eventespresso / event-espresso-core

core/db_models/EEM_Base.model.php

Doc Comments +15 added lines, -13 removed lines

@@ -967,7 +967,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
      */
     public function wp_user_field_name()
@@ -1072,7 +1072,7 @@ 
      *
      * @param array  $query_params      like EEM_Base::get_all's $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,
@@ -1486,7 +1486,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).
      * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
-     * @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.
      */
     public function get_formats_for($field_name, $pretty = false)
     {
@@ -1521,7 +1521,7 @@ 
      *                                 be returned.
      * @param string $what             Whether to return the string in just the time format, the date format, or both.
      * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
+     * @return string|null  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
      *                                 exception is triggered.
      */
     public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
@@ -1561,7 +1561,7 @@ 
      *                                the blog.  If this is not the case, then it can be specified here.  If incoming
      *                                format is
      *                                'U', this is ignored.
-     * @return DateTime
+     * @return string
      * @throws EE_Error
      */
     public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
@@ -2426,7 +2426,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
      */
@@ -2550,6 +2550,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
      */
     public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
     {
@@ -2560,7 +2561,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
@@ -2601,7 +2602,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
@@ -2622,7 +2623,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
@@ -2679,6 +2680,7 @@ 
      * @param string $model_name   like 'Event', or 'Registration'
      * @param array  $query_params like EEM_Base::get_all's
      * @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
      */
@@ -3639,7 +3641,7 @@ 
      * 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      string $default_where_conditions_value
      * @param bool $for_this_model false means this is for OTHER related models
      * @return bool
      */
@@ -3677,7 +3679,7 @@ 
      * 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      string $default_where_conditions_value
      * @param bool $for_this_model false means this is for OTHER related models
      * @return bool
      */
@@ -4732,7 +4734,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)
@@ -5450,7 +5452,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()
     {

Indentation +6006 added lines, -6006 removed lines

@@ -32,6014 +32,6014 @@
 abstract class EEM_Base extends EE_Base implements ResettableInterface
 {
 
-    /**
-     * 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;
-
-    /**
-     * 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;
-
-
-    protected $singular_item = 'Item';
-
-    protected $plural_item   = 'Items';
-
-    /**
-     * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
-     */
-    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 = array();
-
-    /**
-     * 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 = '';
-
-    /**
-     * 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 each's value is 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 = array(
-        self::caps_read       => array(),
-        self::caps_read_admin => array(),
-        self::caps_edit       => array(),
-        self::caps_delete     => array(),
-    );
-
-    /**
-     * 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 = array();
-
-    /**
-     * 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';
-
-    /**
-     * 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 = array(
-        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 = array();
-
-    /**
-     * 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;
-
-    /**
-     * 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;
-
-    /**
-     *    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 = array(
-        '='           => '=',
-        '<='          => '<=',
-        '<'           => '<',
-        '>='          => '>=',
-        '>'           => '>',
-        '!='          => '!=',
-        '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 = array('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 = array('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 = array('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 = array('IS NOT NULL', 'IS NULL');
-
-    /**
-     * Allowed values for $query_params['order'] for ordering in queries
-     *
-     * @var array
-     */
-    protected $_allowed_order_values = array('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 = array('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 = array(
-        0,
-        'limit',
-        'order_by',
-        'group_by',
-        'having',
-        'force_join',
-        'order',
-        'on_join_limit',
-        'default_where_conditions',
-        'caps',
-    );
-
-    /**
-     * All the data types that can be used in $wpdb->prepare statements.
-     *
-     * @var array
-     */
-    private $_valid_wpdb_data_types = array('%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 so those selections can be used in WHERE, GROUP_BY, etc.
-     *
-     * @var array
-     */
-    protected $_custom_selections = array();
-
-    /**
-     * 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;
-
-
-    /**
-     * 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;
-
-    /**
-     * 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;
-
-    /**
-     * @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';
-
-
-
-    /**
-     * 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 null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        // check that the model has not been loaded too soon
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
-            throw new EE_Error (
-                sprintf(
-                    __('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 blogid 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(__("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) {
-            /** @var $index_obj EE_Index */
-            $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 ($this->_cap_restriction_generators !== false) {
-            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 there are cap restriction generators, use them to make the default cap restrictions
-        if ($this->_cap_restriction_generators !== false) {
-            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(
-                            __('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 = null)
-    {
-        // 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')
-            );
-        }
-        //we might have a timezone set, let set_timezone decide what to do with it
-        static::$_instance->set_timezone($timezone);
-        // Espresso_model object
-        return static::$_instance;
-    }
-
-
-
-    /**
-     * resets the model and returns it
-     *
-     * @param null | 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 = null)
-    {
-        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;
-                }
-            }
-            //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 self::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
-     */
-    public function status_array($translated = false)
-    {
-        if (! array_key_exists('Status', $this->_model_relations)) {
-            return array();
-        }
-        $model_name = $this->get_this_model_name();
-        $status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
-        $stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
-        $status_array = array();
-        foreach ($stati 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             {
-     * @var array $0 (where) array {
-     *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
-     *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
-     *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
-     *                                        conditions based on related models (and even
-     *                                        models-related-to-related-models) prepend the model's name onto the field
-     *                                        name. Eg,
-     *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
-     *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
-     *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
-     *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
-     *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
-     *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
-     *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
-     *                                        to Venues (even when each of those models actually consisted of two
-     *                                        tables). Also, you may chain the model relations together. Eg instead of
-     *                                        just having
-     *                                        "Venue.VNU_ID", you could have
-     *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
-     *                                        events are related to Registrations, which are related to Attendees). You
-     *                                        can take it even further with
-     *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
-     *                                        (from the default of '='), change the value to an numerically-indexed
-     *                                        array, where the first item in the list is the operator. eg: array(
-     *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
-     *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
-     *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
-     *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
-     *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
-     *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
-     *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
-     *                                        the operator is IN. Also, values can actually be field names. To indicate
-     *                                        the value is a field, simply provide a third array item (true) to the
-     *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
-     *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
-     *                                        Note: you can also use related model field names like you would any other
-     *                                        field name. eg:
-     *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
-     *                                        be used if you were querying EEM_Tickets (because Datetime is directly related to tickets) Also, by default all the where conditions are AND'd together. To override this, add an array key 'OR' (or 'AND') and the array to be OR'd together eg: array('OR'=>array('TXN_ID' => 23 , 'TXN_timestamp__>' =>
-     *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
-     *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
-     *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
-     *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
-     *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
-     *                                        to be what you last specified. IE, "AND"s by default, but if you had
-     *                                        previously specified to use ORs to join, ORs will continue to be used.
-     *                                        So, if you specify to use an "OR" to join conditions, it will continue to
-     *                                        "stick" until you specify an AND. eg
-     *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
-     *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
-     *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
-     *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
-     *                                        array('OR'=>array('TXN_total' => 23, 'NOT'=> array( 'TXN_timestamp'=> 345678912, 'AND'=>array('TXN_paid' => 53, 'STS_ID' => 'TIN')))) becomes SQL >> "...WHERE TXN_total = 23 OR ! (TXN_timestamp = 345678912 OR (TXN_paid = 53 AND STS_ID = 'TIN'))..." GOTCHA: because this is an array, array keys must be unique, making it impossible to place two or more where conditions applying to the same field. eg: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp'=>array('<',$end_date),'PAY_timestamp'=>array('!=',$special_date)), as PHP enforces that the array keys must be unique, thus removing the first two array entries with key 'PAY_timestamp'. becomes SQL >> "PAY_timestamp !=  4234232", ignoring the first two PAY_timestamp conditions). To overcome this, you can add a '*' character to the end of the field's name, followed by anything. These will be removed when generating the SQL string, but allow for the array keys to be unique. eg: you could rewrite the previous query as: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp*1st'=>array('<',$end_date),'PAY_timestamp*2nd'=>array('!=',$special_date)) which correctly becomes SQL >>
-     *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
-     *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
-     *                                        too, eg:
-     *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
-     * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
-     *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
-     *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
-     *                                        Remember when you provide two numbers for the limit, the 1st number is
-     *                                        the OFFSET, the 2nd is the LIMIT
-     * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
-     *                                        can do paging on one-to-many multi-table-joins. Send an array in the
-     *                                        following format array('on_join_limit'
-     *                                        => array( 'table_alias', array(1,2) ) ).
-     * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
-     *                                        values are either 'ASC' or 'DESC'.
-     *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
-     *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
-     *                                        DESC..." respectively. Like the
-     *                                        'where' conditions, these fields can be on related models. Eg
-     *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
-     *                                        perfectly valid from any model related to 'Registration' (like Event,
-     *                                        Attendee, Price, Datetime, etc.)
-     * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
-     *                                        'order' specifies whether to order the field specified in 'order_by' in
-     *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
-     *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
-     *                                        order by the primary key. Eg,
-     *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
-     *                                        //(will join with the Datetime model's table(s) and order by its field
-     *                                        DTT_EVT_start) or
-     *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
-     *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
-     * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
-     *                                        'group_by'=>'VNU_ID', or
-     *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
-     *                                        if no
-     *                                        $group_by is specified, and a limit is set, automatically groups by the
-     *                                        model's primary key (or combined primary keys). This avoids some
-     *                                        weirdness that results when using limits, tons of joins, and no group by,
-     *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
-     * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
-     *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
-     *                                        results)
-     * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
-     *                                        array where values are models to be joined in the query.Eg
-     *                                        array('Attendee','Payment','Datetime'). You may join with transient
-     *                                        models using period, eg "Registration.Transaction.Payment". You will
-     *                                        probably only want to do this in hopes of increasing efficiency, as
-     *                                        related models which belongs to the current model
-     *                                        (ie, the current model has a foreign key to them, like how Registration
-     *                                        belongs to Attendee) can be cached in order to avoid future queries
-     * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
-     *                                        set this to 'none' to disable all default where conditions. Eg, usually
-     *                                        soft-deleted objects are filtered-out if you want to include them, set
-     *                                        this query param to 'none'. If you want to ONLY disable THIS model's
-     *                                        default where conditions set it to 'other_models_only'. If you only want
-     *                                        this model's default where conditions added to the query, use
-     *                                        'this_model_only'. If you want to use all default where conditions
-     *                                        (default), set to 'all'.
-     * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
-     *                                        we just NOT apply any capabilities/permissions/restrictions and return
-     *                                        everything? Or should we only show the current user items they should be
-     *                                        able to view on the frontend, backend, edit, or delete? can be set to
-     *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
-     *                                        }
-     * @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()and make it public
-     *                                        again. 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
-     */
-    public function get_all($query_params = array())
-    {
-        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, ARRAY_A, null));
-    }
-
-
-
-    /**
-     * Modifies the query parameters so we only get back model objects
-     * that "belong" to the current user
-     *
-     * @param array $query_params @see EEM_Base::get_all()
-     * @return array like EEM_Base::get_all
-     */
-    public function alter_query_params_to_only_include_mine($query_params = array())
-    {
-        $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
-     */
-    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      like EEM_Base::get_all's $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
-     */
-    protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
-    {
-        // remember the custom selections, if any, and type cast as array
-        // (unless $columns_to_select is an object, then just set as an empty array)
-        // Note: (array) 'some string' === array( 'some string' )
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
-        $select_expressions = $columns_to_select !== null
-            ? $this->_construct_select_from_input($columns_to_select)
-            : $this->_construct_default_select_sql($model_query_info);
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
-        return $this->_do_wpdb_query('get_results', array($SQL, $output));
-    }
-
-
-
-    /**
-     * Gets an array of rows from the database just like $wpdb->get_results would,
-     * but you can use the $query_params like on EEM_Base::get_all() to more easily
-     * take care of joins, field preparation etc.
-     *
-     * @param array  $query_params      like EEM_Base::get_all's $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
-     */
-    public function get_all_wpdb_results($query_params = array(), $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 mixed $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
-     * @throws EE_Error
-     * @return string
-     */
-    private function _construct_select_from_input($columns_to_select)
-    {
-        if (is_array($columns_to_select)) {
-            $select_sql_array = 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(
-                            __(
-                                "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
-     */
-    public function get_one_by_ID($id)
-    {
-        if ($this->get_from_entity_map($id)) {
-            return $this->get_from_entity_map($id);
-        }
-        return $this->get_one(
-            $this->alter_query_params_to_restrict_by_ID(
-                $id,
-                array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
-            )
-        );
-    }
-
-
-
-    /**
-     * 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
-     * @return array of normal query params, @see EEM_Base::get_all
-     * @throws EE_Error
-     */
-    public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
-    {
-        if (! isset($query_params[0])) {
-            $query_params[0] = array();
-        }
-        $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|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one($query_params = array())
-    {
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong('EEM_Base::get_one',
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)), '4.6.0');
-            $query_params = array();
-        }
-        $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
-     */
-    public function next_x(
-        $current_field_value,
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = array(),
-        $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
-     */
-    public function previous_x(
-        $current_field_value,
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = array(),
-        $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
-     */
-    public function next(
-        $current_field_value,
-        $field_to_order_by = null,
-        $query_params = array(),
-        $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
-     */
-    public function previous(
-        $current_field_value,
-        $field_to_order_by = null,
-        $query_params = array(),
-        $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
-     */
-    protected function _get_consecutive(
-        $current_field_value,
-        $operand = '>',
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = array(),
-        $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(__('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 array();
-            }
-        }
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)), '4.6.0');
-            $query_params = array();
-        }
-        //let's add the where query param for consecutive look up.
-        $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
-        $query_params['limit'] = $limit;
-        //set direction
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
-        $query_params['order_by'] = $operand === '>'
-            ? array($field_to_order_by => 'ASC') + $incoming_orderby
-            : array($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 null | string $timezone valid PHP DateTimeZone timezone string
-     */
-    public function set_timezone($timezone)
-    {
-        if ($timezone !== null) {
-            $this->_timezone = $timezone;
-        }
-        //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($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($timezone);
-            }
-        }
-    }
-
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string
-     */
-    public function get_timezone()
-    {
-        //first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
-        if (empty($this->_timezone)) {
-            foreach ($this->_fields as $field) {
-                if ($field instanceof EE_Datetime_Field) {
-                    $this->set_timezone($field->get_timezone());
-                    break;
-                }
-            }
-        }
-        //if timezone STILL empty then return the default timezone for the site.
-        if (empty($this->_timezone)) {
-            $this->set_timezone(EEH_DTT_Helper::get_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.
-     *
-     * @since 4.6.x
-     * @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).
-     * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
-     * @return array formats in an array with the date format first, and the time format last.
-     */
-    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(__('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.
-        $this->_timezone = $field_settings->get_timezone();
-        return array($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.
-     * @since 4.6.x
-     * @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.
-     * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
-     *                                 exception is triggered.
-     */
-    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->_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]);
-                break;
-            case 'date' :
-                return $DateTime->format($formats[0]);
-                break;
-            default :
-                return $DateTime->format(implode(' ', $formats));
-                break;
-        }
-    }
-
-
-
-    /**
-     * 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 $incoming_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 DateTime
-     * @throws EE_Error
-     */
-    public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
-    {
-        //just using this to ensure the timezone is set correctly internally
-        $this->get_formats_for($field_name);
-        //load EEH_DTT_Helper
-        $set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
-        $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
-        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
-    }
-
-
-
-    /**
-     * 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, ints, 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            very much like EEM_Base::get_all's $query_params
-     *                                         in client code into what's expected to be stored on each field. 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
-     */
-    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(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)), '4.6.0');
-            $query_params = array();
-        }
-        /**
-         * 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 EEM_Base::get_all()
-         */
-        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 EEM_Base::get_all()
-         */
-        $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;
-                        }
-                    }
-                }
-            }
-            //				//and now check that if we have cached any models by that ID on the model, that
-            //				//they also get updated properly
-            //				$model_object = $this->get_from_entity_map( $main_table_pk_value );
-            //				if( $model_object ){
-            //					foreach( $fields_n_values as $field => $value ){
-            //						$model_object->set($field, $value);
-            //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, ARRAY_A);
-                $model_objs_affected_ids = array();
-                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 = array(
-                    array($this->primary_key_name() => array('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', array($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    @see EEM_Base::get_all()
-         * @param int      $rows_affected
-         */
-        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 @see EEM_Base::get_all()
-     * @param string $field_to_select
-     * @return array just like $wpdb->get_col()
-     * @throws EE_Error
-     */
-    public function get_col($query_params = array(), $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 {
-            //no primary key, just grab the first column
-            $field = reset($this->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', array($SQL));
-    }
-
-
-
-    /**
-     * Returns a single column value for a single row from the database
-     *
-     * @param array  $query_params    @see EEM_Base::get_all()
-     * @param string $field_to_select @see EEM_Base::get_col()
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_var($query_params = array(), $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
-     *
-     * @global      $wpdb
-     * @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
-     */
-    public function _construct_update_sql($fields_n_values)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $cols_n_values = array();
-        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
-     */
-    public function delete_permanently_by_ID($id, $allow_blocking = true)
-    {
-        return $this->delete_permanently(
-            array(
-                array($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
-     */
-    public function delete_by_ID($id, $allow_blocking = true)
-    {
-        return $this->delete(
-            array(
-                array($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.
-     *
-     * @see EEM_Base::delete_permanently
-     * @param array   $query_params
-     * @param boolean $allow_blocking
-     * @return int how many rows got deleted
-     * @throws EE_Error
-     */
-    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   very much like EEM_Base::get_all's $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
-     */
-    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   @see EEM_Base::get_all()
-         * @param boolean  $allow_blocking whether or not to allow related model objects
-         *                                 to block (prevent) this deletion
-         */
-        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 = array_keys($this->_tables);
-            $SQL = "DELETE "
-                   . implode(", ", $table_aliases)
-                   . " FROM "
-                   . $model_query_info->get_full_join_sql()
-                   . " WHERE "
-                   . $deletion_where_query_part;
-            $rows_deleted = $this->_do_wpdb_query('query', array($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(array(
-                    0 => array(
-                        'EXM_type' => $this->get_this_model_name(),
-                        'OBJ_ID'   => array(
-                            '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 @see EEM_Base::get_all()
-         * @param int      $rows_deleted
-         */
-        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
-     */
-    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, array(
-                        array(
-                            $ignored_model->get_primary_key_field()->get_name() => array(
-                                '!=',
-                                $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
-     */
-    protected function _get_ids_for_delete(array $row_results_for_deleting, $allow_blocking = true)
-    {
-        $ids_to_delete_indexed_by_column = array();
-        if ($this->has_primary_key_field()) {
-            $primary_table = $this->_get_main_table();
-            $primary_table_pk_field = $this->get_field_by_column($primary_table->get_fully_qualified_pk_column());
-            $other_tables = $this->_get_other_tables();
-            $ids_to_delete_indexed_by_column = $query = array();
-            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 = array();
-                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(
-                    __(
-                        "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 = array();
-            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 = array();
-            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 = array();
-                foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
-                    $values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
-                }
-                $ways_to_identify_a_row[] = '(' . implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
-            }
-            $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
-     */
-    public function get_field_by_column($qualified_column_name)
-    {
-       foreach($this->field_settings(true) as $field_name => $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 expressed in $query_params (an array just like arg to EEM_Base::get_all).
-     * 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   like EEM_Base::get_all's
-     * @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
-     */
-    public function count($query_params = array(), $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 = array();
-                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', array($SQL));
-    }
-
-
-
-    /**
-     * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
-     *
-     * @param array  $query_params like EEM_Base::get_all
-     * @param string $field_to_sum name of field (array key in $_fields array)
-     * @return float
-     * @throws EE_Error
-     */
-    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', array($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
-     * @throws EE_Error
-     * @global wpdb  $wpdb
-     * @return mixed
-     */
-    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(sprintf(__("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")));
-        }
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        if (! method_exists($wpdb, $wpdb_method)) {
-            throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
-                'event_espresso'), $wpdb_method));
-        }
-        if (WP_DEBUG) {
-            $old_show_errors_value = $wpdb->show_errors;
-            $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(__('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(
-                    __('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
-     */
-    private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $wpdb->last_error = null;
-        $result = call_user_func_array(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;
-                    break;
-            }
-            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
-     */
-    private function _verify_core_db($wpdb_method, $arguments_to_provide)
-    {
-        /** @type WPDB $wpdb */
-        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(
-            __('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(false, true);
-        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
-     */
-    private function _verify_addons_db($wpdb_method, $arguments_to_provide)
-    {
-        /** @type WPDB $wpdb */
-        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(
-            __('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 = array()
-    ) {
-        $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
-     * @return boolean of success
-     * @throws EE_Error
-     * @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.
-     */
-    public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
-    {
-        $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 = array())
-    {
-        $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 like EEM_Base::get_all
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     */
-    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
-     */
-    public function delete_related($id_or_obj, $model_name, $query_params = array())
-    {
-        $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
-     */
-    public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
-    {
-        $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   like EEM_Base::get_all's
-     * @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
-     */
-    public function count_related(
-        $id_or_obj,
-        $model_name,
-        $query_params = array(),
-        $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 like EEM_Base::get_all's
-     * @param string $field_to_sum name of field to count by. By default, uses primary key
-     * @return float
-     * @throws EE_Error
-     */
-    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(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)), '4.6.0');
-            $query_params = array();
-        }
-        //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     like EEM_Base::get_all's
-     * @return EE_Base_Class
-     * @throws EE_Error
-     */
-    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(__("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 new primary key on main table that got inserted
-     * @throws EE_Error
-     */
-    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
-     */
-    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(array($uniqueness_where_params))) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            "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
-     * @throws EE_Error
-     * @return EE_Base_Class|array
-     */
-    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(
-                    __(
-                        "%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 = array();
-        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 array();
-        }
-        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
-     */
-    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
-     */
-    public function exists_by_ID($id)
-    {
-        return $this->exists(
-            array(
-                'default_where_conditions' => EEM_Base::default_where_conditions_none,
-                array(
-                    $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
-     * @throws EE_Error
-     * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
-     * @return int ID of new row inserted, or FALSE on failure
-     */
-    protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
-    {
-        global $wpdb;
-        $insertion_col_n_values = array();
-        $format_for_insertion = array();
-        $fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
-        foreach ($fields_on_table as $field_name => $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',
-            array($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) {
-            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;
-        }
-        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(__('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 = array();
-        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 like EEM_Base::get_all's $query_parameters['where']
-     * @return EE_Model_Query_Info_Carrier
-     * @throws EE_Error
-     */
-    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'
-            );
-        }
-        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 like EEM_Base::get_all's $query_params[0] or
-     *                                                      $query_params['having']
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
-     * @param string                      $query_param_type one of $this->_allowed_query_params
-     * @throws EE_Error
-     * @return \EE_Model_Query_Info_Carrier
-     */
-    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(__("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(__("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);
-                }
-            }
-        }
-        return $model_query_info_carrier;
-    }
-
-
-
-    /**
-     * 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 like EEM_Base::get_all's $query_params[0] or
-     *                                                      $query_params['having']
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
-     * @param string                      $query_param_type one of $this->_allowed_query_params
-     * @throws EE_Error
-     * @return \EE_Model_Query_Info_Carrier
-     */
-    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(__("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);
-            }
-        }
-        return $model_query_info_carrier;
-    }
-
-
-
-    /**
-     * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
-     * 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
-     * @throws EE_Error
-     * @return EE_Model_Query_Info_Carrier
-     */
-    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(
-                    __(
-                        '$query_params should be an array, you passed a variable of type %s',
-                        'event_espresso'
-                    ),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = array();
-        }
-        $where_query_params = isset($query_params[0]) ? $query_params[0] : array();
-        //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] = $where_query_params = array_replace_recursive(
-                $where_query_params,
-                $this->caps_where_conditions(
-                    $query_params['caps']
-                )
-            );
-        }
-        $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 ($where_query_params as $key => $value) {
-            if (is_int($key)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            "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;
-        }
-        $where_query_params = array_merge(
-            $this->_get_default_where_conditions_for_models_in_query(
-                $query_object,
-                $use_default_where_conditions,
-                $where_query_params
-            ),
-            $where_query_params
-        );
-        $query_object->set_where_sql($this->_construct_where_clause($where_query_params));
-        // 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(
-                        __(
-                            "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(
-                            __(
-                                "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 = 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 = 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(
-                        __(
-                            "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 like EEM_Base::get_all() 's $query_params[0]
-     * @throws EE_Error
-     */
-    public function caps_where_conditions($context = self::caps_read)
-    {
-        EEM_Base::verify_is_valid_cap_context($context);
-        $cap_where_conditions = array();
-        $cap_restrictions = $this->caps_missing($context);
-        /**
-         * @var $cap_restrictions EE_Default_Where_Conditions[]
-         */
-        foreach ($cap_restrictions as $cap => $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(
-                __(
-                    "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           like EEM_Base::get_all's $query_params[0]
-     * @throws EE_Error
-     * @return array like $query_params[0], see EEM_Base::get_all for documentation
-     */
-    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 = array()
-    ) {
-        $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(__("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 = array();
-        if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
-            $universal_query_params = $this->_get_default_where_conditions();
-        } else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
-            $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,
-                       array(
-                           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,
-                       array(
-                           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,
-                       array(
-                           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 like EEM_Base::get_all's $query_params[0]
-     * @throws EE_Error
-     */
-    private function _override_defaults_or_make_null_friendly(
-        $default_where_conditions,
-        $provided_where_conditions,
-        $model,
-        $model_relation_path
-    ) {
-        $null_friendly_where_conditions = array();
-        $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()] = array('IS NULL');
-            }/*else{
+	/**
+	 * 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;
+
+	/**
+	 * 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;
+
+
+	protected $singular_item = 'Item';
+
+	protected $plural_item   = 'Items';
+
+	/**
+	 * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
+	 */
+	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 = array();
+
+	/**
+	 * 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 = '';
+
+	/**
+	 * 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 each's value is 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 = array(
+		self::caps_read       => array(),
+		self::caps_read_admin => array(),
+		self::caps_edit       => array(),
+		self::caps_delete     => array(),
+	);
+
+	/**
+	 * 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 = array();
+
+	/**
+	 * 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';
+
+	/**
+	 * 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 = array(
+		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 = array();
+
+	/**
+	 * 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;
+
+	/**
+	 * 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;
+
+	/**
+	 *    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 = array(
+		'='           => '=',
+		'<='          => '<=',
+		'<'           => '<',
+		'>='          => '>=',
+		'>'           => '>',
+		'!='          => '!=',
+		'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 = array('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 = array('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 = array('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 = array('IS NOT NULL', 'IS NULL');
+
+	/**
+	 * Allowed values for $query_params['order'] for ordering in queries
+	 *
+	 * @var array
+	 */
+	protected $_allowed_order_values = array('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 = array('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 = array(
+		0,
+		'limit',
+		'order_by',
+		'group_by',
+		'having',
+		'force_join',
+		'order',
+		'on_join_limit',
+		'default_where_conditions',
+		'caps',
+	);
+
+	/**
+	 * All the data types that can be used in $wpdb->prepare statements.
+	 *
+	 * @var array
+	 */
+	private $_valid_wpdb_data_types = array('%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 so those selections can be used in WHERE, GROUP_BY, etc.
+	 *
+	 * @var array
+	 */
+	protected $_custom_selections = array();
+
+	/**
+	 * 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;
+
+
+	/**
+	 * 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;
+
+	/**
+	 * 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;
+
+	/**
+	 * @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';
+
+
+
+	/**
+	 * 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 null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		// check that the model has not been loaded too soon
+		if (! did_action('AHEE__EE_System__load_espresso_addons')) {
+			throw new EE_Error (
+				sprintf(
+					__('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 blogid 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(__("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) {
+			/** @var $index_obj EE_Index */
+			$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 ($this->_cap_restriction_generators !== false) {
+			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 there are cap restriction generators, use them to make the default cap restrictions
+		if ($this->_cap_restriction_generators !== false) {
+			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(
+							__('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 = null)
+	{
+		// 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')
+			);
+		}
+		//we might have a timezone set, let set_timezone decide what to do with it
+		static::$_instance->set_timezone($timezone);
+		// Espresso_model object
+		return static::$_instance;
+	}
+
+
+
+	/**
+	 * resets the model and returns it
+	 *
+	 * @param null | 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 = null)
+	{
+		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;
+				}
+			}
+			//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 self::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
+	 */
+	public function status_array($translated = false)
+	{
+		if (! array_key_exists('Status', $this->_model_relations)) {
+			return array();
+		}
+		$model_name = $this->get_this_model_name();
+		$status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
+		$stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
+		$status_array = array();
+		foreach ($stati 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             {
+	 * @var array $0 (where) array {
+	 *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
+	 *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
+	 *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
+	 *                                        conditions based on related models (and even
+	 *                                        models-related-to-related-models) prepend the model's name onto the field
+	 *                                        name. Eg,
+	 *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
+	 *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
+	 *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
+	 *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
+	 *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
+	 *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
+	 *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
+	 *                                        to Venues (even when each of those models actually consisted of two
+	 *                                        tables). Also, you may chain the model relations together. Eg instead of
+	 *                                        just having
+	 *                                        "Venue.VNU_ID", you could have
+	 *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
+	 *                                        events are related to Registrations, which are related to Attendees). You
+	 *                                        can take it even further with
+	 *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
+	 *                                        (from the default of '='), change the value to an numerically-indexed
+	 *                                        array, where the first item in the list is the operator. eg: array(
+	 *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
+	 *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
+	 *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
+	 *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
+	 *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
+	 *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
+	 *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
+	 *                                        the operator is IN. Also, values can actually be field names. To indicate
+	 *                                        the value is a field, simply provide a third array item (true) to the
+	 *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
+	 *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
+	 *                                        Note: you can also use related model field names like you would any other
+	 *                                        field name. eg:
+	 *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
+	 *                                        be used if you were querying EEM_Tickets (because Datetime is directly related to tickets) Also, by default all the where conditions are AND'd together. To override this, add an array key 'OR' (or 'AND') and the array to be OR'd together eg: array('OR'=>array('TXN_ID' => 23 , 'TXN_timestamp__>' =>
+	 *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
+	 *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
+	 *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
+	 *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
+	 *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
+	 *                                        to be what you last specified. IE, "AND"s by default, but if you had
+	 *                                        previously specified to use ORs to join, ORs will continue to be used.
+	 *                                        So, if you specify to use an "OR" to join conditions, it will continue to
+	 *                                        "stick" until you specify an AND. eg
+	 *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
+	 *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
+	 *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
+	 *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
+	 *                                        array('OR'=>array('TXN_total' => 23, 'NOT'=> array( 'TXN_timestamp'=> 345678912, 'AND'=>array('TXN_paid' => 53, 'STS_ID' => 'TIN')))) becomes SQL >> "...WHERE TXN_total = 23 OR ! (TXN_timestamp = 345678912 OR (TXN_paid = 53 AND STS_ID = 'TIN'))..." GOTCHA: because this is an array, array keys must be unique, making it impossible to place two or more where conditions applying to the same field. eg: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp'=>array('<',$end_date),'PAY_timestamp'=>array('!=',$special_date)), as PHP enforces that the array keys must be unique, thus removing the first two array entries with key 'PAY_timestamp'. becomes SQL >> "PAY_timestamp !=  4234232", ignoring the first two PAY_timestamp conditions). To overcome this, you can add a '*' character to the end of the field's name, followed by anything. These will be removed when generating the SQL string, but allow for the array keys to be unique. eg: you could rewrite the previous query as: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp*1st'=>array('<',$end_date),'PAY_timestamp*2nd'=>array('!=',$special_date)) which correctly becomes SQL >>
+	 *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
+	 *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
+	 *                                        too, eg:
+	 *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
+	 * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
+	 *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
+	 *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
+	 *                                        Remember when you provide two numbers for the limit, the 1st number is
+	 *                                        the OFFSET, the 2nd is the LIMIT
+	 * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
+	 *                                        can do paging on one-to-many multi-table-joins. Send an array in the
+	 *                                        following format array('on_join_limit'
+	 *                                        => array( 'table_alias', array(1,2) ) ).
+	 * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
+	 *                                        values are either 'ASC' or 'DESC'.
+	 *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
+	 *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
+	 *                                        DESC..." respectively. Like the
+	 *                                        'where' conditions, these fields can be on related models. Eg
+	 *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
+	 *                                        perfectly valid from any model related to 'Registration' (like Event,
+	 *                                        Attendee, Price, Datetime, etc.)
+	 * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
+	 *                                        'order' specifies whether to order the field specified in 'order_by' in
+	 *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
+	 *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
+	 *                                        order by the primary key. Eg,
+	 *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
+	 *                                        //(will join with the Datetime model's table(s) and order by its field
+	 *                                        DTT_EVT_start) or
+	 *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
+	 *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
+	 * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
+	 *                                        'group_by'=>'VNU_ID', or
+	 *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
+	 *                                        if no
+	 *                                        $group_by is specified, and a limit is set, automatically groups by the
+	 *                                        model's primary key (or combined primary keys). This avoids some
+	 *                                        weirdness that results when using limits, tons of joins, and no group by,
+	 *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
+	 * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
+	 *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
+	 *                                        results)
+	 * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
+	 *                                        array where values are models to be joined in the query.Eg
+	 *                                        array('Attendee','Payment','Datetime'). You may join with transient
+	 *                                        models using period, eg "Registration.Transaction.Payment". You will
+	 *                                        probably only want to do this in hopes of increasing efficiency, as
+	 *                                        related models which belongs to the current model
+	 *                                        (ie, the current model has a foreign key to them, like how Registration
+	 *                                        belongs to Attendee) can be cached in order to avoid future queries
+	 * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
+	 *                                        set this to 'none' to disable all default where conditions. Eg, usually
+	 *                                        soft-deleted objects are filtered-out if you want to include them, set
+	 *                                        this query param to 'none'. If you want to ONLY disable THIS model's
+	 *                                        default where conditions set it to 'other_models_only'. If you only want
+	 *                                        this model's default where conditions added to the query, use
+	 *                                        'this_model_only'. If you want to use all default where conditions
+	 *                                        (default), set to 'all'.
+	 * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
+	 *                                        we just NOT apply any capabilities/permissions/restrictions and return
+	 *                                        everything? Or should we only show the current user items they should be
+	 *                                        able to view on the frontend, backend, edit, or delete? can be set to
+	 *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
+	 *                                        }
+	 * @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()and make it public
+	 *                                        again. 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
+	 */
+	public function get_all($query_params = array())
+	{
+		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, ARRAY_A, null));
+	}
+
+
+
+	/**
+	 * Modifies the query parameters so we only get back model objects
+	 * that "belong" to the current user
+	 *
+	 * @param array $query_params @see EEM_Base::get_all()
+	 * @return array like EEM_Base::get_all
+	 */
+	public function alter_query_params_to_only_include_mine($query_params = array())
+	{
+		$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
+	 */
+	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      like EEM_Base::get_all's $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
+	 */
+	protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
+	{
+		// remember the custom selections, if any, and type cast as array
+		// (unless $columns_to_select is an object, then just set as an empty array)
+		// Note: (array) 'some string' === array( 'some string' )
+		$this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
+		$select_expressions = $columns_to_select !== null
+			? $this->_construct_select_from_input($columns_to_select)
+			: $this->_construct_default_select_sql($model_query_info);
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
+		return $this->_do_wpdb_query('get_results', array($SQL, $output));
+	}
+
+
+
+	/**
+	 * Gets an array of rows from the database just like $wpdb->get_results would,
+	 * but you can use the $query_params like on EEM_Base::get_all() to more easily
+	 * take care of joins, field preparation etc.
+	 *
+	 * @param array  $query_params      like EEM_Base::get_all's $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
+	 */
+	public function get_all_wpdb_results($query_params = array(), $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 mixed $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
+	 * @throws EE_Error
+	 * @return string
+	 */
+	private function _construct_select_from_input($columns_to_select)
+	{
+		if (is_array($columns_to_select)) {
+			$select_sql_array = 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(
+							__(
+								"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
+	 */
+	public function get_one_by_ID($id)
+	{
+		if ($this->get_from_entity_map($id)) {
+			return $this->get_from_entity_map($id);
+		}
+		return $this->get_one(
+			$this->alter_query_params_to_restrict_by_ID(
+				$id,
+				array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
+			)
+		);
+	}
+
+
+
+	/**
+	 * 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
+	 * @return array of normal query params, @see EEM_Base::get_all
+	 * @throws EE_Error
+	 */
+	public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
+	{
+		if (! isset($query_params[0])) {
+			$query_params[0] = array();
+		}
+		$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|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one($query_params = array())
+	{
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong('EEM_Base::get_one',
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)), '4.6.0');
+			$query_params = array();
+		}
+		$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
+	 */
+	public function next_x(
+		$current_field_value,
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = array(),
+		$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
+	 */
+	public function previous_x(
+		$current_field_value,
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = array(),
+		$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
+	 */
+	public function next(
+		$current_field_value,
+		$field_to_order_by = null,
+		$query_params = array(),
+		$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
+	 */
+	public function previous(
+		$current_field_value,
+		$field_to_order_by = null,
+		$query_params = array(),
+		$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
+	 */
+	protected function _get_consecutive(
+		$current_field_value,
+		$operand = '>',
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = array(),
+		$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(__('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 array();
+			}
+		}
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)), '4.6.0');
+			$query_params = array();
+		}
+		//let's add the where query param for consecutive look up.
+		$query_params[0][$field_to_order_by] = array($operand, $current_field_value);
+		$query_params['limit'] = $limit;
+		//set direction
+		$incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
+		$query_params['order_by'] = $operand === '>'
+			? array($field_to_order_by => 'ASC') + $incoming_orderby
+			: array($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 null | string $timezone valid PHP DateTimeZone timezone string
+	 */
+	public function set_timezone($timezone)
+	{
+		if ($timezone !== null) {
+			$this->_timezone = $timezone;
+		}
+		//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($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($timezone);
+			}
+		}
+	}
+
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function get_timezone()
+	{
+		//first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
+		if (empty($this->_timezone)) {
+			foreach ($this->_fields as $field) {
+				if ($field instanceof EE_Datetime_Field) {
+					$this->set_timezone($field->get_timezone());
+					break;
+				}
+			}
+		}
+		//if timezone STILL empty then return the default timezone for the site.
+		if (empty($this->_timezone)) {
+			$this->set_timezone(EEH_DTT_Helper::get_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.
+	 *
+	 * @since 4.6.x
+	 * @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).
+	 * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
+	 * @return array formats in an array with the date format first, and the time format last.
+	 */
+	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(__('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.
+		$this->_timezone = $field_settings->get_timezone();
+		return array($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.
+	 * @since 4.6.x
+	 * @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.
+	 * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
+	 * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
+	 *                                 exception is triggered.
+	 */
+	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->_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]);
+				break;
+			case 'date' :
+				return $DateTime->format($formats[0]);
+				break;
+			default :
+				return $DateTime->format(implode(' ', $formats));
+				break;
+		}
+	}
+
+
+
+	/**
+	 * 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 $incoming_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 DateTime
+	 * @throws EE_Error
+	 */
+	public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
+	{
+		//just using this to ensure the timezone is set correctly internally
+		$this->get_formats_for($field_name);
+		//load EEH_DTT_Helper
+		$set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
+		$incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
+		return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
+	}
+
+
+
+	/**
+	 * 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, ints, 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            very much like EEM_Base::get_all's $query_params
+	 *                                         in client code into what's expected to be stored on each field. 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
+	 */
+	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(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)), '4.6.0');
+			$query_params = array();
+		}
+		/**
+		 * 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 EEM_Base::get_all()
+		 */
+		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 EEM_Base::get_all()
+		 */
+		$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;
+						}
+					}
+				}
+			}
+			//				//and now check that if we have cached any models by that ID on the model, that
+			//				//they also get updated properly
+			//				$model_object = $this->get_from_entity_map( $main_table_pk_value );
+			//				if( $model_object ){
+			//					foreach( $fields_n_values as $field => $value ){
+			//						$model_object->set($field, $value);
+			//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, ARRAY_A);
+				$model_objs_affected_ids = array();
+				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 = array(
+					array($this->primary_key_name() => array('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', array($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    @see EEM_Base::get_all()
+		 * @param int      $rows_affected
+		 */
+		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 @see EEM_Base::get_all()
+	 * @param string $field_to_select
+	 * @return array just like $wpdb->get_col()
+	 * @throws EE_Error
+	 */
+	public function get_col($query_params = array(), $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 {
+			//no primary key, just grab the first column
+			$field = reset($this->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', array($SQL));
+	}
+
+
+
+	/**
+	 * Returns a single column value for a single row from the database
+	 *
+	 * @param array  $query_params    @see EEM_Base::get_all()
+	 * @param string $field_to_select @see EEM_Base::get_col()
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_var($query_params = array(), $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
+	 *
+	 * @global      $wpdb
+	 * @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
+	 */
+	public function _construct_update_sql($fields_n_values)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$cols_n_values = array();
+		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
+	 */
+	public function delete_permanently_by_ID($id, $allow_blocking = true)
+	{
+		return $this->delete_permanently(
+			array(
+				array($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
+	 */
+	public function delete_by_ID($id, $allow_blocking = true)
+	{
+		return $this->delete(
+			array(
+				array($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.
+	 *
+	 * @see EEM_Base::delete_permanently
+	 * @param array   $query_params
+	 * @param boolean $allow_blocking
+	 * @return int how many rows got deleted
+	 * @throws EE_Error
+	 */
+	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   very much like EEM_Base::get_all's $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
+	 */
+	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   @see EEM_Base::get_all()
+		 * @param boolean  $allow_blocking whether or not to allow related model objects
+		 *                                 to block (prevent) this deletion
+		 */
+		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 = array_keys($this->_tables);
+			$SQL = "DELETE "
+				   . implode(", ", $table_aliases)
+				   . " FROM "
+				   . $model_query_info->get_full_join_sql()
+				   . " WHERE "
+				   . $deletion_where_query_part;
+			$rows_deleted = $this->_do_wpdb_query('query', array($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(array(
+					0 => array(
+						'EXM_type' => $this->get_this_model_name(),
+						'OBJ_ID'   => array(
+							'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 @see EEM_Base::get_all()
+		 * @param int      $rows_deleted
+		 */
+		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
+	 */
+	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, array(
+						array(
+							$ignored_model->get_primary_key_field()->get_name() => array(
+								'!=',
+								$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
+	 */
+	protected function _get_ids_for_delete(array $row_results_for_deleting, $allow_blocking = true)
+	{
+		$ids_to_delete_indexed_by_column = array();
+		if ($this->has_primary_key_field()) {
+			$primary_table = $this->_get_main_table();
+			$primary_table_pk_field = $this->get_field_by_column($primary_table->get_fully_qualified_pk_column());
+			$other_tables = $this->_get_other_tables();
+			$ids_to_delete_indexed_by_column = $query = array();
+			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 = array();
+				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(
+					__(
+						"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 = array();
+			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 = array();
+			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 = array();
+				foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
+					$values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
+				}
+				$ways_to_identify_a_row[] = '(' . implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
+			}
+			$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
+	 */
+	public function get_field_by_column($qualified_column_name)
+	{
+	   foreach($this->field_settings(true) as $field_name => $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 expressed in $query_params (an array just like arg to EEM_Base::get_all).
+	 * 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   like EEM_Base::get_all's
+	 * @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
+	 */
+	public function count($query_params = array(), $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 = array();
+				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', array($SQL));
+	}
+
+
+
+	/**
+	 * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
+	 *
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @param string $field_to_sum name of field (array key in $_fields array)
+	 * @return float
+	 * @throws EE_Error
+	 */
+	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', array($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
+	 * @throws EE_Error
+	 * @global wpdb  $wpdb
+	 * @return mixed
+	 */
+	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(sprintf(__("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")));
+		}
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		if (! method_exists($wpdb, $wpdb_method)) {
+			throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
+				'event_espresso'), $wpdb_method));
+		}
+		if (WP_DEBUG) {
+			$old_show_errors_value = $wpdb->show_errors;
+			$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(__('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(
+					__('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
+	 */
+	private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$wpdb->last_error = null;
+		$result = call_user_func_array(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;
+					break;
+			}
+			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
+	 */
+	private function _verify_core_db($wpdb_method, $arguments_to_provide)
+	{
+		/** @type WPDB $wpdb */
+		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(
+			__('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(false, true);
+		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
+	 */
+	private function _verify_addons_db($wpdb_method, $arguments_to_provide)
+	{
+		/** @type WPDB $wpdb */
+		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(
+			__('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 = array()
+	) {
+		$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
+	 * @return boolean of success
+	 * @throws EE_Error
+	 * @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.
+	 */
+	public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
+	{
+		$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 = array())
+	{
+		$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 like EEM_Base::get_all
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	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
+	 */
+	public function delete_related($id_or_obj, $model_name, $query_params = array())
+	{
+		$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
+	 */
+	public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
+	{
+		$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   like EEM_Base::get_all's
+	 * @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
+	 */
+	public function count_related(
+		$id_or_obj,
+		$model_name,
+		$query_params = array(),
+		$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 like EEM_Base::get_all's
+	 * @param string $field_to_sum name of field to count by. By default, uses primary key
+	 * @return float
+	 * @throws EE_Error
+	 */
+	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(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)), '4.6.0');
+			$query_params = array();
+		}
+		//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     like EEM_Base::get_all's
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 */
+	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(__("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 new primary key on main table that got inserted
+	 * @throws EE_Error
+	 */
+	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
+	 */
+	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(array($uniqueness_where_params))) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							"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
+	 * @throws EE_Error
+	 * @return EE_Base_Class|array
+	 */
+	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(
+					__(
+						"%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 = array();
+		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 array();
+		}
+		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
+	 */
+	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
+	 */
+	public function exists_by_ID($id)
+	{
+		return $this->exists(
+			array(
+				'default_where_conditions' => EEM_Base::default_where_conditions_none,
+				array(
+					$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
+	 * @throws EE_Error
+	 * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
+	 * @return int ID of new row inserted, or FALSE on failure
+	 */
+	protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
+	{
+		global $wpdb;
+		$insertion_col_n_values = array();
+		$format_for_insertion = array();
+		$fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
+		foreach ($fields_on_table as $field_name => $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',
+			array($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) {
+			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;
+		}
+		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(__('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 = array();
+		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 like EEM_Base::get_all's $query_parameters['where']
+	 * @return EE_Model_Query_Info_Carrier
+	 * @throws EE_Error
+	 */
+	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'
+			);
+		}
+		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 like EEM_Base::get_all's $query_params[0] or
+	 *                                                      $query_params['having']
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
+	 * @throws EE_Error
+	 * @return \EE_Model_Query_Info_Carrier
+	 */
+	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(__("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(__("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);
+				}
+			}
+		}
+		return $model_query_info_carrier;
+	}
+
+
+
+	/**
+	 * 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 like EEM_Base::get_all's $query_params[0] or
+	 *                                                      $query_params['having']
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
+	 * @throws EE_Error
+	 * @return \EE_Model_Query_Info_Carrier
+	 */
+	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(__("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);
+			}
+		}
+		return $model_query_info_carrier;
+	}
+
+
+
+	/**
+	 * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
+	 * 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
+	 * @throws EE_Error
+	 * @return EE_Model_Query_Info_Carrier
+	 */
+	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(
+					__(
+						'$query_params should be an array, you passed a variable of type %s',
+						'event_espresso'
+					),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = array();
+		}
+		$where_query_params = isset($query_params[0]) ? $query_params[0] : array();
+		//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] = $where_query_params = array_replace_recursive(
+				$where_query_params,
+				$this->caps_where_conditions(
+					$query_params['caps']
+				)
+			);
+		}
+		$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 ($where_query_params as $key => $value) {
+			if (is_int($key)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							"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;
+		}
+		$where_query_params = array_merge(
+			$this->_get_default_where_conditions_for_models_in_query(
+				$query_object,
+				$use_default_where_conditions,
+				$where_query_params
+			),
+			$where_query_params
+		);
+		$query_object->set_where_sql($this->_construct_where_clause($where_query_params));
+		// 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(
+						__(
+							"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(
+							__(
+								"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 = 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 = 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(
+						__(
+							"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 like EEM_Base::get_all() 's $query_params[0]
+	 * @throws EE_Error
+	 */
+	public function caps_where_conditions($context = self::caps_read)
+	{
+		EEM_Base::verify_is_valid_cap_context($context);
+		$cap_where_conditions = array();
+		$cap_restrictions = $this->caps_missing($context);
+		/**
+		 * @var $cap_restrictions EE_Default_Where_Conditions[]
+		 */
+		foreach ($cap_restrictions as $cap => $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(
+				__(
+					"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           like EEM_Base::get_all's $query_params[0]
+	 * @throws EE_Error
+	 * @return array like $query_params[0], see EEM_Base::get_all for documentation
+	 */
+	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 = array()
+	) {
+		$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(__("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 = array();
+		if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
+			$universal_query_params = $this->_get_default_where_conditions();
+		} else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
+			$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,
+					   array(
+						   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,
+					   array(
+						   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,
+					   array(
+						   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 like EEM_Base::get_all's $query_params[0]
+	 * @throws EE_Error
+	 */
+	private function _override_defaults_or_make_null_friendly(
+		$default_where_conditions,
+		$provided_where_conditions,
+		$model,
+		$model_relation_path
+	) {
+		$null_friendly_where_conditions = array();
+		$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()] = array('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 like EEM_Base::get_all's $query_params[0] (where conditions)
-     */
-    private function _get_default_where_conditions($model_relation_path = null)
-    {
-        if ($this->_ignore_where_strategy) {
-            return array();
-        }
-        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 like EEM_Base::get_all's $query_params[0] (where conditions)
-     */
-    protected function _get_minimum_where_conditions($model_relation_path = null)
-    {
-        if ($this->_ignore_where_strategy) {
-            return array();
-        }
-        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 $key => $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 = array();
-        $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 null|string                 $original_query_param
-     * @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                      $original_query_param what it originally was (eg
-     *                                                          Registration.Transaction.TXN_ID). If null, we assume it
-     *                                                          matches $query_param
-     * @throws EE_Error
-     * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
-     */
-    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);
-        /** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
-        $allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
-        $allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
-        //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(
-                    __(
-                        "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(
-                    __(
-                        '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 (array_key_exists($query_param, $this->_custom_selections)) {
-            return;
-        }
-        //check if has a model name at the beginning
-        //and
-        //check if it's a field on a related model
-        foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
-                if ($query_param === '') {
-                    //nothing left to $query_param
-                    //we should actually end in a field name, not a model like this!
-                    throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
-                        "event_espresso"),
-                        $query_param, $query_param_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(
-                    $query_param,
-                    $passed_in_query_info, $query_param_type, $original_query_param
-                );
-                return;
-            }
-            if ($query_param === $valid_related_model_name) {
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
-                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(__("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));
-    }
-
-
-
-    /**
-     * 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(
-                    array($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(
-                array($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 like EEM_Base::get_all
-     * @return string of SQL
-     * @throws EE_Error
-     */
-    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 see EEM_Base::get_all for documentation
-     * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
-     * @throws EE_Error
-     * @return string of SQL
-     */
-    private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
-    {
-        $where_clauses = array();
-        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 (isset($this->_custom_selections[$query_param][1])) {
-                        $field_obj = $this->_custom_selections[$query_param][1];
-                    } else {
-                        throw new EE_Error(sprintf(__("%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
-     * @throws EE_Error
-     * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
-     */
-    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 (array_key_exists($query_param, $this->_custom_selections)) {
-            //maybe it's custom selection item?
-            //if so, just use it as the "column name"
-            return $query_param;
-        }
-        throw new EE_Error(
-            sprintf(
-                __(
-                    "%s is not a valid field on this model, nor a custom selection (%s)",
-                    "event_espresso"
-                ), $query_param, implode(",", $this->_custom_selections)
-            )
-        );
-    }
-
-
-
-    /**
-     * 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;
-        }
-        $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
-        return $condition_query_param_sans_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
-     * @throws EE_Error
-     * @return string
-     */
-    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 = array();
-                foreach ($op_and_value as $key => $value) {
-                    $php_array_like_string[] = "$key=>$value";
-                }
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            "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(
-                        __(
-                            "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(
-                        __(
-                            "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(
-                    __(
-                        "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(
-                    __(
-                        "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(
-                __(
-                    "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 = array();
-        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 = array();
-        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'
-     * @throws EE_Error
-     * @return false|null|string
-     */
-    private function _wpdb_prepare_using_field($value, $field_obj)
-    {
-        /** @type WPDB $wpdb */
-        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(
-                    __("%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
-     * @throws EE_Error
-     * @return EE_Model_Field_Base
-     */
-    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(__("_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];
-        if ($number_of_parts === 1) {
-            $field_name = $last_query_param_part;
-            $model_obj = $this;
-        } else {// $number_of_parts >= 2
-            //the last part is the column name, and there are only 2parts. therefore...
-            $field_name = $last_query_param_part;
-            $model_obj = $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
-     * @throws EE_Error
-     * @return string
-     */
-    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(
-                __(
-                    "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 = array();
-        foreach ($this->field_settings() as $field_name => $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.
-     */
-    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
-     */
-    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 = array();
-        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
-     * @throws EE_Error
-     * @return EEM_Base
-     */
-    public function get_related_model_obj($model_name)
-    {
-        $model_classname = "EEM_" . $model_name;
-        if (! class_exists($model_classname)) {
-            throw new EE_Error(sprintf(__("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 = array();
-        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
-     * @throws EE_Error
-     * @return EE_Model_Relation_Base
-     */
-    public function related_settings_for($relation_name)
-    {
-        $relatedModels = $this->relation_settings();
-        if (! array_key_exists($relation_name, $relatedModels)) {
-            throw new EE_Error(
-                sprintf(
-                    __('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
-     * @throws EE_Error
-     * @return EE_Model_Field_Base
-     */
-    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(__("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 ? true : false;
-    }
-
-
-
-    /**
-     * 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(__("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(__("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 = array();
-                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 = array();
-            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
-     */
-    protected function _create_objects($rows = array())
-    {
-        $array_of_objects = array();
-        if (empty($rows)) {
-            return array();
-        }
-        $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 array();
-            }
-            //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(
-                        __('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->_timezone);
-            //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->_timezone);
-                        $classInstance->cache($modelName, $other_model_obj_maybe);
-                    }
-                }
-            }
-        }
-        return $array_of_objects;
-    }
-
-
-
-    /**
-     * 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.
-     */
-    public function create_default_object()
-    {
-        $this_model_fields_and_values = array();
-        //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();
-        $classInstance = EE_Registry::instance()
-                                    ->load_class($className, array($this_model_fields_and_values), false, false);
-        return $classInstance;
-    }
-
-
-
-    /**
-     * @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
-     */
-    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;
-            }
-        } else if ($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,
-                                                array($this_model_fields_n_values, $this->_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, array($this_model_fields_n_values, $this->_timezone),
-                                            true, false);
-        }
-        //it is entirely possible that the instantiated class object has a set timezone_string db field and has set it's internal _timezone property accordingly (see new_instance_from_db in model objects particularly EE_Event for example).  In this case, we want to make sure the model object doesn't have its timezone string overwritten by any timezone property currently set here on the model so, we intentionally override the model _timezone property with the model_object timezone property.
-        $this->set_timezone($classInstance->get_timezone());
-        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
-     * @throws EE_Error
-     * @return \EE_Base_Class
-     */
-    public function add_to_entity_map(EE_Base_Class $object)
-    {
-        $className = $this->_get_class_name();
-        if (! $object instanceof $className) {
-            throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
-                is_object($object) ? get_class($object) : $object, $className));
-        }
-        /** @var $object EE_Base_Class */
-        if (! $object->ID()) {
-            throw new EE_Error(sprintf(__("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] = array();
-            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
-     */
-    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 string $cols_n_values
-     * @return array
-     */
-    protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
-    {
-        $this_model_fields_n_values = array();
-        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 $cols_n_values
-     * @param $qualified_column
-     * @param $regular_column
-     * @return null
-     */
-    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];
-        }
-        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
-     */
-    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(
-                array(array($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
-     */
-    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
-     * @throws EE_Error
-     * @return mixed whatever the plugin which calls add_filter decides
-     */
-    public function __call($methodName, $args)
-    {
-        $className = get_class($this);
-        $tagName = "FHEE__{$className}__{$methodName}";
-        if (! has_filter($tagName)) {
-            throw new EE_Error(
-                sprintf(
-                    __('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
-     * @throws EE_Error
-     * @return EE_Base_Class
-     */
-    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);
-            } else if (
-                $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(
-                        __(
-                            "'%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) {
-            /** @var $base_class_obj_or_id EE_Base_Class */
-            $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(__("'%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 = array();
-        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 array($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 $cols_n_values keys are field names, values are their values
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_index_primary_key_string($cols_n_values)
-    {
-        $cols_n_values_for_primary_key_index = array_intersect_key($cols_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
-     *
-     * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
-     * @param string $index_primary_key_string
-     * @return null|array
-     * @throws EE_Error
-     */
-    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_vals_in_combined_pk = array();
-        parse_str($index_primary_key_string, $key_vals_in_combined_pk);
-        foreach ($key_fields as $key_field_name => $field_obj) {
-            if (! isset($key_vals_in_combined_pk[$key_field_name])) {
-                return null;
-            }
-        }
-        return $key_vals_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_vals
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function has_all_combined_primary_key_fields($key_vals)
-    {
-        $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
-        foreach ($keys_it_should_have as $key) {
-            if (! isset($key_vals[$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                     like EEM_Base::get_all's query_params.
-     * @throws EE_Error
-     * @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 = array())
-    {
-        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(__("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
-     */
-    public function get_one_copy($model_object_or_attributes_array, $query_params = array())
-    {
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)), '4.6.0');
-            $query_params = array();
-        }
-        $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
-     */
-    public function update_by_ID($fields_n_values, $id)
-    {
-        $query_params = array(
-            0                          => array($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(
-                __(
-                    "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
-     */
-    public function get_all_names($query_params = array())
-    {
-        $objs = $this->get_all($query_params);
-        $names = array();
-        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(
-                    __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        $IDs = array();
-        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(
-                        __(
-                            '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 (@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)
-     *
-     * @param string $context
-     * @return EE_Default_Where_Conditions[] indexed by associated capability
-     * @throws EE_Error
-     */
-    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 = array();
-        $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(
-                __('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', array(
-            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 array(
-            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
-     */
-    static public 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(
-                __(
-                    '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 = array();
-        $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;
-    }
+		}
+		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 like EEM_Base::get_all's $query_params[0] (where conditions)
+	 */
+	private function _get_default_where_conditions($model_relation_path = null)
+	{
+		if ($this->_ignore_where_strategy) {
+			return array();
+		}
+		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 like EEM_Base::get_all's $query_params[0] (where conditions)
+	 */
+	protected function _get_minimum_where_conditions($model_relation_path = null)
+	{
+		if ($this->_ignore_where_strategy) {
+			return array();
+		}
+		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 $key => $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 = array();
+		$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 null|string                 $original_query_param
+	 * @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                      $original_query_param what it originally was (eg
+	 *                                                          Registration.Transaction.TXN_ID). If null, we assume it
+	 *                                                          matches $query_param
+	 * @throws EE_Error
+	 * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
+	 */
+	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);
+		/** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
+		$allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
+		$allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
+		//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(
+					__(
+						"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(
+					__(
+						'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 (array_key_exists($query_param, $this->_custom_selections)) {
+			return;
+		}
+		//check if has a model name at the beginning
+		//and
+		//check if it's a field on a related model
+		foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
+			if (strpos($query_param, $valid_related_model_name . ".") === 0) {
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
+				$query_param = substr($query_param, strlen($valid_related_model_name . "."));
+				if ($query_param === '') {
+					//nothing left to $query_param
+					//we should actually end in a field name, not a model like this!
+					throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
+						"event_espresso"),
+						$query_param, $query_param_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(
+					$query_param,
+					$passed_in_query_info, $query_param_type, $original_query_param
+				);
+				return;
+			}
+			if ($query_param === $valid_related_model_name) {
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
+				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(__("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));
+	}
+
+
+
+	/**
+	 * 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(
+					array($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(
+				array($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 like EEM_Base::get_all
+	 * @return string of SQL
+	 * @throws EE_Error
+	 */
+	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 see EEM_Base::get_all for documentation
+	 * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
+	 * @throws EE_Error
+	 * @return string of SQL
+	 */
+	private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
+	{
+		$where_clauses = array();
+		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 (isset($this->_custom_selections[$query_param][1])) {
+						$field_obj = $this->_custom_selections[$query_param][1];
+					} else {
+						throw new EE_Error(sprintf(__("%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
+	 * @throws EE_Error
+	 * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
+	 */
+	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 (array_key_exists($query_param, $this->_custom_selections)) {
+			//maybe it's custom selection item?
+			//if so, just use it as the "column name"
+			return $query_param;
+		}
+		throw new EE_Error(
+			sprintf(
+				__(
+					"%s is not a valid field on this model, nor a custom selection (%s)",
+					"event_espresso"
+				), $query_param, implode(",", $this->_custom_selections)
+			)
+		);
+	}
+
+
+
+	/**
+	 * 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;
+		}
+		$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
+		return $condition_query_param_sans_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
+	 * @throws EE_Error
+	 * @return string
+	 */
+	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 = array();
+				foreach ($op_and_value as $key => $value) {
+					$php_array_like_string[] = "$key=>$value";
+				}
+				throw new EE_Error(
+					sprintf(
+						__(
+							"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(
+						__(
+							"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(
+						__(
+							"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(
+					__(
+						"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(
+					__(
+						"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(
+				__(
+					"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 = array();
+		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 = array();
+		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'
+	 * @throws EE_Error
+	 * @return false|null|string
+	 */
+	private function _wpdb_prepare_using_field($value, $field_obj)
+	{
+		/** @type WPDB $wpdb */
+		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(
+					__("%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
+	 * @throws EE_Error
+	 * @return EE_Model_Field_Base
+	 */
+	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(__("_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];
+		if ($number_of_parts === 1) {
+			$field_name = $last_query_param_part;
+			$model_obj = $this;
+		} else {// $number_of_parts >= 2
+			//the last part is the column name, and there are only 2parts. therefore...
+			$field_name = $last_query_param_part;
+			$model_obj = $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
+	 * @throws EE_Error
+	 * @return string
+	 */
+	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(
+				__(
+					"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 = array();
+		foreach ($this->field_settings() as $field_name => $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.
+	 */
+	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
+	 */
+	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 = array();
+		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
+	 * @throws EE_Error
+	 * @return EEM_Base
+	 */
+	public function get_related_model_obj($model_name)
+	{
+		$model_classname = "EEM_" . $model_name;
+		if (! class_exists($model_classname)) {
+			throw new EE_Error(sprintf(__("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 = array();
+		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
+	 * @throws EE_Error
+	 * @return EE_Model_Relation_Base
+	 */
+	public function related_settings_for($relation_name)
+	{
+		$relatedModels = $this->relation_settings();
+		if (! array_key_exists($relation_name, $relatedModels)) {
+			throw new EE_Error(
+				sprintf(
+					__('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
+	 * @throws EE_Error
+	 * @return EE_Model_Field_Base
+	 */
+	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(__("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 ? true : false;
+	}
+
+
+
+	/**
+	 * 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(__("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(__("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 = array();
+				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 = array();
+			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
+	 */
+	protected function _create_objects($rows = array())
+	{
+		$array_of_objects = array();
+		if (empty($rows)) {
+			return array();
+		}
+		$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 array();
+			}
+			//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(
+						__('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->_timezone);
+			//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->_timezone);
+						$classInstance->cache($modelName, $other_model_obj_maybe);
+					}
+				}
+			}
+		}
+		return $array_of_objects;
+	}
+
+
+
+	/**
+	 * 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.
+	 */
+	public function create_default_object()
+	{
+		$this_model_fields_and_values = array();
+		//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();
+		$classInstance = EE_Registry::instance()
+									->load_class($className, array($this_model_fields_and_values), false, false);
+		return $classInstance;
+	}
+
+
+
+	/**
+	 * @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
+	 */
+	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;
+			}
+		} else if ($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,
+												array($this_model_fields_n_values, $this->_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, array($this_model_fields_n_values, $this->_timezone),
+											true, false);
+		}
+		//it is entirely possible that the instantiated class object has a set timezone_string db field and has set it's internal _timezone property accordingly (see new_instance_from_db in model objects particularly EE_Event for example).  In this case, we want to make sure the model object doesn't have its timezone string overwritten by any timezone property currently set here on the model so, we intentionally override the model _timezone property with the model_object timezone property.
+		$this->set_timezone($classInstance->get_timezone());
+		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
+	 * @throws EE_Error
+	 * @return \EE_Base_Class
+	 */
+	public function add_to_entity_map(EE_Base_Class $object)
+	{
+		$className = $this->_get_class_name();
+		if (! $object instanceof $className) {
+			throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
+				is_object($object) ? get_class($object) : $object, $className));
+		}
+		/** @var $object EE_Base_Class */
+		if (! $object->ID()) {
+			throw new EE_Error(sprintf(__("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] = array();
+			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
+	 */
+	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 string $cols_n_values
+	 * @return array
+	 */
+	protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
+	{
+		$this_model_fields_n_values = array();
+		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 $cols_n_values
+	 * @param $qualified_column
+	 * @param $regular_column
+	 * @return null
+	 */
+	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];
+		}
+		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
+	 */
+	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(
+				array(array($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
+	 */
+	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
+	 * @throws EE_Error
+	 * @return mixed whatever the plugin which calls add_filter decides
+	 */
+	public function __call($methodName, $args)
+	{
+		$className = get_class($this);
+		$tagName = "FHEE__{$className}__{$methodName}";
+		if (! has_filter($tagName)) {
+			throw new EE_Error(
+				sprintf(
+					__('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
+	 * @throws EE_Error
+	 * @return EE_Base_Class
+	 */
+	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);
+			} else if (
+				$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(
+						__(
+							"'%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) {
+			/** @var $base_class_obj_or_id EE_Base_Class */
+			$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(__("'%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 = array();
+		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 array($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 $cols_n_values keys are field names, values are their values
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_index_primary_key_string($cols_n_values)
+	{
+		$cols_n_values_for_primary_key_index = array_intersect_key($cols_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
+	 *
+	 * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
+	 * @param string $index_primary_key_string
+	 * @return null|array
+	 * @throws EE_Error
+	 */
+	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_vals_in_combined_pk = array();
+		parse_str($index_primary_key_string, $key_vals_in_combined_pk);
+		foreach ($key_fields as $key_field_name => $field_obj) {
+			if (! isset($key_vals_in_combined_pk[$key_field_name])) {
+				return null;
+			}
+		}
+		return $key_vals_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_vals
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function has_all_combined_primary_key_fields($key_vals)
+	{
+		$keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
+		foreach ($keys_it_should_have as $key) {
+			if (! isset($key_vals[$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                     like EEM_Base::get_all's query_params.
+	 * @throws EE_Error
+	 * @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 = array())
+	{
+		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(__("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
+	 */
+	public function get_one_copy($model_object_or_attributes_array, $query_params = array())
+	{
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)), '4.6.0');
+			$query_params = array();
+		}
+		$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
+	 */
+	public function update_by_ID($fields_n_values, $id)
+	{
+		$query_params = array(
+			0                          => array($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(
+				__(
+					"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
+	 */
+	public function get_all_names($query_params = array())
+	{
+		$objs = $this->get_all($query_params);
+		$names = array();
+		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(
+					__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		$IDs = array();
+		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(
+						__(
+							'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 (@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)
+	 *
+	 * @param string $context
+	 * @return EE_Default_Where_Conditions[] indexed by associated capability
+	 * @throws EE_Error
+	 */
+	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 = array();
+		$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(
+				__('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', array(
+			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 array(
+			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
+	 */
+	static public 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(
+				__(
+					'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 = array();
+		$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;
+	}
 
 
 

Spacing +156 added lines, -156 removed lines

@@ -511,8 +511,8 @@ 
     protected function __construct($timezone = null)
     {
         // check that the model has not been loaded too soon
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
-            throw new EE_Error (
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')) {
+            throw new EE_Error(
                 sprintf(
                     __('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'),
@@ -532,7 +532,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);
@@ -547,10 +547,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(__("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)));
             }
@@ -578,7 +578,7 @@ 
          *
          * @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) {
             /** @var $relation_obj EE_Model_Relation_Base */
@@ -590,12 +590,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();
         }
@@ -608,7 +608,7 @@ 
         //initialize the standard cap restriction generators if none were specified by the child constructor
         if ($this->_cap_restriction_generators !== false) {
             foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-                if (! isset($this->_cap_restriction_generators[$cap_context])) {
+                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(),
@@ -621,10 +621,10 @@ 
         //if there are cap restriction generators, use them to make the default cap restrictions
         if ($this->_cap_restriction_generators !== false) {
             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(
                             __('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.',
@@ -635,12 +635,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');
     }
 
 
@@ -653,7 +653,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();
     }
 
 
@@ -687,7 +687,7 @@ 
     public static function instance($timezone = null)
     {
         // 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,
@@ -726,7 +726,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;
                 }
             }
@@ -750,7 +750,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;
@@ -770,7 +770,7 @@ 
      */
     public function status_array($translated = false)
     {
-        if (! array_key_exists('Status', $this->_model_relations)) {
+        if ( ! array_key_exists('Status', $this->_model_relations)) {
             return array();
         }
         $model_name = $this->get_this_model_name();
@@ -973,17 +973,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;
         }
@@ -1054,12 +1054,12 @@ 
         // remember the custom selections, if any, and type cast as array
         // (unless $columns_to_select is an object, then just set as an empty array)
         // Note: (array) 'some string' === array( 'some string' )
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
+        $this->_custom_selections = ! is_object($columns_to_select) ? (array) $columns_to_select : array();
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
         $select_expressions = $columns_to_select !== null
             ? $this->_construct_select_from_input($columns_to_select)
             : $this->_construct_default_select_sql($model_query_info);
-        $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', array($SQL, $output));
     }
 
@@ -1104,7 +1104,7 @@ 
         if (is_array($columns_to_select)) {
             $select_sql_array = 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(
                             __(
@@ -1116,7 +1116,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__(
@@ -1188,7 +1188,7 @@ 
      */
     public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
     {
-        if (! isset($query_params[0])) {
+        if ( ! isset($query_params[0])) {
             $query_params[0] = array();
         }
         $conditions_from_id = $this->parse_index_primary_key_string($id);
@@ -1213,7 +1213,7 @@ 
      */
     public function get_one($query_params = array())
     {
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong('EEM_Base::get_one',
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
                     gettype($query_params)), '4.6.0');
@@ -1404,7 +1404,7 @@ 
                 return array();
             }
         }
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
                     gettype($query_params)), '4.6.0');
@@ -1414,7 +1414,7 @@ 
         $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
         $query_params['limit'] = $limit;
         //set direction
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
+        $incoming_orderby = isset($query_params['order_by']) ? (array) $query_params['order_by'] : array();
         $query_params['order_by'] = $operand === '>'
             ? array($field_to_order_by => 'ASC') + $incoming_orderby
             : array($field_to_order_by => 'DESC') + $incoming_orderby;
@@ -1492,7 +1492,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(__('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));
         }
@@ -1571,7 +1571,7 @@ 
         //load EEH_DTT_Helper
         $set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
         $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
-        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
+        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime($incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)));
     }
 
 
@@ -1639,7 +1639,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(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
                     gettype($query_params)), '4.6.0');
@@ -1661,7 +1661,7 @@ 
          * @param EEM_Base $model           the model being queried
          * @param array    $query_params    see EEM_Base::get_all()
          */
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
+        $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.
@@ -1675,7 +1675,7 @@ 
         $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()];
@@ -1692,13 +1692,13 @@ 
                     $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)
+                    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) {
+                        if ( ! $success) {
                             return false;
                         }
                     }
@@ -1729,7 +1729,7 @@ 
                     $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;
             }
@@ -1756,7 +1756,7 @@ 
                . $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.
+               . $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', array($SQL));
         /**
          * Action called after a model update call has been made.
@@ -1767,7 +1767,7 @@ 
          * @param int      $rows_affected
          */
         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
     }
 
 
@@ -1795,7 +1795,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', array($SQL));
     }
 
@@ -1813,7 +1813,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;
@@ -1844,7 +1844,7 @@ 
             $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;
+            $cols_n_values[] = $field_obj->get_qualified_column()."=".$value_sql;
         }
         return implode(",", $cols_n_values);
     }
@@ -2026,7 +2026,7 @@ 
          * @param int      $rows_deleted
          */
         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
     }
 
 
@@ -2176,7 +2176,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) {
@@ -2184,9 +2184,9 @@ 
             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 = array();
                 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;
                 }
-                $ways_to_identify_a_row[] = '(' . implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
+                $ways_to_identify_a_row[] = '('.implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
             }
             $query_part = implode(' OR ', $ways_to_identify_a_row);
         }
@@ -2202,8 +2202,8 @@ 
      */
     public function get_field_by_column($qualified_column_name)
     {
-       foreach($this->field_settings(true) as $field_name => $field_obj){
-           if($field_obj->get_qualified_column() === $qualified_column_name){
+       foreach ($this->field_settings(true) as $field_name => $field_obj) {
+           if ($field_obj->get_qualified_column() === $qualified_column_name) {
                return $field_obj;
            }
        }
@@ -2254,9 +2254,9 @@ 
                 $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', array($SQL));
+        $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', array($SQL));
     }
 
 
@@ -2278,14 +2278,14 @@ 
             $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);
+        $SQL = "SELECT SUM(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
         $return_value = $this->_do_wpdb_query('get_var', array($SQL));
         $data_type = $field_obj->get_wpdb_data_type();
         if ($data_type === '%d' || $data_type === '%s') {
-            return (float)$return_value;
+            return (float) $return_value;
         }
         //must be %f
-        return (float)$return_value;
+        return (float) $return_value;
     }
 
 
@@ -2305,13 +2305,13 @@ 
         //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(sprintf(__("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")));
         }
         /** @type WPDB $wpdb */
         global $wpdb;
-        if (! method_exists($wpdb, $wpdb_method)) {
+        if ( ! method_exists($wpdb, $wpdb_method)) {
             throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
                 'event_espresso'), $wpdb_method));
         }
@@ -2323,7 +2323,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) {
@@ -2384,7 +2384,7 @@ 
                     return $result;
                     break;
             }
-            if (! empty($error_message)) {
+            if ( ! empty($error_message)) {
                 EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
                 trigger_error($error_message);
             }
@@ -2460,11 +2460,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();
     }
 
@@ -2660,12 +2660,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);
     }
 
@@ -2685,7 +2685,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(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
                     gettype($query_params)), '4.6.0');
@@ -2693,12 +2693,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);
     }
 
@@ -2751,7 +2751,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(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
                 $this->get_this_model_name()));
         }
@@ -2784,7 +2784,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);
@@ -2891,7 +2891,7 @@ 
         }
         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)) {
@@ -2977,7 +2977,7 @@ 
             //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
+            $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',
@@ -3181,7 +3181,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,
@@ -3203,7 +3203,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,
@@ -3238,8 +3238,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($param, $model_query_info_carrier,
@@ -3250,7 +3250,7 @@ 
                 //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)) {
+                    if ( ! is_array($possibly_array_of_params)) {
                         throw new EE_Error(sprintf(__("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));
@@ -3267,7 +3267,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(__("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)));
                     }
@@ -3297,8 +3297,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(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
                     $sub_query_params));
             }
@@ -3327,7 +3327,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(
@@ -3403,7 +3403,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(
                         __(
                             "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)",
@@ -3411,12 +3411,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
@@ -3448,10 +3448,10 @@ 
                 $order_array = 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,
@@ -3462,18 +3462,18 @@ 
                     ? $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
                 );
             }
         }
         //if 'order_by' wasn't set, maybe they are just using 'order' on its own?
-        if (! array_key_exists('order_by', $query_params)
+        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);
+            $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)) {
@@ -3483,10 +3483,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'])
                 );
             }
         }
@@ -3496,7 +3496,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(
                         __(
@@ -3595,22 +3595,22 @@ 
         $where_query_params = array()
     ) {
         $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(__("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 = array();
-        if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
+        if ($this->_should_use_default_where_conditions($use_default_where_conditions, true)) {
             $universal_query_params = $this->_get_default_where_conditions();
-        } else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
+        } else if ($this->_should_use_minimum_where_conditions($use_default_where_conditions, true)) {
             $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)) {
+            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)) {
+            } 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
@@ -3643,7 +3643,7 @@ 
      * @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 )
+    private function _should_use_default_where_conditions($default_where_conditions_value, $for_this_model = true)
     {
         return (
                    $for_this_model
@@ -3722,7 +3722,7 @@ 
     ) {
         $null_friendly_where_conditions = array();
         $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])) {
                 $none_overridden = false;
@@ -3840,7 +3840,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'";
                 }
             }
@@ -3934,9 +3934,9 @@ 
         //and
         //check if it's a field on a related model
         foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
+            if (strpos($query_param, $valid_related_model_name.".") === 0) {
                 $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
+                $query_param = substr($query_param, strlen($valid_related_model_name."."));
                 if ($query_param === '') {
                     //nothing left to $query_param
                     //we should actually end in a field name, not a model like this!
@@ -4028,7 +4028,7 @@ 
     {
         $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
         if ($SQL) {
-            return " WHERE " . $SQL;
+            return " WHERE ".$SQL;
         }
         return '';
     }
@@ -4047,7 +4047,7 @@ 
     {
         $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
         if ($SQL) {
-            return " HAVING " . $SQL;
+            return " HAVING ".$SQL;
         }
         return '';
     }
@@ -4066,7 +4066,7 @@ 
     {
         $where_clauses = array();
         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);
+            $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':
@@ -4094,7 +4094,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 (isset($this->_custom_selections[$query_param][1])) {
                         $field_obj = $this->_custom_selections[$query_param][1];
                     } else {
@@ -4103,7 +4103,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) : '';
@@ -4124,7 +4124,7 @@ 
         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();
+            return $table_alias_prefix.$field->get_qualified_column();
         }
         if (array_key_exists($query_param, $this->_custom_selections)) {
             //maybe it's custom selection item?
@@ -4176,7 +4176,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 = array();
                 foreach ($op_and_value as $key => $value) {
                     $php_array_like_string[] = "$key=>$value";
@@ -4198,14 +4198,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.
@@ -4221,7 +4221,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) {
@@ -4241,10 +4241,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(
@@ -4258,7 +4258,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(
                     __(
@@ -4298,7 +4298,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];
     }
 
 
@@ -4339,7 +4339,7 @@ 
                                 . $main_table->get_table_name()
                                 . " WHERE FALSE";
         }
-        return "(" . implode(",", $cleaned_values) . ")";
+        return "(".implode(",", $cleaned_values).")";
     }
 
 
@@ -4358,7 +4358,7 @@ 
             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)) {
+        if ( ! in_array($field_obj, $this->_valid_wpdb_data_types)) {
             throw new EE_Error(
                 sprintf(
                     __("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
@@ -4486,10 +4486,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 = array();
         foreach ($this->field_settings() as $field_name => $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;
     }
@@ -4513,11 +4513,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;
@@ -4605,12 +4605,12 @@ 
      */
     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(__("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");
+        return call_user_func($model_classname."::instance");
     }
 
 
@@ -4657,7 +4657,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(
                     __('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
@@ -4685,7 +4685,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(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
                 get_class($this)));
         }
@@ -4758,7 +4758,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(__("There is no Primary Key defined on model %s", 'event_espresso'),
                     get_class($this)));
             }
@@ -4817,7 +4817,7 @@ 
      */
     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
@@ -4827,7 +4827,7 @@ 
                     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(__("There is no foreign key field pointing to model %s on model %s",
                     'event_espresso'), $model_name, get_class($this)));
             }
@@ -4878,7 +4878,7 @@ 
             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()) {
+                    if ( ! $field_obj->is_db_only_field()) {
                         $this->_cached_fields_non_db_only[$field_name] = $field_obj;
                     }
                 }
@@ -4907,7 +4907,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 array();
@@ -4925,7 +4925,7 @@ 
                 }
             }
             $classInstance = $this->instantiate_class_from_array_or_object($row);
-            if (! $classInstance) {
+            if ( ! $classInstance) {
                 throw new EE_Error(
                     sprintf(
                         __('Could not create instance of class %s from row %s', 'event_espresso'),
@@ -4994,7 +4994,7 @@ 
      */
     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;
@@ -5019,7 +5019,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,
                                                 array($this_model_fields_n_values, $this->_timezone), true, false);
@@ -5070,12 +5070,12 @@ 
     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(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
                 is_object($object) ? get_class($object) : $object, $className));
         }
         /** @var $object EE_Base_Class */
-        if (! $object->ID()) {
+        if ( ! $object->ID()) {
             throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
                 "event_espresso"), get_class($this)));
         }
@@ -5144,7 +5144,7 @@ 
             //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);
@@ -5153,7 +5153,7 @@ 
             } 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()) {
+                    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()
@@ -5268,7 +5268,7 @@ 
      */
     private function _get_class_name()
     {
-        return "EE_" . $this->get_this_model_name();
+        return "EE_".$this->get_this_model_name();
     }
 
 
@@ -5283,7 +5283,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;
     }
 
 
@@ -5316,7 +5316,7 @@ 
     {
         $className = get_class($this);
         $tagName = "FHEE__{$className}__{$methodName}";
-        if (! has_filter($tagName)) {
+        if ( ! has_filter($tagName)) {
             throw new EE_Error(
                 sprintf(
                     __('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 );',
@@ -5542,7 +5542,7 @@ 
         $key_vals_in_combined_pk = array();
         parse_str($index_primary_key_string, $key_vals_in_combined_pk);
         foreach ($key_fields as $key_field_name => $field_obj) {
-            if (! isset($key_vals_in_combined_pk[$key_field_name])) {
+            if ( ! isset($key_vals_in_combined_pk[$key_field_name])) {
                 return null;
             }
         }
@@ -5563,7 +5563,7 @@ 
     {
         $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
         foreach ($keys_it_should_have as $key) {
-            if (! isset($key_vals[$key])) {
+            if ( ! isset($key_vals[$key])) {
                 return false;
             }
         }
@@ -5617,7 +5617,7 @@ 
      */
     public function get_one_copy($model_object_or_attributes_array, $query_params = array())
     {
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
                     gettype($query_params)), '4.6.0');
@@ -5683,7 +5683,7 @@ 
      * Gets the valid operators
      * @return array keys are accepted strings, values are the SQL they are converted to
      */
-    public function valid_operators(){
+    public function valid_operators() {
         return $this->_valid_operators;
     }
 
@@ -5771,7 +5771,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(
                     __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
@@ -5784,7 +5784,7 @@ 
         $IDs = array();
         foreach ($model_objects as $model_object) {
             $id = $model_object->ID();
-            if (! $id) {
+            if ( ! $id) {
                 if ($filter_out_empty_ids) {
                     continue;
                 }
@@ -5880,8 +5880,8 @@ 
         $missing_caps = array();
         $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')
+            if ( ! EE_Capabilities::instance()
+                                 ->current_user_can($cap, $this->get_this_model_name().'_model_applying_caps')
             ) {
                 $missing_caps[$cap] = $restriction_if_no_cap;
             }
@@ -6033,7 +6033,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;
             }

core/services/loaders/CachingLoader.php

Indentation +140 added lines, -140 removed lines

@@ -21,146 +21,146 @@
 class CachingLoader extends LoaderDecorator
 {
 
-    /**
-     * @var CollectionInterface $cache
-     */
-    protected $cache;
-
-    /**
-     * @var string $identifier
-     */
-    protected $identifier;
-
-
-
-    /**
-     * CachingLoader constructor.
-     *
-     * @param LoaderDecoratorInterface $loader
-     * @param CollectionInterface      $cache
-     * @param string                   $identifier
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(LoaderDecoratorInterface $loader, CollectionInterface $cache, $identifier = '')
-    {
-        parent::__construct($loader);
-        $this->cache = $cache;
-        $this->setIdentifier($identifier);
-        if ($this->identifier !== '') {
-            // to only clear this cache, and assuming an identifier has been set, simply do the following:
-            // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
-            // where "IDENTIFIER" = the string that was set during construction
-            add_action(
-                "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
-                array($this, 'reset')
-            );
-        }
-        // to clear ALL caches, simply do the following:
-        // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
-        add_action(
-            'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
-            array($this, 'reset')
-        );
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-
-    /**
-     * @param string $identifier
-     * @throws InvalidDataTypeException
-     */
-    private function setIdentifier($identifier)
-    {
-        if ( ! is_string($identifier)) {
-            throw new InvalidDataTypeException('$identifier', $identifier, 'string');
-        }
-        $this->identifier = $identifier;
-    }
-
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @param bool   $shared
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = array(), $shared = true)
-    {
-        $fqcn = ltrim($fqcn, '\\');
-        // caching can be turned off via the following code:
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
-        if(
-            apply_filters(
-                'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
-                false,
-                $this
-            )
-        ){
-            // even though $shared might be true, caching should be bypassed for whatever reason,
-            // so we don't want the core loader to cache anything, therefore caching is turned off
-            return $this->loader->load($fqcn, $arguments, false);
-        }
-        $identifier = md5($fqcn . $this->getIdentifierForArgument($arguments));
-        if($this->cache->has($identifier)){
-            return $this->cache->get($identifier);
-        }
-        $object = $this->loader->load($fqcn, $arguments, $shared);
-        if($object instanceof $fqcn){
-            $this->cache->add($object, $identifier);
-        }
-        return $object;
-    }
-
-
-
-    /**
-     * empties cache and calls reset() on loader if method exists
-     */
-    public function reset()
-    {
-        $this->cache->trashAndDetachAll();
-        $this->loader->reset();
-    }
-
-
-
-    /**
-     * build a string representation of a class' arguments
-     * (mostly because Closures can't be serialized)
-     *
-     * @param array $arguments
-     * @return string
-     */
-    private function getIdentifierForArgument(array $arguments)
-    {
-        $identifier = '';
-        foreach ($arguments as $argument) {
-            switch (true) {
-                case is_object($argument) :
-                case $argument instanceof Closure :
-                    $identifier .= spl_object_hash($argument);
-                    break;
-                case is_array($argument) :
-                    $identifier .= $this->getIdentifierForArgument($argument);
-                    break;
-                default :
-                    $identifier .= $argument;
-                    break;
-            }
-        }
-        return $identifier;
-    }
+	/**
+	 * @var CollectionInterface $cache
+	 */
+	protected $cache;
+
+	/**
+	 * @var string $identifier
+	 */
+	protected $identifier;
+
+
+
+	/**
+	 * CachingLoader constructor.
+	 *
+	 * @param LoaderDecoratorInterface $loader
+	 * @param CollectionInterface      $cache
+	 * @param string                   $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(LoaderDecoratorInterface $loader, CollectionInterface $cache, $identifier = '')
+	{
+		parent::__construct($loader);
+		$this->cache = $cache;
+		$this->setIdentifier($identifier);
+		if ($this->identifier !== '') {
+			// to only clear this cache, and assuming an identifier has been set, simply do the following:
+			// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
+			// where "IDENTIFIER" = the string that was set during construction
+			add_action(
+				"AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
+				array($this, 'reset')
+			);
+		}
+		// to clear ALL caches, simply do the following:
+		// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
+		add_action(
+			'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
+			array($this, 'reset')
+		);
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+
+	/**
+	 * @param string $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	private function setIdentifier($identifier)
+	{
+		if ( ! is_string($identifier)) {
+			throw new InvalidDataTypeException('$identifier', $identifier, 'string');
+		}
+		$this->identifier = $identifier;
+	}
+
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @param bool   $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true)
+	{
+		$fqcn = ltrim($fqcn, '\\');
+		// caching can be turned off via the following code:
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
+		if(
+			apply_filters(
+				'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
+				false,
+				$this
+			)
+		){
+			// even though $shared might be true, caching should be bypassed for whatever reason,
+			// so we don't want the core loader to cache anything, therefore caching is turned off
+			return $this->loader->load($fqcn, $arguments, false);
+		}
+		$identifier = md5($fqcn . $this->getIdentifierForArgument($arguments));
+		if($this->cache->has($identifier)){
+			return $this->cache->get($identifier);
+		}
+		$object = $this->loader->load($fqcn, $arguments, $shared);
+		if($object instanceof $fqcn){
+			$this->cache->add($object, $identifier);
+		}
+		return $object;
+	}
+
+
+
+	/**
+	 * empties cache and calls reset() on loader if method exists
+	 */
+	public function reset()
+	{
+		$this->cache->trashAndDetachAll();
+		$this->loader->reset();
+	}
+
+
+
+	/**
+	 * build a string representation of a class' arguments
+	 * (mostly because Closures can't be serialized)
+	 *
+	 * @param array $arguments
+	 * @return string
+	 */
+	private function getIdentifierForArgument(array $arguments)
+	{
+		$identifier = '';
+		foreach ($arguments as $argument) {
+			switch (true) {
+				case is_object($argument) :
+				case $argument instanceof Closure :
+					$identifier .= spl_object_hash($argument);
+					break;
+				case is_array($argument) :
+					$identifier .= $this->getIdentifierForArgument($argument);
+					break;
+				default :
+					$identifier .= $argument;
+					break;
+			}
+		}
+		return $identifier;
+	}
 
 
 }

core/libraries/rest_api/controllers/model/Write.php

Indentation +330 added lines, -330 removed lines

@@ -18,7 +18,7 @@ 
 use EE_Error;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -36,334 +36,334 @@ 
 
 
 
-    public function __construct()
-    {
-        parent::__construct();
-        EE_Registry::instance()->load_helper('Inflector');
-    }
-
-
-
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response|\WP_Error
-     */
-    public static function handleRequestInsert(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse(
-                $controller->insert(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-
-    /**
-     * Handles a request from \WP_REST_Server to update an EE model
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response|\WP_Error
-     */
-    public static function handleRequestUpdate(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse(
-                $controller->update(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-
-    /**
-     * Deletes a single model object and returns it. Unless
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response|\WP_Error
-     */
-    public static function handleRequestDelete(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse(
-                $controller->delete(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-
-    /**
-     * Inserts a new model object according to the $request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     * @throws RestException
-     */
-    public function insert(EEM_Base $model, WP_REST_Request $request)
-    {
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create');
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
-            throw new RestException(
-                'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
-                sprintf(
-                    esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to insert data into Event Espresso.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $default_cap_to_check_for
-                ),
-                array('status' => 403)
-            );
-        }
-        $submitted_json_data = array_merge((array)$request->get_body_params(), (array)$request->get_json_params());
-        $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-            $submitted_json_data,
-            $model,
-            $this->getModelVersionInfo()->requestedVersion(),
-            true
-        );
-        $model_obj = EE_Registry::instance()->load_class(
-            $model->get_this_model_name(),
-            array($model_data, $model->get_timezone()),
-            false,
-            false
-        );
-        $model_obj->save();
-        $new_id = $model_obj->ID();
-        if (! $new_id) {
-            throw new RestException(
-                'rest_insertion_failed',
-                sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
-            );
-        }
-        return $this->returnModelObjAsJsonResponse($model_obj, $request);
-    }
-
-
-
-    /**
-     * Updates an existing model object according to the $request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     */
-    public function update(EEM_Base $model, WP_REST_Request $request)
-    {
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
-            throw new RestException(
-                'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
-                sprintf(
-                    esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to update data into Event Espresso.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $default_cap_to_check_for
-                ),
-                array('status' => 403)
-            );
-        }
-        $obj_id = $request->get_param('id');
-        if (! $obj_id) {
-            throw new RestException(
-                'rest_edit_failed',
-                sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
-            );
-        }
-        $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-            $this->getBodyParams($request),
-            $model,
-            $this->getModelVersionInfo()->requestedVersion(),
-            true
-        );
-        $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                array('status' => 404)
-            );
-        }
-        $model_obj->save($model_data);
-        return $this->returnModelObjAsJsonResponse($model_obj, $request);
-    }
-
-
-
-    /**
-     * Updates an existing model object according to the $request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array of either the soft-deleted item, or
-     * @throws EE_Error
-     */
-    public function delete(EEM_Base $model, WP_REST_Request $request)
-    {
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete');
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
-            throw new RestException(
-                'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
-                sprintf(
-                    esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to delete data into Event Espresso.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $default_cap_to_check_for
-                ),
-                array('status' => 403)
-            );
-        }
-        $obj_id = $request->get_param('id');
-        //this is where we would apply more fine-grained caps
-        $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                array('status' => 404)
-            );
-        }
-        $requested_permanent_delete = filter_var($request->get_param('force'), FILTER_VALIDATE_BOOLEAN);
-        $requested_allow_blocking = filter_var($request->get_param('allow_blocking'), FILTER_VALIDATE_BOOLEAN);
-        if ($requested_permanent_delete) {
-            $previous = $this->returnModelObjAsJsonResponse($model_obj, $request);
-            $deleted = (bool)$model->delete_permanently_by_ID($obj_id, $requested_allow_blocking);
-            return array(
-                'deleted'  => $deleted,
-                'previous' => $previous,
-            );
-        } else {
-            if ($model instanceof EEM_Soft_Delete_Base) {
-                $model->delete_by_ID($obj_id, $requested_allow_blocking);
-                return $this->returnModelObjAsJsonResponse($model_obj, $request);
-            } else {
-                throw new RestException(
-                    'rest_trash_not_supported',
-                    501,
-                    sprintf(
-                        esc_html__('%1$s do not support trashing. Set force=1 to delete.', 'event_espresso'),
-                        EEH_Inflector::pluralize($model->get_this_model_name())
-                    )
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * Returns an array ready to be converted into a JSON response, based solely on the model object
-     *
-     * @param EE_Base_Class $model_obj
-     * @param WP_REST_Request $request
-     * @return array ready for a response
-     */
-    protected function returnModelObjAsJsonResponse(EE_Base_Class $model_obj, WP_REST_Request $request)
-    {
-        $model = $model_obj->get_model();
-        //create an array exactly like the wpdb results row,
-        // so we can pass it to controllers/model/Read::create_entity_from_wpdb_result()
-        $simulated_db_row = array();
-        foreach ($model->field_settings(true) as $field_name => $field_obj) {
-            //we need to reconstruct the normal wpdb results, including the db-only fields
-            //like a secondary table's primary key. The models expect those (but don't care what value they have)
-            if( $field_obj instanceof EE_DB_Only_Field_Base){
-                $raw_value = true;
-            } elseif ($field_obj instanceof EE_Datetime_Field) {
-                $raw_value = $model_obj->get_DateTime_object($field_name);
-            } else {
-                $raw_value = $model_obj->get_raw($field_name);
-            }
-            $simulated_db_row[$field_obj->get_qualified_column()] = $field_obj->prepare_for_use_in_db($raw_value);
-        }
-        $read_controller = new Read();
-        $read_controller->setRequestedVersion($this->getRequestedVersion());
-        //the simulates request really doesn't need any info downstream
-        $simulated_request = new WP_REST_Request('GET');
-        return $read_controller->createEntityFromWpdbResult(
-            $model_obj->get_model(),
-            $simulated_db_row,
-            $simulated_request
-        );
-    }
-
-
-
-    /**
-     * Gets the item affected by this request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @param  int|string     $obj_id
-     * @return \WP_Error|array
-     */
-    protected function getOneBasedOnRequest(EEM_Base $model, WP_REST_Request $request, $obj_id)
-    {
-        $requested_version = $this->getRequestedVersion($request->get_route());
-        $get_request = new WP_REST_Request(
-            'GET',
-            EED_Core_Rest_Api::ee_api_namespace
-            . $requested_version
-            . '/'
-            . EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-            . '/'
-            . $obj_id
-        );
-        $get_request->set_url_params(
-            array(
-                'id'      => $obj_id,
-                'include' => $request->get_param('include'),
-            )
-        );
-        $read_controller = new Read();
-        $read_controller->setRequestedVersion($this->getRequestedVersion());
-        return $read_controller->getEntityFromModel($model, $get_request);
-    }
+	public function __construct()
+	{
+		parent::__construct();
+		EE_Registry::instance()->load_helper('Inflector');
+	}
+
+
+
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response|\WP_Error
+	 */
+	public static function handleRequestInsert(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse(
+				$controller->insert(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+
+	/**
+	 * Handles a request from \WP_REST_Server to update an EE model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response|\WP_Error
+	 */
+	public static function handleRequestUpdate(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse(
+				$controller->update(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+
+	/**
+	 * Deletes a single model object and returns it. Unless
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response|\WP_Error
+	 */
+	public static function handleRequestDelete(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse(
+				$controller->delete(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+
+	/**
+	 * Inserts a new model object according to the $request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 * @throws RestException
+	 */
+	public function insert(EEM_Base $model, WP_REST_Request $request)
+	{
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create');
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (! current_user_can($default_cap_to_check_for)) {
+			throw new RestException(
+				'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+				sprintf(
+					esc_html__(
+						// @codingStandardsIgnoreStart
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to insert data into Event Espresso.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$default_cap_to_check_for
+				),
+				array('status' => 403)
+			);
+		}
+		$submitted_json_data = array_merge((array)$request->get_body_params(), (array)$request->get_json_params());
+		$model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+			$submitted_json_data,
+			$model,
+			$this->getModelVersionInfo()->requestedVersion(),
+			true
+		);
+		$model_obj = EE_Registry::instance()->load_class(
+			$model->get_this_model_name(),
+			array($model_data, $model->get_timezone()),
+			false,
+			false
+		);
+		$model_obj->save();
+		$new_id = $model_obj->ID();
+		if (! $new_id) {
+			throw new RestException(
+				'rest_insertion_failed',
+				sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
+			);
+		}
+		return $this->returnModelObjAsJsonResponse($model_obj, $request);
+	}
+
+
+
+	/**
+	 * Updates an existing model object according to the $request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function update(EEM_Base $model, WP_REST_Request $request)
+	{
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (! current_user_can($default_cap_to_check_for)) {
+			throw new RestException(
+				'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+				sprintf(
+					esc_html__(
+						// @codingStandardsIgnoreStart
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to update data into Event Espresso.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$default_cap_to_check_for
+				),
+				array('status' => 403)
+			);
+		}
+		$obj_id = $request->get_param('id');
+		if (! $obj_id) {
+			throw new RestException(
+				'rest_edit_failed',
+				sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
+			);
+		}
+		$model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+			$this->getBodyParams($request),
+			$model,
+			$this->getModelVersionInfo()->requestedVersion(),
+			true
+		);
+		$model_obj = $model->get_one_by_ID($obj_id);
+		if (! $model_obj instanceof EE_Base_Class) {
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_%s_invalid_id', $lowercase_model_name),
+				sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+				array('status' => 404)
+			);
+		}
+		$model_obj->save($model_data);
+		return $this->returnModelObjAsJsonResponse($model_obj, $request);
+	}
+
+
+
+	/**
+	 * Updates an existing model object according to the $request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array of either the soft-deleted item, or
+	 * @throws EE_Error
+	 */
+	public function delete(EEM_Base $model, WP_REST_Request $request)
+	{
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete');
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (! current_user_can($default_cap_to_check_for)) {
+			throw new RestException(
+				'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+				sprintf(
+					esc_html__(
+						// @codingStandardsIgnoreStart
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to delete data into Event Espresso.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$default_cap_to_check_for
+				),
+				array('status' => 403)
+			);
+		}
+		$obj_id = $request->get_param('id');
+		//this is where we would apply more fine-grained caps
+		$model_obj = $model->get_one_by_ID($obj_id);
+		if (! $model_obj instanceof EE_Base_Class) {
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_%s_invalid_id', $lowercase_model_name),
+				sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+				array('status' => 404)
+			);
+		}
+		$requested_permanent_delete = filter_var($request->get_param('force'), FILTER_VALIDATE_BOOLEAN);
+		$requested_allow_blocking = filter_var($request->get_param('allow_blocking'), FILTER_VALIDATE_BOOLEAN);
+		if ($requested_permanent_delete) {
+			$previous = $this->returnModelObjAsJsonResponse($model_obj, $request);
+			$deleted = (bool)$model->delete_permanently_by_ID($obj_id, $requested_allow_blocking);
+			return array(
+				'deleted'  => $deleted,
+				'previous' => $previous,
+			);
+		} else {
+			if ($model instanceof EEM_Soft_Delete_Base) {
+				$model->delete_by_ID($obj_id, $requested_allow_blocking);
+				return $this->returnModelObjAsJsonResponse($model_obj, $request);
+			} else {
+				throw new RestException(
+					'rest_trash_not_supported',
+					501,
+					sprintf(
+						esc_html__('%1$s do not support trashing. Set force=1 to delete.', 'event_espresso'),
+						EEH_Inflector::pluralize($model->get_this_model_name())
+					)
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Returns an array ready to be converted into a JSON response, based solely on the model object
+	 *
+	 * @param EE_Base_Class $model_obj
+	 * @param WP_REST_Request $request
+	 * @return array ready for a response
+	 */
+	protected function returnModelObjAsJsonResponse(EE_Base_Class $model_obj, WP_REST_Request $request)
+	{
+		$model = $model_obj->get_model();
+		//create an array exactly like the wpdb results row,
+		// so we can pass it to controllers/model/Read::create_entity_from_wpdb_result()
+		$simulated_db_row = array();
+		foreach ($model->field_settings(true) as $field_name => $field_obj) {
+			//we need to reconstruct the normal wpdb results, including the db-only fields
+			//like a secondary table's primary key. The models expect those (but don't care what value they have)
+			if( $field_obj instanceof EE_DB_Only_Field_Base){
+				$raw_value = true;
+			} elseif ($field_obj instanceof EE_Datetime_Field) {
+				$raw_value = $model_obj->get_DateTime_object($field_name);
+			} else {
+				$raw_value = $model_obj->get_raw($field_name);
+			}
+			$simulated_db_row[$field_obj->get_qualified_column()] = $field_obj->prepare_for_use_in_db($raw_value);
+		}
+		$read_controller = new Read();
+		$read_controller->setRequestedVersion($this->getRequestedVersion());
+		//the simulates request really doesn't need any info downstream
+		$simulated_request = new WP_REST_Request('GET');
+		return $read_controller->createEntityFromWpdbResult(
+			$model_obj->get_model(),
+			$simulated_db_row,
+			$simulated_request
+		);
+	}
+
+
+
+	/**
+	 * Gets the item affected by this request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @param  int|string     $obj_id
+	 * @return \WP_Error|array
+	 */
+	protected function getOneBasedOnRequest(EEM_Base $model, WP_REST_Request $request, $obj_id)
+	{
+		$requested_version = $this->getRequestedVersion($request->get_route());
+		$get_request = new WP_REST_Request(
+			'GET',
+			EED_Core_Rest_Api::ee_api_namespace
+			. $requested_version
+			. '/'
+			. EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+			. '/'
+			. $obj_id
+		);
+		$get_request->set_url_params(
+			array(
+				'id'      => $obj_id,
+				'include' => $request->get_param('include'),
+			)
+		);
+		$read_controller = new Read();
+		$read_controller->setRequestedVersion($this->getRequestedVersion());
+		return $read_controller->getEntityFromModel($model, $get_request);
+	}
 }
 // End of file Read.php

Spacing +14 added lines, -14 removed lines

@@ -17,7 +17,7 @@ 
 use EEH_Inflector;
 use EE_Error;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -135,9 +135,9 @@ 
     {
         Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create');
         $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
+        if ( ! current_user_can($default_cap_to_check_for)) {
             throw new RestException(
-                'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+                'rest_cannot_create_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
                 sprintf(
                     esc_html__(
                         // @codingStandardsIgnoreStart
@@ -150,7 +150,7 @@ 
                 array('status' => 403)
             );
         }
-        $submitted_json_data = array_merge((array)$request->get_body_params(), (array)$request->get_json_params());
+        $submitted_json_data = array_merge((array) $request->get_body_params(), (array) $request->get_json_params());
         $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
             $submitted_json_data,
             $model,
@@ -165,7 +165,7 @@ 
         );
         $model_obj->save();
         $new_id = $model_obj->ID();
-        if (! $new_id) {
+        if ( ! $new_id) {
             throw new RestException(
                 'rest_insertion_failed',
                 sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
@@ -188,9 +188,9 @@ 
     {
         Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
         $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
+        if ( ! current_user_can($default_cap_to_check_for)) {
             throw new RestException(
-                'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+                'rest_cannot_edit_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
                 sprintf(
                     esc_html__(
                         // @codingStandardsIgnoreStart
@@ -204,7 +204,7 @@ 
             );
         }
         $obj_id = $request->get_param('id');
-        if (! $obj_id) {
+        if ( ! $obj_id) {
             throw new RestException(
                 'rest_edit_failed',
                 sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
@@ -217,7 +217,7 @@ 
             true
         );
         $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
+        if ( ! $model_obj instanceof EE_Base_Class) {
             $lowercase_model_name = strtolower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_%s_invalid_id', $lowercase_model_name),
@@ -243,9 +243,9 @@ 
     {
         Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete');
         $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
+        if ( ! current_user_can($default_cap_to_check_for)) {
             throw new RestException(
-                'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+                'rest_cannot_delete_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
                 sprintf(
                     esc_html__(
                         // @codingStandardsIgnoreStart
@@ -261,7 +261,7 @@ 
         $obj_id = $request->get_param('id');
         //this is where we would apply more fine-grained caps
         $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
+        if ( ! $model_obj instanceof EE_Base_Class) {
             $lowercase_model_name = strtolower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_%s_invalid_id', $lowercase_model_name),
@@ -273,7 +273,7 @@ 
         $requested_allow_blocking = filter_var($request->get_param('allow_blocking'), FILTER_VALIDATE_BOOLEAN);
         if ($requested_permanent_delete) {
             $previous = $this->returnModelObjAsJsonResponse($model_obj, $request);
-            $deleted = (bool)$model->delete_permanently_by_ID($obj_id, $requested_allow_blocking);
+            $deleted = (bool) $model->delete_permanently_by_ID($obj_id, $requested_allow_blocking);
             return array(
                 'deleted'  => $deleted,
                 'previous' => $previous,
@@ -313,7 +313,7 @@ 
         foreach ($model->field_settings(true) as $field_name => $field_obj) {
             //we need to reconstruct the normal wpdb results, including the db-only fields
             //like a secondary table's primary key. The models expect those (but don't care what value they have)
-            if( $field_obj instanceof EE_DB_Only_Field_Base){
+            if ($field_obj instanceof EE_DB_Only_Field_Base) {
                 $raw_value = true;
             } elseif ($field_obj instanceof EE_Datetime_Field) {
                 $raw_value = $model_obj->get_DateTime_object($field_name);

core/db_models/EEM_Change_Log.model.php

Indentation +227 added lines, -227 removed lines

@@ -13,93 +13,93 @@ 
 class EEM_Change_Log extends EEM_Base
 {
 
-    /**
-     * the related object was created log type
-     */
-    const type_create = 'create';
-    /**
-     * the related object was updated (changed, or soft-deleted)
-     */
-    const type_update = 'update';
-    /**
-     * the related object was deleted permanently
-     */
-    const type_delete = 'delete';
-    /**
-     * the related item had something worth noting happen on it, but
-     * only for the purposes of debugging problems
-     */
-    const type_debug = 'debug';
-    /**
-     * the related item had an error occur on it
-     */
-    const type_error = 'error';
-    /**
-     * the related item is regarding some gateway interaction, like an IPN
-     * or request to process a payment
-     */
-    const type_gateway = 'gateway';
+	/**
+	 * the related object was created log type
+	 */
+	const type_create = 'create';
+	/**
+	 * the related object was updated (changed, or soft-deleted)
+	 */
+	const type_update = 'update';
+	/**
+	 * the related object was deleted permanently
+	 */
+	const type_delete = 'delete';
+	/**
+	 * the related item had something worth noting happen on it, but
+	 * only for the purposes of debugging problems
+	 */
+	const type_debug = 'debug';
+	/**
+	 * the related item had an error occur on it
+	 */
+	const type_error = 'error';
+	/**
+	 * the related item is regarding some gateway interaction, like an IPN
+	 * or request to process a payment
+	 */
+	const type_gateway = 'gateway';
 
-    /**
-     * private instance of the EEM_Change_Log object
-     *
-     * @access private
-     * @var EEM_Change_Log $_instance
-     */
-    protected static $_instance = null;
+	/**
+	 * private instance of the EEM_Change_Log object
+	 *
+	 * @access private
+	 * @var EEM_Change_Log $_instance
+	 */
+	protected static $_instance = null;
 
 
-    /**
-     * constructor
-     *
-     * @access protected
-     * @param null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        global $current_user;
-        $this->singular_item       = esc_html__('Log', 'event_espresso');
-        $this->plural_item         = esc_html__('Logs', 'event_espresso');
-        $this->_tables             = array(
-            'Log' => new EE_Primary_Table('esp_log', 'LOG_ID'),
-        );
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
-        $this->_fields             = array(
-            'Log' => array(
-                'LOG_ID'      => new EE_Primary_Key_Int_Field('LOG_ID', esc_html__('Log ID', 'event_espresso')),
-                'LOG_time'    => new EE_Datetime_Field(
-                    'LOG_time',
-                    esc_html__("Log Time", 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'OBJ_ID'      => new EE_Foreign_Key_String_Field(
-                    'OBJ_ID',
-                    esc_html__("Object ID (int or string)", 'event_espresso'),
-                    true,
-                    null,
-                    $models_this_can_attach_to
-                ),
-                'OBJ_type'    => new EE_Any_Foreign_Model_Name_Field(
-                    'OBJ_type',
-                    esc_html__("Object Type", 'event_espresso'),
-                    true,
-                    null,
-                    $models_this_can_attach_to
-                ),
-                'LOG_type'    => new EE_Plain_Text_Field(
-                    'LOG_type',
-                    esc_html__("Type of log entry", "event_espresso"),
-                    false,
-                    self::type_debug
-                ),
-                'LOG_message' => new EE_Maybe_Serialized_Text_Field(
-                    'LOG_message',
-                    esc_html__("Log Message (body)", 'event_espresso'),
-                    true
-                ),
-                /*
+	/**
+	 * constructor
+	 *
+	 * @access protected
+	 * @param null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		global $current_user;
+		$this->singular_item       = esc_html__('Log', 'event_espresso');
+		$this->plural_item         = esc_html__('Logs', 'event_espresso');
+		$this->_tables             = array(
+			'Log' => new EE_Primary_Table('esp_log', 'LOG_ID'),
+		);
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
+		$this->_fields             = array(
+			'Log' => array(
+				'LOG_ID'      => new EE_Primary_Key_Int_Field('LOG_ID', esc_html__('Log ID', 'event_espresso')),
+				'LOG_time'    => new EE_Datetime_Field(
+					'LOG_time',
+					esc_html__("Log Time", 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'OBJ_ID'      => new EE_Foreign_Key_String_Field(
+					'OBJ_ID',
+					esc_html__("Object ID (int or string)", 'event_espresso'),
+					true,
+					null,
+					$models_this_can_attach_to
+				),
+				'OBJ_type'    => new EE_Any_Foreign_Model_Name_Field(
+					'OBJ_type',
+					esc_html__("Object Type", 'event_espresso'),
+					true,
+					null,
+					$models_this_can_attach_to
+				),
+				'LOG_type'    => new EE_Plain_Text_Field(
+					'LOG_type',
+					esc_html__("Type of log entry", "event_espresso"),
+					false,
+					self::type_debug
+				),
+				'LOG_message' => new EE_Maybe_Serialized_Text_Field(
+					'LOG_message',
+					esc_html__("Log Message (body)", 'event_espresso'),
+					true
+				),
+				/*
                  * Note: when querying for a change log's user, the OBJ_ID and OBJ_type fields are used,
                  * not the LOG_wp_user field. E.g.,
                  * `EEM_Change_Log::instance()->get_all(array(array('WP_User.ID'=>1)))` will actually return
@@ -108,158 +108,158 @@ 
                  *  If you want the latter, you can't use the model's magic joining. E.g, you would need to do
                  * `EEM_Change_Log::instance()->get_all(array(array('LOG_wp_user' => 1)))`.
                  */
-                'LOG_wp_user' => new EE_WP_User_Field(
-                    'LOG_wp_user',
-                    esc_html__("User who was logged in while this occurred", 'event_espresso'),
-                    true
-                ),
-            ),
-        );
-        $this->_model_relations    = array();
-        foreach ($models_this_can_attach_to as $model) {
-            if ($model != 'Change_Log') {
-                $this->_model_relations[$model] = new EE_Belongs_To_Any_Relation();
-            }
-        }
-        //use completely custom caps for this
-        $this->_cap_restriction_generators = false;
-        //caps-wise this is all-or-nothing: if you have the default role you can access anything, otherwise nothing
-        foreach ($this->_cap_contexts_to_cap_action_map as $cap_context => $action) {
-            $this->_cap_restrictions[$cap_context][EE_Restriction_Generator_Base::get_default_restrictions_cap()]
-                = new EE_Return_None_Where_Conditions();
-        }
-        parent::__construct($timezone);
-    }
+				'LOG_wp_user' => new EE_WP_User_Field(
+					'LOG_wp_user',
+					esc_html__("User who was logged in while this occurred", 'event_espresso'),
+					true
+				),
+			),
+		);
+		$this->_model_relations    = array();
+		foreach ($models_this_can_attach_to as $model) {
+			if ($model != 'Change_Log') {
+				$this->_model_relations[$model] = new EE_Belongs_To_Any_Relation();
+			}
+		}
+		//use completely custom caps for this
+		$this->_cap_restriction_generators = false;
+		//caps-wise this is all-or-nothing: if you have the default role you can access anything, otherwise nothing
+		foreach ($this->_cap_contexts_to_cap_action_map as $cap_context => $action) {
+			$this->_cap_restrictions[$cap_context][EE_Restriction_Generator_Base::get_default_restrictions_cap()]
+				= new EE_Return_None_Where_Conditions();
+		}
+		parent::__construct($timezone);
+	}
 
-    /**
-     * @param string        $log_type !see the acceptable values of LOG_type in EEM__Change_Log::__construct
-     * @param mixed         $message  array|string of the message you want to record
-     * @param EE_Base_Class $related_model_obj
-     * @return EE_Change_Log
-     * @throws EE_Error
-     */
-    public function log($log_type, $message, $related_model_obj)
-    {
-        if ($related_model_obj instanceof EE_Base_Class) {
-            $obj_id   = $related_model_obj->ID();
-            $obj_type = $related_model_obj->get_model()->get_this_model_name();
-        } else {
-            $obj_id   = null;
-            $obj_type = null;
-        }
-        /** @var EE_Change_Log $log */
-        $log = EE_Change_Log::new_instance(array(
-            'LOG_type'    => $log_type,
-            'LOG_message' => $message,
-            'OBJ_ID'      => $obj_id,
-            'OBJ_type'    => $obj_type,
-        ));
-        $log->save();
-        return $log;
-    }
+	/**
+	 * @param string        $log_type !see the acceptable values of LOG_type in EEM__Change_Log::__construct
+	 * @param mixed         $message  array|string of the message you want to record
+	 * @param EE_Base_Class $related_model_obj
+	 * @return EE_Change_Log
+	 * @throws EE_Error
+	 */
+	public function log($log_type, $message, $related_model_obj)
+	{
+		if ($related_model_obj instanceof EE_Base_Class) {
+			$obj_id   = $related_model_obj->ID();
+			$obj_type = $related_model_obj->get_model()->get_this_model_name();
+		} else {
+			$obj_id   = null;
+			$obj_type = null;
+		}
+		/** @var EE_Change_Log $log */
+		$log = EE_Change_Log::new_instance(array(
+			'LOG_type'    => $log_type,
+			'LOG_message' => $message,
+			'OBJ_ID'      => $obj_id,
+			'OBJ_type'    => $obj_type,
+		));
+		$log->save();
+		return $log;
+	}
 
 
-    /**
-     * Adds a gateway log for the specified object, given its ID and type
-     *
-     * @param string $message
-     * @param mixed  $related_obj_id
-     * @param string $related_obj_type
-     * @throws EE_Error
-     * @return EE_Change_Log
-     */
-    public function gateway_log($message, $related_obj_id, $related_obj_type)
-    {
-        if (! EE_Registry::instance()->is_model_name($related_obj_type)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "'%s' is not a model name. A model name must be provided when making a gateway log. Eg, 'Payment', 'Payment_Method', etc",
-                        "event_espresso"
-                    ),
-                    $related_obj_type
-                )
-            );
-        }
-        /** @var EE_Change_Log $log */
-        $log = EE_Change_Log::new_instance(array(
-            'LOG_type'    => EEM_Change_Log::type_gateway,
-            'LOG_message' => $message,
-            'OBJ_ID'      => $related_obj_id,
-            'OBJ_type'    => $related_obj_type,
-        ));
-        $log->save();
-        return $log;
-    }
+	/**
+	 * Adds a gateway log for the specified object, given its ID and type
+	 *
+	 * @param string $message
+	 * @param mixed  $related_obj_id
+	 * @param string $related_obj_type
+	 * @throws EE_Error
+	 * @return EE_Change_Log
+	 */
+	public function gateway_log($message, $related_obj_id, $related_obj_type)
+	{
+		if (! EE_Registry::instance()->is_model_name($related_obj_type)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"'%s' is not a model name. A model name must be provided when making a gateway log. Eg, 'Payment', 'Payment_Method', etc",
+						"event_espresso"
+					),
+					$related_obj_type
+				)
+			);
+		}
+		/** @var EE_Change_Log $log */
+		$log = EE_Change_Log::new_instance(array(
+			'LOG_type'    => EEM_Change_Log::type_gateway,
+			'LOG_message' => $message,
+			'OBJ_ID'      => $related_obj_id,
+			'OBJ_type'    => $related_obj_type,
+		));
+		$log->save();
+		return $log;
+	}
 
 
-    /**
-     * Just gets the bare-bones wpdb results as an array in cases where efficiency is essential
-     *
-     * @param array $query_params @see EEM_Base::get_all
-     * @return array of arrays
-     * @throws EE_Error
-     */
-    public function get_all_efficiently($query_params)
-    {
-        return $this->_get_all_wpdb_results($query_params);
-    }
+	/**
+	 * Just gets the bare-bones wpdb results as an array in cases where efficiency is essential
+	 *
+	 * @param array $query_params @see EEM_Base::get_all
+	 * @return array of arrays
+	 * @throws EE_Error
+	 */
+	public function get_all_efficiently($query_params)
+	{
+		return $this->_get_all_wpdb_results($query_params);
+	}
 
 
-    /**
-     * Executes a database query to delete gateway logs. Does not affect model objects, so if you attempt to use
-     * models after this, they may be out-of-sync with the database
-     *
-     * @param DateTime $datetime
-     * @return false|int
-     * @throws EE_Error
-     */
-    public function delete_gateway_logs_older_than(DateTime $datetime)
-    {
-        global $wpdb;
-        return $wpdb->query(
-            $wpdb->prepare(
-                'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s',
-                EEM_Change_Log::type_gateway,
-                $datetime->format(EE_Datetime_Field::mysql_timestamp_format)
-            )
-        );
-    }
+	/**
+	 * Executes a database query to delete gateway logs. Does not affect model objects, so if you attempt to use
+	 * models after this, they may be out-of-sync with the database
+	 *
+	 * @param DateTime $datetime
+	 * @return false|int
+	 * @throws EE_Error
+	 */
+	public function delete_gateway_logs_older_than(DateTime $datetime)
+	{
+		global $wpdb;
+		return $wpdb->query(
+			$wpdb->prepare(
+				'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s',
+				EEM_Change_Log::type_gateway,
+				$datetime->format(EE_Datetime_Field::mysql_timestamp_format)
+			)
+		);
+	}
 
 
-    /**
-     * Returns the map of type to pretty label for identifiers used for `LOG_type`.  Client code can register their own
-     * map vai the given filter.
-     *
-     * @return array
-     */
-    public static function get_pretty_label_map_for_registered_types()
-    {
-        return apply_filters(
-            'FHEE__EEM_Change_Log__get_pretty_label_map_for_registered_types',
-            array(
-                self::type_create=>  esc_html__("Create", "event_espresso"),
-                self::type_update=>  esc_html__("Update", "event_espresso"),
-                self::type_delete => esc_html__("Delete", "event_espresso"),
-                self::type_debug=>  esc_html__("Debug", "event_espresso"),
-                self::type_error=>  esc_html__("Error", "event_espresso"),
-                self::type_gateway=> esc_html__("Gateway Interaction (IPN or Direct Payment)", 'event_espresso')
-            )
-        );
-    }
+	/**
+	 * Returns the map of type to pretty label for identifiers used for `LOG_type`.  Client code can register their own
+	 * map vai the given filter.
+	 *
+	 * @return array
+	 */
+	public static function get_pretty_label_map_for_registered_types()
+	{
+		return apply_filters(
+			'FHEE__EEM_Change_Log__get_pretty_label_map_for_registered_types',
+			array(
+				self::type_create=>  esc_html__("Create", "event_espresso"),
+				self::type_update=>  esc_html__("Update", "event_espresso"),
+				self::type_delete => esc_html__("Delete", "event_espresso"),
+				self::type_debug=>  esc_html__("Debug", "event_espresso"),
+				self::type_error=>  esc_html__("Error", "event_espresso"),
+				self::type_gateway=> esc_html__("Gateway Interaction (IPN or Direct Payment)", 'event_espresso')
+			)
+		);
+	}
 
 
-    /**
-     * Return the pretty (localized) label for the given log type identifier.
-     * @param string $type_identifier
-     * @return string
-     */
-    public static function get_pretty_label_for_type($type_identifier)
-    {
-        $type_identifier_map = self::get_pretty_label_map_for_registered_types();
-        //we fallback to the incoming type identifier if there is no localized label for it.
-        return isset($type_identifier_map[$type_identifier])
-            ? $type_identifier_map[$type_identifier]
-            : $type_identifier;
-    }
+	/**
+	 * Return the pretty (localized) label for the given log type identifier.
+	 * @param string $type_identifier
+	 * @return string
+	 */
+	public static function get_pretty_label_for_type($type_identifier)
+	{
+		$type_identifier_map = self::get_pretty_label_map_for_registered_types();
+		//we fallback to the incoming type identifier if there is no localized label for it.
+		return isset($type_identifier_map[$type_identifier])
+			? $type_identifier_map[$type_identifier]
+			: $type_identifier;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -115,7 +115,7 @@ 
                 ),
             ),
         );
-        $this->_model_relations    = array();
+        $this->_model_relations = array();
         foreach ($models_this_can_attach_to as $model) {
             if ($model != 'Change_Log') {
                 $this->_model_relations[$model] = new EE_Belongs_To_Any_Relation();
@@ -170,7 +170,7 @@ 
      */
     public function gateway_log($message, $related_obj_id, $related_obj_type)
     {
-        if (! EE_Registry::instance()->is_model_name($related_obj_type)) {
+        if ( ! EE_Registry::instance()->is_model_name($related_obj_type)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -219,7 +219,7 @@ 
         global $wpdb;
         return $wpdb->query(
             $wpdb->prepare(
-                'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s',
+                'DELETE FROM '.$this->table().' WHERE LOG_type = %s AND LOG_time < %s',
                 EEM_Change_Log::type_gateway,
                 $datetime->format(EE_Datetime_Field::mysql_timestamp_format)
             )

core/EE_Registry.core.php

Indentation +1513 added lines, -1513 removed lines

@@ -22,1519 +22,1519 @@
 class EE_Registry implements ResettableInterface
 {
 
-    /**
-     * @var EE_Registry $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Dependency_Map $_dependency_map
-     */
-    protected $_dependency_map;
-
-    /**
-     * @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 StdClass $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
-     *
-     * @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;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param  EE_Dependency_Map $dependency_map
-     * @return EE_Registry instance
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function instance(EE_Dependency_Map $dependency_map = null)
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registry) {
-            self::$_instance = new self($dependency_map);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @Constructor
-     * @param  EE_Dependency_Map $dependency_map
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct(EE_Dependency_Map $dependency_map)
-    {
-        $this->_dependency_map = $dependency_map;
-        $this->LIB = new stdClass();
-        $this->addons = new stdClass();
-        $this->modules = new stdClass();
-        $this->shortcodes = new stdClass();
-        $this->widgets = new stdClass();
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
-    }
-
-
-
-    /**
-     * initialize
-     *
-     * @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('EE_Request');
-        $this->_set_cached_class(
-            $request_loader(),
-            'EE_Request'
-        );
-        $response_loader = $this->_dependency_map->class_loader('EE_Response');
-        $this->_set_cached_class(
-            $response_loader(),
-            'EE_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 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')) {
-                $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 EE_Error
-     * @throws ReflectionException
-     */
-    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' . DS,
-                EE_CORE . 'capabilities' . DS,
-                EE_CORE . 'request_stack' . DS,
-                EE_CORE . 'middleware' . DS,
-            )
-        );
-        // 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 EE_Error
-     * @throws ReflectionException
-     */
-    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' . DS,
-            )
-        );
-        // 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 EE_Error
-     * @throws ReflectionException
-     */
-    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 EE_Error
-     * @throws ReflectionException
-     */
-    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 EE_Error
-     * @throws ReflectionException
-     */
-    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 EE_Error
-     * @throws ReflectionException
-     */
-    public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
-    {
-        $paths = array(
-            EE_LIBRARIES,
-            EE_LIBRARIES . 'messages' . DS,
-            EE_LIBRARIES . 'shortcodes' . DS,
-            EE_LIBRARIES . 'qtips' . DS,
-            EE_LIBRARIES . 'payment_methods' . DS,
-        );
-        // 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 EE_Error
-     * @throws ReflectionException
-     */
-    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 EE_Error
-     * @throws ReflectionException
-     */
-    public function load_model_class($class_name, $arguments = array(), $load_only = true)
-    {
-        $paths = array(
-            EE_MODELS . 'fields' . DS,
-            EE_MODELS . 'helpers' . DS,
-            EE_MODELS . 'relations' . DS,
-            EE_MODELS . 'strategies' . DS,
-        );
-        // 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 EE_Error
-     * @throws ReflectionException
-     */
-    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 EE_Error
-     * @throws ReflectionException
-     */
-    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 EE_Error
-     * @throws ReflectionException
-     */
-    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->_dependency_map->get_alias($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);
-            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);
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-
-    /**
-     * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
-     *
-     * @param string $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
-     */
-    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->_dependency_map->get_alias($class_name);
-        $class_exists = class_exists($class_name);
-        // 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;
-        }
-        // $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);
-            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 loading failed, or we are only loading a file but NOT instantiating an object
-            if (! $loaded || $load_only) {
-                // return boolean if only loading, or null if an object was expected
-                return $load_only
-                    ? $loaded
-                    : 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);
-        }
-        $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
-     * @return mixed
-     */
-    protected function _get_cached_class($class_name, $class_prefix = '')
-    {
-        if ($class_name === 'EE_Registry') {
-            return $this;
-        }
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        $class_name = str_replace('\\', '_', $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};
-        }
-        if (isset ($this->{$class_name})) {
-            return $this->{$class_name};
-        }
-        if (isset ($this->LIB->{$class_name})) {
-            return $this->LIB->{$class_name};
-        }
-        if ($class_prefix === 'addon' && isset ($this->addons->{$class_name})) {
-            return $this->addons->{$class_name};
-        }
-        return null;
-    }
-
-
-
-    /**
-     * removes a cached version of the requested class
-     *
-     * @param string  $class_name
-     * @param boolean $addon
-     * @return boolean
-     */
-    public function clear_cached_class($class_name, $addon = false)
-    {
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        $class_name = str_replace('\\', '_', $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;
-        }
-        if (isset($this->{$class_name})) {
-            $this->{$class_name} = null;
-            return true;
-        }
-        if (isset($this->LIB->{$class_name})) {
-            unset($this->LIB->{$class_name});
-            return true;
-        }
-        if ($addon && isset($this->addons->{$class_name})) {
-            unset($this->addons->{$class_name});
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * 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 DS, if no filepath, then use EE_CLASSES
-            $file_path = $file_path
-                ? str_replace(array('/', '\\'), DS, $file_path)
-                : EE_CLASSES;
-            // prep file type
-            $type = ! empty($type)
-                ? trim($type, '.') . '.'
-                : '';
-            // build full file path
-            $file_paths[$key] = rtrim($file_path, DS) . DS . $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())
-    {
-        // don't give up! you gotta...
-        try {
-            //does the file exist and can it be read ?
-            if (! $path) {
-                // 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;
-    }
-
-
-
-    /**
-     * _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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
-    {
-        // create reflection
-        $reflector = $this->get_ReflectionClass($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) && $reflector->getConstructor() === 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()) {
-            // $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;
-    }
-
-
-
-    /**
-     * getReflectionClass
-     * checks if a ReflectionClass object has already been generated for a class
-     * and returns that instead of creating a new one
-     *
-     * @param string $class_name
-     * @return ReflectionClass
-     * @throws ReflectionException
-     */
-    public function get_ReflectionClass($class_name)
-    {
-        if (
-            ! isset($this->_reflectors[$class_name])
-            || ! $this->_reflectors[$class_name] instanceof ReflectionClass
-        ) {
-            $this->_reflectors[$class_name] = new ReflectionClass($class_name);
-        }
-        return $this->_reflectors[$class_name];
-    }
-
-
-
-    /**
-     * _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 EE_Error
-     * @throws ReflectionException
-     */
-    protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array())
-    {
-        // let's examine the constructor
-        $constructor = $reflector->getConstructor();
-        // whu? huh? nothing?
-        if (! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $constructor->getParameters();
-        // 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) {
-            // is this a dependency for a specific class ?
-            $param_class = $param->getClass()
-                ? $param->getClass()->name
-                : null;
-            // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
-            $param_class = $this->_dependency_map->has_alias($param_class, $class_name)
-                ? $this->_dependency_map->get_alias($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 (
-                // 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 (
-                // 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,
-                    $argument_keys
-                );
-            } else {
-                try {
-                    $arguments[$index] = $param->isDefaultValueAvailable()
-                        ? $param->getDefaultValue()
-                        : null;
-                } catch (ReflectionException $e) {
-                    throw new ReflectionException(
-                        sprintf(
-                            esc_html__('%1$s for parameter "$%2$s on classname "%3$s"', 'event_espresso'),
-                            $e->getMessage(),
-                            $param->getName(),
-                            $class_name
-                        )
-                    );
-                }
-            }
-        }
-        return $arguments;
-    }
-
-
-
-    /**
-     * @param string $class_name
-     * @param string $param_class
-     * @param array  $arguments
-     * @param mixed  $index
-     * @param array  $argument_keys
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _resolve_dependency($class_name, $param_class, $arguments, $index, array $argument_keys)
-    {
-        $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;
-        } else if ($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;
-    }
-
-
-
-    /**
-     * _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
-     * @return void
-     */
-    protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false)
-    {
-        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) {
-            $this->LIB->{$class_name} = $class_obj;
-        }
-    }
-
-
-
-    /**
-     * 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 name/slug (not classname. For that, just
-     * use the classname as the property name on EE_Config::instance()->addons)
-     *
-     * @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_Config::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, use
-     * EE_Config::instance()->addons->{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 EE_Error
-     * @throws ReflectionException
-     */
-    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();
-        $hard = apply_filters( 'FHEE__EE_Registry__reset__hard', $hard);
-        $instance->CFG = EE_Config::reset($hard, $reinstantiate);
-        $instance->CART = null;
-        $instance->MRM = null;
-        $instance->AssetsRegistry = $instance->create('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;
-    }
+	/**
+	 * @var EE_Registry $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Dependency_Map $_dependency_map
+	 */
+	protected $_dependency_map;
+
+	/**
+	 * @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 StdClass $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
+	 *
+	 * @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;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param  EE_Dependency_Map $dependency_map
+	 * @return EE_Registry instance
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function instance(EE_Dependency_Map $dependency_map = null)
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Registry) {
+			self::$_instance = new self($dependency_map);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @param  EE_Dependency_Map $dependency_map
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct(EE_Dependency_Map $dependency_map)
+	{
+		$this->_dependency_map = $dependency_map;
+		$this->LIB = new stdClass();
+		$this->addons = new stdClass();
+		$this->modules = new stdClass();
+		$this->shortcodes = new stdClass();
+		$this->widgets = new stdClass();
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
+	}
+
+
+
+	/**
+	 * initialize
+	 *
+	 * @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('EE_Request');
+		$this->_set_cached_class(
+			$request_loader(),
+			'EE_Request'
+		);
+		$response_loader = $this->_dependency_map->class_loader('EE_Response');
+		$this->_set_cached_class(
+			$response_loader(),
+			'EE_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 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')) {
+				$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 EE_Error
+	 * @throws ReflectionException
+	 */
+	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' . DS,
+				EE_CORE . 'capabilities' . DS,
+				EE_CORE . 'request_stack' . DS,
+				EE_CORE . 'middleware' . DS,
+			)
+		);
+		// 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 EE_Error
+	 * @throws ReflectionException
+	 */
+	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' . DS,
+			)
+		);
+		// 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 EE_Error
+	 * @throws ReflectionException
+	 */
+	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 EE_Error
+	 * @throws ReflectionException
+	 */
+	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 EE_Error
+	 * @throws ReflectionException
+	 */
+	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 EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
+	{
+		$paths = array(
+			EE_LIBRARIES,
+			EE_LIBRARIES . 'messages' . DS,
+			EE_LIBRARIES . 'shortcodes' . DS,
+			EE_LIBRARIES . 'qtips' . DS,
+			EE_LIBRARIES . 'payment_methods' . DS,
+		);
+		// 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 EE_Error
+	 * @throws ReflectionException
+	 */
+	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 EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_model_class($class_name, $arguments = array(), $load_only = true)
+	{
+		$paths = array(
+			EE_MODELS . 'fields' . DS,
+			EE_MODELS . 'helpers' . DS,
+			EE_MODELS . 'relations' . DS,
+			EE_MODELS . 'strategies' . DS,
+		);
+		// 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 EE_Error
+	 * @throws ReflectionException
+	 */
+	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 EE_Error
+	 * @throws ReflectionException
+	 */
+	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 EE_Error
+	 * @throws ReflectionException
+	 */
+	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->_dependency_map->get_alias($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);
+			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);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
+	 *
+	 * @param string $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
+	 */
+	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->_dependency_map->get_alias($class_name);
+		$class_exists = class_exists($class_name);
+		// 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;
+		}
+		// $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);
+			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 loading failed, or we are only loading a file but NOT instantiating an object
+			if (! $loaded || $load_only) {
+				// return boolean if only loading, or null if an object was expected
+				return $load_only
+					? $loaded
+					: 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);
+		}
+		$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
+	 * @return mixed
+	 */
+	protected function _get_cached_class($class_name, $class_prefix = '')
+	{
+		if ($class_name === 'EE_Registry') {
+			return $this;
+		}
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		$class_name = str_replace('\\', '_', $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};
+		}
+		if (isset ($this->{$class_name})) {
+			return $this->{$class_name};
+		}
+		if (isset ($this->LIB->{$class_name})) {
+			return $this->LIB->{$class_name};
+		}
+		if ($class_prefix === 'addon' && isset ($this->addons->{$class_name})) {
+			return $this->addons->{$class_name};
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * removes a cached version of the requested class
+	 *
+	 * @param string  $class_name
+	 * @param boolean $addon
+	 * @return boolean
+	 */
+	public function clear_cached_class($class_name, $addon = false)
+	{
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		$class_name = str_replace('\\', '_', $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;
+		}
+		if (isset($this->{$class_name})) {
+			$this->{$class_name} = null;
+			return true;
+		}
+		if (isset($this->LIB->{$class_name})) {
+			unset($this->LIB->{$class_name});
+			return true;
+		}
+		if ($addon && isset($this->addons->{$class_name})) {
+			unset($this->addons->{$class_name});
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * 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 DS, if no filepath, then use EE_CLASSES
+			$file_path = $file_path
+				? str_replace(array('/', '\\'), DS, $file_path)
+				: EE_CLASSES;
+			// prep file type
+			$type = ! empty($type)
+				? trim($type, '.') . '.'
+				: '';
+			// build full file path
+			$file_paths[$key] = rtrim($file_path, DS) . DS . $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())
+	{
+		// don't give up! you gotta...
+		try {
+			//does the file exist and can it be read ?
+			if (! $path) {
+				// 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;
+	}
+
+
+
+	/**
+	 * _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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
+	{
+		// create reflection
+		$reflector = $this->get_ReflectionClass($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) && $reflector->getConstructor() === 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()) {
+			// $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;
+	}
+
+
+
+	/**
+	 * getReflectionClass
+	 * checks if a ReflectionClass object has already been generated for a class
+	 * and returns that instead of creating a new one
+	 *
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 * @throws ReflectionException
+	 */
+	public function get_ReflectionClass($class_name)
+	{
+		if (
+			! isset($this->_reflectors[$class_name])
+			|| ! $this->_reflectors[$class_name] instanceof ReflectionClass
+		) {
+			$this->_reflectors[$class_name] = new ReflectionClass($class_name);
+		}
+		return $this->_reflectors[$class_name];
+	}
+
+
+
+	/**
+	 * _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 EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array())
+	{
+		// let's examine the constructor
+		$constructor = $reflector->getConstructor();
+		// whu? huh? nothing?
+		if (! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $constructor->getParameters();
+		// 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) {
+			// is this a dependency for a specific class ?
+			$param_class = $param->getClass()
+				? $param->getClass()->name
+				: null;
+			// BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
+			$param_class = $this->_dependency_map->has_alias($param_class, $class_name)
+				? $this->_dependency_map->get_alias($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 (
+				// 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 (
+				// 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,
+					$argument_keys
+				);
+			} else {
+				try {
+					$arguments[$index] = $param->isDefaultValueAvailable()
+						? $param->getDefaultValue()
+						: null;
+				} catch (ReflectionException $e) {
+					throw new ReflectionException(
+						sprintf(
+							esc_html__('%1$s for parameter "$%2$s on classname "%3$s"', 'event_espresso'),
+							$e->getMessage(),
+							$param->getName(),
+							$class_name
+						)
+					);
+				}
+			}
+		}
+		return $arguments;
+	}
+
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $param_class
+	 * @param array  $arguments
+	 * @param mixed  $index
+	 * @param array  $argument_keys
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _resolve_dependency($class_name, $param_class, $arguments, $index, array $argument_keys)
+	{
+		$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;
+		} else if ($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;
+	}
+
+
+
+	/**
+	 * _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
+	 * @return void
+	 */
+	protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false)
+	{
+		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) {
+			$this->LIB->{$class_name} = $class_obj;
+		}
+	}
+
+
+
+	/**
+	 * 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 name/slug (not classname. For that, just
+	 * use the classname as the property name on EE_Config::instance()->addons)
+	 *
+	 * @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_Config::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, use
+	 * EE_Config::instance()->addons->{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 EE_Error
+	 * @throws ReflectionException
+	 */
+	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();
+		$hard = apply_filters( 'FHEE__EE_Registry__reset__hard', $hard);
+		$instance->CFG = EE_Config::reset($hard, $reinstantiate);
+		$instance->CART = null;
+		$instance->MRM = null;
+		$instance->AssetsRegistry = $instance->create('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;
+	}
 
 
 }

Spacing +35 added lines, -35 removed lines

@@ -176,7 +176,7 @@ 
     public static function instance(EE_Dependency_Map $dependency_map = null)
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registry) {
+        if ( ! self::$_instance instanceof EE_Registry) {
             self::$_instance = new self($dependency_map);
         }
         return self::$_instance;
@@ -266,13 +266,13 @@ 
      */
     public static function localize_i18n_js_strings()
     {
-        $i18n_js_strings = (array)self::$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');
+                $i18n_js_strings[$key] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
             }
         }
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+        return '/* <![CDATA[ */ var eei18n = '.wp_json_encode($i18n_js_strings).'; /* ]]> */';
     }
 
 
@@ -288,7 +288,7 @@ 
             $module_class = get_class($module);
             $this->modules->{$module_class} = $module;
         } else {
-            if (! class_exists('EE_Module_Request_Router')) {
+            if ( ! class_exists('EE_Module_Request_Router')) {
                 $this->load_core('Module_Request_Router');
             }
             EE_Module_Request_Router::module_factory($module);
@@ -328,10 +328,10 @@ 
                 EE_CORE,
                 EE_ADMIN,
                 EE_CPTS,
-                EE_CORE . 'data_migration_scripts' . DS,
-                EE_CORE . 'capabilities' . DS,
-                EE_CORE . 'request_stack' . DS,
-                EE_CORE . 'middleware' . DS,
+                EE_CORE.'data_migration_scripts'.DS,
+                EE_CORE.'capabilities'.DS,
+                EE_CORE.'request_stack'.DS,
+                EE_CORE.'middleware'.DS,
             )
         );
         // retrieve instantiated class
@@ -364,7 +364,7 @@ 
         $service_paths = apply_filters(
             'FHEE__EE_Registry__load_service__service_paths',
             array(
-                EE_CORE . 'services' . DS,
+                EE_CORE.'services'.DS,
             )
         );
         // retrieve instantiated class
@@ -490,10 +490,10 @@ 
     {
         $paths = array(
             EE_LIBRARIES,
-            EE_LIBRARIES . 'messages' . DS,
-            EE_LIBRARIES . 'shortcodes' . DS,
-            EE_LIBRARIES . 'qtips' . DS,
-            EE_LIBRARIES . 'payment_methods' . DS,
+            EE_LIBRARIES.'messages'.DS,
+            EE_LIBRARIES.'shortcodes'.DS,
+            EE_LIBRARIES.'qtips'.DS,
+            EE_LIBRARIES.'payment_methods'.DS,
         );
         // retrieve instantiated class
         return $this->_load(
@@ -556,10 +556,10 @@ 
     public function load_model_class($class_name, $arguments = array(), $load_only = true)
     {
         $paths = array(
-            EE_MODELS . 'fields' . DS,
-            EE_MODELS . 'helpers' . DS,
-            EE_MODELS . 'relations' . DS,
-            EE_MODELS . 'strategies' . DS,
+            EE_MODELS.'fields'.DS,
+            EE_MODELS.'helpers'.DS,
+            EE_MODELS.'relations'.DS,
+            EE_MODELS.'strategies'.DS,
         );
         // retrieve instantiated class
         return $this->_load(
@@ -678,7 +678,7 @@ 
         $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){
+        if ($class_exists instanceof $class_name || $class_exists === null) {
             // either way, return the results
             return $class_exists;
         }
@@ -736,7 +736,7 @@ 
             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, '\\')
+                    ? '\\'.ltrim($class_name, '\\')
                     : $class_name;
                 break;
             case 2:
@@ -788,11 +788,11 @@ 
         // 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') {
+        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 = $class_prefix.str_replace($class_prefix, '', $class_name);
         }
         $class_name = $this->_dependency_map->get_alias($class_name);
         $class_exists = class_exists($class_name);
@@ -811,13 +811,13 @@ 
             }
         }
         // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
+        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 loading failed, or we are only loading a file but NOT instantiating an object
-            if (! $loaded || $load_only) {
+            if ( ! $loaded || $load_only) {
                 // return boolean if only loading, or null if an object was expected
                 return $load_only
                     ? $loaded
@@ -942,10 +942,10 @@ 
                 : EE_CLASSES;
             // prep file type
             $type = ! empty($type)
-                ? trim($type, '.') . '.'
+                ? trim($type, '.').'.'
                 : '';
             // build full file path
-            $file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
+            $file_paths[$key] = rtrim($file_path, DS).DS.$class_name.'.'.$type.'php';
             //does the file exist and can be read ?
             if (is_readable($file_paths[$key])) {
                 return $file_paths[$key];
@@ -973,9 +973,9 @@ 
         // don't give up! you gotta...
         try {
             //does the file exist and can it be read ?
-            if (! $path) {
+            if ( ! $path) {
                 // so sorry, can't find the file
-                throw new EE_Error (
+                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',
@@ -983,7 +983,7 @@ 
                         ),
                         trim($type, '.'),
                         $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
+                        '<br />'.implode(',<br />', $file_paths)
                     )
                 );
             }
@@ -1151,7 +1151,7 @@ 
         // let's examine the constructor
         $constructor = $reflector->getConstructor();
         // whu? huh? nothing?
-        if (! $constructor) {
+        if ( ! $constructor) {
             return $arguments;
         }
         // get constructor parameters
@@ -1317,7 +1317,7 @@ 
             $this->addons->{$class_name} = $class_obj;
             return;
         }
-        if (! $from_db) {
+        if ( ! $from_db) {
             $this->LIB->{$class_name} = $class_obj;
         }
     }
@@ -1398,7 +1398,7 @@ 
         $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) {
+        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
@@ -1451,7 +1451,7 @@ 
         $instance->_cache_on = true;
         // reset some "special" classes
         EEH_Activation::reset();
-        $hard = apply_filters( 'FHEE__EE_Registry__reset__hard', $hard);
+        $hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
         $instance->CFG = EE_Config::reset($hard, $reinstantiate);
         $instance->CART = null;
         $instance->MRM = null;
@@ -1482,7 +1482,7 @@ 
      */
     private static function _reset_and_unset_object($object, $reset_models)
     {
-        if (! is_object($object)) {
+        if ( ! is_object($object)) {
             // don't unset anything that's not an object
             return false;
         }
@@ -1502,7 +1502,7 @@ 
             $object->reset();
             return true;
         }
-        if (! $object instanceof InterminableInterface) {
+        if ( ! $object instanceof InterminableInterface) {
             return true;
         }
         return false;

core/helpers/EEH_Line_Item.helper.php

Spacing +346 added lines, -346 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (!defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
 /**
  *
  * EEH_Line_Item
@@ -45,8 +45,8 @@ 
 	 * @return boolean success
 	 * @throws \EE_Error
 	 */
-	public static function add_unrelated_item( EE_Line_Item $parent_line_item, $name, $unit_price, $description = '', $quantity = 1, $taxable = FALSE, $code = NULL  ){
-		$items_subtotal = self::get_pre_tax_subtotal( $parent_line_item );
+	public static function add_unrelated_item(EE_Line_Item $parent_line_item, $name, $unit_price, $description = '', $quantity = 1, $taxable = FALSE, $code = NULL) {
+		$items_subtotal = self::get_pre_tax_subtotal($parent_line_item);
 		$line_item = EE_Line_Item::new_instance(array(
 			'LIN_name' => $name,
 			'LIN_desc' => $description,
@@ -54,7 +54,7 @@ 
 			'LIN_quantity' => $quantity,
 			'LIN_percent' => null,
 			'LIN_is_taxable' => $taxable,
-			'LIN_order' => $items_subtotal instanceof EE_Line_Item ? count( $items_subtotal->children() ) : 0,
+			'LIN_order' => $items_subtotal instanceof EE_Line_Item ? count($items_subtotal->children()) : 0,
 			'LIN_total' => (float) $unit_price * (int) $quantity,
 			'LIN_type'=>  EEM_Line_Item::type_line_item,
 			'LIN_code' => $code,
@@ -64,7 +64,7 @@ 
 			$line_item,
 			$parent_line_item
 		);
-		return self::add_item( $parent_line_item, $line_item );
+		return self::add_item($parent_line_item, $line_item);
 	}
 
 
@@ -86,7 +86,7 @@ 
 	 * @return boolean success
 	 * @throws \EE_Error
 	 */
-	public static function add_percentage_based_item( EE_Line_Item $parent_line_item, $name, $percentage_amount, $description = '', $taxable = FALSE ){
+	public static function add_percentage_based_item(EE_Line_Item $parent_line_item, $name, $percentage_amount, $description = '', $taxable = FALSE) {
 		$line_item = EE_Line_Item::new_instance(array(
 			'LIN_name' => $name,
 			'LIN_desc' => $description,
@@ -94,7 +94,7 @@ 
 			'LIN_percent' => $percentage_amount,
 			'LIN_quantity' => NULL,
 			'LIN_is_taxable' => $taxable,
-			'LIN_total' => (float) ( $percentage_amount * ( $parent_line_item->total() / 100 ) ),
+			'LIN_total' => (float) ($percentage_amount * ($parent_line_item->total() / 100)),
 			'LIN_type'=>  EEM_Line_Item::type_line_item,
 			'LIN_parent' => $parent_line_item->ID()
 		));
@@ -123,15 +123,15 @@ 
 	 * @return \EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function add_ticket_purchase( EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1 ){
-		if ( ! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total() ) {
-			throw new EE_Error( sprintf( __( 'A valid line item total is required in order to add tickets. A line item of type "%s" was passed.', 'event_espresso' ), $ticket->ID(), $total_line_item->ID() ) );
+	public static function add_ticket_purchase(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) {
+		if ( ! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) {
+			throw new EE_Error(sprintf(__('A valid line item total is required in order to add tickets. A line item of type "%s" was passed.', 'event_espresso'), $ticket->ID(), $total_line_item->ID()));
 		}
 		// either increment the qty for an existing ticket
-		$line_item = self::increment_ticket_qty_if_already_in_cart( $total_line_item, $ticket, $qty );
+		$line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty);
 		// or add a new one
-		if ( ! $line_item instanceof EE_Line_Item ) {
-			$line_item = self::create_ticket_line_item( $total_line_item, $ticket, $qty );
+		if ( ! $line_item instanceof EE_Line_Item) {
+			$line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty);
 		}
 		$total_line_item->recalculate_total_including_taxes();
 		return $line_item;
@@ -147,11 +147,11 @@ 
 	 * @return \EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function increment_ticket_qty_if_already_in_cart( EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1 ) {
+	public static function increment_ticket_qty_if_already_in_cart(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) {
 		$line_item = null;
-		if ( $total_line_item instanceof EE_Line_Item && $total_line_item->is_total() ) {
-			$ticket_line_items = EEH_Line_Item::get_ticket_line_items( $total_line_item );
-			foreach ( (array)$ticket_line_items as $ticket_line_item ) {
+		if ($total_line_item instanceof EE_Line_Item && $total_line_item->is_total()) {
+			$ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
+			foreach ((array) $ticket_line_items as $ticket_line_item) {
 				if (
 					$ticket_line_item instanceof EE_Line_Item
 					&& (int) $ticket_line_item->OBJ_ID() === (int) $ticket->ID()
@@ -161,8 +161,8 @@ 
 				}
 			}
 		}
-		if ( $line_item instanceof EE_Line_Item ) {
-			EEH_Line_Item::increment_quantity( $line_item, $qty );
+		if ($line_item instanceof EE_Line_Item) {
+			EEH_Line_Item::increment_quantity($line_item, $qty);
 			return $line_item;
 		}
 		return null;
@@ -179,16 +179,16 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public static function increment_quantity( EE_Line_Item $line_item, $qty = 1 ) {
-		if( ! $line_item->is_percent() ) {
+	public static function increment_quantity(EE_Line_Item $line_item, $qty = 1) {
+		if ( ! $line_item->is_percent()) {
 			$qty += $line_item->quantity();
-			$line_item->set_quantity( $qty );
-			$line_item->set_total( $line_item->unit_price() * $qty );
+			$line_item->set_quantity($qty);
+			$line_item->set_total($line_item->unit_price() * $qty);
 			$line_item->save();
 		}
-		foreach( $line_item->children() as $child ) {
-			if( $child->is_sub_line_item() ) {
-				EEH_Line_Item::update_quantity( $child, $qty );
+		foreach ($line_item->children() as $child) {
+			if ($child->is_sub_line_item()) {
+				EEH_Line_Item::update_quantity($child, $qty);
 			}
 		}
 	}
@@ -204,17 +204,17 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public static function decrement_quantity( EE_Line_Item $line_item, $qty = 1 ) {
-		if( ! $line_item->is_percent() ) {
+	public static function decrement_quantity(EE_Line_Item $line_item, $qty = 1) {
+		if ( ! $line_item->is_percent()) {
 			$qty = $line_item->quantity() - $qty;
-			$qty = max( $qty, 0 );
-			$line_item->set_quantity( $qty );
-			$line_item->set_total( $line_item->unit_price() * $qty );
+			$qty = max($qty, 0);
+			$line_item->set_quantity($qty);
+			$line_item->set_total($line_item->unit_price() * $qty);
 			$line_item->save();
 		}
-		foreach( $line_item->children() as $child ) {
-			if( $child->is_sub_line_item() ) {
-				EEH_Line_Item::update_quantity( $child, $qty );
+		foreach ($line_item->children() as $child) {
+			if ($child->is_sub_line_item()) {
+				EEH_Line_Item::update_quantity($child, $qty);
 			}
 		}
 	}
@@ -229,15 +229,15 @@ 
 	 * @param int          $new_quantity
 	 * @throws \EE_Error
 	 */
-	public static function update_quantity( EE_Line_Item $line_item, $new_quantity ) {
-		if( ! $line_item->is_percent() ) {
-			$line_item->set_quantity( $new_quantity );
-			$line_item->set_total( $line_item->unit_price() * $new_quantity );
+	public static function update_quantity(EE_Line_Item $line_item, $new_quantity) {
+		if ( ! $line_item->is_percent()) {
+			$line_item->set_quantity($new_quantity);
+			$line_item->set_total($line_item->unit_price() * $new_quantity);
 			$line_item->save();
 		}
-		foreach( $line_item->children() as $child ) {
-			if( $child->is_sub_line_item() ) {
-				EEH_Line_Item::update_quantity( $child, $new_quantity );
+		foreach ($line_item->children() as $child) {
+			if ($child->is_sub_line_item()) {
+				EEH_Line_Item::update_quantity($child, $new_quantity);
 			}
 		}
 	}
@@ -252,43 +252,43 @@ 
 	 * @return \EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function create_ticket_line_item( EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1 ) {
+	public static function create_ticket_line_item(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) {
 		$datetimes = $ticket->datetimes();
-		$first_datetime = reset( $datetimes );
-		if( $first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event ) {
+		$first_datetime = reset($datetimes);
+		if ($first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event) {
 			$first_datetime_name = $first_datetime->event()->name();
 		} else {
-			$first_datetime_name = __( 'Event', 'event_espresso' );
+			$first_datetime_name = __('Event', 'event_espresso');
 		}
-		$event = sprintf( _x( '(For %1$s)', '(For Event Name)', 'event_espresso' ), $first_datetime_name );
+		$event = sprintf(_x('(For %1$s)', '(For Event Name)', 'event_espresso'), $first_datetime_name);
 		// get event subtotal line
-		$events_sub_total = self::get_event_line_item_for_ticket( $total_line_item, $ticket );
+		$events_sub_total = self::get_event_line_item_for_ticket($total_line_item, $ticket);
 		// add $ticket to cart
-		$line_item = EE_Line_Item::new_instance( array(
+		$line_item = EE_Line_Item::new_instance(array(
 			'LIN_name'       	=> $ticket->name(),
-			'LIN_desc'       		=> $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event,
+			'LIN_desc'       		=> $ticket->description() !== '' ? $ticket->description().' '.$event : $event,
 			'LIN_unit_price' 	=> $ticket->price(),
 			'LIN_quantity'   	=> $qty,
 			'LIN_is_taxable' 	=> $ticket->taxable(),
-			'LIN_order'      	=> count( $events_sub_total->children() ),
+			'LIN_order'      	=> count($events_sub_total->children()),
 			'LIN_total'      		=> $ticket->price() * $qty,
 			'LIN_type'       		=> EEM_Line_Item::type_line_item,
 			'OBJ_ID'         		=> $ticket->ID(),
 			'OBJ_type'       	=> 'Ticket'
-		) );
+		));
 		$line_item = apply_filters(
 			'FHEE__EEH_Line_Item__create_ticket_line_item__line_item',
 			$line_item
 		);
-		$events_sub_total->add_child_line_item( $line_item );
+		$events_sub_total->add_child_line_item($line_item);
 		//now add the sub-line items
 		$running_total_for_ticket = 0;
-		foreach ( $ticket->prices( array( 'order_by' => array( 'PRC_order' => 'ASC' ) ) ) as $price ) {
+		foreach ($ticket->prices(array('order_by' => array('PRC_order' => 'ASC'))) as $price) {
 			$sign = $price->is_discount() ? -1 : 1;
 			$price_total = $price->is_percent()
 				? $running_total_for_ticket * $price->amount() / 100
 				: $price->amount() * $qty;
-			$sub_line_item = EE_Line_Item::new_instance( array(
+			$sub_line_item = EE_Line_Item::new_instance(array(
 				'LIN_name'       	=> $price->name(),
 				'LIN_desc'       		=> $price->desc(),
 				'LIN_quantity'   	=> $price->is_percent() ? null : $qty,
@@ -298,18 +298,18 @@ 
 				'LIN_type'       		=> EEM_Line_Item::type_sub_line_item,
 				'OBJ_ID'         		=> $price->ID(),
 				'OBJ_type'       	=> 'Price'
-			) );
+			));
 			$sub_line_item = apply_filters(
 				'FHEE__EEH_Line_Item__create_ticket_line_item__sub_line_item',
 				$sub_line_item
 			);
-			if ( $price->is_percent() ) {
-				$sub_line_item->set_percent( $sign * $price->amount() );
+			if ($price->is_percent()) {
+				$sub_line_item->set_percent($sign * $price->amount());
 			} else {
-				$sub_line_item->set_unit_price( $sign * $price->amount() );
+				$sub_line_item->set_unit_price($sign * $price->amount());
 			}
 			$running_total_for_ticket += $price_total;
-			$line_item->add_child_line_item( $sub_line_item );
+			$line_item->add_child_line_item($sub_line_item);
 		}
 		return $line_item;
 	}
@@ -329,11 +329,11 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public static function add_item( EE_Line_Item $total_line_item, EE_Line_Item $item ){
-		$pre_tax_subtotal = self::get_pre_tax_subtotal( $total_line_item );
-		if ( $pre_tax_subtotal instanceof EE_Line_Item ){
+	public static function add_item(EE_Line_Item $total_line_item, EE_Line_Item $item) {
+		$pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item);
+		if ($pre_tax_subtotal instanceof EE_Line_Item) {
 			$success = $pre_tax_subtotal->add_child_line_item($item);
-		}else{
+		} else {
 			return FALSE;
 		}
 		$total_line_item->recalculate_total_including_taxes();
@@ -352,34 +352,34 @@ 
 	 * @return bool success
 	 * @throws \EE_Error
 	 */
-	public static function cancel_ticket_line_item( EE_Line_Item $ticket_line_item, $qty = 1 ) {
+	public static function cancel_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1) {
 		// validate incoming line_item
-		if ( $ticket_line_item->OBJ_type() !== 'Ticket' ) {
+		if ($ticket_line_item->OBJ_type() !== 'Ticket') {
 			throw new EE_Error(
 				sprintf(
-					__( 'The supplied line item must have an Object Type of "Ticket", not %1$s.', 'event_espresso' ),
+					__('The supplied line item must have an Object Type of "Ticket", not %1$s.', 'event_espresso'),
 					$ticket_line_item->type()
 				)
 			);
 		}
-		if ( $ticket_line_item->quantity() < $qty ) {
+		if ($ticket_line_item->quantity() < $qty) {
 			throw new EE_Error(
 				sprintf(
-					__( 'Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.', 'event_espresso' ),
+					__('Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.', 'event_espresso'),
 					$qty,
 					$ticket_line_item->quantity()
 				)
 			);
 		}
 		// decrement ticket quantity; don't rely on auto-fixing when recalculating totals to do this
-		$ticket_line_item->set_quantity( $ticket_line_item->quantity() - $qty );
-		foreach( $ticket_line_item->children() as $child_line_item ) {
-			if(
+		$ticket_line_item->set_quantity($ticket_line_item->quantity() - $qty);
+		foreach ($ticket_line_item->children() as $child_line_item) {
+			if (
 				$child_line_item->is_sub_line_item()
 				&& ! $child_line_item->is_percent()
 				&& ! $child_line_item->is_cancellation()
 			) {
-				$child_line_item->set_quantity( $child_line_item->quantity() - $qty );
+				$child_line_item->set_quantity($child_line_item->quantity() - $qty);
 			}
 		}
 		// get cancellation sub line item
@@ -387,37 +387,37 @@ 
 			$ticket_line_item,
 			EEM_Line_Item::type_cancellation
 		);
-		$cancellation_line_item = reset( $cancellation_line_item );
+		$cancellation_line_item = reset($cancellation_line_item);
 		// verify that this ticket was indeed previously cancelled
-		if ( $cancellation_line_item instanceof EE_Line_Item ) {
+		if ($cancellation_line_item instanceof EE_Line_Item) {
 			// increment cancelled quantity
-			$cancellation_line_item->set_quantity( $cancellation_line_item->quantity() + $qty );
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() + $qty);
 		} else {
 			// create cancellation sub line item
-			$cancellation_line_item = EE_Line_Item::new_instance( array(
-				'LIN_name'       => __( 'Cancellation', 'event_espresso' ),
+			$cancellation_line_item = EE_Line_Item::new_instance(array(
+				'LIN_name'       => __('Cancellation', 'event_espresso'),
 				'LIN_desc'       => sprintf(
-					_x( 'Cancelled %1$s : %2$s', 'Cancelled Ticket Name : 2015-01-01 11:11', 'event_espresso' ),
+					_x('Cancelled %1$s : %2$s', 'Cancelled Ticket Name : 2015-01-01 11:11', 'event_espresso'),
 					$ticket_line_item->name(),
-					current_time( get_option( 'date_format' ) . ' ' . get_option( 'time_format' ) )
+					current_time(get_option('date_format').' '.get_option('time_format'))
 				),
 				'LIN_unit_price' => 0, // $ticket_line_item->unit_price()
 				'LIN_quantity'   => $qty,
 				'LIN_is_taxable' => $ticket_line_item->is_taxable(),
-				'LIN_order'      => count( $ticket_line_item->children() ),
+				'LIN_order'      => count($ticket_line_item->children()),
 				'LIN_total'      => 0, // $ticket_line_item->unit_price()
 				'LIN_type'       => EEM_Line_Item::type_cancellation,
-			) );
-			$ticket_line_item->add_child_line_item( $cancellation_line_item );
+			));
+			$ticket_line_item->add_child_line_item($cancellation_line_item);
 		}
-		if ( $ticket_line_item->save_this_and_descendants() > 0 ) {
+		if ($ticket_line_item->save_this_and_descendants() > 0) {
 			// decrement parent line item quantity
 			$event_line_item = $ticket_line_item->parent();
-			if ( $event_line_item instanceof EE_Line_Item && $event_line_item->OBJ_type() === 'Event' ) {
-				$event_line_item->set_quantity( $event_line_item->quantity() - $qty );
+			if ($event_line_item instanceof EE_Line_Item && $event_line_item->OBJ_type() === 'Event') {
+				$event_line_item->set_quantity($event_line_item->quantity() - $qty);
 				$event_line_item->save();
 			}
-			EEH_Line_Item::get_grand_total_and_recalculate_everything( $ticket_line_item );
+			EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
 			return true;
 		}
 		return false;
@@ -435,12 +435,12 @@ 
 	 * @return bool success
 	 * @throws \EE_Error
 	 */
-	public static function reinstate_canceled_ticket_line_item( EE_Line_Item $ticket_line_item, $qty = 1 ) {
+	public static function reinstate_canceled_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1) {
 		// validate incoming line_item
-		if ( $ticket_line_item->OBJ_type() !== 'Ticket' ) {
+		if ($ticket_line_item->OBJ_type() !== 'Ticket') {
 			throw new EE_Error(
 				sprintf(
-					__( 'The supplied line item must have an Object Type of "Ticket", not %1$s.', 'event_espresso' ),
+					__('The supplied line item must have an Object Type of "Ticket", not %1$s.', 'event_espresso'),
 					$ticket_line_item->type()
 				)
 			);
@@ -450,42 +450,42 @@ 
 			$ticket_line_item,
 			EEM_Line_Item::type_cancellation
 		);
-		$cancellation_line_item = reset( $cancellation_line_item );
+		$cancellation_line_item = reset($cancellation_line_item);
 		// verify that this ticket was indeed previously cancelled
-		if ( ! $cancellation_line_item instanceof EE_Line_Item ) {
+		if ( ! $cancellation_line_item instanceof EE_Line_Item) {
 			return false;
 		}
-		if ( $cancellation_line_item->quantity() > $qty ) {
+		if ($cancellation_line_item->quantity() > $qty) {
 			// decrement cancelled quantity
-			$cancellation_line_item->set_quantity( $cancellation_line_item->quantity() - $qty );
-		} else if ( $cancellation_line_item->quantity() == $qty ) {
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
+		} else if ($cancellation_line_item->quantity() == $qty) {
 			// decrement cancelled quantity in case anyone still has the object kicking around
-			$cancellation_line_item->set_quantity( $cancellation_line_item->quantity() - $qty );
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
 			// delete because quantity will end up as 0
 			$cancellation_line_item->delete();
 			// and attempt to destroy the object,
 			// even though PHP won't actually destroy it until it needs the memory
-			unset( $cancellation_line_item );
+			unset($cancellation_line_item);
 		} else {
 			// what ?!?! negative quantity ?!?!
 			throw new EE_Error(
 				sprintf(
-					__( 'Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.',
-						'event_espresso' ),
+					__('Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.',
+						'event_espresso'),
 					$qty,
 					$cancellation_line_item->quantity()
 				)
 			);
 		}
 		// increment ticket quantity
-		$ticket_line_item->set_quantity( $ticket_line_item->quantity() + $qty );
-		if ( $ticket_line_item->save_this_and_descendants() > 0 ) {
+		$ticket_line_item->set_quantity($ticket_line_item->quantity() + $qty);
+		if ($ticket_line_item->save_this_and_descendants() > 0) {
 			// increment parent line item quantity
 			$event_line_item = $ticket_line_item->parent();
-			if ( $event_line_item instanceof EE_Line_Item && $event_line_item->OBJ_type() === 'Event' ) {
-				$event_line_item->set_quantity( $event_line_item->quantity() + $qty );
+			if ($event_line_item instanceof EE_Line_Item && $event_line_item->OBJ_type() === 'Event') {
+				$event_line_item->set_quantity($event_line_item->quantity() + $qty);
 			}
-			EEH_Line_Item::get_grand_total_and_recalculate_everything( $ticket_line_item );
+			EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
 			return true;
 		}
 		return false;
@@ -500,8 +500,8 @@ 
 	 * @param EE_Line_Item $line_item
 	 * @return \EE_Line_Item
 	 */
-	public static function get_grand_total_and_recalculate_everything( EE_Line_Item $line_item ){
-		$grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item( $line_item );
+	public static function get_grand_total_and_recalculate_everything(EE_Line_Item $line_item) {
+		$grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item);
 		return $grand_total_line_item->recalculate_total_including_taxes();
 	}
 
@@ -514,11 +514,11 @@ 
 	 * @return \EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function get_pre_tax_subtotal( EE_Line_Item $total_line_item ){
-		$pre_tax_subtotal = $total_line_item->get_child_line_item( 'pre-tax-subtotal' );
+	public static function get_pre_tax_subtotal(EE_Line_Item $total_line_item) {
+		$pre_tax_subtotal = $total_line_item->get_child_line_item('pre-tax-subtotal');
 		return $pre_tax_subtotal instanceof EE_Line_Item
 			? $pre_tax_subtotal
-			: self::create_pre_tax_subtotal( $total_line_item );
+			: self::create_pre_tax_subtotal($total_line_item);
 	}
 
 
@@ -530,9 +530,9 @@ 
 	 * @return \EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function get_taxes_subtotal( EE_Line_Item $total_line_item ){
-		$taxes = $total_line_item->get_child_line_item( 'taxes' );
-		return $taxes ? $taxes : self::create_taxes_subtotal( $total_line_item );
+	public static function get_taxes_subtotal(EE_Line_Item $total_line_item) {
+		$taxes = $total_line_item->get_child_line_item('taxes');
+		return $taxes ? $taxes : self::create_taxes_subtotal($total_line_item);
 	}
 
 
@@ -545,12 +545,12 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public static function set_TXN_ID( EE_Line_Item $line_item, $transaction = NULL ){
-		if( $transaction ){
+	public static function set_TXN_ID(EE_Line_Item $line_item, $transaction = NULL) {
+		if ($transaction) {
 			/** @type EEM_Transaction $EEM_Transaction */
-			$EEM_Transaction = EE_Registry::instance()->load_model( 'Transaction' );
-			$TXN_ID = $EEM_Transaction->ensure_is_ID( $transaction );
-			$line_item->set_TXN_ID( $TXN_ID );
+			$EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
+			$TXN_ID = $EEM_Transaction->ensure_is_ID($transaction);
+			$line_item->set_TXN_ID($TXN_ID);
 		}
 	}
 
@@ -565,8 +565,8 @@ 
 	 * @return \EE_Line_Item of type total
 	 * @throws \EE_Error
 	 */
-	public static function create_total_line_item( $transaction = NULL ){
-		$total_line_item = EE_Line_Item::new_instance( array(
+	public static function create_total_line_item($transaction = NULL) {
+		$total_line_item = EE_Line_Item::new_instance(array(
 			'LIN_code'	=> 'total',
 			'LIN_name'	=> __('Grand Total', 'event_espresso'),
 			'LIN_type'	=> EEM_Line_Item::type_total,
@@ -576,9 +576,9 @@ 
 			'FHEE__EEH_Line_Item__create_total_line_item__total_line_item',
 			$total_line_item
 		);
-		self::set_TXN_ID( $total_line_item, $transaction );
-		self::create_pre_tax_subtotal( $total_line_item, $transaction );
-		self::create_taxes_subtotal( $total_line_item, $transaction );
+		self::set_TXN_ID($total_line_item, $transaction);
+		self::create_pre_tax_subtotal($total_line_item, $transaction);
+		self::create_taxes_subtotal($total_line_item, $transaction);
 		return $total_line_item;
 	}
 
@@ -592,19 +592,19 @@ 
 	 * @return EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	protected static function create_pre_tax_subtotal( EE_Line_Item $total_line_item, $transaction = NULL ){
-		$pre_tax_line_item = EE_Line_Item::new_instance( array(
+	protected static function create_pre_tax_subtotal(EE_Line_Item $total_line_item, $transaction = NULL) {
+		$pre_tax_line_item = EE_Line_Item::new_instance(array(
 			'LIN_code' 	=> 'pre-tax-subtotal',
-			'LIN_name' 	=> __( 'Pre-Tax Subtotal', 'event_espresso' ),
+			'LIN_name' 	=> __('Pre-Tax Subtotal', 'event_espresso'),
 			'LIN_type' 	=> EEM_Line_Item::type_sub_total
-		) );
+		));
 		$pre_tax_line_item = apply_filters(
 			'FHEE__EEH_Line_Item__create_pre_tax_subtotal__pre_tax_line_item',
 			$pre_tax_line_item
 		);
-		self::set_TXN_ID( $pre_tax_line_item, $transaction );
-		$total_line_item->add_child_line_item( $pre_tax_line_item );
-		self::create_event_subtotal( $pre_tax_line_item, $transaction );
+		self::set_TXN_ID($pre_tax_line_item, $transaction);
+		$total_line_item->add_child_line_item($pre_tax_line_item);
+		self::create_event_subtotal($pre_tax_line_item, $transaction);
 		return $pre_tax_line_item;
 	}
 
@@ -619,21 +619,21 @@ 
 	 * @return EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	protected static function create_taxes_subtotal( EE_Line_Item $total_line_item, $transaction = NULL ){
+	protected static function create_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = NULL) {
 		$tax_line_item = EE_Line_Item::new_instance(array(
 			'LIN_code'	=> 'taxes',
 			'LIN_name' 	=> __('Taxes', 'event_espresso'),
 			'LIN_type'	=> EEM_Line_Item::type_tax_sub_total,
-			'LIN_order' => 1000,//this should always come last
+			'LIN_order' => 1000, //this should always come last
 		));
 		$tax_line_item = apply_filters(
 			'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item',
 			$tax_line_item
 		);
-		self::set_TXN_ID( $tax_line_item, $transaction );
-		$total_line_item->add_child_line_item( $tax_line_item );
+		self::set_TXN_ID($tax_line_item, $transaction);
+		$total_line_item->add_child_line_item($tax_line_item);
 		//and lastly, add the actual taxes
-		self::apply_taxes( $total_line_item );
+		self::apply_taxes($total_line_item);
 		return $tax_line_item;
 	}
 
@@ -648,11 +648,11 @@ 
 	 * @return EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function create_event_subtotal( EE_Line_Item $pre_tax_line_item, $transaction = NULL, $event = NULL ){
+	public static function create_event_subtotal(EE_Line_Item $pre_tax_line_item, $transaction = NULL, $event = NULL) {
 		$event_line_item = EE_Line_Item::new_instance(array(
-			'LIN_code'	=> self::get_event_code( $event ),
-			'LIN_name' 	=> self::get_event_name( $event ),
-			'LIN_desc' 	=> self::get_event_desc( $event ),
+			'LIN_code'	=> self::get_event_code($event),
+			'LIN_name' 	=> self::get_event_name($event),
+			'LIN_desc' 	=> self::get_event_desc($event),
 			'LIN_type'	=> EEM_Line_Item::type_sub_total,
 			'OBJ_type' 	=> 'Event',
 			'OBJ_ID' 		=>  $event instanceof EE_Event ? $event->ID() : 0
@@ -661,8 +661,8 @@ 
 			'FHEE__EEH_Line_Item__create_event_subtotal__event_line_item',
 			$event_line_item
 		);
-		self::set_TXN_ID( $event_line_item, $transaction );
-		$pre_tax_line_item->add_child_line_item( $event_line_item );
+		self::set_TXN_ID($event_line_item, $transaction);
+		$pre_tax_line_item->add_child_line_item($event_line_item);
 		return $event_line_item;
 	}
 
@@ -675,8 +675,8 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public static function get_event_code( $event ) {
-		return 'event-' . ( $event instanceof EE_Event ? $event->ID() : '0' );
+	public static function get_event_code($event) {
+		return 'event-'.($event instanceof EE_Event ? $event->ID() : '0');
 	}
 
 	/**
@@ -684,8 +684,8 @@ 
 	 * @param EE_Event $event
 	 * @return string
 	 */
-	public static function get_event_name( $event ) {
-		return $event instanceof EE_Event ? $event->name() : __( 'Event', 'event_espresso' );
+	public static function get_event_name($event) {
+		return $event instanceof EE_Event ? $event->name() : __('Event', 'event_espresso');
 	}
 
 	/**
@@ -693,7 +693,7 @@ 
 	 * @param EE_Event $event
 	 * @return string
 	 */
-	public static function get_event_desc( $event ) {
+	public static function get_event_desc($event) {
 		return $event instanceof EE_Event ? $event->short_description() : '';
 	}
 
@@ -707,27 +707,27 @@ 
 	  * @throws \EE_Error
 	  * @return EE_Line_Item
 	  */
-	public static function get_event_line_item_for_ticket( EE_Line_Item $grand_total, EE_Ticket $ticket ) {
+	public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket) {
 		$first_datetime = $ticket->first_datetime();
-		if ( ! $first_datetime instanceof EE_Datetime ) {
+		if ( ! $first_datetime instanceof EE_Datetime) {
 			throw new EE_Error(
-				sprintf( __( 'The supplied ticket (ID %d) has no datetimes', 'event_espresso' ), $ticket->ID() )
+				sprintf(__('The supplied ticket (ID %d) has no datetimes', 'event_espresso'), $ticket->ID())
 			);
 		}
 		$event = $first_datetime->event();
-		if ( ! $event instanceof EE_Event ) {
+		if ( ! $event instanceof EE_Event) {
 			throw new EE_Error(
 				sprintf(
-					__( 'The supplied ticket (ID %d) has no event data associated with it.', 'event_espresso' ),
+					__('The supplied ticket (ID %d) has no event data associated with it.', 'event_espresso'),
 					$ticket->ID()
 				)
 			);
 		}
-		$events_sub_total = EEH_Line_Item::get_event_line_item( $grand_total, $event );
-		if ( ! $events_sub_total instanceof EE_Line_Item ) {
+		$events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event);
+		if ( ! $events_sub_total instanceof EE_Line_Item) {
 			throw new EE_Error(
 				sprintf(
-					__( 'There is no events sub-total for ticket %s on total line item %d', 'event_espresso' ),
+					__('There is no events sub-total for ticket %s on total line item %d', 'event_espresso'),
 					$ticket->ID(),
 					$grand_total->ID()
 				)
@@ -746,31 +746,31 @@ 
 	 * @return EE_Line_Item for the event subtotal which is a child of $grand_total
 	 * @throws \EE_Error
 	 */
-	public static function get_event_line_item( EE_Line_Item $grand_total, $event ) {
+	public static function get_event_line_item(EE_Line_Item $grand_total, $event) {
 		/** @type EE_Event $event */
-		$event = EEM_Event::instance()->ensure_is_obj( $event, true );
+		$event = EEM_Event::instance()->ensure_is_obj($event, true);
 		$event_line_item = NULL;
 		$found = false;
-		foreach ( EEH_Line_Item::get_event_subtotals( $grand_total ) as $event_line_item ) {
+		foreach (EEH_Line_Item::get_event_subtotals($grand_total) as $event_line_item) {
 			// default event subtotal, we should only ever find this the first time this method is called
-			if ( ! $event_line_item->OBJ_ID() ) {
+			if ( ! $event_line_item->OBJ_ID()) {
 				// let's use this! but first... set the event details
-				EEH_Line_Item::set_event_subtotal_details( $event_line_item, $event );
+				EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
 				$found = true;
 				break;
-			} else if ( $event_line_item->OBJ_ID() === $event->ID() ) {
+			} else if ($event_line_item->OBJ_ID() === $event->ID()) {
 				// found existing line item for this event in the cart, so break out of loop and use this one
 				$found = true;
 				break;
 			}
 		}
-		if ( ! $found ) {
+		if ( ! $found) {
 			//there is no event sub-total yet, so add it
-			$pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal( $grand_total );
+			$pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal($grand_total);
 			// create a new "event" subtotal below that
-			$event_line_item = EEH_Line_Item::create_event_subtotal( $pre_tax_subtotal, null, $event );
+			$event_line_item = EEH_Line_Item::create_event_subtotal($pre_tax_subtotal, null, $event);
 			// and set the event details
-			EEH_Line_Item::set_event_subtotal_details( $event_line_item, $event );
+			EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
 		}
 		return $event_line_item;
 	}
@@ -791,13 +791,13 @@ 
 		EE_Event $event,
 		$transaction = null
 	) {
-		if ( $event instanceof EE_Event ) {
-			$event_line_item->set_code( self::get_event_code( $event ) );
-			$event_line_item->set_name( self::get_event_name( $event ) );
-			$event_line_item->set_desc( self::get_event_desc( $event ) );
-			$event_line_item->set_OBJ_ID( $event->ID() );
+		if ($event instanceof EE_Event) {
+			$event_line_item->set_code(self::get_event_code($event));
+			$event_line_item->set_name(self::get_event_name($event));
+			$event_line_item->set_desc(self::get_event_desc($event));
+			$event_line_item->set_OBJ_ID($event->ID());
 		}
-		self::set_TXN_ID( $event_line_item, $transaction );
+		self::set_TXN_ID($event_line_item, $transaction);
 	}
 
 
@@ -810,19 +810,19 @@ 
 	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
 	 * @throws \EE_Error
 	 */
-	public static function apply_taxes( EE_Line_Item $total_line_item ){
+	public static function apply_taxes(EE_Line_Item $total_line_item) {
 		/** @type EEM_Price $EEM_Price */
-		$EEM_Price = EE_Registry::instance()->load_model( 'Price' );
+		$EEM_Price = EE_Registry::instance()->load_model('Price');
 		// get array of taxes via Price Model
 		$ordered_taxes = $EEM_Price->get_all_prices_that_are_taxes();
-		ksort( $ordered_taxes );
-		$taxes_line_item = self::get_taxes_subtotal( $total_line_item );
+		ksort($ordered_taxes);
+		$taxes_line_item = self::get_taxes_subtotal($total_line_item);
 		//just to be safe, remove its old tax line items
 		$taxes_line_item->delete_children_line_items();
 		//loop thru taxes
-		foreach ( $ordered_taxes as $order => $taxes ) {
-			foreach ( $taxes as $tax ) {
-				if ( $tax instanceof EE_Price ) {
+		foreach ($ordered_taxes as $order => $taxes) {
+			foreach ($taxes as $tax) {
+				if ($tax instanceof EE_Price) {
 					$tax_line_item = EE_Line_Item::new_instance(
 						array(
 							'LIN_name'       => $tax->name(),
@@ -840,7 +840,7 @@ 
 						'FHEE__EEH_Line_Item__apply_taxes__tax_line_item',
 						$tax_line_item
 					);
-					$taxes_line_item->add_child_line_item( $tax_line_item );
+					$taxes_line_item->add_child_line_item($tax_line_item);
 				}
 			}
 		}
@@ -857,10 +857,10 @@ 
 	 * @return float
 	 * @throws \EE_Error
 	 */
-	public static function ensure_taxes_applied( $total_line_item ){
-		$taxes_subtotal = self::get_taxes_subtotal( $total_line_item );
-		if( ! $taxes_subtotal->children()){
-			self::apply_taxes( $total_line_item );
+	public static function ensure_taxes_applied($total_line_item) {
+		$taxes_subtotal = self::get_taxes_subtotal($total_line_item);
+		if ( ! $taxes_subtotal->children()) {
+			self::apply_taxes($total_line_item);
 		}
 		return $taxes_subtotal->total();
 	}
@@ -874,16 +874,16 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	public static function delete_all_child_items( EE_Line_Item $parent_line_item ) {
+	public static function delete_all_child_items(EE_Line_Item $parent_line_item) {
 		$deleted = 0;
-		foreach ( $parent_line_item->children() as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item ) {
-				$deleted += EEH_Line_Item::delete_all_child_items( $child_line_item );
-				if ( $child_line_item->ID() ) {
+		foreach ($parent_line_item->children() as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$deleted += EEH_Line_Item::delete_all_child_items($child_line_item);
+				if ($child_line_item->ID()) {
 					$child_line_item->delete();
-					unset( $child_line_item );
+					unset($child_line_item);
 				} else {
-					$parent_line_item->delete_child_line_item( $child_line_item->code() );
+					$parent_line_item->delete_child_line_item($child_line_item->code());
 				}
 				$deleted++;
 			}
@@ -905,9 +905,9 @@ 
 	 * @param array|bool|string $line_item_codes
 	 * @return int number of items successfully removed
 	 */
-	public static function delete_items( EE_Line_Item $total_line_item, $line_item_codes = FALSE ) {
+	public static function delete_items(EE_Line_Item $total_line_item, $line_item_codes = FALSE) {
 
-		if( $total_line_item->type() !== EEM_Line_Item::type_total ){
+		if ($total_line_item->type() !== EEM_Line_Item::type_total) {
 			EE_Error::doing_it_wrong(
 				'EEH_Line_Item::delete_items',
 				__(
@@ -917,20 +917,20 @@ 
 				'4.6.18'
 			);
 		}
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 
 		// check if only a single line_item_id was passed
-		if ( ! empty( $line_item_codes ) && ! is_array( $line_item_codes )) {
+		if ( ! empty($line_item_codes) && ! is_array($line_item_codes)) {
 			// place single line_item_id in an array to appear as multiple line_item_ids
-			$line_item_codes = array ( $line_item_codes );
+			$line_item_codes = array($line_item_codes);
 		}
 		$removals = 0;
 		// cycle thru line_item_ids
-		foreach ( $line_item_codes as $line_item_id ) {
+		foreach ($line_item_codes as $line_item_id) {
 			$removals += $total_line_item->delete_child_line_item($line_item_id);
 		}
 
-		if ( $removals > 0 ) {
+		if ($removals > 0) {
 			$total_line_item->recalculate_taxes_and_tax_total();
 			return $removals;
 		} else {
@@ -963,33 +963,33 @@ 
 		$code = null,
 		$add_to_existing_line_item = false
 	) {
-		$tax_subtotal = self::get_taxes_subtotal( $total_line_item );
+		$tax_subtotal = self::get_taxes_subtotal($total_line_item);
             $taxable_total = $total_line_item->taxable_total();
 
-            if( $add_to_existing_line_item ) {
-                $new_tax = $tax_subtotal->get_child_line_item( $code );
+            if ($add_to_existing_line_item) {
+                $new_tax = $tax_subtotal->get_child_line_item($code);
 	            EEM_Line_Item::instance()->delete(
-		            array( array( 'LIN_code' => array( '!=', $code ), 'LIN_parent' => $tax_subtotal->ID() ) )
+		            array(array('LIN_code' => array('!=', $code), 'LIN_parent' => $tax_subtotal->ID()))
 	            );
             } else {
                 $new_tax = null;
                 $tax_subtotal->delete_children_line_items();
             }
-            if( $new_tax ) {
-                $new_tax->set_total( $new_tax->total() + $amount );
-                $new_tax->set_percent( $taxable_total ? $new_tax->total() / $taxable_total * 100 : 0 );
+            if ($new_tax) {
+                $new_tax->set_total($new_tax->total() + $amount);
+                $new_tax->set_percent($taxable_total ? $new_tax->total() / $taxable_total * 100 : 0);
             } else {
                 //no existing tax item. Create it
-				$new_tax = EE_Line_Item::new_instance( array(
+				$new_tax = EE_Line_Item::new_instance(array(
 					'TXN_ID'      => $total_line_item->TXN_ID(),
-					'LIN_name'    => $name ? $name : __( 'Tax', 'event_espresso' ),
+					'LIN_name'    => $name ? $name : __('Tax', 'event_espresso'),
 					'LIN_desc'    => $description ? $description : '',
-					'LIN_percent' => $taxable_total ? ( $amount / $taxable_total * 100 ) : 0,
+					'LIN_percent' => $taxable_total ? ($amount / $taxable_total * 100) : 0,
 					'LIN_total'   => $amount,
 					'LIN_parent'  => $tax_subtotal->ID(),
 					'LIN_type'    => EEM_Line_Item::type_tax,
 					'LIN_code'    => $code
-				) );
+				));
 			}
 
             $new_tax = apply_filters(
@@ -998,7 +998,7 @@ 
 				$total_line_item
             );
             $new_tax->save();
-            $tax_subtotal->set_total( $new_tax->total() );
+            $tax_subtotal->set_total($new_tax->total());
             $tax_subtotal->save();
             $total_line_item->recalculate_total_including_taxes();
             return $new_tax;
@@ -1020,14 +1020,14 @@ 
 		$code_substring_for_whitelist = null
 	) {
 		$whitelisted = false;
-		if( $code_substring_for_whitelist !== null ) {
-			$whitelisted = strpos( $line_item->code(), $code_substring_for_whitelist ) !== false ? true : false;
+		if ($code_substring_for_whitelist !== null) {
+			$whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false ? true : false;
 		}
-		if( ! $whitelisted && $line_item->is_line_item() ) {
-			$line_item->set_is_taxable( $taxable );
+		if ( ! $whitelisted && $line_item->is_line_item()) {
+			$line_item->set_is_taxable($taxable);
 		}
-		foreach( $line_item->children() as $child_line_item ) {
-			EEH_Line_Item::set_line_items_taxable( $child_line_item, $taxable, $code_substring_for_whitelist );
+		foreach ($line_item->children() as $child_line_item) {
+			EEH_Line_Item::set_line_items_taxable($child_line_item, $taxable, $code_substring_for_whitelist);
 		}
 	}
 
@@ -1040,8 +1040,8 @@ 
 	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
 	 * @return EE_Line_Item[]
 	 */
-	public static function get_event_subtotals( EE_Line_Item $parent_line_item ) {
-		return self::get_subtotals_of_object_type( $parent_line_item, 'Event' );
+	public static function get_event_subtotals(EE_Line_Item $parent_line_item) {
+		return self::get_subtotals_of_object_type($parent_line_item, 'Event');
 	}
 
 
@@ -1054,7 +1054,7 @@ 
 	 * @param string $obj_type
 	 * @return EE_Line_Item[]
 	 */
-	public static function get_subtotals_of_object_type( EE_Line_Item $parent_line_item, $obj_type = '' ) {
+	public static function get_subtotals_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '') {
 		return self::_get_descendants_by_type_and_object_type(
 			$parent_line_item,
 			EEM_Line_Item::type_sub_total,
@@ -1071,8 +1071,8 @@ 
 	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
 	 * @return EE_Line_Item[]
 	 */
-	public static function get_ticket_line_items( EE_Line_Item $parent_line_item ) {
-		return self::get_line_items_of_object_type( $parent_line_item, 'Ticket' );
+	public static function get_ticket_line_items(EE_Line_Item $parent_line_item) {
+		return self::get_line_items_of_object_type($parent_line_item, 'Ticket');
 	}
 
 
@@ -1085,8 +1085,8 @@ 
 	 * @param string $obj_type
 	 * @return EE_Line_Item[]
 	 */
-	public static function get_line_items_of_object_type( EE_Line_Item $parent_line_item, $obj_type = '' ) {
-		return self::_get_descendants_by_type_and_object_type( $parent_line_item, EEM_Line_Item::type_line_item, $obj_type );
+	public static function get_line_items_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '') {
+		return self::_get_descendants_by_type_and_object_type($parent_line_item, EEM_Line_Item::type_line_item, $obj_type);
 	}
 
 
@@ -1097,8 +1097,8 @@ 
 	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
 	 * @return EE_Line_Item[]
 	 */
-	public static function get_tax_descendants( EE_Line_Item $parent_line_item ) {
-		return EEH_Line_Item::get_descendants_of_type( $parent_line_item, EEM_Line_Item::type_tax );
+	public static function get_tax_descendants(EE_Line_Item $parent_line_item) {
+		return EEH_Line_Item::get_descendants_of_type($parent_line_item, EEM_Line_Item::type_tax);
 	}
 
 
@@ -1109,8 +1109,8 @@ 
 	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
 	 * @return EE_Line_Item[]
 	 */
-	public static function get_line_item_descendants( EE_Line_Item $parent_line_item ) {
-		return EEH_Line_Item::get_descendants_of_type( $parent_line_item, EEM_Line_Item::type_line_item );
+	public static function get_line_item_descendants(EE_Line_Item $parent_line_item) {
+		return EEH_Line_Item::get_descendants_of_type($parent_line_item, EEM_Line_Item::type_line_item);
 	}
 
 
@@ -1123,8 +1123,8 @@ 
 	 * @param string $line_item_type one of the EEM_Line_Item constants
 	 * @return EE_Line_Item[]
 	 */
-	public static function get_descendants_of_type( EE_Line_Item $parent_line_item, $line_item_type ) {
-		return self::_get_descendants_by_type_and_object_type( $parent_line_item, $line_item_type, NULL );
+	public static function get_descendants_of_type(EE_Line_Item $parent_line_item, $line_item_type) {
+		return self::_get_descendants_by_type_and_object_type($parent_line_item, $line_item_type, NULL);
 	}
 
 
@@ -1143,8 +1143,8 @@ 
 		$obj_type = null
 	) {
 		$objects = array();
-		foreach ( $parent_line_item->children() as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item ) {
+		foreach ($parent_line_item->children() as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
 				if (
 					$child_line_item->type() === $line_item_type
 				    && (
@@ -1184,7 +1184,7 @@ 
 		$OBJ_type = '',
 		$OBJ_IDs = array()
 	) {
-		return self::_get_descendants_by_object_type_and_object_ID( $parent_line_item, $OBJ_type, $OBJ_IDs );
+		return self::_get_descendants_by_object_type_and_object_ID($parent_line_item, $OBJ_type, $OBJ_IDs);
 	}
 
 
@@ -1203,12 +1203,12 @@ 
 		$OBJ_IDs
 	) {
 		$objects = array();
-		foreach ( $parent_line_item->children() as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item ) {
+		foreach ($parent_line_item->children() as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
 				if (
 					$child_line_item->OBJ_type() === $OBJ_type
-					&& is_array( $OBJ_IDs )
-					&& in_array( $child_line_item->OBJ_ID(), $OBJ_IDs )
+					&& is_array($OBJ_IDs)
+					&& in_array($child_line_item->OBJ_ID(), $OBJ_IDs)
 				) {
 					$objects[] = $child_line_item;
 				} else {
@@ -1238,8 +1238,8 @@ 
 	 * @param string $type like one of the EEM_Line_Item::type_*
 	 * @return EE_Line_Item
 	 */
-	public static function get_nearest_descendant_of_type( EE_Line_Item $parent_line_item, $type ) {
-		return self::_get_nearest_descendant( $parent_line_item, 'LIN_type' , $type );
+	public static function get_nearest_descendant_of_type(EE_Line_Item $parent_line_item, $type) {
+		return self::_get_nearest_descendant($parent_line_item, 'LIN_type', $type);
 	}
 
 
@@ -1253,8 +1253,8 @@ 
 	 * @param string $code any value used for LIN_code
 	 * @return EE_Line_Item
 	 */
-	public static function get_nearest_descendant_having_code( EE_Line_Item $parent_line_item, $code ) {
-		return self::_get_nearest_descendant( $parent_line_item, 'LIN_code' , $code );
+	public static function get_nearest_descendant_having_code(EE_Line_Item $parent_line_item, $code) {
+		return self::_get_nearest_descendant($parent_line_item, 'LIN_code', $code);
 	}
 
 
@@ -1268,15 +1268,15 @@ 
 	 * @param string $value any value stored in $search_field
 	 * @return EE_Line_Item
 	 */
-	protected static function _get_nearest_descendant( EE_Line_Item $parent_line_item, $search_field, $value ) {
-		foreach( $parent_line_item->children() as $child ){
-			if ( $child->get( $search_field ) == $value ){
+	protected static function _get_nearest_descendant(EE_Line_Item $parent_line_item, $search_field, $value) {
+		foreach ($parent_line_item->children() as $child) {
+			if ($child->get($search_field) == $value) {
 				return $child;
 			}
 		}
-		foreach( $parent_line_item->children() as $child ){
-			$descendant_found = self::_get_nearest_descendant( $child, $search_field, $value );
-			if ( $descendant_found ){
+		foreach ($parent_line_item->children() as $child) {
+			$descendant_found = self::_get_nearest_descendant($child, $search_field, $value);
+			if ($descendant_found) {
 				return $descendant_found;
 			}
 		}
@@ -1293,24 +1293,24 @@ 
 	 * @return \EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function find_transaction_grand_total_for_line_item( EE_Line_Item $line_item ){
-		if ( $line_item->TXN_ID() ) {
-			$total_line_item = $line_item->transaction()->total_line_item( false );
-			if ( $total_line_item instanceof EE_Line_Item ) {
+	public static function find_transaction_grand_total_for_line_item(EE_Line_Item $line_item) {
+		if ($line_item->TXN_ID()) {
+			$total_line_item = $line_item->transaction()->total_line_item(false);
+			if ($total_line_item instanceof EE_Line_Item) {
 				return $total_line_item;
 			}
 		} else {
 			$line_item_parent = $line_item->parent();
-			if ( $line_item_parent instanceof EE_Line_Item ) {
-				if ( $line_item_parent->is_total() ) {
+			if ($line_item_parent instanceof EE_Line_Item) {
+				if ($line_item_parent->is_total()) {
 					return $line_item_parent;
 				}
-				return EEH_Line_Item::find_transaction_grand_total_for_line_item( $line_item_parent );
+				return EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item_parent);
 			}
 		}
 		throw new EE_Error(
 			sprintf(
-				__( 'A valid grand total for line item %1$d was not found.', 'event_espresso' ),
+				__('A valid grand total for line item %1$d was not found.', 'event_espresso'),
 				$line_item->ID()
 			)
 		);
@@ -1327,31 +1327,31 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public static function visualize( EE_Line_Item $line_item, $indentation = 0 ){
+	public static function visualize(EE_Line_Item $line_item, $indentation = 0) {
 		echo defined('EE_TESTS_DIR') ? "\n" : '<br />';
-		if ( ! $indentation ) {
-			echo defined( 'EE_TESTS_DIR' ) ? "\n" : '<br />';
+		if ( ! $indentation) {
+			echo defined('EE_TESTS_DIR') ? "\n" : '<br />';
 		}
-		for( $i = 0; $i < $indentation; $i++ ){
+		for ($i = 0; $i < $indentation; $i++) {
 			echo ". ";
 		}
 		$breakdown = '';
-		if ( $line_item->is_line_item()){
-			if ( $line_item->is_percent() ) {
+		if ($line_item->is_line_item()) {
+			if ($line_item->is_percent()) {
 				$breakdown = "{$line_item->percent()}%";
 			} else {
-				$breakdown = '$' . "{$line_item->unit_price()} x {$line_item->quantity()}";
+				$breakdown = '$'."{$line_item->unit_price()} x {$line_item->quantity()}";
 			}
 		}
-		echo $line_item->name() . " [ ID:{$line_item->ID()} | qty:{$line_item->quantity()} ] {$line_item->type()} : " . '$' . "{$line_item->total()}";
-		if ( $breakdown ) {
+		echo $line_item->name()." [ ID:{$line_item->ID()} | qty:{$line_item->quantity()} ] {$line_item->type()} : ".'$'."{$line_item->total()}";
+		if ($breakdown) {
 			echo " ( {$breakdown} )";
 		}
-		if( $line_item->is_taxable() ){
+		if ($line_item->is_taxable()) {
 			echo "  * taxable";
 		}
-		if( $line_item->children() ){
-			foreach($line_item->children() as $child){
+		if ($line_item->children()) {
+			foreach ($line_item->children() as $child) {
 				self::visualize($child, $indentation + 1);
 			}
 		}
@@ -1392,97 +1392,97 @@ 
 	 *                                          is theirs, which can be done with
 	 *                                          `EEM_Line_Item::instance()->get_line_item_for_registration( $registration );`
 	 */
-	public static function calculate_reg_final_prices_per_line_item( EE_Line_Item $line_item, $billable_ticket_quantities = array() ) {
+	public static function calculate_reg_final_prices_per_line_item(EE_Line_Item $line_item, $billable_ticket_quantities = array()) {
 		//init running grand total if not already
-		if ( ! isset( $running_totals[ 'total' ] ) ) {
-			$running_totals[ 'total' ] = 0;
+		if ( ! isset($running_totals['total'])) {
+			$running_totals['total'] = 0;
 		}
-		if( ! isset( $running_totals[ 'taxable' ] ) ) {
-			$running_totals[ 'taxable' ] = array( 'total' => 0 );
+		if ( ! isset($running_totals['taxable'])) {
+			$running_totals['taxable'] = array('total' => 0);
 		}
-		foreach ( $line_item->children() as $child_line_item ) {
-			switch ( $child_line_item->type() ) {
+		foreach ($line_item->children() as $child_line_item) {
+			switch ($child_line_item->type()) {
 
 				case EEM_Line_Item::type_sub_total :
-					$running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item( $child_line_item, $billable_ticket_quantities );
+					$running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item($child_line_item, $billable_ticket_quantities);
 					//combine arrays but preserve numeric keys
-					$running_totals = array_replace_recursive( $running_totals_from_subtotal, $running_totals );
-					$running_totals[ 'total' ] += $running_totals_from_subtotal[ 'total' ];
-					$running_totals[ 'taxable'][ 'total' ] += $running_totals_from_subtotal[ 'taxable' ][ 'total' ];
+					$running_totals = array_replace_recursive($running_totals_from_subtotal, $running_totals);
+					$running_totals['total'] += $running_totals_from_subtotal['total'];
+					$running_totals['taxable']['total'] += $running_totals_from_subtotal['taxable']['total'];
 					break;
 
 				case EEM_Line_Item::type_tax_sub_total :
 
 					//find how much the taxes percentage is
-					if ( $child_line_item->percent() !== 0 ) {
+					if ($child_line_item->percent() !== 0) {
 						$tax_percent_decimal = $child_line_item->percent() / 100;
 					} else {
 						$tax_percent_decimal = EE_Taxes::get_total_taxes_percentage() / 100;
 					}
 					//and apply to all the taxable totals, and add to the pretax totals
-					foreach ( $running_totals as $line_item_id => $this_running_total ) {
+					foreach ($running_totals as $line_item_id => $this_running_total) {
 						//"total" and "taxable" array key is an exception
-						if ( $line_item_id === 'taxable' ) {
+						if ($line_item_id === 'taxable') {
 							continue;
 						}
-						$taxable_total = $running_totals[ 'taxable' ][ $line_item_id ];
-						$running_totals[ $line_item_id ] += ( $taxable_total * $tax_percent_decimal );
+						$taxable_total = $running_totals['taxable'][$line_item_id];
+						$running_totals[$line_item_id] += ($taxable_total * $tax_percent_decimal);
 					}
 					break;
 
 				case EEM_Line_Item::type_line_item :
 
 					// ticket line items or ????
-					if ( $child_line_item->OBJ_type() === 'Ticket' ) {
+					if ($child_line_item->OBJ_type() === 'Ticket') {
 						// kk it's a ticket
-						if ( isset( $running_totals[ $child_line_item->ID() ] ) ) {
+						if (isset($running_totals[$child_line_item->ID()])) {
 							//huh? that shouldn't happen.
-							$running_totals[ 'total' ] += $child_line_item->total();
+							$running_totals['total'] += $child_line_item->total();
 						} else {
 							//its not in our running totals yet. great.
-							if ( $child_line_item->is_taxable() ) {
+							if ($child_line_item->is_taxable()) {
 								$taxable_amount = $child_line_item->unit_price();
 							} else {
 								$taxable_amount = 0;
 							}
 							// are we only calculating totals for some tickets?
-							if ( isset( $billable_ticket_quantities[ $child_line_item->OBJ_ID() ] ) ) {
-								$quantity = $billable_ticket_quantities[ $child_line_item->OBJ_ID() ];
-								$running_totals[ $child_line_item->ID() ] = $quantity
+							if (isset($billable_ticket_quantities[$child_line_item->OBJ_ID()])) {
+								$quantity = $billable_ticket_quantities[$child_line_item->OBJ_ID()];
+								$running_totals[$child_line_item->ID()] = $quantity
 									? $child_line_item->unit_price()
 									: 0;
-								$running_totals[ 'taxable' ][ $child_line_item->ID() ] = $quantity
+								$running_totals['taxable'][$child_line_item->ID()] = $quantity
 									? $taxable_amount
 									: 0;
 							} else {
 								$quantity = $child_line_item->quantity();
-								$running_totals[ $child_line_item->ID() ] = $child_line_item->unit_price();
-								$running_totals[ 'taxable' ][ $child_line_item->ID() ] = $taxable_amount;
+								$running_totals[$child_line_item->ID()] = $child_line_item->unit_price();
+								$running_totals['taxable'][$child_line_item->ID()] = $taxable_amount;
 							}
-							$running_totals[ 'taxable' ][ 'total' ] += $taxable_amount * $quantity;
-							$running_totals[ 'total' ] += $child_line_item->unit_price() * $quantity;
+							$running_totals['taxable']['total'] += $taxable_amount * $quantity;
+							$running_totals['total'] += $child_line_item->unit_price() * $quantity;
 						}
 					} else {
 						// it's some other type of item added to the cart
 						// it should affect the running totals
 						// basically we want to convert it into a PERCENT modifier. Because
 						// more clearly affect all registration's final price equally
-						$line_items_percent_of_running_total = $running_totals[ 'total' ] > 0
-							? ( $child_line_item->total() / $running_totals[ 'total' ] ) + 1
+						$line_items_percent_of_running_total = $running_totals['total'] > 0
+							? ($child_line_item->total() / $running_totals['total']) + 1
 							: 1;
-						foreach ( $running_totals as $line_item_id => $this_running_total ) {
+						foreach ($running_totals as $line_item_id => $this_running_total) {
 							//the "taxable" array key is an exception
-							if ( $line_item_id === 'taxable' ) {
+							if ($line_item_id === 'taxable') {
 								continue;
 							}
 							// update the running totals
 							// yes this actually even works for the running grand total!
-							$running_totals[ $line_item_id ] =
+							$running_totals[$line_item_id] =
 								$line_items_percent_of_running_total * $this_running_total;
 
-							if ( $child_line_item->is_taxable() ) {
-								$running_totals[ 'taxable' ][ $line_item_id ] =
-									$line_items_percent_of_running_total * $running_totals[ 'taxable' ][ $line_item_id ];
+							if ($child_line_item->is_taxable()) {
+								$running_totals['taxable'][$line_item_id] =
+									$line_items_percent_of_running_total * $running_totals['taxable'][$line_item_id];
 							}
 						}
 					}
@@ -1500,16 +1500,16 @@ 
 	 * @return float | null
 	 * @throws \OutOfRangeException
 	 */
-	public static function calculate_final_price_for_ticket_line_item( \EE_Line_Item $total_line_item, \EE_Line_Item $ticket_line_item ) {
+	public static function calculate_final_price_for_ticket_line_item(\EE_Line_Item $total_line_item, \EE_Line_Item $ticket_line_item) {
 		static $final_prices_per_ticket_line_item = array();
-		if ( empty( $final_prices_per_ticket_line_item ) ) {
+		if (empty($final_prices_per_ticket_line_item)) {
 			$final_prices_per_ticket_line_item = \EEH_Line_Item::calculate_reg_final_prices_per_line_item(
 				$total_line_item
 			);
 		}
 		//ok now find this new registration's final price
-		if ( isset( $final_prices_per_ticket_line_item[ $ticket_line_item->ID() ] ) ) {
-			return $final_prices_per_ticket_line_item[ $ticket_line_item->ID() ];
+		if (isset($final_prices_per_ticket_line_item[$ticket_line_item->ID()])) {
+			return $final_prices_per_ticket_line_item[$ticket_line_item->ID()];
 		}
 		$message = sprintf(
 			__(
@@ -1518,11 +1518,11 @@ 
 			),
 			$ticket_line_item->ID()
 		);
-		if ( WP_DEBUG ) {
-			$message .= '<br>' . print_r( $final_prices_per_ticket_line_item, true );
-			throw new \OutOfRangeException( $message );
+		if (WP_DEBUG) {
+			$message .= '<br>'.print_r($final_prices_per_ticket_line_item, true);
+			throw new \OutOfRangeException($message);
 		} else {
-			EE_Log::instance()->log( __CLASS__, __FUNCTION__, $message );
+			EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message);
 		}
 		return null;
 	}
@@ -1538,15 +1538,15 @@ 
 	 * @return \EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function billable_line_item_tree( EE_Line_Item $line_item, $registrations ) {
-		$copy_li = EEH_Line_Item::billable_line_item( $line_item, $registrations );
-		foreach ( $line_item->children() as $child_li ) {
-			$copy_li->add_child_line_item( EEH_Line_Item::billable_line_item_tree( $child_li, $registrations ) );
+	public static function billable_line_item_tree(EE_Line_Item $line_item, $registrations) {
+		$copy_li = EEH_Line_Item::billable_line_item($line_item, $registrations);
+		foreach ($line_item->children() as $child_li) {
+			$copy_li->add_child_line_item(EEH_Line_Item::billable_line_item_tree($child_li, $registrations));
 		}
 		//if this is the grand total line item, make sure the totals all add up
 		//(we could have duplicated this logic AS we copied the line items, but
 		//it seems DRYer this way)
-		if ( $copy_li->type() === EEM_Line_Item::type_total ) {
+		if ($copy_li->type() === EEM_Line_Item::type_total) {
 			$copy_li->recalculate_total_including_taxes();
 		}
 		return $copy_li;
@@ -1563,24 +1563,24 @@ 
 	 * @throws \EE_Error
 	 * @param EE_Registration[] $registrations
 	 */
-	public static function billable_line_item( EE_Line_Item $line_item, $registrations ) {
+	public static function billable_line_item(EE_Line_Item $line_item, $registrations) {
 		$new_li_fields = $line_item->model_field_array();
-		if ( $line_item->type() === EEM_Line_Item::type_line_item &&
+		if ($line_item->type() === EEM_Line_Item::type_line_item &&
 			$line_item->OBJ_type() === 'Ticket'
 		) {
 			$count = 0;
-			foreach ( $registrations as $registration ) {
-				if ( $line_item->OBJ_ID() === $registration->ticket_ID() &&
-					in_array( $registration->status_ID(), EEM_Registration::reg_statuses_that_allow_payment() )
+			foreach ($registrations as $registration) {
+				if ($line_item->OBJ_ID() === $registration->ticket_ID() &&
+					in_array($registration->status_ID(), EEM_Registration::reg_statuses_that_allow_payment())
 				) {
 					$count++;
 				}
 			}
-			$new_li_fields[ 'LIN_quantity' ] = $count;
+			$new_li_fields['LIN_quantity'] = $count;
 		}
 		//don't set the total. We'll leave that up to the code that calculates it
-		unset( $new_li_fields[ 'LIN_ID' ], $new_li_fields[ 'LIN_parent' ], $new_li_fields[ 'LIN_total' ] );
-		return EE_Line_Item::new_instance( $new_li_fields );
+		unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent'], $new_li_fields['LIN_total']);
+		return EE_Line_Item::new_instance($new_li_fields);
 	}
 
 
@@ -1593,19 +1593,19 @@ 
 	 * @return \EE_Line_Item|null
 	 * @throws \EE_Error
 	 */
-	public static function non_empty_line_items( EE_Line_Item $line_item ) {
-		$copied_li = EEH_Line_Item::non_empty_line_item( $line_item );
-		if ( $copied_li === null ) {
+	public static function non_empty_line_items(EE_Line_Item $line_item) {
+		$copied_li = EEH_Line_Item::non_empty_line_item($line_item);
+		if ($copied_li === null) {
 			return null;
 		}
 		//if this is an event subtotal, we want to only include it if it
 		//has a non-zero total and at least one ticket line item child
 		$ticket_children = 0;
-		foreach ( $line_item->children() as $child_li ) {
-			$child_li_copy = EEH_Line_Item::non_empty_line_items( $child_li );
-			if ( $child_li_copy !== null ) {
-				$copied_li->add_child_line_item( $child_li_copy );
-				if ( $child_li_copy->type() === EEM_Line_Item::type_line_item &&
+		foreach ($line_item->children() as $child_li) {
+			$child_li_copy = EEH_Line_Item::non_empty_line_items($child_li);
+			if ($child_li_copy !== null) {
+				$copied_li->add_child_line_item($child_li_copy);
+				if ($child_li_copy->type() === EEM_Line_Item::type_line_item &&
 					$child_li_copy->OBJ_type() === 'Ticket'
 				) {
 					$ticket_children++;
@@ -1635,8 +1635,8 @@ 
 	 * @return EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function non_empty_line_item( EE_Line_Item $line_item ) {
-		if ( $line_item->type() === EEM_Line_Item::type_line_item &&
+	public static function non_empty_line_item(EE_Line_Item $line_item) {
+		if ($line_item->type() === EEM_Line_Item::type_line_item &&
 			$line_item->OBJ_type() === 'Ticket' &&
 			$line_item->quantity() === 0
 		) {
@@ -1644,8 +1644,8 @@ 
 		}
 		$new_li_fields = $line_item->model_field_array();
 		//don't set the total. We'll leave that up to the code that calculates it
-		unset( $new_li_fields[ 'LIN_ID' ], $new_li_fields[ 'LIN_parent' ] );
-		return EE_Line_Item::new_instance( $new_li_fields );
+		unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent']);
+		return EE_Line_Item::new_instance($new_li_fields);
 	}
 
 
@@ -1657,9 +1657,9 @@ 
 	 * @return \EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function get_items_subtotal( EE_Line_Item $total_line_item ){
-		EE_Error::doing_it_wrong( 'EEH_Line_Item::get_items_subtotal()', __('Method replaced with EEH_Line_Item::get_pre_tax_subtotal()', 'event_espresso'), '4.6.0' );
-		return self::get_pre_tax_subtotal( $total_line_item );
+	public static function get_items_subtotal(EE_Line_Item $total_line_item) {
+		EE_Error::doing_it_wrong('EEH_Line_Item::get_items_subtotal()', __('Method replaced with EEH_Line_Item::get_pre_tax_subtotal()', 'event_espresso'), '4.6.0');
+		return self::get_pre_tax_subtotal($total_line_item);
 	}
 
 
@@ -1670,9 +1670,9 @@ 
 	 * @return \EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function create_default_total_line_item( $transaction = NULL) {
-		EE_Error::doing_it_wrong( 'EEH_Line_Item::create_default_total_line_item()', __('Method replaced with EEH_Line_Item::create_total_line_item()', 'event_espresso'), '4.6.0' );
-		return self::create_total_line_item( $transaction );
+	public static function create_default_total_line_item($transaction = NULL) {
+		EE_Error::doing_it_wrong('EEH_Line_Item::create_default_total_line_item()', __('Method replaced with EEH_Line_Item::create_total_line_item()', 'event_espresso'), '4.6.0');
+		return self::create_total_line_item($transaction);
 	}
 
 
@@ -1684,9 +1684,9 @@ 
 	 * @return \EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function create_default_tickets_subtotal( EE_Line_Item $total_line_item, $transaction = NULL) {
-		EE_Error::doing_it_wrong( 'EEH_Line_Item::create_default_tickets_subtotal()', __('Method replaced with EEH_Line_Item::create_pre_tax_subtotal()', 'event_espresso'), '4.6.0' );
-		return self::create_pre_tax_subtotal( $total_line_item, $transaction );
+	public static function create_default_tickets_subtotal(EE_Line_Item $total_line_item, $transaction = NULL) {
+		EE_Error::doing_it_wrong('EEH_Line_Item::create_default_tickets_subtotal()', __('Method replaced with EEH_Line_Item::create_pre_tax_subtotal()', 'event_espresso'), '4.6.0');
+		return self::create_pre_tax_subtotal($total_line_item, $transaction);
 	}
 
 
@@ -1698,9 +1698,9 @@ 
 	 * @return \EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function create_default_taxes_subtotal( EE_Line_Item $total_line_item, $transaction = NULL) {
-		EE_Error::doing_it_wrong( 'EEH_Line_Item::create_default_taxes_subtotal()', __('Method replaced with EEH_Line_Item::create_taxes_subtotal()', 'event_espresso'), '4.6.0' );
-		return self::create_taxes_subtotal( $total_line_item, $transaction );
+	public static function create_default_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = NULL) {
+		EE_Error::doing_it_wrong('EEH_Line_Item::create_default_taxes_subtotal()', __('Method replaced with EEH_Line_Item::create_taxes_subtotal()', 'event_espresso'), '4.6.0');
+		return self::create_taxes_subtotal($total_line_item, $transaction);
 	}
 
 
@@ -1712,9 +1712,9 @@ 
 	 * @return \EE_Line_Item
 	 * @throws \EE_Error
 	 */
-	public static function create_default_event_subtotal( EE_Line_Item $total_line_item, $transaction = NULL) {
-		EE_Error::doing_it_wrong( 'EEH_Line_Item::create_default_event_subtotal()', __('Method replaced with EEH_Line_Item::create_event_subtotal()', 'event_espresso'), '4.6.0' );
-		return self::create_event_subtotal( $total_line_item, $transaction );
+	public static function create_default_event_subtotal(EE_Line_Item $total_line_item, $transaction = NULL) {
+		EE_Error::doing_it_wrong('EEH_Line_Item::create_default_event_subtotal()', __('Method replaced with EEH_Line_Item::create_event_subtotal()', 'event_espresso'), '4.6.0');
+		return self::create_event_subtotal($total_line_item, $transaction);
 	}
 
 

core/EE_Dependency_Map.core.php

Indentation +789 added lines, -789 removed lines

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

Spacing +24 added lines, -24 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\services\loaders\LoaderFactory;
 use EventEspresso\core\services\loaders\LoaderInterface;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -130,7 +130,7 @@ 
     public static function instance(EE_Request $request = null, EE_Response $response = null)
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Dependency_Map) {
+        if ( ! self::$_instance instanceof EE_Dependency_Map) {
             self::$_instance = new EE_Dependency_Map($request, $response);
         }
         return self::$_instance;
@@ -185,16 +185,16 @@ 
     ) {
         $class = trim($class, '\\');
         $registered = false;
-        if (empty(self::$_instance->_dependency_map[ $class ])) {
-            self::$_instance->_dependency_map[ $class ] = array();
+        if (empty(self::$_instance->_dependency_map[$class])) {
+            self::$_instance->_dependency_map[$class] = array();
         }
         // we need to make sure that any aliases used when registering a dependency
         // get resolved to the correct class name
-        foreach ((array)$dependencies as $dependency => $load_source) {
+        foreach ((array) $dependencies as $dependency => $load_source) {
             $alias = self::$_instance->get_alias($dependency);
             if (
                 $overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
-                || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
+                || ! isset(self::$_instance->_dependency_map[$class][$alias])
             ) {
                 unset($dependencies[$dependency]);
                 $dependencies[$alias] = $load_source;
@@ -207,13 +207,13 @@ 
         // ie: with A = B + C, entries in B take precedence over duplicate entries in C
         // Union is way faster than array_merge() but should be used with caution...
         // especially with numerically indexed arrays
-        $dependencies += self::$_instance->_dependency_map[ $class ];
+        $dependencies += self::$_instance->_dependency_map[$class];
         // now we need to ensure that the resulting dependencies
         // array only has the entries that are required for the class
         // so first count how many dependencies were originally registered for the class
-        $dependency_count = count(self::$_instance->_dependency_map[ $class ]);
+        $dependency_count = count(self::$_instance->_dependency_map[$class]);
         // if that count is non-zero (meaning dependencies were already registered)
-        self::$_instance->_dependency_map[ $class ] = $dependency_count
+        self::$_instance->_dependency_map[$class] = $dependency_count
             // then truncate the  final array to match that count
             ? array_slice($dependencies, 0, $dependency_count)
             // otherwise just take the incoming array because nothing previously existed
@@ -231,7 +231,7 @@ 
      */
     public static function register_class_loader($class_name, $loader = 'load_core')
     {
-        if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
+        if ( ! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
             throw new DomainException(
                 esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
             );
@@ -255,7 +255,7 @@ 
             );
         }
         $class_name = self::$_instance->get_alias($class_name);
-        if (! isset(self::$_instance->_class_loaders[$class_name])) {
+        if ( ! isset(self::$_instance->_class_loaders[$class_name])) {
             self::$_instance->_class_loaders[$class_name] = $loader;
             return true;
         }
@@ -340,7 +340,7 @@ 
     public function class_loader($class_name)
     {
         // all legacy models use load_model()
-        if(strpos($class_name, 'EEM_') === 0){
+        if (strpos($class_name, 'EEM_') === 0) {
             return 'load_model';
         }
         $class_name = $this->get_alias($class_name);
@@ -369,7 +369,7 @@ 
     public function add_alias($class_name, $alias, $for_class = '')
     {
         if ($for_class !== '') {
-            if (! isset($this->_aliases[$for_class])) {
+            if ( ! isset($this->_aliases[$for_class])) {
                 $this->_aliases[$for_class] = array();
             }
             $this->_aliases[$for_class][$class_name] = $alias;
@@ -415,10 +415,10 @@ 
      */
     public function get_alias($class_name = '', $for_class = '')
     {
-        if (! $this->has_alias($class_name, $for_class)) {
+        if ( ! $this->has_alias($class_name, $for_class)) {
             return $class_name;
         }
-        if ($for_class !== '' && isset($this->_aliases[ $for_class ][ $class_name ])) {
+        if ($for_class !== '' && isset($this->_aliases[$for_class][$class_name])) {
             return $this->get_alias($this->_aliases[$for_class][$class_name], $for_class);
         }
         return $this->get_alias($this->_aliases[$class_name]);
@@ -679,10 +679,10 @@ 
             'EE_Front_Controller'                  => 'load_core',
             'EE_Module_Request_Router'             => 'load_core',
             'EE_Registry'                          => 'load_core',
-            'EE_Request'                           => function () use (&$request) {
+            'EE_Request'                           => function() use (&$request) {
                 return $request;
             },
-            'EE_Response'                          => function () use (&$response) {
+            'EE_Response'                          => function() use (&$response) {
                 return $response;
             },
             'EE_Request_Handler'                   => 'load_core',
@@ -704,7 +704,7 @@ 
             'EE_Messages_Data_Handler_Collection'  => 'load_lib',
             'EE_Message_Template_Group_Collection' => 'load_lib',
             'EE_Payment_Method_Manager'            => 'load_lib',
-            'EE_Messages_Generator'                => function () {
+            'EE_Messages_Generator'                => function() {
                 return EE_Registry::instance()->load_lib(
                     'Messages_Generator',
                     array(),
@@ -712,7 +712,7 @@ 
                     false
                 );
             },
-            'EE_Messages_Template_Defaults'        => function ($arguments = array()) {
+            'EE_Messages_Template_Defaults'        => function($arguments = array()) {
                 return EE_Registry::instance()->load_lib(
                     'Messages_Template_Defaults',
                     $arguments,
@@ -725,22 +725,22 @@ 
             // 'EEM_Message_Template_Group'           => 'load_model',
             // 'EEM_Message_Template'                 => 'load_model',
             //load_helper
-            'EEH_Parse_Shortcodes'                 => function () {
+            'EEH_Parse_Shortcodes'                 => function() {
                 if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
                     return new EEH_Parse_Shortcodes();
                 }
                 return null;
             },
-            'EE_Template_Config'                   => function () {
+            'EE_Template_Config'                   => function() {
                 return EE_Config::instance()->template_settings;
             },
-            'EE_Currency_Config'                   => function () {
+            'EE_Currency_Config'                   => function() {
                 return EE_Config::instance()->currency;
             },
-            'EE_Registration_Config'                   => function () {
+            'EE_Registration_Config'                   => function() {
                 return EE_Config::instance()->registration;
             },
-            'EventEspresso\core\services\loaders\Loader' => function () {
+            'EventEspresso\core\services\loaders\Loader' => function() {
                 return LoaderFactory::getLoader();
             },
         );

core/libraries/plugin_api/EE_Register_Payment_Method.lib.php

Indentation +157 added lines, -157 removed lines

@@ -22,163 +22,163 @@
 class EE_Register_Payment_Method implements EEI_Plugin_API
 {
 
-    /**
-     * Holds values for registered payment methods
-     *
-     * @var array
-     */
-    protected static $_settings = array();
-
-
-
-    /**
-     * Method for registering new EE_PMT_Base children
-     *
-     * @since    4.5.0
-     * @param string  $payment_method_id    a unique identifier for this set of modules Required.
-     * @param  array  $setup_args           an array of arguments provided for registering modules Required.{
-     * @type string[] $payment_method_paths each element is the folder containing the EE_PMT_Base child class
-     *                                      (eg, 'public_html/wp-content/plugins/my_plugin/Payomatic/' which contains
-     *                                      the files EE_PMT_Payomatic.pm.php)
-     *                                      }
-     * @throws EE_Error
-     * @type array payment_method_paths    an array of full server paths to folders containing any EE_PMT_Base
-     *                                      children, or to the EED_Module files themselves
-     * @return void
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function register($payment_method_id = null, $setup_args = array())
-    {
-        //required fields MUST be present, so let's make sure they are.
-        if (empty($payment_method_id) || ! is_array($setup_args) || empty($setup_args['payment_method_paths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Payment Methods with EE_Register_Payment_Method::register(), you must include a "payment_method_id" (a unique identifier for this set of modules), and an array containing the following keys: "payment_method_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
-                    'event_espresso'
-                )
-            );
-        }
-        //make sure we don't register twice
-        if (isset(self::$_settings[$payment_method_id])) {
-            return;
-        }
-        //make sure this was called in the right place!
-        if (
-            ! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        //setup $_settings array from incoming values.
-        self::$_settings[$payment_method_id] = array(
-            // array of full server paths to any EE_PMT_Base children used
-            'payment_method_paths' => isset($setup_args['payment_method_paths'])
-                ? (array)$setup_args['payment_method_paths']
-                : array(),
-        );
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-            array('EE_Register_Payment_Method', 'add_payment_methods')
-        );
-        // If EE_Payment_Method_Manager::register_payment_methods has already been called,
-        // then we need to add our caps for this payment method manually
-        if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
-            $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            // register payment methods directly
-            foreach (self::$_settings[$payment_method_id]['payment_method_paths'] as $payment_method_path) {
-                $payment_method_manager->register_payment_method($payment_method_path);
-            }
-            $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-            $capabilities->addCaps(
-                self::getPaymentMethodCapabilities(self::$_settings[$payment_method_id])
-            );
-        }
-    }
-
-
-
-    /**
-     * Filters the list of payment methods to add ours.
-     * and they're just full filepaths to FOLDERS containing a payment method class file. Eg.
-     *
-     * @param array $payment_method_folders array of paths to all payment methods that require registering
-     * @return array
-     */
-    public static function add_payment_methods($payment_method_folders)
-    {
-        foreach (self::$_settings as $settings) {
-            foreach ($settings['payment_method_paths'] as $payment_method_path) {
-                $payment_method_folders[] = $payment_method_path;
-            }
-        }
-        return $payment_method_folders;
-    }
-
-
-
-    /**
-     * This deregisters a module that was previously registered with a specific $module_id.
-     *
-     * @since    4.3.0
-     *
-     * @param string $module_id the name for the module that was previously registered
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function deregister($module_id = null)
-    {
-        if (isset(self::$_settings[$module_id])) {
-            $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-            $capabilities->removeCaps(
-                self::getPaymentMethodCapabilities(self::$_settings[$module_id])
-            );
-            unset(self::$_settings[$module_id]);
-        }
-    }
-
-
-
-    /**
-     * returns an array of the caps that get added when a Payment Method is registered
-     *
-     * @param array $settings
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    private static function getPaymentMethodCapabilities(array $settings)
-    {
-        $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-        $payment_method_caps = array('administrator' => array());
-        if (isset($settings['payment_method_paths'])) {
-            foreach ($settings['payment_method_paths'] as $payment_method_path) {
-                $payment_method_caps = $payment_method_manager->addPaymentMethodCap(
-                    strtolower(basename($payment_method_path)),
-                    $payment_method_caps
-                );
-            }
-        }
-        return $payment_method_caps;
-    }
+	/**
+	 * Holds values for registered payment methods
+	 *
+	 * @var array
+	 */
+	protected static $_settings = array();
+
+
+
+	/**
+	 * Method for registering new EE_PMT_Base children
+	 *
+	 * @since    4.5.0
+	 * @param string  $payment_method_id    a unique identifier for this set of modules Required.
+	 * @param  array  $setup_args           an array of arguments provided for registering modules Required.{
+	 * @type string[] $payment_method_paths each element is the folder containing the EE_PMT_Base child class
+	 *                                      (eg, 'public_html/wp-content/plugins/my_plugin/Payomatic/' which contains
+	 *                                      the files EE_PMT_Payomatic.pm.php)
+	 *                                      }
+	 * @throws EE_Error
+	 * @type array payment_method_paths    an array of full server paths to folders containing any EE_PMT_Base
+	 *                                      children, or to the EED_Module files themselves
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function register($payment_method_id = null, $setup_args = array())
+	{
+		//required fields MUST be present, so let's make sure they are.
+		if (empty($payment_method_id) || ! is_array($setup_args) || empty($setup_args['payment_method_paths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Payment Methods with EE_Register_Payment_Method::register(), you must include a "payment_method_id" (a unique identifier for this set of modules), and an array containing the following keys: "payment_method_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
+					'event_espresso'
+				)
+			);
+		}
+		//make sure we don't register twice
+		if (isset(self::$_settings[$payment_method_id])) {
+			return;
+		}
+		//make sure this was called in the right place!
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				esc_html__(
+					'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		//setup $_settings array from incoming values.
+		self::$_settings[$payment_method_id] = array(
+			// array of full server paths to any EE_PMT_Base children used
+			'payment_method_paths' => isset($setup_args['payment_method_paths'])
+				? (array)$setup_args['payment_method_paths']
+				: array(),
+		);
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+			array('EE_Register_Payment_Method', 'add_payment_methods')
+		);
+		// If EE_Payment_Method_Manager::register_payment_methods has already been called,
+		// then we need to add our caps for this payment method manually
+		if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
+			$payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			// register payment methods directly
+			foreach (self::$_settings[$payment_method_id]['payment_method_paths'] as $payment_method_path) {
+				$payment_method_manager->register_payment_method($payment_method_path);
+			}
+			$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+			$capabilities->addCaps(
+				self::getPaymentMethodCapabilities(self::$_settings[$payment_method_id])
+			);
+		}
+	}
+
+
+
+	/**
+	 * Filters the list of payment methods to add ours.
+	 * and they're just full filepaths to FOLDERS containing a payment method class file. Eg.
+	 *
+	 * @param array $payment_method_folders array of paths to all payment methods that require registering
+	 * @return array
+	 */
+	public static function add_payment_methods($payment_method_folders)
+	{
+		foreach (self::$_settings as $settings) {
+			foreach ($settings['payment_method_paths'] as $payment_method_path) {
+				$payment_method_folders[] = $payment_method_path;
+			}
+		}
+		return $payment_method_folders;
+	}
+
+
+
+	/**
+	 * This deregisters a module that was previously registered with a specific $module_id.
+	 *
+	 * @since    4.3.0
+	 *
+	 * @param string $module_id the name for the module that was previously registered
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function deregister($module_id = null)
+	{
+		if (isset(self::$_settings[$module_id])) {
+			$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+			$capabilities->removeCaps(
+				self::getPaymentMethodCapabilities(self::$_settings[$module_id])
+			);
+			unset(self::$_settings[$module_id]);
+		}
+	}
+
+
+
+	/**
+	 * returns an array of the caps that get added when a Payment Method is registered
+	 *
+	 * @param array $settings
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	private static function getPaymentMethodCapabilities(array $settings)
+	{
+		$payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+		$payment_method_caps = array('administrator' => array());
+		if (isset($settings['payment_method_paths'])) {
+			foreach ($settings['payment_method_paths'] as $payment_method_path) {
+				$payment_method_caps = $payment_method_manager->addPaymentMethodCap(
+					strtolower(basename($payment_method_path)),
+					$payment_method_caps
+				);
+			}
+		}
+		return $payment_method_caps;
+	}
 
 }
 // End of file EE_Register_Payment_Method.lib.php

core/libraries/messages/EE_Messages_Data_Handler_Collection.lib.php

Spacing +9 added lines, -9 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('No direct script access allowed');
 
 
@@ -26,10 +26,10 @@ 
 	 *                                                   classname to create an alternative index for retrieving data_handlers.
 	 * @return bool
 	 */
-	public function add( $data_handler, $data = null) {
+	public function add($data_handler, $data = null) {
 		$data = $data === null ? array() : (array) $data;
-		$info['key'] = $this->get_key( get_class( $data_handler ), $data );
-		return parent::add( $data_handler, $info );
+		$info['key'] = $this->get_key(get_class($data_handler), $data);
+		return parent::add($data_handler, $info);
 	}
 	
 
@@ -44,8 +44,8 @@ 
 	 *
 	 * @return  string      md5 hash using provided info.
 	 */
-	public function get_key( $classname, $data ) {
-		return md5( $classname . serialize( $data ) );
+	public function get_key($classname, $data) {
+		return md5($classname.serialize($data));
 	}
 
 
@@ -61,11 +61,11 @@ 
 	 *
 	 * @return null|EE_Messages_incoming_data
 	 */
-	public function get_by_key( $key ) {
+	public function get_by_key($key) {
 		$this->rewind();
-		while( $this->valid() ) {
+		while ($this->valid()) {
 			$data = $this->getInfo();
-			if ( isset( $data['key'] ) && $data['key'] === $key ) {
+			if (isset($data['key']) && $data['key'] === $key) {
 				$handler = $this->current();
 				$this->rewind();
 				return $handler;