eventespresso / event-espresso-core

core/db_classes/EE_Soft_Delete_Base_Class.class.php

Indentation +51 added lines, -51 removed lines

@@ -11,59 +11,59 @@
  */
 abstract class EE_Soft_Delete_Base_Class extends EE_Base_Class
 {
-    /**
-     * Overrides parent _delete() so that we do soft deletes.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete(): int
-    {
-        return $this->delete_or_restore();
-    }
+	/**
+	 * Overrides parent _delete() so that we do soft deletes.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete(): int
+	{
+		return $this->delete_or_restore();
+	}
 
 
-    /**
-     * Deletes or restores this object.
-     *
-     * @param bool $delete true=>delete, false=>restore
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_or_restore(bool $delete = true): int
-    {
-        /**
-         * Called just before trashing (soft delete) or restoring a trashed item.
-         *
-         * @param EE_Base_Class $model_object about to be trashed or restored
-         * @param bool          $delete       true the item is being trashed, false the item is being restored.
-         */
-        do_action('AHEE__EE_Soft_Delete_Base_Class__delete_or_restore__before', $this, $delete);
-        $model  = $this->get_model();
-        $result = $model->delete_or_restore_by_ID($delete, $this->ID());
-        /**
-         * Called just after trashing (soft delete) or restoring a trashed item.
-         *
-         * @param EE_Base_Class $model_object that was just trashed or restored.
-         * @param bool          $delete       true the item is being trashed, false the item is being restored.
-         * @param bool|int      $result
-         */
-        do_action('AHEE__EE_Soft_Delete_Base_Class__delete_or_restore__after', $this, $delete, $result);
-        return $result;
-    }
+	/**
+	 * Deletes or restores this object.
+	 *
+	 * @param bool $delete true=>delete, false=>restore
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_or_restore(bool $delete = true): int
+	{
+		/**
+		 * Called just before trashing (soft delete) or restoring a trashed item.
+		 *
+		 * @param EE_Base_Class $model_object about to be trashed or restored
+		 * @param bool          $delete       true the item is being trashed, false the item is being restored.
+		 */
+		do_action('AHEE__EE_Soft_Delete_Base_Class__delete_or_restore__before', $this, $delete);
+		$model  = $this->get_model();
+		$result = $model->delete_or_restore_by_ID($delete, $this->ID());
+		/**
+		 * Called just after trashing (soft delete) or restoring a trashed item.
+		 *
+		 * @param EE_Base_Class $model_object that was just trashed or restored.
+		 * @param bool          $delete       true the item is being trashed, false the item is being restored.
+		 * @param bool|int      $result
+		 */
+		do_action('AHEE__EE_Soft_Delete_Base_Class__delete_or_restore__after', $this, $delete, $result);
+		return $result;
+	}
 
 
-    /**
-     * Performs a restoration (un-deletes) this object
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function restore(): int
-    {
-        return $this->delete_or_restore(false);
-    }
+	/**
+	 * Performs a restoration (un-deletes) this object
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function restore(): int
+	{
+		return $this->delete_or_restore(false);
+	}
 }

core/db_classes/EE_Country.class.php

Indentation +217 added lines, -217 removed lines

@@ -9,221 +9,221 @@
  */
 class EE_Country extends EE_Base_Class
 {
-    /**
-     * @param array $props_n_values
-     * @return EE_Country|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [])
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ?: new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Country
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = []): EE_Country
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Gets the country name
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function name(): string
-    {
-        return (string) $this->get('CNT_name');
-    }
-
-
-    /**
-     * Whether the country is active/enabled
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function isActive(): bool
-    {
-        return (bool) $this->get('CNT_active');
-    }
-
-
-    /**
-     * Gets the country ISO code
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ISO(): string
-    {
-        return (string) $this->get('CNT_ISO');
-    }
-
-
-    /**
-     * Gets the country ISO3 code
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ISO3(): string
-    {
-        return (string) $this->get('CNT_ISO3');
-    }
-
-
-    /**
-     * gets the country's currency code
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function currency_code(): string
-    {
-        return (string) $this->get('CNT_cur_code');
-    }
-
-
-    /**
-     * gets the country's currency sign/symbol
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function currency_sign(): string
-    {
-        return (string) $this->get('CNT_cur_sign');
-    }
-
-
-    /**
-     * Currency name singular
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function currency_name_single(): string
-    {
-        return (string) $this->get('CNT_cur_single');
-    }
-
-
-    /**
-     * Currency name plural
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function currency_name_plural(): string
-    {
-        return (string) $this->get('CNT_cur_plural');
-    }
-
-
-    /**
-     * currency_sign_before - ie: $TRUE  or  FALSE$
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function currency_sign_before(): bool
-    {
-        return (bool) $this->get('CNT_cur_sign_b4');
-    }
-
-
-    /**
-     * currency_decimal_places : 2 = 0.00   3 = 0.000
-     *
-     * @return integer
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function currency_decimal_places(): int
-    {
-        return (int) $this->get('CNT_cur_dec_plc');
-    }
-
-
-    /**
-     * currency_decimal_mark :   (comma) ',' = 0,01   or   (decimal) '.' = 0.01
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function currency_decimal_mark(): string
-    {
-        return (string) $this->get('CNT_cur_dec_mrk');
-    }
-
-
-    /**
-     * currency thousands separator:   (comma) ',' = 1,000   or   (decimal) '.' = 1.000
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function currency_thousands_separator(): string
-    {
-        return (string) $this->get('CNT_cur_thsnds');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.10.30.p
-     */
-    public function isEU(): bool
-    {
-        return (bool) $this->get('CNT_is_EU');
-    }
-
-
-    /**
-     * Country Telephone Code: +1
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.10.30.p
-     */
-    public function telephoneCode(): string
-    {
-        return (string) $this->get('CNT_tel_code');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated 4.10.30.p
-     */
-    public function is_active(): bool
-    {
-        return $this->isActive();
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Country|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [])
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ?: new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Country
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = []): EE_Country
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Gets the country name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function name(): string
+	{
+		return (string) $this->get('CNT_name');
+	}
+
+
+	/**
+	 * Whether the country is active/enabled
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function isActive(): bool
+	{
+		return (bool) $this->get('CNT_active');
+	}
+
+
+	/**
+	 * Gets the country ISO code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ISO(): string
+	{
+		return (string) $this->get('CNT_ISO');
+	}
+
+
+	/**
+	 * Gets the country ISO3 code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ISO3(): string
+	{
+		return (string) $this->get('CNT_ISO3');
+	}
+
+
+	/**
+	 * gets the country's currency code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function currency_code(): string
+	{
+		return (string) $this->get('CNT_cur_code');
+	}
+
+
+	/**
+	 * gets the country's currency sign/symbol
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function currency_sign(): string
+	{
+		return (string) $this->get('CNT_cur_sign');
+	}
+
+
+	/**
+	 * Currency name singular
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function currency_name_single(): string
+	{
+		return (string) $this->get('CNT_cur_single');
+	}
+
+
+	/**
+	 * Currency name plural
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function currency_name_plural(): string
+	{
+		return (string) $this->get('CNT_cur_plural');
+	}
+
+
+	/**
+	 * currency_sign_before - ie: $TRUE  or  FALSE$
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function currency_sign_before(): bool
+	{
+		return (bool) $this->get('CNT_cur_sign_b4');
+	}
+
+
+	/**
+	 * currency_decimal_places : 2 = 0.00   3 = 0.000
+	 *
+	 * @return integer
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function currency_decimal_places(): int
+	{
+		return (int) $this->get('CNT_cur_dec_plc');
+	}
+
+
+	/**
+	 * currency_decimal_mark :   (comma) ',' = 0,01   or   (decimal) '.' = 0.01
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function currency_decimal_mark(): string
+	{
+		return (string) $this->get('CNT_cur_dec_mrk');
+	}
+
+
+	/**
+	 * currency thousands separator:   (comma) ',' = 1,000   or   (decimal) '.' = 1.000
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function currency_thousands_separator(): string
+	{
+		return (string) $this->get('CNT_cur_thsnds');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.10.30.p
+	 */
+	public function isEU(): bool
+	{
+		return (bool) $this->get('CNT_is_EU');
+	}
+
+
+	/**
+	 * Country Telephone Code: +1
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.10.30.p
+	 */
+	public function telephoneCode(): string
+	{
+		return (string) $this->get('CNT_tel_code');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated 4.10.30.p
+	 */
+	public function is_active(): bool
+	{
+		return $this->isActive();
+	}
 }

core/db_classes/EE_Base_Class.class.php

Indentation +3362 added lines, -3362 removed lines

@@ -15,3377 +15,3377 @@
  */
 abstract class EE_Base_Class
 {
-    /**
-     * @var EEM_Base|null
-     */
-    protected $_model = null;
-
-    /**
-     * This is an array of the original properties and values provided during construction
-     * of this model object. (keys are model field names, values are their values).
-     * This list is important to remember so that when we are merging data from the db, we know
-     * which values to override and which to not override.
-     */
-    protected ?array $_props_n_values_provided_in_constructor = null;
-
-    /**
-     * Timezone
-     * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
-     * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
-     * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
-     * access to it.
-     */
-    protected string $_timezone = '';
-
-    /**
-     * date format
-     * pattern or format for displaying dates
-     */
-    protected string $_dt_frmt = '';
-
-    /**
-     * time format
-     * pattern or format for displaying time
-     */
-    protected string $_tm_frmt = '';
-
-    /**
-     * This property is for holding a cached array of object properties indexed by property name as the key.
-     * The purpose of this is for setting a cache on properties that may have calculated values after a
-     * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
-     * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
-     */
-    protected array $_cached_properties = [];
-
-    /**
-     * An array containing keys of the related model, and values are either an array of related mode objects or a
-     * single
-     * related model object. see the model's _model_relations. The keys should match those specified. And if the
-     * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
-     * all others have an array)
-     */
-    protected array $_model_relations = [];
-
-    /**
-     * Array where keys are field names (see the model's _fields property) and values are their values. To see what
-     * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
-     */
-    protected array $_fields = [];
-
-    /**
-     * indicating whether or not this model object is intended to ever be saved
-     * For example, we might create model objects intended to only be used for the duration
-     * of this request and to be thrown away, and if they were accidentally saved
-     * it would be a bug.
-     */
-    protected bool $_allow_persist = true;
-
-    /**
-     * indicating whether or not this model object's properties have changed since construction
-     */
-    protected bool $_has_changes = false;
-
-    /**
-     * This is a cache of results from custom selections done on a query that constructs this entity. The only purpose
-     * for these values is for retrieval of the results, they are not further queryable and they are not persisted to
-     * the db.  They also do not automatically update if there are any changes to the data that produced their results.
-     * The format is a simple array of field_alias => field_value.  So for instance if a custom select was something
-     * like,  "Select COUNT(Registration.REG_ID) as Registration_Count ...", then the resulting value will be in this
-     * array as:
-     * array(
-     *  'Registration_Count' => 24
-     * );
-     * Note: if the custom select configuration for the query included a data type, the value will be in the data type
-     * provided for the query (@see EventEspresso\core\domain\values\model\CustomSelects::__construct phpdocs for more
-     * info)
-     */
-    protected array $custom_selection_results = [];
-
-
-    /**
-     * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children
-     * play nice
-     *
-     * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
-     *                                                         layer of the model's _fields array, (eg, EVT_ID,
-     *                                                         TXN_amount, QST_name, etc) and values are their values
-     * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
-     *                                                         corresponding db model or not.
-     * @param string  $timezone                                indicate what timezone you want any datetime fields to
-     *                                                         be in when instantiating a EE_Base_Class object.
-     * @param array   $date_formats                            An array of date formats to set on construct where first
-     *                                                         value is the date_format and second value is the time
-     *                                                         format.
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct($fieldValues = [], $bydb = false, $timezone = '', $date_formats = [])
-    {
-        $className = get_class($this);
-        do_action("AHEE__{$className}__construct", $this, $fieldValues);
-        $model        = $this->get_model();
-        $model_fields = $model->field_settings();
-        // ensure $fieldValues is an array
-        $fieldValues = is_array($fieldValues) ? $fieldValues : [$fieldValues];
-        // verify client code has not passed any invalid field names
-        foreach ($fieldValues as $field_name => $field_value) {
-            if (! isset($model_fields[ $field_name ])) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Invalid field (%s) passed to constructor of %s. Allowed fields are :%s',
-                            'event_espresso'
-                        ),
-                        $field_name,
-                        get_class($this),
-                        implode(', ', array_keys($model_fields))
-                    )
-                );
-            }
-        }
-
-        $date_format     = null;
-        $time_format     = null;
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        if (! empty($date_formats) && is_array($date_formats)) {
-            [$date_format, $time_format] = $date_formats;
-        }
-        $this->set_date_format($date_format);
-        $this->set_time_format($time_format);
-        // if db model is instantiating
-        foreach ($model_fields as $fieldName => $field) {
-            if ($bydb) {
-                // client code has indicated these field values are from the database
-                $this->set_from_db(
-                    $fieldName,
-                    $fieldValues[ $fieldName ] ?? null
-                );
-            } else {
-                // we're constructing a brand new instance of the model object.
-                // Generally, this means we'll need to do more field validation
-                $this->set(
-                    $fieldName,
-                    $fieldValues[ $fieldName ] ?? null,
-                    true
-                );
-            }
-        }
-        // remember what values were passed to this constructor
-        $this->_props_n_values_provided_in_constructor = $fieldValues;
-        // remember in entity mapper
-        if (! $bydb && $model->has_primary_key_field() && $this->ID()) {
-            $model->add_to_entity_map($this);
-        }
-        // setup all the relations
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $this->_model_relations[ $relation_name ] = null;
-            } else {
-                $this->_model_relations[ $relation_name ] = [];
-            }
-        }
-        /**
-         * Action done at the end of each model object construction
-         *
-         * @param EE_Base_Class $this the model object just created
-         */
-        do_action('AHEE__EE_Base_Class__construct__finished', $this);
-    }
-
-
-    /**
-     * Gets whether or not this model object is allowed to persist/be saved to the database.
-     *
-     * @return boolean
-     */
-    public function allow_persist()
-    {
-        return $this->_allow_persist;
-    }
-
-
-    /**
-     * Sets whether or not this model object should be allowed to be saved to the DB.
-     * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
-     * you got new information that somehow made you change your mind.
-     *
-     * @param boolean $allow_persist
-     * @return boolean
-     */
-    public function set_allow_persist($allow_persist)
-    {
-        return $this->_allow_persist = $allow_persist;
-    }
-
-
-    /**
-     * Gets the field's original value when this object was constructed during this request.
-     * This can be helpful when determining if a model object has changed or not
-     *
-     * @param string $field_name
-     * @return mixed|null
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_original($field_name)
-    {
-        if (
-            isset($this->_props_n_values_provided_in_constructor[ $field_name ])
-            && $field_settings = $this->get_model()->field_settings_for($field_name)
-        ) {
-            return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[ $field_name ]);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param EE_Base_Class $obj
-     * @return string
-     */
-    public function get_class($obj)
-    {
-        return get_class($obj);
-    }
-
-
-    /**
-     * Overrides parent because parent expects old models.
-     * This also doesn't do any validation, and won't work for serialized arrays
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function set(string $field_name, $field_value, bool $use_default = false)
-    {
-        // if not using default and nothing has changed, and object has already been setup (has ID),
-        // then don't do anything
-        if (
-            ! $use_default
-            && $this->_fields[ $field_name ] === $field_value
-            && $this->ID()
-        ) {
-            return;
-        }
-        $model              = $this->get_model();
-        $this->_has_changes = true;
-        $field_obj          = $model->field_settings_for($field_name);
-        if (! $field_obj instanceof EE_Model_Field_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'A valid EE_Model_Field_Base could not be found for the given field name: %s',
-                        'event_espresso'
-                    ),
-                    $field_name
-                )
-            );
-        }
-        // if ( method_exists( $field_obj, 'set_timezone' )) {
-        if ($field_obj instanceof EE_Datetime_Field) {
-            $field_obj->set_timezone($this->_timezone);
-            $field_obj->set_date_format($this->_dt_frmt);
-            $field_obj->set_time_format($this->_tm_frmt);
-        }
-
-        // should the value be null?
-        $value = $field_value === null && ($use_default || ! $field_obj->is_nullable())
-            ? $field_obj->get_default_value()
-            : $field_value;
-
-        $this->_fields[ $field_name ] = $field_obj->prepare_for_set($value);
-
-        // if we're not in the constructor...
-        // now check if what we set was a primary key
-        if (
-            // note: props_n_values_provided_in_constructor is only set at the END of the constructor
-            $this->_props_n_values_provided_in_constructor
-            && $field_value
-            && $field_name === $model->primary_key_name()
-        ) {
-            // if so, we want all this object's fields to be filled either with
-            // what we've explicitly set on this model
-            // or what we have in the db
-            // echo "setting primary key!";
-            $fields_on_model = self::_get_model(get_class($this))->field_settings();
-            $obj_in_db       = self::_get_model(get_class($this))->get_one_by_ID($field_value);
-            foreach ($fields_on_model as $field_obj) {
-                if (
-                    ! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
-                    && $field_obj->get_name() !== $field_name
-                ) {
-                    $this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
-                }
-            }
-            // oh this model object has an ID? well make sure its in the entity mapper
-            $model->add_to_entity_map($this);
-        }
-        // let's unset any cache for this field_name from the $_cached_properties property.
-        $this->_clear_cached_property($field_name);
-    }
-
-
-    /**
-     * Overrides parent because parent expects old models.
-     * This also doesn't do any validation, and won't work for serialized arrays
-     *
-     * @param string $field_name
-     * @param mixed  $field_value_from_db
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_from_db(string $field_name, $field_value_from_db)
-    {
-        $field_obj = $this->get_model()->field_settings_for($field_name);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            // you would think the DB has no NULLs for non-null label fields right? wrong!
-            // eg, a CPT model object could have an entry in the posts table, but no
-            // entry in the meta table. Meaning that all its columns in the meta table
-            // are null! yikes! so when we find one like that, use defaults for its meta columns
-            if ($field_value_from_db === null) {
-                if ($field_obj->is_nullable()) {
-                    // if the field allows nulls, then let it be null
-                    $field_value = null;
-                } else {
-                    $field_value = $field_obj->get_default_value();
-                }
-            } else {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
-            }
-            $this->_fields[ $field_name ] = $field_value;
-            $this->_clear_cached_property($field_name);
-        }
-    }
-
-
-    /**
-     * Set custom select values for model.
-     *
-     * @param array $custom_select_values
-     */
-    public function setCustomSelectsValues(array $custom_select_values)
-    {
-        $this->custom_selection_results = $custom_select_values;
-    }
-
-
-    /**
-     * Returns the custom select value for the provided alias if its set.
-     * If not set, returns null.
-     *
-     * @param string $alias
-     * @return string|int|float|null
-     */
-    public function getCustomSelect($alias)
-    {
-        return $this->custom_selection_results[ $alias ] ?? null;
-    }
-
-
-    /**
-     * This sets the field value on the db column if it exists for the given $column_name or
-     * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
-     *
-     * @param string $field_name  Must be the exact column name.
-     * @param mixed  $field_value The value to set.
-     * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see EE_message::get_column_value for related documentation on the necessity of this method.
-     */
-    public function set_field_or_extra_meta($field_name, $field_value)
-    {
-        if ($this->get_model()->has_field($field_name)) {
-            $this->set($field_name, $field_value);
-            return true;
-        }
-        // ensure this object is saved first so that extra meta can be properly related.
-        $this->save();
-        return $this->update_extra_meta($field_name, $field_value);
-    }
-
-
-    /**
-     * This retrieves the value of the db column set on this class or if that's not present
-     * it will attempt to retrieve from extra_meta if found.
-     * Example Usage:
-     * Via EE_Message child class:
-     * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
-     * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
-     * also have additional main fields specific to the messenger.  The system accommodates those extra
-     * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
-     * value for those extra fields dynamically via the EE_message object.
-     *
-     * @param string $field_name expecting the fully qualified field name.
-     * @return mixed|null  value for the field if found.  null if not found.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_field_or_extra_meta($field_name)
-    {
-        if ($this->get_model()->has_field($field_name)) {
-            $column_value = $this->get($field_name);
-        } else {
-            // This isn't a column in the main table, let's see if it is in the extra meta.
-            $column_value = $this->get_extra_meta($field_name, true, null);
-        }
-        return $column_value;
-    }
-
-
-    /**
-     * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
-     * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
-     * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
-     * available to all child classes that may be using the EE_Datetime_Field for a field data type.
-     *
-     * @access public
-     * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function set_timezone($timezone = '')
-    {
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        // make sure we clear all cached properties because they won't be relevant now
-        $this->_clear_cached_properties();
-        // make sure we update field settings and the date for all EE_Datetime_Fields
-        $model_fields = $this->get_model()->field_settings(false);
-        foreach ($model_fields as $field_name => $field_obj) {
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $field_obj->set_timezone($this->_timezone);
-                if (isset($this->_fields[ $field_name ]) && $this->_fields[ $field_name ] instanceof DateTime) {
-                    EEH_DTT_Helper::setTimezone($this->_fields[ $field_name ], new DateTimeZone($this->_timezone));
-                }
-            }
-        }
-    }
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string timezone string
-     */
-    public function get_timezone()
-    {
-        return $this->_timezone;
-    }
-
-
-    /**
-     * This sets the internal date format to what is sent in to be used as the new default for the class
-     * internally instead of wp set date format options
-     *
-     * @param string|null $format should be a format recognizable by PHP date() functions.
-     * @since 4.6
-     */
-    public function set_date_format(?string $format)
-    {
-        $this->_dt_frmt = new DateFormat($format);
-        // clear cached_properties because they won't be relevant now.
-        $this->_clear_cached_properties();
-    }
-
-
-    /**
-     * This sets the internal time format string to what is sent in to be used as the new default for the
-     * class internally instead of wp set time format options.
-     *
-     * @param string|null $format should be a format recognizable by PHP date() functions.
-     * @since 4.6
-     */
-    public function set_time_format(?string $format)
-    {
-        $this->_tm_frmt = new TimeFormat($format);
-        // clear cached_properties because they won't be relevant now.
-        $this->_clear_cached_properties();
-    }
-
-
-    /**
-     * This returns the current internal set format for the date and time formats.
-     *
-     * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
-     *                             where the first value is the date format and the second value is the time format.
-     * @return string|array
-     */
-    public function get_format($full = true)
-    {
-        return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : [$this->_dt_frmt, $this->_tm_frmt];
-    }
-
-
-    /**
-     * cache
-     * stores the passed model object on the current model object.
-     * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
-     *
-     * @param string        $relation_name   one of the keys in the _model_relations array on the model. Eg
-     *                                       'Registration' associated with this model object
-     * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
-     *                                       that could be a payment or a registration)
-     * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
-     *                                       items which will be stored in an array on this object
-     * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
-     *                                       related thing, no array)
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function cache($relation_name = '', $object_to_cache = null, $cache_id = null)
-    {
-        // its entirely possible that there IS no related object yet in which case there is nothing to cache.
-        if (! $object_to_cache instanceof EE_Base_Class) {
-            return false;
-        }
-        // also get "how" the object is related, or throw an error
-        if (! $relationship_to_model = $this->get_model()->related_settings_for($relation_name)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
-                    $relation_name,
-                    get_class($this)
-                )
-            );
-        }
-        // how many things are related ?
-        if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            // if it's a "belongs to" relationship, then there's only one related model object
-            // eg, if this is a registration, there's only 1 attendee for it
-            // so for these model objects just set it to be cached
-            $this->_model_relations[ $relation_name ] = $object_to_cache;
-            $return                                   = true;
-        } else {
-            // otherwise, this is the "many" side of a one to many relationship,
-            // so we'll add the object to the array of related objects for that type.
-            // eg: if this is an event, there are many registrations for that event,
-            // so we cache the registrations in an array
-            if (! is_array($this->_model_relations[ $relation_name ])) {
-                // if for some reason, the cached item is a model object,
-                // then stick that in the array, otherwise start with an empty array
-                $this->_model_relations[ $relation_name ] =
-                    $this->_model_relations[ $relation_name ] instanceof EE_Base_Class
-                        ? [$this->_model_relations[ $relation_name ]]
-                        : [];
-            }
-            // first check for a cache_id which is normally empty
-            if (! empty($cache_id)) {
-                // if the cache_id exists, then it means we are purposely trying to cache this
-                // with a known key that can then be used to retrieve the object later on
-                $this->_model_relations[ $relation_name ][ $cache_id ] = $object_to_cache;
-                $return                                                = $cache_id;
-            } elseif ($object_to_cache->ID()) {
-                // OR the cached object originally came from the db, so let's just use it's PK for an ID
-                $this->_model_relations[ $relation_name ][ $object_to_cache->ID() ] = $object_to_cache;
-                $return                                                             = $object_to_cache->ID();
-            } else {
-                // OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
-                $this->_model_relations[ $relation_name ][] = $object_to_cache;
-                // move the internal pointer to the end of the array
-                end($this->_model_relations[ $relation_name ]);
-                // and grab the key so that we can return it
-                $return = key($this->_model_relations[ $relation_name ]);
-            }
-        }
-        return $return;
-    }
-
-
-    /**
-     * For adding an item to the cached_properties property.
-     *
-     * @access protected
-     * @param string      $fieldname the property item the corresponding value is for.
-     * @param mixed       $value     The value we are caching.
-     * @param string|null $cache_type
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _set_cached_property($fieldname, $value, $cache_type = null)
-    {
-        // first make sure this property exists
-        $this->get_model()->field_settings_for($fieldname);
-        $cache_type = empty($cache_type) ? 'standard' : $cache_type;
-
-        $this->_cached_properties[ $fieldname ][ $cache_type ] = $value;
-    }
-
-
-    /**
-     * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
-     * This also SETS the cache if we return the actual property!
-     *
-     * @param string $fieldname        the name of the property we're trying to retrieve
-     * @param bool   $pretty
-     * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
-     *                                 (in cases where the same property may be used for different outputs
-     *                                 - i.e. datetime, money etc.)
-     *                                 It can also accept certain pre-defined "schema" strings
-     *                                 to define how to output the property.
-     *                                 see the field's prepare_for_pretty_echoing for what strings can be used
-     * @return mixed                   whatever the value for the property is we're retrieving
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
-    {
-        // verify the field exists
-        $model = $this->get_model();
-        $model->field_settings_for($fieldname);
-        $cache_type = $pretty ? 'pretty' : 'standard';
-        $cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
-        if (isset($this->_cached_properties[ $fieldname ][ $cache_type ])) {
-            return $this->_cached_properties[ $fieldname ][ $cache_type ];
-        }
-        $value = $this->_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
-        $this->_set_cached_property($fieldname, $value, $cache_type);
-        return $value;
-    }
-
-
-    /**
-     * If the cache didn't fetch the needed item, this fetches it.
-     *
-     * @param string $fieldname
-     * @param bool   $pretty
-     * @param string $extra_cache_ref
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
-    {
-        $field_obj = $this->get_model()->field_settings_for($fieldname);
-        // If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
-        if ($field_obj instanceof EE_Datetime_Field) {
-            $this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
-        }
-        if (! isset($this->_fields[ $fieldname ])) {
-            $this->_fields[ $fieldname ] = null;
-        }
-        return $pretty
-            ? $field_obj->prepare_for_pretty_echoing($this->_fields[ $fieldname ], $extra_cache_ref)
-            : $field_obj->prepare_for_get($this->_fields[ $fieldname ]);
-    }
-
-
-    /**
-     * set timezone, formats, and output for EE_Datetime_Field objects
-     *
-     * @param EE_Datetime_Field $datetime_field
-     * @param bool              $pretty
-     * @param null              $date_or_time
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _prepare_datetime_field(
-        EE_Datetime_Field $datetime_field,
-        $pretty = false,
-        $date_or_time = null
-    ) {
-        $datetime_field->set_timezone($this->_timezone);
-        $datetime_field->set_date_format($this->_dt_frmt, $pretty);
-        $datetime_field->set_time_format($this->_tm_frmt, $pretty);
-        // set the output returned
-        switch ($date_or_time) {
-            case 'D':
-                $datetime_field->set_date_time_output('date');
-                break;
-            case 'T':
-                $datetime_field->set_date_time_output('time');
-                break;
-            default:
-                $datetime_field->set_date_time_output();
-        }
-    }
-
-
-    /**
-     * This just takes care of clearing out the cached_properties
-     *
-     * @return void
-     */
-    protected function _clear_cached_properties()
-    {
-        $this->_cached_properties = [];
-    }
-
-
-    /**
-     * This just clears out ONE property if it exists in the cache
-     *
-     * @param string $property_name the property to remove if it exists (from the _cached_properties array)
-     * @return void
-     */
-    protected function _clear_cached_property($property_name)
-    {
-        if (isset($this->_cached_properties[ $property_name ])) {
-            unset($this->_cached_properties[ $property_name ]);
-        }
-    }
-
-
-    /**
-     * Ensures that this related thing is a model object.
-     *
-     * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
-     * @param string $model_name   name of the related thing, eg 'Attendee',
-     * @return EE_Base_Class
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
-    {
-        $other_model_instance = self::_get_model_instance_with_name(
-            self::_get_model_classname($model_name),
-            $this->_timezone
-        );
-        return $other_model_instance->ensure_is_obj($object_or_id);
-    }
-
-
-    /**
-     * Forgets the cached model of the given relation Name. So the next time we request it,
-     * we will fetch it again from the database. (Handy if you know it's changed somehow).
-     * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
-     * then only remove that one object from our cached array. Otherwise, clear the entire list
-     *
-     * @param string $relation_name                        one of the keys in the _model_relations array on the model.
-     *                                                     Eg 'Registration'
-     * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
-     *                                                     if you intend to use $clear_all = TRUE, or the relation only
-     *                                                     has 1 object anyway (ie, it's a BelongsToRelation)
-     * @param bool   $clear_all                            This flags clearing the entire cache relation property if
-     *                                                     this is HasMany or HABTM.
-     * @return EE_Base_Class|bool                          entity that was cleared from the cache,
-     *                                                     or true if we requested to remove a relation from all
-     *                                                     or false if entity was never cached anyway.
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function clear_cache($relation_name, $object_to_remove_or_index_into_array = null, $clear_all = false)
-    {
-        $relationship_to_model = $this->get_model()->related_settings_for($relation_name);
-        $index_in_cache        = '';
-        if (! $relationship_to_model) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no relationship to %s on a %s. Cannot clear that cache', 'event_espresso'),
-                    $relation_name,
-                    get_class($this)
-                )
-            );
-        }
-        if ($clear_all) {
-            $obj_removed                              = true;
-            $this->_model_relations[ $relation_name ] = null;
-        } elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            $obj_removed                              = $this->_model_relations[ $relation_name ];
-            $this->_model_relations[ $relation_name ] = null;
-        } else {
-            if (
-                $object_to_remove_or_index_into_array instanceof EE_Base_Class
-                && $object_to_remove_or_index_into_array->ID()
-            ) {
-                $index_in_cache = $object_to_remove_or_index_into_array->ID();
-                if (
-                    is_array($this->_model_relations[ $relation_name ])
-                    && ! isset($this->_model_relations[ $relation_name ][ $index_in_cache ])
-                ) {
-                    $index_found_at = null;
-                    // find this object in the array even though it has a different key
-                    foreach ($this->_model_relations[ $relation_name ] as $index => $obj) {
-                        /** @noinspection TypeUnsafeComparisonInspection */
-                        if (
-                            $obj instanceof EE_Base_Class
-                            && (
-                                $obj == $object_to_remove_or_index_into_array
-                                || $obj->ID() === $object_to_remove_or_index_into_array->ID()
-                            )
-                        ) {
-                            $index_found_at = $index;
-                            break;
-                        }
-                    }
-                    if ($index_found_at) {
-                        $index_in_cache = $index_found_at;
-                    } else {
-                        // it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
-                        // if it wasn't in it to begin with. So we're done
-                        return $object_to_remove_or_index_into_array;
-                    }
-                }
-            } elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
-                // so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
-                foreach ($this->get_all_from_cache($relation_name) as $index => $potentially_obj_we_want) {
-                    /** @noinspection TypeUnsafeComparisonInspection */
-                    if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
-                        $index_in_cache = $index;
-                    }
-                }
-            } else {
-                $index_in_cache = $object_to_remove_or_index_into_array;
-            }
-            // supposedly we've found it. But it could just be that the client code
-            // provided a bad index/object
-            if (isset($this->_model_relations[ $relation_name ][ $index_in_cache ])) {
-                $obj_removed = $this->_model_relations[ $relation_name ][ $index_in_cache ];
-                unset($this->_model_relations[ $relation_name ][ $index_in_cache ]);
-            } else {
-                // that thing was never cached anyway.
-                $obj_removed = false;
-            }
-        }
-        return $obj_removed;
-    }
-
-
-    /**
-     * update_cache_after_object_save
-     * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
-     * obtained after being saved to the db
-     *
-     * @param string        $relation_name      - the type of object that is cached
-     * @param EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
-     * @param string        $current_cache_id   - the ID that was used when originally caching the object
-     * @return boolean TRUE on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function update_cache_after_object_save(
-        $relation_name,
-        EE_Base_Class $newly_saved_object,
-        $current_cache_id = ''
-    ) {
-        // verify that incoming object is of the correct type
-        $obj_class = 'EE_' . $relation_name;
-        if ($newly_saved_object instanceof $obj_class) {
-            /* @type EE_Base_Class $newly_saved_object */
-            // now get the type of relation
-            $relationship_to_model = $this->get_model()->related_settings_for($relation_name);
-            // if this is a 1:1 relationship
-            if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-                // then just replace the cached object with the newly saved object
-                $this->_model_relations[ $relation_name ] = $newly_saved_object;
-                return true;
-                // or if it's some kind of sordid feral polyamorous relationship...
-            }
-            if (
-                is_array($this->_model_relations[ $relation_name ])
-                && isset($this->_model_relations[ $relation_name ][ $current_cache_id ])
-            ) {
-                // then remove the current cached item
-                unset($this->_model_relations[ $relation_name ][ $current_cache_id ]);
-                // and cache the newly saved object using it's new ID
-                $this->_model_relations[ $relation_name ][ $newly_saved_object->ID() ] = $newly_saved_object;
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
-     *
-     * @param string $relation_name
-     * @return EE_Base_Class
-     */
-    public function get_one_from_cache($relation_name)
-    {
-        $cached_array_or_object = $this->_model_relations[ $relation_name ] ?? null;
-        if (is_array($cached_array_or_object)) {
-            return array_shift($cached_array_or_object);
-        }
-        return $cached_array_or_object;
-    }
-
-
-    /**
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
-     *
-     * @param string $relation_name
-     * @return EE_Base_Class[] NOT necessarily indexed by primary keys
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_from_cache($relation_name)
-    {
-        $objects = $this->_model_relations[ $relation_name ] ?? [];
-        // if the result is not an array, but exists, make it an array
-        $objects = is_array($objects)
-            ? $objects
-            : [$objects];
-        // bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
-        // basically, if this model object was stored in the session, and these cached model objects
-        // already have IDs, let's make sure they're in their model's entity mapper
-        // otherwise we will have duplicates next time we call
-        // EE_Registry::instance()->load_model( $relation_name )->get_one_by_ID( $result->ID() );
-        $model = EE_Registry::instance()->load_model($relation_name);
-        foreach ($objects as $model_object) {
-            if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
-                // ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
-                if ($model_object->ID()) {
-                    $model->add_to_entity_map($model_object);
-                }
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
-                            'event_espresso'
-                        ),
-                        $relation_name,
-                        gettype($model_object)
-                    )
-                );
-            }
-        }
-        return $objects;
-    }
-
-
-    /**
-     * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param int   $limit              How many objects to return.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class[]
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function next_x($field_to_order_by = null, $limit = 1, $query_params = [], $columns_to_select = null)
-    {
-        $model         = $this->get_model();
-        $field         = empty($field_to_order_by) && $model->has_primary_key_field()
-            ? $model->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field)
-            ? $this->get($field)
-            : null;
-        if (empty($field) || empty($current_value)) {
-            return [];
-        }
-        return $model->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
-    }
-
-
-    /**
-     * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param int   $limit              How many objects to return.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class[]
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function previous_x(
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = [],
-        $columns_to_select = null
-    ) {
-        $model         = $this->get_model();
-        $field         = empty($field_to_order_by) && $model->has_primary_key_field()
-            ? $model->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return [];
-        }
-        return $model->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
-    }
-
-
-    /**
-     * Returns the next EE_Base_Class object in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function next($field_to_order_by = null, $query_params = [], $columns_to_select = null)
-    {
-        $model         = $this->get_model();
-        $field         = empty($field_to_order_by) && $model->has_primary_key_field()
-            ? $model->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return [];
-        }
-        return $model->next($current_value, $field, $query_params, $columns_to_select);
-    }
-
-
-    /**
-     * Returns the previous EE_Base_Class object in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
-     *                                  you can indicate just the column you want returned
-     * @return array|EE_Base_Class
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function previous($field_to_order_by = null, $query_params = [], $columns_to_select = null)
-    {
-        $model         = $this->get_model();
-        $field         = empty($field_to_order_by) && $model->has_primary_key_field()
-            ? $model->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return [];
-        }
-        return $model->previous($current_value, $field, $query_params, $columns_to_select);
-    }
-
-
-    /**
-     * verifies that the specified field is of the correct type
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get($field_name, $extra_cache_ref = null)
-    {
-        return $this->_get_cached_property($field_name, false, $extra_cache_ref);
-    }
-
-
-    /**
-     * This method simply returns the RAW unprocessed value for the given property in this class
-     *
-     * @param string $field_name A valid fieldname
-     * @return mixed              Whatever the raw value stored on the property is.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
-     */
-    public function get_raw($field_name)
-    {
-        $field_settings = $this->get_model()->field_settings_for($field_name);
-        return $field_settings instanceof EE_Datetime_Field && $this->_fields[ $field_name ] instanceof DateTime
-            ? $this->_fields[ $field_name ]->format('U')
-            : $this->_fields[ $field_name ];
-    }
-
-
-    /**
-     * This is used to return the internal DateTime object used for a field that is a
-     * EE_Datetime_Field.
-     *
-     * @param string $field_name               The field name retrieving the DateTime object.
-     * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
-     * @throws EE_Error an error is set and false returned.  If the field IS an
-     *                                         EE_Datetime_Field and but the field value is null, then
-     *                                         just null is returned (because that indicates that likely
-     *                                         this field is nullable).
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_DateTime_object($field_name)
-    {
-        $field_settings = $this->get_model()->field_settings_for($field_name);
-        if (! $field_settings instanceof EE_Datetime_Field) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
-                        'event_espresso'
-                    ),
-                    $field_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return isset($this->_fields[ $field_name ]) && $this->_fields[ $field_name ] instanceof DateTime
-            ? clone $this->_fields[ $field_name ]
-            : null;
-    }
-
-
-    /**
-     * To be used in template to immediately echo out the value, and format it for output.
-     * Eg, should call stripslashes and whatnot before echoing
-     *
-     * @param string $field_name      the name of the field as it appears in the DB
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e($field_name, $extra_cache_ref = null)
-    {
-        echo wp_kses($this->get_pretty($field_name, $extra_cache_ref), AllowedTags::getWithFormTags());
-    }
-
-
-    /**
-     * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
-     * can be easily used as the value of form input.
-     *
-     * @param string $field_name
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function f($field_name)
-    {
-        $this->e($field_name, 'form_input');
-    }
-
-
-    /**
-     * Same as `f()` but just returns the value instead of echoing it
-     *
-     * @param string $field_name
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_f($field_name)
-    {
-        return (string) $this->get_pretty($field_name, 'form_input');
-    }
-
-
-    /**
-     * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this.
-     * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class
-     * to see what options are available.
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_pretty($field_name, $extra_cache_ref = null)
-    {
-        return $this->_get_cached_property($field_name, true, $extra_cache_ref);
-    }
-
-
-    /**
-     * This simply returns the datetime for the given field name
-     * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
-     * (and the equivalent e_date, e_time, e_datetime).
-     *
-     * @access   protected
-     * @param string      $field_name   Field on the instantiated EE_Base_Class child object
-     * @param string|null $date_format  valid datetime format used for date
-     *                                  (if '' then we just use the default on the field,
-     *                                  if NULL we use the last-used format)
-     * @param string|null $time_format  Same as above except this is for time format
-     * @param string|null $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
-     * @param bool|null   $echo         Whether the datetime is pretty echoing or just returned using vanilla get
-     * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
-     *                                  if field is not a valid dtt field, or void if echoing
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_datetime(
-        string $field_name,
-        ?string $date_format = '',
-        ?string $time_format = '',
-        ?string $date_or_time = '',
-        ?bool $echo = false
-    ) {
-        // clear cached property
-        $this->_clear_cached_property($field_name);
-        // reset format properties because they are used in get()
-        $this->_dt_frmt = $date_format ?: $this->_dt_frmt;
-        $this->_tm_frmt = $time_format ?: $this->_tm_frmt;
-        if ($echo) {
-            $this->e($field_name, $date_or_time);
-            return '';
-        }
-        return $this->get($field_name, $date_or_time);
-    }
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param string $field_name name of model object datetime field holding the value
-     * @param string $format     format for the date returned (if NULL we use default in dt_frmt property)
-     * @return string            datetime value formatted
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_date($field_name, $format = '')
-    {
-        return $this->_get_datetime($field_name, $format, null, 'D');
-    }
-
-
-    /**
-     * @param        $field_name
-     * @param string $format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_date($field_name, $format = '')
-    {
-        $this->_get_datetime($field_name, $format, null, 'D', true);
-    }
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param string $field_name name of model object datetime field holding the value
-     * @param string $format     format for the time returned ( if NULL we use default in tm_frmt property)
-     * @return string             datetime value formatted
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_time($field_name, $format = '')
-    {
-        return $this->_get_datetime($field_name, null, $format, 'T');
-    }
-
-
-    /**
-     * @param        $field_name
-     * @param string $format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_time($field_name, $format = '')
-    {
-        $this->_get_datetime($field_name, null, $format, 'T', true);
-    }
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
-     * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param string $field_name  name of model object datetime field holding the value
-     * @param string $date_format format for the date returned (if NULL we use default in dt_frmt property)
-     * @param string $time_format format for the time returned (if NULL we use default in tm_frmt property)
-     * @return string             datetime value formatted
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_datetime($field_name, $date_format = '', $time_format = '')
-    {
-        return $this->_get_datetime($field_name, $date_format, $time_format);
-    }
-
-
-    /**
-     * @param string $field_name
-     * @param string $date_format
-     * @param string $time_format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_datetime($field_name, $date_format = '', $time_format = '')
-    {
-        $this->_get_datetime($field_name, $date_format, $time_format, null, true);
-    }
-
-
-    /**
-     * Get the i8ln value for a date using the WordPress @param string $field_name The EE_Datetime_Field reference for
-     *                           the date being retrieved.
-     *
-     * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
-     *                           on the object will be used.
-     * @return string Date and time string in set locale or false if no field exists for the given
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     *                           field name.
-     * @see date_i18n function.
-     */
-    public function get_i18n_datetime(string $field_name, string $format = ''): string
-    {
-        $format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
-        return date_i18n(
-            $format,
-            EEH_DTT_Helper::get_timestamp_with_offset(
-                $this->get_raw($field_name),
-                $this->_timezone
-            )
-        );
-    }
-
-
-    /**
-     * This method validates whether the given field name is a valid field on the model object as well as it is of a
-     * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
-     * thrown.
-     *
-     * @param string $field_name The field name being checked
-     * @return EE_Datetime_Field
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_dtt_field_settings($field_name)
-    {
-        $field = $this->get_model()->field_settings_for($field_name);
-        // check if field is dtt
-        if ($field instanceof EE_Datetime_Field) {
-            return $field;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
-                    'event_espresso'
-                ),
-                $field_name,
-                self::_get_model_classname(get_class($this))
-            )
-        );
-    }
-
-
-
-
-    /**
-     * NOTE ABOUT BELOW:
-     * These convenience date and time setters are for setting date and time independently.  In other words you might
-     * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
-     * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
-     * method and make sure you send the entire datetime value for setting.
-     */
-    /**
-     * sets the time on a datetime property
-     *
-     * @access protected
-     * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
-     * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _set_time_for($time, $fieldname)
-    {
-        $this->_set_date_time('T', $time, $fieldname);
-    }
-
-
-    /**
-     * sets the date on a datetime property
-     *
-     * @access protected
-     * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
-     * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _set_date_for($date, $fieldname)
-    {
-        $this->_set_date_time('D', $date, $fieldname);
-    }
-
-
-    /**
-     * This takes care of setting a date or time independently on a given model object property. This method also
-     * verifies that the given field_name matches a model object property and is for a EE_Datetime_Field field
-     *
-     * @access protected
-     * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
-     * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
-     * @param string          $field_name     the name of the field the date OR time is being set on (must match a
-     *                                        EE_Datetime_Field property)
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _set_date_time(string $what, $datetime_value, string $field_name)
-    {
-        $field = $this->_get_dtt_field_settings($field_name);
-        $field->set_timezone($this->_timezone);
-        $field->set_date_format($this->_dt_frmt);
-        $field->set_time_format($this->_tm_frmt);
-        switch ($what) {
-            case 'T':
-                $this->_fields[ $field_name ] = $field->prepare_for_set_with_new_time(
-                    $datetime_value,
-                    $this->_fields[ $field_name ]
-                );
-                $this->_has_changes           = true;
-                break;
-            case 'D':
-                $this->_fields[ $field_name ] = $field->prepare_for_set_with_new_date(
-                    $datetime_value,
-                    $this->_fields[ $field_name ]
-                );
-                $this->_has_changes           = true;
-                break;
-            case 'B':
-                $this->_fields[ $field_name ] = $field->prepare_for_set($datetime_value);
-                $this->_has_changes           = true;
-                break;
-        }
-        $this->_clear_cached_property($field_name);
-    }
-
-
-    /**
-     * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
-     * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
-     * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
-     * that could lead to some unexpected results!
-     *
-     * @access public
-     * @param string $field_name               This is the name of the field on the object that contains the date/time
-     *                                         value being returned.
-     * @param string $callback                 must match a valid method in this class (defaults to get_datetime)
-     * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
-     * @param string $prepend                  You can include something to prepend on the timestamp
-     * @param string $append                   You can include something to append on the timestamp
-     * @return string timestamp
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function display_in_my_timezone(
-        $field_name,
-        $callback = 'get_datetime',
-        $args = null,
-        $prepend = '',
-        $append = ''
-    ) {
-        $timezone = EEH_DTT_Helper::get_timezone();
-        if ($timezone === $this->_timezone) {
-            return '';
-        }
-        $original_timezone = $this->_timezone;
-        $this->set_timezone($timezone);
-        $fn   = (array) $field_name;
-        $args = array_merge($fn, (array) $args);
-        if (! method_exists($this, $callback)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
-                        'event_espresso'
-                    ),
-                    $callback
-                )
-            );
-        }
-        $args   = (array) $args;
-        $return = $prepend . call_user_func_array([$this, $callback], $args) . $append;
-        $this->set_timezone($original_timezone);
-        return $return;
-    }
-
-
-    /**
-     * Deletes this model object.
-     * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
-     * override
-     * `EE_Base_Class::_delete` NOT this class.
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function delete()
-    {
-        /**
-         * Called just before the `EE_Base_Class::_delete` method call.
-         * Note:
-         * `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
-         * should be aware that `_delete` may not always result in a permanent delete.
-         * For example, `EE_Soft_Delete_Base_Class::_delete`
-         * soft deletes (trash) the object and does not permanently delete it.
-         *
-         * @param EE_Base_Class $model_object about to be 'deleted'
-         */
-        do_action('AHEE__EE_Base_Class__delete__before', $this);
-        $deleted = $this->_delete();
-        /**
-         * Called just after the `EE_Base_Class::_delete` method call.
-         * Note:
-         * `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
-         * should be aware that `_delete` may not always result in a permanent delete.
-         * For example `EE_Soft_Base_Class::_delete`
-         * soft deletes (trash) the object and does not permanently delete it.
-         *
-         * @param EE_Base_Class $model_object that was just 'deleted'
-         * @param boolean       $deleted
-         */
-        do_action('AHEE__EE_Base_Class__delete__end', $this, $deleted);
-        return $deleted;
-    }
-
-
-    /**
-     * Calls the specific delete method for the instantiated class.
-     * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
-     * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
-     * `EE_Base_Class::delete`
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _delete(): int
-    {
-        return $this->delete_permanently();
-    }
-
-
-    /**
-     * Deletes this model object permanently from db
-     * (but keep in mind related models may block the delete and return an error)
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function delete_permanently(): int
-    {
-        /**
-         * Called just before HARD deleting a model object
-         *
-         * @param EE_Base_Class $model_object about to be 'deleted'
-         */
-        do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
-        $model  = $this->get_model();
-        $result = $model->delete_permanently_by_ID($this->ID());
-        $this->refresh_cache_of_related_objects();
-        /**
-         * Called just after HARD deleting a model object
-         *
-         * @param EE_Base_Class $model_object that was just 'deleted'
-         * @param boolean       $result
-         */
-        do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
-        return $result;
-    }
-
-
-    /**
-     * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
-     * related model objects
-     *
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function refresh_cache_of_related_objects()
-    {
-        $model = $this->get_model();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if (! empty($this->_model_relations[ $relation_name ])) {
-                $related_objects = $this->_model_relations[ $relation_name ];
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                    // this relation only stores a single model object, not an array
-                    // but let's make it consistent
-                    $related_objects = [$related_objects];
-                }
-                foreach ($related_objects as $related_object) {
-                    // only refresh their cache if they're in memory
-                    if ($related_object instanceof EE_Base_Class) {
-                        $related_object->clear_cache(
-                            $model->get_this_model_name(),
-                            $this
-                        );
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     *        Saves this object to the database. An array may be supplied to set some values on this
-     * object just before saving.
-     *
-     * @access public
-     * @param array $set_cols_n_values keys are field names, values are their new values,
-     *                                 if provided during the save() method (often client code will change the fields'
-     *                                 values before calling save)
-     * @return bool|int|string         1 on a successful update
-     *                                 the ID of the new entry on insert
-     *                                 0 on failure or if the model object isn't allowed to persist
-     *                                 (as determined by EE_Base_Class::allow_persist())
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function save($set_cols_n_values = [])
-    {
-        $model = $this->get_model();
-        /**
-         * Filters the fields we're about to save on the model object
-         *
-         * @param array         $set_cols_n_values
-         * @param EE_Base_Class $model_object
-         */
-        $set_cols_n_values = (array) apply_filters(
-            'FHEE__EE_Base_Class__save__set_cols_n_values',
-            $set_cols_n_values,
-            $this
-        );
-        // set attributes as provided in $set_cols_n_values
-        foreach ($set_cols_n_values as $column => $value) {
-            $this->set($column, $value);
-        }
-        // no changes ? then don't do anything
-        if (! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
-            return 0;
-        }
-        /**
-         * Saving a model object.
-         * Before we perform a save, this action is fired.
-         *
-         * @param EE_Base_Class $model_object the model object about to be saved.
-         */
-        do_action('AHEE__EE_Base_Class__save__begin', $this);
-        if (! $this->allow_persist()) {
-            return 0;
-        }
-        // now get current attribute values
-        $save_cols_n_values = $this->_fields;
-        // if the object already has an ID, update it. Otherwise, insert it
-        // also: change the assumption about values passed to the model NOT being prepare dby the model object.
-        // They have been
-        $old_assumption_concerning_value_preparation = $model
-            ->get_assumption_concerning_values_already_prepared_by_model_object();
-        $model->assume_values_already_prepared_by_model_object(true);
-        // does this model have an autoincrement PK?
-        if ($model->has_primary_key_field()) {
-            if ($model->get_primary_key_field()->is_auto_increment()) {
-                // ok check if it's set, if so: update; if not, insert
-                if (! empty($save_cols_n_values[ $model->primary_key_name() ])) {
-                    $results = $model->update_by_ID($save_cols_n_values, $this->ID());
-                } else {
-                    unset($save_cols_n_values[ $model->primary_key_name() ]);
-                    $results = $model->insert($save_cols_n_values);
-                    if ($results) {
-                        // if successful, set the primary key
-                        // but don't use the normal SET method, because it will check if
-                        // an item with the same ID exists in the mapper & db, then
-                        // will find it in the db (because we just added it) and THAT object
-                        // will get added to the mapper before we can add this one!
-                        // but if we just avoid using the SET method, all that headache can be avoided
-                        $pk_field_name                   = $model->primary_key_name();
-                        $this->_fields[ $pk_field_name ] = $results;
-                        $this->_clear_cached_property($pk_field_name);
-                        $model->add_to_entity_map($this);
-                        $this->_update_cached_related_model_objs_fks();
-                    }
-                }
-            } else {// PK is NOT auto-increment
-                // so check if one like it already exists in the db
-                if ($model->exists_by_ID($this->ID())) {
-                    if (WP_DEBUG && ! $this->in_entity_map()) {
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__(
-                                    'Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
-                                    'event_espresso'
-                                ),
-                                get_class($this),
-                                get_class($model) . '::instance()->add_to_entity_map()',
-                                get_class($model) . '::instance()->get_one_by_ID()',
-                                '<br />'
-                            )
-                        );
-                    }
-                    $results = $model->update_by_ID($save_cols_n_values, $this->ID());
-                } else {
-                    $results = $model->insert($save_cols_n_values);
-                    $this->_update_cached_related_model_objs_fks();
-                }
-            }
-        } else {// there is NO primary key
-            $already_in_db = false;
-            foreach ($model->unique_indexes() as $index) {
-                $uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
-                if ($model->exists([$uniqueness_where_params])) {
-                    $already_in_db = true;
-                }
-            }
-            if ($already_in_db) {
-                $combined_pk_fields_n_values = array_intersect_key(
-                    $save_cols_n_values,
-                    $model->get_combined_primary_key_fields()
-                );
-                $results                     = $model->update(
-                    $save_cols_n_values,
-                    $combined_pk_fields_n_values
-                );
-            } else {
-                $results = $model->insert($save_cols_n_values);
-            }
-        }
-        // restore the old assumption about values being prepared by the model object
-        $model->assume_values_already_prepared_by_model_object(
-            $old_assumption_concerning_value_preparation
-        );
-        /**
-         * After saving the model object this action is called
-         *
-         * @param EE_Base_Class $model_object which was just saved
-         * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
-         *                                    the new ID (or 0 if an error occurred and it wasn't updated)
-         */
-        do_action('AHEE__EE_Base_Class__save__end', $this, $results);
-        $this->_has_changes = false;
-        return $results;
-    }
-
-
-    /**
-     * Updates the foreign key on related models objects pointing to this to have this model object's ID
-     * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
-     * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
-     * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
-     * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
-     * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
-     * or not they exist in the DB (if they do, their DB records will be automatically updated)
-     *
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _update_cached_related_model_objs_fks()
-    {
-        $model = $this->get_model();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Has_Many_Relation) {
-                foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
-                    $fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
-                        $model->get_this_model_name()
-                    );
-                    $related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
-                    if ($related_model_obj_in_cache->ID()) {
-                        $related_model_obj_in_cache->save();
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Saves this model object and its NEW cached relations to the database.
-     * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
-     * In order for that to work, we would need to mark model objects as dirty/clean...
-     * because otherwise, there's a potential for infinite looping of saving
-     * Saves the cached related model objects, and ensures the relation between them
-     * and this object and properly setup
-     *
-     * @return int ID of new model object on save; 0 on failure+
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function save_new_cached_related_model_objs()
-    {
-        // make sure this has been saved
-        if (! $this->ID()) {
-            $id = $this->save();
-        } else {
-            $id = $this->ID();
-        }
-        // now save all the NEW cached model objects  (ie they don't exist in the DB)
-        foreach ($this->get_model()->relation_settings() as $relation_name => $relationObj) {
-            if ($this->_model_relations[ $relation_name ]) {
-                // is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
-                // or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
-                /* @var $related_model_obj EE_Base_Class */
-                if ($relationObj instanceof EE_Belongs_To_Relation) {
-                    // add a relation to that relation type (which saves the appropriate thing in the process)
-                    // but ONLY if it DOES NOT exist in the DB
-                    $related_model_obj = $this->_model_relations[ $relation_name ];
-                    // if( ! $related_model_obj->ID()){
-                    $this->_add_relation_to($related_model_obj, $relation_name);
-                    $related_model_obj->save_new_cached_related_model_objs();
-                    // }
-                } else {
-                    foreach ($this->_model_relations[ $relation_name ] as $related_model_obj) {
-                        // add a relation to that relation type (which saves the appropriate thing in the process)
-                        // but ONLY if it DOES NOT exist in the DB
-                        // if( ! $related_model_obj->ID()){
-                        $this->_add_relation_to($related_model_obj, $relation_name);
-                        $related_model_obj->save_new_cached_related_model_objs();
-                        // }
-                    }
-                }
-            }
-        }
-        return $id;
-    }
-
-
-    /**
-     * for getting a model while instantiated.
-     *
-     * @return EEM_Base | EEM_CPT_Base
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_model()
-    {
-        if (! $this->_model) {
-            $modelName    = self::_get_model_classname(get_class($this));
-            $this->_model = self::_get_model_instance_with_name($modelName, $this->_timezone);
-        } else {
-            $this->_model->set_timezone($this->_timezone);
-        }
-        return $this->_model;
-    }
-
-
-    /**
-     * @param $props_n_values
-     * @param $classname
-     * @return mixed bool|EE_Base_Class|EEM_CPT_Base
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected static function _get_object_from_entity_mapper($props_n_values, $classname)
-    {
-        // TODO: will not work for Term_Relationships because they have no PK!
-        $primary_id_ref = self::_get_primary_key_name($classname);
-        if (
-            array_key_exists($primary_id_ref, $props_n_values)
-            && ! empty($props_n_values[ $primary_id_ref ])
-        ) {
-            $id = $props_n_values[ $primary_id_ref ];
-            return self::_get_model($classname)->get_from_entity_map($id);
-        }
-        return false;
-    }
-
-
-    /**
-     * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
-     * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
-     * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
-     * we return false.
-     *
-     * @param array  $props_n_values    incoming array of properties and their values
-     * @param string $classname         the classname of the child class
-     * @param null   $timezone
-     * @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 mixed (EE_Base_Class|bool)
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _check_for_object($props_n_values, $classname, $timezone = '', $date_formats = [])
-    {
-        $existing = null;
-        $model    = self::_get_model($classname, $timezone);
-        if ($model->has_primary_key_field()) {
-            $primary_id_ref = self::_get_primary_key_name($classname);
-            if (
-                array_key_exists($primary_id_ref, $props_n_values)
-                && ! empty($props_n_values[ $primary_id_ref ])
-            ) {
-                $existing = $model->get_one_by_ID(
-                    $props_n_values[ $primary_id_ref ]
-                );
-            }
-        } elseif ($model->has_all_combined_primary_key_fields($props_n_values)) {
-            // no primary key on this model, but there's still a matching item in the DB
-            $existing = self::_get_model($classname, $timezone)->get_one_by_ID(
-                self::_get_model($classname, $timezone)
-                    ->get_index_primary_key_string($props_n_values)
-            );
-        }
-        if ($existing) {
-            // set date formats if present before setting values
-            if (! empty($date_formats) && is_array($date_formats)) {
-                $existing->set_date_format($date_formats[0]);
-                $existing->set_time_format($date_formats[1]);
-            } else {
-                // set default formats for date and time
-                $existing->set_date_format(get_option('date_format'));
-                $existing->set_time_format(get_option('time_format'));
-            }
-            foreach ($props_n_values as $property => $field_value) {
-                $existing->set($property, $field_value);
-            }
-            return $existing;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets the EEM_*_Model for this class
-     *
-     * @access public now, as this is more convenient
-     * @param      $classname
-     * @param null $timezone
-     * @return EEM_Base
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _get_model($classname, $timezone = '')
-    {
-        // find model for this class
-        if (! $classname) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'What were you thinking calling _get_model(%s)?? You need to specify the class name',
-                        'event_espresso'
-                    ),
-                    $classname
-                )
-            );
-        }
-        $modelName = self::_get_model_classname($classname);
-        return self::_get_model_instance_with_name($modelName, $timezone);
-    }
-
-
-    /**
-     * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
-     *
-     * @param string $model_classname
-     * @param null   $timezone
-     * @return EEM_Base
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected static function _get_model_instance_with_name($model_classname, $timezone = '')
-    {
-        $model_classname = str_replace('EEM_', '', $model_classname);
-        $model           = EE_Registry::instance()->load_model($model_classname);
-        $model->set_timezone($timezone);
-        return $model;
-    }
-
-
-    /**
-     * If a model name is provided (eg Registration), gets the model classname for that model.
-     * Also works if a model class's classname is provided (eg EE_Registration).
-     *
-     * @param string|null $model_name
-     * @return string like EEM_Attendee
-     */
-    private static function _get_model_classname($model_name = '')
-    {
-        return strpos((string) $model_name, 'EE_') === 0
-            ? str_replace('EE_', 'EEM_', $model_name)
-            : 'EEM_' . $model_name;
-    }
-
-
-    /**
-     * returns the name of the primary key attribute
-     *
-     * @param null $classname
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _get_primary_key_name($classname = null)
-    {
-        if (! $classname) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('What were you thinking calling _get_primary_key_name(%s)', 'event_espresso'),
-                    $classname
-                )
-            );
-        }
-        return self::_get_model($classname)->get_primary_key_field()->get_name();
-    }
-
-
-    /**
-     * Gets the value of the primary key.
-     * If the object hasn't yet been saved, it should be whatever the model field's default was
-     * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
-     * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
-     *
-     * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function ID()
-    {
-        $model = $this->get_model();
-        // now that we know the name of the variable, use a variable variable to get its value and return its
-        if ($model->has_primary_key_field()) {
-            return $this->_fields[ $model->primary_key_name() ];
-        }
-        return $model->get_index_primary_key_string($this->_fields);
-    }
-
-
-    /**
-     * @param EE_Base_Class|int|string $otherModelObjectOrID
-     * @param string                   $relation_name
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function hasRelation($otherModelObjectOrID, string $relation_name): bool
-    {
-        $other_model = self::_get_model_instance_with_name(
-            self::_get_model_classname($relation_name),
-            $this->_timezone
-        );
-        $primary_key = $other_model->primary_key_name();
-        /** @var EE_Base_Class $otherModelObject */
-        $otherModelObject = $other_model->ensure_is_obj($otherModelObjectOrID, $relation_name);
-        return $this->count_related($relation_name, [[$primary_key => $otherModelObject->ID()]]) > 0;
-    }
-
-
-    /**
-     * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
-     * model is related to a group of events, the $relation_name should be 'Event', and should be a key in the EE
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
-     *
-     * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
-     * @param string $relation_name                    eg 'Events','Question',etc.
-     *                                                 an attendee to a group, you also want to specify which role they
-     *                                                 will have in that group. So you would use this parameter to
-     *                                                 specify array('role-column-name'=>'role-id')
-     * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
-     *                                                 allow you to further constrict the relation to being added.
-     *                                                 However, keep in mind that the columns (keys) given must match a
-     *                                                 column on the JOIN table and currently only the HABTM models
-     *                                                 accept these additional conditions.  Also remember that if an
-     *                                                 exact match isn't found for these extra cols/val pairs, then a
-     *                                                 NEW row is created in the join table.
-     * @param null   $cache_id
-     * @return EE_Base_Class the object the relation was added to
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function _add_relation_to(
-        $otherObjectModelObjectOrID,
-        $relation_name,
-        $extra_join_model_fields_n_values = [],
-        $cache_id = null
-    ) {
-        $model = $this->get_model();
-        // if this thing exists in the DB, save the relation to the DB
-        if ($this->ID()) {
-            $otherObject = $model->add_relationship_to(
-                $this,
-                $otherObjectModelObjectOrID,
-                $relation_name,
-                $extra_join_model_fields_n_values
-            );
-            // clear cache so future get_many_related and get_first_related() return new results.
-            $this->clear_cache($relation_name, $otherObject, true);
-            if ($otherObject instanceof EE_Base_Class) {
-                $otherObject->clear_cache($model->get_this_model_name(), $this);
-            }
-        } else {
-            // this thing doesn't exist in the DB,  so just cache it
-            if (! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
-                            'event_espresso'
-                        ),
-                        $otherObjectModelObjectOrID,
-                        get_class($this)
-                    )
-                );
-            }
-            $otherObject = $otherObjectModelObjectOrID;
-            $this->cache($relation_name, $otherObjectModelObjectOrID, $cache_id);
-        }
-        if ($otherObject instanceof EE_Base_Class) {
-            // fix the reciprocal relation too
-            if ($otherObject->ID()) {
-                // its saved so assumed relations exist in the DB, so we can just
-                // clear the cache so future queries use the updated info in the DB
-                $otherObject->clear_cache(
-                    $model->get_this_model_name(),
-                    null,
-                    true
-                );
-            } else {
-                // it's not saved, so it caches relations like this
-                $otherObject->cache($model->get_this_model_name(), $this);
-            }
-        }
-        return $otherObject;
-    }
-
-
-    /**
-     * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
-     * model is related to a group of events, the $relation_name should be 'Events', and should be a key in the EE
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
-     * from the cache
-     *
-     * @param mixed  $otherObjectModelObjectOrID
-     *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
-     *                to the DB yet
-     * @param string $relation_name
-     * @param array  $where_query
-     *                You can optionally include an array of key=>value pairs that allow you to further constrict the
-     *                relation to being added. However, keep in mind that the columns (keys) given must match a column
-     *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
-     *                remember that if an exact match isn't found for these extra cols/val pairs, then no row is
-     *                deleted.
-     * @return EE_Base_Class|bool   the related entity that was removed
-     *                              or true if multiple entities removed
-     *                              or false if nothing was cached
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function _remove_relation_to($otherObjectModelObjectOrID, $relation_name, $where_query = [])
-    {
-        if ($this->ID()) {
-            // if this exists in the DB, save the relation change to the DB too
-            $otherObject = $this->get_model()->remove_relationship_to(
-                $this,
-                $otherObjectModelObjectOrID,
-                $relation_name,
-                $where_query
-            );
-            $this->clear_cache(
-                $relation_name,
-                $otherObject
-            );
-        } else {
-            // this doesn't exist in the DB, just remove it from the cache
-            $otherObject = $this->clear_cache(
-                $relation_name,
-                $otherObjectModelObjectOrID
-            );
-        }
-        if ($otherObject instanceof EE_Base_Class) {
-            $otherObject->clear_cache(
-                $this->get_model()->get_this_model_name(),
-                $this
-            );
-        }
-        return $otherObject;
-    }
-
-
-    /**
-     * Removes ALL the related things for the $relation_name.
-     *
-     * @param string $relation_name
-     * @param array  $where_query_params @see
-     *                                   https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @return EE_Base_Class
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function _remove_relations($relation_name, $where_query_params = [])
-    {
-        if ($this->ID()) {
-            // if this exists in the DB, save the relation change to the DB too
-            $otherObjects = $this->get_model()->remove_relations(
-                $this,
-                $relation_name,
-                $where_query_params
-            );
-            $this->clear_cache(
-                $relation_name,
-                null,
-                true
-            );
-        } else {
-            // this doesn't exist in the DB, just remove it from the cache
-            $otherObjects = $this->clear_cache(
-                $relation_name,
-                null,
-                true
-            );
-        }
-        if (is_array($otherObjects)) {
-            foreach ($otherObjects as $otherObject) {
-                $otherObject->clear_cache(
-                    $this->get_model()->get_this_model_name(),
-                    $this
-                );
-            }
-        }
-        return $otherObjects;
-    }
-
-
-    /**
-     * Gets all the related model objects of the specified type. Eg, if the current class if
-     * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
-     * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
-     * because we want to get even deleted items etc.
-     *
-     * @param string      $relation_name key in the model's _model_relations array
-     * @param array|null  $query_params  @see
-     *                              https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @return EE_Base_Class[]     Results not necessarily indexed by IDs, because some results might not have primary
-     *                              keys or might not be saved yet. Consider using EEM_Base::get_IDs() on these
-     *                              results if you want IDs
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_many_related($relation_name, $query_params = [])
-    {
-        if ($this->ID()) {
-            // this exists in the DB, so get the related things from either the cache or the DB
-            // if there are query parameters, forget about caching the related model objects.
-            if ($query_params) {
-                $related_model_objects = $this->get_model()->get_all_related(
-                    $this,
-                    $relation_name,
-                    $query_params
-                );
-            } else {
-                // did we already cache the result of this query?
-                $cached_results = $this->get_all_from_cache($relation_name);
-                if (! $cached_results) {
-                    $related_model_objects = $this->get_model()->get_all_related(
-                        $this,
-                        $relation_name,
-                        $query_params
-                    );
-                    // if no query parameters were passed, then we got all the related model objects
-                    // for that relation. We can cache them then.
-                    foreach ($related_model_objects as $related_model_object) {
-                        $this->cache($relation_name, $related_model_object);
-                    }
-                } else {
-                    $related_model_objects = $cached_results;
-                }
-            }
-        } else {
-            // this doesn't exist in the DB, so just get the related things from the cache
-            $related_model_objects = $this->get_all_from_cache($relation_name);
-        }
-        return $related_model_objects;
-    }
-
-
-    /**
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
-     * unless otherwise specified in the $query_params
-     *
-     * @param string $relation_name  model_name like 'Event', or 'Registration'
-     * @param array  $query_params   @see
-     *                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_count name of field to count by. By default, uses primary key
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
-     *                               that by the setting $distinct to TRUE;
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function count_related($relation_name, $query_params = [], $field_to_count = null, $distinct = false)
-    {
-        return $this->get_model()->count_related(
-            $this,
-            $relation_name,
-            $query_params,
-            $field_to_count,
-            $distinct
-        );
-    }
-
-
-    /**
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
-     *
-     * @param string $relation_name model_name like 'Event', or 'Registration'
-     * @param array  $query_params  @see
-     *                              https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_sum  name of field to count by.
-     *                              By default, uses primary key
-     *                              (which doesn't make much sense, so you should probably change it)
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sum_related($relation_name, $query_params = [], $field_to_sum = null)
-    {
-        return $this->get_model()->sum_related(
-            $this,
-            $relation_name,
-            $query_params,
-            $field_to_sum
-        );
-    }
-
-
-    /**
-     * Gets the first (ie, one) related model object of the specified type.
-     *
-     * @param string $relation_name key in the model's _model_relations array
-     * @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|null (not an array, a single object)
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_first_related(string $relation_name, array $query_params = []): ?EE_Base_Class
-    {
-        $model = $this->get_model();
-        if ($this->ID()) {// this exists in the DB, get from the cache OR the DB
-            // if they've provided some query parameters, don't bother trying to cache the result
-            // also make sure we're not caching the result of get_first_related
-            // on a relation which should have an array of objects (because the cache might have an array of objects)
-            if (
-                $query_params
-                || ! $model->related_settings_for($relation_name) instanceof EE_Belongs_To_Relation
-            ) {
-                $related_model_object = $model->get_first_related(
-                    $this,
-                    $relation_name,
-                    $query_params
-                );
-            } else {
-                // first, check if we've already cached the result of this query
-                $cached_result = $this->get_one_from_cache($relation_name);
-                if (! $cached_result) {
-                    $related_model_object = $model->get_first_related(
-                        $this,
-                        $relation_name,
-                        $query_params
-                    );
-                    $this->cache($relation_name, $related_model_object);
-                } else {
-                    $related_model_object = $cached_result;
-                }
-            }
-        } else {
-            $related_model_object = null;
-            // this doesn't exist in the Db,
-            // but maybe the relation is of type belongs to, and so the related thing might
-            if ($model->related_settings_for($relation_name) instanceof EE_Belongs_To_Relation) {
-                $related_model_object = $model->get_first_related(
-                    $this,
-                    $relation_name,
-                    $query_params
-                );
-            }
-            // this doesn't exist in the DB and apparently the thing it belongs to doesn't either,
-            // just get what's cached on this object
-            if (! $related_model_object) {
-                $related_model_object = $this->get_one_from_cache($relation_name);
-            }
-        }
-        return $related_model_object;
-    }
-
-
-    /**
-     * Does a delete on all related objects of type $relation_name and removes
-     * the current model object's relation to them. If they can't be deleted (because
-     * of blocking related model objects) does nothing. If the related model objects are
-     * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
-     * If this model object doesn't exist yet in the DB, just removes its related things
-     *
-     * @param string $relation_name
-     * @param array  $query_params @see
-     *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return int how many deleted
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function delete_related($relation_name, $query_params = [])
-    {
-        if ($this->ID()) {
-            $count = $this->get_model()->delete_related(
-                $this,
-                $relation_name,
-                $query_params
-            );
-        } else {
-            $count = count($this->get_all_from_cache($relation_name));
-            $this->clear_cache($relation_name, null, true);
-        }
-        return $count;
-    }
-
-
-    /**
-     * Does a hard delete (ie, removes the DB row) on all related objects of type $relation_name and removes
-     * the current model object's relation to them. If they can't be deleted (because
-     * of blocking related model objects) just does a soft delete on it instead, if possible.
-     * If the related thing isn't a soft-deletable model object, this function is identical
-     * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
-     *
-     * @param string $relation_name
-     * @param array  $query_params @see
-     *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return int how many deleted (including those soft deleted)
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function delete_related_permanently($relation_name, $query_params = [])
-    {
-        $count = $this->ID()
-            ? $this->get_model()->delete_related_permanently(
-                $this,
-                $relation_name,
-                $query_params
-            )
-            : count($this->get_all_from_cache($relation_name));
-
-        $this->clear_cache($relation_name, null, true);
-        return $count;
-    }
-
-
-    /**
-     * is_set
-     * Just a simple utility function children can use for checking if property exists
-     *
-     * @access  public
-     * @param string $field_name property to check
-     * @return bool                              TRUE if existing,FALSE if not.
-     */
-    public function is_set($field_name)
-    {
-        return isset($this->_fields[ $field_name ]);
-    }
-
-
-    /**
-     * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
-     * EE_Error exception if they don't
-     *
-     * @param mixed (string|array) $properties properties to check
-     * @return bool                              TRUE if existing, throw EE_Error if not.
-     * @throws EE_Error
-     */
-    protected function _property_exists($properties)
-    {
-        foreach ((array) $properties as $property_name) {
-            // first make sure this property exists
-            if (! $this->_fields[ $property_name ]) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
-                            'event_espresso'
-                        ),
-                        $property_name
-                    )
-                );
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This simply returns an array of model fields for this object
-     *
-     * @return array
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function model_field_array()
-    {
-        $fields     = $this->get_model()->field_settings(false);
-        $properties = [];
-        // remove prepended underscore
-        foreach ($fields as $field_name => $settings) {
-            $properties[ $field_name ] = $this->get($field_name);
-        }
-        return $properties;
-    }
-
-
-    /**
-     * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
-     * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments.
-     * Instead of requiring a plugin to extend the EE_Base_Class
-     * (which works fine is there's only 1 plugin, but when will that happen?)
-     * they can add a hook onto 'filters_hook_espresso__{className}__{methodName}'
-     * (eg, filters_hook_espresso__EE_Answer__my_great_function)
-     * and accepts 2 arguments: the object on which the function was called,
-     * and an array of the original arguments passed to the function.
-     * Whatever their callback function returns will be returned by this function.
-     * Example: in functions.php (or in a plugin):
-     *      add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3);
-     *      function my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
-     *          $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
-     *          return $previousReturnValue.$returnString;
-     *      }
-     * require('EE_Answer.class.php');
-     * echo EE_Answer::new_instance(['REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'])
-     *      ->my_callback('monkeys',100);
-     * // will output "you called my_callback! and passed args:monkeys,100"
-     *
-     * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
-     * @param array  $args       array of original arguments passed to the function
-     * @return mixed whatever the plugin which calls add_filter decides
-     * @throws EE_Error
-     */
-    public function __call($methodName, $args)
-    {
-        $className = get_class($this);
-        $tagName   = "FHEE__{$className}__{$methodName}";
-        if (! has_filter($tagName)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
-                        'event_espresso'
-                    ),
-                    $methodName,
-                    $className,
-                    $tagName
-                )
-            );
-        }
-        return apply_filters($tagName, null, $this, $args);
-    }
-
-
-    /**
-     * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
-     * A $previous_value can be specified in case there are many meta rows with the same key
-     *
-     * @param string $meta_key
-     * @param mixed  $meta_value
-     * @param mixed  $previous_value
-     * @return bool|int # of records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
-     *                  NOTE: if the values haven't changed, returns 0
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_extra_meta(string $meta_key, $meta_value, $previous_value = null)
-    {
-        $query_params = [
-            [
-                'EXM_key'  => $meta_key,
-                'OBJ_ID'   => $this->ID(),
-                'EXM_type' => $this->get_model()->get_this_model_name(),
-            ],
-        ];
-        if ($previous_value !== null) {
-            $query_params[0]['EXM_value'] = $meta_value;
-        }
-        $existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
-        if (! $existing_rows_like_that) {
-            return $this->add_extra_meta($meta_key, $meta_value);
-        }
-        foreach ($existing_rows_like_that as $existing_row) {
-            $existing_row->save(['EXM_value' => $meta_value]);
-        }
-        return count($existing_rows_like_that);
-    }
-
-
-    /**
-     * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
-     * no other extra meta for this model object have the same key. Returns TRUE if the
-     * extra meta row was entered, false if not
-     *
-     * @param string $meta_key
-     * @param mixed  $meta_value
-     * @param bool   $unique
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_extra_meta(string $meta_key, $meta_value, bool $unique = false): bool
-    {
-        if ($unique) {
-            $existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
-                [
-                    [
-                        'EXM_key'  => $meta_key,
-                        'OBJ_ID'   => $this->ID(),
-                        'EXM_type' => $this->get_model()->get_this_model_name(),
-                    ],
-                ]
-            );
-            if ($existing_extra_meta) {
-                return false;
-            }
-        }
-        $new_extra_meta = EE_Extra_Meta::new_instance(
-            [
-                'EXM_key'   => $meta_key,
-                'EXM_value' => $meta_value,
-                'OBJ_ID'    => $this->ID(),
-                'EXM_type'  => $this->get_model()->get_this_model_name(),
-            ]
-        );
-        $new_extra_meta->save();
-        return true;
-    }
-
-
-    /**
-     * Deletes all the extra meta rows for this record as specified by key. If $meta_value
-     * is specified, only deletes extra meta records with that value.
-     *
-     * @param string $meta_key
-     * @param mixed  $meta_value
-     * @return int number of extra meta rows deleted
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_extra_meta(string $meta_key, $meta_value = null)
-    {
-        $query_params = [
-            [
-                'EXM_key'  => $meta_key,
-                'OBJ_ID'   => $this->ID(),
-                'EXM_type' => $this->get_model()->get_this_model_name(),
-            ],
-        ];
-        if ($meta_value !== null) {
-            $query_params[0]['EXM_value'] = $meta_value;
-        }
-        return EEM_Extra_Meta::instance()->delete($query_params);
-    }
-
-
-    /**
-     * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
-     * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
-     * You can specify $default is case you haven't found the extra meta
-     *
-     * @param string     $meta_key
-     * @param bool       $single
-     * @param mixed      $default if we don't find anything, what should we return?
-     * @param array|null $extra_where
-     * @return mixed single value if $single; array if ! $single
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function get_extra_meta(string $meta_key, bool $single = false, $default = null, ?array $extra_where = [])
-    {
-        $query_params = [$extra_where + ['EXM_key' => $meta_key]];
-        if ($single) {
-            $result = $this->get_first_related('Extra_Meta', $query_params);
-            if ($result instanceof EE_Extra_Meta) {
-                return $result->value();
-            }
-        } else {
-            $results = $this->get_many_related('Extra_Meta', $query_params);
-            if ($results) {
-                $values = [];
-                foreach ($results as $result) {
-                    if ($result instanceof EE_Extra_Meta) {
-                        $values[ $result->ID() ] = $result->value();
-                    }
-                }
-                return $values;
-            }
-        }
-        // if nothing discovered yet return default.
-        return apply_filters(
-            'FHEE__EE_Base_Class__get_extra_meta__default_value',
-            $default,
-            $meta_key,
-            $single,
-            $this
-        );
-    }
-
-
-    /**
-     * Returns a simple array of all the extra meta associated with this model object.
-     * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
-     * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
-     * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
-     * If $one_of_each_key is false, it will return an array with the top-level keys being
-     * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
-     * finally the extra meta's value as each sub-value. (eg
-     * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
-     *
-     * @param bool $one_of_each_key
-     * @return array
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function all_extra_meta_array(bool $one_of_each_key = true): array
-    {
-        $return_array = [];
-        if ($one_of_each_key) {
-            $extra_meta_objs = $this->get_many_related(
-                'Extra_Meta',
-                ['group_by' => 'EXM_key']
-            );
-            foreach ($extra_meta_objs as $extra_meta_obj) {
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    $return_array[ $extra_meta_obj->key() ] = $extra_meta_obj->value();
-                }
-            }
-        } else {
-            $extra_meta_objs = $this->get_many_related('Extra_Meta');
-            foreach ($extra_meta_objs as $extra_meta_obj) {
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    if (! isset($return_array[ $extra_meta_obj->key() ])) {
-                        $return_array[ $extra_meta_obj->key() ] = [];
-                    }
-                    $return_array[ $extra_meta_obj->key() ][ $extra_meta_obj->ID() ] = $extra_meta_obj->value();
-                }
-            }
-        }
-        return $return_array;
-    }
-
-
-    /**
-     * Gets a pretty nice displayable nice for this model object. Often overridden
-     *
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        // find a field that's not a text field
-        $field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
-        if ($field_we_can_use) {
-            return $this->get($field_we_can_use->get_name());
-        }
-        $first_few_properties = $this->model_field_array();
-        $first_few_properties = array_slice($first_few_properties, 0, 3);
-        $name_parts           = [];
-        foreach ($first_few_properties as $name => $value) {
-            $name_parts[] = "$name:$value";
-        }
-        return implode(',', $name_parts);
-    }
-
-
-    /**
-     * in_entity_map
-     * Checks if this model object has been proven to already be in the entity map
-     *
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function in_entity_map()
-    {
-        // well, if we looked, did we find it in the entity map?
-        return $this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this;
-    }
-
-
-    /**
-     * refresh_from_db
-     * Makes sure the fields and values on this model object are in-sync with what's in the database.
-     *
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error if this model object isn't in the entity mapper (because then you should
-     * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
-     */
-    public function refresh_from_db()
-    {
-        if ($this->ID() && $this->in_entity_map()) {
-            $this->get_model()->refresh_entity_map_from_db($this->ID());
-        } else {
-            // if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
-            // if it has an ID but it's not in the map, and you're asking me to refresh it
-            // that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
-            // absolutely nothing in it for this ID
-            if (WP_DEBUG) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
-                            'event_espresso'
-                        ),
-                        $this->ID(),
-                        get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                        get_class($this->get_model()) . '::instance()->refresh_entity_map()'
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Change $fields' values to $new_value_sql (which is a string of raw SQL)
-     *
-     * @param EE_Model_Field_Base[] $fields
-     * @param string                $new_value_sql
-     *          example: 'column_name=123',
-     *          or 'column_name=column_name+1',
-     *          or 'column_name= CASE
-     *          WHEN (`column_name` + `other_column` + 5) <= `yet_another_column`
-     *          THEN `column_name` + 5
-     *          ELSE `column_name`
-     *          END'
-     *          Also updates $field on this model object with the latest value from the database.
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.9.80.p
-     */
-    protected function updateFieldsInDB($fields, $new_value_sql)
-    {
-        // First make sure this model object actually exists in the DB. It would be silly to try to update it in the DB
-        // if it wasn't even there to start off.
-        if (! $this->ID()) {
-            $this->save();
-        }
-        global $wpdb;
-        if (empty($fields)) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'EE_Base_Class::updateFieldsInDB was passed an empty array of fields.',
-                    'event_espresso'
-                )
-            );
-        }
-        $first_field = reset($fields);
-        $table_alias = $first_field->get_table_alias();
-        foreach ($fields as $field) {
-            if ($table_alias !== $field->get_table_alias()) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                        // @codingStandardsIgnoreStart
-                            'EE_Base_Class::updateFieldsInDB was passed fields for different tables ("%1$s" and "%2$s"), which is not supported. Instead, please call the method multiple times.',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        ),
-                        $table_alias,
-                        $field->get_table_alias()
-                    )
-                );
-            }
-        }
-        // Ok the fields are now known to all be for the same table. Proceed with creating the SQL to update it.
-        $table_obj      = $this->get_model()->get_table_obj_by_alias($table_alias);
-        $table_pk_value = $this->ID();
-        $table_name     = $table_obj->get_table_name();
-        if ($table_obj instanceof EE_Secondary_Table) {
-            $table_pk_field_name = $table_obj->get_fk_on_table();
-        } else {
-            $table_pk_field_name = $table_obj->get_pk_column();
-        }
-
-        $query  =
-            "UPDATE `{$table_name}`
+	/**
+	 * @var EEM_Base|null
+	 */
+	protected $_model = null;
+
+	/**
+	 * This is an array of the original properties and values provided during construction
+	 * of this model object. (keys are model field names, values are their values).
+	 * This list is important to remember so that when we are merging data from the db, we know
+	 * which values to override and which to not override.
+	 */
+	protected ?array $_props_n_values_provided_in_constructor = null;
+
+	/**
+	 * Timezone
+	 * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
+	 * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
+	 * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
+	 * access to it.
+	 */
+	protected string $_timezone = '';
+
+	/**
+	 * date format
+	 * pattern or format for displaying dates
+	 */
+	protected string $_dt_frmt = '';
+
+	/**
+	 * time format
+	 * pattern or format for displaying time
+	 */
+	protected string $_tm_frmt = '';
+
+	/**
+	 * This property is for holding a cached array of object properties indexed by property name as the key.
+	 * The purpose of this is for setting a cache on properties that may have calculated values after a
+	 * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
+	 * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
+	 */
+	protected array $_cached_properties = [];
+
+	/**
+	 * An array containing keys of the related model, and values are either an array of related mode objects or a
+	 * single
+	 * related model object. see the model's _model_relations. The keys should match those specified. And if the
+	 * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
+	 * all others have an array)
+	 */
+	protected array $_model_relations = [];
+
+	/**
+	 * Array where keys are field names (see the model's _fields property) and values are their values. To see what
+	 * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
+	 */
+	protected array $_fields = [];
+
+	/**
+	 * indicating whether or not this model object is intended to ever be saved
+	 * For example, we might create model objects intended to only be used for the duration
+	 * of this request and to be thrown away, and if they were accidentally saved
+	 * it would be a bug.
+	 */
+	protected bool $_allow_persist = true;
+
+	/**
+	 * indicating whether or not this model object's properties have changed since construction
+	 */
+	protected bool $_has_changes = false;
+
+	/**
+	 * This is a cache of results from custom selections done on a query that constructs this entity. The only purpose
+	 * for these values is for retrieval of the results, they are not further queryable and they are not persisted to
+	 * the db.  They also do not automatically update if there are any changes to the data that produced their results.
+	 * The format is a simple array of field_alias => field_value.  So for instance if a custom select was something
+	 * like,  "Select COUNT(Registration.REG_ID) as Registration_Count ...", then the resulting value will be in this
+	 * array as:
+	 * array(
+	 *  'Registration_Count' => 24
+	 * );
+	 * Note: if the custom select configuration for the query included a data type, the value will be in the data type
+	 * provided for the query (@see EventEspresso\core\domain\values\model\CustomSelects::__construct phpdocs for more
+	 * info)
+	 */
+	protected array $custom_selection_results = [];
+
+
+	/**
+	 * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children
+	 * play nice
+	 *
+	 * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
+	 *                                                         layer of the model's _fields array, (eg, EVT_ID,
+	 *                                                         TXN_amount, QST_name, etc) and values are their values
+	 * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
+	 *                                                         corresponding db model or not.
+	 * @param string  $timezone                                indicate what timezone you want any datetime fields to
+	 *                                                         be in when instantiating a EE_Base_Class object.
+	 * @param array   $date_formats                            An array of date formats to set on construct where first
+	 *                                                         value is the date_format and second value is the time
+	 *                                                         format.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct($fieldValues = [], $bydb = false, $timezone = '', $date_formats = [])
+	{
+		$className = get_class($this);
+		do_action("AHEE__{$className}__construct", $this, $fieldValues);
+		$model        = $this->get_model();
+		$model_fields = $model->field_settings();
+		// ensure $fieldValues is an array
+		$fieldValues = is_array($fieldValues) ? $fieldValues : [$fieldValues];
+		// verify client code has not passed any invalid field names
+		foreach ($fieldValues as $field_name => $field_value) {
+			if (! isset($model_fields[ $field_name ])) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Invalid field (%s) passed to constructor of %s. Allowed fields are :%s',
+							'event_espresso'
+						),
+						$field_name,
+						get_class($this),
+						implode(', ', array_keys($model_fields))
+					)
+				);
+			}
+		}
+
+		$date_format     = null;
+		$time_format     = null;
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
+		if (! empty($date_formats) && is_array($date_formats)) {
+			[$date_format, $time_format] = $date_formats;
+		}
+		$this->set_date_format($date_format);
+		$this->set_time_format($time_format);
+		// if db model is instantiating
+		foreach ($model_fields as $fieldName => $field) {
+			if ($bydb) {
+				// client code has indicated these field values are from the database
+				$this->set_from_db(
+					$fieldName,
+					$fieldValues[ $fieldName ] ?? null
+				);
+			} else {
+				// we're constructing a brand new instance of the model object.
+				// Generally, this means we'll need to do more field validation
+				$this->set(
+					$fieldName,
+					$fieldValues[ $fieldName ] ?? null,
+					true
+				);
+			}
+		}
+		// remember what values were passed to this constructor
+		$this->_props_n_values_provided_in_constructor = $fieldValues;
+		// remember in entity mapper
+		if (! $bydb && $model->has_primary_key_field() && $this->ID()) {
+			$model->add_to_entity_map($this);
+		}
+		// setup all the relations
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$this->_model_relations[ $relation_name ] = null;
+			} else {
+				$this->_model_relations[ $relation_name ] = [];
+			}
+		}
+		/**
+		 * Action done at the end of each model object construction
+		 *
+		 * @param EE_Base_Class $this the model object just created
+		 */
+		do_action('AHEE__EE_Base_Class__construct__finished', $this);
+	}
+
+
+	/**
+	 * Gets whether or not this model object is allowed to persist/be saved to the database.
+	 *
+	 * @return boolean
+	 */
+	public function allow_persist()
+	{
+		return $this->_allow_persist;
+	}
+
+
+	/**
+	 * Sets whether or not this model object should be allowed to be saved to the DB.
+	 * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
+	 * you got new information that somehow made you change your mind.
+	 *
+	 * @param boolean $allow_persist
+	 * @return boolean
+	 */
+	public function set_allow_persist($allow_persist)
+	{
+		return $this->_allow_persist = $allow_persist;
+	}
+
+
+	/**
+	 * Gets the field's original value when this object was constructed during this request.
+	 * This can be helpful when determining if a model object has changed or not
+	 *
+	 * @param string $field_name
+	 * @return mixed|null
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_original($field_name)
+	{
+		if (
+			isset($this->_props_n_values_provided_in_constructor[ $field_name ])
+			&& $field_settings = $this->get_model()->field_settings_for($field_name)
+		) {
+			return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[ $field_name ]);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param EE_Base_Class $obj
+	 * @return string
+	 */
+	public function get_class($obj)
+	{
+		return get_class($obj);
+	}
+
+
+	/**
+	 * Overrides parent because parent expects old models.
+	 * This also doesn't do any validation, and won't work for serialized arrays
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function set(string $field_name, $field_value, bool $use_default = false)
+	{
+		// if not using default and nothing has changed, and object has already been setup (has ID),
+		// then don't do anything
+		if (
+			! $use_default
+			&& $this->_fields[ $field_name ] === $field_value
+			&& $this->ID()
+		) {
+			return;
+		}
+		$model              = $this->get_model();
+		$this->_has_changes = true;
+		$field_obj          = $model->field_settings_for($field_name);
+		if (! $field_obj instanceof EE_Model_Field_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'A valid EE_Model_Field_Base could not be found for the given field name: %s',
+						'event_espresso'
+					),
+					$field_name
+				)
+			);
+		}
+		// if ( method_exists( $field_obj, 'set_timezone' )) {
+		if ($field_obj instanceof EE_Datetime_Field) {
+			$field_obj->set_timezone($this->_timezone);
+			$field_obj->set_date_format($this->_dt_frmt);
+			$field_obj->set_time_format($this->_tm_frmt);
+		}
+
+		// should the value be null?
+		$value = $field_value === null && ($use_default || ! $field_obj->is_nullable())
+			? $field_obj->get_default_value()
+			: $field_value;
+
+		$this->_fields[ $field_name ] = $field_obj->prepare_for_set($value);
+
+		// if we're not in the constructor...
+		// now check if what we set was a primary key
+		if (
+			// note: props_n_values_provided_in_constructor is only set at the END of the constructor
+			$this->_props_n_values_provided_in_constructor
+			&& $field_value
+			&& $field_name === $model->primary_key_name()
+		) {
+			// if so, we want all this object's fields to be filled either with
+			// what we've explicitly set on this model
+			// or what we have in the db
+			// echo "setting primary key!";
+			$fields_on_model = self::_get_model(get_class($this))->field_settings();
+			$obj_in_db       = self::_get_model(get_class($this))->get_one_by_ID($field_value);
+			foreach ($fields_on_model as $field_obj) {
+				if (
+					! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
+					&& $field_obj->get_name() !== $field_name
+				) {
+					$this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
+				}
+			}
+			// oh this model object has an ID? well make sure its in the entity mapper
+			$model->add_to_entity_map($this);
+		}
+		// let's unset any cache for this field_name from the $_cached_properties property.
+		$this->_clear_cached_property($field_name);
+	}
+
+
+	/**
+	 * Overrides parent because parent expects old models.
+	 * This also doesn't do any validation, and won't work for serialized arrays
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value_from_db
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_from_db(string $field_name, $field_value_from_db)
+	{
+		$field_obj = $this->get_model()->field_settings_for($field_name);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			// you would think the DB has no NULLs for non-null label fields right? wrong!
+			// eg, a CPT model object could have an entry in the posts table, but no
+			// entry in the meta table. Meaning that all its columns in the meta table
+			// are null! yikes! so when we find one like that, use defaults for its meta columns
+			if ($field_value_from_db === null) {
+				if ($field_obj->is_nullable()) {
+					// if the field allows nulls, then let it be null
+					$field_value = null;
+				} else {
+					$field_value = $field_obj->get_default_value();
+				}
+			} else {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
+			}
+			$this->_fields[ $field_name ] = $field_value;
+			$this->_clear_cached_property($field_name);
+		}
+	}
+
+
+	/**
+	 * Set custom select values for model.
+	 *
+	 * @param array $custom_select_values
+	 */
+	public function setCustomSelectsValues(array $custom_select_values)
+	{
+		$this->custom_selection_results = $custom_select_values;
+	}
+
+
+	/**
+	 * Returns the custom select value for the provided alias if its set.
+	 * If not set, returns null.
+	 *
+	 * @param string $alias
+	 * @return string|int|float|null
+	 */
+	public function getCustomSelect($alias)
+	{
+		return $this->custom_selection_results[ $alias ] ?? null;
+	}
+
+
+	/**
+	 * This sets the field value on the db column if it exists for the given $column_name or
+	 * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
+	 *
+	 * @param string $field_name  Must be the exact column name.
+	 * @param mixed  $field_value The value to set.
+	 * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see EE_message::get_column_value for related documentation on the necessity of this method.
+	 */
+	public function set_field_or_extra_meta($field_name, $field_value)
+	{
+		if ($this->get_model()->has_field($field_name)) {
+			$this->set($field_name, $field_value);
+			return true;
+		}
+		// ensure this object is saved first so that extra meta can be properly related.
+		$this->save();
+		return $this->update_extra_meta($field_name, $field_value);
+	}
+
+
+	/**
+	 * This retrieves the value of the db column set on this class or if that's not present
+	 * it will attempt to retrieve from extra_meta if found.
+	 * Example Usage:
+	 * Via EE_Message child class:
+	 * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
+	 * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
+	 * also have additional main fields specific to the messenger.  The system accommodates those extra
+	 * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
+	 * value for those extra fields dynamically via the EE_message object.
+	 *
+	 * @param string $field_name expecting the fully qualified field name.
+	 * @return mixed|null  value for the field if found.  null if not found.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_field_or_extra_meta($field_name)
+	{
+		if ($this->get_model()->has_field($field_name)) {
+			$column_value = $this->get($field_name);
+		} else {
+			// This isn't a column in the main table, let's see if it is in the extra meta.
+			$column_value = $this->get_extra_meta($field_name, true, null);
+		}
+		return $column_value;
+	}
+
+
+	/**
+	 * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
+	 * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
+	 * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
+	 * available to all child classes that may be using the EE_Datetime_Field for a field data type.
+	 *
+	 * @access public
+	 * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function set_timezone($timezone = '')
+	{
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
+		// make sure we clear all cached properties because they won't be relevant now
+		$this->_clear_cached_properties();
+		// make sure we update field settings and the date for all EE_Datetime_Fields
+		$model_fields = $this->get_model()->field_settings(false);
+		foreach ($model_fields as $field_name => $field_obj) {
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$field_obj->set_timezone($this->_timezone);
+				if (isset($this->_fields[ $field_name ]) && $this->_fields[ $field_name ] instanceof DateTime) {
+					EEH_DTT_Helper::setTimezone($this->_fields[ $field_name ], new DateTimeZone($this->_timezone));
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string timezone string
+	 */
+	public function get_timezone()
+	{
+		return $this->_timezone;
+	}
+
+
+	/**
+	 * This sets the internal date format to what is sent in to be used as the new default for the class
+	 * internally instead of wp set date format options
+	 *
+	 * @param string|null $format should be a format recognizable by PHP date() functions.
+	 * @since 4.6
+	 */
+	public function set_date_format(?string $format)
+	{
+		$this->_dt_frmt = new DateFormat($format);
+		// clear cached_properties because they won't be relevant now.
+		$this->_clear_cached_properties();
+	}
+
+
+	/**
+	 * This sets the internal time format string to what is sent in to be used as the new default for the
+	 * class internally instead of wp set time format options.
+	 *
+	 * @param string|null $format should be a format recognizable by PHP date() functions.
+	 * @since 4.6
+	 */
+	public function set_time_format(?string $format)
+	{
+		$this->_tm_frmt = new TimeFormat($format);
+		// clear cached_properties because they won't be relevant now.
+		$this->_clear_cached_properties();
+	}
+
+
+	/**
+	 * This returns the current internal set format for the date and time formats.
+	 *
+	 * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
+	 *                             where the first value is the date format and the second value is the time format.
+	 * @return string|array
+	 */
+	public function get_format($full = true)
+	{
+		return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : [$this->_dt_frmt, $this->_tm_frmt];
+	}
+
+
+	/**
+	 * cache
+	 * stores the passed model object on the current model object.
+	 * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
+	 *
+	 * @param string        $relation_name   one of the keys in the _model_relations array on the model. Eg
+	 *                                       'Registration' associated with this model object
+	 * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
+	 *                                       that could be a payment or a registration)
+	 * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
+	 *                                       items which will be stored in an array on this object
+	 * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
+	 *                                       related thing, no array)
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function cache($relation_name = '', $object_to_cache = null, $cache_id = null)
+	{
+		// its entirely possible that there IS no related object yet in which case there is nothing to cache.
+		if (! $object_to_cache instanceof EE_Base_Class) {
+			return false;
+		}
+		// also get "how" the object is related, or throw an error
+		if (! $relationship_to_model = $this->get_model()->related_settings_for($relation_name)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
+					$relation_name,
+					get_class($this)
+				)
+			);
+		}
+		// how many things are related ?
+		if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+			// if it's a "belongs to" relationship, then there's only one related model object
+			// eg, if this is a registration, there's only 1 attendee for it
+			// so for these model objects just set it to be cached
+			$this->_model_relations[ $relation_name ] = $object_to_cache;
+			$return                                   = true;
+		} else {
+			// otherwise, this is the "many" side of a one to many relationship,
+			// so we'll add the object to the array of related objects for that type.
+			// eg: if this is an event, there are many registrations for that event,
+			// so we cache the registrations in an array
+			if (! is_array($this->_model_relations[ $relation_name ])) {
+				// if for some reason, the cached item is a model object,
+				// then stick that in the array, otherwise start with an empty array
+				$this->_model_relations[ $relation_name ] =
+					$this->_model_relations[ $relation_name ] instanceof EE_Base_Class
+						? [$this->_model_relations[ $relation_name ]]
+						: [];
+			}
+			// first check for a cache_id which is normally empty
+			if (! empty($cache_id)) {
+				// if the cache_id exists, then it means we are purposely trying to cache this
+				// with a known key that can then be used to retrieve the object later on
+				$this->_model_relations[ $relation_name ][ $cache_id ] = $object_to_cache;
+				$return                                                = $cache_id;
+			} elseif ($object_to_cache->ID()) {
+				// OR the cached object originally came from the db, so let's just use it's PK for an ID
+				$this->_model_relations[ $relation_name ][ $object_to_cache->ID() ] = $object_to_cache;
+				$return                                                             = $object_to_cache->ID();
+			} else {
+				// OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
+				$this->_model_relations[ $relation_name ][] = $object_to_cache;
+				// move the internal pointer to the end of the array
+				end($this->_model_relations[ $relation_name ]);
+				// and grab the key so that we can return it
+				$return = key($this->_model_relations[ $relation_name ]);
+			}
+		}
+		return $return;
+	}
+
+
+	/**
+	 * For adding an item to the cached_properties property.
+	 *
+	 * @access protected
+	 * @param string      $fieldname the property item the corresponding value is for.
+	 * @param mixed       $value     The value we are caching.
+	 * @param string|null $cache_type
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _set_cached_property($fieldname, $value, $cache_type = null)
+	{
+		// first make sure this property exists
+		$this->get_model()->field_settings_for($fieldname);
+		$cache_type = empty($cache_type) ? 'standard' : $cache_type;
+
+		$this->_cached_properties[ $fieldname ][ $cache_type ] = $value;
+	}
+
+
+	/**
+	 * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
+	 * This also SETS the cache if we return the actual property!
+	 *
+	 * @param string $fieldname        the name of the property we're trying to retrieve
+	 * @param bool   $pretty
+	 * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
+	 *                                 (in cases where the same property may be used for different outputs
+	 *                                 - i.e. datetime, money etc.)
+	 *                                 It can also accept certain pre-defined "schema" strings
+	 *                                 to define how to output the property.
+	 *                                 see the field's prepare_for_pretty_echoing for what strings can be used
+	 * @return mixed                   whatever the value for the property is we're retrieving
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
+	{
+		// verify the field exists
+		$model = $this->get_model();
+		$model->field_settings_for($fieldname);
+		$cache_type = $pretty ? 'pretty' : 'standard';
+		$cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
+		if (isset($this->_cached_properties[ $fieldname ][ $cache_type ])) {
+			return $this->_cached_properties[ $fieldname ][ $cache_type ];
+		}
+		$value = $this->_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
+		$this->_set_cached_property($fieldname, $value, $cache_type);
+		return $value;
+	}
+
+
+	/**
+	 * If the cache didn't fetch the needed item, this fetches it.
+	 *
+	 * @param string $fieldname
+	 * @param bool   $pretty
+	 * @param string $extra_cache_ref
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
+	{
+		$field_obj = $this->get_model()->field_settings_for($fieldname);
+		// If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
+		if ($field_obj instanceof EE_Datetime_Field) {
+			$this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
+		}
+		if (! isset($this->_fields[ $fieldname ])) {
+			$this->_fields[ $fieldname ] = null;
+		}
+		return $pretty
+			? $field_obj->prepare_for_pretty_echoing($this->_fields[ $fieldname ], $extra_cache_ref)
+			: $field_obj->prepare_for_get($this->_fields[ $fieldname ]);
+	}
+
+
+	/**
+	 * set timezone, formats, and output for EE_Datetime_Field objects
+	 *
+	 * @param EE_Datetime_Field $datetime_field
+	 * @param bool              $pretty
+	 * @param null              $date_or_time
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _prepare_datetime_field(
+		EE_Datetime_Field $datetime_field,
+		$pretty = false,
+		$date_or_time = null
+	) {
+		$datetime_field->set_timezone($this->_timezone);
+		$datetime_field->set_date_format($this->_dt_frmt, $pretty);
+		$datetime_field->set_time_format($this->_tm_frmt, $pretty);
+		// set the output returned
+		switch ($date_or_time) {
+			case 'D':
+				$datetime_field->set_date_time_output('date');
+				break;
+			case 'T':
+				$datetime_field->set_date_time_output('time');
+				break;
+			default:
+				$datetime_field->set_date_time_output();
+		}
+	}
+
+
+	/**
+	 * This just takes care of clearing out the cached_properties
+	 *
+	 * @return void
+	 */
+	protected function _clear_cached_properties()
+	{
+		$this->_cached_properties = [];
+	}
+
+
+	/**
+	 * This just clears out ONE property if it exists in the cache
+	 *
+	 * @param string $property_name the property to remove if it exists (from the _cached_properties array)
+	 * @return void
+	 */
+	protected function _clear_cached_property($property_name)
+	{
+		if (isset($this->_cached_properties[ $property_name ])) {
+			unset($this->_cached_properties[ $property_name ]);
+		}
+	}
+
+
+	/**
+	 * Ensures that this related thing is a model object.
+	 *
+	 * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
+	 * @param string $model_name   name of the related thing, eg 'Attendee',
+	 * @return EE_Base_Class
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
+	{
+		$other_model_instance = self::_get_model_instance_with_name(
+			self::_get_model_classname($model_name),
+			$this->_timezone
+		);
+		return $other_model_instance->ensure_is_obj($object_or_id);
+	}
+
+
+	/**
+	 * Forgets the cached model of the given relation Name. So the next time we request it,
+	 * we will fetch it again from the database. (Handy if you know it's changed somehow).
+	 * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
+	 * then only remove that one object from our cached array. Otherwise, clear the entire list
+	 *
+	 * @param string $relation_name                        one of the keys in the _model_relations array on the model.
+	 *                                                     Eg 'Registration'
+	 * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
+	 *                                                     if you intend to use $clear_all = TRUE, or the relation only
+	 *                                                     has 1 object anyway (ie, it's a BelongsToRelation)
+	 * @param bool   $clear_all                            This flags clearing the entire cache relation property if
+	 *                                                     this is HasMany or HABTM.
+	 * @return EE_Base_Class|bool                          entity that was cleared from the cache,
+	 *                                                     or true if we requested to remove a relation from all
+	 *                                                     or false if entity was never cached anyway.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function clear_cache($relation_name, $object_to_remove_or_index_into_array = null, $clear_all = false)
+	{
+		$relationship_to_model = $this->get_model()->related_settings_for($relation_name);
+		$index_in_cache        = '';
+		if (! $relationship_to_model) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no relationship to %s on a %s. Cannot clear that cache', 'event_espresso'),
+					$relation_name,
+					get_class($this)
+				)
+			);
+		}
+		if ($clear_all) {
+			$obj_removed                              = true;
+			$this->_model_relations[ $relation_name ] = null;
+		} elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+			$obj_removed                              = $this->_model_relations[ $relation_name ];
+			$this->_model_relations[ $relation_name ] = null;
+		} else {
+			if (
+				$object_to_remove_or_index_into_array instanceof EE_Base_Class
+				&& $object_to_remove_or_index_into_array->ID()
+			) {
+				$index_in_cache = $object_to_remove_or_index_into_array->ID();
+				if (
+					is_array($this->_model_relations[ $relation_name ])
+					&& ! isset($this->_model_relations[ $relation_name ][ $index_in_cache ])
+				) {
+					$index_found_at = null;
+					// find this object in the array even though it has a different key
+					foreach ($this->_model_relations[ $relation_name ] as $index => $obj) {
+						/** @noinspection TypeUnsafeComparisonInspection */
+						if (
+							$obj instanceof EE_Base_Class
+							&& (
+								$obj == $object_to_remove_or_index_into_array
+								|| $obj->ID() === $object_to_remove_or_index_into_array->ID()
+							)
+						) {
+							$index_found_at = $index;
+							break;
+						}
+					}
+					if ($index_found_at) {
+						$index_in_cache = $index_found_at;
+					} else {
+						// it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
+						// if it wasn't in it to begin with. So we're done
+						return $object_to_remove_or_index_into_array;
+					}
+				}
+			} elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
+				// so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
+				foreach ($this->get_all_from_cache($relation_name) as $index => $potentially_obj_we_want) {
+					/** @noinspection TypeUnsafeComparisonInspection */
+					if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
+						$index_in_cache = $index;
+					}
+				}
+			} else {
+				$index_in_cache = $object_to_remove_or_index_into_array;
+			}
+			// supposedly we've found it. But it could just be that the client code
+			// provided a bad index/object
+			if (isset($this->_model_relations[ $relation_name ][ $index_in_cache ])) {
+				$obj_removed = $this->_model_relations[ $relation_name ][ $index_in_cache ];
+				unset($this->_model_relations[ $relation_name ][ $index_in_cache ]);
+			} else {
+				// that thing was never cached anyway.
+				$obj_removed = false;
+			}
+		}
+		return $obj_removed;
+	}
+
+
+	/**
+	 * update_cache_after_object_save
+	 * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
+	 * obtained after being saved to the db
+	 *
+	 * @param string        $relation_name      - the type of object that is cached
+	 * @param EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
+	 * @param string        $current_cache_id   - the ID that was used when originally caching the object
+	 * @return boolean TRUE on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function update_cache_after_object_save(
+		$relation_name,
+		EE_Base_Class $newly_saved_object,
+		$current_cache_id = ''
+	) {
+		// verify that incoming object is of the correct type
+		$obj_class = 'EE_' . $relation_name;
+		if ($newly_saved_object instanceof $obj_class) {
+			/* @type EE_Base_Class $newly_saved_object */
+			// now get the type of relation
+			$relationship_to_model = $this->get_model()->related_settings_for($relation_name);
+			// if this is a 1:1 relationship
+			if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+				// then just replace the cached object with the newly saved object
+				$this->_model_relations[ $relation_name ] = $newly_saved_object;
+				return true;
+				// or if it's some kind of sordid feral polyamorous relationship...
+			}
+			if (
+				is_array($this->_model_relations[ $relation_name ])
+				&& isset($this->_model_relations[ $relation_name ][ $current_cache_id ])
+			) {
+				// then remove the current cached item
+				unset($this->_model_relations[ $relation_name ][ $current_cache_id ]);
+				// and cache the newly saved object using it's new ID
+				$this->_model_relations[ $relation_name ][ $newly_saved_object->ID() ] = $newly_saved_object;
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
+	 *
+	 * @param string $relation_name
+	 * @return EE_Base_Class
+	 */
+	public function get_one_from_cache($relation_name)
+	{
+		$cached_array_or_object = $this->_model_relations[ $relation_name ] ?? null;
+		if (is_array($cached_array_or_object)) {
+			return array_shift($cached_array_or_object);
+		}
+		return $cached_array_or_object;
+	}
+
+
+	/**
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
+	 *
+	 * @param string $relation_name
+	 * @return EE_Base_Class[] NOT necessarily indexed by primary keys
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_from_cache($relation_name)
+	{
+		$objects = $this->_model_relations[ $relation_name ] ?? [];
+		// if the result is not an array, but exists, make it an array
+		$objects = is_array($objects)
+			? $objects
+			: [$objects];
+		// bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
+		// basically, if this model object was stored in the session, and these cached model objects
+		// already have IDs, let's make sure they're in their model's entity mapper
+		// otherwise we will have duplicates next time we call
+		// EE_Registry::instance()->load_model( $relation_name )->get_one_by_ID( $result->ID() );
+		$model = EE_Registry::instance()->load_model($relation_name);
+		foreach ($objects as $model_object) {
+			if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
+				// ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
+				if ($model_object->ID()) {
+					$model->add_to_entity_map($model_object);
+				}
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
+							'event_espresso'
+						),
+						$relation_name,
+						gettype($model_object)
+					)
+				);
+			}
+		}
+		return $objects;
+	}
+
+
+	/**
+	 * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param int   $limit              How many objects to return.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class[]
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function next_x($field_to_order_by = null, $limit = 1, $query_params = [], $columns_to_select = null)
+	{
+		$model         = $this->get_model();
+		$field         = empty($field_to_order_by) && $model->has_primary_key_field()
+			? $model->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field)
+			? $this->get($field)
+			: null;
+		if (empty($field) || empty($current_value)) {
+			return [];
+		}
+		return $model->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
+	}
+
+
+	/**
+	 * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param int   $limit              How many objects to return.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class[]
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function previous_x(
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = [],
+		$columns_to_select = null
+	) {
+		$model         = $this->get_model();
+		$field         = empty($field_to_order_by) && $model->has_primary_key_field()
+			? $model->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return [];
+		}
+		return $model->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
+	}
+
+
+	/**
+	 * Returns the next EE_Base_Class object in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function next($field_to_order_by = null, $query_params = [], $columns_to_select = null)
+	{
+		$model         = $this->get_model();
+		$field         = empty($field_to_order_by) && $model->has_primary_key_field()
+			? $model->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return [];
+		}
+		return $model->next($current_value, $field, $query_params, $columns_to_select);
+	}
+
+
+	/**
+	 * Returns the previous EE_Base_Class object in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
+	 *                                  you can indicate just the column you want returned
+	 * @return array|EE_Base_Class
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function previous($field_to_order_by = null, $query_params = [], $columns_to_select = null)
+	{
+		$model         = $this->get_model();
+		$field         = empty($field_to_order_by) && $model->has_primary_key_field()
+			? $model->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return [];
+		}
+		return $model->previous($current_value, $field, $query_params, $columns_to_select);
+	}
+
+
+	/**
+	 * verifies that the specified field is of the correct type
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get($field_name, $extra_cache_ref = null)
+	{
+		return $this->_get_cached_property($field_name, false, $extra_cache_ref);
+	}
+
+
+	/**
+	 * This method simply returns the RAW unprocessed value for the given property in this class
+	 *
+	 * @param string $field_name A valid fieldname
+	 * @return mixed              Whatever the raw value stored on the property is.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
+	 */
+	public function get_raw($field_name)
+	{
+		$field_settings = $this->get_model()->field_settings_for($field_name);
+		return $field_settings instanceof EE_Datetime_Field && $this->_fields[ $field_name ] instanceof DateTime
+			? $this->_fields[ $field_name ]->format('U')
+			: $this->_fields[ $field_name ];
+	}
+
+
+	/**
+	 * This is used to return the internal DateTime object used for a field that is a
+	 * EE_Datetime_Field.
+	 *
+	 * @param string $field_name               The field name retrieving the DateTime object.
+	 * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
+	 * @throws EE_Error an error is set and false returned.  If the field IS an
+	 *                                         EE_Datetime_Field and but the field value is null, then
+	 *                                         just null is returned (because that indicates that likely
+	 *                                         this field is nullable).
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_DateTime_object($field_name)
+	{
+		$field_settings = $this->get_model()->field_settings_for($field_name);
+		if (! $field_settings instanceof EE_Datetime_Field) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
+						'event_espresso'
+					),
+					$field_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return isset($this->_fields[ $field_name ]) && $this->_fields[ $field_name ] instanceof DateTime
+			? clone $this->_fields[ $field_name ]
+			: null;
+	}
+
+
+	/**
+	 * To be used in template to immediately echo out the value, and format it for output.
+	 * Eg, should call stripslashes and whatnot before echoing
+	 *
+	 * @param string $field_name      the name of the field as it appears in the DB
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e($field_name, $extra_cache_ref = null)
+	{
+		echo wp_kses($this->get_pretty($field_name, $extra_cache_ref), AllowedTags::getWithFormTags());
+	}
+
+
+	/**
+	 * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
+	 * can be easily used as the value of form input.
+	 *
+	 * @param string $field_name
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function f($field_name)
+	{
+		$this->e($field_name, 'form_input');
+	}
+
+
+	/**
+	 * Same as `f()` but just returns the value instead of echoing it
+	 *
+	 * @param string $field_name
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_f($field_name)
+	{
+		return (string) $this->get_pretty($field_name, 'form_input');
+	}
+
+
+	/**
+	 * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this.
+	 * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class
+	 * to see what options are available.
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_pretty($field_name, $extra_cache_ref = null)
+	{
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
+	}
+
+
+	/**
+	 * This simply returns the datetime for the given field name
+	 * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
+	 * (and the equivalent e_date, e_time, e_datetime).
+	 *
+	 * @access   protected
+	 * @param string      $field_name   Field on the instantiated EE_Base_Class child object
+	 * @param string|null $date_format  valid datetime format used for date
+	 *                                  (if '' then we just use the default on the field,
+	 *                                  if NULL we use the last-used format)
+	 * @param string|null $time_format  Same as above except this is for time format
+	 * @param string|null $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
+	 * @param bool|null   $echo         Whether the datetime is pretty echoing or just returned using vanilla get
+	 * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
+	 *                                  if field is not a valid dtt field, or void if echoing
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_datetime(
+		string $field_name,
+		?string $date_format = '',
+		?string $time_format = '',
+		?string $date_or_time = '',
+		?bool $echo = false
+	) {
+		// clear cached property
+		$this->_clear_cached_property($field_name);
+		// reset format properties because they are used in get()
+		$this->_dt_frmt = $date_format ?: $this->_dt_frmt;
+		$this->_tm_frmt = $time_format ?: $this->_tm_frmt;
+		if ($echo) {
+			$this->e($field_name, $date_or_time);
+			return '';
+		}
+		return $this->get($field_name, $date_or_time);
+	}
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param string $field_name name of model object datetime field holding the value
+	 * @param string $format     format for the date returned (if NULL we use default in dt_frmt property)
+	 * @return string            datetime value formatted
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_date($field_name, $format = '')
+	{
+		return $this->_get_datetime($field_name, $format, null, 'D');
+	}
+
+
+	/**
+	 * @param        $field_name
+	 * @param string $format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_date($field_name, $format = '')
+	{
+		$this->_get_datetime($field_name, $format, null, 'D', true);
+	}
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param string $field_name name of model object datetime field holding the value
+	 * @param string $format     format for the time returned ( if NULL we use default in tm_frmt property)
+	 * @return string             datetime value formatted
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_time($field_name, $format = '')
+	{
+		return $this->_get_datetime($field_name, null, $format, 'T');
+	}
+
+
+	/**
+	 * @param        $field_name
+	 * @param string $format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_time($field_name, $format = '')
+	{
+		$this->_get_datetime($field_name, null, $format, 'T', true);
+	}
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
+	 * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param string $field_name  name of model object datetime field holding the value
+	 * @param string $date_format format for the date returned (if NULL we use default in dt_frmt property)
+	 * @param string $time_format format for the time returned (if NULL we use default in tm_frmt property)
+	 * @return string             datetime value formatted
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_datetime($field_name, $date_format = '', $time_format = '')
+	{
+		return $this->_get_datetime($field_name, $date_format, $time_format);
+	}
+
+
+	/**
+	 * @param string $field_name
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_datetime($field_name, $date_format = '', $time_format = '')
+	{
+		$this->_get_datetime($field_name, $date_format, $time_format, null, true);
+	}
+
+
+	/**
+	 * Get the i8ln value for a date using the WordPress @param string $field_name The EE_Datetime_Field reference for
+	 *                           the date being retrieved.
+	 *
+	 * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
+	 *                           on the object will be used.
+	 * @return string Date and time string in set locale or false if no field exists for the given
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 *                           field name.
+	 * @see date_i18n function.
+	 */
+	public function get_i18n_datetime(string $field_name, string $format = ''): string
+	{
+		$format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
+		return date_i18n(
+			$format,
+			EEH_DTT_Helper::get_timestamp_with_offset(
+				$this->get_raw($field_name),
+				$this->_timezone
+			)
+		);
+	}
+
+
+	/**
+	 * This method validates whether the given field name is a valid field on the model object as well as it is of a
+	 * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
+	 * thrown.
+	 *
+	 * @param string $field_name The field name being checked
+	 * @return EE_Datetime_Field
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_dtt_field_settings($field_name)
+	{
+		$field = $this->get_model()->field_settings_for($field_name);
+		// check if field is dtt
+		if ($field instanceof EE_Datetime_Field) {
+			return $field;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
+					'event_espresso'
+				),
+				$field_name,
+				self::_get_model_classname(get_class($this))
+			)
+		);
+	}
+
+
+
+
+	/**
+	 * NOTE ABOUT BELOW:
+	 * These convenience date and time setters are for setting date and time independently.  In other words you might
+	 * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
+	 * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
+	 * method and make sure you send the entire datetime value for setting.
+	 */
+	/**
+	 * sets the time on a datetime property
+	 *
+	 * @access protected
+	 * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
+	 * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _set_time_for($time, $fieldname)
+	{
+		$this->_set_date_time('T', $time, $fieldname);
+	}
+
+
+	/**
+	 * sets the date on a datetime property
+	 *
+	 * @access protected
+	 * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
+	 * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _set_date_for($date, $fieldname)
+	{
+		$this->_set_date_time('D', $date, $fieldname);
+	}
+
+
+	/**
+	 * This takes care of setting a date or time independently on a given model object property. This method also
+	 * verifies that the given field_name matches a model object property and is for a EE_Datetime_Field field
+	 *
+	 * @access protected
+	 * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
+	 * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
+	 * @param string          $field_name     the name of the field the date OR time is being set on (must match a
+	 *                                        EE_Datetime_Field property)
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _set_date_time(string $what, $datetime_value, string $field_name)
+	{
+		$field = $this->_get_dtt_field_settings($field_name);
+		$field->set_timezone($this->_timezone);
+		$field->set_date_format($this->_dt_frmt);
+		$field->set_time_format($this->_tm_frmt);
+		switch ($what) {
+			case 'T':
+				$this->_fields[ $field_name ] = $field->prepare_for_set_with_new_time(
+					$datetime_value,
+					$this->_fields[ $field_name ]
+				);
+				$this->_has_changes           = true;
+				break;
+			case 'D':
+				$this->_fields[ $field_name ] = $field->prepare_for_set_with_new_date(
+					$datetime_value,
+					$this->_fields[ $field_name ]
+				);
+				$this->_has_changes           = true;
+				break;
+			case 'B':
+				$this->_fields[ $field_name ] = $field->prepare_for_set($datetime_value);
+				$this->_has_changes           = true;
+				break;
+		}
+		$this->_clear_cached_property($field_name);
+	}
+
+
+	/**
+	 * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
+	 * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
+	 * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
+	 * that could lead to some unexpected results!
+	 *
+	 * @access public
+	 * @param string $field_name               This is the name of the field on the object that contains the date/time
+	 *                                         value being returned.
+	 * @param string $callback                 must match a valid method in this class (defaults to get_datetime)
+	 * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
+	 * @param string $prepend                  You can include something to prepend on the timestamp
+	 * @param string $append                   You can include something to append on the timestamp
+	 * @return string timestamp
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function display_in_my_timezone(
+		$field_name,
+		$callback = 'get_datetime',
+		$args = null,
+		$prepend = '',
+		$append = ''
+	) {
+		$timezone = EEH_DTT_Helper::get_timezone();
+		if ($timezone === $this->_timezone) {
+			return '';
+		}
+		$original_timezone = $this->_timezone;
+		$this->set_timezone($timezone);
+		$fn   = (array) $field_name;
+		$args = array_merge($fn, (array) $args);
+		if (! method_exists($this, $callback)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
+						'event_espresso'
+					),
+					$callback
+				)
+			);
+		}
+		$args   = (array) $args;
+		$return = $prepend . call_user_func_array([$this, $callback], $args) . $append;
+		$this->set_timezone($original_timezone);
+		return $return;
+	}
+
+
+	/**
+	 * Deletes this model object.
+	 * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
+	 * override
+	 * `EE_Base_Class::_delete` NOT this class.
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function delete()
+	{
+		/**
+		 * Called just before the `EE_Base_Class::_delete` method call.
+		 * Note:
+		 * `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
+		 * should be aware that `_delete` may not always result in a permanent delete.
+		 * For example, `EE_Soft_Delete_Base_Class::_delete`
+		 * soft deletes (trash) the object and does not permanently delete it.
+		 *
+		 * @param EE_Base_Class $model_object about to be 'deleted'
+		 */
+		do_action('AHEE__EE_Base_Class__delete__before', $this);
+		$deleted = $this->_delete();
+		/**
+		 * Called just after the `EE_Base_Class::_delete` method call.
+		 * Note:
+		 * `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
+		 * should be aware that `_delete` may not always result in a permanent delete.
+		 * For example `EE_Soft_Base_Class::_delete`
+		 * soft deletes (trash) the object and does not permanently delete it.
+		 *
+		 * @param EE_Base_Class $model_object that was just 'deleted'
+		 * @param boolean       $deleted
+		 */
+		do_action('AHEE__EE_Base_Class__delete__end', $this, $deleted);
+		return $deleted;
+	}
+
+
+	/**
+	 * Calls the specific delete method for the instantiated class.
+	 * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
+	 * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
+	 * `EE_Base_Class::delete`
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _delete(): int
+	{
+		return $this->delete_permanently();
+	}
+
+
+	/**
+	 * Deletes this model object permanently from db
+	 * (but keep in mind related models may block the delete and return an error)
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function delete_permanently(): int
+	{
+		/**
+		 * Called just before HARD deleting a model object
+		 *
+		 * @param EE_Base_Class $model_object about to be 'deleted'
+		 */
+		do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
+		$model  = $this->get_model();
+		$result = $model->delete_permanently_by_ID($this->ID());
+		$this->refresh_cache_of_related_objects();
+		/**
+		 * Called just after HARD deleting a model object
+		 *
+		 * @param EE_Base_Class $model_object that was just 'deleted'
+		 * @param boolean       $result
+		 */
+		do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
+		return $result;
+	}
+
+
+	/**
+	 * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
+	 * related model objects
+	 *
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function refresh_cache_of_related_objects()
+	{
+		$model = $this->get_model();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if (! empty($this->_model_relations[ $relation_name ])) {
+				$related_objects = $this->_model_relations[ $relation_name ];
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
+					// this relation only stores a single model object, not an array
+					// but let's make it consistent
+					$related_objects = [$related_objects];
+				}
+				foreach ($related_objects as $related_object) {
+					// only refresh their cache if they're in memory
+					if ($related_object instanceof EE_Base_Class) {
+						$related_object->clear_cache(
+							$model->get_this_model_name(),
+							$this
+						);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *        Saves this object to the database. An array may be supplied to set some values on this
+	 * object just before saving.
+	 *
+	 * @access public
+	 * @param array $set_cols_n_values keys are field names, values are their new values,
+	 *                                 if provided during the save() method (often client code will change the fields'
+	 *                                 values before calling save)
+	 * @return bool|int|string         1 on a successful update
+	 *                                 the ID of the new entry on insert
+	 *                                 0 on failure or if the model object isn't allowed to persist
+	 *                                 (as determined by EE_Base_Class::allow_persist())
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function save($set_cols_n_values = [])
+	{
+		$model = $this->get_model();
+		/**
+		 * Filters the fields we're about to save on the model object
+		 *
+		 * @param array         $set_cols_n_values
+		 * @param EE_Base_Class $model_object
+		 */
+		$set_cols_n_values = (array) apply_filters(
+			'FHEE__EE_Base_Class__save__set_cols_n_values',
+			$set_cols_n_values,
+			$this
+		);
+		// set attributes as provided in $set_cols_n_values
+		foreach ($set_cols_n_values as $column => $value) {
+			$this->set($column, $value);
+		}
+		// no changes ? then don't do anything
+		if (! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
+			return 0;
+		}
+		/**
+		 * Saving a model object.
+		 * Before we perform a save, this action is fired.
+		 *
+		 * @param EE_Base_Class $model_object the model object about to be saved.
+		 */
+		do_action('AHEE__EE_Base_Class__save__begin', $this);
+		if (! $this->allow_persist()) {
+			return 0;
+		}
+		// now get current attribute values
+		$save_cols_n_values = $this->_fields;
+		// if the object already has an ID, update it. Otherwise, insert it
+		// also: change the assumption about values passed to the model NOT being prepare dby the model object.
+		// They have been
+		$old_assumption_concerning_value_preparation = $model
+			->get_assumption_concerning_values_already_prepared_by_model_object();
+		$model->assume_values_already_prepared_by_model_object(true);
+		// does this model have an autoincrement PK?
+		if ($model->has_primary_key_field()) {
+			if ($model->get_primary_key_field()->is_auto_increment()) {
+				// ok check if it's set, if so: update; if not, insert
+				if (! empty($save_cols_n_values[ $model->primary_key_name() ])) {
+					$results = $model->update_by_ID($save_cols_n_values, $this->ID());
+				} else {
+					unset($save_cols_n_values[ $model->primary_key_name() ]);
+					$results = $model->insert($save_cols_n_values);
+					if ($results) {
+						// if successful, set the primary key
+						// but don't use the normal SET method, because it will check if
+						// an item with the same ID exists in the mapper & db, then
+						// will find it in the db (because we just added it) and THAT object
+						// will get added to the mapper before we can add this one!
+						// but if we just avoid using the SET method, all that headache can be avoided
+						$pk_field_name                   = $model->primary_key_name();
+						$this->_fields[ $pk_field_name ] = $results;
+						$this->_clear_cached_property($pk_field_name);
+						$model->add_to_entity_map($this);
+						$this->_update_cached_related_model_objs_fks();
+					}
+				}
+			} else {// PK is NOT auto-increment
+				// so check if one like it already exists in the db
+				if ($model->exists_by_ID($this->ID())) {
+					if (WP_DEBUG && ! $this->in_entity_map()) {
+						throw new EE_Error(
+							sprintf(
+								esc_html__(
+									'Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
+									'event_espresso'
+								),
+								get_class($this),
+								get_class($model) . '::instance()->add_to_entity_map()',
+								get_class($model) . '::instance()->get_one_by_ID()',
+								'<br />'
+							)
+						);
+					}
+					$results = $model->update_by_ID($save_cols_n_values, $this->ID());
+				} else {
+					$results = $model->insert($save_cols_n_values);
+					$this->_update_cached_related_model_objs_fks();
+				}
+			}
+		} else {// there is NO primary key
+			$already_in_db = false;
+			foreach ($model->unique_indexes() as $index) {
+				$uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
+				if ($model->exists([$uniqueness_where_params])) {
+					$already_in_db = true;
+				}
+			}
+			if ($already_in_db) {
+				$combined_pk_fields_n_values = array_intersect_key(
+					$save_cols_n_values,
+					$model->get_combined_primary_key_fields()
+				);
+				$results                     = $model->update(
+					$save_cols_n_values,
+					$combined_pk_fields_n_values
+				);
+			} else {
+				$results = $model->insert($save_cols_n_values);
+			}
+		}
+		// restore the old assumption about values being prepared by the model object
+		$model->assume_values_already_prepared_by_model_object(
+			$old_assumption_concerning_value_preparation
+		);
+		/**
+		 * After saving the model object this action is called
+		 *
+		 * @param EE_Base_Class $model_object which was just saved
+		 * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
+		 *                                    the new ID (or 0 if an error occurred and it wasn't updated)
+		 */
+		do_action('AHEE__EE_Base_Class__save__end', $this, $results);
+		$this->_has_changes = false;
+		return $results;
+	}
+
+
+	/**
+	 * Updates the foreign key on related models objects pointing to this to have this model object's ID
+	 * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
+	 * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
+	 * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
+	 * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
+	 * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
+	 * or not they exist in the DB (if they do, their DB records will be automatically updated)
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _update_cached_related_model_objs_fks()
+	{
+		$model = $this->get_model();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Has_Many_Relation) {
+				foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
+					$fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
+						$model->get_this_model_name()
+					);
+					$related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
+					if ($related_model_obj_in_cache->ID()) {
+						$related_model_obj_in_cache->save();
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Saves this model object and its NEW cached relations to the database.
+	 * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
+	 * In order for that to work, we would need to mark model objects as dirty/clean...
+	 * because otherwise, there's a potential for infinite looping of saving
+	 * Saves the cached related model objects, and ensures the relation between them
+	 * and this object and properly setup
+	 *
+	 * @return int ID of new model object on save; 0 on failure+
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function save_new_cached_related_model_objs()
+	{
+		// make sure this has been saved
+		if (! $this->ID()) {
+			$id = $this->save();
+		} else {
+			$id = $this->ID();
+		}
+		// now save all the NEW cached model objects  (ie they don't exist in the DB)
+		foreach ($this->get_model()->relation_settings() as $relation_name => $relationObj) {
+			if ($this->_model_relations[ $relation_name ]) {
+				// is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
+				// or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
+				/* @var $related_model_obj EE_Base_Class */
+				if ($relationObj instanceof EE_Belongs_To_Relation) {
+					// add a relation to that relation type (which saves the appropriate thing in the process)
+					// but ONLY if it DOES NOT exist in the DB
+					$related_model_obj = $this->_model_relations[ $relation_name ];
+					// if( ! $related_model_obj->ID()){
+					$this->_add_relation_to($related_model_obj, $relation_name);
+					$related_model_obj->save_new_cached_related_model_objs();
+					// }
+				} else {
+					foreach ($this->_model_relations[ $relation_name ] as $related_model_obj) {
+						// add a relation to that relation type (which saves the appropriate thing in the process)
+						// but ONLY if it DOES NOT exist in the DB
+						// if( ! $related_model_obj->ID()){
+						$this->_add_relation_to($related_model_obj, $relation_name);
+						$related_model_obj->save_new_cached_related_model_objs();
+						// }
+					}
+				}
+			}
+		}
+		return $id;
+	}
+
+
+	/**
+	 * for getting a model while instantiated.
+	 *
+	 * @return EEM_Base | EEM_CPT_Base
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_model()
+	{
+		if (! $this->_model) {
+			$modelName    = self::_get_model_classname(get_class($this));
+			$this->_model = self::_get_model_instance_with_name($modelName, $this->_timezone);
+		} else {
+			$this->_model->set_timezone($this->_timezone);
+		}
+		return $this->_model;
+	}
+
+
+	/**
+	 * @param $props_n_values
+	 * @param $classname
+	 * @return mixed bool|EE_Base_Class|EEM_CPT_Base
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected static function _get_object_from_entity_mapper($props_n_values, $classname)
+	{
+		// TODO: will not work for Term_Relationships because they have no PK!
+		$primary_id_ref = self::_get_primary_key_name($classname);
+		if (
+			array_key_exists($primary_id_ref, $props_n_values)
+			&& ! empty($props_n_values[ $primary_id_ref ])
+		) {
+			$id = $props_n_values[ $primary_id_ref ];
+			return self::_get_model($classname)->get_from_entity_map($id);
+		}
+		return false;
+	}
+
+
+	/**
+	 * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
+	 * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
+	 * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
+	 * we return false.
+	 *
+	 * @param array  $props_n_values    incoming array of properties and their values
+	 * @param string $classname         the classname of the child class
+	 * @param null   $timezone
+	 * @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 mixed (EE_Base_Class|bool)
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _check_for_object($props_n_values, $classname, $timezone = '', $date_formats = [])
+	{
+		$existing = null;
+		$model    = self::_get_model($classname, $timezone);
+		if ($model->has_primary_key_field()) {
+			$primary_id_ref = self::_get_primary_key_name($classname);
+			if (
+				array_key_exists($primary_id_ref, $props_n_values)
+				&& ! empty($props_n_values[ $primary_id_ref ])
+			) {
+				$existing = $model->get_one_by_ID(
+					$props_n_values[ $primary_id_ref ]
+				);
+			}
+		} elseif ($model->has_all_combined_primary_key_fields($props_n_values)) {
+			// no primary key on this model, but there's still a matching item in the DB
+			$existing = self::_get_model($classname, $timezone)->get_one_by_ID(
+				self::_get_model($classname, $timezone)
+					->get_index_primary_key_string($props_n_values)
+			);
+		}
+		if ($existing) {
+			// set date formats if present before setting values
+			if (! empty($date_formats) && is_array($date_formats)) {
+				$existing->set_date_format($date_formats[0]);
+				$existing->set_time_format($date_formats[1]);
+			} else {
+				// set default formats for date and time
+				$existing->set_date_format(get_option('date_format'));
+				$existing->set_time_format(get_option('time_format'));
+			}
+			foreach ($props_n_values as $property => $field_value) {
+				$existing->set($property, $field_value);
+			}
+			return $existing;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets the EEM_*_Model for this class
+	 *
+	 * @access public now, as this is more convenient
+	 * @param      $classname
+	 * @param null $timezone
+	 * @return EEM_Base
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _get_model($classname, $timezone = '')
+	{
+		// find model for this class
+		if (! $classname) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'What were you thinking calling _get_model(%s)?? You need to specify the class name',
+						'event_espresso'
+					),
+					$classname
+				)
+			);
+		}
+		$modelName = self::_get_model_classname($classname);
+		return self::_get_model_instance_with_name($modelName, $timezone);
+	}
+
+
+	/**
+	 * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
+	 *
+	 * @param string $model_classname
+	 * @param null   $timezone
+	 * @return EEM_Base
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected static function _get_model_instance_with_name($model_classname, $timezone = '')
+	{
+		$model_classname = str_replace('EEM_', '', $model_classname);
+		$model           = EE_Registry::instance()->load_model($model_classname);
+		$model->set_timezone($timezone);
+		return $model;
+	}
+
+
+	/**
+	 * If a model name is provided (eg Registration), gets the model classname for that model.
+	 * Also works if a model class's classname is provided (eg EE_Registration).
+	 *
+	 * @param string|null $model_name
+	 * @return string like EEM_Attendee
+	 */
+	private static function _get_model_classname($model_name = '')
+	{
+		return strpos((string) $model_name, 'EE_') === 0
+			? str_replace('EE_', 'EEM_', $model_name)
+			: 'EEM_' . $model_name;
+	}
+
+
+	/**
+	 * returns the name of the primary key attribute
+	 *
+	 * @param null $classname
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _get_primary_key_name($classname = null)
+	{
+		if (! $classname) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('What were you thinking calling _get_primary_key_name(%s)', 'event_espresso'),
+					$classname
+				)
+			);
+		}
+		return self::_get_model($classname)->get_primary_key_field()->get_name();
+	}
+
+
+	/**
+	 * Gets the value of the primary key.
+	 * If the object hasn't yet been saved, it should be whatever the model field's default was
+	 * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
+	 * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
+	 *
+	 * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function ID()
+	{
+		$model = $this->get_model();
+		// now that we know the name of the variable, use a variable variable to get its value and return its
+		if ($model->has_primary_key_field()) {
+			return $this->_fields[ $model->primary_key_name() ];
+		}
+		return $model->get_index_primary_key_string($this->_fields);
+	}
+
+
+	/**
+	 * @param EE_Base_Class|int|string $otherModelObjectOrID
+	 * @param string                   $relation_name
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function hasRelation($otherModelObjectOrID, string $relation_name): bool
+	{
+		$other_model = self::_get_model_instance_with_name(
+			self::_get_model_classname($relation_name),
+			$this->_timezone
+		);
+		$primary_key = $other_model->primary_key_name();
+		/** @var EE_Base_Class $otherModelObject */
+		$otherModelObject = $other_model->ensure_is_obj($otherModelObjectOrID, $relation_name);
+		return $this->count_related($relation_name, [[$primary_key => $otherModelObject->ID()]]) > 0;
+	}
+
+
+	/**
+	 * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
+	 * model is related to a group of events, the $relation_name should be 'Event', and should be a key in the EE
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
+	 *
+	 * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
+	 * @param string $relation_name                    eg 'Events','Question',etc.
+	 *                                                 an attendee to a group, you also want to specify which role they
+	 *                                                 will have in that group. So you would use this parameter to
+	 *                                                 specify array('role-column-name'=>'role-id')
+	 * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
+	 *                                                 allow you to further constrict the relation to being added.
+	 *                                                 However, keep in mind that the columns (keys) given must match a
+	 *                                                 column on the JOIN table and currently only the HABTM models
+	 *                                                 accept these additional conditions.  Also remember that if an
+	 *                                                 exact match isn't found for these extra cols/val pairs, then a
+	 *                                                 NEW row is created in the join table.
+	 * @param null   $cache_id
+	 * @return EE_Base_Class the object the relation was added to
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function _add_relation_to(
+		$otherObjectModelObjectOrID,
+		$relation_name,
+		$extra_join_model_fields_n_values = [],
+		$cache_id = null
+	) {
+		$model = $this->get_model();
+		// if this thing exists in the DB, save the relation to the DB
+		if ($this->ID()) {
+			$otherObject = $model->add_relationship_to(
+				$this,
+				$otherObjectModelObjectOrID,
+				$relation_name,
+				$extra_join_model_fields_n_values
+			);
+			// clear cache so future get_many_related and get_first_related() return new results.
+			$this->clear_cache($relation_name, $otherObject, true);
+			if ($otherObject instanceof EE_Base_Class) {
+				$otherObject->clear_cache($model->get_this_model_name(), $this);
+			}
+		} else {
+			// this thing doesn't exist in the DB,  so just cache it
+			if (! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
+							'event_espresso'
+						),
+						$otherObjectModelObjectOrID,
+						get_class($this)
+					)
+				);
+			}
+			$otherObject = $otherObjectModelObjectOrID;
+			$this->cache($relation_name, $otherObjectModelObjectOrID, $cache_id);
+		}
+		if ($otherObject instanceof EE_Base_Class) {
+			// fix the reciprocal relation too
+			if ($otherObject->ID()) {
+				// its saved so assumed relations exist in the DB, so we can just
+				// clear the cache so future queries use the updated info in the DB
+				$otherObject->clear_cache(
+					$model->get_this_model_name(),
+					null,
+					true
+				);
+			} else {
+				// it's not saved, so it caches relations like this
+				$otherObject->cache($model->get_this_model_name(), $this);
+			}
+		}
+		return $otherObject;
+	}
+
+
+	/**
+	 * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
+	 * model is related to a group of events, the $relation_name should be 'Events', and should be a key in the EE
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
+	 * from the cache
+	 *
+	 * @param mixed  $otherObjectModelObjectOrID
+	 *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
+	 *                to the DB yet
+	 * @param string $relation_name
+	 * @param array  $where_query
+	 *                You can optionally include an array of key=>value pairs that allow you to further constrict the
+	 *                relation to being added. However, keep in mind that the columns (keys) given must match a column
+	 *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
+	 *                remember that if an exact match isn't found for these extra cols/val pairs, then no row is
+	 *                deleted.
+	 * @return EE_Base_Class|bool   the related entity that was removed
+	 *                              or true if multiple entities removed
+	 *                              or false if nothing was cached
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function _remove_relation_to($otherObjectModelObjectOrID, $relation_name, $where_query = [])
+	{
+		if ($this->ID()) {
+			// if this exists in the DB, save the relation change to the DB too
+			$otherObject = $this->get_model()->remove_relationship_to(
+				$this,
+				$otherObjectModelObjectOrID,
+				$relation_name,
+				$where_query
+			);
+			$this->clear_cache(
+				$relation_name,
+				$otherObject
+			);
+		} else {
+			// this doesn't exist in the DB, just remove it from the cache
+			$otherObject = $this->clear_cache(
+				$relation_name,
+				$otherObjectModelObjectOrID
+			);
+		}
+		if ($otherObject instanceof EE_Base_Class) {
+			$otherObject->clear_cache(
+				$this->get_model()->get_this_model_name(),
+				$this
+			);
+		}
+		return $otherObject;
+	}
+
+
+	/**
+	 * Removes ALL the related things for the $relation_name.
+	 *
+	 * @param string $relation_name
+	 * @param array  $where_query_params @see
+	 *                                   https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @return EE_Base_Class
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function _remove_relations($relation_name, $where_query_params = [])
+	{
+		if ($this->ID()) {
+			// if this exists in the DB, save the relation change to the DB too
+			$otherObjects = $this->get_model()->remove_relations(
+				$this,
+				$relation_name,
+				$where_query_params
+			);
+			$this->clear_cache(
+				$relation_name,
+				null,
+				true
+			);
+		} else {
+			// this doesn't exist in the DB, just remove it from the cache
+			$otherObjects = $this->clear_cache(
+				$relation_name,
+				null,
+				true
+			);
+		}
+		if (is_array($otherObjects)) {
+			foreach ($otherObjects as $otherObject) {
+				$otherObject->clear_cache(
+					$this->get_model()->get_this_model_name(),
+					$this
+				);
+			}
+		}
+		return $otherObjects;
+	}
+
+
+	/**
+	 * Gets all the related model objects of the specified type. Eg, if the current class if
+	 * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
+	 * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
+	 * because we want to get even deleted items etc.
+	 *
+	 * @param string      $relation_name key in the model's _model_relations array
+	 * @param array|null  $query_params  @see
+	 *                              https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @return EE_Base_Class[]     Results not necessarily indexed by IDs, because some results might not have primary
+	 *                              keys or might not be saved yet. Consider using EEM_Base::get_IDs() on these
+	 *                              results if you want IDs
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_many_related($relation_name, $query_params = [])
+	{
+		if ($this->ID()) {
+			// this exists in the DB, so get the related things from either the cache or the DB
+			// if there are query parameters, forget about caching the related model objects.
+			if ($query_params) {
+				$related_model_objects = $this->get_model()->get_all_related(
+					$this,
+					$relation_name,
+					$query_params
+				);
+			} else {
+				// did we already cache the result of this query?
+				$cached_results = $this->get_all_from_cache($relation_name);
+				if (! $cached_results) {
+					$related_model_objects = $this->get_model()->get_all_related(
+						$this,
+						$relation_name,
+						$query_params
+					);
+					// if no query parameters were passed, then we got all the related model objects
+					// for that relation. We can cache them then.
+					foreach ($related_model_objects as $related_model_object) {
+						$this->cache($relation_name, $related_model_object);
+					}
+				} else {
+					$related_model_objects = $cached_results;
+				}
+			}
+		} else {
+			// this doesn't exist in the DB, so just get the related things from the cache
+			$related_model_objects = $this->get_all_from_cache($relation_name);
+		}
+		return $related_model_objects;
+	}
+
+
+	/**
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
+	 * unless otherwise specified in the $query_params
+	 *
+	 * @param string $relation_name  model_name like 'Event', or 'Registration'
+	 * @param array  $query_params   @see
+	 *                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
+	 *                               that by the setting $distinct to TRUE;
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function count_related($relation_name, $query_params = [], $field_to_count = null, $distinct = false)
+	{
+		return $this->get_model()->count_related(
+			$this,
+			$relation_name,
+			$query_params,
+			$field_to_count,
+			$distinct
+		);
+	}
+
+
+	/**
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
+	 *
+	 * @param string $relation_name model_name like 'Event', or 'Registration'
+	 * @param array  $query_params  @see
+	 *                              https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_sum  name of field to count by.
+	 *                              By default, uses primary key
+	 *                              (which doesn't make much sense, so you should probably change it)
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sum_related($relation_name, $query_params = [], $field_to_sum = null)
+	{
+		return $this->get_model()->sum_related(
+			$this,
+			$relation_name,
+			$query_params,
+			$field_to_sum
+		);
+	}
+
+
+	/**
+	 * Gets the first (ie, one) related model object of the specified type.
+	 *
+	 * @param string $relation_name key in the model's _model_relations array
+	 * @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|null (not an array, a single object)
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_first_related(string $relation_name, array $query_params = []): ?EE_Base_Class
+	{
+		$model = $this->get_model();
+		if ($this->ID()) {// this exists in the DB, get from the cache OR the DB
+			// if they've provided some query parameters, don't bother trying to cache the result
+			// also make sure we're not caching the result of get_first_related
+			// on a relation which should have an array of objects (because the cache might have an array of objects)
+			if (
+				$query_params
+				|| ! $model->related_settings_for($relation_name) instanceof EE_Belongs_To_Relation
+			) {
+				$related_model_object = $model->get_first_related(
+					$this,
+					$relation_name,
+					$query_params
+				);
+			} else {
+				// first, check if we've already cached the result of this query
+				$cached_result = $this->get_one_from_cache($relation_name);
+				if (! $cached_result) {
+					$related_model_object = $model->get_first_related(
+						$this,
+						$relation_name,
+						$query_params
+					);
+					$this->cache($relation_name, $related_model_object);
+				} else {
+					$related_model_object = $cached_result;
+				}
+			}
+		} else {
+			$related_model_object = null;
+			// this doesn't exist in the Db,
+			// but maybe the relation is of type belongs to, and so the related thing might
+			if ($model->related_settings_for($relation_name) instanceof EE_Belongs_To_Relation) {
+				$related_model_object = $model->get_first_related(
+					$this,
+					$relation_name,
+					$query_params
+				);
+			}
+			// this doesn't exist in the DB and apparently the thing it belongs to doesn't either,
+			// just get what's cached on this object
+			if (! $related_model_object) {
+				$related_model_object = $this->get_one_from_cache($relation_name);
+			}
+		}
+		return $related_model_object;
+	}
+
+
+	/**
+	 * Does a delete on all related objects of type $relation_name and removes
+	 * the current model object's relation to them. If they can't be deleted (because
+	 * of blocking related model objects) does nothing. If the related model objects are
+	 * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
+	 * If this model object doesn't exist yet in the DB, just removes its related things
+	 *
+	 * @param string $relation_name
+	 * @param array  $query_params @see
+	 *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return int how many deleted
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function delete_related($relation_name, $query_params = [])
+	{
+		if ($this->ID()) {
+			$count = $this->get_model()->delete_related(
+				$this,
+				$relation_name,
+				$query_params
+			);
+		} else {
+			$count = count($this->get_all_from_cache($relation_name));
+			$this->clear_cache($relation_name, null, true);
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Does a hard delete (ie, removes the DB row) on all related objects of type $relation_name and removes
+	 * the current model object's relation to them. If they can't be deleted (because
+	 * of blocking related model objects) just does a soft delete on it instead, if possible.
+	 * If the related thing isn't a soft-deletable model object, this function is identical
+	 * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
+	 *
+	 * @param string $relation_name
+	 * @param array  $query_params @see
+	 *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return int how many deleted (including those soft deleted)
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function delete_related_permanently($relation_name, $query_params = [])
+	{
+		$count = $this->ID()
+			? $this->get_model()->delete_related_permanently(
+				$this,
+				$relation_name,
+				$query_params
+			)
+			: count($this->get_all_from_cache($relation_name));
+
+		$this->clear_cache($relation_name, null, true);
+		return $count;
+	}
+
+
+	/**
+	 * is_set
+	 * Just a simple utility function children can use for checking if property exists
+	 *
+	 * @access  public
+	 * @param string $field_name property to check
+	 * @return bool                              TRUE if existing,FALSE if not.
+	 */
+	public function is_set($field_name)
+	{
+		return isset($this->_fields[ $field_name ]);
+	}
+
+
+	/**
+	 * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
+	 * EE_Error exception if they don't
+	 *
+	 * @param mixed (string|array) $properties properties to check
+	 * @return bool                              TRUE if existing, throw EE_Error if not.
+	 * @throws EE_Error
+	 */
+	protected function _property_exists($properties)
+	{
+		foreach ((array) $properties as $property_name) {
+			// first make sure this property exists
+			if (! $this->_fields[ $property_name ]) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
+							'event_espresso'
+						),
+						$property_name
+					)
+				);
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This simply returns an array of model fields for this object
+	 *
+	 * @return array
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function model_field_array()
+	{
+		$fields     = $this->get_model()->field_settings(false);
+		$properties = [];
+		// remove prepended underscore
+		foreach ($fields as $field_name => $settings) {
+			$properties[ $field_name ] = $this->get($field_name);
+		}
+		return $properties;
+	}
+
+
+	/**
+	 * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
+	 * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments.
+	 * Instead of requiring a plugin to extend the EE_Base_Class
+	 * (which works fine is there's only 1 plugin, but when will that happen?)
+	 * they can add a hook onto 'filters_hook_espresso__{className}__{methodName}'
+	 * (eg, filters_hook_espresso__EE_Answer__my_great_function)
+	 * and accepts 2 arguments: the object on which the function was called,
+	 * and an array of the original arguments passed to the function.
+	 * Whatever their callback function returns will be returned by this function.
+	 * Example: in functions.php (or in a plugin):
+	 *      add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3);
+	 *      function my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
+	 *          $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
+	 *          return $previousReturnValue.$returnString;
+	 *      }
+	 * require('EE_Answer.class.php');
+	 * echo EE_Answer::new_instance(['REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'])
+	 *      ->my_callback('monkeys',100);
+	 * // will output "you called my_callback! and passed args:monkeys,100"
+	 *
+	 * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
+	 * @param array  $args       array of original arguments passed to the function
+	 * @return mixed whatever the plugin which calls add_filter decides
+	 * @throws EE_Error
+	 */
+	public function __call($methodName, $args)
+	{
+		$className = get_class($this);
+		$tagName   = "FHEE__{$className}__{$methodName}";
+		if (! has_filter($tagName)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
+						'event_espresso'
+					),
+					$methodName,
+					$className,
+					$tagName
+				)
+			);
+		}
+		return apply_filters($tagName, null, $this, $args);
+	}
+
+
+	/**
+	 * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
+	 * A $previous_value can be specified in case there are many meta rows with the same key
+	 *
+	 * @param string $meta_key
+	 * @param mixed  $meta_value
+	 * @param mixed  $previous_value
+	 * @return bool|int # of records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
+	 *                  NOTE: if the values haven't changed, returns 0
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_extra_meta(string $meta_key, $meta_value, $previous_value = null)
+	{
+		$query_params = [
+			[
+				'EXM_key'  => $meta_key,
+				'OBJ_ID'   => $this->ID(),
+				'EXM_type' => $this->get_model()->get_this_model_name(),
+			],
+		];
+		if ($previous_value !== null) {
+			$query_params[0]['EXM_value'] = $meta_value;
+		}
+		$existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
+		if (! $existing_rows_like_that) {
+			return $this->add_extra_meta($meta_key, $meta_value);
+		}
+		foreach ($existing_rows_like_that as $existing_row) {
+			$existing_row->save(['EXM_value' => $meta_value]);
+		}
+		return count($existing_rows_like_that);
+	}
+
+
+	/**
+	 * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
+	 * no other extra meta for this model object have the same key. Returns TRUE if the
+	 * extra meta row was entered, false if not
+	 *
+	 * @param string $meta_key
+	 * @param mixed  $meta_value
+	 * @param bool   $unique
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_extra_meta(string $meta_key, $meta_value, bool $unique = false): bool
+	{
+		if ($unique) {
+			$existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
+				[
+					[
+						'EXM_key'  => $meta_key,
+						'OBJ_ID'   => $this->ID(),
+						'EXM_type' => $this->get_model()->get_this_model_name(),
+					],
+				]
+			);
+			if ($existing_extra_meta) {
+				return false;
+			}
+		}
+		$new_extra_meta = EE_Extra_Meta::new_instance(
+			[
+				'EXM_key'   => $meta_key,
+				'EXM_value' => $meta_value,
+				'OBJ_ID'    => $this->ID(),
+				'EXM_type'  => $this->get_model()->get_this_model_name(),
+			]
+		);
+		$new_extra_meta->save();
+		return true;
+	}
+
+
+	/**
+	 * Deletes all the extra meta rows for this record as specified by key. If $meta_value
+	 * is specified, only deletes extra meta records with that value.
+	 *
+	 * @param string $meta_key
+	 * @param mixed  $meta_value
+	 * @return int number of extra meta rows deleted
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_extra_meta(string $meta_key, $meta_value = null)
+	{
+		$query_params = [
+			[
+				'EXM_key'  => $meta_key,
+				'OBJ_ID'   => $this->ID(),
+				'EXM_type' => $this->get_model()->get_this_model_name(),
+			],
+		];
+		if ($meta_value !== null) {
+			$query_params[0]['EXM_value'] = $meta_value;
+		}
+		return EEM_Extra_Meta::instance()->delete($query_params);
+	}
+
+
+	/**
+	 * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
+	 * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
+	 * You can specify $default is case you haven't found the extra meta
+	 *
+	 * @param string     $meta_key
+	 * @param bool       $single
+	 * @param mixed      $default if we don't find anything, what should we return?
+	 * @param array|null $extra_where
+	 * @return mixed single value if $single; array if ! $single
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function get_extra_meta(string $meta_key, bool $single = false, $default = null, ?array $extra_where = [])
+	{
+		$query_params = [$extra_where + ['EXM_key' => $meta_key]];
+		if ($single) {
+			$result = $this->get_first_related('Extra_Meta', $query_params);
+			if ($result instanceof EE_Extra_Meta) {
+				return $result->value();
+			}
+		} else {
+			$results = $this->get_many_related('Extra_Meta', $query_params);
+			if ($results) {
+				$values = [];
+				foreach ($results as $result) {
+					if ($result instanceof EE_Extra_Meta) {
+						$values[ $result->ID() ] = $result->value();
+					}
+				}
+				return $values;
+			}
+		}
+		// if nothing discovered yet return default.
+		return apply_filters(
+			'FHEE__EE_Base_Class__get_extra_meta__default_value',
+			$default,
+			$meta_key,
+			$single,
+			$this
+		);
+	}
+
+
+	/**
+	 * Returns a simple array of all the extra meta associated with this model object.
+	 * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
+	 * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
+	 * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
+	 * If $one_of_each_key is false, it will return an array with the top-level keys being
+	 * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
+	 * finally the extra meta's value as each sub-value. (eg
+	 * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
+	 *
+	 * @param bool $one_of_each_key
+	 * @return array
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function all_extra_meta_array(bool $one_of_each_key = true): array
+	{
+		$return_array = [];
+		if ($one_of_each_key) {
+			$extra_meta_objs = $this->get_many_related(
+				'Extra_Meta',
+				['group_by' => 'EXM_key']
+			);
+			foreach ($extra_meta_objs as $extra_meta_obj) {
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
+					$return_array[ $extra_meta_obj->key() ] = $extra_meta_obj->value();
+				}
+			}
+		} else {
+			$extra_meta_objs = $this->get_many_related('Extra_Meta');
+			foreach ($extra_meta_objs as $extra_meta_obj) {
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
+					if (! isset($return_array[ $extra_meta_obj->key() ])) {
+						$return_array[ $extra_meta_obj->key() ] = [];
+					}
+					$return_array[ $extra_meta_obj->key() ][ $extra_meta_obj->ID() ] = $extra_meta_obj->value();
+				}
+			}
+		}
+		return $return_array;
+	}
+
+
+	/**
+	 * Gets a pretty nice displayable nice for this model object. Often overridden
+	 *
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		// find a field that's not a text field
+		$field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
+		if ($field_we_can_use) {
+			return $this->get($field_we_can_use->get_name());
+		}
+		$first_few_properties = $this->model_field_array();
+		$first_few_properties = array_slice($first_few_properties, 0, 3);
+		$name_parts           = [];
+		foreach ($first_few_properties as $name => $value) {
+			$name_parts[] = "$name:$value";
+		}
+		return implode(',', $name_parts);
+	}
+
+
+	/**
+	 * in_entity_map
+	 * Checks if this model object has been proven to already be in the entity map
+	 *
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function in_entity_map()
+	{
+		// well, if we looked, did we find it in the entity map?
+		return $this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this;
+	}
+
+
+	/**
+	 * refresh_from_db
+	 * Makes sure the fields and values on this model object are in-sync with what's in the database.
+	 *
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error if this model object isn't in the entity mapper (because then you should
+	 * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
+	 */
+	public function refresh_from_db()
+	{
+		if ($this->ID() && $this->in_entity_map()) {
+			$this->get_model()->refresh_entity_map_from_db($this->ID());
+		} else {
+			// if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
+			// if it has an ID but it's not in the map, and you're asking me to refresh it
+			// that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
+			// absolutely nothing in it for this ID
+			if (WP_DEBUG) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
+							'event_espresso'
+						),
+						$this->ID(),
+						get_class($this->get_model()) . '::instance()->add_to_entity_map()',
+						get_class($this->get_model()) . '::instance()->refresh_entity_map()'
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Change $fields' values to $new_value_sql (which is a string of raw SQL)
+	 *
+	 * @param EE_Model_Field_Base[] $fields
+	 * @param string                $new_value_sql
+	 *          example: 'column_name=123',
+	 *          or 'column_name=column_name+1',
+	 *          or 'column_name= CASE
+	 *          WHEN (`column_name` + `other_column` + 5) <= `yet_another_column`
+	 *          THEN `column_name` + 5
+	 *          ELSE `column_name`
+	 *          END'
+	 *          Also updates $field on this model object with the latest value from the database.
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.9.80.p
+	 */
+	protected function updateFieldsInDB($fields, $new_value_sql)
+	{
+		// First make sure this model object actually exists in the DB. It would be silly to try to update it in the DB
+		// if it wasn't even there to start off.
+		if (! $this->ID()) {
+			$this->save();
+		}
+		global $wpdb;
+		if (empty($fields)) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'EE_Base_Class::updateFieldsInDB was passed an empty array of fields.',
+					'event_espresso'
+				)
+			);
+		}
+		$first_field = reset($fields);
+		$table_alias = $first_field->get_table_alias();
+		foreach ($fields as $field) {
+			if ($table_alias !== $field->get_table_alias()) {
+				throw new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+						// @codingStandardsIgnoreStart
+							'EE_Base_Class::updateFieldsInDB was passed fields for different tables ("%1$s" and "%2$s"), which is not supported. Instead, please call the method multiple times.',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						),
+						$table_alias,
+						$field->get_table_alias()
+					)
+				);
+			}
+		}
+		// Ok the fields are now known to all be for the same table. Proceed with creating the SQL to update it.
+		$table_obj      = $this->get_model()->get_table_obj_by_alias($table_alias);
+		$table_pk_value = $this->ID();
+		$table_name     = $table_obj->get_table_name();
+		if ($table_obj instanceof EE_Secondary_Table) {
+			$table_pk_field_name = $table_obj->get_fk_on_table();
+		} else {
+			$table_pk_field_name = $table_obj->get_pk_column();
+		}
+
+		$query  =
+			"UPDATE `{$table_name}`
             SET "
-            . $new_value_sql
-            . $wpdb->prepare(
-                "
+			. $new_value_sql
+			. $wpdb->prepare(
+				"
             WHERE `{$table_pk_field_name}` = %d;",
-                $table_pk_value
-            );
-        $result = $wpdb->query($query);
-        foreach ($fields as $field) {
-            // If it was successful, we'd like to know the new value.
-            // If it failed, we'd also like to know the new value.
-            $new_value = $this->get_model()->get_var(
-                $this->get_model()->alter_query_params_to_restrict_by_ID(
-                    $this->get_model()->get_index_primary_key_string(
-                        $this->model_field_array()
-                    ),
-                    [
-                        'default_where_conditions' => 'minimum',
-                    ]
-                ),
-                $field->get_name()
-            );
-            $this->set_from_db(
-                $field->get_name(),
-                $new_value
-            );
-        }
-        return (bool) $result;
-    }
-
-
-    /**
-     * Nudges $field_name's value by $quantity, without any conditionals (in comparison to bumpConditionally()).
-     * Does not allow negative values, however.
-     *
-     * @param array $fields_n_quantities keys are the field names, and values are the amount by which to bump them
-     *                                   (positive or negative). One important gotcha: all these values must be
-     *                                   on the same table (eg don't pass in one field for the posts table and
-     *                                   another for the event meta table.)
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.9.80.p
-     */
-    public function adjustNumericFieldsInDb(array $fields_n_quantities)
-    {
-        global $wpdb;
-        if (empty($fields_n_quantities)) {
-            // No fields to update? Well sure, we updated them to that value just fine.
-            return true;
-        }
-        $fields             = [];
-        $set_sql_statements = [];
-        foreach ($fields_n_quantities as $field_name => $quantity) {
-            $field       = $this->get_model()->field_settings_for($field_name, true);
-            $fields[]    = $field;
-            $column_name = $field->get_table_column();
-
-            $abs_qty = absint($quantity);
-            if ($quantity > 0) {
-                // don't let the value be negative as often these fields are unsigned
-                $set_sql_statements[] = $wpdb->prepare(
-                    "`{$column_name}` = `{$column_name}` + %d",
-                    $abs_qty
-                );
-            } else {
-                $set_sql_statements[] = $wpdb->prepare(
-                    "`{$column_name}` = CASE
+				$table_pk_value
+			);
+		$result = $wpdb->query($query);
+		foreach ($fields as $field) {
+			// If it was successful, we'd like to know the new value.
+			// If it failed, we'd also like to know the new value.
+			$new_value = $this->get_model()->get_var(
+				$this->get_model()->alter_query_params_to_restrict_by_ID(
+					$this->get_model()->get_index_primary_key_string(
+						$this->model_field_array()
+					),
+					[
+						'default_where_conditions' => 'minimum',
+					]
+				),
+				$field->get_name()
+			);
+			$this->set_from_db(
+				$field->get_name(),
+				$new_value
+			);
+		}
+		return (bool) $result;
+	}
+
+
+	/**
+	 * Nudges $field_name's value by $quantity, without any conditionals (in comparison to bumpConditionally()).
+	 * Does not allow negative values, however.
+	 *
+	 * @param array $fields_n_quantities keys are the field names, and values are the amount by which to bump them
+	 *                                   (positive or negative). One important gotcha: all these values must be
+	 *                                   on the same table (eg don't pass in one field for the posts table and
+	 *                                   another for the event meta table.)
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.9.80.p
+	 */
+	public function adjustNumericFieldsInDb(array $fields_n_quantities)
+	{
+		global $wpdb;
+		if (empty($fields_n_quantities)) {
+			// No fields to update? Well sure, we updated them to that value just fine.
+			return true;
+		}
+		$fields             = [];
+		$set_sql_statements = [];
+		foreach ($fields_n_quantities as $field_name => $quantity) {
+			$field       = $this->get_model()->field_settings_for($field_name, true);
+			$fields[]    = $field;
+			$column_name = $field->get_table_column();
+
+			$abs_qty = absint($quantity);
+			if ($quantity > 0) {
+				// don't let the value be negative as often these fields are unsigned
+				$set_sql_statements[] = $wpdb->prepare(
+					"`{$column_name}` = `{$column_name}` + %d",
+					$abs_qty
+				);
+			} else {
+				$set_sql_statements[] = $wpdb->prepare(
+					"`{$column_name}` = CASE
                        WHEN (`{$column_name}` >= %d)
                        THEN `{$column_name}` - %d
                        ELSE 0
                     END",
-                    $abs_qty,
-                    $abs_qty
-                );
-            }
-        }
-        return $this->updateFieldsInDB(
-            $fields,
-            implode(', ', $set_sql_statements)
-        );
-    }
-
-
-    /**
-     * Increases the value of the field $field_name_to_bump by $quantity, but only if the values of
-     * $field_name_to_bump plus $field_name_affecting_total and $quantity won't exceed $limit_field_name's value.
-     * For example, this is useful when bumping the value of TKT_reserved, TKT_sold, DTT_reserved or DTT_sold.
-     * Returns true if the value was successfully bumped, and updates the value on this model object.
-     * Otherwise returns false.
-     *
-     * @param string $field_name_to_bump
-     * @param string $field_name_affecting_total
-     * @param string $limit_field_name
-     * @param int    $quantity
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.9.80.p
-     */
-    public function incrementFieldConditionallyInDb(
-        $field_name_to_bump,
-        $field_name_affecting_total,
-        $limit_field_name,
-        $quantity
-    ) {
-        global $wpdb;
-        $field       = $this->get_model()->field_settings_for($field_name_to_bump, true);
-        $column_name = $field->get_table_column();
-
-        $field_affecting_total  = $this->get_model()->field_settings_for($field_name_affecting_total, true);
-        $column_affecting_total = $field_affecting_total->get_table_column();
-
-        $limiting_field  = $this->get_model()->field_settings_for($limit_field_name, true);
-        $limiting_column = $limiting_field->get_table_column();
-        return $this->updateFieldsInDB(
-            [$field],
-            $wpdb->prepare(
-                "`{$column_name}` =
+					$abs_qty,
+					$abs_qty
+				);
+			}
+		}
+		return $this->updateFieldsInDB(
+			$fields,
+			implode(', ', $set_sql_statements)
+		);
+	}
+
+
+	/**
+	 * Increases the value of the field $field_name_to_bump by $quantity, but only if the values of
+	 * $field_name_to_bump plus $field_name_affecting_total and $quantity won't exceed $limit_field_name's value.
+	 * For example, this is useful when bumping the value of TKT_reserved, TKT_sold, DTT_reserved or DTT_sold.
+	 * Returns true if the value was successfully bumped, and updates the value on this model object.
+	 * Otherwise returns false.
+	 *
+	 * @param string $field_name_to_bump
+	 * @param string $field_name_affecting_total
+	 * @param string $limit_field_name
+	 * @param int    $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.9.80.p
+	 */
+	public function incrementFieldConditionallyInDb(
+		$field_name_to_bump,
+		$field_name_affecting_total,
+		$limit_field_name,
+		$quantity
+	) {
+		global $wpdb;
+		$field       = $this->get_model()->field_settings_for($field_name_to_bump, true);
+		$column_name = $field->get_table_column();
+
+		$field_affecting_total  = $this->get_model()->field_settings_for($field_name_affecting_total, true);
+		$column_affecting_total = $field_affecting_total->get_table_column();
+
+		$limiting_field  = $this->get_model()->field_settings_for($limit_field_name, true);
+		$limiting_column = $limiting_field->get_table_column();
+		return $this->updateFieldsInDB(
+			[$field],
+			$wpdb->prepare(
+				"`{$column_name}` =
             CASE
                WHEN ((`{$column_name}` + `{$column_affecting_total}` + %d) <= `{$limiting_column}`) OR `{$limiting_column}` = %d
                THEN `{$column_name}` + %d
                ELSE `{$column_name}`
             END",
-                $quantity,
-                EE_INF_IN_DB,
-                $quantity
-            )
-        );
-    }
-
-
-    /**
-     * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
-     * (probably a bad assumption they have made, oh well)
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        try {
-            return sprintf('%s (%s)', $this->name(), $this->ID());
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            return '';
-        }
-    }
-
-
-    /**
-     * Clear related model objects if they're already in the DB, because otherwise when we
-     * UN-serialize this model object we'll need to be careful to add them to the entity map.
-     * This means if we have made changes to those related model objects, and want to unserialize
-     * the this model object on a subsequent request, changes to those related model objects will be lost.
-     * Instead, those related model objects should be directly serialized and stored.
-     * Eg, the following won't work:
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
-     * $att = $reg->attendee();
-     * $att->set( 'ATT_fname', 'Dirk' );
-     * update_option( 'my_option', serialize( $reg ) );
-     * //END REQUEST
-     * //START NEXT REQUEST
-     * $reg = get_option( 'my_option' );
-     * $reg->attendee()->save();
-     * And would need to be replace with:
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
-     * $att = $reg->attendee();
-     * $att->set( 'ATT_fname', 'Dirk' );
-     * update_option( 'my_option', serialize( $reg ) );
-     * //END REQUEST
-     * //START NEXT REQUEST
-     * $att = get_option( 'my_option' );
-     * $att->save();
-     *
-     * @return array
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function __sleep()
-    {
-        $model = $this->get_model();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $classname = 'EE_' . $model->get_this_model_name();
-                if (
-                    $this->get_one_from_cache($relation_name) instanceof $classname
-                    && $this->get_one_from_cache($relation_name)->ID()
-                ) {
-                    $this->clear_cache(
-                        $relation_name,
-                        $this->get_one_from_cache($relation_name)->ID()
-                    );
-                }
-            }
-        }
-        $this->_props_n_values_provided_in_constructor = [];
-        $properties_to_serialize                       = get_object_vars($this);
-        // don't serialize the model. It's big and that risks recursion
-        unset($properties_to_serialize['_model']);
-        return array_keys($properties_to_serialize);
-    }
-
-
-    /**
-     * restore _props_n_values_provided_in_constructor
-     * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
-     * and therefore should NOT be used to determine if state change has occurred since initial construction.
-     * At best, you would only be able to detect if state change has occurred during THIS request.
-     */
-    public function __wakeup()
-    {
-        $this->_props_n_values_provided_in_constructor = $this->_fields;
-    }
-
-
-    /**
-     * Usage of this magic method is to ensure any internally cached references to object instances that must remain
-     * distinct with the clone host instance are also cloned.
-     */
-    public function __clone()
-    {
-        // handle DateTimes (this is handled in here because there's no one specific child class that uses datetimes).
-        foreach ($this->_fields as $field => $value) {
-            if ($value instanceof DateTime) {
-                $this->_fields[ $field ] = clone $value;
-            }
-        }
-    }
-
-
-    public function debug()
-    {
-        $this->echoProperty(get_class($this), get_object_vars($this));
-        echo "\n\n";
-    }
-
-
-    private function echoProperty($field, $value, int $indent = 0)
-    {
-        $bullets = str_repeat(' -', $indent) . ' ';
-        $field = strpos($field, '_') === 0 ? substr($field, 1) : $field;
-        echo "\n$bullets$field: ";
-        if ($value instanceof EEM_Base) {
-            $value = get_class($value);
-        } elseif (is_object($value)) {
-            $value = get_object_vars($value);
-        }
-        if (is_array($value)) {
-            foreach ($value as $f => $v) {
-                $this->echoProperty($f, $v, $indent + 1);
-            }
-            return;
-        }
-        ob_start();
-        var_dump($value);
-        echo rtrim(ob_get_clean(), "\n");
-    }
+				$quantity,
+				EE_INF_IN_DB,
+				$quantity
+			)
+		);
+	}
+
+
+	/**
+	 * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
+	 * (probably a bad assumption they have made, oh well)
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		try {
+			return sprintf('%s (%s)', $this->name(), $this->ID());
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			return '';
+		}
+	}
+
+
+	/**
+	 * Clear related model objects if they're already in the DB, because otherwise when we
+	 * UN-serialize this model object we'll need to be careful to add them to the entity map.
+	 * This means if we have made changes to those related model objects, and want to unserialize
+	 * the this model object on a subsequent request, changes to those related model objects will be lost.
+	 * Instead, those related model objects should be directly serialized and stored.
+	 * Eg, the following won't work:
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
+	 * $att = $reg->attendee();
+	 * $att->set( 'ATT_fname', 'Dirk' );
+	 * update_option( 'my_option', serialize( $reg ) );
+	 * //END REQUEST
+	 * //START NEXT REQUEST
+	 * $reg = get_option( 'my_option' );
+	 * $reg->attendee()->save();
+	 * And would need to be replace with:
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
+	 * $att = $reg->attendee();
+	 * $att->set( 'ATT_fname', 'Dirk' );
+	 * update_option( 'my_option', serialize( $reg ) );
+	 * //END REQUEST
+	 * //START NEXT REQUEST
+	 * $att = get_option( 'my_option' );
+	 * $att->save();
+	 *
+	 * @return array
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function __sleep()
+	{
+		$model = $this->get_model();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$classname = 'EE_' . $model->get_this_model_name();
+				if (
+					$this->get_one_from_cache($relation_name) instanceof $classname
+					&& $this->get_one_from_cache($relation_name)->ID()
+				) {
+					$this->clear_cache(
+						$relation_name,
+						$this->get_one_from_cache($relation_name)->ID()
+					);
+				}
+			}
+		}
+		$this->_props_n_values_provided_in_constructor = [];
+		$properties_to_serialize                       = get_object_vars($this);
+		// don't serialize the model. It's big and that risks recursion
+		unset($properties_to_serialize['_model']);
+		return array_keys($properties_to_serialize);
+	}
+
+
+	/**
+	 * restore _props_n_values_provided_in_constructor
+	 * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
+	 * and therefore should NOT be used to determine if state change has occurred since initial construction.
+	 * At best, you would only be able to detect if state change has occurred during THIS request.
+	 */
+	public function __wakeup()
+	{
+		$this->_props_n_values_provided_in_constructor = $this->_fields;
+	}
+
+
+	/**
+	 * Usage of this magic method is to ensure any internally cached references to object instances that must remain
+	 * distinct with the clone host instance are also cloned.
+	 */
+	public function __clone()
+	{
+		// handle DateTimes (this is handled in here because there's no one specific child class that uses datetimes).
+		foreach ($this->_fields as $field => $value) {
+			if ($value instanceof DateTime) {
+				$this->_fields[ $field ] = clone $value;
+			}
+		}
+	}
+
+
+	public function debug()
+	{
+		$this->echoProperty(get_class($this), get_object_vars($this));
+		echo "\n\n";
+	}
+
+
+	private function echoProperty($field, $value, int $indent = 0)
+	{
+		$bullets = str_repeat(' -', $indent) . ' ';
+		$field = strpos($field, '_') === 0 ? substr($field, 1) : $field;
+		echo "\n$bullets$field: ";
+		if ($value instanceof EEM_Base) {
+			$value = get_class($value);
+		} elseif (is_object($value)) {
+			$value = get_object_vars($value);
+		}
+		if (is_array($value)) {
+			foreach ($value as $f => $v) {
+				$this->echoProperty($f, $v, $indent + 1);
+			}
+			return;
+		}
+		ob_start();
+		var_dump($value);
+		echo rtrim(ob_get_clean(), "\n");
+	}
 }

Spacing +117 added lines, -117 removed lines

@@ -132,7 +132,7 @@ 
         $fieldValues = is_array($fieldValues) ? $fieldValues : [$fieldValues];
         // verify client code has not passed any invalid field names
         foreach ($fieldValues as $field_name => $field_value) {
-            if (! isset($model_fields[ $field_name ])) {
+            if ( ! isset($model_fields[$field_name])) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -150,7 +150,7 @@ 
         $date_format     = null;
         $time_format     = null;
         $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        if (! empty($date_formats) && is_array($date_formats)) {
+        if ( ! empty($date_formats) && is_array($date_formats)) {
             [$date_format, $time_format] = $date_formats;
         }
         $this->set_date_format($date_format);
@@ -161,14 +161,14 @@ 
                 // client code has indicated these field values are from the database
                 $this->set_from_db(
                     $fieldName,
-                    $fieldValues[ $fieldName ] ?? null
+                    $fieldValues[$fieldName] ?? null
                 );
             } else {
                 // we're constructing a brand new instance of the model object.
                 // Generally, this means we'll need to do more field validation
                 $this->set(
                     $fieldName,
-                    $fieldValues[ $fieldName ] ?? null,
+                    $fieldValues[$fieldName] ?? null,
                     true
                 );
             }
@@ -176,15 +176,15 @@ 
         // remember what values were passed to this constructor
         $this->_props_n_values_provided_in_constructor = $fieldValues;
         // remember in entity mapper
-        if (! $bydb && $model->has_primary_key_field() && $this->ID()) {
+        if ( ! $bydb && $model->has_primary_key_field() && $this->ID()) {
             $model->add_to_entity_map($this);
         }
         // setup all the relations
         foreach ($model->relation_settings() as $relation_name => $relation_obj) {
             if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $this->_model_relations[ $relation_name ] = null;
+                $this->_model_relations[$relation_name] = null;
             } else {
-                $this->_model_relations[ $relation_name ] = [];
+                $this->_model_relations[$relation_name] = [];
             }
         }
         /**
@@ -236,10 +236,10 @@ 
     public function get_original($field_name)
     {
         if (
-            isset($this->_props_n_values_provided_in_constructor[ $field_name ])
+            isset($this->_props_n_values_provided_in_constructor[$field_name])
             && $field_settings = $this->get_model()->field_settings_for($field_name)
         ) {
-            return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[ $field_name ]);
+            return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[$field_name]);
         }
         return null;
     }
@@ -275,7 +275,7 @@ 
         // then don't do anything
         if (
             ! $use_default
-            && $this->_fields[ $field_name ] === $field_value
+            && $this->_fields[$field_name] === $field_value
             && $this->ID()
         ) {
             return;
@@ -283,7 +283,7 @@ 
         $model              = $this->get_model();
         $this->_has_changes = true;
         $field_obj          = $model->field_settings_for($field_name);
-        if (! $field_obj instanceof EE_Model_Field_Base) {
+        if ( ! $field_obj instanceof EE_Model_Field_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -306,7 +306,7 @@ 
             ? $field_obj->get_default_value()
             : $field_value;
 
-        $this->_fields[ $field_name ] = $field_obj->prepare_for_set($value);
+        $this->_fields[$field_name] = $field_obj->prepare_for_set($value);
 
         // if we're not in the constructor...
         // now check if what we set was a primary key
@@ -368,7 +368,7 @@ 
             } else {
                 $field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
             }
-            $this->_fields[ $field_name ] = $field_value;
+            $this->_fields[$field_name] = $field_value;
             $this->_clear_cached_property($field_name);
         }
     }
@@ -394,7 +394,7 @@ 
      */
     public function getCustomSelect($alias)
     {
-        return $this->custom_selection_results[ $alias ] ?? null;
+        return $this->custom_selection_results[$alias] ?? null;
     }
 
 
@@ -481,8 +481,8 @@ 
         foreach ($model_fields as $field_name => $field_obj) {
             if ($field_obj instanceof EE_Datetime_Field) {
                 $field_obj->set_timezone($this->_timezone);
-                if (isset($this->_fields[ $field_name ]) && $this->_fields[ $field_name ] instanceof DateTime) {
-                    EEH_DTT_Helper::setTimezone($this->_fields[ $field_name ], new DateTimeZone($this->_timezone));
+                if (isset($this->_fields[$field_name]) && $this->_fields[$field_name] instanceof DateTime) {
+                    EEH_DTT_Helper::setTimezone($this->_fields[$field_name], new DateTimeZone($this->_timezone));
                 }
             }
         }
@@ -540,7 +540,7 @@ 
      */
     public function get_format($full = true)
     {
-        return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : [$this->_dt_frmt, $this->_tm_frmt];
+        return $full ? $this->_dt_frmt.' '.$this->_tm_frmt : [$this->_dt_frmt, $this->_tm_frmt];
     }
 
 
@@ -566,11 +566,11 @@ 
     public function cache($relation_name = '', $object_to_cache = null, $cache_id = null)
     {
         // its entirely possible that there IS no related object yet in which case there is nothing to cache.
-        if (! $object_to_cache instanceof EE_Base_Class) {
+        if ( ! $object_to_cache instanceof EE_Base_Class) {
             return false;
         }
         // also get "how" the object is related, or throw an error
-        if (! $relationship_to_model = $this->get_model()->related_settings_for($relation_name)) {
+        if ( ! $relationship_to_model = $this->get_model()->related_settings_for($relation_name)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
@@ -584,38 +584,38 @@ 
             // if it's a "belongs to" relationship, then there's only one related model object
             // eg, if this is a registration, there's only 1 attendee for it
             // so for these model objects just set it to be cached
-            $this->_model_relations[ $relation_name ] = $object_to_cache;
+            $this->_model_relations[$relation_name] = $object_to_cache;
             $return                                   = true;
         } else {
             // otherwise, this is the "many" side of a one to many relationship,
             // so we'll add the object to the array of related objects for that type.
             // eg: if this is an event, there are many registrations for that event,
             // so we cache the registrations in an array
-            if (! is_array($this->_model_relations[ $relation_name ])) {
+            if ( ! is_array($this->_model_relations[$relation_name])) {
                 // if for some reason, the cached item is a model object,
                 // then stick that in the array, otherwise start with an empty array
-                $this->_model_relations[ $relation_name ] =
-                    $this->_model_relations[ $relation_name ] instanceof EE_Base_Class
-                        ? [$this->_model_relations[ $relation_name ]]
+                $this->_model_relations[$relation_name] =
+                    $this->_model_relations[$relation_name] instanceof EE_Base_Class
+                        ? [$this->_model_relations[$relation_name]]
                         : [];
             }
             // first check for a cache_id which is normally empty
-            if (! empty($cache_id)) {
+            if ( ! empty($cache_id)) {
                 // if the cache_id exists, then it means we are purposely trying to cache this
                 // with a known key that can then be used to retrieve the object later on
-                $this->_model_relations[ $relation_name ][ $cache_id ] = $object_to_cache;
+                $this->_model_relations[$relation_name][$cache_id] = $object_to_cache;
                 $return                                                = $cache_id;
             } elseif ($object_to_cache->ID()) {
                 // OR the cached object originally came from the db, so let's just use it's PK for an ID
-                $this->_model_relations[ $relation_name ][ $object_to_cache->ID() ] = $object_to_cache;
+                $this->_model_relations[$relation_name][$object_to_cache->ID()] = $object_to_cache;
                 $return                                                             = $object_to_cache->ID();
             } else {
                 // OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
-                $this->_model_relations[ $relation_name ][] = $object_to_cache;
+                $this->_model_relations[$relation_name][] = $object_to_cache;
                 // move the internal pointer to the end of the array
-                end($this->_model_relations[ $relation_name ]);
+                end($this->_model_relations[$relation_name]);
                 // and grab the key so that we can return it
-                $return = key($this->_model_relations[ $relation_name ]);
+                $return = key($this->_model_relations[$relation_name]);
             }
         }
         return $return;
@@ -642,7 +642,7 @@ 
         $this->get_model()->field_settings_for($fieldname);
         $cache_type = empty($cache_type) ? 'standard' : $cache_type;
 
-        $this->_cached_properties[ $fieldname ][ $cache_type ] = $value;
+        $this->_cached_properties[$fieldname][$cache_type] = $value;
     }
 
 
@@ -671,9 +671,9 @@ 
         $model = $this->get_model();
         $model->field_settings_for($fieldname);
         $cache_type = $pretty ? 'pretty' : 'standard';
-        $cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
-        if (isset($this->_cached_properties[ $fieldname ][ $cache_type ])) {
-            return $this->_cached_properties[ $fieldname ][ $cache_type ];
+        $cache_type .= ! empty($extra_cache_ref) ? '_'.$extra_cache_ref : '';
+        if (isset($this->_cached_properties[$fieldname][$cache_type])) {
+            return $this->_cached_properties[$fieldname][$cache_type];
         }
         $value = $this->_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
         $this->_set_cached_property($fieldname, $value, $cache_type);
@@ -701,12 +701,12 @@ 
         if ($field_obj instanceof EE_Datetime_Field) {
             $this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
         }
-        if (! isset($this->_fields[ $fieldname ])) {
-            $this->_fields[ $fieldname ] = null;
+        if ( ! isset($this->_fields[$fieldname])) {
+            $this->_fields[$fieldname] = null;
         }
         return $pretty
-            ? $field_obj->prepare_for_pretty_echoing($this->_fields[ $fieldname ], $extra_cache_ref)
-            : $field_obj->prepare_for_get($this->_fields[ $fieldname ]);
+            ? $field_obj->prepare_for_pretty_echoing($this->_fields[$fieldname], $extra_cache_ref)
+            : $field_obj->prepare_for_get($this->_fields[$fieldname]);
     }
 
 
@@ -762,8 +762,8 @@ 
      */
     protected function _clear_cached_property($property_name)
     {
-        if (isset($this->_cached_properties[ $property_name ])) {
-            unset($this->_cached_properties[ $property_name ]);
+        if (isset($this->_cached_properties[$property_name])) {
+            unset($this->_cached_properties[$property_name]);
         }
     }
 
@@ -816,7 +816,7 @@ 
     {
         $relationship_to_model = $this->get_model()->related_settings_for($relation_name);
         $index_in_cache        = '';
-        if (! $relationship_to_model) {
+        if ( ! $relationship_to_model) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no relationship to %s on a %s. Cannot clear that cache', 'event_espresso'),
@@ -827,10 +827,10 @@ 
         }
         if ($clear_all) {
             $obj_removed                              = true;
-            $this->_model_relations[ $relation_name ] = null;
+            $this->_model_relations[$relation_name] = null;
         } elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            $obj_removed                              = $this->_model_relations[ $relation_name ];
-            $this->_model_relations[ $relation_name ] = null;
+            $obj_removed                              = $this->_model_relations[$relation_name];
+            $this->_model_relations[$relation_name] = null;
         } else {
             if (
                 $object_to_remove_or_index_into_array instanceof EE_Base_Class
@@ -838,12 +838,12 @@ 
             ) {
                 $index_in_cache = $object_to_remove_or_index_into_array->ID();
                 if (
-                    is_array($this->_model_relations[ $relation_name ])
-                    && ! isset($this->_model_relations[ $relation_name ][ $index_in_cache ])
+                    is_array($this->_model_relations[$relation_name])
+                    && ! isset($this->_model_relations[$relation_name][$index_in_cache])
                 ) {
                     $index_found_at = null;
                     // find this object in the array even though it has a different key
-                    foreach ($this->_model_relations[ $relation_name ] as $index => $obj) {
+                    foreach ($this->_model_relations[$relation_name] as $index => $obj) {
                         /** @noinspection TypeUnsafeComparisonInspection */
                         if (
                             $obj instanceof EE_Base_Class
@@ -877,9 +877,9 @@ 
             }
             // supposedly we've found it. But it could just be that the client code
             // provided a bad index/object
-            if (isset($this->_model_relations[ $relation_name ][ $index_in_cache ])) {
-                $obj_removed = $this->_model_relations[ $relation_name ][ $index_in_cache ];
-                unset($this->_model_relations[ $relation_name ][ $index_in_cache ]);
+            if (isset($this->_model_relations[$relation_name][$index_in_cache])) {
+                $obj_removed = $this->_model_relations[$relation_name][$index_in_cache];
+                unset($this->_model_relations[$relation_name][$index_in_cache]);
             } else {
                 // that thing was never cached anyway.
                 $obj_removed = false;
@@ -910,7 +910,7 @@ 
         $current_cache_id = ''
     ) {
         // verify that incoming object is of the correct type
-        $obj_class = 'EE_' . $relation_name;
+        $obj_class = 'EE_'.$relation_name;
         if ($newly_saved_object instanceof $obj_class) {
             /* @type EE_Base_Class $newly_saved_object */
             // now get the type of relation
@@ -918,18 +918,18 @@ 
             // if this is a 1:1 relationship
             if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
                 // then just replace the cached object with the newly saved object
-                $this->_model_relations[ $relation_name ] = $newly_saved_object;
+                $this->_model_relations[$relation_name] = $newly_saved_object;
                 return true;
                 // or if it's some kind of sordid feral polyamorous relationship...
             }
             if (
-                is_array($this->_model_relations[ $relation_name ])
-                && isset($this->_model_relations[ $relation_name ][ $current_cache_id ])
+                is_array($this->_model_relations[$relation_name])
+                && isset($this->_model_relations[$relation_name][$current_cache_id])
             ) {
                 // then remove the current cached item
-                unset($this->_model_relations[ $relation_name ][ $current_cache_id ]);
+                unset($this->_model_relations[$relation_name][$current_cache_id]);
                 // and cache the newly saved object using it's new ID
-                $this->_model_relations[ $relation_name ][ $newly_saved_object->ID() ] = $newly_saved_object;
+                $this->_model_relations[$relation_name][$newly_saved_object->ID()] = $newly_saved_object;
                 return true;
             }
         }
@@ -946,7 +946,7 @@ 
      */
     public function get_one_from_cache($relation_name)
     {
-        $cached_array_or_object = $this->_model_relations[ $relation_name ] ?? null;
+        $cached_array_or_object = $this->_model_relations[$relation_name] ?? null;
         if (is_array($cached_array_or_object)) {
             return array_shift($cached_array_or_object);
         }
@@ -968,7 +968,7 @@ 
      */
     public function get_all_from_cache($relation_name)
     {
-        $objects = $this->_model_relations[ $relation_name ] ?? [];
+        $objects = $this->_model_relations[$relation_name] ?? [];
         // if the result is not an array, but exists, make it an array
         $objects = is_array($objects)
             ? $objects
@@ -1160,9 +1160,9 @@ 
     public function get_raw($field_name)
     {
         $field_settings = $this->get_model()->field_settings_for($field_name);
-        return $field_settings instanceof EE_Datetime_Field && $this->_fields[ $field_name ] instanceof DateTime
-            ? $this->_fields[ $field_name ]->format('U')
-            : $this->_fields[ $field_name ];
+        return $field_settings instanceof EE_Datetime_Field && $this->_fields[$field_name] instanceof DateTime
+            ? $this->_fields[$field_name]->format('U')
+            : $this->_fields[$field_name];
     }
 
 
@@ -1184,7 +1184,7 @@ 
     public function get_DateTime_object($field_name)
     {
         $field_settings = $this->get_model()->field_settings_for($field_name);
-        if (! $field_settings instanceof EE_Datetime_Field) {
+        if ( ! $field_settings instanceof EE_Datetime_Field) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -1199,8 +1199,8 @@ 
             );
             return false;
         }
-        return isset($this->_fields[ $field_name ]) && $this->_fields[ $field_name ] instanceof DateTime
-            ? clone $this->_fields[ $field_name ]
+        return isset($this->_fields[$field_name]) && $this->_fields[$field_name] instanceof DateTime
+            ? clone $this->_fields[$field_name]
             : null;
     }
 
@@ -1445,7 +1445,7 @@ 
      */
     public function get_i18n_datetime(string $field_name, string $format = ''): string
     {
-        $format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
+        $format = empty($format) ? $this->_dt_frmt.' '.$this->_tm_frmt : $format;
         return date_i18n(
             $format,
             EEH_DTT_Helper::get_timestamp_with_offset(
@@ -1557,21 +1557,21 @@ 
         $field->set_time_format($this->_tm_frmt);
         switch ($what) {
             case 'T':
-                $this->_fields[ $field_name ] = $field->prepare_for_set_with_new_time(
+                $this->_fields[$field_name] = $field->prepare_for_set_with_new_time(
                     $datetime_value,
-                    $this->_fields[ $field_name ]
+                    $this->_fields[$field_name]
                 );
                 $this->_has_changes           = true;
                 break;
             case 'D':
-                $this->_fields[ $field_name ] = $field->prepare_for_set_with_new_date(
+                $this->_fields[$field_name] = $field->prepare_for_set_with_new_date(
                     $datetime_value,
-                    $this->_fields[ $field_name ]
+                    $this->_fields[$field_name]
                 );
                 $this->_has_changes           = true;
                 break;
             case 'B':
-                $this->_fields[ $field_name ] = $field->prepare_for_set($datetime_value);
+                $this->_fields[$field_name] = $field->prepare_for_set($datetime_value);
                 $this->_has_changes           = true;
                 break;
         }
@@ -1614,7 +1614,7 @@ 
         $this->set_timezone($timezone);
         $fn   = (array) $field_name;
         $args = array_merge($fn, (array) $args);
-        if (! method_exists($this, $callback)) {
+        if ( ! method_exists($this, $callback)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -1626,7 +1626,7 @@ 
             );
         }
         $args   = (array) $args;
-        $return = $prepend . call_user_func_array([$this, $callback], $args) . $append;
+        $return = $prepend.call_user_func_array([$this, $callback], $args).$append;
         $this->set_timezone($original_timezone);
         return $return;
     }
@@ -1741,8 +1741,8 @@ 
     {
         $model = $this->get_model();
         foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if (! empty($this->_model_relations[ $relation_name ])) {
-                $related_objects = $this->_model_relations[ $relation_name ];
+            if ( ! empty($this->_model_relations[$relation_name])) {
+                $related_objects = $this->_model_relations[$relation_name];
                 if ($relation_obj instanceof EE_Belongs_To_Relation) {
                     // this relation only stores a single model object, not an array
                     // but let's make it consistent
@@ -1799,7 +1799,7 @@ 
             $this->set($column, $value);
         }
         // no changes ? then don't do anything
-        if (! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
+        if ( ! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
             return 0;
         }
         /**
@@ -1809,7 +1809,7 @@ 
          * @param EE_Base_Class $model_object the model object about to be saved.
          */
         do_action('AHEE__EE_Base_Class__save__begin', $this);
-        if (! $this->allow_persist()) {
+        if ( ! $this->allow_persist()) {
             return 0;
         }
         // now get current attribute values
@@ -1824,10 +1824,10 @@ 
         if ($model->has_primary_key_field()) {
             if ($model->get_primary_key_field()->is_auto_increment()) {
                 // ok check if it's set, if so: update; if not, insert
-                if (! empty($save_cols_n_values[ $model->primary_key_name() ])) {
+                if ( ! empty($save_cols_n_values[$model->primary_key_name()])) {
                     $results = $model->update_by_ID($save_cols_n_values, $this->ID());
                 } else {
-                    unset($save_cols_n_values[ $model->primary_key_name() ]);
+                    unset($save_cols_n_values[$model->primary_key_name()]);
                     $results = $model->insert($save_cols_n_values);
                     if ($results) {
                         // if successful, set the primary key
@@ -1837,7 +1837,7 @@ 
                         // will get added to the mapper before we can add this one!
                         // but if we just avoid using the SET method, all that headache can be avoided
                         $pk_field_name                   = $model->primary_key_name();
-                        $this->_fields[ $pk_field_name ] = $results;
+                        $this->_fields[$pk_field_name] = $results;
                         $this->_clear_cached_property($pk_field_name);
                         $model->add_to_entity_map($this);
                         $this->_update_cached_related_model_objs_fks();
@@ -1854,8 +1854,8 @@ 
                                     'event_espresso'
                                 ),
                                 get_class($this),
-                                get_class($model) . '::instance()->add_to_entity_map()',
-                                get_class($model) . '::instance()->get_one_by_ID()',
+                                get_class($model).'::instance()->add_to_entity_map()',
+                                get_class($model).'::instance()->get_one_by_ID()',
                                 '<br />'
                             )
                         );
@@ -1879,7 +1879,7 @@ 
                     $save_cols_n_values,
                     $model->get_combined_primary_key_fields()
                 );
-                $results                     = $model->update(
+                $results = $model->update(
                     $save_cols_n_values,
                     $combined_pk_fields_n_values
                 );
@@ -1957,27 +1957,27 @@ 
     public function save_new_cached_related_model_objs()
     {
         // make sure this has been saved
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             $id = $this->save();
         } else {
             $id = $this->ID();
         }
         // now save all the NEW cached model objects  (ie they don't exist in the DB)
         foreach ($this->get_model()->relation_settings() as $relation_name => $relationObj) {
-            if ($this->_model_relations[ $relation_name ]) {
+            if ($this->_model_relations[$relation_name]) {
                 // is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
                 // or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
                 /* @var $related_model_obj EE_Base_Class */
                 if ($relationObj instanceof EE_Belongs_To_Relation) {
                     // add a relation to that relation type (which saves the appropriate thing in the process)
                     // but ONLY if it DOES NOT exist in the DB
-                    $related_model_obj = $this->_model_relations[ $relation_name ];
+                    $related_model_obj = $this->_model_relations[$relation_name];
                     // if( ! $related_model_obj->ID()){
                     $this->_add_relation_to($related_model_obj, $relation_name);
                     $related_model_obj->save_new_cached_related_model_objs();
                     // }
                 } else {
-                    foreach ($this->_model_relations[ $relation_name ] as $related_model_obj) {
+                    foreach ($this->_model_relations[$relation_name] as $related_model_obj) {
                         // add a relation to that relation type (which saves the appropriate thing in the process)
                         // but ONLY if it DOES NOT exist in the DB
                         // if( ! $related_model_obj->ID()){
@@ -2004,7 +2004,7 @@ 
      */
     public function get_model()
     {
-        if (! $this->_model) {
+        if ( ! $this->_model) {
             $modelName    = self::_get_model_classname(get_class($this));
             $this->_model = self::_get_model_instance_with_name($modelName, $this->_timezone);
         } else {
@@ -2030,9 +2030,9 @@ 
         $primary_id_ref = self::_get_primary_key_name($classname);
         if (
             array_key_exists($primary_id_ref, $props_n_values)
-            && ! empty($props_n_values[ $primary_id_ref ])
+            && ! empty($props_n_values[$primary_id_ref])
         ) {
-            $id = $props_n_values[ $primary_id_ref ];
+            $id = $props_n_values[$primary_id_ref];
             return self::_get_model($classname)->get_from_entity_map($id);
         }
         return false;
@@ -2065,10 +2065,10 @@ 
             $primary_id_ref = self::_get_primary_key_name($classname);
             if (
                 array_key_exists($primary_id_ref, $props_n_values)
-                && ! empty($props_n_values[ $primary_id_ref ])
+                && ! empty($props_n_values[$primary_id_ref])
             ) {
                 $existing = $model->get_one_by_ID(
-                    $props_n_values[ $primary_id_ref ]
+                    $props_n_values[$primary_id_ref]
                 );
             }
         } elseif ($model->has_all_combined_primary_key_fields($props_n_values)) {
@@ -2080,7 +2080,7 @@ 
         }
         if ($existing) {
             // set date formats if present before setting values
-            if (! empty($date_formats) && is_array($date_formats)) {
+            if ( ! empty($date_formats) && is_array($date_formats)) {
                 $existing->set_date_format($date_formats[0]);
                 $existing->set_time_format($date_formats[1]);
             } else {
@@ -2113,7 +2113,7 @@ 
     protected static function _get_model($classname, $timezone = '')
     {
         // find model for this class
-        if (! $classname) {
+        if ( ! $classname) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -2161,7 +2161,7 @@ 
     {
         return strpos((string) $model_name, 'EE_') === 0
             ? str_replace('EE_', 'EEM_', $model_name)
-            : 'EEM_' . $model_name;
+            : 'EEM_'.$model_name;
     }
 
 
@@ -2178,7 +2178,7 @@ 
      */
     protected static function _get_primary_key_name($classname = null)
     {
-        if (! $classname) {
+        if ( ! $classname) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('What were you thinking calling _get_primary_key_name(%s)', 'event_espresso'),
@@ -2208,7 +2208,7 @@ 
         $model = $this->get_model();
         // now that we know the name of the variable, use a variable variable to get its value and return its
         if ($model->has_primary_key_field()) {
-            return $this->_fields[ $model->primary_key_name() ];
+            return $this->_fields[$model->primary_key_name()];
         }
         return $model->get_index_primary_key_string($this->_fields);
     }
@@ -2282,7 +2282,7 @@ 
             }
         } else {
             // this thing doesn't exist in the DB,  so just cache it
-            if (! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
+            if ( ! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -2451,7 +2451,7 @@ 
             } else {
                 // did we already cache the result of this query?
                 $cached_results = $this->get_all_from_cache($relation_name);
-                if (! $cached_results) {
+                if ( ! $cached_results) {
                     $related_model_objects = $this->get_model()->get_all_related(
                         $this,
                         $relation_name,
@@ -2563,7 +2563,7 @@ 
             } else {
                 // first, check if we've already cached the result of this query
                 $cached_result = $this->get_one_from_cache($relation_name);
-                if (! $cached_result) {
+                if ( ! $cached_result) {
                     $related_model_object = $model->get_first_related(
                         $this,
                         $relation_name,
@@ -2587,7 +2587,7 @@ 
             }
             // this doesn't exist in the DB and apparently the thing it belongs to doesn't either,
             // just get what's cached on this object
-            if (! $related_model_object) {
+            if ( ! $related_model_object) {
                 $related_model_object = $this->get_one_from_cache($relation_name);
             }
         }
@@ -2670,7 +2670,7 @@ 
      */
     public function is_set($field_name)
     {
-        return isset($this->_fields[ $field_name ]);
+        return isset($this->_fields[$field_name]);
     }
 
 
@@ -2686,7 +2686,7 @@ 
     {
         foreach ((array) $properties as $property_name) {
             // first make sure this property exists
-            if (! $this->_fields[ $property_name ]) {
+            if ( ! $this->_fields[$property_name]) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -2718,7 +2718,7 @@ 
         $properties = [];
         // remove prepended underscore
         foreach ($fields as $field_name => $settings) {
-            $properties[ $field_name ] = $this->get($field_name);
+            $properties[$field_name] = $this->get($field_name);
         }
         return $properties;
     }
@@ -2755,7 +2755,7 @@ 
     {
         $className = get_class($this);
         $tagName   = "FHEE__{$className}__{$methodName}";
-        if (! has_filter($tagName)) {
+        if ( ! has_filter($tagName)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -2800,7 +2800,7 @@ 
             $query_params[0]['EXM_value'] = $meta_value;
         }
         $existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
-        if (! $existing_rows_like_that) {
+        if ( ! $existing_rows_like_that) {
             return $this->add_extra_meta($meta_key, $meta_value);
         }
         foreach ($existing_rows_like_that as $existing_row) {
@@ -2910,7 +2910,7 @@ 
                 $values = [];
                 foreach ($results as $result) {
                     if ($result instanceof EE_Extra_Meta) {
-                        $values[ $result->ID() ] = $result->value();
+                        $values[$result->ID()] = $result->value();
                     }
                 }
                 return $values;
@@ -2955,17 +2955,17 @@ 
             );
             foreach ($extra_meta_objs as $extra_meta_obj) {
                 if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    $return_array[ $extra_meta_obj->key() ] = $extra_meta_obj->value();
+                    $return_array[$extra_meta_obj->key()] = $extra_meta_obj->value();
                 }
             }
         } else {
             $extra_meta_objs = $this->get_many_related('Extra_Meta');
             foreach ($extra_meta_objs as $extra_meta_obj) {
                 if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    if (! isset($return_array[ $extra_meta_obj->key() ])) {
-                        $return_array[ $extra_meta_obj->key() ] = [];
+                    if ( ! isset($return_array[$extra_meta_obj->key()])) {
+                        $return_array[$extra_meta_obj->key()] = [];
                     }
-                    $return_array[ $extra_meta_obj->key() ][ $extra_meta_obj->ID() ] = $extra_meta_obj->value();
+                    $return_array[$extra_meta_obj->key()][$extra_meta_obj->ID()] = $extra_meta_obj->value();
                 }
             }
         }
@@ -3046,8 +3046,8 @@ 
                             'event_espresso'
                         ),
                         $this->ID(),
-                        get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                        get_class($this->get_model()) . '::instance()->refresh_entity_map()'
+                        get_class($this->get_model()).'::instance()->add_to_entity_map()',
+                        get_class($this->get_model()).'::instance()->refresh_entity_map()'
                     )
                 );
             }
@@ -3080,7 +3080,7 @@ 
     {
         // First make sure this model object actually exists in the DB. It would be silly to try to update it in the DB
         // if it wasn't even there to start off.
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             $this->save();
         }
         global $wpdb;
@@ -3120,7 +3120,7 @@ 
             $table_pk_field_name = $table_obj->get_pk_column();
         }
 
-        $query  =
+        $query =
             "UPDATE `{$table_name}`
             SET "
             . $new_value_sql
@@ -3314,7 +3314,7 @@ 
         $model = $this->get_model();
         foreach ($model->relation_settings() as $relation_name => $relation_obj) {
             if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $classname = 'EE_' . $model->get_this_model_name();
+                $classname = 'EE_'.$model->get_this_model_name();
                 if (
                     $this->get_one_from_cache($relation_name) instanceof $classname
                     && $this->get_one_from_cache($relation_name)->ID()
@@ -3355,7 +3355,7 @@ 
         // handle DateTimes (this is handled in here because there's no one specific child class that uses datetimes).
         foreach ($this->_fields as $field => $value) {
             if ($value instanceof DateTime) {
-                $this->_fields[ $field ] = clone $value;
+                $this->_fields[$field] = clone $value;
             }
         }
     }
@@ -3370,7 +3370,7 @@ 
 
     private function echoProperty($field, $value, int $indent = 0)
     {
-        $bullets = str_repeat(' -', $indent) . ' ';
+        $bullets = str_repeat(' -', $indent).' ';
         $field = strpos($field, '_') === 0 ? substr($field, 1) : $field;
         echo "\n$bullets$field: ";
         if ($value instanceof EEM_Base) {

core/db_classes/EE_Export.class.php

Indentation +771 added lines, -771 removed lines

@@ -18,775 +18,775 @@
  */
 class EE_Export
 {
-    const option_prefix = 'ee_report_job_';
-
-    /**
-     * instance of the EE_Export object
-     */
-    private static $_instance = null;
-
-    /**
-     * instance of the EE_CSV object
-     * @var EE_CSV
-     */
-    public $EE_CSV = null;
-
-
-    private $_req_data = array();
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param array $request_data
-     */
-    private function __construct($request_data = array())
-    {
-        $this->_req_data = $request_data;
-        $this->today = date("Y-m-d", time());
-        require_once(EE_CLASSES . 'EE_CSV.class.php');
-        $this->EE_CSV = EE_CSV::instance();
-    }
-
-
-    /**
-     * singleton method used to instantiate class object
-     *
-     * @param array $request_data
-     * @return EE_Export
-     */
-    public static function instance($request_data = array())
-    {
-        // check if class object is instantiated
-        if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Export)) {
-            self::$_instance = new self($request_data);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Export Event Espresso data - routes export requests
-     * @return void | bool
-     */
-    public function export()
-    {
-        // in case of bulk exports, the "actual" action will be in action2, but first check regular action for "export" keyword
-        if (isset($this->_req_data['action']) && strpos($this->_req_data['action'], 'export') === false) {
-            // check if action2 has export action
-            if (isset($this->_req_data['action2']) && strpos($this->_req_data['action2'], 'export') !== false) {
-                // whoop! there it is!
-                $this->_req_data['action'] = $this->_req_data['action2'];
-            }
-        }
-
-        $this->_req_data['export'] = isset($this->_req_data['export']) ? $this->_req_data['export'] : '';
-
-        switch ($this->_req_data['export']) {
-            case 'report':
-                switch ($this->_req_data['action']) {
-                    case "event":
-                    case "export_events":
-                    case 'all_event_data':
-                        $this->export_all_event_data();
-                        break;
-
-                    case 'registrations_report_for_event':
-                        $this->report_registrations_for_event($this->_req_data['EVT_ID']);
-                        break;
-
-                    case 'attendees':
-                        $this->export_attendees();
-                        break;
-
-                    case 'categories':
-                        $this->export_categories();
-                        break;
-
-                    default:
-                        EE_Error::add_error(
-                            esc_html__('An error occurred! The requested export report could not be found.', 'event_espresso'),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                        break;
-                }
-                break; // end of switch export : report
-            default:
-                break;
-        } // end of switch export
-
-        exit;
-    }
-
-    /**
-     * Downloads a CSV file with all the columns, but no data. This should be used for importing
-     *
-     * @return void kills execution
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function export_sample()
-    {
-        $event = EEM_Event::instance()->get_one();
-        $this->_req_data['EVT_ID'] = $event->ID();
-        $this->export_all_event_data();
-    }
-
-
-    /**
-     * Export data for ALL events
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function export_all_event_data()
-    {
-        // are any Event IDs set?
-        $event_query_params = array();
-        $related_models_query_params = array();
-        $related_through_reg_query_params = array();
-        $datetime_ticket_query_params = array();
-        $price_query_params = array();
-        $price_type_query_params = array();
-        $term_query_params = array();
-        $state_country_query_params = array();
-        $question_group_query_params = array();
-        $question_query_params = array();
-        if (isset($this->_req_data['EVT_ID'])) {
-            // do we have an array of IDs ?
-
-            if (is_array($this->_req_data['EVT_ID'])) {
-                $EVT_IDs = array_map('sanitize_text_field', $this->_req_data['EVT_ID']);
-                $value_to_equal = array('IN', $EVT_IDs);
-                $filename = 'events';
-            } else {
-                // generate regular where = clause
-                $EVT_ID = absint($this->_req_data['EVT_ID']);
-                $value_to_equal = $EVT_ID;
-                $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($EVT_ID);
-
-                $filename = 'event-' . ($event instanceof EE_Event ? $event->slug() : esc_html__('unknown', 'event_espresso'));
-            }
-            $event_query_params[0]['EVT_ID'] = $value_to_equal;
-            $related_models_query_params[0]['Event.EVT_ID'] = $value_to_equal;
-            $related_through_reg_query_params[0]['Registration.EVT_ID'] = $value_to_equal;
-            $datetime_ticket_query_params[0]['Datetime.EVT_ID'] = $value_to_equal;
-            $price_query_params[0]['Ticket.Datetime.EVT_ID'] = $value_to_equal;
-            $price_type_query_params[0]['Price.Ticket.Datetime.EVT_ID'] = $value_to_equal;
-            $term_query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $value_to_equal;
-            $state_country_query_params[0]['Venue.Event.EVT_ID'] = $value_to_equal;
-            $question_group_query_params[0]['Event.EVT_ID'] = $value_to_equal;
-            $question_query_params[0]['Question_Group.Event.EVT_ID'] = $value_to_equal;
-        } else {
-            $filename = 'all-events';
-        }
-
-
-        // array in the format:  table name =>  query where clause
-        $models_to_export = array(
-            'Event'                   => $event_query_params,
-            'Datetime'                => $related_models_query_params,
-            'Ticket_Template'         => $price_query_params,
-            'Ticket'                  => $datetime_ticket_query_params,
-            'Datetime_Ticket'         => $datetime_ticket_query_params,
-            'Price_Type'              => $price_type_query_params,
-            'Price'                   => $price_query_params,
-            'Ticket_Price'            => $price_query_params,
-            'Term'                    => $term_query_params,
-            'Term_Taxonomy'           => $related_models_query_params,
-            'Term_Relationship'       => $related_models_query_params, // model has NO primary key...
-            'Country'                 => $state_country_query_params,
-            'State'                   => $state_country_query_params,
-            'Venue'                   => $related_models_query_params,
-            'Event_Venue'             => $related_models_query_params,
-            'Question_Group'          => $question_group_query_params,
-            'Event_Question_Group'    => $question_group_query_params,
-            'Question'                => $question_query_params,
-            'Question_Group_Question' => $question_query_params,
-            // 'Transaction'=>$related_through_reg_query_params,
-            // 'Registration'=>$related_models_query_params,
-            // 'Attendee'=>$related_through_reg_query_params,
-            // 'Line_Item'=>
-
-        );
-
-        $model_data = $this->_get_export_data_for_models($models_to_export);
-
-        $filename = $this->generate_filename($filename);
-
-        if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
-            EE_Error::add_error(
-                esc_html__(
-                    "'An error occurred and the Event details could not be exported from the database.'",
-                    "event_espresso"
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-    public function report_attendees()
-    {
-        $attendee_rows = EEM_Attendee::instance()->get_all_wpdb_results(
-            array(
-                'force_join' => array('State', 'Country'),
-                'caps'       => EEM_Base::caps_read_admin,
-            )
-        );
-        $csv_data = array();
-        foreach ($attendee_rows as $attendee_row) {
-            $csv_row = array();
-            foreach (EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) {
-                if ($field_name == 'STA_ID') {
-                    $state_name_field = EEM_State::instance()->field_settings_for('STA_name');
-                    $csv_row[ esc_html__('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column(
-                    ) ];
-                } elseif ($field_name == 'CNT_ISO') {
-                    $country_name_field = EEM_Country::instance()->field_settings_for('CNT_name');
-                    $csv_row[ esc_html__(
-                        'Country',
-                        'event_espresso'
-                    ) ] = $attendee_row[ $country_name_field->get_qualified_column() ];
-                } else {
-                    $csv_row[ $field_obj->get_nicename() ] = $attendee_row[ $field_obj->get_qualified_column() ];
-                }
-            }
-            $csv_data[] = $csv_row;
-        }
-
-        $filename = $this->generate_filename('contact-list-report');
-
-        $handle = $this->EE_CSV->begin_sending_csv($filename);
-        $this->EE_CSV->write_data_array_to_csv($handle, $csv_data);
-        $this->EE_CSV->end_sending_csv($handle);
-    }
-
-
-    /**
-     * Export data for ALL attendees
-     * @return void
-     * @throws EE_Error
-     */
-    public function export_attendees()
-    {
-
-        $states_that_have_an_attendee = EEM_State::instance()->get_all(
-            array(0 => array('Attendee.ATT_ID' => array('IS NOT NULL')))
-        );
-        $countries_that_have_an_attendee = EEM_Country::instance()->get_all(
-            array(0 => array('Attendee.ATT_ID' => array('IS NOT NULL')))
-        );
-        // $states_to_export_query_params
-        $models_to_export = array(
-            'Country'  => array(array('CNT_ISO' => array('IN', array_keys($countries_that_have_an_attendee)))),
-            'State'    => array(array('STA_ID' => array('IN', array_keys($states_that_have_an_attendee)))),
-            'Attendee' => array(),
-        );
-
-
-        $model_data = $this->_get_export_data_for_models($models_to_export);
-        $filename = $this->generate_filename('all-attendees');
-
-        if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred and the Attendee data could not be exported from the database.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-    /**
-     * Shortcut for preparing a database result for display
-     *
-     * @param EEM_Base $model
-     * @param string $field_name
-     * @param string $raw_db_value
-     * @param bool|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to
-     *                                      NOT display pretty
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true)
-    {
-        $field_obj = $model->field_settings_for($field_name);
-        $value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value);
-        if ($field_obj instanceof EE_Datetime_Field) {
-            $field_obj->set_date_format(
-                EE_CSV::instance()->get_date_format_for_csv($field_obj->get_date_format($pretty_schema)),
-                $pretty_schema
-            );
-            $field_obj->set_time_format(
-                EE_CSV::instance()->get_time_format_for_csv($field_obj->get_time_format($pretty_schema)),
-                $pretty_schema
-            );
-        }
-        if ($pretty_schema === true) {
-            return $field_obj->prepare_for_pretty_echoing($value_on_model_obj);
-        } elseif (is_string($pretty_schema)) {
-            return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema);
-        } else {
-            return $field_obj->prepare_for_get($value_on_model_obj);
-        }
-    }
-
-    /**
-     * Export a custom CSV of registration info including: A bunch of the reg fields, the time of the event, the price
-     * name, and the questions associated with the registrations
-     *
-     * @param int $event_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function report_registrations_for_event($event_id = null)
-    {
-        $reg_fields_to_include = array(
-            'TXN_ID',
-            'ATT_ID',
-            'REG_ID',
-            'REG_date',
-            'REG_code',
-            'REG_count',
-            'REG_final_price',
-
-        );
-        $att_fields_to_include = array(
-            'ATT_fname',
-            'ATT_lname',
-            'ATT_email',
-            'ATT_address',
-            'ATT_address2',
-            'ATT_city',
-            'STA_ID',
-            'CNT_ISO',
-            'ATT_zip',
-            'ATT_phone',
-        );
-
-        $registrations_csv_ready_array = array();
-        $reg_model = EE_Registry::instance()->load_model('Registration');
-        $query_params = apply_filters(
-            'FHEE__EE_Export__report_registration_for_event',
-            array(
-                array(
-                    'OR'                 => array(
-                        // don't include registrations from failed or abandoned transactions...
-                        'Transaction.STS_ID' => array(
-                            'NOT IN',
-                            array(EEM_Transaction::failed_status_code, EEM_Transaction::abandoned_status_code),
-                        ),
-                        // unless the registration is approved, in which case include it regardless of transaction status
-                        'STS_ID'             => RegStatus::APPROVED,
-                    ),
-                    'Ticket.TKT_deleted' => array('IN', array(true, false)),
-                ),
-                'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
-                'force_join' => array('Transaction', 'Ticket', 'Attendee'),
-                'caps'       => EEM_Base::caps_read_admin,
-            ),
-            $event_id
-        );
-        if ($event_id) {
-            $query_params[0]['EVT_ID'] = $event_id;
-        } else {
-            $query_params['force_join'][] = 'Event';
-        }
-        $registration_rows = $reg_model->get_all_wpdb_results($query_params);
-        // get all questions which relate to someone in this group
-        $registration_ids = array();
-        foreach ($registration_rows as $reg_row) {
-            $registration_ids[] = intval($reg_row['Registration.REG_ID']);
-        }
-        // EEM_Question::instance()->show_next_x_db_queries();
-        $questions_for_these_regs_rows = EEM_Question::instance()->get_all_wpdb_results(
-            array(array('Answer.REG_ID' => array('IN', $registration_ids)))
-        );
-        foreach ($registration_rows as $reg_row) {
-            if (is_array($reg_row)) {
-                $reg_csv_array = array();
-                if (! $event_id) {
-                    // get the event's name and Id
-                    $reg_csv_array[ esc_html__('Event', 'event_espresso') ] = sprintf(
-                        esc_html__('%1$s (%2$s)', 'event_espresso'),
-                        $this->_prepare_value_from_db_for_display(
-                            EEM_Event::instance(),
-                            'EVT_name',
-                            $reg_row['Event_CPT.post_title']
-                        ),
-                        $reg_row['Event_CPT.ID']
-                    );
-                }
-                $is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
-                /*@var $reg_row EE_Registration */
-                foreach ($reg_fields_to_include as $field_name) {
-                    $field = $reg_model->field_settings_for($field_name);
-                    if ($field_name == 'REG_final_price') {
-                        $value = $this->_prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row['Registration.REG_final_price'],
-                            'localized_float'
-                        );
-                    } elseif ($field_name == 'REG_count') {
-                        $value = sprintf(
-                            esc_html__('%s of %s', 'event_espresso'),
-                            $this->_prepare_value_from_db_for_display(
-                                $reg_model,
-                                'REG_count',
-                                $reg_row['Registration.REG_count']
-                            ),
-                            $this->_prepare_value_from_db_for_display(
-                                $reg_model,
-                                'REG_group_size',
-                                $reg_row['Registration.REG_group_size']
-                            )
-                        );
-                    } elseif ($field_name == 'REG_date') {
-                        $value = $this->_prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row['Registration.REG_date'],
-                            'no_html'
-                        );
-                    } else {
-                        $value = $this->_prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row[ $field->get_qualified_column() ]
-                        );
-                    }
-                    $reg_csv_array[ $this->_get_column_name_for_field($field) ] = $value;
-                    if ($field_name == 'REG_final_price') {
-                        // add a column named Currency after the final price
-                        $reg_csv_array[ esc_html__("Currency", "event_espresso") ] = EE_Config::instance()->currency->code;
-                    }
-                }
-                // get pretty status
-                $stati = EEM_Status::instance()->localized_status(
-                    array(
-                        $reg_row['Registration.STS_ID']     => esc_html__('unknown', 'event_espresso'),
-                        $reg_row['TransactionTable.STS_ID'] => esc_html__('unknown', 'event_espresso'),
-                    ),
-                    false,
-                    'sentence'
-                );
-                $reg_csv_array[ esc_html__(
-                    "Registration Status",
-                    'event_espresso'
-                ) ] = $stati[ $reg_row['Registration.STS_ID'] ];
-                // get pretty trnasaction status
-                $reg_csv_array[ esc_html__(
-                    "Transaction Status",
-                    'event_espresso'
-                ) ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
-                $reg_csv_array[ esc_html__('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
-                    ? $this->_prepare_value_from_db_for_display(
-                        EEM_Transaction::instance(),
-                        'TXN_total',
-                        $reg_row['TransactionTable.TXN_total'],
-                        'localized_float'
-                    ) : '0.00';
-                $reg_csv_array[ esc_html__('Amount Paid', 'event_espresso') ] = $is_primary_reg
-                    ? $this->_prepare_value_from_db_for_display(
-                        EEM_Transaction::instance(),
-                        'TXN_paid',
-                        $reg_row['TransactionTable.TXN_paid'],
-                        'localized_float'
-                    ) : '0.00';
-                $payment_methods = array();
-                $gateway_txn_ids_etc = array();
-                $payment_times = array();
-                if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
-                    $payments_info = EEM_Payment::instance()->get_all_wpdb_results(
-                        array(
-                            array(
-                                'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
-                                'STS_ID' => EEM_Payment::status_id_approved,
-                            ),
-                            'force_join' => array('Payment_Method'),
-                        ),
-                        ARRAY_A,
-                        'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
-                    );
-                    list($payment_methods, $gateway_txn_ids_etc, $payment_times) = PaymentsInfoCSV::extractPaymentInfo($payments_info);
-                }
-                $reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
-                $reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
-                $reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
-                    ',',
-                    $gateway_txn_ids_etc
-                );
-
-                // get whether or not the user has checked in
-                $reg_csv_array[ esc_html__("Check-Ins", "event_espresso") ] = $reg_model->count_related(
-                    $reg_row['Registration.REG_ID'],
-                    'Checkin'
-                );
-                // get ticket of registration and its price
-                $ticket_model = EE_Registry::instance()->load_model('Ticket');
-                if ($reg_row['Ticket.TKT_ID']) {
-                    $ticket_name = $this->_prepare_value_from_db_for_display(
-                        $ticket_model,
-                        'TKT_name',
-                        $reg_row['Ticket.TKT_name']
-                    );
-                    $datetimes_strings = array();
-                    foreach (
-                        EEM_Datetime::instance()->get_all_wpdb_results(
-                            array(
-                            array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']),
-                            'order_by'                 => array('DTT_EVT_start' => 'ASC'),
-                            'default_where_conditions' => 'none',
-                            )
-                        ) as $datetime
-                    ) {
-                        $datetimes_strings[] = $this->_prepare_value_from_db_for_display(
-                            EEM_Datetime::instance(),
-                            'DTT_EVT_start',
-                            $datetime['Datetime.DTT_EVT_start']
-                        );
-                    }
-                } else {
-                    $ticket_name = esc_html__('Unknown', 'event_espresso');
-                    $datetimes_strings = array(esc_html__('Unknown', 'event_espresso'));
-                }
-                $reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
-                $reg_csv_array[ esc_html__("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings);
-                // get datetime(s) of registration
-
-                // add attendee columns
-                foreach ($att_fields_to_include as $att_field_name) {
-                    $field_obj = EEM_Attendee::instance()->field_settings_for($att_field_name);
-                    if ($reg_row['Attendee_CPT.ID']) {
-                        if ($att_field_name == 'STA_ID') {
-                            $value = EEM_State::instance()->get_var(
-                                array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])),
-                                'STA_name'
-                            );
-                        } elseif ($att_field_name == 'CNT_ISO') {
-                            $value = EEM_Country::instance()->get_var(
-                                array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])),
-                                'CNT_name'
-                            );
-                        } else {
-                            $value = $this->_prepare_value_from_db_for_display(
-                                EEM_Attendee::instance(),
-                                $att_field_name,
-                                $reg_row[ $field_obj->get_qualified_column() ]
-                            );
-                        }
-                    } else {
-                        $value = '';
-                    }
-
-                    $reg_csv_array[ $this->_get_column_name_for_field($field_obj) ] = $value;
-                }
-
-                // make sure each registration has the same questions in the same order
-                foreach ($questions_for_these_regs_rows as $question_row) {
-                    if (! isset($reg_csv_array[ $question_row['Question.QST_admin_label'] ])) {
-                        $reg_csv_array[ $question_row['Question.QST_admin_label'] ] = null;
-                    }
-                }
-                // now fill out the questions THEY answered
-                foreach (
-                    EEM_Answer::instance()->get_all_wpdb_results(
-                        array(array('REG_ID' => $reg_row['Registration.REG_ID']), 'force_join' => array('Question'))
-                    ) as $answer_row
-                ) {
-                    /* @var $answer EE_Answer */
-                    if ($answer_row['Question.QST_ID']) {
-                        $question_label = $this->_prepare_value_from_db_for_display(
-                            EEM_Question::instance(),
-                            'QST_admin_label',
-                            $answer_row['Question.QST_admin_label']
-                        );
-                    } else {
-                        $question_label = sprintf(esc_html__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
-                    }
-                    if (isset($answer_row['Question.QST_type']) && $answer_row['Question.QST_type'] == EEM_Question::QST_type_state) {
-                        $reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID(
-                            (int) $answer_row['Answer.ANS_value']
-                        );
-                    } else {
-                        $reg_csv_array[ $question_label ] = $this->_prepare_value_from_db_for_display(
-                            EEM_Answer::instance(),
-                            'ANS_value',
-                            $answer_row['Answer.ANS_value']
-                        );
-                    }
-                }
-                $registrations_csv_ready_array[] = apply_filters(
-                    'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
-                    $reg_csv_array,
-                    $reg_row
-                );
-            }
-        }
-
-        // if we couldn't export anything, we want to at least show the column headers
-        if (empty($registrations_csv_ready_array)) {
-            $reg_csv_array = array();
-            $model_and_fields_to_include = array(
-                'Registration' => $reg_fields_to_include,
-                'Attendee'     => $att_fields_to_include,
-            );
-            foreach ($model_and_fields_to_include as $model_name => $field_list) {
-                $model = EE_Registry::instance()->load_model($model_name);
-                foreach ($field_list as $field_name) {
-                    $field = $model->field_settings_for($field_name);
-                    $reg_csv_array[ $this->_get_column_name_for_field(
-                        $field
-                    ) ] = null;// $registration->get($field->get_name());
-                }
-            }
-            $registrations_csv_ready_array [] = $reg_csv_array;
-        }
-        if ($event_id) {
-            $event_slug = EEM_Event::instance()->get_var(array(array('EVT_ID' => $event_id)), 'EVT_slug');
-            if (! $event_slug) {
-                $event_slug = esc_html__('unknown', 'event_espresso');
-            }
-        } else {
-            $event_slug = esc_html__('all', 'event_espresso');
-        }
-        $filename = sprintf("registrations-for-%s", $event_slug);
-
-        $handle = $this->EE_CSV->begin_sending_csv($filename);
-        $this->EE_CSV->write_data_array_to_csv($handle, $registrations_csv_ready_array);
-        $this->EE_CSV->end_sending_csv($handle);
-    }
-
-    /**
-     * Gets the 'normal' column named for fields
-     *
-     * @param EE_Model_Field_Base $field
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_column_name_for_field(EE_Model_Field_Base $field)
-    {
-        return $field->get_nicename() . "[" . $field->get_name() . "]";
-    }
-
-
-    /**
-     * Export data for ALL events
-     * @return void
-     */
-    public function export_categories()
-    {
-        // are any Event IDs set?
-        $query_params = array();
-        if (isset($this->_req_data['EVT_CAT_ID'])) {
-            // do we have an array of IDs ?
-            if (is_array($this->_req_data['EVT_CAT_ID'])) {
-                // generate an "IN (CSV)" where clause
-                $EVT_CAT_IDs = array_map('sanitize_text_field', $this->_req_data['EVT_CAT_ID']);
-                $filename = 'event-categories';
-                $query_params[0]['term_taxonomy_id'] = array('IN', $EVT_CAT_IDs);
-            } else {
-                // generate regular where = clause
-                $EVT_CAT_ID = absint($this->_req_data['EVT_CAT_ID']);
-                $filename = 'event-category#' . $EVT_CAT_ID;
-                $query_params[0]['term_taxonomy_id'] = $EVT_CAT_ID;
-            }
-        } else {
-            // no IDs means we will d/l the entire table
-            $filename = 'all-categories';
-        }
-
-        $tables_to_export = array(
-            'Term_Taxonomy' => $query_params,
-        );
-
-        $table_data = $this->_get_export_data_for_models($tables_to_export);
-        $filename = $this->generate_filename($filename);
-
-        if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $table_data)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred and the Category details could not be exported from the database.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * process export name to create a suitable filename
-     * @param string - export_name
-     * @return string on success, FALSE on fail
-     */
-    private function generate_filename($export_name = '')
-    {
-        if ($export_name != '') {
-            $filename = get_bloginfo('name') . '-' . $export_name;
-            $filename = sanitize_key($filename) . '-' . $this->today;
-            return $filename;
-        } else {
-            EE_Error::add_error(esc_html__("No filename was provided", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return false;
-    }
-
-
-    /**
-     * recursive function for exporting table data and merging the results with the next results
-     * @param array $models_to_export keys are model names (eg 'Event', 'Attendee', etc.) and values are arrays of
-     *                                query params @return bool on success, FALSE on fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    private function _get_export_data_for_models($models_to_export = array())
-    {
-        $table_data = false;
-        if (is_array($models_to_export)) {
-            foreach ($models_to_export as $model_name => $query_params) {
-                // check for a numerically-indexed array. in that case, $model_name is the value!!
-                if (is_int($model_name)) {
-                    $model_name = $query_params;
-                    $query_params = array();
-                }
-                $model = EE_Registry::instance()->load_model($model_name);
-                $model_objects = $model->get_all($query_params);
-
-                $table_data[ $model_name ] = array();
-                foreach ($model_objects as $model_object) {
-                    $model_data_array = array();
-                    $fields = $model->field_settings();
-                    foreach ($fields as $field) {
-                        $column_name = $field->get_nicename() . "[" . $field->get_name() . "]";
-                        if ($field instanceof EE_Datetime_Field) {
-                            // $field->set_date_format('Y-m-d');
-                            // $field->set_time_format('H:i:s');
-                            $model_data_array[ $column_name ] = $model_object->get_datetime(
-                                $field->get_name(),
-                                'Y-m-d',
-                                'H:i:s'
-                            );
-                        } else {
-                            $model_data_array[ $column_name ] = $model_object->get($field->get_name());
-                        }
-                    }
-                    $table_data[ $model_name ][] = $model_data_array;
-                }
-            }
-        }
-        return $table_data;
-    }
+	const option_prefix = 'ee_report_job_';
+
+	/**
+	 * instance of the EE_Export object
+	 */
+	private static $_instance = null;
+
+	/**
+	 * instance of the EE_CSV object
+	 * @var EE_CSV
+	 */
+	public $EE_CSV = null;
+
+
+	private $_req_data = array();
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param array $request_data
+	 */
+	private function __construct($request_data = array())
+	{
+		$this->_req_data = $request_data;
+		$this->today = date("Y-m-d", time());
+		require_once(EE_CLASSES . 'EE_CSV.class.php');
+		$this->EE_CSV = EE_CSV::instance();
+	}
+
+
+	/**
+	 * singleton method used to instantiate class object
+	 *
+	 * @param array $request_data
+	 * @return EE_Export
+	 */
+	public static function instance($request_data = array())
+	{
+		// check if class object is instantiated
+		if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Export)) {
+			self::$_instance = new self($request_data);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Export Event Espresso data - routes export requests
+	 * @return void | bool
+	 */
+	public function export()
+	{
+		// in case of bulk exports, the "actual" action will be in action2, but first check regular action for "export" keyword
+		if (isset($this->_req_data['action']) && strpos($this->_req_data['action'], 'export') === false) {
+			// check if action2 has export action
+			if (isset($this->_req_data['action2']) && strpos($this->_req_data['action2'], 'export') !== false) {
+				// whoop! there it is!
+				$this->_req_data['action'] = $this->_req_data['action2'];
+			}
+		}
+
+		$this->_req_data['export'] = isset($this->_req_data['export']) ? $this->_req_data['export'] : '';
+
+		switch ($this->_req_data['export']) {
+			case 'report':
+				switch ($this->_req_data['action']) {
+					case "event":
+					case "export_events":
+					case 'all_event_data':
+						$this->export_all_event_data();
+						break;
+
+					case 'registrations_report_for_event':
+						$this->report_registrations_for_event($this->_req_data['EVT_ID']);
+						break;
+
+					case 'attendees':
+						$this->export_attendees();
+						break;
+
+					case 'categories':
+						$this->export_categories();
+						break;
+
+					default:
+						EE_Error::add_error(
+							esc_html__('An error occurred! The requested export report could not be found.', 'event_espresso'),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+						break;
+				}
+				break; // end of switch export : report
+			default:
+				break;
+		} // end of switch export
+
+		exit;
+	}
+
+	/**
+	 * Downloads a CSV file with all the columns, but no data. This should be used for importing
+	 *
+	 * @return void kills execution
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function export_sample()
+	{
+		$event = EEM_Event::instance()->get_one();
+		$this->_req_data['EVT_ID'] = $event->ID();
+		$this->export_all_event_data();
+	}
+
+
+	/**
+	 * Export data for ALL events
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function export_all_event_data()
+	{
+		// are any Event IDs set?
+		$event_query_params = array();
+		$related_models_query_params = array();
+		$related_through_reg_query_params = array();
+		$datetime_ticket_query_params = array();
+		$price_query_params = array();
+		$price_type_query_params = array();
+		$term_query_params = array();
+		$state_country_query_params = array();
+		$question_group_query_params = array();
+		$question_query_params = array();
+		if (isset($this->_req_data['EVT_ID'])) {
+			// do we have an array of IDs ?
+
+			if (is_array($this->_req_data['EVT_ID'])) {
+				$EVT_IDs = array_map('sanitize_text_field', $this->_req_data['EVT_ID']);
+				$value_to_equal = array('IN', $EVT_IDs);
+				$filename = 'events';
+			} else {
+				// generate regular where = clause
+				$EVT_ID = absint($this->_req_data['EVT_ID']);
+				$value_to_equal = $EVT_ID;
+				$event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($EVT_ID);
+
+				$filename = 'event-' . ($event instanceof EE_Event ? $event->slug() : esc_html__('unknown', 'event_espresso'));
+			}
+			$event_query_params[0]['EVT_ID'] = $value_to_equal;
+			$related_models_query_params[0]['Event.EVT_ID'] = $value_to_equal;
+			$related_through_reg_query_params[0]['Registration.EVT_ID'] = $value_to_equal;
+			$datetime_ticket_query_params[0]['Datetime.EVT_ID'] = $value_to_equal;
+			$price_query_params[0]['Ticket.Datetime.EVT_ID'] = $value_to_equal;
+			$price_type_query_params[0]['Price.Ticket.Datetime.EVT_ID'] = $value_to_equal;
+			$term_query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $value_to_equal;
+			$state_country_query_params[0]['Venue.Event.EVT_ID'] = $value_to_equal;
+			$question_group_query_params[0]['Event.EVT_ID'] = $value_to_equal;
+			$question_query_params[0]['Question_Group.Event.EVT_ID'] = $value_to_equal;
+		} else {
+			$filename = 'all-events';
+		}
+
+
+		// array in the format:  table name =>  query where clause
+		$models_to_export = array(
+			'Event'                   => $event_query_params,
+			'Datetime'                => $related_models_query_params,
+			'Ticket_Template'         => $price_query_params,
+			'Ticket'                  => $datetime_ticket_query_params,
+			'Datetime_Ticket'         => $datetime_ticket_query_params,
+			'Price_Type'              => $price_type_query_params,
+			'Price'                   => $price_query_params,
+			'Ticket_Price'            => $price_query_params,
+			'Term'                    => $term_query_params,
+			'Term_Taxonomy'           => $related_models_query_params,
+			'Term_Relationship'       => $related_models_query_params, // model has NO primary key...
+			'Country'                 => $state_country_query_params,
+			'State'                   => $state_country_query_params,
+			'Venue'                   => $related_models_query_params,
+			'Event_Venue'             => $related_models_query_params,
+			'Question_Group'          => $question_group_query_params,
+			'Event_Question_Group'    => $question_group_query_params,
+			'Question'                => $question_query_params,
+			'Question_Group_Question' => $question_query_params,
+			// 'Transaction'=>$related_through_reg_query_params,
+			// 'Registration'=>$related_models_query_params,
+			// 'Attendee'=>$related_through_reg_query_params,
+			// 'Line_Item'=>
+
+		);
+
+		$model_data = $this->_get_export_data_for_models($models_to_export);
+
+		$filename = $this->generate_filename($filename);
+
+		if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
+			EE_Error::add_error(
+				esc_html__(
+					"'An error occurred and the Event details could not be exported from the database.'",
+					"event_espresso"
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+	public function report_attendees()
+	{
+		$attendee_rows = EEM_Attendee::instance()->get_all_wpdb_results(
+			array(
+				'force_join' => array('State', 'Country'),
+				'caps'       => EEM_Base::caps_read_admin,
+			)
+		);
+		$csv_data = array();
+		foreach ($attendee_rows as $attendee_row) {
+			$csv_row = array();
+			foreach (EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) {
+				if ($field_name == 'STA_ID') {
+					$state_name_field = EEM_State::instance()->field_settings_for('STA_name');
+					$csv_row[ esc_html__('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column(
+					) ];
+				} elseif ($field_name == 'CNT_ISO') {
+					$country_name_field = EEM_Country::instance()->field_settings_for('CNT_name');
+					$csv_row[ esc_html__(
+						'Country',
+						'event_espresso'
+					) ] = $attendee_row[ $country_name_field->get_qualified_column() ];
+				} else {
+					$csv_row[ $field_obj->get_nicename() ] = $attendee_row[ $field_obj->get_qualified_column() ];
+				}
+			}
+			$csv_data[] = $csv_row;
+		}
+
+		$filename = $this->generate_filename('contact-list-report');
+
+		$handle = $this->EE_CSV->begin_sending_csv($filename);
+		$this->EE_CSV->write_data_array_to_csv($handle, $csv_data);
+		$this->EE_CSV->end_sending_csv($handle);
+	}
+
+
+	/**
+	 * Export data for ALL attendees
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function export_attendees()
+	{
+
+		$states_that_have_an_attendee = EEM_State::instance()->get_all(
+			array(0 => array('Attendee.ATT_ID' => array('IS NOT NULL')))
+		);
+		$countries_that_have_an_attendee = EEM_Country::instance()->get_all(
+			array(0 => array('Attendee.ATT_ID' => array('IS NOT NULL')))
+		);
+		// $states_to_export_query_params
+		$models_to_export = array(
+			'Country'  => array(array('CNT_ISO' => array('IN', array_keys($countries_that_have_an_attendee)))),
+			'State'    => array(array('STA_ID' => array('IN', array_keys($states_that_have_an_attendee)))),
+			'Attendee' => array(),
+		);
+
+
+		$model_data = $this->_get_export_data_for_models($models_to_export);
+		$filename = $this->generate_filename('all-attendees');
+
+		if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred and the Attendee data could not be exported from the database.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+	/**
+	 * Shortcut for preparing a database result for display
+	 *
+	 * @param EEM_Base $model
+	 * @param string $field_name
+	 * @param string $raw_db_value
+	 * @param bool|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to
+	 *                                      NOT display pretty
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true)
+	{
+		$field_obj = $model->field_settings_for($field_name);
+		$value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value);
+		if ($field_obj instanceof EE_Datetime_Field) {
+			$field_obj->set_date_format(
+				EE_CSV::instance()->get_date_format_for_csv($field_obj->get_date_format($pretty_schema)),
+				$pretty_schema
+			);
+			$field_obj->set_time_format(
+				EE_CSV::instance()->get_time_format_for_csv($field_obj->get_time_format($pretty_schema)),
+				$pretty_schema
+			);
+		}
+		if ($pretty_schema === true) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj);
+		} elseif (is_string($pretty_schema)) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema);
+		} else {
+			return $field_obj->prepare_for_get($value_on_model_obj);
+		}
+	}
+
+	/**
+	 * Export a custom CSV of registration info including: A bunch of the reg fields, the time of the event, the price
+	 * name, and the questions associated with the registrations
+	 *
+	 * @param int $event_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function report_registrations_for_event($event_id = null)
+	{
+		$reg_fields_to_include = array(
+			'TXN_ID',
+			'ATT_ID',
+			'REG_ID',
+			'REG_date',
+			'REG_code',
+			'REG_count',
+			'REG_final_price',
+
+		);
+		$att_fields_to_include = array(
+			'ATT_fname',
+			'ATT_lname',
+			'ATT_email',
+			'ATT_address',
+			'ATT_address2',
+			'ATT_city',
+			'STA_ID',
+			'CNT_ISO',
+			'ATT_zip',
+			'ATT_phone',
+		);
+
+		$registrations_csv_ready_array = array();
+		$reg_model = EE_Registry::instance()->load_model('Registration');
+		$query_params = apply_filters(
+			'FHEE__EE_Export__report_registration_for_event',
+			array(
+				array(
+					'OR'                 => array(
+						// don't include registrations from failed or abandoned transactions...
+						'Transaction.STS_ID' => array(
+							'NOT IN',
+							array(EEM_Transaction::failed_status_code, EEM_Transaction::abandoned_status_code),
+						),
+						// unless the registration is approved, in which case include it regardless of transaction status
+						'STS_ID'             => RegStatus::APPROVED,
+					),
+					'Ticket.TKT_deleted' => array('IN', array(true, false)),
+				),
+				'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
+				'force_join' => array('Transaction', 'Ticket', 'Attendee'),
+				'caps'       => EEM_Base::caps_read_admin,
+			),
+			$event_id
+		);
+		if ($event_id) {
+			$query_params[0]['EVT_ID'] = $event_id;
+		} else {
+			$query_params['force_join'][] = 'Event';
+		}
+		$registration_rows = $reg_model->get_all_wpdb_results($query_params);
+		// get all questions which relate to someone in this group
+		$registration_ids = array();
+		foreach ($registration_rows as $reg_row) {
+			$registration_ids[] = intval($reg_row['Registration.REG_ID']);
+		}
+		// EEM_Question::instance()->show_next_x_db_queries();
+		$questions_for_these_regs_rows = EEM_Question::instance()->get_all_wpdb_results(
+			array(array('Answer.REG_ID' => array('IN', $registration_ids)))
+		);
+		foreach ($registration_rows as $reg_row) {
+			if (is_array($reg_row)) {
+				$reg_csv_array = array();
+				if (! $event_id) {
+					// get the event's name and Id
+					$reg_csv_array[ esc_html__('Event', 'event_espresso') ] = sprintf(
+						esc_html__('%1$s (%2$s)', 'event_espresso'),
+						$this->_prepare_value_from_db_for_display(
+							EEM_Event::instance(),
+							'EVT_name',
+							$reg_row['Event_CPT.post_title']
+						),
+						$reg_row['Event_CPT.ID']
+					);
+				}
+				$is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
+				/*@var $reg_row EE_Registration */
+				foreach ($reg_fields_to_include as $field_name) {
+					$field = $reg_model->field_settings_for($field_name);
+					if ($field_name == 'REG_final_price') {
+						$value = $this->_prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row['Registration.REG_final_price'],
+							'localized_float'
+						);
+					} elseif ($field_name == 'REG_count') {
+						$value = sprintf(
+							esc_html__('%s of %s', 'event_espresso'),
+							$this->_prepare_value_from_db_for_display(
+								$reg_model,
+								'REG_count',
+								$reg_row['Registration.REG_count']
+							),
+							$this->_prepare_value_from_db_for_display(
+								$reg_model,
+								'REG_group_size',
+								$reg_row['Registration.REG_group_size']
+							)
+						);
+					} elseif ($field_name == 'REG_date') {
+						$value = $this->_prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row['Registration.REG_date'],
+							'no_html'
+						);
+					} else {
+						$value = $this->_prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row[ $field->get_qualified_column() ]
+						);
+					}
+					$reg_csv_array[ $this->_get_column_name_for_field($field) ] = $value;
+					if ($field_name == 'REG_final_price') {
+						// add a column named Currency after the final price
+						$reg_csv_array[ esc_html__("Currency", "event_espresso") ] = EE_Config::instance()->currency->code;
+					}
+				}
+				// get pretty status
+				$stati = EEM_Status::instance()->localized_status(
+					array(
+						$reg_row['Registration.STS_ID']     => esc_html__('unknown', 'event_espresso'),
+						$reg_row['TransactionTable.STS_ID'] => esc_html__('unknown', 'event_espresso'),
+					),
+					false,
+					'sentence'
+				);
+				$reg_csv_array[ esc_html__(
+					"Registration Status",
+					'event_espresso'
+				) ] = $stati[ $reg_row['Registration.STS_ID'] ];
+				// get pretty trnasaction status
+				$reg_csv_array[ esc_html__(
+					"Transaction Status",
+					'event_espresso'
+				) ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
+				$reg_csv_array[ esc_html__('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
+					? $this->_prepare_value_from_db_for_display(
+						EEM_Transaction::instance(),
+						'TXN_total',
+						$reg_row['TransactionTable.TXN_total'],
+						'localized_float'
+					) : '0.00';
+				$reg_csv_array[ esc_html__('Amount Paid', 'event_espresso') ] = $is_primary_reg
+					? $this->_prepare_value_from_db_for_display(
+						EEM_Transaction::instance(),
+						'TXN_paid',
+						$reg_row['TransactionTable.TXN_paid'],
+						'localized_float'
+					) : '0.00';
+				$payment_methods = array();
+				$gateway_txn_ids_etc = array();
+				$payment_times = array();
+				if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
+					$payments_info = EEM_Payment::instance()->get_all_wpdb_results(
+						array(
+							array(
+								'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
+								'STS_ID' => EEM_Payment::status_id_approved,
+							),
+							'force_join' => array('Payment_Method'),
+						),
+						ARRAY_A,
+						'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
+					);
+					list($payment_methods, $gateway_txn_ids_etc, $payment_times) = PaymentsInfoCSV::extractPaymentInfo($payments_info);
+				}
+				$reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
+				$reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
+				$reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+					',',
+					$gateway_txn_ids_etc
+				);
+
+				// get whether or not the user has checked in
+				$reg_csv_array[ esc_html__("Check-Ins", "event_espresso") ] = $reg_model->count_related(
+					$reg_row['Registration.REG_ID'],
+					'Checkin'
+				);
+				// get ticket of registration and its price
+				$ticket_model = EE_Registry::instance()->load_model('Ticket');
+				if ($reg_row['Ticket.TKT_ID']) {
+					$ticket_name = $this->_prepare_value_from_db_for_display(
+						$ticket_model,
+						'TKT_name',
+						$reg_row['Ticket.TKT_name']
+					);
+					$datetimes_strings = array();
+					foreach (
+						EEM_Datetime::instance()->get_all_wpdb_results(
+							array(
+							array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']),
+							'order_by'                 => array('DTT_EVT_start' => 'ASC'),
+							'default_where_conditions' => 'none',
+							)
+						) as $datetime
+					) {
+						$datetimes_strings[] = $this->_prepare_value_from_db_for_display(
+							EEM_Datetime::instance(),
+							'DTT_EVT_start',
+							$datetime['Datetime.DTT_EVT_start']
+						);
+					}
+				} else {
+					$ticket_name = esc_html__('Unknown', 'event_espresso');
+					$datetimes_strings = array(esc_html__('Unknown', 'event_espresso'));
+				}
+				$reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
+				$reg_csv_array[ esc_html__("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings);
+				// get datetime(s) of registration
+
+				// add attendee columns
+				foreach ($att_fields_to_include as $att_field_name) {
+					$field_obj = EEM_Attendee::instance()->field_settings_for($att_field_name);
+					if ($reg_row['Attendee_CPT.ID']) {
+						if ($att_field_name == 'STA_ID') {
+							$value = EEM_State::instance()->get_var(
+								array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])),
+								'STA_name'
+							);
+						} elseif ($att_field_name == 'CNT_ISO') {
+							$value = EEM_Country::instance()->get_var(
+								array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])),
+								'CNT_name'
+							);
+						} else {
+							$value = $this->_prepare_value_from_db_for_display(
+								EEM_Attendee::instance(),
+								$att_field_name,
+								$reg_row[ $field_obj->get_qualified_column() ]
+							);
+						}
+					} else {
+						$value = '';
+					}
+
+					$reg_csv_array[ $this->_get_column_name_for_field($field_obj) ] = $value;
+				}
+
+				// make sure each registration has the same questions in the same order
+				foreach ($questions_for_these_regs_rows as $question_row) {
+					if (! isset($reg_csv_array[ $question_row['Question.QST_admin_label'] ])) {
+						$reg_csv_array[ $question_row['Question.QST_admin_label'] ] = null;
+					}
+				}
+				// now fill out the questions THEY answered
+				foreach (
+					EEM_Answer::instance()->get_all_wpdb_results(
+						array(array('REG_ID' => $reg_row['Registration.REG_ID']), 'force_join' => array('Question'))
+					) as $answer_row
+				) {
+					/* @var $answer EE_Answer */
+					if ($answer_row['Question.QST_ID']) {
+						$question_label = $this->_prepare_value_from_db_for_display(
+							EEM_Question::instance(),
+							'QST_admin_label',
+							$answer_row['Question.QST_admin_label']
+						);
+					} else {
+						$question_label = sprintf(esc_html__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
+					}
+					if (isset($answer_row['Question.QST_type']) && $answer_row['Question.QST_type'] == EEM_Question::QST_type_state) {
+						$reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID(
+							(int) $answer_row['Answer.ANS_value']
+						);
+					} else {
+						$reg_csv_array[ $question_label ] = $this->_prepare_value_from_db_for_display(
+							EEM_Answer::instance(),
+							'ANS_value',
+							$answer_row['Answer.ANS_value']
+						);
+					}
+				}
+				$registrations_csv_ready_array[] = apply_filters(
+					'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
+					$reg_csv_array,
+					$reg_row
+				);
+			}
+		}
+
+		// if we couldn't export anything, we want to at least show the column headers
+		if (empty($registrations_csv_ready_array)) {
+			$reg_csv_array = array();
+			$model_and_fields_to_include = array(
+				'Registration' => $reg_fields_to_include,
+				'Attendee'     => $att_fields_to_include,
+			);
+			foreach ($model_and_fields_to_include as $model_name => $field_list) {
+				$model = EE_Registry::instance()->load_model($model_name);
+				foreach ($field_list as $field_name) {
+					$field = $model->field_settings_for($field_name);
+					$reg_csv_array[ $this->_get_column_name_for_field(
+						$field
+					) ] = null;// $registration->get($field->get_name());
+				}
+			}
+			$registrations_csv_ready_array [] = $reg_csv_array;
+		}
+		if ($event_id) {
+			$event_slug = EEM_Event::instance()->get_var(array(array('EVT_ID' => $event_id)), 'EVT_slug');
+			if (! $event_slug) {
+				$event_slug = esc_html__('unknown', 'event_espresso');
+			}
+		} else {
+			$event_slug = esc_html__('all', 'event_espresso');
+		}
+		$filename = sprintf("registrations-for-%s", $event_slug);
+
+		$handle = $this->EE_CSV->begin_sending_csv($filename);
+		$this->EE_CSV->write_data_array_to_csv($handle, $registrations_csv_ready_array);
+		$this->EE_CSV->end_sending_csv($handle);
+	}
+
+	/**
+	 * Gets the 'normal' column named for fields
+	 *
+	 * @param EE_Model_Field_Base $field
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_column_name_for_field(EE_Model_Field_Base $field)
+	{
+		return $field->get_nicename() . "[" . $field->get_name() . "]";
+	}
+
+
+	/**
+	 * Export data for ALL events
+	 * @return void
+	 */
+	public function export_categories()
+	{
+		// are any Event IDs set?
+		$query_params = array();
+		if (isset($this->_req_data['EVT_CAT_ID'])) {
+			// do we have an array of IDs ?
+			if (is_array($this->_req_data['EVT_CAT_ID'])) {
+				// generate an "IN (CSV)" where clause
+				$EVT_CAT_IDs = array_map('sanitize_text_field', $this->_req_data['EVT_CAT_ID']);
+				$filename = 'event-categories';
+				$query_params[0]['term_taxonomy_id'] = array('IN', $EVT_CAT_IDs);
+			} else {
+				// generate regular where = clause
+				$EVT_CAT_ID = absint($this->_req_data['EVT_CAT_ID']);
+				$filename = 'event-category#' . $EVT_CAT_ID;
+				$query_params[0]['term_taxonomy_id'] = $EVT_CAT_ID;
+			}
+		} else {
+			// no IDs means we will d/l the entire table
+			$filename = 'all-categories';
+		}
+
+		$tables_to_export = array(
+			'Term_Taxonomy' => $query_params,
+		);
+
+		$table_data = $this->_get_export_data_for_models($tables_to_export);
+		$filename = $this->generate_filename($filename);
+
+		if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $table_data)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred and the Category details could not be exported from the database.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * process export name to create a suitable filename
+	 * @param string - export_name
+	 * @return string on success, FALSE on fail
+	 */
+	private function generate_filename($export_name = '')
+	{
+		if ($export_name != '') {
+			$filename = get_bloginfo('name') . '-' . $export_name;
+			$filename = sanitize_key($filename) . '-' . $this->today;
+			return $filename;
+		} else {
+			EE_Error::add_error(esc_html__("No filename was provided", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return false;
+	}
+
+
+	/**
+	 * recursive function for exporting table data and merging the results with the next results
+	 * @param array $models_to_export keys are model names (eg 'Event', 'Attendee', etc.) and values are arrays of
+	 *                                query params @return bool on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	private function _get_export_data_for_models($models_to_export = array())
+	{
+		$table_data = false;
+		if (is_array($models_to_export)) {
+			foreach ($models_to_export as $model_name => $query_params) {
+				// check for a numerically-indexed array. in that case, $model_name is the value!!
+				if (is_int($model_name)) {
+					$model_name = $query_params;
+					$query_params = array();
+				}
+				$model = EE_Registry::instance()->load_model($model_name);
+				$model_objects = $model->get_all($query_params);
+
+				$table_data[ $model_name ] = array();
+				foreach ($model_objects as $model_object) {
+					$model_data_array = array();
+					$fields = $model->field_settings();
+					foreach ($fields as $field) {
+						$column_name = $field->get_nicename() . "[" . $field->get_name() . "]";
+						if ($field instanceof EE_Datetime_Field) {
+							// $field->set_date_format('Y-m-d');
+							// $field->set_time_format('H:i:s');
+							$model_data_array[ $column_name ] = $model_object->get_datetime(
+								$field->get_name(),
+								'Y-m-d',
+								'H:i:s'
+							);
+						} else {
+							$model_data_array[ $column_name ] = $model_object->get($field->get_name());
+						}
+					}
+					$table_data[ $model_name ][] = $model_data_array;
+				}
+			}
+		}
+		return $table_data;
+	}
 }

Spacing +45 added lines, -45 removed lines

@@ -44,7 +44,7 @@ 
     {
         $this->_req_data = $request_data;
         $this->today = date("Y-m-d", time());
-        require_once(EE_CLASSES . 'EE_CSV.class.php');
+        require_once(EE_CLASSES.'EE_CSV.class.php');
         $this->EE_CSV = EE_CSV::instance();
     }
 
@@ -168,7 +168,7 @@ 
                 $value_to_equal = $EVT_ID;
                 $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($EVT_ID);
 
-                $filename = 'event-' . ($event instanceof EE_Event ? $event->slug() : esc_html__('unknown', 'event_espresso'));
+                $filename = 'event-'.($event instanceof EE_Event ? $event->slug() : esc_html__('unknown', 'event_espresso'));
             }
             $event_query_params[0]['EVT_ID'] = $value_to_equal;
             $related_models_query_params[0]['Event.EVT_ID'] = $value_to_equal;
@@ -217,7 +217,7 @@ 
 
         $filename = $this->generate_filename($filename);
 
-        if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
+        if ( ! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
             EE_Error::add_error(
                 esc_html__(
                     "'An error occurred and the Event details could not be exported from the database.'",
@@ -244,16 +244,16 @@ 
             foreach (EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) {
                 if ($field_name == 'STA_ID') {
                     $state_name_field = EEM_State::instance()->field_settings_for('STA_name');
-                    $csv_row[ esc_html__('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column(
-                    ) ];
+                    $csv_row[esc_html__('State', 'event_espresso')] = $attendee_row[$state_name_field->get_qualified_column(
+                    )];
                 } elseif ($field_name == 'CNT_ISO') {
                     $country_name_field = EEM_Country::instance()->field_settings_for('CNT_name');
-                    $csv_row[ esc_html__(
+                    $csv_row[esc_html__(
                         'Country',
                         'event_espresso'
-                    ) ] = $attendee_row[ $country_name_field->get_qualified_column() ];
+                    )] = $attendee_row[$country_name_field->get_qualified_column()];
                 } else {
-                    $csv_row[ $field_obj->get_nicename() ] = $attendee_row[ $field_obj->get_qualified_column() ];
+                    $csv_row[$field_obj->get_nicename()] = $attendee_row[$field_obj->get_qualified_column()];
                 }
             }
             $csv_data[] = $csv_row;
@@ -292,7 +292,7 @@ 
         $model_data = $this->_get_export_data_for_models($models_to_export);
         $filename = $this->generate_filename('all-attendees');
 
-        if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
+        if ( ! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred and the Attendee data could not be exported from the database.',
@@ -413,9 +413,9 @@ 
         foreach ($registration_rows as $reg_row) {
             if (is_array($reg_row)) {
                 $reg_csv_array = array();
-                if (! $event_id) {
+                if ( ! $event_id) {
                     // get the event's name and Id
-                    $reg_csv_array[ esc_html__('Event', 'event_espresso') ] = sprintf(
+                    $reg_csv_array[esc_html__('Event', 'event_espresso')] = sprintf(
                         esc_html__('%1$s (%2$s)', 'event_espresso'),
                         $this->_prepare_value_from_db_for_display(
                             EEM_Event::instance(),
@@ -461,13 +461,13 @@ 
                         $value = $this->_prepare_value_from_db_for_display(
                             $reg_model,
                             $field_name,
-                            $reg_row[ $field->get_qualified_column() ]
+                            $reg_row[$field->get_qualified_column()]
                         );
                     }
-                    $reg_csv_array[ $this->_get_column_name_for_field($field) ] = $value;
+                    $reg_csv_array[$this->_get_column_name_for_field($field)] = $value;
                     if ($field_name == 'REG_final_price') {
                         // add a column named Currency after the final price
-                        $reg_csv_array[ esc_html__("Currency", "event_espresso") ] = EE_Config::instance()->currency->code;
+                        $reg_csv_array[esc_html__("Currency", "event_espresso")] = EE_Config::instance()->currency->code;
                     }
                 }
                 // get pretty status
@@ -479,23 +479,23 @@ 
                     false,
                     'sentence'
                 );
-                $reg_csv_array[ esc_html__(
+                $reg_csv_array[esc_html__(
                     "Registration Status",
                     'event_espresso'
-                ) ] = $stati[ $reg_row['Registration.STS_ID'] ];
+                )] = $stati[$reg_row['Registration.STS_ID']];
                 // get pretty trnasaction status
-                $reg_csv_array[ esc_html__(
+                $reg_csv_array[esc_html__(
                     "Transaction Status",
                     'event_espresso'
-                ) ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
-                $reg_csv_array[ esc_html__('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
+                )] = $stati[$reg_row['TransactionTable.STS_ID']];
+                $reg_csv_array[esc_html__('Transaction Amount Due', 'event_espresso')] = $is_primary_reg
                     ? $this->_prepare_value_from_db_for_display(
                         EEM_Transaction::instance(),
                         'TXN_total',
                         $reg_row['TransactionTable.TXN_total'],
                         'localized_float'
                     ) : '0.00';
-                $reg_csv_array[ esc_html__('Amount Paid', 'event_espresso') ] = $is_primary_reg
+                $reg_csv_array[esc_html__('Amount Paid', 'event_espresso')] = $is_primary_reg
                     ? $this->_prepare_value_from_db_for_display(
                         EEM_Transaction::instance(),
                         'TXN_paid',
@@ -519,15 +519,15 @@ 
                     );
                     list($payment_methods, $gateway_txn_ids_etc, $payment_times) = PaymentsInfoCSV::extractPaymentInfo($payments_info);
                 }
-                $reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
-                $reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
-                $reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+                $reg_csv_array[esc_html__('Payment Date(s)', 'event_espresso')] = implode(',', $payment_times);
+                $reg_csv_array[esc_html__('Payment Method(s)', 'event_espresso')] = implode(",", $payment_methods);
+                $reg_csv_array[esc_html__('Gateway Transaction ID(s)', 'event_espresso')] = implode(
                     ',',
                     $gateway_txn_ids_etc
                 );
 
                 // get whether or not the user has checked in
-                $reg_csv_array[ esc_html__("Check-Ins", "event_espresso") ] = $reg_model->count_related(
+                $reg_csv_array[esc_html__("Check-Ins", "event_espresso")] = $reg_model->count_related(
                     $reg_row['Registration.REG_ID'],
                     'Checkin'
                 );
@@ -559,8 +559,8 @@ 
                     $ticket_name = esc_html__('Unknown', 'event_espresso');
                     $datetimes_strings = array(esc_html__('Unknown', 'event_espresso'));
                 }
-                $reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
-                $reg_csv_array[ esc_html__("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings);
+                $reg_csv_array[$ticket_model->field_settings_for('TKT_name')->get_nicename()] = $ticket_name;
+                $reg_csv_array[esc_html__("Datetimes of Ticket", "event_espresso")] = implode(", ", $datetimes_strings);
                 // get datetime(s) of registration
 
                 // add attendee columns
@@ -581,20 +581,20 @@ 
                             $value = $this->_prepare_value_from_db_for_display(
                                 EEM_Attendee::instance(),
                                 $att_field_name,
-                                $reg_row[ $field_obj->get_qualified_column() ]
+                                $reg_row[$field_obj->get_qualified_column()]
                             );
                         }
                     } else {
                         $value = '';
                     }
 
-                    $reg_csv_array[ $this->_get_column_name_for_field($field_obj) ] = $value;
+                    $reg_csv_array[$this->_get_column_name_for_field($field_obj)] = $value;
                 }
 
                 // make sure each registration has the same questions in the same order
                 foreach ($questions_for_these_regs_rows as $question_row) {
-                    if (! isset($reg_csv_array[ $question_row['Question.QST_admin_label'] ])) {
-                        $reg_csv_array[ $question_row['Question.QST_admin_label'] ] = null;
+                    if ( ! isset($reg_csv_array[$question_row['Question.QST_admin_label']])) {
+                        $reg_csv_array[$question_row['Question.QST_admin_label']] = null;
                     }
                 }
                 // now fill out the questions THEY answered
@@ -614,11 +614,11 @@ 
                         $question_label = sprintf(esc_html__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
                     }
                     if (isset($answer_row['Question.QST_type']) && $answer_row['Question.QST_type'] == EEM_Question::QST_type_state) {
-                        $reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID(
+                        $reg_csv_array[$question_label] = EEM_State::instance()->get_state_name_by_ID(
                             (int) $answer_row['Answer.ANS_value']
                         );
                     } else {
-                        $reg_csv_array[ $question_label ] = $this->_prepare_value_from_db_for_display(
+                        $reg_csv_array[$question_label] = $this->_prepare_value_from_db_for_display(
                             EEM_Answer::instance(),
                             'ANS_value',
                             $answer_row['Answer.ANS_value']
@@ -644,16 +644,16 @@ 
                 $model = EE_Registry::instance()->load_model($model_name);
                 foreach ($field_list as $field_name) {
                     $field = $model->field_settings_for($field_name);
-                    $reg_csv_array[ $this->_get_column_name_for_field(
+                    $reg_csv_array[$this->_get_column_name_for_field(
                         $field
-                    ) ] = null;// $registration->get($field->get_name());
+                    )] = null; // $registration->get($field->get_name());
                 }
             }
             $registrations_csv_ready_array [] = $reg_csv_array;
         }
         if ($event_id) {
             $event_slug = EEM_Event::instance()->get_var(array(array('EVT_ID' => $event_id)), 'EVT_slug');
-            if (! $event_slug) {
+            if ( ! $event_slug) {
                 $event_slug = esc_html__('unknown', 'event_espresso');
             }
         } else {
@@ -675,7 +675,7 @@ 
      */
     protected function _get_column_name_for_field(EE_Model_Field_Base $field)
     {
-        return $field->get_nicename() . "[" . $field->get_name() . "]";
+        return $field->get_nicename()."[".$field->get_name()."]";
     }
 
 
@@ -697,7 +697,7 @@ 
             } else {
                 // generate regular where = clause
                 $EVT_CAT_ID = absint($this->_req_data['EVT_CAT_ID']);
-                $filename = 'event-category#' . $EVT_CAT_ID;
+                $filename = 'event-category#'.$EVT_CAT_ID;
                 $query_params[0]['term_taxonomy_id'] = $EVT_CAT_ID;
             }
         } else {
@@ -712,7 +712,7 @@ 
         $table_data = $this->_get_export_data_for_models($tables_to_export);
         $filename = $this->generate_filename($filename);
 
-        if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $table_data)) {
+        if ( ! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $table_data)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred and the Category details could not be exported from the database.',
@@ -734,8 +734,8 @@ 
     private function generate_filename($export_name = '')
     {
         if ($export_name != '') {
-            $filename = get_bloginfo('name') . '-' . $export_name;
-            $filename = sanitize_key($filename) . '-' . $this->today;
+            $filename = get_bloginfo('name').'-'.$export_name;
+            $filename = sanitize_key($filename).'-'.$this->today;
             return $filename;
         } else {
             EE_Error::add_error(esc_html__("No filename was provided", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
@@ -765,25 +765,25 @@ 
                 $model = EE_Registry::instance()->load_model($model_name);
                 $model_objects = $model->get_all($query_params);
 
-                $table_data[ $model_name ] = array();
+                $table_data[$model_name] = array();
                 foreach ($model_objects as $model_object) {
                     $model_data_array = array();
                     $fields = $model->field_settings();
                     foreach ($fields as $field) {
-                        $column_name = $field->get_nicename() . "[" . $field->get_name() . "]";
+                        $column_name = $field->get_nicename()."[".$field->get_name()."]";
                         if ($field instanceof EE_Datetime_Field) {
                             // $field->set_date_format('Y-m-d');
                             // $field->set_time_format('H:i:s');
-                            $model_data_array[ $column_name ] = $model_object->get_datetime(
+                            $model_data_array[$column_name] = $model_object->get_datetime(
                                 $field->get_name(),
                                 'Y-m-d',
                                 'H:i:s'
                             );
                         } else {
-                            $model_data_array[ $column_name ] = $model_object->get($field->get_name());
+                            $model_data_array[$column_name] = $model_object->get($field->get_name());
                         }
                     }
-                    $table_data[ $model_name ][] = $model_data_array;
+                    $table_data[$model_name][] = $model_data_array;
                 }
             }
         }

core/db_classes/EE_Question_Option.class.php

Indentation +259 added lines, -259 removed lines

@@ -10,263 +10,263 @@
  */
 class EE_Question_Option extends EE_Soft_Delete_Base_Class implements EEI_Duplicatable
 {
-    /**
-     * Question Option Opt Group Name
-     *
-     * @var string
-     */
-    protected string $_QSO_opt_group = '';
-
-
-    /**
-     * @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_Question_Option
-     * @throws EE_Error
-     * @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_Question_Option
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Sets the option's key value
-     *
-     * @param string $value
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_value(string $value)
-    {
-        $this->set('QSO_value', $value);
-    }
-
-
-    /**
-     * Sets the option's Display Text
-     *
-     * @param string $text
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_desc(string $text)
-    {
-        $this->set('QSO_desc', $text);
-    }
-
-
-    /**
-     * Sets the order for this option
-     *
-     * @param int $order
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_order(int $order)
-    {
-        $this->set('QSO_order', $order);
-    }
-
-
-    /**
-     * Sets the ID of the related question
-     *
-     * @param int $question_ID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_question_ID(int $question_ID)
-    {
-        $this->set('QST_ID', $question_ID);
-    }
-
-
-    /**
-     * Sets the option's opt_group
-     *
-     * @param string $text
-     */
-    public function set_opt_group(string $text)
-    {
-        $this->_QSO_opt_group = $text;
-    }
-
-
-    /**
-     * Gets the option's key value
-     *
-     * @return int|float|string|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function value()
-    {
-        return $this->get('QSO_value');
-    }
-
-
-    /**
-     * Gets the option's display text
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function desc(): string
-    {
-        return (string) $this->get('QSO_desc');
-    }
-
-
-    /**
-     * Returns whether this option has been deleted or not
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function deleted(): bool
-    {
-        return (bool) $this->get('QSO_deleted');
-    }
-
-
-    /**
-     * Returns the order or the Question Option
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function order(): int
-    {
-        return (int) $this->get('QSO_option');
-    }
-
-
-    /**
-     * Gets the related question's ID
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function question_ID(): int
-    {
-        return (int) $this->get('QST_ID');
-    }
-
-
-    /**
-     * Returns the question related to this question option
-     *
-     * @return EE_Question
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function question(): EE_Question
-    {
-        return $this->get_first_related('Question');
-    }
-
-
-    /**
-     * Gets the option's opt_group
-     *
-     * @return string
-     */
-    public function opt_group(): string
-    {
-        return $this->_QSO_opt_group;
-    }
-
-
-    /**
-     * Duplicates this question option. By default the new question option will be for the same question,
-     * but that can be overriden by setting the 'QST_ID' option
-     *
-     * @param array $options {
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function duplicate($options = [])
-    {
-        $new_question_option = clone $this;
-        $new_question_option->set('QSO_ID', null);
-        if (
-            array_key_exists(
-                'QST_ID',
-                $options
-            )
-        ) {// use array_key_exists instead of isset because NULL might be a valid value
-            $new_question_option->set_question_ID($options['QST_ID']);
-        }
-        $new_question_option->save();
-    }
-
-
-    /**
-     * Gets the QSO_system value
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function system(): string
-    {
-        return (string) $this->get('QSO_system');
-    }
-
-
-    /**
-     * Sets QSO_system
-     *
-     * @param string $QSO_system
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_system(string $QSO_system)
-    {
-        $this->set('QSO_system', $QSO_system);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function isDefault(): bool
-    {
-        return (bool) $this->get('QSO_default');
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setIsDefault(bool $is_default)
-    {
-        $this->set('QSO_default', $is_default);
-    }
+	/**
+	 * Question Option Opt Group Name
+	 *
+	 * @var string
+	 */
+	protected string $_QSO_opt_group = '';
+
+
+	/**
+	 * @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_Question_Option
+	 * @throws EE_Error
+	 * @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_Question_Option
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Sets the option's key value
+	 *
+	 * @param string $value
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_value(string $value)
+	{
+		$this->set('QSO_value', $value);
+	}
+
+
+	/**
+	 * Sets the option's Display Text
+	 *
+	 * @param string $text
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_desc(string $text)
+	{
+		$this->set('QSO_desc', $text);
+	}
+
+
+	/**
+	 * Sets the order for this option
+	 *
+	 * @param int $order
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_order(int $order)
+	{
+		$this->set('QSO_order', $order);
+	}
+
+
+	/**
+	 * Sets the ID of the related question
+	 *
+	 * @param int $question_ID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_question_ID(int $question_ID)
+	{
+		$this->set('QST_ID', $question_ID);
+	}
+
+
+	/**
+	 * Sets the option's opt_group
+	 *
+	 * @param string $text
+	 */
+	public function set_opt_group(string $text)
+	{
+		$this->_QSO_opt_group = $text;
+	}
+
+
+	/**
+	 * Gets the option's key value
+	 *
+	 * @return int|float|string|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function value()
+	{
+		return $this->get('QSO_value');
+	}
+
+
+	/**
+	 * Gets the option's display text
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function desc(): string
+	{
+		return (string) $this->get('QSO_desc');
+	}
+
+
+	/**
+	 * Returns whether this option has been deleted or not
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function deleted(): bool
+	{
+		return (bool) $this->get('QSO_deleted');
+	}
+
+
+	/**
+	 * Returns the order or the Question Option
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function order(): int
+	{
+		return (int) $this->get('QSO_option');
+	}
+
+
+	/**
+	 * Gets the related question's ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function question_ID(): int
+	{
+		return (int) $this->get('QST_ID');
+	}
+
+
+	/**
+	 * Returns the question related to this question option
+	 *
+	 * @return EE_Question
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function question(): EE_Question
+	{
+		return $this->get_first_related('Question');
+	}
+
+
+	/**
+	 * Gets the option's opt_group
+	 *
+	 * @return string
+	 */
+	public function opt_group(): string
+	{
+		return $this->_QSO_opt_group;
+	}
+
+
+	/**
+	 * Duplicates this question option. By default the new question option will be for the same question,
+	 * but that can be overriden by setting the 'QST_ID' option
+	 *
+	 * @param array $options {
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function duplicate($options = [])
+	{
+		$new_question_option = clone $this;
+		$new_question_option->set('QSO_ID', null);
+		if (
+			array_key_exists(
+				'QST_ID',
+				$options
+			)
+		) {// use array_key_exists instead of isset because NULL might be a valid value
+			$new_question_option->set_question_ID($options['QST_ID']);
+		}
+		$new_question_option->save();
+	}
+
+
+	/**
+	 * Gets the QSO_system value
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function system(): string
+	{
+		return (string) $this->get('QSO_system');
+	}
+
+
+	/**
+	 * Sets QSO_system
+	 *
+	 * @param string $QSO_system
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_system(string $QSO_system)
+	{
+		$this->set('QSO_system', $QSO_system);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function isDefault(): bool
+	{
+		return (bool) $this->get('QSO_default');
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setIsDefault(bool $is_default)
+	{
+		$this->set('QSO_default', $is_default);
+	}
 }

core/db_classes/EE_Registration.class.php

Indentation +2597 added lines, -2597 removed lines

@@ -19,2601 +19,2601 @@
  */
 class EE_Registration extends EE_Soft_Delete_Base_Class implements EEI_Registration, EEI_Admin_Links
 {
-    /**
-     * extra meta key for tracking reg status os trashed registrations
-     *
-     * @type string
-     */
-    public const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
-
-    /**
-     * extra meta key for tracking if registration has reserved ticket
-     *
-     * @type string
-     */
-    public const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
-
-    /**
-     * extra meta key for tracking registration cancellations
-     *
-     * @type string
-     */
-    public const META_KEY_REG_STATUS_CHANGE = 'registration_status_change';
-
-
-    /**
-     * @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((string) $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(
-        string $new_STS_ID = '',
-        bool $use_default = false,
-        ?ContextInterface $context = null
-    ): bool {
-        // get current REG_Status
-        $old_STS_ID = $this->status_ID();
-        $new_STS_ID = (string) apply_filters(
-            'AFEE__EE_Registration__set_status__new_STS_ID',
-            $new_STS_ID,
-            $context,
-            $this
-        );
-        // it's still good to allow the parent set method to have a say
-        parent::set('STS_ID', (! empty($new_STS_ID) ? $new_STS_ID : null), $use_default);
-        // 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
-        ) {
-            // THEN handle other changes that occur when reg status changes
-            // TO approved
-            if ($new_STS_ID === RegStatus::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 === RegStatus::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
-                );
-            }
-            $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 ! empty($new_STS_ID);
-    }
-
-
-    /**
-     * 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
-            );
-        }
-    }
-
-
-    /**
-     * 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__ . ')');
-                // comment out extra meta tracking
-                // $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) {
-            $released = $this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
-            if ($released && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
-                // comment out extra meta tracking
-                // $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 ==
-     *    RegStatus::AWAITING_REVIEW
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_not_approved()
-    {
-        return $this->status_ID() === RegStatus::AWAITING_REVIEW;
-    }
-
-
-    /**
-     *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
-     *    RegStatus::PENDING_PAYMENT
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_pending_payment()
-    {
-        return $this->status_ID() === RegStatus::PENDING_PAYMENT;
-    }
-
-
-    /**
-     *    is_approved -  convenience method that returns TRUE if REG status ID == RegStatus::APPROVED
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_approved()
-    {
-        return $this->status_ID() === RegStatus::APPROVED;
-    }
-
-
-    /**
-     *    is_cancelled -  convenience method that returns TRUE if REG status ID == RegStatus::CANCELLED
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_cancelled()
-    {
-        return $this->status_ID() === RegStatus::CANCELLED;
-    }
-
-
-    /**
-     *    is_declined -  convenience method that returns TRUE if REG status ID == RegStatus::DECLINED
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_declined()
-    {
-        return $this->status_ID() === RegStatus::DECLINED;
-    }
-
-
-    /**
-     *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
-     *    RegStatus::INCOMPLETE
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_incomplete()
-    {
-        return $this->status_ID() === RegStatus::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 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 RegStatus::APPROVED:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>'
-                    : '';
-                break;
-            case RegStatus::PENDING_PAYMENT:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case RegStatus::AWAITING_REVIEW:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case RegStatus::CANCELLED:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
-                    : '';
-                break;
-            case RegStatus::INCOMPLETE:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>'
-                    : '';
-                break;
-            case RegStatus::DECLINED:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-            case RegStatus::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 it's 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 checked out)
-     *
-     * @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 check in 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 check in 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 check in.  false means cannot check in.
-     * @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
-        // because it's 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 check-in 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 check-ins 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
-        );
-        // check-ins have already reached their max number of uses
-        // so registrant can NOT check in
-        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 check-in 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 check in 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 check-in 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 its ID);
-     * @param EE_Checkin|null $checkin If present, we use the given check-in 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
-    {
-        $TXN_ID = $this->transaction_ID();
-        $transaction = $TXN_ID
-            ? EEM_Transaction::instance()->get_one_by_ID($TXN_ID)
-            : $this->get_one_from_cache('Transaction');
-        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 (! $this->reg_code()) {
-            parent::set('REG_code', $REG_code, $use_default);
-        } elseif (empty($REG_code)) {
-            EE_Error::add_error(
-                esc_html__('REG_code can not be empty.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } 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(bool $with_same_ticket = true): array
-    {
-        if ($this->group_size() < 2) {
-            return [];
-        }
-
-        $query[0] = [
-            'TXN_ID' => $this->transaction_ID(),
-            'REG_ID' => ['!=', $this->ID()],
-        ];
-
-        if ($with_same_ticket) {
-            $query[0]['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.
-     *
-     * @return 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(
-                RegStatus::CANCELLED,
-                false,
-                new Context(
-                    __METHOD__,
-                    esc_html__('Executed when a registration is trashed.', 'event_espresso')
-                )
-            );
-        }
-        return parent::delete();
-    }
-
-
-    /**
-     * Restores whatever the previous status was on a registration before it was trashed (if possible)
-     *
-     * @return int
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function restore(): int
-    {
-        $previous_status = $this->get_extra_meta(
-            EE_Registration::PRE_TRASH_REG_STATUS_KEY,
-            true,
-            RegStatus::CANCELLED
-        );
-        if ($previous_status) {
-            $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
-            $this->set_status(
-                $previous_status,
-                false,
-                new Context(
-                    __METHOD__,
-                    esc_html__('Executed when a trashed registration is restored.', 'event_espresso')
-                )
-            );
-        }
-        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 = RegStatus::APPROVED;
-                break;
-            //  underpaid
-            case EEH_Money::compare_floats($paid, $price, '<'):
-                $new_status = RegStatus::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,
-                    false,
-                    new Context(
-                        __METHOD__,
-                        esc_html__(
-                            'Executed when the registration status is updated based on total paid.',
-                            'event_espresso'
-                        )
-                    )
-                );
-            }
-            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;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.20.p
-     */
-    public function defaultRegistrationStatus(): string
-    {
-        $default_event_reg_status = $this->event()->default_registration_status();
-        $default_reg_status = (string) apply_filters(
-            'AFEE__EE_Registration__defaultRegistrationStatus__default_reg_status',
-            $default_event_reg_status,
-            $this
-        );
-        return RegStatus::isValidStatus($default_reg_status, false)
-            ? $default_reg_status
-            : $default_event_reg_status;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.30.p
-     */
-    public function cancelRegistrationConfirmationCode(): string
-    {
-        // concatenate all the fields that make up the source string
-        // ex: 944-1084-720-379-7-2024-10-11 18:21:00-626-379-7-2ff6
-        $source_string = $this->ID() . $this->event_ID() . $this->attendee_ID() . $this->ticket_ID();
-        $source_string .= $this->count() . $this->reg_date() . $this->reg_code();
-        // create a hash of the source string, ex: a9c0d28f79b5602a428e386821015420
-        $source_string = md5($source_string);
-        // return the first 4 characters of the hash in uppercase, ex: A9C0
-        return strtoupper(substr($source_string, 0, 4));
-    }
+	/**
+	 * extra meta key for tracking reg status os trashed registrations
+	 *
+	 * @type string
+	 */
+	public const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
+
+	/**
+	 * extra meta key for tracking if registration has reserved ticket
+	 *
+	 * @type string
+	 */
+	public const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
+
+	/**
+	 * extra meta key for tracking registration cancellations
+	 *
+	 * @type string
+	 */
+	public const META_KEY_REG_STATUS_CHANGE = 'registration_status_change';
+
+
+	/**
+	 * @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((string) $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(
+		string $new_STS_ID = '',
+		bool $use_default = false,
+		?ContextInterface $context = null
+	): bool {
+		// get current REG_Status
+		$old_STS_ID = $this->status_ID();
+		$new_STS_ID = (string) apply_filters(
+			'AFEE__EE_Registration__set_status__new_STS_ID',
+			$new_STS_ID,
+			$context,
+			$this
+		);
+		// it's still good to allow the parent set method to have a say
+		parent::set('STS_ID', (! empty($new_STS_ID) ? $new_STS_ID : null), $use_default);
+		// 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
+		) {
+			// THEN handle other changes that occur when reg status changes
+			// TO approved
+			if ($new_STS_ID === RegStatus::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 === RegStatus::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
+				);
+			}
+			$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 ! empty($new_STS_ID);
+	}
+
+
+	/**
+	 * 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
+			);
+		}
+	}
+
+
+	/**
+	 * 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__ . ')');
+				// comment out extra meta tracking
+				// $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) {
+			$released = $this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
+			if ($released && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+				// comment out extra meta tracking
+				// $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 ==
+	 *    RegStatus::AWAITING_REVIEW
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_not_approved()
+	{
+		return $this->status_ID() === RegStatus::AWAITING_REVIEW;
+	}
+
+
+	/**
+	 *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
+	 *    RegStatus::PENDING_PAYMENT
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_pending_payment()
+	{
+		return $this->status_ID() === RegStatus::PENDING_PAYMENT;
+	}
+
+
+	/**
+	 *    is_approved -  convenience method that returns TRUE if REG status ID == RegStatus::APPROVED
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_approved()
+	{
+		return $this->status_ID() === RegStatus::APPROVED;
+	}
+
+
+	/**
+	 *    is_cancelled -  convenience method that returns TRUE if REG status ID == RegStatus::CANCELLED
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_cancelled()
+	{
+		return $this->status_ID() === RegStatus::CANCELLED;
+	}
+
+
+	/**
+	 *    is_declined -  convenience method that returns TRUE if REG status ID == RegStatus::DECLINED
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_declined()
+	{
+		return $this->status_ID() === RegStatus::DECLINED;
+	}
+
+
+	/**
+	 *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
+	 *    RegStatus::INCOMPLETE
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_incomplete()
+	{
+		return $this->status_ID() === RegStatus::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 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 RegStatus::APPROVED:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>'
+					: '';
+				break;
+			case RegStatus::PENDING_PAYMENT:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case RegStatus::AWAITING_REVIEW:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case RegStatus::CANCELLED:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
+					: '';
+				break;
+			case RegStatus::INCOMPLETE:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>'
+					: '';
+				break;
+			case RegStatus::DECLINED:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+			case RegStatus::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 it's 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 checked out)
+	 *
+	 * @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 check in 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 check in 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 check in.  false means cannot check in.
+	 * @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
+		// because it's 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 check-in 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 check-ins 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
+		);
+		// check-ins have already reached their max number of uses
+		// so registrant can NOT check in
+		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 check-in 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 check in 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 check-in 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 its ID);
+	 * @param EE_Checkin|null $checkin If present, we use the given check-in 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
+	{
+		$TXN_ID = $this->transaction_ID();
+		$transaction = $TXN_ID
+			? EEM_Transaction::instance()->get_one_by_ID($TXN_ID)
+			: $this->get_one_from_cache('Transaction');
+		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 (! $this->reg_code()) {
+			parent::set('REG_code', $REG_code, $use_default);
+		} elseif (empty($REG_code)) {
+			EE_Error::add_error(
+				esc_html__('REG_code can not be empty.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} 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(bool $with_same_ticket = true): array
+	{
+		if ($this->group_size() < 2) {
+			return [];
+		}
+
+		$query[0] = [
+			'TXN_ID' => $this->transaction_ID(),
+			'REG_ID' => ['!=', $this->ID()],
+		];
+
+		if ($with_same_ticket) {
+			$query[0]['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.
+	 *
+	 * @return 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(
+				RegStatus::CANCELLED,
+				false,
+				new Context(
+					__METHOD__,
+					esc_html__('Executed when a registration is trashed.', 'event_espresso')
+				)
+			);
+		}
+		return parent::delete();
+	}
+
+
+	/**
+	 * Restores whatever the previous status was on a registration before it was trashed (if possible)
+	 *
+	 * @return int
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function restore(): int
+	{
+		$previous_status = $this->get_extra_meta(
+			EE_Registration::PRE_TRASH_REG_STATUS_KEY,
+			true,
+			RegStatus::CANCELLED
+		);
+		if ($previous_status) {
+			$this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
+			$this->set_status(
+				$previous_status,
+				false,
+				new Context(
+					__METHOD__,
+					esc_html__('Executed when a trashed registration is restored.', 'event_espresso')
+				)
+			);
+		}
+		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 = RegStatus::APPROVED;
+				break;
+			//  underpaid
+			case EEH_Money::compare_floats($paid, $price, '<'):
+				$new_status = RegStatus::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,
+					false,
+					new Context(
+						__METHOD__,
+						esc_html__(
+							'Executed when the registration status is updated based on total paid.',
+							'event_espresso'
+						)
+					)
+				);
+			}
+			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;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.20.p
+	 */
+	public function defaultRegistrationStatus(): string
+	{
+		$default_event_reg_status = $this->event()->default_registration_status();
+		$default_reg_status = (string) apply_filters(
+			'AFEE__EE_Registration__defaultRegistrationStatus__default_reg_status',
+			$default_event_reg_status,
+			$this
+		);
+		return RegStatus::isValidStatus($default_reg_status, false)
+			? $default_reg_status
+			: $default_event_reg_status;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.30.p
+	 */
+	public function cancelRegistrationConfirmationCode(): string
+	{
+		// concatenate all the fields that make up the source string
+		// ex: 944-1084-720-379-7-2024-10-11 18:21:00-626-379-7-2ff6
+		$source_string = $this->ID() . $this->event_ID() . $this->attendee_ID() . $this->ticket_ID();
+		$source_string .= $this->count() . $this->reg_date() . $this->reg_code();
+		// create a hash of the source string, ex: a9c0d28f79b5602a428e386821015420
+		$source_string = md5($source_string);
+		// return the first 4 characters of the hash in uppercase, ex: A9C0
+		return strtoupper(substr($source_string, 0, 4));
+	}
 }

Spacing +20 added lines, -20 removed lines

@@ -120,7 +120,7 @@ 
     {
         switch ($field_name) {
             case 'REG_code':
-                if (! empty($field_value) && ! $this->reg_code()) {
+                if ( ! empty($field_value) && ! $this->reg_code()) {
                     $this->set_reg_code($field_value, $use_default);
                 }
                 break;
@@ -167,7 +167,7 @@ 
             $this
         );
         // it's still good to allow the parent set method to have a say
-        parent::set('STS_ID', (! empty($new_STS_ID) ? $new_STS_ID : null), $use_default);
+        parent::set('STS_ID', ( ! empty($new_STS_ID) ? $new_STS_ID : null), $use_default);
         // if status has changed
         if (
             $old_STS_ID !== $new_STS_ID // and that status has actually changed
@@ -419,7 +419,7 @@ 
     public function event(): EE_Event
     {
         $event = $this->event_obj();
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             throw new EntityNotFoundException('Event ID', $this->event_ID());
         }
         return $event;
@@ -462,7 +462,7 @@ 
     {
         // 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__ . ')');
+        $this->release_reserved_ticket(false, "REG: {$this->ID()} (ln:".__LINE__.')');
         $ticket = $this->ticket();
         $ticket->increaseSold();
         // possibly set event status to sold out
@@ -512,7 +512,7 @@ 
             $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__ . ')');
+                $ticket->increaseReserved(1, "REG: {$this->ID()} (ln:".__LINE__.')');
                 // comment out extra meta tracking
                 // $this->update_extra_meta('reserve_ticket', "{$this->ticket_ID()} from {$source}");
                 $ticket->save();
@@ -541,7 +541,7 @@ 
             $released = $this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
             if ($released && $update_ticket) {
                 $ticket = $this->ticket();
-                $ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+                $ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:".__LINE__.')');
                 // comment out extra meta tracking
                 // $this->update_extra_meta('release_reserved_ticket', "{$this->ticket_ID()} from {$source}");
             }
@@ -1352,7 +1352,7 @@ 
             false,
             'sentence'
         );
-        $icon   = '';
+        $icon = '';
         switch ($this->status_ID()) {
             case RegStatus::APPROVED:
                 $icon = $show_icons
@@ -1390,7 +1390,7 @@ 
                     : '';
                 break;
         }
-        return $icon . $status[ $this->status_ID() ];
+        return $icon.$status[$this->status_ID()];
     }
 
 
@@ -1645,7 +1645,7 @@ 
     {
         $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
         // first check registration status
-        if (! $DTT_ID || ($check_approved && ! $this->is_approved())) {
+        if ( ! $DTT_ID || ($check_approved && ! $this->is_approved())) {
             return false;
         }
         // is there a datetime ticket that matches this dtt_ID?
@@ -1685,7 +1685,7 @@ 
     {
         $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
 
-        if (! $DTT_ID) {
+        if ( ! $DTT_ID) {
             return false;
         }
 
@@ -1695,7 +1695,7 @@ 
 
         // if max uses is not set or equals infinity then return true
         // because it's not a factor for whether user can check in or not.
-        if (! $max_uses || $max_uses === EE_INF) {
+        if ( ! $max_uses || $max_uses === EE_INF) {
             return true;
         }
 
@@ -1759,7 +1759,7 @@ 
             $datetime = $this->get_latest_related_datetime();
             $DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
             // verify the registration can check in for the given DTT_ID
-        } elseif (! $this->can_checkin($DTT_ID, $verify)) {
+        } elseif ( ! $this->can_checkin($DTT_ID, $verify)) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -1782,7 +1782,7 @@ 
         ];
         // 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 ];
+        $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;
@@ -1894,7 +1894,7 @@ 
             return $checkin->status();
         }
 
-        if (! $DTT_ID) {
+        if ( ! $DTT_ID) {
             return EE_Checkin::status_invalid;
         }
 
@@ -1965,7 +1965,7 @@ 
         $transaction = $TXN_ID
             ? EEM_Transaction::instance()->get_one_by_ID($TXN_ID)
             : $this->get_one_from_cache('Transaction');
-        if (! $transaction instanceof \EE_Transaction) {
+        if ( ! $transaction instanceof \EE_Transaction) {
             throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
         }
         return $transaction;
@@ -2030,7 +2030,7 @@ 
      */
     public function set_reg_code($REG_code, bool $use_default = false)
     {
-        if (! $this->reg_code()) {
+        if ( ! $this->reg_code()) {
             parent::set('REG_code', $REG_code, $use_default);
         } elseif (empty($REG_code)) {
             EE_Error::add_error(
@@ -2041,7 +2041,7 @@ 
             );
         } else {
             EE_Error::doing_it_wrong(
-                __CLASS__ . '::' . __FUNCTION__,
+                __CLASS__.'::'.__FUNCTION__,
                 esc_html__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
                 '4.6.0'
             );
@@ -2235,7 +2235,7 @@ 
                 break;
             }
         }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+        if ( ! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
             throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
         }
         return $line_item;
@@ -2609,8 +2609,8 @@ 
     {
         // concatenate all the fields that make up the source string
         // ex: 944-1084-720-379-7-2024-10-11 18:21:00-626-379-7-2ff6
-        $source_string = $this->ID() . $this->event_ID() . $this->attendee_ID() . $this->ticket_ID();
-        $source_string .= $this->count() . $this->reg_date() . $this->reg_code();
+        $source_string = $this->ID().$this->event_ID().$this->attendee_ID().$this->ticket_ID();
+        $source_string .= $this->count().$this->reg_date().$this->reg_code();
         // create a hash of the source string, ex: a9c0d28f79b5602a428e386821015420
         $source_string = md5($source_string);
         // return the first 4 characters of the hash in uppercase, ex: A9C0

core/db_classes/EE_Question.class.php

Indentation +746 added lines, -746 removed lines

@@ -13,750 +13,750 @@
  */
 class EE_Question extends EE_Soft_Delete_Base_Class implements EEI_Duplicatable
 {
-    private ?string $type = 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_Question
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [], $timezone = '', $date_formats = []): EE_Question
-    {
-        $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_Question
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = ''): EE_Question
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @return EEM_Question
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.30.p
-     */
-    private function getModel(): EEM_Question
-    {
-        return $this->get_model();
-    }
-
-
-    /**
-     * @param string $QST_display_text
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_display_text(string $QST_display_text = '')
-    {
-        $this->set('QST_display_text', $QST_display_text);
-    }
-
-
-    /**
-     * @param string $QST_admin_label
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_admin_label(string $QST_admin_label = '')
-    {
-        $this->set('QST_admin_label', $QST_admin_label);
-    }
-
-
-    /**
-     * @param mixed $QST_system
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_system_ID(string $QST_system = '')
-    {
-        $this->set('QST_system', $QST_system);
-    }
-
-
-    /**
-     * @param string $QST_type
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_question_type(string $QST_type = '')
-    {
-        $this->set('QST_type', $QST_type);
-    }
-
-
-    /**
-     * Sets whether this question must be answered when presented in a form
-     *
-     * @param bool $QST_required
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_required(bool $QST_required = false)
-    {
-        $this->set('QST_required', $QST_required);
-    }
-
-
-    /**
-     * @param string $QST_required_text
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_required_text(string $QST_required_text = '')
-    {
-        $this->set('QST_required_text', $QST_required_text);
-    }
-
-
-    /**
-     * Sets the order of this question when placed in a sequence of questions
-     *
-     * @param int $QST_order
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_order(int $QST_order = 0)
-    {
-        $this->set('QST_order', $QST_order);
-    }
-
-
-    /**
-     * @param bool $QST_admin_only
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_admin_only(bool $QST_admin_only = false)
-    {
-        $this->set('QST_admin_only', $QST_admin_only);
-    }
-
-
-    /**
-     * Sets the WordPress user ID on the question
-     *
-     * @param int $QST_wp_user
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_wp_user(int $QST_wp_user = 1)
-    {
-        $this->set('QST_wp_user', $QST_wp_user);
-    }
-
-
-    /**
-     * Sets whether the question has been deleted
-     * we use this boolean instead of actually deleting it
-     * because when users delete this question they really want to remove the question from future forms,
-     * BUT keep their old answers which depend on this record actually existing.
-     *
-     * @param bool $QST_deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_deleted(bool $QST_deleted = false)
-    {
-        $this->set('QST_deleted', $QST_deleted);
-    }
-
-
-    /**
-     *  used for the input label text displayed to users on the frontend
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function display_text(): string
-    {
-        return (string) $this->get('QST_display_text');
-    }
-
-
-    /**
-     * input label used in the admin
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function admin_label(): string
-    {
-        return (string) $this->get('QST_admin_label');
-    }
-
-
-    /**
-     * returns the attendee column name for this question
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function system_ID(): string
-    {
-        return (string) $this->get('QST_system');
-    }
-
-
-    /**
-     * if question is required or not (boolean)
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function required(): bool
-    {
-        return (bool) $this->get('QST_required');
-    }
-
-
-    /**
-     * returns the text which should be displayed when a user
-     * doesn't answer this question in a form
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function required_text(): string
-    {
-        return (string) $this->get('QST_required_text');
-    }
-
-
-    /**
-     * returns the type of this question: one of the QST_type_* constants on the EEM_Question model
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function type(): string
-    {
-        if ($this->type === null) {
-            $this->type = (string) $this->get('QST_type');
-        }
-        return $this->type;
-    }
-
-
-    /**
-     * returns an integer showing where this question should be placed in a sequence of questions
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function order(): int
-    {
-        return (int) $this->get('QST_order');
-    }
-
-
-    /**
-     * returns whether this question should only appear to admins, or to everyone
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function admin_only(): bool
-    {
-        return (bool) $this->get('QST_admin_only');
-    }
-
-
-    /**
-     * returns the id the WordPress user who created this question
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function wp_user(): int
-    {
-        return (int) $this->get('QST_wp_user');
-    }
-
-
-    /**
-     * returns whether this question has been marked as 'deleted'
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function deleted(): bool
-    {
-        return (bool) $this->get('QST_deleted');
-    }
-
-
-    /**
-     * Gets an array of related EE_Answer  to this EE_Question
-     *
-     * @return EE_Answer[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function answers(): array
-    {
-        return $this->get_many_related('Answer');
-    }
-
-
-    /**
-     * Boolean check for if there are answers on this question in th db
-     *
-     * @return bool true = has answers, false = no answers.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function has_answers(): bool
-    {
-        return (bool) $this->count_related('Answer') > 0;
-    }
-
-
-    /**
-     * gets an array of EE_Question_Group which relate to this question
-     *
-     * @return EE_Question_Group[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function question_groups(): array
-    {
-        return $this->get_many_related('Question_Group');
-    }
-
-
-    /**
-     * Returns all the options for this question. By default, it returns only the not-yet-deleted ones.
-     *
-     * @param bool $notDeletedOptionsOnly                         whether to return ALL options,
-     *                                                            or only the ones which have not yet been deleted
-     * @param string|array|null $selected_value_to_always_include when retrieving options to an ANSWERED question,
-     *                                                            we want to usually only show non-deleted options
-     *                                                            AND the value that was selected for the answer,
-     *                                                            whether it was trashed or not.
-     * @return EE_Question_Option[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function options(bool $notDeletedOptionsOnly = true, $selected_value_to_always_include = null): array
-    {
-        if (! $this->ID()) {
-            return [];
-        }
-        $query_params = [];
-        if ($selected_value_to_always_include) {
-            if (is_array($selected_value_to_always_include)) {
-                $query_params[0]['OR*options-query']['QSO_value'] = ['IN', $selected_value_to_always_include];
-            } else {
-                $query_params[0]['OR*options-query']['QSO_value'] = $selected_value_to_always_include;
-            }
-        }
-        if ($notDeletedOptionsOnly) {
-            $query_params[0]['OR*options-query']['QSO_deleted'] = false;
-        }
-        // order by QSO_order
-        $query_params['order_by'] = ['QSO_order' => 'ASC'];
-        return $this->get_many_related('Question_Option', $query_params);
-    }
-
-
-    /**
-     * returns an array of EE_Question_Options which relate to this question
-     *
-     * @return EE_Question_Option[]
-     */
-    public function temp_options(): array
-    {
-        return $this->_model_relations['Question_Option'];
-    }
-
-
-    /**
-     * Adds an option for this question. Note: if the option were previously associated with a different
-     * Question, that relationship will be overwritten.
-     *
-     * @param EE_Question_Option $option
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_option(EE_Question_Option $option): EE_Base_Class
-    {
-        return $this->_add_relation_to($option, 'Question_Option');
-    }
-
-
-    /**
-     * Adds an option directly to this question without saving to the db
-     *
-     * @param EE_Question_Option $option
-     * @return bool success
-     */
-    public function add_temp_option(EE_Question_Option $option): bool
-    {
-        $this->_model_relations['Question_Option'][] = $option;
-        return true;
-    }
-
-
-    /**
-     * Marks the option as deleted.
-     *
-     * @param EE_Question_Option $option
-     * @return bool success
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remove_option(EE_Question_Option $option): bool
-    {
-        return (bool) $this->_remove_relation_to($option, 'Question_Option');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_system_question(): bool
-    {
-        $system_ID = $this->get('QST_system');
-        return ! empty($system_ID);
-    }
-
-
-    /**
-     * The purpose of this method is set the question order this question order to be the max out of all questions
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_order_to_latest()
-    {
-        $latest_order = $this->getModel()->get_latest_question_order();
-        $latest_order++;
-        $this->set('QST_order', $latest_order);
-    }
-
-
-    /**
-     * Retrieves the list of allowed question types from the model.
-     *
-     * @return string[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _allowed_question_types(): array
-    {
-        return $this->getModel()->allowed_question_types();
-    }
-
-
-    /**
-     * Duplicates this question and its question options
-     *
-     * @param array $options
-     * @return EE_Question|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function duplicate($options = []): ?EE_Question
-    {
-        $new_question = clone $this;
-        $new_question->set('QST_ID', 0);
-        $new_question->set_display_text(
-            sprintf(esc_html__('%s **Duplicate**', 'event_espresso'), $this->display_text())
-        );
-        $new_question->set_admin_label(sprintf(esc_html__('%s **Duplicate**', 'event_espresso'), $this->admin_label()));
-        $new_question->set_system_ID('');
-        $new_question->set_wp_user(get_current_user_id());
-        // if we're duplicating a trashed question, assume we don't want the new one to be trashed
-        $new_question->set_deleted();
-        $success = $new_question->save();
-        if ($success) {
-            // we don't totally want to duplicate the question options, because we want them to be for the NEW question
-            foreach ($this->options() as $question_option) {
-                $question_option->duplicate(['QST_ID' => $new_question->ID()]);
-            }
-            return $new_question;
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns the question's maximum allowed response size
-     *
-     * @return int|float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function max()
-    {
-        return $this->get('QST_max');
-    }
-
-
-    /**
-     * Sets the question's maximum allowed response size
-     *
-     * @param int|float $new_max
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_max($new_max)
-    {
-        $this->set('QST_max', $new_max);
-    }
-
-
-    /**
-     * Creates a form input from this question which can be used in HTML forms
-     *
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer
-     * @param array                $input_constructor_args
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generate_form_input(
-        ?EE_Registration $registration = null,
-        ?EE_Answer $answer = null,
-        array $input_constructor_args = []
-    ): EE_Form_Input_Base {
-        $input_constructor_args = array_merge(
-            [
-                'required'                          => $this->required(),
-                'html_label_text'                   => $this->display_text(),
-                'required_validation_error_message' => $this->required_text(),
-            ],
-            $input_constructor_args
-        );
-        if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
-            $answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID());
-        }
-        $enum_options = $this->isEnumType() ? $this->options() : [];
-        // has this question been answered ?
-        if (
-            $answer instanceof EE_Answer
-            && $answer->value() !== ''
-        ) {
-            // answer gets htmlspecialchars called on it, undo that please
-            // because the form input's display strategy may call esc_attr too
-            // which also does html special characters
-            $values_with_html_special_chars = $answer->value();
-            if (is_array($values_with_html_special_chars)) {
-                $default_value = array_map('htmlspecialchars_decode', $values_with_html_special_chars);
-            } else {
-                $default_value = htmlspecialchars_decode($values_with_html_special_chars);
-            }
-            $input_constructor_args['default'] = $default_value;
-        } else {
-            foreach ($enum_options as $enum_option) {
-                if (! $enum_option instanceof EE_Question_Option) {
-                    continue;
-                }
-                if ($enum_option->isDefault()) {
-                    $input_constructor_args['default'] = $enum_option->value();
-                    break;
-                }
-            }
-        }
-        $max_max_for_question = EEM_Question::instance()->absolute_max_for_system_question($this->system_ID());
-        if (
-            in_array(
-                $this->type(),
-                EEM_Question::instance()->questionTypesWithMaxLength(),
-                true
-            )
-        ) {
-            $input_constructor_args['validation_strategies'][] = new EE_Max_Length_Validation_Strategy(
-                null,
-                min($max_max_for_question, $this->max())
-            );
-        }
-        $input_constructor_args = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__input_constructor_args',
-            $input_constructor_args,
-            $registration,
-            $this,
-            $answer
-        );
-
-        switch ($this->type()) {
-            // Text
-            case EEM_Question::QST_type_text:
-                $result = new EE_Text_Input($input_constructor_args);
-                break;
-            // Textarea
-            case EEM_Question::QST_type_textarea:
-                $result = new EE_Text_Area_Input($input_constructor_args);
-                break;
-            // Radio Buttons
-            case EEM_Question::QST_type_radio:
-                $result = new EE_Radio_Button_Input($enum_options, $input_constructor_args);
-                break;
-            // Dropdown
-            case EEM_Question::QST_type_dropdown:
-                $result = new EE_Select_Input($enum_options, $input_constructor_args);
-                break;
-            // State Dropdown
-            case EEM_Question::QST_type_state:
-                $state_options = apply_filters(
-                    'FHEE__EE_Question__generate_form_input__state_options',
-                    null,
-                    $this,
-                    $registration,
-                    $answer
-                );
-                $result        = new EE_State_Select_Input($state_options, $input_constructor_args);
-                break;
-            // Country Dropdown
-            case EEM_Question::QST_type_country:
-                $country_options = apply_filters(
-                    'FHEE__EE_Question__generate_form_input__country_options',
-                    null,
-                    $this,
-                    $registration,
-                    $answer
-                );
-                $result          = new EE_Country_Select_Input($country_options, $input_constructor_args);
-                break;
-            // Checkboxes
-            case EEM_Question::QST_type_checkbox:
-                $result = new EE_Checkbox_Multi_Input($enum_options, $input_constructor_args);
-                break;
-            // Date
-            case EEM_Question::QST_type_date:
-                $result = new EE_Datepicker_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_html_textarea:
-                $input_constructor_args['validation_strategies'][] = new EE_Simple_HTML_Validation_Strategy();
-                $result                                            = new EE_Text_Area_Input($input_constructor_args);
-                $result->remove_validation_strategy('EE_Plaintext_Validation_Strategy');
-                break;
-            case EEM_Question::QST_type_email:
-                $result = new EE_Email_Input($input_constructor_args);
-                break;
-            // Email confirm
-            case EEM_Question::QST_type_email_confirm:
-                $result = new EE_Email_Confirm_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_us_phone:
-                $result = new EE_Phone_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_int:
-                $result = new EE_Integer_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_decimal:
-                $result = new EE_Float_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_url:
-                $result = new EE_URL_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_year:
-                $result = new EE_Year_Input(
-                    $input_constructor_args,
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__four_digit',
-                        true,
-                        $this
-                    ),
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__early_range',
-                        100,
-                        $this
-                    ),
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__end_range',
-                        100,
-                        $this
-                    )
-                );
-                break;
-            case EEM_Question::QST_type_multi_select:
-                $result = new EE_Select_Multiple_Input($enum_options, $input_constructor_args);
-                break;
-            // fallback
-            default:
-                $default_input = apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__default',
-                    null,
-                    $this->type(),
-                    $this,
-                    $input_constructor_args
-                );
-                if (! $default_input) {
-                    $default_input = new EE_Text_Input($input_constructor_args);
-                }
-                $result = $default_input;
-        }
-        return apply_filters('FHEE__EE_Question__generate_form_input__return', $result, $registration, $this, $answer);
-    }
-
-
-    /**
-     * Returns whether this question type should have question option entries
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function should_have_question_options(): bool
-    {
-        return in_array(
-            $this->type(),
-            $this->getModel()->question_types_with_options(),
-            true
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.30.p
-     */
-    public function isEnumType(): bool
-    {
-        return $this->type() === EEM_Question::QST_type_checkbox
-            || $this->type() === EEM_Question::QST_type_dropdown
-            || $this->type() === EEM_Question::QST_type_multi_select
-            || $this->type() === EEM_Question::QST_type_radio
-            || $this->type() === EEM_Question::QST_type_country
-            || $this->type() === EEM_Question::QST_type_state
-            || $this->type() === EEM_Question::QST_type_year;
-    }
+	private ?string $type = 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_Question
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [], $timezone = '', $date_formats = []): EE_Question
+	{
+		$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_Question
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = ''): EE_Question
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @return EEM_Question
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.30.p
+	 */
+	private function getModel(): EEM_Question
+	{
+		return $this->get_model();
+	}
+
+
+	/**
+	 * @param string $QST_display_text
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_display_text(string $QST_display_text = '')
+	{
+		$this->set('QST_display_text', $QST_display_text);
+	}
+
+
+	/**
+	 * @param string $QST_admin_label
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_admin_label(string $QST_admin_label = '')
+	{
+		$this->set('QST_admin_label', $QST_admin_label);
+	}
+
+
+	/**
+	 * @param mixed $QST_system
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_system_ID(string $QST_system = '')
+	{
+		$this->set('QST_system', $QST_system);
+	}
+
+
+	/**
+	 * @param string $QST_type
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_question_type(string $QST_type = '')
+	{
+		$this->set('QST_type', $QST_type);
+	}
+
+
+	/**
+	 * Sets whether this question must be answered when presented in a form
+	 *
+	 * @param bool $QST_required
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_required(bool $QST_required = false)
+	{
+		$this->set('QST_required', $QST_required);
+	}
+
+
+	/**
+	 * @param string $QST_required_text
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_required_text(string $QST_required_text = '')
+	{
+		$this->set('QST_required_text', $QST_required_text);
+	}
+
+
+	/**
+	 * Sets the order of this question when placed in a sequence of questions
+	 *
+	 * @param int $QST_order
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_order(int $QST_order = 0)
+	{
+		$this->set('QST_order', $QST_order);
+	}
+
+
+	/**
+	 * @param bool $QST_admin_only
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_admin_only(bool $QST_admin_only = false)
+	{
+		$this->set('QST_admin_only', $QST_admin_only);
+	}
+
+
+	/**
+	 * Sets the WordPress user ID on the question
+	 *
+	 * @param int $QST_wp_user
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_wp_user(int $QST_wp_user = 1)
+	{
+		$this->set('QST_wp_user', $QST_wp_user);
+	}
+
+
+	/**
+	 * Sets whether the question has been deleted
+	 * we use this boolean instead of actually deleting it
+	 * because when users delete this question they really want to remove the question from future forms,
+	 * BUT keep their old answers which depend on this record actually existing.
+	 *
+	 * @param bool $QST_deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_deleted(bool $QST_deleted = false)
+	{
+		$this->set('QST_deleted', $QST_deleted);
+	}
+
+
+	/**
+	 *  used for the input label text displayed to users on the frontend
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function display_text(): string
+	{
+		return (string) $this->get('QST_display_text');
+	}
+
+
+	/**
+	 * input label used in the admin
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function admin_label(): string
+	{
+		return (string) $this->get('QST_admin_label');
+	}
+
+
+	/**
+	 * returns the attendee column name for this question
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function system_ID(): string
+	{
+		return (string) $this->get('QST_system');
+	}
+
+
+	/**
+	 * if question is required or not (boolean)
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function required(): bool
+	{
+		return (bool) $this->get('QST_required');
+	}
+
+
+	/**
+	 * returns the text which should be displayed when a user
+	 * doesn't answer this question in a form
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function required_text(): string
+	{
+		return (string) $this->get('QST_required_text');
+	}
+
+
+	/**
+	 * returns the type of this question: one of the QST_type_* constants on the EEM_Question model
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function type(): string
+	{
+		if ($this->type === null) {
+			$this->type = (string) $this->get('QST_type');
+		}
+		return $this->type;
+	}
+
+
+	/**
+	 * returns an integer showing where this question should be placed in a sequence of questions
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function order(): int
+	{
+		return (int) $this->get('QST_order');
+	}
+
+
+	/**
+	 * returns whether this question should only appear to admins, or to everyone
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function admin_only(): bool
+	{
+		return (bool) $this->get('QST_admin_only');
+	}
+
+
+	/**
+	 * returns the id the WordPress user who created this question
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function wp_user(): int
+	{
+		return (int) $this->get('QST_wp_user');
+	}
+
+
+	/**
+	 * returns whether this question has been marked as 'deleted'
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function deleted(): bool
+	{
+		return (bool) $this->get('QST_deleted');
+	}
+
+
+	/**
+	 * Gets an array of related EE_Answer  to this EE_Question
+	 *
+	 * @return EE_Answer[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function answers(): array
+	{
+		return $this->get_many_related('Answer');
+	}
+
+
+	/**
+	 * Boolean check for if there are answers on this question in th db
+	 *
+	 * @return bool true = has answers, false = no answers.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function has_answers(): bool
+	{
+		return (bool) $this->count_related('Answer') > 0;
+	}
+
+
+	/**
+	 * gets an array of EE_Question_Group which relate to this question
+	 *
+	 * @return EE_Question_Group[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function question_groups(): array
+	{
+		return $this->get_many_related('Question_Group');
+	}
+
+
+	/**
+	 * Returns all the options for this question. By default, it returns only the not-yet-deleted ones.
+	 *
+	 * @param bool $notDeletedOptionsOnly                         whether to return ALL options,
+	 *                                                            or only the ones which have not yet been deleted
+	 * @param string|array|null $selected_value_to_always_include when retrieving options to an ANSWERED question,
+	 *                                                            we want to usually only show non-deleted options
+	 *                                                            AND the value that was selected for the answer,
+	 *                                                            whether it was trashed or not.
+	 * @return EE_Question_Option[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function options(bool $notDeletedOptionsOnly = true, $selected_value_to_always_include = null): array
+	{
+		if (! $this->ID()) {
+			return [];
+		}
+		$query_params = [];
+		if ($selected_value_to_always_include) {
+			if (is_array($selected_value_to_always_include)) {
+				$query_params[0]['OR*options-query']['QSO_value'] = ['IN', $selected_value_to_always_include];
+			} else {
+				$query_params[0]['OR*options-query']['QSO_value'] = $selected_value_to_always_include;
+			}
+		}
+		if ($notDeletedOptionsOnly) {
+			$query_params[0]['OR*options-query']['QSO_deleted'] = false;
+		}
+		// order by QSO_order
+		$query_params['order_by'] = ['QSO_order' => 'ASC'];
+		return $this->get_many_related('Question_Option', $query_params);
+	}
+
+
+	/**
+	 * returns an array of EE_Question_Options which relate to this question
+	 *
+	 * @return EE_Question_Option[]
+	 */
+	public function temp_options(): array
+	{
+		return $this->_model_relations['Question_Option'];
+	}
+
+
+	/**
+	 * Adds an option for this question. Note: if the option were previously associated with a different
+	 * Question, that relationship will be overwritten.
+	 *
+	 * @param EE_Question_Option $option
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_option(EE_Question_Option $option): EE_Base_Class
+	{
+		return $this->_add_relation_to($option, 'Question_Option');
+	}
+
+
+	/**
+	 * Adds an option directly to this question without saving to the db
+	 *
+	 * @param EE_Question_Option $option
+	 * @return bool success
+	 */
+	public function add_temp_option(EE_Question_Option $option): bool
+	{
+		$this->_model_relations['Question_Option'][] = $option;
+		return true;
+	}
+
+
+	/**
+	 * Marks the option as deleted.
+	 *
+	 * @param EE_Question_Option $option
+	 * @return bool success
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remove_option(EE_Question_Option $option): bool
+	{
+		return (bool) $this->_remove_relation_to($option, 'Question_Option');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_system_question(): bool
+	{
+		$system_ID = $this->get('QST_system');
+		return ! empty($system_ID);
+	}
+
+
+	/**
+	 * The purpose of this method is set the question order this question order to be the max out of all questions
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_order_to_latest()
+	{
+		$latest_order = $this->getModel()->get_latest_question_order();
+		$latest_order++;
+		$this->set('QST_order', $latest_order);
+	}
+
+
+	/**
+	 * Retrieves the list of allowed question types from the model.
+	 *
+	 * @return string[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _allowed_question_types(): array
+	{
+		return $this->getModel()->allowed_question_types();
+	}
+
+
+	/**
+	 * Duplicates this question and its question options
+	 *
+	 * @param array $options
+	 * @return EE_Question|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function duplicate($options = []): ?EE_Question
+	{
+		$new_question = clone $this;
+		$new_question->set('QST_ID', 0);
+		$new_question->set_display_text(
+			sprintf(esc_html__('%s **Duplicate**', 'event_espresso'), $this->display_text())
+		);
+		$new_question->set_admin_label(sprintf(esc_html__('%s **Duplicate**', 'event_espresso'), $this->admin_label()));
+		$new_question->set_system_ID('');
+		$new_question->set_wp_user(get_current_user_id());
+		// if we're duplicating a trashed question, assume we don't want the new one to be trashed
+		$new_question->set_deleted();
+		$success = $new_question->save();
+		if ($success) {
+			// we don't totally want to duplicate the question options, because we want them to be for the NEW question
+			foreach ($this->options() as $question_option) {
+				$question_option->duplicate(['QST_ID' => $new_question->ID()]);
+			}
+			return $new_question;
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns the question's maximum allowed response size
+	 *
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function max()
+	{
+		return $this->get('QST_max');
+	}
+
+
+	/**
+	 * Sets the question's maximum allowed response size
+	 *
+	 * @param int|float $new_max
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_max($new_max)
+	{
+		$this->set('QST_max', $new_max);
+	}
+
+
+	/**
+	 * Creates a form input from this question which can be used in HTML forms
+	 *
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer
+	 * @param array                $input_constructor_args
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generate_form_input(
+		?EE_Registration $registration = null,
+		?EE_Answer $answer = null,
+		array $input_constructor_args = []
+	): EE_Form_Input_Base {
+		$input_constructor_args = array_merge(
+			[
+				'required'                          => $this->required(),
+				'html_label_text'                   => $this->display_text(),
+				'required_validation_error_message' => $this->required_text(),
+			],
+			$input_constructor_args
+		);
+		if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
+			$answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID());
+		}
+		$enum_options = $this->isEnumType() ? $this->options() : [];
+		// has this question been answered ?
+		if (
+			$answer instanceof EE_Answer
+			&& $answer->value() !== ''
+		) {
+			// answer gets htmlspecialchars called on it, undo that please
+			// because the form input's display strategy may call esc_attr too
+			// which also does html special characters
+			$values_with_html_special_chars = $answer->value();
+			if (is_array($values_with_html_special_chars)) {
+				$default_value = array_map('htmlspecialchars_decode', $values_with_html_special_chars);
+			} else {
+				$default_value = htmlspecialchars_decode($values_with_html_special_chars);
+			}
+			$input_constructor_args['default'] = $default_value;
+		} else {
+			foreach ($enum_options as $enum_option) {
+				if (! $enum_option instanceof EE_Question_Option) {
+					continue;
+				}
+				if ($enum_option->isDefault()) {
+					$input_constructor_args['default'] = $enum_option->value();
+					break;
+				}
+			}
+		}
+		$max_max_for_question = EEM_Question::instance()->absolute_max_for_system_question($this->system_ID());
+		if (
+			in_array(
+				$this->type(),
+				EEM_Question::instance()->questionTypesWithMaxLength(),
+				true
+			)
+		) {
+			$input_constructor_args['validation_strategies'][] = new EE_Max_Length_Validation_Strategy(
+				null,
+				min($max_max_for_question, $this->max())
+			);
+		}
+		$input_constructor_args = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__input_constructor_args',
+			$input_constructor_args,
+			$registration,
+			$this,
+			$answer
+		);
+
+		switch ($this->type()) {
+			// Text
+			case EEM_Question::QST_type_text:
+				$result = new EE_Text_Input($input_constructor_args);
+				break;
+			// Textarea
+			case EEM_Question::QST_type_textarea:
+				$result = new EE_Text_Area_Input($input_constructor_args);
+				break;
+			// Radio Buttons
+			case EEM_Question::QST_type_radio:
+				$result = new EE_Radio_Button_Input($enum_options, $input_constructor_args);
+				break;
+			// Dropdown
+			case EEM_Question::QST_type_dropdown:
+				$result = new EE_Select_Input($enum_options, $input_constructor_args);
+				break;
+			// State Dropdown
+			case EEM_Question::QST_type_state:
+				$state_options = apply_filters(
+					'FHEE__EE_Question__generate_form_input__state_options',
+					null,
+					$this,
+					$registration,
+					$answer
+				);
+				$result        = new EE_State_Select_Input($state_options, $input_constructor_args);
+				break;
+			// Country Dropdown
+			case EEM_Question::QST_type_country:
+				$country_options = apply_filters(
+					'FHEE__EE_Question__generate_form_input__country_options',
+					null,
+					$this,
+					$registration,
+					$answer
+				);
+				$result          = new EE_Country_Select_Input($country_options, $input_constructor_args);
+				break;
+			// Checkboxes
+			case EEM_Question::QST_type_checkbox:
+				$result = new EE_Checkbox_Multi_Input($enum_options, $input_constructor_args);
+				break;
+			// Date
+			case EEM_Question::QST_type_date:
+				$result = new EE_Datepicker_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_html_textarea:
+				$input_constructor_args['validation_strategies'][] = new EE_Simple_HTML_Validation_Strategy();
+				$result                                            = new EE_Text_Area_Input($input_constructor_args);
+				$result->remove_validation_strategy('EE_Plaintext_Validation_Strategy');
+				break;
+			case EEM_Question::QST_type_email:
+				$result = new EE_Email_Input($input_constructor_args);
+				break;
+			// Email confirm
+			case EEM_Question::QST_type_email_confirm:
+				$result = new EE_Email_Confirm_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_us_phone:
+				$result = new EE_Phone_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_int:
+				$result = new EE_Integer_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_decimal:
+				$result = new EE_Float_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_url:
+				$result = new EE_URL_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_year:
+				$result = new EE_Year_Input(
+					$input_constructor_args,
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__four_digit',
+						true,
+						$this
+					),
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__early_range',
+						100,
+						$this
+					),
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__end_range',
+						100,
+						$this
+					)
+				);
+				break;
+			case EEM_Question::QST_type_multi_select:
+				$result = new EE_Select_Multiple_Input($enum_options, $input_constructor_args);
+				break;
+			// fallback
+			default:
+				$default_input = apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__default',
+					null,
+					$this->type(),
+					$this,
+					$input_constructor_args
+				);
+				if (! $default_input) {
+					$default_input = new EE_Text_Input($input_constructor_args);
+				}
+				$result = $default_input;
+		}
+		return apply_filters('FHEE__EE_Question__generate_form_input__return', $result, $registration, $this, $answer);
+	}
+
+
+	/**
+	 * Returns whether this question type should have question option entries
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function should_have_question_options(): bool
+	{
+		return in_array(
+			$this->type(),
+			$this->getModel()->question_types_with_options(),
+			true
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.30.p
+	 */
+	public function isEnumType(): bool
+	{
+		return $this->type() === EEM_Question::QST_type_checkbox
+			|| $this->type() === EEM_Question::QST_type_dropdown
+			|| $this->type() === EEM_Question::QST_type_multi_select
+			|| $this->type() === EEM_Question::QST_type_radio
+			|| $this->type() === EEM_Question::QST_type_country
+			|| $this->type() === EEM_Question::QST_type_state
+			|| $this->type() === EEM_Question::QST_type_year;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -368,7 +368,7 @@ 
      */
     public function options(bool $notDeletedOptionsOnly = true, $selected_value_to_always_include = null): array
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return [];
         }
         $query_params = [];
@@ -563,7 +563,7 @@ 
             ],
             $input_constructor_args
         );
-        if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
+        if ( ! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
             $answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID());
         }
         $enum_options = $this->isEnumType() ? $this->options() : [];
@@ -584,7 +584,7 @@ 
             $input_constructor_args['default'] = $default_value;
         } else {
             foreach ($enum_options as $enum_option) {
-                if (! $enum_option instanceof EE_Question_Option) {
+                if ( ! $enum_option instanceof EE_Question_Option) {
                     continue;
                 }
                 if ($enum_option->isDefault()) {
@@ -640,7 +640,7 @@ 
                     $registration,
                     $answer
                 );
-                $result        = new EE_State_Select_Input($state_options, $input_constructor_args);
+                $result = new EE_State_Select_Input($state_options, $input_constructor_args);
                 break;
             // Country Dropdown
             case EEM_Question::QST_type_country:
@@ -651,7 +651,7 @@ 
                     $registration,
                     $answer
                 );
-                $result          = new EE_Country_Select_Input($country_options, $input_constructor_args);
+                $result = new EE_Country_Select_Input($country_options, $input_constructor_args);
                 break;
             // Checkboxes
             case EEM_Question::QST_type_checkbox:
@@ -717,7 +717,7 @@ 
                     $this,
                     $input_constructor_args
                 );
-                if (! $default_input) {
+                if ( ! $default_input) {
                     $default_input = new EE_Text_Input($input_constructor_args);
                 }
                 $result = $default_input;

core/db_classes/EE_Ticket.class.php

Indentation +2148 added lines, -2148 removed lines

@@ -15,2156 +15,2156 @@
  */
 class EE_Ticket extends EE_Soft_Delete_Base_Class implements EEI_Line_Item_Object, EEI_Event_Relation, EEI_Has_Icon
 {
-    /**
-     * TicKet Archived:
-     * constant used by ticket_status() to indicate that a ticket is archived
-     * and no longer available for purchase
-     */
-    const archived = 'TKA';
-
-    /**
-     * TicKet Expired:
-     * constant used by ticket_status() to indicate that a ticket is expired
-     * and no longer available for purchase
-     */
-    const expired = 'TKE';
-
-    /**
-     * TicKet On sale:
-     * constant used by ticket_status() to indicate that a ticket is On Sale
-     * and IS available for purchase
-     */
-    const onsale = 'TKO';
-
-    /**
-     * TicKet Pending:
-     * constant used by ticket_status() to indicate that a ticket is pending
-     * and is NOT YET available for purchase
-     */
-    const pending = 'TKP';
-
-    /**
-     * TicKet Sold out:
-     * constant used by ticket_status() to indicate that a ticket is sold out
-     * and no longer available for purchases
-     */
-    const sold_out = 'TKS';
-
-    /**
-     * extra meta key for tracking ticket reservations
-     *
-     * @type string
-     */
-    const META_KEY_TICKET_RESERVATIONS = 'ticket_reservations';
-
-    /**
-     * override of parent property
-     *
-     * @var EEM_Ticket
-     */
-    protected $_model;
-
-    /**
-     * cached result from method of the same name
-     *
-     * @var float $_ticket_total_with_taxes
-     */
-    private $_ticket_total_with_taxes;
-
-    /**
-     * @var TicketPriceModifiers
-     */
-    protected $ticket_price_modifiers;
-
-
-    /**
-     * @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_Ticket
-     * @throws EE_Error
-     * @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_Ticket
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @param array  $fieldValues
-     * @param false  $bydb
-     * @param string $timezone
-     * @param array  $date_formats
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($fieldValues = [], $bydb = false, $timezone = '', $date_formats = [])
-    {
-        parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
-        $this->ticket_price_modifiers = new TicketPriceModifiers($this);
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function parent()
-    {
-        return $this->get('TKT_parent');
-    }
-
-
-    /**
-     * return if a ticket has quantities available for purchase
-     *
-     * @param int $DTT_ID the primary key for a particular datetime
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function available($DTT_ID = 0)
-    {
-        // are we checking availability for a particular datetime ?
-        if ($DTT_ID) {
-            // get that datetime object
-            $datetime = $this->get_first_related('Datetime', [['DTT_ID' => $DTT_ID]]);
-            // if  ticket sales for this datetime have exceeded the reg limit...
-            if ($datetime instanceof EE_Datetime && $datetime->sold_out()) {
-                return false;
-            }
-        }
-        // datetime is still open for registration, but is this ticket sold out ?
-        return $this->qty() < 1 || $this->qty() > $this->sold();
-    }
-
-
-    /**
-     * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired
-     *
-     * @param bool        $display   true = we'll return a localized string, otherwise we just return the value of the
-     *                               relevant status const
-     * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save
-     *                               further processing
-     * @return mixed status int if the display string isn't requested
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ticket_status($display = false, $remaining = null)
-    {
-        $remaining = is_bool($remaining) ? $remaining : $this->is_remaining();
-        if (! $remaining) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::sold_out, false, 'sentence') : EE_Ticket::sold_out;
-        }
-        if ($this->get('TKT_deleted')) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::archived, false, 'sentence') : EE_Ticket::archived;
-        }
-        if ($this->is_expired()) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::expired, false, 'sentence') : EE_Ticket::expired;
-        }
-        if ($this->is_pending()) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::pending, false, 'sentence') : EE_Ticket::pending;
-        }
-        if ($this->is_on_sale()) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence') : EE_Ticket::onsale;
-        }
-        return '';
-    }
-
-
-    /**
-     * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale
-     * considering ALL the factors used for figuring that out.
-     *
-     * @param int $DTT_ID if an int above 0 is included here then we get a specific dtt.
-     * @return boolean         true = tickets remaining, false not.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_remaining($DTT_ID = 0)
-    {
-        $num_remaining = $this->remaining($DTT_ID);
-        if ($num_remaining === 0) {
-            return false;
-        }
-        if ($num_remaining > 0 && $num_remaining < $this->min()) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * return the total number of tickets available for purchase
-     *
-     * @param int $DTT_ID  the primary key for a particular datetime.
-     *                     set to 0 for all related datetimes
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remaining($DTT_ID = 0)
-    {
-        return $this->real_quantity_on_ticket('saleable', $DTT_ID);
-    }
-
-
-    /**
-     * Gets min
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function min()
-    {
-        return $this->get('TKT_min');
-    }
-
-
-    /**
-     * return if a ticket is no longer available cause its available dates have expired.
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_expired()
-    {
-        return ($this->get_raw('TKT_end_date') < time());
-    }
-
-
-    /**
-     * Return if a ticket is yet to go on sale or not
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_pending()
-    {
-        return ($this->get_raw('TKT_start_date') >= time());
-    }
-
-
-    /**
-     * Return if a ticket is on sale or not
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_on_sale()
-    {
-        return ($this->get_raw('TKT_start_date') <= time() && $this->get_raw('TKT_end_date') >= time());
-    }
-
-
-    /**
-     * This returns the chronologically last datetime that this ticket is associated with
-     *
-     * @param string $date_format
-     * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with
-     *                            the end date ie: Jan 01 "to" Dec 31
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function date_range($date_format = '', $conjunction = ' - ')
-    {
-        $date_format = ! empty($date_format) ? $date_format : $this->_dt_frmt;
-        $first_date  = $this->first_datetime() instanceof EE_Datetime
-            ? $this->first_datetime()->get_i18n_datetime('DTT_EVT_start', $date_format)
-            : '';
-        $last_date   = $this->last_datetime() instanceof EE_Datetime
-            ? $this->last_datetime()->get_i18n_datetime('DTT_EVT_end', $date_format)
-            : '';
-
-        return $first_date && $last_date ? $first_date . $conjunction . $last_date : '';
-    }
-
-
-    /**
-     * This returns the chronologically first datetime that this ticket is associated with
-     *
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function first_datetime()
-    {
-        $datetimes = $this->datetimes(['limit' => 1]);
-        return reset($datetimes);
-    }
-
-
-    /**
-     * Gets all the datetimes this ticket can be used for attending.
-     * Unless otherwise specified, orders datetimes by start date.
-     *
-     * @param array $query_params
-     * @return EE_Datetime[]|EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function datetimes($query_params = [])
-    {
-        if (! isset($query_params['order_by'])) {
-            $query_params['order_by']['DTT_order'] = 'ASC';
-        }
-        return $this->get_many_related('Datetime', $query_params);
-    }
-
-
-    /**
-     * This returns the chronologically last datetime that this ticket is associated with
-     *
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function last_datetime()
-    {
-        $datetimes = $this->datetimes(['limit' => 1, 'order_by' => ['DTT_EVT_start' => 'DESC']]);
-        return end($datetimes);
-    }
-
-
-    /**
-     * This returns the total tickets sold depending on the given parameters.
-     *
-     * @param string $what    Can be one of two options: 'ticket', 'datetime'.
-     *                        'ticket' = total ticket sales for all datetimes this ticket is related to
-     *                        'datetime' = total ticket sales for a specified datetime (required $dtt_id)
-     *                        'datetime' = total ticket sales in the datetime_ticket table.
-     *                        If $dtt_id is not given then we return an array of sales indexed by datetime.
-     *                        If $dtt_id IS given then we return the tickets sold for that given datetime.
-     * @param int    $dtt_id  [optional] include the dtt_id with $what = 'datetime'.
-     * @return mixed (array|int)          how many tickets have sold
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function tickets_sold($what = 'ticket', $dtt_id = null)
-    {
-        $total        = 0;
-        $tickets_sold = $this->_all_tickets_sold();
-        switch ($what) {
-            case 'ticket':
-                return $tickets_sold['ticket'];
-
-            case 'datetime':
-                if (empty($tickets_sold['datetime'])) {
-                    return $total;
-                }
-                if (! empty($dtt_id) && ! isset($tickets_sold['datetime'][ $dtt_id ])) {
-                    EE_Error::add_error(
-                        esc_html__(
-                            'You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return $total;
-                }
-                return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][ $dtt_id ];
-
-            default:
-                return $total;
-        }
-    }
-
-
-    /**
-     * This returns an array indexed by datetime_id for tickets sold with this ticket.
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _all_tickets_sold()
-    {
-        $datetimes    = $this->get_many_related('Datetime');
-        $tickets_sold = [];
-        if (! empty($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                $tickets_sold['datetime'][ $datetime->ID() ] = $datetime->get('DTT_sold');
-            }
-        }
-        // Tickets sold
-        $tickets_sold['ticket'] = $this->sold();
-        return $tickets_sold;
-    }
-
-
-    /**
-     * This returns the base price object for the ticket.
-     *
-     * @param bool $return_array whether to return as an array indexed by price id or just the object.
-     * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function base_price(bool $return_array = false)
-    {
-        $base_price = $this->ticket_price_modifiers->getBasePrice();
-        if (! empty($base_price)) {
-            return $return_array ? $base_price : reset($base_price);
-        }
-        $_where = ['Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price];
-        return $return_array
-            ? $this->get_many_related('Price', [$_where])
-            : $this->get_first_related('Price', [$_where]);
-    }
-
-
-    /**
-     * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price)
-     *
-     * @return EE_Price[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function price_modifiers(): array
-    {
-        $price_modifiers = $this->usesGlobalTaxes()
-            ? $this->ticket_price_modifiers->getAllDiscountAndSurchargeModifiersForTicket()
-            : $this->ticket_price_modifiers->getAllModifiersForTicket();
-        if (! empty($price_modifiers)) {
-            return $price_modifiers;
-        }
-        return $this->prices(
-            [
-                [
-                    'Price_Type.PBT_ID' => [
-                        'NOT IN',
-                        [EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax],
-                    ],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * This returns ONLY the TAX price modifiers for the ticket
-     *
-     * @return EE_Price[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function tax_price_modifiers(): array
-    {
-        $tax_price_modifiers = $this->ticket_price_modifiers->getAllTaxesForTicket();
-        if (! empty($tax_price_modifiers)) {
-            return $tax_price_modifiers;
-        }
-        return $this->prices([['Price_Type.PBT_ID' => EEM_Price_Type::base_type_tax]]);
-    }
-
-
-    /**
-     * Gets all the prices that combine to form the final price of this ticket
-     *
-     * @param array $query_params
-     * @return EE_Price[]|EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function prices(array $query_params = []): array
-    {
-        if (! isset($query_params['order_by'])) {
-            $query_params['order_by']['PRC_order'] = 'ASC';
-        }
-        return $this->get_many_related('Price', $query_params);
-    }
-
-
-    /**
-     * Gets all the ticket datetimes (ie, relations between datetimes and tickets)
-     *
-     * @param array $query_params
-     * @return EE_Datetime_Ticket|EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function datetime_tickets($query_params = [])
-    {
-        return $this->get_many_related('Datetime_Ticket', $query_params);
-    }
-
-
-    /**
-     * Gets all the datetimes from the db ordered by DTT_order
-     *
-     * @param boolean $show_expired
-     * @param boolean $show_deleted
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function datetimes_ordered($show_expired = true, $show_deleted = false)
-    {
-        return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_ticket_ordered_by_DTT_order(
-            $this->ID(),
-            $show_expired,
-            $show_deleted
-        );
-    }
-
-
-    /**
-     * Gets ID
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ID()
-    {
-        return (int) $this->get('TKT_ID');
-    }
-
-
-    /**
-     * get the author of the ticket.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    public function wp_user()
-    {
-        return $this->get('TKT_wp_user');
-    }
-
-
-    /**
-     * Gets the template for the ticket
-     *
-     * @return EE_Ticket_Template|EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function template()
-    {
-        return $this->get_first_related('Ticket_Template');
-    }
-
-
-    /**
-     * Simply returns an array of EE_Price objects that are taxes.
-     *
-     * @return EE_Price[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_ticket_taxes_for_admin(): array
-    {
-        return $this->usesGlobalTaxes() ? EE_Taxes::get_taxes_for_admin() : $this->tax_price_modifiers();
-    }
-
-
-    /**
-     * alias of taxable() to better indicate that ticket uses the legacy method of applying default "global" taxes
-     * as opposed to having tax price modifiers added directly to each ticket
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function usesGlobalTaxes(): bool
-    {
-        return $this->taxable();
-    }
-
-
-    /**
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ticket_price()
-    {
-        return $this->get('TKT_price');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function pretty_price()
-    {
-        return $this->get_pretty('TKT_price');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_free()
-    {
-        return $this->get_ticket_total_with_taxes() === (float) 0;
-    }
-
-
-    /**
-     * get_ticket_total_with_taxes
-     *
-     * @param bool $no_cache
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_ticket_total_with_taxes(bool $no_cache = false): float
-    {
-        if ($this->_ticket_total_with_taxes === null || $no_cache) {
-            $this->_ticket_total_with_taxes = $this->get_ticket_subtotal();
-            // add taxes
-            if ($this->usesGlobalTaxes()) {
-                $this->_ticket_total_with_taxes += $this->get_ticket_taxes_total_for_admin();
-            } else {
-                $subtotal = $this->_ticket_total_with_taxes;
-                foreach ($this->tax_price_modifiers() as $tax) {
-                    $this->_ticket_total_with_taxes += $subtotal * $tax->amount() / 100;
-                }
-            }
-        }
-        return (float) $this->_ticket_total_with_taxes;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ensure_TKT_Price_correct()
-    {
-        $this->set('TKT_price', EE_Taxes::get_subtotal_for_admin($this));
-        $this->save();
-    }
-
-
-    /**
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_ticket_subtotal()
-    {
-        return EE_Taxes::get_subtotal_for_admin($this);
-    }
-
-
-    /**
-     * Returns the total taxes applied to this ticket
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_ticket_taxes_total_for_admin()
-    {
-        return EE_Taxes::get_total_taxes_for_admin($this);
-    }
-
-
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_name($name)
-    {
-        $this->set('TKT_name', $name);
-    }
-
-
-    /**
-     * Gets description
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function description()
-    {
-        return $this->get('TKT_description');
-    }
-
-
-    /**
-     * Sets description
-     *
-     * @param string $description
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_description($description)
-    {
-        $this->set('TKT_description', $description);
-    }
-
-
-    /**
-     * Gets start_date
-     *
-     * @param string|null $date_format
-     * @param string|null $time_format
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function start_date(?string $date_format = '', ?string $time_format = ''): string
-    {
-        return $this->_get_datetime('TKT_start_date', $date_format, $time_format);
-    }
-
-
-    /**
-     * Sets start_date
-     *
-     * @param string $start_date
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_start_date($start_date)
-    {
-        $this->_set_date_time('B', $start_date, 'TKT_start_date');
-    }
-
-
-    /**
-     * Gets end_date
-     *
-     * @param string|null $date_format
-     * @param string|null $time_format
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function end_date(?string $date_format = '', ?string $time_format = ''): string
-    {
-        return $this->_get_datetime('TKT_end_date', $date_format, $time_format);
-    }
-
-
-    /**
-     * Sets end_date
-     *
-     * @param string $end_date
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_end_date($end_date)
-    {
-        $this->_set_date_time('B', $end_date, 'TKT_end_date');
-    }
-
-
-    /**
-     * Sets sell until time
-     *
-     * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    public function set_end_time($time)
-    {
-        $this->_set_time_for($time, 'TKT_end_date');
-    }
-
-
-    /**
-     * Sets min
-     *
-     * @param int $min
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_min($min)
-    {
-        $this->set('TKT_min', $min);
-    }
-
-
-    /**
-     * Gets max
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function max()
-    {
-        return $this->get('TKT_max');
-    }
-
-
-    /**
-     * Sets max
-     *
-     * @param int $max
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_max($max)
-    {
-        $this->set('TKT_max', $max);
-    }
-
-
-    /**
-     * Sets price
-     *
-     * @param float $price
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_price($price)
-    {
-        $this->set('TKT_price', $price);
-    }
-
-
-    /**
-     * Gets sold
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function sold(): int
-    {
-        return (int) $this->get_raw('TKT_sold');
-    }
-
-
-    /**
-     * Sets sold
-     *
-     * @param int $sold
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_sold($sold)
-    {
-        // sold can not go below zero
-        $sold = max(0, $sold);
-        $this->set('TKT_sold', $sold);
-    }
-
-
-    /**
-     * Increments sold by amount passed by $qty AND decrements the reserved count on both this ticket and its
-     * associated datetimes.
-     *
-     * @param int $qty
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.9.80.p
-     */
-    public function increaseSold($qty = 1)
-    {
-        $qty = absint($qty);
-        // increment sold and decrement reserved datetime quantities simultaneously
-        // don't worry about failures, because they must have already had a spot reserved
-        $this->increaseSoldForDatetimes($qty);
-        // Increment and decrement ticket quantities simultaneously
-        $success = $this->adjustNumericFieldsInDb(
-            [
-                'TKT_reserved' => $qty * -1,
-                'TKT_sold'     => $qty,
-            ]
-        );
-        do_action(
-            'AHEE__EE_Ticket__increase_sold',
-            $this,
-            $qty,
-            $this->sold(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * On each datetime related to this ticket, increases its sold count and decreases its reserved count by $qty.
-     *
-     * @param int           $qty positive or negative. Positive means to increase sold counts (and decrease reserved
-     *                           counts), Negative means to decreases old counts (and increase reserved counts).
-     * @param EE_Datetime[] $datetimes
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.9.80.p
-     */
-    protected function increaseSoldForDatetimes($qty, array $datetimes = [])
-    {
-        $datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            $datetime->increaseSold($qty);
-        }
-    }
-
-
-    /**
-     * Decrements (subtracts) sold by amount passed by $qty on both the ticket and its related datetimes directly in the
-     * DB and then updates the model objects.
-     * Does not affect the reserved counts.
-     *
-     * @param int $qty
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.9.80.p
-     */
-    public function decreaseSold($qty = 1)
-    {
-        $qty = absint($qty);
-        $this->decreaseSoldForDatetimes($qty);
-        $success = $this->adjustNumericFieldsInDb(
-            [
-                'TKT_sold' => $qty * -1,
-            ]
-        );
-        do_action(
-            'AHEE__EE_Ticket__decrease_sold',
-            $this,
-            $qty,
-            $this->sold(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * Decreases sold on related datetimes
-     *
-     * @param int           $qty
-     * @param EE_Datetime[] $datetimes
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.9.80.p
-     */
-    protected function decreaseSoldForDatetimes($qty = 1, array $datetimes = [])
-    {
-        $datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
-        if (is_array($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    $datetime->decreaseSold($qty);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Gets qty of reserved tickets
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function reserved(): int
-    {
-        return (int) $this->get_raw('TKT_reserved');
-    }
-
-
-    /**
-     * Sets reserved
-     *
-     * @param int $reserved
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_reserved($reserved)
-    {
-        // reserved can not go below zero
-        $reserved = max(0, (int) $reserved);
-        $this->set('TKT_reserved', $reserved);
-    }
-
-
-    /**
-     * Increments reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @param int    $qty
-     * @param string $source
-     * @return bool whether we successfully reserved the ticket or not.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.9.80.p
-     */
-    public function increaseReserved($qty = 1, $source = 'unknown')
-    {
-        $qty = absint($qty);
-        do_action(
-            'AHEE__EE_Ticket__increase_reserved__begin',
-            $this,
-            $qty,
-            $source
-        );
-        // comment out extra meta tracking
-        // $this->add_extra_meta(EE_Ticket::META_KEY_TICKET_RESERVATIONS, "{$qty} from {$source}");
-        $success                         = false;
-        $datetimes_adjusted_successfully = $this->increaseReservedForDatetimes($qty);
-        if ($datetimes_adjusted_successfully) {
-            $success = $this->incrementFieldConditionallyInDb(
-                'TKT_reserved',
-                'TKT_sold',
-                'TKT_qty',
-                $qty
-            );
-            if (! $success) {
-                // The datetimes were successfully bumped, but not the
-                // ticket. So we need to manually roll back the datetimes.
-                $this->decreaseReservedForDatetimes($qty);
-            }
-        }
-        do_action(
-            'AHEE__EE_Ticket__increase_reserved',
-            $this,
-            $qty,
-            $this->reserved(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * Increases reserved counts on related datetimes
-     *
-     * @param int           $qty
-     * @param EE_Datetime[] $datetimes
-     * @return boolean indicating success
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.9.80.p
-     */
-    protected function increaseReservedForDatetimes($qty = 1, array $datetimes = [])
-    {
-        $datetimes         = ! empty($datetimes) ? $datetimes : $this->datetimes();
-        $datetimes_updated = [];
-        $limit_exceeded    = false;
-        if (is_array($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    if ($datetime->increaseReserved($qty)) {
-                        $datetimes_updated[] = $datetime;
-                    } else {
-                        $limit_exceeded = true;
-                        break;
-                    }
-                }
-            }
-            // If somewhere along the way we detected a datetime whose
-            // limit was exceeded, do a manual rollback.
-            if ($limit_exceeded) {
-                $this->decreaseReservedForDatetimes($qty, $datetimes_updated);
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @param int    $qty
-     * @param bool   $adjust_datetimes
-     * @param string $source
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.9.80.p
-     */
-    public function decreaseReserved($qty = 1, $adjust_datetimes = true, $source = 'unknown')
-    {
-        $qty = absint($qty);
-        // comment out extra meta tracking
-        // $this->add_extra_meta(EE_Ticket::META_KEY_TICKET_RESERVATIONS, "-{$qty} from {$source}");
-        if ($adjust_datetimes) {
-            $this->decreaseReservedForDatetimes($qty);
-        }
-        $success = $this->adjustNumericFieldsInDb(
-            [
-                'TKT_reserved' => $qty * -1,
-            ]
-        );
-        do_action(
-            'AHEE__EE_Ticket__decrease_reserved',
-            $this,
-            $qty,
-            $this->reserved(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * Decreases the reserved count on the specified datetimes.
-     *
-     * @param int           $qty
-     * @param EE_Datetime[] $datetimes
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.9.80.p
-     */
-    protected function decreaseReservedForDatetimes($qty = 1, array $datetimes = [])
-    {
-        $datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $datetime->decreaseReserved($qty);
-            }
-        }
-    }
-
-
-    /**
-     * Gets ticket quantity
-     *
-     * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
-     *                            therefore $context can be one of three values: '', 'reg_limit', or 'saleable'
-     *                            '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects
-     *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
-     *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
-     *                            is therefore the truest measure of tickets that can be purchased at the moment
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function qty($context = '')
-    {
-        switch ($context) {
-            case 'reg_limit':
-                return $this->real_quantity_on_ticket();
-            case 'saleable':
-                return $this->real_quantity_on_ticket('saleable');
-            default:
-                return $this->get_raw('TKT_qty');
-        }
-    }
-
-
-    /**
-     * Gets ticket quantity
-     *
-     * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
-     *                            therefore $context can be one of two values: 'reg_limit', or 'saleable'
-     *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
-     *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
-     *                            is therefore the truest measure of tickets that can be purchased at the moment
-     * @param int    $DTT_ID      the primary key for a particular datetime.
-     *                            set to 0 for all related datetimes
-     * @return int|float          int for finite quantity or float for INF
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function real_quantity_on_ticket($context = 'reg_limit', $DTT_ID = 0)
-    {
-        $raw = $this->get_raw('TKT_qty');
-        // return immediately if it's zero
-        if ($raw === 0) {
-            return $raw;
-        }
-        // echo "\n\n<br />Ticket: " . $this->name() . '<br />';
-        // ensure qty doesn't exceed raw value for THIS ticket
-        $qty = min(EE_INF, $raw);
-        // echo "\n . qty: " . $qty . '<br />';
-        // calculate this ticket's total sales and reservations
-        $sold_and_reserved_for_this_ticket = $this->sold() + $this->reserved();
-        // echo "\n . sold: " . $this->sold() . '<br />';
-        // echo "\n . reserved: " . $this->reserved() . '<br />';
-        // echo "\n . sold_and_reserved_for_this_ticket: " . $sold_and_reserved_for_this_ticket . '<br />';
-        // first we need to calculate the maximum number of tickets available for the datetime
-        // do we want data for one datetime or all of them ?
-        $query_params = $DTT_ID ? [['DTT_ID' => $DTT_ID]] : [];
-        $datetimes    = $this->get_many_related('Datetime', $query_params);
-        if (is_array($datetimes) && ! empty($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    // $datetime->refresh_from_db();
-                    // echo "\n . . datetime name: " . $datetime->name() . '<br />';
-                    // echo "\n . . datetime ID: " . $datetime->ID() . '<br />';
-                    // initialize with no restrictions for each datetime
-                    // but adjust datetime qty based on datetime reg limit
-                    $datetime_qty = min(EE_INF, $datetime->reg_limit());
-                    // echo "\n . . . datetime reg_limit: " . $datetime->reg_limit() . '<br />';
-                    // echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
-                    // if we want the actual saleable amount, then we need to consider OTHER ticket sales
-                    // and reservations for this datetime, that do NOT include sales and reservations
-                    // for this ticket (so we add $this->sold() and $this->reserved() back in)
-                    if ($context === 'saleable') {
-                        $datetime_qty = max(
-                            $datetime_qty - $datetime->sold_and_reserved() + $sold_and_reserved_for_this_ticket,
-                            0
-                        );
-                        // echo "\n . . . datetime sold: " . $datetime->sold() . '<br />';
-                        // echo "\n . . . datetime reserved: " . $datetime->reserved() . '<br />';
-                        // echo "\n . . . datetime sold_and_reserved: " . $datetime->sold_and_reserved() . '<br />';
-                        // echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
-                        $datetime_qty = ! $datetime->sold_out() ? $datetime_qty : 0;
-                        // echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
-                    }
-                    $qty = min($datetime_qty, $qty);
-                    // echo "\n . . qty: " . $qty . '<br />';
-                }
-            }
-        }
-        // NOW that we know the  maximum number of tickets available for the datetime
-        // we can finally factor in the details for this specific ticket
-        if ($qty > 0 && $context === 'saleable') {
-            // and subtract the sales for THIS ticket
-            $qty = max($qty - $sold_and_reserved_for_this_ticket, 0);
-            // echo "\n . qty: " . $qty . '<br />';
-        }
-        // echo "\nFINAL QTY: " . $qty . "<br /><br />";
-        return $qty;
-    }
-
-
-    /**
-     * Sets qty - IMPORTANT!!! Does NOT allow QTY to be set higher than the lowest reg limit of any related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_qty($qty)
-    {
-        $datetimes = $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $qty = min($qty, $datetime->reg_limit());
-            }
-        }
-        $this->set('TKT_qty', $qty);
-    }
-
-
-    /**
-     * Gets uses
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function uses()
-    {
-        return $this->get('TKT_uses');
-    }
-
-
-    /**
-     * Sets uses
-     *
-     * @param int $uses
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_uses($uses)
-    {
-        $this->set('TKT_uses', $uses);
-    }
-
-
-    /**
-     * returns whether ticket is required or not.
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function required()
-    {
-        return $this->get('TKT_required');
-    }
-
-
-    /**
-     * sets the TKT_required property
-     *
-     * @param boolean $required
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_required($required)
-    {
-        $this->set('TKT_required', $required);
-    }
-
-
-    /**
-     * Gets taxable
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function taxable()
-    {
-        return $this->get('TKT_taxable');
-    }
-
-
-    /**
-     * Sets taxable
-     *
-     * @param boolean $taxable
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_taxable($taxable)
-    {
-        $this->set('TKT_taxable', $taxable);
-    }
-
-
-    /**
-     * Gets is_default
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_default()
-    {
-        return $this->get('TKT_is_default');
-    }
-
-
-    /**
-     * Sets is_default
-     *
-     * @param boolean $is_default
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_is_default($is_default)
-    {
-        $this->set('TKT_is_default', $is_default);
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function order()
-    {
-        return $this->get('TKT_order');
-    }
-
-
-    /**
-     * Sets order
-     *
-     * @param int $order
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_order($order)
-    {
-        $this->set('TKT_order', $order);
-    }
-
-
-    /**
-     * Gets row
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function row()
-    {
-        return $this->get('TKT_row');
-    }
-
-
-    /**
-     * Sets row
-     *
-     * @param int $row
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_row($row)
-    {
-        $this->set('TKT_row', $row);
-    }
-
-
-    /**
-     * Gets deleted
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function deleted()
-    {
-        return $this->get('TKT_deleted');
-    }
-
-
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_deleted($deleted)
-    {
-        $this->set('TKT_deleted', $deleted);
-    }
-
-
-    /**
-     * Gets parent
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function parent_ID()
-    {
-        return $this->get('TKT_parent');
-    }
-
-
-    /**
-     * Sets parent
-     *
-     * @param int $parent
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_parent_ID($parent)
-    {
-        $this->set('TKT_parent', $parent);
-    }
-
-
-    /**
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reverse_calculate()
-    {
-        return $this->get('TKT_reverse_calculate');
-    }
-
-
-    /**
-     * @param boolean $reverse_calculate
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reverse_calculate($reverse_calculate)
-    {
-        $this->set('TKT_reverse_calculate', $reverse_calculate);
-    }
-
-
-    /**
-     * Gets a string which is handy for showing in gateways etc that describes the ticket.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function name_and_info()
-    {
-        $times = [];
-        foreach ($this->datetimes() as $datetime) {
-            $times[] = $datetime->start_date_and_time();
-        }
-        /* translators: %1$s ticket name, %2$s start datetimes separated by comma, %3$s ticket price */
-        return sprintf(
-            esc_html__('%1$s @ %2$s for %3$s', 'event_espresso'),
-            $this->name(),
-            implode(', ', $times),
-            $this->pretty_price()
-        );
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function name()
-    {
-        return $this->get('TKT_name');
-    }
-
-
-    /**
-     * Gets price
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function price()
-    {
-        return $this->get('TKT_price');
-    }
-
-
-    /**
-     * Gets all the registrations for this ticket
-     *
-     * @param array $query_params
-     * @return EE_Registration[]|EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function registrations($query_params = [])
-    {
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_tickets_sold()
-    {
-        $count_regs_for_this_ticket = $this->count_registrations(
-            [
-                [
-                    'STS_ID'      => RegStatus::APPROVED,
-                    'REG_deleted' => 0,
-                ],
-            ]
-        );
-        $this->set_sold($count_regs_for_this_ticket);
-        $this->save();
-        return $count_regs_for_this_ticket;
-    }
-
-
-    /**
-     * Counts the registrations for this ticket
-     *
-     * @param array $query_params
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function count_registrations($query_params = [])
-    {
-        return $this->count_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Implementation for EEI_Has_Icon interface method.
-     *
-     * @return string
-     * @see EEI_Visual_Representation for comments
-     */
-    public function get_icon()
-    {
-        return '<span class="dashicons dashicons-tickets-alt"></span>';
-    }
-
-
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @return EE_Event
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     * @throws ReflectionException
-     * @see EEI_Event_Relation for comments
-     */
-    public function get_related_event()
-    {
-        // get one datetime to use for getting the event
-        $datetime = $this->first_datetime();
-        if (! $datetime instanceof EE_Datetime) {
-            throw new UnexpectedEntityException(
-                $datetime,
-                'EE_Datetime',
-                sprintf(
-                    esc_html__('The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
-                    $this->name()
-                )
-            );
-        }
-        $event = $datetime->event();
-        if (! $event instanceof EE_Event) {
-            throw new UnexpectedEntityException(
-                $event,
-                'EE_Event',
-                sprintf(
-                    esc_html__('The ticket (%s) is not associated with a valid event.', 'event_espresso'),
-                    $this->name()
-                )
-            );
-        }
-        return $event;
-    }
-
-
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @return string
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see EEI_Event_Relation for comments
-     */
-    public function get_event_name()
-    {
-        $event = $this->get_related_event();
-        return $event instanceof EE_Event ? $event->name() : '';
-    }
-
-
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see EEI_Event_Relation for comments
-     */
-    public function get_event_ID()
-    {
-        $event = $this->get_related_event();
-        return $event instanceof EE_Event ? $event->ID() : 0;
-    }
-
-
-    /**
-     * This simply returns whether a ticket can be permanently deleted or not.
-     * The criteria for determining this is whether the ticket has any related registrations.
-     * If there are none then it can be permanently deleted.
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_permanently_deleteable()
-    {
-        return $this->count_registrations() === 0;
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function visibility(): int
-    {
-        return $this->get('TKT_visibility');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function isHidden(): bool
-    {
-        return $this->visibility() === EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function isNotHidden(): bool
-    {
-        return $this->visibility() > EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function isPublicOnly(): bool
-    {
-        return $this->isNotHidden() && $this->visibility() <= EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function isMembersOnly(): bool
-    {
-        return $this->visibility() > EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE
-               && $this->visibility() <= EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_VALUE;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function isAdminsOnly(): bool
-    {
-        return $this->visibility() > EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_VALUE
-               && $this->visibility() <= EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_VALUE;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function isAdminUiOnly(): bool
-    {
-        return $this->visibility() > EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_VALUE
-               && $this->visibility() <= EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE;
-    }
-
-
-    /**
-     * @param int $visibility
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function set_visibility(int $visibility)
-    {
-        $ticket_visibility_options = $this->_model->ticketVisibilityOptions();
-        $ticket_visibility         = -1;
-        foreach ($ticket_visibility_options as $ticket_visibility_option) {
-            if ($visibility === $ticket_visibility_option) {
-                $ticket_visibility = $visibility;
-            }
-        }
-        if ($ticket_visibility === -1) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The supplied ticket visibility setting of "%1$s" is not valid. It needs to match one of the keys in the following array:%2$s %3$s ',
-                        'event_espresso'
-                    ),
-                    $visibility,
-                    '<br />',
-                    var_export($ticket_visibility_options, true)
-                )
-            );
-        }
-        $this->set('TKT_visibility', $ticket_visibility);
-    }
-
-
-    /**
-     * @param EE_Base_Class|int|string $otherObjectModelObjectOrID
-     * @param string                   $relationName
-     * @param array                    $extra_join_model_fields_n_values
-     * @param string|null              $cache_id
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function _add_relation_to(
-        $otherObjectModelObjectOrID,
-        $relationName,
-        $extra_join_model_fields_n_values = [],
-        $cache_id = null
-    ) {
-        if ($relationName === 'Datetime' && ! $this->hasRelation($otherObjectModelObjectOrID, $relationName)) {
-            /** @var EE_Datetime $datetime */
-            $datetime = EEM_Datetime::instance()->ensure_is_obj($otherObjectModelObjectOrID);
-            $datetime->increaseSold($this->sold(), false);
-            $datetime->increaseReserved($this->reserved());
-            $datetime->save();
-            $otherObjectModelObjectOrID = $datetime;
-        }
-        return parent::_add_relation_to(
-            $otherObjectModelObjectOrID,
-            $relationName,
-            $extra_join_model_fields_n_values,
-            $cache_id
-        );
-    }
-
-
-    /**
-     * @param EE_Base_Class|int|string $otherObjectModelObjectOrID
-     * @param string                   $relationName
-     * @param array                    $where_query
-     * @return bool|EE_Base_Class|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = [])
-    {
-        // if we're adding a new relation to a datetime
-        if ($relationName === 'Datetime' && $this->hasRelation($otherObjectModelObjectOrID, $relationName)) {
-            /** @var EE_Datetime $datetime */
-            $datetime = EEM_Datetime::instance()->ensure_is_obj($otherObjectModelObjectOrID);
-            $datetime->decreaseSold($this->sold());
-            $datetime->decreaseReserved($this->reserved());
-            $datetime->save();
-            $otherObjectModelObjectOrID = $datetime;
-        }
-        return parent::_remove_relation_to(
-            $otherObjectModelObjectOrID,
-            $relationName,
-            $where_query
-        );
-    }
-
-
-    /**
-     * Removes ALL the related things for the $relationName.
-     *
-     * @param string $relationName
-     * @param array  $where_query_params
-     * @return EE_Base_Class
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    public function _remove_relations($relationName, $where_query_params = [])
-    {
-        if ($relationName === 'Datetime') {
-            $datetimes = $this->datetimes();
-            foreach ($datetimes as $datetime) {
-                $datetime->decreaseSold($this->sold());
-                $datetime->decreaseReserved($this->reserved());
-                $datetime->save();
-            }
-        }
-        return parent::_remove_relations($relationName, $where_query_params);
-    }
-
-
-    /*******************************************************************
+	/**
+	 * TicKet Archived:
+	 * constant used by ticket_status() to indicate that a ticket is archived
+	 * and no longer available for purchase
+	 */
+	const archived = 'TKA';
+
+	/**
+	 * TicKet Expired:
+	 * constant used by ticket_status() to indicate that a ticket is expired
+	 * and no longer available for purchase
+	 */
+	const expired = 'TKE';
+
+	/**
+	 * TicKet On sale:
+	 * constant used by ticket_status() to indicate that a ticket is On Sale
+	 * and IS available for purchase
+	 */
+	const onsale = 'TKO';
+
+	/**
+	 * TicKet Pending:
+	 * constant used by ticket_status() to indicate that a ticket is pending
+	 * and is NOT YET available for purchase
+	 */
+	const pending = 'TKP';
+
+	/**
+	 * TicKet Sold out:
+	 * constant used by ticket_status() to indicate that a ticket is sold out
+	 * and no longer available for purchases
+	 */
+	const sold_out = 'TKS';
+
+	/**
+	 * extra meta key for tracking ticket reservations
+	 *
+	 * @type string
+	 */
+	const META_KEY_TICKET_RESERVATIONS = 'ticket_reservations';
+
+	/**
+	 * override of parent property
+	 *
+	 * @var EEM_Ticket
+	 */
+	protected $_model;
+
+	/**
+	 * cached result from method of the same name
+	 *
+	 * @var float $_ticket_total_with_taxes
+	 */
+	private $_ticket_total_with_taxes;
+
+	/**
+	 * @var TicketPriceModifiers
+	 */
+	protected $ticket_price_modifiers;
+
+
+	/**
+	 * @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_Ticket
+	 * @throws EE_Error
+	 * @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_Ticket
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @param array  $fieldValues
+	 * @param false  $bydb
+	 * @param string $timezone
+	 * @param array  $date_formats
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($fieldValues = [], $bydb = false, $timezone = '', $date_formats = [])
+	{
+		parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
+		$this->ticket_price_modifiers = new TicketPriceModifiers($this);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function parent()
+	{
+		return $this->get('TKT_parent');
+	}
+
+
+	/**
+	 * return if a ticket has quantities available for purchase
+	 *
+	 * @param int $DTT_ID the primary key for a particular datetime
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function available($DTT_ID = 0)
+	{
+		// are we checking availability for a particular datetime ?
+		if ($DTT_ID) {
+			// get that datetime object
+			$datetime = $this->get_first_related('Datetime', [['DTT_ID' => $DTT_ID]]);
+			// if  ticket sales for this datetime have exceeded the reg limit...
+			if ($datetime instanceof EE_Datetime && $datetime->sold_out()) {
+				return false;
+			}
+		}
+		// datetime is still open for registration, but is this ticket sold out ?
+		return $this->qty() < 1 || $this->qty() > $this->sold();
+	}
+
+
+	/**
+	 * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired
+	 *
+	 * @param bool        $display   true = we'll return a localized string, otherwise we just return the value of the
+	 *                               relevant status const
+	 * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save
+	 *                               further processing
+	 * @return mixed status int if the display string isn't requested
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ticket_status($display = false, $remaining = null)
+	{
+		$remaining = is_bool($remaining) ? $remaining : $this->is_remaining();
+		if (! $remaining) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::sold_out, false, 'sentence') : EE_Ticket::sold_out;
+		}
+		if ($this->get('TKT_deleted')) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::archived, false, 'sentence') : EE_Ticket::archived;
+		}
+		if ($this->is_expired()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::expired, false, 'sentence') : EE_Ticket::expired;
+		}
+		if ($this->is_pending()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::pending, false, 'sentence') : EE_Ticket::pending;
+		}
+		if ($this->is_on_sale()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence') : EE_Ticket::onsale;
+		}
+		return '';
+	}
+
+
+	/**
+	 * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale
+	 * considering ALL the factors used for figuring that out.
+	 *
+	 * @param int $DTT_ID if an int above 0 is included here then we get a specific dtt.
+	 * @return boolean         true = tickets remaining, false not.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_remaining($DTT_ID = 0)
+	{
+		$num_remaining = $this->remaining($DTT_ID);
+		if ($num_remaining === 0) {
+			return false;
+		}
+		if ($num_remaining > 0 && $num_remaining < $this->min()) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * return the total number of tickets available for purchase
+	 *
+	 * @param int $DTT_ID  the primary key for a particular datetime.
+	 *                     set to 0 for all related datetimes
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remaining($DTT_ID = 0)
+	{
+		return $this->real_quantity_on_ticket('saleable', $DTT_ID);
+	}
+
+
+	/**
+	 * Gets min
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function min()
+	{
+		return $this->get('TKT_min');
+	}
+
+
+	/**
+	 * return if a ticket is no longer available cause its available dates have expired.
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_expired()
+	{
+		return ($this->get_raw('TKT_end_date') < time());
+	}
+
+
+	/**
+	 * Return if a ticket is yet to go on sale or not
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_pending()
+	{
+		return ($this->get_raw('TKT_start_date') >= time());
+	}
+
+
+	/**
+	 * Return if a ticket is on sale or not
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_on_sale()
+	{
+		return ($this->get_raw('TKT_start_date') <= time() && $this->get_raw('TKT_end_date') >= time());
+	}
+
+
+	/**
+	 * This returns the chronologically last datetime that this ticket is associated with
+	 *
+	 * @param string $date_format
+	 * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with
+	 *                            the end date ie: Jan 01 "to" Dec 31
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function date_range($date_format = '', $conjunction = ' - ')
+	{
+		$date_format = ! empty($date_format) ? $date_format : $this->_dt_frmt;
+		$first_date  = $this->first_datetime() instanceof EE_Datetime
+			? $this->first_datetime()->get_i18n_datetime('DTT_EVT_start', $date_format)
+			: '';
+		$last_date   = $this->last_datetime() instanceof EE_Datetime
+			? $this->last_datetime()->get_i18n_datetime('DTT_EVT_end', $date_format)
+			: '';
+
+		return $first_date && $last_date ? $first_date . $conjunction . $last_date : '';
+	}
+
+
+	/**
+	 * This returns the chronologically first datetime that this ticket is associated with
+	 *
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function first_datetime()
+	{
+		$datetimes = $this->datetimes(['limit' => 1]);
+		return reset($datetimes);
+	}
+
+
+	/**
+	 * Gets all the datetimes this ticket can be used for attending.
+	 * Unless otherwise specified, orders datetimes by start date.
+	 *
+	 * @param array $query_params
+	 * @return EE_Datetime[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function datetimes($query_params = [])
+	{
+		if (! isset($query_params['order_by'])) {
+			$query_params['order_by']['DTT_order'] = 'ASC';
+		}
+		return $this->get_many_related('Datetime', $query_params);
+	}
+
+
+	/**
+	 * This returns the chronologically last datetime that this ticket is associated with
+	 *
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function last_datetime()
+	{
+		$datetimes = $this->datetimes(['limit' => 1, 'order_by' => ['DTT_EVT_start' => 'DESC']]);
+		return end($datetimes);
+	}
+
+
+	/**
+	 * This returns the total tickets sold depending on the given parameters.
+	 *
+	 * @param string $what    Can be one of two options: 'ticket', 'datetime'.
+	 *                        'ticket' = total ticket sales for all datetimes this ticket is related to
+	 *                        'datetime' = total ticket sales for a specified datetime (required $dtt_id)
+	 *                        'datetime' = total ticket sales in the datetime_ticket table.
+	 *                        If $dtt_id is not given then we return an array of sales indexed by datetime.
+	 *                        If $dtt_id IS given then we return the tickets sold for that given datetime.
+	 * @param int    $dtt_id  [optional] include the dtt_id with $what = 'datetime'.
+	 * @return mixed (array|int)          how many tickets have sold
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function tickets_sold($what = 'ticket', $dtt_id = null)
+	{
+		$total        = 0;
+		$tickets_sold = $this->_all_tickets_sold();
+		switch ($what) {
+			case 'ticket':
+				return $tickets_sold['ticket'];
+
+			case 'datetime':
+				if (empty($tickets_sold['datetime'])) {
+					return $total;
+				}
+				if (! empty($dtt_id) && ! isset($tickets_sold['datetime'][ $dtt_id ])) {
+					EE_Error::add_error(
+						esc_html__(
+							'You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return $total;
+				}
+				return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][ $dtt_id ];
+
+			default:
+				return $total;
+		}
+	}
+
+
+	/**
+	 * This returns an array indexed by datetime_id for tickets sold with this ticket.
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _all_tickets_sold()
+	{
+		$datetimes    = $this->get_many_related('Datetime');
+		$tickets_sold = [];
+		if (! empty($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				$tickets_sold['datetime'][ $datetime->ID() ] = $datetime->get('DTT_sold');
+			}
+		}
+		// Tickets sold
+		$tickets_sold['ticket'] = $this->sold();
+		return $tickets_sold;
+	}
+
+
+	/**
+	 * This returns the base price object for the ticket.
+	 *
+	 * @param bool $return_array whether to return as an array indexed by price id or just the object.
+	 * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function base_price(bool $return_array = false)
+	{
+		$base_price = $this->ticket_price_modifiers->getBasePrice();
+		if (! empty($base_price)) {
+			return $return_array ? $base_price : reset($base_price);
+		}
+		$_where = ['Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price];
+		return $return_array
+			? $this->get_many_related('Price', [$_where])
+			: $this->get_first_related('Price', [$_where]);
+	}
+
+
+	/**
+	 * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price)
+	 *
+	 * @return EE_Price[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function price_modifiers(): array
+	{
+		$price_modifiers = $this->usesGlobalTaxes()
+			? $this->ticket_price_modifiers->getAllDiscountAndSurchargeModifiersForTicket()
+			: $this->ticket_price_modifiers->getAllModifiersForTicket();
+		if (! empty($price_modifiers)) {
+			return $price_modifiers;
+		}
+		return $this->prices(
+			[
+				[
+					'Price_Type.PBT_ID' => [
+						'NOT IN',
+						[EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax],
+					],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * This returns ONLY the TAX price modifiers for the ticket
+	 *
+	 * @return EE_Price[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function tax_price_modifiers(): array
+	{
+		$tax_price_modifiers = $this->ticket_price_modifiers->getAllTaxesForTicket();
+		if (! empty($tax_price_modifiers)) {
+			return $tax_price_modifiers;
+		}
+		return $this->prices([['Price_Type.PBT_ID' => EEM_Price_Type::base_type_tax]]);
+	}
+
+
+	/**
+	 * Gets all the prices that combine to form the final price of this ticket
+	 *
+	 * @param array $query_params
+	 * @return EE_Price[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function prices(array $query_params = []): array
+	{
+		if (! isset($query_params['order_by'])) {
+			$query_params['order_by']['PRC_order'] = 'ASC';
+		}
+		return $this->get_many_related('Price', $query_params);
+	}
+
+
+	/**
+	 * Gets all the ticket datetimes (ie, relations between datetimes and tickets)
+	 *
+	 * @param array $query_params
+	 * @return EE_Datetime_Ticket|EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function datetime_tickets($query_params = [])
+	{
+		return $this->get_many_related('Datetime_Ticket', $query_params);
+	}
+
+
+	/**
+	 * Gets all the datetimes from the db ordered by DTT_order
+	 *
+	 * @param boolean $show_expired
+	 * @param boolean $show_deleted
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function datetimes_ordered($show_expired = true, $show_deleted = false)
+	{
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_ticket_ordered_by_DTT_order(
+			$this->ID(),
+			$show_expired,
+			$show_deleted
+		);
+	}
+
+
+	/**
+	 * Gets ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ID()
+	{
+		return (int) $this->get('TKT_ID');
+	}
+
+
+	/**
+	 * get the author of the ticket.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	public function wp_user()
+	{
+		return $this->get('TKT_wp_user');
+	}
+
+
+	/**
+	 * Gets the template for the ticket
+	 *
+	 * @return EE_Ticket_Template|EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function template()
+	{
+		return $this->get_first_related('Ticket_Template');
+	}
+
+
+	/**
+	 * Simply returns an array of EE_Price objects that are taxes.
+	 *
+	 * @return EE_Price[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_taxes_for_admin(): array
+	{
+		return $this->usesGlobalTaxes() ? EE_Taxes::get_taxes_for_admin() : $this->tax_price_modifiers();
+	}
+
+
+	/**
+	 * alias of taxable() to better indicate that ticket uses the legacy method of applying default "global" taxes
+	 * as opposed to having tax price modifiers added directly to each ticket
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function usesGlobalTaxes(): bool
+	{
+		return $this->taxable();
+	}
+
+
+	/**
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ticket_price()
+	{
+		return $this->get('TKT_price');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function pretty_price()
+	{
+		return $this->get_pretty('TKT_price');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_free()
+	{
+		return $this->get_ticket_total_with_taxes() === (float) 0;
+	}
+
+
+	/**
+	 * get_ticket_total_with_taxes
+	 *
+	 * @param bool $no_cache
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_total_with_taxes(bool $no_cache = false): float
+	{
+		if ($this->_ticket_total_with_taxes === null || $no_cache) {
+			$this->_ticket_total_with_taxes = $this->get_ticket_subtotal();
+			// add taxes
+			if ($this->usesGlobalTaxes()) {
+				$this->_ticket_total_with_taxes += $this->get_ticket_taxes_total_for_admin();
+			} else {
+				$subtotal = $this->_ticket_total_with_taxes;
+				foreach ($this->tax_price_modifiers() as $tax) {
+					$this->_ticket_total_with_taxes += $subtotal * $tax->amount() / 100;
+				}
+			}
+		}
+		return (float) $this->_ticket_total_with_taxes;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ensure_TKT_Price_correct()
+	{
+		$this->set('TKT_price', EE_Taxes::get_subtotal_for_admin($this));
+		$this->save();
+	}
+
+
+	/**
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_subtotal()
+	{
+		return EE_Taxes::get_subtotal_for_admin($this);
+	}
+
+
+	/**
+	 * Returns the total taxes applied to this ticket
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_taxes_total_for_admin()
+	{
+		return EE_Taxes::get_total_taxes_for_admin($this);
+	}
+
+
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_name($name)
+	{
+		$this->set('TKT_name', $name);
+	}
+
+
+	/**
+	 * Gets description
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function description()
+	{
+		return $this->get('TKT_description');
+	}
+
+
+	/**
+	 * Sets description
+	 *
+	 * @param string $description
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_description($description)
+	{
+		$this->set('TKT_description', $description);
+	}
+
+
+	/**
+	 * Gets start_date
+	 *
+	 * @param string|null $date_format
+	 * @param string|null $time_format
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function start_date(?string $date_format = '', ?string $time_format = ''): string
+	{
+		return $this->_get_datetime('TKT_start_date', $date_format, $time_format);
+	}
+
+
+	/**
+	 * Sets start_date
+	 *
+	 * @param string $start_date
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_start_date($start_date)
+	{
+		$this->_set_date_time('B', $start_date, 'TKT_start_date');
+	}
+
+
+	/**
+	 * Gets end_date
+	 *
+	 * @param string|null $date_format
+	 * @param string|null $time_format
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function end_date(?string $date_format = '', ?string $time_format = ''): string
+	{
+		return $this->_get_datetime('TKT_end_date', $date_format, $time_format);
+	}
+
+
+	/**
+	 * Sets end_date
+	 *
+	 * @param string $end_date
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_end_date($end_date)
+	{
+		$this->_set_date_time('B', $end_date, 'TKT_end_date');
+	}
+
+
+	/**
+	 * Sets sell until time
+	 *
+	 * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	public function set_end_time($time)
+	{
+		$this->_set_time_for($time, 'TKT_end_date');
+	}
+
+
+	/**
+	 * Sets min
+	 *
+	 * @param int $min
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_min($min)
+	{
+		$this->set('TKT_min', $min);
+	}
+
+
+	/**
+	 * Gets max
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function max()
+	{
+		return $this->get('TKT_max');
+	}
+
+
+	/**
+	 * Sets max
+	 *
+	 * @param int $max
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_max($max)
+	{
+		$this->set('TKT_max', $max);
+	}
+
+
+	/**
+	 * Sets price
+	 *
+	 * @param float $price
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_price($price)
+	{
+		$this->set('TKT_price', $price);
+	}
+
+
+	/**
+	 * Gets sold
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function sold(): int
+	{
+		return (int) $this->get_raw('TKT_sold');
+	}
+
+
+	/**
+	 * Sets sold
+	 *
+	 * @param int $sold
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_sold($sold)
+	{
+		// sold can not go below zero
+		$sold = max(0, $sold);
+		$this->set('TKT_sold', $sold);
+	}
+
+
+	/**
+	 * Increments sold by amount passed by $qty AND decrements the reserved count on both this ticket and its
+	 * associated datetimes.
+	 *
+	 * @param int $qty
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.9.80.p
+	 */
+	public function increaseSold($qty = 1)
+	{
+		$qty = absint($qty);
+		// increment sold and decrement reserved datetime quantities simultaneously
+		// don't worry about failures, because they must have already had a spot reserved
+		$this->increaseSoldForDatetimes($qty);
+		// Increment and decrement ticket quantities simultaneously
+		$success = $this->adjustNumericFieldsInDb(
+			[
+				'TKT_reserved' => $qty * -1,
+				'TKT_sold'     => $qty,
+			]
+		);
+		do_action(
+			'AHEE__EE_Ticket__increase_sold',
+			$this,
+			$qty,
+			$this->sold(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * On each datetime related to this ticket, increases its sold count and decreases its reserved count by $qty.
+	 *
+	 * @param int           $qty positive or negative. Positive means to increase sold counts (and decrease reserved
+	 *                           counts), Negative means to decreases old counts (and increase reserved counts).
+	 * @param EE_Datetime[] $datetimes
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.9.80.p
+	 */
+	protected function increaseSoldForDatetimes($qty, array $datetimes = [])
+	{
+		$datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			$datetime->increaseSold($qty);
+		}
+	}
+
+
+	/**
+	 * Decrements (subtracts) sold by amount passed by $qty on both the ticket and its related datetimes directly in the
+	 * DB and then updates the model objects.
+	 * Does not affect the reserved counts.
+	 *
+	 * @param int $qty
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.9.80.p
+	 */
+	public function decreaseSold($qty = 1)
+	{
+		$qty = absint($qty);
+		$this->decreaseSoldForDatetimes($qty);
+		$success = $this->adjustNumericFieldsInDb(
+			[
+				'TKT_sold' => $qty * -1,
+			]
+		);
+		do_action(
+			'AHEE__EE_Ticket__decrease_sold',
+			$this,
+			$qty,
+			$this->sold(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * Decreases sold on related datetimes
+	 *
+	 * @param int           $qty
+	 * @param EE_Datetime[] $datetimes
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.9.80.p
+	 */
+	protected function decreaseSoldForDatetimes($qty = 1, array $datetimes = [])
+	{
+		$datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->decreaseSold($qty);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Gets qty of reserved tickets
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function reserved(): int
+	{
+		return (int) $this->get_raw('TKT_reserved');
+	}
+
+
+	/**
+	 * Sets reserved
+	 *
+	 * @param int $reserved
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_reserved($reserved)
+	{
+		// reserved can not go below zero
+		$reserved = max(0, (int) $reserved);
+		$this->set('TKT_reserved', $reserved);
+	}
+
+
+	/**
+	 * Increments reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @param int    $qty
+	 * @param string $source
+	 * @return bool whether we successfully reserved the ticket or not.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.80.p
+	 */
+	public function increaseReserved($qty = 1, $source = 'unknown')
+	{
+		$qty = absint($qty);
+		do_action(
+			'AHEE__EE_Ticket__increase_reserved__begin',
+			$this,
+			$qty,
+			$source
+		);
+		// comment out extra meta tracking
+		// $this->add_extra_meta(EE_Ticket::META_KEY_TICKET_RESERVATIONS, "{$qty} from {$source}");
+		$success                         = false;
+		$datetimes_adjusted_successfully = $this->increaseReservedForDatetimes($qty);
+		if ($datetimes_adjusted_successfully) {
+			$success = $this->incrementFieldConditionallyInDb(
+				'TKT_reserved',
+				'TKT_sold',
+				'TKT_qty',
+				$qty
+			);
+			if (! $success) {
+				// The datetimes were successfully bumped, but not the
+				// ticket. So we need to manually roll back the datetimes.
+				$this->decreaseReservedForDatetimes($qty);
+			}
+		}
+		do_action(
+			'AHEE__EE_Ticket__increase_reserved',
+			$this,
+			$qty,
+			$this->reserved(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * Increases reserved counts on related datetimes
+	 *
+	 * @param int           $qty
+	 * @param EE_Datetime[] $datetimes
+	 * @return boolean indicating success
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.9.80.p
+	 */
+	protected function increaseReservedForDatetimes($qty = 1, array $datetimes = [])
+	{
+		$datetimes         = ! empty($datetimes) ? $datetimes : $this->datetimes();
+		$datetimes_updated = [];
+		$limit_exceeded    = false;
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					if ($datetime->increaseReserved($qty)) {
+						$datetimes_updated[] = $datetime;
+					} else {
+						$limit_exceeded = true;
+						break;
+					}
+				}
+			}
+			// If somewhere along the way we detected a datetime whose
+			// limit was exceeded, do a manual rollback.
+			if ($limit_exceeded) {
+				$this->decreaseReservedForDatetimes($qty, $datetimes_updated);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @param int    $qty
+	 * @param bool   $adjust_datetimes
+	 * @param string $source
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.80.p
+	 */
+	public function decreaseReserved($qty = 1, $adjust_datetimes = true, $source = 'unknown')
+	{
+		$qty = absint($qty);
+		// comment out extra meta tracking
+		// $this->add_extra_meta(EE_Ticket::META_KEY_TICKET_RESERVATIONS, "-{$qty} from {$source}");
+		if ($adjust_datetimes) {
+			$this->decreaseReservedForDatetimes($qty);
+		}
+		$success = $this->adjustNumericFieldsInDb(
+			[
+				'TKT_reserved' => $qty * -1,
+			]
+		);
+		do_action(
+			'AHEE__EE_Ticket__decrease_reserved',
+			$this,
+			$qty,
+			$this->reserved(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * Decreases the reserved count on the specified datetimes.
+	 *
+	 * @param int           $qty
+	 * @param EE_Datetime[] $datetimes
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.80.p
+	 */
+	protected function decreaseReservedForDatetimes($qty = 1, array $datetimes = [])
+	{
+		$datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$datetime->decreaseReserved($qty);
+			}
+		}
+	}
+
+
+	/**
+	 * Gets ticket quantity
+	 *
+	 * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
+	 *                            therefore $context can be one of three values: '', 'reg_limit', or 'saleable'
+	 *                            '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects
+	 *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
+	 *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
+	 *                            is therefore the truest measure of tickets that can be purchased at the moment
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function qty($context = '')
+	{
+		switch ($context) {
+			case 'reg_limit':
+				return $this->real_quantity_on_ticket();
+			case 'saleable':
+				return $this->real_quantity_on_ticket('saleable');
+			default:
+				return $this->get_raw('TKT_qty');
+		}
+	}
+
+
+	/**
+	 * Gets ticket quantity
+	 *
+	 * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
+	 *                            therefore $context can be one of two values: 'reg_limit', or 'saleable'
+	 *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
+	 *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
+	 *                            is therefore the truest measure of tickets that can be purchased at the moment
+	 * @param int    $DTT_ID      the primary key for a particular datetime.
+	 *                            set to 0 for all related datetimes
+	 * @return int|float          int for finite quantity or float for INF
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function real_quantity_on_ticket($context = 'reg_limit', $DTT_ID = 0)
+	{
+		$raw = $this->get_raw('TKT_qty');
+		// return immediately if it's zero
+		if ($raw === 0) {
+			return $raw;
+		}
+		// echo "\n\n<br />Ticket: " . $this->name() . '<br />';
+		// ensure qty doesn't exceed raw value for THIS ticket
+		$qty = min(EE_INF, $raw);
+		// echo "\n . qty: " . $qty . '<br />';
+		// calculate this ticket's total sales and reservations
+		$sold_and_reserved_for_this_ticket = $this->sold() + $this->reserved();
+		// echo "\n . sold: " . $this->sold() . '<br />';
+		// echo "\n . reserved: " . $this->reserved() . '<br />';
+		// echo "\n . sold_and_reserved_for_this_ticket: " . $sold_and_reserved_for_this_ticket . '<br />';
+		// first we need to calculate the maximum number of tickets available for the datetime
+		// do we want data for one datetime or all of them ?
+		$query_params = $DTT_ID ? [['DTT_ID' => $DTT_ID]] : [];
+		$datetimes    = $this->get_many_related('Datetime', $query_params);
+		if (is_array($datetimes) && ! empty($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					// $datetime->refresh_from_db();
+					// echo "\n . . datetime name: " . $datetime->name() . '<br />';
+					// echo "\n . . datetime ID: " . $datetime->ID() . '<br />';
+					// initialize with no restrictions for each datetime
+					// but adjust datetime qty based on datetime reg limit
+					$datetime_qty = min(EE_INF, $datetime->reg_limit());
+					// echo "\n . . . datetime reg_limit: " . $datetime->reg_limit() . '<br />';
+					// echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
+					// if we want the actual saleable amount, then we need to consider OTHER ticket sales
+					// and reservations for this datetime, that do NOT include sales and reservations
+					// for this ticket (so we add $this->sold() and $this->reserved() back in)
+					if ($context === 'saleable') {
+						$datetime_qty = max(
+							$datetime_qty - $datetime->sold_and_reserved() + $sold_and_reserved_for_this_ticket,
+							0
+						);
+						// echo "\n . . . datetime sold: " . $datetime->sold() . '<br />';
+						// echo "\n . . . datetime reserved: " . $datetime->reserved() . '<br />';
+						// echo "\n . . . datetime sold_and_reserved: " . $datetime->sold_and_reserved() . '<br />';
+						// echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
+						$datetime_qty = ! $datetime->sold_out() ? $datetime_qty : 0;
+						// echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
+					}
+					$qty = min($datetime_qty, $qty);
+					// echo "\n . . qty: " . $qty . '<br />';
+				}
+			}
+		}
+		// NOW that we know the  maximum number of tickets available for the datetime
+		// we can finally factor in the details for this specific ticket
+		if ($qty > 0 && $context === 'saleable') {
+			// and subtract the sales for THIS ticket
+			$qty = max($qty - $sold_and_reserved_for_this_ticket, 0);
+			// echo "\n . qty: " . $qty . '<br />';
+		}
+		// echo "\nFINAL QTY: " . $qty . "<br /><br />";
+		return $qty;
+	}
+
+
+	/**
+	 * Sets qty - IMPORTANT!!! Does NOT allow QTY to be set higher than the lowest reg limit of any related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_qty($qty)
+	{
+		$datetimes = $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$qty = min($qty, $datetime->reg_limit());
+			}
+		}
+		$this->set('TKT_qty', $qty);
+	}
+
+
+	/**
+	 * Gets uses
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function uses()
+	{
+		return $this->get('TKT_uses');
+	}
+
+
+	/**
+	 * Sets uses
+	 *
+	 * @param int $uses
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_uses($uses)
+	{
+		$this->set('TKT_uses', $uses);
+	}
+
+
+	/**
+	 * returns whether ticket is required or not.
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function required()
+	{
+		return $this->get('TKT_required');
+	}
+
+
+	/**
+	 * sets the TKT_required property
+	 *
+	 * @param boolean $required
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_required($required)
+	{
+		$this->set('TKT_required', $required);
+	}
+
+
+	/**
+	 * Gets taxable
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function taxable()
+	{
+		return $this->get('TKT_taxable');
+	}
+
+
+	/**
+	 * Sets taxable
+	 *
+	 * @param boolean $taxable
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_taxable($taxable)
+	{
+		$this->set('TKT_taxable', $taxable);
+	}
+
+
+	/**
+	 * Gets is_default
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_default()
+	{
+		return $this->get('TKT_is_default');
+	}
+
+
+	/**
+	 * Sets is_default
+	 *
+	 * @param boolean $is_default
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_is_default($is_default)
+	{
+		$this->set('TKT_is_default', $is_default);
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function order()
+	{
+		return $this->get('TKT_order');
+	}
+
+
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_order($order)
+	{
+		$this->set('TKT_order', $order);
+	}
+
+
+	/**
+	 * Gets row
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function row()
+	{
+		return $this->get('TKT_row');
+	}
+
+
+	/**
+	 * Sets row
+	 *
+	 * @param int $row
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_row($row)
+	{
+		$this->set('TKT_row', $row);
+	}
+
+
+	/**
+	 * Gets deleted
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function deleted()
+	{
+		return $this->get('TKT_deleted');
+	}
+
+
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_deleted($deleted)
+	{
+		$this->set('TKT_deleted', $deleted);
+	}
+
+
+	/**
+	 * Gets parent
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function parent_ID()
+	{
+		return $this->get('TKT_parent');
+	}
+
+
+	/**
+	 * Sets parent
+	 *
+	 * @param int $parent
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_parent_ID($parent)
+	{
+		$this->set('TKT_parent', $parent);
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reverse_calculate()
+	{
+		return $this->get('TKT_reverse_calculate');
+	}
+
+
+	/**
+	 * @param boolean $reverse_calculate
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reverse_calculate($reverse_calculate)
+	{
+		$this->set('TKT_reverse_calculate', $reverse_calculate);
+	}
+
+
+	/**
+	 * Gets a string which is handy for showing in gateways etc that describes the ticket.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function name_and_info()
+	{
+		$times = [];
+		foreach ($this->datetimes() as $datetime) {
+			$times[] = $datetime->start_date_and_time();
+		}
+		/* translators: %1$s ticket name, %2$s start datetimes separated by comma, %3$s ticket price */
+		return sprintf(
+			esc_html__('%1$s @ %2$s for %3$s', 'event_espresso'),
+			$this->name(),
+			implode(', ', $times),
+			$this->pretty_price()
+		);
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function name()
+	{
+		return $this->get('TKT_name');
+	}
+
+
+	/**
+	 * Gets price
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function price()
+	{
+		return $this->get('TKT_price');
+	}
+
+
+	/**
+	 * Gets all the registrations for this ticket
+	 *
+	 * @param array $query_params
+	 * @return EE_Registration[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function registrations($query_params = [])
+	{
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_tickets_sold()
+	{
+		$count_regs_for_this_ticket = $this->count_registrations(
+			[
+				[
+					'STS_ID'      => RegStatus::APPROVED,
+					'REG_deleted' => 0,
+				],
+			]
+		);
+		$this->set_sold($count_regs_for_this_ticket);
+		$this->save();
+		return $count_regs_for_this_ticket;
+	}
+
+
+	/**
+	 * Counts the registrations for this ticket
+	 *
+	 * @param array $query_params
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function count_registrations($query_params = [])
+	{
+		return $this->count_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Implementation for EEI_Has_Icon interface method.
+	 *
+	 * @return string
+	 * @see EEI_Visual_Representation for comments
+	 */
+	public function get_icon()
+	{
+		return '<span class="dashicons dashicons-tickets-alt"></span>';
+	}
+
+
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @return EE_Event
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 * @throws ReflectionException
+	 * @see EEI_Event_Relation for comments
+	 */
+	public function get_related_event()
+	{
+		// get one datetime to use for getting the event
+		$datetime = $this->first_datetime();
+		if (! $datetime instanceof EE_Datetime) {
+			throw new UnexpectedEntityException(
+				$datetime,
+				'EE_Datetime',
+				sprintf(
+					esc_html__('The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
+					$this->name()
+				)
+			);
+		}
+		$event = $datetime->event();
+		if (! $event instanceof EE_Event) {
+			throw new UnexpectedEntityException(
+				$event,
+				'EE_Event',
+				sprintf(
+					esc_html__('The ticket (%s) is not associated with a valid event.', 'event_espresso'),
+					$this->name()
+				)
+			);
+		}
+		return $event;
+	}
+
+
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @return string
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see EEI_Event_Relation for comments
+	 */
+	public function get_event_name()
+	{
+		$event = $this->get_related_event();
+		return $event instanceof EE_Event ? $event->name() : '';
+	}
+
+
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see EEI_Event_Relation for comments
+	 */
+	public function get_event_ID()
+	{
+		$event = $this->get_related_event();
+		return $event instanceof EE_Event ? $event->ID() : 0;
+	}
+
+
+	/**
+	 * This simply returns whether a ticket can be permanently deleted or not.
+	 * The criteria for determining this is whether the ticket has any related registrations.
+	 * If there are none then it can be permanently deleted.
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_permanently_deleteable()
+	{
+		return $this->count_registrations() === 0;
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function visibility(): int
+	{
+		return $this->get('TKT_visibility');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function isHidden(): bool
+	{
+		return $this->visibility() === EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function isNotHidden(): bool
+	{
+		return $this->visibility() > EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function isPublicOnly(): bool
+	{
+		return $this->isNotHidden() && $this->visibility() <= EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function isMembersOnly(): bool
+	{
+		return $this->visibility() > EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE
+			   && $this->visibility() <= EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_VALUE;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function isAdminsOnly(): bool
+	{
+		return $this->visibility() > EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_VALUE
+			   && $this->visibility() <= EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_VALUE;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function isAdminUiOnly(): bool
+	{
+		return $this->visibility() > EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_VALUE
+			   && $this->visibility() <= EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE;
+	}
+
+
+	/**
+	 * @param int $visibility
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function set_visibility(int $visibility)
+	{
+		$ticket_visibility_options = $this->_model->ticketVisibilityOptions();
+		$ticket_visibility         = -1;
+		foreach ($ticket_visibility_options as $ticket_visibility_option) {
+			if ($visibility === $ticket_visibility_option) {
+				$ticket_visibility = $visibility;
+			}
+		}
+		if ($ticket_visibility === -1) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The supplied ticket visibility setting of "%1$s" is not valid. It needs to match one of the keys in the following array:%2$s %3$s ',
+						'event_espresso'
+					),
+					$visibility,
+					'<br />',
+					var_export($ticket_visibility_options, true)
+				)
+			);
+		}
+		$this->set('TKT_visibility', $ticket_visibility);
+	}
+
+
+	/**
+	 * @param EE_Base_Class|int|string $otherObjectModelObjectOrID
+	 * @param string                   $relationName
+	 * @param array                    $extra_join_model_fields_n_values
+	 * @param string|null              $cache_id
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function _add_relation_to(
+		$otherObjectModelObjectOrID,
+		$relationName,
+		$extra_join_model_fields_n_values = [],
+		$cache_id = null
+	) {
+		if ($relationName === 'Datetime' && ! $this->hasRelation($otherObjectModelObjectOrID, $relationName)) {
+			/** @var EE_Datetime $datetime */
+			$datetime = EEM_Datetime::instance()->ensure_is_obj($otherObjectModelObjectOrID);
+			$datetime->increaseSold($this->sold(), false);
+			$datetime->increaseReserved($this->reserved());
+			$datetime->save();
+			$otherObjectModelObjectOrID = $datetime;
+		}
+		return parent::_add_relation_to(
+			$otherObjectModelObjectOrID,
+			$relationName,
+			$extra_join_model_fields_n_values,
+			$cache_id
+		);
+	}
+
+
+	/**
+	 * @param EE_Base_Class|int|string $otherObjectModelObjectOrID
+	 * @param string                   $relationName
+	 * @param array                    $where_query
+	 * @return bool|EE_Base_Class|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = [])
+	{
+		// if we're adding a new relation to a datetime
+		if ($relationName === 'Datetime' && $this->hasRelation($otherObjectModelObjectOrID, $relationName)) {
+			/** @var EE_Datetime $datetime */
+			$datetime = EEM_Datetime::instance()->ensure_is_obj($otherObjectModelObjectOrID);
+			$datetime->decreaseSold($this->sold());
+			$datetime->decreaseReserved($this->reserved());
+			$datetime->save();
+			$otherObjectModelObjectOrID = $datetime;
+		}
+		return parent::_remove_relation_to(
+			$otherObjectModelObjectOrID,
+			$relationName,
+			$where_query
+		);
+	}
+
+
+	/**
+	 * Removes ALL the related things for the $relationName.
+	 *
+	 * @param string $relationName
+	 * @param array  $where_query_params
+	 * @return EE_Base_Class
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	public function _remove_relations($relationName, $where_query_params = [])
+	{
+		if ($relationName === 'Datetime') {
+			$datetimes = $this->datetimes();
+			foreach ($datetimes as $datetime) {
+				$datetime->decreaseSold($this->sold());
+				$datetime->decreaseReserved($this->reserved());
+				$datetime->save();
+			}
+		}
+		return parent::_remove_relations($relationName, $where_query_params);
+	}
+
+
+	/*******************************************************************
      ***********************  DEPRECATED METHODS  **********************
      *******************************************************************/
 
 
-    /**
-     * Increments sold by amount passed by $qty AND decrements the reserved count on both this ticket and its
-     * associated datetimes.
-     *
-     * @param int $qty
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated 4.9.80.p
-     */
-    public function increase_sold($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::increaseSold() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        $this->increaseSold($qty);
-    }
-
-
-    /**
-     * On each datetime related to this ticket, increases its sold count and decreases its reserved count by $qty.
-     *
-     * @param int $qty positive or negative. Positive means to increase sold counts (and decrease reserved counts),
-     *                 Negative means to decreases old counts (and increase reserved counts).
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated 4.9.80.p
-     */
-    protected function _increase_sold_for_datetimes($qty)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::increaseSoldForDatetimes() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        $this->increaseSoldForDatetimes($qty);
-    }
-
-
-    /**
-     * Decrements (subtracts) sold by amount passed by $qty on both the ticket and its related datetimes directly in the
-     * DB and then updates the model objects.
-     * Does not affect the reserved counts.
-     *
-     * @param int $qty
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated 4.9.80.p
-     */
-    public function decrease_sold($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::decreaseSold() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        $this->decreaseSold($qty);
-    }
-
-
-    /**
-     * Decreases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated 4.9.80.p
-     */
-    protected function _decrease_sold_for_datetimes($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::decreaseSoldForDatetimes() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        $this->decreaseSoldForDatetimes($qty);
-    }
-
-
-    /**
-     * Increments reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @param int    $qty
-     * @param string $source
-     * @return bool whether we successfully reserved the ticket or not.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated 4.9.80.p
-     */
-    public function increase_reserved($qty = 1, $source = 'unknown')
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::increaseReserved() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        return $this->increaseReserved($qty);
-    }
-
-
-    /**
-     * Increases sold on related datetimes
-     *
-     * @param int $qty
-     * @return boolean indicating success
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated 4.9.80.p
-     */
-    protected function _increase_reserved_for_datetimes($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::increaseReservedForDatetimes() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        return $this->increaseReservedForDatetimes($qty);
-    }
-
-
-    /**
-     * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @param int    $qty
-     * @param bool   $adjust_datetimes
-     * @param string $source
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated 4.9.80.p
-     */
-    public function decrease_reserved($qty = 1, $adjust_datetimes = true, $source = 'unknown')
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::decreaseReserved() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        $this->decreaseReserved($qty);
-    }
-
-
-    /**
-     * Decreases reserved on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated 4.9.80.p
-     */
-    protected function _decrease_reserved_for_datetimes($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::decreaseReservedForDatetimes() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        $this->decreaseReservedForDatetimes($qty);
-    }
+	/**
+	 * Increments sold by amount passed by $qty AND decrements the reserved count on both this ticket and its
+	 * associated datetimes.
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated 4.9.80.p
+	 */
+	public function increase_sold($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::increaseSold() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		$this->increaseSold($qty);
+	}
+
+
+	/**
+	 * On each datetime related to this ticket, increases its sold count and decreases its reserved count by $qty.
+	 *
+	 * @param int $qty positive or negative. Positive means to increase sold counts (and decrease reserved counts),
+	 *                 Negative means to decreases old counts (and increase reserved counts).
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated 4.9.80.p
+	 */
+	protected function _increase_sold_for_datetimes($qty)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::increaseSoldForDatetimes() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		$this->increaseSoldForDatetimes($qty);
+	}
+
+
+	/**
+	 * Decrements (subtracts) sold by amount passed by $qty on both the ticket and its related datetimes directly in the
+	 * DB and then updates the model objects.
+	 * Does not affect the reserved counts.
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated 4.9.80.p
+	 */
+	public function decrease_sold($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::decreaseSold() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		$this->decreaseSold($qty);
+	}
+
+
+	/**
+	 * Decreases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated 4.9.80.p
+	 */
+	protected function _decrease_sold_for_datetimes($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::decreaseSoldForDatetimes() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		$this->decreaseSoldForDatetimes($qty);
+	}
+
+
+	/**
+	 * Increments reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @param int    $qty
+	 * @param string $source
+	 * @return bool whether we successfully reserved the ticket or not.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated 4.9.80.p
+	 */
+	public function increase_reserved($qty = 1, $source = 'unknown')
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::increaseReserved() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		return $this->increaseReserved($qty);
+	}
+
+
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return boolean indicating success
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated 4.9.80.p
+	 */
+	protected function _increase_reserved_for_datetimes($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::increaseReservedForDatetimes() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		return $this->increaseReservedForDatetimes($qty);
+	}
+
+
+	/**
+	 * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @param int    $qty
+	 * @param bool   $adjust_datetimes
+	 * @param string $source
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated 4.9.80.p
+	 */
+	public function decrease_reserved($qty = 1, $adjust_datetimes = true, $source = 'unknown')
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::decreaseReserved() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		$this->decreaseReserved($qty);
+	}
+
+
+	/**
+	 * Decreases reserved on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated 4.9.80.p
+	 */
+	protected function _decrease_reserved_for_datetimes($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::decreaseReservedForDatetimes() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		$this->decreaseReservedForDatetimes($qty);
+	}
 }

Spacing +14 added lines, -14 removed lines

@@ -172,7 +172,7 @@ 
     public function ticket_status($display = false, $remaining = null)
     {
         $remaining = is_bool($remaining) ? $remaining : $this->is_remaining();
-        if (! $remaining) {
+        if ( ! $remaining) {
             return $display ? EEH_Template::pretty_status(EE_Ticket::sold_out, false, 'sentence') : EE_Ticket::sold_out;
         }
         if ($this->get('TKT_deleted')) {
@@ -300,7 +300,7 @@ 
             ? $this->last_datetime()->get_i18n_datetime('DTT_EVT_end', $date_format)
             : '';
 
-        return $first_date && $last_date ? $first_date . $conjunction . $last_date : '';
+        return $first_date && $last_date ? $first_date.$conjunction.$last_date : '';
     }
 
 
@@ -330,7 +330,7 @@ 
      */
     public function datetimes($query_params = [])
     {
-        if (! isset($query_params['order_by'])) {
+        if ( ! isset($query_params['order_by'])) {
             $query_params['order_by']['DTT_order'] = 'ASC';
         }
         return $this->get_many_related('Datetime', $query_params);
@@ -377,7 +377,7 @@ 
                 if (empty($tickets_sold['datetime'])) {
                     return $total;
                 }
-                if (! empty($dtt_id) && ! isset($tickets_sold['datetime'][ $dtt_id ])) {
+                if ( ! empty($dtt_id) && ! isset($tickets_sold['datetime'][$dtt_id])) {
                     EE_Error::add_error(
                         esc_html__(
                             'You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?',
@@ -389,7 +389,7 @@ 
                     );
                     return $total;
                 }
-                return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][ $dtt_id ];
+                return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][$dtt_id];
 
             default:
                 return $total;
@@ -408,9 +408,9 @@ 
     {
         $datetimes    = $this->get_many_related('Datetime');
         $tickets_sold = [];
-        if (! empty($datetimes)) {
+        if ( ! empty($datetimes)) {
             foreach ($datetimes as $datetime) {
-                $tickets_sold['datetime'][ $datetime->ID() ] = $datetime->get('DTT_sold');
+                $tickets_sold['datetime'][$datetime->ID()] = $datetime->get('DTT_sold');
             }
         }
         // Tickets sold
@@ -430,7 +430,7 @@ 
     public function base_price(bool $return_array = false)
     {
         $base_price = $this->ticket_price_modifiers->getBasePrice();
-        if (! empty($base_price)) {
+        if ( ! empty($base_price)) {
             return $return_array ? $base_price : reset($base_price);
         }
         $_where = ['Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price];
@@ -452,7 +452,7 @@ 
         $price_modifiers = $this->usesGlobalTaxes()
             ? $this->ticket_price_modifiers->getAllDiscountAndSurchargeModifiersForTicket()
             : $this->ticket_price_modifiers->getAllModifiersForTicket();
-        if (! empty($price_modifiers)) {
+        if ( ! empty($price_modifiers)) {
             return $price_modifiers;
         }
         return $this->prices(
@@ -478,7 +478,7 @@ 
     public function tax_price_modifiers(): array
     {
         $tax_price_modifiers = $this->ticket_price_modifiers->getAllTaxesForTicket();
-        if (! empty($tax_price_modifiers)) {
+        if ( ! empty($tax_price_modifiers)) {
             return $tax_price_modifiers;
         }
         return $this->prices([['Price_Type.PBT_ID' => EEM_Price_Type::base_type_tax]]);
@@ -496,7 +496,7 @@ 
      */
     public function prices(array $query_params = []): array
     {
-        if (! isset($query_params['order_by'])) {
+        if ( ! isset($query_params['order_by'])) {
             $query_params['order_by']['PRC_order'] = 'ASC';
         }
         return $this->get_many_related('Price', $query_params);
@@ -1075,7 +1075,7 @@ 
                 'TKT_qty',
                 $qty
             );
-            if (! $success) {
+            if ( ! $success) {
                 // The datetimes were successfully bumped, but not the
                 // ticket. So we need to manually roll back the datetimes.
                 $this->decreaseReservedForDatetimes($qty);
@@ -1687,7 +1687,7 @@ 
     {
         // get one datetime to use for getting the event
         $datetime = $this->first_datetime();
-        if (! $datetime instanceof EE_Datetime) {
+        if ( ! $datetime instanceof EE_Datetime) {
             throw new UnexpectedEntityException(
                 $datetime,
                 'EE_Datetime',
@@ -1698,7 +1698,7 @@ 
             );
         }
         $event = $datetime->event();
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             throw new UnexpectedEntityException(
                 $event,
                 'EE_Event',

core/domain/entities/shortcodes/EspressoCancelled.php

Indentation +174 added lines, -174 removed lines

@@ -25,178 +25,178 @@
  */
 class EspressoCancelled extends EspressoShortcode
 {
-    private ?RequestInterface $request = null;
-
-
-    public function request(): RequestInterface
-    {
-        if (! $this->request instanceof RequestInterface) {
-            $this->request = LoaderFactory::getShared(RequestInterface::class);
-        }
-        return $this->request;
-    }
-
-
-
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_CANCELLED';
-    }
-
-
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
-
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        $this->shortcodeHasBeenInitialized();
-    }
-
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array|string $attributes
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function processShortcode($attributes = array())
-    {
-        $reg_url_link = $this->request()->getRequestParam('e_reg_url_link', '');
-        if (! $reg_url_link) {
-            return $this->clearCartAndCancelAllRegistrations();
-        }
-        $registration = EEM_Registration::instance()->get_registration_for_reg_url_link($reg_url_link);
-        if (! $registration instanceof EE_Registration) {
-            return sprintf(
-                esc_html__(
-                    '%1$sCould not find registration for the REG URL link: %2$s',
-                    'event_espresso'
-                ),
-                '<p class="ee-registrations-cancelled-pg ee-attention">',
-                $reg_url_link . '</p>'
-            );
-        }
-        $confirmation_code = $this->request()->getRequestParam('confirmation_code', '');
-        $confirmation_code = strtoupper((string) $confirmation_code);
-        if (! $confirmation_code) {
-            return $this->cancelRegistrationConfirmationForm($registration);
-        }
-        return $this->cancelRegistration($registration, $confirmation_code);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @since 5.0.30.p
-     */
-    private function cancelRegistrationConfirmationForm(EE_Registration $registration): string
-    {
-        $form  = new CancelRegistrationForm($registration);
-        return $form->display();
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param string          $confirmation_code
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.30.p
-     */
-    private function cancelRegistration(EE_Registration $registration, string $confirmation_code): string
-    {
-        if ($confirmation_code !== $registration->cancelRegistrationConfirmationCode()) {
-            return sprintf(
-                esc_html__(
-                    '%1$sThe confirmation code provided does not match the confirmation code for this registration!%2$s',
-                    'event_espresso'
-                ),
-                '<p class="ee-registrations-cancelled-pg ee-attention">',
-                $registration->reg_url_link() . '</p>'
-            );
-        }
-
-        try {
-            $form   = new CancelRegistrationForm($registration);
-            return $form->process($this->request->postParams());
-        } catch (Exception $exception) {
-            return sprintf(
-                esc_html__(
-                    '%1$sThe following error occurred and the one or more registrations could not be cancelled:%2$s',
-                    'event_espresso'
-                ),
-                '<p class="ee-registrations-cancelled-pg ee-attention">',
-                '<br>' . $exception->getMessage() . '</p>'
-            );
-        }
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.30.p
-     */
-    private function clearCartAndCancelAllRegistrations(): string
-    {
-        $session = LoaderFactory::getShared(EE_Session::class);
-        if (! $session instanceof EE_Session) {
-            return '';
-        }
-        $transaction = $session->get_session_data('transaction');
-        if ($transaction instanceof EE_Transaction) {
-            do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', $transaction);
-            $registrations = $transaction->registrations();
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration) {
-                    do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__registration', $registration);
-                }
-            }
-        }
-        do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__clear_session');
-        // remove all unwanted records from the db
-        if ($session->cart() instanceof EE_Cart) {
-            $session->cart()->delete_cart();
-        }
-        $session->clear_session(__CLASS__, __FUNCTION__);
-        // phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText
-        return sprintf(
-            esc_html__(
-                '%sAll unsaved registration information entered during this session has been deleted.%s',
-                'event_espresso'
-            ),
-            '<p class="ee-registrations-cancelled-pg ee-attention">',
-            '</p>'
-        );
-        // phpcs:enable
-    }
+	private ?RequestInterface $request = null;
+
+
+	public function request(): RequestInterface
+	{
+		if (! $this->request instanceof RequestInterface) {
+			$this->request = LoaderFactory::getShared(RequestInterface::class);
+		}
+		return $this->request;
+	}
+
+
+
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_CANCELLED';
+	}
+
+
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
+
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		$this->shortcodeHasBeenInitialized();
+	}
+
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array|string $attributes
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function processShortcode($attributes = array())
+	{
+		$reg_url_link = $this->request()->getRequestParam('e_reg_url_link', '');
+		if (! $reg_url_link) {
+			return $this->clearCartAndCancelAllRegistrations();
+		}
+		$registration = EEM_Registration::instance()->get_registration_for_reg_url_link($reg_url_link);
+		if (! $registration instanceof EE_Registration) {
+			return sprintf(
+				esc_html__(
+					'%1$sCould not find registration for the REG URL link: %2$s',
+					'event_espresso'
+				),
+				'<p class="ee-registrations-cancelled-pg ee-attention">',
+				$reg_url_link . '</p>'
+			);
+		}
+		$confirmation_code = $this->request()->getRequestParam('confirmation_code', '');
+		$confirmation_code = strtoupper((string) $confirmation_code);
+		if (! $confirmation_code) {
+			return $this->cancelRegistrationConfirmationForm($registration);
+		}
+		return $this->cancelRegistration($registration, $confirmation_code);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @since 5.0.30.p
+	 */
+	private function cancelRegistrationConfirmationForm(EE_Registration $registration): string
+	{
+		$form  = new CancelRegistrationForm($registration);
+		return $form->display();
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param string          $confirmation_code
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.30.p
+	 */
+	private function cancelRegistration(EE_Registration $registration, string $confirmation_code): string
+	{
+		if ($confirmation_code !== $registration->cancelRegistrationConfirmationCode()) {
+			return sprintf(
+				esc_html__(
+					'%1$sThe confirmation code provided does not match the confirmation code for this registration!%2$s',
+					'event_espresso'
+				),
+				'<p class="ee-registrations-cancelled-pg ee-attention">',
+				$registration->reg_url_link() . '</p>'
+			);
+		}
+
+		try {
+			$form   = new CancelRegistrationForm($registration);
+			return $form->process($this->request->postParams());
+		} catch (Exception $exception) {
+			return sprintf(
+				esc_html__(
+					'%1$sThe following error occurred and the one or more registrations could not be cancelled:%2$s',
+					'event_espresso'
+				),
+				'<p class="ee-registrations-cancelled-pg ee-attention">',
+				'<br>' . $exception->getMessage() . '</p>'
+			);
+		}
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.30.p
+	 */
+	private function clearCartAndCancelAllRegistrations(): string
+	{
+		$session = LoaderFactory::getShared(EE_Session::class);
+		if (! $session instanceof EE_Session) {
+			return '';
+		}
+		$transaction = $session->get_session_data('transaction');
+		if ($transaction instanceof EE_Transaction) {
+			do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', $transaction);
+			$registrations = $transaction->registrations();
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration) {
+					do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__registration', $registration);
+				}
+			}
+		}
+		do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__clear_session');
+		// remove all unwanted records from the db
+		if ($session->cart() instanceof EE_Cart) {
+			$session->cart()->delete_cart();
+		}
+		$session->clear_session(__CLASS__, __FUNCTION__);
+		// phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText
+		return sprintf(
+			esc_html__(
+				'%sAll unsaved registration information entered during this session has been deleted.%s',
+				'event_espresso'
+			),
+			'<p class="ee-registrations-cancelled-pg ee-attention">',
+			'</p>'
+		);
+		// phpcs:enable
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -30,7 +30,7 @@ 
 
     public function request(): RequestInterface
     {
-        if (! $this->request instanceof RequestInterface) {
+        if ( ! $this->request instanceof RequestInterface) {
             $this->request = LoaderFactory::getShared(RequestInterface::class);
         }
         return $this->request;
@@ -87,23 +87,23 @@ 
     public function processShortcode($attributes = array())
     {
         $reg_url_link = $this->request()->getRequestParam('e_reg_url_link', '');
-        if (! $reg_url_link) {
+        if ( ! $reg_url_link) {
             return $this->clearCartAndCancelAllRegistrations();
         }
         $registration = EEM_Registration::instance()->get_registration_for_reg_url_link($reg_url_link);
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             return sprintf(
                 esc_html__(
                     '%1$sCould not find registration for the REG URL link: %2$s',
                     'event_espresso'
                 ),
                 '<p class="ee-registrations-cancelled-pg ee-attention">',
-                $reg_url_link . '</p>'
+                $reg_url_link.'</p>'
             );
         }
         $confirmation_code = $this->request()->getRequestParam('confirmation_code', '');
         $confirmation_code = strtoupper((string) $confirmation_code);
-        if (! $confirmation_code) {
+        if ( ! $confirmation_code) {
             return $this->cancelRegistrationConfirmationForm($registration);
         }
         return $this->cancelRegistration($registration, $confirmation_code);
@@ -118,7 +118,7 @@ 
      */
     private function cancelRegistrationConfirmationForm(EE_Registration $registration): string
     {
-        $form  = new CancelRegistrationForm($registration);
+        $form = new CancelRegistrationForm($registration);
         return $form->display();
     }
 
@@ -140,12 +140,12 @@ 
                     'event_espresso'
                 ),
                 '<p class="ee-registrations-cancelled-pg ee-attention">',
-                $registration->reg_url_link() . '</p>'
+                $registration->reg_url_link().'</p>'
             );
         }
 
         try {
-            $form   = new CancelRegistrationForm($registration);
+            $form = new CancelRegistrationForm($registration);
             return $form->process($this->request->postParams());
         } catch (Exception $exception) {
             return sprintf(
@@ -154,7 +154,7 @@ 
                     'event_espresso'
                 ),
                 '<p class="ee-registrations-cancelled-pg ee-attention">',
-                '<br>' . $exception->getMessage() . '</p>'
+                '<br>'.$exception->getMessage().'</p>'
             );
         }
     }
@@ -169,7 +169,7 @@ 
     private function clearCartAndCancelAllRegistrations(): string
     {
         $session = LoaderFactory::getShared(EE_Session::class);
-        if (! $session instanceof EE_Session) {
+        if ( ! $session instanceof EE_Session) {
             return '';
         }
         $transaction = $session->get_session_data('transaction');