eventespresso / event-espresso-core

core/db_models/EEM_Ticket_Template.model.php

Indentation +63 added lines, -63 removed lines

@@ -9,70 +9,70 @@
  */
 class EEM_Ticket_Template extends EEM_Base
 {
-    protected static ?EEM_Ticket_Template $_instance = null;
+	protected static ?EEM_Ticket_Template $_instance = null;
 
 
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings (and
-     *                              any incoming timezone data that gets saved).  Note this just sends the timezone
-     *                              info to the date time model field objects.  Default is NULL (and will be assumed
-     *                              using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Ticket Template', 'event_espresso');
-        $this->plural_item   = esc_html__('Ticket Templates', 'event_espresso');
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings (and
+	 *                              any incoming timezone data that gets saved).  Note this just sends the timezone
+	 *                              info to the date time model field objects.  Default is NULL (and will be assumed
+	 *                              using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Ticket Template', 'event_espresso');
+		$this->plural_item   = esc_html__('Ticket Templates', 'event_espresso');
 
-        $this->_tables                                            = [
-            'Ticket_Template' => new EE_Primary_Table('esp_ticket_template', 'TTM_ID'),
-        ];
-        $this->_fields                                            = [
-            'Ticket_Template' => [
-                'TTM_ID'          => new EE_Primary_Key_Int_Field(
-                    'TTM_ID', esc_html__('Ticket Template ID', 'event_espresso')
-                ),
-                'TTM_name'        => new EE_Plain_Text_Field(
-                    'TTM_name',
-                    esc_html__('The name of the ticket template', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'TTM_description' => new EE_Plain_Text_Field(
-                    'TTM_description',
-                    esc_html__(
-                        'The description for the ticket template',
-                        'event_espresso'
-                    ),
-                    true,
-                    ''
-                ),
-                'TTM_file'        => new EE_Plain_Text_Field(
-                    'TTM_file',
-                    esc_html__(
-                        'The file name for the actual template file saved on disk',
-                        'event_espresso'
-                    ),
-                    true,
-                    ''
-                ),
-            ],
-        ];
-        $this->_model_relations                                   = [
-            'Ticket' => new EE_Has_Many_Relation(),
-        ];
-        $this->_model_chain_to_wp_user                            = 'Ticket';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] =
-            new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        parent::__construct($timezone);
-    }
+		$this->_tables                                            = [
+			'Ticket_Template' => new EE_Primary_Table('esp_ticket_template', 'TTM_ID'),
+		];
+		$this->_fields                                            = [
+			'Ticket_Template' => [
+				'TTM_ID'          => new EE_Primary_Key_Int_Field(
+					'TTM_ID', esc_html__('Ticket Template ID', 'event_espresso')
+				),
+				'TTM_name'        => new EE_Plain_Text_Field(
+					'TTM_name',
+					esc_html__('The name of the ticket template', 'event_espresso'),
+					false,
+					''
+				),
+				'TTM_description' => new EE_Plain_Text_Field(
+					'TTM_description',
+					esc_html__(
+						'The description for the ticket template',
+						'event_espresso'
+					),
+					true,
+					''
+				),
+				'TTM_file'        => new EE_Plain_Text_Field(
+					'TTM_file',
+					esc_html__(
+						'The file name for the actual template file saved on disk',
+						'event_espresso'
+					),
+					true,
+					''
+				),
+			],
+		];
+		$this->_model_relations                                   = [
+			'Ticket' => new EE_Has_Many_Relation(),
+		];
+		$this->_model_chain_to_wp_user                            = 'Ticket';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] =
+			new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Country.model.php

Indentation +208 added lines, -208 removed lines

@@ -10,212 +10,212 @@
  */
 class EEM_Country extends EEM_Base
 {
-    protected static ?EEM_Country $_instance = null;
-
-    // array of all countries
-    private static ?array $_all_countries = null;
-
-    // array of all active countries
-    private static ?array $_active_countries = null;
-
-
-    /**
-     * Resets the country
-     *
-     * @param string|null $timezone
-     * @return EEM_Country|EEM_Base|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reset($timezone = '')
-    {
-        self::$_active_countries = null;
-        self::$_all_countries    = null;
-        return parent::reset($timezone);
-    }
-
-
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Country', 'event_espresso');
-        $this->plural_item   = esc_html__('Countries', 'event_espresso');
-
-        $this->_tables = [
-            'Country' => new EE_Primary_Table('esp_country', 'CNT_ISO'),
-        ];
-
-        $this->_fields          = [
-            'Country' => [
-                'CNT_active'      => new EE_Boolean_Field(
-                    'CNT_active',
-                    esc_html__('Country Appears in Dropdown Select Lists', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'CNT_ISO'         => new EE_Primary_Key_String_Field(
-                    'CNT_ISO',
-                    esc_html__('Country ISO Code', 'event_espresso')
-                ),
-                'CNT_ISO3'        => new EE_All_Caps_Text_Field(
-                    'CNT_ISO3',
-                    esc_html__('Country ISO3 Code', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'RGN_ID'          => new EE_Integer_Field(
-                    'RGN_ID',
-                    esc_html__('Region ID', 'event_espresso'),
-                    false,
-                    0
-                ),
-                // should be a foreign key, but no region table exists yet
-                'CNT_name'        => new EE_Plain_Text_Field(
-                    'CNT_name',
-                    esc_html__('Country Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'CNT_cur_code'    => new EE_All_Caps_Text_Field(
-                    'CNT_cur_code',
-                    esc_html__('Country Currency Code', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_single'  => new EE_Plain_Text_Field(
-                    'CNT_cur_single',
-                    esc_html__('Currency Name Singular', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_plural'  => new EE_Plain_Text_Field(
-                    'CNT_cur_plural',
-                    esc_html__('Currency Name Plural', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_sign'    => new EE_Plain_Text_Field(
-                    'CNT_cur_sign',
-                    esc_html__('Currency Sign', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_sign_b4' => new EE_Boolean_Field(
-                    'CNT_cur_sign_b4',
-                    esc_html__('Currency Sign Before Number', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'CNT_cur_dec_plc' => new EE_Integer_Field(
-                    'CNT_cur_dec_plc',
-                    esc_html__('Currency Decimal Places', 'event_espresso'),
-                    false,
-                    2
-                ),
-                'CNT_cur_dec_mrk' => new EE_Plain_Text_Field(
-                    'CNT_cur_dec_mrk',
-                    esc_html__('Currency Decimal Mark', 'event_espresso'),
-                    false,
-                    '.'
-                ),
-                'CNT_cur_thsnds'  => new EE_Plain_Text_Field(
-                    'CNT_cur_thsnds',
-                    esc_html__('Currency Thousands Separator', 'event_espresso'),
-                    false,
-                    ','
-                ),
-                'CNT_tel_code'    => new EE_Plain_Text_Field(
-                    'CNT_tel_code',
-                    esc_html__('Country Telephone Code', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'CNT_is_EU'       => new EE_Boolean_Field(
-                    'CNT_is_EU',
-                    esc_html__('Country is Member of EU', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Attendee' => new EE_Has_Many_Relation(),
-            'State'    => new EE_Has_Many_Relation(),
-            'Venue'    => new EE_Has_Many_Relation(),
-        ];
-        // only anyone to view, but only those with the default role can do anything
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return EE_Country[]
-     * @throws EE_Error
-     */
-    public function get_all_countries()
-    {
-        if (! self::$_all_countries) {
-            self::$_all_countries = $this->get_all(['order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
-        }
-        return self::$_all_countries;
-    }
-
-
-    /**
-     * Gets and caches the list of active countries. If you know the list of active countries
-     * has changed during this request, first use EEM_Country::reset() to flush the cache
-     *
-     * @return EE_Country[]
-     * @throws EE_Error
-     */
-    public function get_all_active_countries()
-    {
-        if (! self::$_active_countries) {
-            self::$_active_countries =
-                $this->get_all([['CNT_active' => true], 'order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
-        }
-        return self::$_active_countries;
-    }
-
-
-    /**
-     * Gets the country's name by its ISO
-     *
-     * @param string $country_ISO
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_country_name_by_ISO($country_ISO)
-    {
-        $countries = $this->get_all_countries();
-        if (isset($countries[ $country_ISO ]) && $countries[ $country_ISO ] instanceof EE_Country) {
-            return $countries[ $country_ISO ]->name();
-        }
-        $names = $this->get_col([['CNT_ISO' => $country_ISO], 'limit' => 1], 'CNT_name');
-        if (is_array($names) && ! empty($names)) {
-            return reset($names);
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * Gets the country's name by its name
-     *
-     * @param string $country_name
-     * @return EE_Country|null
-     * @throws EE_Error
-     */
-    public function getCountryByName($country_name)
-    {
-        $countries = $this->get_all_countries();
-        foreach ($countries as $country) {
-            if ($country instanceof EE_Country && $country->name() === $country_name) {
-                return $country;
-            }
-        }
-        return $this->get_one([['CNT_name' => $country_name]]);
-    }
+	protected static ?EEM_Country $_instance = null;
+
+	// array of all countries
+	private static ?array $_all_countries = null;
+
+	// array of all active countries
+	private static ?array $_active_countries = null;
+
+
+	/**
+	 * Resets the country
+	 *
+	 * @param string|null $timezone
+	 * @return EEM_Country|EEM_Base|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reset($timezone = '')
+	{
+		self::$_active_countries = null;
+		self::$_all_countries    = null;
+		return parent::reset($timezone);
+	}
+
+
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Country', 'event_espresso');
+		$this->plural_item   = esc_html__('Countries', 'event_espresso');
+
+		$this->_tables = [
+			'Country' => new EE_Primary_Table('esp_country', 'CNT_ISO'),
+		];
+
+		$this->_fields          = [
+			'Country' => [
+				'CNT_active'      => new EE_Boolean_Field(
+					'CNT_active',
+					esc_html__('Country Appears in Dropdown Select Lists', 'event_espresso'),
+					false,
+					true
+				),
+				'CNT_ISO'         => new EE_Primary_Key_String_Field(
+					'CNT_ISO',
+					esc_html__('Country ISO Code', 'event_espresso')
+				),
+				'CNT_ISO3'        => new EE_All_Caps_Text_Field(
+					'CNT_ISO3',
+					esc_html__('Country ISO3 Code', 'event_espresso'),
+					false,
+					''
+				),
+				'RGN_ID'          => new EE_Integer_Field(
+					'RGN_ID',
+					esc_html__('Region ID', 'event_espresso'),
+					false,
+					0
+				),
+				// should be a foreign key, but no region table exists yet
+				'CNT_name'        => new EE_Plain_Text_Field(
+					'CNT_name',
+					esc_html__('Country Name', 'event_espresso'),
+					false,
+					''
+				),
+				'CNT_cur_code'    => new EE_All_Caps_Text_Field(
+					'CNT_cur_code',
+					esc_html__('Country Currency Code', 'event_espresso'),
+					false
+				),
+				'CNT_cur_single'  => new EE_Plain_Text_Field(
+					'CNT_cur_single',
+					esc_html__('Currency Name Singular', 'event_espresso'),
+					false
+				),
+				'CNT_cur_plural'  => new EE_Plain_Text_Field(
+					'CNT_cur_plural',
+					esc_html__('Currency Name Plural', 'event_espresso'),
+					false
+				),
+				'CNT_cur_sign'    => new EE_Plain_Text_Field(
+					'CNT_cur_sign',
+					esc_html__('Currency Sign', 'event_espresso'),
+					false
+				),
+				'CNT_cur_sign_b4' => new EE_Boolean_Field(
+					'CNT_cur_sign_b4',
+					esc_html__('Currency Sign Before Number', 'event_espresso'),
+					false,
+					true
+				),
+				'CNT_cur_dec_plc' => new EE_Integer_Field(
+					'CNT_cur_dec_plc',
+					esc_html__('Currency Decimal Places', 'event_espresso'),
+					false,
+					2
+				),
+				'CNT_cur_dec_mrk' => new EE_Plain_Text_Field(
+					'CNT_cur_dec_mrk',
+					esc_html__('Currency Decimal Mark', 'event_espresso'),
+					false,
+					'.'
+				),
+				'CNT_cur_thsnds'  => new EE_Plain_Text_Field(
+					'CNT_cur_thsnds',
+					esc_html__('Currency Thousands Separator', 'event_espresso'),
+					false,
+					','
+				),
+				'CNT_tel_code'    => new EE_Plain_Text_Field(
+					'CNT_tel_code',
+					esc_html__('Country Telephone Code', 'event_espresso'),
+					false,
+					''
+				),
+				'CNT_is_EU'       => new EE_Boolean_Field(
+					'CNT_is_EU',
+					esc_html__('Country is Member of EU', 'event_espresso'),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Attendee' => new EE_Has_Many_Relation(),
+			'State'    => new EE_Has_Many_Relation(),
+			'Venue'    => new EE_Has_Many_Relation(),
+		];
+		// only anyone to view, but only those with the default role can do anything
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return EE_Country[]
+	 * @throws EE_Error
+	 */
+	public function get_all_countries()
+	{
+		if (! self::$_all_countries) {
+			self::$_all_countries = $this->get_all(['order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
+		}
+		return self::$_all_countries;
+	}
+
+
+	/**
+	 * Gets and caches the list of active countries. If you know the list of active countries
+	 * has changed during this request, first use EEM_Country::reset() to flush the cache
+	 *
+	 * @return EE_Country[]
+	 * @throws EE_Error
+	 */
+	public function get_all_active_countries()
+	{
+		if (! self::$_active_countries) {
+			self::$_active_countries =
+				$this->get_all([['CNT_active' => true], 'order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
+		}
+		return self::$_active_countries;
+	}
+
+
+	/**
+	 * Gets the country's name by its ISO
+	 *
+	 * @param string $country_ISO
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_country_name_by_ISO($country_ISO)
+	{
+		$countries = $this->get_all_countries();
+		if (isset($countries[ $country_ISO ]) && $countries[ $country_ISO ] instanceof EE_Country) {
+			return $countries[ $country_ISO ]->name();
+		}
+		$names = $this->get_col([['CNT_ISO' => $country_ISO], 'limit' => 1], 'CNT_name');
+		if (is_array($names) && ! empty($names)) {
+			return reset($names);
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * Gets the country's name by its name
+	 *
+	 * @param string $country_name
+	 * @return EE_Country|null
+	 * @throws EE_Error
+	 */
+	public function getCountryByName($country_name)
+	{
+		$countries = $this->get_all_countries();
+		foreach ($countries as $country) {
+			if ($country instanceof EE_Country && $country->name() === $country_name) {
+				return $country;
+			}
+		}
+		return $this->get_one([['CNT_name' => $country_name]]);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -13,10 +13,10 @@ 
     protected static ?EEM_Country $_instance = null;
 
     // array of all countries
-    private static ?array $_all_countries = null;
+    private static ? array $_all_countries = null;
 
     // array of all active countries
-    private static ?array $_active_countries = null;
+    private static ? array $_active_countries = null;
 
 
     /**
@@ -48,7 +48,7 @@ 
             'Country' => new EE_Primary_Table('esp_country', 'CNT_ISO'),
         ];
 
-        $this->_fields          = [
+        $this->_fields = [
             'Country' => [
                 'CNT_active'      => new EE_Boolean_Field(
                     'CNT_active',
@@ -143,7 +143,7 @@ 
             'Venue'    => new EE_Has_Many_Relation(),
         ];
         // only anyone to view, but only those with the default role can do anything
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
 
         parent::__construct($timezone);
     }
@@ -155,7 +155,7 @@ 
      */
     public function get_all_countries()
     {
-        if (! self::$_all_countries) {
+        if ( ! self::$_all_countries) {
             self::$_all_countries = $this->get_all(['order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
         }
         return self::$_all_countries;
@@ -171,7 +171,7 @@ 
      */
     public function get_all_active_countries()
     {
-        if (! self::$_active_countries) {
+        if ( ! self::$_active_countries) {
             self::$_active_countries =
                 $this->get_all([['CNT_active' => true], 'order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
         }
@@ -189,8 +189,8 @@ 
     public function get_country_name_by_ISO($country_ISO)
     {
         $countries = $this->get_all_countries();
-        if (isset($countries[ $country_ISO ]) && $countries[ $country_ISO ] instanceof EE_Country) {
-            return $countries[ $country_ISO ]->name();
+        if (isset($countries[$country_ISO]) && $countries[$country_ISO] instanceof EE_Country) {
+            return $countries[$country_ISO]->name();
         }
         $names = $this->get_col([['CNT_ISO' => $country_ISO], 'limit' => 1], 'CNT_name');
         if (is_array($names) && ! empty($names)) {

core/db_models/EEM_Registration_Payment.model.php

Indentation +49 added lines, -49 removed lines

@@ -12,59 +12,59 @@
  */
 class EEM_Registration_Payment extends EEM_Base
 {
-    protected static ?EEM_Registration_Payment $_instance = null;
+	protected static ?EEM_Registration_Payment $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Registration Payment', 'event_espresso');
-        $this->plural_item   = esc_html__('Registration Payments', 'event_espresso');
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Registration Payment', 'event_espresso');
+		$this->plural_item   = esc_html__('Registration Payments', 'event_espresso');
 
-        $this->_tables = [
-            'Registration_Payment' => new EE_Primary_Table('esp_registration_payment', 'RPY_ID'),
-        ];
+		$this->_tables = [
+			'Registration_Payment' => new EE_Primary_Table('esp_registration_payment', 'RPY_ID'),
+		];
 
-        $this->_fields = [
-            'Registration_Payment' => [
-                'RPY_ID'     => new EE_Primary_Key_Int_Field(
-                    'RPY_ID',
-                    esc_html__('Registration Payment ID', 'event_espresso')
-                ),
-                'REG_ID'     => new EE_Foreign_Key_Int_Field(
-                    'REG_ID',
-                    esc_html__('Registration ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Registration'
-                ),
-                'PAY_ID'     => new EE_Foreign_Key_Int_Field(
-                    'PAY_ID',
-                    esc_html__('Payment ID', 'event_espresso'),
-                    true,
-                    null,
-                    'Payment'
-                ),
-                'RPY_amount' => new EE_Money_Field(
-                    'RPY_amount',
-                    esc_html__(
-                        'Amount attributed to the registration',
-                        'event_espresso'
-                    ),
-                    false,
-                    0
-                ),
-            ],
-        ];
+		$this->_fields = [
+			'Registration_Payment' => [
+				'RPY_ID'     => new EE_Primary_Key_Int_Field(
+					'RPY_ID',
+					esc_html__('Registration Payment ID', 'event_espresso')
+				),
+				'REG_ID'     => new EE_Foreign_Key_Int_Field(
+					'REG_ID',
+					esc_html__('Registration ID', 'event_espresso'),
+					false,
+					0,
+					'Registration'
+				),
+				'PAY_ID'     => new EE_Foreign_Key_Int_Field(
+					'PAY_ID',
+					esc_html__('Payment ID', 'event_espresso'),
+					true,
+					null,
+					'Payment'
+				),
+				'RPY_amount' => new EE_Money_Field(
+					'RPY_amount',
+					esc_html__(
+						'Amount attributed to the registration',
+						'event_espresso'
+					),
+					false,
+					0
+				),
+			],
+		];
 
-        $this->_model_relations = [
-            'Registration' => new EE_Belongs_To_Relation(),
-            'Payment'      => new EE_Belongs_To_Relation(),
-        ];
+		$this->_model_relations = [
+			'Registration' => new EE_Belongs_To_Relation(),
+			'Payment'      => new EE_Belongs_To_Relation(),
+		];
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Question.model.php

Indentation +565 added lines, -565 removed lines

@@ -9,569 +9,569 @@
  */
 class EEM_Question extends EEM_Soft_Delete_Base
 {
-    // constant used to indicate that the question type is CHECKBOX
-    const QST_type_checkbox = 'CHECKBOX';
-
-    // constant used to indicate that the question type is COUNTRY
-    const QST_type_country = 'COUNTRY';
-
-    // constant used to indicate that the question type is DATE
-    const QST_type_date = 'DATE';
-
-    // constant used to indicate that the question type is a decimal (float)
-    const QST_type_decimal = 'DECIMAL';
-
-    // constant used to indicate that the question type is DROPDOWN
-    const QST_type_dropdown = 'DROPDOWN';
-
-    // constant used to indicate that the question type is an email input
-    const QST_type_email = 'EMAIL';
-
-    // constant used to indicate that the question type is an email input
-    const QST_type_email_confirm = 'EMAIL_CONFIRM';
-
-    // constant used to indicate that the question type is a TEXTAREA that allows simple html
-    const QST_type_html_textarea = 'HTML_TEXTAREA';
-
-    // constant used to indicate that the question type is an integer (whole number)
-    const QST_type_int = 'INTEGER';
-
-    // constant used to indicate that the question type is a multi-select
-    const QST_type_multi_select = 'MULTI_SELECT';
-
-    // constant used to indicate that the question type is RADIO_BTN
-    const QST_type_radio = 'RADIO_BTN';
-
-    // constant used to indicate that the question type is STATE
-    const QST_type_state = 'STATE';
-
-    // constant used to indicate that the question type is TEXT
-    const QST_type_text = 'TEXT';
-
-    // constant used to indicate that the question type is TEXTAREA
-    const QST_type_textarea = 'TEXTAREA';
-
-    // constant used to indicate that the question type is a valid URL
-    const QST_type_url = 'URL';
-
-    // constant used to indicate that the question type is a US-formatted phone number
-    const QST_type_us_phone = 'US_PHONE';
-
-    // constant used to indicate that the question type is a YEAR
-    const QST_type_year = 'YEAR';
-
-
-    protected static ?EEM_Question $_instance = null;
-
-    /**
-     * lists all the question types which should be allowed. Ideally, this will be extensible.
-     */
-    protected array $_allowed_question_types;
-
-    /**
-     * brief descriptions for all the question types
-     */
-    protected array $_question_descriptions;
-
-    /**
-     * Question types that are interchangeable, even after answers have been provided for them.
-     * Top-level keys are category slugs, next level is an array of question types. If question types
-     * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
-     *
-     * @var array   $_question_type_categories {
-     * @type string $text
-     * @type string $single                    -answer-enum
-     * @type string $multi                     -answer-enum
-     *                                         }
-     */
-    protected array $_question_type_categories;
-
-    /**
-     * Question types that should have an admin-defined max input length
-     */
-    protected array $question_types_with_max_length;
-
-
-    /**
-     * EEM_Question constructor.
-     *
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item                  = esc_html__('Question', 'event_espresso');
-        $this->plural_item                    = esc_html__('Questions', 'event_espresso');
-        $this->_allowed_question_types        = (array) apply_filters(
-            'FHEE__EEM_Question__construct__allowed_question_types',
-            [
-                EEM_Question::QST_type_checkbox      => esc_html__('Checkboxes', 'event_espresso'),
-                EEM_Question::QST_type_country       => esc_html__('Country Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_date          => esc_html__('Date Picker', 'event_espresso'),
-                EEM_Question::QST_type_decimal       => esc_html__('Number', 'event_espresso'),
-                EEM_Question::QST_type_dropdown      => esc_html__('Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_email         => esc_html__('Email', 'event_espresso'),
-                EEM_Question::QST_type_email_confirm => esc_html__('Confirm Email', 'event_espresso'),
-                EEM_Question::QST_type_html_textarea => esc_html__('HTML Textarea', 'event_espresso'),
-                EEM_Question::QST_type_int           => esc_html__('Whole Number', 'event_espresso'),
-                EEM_Question::QST_type_multi_select  => esc_html__('Multi Select', 'event_espresso'),
-                EEM_Question::QST_type_radio         => esc_html__('Radio Buttons', 'event_espresso'),
-                EEM_Question::QST_type_state         => esc_html__('State/Province Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_text          => esc_html__('Text', 'event_espresso'),
-                EEM_Question::QST_type_textarea      => esc_html__('Textarea', 'event_espresso'),
-                EEM_Question::QST_type_url           => esc_html__('URL', 'event_espresso'),
-                EEM_Question::QST_type_us_phone      => esc_html__('USA - Format Phone', 'event_espresso'),
-                EEM_Question::QST_type_year          => esc_html__('Year', 'event_espresso'),
-            ]
-        );
-        $this->_question_descriptions         = (array) apply_filters(
-            'FHEE__EEM_Question__construct__question_descriptions',
-            [
-                EEM_Question::QST_type_checkbox      => esc_html__(
-                    'Allows multiple preset options to be selected',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_country       => esc_html__(
-                    'A dropdown that lists countries',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_date          => esc_html__(
-                    'A popup calendar that allows date selections',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_decimal       => esc_html__(
-                    'A text field that allows number values with decimals',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_dropdown      => esc_html__(
-                    'A dropdown that allows a single selection',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_email         => esc_html__(
-                    'A text field that must contain a valid Email address',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_email_confirm => esc_html__(
-                    'A text field that must contain a valid Email address and be equal to Email field',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_html_textarea => esc_html__(
-                    'A multi line text input field that allows HTML',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_int           => esc_html__(
-                    'A text field that only allows whole numbers (no decimals)',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_multi_select  => esc_html__(
-                    'A dropdown that allows multiple selections',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_radio         => esc_html__(
-                    'Allows a single preset option to be selected',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_state         => esc_html__(
-                    'A dropdown that lists states/provinces',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_text          => esc_html__(
-                    'A single line text input field',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_textarea      => esc_html__(
-                    'A multi line text input field',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_url           => esc_html__(
-                    'A text field that must contain a valid URL',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_us_phone      => esc_html__(
-                    'A text field that must contain a valid US phone number',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_year          => esc_html__(
-                    'A dropdown that lists the last 100 years',
-                    'event_espresso'
-                ),
-            ]
-        );
-        $this->_question_type_categories      = (array) apply_filters(
-            'FHEE__EEM_Question__construct__question_type_categories',
-            [
-                'text'               => [
-                    EEM_Question::QST_type_date,
-                    EEM_Question::QST_type_decimal,
-                    EEM_Question::QST_type_email,
-                    EEM_Question::QST_type_email_confirm,
-                    EEM_Question::QST_type_html_textarea,
-                    EEM_Question::QST_type_int,
-                    EEM_Question::QST_type_text,
-                    EEM_Question::QST_type_textarea,
-                    EEM_Question::QST_type_url,
-                    EEM_Question::QST_type_us_phone,
-                    EEM_Question::QST_type_year,
-                ],
-                'single-answer-enum' => [
-                    EEM_Question::QST_type_dropdown,
-                    EEM_Question::QST_type_radio,
-                ],
-                'multi-answer-enum'  => [
-                    EEM_Question::QST_type_multi_select,
-                    EEM_Question::QST_type_checkbox,
-                ],
-            ]
-        );
-        $this->question_types_with_max_length = (array) apply_filters(
-            'FHEE__EEM_Question___construct__question_types_with_max_length',
-            [
-                EEM_Question::QST_type_html_textarea,
-                EEM_Question::QST_type_text,
-                EEM_Question::QST_type_textarea,
-            ]
-        );
-
-        $this->_tables          = [
-            'Question' => new EE_Primary_Table('esp_question', 'QST_ID'),
-        ];
-        $this->_fields          = [
-            'Question' => [
-                'QST_ID'            => new EE_Primary_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question ID', 'event_espresso')
-                ),
-                'QST_admin_label'   => new EE_Plain_Text_Field(
-                    'QST_admin_label',
-                    esc_html__('Question Label (admin-only)', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QST_admin_only'    => new EE_Boolean_Field(
-                    'QST_admin_only',
-                    esc_html__('Admin-Only Question?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QST_deleted'       => new EE_Trashed_Flag_Field(
-                    'QST_deleted',
-                    esc_html__('Flag Indicating question was deleted', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QST_display_text'  => new EE_Post_Content_Field(
-                    'QST_display_text',
-                    esc_html__('Question Text', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QST_max'           => new EE_Infinite_Integer_Field(
-                    'QST_max',
-                    esc_html__('Max Size', 'event_espresso'),
-                    false,
-                    EE_INF
-                ),
-                'QST_order'         => new EE_Integer_Field(
-                    'QST_order',
-                    esc_html__('Question Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'QST_required'      => new EE_Boolean_Field(
-                    'QST_required',
-                    esc_html__('Required Question?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QST_required_text' => new EE_Simple_HTML_Field(
-                    'QST_required_text',
-                    esc_html__('Text to Display if Not Provided', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QST_system'        => new EE_Plain_Text_Field(
-                    'QST_system',
-                    esc_html__('Internal string ID for question', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'QST_type'          => new EE_Enum_Text_Field(
-                    'QST_type',
-                    esc_html__('Question Type', 'event_espresso'),
-                    false,
-                    'TEXT',
-                    $this->_allowed_question_types
-                ),
-                'QST_wp_user'       => new EE_WP_User_Field(
-                    'QST_wp_user',
-                    esc_html__('Question Creator ID', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Answer'                  => new EE_Has_Many_Relation(),
-            'Question_Group'          => new EE_HABTM_Relation('Question_Group_Question'),
-            // for QST_order column
-            'Question_Group_Question' => new EE_Has_Many_Relation(),
-            'Question_Option'         => new EE_Has_Many_Relation(),
-            'WP_User'                 => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Reg_Form('QST_system');
-
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Returns the list of allowed question types, which are normally:
-     * 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE' but they can be extended
-     *
-     * @return string[]
-     */
-    public function allowed_question_types(): array
-    {
-        return $this->_allowed_question_types;
-    }
-
-
-    /**
-     * Gets all the question types in the same category
-     *
-     * @param string $question_type one of EEM_Question::allowed_question_types(
-     * @return string[] like EEM_Question::allowed_question_types()
-     */
-    public function question_types_in_same_category(string $question_type): array
-    {
-        $question_types = [$question_type];
-        foreach ($this->_question_type_categories as $category => $question_types_in_category) {
-            if (in_array($question_type, $question_types_in_category)) {
-                $question_types = $question_types_in_category;
-                break;
-            }
-        }
-
-        return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
-    }
-
-
-    /**
-     * Determines if the given question type is in the given question type category
-     *
-     * @param string $question_type one of EEM_Question::allowed_question_types()
-     * @param string $category      one of the top-level keys of EEM_Question::question_type_categories()
-     * @return boolean
-     */
-    public function question_type_is_in_category(string $question_type, string $category): bool
-    {
-        if (! isset($this->_question_type_categories[ $category ])) {
-            return false;
-        }
-        return in_array($question_type, $this->_question_type_categories[ $category ]);
-    }
-
-
-    /**
-     * Returns all the question types in the given category
-     *
-     * @param string $category
-     * @return array|mixed
-     */
-    public function question_types_in_category(string $category): array
-    {
-        if (isset($this->_question_type_categories[ $category ])) {
-            return $this->_question_type_categories[ $category ];
-        }
-        return [];
-    }
-
-
-    /**
-     * Returns all the question types that should have question options
-     *
-     * @return array
-     */
-    public function question_types_with_options(): array
-    {
-        return array_merge(
-            $this->question_types_in_category('single-answer-enum'),
-            $this->question_types_in_category('multi-answer-enum')
-        );
-    }
-
-
-    /**
-     * Returns the question type categories 2d array
-     *
-     * @return array see EEM_Question::_question_type_categories
-     */
-    public function question_type_categories(): array
-    {
-        return $this->_question_type_categories;
-    }
-
-
-    /**
-     * Returns an array of all the QST_system values that can be allowed in the system question group
-     * identified by $system_question_group_id
-     *
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function allowed_system_questions_in_system_question_group(string $system_question_group_id): array
-    {
-        $question_system_ids = [];
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = [
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_lname,
-                    EEM_Attendee::system_question_email,
-                    EEM_Attendee::system_question_email_confirm,
-                    EEM_Attendee::system_question_phone,
-                ];
-                break;
-            case EEM_Question_Group::system_address:
-                $question_system_ids = [
-                    EEM_Attendee::system_question_address,
-                    EEM_Attendee::system_question_address2,
-                    EEM_Attendee::system_question_city,
-                    EEM_Attendee::system_question_state,
-                    EEM_Attendee::system_question_country,
-                    EEM_Attendee::system_question_zip,
-                    EEM_Attendee::system_question_phone,
-                ];
-                break;
-        }
-        return apply_filters(
-            'FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return',
-            $question_system_ids,
-            $system_question_group_id
-        );
-    }
-
-
-    /**
-     * Returns an array of all the QST_system values that are required in the system question group
-     * identified by $system_question_group_id
-     *
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function required_system_questions_in_system_question_group(string $system_question_group_id): array
-    {
-        $question_system_ids = null;
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = [
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_email,
-                ];
-                break;
-            default:
-                $question_system_ids = [];
-        }
-        return apply_filters(
-            'FHEE__EEM_Question__system_questions_required_in_system_question_group',
-            $question_system_ids,
-            $system_question_group_id
-        );
-    }
-
-
-    /**
-     * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
-     * which system question QST_ID corresponds to the QST_system 'city', use
-     * EEM_Question::instance()->get_Question_ID_from_system_string('city');
-     *
-     * @param $QST_system
-     * @return int of QST_ID for the question that corresponds to that QST_system
-     * @throws EE_Error
-     */
-    public function get_Question_ID_from_system_string($QST_system): int
-    {
-        return $this->get_var([['QST_system' => $QST_system]]);
-    }
-
-
-    /**
-     * searches the db for the question with the latest question order and returns that value.
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_latest_question_order(): int
-    {
-        $columns_to_select = [
-            'max_order' => ["MAX(QST_order)", "%d"],
-        ];
-        $max               = $this->_get_all_wpdb_results([], ARRAY_A, $columns_to_select);
-        return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
-    }
-
-
-    /**
-     * Returns an array where keys are system question QST_system values,
-     * and values are the highest question max the admin can set on the question
-     * (aka the "max max"; eg, a site admin can change the zip question to have a max
-     * of 5, but no larger than 12)
-     *
-     * @return array
-     */
-    public function system_question_maxes(): array
-    {
-        return [
-            'fname'         => 45,
-            'lname'         => 45,
-            'address'       => 255,
-            'address2'      => 255,
-            'city'          => 45,
-            'zip'           => 12,
-            'email'         => 255,
-            'email_confirm' => 255,
-            'phone'         => 45,
-        ];
-    }
-
-
-    /**
-     * Given a QST_system value, gets the question's largest allowable max input.
-     *
-     * @param string $system_question_value
-     * @return int|float
-     * @see Registration_Form_Admin_Page::system_question_maxes()
-     */
-    public function absolute_max_for_system_question(string $system_question_value)
-    {
-        $maxes = $this->system_question_maxes();
-        return $maxes[ $system_question_value ] ?? EE_INF;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function question_descriptions(): array
-    {
-        return $this->_question_descriptions;
-    }
-
-
-    /**
-     * Returns all the question types that should have an admin-defined max input length
-     *
-     * @return array
-     */
-    public function questionTypesWithMaxLength(): array
-    {
-        return (array) $this->question_types_with_max_length;
-    }
+	// constant used to indicate that the question type is CHECKBOX
+	const QST_type_checkbox = 'CHECKBOX';
+
+	// constant used to indicate that the question type is COUNTRY
+	const QST_type_country = 'COUNTRY';
+
+	// constant used to indicate that the question type is DATE
+	const QST_type_date = 'DATE';
+
+	// constant used to indicate that the question type is a decimal (float)
+	const QST_type_decimal = 'DECIMAL';
+
+	// constant used to indicate that the question type is DROPDOWN
+	const QST_type_dropdown = 'DROPDOWN';
+
+	// constant used to indicate that the question type is an email input
+	const QST_type_email = 'EMAIL';
+
+	// constant used to indicate that the question type is an email input
+	const QST_type_email_confirm = 'EMAIL_CONFIRM';
+
+	// constant used to indicate that the question type is a TEXTAREA that allows simple html
+	const QST_type_html_textarea = 'HTML_TEXTAREA';
+
+	// constant used to indicate that the question type is an integer (whole number)
+	const QST_type_int = 'INTEGER';
+
+	// constant used to indicate that the question type is a multi-select
+	const QST_type_multi_select = 'MULTI_SELECT';
+
+	// constant used to indicate that the question type is RADIO_BTN
+	const QST_type_radio = 'RADIO_BTN';
+
+	// constant used to indicate that the question type is STATE
+	const QST_type_state = 'STATE';
+
+	// constant used to indicate that the question type is TEXT
+	const QST_type_text = 'TEXT';
+
+	// constant used to indicate that the question type is TEXTAREA
+	const QST_type_textarea = 'TEXTAREA';
+
+	// constant used to indicate that the question type is a valid URL
+	const QST_type_url = 'URL';
+
+	// constant used to indicate that the question type is a US-formatted phone number
+	const QST_type_us_phone = 'US_PHONE';
+
+	// constant used to indicate that the question type is a YEAR
+	const QST_type_year = 'YEAR';
+
+
+	protected static ?EEM_Question $_instance = null;
+
+	/**
+	 * lists all the question types which should be allowed. Ideally, this will be extensible.
+	 */
+	protected array $_allowed_question_types;
+
+	/**
+	 * brief descriptions for all the question types
+	 */
+	protected array $_question_descriptions;
+
+	/**
+	 * Question types that are interchangeable, even after answers have been provided for them.
+	 * Top-level keys are category slugs, next level is an array of question types. If question types
+	 * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
+	 *
+	 * @var array   $_question_type_categories {
+	 * @type string $text
+	 * @type string $single                    -answer-enum
+	 * @type string $multi                     -answer-enum
+	 *                                         }
+	 */
+	protected array $_question_type_categories;
+
+	/**
+	 * Question types that should have an admin-defined max input length
+	 */
+	protected array $question_types_with_max_length;
+
+
+	/**
+	 * EEM_Question constructor.
+	 *
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item                  = esc_html__('Question', 'event_espresso');
+		$this->plural_item                    = esc_html__('Questions', 'event_espresso');
+		$this->_allowed_question_types        = (array) apply_filters(
+			'FHEE__EEM_Question__construct__allowed_question_types',
+			[
+				EEM_Question::QST_type_checkbox      => esc_html__('Checkboxes', 'event_espresso'),
+				EEM_Question::QST_type_country       => esc_html__('Country Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_date          => esc_html__('Date Picker', 'event_espresso'),
+				EEM_Question::QST_type_decimal       => esc_html__('Number', 'event_espresso'),
+				EEM_Question::QST_type_dropdown      => esc_html__('Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_email         => esc_html__('Email', 'event_espresso'),
+				EEM_Question::QST_type_email_confirm => esc_html__('Confirm Email', 'event_espresso'),
+				EEM_Question::QST_type_html_textarea => esc_html__('HTML Textarea', 'event_espresso'),
+				EEM_Question::QST_type_int           => esc_html__('Whole Number', 'event_espresso'),
+				EEM_Question::QST_type_multi_select  => esc_html__('Multi Select', 'event_espresso'),
+				EEM_Question::QST_type_radio         => esc_html__('Radio Buttons', 'event_espresso'),
+				EEM_Question::QST_type_state         => esc_html__('State/Province Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_text          => esc_html__('Text', 'event_espresso'),
+				EEM_Question::QST_type_textarea      => esc_html__('Textarea', 'event_espresso'),
+				EEM_Question::QST_type_url           => esc_html__('URL', 'event_espresso'),
+				EEM_Question::QST_type_us_phone      => esc_html__('USA - Format Phone', 'event_espresso'),
+				EEM_Question::QST_type_year          => esc_html__('Year', 'event_espresso'),
+			]
+		);
+		$this->_question_descriptions         = (array) apply_filters(
+			'FHEE__EEM_Question__construct__question_descriptions',
+			[
+				EEM_Question::QST_type_checkbox      => esc_html__(
+					'Allows multiple preset options to be selected',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_country       => esc_html__(
+					'A dropdown that lists countries',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_date          => esc_html__(
+					'A popup calendar that allows date selections',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_decimal       => esc_html__(
+					'A text field that allows number values with decimals',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_dropdown      => esc_html__(
+					'A dropdown that allows a single selection',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_email         => esc_html__(
+					'A text field that must contain a valid Email address',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_email_confirm => esc_html__(
+					'A text field that must contain a valid Email address and be equal to Email field',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_html_textarea => esc_html__(
+					'A multi line text input field that allows HTML',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_int           => esc_html__(
+					'A text field that only allows whole numbers (no decimals)',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_multi_select  => esc_html__(
+					'A dropdown that allows multiple selections',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_radio         => esc_html__(
+					'Allows a single preset option to be selected',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_state         => esc_html__(
+					'A dropdown that lists states/provinces',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_text          => esc_html__(
+					'A single line text input field',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_textarea      => esc_html__(
+					'A multi line text input field',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_url           => esc_html__(
+					'A text field that must contain a valid URL',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_us_phone      => esc_html__(
+					'A text field that must contain a valid US phone number',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_year          => esc_html__(
+					'A dropdown that lists the last 100 years',
+					'event_espresso'
+				),
+			]
+		);
+		$this->_question_type_categories      = (array) apply_filters(
+			'FHEE__EEM_Question__construct__question_type_categories',
+			[
+				'text'               => [
+					EEM_Question::QST_type_date,
+					EEM_Question::QST_type_decimal,
+					EEM_Question::QST_type_email,
+					EEM_Question::QST_type_email_confirm,
+					EEM_Question::QST_type_html_textarea,
+					EEM_Question::QST_type_int,
+					EEM_Question::QST_type_text,
+					EEM_Question::QST_type_textarea,
+					EEM_Question::QST_type_url,
+					EEM_Question::QST_type_us_phone,
+					EEM_Question::QST_type_year,
+				],
+				'single-answer-enum' => [
+					EEM_Question::QST_type_dropdown,
+					EEM_Question::QST_type_radio,
+				],
+				'multi-answer-enum'  => [
+					EEM_Question::QST_type_multi_select,
+					EEM_Question::QST_type_checkbox,
+				],
+			]
+		);
+		$this->question_types_with_max_length = (array) apply_filters(
+			'FHEE__EEM_Question___construct__question_types_with_max_length',
+			[
+				EEM_Question::QST_type_html_textarea,
+				EEM_Question::QST_type_text,
+				EEM_Question::QST_type_textarea,
+			]
+		);
+
+		$this->_tables          = [
+			'Question' => new EE_Primary_Table('esp_question', 'QST_ID'),
+		];
+		$this->_fields          = [
+			'Question' => [
+				'QST_ID'            => new EE_Primary_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question ID', 'event_espresso')
+				),
+				'QST_admin_label'   => new EE_Plain_Text_Field(
+					'QST_admin_label',
+					esc_html__('Question Label (admin-only)', 'event_espresso'),
+					true,
+					''
+				),
+				'QST_admin_only'    => new EE_Boolean_Field(
+					'QST_admin_only',
+					esc_html__('Admin-Only Question?', 'event_espresso'),
+					false,
+					false
+				),
+				'QST_deleted'       => new EE_Trashed_Flag_Field(
+					'QST_deleted',
+					esc_html__('Flag Indicating question was deleted', 'event_espresso'),
+					false,
+					false
+				),
+				'QST_display_text'  => new EE_Post_Content_Field(
+					'QST_display_text',
+					esc_html__('Question Text', 'event_espresso'),
+					true,
+					''
+				),
+				'QST_max'           => new EE_Infinite_Integer_Field(
+					'QST_max',
+					esc_html__('Max Size', 'event_espresso'),
+					false,
+					EE_INF
+				),
+				'QST_order'         => new EE_Integer_Field(
+					'QST_order',
+					esc_html__('Question Order', 'event_espresso'),
+					false,
+					0
+				),
+				'QST_required'      => new EE_Boolean_Field(
+					'QST_required',
+					esc_html__('Required Question?', 'event_espresso'),
+					false,
+					false
+				),
+				'QST_required_text' => new EE_Simple_HTML_Field(
+					'QST_required_text',
+					esc_html__('Text to Display if Not Provided', 'event_espresso'),
+					true,
+					''
+				),
+				'QST_system'        => new EE_Plain_Text_Field(
+					'QST_system',
+					esc_html__('Internal string ID for question', 'event_espresso'),
+					false,
+					''
+				),
+				'QST_type'          => new EE_Enum_Text_Field(
+					'QST_type',
+					esc_html__('Question Type', 'event_espresso'),
+					false,
+					'TEXT',
+					$this->_allowed_question_types
+				),
+				'QST_wp_user'       => new EE_WP_User_Field(
+					'QST_wp_user',
+					esc_html__('Question Creator ID', 'event_espresso'),
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Answer'                  => new EE_Has_Many_Relation(),
+			'Question_Group'          => new EE_HABTM_Relation('Question_Group_Question'),
+			// for QST_order column
+			'Question_Group_Question' => new EE_Has_Many_Relation(),
+			'Question_Option'         => new EE_Has_Many_Relation(),
+			'WP_User'                 => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Reg_Form('QST_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Reg_Form('QST_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Reg_Form('QST_system');
+
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Returns the list of allowed question types, which are normally:
+	 * 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE' but they can be extended
+	 *
+	 * @return string[]
+	 */
+	public function allowed_question_types(): array
+	{
+		return $this->_allowed_question_types;
+	}
+
+
+	/**
+	 * Gets all the question types in the same category
+	 *
+	 * @param string $question_type one of EEM_Question::allowed_question_types(
+	 * @return string[] like EEM_Question::allowed_question_types()
+	 */
+	public function question_types_in_same_category(string $question_type): array
+	{
+		$question_types = [$question_type];
+		foreach ($this->_question_type_categories as $category => $question_types_in_category) {
+			if (in_array($question_type, $question_types_in_category)) {
+				$question_types = $question_types_in_category;
+				break;
+			}
+		}
+
+		return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
+	}
+
+
+	/**
+	 * Determines if the given question type is in the given question type category
+	 *
+	 * @param string $question_type one of EEM_Question::allowed_question_types()
+	 * @param string $category      one of the top-level keys of EEM_Question::question_type_categories()
+	 * @return boolean
+	 */
+	public function question_type_is_in_category(string $question_type, string $category): bool
+	{
+		if (! isset($this->_question_type_categories[ $category ])) {
+			return false;
+		}
+		return in_array($question_type, $this->_question_type_categories[ $category ]);
+	}
+
+
+	/**
+	 * Returns all the question types in the given category
+	 *
+	 * @param string $category
+	 * @return array|mixed
+	 */
+	public function question_types_in_category(string $category): array
+	{
+		if (isset($this->_question_type_categories[ $category ])) {
+			return $this->_question_type_categories[ $category ];
+		}
+		return [];
+	}
+
+
+	/**
+	 * Returns all the question types that should have question options
+	 *
+	 * @return array
+	 */
+	public function question_types_with_options(): array
+	{
+		return array_merge(
+			$this->question_types_in_category('single-answer-enum'),
+			$this->question_types_in_category('multi-answer-enum')
+		);
+	}
+
+
+	/**
+	 * Returns the question type categories 2d array
+	 *
+	 * @return array see EEM_Question::_question_type_categories
+	 */
+	public function question_type_categories(): array
+	{
+		return $this->_question_type_categories;
+	}
+
+
+	/**
+	 * Returns an array of all the QST_system values that can be allowed in the system question group
+	 * identified by $system_question_group_id
+	 *
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function allowed_system_questions_in_system_question_group(string $system_question_group_id): array
+	{
+		$question_system_ids = [];
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = [
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_lname,
+					EEM_Attendee::system_question_email,
+					EEM_Attendee::system_question_email_confirm,
+					EEM_Attendee::system_question_phone,
+				];
+				break;
+			case EEM_Question_Group::system_address:
+				$question_system_ids = [
+					EEM_Attendee::system_question_address,
+					EEM_Attendee::system_question_address2,
+					EEM_Attendee::system_question_city,
+					EEM_Attendee::system_question_state,
+					EEM_Attendee::system_question_country,
+					EEM_Attendee::system_question_zip,
+					EEM_Attendee::system_question_phone,
+				];
+				break;
+		}
+		return apply_filters(
+			'FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return',
+			$question_system_ids,
+			$system_question_group_id
+		);
+	}
+
+
+	/**
+	 * Returns an array of all the QST_system values that are required in the system question group
+	 * identified by $system_question_group_id
+	 *
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function required_system_questions_in_system_question_group(string $system_question_group_id): array
+	{
+		$question_system_ids = null;
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = [
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_email,
+				];
+				break;
+			default:
+				$question_system_ids = [];
+		}
+		return apply_filters(
+			'FHEE__EEM_Question__system_questions_required_in_system_question_group',
+			$question_system_ids,
+			$system_question_group_id
+		);
+	}
+
+
+	/**
+	 * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
+	 * which system question QST_ID corresponds to the QST_system 'city', use
+	 * EEM_Question::instance()->get_Question_ID_from_system_string('city');
+	 *
+	 * @param $QST_system
+	 * @return int of QST_ID for the question that corresponds to that QST_system
+	 * @throws EE_Error
+	 */
+	public function get_Question_ID_from_system_string($QST_system): int
+	{
+		return $this->get_var([['QST_system' => $QST_system]]);
+	}
+
+
+	/**
+	 * searches the db for the question with the latest question order and returns that value.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_latest_question_order(): int
+	{
+		$columns_to_select = [
+			'max_order' => ["MAX(QST_order)", "%d"],
+		];
+		$max               = $this->_get_all_wpdb_results([], ARRAY_A, $columns_to_select);
+		return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
+	}
+
+
+	/**
+	 * Returns an array where keys are system question QST_system values,
+	 * and values are the highest question max the admin can set on the question
+	 * (aka the "max max"; eg, a site admin can change the zip question to have a max
+	 * of 5, but no larger than 12)
+	 *
+	 * @return array
+	 */
+	public function system_question_maxes(): array
+	{
+		return [
+			'fname'         => 45,
+			'lname'         => 45,
+			'address'       => 255,
+			'address2'      => 255,
+			'city'          => 45,
+			'zip'           => 12,
+			'email'         => 255,
+			'email_confirm' => 255,
+			'phone'         => 45,
+		];
+	}
+
+
+	/**
+	 * Given a QST_system value, gets the question's largest allowable max input.
+	 *
+	 * @param string $system_question_value
+	 * @return int|float
+	 * @see Registration_Form_Admin_Page::system_question_maxes()
+	 */
+	public function absolute_max_for_system_question(string $system_question_value)
+	{
+		$maxes = $this->system_question_maxes();
+		return $maxes[ $system_question_value ] ?? EE_INF;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function question_descriptions(): array
+	{
+		return $this->_question_descriptions;
+	}
+
+
+	/**
+	 * Returns all the question types that should have an admin-defined max input length
+	 *
+	 * @return array
+	 */
+	public function questionTypesWithMaxLength(): array
+	{
+		return (array) $this->question_types_with_max_length;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -124,7 +124,7 @@ 
                 EEM_Question::QST_type_year          => esc_html__('Year', 'event_espresso'),
             ]
         );
-        $this->_question_descriptions         = (array) apply_filters(
+        $this->_question_descriptions = (array) apply_filters(
             'FHEE__EEM_Question__construct__question_descriptions',
             [
                 EEM_Question::QST_type_checkbox      => esc_html__(
@@ -197,7 +197,7 @@ 
                 ),
             ]
         );
-        $this->_question_type_categories      = (array) apply_filters(
+        $this->_question_type_categories = (array) apply_filters(
             'FHEE__EEM_Question__construct__question_type_categories',
             [
                 'text'               => [
@@ -318,13 +318,13 @@ 
             'WP_User'                 => new EE_Belongs_To_Relation(),
         ];
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_read]       =
             new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] =
             new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       =
             new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     =
             new EE_Restriction_Generator_Reg_Form('QST_system');
 
         parent::__construct($timezone);
@@ -372,10 +372,10 @@ 
      */
     public function question_type_is_in_category(string $question_type, string $category): bool
     {
-        if (! isset($this->_question_type_categories[ $category ])) {
+        if ( ! isset($this->_question_type_categories[$category])) {
             return false;
         }
-        return in_array($question_type, $this->_question_type_categories[ $category ]);
+        return in_array($question_type, $this->_question_type_categories[$category]);
     }
 
 
@@ -387,8 +387,8 @@ 
      */
     public function question_types_in_category(string $category): array
     {
-        if (isset($this->_question_type_categories[ $category ])) {
-            return $this->_question_type_categories[ $category ];
+        if (isset($this->_question_type_categories[$category])) {
+            return $this->_question_type_categories[$category];
         }
         return [];
     }
@@ -552,7 +552,7 @@ 
     public function absolute_max_for_system_question(string $system_question_value)
     {
         $maxes = $this->system_question_maxes();
-        return $maxes[ $system_question_value ] ?? EE_INF;
+        return $maxes[$system_question_value] ?? EE_INF;
     }
 
 

core/db_models/EEM_Event_Question_Group.model.php

Indentation +103 added lines, -103 removed lines

@@ -14,116 +14,116 @@
  */
 class EEM_Event_Question_Group extends EEM_Base
 {
-    /**
-     * Name of the field indicating an event should use the question group for the primary attendee
-     */
-    const PRIMARY = 'EQG_primary';
+	/**
+	 * Name of the field indicating an event should use the question group for the primary attendee
+	 */
+	const PRIMARY = 'EQG_primary';
 
-    /**
-     * Name of hte field indicating an event should use the question group for additional attendees
-     */
-    const ADDITIONAL = 'EQG_additional';
+	/**
+	 * Name of hte field indicating an event should use the question group for additional attendees
+	 */
+	const ADDITIONAL = 'EQG_additional';
 
 
-    protected static ?EEM_Event_Question_Group $_instance = null;
+	protected static ?EEM_Event_Question_Group $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Event to Question Group Link', 'event_espresso');
-        $this->plural_item      = esc_html__('Event to Question Group Links', 'event_espresso');
-        $this->_tables          = [
-            'Event_Question_Group' => new EE_Primary_Table('esp_event_question_group', 'EQG_ID'),
-        ];
-        $this->_fields          = [
-            'Event_Question_Group' => [
-                'EQG_ID'         => new EE_Primary_Key_Int_Field(
-                    'EQG_ID',
-                    esc_html__('Event to Question Group Link ID', 'event_espresso')
-                ),
-                'EVT_ID'         => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Event ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'QSG_ID'         => new EE_Foreign_Key_Int_Field(
-                    'QSG_ID',
-                    esc_html__('Question Group Id', 'event_espresso'),
-                    false,
-                    0,
-                    'Question_Group'
-                ),
-                'EQG_additional' => new EE_Boolean_Field(
-                    'EQG_additional',
-                    esc_html__(
-                        'Flag indicating question is only for additional attendees',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'EQG_primary'    => new EE_Boolean_Field(
-                    'EQG_primary',
-                    esc_html__(
-                        'Flag indicating question is only for primary attendees',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Event'          => new EE_Belongs_To_Relation(),
-            'Question_Group' => new EE_Belongs_To_Relation(),
-        ];
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Event to Question Group Link', 'event_espresso');
+		$this->plural_item      = esc_html__('Event to Question Group Links', 'event_espresso');
+		$this->_tables          = [
+			'Event_Question_Group' => new EE_Primary_Table('esp_event_question_group', 'EQG_ID'),
+		];
+		$this->_fields          = [
+			'Event_Question_Group' => [
+				'EQG_ID'         => new EE_Primary_Key_Int_Field(
+					'EQG_ID',
+					esc_html__('Event to Question Group Link ID', 'event_espresso')
+				),
+				'EVT_ID'         => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('Event ID', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'QSG_ID'         => new EE_Foreign_Key_Int_Field(
+					'QSG_ID',
+					esc_html__('Question Group Id', 'event_espresso'),
+					false,
+					0,
+					'Question_Group'
+				),
+				'EQG_additional' => new EE_Boolean_Field(
+					'EQG_additional',
+					esc_html__(
+						'Flag indicating question is only for additional attendees',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'EQG_primary'    => new EE_Boolean_Field(
+					'EQG_primary',
+					esc_html__(
+						'Flag indicating question is only for primary attendees',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Event'          => new EE_Belongs_To_Relation(),
+			'Question_Group' => new EE_Belongs_To_Relation(),
+		];
 
-        // this model is generally available for reading
-        $path_to_event = 'Event';
+		// this model is generally available for reading
+		$path_to_event = 'Event';
 
-        $caps[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public($path_to_event);
-        $caps[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $caps[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $caps[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event,
-            EEM_Base::caps_edit
-        );
-        $this->_cap_restriction_generators = $caps;
-        parent::__construct($timezone);
-    }
+		$caps[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public($path_to_event);
+		$caps[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+		$caps[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+		$caps[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event,
+			EEM_Base::caps_edit
+		);
+		$this->_cap_restriction_generators = $caps;
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * Decides whether to use the 'EQG_primary' or newer 'EQG_additional' for use in queries, based on whether
-     * this is concerning primary attendees or additional attendees.
-     * If 1, true, or "primary" is passed in, returns EQG_primary. If 0, false, or "additional" is passed in, returns
-     * EQG_additional.
-     *
-     * @param string|boolean|int $context
-     * @return string
-     * @since 4.10.0.p
-     */
-    public function fieldNameForContext($context): string
-    {
-        // Basically do a strict switch statement.
-        switch (true) {
-            case $context === 'additional':
-            case $context === false:
-            case $context === 0:
-                $field_name = EEM_Event_Question_Group::ADDITIONAL;
-                break;
-            case $context === 'primary':
-            case $context === true:
-            case $context === 1:
-            default:
-                $field_name = EEM_Event_Question_Group::PRIMARY;
-        }
-        return apply_filters('FHEE__EEM_Event_Question_Group__fieldNameForContext', $field_name, $context);
-    }
+	/**
+	 * Decides whether to use the 'EQG_primary' or newer 'EQG_additional' for use in queries, based on whether
+	 * this is concerning primary attendees or additional attendees.
+	 * If 1, true, or "primary" is passed in, returns EQG_primary. If 0, false, or "additional" is passed in, returns
+	 * EQG_additional.
+	 *
+	 * @param string|boolean|int $context
+	 * @return string
+	 * @since 4.10.0.p
+	 */
+	public function fieldNameForContext($context): string
+	{
+		// Basically do a strict switch statement.
+		switch (true) {
+			case $context === 'additional':
+			case $context === false:
+			case $context === 0:
+				$field_name = EEM_Event_Question_Group::ADDITIONAL;
+				break;
+			case $context === 'primary':
+			case $context === true:
+			case $context === 1:
+			default:
+				$field_name = EEM_Event_Question_Group::PRIMARY;
+		}
+		return apply_filters('FHEE__EEM_Event_Question_Group__fieldNameForContext', $field_name, $context);
+	}
 }

core/db_classes/EE_Registration.class.php

Indentation +2546 added lines, -2546 removed lines

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

core/db_classes/EE_Transaction.class.php

Indentation +1749 added lines, -1749 removed lines

@@ -13,1753 +13,1753 @@
  */
 class EE_Transaction extends EE_Base_Class implements EEI_Transaction
 {
-    /**
-     * The length of time in seconds that a lock is applied before being considered expired.
-     * It is not long because a transaction should only be locked for the duration of the request that locked it
-     */
-    const LOCK_EXPIRATION = 2;
-
-    /**
-     * txn status upon initial construction.
-     *
-     * @var string
-     */
-    protected $_old_txn_status;
-
-    private ?EE_Registration $_primary_registrant = null;
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone
-     *                                        (if not set the timezone set for the website will be used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [], $timezone = '', $date_formats = [])
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        $txn        = $has_object
-            ? $has_object
-            : new self($props_n_values, false, $timezone, $date_formats);
-        if (! $has_object) {
-            $txn->set_old_txn_status($txn->status_ID());
-        }
-        return $txn;
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = '')
-    {
-        $txn = new self($props_n_values, true, $timezone);
-        $txn->set_old_txn_status($txn->status_ID());
-        return $txn;
-    }
-
-
-    /**
-     * Sets a meta field indicating that this TXN is locked and should not be updated in the db.
-     * If a lock has already been set, then we will attempt to remove it in case it has expired.
-     * If that also fails, then an exception is thrown.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function lock()
-    {
-        // attempt to set lock, but if that fails...
-        if (! $this->add_extra_meta('lock', time(), true)) {
-            // then attempt to remove the lock in case it is expired
-            if ($this->_remove_expired_lock()) {
-                // if removal was successful, then try setting lock again
-                $this->lock();
-            } else {
-                // but if the lock can not be removed, then throw an exception
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Could not lock Transaction %1$d because it is already locked, meaning another part of the system is currently editing it. It should already be unlocked by the time you read this, so please refresh the page and try again.',
-                            'event_espresso'
-                        ),
-                        $this->ID()
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * removes transaction lock applied in EE_Transaction::lock()
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function unlock()
-    {
-        return $this->delete_extra_meta('lock');
-    }
-
-
-    /**
-     * Decides whether or not now is the right time to update the transaction.
-     * This is useful because we don't always know if it is safe to update the transaction
-     * and its related data. why?
-     * because it's possible that the transaction is being used in another
-     * request and could overwrite anything we save.
-     * So we want to only update the txn once we know that won't happen.
-     * We also check that the lock isn't expired, and remove it if it is
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_locked()
-    {
-        // if TXN is not locked, then return false immediately
-        if (! $this->_get_lock()) {
-            return false;
-        }
-        // if not, then let's try and remove the lock in case it's expired...
-        // _remove_expired_lock() returns 0 when lock is valid (ie: removed = false)
-        // and a positive number if the lock was removed (ie: number of locks deleted),
-        // so we need to return the opposite
-        return ! $this->_remove_expired_lock();
-    }
-
-
-    /**
-     * Gets the meta field indicating that this TXN is locked
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_lock()
-    {
-        return (int) $this->get_extra_meta('lock', true, 0);
-    }
-
-
-    /**
-     * If the lock on this transaction is expired, then we want to remove it so that the transaction can be updated
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _remove_expired_lock()
-    {
-        $locked = $this->_get_lock();
-        if ($locked && time() - EE_Transaction::LOCK_EXPIRATION > $locked) {
-            return $this->unlock();
-        }
-        return 0;
-    }
-
-
-    /**
-     * Set transaction total
-     *
-     * @param float $total total value of transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_total($total = 0.00)
-    {
-        $this->set('TXN_total', (float) $total);
-    }
-
-
-    /**
-     * Set Total Amount Paid to Date
-     *
-     * @param float $total_paid total amount paid to date (sum of all payments)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_paid($total_paid = 0.00)
-    {
-        $this->set('TXN_paid', (float) $total_paid);
-    }
-
-
-    /**
-     * Set transaction status
-     *
-     * @param string $status        whether the transaction is open, declined, accepted,
-     *                              or any number of custom values that can be set
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_status($status = '')
-    {
-        $this->set('STS_ID', $status);
-    }
-
-
-    /**
-     * Set hash salt
-     *
-     * @param string $hash_salt required for some payment gateways
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_hash_salt($hash_salt = '')
-    {
-        $this->set('TXN_hash_salt', $hash_salt);
-    }
-
-
-    /**
-     * Sets TXN_reg_steps array
-     *
-     * @param array $txn_reg_steps
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_steps(array $txn_reg_steps)
-    {
-        $this->set('TXN_reg_steps', $txn_reg_steps);
-    }
-
-
-    /**
-     * Gets TXN_reg_steps
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_steps()
-    {
-        $TXN_reg_steps = $this->get('TXN_reg_steps');
-        return is_array($TXN_reg_steps)
-            ? $TXN_reg_steps
-            : [];
-    }
-
-
-    /**
-     * @param string|null $schema
-     *     Schemas:
-     *     'localized_float': "3,023.00"
-     *     'no_currency_code': "$3,023.00"
-     *     null: "$3,023.00<span>USD</span>"
-     * @return string of transaction's total cost, with currency symbol and decimal
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_total(?string $schema = null)
-    {
-        return $this->get_pretty('TXN_total', $schema);
-    }
-
-
-    /**
-     * Gets the amount paid in a pretty string (formatted and with currency symbol)
-     *
-     * @param string|null $schema
-     *     Schemas:
-     *     'localized_float': "3,023.00"
-     *     'no_currency_code': "$3,023.00"
-     *     null: "$3,023.00<span>USD</span>"
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_paid(?string $schema = null)
-    {
-        return $this->get_pretty('TXN_paid', $schema);
-    }
-
-
-    /**
-     * calculate the amount remaining for this transaction and return;
-     *
-     * @return float amount remaining
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function remaining()
-    {
-        return $this->total() - $this->paid();
-    }
-
-
-    /**
-     * get Transaction Total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total()
-    {
-        return (float) $this->get('TXN_total');
-    }
-
-
-    /**
-     * get Total Amount Paid to Date
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function paid()
-    {
-        return (float) $this->get('TXN_paid');
-    }
-
-
-    /**
-     * @return mixed|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_cart_session()
-    {
-        $session_data = (array) $this->get('TXN_session_data');
-        return isset($session_data['cart']) && $session_data['cart'] instanceof EE_Cart
-            ? $session_data['cart']
-            : null;
-    }
-
-
-    /**
-     * get Transaction session data
-     *
-     * @return array|mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function session_data()
-    {
-        $session_data = $this->get('TXN_session_data');
-        if (empty($session_data)) {
-            $session_data = [
-                'id'            => null,
-                'user_id'       => null,
-                'ip_address'    => null,
-                'user_agent'    => null,
-                'init_access'   => null,
-                'last_access'   => null,
-                'pages_visited' => [],
-            ];
-        }
-        return $session_data;
-    }
-
-
-    /**
-     * Set session data within the TXN object
-     *
-     * @param EE_Session|array|null $session_data
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_txn_session_data($session_data)
-    {
-        if ($session_data instanceof EE_Session) {
-            $this->set('TXN_session_data', $session_data->get_session_data(null, true));
-        } else {
-            $this->set('TXN_session_data', $session_data);
-        }
-    }
-
-
-    /**
-     * get Transaction hash salt
-     *
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function hash_salt_()
-    {
-        return $this->get('TXN_hash_salt');
-    }
-
-
-    /**
-     * Returns the transaction datetime as either:
-     *            - unix timestamp format ($format = false, $gmt = true)
-     *            - formatted date string including the UTC (timezone) offset ($format = true ($gmt
-     *              has no affect with this option)), this also may include a timezone abbreviation if the
-     *              set timezone in this class differs from what the timezone is on the blog.
-     *            - formatted date string including the UTC (timezone) offset (default).
-     *
-     * @param boolean $format   - whether to return a unix timestamp (default) or formatted date string
-     * @param boolean $gmt      - whether to return a unix timestamp with UTC offset applied (default)
-     *                          or no UTC offset applied
-     * @return string | int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function datetime($format = false, $gmt = false)
-    {
-        if ($format) {
-            return $this->get_pretty('TXN_timestamp');
-        }
-        if ($gmt) {
-            return $this->get_raw('TXN_timestamp');
-        }
-        return $this->get('TXN_timestamp');
-    }
-
-
-    /**
-     * Gets registrations on this transaction
-     *
-     * @param array   $query_params array of query parameters
-     * @param boolean $get_cached   TRUE to retrieve cached registrations or FALSE to pull from the db
-     * @return EE_Base_Class[]|EE_Registration[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function registrations($query_params = [], $get_cached = false)
-    {
-        $query_params = (empty($query_params) || ! is_array($query_params))
-            ? [
-                'order_by' => [
-                    'Event.EVT_name'     => 'ASC',
-                    'Attendee.ATT_lname' => 'ASC',
-                    'Attendee.ATT_fname' => 'ASC',
-                    'REG_ID'             => 'ASC',
-                ],
-            ]
-            : $query_params;
-        $query_params = $get_cached
-            ? []
-            : $query_params;
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event
-     * function for getting attendees and how many registrations they each have for an event)
-     *
-     * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT'
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function attendees()
-    {
-        return $this->get_many_related('Attendee', [['Registration.Transaction.TXN_ID' => $this->ID()]]);
-    }
-
-
-    /**
-     * Gets payments for this transaction. Unlike other such functions, order by 'DESC' by default
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Payment[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payments($query_params = [])
-    {
-        return $this->get_many_related('Payment', $query_params);
-    }
-
-
-    /**
-     * gets only approved payments for this transaction
-     *
-     * @return EE_Base_Class[]|EE_Payment[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function approved_payments()
-    {
-        EE_Registry::instance()->load_model('Payment');
-        return $this->get_many_related(
-            'Payment',
-            [
-                ['STS_ID' => EEM_Payment::status_id_approved],
-                'order_by' => ['PAY_timestamp' => 'DESC'],
-            ]
-        );
-    }
-
-
-    /**
-     * Gets all payments which have not been approved
-     *
-     * @return EE_Base_Class[]|EEI_Payment[]
-     * @throws EE_Error if a model is misconfigured somehow
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pending_payments()
-    {
-        return $this->get_many_related(
-            'Payment',
-            [
-                [
-                    'STS_ID' => EEM_Payment::status_id_pending,
-                ],
-                'order_by' => [
-                    'PAY_timestamp' => 'DESC',
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * echoes $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
-    }
-
-
-    /**
-     * returns a pretty version of the status, good for displaying to users
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            [$this->status_ID() => esc_html__('unknown', 'event_espresso')],
-            false,
-            'sentence'
-        );
-        $icon   = '';
-        switch ($this->status_ID()) {
-            case EEM_Transaction::complete_status_code:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
-                    : '';
-                break;
-            case EEM_Transaction::incomplete_status_code:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-marker ee-icon-size-16 lt-blue-text"></span>'
-                    : '';
-                break;
-            case EEM_Transaction::abandoned_status_code:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-marker ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-            case EEM_Transaction::failed_status_code:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-            case EEM_Transaction::overpaid_status_code:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-        }
-        return $icon . $status[ $this->status_ID() ];
-    }
-
-
-    /**
-     * get Transaction Status
-     *
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * Returns TRUE or FALSE for whether or not this transaction cost any money
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_free()
-    {
-        return EEH_Money::compare_floats($this->get('TXN_total'), 0, '==');
-    }
-
-
-    /**
-     * Returns whether this transaction is complete
-     * Useful in templates and other logic for deciding if we should ask for another payment...
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_completed()
-    {
-        return $this->status_ID() === EEM_Transaction::complete_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction is incomplete
-     * Useful in templates and other logic for deciding if we should ask for another payment...
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_incomplete()
-    {
-        return $this->status_ID() === EEM_Transaction::incomplete_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction is overpaid
-     * Useful in templates and other logic for deciding if monies need to be refunded
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_overpaid()
-    {
-        return $this->status_ID() === EEM_Transaction::overpaid_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction was abandoned
-     * meaning that the transaction/registration process was somehow interrupted and never completed
-     * but that contact information exists for at least one registrant
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_abandoned()
-    {
-        return $this->status_ID() === EEM_Transaction::abandoned_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction failed
-     * meaning that the transaction/registration process was somehow interrupted and never completed
-     * and that NO contact information exists for any registrants
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function failed()
-    {
-        return $this->status_ID() === EEM_Transaction::failed_status_code;
-    }
-
-
-    /**
-     * This returns the url for the invoice of this transaction
-     *
-     * @param string $type 'html' or 'pdf' (default is pdf)
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function invoice_url($type = 'html')
-    {
-        $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
-            return '';
-        }
-        return $REG->invoice_url($type);
-    }
-
-
-    /**
-     * Gets the primary registration only
-     *
-     * @return EE_Base_Class|EE_Registration
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function primary_registration()
-    {
-        if($this->_primary_registrant instanceof EE_Registration) {
-            return $this->_primary_registrant;
-        }
-
-        $registrations = (array) $this->get_many_related(
-            'Registration',
-            [['REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT]]
-        );
-        foreach ($registrations as $registration) {
-            // valid registration that is NOT cancelled or declined ?
-            if (
-                $registration instanceof EE_Registration
-                && ! in_array($registration->status_ID(), EEM_Registration::closed_reg_statuses(), true)
-            ) {
-                $this->_primary_registrant = $registration;
-                return $registration;
-            }
-        }
-        // nothing valid found, so just return first thing from array of results
-        $primary_registrant = reset($registrations);
-        $this->_primary_registrant = $primary_registrant instanceof EE_Registration ? $primary_registrant : null;
-        return $this->_primary_registrant;
-    }
-
-
-    /**
-     * Gets the URL for viewing the receipt
-     *
-     * @param string $type 'pdf' or 'html' (default is 'html')
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function receipt_url($type = 'html')
-    {
-        $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
-            return '';
-        }
-        return $REG->receipt_url($type);
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_overview_url()
-    {
-        $primary_registration = $this->primary_registration();
-        return $primary_registration instanceof EE_Registration
-            ? $primary_registration->payment_overview_url()
-            : false;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function gateway_response_on_transaction()
-    {
-        $payment = $this->get_first_related('Payment');
-        return $payment instanceof EE_Payment
-            ? $payment->gateway_response()
-            : '';
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Base_Class|EE_Status
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Gets all the extra meta info on this payment
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Extra_Meta
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function extra_meta($query_params = [])
-    {
-        return $this->get_many_related('Extra_Meta', $query_params);
-    }
-
-
-    /**
-     * Wrapper for _add_relation_to
-     *
-     * @param EE_Registration $registration
-     * @return EE_Base_Class the relation was added to
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_registration(EE_Registration $registration)
-    {
-        return $this->_add_relation_to($registration, 'Registration');
-    }
-
-
-    /**
-     * Removes the given registration from being related (even before saving this transaction).
-     * If an ID/index is provided and this transaction isn't saved yet, removes it from list of cached relations
-     *
-     * @param int $registration_or_id
-     * @return EE_Base_Class that was removed from being related
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function remove_registration_with_id($registration_or_id)
-    {
-        return $this->_remove_relation_to($registration_or_id, 'Registration');
-    }
-
-
-    /**
-     * Gets all the line items which are for ACTUAL items
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function items_purchased()
-    {
-        return $this->line_items([['LIN_type' => EEM_Line_Item::type_line_item]]);
-    }
-
-
-    /**
-     * Wrapper for _add_relation_to
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Base_Class the relation was added to
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_line_item(EE_Line_Item $line_item)
-    {
-        return $this->_add_relation_to($line_item, 'Line_Item');
-    }
-
-
-    /**
-     * Gets ALL the line items related to this transaction (unstructured)
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function line_items($query_params = [])
-    {
-        return $this->get_many_related('Line_Item', $query_params);
-    }
-
-
-    /**
-     * Gets all the line items which are taxes on the total
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function tax_items()
-    {
-        return $this->line_items([['LIN_type' => EEM_Line_Item::type_tax]]);
-    }
-
-
-    /**
-     * Gets the total line item (which is a parent of all other related line items,
-     * meaning it takes them all into account on its total)
-     *
-     * @param bool $create_if_not_found
-     * @return EE_Line_Item|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total_line_item(bool $create_if_not_found = true): ?EE_Line_Item
-    {
-        $item = $this->get_first_related('Line_Item', [['LIN_type' => EEM_Line_Item::type_total]]);
-        if ($item instanceof EE_Line_Item) {
-            return $item;
-        }
-        return $create_if_not_found
-            ? EEH_Line_Item::create_total_line_item($this)
-            : null;
-    }
-
-
-    /**
-     * Returns the total amount of tax on this transaction
-     * (assumes there's only one tax subtotal line item)
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function tax_total()
-    {
-        $tax_line_item = $this->tax_total_line_item();
-        if ($tax_line_item) {
-            return (float) $tax_line_item->total();
-        }
-        return (float) 0;
-    }
-
-
-    /**
-     * Gets the tax subtotal line item (assumes there's only one)
-     *
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function tax_total_line_item()
-    {
-        return EEH_Line_Item::get_taxes_subtotal($this->total_line_item());
-    }
-
-
-    /**
-     * Gets the array of billing info for the gateway and for this transaction's primary registration's attendee.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function billing_info()
-    {
-        $payment_method = $this->payment_method();
-        if (! $payment_method) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Could not find billing info for transaction because no gateway has been used for it yet',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $primary_reg = $this->primary_registration();
-        if (! $primary_reg) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Cannot get billing info for gateway %s on transaction because no primary registration exists',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $attendee = $primary_reg->attendee();
-        if (! $attendee) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $attendee->billing_info_for_payment_method($payment_method);
-    }
-
-
-    /**
-     * Gets PMD_ID
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_method_ID()
-    {
-        return $this->get('PMD_ID');
-    }
-
-
-    /**
-     * Sets PMD_ID
-     *
-     * @param int $PMD_ID
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_payment_method_ID($PMD_ID)
-    {
-        $this->set('PMD_ID', $PMD_ID);
-    }
-
-
-    /**
-     * Gets the last-used payment method on this transaction
-     * (we COULD just use the last-made payment, but some payment methods, namely
-     * offline ones, dont' create payments)
-     *
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_method()
-    {
-        $PMD_ID = $this->payment_method_ID();
-        if($PMD_ID) {
-            $pm = EEM_Payment_Method::instance()->get_one_by_ID($this->payment_method_ID());
-            if ($pm instanceof EE_Payment_Method) {
-                return $pm;
-            }
-        }
-        $last_payment = $this->last_payment();
-        if ($last_payment instanceof EE_Payment && $last_payment->payment_method()) {
-            return $last_payment->payment_method();
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the last payment made
-     *
-     * @return EE_Base_Class|EE_Payment|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function last_payment(): ?EE_Payment
-    {
-        return $this->get_first_related('Payment', ['order_by' => ['PAY_ID' => 'desc']]);
-    }
-
-
-    /**
-     * Gets all the line items which are unrelated to tickets on this transaction
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function non_ticket_line_items()
-    {
-        return EEM_Line_Item::instance()->get_all_non_ticket_line_items_for_transaction($this->ID());
-    }
-
-
-    /**
-     * possibly toggles TXN status
-     *
-     * @param boolean $update whether to save the TXN
-     * @return bool whether the TXN was saved
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function update_status_based_on_total_paid($update = true)
-    {
-        // set transaction status based on comparison of TXN_paid vs TXN_total
-        if (EEH_Money::compare_floats($this->paid(), $this->total(), '>')) {
-            $new_txn_status = EEM_Transaction::overpaid_status_code;
-        } elseif (EEH_Money::compare_floats($this->paid(), $this->total())) {
-            $new_txn_status = EEM_Transaction::complete_status_code;
-        } elseif (EEH_Money::compare_floats($this->paid(), $this->total(), '<')) {
-            $new_txn_status = EEM_Transaction::incomplete_status_code;
-        } else {
-            throw new RuntimeException(
-                esc_html__('The total paid calculation for this transaction is inaccurate.', 'event_espresso')
-            );
-        }
-        if ($new_txn_status !== $this->status_ID()) {
-            $this->set_status($new_txn_status);
-            if ($update) {
-                return (bool) $this->save();
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Updates the transaction's status and total_paid based on all the payments
-     * that apply to it
-     *
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated
-     */
-    public function update_based_on_payments()
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
-            ),
-            '4.6.0'
-        );
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($this);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function old_txn_status()
-    {
-        return $this->_old_txn_status;
-    }
-
-
-    /**
-     * @param string $old_txn_status
-     */
-    public function set_old_txn_status($old_txn_status)
-    {
-        // only set the first time
-        if ($this->_old_txn_status === null) {
-            $this->_old_txn_status = $old_txn_status;
-        }
-    }
-
-
-    /**
-     * reg_status_updated
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function txn_status_updated()
-    {
-        return $this->status_ID() !== $this->_old_txn_status && $this->_old_txn_status !== null;
-    }
-
-
-    /**
-     * _reg_steps_completed
-     * if $check_all is TRUE, then returns TRUE if ALL reg steps have been marked as completed,
-     * if a $reg_step_slug is provided, then this step will be skipped when testing for completion
-     * if $check_all is FALSE and a $reg_step_slug is provided, then ONLY that reg step will be tested for completion
-     *
-     * @param string $reg_step_slug
-     * @param bool   $check_all
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
-    {
-        $reg_steps = $this->reg_steps();
-        if (! is_array($reg_steps) || empty($reg_steps)) {
-            return false;
-        }
-        // loop thru reg steps array)
-        foreach ($reg_steps as $slug => $reg_step_completed) {
-            // if NOT checking ALL steps (only checking one step)
-            if (! $check_all) {
-                // and this is the one
-                if ($slug === $reg_step_slug) {
-                    return $reg_step_completed;
-                }
-                // skip to next reg step in loop
-                continue;
-            }
-            // $check_all must be true, else we would never have gotten to this point
-            if ($slug === $reg_step_slug) {
-                // if we reach this point, then we are testing either:
-                // all_reg_steps_completed_except() or
-                // all_reg_steps_completed_except_final_step(),
-                // and since this is the reg step EXCEPTION being tested
-                // we want to return true (yes true) if this reg step is NOT completed
-                // ie: "is everything completed except the final step?"
-                // "that is correct... the final step is not completed, but all others are."
-                return $reg_step_completed !== true;
-            }
-            if ($reg_step_completed !== true) {
-                // if any reg step is NOT completed, then ALL steps are not completed
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * all_reg_steps_completed
-     * returns:
-     *    true if ALL reg steps have been marked as completed
-     *        or false if any step is not completed
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function all_reg_steps_completed()
-    {
-        return $this->_reg_steps_completed();
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
-     *        or false if any other step is not completed
-     *        or false if ALL steps are completed including the exception you are testing !!!
-     *
-     * @param string $exception
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function all_reg_steps_completed_except($exception = '')
-    {
-        return $this->_reg_steps_completed($exception);
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except the final step, have been marked as completed
-     *        or false if any step is not completed
-     *    or false if ALL steps are completed including the final step !!!
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function all_reg_steps_completed_except_final_step()
-    {
-        return $this->_reg_steps_completed('finalize_registration');
-    }
-
-
-    /**
-     * reg_step_completed
-     * returns:
-     *    true if a specific reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @param string $reg_step_slug
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_step_completed($reg_step_slug)
-    {
-        return $this->_reg_steps_completed($reg_step_slug, false);
-    }
-
-
-    /**
-     * completed_final_reg_step
-     * returns:
-     *    true if the finalize_registration reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function final_reg_step_completed()
-    {
-        return $this->_reg_steps_completed('finalize_registration', false);
-    }
-
-
-    /**
-     * set_reg_step_initiated
-     * given a valid TXN_reg_step, this sets it's value to a unix timestamp
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_step_initiated($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, time());
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step, this sets the step as completed
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_step_completed($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, true);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step slug, this sets the step as NOT completed
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_step_not_completed($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, false);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid reg step slug, this sets the TXN_reg_step completed status which is either:
-     *
-     * @param string      $reg_step_slug
-     * @param boolean|int $status
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _set_reg_step_completed_status($reg_step_slug, $status)
-    {
-        // validate status
-        $status = is_bool($status) || is_int($status)
-            ? $status
-            : false;
-        // get reg steps array
-        $txn_reg_steps = $this->reg_steps();
-        // if reg step does NOT exist
-        if (! isset($txn_reg_steps[ $reg_step_slug ])) {
-            return false;
-        }
-        // if  we're trying to complete a step that is already completed
-        if ($txn_reg_steps[ $reg_step_slug ] === true) {
-            return true;
-        }
-        // if  we're trying to complete a step that hasn't even started
-        if ($status === true && $txn_reg_steps[ $reg_step_slug ] === false) {
-            return false;
-        }
-        // if current status value matches the incoming value (no change)
-        // type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
-        if ((int) $txn_reg_steps[ $reg_step_slug ] === (int) $status) {
-            // this will happen in cases where multiple AJAX requests occur during the same step
-            return true;
-        }
-        // if we're trying to set a start time, but it has already been set...
-        if (is_numeric($status) && is_numeric($txn_reg_steps[ $reg_step_slug ])) {
-            // skip the update below, but don't return FALSE so that errors won't be displayed
-            return true;
-        }
-        // update completed status
-        $txn_reg_steps[ $reg_step_slug ] = $status;
-        $this->set_reg_steps($txn_reg_steps);
-        $this->save();
-        return true;
-    }
-
-
-    /**
-     * remove_reg_step
-     * given a valid TXN_reg_step slug, this will remove (unset)
-     * the reg step from the TXN reg step array
-     *
-     * @param string $reg_step_slug
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function remove_reg_step($reg_step_slug)
-    {
-        // get reg steps array
-        $txn_reg_steps = $this->reg_steps();
-        unset($txn_reg_steps[ $reg_step_slug ]);
-        $this->set_reg_steps($txn_reg_steps);
-    }
-
-
-    /**
-     * toggle_failed_transaction_status
-     * upgrades a TXNs status from failed to abandoned,
-     * meaning that contact information has been captured for at least one registrant
-     *
-     * @param bool $save
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function toggle_failed_transaction_status($save = true)
-    {
-        // if TXN status is still set as "failed"...
-        if ($this->status_ID() === EEM_Transaction::failed_status_code) {
-            $this->set_status(EEM_Transaction::abandoned_status_code);
-            if ($save) {
-                $this->save();
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * toggle_abandoned_transaction_status
-     * upgrades a TXNs status from failed or abandoned to incomplete
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function toggle_abandoned_transaction_status()
-    {
-        // if TXN status has not been updated already due to a payment, and is still set as "failed" or "abandoned"...
-        $txn_status = $this->status_ID();
-        if (
-            $txn_status === EEM_Transaction::failed_status_code
-            || $txn_status === EEM_Transaction::abandoned_status_code
-        ) {
-            // if a contact record for the primary registrant has been created
-            if (
-                $this->primary_registration() instanceof EE_Registration
-                && $this->primary_registration()->attendee() instanceof EE_Attendee
-            ) {
-                $this->set_status(EEM_Transaction::incomplete_status_code);
-            } else {
-                // no contact record? yer abandoned!
-                $this->set_status(EEM_Transaction::abandoned_status_code);
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * checks if an Abandoned TXN has any related payments, and if so,
-     * updates the TXN status based on the amount paid
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function verify_abandoned_transaction_status()
-    {
-        if ($this->status_ID() !== EEM_Transaction::abandoned_status_code) {
-            return;
-        }
-        $payments = $this->get_many_related('Payment');
-        if (! empty($payments)) {
-            foreach ($payments as $payment) {
-                if ($payment instanceof EE_Payment) {
-                    // kk this TXN should NOT be abandoned
-                    $this->update_status_based_on_total_paid();
-                    if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-                        EE_Error::add_attention(
-                            sprintf(
-                                esc_html__(
-                                    'The status for Transaction #%1$d has been updated from "Abandoned" to "%2$s", because at least one payment has been made towards it. If the payment appears in the "Payment Details" table below, you may need to edit its status and/or other details as well.',
-                                    'event_espresso'
-                                ),
-                                $this->ID(),
-                                $this->pretty_status()
-                            )
-                        );
-                    }
-                    // get final reg step status
-                    $finalized = $this->final_reg_step_completed();
-                    // if the 'finalize_registration' step has been initiated (has a timestamp)
-                    // but has not yet been fully completed (TRUE)
-                    if (is_int($finalized) && $finalized !== false && $finalized !== true) {
-                        $this->set_reg_step_completed('finalize_registration');
-                        $this->save();
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @since 4.10.4.p
-     */
-    public function recalculateLineItems()
-    {
-        $total_line_item = $this->total_line_item(false);
-        if ($total_line_item instanceof EE_Line_Item) {
-            EEH_Line_Item::resetIsTaxableForTickets($total_line_item);
-            return EEH_Line_Item::apply_taxes($total_line_item, true);
-        }
-        return false;
-    }
+	/**
+	 * The length of time in seconds that a lock is applied before being considered expired.
+	 * It is not long because a transaction should only be locked for the duration of the request that locked it
+	 */
+	const LOCK_EXPIRATION = 2;
+
+	/**
+	 * txn status upon initial construction.
+	 *
+	 * @var string
+	 */
+	protected $_old_txn_status;
+
+	private ?EE_Registration $_primary_registrant = null;
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone
+	 *                                        (if not set the timezone set for the website will be used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [], $timezone = '', $date_formats = [])
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		$txn        = $has_object
+			? $has_object
+			: new self($props_n_values, false, $timezone, $date_formats);
+		if (! $has_object) {
+			$txn->set_old_txn_status($txn->status_ID());
+		}
+		return $txn;
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = '')
+	{
+		$txn = new self($props_n_values, true, $timezone);
+		$txn->set_old_txn_status($txn->status_ID());
+		return $txn;
+	}
+
+
+	/**
+	 * Sets a meta field indicating that this TXN is locked and should not be updated in the db.
+	 * If a lock has already been set, then we will attempt to remove it in case it has expired.
+	 * If that also fails, then an exception is thrown.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function lock()
+	{
+		// attempt to set lock, but if that fails...
+		if (! $this->add_extra_meta('lock', time(), true)) {
+			// then attempt to remove the lock in case it is expired
+			if ($this->_remove_expired_lock()) {
+				// if removal was successful, then try setting lock again
+				$this->lock();
+			} else {
+				// but if the lock can not be removed, then throw an exception
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Could not lock Transaction %1$d because it is already locked, meaning another part of the system is currently editing it. It should already be unlocked by the time you read this, so please refresh the page and try again.',
+							'event_espresso'
+						),
+						$this->ID()
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * removes transaction lock applied in EE_Transaction::lock()
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function unlock()
+	{
+		return $this->delete_extra_meta('lock');
+	}
+
+
+	/**
+	 * Decides whether or not now is the right time to update the transaction.
+	 * This is useful because we don't always know if it is safe to update the transaction
+	 * and its related data. why?
+	 * because it's possible that the transaction is being used in another
+	 * request and could overwrite anything we save.
+	 * So we want to only update the txn once we know that won't happen.
+	 * We also check that the lock isn't expired, and remove it if it is
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_locked()
+	{
+		// if TXN is not locked, then return false immediately
+		if (! $this->_get_lock()) {
+			return false;
+		}
+		// if not, then let's try and remove the lock in case it's expired...
+		// _remove_expired_lock() returns 0 when lock is valid (ie: removed = false)
+		// and a positive number if the lock was removed (ie: number of locks deleted),
+		// so we need to return the opposite
+		return ! $this->_remove_expired_lock();
+	}
+
+
+	/**
+	 * Gets the meta field indicating that this TXN is locked
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_lock()
+	{
+		return (int) $this->get_extra_meta('lock', true, 0);
+	}
+
+
+	/**
+	 * If the lock on this transaction is expired, then we want to remove it so that the transaction can be updated
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _remove_expired_lock()
+	{
+		$locked = $this->_get_lock();
+		if ($locked && time() - EE_Transaction::LOCK_EXPIRATION > $locked) {
+			return $this->unlock();
+		}
+		return 0;
+	}
+
+
+	/**
+	 * Set transaction total
+	 *
+	 * @param float $total total value of transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_total($total = 0.00)
+	{
+		$this->set('TXN_total', (float) $total);
+	}
+
+
+	/**
+	 * Set Total Amount Paid to Date
+	 *
+	 * @param float $total_paid total amount paid to date (sum of all payments)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_paid($total_paid = 0.00)
+	{
+		$this->set('TXN_paid', (float) $total_paid);
+	}
+
+
+	/**
+	 * Set transaction status
+	 *
+	 * @param string $status        whether the transaction is open, declined, accepted,
+	 *                              or any number of custom values that can be set
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_status($status = '')
+	{
+		$this->set('STS_ID', $status);
+	}
+
+
+	/**
+	 * Set hash salt
+	 *
+	 * @param string $hash_salt required for some payment gateways
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_hash_salt($hash_salt = '')
+	{
+		$this->set('TXN_hash_salt', $hash_salt);
+	}
+
+
+	/**
+	 * Sets TXN_reg_steps array
+	 *
+	 * @param array $txn_reg_steps
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_steps(array $txn_reg_steps)
+	{
+		$this->set('TXN_reg_steps', $txn_reg_steps);
+	}
+
+
+	/**
+	 * Gets TXN_reg_steps
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_steps()
+	{
+		$TXN_reg_steps = $this->get('TXN_reg_steps');
+		return is_array($TXN_reg_steps)
+			? $TXN_reg_steps
+			: [];
+	}
+
+
+	/**
+	 * @param string|null $schema
+	 *     Schemas:
+	 *     'localized_float': "3,023.00"
+	 *     'no_currency_code': "$3,023.00"
+	 *     null: "$3,023.00<span>USD</span>"
+	 * @return string of transaction's total cost, with currency symbol and decimal
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_total(?string $schema = null)
+	{
+		return $this->get_pretty('TXN_total', $schema);
+	}
+
+
+	/**
+	 * Gets the amount paid in a pretty string (formatted and with currency symbol)
+	 *
+	 * @param string|null $schema
+	 *     Schemas:
+	 *     'localized_float': "3,023.00"
+	 *     'no_currency_code': "$3,023.00"
+	 *     null: "$3,023.00<span>USD</span>"
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_paid(?string $schema = null)
+	{
+		return $this->get_pretty('TXN_paid', $schema);
+	}
+
+
+	/**
+	 * calculate the amount remaining for this transaction and return;
+	 *
+	 * @return float amount remaining
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function remaining()
+	{
+		return $this->total() - $this->paid();
+	}
+
+
+	/**
+	 * get Transaction Total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total()
+	{
+		return (float) $this->get('TXN_total');
+	}
+
+
+	/**
+	 * get Total Amount Paid to Date
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function paid()
+	{
+		return (float) $this->get('TXN_paid');
+	}
+
+
+	/**
+	 * @return mixed|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_cart_session()
+	{
+		$session_data = (array) $this->get('TXN_session_data');
+		return isset($session_data['cart']) && $session_data['cart'] instanceof EE_Cart
+			? $session_data['cart']
+			: null;
+	}
+
+
+	/**
+	 * get Transaction session data
+	 *
+	 * @return array|mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function session_data()
+	{
+		$session_data = $this->get('TXN_session_data');
+		if (empty($session_data)) {
+			$session_data = [
+				'id'            => null,
+				'user_id'       => null,
+				'ip_address'    => null,
+				'user_agent'    => null,
+				'init_access'   => null,
+				'last_access'   => null,
+				'pages_visited' => [],
+			];
+		}
+		return $session_data;
+	}
+
+
+	/**
+	 * Set session data within the TXN object
+	 *
+	 * @param EE_Session|array|null $session_data
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_txn_session_data($session_data)
+	{
+		if ($session_data instanceof EE_Session) {
+			$this->set('TXN_session_data', $session_data->get_session_data(null, true));
+		} else {
+			$this->set('TXN_session_data', $session_data);
+		}
+	}
+
+
+	/**
+	 * get Transaction hash salt
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function hash_salt_()
+	{
+		return $this->get('TXN_hash_salt');
+	}
+
+
+	/**
+	 * Returns the transaction datetime as either:
+	 *            - unix timestamp format ($format = false, $gmt = true)
+	 *            - formatted date string including the UTC (timezone) offset ($format = true ($gmt
+	 *              has no affect with this option)), this also may include a timezone abbreviation if the
+	 *              set timezone in this class differs from what the timezone is on the blog.
+	 *            - formatted date string including the UTC (timezone) offset (default).
+	 *
+	 * @param boolean $format   - whether to return a unix timestamp (default) or formatted date string
+	 * @param boolean $gmt      - whether to return a unix timestamp with UTC offset applied (default)
+	 *                          or no UTC offset applied
+	 * @return string | int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function datetime($format = false, $gmt = false)
+	{
+		if ($format) {
+			return $this->get_pretty('TXN_timestamp');
+		}
+		if ($gmt) {
+			return $this->get_raw('TXN_timestamp');
+		}
+		return $this->get('TXN_timestamp');
+	}
+
+
+	/**
+	 * Gets registrations on this transaction
+	 *
+	 * @param array   $query_params array of query parameters
+	 * @param boolean $get_cached   TRUE to retrieve cached registrations or FALSE to pull from the db
+	 * @return EE_Base_Class[]|EE_Registration[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function registrations($query_params = [], $get_cached = false)
+	{
+		$query_params = (empty($query_params) || ! is_array($query_params))
+			? [
+				'order_by' => [
+					'Event.EVT_name'     => 'ASC',
+					'Attendee.ATT_lname' => 'ASC',
+					'Attendee.ATT_fname' => 'ASC',
+					'REG_ID'             => 'ASC',
+				],
+			]
+			: $query_params;
+		$query_params = $get_cached
+			? []
+			: $query_params;
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event
+	 * function for getting attendees and how many registrations they each have for an event)
+	 *
+	 * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT'
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function attendees()
+	{
+		return $this->get_many_related('Attendee', [['Registration.Transaction.TXN_ID' => $this->ID()]]);
+	}
+
+
+	/**
+	 * Gets payments for this transaction. Unlike other such functions, order by 'DESC' by default
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Payment[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payments($query_params = [])
+	{
+		return $this->get_many_related('Payment', $query_params);
+	}
+
+
+	/**
+	 * gets only approved payments for this transaction
+	 *
+	 * @return EE_Base_Class[]|EE_Payment[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function approved_payments()
+	{
+		EE_Registry::instance()->load_model('Payment');
+		return $this->get_many_related(
+			'Payment',
+			[
+				['STS_ID' => EEM_Payment::status_id_approved],
+				'order_by' => ['PAY_timestamp' => 'DESC'],
+			]
+		);
+	}
+
+
+	/**
+	 * Gets all payments which have not been approved
+	 *
+	 * @return EE_Base_Class[]|EEI_Payment[]
+	 * @throws EE_Error if a model is misconfigured somehow
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pending_payments()
+	{
+		return $this->get_many_related(
+			'Payment',
+			[
+				[
+					'STS_ID' => EEM_Payment::status_id_pending,
+				],
+				'order_by' => [
+					'PAY_timestamp' => 'DESC',
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * echoes $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
+	}
+
+
+	/**
+	 * returns a pretty version of the status, good for displaying to users
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			[$this->status_ID() => esc_html__('unknown', 'event_espresso')],
+			false,
+			'sentence'
+		);
+		$icon   = '';
+		switch ($this->status_ID()) {
+			case EEM_Transaction::complete_status_code:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
+					: '';
+				break;
+			case EEM_Transaction::incomplete_status_code:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-marker ee-icon-size-16 lt-blue-text"></span>'
+					: '';
+				break;
+			case EEM_Transaction::abandoned_status_code:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-marker ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+			case EEM_Transaction::failed_status_code:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+			case EEM_Transaction::overpaid_status_code:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+		}
+		return $icon . $status[ $this->status_ID() ];
+	}
+
+
+	/**
+	 * get Transaction Status
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * Returns TRUE or FALSE for whether or not this transaction cost any money
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_free()
+	{
+		return EEH_Money::compare_floats($this->get('TXN_total'), 0, '==');
+	}
+
+
+	/**
+	 * Returns whether this transaction is complete
+	 * Useful in templates and other logic for deciding if we should ask for another payment...
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_completed()
+	{
+		return $this->status_ID() === EEM_Transaction::complete_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction is incomplete
+	 * Useful in templates and other logic for deciding if we should ask for another payment...
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_incomplete()
+	{
+		return $this->status_ID() === EEM_Transaction::incomplete_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction is overpaid
+	 * Useful in templates and other logic for deciding if monies need to be refunded
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_overpaid()
+	{
+		return $this->status_ID() === EEM_Transaction::overpaid_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction was abandoned
+	 * meaning that the transaction/registration process was somehow interrupted and never completed
+	 * but that contact information exists for at least one registrant
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_abandoned()
+	{
+		return $this->status_ID() === EEM_Transaction::abandoned_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction failed
+	 * meaning that the transaction/registration process was somehow interrupted and never completed
+	 * and that NO contact information exists for any registrants
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function failed()
+	{
+		return $this->status_ID() === EEM_Transaction::failed_status_code;
+	}
+
+
+	/**
+	 * This returns the url for the invoice of this transaction
+	 *
+	 * @param string $type 'html' or 'pdf' (default is pdf)
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function invoice_url($type = 'html')
+	{
+		$REG = $this->primary_registration();
+		if (! $REG instanceof EE_Registration) {
+			return '';
+		}
+		return $REG->invoice_url($type);
+	}
+
+
+	/**
+	 * Gets the primary registration only
+	 *
+	 * @return EE_Base_Class|EE_Registration
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function primary_registration()
+	{
+		if($this->_primary_registrant instanceof EE_Registration) {
+			return $this->_primary_registrant;
+		}
+
+		$registrations = (array) $this->get_many_related(
+			'Registration',
+			[['REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT]]
+		);
+		foreach ($registrations as $registration) {
+			// valid registration that is NOT cancelled or declined ?
+			if (
+				$registration instanceof EE_Registration
+				&& ! in_array($registration->status_ID(), EEM_Registration::closed_reg_statuses(), true)
+			) {
+				$this->_primary_registrant = $registration;
+				return $registration;
+			}
+		}
+		// nothing valid found, so just return first thing from array of results
+		$primary_registrant = reset($registrations);
+		$this->_primary_registrant = $primary_registrant instanceof EE_Registration ? $primary_registrant : null;
+		return $this->_primary_registrant;
+	}
+
+
+	/**
+	 * Gets the URL for viewing the receipt
+	 *
+	 * @param string $type 'pdf' or 'html' (default is 'html')
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function receipt_url($type = 'html')
+	{
+		$REG = $this->primary_registration();
+		if (! $REG instanceof EE_Registration) {
+			return '';
+		}
+		return $REG->receipt_url($type);
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_overview_url()
+	{
+		$primary_registration = $this->primary_registration();
+		return $primary_registration instanceof EE_Registration
+			? $primary_registration->payment_overview_url()
+			: false;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function gateway_response_on_transaction()
+	{
+		$payment = $this->get_first_related('Payment');
+		return $payment instanceof EE_Payment
+			? $payment->gateway_response()
+			: '';
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Base_Class|EE_Status
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Gets all the extra meta info on this payment
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Extra_Meta
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function extra_meta($query_params = [])
+	{
+		return $this->get_many_related('Extra_Meta', $query_params);
+	}
+
+
+	/**
+	 * Wrapper for _add_relation_to
+	 *
+	 * @param EE_Registration $registration
+	 * @return EE_Base_Class the relation was added to
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_registration(EE_Registration $registration)
+	{
+		return $this->_add_relation_to($registration, 'Registration');
+	}
+
+
+	/**
+	 * Removes the given registration from being related (even before saving this transaction).
+	 * If an ID/index is provided and this transaction isn't saved yet, removes it from list of cached relations
+	 *
+	 * @param int $registration_or_id
+	 * @return EE_Base_Class that was removed from being related
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function remove_registration_with_id($registration_or_id)
+	{
+		return $this->_remove_relation_to($registration_or_id, 'Registration');
+	}
+
+
+	/**
+	 * Gets all the line items which are for ACTUAL items
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function items_purchased()
+	{
+		return $this->line_items([['LIN_type' => EEM_Line_Item::type_line_item]]);
+	}
+
+
+	/**
+	 * Wrapper for _add_relation_to
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Base_Class the relation was added to
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_line_item(EE_Line_Item $line_item)
+	{
+		return $this->_add_relation_to($line_item, 'Line_Item');
+	}
+
+
+	/**
+	 * Gets ALL the line items related to this transaction (unstructured)
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function line_items($query_params = [])
+	{
+		return $this->get_many_related('Line_Item', $query_params);
+	}
+
+
+	/**
+	 * Gets all the line items which are taxes on the total
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function tax_items()
+	{
+		return $this->line_items([['LIN_type' => EEM_Line_Item::type_tax]]);
+	}
+
+
+	/**
+	 * Gets the total line item (which is a parent of all other related line items,
+	 * meaning it takes them all into account on its total)
+	 *
+	 * @param bool $create_if_not_found
+	 * @return EE_Line_Item|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total_line_item(bool $create_if_not_found = true): ?EE_Line_Item
+	{
+		$item = $this->get_first_related('Line_Item', [['LIN_type' => EEM_Line_Item::type_total]]);
+		if ($item instanceof EE_Line_Item) {
+			return $item;
+		}
+		return $create_if_not_found
+			? EEH_Line_Item::create_total_line_item($this)
+			: null;
+	}
+
+
+	/**
+	 * Returns the total amount of tax on this transaction
+	 * (assumes there's only one tax subtotal line item)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function tax_total()
+	{
+		$tax_line_item = $this->tax_total_line_item();
+		if ($tax_line_item) {
+			return (float) $tax_line_item->total();
+		}
+		return (float) 0;
+	}
+
+
+	/**
+	 * Gets the tax subtotal line item (assumes there's only one)
+	 *
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function tax_total_line_item()
+	{
+		return EEH_Line_Item::get_taxes_subtotal($this->total_line_item());
+	}
+
+
+	/**
+	 * Gets the array of billing info for the gateway and for this transaction's primary registration's attendee.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function billing_info()
+	{
+		$payment_method = $this->payment_method();
+		if (! $payment_method) {
+			EE_Error::add_error(
+				esc_html__(
+					'Could not find billing info for transaction because no gateway has been used for it yet',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$primary_reg = $this->primary_registration();
+		if (! $primary_reg) {
+			EE_Error::add_error(
+				esc_html__(
+					'Cannot get billing info for gateway %s on transaction because no primary registration exists',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$attendee = $primary_reg->attendee();
+		if (! $attendee) {
+			EE_Error::add_error(
+				esc_html__(
+					'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $attendee->billing_info_for_payment_method($payment_method);
+	}
+
+
+	/**
+	 * Gets PMD_ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_method_ID()
+	{
+		return $this->get('PMD_ID');
+	}
+
+
+	/**
+	 * Sets PMD_ID
+	 *
+	 * @param int $PMD_ID
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_payment_method_ID($PMD_ID)
+	{
+		$this->set('PMD_ID', $PMD_ID);
+	}
+
+
+	/**
+	 * Gets the last-used payment method on this transaction
+	 * (we COULD just use the last-made payment, but some payment methods, namely
+	 * offline ones, dont' create payments)
+	 *
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_method()
+	{
+		$PMD_ID = $this->payment_method_ID();
+		if($PMD_ID) {
+			$pm = EEM_Payment_Method::instance()->get_one_by_ID($this->payment_method_ID());
+			if ($pm instanceof EE_Payment_Method) {
+				return $pm;
+			}
+		}
+		$last_payment = $this->last_payment();
+		if ($last_payment instanceof EE_Payment && $last_payment->payment_method()) {
+			return $last_payment->payment_method();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the last payment made
+	 *
+	 * @return EE_Base_Class|EE_Payment|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function last_payment(): ?EE_Payment
+	{
+		return $this->get_first_related('Payment', ['order_by' => ['PAY_ID' => 'desc']]);
+	}
+
+
+	/**
+	 * Gets all the line items which are unrelated to tickets on this transaction
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function non_ticket_line_items()
+	{
+		return EEM_Line_Item::instance()->get_all_non_ticket_line_items_for_transaction($this->ID());
+	}
+
+
+	/**
+	 * possibly toggles TXN status
+	 *
+	 * @param boolean $update whether to save the TXN
+	 * @return bool whether the TXN was saved
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function update_status_based_on_total_paid($update = true)
+	{
+		// set transaction status based on comparison of TXN_paid vs TXN_total
+		if (EEH_Money::compare_floats($this->paid(), $this->total(), '>')) {
+			$new_txn_status = EEM_Transaction::overpaid_status_code;
+		} elseif (EEH_Money::compare_floats($this->paid(), $this->total())) {
+			$new_txn_status = EEM_Transaction::complete_status_code;
+		} elseif (EEH_Money::compare_floats($this->paid(), $this->total(), '<')) {
+			$new_txn_status = EEM_Transaction::incomplete_status_code;
+		} else {
+			throw new RuntimeException(
+				esc_html__('The total paid calculation for this transaction is inaccurate.', 'event_espresso')
+			);
+		}
+		if ($new_txn_status !== $this->status_ID()) {
+			$this->set_status($new_txn_status);
+			if ($update) {
+				return (bool) $this->save();
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Updates the transaction's status and total_paid based on all the payments
+	 * that apply to it
+	 *
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated
+	 */
+	public function update_based_on_payments()
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
+			),
+			'4.6.0'
+		);
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($this);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function old_txn_status()
+	{
+		return $this->_old_txn_status;
+	}
+
+
+	/**
+	 * @param string $old_txn_status
+	 */
+	public function set_old_txn_status($old_txn_status)
+	{
+		// only set the first time
+		if ($this->_old_txn_status === null) {
+			$this->_old_txn_status = $old_txn_status;
+		}
+	}
+
+
+	/**
+	 * reg_status_updated
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function txn_status_updated()
+	{
+		return $this->status_ID() !== $this->_old_txn_status && $this->_old_txn_status !== null;
+	}
+
+
+	/**
+	 * _reg_steps_completed
+	 * if $check_all is TRUE, then returns TRUE if ALL reg steps have been marked as completed,
+	 * if a $reg_step_slug is provided, then this step will be skipped when testing for completion
+	 * if $check_all is FALSE and a $reg_step_slug is provided, then ONLY that reg step will be tested for completion
+	 *
+	 * @param string $reg_step_slug
+	 * @param bool   $check_all
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
+	{
+		$reg_steps = $this->reg_steps();
+		if (! is_array($reg_steps) || empty($reg_steps)) {
+			return false;
+		}
+		// loop thru reg steps array)
+		foreach ($reg_steps as $slug => $reg_step_completed) {
+			// if NOT checking ALL steps (only checking one step)
+			if (! $check_all) {
+				// and this is the one
+				if ($slug === $reg_step_slug) {
+					return $reg_step_completed;
+				}
+				// skip to next reg step in loop
+				continue;
+			}
+			// $check_all must be true, else we would never have gotten to this point
+			if ($slug === $reg_step_slug) {
+				// if we reach this point, then we are testing either:
+				// all_reg_steps_completed_except() or
+				// all_reg_steps_completed_except_final_step(),
+				// and since this is the reg step EXCEPTION being tested
+				// we want to return true (yes true) if this reg step is NOT completed
+				// ie: "is everything completed except the final step?"
+				// "that is correct... the final step is not completed, but all others are."
+				return $reg_step_completed !== true;
+			}
+			if ($reg_step_completed !== true) {
+				// if any reg step is NOT completed, then ALL steps are not completed
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * all_reg_steps_completed
+	 * returns:
+	 *    true if ALL reg steps have been marked as completed
+	 *        or false if any step is not completed
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function all_reg_steps_completed()
+	{
+		return $this->_reg_steps_completed();
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
+	 *        or false if any other step is not completed
+	 *        or false if ALL steps are completed including the exception you are testing !!!
+	 *
+	 * @param string $exception
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function all_reg_steps_completed_except($exception = '')
+	{
+		return $this->_reg_steps_completed($exception);
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except the final step, have been marked as completed
+	 *        or false if any step is not completed
+	 *    or false if ALL steps are completed including the final step !!!
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function all_reg_steps_completed_except_final_step()
+	{
+		return $this->_reg_steps_completed('finalize_registration');
+	}
+
+
+	/**
+	 * reg_step_completed
+	 * returns:
+	 *    true if a specific reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @param string $reg_step_slug
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_step_completed($reg_step_slug)
+	{
+		return $this->_reg_steps_completed($reg_step_slug, false);
+	}
+
+
+	/**
+	 * completed_final_reg_step
+	 * returns:
+	 *    true if the finalize_registration reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function final_reg_step_completed()
+	{
+		return $this->_reg_steps_completed('finalize_registration', false);
+	}
+
+
+	/**
+	 * set_reg_step_initiated
+	 * given a valid TXN_reg_step, this sets it's value to a unix timestamp
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_step_initiated($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, time());
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step, this sets the step as completed
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_step_completed($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, true);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step slug, this sets the step as NOT completed
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_step_not_completed($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, false);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid reg step slug, this sets the TXN_reg_step completed status which is either:
+	 *
+	 * @param string      $reg_step_slug
+	 * @param boolean|int $status
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _set_reg_step_completed_status($reg_step_slug, $status)
+	{
+		// validate status
+		$status = is_bool($status) || is_int($status)
+			? $status
+			: false;
+		// get reg steps array
+		$txn_reg_steps = $this->reg_steps();
+		// if reg step does NOT exist
+		if (! isset($txn_reg_steps[ $reg_step_slug ])) {
+			return false;
+		}
+		// if  we're trying to complete a step that is already completed
+		if ($txn_reg_steps[ $reg_step_slug ] === true) {
+			return true;
+		}
+		// if  we're trying to complete a step that hasn't even started
+		if ($status === true && $txn_reg_steps[ $reg_step_slug ] === false) {
+			return false;
+		}
+		// if current status value matches the incoming value (no change)
+		// type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
+		if ((int) $txn_reg_steps[ $reg_step_slug ] === (int) $status) {
+			// this will happen in cases where multiple AJAX requests occur during the same step
+			return true;
+		}
+		// if we're trying to set a start time, but it has already been set...
+		if (is_numeric($status) && is_numeric($txn_reg_steps[ $reg_step_slug ])) {
+			// skip the update below, but don't return FALSE so that errors won't be displayed
+			return true;
+		}
+		// update completed status
+		$txn_reg_steps[ $reg_step_slug ] = $status;
+		$this->set_reg_steps($txn_reg_steps);
+		$this->save();
+		return true;
+	}
+
+
+	/**
+	 * remove_reg_step
+	 * given a valid TXN_reg_step slug, this will remove (unset)
+	 * the reg step from the TXN reg step array
+	 *
+	 * @param string $reg_step_slug
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function remove_reg_step($reg_step_slug)
+	{
+		// get reg steps array
+		$txn_reg_steps = $this->reg_steps();
+		unset($txn_reg_steps[ $reg_step_slug ]);
+		$this->set_reg_steps($txn_reg_steps);
+	}
+
+
+	/**
+	 * toggle_failed_transaction_status
+	 * upgrades a TXNs status from failed to abandoned,
+	 * meaning that contact information has been captured for at least one registrant
+	 *
+	 * @param bool $save
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function toggle_failed_transaction_status($save = true)
+	{
+		// if TXN status is still set as "failed"...
+		if ($this->status_ID() === EEM_Transaction::failed_status_code) {
+			$this->set_status(EEM_Transaction::abandoned_status_code);
+			if ($save) {
+				$this->save();
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * toggle_abandoned_transaction_status
+	 * upgrades a TXNs status from failed or abandoned to incomplete
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function toggle_abandoned_transaction_status()
+	{
+		// if TXN status has not been updated already due to a payment, and is still set as "failed" or "abandoned"...
+		$txn_status = $this->status_ID();
+		if (
+			$txn_status === EEM_Transaction::failed_status_code
+			|| $txn_status === EEM_Transaction::abandoned_status_code
+		) {
+			// if a contact record for the primary registrant has been created
+			if (
+				$this->primary_registration() instanceof EE_Registration
+				&& $this->primary_registration()->attendee() instanceof EE_Attendee
+			) {
+				$this->set_status(EEM_Transaction::incomplete_status_code);
+			} else {
+				// no contact record? yer abandoned!
+				$this->set_status(EEM_Transaction::abandoned_status_code);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * checks if an Abandoned TXN has any related payments, and if so,
+	 * updates the TXN status based on the amount paid
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function verify_abandoned_transaction_status()
+	{
+		if ($this->status_ID() !== EEM_Transaction::abandoned_status_code) {
+			return;
+		}
+		$payments = $this->get_many_related('Payment');
+		if (! empty($payments)) {
+			foreach ($payments as $payment) {
+				if ($payment instanceof EE_Payment) {
+					// kk this TXN should NOT be abandoned
+					$this->update_status_based_on_total_paid();
+					if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+						EE_Error::add_attention(
+							sprintf(
+								esc_html__(
+									'The status for Transaction #%1$d has been updated from "Abandoned" to "%2$s", because at least one payment has been made towards it. If the payment appears in the "Payment Details" table below, you may need to edit its status and/or other details as well.',
+									'event_espresso'
+								),
+								$this->ID(),
+								$this->pretty_status()
+							)
+						);
+					}
+					// get final reg step status
+					$finalized = $this->final_reg_step_completed();
+					// if the 'finalize_registration' step has been initiated (has a timestamp)
+					// but has not yet been fully completed (TRUE)
+					if (is_int($finalized) && $finalized !== false && $finalized !== true) {
+						$this->set_reg_step_completed('finalize_registration');
+						$this->save();
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @since 4.10.4.p
+	 */
+	public function recalculateLineItems()
+	{
+		$total_line_item = $this->total_line_item(false);
+		if ($total_line_item instanceof EE_Line_Item) {
+			EEH_Line_Item::resetIsTaxableForTickets($total_line_item);
+			return EEH_Line_Item::apply_taxes($total_line_item, true);
+		}
+		return false;
+	}
 }

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

Indentation +912 added lines, -912 removed lines

@@ -225,937 +225,937 @@
 class EE_DMS_4_1_0_attendees extends EE_Data_Migration_Script_Stage_Table
 {
 
-    private string $_new_attendee_cpt_table;
+	private string $_new_attendee_cpt_table;
 
-    private string $_new_attendee_meta_table;
+	private string $_new_attendee_meta_table;
 
-    private string $_new_reg_table;
+	private string $_new_reg_table;
 
-    private string $_new_transaction_table;
+	private string $_new_transaction_table;
 
-    private string $_new_payment_table;
+	private string $_new_payment_table;
 
-    private string $_old_mer_table;
+	private string $_old_mer_table;
 
-    private string $_new_ticket_table;
+	private string $_new_ticket_table;
 
-    private string $_new_ticket_datetime_table;
+	private string $_new_ticket_datetime_table;
 
-    private string $_new_datetime_table;
+	private string $_new_datetime_table;
 
-    private string $_new_datetime_ticket_table;
+	private string $_new_datetime_ticket_table;
 
-    private string $_new_price_table;
+	private string $_new_price_table;
 
-    private string $_new_ticket_price_table;
+	private string $_new_ticket_price_table;
 
-    /**
-     * Remembers whether the mer table exists
-     *
-     * @var boolean
-     */
-    private ?bool $_mer_tables_exist = null;
+	/**
+	 * Remembers whether the mer table exists
+	 *
+	 * @var boolean
+	 */
+	private ?bool $_mer_tables_exist = null;
 
 
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = esc_html__("Attendees", "event_espresso");
-        $this->_old_table   = $wpdb->prefix . "events_attendee";
-        // Only select the event status column from the event table.
-        $this->select_expression = 'att.*, e.event_status';
-        // Only select attendees for events that aren't deleted.
-        $this->_extra_where_sql           = 'AS att
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = esc_html__("Attendees", "event_espresso");
+		$this->_old_table   = $wpdb->prefix . "events_attendee";
+		// Only select the event status column from the event table.
+		$this->select_expression = 'att.*, e.event_status';
+		// Only select attendees for events that aren't deleted.
+		$this->_extra_where_sql           = 'AS att
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
-        $this->_old_mer_table             = $wpdb->prefix . "events_multi_event_registration_id_group";
-        $this->_new_attendee_cpt_table    = $wpdb->posts;
-        $this->_new_attendee_meta_table   = $wpdb->prefix . "esp_attendee_meta";
-        $this->_new_reg_table             = $wpdb->prefix . "esp_registration";
-        $this->_new_transaction_table     = $wpdb->prefix . "esp_transaction";
-        $this->_new_payment_table         = $wpdb->prefix . "esp_payment";
-        $this->_new_ticket_table          = $wpdb->prefix . "esp_ticket";
-        $this->_new_ticket_datetime_table = $wpdb->prefix . "esp_datetime_ticket";
-        $this->_new_datetime_table        = $wpdb->prefix . "esp_datetime";
-        $this->_new_datetime_ticket_table = $wpdb->prefix . "esp_datetime_ticket";
-        $this->_new_price_table           = $wpdb->prefix . "esp_price";
-        $this->_new_ticket_price_table    = $wpdb->prefix . "esp_ticket_price";
-        parent::__construct();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _migrate_old_row($old_row)
-    {
-        // first check if there's already a new attendee with similar characteristics
-        $new_att_id = $this->_find_attendee_cpt_matching($old_row);
-        if (! $new_att_id) {
-            $new_att_id = $this->_insert_new_attendee_cpt($old_row);
-            if (! $new_att_id) {
-                // if we couldn't even make an attendee, abandon all hope
-                return;
-            }
-            $new_att_meta_id = $this->_insert_attendee_meta_row($old_row, $new_att_id);
-            if ($new_att_meta_id) {
-                $this->get_migration_script()->set_mapping(
-                    $this->_old_table,
-                    $old_row['id'],
-                    $this->_new_attendee_meta_table,
-                    $new_att_meta_id
-                );
-            }
-        }
-        $this->get_migration_script()->set_mapping(
-            $this->_old_table,
-            $old_row['id'],
-            $this->_new_attendee_cpt_table,
-            $new_att_id
-        );
-
-        $txn_id = $this->_insert_new_transaction($old_row);
-        if (! $txn_id) {
-            // if we couldn't make the transaction, also abandon all hope
-            return;
-        }
-        $this->get_migration_script()->set_mapping(
-            $this->_old_table,
-            $old_row['id'],
-            $this->_new_transaction_table,
-            $txn_id
-        );
-        $pay_id = $this->_insert_new_payment($old_row, $txn_id);
-        if ($pay_id) {
-            $this->get_migration_script()->set_mapping(
-                $this->_old_table,
-                $old_row['id'],
-                $this->_new_payment_table,
-                $pay_id
-            );
-        }
-
-
-        // even if there was no payment, we can go ahead with adding the reg
-        $new_regs = $this->_insert_new_registrations($old_row, $new_att_id, $txn_id);
-        if ($new_regs) {
-            $this->get_migration_script()->set_mapping(
-                $this->_old_table,
-                $old_row['id'],
-                $this->_new_reg_table,
-                $new_regs
-            );
-        }
-    }
-
-
-    /**
-     * Checks if there's already an attendee CPT in the db that has the same
-     * first and last name, and email. If so, returns its ID as an int.
-     *
-     * @param array $old_attendee
-     * @return int
-     * @global wpdb $wpdb
-     */
-    private function _find_attendee_cpt_matching(array $old_attendee): int
-    {
-        global $wpdb;
-        $existing_attendee_id =
-            $wpdb->get_var(
-                $wpdb->prepare(
-                    "SELECT id FROM " .
-                    $this->_new_attendee_cpt_table .
-                    " AS cpt INNER JOIN " .
-                    $this->_new_attendee_meta_table .
-                    " AS meta ON cpt.ID = meta.ATT_ID WHERE meta.ATT_fname = %s AND meta.ATT_lname = %s AND meta.ATT_email = %s LIMIT 1",
-                    $old_attendee['fname'],
-                    $old_attendee['lname'],
-                    $old_attendee['email']
-                )
-            );
-        return intval($existing_attendee_id);
-    }
-
-
-    private function _insert_new_attendee_cpt($old_attendee): int
-    {
-        global $wpdb;
-        $cols_n_values = [
-            'post_title'    => stripslashes($old_attendee['fname'] . " " . $old_attendee['lname']),// ATT_full_name
-            'post_content'  => '',// ATT_bio
-            'post_name'     => sanitize_title($old_attendee['fname'] . "-" . $old_attendee['lname']),// ATT_slug
-            'post_date'     => $this->get_migration_script()->convert_date_string_to_utc(
-                $this,
-                $old_attendee,
-                $old_attendee['date']
-            ),// ATT_created
-            'post_excerpt'  => '',// ATT_short_bio
-            'post_modified' => $this->get_migration_script()->convert_date_string_to_utc(
-                $this,
-                $old_attendee,
-                $old_attendee['date']
-            ),// ATT_modified
-            'post_author'   => 0,// ATT_author
-            'post_parent'   => 0,// ATT_parent
-            'post_type'     => EspressoPostType::ATTENDEES,
-            'post_status'   => 'publish',// status
-        ];
-        $data_types    = [
-            '%s',// ATT_full_name
-            '%s',// ATT_bio
-            '%s',// ATT_slug
-            '%s',// ATT_created
-            '%s',// ATT_short_bio
-            '%s',// ATT_modified
-            '%d',// ATT_author
-            '%d',// ATT_parent
-            '%s',// post_type
-            '%s',// status
-        ];
-        $success       = $wpdb->insert($this->_new_attendee_cpt_table, $cols_n_values, $data_types);
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_table,
-                    $old_attendee,
-                    $this->_new_attendee_cpt_table,
-                    $cols_n_values,
-                    $data_types
-                )
-            );
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-
-    private function _insert_attendee_meta_row($old_attendee, $new_attendee_cpt_id): int
-    {
-        global $wpdb;
-        // get the state and country ids from the old row
-        try {
-            $new_country     =
-                $this->get_migration_script()->get_or_create_country(stripslashes($old_attendee['country_id']));
-            $new_country_iso = $new_country['CNT_ISO'];
-        } catch (EE_Error $exception) {
-            $new_country_iso = $this->get_migration_script()->get_default_country_iso();
-        }
-        try {
-            $new_state    =
-                $this->get_migration_script()->get_or_create_state(
-                    stripslashes($old_attendee['state']),
-                    $new_country_iso
-                );
-            $new_state_id = $new_state['STA_ID'];
-        } catch (EE_Error $exception) {
-            $new_state_id = 0;
-        }
-        $cols_n_values = [
-            'ATT_ID'       => $new_attendee_cpt_id,
-            'ATT_fname'    => stripslashes($old_attendee['fname']),
-            'ATT_lname'    => stripslashes($old_attendee['lname']),
-            'ATT_address'  => stripslashes($old_attendee['address']),
-            'ATT_address2' => stripslashes($old_attendee['address2']),
-            'ATT_city'     => stripslashes($old_attendee['city']),
-            'STA_ID'       => $new_state_id,
-            'CNT_ISO'      => $new_country_iso,
-            'ATT_zip'      => stripslashes($old_attendee['zip']),
-            'ATT_email'    => stripslashes($old_attendee['email']),
-            'ATT_phone'    => stripslashes($old_attendee['phone']),
-        ];
-        $data_types    = [
-            '%d',// ATT_ID
-            '%s',// ATT_fname
-            '%s',// ATT_lname
-            '%s',// ATT_address
-            '%s',// ATT_address2
-            '%s',// ATT_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// ATT_zip
-            '%s',// ATT_email
-            '%s',// ATT_phone
-        ];
-        $success       = $wpdb->insert($this->_new_attendee_meta_table, $cols_n_values, $data_types);
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_table,
-                    $old_attendee,
-                    $this->_new_attendee_meta_table,
-                    $cols_n_values,
-                    $data_types
-                )
-            );
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-
-    /**
-     * Note: we don't necessarily create a new transaction for each attendee row.
-     * Only if the old attendee 'is_primary' is true; otherwise we find the old attendee row that
-     * 'is_primary' and has the same 'txn_id', then we return ITS new transaction id
-     *
-     * @param array $old_attendee
-     * @return int new transaction id
-     * @throws EE_Error
-     * @global wpdb $wpdb
-     */
-    private function _insert_new_transaction(array $old_attendee): int
-    {
-        global $wpdb;
-
-        // first: let's check for an existing transaction for this old attendee
-        if (intval($old_attendee['is_primary'])) {// primary attendee, so create txn
-            $txn_id =
-                $this->get_migration_script()->get_mapping_new_pk(
-                    $this->_old_table,
-                    intval($old_attendee['id']),
-                    $this->_new_transaction_table
-                );
-        } else { // non-primary attendee, so find its primary attendee's transaction
-            $primary_attendee_old_id =
-                $wpdb->get_var(
-                    $wpdb->prepare(
-                        "SELECT id FROM " . $this->_old_table . " WHERE is_primary=1 and registration_id=%s",
-                        $old_attendee['registration_id']
-                    )
-                );
-            if (! $primary_attendee_old_id) {
-                $primary_attendee        =
-                    $this->_find_mer_primary_attendee_using_mer_tables($old_attendee['registration_id']);
-                $primary_attendee_old_id = is_array($primary_attendee) ? $primary_attendee['id'] : null;
-            }
-            $txn_id =
-                $this->get_migration_script()->get_mapping_new_pk(
-                    $this->_old_table,
-                    intval($primary_attendee_old_id),
-                    $this->_new_transaction_table
-                );
-            if (! $txn_id) {
-                $this->add_error(
-                    sprintf(
-                        esc_html__(
-                            "Could not find primary attendee's new transaction. Current attendee is: %s, we think the 3.1 primary attendee for it has id %d, but there's no 4.1 transaction for that primary attendee id.",
-                            "event_espresso"
-                        ),
-                        $this->_json_encode($old_attendee),
-                        $primary_attendee_old_id
-                    )
-                );
-                $txn_id = 0;
-            }
-        }
-        // if there isn't yet a transaction row for this, create one
-        // (so even if it was a non-primary attendee with no EE3 primary attendee,
-        // it ought to have SOME transaction, so we'll make one)
-        if (! $txn_id) {
-            // maps 3.1 payment stati onto 4.1 transaction stati
-            $txn_status_mapping = [
-                'Completed'        => 'TCM',
-                'Pending'          => 'TIN',
-                'Payment Declined' => 'TIN',
-                'Incomplete'       => 'TIN',
-                'Not Completed'    => 'TIN',
-                'Cancelled'        => 'TIN',
-                'Declined'         => 'TIN',
-            ];
-            $STS_ID             = $txn_status_mapping[ $old_attendee['payment_status'] ] ?? 'TIN';
-            $cols_n_values      = [
-                'TXN_timestamp' => $this->get_migration_script()->convert_date_string_to_utc(
-                    $this,
-                    $old_attendee,
-                    $old_attendee['date']
-                ),
-                'TXN_total'     => floatval($old_attendee['total_cost']),
-                'TXN_paid'      => floatval($old_attendee['amount_pd']),
-                'STS_ID'        => $STS_ID,
-                'TXN_hash_salt' => $old_attendee['hashSalt'],
-            ];
-            $data_types         = [
-                '%s',// TXN_timestamp
-                '%f',// TXN_total
-                '%f',// TXN_paid
-                '%s',// STS_ID
-                '%s',// TXN_hash_salt
-            ];
-            $success            = $wpdb->insert($this->_new_transaction_table, $cols_n_values, $data_types);
-            if (! $success) {
-                $this->add_error(
-                    $this->get_migration_script()->_create_error_message_for_db_insertion(
-                        $this->_old_table,
-                        $old_attendee,
-                        $this->_new_transaction_table,
-                        $cols_n_values,
-                        $data_types
-                    )
-                );
-                return 0;
-            }
-            $txn_id = $wpdb->insert_id;
-        }
-
-        return $txn_id;
-    }
-
-
-    /**
-     * Detects if the MER tables exist
-     *
-     * @return boolean
-     * @global wpdb $wpdb
-     */
-    private function _mer_tables_exist(): ?bool
-    {
-        if ($this->_mer_tables_exist === null) {
-            global $wpdb;
-
-            if ($wpdb->get_var("SHOW TABLES LIKE '$this->_old_mer_table'") != $this->_old_mer_table) {
-                $this->_mer_tables_exist = false;
-            } else {
-                $this->_mer_tables_exist = true;
-            }
-        }
-        return $this->_mer_tables_exist;
-    }
-
-
-    /**
-     * Gets the 4.1 registration's status given the 3.1 attendee row. We consider
-     * whether the event required pre-approval or not,a dn the 4.1 payment status.
-     *
-     * @param array $old_attendee_row
-     * @return string
-     * @global wpdb $wpdb
-     */
-    private function _get_reg_status_for_old_payment_status(array $old_attendee_row): string
-    {
-        // need event default reg status and if pre_approval was required
-        global $wpdb;
-        $event_required_pre_approval =
-            $wpdb->get_var(
-                $wpdb->prepare(
-                    "SELECT require_pre_approval FROM " . $wpdb->prefix . "events_detail WHERE id = %d",
-                    $old_attendee_row['event_id']
-                )
-            );
-        return $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(
-            $old_attendee_row['payment_status'],
-            intval($event_required_pre_approval) && intval($old_attendee_row['pre_approve'])
-        );
-    }
-
-
-    /**
-     * Adds however many registrations are indicated by the old attendee's QUANTITY field,
-     * and returns an array of their IDs
-     *
-     * @param array $old_attendee
-     * @param int   $new_attendee_id
-     * @param int   $new_txn_id
-     * @return array of new registration ids
-     * @throws EE_Error
-     * @global wpdb $wpdb
-     */
-    private function _insert_new_registrations(array $old_attendee, int $new_attendee_id, int $new_txn_id): array
-    {
-        global $wpdb;
-
-        $STS_ID       = $this->_get_reg_status_for_old_payment_status($old_attendee);
-        $new_event_id =
-            $this->get_migration_script()->get_mapping_new_pk(
-                $wpdb->prefix . 'events_detail',
-                $old_attendee['event_id'],
-                $wpdb->posts
-            );
-        if (! $new_event_id) {
-            $this->add_error(
-                sprintf(
-                    esc_html__(
-                        "Could not find NEW event CPT ID for old event '%d' on old attendee %s",
-                        "event_espresso"
-                    ),
-                    $old_attendee['event_id'],
-                    $this->_json_encode($old_attendee)
-                )
-            );
-        }
-
-        $ticket_id = $this->_try_to_find_new_ticket_id($old_attendee, $new_event_id);
-        if (! $ticket_id) {
-            $ticket_id = $this->_insert_new_ticket_because_none_found($old_attendee, $new_event_id);
-            $this->add_error(
-                sprintf(
-                    esc_html__(
-                        'Could not find a ticket for old attendee with id %d for new event %d, so created a new ticket with id %d',
-                        'event_espresso'
-                    ),
-                    $old_attendee['id'],
-                    $new_event_id,
-                    $ticket_id
-                )
-            );
-        }
-        $regs_on_this_row = intval($old_attendee['quantity']);
-        $new_regs         = [];
-        // 4 cases we need to account for:
-        // 1 old attendee_details row with a quantity of X (no mer)
-        // Y old attendee_details rows with a quantity of 1 (no mer) joined by their common registration_id
-        // Y old attendee_details rows with a quantity of x (because of mer)
-        // Y old attendee_details rows with a quantity of 1 (because of mer) joined by wp_events_multi_event_registration_id_group
-        for ($count = 1; $count <= $regs_on_this_row; $count++) {
-            // sum regs on older rows
-            $regs_on_this_event_and_txn = $this->_sum_old_attendees_on_old_txn($old_attendee, true);
-            $cols_n_values              = [
-                'EVT_ID'           => $new_event_id,
-                'ATT_ID'           => $new_attendee_id,
-                'TXN_ID'           => $new_txn_id,
-                'TKT_ID'           => $ticket_id,
-                'STS_ID'           => $STS_ID,
-                'REG_date'         => $this->get_migration_script()->convert_date_string_to_utc(
-                    $this,
-                    $old_attendee,
-                    $old_attendee['date']
-                ),
-                'REG_final_price'  => $old_attendee['final_price'],
-                'REG_session'      => substr($old_attendee['attendee_session'], 0, 44),
-                'REG_code'         => sanitize_key($old_attendee['registration_id']),
-                'REG_url_link'     => sanitize_key($old_attendee['registration_id'] . '-' . $count),
-                'REG_count'        => $regs_on_this_event_and_txn + $count,
-                'REG_group_size'   => $this->_sum_old_attendees_on_old_txn($old_attendee),
-                'REG_att_is_going' => true,
-                'REG_deleted'      => false,
-            ];
-            $data_types                 = [
-                '%d',// EVT_ID
-                '%d',// ATT_ID
-                '%d',// TXN_ID
-                '%d',// TKT_ID
-                '%s',// STS_ID
-                '%s',// REG_date
-                '%f',// REG_final_price
-                '%s',// REG_session
-                '%s',// REG_code
-                '%s',// REG_url_link
-                '%d',// REG_count
-                '%d',// REG_group_size
-                '%d',// REG_att_is_going
-                '%d',// REG_deleted
-            ];
-            $success                    = $wpdb->insert($this->_new_reg_table, $cols_n_values, $data_types);
-            if (! $success) {
-                $this->add_error(
-                    $this->get_migration_script()->_create_error_message_for_db_insertion(
-                        $this->_old_table,
-                        $old_attendee,
-                        $this->_new_reg_table,
-                        $cols_n_values,
-                        $data_types
-                    )
-                );
-                return [];
-            }
-            $cols_n_values['REG_ID'] = $wpdb->insert_id;
-            $new_regs[]              = $wpdb->insert_id;
-        }
-        $this->_add_regs_to_ticket_and_datetimes($ticket_id, count($new_regs), $STS_ID);
-        return $new_regs;
-    }
-
-
-    /**
-     * Increments the sold values on the ticket and its related datetimes by the amount sold,
-     * which should be done directly after adding the rows. Yes this means we're constantly incrementing
-     * the sold amounts as we go, and is less efficient than a single big query,
-     * but it's safer because we KNOW these regs have been added, rather than inferring
-     * that they WILL be added (because the attendees stage runs nearly last during
-     * the migration script)
-     *
-     * @param int    $new_ticket_id
-     * @param int    $quantity_sold
-     * @param string $STS_ID
-     * @return boolean whether they were successfully updated or not
-     */
-    protected function _add_regs_to_ticket_and_datetimes(int $new_ticket_id, int $quantity_sold, string $STS_ID): bool
-    {
-        if ($STS_ID != 'RAP') {
-            return true;
-        }
-        global $wpdb;
-        $success =
-            $wpdb->query(
-                $wpdb->prepare(
-                    "UPDATE $this->_new_ticket_table SET TKT_sold=TKT_sold+%d WHERE TKT_ID=%d",
-                    $quantity_sold,
-                    $new_ticket_id
-                )
-            );
-        if ($success) {
-            // get the ticket's datetimes, and increment them too
-            $success_update_datetimes = $wpdb->query(
-                $wpdb->prepare(
-                    "UPDATE $this->_new_ticket_table TKT
+		$this->_old_mer_table             = $wpdb->prefix . "events_multi_event_registration_id_group";
+		$this->_new_attendee_cpt_table    = $wpdb->posts;
+		$this->_new_attendee_meta_table   = $wpdb->prefix . "esp_attendee_meta";
+		$this->_new_reg_table             = $wpdb->prefix . "esp_registration";
+		$this->_new_transaction_table     = $wpdb->prefix . "esp_transaction";
+		$this->_new_payment_table         = $wpdb->prefix . "esp_payment";
+		$this->_new_ticket_table          = $wpdb->prefix . "esp_ticket";
+		$this->_new_ticket_datetime_table = $wpdb->prefix . "esp_datetime_ticket";
+		$this->_new_datetime_table        = $wpdb->prefix . "esp_datetime";
+		$this->_new_datetime_ticket_table = $wpdb->prefix . "esp_datetime_ticket";
+		$this->_new_price_table           = $wpdb->prefix . "esp_price";
+		$this->_new_ticket_price_table    = $wpdb->prefix . "esp_ticket_price";
+		parent::__construct();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _migrate_old_row($old_row)
+	{
+		// first check if there's already a new attendee with similar characteristics
+		$new_att_id = $this->_find_attendee_cpt_matching($old_row);
+		if (! $new_att_id) {
+			$new_att_id = $this->_insert_new_attendee_cpt($old_row);
+			if (! $new_att_id) {
+				// if we couldn't even make an attendee, abandon all hope
+				return;
+			}
+			$new_att_meta_id = $this->_insert_attendee_meta_row($old_row, $new_att_id);
+			if ($new_att_meta_id) {
+				$this->get_migration_script()->set_mapping(
+					$this->_old_table,
+					$old_row['id'],
+					$this->_new_attendee_meta_table,
+					$new_att_meta_id
+				);
+			}
+		}
+		$this->get_migration_script()->set_mapping(
+			$this->_old_table,
+			$old_row['id'],
+			$this->_new_attendee_cpt_table,
+			$new_att_id
+		);
+
+		$txn_id = $this->_insert_new_transaction($old_row);
+		if (! $txn_id) {
+			// if we couldn't make the transaction, also abandon all hope
+			return;
+		}
+		$this->get_migration_script()->set_mapping(
+			$this->_old_table,
+			$old_row['id'],
+			$this->_new_transaction_table,
+			$txn_id
+		);
+		$pay_id = $this->_insert_new_payment($old_row, $txn_id);
+		if ($pay_id) {
+			$this->get_migration_script()->set_mapping(
+				$this->_old_table,
+				$old_row['id'],
+				$this->_new_payment_table,
+				$pay_id
+			);
+		}
+
+
+		// even if there was no payment, we can go ahead with adding the reg
+		$new_regs = $this->_insert_new_registrations($old_row, $new_att_id, $txn_id);
+		if ($new_regs) {
+			$this->get_migration_script()->set_mapping(
+				$this->_old_table,
+				$old_row['id'],
+				$this->_new_reg_table,
+				$new_regs
+			);
+		}
+	}
+
+
+	/**
+	 * Checks if there's already an attendee CPT in the db that has the same
+	 * first and last name, and email. If so, returns its ID as an int.
+	 *
+	 * @param array $old_attendee
+	 * @return int
+	 * @global wpdb $wpdb
+	 */
+	private function _find_attendee_cpt_matching(array $old_attendee): int
+	{
+		global $wpdb;
+		$existing_attendee_id =
+			$wpdb->get_var(
+				$wpdb->prepare(
+					"SELECT id FROM " .
+					$this->_new_attendee_cpt_table .
+					" AS cpt INNER JOIN " .
+					$this->_new_attendee_meta_table .
+					" AS meta ON cpt.ID = meta.ATT_ID WHERE meta.ATT_fname = %s AND meta.ATT_lname = %s AND meta.ATT_email = %s LIMIT 1",
+					$old_attendee['fname'],
+					$old_attendee['lname'],
+					$old_attendee['email']
+				)
+			);
+		return intval($existing_attendee_id);
+	}
+
+
+	private function _insert_new_attendee_cpt($old_attendee): int
+	{
+		global $wpdb;
+		$cols_n_values = [
+			'post_title'    => stripslashes($old_attendee['fname'] . " " . $old_attendee['lname']),// ATT_full_name
+			'post_content'  => '',// ATT_bio
+			'post_name'     => sanitize_title($old_attendee['fname'] . "-" . $old_attendee['lname']),// ATT_slug
+			'post_date'     => $this->get_migration_script()->convert_date_string_to_utc(
+				$this,
+				$old_attendee,
+				$old_attendee['date']
+			),// ATT_created
+			'post_excerpt'  => '',// ATT_short_bio
+			'post_modified' => $this->get_migration_script()->convert_date_string_to_utc(
+				$this,
+				$old_attendee,
+				$old_attendee['date']
+			),// ATT_modified
+			'post_author'   => 0,// ATT_author
+			'post_parent'   => 0,// ATT_parent
+			'post_type'     => EspressoPostType::ATTENDEES,
+			'post_status'   => 'publish',// status
+		];
+		$data_types    = [
+			'%s',// ATT_full_name
+			'%s',// ATT_bio
+			'%s',// ATT_slug
+			'%s',// ATT_created
+			'%s',// ATT_short_bio
+			'%s',// ATT_modified
+			'%d',// ATT_author
+			'%d',// ATT_parent
+			'%s',// post_type
+			'%s',// status
+		];
+		$success       = $wpdb->insert($this->_new_attendee_cpt_table, $cols_n_values, $data_types);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_table,
+					$old_attendee,
+					$this->_new_attendee_cpt_table,
+					$cols_n_values,
+					$data_types
+				)
+			);
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+
+	private function _insert_attendee_meta_row($old_attendee, $new_attendee_cpt_id): int
+	{
+		global $wpdb;
+		// get the state and country ids from the old row
+		try {
+			$new_country     =
+				$this->get_migration_script()->get_or_create_country(stripslashes($old_attendee['country_id']));
+			$new_country_iso = $new_country['CNT_ISO'];
+		} catch (EE_Error $exception) {
+			$new_country_iso = $this->get_migration_script()->get_default_country_iso();
+		}
+		try {
+			$new_state    =
+				$this->get_migration_script()->get_or_create_state(
+					stripslashes($old_attendee['state']),
+					$new_country_iso
+				);
+			$new_state_id = $new_state['STA_ID'];
+		} catch (EE_Error $exception) {
+			$new_state_id = 0;
+		}
+		$cols_n_values = [
+			'ATT_ID'       => $new_attendee_cpt_id,
+			'ATT_fname'    => stripslashes($old_attendee['fname']),
+			'ATT_lname'    => stripslashes($old_attendee['lname']),
+			'ATT_address'  => stripslashes($old_attendee['address']),
+			'ATT_address2' => stripslashes($old_attendee['address2']),
+			'ATT_city'     => stripslashes($old_attendee['city']),
+			'STA_ID'       => $new_state_id,
+			'CNT_ISO'      => $new_country_iso,
+			'ATT_zip'      => stripslashes($old_attendee['zip']),
+			'ATT_email'    => stripslashes($old_attendee['email']),
+			'ATT_phone'    => stripslashes($old_attendee['phone']),
+		];
+		$data_types    = [
+			'%d',// ATT_ID
+			'%s',// ATT_fname
+			'%s',// ATT_lname
+			'%s',// ATT_address
+			'%s',// ATT_address2
+			'%s',// ATT_city
+			'%d',// STA_ID
+			'%s',// CNT_ISO
+			'%s',// ATT_zip
+			'%s',// ATT_email
+			'%s',// ATT_phone
+		];
+		$success       = $wpdb->insert($this->_new_attendee_meta_table, $cols_n_values, $data_types);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_table,
+					$old_attendee,
+					$this->_new_attendee_meta_table,
+					$cols_n_values,
+					$data_types
+				)
+			);
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+
+	/**
+	 * Note: we don't necessarily create a new transaction for each attendee row.
+	 * Only if the old attendee 'is_primary' is true; otherwise we find the old attendee row that
+	 * 'is_primary' and has the same 'txn_id', then we return ITS new transaction id
+	 *
+	 * @param array $old_attendee
+	 * @return int new transaction id
+	 * @throws EE_Error
+	 * @global wpdb $wpdb
+	 */
+	private function _insert_new_transaction(array $old_attendee): int
+	{
+		global $wpdb;
+
+		// first: let's check for an existing transaction for this old attendee
+		if (intval($old_attendee['is_primary'])) {// primary attendee, so create txn
+			$txn_id =
+				$this->get_migration_script()->get_mapping_new_pk(
+					$this->_old_table,
+					intval($old_attendee['id']),
+					$this->_new_transaction_table
+				);
+		} else { // non-primary attendee, so find its primary attendee's transaction
+			$primary_attendee_old_id =
+				$wpdb->get_var(
+					$wpdb->prepare(
+						"SELECT id FROM " . $this->_old_table . " WHERE is_primary=1 and registration_id=%s",
+						$old_attendee['registration_id']
+					)
+				);
+			if (! $primary_attendee_old_id) {
+				$primary_attendee        =
+					$this->_find_mer_primary_attendee_using_mer_tables($old_attendee['registration_id']);
+				$primary_attendee_old_id = is_array($primary_attendee) ? $primary_attendee['id'] : null;
+			}
+			$txn_id =
+				$this->get_migration_script()->get_mapping_new_pk(
+					$this->_old_table,
+					intval($primary_attendee_old_id),
+					$this->_new_transaction_table
+				);
+			if (! $txn_id) {
+				$this->add_error(
+					sprintf(
+						esc_html__(
+							"Could not find primary attendee's new transaction. Current attendee is: %s, we think the 3.1 primary attendee for it has id %d, but there's no 4.1 transaction for that primary attendee id.",
+							"event_espresso"
+						),
+						$this->_json_encode($old_attendee),
+						$primary_attendee_old_id
+					)
+				);
+				$txn_id = 0;
+			}
+		}
+		// if there isn't yet a transaction row for this, create one
+		// (so even if it was a non-primary attendee with no EE3 primary attendee,
+		// it ought to have SOME transaction, so we'll make one)
+		if (! $txn_id) {
+			// maps 3.1 payment stati onto 4.1 transaction stati
+			$txn_status_mapping = [
+				'Completed'        => 'TCM',
+				'Pending'          => 'TIN',
+				'Payment Declined' => 'TIN',
+				'Incomplete'       => 'TIN',
+				'Not Completed'    => 'TIN',
+				'Cancelled'        => 'TIN',
+				'Declined'         => 'TIN',
+			];
+			$STS_ID             = $txn_status_mapping[ $old_attendee['payment_status'] ] ?? 'TIN';
+			$cols_n_values      = [
+				'TXN_timestamp' => $this->get_migration_script()->convert_date_string_to_utc(
+					$this,
+					$old_attendee,
+					$old_attendee['date']
+				),
+				'TXN_total'     => floatval($old_attendee['total_cost']),
+				'TXN_paid'      => floatval($old_attendee['amount_pd']),
+				'STS_ID'        => $STS_ID,
+				'TXN_hash_salt' => $old_attendee['hashSalt'],
+			];
+			$data_types         = [
+				'%s',// TXN_timestamp
+				'%f',// TXN_total
+				'%f',// TXN_paid
+				'%s',// STS_ID
+				'%s',// TXN_hash_salt
+			];
+			$success            = $wpdb->insert($this->_new_transaction_table, $cols_n_values, $data_types);
+			if (! $success) {
+				$this->add_error(
+					$this->get_migration_script()->_create_error_message_for_db_insertion(
+						$this->_old_table,
+						$old_attendee,
+						$this->_new_transaction_table,
+						$cols_n_values,
+						$data_types
+					)
+				);
+				return 0;
+			}
+			$txn_id = $wpdb->insert_id;
+		}
+
+		return $txn_id;
+	}
+
+
+	/**
+	 * Detects if the MER tables exist
+	 *
+	 * @return boolean
+	 * @global wpdb $wpdb
+	 */
+	private function _mer_tables_exist(): ?bool
+	{
+		if ($this->_mer_tables_exist === null) {
+			global $wpdb;
+
+			if ($wpdb->get_var("SHOW TABLES LIKE '$this->_old_mer_table'") != $this->_old_mer_table) {
+				$this->_mer_tables_exist = false;
+			} else {
+				$this->_mer_tables_exist = true;
+			}
+		}
+		return $this->_mer_tables_exist;
+	}
+
+
+	/**
+	 * Gets the 4.1 registration's status given the 3.1 attendee row. We consider
+	 * whether the event required pre-approval or not,a dn the 4.1 payment status.
+	 *
+	 * @param array $old_attendee_row
+	 * @return string
+	 * @global wpdb $wpdb
+	 */
+	private function _get_reg_status_for_old_payment_status(array $old_attendee_row): string
+	{
+		// need event default reg status and if pre_approval was required
+		global $wpdb;
+		$event_required_pre_approval =
+			$wpdb->get_var(
+				$wpdb->prepare(
+					"SELECT require_pre_approval FROM " . $wpdb->prefix . "events_detail WHERE id = %d",
+					$old_attendee_row['event_id']
+				)
+			);
+		return $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(
+			$old_attendee_row['payment_status'],
+			intval($event_required_pre_approval) && intval($old_attendee_row['pre_approve'])
+		);
+	}
+
+
+	/**
+	 * Adds however many registrations are indicated by the old attendee's QUANTITY field,
+	 * and returns an array of their IDs
+	 *
+	 * @param array $old_attendee
+	 * @param int   $new_attendee_id
+	 * @param int   $new_txn_id
+	 * @return array of new registration ids
+	 * @throws EE_Error
+	 * @global wpdb $wpdb
+	 */
+	private function _insert_new_registrations(array $old_attendee, int $new_attendee_id, int $new_txn_id): array
+	{
+		global $wpdb;
+
+		$STS_ID       = $this->_get_reg_status_for_old_payment_status($old_attendee);
+		$new_event_id =
+			$this->get_migration_script()->get_mapping_new_pk(
+				$wpdb->prefix . 'events_detail',
+				$old_attendee['event_id'],
+				$wpdb->posts
+			);
+		if (! $new_event_id) {
+			$this->add_error(
+				sprintf(
+					esc_html__(
+						"Could not find NEW event CPT ID for old event '%d' on old attendee %s",
+						"event_espresso"
+					),
+					$old_attendee['event_id'],
+					$this->_json_encode($old_attendee)
+				)
+			);
+		}
+
+		$ticket_id = $this->_try_to_find_new_ticket_id($old_attendee, $new_event_id);
+		if (! $ticket_id) {
+			$ticket_id = $this->_insert_new_ticket_because_none_found($old_attendee, $new_event_id);
+			$this->add_error(
+				sprintf(
+					esc_html__(
+						'Could not find a ticket for old attendee with id %d for new event %d, so created a new ticket with id %d',
+						'event_espresso'
+					),
+					$old_attendee['id'],
+					$new_event_id,
+					$ticket_id
+				)
+			);
+		}
+		$regs_on_this_row = intval($old_attendee['quantity']);
+		$new_regs         = [];
+		// 4 cases we need to account for:
+		// 1 old attendee_details row with a quantity of X (no mer)
+		// Y old attendee_details rows with a quantity of 1 (no mer) joined by their common registration_id
+		// Y old attendee_details rows with a quantity of x (because of mer)
+		// Y old attendee_details rows with a quantity of 1 (because of mer) joined by wp_events_multi_event_registration_id_group
+		for ($count = 1; $count <= $regs_on_this_row; $count++) {
+			// sum regs on older rows
+			$regs_on_this_event_and_txn = $this->_sum_old_attendees_on_old_txn($old_attendee, true);
+			$cols_n_values              = [
+				'EVT_ID'           => $new_event_id,
+				'ATT_ID'           => $new_attendee_id,
+				'TXN_ID'           => $new_txn_id,
+				'TKT_ID'           => $ticket_id,
+				'STS_ID'           => $STS_ID,
+				'REG_date'         => $this->get_migration_script()->convert_date_string_to_utc(
+					$this,
+					$old_attendee,
+					$old_attendee['date']
+				),
+				'REG_final_price'  => $old_attendee['final_price'],
+				'REG_session'      => substr($old_attendee['attendee_session'], 0, 44),
+				'REG_code'         => sanitize_key($old_attendee['registration_id']),
+				'REG_url_link'     => sanitize_key($old_attendee['registration_id'] . '-' . $count),
+				'REG_count'        => $regs_on_this_event_and_txn + $count,
+				'REG_group_size'   => $this->_sum_old_attendees_on_old_txn($old_attendee),
+				'REG_att_is_going' => true,
+				'REG_deleted'      => false,
+			];
+			$data_types                 = [
+				'%d',// EVT_ID
+				'%d',// ATT_ID
+				'%d',// TXN_ID
+				'%d',// TKT_ID
+				'%s',// STS_ID
+				'%s',// REG_date
+				'%f',// REG_final_price
+				'%s',// REG_session
+				'%s',// REG_code
+				'%s',// REG_url_link
+				'%d',// REG_count
+				'%d',// REG_group_size
+				'%d',// REG_att_is_going
+				'%d',// REG_deleted
+			];
+			$success                    = $wpdb->insert($this->_new_reg_table, $cols_n_values, $data_types);
+			if (! $success) {
+				$this->add_error(
+					$this->get_migration_script()->_create_error_message_for_db_insertion(
+						$this->_old_table,
+						$old_attendee,
+						$this->_new_reg_table,
+						$cols_n_values,
+						$data_types
+					)
+				);
+				return [];
+			}
+			$cols_n_values['REG_ID'] = $wpdb->insert_id;
+			$new_regs[]              = $wpdb->insert_id;
+		}
+		$this->_add_regs_to_ticket_and_datetimes($ticket_id, count($new_regs), $STS_ID);
+		return $new_regs;
+	}
+
+
+	/**
+	 * Increments the sold values on the ticket and its related datetimes by the amount sold,
+	 * which should be done directly after adding the rows. Yes this means we're constantly incrementing
+	 * the sold amounts as we go, and is less efficient than a single big query,
+	 * but it's safer because we KNOW these regs have been added, rather than inferring
+	 * that they WILL be added (because the attendees stage runs nearly last during
+	 * the migration script)
+	 *
+	 * @param int    $new_ticket_id
+	 * @param int    $quantity_sold
+	 * @param string $STS_ID
+	 * @return boolean whether they were successfully updated or not
+	 */
+	protected function _add_regs_to_ticket_and_datetimes(int $new_ticket_id, int $quantity_sold, string $STS_ID): bool
+	{
+		if ($STS_ID != 'RAP') {
+			return true;
+		}
+		global $wpdb;
+		$success =
+			$wpdb->query(
+				$wpdb->prepare(
+					"UPDATE $this->_new_ticket_table SET TKT_sold=TKT_sold+%d WHERE TKT_ID=%d",
+					$quantity_sold,
+					$new_ticket_id
+				)
+			);
+		if ($success) {
+			// get the ticket's datetimes, and increment them too
+			$success_update_datetimes = $wpdb->query(
+				$wpdb->prepare(
+					"UPDATE $this->_new_ticket_table TKT
 				INNER JOIN $this->_new_ticket_datetime_table as DTK ON TKT.TKT_ID = DTK.TKT_ID
 				INNER JOIN $this->_new_datetime_table as DTT ON DTK.DTT_ID = DTT.DTT_ID
 				SET DTT.DTT_sold = DTT.DTT_sold + %d WHERE TKT.TKT_ID = %d",
-                    $quantity_sold,
-                    $new_ticket_id
-                )
-            );
-            if (! $success_update_datetimes) {
-                $this->add_error(
-                    sprintf(
-                        esc_html__(
-                            "Could not update datetimes related to ticket with ID %d's TKT_sold by %d because %s",
-                            "event_espresso"
-                        ),
-                        $new_ticket_id,
-                        $quantity_sold,
-                        $wpdb->last_error
-                    )
-                );
-            }
-        } else {
-            $this->add_error(
-                sprintf(
-                    esc_html__("Could not update ticket with ID %d's TKT_sold by %d because %s", "event_espresso"),
-                    $new_ticket_id,
-                    $quantity_sold,
-                    $wpdb->last_error
-                )
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * Makes a guess at which ticket is the one the attendee purchased.
-     * Obviously, the old attendee's event_id narrows it down quite a bit;
-     * then the old attendee's orig_price and event_time, and price_option can uniquely identify the ticket
-     * however, if we don't find an exact match, see if any of those conditions match;
-     * and lastly if none of that works, just use the first ticket for the event we find
-     *
-     * @param array $old_attendee
-     * @param       $new_event_id
-     * @return string|null
-     */
-    private function _try_to_find_new_ticket_id(array $old_attendee, $new_event_id): ?string
-    {
-        global $wpdb;
-        $tickets_table          = $this->_new_ticket_table;
-        $datetime_tickets_table = $this->_new_ticket_datetime_table;
-        $datetime_table         = $this->_new_datetime_table;
-
-        $old_att_price_option = $old_attendee['price_option'];
-        $old_att_price        = floatval($old_attendee['orig_price']);
-
-        $old_att_start_date = $old_attendee['start_date'];
-        $old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
-        $old_att_datetime   =
-            $this->get_migration_script()->convert_date_string_to_utc(
-                $this,
-                $old_attendee,
-                "$old_att_start_date $old_att_start_time:00"
-            );
-        // add all conditions to an array from which we can SHIFT conditions off in order to widen our search
-        // the most important condition should be last, as it will be array_shift'ed off last
-        $conditions           = [
-            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
-            $wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price),// prices match?
-            $wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option),// names match?
-            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
-        ];
-        $select_and_join_part = "SELECT $tickets_table.TKT_ID FROM $tickets_table INNER JOIN
+					$quantity_sold,
+					$new_ticket_id
+				)
+			);
+			if (! $success_update_datetimes) {
+				$this->add_error(
+					sprintf(
+						esc_html__(
+							"Could not update datetimes related to ticket with ID %d's TKT_sold by %d because %s",
+							"event_espresso"
+						),
+						$new_ticket_id,
+						$quantity_sold,
+						$wpdb->last_error
+					)
+				);
+			}
+		} else {
+			$this->add_error(
+				sprintf(
+					esc_html__("Could not update ticket with ID %d's TKT_sold by %d because %s", "event_espresso"),
+					$new_ticket_id,
+					$quantity_sold,
+					$wpdb->last_error
+				)
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Makes a guess at which ticket is the one the attendee purchased.
+	 * Obviously, the old attendee's event_id narrows it down quite a bit;
+	 * then the old attendee's orig_price and event_time, and price_option can uniquely identify the ticket
+	 * however, if we don't find an exact match, see if any of those conditions match;
+	 * and lastly if none of that works, just use the first ticket for the event we find
+	 *
+	 * @param array $old_attendee
+	 * @param       $new_event_id
+	 * @return string|null
+	 */
+	private function _try_to_find_new_ticket_id(array $old_attendee, $new_event_id): ?string
+	{
+		global $wpdb;
+		$tickets_table          = $this->_new_ticket_table;
+		$datetime_tickets_table = $this->_new_ticket_datetime_table;
+		$datetime_table         = $this->_new_datetime_table;
+
+		$old_att_price_option = $old_attendee['price_option'];
+		$old_att_price        = floatval($old_attendee['orig_price']);
+
+		$old_att_start_date = $old_attendee['start_date'];
+		$old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
+		$old_att_datetime   =
+			$this->get_migration_script()->convert_date_string_to_utc(
+				$this,
+				$old_attendee,
+				"$old_att_start_date $old_att_start_time:00"
+			);
+		// add all conditions to an array from which we can SHIFT conditions off in order to widen our search
+		// the most important condition should be last, as it will be array_shift'ed off last
+		$conditions           = [
+			$wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
+			$wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price),// prices match?
+			$wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option),// names match?
+			$wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
+		];
+		$select_and_join_part = "SELECT $tickets_table.TKT_ID FROM $tickets_table INNER JOIN
 			$datetime_tickets_table ON $tickets_table.TKT_ID = $datetime_tickets_table.TKT_ID INNER JOIN
 			$datetime_table ON $datetime_tickets_table.DTT_ID = $datetime_table.DTT_ID";
-        // start running queries, widening search each time by removing a condition
-        do {
-            $full_query      = $select_and_join_part . " WHERE " . implode(" AND ", $conditions) . " LIMIT 1";
-            $ticket_id_found = $wpdb->get_var($full_query);
-            array_shift($conditions);
-        } while (! $ticket_id_found && $conditions);
-        return $ticket_id_found;
-    }
-
-
-    /**
-     * If we couldn't find a 4.1 ticket for a 3.1 attendee row, this function creates one;
-     * and it also tries to find a datetime that works, and inserts a price, and associates
-     * the new ticket to that datetime and price.
-     *
-     * @return int ticket id
-     */
-    private function _insert_new_ticket_because_none_found($old_attendee, $new_event_id): int
-    {
-        global $wpdb;
-        $old_att_price_option = $old_attendee['price_option'];
-        $old_att_price        = floatval($old_attendee['orig_price']);
-
-        $old_att_start_date     = $old_attendee['start_date'];
-        $old_att_start_time     = $this->get_migration_script()->convertTimeFromAMPM(
-            $old_attendee['event_time']
-        );
-        $old_att_start_datetime =
-            $this->get_migration_script()->convert_date_string_to_utc(
-                $this,
-                $old_attendee,
-                "$old_att_start_date $old_att_start_time:00"
-            );
-        $old_att_end_datetime   = null;
-
-
-        // insert new datetime unless we find one
-        $datetime_id =
-            $wpdb->get_var(
-                $wpdb->prepare(
-                    "SELECT DTT_ID FROM " .
-                    $this->_new_datetime_table .
-                    " WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1",
-                    $old_att_start_datetime,
-                    $new_event_id
-                ),
-                ARRAY_A
-            );
-        if (! $datetime_id) {
-            $old_att_end_date     = $old_attendee['start_date'];
-            $old_att_end_time     = $this->get_migration_script()->convertTimeFromAMPM(
-                $old_attendee['event_time']
-            );
-            $old_att_end_datetime = $this->get_migration_script()->convert_date_string_to_utc(
-                $this,
-                $old_attendee,
-                "$old_att_end_date $old_att_end_time:00"
-            );
-            $wpdb->insert(
-                $this->_new_datetime_table,
-                [
-                    'EVT_ID'        => $new_event_id,
-                    'DTT_EVT_start' => $old_att_start_datetime,
-                    'DTT_EVT_end'   => $old_att_end_datetime,
-                    'DTT_deleted'   => true,
-                ],
-                [
-                    '%d',// EVT_ID
-                    '%s',// DTT_EVT_start
-                    '%s',// DTT_EVT_end
-                    '%d',// DTT_deleted
-                ]
-            );
-            $datetime_id = $wpdb->insert_id;
-        }
-
-        // insert new ticket
-        $wpdb->insert(
-            $wpdb->prefix . 'esp_ticket',
-            [
-                'TKT_name'       => $old_att_price_option,
-                'TKT_qty'        => -1,
-                'TKT_price'      => $old_att_price,
-                'TKT_start_date' => $old_att_start_datetime,
-                // we really have no clue what the time should be, but at least it was available when they attended
-                'TKT_end_date'   => $old_att_end_datetime,
-
-            ],
-            [
-                '%s',// name
-                '%d',// qty
-                '%d',// price
-                '%s',// start_date
-                '%s',// end_date
-            ]
-        );
-        $ticket_id = $wpdb->insert_id;
-        // associate the ticket with the datetime we found earlier
-        $wpdb->insert(
-            $this->_new_datetime_ticket_table,
-            [
-                'DTT_ID' => $datetime_id,
-                'TKT_ID' => $ticket_id,
-            ],
-            [
-                '%d',// DTT_ID
-                '%d',// TKT_ID
-            ]
-        );
-        // insert new price
-        $wpdb->insert(
-            $this->_new_price_table,
-            [
-                'PRC_amount'  => $old_att_price,
-                'PRT_ID'      => EE_DMS_4_1_0_prices::price_type_base,
-                'PRC_name'    => $old_att_price_option,
-                'PRC_deleted' => true,
-            ],
-            [
-                '%d',// PRC_amount
-                '%d',// PRT_ID
-                '%s',// PRC_name
-                '%d',// PRC_deleted
-            ]
-        );
-        $price_id = $wpdb->insert_id;
-        // associate the price to the ticket
-        $wpdb->insert(
-            $this->_new_ticket_price_table,
-            [
-                'TKT_ID' => $ticket_id,
-                'PRC_ID' => $price_id,
-            ],
-            [
-                '%d',// TKT_ID
-                '%d',// PRC_ID
-            ]
-        );
-        return $ticket_id;
-    }
-
-
-    /**
-     * Counts all the registrations on this transaction. If $count_only_older is TRUE then returns the number added SO
-     * FAR (ie, only considers attendee rows with an ID less than this one's), but if $count_only_older is FALSe
-     * returns ALL
-     *
-     * @param array   $old_attendee_row
-     * @param boolean $count_only_older true if you want the running count (ie, the total up to this row), and false if
-     *                                  you want ALL
-     * @return int
-     * @global wpdb   $wpdb
-     */
-    private function _sum_old_attendees_on_old_txn(array $old_attendee_row, bool $count_only_older = false): int
-    {
-        global $wpdb;
-        $count_only_older_sql = $count_only_older ? $wpdb->prepare(" AND id<%d", $old_attendee_row['id']) : '';
-        $count                =
-            intval(
-                $wpdb->get_var(
-                    $wpdb->prepare(
-                        "SELECT SUM(quantity) FROM " .
-                        $this->_old_table .
-                        " WHERE registration_id=%s $count_only_older_sql",
-                        $old_attendee_row['registration_id']
-                    )
-                )
-            );
-
-        if ($this->_mer_tables_exist()) {
-            // if MER exists, then it's a little tricky.
-            // when users registered by adding items to the cart, and it was a
-            // group registration requiring additional attendee INFO, then the attendee rows
-            // DO NOT have the same registration_id (although they probably should have)
-            // they are related just like MER attendee rows are related, through the MER group table
-            // BUT we want to count all the MER attendee rows for the same registration
-            $primary_attendee =
-                $this->_find_mer_primary_attendee_using_mer_tables($old_attendee_row['registration_id']);
-
-            $count_using_mer_table =
-                $wpdb->get_var(
-                    $wpdb->prepare(
-                        "SELECT SUM(quantity) FROM $this->_old_table att INNER JOIN $this->_old_mer_table mer ON att.registration_id = mer.registration_id WHERE att.event_id=%d AND mer.primary_registration_id = %s $count_only_older_sql",
-                        $old_attendee_row['event_id'],
-                        $primary_attendee['registration_id']
-                    )
-                );
-            $count                 = max($count_using_mer_table, $count);
-        }
-        return $count;
-    }
-
-
-    private function _insert_new_payment($old_attendee, $new_txn_id): int
-    {
-        global $wpdb;
-        // Only add a payment for primary attendees. Important note: partial payments were marked as "Pending".
-        // Also, an offline payment had blank status (ie, "").
-        $old_pay_stati_indicating_no_payment = ['', 'Incomplete', 'Not Completed'];
-        // if this is for a primary 3.1 attendee which WASN'T free and has a completed, cancelled, or declined payment...
-        if (
-            intval($old_attendee['is_primary']) &&
-            floatval($old_attendee['total_cost']) &&
-            ! in_array($old_attendee['payment_status'], $old_pay_stati_indicating_no_payment)
-        ) {
-            $pay_status_mapping = [
-                'Completed'        => 'PAP',
-                'Payment Declined' => 'PDC',
-                'Cancelled'        => 'PCN',
-                'Declined'         => 'PDC',
-            ];
-
-            $by_admin = $old_attendee['payment'] == 'Admin';
-
-            // IE, if we don't recognize the status, assume payment failed
-            $STS_ID = $pay_status_mapping[ $old_attendee['payment_status'] ] ?? 'PFL';
-
-            $cols_n_values = [
-                'TXN_ID'               => $new_txn_id,
-                'STS_ID'               => $STS_ID,
-                'PAY_timestamp'        => $this->get_migration_script()->convert_date_string_to_utc(
-                    $this,
-                    $old_attendee,
-                    $old_attendee['date']
-                ),
-                'PAY_method'           => 'CART',
-                'PAY_amount'           => $old_attendee['amount_pd'],
-                // 'txn_type' was used both for the gateway's name, and for other payment notes.
-                'PAY_gateway'          => $old_attendee['txn_type'],
-                'PAY_extra_accntng'    => $old_attendee['txn_type'],
-                'PAY_gateway_response' => '',
-                'PAY_txn_id_chq_nmbr'  => substr($old_attendee['txn_id'], 0, 32),
-                'PAY_via_admin'        => $by_admin,
-                'PAY_details'          => $old_attendee['transaction_details'],
-            ];
-            $data_types    = [
-                '%d',// TXN_Id
-                '%s',// STS_ID
-                '%s',// PAY_timestamp
-                '%s',// PAY_method
-                '%f',// PAY_amount
-                '%s',// PAY_gateway
-                '%s',// PAY_gateway_response
-                '%s',// PAY_txn_id_chq_nmbr
-                '%d',// PAY_via_admin
-                '%s',// PAY_details
-            ];
-            $success       = $wpdb->insert($this->_new_payment_table, $cols_n_values, $data_types);
-            if (! $success) {
-                $this->add_error(
-                    $this->get_migration_script()->_create_error_message_for_db_insertion(
-                        $this->_old_table,
-                        $old_attendee,
-                        $this->_new_attendee_cpt_table,
-                        $cols_n_values,
-                        $data_types
-                    )
-                );
-                return 0;
-            }
-            return $wpdb->insert_id;
-        }
-        return 0;
-    }
-
-
-    /**
-     * If MER is active, if you want ot find the other registrations on that attendee row
-     *
-     * @param int   $old_registration_id
-     * @return array|null
-     * @global wpdb $wpdb
-     */
-    private function _find_mer_primary_attendee_using_mer_tables(int $old_registration_id): ?array
-    {
-        if (! $this->_mer_tables_exist()) {
-            return null;
-        }
-        global $wpdb;
-        return $wpdb->get_row(
-            $wpdb->prepare(
-                "SELECT * FROM $this->_old_mer_table AS mer INNER JOIN $this->_old_table AS att ON mer.primary_registration_id = att.registration_id WHERE mer.registration_id=%s LIMIT 1",
-                $old_registration_id
-            ),
-            ARRAY_A
-        );
-    }
+		// start running queries, widening search each time by removing a condition
+		do {
+			$full_query      = $select_and_join_part . " WHERE " . implode(" AND ", $conditions) . " LIMIT 1";
+			$ticket_id_found = $wpdb->get_var($full_query);
+			array_shift($conditions);
+		} while (! $ticket_id_found && $conditions);
+		return $ticket_id_found;
+	}
+
+
+	/**
+	 * If we couldn't find a 4.1 ticket for a 3.1 attendee row, this function creates one;
+	 * and it also tries to find a datetime that works, and inserts a price, and associates
+	 * the new ticket to that datetime and price.
+	 *
+	 * @return int ticket id
+	 */
+	private function _insert_new_ticket_because_none_found($old_attendee, $new_event_id): int
+	{
+		global $wpdb;
+		$old_att_price_option = $old_attendee['price_option'];
+		$old_att_price        = floatval($old_attendee['orig_price']);
+
+		$old_att_start_date     = $old_attendee['start_date'];
+		$old_att_start_time     = $this->get_migration_script()->convertTimeFromAMPM(
+			$old_attendee['event_time']
+		);
+		$old_att_start_datetime =
+			$this->get_migration_script()->convert_date_string_to_utc(
+				$this,
+				$old_attendee,
+				"$old_att_start_date $old_att_start_time:00"
+			);
+		$old_att_end_datetime   = null;
+
+
+		// insert new datetime unless we find one
+		$datetime_id =
+			$wpdb->get_var(
+				$wpdb->prepare(
+					"SELECT DTT_ID FROM " .
+					$this->_new_datetime_table .
+					" WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1",
+					$old_att_start_datetime,
+					$new_event_id
+				),
+				ARRAY_A
+			);
+		if (! $datetime_id) {
+			$old_att_end_date     = $old_attendee['start_date'];
+			$old_att_end_time     = $this->get_migration_script()->convertTimeFromAMPM(
+				$old_attendee['event_time']
+			);
+			$old_att_end_datetime = $this->get_migration_script()->convert_date_string_to_utc(
+				$this,
+				$old_attendee,
+				"$old_att_end_date $old_att_end_time:00"
+			);
+			$wpdb->insert(
+				$this->_new_datetime_table,
+				[
+					'EVT_ID'        => $new_event_id,
+					'DTT_EVT_start' => $old_att_start_datetime,
+					'DTT_EVT_end'   => $old_att_end_datetime,
+					'DTT_deleted'   => true,
+				],
+				[
+					'%d',// EVT_ID
+					'%s',// DTT_EVT_start
+					'%s',// DTT_EVT_end
+					'%d',// DTT_deleted
+				]
+			);
+			$datetime_id = $wpdb->insert_id;
+		}
+
+		// insert new ticket
+		$wpdb->insert(
+			$wpdb->prefix . 'esp_ticket',
+			[
+				'TKT_name'       => $old_att_price_option,
+				'TKT_qty'        => -1,
+				'TKT_price'      => $old_att_price,
+				'TKT_start_date' => $old_att_start_datetime,
+				// we really have no clue what the time should be, but at least it was available when they attended
+				'TKT_end_date'   => $old_att_end_datetime,
+
+			],
+			[
+				'%s',// name
+				'%d',// qty
+				'%d',// price
+				'%s',// start_date
+				'%s',// end_date
+			]
+		);
+		$ticket_id = $wpdb->insert_id;
+		// associate the ticket with the datetime we found earlier
+		$wpdb->insert(
+			$this->_new_datetime_ticket_table,
+			[
+				'DTT_ID' => $datetime_id,
+				'TKT_ID' => $ticket_id,
+			],
+			[
+				'%d',// DTT_ID
+				'%d',// TKT_ID
+			]
+		);
+		// insert new price
+		$wpdb->insert(
+			$this->_new_price_table,
+			[
+				'PRC_amount'  => $old_att_price,
+				'PRT_ID'      => EE_DMS_4_1_0_prices::price_type_base,
+				'PRC_name'    => $old_att_price_option,
+				'PRC_deleted' => true,
+			],
+			[
+				'%d',// PRC_amount
+				'%d',// PRT_ID
+				'%s',// PRC_name
+				'%d',// PRC_deleted
+			]
+		);
+		$price_id = $wpdb->insert_id;
+		// associate the price to the ticket
+		$wpdb->insert(
+			$this->_new_ticket_price_table,
+			[
+				'TKT_ID' => $ticket_id,
+				'PRC_ID' => $price_id,
+			],
+			[
+				'%d',// TKT_ID
+				'%d',// PRC_ID
+			]
+		);
+		return $ticket_id;
+	}
+
+
+	/**
+	 * Counts all the registrations on this transaction. If $count_only_older is TRUE then returns the number added SO
+	 * FAR (ie, only considers attendee rows with an ID less than this one's), but if $count_only_older is FALSe
+	 * returns ALL
+	 *
+	 * @param array   $old_attendee_row
+	 * @param boolean $count_only_older true if you want the running count (ie, the total up to this row), and false if
+	 *                                  you want ALL
+	 * @return int
+	 * @global wpdb   $wpdb
+	 */
+	private function _sum_old_attendees_on_old_txn(array $old_attendee_row, bool $count_only_older = false): int
+	{
+		global $wpdb;
+		$count_only_older_sql = $count_only_older ? $wpdb->prepare(" AND id<%d", $old_attendee_row['id']) : '';
+		$count                =
+			intval(
+				$wpdb->get_var(
+					$wpdb->prepare(
+						"SELECT SUM(quantity) FROM " .
+						$this->_old_table .
+						" WHERE registration_id=%s $count_only_older_sql",
+						$old_attendee_row['registration_id']
+					)
+				)
+			);
+
+		if ($this->_mer_tables_exist()) {
+			// if MER exists, then it's a little tricky.
+			// when users registered by adding items to the cart, and it was a
+			// group registration requiring additional attendee INFO, then the attendee rows
+			// DO NOT have the same registration_id (although they probably should have)
+			// they are related just like MER attendee rows are related, through the MER group table
+			// BUT we want to count all the MER attendee rows for the same registration
+			$primary_attendee =
+				$this->_find_mer_primary_attendee_using_mer_tables($old_attendee_row['registration_id']);
+
+			$count_using_mer_table =
+				$wpdb->get_var(
+					$wpdb->prepare(
+						"SELECT SUM(quantity) FROM $this->_old_table att INNER JOIN $this->_old_mer_table mer ON att.registration_id = mer.registration_id WHERE att.event_id=%d AND mer.primary_registration_id = %s $count_only_older_sql",
+						$old_attendee_row['event_id'],
+						$primary_attendee['registration_id']
+					)
+				);
+			$count                 = max($count_using_mer_table, $count);
+		}
+		return $count;
+	}
+
+
+	private function _insert_new_payment($old_attendee, $new_txn_id): int
+	{
+		global $wpdb;
+		// Only add a payment for primary attendees. Important note: partial payments were marked as "Pending".
+		// Also, an offline payment had blank status (ie, "").
+		$old_pay_stati_indicating_no_payment = ['', 'Incomplete', 'Not Completed'];
+		// if this is for a primary 3.1 attendee which WASN'T free and has a completed, cancelled, or declined payment...
+		if (
+			intval($old_attendee['is_primary']) &&
+			floatval($old_attendee['total_cost']) &&
+			! in_array($old_attendee['payment_status'], $old_pay_stati_indicating_no_payment)
+		) {
+			$pay_status_mapping = [
+				'Completed'        => 'PAP',
+				'Payment Declined' => 'PDC',
+				'Cancelled'        => 'PCN',
+				'Declined'         => 'PDC',
+			];
+
+			$by_admin = $old_attendee['payment'] == 'Admin';
+
+			// IE, if we don't recognize the status, assume payment failed
+			$STS_ID = $pay_status_mapping[ $old_attendee['payment_status'] ] ?? 'PFL';
+
+			$cols_n_values = [
+				'TXN_ID'               => $new_txn_id,
+				'STS_ID'               => $STS_ID,
+				'PAY_timestamp'        => $this->get_migration_script()->convert_date_string_to_utc(
+					$this,
+					$old_attendee,
+					$old_attendee['date']
+				),
+				'PAY_method'           => 'CART',
+				'PAY_amount'           => $old_attendee['amount_pd'],
+				// 'txn_type' was used both for the gateway's name, and for other payment notes.
+				'PAY_gateway'          => $old_attendee['txn_type'],
+				'PAY_extra_accntng'    => $old_attendee['txn_type'],
+				'PAY_gateway_response' => '',
+				'PAY_txn_id_chq_nmbr'  => substr($old_attendee['txn_id'], 0, 32),
+				'PAY_via_admin'        => $by_admin,
+				'PAY_details'          => $old_attendee['transaction_details'],
+			];
+			$data_types    = [
+				'%d',// TXN_Id
+				'%s',// STS_ID
+				'%s',// PAY_timestamp
+				'%s',// PAY_method
+				'%f',// PAY_amount
+				'%s',// PAY_gateway
+				'%s',// PAY_gateway_response
+				'%s',// PAY_txn_id_chq_nmbr
+				'%d',// PAY_via_admin
+				'%s',// PAY_details
+			];
+			$success       = $wpdb->insert($this->_new_payment_table, $cols_n_values, $data_types);
+			if (! $success) {
+				$this->add_error(
+					$this->get_migration_script()->_create_error_message_for_db_insertion(
+						$this->_old_table,
+						$old_attendee,
+						$this->_new_attendee_cpt_table,
+						$cols_n_values,
+						$data_types
+					)
+				);
+				return 0;
+			}
+			return $wpdb->insert_id;
+		}
+		return 0;
+	}
+
+
+	/**
+	 * If MER is active, if you want ot find the other registrations on that attendee row
+	 *
+	 * @param int   $old_registration_id
+	 * @return array|null
+	 * @global wpdb $wpdb
+	 */
+	private function _find_mer_primary_attendee_using_mer_tables(int $old_registration_id): ?array
+	{
+		if (! $this->_mer_tables_exist()) {
+			return null;
+		}
+		global $wpdb;
+		return $wpdb->get_row(
+			$wpdb->prepare(
+				"SELECT * FROM $this->_old_mer_table AS mer INNER JOIN $this->_old_table AS att ON mer.primary_registration_id = att.registration_id WHERE mer.registration_id=%s LIMIT 1",
+				$old_registration_id
+			),
+			ARRAY_A
+		);
+	}
 }

Spacing +140 added lines, -140 removed lines

@@ -261,25 +261,25 @@ 
     {
         global $wpdb;
         $this->_pretty_name = esc_html__("Attendees", "event_espresso");
-        $this->_old_table   = $wpdb->prefix . "events_attendee";
+        $this->_old_table   = $wpdb->prefix."events_attendee";
         // Only select the event status column from the event table.
         $this->select_expression = 'att.*, e.event_status';
         // Only select attendees for events that aren't deleted.
         $this->_extra_where_sql           = 'AS att
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
-        $this->_old_mer_table             = $wpdb->prefix . "events_multi_event_registration_id_group";
+        $this->_old_mer_table             = $wpdb->prefix."events_multi_event_registration_id_group";
         $this->_new_attendee_cpt_table    = $wpdb->posts;
-        $this->_new_attendee_meta_table   = $wpdb->prefix . "esp_attendee_meta";
-        $this->_new_reg_table             = $wpdb->prefix . "esp_registration";
-        $this->_new_transaction_table     = $wpdb->prefix . "esp_transaction";
-        $this->_new_payment_table         = $wpdb->prefix . "esp_payment";
-        $this->_new_ticket_table          = $wpdb->prefix . "esp_ticket";
-        $this->_new_ticket_datetime_table = $wpdb->prefix . "esp_datetime_ticket";
-        $this->_new_datetime_table        = $wpdb->prefix . "esp_datetime";
-        $this->_new_datetime_ticket_table = $wpdb->prefix . "esp_datetime_ticket";
-        $this->_new_price_table           = $wpdb->prefix . "esp_price";
-        $this->_new_ticket_price_table    = $wpdb->prefix . "esp_ticket_price";
+        $this->_new_attendee_meta_table   = $wpdb->prefix."esp_attendee_meta";
+        $this->_new_reg_table             = $wpdb->prefix."esp_registration";
+        $this->_new_transaction_table     = $wpdb->prefix."esp_transaction";
+        $this->_new_payment_table         = $wpdb->prefix."esp_payment";
+        $this->_new_ticket_table          = $wpdb->prefix."esp_ticket";
+        $this->_new_ticket_datetime_table = $wpdb->prefix."esp_datetime_ticket";
+        $this->_new_datetime_table        = $wpdb->prefix."esp_datetime";
+        $this->_new_datetime_ticket_table = $wpdb->prefix."esp_datetime_ticket";
+        $this->_new_price_table           = $wpdb->prefix."esp_price";
+        $this->_new_ticket_price_table    = $wpdb->prefix."esp_ticket_price";
         parent::__construct();
     }
 
@@ -291,9 +291,9 @@ 
     {
         // first check if there's already a new attendee with similar characteristics
         $new_att_id = $this->_find_attendee_cpt_matching($old_row);
-        if (! $new_att_id) {
+        if ( ! $new_att_id) {
             $new_att_id = $this->_insert_new_attendee_cpt($old_row);
-            if (! $new_att_id) {
+            if ( ! $new_att_id) {
                 // if we couldn't even make an attendee, abandon all hope
                 return;
             }
@@ -315,7 +315,7 @@ 
         );
 
         $txn_id = $this->_insert_new_transaction($old_row);
-        if (! $txn_id) {
+        if ( ! $txn_id) {
             // if we couldn't make the transaction, also abandon all hope
             return;
         }
@@ -363,10 +363,10 @@ 
         $existing_attendee_id =
             $wpdb->get_var(
                 $wpdb->prepare(
-                    "SELECT id FROM " .
-                    $this->_new_attendee_cpt_table .
-                    " AS cpt INNER JOIN " .
-                    $this->_new_attendee_meta_table .
+                    "SELECT id FROM ".
+                    $this->_new_attendee_cpt_table.
+                    " AS cpt INNER JOIN ".
+                    $this->_new_attendee_meta_table.
                     " AS meta ON cpt.ID = meta.ATT_ID WHERE meta.ATT_fname = %s AND meta.ATT_lname = %s AND meta.ATT_email = %s LIMIT 1",
                     $old_attendee['fname'],
                     $old_attendee['lname'],
@@ -381,39 +381,39 @@ 
     {
         global $wpdb;
         $cols_n_values = [
-            'post_title'    => stripslashes($old_attendee['fname'] . " " . $old_attendee['lname']),// ATT_full_name
-            'post_content'  => '',// ATT_bio
-            'post_name'     => sanitize_title($old_attendee['fname'] . "-" . $old_attendee['lname']),// ATT_slug
+            'post_title'    => stripslashes($old_attendee['fname']." ".$old_attendee['lname']), // ATT_full_name
+            'post_content'  => '', // ATT_bio
+            'post_name'     => sanitize_title($old_attendee['fname']."-".$old_attendee['lname']), // ATT_slug
             'post_date'     => $this->get_migration_script()->convert_date_string_to_utc(
                 $this,
                 $old_attendee,
                 $old_attendee['date']
-            ),// ATT_created
-            'post_excerpt'  => '',// ATT_short_bio
+            ), // ATT_created
+            'post_excerpt'  => '', // ATT_short_bio
             'post_modified' => $this->get_migration_script()->convert_date_string_to_utc(
                 $this,
                 $old_attendee,
                 $old_attendee['date']
-            ),// ATT_modified
-            'post_author'   => 0,// ATT_author
-            'post_parent'   => 0,// ATT_parent
+            ), // ATT_modified
+            'post_author'   => 0, // ATT_author
+            'post_parent'   => 0, // ATT_parent
             'post_type'     => EspressoPostType::ATTENDEES,
-            'post_status'   => 'publish',// status
+            'post_status'   => 'publish', // status
         ];
-        $data_types    = [
-            '%s',// ATT_full_name
-            '%s',// ATT_bio
-            '%s',// ATT_slug
-            '%s',// ATT_created
-            '%s',// ATT_short_bio
-            '%s',// ATT_modified
-            '%d',// ATT_author
-            '%d',// ATT_parent
-            '%s',// post_type
-            '%s',// status
+        $data_types = [
+            '%s', // ATT_full_name
+            '%s', // ATT_bio
+            '%s', // ATT_slug
+            '%s', // ATT_created
+            '%s', // ATT_short_bio
+            '%s', // ATT_modified
+            '%d', // ATT_author
+            '%d', // ATT_parent
+            '%s', // post_type
+            '%s', // status
         ];
-        $success       = $wpdb->insert($this->_new_attendee_cpt_table, $cols_n_values, $data_types);
-        if (! $success) {
+        $success = $wpdb->insert($this->_new_attendee_cpt_table, $cols_n_values, $data_types);
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_table,
@@ -441,7 +441,7 @@ 
             $new_country_iso = $this->get_migration_script()->get_default_country_iso();
         }
         try {
-            $new_state    =
+            $new_state =
                 $this->get_migration_script()->get_or_create_state(
                     stripslashes($old_attendee['state']),
                     $new_country_iso
@@ -463,21 +463,21 @@ 
             'ATT_email'    => stripslashes($old_attendee['email']),
             'ATT_phone'    => stripslashes($old_attendee['phone']),
         ];
-        $data_types    = [
-            '%d',// ATT_ID
-            '%s',// ATT_fname
-            '%s',// ATT_lname
-            '%s',// ATT_address
-            '%s',// ATT_address2
-            '%s',// ATT_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// ATT_zip
-            '%s',// ATT_email
-            '%s',// ATT_phone
+        $data_types = [
+            '%d', // ATT_ID
+            '%s', // ATT_fname
+            '%s', // ATT_lname
+            '%s', // ATT_address
+            '%s', // ATT_address2
+            '%s', // ATT_city
+            '%d', // STA_ID
+            '%s', // CNT_ISO
+            '%s', // ATT_zip
+            '%s', // ATT_email
+            '%s', // ATT_phone
         ];
-        $success       = $wpdb->insert($this->_new_attendee_meta_table, $cols_n_values, $data_types);
-        if (! $success) {
+        $success = $wpdb->insert($this->_new_attendee_meta_table, $cols_n_values, $data_types);
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_table,
@@ -519,11 +519,11 @@ 
             $primary_attendee_old_id =
                 $wpdb->get_var(
                     $wpdb->prepare(
-                        "SELECT id FROM " . $this->_old_table . " WHERE is_primary=1 and registration_id=%s",
+                        "SELECT id FROM ".$this->_old_table." WHERE is_primary=1 and registration_id=%s",
                         $old_attendee['registration_id']
                     )
                 );
-            if (! $primary_attendee_old_id) {
+            if ( ! $primary_attendee_old_id) {
                 $primary_attendee        =
                     $this->_find_mer_primary_attendee_using_mer_tables($old_attendee['registration_id']);
                 $primary_attendee_old_id = is_array($primary_attendee) ? $primary_attendee['id'] : null;
@@ -534,7 +534,7 @@ 
                     intval($primary_attendee_old_id),
                     $this->_new_transaction_table
                 );
-            if (! $txn_id) {
+            if ( ! $txn_id) {
                 $this->add_error(
                     sprintf(
                         esc_html__(
@@ -551,7 +551,7 @@ 
         // if there isn't yet a transaction row for this, create one
         // (so even if it was a non-primary attendee with no EE3 primary attendee,
         // it ought to have SOME transaction, so we'll make one)
-        if (! $txn_id) {
+        if ( ! $txn_id) {
             // maps 3.1 payment stati onto 4.1 transaction stati
             $txn_status_mapping = [
                 'Completed'        => 'TCM',
@@ -562,7 +562,7 @@ 
                 'Cancelled'        => 'TIN',
                 'Declined'         => 'TIN',
             ];
-            $STS_ID             = $txn_status_mapping[ $old_attendee['payment_status'] ] ?? 'TIN';
+            $STS_ID             = $txn_status_mapping[$old_attendee['payment_status']] ?? 'TIN';
             $cols_n_values      = [
                 'TXN_timestamp' => $this->get_migration_script()->convert_date_string_to_utc(
                     $this,
@@ -574,15 +574,15 @@ 
                 'STS_ID'        => $STS_ID,
                 'TXN_hash_salt' => $old_attendee['hashSalt'],
             ];
-            $data_types         = [
-                '%s',// TXN_timestamp
-                '%f',// TXN_total
-                '%f',// TXN_paid
-                '%s',// STS_ID
-                '%s',// TXN_hash_salt
+            $data_types = [
+                '%s', // TXN_timestamp
+                '%f', // TXN_total
+                '%f', // TXN_paid
+                '%s', // STS_ID
+                '%s', // TXN_hash_salt
             ];
-            $success            = $wpdb->insert($this->_new_transaction_table, $cols_n_values, $data_types);
-            if (! $success) {
+            $success = $wpdb->insert($this->_new_transaction_table, $cols_n_values, $data_types);
+            if ( ! $success) {
                 $this->add_error(
                     $this->get_migration_script()->_create_error_message_for_db_insertion(
                         $this->_old_table,
@@ -637,7 +637,7 @@ 
         $event_required_pre_approval =
             $wpdb->get_var(
                 $wpdb->prepare(
-                    "SELECT require_pre_approval FROM " . $wpdb->prefix . "events_detail WHERE id = %d",
+                    "SELECT require_pre_approval FROM ".$wpdb->prefix."events_detail WHERE id = %d",
                     $old_attendee_row['event_id']
                 )
             );
@@ -666,11 +666,11 @@ 
         $STS_ID       = $this->_get_reg_status_for_old_payment_status($old_attendee);
         $new_event_id =
             $this->get_migration_script()->get_mapping_new_pk(
-                $wpdb->prefix . 'events_detail',
+                $wpdb->prefix.'events_detail',
                 $old_attendee['event_id'],
                 $wpdb->posts
             );
-        if (! $new_event_id) {
+        if ( ! $new_event_id) {
             $this->add_error(
                 sprintf(
                     esc_html__(
@@ -684,7 +684,7 @@ 
         }
 
         $ticket_id = $this->_try_to_find_new_ticket_id($old_attendee, $new_event_id);
-        if (! $ticket_id) {
+        if ( ! $ticket_id) {
             $ticket_id = $this->_insert_new_ticket_because_none_found($old_attendee, $new_event_id);
             $this->add_error(
                 sprintf(
@@ -722,30 +722,30 @@ 
                 'REG_final_price'  => $old_attendee['final_price'],
                 'REG_session'      => substr($old_attendee['attendee_session'], 0, 44),
                 'REG_code'         => sanitize_key($old_attendee['registration_id']),
-                'REG_url_link'     => sanitize_key($old_attendee['registration_id'] . '-' . $count),
+                'REG_url_link'     => sanitize_key($old_attendee['registration_id'].'-'.$count),
                 'REG_count'        => $regs_on_this_event_and_txn + $count,
                 'REG_group_size'   => $this->_sum_old_attendees_on_old_txn($old_attendee),
                 'REG_att_is_going' => true,
                 'REG_deleted'      => false,
             ];
-            $data_types                 = [
-                '%d',// EVT_ID
-                '%d',// ATT_ID
-                '%d',// TXN_ID
-                '%d',// TKT_ID
-                '%s',// STS_ID
-                '%s',// REG_date
-                '%f',// REG_final_price
-                '%s',// REG_session
-                '%s',// REG_code
-                '%s',// REG_url_link
-                '%d',// REG_count
-                '%d',// REG_group_size
-                '%d',// REG_att_is_going
-                '%d',// REG_deleted
+            $data_types = [
+                '%d', // EVT_ID
+                '%d', // ATT_ID
+                '%d', // TXN_ID
+                '%d', // TKT_ID
+                '%s', // STS_ID
+                '%s', // REG_date
+                '%f', // REG_final_price
+                '%s', // REG_session
+                '%s', // REG_code
+                '%s', // REG_url_link
+                '%d', // REG_count
+                '%d', // REG_group_size
+                '%d', // REG_att_is_going
+                '%d', // REG_deleted
             ];
-            $success                    = $wpdb->insert($this->_new_reg_table, $cols_n_values, $data_types);
-            if (! $success) {
+            $success = $wpdb->insert($this->_new_reg_table, $cols_n_values, $data_types);
+            if ( ! $success) {
                 $this->add_error(
                     $this->get_migration_script()->_create_error_message_for_db_insertion(
                         $this->_old_table,
@@ -804,7 +804,7 @@ 
                     $new_ticket_id
                 )
             );
-            if (! $success_update_datetimes) {
+            if ( ! $success_update_datetimes) {
                 $this->add_error(
                     sprintf(
                         esc_html__(
@@ -862,21 +862,21 @@ 
             );
         // add all conditions to an array from which we can SHIFT conditions off in order to widen our search
         // the most important condition should be last, as it will be array_shift'ed off last
-        $conditions           = [
-            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
-            $wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price),// prices match?
-            $wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option),// names match?
-            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
+        $conditions = [
+            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime), // times match?
+            $wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price), // prices match?
+            $wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option), // names match?
+            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id), // events match?
         ];
         $select_and_join_part = "SELECT $tickets_table.TKT_ID FROM $tickets_table INNER JOIN
 			$datetime_tickets_table ON $tickets_table.TKT_ID = $datetime_tickets_table.TKT_ID INNER JOIN
 			$datetime_table ON $datetime_tickets_table.DTT_ID = $datetime_table.DTT_ID";
         // start running queries, widening search each time by removing a condition
         do {
-            $full_query      = $select_and_join_part . " WHERE " . implode(" AND ", $conditions) . " LIMIT 1";
+            $full_query      = $select_and_join_part." WHERE ".implode(" AND ", $conditions)." LIMIT 1";
             $ticket_id_found = $wpdb->get_var($full_query);
             array_shift($conditions);
-        } while (! $ticket_id_found && $conditions);
+        }while ( ! $ticket_id_found && $conditions);
         return $ticket_id_found;
     }
 
@@ -904,22 +904,22 @@ 
                 $old_attendee,
                 "$old_att_start_date $old_att_start_time:00"
             );
-        $old_att_end_datetime   = null;
+        $old_att_end_datetime = null;
 
 
         // insert new datetime unless we find one
         $datetime_id =
             $wpdb->get_var(
                 $wpdb->prepare(
-                    "SELECT DTT_ID FROM " .
-                    $this->_new_datetime_table .
+                    "SELECT DTT_ID FROM ".
+                    $this->_new_datetime_table.
                     " WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1",
                     $old_att_start_datetime,
                     $new_event_id
                 ),
                 ARRAY_A
             );
-        if (! $datetime_id) {
+        if ( ! $datetime_id) {
             $old_att_end_date     = $old_attendee['start_date'];
             $old_att_end_time     = $this->get_migration_script()->convertTimeFromAMPM(
                 $old_attendee['event_time']
@@ -938,10 +938,10 @@ 
                     'DTT_deleted'   => true,
                 ],
                 [
-                    '%d',// EVT_ID
-                    '%s',// DTT_EVT_start
-                    '%s',// DTT_EVT_end
-                    '%d',// DTT_deleted
+                    '%d', // EVT_ID
+                    '%s', // DTT_EVT_start
+                    '%s', // DTT_EVT_end
+                    '%d', // DTT_deleted
                 ]
             );
             $datetime_id = $wpdb->insert_id;
@@ -949,7 +949,7 @@ 
 
         // insert new ticket
         $wpdb->insert(
-            $wpdb->prefix . 'esp_ticket',
+            $wpdb->prefix.'esp_ticket',
             [
                 'TKT_name'       => $old_att_price_option,
                 'TKT_qty'        => -1,
@@ -960,11 +960,11 @@ 
 
             ],
             [
-                '%s',// name
-                '%d',// qty
-                '%d',// price
-                '%s',// start_date
-                '%s',// end_date
+                '%s', // name
+                '%d', // qty
+                '%d', // price
+                '%s', // start_date
+                '%s', // end_date
             ]
         );
         $ticket_id = $wpdb->insert_id;
@@ -976,8 +976,8 @@ 
                 'TKT_ID' => $ticket_id,
             ],
             [
-                '%d',// DTT_ID
-                '%d',// TKT_ID
+                '%d', // DTT_ID
+                '%d', // TKT_ID
             ]
         );
         // insert new price
@@ -990,10 +990,10 @@ 
                 'PRC_deleted' => true,
             ],
             [
-                '%d',// PRC_amount
-                '%d',// PRT_ID
-                '%s',// PRC_name
-                '%d',// PRC_deleted
+                '%d', // PRC_amount
+                '%d', // PRT_ID
+                '%s', // PRC_name
+                '%d', // PRC_deleted
             ]
         );
         $price_id = $wpdb->insert_id;
@@ -1005,8 +1005,8 @@ 
                 'PRC_ID' => $price_id,
             ],
             [
-                '%d',// TKT_ID
-                '%d',// PRC_ID
+                '%d', // TKT_ID
+                '%d', // PRC_ID
             ]
         );
         return $ticket_id;
@@ -1032,8 +1032,8 @@ 
             intval(
                 $wpdb->get_var(
                     $wpdb->prepare(
-                        "SELECT SUM(quantity) FROM " .
-                        $this->_old_table .
+                        "SELECT SUM(quantity) FROM ".
+                        $this->_old_table.
                         " WHERE registration_id=%s $count_only_older_sql",
                         $old_attendee_row['registration_id']
                     )
@@ -1058,7 +1058,7 @@ 
                         $primary_attendee['registration_id']
                     )
                 );
-            $count                 = max($count_using_mer_table, $count);
+            $count = max($count_using_mer_table, $count);
         }
         return $count;
     }
@@ -1086,7 +1086,7 @@ 
             $by_admin = $old_attendee['payment'] == 'Admin';
 
             // IE, if we don't recognize the status, assume payment failed
-            $STS_ID = $pay_status_mapping[ $old_attendee['payment_status'] ] ?? 'PFL';
+            $STS_ID = $pay_status_mapping[$old_attendee['payment_status']] ?? 'PFL';
 
             $cols_n_values = [
                 'TXN_ID'               => $new_txn_id,
@@ -1106,20 +1106,20 @@ 
                 'PAY_via_admin'        => $by_admin,
                 'PAY_details'          => $old_attendee['transaction_details'],
             ];
-            $data_types    = [
-                '%d',// TXN_Id
-                '%s',// STS_ID
-                '%s',// PAY_timestamp
-                '%s',// PAY_method
-                '%f',// PAY_amount
-                '%s',// PAY_gateway
-                '%s',// PAY_gateway_response
-                '%s',// PAY_txn_id_chq_nmbr
-                '%d',// PAY_via_admin
-                '%s',// PAY_details
+            $data_types = [
+                '%d', // TXN_Id
+                '%s', // STS_ID
+                '%s', // PAY_timestamp
+                '%s', // PAY_method
+                '%f', // PAY_amount
+                '%s', // PAY_gateway
+                '%s', // PAY_gateway_response
+                '%s', // PAY_txn_id_chq_nmbr
+                '%d', // PAY_via_admin
+                '%s', // PAY_details
             ];
-            $success       = $wpdb->insert($this->_new_payment_table, $cols_n_values, $data_types);
-            if (! $success) {
+            $success = $wpdb->insert($this->_new_payment_table, $cols_n_values, $data_types);
+            if ( ! $success) {
                 $this->add_error(
                     $this->get_migration_script()->_create_error_message_for_db_insertion(
                         $this->_old_table,
@@ -1146,7 +1146,7 @@ 
      */
     private function _find_mer_primary_attendee_using_mer_tables(int $old_registration_id): ?array
     {
-        if (! $this->_mer_tables_exist()) {
+        if ( ! $this->_mer_tables_exist()) {
             return null;
         }
         global $wpdb;

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

Indentation +817 added lines, -817 removed lines

@@ -177,825 +177,825 @@
 class EE_DMS_4_1_0_events extends EE_Data_Migration_Script_Stage
 {
 
-    private string $_old_start_end_table;
-
-    private string $_new_meta_table;
-
-    private string $_new_datetime_table;
-
-
-    /**
-     * Just initializes the status of the migration
-     */
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table           = $wpdb->prefix . "events_detail";
-        $this->_old_start_end_table = $wpdb->prefix . "events_start_end";
-        $this->_new_table           = $wpdb->prefix . "posts";
-        $this->_new_meta_table      = $wpdb->prefix . "esp_event_meta";
-        $this->_new_datetime_table  = $wpdb->prefix . "esp_datetime";
-        $this->_pretty_name         = esc_html__("Events", "event_espresso");
-        parent::__construct();
-    }
-
-
-    /**
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @return int
-     */
-    public function _count_records_to_migrate(): int
-    {
-        global $wpdb;
-        return (int) $wpdb->get_var("SELECT COUNT(*) FROM " . $this->_old_table . ' WHERE event_status !="D"');
-    }
-
-
-    /**
-     * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property
-     * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that
-     * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the
-     * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees
-     * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at
-     * very least we MUST report/return 50 items migrated)
-     *
-     * @param int $num_items_to_migrate
-     * @return int number of items ACTUALLY migrated
-     * @throws EE_Error
-     */
-    protected function _migration_step($num_items_to_migrate = 50)
-    {
-        global $wpdb;
-        // because the migration of each event can be a LOT more work, make each step smaller
-        $num_items_to_migrate     = max(1, $num_items_to_migrate / 5);
-        $events                   =
-            $wpdb->get_results(
-                $wpdb->prepare(
-                    "SELECT * FROM $this->_old_table WHERE event_status!='D' LIMIT %d,%d",
-                    $this->count_records_migrated(),
-                    $num_items_to_migrate
-                ),
-                ARRAY_A
-            );
-        $items_migrated_this_step = 0;
-
-        foreach ($events as $event_row) {
-            $guid = null;
-            // insert new 4.1 Attendee object using $wpdb
-            $post_id = $this->_insert_cpt($event_row);
-            if ($post_id) {
-                $this->get_migration_script()->set_mapping(
-                    $this->_old_table,
-                    $event_row['id'],
-                    $this->_new_table,
-                    $post_id
-                );
-                $meta_id = $this->_insert_event_meta($event_row, $post_id);
-                if ($meta_id) {
-                    $this->get_migration_script()->set_mapping(
-                        $this->_old_table,
-                        $event_row['id'],
-                        $this->_new_meta_table,
-                        $meta_id
-                    );
-                }
-                $this->_convert_start_end_times($event_row, $post_id);
-                $event_meta = maybe_unserialize($event_row['event_meta']);
-                $guid       = $event_meta['event_thumbnail_url'] ?? null;
-                if ($guid) {
-                    $this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post(
-                        $guid,
-                        $post_id,
-                        $this
-                    );
-                }
-                // maybe create a venue from info on the event?
-                $new_venue_id = $this->_maybe_create_venue($event_row);
-                if ($new_venue_id) {
-                    $this->_insert_new_venue_to_event($post_id, $new_venue_id);
-                }
-                $this->_add_post_metas($event_row, $post_id);
-            }
-            $items_migrated_this_step++;
-            if ($guid) {
-                // if we had to check for an image attachment
-                // then let's call it a day (avoid timing out, because this took a long time)
-                break;
-            }
-        }
-        if ($this->count_records_migrated() + $items_migrated_this_step >= $this->count_records_to_migrate()) {
-            $this->set_status(EE_Data_Migration_Manager::status_completed);
-        }
-        return $items_migrated_this_step;
-    }
-
-
-    /**
-     * Stores any extra 3.1 "event_meta" column things as post meta
-     *
-     * @param array $old_event
-     * @param int   $post_id
-     * @return void
-     */
-    private function _add_post_metas(array $old_event, int $post_id)
-    {
-        $event_meta = maybe_unserialize($old_event['event_meta']);
-        if (! $event_meta || ! is_array($event_meta)) {
-            return;
-        }
-        unset($event_meta['date_submitted']);              // factored into CPT
-        unset($event_meta['additional_attendee_reg_info']);// factored into event meta table
-        unset($event_meta['default_payment_status']);      // dido
-        unset($event_meta['event_thumbnail_url']);         // used to find post featured image
-        foreach ($event_meta as $meta_key => $meta_value) {
-            if ($meta_key) {// if the meta key is just an empty string, ignore it
-                $success = add_post_meta($post_id, $meta_key, $meta_value, true);
-                if (! $success) {
-                    $this->add_error(
-                        sprintf(
-                            esc_html__(
-                                "Could not add post meta for CPT with ID #%d. Meta key: '%s',meta value:'%d' for 3.1 event: %s",
-                                "event_espresso"
-                            ),
-                            $post_id,
-                            $meta_key,
-                            $meta_value,
-                            implode(",", $old_event)
-                        )
-                    );
-                }
-            }
-        }
-        if ($old_event['alt_email']) {
-            add_post_meta($post_id, 'alt_email', $old_event['alt_email']);
-        }
-        if ($old_event['recurrence_id']) {
-            add_post_meta($post_id, 'recurrence_id', $old_event['recurrence_id']);
-        }
-    }
-
-
-    /**
-     * Finds a unique slug for this event, given its name (we could have simply used
-     * the old unique_identifier column, but it added a long string of seemingly random characters onto the end
-     * and really wasn't that pretty for a slug, so we decided we'd make our own slug again)
-     *
-     * @param string $event_name      (the name of the event for reading by humans)
-     * @param string $old_identifier  the old EE3 identifier (a long unique string)
-     * @param string $new_post_status a post status
-     * @return string
-     */
-    private function _find_unique_slug(
-        string $event_name,
-        string $old_identifier = '',
-        string $new_post_status = 'publish'
-    ): string {
-        $original_name = $event_name ? sanitize_title($event_name) : $old_identifier;
-        return wp_unique_post_slug($original_name, 0, $new_post_status, EspressoPostType::EVENTS, 0);
-    }
-
-
-    /**
-     * returns whether there is a post that has this same slug (post_title)
-     *
-     * @param string $slug
-     * @return boolean
-     * @global wpdb  $wpdb
-     */
-    private function _other_post_exists_with_that_slug(string $slug): bool
-    {
-        global $wpdb;
-        $query =
-            $wpdb->prepare(
-                "SELECT COUNT(ID) FROM $this->_new_table WHERE event_status != 'D' AND post_name = %s",
-                $slug
-            );
-        $count = $wpdb->get_var($query);
-        return (bool) intval($count);
-    }
-
-
-    /**
-     * @param $old_event
-     * @return int
-     */
-    private function _insert_cpt($old_event): int
-    {
-        global $wpdb;
-        // convert 3.1 event status to 4.1 CPT status
-        // for reference, 3.1 event stati available for setting are:
-        //      $status = array(array('id' => 'A', 'text' => esc_html__('Public', 'event_espresso')), array('id' => 'S', 'text' => esc_html__('Waitlist', 'event_espresso')), array('id' => 'O', 'text' => esc_html__('Ongoing', 'event_espresso')), array('id' => 'R', 'text' => esc_html__('Draft', 'event_espresso')), array('id' => 'D', 'text' => esc_html__('Deleted', 'event_espresso')));
-        //      and the json api uses the following to convert from 3.1 to 4.0
-        //      'S'=>'secondary/waitlist',
-        //      'A'=>'active',
-        //      'X'=>'denied',
-        //      'IA'=>'inactive',
-        //      'O'=>'ongoing',
-        //      'P'=>'pending',
-        //      'R'=>'draft',
-        //      'D'=>'deleted');
-        //      4.1 Event Post stati are the normal post statis
-        //      (publish,future,draft,pending,private,trash,auto-draft,inherit)
-        //      and 3 custom ones: cancelled,postponed,sold_out
-        $status_conversions = [
-            'R'  => 'draft',
-            'X'  => 'draft',
-            // 4.1 doesn't have a "not approved for publishing" status. this is what posts are set to that aren't approved
-            'P'  => 'pending',
-            'IA' => 'draft',
-            // draft and in the past
-            // IA=inactive in 3.1: events were switched to this when they expired. in 4.1 that's just calculated
-            'O'  => 'publish',
-            // @todo: will be an event type later; if this is the status, set the end date WAAAY later; and add term for 'ongoing'
-            'A'  => 'publish',
-            'S'  => 'draft',
-            // @todo: is it ok to just mark secondary/waitlist events as DRAFTS?
-            'D'  => 'trash',
-        ];
-        $post_status        = $status_conversions[ $old_event['event_status'] ];
-        // check if we've sold out
-        if (intval($old_event['reg_limit']) <= self::count_registrations($old_event['id'])) {
-            $post_status = 'sold_out';
-        }
-        //      FYI postponed and cancelled don't exist in 3.1
-        $cols_n_values                      = [
-            'post_title'        => stripslashes($old_event['event_name']),// EVT_name
-            'post_content'      => stripslashes($old_event['event_desc']),// EVT_desc
-            'post_name'         => $this->_find_unique_slug(
-                $old_event['event_name'],
-                $old_event['event_identifier'],
-                $post_status
-            ),// EVT_slug
-            'post_date'         => $old_event['submitted'],// EVT_created NOT
-            'post_date_gmt'     => get_gmt_from_date($old_event['submitted']),
-            'post_excerpt'      => '',// EVT_short_desc
-            'post_modified'     => $old_event['submitted'],// EVT_modified
-            'post_modified_gmt' => get_gmt_from_date($old_event['submitted']),
-            'post_author'       => $old_event['wp_user'],// EVT_wp_user
-            'post_parent'       => 0,// parent maybe get this from some REM field?
-            'menu_order'        => 0,// EVT_order
-            'post_type'         => EspressoPostType::EVENTS,// post_type
-            'post_status'       => $post_status,// status
-        ];
-        $cols_n_values_with_no_invalid_text = [];
-        foreach ($cols_n_values as $col => $value) {
-            $value_sans_invalid_chars = $wpdb->strip_invalid_text_for_column($this->_new_table, $col, $value);
-            if (! is_wp_error($value_sans_invalid_chars)) {
-                $cols_n_values_with_no_invalid_text[ $col ] = $value_sans_invalid_chars;
-            } else {
-                // otherwise leave it as-is. It will blow everything up and stop the migration
-                $cols_n_values_with_no_invalid_text[ $col ] = $value;
-            }
-        }
-        $cols_n_values = $cols_n_values_with_no_invalid_text;
-        $data_types    = [
-            '%s',// EVT_name
-            '%s',// EVT_desc
-            '%s',// EVT_slug
-            '%s',// EVT_created
-            '%s',
-            '%s',// EVT_short_desc
-            '%s',// EVT_modified
-            '%s',
-            '%s',// EVT_wp_user
-            '%d',// post_parent
-            '%d',// EVT_order
-            '%s',// post_type
-            '%s',// status
-        ];
-        $success       = $wpdb->insert(
-            $this->_new_table,
-            $cols_n_values,
-            $data_types
-        );
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_table,
-                    $old_event,
-                    $this->_new_table,
-                    $cols_n_values,
-                    $data_types
-                )
-            );
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-
-    /**
-     * Counts all the registrations for the event in the 3.1 DB. (takes into account attendee rows which represent
-     * various registrations)
-     *
-     * @param int   $event_id
-     * @return int
-     * @global wpdb $wpdb
-     */
-    public static function count_registrations(int $event_id): int
-    {
-        global $wpdb;
-        return (int) $wpdb->get_var(
-            $wpdb->prepare("SELECT sum(quantity) FROM {$wpdb->prefix}events_attendee WHERE event_id=%d", $event_id)
-        );
-    }
-
-
-    /**
-     * @param $old_event
-     * @param $new_cpt_id
-     * @return int
-     */
-    private function _insert_event_meta($old_event, $new_cpt_id): int
-    {
-        global $wpdb;
-        $event_meta = maybe_unserialize($old_event['event_meta']);
-        //      for reference, 3.1 'default_payment_status' are: $default_payment_status = array(
-        //  array('id' => "", 'text' => 'No Change'),
-        //  array('id' => 'Incomplete', 'text' => 'Incomplete'),
-        //  array('id' => 'Pending', 'text' => 'Pending'),
-        //  //array('id' => 'Completed', 'text' => 'Completed')
-        // );
-        $default_reg_status =
-            $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(
-                $event_meta['default_payment_status'] ?? '',
-                intval($old_event['require_pre_approval'])
-            );
-        $cols_n_values      = [
-            'EVT_ID'                          => $new_cpt_id,// EVT_ID_fk
-            'EVT_display_desc'                => 'Y' == $old_event['display_desc'],
-            'EVT_display_ticket_selector'     => 'Y' == $old_event['display_reg_form'],
-            'EVT_visible_on'                  => $this->get_migration_script()->convert_date_string_to_utc(
-                $this,
-                $old_event,
-                current_time(
-                    'mysql'
-                ),
-                $old_event['timezone_string']
-            ),// don't use the old 'visible_on', as it wasn't ever used
-            'EVT_additional_limit'            => $old_event['allow_multiple'] == 'N' ? 1
-                : $old_event['additional_limit'],
-            'EVT_default_registration_status' => $default_reg_status,
-            'EVT_member_only'                 => $old_event['member_only'],
-            'EVT_phone'                       => $old_event['phone'],
-            'EVT_allow_overflow'              => 'Y' == $old_event['allow_overflow'],
-            'EVT_timezone_string'             => $old_event['timezone_string'],
-            'EVT_external_URL'                => $old_event['externalURL'],
-            'EVT_donations'                   => false,// doesn't exist in 3.1
-
-        ];
-        $data_types         = [
-            '%s',// EVT_ID
-            '%d',// EVT_display_desc
-            '%d',// EVT_display_ticket_selector
-            '%s',// EVT_visible_on
-            '%d',// EVT_additional_limit
-            '%s',// EVT_default_registration_status
-            '%d',// EVT_member_only
-            '%s',// EVT_phone
-            '%d',// EVT_allow_overflow
-            '%s',// EVT_timezone_string
-            '%s',// EVT_external_URL
-            '%d',// EVT_donations
-        ];
-        $success            = $wpdb->insert(
-            $this->_new_meta_table,
-            $cols_n_values,
-            $data_types
-        );
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_table,
-                    $old_event,
-                    $this->_new_meta_table,
-                    $cols_n_values,
-                    $data_types
-                )
-            );
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-
-    /**
-     * @param $old_event
-     * @return int
-     */
-    private function _maybe_create_venue($old_event): int
-    {
-        if (
-            $old_event['address'] ||
-            $old_event['address2'] ||
-            $old_event['city'] ||
-            $old_event['state'] ||
-            $old_event['zip'] ||
-            $old_event['venue_title'] ||
-            $old_event['venue_url'] ||
-            $old_event['venue_image'] ||
-            $old_event['venue_phone'] ||
-            $old_event['virtual_url'] ||
-            $old_event['virtual_phone']
-        ) {
-            $old_id = $this->_duplicate_venue_exists($old_event);
-            if ($old_id) {
-                return $old_id;
-            }
-            $new_id = $this->_insert_venue_into_posts($old_event);
-            if ($new_id) {
-                $this->_insert_venue_into_meta_table($new_id, $old_event);
-                $guid = $old_event['venue_image'] ?? null;
-                if($guid) {
-                    $this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post(
-                        $guid,
-                        $new_id,
-                        $this
-                    );
-                }
-            }
-            // we don't bother recording the conversion from old events to venues as that
-            // will complicate finding the conversion from old venues to new events
-            return $new_id;
-        }
-        return 0;
-    }
-
-
-    /**
-     * Assuming there is venue data on this event, check if there is a duplicate venue already in the system for it.
-     * If so, return it. Otherwise, return NULL.
-     *
-     * @param array $old_event
-     * @return int duplicate venue id
-     */
-    private function _duplicate_venue_exists(array $old_event): int
-    {
-        global $wpdb;
-        $conditions     = [
-            'VNU_address'       => $old_event ['address'],
-            'VNU_address2'      => $old_event['address2'],
-            'VNU_city'          => $old_event['city'],
-            'VNU_zip'           => $old_event['zip'],
-            'post_title'        => $this->_get_venue_title_for_event($old_event),
-            'VNU_phone'         => $old_event['venue_phone'],// VNU_phone
-            'VNU_url'           => $old_event['venue_url'],// VNU_url
-            'VNU_virtual_phone' => $old_event['virtual_phone'],// VNU_virtual_phone
-            'VNU_virtual_url'   => $old_event['virtual_url'],// VNU_virtual_url
-        ];
-        $sql_conditions = [];
-        foreach ($conditions as $column => $value) {
-            $sql_conditions [] = $wpdb->prepare("$column = %s", $value);
-        }
-        $query = "SELECT VNU_ID
+	private string $_old_start_end_table;
+
+	private string $_new_meta_table;
+
+	private string $_new_datetime_table;
+
+
+	/**
+	 * Just initializes the status of the migration
+	 */
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table           = $wpdb->prefix . "events_detail";
+		$this->_old_start_end_table = $wpdb->prefix . "events_start_end";
+		$this->_new_table           = $wpdb->prefix . "posts";
+		$this->_new_meta_table      = $wpdb->prefix . "esp_event_meta";
+		$this->_new_datetime_table  = $wpdb->prefix . "esp_datetime";
+		$this->_pretty_name         = esc_html__("Events", "event_espresso");
+		parent::__construct();
+	}
+
+
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @return int
+	 */
+	public function _count_records_to_migrate(): int
+	{
+		global $wpdb;
+		return (int) $wpdb->get_var("SELECT COUNT(*) FROM " . $this->_old_table . ' WHERE event_status !="D"');
+	}
+
+
+	/**
+	 * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property
+	 * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that
+	 * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the
+	 * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees
+	 * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at
+	 * very least we MUST report/return 50 items migrated)
+	 *
+	 * @param int $num_items_to_migrate
+	 * @return int number of items ACTUALLY migrated
+	 * @throws EE_Error
+	 */
+	protected function _migration_step($num_items_to_migrate = 50)
+	{
+		global $wpdb;
+		// because the migration of each event can be a LOT more work, make each step smaller
+		$num_items_to_migrate     = max(1, $num_items_to_migrate / 5);
+		$events                   =
+			$wpdb->get_results(
+				$wpdb->prepare(
+					"SELECT * FROM $this->_old_table WHERE event_status!='D' LIMIT %d,%d",
+					$this->count_records_migrated(),
+					$num_items_to_migrate
+				),
+				ARRAY_A
+			);
+		$items_migrated_this_step = 0;
+
+		foreach ($events as $event_row) {
+			$guid = null;
+			// insert new 4.1 Attendee object using $wpdb
+			$post_id = $this->_insert_cpt($event_row);
+			if ($post_id) {
+				$this->get_migration_script()->set_mapping(
+					$this->_old_table,
+					$event_row['id'],
+					$this->_new_table,
+					$post_id
+				);
+				$meta_id = $this->_insert_event_meta($event_row, $post_id);
+				if ($meta_id) {
+					$this->get_migration_script()->set_mapping(
+						$this->_old_table,
+						$event_row['id'],
+						$this->_new_meta_table,
+						$meta_id
+					);
+				}
+				$this->_convert_start_end_times($event_row, $post_id);
+				$event_meta = maybe_unserialize($event_row['event_meta']);
+				$guid       = $event_meta['event_thumbnail_url'] ?? null;
+				if ($guid) {
+					$this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post(
+						$guid,
+						$post_id,
+						$this
+					);
+				}
+				// maybe create a venue from info on the event?
+				$new_venue_id = $this->_maybe_create_venue($event_row);
+				if ($new_venue_id) {
+					$this->_insert_new_venue_to_event($post_id, $new_venue_id);
+				}
+				$this->_add_post_metas($event_row, $post_id);
+			}
+			$items_migrated_this_step++;
+			if ($guid) {
+				// if we had to check for an image attachment
+				// then let's call it a day (avoid timing out, because this took a long time)
+				break;
+			}
+		}
+		if ($this->count_records_migrated() + $items_migrated_this_step >= $this->count_records_to_migrate()) {
+			$this->set_status(EE_Data_Migration_Manager::status_completed);
+		}
+		return $items_migrated_this_step;
+	}
+
+
+	/**
+	 * Stores any extra 3.1 "event_meta" column things as post meta
+	 *
+	 * @param array $old_event
+	 * @param int   $post_id
+	 * @return void
+	 */
+	private function _add_post_metas(array $old_event, int $post_id)
+	{
+		$event_meta = maybe_unserialize($old_event['event_meta']);
+		if (! $event_meta || ! is_array($event_meta)) {
+			return;
+		}
+		unset($event_meta['date_submitted']);              // factored into CPT
+		unset($event_meta['additional_attendee_reg_info']);// factored into event meta table
+		unset($event_meta['default_payment_status']);      // dido
+		unset($event_meta['event_thumbnail_url']);         // used to find post featured image
+		foreach ($event_meta as $meta_key => $meta_value) {
+			if ($meta_key) {// if the meta key is just an empty string, ignore it
+				$success = add_post_meta($post_id, $meta_key, $meta_value, true);
+				if (! $success) {
+					$this->add_error(
+						sprintf(
+							esc_html__(
+								"Could not add post meta for CPT with ID #%d. Meta key: '%s',meta value:'%d' for 3.1 event: %s",
+								"event_espresso"
+							),
+							$post_id,
+							$meta_key,
+							$meta_value,
+							implode(",", $old_event)
+						)
+					);
+				}
+			}
+		}
+		if ($old_event['alt_email']) {
+			add_post_meta($post_id, 'alt_email', $old_event['alt_email']);
+		}
+		if ($old_event['recurrence_id']) {
+			add_post_meta($post_id, 'recurrence_id', $old_event['recurrence_id']);
+		}
+	}
+
+
+	/**
+	 * Finds a unique slug for this event, given its name (we could have simply used
+	 * the old unique_identifier column, but it added a long string of seemingly random characters onto the end
+	 * and really wasn't that pretty for a slug, so we decided we'd make our own slug again)
+	 *
+	 * @param string $event_name      (the name of the event for reading by humans)
+	 * @param string $old_identifier  the old EE3 identifier (a long unique string)
+	 * @param string $new_post_status a post status
+	 * @return string
+	 */
+	private function _find_unique_slug(
+		string $event_name,
+		string $old_identifier = '',
+		string $new_post_status = 'publish'
+	): string {
+		$original_name = $event_name ? sanitize_title($event_name) : $old_identifier;
+		return wp_unique_post_slug($original_name, 0, $new_post_status, EspressoPostType::EVENTS, 0);
+	}
+
+
+	/**
+	 * returns whether there is a post that has this same slug (post_title)
+	 *
+	 * @param string $slug
+	 * @return boolean
+	 * @global wpdb  $wpdb
+	 */
+	private function _other_post_exists_with_that_slug(string $slug): bool
+	{
+		global $wpdb;
+		$query =
+			$wpdb->prepare(
+				"SELECT COUNT(ID) FROM $this->_new_table WHERE event_status != 'D' AND post_name = %s",
+				$slug
+			);
+		$count = $wpdb->get_var($query);
+		return (bool) intval($count);
+	}
+
+
+	/**
+	 * @param $old_event
+	 * @return int
+	 */
+	private function _insert_cpt($old_event): int
+	{
+		global $wpdb;
+		// convert 3.1 event status to 4.1 CPT status
+		// for reference, 3.1 event stati available for setting are:
+		//      $status = array(array('id' => 'A', 'text' => esc_html__('Public', 'event_espresso')), array('id' => 'S', 'text' => esc_html__('Waitlist', 'event_espresso')), array('id' => 'O', 'text' => esc_html__('Ongoing', 'event_espresso')), array('id' => 'R', 'text' => esc_html__('Draft', 'event_espresso')), array('id' => 'D', 'text' => esc_html__('Deleted', 'event_espresso')));
+		//      and the json api uses the following to convert from 3.1 to 4.0
+		//      'S'=>'secondary/waitlist',
+		//      'A'=>'active',
+		//      'X'=>'denied',
+		//      'IA'=>'inactive',
+		//      'O'=>'ongoing',
+		//      'P'=>'pending',
+		//      'R'=>'draft',
+		//      'D'=>'deleted');
+		//      4.1 Event Post stati are the normal post statis
+		//      (publish,future,draft,pending,private,trash,auto-draft,inherit)
+		//      and 3 custom ones: cancelled,postponed,sold_out
+		$status_conversions = [
+			'R'  => 'draft',
+			'X'  => 'draft',
+			// 4.1 doesn't have a "not approved for publishing" status. this is what posts are set to that aren't approved
+			'P'  => 'pending',
+			'IA' => 'draft',
+			// draft and in the past
+			// IA=inactive in 3.1: events were switched to this when they expired. in 4.1 that's just calculated
+			'O'  => 'publish',
+			// @todo: will be an event type later; if this is the status, set the end date WAAAY later; and add term for 'ongoing'
+			'A'  => 'publish',
+			'S'  => 'draft',
+			// @todo: is it ok to just mark secondary/waitlist events as DRAFTS?
+			'D'  => 'trash',
+		];
+		$post_status        = $status_conversions[ $old_event['event_status'] ];
+		// check if we've sold out
+		if (intval($old_event['reg_limit']) <= self::count_registrations($old_event['id'])) {
+			$post_status = 'sold_out';
+		}
+		//      FYI postponed and cancelled don't exist in 3.1
+		$cols_n_values                      = [
+			'post_title'        => stripslashes($old_event['event_name']),// EVT_name
+			'post_content'      => stripslashes($old_event['event_desc']),// EVT_desc
+			'post_name'         => $this->_find_unique_slug(
+				$old_event['event_name'],
+				$old_event['event_identifier'],
+				$post_status
+			),// EVT_slug
+			'post_date'         => $old_event['submitted'],// EVT_created NOT
+			'post_date_gmt'     => get_gmt_from_date($old_event['submitted']),
+			'post_excerpt'      => '',// EVT_short_desc
+			'post_modified'     => $old_event['submitted'],// EVT_modified
+			'post_modified_gmt' => get_gmt_from_date($old_event['submitted']),
+			'post_author'       => $old_event['wp_user'],// EVT_wp_user
+			'post_parent'       => 0,// parent maybe get this from some REM field?
+			'menu_order'        => 0,// EVT_order
+			'post_type'         => EspressoPostType::EVENTS,// post_type
+			'post_status'       => $post_status,// status
+		];
+		$cols_n_values_with_no_invalid_text = [];
+		foreach ($cols_n_values as $col => $value) {
+			$value_sans_invalid_chars = $wpdb->strip_invalid_text_for_column($this->_new_table, $col, $value);
+			if (! is_wp_error($value_sans_invalid_chars)) {
+				$cols_n_values_with_no_invalid_text[ $col ] = $value_sans_invalid_chars;
+			} else {
+				// otherwise leave it as-is. It will blow everything up and stop the migration
+				$cols_n_values_with_no_invalid_text[ $col ] = $value;
+			}
+		}
+		$cols_n_values = $cols_n_values_with_no_invalid_text;
+		$data_types    = [
+			'%s',// EVT_name
+			'%s',// EVT_desc
+			'%s',// EVT_slug
+			'%s',// EVT_created
+			'%s',
+			'%s',// EVT_short_desc
+			'%s',// EVT_modified
+			'%s',
+			'%s',// EVT_wp_user
+			'%d',// post_parent
+			'%d',// EVT_order
+			'%s',// post_type
+			'%s',// status
+		];
+		$success       = $wpdb->insert(
+			$this->_new_table,
+			$cols_n_values,
+			$data_types
+		);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_table,
+					$old_event,
+					$this->_new_table,
+					$cols_n_values,
+					$data_types
+				)
+			);
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+
+	/**
+	 * Counts all the registrations for the event in the 3.1 DB. (takes into account attendee rows which represent
+	 * various registrations)
+	 *
+	 * @param int   $event_id
+	 * @return int
+	 * @global wpdb $wpdb
+	 */
+	public static function count_registrations(int $event_id): int
+	{
+		global $wpdb;
+		return (int) $wpdb->get_var(
+			$wpdb->prepare("SELECT sum(quantity) FROM {$wpdb->prefix}events_attendee WHERE event_id=%d", $event_id)
+		);
+	}
+
+
+	/**
+	 * @param $old_event
+	 * @param $new_cpt_id
+	 * @return int
+	 */
+	private function _insert_event_meta($old_event, $new_cpt_id): int
+	{
+		global $wpdb;
+		$event_meta = maybe_unserialize($old_event['event_meta']);
+		//      for reference, 3.1 'default_payment_status' are: $default_payment_status = array(
+		//  array('id' => "", 'text' => 'No Change'),
+		//  array('id' => 'Incomplete', 'text' => 'Incomplete'),
+		//  array('id' => 'Pending', 'text' => 'Pending'),
+		//  //array('id' => 'Completed', 'text' => 'Completed')
+		// );
+		$default_reg_status =
+			$this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(
+				$event_meta['default_payment_status'] ?? '',
+				intval($old_event['require_pre_approval'])
+			);
+		$cols_n_values      = [
+			'EVT_ID'                          => $new_cpt_id,// EVT_ID_fk
+			'EVT_display_desc'                => 'Y' == $old_event['display_desc'],
+			'EVT_display_ticket_selector'     => 'Y' == $old_event['display_reg_form'],
+			'EVT_visible_on'                  => $this->get_migration_script()->convert_date_string_to_utc(
+				$this,
+				$old_event,
+				current_time(
+					'mysql'
+				),
+				$old_event['timezone_string']
+			),// don't use the old 'visible_on', as it wasn't ever used
+			'EVT_additional_limit'            => $old_event['allow_multiple'] == 'N' ? 1
+				: $old_event['additional_limit'],
+			'EVT_default_registration_status' => $default_reg_status,
+			'EVT_member_only'                 => $old_event['member_only'],
+			'EVT_phone'                       => $old_event['phone'],
+			'EVT_allow_overflow'              => 'Y' == $old_event['allow_overflow'],
+			'EVT_timezone_string'             => $old_event['timezone_string'],
+			'EVT_external_URL'                => $old_event['externalURL'],
+			'EVT_donations'                   => false,// doesn't exist in 3.1
+
+		];
+		$data_types         = [
+			'%s',// EVT_ID
+			'%d',// EVT_display_desc
+			'%d',// EVT_display_ticket_selector
+			'%s',// EVT_visible_on
+			'%d',// EVT_additional_limit
+			'%s',// EVT_default_registration_status
+			'%d',// EVT_member_only
+			'%s',// EVT_phone
+			'%d',// EVT_allow_overflow
+			'%s',// EVT_timezone_string
+			'%s',// EVT_external_URL
+			'%d',// EVT_donations
+		];
+		$success            = $wpdb->insert(
+			$this->_new_meta_table,
+			$cols_n_values,
+			$data_types
+		);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_table,
+					$old_event,
+					$this->_new_meta_table,
+					$cols_n_values,
+					$data_types
+				)
+			);
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+
+	/**
+	 * @param $old_event
+	 * @return int
+	 */
+	private function _maybe_create_venue($old_event): int
+	{
+		if (
+			$old_event['address'] ||
+			$old_event['address2'] ||
+			$old_event['city'] ||
+			$old_event['state'] ||
+			$old_event['zip'] ||
+			$old_event['venue_title'] ||
+			$old_event['venue_url'] ||
+			$old_event['venue_image'] ||
+			$old_event['venue_phone'] ||
+			$old_event['virtual_url'] ||
+			$old_event['virtual_phone']
+		) {
+			$old_id = $this->_duplicate_venue_exists($old_event);
+			if ($old_id) {
+				return $old_id;
+			}
+			$new_id = $this->_insert_venue_into_posts($old_event);
+			if ($new_id) {
+				$this->_insert_venue_into_meta_table($new_id, $old_event);
+				$guid = $old_event['venue_image'] ?? null;
+				if($guid) {
+					$this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post(
+						$guid,
+						$new_id,
+						$this
+					);
+				}
+			}
+			// we don't bother recording the conversion from old events to venues as that
+			// will complicate finding the conversion from old venues to new events
+			return $new_id;
+		}
+		return 0;
+	}
+
+
+	/**
+	 * Assuming there is venue data on this event, check if there is a duplicate venue already in the system for it.
+	 * If so, return it. Otherwise, return NULL.
+	 *
+	 * @param array $old_event
+	 * @return int duplicate venue id
+	 */
+	private function _duplicate_venue_exists(array $old_event): int
+	{
+		global $wpdb;
+		$conditions     = [
+			'VNU_address'       => $old_event ['address'],
+			'VNU_address2'      => $old_event['address2'],
+			'VNU_city'          => $old_event['city'],
+			'VNU_zip'           => $old_event['zip'],
+			'post_title'        => $this->_get_venue_title_for_event($old_event),
+			'VNU_phone'         => $old_event['venue_phone'],// VNU_phone
+			'VNU_url'           => $old_event['venue_url'],// VNU_url
+			'VNU_virtual_phone' => $old_event['virtual_phone'],// VNU_virtual_phone
+			'VNU_virtual_url'   => $old_event['virtual_url'],// VNU_virtual_url
+		];
+		$sql_conditions = [];
+		foreach ($conditions as $column => $value) {
+			$sql_conditions [] = $wpdb->prepare("$column = %s", $value);
+		}
+		$query = "SELECT VNU_ID
 					FROM
 		$wpdb->posts as p INNER JOIN
 		{$wpdb->prefix}esp_venue_meta as v ON p.ID = v.VNU_ID
 			WHERE " . implode(" AND ", $sql_conditions) . " LIMIT 1";
-        return (int) $wpdb->get_var($query);
-    }
-
-
-    /**
-     * Gets teh venue's title or makes one up if there is none
-     *
-     * @param array $event_data_array keys are events_details columns and values are their values
-     * @return string
-     */
-    protected function _get_venue_title_for_event(array $event_data_array): string
-    {
-        return $event_data_array['venue_title']
-            ? stripslashes($event_data_array['venue_title'])
-            : stripslashes(
-                sprintf(
-                    esc_html__('Venue of %s', 'event_espresso'),
-                    $event_data_array['event_name']
-                )
-            );
-    }
-
-
-    /**
-     * Inserts the CPT
-     *
-     * @param array $old_event keys are cols, values are col values
-     * @return int
-     */
-    private function _insert_venue_into_posts(array $old_event): int
-    {
-        global $wpdb;
-        $insertion_array  = [
-            'post_title'        => $this->_get_venue_title_for_event($old_event),// VNU_name
-            'post_content'      => '',// VNU_desc
-            'post_name'         => $this->_find_unique_slug(
-                $old_event['venue_title'],
-                sanitize_title('venue-of-' . $old_event['event_name'])
-            ),// VNU_identifier
-            'post_date'         => current_time('mysql'),// VNU_created
-            'post_date_gmt'     => get_gmt_from_date(current_time('mysql')),
-            'post_excerpt'      => '',// VNU_short_desc arbitrary only 50 characters
-            'post_modified'     => current_time('mysql'),// VNU_modified
-            'post_modified_gmt' => get_gmt_from_date(current_time('mysql')),
-            'post_author'       => $old_event['wp_user'],// VNU_wp_user
-            'post_parent'       => 0,// parent
-            'menu_order'        => 0,// VNU_order
-            'post_type'         => EspressoPostType::VENUES,// post_type
-        ];
-        $data_types_array = [
-            '%s',// VNU_name
-            '%s',// VNU_desc
-            '%s',// VNU_identifier
-            '%s',// VNU_created
-            '%s',
-            '%s',// VNU_short_desc
-            '%s',// VNU_modified
-            '%s',
-            '%d',// VNU_wp_user
-            '%d',// parent
-            '%d',// VNU_order
-            '%s',// post_type
-        ];
-        $success          = $wpdb->insert(
-            $wpdb->posts,
-            $insertion_array,
-            $data_types_array
-        );
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_table,
-                    $old_event,
-                    $this->_new_table,
-                    $insertion_array,
-                    $data_types_array
-                )
-            );
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-
-    /**
-     * Inserts into the venue_meta table
-     *
-     * @param int   $cpt_id
-     * @param array $old_event
-     * @return void
-     */
-    private function _insert_venue_into_meta_table(int $cpt_id, array $old_event): void
-    {
-        global $wpdb;
-
-        // assume the country is the same as the organization's old settings
-        $country_iso = $this->get_migration_script()->get_default_country_iso();
-        // find the state from the venue, or the organization, or just guess california
-        if (! $old_event['state']) {
-            $old_org_options = get_option('events_organization_settings');
-            $state_name      = stripslashes($old_org_options['organization_state']);
-        } else {
-            $state_name = $old_event['state'];
-        }
-        if (! $state_name) {
-            $state_name = 'CA';
-        }
-        // get a state ID with the same name, if possible
-        try {
-            $state    = $this->get_migration_script()->get_or_create_state($state_name, $country_iso);
-            $state_id = $state['STA_ID'];
-        } catch (EE_Error $e) {
-            $this->add_error($e->getMessage());
-            $state_id = 0;
-        }
-        // now insert into meta table
-        $insertion_array = [
-            'VNU_ID'              => $cpt_id,// VNU_ID_fk
-            'VNU_address'         => stripslashes($old_event['address']),// VNU_address
-            'VNU_address2'        => stripslashes($old_event['address2']),// VNU_address2
-            'VNU_city'            => stripslashes($old_event['city']),// VNU_city
-            'STA_ID'              => $state_id,// STA_ID
-            'CNT_ISO'             => $country_iso,// CNT_ISO
-            'VNU_zip'             => $old_event['zip'],// VNU_zip
-            'VNU_phone'           => $old_event['venue_phone'],// VNU_phone
-            'VNU_capacity'        => -1,// VNU_capacity
-            'VNU_url'             => $old_event['venue_url'],// VNU_url
-            'VNU_virtual_phone'   => $old_event['virtual_phone'],// VNU_virtual_phone
-            'VNU_virtual_url'     => $old_event['virtual_url'],// VNU_virtual_url
-            'VNU_google_map_link' => '',// VNU_google_map_link
-            'VNU_enable_for_gmap' => true, // VNU_enable_for_gmap
-        ];
-        $data_types      = [
-            '%d',// VNU_ID_fk
-            '%s',// VNU_address
-            '%s',// VNU_address2
-            '%s',// VNU_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// VNU_zip
-            '%s',// VNU_phone
-            '%d',// VNU_capacity
-            '%s',// VNU_url
-            '%s',// VNU_virtual_phone
-            '%s',// VNU_virtual_url
-            '%s',// VNU_google_map_link
-            '%d',// VNU_enable_for_gmap
-        ];
-        $success         = $wpdb->insert($wpdb->prefix . "esp_venue_meta", $insertion_array, $data_types);
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_table,
-                    $old_event,
-                    $this->_new_meta_table,
-                    $insertion_array,
-                    $data_types
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param $new_event_id
-     * @param $new_venue_id
-     * @return void
-     */
-    private function _insert_new_venue_to_event($new_event_id, $new_venue_id): void
-    {
-        global $wpdb;
-        if (! $new_event_id) {
-            $this->add_error(
-                sprintf(esc_html__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $new_event_id)
-            );
-            return;
-        }
-        if (! $new_venue_id) {
-            $this->add_error(
-                sprintf(esc_html__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $new_venue_id)
-            );
-            return;
-        }
-        $cols_n_values = [
-            'EVT_ID'      => $new_event_id,
-            'VNU_ID'      => $new_venue_id,
-            'EVV_primary' => true,
-        ];
-        $data_types    = [
-            '%d',// EVT_ID
-            '%d',// VNU_ID
-            '%d',// EVT_primary
-        ];
-        $success       = $wpdb->insert($wpdb->prefix . "esp_event_venue", $cols_n_values, $data_types);
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_table,
-                    [],
-                    $this->_new_table,
-                    $cols_n_values,
-                    $data_types
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Converts all the 3.1 start-end times for the event to 4.1 datetimes
-     *
-     * @param array $old_event  results of get_results(...,ARRAY_A)
-     * @param int   $new_cpt_id new post ID
-     * @return void (if there are errors though, adds them to the stage's error list
-     * @throws EE_Error
-     * @global wpdb $wpdb
-     */
-    private function _convert_start_end_times(array $old_event, int $new_cpt_id)
-    {
-        $start_end_times = $this->_get_old_start_end_times($old_event['id']);
-        foreach ($start_end_times as $start_end_time) {
-            $datetime_id = $this->_insert_new_datetime($start_end_time, $old_event, $new_cpt_id);
-            if ($datetime_id) {
-                $this->get_migration_script()->set_mapping(
-                    $this->_old_start_end_table,
-                    $start_end_time['id'],
-                    $this->_new_datetime_table,
-                    $datetime_id
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Queries the 3.1 wp_events_start_end table to get all the start and end times for the event
-     *
-     * @param int   $old_event_id
-     * @return array
-     * @global wpdb $wpdb
-     */
-    private function _get_old_start_end_times(int $old_event_id): array
-    {
-        global $wpdb;
-        return $wpdb->get_results(
-            $wpdb->prepare("SELECT * FROM $this->_old_start_end_table WHERE event_id=%d", $old_event_id),
-            ARRAY_A
-        );
-    }
-
-
-    /**
-     * Inserts a 4.1 datetime given the 3.1 start_end db row and event_details row
-     *
-     * @param array $start_end_time_row
-     * @param array $old_event_row
-     * @param int   $new_cpt_id
-     * @return int ID of new datetime
-     */
-    private function _insert_new_datetime(array $start_end_time_row, array $old_event_row, int $new_cpt_id): int
-    {
-        global $wpdb;
-        $start_date         = $old_event_row['start_date'];
-        $start_time         = $this->get_migration_script()->convertTimeFromAMPM($start_end_time_row['start_time']);
-        $end_date           = $old_event_row['end_date'];
-        $end_time           = $this->get_migration_script()->convertTimeFromAMPM($start_end_time_row['end_time']);
-        $existing_datetimes = $this->_count_other_datetimes_exist_for_new_event($new_cpt_id);
-        $start_datetime_utc =
-            $this->get_migration_script()->convert_date_string_to_utc(
-                $this,
-                $start_end_time_row,
-                "$start_date $start_time:00",
-                $old_event_row['timezone_string']
-            );
-        $end_datetime_utc   =
-            $this->get_migration_script()->convert_date_string_to_utc(
-                $this,
-                $start_end_time_row,
-                "$end_date $end_time:00",
-                $old_event_row['timezone_string']
-            );
-        $cols_n_values      = [
-            'EVT_ID'        => $new_cpt_id,
-            // EVT_ID
-            'DTT_EVT_start' => $start_datetime_utc,
-            // DTT_EVT_start
-            'DTT_EVT_end'   => $end_datetime_utc,
-            // DTT_EVT_end
-            'DTT_reg_limit' => intval($start_end_time_row['reg_limit']) ? $start_end_time_row['reg_limit']
-                : $old_event_row['reg_limit'],
-            // DTT_reg_limit
-            'DTT_sold'      => 0,
-            // note: we will increment this as registrations are added during the migration
-            //          'DTT_is_primary'=> 0 == $existing_datetimes ,//DTT_is_primary... if count==0, then we'll call it the 'primary'
-            'DTT_order'     => $existing_datetimes,
-            // DTT_order, just give it the same order as the count of how many datetimes already exist
-            'DTT_parent'    => 0,
-            'DTT_deleted'   => false,
-        ];
-        $data_types         = [
-            '%d',// EVT_Id
-            '%s',// DTT_EVT_start
-            '%s',// DTT_EVT_end
-            '%d',// DTT_reg_limit
-            '%d',// DTT_sold
-            //          '%d',//DTT_is_primary
-            '%d',// DTT_order
-            '%d',// DTT_parent
-            '%d',// DTT_deleted
-        ];
-        $success            = $wpdb->insert($this->_new_datetime_table, $cols_n_values, $data_types);
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_start_end_table,
-                    array_merge($old_event_row, $start_end_time_row),
-                    $this->_new_datetime_table,
-                    $cols_n_values,
-                    $data_types
-                )
-            );
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-
-    /**
-     * Checks if there's a 4.1 datetime for this event already. This is mostly only handy
-     * when deciding whether a datetime we're about ot insert should be the 'primary' or not
-     *
-     * @param int   $cpt_event_id
-     * @return int
-     * @global wpdb $wpdb
-     */
-    private function _count_other_datetimes_exist_for_new_event(int $cpt_event_id): int
-    {
-        global $wpdb;
-        return (int) $wpdb->get_var(
-            $wpdb->prepare(
-                "SELECT COUNT(*) FROM $this->_new_datetime_table WHERE EVT_ID=%d",
-                $cpt_event_id
-            )
-        );
-    }
+		return (int) $wpdb->get_var($query);
+	}
+
+
+	/**
+	 * Gets teh venue's title or makes one up if there is none
+	 *
+	 * @param array $event_data_array keys are events_details columns and values are their values
+	 * @return string
+	 */
+	protected function _get_venue_title_for_event(array $event_data_array): string
+	{
+		return $event_data_array['venue_title']
+			? stripslashes($event_data_array['venue_title'])
+			: stripslashes(
+				sprintf(
+					esc_html__('Venue of %s', 'event_espresso'),
+					$event_data_array['event_name']
+				)
+			);
+	}
+
+
+	/**
+	 * Inserts the CPT
+	 *
+	 * @param array $old_event keys are cols, values are col values
+	 * @return int
+	 */
+	private function _insert_venue_into_posts(array $old_event): int
+	{
+		global $wpdb;
+		$insertion_array  = [
+			'post_title'        => $this->_get_venue_title_for_event($old_event),// VNU_name
+			'post_content'      => '',// VNU_desc
+			'post_name'         => $this->_find_unique_slug(
+				$old_event['venue_title'],
+				sanitize_title('venue-of-' . $old_event['event_name'])
+			),// VNU_identifier
+			'post_date'         => current_time('mysql'),// VNU_created
+			'post_date_gmt'     => get_gmt_from_date(current_time('mysql')),
+			'post_excerpt'      => '',// VNU_short_desc arbitrary only 50 characters
+			'post_modified'     => current_time('mysql'),// VNU_modified
+			'post_modified_gmt' => get_gmt_from_date(current_time('mysql')),
+			'post_author'       => $old_event['wp_user'],// VNU_wp_user
+			'post_parent'       => 0,// parent
+			'menu_order'        => 0,// VNU_order
+			'post_type'         => EspressoPostType::VENUES,// post_type
+		];
+		$data_types_array = [
+			'%s',// VNU_name
+			'%s',// VNU_desc
+			'%s',// VNU_identifier
+			'%s',// VNU_created
+			'%s',
+			'%s',// VNU_short_desc
+			'%s',// VNU_modified
+			'%s',
+			'%d',// VNU_wp_user
+			'%d',// parent
+			'%d',// VNU_order
+			'%s',// post_type
+		];
+		$success          = $wpdb->insert(
+			$wpdb->posts,
+			$insertion_array,
+			$data_types_array
+		);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_table,
+					$old_event,
+					$this->_new_table,
+					$insertion_array,
+					$data_types_array
+				)
+			);
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+
+	/**
+	 * Inserts into the venue_meta table
+	 *
+	 * @param int   $cpt_id
+	 * @param array $old_event
+	 * @return void
+	 */
+	private function _insert_venue_into_meta_table(int $cpt_id, array $old_event): void
+	{
+		global $wpdb;
+
+		// assume the country is the same as the organization's old settings
+		$country_iso = $this->get_migration_script()->get_default_country_iso();
+		// find the state from the venue, or the organization, or just guess california
+		if (! $old_event['state']) {
+			$old_org_options = get_option('events_organization_settings');
+			$state_name      = stripslashes($old_org_options['organization_state']);
+		} else {
+			$state_name = $old_event['state'];
+		}
+		if (! $state_name) {
+			$state_name = 'CA';
+		}
+		// get a state ID with the same name, if possible
+		try {
+			$state    = $this->get_migration_script()->get_or_create_state($state_name, $country_iso);
+			$state_id = $state['STA_ID'];
+		} catch (EE_Error $e) {
+			$this->add_error($e->getMessage());
+			$state_id = 0;
+		}
+		// now insert into meta table
+		$insertion_array = [
+			'VNU_ID'              => $cpt_id,// VNU_ID_fk
+			'VNU_address'         => stripslashes($old_event['address']),// VNU_address
+			'VNU_address2'        => stripslashes($old_event['address2']),// VNU_address2
+			'VNU_city'            => stripslashes($old_event['city']),// VNU_city
+			'STA_ID'              => $state_id,// STA_ID
+			'CNT_ISO'             => $country_iso,// CNT_ISO
+			'VNU_zip'             => $old_event['zip'],// VNU_zip
+			'VNU_phone'           => $old_event['venue_phone'],// VNU_phone
+			'VNU_capacity'        => -1,// VNU_capacity
+			'VNU_url'             => $old_event['venue_url'],// VNU_url
+			'VNU_virtual_phone'   => $old_event['virtual_phone'],// VNU_virtual_phone
+			'VNU_virtual_url'     => $old_event['virtual_url'],// VNU_virtual_url
+			'VNU_google_map_link' => '',// VNU_google_map_link
+			'VNU_enable_for_gmap' => true, // VNU_enable_for_gmap
+		];
+		$data_types      = [
+			'%d',// VNU_ID_fk
+			'%s',// VNU_address
+			'%s',// VNU_address2
+			'%s',// VNU_city
+			'%d',// STA_ID
+			'%s',// CNT_ISO
+			'%s',// VNU_zip
+			'%s',// VNU_phone
+			'%d',// VNU_capacity
+			'%s',// VNU_url
+			'%s',// VNU_virtual_phone
+			'%s',// VNU_virtual_url
+			'%s',// VNU_google_map_link
+			'%d',// VNU_enable_for_gmap
+		];
+		$success         = $wpdb->insert($wpdb->prefix . "esp_venue_meta", $insertion_array, $data_types);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_table,
+					$old_event,
+					$this->_new_meta_table,
+					$insertion_array,
+					$data_types
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param $new_event_id
+	 * @param $new_venue_id
+	 * @return void
+	 */
+	private function _insert_new_venue_to_event($new_event_id, $new_venue_id): void
+	{
+		global $wpdb;
+		if (! $new_event_id) {
+			$this->add_error(
+				sprintf(esc_html__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $new_event_id)
+			);
+			return;
+		}
+		if (! $new_venue_id) {
+			$this->add_error(
+				sprintf(esc_html__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $new_venue_id)
+			);
+			return;
+		}
+		$cols_n_values = [
+			'EVT_ID'      => $new_event_id,
+			'VNU_ID'      => $new_venue_id,
+			'EVV_primary' => true,
+		];
+		$data_types    = [
+			'%d',// EVT_ID
+			'%d',// VNU_ID
+			'%d',// EVT_primary
+		];
+		$success       = $wpdb->insert($wpdb->prefix . "esp_event_venue", $cols_n_values, $data_types);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_table,
+					[],
+					$this->_new_table,
+					$cols_n_values,
+					$data_types
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Converts all the 3.1 start-end times for the event to 4.1 datetimes
+	 *
+	 * @param array $old_event  results of get_results(...,ARRAY_A)
+	 * @param int   $new_cpt_id new post ID
+	 * @return void (if there are errors though, adds them to the stage's error list
+	 * @throws EE_Error
+	 * @global wpdb $wpdb
+	 */
+	private function _convert_start_end_times(array $old_event, int $new_cpt_id)
+	{
+		$start_end_times = $this->_get_old_start_end_times($old_event['id']);
+		foreach ($start_end_times as $start_end_time) {
+			$datetime_id = $this->_insert_new_datetime($start_end_time, $old_event, $new_cpt_id);
+			if ($datetime_id) {
+				$this->get_migration_script()->set_mapping(
+					$this->_old_start_end_table,
+					$start_end_time['id'],
+					$this->_new_datetime_table,
+					$datetime_id
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Queries the 3.1 wp_events_start_end table to get all the start and end times for the event
+	 *
+	 * @param int   $old_event_id
+	 * @return array
+	 * @global wpdb $wpdb
+	 */
+	private function _get_old_start_end_times(int $old_event_id): array
+	{
+		global $wpdb;
+		return $wpdb->get_results(
+			$wpdb->prepare("SELECT * FROM $this->_old_start_end_table WHERE event_id=%d", $old_event_id),
+			ARRAY_A
+		);
+	}
+
+
+	/**
+	 * Inserts a 4.1 datetime given the 3.1 start_end db row and event_details row
+	 *
+	 * @param array $start_end_time_row
+	 * @param array $old_event_row
+	 * @param int   $new_cpt_id
+	 * @return int ID of new datetime
+	 */
+	private function _insert_new_datetime(array $start_end_time_row, array $old_event_row, int $new_cpt_id): int
+	{
+		global $wpdb;
+		$start_date         = $old_event_row['start_date'];
+		$start_time         = $this->get_migration_script()->convertTimeFromAMPM($start_end_time_row['start_time']);
+		$end_date           = $old_event_row['end_date'];
+		$end_time           = $this->get_migration_script()->convertTimeFromAMPM($start_end_time_row['end_time']);
+		$existing_datetimes = $this->_count_other_datetimes_exist_for_new_event($new_cpt_id);
+		$start_datetime_utc =
+			$this->get_migration_script()->convert_date_string_to_utc(
+				$this,
+				$start_end_time_row,
+				"$start_date $start_time:00",
+				$old_event_row['timezone_string']
+			);
+		$end_datetime_utc   =
+			$this->get_migration_script()->convert_date_string_to_utc(
+				$this,
+				$start_end_time_row,
+				"$end_date $end_time:00",
+				$old_event_row['timezone_string']
+			);
+		$cols_n_values      = [
+			'EVT_ID'        => $new_cpt_id,
+			// EVT_ID
+			'DTT_EVT_start' => $start_datetime_utc,
+			// DTT_EVT_start
+			'DTT_EVT_end'   => $end_datetime_utc,
+			// DTT_EVT_end
+			'DTT_reg_limit' => intval($start_end_time_row['reg_limit']) ? $start_end_time_row['reg_limit']
+				: $old_event_row['reg_limit'],
+			// DTT_reg_limit
+			'DTT_sold'      => 0,
+			// note: we will increment this as registrations are added during the migration
+			//          'DTT_is_primary'=> 0 == $existing_datetimes ,//DTT_is_primary... if count==0, then we'll call it the 'primary'
+			'DTT_order'     => $existing_datetimes,
+			// DTT_order, just give it the same order as the count of how many datetimes already exist
+			'DTT_parent'    => 0,
+			'DTT_deleted'   => false,
+		];
+		$data_types         = [
+			'%d',// EVT_Id
+			'%s',// DTT_EVT_start
+			'%s',// DTT_EVT_end
+			'%d',// DTT_reg_limit
+			'%d',// DTT_sold
+			//          '%d',//DTT_is_primary
+			'%d',// DTT_order
+			'%d',// DTT_parent
+			'%d',// DTT_deleted
+		];
+		$success            = $wpdb->insert($this->_new_datetime_table, $cols_n_values, $data_types);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_start_end_table,
+					array_merge($old_event_row, $start_end_time_row),
+					$this->_new_datetime_table,
+					$cols_n_values,
+					$data_types
+				)
+			);
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+
+	/**
+	 * Checks if there's a 4.1 datetime for this event already. This is mostly only handy
+	 * when deciding whether a datetime we're about ot insert should be the 'primary' or not
+	 *
+	 * @param int   $cpt_event_id
+	 * @return int
+	 * @global wpdb $wpdb
+	 */
+	private function _count_other_datetimes_exist_for_new_event(int $cpt_event_id): int
+	{
+		global $wpdb;
+		return (int) $wpdb->get_var(
+			$wpdb->prepare(
+				"SELECT COUNT(*) FROM $this->_new_datetime_table WHERE EVT_ID=%d",
+				$cpt_event_id
+			)
+		);
+	}
 }

Spacing +144 added lines, -144 removed lines

@@ -190,11 +190,11 @@ 
     public function __construct()
     {
         global $wpdb;
-        $this->_old_table           = $wpdb->prefix . "events_detail";
-        $this->_old_start_end_table = $wpdb->prefix . "events_start_end";
-        $this->_new_table           = $wpdb->prefix . "posts";
-        $this->_new_meta_table      = $wpdb->prefix . "esp_event_meta";
-        $this->_new_datetime_table  = $wpdb->prefix . "esp_datetime";
+        $this->_old_table           = $wpdb->prefix."events_detail";
+        $this->_old_start_end_table = $wpdb->prefix."events_start_end";
+        $this->_new_table           = $wpdb->prefix."posts";
+        $this->_new_meta_table      = $wpdb->prefix."esp_event_meta";
+        $this->_new_datetime_table  = $wpdb->prefix."esp_datetime";
         $this->_pretty_name         = esc_html__("Events", "event_espresso");
         parent::__construct();
     }
@@ -208,7 +208,7 @@ 
     public function _count_records_to_migrate(): int
     {
         global $wpdb;
-        return (int) $wpdb->get_var("SELECT COUNT(*) FROM " . $this->_old_table . ' WHERE event_status !="D"');
+        return (int) $wpdb->get_var("SELECT COUNT(*) FROM ".$this->_old_table.' WHERE event_status !="D"');
     }
 
 
@@ -301,17 +301,17 @@ 
     private function _add_post_metas(array $old_event, int $post_id)
     {
         $event_meta = maybe_unserialize($old_event['event_meta']);
-        if (! $event_meta || ! is_array($event_meta)) {
+        if ( ! $event_meta || ! is_array($event_meta)) {
             return;
         }
-        unset($event_meta['date_submitted']);              // factored into CPT
-        unset($event_meta['additional_attendee_reg_info']);// factored into event meta table
-        unset($event_meta['default_payment_status']);      // dido
-        unset($event_meta['event_thumbnail_url']);         // used to find post featured image
+        unset($event_meta['date_submitted']); // factored into CPT
+        unset($event_meta['additional_attendee_reg_info']); // factored into event meta table
+        unset($event_meta['default_payment_status']); // dido
+        unset($event_meta['event_thumbnail_url']); // used to find post featured image
         foreach ($event_meta as $meta_key => $meta_value) {
             if ($meta_key) {// if the meta key is just an empty string, ignore it
                 $success = add_post_meta($post_id, $meta_key, $meta_value, true);
-                if (! $success) {
+                if ( ! $success) {
                     $this->add_error(
                         sprintf(
                             esc_html__(
@@ -413,63 +413,63 @@ 
             // @todo: is it ok to just mark secondary/waitlist events as DRAFTS?
             'D'  => 'trash',
         ];
-        $post_status        = $status_conversions[ $old_event['event_status'] ];
+        $post_status = $status_conversions[$old_event['event_status']];
         // check if we've sold out
         if (intval($old_event['reg_limit']) <= self::count_registrations($old_event['id'])) {
             $post_status = 'sold_out';
         }
         //      FYI postponed and cancelled don't exist in 3.1
-        $cols_n_values                      = [
-            'post_title'        => stripslashes($old_event['event_name']),// EVT_name
-            'post_content'      => stripslashes($old_event['event_desc']),// EVT_desc
+        $cols_n_values = [
+            'post_title'        => stripslashes($old_event['event_name']), // EVT_name
+            'post_content'      => stripslashes($old_event['event_desc']), // EVT_desc
             'post_name'         => $this->_find_unique_slug(
                 $old_event['event_name'],
                 $old_event['event_identifier'],
                 $post_status
-            ),// EVT_slug
-            'post_date'         => $old_event['submitted'],// EVT_created NOT
+            ), // EVT_slug
+            'post_date'         => $old_event['submitted'], // EVT_created NOT
             'post_date_gmt'     => get_gmt_from_date($old_event['submitted']),
-            'post_excerpt'      => '',// EVT_short_desc
-            'post_modified'     => $old_event['submitted'],// EVT_modified
+            'post_excerpt'      => '', // EVT_short_desc
+            'post_modified'     => $old_event['submitted'], // EVT_modified
             'post_modified_gmt' => get_gmt_from_date($old_event['submitted']),
-            'post_author'       => $old_event['wp_user'],// EVT_wp_user
-            'post_parent'       => 0,// parent maybe get this from some REM field?
-            'menu_order'        => 0,// EVT_order
-            'post_type'         => EspressoPostType::EVENTS,// post_type
-            'post_status'       => $post_status,// status
+            'post_author'       => $old_event['wp_user'], // EVT_wp_user
+            'post_parent'       => 0, // parent maybe get this from some REM field?
+            'menu_order'        => 0, // EVT_order
+            'post_type'         => EspressoPostType::EVENTS, // post_type
+            'post_status'       => $post_status, // status
         ];
         $cols_n_values_with_no_invalid_text = [];
         foreach ($cols_n_values as $col => $value) {
             $value_sans_invalid_chars = $wpdb->strip_invalid_text_for_column($this->_new_table, $col, $value);
-            if (! is_wp_error($value_sans_invalid_chars)) {
-                $cols_n_values_with_no_invalid_text[ $col ] = $value_sans_invalid_chars;
+            if ( ! is_wp_error($value_sans_invalid_chars)) {
+                $cols_n_values_with_no_invalid_text[$col] = $value_sans_invalid_chars;
             } else {
                 // otherwise leave it as-is. It will blow everything up and stop the migration
-                $cols_n_values_with_no_invalid_text[ $col ] = $value;
+                $cols_n_values_with_no_invalid_text[$col] = $value;
             }
         }
         $cols_n_values = $cols_n_values_with_no_invalid_text;
         $data_types    = [
-            '%s',// EVT_name
-            '%s',// EVT_desc
-            '%s',// EVT_slug
-            '%s',// EVT_created
+            '%s', // EVT_name
+            '%s', // EVT_desc
+            '%s', // EVT_slug
+            '%s', // EVT_created
             '%s',
-            '%s',// EVT_short_desc
-            '%s',// EVT_modified
+            '%s', // EVT_short_desc
+            '%s', // EVT_modified
             '%s',
-            '%s',// EVT_wp_user
-            '%d',// post_parent
-            '%d',// EVT_order
-            '%s',// post_type
-            '%s',// status
+            '%s', // EVT_wp_user
+            '%d', // post_parent
+            '%d', // EVT_order
+            '%s', // post_type
+            '%s', // status
         ];
-        $success       = $wpdb->insert(
+        $success = $wpdb->insert(
             $this->_new_table,
             $cols_n_values,
             $data_types
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_table,
@@ -522,8 +522,8 @@ 
                 $event_meta['default_payment_status'] ?? '',
                 intval($old_event['require_pre_approval'])
             );
-        $cols_n_values      = [
-            'EVT_ID'                          => $new_cpt_id,// EVT_ID_fk
+        $cols_n_values = [
+            'EVT_ID'                          => $new_cpt_id, // EVT_ID_fk
             'EVT_display_desc'                => 'Y' == $old_event['display_desc'],
             'EVT_display_ticket_selector'     => 'Y' == $old_event['display_reg_form'],
             'EVT_visible_on'                  => $this->get_migration_script()->convert_date_string_to_utc(
@@ -533,7 +533,7 @@ 
                     'mysql'
                 ),
                 $old_event['timezone_string']
-            ),// don't use the old 'visible_on', as it wasn't ever used
+            ), // don't use the old 'visible_on', as it wasn't ever used
             'EVT_additional_limit'            => $old_event['allow_multiple'] == 'N' ? 1
                 : $old_event['additional_limit'],
             'EVT_default_registration_status' => $default_reg_status,
@@ -542,29 +542,29 @@ 
             'EVT_allow_overflow'              => 'Y' == $old_event['allow_overflow'],
             'EVT_timezone_string'             => $old_event['timezone_string'],
             'EVT_external_URL'                => $old_event['externalURL'],
-            'EVT_donations'                   => false,// doesn't exist in 3.1
+            'EVT_donations'                   => false, // doesn't exist in 3.1
 
         ];
-        $data_types         = [
-            '%s',// EVT_ID
-            '%d',// EVT_display_desc
-            '%d',// EVT_display_ticket_selector
-            '%s',// EVT_visible_on
-            '%d',// EVT_additional_limit
-            '%s',// EVT_default_registration_status
-            '%d',// EVT_member_only
-            '%s',// EVT_phone
-            '%d',// EVT_allow_overflow
-            '%s',// EVT_timezone_string
-            '%s',// EVT_external_URL
-            '%d',// EVT_donations
+        $data_types = [
+            '%s', // EVT_ID
+            '%d', // EVT_display_desc
+            '%d', // EVT_display_ticket_selector
+            '%s', // EVT_visible_on
+            '%d', // EVT_additional_limit
+            '%s', // EVT_default_registration_status
+            '%d', // EVT_member_only
+            '%s', // EVT_phone
+            '%d', // EVT_allow_overflow
+            '%s', // EVT_timezone_string
+            '%s', // EVT_external_URL
+            '%d', // EVT_donations
         ];
-        $success            = $wpdb->insert(
+        $success = $wpdb->insert(
             $this->_new_meta_table,
             $cols_n_values,
             $data_types
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_table,
@@ -607,7 +607,7 @@ 
             if ($new_id) {
                 $this->_insert_venue_into_meta_table($new_id, $old_event);
                 $guid = $old_event['venue_image'] ?? null;
-                if($guid) {
+                if ($guid) {
                     $this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post(
                         $guid,
                         $new_id,
@@ -633,16 +633,16 @@ 
     private function _duplicate_venue_exists(array $old_event): int
     {
         global $wpdb;
-        $conditions     = [
+        $conditions = [
             'VNU_address'       => $old_event ['address'],
             'VNU_address2'      => $old_event['address2'],
             'VNU_city'          => $old_event['city'],
             'VNU_zip'           => $old_event['zip'],
             'post_title'        => $this->_get_venue_title_for_event($old_event),
-            'VNU_phone'         => $old_event['venue_phone'],// VNU_phone
-            'VNU_url'           => $old_event['venue_url'],// VNU_url
-            'VNU_virtual_phone' => $old_event['virtual_phone'],// VNU_virtual_phone
-            'VNU_virtual_url'   => $old_event['virtual_url'],// VNU_virtual_url
+            'VNU_phone'         => $old_event['venue_phone'], // VNU_phone
+            'VNU_url'           => $old_event['venue_url'], // VNU_url
+            'VNU_virtual_phone' => $old_event['virtual_phone'], // VNU_virtual_phone
+            'VNU_virtual_url'   => $old_event['virtual_url'], // VNU_virtual_url
         ];
         $sql_conditions = [];
         foreach ($conditions as $column => $value) {
@@ -652,7 +652,7 @@ 
 					FROM
 		$wpdb->posts as p INNER JOIN
 		{$wpdb->prefix}esp_venue_meta as v ON p.ID = v.VNU_ID
-			WHERE " . implode(" AND ", $sql_conditions) . " LIMIT 1";
+			WHERE ".implode(" AND ", $sql_conditions)." LIMIT 1";
         return (int) $wpdb->get_var($query);
     }
 
@@ -685,43 +685,43 @@ 
     private function _insert_venue_into_posts(array $old_event): int
     {
         global $wpdb;
-        $insertion_array  = [
-            'post_title'        => $this->_get_venue_title_for_event($old_event),// VNU_name
-            'post_content'      => '',// VNU_desc
+        $insertion_array = [
+            'post_title'        => $this->_get_venue_title_for_event($old_event), // VNU_name
+            'post_content'      => '', // VNU_desc
             'post_name'         => $this->_find_unique_slug(
                 $old_event['venue_title'],
-                sanitize_title('venue-of-' . $old_event['event_name'])
-            ),// VNU_identifier
-            'post_date'         => current_time('mysql'),// VNU_created
+                sanitize_title('venue-of-'.$old_event['event_name'])
+            ), // VNU_identifier
+            'post_date'         => current_time('mysql'), // VNU_created
             'post_date_gmt'     => get_gmt_from_date(current_time('mysql')),
-            'post_excerpt'      => '',// VNU_short_desc arbitrary only 50 characters
-            'post_modified'     => current_time('mysql'),// VNU_modified
+            'post_excerpt'      => '', // VNU_short_desc arbitrary only 50 characters
+            'post_modified'     => current_time('mysql'), // VNU_modified
             'post_modified_gmt' => get_gmt_from_date(current_time('mysql')),
-            'post_author'       => $old_event['wp_user'],// VNU_wp_user
-            'post_parent'       => 0,// parent
-            'menu_order'        => 0,// VNU_order
-            'post_type'         => EspressoPostType::VENUES,// post_type
+            'post_author'       => $old_event['wp_user'], // VNU_wp_user
+            'post_parent'       => 0, // parent
+            'menu_order'        => 0, // VNU_order
+            'post_type'         => EspressoPostType::VENUES, // post_type
         ];
         $data_types_array = [
-            '%s',// VNU_name
-            '%s',// VNU_desc
-            '%s',// VNU_identifier
-            '%s',// VNU_created
+            '%s', // VNU_name
+            '%s', // VNU_desc
+            '%s', // VNU_identifier
+            '%s', // VNU_created
             '%s',
-            '%s',// VNU_short_desc
-            '%s',// VNU_modified
+            '%s', // VNU_short_desc
+            '%s', // VNU_modified
             '%s',
-            '%d',// VNU_wp_user
-            '%d',// parent
-            '%d',// VNU_order
-            '%s',// post_type
+            '%d', // VNU_wp_user
+            '%d', // parent
+            '%d', // VNU_order
+            '%s', // post_type
         ];
-        $success          = $wpdb->insert(
+        $success = $wpdb->insert(
             $wpdb->posts,
             $insertion_array,
             $data_types_array
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_table,
@@ -751,13 +751,13 @@ 
         // assume the country is the same as the organization's old settings
         $country_iso = $this->get_migration_script()->get_default_country_iso();
         // find the state from the venue, or the organization, or just guess california
-        if (! $old_event['state']) {
+        if ( ! $old_event['state']) {
             $old_org_options = get_option('events_organization_settings');
             $state_name      = stripslashes($old_org_options['organization_state']);
         } else {
             $state_name = $old_event['state'];
         }
-        if (! $state_name) {
+        if ( ! $state_name) {
             $state_name = 'CA';
         }
         // get a state ID with the same name, if possible
@@ -770,39 +770,39 @@ 
         }
         // now insert into meta table
         $insertion_array = [
-            'VNU_ID'              => $cpt_id,// VNU_ID_fk
-            'VNU_address'         => stripslashes($old_event['address']),// VNU_address
-            'VNU_address2'        => stripslashes($old_event['address2']),// VNU_address2
-            'VNU_city'            => stripslashes($old_event['city']),// VNU_city
-            'STA_ID'              => $state_id,// STA_ID
-            'CNT_ISO'             => $country_iso,// CNT_ISO
-            'VNU_zip'             => $old_event['zip'],// VNU_zip
-            'VNU_phone'           => $old_event['venue_phone'],// VNU_phone
-            'VNU_capacity'        => -1,// VNU_capacity
-            'VNU_url'             => $old_event['venue_url'],// VNU_url
-            'VNU_virtual_phone'   => $old_event['virtual_phone'],// VNU_virtual_phone
-            'VNU_virtual_url'     => $old_event['virtual_url'],// VNU_virtual_url
-            'VNU_google_map_link' => '',// VNU_google_map_link
+            'VNU_ID'              => $cpt_id, // VNU_ID_fk
+            'VNU_address'         => stripslashes($old_event['address']), // VNU_address
+            'VNU_address2'        => stripslashes($old_event['address2']), // VNU_address2
+            'VNU_city'            => stripslashes($old_event['city']), // VNU_city
+            'STA_ID'              => $state_id, // STA_ID
+            'CNT_ISO'             => $country_iso, // CNT_ISO
+            'VNU_zip'             => $old_event['zip'], // VNU_zip
+            'VNU_phone'           => $old_event['venue_phone'], // VNU_phone
+            'VNU_capacity'        => -1, // VNU_capacity
+            'VNU_url'             => $old_event['venue_url'], // VNU_url
+            'VNU_virtual_phone'   => $old_event['virtual_phone'], // VNU_virtual_phone
+            'VNU_virtual_url'     => $old_event['virtual_url'], // VNU_virtual_url
+            'VNU_google_map_link' => '', // VNU_google_map_link
             'VNU_enable_for_gmap' => true, // VNU_enable_for_gmap
         ];
-        $data_types      = [
-            '%d',// VNU_ID_fk
-            '%s',// VNU_address
-            '%s',// VNU_address2
-            '%s',// VNU_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// VNU_zip
-            '%s',// VNU_phone
-            '%d',// VNU_capacity
-            '%s',// VNU_url
-            '%s',// VNU_virtual_phone
-            '%s',// VNU_virtual_url
-            '%s',// VNU_google_map_link
-            '%d',// VNU_enable_for_gmap
+        $data_types = [
+            '%d', // VNU_ID_fk
+            '%s', // VNU_address
+            '%s', // VNU_address2
+            '%s', // VNU_city
+            '%d', // STA_ID
+            '%s', // CNT_ISO
+            '%s', // VNU_zip
+            '%s', // VNU_phone
+            '%d', // VNU_capacity
+            '%s', // VNU_url
+            '%s', // VNU_virtual_phone
+            '%s', // VNU_virtual_url
+            '%s', // VNU_google_map_link
+            '%d', // VNU_enable_for_gmap
         ];
-        $success         = $wpdb->insert($wpdb->prefix . "esp_venue_meta", $insertion_array, $data_types);
-        if (! $success) {
+        $success = $wpdb->insert($wpdb->prefix."esp_venue_meta", $insertion_array, $data_types);
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_table,
@@ -824,13 +824,13 @@ 
     private function _insert_new_venue_to_event($new_event_id, $new_venue_id): void
     {
         global $wpdb;
-        if (! $new_event_id) {
+        if ( ! $new_event_id) {
             $this->add_error(
                 sprintf(esc_html__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $new_event_id)
             );
             return;
         }
-        if (! $new_venue_id) {
+        if ( ! $new_venue_id) {
             $this->add_error(
                 sprintf(esc_html__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $new_venue_id)
             );
@@ -841,13 +841,13 @@ 
             'VNU_ID'      => $new_venue_id,
             'EVV_primary' => true,
         ];
-        $data_types    = [
-            '%d',// EVT_ID
-            '%d',// VNU_ID
-            '%d',// EVT_primary
+        $data_types = [
+            '%d', // EVT_ID
+            '%d', // VNU_ID
+            '%d', // EVT_primary
         ];
-        $success       = $wpdb->insert($wpdb->prefix . "esp_event_venue", $cols_n_values, $data_types);
-        if (! $success) {
+        $success = $wpdb->insert($wpdb->prefix."esp_event_venue", $cols_n_values, $data_types);
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_table,
@@ -927,14 +927,14 @@ 
                 "$start_date $start_time:00",
                 $old_event_row['timezone_string']
             );
-        $end_datetime_utc   =
+        $end_datetime_utc =
             $this->get_migration_script()->convert_date_string_to_utc(
                 $this,
                 $start_end_time_row,
                 "$end_date $end_time:00",
                 $old_event_row['timezone_string']
             );
-        $cols_n_values      = [
+        $cols_n_values = [
             'EVT_ID'        => $new_cpt_id,
             // EVT_ID
             'DTT_EVT_start' => $start_datetime_utc,
@@ -952,19 +952,19 @@ 
             'DTT_parent'    => 0,
             'DTT_deleted'   => false,
         ];
-        $data_types         = [
-            '%d',// EVT_Id
-            '%s',// DTT_EVT_start
-            '%s',// DTT_EVT_end
-            '%d',// DTT_reg_limit
-            '%d',// DTT_sold
+        $data_types = [
+            '%d', // EVT_Id
+            '%s', // DTT_EVT_start
+            '%s', // DTT_EVT_end
+            '%d', // DTT_reg_limit
+            '%d', // DTT_sold
             //          '%d',//DTT_is_primary
-            '%d',// DTT_order
-            '%d',// DTT_parent
-            '%d',// DTT_deleted
+            '%d', // DTT_order
+            '%d', // DTT_parent
+            '%d', // DTT_deleted
         ];
-        $success            = $wpdb->insert($this->_new_datetime_table, $cols_n_values, $data_types);
-        if (! $success) {
+        $success = $wpdb->insert($this->_new_datetime_table, $cols_n_values, $data_types);
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_start_end_table,