eventespresso / event-espresso-core

core/db_models/EEM_Base.model.php

Doc Comments +18 added lines, -16 removed lines

@@ -915,7 +915,7 @@ 
      *  on this model (or follows the _model_chain_to_wp_user and uses that model's
      * foreign key to the WP_User table)
      *
-     * @return string|boolean string on success, boolean false when there is no
+     * @return string|false string on success, boolean false when there is no
      * foreign key to the WP_User table
      * @throws ReflectionException
      */
@@ -1045,7 +1045,7 @@ 
      *
      * @param array  $query_params
      * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
+     * @param string  $columns_to_select , What columns to select. By default, we select all columns specified by the
      *                                  fields on the model, and the models we joined to in the query. However, you can
      *                                  override this and set the select to "*", or a specific column name, like
      *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
@@ -1212,7 +1212,7 @@ 
      * found in the database matching the given query conditions.
      *
      * @param mixed $current_field_value    Value used for the reference point.
-     * @param null  $field_to_order_by      What field is used for the
+     * @param string  $field_to_order_by      What field is used for the
      *                                      reference point.
      * @param int   $limit                  How many to return.
      * @param array $query_params           Extra conditions on the query.
@@ -1247,7 +1247,7 @@ 
      * as found in the database matching the given query conditions.
      *
      * @param mixed $current_field_value    Value used for the reference point.
-     * @param null  $field_to_order_by      What field is used for the
+     * @param string  $field_to_order_by      What field is used for the
      *                                      reference point.
      * @param int   $limit                  How many to return.
      * @param array $query_params           Extra conditions on the query.
@@ -1282,7 +1282,7 @@ 
      * database matching the given query conditions.
      *
      * @param mixed $current_field_value    Value used for the reference point.
-     * @param null  $field_to_order_by      What field is used for the
+     * @param string  $field_to_order_by      What field is used for the
      *                                      reference point.
      * @param array $query_params           Extra conditions on the query.
      * @param null  $columns_to_select      If left null, then an EE_Base_Class
@@ -1317,7 +1317,7 @@ 
      * the database matching the given query conditions.
      *
      * @param mixed $current_field_value    Value used for the reference point.
-     * @param null  $field_to_order_by      What field is used for the
+     * @param string  $field_to_order_by      What field is used for the
      *                                      reference point.
      * @param array $query_params           Extra conditions on the query.
      * @param null  $columns_to_select      If left null, then an EE_Base_Class
@@ -1478,7 +1478,7 @@ 
      *
      * @param string $field_name The name of the field the formats are being retrieved for.
      * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
-     * @return array formats in an array with the date format first, and the time format last.
+     * @return string[] formats in an array with the date format first, and the time format last.
      * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
      * @since 4.6.x
      */
@@ -2478,7 +2478,7 @@ 
      * Verifies the EE addons' database is up-to-date and records that we've done it on
      * EEM_Base::$_db_verification_level
      *
-     * @param $wpdb_method
+     * @param string $wpdb_method
      * @param $arguments_to_provide
      * @return string
      * @throws EE_Error
@@ -2597,6 +2597,7 @@ 
      *                             methods that allow you to further specify extra columns to join by (such as HABTM).
      *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
      *                             because these will be inserted in any new rows created as well.
+     * @param EE_Base_Class $id_or_obj
      * @return boolean of success
      * @throws EE_Error
      */
@@ -2608,7 +2609,7 @@ 
 
 
     /**
-     * @param mixed  $id_or_obj
+     * @param EE_Base_Class  $id_or_obj
      * @param string $relationName
      * @param array  $where_query_params
      * @param EE_Base_Class[] objects to which relations were removed
@@ -2649,7 +2650,7 @@ 
      * However, if the model objects can't be deleted because of blocking related model objects, then
      * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
      *
-     * @param EE_Base_Class|int|string $id_or_obj
+     * @param EE_Base_Class $id_or_obj
      * @param string                   $model_name
      * @param array                    $query_params
      * @return int how many deleted
@@ -2670,7 +2671,7 @@ 
      * the model objects can't be hard deleted because of blocking related model objects,
      * just does a soft-delete on them instead.
      *
-     * @param EE_Base_Class|int|string $id_or_obj
+     * @param EE_Base_Class $id_or_obj
      * @param string                   $model_name
      * @param array                    $query_params
      * @return int how many deleted
@@ -2728,6 +2729,7 @@ 
      * @param string $model_name   like 'Event', or 'Registration'
      * @param array  $query_params
      * @param string $field_to_sum name of field to count by. By default, uses primary key
+     * @param EE_Base_Class $id_or_obj
      * @return float
      * @throws EE_Error
      * @throws ReflectionException
@@ -3761,7 +3763,7 @@ 
      * We should use default where conditions on related models when they requested to use default where conditions
      * on all models, or specifically just on other related models
      *
-     * @param      $default_where_conditions_value
+     * @param      string $default_where_conditions_value
      * @param bool $for_this_model false means this is for OTHER related models
      * @return bool
      */
@@ -3801,7 +3803,7 @@ 
      * We should use minimum where conditions on related models if they requested to use minimum where conditions
      * on this model or others
      *
-     * @param      $default_where_conditions_value
+     * @param      string $default_where_conditions_value
      * @param bool $for_this_model false means this is for OTHER related models
      * @return bool
      */
@@ -4990,7 +4992,7 @@ 
      * gets the field object of type 'primary_key' from the fieldsSettings attribute.
      * Eg, on EE_Answer that would be ANS_ID field object
      *
-     * @param $field_obj
+     * @param EE_Model_Field_Base $field_obj
      * @return boolean
      */
     public function is_primary_key_field($field_obj)
@@ -5799,7 +5801,7 @@ 
     /**
      * Read comments for assume_values_already_prepared_by_model_object()
      *
-     * @return int
+     * @return boolean
      */
     public function get_assumption_concerning_values_already_prepared_by_model_object()
     {
@@ -6434,7 +6436,7 @@ 
     /**
      * Returns the password field on this model, if there is one
      *
-     * @return EE_Password_Field|null
+     * @return EE_Model_Field_Base|null
      * @since 4.9.74.p
      */
     public function getPasswordField()

Indentation +6562 added lines, -6562 removed lines

@@ -37,6568 +37,6568 @@
 abstract class EEM_Base extends EE_Base implements ResettableInterface
 {
 
-    /**
-     * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
-     */
-    const caps_read       = 'read';
-
-    const caps_read_admin = 'read_admin';
-
-    const caps_edit       = 'edit';
-
-    const caps_delete     = 'delete';
-
-
-    /**
-     * constant used to show EEM_Base has not yet verified the db on this http request
-     */
-    const db_verified_none = 0;
-
-    /**
-     * constant used to show EEM_Base has verified the EE core db on this http request,
-     * but not the addons' dbs
-     */
-    const db_verified_core = 1;
-
-    /**
-     * constant used to show EEM_Base has verified the addons' dbs (and implicitly
-     * the EE core db too)
-     */
-    const db_verified_addons = 2;
-
-    /**
-     * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
-     *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
-     *        registrations for non-trashed tickets for non-trashed datetimes)
-     */
-    const default_where_conditions_all = 'all';
-
-    /**
-     * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
-     *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
-     *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
-     *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
-     *        models which share tables with other models, this can return data for the wrong model.
-     */
-    const default_where_conditions_this_only = 'this_model_only';
-
-    /**
-     * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
-     *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
-     *        return all registrations related to non-trashed tickets and non-trashed datetimes)
-     */
-    const default_where_conditions_others_only = 'other_models_only';
-
-    /**
-     * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
-     *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
-     *        their table with other models, like the Event and Venue models. For example, when querying for events
-     *        ordered by their venues' name, this will be sure to only return real events with associated real venues
-     *        (regardless of whether those events and venues are trashed)
-     *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
-     *        events.
-     */
-    const default_where_conditions_minimum_all = 'minimum';
-
-    /**
-     * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
-     *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
-     *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
-     *        not)
-     */
-    const default_where_conditions_minimum_others = 'full_this_minimum_others';
-
-    /**
-     * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
-     *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
-     *        it's possible it will return table entries for other models. You should use
-     *        EEM_Base::default_where_conditions_minimum_all instead.
-     */
-    const default_where_conditions_none = 'none';
-
-    /**
-     * when $_values_already_prepared_by_model_object equals this, we assume
-     * the data is just like form input that needs to have the model fields'
-     * prepare_for_set and prepare_for_use_in_db called on it
-     */
-    const not_prepared_by_model_object = 0;
-
-    /**
-     * when $_values_already_prepared_by_model_object equals this, we
-     * assume this value is coming from a model object and doesn't need to have
-     * prepare_for_set called on it, just prepare_for_use_in_db is used
-     */
-    const prepared_by_model_object = 1;
-
-    /**
-     * when $_values_already_prepared_by_model_object equals this, we assume
-     * the values are already to be used in the database (ie no processing is done
-     * on them by the model's fields)
-     */
-    const prepared_for_use_in_db = 2;
-
-    /**
-     * Flag to indicate whether the values provided to EEM_Base have already been prepared
-     * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
-     * They almost always WILL NOT, but it's not necessarily a requirement.
-     * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
-     *
-     * @var boolean
-     */
-    private $_values_already_prepared_by_model_object = 0;
-
-
-    /**
-     * @var string
-     */
-    protected $singular_item = 'Item';
-
-    /**
-     * @var string
-     */
-    protected $plural_item = 'Items';
-
-    /**
-     * array of EE_Table objects for defining which tables comprise this model.
-     *
-     * @type EE_Table_Base[] $_tables
-     */
-    protected $_tables;
-
-    /**
-     * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
-     * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
-     * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
-     *
-     * @var EE_Model_Field_Base[][] $_fields
-     */
-    protected $_fields;
-
-    /**
-     * array of different kinds of relations
-     *
-     * @var EE_Model_Relation_Base[] $_model_relations
-     */
-    protected $_model_relations;
-
-    /**
-     * @var EE_Index[] $_indexes
-     */
-    protected $_indexes = [];
-
-    /**
-     * Default strategy for getting where conditions on this model. This strategy is used to get default
-     * where conditions which are added to get_all, update, and delete queries. They can be overridden
-     * by setting the same columns as used in these queries in the query yourself.
-     *
-     * @var EE_Default_Where_Conditions
-     */
-    protected $_default_where_conditions_strategy;
-
-    /**
-     * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
-     * This is particularly useful when you want something between 'none' and 'default'
-     *
-     * @var EE_Default_Where_Conditions
-     */
-    protected $_minimum_where_conditions_strategy;
-
-    /**
-     * String describing how to find the "owner" of this model's objects.
-     * When there is a foreign key on this model to the wp_users table, this isn't needed.
-     * But when there isn't, this indicates which related model, or transiently-related model,
-     * has the foreign key to the wp_users table.
-     * Eg, for EEM_Registration this would be 'Event' because registrations are directly
-     * related to events, and events have a foreign key to wp_users.
-     * On EEM_Transaction, this would be 'Transaction.Event'
-     *
-     * @var string
-     */
-    protected $_model_chain_to_wp_user = '';
-
-    /**
-     * String describing how to find the model with a password controlling access to this model. This property has the
-     * same format as $_model_chain_to_wp_user. This is primarily used by the query param "exclude_protected".
-     * This value is the path of models to follow to arrive at the model with the password field.
-     * If it is an empty string, it means this model has the password field. If it is null, it means there is no
-     * model with a password that should affect reading this on the front-end.
-     * Eg this is an empty string for the Event model because it has a password.
-     * This is null for the Registration model, because its event's password has no bearing on whether
-     * you can read the registration or not on the front-end (it just depends on your capabilities.)
-     * This is 'Datetime.Event' on the Ticket model, because model queries for tickets that set "exclude_protected"
-     * should hide tickets for datetimes for events that have a password set.
-     *
-     * @var string |null
-     */
-    protected $model_chain_to_password = null;
-
-    /**
-     * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
-     * don't need it (particularly CPT models)
-     *
-     * @var bool
-     */
-    protected $_ignore_where_strategy = false;
-
-    /**
-     * String used in caps relating to this model. Eg, if the caps relating to this
-     * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
-     *
-     * @var string. If null it hasn't been initialized yet. If false then we
-     * have indicated capabilities don't apply to this
-     */
-    protected $_caps_slug = null;
-
-    /**
-     * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
-     * and next-level keys are capability names, and values are a
-     * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
-     * they specify which context to use (ie, frontend, backend, edit or delete)
-     * and then each capability in the corresponding sub-array that they're missing
-     * adds the where conditions onto the query.
-     *
-     * @var array
-     */
-    protected $_cap_restrictions = [
-        self::caps_read       => [],
-        self::caps_read_admin => [],
-        self::caps_edit       => [],
-        self::caps_delete     => [],
-    ];
-
-    /**
-     * Array defining which cap restriction generators to use to create default
-     * cap restrictions to put in EEM_Base::_cap_restrictions.
-     * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
-     * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
-     * automatically set this to false (not just null).
-     *
-     * @var EE_Restriction_Generator_Base[]
-     */
-    protected $_cap_restriction_generators = [];
-
-    /**
-     * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
-     * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
-     * maps to 'read' because when looking for relevant permissions we're going to use
-     * 'read' in teh capabilities names like 'ee_read_events' etc.
-     *
-     * @var array
-     */
-    protected $_cap_contexts_to_cap_action_map = [
-        self::caps_read       => 'read',
-        self::caps_read_admin => 'read',
-        self::caps_edit       => 'edit',
-        self::caps_delete     => 'delete',
-    ];
-
-    /**
-     * Timezone
-     * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
-     * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
-     * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
-     * EE_Datetime_Field data type will have access to it.
-     *
-     * @var string
-     */
-    protected $_timezone;
-
-
-    /**
-     * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
-     * multisite.
-     *
-     * @var int
-     */
-    protected static $_model_query_blog_id;
-
-    /**
-     * A copy of _fields, except the array keys are the model names pointed to by
-     * the field
-     *
-     * @var EE_Model_Field_Base[]
-     */
-    private $_cache_foreign_key_to_fields = [];
-
-    /**
-     * Cached list of all the fields on the model, indexed by their name
-     *
-     * @var EE_Model_Field_Base[]
-     */
-    private $_cached_fields = null;
-
-    /**
-     * Cached list of all the fields on the model, except those that are
-     * marked as only pertinent to the database
-     *
-     * @var EE_Model_Field_Base[]
-     */
-    private $_cached_fields_non_db_only = null;
-
-    /**
-     * A cached reference to the primary key for quick lookup
-     *
-     * @var EE_Model_Field_Base
-     */
-    private $_primary_key_field = null;
-
-    /**
-     * Flag indicating whether this model has a primary key or not
-     *
-     * @var boolean
-     */
-    protected $_has_primary_key_field = null;
-
-    /**
-     * array in the format:  [ FK alias => full PK ]
-     * where keys are local column name aliases for foreign keys
-     * and values are the fully qualified column name for the primary key they represent
-     *  ex:
-     *      [ 'Event.EVT_wp_user' => 'WP_User.ID' ]
-     *
-     * @var array $foreign_key_aliases
-     */
-    protected $foreign_key_aliases = [];
-
-    /**
-     * Whether or not this model is based off a table in WP core only (CPTs should set
-     * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
-     * This should be true for models that deal with data that should exist independent of EE.
-     * For example, if the model can read and insert data that isn't used by EE, this should be true.
-     * It would be false, however, if you could guarantee the model would only interact with EE data,
-     * even if it uses a WP core table (eg event and venue models set this to false for that reason:
-     * they can only read and insert events and venues custom post types, not arbitrary post types)
-     *
-     * @var boolean
-     */
-    protected $_wp_core_model = false;
-
-    /**
-     * @var bool stores whether this model has a password field or not.
-     * null until initialized by hasPasswordField()
-     */
-    protected $has_password_field;
-
-    /**
-     * @var EE_Password_Field|null Automatically set when calling getPasswordField()
-     */
-    protected $password_field;
-
-    /**
-     *    List of valid operators that can be used for querying.
-     * The keys are all operators we'll accept, the values are the real SQL
-     * operators used
-     *
-     * @var array
-     */
-    protected $_valid_operators = [
-        '='           => '=',
-        '<='          => '<=',
-        '<'           => '<',
-        '>='          => '>=',
-        '>'           => '>',
-        '!='          => '!=',
-        'LIKE'        => 'LIKE',
-        'like'        => 'LIKE',
-        'NOT_LIKE'    => 'NOT LIKE',
-        'not_like'    => 'NOT LIKE',
-        'NOT LIKE'    => 'NOT LIKE',
-        'not like'    => 'NOT LIKE',
-        'IN'          => 'IN',
-        'in'          => 'IN',
-        'NOT_IN'      => 'NOT IN',
-        'not_in'      => 'NOT IN',
-        'NOT IN'      => 'NOT IN',
-        'not in'      => 'NOT IN',
-        'between'     => 'BETWEEN',
-        'BETWEEN'     => 'BETWEEN',
-        'IS_NOT_NULL' => 'IS NOT NULL',
-        'is_not_null' => 'IS NOT NULL',
-        'IS NOT NULL' => 'IS NOT NULL',
-        'is not null' => 'IS NOT NULL',
-        'IS_NULL'     => 'IS NULL',
-        'is_null'     => 'IS NULL',
-        'IS NULL'     => 'IS NULL',
-        'is null'     => 'IS NULL',
-        'REGEXP'      => 'REGEXP',
-        'regexp'      => 'REGEXP',
-        'NOT_REGEXP'  => 'NOT REGEXP',
-        'not_regexp'  => 'NOT REGEXP',
-        'NOT REGEXP'  => 'NOT REGEXP',
-        'not regexp'  => 'NOT REGEXP',
-    ];
-
-    /**
-     * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
-     *
-     * @var array
-     */
-    protected $_in_style_operators = ['IN', 'NOT IN'];
-
-    /**
-     * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
-     * '12-31-2012'"
-     *
-     * @var array
-     */
-    protected $_between_style_operators = ['BETWEEN'];
-
-    /**
-     * Operators that work like SQL's like: input should be assumed to be a string, already prepared for a LIKE query.
-     *
-     * @var array
-     */
-    protected $_like_style_operators = ['LIKE', 'NOT LIKE'];
-
-    /**
-     * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
-     * on a join table.
-     *
-     * @var array
-     */
-    protected $_null_style_operators = ['IS NOT NULL', 'IS NULL'];
-
-    /**
-     * Allowed values for $query_params['order'] for ordering in queries
-     *
-     * @var array
-     */
-    protected $_allowed_order_values = ['asc', 'desc', 'ASC', 'DESC'];
-
-    /**
-     * When these are keys in a WHERE or HAVING clause, they are handled much differently
-     * than regular field names. It is assumed that their values are an array of WHERE conditions
-     *
-     * @var array
-     */
-    private $_logic_query_param_keys = ['not', 'and', 'or', 'NOT', 'AND', 'OR'];
-
-    /**
-     * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
-     * 'where', but 'where' clauses are so common that we thought we'd omit it
-     *
-     * @var array
-     */
-    private $_allowed_query_params = [
-        0,
-        'limit',
-        'order_by',
-        'group_by',
-        'having',
-        'force_join',
-        'order',
-        'on_join_limit',
-        'default_where_conditions',
-        'caps',
-        'extra_selects',
-        'exclude_protected',
-    ];
-
-    /**
-     * All the data types that can be used in $wpdb->prepare statements.
-     *
-     * @var array
-     */
-    private $_valid_wpdb_data_types = ['%d', '%s', '%f'];
-
-    /**
-     * @var EE_Registry $EE
-     */
-    protected $EE = null;
-
-
-    /**
-     * Property which, when set, will have this model echo out the next X queries to the page for debugging.
-     *
-     * @var int
-     */
-    protected $_show_next_x_db_queries = 0;
-
-    /**
-     * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
-     * it gets saved on this property as an instance of CustomSelects so those selections can be used in
-     * WHERE, GROUP_BY, etc.
-     *
-     * @var CustomSelects
-     */
-    protected $_custom_selections = [];
-
-    /**
-     * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
-     * caches every model object we've fetched from the DB on this request
-     *
-     * @var array
-     */
-    protected $_entity_map;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private static $loader;
-
-    /**
-     * indicates whether an EEM_Base child has already re-verified the DB
-     * is ok (we don't want to do it repetitively). Should be set to one the constants
-     * looking like EEM_Base::db_verified_*
-     *
-     * @var int - 0 = none, 1 = core, 2 = addons
-     */
-    protected static $_db_verification_level = EEM_Base::db_verified_none;
-
-
-    /**
-     * About all child constructors:
-     * they should define the _tables, _fields and _model_relations arrays.
-     * Should ALWAYS be called after child constructor.
-     * In order to make the child constructors to be as simple as possible, this parent constructor
-     * finalizes constructing all the object's attributes.
-     * Generally, rather than requiring a child to code
-     * $this->_tables = array(
-     *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
-     *        ...);
-     *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
-     * each EE_Table has a function to set the table's alias after the constructor, using
-     * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
-     * do something similar.
-     *
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = '')
-    {
-        // check that the model has not been loaded too soon
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The %1$s model can not be loaded before the "AHEE__EE_System__load_espresso_addons" hook has been called. This gives other addons a chance to extend this model.',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        /**
-         * Set blog id for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
-         */
-        if (empty(EEM_Base::$_model_query_blog_id)) {
-            EEM_Base::set_model_query_blog_id();
-        }
-        /**
-         * Filters the list of tables on a model. It is best to NOT use this directly and instead
-         * just use EE_Register_Model_Extension
-         *
-         * @var EE_Table_Base[] $_tables
-         */
-        $this->_tables = (array)apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
-        foreach ($this->_tables as $table_alias => $table_obj) {
-            /** @var $table_obj EE_Table_Base */
-            $table_obj->_construct_finalize_with_alias($table_alias);
-            if ($table_obj instanceof EE_Secondary_Table) {
-                /** @var $table_obj EE_Secondary_Table */
-                $table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
-            }
-        }
-        /**
-         * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
-         * EE_Register_Model_Extension
-         *
-         * @param EE_Model_Field_Base[] $_fields
-         */
-        $this->_fields = (array)apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
-        $this->_invalidate_field_caches();
-        foreach ($this->_fields as $table_alias => $fields_for_table) {
-            if (! array_key_exists($table_alias, $this->_tables)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
-                            'event_espresso'
-                        ),
-                        $table_alias,
-                        implode(",", $this->_fields)
-                    )
-                );
-            }
-            foreach ($fields_for_table as $field_name => $field_obj) {
-                /** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
-                // primary key field base has a slightly different _construct_finalize
-                /** @var $field_obj EE_Model_Field_Base */
-                $field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
-            }
-        }
-        // everything is related to Extra_Meta
-        if (get_class($this) !== 'EEM_Extra_Meta') {
-            // make extra meta related to everything, but don't block deleting things just
-            // because they have related extra meta info. For now just orphan those extra meta
-            // in the future we should automatically delete them
-            $this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
-        }
-        // and change logs
-        if (get_class($this) !== 'EEM_Change_Log') {
-            $this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
-        }
-        /**
-         * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
-         * EE_Register_Model_Extension
-         *
-         * @param EE_Model_Relation_Base[] $_model_relations
-         */
-        $this->_model_relations = (array)apply_filters(
-            'FHEE__' . get_class($this) . '__construct__model_relations',
-            $this->_model_relations
-        );
-        foreach ($this->_model_relations as $model_name => $relation_obj) {
-            /** @var $relation_obj EE_Model_Relation_Base */
-            $relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
-        }
-        foreach ($this->_indexes as $index_name => $index_obj) {
-            $index_obj->_construct_finalize($index_name, $this->get_this_model_name());
-        }
-        $this->set_timezone($timezone);
-        // finalize default where condition strategy, or set default
-        if (! $this->_default_where_conditions_strategy) {
-            // nothing was set during child constructor, so set default
-            $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
-        }
-        $this->_default_where_conditions_strategy->_finalize_construct($this);
-        if (! $this->_minimum_where_conditions_strategy) {
-            // nothing was set during child constructor, so set default
-            $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
-        }
-        $this->_minimum_where_conditions_strategy->_finalize_construct($this);
-        // if the cap slug hasn't been set, and we haven't set it to false on purpose
-        // to indicate to NOT set it, set it to the logical default
-        if ($this->_caps_slug === null) {
-            $this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
-        }
-        // initialize the standard cap restriction generators if none were specified by the child constructor
-        if (! empty($this->_cap_restriction_generators)) {
-            foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-                if (! isset($this->_cap_restriction_generators[ $cap_context ])) {
-                    $this->_cap_restriction_generators[ $cap_context ] = apply_filters(
-                        'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
-                        new EE_Restriction_Generator_Protected(),
-                        $cap_context,
-                        $this
-                    );
-                }
-            }
-        // }
-        // if ($this->_cap_restriction_generators !== false) {
-        // if there are cap restriction generators, use them to make the default cap restrictions
-            foreach ($this->_cap_restriction_generators as $context => $generator_object) {
-                if (! $generator_object) {
-                    continue;
-                }
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'Index "%1$s" in the model %2$s\'s _cap_restriction_generators is not a child of EE_Restriction_Generator_Base. It should be that or NULL.',
-                                'event_espresso'
-                            ),
-                            $context,
-                            $this->get_this_model_name()
-                        )
-                    );
-                }
-                $action = $this->cap_action_for_context($context);
-                if (! $generator_object->construction_finalized()) {
-                    $generator_object->_construct_finalize($this, $action);
-                }
-            }
-        }
-        do_action('AHEE__' . get_class($this) . '__construct__end');
-    }
-
-
-    /**
-     * Used to set the $_model_query_blog_id static property.
-     *
-     * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
-     *                      value for get_current_blog_id() will be used.
-     */
-    public static function set_model_query_blog_id($blog_id = 0)
-    {
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
-    }
-
-
-    /**
-     * Returns whatever is set as the internal $model_query_blog_id.
-     *
-     * @return int
-     */
-    public static function get_model_query_blog_id()
-    {
-        return EEM_Base::$_model_query_blog_id;
-    }
-
-
-    /**
-     * This function is a singleton method used to instantiate the Espresso_model object
-     *
-     * @param string $timezone        string representing the timezone we want to set for returned Date Time Strings
-     *                                (and any incoming timezone data that gets saved).
-     *                                Note this just sends the timezone info to the date time model field objects.
-     *                                Default is NULL
-     *                                (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @return static (as in the concrete child class)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function instance($timezone = '')
-    {
-        // check if instance of Espresso_model already exists
-        if (! static::$_instance instanceof static) {
-            // instantiate Espresso_model
-            static::$_instance = new static(
-                $timezone,
-                LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory')
-            );
-        }
-        // Espresso model object
-        return static::$_instance;
-    }
-
-
-    /**
-     * resets the model and returns it
-     *
-     * @param string $timezone
-     * @return EEM_Base|null (if the model was already instantiated, returns it, with
-     * all its properties reset; if it wasn't instantiated, returns null)
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function reset($timezone = '')
-    {
-        if (static::$_instance instanceof EEM_Base) {
-            // let's try to NOT swap out the current instance for a new one
-            // because if someone has a reference to it, we can't remove their reference
-            // so it's best to keep using the same reference, but change the original object
-            // reset all its properties to their original values as defined in the class
-            $r                 = new ReflectionClass(get_class(static::$_instance));
-            $static_properties = $r->getStaticProperties();
-            foreach ($r->getDefaultProperties() as $property => $value) {
-                // don't set instance to null like it was originally,
-                // but it's static anyways, and we're ignoring static properties (for now at least)
-                if (! isset($static_properties[ $property ])) {
-                    static::$_instance->{$property} = $value;
-                }
-            }
-            EEH_DTT_Helper::resetDefaultTimezoneString();
-            // and then directly call its constructor again, like we would if we were creating a new one
-            static::$_instance->__construct(
-                $timezone,
-                LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory')
-            );
-            return static::instance();
-        }
-        return null;
-    }
-
-
-    /**
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function getLoader()
-    {
-        if (! EEM_Base::$loader instanceof LoaderInterface) {
-            EEM_Base::$loader = LoaderFactory::getLoader();
-        }
-        return EEM_Base::$loader;
-    }
-
-
-    /**
-     * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
-     *
-     * @param boolean $translated return localized strings or JUST the array.
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_array($translated = false)
-    {
-        if (! array_key_exists('Status', $this->_model_relations)) {
-            return [];
-        }
-        $model_name   = $this->get_this_model_name();
-        $status_type  = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
-        $statuses      = EEM_Status::instance()->get_all([['STS_type' => $status_type]]);
-        $status_array = [];
-        foreach ($statuses as $status) {
-            $status_array[ $status->ID() ] = $status->get('STS_code');
-        }
-        return $translated
-            ? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
-            : $status_array;
-    }
-
-
-    /**
-     * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
-     *
-     * @param array $query_params             see github link below for more info
-     * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
-     *                                        from EE_Base_Class[], use get_all_wpdb_results(). Array keys are object
-     *                                        IDs (if there is a primary key on the model. if not, numerically indexed)
-     *                                        Some full examples: get 10 transactions which have Scottish attendees:
-     *                                        EEM_Transaction::instance()->get_all( array( array(
-     *                                        'OR'=>array(
-     *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
-     *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
-     *                                        )
-     *                                        ),
-     *                                        'limit'=>10,
-     *                                        'group_by'=>'TXN_ID'
-     *                                        ));
-     *                                        get all the answers to the question titled "shirt size" for event with id
-     *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
-     *                                        'Question.QST_display_text'=>'shirt size',
-     *                                        'Registration.Event.EVT_ID'=>12
-     *                                        ),
-     *                                        'order_by'=>array('ANS_value'=>'ASC')
-     *                                        ));
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     *                                        or if you have the development copy of EE you can view this at the path:
-     *                                        /docs/G--Model-System/model-query-params.md
-     */
-    public function get_all($query_params = [])
-    {
-        if (
-            isset($query_params['limit'])
-            && ! isset($query_params['group_by'])
-        ) {
-            $query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
-        }
-        return $this->_create_objects($this->_get_all_wpdb_results($query_params));
-    }
-
-
-    /**
-     * Modifies the query parameters so we only get back model objects
-     * that "belong" to the current user
-     *
-     * @param array $query_params see github link below for more info
-     * @return array
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function alter_query_params_to_only_include_mine($query_params = [])
-    {
-        $wp_user_field_name = $this->wp_user_field_name();
-        if ($wp_user_field_name) {
-            $query_params[0][ $wp_user_field_name ] = get_current_user_id();
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * Returns the name of the field's name that points to the WP_User table
-     *  on this model (or follows the _model_chain_to_wp_user and uses that model's
-     * foreign key to the WP_User table)
-     *
-     * @return string|boolean string on success, boolean false when there is no
-     * foreign key to the WP_User table
-     * @throws ReflectionException
-     */
-    public function wp_user_field_name()
-    {
-        try {
-            if (! empty($this->_model_chain_to_wp_user)) {
-                $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
-                $last_model_name              = end($models_to_follow_to_wp_users);
-                $model_with_fk_to_wp_users    = EE_Registry::instance()->load_model($last_model_name);
-                $model_chain_to_wp_user       = $this->_model_chain_to_wp_user . '.';
-            } else {
-                $model_with_fk_to_wp_users = $this;
-                $model_chain_to_wp_user    = '';
-            }
-            $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
-        } catch (EE_Error $e) {
-            return false;
-        }
-    }
-
-
-    /**
-     * Returns the _model_chain_to_wp_user string, which indicates which related model
-     * (or transiently-related model) has a foreign key to the wp_users table;
-     * useful for finding if model objects of this type are 'owned' by the current user.
-     * This is an empty string when the foreign key is on this model and when it isn't,
-     * but is only non-empty when this model's ownership is indicated by a RELATED model
-     * (or transiently-related model)
-     *
-     * @return string
-     */
-    public function model_chain_to_wp_user()
-    {
-        return $this->_model_chain_to_wp_user;
-    }
-
-
-    /**
-     * Whether this model is 'owned' by a specific wordpress user (even indirectly,
-     * like how registrations don't have a foreign key to wp_users, but the
-     * events they are for are), or is unrelated to wp users.
-     * generally available
-     *
-     * @return boolean
-     */
-    public function is_owned()
-    {
-        if ($this->model_chain_to_wp_user()) {
-            return true;
-        }
-        try {
-            $this->get_foreign_key_to('WP_User');
-            return true;
-        } catch (EE_Error $e) {
-            return false;
-        }
-    }
-
-
-    /**
-     * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
-     * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
-     * the model)
-     *
-     * @param array  $query_params
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
-     *                                  fields on the model, and the models we joined to in the query. However, you can
-     *                                  override this and set the select to "*", or a specific column name, like
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
-     *                                  the aliases used to refer to this selection, and values are to be
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
-     * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _get_all_wpdb_results($query_params = [], $output = ARRAY_A, $columns_to_select = null)
-    {
-        $this->_custom_selections = $this->getCustomSelection($query_params, $columns_to_select);
-        $model_query_info         = $this->_create_model_query_info_carrier($query_params);
-        $select_expressions       = $columns_to_select === null
-            ? $this->_construct_default_select_sql($model_query_info)
-            : '';
-        if ($this->_custom_selections instanceof CustomSelects) {
-            $custom_expressions = $this->_custom_selections->columnsToSelectExpression();
-            $select_expressions .= $select_expressions
-                ? ', ' . $custom_expressions
-                : $custom_expressions;
-        }
-
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
-        return $this->_do_wpdb_query('get_results', [$SQL, $output]);
-    }
-
-
-    /**
-     * Get a CustomSelects object if the $query_params or $columns_to_select allows for it.
-     * Note: $query_params['extra_selects'] will always override any $columns_to_select values. It is the preferred
-     * method of including extra select information.
-     *
-     * @param array             $query_params
-     * @param null|array|string $columns_to_select
-     * @return null|CustomSelects
-     * @throws InvalidArgumentException
-     */
-    protected function getCustomSelection(array $query_params, $columns_to_select = null)
-    {
-        if (! isset($query_params['extra_selects']) && $columns_to_select === null) {
-            return null;
-        }
-        $selects = isset($query_params['extra_selects']) ? $query_params['extra_selects'] : $columns_to_select;
-        $selects = is_string($selects) ? explode(',', $selects) : $selects;
-        return new CustomSelects($selects);
-    }
-
-
-    /**
-     * Gets an array of rows from the database just like $wpdb->get_results would,
-     * but you can use the model query params to more easily
-     * take care of joins, field preparation etc.
-     *
-     * @param array  $query_params
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
-     *                                  fields on the model, and the models we joined to in the query. However, you can
-     *                                  override this and set the select to "*", or a specific column name, like
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
-     *                                  the aliases used to refer to this selection, and values are to be
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
-     * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
-     * @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 get_all_wpdb_results($query_params = [], $output = ARRAY_A, $columns_to_select = null)
-    {
-        return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
-    }
-
-
-    /**
-     * For creating a custom select statement
-     *
-     * @param array|string $columns_to_select either a string to be inserted directly as the select statement,
-     *                                        or an array where keys are aliases, and values are arrays where 0=>the
-     *                                        selection SQL, and 1=>is the datatype
-     * @return string
-     * @throws EE_Error
-     */
-    private function _construct_select_from_input($columns_to_select)
-    {
-        if (is_array($columns_to_select)) {
-            $select_sql_array = [];
-            foreach ($columns_to_select as $alias => $selection_and_datatype) {
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                "Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
-                                'event_espresso'
-                            ),
-                            $selection_and_datatype,
-                            $alias
-                        )
-                    );
-                }
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types, true)) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                "Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
-                                'event_espresso'
-                            ),
-                            $selection_and_datatype[1],
-                            $selection_and_datatype[0],
-                            $alias,
-                            implode(', ', $this->_valid_wpdb_data_types)
-                        )
-                    );
-                }
-                $select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
-            }
-            $columns_to_select_string = implode(', ', $select_sql_array);
-        } else {
-            $columns_to_select_string = $columns_to_select;
-        }
-        return $columns_to_select_string;
-    }
-
-
-    /**
-     * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function primary_key_name()
-    {
-        return $this->get_primary_key_field()->get_name();
-    }
-
-
-    /**
-     * Gets a single item for this model from the DB, given only its ID (or null if none is found).
-     * If there is no primary key on this model, $id is treated as primary key string
-     *
-     * @param mixed $id int or string, depending on the type of the model's primary key
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one_by_ID($id)
-    {
-        if ($this->get_from_entity_map($id)) {
-            return $this->get_from_entity_map($id);
-        }
-        $model_object = $this->get_one(
-            $this->alter_query_params_to_restrict_by_ID(
-                $id,
-                ['default_where_conditions' => EEM_Base::default_where_conditions_minimum_all]
-            )
-        );
-        $className = $this->_get_class_name();
-        if ($model_object instanceof $className) {
-            // make sure valid objects get added to the entity map
-            // so that the next call to this method doesn't trigger another trip to the db
-            $this->add_to_entity_map($model_object);
-        }
-        return $model_object;
-    }
-
-
-    /**
-     * Alters query parameters to only get items with this ID are returned.
-     * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
-     * or could just be a simple primary key ID
-     *
-     * @param int   $id
-     * @param array $query_params see github link below for more info
-     * @return array of normal query params,
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function alter_query_params_to_restrict_by_ID($id, $query_params = [])
-    {
-        if (! isset($query_params[0])) {
-            $query_params[0] = [];
-        }
-        $conditions_from_id = $this->parse_index_primary_key_string($id);
-        if ($conditions_from_id === null) {
-            $query_params[0][ $this->primary_key_name() ] = $id;
-        } else {
-            // no primary key, so the $id must be from the get_index_primary_key_string()
-            $query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
-     * array. If no item is found, null is returned.
-     *
-     * @param array $query_params like EEM_Base's $query_params variable.
-     * @return EE_Base_Class|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one(array $query_params = [])
-    {
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong(
-                'EEM_Base::get_one',
-                sprintf(
-                    esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = [];
-        }
-        $query_params['limit'] = 1;
-        $items                 = $this->get_all($query_params);
-        if (empty($items)) {
-            return null;
-        }
-        return array_shift($items);
-    }
-
-
-    /**
-     * Returns the next x number of items in sequence from the given value as
-     * found in the database matching the given query conditions.
-     *
-     * @param mixed $current_field_value    Value used for the reference point.
-     * @param null  $field_to_order_by      What field is used for the
-     *                                      reference point.
-     * @param int   $limit                  How many to return.
-     * @param array $query_params           Extra 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 EE_Base_Class[]|array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function next_x(
-        $current_field_value,
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = [],
-        $columns_to_select = null
-    ) {
-        return $this->_get_consecutive(
-            $current_field_value,
-            '>',
-            $field_to_order_by,
-            $limit,
-            $query_params,
-            $columns_to_select
-        );
-    }
-
-
-    /**
-     * Returns the previous x number of items in sequence from the given value
-     * as found in the database matching the given query conditions.
-     *
-     * @param mixed $current_field_value    Value used for the reference point.
-     * @param null  $field_to_order_by      What field is used for the
-     *                                      reference point.
-     * @param int   $limit                  How many to return.
-     * @param array $query_params           Extra 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 EE_Base_Class[]|array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function previous_x(
-        $current_field_value,
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = [],
-        $columns_to_select = null
-    ) {
-        return $this->_get_consecutive(
-            $current_field_value,
-            '<',
-            $field_to_order_by,
-            $limit,
-            $query_params,
-            $columns_to_select
-        );
-    }
-
-
-    /**
-     * Returns the next item in sequence from the given value as found in the
-     * database matching the given query conditions.
-     *
-     * @param mixed $current_field_value    Value used for the reference point.
-     * @param null  $field_to_order_by      What field is used for the
-     *                                      reference point.
-     * @param array $query_params           Extra 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 columns you
-     *                                      want and a single array indexed by
-     *                                      the columns will be returned.
-     * @return EE_Base_Class|null|array()
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function next(
-        $current_field_value,
-        $field_to_order_by = null,
-        $query_params = [],
-        $columns_to_select = null
-    ) {
-        $results = $this->_get_consecutive(
-            $current_field_value,
-            '>',
-            $field_to_order_by,
-            1,
-            $query_params,
-            $columns_to_select
-        );
-        return empty($results) ? null : reset($results);
-    }
-
-
-    /**
-     * Returns the previous item in sequence from the given value as found in
-     * the database matching the given query conditions.
-     *
-     * @param mixed $current_field_value    Value used for the reference point.
-     * @param null  $field_to_order_by      What field is used for the
-     *                                      reference point.
-     * @param array $query_params           Extra 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 columns you
-     *                                      want and a single array indexed by
-     *                                      the columns will be returned.
-     * @return EE_Base_Class|null|array()
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function previous(
-        $current_field_value,
-        $field_to_order_by = null,
-        $query_params = [],
-        $columns_to_select = null
-    ) {
-        $results = $this->_get_consecutive(
-            $current_field_value,
-            '<',
-            $field_to_order_by,
-            1,
-            $query_params,
-            $columns_to_select
-        );
-        return empty($results) ? null : reset($results);
-    }
-
-
-    /**
-     * Returns the a consecutive number of items in sequence from the given
-     * value as found in the database matching the given query conditions.
-     *
-     * @param mixed  $current_field_value   Value used for the reference point.
-     * @param string $operand               What operand is used for the sequence.
-     * @param string $field_to_order_by     What field is used for the reference point.
-     * @param int    $limit                 How many to return.
-     * @param array  $query_params          Extra 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 EE_Base_Class[]|array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_consecutive(
-        $current_field_value,
-        $operand = '>',
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = [],
-        $columns_to_select = null
-    ) {
-        // if $field_to_order_by is empty then let's assume we're ordering by the primary key.
-        if (empty($field_to_order_by)) {
-            if ($this->has_primary_key_field()) {
-                $field_to_order_by = $this->get_primary_key_field()->get_name();
-            } else {
-                if (WP_DEBUG) {
-                    throw new EE_Error(
-                        esc_html__(
-                            'EEM_Base::_get_consecutive() has been called with no $field_to_order_by argument and there is no primary key on the field.  Please provide the field you would like to use as the base for retrieving the next item(s).',
-                            'event_espresso'
-                        )
-                    );
-                }
-                EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
-                return [];
-            }
-        }
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong(
-                'EEM_Base::_get_consecutive',
-                sprintf(
-                    esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = [];
-        }
-        // let's add the where query param for consecutive look up.
-        $query_params[0][ $field_to_order_by ] = [$operand, $current_field_value];
-        $query_params['limit']                 = $limit;
-        // set direction
-        $incoming_orderby         = isset($query_params['order_by']) ? (array)$query_params['order_by'] : [];
-        $query_params['order_by'] = $operand === '>'
-            ? [$field_to_order_by => 'ASC'] + $incoming_orderby
-            : [$field_to_order_by => 'DESC'] + $incoming_orderby;
-        // if $columns_to_select is empty then that means we're returning EE_Base_Class objects
-        if (empty($columns_to_select)) {
-            return $this->get_all($query_params);
-        }
-        // getting just the fields
-        return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
-    }
-
-
-    /**
-     * This sets the _timezone property after model object has been instantiated.
-     *
-     * @param string|null $timezone valid PHP DateTimeZone timezone string
-     */
-    public function set_timezone($timezone = '')
-    {
-        static $set_in_progress = false;
-        // if incoming timezone string is empty, then use the existing
-        $valid_timezone = ! empty($timezone) && $timezone !== $this->_timezone
-            ? EEH_DTT_Helper::get_valid_timezone_string($timezone)
-            : $this->_timezone;
-        // do NOT set the timezone if we are already in the process of setting the timezone
-        // OR the existing timezone is already set and the incoming value is nothing (which gets set to default TZ)
-        // OR the existing timezone is already set and the validated value is the same as the existing timezone
-        if (
-            $set_in_progress
-            || (
-                ! empty($this->_timezone)
-                && (
-                    empty($timezone) || $valid_timezone === $this->_timezone
-                )
-            )
-        ) {
-            return;
-        }
-        $set_in_progress = true;
-        $this->_timezone = $valid_timezone ?: EEH_DTT_Helper::get_valid_timezone_string();
-        // note we need to loop through relations and set the timezone on those objects as well.
-        foreach ($this->_model_relations as $relation) {
-            $relation->set_timezone($this->_timezone);
-        }
-        // and finally we do the same for any datetime fields
-        foreach ($this->_fields as $field) {
-            if ($field instanceof EE_Datetime_Field) {
-                $field->set_timezone($this->_timezone);
-            }
-        }
-        $set_in_progress = false;
-    }
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string
-     */
-    public function get_timezone()
-    {
-        if (empty($this->_timezone)) {
-            $this->set_timezone();
-        }
-        return $this->_timezone;
-    }
-
-
-    /**
-     * This returns the date formats set for the given field name and also ensures that
-     * $this->_timezone property is set correctly.
-     *
-     * @param string $field_name The name of the field the formats are being retrieved for.
-     * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
-     * @return array formats in an array with the date format first, and the time format last.
-     * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
-     * @since 4.6.x
-     */
-    public function get_formats_for($field_name, $pretty = false)
-    {
-        $field_settings = $this->field_settings_for($field_name);
-        // if not a valid EE_Datetime_Field then throw error
-        if (! $field_settings instanceof EE_Datetime_Field) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The field sent into EEM_Base::get_formats_for (%s) is not registered as a EE_Datetime_Field. Please check the spelling and make sure you are submitting the right field name to retrieve date_formats for.',
-                        'event_espresso'
-                    ),
-                    $field_name
-                )
-            );
-        }
-        // while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on the field.
-        $field_timezone = $field_settings->get_timezone();
-        if (empty($this->_timezone && $field_timezone)) {
-            $this->set_timezone();
-        } else {
-            // or vice versa if the field TZ isn't set
-            $model_timezone = $this->get_timezone();
-            $field_settings->set_timezone($model_timezone);
-        }
-
-        return [$field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty)];
-    }
-
-
-    /**
-     * This returns the current time in a format setup for a query on this model.
-     * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
-     * it will return:
-     *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field
-     *    for the given field for NOW
-     *  - or a unix timestamp (equivalent to time())
-     * Note: When requesting a formatted string, if the date or time format doesn't include seconds, for example,
-     * the time returned, because it uses that format, will also NOT include seconds. For this reason, if you want
-     * the time returned to be the current time down to the exact second, set $timestamp to true.
-     *
-     * @param string $field_name    The field the current time is needed for.
-     * @param bool $timestamp       True means to return a unix timestamp.
-     *                              Otherwise a formatted string matching the set format for the field
-     *                              in the set timezone will be returned.
-     * @param string $what          Whether to return the string in just the time format, the date format, or both.
-     * @return string               If the given field_name is not of the EE_Datetime_Field type,
-     *                              then an EE_Error exception is triggered.
-     * @throws EE_Error             If the given field_name is not of the EE_Datetime_Field type.
-     * @throws Exception
-     * @since 4.6.x
-     */
-    public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
-    {
-        $formats  = $this->get_formats_for($field_name);
-        $DateTime = new DateTime("now", new DateTimeZone($this->get_timezone()));
-        if ($timestamp) {
-            return $DateTime->format('U');
-        }
-        // not returning timestamp, so return formatted string in timezone.
-        switch ($what) {
-            case 'time':
-                return $DateTime->format($formats[1]);
-            case 'date':
-                return $DateTime->format($formats[0]);
-            default:
-                return $DateTime->format(implode(' ', $formats));
-        }
-    }
-
-
-    /**
-     * This receives a time string for a given field and ensures that it is setup to match what the internal settings
-     * for the model are.  Returns a DateTime object.
-     * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
-     * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
-     * ignored.
-     *
-     * @param string $field_name    The field being setup.
-     * @param string $timestring    The date time string being used.
-     * @param string $format        The format for the time string.
-     * @param string $timezone      By default, it is assumed the incoming time string is in timezone for
-     *                              the blog.  If this is not the case, then it can be specified here.
-     *                              If incoming format is 'U', this is ignored.
-     * @return DbSafeDateTime
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function convert_datetime_for_query($field_name, $timestring, $format, $timezone = '')
-    {
-        // just using this to ensure the timezone is set correctly internally
-        $this->get_formats_for($field_name);
-        $timezone         = ! empty($timezone) ? $timezone : EEH_DTT_Helper::get_timezone();
-        $db_safe_datetime = DbSafeDateTime::createFromFormat($format, $timestring, new DateTimeZone($timezone));
-        EEH_DTT_Helper::setTimezone($db_safe_datetime, new DateTimeZone($this->get_timezone()));
-        return $db_safe_datetime;
-    }
-
-
-    /**
-     * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
-     *
-     * @return EE_Table_Base[]
-     */
-    public function get_tables()
-    {
-        return $this->_tables;
-    }
-
-
-    /**
-     * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
-     * also updates all the model objects, where the criteria expressed in $query_params are met..
-     * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
-     * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
-     * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
-     * model object with EVT_ID = 1
-     * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
-     * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
-     * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
-     * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
-     * are not specified)
-     *
-     * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
-     *                                         columns!), values are strings, integers, floats, and maybe arrays if
-     *                                         they
-     *                                         are to be serialized. Basically, the values are what you'd expect to be
-     *                                         values on the model, NOT necessarily what's in the DB. For example, if
-     *                                         we wanted to update only the TXN_details on any Transactions where its
-     *                                         ID=34, we'd use this method as follows:
-     *                                         EEM_Transaction::instance()->update(
-     *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
-     *                                         array(array('TXN_ID'=>34)));
-     * @param array   $query_params            Eg, consider updating Question's QST_admin_label field is of type
-     *                                         Simple_HTML. If you use this function to update that field to $new_value
-     *                                         = (note replace 8's with appropriate opening and closing tags in the
-     *                                         following example)"8script8alert('I hack all');8/script88b8boom
-     *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
-     *                                         TRUE, it is assumed that you've already called
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
-     *                                         malicious javascript. However, if
-     *                                         $values_already_prepared_by_model_object is left as FALSE, then
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
-     *                                         and every other field, before insertion. We provide this parameter
-     *                                         because model objects perform their prepare_for_set function on all
-     *                                         their values, and so don't need to be called again (and in many cases,
-     *                                         shouldn't be called again. Eg: if we escape HTML characters in the
-     *                                         prepare_for_set method...)
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
-     *                                         in this model's entity map according to $fields_n_values that match
-     *                                         $query_params. This obviously has some overhead, so you can disable it
-     *                                         by setting this to FALSE, but be aware that model objects being used
-     *                                         could get out-of-sync with the database
-     * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
-     *                                         rows affected which *could* include 0 which DOES NOT mean the query was
-     *                                         bad)
-     * @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 update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
-    {
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong(
-                'EEM_Base::update',
-                sprintf(
-                    esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = [];
-        }
-        /**
-         * Action called before a model update call has been made.
-         *
-         * @param EEM_Base $model
-         * @param array    $fields_n_values the updated fields and their new values
-         * @param array    $query_params
-         * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-         */
-        do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
-        /**
-         * Filters the fields about to be updated given the query parameters. You can provide the
-         * $query_params to $this->get_all() to find exactly which records will be updated
-         *
-         * @param array    $fields_n_values fields and their new values
-         * @param EEM_Base $model           the model being queried
-         * @param array    $query_params
-         * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-         */
-        $fields_n_values = (array)apply_filters(
-            'FHEE__EEM_Base__update__fields_n_values',
-            $fields_n_values,
-            $this,
-            $query_params
-        );
-        // need to verify that, for any entry we want to update, there are entries in each secondary table.
-        // to do that, for each table, verify that it's PK isn't null.
-        $tables = $this->get_tables();
-        // and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
-        // NOTE: we should make this code more efficient by NOT querying twice
-        // before the real update, but that needs to first go through ALPHA testing
-        // as it's dangerous. says Mike August 8 2014
-        // we want to make sure the default_where strategy is ignored
-        $this->_ignore_where_strategy = true;
-        $wpdb_select_results          = $this->_get_all_wpdb_results($query_params);
-        foreach ($wpdb_select_results as $wpdb_result) {
-            // type cast stdClass as array
-            $wpdb_result = (array)$wpdb_result;
-            // get the model object's PK, as we'll want this if we need to insert a row into secondary tables
-            if ($this->has_primary_key_field()) {
-                $main_table_pk_value = $wpdb_result[ $this->get_primary_key_field()->get_qualified_column() ];
-            } else {
-                // if there's no primary key, we basically can't support having a 2nd table on the model (we could but it would be lots of work)
-                $main_table_pk_value = null;
-            }
-            // if there are more than 1 tables, we'll want to verify that each table for this model has an entry in the other tables
-            // and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
-            if (count($tables) > 1) {
-                // foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
-                // in that table, and so we'll want to insert one
-                foreach ($tables as $table_obj) {
-                    $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
-                    // if there is no private key for this table on the results, it means there's no entry
-                    // in this table, right? so insert a row in the current table, using any fields available
-                    if (
-                    ! (array_key_exists($this_table_pk_column, $wpdb_result)
-                       && $wpdb_result[ $this_table_pk_column ])
-                    ) {
-                        $success = $this->_insert_into_specific_table(
-                            $table_obj,
-                            $fields_n_values,
-                            $main_table_pk_value
-                        );
-                        // if we died here, report the error
-                        if (! $success) {
-                            return false;
-                        }
-                    }
-                }
-            }
-            // let's make sure default_where strategy is followed now
-            $this->_ignore_where_strategy = false;
-        }
-        // if we want to keep model objects in sync, AND
-        // if this wasn't called from a model object (to update itself)
-        // then we want to make sure we keep all the existing
-        // model objects in sync with the db
-        if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
-            if ($this->has_primary_key_field()) {
-                $model_objs_affected_ids = $this->get_col($query_params);
-            } else {
-                // we need to select a bunch of columns and then combine them into the the "index primary key string"s
-                $models_affected_key_columns = $this->_get_all_wpdb_results($query_params);
-                $model_objs_affected_ids     = [];
-                foreach ($models_affected_key_columns as $row) {
-                    $combined_index_key                             = $this->get_index_primary_key_string($row);
-                    $model_objs_affected_ids[ $combined_index_key ] = $combined_index_key;
-                }
-            }
-            if (! $model_objs_affected_ids) {
-                // wait wait wait- if nothing was affected let's stop here
-                return 0;
-            }
-            foreach ($model_objs_affected_ids as $id) {
-                $model_obj_in_entity_map = $this->get_from_entity_map($id);
-                if ($model_obj_in_entity_map) {
-                    foreach ($fields_n_values as $field => $new_value) {
-                        $model_obj_in_entity_map->set($field, $new_value);
-                    }
-                }
-            }
-            // if there is a primary key on this model, we can now do a slight optimization
-            if ($this->has_primary_key_field()) {
-                // we already know what we want to update. So let's make the query simpler so it's a little more efficient
-                $query_params = [
-                    [$this->primary_key_name() => ['IN', $model_objs_affected_ids]],
-                    'limit'                    => count($model_objs_affected_ids),
-                    'default_where_conditions' => EEM_Base::default_where_conditions_none,
-                ];
-            }
-        }
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
-        $SQL              = "UPDATE " . $model_query_info->get_full_join_sql()
-                            . " SET " . $this->_construct_update_sql($fields_n_values)
-                            . $model_query_info->get_where_sql();
-        // note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
-        $rows_affected    = $this->_do_wpdb_query('query', [$SQL]);
-        /**
-         * Action called after a model update call has been made.
-         *
-         * @param EEM_Base $model
-         * @param array    $fields_n_values the updated fields and their new values
-         * @param array    $query_params
-         * @param int      $rows_affected
-         * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-         */
-        do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
-        return $rows_affected;// how many supposedly got updated
-    }
-
-
-    /**
-     * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
-     * are teh values of the field specified (or by default the primary key field)
-     * that matched the query params. Note that you should pass the name of the
-     * model FIELD, not the database table's column name.
-     *
-     * @param array  $query_params
-     * @param string $field_to_select
-     * @return array just like $wpdb->get_col()
-     * @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 get_col($query_params = [], $field_to_select = null)
-    {
-        if ($field_to_select) {
-            $field = $this->field_settings_for($field_to_select);
-        } elseif ($this->has_primary_key_field()) {
-            $field = $this->get_primary_key_field();
-        } else {
-            $field_settings = $this->field_settings();
-            // no primary key, just grab the first column
-            $field = reset($field_settings);
-        }
-        $model_query_info   = $this->_create_model_query_info_carrier($query_params);
-        $select_expressions = $field->get_qualified_column();
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
-        return $this->_do_wpdb_query('get_col', [$SQL]);
-    }
-
-
-    /**
-     * Returns a single column value for a single row from the database
-     *
-     * @param array  $query_params
-     * @param string $field_to_select
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see EEM_Base::get_col()
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_var($query_params = [], $field_to_select = null)
-    {
-        $query_params['limit'] = 1;
-        $col                   = $this->get_col($query_params, $field_to_select);
-        if (! empty($col)) {
-            return reset($col);
-        }
-        return null;
-    }
-
-
-    /**
-     * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
-     * time?', Question.desc='what do you think?'..." Values are filtered through wpdb->prepare to avoid against SQL
-     * injection, but currently no further filtering is done
-     *
-     * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
-     *                               be updated to in the DB
-     * @return string of SQL
-     * @throws EE_Error
-     * @global      $wpdb
-     */
-    public function _construct_update_sql($fields_n_values)
-    {
-        global $wpdb;
-        $cols_n_values = [];
-        foreach ($fields_n_values as $field_name => $value) {
-            $field_obj = $this->field_settings_for($field_name);
-            // if the value is NULL, we want to assign the value to that.
-            // wpdb->prepare doesn't really handle that properly
-            $prepared_value  = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
-            $value_sql       = $prepared_value === null
-                ? 'NULL'
-                : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
-        }
-        return implode(",", $cols_n_values);
-    }
-
-
-    /**
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
-     * Performs a HARD delete, meaning the database row should always be removed,
-     * not just have a flag field on it switched
-     * Wrapper for EEM_Base::delete_permanently()
-     *
-     * @param mixed   $id
-     * @param boolean $allow_blocking
-     * @return int the number of rows deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_permanently_by_ID($id, $allow_blocking = true)
-    {
-        return $this->delete_permanently(
-            [
-                [$this->get_primary_key_field()->get_name() => $id],
-                'limit' => 1,
-            ],
-            $allow_blocking
-        );
-    }
-
-
-    /**
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
-     * Wrapper for EEM_Base::delete()
-     *
-     * @param mixed   $id
-     * @param boolean $allow_blocking
-     * @return int the number of rows deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_by_ID($id, $allow_blocking = true)
-    {
-        return $this->delete(
-            [
-                [$this->get_primary_key_field()->get_name() => $id],
-                'limit' => 1,
-            ],
-            $allow_blocking
-        );
-    }
-
-
-    /**
-     * Identical to delete_permanently, but does a "soft" delete if possible,
-     * meaning if the model has a field that indicates its been "trashed" or
-     * "soft deleted", we will just set that instead of actually deleting the rows.
-     *
-     * @param array   $query_params
-     * @param boolean $allow_blocking
-     * @return int how many rows got deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see EEM_Base::delete_permanently
-     */
-    public function delete($query_params, $allow_blocking = true)
-    {
-        return $this->delete_permanently($query_params, $allow_blocking);
-    }
-
-
-    /**
-     * Deletes the model objects that meet the query params. Note: this method is overridden
-     * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
-     * as archived, not actually deleted
-     *
-     * @param array   $query_params
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
-     *                                that blocks it (ie, there' sno other data that depends on this data); if false,
-     *                                deletes regardless of other objects which may depend on it. Its generally
-     *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
-     *                                DB
-     * @return int how many rows got deleted
-     * @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 delete_permanently($query_params, $allow_blocking = true)
-    {
-        /**
-         * Action called just before performing a real deletion query. You can use the
-         * model and its $query_params to find exactly which items will be deleted
-         *
-         * @param EEM_Base $model
-         * @param array    $query_params
-         * @param boolean  $allow_blocking whether or not to allow related model objects
-         *                                 to block (prevent) this deletion
-         * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-         */
-        do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
-        // some MySQL databases may be running safe mode, which may restrict
-        // deletion if there is no KEY column used in the WHERE statement of a deletion.
-        // to get around this, we first do a SELECT, get all the IDs, and then run another query
-        // to delete them
-        $items_for_deletion           = $this->_get_all_wpdb_results($query_params);
-        $columns_and_ids_for_deleting = $this->_get_ids_for_delete($items_for_deletion, $allow_blocking);
-        $deletion_where_query_part    = $this->_build_query_part_for_deleting_from_columns_and_values(
-            $columns_and_ids_for_deleting
-        );
-        /**
-         * Allows client code to act on the items being deleted before the query is actually executed.
-         *
-         * @param EEM_Base $this                            The model instance being acted on.
-         * @param array    $query_params                    The incoming array of query parameters influencing what gets deleted.
-         * @param bool     $allow_blocking                  @see param description in method phpdoc block.
-         * @param array    $columns_and_ids_for_deleting    An array indicating what entities will get removed as
-         *                                                  derived from the incoming query parameters.
-         * @see details on the structure of this array in the phpdocs
-         *                                                  for the `_get_ids_for_delete_method`
-         *
-         */
-        do_action(
-            'AHEE__EEM_Base__delete__before_query',
-            $this,
-            $query_params,
-            $allow_blocking,
-            $columns_and_ids_for_deleting
-        );
-        if ($deletion_where_query_part) {
-            $model_query_info = $this->_create_model_query_info_carrier($query_params);
-            $table_aliases    = implode(', ', array_keys($this->_tables));
-            $SQL              = "DELETE " . $table_aliases
-                                . " FROM " . $model_query_info->get_full_join_sql()
-                                . " WHERE " . $deletion_where_query_part;
-            $rows_deleted     = $this->_do_wpdb_query('query', [$SQL]);
-        } else {
-            $rows_deleted = 0;
-        }
-
-        // Next, make sure those items are removed from the entity map; if they could be put into it at all; and if
-        // there was no error with the delete query.
-        if (
-            $this->has_primary_key_field()
-            && $rows_deleted !== false
-            && isset($columns_and_ids_for_deleting[ $this->get_primary_key_field()->get_qualified_column() ])
-        ) {
-            $ids_for_removal = $columns_and_ids_for_deleting[ $this->get_primary_key_field()->get_qualified_column() ];
-            foreach ($ids_for_removal as $id) {
-                if (isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])) {
-                    unset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]);
-                }
-            }
-
-            // delete any extra meta attached to the deleted entities but ONLY if this model is not an instance of
-            // `EEM_Extra_Meta`.  In other words we want to prevent recursion on EEM_Extra_Meta::delete_permanently calls
-            // unnecessarily.  It's very unlikely that users will have assigned Extra Meta to Extra Meta
-            // (although it is possible).
-            // Note this can be skipped by using the provided filter and returning false.
-            if (
-            apply_filters(
-                'FHEE__EEM_Base__delete_permanently__dont_delete_extra_meta_for_extra_meta',
-                ! $this instanceof EEM_Extra_Meta,
-                $this
-            )
-            ) {
-                EEM_Extra_Meta::instance()->delete_permanently(
-                    [
-                        0 => [
-                            'EXM_type' => $this->get_this_model_name(),
-                            'OBJ_ID'   => [
-                                'IN',
-                                $ids_for_removal,
-                            ],
-                        ],
-                    ]
-                );
-            }
-        }
-
-        /**
-         * Action called just after performing a real deletion query. Although at this point the
-         * items should have been deleted
-         *
-         * @param EEM_Base $model
-         * @param array    $query_params
-         * @param int      $rows_deleted
-         * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-         */
-        do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
-        return $rows_deleted;// how many supposedly got deleted
-    }
-
-
-    /**
-     * Checks all the relations that throw error messages when there are blocking related objects
-     * for related model objects. If there are any related model objects on those relations,
-     * adds an EE_Error, and return true
-     *
-     * @param EE_Base_Class|int $this_model_obj_or_id
-     * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
-     *                                                 should be ignored when determining whether there are related
-     *                                                 model objects which block this model object's deletion. Useful
-     *                                                 if you know A is related to B and are considering deleting A,
-     *                                                 but want to see if A has any other objects blocking its deletion
-     *                                                 before removing the relation between A and B
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
-    {
-        // first, if $ignore_this_model_obj was supplied, get its model
-        if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
-            $ignored_model = $ignore_this_model_obj->get_model();
-        } else {
-            $ignored_model = null;
-        }
-        // now check all the relations of $this_model_obj_or_id and see if there
-        // are any related model objects blocking it?
-        $is_blocked = false;
-        foreach ($this->_model_relations as $relation_name => $relation_obj) {
-            if ($relation_obj->block_delete_if_related_models_exist()) {
-                // if $ignore_this_model_obj was supplied, then for the query
-                // on that model needs to be told to ignore $ignore_this_model_obj
-                if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
-                    $related_model_objects = $relation_obj->get_all_related(
-                        $this_model_obj_or_id,
-                        [
-                            [
-                                $ignored_model->get_primary_key_field()->get_name() => [
-                                    '!=',
-                                    $ignore_this_model_obj->ID(),
-                                ],
-                            ],
-                        ]
-                    );
-                } else {
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
-                }
-                if ($related_model_objects) {
-                    EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
-                    $is_blocked = true;
-                }
-            }
-        }
-        return $is_blocked;
-    }
-
-
-    /**
-     * Builds the columns and values for items to delete from the incoming $row_results_for_deleting array.
-     *
-     * @param array $row_results_for_deleting
-     * @param bool  $allow_blocking
-     * @return array   The shape of this array depends on whether the model `has_primary_key_field` or not.  If the
-     *                              model DOES have a primary_key_field, then the array will be a simple single
-     *                              dimension array where the key is the fully qualified primary key column and the
-     *                              value is an array of ids that will be deleted. Example: array('Event.EVT_ID' =>
-     *                              array( 1,2,3)) If the model DOES NOT have a primary_key_field, then the array will
-     *                              be a two dimensional array where each element is a group of columns and values that
-     *                              get deleted. Example: array(
-     *                              0 => array(
-     *                              'Term_Relationship.object_id' => 1
-     *                              'Term_Relationship.term_taxonomy_id' => 5
-     *                              ),
-     *                              1 => array(
-     *                              'Term_Relationship.object_id' => 1
-     *                              'Term_Relationship.term_taxonomy_id' => 6
-     *                              )
-     *                              )
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_ids_for_delete(array $row_results_for_deleting, $allow_blocking = true)
-    {
-        $ids_to_delete_indexed_by_column = [];
-        if ($this->has_primary_key_field()) {
-            $primary_table                   = $this->_get_main_table();
-            $ids_to_delete_indexed_by_column = [];
-            foreach ($row_results_for_deleting as $item_to_delete) {
-                // before we mark this item for deletion,
-                // make sure there's no related entities blocking its deletion (if we're checking)
-                if (
-                    $allow_blocking
-                    && $this->delete_is_blocked_by_related_models(
-                        $item_to_delete[ $primary_table->get_fully_qualified_pk_column() ]
-                    )
-                ) {
-                    continue;
-                }
-                // primary table deletes
-                if (isset($item_to_delete[ $primary_table->get_fully_qualified_pk_column() ])) {
-                    $ids_to_delete_indexed_by_column[ $primary_table->get_fully_qualified_pk_column() ][] =
-                        $item_to_delete[ $primary_table->get_fully_qualified_pk_column() ];
-                }
-            }
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
-            $fields = $this->get_combined_primary_key_fields();
-            foreach ($row_results_for_deleting as $item_to_delete) {
-                $ids_to_delete_indexed_by_column_for_row = [];
-                foreach ($fields as $cpk_field) {
-                    if ($cpk_field instanceof EE_Model_Field_Base) {
-                        $ids_to_delete_indexed_by_column_for_row[ $cpk_field->get_qualified_column() ] =
-                            $item_to_delete[ $cpk_field->get_qualified_column() ];
-                    }
-                }
-                $ids_to_delete_indexed_by_column[] = $ids_to_delete_indexed_by_column_for_row;
-            }
-        } else {
-            // so there's no primary key and no combined key...
-            // sorry, can't help you
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Cannot delete objects of type %s because there is no primary key NOR combined key",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $ids_to_delete_indexed_by_column;
-    }
-
-
-    /**
-     * This receives an array of columns and values set to be deleted (as prepared by _get_ids_for_delete) and prepares
-     * the corresponding query_part for the query performing the delete.
-     *
-     * @param array $ids_to_delete_indexed_by_column @see _get_ids_for_delete for how this array might be shaped.
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _build_query_part_for_deleting_from_columns_and_values(array $ids_to_delete_indexed_by_column)
-    {
-        $query_part = '';
-        if (empty($ids_to_delete_indexed_by_column)) {
-            return $query_part;
-        } elseif ($this->has_primary_key_field()) {
-            $query = [];
-            foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
-                // make sure we have unique $ids
-                $ids     = array_unique($ids);
-                $query[] = $column . ' IN(' . implode(',', $ids) . ')';
-            }
-            $query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
-            $ways_to_identify_a_row = [];
-            foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
-                $values_for_each_combined_primary_key_for_a_row = [];
-                foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
-                    $values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
-                }
-                $value_and_value_and_value = implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
-                $ways_to_identify_a_row[]  = "({$value_and_value_and_value})";
-            }
-            $query_part = implode(' OR ', $ways_to_identify_a_row);
-        }
-        return $query_part;
-    }
-
-
-    /**
-     * Gets the model field by the fully qualified name
-     *
-     * @param string $qualified_column_name eg 'Event_CPT.post_name' or $field_obj->get_qualified_column()
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     */
-    public function get_field_by_column($qualified_column_name)
-    {
-        foreach ($this->field_settings(true) as $field_obj) {
-            if ($field_obj->get_qualified_column() === $qualified_column_name) {
-                return $field_obj;
-            }
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__('Could not find a field on the model "%1$s" for qualified column "%2$s"', 'event_espresso'),
-                $this->get_this_model_name(),
-                $qualified_column_name
-            )
-        );
-    }
-
-
-    /**
-     * Count all the rows that match criteria the model query params.
-     * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
-     * column
-     *
-     * @param array  $query_params
-     * @param string $field_to_count field on model to count by (not column name)
-     * @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 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($query_params = [], $field_to_count = null, $distinct = false)
-    {
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
-        if ($field_to_count) {
-            $field_obj       = $this->field_settings_for($field_to_count);
-            $column_to_count = $field_obj->get_qualified_column();
-        } elseif ($this->has_primary_key_field()) {
-            $pk_field_obj    = $this->get_primary_key_field();
-            $column_to_count = $pk_field_obj->get_qualified_column();
-        } else {
-            // there's no primary key
-            // if we're counting distinct items, and there's no primary key,
-            // we need to list out the columns for distinction;
-            // otherwise we can just use star
-            if ($distinct) {
-                $columns_to_use = [];
-                foreach ($this->get_combined_primary_key_fields() as $field_obj) {
-                    $columns_to_use[] = $field_obj->get_qualified_column();
-                }
-                $column_to_count = implode(',', $columns_to_use);
-            } else {
-                $column_to_count = '*';
-            }
-        }
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
-        $SQL             =
-            "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
-        return (int)$this->_do_wpdb_query('get_var', [$SQL]);
-    }
-
-
-    /**
-     * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
-     *
-     * @param array  $query_params
-     * @param string $field_to_sum name of field (array key in $_fields array)
-     * @return float
-     * @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 sum($query_params, $field_to_sum = null)
-    {
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
-        if ($field_to_sum) {
-            $field_obj = $this->field_settings_for($field_to_sum);
-        } else {
-            $field_obj = $this->get_primary_key_field();
-        }
-        $column_to_count = $field_obj->get_qualified_column();
-        $SQL             = "SELECT SUM(" . $column_to_count . ")"
-                           . $this->_construct_2nd_half_of_select_query($model_query_info);
-        $return_value    = $this->_do_wpdb_query('get_var', [$SQL]);
-        // $data_type       = $field_obj->get_wpdb_data_type();
-        // if ($data_type === '%d' || $data_type === '%s') {
-        //     return (float)$return_value;
-        // }
-        // must be %f
-        return (float)$return_value;
-    }
-
-
-    /**
-     * Just calls the specified method on $wpdb with the given arguments
-     * Consolidates a little extra error handling code
-     *
-     * @param string $wpdb_method
-     * @param array  $arguments_to_provide
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @global wpdb  $wpdb
-     */
-    protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
-    {
-        // if we're in maintenance mode level 2, DON'T run any queries
-        // because level 2 indicates the database needs updating and
-        // is probably out of sync with the code
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-            throw new EE_Error(
-                esc_html__(
-                    'Event Espresso Level 2 Maintenance mode is active. That means EE can not run ANY database queries until the necessary migration scripts have run which will take EE out of maintenance mode level 2. Please inform support of this error.',
-                    'event_espresso'
-                )
-            );
-        }
-        global $wpdb;
-        if (! method_exists($wpdb, $wpdb_method)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'There is no method named "%s" on Wordpress\' $wpdb object',
-                        'event_espresso'
-                    ),
-                    $wpdb_method
-                )
-            );
-        }
-        $old_show_errors_value = $wpdb->show_errors;
-        if (WP_DEBUG) {
-            $wpdb->show_errors(false);
-        }
-        $result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
-        $this->show_db_query_if_previously_requested($wpdb->last_query);
-        if (WP_DEBUG) {
-            $wpdb->show_errors($old_show_errors_value);
-            if (! empty($wpdb->last_error)) {
-                throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
-            }
-            if ($result === false) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'WPDB Error occurred, but no error message was logged by wpdb! The wpdb method called was "%1$s" and the arguments were "%2$s"',
-                            'event_espresso'
-                        ),
-                        $wpdb_method,
-                        var_export($arguments_to_provide, true)
-                    )
-                );
-            }
-        } elseif ($result === false) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'A database error has occurred. Turn on WP_DEBUG for more information.||A database error occurred doing wpdb method "%1$s", with arguments "%2$s". The error was "%3$s"',
-                        'event_espresso'
-                    ),
-                    $wpdb_method,
-                    var_export($arguments_to_provide, true),
-                    $wpdb->last_error
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $result;
-    }
-
-
-    /**
-     * Attempts to run the indicated WPDB method with the provided arguments,
-     * and if there's an error tries to verify the DB is correct. Uses
-     * the static property EEM_Base::$_db_verification_level to determine whether
-     * we should try to fix the EE core db, the addons, or just give up
-     *
-     * @param string $wpdb_method
-     * @param array  $arguments_to_provide
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
-    {
-        global $wpdb;
-        $wpdb->last_error = null;
-        $result           = call_user_func_array([$wpdb, $wpdb_method], $arguments_to_provide);
-        // was there an error running the query? but we don't care on new activations
-        // (we're going to setup the DB anyway on new activations)
-        if (
-            ($result === false || ! empty($wpdb->last_error))
-            && EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
-        ) {
-            switch (EEM_Base::$_db_verification_level) {
-                case EEM_Base::db_verified_none:
-                    // let's double-check core's DB
-                    $error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
-                    break;
-                case EEM_Base::db_verified_core:
-                    // STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
-                    $error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
-                    break;
-                case EEM_Base::db_verified_addons:
-                    // ummmm... you in trouble
-                    return $result;
-            }
-            if (! empty($error_message)) {
-                EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
-                trigger_error($error_message);
-            }
-            return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
-        }
-        return $result;
-    }
-
-
-    /**
-     * Verifies the EE core database is up-to-date and records that we've done it on
-     * EEM_Base::$_db_verification_level
-     *
-     * @param string $wpdb_method
-     * @param array  $arguments_to_provide
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _verify_core_db($wpdb_method, $arguments_to_provide)
-    {
-        global $wpdb;
-        // ok remember that we've already attempted fixing the core db, in case the problem persists
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
-        $error_message                    = sprintf(
-            esc_html__(
-                'WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
-                'event_espresso'
-            ),
-            $wpdb->last_error,
-            $wpdb_method,
-            wp_json_encode($arguments_to_provide)
-        );
-        EE_System::instance()->initialize_db_if_no_migrations_required();
-        return $error_message;
-    }
-
-
-    /**
-     * Verifies the EE addons' database is up-to-date and records that we've done it on
-     * EEM_Base::$_db_verification_level
-     *
-     * @param $wpdb_method
-     * @param $arguments_to_provide
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _verify_addons_db($wpdb_method, $arguments_to_provide)
-    {
-        global $wpdb;
-        // ok remember that we've already attempted fixing the addons dbs, in case the problem persists
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
-        $error_message                    = sprintf(
-            esc_html__(
-                'WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
-                'event_espresso'
-            ),
-            $wpdb->last_error,
-            $wpdb_method,
-            wp_json_encode($arguments_to_provide)
-        );
-        EE_System::instance()->initialize_addons();
-        return $error_message;
-    }
-
-
-    /**
-     * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
-     * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
-     * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
-     * ..."
-     *
-     * @param EE_Model_Query_Info_Carrier $model_query_info
-     * @return string
-     */
-    private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
-    {
-        return " FROM " . $model_query_info->get_full_join_sql() .
-               $model_query_info->get_where_sql() .
-               $model_query_info->get_group_by_sql() .
-               $model_query_info->get_having_sql() .
-               $model_query_info->get_order_by_sql() .
-               $model_query_info->get_limit_sql();
-    }
-
-
-    /**
-     * Set to easily debug the next X queries ran from this model.
-     *
-     * @param int $count
-     */
-    public function show_next_x_db_queries($count = 1)
-    {
-        $this->_show_next_x_db_queries = $count;
-    }
-
-
-    /**
-     * @param $sql_query
-     */
-    public function show_db_query_if_previously_requested($sql_query)
-    {
-        if ($this->_show_next_x_db_queries > 0) {
-            echo $sql_query;
-            $this->_show_next_x_db_queries--;
-        }
-    }
-
-
-    /**
-     * Adds a relationship of the correct type between $modelObject and $otherModelObject.
-     * There are the 3 cases:
-     * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
-     * $otherModelObject has no ID, it is first saved.
-     * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
-     * has no ID, it is first saved.
-     * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
-     * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
-     * join table
-     *
-     * @param EE_Base_Class                     /int $thisModelObject
-     * @param EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
-     * @param string $relationName                     , key in EEM_Base::_relations
-     *                                                 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 This allows you to enter further query params for the relation
-     *                                                 to for relation to methods that allow you to further specify
-     *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
-     *                                                 only acceptable query_params is strict "col" => "value" pairs
-     *                                                 because these will be inserted in any new rows created as well.
-     * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
-     * @throws EE_Error
-     */
-    public function add_relationship_to(
-        $id_or_obj,
-        $other_model_id_or_obj,
-        $relationName,
-        $extra_join_model_fields_n_values = []
-    ) {
-        $relation_obj = $this->related_settings_for($relationName);
-        return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
-    }
-
-
-    /**
-     * Removes a relationship of the correct type between $modelObject and $otherModelObject.
-     * There are the 3 cases:
-     * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
-     * error
-     * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
-     * an error
-     * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
-     *
-     * @param EE_Base_Class /int $id_or_obj
-     * @param EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
-     * @param string $relationName key in EEM_Base::_relations
-     * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
-     *                             methods that allow you to further specify extra columns to join by (such as HABTM).
-     *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
-     *                             because these will be inserted in any new rows created as well.
-     * @return boolean of success
-     * @throws EE_Error
-     */
-    public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = [])
-    {
-        $relation_obj = $this->related_settings_for($relationName);
-        return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
-    }
-
-
-    /**
-     * @param mixed  $id_or_obj
-     * @param string $relationName
-     * @param array  $where_query_params
-     * @param EE_Base_Class[] objects to which relations were removed
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function remove_relations($id_or_obj, $relationName, $where_query_params = [])
-    {
-        $relation_obj = $this->related_settings_for($relationName);
-        return $relation_obj->remove_relations($id_or_obj, $where_query_params);
-    }
-
-
-    /**
-     * Gets all the related items of the specified $model_name, using $query_params.
-     * Note: by default, we remove the "default query params"
-     * because we want to get even deleted items etc.
-     *
-     * @param mixed  $id_or_obj    EE_Base_Class child or its ID
-     * @param string $model_name   like 'Event', 'Registration', etc. always singular
-     * @param array  $query_params see github link below for more info
-     * @return 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 get_all_related($id_or_obj, $model_name, $query_params = null)
-    {
-        $model_obj         = $this->ensure_is_obj($id_or_obj);
-        $relation_settings = $this->related_settings_for($model_name);
-        return $relation_settings->get_all_related($model_obj, $query_params);
-    }
-
-
-    /**
-     * Deletes all the model objects across the relation indicated by $model_name
-     * which are related to $id_or_obj which meet the criteria set in $query_params.
-     * However, if the model objects can't be deleted because of blocking related model objects, then
-     * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
-     *
-     * @param EE_Base_Class|int|string $id_or_obj
-     * @param string                   $model_name
-     * @param array                    $query_params
-     * @return int how many deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_related($id_or_obj, $model_name, $query_params = [])
-    {
-        $model_obj         = $this->ensure_is_obj($id_or_obj);
-        $relation_settings = $this->related_settings_for($model_name);
-        return $relation_settings->delete_all_related($model_obj, $query_params);
-    }
-
-
-    /**
-     * Hard deletes all the model objects across the relation indicated by $model_name
-     * which are related to $id_or_obj which meet the criteria set in $query_params. If
-     * the model objects can't be hard deleted because of blocking related model objects,
-     * just does a soft-delete on them instead.
-     *
-     * @param EE_Base_Class|int|string $id_or_obj
-     * @param string                   $model_name
-     * @param array                    $query_params
-     * @return int how many deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_related_permanently($id_or_obj, $model_name, $query_params = [])
-    {
-        $model_obj         = $this->ensure_is_obj($id_or_obj);
-        $relation_settings = $this->related_settings_for($model_name);
-        return $relation_settings->delete_related_permanently($model_obj, $query_params);
-    }
-
-
-    /**
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
-     * unless otherwise specified in the $query_params
-     *
-     * @param int             /EE_Base_Class $id_or_obj
-     * @param string $model_name     like 'Event', or 'Registration'
-     * @param array  $query_params
-     * @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 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_related(
-        $id_or_obj,
-        $model_name,
-        $query_params = [],
-        $field_to_count = null,
-        $distinct = false
-    ) {
-        $related_model = $this->get_related_model_obj($model_name);
-        // we're just going to use the query params on the related model's normal get_all query,
-        // except add a condition to say to match the current mod
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
-        }
-        $this_model_name                                                 = $this->get_this_model_name();
-        $this_pk_field_name                                              = $this->get_primary_key_field()->get_name();
-        $query_params[0][ $this_model_name . "." . $this_pk_field_name ] = $id_or_obj;
-        return $related_model->count($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 int           /EE_Base_Class $id_or_obj
-     * @param string $model_name   like 'Event', or 'Registration'
-     * @param array  $query_params
-     * @param string $field_to_sum name of field to count by. By default, uses primary key
-     * @return float
-     * @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 sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
-    {
-        $related_model = $this->get_related_model_obj($model_name);
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong(
-                'EEM_Base::sum_related',
-                sprintf(
-                    esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = [];
-        }
-        // we're just going to use the query params on the related model's normal get_all query,
-        // except add a condition to say to match the current mod
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
-        }
-        $this_model_name                                                 = $this->get_this_model_name();
-        $this_pk_field_name                                              = $this->get_primary_key_field()->get_name();
-        $query_params[0][ $this_model_name . "." . $this_pk_field_name ] = $id_or_obj;
-        return $related_model->sum($query_params, $field_to_sum);
-    }
-
-
-    /**
-     * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
-     * $modelObject
-     *
-     * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
-     * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
-     * @param array               $query_params     see github link below for more info
-     * @return 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 get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
-    {
-        $query_params['limit'] = 1;
-        $results               = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
-     *
-     * @return string
-     */
-    public function get_this_model_name()
-    {
-        return str_replace("EEM_", "", get_class($this));
-    }
-
-
-    /**
-     * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
-     *
-     * @return EE_Any_Foreign_Model_Name_Field
-     * @throws EE_Error
-     */
-    public function get_field_containing_related_model_name()
-    {
-        foreach ($this->field_settings(true) as $field) {
-            if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
-                $field_with_model_name = $field;
-            }
-        }
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
-                    $this->get_this_model_name()
-                )
-            );
-        }
-        return $field_with_model_name;
-    }
-
-
-    /**
-     * Inserts a new entry into the database, for each table.
-     * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
-     * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
-     * we also know there is no model object with the newly inserted item's ID at the moment (because
-     * if there were, then they would already be in the DB and this would fail); and in the future if someone
-     * creates a model object with this ID (or grabs it from the DB) then it will be added to the
-     * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
-     *
-     * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
-     *                              $values_already_prepared_by_model_object is false, in the model object's domain if
-     *                              $values_already_prepared_by_model_object is true. See comment about this at the top
-     *                              of EEM_Base)
-     * @return int|string new primary key on main table that got inserted
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function insert($field_n_values)
-    {
-        /**
-         * Filters the fields and their values before inserting an item using the models
-         *
-         * @param array    $fields_n_values keys are the fields and values are their new values
-         * @param EEM_Base $model           the model used
-         */
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
-        if ($this->_satisfies_unique_indexes($field_n_values)) {
-            $main_table = $this->_get_main_table();
-            $new_id     = $this->_insert_into_specific_table($main_table, $field_n_values, false);
-            if ($new_id !== false) {
-                foreach ($this->_get_other_tables() as $other_table) {
-                    $this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
-                }
-            }
-            /**
-             * Done just after attempting to insert a new model object
-             *
-             * @param EEM_Base $model           used
-             * @param array    $fields_n_values fields and their values
-             * @param int|string the              ID of the newly-inserted model object
-             */
-            do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
-            return $new_id;
-        }
-        return false;
-    }
-
-
-    /**
-     * Checks that the result would satisfy the unique indexes on this model
-     *
-     * @param array  $field_n_values
-     * @param string $action
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
-    {
-        foreach ($this->unique_indexes() as $index_name => $index) {
-            $uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
-            if ($this->exists([$uniqueness_where_params])) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            "Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
-                            "event_espresso"
-                        ),
-                        $action,
-                        $this->_get_class_name(),
-                        $index_name,
-                        implode(",", $index->field_names()),
-                        http_build_query($uniqueness_where_params)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * Checks the database for an item that conflicts (ie, if this item were
-     * saved to the DB would break some uniqueness requirement, like a primary key
-     * or an index primary key set) with the item specified. $id_obj_or_fields_array
-     * can be either an EE_Base_Class or an array of fields n values
-     *
-     * @param EE_Base_Class|array $obj_or_fields_array
-     * @param boolean             $include_primary_key whether to use the model object's primary key
-     *                                                 when looking for conflicts
-     *                                                 (ie, if false, we ignore the model object's primary key
-     *                                                 when finding "conflicts". If true, it's also considered).
-     *                                                 Only works for INT primary key,
-     *                                                 STRING primary keys cannot be ignored
-     * @return EE_Base_Class|array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
-    {
-        if ($obj_or_fields_array instanceof EE_Base_Class) {
-            $fields_n_values = $obj_or_fields_array->model_field_array();
-        } elseif (is_array($obj_or_fields_array)) {
-            $fields_n_values = $obj_or_fields_array;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
-                        "event_espresso"
-                    ),
-                    get_class($this),
-                    $obj_or_fields_array
-                )
-            );
-        }
-        $query_params = [];
-        if (
-            $this->has_primary_key_field()
-            && ($include_primary_key
-                || $this->get_primary_key_field()
-                   instanceof
-                   EE_Primary_Key_String_Field)
-            && isset($fields_n_values[ $this->primary_key_name() ])
-        ) {
-            $query_params[0]['OR'][ $this->primary_key_name() ] = $fields_n_values[ $this->primary_key_name() ];
-        }
-        foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
-            $uniqueness_where_params                              =
-                array_intersect_key($fields_n_values, $unique_index->fields());
-            $query_params[0]['OR'][ 'AND*' . $unique_index_name ] = $uniqueness_where_params;
-        }
-        // if there is nothing to base this search on, then we shouldn't find anything
-        if (empty($query_params)) {
-            return [];
-        }
-        return $this->get_one($query_params);
-    }
-
-
-    /**
-     * Like count, but is optimized and returns a boolean instead of an int
-     *
-     * @param array $query_params
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function exists($query_params)
-    {
-        $query_params['limit'] = 1;
-        return $this->count($query_params) > 0;
-    }
-
-
-    /**
-     * Wrapper for exists, except ignores default query parameters so we're only considering ID
-     *
-     * @param int|string $id
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function exists_by_ID($id)
-    {
-        return $this->exists(
-            [
-                'default_where_conditions' => EEM_Base::default_where_conditions_none,
-                [
-                    $this->primary_key_name() => $id,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Inserts a new row in $table, using the $cols_n_values which apply to that table.
-     * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
-     * we need to add a foreign key column to point to $new_id (which should be the primary key's value
-     * on the main table)
-     * This is protected rather than private because private is not accessible to any child methods and there MAY be
-     * cases where we want to call it directly rather than via insert().
-     *
-     * @access   protected
-     * @param EE_Table_Base $table
-     * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
-     *                                       float
-     * @param int           $new_id          for now we assume only int keys
-     * @return int ID of new row inserted, or FALSE on failure
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
-     */
-    protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
-    {
-        global $wpdb;
-        $insertion_col_n_values = [];
-        $format_for_insertion   = [];
-        $fields_on_table        = $this->_get_fields_for_table($table->get_table_alias());
-        foreach ($fields_on_table as $field_obj) {
-            // check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
-            if ($field_obj->is_auto_increment()) {
-                continue;
-            }
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
-            // if the value we want to assign it to is NULL, just don't mention it for the insertion
-            if ($prepared_value !== null) {
-                $insertion_col_n_values[ $field_obj->get_table_column() ] = $prepared_value;
-                $format_for_insertion[]                                   = $field_obj->get_wpdb_data_type();
-            }
-        }
-        if ($table instanceof EE_Secondary_Table && $new_id) {
-            // its not the main table, so we should have already saved the main table's PK which we just inserted
-            // so add the fk to the main table as a column
-            $insertion_col_n_values[ $table->get_fk_on_table() ] = $new_id;
-            $format_for_insertion[]                              =
-                '%d';// yes right now we're only allowing these foreign keys to be INTs
-        }
-        // insert the new entry
-        $result = $this->_do_wpdb_query(
-            'insert',
-            [$table->get_table_name(), $insertion_col_n_values, $format_for_insertion]
-        );
-        if ($result === false) {
-            return false;
-        }
-        // ok, now what do we return for the ID of the newly-inserted thing?
-        if ($this->has_primary_key_field()) {
-            if ($this->get_primary_key_field()->is_auto_increment()) {
-                return $wpdb->insert_id;
-            }
-            // it's not an auto-increment primary key, so
-            // it must have been supplied
-            return $fields_n_values[ $this->get_primary_key_field()->get_name() ];
-        }
-        // we can't return a  primary key because there is none. instead return
-        // a unique string indicating this model
-        return $this->get_index_primary_key_string($fields_n_values);
-    }
-
-
-    /**
-     * Prepare the $field_obj 's value in $fields_n_values for use in the database.
-     * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
-     * and there is no default, we pass it along. WPDB will take care of it)
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param array               $fields_n_values
-     * @return mixed string|int|float depending on what the table column will be expecting
-     * @throws EE_Error
-     */
-    protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
-    {
-        // if this field doesn't allow nullable, don't allow it
-        if (
-            ! $field_obj->is_nullable()
-            && (
-                ! isset($fields_n_values[ $field_obj->get_name() ])
-                || $fields_n_values[ $field_obj->get_name() ] === null
-            )
-        ) {
-            $fields_n_values[ $field_obj->get_name() ] = $field_obj->get_default_value();
-        }
-        $unprepared_value = isset($fields_n_values[ $field_obj->get_name() ])
-            ? $fields_n_values[ $field_obj->get_name() ]
-            : null;
-        return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
-    }
-
-
-    /**
-     * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
-     * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
-     * the field's prepare_for_set() method.
-     *
-     * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
-     *                                   false, otherwise a value in the model object's domain (see lengthy comment at
-     *                                   top of file)
-     * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
-     *                                   $value is a custom selection
-     * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
-     */
-    private function _prepare_value_for_use_in_db($value, $field)
-    {
-        if ($field && $field instanceof EE_Model_Field_Base) {
-            // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
-            switch ($this->_values_already_prepared_by_model_object) {
-                /** @noinspection PhpMissingBreakStatementInspection */
-                case self::not_prepared_by_model_object:
-                    $value = $field->prepare_for_set($value);
-                // purposefully left out "return"
-                case self::prepared_by_model_object:
-                    /** @noinspection SuspiciousAssignmentsInspection */
-                    $value = $field->prepare_for_use_in_db($value);
-                case self::prepared_for_use_in_db:
-                    // leave the value alone
-            }
-            return $value;
-            // phpcs:enable
-        }
-        return $value;
-    }
-
-
-    /**
-     * Returns the main table on this model
-     *
-     * @return EE_Primary_Table
-     * @throws EE_Error
-     */
-    protected function _get_main_table()
-    {
-        foreach ($this->_tables as $table) {
-            if ($table instanceof EE_Primary_Table) {
-                return $table;
-            }
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'There are no main tables on %s. They should be added to _tables array in the constructor',
-                    'event_espresso'
-                ),
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * table
-     * returns EE_Primary_Table table name
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function table()
-    {
-        return $this->_get_main_table()->get_table_name();
-    }
-
-
-    /**
-     * table
-     * returns first EE_Secondary_Table table name
-     *
-     * @return string
-     */
-    public function second_table()
-    {
-        // grab second table from tables array
-        $second_table = end($this->_tables);
-        return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
-    }
-
-
-    /**
-     * get_table_obj_by_alias
-     * returns table name given it's alias
-     *
-     * @param string $table_alias
-     * @return EE_Primary_Table | EE_Secondary_Table
-     */
-    public function get_table_obj_by_alias($table_alias = '')
-    {
-        return isset($this->_tables[ $table_alias ]) ? $this->_tables[ $table_alias ] : null;
-    }
-
-
-    /**
-     * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
-     *
-     * @return EE_Secondary_Table[]
-     */
-    protected function _get_other_tables()
-    {
-        $other_tables = [];
-        foreach ($this->_tables as $table_alias => $table) {
-            if ($table instanceof EE_Secondary_Table) {
-                $other_tables[ $table_alias ] = $table;
-            }
-        }
-        return $other_tables;
-    }
-
-
-    /**
-     * Finds all the fields that correspond to the given table
-     *
-     * @param string $table_alias , array key in EEM_Base::_tables
-     * @return EE_Model_Field_Base[]
-     */
-    public function _get_fields_for_table($table_alias)
-    {
-        return $this->_fields[ $table_alias ];
-    }
-
-
-    /**
-     * Recurses through all the where parameters, and finds all the related models we'll need
-     * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
-     * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
-     * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
-     * related Registration, Transaction, and Payment models.
-     *
-     * @param array $query_params see github link below for more info
-     * @return EE_Model_Query_Info_Carrier
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function _extract_related_models_from_query($query_params)
-    {
-        $query_info_carrier = new EE_Model_Query_Info_Carrier();
-        if (array_key_exists(0, $query_params)) {
-            $this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
-        }
-        if (array_key_exists('group_by', $query_params)) {
-            if (is_array($query_params['group_by'])) {
-                $this->_extract_related_models_from_sub_params_array_values(
-                    $query_params['group_by'],
-                    $query_info_carrier,
-                    'group_by'
-                );
-            } elseif (! empty($query_params['group_by'])) {
-                $this->_extract_related_model_info_from_query_param(
-                    $query_params['group_by'],
-                    $query_info_carrier,
-                    'group_by'
-                );
-            }
-        }
-        if (array_key_exists('having', $query_params)) {
-            $this->_extract_related_models_from_sub_params_array_keys(
-                $query_params[0],
-                $query_info_carrier,
-                'having'
-            );
-        }
-        if (array_key_exists('order_by', $query_params)) {
-            if (is_array($query_params['order_by'])) {
-                $this->_extract_related_models_from_sub_params_array_keys(
-                    $query_params['order_by'],
-                    $query_info_carrier,
-                    'order_by'
-                );
-            } elseif (! empty($query_params['order_by'])) {
-                $this->_extract_related_model_info_from_query_param(
-                    $query_params['order_by'],
-                    $query_info_carrier,
-                    'order_by'
-                );
-            }
-        }
-        if (array_key_exists('force_join', $query_params)) {
-            $this->_extract_related_models_from_sub_params_array_values(
-                $query_params['force_join'],
-                $query_info_carrier,
-                'force_join'
-            );
-        }
-        $this->extractRelatedModelsFromCustomSelects($query_info_carrier);
-        return $query_info_carrier;
-    }
-
-
-    /**
-     * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
-     *
-     * @param array                       $sub_query_params
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
-     * @param string                      $query_param_type one of $this->_allowed_query_params
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#-0-where-conditions
-     */
-    private function _extract_related_models_from_sub_params_array_keys(
-        $sub_query_params,
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
-        $query_param_type
-    ) {
-        if (! empty($sub_query_params)) {
-            $sub_query_params = (array)$sub_query_params;
-            foreach ($sub_query_params as $param => $possibly_array_of_params) {
-                // $param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
-                $this->_extract_related_model_info_from_query_param(
-                    $param,
-                    $model_query_info_carrier,
-                    $query_param_type
-                );
-                // if $possibly_array_of_params is an array, try recursing into it, searching for keys which
-                // indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
-                // extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
-                // of array('Registration.TXN_ID'=>23)
-                $query_param_sans_stars =
-                    $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
-                if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
-                    if (! is_array($possibly_array_of_params)) {
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__(
-                                    "You used a special where query param %s, but the value isn't an array of where query params, it's just %s'. It should be an array, eg array('EVT_ID'=>23,'OR'=>array('Venue.VNU_ID'=>32,'Venue.VNU_name'=>'monkey_land'))",
-                                    "event_espresso"
-                                ),
-                                $param,
-                                $possibly_array_of_params
-                            )
-                        );
-                    }
-                    $this->_extract_related_models_from_sub_params_array_keys(
-                        $possibly_array_of_params,
-                        $model_query_info_carrier,
-                        $query_param_type
-                    );
-                } elseif (
-                    $query_param_type === 0 // ie WHERE
-                    && is_array($possibly_array_of_params)
-                    && isset($possibly_array_of_params[2])
-                    && $possibly_array_of_params[2] == true
-                ) {
-                    // then $possible_array_of_params looks something like array('<','DTT_sold',true)
-                    // indicating that $possible_array_of_params[1] is actually a field name,
-                    // from which we should extract query parameters!
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__(
-                                    "Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
-                                    "event_espresso"
-                                ),
-                                $query_param_type,
-                                implode(",", $possibly_array_of_params)
-                            )
-                        );
-                    }
-                    $this->_extract_related_model_info_from_query_param(
-                        $possibly_array_of_params[1],
-                        $model_query_info_carrier,
-                        $query_param_type
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * For extracting related models from forced_joins, where the array values contain the info about what
-     * models to join with. Eg an array like array('Attendee','Price.Price_Type');
-     *
-     * @param array                       $sub_query_params
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
-     * @param string                      $query_param_type one of $this->_allowed_query_params
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    private function _extract_related_models_from_sub_params_array_values(
-        $sub_query_params,
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
-        $query_param_type
-    ) {
-        if (! empty($sub_query_params)) {
-            if (! is_array($sub_query_params)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
-                        $sub_query_params
-                    )
-                );
-            }
-            foreach ($sub_query_params as $param) {
-                // $param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
-                $this->_extract_related_model_info_from_query_param(
-                    $param,
-                    $model_query_info_carrier,
-                    $query_param_type
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Extract all the query parts from  model query params
-     * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
-     * instead of directly constructing the SQL because often we need to extract info from the $query_params
-     * but use them in a different order. Eg, we need to know what models we are querying
-     * before we know what joins to perform. However, we need to know what data types correspond to which fields on
-     * other models before we can finalize the where clause SQL.
-     *
-     * @param array $query_params see github link below for more info
-     * @return EE_Model_Query_Info_Carrier
-     * @throws EE_Error
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function _create_model_query_info_carrier($query_params)
-    {
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong(
-                'EEM_Base::_create_model_query_info_carrier',
-                sprintf(
-                    esc_html__(
-                        '$query_params should be an array, you passed a variable of type %s',
-                        'event_espresso'
-                    ),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = [];
-        }
-        $query_params[0] = isset($query_params[0]) ? $query_params[0] : [];
-        // first check if we should alter the query to account for caps or not
-        // because the caps might require us to do extra joins
-        if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
-            $query_params[0] = array_replace_recursive(
-                $query_params[0],
-                $this->caps_where_conditions(
-                    $query_params['caps']
-                )
-            );
-        }
-
-        // check if we should alter the query to remove data related to protected
-        // custom post types
-        if (isset($query_params['exclude_protected']) && $query_params['exclude_protected'] === true) {
-            $where_param_key_for_password = $this->modelChainAndPassword();
-            // only include if related to a cpt where no password has been set
-            $query_params[0]['OR*nopassword'] = [
-                $where_param_key_for_password       => '',
-                $where_param_key_for_password . '*' => ['IS_NULL'],
-            ];
-        }
-        $query_object = $this->_extract_related_models_from_query($query_params);
-        // verify where_query_params has NO numeric indexes.... that's simply not how you use it!
-        foreach ($query_params[0] as $key => $value) {
-            if (is_int($key)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "WHERE query params must NOT be numerically-indexed. You provided the array key '%s' for value '%s' while querying model %s. All the query params provided were '%s' Please read documentation on EEM_Base::get_all.",
-                            "event_espresso"
-                        ),
-                        $key,
-                        var_export($value, true),
-                        var_export($query_params, true),
-                        get_class($this)
-                    )
-                );
-            }
-        }
-        if (
-            array_key_exists('default_where_conditions', $query_params)
-            && ! empty($query_params['default_where_conditions'])
-        ) {
-            $use_default_where_conditions = $query_params['default_where_conditions'];
-        } else {
-            $use_default_where_conditions = EEM_Base::default_where_conditions_all;
-        }
-        $query_params[0] = array_merge(
-            $this->_get_default_where_conditions_for_models_in_query(
-                $query_object,
-                $use_default_where_conditions,
-                $query_params[0]
-            ),
-            $query_params[0]
-        );
-        $query_object->set_where_sql($this->_construct_where_clause($query_params[0]));
-        // if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
-        // So we need to setup a subquery and use that for the main join.
-        // Note for now this only works on the primary table for the model.
-        // So for instance, you could set the limit array like this:
-        // array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
-        if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
-            $query_object->set_main_model_join_sql(
-                $this->_construct_limit_join_select(
-                    $query_params['on_join_limit'][0],
-                    $query_params['on_join_limit'][1]
-                )
-            );
-        }
-        // set limit
-        if (array_key_exists('limit', $query_params)) {
-            if (is_array($query_params['limit'])) {
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
-                    $e = sprintf(
-                        esc_html__(
-                            "Invalid DB query. You passed '%s' for the LIMIT, but only the following are valid: an integer, string representing an integer, a string like 'int,int', or an array like array(int,int)",
-                            "event_espresso"
-                        ),
-                        http_build_query($query_params['limit'])
-                    );
-                    throw new EE_Error($e . "|" . $e);
-                }
-                // they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
-            } elseif (! empty($query_params['limit'])) {
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
-            }
-        }
-        // set order by
-        if (array_key_exists('order_by', $query_params)) {
-            if (is_array($query_params['order_by'])) {
-                // if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
-                // specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
-                // including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
-                if (array_key_exists('order', $query_params)) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                "In querying %s, we are using query parameter 'order_by' as an array (keys:%s,values:%s), and so we can't use query parameter 'order' (value %s). You should just use the 'order_by' parameter ",
-                                "event_espresso"
-                            ),
-                            get_class($this),
-                            implode(", ", array_keys($query_params['order_by'])),
-                            implode(", ", $query_params['order_by']),
-                            $query_params['order']
-                        )
-                    );
-                }
-                $this->_extract_related_models_from_sub_params_array_keys(
-                    $query_params['order_by'],
-                    $query_object,
-                    'order_by'
-                );
-                // assume it's an array of fields to order by
-                $order_array = [];
-                foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
-                    $order         = $this->_extract_order($order);
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
-                }
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
-            } elseif (! empty($query_params['order_by'])) {
-                $this->_extract_related_model_info_from_query_param(
-                    $query_params['order_by'],
-                    $query_object,
-                    'order',
-                    $query_params['order_by']
-                );
-                $order = isset($query_params['order'])
-                    ? $this->_extract_order($query_params['order'])
-                    : 'DESC';
-                $query_object->set_order_by_sql(
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
-                );
-            }
-        }
-        // if 'order_by' wasn't set, maybe they are just using 'order' on its own?
-        if (
-            ! array_key_exists('order_by', $query_params)
-            && array_key_exists('order', $query_params)
-            && ! empty($query_params['order'])
-        ) {
-            $pk_field = $this->get_primary_key_field();
-            $order    = $this->_extract_order($query_params['order']);
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
-        }
-        // set group by
-        if (array_key_exists('group_by', $query_params)) {
-            if (is_array($query_params['group_by'])) {
-                // it's an array, so assume we'll be grouping by a bunch of stuff
-                $group_by_array = [];
-                foreach ($query_params['group_by'] as $field_name_to_group_by) {
-                    $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
-                }
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
-            } elseif (! empty($query_params['group_by'])) {
-                $query_object->set_group_by_sql(
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
-                );
-            }
-        }
-        // set having
-        if (array_key_exists('having', $query_params) && $query_params['having']) {
-            $query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
-        }
-        // now, just verify they didn't pass anything wack
-        foreach ($query_params as $query_key => $query_value) {
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
-                            'event_espresso'
-                        ),
-                        $query_key,
-                        get_class($this),
-                        //                      print_r( $this->_allowed_query_params, TRUE )
-                        implode(',', $this->_allowed_query_params)
-                    )
-                );
-            }
-        }
-        $main_model_join_sql = $query_object->get_main_model_join_sql();
-        if (empty($main_model_join_sql)) {
-            $query_object->set_main_model_join_sql($this->_construct_internal_join());
-        }
-        return $query_object;
-    }
-
-
-    /**
-     * Gets the where conditions that should be imposed on the query based on the
-     * context (eg reading frontend, backend, edit or delete).
-     *
-     * @param string $context one of EEM_Base::valid_cap_contexts()
-     * @return array
-     * @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 caps_where_conditions($context = self::caps_read)
-    {
-        EEM_Base::verify_is_valid_cap_context($context);
-        $cap_where_conditions = [];
-        $cap_restrictions     = $this->caps_missing($context);
-        foreach ($cap_restrictions as $restriction_if_no_cap) {
-            $cap_where_conditions = array_replace_recursive(
-                $cap_where_conditions,
-                $restriction_if_no_cap->get_default_where_conditions()
-            );
-        }
-        return apply_filters(
-            'FHEE__EEM_Base__caps_where_conditions__return',
-            $cap_where_conditions,
-            $this,
-            $context,
-            $cap_restrictions
-        );
-    }
-
-
-    /**
-     * Verifies that $should_be_order_string is in $this->_allowed_order_values,
-     * otherwise throws an exception
-     *
-     * @param string $should_be_order_string
-     * @return string either ASC, asc, DESC or desc
-     * @throws EE_Error
-     */
-    private function _extract_order($should_be_order_string)
-    {
-        if (in_array($should_be_order_string, $this->_allowed_order_values)) {
-            return $should_be_order_string;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "While performing a query on '%s', tried to use '%s' as an order parameter. ",
-                    "event_espresso"
-                ),
-                get_class($this),
-                $should_be_order_string
-            )
-        );
-    }
-
-
-    /**
-     * Looks at all the models which are included in this query, and asks each
-     * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
-     * so they can be merged
-     *
-     * @param EE_Model_Query_Info_Carrier $query_info_carrier
-     * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
-     *                                                                  'none' means NO default where conditions will
-     *                                                                  be used AT ALL during this query.
-     *                                                                  'other_models_only' means default where
-     *                                                                  conditions from other models will be used, but
-     *                                                                  not for this primary model. 'all', the default,
-     *                                                                  means default where conditions will apply as
-     *                                                                  normal
-     * @param array                       $where_query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    private function _get_default_where_conditions_for_models_in_query(
-        EE_Model_Query_Info_Carrier $query_info_carrier,
-        $use_default_where_conditions = EEM_Base::default_where_conditions_all,
-        $where_query_params = []
-    ) {
-        $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
-                        "event_espresso"
-                    ),
-                    $use_default_where_conditions,
-                    implode(", ", $allowed_used_default_where_conditions_values)
-                )
-            );
-        }
-        $universal_query_params = [];
-        if ($this->_should_use_default_where_conditions($use_default_where_conditions)) {
-            $universal_query_params = $this->_get_default_where_conditions();
-        } elseif ($this->_should_use_minimum_where_conditions($use_default_where_conditions)) {
-            $universal_query_params = $this->_get_minimum_where_conditions();
-        }
-        foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
-            $related_model = $this->get_related_model_obj($model_name);
-            if ($this->_should_use_default_where_conditions($use_default_where_conditions, false)) {
-                $related_model_universal_where_params =
-                    $related_model->_get_default_where_conditions($model_relation_path);
-            } elseif ($this->_should_use_minimum_where_conditions($use_default_where_conditions, false)) {
-                $related_model_universal_where_params =
-                    $related_model->_get_minimum_where_conditions($model_relation_path);
-            } else {
-                // we don't want to add full or even minimum default where conditions from this model, so just continue
-                continue;
-            }
-            $overrides              = $this->_override_defaults_or_make_null_friendly(
-                $related_model_universal_where_params,
-                $where_query_params,
-                $related_model,
-                $model_relation_path
-            );
-            $universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
-                $universal_query_params,
-                $overrides
-            );
-        }
-        return $universal_query_params;
-    }
-
-
-    /**
-     * Determines whether or not we should use default where conditions for the model in question
-     * (this model, or other related models).
-     * Basically, we should use default where conditions on this model if they have requested to use them on all models,
-     * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
-     * We should use default where conditions on related models when they requested to use default where conditions
-     * on all models, or specifically just on other related models
-     *
-     * @param      $default_where_conditions_value
-     * @param bool $for_this_model false means this is for OTHER related models
-     * @return bool
-     */
-    private function _should_use_default_where_conditions($default_where_conditions_value, $for_this_model = true)
-    {
-        return (
-                   $for_this_model
-                   && in_array(
-                       $default_where_conditions_value,
-                       [
-                           EEM_Base::default_where_conditions_all,
-                           EEM_Base::default_where_conditions_this_only,
-                           EEM_Base::default_where_conditions_minimum_others,
-                       ],
-                       true
-                   )
-               )
-               || (
-                   ! $for_this_model
-                   && in_array(
-                       $default_where_conditions_value,
-                       [
-                           EEM_Base::default_where_conditions_all,
-                           EEM_Base::default_where_conditions_others_only,
-                       ],
-                       true
-                   )
-               );
-    }
-
-
-    /**
-     * Determines whether or not we should use default minimum conditions for the model in question
-     * (this model, or other related models).
-     * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
-     * where conditions.
-     * We should use minimum where conditions on related models if they requested to use minimum where conditions
-     * on this model or others
-     *
-     * @param      $default_where_conditions_value
-     * @param bool $for_this_model false means this is for OTHER related models
-     * @return bool
-     */
-    private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
-    {
-        return (
-                   $for_this_model
-                   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
-               )
-               || (
-                   ! $for_this_model
-                   && in_array(
-                       $default_where_conditions_value,
-                       [
-                           EEM_Base::default_where_conditions_minimum_others,
-                           EEM_Base::default_where_conditions_minimum_all,
-                       ],
-                       true
-                   )
-               );
-    }
-
-
-    /**
-     * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
-     * then we also add a special where condition which allows for that model's primary key
-     * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
-     * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
-     *
-     * @param array    $default_where_conditions
-     * @param array    $provided_where_conditions
-     * @param EEM_Base $model
-     * @param string   $model_relation_path like 'Transaction.Payment.'
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    private function _override_defaults_or_make_null_friendly(
-        $default_where_conditions,
-        $provided_where_conditions,
-        $model,
-        $model_relation_path
-    ) {
-        $null_friendly_where_conditions = [];
-        $none_overridden                = true;
-        $or_condition_key_for_defaults  = 'OR*' . get_class($model);
-        foreach ($default_where_conditions as $key => $val) {
-            if (isset($provided_where_conditions[ $key ])) {
-                $none_overridden = false;
-            } else {
-                $null_friendly_where_conditions[ $or_condition_key_for_defaults ]['AND'][ $key ] = $val;
-            }
-        }
-        if ($none_overridden && $default_where_conditions) {
-            if ($model->has_primary_key_field()) {
-                $null_friendly_where_conditions[ $or_condition_key_for_defaults ][ $model_relation_path
-                                                                                   . "."
-                                                                                   . $model->primary_key_name() ] =
-                    ['IS NULL'];
-            }/*else{
+	/**
+	 * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
+	 */
+	const caps_read       = 'read';
+
+	const caps_read_admin = 'read_admin';
+
+	const caps_edit       = 'edit';
+
+	const caps_delete     = 'delete';
+
+
+	/**
+	 * constant used to show EEM_Base has not yet verified the db on this http request
+	 */
+	const db_verified_none = 0;
+
+	/**
+	 * constant used to show EEM_Base has verified the EE core db on this http request,
+	 * but not the addons' dbs
+	 */
+	const db_verified_core = 1;
+
+	/**
+	 * constant used to show EEM_Base has verified the addons' dbs (and implicitly
+	 * the EE core db too)
+	 */
+	const db_verified_addons = 2;
+
+	/**
+	 * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
+	 *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
+	 *        registrations for non-trashed tickets for non-trashed datetimes)
+	 */
+	const default_where_conditions_all = 'all';
+
+	/**
+	 * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
+	 *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
+	 *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
+	 *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
+	 *        models which share tables with other models, this can return data for the wrong model.
+	 */
+	const default_where_conditions_this_only = 'this_model_only';
+
+	/**
+	 * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
+	 *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
+	 *        return all registrations related to non-trashed tickets and non-trashed datetimes)
+	 */
+	const default_where_conditions_others_only = 'other_models_only';
+
+	/**
+	 * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
+	 *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
+	 *        their table with other models, like the Event and Venue models. For example, when querying for events
+	 *        ordered by their venues' name, this will be sure to only return real events with associated real venues
+	 *        (regardless of whether those events and venues are trashed)
+	 *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
+	 *        events.
+	 */
+	const default_where_conditions_minimum_all = 'minimum';
+
+	/**
+	 * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
+	 *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
+	 *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
+	 *        not)
+	 */
+	const default_where_conditions_minimum_others = 'full_this_minimum_others';
+
+	/**
+	 * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
+	 *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
+	 *        it's possible it will return table entries for other models. You should use
+	 *        EEM_Base::default_where_conditions_minimum_all instead.
+	 */
+	const default_where_conditions_none = 'none';
+
+	/**
+	 * when $_values_already_prepared_by_model_object equals this, we assume
+	 * the data is just like form input that needs to have the model fields'
+	 * prepare_for_set and prepare_for_use_in_db called on it
+	 */
+	const not_prepared_by_model_object = 0;
+
+	/**
+	 * when $_values_already_prepared_by_model_object equals this, we
+	 * assume this value is coming from a model object and doesn't need to have
+	 * prepare_for_set called on it, just prepare_for_use_in_db is used
+	 */
+	const prepared_by_model_object = 1;
+
+	/**
+	 * when $_values_already_prepared_by_model_object equals this, we assume
+	 * the values are already to be used in the database (ie no processing is done
+	 * on them by the model's fields)
+	 */
+	const prepared_for_use_in_db = 2;
+
+	/**
+	 * Flag to indicate whether the values provided to EEM_Base have already been prepared
+	 * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
+	 * They almost always WILL NOT, but it's not necessarily a requirement.
+	 * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
+	 *
+	 * @var boolean
+	 */
+	private $_values_already_prepared_by_model_object = 0;
+
+
+	/**
+	 * @var string
+	 */
+	protected $singular_item = 'Item';
+
+	/**
+	 * @var string
+	 */
+	protected $plural_item = 'Items';
+
+	/**
+	 * array of EE_Table objects for defining which tables comprise this model.
+	 *
+	 * @type EE_Table_Base[] $_tables
+	 */
+	protected $_tables;
+
+	/**
+	 * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
+	 * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
+	 * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
+	 *
+	 * @var EE_Model_Field_Base[][] $_fields
+	 */
+	protected $_fields;
+
+	/**
+	 * array of different kinds of relations
+	 *
+	 * @var EE_Model_Relation_Base[] $_model_relations
+	 */
+	protected $_model_relations;
+
+	/**
+	 * @var EE_Index[] $_indexes
+	 */
+	protected $_indexes = [];
+
+	/**
+	 * Default strategy for getting where conditions on this model. This strategy is used to get default
+	 * where conditions which are added to get_all, update, and delete queries. They can be overridden
+	 * by setting the same columns as used in these queries in the query yourself.
+	 *
+	 * @var EE_Default_Where_Conditions
+	 */
+	protected $_default_where_conditions_strategy;
+
+	/**
+	 * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
+	 * This is particularly useful when you want something between 'none' and 'default'
+	 *
+	 * @var EE_Default_Where_Conditions
+	 */
+	protected $_minimum_where_conditions_strategy;
+
+	/**
+	 * String describing how to find the "owner" of this model's objects.
+	 * When there is a foreign key on this model to the wp_users table, this isn't needed.
+	 * But when there isn't, this indicates which related model, or transiently-related model,
+	 * has the foreign key to the wp_users table.
+	 * Eg, for EEM_Registration this would be 'Event' because registrations are directly
+	 * related to events, and events have a foreign key to wp_users.
+	 * On EEM_Transaction, this would be 'Transaction.Event'
+	 *
+	 * @var string
+	 */
+	protected $_model_chain_to_wp_user = '';
+
+	/**
+	 * String describing how to find the model with a password controlling access to this model. This property has the
+	 * same format as $_model_chain_to_wp_user. This is primarily used by the query param "exclude_protected".
+	 * This value is the path of models to follow to arrive at the model with the password field.
+	 * If it is an empty string, it means this model has the password field. If it is null, it means there is no
+	 * model with a password that should affect reading this on the front-end.
+	 * Eg this is an empty string for the Event model because it has a password.
+	 * This is null for the Registration model, because its event's password has no bearing on whether
+	 * you can read the registration or not on the front-end (it just depends on your capabilities.)
+	 * This is 'Datetime.Event' on the Ticket model, because model queries for tickets that set "exclude_protected"
+	 * should hide tickets for datetimes for events that have a password set.
+	 *
+	 * @var string |null
+	 */
+	protected $model_chain_to_password = null;
+
+	/**
+	 * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
+	 * don't need it (particularly CPT models)
+	 *
+	 * @var bool
+	 */
+	protected $_ignore_where_strategy = false;
+
+	/**
+	 * String used in caps relating to this model. Eg, if the caps relating to this
+	 * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
+	 *
+	 * @var string. If null it hasn't been initialized yet. If false then we
+	 * have indicated capabilities don't apply to this
+	 */
+	protected $_caps_slug = null;
+
+	/**
+	 * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
+	 * and next-level keys are capability names, and values are a
+	 * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
+	 * they specify which context to use (ie, frontend, backend, edit or delete)
+	 * and then each capability in the corresponding sub-array that they're missing
+	 * adds the where conditions onto the query.
+	 *
+	 * @var array
+	 */
+	protected $_cap_restrictions = [
+		self::caps_read       => [],
+		self::caps_read_admin => [],
+		self::caps_edit       => [],
+		self::caps_delete     => [],
+	];
+
+	/**
+	 * Array defining which cap restriction generators to use to create default
+	 * cap restrictions to put in EEM_Base::_cap_restrictions.
+	 * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
+	 * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
+	 * automatically set this to false (not just null).
+	 *
+	 * @var EE_Restriction_Generator_Base[]
+	 */
+	protected $_cap_restriction_generators = [];
+
+	/**
+	 * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
+	 * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
+	 * maps to 'read' because when looking for relevant permissions we're going to use
+	 * 'read' in teh capabilities names like 'ee_read_events' etc.
+	 *
+	 * @var array
+	 */
+	protected $_cap_contexts_to_cap_action_map = [
+		self::caps_read       => 'read',
+		self::caps_read_admin => 'read',
+		self::caps_edit       => 'edit',
+		self::caps_delete     => 'delete',
+	];
+
+	/**
+	 * Timezone
+	 * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
+	 * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
+	 * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
+	 * EE_Datetime_Field data type will have access to it.
+	 *
+	 * @var string
+	 */
+	protected $_timezone;
+
+
+	/**
+	 * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
+	 * multisite.
+	 *
+	 * @var int
+	 */
+	protected static $_model_query_blog_id;
+
+	/**
+	 * A copy of _fields, except the array keys are the model names pointed to by
+	 * the field
+	 *
+	 * @var EE_Model_Field_Base[]
+	 */
+	private $_cache_foreign_key_to_fields = [];
+
+	/**
+	 * Cached list of all the fields on the model, indexed by their name
+	 *
+	 * @var EE_Model_Field_Base[]
+	 */
+	private $_cached_fields = null;
+
+	/**
+	 * Cached list of all the fields on the model, except those that are
+	 * marked as only pertinent to the database
+	 *
+	 * @var EE_Model_Field_Base[]
+	 */
+	private $_cached_fields_non_db_only = null;
+
+	/**
+	 * A cached reference to the primary key for quick lookup
+	 *
+	 * @var EE_Model_Field_Base
+	 */
+	private $_primary_key_field = null;
+
+	/**
+	 * Flag indicating whether this model has a primary key or not
+	 *
+	 * @var boolean
+	 */
+	protected $_has_primary_key_field = null;
+
+	/**
+	 * array in the format:  [ FK alias => full PK ]
+	 * where keys are local column name aliases for foreign keys
+	 * and values are the fully qualified column name for the primary key they represent
+	 *  ex:
+	 *      [ 'Event.EVT_wp_user' => 'WP_User.ID' ]
+	 *
+	 * @var array $foreign_key_aliases
+	 */
+	protected $foreign_key_aliases = [];
+
+	/**
+	 * Whether or not this model is based off a table in WP core only (CPTs should set
+	 * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
+	 * This should be true for models that deal with data that should exist independent of EE.
+	 * For example, if the model can read and insert data that isn't used by EE, this should be true.
+	 * It would be false, however, if you could guarantee the model would only interact with EE data,
+	 * even if it uses a WP core table (eg event and venue models set this to false for that reason:
+	 * they can only read and insert events and venues custom post types, not arbitrary post types)
+	 *
+	 * @var boolean
+	 */
+	protected $_wp_core_model = false;
+
+	/**
+	 * @var bool stores whether this model has a password field or not.
+	 * null until initialized by hasPasswordField()
+	 */
+	protected $has_password_field;
+
+	/**
+	 * @var EE_Password_Field|null Automatically set when calling getPasswordField()
+	 */
+	protected $password_field;
+
+	/**
+	 *    List of valid operators that can be used for querying.
+	 * The keys are all operators we'll accept, the values are the real SQL
+	 * operators used
+	 *
+	 * @var array
+	 */
+	protected $_valid_operators = [
+		'='           => '=',
+		'<='          => '<=',
+		'<'           => '<',
+		'>='          => '>=',
+		'>'           => '>',
+		'!='          => '!=',
+		'LIKE'        => 'LIKE',
+		'like'        => 'LIKE',
+		'NOT_LIKE'    => 'NOT LIKE',
+		'not_like'    => 'NOT LIKE',
+		'NOT LIKE'    => 'NOT LIKE',
+		'not like'    => 'NOT LIKE',
+		'IN'          => 'IN',
+		'in'          => 'IN',
+		'NOT_IN'      => 'NOT IN',
+		'not_in'      => 'NOT IN',
+		'NOT IN'      => 'NOT IN',
+		'not in'      => 'NOT IN',
+		'between'     => 'BETWEEN',
+		'BETWEEN'     => 'BETWEEN',
+		'IS_NOT_NULL' => 'IS NOT NULL',
+		'is_not_null' => 'IS NOT NULL',
+		'IS NOT NULL' => 'IS NOT NULL',
+		'is not null' => 'IS NOT NULL',
+		'IS_NULL'     => 'IS NULL',
+		'is_null'     => 'IS NULL',
+		'IS NULL'     => 'IS NULL',
+		'is null'     => 'IS NULL',
+		'REGEXP'      => 'REGEXP',
+		'regexp'      => 'REGEXP',
+		'NOT_REGEXP'  => 'NOT REGEXP',
+		'not_regexp'  => 'NOT REGEXP',
+		'NOT REGEXP'  => 'NOT REGEXP',
+		'not regexp'  => 'NOT REGEXP',
+	];
+
+	/**
+	 * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
+	 *
+	 * @var array
+	 */
+	protected $_in_style_operators = ['IN', 'NOT IN'];
+
+	/**
+	 * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
+	 * '12-31-2012'"
+	 *
+	 * @var array
+	 */
+	protected $_between_style_operators = ['BETWEEN'];
+
+	/**
+	 * Operators that work like SQL's like: input should be assumed to be a string, already prepared for a LIKE query.
+	 *
+	 * @var array
+	 */
+	protected $_like_style_operators = ['LIKE', 'NOT LIKE'];
+
+	/**
+	 * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
+	 * on a join table.
+	 *
+	 * @var array
+	 */
+	protected $_null_style_operators = ['IS NOT NULL', 'IS NULL'];
+
+	/**
+	 * Allowed values for $query_params['order'] for ordering in queries
+	 *
+	 * @var array
+	 */
+	protected $_allowed_order_values = ['asc', 'desc', 'ASC', 'DESC'];
+
+	/**
+	 * When these are keys in a WHERE or HAVING clause, they are handled much differently
+	 * than regular field names. It is assumed that their values are an array of WHERE conditions
+	 *
+	 * @var array
+	 */
+	private $_logic_query_param_keys = ['not', 'and', 'or', 'NOT', 'AND', 'OR'];
+
+	/**
+	 * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
+	 * 'where', but 'where' clauses are so common that we thought we'd omit it
+	 *
+	 * @var array
+	 */
+	private $_allowed_query_params = [
+		0,
+		'limit',
+		'order_by',
+		'group_by',
+		'having',
+		'force_join',
+		'order',
+		'on_join_limit',
+		'default_where_conditions',
+		'caps',
+		'extra_selects',
+		'exclude_protected',
+	];
+
+	/**
+	 * All the data types that can be used in $wpdb->prepare statements.
+	 *
+	 * @var array
+	 */
+	private $_valid_wpdb_data_types = ['%d', '%s', '%f'];
+
+	/**
+	 * @var EE_Registry $EE
+	 */
+	protected $EE = null;
+
+
+	/**
+	 * Property which, when set, will have this model echo out the next X queries to the page for debugging.
+	 *
+	 * @var int
+	 */
+	protected $_show_next_x_db_queries = 0;
+
+	/**
+	 * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
+	 * it gets saved on this property as an instance of CustomSelects so those selections can be used in
+	 * WHERE, GROUP_BY, etc.
+	 *
+	 * @var CustomSelects
+	 */
+	protected $_custom_selections = [];
+
+	/**
+	 * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
+	 * caches every model object we've fetched from the DB on this request
+	 *
+	 * @var array
+	 */
+	protected $_entity_map;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private static $loader;
+
+	/**
+	 * indicates whether an EEM_Base child has already re-verified the DB
+	 * is ok (we don't want to do it repetitively). Should be set to one the constants
+	 * looking like EEM_Base::db_verified_*
+	 *
+	 * @var int - 0 = none, 1 = core, 2 = addons
+	 */
+	protected static $_db_verification_level = EEM_Base::db_verified_none;
+
+
+	/**
+	 * About all child constructors:
+	 * they should define the _tables, _fields and _model_relations arrays.
+	 * Should ALWAYS be called after child constructor.
+	 * In order to make the child constructors to be as simple as possible, this parent constructor
+	 * finalizes constructing all the object's attributes.
+	 * Generally, rather than requiring a child to code
+	 * $this->_tables = array(
+	 *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
+	 *        ...);
+	 *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
+	 * each EE_Table has a function to set the table's alias after the constructor, using
+	 * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
+	 * do something similar.
+	 *
+	 * @param string $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = '')
+	{
+		// check that the model has not been loaded too soon
+		if (! did_action('AHEE__EE_System__load_espresso_addons')) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The %1$s model can not be loaded before the "AHEE__EE_System__load_espresso_addons" hook has been called. This gives other addons a chance to extend this model.',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		/**
+		 * Set blog id for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
+		 */
+		if (empty(EEM_Base::$_model_query_blog_id)) {
+			EEM_Base::set_model_query_blog_id();
+		}
+		/**
+		 * Filters the list of tables on a model. It is best to NOT use this directly and instead
+		 * just use EE_Register_Model_Extension
+		 *
+		 * @var EE_Table_Base[] $_tables
+		 */
+		$this->_tables = (array)apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
+		foreach ($this->_tables as $table_alias => $table_obj) {
+			/** @var $table_obj EE_Table_Base */
+			$table_obj->_construct_finalize_with_alias($table_alias);
+			if ($table_obj instanceof EE_Secondary_Table) {
+				/** @var $table_obj EE_Secondary_Table */
+				$table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
+			}
+		}
+		/**
+		 * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
+		 * EE_Register_Model_Extension
+		 *
+		 * @param EE_Model_Field_Base[] $_fields
+		 */
+		$this->_fields = (array)apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
+		$this->_invalidate_field_caches();
+		foreach ($this->_fields as $table_alias => $fields_for_table) {
+			if (! array_key_exists($table_alias, $this->_tables)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
+							'event_espresso'
+						),
+						$table_alias,
+						implode(",", $this->_fields)
+					)
+				);
+			}
+			foreach ($fields_for_table as $field_name => $field_obj) {
+				/** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
+				// primary key field base has a slightly different _construct_finalize
+				/** @var $field_obj EE_Model_Field_Base */
+				$field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
+			}
+		}
+		// everything is related to Extra_Meta
+		if (get_class($this) !== 'EEM_Extra_Meta') {
+			// make extra meta related to everything, but don't block deleting things just
+			// because they have related extra meta info. For now just orphan those extra meta
+			// in the future we should automatically delete them
+			$this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
+		}
+		// and change logs
+		if (get_class($this) !== 'EEM_Change_Log') {
+			$this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
+		}
+		/**
+		 * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
+		 * EE_Register_Model_Extension
+		 *
+		 * @param EE_Model_Relation_Base[] $_model_relations
+		 */
+		$this->_model_relations = (array)apply_filters(
+			'FHEE__' . get_class($this) . '__construct__model_relations',
+			$this->_model_relations
+		);
+		foreach ($this->_model_relations as $model_name => $relation_obj) {
+			/** @var $relation_obj EE_Model_Relation_Base */
+			$relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
+		}
+		foreach ($this->_indexes as $index_name => $index_obj) {
+			$index_obj->_construct_finalize($index_name, $this->get_this_model_name());
+		}
+		$this->set_timezone($timezone);
+		// finalize default where condition strategy, or set default
+		if (! $this->_default_where_conditions_strategy) {
+			// nothing was set during child constructor, so set default
+			$this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
+		}
+		$this->_default_where_conditions_strategy->_finalize_construct($this);
+		if (! $this->_minimum_where_conditions_strategy) {
+			// nothing was set during child constructor, so set default
+			$this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
+		}
+		$this->_minimum_where_conditions_strategy->_finalize_construct($this);
+		// if the cap slug hasn't been set, and we haven't set it to false on purpose
+		// to indicate to NOT set it, set it to the logical default
+		if ($this->_caps_slug === null) {
+			$this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
+		}
+		// initialize the standard cap restriction generators if none were specified by the child constructor
+		if (! empty($this->_cap_restriction_generators)) {
+			foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
+				if (! isset($this->_cap_restriction_generators[ $cap_context ])) {
+					$this->_cap_restriction_generators[ $cap_context ] = apply_filters(
+						'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
+						new EE_Restriction_Generator_Protected(),
+						$cap_context,
+						$this
+					);
+				}
+			}
+		// }
+		// if ($this->_cap_restriction_generators !== false) {
+		// if there are cap restriction generators, use them to make the default cap restrictions
+			foreach ($this->_cap_restriction_generators as $context => $generator_object) {
+				if (! $generator_object) {
+					continue;
+				}
+				if (! $generator_object instanceof EE_Restriction_Generator_Base) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'Index "%1$s" in the model %2$s\'s _cap_restriction_generators is not a child of EE_Restriction_Generator_Base. It should be that or NULL.',
+								'event_espresso'
+							),
+							$context,
+							$this->get_this_model_name()
+						)
+					);
+				}
+				$action = $this->cap_action_for_context($context);
+				if (! $generator_object->construction_finalized()) {
+					$generator_object->_construct_finalize($this, $action);
+				}
+			}
+		}
+		do_action('AHEE__' . get_class($this) . '__construct__end');
+	}
+
+
+	/**
+	 * Used to set the $_model_query_blog_id static property.
+	 *
+	 * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
+	 *                      value for get_current_blog_id() will be used.
+	 */
+	public static function set_model_query_blog_id($blog_id = 0)
+	{
+		EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
+	}
+
+
+	/**
+	 * Returns whatever is set as the internal $model_query_blog_id.
+	 *
+	 * @return int
+	 */
+	public static function get_model_query_blog_id()
+	{
+		return EEM_Base::$_model_query_blog_id;
+	}
+
+
+	/**
+	 * This function is a singleton method used to instantiate the Espresso_model object
+	 *
+	 * @param string $timezone        string representing the timezone we want to set for returned Date Time Strings
+	 *                                (and any incoming timezone data that gets saved).
+	 *                                Note this just sends the timezone info to the date time model field objects.
+	 *                                Default is NULL
+	 *                                (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @return static (as in the concrete child class)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function instance($timezone = '')
+	{
+		// check if instance of Espresso_model already exists
+		if (! static::$_instance instanceof static) {
+			// instantiate Espresso_model
+			static::$_instance = new static(
+				$timezone,
+				LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory')
+			);
+		}
+		// Espresso model object
+		return static::$_instance;
+	}
+
+
+	/**
+	 * resets the model and returns it
+	 *
+	 * @param string $timezone
+	 * @return EEM_Base|null (if the model was already instantiated, returns it, with
+	 * all its properties reset; if it wasn't instantiated, returns null)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function reset($timezone = '')
+	{
+		if (static::$_instance instanceof EEM_Base) {
+			// let's try to NOT swap out the current instance for a new one
+			// because if someone has a reference to it, we can't remove their reference
+			// so it's best to keep using the same reference, but change the original object
+			// reset all its properties to their original values as defined in the class
+			$r                 = new ReflectionClass(get_class(static::$_instance));
+			$static_properties = $r->getStaticProperties();
+			foreach ($r->getDefaultProperties() as $property => $value) {
+				// don't set instance to null like it was originally,
+				// but it's static anyways, and we're ignoring static properties (for now at least)
+				if (! isset($static_properties[ $property ])) {
+					static::$_instance->{$property} = $value;
+				}
+			}
+			EEH_DTT_Helper::resetDefaultTimezoneString();
+			// and then directly call its constructor again, like we would if we were creating a new one
+			static::$_instance->__construct(
+				$timezone,
+				LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory')
+			);
+			return static::instance();
+		}
+		return null;
+	}
+
+
+	/**
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function getLoader()
+	{
+		if (! EEM_Base::$loader instanceof LoaderInterface) {
+			EEM_Base::$loader = LoaderFactory::getLoader();
+		}
+		return EEM_Base::$loader;
+	}
+
+
+	/**
+	 * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
+	 *
+	 * @param boolean $translated return localized strings or JUST the array.
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_array($translated = false)
+	{
+		if (! array_key_exists('Status', $this->_model_relations)) {
+			return [];
+		}
+		$model_name   = $this->get_this_model_name();
+		$status_type  = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
+		$statuses      = EEM_Status::instance()->get_all([['STS_type' => $status_type]]);
+		$status_array = [];
+		foreach ($statuses as $status) {
+			$status_array[ $status->ID() ] = $status->get('STS_code');
+		}
+		return $translated
+			? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
+			: $status_array;
+	}
+
+
+	/**
+	 * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
+	 *
+	 * @param array $query_params             see github link below for more info
+	 * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
+	 *                                        from EE_Base_Class[], use get_all_wpdb_results(). Array keys are object
+	 *                                        IDs (if there is a primary key on the model. if not, numerically indexed)
+	 *                                        Some full examples: get 10 transactions which have Scottish attendees:
+	 *                                        EEM_Transaction::instance()->get_all( array( array(
+	 *                                        'OR'=>array(
+	 *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
+	 *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
+	 *                                        )
+	 *                                        ),
+	 *                                        'limit'=>10,
+	 *                                        'group_by'=>'TXN_ID'
+	 *                                        ));
+	 *                                        get all the answers to the question titled "shirt size" for event with id
+	 *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
+	 *                                        'Question.QST_display_text'=>'shirt size',
+	 *                                        'Registration.Event.EVT_ID'=>12
+	 *                                        ),
+	 *                                        'order_by'=>array('ANS_value'=>'ASC')
+	 *                                        ));
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 *                                        or if you have the development copy of EE you can view this at the path:
+	 *                                        /docs/G--Model-System/model-query-params.md
+	 */
+	public function get_all($query_params = [])
+	{
+		if (
+			isset($query_params['limit'])
+			&& ! isset($query_params['group_by'])
+		) {
+			$query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
+		}
+		return $this->_create_objects($this->_get_all_wpdb_results($query_params));
+	}
+
+
+	/**
+	 * Modifies the query parameters so we only get back model objects
+	 * that "belong" to the current user
+	 *
+	 * @param array $query_params see github link below for more info
+	 * @return array
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function alter_query_params_to_only_include_mine($query_params = [])
+	{
+		$wp_user_field_name = $this->wp_user_field_name();
+		if ($wp_user_field_name) {
+			$query_params[0][ $wp_user_field_name ] = get_current_user_id();
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * Returns the name of the field's name that points to the WP_User table
+	 *  on this model (or follows the _model_chain_to_wp_user and uses that model's
+	 * foreign key to the WP_User table)
+	 *
+	 * @return string|boolean string on success, boolean false when there is no
+	 * foreign key to the WP_User table
+	 * @throws ReflectionException
+	 */
+	public function wp_user_field_name()
+	{
+		try {
+			if (! empty($this->_model_chain_to_wp_user)) {
+				$models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
+				$last_model_name              = end($models_to_follow_to_wp_users);
+				$model_with_fk_to_wp_users    = EE_Registry::instance()->load_model($last_model_name);
+				$model_chain_to_wp_user       = $this->_model_chain_to_wp_user . '.';
+			} else {
+				$model_with_fk_to_wp_users = $this;
+				$model_chain_to_wp_user    = '';
+			}
+			$wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
+			return $model_chain_to_wp_user . $wp_user_field->get_name();
+		} catch (EE_Error $e) {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Returns the _model_chain_to_wp_user string, which indicates which related model
+	 * (or transiently-related model) has a foreign key to the wp_users table;
+	 * useful for finding if model objects of this type are 'owned' by the current user.
+	 * This is an empty string when the foreign key is on this model and when it isn't,
+	 * but is only non-empty when this model's ownership is indicated by a RELATED model
+	 * (or transiently-related model)
+	 *
+	 * @return string
+	 */
+	public function model_chain_to_wp_user()
+	{
+		return $this->_model_chain_to_wp_user;
+	}
+
+
+	/**
+	 * Whether this model is 'owned' by a specific wordpress user (even indirectly,
+	 * like how registrations don't have a foreign key to wp_users, but the
+	 * events they are for are), or is unrelated to wp users.
+	 * generally available
+	 *
+	 * @return boolean
+	 */
+	public function is_owned()
+	{
+		if ($this->model_chain_to_wp_user()) {
+			return true;
+		}
+		try {
+			$this->get_foreign_key_to('WP_User');
+			return true;
+		} catch (EE_Error $e) {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
+	 * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
+	 * the model)
+	 *
+	 * @param array  $query_params
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
+	 *                                  override this and set the select to "*", or a specific column name, like
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
+	 *                                  the aliases used to refer to this selection, and values are to be
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
+	 * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _get_all_wpdb_results($query_params = [], $output = ARRAY_A, $columns_to_select = null)
+	{
+		$this->_custom_selections = $this->getCustomSelection($query_params, $columns_to_select);
+		$model_query_info         = $this->_create_model_query_info_carrier($query_params);
+		$select_expressions       = $columns_to_select === null
+			? $this->_construct_default_select_sql($model_query_info)
+			: '';
+		if ($this->_custom_selections instanceof CustomSelects) {
+			$custom_expressions = $this->_custom_selections->columnsToSelectExpression();
+			$select_expressions .= $select_expressions
+				? ', ' . $custom_expressions
+				: $custom_expressions;
+		}
+
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
+		return $this->_do_wpdb_query('get_results', [$SQL, $output]);
+	}
+
+
+	/**
+	 * Get a CustomSelects object if the $query_params or $columns_to_select allows for it.
+	 * Note: $query_params['extra_selects'] will always override any $columns_to_select values. It is the preferred
+	 * method of including extra select information.
+	 *
+	 * @param array             $query_params
+	 * @param null|array|string $columns_to_select
+	 * @return null|CustomSelects
+	 * @throws InvalidArgumentException
+	 */
+	protected function getCustomSelection(array $query_params, $columns_to_select = null)
+	{
+		if (! isset($query_params['extra_selects']) && $columns_to_select === null) {
+			return null;
+		}
+		$selects = isset($query_params['extra_selects']) ? $query_params['extra_selects'] : $columns_to_select;
+		$selects = is_string($selects) ? explode(',', $selects) : $selects;
+		return new CustomSelects($selects);
+	}
+
+
+	/**
+	 * Gets an array of rows from the database just like $wpdb->get_results would,
+	 * but you can use the model query params to more easily
+	 * take care of joins, field preparation etc.
+	 *
+	 * @param array  $query_params
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
+	 *                                  override this and set the select to "*", or a specific column name, like
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
+	 *                                  the aliases used to refer to this selection, and values are to be
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
+	 * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
+	 * @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 get_all_wpdb_results($query_params = [], $output = ARRAY_A, $columns_to_select = null)
+	{
+		return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
+	}
+
+
+	/**
+	 * For creating a custom select statement
+	 *
+	 * @param array|string $columns_to_select either a string to be inserted directly as the select statement,
+	 *                                        or an array where keys are aliases, and values are arrays where 0=>the
+	 *                                        selection SQL, and 1=>is the datatype
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _construct_select_from_input($columns_to_select)
+	{
+		if (is_array($columns_to_select)) {
+			$select_sql_array = [];
+			foreach ($columns_to_select as $alias => $selection_and_datatype) {
+				if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								"Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
+								'event_espresso'
+							),
+							$selection_and_datatype,
+							$alias
+						)
+					);
+				}
+				if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types, true)) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								"Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
+								'event_espresso'
+							),
+							$selection_and_datatype[1],
+							$selection_and_datatype[0],
+							$alias,
+							implode(', ', $this->_valid_wpdb_data_types)
+						)
+					);
+				}
+				$select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
+			}
+			$columns_to_select_string = implode(', ', $select_sql_array);
+		} else {
+			$columns_to_select_string = $columns_to_select;
+		}
+		return $columns_to_select_string;
+	}
+
+
+	/**
+	 * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function primary_key_name()
+	{
+		return $this->get_primary_key_field()->get_name();
+	}
+
+
+	/**
+	 * Gets a single item for this model from the DB, given only its ID (or null if none is found).
+	 * If there is no primary key on this model, $id is treated as primary key string
+	 *
+	 * @param mixed $id int or string, depending on the type of the model's primary key
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one_by_ID($id)
+	{
+		if ($this->get_from_entity_map($id)) {
+			return $this->get_from_entity_map($id);
+		}
+		$model_object = $this->get_one(
+			$this->alter_query_params_to_restrict_by_ID(
+				$id,
+				['default_where_conditions' => EEM_Base::default_where_conditions_minimum_all]
+			)
+		);
+		$className = $this->_get_class_name();
+		if ($model_object instanceof $className) {
+			// make sure valid objects get added to the entity map
+			// so that the next call to this method doesn't trigger another trip to the db
+			$this->add_to_entity_map($model_object);
+		}
+		return $model_object;
+	}
+
+
+	/**
+	 * Alters query parameters to only get items with this ID are returned.
+	 * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
+	 * or could just be a simple primary key ID
+	 *
+	 * @param int   $id
+	 * @param array $query_params see github link below for more info
+	 * @return array of normal query params,
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function alter_query_params_to_restrict_by_ID($id, $query_params = [])
+	{
+		if (! isset($query_params[0])) {
+			$query_params[0] = [];
+		}
+		$conditions_from_id = $this->parse_index_primary_key_string($id);
+		if ($conditions_from_id === null) {
+			$query_params[0][ $this->primary_key_name() ] = $id;
+		} else {
+			// no primary key, so the $id must be from the get_index_primary_key_string()
+			$query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
+	 * array. If no item is found, null is returned.
+	 *
+	 * @param array $query_params like EEM_Base's $query_params variable.
+	 * @return EE_Base_Class|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one(array $query_params = [])
+	{
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong(
+				'EEM_Base::get_one',
+				sprintf(
+					esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = [];
+		}
+		$query_params['limit'] = 1;
+		$items                 = $this->get_all($query_params);
+		if (empty($items)) {
+			return null;
+		}
+		return array_shift($items);
+	}
+
+
+	/**
+	 * Returns the next x number of items in sequence from the given value as
+	 * found in the database matching the given query conditions.
+	 *
+	 * @param mixed $current_field_value    Value used for the reference point.
+	 * @param null  $field_to_order_by      What field is used for the
+	 *                                      reference point.
+	 * @param int   $limit                  How many to return.
+	 * @param array $query_params           Extra 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 EE_Base_Class[]|array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function next_x(
+		$current_field_value,
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = [],
+		$columns_to_select = null
+	) {
+		return $this->_get_consecutive(
+			$current_field_value,
+			'>',
+			$field_to_order_by,
+			$limit,
+			$query_params,
+			$columns_to_select
+		);
+	}
+
+
+	/**
+	 * Returns the previous x number of items in sequence from the given value
+	 * as found in the database matching the given query conditions.
+	 *
+	 * @param mixed $current_field_value    Value used for the reference point.
+	 * @param null  $field_to_order_by      What field is used for the
+	 *                                      reference point.
+	 * @param int   $limit                  How many to return.
+	 * @param array $query_params           Extra 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 EE_Base_Class[]|array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function previous_x(
+		$current_field_value,
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = [],
+		$columns_to_select = null
+	) {
+		return $this->_get_consecutive(
+			$current_field_value,
+			'<',
+			$field_to_order_by,
+			$limit,
+			$query_params,
+			$columns_to_select
+		);
+	}
+
+
+	/**
+	 * Returns the next item in sequence from the given value as found in the
+	 * database matching the given query conditions.
+	 *
+	 * @param mixed $current_field_value    Value used for the reference point.
+	 * @param null  $field_to_order_by      What field is used for the
+	 *                                      reference point.
+	 * @param array $query_params           Extra 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 columns you
+	 *                                      want and a single array indexed by
+	 *                                      the columns will be returned.
+	 * @return EE_Base_Class|null|array()
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function next(
+		$current_field_value,
+		$field_to_order_by = null,
+		$query_params = [],
+		$columns_to_select = null
+	) {
+		$results = $this->_get_consecutive(
+			$current_field_value,
+			'>',
+			$field_to_order_by,
+			1,
+			$query_params,
+			$columns_to_select
+		);
+		return empty($results) ? null : reset($results);
+	}
+
+
+	/**
+	 * Returns the previous item in sequence from the given value as found in
+	 * the database matching the given query conditions.
+	 *
+	 * @param mixed $current_field_value    Value used for the reference point.
+	 * @param null  $field_to_order_by      What field is used for the
+	 *                                      reference point.
+	 * @param array $query_params           Extra 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 columns you
+	 *                                      want and a single array indexed by
+	 *                                      the columns will be returned.
+	 * @return EE_Base_Class|null|array()
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function previous(
+		$current_field_value,
+		$field_to_order_by = null,
+		$query_params = [],
+		$columns_to_select = null
+	) {
+		$results = $this->_get_consecutive(
+			$current_field_value,
+			'<',
+			$field_to_order_by,
+			1,
+			$query_params,
+			$columns_to_select
+		);
+		return empty($results) ? null : reset($results);
+	}
+
+
+	/**
+	 * Returns the a consecutive number of items in sequence from the given
+	 * value as found in the database matching the given query conditions.
+	 *
+	 * @param mixed  $current_field_value   Value used for the reference point.
+	 * @param string $operand               What operand is used for the sequence.
+	 * @param string $field_to_order_by     What field is used for the reference point.
+	 * @param int    $limit                 How many to return.
+	 * @param array  $query_params          Extra 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 EE_Base_Class[]|array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_consecutive(
+		$current_field_value,
+		$operand = '>',
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = [],
+		$columns_to_select = null
+	) {
+		// if $field_to_order_by is empty then let's assume we're ordering by the primary key.
+		if (empty($field_to_order_by)) {
+			if ($this->has_primary_key_field()) {
+				$field_to_order_by = $this->get_primary_key_field()->get_name();
+			} else {
+				if (WP_DEBUG) {
+					throw new EE_Error(
+						esc_html__(
+							'EEM_Base::_get_consecutive() has been called with no $field_to_order_by argument and there is no primary key on the field.  Please provide the field you would like to use as the base for retrieving the next item(s).',
+							'event_espresso'
+						)
+					);
+				}
+				EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
+				return [];
+			}
+		}
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong(
+				'EEM_Base::_get_consecutive',
+				sprintf(
+					esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = [];
+		}
+		// let's add the where query param for consecutive look up.
+		$query_params[0][ $field_to_order_by ] = [$operand, $current_field_value];
+		$query_params['limit']                 = $limit;
+		// set direction
+		$incoming_orderby         = isset($query_params['order_by']) ? (array)$query_params['order_by'] : [];
+		$query_params['order_by'] = $operand === '>'
+			? [$field_to_order_by => 'ASC'] + $incoming_orderby
+			: [$field_to_order_by => 'DESC'] + $incoming_orderby;
+		// if $columns_to_select is empty then that means we're returning EE_Base_Class objects
+		if (empty($columns_to_select)) {
+			return $this->get_all($query_params);
+		}
+		// getting just the fields
+		return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
+	}
+
+
+	/**
+	 * This sets the _timezone property after model object has been instantiated.
+	 *
+	 * @param string|null $timezone valid PHP DateTimeZone timezone string
+	 */
+	public function set_timezone($timezone = '')
+	{
+		static $set_in_progress = false;
+		// if incoming timezone string is empty, then use the existing
+		$valid_timezone = ! empty($timezone) && $timezone !== $this->_timezone
+			? EEH_DTT_Helper::get_valid_timezone_string($timezone)
+			: $this->_timezone;
+		// do NOT set the timezone if we are already in the process of setting the timezone
+		// OR the existing timezone is already set and the incoming value is nothing (which gets set to default TZ)
+		// OR the existing timezone is already set and the validated value is the same as the existing timezone
+		if (
+			$set_in_progress
+			|| (
+				! empty($this->_timezone)
+				&& (
+					empty($timezone) || $valid_timezone === $this->_timezone
+				)
+			)
+		) {
+			return;
+		}
+		$set_in_progress = true;
+		$this->_timezone = $valid_timezone ?: EEH_DTT_Helper::get_valid_timezone_string();
+		// note we need to loop through relations and set the timezone on those objects as well.
+		foreach ($this->_model_relations as $relation) {
+			$relation->set_timezone($this->_timezone);
+		}
+		// and finally we do the same for any datetime fields
+		foreach ($this->_fields as $field) {
+			if ($field instanceof EE_Datetime_Field) {
+				$field->set_timezone($this->_timezone);
+			}
+		}
+		$set_in_progress = false;
+	}
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function get_timezone()
+	{
+		if (empty($this->_timezone)) {
+			$this->set_timezone();
+		}
+		return $this->_timezone;
+	}
+
+
+	/**
+	 * This returns the date formats set for the given field name and also ensures that
+	 * $this->_timezone property is set correctly.
+	 *
+	 * @param string $field_name The name of the field the formats are being retrieved for.
+	 * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
+	 * @return array formats in an array with the date format first, and the time format last.
+	 * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
+	 * @since 4.6.x
+	 */
+	public function get_formats_for($field_name, $pretty = false)
+	{
+		$field_settings = $this->field_settings_for($field_name);
+		// if not a valid EE_Datetime_Field then throw error
+		if (! $field_settings instanceof EE_Datetime_Field) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The field sent into EEM_Base::get_formats_for (%s) is not registered as a EE_Datetime_Field. Please check the spelling and make sure you are submitting the right field name to retrieve date_formats for.',
+						'event_espresso'
+					),
+					$field_name
+				)
+			);
+		}
+		// while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on the field.
+		$field_timezone = $field_settings->get_timezone();
+		if (empty($this->_timezone && $field_timezone)) {
+			$this->set_timezone();
+		} else {
+			// or vice versa if the field TZ isn't set
+			$model_timezone = $this->get_timezone();
+			$field_settings->set_timezone($model_timezone);
+		}
+
+		return [$field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty)];
+	}
+
+
+	/**
+	 * This returns the current time in a format setup for a query on this model.
+	 * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
+	 * it will return:
+	 *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field
+	 *    for the given field for NOW
+	 *  - or a unix timestamp (equivalent to time())
+	 * Note: When requesting a formatted string, if the date or time format doesn't include seconds, for example,
+	 * the time returned, because it uses that format, will also NOT include seconds. For this reason, if you want
+	 * the time returned to be the current time down to the exact second, set $timestamp to true.
+	 *
+	 * @param string $field_name    The field the current time is needed for.
+	 * @param bool $timestamp       True means to return a unix timestamp.
+	 *                              Otherwise a formatted string matching the set format for the field
+	 *                              in the set timezone will be returned.
+	 * @param string $what          Whether to return the string in just the time format, the date format, or both.
+	 * @return string               If the given field_name is not of the EE_Datetime_Field type,
+	 *                              then an EE_Error exception is triggered.
+	 * @throws EE_Error             If the given field_name is not of the EE_Datetime_Field type.
+	 * @throws Exception
+	 * @since 4.6.x
+	 */
+	public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
+	{
+		$formats  = $this->get_formats_for($field_name);
+		$DateTime = new DateTime("now", new DateTimeZone($this->get_timezone()));
+		if ($timestamp) {
+			return $DateTime->format('U');
+		}
+		// not returning timestamp, so return formatted string in timezone.
+		switch ($what) {
+			case 'time':
+				return $DateTime->format($formats[1]);
+			case 'date':
+				return $DateTime->format($formats[0]);
+			default:
+				return $DateTime->format(implode(' ', $formats));
+		}
+	}
+
+
+	/**
+	 * This receives a time string for a given field and ensures that it is setup to match what the internal settings
+	 * for the model are.  Returns a DateTime object.
+	 * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
+	 * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
+	 * ignored.
+	 *
+	 * @param string $field_name    The field being setup.
+	 * @param string $timestring    The date time string being used.
+	 * @param string $format        The format for the time string.
+	 * @param string $timezone      By default, it is assumed the incoming time string is in timezone for
+	 *                              the blog.  If this is not the case, then it can be specified here.
+	 *                              If incoming format is 'U', this is ignored.
+	 * @return DbSafeDateTime
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function convert_datetime_for_query($field_name, $timestring, $format, $timezone = '')
+	{
+		// just using this to ensure the timezone is set correctly internally
+		$this->get_formats_for($field_name);
+		$timezone         = ! empty($timezone) ? $timezone : EEH_DTT_Helper::get_timezone();
+		$db_safe_datetime = DbSafeDateTime::createFromFormat($format, $timestring, new DateTimeZone($timezone));
+		EEH_DTT_Helper::setTimezone($db_safe_datetime, new DateTimeZone($this->get_timezone()));
+		return $db_safe_datetime;
+	}
+
+
+	/**
+	 * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
+	 *
+	 * @return EE_Table_Base[]
+	 */
+	public function get_tables()
+	{
+		return $this->_tables;
+	}
+
+
+	/**
+	 * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
+	 * also updates all the model objects, where the criteria expressed in $query_params are met..
+	 * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
+	 * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
+	 * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
+	 * model object with EVT_ID = 1
+	 * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
+	 * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
+	 * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
+	 * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
+	 * are not specified)
+	 *
+	 * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
+	 *                                         columns!), values are strings, integers, floats, and maybe arrays if
+	 *                                         they
+	 *                                         are to be serialized. Basically, the values are what you'd expect to be
+	 *                                         values on the model, NOT necessarily what's in the DB. For example, if
+	 *                                         we wanted to update only the TXN_details on any Transactions where its
+	 *                                         ID=34, we'd use this method as follows:
+	 *                                         EEM_Transaction::instance()->update(
+	 *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
+	 *                                         array(array('TXN_ID'=>34)));
+	 * @param array   $query_params            Eg, consider updating Question's QST_admin_label field is of type
+	 *                                         Simple_HTML. If you use this function to update that field to $new_value
+	 *                                         = (note replace 8's with appropriate opening and closing tags in the
+	 *                                         following example)"8script8alert('I hack all');8/script88b8boom
+	 *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
+	 *                                         TRUE, it is assumed that you've already called
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
+	 *                                         malicious javascript. However, if
+	 *                                         $values_already_prepared_by_model_object is left as FALSE, then
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
+	 *                                         and every other field, before insertion. We provide this parameter
+	 *                                         because model objects perform their prepare_for_set function on all
+	 *                                         their values, and so don't need to be called again (and in many cases,
+	 *                                         shouldn't be called again. Eg: if we escape HTML characters in the
+	 *                                         prepare_for_set method...)
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
+	 *                                         in this model's entity map according to $fields_n_values that match
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
+	 *                                         by setting this to FALSE, but be aware that model objects being used
+	 *                                         could get out-of-sync with the database
+	 * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
+	 *                                         rows affected which *could* include 0 which DOES NOT mean the query was
+	 *                                         bad)
+	 * @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 update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
+	{
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong(
+				'EEM_Base::update',
+				sprintf(
+					esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = [];
+		}
+		/**
+		 * Action called before a model update call has been made.
+		 *
+		 * @param EEM_Base $model
+		 * @param array    $fields_n_values the updated fields and their new values
+		 * @param array    $query_params
+		 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+		 */
+		do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
+		/**
+		 * Filters the fields about to be updated given the query parameters. You can provide the
+		 * $query_params to $this->get_all() to find exactly which records will be updated
+		 *
+		 * @param array    $fields_n_values fields and their new values
+		 * @param EEM_Base $model           the model being queried
+		 * @param array    $query_params
+		 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+		 */
+		$fields_n_values = (array)apply_filters(
+			'FHEE__EEM_Base__update__fields_n_values',
+			$fields_n_values,
+			$this,
+			$query_params
+		);
+		// need to verify that, for any entry we want to update, there are entries in each secondary table.
+		// to do that, for each table, verify that it's PK isn't null.
+		$tables = $this->get_tables();
+		// and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
+		// NOTE: we should make this code more efficient by NOT querying twice
+		// before the real update, but that needs to first go through ALPHA testing
+		// as it's dangerous. says Mike August 8 2014
+		// we want to make sure the default_where strategy is ignored
+		$this->_ignore_where_strategy = true;
+		$wpdb_select_results          = $this->_get_all_wpdb_results($query_params);
+		foreach ($wpdb_select_results as $wpdb_result) {
+			// type cast stdClass as array
+			$wpdb_result = (array)$wpdb_result;
+			// get the model object's PK, as we'll want this if we need to insert a row into secondary tables
+			if ($this->has_primary_key_field()) {
+				$main_table_pk_value = $wpdb_result[ $this->get_primary_key_field()->get_qualified_column() ];
+			} else {
+				// if there's no primary key, we basically can't support having a 2nd table on the model (we could but it would be lots of work)
+				$main_table_pk_value = null;
+			}
+			// if there are more than 1 tables, we'll want to verify that each table for this model has an entry in the other tables
+			// and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
+			if (count($tables) > 1) {
+				// foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
+				// in that table, and so we'll want to insert one
+				foreach ($tables as $table_obj) {
+					$this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
+					// if there is no private key for this table on the results, it means there's no entry
+					// in this table, right? so insert a row in the current table, using any fields available
+					if (
+					! (array_key_exists($this_table_pk_column, $wpdb_result)
+					   && $wpdb_result[ $this_table_pk_column ])
+					) {
+						$success = $this->_insert_into_specific_table(
+							$table_obj,
+							$fields_n_values,
+							$main_table_pk_value
+						);
+						// if we died here, report the error
+						if (! $success) {
+							return false;
+						}
+					}
+				}
+			}
+			// let's make sure default_where strategy is followed now
+			$this->_ignore_where_strategy = false;
+		}
+		// if we want to keep model objects in sync, AND
+		// if this wasn't called from a model object (to update itself)
+		// then we want to make sure we keep all the existing
+		// model objects in sync with the db
+		if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
+			if ($this->has_primary_key_field()) {
+				$model_objs_affected_ids = $this->get_col($query_params);
+			} else {
+				// we need to select a bunch of columns and then combine them into the the "index primary key string"s
+				$models_affected_key_columns = $this->_get_all_wpdb_results($query_params);
+				$model_objs_affected_ids     = [];
+				foreach ($models_affected_key_columns as $row) {
+					$combined_index_key                             = $this->get_index_primary_key_string($row);
+					$model_objs_affected_ids[ $combined_index_key ] = $combined_index_key;
+				}
+			}
+			if (! $model_objs_affected_ids) {
+				// wait wait wait- if nothing was affected let's stop here
+				return 0;
+			}
+			foreach ($model_objs_affected_ids as $id) {
+				$model_obj_in_entity_map = $this->get_from_entity_map($id);
+				if ($model_obj_in_entity_map) {
+					foreach ($fields_n_values as $field => $new_value) {
+						$model_obj_in_entity_map->set($field, $new_value);
+					}
+				}
+			}
+			// if there is a primary key on this model, we can now do a slight optimization
+			if ($this->has_primary_key_field()) {
+				// we already know what we want to update. So let's make the query simpler so it's a little more efficient
+				$query_params = [
+					[$this->primary_key_name() => ['IN', $model_objs_affected_ids]],
+					'limit'                    => count($model_objs_affected_ids),
+					'default_where_conditions' => EEM_Base::default_where_conditions_none,
+				];
+			}
+		}
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
+		$SQL              = "UPDATE " . $model_query_info->get_full_join_sql()
+							. " SET " . $this->_construct_update_sql($fields_n_values)
+							. $model_query_info->get_where_sql();
+		// note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
+		$rows_affected    = $this->_do_wpdb_query('query', [$SQL]);
+		/**
+		 * Action called after a model update call has been made.
+		 *
+		 * @param EEM_Base $model
+		 * @param array    $fields_n_values the updated fields and their new values
+		 * @param array    $query_params
+		 * @param int      $rows_affected
+		 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+		 */
+		do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
+		return $rows_affected;// how many supposedly got updated
+	}
+
+
+	/**
+	 * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
+	 * are teh values of the field specified (or by default the primary key field)
+	 * that matched the query params. Note that you should pass the name of the
+	 * model FIELD, not the database table's column name.
+	 *
+	 * @param array  $query_params
+	 * @param string $field_to_select
+	 * @return array just like $wpdb->get_col()
+	 * @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 get_col($query_params = [], $field_to_select = null)
+	{
+		if ($field_to_select) {
+			$field = $this->field_settings_for($field_to_select);
+		} elseif ($this->has_primary_key_field()) {
+			$field = $this->get_primary_key_field();
+		} else {
+			$field_settings = $this->field_settings();
+			// no primary key, just grab the first column
+			$field = reset($field_settings);
+		}
+		$model_query_info   = $this->_create_model_query_info_carrier($query_params);
+		$select_expressions = $field->get_qualified_column();
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
+		return $this->_do_wpdb_query('get_col', [$SQL]);
+	}
+
+
+	/**
+	 * Returns a single column value for a single row from the database
+	 *
+	 * @param array  $query_params
+	 * @param string $field_to_select
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see EEM_Base::get_col()
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_var($query_params = [], $field_to_select = null)
+	{
+		$query_params['limit'] = 1;
+		$col                   = $this->get_col($query_params, $field_to_select);
+		if (! empty($col)) {
+			return reset($col);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
+	 * time?', Question.desc='what do you think?'..." Values are filtered through wpdb->prepare to avoid against SQL
+	 * injection, but currently no further filtering is done
+	 *
+	 * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
+	 *                               be updated to in the DB
+	 * @return string of SQL
+	 * @throws EE_Error
+	 * @global      $wpdb
+	 */
+	public function _construct_update_sql($fields_n_values)
+	{
+		global $wpdb;
+		$cols_n_values = [];
+		foreach ($fields_n_values as $field_name => $value) {
+			$field_obj = $this->field_settings_for($field_name);
+			// if the value is NULL, we want to assign the value to that.
+			// wpdb->prepare doesn't really handle that properly
+			$prepared_value  = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
+			$value_sql       = $prepared_value === null
+				? 'NULL'
+				: $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
+			$cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
+		}
+		return implode(",", $cols_n_values);
+	}
+
+
+	/**
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
+	 * Performs a HARD delete, meaning the database row should always be removed,
+	 * not just have a flag field on it switched
+	 * Wrapper for EEM_Base::delete_permanently()
+	 *
+	 * @param mixed   $id
+	 * @param boolean $allow_blocking
+	 * @return int the number of rows deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_permanently_by_ID($id, $allow_blocking = true)
+	{
+		return $this->delete_permanently(
+			[
+				[$this->get_primary_key_field()->get_name() => $id],
+				'limit' => 1,
+			],
+			$allow_blocking
+		);
+	}
+
+
+	/**
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
+	 * Wrapper for EEM_Base::delete()
+	 *
+	 * @param mixed   $id
+	 * @param boolean $allow_blocking
+	 * @return int the number of rows deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_by_ID($id, $allow_blocking = true)
+	{
+		return $this->delete(
+			[
+				[$this->get_primary_key_field()->get_name() => $id],
+				'limit' => 1,
+			],
+			$allow_blocking
+		);
+	}
+
+
+	/**
+	 * Identical to delete_permanently, but does a "soft" delete if possible,
+	 * meaning if the model has a field that indicates its been "trashed" or
+	 * "soft deleted", we will just set that instead of actually deleting the rows.
+	 *
+	 * @param array   $query_params
+	 * @param boolean $allow_blocking
+	 * @return int how many rows got deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see EEM_Base::delete_permanently
+	 */
+	public function delete($query_params, $allow_blocking = true)
+	{
+		return $this->delete_permanently($query_params, $allow_blocking);
+	}
+
+
+	/**
+	 * Deletes the model objects that meet the query params. Note: this method is overridden
+	 * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
+	 * as archived, not actually deleted
+	 *
+	 * @param array   $query_params
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
+	 *                                that blocks it (ie, there' sno other data that depends on this data); if false,
+	 *                                deletes regardless of other objects which may depend on it. Its generally
+	 *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
+	 *                                DB
+	 * @return int how many rows got deleted
+	 * @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 delete_permanently($query_params, $allow_blocking = true)
+	{
+		/**
+		 * Action called just before performing a real deletion query. You can use the
+		 * model and its $query_params to find exactly which items will be deleted
+		 *
+		 * @param EEM_Base $model
+		 * @param array    $query_params
+		 * @param boolean  $allow_blocking whether or not to allow related model objects
+		 *                                 to block (prevent) this deletion
+		 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+		 */
+		do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
+		// some MySQL databases may be running safe mode, which may restrict
+		// deletion if there is no KEY column used in the WHERE statement of a deletion.
+		// to get around this, we first do a SELECT, get all the IDs, and then run another query
+		// to delete them
+		$items_for_deletion           = $this->_get_all_wpdb_results($query_params);
+		$columns_and_ids_for_deleting = $this->_get_ids_for_delete($items_for_deletion, $allow_blocking);
+		$deletion_where_query_part    = $this->_build_query_part_for_deleting_from_columns_and_values(
+			$columns_and_ids_for_deleting
+		);
+		/**
+		 * Allows client code to act on the items being deleted before the query is actually executed.
+		 *
+		 * @param EEM_Base $this                            The model instance being acted on.
+		 * @param array    $query_params                    The incoming array of query parameters influencing what gets deleted.
+		 * @param bool     $allow_blocking                  @see param description in method phpdoc block.
+		 * @param array    $columns_and_ids_for_deleting    An array indicating what entities will get removed as
+		 *                                                  derived from the incoming query parameters.
+		 * @see details on the structure of this array in the phpdocs
+		 *                                                  for the `_get_ids_for_delete_method`
+		 *
+		 */
+		do_action(
+			'AHEE__EEM_Base__delete__before_query',
+			$this,
+			$query_params,
+			$allow_blocking,
+			$columns_and_ids_for_deleting
+		);
+		if ($deletion_where_query_part) {
+			$model_query_info = $this->_create_model_query_info_carrier($query_params);
+			$table_aliases    = implode(', ', array_keys($this->_tables));
+			$SQL              = "DELETE " . $table_aliases
+								. " FROM " . $model_query_info->get_full_join_sql()
+								. " WHERE " . $deletion_where_query_part;
+			$rows_deleted     = $this->_do_wpdb_query('query', [$SQL]);
+		} else {
+			$rows_deleted = 0;
+		}
+
+		// Next, make sure those items are removed from the entity map; if they could be put into it at all; and if
+		// there was no error with the delete query.
+		if (
+			$this->has_primary_key_field()
+			&& $rows_deleted !== false
+			&& isset($columns_and_ids_for_deleting[ $this->get_primary_key_field()->get_qualified_column() ])
+		) {
+			$ids_for_removal = $columns_and_ids_for_deleting[ $this->get_primary_key_field()->get_qualified_column() ];
+			foreach ($ids_for_removal as $id) {
+				if (isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])) {
+					unset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]);
+				}
+			}
+
+			// delete any extra meta attached to the deleted entities but ONLY if this model is not an instance of
+			// `EEM_Extra_Meta`.  In other words we want to prevent recursion on EEM_Extra_Meta::delete_permanently calls
+			// unnecessarily.  It's very unlikely that users will have assigned Extra Meta to Extra Meta
+			// (although it is possible).
+			// Note this can be skipped by using the provided filter and returning false.
+			if (
+			apply_filters(
+				'FHEE__EEM_Base__delete_permanently__dont_delete_extra_meta_for_extra_meta',
+				! $this instanceof EEM_Extra_Meta,
+				$this
+			)
+			) {
+				EEM_Extra_Meta::instance()->delete_permanently(
+					[
+						0 => [
+							'EXM_type' => $this->get_this_model_name(),
+							'OBJ_ID'   => [
+								'IN',
+								$ids_for_removal,
+							],
+						],
+					]
+				);
+			}
+		}
+
+		/**
+		 * Action called just after performing a real deletion query. Although at this point the
+		 * items should have been deleted
+		 *
+		 * @param EEM_Base $model
+		 * @param array    $query_params
+		 * @param int      $rows_deleted
+		 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+		 */
+		do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
+		return $rows_deleted;// how many supposedly got deleted
+	}
+
+
+	/**
+	 * Checks all the relations that throw error messages when there are blocking related objects
+	 * for related model objects. If there are any related model objects on those relations,
+	 * adds an EE_Error, and return true
+	 *
+	 * @param EE_Base_Class|int $this_model_obj_or_id
+	 * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
+	 *                                                 should be ignored when determining whether there are related
+	 *                                                 model objects which block this model object's deletion. Useful
+	 *                                                 if you know A is related to B and are considering deleting A,
+	 *                                                 but want to see if A has any other objects blocking its deletion
+	 *                                                 before removing the relation between A and B
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
+	{
+		// first, if $ignore_this_model_obj was supplied, get its model
+		if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
+			$ignored_model = $ignore_this_model_obj->get_model();
+		} else {
+			$ignored_model = null;
+		}
+		// now check all the relations of $this_model_obj_or_id and see if there
+		// are any related model objects blocking it?
+		$is_blocked = false;
+		foreach ($this->_model_relations as $relation_name => $relation_obj) {
+			if ($relation_obj->block_delete_if_related_models_exist()) {
+				// if $ignore_this_model_obj was supplied, then for the query
+				// on that model needs to be told to ignore $ignore_this_model_obj
+				if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
+					$related_model_objects = $relation_obj->get_all_related(
+						$this_model_obj_or_id,
+						[
+							[
+								$ignored_model->get_primary_key_field()->get_name() => [
+									'!=',
+									$ignore_this_model_obj->ID(),
+								],
+							],
+						]
+					);
+				} else {
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
+				}
+				if ($related_model_objects) {
+					EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
+					$is_blocked = true;
+				}
+			}
+		}
+		return $is_blocked;
+	}
+
+
+	/**
+	 * Builds the columns and values for items to delete from the incoming $row_results_for_deleting array.
+	 *
+	 * @param array $row_results_for_deleting
+	 * @param bool  $allow_blocking
+	 * @return array   The shape of this array depends on whether the model `has_primary_key_field` or not.  If the
+	 *                              model DOES have a primary_key_field, then the array will be a simple single
+	 *                              dimension array where the key is the fully qualified primary key column and the
+	 *                              value is an array of ids that will be deleted. Example: array('Event.EVT_ID' =>
+	 *                              array( 1,2,3)) If the model DOES NOT have a primary_key_field, then the array will
+	 *                              be a two dimensional array where each element is a group of columns and values that
+	 *                              get deleted. Example: array(
+	 *                              0 => array(
+	 *                              'Term_Relationship.object_id' => 1
+	 *                              'Term_Relationship.term_taxonomy_id' => 5
+	 *                              ),
+	 *                              1 => array(
+	 *                              'Term_Relationship.object_id' => 1
+	 *                              'Term_Relationship.term_taxonomy_id' => 6
+	 *                              )
+	 *                              )
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_ids_for_delete(array $row_results_for_deleting, $allow_blocking = true)
+	{
+		$ids_to_delete_indexed_by_column = [];
+		if ($this->has_primary_key_field()) {
+			$primary_table                   = $this->_get_main_table();
+			$ids_to_delete_indexed_by_column = [];
+			foreach ($row_results_for_deleting as $item_to_delete) {
+				// before we mark this item for deletion,
+				// make sure there's no related entities blocking its deletion (if we're checking)
+				if (
+					$allow_blocking
+					&& $this->delete_is_blocked_by_related_models(
+						$item_to_delete[ $primary_table->get_fully_qualified_pk_column() ]
+					)
+				) {
+					continue;
+				}
+				// primary table deletes
+				if (isset($item_to_delete[ $primary_table->get_fully_qualified_pk_column() ])) {
+					$ids_to_delete_indexed_by_column[ $primary_table->get_fully_qualified_pk_column() ][] =
+						$item_to_delete[ $primary_table->get_fully_qualified_pk_column() ];
+				}
+			}
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
+			$fields = $this->get_combined_primary_key_fields();
+			foreach ($row_results_for_deleting as $item_to_delete) {
+				$ids_to_delete_indexed_by_column_for_row = [];
+				foreach ($fields as $cpk_field) {
+					if ($cpk_field instanceof EE_Model_Field_Base) {
+						$ids_to_delete_indexed_by_column_for_row[ $cpk_field->get_qualified_column() ] =
+							$item_to_delete[ $cpk_field->get_qualified_column() ];
+					}
+				}
+				$ids_to_delete_indexed_by_column[] = $ids_to_delete_indexed_by_column_for_row;
+			}
+		} else {
+			// so there's no primary key and no combined key...
+			// sorry, can't help you
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Cannot delete objects of type %s because there is no primary key NOR combined key",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $ids_to_delete_indexed_by_column;
+	}
+
+
+	/**
+	 * This receives an array of columns and values set to be deleted (as prepared by _get_ids_for_delete) and prepares
+	 * the corresponding query_part for the query performing the delete.
+	 *
+	 * @param array $ids_to_delete_indexed_by_column @see _get_ids_for_delete for how this array might be shaped.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _build_query_part_for_deleting_from_columns_and_values(array $ids_to_delete_indexed_by_column)
+	{
+		$query_part = '';
+		if (empty($ids_to_delete_indexed_by_column)) {
+			return $query_part;
+		} elseif ($this->has_primary_key_field()) {
+			$query = [];
+			foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
+				// make sure we have unique $ids
+				$ids     = array_unique($ids);
+				$query[] = $column . ' IN(' . implode(',', $ids) . ')';
+			}
+			$query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
+			$ways_to_identify_a_row = [];
+			foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
+				$values_for_each_combined_primary_key_for_a_row = [];
+				foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
+					$values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
+				}
+				$value_and_value_and_value = implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
+				$ways_to_identify_a_row[]  = "({$value_and_value_and_value})";
+			}
+			$query_part = implode(' OR ', $ways_to_identify_a_row);
+		}
+		return $query_part;
+	}
+
+
+	/**
+	 * Gets the model field by the fully qualified name
+	 *
+	 * @param string $qualified_column_name eg 'Event_CPT.post_name' or $field_obj->get_qualified_column()
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 */
+	public function get_field_by_column($qualified_column_name)
+	{
+		foreach ($this->field_settings(true) as $field_obj) {
+			if ($field_obj->get_qualified_column() === $qualified_column_name) {
+				return $field_obj;
+			}
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__('Could not find a field on the model "%1$s" for qualified column "%2$s"', 'event_espresso'),
+				$this->get_this_model_name(),
+				$qualified_column_name
+			)
+		);
+	}
+
+
+	/**
+	 * Count all the rows that match criteria the model query params.
+	 * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
+	 * column
+	 *
+	 * @param array  $query_params
+	 * @param string $field_to_count field on model to count by (not column name)
+	 * @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 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($query_params = [], $field_to_count = null, $distinct = false)
+	{
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
+		if ($field_to_count) {
+			$field_obj       = $this->field_settings_for($field_to_count);
+			$column_to_count = $field_obj->get_qualified_column();
+		} elseif ($this->has_primary_key_field()) {
+			$pk_field_obj    = $this->get_primary_key_field();
+			$column_to_count = $pk_field_obj->get_qualified_column();
+		} else {
+			// there's no primary key
+			// if we're counting distinct items, and there's no primary key,
+			// we need to list out the columns for distinction;
+			// otherwise we can just use star
+			if ($distinct) {
+				$columns_to_use = [];
+				foreach ($this->get_combined_primary_key_fields() as $field_obj) {
+					$columns_to_use[] = $field_obj->get_qualified_column();
+				}
+				$column_to_count = implode(',', $columns_to_use);
+			} else {
+				$column_to_count = '*';
+			}
+		}
+		$column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
+		$SQL             =
+			"SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
+		return (int)$this->_do_wpdb_query('get_var', [$SQL]);
+	}
+
+
+	/**
+	 * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
+	 *
+	 * @param array  $query_params
+	 * @param string $field_to_sum name of field (array key in $_fields array)
+	 * @return float
+	 * @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 sum($query_params, $field_to_sum = null)
+	{
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
+		if ($field_to_sum) {
+			$field_obj = $this->field_settings_for($field_to_sum);
+		} else {
+			$field_obj = $this->get_primary_key_field();
+		}
+		$column_to_count = $field_obj->get_qualified_column();
+		$SQL             = "SELECT SUM(" . $column_to_count . ")"
+						   . $this->_construct_2nd_half_of_select_query($model_query_info);
+		$return_value    = $this->_do_wpdb_query('get_var', [$SQL]);
+		// $data_type       = $field_obj->get_wpdb_data_type();
+		// if ($data_type === '%d' || $data_type === '%s') {
+		//     return (float)$return_value;
+		// }
+		// must be %f
+		return (float)$return_value;
+	}
+
+
+	/**
+	 * Just calls the specified method on $wpdb with the given arguments
+	 * Consolidates a little extra error handling code
+	 *
+	 * @param string $wpdb_method
+	 * @param array  $arguments_to_provide
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @global wpdb  $wpdb
+	 */
+	protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
+	{
+		// if we're in maintenance mode level 2, DON'T run any queries
+		// because level 2 indicates the database needs updating and
+		// is probably out of sync with the code
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+			throw new EE_Error(
+				esc_html__(
+					'Event Espresso Level 2 Maintenance mode is active. That means EE can not run ANY database queries until the necessary migration scripts have run which will take EE out of maintenance mode level 2. Please inform support of this error.',
+					'event_espresso'
+				)
+			);
+		}
+		global $wpdb;
+		if (! method_exists($wpdb, $wpdb_method)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'There is no method named "%s" on Wordpress\' $wpdb object',
+						'event_espresso'
+					),
+					$wpdb_method
+				)
+			);
+		}
+		$old_show_errors_value = $wpdb->show_errors;
+		if (WP_DEBUG) {
+			$wpdb->show_errors(false);
+		}
+		$result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
+		$this->show_db_query_if_previously_requested($wpdb->last_query);
+		if (WP_DEBUG) {
+			$wpdb->show_errors($old_show_errors_value);
+			if (! empty($wpdb->last_error)) {
+				throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
+			}
+			if ($result === false) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'WPDB Error occurred, but no error message was logged by wpdb! The wpdb method called was "%1$s" and the arguments were "%2$s"',
+							'event_espresso'
+						),
+						$wpdb_method,
+						var_export($arguments_to_provide, true)
+					)
+				);
+			}
+		} elseif ($result === false) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'A database error has occurred. Turn on WP_DEBUG for more information.||A database error occurred doing wpdb method "%1$s", with arguments "%2$s". The error was "%3$s"',
+						'event_espresso'
+					),
+					$wpdb_method,
+					var_export($arguments_to_provide, true),
+					$wpdb->last_error
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Attempts to run the indicated WPDB method with the provided arguments,
+	 * and if there's an error tries to verify the DB is correct. Uses
+	 * the static property EEM_Base::$_db_verification_level to determine whether
+	 * we should try to fix the EE core db, the addons, or just give up
+	 *
+	 * @param string $wpdb_method
+	 * @param array  $arguments_to_provide
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
+	{
+		global $wpdb;
+		$wpdb->last_error = null;
+		$result           = call_user_func_array([$wpdb, $wpdb_method], $arguments_to_provide);
+		// was there an error running the query? but we don't care on new activations
+		// (we're going to setup the DB anyway on new activations)
+		if (
+			($result === false || ! empty($wpdb->last_error))
+			&& EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
+		) {
+			switch (EEM_Base::$_db_verification_level) {
+				case EEM_Base::db_verified_none:
+					// let's double-check core's DB
+					$error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
+					break;
+				case EEM_Base::db_verified_core:
+					// STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
+					$error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
+					break;
+				case EEM_Base::db_verified_addons:
+					// ummmm... you in trouble
+					return $result;
+			}
+			if (! empty($error_message)) {
+				EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
+				trigger_error($error_message);
+			}
+			return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Verifies the EE core database is up-to-date and records that we've done it on
+	 * EEM_Base::$_db_verification_level
+	 *
+	 * @param string $wpdb_method
+	 * @param array  $arguments_to_provide
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _verify_core_db($wpdb_method, $arguments_to_provide)
+	{
+		global $wpdb;
+		// ok remember that we've already attempted fixing the core db, in case the problem persists
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
+		$error_message                    = sprintf(
+			esc_html__(
+				'WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
+				'event_espresso'
+			),
+			$wpdb->last_error,
+			$wpdb_method,
+			wp_json_encode($arguments_to_provide)
+		);
+		EE_System::instance()->initialize_db_if_no_migrations_required();
+		return $error_message;
+	}
+
+
+	/**
+	 * Verifies the EE addons' database is up-to-date and records that we've done it on
+	 * EEM_Base::$_db_verification_level
+	 *
+	 * @param $wpdb_method
+	 * @param $arguments_to_provide
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _verify_addons_db($wpdb_method, $arguments_to_provide)
+	{
+		global $wpdb;
+		// ok remember that we've already attempted fixing the addons dbs, in case the problem persists
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
+		$error_message                    = sprintf(
+			esc_html__(
+				'WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
+				'event_espresso'
+			),
+			$wpdb->last_error,
+			$wpdb_method,
+			wp_json_encode($arguments_to_provide)
+		);
+		EE_System::instance()->initialize_addons();
+		return $error_message;
+	}
+
+
+	/**
+	 * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
+	 * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
+	 * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
+	 * ..."
+	 *
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
+	 * @return string
+	 */
+	private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
+	{
+		return " FROM " . $model_query_info->get_full_join_sql() .
+			   $model_query_info->get_where_sql() .
+			   $model_query_info->get_group_by_sql() .
+			   $model_query_info->get_having_sql() .
+			   $model_query_info->get_order_by_sql() .
+			   $model_query_info->get_limit_sql();
+	}
+
+
+	/**
+	 * Set to easily debug the next X queries ran from this model.
+	 *
+	 * @param int $count
+	 */
+	public function show_next_x_db_queries($count = 1)
+	{
+		$this->_show_next_x_db_queries = $count;
+	}
+
+
+	/**
+	 * @param $sql_query
+	 */
+	public function show_db_query_if_previously_requested($sql_query)
+	{
+		if ($this->_show_next_x_db_queries > 0) {
+			echo $sql_query;
+			$this->_show_next_x_db_queries--;
+		}
+	}
+
+
+	/**
+	 * Adds a relationship of the correct type between $modelObject and $otherModelObject.
+	 * There are the 3 cases:
+	 * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
+	 * $otherModelObject has no ID, it is first saved.
+	 * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
+	 * has no ID, it is first saved.
+	 * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
+	 * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
+	 * join table
+	 *
+	 * @param EE_Base_Class                     /int $thisModelObject
+	 * @param EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
+	 * @param string $relationName                     , key in EEM_Base::_relations
+	 *                                                 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 This allows you to enter further query params for the relation
+	 *                                                 to for relation to methods that allow you to further specify
+	 *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
+	 *                                                 only acceptable query_params is strict "col" => "value" pairs
+	 *                                                 because these will be inserted in any new rows created as well.
+	 * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
+	 * @throws EE_Error
+	 */
+	public function add_relationship_to(
+		$id_or_obj,
+		$other_model_id_or_obj,
+		$relationName,
+		$extra_join_model_fields_n_values = []
+	) {
+		$relation_obj = $this->related_settings_for($relationName);
+		return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
+	}
+
+
+	/**
+	 * Removes a relationship of the correct type between $modelObject and $otherModelObject.
+	 * There are the 3 cases:
+	 * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
+	 * error
+	 * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
+	 * an error
+	 * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
+	 *
+	 * @param EE_Base_Class /int $id_or_obj
+	 * @param EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
+	 * @param string $relationName key in EEM_Base::_relations
+	 * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
+	 *                             methods that allow you to further specify extra columns to join by (such as HABTM).
+	 *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
+	 *                             because these will be inserted in any new rows created as well.
+	 * @return boolean of success
+	 * @throws EE_Error
+	 */
+	public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = [])
+	{
+		$relation_obj = $this->related_settings_for($relationName);
+		return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
+	}
+
+
+	/**
+	 * @param mixed  $id_or_obj
+	 * @param string $relationName
+	 * @param array  $where_query_params
+	 * @param EE_Base_Class[] objects to which relations were removed
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function remove_relations($id_or_obj, $relationName, $where_query_params = [])
+	{
+		$relation_obj = $this->related_settings_for($relationName);
+		return $relation_obj->remove_relations($id_or_obj, $where_query_params);
+	}
+
+
+	/**
+	 * Gets all the related items of the specified $model_name, using $query_params.
+	 * Note: by default, we remove the "default query params"
+	 * because we want to get even deleted items etc.
+	 *
+	 * @param mixed  $id_or_obj    EE_Base_Class child or its ID
+	 * @param string $model_name   like 'Event', 'Registration', etc. always singular
+	 * @param array  $query_params see github link below for more info
+	 * @return 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 get_all_related($id_or_obj, $model_name, $query_params = null)
+	{
+		$model_obj         = $this->ensure_is_obj($id_or_obj);
+		$relation_settings = $this->related_settings_for($model_name);
+		return $relation_settings->get_all_related($model_obj, $query_params);
+	}
+
+
+	/**
+	 * Deletes all the model objects across the relation indicated by $model_name
+	 * which are related to $id_or_obj which meet the criteria set in $query_params.
+	 * However, if the model objects can't be deleted because of blocking related model objects, then
+	 * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
+	 *
+	 * @param EE_Base_Class|int|string $id_or_obj
+	 * @param string                   $model_name
+	 * @param array                    $query_params
+	 * @return int how many deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_related($id_or_obj, $model_name, $query_params = [])
+	{
+		$model_obj         = $this->ensure_is_obj($id_or_obj);
+		$relation_settings = $this->related_settings_for($model_name);
+		return $relation_settings->delete_all_related($model_obj, $query_params);
+	}
+
+
+	/**
+	 * Hard deletes all the model objects across the relation indicated by $model_name
+	 * which are related to $id_or_obj which meet the criteria set in $query_params. If
+	 * the model objects can't be hard deleted because of blocking related model objects,
+	 * just does a soft-delete on them instead.
+	 *
+	 * @param EE_Base_Class|int|string $id_or_obj
+	 * @param string                   $model_name
+	 * @param array                    $query_params
+	 * @return int how many deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_related_permanently($id_or_obj, $model_name, $query_params = [])
+	{
+		$model_obj         = $this->ensure_is_obj($id_or_obj);
+		$relation_settings = $this->related_settings_for($model_name);
+		return $relation_settings->delete_related_permanently($model_obj, $query_params);
+	}
+
+
+	/**
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
+	 * unless otherwise specified in the $query_params
+	 *
+	 * @param int             /EE_Base_Class $id_or_obj
+	 * @param string $model_name     like 'Event', or 'Registration'
+	 * @param array  $query_params
+	 * @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 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_related(
+		$id_or_obj,
+		$model_name,
+		$query_params = [],
+		$field_to_count = null,
+		$distinct = false
+	) {
+		$related_model = $this->get_related_model_obj($model_name);
+		// we're just going to use the query params on the related model's normal get_all query,
+		// except add a condition to say to match the current mod
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
+		}
+		$this_model_name                                                 = $this->get_this_model_name();
+		$this_pk_field_name                                              = $this->get_primary_key_field()->get_name();
+		$query_params[0][ $this_model_name . "." . $this_pk_field_name ] = $id_or_obj;
+		return $related_model->count($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 int           /EE_Base_Class $id_or_obj
+	 * @param string $model_name   like 'Event', or 'Registration'
+	 * @param array  $query_params
+	 * @param string $field_to_sum name of field to count by. By default, uses primary key
+	 * @return float
+	 * @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 sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
+	{
+		$related_model = $this->get_related_model_obj($model_name);
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong(
+				'EEM_Base::sum_related',
+				sprintf(
+					esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = [];
+		}
+		// we're just going to use the query params on the related model's normal get_all query,
+		// except add a condition to say to match the current mod
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
+		}
+		$this_model_name                                                 = $this->get_this_model_name();
+		$this_pk_field_name                                              = $this->get_primary_key_field()->get_name();
+		$query_params[0][ $this_model_name . "." . $this_pk_field_name ] = $id_or_obj;
+		return $related_model->sum($query_params, $field_to_sum);
+	}
+
+
+	/**
+	 * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
+	 * $modelObject
+	 *
+	 * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
+	 * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
+	 * @param array               $query_params     see github link below for more info
+	 * @return 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 get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
+	{
+		$query_params['limit'] = 1;
+		$results               = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
+	 *
+	 * @return string
+	 */
+	public function get_this_model_name()
+	{
+		return str_replace("EEM_", "", get_class($this));
+	}
+
+
+	/**
+	 * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
+	 *
+	 * @return EE_Any_Foreign_Model_Name_Field
+	 * @throws EE_Error
+	 */
+	public function get_field_containing_related_model_name()
+	{
+		foreach ($this->field_settings(true) as $field) {
+			if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
+				$field_with_model_name = $field;
+			}
+		}
+		if (! isset($field_with_model_name) || ! $field_with_model_name) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
+					$this->get_this_model_name()
+				)
+			);
+		}
+		return $field_with_model_name;
+	}
+
+
+	/**
+	 * Inserts a new entry into the database, for each table.
+	 * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
+	 * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
+	 * we also know there is no model object with the newly inserted item's ID at the moment (because
+	 * if there were, then they would already be in the DB and this would fail); and in the future if someone
+	 * creates a model object with this ID (or grabs it from the DB) then it will be added to the
+	 * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
+	 *
+	 * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
+	 *                              $values_already_prepared_by_model_object is false, in the model object's domain if
+	 *                              $values_already_prepared_by_model_object is true. See comment about this at the top
+	 *                              of EEM_Base)
+	 * @return int|string new primary key on main table that got inserted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function insert($field_n_values)
+	{
+		/**
+		 * Filters the fields and their values before inserting an item using the models
+		 *
+		 * @param array    $fields_n_values keys are the fields and values are their new values
+		 * @param EEM_Base $model           the model used
+		 */
+		$field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
+		if ($this->_satisfies_unique_indexes($field_n_values)) {
+			$main_table = $this->_get_main_table();
+			$new_id     = $this->_insert_into_specific_table($main_table, $field_n_values, false);
+			if ($new_id !== false) {
+				foreach ($this->_get_other_tables() as $other_table) {
+					$this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
+				}
+			}
+			/**
+			 * Done just after attempting to insert a new model object
+			 *
+			 * @param EEM_Base $model           used
+			 * @param array    $fields_n_values fields and their values
+			 * @param int|string the              ID of the newly-inserted model object
+			 */
+			do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
+			return $new_id;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Checks that the result would satisfy the unique indexes on this model
+	 *
+	 * @param array  $field_n_values
+	 * @param string $action
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
+	{
+		foreach ($this->unique_indexes() as $index_name => $index) {
+			$uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
+			if ($this->exists([$uniqueness_where_params])) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							"Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
+							"event_espresso"
+						),
+						$action,
+						$this->_get_class_name(),
+						$index_name,
+						implode(",", $index->field_names()),
+						http_build_query($uniqueness_where_params)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * Checks the database for an item that conflicts (ie, if this item were
+	 * saved to the DB would break some uniqueness requirement, like a primary key
+	 * or an index primary key set) with the item specified. $id_obj_or_fields_array
+	 * can be either an EE_Base_Class or an array of fields n values
+	 *
+	 * @param EE_Base_Class|array $obj_or_fields_array
+	 * @param boolean             $include_primary_key whether to use the model object's primary key
+	 *                                                 when looking for conflicts
+	 *                                                 (ie, if false, we ignore the model object's primary key
+	 *                                                 when finding "conflicts". If true, it's also considered).
+	 *                                                 Only works for INT primary key,
+	 *                                                 STRING primary keys cannot be ignored
+	 * @return EE_Base_Class|array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
+	{
+		if ($obj_or_fields_array instanceof EE_Base_Class) {
+			$fields_n_values = $obj_or_fields_array->model_field_array();
+		} elseif (is_array($obj_or_fields_array)) {
+			$fields_n_values = $obj_or_fields_array;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
+						"event_espresso"
+					),
+					get_class($this),
+					$obj_or_fields_array
+				)
+			);
+		}
+		$query_params = [];
+		if (
+			$this->has_primary_key_field()
+			&& ($include_primary_key
+				|| $this->get_primary_key_field()
+				   instanceof
+				   EE_Primary_Key_String_Field)
+			&& isset($fields_n_values[ $this->primary_key_name() ])
+		) {
+			$query_params[0]['OR'][ $this->primary_key_name() ] = $fields_n_values[ $this->primary_key_name() ];
+		}
+		foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
+			$uniqueness_where_params                              =
+				array_intersect_key($fields_n_values, $unique_index->fields());
+			$query_params[0]['OR'][ 'AND*' . $unique_index_name ] = $uniqueness_where_params;
+		}
+		// if there is nothing to base this search on, then we shouldn't find anything
+		if (empty($query_params)) {
+			return [];
+		}
+		return $this->get_one($query_params);
+	}
+
+
+	/**
+	 * Like count, but is optimized and returns a boolean instead of an int
+	 *
+	 * @param array $query_params
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function exists($query_params)
+	{
+		$query_params['limit'] = 1;
+		return $this->count($query_params) > 0;
+	}
+
+
+	/**
+	 * Wrapper for exists, except ignores default query parameters so we're only considering ID
+	 *
+	 * @param int|string $id
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function exists_by_ID($id)
+	{
+		return $this->exists(
+			[
+				'default_where_conditions' => EEM_Base::default_where_conditions_none,
+				[
+					$this->primary_key_name() => $id,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Inserts a new row in $table, using the $cols_n_values which apply to that table.
+	 * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
+	 * we need to add a foreign key column to point to $new_id (which should be the primary key's value
+	 * on the main table)
+	 * This is protected rather than private because private is not accessible to any child methods and there MAY be
+	 * cases where we want to call it directly rather than via insert().
+	 *
+	 * @access   protected
+	 * @param EE_Table_Base $table
+	 * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
+	 *                                       float
+	 * @param int           $new_id          for now we assume only int keys
+	 * @return int ID of new row inserted, or FALSE on failure
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
+	 */
+	protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
+	{
+		global $wpdb;
+		$insertion_col_n_values = [];
+		$format_for_insertion   = [];
+		$fields_on_table        = $this->_get_fields_for_table($table->get_table_alias());
+		foreach ($fields_on_table as $field_obj) {
+			// check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
+			if ($field_obj->is_auto_increment()) {
+				continue;
+			}
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
+			// if the value we want to assign it to is NULL, just don't mention it for the insertion
+			if ($prepared_value !== null) {
+				$insertion_col_n_values[ $field_obj->get_table_column() ] = $prepared_value;
+				$format_for_insertion[]                                   = $field_obj->get_wpdb_data_type();
+			}
+		}
+		if ($table instanceof EE_Secondary_Table && $new_id) {
+			// its not the main table, so we should have already saved the main table's PK which we just inserted
+			// so add the fk to the main table as a column
+			$insertion_col_n_values[ $table->get_fk_on_table() ] = $new_id;
+			$format_for_insertion[]                              =
+				'%d';// yes right now we're only allowing these foreign keys to be INTs
+		}
+		// insert the new entry
+		$result = $this->_do_wpdb_query(
+			'insert',
+			[$table->get_table_name(), $insertion_col_n_values, $format_for_insertion]
+		);
+		if ($result === false) {
+			return false;
+		}
+		// ok, now what do we return for the ID of the newly-inserted thing?
+		if ($this->has_primary_key_field()) {
+			if ($this->get_primary_key_field()->is_auto_increment()) {
+				return $wpdb->insert_id;
+			}
+			// it's not an auto-increment primary key, so
+			// it must have been supplied
+			return $fields_n_values[ $this->get_primary_key_field()->get_name() ];
+		}
+		// we can't return a  primary key because there is none. instead return
+		// a unique string indicating this model
+		return $this->get_index_primary_key_string($fields_n_values);
+	}
+
+
+	/**
+	 * Prepare the $field_obj 's value in $fields_n_values for use in the database.
+	 * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
+	 * and there is no default, we pass it along. WPDB will take care of it)
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param array               $fields_n_values
+	 * @return mixed string|int|float depending on what the table column will be expecting
+	 * @throws EE_Error
+	 */
+	protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
+	{
+		// if this field doesn't allow nullable, don't allow it
+		if (
+			! $field_obj->is_nullable()
+			&& (
+				! isset($fields_n_values[ $field_obj->get_name() ])
+				|| $fields_n_values[ $field_obj->get_name() ] === null
+			)
+		) {
+			$fields_n_values[ $field_obj->get_name() ] = $field_obj->get_default_value();
+		}
+		$unprepared_value = isset($fields_n_values[ $field_obj->get_name() ])
+			? $fields_n_values[ $field_obj->get_name() ]
+			: null;
+		return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
+	}
+
+
+	/**
+	 * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
+	 * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
+	 * the field's prepare_for_set() method.
+	 *
+	 * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
+	 *                                   false, otherwise a value in the model object's domain (see lengthy comment at
+	 *                                   top of file)
+	 * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
+	 *                                   $value is a custom selection
+	 * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
+	 */
+	private function _prepare_value_for_use_in_db($value, $field)
+	{
+		if ($field && $field instanceof EE_Model_Field_Base) {
+			// phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
+			switch ($this->_values_already_prepared_by_model_object) {
+				/** @noinspection PhpMissingBreakStatementInspection */
+				case self::not_prepared_by_model_object:
+					$value = $field->prepare_for_set($value);
+				// purposefully left out "return"
+				case self::prepared_by_model_object:
+					/** @noinspection SuspiciousAssignmentsInspection */
+					$value = $field->prepare_for_use_in_db($value);
+				case self::prepared_for_use_in_db:
+					// leave the value alone
+			}
+			return $value;
+			// phpcs:enable
+		}
+		return $value;
+	}
+
+
+	/**
+	 * Returns the main table on this model
+	 *
+	 * @return EE_Primary_Table
+	 * @throws EE_Error
+	 */
+	protected function _get_main_table()
+	{
+		foreach ($this->_tables as $table) {
+			if ($table instanceof EE_Primary_Table) {
+				return $table;
+			}
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'There are no main tables on %s. They should be added to _tables array in the constructor',
+					'event_espresso'
+				),
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * table
+	 * returns EE_Primary_Table table name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function table()
+	{
+		return $this->_get_main_table()->get_table_name();
+	}
+
+
+	/**
+	 * table
+	 * returns first EE_Secondary_Table table name
+	 *
+	 * @return string
+	 */
+	public function second_table()
+	{
+		// grab second table from tables array
+		$second_table = end($this->_tables);
+		return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
+	}
+
+
+	/**
+	 * get_table_obj_by_alias
+	 * returns table name given it's alias
+	 *
+	 * @param string $table_alias
+	 * @return EE_Primary_Table | EE_Secondary_Table
+	 */
+	public function get_table_obj_by_alias($table_alias = '')
+	{
+		return isset($this->_tables[ $table_alias ]) ? $this->_tables[ $table_alias ] : null;
+	}
+
+
+	/**
+	 * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
+	 *
+	 * @return EE_Secondary_Table[]
+	 */
+	protected function _get_other_tables()
+	{
+		$other_tables = [];
+		foreach ($this->_tables as $table_alias => $table) {
+			if ($table instanceof EE_Secondary_Table) {
+				$other_tables[ $table_alias ] = $table;
+			}
+		}
+		return $other_tables;
+	}
+
+
+	/**
+	 * Finds all the fields that correspond to the given table
+	 *
+	 * @param string $table_alias , array key in EEM_Base::_tables
+	 * @return EE_Model_Field_Base[]
+	 */
+	public function _get_fields_for_table($table_alias)
+	{
+		return $this->_fields[ $table_alias ];
+	}
+
+
+	/**
+	 * Recurses through all the where parameters, and finds all the related models we'll need
+	 * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
+	 * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
+	 * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
+	 * related Registration, Transaction, and Payment models.
+	 *
+	 * @param array $query_params see github link below for more info
+	 * @return EE_Model_Query_Info_Carrier
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function _extract_related_models_from_query($query_params)
+	{
+		$query_info_carrier = new EE_Model_Query_Info_Carrier();
+		if (array_key_exists(0, $query_params)) {
+			$this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
+		}
+		if (array_key_exists('group_by', $query_params)) {
+			if (is_array($query_params['group_by'])) {
+				$this->_extract_related_models_from_sub_params_array_values(
+					$query_params['group_by'],
+					$query_info_carrier,
+					'group_by'
+				);
+			} elseif (! empty($query_params['group_by'])) {
+				$this->_extract_related_model_info_from_query_param(
+					$query_params['group_by'],
+					$query_info_carrier,
+					'group_by'
+				);
+			}
+		}
+		if (array_key_exists('having', $query_params)) {
+			$this->_extract_related_models_from_sub_params_array_keys(
+				$query_params[0],
+				$query_info_carrier,
+				'having'
+			);
+		}
+		if (array_key_exists('order_by', $query_params)) {
+			if (is_array($query_params['order_by'])) {
+				$this->_extract_related_models_from_sub_params_array_keys(
+					$query_params['order_by'],
+					$query_info_carrier,
+					'order_by'
+				);
+			} elseif (! empty($query_params['order_by'])) {
+				$this->_extract_related_model_info_from_query_param(
+					$query_params['order_by'],
+					$query_info_carrier,
+					'order_by'
+				);
+			}
+		}
+		if (array_key_exists('force_join', $query_params)) {
+			$this->_extract_related_models_from_sub_params_array_values(
+				$query_params['force_join'],
+				$query_info_carrier,
+				'force_join'
+			);
+		}
+		$this->extractRelatedModelsFromCustomSelects($query_info_carrier);
+		return $query_info_carrier;
+	}
+
+
+	/**
+	 * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
+	 *
+	 * @param array                       $sub_query_params
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#-0-where-conditions
+	 */
+	private function _extract_related_models_from_sub_params_array_keys(
+		$sub_query_params,
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
+		$query_param_type
+	) {
+		if (! empty($sub_query_params)) {
+			$sub_query_params = (array)$sub_query_params;
+			foreach ($sub_query_params as $param => $possibly_array_of_params) {
+				// $param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
+				$this->_extract_related_model_info_from_query_param(
+					$param,
+					$model_query_info_carrier,
+					$query_param_type
+				);
+				// if $possibly_array_of_params is an array, try recursing into it, searching for keys which
+				// indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
+				// extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
+				// of array('Registration.TXN_ID'=>23)
+				$query_param_sans_stars =
+					$this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
+				if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
+					if (! is_array($possibly_array_of_params)) {
+						throw new EE_Error(
+							sprintf(
+								esc_html__(
+									"You used a special where query param %s, but the value isn't an array of where query params, it's just %s'. It should be an array, eg array('EVT_ID'=>23,'OR'=>array('Venue.VNU_ID'=>32,'Venue.VNU_name'=>'monkey_land'))",
+									"event_espresso"
+								),
+								$param,
+								$possibly_array_of_params
+							)
+						);
+					}
+					$this->_extract_related_models_from_sub_params_array_keys(
+						$possibly_array_of_params,
+						$model_query_info_carrier,
+						$query_param_type
+					);
+				} elseif (
+					$query_param_type === 0 // ie WHERE
+					&& is_array($possibly_array_of_params)
+					&& isset($possibly_array_of_params[2])
+					&& $possibly_array_of_params[2] == true
+				) {
+					// then $possible_array_of_params looks something like array('<','DTT_sold',true)
+					// indicating that $possible_array_of_params[1] is actually a field name,
+					// from which we should extract query parameters!
+					if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
+						throw new EE_Error(
+							sprintf(
+								esc_html__(
+									"Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
+									"event_espresso"
+								),
+								$query_param_type,
+								implode(",", $possibly_array_of_params)
+							)
+						);
+					}
+					$this->_extract_related_model_info_from_query_param(
+						$possibly_array_of_params[1],
+						$model_query_info_carrier,
+						$query_param_type
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * For extracting related models from forced_joins, where the array values contain the info about what
+	 * models to join with. Eg an array like array('Attendee','Price.Price_Type');
+	 *
+	 * @param array                       $sub_query_params
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	private function _extract_related_models_from_sub_params_array_values(
+		$sub_query_params,
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
+		$query_param_type
+	) {
+		if (! empty($sub_query_params)) {
+			if (! is_array($sub_query_params)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
+						$sub_query_params
+					)
+				);
+			}
+			foreach ($sub_query_params as $param) {
+				// $param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
+				$this->_extract_related_model_info_from_query_param(
+					$param,
+					$model_query_info_carrier,
+					$query_param_type
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Extract all the query parts from  model query params
+	 * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
+	 * instead of directly constructing the SQL because often we need to extract info from the $query_params
+	 * but use them in a different order. Eg, we need to know what models we are querying
+	 * before we know what joins to perform. However, we need to know what data types correspond to which fields on
+	 * other models before we can finalize the where clause SQL.
+	 *
+	 * @param array $query_params see github link below for more info
+	 * @return EE_Model_Query_Info_Carrier
+	 * @throws EE_Error
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function _create_model_query_info_carrier($query_params)
+	{
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong(
+				'EEM_Base::_create_model_query_info_carrier',
+				sprintf(
+					esc_html__(
+						'$query_params should be an array, you passed a variable of type %s',
+						'event_espresso'
+					),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = [];
+		}
+		$query_params[0] = isset($query_params[0]) ? $query_params[0] : [];
+		// first check if we should alter the query to account for caps or not
+		// because the caps might require us to do extra joins
+		if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
+			$query_params[0] = array_replace_recursive(
+				$query_params[0],
+				$this->caps_where_conditions(
+					$query_params['caps']
+				)
+			);
+		}
+
+		// check if we should alter the query to remove data related to protected
+		// custom post types
+		if (isset($query_params['exclude_protected']) && $query_params['exclude_protected'] === true) {
+			$where_param_key_for_password = $this->modelChainAndPassword();
+			// only include if related to a cpt where no password has been set
+			$query_params[0]['OR*nopassword'] = [
+				$where_param_key_for_password       => '',
+				$where_param_key_for_password . '*' => ['IS_NULL'],
+			];
+		}
+		$query_object = $this->_extract_related_models_from_query($query_params);
+		// verify where_query_params has NO numeric indexes.... that's simply not how you use it!
+		foreach ($query_params[0] as $key => $value) {
+			if (is_int($key)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"WHERE query params must NOT be numerically-indexed. You provided the array key '%s' for value '%s' while querying model %s. All the query params provided were '%s' Please read documentation on EEM_Base::get_all.",
+							"event_espresso"
+						),
+						$key,
+						var_export($value, true),
+						var_export($query_params, true),
+						get_class($this)
+					)
+				);
+			}
+		}
+		if (
+			array_key_exists('default_where_conditions', $query_params)
+			&& ! empty($query_params['default_where_conditions'])
+		) {
+			$use_default_where_conditions = $query_params['default_where_conditions'];
+		} else {
+			$use_default_where_conditions = EEM_Base::default_where_conditions_all;
+		}
+		$query_params[0] = array_merge(
+			$this->_get_default_where_conditions_for_models_in_query(
+				$query_object,
+				$use_default_where_conditions,
+				$query_params[0]
+			),
+			$query_params[0]
+		);
+		$query_object->set_where_sql($this->_construct_where_clause($query_params[0]));
+		// if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
+		// So we need to setup a subquery and use that for the main join.
+		// Note for now this only works on the primary table for the model.
+		// So for instance, you could set the limit array like this:
+		// array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
+		if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
+			$query_object->set_main_model_join_sql(
+				$this->_construct_limit_join_select(
+					$query_params['on_join_limit'][0],
+					$query_params['on_join_limit'][1]
+				)
+			);
+		}
+		// set limit
+		if (array_key_exists('limit', $query_params)) {
+			if (is_array($query_params['limit'])) {
+				if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
+					$e = sprintf(
+						esc_html__(
+							"Invalid DB query. You passed '%s' for the LIMIT, but only the following are valid: an integer, string representing an integer, a string like 'int,int', or an array like array(int,int)",
+							"event_espresso"
+						),
+						http_build_query($query_params['limit'])
+					);
+					throw new EE_Error($e . "|" . $e);
+				}
+				// they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
+			} elseif (! empty($query_params['limit'])) {
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
+			}
+		}
+		// set order by
+		if (array_key_exists('order_by', $query_params)) {
+			if (is_array($query_params['order_by'])) {
+				// if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
+				// specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
+				// including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
+				if (array_key_exists('order', $query_params)) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								"In querying %s, we are using query parameter 'order_by' as an array (keys:%s,values:%s), and so we can't use query parameter 'order' (value %s). You should just use the 'order_by' parameter ",
+								"event_espresso"
+							),
+							get_class($this),
+							implode(", ", array_keys($query_params['order_by'])),
+							implode(", ", $query_params['order_by']),
+							$query_params['order']
+						)
+					);
+				}
+				$this->_extract_related_models_from_sub_params_array_keys(
+					$query_params['order_by'],
+					$query_object,
+					'order_by'
+				);
+				// assume it's an array of fields to order by
+				$order_array = [];
+				foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
+					$order         = $this->_extract_order($order);
+					$order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
+				}
+				$query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
+			} elseif (! empty($query_params['order_by'])) {
+				$this->_extract_related_model_info_from_query_param(
+					$query_params['order_by'],
+					$query_object,
+					'order',
+					$query_params['order_by']
+				);
+				$order = isset($query_params['order'])
+					? $this->_extract_order($query_params['order'])
+					: 'DESC';
+				$query_object->set_order_by_sql(
+					" ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
+				);
+			}
+		}
+		// if 'order_by' wasn't set, maybe they are just using 'order' on its own?
+		if (
+			! array_key_exists('order_by', $query_params)
+			&& array_key_exists('order', $query_params)
+			&& ! empty($query_params['order'])
+		) {
+			$pk_field = $this->get_primary_key_field();
+			$order    = $this->_extract_order($query_params['order']);
+			$query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
+		}
+		// set group by
+		if (array_key_exists('group_by', $query_params)) {
+			if (is_array($query_params['group_by'])) {
+				// it's an array, so assume we'll be grouping by a bunch of stuff
+				$group_by_array = [];
+				foreach ($query_params['group_by'] as $field_name_to_group_by) {
+					$group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
+				}
+				$query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
+			} elseif (! empty($query_params['group_by'])) {
+				$query_object->set_group_by_sql(
+					" GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
+				);
+			}
+		}
+		// set having
+		if (array_key_exists('having', $query_params) && $query_params['having']) {
+			$query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
+		}
+		// now, just verify they didn't pass anything wack
+		foreach ($query_params as $query_key => $query_value) {
+			if (! in_array($query_key, $this->_allowed_query_params, true)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
+							'event_espresso'
+						),
+						$query_key,
+						get_class($this),
+						//                      print_r( $this->_allowed_query_params, TRUE )
+						implode(',', $this->_allowed_query_params)
+					)
+				);
+			}
+		}
+		$main_model_join_sql = $query_object->get_main_model_join_sql();
+		if (empty($main_model_join_sql)) {
+			$query_object->set_main_model_join_sql($this->_construct_internal_join());
+		}
+		return $query_object;
+	}
+
+
+	/**
+	 * Gets the where conditions that should be imposed on the query based on the
+	 * context (eg reading frontend, backend, edit or delete).
+	 *
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
+	 * @return array
+	 * @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 caps_where_conditions($context = self::caps_read)
+	{
+		EEM_Base::verify_is_valid_cap_context($context);
+		$cap_where_conditions = [];
+		$cap_restrictions     = $this->caps_missing($context);
+		foreach ($cap_restrictions as $restriction_if_no_cap) {
+			$cap_where_conditions = array_replace_recursive(
+				$cap_where_conditions,
+				$restriction_if_no_cap->get_default_where_conditions()
+			);
+		}
+		return apply_filters(
+			'FHEE__EEM_Base__caps_where_conditions__return',
+			$cap_where_conditions,
+			$this,
+			$context,
+			$cap_restrictions
+		);
+	}
+
+
+	/**
+	 * Verifies that $should_be_order_string is in $this->_allowed_order_values,
+	 * otherwise throws an exception
+	 *
+	 * @param string $should_be_order_string
+	 * @return string either ASC, asc, DESC or desc
+	 * @throws EE_Error
+	 */
+	private function _extract_order($should_be_order_string)
+	{
+		if (in_array($should_be_order_string, $this->_allowed_order_values)) {
+			return $should_be_order_string;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"While performing a query on '%s', tried to use '%s' as an order parameter. ",
+					"event_espresso"
+				),
+				get_class($this),
+				$should_be_order_string
+			)
+		);
+	}
+
+
+	/**
+	 * Looks at all the models which are included in this query, and asks each
+	 * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
+	 * so they can be merged
+	 *
+	 * @param EE_Model_Query_Info_Carrier $query_info_carrier
+	 * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
+	 *                                                                  'none' means NO default where conditions will
+	 *                                                                  be used AT ALL during this query.
+	 *                                                                  'other_models_only' means default where
+	 *                                                                  conditions from other models will be used, but
+	 *                                                                  not for this primary model. 'all', the default,
+	 *                                                                  means default where conditions will apply as
+	 *                                                                  normal
+	 * @param array                       $where_query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	private function _get_default_where_conditions_for_models_in_query(
+		EE_Model_Query_Info_Carrier $query_info_carrier,
+		$use_default_where_conditions = EEM_Base::default_where_conditions_all,
+		$where_query_params = []
+	) {
+		$allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
+		if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
+						"event_espresso"
+					),
+					$use_default_where_conditions,
+					implode(", ", $allowed_used_default_where_conditions_values)
+				)
+			);
+		}
+		$universal_query_params = [];
+		if ($this->_should_use_default_where_conditions($use_default_where_conditions)) {
+			$universal_query_params = $this->_get_default_where_conditions();
+		} elseif ($this->_should_use_minimum_where_conditions($use_default_where_conditions)) {
+			$universal_query_params = $this->_get_minimum_where_conditions();
+		}
+		foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
+			$related_model = $this->get_related_model_obj($model_name);
+			if ($this->_should_use_default_where_conditions($use_default_where_conditions, false)) {
+				$related_model_universal_where_params =
+					$related_model->_get_default_where_conditions($model_relation_path);
+			} elseif ($this->_should_use_minimum_where_conditions($use_default_where_conditions, false)) {
+				$related_model_universal_where_params =
+					$related_model->_get_minimum_where_conditions($model_relation_path);
+			} else {
+				// we don't want to add full or even minimum default where conditions from this model, so just continue
+				continue;
+			}
+			$overrides              = $this->_override_defaults_or_make_null_friendly(
+				$related_model_universal_where_params,
+				$where_query_params,
+				$related_model,
+				$model_relation_path
+			);
+			$universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
+				$universal_query_params,
+				$overrides
+			);
+		}
+		return $universal_query_params;
+	}
+
+
+	/**
+	 * Determines whether or not we should use default where conditions for the model in question
+	 * (this model, or other related models).
+	 * Basically, we should use default where conditions on this model if they have requested to use them on all models,
+	 * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
+	 * We should use default where conditions on related models when they requested to use default where conditions
+	 * on all models, or specifically just on other related models
+	 *
+	 * @param      $default_where_conditions_value
+	 * @param bool $for_this_model false means this is for OTHER related models
+	 * @return bool
+	 */
+	private function _should_use_default_where_conditions($default_where_conditions_value, $for_this_model = true)
+	{
+		return (
+				   $for_this_model
+				   && in_array(
+					   $default_where_conditions_value,
+					   [
+						   EEM_Base::default_where_conditions_all,
+						   EEM_Base::default_where_conditions_this_only,
+						   EEM_Base::default_where_conditions_minimum_others,
+					   ],
+					   true
+				   )
+			   )
+			   || (
+				   ! $for_this_model
+				   && in_array(
+					   $default_where_conditions_value,
+					   [
+						   EEM_Base::default_where_conditions_all,
+						   EEM_Base::default_where_conditions_others_only,
+					   ],
+					   true
+				   )
+			   );
+	}
+
+
+	/**
+	 * Determines whether or not we should use default minimum conditions for the model in question
+	 * (this model, or other related models).
+	 * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
+	 * where conditions.
+	 * We should use minimum where conditions on related models if they requested to use minimum where conditions
+	 * on this model or others
+	 *
+	 * @param      $default_where_conditions_value
+	 * @param bool $for_this_model false means this is for OTHER related models
+	 * @return bool
+	 */
+	private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
+	{
+		return (
+				   $for_this_model
+				   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
+			   )
+			   || (
+				   ! $for_this_model
+				   && in_array(
+					   $default_where_conditions_value,
+					   [
+						   EEM_Base::default_where_conditions_minimum_others,
+						   EEM_Base::default_where_conditions_minimum_all,
+					   ],
+					   true
+				   )
+			   );
+	}
+
+
+	/**
+	 * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
+	 * then we also add a special where condition which allows for that model's primary key
+	 * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
+	 * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
+	 *
+	 * @param array    $default_where_conditions
+	 * @param array    $provided_where_conditions
+	 * @param EEM_Base $model
+	 * @param string   $model_relation_path like 'Transaction.Payment.'
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	private function _override_defaults_or_make_null_friendly(
+		$default_where_conditions,
+		$provided_where_conditions,
+		$model,
+		$model_relation_path
+	) {
+		$null_friendly_where_conditions = [];
+		$none_overridden                = true;
+		$or_condition_key_for_defaults  = 'OR*' . get_class($model);
+		foreach ($default_where_conditions as $key => $val) {
+			if (isset($provided_where_conditions[ $key ])) {
+				$none_overridden = false;
+			} else {
+				$null_friendly_where_conditions[ $or_condition_key_for_defaults ]['AND'][ $key ] = $val;
+			}
+		}
+		if ($none_overridden && $default_where_conditions) {
+			if ($model->has_primary_key_field()) {
+				$null_friendly_where_conditions[ $or_condition_key_for_defaults ][ $model_relation_path
+																				   . "."
+																				   . $model->primary_key_name() ] =
+					['IS NULL'];
+			}/*else{
                 //@todo NO PK, use other defaults
             }*/
-        }
-        return $null_friendly_where_conditions;
-    }
-
-
-    /**
-     * Uses the _default_where_conditions_strategy set during __construct() to get
-     * default where conditions on all get_all, update, and delete queries done by this model.
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
-     * NOT array('Event_CPT.post_type'=>'esp_event').
-     *
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    private function _get_default_where_conditions($model_relation_path = '')
-    {
-        if ($this->_ignore_where_strategy) {
-            return [];
-        }
-        return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
-    }
-
-
-    /**
-     * Uses the _minimum_where_conditions_strategy set during __construct() to get
-     * minimum where conditions on all get_all, update, and delete queries done by this model.
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
-     * NOT array('Event_CPT.post_type'=>'esp_event').
-     * Similar to _get_default_where_conditions
-     *
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    protected function _get_minimum_where_conditions($model_relation_path = '')
-    {
-        if ($this->_ignore_where_strategy) {
-            return [];
-        }
-        return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
-    }
-
-
-    /**
-     * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
-     * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
-     *
-     * @param EE_Model_Query_Info_Carrier $model_query_info
-     * @return string
-     * @throws EE_Error
-     */
-    private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
-    {
-        $selects = $this->_get_columns_to_select_for_this_model();
-        foreach (
-            $model_query_info->get_model_names_included() as $model_relation_chain => $name_of_other_model_included
-        ) {
-            $other_model_included = $this->get_related_model_obj($name_of_other_model_included);
-            $other_model_selects  = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
-            foreach ($other_model_selects as $value) {
-                $selects[] = $value;
-            }
-        }
-        return implode(", ", $selects);
-    }
-
-
-    /**
-     * Gets an array of columns to select for this model, which are necessary for it to create its objects.
-     * So that's going to be the columns for all the fields on the model
-     *
-     * @param string $model_relation_chain like 'Question.Question_Group.Event'
-     * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
-     */
-    public function _get_columns_to_select_for_this_model($model_relation_chain = '')
-    {
-        $fields                                       = $this->field_settings();
-        $selects                                      = [];
-        $table_alias_with_model_relation_chain_prefix =
-            EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_this_model_name()
-            );
-        foreach ($fields as $field_obj) {
-            $selects[] = $table_alias_with_model_relation_chain_prefix
-                         . $field_obj->get_table_alias()
-                         . "."
-                         . $field_obj->get_table_column()
-                         . " AS '"
-                         . $table_alias_with_model_relation_chain_prefix
-                         . $field_obj->get_table_alias()
-                         . "."
-                         . $field_obj->get_table_column()
-                         . "'";
-        }
-        // make sure we are also getting the PKs of each table
-        $tables = $this->get_tables();
-        if (count($tables) > 1) {
-            foreach ($tables as $table_obj) {
-                $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
-                                       . $table_obj->get_fully_qualified_pk_column();
-                if (! in_array($qualified_pk_column, $selects)) {
-                    $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
-                }
-            }
-        }
-        return $selects;
-    }
-
-
-    /**
-     * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
-     * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
-     * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
-     * SQL for joining, and the data types
-     *
-     * @param string                      $query_param          like Registration.Transaction.TXN_ID
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
-     * @param string                      $query_param_type     like Registration.Transaction.TXN_ID
-     *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
-     *                                                          column name. We only want model names, eg 'Event.Venue'
-     *                                                          or 'Registration's
-     * @param string|null                 $original_query_param what it originally was (eg
-     *                                                          Registration.Transaction.TXN_ID). If null, we assume it
-     *                                                          matches $query_param
-     * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
-     * @throws EE_Error
-     */
-    private function _extract_related_model_info_from_query_param(
-        $query_param,
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
-        $query_param_type,
-        $original_query_param = null
-    ) {
-        if ($original_query_param === null) {
-            $original_query_param = $query_param;
-        }
-        $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
-        // whether or not to allow logic_query_params like 'NOT','OR', or 'AND'
-        $allow_logic_query_params = in_array($query_param_type, ['where', 'having', 0, 'custom_selects'], true);
-        $allow_fields             = in_array(
-            $query_param_type,
-            ['where', 'having', 'order_by', 'group_by', 'order', 'custom_selects', 0],
-            true
-        );
-        // check to see if we have a field on this model
-        $this_model_fields = $this->field_settings(true);
-        if (array_key_exists($query_param, $this_model_fields)) {
-            if ($allow_fields) {
-                return;
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
-                        "event_espresso"
-                    ),
-                    $query_param,
-                    get_class($this),
-                    $query_param_type,
-                    $original_query_param
-                )
-            );
-        }
-        // check if this is a special logic query param
-        if (in_array($query_param, $this->_logic_query_param_keys, true)) {
-            if ($allow_logic_query_params) {
-                return;
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Logic query params ("%1$s") are being used incorrectly with the following query param ("%2$s") on model %3$s. %4$sAdditional Info:%4$s%5$s',
-                        'event_espresso'
-                    ),
-                    implode('", "', $this->_logic_query_param_keys),
-                    $query_param,
-                    get_class($this),
-                    '<br />',
-                    "\t"
-                    . ' $passed_in_query_info = <pre>'
-                    . print_r($passed_in_query_info, true)
-                    . '</pre>'
-                    . "\n\t"
-                    . ' $query_param_type = '
-                    . $query_param_type
-                    . "\n\t"
-                    . ' $original_query_param = '
-                    . $original_query_param
-                )
-            );
-        }
-        // check if it's a custom selection
-        if (
-            $this->_custom_selections instanceof CustomSelects
-            && in_array($query_param, $this->_custom_selections->columnAliases(), true)
-        ) {
-            return;
-        }
-        // check if has a model name at the beginning
-        // and
-        // check if it's a field on a related model
-        if (
-        $this->extractJoinModelFromQueryParams(
-            $passed_in_query_info,
-            $query_param,
-            $original_query_param,
-            $query_param_type
-        )
-        ) {
-            return;
-        }
-
-        // ok so $query_param didn't start with a model name
-        // and we previously confirmed it wasn't a logic query param or field on the current model
-        // it's wack, that's what it is
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "There is no model named '%s' related to %s. Query param type is %s and original query param is %s",
-                    "event_espresso"
-                ),
-                $query_param,
-                get_class($this),
-                $query_param_type,
-                $original_query_param
-            )
-        );
-    }
-
-
-    /**
-     * Extracts any possible join model information from the provided possible_join_string.
-     * This method will read the provided $possible_join_string value and determine if there are any possible model
-     * join
-     * parts that should be added to the query.
-     *
-     * @param EE_Model_Query_Info_Carrier $query_info_carrier
-     * @param string                      $possible_join_string  Such as Registration.REG_ID, or Registration
-     * @param null|string                 $original_query_param
-     * @param string                      $query_parameter_type  The type for the source of the $possible_join_string
-     *                                                           ('where', 'order_by', 'group_by', 'custom_selects'
-     *                                                           etc.)
-     * @return bool  returns true if a join was added and false if not.
-     * @throws EE_Error
-     */
-    private function extractJoinModelFromQueryParams(
-        EE_Model_Query_Info_Carrier $query_info_carrier,
-        $possible_join_string,
-        $original_query_param,
-        $query_parameter_type
-    ) {
-        foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
-            if (strpos($possible_join_string, $valid_related_model_name . ".") === 0) {
-                $this->_add_join_to_model($valid_related_model_name, $query_info_carrier, $original_query_param);
-                $possible_join_string = substr($possible_join_string, strlen($valid_related_model_name . "."));
-                if ($possible_join_string === '') {
-                    // nothing left to $query_param
-                    // we should actually end in a field name, not a model like this!
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                "Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
-                                "event_espresso"
-                            ),
-                            $possible_join_string,
-                            $query_parameter_type,
-                            get_class($this),
-                            $valid_related_model_name
-                        )
-                    );
-                }
-                $related_model_obj = $this->get_related_model_obj($valid_related_model_name);
-                $related_model_obj->_extract_related_model_info_from_query_param(
-                    $possible_join_string,
-                    $query_info_carrier,
-                    $query_parameter_type,
-                    $original_query_param
-                );
-                return true;
-            }
-            if ($possible_join_string === $valid_related_model_name) {
-                $this->_add_join_to_model(
-                    $valid_related_model_name,
-                    $query_info_carrier,
-                    $original_query_param
-                );
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Extracts related models from Custom Selects and sets up any joins for those related models.
-     *
-     * @param EE_Model_Query_Info_Carrier $query_info_carrier
-     * @throws EE_Error
-     */
-    private function extractRelatedModelsFromCustomSelects(EE_Model_Query_Info_Carrier $query_info_carrier)
-    {
-        if (
-            $this->_custom_selections instanceof CustomSelects
-            && ($this->_custom_selections->type() === CustomSelects::TYPE_STRUCTURED
-                || $this->_custom_selections->type() == CustomSelects::TYPE_COMPLEX
-            )
-        ) {
-            $original_selects = $this->_custom_selections->originalSelects();
-            foreach ($original_selects as $select_configuration) {
-                $this->extractJoinModelFromQueryParams(
-                    $query_info_carrier,
-                    $select_configuration[0],
-                    $select_configuration[0],
-                    'custom_selects'
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
-     * and store it on $passed_in_query_info
-     *
-     * @param string                      $model_name
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
-     * @param string                      $original_query_param used to extract the relation chain between the queried
-     *                                                          model and $model_name. Eg, if we are querying Event,
-     *                                                          and are adding a join to 'Payment' with the original
-     *                                                          query param key
-     *                                                          'Registration.Transaction.Payment.PAY_amount', we want
-     *                                                          to extract 'Registration.Transaction.Payment', in case
-     *                                                          Payment wants to add default query params so that it
-     *                                                          will know what models to prepend onto its default query
-     *                                                          params or in case it wants to rename tables (in case
-     *                                                          there are multiple joins to the same table)
-     * @return void
-     * @throws EE_Error
-     */
-    private function _add_join_to_model(
-        $model_name,
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
-        $original_query_param
-    ) {
-        $relation_obj         = $this->related_settings_for($model_name);
-        $model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
-        // check if the relation is HABTM, because then we're essentially doing two joins
-        // If so, join first to the JOIN table, and add its data types, and then continue as normal
-        if ($relation_obj instanceof EE_HABTM_Relation) {
-            $join_model_obj = $relation_obj->get_join_model();
-            // replace the model specified with the join model for this relation chain, whi
-            $relation_chain_to_join_model =
-                EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain(
-                    $model_name,
-                    $join_model_obj->get_this_model_name(),
-                    $model_relation_chain
-                );
-            $passed_in_query_info->merge(
-                new EE_Model_Query_Info_Carrier(
-                    [$relation_chain_to_join_model => $join_model_obj->get_this_model_name()],
-                    $relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model)
-                )
-            );
-        }
-        // now just join to the other table pointed to by the relation object, and add its data types
-        $passed_in_query_info->merge(
-            new EE_Model_Query_Info_Carrier(
-                [$model_relation_chain => $model_name],
-                $relation_obj->get_join_statement($model_relation_chain)
-            )
-        );
-    }
-
-
-    /**
-     * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
-     *
-     * @param array $where_params
-     * @return string of SQL
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    private function _construct_where_clause($where_params)
-    {
-        $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
-        if ($SQL) {
-            return " WHERE " . $SQL;
-        }
-        return '';
-    }
-
-
-    /**
-     * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
-     * and should be passed HAVING parameters, not WHERE parameters
-     *
-     * @param array $having_params
-     * @return string
-     * @throws EE_Error
-     */
-    private function _construct_having_clause($having_params)
-    {
-        $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
-        if ($SQL) {
-            return " HAVING " . $SQL;
-        }
-        return '';
-    }
-
-
-    /**
-     * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
-     * Event_Meta.meta_value = 'foo'))"
-     *
-     * @param array  $where_params
-     * @param string $glue joins each sub-clause together. Should really only be " AND " or " OR "...
-     * @return string of SQL
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
-    {
-        $where_clauses = [];
-        foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
-            $query_param =
-                $this->_remove_stars_and_anything_after_from_condition_query_param_key(
-                    $query_param
-                );// str_replace("*",'',$query_param);
-            if (in_array($query_param, $this->_logic_query_param_keys)) {
-                switch ($query_param) {
-                    case 'not':
-                    case 'NOT':
-                        $where_clauses[] = "! ("
-                                           . $this->_construct_condition_clause_recursive(
-                                $op_and_value_or_sub_condition,
-                                $glue
-                            )
-                                           . ")";
-                        break;
-                    case 'and':
-                    case 'AND':
-                        $where_clauses[] = " ("
-                                           . $this->_construct_condition_clause_recursive(
-                                $op_and_value_or_sub_condition,
-                                ' AND '
-                            )
-                                           . ")";
-                        break;
-                    case 'or':
-                    case 'OR':
-                        $where_clauses[] = " ("
-                                           . $this->_construct_condition_clause_recursive(
-                                $op_and_value_or_sub_condition,
-                                ' OR '
-                            )
-                                           . ")";
-                        break;
-                }
-            } else {
-                $field_obj = $this->_deduce_field_from_query_param($query_param);
-                // if it's not a normal field, maybe it's a custom selection?
-                if (! $field_obj) {
-                    if ($this->_custom_selections instanceof CustomSelects) {
-                        $field_obj = $this->_custom_selections->getDataTypeForAlias($query_param);
-                    } else {
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__(
-                                    "%s is neither a valid model field name, nor a custom selection",
-                                    "event_espresso"
-                                ),
-                                $query_param
-                            )
-                        );
-                    }
-                }
-                $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
-                $where_clauses[]  = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
-            }
-        }
-        return $where_clauses ? implode($glue, $where_clauses) : '';
-    }
-
-
-    /**
-     * Takes the input parameter and extract the table name (alias) and column name
-     *
-     * @param string $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
-     * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
-     * @throws EE_Error
-     */
-    private function _deduce_column_name_from_query_param($query_param)
-    {
-        $field = $this->_deduce_field_from_query_param($query_param);
-        if ($field) {
-            $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param(
-                $field->get_model_name(),
-                $query_param
-            );
-            return $table_alias_prefix . $field->get_qualified_column();
-        }
-        if (
-            $this->_custom_selections instanceof CustomSelects
-            && in_array($query_param, $this->_custom_selections->columnAliases(), true)
-        ) {
-            // maybe it's custom selection item?
-            // if so, just use it as the "column name"
-            return $query_param;
-        }
-        $custom_select_aliases = $this->_custom_selections instanceof CustomSelects
-            ? implode(',', $this->_custom_selections->columnAliases())
-            : '';
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "%s is not a valid field on this model, nor a custom selection (%s)",
-                    "event_espresso"
-                ),
-                $query_param,
-                $custom_select_aliases
-            )
-        );
-    }
-
-
-    /**
-     * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
-     * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
-     * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
-     * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
-     *
-     * @param string $condition_query_param_key
-     * @return string
-     */
-    private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
-    {
-        $pos_of_star = strpos($condition_query_param_key, '*');
-        if ($pos_of_star === false) {
-            return $condition_query_param_key;
-        }
-        return substr($condition_query_param_key, 0, $pos_of_star);
-    }
-
-
-    /**
-     * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
-     *
-     * @param mixed      array | string    $op_and_value
-     * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
-     * @return string
-     * @throws EE_Error
-     */
-    private function _construct_op_and_value($op_and_value, $field_obj)
-    {
-        if (is_array($op_and_value)) {
-            $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
-            if (! $operator) {
-                $php_array_like_string = [];
-                foreach ($op_and_value as $key => $value) {
-                    $php_array_like_string[] = "$key=>$value";
-                }
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "You setup a query parameter like you were going to specify an operator, but didn't. You provided '(%s)', but the operator should be at array key index 0 (eg array('>',32))",
-                            "event_espresso"
-                        ),
-                        implode(",", $php_array_like_string)
-                    )
-                );
-            }
-            $value = isset($op_and_value[1]) ? $op_and_value[1] : null;
-        } else {
-            $operator = '=';
-            $value    = $op_and_value;
-        }
-        // check to see if the value is actually another field
-        if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
-        }
-        if (in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
-            // in this case, the value should be an array, or at least a comma-separated list
-            // it will need to handle a little differently
-            $cleaned_value = $this->_construct_in_value($value, $field_obj);
-            // note: $cleaned_value has already been run through $wpdb->prepare()
-            return $operator . SP . $cleaned_value;
-        }
-        if (in_array($operator, $this->valid_between_style_operators()) && is_array($value)) {
-            // the value should be an array with count of two.
-            if (count($value) !== 2) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
-                            'event_espresso'
-                        ),
-                        "BETWEEN"
-                    )
-                );
-            }
-            $cleaned_value = $this->_construct_between_value($value, $field_obj);
-            return $operator . SP . $cleaned_value;
-        }
-        if (in_array($operator, $this->valid_null_style_operators())) {
-            if ($value !== null) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
-                            "event_espresso"
-                        ),
-                        $value,
-                        $operator
-                    )
-                );
-            }
-            return $operator;
-        }
-        if (in_array($operator, $this->valid_like_style_operators()) && ! is_array($value)) {
-            // if the operator is 'LIKE', we want to allow percent signs (%) and not
-            // remove other junk. So just treat it as a string.
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
-        }
-        if (! in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
-        }
-        if (in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
-                        'event_espresso'
-                    ),
-                    $operator,
-                    $operator
-                )
-            );
-        }
-        if (! in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
-                        'event_espresso'
-                    ),
-                    $operator,
-                    $operator
-                )
-            );
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
-                    "event_espresso"
-                ),
-                http_build_query($op_and_value)
-            )
-        );
-    }
-
-
-    /**
-     * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
-     *
-     * @param array                      $values
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
-     *                                              '%s'
-     * @return string
-     * @throws EE_Error
-     */
-    public function _construct_between_value($values, $field_obj)
-    {
-        $cleaned_values = [];
-        foreach ($values as $value) {
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
-        }
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
-    }
-
-
-    /**
-     * Takes an array or a comma-separated list of $values and cleans them
-     * according to $data_type using $wpdb->prepare, and then makes the list a
-     * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
-     * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
-     * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
-     *
-     * @param mixed                      $values    array or comma-separated string
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
-     * @return string of SQL to follow an 'IN' or 'NOT IN' operator
-     * @throws EE_Error
-     */
-    public function _construct_in_value($values, $field_obj)
-    {
-        // check if the value is a CSV list
-        if (is_string($values)) {
-            // in which case, turn it into an array
-            $values = explode(",", $values);
-        }
-        $cleaned_values = [];
-        foreach ($values as $value) {
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
-        }
-        // we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
-        // but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
-        // which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
-        if (empty($cleaned_values)) {
-            $all_fields       = $this->field_settings();
-            $a_field          = array_shift($all_fields);
-            $main_table       = $this->_get_main_table();
-            $cleaned_values[] = "SELECT "
-                                . $a_field->get_table_column()
-                                . " FROM "
-                                . $main_table->get_table_name()
-                                . " WHERE FALSE";
-        }
-        return "(" . implode(",", $cleaned_values) . ")";
-    }
-
-
-    /**
-     * @param mixed                      $value
-     * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
-     * @return string
-     * @throws EE_Error
-     */
-    private function _wpdb_prepare_using_field($value, $field_obj)
-    {
-        global $wpdb;
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            return $wpdb->prepare(
-                $field_obj->get_wpdb_data_type(),
-                $this->_prepare_value_for_use_in_db($value, $field_obj)
-            );
-        } //$field_obj should really just be a data type
-        if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
-                    $field_obj,
-                    implode(",", $this->_valid_wpdb_data_types)
-                )
-            );
-        }
-        return $wpdb->prepare($field_obj, $value);
-    }
-
-
-    /**
-     * Takes the input parameter and finds the model field that it indicates.
-     *
-     * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     */
-    protected function _deduce_field_from_query_param($query_param_name)
-    {
-        // ok, now proceed with deducing which part is the model's name, and which is the field's name
-        // which will help us find the database table and column
-        $query_param_parts = explode(".", $query_param_name);
-        if (empty($query_param_parts)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "_extract_column_name is empty when trying to extract column and table name from %s",
-                        'event_espresso'
-                    ),
-                    $query_param_name
-                )
-            );
-        }
-        $number_of_parts       = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
-        $field_name = $last_query_param_part;
-        $model_obj  = $number_of_parts === 1
-            ? $this
-            // $number_of_parts >= 2, the last part is the column name, and there are only 2parts. therefore...
-            : $this->get_related_model_obj($query_param_parts[ $number_of_parts - 2 ]);
-        try {
-            return $model_obj->field_settings_for($field_name);
-        } catch (EE_Error $e) {
-            return null;
-        }
-    }
-
-
-    /**
-     * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
-     * alias and column which corresponds to it
-     *
-     * @param string $field_name
-     * @return string
-     * @throws EE_Error
-     */
-    public function _get_qualified_column_for_field($field_name)
-    {
-        $all_fields = $this->field_settings();
-        $field      = isset($all_fields[ $field_name ]) ? $all_fields[ $field_name ] : false;
-        if ($field) {
-            return $field->get_qualified_column();
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "There is no field titled %s on model %s. Either the query trying to use it is bad, or you need to add it to the list of fields on the model.",
-                    'event_espresso'
-                ),
-                $field_name,
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
-     * Example usage:
-     * EEM_Ticket::instance()->get_all_wpdb_results(
-     *      array(),
-     *      ARRAY_A,
-     *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
-     *  );
-     * is equivalent to
-     *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
-     * and
-     *  EEM_Event::instance()->get_all_wpdb_results(
-     *      array(
-     *          array(
-     *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
-     *          ),
-     *          ARRAY_A,
-     *          implode(
-     *              ', ',
-     *              array_merge(
-     *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
-     *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
-     *              )
-     *          )
-     *      )
-     *  );
-     * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
-     *
-     * @param string $model_relation_chain        the chain of models used to join between the model you want to query
-     *                                            and the one whose fields you are selecting for example: when querying
-     *                                            tickets model and selecting fields from the tickets model you would
-     *                                            leave this parameter empty, because no models are needed to join
-     *                                            between the queried model and the selected one. Likewise when
-     *                                            querying the datetime model and selecting fields from the tickets
-     *                                            model, it would also be left empty, because there is a direct
-     *                                            relation from datetimes to tickets, so no model is needed to join
-     *                                            them together. However, when querying from the event model and
-     *                                            selecting fields from the ticket model, you should provide the string
-     *                                            'Datetime', indicating that the event model must first join to the
-     *                                            datetime model in order to find its relation to ticket model.
-     *                                            Also, when querying from the venue model and selecting fields from
-     *                                            the ticket model, you should provide the string 'Event.Datetime',
-     *                                            indicating you need to join the venue model to the event model,
-     *                                            to the datetime model, in order to find its relation to the ticket
-     *                                            model. This string is used to deduce the prefix that gets added onto
-     *                                            the models' tables qualified columns
-     * @param bool   $return_string               if true, will return a string with qualified column names separated
-     *                                            by ', ' if false, will simply return a numerically indexed array of
-     *                                            qualified column names
-     * @return array|string
-     */
-    public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
-    {
-        $table_prefix      = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
-        $qualified_columns = [];
-        foreach ($this->field_settings() as $field) {
-            $qualified_columns[] = $table_prefix . $field->get_qualified_column();
-        }
-        return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
-    }
-
-
-    /**
-     * constructs the select use on special limit joins
-     * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
-     * its setup so the select query will be setup on and just doing the special select join off of the primary table
-     * (as that is typically where the limits would be set).
-     *
-     * @param string       $table_alias The table the select is being built for
-     * @param mixed|string $limit       The limit for this select
-     * @return string                The final select join element for the query.
-     * @throws EE_Error
-     */
-    public function _construct_limit_join_select($table_alias, $limit)
-    {
-        $SQL = '';
-        foreach ($this->_tables as $table_obj) {
-            if ($table_obj instanceof EE_Primary_Table) {
-                $SQL .= $table_alias === $table_obj->get_table_alias()
-                    ? $table_obj->get_select_join_limit($limit)
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
-            } elseif ($table_obj instanceof EE_Secondary_Table) {
-                $SQL .= $table_alias === $table_obj->get_table_alias()
-                    ? $table_obj->get_select_join_limit_join($limit)
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
-            }
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * Constructs the internal join if there are multiple tables, or simply the table's name and alias
-     * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
-     *
-     * @return string SQL
-     * @throws EE_Error
-     */
-    public function _construct_internal_join()
-    {
-        $SQL = $this->_get_main_table()->get_table_sql();
-        $SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
-        return $SQL;
-    }
-
-
-    /**
-     * Constructs the SQL for joining all the tables on this model.
-     * Normally $alias should be the primary table's alias, but in cases where
-     * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
-     * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
-     * alias, this will construct SQL like:
-     * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
-     * With $alias being a secondary table's alias, this will construct SQL like:
-     * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
-     *
-     * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
-     * @return string
-     * @throws EE_Error
-     */
-    public function _construct_internal_join_to_table_with_alias($alias_prefixed)
-    {
-        $SQL               = '';
-        $alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
-        foreach ($this->_tables as $table_obj) {
-            if ($table_obj instanceof EE_Secondary_Table) {// table is secondary table
-                if ($alias_sans_prefix === $table_obj->get_table_alias()) {
-                    // so we're joining to this table, meaning the table is already in
-                    // the FROM statement, BUT the primary table isn't. So we want
-                    // to add the inverse join sql
-                    $SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
-                } else {
-                    // just add a regular JOIN to this table from the primary table
-                    $SQL .= $table_obj->get_join_sql($alias_prefixed);
-                }
-            }//if it's a primary table, dont add any SQL. it should already be in the FROM statement
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * Gets an array for storing all the data types on the next-to-be-executed-query.
-     * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
-     * their data type (eg, '%s', '%d', etc)
-     *
-     * @return array
-     */
-    public function _get_data_types()
-    {
-        $data_types = [];
-        foreach ($this->field_settings() as $field_obj) {
-            // $data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
-            /** @var $field_obj EE_Model_Field_Base */
-            $data_types[ $field_obj->get_qualified_column() ] = $field_obj->get_wpdb_data_type();
-        }
-        return $data_types;
-    }
-
-
-    /**
-     * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
-     *
-     * @param string $model_name
-     * @return EEM_Base
-     * @throws EE_Error
-     */
-    public function get_related_model_obj($model_name)
-    {
-        $model_classname = "EEM_" . $model_name;
-        if (! class_exists($model_classname)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "You specified a related model named %s in your query. No such model exists, if it did, it would have the classname %s",
-                        'event_espresso'
-                    ),
-                    $model_name,
-                    $model_classname
-                )
-            );
-        }
-        return call_user_func($model_classname . "::instance");
-    }
-
-
-    /**
-     * Returns the array of EE_ModelRelations for this model.
-     *
-     * @return EE_Model_Relation_Base[]
-     */
-    public function relation_settings()
-    {
-        return $this->_model_relations;
-    }
-
-
-    /**
-     * Gets all related models that this model BELONGS TO. Handy to know sometimes
-     * because without THOSE models, this model probably doesn't have much purpose.
-     * (Eg, without an event, datetimes have little purpose.)
-     *
-     * @return EE_Belongs_To_Relation[]
-     */
-    public function belongs_to_relations()
-    {
-        $belongs_to_relations = [];
-        foreach ($this->relation_settings() as $model_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $belongs_to_relations[ $model_name ] = $relation_obj;
-            }
-        }
-        return $belongs_to_relations;
-    }
-
-
-    /**
-     * Returns the specified EE_Model_Relation, or throws an exception
-     *
-     * @param string $relation_name name of relation, key in $this->_relatedModels
-     * @return EE_Model_Relation_Base
-     * @throws EE_Error
-     */
-    public function related_settings_for($relation_name)
-    {
-        $relatedModels = $this->relation_settings();
-        if (! array_key_exists($relation_name, $relatedModels)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
-                        'event_espresso'
-                    ),
-                    $relation_name,
-                    $this->_get_class_name(),
-                    implode(', ', array_keys($relatedModels))
-                )
-            );
-        }
-        return $relatedModels[ $relation_name ];
-    }
-
-
-    /**
-     * A convenience method for getting a specific field's settings, instead of getting all field settings for all
-     * fields
-     *
-     * @param string  $fieldName
-     * @param boolean $include_db_only_fields
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     */
-    public function field_settings_for($fieldName, $include_db_only_fields = true)
-    {
-        $fieldSettings = $this->field_settings($include_db_only_fields);
-        if (! array_key_exists($fieldName, $fieldSettings)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("There is no field/column '%s' on '%s'", 'event_espresso'),
-                    $fieldName,
-                    get_class($this)
-                )
-            );
-        }
-        return $fieldSettings[ $fieldName ];
-    }
-
-
-    /**
-     * Checks if this field exists on this model
-     *
-     * @param string $fieldName a key in the model's _field_settings array
-     * @return boolean
-     */
-    public function has_field($fieldName)
-    {
-        $fieldSettings = $this->field_settings(true);
-        if (isset($fieldSettings[ $fieldName ])) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns whether or not this model has a relation to the specified model
-     *
-     * @param string $relation_name possibly one of the keys in the relation_settings array
-     * @return boolean
-     */
-    public function has_relation($relation_name)
-    {
-        $relations = $this->relation_settings();
-        if (isset($relations[ $relation_name ])) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
-     * Eg, on EE_Answer that would be ANS_ID field object
-     *
-     * @param $field_obj
-     * @return boolean
-     */
-    public function is_primary_key_field($field_obj)
-    {
-        return $field_obj instanceof EE_Primary_Key_Field_Base;
-    }
-
-
-    /**
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
-     * Eg, on EE_Answer that would be ANS_ID field object
-     *
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     */
-    public function get_primary_key_field()
-    {
-        if ($this->_primary_key_field === null) {
-            foreach ($this->field_settings(true) as $field_obj) {
-                if ($this->is_primary_key_field($field_obj)) {
-                    $this->_primary_key_field = $field_obj;
-                    break;
-                }
-            }
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__("There is no Primary Key defined on model %s", 'event_espresso'),
-                        get_class($this)
-                    )
-                );
-            }
-        }
-        return $this->_primary_key_field;
-    }
-
-
-    /**
-     * Returns whether or not not there is a primary key on this model.
-     * Internally does some caching.
-     *
-     * @return boolean
-     */
-    public function has_primary_key_field()
-    {
-        if ($this->_has_primary_key_field === null) {
-            try {
-                $this->get_primary_key_field();
-                $this->_has_primary_key_field = true;
-            } catch (EE_Error $e) {
-                $this->_has_primary_key_field = false;
-            }
-        }
-        return $this->_has_primary_key_field;
-    }
-
-
-    /**
-     * Finds the first field of type $field_class_name.
-     *
-     * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
-     *                                 EE_Foreign_Key_Field, etc
-     * @return EE_Model_Field_Base or null if none is found
-     */
-    public function get_a_field_of_type($field_class_name)
-    {
-        foreach ($this->field_settings() as $field) {
-            if ($field instanceof $field_class_name) {
-                return $field;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets a foreign key field pointing to model.
-     *
-     * @param string $model_name eg Event, Registration, not EEM_Event
-     * @return EE_Foreign_Key_Field_Base
-     * @throws EE_Error
-     */
-    public function get_foreign_key_to($model_name)
-    {
-        if (! isset($this->_cache_foreign_key_to_fields[ $model_name ])) {
-            foreach ($this->field_settings() as $field) {
-                if (
-                    $field instanceof EE_Foreign_Key_Field_Base
-                    && in_array($model_name, $field->get_model_names_pointed_to())
-                ) {
-                    $this->_cache_foreign_key_to_fields[ $model_name ] = $field;
-                    break;
-                }
-            }
-            if (! isset($this->_cache_foreign_key_to_fields[ $model_name ])) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "There is no foreign key field pointing to model %s on model %s",
-                            'event_espresso'
-                        ),
-                        $model_name,
-                        get_class($this)
-                    )
-                );
-            }
-        }
-        return $this->_cache_foreign_key_to_fields[ $model_name ];
-    }
-
-
-    /**
-     * Gets the table name (including $wpdb->prefix) for the table alias
-     *
-     * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
-     *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
-     *                            Either one works
-     * @return string
-     */
-    public function get_table_for_alias($table_alias)
-    {
-        $table_alias_sans_model_relation_chain_prefix =
-            EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
-        return $this->_tables[ $table_alias_sans_model_relation_chain_prefix ]->get_table_name();
-    }
-
-
-    /**
-     * Returns a flat array of all field son this model, instead of organizing them
-     * by table_alias as they are in the constructor.
-     *
-     * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
-     * @return EE_Model_Field_Base[] where the keys are the field's name
-     */
-    public function field_settings($include_db_only_fields = false)
-    {
-        if ($include_db_only_fields) {
-            if ($this->_cached_fields === null) {
-                $this->_cached_fields = [];
-                foreach ($this->_fields as $fields_corresponding_to_table) {
-                    foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
-                        $this->_cached_fields[ $field_name ] = $field_obj;
-                    }
-                }
-            }
-            return $this->_cached_fields;
-        }
-        if ($this->_cached_fields_non_db_only === null) {
-            $this->_cached_fields_non_db_only = [];
-            foreach ($this->_fields as $fields_corresponding_to_table) {
-                foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
-                    /** @var $field_obj EE_Model_Field_Base */
-                    if (! $field_obj->is_db_only_field()) {
-                        $this->_cached_fields_non_db_only[ $field_name ] = $field_obj;
-                    }
-                }
-            }
-        }
-        return $this->_cached_fields_non_db_only;
-    }
-
-
-    /**
-     *        cycle though array of attendees and create objects out of each item
-     *
-     * @access        private
-     * @param array $rows        of results of $wpdb->get_results($query,ARRAY_A)
-     * @return EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
-     *                           numerically indexed)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _create_objects($rows = [])
-    {
-        $array_of_objects = [];
-        if (empty($rows)) {
-            return [];
-        }
-        $count_if_model_has_no_primary_key = 0;
-        $has_primary_key                   = $this->has_primary_key_field();
-        $primary_key_field                 = $has_primary_key ? $this->get_primary_key_field() : null;
-        foreach ((array)$rows as $row) {
-            if (empty($row)) {
-                // wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
-                return [];
-            }
-            // check if we've already set this object in the results array,
-            // in which case there's no need to process it further (again)
-            if ($has_primary_key) {
-                $table_pk_value = $this->_get_column_value_with_table_alias_or_not(
-                    $row,
-                    $primary_key_field->get_qualified_column(),
-                    $primary_key_field->get_table_column()
-                );
-                if ($table_pk_value && isset($array_of_objects[ $table_pk_value ])) {
-                    continue;
-                }
-            }
-            $classInstance = $this->instantiate_class_from_array_or_object($row);
-            if (! $classInstance) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__('Could not create instance of class %s from row %s', 'event_espresso'),
-                        $this->get_this_model_name(),
-                        http_build_query($row)
-                    )
-                );
-            }
-            // set the timezone on the instantiated objects
-            $classInstance->set_timezone($this->get_timezone(), true);
-            // make sure if there is any timezone setting present that we set the timezone for the object
-            $key                      = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
-            $array_of_objects[ $key ] = $classInstance;
-            // also, for all the relations of type BelongsTo, see if we can cache
-            // those related models
-            // (we could do this for other relations too, but if there are conditions
-            // that filtered out some fo the results, then we'd be caching an incomplete set
-            // so it requires a little more thought than just caching them immediately...)
-            foreach ($this->_model_relations as $modelName => $relation_obj) {
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                    // check if this model's INFO is present. If so, cache it on the model
-                    $other_model           = $relation_obj->get_other_model();
-                    $other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
-                    // if we managed to make a model object from the results, cache it on the main model object
-                    if ($other_model_obj_maybe) {
-                        // set timezone on these other model objects if they are present
-                        $other_model_obj_maybe->set_timezone($this->get_timezone(), true);
-                        $classInstance->cache($modelName, $other_model_obj_maybe);
-                    }
-                }
-            }
-            // also, if this was a custom select query, let's see if there are any results for the custom select fields
-            // and add them to the object as well.  We'll convert according to the set data_type if there's any set for
-            // the field in the CustomSelects object
-            if ($this->_custom_selections instanceof CustomSelects) {
-                $classInstance->setCustomSelectsValues(
-                    $this->getValuesForCustomSelectAliasesFromResults($row)
-                );
-            }
-        }
-        return $array_of_objects;
-    }
-
-
-    /**
-     * This will parse a given row of results from the db and see if any keys in the results match an alias within the
-     * current CustomSelects object. This will be used to build an array of values indexed by those keys.
-     *
-     * @param array $db_results_row
-     * @return array
-     */
-    protected function getValuesForCustomSelectAliasesFromResults(array $db_results_row)
-    {
-        $results = [];
-        if ($this->_custom_selections instanceof CustomSelects) {
-            foreach ($this->_custom_selections->columnAliases() as $alias) {
-                if (isset($db_results_row[ $alias ])) {
-                    $results[ $alias ] = $this->convertValueToDataType(
-                        $db_results_row[ $alias ],
-                        $this->_custom_selections->getDataTypeForAlias($alias)
-                    );
-                }
-            }
-        }
-        return $results;
-    }
-
-
-    /**
-     * This will set the value for the given alias
-     *
-     * @param string $value
-     * @param string $datatype (one of %d, %s, %f)
-     * @return int|string|float (int for %d, string for %s, float for %f)
-     */
-    protected function convertValueToDataType($value, $datatype)
-    {
-        switch ($datatype) {
-            case '%f':
-                return (float)$value;
-            case '%d':
-                return (int)$value;
-            default:
-                return (string)$value;
-        }
-    }
-
-
-    /**
-     * The purpose of this method is to allow us to create a model object that is not in the db that holds default
-     * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
-     * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
-     * object (as set in the model_field!).
-     *
-     * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create_default_object()
-    {
-        $this_model_fields_and_values = [];
-        // setup the row using default values;
-        foreach ($this->field_settings() as $field_name => $field_obj) {
-            $this_model_fields_and_values[ $field_name ] = $field_obj->get_default_value();
-        }
-        $className = $this->_get_class_name();
-        return EE_Registry::instance()->load_class(
-            $className,
-            [$this_model_fields_and_values],
-            false,
-            false
-        );
-    }
-
-
-    /**
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
-     *                             or an stdClass where each property is the name of a column,
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
-            $cols_n_values = get_object_vars($cols_n_values);
-        }
-        $primary_key = null;
-        // make sure the array only has keys that are fields/columns on this model
-        $this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
-        if ($this->has_primary_key_field() && isset($this_model_fields_n_values[ $this->primary_key_name() ])) {
-            $primary_key = $this_model_fields_n_values[ $this->primary_key_name() ];
-        }
-        $className = $this->_get_class_name();
-        // check we actually found results that we can use to build our model object
-        // if not, return null
-        if ($this->has_primary_key_field()) {
-            if (empty($this_model_fields_n_values[ $this->primary_key_name() ])) {
-                return null;
-            }
-        } elseif ($this->unique_indexes()) {
-            $first_column = reset($this_model_fields_n_values);
-            if (empty($first_column)) {
-                return null;
-            }
-        }
-        // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
-        if ($primary_key) {
-            $classInstance = $this->get_from_entity_map($primary_key);
-            if (! $classInstance) {
-                $classInstance = EE_Registry::instance()->load_class(
-                    $className,
-                    [$this_model_fields_n_values, $this->get_timezone()],
-                    true,
-                    false
-                );
-                // add this new object to the entity map
-                $classInstance = $this->add_to_entity_map($classInstance);
-            }
-        } else {
-            $classInstance = EE_Registry::instance()->load_class(
-                $className,
-                [$this_model_fields_n_values, $this->get_timezone()],
-                true,
-                false
-            );
-        }
-        return $classInstance;
-    }
-
-
-    /**
-     * Gets the model object from the  entity map if it exists
-     *
-     * @param int|string $id the ID of the model object
-     * @return EE_Base_Class
-     */
-    public function get_from_entity_map($id)
-    {
-        return isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])
-            ? $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]
-            : null;
-    }
-
-
-    /**
-     * add_to_entity_map
-     * Adds the object to the model's entity mappings
-     *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
-     *        and for the remainder of the request, it's even more up-to-date than what's in the database.
-     *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
-     *        If the database gets updated directly and you want the entity mapper to reflect that change,
-     *        then this method should be called immediately after the update query
-     * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
-     * so on multisite, the entity map is specific to the query being done for a specific site.
-     *
-     * @param EE_Base_Class $object
-     * @return EE_Base_Class
-     * @throws EE_Error
-     */
-    public function add_to_entity_map(EE_Base_Class $object)
-    {
-        $className = $this->_get_class_name();
-        if (! $object instanceof $className) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("You tried adding a %s to a mapping of %ss", "event_espresso"),
-                    is_object($object) ? get_class($object) : $object,
-                    $className
-                )
-            );
-        }
-        if (! $object->ID()) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        "You tried storing a model object with NO ID in the %s entity mapper.",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        // double check it's not already there
-        $classInstance = $this->get_from_entity_map($object->ID());
-        if ($classInstance) {
-            return $classInstance;
-        }
-        $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $object->ID() ] = $object;
-        return $object;
-    }
-
-
-    /**
-     * if a valid identifier is provided, then that entity is unset from the entity map,
-     * if no identifier is provided, then the entire entity map is emptied
-     *
-     * @param int|string $id the ID of the model object
-     * @return boolean
-     */
-    public function clear_entity_map($id = null)
-    {
-        if (empty($id)) {
-            $this->_entity_map[ EEM_Base::$_model_query_blog_id ] = [];
-            return true;
-        }
-        if (isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])) {
-            unset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
-     * Given an array where keys are column (or column alias) names and values,
-     * returns an array of their corresponding field names and database values
-     *
-     * @param array $cols_n_values
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
-    {
-        return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
-    }
-
-
-    /**
-     * _deduce_fields_n_values_from_cols_n_values
-     * Given an array where keys are column (or column alias) names and values,
-     * returns an array of their corresponding field names and database values
-     *
-     * @param array $cols_n_values
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
-    {
-        $this_model_fields_n_values = [];
-        foreach ($this->get_tables() as $table_alias => $table_obj) {
-            $table_pk_value = $this->_get_column_value_with_table_alias_or_not(
-                $cols_n_values,
-                $table_obj->get_fully_qualified_pk_column(),
-                $table_obj->get_pk_column()
-            );
-            // there is a primary key on this table and its not set. Use defaults for all its columns
-            if ($table_pk_value === null && $table_obj->get_pk_column()) {
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
-                    if (! $field_obj->is_db_only_field()) {
-                        // prepare field as if its coming from db
-                        $prepared_value                            =
-                            $field_obj->prepare_for_set($field_obj->get_default_value());
-                        $this_model_fields_n_values[ $field_name ] = $field_obj->prepare_for_use_in_db($prepared_value);
-                    }
-                }
-            } else {
-                // the table's rows existed. Use their values
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
-                    if (! $field_obj->is_db_only_field()) {
-                        $this_model_fields_n_values[ $field_name ] = $this->_get_column_value_with_table_alias_or_not(
-                            $cols_n_values,
-                            $field_obj->get_qualified_column(),
-                            $field_obj->get_table_column()
-                        );
-                    }
-                }
-            }
-        }
-        return $this_model_fields_n_values;
-    }
-
-
-    /**
-     * @param array  $cols_n_values
-     * @param string $qualified_column
-     * @param string $regular_column
-     * @return null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
-    {
-        $value = null;
-        // ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
-        // does the field on the model relate to this column retrieved from the db?
-        // or is it a db-only field? (not relating to the model)
-        if (isset($cols_n_values[ $qualified_column ])) {
-            $value = $cols_n_values[ $qualified_column ];
-        } elseif (isset($cols_n_values[ $regular_column ])) {
-            $value = $cols_n_values[ $regular_column ];
-        } elseif (! empty($this->foreign_key_aliases)) {
-            // no PK?  ok check if there is a foreign key alias set for this table
-            // then check if that alias exists in the incoming data
-            // AND that the actual PK the $FK_alias represents matches the $qualified_column (full PK)
-            foreach ($this->foreign_key_aliases as $FK_alias => $PK_column) {
-                if ($PK_column === $qualified_column && isset($cols_n_values[ $FK_alias ])) {
-                    $value = $cols_n_values[ $FK_alias ];
-                    [$pk_class] = explode('.', $PK_column);
-                    $pk_model_name = "EEM_{$pk_class}";
-                    /** @var EEM_Base $pk_model */
-                    $pk_model = EE_Registry::instance()->load_model($pk_model_name);
-                    if ($pk_model instanceof EEM_Base) {
-                        // make sure object is pulled from db and added to entity map
-                        $pk_model->get_one_by_ID($value);
-                    }
-                    break;
-                }
-            }
-        }
-        return $value;
-    }
-
-
-    /**
-     * refresh_entity_map_from_db
-     * Makes sure the model object in the entity map at $id assumes the values
-     * of the database (opposite of EE_base_Class::save())
-     *
-     * @param int|string $id
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function refresh_entity_map_from_db($id)
-    {
-        $obj_in_map = $this->get_from_entity_map($id);
-        if ($obj_in_map) {
-            $wpdb_results = $this->_get_all_wpdb_results(
-                [[$this->get_primary_key_field()->get_name() => $id], 'limit' => 1]
-            );
-            if ($wpdb_results && is_array($wpdb_results)) {
-                $one_row = reset($wpdb_results);
-                foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
-                    $obj_in_map->set_from_db($field_name, $db_value);
-                }
-                // clear the cache of related model objects
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
-                    $obj_in_map->clear_cache($relation_name, null, true);
-                }
-            }
-            $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ] = $obj_in_map;
-            return $obj_in_map;
-        }
-        return $this->get_one_by_ID($id);
-    }
-
-
-    /**
-     * refresh_entity_map_with
-     * Leaves the entry in the entity map alone, but updates it to match the provided
-     * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
-     * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
-     * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
-     *
-     * @param int|string    $id
-     * @param EE_Base_Class $replacing_model_obj
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function refresh_entity_map_with($id, $replacing_model_obj)
-    {
-        $obj_in_map = $this->get_from_entity_map($id);
-        if ($obj_in_map) {
-            if ($replacing_model_obj instanceof EE_Base_Class) {
-                foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
-                    $obj_in_map->set($field_name, $value);
-                }
-                // make the model object in the entity map's cache match the $replacing_model_obj
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
-                    $obj_in_map->clear_cache($relation_name, null, true);
-                    foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
-                        $obj_in_map->cache($relation_name, $cached_obj, $cache_id);
-                    }
-                }
-            }
-            return $obj_in_map;
-        }
-        $this->add_to_entity_map($replacing_model_obj);
-        return $replacing_model_obj;
-    }
-
-
-    /**
-     * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
-     * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
-     * require_once($this->_getClassName().".class.php");
-     *
-     * @return string
-     */
-    private function _get_class_name()
-    {
-        return "EE_" . $this->get_this_model_name();
-    }
-
-
-    /**
-     * Get the name of the items this model represents, for the quantity specified. Eg,
-     * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
-     * it would be 'Events'.
-     *
-     * @param int $quantity
-     * @return string
-     */
-    public function item_name($quantity = 1)
-    {
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
-    }
-
-
-    /**
-     * Very handy general function to allow for plugins to extend any child of EE_TempBase.
-     * If a method is called on a child of EE_TempBase 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_TempBase (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_TempBase $object,$argsArray){
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
-     *        return $previousReturnValue.$returnString;
-     * }
-     * require('EEM_Answer.model.php');
-     * $answer=EEM_Answer::instance();
-     * echo $answer->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_TempBase, 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 %1$s on model %2$s does not exist! You can create one with the following code in functions.php or in a plugin: %4$s function my_callback(%4$s \$previousReturnValue, EEM_Base \$object\ $argsArray=NULL ){%4$s     /*function body*/%4$s      return \$whatever;%4$s }%4$s add_filter( \'%3$s\', \'my_callback\', 10, 3 );',
-                        'event_espresso'
-                    ),
-                    $methodName,
-                    $className,
-                    $tagName,
-                    '<br />'
-                )
-            );
-        }
-        return apply_filters($tagName, null, $this, $args);
-    }
-
-
-    /**
-     * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
-     * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
-     *
-     * @param EE_Base_Class|string|int $base_class_obj_or_id either:
-     *                                                       the EE_Base_Class object that corresponds to this Model,
-     *                                                       the object's class name
-     *                                                       or object's ID
-     * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
-     *                                                       exists in the database. If it does not, we add it
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
-    {
-        $className = $this->_get_class_name();
-        if ($base_class_obj_or_id instanceof $className) {
-            $model_object = $base_class_obj_or_id;
-        } else {
-            $primary_key_field = $this->get_primary_key_field();
-            if (
-                $primary_key_field instanceof EE_Primary_Key_Int_Field
-                && (
-                    is_int($base_class_obj_or_id)
-                    || is_string($base_class_obj_or_id)
-                )
-            ) {
-                // assume it's an ID.
-                // either a proper integer or a string representing an integer (eg "101" instead of 101)
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
-            } elseif (
-                $primary_key_field instanceof EE_Primary_Key_String_Field
-                && is_string($base_class_obj_or_id)
-            ) {
-                // assume its a string representation of the object
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
-                            'event_espresso'
-                        ),
-                        $base_class_obj_or_id,
-                        $this->_get_class_name(),
-                        print_r($base_class_obj_or_id, true)
-                    )
-                );
-            }
-        }
-        if ($ensure_is_in_db && $model_object->ID() !== null) {
-            $model_object->save();
-        }
-        return $model_object;
-    }
-
-
-    /**
-     * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
-     * is a value of the this model's primary key. If it's an EE_Base_Class child,
-     * returns it ID.
-     *
-     * @param EE_Base_Class|int|string $base_class_obj_or_id
-     * @return int|string depending on the type of this model object's ID
-     * @throws EE_Error
-     */
-    public function ensure_is_ID($base_class_obj_or_id)
-    {
-        $className = $this->_get_class_name();
-        if ($base_class_obj_or_id instanceof $className) {
-            $id = $base_class_obj_or_id->ID();
-        } elseif (is_int($base_class_obj_or_id)) {
-            // assume it's an ID
-            $id = $base_class_obj_or_id;
-        } elseif (is_string($base_class_obj_or_id)) {
-            // assume its a string representation of the object
-            $id = $base_class_obj_or_id;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
-                        'event_espresso'
-                    ),
-                    $base_class_obj_or_id,
-                    $this->_get_class_name(),
-                    print_r($base_class_obj_or_id, true)
-                )
-            );
-        }
-        return $id;
-    }
-
-
-    /**
-     * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
-     * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
-     * been sanitized and converted into the appropriate domain.
-     * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
-     * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
-     * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
-     * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
-     * $EVT = EEM_Event::instance(); $old_setting =
-     * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
-     * $EVT->assume_values_already_prepared_by_model_object(true);
-     * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
-     * $EVT->assume_values_already_prepared_by_model_object($old_setting);
-     *
-     * @param int $values_already_prepared like one of the constants on EEM_Base
-     * @return void
-     */
-    public function assume_values_already_prepared_by_model_object(
-        $values_already_prepared = self::not_prepared_by_model_object
-    ) {
-        $this->_values_already_prepared_by_model_object = $values_already_prepared;
-    }
-
-
-    /**
-     * Read comments for assume_values_already_prepared_by_model_object()
-     *
-     * @return int
-     */
-    public function get_assumption_concerning_values_already_prepared_by_model_object()
-    {
-        return $this->_values_already_prepared_by_model_object;
-    }
-
-
-    /**
-     * Gets all the indexes on this model
-     *
-     * @return EE_Index[]
-     */
-    public function indexes()
-    {
-        return $this->_indexes;
-    }
-
-
-    /**
-     * Gets all the Unique Indexes on this model
-     *
-     * @return EE_Unique_Index[]
-     */
-    public function unique_indexes()
-    {
-        $unique_indexes = [];
-        foreach ($this->_indexes as $name => $index) {
-            if ($index instanceof EE_Unique_Index) {
-                $unique_indexes [ $name ] = $index;
-            }
-        }
-        return $unique_indexes;
-    }
-
-
-    /**
-     * Gets all the fields which, when combined, make the primary key.
-     * This is usually just an array with 1 element (the primary key), but in cases
-     * where there is no primary key, it's a combination of fields as defined
-     * on a primary index
-     *
-     * @return EE_Model_Field_Base[] indexed by the field's name
-     * @throws EE_Error
-     */
-    public function get_combined_primary_key_fields()
-    {
-        foreach ($this->indexes() as $index) {
-            if ($index instanceof EE_Primary_Key_Index) {
-                return $index->fields();
-            }
-        }
-        return [$this->primary_key_name() => $this->get_primary_key_field()];
-    }
-
-
-    /**
-     * Used to build a primary key string (when the model has no primary key),
-     * which can be used a unique string to identify this model object.
-     *
-     * @param array $fields_n_values keys are field names, values are their values.
-     *                               Note: if you have results from `EEM_Base::get_all_wpdb_results()`, you need to
-     *                               run it through `EEM_Base::deduce_fields_n_values_from_cols_n_values()`
-     *                               before passing it to this function (that will convert it from columns-n-values
-     *                               to field-names-n-values).
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_index_primary_key_string($fields_n_values)
-    {
-        $cols_n_values_for_primary_key_index = array_intersect_key(
-            $fields_n_values,
-            $this->get_combined_primary_key_fields()
-        );
-        return http_build_query($cols_n_values_for_primary_key_index);
-    }
-
-
-    /**
-     * Gets the field values from the primary key string
-     *
-     * @param string $index_primary_key_string
-     * @return null|array
-     * @throws EE_Error
-     * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
-     */
-    public function parse_index_primary_key_string($index_primary_key_string)
-    {
-        $key_fields = $this->get_combined_primary_key_fields();
-        // check all of them are in the $id
-        $key_values_in_combined_pk = [];
-        parse_str($index_primary_key_string, $key_values_in_combined_pk);
-        foreach ($key_fields as $key_field_name => $field_obj) {
-            if (! isset($key_values_in_combined_pk[ $key_field_name ])) {
-                return null;
-            }
-        }
-        return $key_values_in_combined_pk;
-    }
-
-
-    /**
-     * verifies that an array of key-value pairs for model fields has a key
-     * for each field comprising the primary key index
-     *
-     * @param array $key_values
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function has_all_combined_primary_key_fields($key_values)
-    {
-        $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
-        foreach ($keys_it_should_have as $key) {
-            if (! isset($key_values[ $key ])) {
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
-     * We consider something to be a copy if all the attributes match (except the ID, of course).
-     *
-     * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
-     * @param array               $query_params                     see github link below for more info
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @return EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
-     *                                                              indexed)
-     */
-    public function get_all_copies($model_object_or_attributes_array, $query_params = [])
-    {
-        if ($model_object_or_attributes_array instanceof EE_Base_Class) {
-            $attributes_array = $model_object_or_attributes_array->model_field_array();
-        } elseif (is_array($model_object_or_attributes_array)) {
-            $attributes_array = $model_object_or_attributes_array;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "get_all_copies should be provided with either a model object or an array of field-value-pairs, but was given %s",
-                        "event_espresso"
-                    ),
-                    $model_object_or_attributes_array
-                )
-            );
-        }
-        // even copies obviously won't have the same ID, so remove the primary key
-        // from the WHERE conditions for finding copies (if there is a primary key, of course)
-        if ($this->has_primary_key_field() && isset($attributes_array[ $this->primary_key_name() ])) {
-            unset($attributes_array[ $this->primary_key_name() ]);
-        }
-        if (isset($query_params[0])) {
-            $query_params[0] = array_merge($attributes_array, $query_params);
-        } else {
-            $query_params[0] = $attributes_array;
-        }
-        return $this->get_all($query_params);
-    }
-
-
-    /**
-     * Gets the first copy we find. See get_all_copies for more details
-     *
-     * @param mixed EE_Base_Class | array        $model_object_or_attributes_array
-     * @param array $query_params
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one_copy($model_object_or_attributes_array, $query_params = [])
-    {
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong(
-                'EEM_Base::get_one_copy',
-                sprintf(
-                    esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = [];
-        }
-        $query_params['limit'] = 1;
-        $copies                = $this->get_all_copies($model_object_or_attributes_array, $query_params);
-        if (is_array($copies)) {
-            return array_shift($copies);
-        }
-        return null;
-    }
-
-
-    /**
-     * Updates the item with the specified id. Ignores default query parameters because
-     * we have specified the ID, and its assumed we KNOW what we're doing
-     *
-     * @param array      $fields_n_values keys are field names, values are their new values
-     * @param int|string $id              the value of the primary key to update
-     * @return int number of rows updated
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_by_ID($fields_n_values, $id)
-    {
-        $query_params = [
-            0                          => [$this->get_primary_key_field()->get_name() => $id],
-            'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
-        ];
-        return $this->update($fields_n_values, $query_params);
-    }
-
-
-    /**
-     * Changes an operator which was supplied to the models into one usable in SQL
-     *
-     * @param string $operator_supplied
-     * @return string an operator which can be used in SQL
-     * @throws EE_Error
-     */
-    private function _prepare_operator_for_sql($operator_supplied)
-    {
-        $sql_operator =
-            isset($this->_valid_operators[ $operator_supplied ]) ? $this->_valid_operators[ $operator_supplied ]
-                : null;
-        if ($sql_operator) {
-            return $sql_operator;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "The operator '%s' is not in the list of valid operators: %s",
-                    "event_espresso"
-                ),
-                $operator_supplied,
-                implode(",", array_keys($this->_valid_operators))
-            )
-        );
-    }
-
-
-    /**
-     * Gets the valid operators
-     *
-     * @return array keys are accepted strings, values are the SQL they are converted to
-     */
-    public function valid_operators()
-    {
-        return $this->_valid_operators;
-    }
-
-
-    /**
-     * Gets the between-style operators (take 2 arguments).
-     *
-     * @return array keys are accepted strings, values are the SQL they are converted to
-     */
-    public function valid_between_style_operators()
-    {
-        return array_intersect(
-            $this->valid_operators(),
-            $this->_between_style_operators
-        );
-    }
-
-
-    /**
-     * Gets the "like"-style operators (take a single argument, but it may contain wildcards)
-     *
-     * @return array keys are accepted strings, values are the SQL they are converted to
-     */
-    public function valid_like_style_operators()
-    {
-        return array_intersect(
-            $this->valid_operators(),
-            $this->_like_style_operators
-        );
-    }
-
-
-    /**
-     * Gets the "in"-style operators
-     *
-     * @return array keys are accepted strings, values are the SQL they are converted to
-     */
-    public function valid_in_style_operators()
-    {
-        return array_intersect(
-            $this->valid_operators(),
-            $this->_in_style_operators
-        );
-    }
-
-
-    /**
-     * Gets the "null"-style operators (accept no arguments)
-     *
-     * @return array keys are accepted strings, values are the SQL they are converted to
-     */
-    public function valid_null_style_operators()
-    {
-        return array_intersect(
-            $this->valid_operators(),
-            $this->_null_style_operators
-        );
-    }
-
-
-    /**
-     * Gets an array where keys are the primary keys and values are their 'names'
-     * (as determined by the model object's name() function, which is often overridden)
-     *
-     * @param array $query_params like get_all's
-     * @return string[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_names($query_params = [])
-    {
-        $objs  = $this->get_all($query_params);
-        $names = [];
-        foreach ($objs as $obj) {
-            $names[ $obj->ID() ] = $obj->name();
-        }
-        return $names;
-    }
-
-
-    /**
-     * Gets an array of primary keys from the model objects. If you acquired the model objects
-     * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
-     * this is duplicated effort and reduces efficiency) you would be better to use
-     * array_keys() on $model_objects.
-     *
-     * @param EE_Base_Class[] $model_objects
-     * @param boolean         $filter_out_empty_ids  if a model object has an ID of '' or 0, don't bother including it
-     *                                               in the returned array
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_IDs($model_objects, $filter_out_empty_ids = false)
-    {
-        if (! $this->has_primary_key_field()) {
-            if (WP_DEBUG) {
-                EE_Error::add_error(
-                    esc_html__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        $IDs = [];
-        foreach ($model_objects as $model_object) {
-            $id = $model_object->ID();
-            if (! $id) {
-                if ($filter_out_empty_ids) {
-                    continue;
-                }
-                if (WP_DEBUG) {
-                    EE_Error::add_error(
-                        esc_html__(
-                            'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-            $IDs[] = $id;
-        }
-        return $IDs;
-    }
-
-
-    /**
-     * Returns the string used in capabilities relating to this model. If there
-     * are no capabilities that relate to this model returns false
-     *
-     * @return string|false
-     */
-    public function cap_slug()
-    {
-        return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
-    }
-
-
-    /**
-     * Returns the capability-restrictions array (@param string $context
-     *
-     * @return EE_Default_Where_Conditions[] indexed by associated capability
-     * @throws EE_Error
-     * @see EEM_Base::_cap_restrictions).
-     *      If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
-     *      only returns the cap restrictions array in that context (ie, the array
-     *      at that key)
-     *
-     */
-    public function cap_restrictions($context = EEM_Base::caps_read)
-    {
-        EEM_Base::verify_is_valid_cap_context($context);
-        // check if we ought to run the restriction generator first
-        if (
-            isset($this->_cap_restriction_generators[ $context ])
-            && $this->_cap_restriction_generators[ $context ] instanceof EE_Restriction_Generator_Base
-            && ! $this->_cap_restriction_generators[ $context ]->has_generated_cap_restrictions()
-        ) {
-            $this->_cap_restrictions[ $context ] = array_merge(
-                $this->_cap_restrictions[ $context ],
-                $this->_cap_restriction_generators[ $context ]->generate_restrictions()
-            );
-        }
-        // and make sure we've finalized the construction of each restriction
-        foreach ($this->_cap_restrictions[ $context ] as $where_conditions_obj) {
-            if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
-                $where_conditions_obj->_finalize_construct($this);
-            }
-        }
-        return $this->_cap_restrictions[ $context ];
-    }
-
-
-    /**
-     * Indicating whether or not this model thinks its a wp core model
-     *
-     * @return boolean
-     */
-    public function is_wp_core_model()
-    {
-        return $this->_wp_core_model;
-    }
-
-
-    /**
-     * Gets all the caps that are missing which impose a restriction on
-     * queries made in this context
-     *
-     * @param string $context one of EEM_Base::caps_ constants
-     * @return EE_Default_Where_Conditions[] indexed by capability name
-     * @throws EE_Error
-     */
-    public function caps_missing($context = EEM_Base::caps_read)
-    {
-        $missing_caps     = [];
-        $cap_restrictions = $this->cap_restrictions($context);
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
-            if (
-            ! EE_Capabilities::instance()
-                             ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
-            ) {
-                $missing_caps[ $cap ] = $restriction_if_no_cap;
-            }
-        }
-        return $missing_caps;
-    }
-
-
-    /**
-     * Gets the mapping from capability contexts to action strings used in capability names
-     *
-     * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
-     * one of 'read', 'edit', or 'delete'
-     */
-    public function cap_contexts_to_cap_action_map()
-    {
-        return apply_filters(
-            'FHEE__EEM_Base__cap_contexts_to_cap_action_map',
-            $this->_cap_contexts_to_cap_action_map,
-            $this
-        );
-    }
-
-
-    /**
-     * Gets the action string for the specified capability context
-     *
-     * @param string $context
-     * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
-     * @throws EE_Error
-     */
-    public function cap_action_for_context($context)
-    {
-        $mapping = $this->cap_contexts_to_cap_action_map();
-        if (isset($mapping[ $context ])) {
-            return $mapping[ $context ];
-        }
-        if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
-            return $action;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
-                $context,
-                implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
-            )
-        );
-    }
-
-
-    /**
-     * Returns all the capability contexts which are valid when querying models
-     *
-     * @return array
-     */
-    public static function valid_cap_contexts()
-    {
-        return apply_filters(
-            'FHEE__EEM_Base__valid_cap_contexts',
-            [
-                self::caps_read,
-                self::caps_read_admin,
-                self::caps_edit,
-                self::caps_delete,
-            ]
-        );
-    }
-
-
-    /**
-     * Returns all valid options for 'default_where_conditions'
-     *
-     * @return array
-     */
-    public static function valid_default_where_conditions()
-    {
-        return [
-            EEM_Base::default_where_conditions_all,
-            EEM_Base::default_where_conditions_this_only,
-            EEM_Base::default_where_conditions_others_only,
-            EEM_Base::default_where_conditions_minimum_all,
-            EEM_Base::default_where_conditions_minimum_others,
-            EEM_Base::default_where_conditions_none,
-        ];
-    }
-
-    // public static function default_where_conditions_full
-
-
-    /**
-     * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
-     *
-     * @param string $context
-     * @return bool
-     * @throws EE_Error
-     */
-    public static function verify_is_valid_cap_context($context)
-    {
-        $valid_cap_contexts = EEM_Base::valid_cap_contexts();
-        if (in_array($context, $valid_cap_contexts)) {
-            return true;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
-                    'event_espresso'
-                ),
-                $context,
-                'EEM_Base',
-                implode(',', $valid_cap_contexts)
-            )
-        );
-    }
-
-
-    /**
-     * Clears all the models field caches. This is only useful when a sub-class
-     * might have added a field or something and these caches might be invalidated
-     */
-    protected function _invalidate_field_caches()
-    {
-        $this->_cache_foreign_key_to_fields = [];
-        $this->_cached_fields               = null;
-        $this->_cached_fields_non_db_only   = null;
-    }
-
-
-    /**
-     * Gets the list of all the where query param keys that relate to logic instead of field names
-     * (eg "and", "or", "not").
-     *
-     * @return array
-     */
-    public function logic_query_param_keys()
-    {
-        return $this->_logic_query_param_keys;
-    }
-
-
-    /**
-     * Determines whether or not the where query param array key is for a logic query param.
-     * Eg 'OR', 'not*', and 'and*because-i-say-so' should all return true, whereas
-     * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
-     *
-     * @param $query_param_key
-     * @return bool
-     */
-    public function is_logic_query_param_key($query_param_key)
-    {
-        foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
-            if (
-                $query_param_key === $logic_query_param_key
-                || strpos($query_param_key, $logic_query_param_key . '*') === 0
-            ) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns true if this model has a password field on it (regardless of whether that password field has any content)
-     *
-     * @return boolean
-     * @since 4.9.74.p
-     */
-    public function hasPassword()
-    {
-        // if we don't yet know if there's a password field, find out and remember it for next time.
-        if ($this->has_password_field === null) {
-            $password_field           = $this->getPasswordField();
-            $this->has_password_field = $password_field instanceof EE_Password_Field;
-        }
-        return $this->has_password_field;
-    }
-
-
-    /**
-     * Returns the password field on this model, if there is one
-     *
-     * @return EE_Password_Field|null
-     * @since 4.9.74.p
-     */
-    public function getPasswordField()
-    {
-        // if we definitely already know there is a password field or not (because has_password_field is true or false)
-        // there's no need to search for it. If we don't know yet, then find out
-        if ($this->has_password_field === null && $this->password_field === null) {
-            $this->password_field = $this->get_a_field_of_type('EE_Password_Field');
-        }
-        // don't bother setting has_password_field because that's hasPassword()'s job.
-        return $this->password_field;
-    }
-
-
-    /**
-     * Returns the list of field (as EE_Model_Field_Bases) that are protected by the password
-     *
-     * @return EE_Model_Field_Base[]
-     * @throws EE_Error
-     * @since 4.9.74.p
-     */
-    public function getPasswordProtectedFields()
-    {
-        $password_field = $this->getPasswordField();
-        $fields         = [];
-        if ($password_field instanceof EE_Password_Field) {
-            $field_names = $password_field->protectedFields();
-            foreach ($field_names as $field_name) {
-                $fields[ $field_name ] = $this->field_settings_for($field_name);
-            }
-        }
-        return $fields;
-    }
-
-
-    /**
-     * Checks if the current user can perform the requested action on this model
-     *
-     * @param string              $cap_to_check one of the array keys from _cap_contexts_to_cap_action_map
-     * @param EE_Base_Class|array $model_obj_or_fields_n_values
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     * @since 4.9.74.p
-     */
-    public function currentUserCan($cap_to_check, $model_obj_or_fields_n_values)
-    {
-        if ($model_obj_or_fields_n_values instanceof EE_Base_Class) {
-            $model_obj_or_fields_n_values = $model_obj_or_fields_n_values->model_field_array();
-        }
-        if (! is_array($model_obj_or_fields_n_values)) {
-            throw new UnexpectedEntityException(
-                $model_obj_or_fields_n_values,
-                'EE_Base_Class',
-                sprintf(
-                    esc_html__(
-                        '%1$s must be passed an `EE_Base_Class or an array of fields names with their values. You passed in something different.',
-                        'event_espresso'
-                    ),
-                    __FUNCTION__
-                )
-            );
-        }
-        return $this->exists(
-            $this->alter_query_params_to_restrict_by_ID(
-                $this->get_index_primary_key_string($model_obj_or_fields_n_values),
-                [
-                    'default_where_conditions' => 'none',
-                    'caps'                     => $cap_to_check,
-                ]
-            )
-        );
-    }
-
-
-    /**
-     * Returns the query param where conditions key to the password affecting this model.
-     * Eg on EEM_Event this would just be "password", on EEM_Datetime this would be "Event.password", etc.
-     *
-     * @return null|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @since 4.9.74.p
-     */
-    public function modelChainAndPassword()
-    {
-        if ($this->model_chain_to_password === null) {
-            throw new ModelConfigurationException(
-                $this,
-                esc_html_x(
-                // @codingStandardsIgnoreStart
-                    'Cannot exclude protected data because the model has not specified which model has the password.',
-                    // @codingStandardsIgnoreEnd
-                    '1: model name',
-                    'event_espresso'
-                )
-            );
-        }
-        if ($this->model_chain_to_password === '') {
-            $model_with_password = $this;
-        } else {
-            if ($pos_of_period = strrpos($this->model_chain_to_password, '.')) {
-                $last_model_in_chain = substr($this->model_chain_to_password, $pos_of_period + 1);
-            } else {
-                $last_model_in_chain = $this->model_chain_to_password;
-            }
-            $model_with_password = EE_Registry::instance()->load_model($last_model_in_chain);
-        }
-
-        $password_field = $model_with_password->getPasswordField();
-        if ($password_field instanceof EE_Password_Field) {
-            $password_field_name = $password_field->get_name();
-        } else {
-            throw new ModelConfigurationException(
-                $this,
-                sprintf(
-                    esc_html_x(
-                        'This model claims related model "%1$s" should have a password field on it, but none was found. The model relation chain is "%2$s"',
-                        '1: model name, 2: special string',
-                        'event_espresso'
-                    ),
-                    $model_with_password->get_this_model_name(),
-                    $this->model_chain_to_password
-                )
-            );
-        }
-        return ($this->model_chain_to_password ? $this->model_chain_to_password . '.' : '') . $password_field_name;
-    }
-
-
-    /**
-     * Returns true if there is a password on a related model which restricts access to some of this model's rows,
-     * or if this model itself has a password affecting access to some of its other fields.
-     *
-     * @return boolean
-     * @since 4.9.74.p
-     */
-    public function restrictedByRelatedModelPassword()
-    {
-        return $this->model_chain_to_password !== null;
-    }
+		}
+		return $null_friendly_where_conditions;
+	}
+
+
+	/**
+	 * Uses the _default_where_conditions_strategy set during __construct() to get
+	 * default where conditions on all get_all, update, and delete queries done by this model.
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
+	 *
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	private function _get_default_where_conditions($model_relation_path = '')
+	{
+		if ($this->_ignore_where_strategy) {
+			return [];
+		}
+		return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
+	}
+
+
+	/**
+	 * Uses the _minimum_where_conditions_strategy set during __construct() to get
+	 * minimum where conditions on all get_all, update, and delete queries done by this model.
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
+	 * Similar to _get_default_where_conditions
+	 *
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	protected function _get_minimum_where_conditions($model_relation_path = '')
+	{
+		if ($this->_ignore_where_strategy) {
+			return [];
+		}
+		return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
+	}
+
+
+	/**
+	 * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
+	 * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
+	 *
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
+	{
+		$selects = $this->_get_columns_to_select_for_this_model();
+		foreach (
+			$model_query_info->get_model_names_included() as $model_relation_chain => $name_of_other_model_included
+		) {
+			$other_model_included = $this->get_related_model_obj($name_of_other_model_included);
+			$other_model_selects  = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
+			foreach ($other_model_selects as $value) {
+				$selects[] = $value;
+			}
+		}
+		return implode(", ", $selects);
+	}
+
+
+	/**
+	 * Gets an array of columns to select for this model, which are necessary for it to create its objects.
+	 * So that's going to be the columns for all the fields on the model
+	 *
+	 * @param string $model_relation_chain like 'Question.Question_Group.Event'
+	 * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
+	 */
+	public function _get_columns_to_select_for_this_model($model_relation_chain = '')
+	{
+		$fields                                       = $this->field_settings();
+		$selects                                      = [];
+		$table_alias_with_model_relation_chain_prefix =
+			EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_this_model_name()
+			);
+		foreach ($fields as $field_obj) {
+			$selects[] = $table_alias_with_model_relation_chain_prefix
+						 . $field_obj->get_table_alias()
+						 . "."
+						 . $field_obj->get_table_column()
+						 . " AS '"
+						 . $table_alias_with_model_relation_chain_prefix
+						 . $field_obj->get_table_alias()
+						 . "."
+						 . $field_obj->get_table_column()
+						 . "'";
+		}
+		// make sure we are also getting the PKs of each table
+		$tables = $this->get_tables();
+		if (count($tables) > 1) {
+			foreach ($tables as $table_obj) {
+				$qualified_pk_column = $table_alias_with_model_relation_chain_prefix
+									   . $table_obj->get_fully_qualified_pk_column();
+				if (! in_array($qualified_pk_column, $selects)) {
+					$selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
+				}
+			}
+		}
+		return $selects;
+	}
+
+
+	/**
+	 * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
+	 * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
+	 * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
+	 * SQL for joining, and the data types
+	 *
+	 * @param string                      $query_param          like Registration.Transaction.TXN_ID
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
+	 * @param string                      $query_param_type     like Registration.Transaction.TXN_ID
+	 *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
+	 *                                                          column name. We only want model names, eg 'Event.Venue'
+	 *                                                          or 'Registration's
+	 * @param string|null                 $original_query_param what it originally was (eg
+	 *                                                          Registration.Transaction.TXN_ID). If null, we assume it
+	 *                                                          matches $query_param
+	 * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
+	 * @throws EE_Error
+	 */
+	private function _extract_related_model_info_from_query_param(
+		$query_param,
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
+		$query_param_type,
+		$original_query_param = null
+	) {
+		if ($original_query_param === null) {
+			$original_query_param = $query_param;
+		}
+		$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
+		// whether or not to allow logic_query_params like 'NOT','OR', or 'AND'
+		$allow_logic_query_params = in_array($query_param_type, ['where', 'having', 0, 'custom_selects'], true);
+		$allow_fields             = in_array(
+			$query_param_type,
+			['where', 'having', 'order_by', 'group_by', 'order', 'custom_selects', 0],
+			true
+		);
+		// check to see if we have a field on this model
+		$this_model_fields = $this->field_settings(true);
+		if (array_key_exists($query_param, $this_model_fields)) {
+			if ($allow_fields) {
+				return;
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
+						"event_espresso"
+					),
+					$query_param,
+					get_class($this),
+					$query_param_type,
+					$original_query_param
+				)
+			);
+		}
+		// check if this is a special logic query param
+		if (in_array($query_param, $this->_logic_query_param_keys, true)) {
+			if ($allow_logic_query_params) {
+				return;
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Logic query params ("%1$s") are being used incorrectly with the following query param ("%2$s") on model %3$s. %4$sAdditional Info:%4$s%5$s',
+						'event_espresso'
+					),
+					implode('", "', $this->_logic_query_param_keys),
+					$query_param,
+					get_class($this),
+					'<br />',
+					"\t"
+					. ' $passed_in_query_info = <pre>'
+					. print_r($passed_in_query_info, true)
+					. '</pre>'
+					. "\n\t"
+					. ' $query_param_type = '
+					. $query_param_type
+					. "\n\t"
+					. ' $original_query_param = '
+					. $original_query_param
+				)
+			);
+		}
+		// check if it's a custom selection
+		if (
+			$this->_custom_selections instanceof CustomSelects
+			&& in_array($query_param, $this->_custom_selections->columnAliases(), true)
+		) {
+			return;
+		}
+		// check if has a model name at the beginning
+		// and
+		// check if it's a field on a related model
+		if (
+		$this->extractJoinModelFromQueryParams(
+			$passed_in_query_info,
+			$query_param,
+			$original_query_param,
+			$query_param_type
+		)
+		) {
+			return;
+		}
+
+		// ok so $query_param didn't start with a model name
+		// and we previously confirmed it wasn't a logic query param or field on the current model
+		// it's wack, that's what it is
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"There is no model named '%s' related to %s. Query param type is %s and original query param is %s",
+					"event_espresso"
+				),
+				$query_param,
+				get_class($this),
+				$query_param_type,
+				$original_query_param
+			)
+		);
+	}
+
+
+	/**
+	 * Extracts any possible join model information from the provided possible_join_string.
+	 * This method will read the provided $possible_join_string value and determine if there are any possible model
+	 * join
+	 * parts that should be added to the query.
+	 *
+	 * @param EE_Model_Query_Info_Carrier $query_info_carrier
+	 * @param string                      $possible_join_string  Such as Registration.REG_ID, or Registration
+	 * @param null|string                 $original_query_param
+	 * @param string                      $query_parameter_type  The type for the source of the $possible_join_string
+	 *                                                           ('where', 'order_by', 'group_by', 'custom_selects'
+	 *                                                           etc.)
+	 * @return bool  returns true if a join was added and false if not.
+	 * @throws EE_Error
+	 */
+	private function extractJoinModelFromQueryParams(
+		EE_Model_Query_Info_Carrier $query_info_carrier,
+		$possible_join_string,
+		$original_query_param,
+		$query_parameter_type
+	) {
+		foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
+			if (strpos($possible_join_string, $valid_related_model_name . ".") === 0) {
+				$this->_add_join_to_model($valid_related_model_name, $query_info_carrier, $original_query_param);
+				$possible_join_string = substr($possible_join_string, strlen($valid_related_model_name . "."));
+				if ($possible_join_string === '') {
+					// nothing left to $query_param
+					// we should actually end in a field name, not a model like this!
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								"Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
+								"event_espresso"
+							),
+							$possible_join_string,
+							$query_parameter_type,
+							get_class($this),
+							$valid_related_model_name
+						)
+					);
+				}
+				$related_model_obj = $this->get_related_model_obj($valid_related_model_name);
+				$related_model_obj->_extract_related_model_info_from_query_param(
+					$possible_join_string,
+					$query_info_carrier,
+					$query_parameter_type,
+					$original_query_param
+				);
+				return true;
+			}
+			if ($possible_join_string === $valid_related_model_name) {
+				$this->_add_join_to_model(
+					$valid_related_model_name,
+					$query_info_carrier,
+					$original_query_param
+				);
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Extracts related models from Custom Selects and sets up any joins for those related models.
+	 *
+	 * @param EE_Model_Query_Info_Carrier $query_info_carrier
+	 * @throws EE_Error
+	 */
+	private function extractRelatedModelsFromCustomSelects(EE_Model_Query_Info_Carrier $query_info_carrier)
+	{
+		if (
+			$this->_custom_selections instanceof CustomSelects
+			&& ($this->_custom_selections->type() === CustomSelects::TYPE_STRUCTURED
+				|| $this->_custom_selections->type() == CustomSelects::TYPE_COMPLEX
+			)
+		) {
+			$original_selects = $this->_custom_selections->originalSelects();
+			foreach ($original_selects as $select_configuration) {
+				$this->extractJoinModelFromQueryParams(
+					$query_info_carrier,
+					$select_configuration[0],
+					$select_configuration[0],
+					'custom_selects'
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
+	 * and store it on $passed_in_query_info
+	 *
+	 * @param string                      $model_name
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
+	 * @param string                      $original_query_param used to extract the relation chain between the queried
+	 *                                                          model and $model_name. Eg, if we are querying Event,
+	 *                                                          and are adding a join to 'Payment' with the original
+	 *                                                          query param key
+	 *                                                          'Registration.Transaction.Payment.PAY_amount', we want
+	 *                                                          to extract 'Registration.Transaction.Payment', in case
+	 *                                                          Payment wants to add default query params so that it
+	 *                                                          will know what models to prepend onto its default query
+	 *                                                          params or in case it wants to rename tables (in case
+	 *                                                          there are multiple joins to the same table)
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _add_join_to_model(
+		$model_name,
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
+		$original_query_param
+	) {
+		$relation_obj         = $this->related_settings_for($model_name);
+		$model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
+		// check if the relation is HABTM, because then we're essentially doing two joins
+		// If so, join first to the JOIN table, and add its data types, and then continue as normal
+		if ($relation_obj instanceof EE_HABTM_Relation) {
+			$join_model_obj = $relation_obj->get_join_model();
+			// replace the model specified with the join model for this relation chain, whi
+			$relation_chain_to_join_model =
+				EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain(
+					$model_name,
+					$join_model_obj->get_this_model_name(),
+					$model_relation_chain
+				);
+			$passed_in_query_info->merge(
+				new EE_Model_Query_Info_Carrier(
+					[$relation_chain_to_join_model => $join_model_obj->get_this_model_name()],
+					$relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model)
+				)
+			);
+		}
+		// now just join to the other table pointed to by the relation object, and add its data types
+		$passed_in_query_info->merge(
+			new EE_Model_Query_Info_Carrier(
+				[$model_relation_chain => $model_name],
+				$relation_obj->get_join_statement($model_relation_chain)
+			)
+		);
+	}
+
+
+	/**
+	 * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
+	 *
+	 * @param array $where_params
+	 * @return string of SQL
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	private function _construct_where_clause($where_params)
+	{
+		$SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
+		if ($SQL) {
+			return " WHERE " . $SQL;
+		}
+		return '';
+	}
+
+
+	/**
+	 * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
+	 * and should be passed HAVING parameters, not WHERE parameters
+	 *
+	 * @param array $having_params
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _construct_having_clause($having_params)
+	{
+		$SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
+		if ($SQL) {
+			return " HAVING " . $SQL;
+		}
+		return '';
+	}
+
+
+	/**
+	 * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
+	 * Event_Meta.meta_value = 'foo'))"
+	 *
+	 * @param array  $where_params
+	 * @param string $glue joins each sub-clause together. Should really only be " AND " or " OR "...
+	 * @return string of SQL
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
+	{
+		$where_clauses = [];
+		foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
+			$query_param =
+				$this->_remove_stars_and_anything_after_from_condition_query_param_key(
+					$query_param
+				);// str_replace("*",'',$query_param);
+			if (in_array($query_param, $this->_logic_query_param_keys)) {
+				switch ($query_param) {
+					case 'not':
+					case 'NOT':
+						$where_clauses[] = "! ("
+										   . $this->_construct_condition_clause_recursive(
+								$op_and_value_or_sub_condition,
+								$glue
+							)
+										   . ")";
+						break;
+					case 'and':
+					case 'AND':
+						$where_clauses[] = " ("
+										   . $this->_construct_condition_clause_recursive(
+								$op_and_value_or_sub_condition,
+								' AND '
+							)
+										   . ")";
+						break;
+					case 'or':
+					case 'OR':
+						$where_clauses[] = " ("
+										   . $this->_construct_condition_clause_recursive(
+								$op_and_value_or_sub_condition,
+								' OR '
+							)
+										   . ")";
+						break;
+				}
+			} else {
+				$field_obj = $this->_deduce_field_from_query_param($query_param);
+				// if it's not a normal field, maybe it's a custom selection?
+				if (! $field_obj) {
+					if ($this->_custom_selections instanceof CustomSelects) {
+						$field_obj = $this->_custom_selections->getDataTypeForAlias($query_param);
+					} else {
+						throw new EE_Error(
+							sprintf(
+								esc_html__(
+									"%s is neither a valid model field name, nor a custom selection",
+									"event_espresso"
+								),
+								$query_param
+							)
+						);
+					}
+				}
+				$op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
+				$where_clauses[]  = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
+			}
+		}
+		return $where_clauses ? implode($glue, $where_clauses) : '';
+	}
+
+
+	/**
+	 * Takes the input parameter and extract the table name (alias) and column name
+	 *
+	 * @param string $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
+	 * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
+	 * @throws EE_Error
+	 */
+	private function _deduce_column_name_from_query_param($query_param)
+	{
+		$field = $this->_deduce_field_from_query_param($query_param);
+		if ($field) {
+			$table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param(
+				$field->get_model_name(),
+				$query_param
+			);
+			return $table_alias_prefix . $field->get_qualified_column();
+		}
+		if (
+			$this->_custom_selections instanceof CustomSelects
+			&& in_array($query_param, $this->_custom_selections->columnAliases(), true)
+		) {
+			// maybe it's custom selection item?
+			// if so, just use it as the "column name"
+			return $query_param;
+		}
+		$custom_select_aliases = $this->_custom_selections instanceof CustomSelects
+			? implode(',', $this->_custom_selections->columnAliases())
+			: '';
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"%s is not a valid field on this model, nor a custom selection (%s)",
+					"event_espresso"
+				),
+				$query_param,
+				$custom_select_aliases
+			)
+		);
+	}
+
+
+	/**
+	 * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
+	 * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
+	 * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
+	 * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
+	 *
+	 * @param string $condition_query_param_key
+	 * @return string
+	 */
+	private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
+	{
+		$pos_of_star = strpos($condition_query_param_key, '*');
+		if ($pos_of_star === false) {
+			return $condition_query_param_key;
+		}
+		return substr($condition_query_param_key, 0, $pos_of_star);
+	}
+
+
+	/**
+	 * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
+	 *
+	 * @param mixed      array | string    $op_and_value
+	 * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _construct_op_and_value($op_and_value, $field_obj)
+	{
+		if (is_array($op_and_value)) {
+			$operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
+			if (! $operator) {
+				$php_array_like_string = [];
+				foreach ($op_and_value as $key => $value) {
+					$php_array_like_string[] = "$key=>$value";
+				}
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"You setup a query parameter like you were going to specify an operator, but didn't. You provided '(%s)', but the operator should be at array key index 0 (eg array('>',32))",
+							"event_espresso"
+						),
+						implode(",", $php_array_like_string)
+					)
+				);
+			}
+			$value = isset($op_and_value[1]) ? $op_and_value[1] : null;
+		} else {
+			$operator = '=';
+			$value    = $op_and_value;
+		}
+		// check to see if the value is actually another field
+		if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
+			return $operator . SP . $this->_deduce_column_name_from_query_param($value);
+		}
+		if (in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
+			// in this case, the value should be an array, or at least a comma-separated list
+			// it will need to handle a little differently
+			$cleaned_value = $this->_construct_in_value($value, $field_obj);
+			// note: $cleaned_value has already been run through $wpdb->prepare()
+			return $operator . SP . $cleaned_value;
+		}
+		if (in_array($operator, $this->valid_between_style_operators()) && is_array($value)) {
+			// the value should be an array with count of two.
+			if (count($value) !== 2) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
+							'event_espresso'
+						),
+						"BETWEEN"
+					)
+				);
+			}
+			$cleaned_value = $this->_construct_between_value($value, $field_obj);
+			return $operator . SP . $cleaned_value;
+		}
+		if (in_array($operator, $this->valid_null_style_operators())) {
+			if ($value !== null) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
+							"event_espresso"
+						),
+						$value,
+						$operator
+					)
+				);
+			}
+			return $operator;
+		}
+		if (in_array($operator, $this->valid_like_style_operators()) && ! is_array($value)) {
+			// if the operator is 'LIKE', we want to allow percent signs (%) and not
+			// remove other junk. So just treat it as a string.
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
+		}
+		if (! in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
+		}
+		if (in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
+						'event_espresso'
+					),
+					$operator,
+					$operator
+				)
+			);
+		}
+		if (! in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
+						'event_espresso'
+					),
+					$operator,
+					$operator
+				)
+			);
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
+					"event_espresso"
+				),
+				http_build_query($op_and_value)
+			)
+		);
+	}
+
+
+	/**
+	 * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
+	 *
+	 * @param array                      $values
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
+	 *                                              '%s'
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function _construct_between_value($values, $field_obj)
+	{
+		$cleaned_values = [];
+		foreach ($values as $value) {
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
+		}
+		return $cleaned_values[0] . " AND " . $cleaned_values[1];
+	}
+
+
+	/**
+	 * Takes an array or a comma-separated list of $values and cleans them
+	 * according to $data_type using $wpdb->prepare, and then makes the list a
+	 * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
+	 * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
+	 * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
+	 *
+	 * @param mixed                      $values    array or comma-separated string
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
+	 * @return string of SQL to follow an 'IN' or 'NOT IN' operator
+	 * @throws EE_Error
+	 */
+	public function _construct_in_value($values, $field_obj)
+	{
+		// check if the value is a CSV list
+		if (is_string($values)) {
+			// in which case, turn it into an array
+			$values = explode(",", $values);
+		}
+		$cleaned_values = [];
+		foreach ($values as $value) {
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
+		}
+		// we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
+		// but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
+		// which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
+		if (empty($cleaned_values)) {
+			$all_fields       = $this->field_settings();
+			$a_field          = array_shift($all_fields);
+			$main_table       = $this->_get_main_table();
+			$cleaned_values[] = "SELECT "
+								. $a_field->get_table_column()
+								. " FROM "
+								. $main_table->get_table_name()
+								. " WHERE FALSE";
+		}
+		return "(" . implode(",", $cleaned_values) . ")";
+	}
+
+
+	/**
+	 * @param mixed                      $value
+	 * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _wpdb_prepare_using_field($value, $field_obj)
+	{
+		global $wpdb;
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			return $wpdb->prepare(
+				$field_obj->get_wpdb_data_type(),
+				$this->_prepare_value_for_use_in_db($value, $field_obj)
+			);
+		} //$field_obj should really just be a data type
+		if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
+					$field_obj,
+					implode(",", $this->_valid_wpdb_data_types)
+				)
+			);
+		}
+		return $wpdb->prepare($field_obj, $value);
+	}
+
+
+	/**
+	 * Takes the input parameter and finds the model field that it indicates.
+	 *
+	 * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 */
+	protected function _deduce_field_from_query_param($query_param_name)
+	{
+		// ok, now proceed with deducing which part is the model's name, and which is the field's name
+		// which will help us find the database table and column
+		$query_param_parts = explode(".", $query_param_name);
+		if (empty($query_param_parts)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"_extract_column_name is empty when trying to extract column and table name from %s",
+						'event_espresso'
+					),
+					$query_param_name
+				)
+			);
+		}
+		$number_of_parts       = count($query_param_parts);
+		$last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
+		$field_name = $last_query_param_part;
+		$model_obj  = $number_of_parts === 1
+			? $this
+			// $number_of_parts >= 2, the last part is the column name, and there are only 2parts. therefore...
+			: $this->get_related_model_obj($query_param_parts[ $number_of_parts - 2 ]);
+		try {
+			return $model_obj->field_settings_for($field_name);
+		} catch (EE_Error $e) {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
+	 * alias and column which corresponds to it
+	 *
+	 * @param string $field_name
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function _get_qualified_column_for_field($field_name)
+	{
+		$all_fields = $this->field_settings();
+		$field      = isset($all_fields[ $field_name ]) ? $all_fields[ $field_name ] : false;
+		if ($field) {
+			return $field->get_qualified_column();
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"There is no field titled %s on model %s. Either the query trying to use it is bad, or you need to add it to the list of fields on the model.",
+					'event_espresso'
+				),
+				$field_name,
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
+	 * Example usage:
+	 * EEM_Ticket::instance()->get_all_wpdb_results(
+	 *      array(),
+	 *      ARRAY_A,
+	 *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
+	 *  );
+	 * is equivalent to
+	 *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
+	 * and
+	 *  EEM_Event::instance()->get_all_wpdb_results(
+	 *      array(
+	 *          array(
+	 *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
+	 *          ),
+	 *          ARRAY_A,
+	 *          implode(
+	 *              ', ',
+	 *              array_merge(
+	 *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
+	 *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
+	 *              )
+	 *          )
+	 *      )
+	 *  );
+	 * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
+	 *
+	 * @param string $model_relation_chain        the chain of models used to join between the model you want to query
+	 *                                            and the one whose fields you are selecting for example: when querying
+	 *                                            tickets model and selecting fields from the tickets model you would
+	 *                                            leave this parameter empty, because no models are needed to join
+	 *                                            between the queried model and the selected one. Likewise when
+	 *                                            querying the datetime model and selecting fields from the tickets
+	 *                                            model, it would also be left empty, because there is a direct
+	 *                                            relation from datetimes to tickets, so no model is needed to join
+	 *                                            them together. However, when querying from the event model and
+	 *                                            selecting fields from the ticket model, you should provide the string
+	 *                                            'Datetime', indicating that the event model must first join to the
+	 *                                            datetime model in order to find its relation to ticket model.
+	 *                                            Also, when querying from the venue model and selecting fields from
+	 *                                            the ticket model, you should provide the string 'Event.Datetime',
+	 *                                            indicating you need to join the venue model to the event model,
+	 *                                            to the datetime model, in order to find its relation to the ticket
+	 *                                            model. This string is used to deduce the prefix that gets added onto
+	 *                                            the models' tables qualified columns
+	 * @param bool   $return_string               if true, will return a string with qualified column names separated
+	 *                                            by ', ' if false, will simply return a numerically indexed array of
+	 *                                            qualified column names
+	 * @return array|string
+	 */
+	public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
+	{
+		$table_prefix      = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
+		$qualified_columns = [];
+		foreach ($this->field_settings() as $field) {
+			$qualified_columns[] = $table_prefix . $field->get_qualified_column();
+		}
+		return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
+	}
+
+
+	/**
+	 * constructs the select use on special limit joins
+	 * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
+	 * its setup so the select query will be setup on and just doing the special select join off of the primary table
+	 * (as that is typically where the limits would be set).
+	 *
+	 * @param string       $table_alias The table the select is being built for
+	 * @param mixed|string $limit       The limit for this select
+	 * @return string                The final select join element for the query.
+	 * @throws EE_Error
+	 */
+	public function _construct_limit_join_select($table_alias, $limit)
+	{
+		$SQL = '';
+		foreach ($this->_tables as $table_obj) {
+			if ($table_obj instanceof EE_Primary_Table) {
+				$SQL .= $table_alias === $table_obj->get_table_alias()
+					? $table_obj->get_select_join_limit($limit)
+					: SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
+			} elseif ($table_obj instanceof EE_Secondary_Table) {
+				$SQL .= $table_alias === $table_obj->get_table_alias()
+					? $table_obj->get_select_join_limit_join($limit)
+					: SP . $table_obj->get_join_sql($table_alias) . SP;
+			}
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * Constructs the internal join if there are multiple tables, or simply the table's name and alias
+	 * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
+	 *
+	 * @return string SQL
+	 * @throws EE_Error
+	 */
+	public function _construct_internal_join()
+	{
+		$SQL = $this->_get_main_table()->get_table_sql();
+		$SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
+		return $SQL;
+	}
+
+
+	/**
+	 * Constructs the SQL for joining all the tables on this model.
+	 * Normally $alias should be the primary table's alias, but in cases where
+	 * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
+	 * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
+	 * alias, this will construct SQL like:
+	 * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
+	 * With $alias being a secondary table's alias, this will construct SQL like:
+	 * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
+	 *
+	 * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function _construct_internal_join_to_table_with_alias($alias_prefixed)
+	{
+		$SQL               = '';
+		$alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
+		foreach ($this->_tables as $table_obj) {
+			if ($table_obj instanceof EE_Secondary_Table) {// table is secondary table
+				if ($alias_sans_prefix === $table_obj->get_table_alias()) {
+					// so we're joining to this table, meaning the table is already in
+					// the FROM statement, BUT the primary table isn't. So we want
+					// to add the inverse join sql
+					$SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
+				} else {
+					// just add a regular JOIN to this table from the primary table
+					$SQL .= $table_obj->get_join_sql($alias_prefixed);
+				}
+			}//if it's a primary table, dont add any SQL. it should already be in the FROM statement
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * Gets an array for storing all the data types on the next-to-be-executed-query.
+	 * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
+	 * their data type (eg, '%s', '%d', etc)
+	 *
+	 * @return array
+	 */
+	public function _get_data_types()
+	{
+		$data_types = [];
+		foreach ($this->field_settings() as $field_obj) {
+			// $data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
+			/** @var $field_obj EE_Model_Field_Base */
+			$data_types[ $field_obj->get_qualified_column() ] = $field_obj->get_wpdb_data_type();
+		}
+		return $data_types;
+	}
+
+
+	/**
+	 * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
+	 *
+	 * @param string $model_name
+	 * @return EEM_Base
+	 * @throws EE_Error
+	 */
+	public function get_related_model_obj($model_name)
+	{
+		$model_classname = "EEM_" . $model_name;
+		if (! class_exists($model_classname)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"You specified a related model named %s in your query. No such model exists, if it did, it would have the classname %s",
+						'event_espresso'
+					),
+					$model_name,
+					$model_classname
+				)
+			);
+		}
+		return call_user_func($model_classname . "::instance");
+	}
+
+
+	/**
+	 * Returns the array of EE_ModelRelations for this model.
+	 *
+	 * @return EE_Model_Relation_Base[]
+	 */
+	public function relation_settings()
+	{
+		return $this->_model_relations;
+	}
+
+
+	/**
+	 * Gets all related models that this model BELONGS TO. Handy to know sometimes
+	 * because without THOSE models, this model probably doesn't have much purpose.
+	 * (Eg, without an event, datetimes have little purpose.)
+	 *
+	 * @return EE_Belongs_To_Relation[]
+	 */
+	public function belongs_to_relations()
+	{
+		$belongs_to_relations = [];
+		foreach ($this->relation_settings() as $model_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$belongs_to_relations[ $model_name ] = $relation_obj;
+			}
+		}
+		return $belongs_to_relations;
+	}
+
+
+	/**
+	 * Returns the specified EE_Model_Relation, or throws an exception
+	 *
+	 * @param string $relation_name name of relation, key in $this->_relatedModels
+	 * @return EE_Model_Relation_Base
+	 * @throws EE_Error
+	 */
+	public function related_settings_for($relation_name)
+	{
+		$relatedModels = $this->relation_settings();
+		if (! array_key_exists($relation_name, $relatedModels)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
+						'event_espresso'
+					),
+					$relation_name,
+					$this->_get_class_name(),
+					implode(', ', array_keys($relatedModels))
+				)
+			);
+		}
+		return $relatedModels[ $relation_name ];
+	}
+
+
+	/**
+	 * A convenience method for getting a specific field's settings, instead of getting all field settings for all
+	 * fields
+	 *
+	 * @param string  $fieldName
+	 * @param boolean $include_db_only_fields
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 */
+	public function field_settings_for($fieldName, $include_db_only_fields = true)
+	{
+		$fieldSettings = $this->field_settings($include_db_only_fields);
+		if (! array_key_exists($fieldName, $fieldSettings)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("There is no field/column '%s' on '%s'", 'event_espresso'),
+					$fieldName,
+					get_class($this)
+				)
+			);
+		}
+		return $fieldSettings[ $fieldName ];
+	}
+
+
+	/**
+	 * Checks if this field exists on this model
+	 *
+	 * @param string $fieldName a key in the model's _field_settings array
+	 * @return boolean
+	 */
+	public function has_field($fieldName)
+	{
+		$fieldSettings = $this->field_settings(true);
+		if (isset($fieldSettings[ $fieldName ])) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns whether or not this model has a relation to the specified model
+	 *
+	 * @param string $relation_name possibly one of the keys in the relation_settings array
+	 * @return boolean
+	 */
+	public function has_relation($relation_name)
+	{
+		$relations = $this->relation_settings();
+		if (isset($relations[ $relation_name ])) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
+	 * Eg, on EE_Answer that would be ANS_ID field object
+	 *
+	 * @param $field_obj
+	 * @return boolean
+	 */
+	public function is_primary_key_field($field_obj)
+	{
+		return $field_obj instanceof EE_Primary_Key_Field_Base;
+	}
+
+
+	/**
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
+	 * Eg, on EE_Answer that would be ANS_ID field object
+	 *
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 */
+	public function get_primary_key_field()
+	{
+		if ($this->_primary_key_field === null) {
+			foreach ($this->field_settings(true) as $field_obj) {
+				if ($this->is_primary_key_field($field_obj)) {
+					$this->_primary_key_field = $field_obj;
+					break;
+				}
+			}
+			if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__("There is no Primary Key defined on model %s", 'event_espresso'),
+						get_class($this)
+					)
+				);
+			}
+		}
+		return $this->_primary_key_field;
+	}
+
+
+	/**
+	 * Returns whether or not not there is a primary key on this model.
+	 * Internally does some caching.
+	 *
+	 * @return boolean
+	 */
+	public function has_primary_key_field()
+	{
+		if ($this->_has_primary_key_field === null) {
+			try {
+				$this->get_primary_key_field();
+				$this->_has_primary_key_field = true;
+			} catch (EE_Error $e) {
+				$this->_has_primary_key_field = false;
+			}
+		}
+		return $this->_has_primary_key_field;
+	}
+
+
+	/**
+	 * Finds the first field of type $field_class_name.
+	 *
+	 * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
+	 *                                 EE_Foreign_Key_Field, etc
+	 * @return EE_Model_Field_Base or null if none is found
+	 */
+	public function get_a_field_of_type($field_class_name)
+	{
+		foreach ($this->field_settings() as $field) {
+			if ($field instanceof $field_class_name) {
+				return $field;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets a foreign key field pointing to model.
+	 *
+	 * @param string $model_name eg Event, Registration, not EEM_Event
+	 * @return EE_Foreign_Key_Field_Base
+	 * @throws EE_Error
+	 */
+	public function get_foreign_key_to($model_name)
+	{
+		if (! isset($this->_cache_foreign_key_to_fields[ $model_name ])) {
+			foreach ($this->field_settings() as $field) {
+				if (
+					$field instanceof EE_Foreign_Key_Field_Base
+					&& in_array($model_name, $field->get_model_names_pointed_to())
+				) {
+					$this->_cache_foreign_key_to_fields[ $model_name ] = $field;
+					break;
+				}
+			}
+			if (! isset($this->_cache_foreign_key_to_fields[ $model_name ])) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"There is no foreign key field pointing to model %s on model %s",
+							'event_espresso'
+						),
+						$model_name,
+						get_class($this)
+					)
+				);
+			}
+		}
+		return $this->_cache_foreign_key_to_fields[ $model_name ];
+	}
+
+
+	/**
+	 * Gets the table name (including $wpdb->prefix) for the table alias
+	 *
+	 * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
+	 *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
+	 *                            Either one works
+	 * @return string
+	 */
+	public function get_table_for_alias($table_alias)
+	{
+		$table_alias_sans_model_relation_chain_prefix =
+			EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
+		return $this->_tables[ $table_alias_sans_model_relation_chain_prefix ]->get_table_name();
+	}
+
+
+	/**
+	 * Returns a flat array of all field son this model, instead of organizing them
+	 * by table_alias as they are in the constructor.
+	 *
+	 * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
+	 * @return EE_Model_Field_Base[] where the keys are the field's name
+	 */
+	public function field_settings($include_db_only_fields = false)
+	{
+		if ($include_db_only_fields) {
+			if ($this->_cached_fields === null) {
+				$this->_cached_fields = [];
+				foreach ($this->_fields as $fields_corresponding_to_table) {
+					foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
+						$this->_cached_fields[ $field_name ] = $field_obj;
+					}
+				}
+			}
+			return $this->_cached_fields;
+		}
+		if ($this->_cached_fields_non_db_only === null) {
+			$this->_cached_fields_non_db_only = [];
+			foreach ($this->_fields as $fields_corresponding_to_table) {
+				foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
+					/** @var $field_obj EE_Model_Field_Base */
+					if (! $field_obj->is_db_only_field()) {
+						$this->_cached_fields_non_db_only[ $field_name ] = $field_obj;
+					}
+				}
+			}
+		}
+		return $this->_cached_fields_non_db_only;
+	}
+
+
+	/**
+	 *        cycle though array of attendees and create objects out of each item
+	 *
+	 * @access        private
+	 * @param array $rows        of results of $wpdb->get_results($query,ARRAY_A)
+	 * @return EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
+	 *                           numerically indexed)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _create_objects($rows = [])
+	{
+		$array_of_objects = [];
+		if (empty($rows)) {
+			return [];
+		}
+		$count_if_model_has_no_primary_key = 0;
+		$has_primary_key                   = $this->has_primary_key_field();
+		$primary_key_field                 = $has_primary_key ? $this->get_primary_key_field() : null;
+		foreach ((array)$rows as $row) {
+			if (empty($row)) {
+				// wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
+				return [];
+			}
+			// check if we've already set this object in the results array,
+			// in which case there's no need to process it further (again)
+			if ($has_primary_key) {
+				$table_pk_value = $this->_get_column_value_with_table_alias_or_not(
+					$row,
+					$primary_key_field->get_qualified_column(),
+					$primary_key_field->get_table_column()
+				);
+				if ($table_pk_value && isset($array_of_objects[ $table_pk_value ])) {
+					continue;
+				}
+			}
+			$classInstance = $this->instantiate_class_from_array_or_object($row);
+			if (! $classInstance) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__('Could not create instance of class %s from row %s', 'event_espresso'),
+						$this->get_this_model_name(),
+						http_build_query($row)
+					)
+				);
+			}
+			// set the timezone on the instantiated objects
+			$classInstance->set_timezone($this->get_timezone(), true);
+			// make sure if there is any timezone setting present that we set the timezone for the object
+			$key                      = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
+			$array_of_objects[ $key ] = $classInstance;
+			// also, for all the relations of type BelongsTo, see if we can cache
+			// those related models
+			// (we could do this for other relations too, but if there are conditions
+			// that filtered out some fo the results, then we'd be caching an incomplete set
+			// so it requires a little more thought than just caching them immediately...)
+			foreach ($this->_model_relations as $modelName => $relation_obj) {
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
+					// check if this model's INFO is present. If so, cache it on the model
+					$other_model           = $relation_obj->get_other_model();
+					$other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
+					// if we managed to make a model object from the results, cache it on the main model object
+					if ($other_model_obj_maybe) {
+						// set timezone on these other model objects if they are present
+						$other_model_obj_maybe->set_timezone($this->get_timezone(), true);
+						$classInstance->cache($modelName, $other_model_obj_maybe);
+					}
+				}
+			}
+			// also, if this was a custom select query, let's see if there are any results for the custom select fields
+			// and add them to the object as well.  We'll convert according to the set data_type if there's any set for
+			// the field in the CustomSelects object
+			if ($this->_custom_selections instanceof CustomSelects) {
+				$classInstance->setCustomSelectsValues(
+					$this->getValuesForCustomSelectAliasesFromResults($row)
+				);
+			}
+		}
+		return $array_of_objects;
+	}
+
+
+	/**
+	 * This will parse a given row of results from the db and see if any keys in the results match an alias within the
+	 * current CustomSelects object. This will be used to build an array of values indexed by those keys.
+	 *
+	 * @param array $db_results_row
+	 * @return array
+	 */
+	protected function getValuesForCustomSelectAliasesFromResults(array $db_results_row)
+	{
+		$results = [];
+		if ($this->_custom_selections instanceof CustomSelects) {
+			foreach ($this->_custom_selections->columnAliases() as $alias) {
+				if (isset($db_results_row[ $alias ])) {
+					$results[ $alias ] = $this->convertValueToDataType(
+						$db_results_row[ $alias ],
+						$this->_custom_selections->getDataTypeForAlias($alias)
+					);
+				}
+			}
+		}
+		return $results;
+	}
+
+
+	/**
+	 * This will set the value for the given alias
+	 *
+	 * @param string $value
+	 * @param string $datatype (one of %d, %s, %f)
+	 * @return int|string|float (int for %d, string for %s, float for %f)
+	 */
+	protected function convertValueToDataType($value, $datatype)
+	{
+		switch ($datatype) {
+			case '%f':
+				return (float)$value;
+			case '%d':
+				return (int)$value;
+			default:
+				return (string)$value;
+		}
+	}
+
+
+	/**
+	 * The purpose of this method is to allow us to create a model object that is not in the db that holds default
+	 * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
+	 * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
+	 * object (as set in the model_field!).
+	 *
+	 * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create_default_object()
+	{
+		$this_model_fields_and_values = [];
+		// setup the row using default values;
+		foreach ($this->field_settings() as $field_name => $field_obj) {
+			$this_model_fields_and_values[ $field_name ] = $field_obj->get_default_value();
+		}
+		$className = $this->_get_class_name();
+		return EE_Registry::instance()->load_class(
+			$className,
+			[$this_model_fields_and_values],
+			false,
+			false
+		);
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
+	 *                             or an stdClass where each property is the name of a column,
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		if (! is_array($cols_n_values) && is_object($cols_n_values)) {
+			$cols_n_values = get_object_vars($cols_n_values);
+		}
+		$primary_key = null;
+		// make sure the array only has keys that are fields/columns on this model
+		$this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
+		if ($this->has_primary_key_field() && isset($this_model_fields_n_values[ $this->primary_key_name() ])) {
+			$primary_key = $this_model_fields_n_values[ $this->primary_key_name() ];
+		}
+		$className = $this->_get_class_name();
+		// check we actually found results that we can use to build our model object
+		// if not, return null
+		if ($this->has_primary_key_field()) {
+			if (empty($this_model_fields_n_values[ $this->primary_key_name() ])) {
+				return null;
+			}
+		} elseif ($this->unique_indexes()) {
+			$first_column = reset($this_model_fields_n_values);
+			if (empty($first_column)) {
+				return null;
+			}
+		}
+		// if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
+		if ($primary_key) {
+			$classInstance = $this->get_from_entity_map($primary_key);
+			if (! $classInstance) {
+				$classInstance = EE_Registry::instance()->load_class(
+					$className,
+					[$this_model_fields_n_values, $this->get_timezone()],
+					true,
+					false
+				);
+				// add this new object to the entity map
+				$classInstance = $this->add_to_entity_map($classInstance);
+			}
+		} else {
+			$classInstance = EE_Registry::instance()->load_class(
+				$className,
+				[$this_model_fields_n_values, $this->get_timezone()],
+				true,
+				false
+			);
+		}
+		return $classInstance;
+	}
+
+
+	/**
+	 * Gets the model object from the  entity map if it exists
+	 *
+	 * @param int|string $id the ID of the model object
+	 * @return EE_Base_Class
+	 */
+	public function get_from_entity_map($id)
+	{
+		return isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])
+			? $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]
+			: null;
+	}
+
+
+	/**
+	 * add_to_entity_map
+	 * Adds the object to the model's entity mappings
+	 *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
+	 *        and for the remainder of the request, it's even more up-to-date than what's in the database.
+	 *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
+	 *        If the database gets updated directly and you want the entity mapper to reflect that change,
+	 *        then this method should be called immediately after the update query
+	 * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
+	 * so on multisite, the entity map is specific to the query being done for a specific site.
+	 *
+	 * @param EE_Base_Class $object
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 */
+	public function add_to_entity_map(EE_Base_Class $object)
+	{
+		$className = $this->_get_class_name();
+		if (! $object instanceof $className) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("You tried adding a %s to a mapping of %ss", "event_espresso"),
+					is_object($object) ? get_class($object) : $object,
+					$className
+				)
+			);
+		}
+		if (! $object->ID()) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						"You tried storing a model object with NO ID in the %s entity mapper.",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		// double check it's not already there
+		$classInstance = $this->get_from_entity_map($object->ID());
+		if ($classInstance) {
+			return $classInstance;
+		}
+		$this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $object->ID() ] = $object;
+		return $object;
+	}
+
+
+	/**
+	 * if a valid identifier is provided, then that entity is unset from the entity map,
+	 * if no identifier is provided, then the entire entity map is emptied
+	 *
+	 * @param int|string $id the ID of the model object
+	 * @return boolean
+	 */
+	public function clear_entity_map($id = null)
+	{
+		if (empty($id)) {
+			$this->_entity_map[ EEM_Base::$_model_query_blog_id ] = [];
+			return true;
+		}
+		if (isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])) {
+			unset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
+	 * Given an array where keys are column (or column alias) names and values,
+	 * returns an array of their corresponding field names and database values
+	 *
+	 * @param array $cols_n_values
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
+	{
+		return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
+	}
+
+
+	/**
+	 * _deduce_fields_n_values_from_cols_n_values
+	 * Given an array where keys are column (or column alias) names and values,
+	 * returns an array of their corresponding field names and database values
+	 *
+	 * @param array $cols_n_values
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
+	{
+		$this_model_fields_n_values = [];
+		foreach ($this->get_tables() as $table_alias => $table_obj) {
+			$table_pk_value = $this->_get_column_value_with_table_alias_or_not(
+				$cols_n_values,
+				$table_obj->get_fully_qualified_pk_column(),
+				$table_obj->get_pk_column()
+			);
+			// there is a primary key on this table and its not set. Use defaults for all its columns
+			if ($table_pk_value === null && $table_obj->get_pk_column()) {
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
+					if (! $field_obj->is_db_only_field()) {
+						// prepare field as if its coming from db
+						$prepared_value                            =
+							$field_obj->prepare_for_set($field_obj->get_default_value());
+						$this_model_fields_n_values[ $field_name ] = $field_obj->prepare_for_use_in_db($prepared_value);
+					}
+				}
+			} else {
+				// the table's rows existed. Use their values
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
+					if (! $field_obj->is_db_only_field()) {
+						$this_model_fields_n_values[ $field_name ] = $this->_get_column_value_with_table_alias_or_not(
+							$cols_n_values,
+							$field_obj->get_qualified_column(),
+							$field_obj->get_table_column()
+						);
+					}
+				}
+			}
+		}
+		return $this_model_fields_n_values;
+	}
+
+
+	/**
+	 * @param array  $cols_n_values
+	 * @param string $qualified_column
+	 * @param string $regular_column
+	 * @return null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
+	{
+		$value = null;
+		// ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
+		// does the field on the model relate to this column retrieved from the db?
+		// or is it a db-only field? (not relating to the model)
+		if (isset($cols_n_values[ $qualified_column ])) {
+			$value = $cols_n_values[ $qualified_column ];
+		} elseif (isset($cols_n_values[ $regular_column ])) {
+			$value = $cols_n_values[ $regular_column ];
+		} elseif (! empty($this->foreign_key_aliases)) {
+			// no PK?  ok check if there is a foreign key alias set for this table
+			// then check if that alias exists in the incoming data
+			// AND that the actual PK the $FK_alias represents matches the $qualified_column (full PK)
+			foreach ($this->foreign_key_aliases as $FK_alias => $PK_column) {
+				if ($PK_column === $qualified_column && isset($cols_n_values[ $FK_alias ])) {
+					$value = $cols_n_values[ $FK_alias ];
+					[$pk_class] = explode('.', $PK_column);
+					$pk_model_name = "EEM_{$pk_class}";
+					/** @var EEM_Base $pk_model */
+					$pk_model = EE_Registry::instance()->load_model($pk_model_name);
+					if ($pk_model instanceof EEM_Base) {
+						// make sure object is pulled from db and added to entity map
+						$pk_model->get_one_by_ID($value);
+					}
+					break;
+				}
+			}
+		}
+		return $value;
+	}
+
+
+	/**
+	 * refresh_entity_map_from_db
+	 * Makes sure the model object in the entity map at $id assumes the values
+	 * of the database (opposite of EE_base_Class::save())
+	 *
+	 * @param int|string $id
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function refresh_entity_map_from_db($id)
+	{
+		$obj_in_map = $this->get_from_entity_map($id);
+		if ($obj_in_map) {
+			$wpdb_results = $this->_get_all_wpdb_results(
+				[[$this->get_primary_key_field()->get_name() => $id], 'limit' => 1]
+			);
+			if ($wpdb_results && is_array($wpdb_results)) {
+				$one_row = reset($wpdb_results);
+				foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
+					$obj_in_map->set_from_db($field_name, $db_value);
+				}
+				// clear the cache of related model objects
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
+					$obj_in_map->clear_cache($relation_name, null, true);
+				}
+			}
+			$this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ] = $obj_in_map;
+			return $obj_in_map;
+		}
+		return $this->get_one_by_ID($id);
+	}
+
+
+	/**
+	 * refresh_entity_map_with
+	 * Leaves the entry in the entity map alone, but updates it to match the provided
+	 * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
+	 * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
+	 * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
+	 *
+	 * @param int|string    $id
+	 * @param EE_Base_Class $replacing_model_obj
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function refresh_entity_map_with($id, $replacing_model_obj)
+	{
+		$obj_in_map = $this->get_from_entity_map($id);
+		if ($obj_in_map) {
+			if ($replacing_model_obj instanceof EE_Base_Class) {
+				foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
+					$obj_in_map->set($field_name, $value);
+				}
+				// make the model object in the entity map's cache match the $replacing_model_obj
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
+					$obj_in_map->clear_cache($relation_name, null, true);
+					foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
+						$obj_in_map->cache($relation_name, $cached_obj, $cache_id);
+					}
+				}
+			}
+			return $obj_in_map;
+		}
+		$this->add_to_entity_map($replacing_model_obj);
+		return $replacing_model_obj;
+	}
+
+
+	/**
+	 * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
+	 * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
+	 * require_once($this->_getClassName().".class.php");
+	 *
+	 * @return string
+	 */
+	private function _get_class_name()
+	{
+		return "EE_" . $this->get_this_model_name();
+	}
+
+
+	/**
+	 * Get the name of the items this model represents, for the quantity specified. Eg,
+	 * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
+	 * it would be 'Events'.
+	 *
+	 * @param int $quantity
+	 * @return string
+	 */
+	public function item_name($quantity = 1)
+	{
+		return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
+	}
+
+
+	/**
+	 * Very handy general function to allow for plugins to extend any child of EE_TempBase.
+	 * If a method is called on a child of EE_TempBase 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_TempBase (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_TempBase $object,$argsArray){
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
+	 *        return $previousReturnValue.$returnString;
+	 * }
+	 * require('EEM_Answer.model.php');
+	 * $answer=EEM_Answer::instance();
+	 * echo $answer->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_TempBase, 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 %1$s on model %2$s does not exist! You can create one with the following code in functions.php or in a plugin: %4$s function my_callback(%4$s \$previousReturnValue, EEM_Base \$object\ $argsArray=NULL ){%4$s     /*function body*/%4$s      return \$whatever;%4$s }%4$s add_filter( \'%3$s\', \'my_callback\', 10, 3 );',
+						'event_espresso'
+					),
+					$methodName,
+					$className,
+					$tagName,
+					'<br />'
+				)
+			);
+		}
+		return apply_filters($tagName, null, $this, $args);
+	}
+
+
+	/**
+	 * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
+	 * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
+	 *
+	 * @param EE_Base_Class|string|int $base_class_obj_or_id either:
+	 *                                                       the EE_Base_Class object that corresponds to this Model,
+	 *                                                       the object's class name
+	 *                                                       or object's ID
+	 * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
+	 *                                                       exists in the database. If it does not, we add it
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
+	{
+		$className = $this->_get_class_name();
+		if ($base_class_obj_or_id instanceof $className) {
+			$model_object = $base_class_obj_or_id;
+		} else {
+			$primary_key_field = $this->get_primary_key_field();
+			if (
+				$primary_key_field instanceof EE_Primary_Key_Int_Field
+				&& (
+					is_int($base_class_obj_or_id)
+					|| is_string($base_class_obj_or_id)
+				)
+			) {
+				// assume it's an ID.
+				// either a proper integer or a string representing an integer (eg "101" instead of 101)
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
+			} elseif (
+				$primary_key_field instanceof EE_Primary_Key_String_Field
+				&& is_string($base_class_obj_or_id)
+			) {
+				// assume its a string representation of the object
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
+							'event_espresso'
+						),
+						$base_class_obj_or_id,
+						$this->_get_class_name(),
+						print_r($base_class_obj_or_id, true)
+					)
+				);
+			}
+		}
+		if ($ensure_is_in_db && $model_object->ID() !== null) {
+			$model_object->save();
+		}
+		return $model_object;
+	}
+
+
+	/**
+	 * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
+	 * is a value of the this model's primary key. If it's an EE_Base_Class child,
+	 * returns it ID.
+	 *
+	 * @param EE_Base_Class|int|string $base_class_obj_or_id
+	 * @return int|string depending on the type of this model object's ID
+	 * @throws EE_Error
+	 */
+	public function ensure_is_ID($base_class_obj_or_id)
+	{
+		$className = $this->_get_class_name();
+		if ($base_class_obj_or_id instanceof $className) {
+			$id = $base_class_obj_or_id->ID();
+		} elseif (is_int($base_class_obj_or_id)) {
+			// assume it's an ID
+			$id = $base_class_obj_or_id;
+		} elseif (is_string($base_class_obj_or_id)) {
+			// assume its a string representation of the object
+			$id = $base_class_obj_or_id;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
+						'event_espresso'
+					),
+					$base_class_obj_or_id,
+					$this->_get_class_name(),
+					print_r($base_class_obj_or_id, true)
+				)
+			);
+		}
+		return $id;
+	}
+
+
+	/**
+	 * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
+	 * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
+	 * been sanitized and converted into the appropriate domain.
+	 * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
+	 * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
+	 * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
+	 * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
+	 * $EVT = EEM_Event::instance(); $old_setting =
+	 * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
+	 * $EVT->assume_values_already_prepared_by_model_object(true);
+	 * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
+	 * $EVT->assume_values_already_prepared_by_model_object($old_setting);
+	 *
+	 * @param int $values_already_prepared like one of the constants on EEM_Base
+	 * @return void
+	 */
+	public function assume_values_already_prepared_by_model_object(
+		$values_already_prepared = self::not_prepared_by_model_object
+	) {
+		$this->_values_already_prepared_by_model_object = $values_already_prepared;
+	}
+
+
+	/**
+	 * Read comments for assume_values_already_prepared_by_model_object()
+	 *
+	 * @return int
+	 */
+	public function get_assumption_concerning_values_already_prepared_by_model_object()
+	{
+		return $this->_values_already_prepared_by_model_object;
+	}
+
+
+	/**
+	 * Gets all the indexes on this model
+	 *
+	 * @return EE_Index[]
+	 */
+	public function indexes()
+	{
+		return $this->_indexes;
+	}
+
+
+	/**
+	 * Gets all the Unique Indexes on this model
+	 *
+	 * @return EE_Unique_Index[]
+	 */
+	public function unique_indexes()
+	{
+		$unique_indexes = [];
+		foreach ($this->_indexes as $name => $index) {
+			if ($index instanceof EE_Unique_Index) {
+				$unique_indexes [ $name ] = $index;
+			}
+		}
+		return $unique_indexes;
+	}
+
+
+	/**
+	 * Gets all the fields which, when combined, make the primary key.
+	 * This is usually just an array with 1 element (the primary key), but in cases
+	 * where there is no primary key, it's a combination of fields as defined
+	 * on a primary index
+	 *
+	 * @return EE_Model_Field_Base[] indexed by the field's name
+	 * @throws EE_Error
+	 */
+	public function get_combined_primary_key_fields()
+	{
+		foreach ($this->indexes() as $index) {
+			if ($index instanceof EE_Primary_Key_Index) {
+				return $index->fields();
+			}
+		}
+		return [$this->primary_key_name() => $this->get_primary_key_field()];
+	}
+
+
+	/**
+	 * Used to build a primary key string (when the model has no primary key),
+	 * which can be used a unique string to identify this model object.
+	 *
+	 * @param array $fields_n_values keys are field names, values are their values.
+	 *                               Note: if you have results from `EEM_Base::get_all_wpdb_results()`, you need to
+	 *                               run it through `EEM_Base::deduce_fields_n_values_from_cols_n_values()`
+	 *                               before passing it to this function (that will convert it from columns-n-values
+	 *                               to field-names-n-values).
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_index_primary_key_string($fields_n_values)
+	{
+		$cols_n_values_for_primary_key_index = array_intersect_key(
+			$fields_n_values,
+			$this->get_combined_primary_key_fields()
+		);
+		return http_build_query($cols_n_values_for_primary_key_index);
+	}
+
+
+	/**
+	 * Gets the field values from the primary key string
+	 *
+	 * @param string $index_primary_key_string
+	 * @return null|array
+	 * @throws EE_Error
+	 * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
+	 */
+	public function parse_index_primary_key_string($index_primary_key_string)
+	{
+		$key_fields = $this->get_combined_primary_key_fields();
+		// check all of them are in the $id
+		$key_values_in_combined_pk = [];
+		parse_str($index_primary_key_string, $key_values_in_combined_pk);
+		foreach ($key_fields as $key_field_name => $field_obj) {
+			if (! isset($key_values_in_combined_pk[ $key_field_name ])) {
+				return null;
+			}
+		}
+		return $key_values_in_combined_pk;
+	}
+
+
+	/**
+	 * verifies that an array of key-value pairs for model fields has a key
+	 * for each field comprising the primary key index
+	 *
+	 * @param array $key_values
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function has_all_combined_primary_key_fields($key_values)
+	{
+		$keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
+		foreach ($keys_it_should_have as $key) {
+			if (! isset($key_values[ $key ])) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
+	 * We consider something to be a copy if all the attributes match (except the ID, of course).
+	 *
+	 * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
+	 * @param array               $query_params                     see github link below for more info
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @return EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
+	 *                                                              indexed)
+	 */
+	public function get_all_copies($model_object_or_attributes_array, $query_params = [])
+	{
+		if ($model_object_or_attributes_array instanceof EE_Base_Class) {
+			$attributes_array = $model_object_or_attributes_array->model_field_array();
+		} elseif (is_array($model_object_or_attributes_array)) {
+			$attributes_array = $model_object_or_attributes_array;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"get_all_copies should be provided with either a model object or an array of field-value-pairs, but was given %s",
+						"event_espresso"
+					),
+					$model_object_or_attributes_array
+				)
+			);
+		}
+		// even copies obviously won't have the same ID, so remove the primary key
+		// from the WHERE conditions for finding copies (if there is a primary key, of course)
+		if ($this->has_primary_key_field() && isset($attributes_array[ $this->primary_key_name() ])) {
+			unset($attributes_array[ $this->primary_key_name() ]);
+		}
+		if (isset($query_params[0])) {
+			$query_params[0] = array_merge($attributes_array, $query_params);
+		} else {
+			$query_params[0] = $attributes_array;
+		}
+		return $this->get_all($query_params);
+	}
+
+
+	/**
+	 * Gets the first copy we find. See get_all_copies for more details
+	 *
+	 * @param mixed EE_Base_Class | array        $model_object_or_attributes_array
+	 * @param array $query_params
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one_copy($model_object_or_attributes_array, $query_params = [])
+	{
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong(
+				'EEM_Base::get_one_copy',
+				sprintf(
+					esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = [];
+		}
+		$query_params['limit'] = 1;
+		$copies                = $this->get_all_copies($model_object_or_attributes_array, $query_params);
+		if (is_array($copies)) {
+			return array_shift($copies);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Updates the item with the specified id. Ignores default query parameters because
+	 * we have specified the ID, and its assumed we KNOW what we're doing
+	 *
+	 * @param array      $fields_n_values keys are field names, values are their new values
+	 * @param int|string $id              the value of the primary key to update
+	 * @return int number of rows updated
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_by_ID($fields_n_values, $id)
+	{
+		$query_params = [
+			0                          => [$this->get_primary_key_field()->get_name() => $id],
+			'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
+		];
+		return $this->update($fields_n_values, $query_params);
+	}
+
+
+	/**
+	 * Changes an operator which was supplied to the models into one usable in SQL
+	 *
+	 * @param string $operator_supplied
+	 * @return string an operator which can be used in SQL
+	 * @throws EE_Error
+	 */
+	private function _prepare_operator_for_sql($operator_supplied)
+	{
+		$sql_operator =
+			isset($this->_valid_operators[ $operator_supplied ]) ? $this->_valid_operators[ $operator_supplied ]
+				: null;
+		if ($sql_operator) {
+			return $sql_operator;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"The operator '%s' is not in the list of valid operators: %s",
+					"event_espresso"
+				),
+				$operator_supplied,
+				implode(",", array_keys($this->_valid_operators))
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the valid operators
+	 *
+	 * @return array keys are accepted strings, values are the SQL they are converted to
+	 */
+	public function valid_operators()
+	{
+		return $this->_valid_operators;
+	}
+
+
+	/**
+	 * Gets the between-style operators (take 2 arguments).
+	 *
+	 * @return array keys are accepted strings, values are the SQL they are converted to
+	 */
+	public function valid_between_style_operators()
+	{
+		return array_intersect(
+			$this->valid_operators(),
+			$this->_between_style_operators
+		);
+	}
+
+
+	/**
+	 * Gets the "like"-style operators (take a single argument, but it may contain wildcards)
+	 *
+	 * @return array keys are accepted strings, values are the SQL they are converted to
+	 */
+	public function valid_like_style_operators()
+	{
+		return array_intersect(
+			$this->valid_operators(),
+			$this->_like_style_operators
+		);
+	}
+
+
+	/**
+	 * Gets the "in"-style operators
+	 *
+	 * @return array keys are accepted strings, values are the SQL they are converted to
+	 */
+	public function valid_in_style_operators()
+	{
+		return array_intersect(
+			$this->valid_operators(),
+			$this->_in_style_operators
+		);
+	}
+
+
+	/**
+	 * Gets the "null"-style operators (accept no arguments)
+	 *
+	 * @return array keys are accepted strings, values are the SQL they are converted to
+	 */
+	public function valid_null_style_operators()
+	{
+		return array_intersect(
+			$this->valid_operators(),
+			$this->_null_style_operators
+		);
+	}
+
+
+	/**
+	 * Gets an array where keys are the primary keys and values are their 'names'
+	 * (as determined by the model object's name() function, which is often overridden)
+	 *
+	 * @param array $query_params like get_all's
+	 * @return string[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_names($query_params = [])
+	{
+		$objs  = $this->get_all($query_params);
+		$names = [];
+		foreach ($objs as $obj) {
+			$names[ $obj->ID() ] = $obj->name();
+		}
+		return $names;
+	}
+
+
+	/**
+	 * Gets an array of primary keys from the model objects. If you acquired the model objects
+	 * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
+	 * this is duplicated effort and reduces efficiency) you would be better to use
+	 * array_keys() on $model_objects.
+	 *
+	 * @param EE_Base_Class[] $model_objects
+	 * @param boolean         $filter_out_empty_ids  if a model object has an ID of '' or 0, don't bother including it
+	 *                                               in the returned array
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_IDs($model_objects, $filter_out_empty_ids = false)
+	{
+		if (! $this->has_primary_key_field()) {
+			if (WP_DEBUG) {
+				EE_Error::add_error(
+					esc_html__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		$IDs = [];
+		foreach ($model_objects as $model_object) {
+			$id = $model_object->ID();
+			if (! $id) {
+				if ($filter_out_empty_ids) {
+					continue;
+				}
+				if (WP_DEBUG) {
+					EE_Error::add_error(
+						esc_html__(
+							'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+			$IDs[] = $id;
+		}
+		return $IDs;
+	}
+
+
+	/**
+	 * Returns the string used in capabilities relating to this model. If there
+	 * are no capabilities that relate to this model returns false
+	 *
+	 * @return string|false
+	 */
+	public function cap_slug()
+	{
+		return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
+	}
+
+
+	/**
+	 * Returns the capability-restrictions array (@param string $context
+	 *
+	 * @return EE_Default_Where_Conditions[] indexed by associated capability
+	 * @throws EE_Error
+	 * @see EEM_Base::_cap_restrictions).
+	 *      If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
+	 *      only returns the cap restrictions array in that context (ie, the array
+	 *      at that key)
+	 *
+	 */
+	public function cap_restrictions($context = EEM_Base::caps_read)
+	{
+		EEM_Base::verify_is_valid_cap_context($context);
+		// check if we ought to run the restriction generator first
+		if (
+			isset($this->_cap_restriction_generators[ $context ])
+			&& $this->_cap_restriction_generators[ $context ] instanceof EE_Restriction_Generator_Base
+			&& ! $this->_cap_restriction_generators[ $context ]->has_generated_cap_restrictions()
+		) {
+			$this->_cap_restrictions[ $context ] = array_merge(
+				$this->_cap_restrictions[ $context ],
+				$this->_cap_restriction_generators[ $context ]->generate_restrictions()
+			);
+		}
+		// and make sure we've finalized the construction of each restriction
+		foreach ($this->_cap_restrictions[ $context ] as $where_conditions_obj) {
+			if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
+				$where_conditions_obj->_finalize_construct($this);
+			}
+		}
+		return $this->_cap_restrictions[ $context ];
+	}
+
+
+	/**
+	 * Indicating whether or not this model thinks its a wp core model
+	 *
+	 * @return boolean
+	 */
+	public function is_wp_core_model()
+	{
+		return $this->_wp_core_model;
+	}
+
+
+	/**
+	 * Gets all the caps that are missing which impose a restriction on
+	 * queries made in this context
+	 *
+	 * @param string $context one of EEM_Base::caps_ constants
+	 * @return EE_Default_Where_Conditions[] indexed by capability name
+	 * @throws EE_Error
+	 */
+	public function caps_missing($context = EEM_Base::caps_read)
+	{
+		$missing_caps     = [];
+		$cap_restrictions = $this->cap_restrictions($context);
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
+			if (
+			! EE_Capabilities::instance()
+							 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
+			) {
+				$missing_caps[ $cap ] = $restriction_if_no_cap;
+			}
+		}
+		return $missing_caps;
+	}
+
+
+	/**
+	 * Gets the mapping from capability contexts to action strings used in capability names
+	 *
+	 * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
+	 * one of 'read', 'edit', or 'delete'
+	 */
+	public function cap_contexts_to_cap_action_map()
+	{
+		return apply_filters(
+			'FHEE__EEM_Base__cap_contexts_to_cap_action_map',
+			$this->_cap_contexts_to_cap_action_map,
+			$this
+		);
+	}
+
+
+	/**
+	 * Gets the action string for the specified capability context
+	 *
+	 * @param string $context
+	 * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
+	 * @throws EE_Error
+	 */
+	public function cap_action_for_context($context)
+	{
+		$mapping = $this->cap_contexts_to_cap_action_map();
+		if (isset($mapping[ $context ])) {
+			return $mapping[ $context ];
+		}
+		if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
+			return $action;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
+				$context,
+				implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
+			)
+		);
+	}
+
+
+	/**
+	 * Returns all the capability contexts which are valid when querying models
+	 *
+	 * @return array
+	 */
+	public static function valid_cap_contexts()
+	{
+		return apply_filters(
+			'FHEE__EEM_Base__valid_cap_contexts',
+			[
+				self::caps_read,
+				self::caps_read_admin,
+				self::caps_edit,
+				self::caps_delete,
+			]
+		);
+	}
+
+
+	/**
+	 * Returns all valid options for 'default_where_conditions'
+	 *
+	 * @return array
+	 */
+	public static function valid_default_where_conditions()
+	{
+		return [
+			EEM_Base::default_where_conditions_all,
+			EEM_Base::default_where_conditions_this_only,
+			EEM_Base::default_where_conditions_others_only,
+			EEM_Base::default_where_conditions_minimum_all,
+			EEM_Base::default_where_conditions_minimum_others,
+			EEM_Base::default_where_conditions_none,
+		];
+	}
+
+	// public static function default_where_conditions_full
+
+
+	/**
+	 * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
+	 *
+	 * @param string $context
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public static function verify_is_valid_cap_context($context)
+	{
+		$valid_cap_contexts = EEM_Base::valid_cap_contexts();
+		if (in_array($context, $valid_cap_contexts)) {
+			return true;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
+					'event_espresso'
+				),
+				$context,
+				'EEM_Base',
+				implode(',', $valid_cap_contexts)
+			)
+		);
+	}
+
+
+	/**
+	 * Clears all the models field caches. This is only useful when a sub-class
+	 * might have added a field or something and these caches might be invalidated
+	 */
+	protected function _invalidate_field_caches()
+	{
+		$this->_cache_foreign_key_to_fields = [];
+		$this->_cached_fields               = null;
+		$this->_cached_fields_non_db_only   = null;
+	}
+
+
+	/**
+	 * Gets the list of all the where query param keys that relate to logic instead of field names
+	 * (eg "and", "or", "not").
+	 *
+	 * @return array
+	 */
+	public function logic_query_param_keys()
+	{
+		return $this->_logic_query_param_keys;
+	}
+
+
+	/**
+	 * Determines whether or not the where query param array key is for a logic query param.
+	 * Eg 'OR', 'not*', and 'and*because-i-say-so' should all return true, whereas
+	 * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
+	 *
+	 * @param $query_param_key
+	 * @return bool
+	 */
+	public function is_logic_query_param_key($query_param_key)
+	{
+		foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
+			if (
+				$query_param_key === $logic_query_param_key
+				|| strpos($query_param_key, $logic_query_param_key . '*') === 0
+			) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns true if this model has a password field on it (regardless of whether that password field has any content)
+	 *
+	 * @return boolean
+	 * @since 4.9.74.p
+	 */
+	public function hasPassword()
+	{
+		// if we don't yet know if there's a password field, find out and remember it for next time.
+		if ($this->has_password_field === null) {
+			$password_field           = $this->getPasswordField();
+			$this->has_password_field = $password_field instanceof EE_Password_Field;
+		}
+		return $this->has_password_field;
+	}
+
+
+	/**
+	 * Returns the password field on this model, if there is one
+	 *
+	 * @return EE_Password_Field|null
+	 * @since 4.9.74.p
+	 */
+	public function getPasswordField()
+	{
+		// if we definitely already know there is a password field or not (because has_password_field is true or false)
+		// there's no need to search for it. If we don't know yet, then find out
+		if ($this->has_password_field === null && $this->password_field === null) {
+			$this->password_field = $this->get_a_field_of_type('EE_Password_Field');
+		}
+		// don't bother setting has_password_field because that's hasPassword()'s job.
+		return $this->password_field;
+	}
+
+
+	/**
+	 * Returns the list of field (as EE_Model_Field_Bases) that are protected by the password
+	 *
+	 * @return EE_Model_Field_Base[]
+	 * @throws EE_Error
+	 * @since 4.9.74.p
+	 */
+	public function getPasswordProtectedFields()
+	{
+		$password_field = $this->getPasswordField();
+		$fields         = [];
+		if ($password_field instanceof EE_Password_Field) {
+			$field_names = $password_field->protectedFields();
+			foreach ($field_names as $field_name) {
+				$fields[ $field_name ] = $this->field_settings_for($field_name);
+			}
+		}
+		return $fields;
+	}
+
+
+	/**
+	 * Checks if the current user can perform the requested action on this model
+	 *
+	 * @param string              $cap_to_check one of the array keys from _cap_contexts_to_cap_action_map
+	 * @param EE_Base_Class|array $model_obj_or_fields_n_values
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 * @since 4.9.74.p
+	 */
+	public function currentUserCan($cap_to_check, $model_obj_or_fields_n_values)
+	{
+		if ($model_obj_or_fields_n_values instanceof EE_Base_Class) {
+			$model_obj_or_fields_n_values = $model_obj_or_fields_n_values->model_field_array();
+		}
+		if (! is_array($model_obj_or_fields_n_values)) {
+			throw new UnexpectedEntityException(
+				$model_obj_or_fields_n_values,
+				'EE_Base_Class',
+				sprintf(
+					esc_html__(
+						'%1$s must be passed an `EE_Base_Class or an array of fields names with their values. You passed in something different.',
+						'event_espresso'
+					),
+					__FUNCTION__
+				)
+			);
+		}
+		return $this->exists(
+			$this->alter_query_params_to_restrict_by_ID(
+				$this->get_index_primary_key_string($model_obj_or_fields_n_values),
+				[
+					'default_where_conditions' => 'none',
+					'caps'                     => $cap_to_check,
+				]
+			)
+		);
+	}
+
+
+	/**
+	 * Returns the query param where conditions key to the password affecting this model.
+	 * Eg on EEM_Event this would just be "password", on EEM_Datetime this would be "Event.password", etc.
+	 *
+	 * @return null|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @since 4.9.74.p
+	 */
+	public function modelChainAndPassword()
+	{
+		if ($this->model_chain_to_password === null) {
+			throw new ModelConfigurationException(
+				$this,
+				esc_html_x(
+				// @codingStandardsIgnoreStart
+					'Cannot exclude protected data because the model has not specified which model has the password.',
+					// @codingStandardsIgnoreEnd
+					'1: model name',
+					'event_espresso'
+				)
+			);
+		}
+		if ($this->model_chain_to_password === '') {
+			$model_with_password = $this;
+		} else {
+			if ($pos_of_period = strrpos($this->model_chain_to_password, '.')) {
+				$last_model_in_chain = substr($this->model_chain_to_password, $pos_of_period + 1);
+			} else {
+				$last_model_in_chain = $this->model_chain_to_password;
+			}
+			$model_with_password = EE_Registry::instance()->load_model($last_model_in_chain);
+		}
+
+		$password_field = $model_with_password->getPasswordField();
+		if ($password_field instanceof EE_Password_Field) {
+			$password_field_name = $password_field->get_name();
+		} else {
+			throw new ModelConfigurationException(
+				$this,
+				sprintf(
+					esc_html_x(
+						'This model claims related model "%1$s" should have a password field on it, but none was found. The model relation chain is "%2$s"',
+						'1: model name, 2: special string',
+						'event_espresso'
+					),
+					$model_with_password->get_this_model_name(),
+					$this->model_chain_to_password
+				)
+			);
+		}
+		return ($this->model_chain_to_password ? $this->model_chain_to_password . '.' : '') . $password_field_name;
+	}
+
+
+	/**
+	 * Returns true if there is a password on a related model which restricts access to some of this model's rows,
+	 * or if this model itself has a password affecting access to some of its other fields.
+	 *
+	 * @return boolean
+	 * @since 4.9.74.p
+	 */
+	public function restrictedByRelatedModelPassword()
+	{
+		return $this->model_chain_to_password !== null;
+	}
 }

Spacing +248 added lines, -248 removed lines

@@ -567,7 +567,7 @@ 
     protected function __construct($timezone = '')
     {
         // check that the model has not been loaded too soon
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -590,7 +590,7 @@ 
          *
          * @var EE_Table_Base[] $_tables
          */
-        $this->_tables = (array)apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
+        $this->_tables = (array) apply_filters('FHEE__'.get_class($this).'__construct__tables', $this->_tables);
         foreach ($this->_tables as $table_alias => $table_obj) {
             /** @var $table_obj EE_Table_Base */
             $table_obj->_construct_finalize_with_alias($table_alias);
@@ -605,10 +605,10 @@ 
          *
          * @param EE_Model_Field_Base[] $_fields
          */
-        $this->_fields = (array)apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
+        $this->_fields = (array) apply_filters('FHEE__'.get_class($this).'__construct__fields', $this->_fields);
         $this->_invalidate_field_caches();
         foreach ($this->_fields as $table_alias => $fields_for_table) {
-            if (! array_key_exists($table_alias, $this->_tables)) {
+            if ( ! array_key_exists($table_alias, $this->_tables)) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -644,8 +644,8 @@ 
          *
          * @param EE_Model_Relation_Base[] $_model_relations
          */
-        $this->_model_relations = (array)apply_filters(
-            'FHEE__' . get_class($this) . '__construct__model_relations',
+        $this->_model_relations = (array) apply_filters(
+            'FHEE__'.get_class($this).'__construct__model_relations',
             $this->_model_relations
         );
         foreach ($this->_model_relations as $model_name => $relation_obj) {
@@ -657,12 +657,12 @@ 
         }
         $this->set_timezone($timezone);
         // finalize default where condition strategy, or set default
-        if (! $this->_default_where_conditions_strategy) {
+        if ( ! $this->_default_where_conditions_strategy) {
             // nothing was set during child constructor, so set default
             $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
         }
         $this->_default_where_conditions_strategy->_finalize_construct($this);
-        if (! $this->_minimum_where_conditions_strategy) {
+        if ( ! $this->_minimum_where_conditions_strategy) {
             // nothing was set during child constructor, so set default
             $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
         }
@@ -673,10 +673,10 @@ 
             $this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
         }
         // initialize the standard cap restriction generators if none were specified by the child constructor
-        if (! empty($this->_cap_restriction_generators)) {
+        if ( ! empty($this->_cap_restriction_generators)) {
             foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-                if (! isset($this->_cap_restriction_generators[ $cap_context ])) {
-                    $this->_cap_restriction_generators[ $cap_context ] = apply_filters(
+                if ( ! isset($this->_cap_restriction_generators[$cap_context])) {
+                    $this->_cap_restriction_generators[$cap_context] = apply_filters(
                         'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
                         new EE_Restriction_Generator_Protected(),
                         $cap_context,
@@ -688,10 +688,10 @@ 
         // if ($this->_cap_restriction_generators !== false) {
         // if there are cap restriction generators, use them to make the default cap restrictions
             foreach ($this->_cap_restriction_generators as $context => $generator_object) {
-                if (! $generator_object) {
+                if ( ! $generator_object) {
                     continue;
                 }
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
+                if ( ! $generator_object instanceof EE_Restriction_Generator_Base) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -704,12 +704,12 @@ 
                     );
                 }
                 $action = $this->cap_action_for_context($context);
-                if (! $generator_object->construction_finalized()) {
+                if ( ! $generator_object->construction_finalized()) {
                     $generator_object->_construct_finalize($this, $action);
                 }
             }
         }
-        do_action('AHEE__' . get_class($this) . '__construct__end');
+        do_action('AHEE__'.get_class($this).'__construct__end');
     }
 
 
@@ -721,7 +721,7 @@ 
      */
     public static function set_model_query_blog_id($blog_id = 0)
     {
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
+        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int) $blog_id : get_current_blog_id();
     }
 
 
@@ -753,7 +753,7 @@ 
     public static function instance($timezone = '')
     {
         // check if instance of Espresso_model already exists
-        if (! static::$_instance instanceof static) {
+        if ( ! static::$_instance instanceof static) {
             // instantiate Espresso_model
             static::$_instance = new static(
                 $timezone,
@@ -789,7 +789,7 @@ 
             foreach ($r->getDefaultProperties() as $property => $value) {
                 // don't set instance to null like it was originally,
                 // but it's static anyways, and we're ignoring static properties (for now at least)
-                if (! isset($static_properties[ $property ])) {
+                if ( ! isset($static_properties[$property])) {
                     static::$_instance->{$property} = $value;
                 }
             }
@@ -813,7 +813,7 @@ 
      */
     private static function getLoader()
     {
-        if (! EEM_Base::$loader instanceof LoaderInterface) {
+        if ( ! EEM_Base::$loader instanceof LoaderInterface) {
             EEM_Base::$loader = LoaderFactory::getLoader();
         }
         return EEM_Base::$loader;
@@ -833,15 +833,15 @@ 
      */
     public function status_array($translated = false)
     {
-        if (! array_key_exists('Status', $this->_model_relations)) {
+        if ( ! array_key_exists('Status', $this->_model_relations)) {
             return [];
         }
         $model_name   = $this->get_this_model_name();
         $status_type  = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
-        $statuses      = EEM_Status::instance()->get_all([['STS_type' => $status_type]]);
+        $statuses = EEM_Status::instance()->get_all([['STS_type' => $status_type]]);
         $status_array = [];
         foreach ($statuses as $status) {
-            $status_array[ $status->ID() ] = $status->get('STS_code');
+            $status_array[$status->ID()] = $status->get('STS_code');
         }
         return $translated
             ? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
@@ -904,7 +904,7 @@ 
     {
         $wp_user_field_name = $this->wp_user_field_name();
         if ($wp_user_field_name) {
-            $query_params[0][ $wp_user_field_name ] = get_current_user_id();
+            $query_params[0][$wp_user_field_name] = get_current_user_id();
         }
         return $query_params;
     }
@@ -922,17 +922,17 @@ 
     public function wp_user_field_name()
     {
         try {
-            if (! empty($this->_model_chain_to_wp_user)) {
+            if ( ! empty($this->_model_chain_to_wp_user)) {
                 $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
                 $last_model_name              = end($models_to_follow_to_wp_users);
                 $model_with_fk_to_wp_users    = EE_Registry::instance()->load_model($last_model_name);
-                $model_chain_to_wp_user       = $this->_model_chain_to_wp_user . '.';
+                $model_chain_to_wp_user       = $this->_model_chain_to_wp_user.'.';
             } else {
                 $model_with_fk_to_wp_users = $this;
                 $model_chain_to_wp_user    = '';
             }
             $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
+            return $model_chain_to_wp_user.$wp_user_field->get_name();
         } catch (EE_Error $e) {
             return false;
         }
@@ -1008,11 +1008,11 @@ 
         if ($this->_custom_selections instanceof CustomSelects) {
             $custom_expressions = $this->_custom_selections->columnsToSelectExpression();
             $select_expressions .= $select_expressions
-                ? ', ' . $custom_expressions
+                ? ', '.$custom_expressions
                 : $custom_expressions;
         }
 
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
         return $this->_do_wpdb_query('get_results', [$SQL, $output]);
     }
 
@@ -1029,7 +1029,7 @@ 
      */
     protected function getCustomSelection(array $query_params, $columns_to_select = null)
     {
-        if (! isset($query_params['extra_selects']) && $columns_to_select === null) {
+        if ( ! isset($query_params['extra_selects']) && $columns_to_select === null) {
             return null;
         }
         $selects = isset($query_params['extra_selects']) ? $query_params['extra_selects'] : $columns_to_select;
@@ -1078,7 +1078,7 @@ 
         if (is_array($columns_to_select)) {
             $select_sql_array = [];
             foreach ($columns_to_select as $alias => $selection_and_datatype) {
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
+                if ( ! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -1090,7 +1090,7 @@ 
                         )
                     );
                 }
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types, true)) {
+                if ( ! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types, true)) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -1169,12 +1169,12 @@ 
      */
     public function alter_query_params_to_restrict_by_ID($id, $query_params = [])
     {
-        if (! isset($query_params[0])) {
+        if ( ! isset($query_params[0])) {
             $query_params[0] = [];
         }
         $conditions_from_id = $this->parse_index_primary_key_string($id);
         if ($conditions_from_id === null) {
-            $query_params[0][ $this->primary_key_name() ] = $id;
+            $query_params[0][$this->primary_key_name()] = $id;
         } else {
             // no primary key, so the $id must be from the get_index_primary_key_string()
             $query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
@@ -1194,7 +1194,7 @@ 
      */
     public function get_one(array $query_params = [])
     {
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong(
                 'EEM_Base::get_one',
                 sprintf(
@@ -1394,7 +1394,7 @@ 
                 return [];
             }
         }
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong(
                 'EEM_Base::_get_consecutive',
                 sprintf(
@@ -1406,10 +1406,10 @@ 
             $query_params = [];
         }
         // let's add the where query param for consecutive look up.
-        $query_params[0][ $field_to_order_by ] = [$operand, $current_field_value];
+        $query_params[0][$field_to_order_by] = [$operand, $current_field_value];
         $query_params['limit']                 = $limit;
         // set direction
-        $incoming_orderby         = isset($query_params['order_by']) ? (array)$query_params['order_by'] : [];
+        $incoming_orderby         = isset($query_params['order_by']) ? (array) $query_params['order_by'] : [];
         $query_params['order_by'] = $operand === '>'
             ? [$field_to_order_by => 'ASC'] + $incoming_orderby
             : [$field_to_order_by => 'DESC'] + $incoming_orderby;
@@ -1493,7 +1493,7 @@ 
     {
         $field_settings = $this->field_settings_for($field_name);
         // if not a valid EE_Datetime_Field then throw error
-        if (! $field_settings instanceof EE_Datetime_Field) {
+        if ( ! $field_settings instanceof EE_Datetime_Field) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -1650,7 +1650,7 @@ 
      */
     public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
     {
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong(
                 'EEM_Base::update',
                 sprintf(
@@ -1679,7 +1679,7 @@ 
          * @param array    $query_params
          * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
          */
-        $fields_n_values = (array)apply_filters(
+        $fields_n_values = (array) apply_filters(
             'FHEE__EEM_Base__update__fields_n_values',
             $fields_n_values,
             $this,
@@ -1697,10 +1697,10 @@ 
         $wpdb_select_results          = $this->_get_all_wpdb_results($query_params);
         foreach ($wpdb_select_results as $wpdb_result) {
             // type cast stdClass as array
-            $wpdb_result = (array)$wpdb_result;
+            $wpdb_result = (array) $wpdb_result;
             // get the model object's PK, as we'll want this if we need to insert a row into secondary tables
             if ($this->has_primary_key_field()) {
-                $main_table_pk_value = $wpdb_result[ $this->get_primary_key_field()->get_qualified_column() ];
+                $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
             } else {
                 // if there's no primary key, we basically can't support having a 2nd table on the model (we could but it would be lots of work)
                 $main_table_pk_value = null;
@@ -1716,7 +1716,7 @@ 
                     // in this table, right? so insert a row in the current table, using any fields available
                     if (
                     ! (array_key_exists($this_table_pk_column, $wpdb_result)
-                       && $wpdb_result[ $this_table_pk_column ])
+                       && $wpdb_result[$this_table_pk_column])
                     ) {
                         $success = $this->_insert_into_specific_table(
                             $table_obj,
@@ -1724,7 +1724,7 @@ 
                             $main_table_pk_value
                         );
                         // if we died here, report the error
-                        if (! $success) {
+                        if ( ! $success) {
                             return false;
                         }
                     }
@@ -1746,10 +1746,10 @@ 
                 $model_objs_affected_ids     = [];
                 foreach ($models_affected_key_columns as $row) {
                     $combined_index_key                             = $this->get_index_primary_key_string($row);
-                    $model_objs_affected_ids[ $combined_index_key ] = $combined_index_key;
+                    $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
                 }
             }
-            if (! $model_objs_affected_ids) {
+            if ( ! $model_objs_affected_ids) {
                 // wait wait wait- if nothing was affected let's stop here
                 return 0;
             }
@@ -1772,11 +1772,11 @@ 
             }
         }
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
-        $SQL              = "UPDATE " . $model_query_info->get_full_join_sql()
-                            . " SET " . $this->_construct_update_sql($fields_n_values)
+        $SQL              = "UPDATE ".$model_query_info->get_full_join_sql()
+                            . " SET ".$this->_construct_update_sql($fields_n_values)
                             . $model_query_info->get_where_sql();
         // note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
-        $rows_affected    = $this->_do_wpdb_query('query', [$SQL]);
+        $rows_affected = $this->_do_wpdb_query('query', [$SQL]);
         /**
          * Action called after a model update call has been made.
          *
@@ -1787,7 +1787,7 @@ 
          * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
          */
         do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
-        return $rows_affected;// how many supposedly got updated
+        return $rows_affected; // how many supposedly got updated
     }
 
 
@@ -1817,7 +1817,7 @@ 
         }
         $model_query_info   = $this->_create_model_query_info_carrier($query_params);
         $select_expressions = $field->get_qualified_column();
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
         return $this->_do_wpdb_query('get_col', [$SQL]);
     }
 
@@ -1837,7 +1837,7 @@ 
     {
         $query_params['limit'] = 1;
         $col                   = $this->get_col($query_params, $field_to_select);
-        if (! empty($col)) {
+        if ( ! empty($col)) {
             return reset($col);
         }
         return null;
@@ -1867,7 +1867,7 @@ 
             $value_sql       = $prepared_value === null
                 ? 'NULL'
                 : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
+            $cols_n_values[] = $field_obj->get_qualified_column()."=".$value_sql;
         }
         return implode(",", $cols_n_values);
     }
@@ -1997,9 +1997,9 @@ 
         if ($deletion_where_query_part) {
             $model_query_info = $this->_create_model_query_info_carrier($query_params);
             $table_aliases    = implode(', ', array_keys($this->_tables));
-            $SQL              = "DELETE " . $table_aliases
-                                . " FROM " . $model_query_info->get_full_join_sql()
-                                . " WHERE " . $deletion_where_query_part;
+            $SQL              = "DELETE ".$table_aliases
+                                . " FROM ".$model_query_info->get_full_join_sql()
+                                . " WHERE ".$deletion_where_query_part;
             $rows_deleted     = $this->_do_wpdb_query('query', [$SQL]);
         } else {
             $rows_deleted = 0;
@@ -2010,12 +2010,12 @@ 
         if (
             $this->has_primary_key_field()
             && $rows_deleted !== false
-            && isset($columns_and_ids_for_deleting[ $this->get_primary_key_field()->get_qualified_column() ])
+            && isset($columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()])
         ) {
-            $ids_for_removal = $columns_and_ids_for_deleting[ $this->get_primary_key_field()->get_qualified_column() ];
+            $ids_for_removal = $columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()];
             foreach ($ids_for_removal as $id) {
-                if (isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])) {
-                    unset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]);
+                if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
+                    unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
                 }
             }
 
@@ -2055,7 +2055,7 @@ 
          * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
          */
         do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
-        return $rows_deleted;// how many supposedly got deleted
+        return $rows_deleted; // how many supposedly got deleted
     }
 
 
@@ -2151,15 +2151,15 @@ 
                 if (
                     $allow_blocking
                     && $this->delete_is_blocked_by_related_models(
-                        $item_to_delete[ $primary_table->get_fully_qualified_pk_column() ]
+                        $item_to_delete[$primary_table->get_fully_qualified_pk_column()]
                     )
                 ) {
                     continue;
                 }
                 // primary table deletes
-                if (isset($item_to_delete[ $primary_table->get_fully_qualified_pk_column() ])) {
-                    $ids_to_delete_indexed_by_column[ $primary_table->get_fully_qualified_pk_column() ][] =
-                        $item_to_delete[ $primary_table->get_fully_qualified_pk_column() ];
+                if (isset($item_to_delete[$primary_table->get_fully_qualified_pk_column()])) {
+                    $ids_to_delete_indexed_by_column[$primary_table->get_fully_qualified_pk_column()][] =
+                        $item_to_delete[$primary_table->get_fully_qualified_pk_column()];
                 }
             }
         } elseif (count($this->get_combined_primary_key_fields()) > 1) {
@@ -2168,8 +2168,8 @@ 
                 $ids_to_delete_indexed_by_column_for_row = [];
                 foreach ($fields as $cpk_field) {
                     if ($cpk_field instanceof EE_Model_Field_Base) {
-                        $ids_to_delete_indexed_by_column_for_row[ $cpk_field->get_qualified_column() ] =
-                            $item_to_delete[ $cpk_field->get_qualified_column() ];
+                        $ids_to_delete_indexed_by_column_for_row[$cpk_field->get_qualified_column()] =
+                            $item_to_delete[$cpk_field->get_qualified_column()];
                     }
                 }
                 $ids_to_delete_indexed_by_column[] = $ids_to_delete_indexed_by_column_for_row;
@@ -2209,7 +2209,7 @@ 
             foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
                 // make sure we have unique $ids
                 $ids     = array_unique($ids);
-                $query[] = $column . ' IN(' . implode(',', $ids) . ')';
+                $query[] = $column.' IN('.implode(',', $ids).')';
             }
             $query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
         } elseif (count($this->get_combined_primary_key_fields()) > 1) {
@@ -2217,7 +2217,7 @@ 
             foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
                 $values_for_each_combined_primary_key_for_a_row = [];
                 foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
-                    $values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
+                    $values_for_each_combined_primary_key_for_a_row[] = $column.'='.$id;
                 }
                 $value_and_value_and_value = implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
                 $ways_to_identify_a_row[]  = "({$value_and_value_and_value})";
@@ -2290,10 +2290,10 @@ 
                 $column_to_count = '*';
             }
         }
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
+        $column_to_count = $distinct ? "DISTINCT ".$column_to_count : $column_to_count;
         $SQL             =
-            "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
-        return (int)$this->_do_wpdb_query('get_var', [$SQL]);
+            "SELECT COUNT(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
+        return (int) $this->_do_wpdb_query('get_var', [$SQL]);
     }
 
 
@@ -2316,7 +2316,7 @@ 
             $field_obj = $this->get_primary_key_field();
         }
         $column_to_count = $field_obj->get_qualified_column();
-        $SQL             = "SELECT SUM(" . $column_to_count . ")"
+        $SQL             = "SELECT SUM(".$column_to_count.")"
                            . $this->_construct_2nd_half_of_select_query($model_query_info);
         $return_value    = $this->_do_wpdb_query('get_var', [$SQL]);
         // $data_type       = $field_obj->get_wpdb_data_type();
@@ -2324,7 +2324,7 @@ 
         //     return (float)$return_value;
         // }
         // must be %f
-        return (float)$return_value;
+        return (float) $return_value;
     }
 
 
@@ -2344,7 +2344,7 @@ 
         // if we're in maintenance mode level 2, DON'T run any queries
         // because level 2 indicates the database needs updating and
         // is probably out of sync with the code
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
             throw new EE_Error(
                 esc_html__(
                     'Event Espresso Level 2 Maintenance mode is active. That means EE can not run ANY database queries until the necessary migration scripts have run which will take EE out of maintenance mode level 2. Please inform support of this error.',
@@ -2353,7 +2353,7 @@ 
             );
         }
         global $wpdb;
-        if (! method_exists($wpdb, $wpdb_method)) {
+        if ( ! method_exists($wpdb, $wpdb_method)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -2372,7 +2372,7 @@ 
         $this->show_db_query_if_previously_requested($wpdb->last_query);
         if (WP_DEBUG) {
             $wpdb->show_errors($old_show_errors_value);
-            if (! empty($wpdb->last_error)) {
+            if ( ! empty($wpdb->last_error)) {
                 throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
             }
             if ($result === false) {
@@ -2443,7 +2443,7 @@ 
                     // ummmm... you in trouble
                     return $result;
             }
-            if (! empty($error_message)) {
+            if ( ! empty($error_message)) {
                 EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
                 trigger_error($error_message);
             }
@@ -2522,11 +2522,11 @@ 
      */
     private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
     {
-        return " FROM " . $model_query_info->get_full_join_sql() .
-               $model_query_info->get_where_sql() .
-               $model_query_info->get_group_by_sql() .
-               $model_query_info->get_having_sql() .
-               $model_query_info->get_order_by_sql() .
+        return " FROM ".$model_query_info->get_full_join_sql().
+               $model_query_info->get_where_sql().
+               $model_query_info->get_group_by_sql().
+               $model_query_info->get_having_sql().
+               $model_query_info->get_order_by_sql().
                $model_query_info->get_limit_sql();
     }
 
@@ -2719,12 +2719,12 @@ 
         $related_model = $this->get_related_model_obj($model_name);
         // we're just going to use the query params on the related model's normal get_all query,
         // except add a condition to say to match the current mod
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
         }
         $this_model_name                                                 = $this->get_this_model_name();
         $this_pk_field_name                                              = $this->get_primary_key_field()->get_name();
-        $query_params[0][ $this_model_name . "." . $this_pk_field_name ] = $id_or_obj;
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
         return $related_model->count($query_params, $field_to_count, $distinct);
     }
 
@@ -2745,7 +2745,7 @@ 
     public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
     {
         $related_model = $this->get_related_model_obj($model_name);
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong(
                 'EEM_Base::sum_related',
                 sprintf(
@@ -2758,12 +2758,12 @@ 
         }
         // we're just going to use the query params on the related model's normal get_all query,
         // except add a condition to say to match the current mod
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
         }
         $this_model_name                                                 = $this->get_this_model_name();
         $this_pk_field_name                                              = $this->get_primary_key_field()->get_name();
-        $query_params[0][ $this_model_name . "." . $this_pk_field_name ] = $id_or_obj;
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
         return $related_model->sum($query_params, $field_to_sum);
     }
 
@@ -2815,7 +2815,7 @@ 
                 $field_with_model_name = $field;
             }
         }
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
+        if ( ! isset($field_with_model_name) || ! $field_with_model_name) {
             throw new EE_Error(
                 sprintf(
                     esc_html__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
@@ -2852,7 +2852,7 @@ 
          * @param array    $fields_n_values keys are the fields and values are their new values
          * @param EEM_Base $model           the model used
          */
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
+        $field_n_values = (array) apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
         if ($this->_satisfies_unique_indexes($field_n_values)) {
             $main_table = $this->_get_main_table();
             $new_id     = $this->_insert_into_specific_table($main_table, $field_n_values, false);
@@ -2954,14 +2954,14 @@ 
                 || $this->get_primary_key_field()
                    instanceof
                    EE_Primary_Key_String_Field)
-            && isset($fields_n_values[ $this->primary_key_name() ])
+            && isset($fields_n_values[$this->primary_key_name()])
         ) {
-            $query_params[0]['OR'][ $this->primary_key_name() ] = $fields_n_values[ $this->primary_key_name() ];
+            $query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
         }
         foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
             $uniqueness_where_params                              =
                 array_intersect_key($fields_n_values, $unique_index->fields());
-            $query_params[0]['OR'][ 'AND*' . $unique_index_name ] = $uniqueness_where_params;
+            $query_params[0]['OR']['AND*'.$unique_index_name] = $uniqueness_where_params;
         }
         // if there is nothing to base this search on, then we shouldn't find anything
         if (empty($query_params)) {
@@ -3039,16 +3039,16 @@ 
             $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
             // if the value we want to assign it to is NULL, just don't mention it for the insertion
             if ($prepared_value !== null) {
-                $insertion_col_n_values[ $field_obj->get_table_column() ] = $prepared_value;
+                $insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
                 $format_for_insertion[]                                   = $field_obj->get_wpdb_data_type();
             }
         }
         if ($table instanceof EE_Secondary_Table && $new_id) {
             // its not the main table, so we should have already saved the main table's PK which we just inserted
             // so add the fk to the main table as a column
-            $insertion_col_n_values[ $table->get_fk_on_table() ] = $new_id;
+            $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
             $format_for_insertion[]                              =
-                '%d';// yes right now we're only allowing these foreign keys to be INTs
+                '%d'; // yes right now we're only allowing these foreign keys to be INTs
         }
         // insert the new entry
         $result = $this->_do_wpdb_query(
@@ -3065,7 +3065,7 @@ 
             }
             // it's not an auto-increment primary key, so
             // it must have been supplied
-            return $fields_n_values[ $this->get_primary_key_field()->get_name() ];
+            return $fields_n_values[$this->get_primary_key_field()->get_name()];
         }
         // we can't return a  primary key because there is none. instead return
         // a unique string indicating this model
@@ -3089,14 +3089,14 @@ 
         if (
             ! $field_obj->is_nullable()
             && (
-                ! isset($fields_n_values[ $field_obj->get_name() ])
-                || $fields_n_values[ $field_obj->get_name() ] === null
+                ! isset($fields_n_values[$field_obj->get_name()])
+                || $fields_n_values[$field_obj->get_name()] === null
             )
         ) {
-            $fields_n_values[ $field_obj->get_name() ] = $field_obj->get_default_value();
+            $fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
         }
-        $unprepared_value = isset($fields_n_values[ $field_obj->get_name() ])
-            ? $fields_n_values[ $field_obj->get_name() ]
+        $unprepared_value = isset($fields_n_values[$field_obj->get_name()])
+            ? $fields_n_values[$field_obj->get_name()]
             : null;
         return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
     }
@@ -3197,7 +3197,7 @@ 
      */
     public function get_table_obj_by_alias($table_alias = '')
     {
-        return isset($this->_tables[ $table_alias ]) ? $this->_tables[ $table_alias ] : null;
+        return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
     }
 
 
@@ -3211,7 +3211,7 @@ 
         $other_tables = [];
         foreach ($this->_tables as $table_alias => $table) {
             if ($table instanceof EE_Secondary_Table) {
-                $other_tables[ $table_alias ] = $table;
+                $other_tables[$table_alias] = $table;
             }
         }
         return $other_tables;
@@ -3226,7 +3226,7 @@ 
      */
     public function _get_fields_for_table($table_alias)
     {
-        return $this->_fields[ $table_alias ];
+        return $this->_fields[$table_alias];
     }
 
 
@@ -3255,7 +3255,7 @@ 
                     $query_info_carrier,
                     'group_by'
                 );
-            } elseif (! empty($query_params['group_by'])) {
+            } elseif ( ! empty($query_params['group_by'])) {
                 $this->_extract_related_model_info_from_query_param(
                     $query_params['group_by'],
                     $query_info_carrier,
@@ -3277,7 +3277,7 @@ 
                     $query_info_carrier,
                     'order_by'
                 );
-            } elseif (! empty($query_params['order_by'])) {
+            } elseif ( ! empty($query_params['order_by'])) {
                 $this->_extract_related_model_info_from_query_param(
                     $query_params['order_by'],
                     $query_info_carrier,
@@ -3311,8 +3311,8 @@ 
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
         $query_param_type
     ) {
-        if (! empty($sub_query_params)) {
-            $sub_query_params = (array)$sub_query_params;
+        if ( ! empty($sub_query_params)) {
+            $sub_query_params = (array) $sub_query_params;
             foreach ($sub_query_params as $param => $possibly_array_of_params) {
                 // $param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
                 $this->_extract_related_model_info_from_query_param(
@@ -3327,7 +3327,7 @@ 
                 $query_param_sans_stars =
                     $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
                 if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
-                    if (! is_array($possibly_array_of_params)) {
+                    if ( ! is_array($possibly_array_of_params)) {
                         throw new EE_Error(
                             sprintf(
                                 esc_html__(
@@ -3353,7 +3353,7 @@ 
                     // then $possible_array_of_params looks something like array('<','DTT_sold',true)
                     // indicating that $possible_array_of_params[1] is actually a field name,
                     // from which we should extract query parameters!
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
+                    if ( ! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
                         throw new EE_Error(
                             sprintf(
                                 esc_html__(
@@ -3391,8 +3391,8 @@ 
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
         $query_param_type
     ) {
-        if (! empty($sub_query_params)) {
-            if (! is_array($sub_query_params)) {
+        if ( ! empty($sub_query_params)) {
+            if ( ! is_array($sub_query_params)) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
@@ -3429,7 +3429,7 @@ 
      */
     public function _create_model_query_info_carrier($query_params)
     {
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong(
                 'EEM_Base::_create_model_query_info_carrier',
                 sprintf(
@@ -3462,7 +3462,7 @@ 
             // only include if related to a cpt where no password has been set
             $query_params[0]['OR*nopassword'] = [
                 $where_param_key_for_password       => '',
-                $where_param_key_for_password . '*' => ['IS_NULL'],
+                $where_param_key_for_password.'*' => ['IS_NULL'],
             ];
         }
         $query_object = $this->_extract_related_models_from_query($query_params);
@@ -3516,7 +3516,7 @@ 
         // set limit
         if (array_key_exists('limit', $query_params)) {
             if (is_array($query_params['limit'])) {
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
+                if ( ! isset($query_params['limit'][0], $query_params['limit'][1])) {
                     $e = sprintf(
                         esc_html__(
                             "Invalid DB query. You passed '%s' for the LIMIT, but only the following are valid: an integer, string representing an integer, a string like 'int,int', or an array like array(int,int)",
@@ -3524,12 +3524,12 @@ 
                         ),
                         http_build_query($query_params['limit'])
                     );
-                    throw new EE_Error($e . "|" . $e);
+                    throw new EE_Error($e."|".$e);
                 }
                 // they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
-            } elseif (! empty($query_params['limit'])) {
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit'][0].",".$query_params['limit'][1]);
+            } elseif ( ! empty($query_params['limit'])) {
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit']);
             }
         }
         // set order by
@@ -3561,10 +3561,10 @@ 
                 $order_array = [];
                 foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
                     $order         = $this->_extract_order($order);
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
+                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by).SP.$order;
                 }
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
-            } elseif (! empty($query_params['order_by'])) {
+                $query_object->set_order_by_sql(" ORDER BY ".implode(",", $order_array));
+            } elseif ( ! empty($query_params['order_by'])) {
                 $this->_extract_related_model_info_from_query_param(
                     $query_params['order_by'],
                     $query_object,
@@ -3575,7 +3575,7 @@ 
                     ? $this->_extract_order($query_params['order'])
                     : 'DESC';
                 $query_object->set_order_by_sql(
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
+                    " ORDER BY ".$this->_deduce_column_name_from_query_param($query_params['order_by']).SP.$order
                 );
             }
         }
@@ -3587,7 +3587,7 @@ 
         ) {
             $pk_field = $this->get_primary_key_field();
             $order    = $this->_extract_order($query_params['order']);
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
+            $query_object->set_order_by_sql(" ORDER BY ".$pk_field->get_qualified_column().SP.$order);
         }
         // set group by
         if (array_key_exists('group_by', $query_params)) {
@@ -3597,10 +3597,10 @@ 
                 foreach ($query_params['group_by'] as $field_name_to_group_by) {
                     $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
                 }
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
-            } elseif (! empty($query_params['group_by'])) {
+                $query_object->set_group_by_sql(" GROUP BY ".implode(", ", $group_by_array));
+            } elseif ( ! empty($query_params['group_by'])) {
                 $query_object->set_group_by_sql(
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
+                    " GROUP BY ".$this->_deduce_column_name_from_query_param($query_params['group_by'])
                 );
             }
         }
@@ -3610,7 +3610,7 @@ 
         }
         // now, just verify they didn't pass anything wack
         foreach ($query_params as $query_key => $query_value) {
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
+            if ( ! in_array($query_key, $this->_allowed_query_params, true)) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -3714,7 +3714,7 @@ 
         $where_query_params = []
     ) {
         $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
+        if ( ! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3744,7 +3744,7 @@ 
                 // we don't want to add full or even minimum default where conditions from this model, so just continue
                 continue;
             }
-            $overrides              = $this->_override_defaults_or_make_null_friendly(
+            $overrides = $this->_override_defaults_or_make_null_friendly(
                 $related_model_universal_where_params,
                 $where_query_params,
                 $related_model,
@@ -3853,19 +3853,19 @@ 
     ) {
         $null_friendly_where_conditions = [];
         $none_overridden                = true;
-        $or_condition_key_for_defaults  = 'OR*' . get_class($model);
+        $or_condition_key_for_defaults  = 'OR*'.get_class($model);
         foreach ($default_where_conditions as $key => $val) {
-            if (isset($provided_where_conditions[ $key ])) {
+            if (isset($provided_where_conditions[$key])) {
                 $none_overridden = false;
             } else {
-                $null_friendly_where_conditions[ $or_condition_key_for_defaults ]['AND'][ $key ] = $val;
+                $null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
             }
         }
         if ($none_overridden && $default_where_conditions) {
             if ($model->has_primary_key_field()) {
-                $null_friendly_where_conditions[ $or_condition_key_for_defaults ][ $model_relation_path
+                $null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
                                                                                    . "."
-                                                                                   . $model->primary_key_name() ] =
+                                                                                   . $model->primary_key_name()] =
                     ['IS NULL'];
             }/*else{
                 //@todo NO PK, use other defaults
@@ -3974,7 +3974,7 @@ 
             foreach ($tables as $table_obj) {
                 $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
                                        . $table_obj->get_fully_qualified_pk_column();
-                if (! in_array($qualified_pk_column, $selects)) {
+                if ( ! in_array($qualified_pk_column, $selects)) {
                     $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
                 }
             }
@@ -4126,9 +4126,9 @@ 
         $query_parameter_type
     ) {
         foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
-            if (strpos($possible_join_string, $valid_related_model_name . ".") === 0) {
+            if (strpos($possible_join_string, $valid_related_model_name.".") === 0) {
                 $this->_add_join_to_model($valid_related_model_name, $query_info_carrier, $original_query_param);
-                $possible_join_string = substr($possible_join_string, strlen($valid_related_model_name . "."));
+                $possible_join_string = substr($possible_join_string, strlen($valid_related_model_name."."));
                 if ($possible_join_string === '') {
                     // nothing left to $query_param
                     // we should actually end in a field name, not a model like this!
@@ -4260,7 +4260,7 @@ 
     {
         $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
         if ($SQL) {
-            return " WHERE " . $SQL;
+            return " WHERE ".$SQL;
         }
         return '';
     }
@@ -4278,7 +4278,7 @@ 
     {
         $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
         if ($SQL) {
-            return " HAVING " . $SQL;
+            return " HAVING ".$SQL;
         }
         return '';
     }
@@ -4301,7 +4301,7 @@ 
             $query_param =
                 $this->_remove_stars_and_anything_after_from_condition_query_param_key(
                     $query_param
-                );// str_replace("*",'',$query_param);
+                ); // str_replace("*",'',$query_param);
             if (in_array($query_param, $this->_logic_query_param_keys)) {
                 switch ($query_param) {
                     case 'not':
@@ -4335,7 +4335,7 @@ 
             } else {
                 $field_obj = $this->_deduce_field_from_query_param($query_param);
                 // if it's not a normal field, maybe it's a custom selection?
-                if (! $field_obj) {
+                if ( ! $field_obj) {
                     if ($this->_custom_selections instanceof CustomSelects) {
                         $field_obj = $this->_custom_selections->getDataTypeForAlias($query_param);
                     } else {
@@ -4351,7 +4351,7 @@ 
                     }
                 }
                 $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
-                $where_clauses[]  = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
+                $where_clauses[]  = $this->_deduce_column_name_from_query_param($query_param).SP.$op_and_value_sql;
             }
         }
         return $where_clauses ? implode($glue, $where_clauses) : '';
@@ -4373,7 +4373,7 @@ 
                 $field->get_model_name(),
                 $query_param
             );
-            return $table_alias_prefix . $field->get_qualified_column();
+            return $table_alias_prefix.$field->get_qualified_column();
         }
         if (
             $this->_custom_selections instanceof CustomSelects
@@ -4430,7 +4430,7 @@ 
     {
         if (is_array($op_and_value)) {
             $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
-            if (! $operator) {
+            if ( ! $operator) {
                 $php_array_like_string = [];
                 foreach ($op_and_value as $key => $value) {
                     $php_array_like_string[] = "$key=>$value";
@@ -4452,14 +4452,14 @@ 
         }
         // check to see if the value is actually another field
         if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
+            return $operator.SP.$this->_deduce_column_name_from_query_param($value);
         }
         if (in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
             // in this case, the value should be an array, or at least a comma-separated list
             // it will need to handle a little differently
             $cleaned_value = $this->_construct_in_value($value, $field_obj);
             // note: $cleaned_value has already been run through $wpdb->prepare()
-            return $operator . SP . $cleaned_value;
+            return $operator.SP.$cleaned_value;
         }
         if (in_array($operator, $this->valid_between_style_operators()) && is_array($value)) {
             // the value should be an array with count of two.
@@ -4475,7 +4475,7 @@ 
                 );
             }
             $cleaned_value = $this->_construct_between_value($value, $field_obj);
-            return $operator . SP . $cleaned_value;
+            return $operator.SP.$cleaned_value;
         }
         if (in_array($operator, $this->valid_null_style_operators())) {
             if ($value !== null) {
@@ -4495,10 +4495,10 @@ 
         if (in_array($operator, $this->valid_like_style_operators()) && ! is_array($value)) {
             // if the operator is 'LIKE', we want to allow percent signs (%) and not
             // remove other junk. So just treat it as a string.
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, '%s');
         }
-        if (! in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
+        if ( ! in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, $field_obj);
         }
         if (in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
             throw new EE_Error(
@@ -4512,7 +4512,7 @@ 
                 )
             );
         }
-        if (! in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
+        if ( ! in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -4551,7 +4551,7 @@ 
         foreach ($values as $value) {
             $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
         }
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
+        return $cleaned_values[0]." AND ".$cleaned_values[1];
     }
 
 
@@ -4591,7 +4591,7 @@ 
                                 . $main_table->get_table_name()
                                 . " WHERE FALSE";
         }
-        return "(" . implode(",", $cleaned_values) . ")";
+        return "(".implode(",", $cleaned_values).")";
     }
 
 
@@ -4610,7 +4610,7 @@ 
                 $this->_prepare_value_for_use_in_db($value, $field_obj)
             );
         } //$field_obj should really just be a data type
-        if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
+        if ( ! in_array($field_obj, $this->_valid_wpdb_data_types)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
@@ -4647,12 +4647,12 @@ 
             );
         }
         $number_of_parts       = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
+        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
         $field_name = $last_query_param_part;
         $model_obj  = $number_of_parts === 1
             ? $this
             // $number_of_parts >= 2, the last part is the column name, and there are only 2parts. therefore...
-            : $this->get_related_model_obj($query_param_parts[ $number_of_parts - 2 ]);
+            : $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
         try {
             return $model_obj->field_settings_for($field_name);
         } catch (EE_Error $e) {
@@ -4672,7 +4672,7 @@ 
     public function _get_qualified_column_for_field($field_name)
     {
         $all_fields = $this->field_settings();
-        $field      = isset($all_fields[ $field_name ]) ? $all_fields[ $field_name ] : false;
+        $field      = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
         if ($field) {
             return $field->get_qualified_column();
         }
@@ -4742,10 +4742,10 @@ 
      */
     public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
     {
-        $table_prefix      = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
+        $table_prefix      = str_replace('.', '__', $model_relation_chain).(empty($model_relation_chain) ? '' : '__');
         $qualified_columns = [];
         foreach ($this->field_settings() as $field) {
-            $qualified_columns[] = $table_prefix . $field->get_qualified_column();
+            $qualified_columns[] = $table_prefix.$field->get_qualified_column();
         }
         return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
     }
@@ -4769,11 +4769,11 @@ 
             if ($table_obj instanceof EE_Primary_Table) {
                 $SQL .= $table_alias === $table_obj->get_table_alias()
                     ? $table_obj->get_select_join_limit($limit)
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
+                    : SP.$table_obj->get_table_name()." AS ".$table_obj->get_table_alias().SP;
             } elseif ($table_obj instanceof EE_Secondary_Table) {
                 $SQL .= $table_alias === $table_obj->get_table_alias()
                     ? $table_obj->get_select_join_limit_join($limit)
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
+                    : SP.$table_obj->get_join_sql($table_alias).SP;
             }
         }
         return $SQL;
@@ -4843,7 +4843,7 @@ 
         foreach ($this->field_settings() as $field_obj) {
             // $data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
             /** @var $field_obj EE_Model_Field_Base */
-            $data_types[ $field_obj->get_qualified_column() ] = $field_obj->get_wpdb_data_type();
+            $data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
         }
         return $data_types;
     }
@@ -4858,8 +4858,8 @@ 
      */
     public function get_related_model_obj($model_name)
     {
-        $model_classname = "EEM_" . $model_name;
-        if (! class_exists($model_classname)) {
+        $model_classname = "EEM_".$model_name;
+        if ( ! class_exists($model_classname)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -4871,7 +4871,7 @@ 
                 )
             );
         }
-        return call_user_func($model_classname . "::instance");
+        return call_user_func($model_classname."::instance");
     }
 
 
@@ -4898,7 +4898,7 @@ 
         $belongs_to_relations = [];
         foreach ($this->relation_settings() as $model_name => $relation_obj) {
             if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $belongs_to_relations[ $model_name ] = $relation_obj;
+                $belongs_to_relations[$model_name] = $relation_obj;
             }
         }
         return $belongs_to_relations;
@@ -4915,7 +4915,7 @@ 
     public function related_settings_for($relation_name)
     {
         $relatedModels = $this->relation_settings();
-        if (! array_key_exists($relation_name, $relatedModels)) {
+        if ( ! array_key_exists($relation_name, $relatedModels)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -4928,7 +4928,7 @@ 
                 )
             );
         }
-        return $relatedModels[ $relation_name ];
+        return $relatedModels[$relation_name];
     }
 
 
@@ -4944,7 +4944,7 @@ 
     public function field_settings_for($fieldName, $include_db_only_fields = true)
     {
         $fieldSettings = $this->field_settings($include_db_only_fields);
-        if (! array_key_exists($fieldName, $fieldSettings)) {
+        if ( ! array_key_exists($fieldName, $fieldSettings)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__("There is no field/column '%s' on '%s'", 'event_espresso'),
@@ -4953,7 +4953,7 @@ 
                 )
             );
         }
-        return $fieldSettings[ $fieldName ];
+        return $fieldSettings[$fieldName];
     }
 
 
@@ -4966,7 +4966,7 @@ 
     public function has_field($fieldName)
     {
         $fieldSettings = $this->field_settings(true);
-        if (isset($fieldSettings[ $fieldName ])) {
+        if (isset($fieldSettings[$fieldName])) {
             return true;
         }
         return false;
@@ -4982,7 +4982,7 @@ 
     public function has_relation($relation_name)
     {
         $relations = $this->relation_settings();
-        if (isset($relations[ $relation_name ])) {
+        if (isset($relations[$relation_name])) {
             return true;
         }
         return false;
@@ -5018,7 +5018,7 @@ 
                     break;
                 }
             }
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
+            if ( ! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__("There is no Primary Key defined on model %s", 'event_espresso'),
@@ -5078,17 +5078,17 @@ 
      */
     public function get_foreign_key_to($model_name)
     {
-        if (! isset($this->_cache_foreign_key_to_fields[ $model_name ])) {
+        if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
             foreach ($this->field_settings() as $field) {
                 if (
                     $field instanceof EE_Foreign_Key_Field_Base
                     && in_array($model_name, $field->get_model_names_pointed_to())
                 ) {
-                    $this->_cache_foreign_key_to_fields[ $model_name ] = $field;
+                    $this->_cache_foreign_key_to_fields[$model_name] = $field;
                     break;
                 }
             }
-            if (! isset($this->_cache_foreign_key_to_fields[ $model_name ])) {
+            if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -5101,7 +5101,7 @@ 
                 );
             }
         }
-        return $this->_cache_foreign_key_to_fields[ $model_name ];
+        return $this->_cache_foreign_key_to_fields[$model_name];
     }
 
 
@@ -5117,7 +5117,7 @@ 
     {
         $table_alias_sans_model_relation_chain_prefix =
             EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
-        return $this->_tables[ $table_alias_sans_model_relation_chain_prefix ]->get_table_name();
+        return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
     }
 
 
@@ -5135,7 +5135,7 @@ 
                 $this->_cached_fields = [];
                 foreach ($this->_fields as $fields_corresponding_to_table) {
                     foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
-                        $this->_cached_fields[ $field_name ] = $field_obj;
+                        $this->_cached_fields[$field_name] = $field_obj;
                     }
                 }
             }
@@ -5146,8 +5146,8 @@ 
             foreach ($this->_fields as $fields_corresponding_to_table) {
                 foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
                     /** @var $field_obj EE_Model_Field_Base */
-                    if (! $field_obj->is_db_only_field()) {
-                        $this->_cached_fields_non_db_only[ $field_name ] = $field_obj;
+                    if ( ! $field_obj->is_db_only_field()) {
+                        $this->_cached_fields_non_db_only[$field_name] = $field_obj;
                     }
                 }
             }
@@ -5175,7 +5175,7 @@ 
         $count_if_model_has_no_primary_key = 0;
         $has_primary_key                   = $this->has_primary_key_field();
         $primary_key_field                 = $has_primary_key ? $this->get_primary_key_field() : null;
-        foreach ((array)$rows as $row) {
+        foreach ((array) $rows as $row) {
             if (empty($row)) {
                 // wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
                 return [];
@@ -5188,12 +5188,12 @@ 
                     $primary_key_field->get_qualified_column(),
                     $primary_key_field->get_table_column()
                 );
-                if ($table_pk_value && isset($array_of_objects[ $table_pk_value ])) {
+                if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
                     continue;
                 }
             }
             $classInstance = $this->instantiate_class_from_array_or_object($row);
-            if (! $classInstance) {
+            if ( ! $classInstance) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__('Could not create instance of class %s from row %s', 'event_espresso'),
@@ -5206,7 +5206,7 @@ 
             $classInstance->set_timezone($this->get_timezone(), true);
             // make sure if there is any timezone setting present that we set the timezone for the object
             $key                      = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
-            $array_of_objects[ $key ] = $classInstance;
+            $array_of_objects[$key] = $classInstance;
             // also, for all the relations of type BelongsTo, see if we can cache
             // those related models
             // (we could do this for other relations too, but if there are conditions
@@ -5250,9 +5250,9 @@ 
         $results = [];
         if ($this->_custom_selections instanceof CustomSelects) {
             foreach ($this->_custom_selections->columnAliases() as $alias) {
-                if (isset($db_results_row[ $alias ])) {
-                    $results[ $alias ] = $this->convertValueToDataType(
-                        $db_results_row[ $alias ],
+                if (isset($db_results_row[$alias])) {
+                    $results[$alias] = $this->convertValueToDataType(
+                        $db_results_row[$alias],
                         $this->_custom_selections->getDataTypeForAlias($alias)
                     );
                 }
@@ -5273,11 +5273,11 @@ 
     {
         switch ($datatype) {
             case '%f':
-                return (float)$value;
+                return (float) $value;
             case '%d':
-                return (int)$value;
+                return (int) $value;
             default:
-                return (string)$value;
+                return (string) $value;
         }
     }
 
@@ -5297,7 +5297,7 @@ 
         $this_model_fields_and_values = [];
         // setup the row using default values;
         foreach ($this->field_settings() as $field_name => $field_obj) {
-            $this_model_fields_and_values[ $field_name ] = $field_obj->get_default_value();
+            $this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
         }
         $className = $this->_get_class_name();
         return EE_Registry::instance()->load_class(
@@ -5318,20 +5318,20 @@ 
      */
     public function instantiate_class_from_array_or_object($cols_n_values)
     {
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
+        if ( ! is_array($cols_n_values) && is_object($cols_n_values)) {
             $cols_n_values = get_object_vars($cols_n_values);
         }
         $primary_key = null;
         // make sure the array only has keys that are fields/columns on this model
         $this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
-        if ($this->has_primary_key_field() && isset($this_model_fields_n_values[ $this->primary_key_name() ])) {
-            $primary_key = $this_model_fields_n_values[ $this->primary_key_name() ];
+        if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
+            $primary_key = $this_model_fields_n_values[$this->primary_key_name()];
         }
         $className = $this->_get_class_name();
         // check we actually found results that we can use to build our model object
         // if not, return null
         if ($this->has_primary_key_field()) {
-            if (empty($this_model_fields_n_values[ $this->primary_key_name() ])) {
+            if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
                 return null;
             }
         } elseif ($this->unique_indexes()) {
@@ -5343,7 +5343,7 @@ 
         // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
         if ($primary_key) {
             $classInstance = $this->get_from_entity_map($primary_key);
-            if (! $classInstance) {
+            if ( ! $classInstance) {
                 $classInstance = EE_Registry::instance()->load_class(
                     $className,
                     [$this_model_fields_n_values, $this->get_timezone()],
@@ -5373,8 +5373,8 @@ 
      */
     public function get_from_entity_map($id)
     {
-        return isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])
-            ? $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]
+        return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
+            ? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id]
             : null;
     }
 
@@ -5397,7 +5397,7 @@ 
     public function add_to_entity_map(EE_Base_Class $object)
     {
         $className = $this->_get_class_name();
-        if (! $object instanceof $className) {
+        if ( ! $object instanceof $className) {
             throw new EE_Error(
                 sprintf(
                     esc_html__("You tried adding a %s to a mapping of %ss", "event_espresso"),
@@ -5406,7 +5406,7 @@ 
                 )
             );
         }
-        if (! $object->ID()) {
+        if ( ! $object->ID()) {
             throw new DomainException(
                 sprintf(
                     esc_html__(
@@ -5422,7 +5422,7 @@ 
         if ($classInstance) {
             return $classInstance;
         }
-        $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $object->ID() ] = $object;
+        $this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
         return $object;
     }
 
@@ -5437,11 +5437,11 @@ 
     public function clear_entity_map($id = null)
     {
         if (empty($id)) {
-            $this->_entity_map[ EEM_Base::$_model_query_blog_id ] = [];
+            $this->_entity_map[EEM_Base::$_model_query_blog_id] = [];
             return true;
         }
-        if (isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])) {
-            unset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]);
+        if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
+            unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
             return true;
         }
         return false;
@@ -5486,18 +5486,18 @@ 
             // there is a primary key on this table and its not set. Use defaults for all its columns
             if ($table_pk_value === null && $table_obj->get_pk_column()) {
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
-                    if (! $field_obj->is_db_only_field()) {
+                    if ( ! $field_obj->is_db_only_field()) {
                         // prepare field as if its coming from db
                         $prepared_value                            =
                             $field_obj->prepare_for_set($field_obj->get_default_value());
-                        $this_model_fields_n_values[ $field_name ] = $field_obj->prepare_for_use_in_db($prepared_value);
+                        $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
                     }
                 }
             } else {
                 // the table's rows existed. Use their values
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
-                    if (! $field_obj->is_db_only_field()) {
-                        $this_model_fields_n_values[ $field_name ] = $this->_get_column_value_with_table_alias_or_not(
+                    if ( ! $field_obj->is_db_only_field()) {
+                        $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
                             $cols_n_values,
                             $field_obj->get_qualified_column(),
                             $field_obj->get_table_column()
@@ -5524,17 +5524,17 @@ 
         // ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
         // does the field on the model relate to this column retrieved from the db?
         // or is it a db-only field? (not relating to the model)
-        if (isset($cols_n_values[ $qualified_column ])) {
-            $value = $cols_n_values[ $qualified_column ];
-        } elseif (isset($cols_n_values[ $regular_column ])) {
-            $value = $cols_n_values[ $regular_column ];
-        } elseif (! empty($this->foreign_key_aliases)) {
+        if (isset($cols_n_values[$qualified_column])) {
+            $value = $cols_n_values[$qualified_column];
+        } elseif (isset($cols_n_values[$regular_column])) {
+            $value = $cols_n_values[$regular_column];
+        } elseif ( ! empty($this->foreign_key_aliases)) {
             // no PK?  ok check if there is a foreign key alias set for this table
             // then check if that alias exists in the incoming data
             // AND that the actual PK the $FK_alias represents matches the $qualified_column (full PK)
             foreach ($this->foreign_key_aliases as $FK_alias => $PK_column) {
-                if ($PK_column === $qualified_column && isset($cols_n_values[ $FK_alias ])) {
-                    $value = $cols_n_values[ $FK_alias ];
+                if ($PK_column === $qualified_column && isset($cols_n_values[$FK_alias])) {
+                    $value = $cols_n_values[$FK_alias];
                     [$pk_class] = explode('.', $PK_column);
                     $pk_model_name = "EEM_{$pk_class}";
                     /** @var EEM_Base $pk_model */
@@ -5578,7 +5578,7 @@ 
                     $obj_in_map->clear_cache($relation_name, null, true);
                 }
             }
-            $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ] = $obj_in_map;
+            $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
             return $obj_in_map;
         }
         return $this->get_one_by_ID($id);
@@ -5630,7 +5630,7 @@ 
      */
     private function _get_class_name()
     {
-        return "EE_" . $this->get_this_model_name();
+        return "EE_".$this->get_this_model_name();
     }
 
 
@@ -5644,7 +5644,7 @@ 
      */
     public function item_name($quantity = 1)
     {
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
+        return (int) $quantity === 1 ? $this->singular_item : $this->plural_item;
     }
 
 
@@ -5676,7 +5676,7 @@ 
     {
         $className = get_class($this);
         $tagName   = "FHEE__{$className}__{$methodName}";
-        if (! has_filter($tagName)) {
+        if ( ! has_filter($tagName)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -5845,7 +5845,7 @@ 
         $unique_indexes = [];
         foreach ($this->_indexes as $name => $index) {
             if ($index instanceof EE_Unique_Index) {
-                $unique_indexes [ $name ] = $index;
+                $unique_indexes [$name] = $index;
             }
         }
         return $unique_indexes;
@@ -5909,7 +5909,7 @@ 
         $key_values_in_combined_pk = [];
         parse_str($index_primary_key_string, $key_values_in_combined_pk);
         foreach ($key_fields as $key_field_name => $field_obj) {
-            if (! isset($key_values_in_combined_pk[ $key_field_name ])) {
+            if ( ! isset($key_values_in_combined_pk[$key_field_name])) {
                 return null;
             }
         }
@@ -5929,7 +5929,7 @@ 
     {
         $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
         foreach ($keys_it_should_have as $key) {
-            if (! isset($key_values[ $key ])) {
+            if ( ! isset($key_values[$key])) {
                 return false;
             }
         }
@@ -5968,8 +5968,8 @@ 
         }
         // even copies obviously won't have the same ID, so remove the primary key
         // from the WHERE conditions for finding copies (if there is a primary key, of course)
-        if ($this->has_primary_key_field() && isset($attributes_array[ $this->primary_key_name() ])) {
-            unset($attributes_array[ $this->primary_key_name() ]);
+        if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
+            unset($attributes_array[$this->primary_key_name()]);
         }
         if (isset($query_params[0])) {
             $query_params[0] = array_merge($attributes_array, $query_params);
@@ -5991,7 +5991,7 @@ 
      */
     public function get_one_copy($model_object_or_attributes_array, $query_params = [])
     {
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong(
                 'EEM_Base::get_one_copy',
                 sprintf(
@@ -6041,7 +6041,7 @@ 
     private function _prepare_operator_for_sql($operator_supplied)
     {
         $sql_operator =
-            isset($this->_valid_operators[ $operator_supplied ]) ? $this->_valid_operators[ $operator_supplied ]
+            isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
                 : null;
         if ($sql_operator) {
             return $sql_operator;
@@ -6140,7 +6140,7 @@ 
         $objs  = $this->get_all($query_params);
         $names = [];
         foreach ($objs as $obj) {
-            $names[ $obj->ID() ] = $obj->name();
+            $names[$obj->ID()] = $obj->name();
         }
         return $names;
     }
@@ -6160,7 +6160,7 @@ 
      */
     public function get_IDs($model_objects, $filter_out_empty_ids = false)
     {
-        if (! $this->has_primary_key_field()) {
+        if ( ! $this->has_primary_key_field()) {
             if (WP_DEBUG) {
                 EE_Error::add_error(
                     esc_html__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
@@ -6173,7 +6173,7 @@ 
         $IDs = [];
         foreach ($model_objects as $model_object) {
             $id = $model_object->ID();
-            if (! $id) {
+            if ( ! $id) {
                 if ($filter_out_empty_ids) {
                     continue;
                 }
@@ -6223,22 +6223,22 @@ 
         EEM_Base::verify_is_valid_cap_context($context);
         // check if we ought to run the restriction generator first
         if (
-            isset($this->_cap_restriction_generators[ $context ])
-            && $this->_cap_restriction_generators[ $context ] instanceof EE_Restriction_Generator_Base
-            && ! $this->_cap_restriction_generators[ $context ]->has_generated_cap_restrictions()
+            isset($this->_cap_restriction_generators[$context])
+            && $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
+            && ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
         ) {
-            $this->_cap_restrictions[ $context ] = array_merge(
-                $this->_cap_restrictions[ $context ],
-                $this->_cap_restriction_generators[ $context ]->generate_restrictions()
+            $this->_cap_restrictions[$context] = array_merge(
+                $this->_cap_restrictions[$context],
+                $this->_cap_restriction_generators[$context]->generate_restrictions()
             );
         }
         // and make sure we've finalized the construction of each restriction
-        foreach ($this->_cap_restrictions[ $context ] as $where_conditions_obj) {
+        foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
             if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
                 $where_conditions_obj->_finalize_construct($this);
             }
         }
-        return $this->_cap_restrictions[ $context ];
+        return $this->_cap_restrictions[$context];
     }
 
 
@@ -6268,9 +6268,9 @@ 
         foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
             if (
             ! EE_Capabilities::instance()
-                             ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
+                             ->current_user_can($cap, $this->get_this_model_name().'_model_applying_caps')
             ) {
-                $missing_caps[ $cap ] = $restriction_if_no_cap;
+                $missing_caps[$cap] = $restriction_if_no_cap;
             }
         }
         return $missing_caps;
@@ -6303,8 +6303,8 @@ 
     public function cap_action_for_context($context)
     {
         $mapping = $this->cap_contexts_to_cap_action_map();
-        if (isset($mapping[ $context ])) {
-            return $mapping[ $context ];
+        if (isset($mapping[$context])) {
+            return $mapping[$context];
         }
         if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
             return $action;
@@ -6422,7 +6422,7 @@ 
         foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
             if (
                 $query_param_key === $logic_query_param_key
-                || strpos($query_param_key, $logic_query_param_key . '*') === 0
+                || strpos($query_param_key, $logic_query_param_key.'*') === 0
             ) {
                 return true;
             }
@@ -6480,7 +6480,7 @@ 
         if ($password_field instanceof EE_Password_Field) {
             $field_names = $password_field->protectedFields();
             foreach ($field_names as $field_name) {
-                $fields[ $field_name ] = $this->field_settings_for($field_name);
+                $fields[$field_name] = $this->field_settings_for($field_name);
             }
         }
         return $fields;
@@ -6506,7 +6506,7 @@ 
         if ($model_obj_or_fields_n_values instanceof EE_Base_Class) {
             $model_obj_or_fields_n_values = $model_obj_or_fields_n_values->model_field_array();
         }
-        if (! is_array($model_obj_or_fields_n_values)) {
+        if ( ! is_array($model_obj_or_fields_n_values)) {
             throw new UnexpectedEntityException(
                 $model_obj_or_fields_n_values,
                 'EE_Base_Class',
@@ -6586,7 +6586,7 @@ 
                 )
             );
         }
-        return ($this->model_chain_to_password ? $this->model_chain_to_password . '.' : '') . $password_field_name;
+        return ($this->model_chain_to_password ? $this->model_chain_to_password.'.' : '').$password_field_name;
     }
 
 

core/db_models/relations/EE_Model_Relation_Base.php

Doc Comments +4 added lines, -4 removed lines

@@ -149,9 +149,9 @@ 
 
     /**
      * @param        $other_table
-     * @param        $other_table_alias
+     * @param        string $other_table_alias
      * @param        $other_table_column
-     * @param        $this_table_alias
+     * @param        string $this_table_alias
      * @param        $this_table_join_column
      * @param string $extra_join_sql
      * @return string
@@ -225,7 +225,7 @@ 
      * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
      * model objects will only be soft-deleted.
      *
-     * @param EE_Base_Class|int|string $model_object_or_id
+     * @param EE_Base_Class|null $model_object_or_id
      * @param array                    $query_params
      * @return int of how many related models got deleted
      * @throws EE_Error
@@ -259,7 +259,7 @@ 
      * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
      * model objects will only be soft-deleted.
      *
-     * @param EE_Base_Class|int|string $model_object_or_id
+     * @param EE_Base_Class|null $model_object_or_id
      * @param array                    $query_params
      * @return int of how many related models got deleted
      * @throws EE_Error

Indentation +507 added lines, -507 removed lines

@@ -16,512 +16,512 @@
  */
 abstract class EE_Model_Relation_Base implements HasSchemaInterface
 {
-    /**
-     * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
-     *
-     * @var string eg Event, Question_Group, Registration
-     */
-    private $_this_model_name;
-    /**
-     * The model name pointed to by this relation (ie, the model we want to establish a relationship to)
-     *
-     * @var string eg Event, Question_Group, Registration
-     */
-    private $_other_model_name;
-
-    /**
-     * this is typically used when calling the relation models to make sure they inherit any set timezone from the
-     * initiating model.
-     *
-     * @var string
-     */
-    protected $_timezone;
-
-    /**
-     * If you try to delete "this_model", and there are related "other_models",
-     * and this isn't null, then abandon the deletion and add this warning.
-     * This effectively makes it impossible to delete "this_model" while there are
-     * related "other_models" along this relation.
-     *
-     * @var string (internationalized)
-     */
-    protected $_blocking_delete_error_message;
-
-    protected $_blocking_delete = false;
-
-    /**
-     * Object representing the relationship between two models. This knows how to join the models,
-     * get related models across the relation, and add-and-remove the relationships.
-     *
-     * @param boolean $block_deletes                 if there are related models across this relation, block (prevent
-     *                                               and add an error) the deletion of this model
-     * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct($block_deletes, $blocking_delete_error_message)
-    {
-        $this->_blocking_delete               = $block_deletes;
-        $this->_blocking_delete_error_message = $blocking_delete_error_message;
-    }
-
-
-    /**
-     * @param $this_model_name
-     * @param $other_model_name
-     * @throws EE_Error
-     */
-    public function _construct_finalize_set_models($this_model_name, $other_model_name)
-    {
-        $this->_this_model_name  = $this_model_name;
-        $this->_other_model_name = $other_model_name;
-        if (is_string($this->_blocking_delete)) {
-            throw new EE_Error(sprintf(
-                esc_html__(
-                    "When instantiating the relation of type %s from %s to %s, the \$block_deletes argument should be a boolean, not a string (%s)",
-                    "event_espresso"
-                ),
-                get_class($this),
-                $this_model_name,
-                $other_model_name,
-                $this->_blocking_delete
-            ));
-        }
-    }
-
-
-    /**
-     * Gets the model where this relation is defined.
-     *
-     * @return EEM_Base
-     */
-    public function get_this_model()
-    {
-        return $this->_get_model($this->_this_model_name);
-    }
-
-
-    /**
-     * Gets the model which this relation establishes the relation TO (ie,
-     * this relation object was defined on get_this_model(), get_other_model() is the other one)
-     *
-     * @return EEM_Base
-     */
-    public function get_other_model()
-    {
-        return $this->_get_model($this->_other_model_name);
-    }
-
-
-    /**
-     * Internally used by get_this_model() and get_other_model()
-     *
-     * @param string $model_name like Event, Question_Group, etc. omit the EEM_
-     * @return EEM_Base
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_model($model_name)
-    {
-        $modelInstance = EE_Registry::instance()->load_model($model_name);
-        // if the timezone is NOT set on the model but IS set for this relation
-        // (which seems really unlikely to ever happen, but whatever)
-        // make sure the model timezone is set
-        if ($this->_timezone && ! $modelInstance->get_timezone()) {
-            $modelInstance->set_timezone($this->_timezone);
-        }
-        return $modelInstance;
-    }
-
-
-    /**
-     * entirely possible that relations may be called from a model and we need to make sure those relations have their
-     * timezone set correctly.
-     *
-     * @param string $timezone timezone to set.
-     */
-    public function set_timezone($timezone)
-    {
-        if (! empty($timezone)) {
-            $this->_timezone = $timezone;
-        }
-    }
-
-
-    /**
-     * @param        $other_table
-     * @param        $other_table_alias
-     * @param        $other_table_column
-     * @param        $this_table_alias
-     * @param        $this_table_join_column
-     * @param string $extra_join_sql
-     * @return string
-     */
-    protected function _left_join(
-        $other_table,
-        $other_table_alias,
-        $other_table_column,
-        $this_table_alias,
-        $this_table_join_column,
-        $extra_join_sql = ''
-    ) {
-        return " LEFT JOIN " . $other_table . " AS " . $other_table_alias . " ON " . $other_table_alias . "." . $other_table_column . "=" . $this_table_alias . "." . $this_table_join_column . ($extra_join_sql ? " AND $extra_join_sql" : '');
-    }
-
-
-    /**
-     * Gets all the model objects of type of other model related to $model_object,
-     * according to this relation. This is the same code for EE_HABTM_Relation and EE_Has_Many_Relation.
-     * For both of those child classes, $model_object must be saved so that it has an ID before querying,
-     * otherwise an error will be thrown. Note: by default we disable default_where_conditions
-     * EE_Belongs_To_Relation doesn't need to be saved before querying.
-     *
-     * @param EE_Base_Class|int $model_object_or_id                      or the primary key of this model
-     * @param array             $query_params                            @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param boolean           $values_already_prepared_by_model_object @deprecated since 4.8.1
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_related(
-        $model_object_or_id,
-        $query_params = array(),
-        $values_already_prepared_by_model_object = false
-    ) {
-        if ($values_already_prepared_by_model_object !== false) {
-            EE_Error::doing_it_wrong(
-                'EE_Model_Relation_Base::get_all_related',
-                esc_html__('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'),
-                '4.8.1'
-            );
-        }
-        $query_params                                      = $this->_disable_default_where_conditions_on_query_param($query_params);
-        $query_param_where_this_model_pk                   = $this->get_this_model()->get_this_model_name()
-                                                             . "."
-                                                             . $this->get_this_model()->get_primary_key_field()->get_name();
-        $model_object_id                                   = $this->_get_model_object_id($model_object_or_id);
-        $query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
-        return $this->get_other_model()->get_all($query_params);
-    }
-
-
-    /**
-     * Alters the $query_params to disable default where conditions, unless otherwise specified
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _disable_default_where_conditions_on_query_param($query_params)
-    {
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * Deletes the related model objects which meet the query parameters. If no
-     * parameters are specified, then all related model objects will be deleted.
-     * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
-     * model objects will only be soft-deleted.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id
-     * @param array                    $query_params
-     * @return int of how many related models got deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_all_related($model_object_or_id, $query_params = array())
-    {
-        // for each thing we would delete,
-        $related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
-        // determine if it's blocked by anything else before it can be deleted
-        $deleted_count = 0;
-        foreach ($related_model_objects as $related_model_object) {
-            $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
-                $related_model_object,
-                $model_object_or_id
-            );
-            /* @var $model_object_or_id EE_Base_Class */
-            if (! $delete_is_blocked) {
-                $this->remove_relation_to($model_object_or_id, $related_model_object);
-                $related_model_object->delete();
-                $deleted_count++;
-            }
-        }
-        return $deleted_count;
-    }
-
-
-    /**
-     * Deletes the related model objects which meet the query parameters. If no
-     * parameters are specified, then all related model objects will be deleted.
-     * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
-     * model objects will only be soft-deleted.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id
-     * @param array                    $query_params
-     * @return int of how many related models got deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_related_permanently($model_object_or_id, $query_params = array())
-    {
-        // for each thing we would delete,
-        $related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
-        // determine if it's blocked by anything else before it can be deleted
-        $deleted_count = 0;
-        foreach ($related_model_objects as $related_model_object) {
-            $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
-                $related_model_object,
-                $model_object_or_id
-            );
-            /* @var $model_object_or_id EE_Base_Class */
-            if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
-                $this->remove_relation_to($model_object_or_id, $related_model_object);
-                $deleted_count++;
-                if (! $delete_is_blocked) {
-                    $related_model_object->delete_permanently();
-                } else {
-                    // delete is blocked
-                    // brent and darren, in this case, wanted to just soft delete it then
-                    $related_model_object->delete();
-                }
-            } else {
-                // its not a soft-deletable thing anyways. do the normal logic.
-                if (! $delete_is_blocked) {
-                    $this->remove_relation_to($model_object_or_id, $related_model_object);
-                    $related_model_object->delete();
-                    $deleted_count++;
-                }
-            }
-        }
-        return $deleted_count;
-    }
-
-
-    /**
-     * this just returns a model_object_id for incoming item that could be an object or id.
-     *
-     * @param  EE_Base_Class|int $model_object_or_id model object or the primary key of this model
-     * @throws EE_Error
-     * @return int
-     */
-    protected function _get_model_object_id($model_object_or_id)
-    {
-        $model_object_id = $model_object_or_id;
-        if ($model_object_or_id instanceof EE_Base_Class) {
-            $model_object_id = $model_object_or_id->ID();
-        }
-        if (! $model_object_id) {
-            throw new EE_Error(sprintf(
-                esc_html__(
-                    "Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",
-                    "event_espresso"
-                ),
-                $this->get_other_model()->get_this_model_name(),
-                $this->get_this_model()->get_this_model_name()
-            ));
-        }
-        return $model_object_id;
-    }
-
-
-    /**
-     * Gets the SQL string for performing the join between this model and the other model.
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
-     *                other_model_primary_table.fk" etc
-     */
-    abstract public function get_join_statement($model_relation_chain);
-
-
-    /**
-     * Adds a relationships between the two model objects provided. Each type of relationship handles this differently
-     * (EE_Belongs_To is a slight exception, it should more accurately be called set_relation_to(...), as this
-     * relationship only allows this model to be related to a single other model of this type)
-     *
-     * @param       $this_obj_or_id
-     * @param       $other_obj_or_id
-     * @param array $extra_join_model_fields_n_values
-     * @return \EE_Base_Class the EE_Base_Class which was added as a relation. (Convenient if you only pass an ID for
-     *                        $other_obj_or_id)
-     */
-    abstract public function add_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        $extra_join_model_fields_n_values = array()
-    );
-
-
-    /**
-     * Similar to 'add_relation_to(...)', performs the opposite action of removing the relationship between the two
-     * model objects
-     *
-     * @param       $this_obj_or_id
-     * @param       $other_obj_or_id
-     * @param array $where_query
-     * @return bool
-     */
-    abstract public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array());
-
-
-    /**
-     * Removes ALL relation instances for this relation obj
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param array             $where_query_param @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 \EE_Error
-     */
-    public function remove_relations($this_obj_or_id, $where_query_param = array())
-    {
-        $related_things = $this->get_all_related($this_obj_or_id, array($where_query_param));
-        $objs_removed   = array();
-        foreach ($related_things as $related_thing) {
-            $objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
-        }
-        return $objs_removed;
-    }
-
-
-    /**
-     * If you aren't allowed to delete this model when there are related models across this
-     * relation object, return true. Otherwise, if you can delete this model even though
-     * related objects exist, returns false.
-     *
-     * @return boolean
-     */
-    public function block_delete_if_related_models_exist()
-    {
-        return $this->_blocking_delete;
-    }
-
-
-    /**
-     * Gets the error message to show
-     *
-     * @return string
-     */
-    public function get_deletion_error_message()
-    {
-        if ($this->_blocking_delete_error_message) {
-            return $this->_blocking_delete_error_message;
-        } else {
+	/**
+	 * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
+	 *
+	 * @var string eg Event, Question_Group, Registration
+	 */
+	private $_this_model_name;
+	/**
+	 * The model name pointed to by this relation (ie, the model we want to establish a relationship to)
+	 *
+	 * @var string eg Event, Question_Group, Registration
+	 */
+	private $_other_model_name;
+
+	/**
+	 * this is typically used when calling the relation models to make sure they inherit any set timezone from the
+	 * initiating model.
+	 *
+	 * @var string
+	 */
+	protected $_timezone;
+
+	/**
+	 * If you try to delete "this_model", and there are related "other_models",
+	 * and this isn't null, then abandon the deletion and add this warning.
+	 * This effectively makes it impossible to delete "this_model" while there are
+	 * related "other_models" along this relation.
+	 *
+	 * @var string (internationalized)
+	 */
+	protected $_blocking_delete_error_message;
+
+	protected $_blocking_delete = false;
+
+	/**
+	 * Object representing the relationship between two models. This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param boolean $block_deletes                 if there are related models across this relation, block (prevent
+	 *                                               and add an error) the deletion of this model
+	 * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct($block_deletes, $blocking_delete_error_message)
+	{
+		$this->_blocking_delete               = $block_deletes;
+		$this->_blocking_delete_error_message = $blocking_delete_error_message;
+	}
+
+
+	/**
+	 * @param $this_model_name
+	 * @param $other_model_name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize_set_models($this_model_name, $other_model_name)
+	{
+		$this->_this_model_name  = $this_model_name;
+		$this->_other_model_name = $other_model_name;
+		if (is_string($this->_blocking_delete)) {
+			throw new EE_Error(sprintf(
+				esc_html__(
+					"When instantiating the relation of type %s from %s to %s, the \$block_deletes argument should be a boolean, not a string (%s)",
+					"event_espresso"
+				),
+				get_class($this),
+				$this_model_name,
+				$other_model_name,
+				$this->_blocking_delete
+			));
+		}
+	}
+
+
+	/**
+	 * Gets the model where this relation is defined.
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_this_model()
+	{
+		return $this->_get_model($this->_this_model_name);
+	}
+
+
+	/**
+	 * Gets the model which this relation establishes the relation TO (ie,
+	 * this relation object was defined on get_this_model(), get_other_model() is the other one)
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_other_model()
+	{
+		return $this->_get_model($this->_other_model_name);
+	}
+
+
+	/**
+	 * Internally used by get_this_model() and get_other_model()
+	 *
+	 * @param string $model_name like Event, Question_Group, etc. omit the EEM_
+	 * @return EEM_Base
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_model($model_name)
+	{
+		$modelInstance = EE_Registry::instance()->load_model($model_name);
+		// if the timezone is NOT set on the model but IS set for this relation
+		// (which seems really unlikely to ever happen, but whatever)
+		// make sure the model timezone is set
+		if ($this->_timezone && ! $modelInstance->get_timezone()) {
+			$modelInstance->set_timezone($this->_timezone);
+		}
+		return $modelInstance;
+	}
+
+
+	/**
+	 * entirely possible that relations may be called from a model and we need to make sure those relations have their
+	 * timezone set correctly.
+	 *
+	 * @param string $timezone timezone to set.
+	 */
+	public function set_timezone($timezone)
+	{
+		if (! empty($timezone)) {
+			$this->_timezone = $timezone;
+		}
+	}
+
+
+	/**
+	 * @param        $other_table
+	 * @param        $other_table_alias
+	 * @param        $other_table_column
+	 * @param        $this_table_alias
+	 * @param        $this_table_join_column
+	 * @param string $extra_join_sql
+	 * @return string
+	 */
+	protected function _left_join(
+		$other_table,
+		$other_table_alias,
+		$other_table_column,
+		$this_table_alias,
+		$this_table_join_column,
+		$extra_join_sql = ''
+	) {
+		return " LEFT JOIN " . $other_table . " AS " . $other_table_alias . " ON " . $other_table_alias . "." . $other_table_column . "=" . $this_table_alias . "." . $this_table_join_column . ($extra_join_sql ? " AND $extra_join_sql" : '');
+	}
+
+
+	/**
+	 * Gets all the model objects of type of other model related to $model_object,
+	 * according to this relation. This is the same code for EE_HABTM_Relation and EE_Has_Many_Relation.
+	 * For both of those child classes, $model_object must be saved so that it has an ID before querying,
+	 * otherwise an error will be thrown. Note: by default we disable default_where_conditions
+	 * EE_Belongs_To_Relation doesn't need to be saved before querying.
+	 *
+	 * @param EE_Base_Class|int $model_object_or_id                      or the primary key of this model
+	 * @param array             $query_params                            @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param boolean           $values_already_prepared_by_model_object @deprecated since 4.8.1
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_related(
+		$model_object_or_id,
+		$query_params = array(),
+		$values_already_prepared_by_model_object = false
+	) {
+		if ($values_already_prepared_by_model_object !== false) {
+			EE_Error::doing_it_wrong(
+				'EE_Model_Relation_Base::get_all_related',
+				esc_html__('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'),
+				'4.8.1'
+			);
+		}
+		$query_params                                      = $this->_disable_default_where_conditions_on_query_param($query_params);
+		$query_param_where_this_model_pk                   = $this->get_this_model()->get_this_model_name()
+															 . "."
+															 . $this->get_this_model()->get_primary_key_field()->get_name();
+		$model_object_id                                   = $this->_get_model_object_id($model_object_or_id);
+		$query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
+		return $this->get_other_model()->get_all($query_params);
+	}
+
+
+	/**
+	 * Alters the $query_params to disable default where conditions, unless otherwise specified
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _disable_default_where_conditions_on_query_param($query_params)
+	{
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * Deletes the related model objects which meet the query parameters. If no
+	 * parameters are specified, then all related model objects will be deleted.
+	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
+	 * model objects will only be soft-deleted.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param array                    $query_params
+	 * @return int of how many related models got deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_all_related($model_object_or_id, $query_params = array())
+	{
+		// for each thing we would delete,
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
+		// determine if it's blocked by anything else before it can be deleted
+		$deleted_count = 0;
+		foreach ($related_model_objects as $related_model_object) {
+			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
+				$related_model_object,
+				$model_object_or_id
+			);
+			/* @var $model_object_or_id EE_Base_Class */
+			if (! $delete_is_blocked) {
+				$this->remove_relation_to($model_object_or_id, $related_model_object);
+				$related_model_object->delete();
+				$deleted_count++;
+			}
+		}
+		return $deleted_count;
+	}
+
+
+	/**
+	 * Deletes the related model objects which meet the query parameters. If no
+	 * parameters are specified, then all related model objects will be deleted.
+	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
+	 * model objects will only be soft-deleted.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param array                    $query_params
+	 * @return int of how many related models got deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_related_permanently($model_object_or_id, $query_params = array())
+	{
+		// for each thing we would delete,
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
+		// determine if it's blocked by anything else before it can be deleted
+		$deleted_count = 0;
+		foreach ($related_model_objects as $related_model_object) {
+			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
+				$related_model_object,
+				$model_object_or_id
+			);
+			/* @var $model_object_or_id EE_Base_Class */
+			if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
+				$this->remove_relation_to($model_object_or_id, $related_model_object);
+				$deleted_count++;
+				if (! $delete_is_blocked) {
+					$related_model_object->delete_permanently();
+				} else {
+					// delete is blocked
+					// brent and darren, in this case, wanted to just soft delete it then
+					$related_model_object->delete();
+				}
+			} else {
+				// its not a soft-deletable thing anyways. do the normal logic.
+				if (! $delete_is_blocked) {
+					$this->remove_relation_to($model_object_or_id, $related_model_object);
+					$related_model_object->delete();
+					$deleted_count++;
+				}
+			}
+		}
+		return $deleted_count;
+	}
+
+
+	/**
+	 * this just returns a model_object_id for incoming item that could be an object or id.
+	 *
+	 * @param  EE_Base_Class|int $model_object_or_id model object or the primary key of this model
+	 * @throws EE_Error
+	 * @return int
+	 */
+	protected function _get_model_object_id($model_object_or_id)
+	{
+		$model_object_id = $model_object_or_id;
+		if ($model_object_or_id instanceof EE_Base_Class) {
+			$model_object_id = $model_object_or_id->ID();
+		}
+		if (! $model_object_id) {
+			throw new EE_Error(sprintf(
+				esc_html__(
+					"Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",
+					"event_espresso"
+				),
+				$this->get_other_model()->get_this_model_name(),
+				$this->get_this_model()->get_this_model_name()
+			));
+		}
+		return $model_object_id;
+	}
+
+
+	/**
+	 * Gets the SQL string for performing the join between this model and the other model.
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
+	 *                other_model_primary_table.fk" etc
+	 */
+	abstract public function get_join_statement($model_relation_chain);
+
+
+	/**
+	 * Adds a relationships between the two model objects provided. Each type of relationship handles this differently
+	 * (EE_Belongs_To is a slight exception, it should more accurately be called set_relation_to(...), as this
+	 * relationship only allows this model to be related to a single other model of this type)
+	 *
+	 * @param       $this_obj_or_id
+	 * @param       $other_obj_or_id
+	 * @param array $extra_join_model_fields_n_values
+	 * @return \EE_Base_Class the EE_Base_Class which was added as a relation. (Convenient if you only pass an ID for
+	 *                        $other_obj_or_id)
+	 */
+	abstract public function add_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		$extra_join_model_fields_n_values = array()
+	);
+
+
+	/**
+	 * Similar to 'add_relation_to(...)', performs the opposite action of removing the relationship between the two
+	 * model objects
+	 *
+	 * @param       $this_obj_or_id
+	 * @param       $other_obj_or_id
+	 * @param array $where_query
+	 * @return bool
+	 */
+	abstract public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array());
+
+
+	/**
+	 * Removes ALL relation instances for this relation obj
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param array             $where_query_param @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 \EE_Error
+	 */
+	public function remove_relations($this_obj_or_id, $where_query_param = array())
+	{
+		$related_things = $this->get_all_related($this_obj_or_id, array($where_query_param));
+		$objs_removed   = array();
+		foreach ($related_things as $related_thing) {
+			$objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
+		}
+		return $objs_removed;
+	}
+
+
+	/**
+	 * If you aren't allowed to delete this model when there are related models across this
+	 * relation object, return true. Otherwise, if you can delete this model even though
+	 * related objects exist, returns false.
+	 *
+	 * @return boolean
+	 */
+	public function block_delete_if_related_models_exist()
+	{
+		return $this->_blocking_delete;
+	}
+
+
+	/**
+	 * Gets the error message to show
+	 *
+	 * @return string
+	 */
+	public function get_deletion_error_message()
+	{
+		if ($this->_blocking_delete_error_message) {
+			return $this->_blocking_delete_error_message;
+		} else {
 //          return sprintf(__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2));
-            return sprintf(
-                esc_html__(
-                    'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.',
-                    "event_espresso"
-                ),
-                $this->get_this_model()->item_name(1),
-                $this->get_other_model()->item_name(1),
-                $this->get_other_model()->item_name(2)
-            );
-        }
-    }
-
-    /**
-     * Returns whatever is set as the nicename for the object.
-     *
-     * @return string
-     */
-    public function getSchemaDescription()
-    {
-        $description = $this instanceof EE_Belongs_To_Relation
-            ? esc_html__('The related %1$s entity to the %2$s.', 'event_espresso')
-            : esc_html__('The related %1$s entities to the %2$s.', 'event_espresso');
-        return sprintf(
-            $description,
-            $this->get_other_model()->get_this_model_name(),
-            $this->get_this_model()->get_this_model_name()
-        );
-    }
-
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     *
-     * @return string|array
-     */
-    public function getSchemaType()
-    {
-        return $this instanceof EE_Belongs_To_Relation ? 'object' : 'array';
-    }
-
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties()
-    {
-        return array();
-    }
-
-    /**
-     * If a child class has enum values, they should override this method and provide a simple array
-     * of the enum values.
-     * The reason this is not a property on the class is because there may be filterable enum values that
-     * are set on the instantiated object that could be filtered after construct.
-     *
-     * @return array
-     */
-    public function getSchemaEnum()
-    {
-        return array();
-    }
-
-    /**
-     * This returns the value of the $_schema_format property on the object.
-     *
-     * @return string
-     */
-    public function getSchemaFormat()
-    {
-        return array();
-    }
-
-    /**
-     * This returns the value of the $_schema_readonly property on the object.
-     *
-     * @return bool
-     */
-    public function getSchemaReadonly()
-    {
-        return true;
-    }
-
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     */
-    public function getSchema()
-    {
-        $schema = array(
-            'description' => $this->getSchemaDescription(),
-            'type' => $this->getSchemaType(),
-            'relation' => true,
-            'relation_type' => get_class($this),
-            'readonly' => $this->getSchemaReadonly()
-        );
-
-        if ($this instanceof EE_HABTM_Relation) {
-            $schema['joining_model_name'] = $this->get_join_model()->get_this_model_name();
-        }
-
-        if ($this->getSchemaType() === 'array') {
-            $schema['items'] = array(
-                'type' => 'object'
-            );
-        }
-
-        return $schema;
-    }
+			return sprintf(
+				esc_html__(
+					'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.',
+					"event_espresso"
+				),
+				$this->get_this_model()->item_name(1),
+				$this->get_other_model()->item_name(1),
+				$this->get_other_model()->item_name(2)
+			);
+		}
+	}
+
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaDescription()
+	{
+		$description = $this instanceof EE_Belongs_To_Relation
+			? esc_html__('The related %1$s entity to the %2$s.', 'event_espresso')
+			: esc_html__('The related %1$s entities to the %2$s.', 'event_espresso');
+		return sprintf(
+			$description,
+			$this->get_other_model()->get_this_model_name(),
+			$this->get_this_model()->get_this_model_name()
+		);
+	}
+
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 *
+	 * @return string|array
+	 */
+	public function getSchemaType()
+	{
+		return $this instanceof EE_Belongs_To_Relation ? 'object' : 'array';
+	}
+
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties()
+	{
+		return array();
+	}
+
+	/**
+	 * If a child class has enum values, they should override this method and provide a simple array
+	 * of the enum values.
+	 * The reason this is not a property on the class is because there may be filterable enum values that
+	 * are set on the instantiated object that could be filtered after construct.
+	 *
+	 * @return array
+	 */
+	public function getSchemaEnum()
+	{
+		return array();
+	}
+
+	/**
+	 * This returns the value of the $_schema_format property on the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaFormat()
+	{
+		return array();
+	}
+
+	/**
+	 * This returns the value of the $_schema_readonly property on the object.
+	 *
+	 * @return bool
+	 */
+	public function getSchemaReadonly()
+	{
+		return true;
+	}
+
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 */
+	public function getSchema()
+	{
+		$schema = array(
+			'description' => $this->getSchemaDescription(),
+			'type' => $this->getSchemaType(),
+			'relation' => true,
+			'relation_type' => get_class($this),
+			'readonly' => $this->getSchemaReadonly()
+		);
+
+		if ($this instanceof EE_HABTM_Relation) {
+			$schema['joining_model_name'] = $this->get_join_model()->get_this_model_name();
+		}
+
+		if ($this->getSchemaType() === 'array') {
+			$schema['items'] = array(
+				'type' => 'object'
+			);
+		}
+
+		return $schema;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -141,7 +141,7 @@ 
      */
     public function set_timezone($timezone)
     {
-        if (! empty($timezone)) {
+        if ( ! empty($timezone)) {
             $this->_timezone = $timezone;
         }
     }
@@ -164,7 +164,7 @@ 
         $this_table_join_column,
         $extra_join_sql = ''
     ) {
-        return " LEFT JOIN " . $other_table . " AS " . $other_table_alias . " ON " . $other_table_alias . "." . $other_table_column . "=" . $this_table_alias . "." . $this_table_join_column . ($extra_join_sql ? " AND $extra_join_sql" : '');
+        return " LEFT JOIN ".$other_table." AS ".$other_table_alias." ON ".$other_table_alias.".".$other_table_column."=".$this_table_alias.".".$this_table_join_column.($extra_join_sql ? " AND $extra_join_sql" : '');
     }
 
 
@@ -199,7 +199,7 @@ 
                                                              . "."
                                                              . $this->get_this_model()->get_primary_key_field()->get_name();
         $model_object_id                                   = $this->_get_model_object_id($model_object_or_id);
-        $query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
+        $query_params[0][$query_param_where_this_model_pk] = $model_object_id;
         return $this->get_other_model()->get_all($query_params);
     }
 
@@ -212,7 +212,7 @@ 
      */
     protected function _disable_default_where_conditions_on_query_param($query_params)
     {
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = 'none';
         }
         return $query_params;
@@ -243,7 +243,7 @@ 
                 $model_object_or_id
             );
             /* @var $model_object_or_id EE_Base_Class */
-            if (! $delete_is_blocked) {
+            if ( ! $delete_is_blocked) {
                 $this->remove_relation_to($model_object_or_id, $related_model_object);
                 $related_model_object->delete();
                 $deleted_count++;
@@ -280,7 +280,7 @@ 
             if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
                 $this->remove_relation_to($model_object_or_id, $related_model_object);
                 $deleted_count++;
-                if (! $delete_is_blocked) {
+                if ( ! $delete_is_blocked) {
                     $related_model_object->delete_permanently();
                 } else {
                     // delete is blocked
@@ -289,7 +289,7 @@ 
                 }
             } else {
                 // its not a soft-deletable thing anyways. do the normal logic.
-                if (! $delete_is_blocked) {
+                if ( ! $delete_is_blocked) {
                     $this->remove_relation_to($model_object_or_id, $related_model_object);
                     $related_model_object->delete();
                     $deleted_count++;
@@ -313,7 +313,7 @@ 
         if ($model_object_or_id instanceof EE_Base_Class) {
             $model_object_id = $model_object_or_id->ID();
         }
-        if (! $model_object_id) {
+        if ( ! $model_object_id) {
             throw new EE_Error(sprintf(
                 esc_html__(
                     "Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",

core/services/helpers/datetime/PhpCompatLessFiveSixHelper.php

Indentation +213 added lines, -213 removed lines

@@ -19,222 +19,222 @@
 class PhpCompatLessFiveSixHelper extends AbstractHelper
 {
 
-    /**
-     * PhpCompatLessFiveSixHelper constructor.
-     *
-     * @throws DomainException
-     */
-    public function __construct()
-    {
-        if (PHP_VERSION_ID >= 50600) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The %1$s is only usable on php versions less than 5.6.  You\'ll want to use %2$s instead.',
-                        'event_espresso'
-                    ),
-                    __CLASS__,
-                    'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper'
-                )
-            );
-        }
-        parent::__construct();
-    }
+	/**
+	 * PhpCompatLessFiveSixHelper constructor.
+	 *
+	 * @throws DomainException
+	 */
+	public function __construct()
+	{
+		if (PHP_VERSION_ID >= 50600) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The %1$s is only usable on php versions less than 5.6.  You\'ll want to use %2$s instead.',
+						'event_espresso'
+					),
+					__CLASS__,
+					'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper'
+				)
+			);
+		}
+		parent::__construct();
+	}
 
-    /**
-     * Returns a timezone string for the provided gmt_offset.
-     *
-     * @param float|string $gmt_offset
-     * @return string
-     * @throws EE_Error
-     */
-    public function getTimezoneStringFromGmtOffset($gmt_offset = '')
-    {
-        $gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset);
-        if (is_string($gmt_offset_or_timezone_string)) {
-            return $gmt_offset_or_timezone_string;
-        }
-        // well we know its a float, so let's roll with it.
-        $gmt_offset = $gmt_offset_or_timezone_string;
-        // convert GMT offset to seconds
-        $gmt_offset *= HOUR_IN_SECONDS;
-        // although we don't know the TZ abbreviation, we know the UTC offset
-        $timezone_string = timezone_name_from_abbr(null, $gmt_offset);
-        // only use this timezone_string IF it's current offset matches the given offset
-        if (! empty($timezone_string)) {
-            $offset = null;
-            try {
-                $offset = $this->getTimezoneOffset(new DateTimeZone($timezone_string));
-                if ($offset !== $gmt_offset) {
-                    $timezone_string = false;
-                }
-            } catch (Exception $e) {
-                $timezone_string = false;
-            }
-        }
-        // better have a valid timezone string by now, but if not, sigh... loop thru  the timezone_abbreviations_list()
-        // ...
-        $timezone_string = $timezone_string !== false
-            ? $timezone_string
-            : $this->getTimezoneStringFromAbbreviationsList($gmt_offset);
-        return $timezone_string;
-    }
+	/**
+	 * Returns a timezone string for the provided gmt_offset.
+	 *
+	 * @param float|string $gmt_offset
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function getTimezoneStringFromGmtOffset($gmt_offset = '')
+	{
+		$gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset);
+		if (is_string($gmt_offset_or_timezone_string)) {
+			return $gmt_offset_or_timezone_string;
+		}
+		// well we know its a float, so let's roll with it.
+		$gmt_offset = $gmt_offset_or_timezone_string;
+		// convert GMT offset to seconds
+		$gmt_offset *= HOUR_IN_SECONDS;
+		// although we don't know the TZ abbreviation, we know the UTC offset
+		$timezone_string = timezone_name_from_abbr(null, $gmt_offset);
+		// only use this timezone_string IF it's current offset matches the given offset
+		if (! empty($timezone_string)) {
+			$offset = null;
+			try {
+				$offset = $this->getTimezoneOffset(new DateTimeZone($timezone_string));
+				if ($offset !== $gmt_offset) {
+					$timezone_string = false;
+				}
+			} catch (Exception $e) {
+				$timezone_string = false;
+			}
+		}
+		// better have a valid timezone string by now, but if not, sigh... loop thru  the timezone_abbreviations_list()
+		// ...
+		$timezone_string = $timezone_string !== false
+			? $timezone_string
+			: $this->getTimezoneStringFromAbbreviationsList($gmt_offset);
+		return $timezone_string;
+	}
 
 
-    /**
-     * @param int  $gmt_offset
-     * @param bool $coerce If true, we attempt to coerce with our adjustment table
-     * @see self::adjustInvalidGmtOffset
-     * @return string
-     * @throws EE_Error
-     */
-    protected function getTimezoneStringFromAbbreviationsList($gmt_offset = 0, $coerce = true)
-    {
-        $gmt_offset = (int) $gmt_offset;
-        /** @var array[] $abbreviations */
-        $abbreviations = DateTimeZone::listAbbreviations();
-        foreach ($abbreviations as $abbreviation) {
-            foreach ($abbreviation as $timezone) {
-                if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) {
-                    try {
-                        $offset = $this->getTimezoneOffset(new DateTimeZone($timezone['timezone_id']));
-                        if ($offset !== $gmt_offset) {
-                            continue;
-                        }
-                        return $timezone['timezone_id'];
-                    } catch (Exception $e) {
-                        continue;
-                    }
-                }
-            }
-        }
-        // if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
-        if ($coerce === true) {
-            $timezone_string = $this->getTimezoneStringFromAbbreviationsList(
-                $this->adjustInvalidGmtOffsets($gmt_offset),
-                false
-            );
-            if ($timezone_string) {
-                return $timezone_string;
-            }
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
-                    'event_espresso'
-                ),
-                $gmt_offset / HOUR_IN_SECONDS,
-                '<a href="http://www.php.net/manual/en/timezones.php">',
-                '</a>'
-            )
-        );
-    }
+	/**
+	 * @param int  $gmt_offset
+	 * @param bool $coerce If true, we attempt to coerce with our adjustment table
+	 * @see self::adjustInvalidGmtOffset
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function getTimezoneStringFromAbbreviationsList($gmt_offset = 0, $coerce = true)
+	{
+		$gmt_offset = (int) $gmt_offset;
+		/** @var array[] $abbreviations */
+		$abbreviations = DateTimeZone::listAbbreviations();
+		foreach ($abbreviations as $abbreviation) {
+			foreach ($abbreviation as $timezone) {
+				if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) {
+					try {
+						$offset = $this->getTimezoneOffset(new DateTimeZone($timezone['timezone_id']));
+						if ($offset !== $gmt_offset) {
+							continue;
+						}
+						return $timezone['timezone_id'];
+					} catch (Exception $e) {
+						continue;
+					}
+				}
+			}
+		}
+		// if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
+		if ($coerce === true) {
+			$timezone_string = $this->getTimezoneStringFromAbbreviationsList(
+				$this->adjustInvalidGmtOffsets($gmt_offset),
+				false
+			);
+			if ($timezone_string) {
+				return $timezone_string;
+			}
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
+					'event_espresso'
+				),
+				$gmt_offset / HOUR_IN_SECONDS,
+				'<a href="http://www.php.net/manual/en/timezones.php">',
+				'</a>'
+			)
+		);
+	}
 
 
-    /**
-     * Depending on PHP version,
-     * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
-     * To get around that, for these fringe timezones we bump them to a known valid offset.
-     * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
-     *
-     * @param int $gmt_offset
-     * @return int
-     */
-    public function adjustInvalidGmtOffsets($gmt_offset = 0)
-    {
-        // make sure $gmt_offset is int
-        $gmt_offset = (int) $gmt_offset;
-        switch ($gmt_offset) {
-            // -12
-            case -43200:
-                $gmt_offset = -39600;
-                break;
-            // -11.5
-            case -41400:
-                $gmt_offset = -39600;
-                break;
-            // -10.5
-            case -37800:
-                $gmt_offset = -39600;
-                break;
-            // -8.5
-            case -30600:
-                $gmt_offset = -28800;
-                break;
-            // -7.5
-            case -27000:
-                $gmt_offset = -25200;
-                break;
-            // -6.5
-            case -23400:
-                $gmt_offset = -21600;
-                break;
-            // -5.5
-            case -19800:
-                $gmt_offset = -18000;
-                break;
-            // -4.5
-            case -16200:
-                $gmt_offset = -14400;
-                break;
-            // -3.5
-            case -12600:
-                $gmt_offset = -10800;
-                break;
-            // -2.5
-            case -9000:
-                $gmt_offset = -7200;
-                break;
-            // -1.5
-            case -5400:
-                $gmt_offset = -3600;
-                break;
-            // -0.5
-            case -1800:
-                $gmt_offset = 0;
-                break;
-            // .5
-            case 1800:
-                $gmt_offset = 3600;
-                break;
-            // 1.5
-            case 5400:
-                $gmt_offset = 7200;
-                break;
-            // 2.5
-            case 9000:
-                $gmt_offset = 10800;
-                break;
-            // 3.5
-            case 12600:
-                $gmt_offset = 14400;
-                break;
-            // 7.5
-            case 27000:
-                $gmt_offset = 28800;
-                break;
-            // 8.5
-            case 30600:
-                $gmt_offset = 31500;
-                break;
-            // 10.5
-            case 37800:
-                $gmt_offset = 39600;
-                break;
-            // 11.5
-            case 41400:
-                $gmt_offset = 43200;
-                break;
-            // 12.75
-            case 45900:
-                $gmt_offset = 46800;
-                break;
-            // 13.75
-            case 49500:
-                $gmt_offset = 50400;
-                break;
-        }
-        return $gmt_offset;
-    }
+	/**
+	 * Depending on PHP version,
+	 * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
+	 * To get around that, for these fringe timezones we bump them to a known valid offset.
+	 * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
+	 *
+	 * @param int $gmt_offset
+	 * @return int
+	 */
+	public function adjustInvalidGmtOffsets($gmt_offset = 0)
+	{
+		// make sure $gmt_offset is int
+		$gmt_offset = (int) $gmt_offset;
+		switch ($gmt_offset) {
+			// -12
+			case -43200:
+				$gmt_offset = -39600;
+				break;
+			// -11.5
+			case -41400:
+				$gmt_offset = -39600;
+				break;
+			// -10.5
+			case -37800:
+				$gmt_offset = -39600;
+				break;
+			// -8.5
+			case -30600:
+				$gmt_offset = -28800;
+				break;
+			// -7.5
+			case -27000:
+				$gmt_offset = -25200;
+				break;
+			// -6.5
+			case -23400:
+				$gmt_offset = -21600;
+				break;
+			// -5.5
+			case -19800:
+				$gmt_offset = -18000;
+				break;
+			// -4.5
+			case -16200:
+				$gmt_offset = -14400;
+				break;
+			// -3.5
+			case -12600:
+				$gmt_offset = -10800;
+				break;
+			// -2.5
+			case -9000:
+				$gmt_offset = -7200;
+				break;
+			// -1.5
+			case -5400:
+				$gmt_offset = -3600;
+				break;
+			// -0.5
+			case -1800:
+				$gmt_offset = 0;
+				break;
+			// .5
+			case 1800:
+				$gmt_offset = 3600;
+				break;
+			// 1.5
+			case 5400:
+				$gmt_offset = 7200;
+				break;
+			// 2.5
+			case 9000:
+				$gmt_offset = 10800;
+				break;
+			// 3.5
+			case 12600:
+				$gmt_offset = 14400;
+				break;
+			// 7.5
+			case 27000:
+				$gmt_offset = 28800;
+				break;
+			// 8.5
+			case 30600:
+				$gmt_offset = 31500;
+				break;
+			// 10.5
+			case 37800:
+				$gmt_offset = 39600;
+				break;
+			// 11.5
+			case 41400:
+				$gmt_offset = 43200;
+				break;
+			// 12.75
+			case 45900:
+				$gmt_offset = 46800;
+				break;
+			// 13.75
+			case 49500:
+				$gmt_offset = 50400;
+				break;
+		}
+		return $gmt_offset;
+	}
 }

core/services/helpers/datetime/HelperInterface.php

Indentation +91 added lines, -91 removed lines

@@ -16,95 +16,95 @@
 interface HelperInterface
 {
 
-    /**
-     * Ensures that a valid timezone string is returned.
-     *
-     * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
-     *                                 settings (or derive from set UTC offset).
-     * @param bool   $throw_error
-     * @return string
-     */
-    public function getValidTimezoneString($timezone_string = '', $throw_error = false);
-
-
-    /**
-     * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
-     *
-     * @param string $timezone_string
-     * @param bool   $throw_error
-     * @return bool
-     */
-    public function validateTimezone($timezone_string, $throw_error = true);
-
-
-    /**
-     * Returns a timezone string for the provided gmt_offset.
-     * @param float|string $gmt_offset
-     * @return string
-     */
-    public function getTimezoneStringFromGmtOffset($gmt_offset = '');
-
-
-    /**
-     * Gets the site's GMT offset based on either the timezone string
-     * (in which case the gmt offset will vary depending on the location's
-     * observance of daylight savings time) or the gmt_offset wp option
-     *
-     * @return int  seconds offset
-     */
-    public function getSiteTimezoneGmtOffset();
-
-
-    /**
-     * Get timezone transitions
-     * @param DateTimeZone $date_time_zone
-     * @param int|null     $time
-     * @param bool         $first_only
-     * @return array
-     */
-    public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true);
-
-
-    /**
-     * Get Timezone offset for given timezone object
-     * @param DateTimeZone $date_time_zone
-     * @param null|int         $time
-     * @return int
-     */
-    public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null);
-
-
-    /**
-     * Provide a timezone select input
-     * @param string $timezone_string
-     * @return string
-     */
-    public function timezoneSelectInput($timezone_string = '');
-
-
-    /**
-     * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
-     * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
-     * the site is used.
-     * This is used typically when using a Unix timestamp any core WP functions that expect their specially
-     * computed timestamp (i.e. date_i18n() )
-     *
-     * @param int    $unix_timestamp    if 0, then time() will be used.
-     * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
-     *                                site will be used.
-     * @return int      unix_timestamp value with the offset applied for the given timezone.
-     */
-    public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '');
-
-
-    /**
-     * Depending on PHP version,
-     * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
-     * To get around that, for these fringe timezones we bump them to a known valid offset.
-     * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
-     *
-     * @param int $gmt_offset
-     * @return int
-     */
-    public function adjustInvalidGmtOffsets($gmt_offset);
+	/**
+	 * Ensures that a valid timezone string is returned.
+	 *
+	 * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
+	 *                                 settings (or derive from set UTC offset).
+	 * @param bool   $throw_error
+	 * @return string
+	 */
+	public function getValidTimezoneString($timezone_string = '', $throw_error = false);
+
+
+	/**
+	 * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
+	 *
+	 * @param string $timezone_string
+	 * @param bool   $throw_error
+	 * @return bool
+	 */
+	public function validateTimezone($timezone_string, $throw_error = true);
+
+
+	/**
+	 * Returns a timezone string for the provided gmt_offset.
+	 * @param float|string $gmt_offset
+	 * @return string
+	 */
+	public function getTimezoneStringFromGmtOffset($gmt_offset = '');
+
+
+	/**
+	 * Gets the site's GMT offset based on either the timezone string
+	 * (in which case the gmt offset will vary depending on the location's
+	 * observance of daylight savings time) or the gmt_offset wp option
+	 *
+	 * @return int  seconds offset
+	 */
+	public function getSiteTimezoneGmtOffset();
+
+
+	/**
+	 * Get timezone transitions
+	 * @param DateTimeZone $date_time_zone
+	 * @param int|null     $time
+	 * @param bool         $first_only
+	 * @return array
+	 */
+	public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true);
+
+
+	/**
+	 * Get Timezone offset for given timezone object
+	 * @param DateTimeZone $date_time_zone
+	 * @param null|int         $time
+	 * @return int
+	 */
+	public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null);
+
+
+	/**
+	 * Provide a timezone select input
+	 * @param string $timezone_string
+	 * @return string
+	 */
+	public function timezoneSelectInput($timezone_string = '');
+
+
+	/**
+	 * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
+	 * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
+	 * the site is used.
+	 * This is used typically when using a Unix timestamp any core WP functions that expect their specially
+	 * computed timestamp (i.e. date_i18n() )
+	 *
+	 * @param int    $unix_timestamp    if 0, then time() will be used.
+	 * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
+	 *                                site will be used.
+	 * @return int      unix_timestamp value with the offset applied for the given timezone.
+	 */
+	public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '');
+
+
+	/**
+	 * Depending on PHP version,
+	 * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
+	 * To get around that, for these fringe timezones we bump them to a known valid offset.
+	 * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
+	 *
+	 * @param int $gmt_offset
+	 * @return int
+	 */
+	public function adjustInvalidGmtOffsets($gmt_offset);
 }

core/services/helpers/datetime/PhpCompatGreaterFiveSixHelper.php

Indentation +80 added lines, -80 removed lines

@@ -9,92 +9,92 @@
 
 class PhpCompatGreaterFiveSixHelper extends AbstractHelper
 {
-    /**
-     * PhpCompatLessFiveSixHelper constructor.
-     *
-     * @throws DomainException
-     */
-    public function __construct()
-    {
-        if (PHP_VERSION_ID < 50600) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The %1$s is only usable on php versions greater than 5.6.  You\'ll want to use %2$s instead.',
-                        'event_espresso'
-                    ),
-                    __CLASS__,
-                    'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper'
-                )
-            );
-        }
-        parent::__construct();
-    }
+	/**
+	 * PhpCompatLessFiveSixHelper constructor.
+	 *
+	 * @throws DomainException
+	 */
+	public function __construct()
+	{
+		if (PHP_VERSION_ID < 50600) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The %1$s is only usable on php versions greater than 5.6.  You\'ll want to use %2$s instead.',
+						'event_espresso'
+					),
+					__CLASS__,
+					'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper'
+				)
+			);
+		}
+		parent::__construct();
+	}
 
-    /**
-     * Returns a timezone string for the provided gmt_offset.
-     * This is a valid timezone string that can be sent into DateTimeZone
-     *
-     * @param float|string $gmt_offset
-     * @return string
-     */
-    public function getTimezoneStringFromGmtOffset($gmt_offset = '')
-    {
-        $gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset);
-        return is_float($gmt_offset_or_timezone_string)
-            ? $this->convertWpGmtOffsetForDateTimeZone($gmt_offset_or_timezone_string)
-            : $gmt_offset_or_timezone_string;
-    }
+	/**
+	 * Returns a timezone string for the provided gmt_offset.
+	 * This is a valid timezone string that can be sent into DateTimeZone
+	 *
+	 * @param float|string $gmt_offset
+	 * @return string
+	 */
+	public function getTimezoneStringFromGmtOffset($gmt_offset = '')
+	{
+		$gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset);
+		return is_float($gmt_offset_or_timezone_string)
+			? $this->convertWpGmtOffsetForDateTimeZone($gmt_offset_or_timezone_string)
+			: $gmt_offset_or_timezone_string;
+	}
 
 
 
-    /**
-     * Returns a formatted offset for use as an argument for constructing DateTimeZone
-     * @param float $gmt_offset This should be a float representing the gmt_offset.
-     * @return string
-     */
-    protected function convertWpGmtOffsetForDateTimeZone($gmt_offset)
-    {
-        $gmt_offset = (float) $gmt_offset;
-        $is_negative = $gmt_offset < 0;
-        $gmt_offset *= 100;
-        $gmt_offset = absint($gmt_offset);
-        // negative and need zero padding?
-        if (strlen($gmt_offset) < 4) {
-            $gmt_offset = str_pad($gmt_offset, 4, '0', STR_PAD_LEFT);
-        }
-        $gmt_offset = $this->convertToTimeFraction($gmt_offset);
-        // return something like -1300, -0200 or +1300, +0200
-        return $is_negative ? '-' . $gmt_offset : '+' . $gmt_offset;
-    }
+	/**
+	 * Returns a formatted offset for use as an argument for constructing DateTimeZone
+	 * @param float $gmt_offset This should be a float representing the gmt_offset.
+	 * @return string
+	 */
+	protected function convertWpGmtOffsetForDateTimeZone($gmt_offset)
+	{
+		$gmt_offset = (float) $gmt_offset;
+		$is_negative = $gmt_offset < 0;
+		$gmt_offset *= 100;
+		$gmt_offset = absint($gmt_offset);
+		// negative and need zero padding?
+		if (strlen($gmt_offset) < 4) {
+			$gmt_offset = str_pad($gmt_offset, 4, '0', STR_PAD_LEFT);
+		}
+		$gmt_offset = $this->convertToTimeFraction($gmt_offset);
+		// return something like -1300, -0200 or +1300, +0200
+		return $is_negative ? '-' . $gmt_offset : '+' . $gmt_offset;
+	}
 
 
-    /**
-     * Converts something like `1550` to `1530` or `0275` to `0245`
-     * Incoming offset should be a positive value, this will mutate negative values. Be aware!
-     * @param int $offset
-     * @return mixed
-     */
-    protected function convertToTimeFraction($offset)
-    {
-        $first_part = substr($offset, 0, 2);
-        $second_part = substr($offset, 2, 2);
-        $second_part = str_replace(array('25', '50', '75'), array('15', '30', '45'), $second_part);
-        return $first_part . $second_part;
-    }
+	/**
+	 * Converts something like `1550` to `1530` or `0275` to `0245`
+	 * Incoming offset should be a positive value, this will mutate negative values. Be aware!
+	 * @param int $offset
+	 * @return mixed
+	 */
+	protected function convertToTimeFraction($offset)
+	{
+		$first_part = substr($offset, 0, 2);
+		$second_part = substr($offset, 2, 2);
+		$second_part = str_replace(array('25', '50', '75'), array('15', '30', '45'), $second_part);
+		return $first_part . $second_part;
+	}
 
 
-    /**
-     * Get Timezone offset for given timezone object
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param null|int     $time
-     * @return int
-     */
-    public function getTimezoneOffset(DateTimezone $date_time_zone, $time = null)
-    {
-        $time = is_int($time) || $time === null ? $time : (int) strtotime($time);
-        $time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
-        return $date_time_zone->getOffset(new DateTime('@' . $time));
-    }
+	/**
+	 * Get Timezone offset for given timezone object
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param null|int     $time
+	 * @return int
+	 */
+	public function getTimezoneOffset(DateTimezone $date_time_zone, $time = null)
+	{
+		$time = is_int($time) || $time === null ? $time : (int) strtotime($time);
+		$time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
+		return $date_time_zone->getOffset(new DateTime('@' . $time));
+	}
 }

core/services/helpers/datetime/AbstractHelper.php

Indentation +323 added lines, -323 removed lines

@@ -11,195 +11,195 @@ 
 
 abstract class AbstractHelper implements HelperInterface
 {
-    /**
-     * @var string
-     */
-    private $default_timezone_string = '';
-
-
-    /**
-     * AbstractHelper constructor.
-     */
-    public function __construct()
-    {
-        add_action('update_option_timezone_string', [$this, 'updateDefaultTimezoneString'], 10, 2);
-    }
-    /**
-     * AbstractHelper destructor.
-     */
-    public function __destruct()
-    {
-        remove_action('update_option_timezone_string', [$this, 'updateDefaultTimezoneString']);
-    }
-
-
-
-
-    /**
-     * Ensures that a valid timezone string is returned.
-     *
-     * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
-     *                                 settings (or derive from set UTC offset).
-     * @param bool   $throw_error
-     * @return string
-     * @throws EE_Error
-     */
-    public function getValidTimezoneString($timezone_string = '', $throw_error = false)
-    {
-        // if a valid TZ is supplied, then just use that, but don't throw errors if it's invalid
-        if (! empty($timezone_string) && $this->validateTimezone($timezone_string, $throw_error)) {
-            return $timezone_string;
-        }
-        // cache whatever gets set as the site default
-        // no default set yet? then let's get to it!
-        if ($this->default_timezone_string === '') {
-            // ignore the incoming TZ string because we already know it's invalid
-            // and just pull the default set for the site
-            $timezone_string = (string) get_option('timezone_string');
-            // if the site admin has not set a valid default,
-            // then derive the TZ from the UTC offset (and hope that that is set)
-            $timezone_string = ! empty($timezone_string)
-                ? $timezone_string
-                : $this->getTimezoneStringFromGmtOffset();
-            // make sure it's all good (and this time blow things up if no TZ can be determined)
-            $this->validateTimezone($timezone_string);
-            // cache the default so that we don't do this a Brazilian times
-            $this->default_timezone_string = $timezone_string;
-        }
-        return $this->default_timezone_string;
-    }
-
-
-    public function resetDefaultTimezoneString()
-    {
-        $this->default_timezone_string = '';
-    }
-
-
-    /**
-     * @param $old_value
-     * @param $value
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    public function updateDefaultTimezoneString($old_value, $value)
-    {
-        if ($value && $value !== $old_value && $value !== $this->default_timezone_string) {
-            $this->resetDefaultTimezoneString();
-            $this->getValidTimezoneString($value);
-        }
-    }
-
-    /**
-     * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
-     *
-     * @param string $timezone_string
-     * @param bool   $throw_error
-     * @return bool
-     * @throws EE_Error
-     */
-    public function validateTimezone($timezone_string, $throw_error = true)
-    {
-        // easiest way to test a timezone string is just see if it throws an error when you try to create a
-        // DateTimeZone object with it
-        try {
-            new DateTimeZone($timezone_string);
-        } catch (Exception $e) {
-            // sometimes we take exception to exceptions
-            if (! $throw_error) {
-                return false;
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The timezone given (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
-                        'event_espresso'
-                    ),
-                    $timezone_string,
-                    '<a href="http://www.php.net/manual/en/timezones.php">',
-                    '</a>'
-                )
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * Gets the site's GMT offset based on either the timezone string
-     * (in which case the gmt offset will vary depending on the location's
-     * observance of daylight savings time) or the gmt_offset wp option
-     *
-     * @return int  seconds offset
-     */
-    public function getSiteTimezoneGmtOffset()
-    {
-        $timezone_string = (string) get_option('timezone_string');
-        if ($timezone_string) {
-            try {
-                $timezone = new DateTimeZone($timezone_string);
-                return $timezone->getOffset(new DateTime()); // in WordPress DateTime defaults to UTC
-            } catch (Exception $e) {
-            }
-        }
-        $offset = get_option('gmt_offset');
-        return (int) ($offset * HOUR_IN_SECONDS);
-    }
-
-
-    /**
-     * Get Timezone offset for given timezone object
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param null|int     $time
-     * @return int
-     * @throws DomainException
-     */
-    public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null)
-    {
-        $transition = $this->getTimezoneTransitions($date_time_zone, $time);
-        if (! isset($transition['offset'])) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'),
-                    print_r($transition, true)
-                )
-            );
-        }
-        return $transition['offset'];
-    }
-
-
-    /**
-     * Provide a timezone select input
-     *
-     * @param string $timezone_string
-     * @return string
-     * @throws EE_Error
-     */
-    public function timezoneSelectInput($timezone_string = '')
-    {
-        // get WP date time format
-        $datetime_format = get_option('date_format') . ' ' . get_option('time_format');
-        // if passed a value, then use that, else get WP option
-        $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
-        // check if the timezone is valid but don't throw any errors if it isn't
-        $timezone_string = $this->validateTimezone($timezone_string, false)
-            ? $timezone_string
-            : '';
-        $gmt_offset      = get_option('gmt_offset');
-        $check_zone_info = true;
-        if (empty($timezone_string)) {
-            // Create a UTC+- zone if no timezone string exists
-            $timezone_string = 'UTC';
-            $check_zone_info = false;
-            if ($gmt_offset > 0) {
-                $timezone_string = 'UTC+' . $gmt_offset;
-            } elseif ($gmt_offset < 0) {
-                $timezone_string = 'UTC' . $gmt_offset;
-            }
-        }
-        ?>
+	/**
+	 * @var string
+	 */
+	private $default_timezone_string = '';
+
+
+	/**
+	 * AbstractHelper constructor.
+	 */
+	public function __construct()
+	{
+		add_action('update_option_timezone_string', [$this, 'updateDefaultTimezoneString'], 10, 2);
+	}
+	/**
+	 * AbstractHelper destructor.
+	 */
+	public function __destruct()
+	{
+		remove_action('update_option_timezone_string', [$this, 'updateDefaultTimezoneString']);
+	}
+
+
+
+
+	/**
+	 * Ensures that a valid timezone string is returned.
+	 *
+	 * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
+	 *                                 settings (or derive from set UTC offset).
+	 * @param bool   $throw_error
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function getValidTimezoneString($timezone_string = '', $throw_error = false)
+	{
+		// if a valid TZ is supplied, then just use that, but don't throw errors if it's invalid
+		if (! empty($timezone_string) && $this->validateTimezone($timezone_string, $throw_error)) {
+			return $timezone_string;
+		}
+		// cache whatever gets set as the site default
+		// no default set yet? then let's get to it!
+		if ($this->default_timezone_string === '') {
+			// ignore the incoming TZ string because we already know it's invalid
+			// and just pull the default set for the site
+			$timezone_string = (string) get_option('timezone_string');
+			// if the site admin has not set a valid default,
+			// then derive the TZ from the UTC offset (and hope that that is set)
+			$timezone_string = ! empty($timezone_string)
+				? $timezone_string
+				: $this->getTimezoneStringFromGmtOffset();
+			// make sure it's all good (and this time blow things up if no TZ can be determined)
+			$this->validateTimezone($timezone_string);
+			// cache the default so that we don't do this a Brazilian times
+			$this->default_timezone_string = $timezone_string;
+		}
+		return $this->default_timezone_string;
+	}
+
+
+	public function resetDefaultTimezoneString()
+	{
+		$this->default_timezone_string = '';
+	}
+
+
+	/**
+	 * @param $old_value
+	 * @param $value
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	public function updateDefaultTimezoneString($old_value, $value)
+	{
+		if ($value && $value !== $old_value && $value !== $this->default_timezone_string) {
+			$this->resetDefaultTimezoneString();
+			$this->getValidTimezoneString($value);
+		}
+	}
+
+	/**
+	 * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
+	 *
+	 * @param string $timezone_string
+	 * @param bool   $throw_error
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function validateTimezone($timezone_string, $throw_error = true)
+	{
+		// easiest way to test a timezone string is just see if it throws an error when you try to create a
+		// DateTimeZone object with it
+		try {
+			new DateTimeZone($timezone_string);
+		} catch (Exception $e) {
+			// sometimes we take exception to exceptions
+			if (! $throw_error) {
+				return false;
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The timezone given (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
+						'event_espresso'
+					),
+					$timezone_string,
+					'<a href="http://www.php.net/manual/en/timezones.php">',
+					'</a>'
+				)
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Gets the site's GMT offset based on either the timezone string
+	 * (in which case the gmt offset will vary depending on the location's
+	 * observance of daylight savings time) or the gmt_offset wp option
+	 *
+	 * @return int  seconds offset
+	 */
+	public function getSiteTimezoneGmtOffset()
+	{
+		$timezone_string = (string) get_option('timezone_string');
+		if ($timezone_string) {
+			try {
+				$timezone = new DateTimeZone($timezone_string);
+				return $timezone->getOffset(new DateTime()); // in WordPress DateTime defaults to UTC
+			} catch (Exception $e) {
+			}
+		}
+		$offset = get_option('gmt_offset');
+		return (int) ($offset * HOUR_IN_SECONDS);
+	}
+
+
+	/**
+	 * Get Timezone offset for given timezone object
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param null|int     $time
+	 * @return int
+	 * @throws DomainException
+	 */
+	public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null)
+	{
+		$transition = $this->getTimezoneTransitions($date_time_zone, $time);
+		if (! isset($transition['offset'])) {
+			throw new DomainException(
+				sprintf(
+					esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'),
+					print_r($transition, true)
+				)
+			);
+		}
+		return $transition['offset'];
+	}
+
+
+	/**
+	 * Provide a timezone select input
+	 *
+	 * @param string $timezone_string
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function timezoneSelectInput($timezone_string = '')
+	{
+		// get WP date time format
+		$datetime_format = get_option('date_format') . ' ' . get_option('time_format');
+		// if passed a value, then use that, else get WP option
+		$timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
+		// check if the timezone is valid but don't throw any errors if it isn't
+		$timezone_string = $this->validateTimezone($timezone_string, false)
+			? $timezone_string
+			: '';
+		$gmt_offset      = get_option('gmt_offset');
+		$check_zone_info = true;
+		if (empty($timezone_string)) {
+			// Create a UTC+- zone if no timezone string exists
+			$timezone_string = 'UTC';
+			$check_zone_info = false;
+			if ($gmt_offset > 0) {
+				$timezone_string = 'UTC+' . $gmt_offset;
+			} elseif ($gmt_offset < 0) {
+				$timezone_string = 'UTC' . $gmt_offset;
+			}
+		}
+		?>
         <p>
             <label for="timezone_string"><?php _e('timezone', 'event_espresso'); ?></label>
             <select id="timezone_string" name="timezone_string">
@@ -212,150 +212,150 @@ 
         <p>
         <span>
             <?php
-            printf(
-                __('%1$sUTC%2$s time is %3$s', 'event_espresso'),
-                '<abbr title="Coordinated Universal Time">',
-                '</abbr>',
-                '<code>' . date_i18n($datetime_format, false, true) . '</code>'
-            );
-            ?></span>
+			printf(
+				__('%1$sUTC%2$s time is %3$s', 'event_espresso'),
+				'<abbr title="Coordinated Universal Time">',
+				'</abbr>',
+				'<code>' . date_i18n($datetime_format, false, true) . '</code>'
+			);
+			?></span>
         <?php
-        if (! empty($timezone_string) || ! empty($gmt_offset)) : ?>
+		if (! empty($timezone_string) || ! empty($gmt_offset)) : ?>
         <br/><span><?php printf(__('Local time is %1$s', 'event_espresso'), '<code>' . date_i18n($datetime_format) . '</code>'); ?></span>
             <?php
-        endif; ?>
+		endif; ?>
 
         <?php
-        if ($check_zone_info && $timezone_string) : ?>
+		if ($check_zone_info && $timezone_string) : ?>
         <br/>
         <span>
                 <?php
-                // Set TZ so localtime works.
-                date_default_timezone_set($timezone_string);
-                $now = localtime(time(), true);
-                if ($now['tm_isdst']) {
-                    _e('This timezone is currently in daylight saving time.', 'event_espresso');
-                } else {
-                    _e('This timezone is currently in standard time.', 'event_espresso');
-                }
-                ?>
+				// Set TZ so localtime works.
+				date_default_timezone_set($timezone_string);
+				$now = localtime(time(), true);
+				if ($now['tm_isdst']) {
+					_e('This timezone is currently in daylight saving time.', 'event_espresso');
+				} else {
+					_e('This timezone is currently in standard time.', 'event_espresso');
+				}
+				?>
             <br/>
             <?php
-            if (function_exists('timezone_transitions_get')) {
-                $found                   = false;
-                $date_time_zone_selected = new DateTimeZone($timezone_string);
-                $tz_offset               = timezone_offset_get($date_time_zone_selected, date_create());
-                $right_now               = time();
-                $tr['isdst']             = false;
-                foreach (timezone_transitions_get($date_time_zone_selected) as $tr) {
-                    if ($tr['ts'] > $right_now) {
-                        $found = true;
-                        break;
-                    }
-                }
-                if ($found) {
-                    $message = $tr['isdst']
-                        ? __(' Daylight saving time begins on: %s.', 'event_espresso')
-                        : __(' Standard time begins  on: %s.', 'event_espresso');
-                    // Add the difference between the current offset and the new offset to ts to get the correct
-                    // transition time from date_i18n().
-                    printf(
-                        $message,
-                        '<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >'
-                    );
-                } else {
-                    _e('This timezone does not observe daylight saving time.', 'event_espresso');
-                }
-            }
-            // Set back to UTC.
-            date_default_timezone_set('UTC');
-            ?>
+			if (function_exists('timezone_transitions_get')) {
+				$found                   = false;
+				$date_time_zone_selected = new DateTimeZone($timezone_string);
+				$tz_offset               = timezone_offset_get($date_time_zone_selected, date_create());
+				$right_now               = time();
+				$tr['isdst']             = false;
+				foreach (timezone_transitions_get($date_time_zone_selected) as $tr) {
+					if ($tr['ts'] > $right_now) {
+						$found = true;
+						break;
+					}
+				}
+				if ($found) {
+					$message = $tr['isdst']
+						? __(' Daylight saving time begins on: %s.', 'event_espresso')
+						: __(' Standard time begins  on: %s.', 'event_espresso');
+					// Add the difference between the current offset and the new offset to ts to get the correct
+					// transition time from date_i18n().
+					printf(
+						$message,
+						'<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >'
+					);
+				} else {
+					_e('This timezone does not observe daylight saving time.', 'event_espresso');
+				}
+			}
+			// Set back to UTC.
+			date_default_timezone_set('UTC');
+			?>
         </span></p>
             <?php
-        endif;
-    }
-
-
-    /**
-     * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
-     * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
-     * the site is used.
-     * This is used typically when using a Unix timestamp any core WP functions that expect their specially
-     * computed timestamp (i.e. date_i18n() )
-     *
-     * @param int    $unix_timestamp  if 0, then time() will be used.
-     * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
-     *                                site will be used.
-     * @return int      unix_timestamp value with the offset applied for the given timezone.
-     * @throws EE_Error
-     */
-    public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '')
-    {
-        $unix_timestamp  = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
-        $timezone_string = $this->getValidTimezoneString($timezone_string);
-        $TimeZone        = new DateTimeZone($timezone_string);
-        $DateTime        = new DateTime('@' . $unix_timestamp, $TimeZone);
-        $offset          = timezone_offset_get($TimeZone, $DateTime);
-        return (int) $DateTime->format('U') + (int) $offset;
-    }
-
-
-    /**
-     * Get Timezone Transitions
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param int|null     $time
-     * @param bool         $first_only
-     * @return array|mixed
-     */
-    public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
-    {
-        $time        = is_int($time) || $time === null ? $time : (int) strtotime($time);
-        $time        = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
-        $transitions = $date_time_zone->getTransitions($time);
-        return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions;
-    }
-
-
-
-    /**
-     * Default to just returning the provided $gmt_offset.  Children can override if adjustment needed.
-     *
-     * @param int $gmt_offset
-     * @return int
-     */
-    public function adjustInvalidGmtOffsets($gmt_offset = 0)
-    {
-        return $gmt_offset;
-    }
-
-
-
-    /**
-     * This receives an incoming gmt_offset and santizes it.  If the provide value is an empty string, then this will
-     * attempt to get the offset from the timezone string.  If this returns a string, then a timezone string was
-     * successfully derived from existing timezone_string in the db.  If not, then a float is returned for the provided
-     * offset.
-     * @param  float|string $gmt_offset
-     * @return float|string
-     */
-    protected function sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset)
-    {
-        // if there is no incoming gmt_offset, then because WP hooks in on timezone_string, we need to see if that is
-        // set because it will override `gmt_offset` via `pre_get_option` filter.  If that's set, then let's just use
-        // that!  Otherwise we'll leave timezone_string at the default of 'UTC' before doing other logic.
-        if ($gmt_offset === '') {
-            // autoloaded so no need to set to a variable.  There will not be multiple hits to the db.
-            if (get_option('timezone_string')) {
-                return (string) get_option('timezone_string');
-            }
-        }
-        $gmt_offset = $gmt_offset !== '' ? $gmt_offset : (string) get_option('gmt_offset');
-        $gmt_offset = (float) $gmt_offset;
-        // if $gmt_offset is 0 or is still an empty string, then just return UTC
-        if ($gmt_offset === (float) 0) {
-            return 'UTC';
-        }
-        return $gmt_offset;
-    }
+		endif;
+	}
+
+
+	/**
+	 * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
+	 * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
+	 * the site is used.
+	 * This is used typically when using a Unix timestamp any core WP functions that expect their specially
+	 * computed timestamp (i.e. date_i18n() )
+	 *
+	 * @param int    $unix_timestamp  if 0, then time() will be used.
+	 * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
+	 *                                site will be used.
+	 * @return int      unix_timestamp value with the offset applied for the given timezone.
+	 * @throws EE_Error
+	 */
+	public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '')
+	{
+		$unix_timestamp  = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
+		$timezone_string = $this->getValidTimezoneString($timezone_string);
+		$TimeZone        = new DateTimeZone($timezone_string);
+		$DateTime        = new DateTime('@' . $unix_timestamp, $TimeZone);
+		$offset          = timezone_offset_get($TimeZone, $DateTime);
+		return (int) $DateTime->format('U') + (int) $offset;
+	}
+
+
+	/**
+	 * Get Timezone Transitions
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param int|null     $time
+	 * @param bool         $first_only
+	 * @return array|mixed
+	 */
+	public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
+	{
+		$time        = is_int($time) || $time === null ? $time : (int) strtotime($time);
+		$time        = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
+		$transitions = $date_time_zone->getTransitions($time);
+		return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions;
+	}
+
+
+
+	/**
+	 * Default to just returning the provided $gmt_offset.  Children can override if adjustment needed.
+	 *
+	 * @param int $gmt_offset
+	 * @return int
+	 */
+	public function adjustInvalidGmtOffsets($gmt_offset = 0)
+	{
+		return $gmt_offset;
+	}
+
+
+
+	/**
+	 * This receives an incoming gmt_offset and santizes it.  If the provide value is an empty string, then this will
+	 * attempt to get the offset from the timezone string.  If this returns a string, then a timezone string was
+	 * successfully derived from existing timezone_string in the db.  If not, then a float is returned for the provided
+	 * offset.
+	 * @param  float|string $gmt_offset
+	 * @return float|string
+	 */
+	protected function sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset)
+	{
+		// if there is no incoming gmt_offset, then because WP hooks in on timezone_string, we need to see if that is
+		// set because it will override `gmt_offset` via `pre_get_option` filter.  If that's set, then let's just use
+		// that!  Otherwise we'll leave timezone_string at the default of 'UTC' before doing other logic.
+		if ($gmt_offset === '') {
+			// autoloaded so no need to set to a variable.  There will not be multiple hits to the db.
+			if (get_option('timezone_string')) {
+				return (string) get_option('timezone_string');
+			}
+		}
+		$gmt_offset = $gmt_offset !== '' ? $gmt_offset : (string) get_option('gmt_offset');
+		$gmt_offset = (float) $gmt_offset;
+		// if $gmt_offset is 0 or is still an empty string, then just return UTC
+		if ($gmt_offset === (float) 0) {
+			return 'UTC';
+		}
+		return $gmt_offset;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -47,7 +47,7 @@ 
     public function getValidTimezoneString($timezone_string = '', $throw_error = false)
     {
         // if a valid TZ is supplied, then just use that, but don't throw errors if it's invalid
-        if (! empty($timezone_string) && $this->validateTimezone($timezone_string, $throw_error)) {
+        if ( ! empty($timezone_string) && $this->validateTimezone($timezone_string, $throw_error)) {
             return $timezone_string;
         }
         // cache whatever gets set as the site default
@@ -106,7 +106,7 @@ 
             new DateTimeZone($timezone_string);
         } catch (Exception $e) {
             // sometimes we take exception to exceptions
-            if (! $throw_error) {
+            if ( ! $throw_error) {
                 return false;
             }
             throw new EE_Error(
@@ -158,7 +158,7 @@ 
     public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null)
     {
         $transition = $this->getTimezoneTransitions($date_time_zone, $time);
-        if (! isset($transition['offset'])) {
+        if ( ! isset($transition['offset'])) {
             throw new DomainException(
                 sprintf(
                     esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'),
@@ -180,7 +180,7 @@ 
     public function timezoneSelectInput($timezone_string = '')
     {
         // get WP date time format
-        $datetime_format = get_option('date_format') . ' ' . get_option('time_format');
+        $datetime_format = get_option('date_format').' '.get_option('time_format');
         // if passed a value, then use that, else get WP option
         $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
         // check if the timezone is valid but don't throw any errors if it isn't
@@ -194,9 +194,9 @@ 
             $timezone_string = 'UTC';
             $check_zone_info = false;
             if ($gmt_offset > 0) {
-                $timezone_string = 'UTC+' . $gmt_offset;
+                $timezone_string = 'UTC+'.$gmt_offset;
             } elseif ($gmt_offset < 0) {
-                $timezone_string = 'UTC' . $gmt_offset;
+                $timezone_string = 'UTC'.$gmt_offset;
             }
         }
         ?>
@@ -216,12 +216,12 @@ 
                 __('%1$sUTC%2$s time is %3$s', 'event_espresso'),
                 '<abbr title="Coordinated Universal Time">',
                 '</abbr>',
-                '<code>' . date_i18n($datetime_format, false, true) . '</code>'
+                '<code>'.date_i18n($datetime_format, false, true).'</code>'
             );
             ?></span>
         <?php
-        if (! empty($timezone_string) || ! empty($gmt_offset)) : ?>
-        <br/><span><?php printf(__('Local time is %1$s', 'event_espresso'), '<code>' . date_i18n($datetime_format) . '</code>'); ?></span>
+        if ( ! empty($timezone_string) || ! empty($gmt_offset)) : ?>
+        <br/><span><?php printf(__('Local time is %1$s', 'event_espresso'), '<code>'.date_i18n($datetime_format).'</code>'); ?></span>
             <?php
         endif; ?>
 
@@ -261,7 +261,7 @@ 
                     // transition time from date_i18n().
                     printf(
                         $message,
-                        '<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >'
+                        '<code >'.date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])).'</code >'
                     );
                 } else {
                     _e('This timezone does not observe daylight saving time.', 'event_espresso');
@@ -294,7 +294,7 @@ 
         $unix_timestamp  = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
         $timezone_string = $this->getValidTimezoneString($timezone_string);
         $TimeZone        = new DateTimeZone($timezone_string);
-        $DateTime        = new DateTime('@' . $unix_timestamp, $TimeZone);
+        $DateTime        = new DateTime('@'.$unix_timestamp, $TimeZone);
         $offset          = timezone_offset_get($TimeZone, $DateTime);
         return (int) $DateTime->format('U') + (int) $offset;
     }

core/EE_Registry.core.php

Indentation +1696 added lines, -1696 removed lines

@@ -23,1704 +23,1704 @@
 class EE_Registry implements ResettableInterface
 {
 
-    /**
-     * @var EE_Registry $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Dependency_Map $_dependency_map
-     */
-    protected $_dependency_map;
-
-    /**
-     * @var Mirror
-     */
-    private $mirror;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * @var array $_class_abbreviations
-     */
-    protected $_class_abbreviations = array();
-
-    /**
-     * @var CommandBusInterface $BUS
-     */
-    public $BUS;
-
-    /**
-     * @var EE_Cart $CART
-     */
-    public $CART;
-
-    /**
-     * @var EE_Config $CFG
-     */
-    public $CFG;
-
-    /**
-     * @var EE_Network_Config $NET_CFG
-     */
-    public $NET_CFG;
-
-    /**
-     * StdClass object for storing library classes in
-     *
-     * @var RegistryContainer $LIB
-     */
-    public $LIB;
-
-    /**
-     * @var EE_Request_Handler $REQ
-     */
-    public $REQ;
-
-    /**
-     * @var EE_Session $SSN
-     */
-    public $SSN;
-
-    /**
-     * @since 4.5.0
-     * @var EE_Capabilities $CAP
-     */
-    public $CAP;
-
-    /**
-     * @since 4.9.0
-     * @var EE_Message_Resource_Manager $MRM
-     */
-    public $MRM;
-
-    /**
-     * @var Registry $AssetsRegistry
-     */
-    public $AssetsRegistry;
-
-    /**
-     * StdClass object for holding addons which have registered themselves to work with EE core
-     *
-     * @var EE_Addon[] $addons
-     */
-    public $addons;
-
-    /**
-     * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
-     *
-     * @var EEM_Base[] $models
-     */
-    public $models = array();
-
-    /**
-     * @var EED_Module[] $modules
-     */
-    public $modules;
-
-    /**
-     * @var EES_Shortcode[] $shortcodes
-     */
-    public $shortcodes;
-
-    /**
-     * @var WP_Widget[] $widgets
-     */
-    public $widgets;
-
-    /**
-     * this is an array of all implemented model names (i.e. not the parent abstract models, or models
-     * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
-     * Keys are model "short names" (eg "Event") as used in model relations, and values are
-     * classnames (eg "EEM_Event")
-     *
-     * @var array $non_abstract_db_models
-     */
-    public $non_abstract_db_models = array();
-
-    /**
-     * internationalization for JS strings
-     *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
-     *    in js file:  var translatedString = eei18n.string_key;
-     *
-     * @var array $i18n_js_strings
-     */
-    public static $i18n_js_strings = array();
-
-    /**
-     * $main_file - path to espresso.php
-     *
-     * @var array $main_file
-     */
-    public $main_file;
-
-    /**
-     * array of ReflectionClass objects where the key is the class name
-     *
-     * @deprecated 4.9.62.p
-     * @var ReflectionClass[] $_reflectors
-     */
-    public $_reflectors;
-
-    /**
-     * boolean flag to indicate whether or not to load/save dependencies from/to the cache
-     *
-     * @var boolean $_cache_on
-     */
-    protected $_cache_on = true;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Dependency_Map|null   $dependency_map
-     * @param Mirror|null              $mirror
-     * @param ClassInterfaceCache|null $class_cache
-     * @param ObjectIdentifier|null    $object_identifier
-     * @return EE_Registry instance
-     */
-    public static function instance(
-        EE_Dependency_Map $dependency_map = null,
-        Mirror $mirror = null,
-        ClassInterfaceCache $class_cache = null,
-        ObjectIdentifier $object_identifier = null
-    ) {
-        // check if class object is instantiated
-        if (
-            ! self::$_instance instanceof EE_Registry
-            && $dependency_map instanceof EE_Dependency_Map
-            && $mirror instanceof Mirror
-            && $class_cache instanceof ClassInterfaceCache
-            && $object_identifier instanceof ObjectIdentifier
-        ) {
-            self::$_instance = new self(
-                $dependency_map,
-                $mirror,
-                $class_cache,
-                $object_identifier
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @Constructor
-     * @param  EE_Dependency_Map  $dependency_map
-     * @param Mirror              $mirror
-     * @param ClassInterfaceCache $class_cache
-     * @param ObjectIdentifier    $object_identifier
-     */
-    protected function __construct(
-        EE_Dependency_Map $dependency_map,
-        Mirror $mirror,
-        ClassInterfaceCache $class_cache,
-        ObjectIdentifier $object_identifier
-    ) {
-        $this->_dependency_map = $dependency_map;
-        $this->mirror = $mirror;
-        $this->class_cache = $class_cache;
-        $this->object_identifier = $object_identifier;
-        // $registry_container = new RegistryContainer();
-        $this->LIB = new RegistryContainer();
-        $this->addons = new RegistryContainer();
-        $this->modules = new RegistryContainer();
-        $this->shortcodes = new RegistryContainer();
-        $this->widgets = new RegistryContainer();
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
-    }
-
-
-    /**
-     * initialize
-     *
-     * @throws OutOfBoundsException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize()
-    {
-        $this->_class_abbreviations = apply_filters(
-            'FHEE__EE_Registry____construct___class_abbreviations',
-            array(
-                'EE_Config'                                       => 'CFG',
-                'EE_Session'                                      => 'SSN',
-                'EE_Capabilities'                                 => 'CAP',
-                'EE_Cart'                                         => 'CART',
-                'EE_Network_Config'                               => 'NET_CFG',
-                'EE_Request_Handler'                              => 'REQ',
-                'EE_Message_Resource_Manager'                     => 'MRM',
-                'EventEspresso\core\services\commands\CommandBus' => 'BUS',
-                'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
-            )
-        );
-        $this->load_core('Base', array(), true);
-        // add our request and response objects to the cache
-        $request_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Request'
-        );
-        $this->_set_cached_class(
-            $request_loader(),
-            'EventEspresso\core\services\request\Request'
-        );
-        $response_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Response'
-        );
-        $this->_set_cached_class(
-            $response_loader(),
-            'EventEspresso\core\services\request\Response'
-        );
-        add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
-    }
-
-
-    /**
-     * @return void
-     */
-    public function init()
-    {
-        // Get current page protocol
-        $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
-        // Output admin-ajax.php URL with same protocol as current page
-        self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
-        self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
-    }
-
-
-    /**
-     * localize_i18n_js_strings
-     *
-     * @return string
-     */
-    public static function localize_i18n_js_strings()
-    {
-        $i18n_js_strings = (array) self::$i18n_js_strings;
-        foreach ($i18n_js_strings as $key => $value) {
-            if (is_scalar($value)) {
-                $i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
-            }
-        }
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
-    }
-
-
-    /**
-     * @param mixed string | EED_Module $module
-     * @throws OutOfBoundsException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_module($module)
-    {
-        if ($module instanceof EED_Module) {
-            $module_class = get_class($module);
-            $this->modules->{$module_class} = $module;
-        } else {
-            if (! class_exists('EE_Module_Request_Router', false)) {
-                $this->load_core('Module_Request_Router');
-            }
-            EE_Module_Request_Router::module_factory($module);
-        }
-    }
-
-
-    /**
-     * @param string $module_name
-     * @return mixed EED_Module | NULL
-     */
-    public function get_module($module_name = '')
-    {
-        return isset($this->modules->{$module_name})
-            ? $this->modules->{$module_name}
-            : null;
-    }
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_core($class_name, $arguments = array(), $load_only = false)
-    {
-        $core_paths = apply_filters(
-            'FHEE__EE_Registry__load_core__core_paths',
-            array(
-                EE_CORE,
-                EE_ADMIN,
-                EE_CPTS,
-                EE_CORE . 'data_migration_scripts/',
-                EE_CORE . 'capabilities/',
-                EE_CORE . 'request_stack/',
-                EE_CORE . 'middleware/',
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $core_paths,
-            'EE_',
-            $class_name,
-            'core',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads service classes
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_service($class_name, $arguments = array(), $load_only = false)
-    {
-        $service_paths = apply_filters(
-            'FHEE__EE_Registry__load_service__service_paths',
-            array(
-                EE_CORE . 'services/',
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $service_paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads data_migration_scripts
-     *
-     * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
-     * @param mixed  $arguments
-     * @return EE_Data_Migration_Script_Base|mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_dms($class_name, $arguments = array())
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
-            'EE_DMS_',
-            $class_name,
-            'dms',
-            $arguments,
-            false,
-            false
-        );
-    }
-
-
-    /**
-     * loads object creating classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: attendee
-     * @param mixed  $arguments  - an array of arguments to pass to the class
-     * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
-     *                           instantiate
-     * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
-     *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
-     * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
-     *                           (default)
-     * @return EE_Base_Class | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
-    {
-        $paths = apply_filters(
-            'FHEE__EE_Registry__load_class__paths',
-            array(
-                EE_CORE,
-                EE_CLASSES,
-                EE_BUSINESS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            $from_db,
-            $cache,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads helper classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEH_Base | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_helper($class_name, $arguments = array(), $load_only = true)
-    {
-        // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
-        $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
-        // retrieve instantiated class
-        return $this->_load(
-            $helper_paths,
-            'EEH_',
-            $class_name,
-            'helper',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @param bool   $cache      whether to cache the object or not.
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
-    {
-        $paths = array(
-            EE_LIBRARIES,
-            EE_LIBRARIES . 'messages/',
-            EE_LIBRARIES . 'shortcodes/',
-            EE_LIBRARIES . 'qtips/',
-            EE_LIBRARIES . 'payment_methods/',
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'lib',
-            $arguments,
-            false,
-            $cache,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEM_Base | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_model($class_name, $arguments = array(), $load_only = false)
-    {
-        $paths = apply_filters(
-            'FHEE__EE_Registry__load_model__paths',
-            array(
-                EE_MODELS,
-                EE_CORE,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EEM_',
-            $class_name,
-            'model',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_model_class($class_name, $arguments = array(), $load_only = true)
-    {
-        $paths = array(
-            EE_MODELS . 'fields/',
-            EE_MODELS . 'helpers/',
-            EE_MODELS . 'relations/',
-            EE_MODELS . 'strategies/',
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            '',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * Determines if $model_name is the name of an actual EE model.
-     *
-     * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
-     * @return boolean
-     */
-    public function is_model_name($model_name)
-    {
-        return isset($this->models[ $model_name ]);
-    }
-
-
-    /**
-     * generic class loader
-     *
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $file_name    - file name  ie:  my_file.php, including extension
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            $path_to_file,
-            '',
-            $file_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $class_name   - full class name  ie:  My_Class
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|EE_Addon|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            $path_to_file,
-            'addon',
-            $class_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * instantiates, caches, and automatically resolves dependencies
-     * for classes that use a Fully Qualified Class Name.
-     * if the class is not capable of being loaded using PSR-4 autoloading,
-     * then you need to use one of the existing load_*() methods
-     * which can resolve the classname and filepath from the passed arguments
-     *
-     * @param bool|string $class_name   Fully Qualified Class Name
-     * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
-     * @return bool|null|mixed          null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function create(
-        $class_name = false,
-        $arguments = array(),
-        $cache = false,
-        $from_db = false,
-        $load_only = false,
-        $addon = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        $class_name = $this->class_cache->getFqnForAlias($class_name);
-        $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
-        // if a non-FQCN was passed, then
-        // verifyClassExists() might return an object
-        // or it could return null if the class just could not be found anywhere
-        if ($class_exists instanceof $class_name || $class_exists === null) {
-            // either way, return the results
-            return $class_exists;
-        }
-        $class_name = $class_exists;
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only) {
-            return true;
-        }
-        $addon = $addon ? 'addon' : '';
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }// obtain the loader method from the dependency map
-        $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
-        if ($loader instanceof Closure) {
-            $class_obj = $loader($arguments);
-        } else {
-            if ($loader && method_exists($this, $loader)) {
-                $class_obj = $this->{$loader}($class_name, $arguments);
-            } else {
-                $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
-            }
-        }
-        if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class(
-                $class_obj,
-                $class_name,
-                $addon,
-                $from_db,
-                $arguments
-            );
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-    /**
-     * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
-     *
-     * @param string|object $class_name
-     * @param array         $arguments
-     * @param int           $attempt
-     * @return mixed
-     */
-    private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1)
-    {
-        if (is_object($class_name) || class_exists($class_name)) {
-            return $class_name;
-        }
-        switch ($attempt) {
-            case 1:
-                // if it's a FQCN then maybe the class is registered with a preceding \
-                $class_name = strpos($class_name, '\\') !== false
-                    ? '\\' . ltrim($class_name, '\\')
-                    : $class_name;
-                break;
-            case 2:
-                //
-                $loader = $this->_dependency_map->class_loader($class_name);
-                if ($loader && method_exists($this, $loader)) {
-                    return $this->{$loader}($class_name, $arguments);
-                }
-                break;
-            case 3:
-            default:
-                return null;
-        }
-        $attempt++;
-        return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
-    }
-
-
-    /**
-     * instantiates, caches, and injects dependencies for classes
-     *
-     * @param array       $file_paths   an array of paths to folders to look in
-     * @param string      $class_prefix EE  or EEM or... ???
-     * @param bool|string $class_name   $class name
-     * @param string      $type         file type - core? class? helper? model?
-     * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @return bool|null|object null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _load(
-        $file_paths = array(),
-        $class_prefix = 'EE_',
-        $class_name = false,
-        $type = 'class',
-        $arguments = array(),
-        $from_db = false,
-        $cache = true,
-        $load_only = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        // strip php file extension
-        $class_name = str_replace('.php', '', trim($class_name));
-        // does the class have a prefix ?
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
-            // make sure $class_prefix is uppercase
-            $class_prefix = strtoupper(trim($class_prefix));
-            // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
-        }
-        $class_name = $this->class_cache->getFqnForAlias($class_name);
-        $class_exists = class_exists($class_name, false);
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only && $class_exists) {
-            return true;
-        }
-        $arguments = is_array($arguments) ? $arguments : array($arguments);
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
-            // get full path to file
-            $path = $this->_resolve_path($class_name, $type, $file_paths);
-            // load the file
-            $loaded = $this->_require_file($path, $class_name, $type, $file_paths);
-            // if we are only loading a file but NOT instantiating an object
-            // then return boolean for whether class was loaded or not
-            if ($load_only) {
-                return $loaded;
-            }
-            // if an object was expected but loading failed, then return nothing
-            if (! $loaded) {
-                return null;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class(
-                $class_obj,
-                $class_name,
-                $class_prefix,
-                $from_db,
-                $arguments
-            );
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $default have to specify something, but not anything that will conflict
-     * @return mixed|string
-     */
-    protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
-    {
-        return isset($this->_class_abbreviations[ $class_name ])
-            ? $this->_class_abbreviations[ $class_name ]
-            : $default;
-    }
-
-
-    /**
-     * attempts to find a cached version of the requested class
-     * by looking in the following places:
-     *        $this->{$class_abbreviation}            ie:    $this->CART
-     *        $this->{$class_name}                        ie:    $this->Some_Class
-     *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
-     *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
-     *
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param array  $arguments
-     * @return mixed
-     */
-    protected function _get_cached_class(
-        $class_name,
-        $class_prefix = '',
-        $arguments = array()
-    ) {
-        if ($class_name === 'EE_Registry') {
-            return $this;
-        }
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            return $this->{$class_abbreviation};
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            return $this->{$class_name};
-        }
-        if ($class_prefix === 'addon' && isset($this->addons->{$class_name})) {
-            return $this->addons->{$class_name};
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if (isset($this->LIB->{$object_identifier})) {
-            return $this->LIB->{$object_identifier};
-        }
-        foreach ($this->LIB as $key => $object) {
-            if (
+	/**
+	 * @var EE_Registry $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Dependency_Map $_dependency_map
+	 */
+	protected $_dependency_map;
+
+	/**
+	 * @var Mirror
+	 */
+	private $mirror;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * @var array $_class_abbreviations
+	 */
+	protected $_class_abbreviations = array();
+
+	/**
+	 * @var CommandBusInterface $BUS
+	 */
+	public $BUS;
+
+	/**
+	 * @var EE_Cart $CART
+	 */
+	public $CART;
+
+	/**
+	 * @var EE_Config $CFG
+	 */
+	public $CFG;
+
+	/**
+	 * @var EE_Network_Config $NET_CFG
+	 */
+	public $NET_CFG;
+
+	/**
+	 * StdClass object for storing library classes in
+	 *
+	 * @var RegistryContainer $LIB
+	 */
+	public $LIB;
+
+	/**
+	 * @var EE_Request_Handler $REQ
+	 */
+	public $REQ;
+
+	/**
+	 * @var EE_Session $SSN
+	 */
+	public $SSN;
+
+	/**
+	 * @since 4.5.0
+	 * @var EE_Capabilities $CAP
+	 */
+	public $CAP;
+
+	/**
+	 * @since 4.9.0
+	 * @var EE_Message_Resource_Manager $MRM
+	 */
+	public $MRM;
+
+	/**
+	 * @var Registry $AssetsRegistry
+	 */
+	public $AssetsRegistry;
+
+	/**
+	 * StdClass object for holding addons which have registered themselves to work with EE core
+	 *
+	 * @var EE_Addon[] $addons
+	 */
+	public $addons;
+
+	/**
+	 * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
+	 *
+	 * @var EEM_Base[] $models
+	 */
+	public $models = array();
+
+	/**
+	 * @var EED_Module[] $modules
+	 */
+	public $modules;
+
+	/**
+	 * @var EES_Shortcode[] $shortcodes
+	 */
+	public $shortcodes;
+
+	/**
+	 * @var WP_Widget[] $widgets
+	 */
+	public $widgets;
+
+	/**
+	 * this is an array of all implemented model names (i.e. not the parent abstract models, or models
+	 * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
+	 * Keys are model "short names" (eg "Event") as used in model relations, and values are
+	 * classnames (eg "EEM_Event")
+	 *
+	 * @var array $non_abstract_db_models
+	 */
+	public $non_abstract_db_models = array();
+
+	/**
+	 * internationalization for JS strings
+	 *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
+	 *    in js file:  var translatedString = eei18n.string_key;
+	 *
+	 * @var array $i18n_js_strings
+	 */
+	public static $i18n_js_strings = array();
+
+	/**
+	 * $main_file - path to espresso.php
+	 *
+	 * @var array $main_file
+	 */
+	public $main_file;
+
+	/**
+	 * array of ReflectionClass objects where the key is the class name
+	 *
+	 * @deprecated 4.9.62.p
+	 * @var ReflectionClass[] $_reflectors
+	 */
+	public $_reflectors;
+
+	/**
+	 * boolean flag to indicate whether or not to load/save dependencies from/to the cache
+	 *
+	 * @var boolean $_cache_on
+	 */
+	protected $_cache_on = true;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Dependency_Map|null   $dependency_map
+	 * @param Mirror|null              $mirror
+	 * @param ClassInterfaceCache|null $class_cache
+	 * @param ObjectIdentifier|null    $object_identifier
+	 * @return EE_Registry instance
+	 */
+	public static function instance(
+		EE_Dependency_Map $dependency_map = null,
+		Mirror $mirror = null,
+		ClassInterfaceCache $class_cache = null,
+		ObjectIdentifier $object_identifier = null
+	) {
+		// check if class object is instantiated
+		if (
+			! self::$_instance instanceof EE_Registry
+			&& $dependency_map instanceof EE_Dependency_Map
+			&& $mirror instanceof Mirror
+			&& $class_cache instanceof ClassInterfaceCache
+			&& $object_identifier instanceof ObjectIdentifier
+		) {
+			self::$_instance = new self(
+				$dependency_map,
+				$mirror,
+				$class_cache,
+				$object_identifier
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @param  EE_Dependency_Map  $dependency_map
+	 * @param Mirror              $mirror
+	 * @param ClassInterfaceCache $class_cache
+	 * @param ObjectIdentifier    $object_identifier
+	 */
+	protected function __construct(
+		EE_Dependency_Map $dependency_map,
+		Mirror $mirror,
+		ClassInterfaceCache $class_cache,
+		ObjectIdentifier $object_identifier
+	) {
+		$this->_dependency_map = $dependency_map;
+		$this->mirror = $mirror;
+		$this->class_cache = $class_cache;
+		$this->object_identifier = $object_identifier;
+		// $registry_container = new RegistryContainer();
+		$this->LIB = new RegistryContainer();
+		$this->addons = new RegistryContainer();
+		$this->modules = new RegistryContainer();
+		$this->shortcodes = new RegistryContainer();
+		$this->widgets = new RegistryContainer();
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
+	}
+
+
+	/**
+	 * initialize
+	 *
+	 * @throws OutOfBoundsException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize()
+	{
+		$this->_class_abbreviations = apply_filters(
+			'FHEE__EE_Registry____construct___class_abbreviations',
+			array(
+				'EE_Config'                                       => 'CFG',
+				'EE_Session'                                      => 'SSN',
+				'EE_Capabilities'                                 => 'CAP',
+				'EE_Cart'                                         => 'CART',
+				'EE_Network_Config'                               => 'NET_CFG',
+				'EE_Request_Handler'                              => 'REQ',
+				'EE_Message_Resource_Manager'                     => 'MRM',
+				'EventEspresso\core\services\commands\CommandBus' => 'BUS',
+				'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
+			)
+		);
+		$this->load_core('Base', array(), true);
+		// add our request and response objects to the cache
+		$request_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Request'
+		);
+		$this->_set_cached_class(
+			$request_loader(),
+			'EventEspresso\core\services\request\Request'
+		);
+		$response_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Response'
+		);
+		$this->_set_cached_class(
+			$response_loader(),
+			'EventEspresso\core\services\request\Response'
+		);
+		add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function init()
+	{
+		// Get current page protocol
+		$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
+		// Output admin-ajax.php URL with same protocol as current page
+		self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
+		self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
+	}
+
+
+	/**
+	 * localize_i18n_js_strings
+	 *
+	 * @return string
+	 */
+	public static function localize_i18n_js_strings()
+	{
+		$i18n_js_strings = (array) self::$i18n_js_strings;
+		foreach ($i18n_js_strings as $key => $value) {
+			if (is_scalar($value)) {
+				$i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
+			}
+		}
+		return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+	}
+
+
+	/**
+	 * @param mixed string | EED_Module $module
+	 * @throws OutOfBoundsException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_module($module)
+	{
+		if ($module instanceof EED_Module) {
+			$module_class = get_class($module);
+			$this->modules->{$module_class} = $module;
+		} else {
+			if (! class_exists('EE_Module_Request_Router', false)) {
+				$this->load_core('Module_Request_Router');
+			}
+			EE_Module_Request_Router::module_factory($module);
+		}
+	}
+
+
+	/**
+	 * @param string $module_name
+	 * @return mixed EED_Module | NULL
+	 */
+	public function get_module($module_name = '')
+	{
+		return isset($this->modules->{$module_name})
+			? $this->modules->{$module_name}
+			: null;
+	}
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_core($class_name, $arguments = array(), $load_only = false)
+	{
+		$core_paths = apply_filters(
+			'FHEE__EE_Registry__load_core__core_paths',
+			array(
+				EE_CORE,
+				EE_ADMIN,
+				EE_CPTS,
+				EE_CORE . 'data_migration_scripts/',
+				EE_CORE . 'capabilities/',
+				EE_CORE . 'request_stack/',
+				EE_CORE . 'middleware/',
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$core_paths,
+			'EE_',
+			$class_name,
+			'core',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads service classes
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_service($class_name, $arguments = array(), $load_only = false)
+	{
+		$service_paths = apply_filters(
+			'FHEE__EE_Registry__load_service__service_paths',
+			array(
+				EE_CORE . 'services/',
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$service_paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads data_migration_scripts
+	 *
+	 * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
+	 * @param mixed  $arguments
+	 * @return EE_Data_Migration_Script_Base|mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_dms($class_name, $arguments = array())
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
+			'EE_DMS_',
+			$class_name,
+			'dms',
+			$arguments,
+			false,
+			false
+		);
+	}
+
+
+	/**
+	 * loads object creating classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: attendee
+	 * @param mixed  $arguments  - an array of arguments to pass to the class
+	 * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
+	 *                           instantiate
+	 * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
+	 *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
+	 * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
+	 *                           (default)
+	 * @return EE_Base_Class | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
+	{
+		$paths = apply_filters(
+			'FHEE__EE_Registry__load_class__paths',
+			array(
+				EE_CORE,
+				EE_CLASSES,
+				EE_BUSINESS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			$from_db,
+			$cache,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads helper classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEH_Base | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_helper($class_name, $arguments = array(), $load_only = true)
+	{
+		// todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
+		$helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
+		// retrieve instantiated class
+		return $this->_load(
+			$helper_paths,
+			'EEH_',
+			$class_name,
+			'helper',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @param bool   $cache      whether to cache the object or not.
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
+	{
+		$paths = array(
+			EE_LIBRARIES,
+			EE_LIBRARIES . 'messages/',
+			EE_LIBRARIES . 'shortcodes/',
+			EE_LIBRARIES . 'qtips/',
+			EE_LIBRARIES . 'payment_methods/',
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'lib',
+			$arguments,
+			false,
+			$cache,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEM_Base | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_model($class_name, $arguments = array(), $load_only = false)
+	{
+		$paths = apply_filters(
+			'FHEE__EE_Registry__load_model__paths',
+			array(
+				EE_MODELS,
+				EE_CORE,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EEM_',
+			$class_name,
+			'model',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_model_class($class_name, $arguments = array(), $load_only = true)
+	{
+		$paths = array(
+			EE_MODELS . 'fields/',
+			EE_MODELS . 'helpers/',
+			EE_MODELS . 'relations/',
+			EE_MODELS . 'strategies/',
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * Determines if $model_name is the name of an actual EE model.
+	 *
+	 * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
+	 * @return boolean
+	 */
+	public function is_model_name($model_name)
+	{
+		return isset($this->models[ $model_name ]);
+	}
+
+
+	/**
+	 * generic class loader
+	 *
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $file_name    - file name  ie:  my_file.php, including extension
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			$path_to_file,
+			'',
+			$file_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $class_name   - full class name  ie:  My_Class
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|EE_Addon|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			$path_to_file,
+			'addon',
+			$class_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * instantiates, caches, and automatically resolves dependencies
+	 * for classes that use a Fully Qualified Class Name.
+	 * if the class is not capable of being loaded using PSR-4 autoloading,
+	 * then you need to use one of the existing load_*() methods
+	 * which can resolve the classname and filepath from the passed arguments
+	 *
+	 * @param bool|string $class_name   Fully Qualified Class Name
+	 * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
+	 * @return bool|null|mixed          null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function create(
+		$class_name = false,
+		$arguments = array(),
+		$cache = false,
+		$from_db = false,
+		$load_only = false,
+		$addon = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		$class_name = $this->class_cache->getFqnForAlias($class_name);
+		$class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
+		// if a non-FQCN was passed, then
+		// verifyClassExists() might return an object
+		// or it could return null if the class just could not be found anywhere
+		if ($class_exists instanceof $class_name || $class_exists === null) {
+			// either way, return the results
+			return $class_exists;
+		}
+		$class_name = $class_exists;
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only) {
+			return true;
+		}
+		$addon = $addon ? 'addon' : '';
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}// obtain the loader method from the dependency map
+		$loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
+		if ($loader instanceof Closure) {
+			$class_obj = $loader($arguments);
+		} else {
+			if ($loader && method_exists($this, $loader)) {
+				$class_obj = $this->{$loader}($class_name, $arguments);
+			} else {
+				$class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
+			}
+		}
+		if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class(
+				$class_obj,
+				$class_name,
+				$addon,
+				$from_db,
+				$arguments
+			);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+	/**
+	 * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
+	 *
+	 * @param string|object $class_name
+	 * @param array         $arguments
+	 * @param int           $attempt
+	 * @return mixed
+	 */
+	private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1)
+	{
+		if (is_object($class_name) || class_exists($class_name)) {
+			return $class_name;
+		}
+		switch ($attempt) {
+			case 1:
+				// if it's a FQCN then maybe the class is registered with a preceding \
+				$class_name = strpos($class_name, '\\') !== false
+					? '\\' . ltrim($class_name, '\\')
+					: $class_name;
+				break;
+			case 2:
+				//
+				$loader = $this->_dependency_map->class_loader($class_name);
+				if ($loader && method_exists($this, $loader)) {
+					return $this->{$loader}($class_name, $arguments);
+				}
+				break;
+			case 3:
+			default:
+				return null;
+		}
+		$attempt++;
+		return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
+	}
+
+
+	/**
+	 * instantiates, caches, and injects dependencies for classes
+	 *
+	 * @param array       $file_paths   an array of paths to folders to look in
+	 * @param string      $class_prefix EE  or EEM or... ???
+	 * @param bool|string $class_name   $class name
+	 * @param string      $type         file type - core? class? helper? model?
+	 * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @return bool|null|object null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _load(
+		$file_paths = array(),
+		$class_prefix = 'EE_',
+		$class_name = false,
+		$type = 'class',
+		$arguments = array(),
+		$from_db = false,
+		$cache = true,
+		$load_only = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		// strip php file extension
+		$class_name = str_replace('.php', '', trim($class_name));
+		// does the class have a prefix ?
+		if (! empty($class_prefix) && $class_prefix !== 'addon') {
+			// make sure $class_prefix is uppercase
+			$class_prefix = strtoupper(trim($class_prefix));
+			// add class prefix ONCE!!!
+			$class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+		}
+		$class_name = $this->class_cache->getFqnForAlias($class_name);
+		$class_exists = class_exists($class_name, false);
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only && $class_exists) {
+			return true;
+		}
+		$arguments = is_array($arguments) ? $arguments : array($arguments);
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// if the class doesn't already exist.. then we need to try and find the file and load it
+		if (! $class_exists) {
+			// get full path to file
+			$path = $this->_resolve_path($class_name, $type, $file_paths);
+			// load the file
+			$loaded = $this->_require_file($path, $class_name, $type, $file_paths);
+			// if we are only loading a file but NOT instantiating an object
+			// then return boolean for whether class was loaded or not
+			if ($load_only) {
+				return $loaded;
+			}
+			// if an object was expected but loading failed, then return nothing
+			if (! $loaded) {
+				return null;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class(
+				$class_obj,
+				$class_name,
+				$class_prefix,
+				$from_db,
+				$arguments
+			);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $default have to specify something, but not anything that will conflict
+	 * @return mixed|string
+	 */
+	protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
+	{
+		return isset($this->_class_abbreviations[ $class_name ])
+			? $this->_class_abbreviations[ $class_name ]
+			: $default;
+	}
+
+
+	/**
+	 * attempts to find a cached version of the requested class
+	 * by looking in the following places:
+	 *        $this->{$class_abbreviation}            ie:    $this->CART
+	 *        $this->{$class_name}                        ie:    $this->Some_Class
+	 *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
+	 *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	protected function _get_cached_class(
+		$class_name,
+		$class_prefix = '',
+		$arguments = array()
+	) {
+		if ($class_name === 'EE_Registry') {
+			return $this;
+		}
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			return $this->{$class_abbreviation};
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			return $this->{$class_name};
+		}
+		if ($class_prefix === 'addon' && isset($this->addons->{$class_name})) {
+			return $this->addons->{$class_name};
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if (isset($this->LIB->{$object_identifier})) {
+			return $this->LIB->{$object_identifier};
+		}
+		foreach ($this->LIB as $key => $object) {
+			if (
 // request does not contain new arguments and therefore no args identifier
-                ! $this->object_identifier->hasArguments($object_identifier)
-                // but previously cached class with args was found
-                && $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
-            ) {
-                return $object;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * removes a cached version of the requested class
-     *
-     * @param string  $class_name
-     * @param boolean $addon
-     * @param array   $arguments
-     * @return boolean
-     */
-    public function clear_cached_class(
-        $class_name,
-        $addon = false,
-        $arguments = array()
-    ) {
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            $this->{$class_abbreviation} = null;
-            return true;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            $this->{$class_name} = null;
-            return true;
-        }
-        if ($addon && isset($this->addons->{$class_name})) {
-            unset($this->addons->{$class_name});
-            return true;
-        }
-        $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if (isset($this->LIB->{$class_name})) {
-            unset($this->LIB->{$class_name});
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * _set_cached_class
-     * attempts to cache the instantiated class locally
-     * in one of the following places, in the following order:
-     *        $this->{class_abbreviation}   ie:    $this->CART
-     *        $this->{$class_name}          ie:    $this->Some_Class
-     *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
-     *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
-     *
-     * @param object $class_obj
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param bool   $from_db
-     * @param array  $arguments
-     * @return void
-     */
-    protected function _set_cached_class(
-        $class_obj,
-        $class_name,
-        $class_prefix = '',
-        $from_db = false,
-        $arguments = array()
-    ) {
-        if ($class_name === 'EE_Registry' || empty($class_obj)) {
-            return;
-        }
-        // return newly instantiated class
-        $class_abbreviation = $this->get_class_abbreviation($class_name, '');
-        if ($class_abbreviation) {
-            $this->{$class_abbreviation} = $class_obj;
-            return;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (property_exists($this, $class_name)) {
-            $this->{$class_name} = $class_obj;
-            return;
-        }
-        if ($class_prefix === 'addon') {
-            $this->addons->{$class_name} = $class_obj;
-            return;
-        }
-        if (! $from_db) {
-            $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-            $this->LIB->{$class_name} = $class_obj;
-        }
-    }
-
-
-    /**
-     * attempts to find a full valid filepath for the requested class.
-     * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
-     * then returns that path if the target file has been found and is readable
-     *
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return string | bool
-     */
-    protected function _resolve_path($class_name, $type = '', $file_paths = array())
-    {
-        // make sure $file_paths is an array
-        $file_paths = is_array($file_paths)
-            ? $file_paths
-            : array($file_paths);
-        // cycle thru paths
-        foreach ($file_paths as $key => $file_path) {
-            // convert all separators to proper /, if no filepath, then use EE_CLASSES
-            $file_path = $file_path
-                ? str_replace(array('/', '\\'), '/', $file_path)
-                : EE_CLASSES;
-            // prep file type
-            $type = ! empty($type)
-                ? trim($type, '.') . '.'
-                : '';
-            // build full file path
-            $file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
-            // does the file exist and can be read ?
-            if (is_readable($file_paths[ $key ])) {
-                return $file_paths[ $key ];
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * basically just performs a require_once()
-     * but with some error handling
-     *
-     * @param  string $path
-     * @param  string $class_name
-     * @param  string $type
-     * @param  array  $file_paths
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _require_file($path, $class_name, $type = '', $file_paths = array())
-    {
-        $this->resolve_legacy_class_parent($class_name);
-        // don't give up! you gotta...
-        try {
-            // does the file exist and can it be read ?
-            if (! $path) {
-                // just in case the file has already been autoloaded,
-                // but discrepancies in the naming schema are preventing it from
-                // being loaded via one of the EE_Registry::load_*() methods,
-                // then let's try one last hail mary before throwing an exception
-                // and call class_exists() again, but with autoloading turned ON
-                if (class_exists($class_name)) {
-                    return true;
-                }
-                // so sorry, can't find the file
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
-                            'event_espresso'
-                        ),
-                        trim($type, '.'),
-                        $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
-                    )
-                );
-            }
-            // get the file
-            require_once($path);
-            // if the class isn't already declared somewhere
-            if (class_exists($class_name, false) === false) {
-                // so sorry, not a class
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %s file %s does not appear to contain the %s Class.',
-                            'event_espresso'
-                        ),
-                        $type,
-                        $path,
-                        $class_name
-                    )
-                );
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Some of our legacy classes that extended a parent class would simply use a require() statement
-     * before their class declaration in order to ensure that the parent class was loaded.
-     * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
-     * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
-     *
-     * @param string $class_name
-     */
-    protected function resolve_legacy_class_parent($class_name = '')
-    {
-        try {
-            $legacy_parent_class_map = array(
-                'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
-            );
-            if (isset($legacy_parent_class_map[ $class_name ])) {
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
-            }
-        } catch (Exception $exception) {
-        }
-    }
-
-
-    /**
-     * _create_object
-     * Attempts to instantiate the requested class via any of the
-     * commonly used instantiation methods employed throughout EE.
-     * The priority for instantiation is as follows:
-     *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
-     *        - model objects via their 'new_instance_from_db' method
-     *        - model objects via their 'new_instance' method
-     *        - "singleton" classes" via their 'instance' method
-     *    - standard instantiable classes via their __constructor
-     * Prior to instantiation, if the classname exists in the dependency_map,
-     * then the constructor for the requested class will be examined to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     *
-     * @param string $class_name
-     * @param array  $arguments
-     * @param string $type
-     * @param bool   $from_db
-     * @return null|object|bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
-    {
-        // create reflection
-        $reflector = $this->mirror->getReflectionClass($class_name);
-        // make sure arguments are an array
-        $arguments = is_array($arguments)
-            ? $arguments
-            : array($arguments);
-        // and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
-        $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
-            ? $arguments
-            : array($arguments);
-        // attempt to inject dependencies ?
-        if ($this->_dependency_map->has($class_name)) {
-            $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
-        }
-        // instantiate the class if possible
-        if ($reflector->isAbstract()) {
-            // nothing to instantiate, loading file was enough
-            // does not throw an exception so $instantiation_mode is unused
-            // $instantiation_mode = "1) no constructor abstract class";
-            return true;
-        }
-        if (
-            empty($arguments)
-            && $this->mirror->getConstructorFromReflection($reflector) === null
-            && $reflector->isInstantiable()
-        ) {
-            // no constructor = static methods only... nothing to instantiate, loading file was enough
-            // $instantiation_mode = "2) no constructor but instantiable";
-            return $reflector->newInstance();
-        }
-        if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
-            // $instantiation_mode = "3) new_instance_from_db()";
-            return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
-        }
-        if (method_exists($class_name, 'new_instance')) {
-            // $instantiation_mode = "4) new_instance()";
-            return call_user_func_array(array($class_name, 'new_instance'), $arguments);
-        }
-        if (method_exists($class_name, 'instance')) {
-            // $instantiation_mode = "5) instance()";
-            return call_user_func_array(array($class_name, 'instance'), $arguments);
-        }
-        if ($reflector->isInstantiable()) {
-            $args_passed_count = count($arguments);
-            $args_required_count = count($this->mirror->getRequiredParameters($class_name));
-            if ($args_passed_count < $args_required_count) {
-                throw new RuntimeException(
-                    sprintf(
-                        __(
-                            'Invalid arguments supplied for the %1$s class, %2$s were required but %3$s were passed.',
-                            'event_espresso'
-                        ),
-                        $class_name,
-                        $args_required_count,
-                        $args_passed_count
-                    )
-                );
-            }
-            // $instantiation_mode = "6) constructor";
-            return $reflector->newInstanceArgs($arguments);
-        }
-        // heh ? something's not right !
-        throw new EE_Error(
-            sprintf(
-                __('The %s file %s could not be instantiated.', 'event_espresso'),
-                $type,
-                $class_name
-            )
-        );
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    protected function _array_is_numerically_and_sequentially_indexed(array $array)
-    {
-        return ! empty($array)
-            ? array_keys($array) === range(0, count($array) - 1)
-            : true;
-    }
-
-
-    /**
-     * _resolve_dependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @param ReflectionClass $reflector
-     * @param string          $class_name
-     * @param array           $arguments
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, array $arguments = array())
-    {
-        // let's examine the constructor
-        $constructor = $this->mirror->getConstructorFromReflection($reflector);
-        // whu? huh? nothing?
-        if (! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $this->mirror->getParametersFromReflection($reflector);
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all of the constructors expected parameters
-        foreach ($params as $index => $param) {
-            try {
-                // is this a dependency for a specific class ?
-                $param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
-            } catch (ReflectionException $exception) {
-                // uh-oh... most likely a legacy class that has not been autoloaded
-                // let's try to derive the classname from what we have now
-                // and hope that the property var name is close to the class name
-                $param_class = $param->getName();
-                $param_class = str_replace('_', ' ', $param_class);
-                $param_class = ucwords($param_class);
-                $param_class = str_replace(' ', '_', $param_class);
-            }
-            // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
-            $param_class = $this->class_cache->isAlias($param_class, $class_name)
-                ? $this->class_cache->getFqnForAlias($param_class, $class_name)
-                : $param_class;
-            if (
+				! $this->object_identifier->hasArguments($object_identifier)
+				// but previously cached class with args was found
+				&& $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
+			) {
+				return $object;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * removes a cached version of the requested class
+	 *
+	 * @param string  $class_name
+	 * @param boolean $addon
+	 * @param array   $arguments
+	 * @return boolean
+	 */
+	public function clear_cached_class(
+		$class_name,
+		$addon = false,
+		$arguments = array()
+	) {
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			$this->{$class_abbreviation} = null;
+			return true;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			$this->{$class_name} = null;
+			return true;
+		}
+		if ($addon && isset($this->addons->{$class_name})) {
+			unset($this->addons->{$class_name});
+			return true;
+		}
+		$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if (isset($this->LIB->{$class_name})) {
+			unset($this->LIB->{$class_name});
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * _set_cached_class
+	 * attempts to cache the instantiated class locally
+	 * in one of the following places, in the following order:
+	 *        $this->{class_abbreviation}   ie:    $this->CART
+	 *        $this->{$class_name}          ie:    $this->Some_Class
+	 *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
+	 *
+	 * @param object $class_obj
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param bool   $from_db
+	 * @param array  $arguments
+	 * @return void
+	 */
+	protected function _set_cached_class(
+		$class_obj,
+		$class_name,
+		$class_prefix = '',
+		$from_db = false,
+		$arguments = array()
+	) {
+		if ($class_name === 'EE_Registry' || empty($class_obj)) {
+			return;
+		}
+		// return newly instantiated class
+		$class_abbreviation = $this->get_class_abbreviation($class_name, '');
+		if ($class_abbreviation) {
+			$this->{$class_abbreviation} = $class_obj;
+			return;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (property_exists($this, $class_name)) {
+			$this->{$class_name} = $class_obj;
+			return;
+		}
+		if ($class_prefix === 'addon') {
+			$this->addons->{$class_name} = $class_obj;
+			return;
+		}
+		if (! $from_db) {
+			$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+			$this->LIB->{$class_name} = $class_obj;
+		}
+	}
+
+
+	/**
+	 * attempts to find a full valid filepath for the requested class.
+	 * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
+	 * then returns that path if the target file has been found and is readable
+	 *
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return string | bool
+	 */
+	protected function _resolve_path($class_name, $type = '', $file_paths = array())
+	{
+		// make sure $file_paths is an array
+		$file_paths = is_array($file_paths)
+			? $file_paths
+			: array($file_paths);
+		// cycle thru paths
+		foreach ($file_paths as $key => $file_path) {
+			// convert all separators to proper /, if no filepath, then use EE_CLASSES
+			$file_path = $file_path
+				? str_replace(array('/', '\\'), '/', $file_path)
+				: EE_CLASSES;
+			// prep file type
+			$type = ! empty($type)
+				? trim($type, '.') . '.'
+				: '';
+			// build full file path
+			$file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
+			// does the file exist and can be read ?
+			if (is_readable($file_paths[ $key ])) {
+				return $file_paths[ $key ];
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * basically just performs a require_once()
+	 * but with some error handling
+	 *
+	 * @param  string $path
+	 * @param  string $class_name
+	 * @param  string $type
+	 * @param  array  $file_paths
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _require_file($path, $class_name, $type = '', $file_paths = array())
+	{
+		$this->resolve_legacy_class_parent($class_name);
+		// don't give up! you gotta...
+		try {
+			// does the file exist and can it be read ?
+			if (! $path) {
+				// just in case the file has already been autoloaded,
+				// but discrepancies in the naming schema are preventing it from
+				// being loaded via one of the EE_Registry::load_*() methods,
+				// then let's try one last hail mary before throwing an exception
+				// and call class_exists() again, but with autoloading turned ON
+				if (class_exists($class_name)) {
+					return true;
+				}
+				// so sorry, can't find the file
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
+							'event_espresso'
+						),
+						trim($type, '.'),
+						$class_name,
+						'<br />' . implode(',<br />', $file_paths)
+					)
+				);
+			}
+			// get the file
+			require_once($path);
+			// if the class isn't already declared somewhere
+			if (class_exists($class_name, false) === false) {
+				// so sorry, not a class
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %s file %s does not appear to contain the %s Class.',
+							'event_espresso'
+						),
+						$type,
+						$path,
+						$class_name
+					)
+				);
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Some of our legacy classes that extended a parent class would simply use a require() statement
+	 * before their class declaration in order to ensure that the parent class was loaded.
+	 * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
+	 * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
+	 *
+	 * @param string $class_name
+	 */
+	protected function resolve_legacy_class_parent($class_name = '')
+	{
+		try {
+			$legacy_parent_class_map = array(
+				'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
+			);
+			if (isset($legacy_parent_class_map[ $class_name ])) {
+				require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
+			}
+		} catch (Exception $exception) {
+		}
+	}
+
+
+	/**
+	 * _create_object
+	 * Attempts to instantiate the requested class via any of the
+	 * commonly used instantiation methods employed throughout EE.
+	 * The priority for instantiation is as follows:
+	 *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
+	 *        - model objects via their 'new_instance_from_db' method
+	 *        - model objects via their 'new_instance' method
+	 *        - "singleton" classes" via their 'instance' method
+	 *    - standard instantiable classes via their __constructor
+	 * Prior to instantiation, if the classname exists in the dependency_map,
+	 * then the constructor for the requested class will be examined to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 *
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @param string $type
+	 * @param bool   $from_db
+	 * @return null|object|bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
+	{
+		// create reflection
+		$reflector = $this->mirror->getReflectionClass($class_name);
+		// make sure arguments are an array
+		$arguments = is_array($arguments)
+			? $arguments
+			: array($arguments);
+		// and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
+		$arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
+			? $arguments
+			: array($arguments);
+		// attempt to inject dependencies ?
+		if ($this->_dependency_map->has($class_name)) {
+			$arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
+		}
+		// instantiate the class if possible
+		if ($reflector->isAbstract()) {
+			// nothing to instantiate, loading file was enough
+			// does not throw an exception so $instantiation_mode is unused
+			// $instantiation_mode = "1) no constructor abstract class";
+			return true;
+		}
+		if (
+			empty($arguments)
+			&& $this->mirror->getConstructorFromReflection($reflector) === null
+			&& $reflector->isInstantiable()
+		) {
+			// no constructor = static methods only... nothing to instantiate, loading file was enough
+			// $instantiation_mode = "2) no constructor but instantiable";
+			return $reflector->newInstance();
+		}
+		if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
+			// $instantiation_mode = "3) new_instance_from_db()";
+			return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
+		}
+		if (method_exists($class_name, 'new_instance')) {
+			// $instantiation_mode = "4) new_instance()";
+			return call_user_func_array(array($class_name, 'new_instance'), $arguments);
+		}
+		if (method_exists($class_name, 'instance')) {
+			// $instantiation_mode = "5) instance()";
+			return call_user_func_array(array($class_name, 'instance'), $arguments);
+		}
+		if ($reflector->isInstantiable()) {
+			$args_passed_count = count($arguments);
+			$args_required_count = count($this->mirror->getRequiredParameters($class_name));
+			if ($args_passed_count < $args_required_count) {
+				throw new RuntimeException(
+					sprintf(
+						__(
+							'Invalid arguments supplied for the %1$s class, %2$s were required but %3$s were passed.',
+							'event_espresso'
+						),
+						$class_name,
+						$args_required_count,
+						$args_passed_count
+					)
+				);
+			}
+			// $instantiation_mode = "6) constructor";
+			return $reflector->newInstanceArgs($arguments);
+		}
+		// heh ? something's not right !
+		throw new EE_Error(
+			sprintf(
+				__('The %s file %s could not be instantiated.', 'event_espresso'),
+				$type,
+				$class_name
+			)
+		);
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	protected function _array_is_numerically_and_sequentially_indexed(array $array)
+	{
+		return ! empty($array)
+			? array_keys($array) === range(0, count($array) - 1)
+			: true;
+	}
+
+
+	/**
+	 * _resolve_dependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @param ReflectionClass $reflector
+	 * @param string          $class_name
+	 * @param array           $arguments
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, array $arguments = array())
+	{
+		// let's examine the constructor
+		$constructor = $this->mirror->getConstructorFromReflection($reflector);
+		// whu? huh? nothing?
+		if (! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $this->mirror->getParametersFromReflection($reflector);
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all of the constructors expected parameters
+		foreach ($params as $index => $param) {
+			try {
+				// is this a dependency for a specific class ?
+				$param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
+			} catch (ReflectionException $exception) {
+				// uh-oh... most likely a legacy class that has not been autoloaded
+				// let's try to derive the classname from what we have now
+				// and hope that the property var name is close to the class name
+				$param_class = $param->getName();
+				$param_class = str_replace('_', ' ', $param_class);
+				$param_class = ucwords($param_class);
+				$param_class = str_replace(' ', '_', $param_class);
+			}
+			// BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
+			$param_class = $this->class_cache->isAlias($param_class, $class_name)
+				? $this->class_cache->getFqnForAlias($param_class, $class_name)
+				: $param_class;
+			if (
 // param is not even a class
-                $param_class === null
-                // and something already exists in the incoming arguments for this param
-                && array_key_exists($index, $argument_keys)
-                && array_key_exists($argument_keys[ $index ], $arguments)
-            ) {
-                // so let's skip this argument and move on to the next
-                continue;
-            }
-            if (
+				$param_class === null
+				// and something already exists in the incoming arguments for this param
+				&& array_key_exists($index, $argument_keys)
+				&& array_key_exists($argument_keys[ $index ], $arguments)
+			) {
+				// so let's skip this argument and move on to the next
+				continue;
+			}
+			if (
 // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
-                $param_class !== null
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
-            ) {
-                // skip this argument and move on to the next
-                continue;
-            }
-            if (
+				$param_class !== null
+				&& isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
+				&& $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+			) {
+				// skip this argument and move on to the next
+				continue;
+			}
+			if (
 // parameter is type hinted as a class, and should be injected
-                $param_class !== null
-                && $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
-            ) {
-                $arguments = $this->_resolve_dependency(
-                    $class_name,
-                    $param_class,
-                    $arguments,
-                    $index
-                );
-            }
-            if (empty($arguments[ $index ])) {
-                $arguments[ $index ] = $this->mirror->getParameterDefaultValue(
-                    $param,
-                    $class_name,
-                    $index
-                );
-            }
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $param_class
-     * @param array  $arguments
-     * @param mixed  $index
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
-    {
-        $dependency = null;
-        // should dependency be loaded from cache ?
-        $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
-            $class_name,
-            $param_class
-        );
-        $cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
-        // we might have a dependency...
-        // let's MAYBE try and find it in our cache if that's what's been requested
-        $cached_class = $cache_on
-            ? $this->_get_cached_class($param_class)
-            : null;
-        // and grab it if it exists
-        if ($cached_class instanceof $param_class) {
-            $dependency = $cached_class;
-        } elseif ($param_class !== $class_name) {
-            // obtain the loader method from the dependency map
-            $loader = $this->_dependency_map->class_loader($param_class);
-            // is loader a custom closure ?
-            if ($loader instanceof Closure) {
-                $dependency = $loader($arguments);
-            } else {
-                // set the cache on property for the recursive loading call
-                $this->_cache_on = $cache_on;
-                // if not, then let's try and load it via the registry
-                if ($loader && method_exists($this, $loader)) {
-                    $dependency = $this->{$loader}($param_class);
-                } else {
-                    $dependency = LoaderFactory::getLoader()->load(
-                        $param_class,
-                        array(),
-                        $cache_on
-                    );
-                }
-            }
-        }
-        // did we successfully find the correct dependency ?
-        if ($dependency instanceof $param_class) {
-            // then let's inject it into the incoming array of arguments at the correct location
-            $arguments[ $index ] = $dependency;
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
-     *
-     * @param string $classname PLEASE NOTE: the class name needs to match what's registered
-     *                          in the EE_Dependency_Map::$_class_loaders array,
-     *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
-     * @param array  $arguments
-     * @return object
-     */
-    public static function factory($classname, $arguments = array())
-    {
-        $loader = self::instance()->_dependency_map->class_loader($classname);
-        if ($loader instanceof Closure) {
-            return $loader($arguments);
-        }
-        if (method_exists(self::instance(), $loader)) {
-            return self::instance()->{$loader}($classname, $arguments);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the addon by its class name
-     *
-     * @param string $class_name
-     * @return EE_Addon
-     */
-    public function getAddon($class_name)
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->addons->{$class_name})) {
-            return $this->addons->{$class_name};
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * removes the addon from the internal cache
-     *
-     * @param string $class_name
-     * @return void
-     */
-    public function removeAddon($class_name)
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        unset($this->addons->{$class_name});
-    }
-
-
-    /**
-     * Gets the addon by its name/slug (not classname. For that, just
-     * use the get_addon() method above
-     *
-     * @param string $name
-     * @return EE_Addon
-     */
-    public function get_addon_by_name($name)
-    {
-        foreach ($this->addons as $addon) {
-            if ($addon->name() === $name) {
-                return $addon;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets an array of all the registered addons, where the keys are their names.
-     * (ie, what each returns for their name() function)
-     * They're already available on EE_Registry::instance()->addons as properties,
-     * where each property's name is the addon's classname,
-     * So if you just want to get the addon by classname,
-     * OR use the get_addon() method above.
-     * PLEASE  NOTE:
-     * addons with Fully Qualified Class Names
-     * have had the namespace separators converted to underscores,
-     * so a classname like Fully\Qualified\ClassName
-     * would have been converted to Fully_Qualified_ClassName
-     *
-     * @return EE_Addon[] where the KEYS are the addon's name()
-     */
-    public function get_addons_by_name()
-    {
-        $addons = array();
-        foreach ($this->addons as $addon) {
-            $addons[ $addon->name() ] = $addon;
-        }
-        return $addons;
-    }
-
-
-    /**
-     * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
-     * a stale copy of it around
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function reset_model($model_name)
-    {
-        $model_class_name = strpos($model_name, 'EEM_') !== 0
-            ? "EEM_{$model_name}"
-            : $model_name;
-        if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
-            return null;
-        }
-        // get that model reset it and make sure we nuke the old reference to it
-        if (
-            $this->LIB->{$model_class_name} instanceof $model_class_name
-            && is_callable(
-                array($model_class_name, 'reset')
-            )
-        ) {
-            $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
-                    $model_name
-                )
-            );
-        }
-        return $this->LIB->{$model_class_name};
-    }
-
-
-    /**
-     * Resets the registry.
-     * The criteria for what gets reset is based on what can be shared between sites on the same request when
-     * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
-     * - $_dependency_map
-     * - $_class_abbreviations
-     * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
-     * - $REQ:  Still on the same request so no need to change.
-     * - $CAP: There is no site specific state in the EE_Capability class.
-     * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
-     * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
-     * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
-     *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
-     *             switch or on the restore.
-     * - $modules
-     * - $shortcodes
-     * - $widgets
-     *
-     * @param boolean $hard             [deprecated]
-     * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
-     *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
-     *                                  sure if you CAN currently reinstantiate the singletons at the moment)
-     * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
-     *                                  client
-     *                                  code instead can just change the model context to a different blog id if
-     *                                  necessary
-     * @return EE_Registry
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
-    {
-        $instance = self::instance();
-        $instance->_cache_on = true;
-        // reset some "special" classes
-        EEH_Activation::reset();
-        EEH_DTT_Helper::resetDefaultTimezoneString();
-
-        $hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
-        $instance->CFG = EE_Config::reset($hard, $reinstantiate);
-        $instance->CART = null;
-        $instance->MRM = null;
-        $instance->AssetsRegistry = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\assets\Registry'
-        );
-        // messages reset
-        EED_Messages::reset();
-        // handle of objects cached on LIB
-        foreach (array('LIB', 'modules') as $cache) {
-            foreach ($instance->{$cache} as $class_name => $class) {
-                if (self::_reset_and_unset_object($class, $reset_models)) {
-                    unset($instance->{$cache}->{$class_name});
-                }
-            }
-        }
-        return $instance;
-    }
-
-
-    /**
-     * if passed object implements ResettableInterface, then call it's reset() method
-     * if passed object implements InterminableInterface, then return false,
-     * to indicate that it should NOT be cleared from the Registry cache
-     *
-     * @param      $object
-     * @param bool $reset_models
-     * @return bool returns true if cached object should be unset
-     */
-    private static function _reset_and_unset_object($object, $reset_models)
-    {
-        if (! is_object($object)) {
-            // don't unset anything that's not an object
-            return false;
-        }
-        if ($object instanceof EED_Module) {
-            $object::reset();
-            // don't unset modules
-            return false;
-        }
-        if ($object instanceof ResettableInterface) {
-            if ($object instanceof EEM_Base) {
-                if ($reset_models) {
-                    $object->reset();
-                    return true;
-                }
-                return false;
-            }
-            $object->reset();
-            return true;
-        }
-        if (! $object instanceof InterminableInterface) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets all the custom post type models defined
-     *
-     * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
-     */
-    public function cpt_models()
-    {
-        $cpt_models = array();
-        foreach ($this->non_abstract_db_models as $short_name => $classname) {
-            if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[ $short_name ] = $classname;
-            }
-        }
-        return $cpt_models;
-    }
-
-
-    /**
-     * @return \EE_Config
-     */
-    public static function CFG()
-    {
-        return self::instance()->CFG;
-    }
-
-
-    /**
-     * @deprecated 4.9.62.p
-     * @param string $class_name
-     * @return ReflectionClass
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    public function get_ReflectionClass($class_name)
-    {
-        return $this->mirror->getReflectionClass($class_name);
-    }
+				$param_class !== null
+				&& $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
+			) {
+				$arguments = $this->_resolve_dependency(
+					$class_name,
+					$param_class,
+					$arguments,
+					$index
+				);
+			}
+			if (empty($arguments[ $index ])) {
+				$arguments[ $index ] = $this->mirror->getParameterDefaultValue(
+					$param,
+					$class_name,
+					$index
+				);
+			}
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $param_class
+	 * @param array  $arguments
+	 * @param mixed  $index
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
+	{
+		$dependency = null;
+		// should dependency be loaded from cache ?
+		$cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
+			$class_name,
+			$param_class
+		);
+		$cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
+		// we might have a dependency...
+		// let's MAYBE try and find it in our cache if that's what's been requested
+		$cached_class = $cache_on
+			? $this->_get_cached_class($param_class)
+			: null;
+		// and grab it if it exists
+		if ($cached_class instanceof $param_class) {
+			$dependency = $cached_class;
+		} elseif ($param_class !== $class_name) {
+			// obtain the loader method from the dependency map
+			$loader = $this->_dependency_map->class_loader($param_class);
+			// is loader a custom closure ?
+			if ($loader instanceof Closure) {
+				$dependency = $loader($arguments);
+			} else {
+				// set the cache on property for the recursive loading call
+				$this->_cache_on = $cache_on;
+				// if not, then let's try and load it via the registry
+				if ($loader && method_exists($this, $loader)) {
+					$dependency = $this->{$loader}($param_class);
+				} else {
+					$dependency = LoaderFactory::getLoader()->load(
+						$param_class,
+						array(),
+						$cache_on
+					);
+				}
+			}
+		}
+		// did we successfully find the correct dependency ?
+		if ($dependency instanceof $param_class) {
+			// then let's inject it into the incoming array of arguments at the correct location
+			$arguments[ $index ] = $dependency;
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
+	 *
+	 * @param string $classname PLEASE NOTE: the class name needs to match what's registered
+	 *                          in the EE_Dependency_Map::$_class_loaders array,
+	 *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
+	 * @param array  $arguments
+	 * @return object
+	 */
+	public static function factory($classname, $arguments = array())
+	{
+		$loader = self::instance()->_dependency_map->class_loader($classname);
+		if ($loader instanceof Closure) {
+			return $loader($arguments);
+		}
+		if (method_exists(self::instance(), $loader)) {
+			return self::instance()->{$loader}($classname, $arguments);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the addon by its class name
+	 *
+	 * @param string $class_name
+	 * @return EE_Addon
+	 */
+	public function getAddon($class_name)
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->addons->{$class_name})) {
+			return $this->addons->{$class_name};
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * removes the addon from the internal cache
+	 *
+	 * @param string $class_name
+	 * @return void
+	 */
+	public function removeAddon($class_name)
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		unset($this->addons->{$class_name});
+	}
+
+
+	/**
+	 * Gets the addon by its name/slug (not classname. For that, just
+	 * use the get_addon() method above
+	 *
+	 * @param string $name
+	 * @return EE_Addon
+	 */
+	public function get_addon_by_name($name)
+	{
+		foreach ($this->addons as $addon) {
+			if ($addon->name() === $name) {
+				return $addon;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets an array of all the registered addons, where the keys are their names.
+	 * (ie, what each returns for their name() function)
+	 * They're already available on EE_Registry::instance()->addons as properties,
+	 * where each property's name is the addon's classname,
+	 * So if you just want to get the addon by classname,
+	 * OR use the get_addon() method above.
+	 * PLEASE  NOTE:
+	 * addons with Fully Qualified Class Names
+	 * have had the namespace separators converted to underscores,
+	 * so a classname like Fully\Qualified\ClassName
+	 * would have been converted to Fully_Qualified_ClassName
+	 *
+	 * @return EE_Addon[] where the KEYS are the addon's name()
+	 */
+	public function get_addons_by_name()
+	{
+		$addons = array();
+		foreach ($this->addons as $addon) {
+			$addons[ $addon->name() ] = $addon;
+		}
+		return $addons;
+	}
+
+
+	/**
+	 * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
+	 * a stale copy of it around
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function reset_model($model_name)
+	{
+		$model_class_name = strpos($model_name, 'EEM_') !== 0
+			? "EEM_{$model_name}"
+			: $model_name;
+		if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
+			return null;
+		}
+		// get that model reset it and make sure we nuke the old reference to it
+		if (
+			$this->LIB->{$model_class_name} instanceof $model_class_name
+			&& is_callable(
+				array($model_class_name, 'reset')
+			)
+		) {
+			$this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
+					$model_name
+				)
+			);
+		}
+		return $this->LIB->{$model_class_name};
+	}
+
+
+	/**
+	 * Resets the registry.
+	 * The criteria for what gets reset is based on what can be shared between sites on the same request when
+	 * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
+	 * - $_dependency_map
+	 * - $_class_abbreviations
+	 * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
+	 * - $REQ:  Still on the same request so no need to change.
+	 * - $CAP: There is no site specific state in the EE_Capability class.
+	 * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
+	 * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
+	 * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
+	 *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
+	 *             switch or on the restore.
+	 * - $modules
+	 * - $shortcodes
+	 * - $widgets
+	 *
+	 * @param boolean $hard             [deprecated]
+	 * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
+	 *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
+	 *                                  sure if you CAN currently reinstantiate the singletons at the moment)
+	 * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
+	 *                                  client
+	 *                                  code instead can just change the model context to a different blog id if
+	 *                                  necessary
+	 * @return EE_Registry
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
+	{
+		$instance = self::instance();
+		$instance->_cache_on = true;
+		// reset some "special" classes
+		EEH_Activation::reset();
+		EEH_DTT_Helper::resetDefaultTimezoneString();
+
+		$hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
+		$instance->CFG = EE_Config::reset($hard, $reinstantiate);
+		$instance->CART = null;
+		$instance->MRM = null;
+		$instance->AssetsRegistry = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\assets\Registry'
+		);
+		// messages reset
+		EED_Messages::reset();
+		// handle of objects cached on LIB
+		foreach (array('LIB', 'modules') as $cache) {
+			foreach ($instance->{$cache} as $class_name => $class) {
+				if (self::_reset_and_unset_object($class, $reset_models)) {
+					unset($instance->{$cache}->{$class_name});
+				}
+			}
+		}
+		return $instance;
+	}
+
+
+	/**
+	 * if passed object implements ResettableInterface, then call it's reset() method
+	 * if passed object implements InterminableInterface, then return false,
+	 * to indicate that it should NOT be cleared from the Registry cache
+	 *
+	 * @param      $object
+	 * @param bool $reset_models
+	 * @return bool returns true if cached object should be unset
+	 */
+	private static function _reset_and_unset_object($object, $reset_models)
+	{
+		if (! is_object($object)) {
+			// don't unset anything that's not an object
+			return false;
+		}
+		if ($object instanceof EED_Module) {
+			$object::reset();
+			// don't unset modules
+			return false;
+		}
+		if ($object instanceof ResettableInterface) {
+			if ($object instanceof EEM_Base) {
+				if ($reset_models) {
+					$object->reset();
+					return true;
+				}
+				return false;
+			}
+			$object->reset();
+			return true;
+		}
+		if (! $object instanceof InterminableInterface) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets all the custom post type models defined
+	 *
+	 * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
+	 */
+	public function cpt_models()
+	{
+		$cpt_models = array();
+		foreach ($this->non_abstract_db_models as $short_name => $classname) {
+			if (is_subclass_of($classname, 'EEM_CPT_Base')) {
+				$cpt_models[ $short_name ] = $classname;
+			}
+		}
+		return $cpt_models;
+	}
+
+
+	/**
+	 * @return \EE_Config
+	 */
+	public static function CFG()
+	{
+		return self::instance()->CFG;
+	}
+
+
+	/**
+	 * @deprecated 4.9.62.p
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	public function get_ReflectionClass($class_name)
+	{
+		return $this->mirror->getReflectionClass($class_name);
+	}
 }

core/domain/entities/DbSafeDateTime.php

Indentation +190 added lines, -190 removed lines

@@ -20,194 +20,194 @@
 class DbSafeDateTime extends DateTime
 {
 
-    // phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
-    /**
-     * @type string db_safe_timestamp_format
-     */
-    const db_safe_timestamp_format = 'Y-m-d H:i:s O e';
-
-    // phpcs:enable
-
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    /**
-     * DateTime object converted to a string that includes the date, time, UTC offset, and timezone identifier
-     *
-     * @type string $_datetime_string
-     */
-    protected $_datetime_string = '';
-
-    /**
-     * where to write the error log to
-     *
-     * @type string $_error_log_dir
-     */
-    protected $_error_log_dir = '';
-
-    // phpcs:enable
-
-
-    /**
-     * @param string $error_log_dir
-     */
-    public function setErrorLogDir($error_log_dir)
-    {
-        // if the folder path is writable, then except the path + filename, else keep empty
-        $this->_error_log_dir = is_writable(str_replace(basename($error_log_dir), '', $error_log_dir))
-            ? $error_log_dir
-            : '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->format(DbSafeDateTime::db_safe_timestamp_format);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function __sleep()
-    {
-        $this->_datetime_string = $this->format(DbSafeDateTime::db_safe_timestamp_format);
-        $date                   = DateTime::createFromFormat(
-            DbSafeDateTime::db_safe_timestamp_format,
-            $this->_datetime_string
-        );
-        if (! $date instanceof DateTime) {
-            try {
-                // we want a stack trace to determine where the malformed date came from, so...
-                throw new DomainException('');
-            } catch (DomainException $e) {
-                $stack_trace = $e->getTraceAsString();
-            }
-            $this->writeToErrorLog(
-                sprintf(
-                    __(
-                        'A valid DateTime could not be generated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s %2$s Stack Trace: %5$s',
-                        'event_espresso'
-                    ),
-                    $this->_datetime_string,
-                    '<br />',
-                    print_r(DateTime::getLastErrors(), true),
-                    PHP_VERSION,
-                    $stack_trace
-                )
-            );
-        }
-        return ['_datetime_string'];
-    }
-
-
-    /**
-     * if an empty or null value got saved to the db for a datetime,
-     * then some servers and/or PHP itself will incorrectly convert that date string
-     * resulting in "-0001-11-30" for the year-month-day.
-     * see the Notes section
-     *
-     * @throws Exception
-     * @link http://php.net/manual/en/datetime.formats.date.php
-     * We'll replace those with "0000-00-00" which will allow a valid DateTime object to be created,
-     * but still result in the internal date for that object being set to "-0001-11-30 10:00:00.000000".
-     * so we're no better off, but at least things won't go fatal on us.
-     */
-    public function __wakeup()
-    {
-        $date = self::createFromFormat(
-            DbSafeDateTime::db_safe_timestamp_format,
-            $this->_datetime_string
-        );
-        if (! $date instanceof DateTime) {
-            $this->writeToErrorLog(
-                sprintf(
-                    __(
-                        'A valid DateTime could not be recreated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s',
-                        'event_espresso'
-                    ),
-                    $this->_datetime_string,
-                    '<br />',
-                    print_r(DateTime::getLastErrors(), true),
-                    PHP_VERSION
-                )
-            );
-        } else {
-            $this->__construct(
-                $date->format(EE_Datetime_Field::mysql_timestamp_format),
-                new DateTimeZone($date->format('e'))
-            );
-        }
-    }
-
-
-    /**
-     * Normalizes incoming date string so that it is a bit more stable for use.
-     *
-     * @param string $date_string
-     * @return string
-     */
-    public static function normalizeInvalidDate($date_string)
-    {
-        return str_replace(
-            ['-0001-11-29', '-0001-11-30', '0000-00-00'],
-            '0000-01-03',
-            $date_string
-        );
-    }
-
-
-    /**
-     * Creates a DbSafeDateTime from ye old DateTime
-     *
-     * @param DateTime $datetime
-     * @return DbSafeDateTime
-     * @throws Exception
-     */
-    public static function createFromDateTime(DateTime $datetime)
-    {
-        return new DbSafeDateTime(
-            $datetime->format(EE_Datetime_Field::mysql_timestamp_format),
-            new DateTimeZone($datetime->format('e'))
-        );
-    }
-
-
-    /**
-     * Parse a string into a new DateTime object according to the specified format
-     *
-     * @param string            $format   Format accepted by date().
-     * @param string            $time     String representing the time.
-     * @param DateTimeZone|null $timezone A DateTimeZone object representing the desired time zone.
-     * @return DbSafeDateTime|boolean
-     * @throws Exception
-     * @link https://php.net/manual/en/datetime.createfromformat.php
-     */
-    public static function createFromFormat($format, $time, DateTimeZone $timezone = null)
-    {
-        $time = self::normalizeInvalidDate($time);
-        // Various php versions handle the third argument differently.  This conditional accounts for that.
-        $DateTime = $timezone instanceof DateTimeZone
-            ? parent::createFromFormat($format, $time, $timezone)
-            : parent::createFromFormat($format, $time);
-        return $DateTime instanceof DateTime
-            ? self::createFromDateTime($DateTime)
-            : $DateTime;
-    }
-
-
-    /**
-     * @param string $message
-     */
-    private function writeToErrorLog($message)
-    {
-        if (! empty($this->_error_log_dir)) {
-            /** @noinspection ForgottenDebugOutputInspection */
-            error_log($message, 3, $this->_error_log_dir);
-        } else {
-            /** @noinspection ForgottenDebugOutputInspection */
-            error_log($message);
-        }
-    }
+	// phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
+	/**
+	 * @type string db_safe_timestamp_format
+	 */
+	const db_safe_timestamp_format = 'Y-m-d H:i:s O e';
+
+	// phpcs:enable
+
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	/**
+	 * DateTime object converted to a string that includes the date, time, UTC offset, and timezone identifier
+	 *
+	 * @type string $_datetime_string
+	 */
+	protected $_datetime_string = '';
+
+	/**
+	 * where to write the error log to
+	 *
+	 * @type string $_error_log_dir
+	 */
+	protected $_error_log_dir = '';
+
+	// phpcs:enable
+
+
+	/**
+	 * @param string $error_log_dir
+	 */
+	public function setErrorLogDir($error_log_dir)
+	{
+		// if the folder path is writable, then except the path + filename, else keep empty
+		$this->_error_log_dir = is_writable(str_replace(basename($error_log_dir), '', $error_log_dir))
+			? $error_log_dir
+			: '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->format(DbSafeDateTime::db_safe_timestamp_format);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$this->_datetime_string = $this->format(DbSafeDateTime::db_safe_timestamp_format);
+		$date                   = DateTime::createFromFormat(
+			DbSafeDateTime::db_safe_timestamp_format,
+			$this->_datetime_string
+		);
+		if (! $date instanceof DateTime) {
+			try {
+				// we want a stack trace to determine where the malformed date came from, so...
+				throw new DomainException('');
+			} catch (DomainException $e) {
+				$stack_trace = $e->getTraceAsString();
+			}
+			$this->writeToErrorLog(
+				sprintf(
+					__(
+						'A valid DateTime could not be generated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s %2$s Stack Trace: %5$s',
+						'event_espresso'
+					),
+					$this->_datetime_string,
+					'<br />',
+					print_r(DateTime::getLastErrors(), true),
+					PHP_VERSION,
+					$stack_trace
+				)
+			);
+		}
+		return ['_datetime_string'];
+	}
+
+
+	/**
+	 * if an empty or null value got saved to the db for a datetime,
+	 * then some servers and/or PHP itself will incorrectly convert that date string
+	 * resulting in "-0001-11-30" for the year-month-day.
+	 * see the Notes section
+	 *
+	 * @throws Exception
+	 * @link http://php.net/manual/en/datetime.formats.date.php
+	 * We'll replace those with "0000-00-00" which will allow a valid DateTime object to be created,
+	 * but still result in the internal date for that object being set to "-0001-11-30 10:00:00.000000".
+	 * so we're no better off, but at least things won't go fatal on us.
+	 */
+	public function __wakeup()
+	{
+		$date = self::createFromFormat(
+			DbSafeDateTime::db_safe_timestamp_format,
+			$this->_datetime_string
+		);
+		if (! $date instanceof DateTime) {
+			$this->writeToErrorLog(
+				sprintf(
+					__(
+						'A valid DateTime could not be recreated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s',
+						'event_espresso'
+					),
+					$this->_datetime_string,
+					'<br />',
+					print_r(DateTime::getLastErrors(), true),
+					PHP_VERSION
+				)
+			);
+		} else {
+			$this->__construct(
+				$date->format(EE_Datetime_Field::mysql_timestamp_format),
+				new DateTimeZone($date->format('e'))
+			);
+		}
+	}
+
+
+	/**
+	 * Normalizes incoming date string so that it is a bit more stable for use.
+	 *
+	 * @param string $date_string
+	 * @return string
+	 */
+	public static function normalizeInvalidDate($date_string)
+	{
+		return str_replace(
+			['-0001-11-29', '-0001-11-30', '0000-00-00'],
+			'0000-01-03',
+			$date_string
+		);
+	}
+
+
+	/**
+	 * Creates a DbSafeDateTime from ye old DateTime
+	 *
+	 * @param DateTime $datetime
+	 * @return DbSafeDateTime
+	 * @throws Exception
+	 */
+	public static function createFromDateTime(DateTime $datetime)
+	{
+		return new DbSafeDateTime(
+			$datetime->format(EE_Datetime_Field::mysql_timestamp_format),
+			new DateTimeZone($datetime->format('e'))
+		);
+	}
+
+
+	/**
+	 * Parse a string into a new DateTime object according to the specified format
+	 *
+	 * @param string            $format   Format accepted by date().
+	 * @param string            $time     String representing the time.
+	 * @param DateTimeZone|null $timezone A DateTimeZone object representing the desired time zone.
+	 * @return DbSafeDateTime|boolean
+	 * @throws Exception
+	 * @link https://php.net/manual/en/datetime.createfromformat.php
+	 */
+	public static function createFromFormat($format, $time, DateTimeZone $timezone = null)
+	{
+		$time = self::normalizeInvalidDate($time);
+		// Various php versions handle the third argument differently.  This conditional accounts for that.
+		$DateTime = $timezone instanceof DateTimeZone
+			? parent::createFromFormat($format, $time, $timezone)
+			: parent::createFromFormat($format, $time);
+		return $DateTime instanceof DateTime
+			? self::createFromDateTime($DateTime)
+			: $DateTime;
+	}
+
+
+	/**
+	 * @param string $message
+	 */
+	private function writeToErrorLog($message)
+	{
+		if (! empty($this->_error_log_dir)) {
+			/** @noinspection ForgottenDebugOutputInspection */
+			error_log($message, 3, $this->_error_log_dir);
+		} else {
+			/** @noinspection ForgottenDebugOutputInspection */
+			error_log($message);
+		}
+	}
 }

core/db_classes/EE_Line_Item.class.php

Indentation +1744 added lines, -1744 removed lines

@@ -14,1748 +14,1748 @@
 class EE_Line_Item extends EE_Base_Class implements EEI_Line_Item
 {
 
-    /**
-     * for children line items (currently not a normal relation)
-     *
-     * @type EE_Line_Item[]
-     */
-    protected $_children = array();
-
-    /**
-     * for the parent line item
-     *
-     * @var EE_Line_Item
-     */
-    protected $_parent;
-
-
-    /**
-     * @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_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '', $date_formats = array())
-    {
-        $has_object = parent::_check_for_object(
-            $props_n_values,
-            __CLASS__,
-            $timezone,
-            $date_formats
-        );
-        return $has_object
-            ? $has_object
-            : new self($props_n_values, false, $timezone);
-    }
-
-
-    /**
-     * @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_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Adds some defaults if they're not specified
-     *
-     * @param array  $fieldValues
-     * @param bool   $bydb
-     * @param string $timezone
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
-    {
-        parent::__construct($fieldValues, $bydb, $timezone);
-        if (! $this->get('LIN_code')) {
-            $this->set_code($this->generate_code());
-        }
-    }
-
-
-    /**
-     * Gets ID
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ID()
-    {
-        return $this->get('LIN_ID');
-    }
-
-
-    /**
-     * Gets TXN_ID
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * Sets TXN_ID
-     *
-     * @param int $TXN_ID
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_TXN_ID($TXN_ID)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function name()
-    {
-        $name = $this->get('LIN_name');
-        if (! $name) {
-            $name = ucwords(str_replace('-', ' ', $this->type()));
-        }
-        return $name;
-    }
-
-
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_name($name)
-    {
-        $this->set('LIN_name', $name);
-    }
-
-
-    /**
-     * Gets desc
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function desc()
-    {
-        return $this->get('LIN_desc');
-    }
-
-
-    /**
-     * Sets desc
-     *
-     * @param string $desc
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_desc($desc)
-    {
-        $this->set('LIN_desc', $desc);
-    }
-
-
-    /**
-     * Gets quantity
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function quantity()
-    {
-        return $this->get('LIN_quantity');
-    }
-
-
-    /**
-     * Sets quantity
-     *
-     * @param int $quantity
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_quantity($quantity)
-    {
-        $this->set('LIN_quantity', max($quantity, 0));
-    }
-
-
-    /**
-     * Gets item_id
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function OBJ_ID()
-    {
-        return $this->get('OBJ_ID');
-    }
-
-
-    /**
-     * Sets item_id
-     *
-     * @param string $item_id
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_OBJ_ID($item_id)
-    {
-        $this->set('OBJ_ID', $item_id);
-    }
-
-
-    /**
-     * Gets item_type
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function OBJ_type()
-    {
-        return $this->get('OBJ_type');
-    }
-
-
-    /**
-     * Gets item_type
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function OBJ_type_i18n()
-    {
-        $obj_type = $this->OBJ_type();
-        switch ($obj_type) {
-            case EEM_Line_Item::OBJ_TYPE_EVENT:
-                $obj_type = esc_html__('Event', 'event_espresso');
-                break;
-            case EEM_Line_Item::OBJ_TYPE_PRICE:
-                $obj_type = esc_html__('Price', 'event_espresso');
-                break;
-            case EEM_Line_Item::OBJ_TYPE_PROMOTION:
-                $obj_type = esc_html__('Promotion', 'event_espresso');
-                break;
-            case EEM_Line_Item::OBJ_TYPE_TICKET:
-                $obj_type = esc_html__('Ticket', 'event_espresso');
-                break;
-            case EEM_Line_Item::OBJ_TYPE_TRANSACTION:
-                $obj_type = esc_html__('Transaction', 'event_espresso');
-                break;
-        }
-        return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this);
-    }
-
-
-    /**
-     * Sets item_type
-     *
-     * @param string $OBJ_type
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_OBJ_type($OBJ_type)
-    {
-        $this->set('OBJ_type', $OBJ_type);
-    }
-
-
-    /**
-     * Gets unit_price
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function unit_price()
-    {
-        return $this->get('LIN_unit_price');
-    }
-
-
-    /**
-     * Sets unit_price
-     *
-     * @param float $unit_price
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_unit_price($unit_price)
-    {
-        $this->set('LIN_unit_price', $unit_price);
-    }
-
-
-    /**
-     * Checks if this item is a percentage modifier or not
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_percent()
-    {
-        if ($this->is_tax_sub_total()) {
-            // tax subtotals HAVE a percent on them, that percentage only applies
-            // to taxable items, so its' an exception. Treat it like a flat line item
-            return false;
-        }
-        $unit_price = abs($this->get('LIN_unit_price'));
-        $percent = abs($this->get('LIN_percent'));
-        if ($unit_price < .001 && $percent) {
-            return true;
-        }
-        if ($unit_price >= .001 && ! $percent) {
-            return false;
-        }
-        if ($unit_price >= .001 && $percent) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'A Line Item can not have a unit price of (%s) AND a percent (%s)!',
-                        'event_espresso'
-                    ),
-                    $unit_price,
-                    $percent
-                )
-            );
-        }
-        // if they're both 0, assume its not a percent item
-        return false;
-    }
-
-
-    /**
-     * Gets percent (between 100-.001)
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function percent()
-    {
-        return $this->get('LIN_percent');
-    }
-
-
-    /**
-     * Sets percent (between 100-0.01)
-     *
-     * @param float $percent
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_percent($percent)
-    {
-        $this->set('LIN_percent', $percent);
-    }
-
-
-    /**
-     * Gets total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total()
-    {
-        return $this->get('LIN_total');
-    }
-
-
-    /**
-     * Sets total
-     *
-     * @param float $total
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_total($total)
-    {
-        $this->set('LIN_total', $total);
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function order()
-    {
-        return $this->get('LIN_order');
-    }
-
-
-    /**
-     * Sets order
-     *
-     * @param int $order
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_order($order)
-    {
-        $this->set('LIN_order', $order);
-    }
-
-
-    /**
-     * Gets parent
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function parent_ID()
-    {
-        return $this->get('LIN_parent');
-    }
-
-
-    /**
-     * Sets parent
-     *
-     * @param int $parent
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_parent_ID($parent)
-    {
-        $this->set('LIN_parent', $parent);
-    }
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function type()
-    {
-        return $this->get('LIN_type');
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_type($type)
-    {
-        $this->set('LIN_type', $type);
-    }
-
-
-    /**
-     * Gets the line item of which this item is a composite. Eg, if this is a subtotal, the parent might be a total\
-     * If this line item is saved to the DB, fetches the parent from the DB. However, if this line item isn't in the DB
-     * it uses its cached reference to its parent line item (which would have been set by `EE_Line_Item::set_parent()`
-     * or indirectly by `EE_Line_item::add_child_line_item()`)
-     *
-     * @return EE_Base_Class|EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function parent()
-    {
-        return $this->ID()
-            ? $this->get_model()->get_one_by_ID($this->parent_ID())
-            : $this->_parent;
-    }
-
-
-    /**
-     * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
-     *
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function children()
-    {
-        if ($this->ID()) {
-            return $this->get_model()->get_all(
-                array(
-                    array('LIN_parent' => $this->ID()),
-                    'order_by' => array('LIN_order' => 'ASC'),
-                )
-            );
-        }
-        if (! is_array($this->_children)) {
-            $this->_children = array();
-        }
-        return $this->_children;
-    }
-
-
-    /**
-     * Gets code
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function code()
-    {
-        return $this->get('LIN_code');
-    }
-
-
-    /**
-     * Sets code
-     *
-     * @param string $code
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_code($code)
-    {
-        $this->set('LIN_code', $code);
-    }
-
-
-    /**
-     * Gets is_taxable
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_taxable()
-    {
-        return $this->get('LIN_is_taxable');
-    }
-
-
-    /**
-     * Sets is_taxable
-     *
-     * @param boolean $is_taxable
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_is_taxable($is_taxable)
-    {
-        $this->set('LIN_is_taxable', $is_taxable);
-    }
-
-
-    /**
-     * Gets the object that this model-joins-to.
-     * returns one of the model objects that the field OBJ_ID can point to... see the 'OBJ_ID' field on
-     * EEM_Promotion_Object
-     *        Eg, if this line item join model object is for a ticket, this will return the EE_Ticket object
-     *
-     * @return EE_Base_Class | NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_object()
-    {
-        $model_name_of_related_obj = $this->OBJ_type();
-        return $this->get_model()->has_relation($model_name_of_related_obj)
-            ? $this->get_first_related($model_name_of_related_obj)
-            : null;
-    }
-
-
-    /**
-     * Like EE_Line_Item::get_object(), but can only ever actually return an EE_Ticket.
-     * (IE, if this line item is for a price or something else, will return NULL)
-     *
-     * @param array $query_params
-     * @return EE_Base_Class|EE_Ticket
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket($query_params = array())
-    {
-        // we're going to assume that when this method is called
-        // we always want to receive the attached ticket EVEN if that ticket is archived.
-        // This can be overridden via the incoming $query_params argument
-        $remove_defaults = array('default_where_conditions' => 'none');
-        $query_params = array_merge($remove_defaults, $query_params);
-        return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TICKET, $query_params);
-    }
-
-
-    /**
-     * Gets the EE_Datetime that's related to the ticket, IF this is for a ticket
-     *
-     * @return EE_Datetime | NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_ticket_datetime()
-    {
-        if ($this->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) {
-            $ticket = $this->ticket();
-            if ($ticket instanceof EE_Ticket) {
-                $datetime = $ticket->first_datetime();
-                if ($datetime instanceof EE_Datetime) {
-                    return $datetime;
-                }
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the event's name that's related to the ticket, if this is for
-     * a ticket
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_event_name()
-    {
-        $event_name = esc_html__('Unknown', 'event_espresso');
-        $event = $this->ticket_event();
-        if ($event instanceof EE_Event) {
-            $event_name = $event->name();
-        }
-        return $event_name;
-    }
-
-
-    /**
-     * Gets the event that's related to the ticket, if this line item represents a ticket.
-     *
-     * @return EE_Event|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_event()
-    {
-        $event = null;
-        $ticket = $this->ticket();
-        if ($ticket instanceof EE_Ticket) {
-            $datetime = $ticket->first_datetime();
-            if ($datetime instanceof EE_Datetime) {
-                $event = $datetime->event();
-            }
-        }
-        return $event;
-    }
-
-
-    /**
-     * Gets the first datetime for this lien item, assuming it's for a ticket
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_datetime_start($date_format = '', $time_format = '')
-    {
-        $first_datetime_string = esc_html__('Unknown', 'event_espresso');
-        $datetime = $this->get_ticket_datetime();
-        if ($datetime) {
-            $first_datetime_string = $datetime->start_date_and_time($date_format, $time_format);
-        }
-        return $first_datetime_string;
-    }
-
-
-    /**
-     * Adds the line item as a child to this line item. If there is another child line
-     * item with the same LIN_code, it is overwritten by this new one
-     *
-     * @param EEI_Line_Item $line_item
-     * @param bool          $set_order
-     * @return bool success
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true)
-    {
-        // should we calculate the LIN_order for this line item ?
-        if ($set_order || $line_item->order() === null) {
-            $line_item->set_order(count($this->children()));
-        }
-        if ($this->ID()) {
-            // check for any duplicate line items (with the same code), if so, this replaces it
-            $line_item_with_same_code = $this->get_child_line_item($line_item->code());
-            if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) {
-                $this->delete_child_line_item($line_item_with_same_code->code());
-            }
-            $line_item->set_parent_ID($this->ID());
-            if ($this->TXN_ID()) {
-                $line_item->set_TXN_ID($this->TXN_ID());
-            }
-            return $line_item->save();
-        }
-        $this->_children[ $line_item->code() ] = $line_item;
-        if ($line_item->parent() !== $this) {
-            $line_item->set_parent($this);
-        }
-        return true;
-    }
-
-
-    /**
-     * Similar to EE_Base_Class::_add_relation_to, except this isn't a normal relation.
-     * If this line item is saved to the DB, this is just a wrapper for set_parent_ID() and save()
-     * However, if this line item is NOT saved to the DB, this just caches the parent on
-     * the EE_Line_Item::_parent property.
-     *
-     * @param EE_Line_Item $line_item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_parent($line_item)
-    {
-        if ($this->ID()) {
-            if (! $line_item->ID()) {
-                $line_item->save();
-            }
-            $this->set_parent_ID($line_item->ID());
-            $this->save();
-        } else {
-            $this->_parent = $line_item;
-            $this->set_parent_ID($line_item->ID());
-        }
-    }
-
-
-    /**
-     * Gets the child line item as specified by its code. Because this returns an object (by reference)
-     * you can modify this child line item and the parent (this object) can know about them
-     * because it also has a reference to that line item
-     *
-     * @param string $code
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_child_line_item($code)
-    {
-        if ($this->ID()) {
-            return $this->get_model()->get_one(
-                array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code))
-            );
-        }
-        return isset($this->_children[ $code ])
-            ? $this->_children[ $code ]
-            : null;
-    }
-
-
-    /**
-     * Returns how many items are deleted (or, if this item has not been saved ot the DB yet, just how many it HAD
-     * cached on it)
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function delete_children_line_items()
-    {
-        if ($this->ID()) {
-            return $this->get_model()->delete(array(array('LIN_parent' => $this->ID())));
-        }
-        $count = count($this->_children);
-        $this->_children = array();
-        return $count;
-    }
-
-
-    /**
-     * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
-     * HAS NOT been saved to the DB, removes the child line item with index $code.
-     * Also searches through the child's children for a matching line item. However, once a line item has been found
-     * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be
-     * deleted)
-     *
-     * @param string $code
-     * @param bool   $stop_search_once_found
-     * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to
-     *             the DB yet)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function delete_child_line_item($code, $stop_search_once_found = true)
-    {
-        if ($this->ID()) {
-            $items_deleted = 0;
-            if ($this->code() === $code) {
-                $items_deleted += EEH_Line_Item::delete_all_child_items($this);
-                $items_deleted += (int) $this->delete();
-                if ($stop_search_once_found) {
-                    return $items_deleted;
-                }
-            }
-            foreach ($this->children() as $child_line_item) {
-                $items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found);
-            }
-            return $items_deleted;
-        }
-        if (isset($this->_children[ $code ])) {
-            unset($this->_children[ $code ]);
-            return 1;
-        }
-        return 0;
-    }
-
-
-    /**
-     * If this line item is in the database, is of the type subtotal, and
-     * has no children, why do we have it? It should be deleted so this function
-     * does that
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function delete_if_childless_subtotal()
-    {
-        if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && ! $this->children()) {
-            return $this->delete();
-        }
-        return false;
-    }
-
-
-    /**
-     * Creates a code and returns a string. doesn't assign the code to this model object
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function generate_code()
-    {
-        // each line item in the cart requires a unique identifier
-        return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime());
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_tax()
-    {
-        return $this->type() === EEM_Line_Item::type_tax;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_tax_sub_total()
-    {
-        return $this->type() === EEM_Line_Item::type_tax_sub_total;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_line_item()
-    {
-        return $this->type() === EEM_Line_Item::type_line_item;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_sub_line_item()
-    {
-        return $this->type() === EEM_Line_Item::type_sub_line_item;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_sub_total()
-    {
-        return $this->type() === EEM_Line_Item::type_sub_total;
-    }
-
-
-    /**
-     * Whether or not this line item is a cancellation line item
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_cancellation()
-    {
-        return EEM_Line_Item::type_cancellation === $this->type();
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_total()
-    {
-        return $this->type() === EEM_Line_Item::type_total;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_cancelled()
-    {
-        return $this->type() === EEM_Line_Item::type_cancellation;
-    }
-
-
-    /**
-     * @return string like '2, 004.00', formatted according to the localized currency
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function unit_price_no_code()
-    {
-        return $this->get_pretty('LIN_unit_price', 'no_currency_code');
-    }
-
-
-    /**
-     * @return string like '2, 004.00', formatted according to the localized currency
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total_no_code()
-    {
-        return $this->get_pretty('LIN_total', 'no_currency_code');
-    }
-
-
-    /**
-     * Gets the final total on this item, taking taxes into account.
-     * Has the side-effect of setting the sub-total as it was just calculated.
-     * If this is used on a grand-total line item, also updates the transaction's
-     * TXN_total (provided this line item is allowed to persist, otherwise we don't
-     * want to change a persistable transaction with info from a non-persistent line item)
-     *
-     * @param bool $update_txn_status
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function recalculate_total_including_taxes($update_txn_status = false)
-    {
-        $pre_tax_total = $this->recalculate_pre_tax_total();
-        $tax_total = $this->recalculate_taxes_and_tax_total();
-        $total = $pre_tax_total + $tax_total;
-        // no negative totals plz
-        $total = max($total, 0);
-        $this->set_total($total);
-        // only update the related transaction's total
-        // if we intend to save this line item and its a grand total
-        if (
-            $this->allow_persist() && $this->type() === EEM_Line_Item::type_total
-            && $this->transaction()
-               instanceof
-               EE_Transaction
-        ) {
-            $this->transaction()->set_total($total);
-            if ($update_txn_status) {
-                // don't save the TXN because that will be done below
-                // and the following method only saves if the status changes
-                $this->transaction()->update_status_based_on_total_paid(false);
-            }
-            if ($this->transaction()->ID()) {
-                $this->transaction()->save();
-            }
-        }
-        $this->maybe_save();
-        return $total;
-    }
-
-
-    /**
-     * Recursively goes through all the children and recalculates sub-totals EXCEPT for
-     * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its
-     * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
-     * when this is called on the grand total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function recalculate_pre_tax_total()
-    {
-        $total = 0;
-        $my_children = $this->children();
-        $has_children = ! empty($my_children);
-        if ($has_children && $this->is_line_item()) {
-            $total = $this->_recalculate_pretax_total_for_line_item($total, $my_children);
-        } elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) {
-            $total = $this->unit_price() * $this->quantity();
-        } elseif ($this->is_sub_total() || $this->is_total()) {
-            $total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children);
-        } elseif ($this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled()) {
-            // completely ignore tax totals, tax sub-totals, and cancelled line items, when calculating the pre-tax-total
-            return 0;
-        }
-        // ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events)
-        if (! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation()) {
-            if ($this->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_EVENT) {
-                $this->set_quantity(1);
-            }
-            if (! $this->is_percent()) {
-                $this->set_unit_price($total);
-            }
-        }
-        // we don't want to bother saving grand totals, because that needs to factor in taxes anyways
-        // so it ought to be
-        if (! $this->is_total()) {
-            $this->set_total($total);
-            // if not a percent line item, make sure we keep the unit price in sync
-            if (
-                $has_children
-                && $this->is_line_item()
-                && ! $this->is_percent()
-            ) {
-                if ($this->quantity() === 0) {
-                    $new_unit_price = 0;
-                } else {
-                    $new_unit_price = $this->total() / $this->quantity();
-                }
-                $this->set_unit_price($new_unit_price);
-            }
-            $this->maybe_save();
-        }
-        return $total;
-    }
-
-
-    /**
-     * Calculates the pretax total when this line item is a subtotal or total line item.
-     * Basically does a sum-then-round approach (ie, any percent line item that are children
-     * will calculate their total based on the un-rounded total we're working with so far, and
-     * THEN round the result; instead of rounding as we go like with sub-line-items)
-     *
-     * @param float          $calculated_total_so_far
-     * @param EE_Line_Item[] $my_children
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null)
-    {
-        if ($my_children === null) {
-            $my_children = $this->children();
-        }
-        $subtotal_quantity = 0;
-        // get the total of all its children
-        foreach ($my_children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                // skip line item if it is cancelled or is a tax
-                if ($child_line_item->is_cancellation() || $child_line_item->is_tax()) {
-                    continue;
-                }
-                // percentage line items are based on total so far
-                if ($child_line_item->is_percent()) {
-                    // round as we go so that the line items add up ok
-                    $percent_total = round(
-                        $calculated_total_so_far * $child_line_item->percent() / 100,
-                        EE_Registry::instance()->CFG->currency->dec_plc
-                    );
-                    $child_line_item->set_total($percent_total);
-                    // so far all percent line items should have a quantity of 1
-                    // (ie, no double percent discounts. Although that might be requested someday)
-                    $child_line_item->set_quantity(1);
-                    $child_line_item->maybe_save();
-                    $calculated_total_so_far += $percent_total;
-                } else {
-                    // verify flat sub-line-item quantities match their parent
-                    if ($child_line_item->is_sub_line_item()) {
-                        $child_line_item->set_quantity($this->quantity());
-                    }
-                    $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
-                    $subtotal_quantity += $child_line_item->quantity();
-                }
-            }
-        }
-        if ($this->is_sub_total()) {
-            // no negative totals plz
-            $calculated_total_so_far = max($calculated_total_so_far, 0);
-            $subtotal_quantity = $subtotal_quantity > 0 ? 1 : 0;
-            $this->set_quantity($subtotal_quantity);
-            $this->maybe_save();
-        }
-        return $calculated_total_so_far;
-    }
-
-
-    /**
-     * Calculates the pretax total for a normal line item, in a round-then-sum approach
-     * (where each sub-line-item is applied to the base price for the line item
-     * and the result is immediately rounded, rather than summing all the sub-line-items
-     * then rounding, like we do when recalculating pretax totals on totals and subtotals).
-     *
-     * @param float          $calculated_total_so_far
-     * @param EE_Line_Item[] $my_children
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null)
-    {
-        if ($my_children === null) {
-            $my_children = $this->children();
-        }
-        // we need to keep track of the running total for a single item,
-        // because we need to round as we go
-        $unit_price_for_total = 0;
-        $quantity_for_total = 1;
-        // get the total of all its children
-        foreach ($my_children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                // skip line item if it is cancelled or is a tax
-                if ($child_line_item->is_cancellation() || $child_line_item->is_tax()) {
-                    continue;
-                }
-                if ($child_line_item->is_percent()) {
-                    // it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity
-                    // not total multiplied by percent, because that ignores rounding along-the-way
-                    $percent_unit_price = round(
-                        $unit_price_for_total * $child_line_item->percent() / 100,
-                        EE_Registry::instance()->CFG->currency->dec_plc
-                    );
-                    $percent_total = $percent_unit_price * $quantity_for_total;
-                    $child_line_item->set_total($percent_total);
-                    // so far all percent line items should have a quantity of 1
-                    // (ie, no double percent discounts. Although that might be requested someday)
-                    $child_line_item->set_quantity(1);
-                    $child_line_item->maybe_save();
-                    $calculated_total_so_far += $percent_total;
-                    $unit_price_for_total += $percent_unit_price;
-                } else {
-                    // verify flat sub-line-item quantities match their parent
-                    if ($child_line_item->is_sub_line_item()) {
-                        $child_line_item->set_quantity($this->quantity());
-                    }
-                    $quantity_for_total = $child_line_item->quantity();
-                    $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
-                    $unit_price_for_total += $child_line_item->unit_price();
-                }
-            }
-        }
-        return $calculated_total_so_far;
-    }
-
-
-    /**
-     * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
-     * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items
-     * and tax sub-total if already in the DB
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function recalculate_taxes_and_tax_total()
-    {
-        // get all taxes
-        $taxes = $this->tax_descendants();
-        // calculate the pretax total
-        $taxable_total = $this->taxable_total();
-        $tax_total = 0;
-        foreach ($taxes as $tax) {
-            $total_on_this_tax = $taxable_total * $tax->percent() / 100;
-            // remember the total on this line item
-            $tax->set_total($total_on_this_tax);
-            $tax->maybe_save();
-            $tax_total += $tax->total();
-        }
-        $this->_recalculate_tax_sub_total();
-        return $tax_total;
-    }
-
-
-    /**
-     * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _recalculate_tax_sub_total()
-    {
-        if ($this->is_tax_sub_total()) {
-            $total = 0;
-            $total_percent = 0;
-            // simply loop through all its children (which should be taxes) and sum their total
-            foreach ($this->children() as $child_tax) {
-                if ($child_tax instanceof EE_Line_Item) {
-                    $total += $child_tax->total();
-                    $total_percent += $child_tax->percent();
-                }
-            }
-            $this->set_total($total);
-            $this->set_percent($total_percent);
-            $this->maybe_save();
-        } elseif ($this->is_total()) {
-            foreach ($this->children() as $maybe_tax_subtotal) {
-                if ($maybe_tax_subtotal instanceof EE_Line_Item) {
-                    $maybe_tax_subtotal->_recalculate_tax_sub_total();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Gets the total tax on this line item. Assumes taxes have already been calculated using
-     * recalculate_taxes_and_total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_total_tax()
-    {
-        $this->_recalculate_tax_sub_total();
-        $total = 0;
-        foreach ($this->tax_descendants() as $tax_line_item) {
-            if ($tax_line_item instanceof EE_Line_Item) {
-                $total += $tax_line_item->total();
-            }
-        }
-        return $total;
-    }
-
-
-    /**
-     * Gets the total for all the items purchased only
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_items_total()
-    {
-        // by default, let's make sure we're consistent with the existing line item
-        if ($this->is_total()) {
-            $pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this);
-            if ($pretax_subtotal_li instanceof EE_Line_Item) {
-                return $pretax_subtotal_li->total();
-            }
-        }
-        $total = 0;
-        foreach ($this->get_items() as $item) {
-            if ($item instanceof EE_Line_Item) {
-                $total += $item->total();
-            }
-        }
-        return $total;
-    }
-
-
-    /**
-     * Gets all the descendants (ie, children or children of children etc) that
-     * are of the type 'tax'
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     */
-    public function tax_descendants()
-    {
-        return EEH_Line_Item::get_tax_descendants($this);
-    }
-
-
-    /**
-     * Gets all the real items purchased which are children of this item
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     */
-    public function get_items()
-    {
-        return EEH_Line_Item::get_line_item_descendants($this);
-    }
-
-
-    /**
-     * Returns the amount taxable among this line item's children (or if it has no children,
-     * how much of it is taxable). Does not recalculate totals or subtotals.
-     * If the taxable total is negative, (eg, if none of the tickets were taxable,
-     * but there is a "Taxable" discount), returns 0.
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function taxable_total()
-    {
-        $total = 0;
-        if ($this->children()) {
-            foreach ($this->children() as $child_line_item) {
-                if ($child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
-                    // if it's a percent item, only take into account the percent
-                    // that's taxable too (the taxable total so far)
-                    if ($child_line_item->is_percent()) {
-                        $total += ($total * $child_line_item->percent() / 100);
-                    } else {
-                        $total += $child_line_item->total();
-                    }
-                } elseif ($child_line_item->type() === EEM_Line_Item::type_sub_total) {
-                    $total += $child_line_item->taxable_total();
-                }
-            }
-        }
-        return max($total, 0);
-    }
-
-
-    /**
-     * Gets the transaction for this line item
-     *
-     * @return EE_Base_Class|EE_Transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function transaction()
-    {
-        return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TRANSACTION);
-    }
-
-
-    /**
-     * Saves this line item to the DB, and recursively saves its descendants.
-     * Because there currently is no proper parent-child relation on the model,
-     * save_this_and_cached() will NOT save the descendants.
-     * Also sets the transaction on this line item and all its descendants before saving
-     *
-     * @param int $txn_id if none is provided, assumes $this->TXN_ID()
-     * @return int count of items saved
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function save_this_and_descendants_to_txn($txn_id = null)
-    {
-        $count = 0;
-        if (! $txn_id) {
-            $txn_id = $this->TXN_ID();
-        }
-        $this->set_TXN_ID($txn_id);
-        $children = $this->children();
-        $count += $this->save()
-            ? 1
-            : 0;
-        foreach ($children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                $child_line_item->set_parent_ID($this->ID());
-                $count += $child_line_item->save_this_and_descendants_to_txn($txn_id);
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * Saves this line item to the DB, and recursively saves its descendants.
-     *
-     * @return int count of items saved
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function save_this_and_descendants()
-    {
-        $count = 0;
-        $children = $this->children();
-        $count += $this->save()
-            ? 1
-            : 0;
-        foreach ($children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                $child_line_item->set_parent_ID($this->ID());
-                $count += $child_line_item->save_this_and_descendants();
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * returns the cancellation line item if this item was cancelled
-     *
-     * @return EE_Line_Item[]
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function get_cancellations()
-    {
-        EE_Registry::instance()->load_helper('Line_Item');
-        return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation);
-    }
-
-
-    /**
-     * If this item has an ID, then this saves it again to update the db
-     *
-     * @return int count of items saved
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function maybe_save()
-    {
-        if ($this->ID()) {
-            return $this->save();
-        }
-        return false;
-    }
-
-
-    /**
-     * clears the cached children and parent from the line item
-     *
-     * @return void
-     */
-    public function clear_related_line_item_cache()
-    {
-        $this->_children = array();
-        $this->_parent = null;
-    }
-
-
-    /**
-     * @param bool $raw
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function timestamp($raw = false)
-    {
-        return $raw
-            ? $this->get_raw('LIN_timestamp')
-            : $this->get('LIN_timestamp');
-    }
-
-
-
-
-    /************************* DEPRECATED *************************/
-    /**
-     * @deprecated 4.6.0
-     * @param string $type one of the constants on EEM_Line_Item
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     */
-    protected function _get_descendants_of_type($type)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Line_Item::_get_descendants_of_type()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::get_descendants_of_type()'
-            ),
-            '4.6.0'
-        );
-        return EEH_Line_Item::get_descendants_of_type($this, $type);
-    }
-
-
-    /**
-     * @deprecated 4.6.0
-     * @param string $type like one of the EEM_Line_Item::type_*
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_nearest_descendant_of_type($type)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Line_Item::get_nearest_descendant_of_type()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::get_nearest_descendant_of_type()'
-            ),
-            '4.6.0'
-        );
-        return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
-    }
+	/**
+	 * for children line items (currently not a normal relation)
+	 *
+	 * @type EE_Line_Item[]
+	 */
+	protected $_children = array();
+
+	/**
+	 * for the parent line item
+	 *
+	 * @var EE_Line_Item
+	 */
+	protected $_parent;
+
+
+	/**
+	 * @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_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '', $date_formats = array())
+	{
+		$has_object = parent::_check_for_object(
+			$props_n_values,
+			__CLASS__,
+			$timezone,
+			$date_formats
+		);
+		return $has_object
+			? $has_object
+			: new self($props_n_values, false, $timezone);
+	}
+
+
+	/**
+	 * @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_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Adds some defaults if they're not specified
+	 *
+	 * @param array  $fieldValues
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
+	{
+		parent::__construct($fieldValues, $bydb, $timezone);
+		if (! $this->get('LIN_code')) {
+			$this->set_code($this->generate_code());
+		}
+	}
+
+
+	/**
+	 * Gets ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ID()
+	{
+		return $this->get('LIN_ID');
+	}
+
+
+	/**
+	 * Gets TXN_ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * Sets TXN_ID
+	 *
+	 * @param int $TXN_ID
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_TXN_ID($TXN_ID)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function name()
+	{
+		$name = $this->get('LIN_name');
+		if (! $name) {
+			$name = ucwords(str_replace('-', ' ', $this->type()));
+		}
+		return $name;
+	}
+
+
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_name($name)
+	{
+		$this->set('LIN_name', $name);
+	}
+
+
+	/**
+	 * Gets desc
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function desc()
+	{
+		return $this->get('LIN_desc');
+	}
+
+
+	/**
+	 * Sets desc
+	 *
+	 * @param string $desc
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_desc($desc)
+	{
+		$this->set('LIN_desc', $desc);
+	}
+
+
+	/**
+	 * Gets quantity
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function quantity()
+	{
+		return $this->get('LIN_quantity');
+	}
+
+
+	/**
+	 * Sets quantity
+	 *
+	 * @param int $quantity
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_quantity($quantity)
+	{
+		$this->set('LIN_quantity', max($quantity, 0));
+	}
+
+
+	/**
+	 * Gets item_id
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function OBJ_ID()
+	{
+		return $this->get('OBJ_ID');
+	}
+
+
+	/**
+	 * Sets item_id
+	 *
+	 * @param string $item_id
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_OBJ_ID($item_id)
+	{
+		$this->set('OBJ_ID', $item_id);
+	}
+
+
+	/**
+	 * Gets item_type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function OBJ_type()
+	{
+		return $this->get('OBJ_type');
+	}
+
+
+	/**
+	 * Gets item_type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function OBJ_type_i18n()
+	{
+		$obj_type = $this->OBJ_type();
+		switch ($obj_type) {
+			case EEM_Line_Item::OBJ_TYPE_EVENT:
+				$obj_type = esc_html__('Event', 'event_espresso');
+				break;
+			case EEM_Line_Item::OBJ_TYPE_PRICE:
+				$obj_type = esc_html__('Price', 'event_espresso');
+				break;
+			case EEM_Line_Item::OBJ_TYPE_PROMOTION:
+				$obj_type = esc_html__('Promotion', 'event_espresso');
+				break;
+			case EEM_Line_Item::OBJ_TYPE_TICKET:
+				$obj_type = esc_html__('Ticket', 'event_espresso');
+				break;
+			case EEM_Line_Item::OBJ_TYPE_TRANSACTION:
+				$obj_type = esc_html__('Transaction', 'event_espresso');
+				break;
+		}
+		return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this);
+	}
+
+
+	/**
+	 * Sets item_type
+	 *
+	 * @param string $OBJ_type
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_OBJ_type($OBJ_type)
+	{
+		$this->set('OBJ_type', $OBJ_type);
+	}
+
+
+	/**
+	 * Gets unit_price
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function unit_price()
+	{
+		return $this->get('LIN_unit_price');
+	}
+
+
+	/**
+	 * Sets unit_price
+	 *
+	 * @param float $unit_price
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_unit_price($unit_price)
+	{
+		$this->set('LIN_unit_price', $unit_price);
+	}
+
+
+	/**
+	 * Checks if this item is a percentage modifier or not
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_percent()
+	{
+		if ($this->is_tax_sub_total()) {
+			// tax subtotals HAVE a percent on them, that percentage only applies
+			// to taxable items, so its' an exception. Treat it like a flat line item
+			return false;
+		}
+		$unit_price = abs($this->get('LIN_unit_price'));
+		$percent = abs($this->get('LIN_percent'));
+		if ($unit_price < .001 && $percent) {
+			return true;
+		}
+		if ($unit_price >= .001 && ! $percent) {
+			return false;
+		}
+		if ($unit_price >= .001 && $percent) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'A Line Item can not have a unit price of (%s) AND a percent (%s)!',
+						'event_espresso'
+					),
+					$unit_price,
+					$percent
+				)
+			);
+		}
+		// if they're both 0, assume its not a percent item
+		return false;
+	}
+
+
+	/**
+	 * Gets percent (between 100-.001)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function percent()
+	{
+		return $this->get('LIN_percent');
+	}
+
+
+	/**
+	 * Sets percent (between 100-0.01)
+	 *
+	 * @param float $percent
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_percent($percent)
+	{
+		$this->set('LIN_percent', $percent);
+	}
+
+
+	/**
+	 * Gets total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total()
+	{
+		return $this->get('LIN_total');
+	}
+
+
+	/**
+	 * Sets total
+	 *
+	 * @param float $total
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_total($total)
+	{
+		$this->set('LIN_total', $total);
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function order()
+	{
+		return $this->get('LIN_order');
+	}
+
+
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_order($order)
+	{
+		$this->set('LIN_order', $order);
+	}
+
+
+	/**
+	 * Gets parent
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function parent_ID()
+	{
+		return $this->get('LIN_parent');
+	}
+
+
+	/**
+	 * Sets parent
+	 *
+	 * @param int $parent
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_parent_ID($parent)
+	{
+		$this->set('LIN_parent', $parent);
+	}
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function type()
+	{
+		return $this->get('LIN_type');
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_type($type)
+	{
+		$this->set('LIN_type', $type);
+	}
+
+
+	/**
+	 * Gets the line item of which this item is a composite. Eg, if this is a subtotal, the parent might be a total\
+	 * If this line item is saved to the DB, fetches the parent from the DB. However, if this line item isn't in the DB
+	 * it uses its cached reference to its parent line item (which would have been set by `EE_Line_Item::set_parent()`
+	 * or indirectly by `EE_Line_item::add_child_line_item()`)
+	 *
+	 * @return EE_Base_Class|EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function parent()
+	{
+		return $this->ID()
+			? $this->get_model()->get_one_by_ID($this->parent_ID())
+			: $this->_parent;
+	}
+
+
+	/**
+	 * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
+	 *
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function children()
+	{
+		if ($this->ID()) {
+			return $this->get_model()->get_all(
+				array(
+					array('LIN_parent' => $this->ID()),
+					'order_by' => array('LIN_order' => 'ASC'),
+				)
+			);
+		}
+		if (! is_array($this->_children)) {
+			$this->_children = array();
+		}
+		return $this->_children;
+	}
+
+
+	/**
+	 * Gets code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function code()
+	{
+		return $this->get('LIN_code');
+	}
+
+
+	/**
+	 * Sets code
+	 *
+	 * @param string $code
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_code($code)
+	{
+		$this->set('LIN_code', $code);
+	}
+
+
+	/**
+	 * Gets is_taxable
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_taxable()
+	{
+		return $this->get('LIN_is_taxable');
+	}
+
+
+	/**
+	 * Sets is_taxable
+	 *
+	 * @param boolean $is_taxable
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_is_taxable($is_taxable)
+	{
+		$this->set('LIN_is_taxable', $is_taxable);
+	}
+
+
+	/**
+	 * Gets the object that this model-joins-to.
+	 * returns one of the model objects that the field OBJ_ID can point to... see the 'OBJ_ID' field on
+	 * EEM_Promotion_Object
+	 *        Eg, if this line item join model object is for a ticket, this will return the EE_Ticket object
+	 *
+	 * @return EE_Base_Class | NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_object()
+	{
+		$model_name_of_related_obj = $this->OBJ_type();
+		return $this->get_model()->has_relation($model_name_of_related_obj)
+			? $this->get_first_related($model_name_of_related_obj)
+			: null;
+	}
+
+
+	/**
+	 * Like EE_Line_Item::get_object(), but can only ever actually return an EE_Ticket.
+	 * (IE, if this line item is for a price or something else, will return NULL)
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class|EE_Ticket
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket($query_params = array())
+	{
+		// we're going to assume that when this method is called
+		// we always want to receive the attached ticket EVEN if that ticket is archived.
+		// This can be overridden via the incoming $query_params argument
+		$remove_defaults = array('default_where_conditions' => 'none');
+		$query_params = array_merge($remove_defaults, $query_params);
+		return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TICKET, $query_params);
+	}
+
+
+	/**
+	 * Gets the EE_Datetime that's related to the ticket, IF this is for a ticket
+	 *
+	 * @return EE_Datetime | NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_datetime()
+	{
+		if ($this->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) {
+			$ticket = $this->ticket();
+			if ($ticket instanceof EE_Ticket) {
+				$datetime = $ticket->first_datetime();
+				if ($datetime instanceof EE_Datetime) {
+					return $datetime;
+				}
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the event's name that's related to the ticket, if this is for
+	 * a ticket
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_event_name()
+	{
+		$event_name = esc_html__('Unknown', 'event_espresso');
+		$event = $this->ticket_event();
+		if ($event instanceof EE_Event) {
+			$event_name = $event->name();
+		}
+		return $event_name;
+	}
+
+
+	/**
+	 * Gets the event that's related to the ticket, if this line item represents a ticket.
+	 *
+	 * @return EE_Event|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_event()
+	{
+		$event = null;
+		$ticket = $this->ticket();
+		if ($ticket instanceof EE_Ticket) {
+			$datetime = $ticket->first_datetime();
+			if ($datetime instanceof EE_Datetime) {
+				$event = $datetime->event();
+			}
+		}
+		return $event;
+	}
+
+
+	/**
+	 * Gets the first datetime for this lien item, assuming it's for a ticket
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_datetime_start($date_format = '', $time_format = '')
+	{
+		$first_datetime_string = esc_html__('Unknown', 'event_espresso');
+		$datetime = $this->get_ticket_datetime();
+		if ($datetime) {
+			$first_datetime_string = $datetime->start_date_and_time($date_format, $time_format);
+		}
+		return $first_datetime_string;
+	}
+
+
+	/**
+	 * Adds the line item as a child to this line item. If there is another child line
+	 * item with the same LIN_code, it is overwritten by this new one
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @param bool          $set_order
+	 * @return bool success
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true)
+	{
+		// should we calculate the LIN_order for this line item ?
+		if ($set_order || $line_item->order() === null) {
+			$line_item->set_order(count($this->children()));
+		}
+		if ($this->ID()) {
+			// check for any duplicate line items (with the same code), if so, this replaces it
+			$line_item_with_same_code = $this->get_child_line_item($line_item->code());
+			if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) {
+				$this->delete_child_line_item($line_item_with_same_code->code());
+			}
+			$line_item->set_parent_ID($this->ID());
+			if ($this->TXN_ID()) {
+				$line_item->set_TXN_ID($this->TXN_ID());
+			}
+			return $line_item->save();
+		}
+		$this->_children[ $line_item->code() ] = $line_item;
+		if ($line_item->parent() !== $this) {
+			$line_item->set_parent($this);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Similar to EE_Base_Class::_add_relation_to, except this isn't a normal relation.
+	 * If this line item is saved to the DB, this is just a wrapper for set_parent_ID() and save()
+	 * However, if this line item is NOT saved to the DB, this just caches the parent on
+	 * the EE_Line_Item::_parent property.
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_parent($line_item)
+	{
+		if ($this->ID()) {
+			if (! $line_item->ID()) {
+				$line_item->save();
+			}
+			$this->set_parent_ID($line_item->ID());
+			$this->save();
+		} else {
+			$this->_parent = $line_item;
+			$this->set_parent_ID($line_item->ID());
+		}
+	}
+
+
+	/**
+	 * Gets the child line item as specified by its code. Because this returns an object (by reference)
+	 * you can modify this child line item and the parent (this object) can know about them
+	 * because it also has a reference to that line item
+	 *
+	 * @param string $code
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_child_line_item($code)
+	{
+		if ($this->ID()) {
+			return $this->get_model()->get_one(
+				array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code))
+			);
+		}
+		return isset($this->_children[ $code ])
+			? $this->_children[ $code ]
+			: null;
+	}
+
+
+	/**
+	 * Returns how many items are deleted (or, if this item has not been saved ot the DB yet, just how many it HAD
+	 * cached on it)
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function delete_children_line_items()
+	{
+		if ($this->ID()) {
+			return $this->get_model()->delete(array(array('LIN_parent' => $this->ID())));
+		}
+		$count = count($this->_children);
+		$this->_children = array();
+		return $count;
+	}
+
+
+	/**
+	 * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
+	 * HAS NOT been saved to the DB, removes the child line item with index $code.
+	 * Also searches through the child's children for a matching line item. However, once a line item has been found
+	 * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be
+	 * deleted)
+	 *
+	 * @param string $code
+	 * @param bool   $stop_search_once_found
+	 * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to
+	 *             the DB yet)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function delete_child_line_item($code, $stop_search_once_found = true)
+	{
+		if ($this->ID()) {
+			$items_deleted = 0;
+			if ($this->code() === $code) {
+				$items_deleted += EEH_Line_Item::delete_all_child_items($this);
+				$items_deleted += (int) $this->delete();
+				if ($stop_search_once_found) {
+					return $items_deleted;
+				}
+			}
+			foreach ($this->children() as $child_line_item) {
+				$items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found);
+			}
+			return $items_deleted;
+		}
+		if (isset($this->_children[ $code ])) {
+			unset($this->_children[ $code ]);
+			return 1;
+		}
+		return 0;
+	}
+
+
+	/**
+	 * If this line item is in the database, is of the type subtotal, and
+	 * has no children, why do we have it? It should be deleted so this function
+	 * does that
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function delete_if_childless_subtotal()
+	{
+		if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && ! $this->children()) {
+			return $this->delete();
+		}
+		return false;
+	}
+
+
+	/**
+	 * Creates a code and returns a string. doesn't assign the code to this model object
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function generate_code()
+	{
+		// each line item in the cart requires a unique identifier
+		return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime());
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_tax()
+	{
+		return $this->type() === EEM_Line_Item::type_tax;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_tax_sub_total()
+	{
+		return $this->type() === EEM_Line_Item::type_tax_sub_total;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_line_item()
+	{
+		return $this->type() === EEM_Line_Item::type_line_item;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_sub_line_item()
+	{
+		return $this->type() === EEM_Line_Item::type_sub_line_item;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_sub_total()
+	{
+		return $this->type() === EEM_Line_Item::type_sub_total;
+	}
+
+
+	/**
+	 * Whether or not this line item is a cancellation line item
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_cancellation()
+	{
+		return EEM_Line_Item::type_cancellation === $this->type();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_total()
+	{
+		return $this->type() === EEM_Line_Item::type_total;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_cancelled()
+	{
+		return $this->type() === EEM_Line_Item::type_cancellation;
+	}
+
+
+	/**
+	 * @return string like '2, 004.00', formatted according to the localized currency
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function unit_price_no_code()
+	{
+		return $this->get_pretty('LIN_unit_price', 'no_currency_code');
+	}
+
+
+	/**
+	 * @return string like '2, 004.00', formatted according to the localized currency
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total_no_code()
+	{
+		return $this->get_pretty('LIN_total', 'no_currency_code');
+	}
+
+
+	/**
+	 * Gets the final total on this item, taking taxes into account.
+	 * Has the side-effect of setting the sub-total as it was just calculated.
+	 * If this is used on a grand-total line item, also updates the transaction's
+	 * TXN_total (provided this line item is allowed to persist, otherwise we don't
+	 * want to change a persistable transaction with info from a non-persistent line item)
+	 *
+	 * @param bool $update_txn_status
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function recalculate_total_including_taxes($update_txn_status = false)
+	{
+		$pre_tax_total = $this->recalculate_pre_tax_total();
+		$tax_total = $this->recalculate_taxes_and_tax_total();
+		$total = $pre_tax_total + $tax_total;
+		// no negative totals plz
+		$total = max($total, 0);
+		$this->set_total($total);
+		// only update the related transaction's total
+		// if we intend to save this line item and its a grand total
+		if (
+			$this->allow_persist() && $this->type() === EEM_Line_Item::type_total
+			&& $this->transaction()
+			   instanceof
+			   EE_Transaction
+		) {
+			$this->transaction()->set_total($total);
+			if ($update_txn_status) {
+				// don't save the TXN because that will be done below
+				// and the following method only saves if the status changes
+				$this->transaction()->update_status_based_on_total_paid(false);
+			}
+			if ($this->transaction()->ID()) {
+				$this->transaction()->save();
+			}
+		}
+		$this->maybe_save();
+		return $total;
+	}
+
+
+	/**
+	 * Recursively goes through all the children and recalculates sub-totals EXCEPT for
+	 * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its
+	 * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
+	 * when this is called on the grand total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function recalculate_pre_tax_total()
+	{
+		$total = 0;
+		$my_children = $this->children();
+		$has_children = ! empty($my_children);
+		if ($has_children && $this->is_line_item()) {
+			$total = $this->_recalculate_pretax_total_for_line_item($total, $my_children);
+		} elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) {
+			$total = $this->unit_price() * $this->quantity();
+		} elseif ($this->is_sub_total() || $this->is_total()) {
+			$total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children);
+		} elseif ($this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled()) {
+			// completely ignore tax totals, tax sub-totals, and cancelled line items, when calculating the pre-tax-total
+			return 0;
+		}
+		// ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events)
+		if (! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation()) {
+			if ($this->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_EVENT) {
+				$this->set_quantity(1);
+			}
+			if (! $this->is_percent()) {
+				$this->set_unit_price($total);
+			}
+		}
+		// we don't want to bother saving grand totals, because that needs to factor in taxes anyways
+		// so it ought to be
+		if (! $this->is_total()) {
+			$this->set_total($total);
+			// if not a percent line item, make sure we keep the unit price in sync
+			if (
+				$has_children
+				&& $this->is_line_item()
+				&& ! $this->is_percent()
+			) {
+				if ($this->quantity() === 0) {
+					$new_unit_price = 0;
+				} else {
+					$new_unit_price = $this->total() / $this->quantity();
+				}
+				$this->set_unit_price($new_unit_price);
+			}
+			$this->maybe_save();
+		}
+		return $total;
+	}
+
+
+	/**
+	 * Calculates the pretax total when this line item is a subtotal or total line item.
+	 * Basically does a sum-then-round approach (ie, any percent line item that are children
+	 * will calculate their total based on the un-rounded total we're working with so far, and
+	 * THEN round the result; instead of rounding as we go like with sub-line-items)
+	 *
+	 * @param float          $calculated_total_so_far
+	 * @param EE_Line_Item[] $my_children
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null)
+	{
+		if ($my_children === null) {
+			$my_children = $this->children();
+		}
+		$subtotal_quantity = 0;
+		// get the total of all its children
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				// skip line item if it is cancelled or is a tax
+				if ($child_line_item->is_cancellation() || $child_line_item->is_tax()) {
+					continue;
+				}
+				// percentage line items are based on total so far
+				if ($child_line_item->is_percent()) {
+					// round as we go so that the line items add up ok
+					$percent_total = round(
+						$calculated_total_so_far * $child_line_item->percent() / 100,
+						EE_Registry::instance()->CFG->currency->dec_plc
+					);
+					$child_line_item->set_total($percent_total);
+					// so far all percent line items should have a quantity of 1
+					// (ie, no double percent discounts. Although that might be requested someday)
+					$child_line_item->set_quantity(1);
+					$child_line_item->maybe_save();
+					$calculated_total_so_far += $percent_total;
+				} else {
+					// verify flat sub-line-item quantities match their parent
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
+					}
+					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
+					$subtotal_quantity += $child_line_item->quantity();
+				}
+			}
+		}
+		if ($this->is_sub_total()) {
+			// no negative totals plz
+			$calculated_total_so_far = max($calculated_total_so_far, 0);
+			$subtotal_quantity = $subtotal_quantity > 0 ? 1 : 0;
+			$this->set_quantity($subtotal_quantity);
+			$this->maybe_save();
+		}
+		return $calculated_total_so_far;
+	}
+
+
+	/**
+	 * Calculates the pretax total for a normal line item, in a round-then-sum approach
+	 * (where each sub-line-item is applied to the base price for the line item
+	 * and the result is immediately rounded, rather than summing all the sub-line-items
+	 * then rounding, like we do when recalculating pretax totals on totals and subtotals).
+	 *
+	 * @param float          $calculated_total_so_far
+	 * @param EE_Line_Item[] $my_children
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null)
+	{
+		if ($my_children === null) {
+			$my_children = $this->children();
+		}
+		// we need to keep track of the running total for a single item,
+		// because we need to round as we go
+		$unit_price_for_total = 0;
+		$quantity_for_total = 1;
+		// get the total of all its children
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				// skip line item if it is cancelled or is a tax
+				if ($child_line_item->is_cancellation() || $child_line_item->is_tax()) {
+					continue;
+				}
+				if ($child_line_item->is_percent()) {
+					// it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity
+					// not total multiplied by percent, because that ignores rounding along-the-way
+					$percent_unit_price = round(
+						$unit_price_for_total * $child_line_item->percent() / 100,
+						EE_Registry::instance()->CFG->currency->dec_plc
+					);
+					$percent_total = $percent_unit_price * $quantity_for_total;
+					$child_line_item->set_total($percent_total);
+					// so far all percent line items should have a quantity of 1
+					// (ie, no double percent discounts. Although that might be requested someday)
+					$child_line_item->set_quantity(1);
+					$child_line_item->maybe_save();
+					$calculated_total_so_far += $percent_total;
+					$unit_price_for_total += $percent_unit_price;
+				} else {
+					// verify flat sub-line-item quantities match their parent
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
+					}
+					$quantity_for_total = $child_line_item->quantity();
+					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
+					$unit_price_for_total += $child_line_item->unit_price();
+				}
+			}
+		}
+		return $calculated_total_so_far;
+	}
+
+
+	/**
+	 * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
+	 * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items
+	 * and tax sub-total if already in the DB
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function recalculate_taxes_and_tax_total()
+	{
+		// get all taxes
+		$taxes = $this->tax_descendants();
+		// calculate the pretax total
+		$taxable_total = $this->taxable_total();
+		$tax_total = 0;
+		foreach ($taxes as $tax) {
+			$total_on_this_tax = $taxable_total * $tax->percent() / 100;
+			// remember the total on this line item
+			$tax->set_total($total_on_this_tax);
+			$tax->maybe_save();
+			$tax_total += $tax->total();
+		}
+		$this->_recalculate_tax_sub_total();
+		return $tax_total;
+	}
+
+
+	/**
+	 * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _recalculate_tax_sub_total()
+	{
+		if ($this->is_tax_sub_total()) {
+			$total = 0;
+			$total_percent = 0;
+			// simply loop through all its children (which should be taxes) and sum their total
+			foreach ($this->children() as $child_tax) {
+				if ($child_tax instanceof EE_Line_Item) {
+					$total += $child_tax->total();
+					$total_percent += $child_tax->percent();
+				}
+			}
+			$this->set_total($total);
+			$this->set_percent($total_percent);
+			$this->maybe_save();
+		} elseif ($this->is_total()) {
+			foreach ($this->children() as $maybe_tax_subtotal) {
+				if ($maybe_tax_subtotal instanceof EE_Line_Item) {
+					$maybe_tax_subtotal->_recalculate_tax_sub_total();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Gets the total tax on this line item. Assumes taxes have already been calculated using
+	 * recalculate_taxes_and_total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_total_tax()
+	{
+		$this->_recalculate_tax_sub_total();
+		$total = 0;
+		foreach ($this->tax_descendants() as $tax_line_item) {
+			if ($tax_line_item instanceof EE_Line_Item) {
+				$total += $tax_line_item->total();
+			}
+		}
+		return $total;
+	}
+
+
+	/**
+	 * Gets the total for all the items purchased only
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_items_total()
+	{
+		// by default, let's make sure we're consistent with the existing line item
+		if ($this->is_total()) {
+			$pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this);
+			if ($pretax_subtotal_li instanceof EE_Line_Item) {
+				return $pretax_subtotal_li->total();
+			}
+		}
+		$total = 0;
+		foreach ($this->get_items() as $item) {
+			if ($item instanceof EE_Line_Item) {
+				$total += $item->total();
+			}
+		}
+		return $total;
+	}
+
+
+	/**
+	 * Gets all the descendants (ie, children or children of children etc) that
+	 * are of the type 'tax'
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	public function tax_descendants()
+	{
+		return EEH_Line_Item::get_tax_descendants($this);
+	}
+
+
+	/**
+	 * Gets all the real items purchased which are children of this item
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	public function get_items()
+	{
+		return EEH_Line_Item::get_line_item_descendants($this);
+	}
+
+
+	/**
+	 * Returns the amount taxable among this line item's children (or if it has no children,
+	 * how much of it is taxable). Does not recalculate totals or subtotals.
+	 * If the taxable total is negative, (eg, if none of the tickets were taxable,
+	 * but there is a "Taxable" discount), returns 0.
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function taxable_total()
+	{
+		$total = 0;
+		if ($this->children()) {
+			foreach ($this->children() as $child_line_item) {
+				if ($child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
+					// if it's a percent item, only take into account the percent
+					// that's taxable too (the taxable total so far)
+					if ($child_line_item->is_percent()) {
+						$total += ($total * $child_line_item->percent() / 100);
+					} else {
+						$total += $child_line_item->total();
+					}
+				} elseif ($child_line_item->type() === EEM_Line_Item::type_sub_total) {
+					$total += $child_line_item->taxable_total();
+				}
+			}
+		}
+		return max($total, 0);
+	}
+
+
+	/**
+	 * Gets the transaction for this line item
+	 *
+	 * @return EE_Base_Class|EE_Transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function transaction()
+	{
+		return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TRANSACTION);
+	}
+
+
+	/**
+	 * Saves this line item to the DB, and recursively saves its descendants.
+	 * Because there currently is no proper parent-child relation on the model,
+	 * save_this_and_cached() will NOT save the descendants.
+	 * Also sets the transaction on this line item and all its descendants before saving
+	 *
+	 * @param int $txn_id if none is provided, assumes $this->TXN_ID()
+	 * @return int count of items saved
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function save_this_and_descendants_to_txn($txn_id = null)
+	{
+		$count = 0;
+		if (! $txn_id) {
+			$txn_id = $this->TXN_ID();
+		}
+		$this->set_TXN_ID($txn_id);
+		$children = $this->children();
+		$count += $this->save()
+			? 1
+			: 0;
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
+				$count += $child_line_item->save_this_and_descendants_to_txn($txn_id);
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Saves this line item to the DB, and recursively saves its descendants.
+	 *
+	 * @return int count of items saved
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function save_this_and_descendants()
+	{
+		$count = 0;
+		$children = $this->children();
+		$count += $this->save()
+			? 1
+			: 0;
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
+				$count += $child_line_item->save_this_and_descendants();
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * returns the cancellation line item if this item was cancelled
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function get_cancellations()
+	{
+		EE_Registry::instance()->load_helper('Line_Item');
+		return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation);
+	}
+
+
+	/**
+	 * If this item has an ID, then this saves it again to update the db
+	 *
+	 * @return int count of items saved
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function maybe_save()
+	{
+		if ($this->ID()) {
+			return $this->save();
+		}
+		return false;
+	}
+
+
+	/**
+	 * clears the cached children and parent from the line item
+	 *
+	 * @return void
+	 */
+	public function clear_related_line_item_cache()
+	{
+		$this->_children = array();
+		$this->_parent = null;
+	}
+
+
+	/**
+	 * @param bool $raw
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function timestamp($raw = false)
+	{
+		return $raw
+			? $this->get_raw('LIN_timestamp')
+			: $this->get('LIN_timestamp');
+	}
+
+
+
+
+	/************************* DEPRECATED *************************/
+	/**
+	 * @deprecated 4.6.0
+	 * @param string $type one of the constants on EEM_Line_Item
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	protected function _get_descendants_of_type($type)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Line_Item::_get_descendants_of_type()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::get_descendants_of_type()'
+			),
+			'4.6.0'
+		);
+		return EEH_Line_Item::get_descendants_of_type($this, $type);
+	}
+
+
+	/**
+	 * @deprecated 4.6.0
+	 * @param string $type like one of the EEM_Line_Item::type_*
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_nearest_descendant_of_type($type)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Line_Item::get_nearest_descendant_of_type()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::get_nearest_descendant_of_type()'
+			),
+			'4.6.0'
+		);
+		return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
+	}
 }