Class Details

/**
 * Class EEM_Base
 * Multi-table model. Especially handles joins when querying.
 * An important note about values dealt with in models and model objects:
 * values used by models exist in basically 3 different domains, which the EE_Model_Fields help convert between:
 * 1. Client-code values (eg, controller code may refer to a date as "March 21, 2013")
 * 2. Model object values (eg, after the model object has called set() on the value and saves it onto the model object,
 * it may become a unix timestamp, eg 12312412412)
 * 3. Database values (eg, we may later decide to store dates as mysql dates, in which case they'd be stored as
 * '2013-03-21 00:00:00') Sometimes these values are the same, but often they are not. When your client code is using a
 * model's functions, you need to be aware which domain your data exists in. If it is client-code values (ie, it hasn't
 * had a EE_Model_Field call prepare_for_set on it) then use the model functions as normal. However, if you are calling
 * the model functions with values from the model object domain (ie, the code your writing is probably within a model
 * object, and all the values you're dealing with have had an EE_Model_Field call prepare_for_set on them), then you'll
 * want to set $values_already_prepared_by_model_object to FALSE within the argument-list of the functions you call (in
 * order to avoid re-processing those values). If your values are already in the database values domain, you'll either
 * way to convert them into the model object domain by creating model objects from those raw db values (ie,using
 * EEM_Base::_create_objects), or just use $wpdb directly.
 *
 * @package               Event Espresso
 * @subpackage            core
 * @author                Michael Nelson
 * @since                 EE4
 */
Class [  abstract class EEM_Base extends EE_Base implements EventEspresso\core\interfaces\ResettableInterface ] {
  @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 40-6714

  - Constants [16] {
    Constant [ public int not_prepared_by_model_object ] { 0 }
    Constant [ public int prepared_by_model_object ] { 1 }
    Constant [ public int prepared_for_use_in_db ] { 2 }
    Constant [ public string caps_read ] { read }
    Constant [ public string caps_read_admin ] { read_admin }
    Constant [ public string caps_edit ] { edit }
    Constant [ public string caps_delete ] { delete }
    Constant [ public int db_verified_none ] { 0 }
    Constant [ public int db_verified_core ] { 1 }
    Constant [ public int db_verified_addons ] { 2 }
    Constant [ public string default_where_conditions_all ] { all }
    Constant [ public string default_where_conditions_this_only ] { this_model_only }
    Constant [ public string default_where_conditions_others_only ] { other_models_only }
    Constant [ public string default_where_conditions_minimum_all ] { minimum }
    Constant [ public string default_where_conditions_minimum_others ] { full_this_minimum_others }
    Constant [ public string default_where_conditions_none ] { none }
  }

  - Static properties [4] {
    Property [ protected static $_model_query_blog_id = NULL ]
    Property [ protected static $loader = NULL ]
    Property [ private static $mirror = NULL ]
    Property [ protected static $_db_verification_level = 0 ]
  }

  - Static methods [10] {
    /**
     * @return LoaderInterface
     * @throws InvalidArgumentException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    Method [  static protected method getLoader ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 701 - 707

      - Parameters [0] {
      }
      - Return [ EventEspresso\core\services\loaders\LoaderInterface ]
    }

    /**
     * @return Mirror
     * @since   5.0.0.p
     */
    Method [  static private method getMirror ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 714 - 720

      - Parameters [0] {
      }
      - Return [ EventEspresso\core\services\container\Mirror ]
    }

    /**
     * @param string $model_class_Name
     * @param string $timezone
     * @return array
     * @throws ReflectionException
     * @since   5.0.0.p
     */
    Method [  static private method getModelArguments ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 730 - 754

      - Parameters [2] {
        Parameter #0 [  string $model_class_Name ]
        Parameter #1 [  string $timezone ]
      }
      - Return [ array ]
    }

    /**
     * This function is a singleton method used to instantiate the Espresso_model object
     *
     * @param string|null $timezone   string representing the timezone we want to set for returned Date Time Strings
     *                                (and any incoming timezone data that gets saved).
     *                                Note this just sends the timezone info to the date time model field objects.
     *                                Default is NULL
     *                                (and will be assumed using the set timezone in the 'timezone_string' wp option)
     * @return static (as in the concrete child class)
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  static public method instance ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 769 - 784

      - Parameters [1] {
        Parameter #0 [  $timezone = '' ]
      }
    }

    /**
     * resets the model and returns it
     *
     * @param string|null $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
     */
    Method [  static public method reset ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 799 - 820

      - Parameters [1] {
        Parameter #0 [  $timezone = '' ]
      }
    }

    /**
     * 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.
     */
    Method [  static public method set_model_query_blog_id ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 829 - 834

      - Parameters [1] {
        Parameter #0 [  $blog_id = 0 ]
      }
    }

    /**
     * Returns whatever is set as the internal $model_query_blog_id.
     *
     * @return int
     */
    Method [  static public method get_model_query_blog_id ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 842 - 845
    }

    /**
     * Returns all the capability contexts which are valid when querying models
     *
     * @return array
     */
    Method [  static public method valid_cap_contexts ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6433 - 6444

      - Parameters [0] {
      }
      - Return [ array ]
    }

    /**
     * Returns all valid options for 'default_where_conditions'
     *
     * @return array
     */
    Method [  static public method valid_default_where_conditions ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6452 - 6462

      - Parameters [0] {
      }
      - Return [ array ]
    }

    /**
     * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
     *
     * @param string $context
     * @return bool
     * @throws EE_Error
     */
    Method [  static public method verify_is_valid_cap_context ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6474 - 6491

      - Parameters [1] {
        Parameter #0 [  $context ]
      }
      - Return [ bool ]
    }
  }

  - Properties [39] {
    Property [ private $_values_already_prepared_by_model_object = 0 ]
    Property [ protected $singular_item = 'Item' ]
    Property [ protected $plural_item = 'Items' ]
    Property [ protected $_tables = NULL ]
    Property [ protected $_fields = NULL ]
    Property [ protected $_model_relations = [] ]
    Property [ protected $_indexes = [] ]
    Property [ protected $_default_where_conditions_strategy = NULL ]
    Property [ protected $_minimum_where_conditions_strategy = NULL ]
    Property [ protected $_model_chain_to_wp_user = '' ]
    Property [ protected $model_chain_to_password = NULL ]
    Property [ protected $_ignore_where_strategy = false ]
    Property [ protected $_caps_slug = NULL ]
    Property [ protected $_cap_restrictions = [self::caps_read => [], self::caps_read_admin => [], self::caps_edit => [], self::caps_delete => []] ]
    Property [ protected $_cap_restriction_generators = [] ]
    Property [ protected $_cap_contexts_to_cap_action_map = ['read' => 'read', 'read_admin' => 'read', 'edit' => 'edit', 'delete' => 'delete'] ]
    Property [ protected $_timezone = NULL ]
    Property [ private $_cache_foreign_key_to_fields = [] ]
    Property [ private $_cached_fields = NULL ]
    Property [ private $_cached_fields_non_db_only = NULL ]
    Property [ private $_primary_key_field = NULL ]
    Property [ protected $_has_primary_key_field = NULL ]
    Property [ protected $foreign_key_aliases = [] ]
    Property [ protected $_wp_core_model = false ]
    Property [ protected $has_password_field = NULL ]
    Property [ protected $password_field = NULL ]
    Property [ protected $_valid_operators = ['=' => '=', ' '<=', ' '=' => '>=', '>' => '>', '!=' => '!=', 'LIKE' => 'LIKE', 'like' => 'LIKE', 'NOT_LIKE' => 'NOT LIKE', 'not_like' => 'NOT LIKE', 'NOT LIKE' => 'NOT LIKE', 'not like' => 'NOT LIKE', 'IN' => 'IN', 'in' => 'IN', 'NOT_IN' => 'NOT IN', 'not_in' => 'NOT IN', 'NOT IN' => 'NOT IN', 'not in' => 'NOT IN', 'between' => 'BETWEEN', 'BETWEEN' => 'BETWEEN', 'IS_NOT_NULL' => 'IS NOT NULL', 'is_not_null' => 'IS NOT NULL', 'IS NOT NULL' => 'IS NOT NULL', 'is not null' => 'IS NOT NULL', 'IS_NULL' => 'IS NULL', 'is_null' => 'IS NULL', 'IS NULL' => 'IS NULL', 'is null' => 'IS NULL', 'REGEXP' => 'REGEXP', 'regexp' => 'REGEXP', 'NOT_REGEXP' => 'NOT REGEXP', 'not_regexp' => 'NOT REGEXP', 'NOT REGEXP' => 'NOT REGEXP', 'not regexp' => 'NOT REGEXP'] ]
    Property [ protected $_in_style_operators = ['IN', 'NOT IN'] ]
    Property [ protected $_between_style_operators = ['BETWEEN'] ]
    Property [ protected $_like_style_operators = ['LIKE', 'NOT LIKE'] ]
    Property [ protected $_null_style_operators = ['IS NOT NULL', 'IS NULL'] ]
    Property [ protected $_allowed_order_values = ['asc', 'desc', 'ASC', 'DESC'] ]
    Property [ private $_logic_query_param_keys = ['not', 'and', 'or', 'NOT', 'AND', 'OR'] ]
    Property [ private $_allowed_query_params = [0, 'limit', 'order_by', 'group_by', 'having', 'force_join', 'order', 'on_join_limit', 'default_where_conditions', 'caps', 'extra_selects', 'exclude_protected'] ]
    Property [ private $_valid_wpdb_data_types = ['%d', '%s', '%f'] ]
    Property [ protected $EE = NULL ]
    Property [ protected $_show_next_x_db_queries = 0 ]
    Property [ protected $_custom_selections = [] ]
    Property [ protected $_entity_map = NULL ]
  }

  - Methods [179] {
    /**
     * About all child constructors:
     * they should define the _tables, _fields and _model_relations arrays.
     * Should ALWAYS be called after child constructor.
     * In order to make the child constructors to be as simple as possible, this parent constructor
     * finalizes constructing all the object's attributes.
     * Generally, rather than requiring a child to code
     * $this->_tables = array(
     *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
     *        ...);
     *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
     * each EE_Table has a function to set the table's alias after the constructor, using
     * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
     * do something similar.
     *
     * @param string|null $timezone
     * @throws EE_Error
     * @throws Exception
     */
    Method [  protected method __construct ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 547 - 692

      - Parameters [1] {
        Parameter #0 [  $timezone = '' ]
      }
    }

    /**
     * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
     *
     * @param boolean $translated return localized strings or JUST the array.
     * @return array
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     * @throws ReflectionException
     */
    Method [  public method status_array ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 859 - 874

      - Parameters [1] {
        Parameter #0 [  $translated = false ]
      }
    }

    /**
     * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
     *
     * @param array $query_params             @see
     *                                        https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     *                                        or if you have the development copy of EE you can view this at the path:
     *                                        /docs/G--Model-System/model-query-params.md
     * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
     *                                        from EE_Base_Class[], use get_all_wpdb_results(). Array keys are object
     *                                        IDs (if there is a primary key on the model. if not, numerically indexed)
     *                                        Some full examples: get 10 transactions which have Scottish attendees:
     *                                        EEM_Transaction::instance()->get_all( array( array(
     *                                        'OR'=>array(
     *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
     *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
     *                                        )
     *                                        ),
     *                                        'limit'=>10,
     *                                        'group_by'=>'TXN_ID'
     *                                        ));
     *                                        get all the answers to the question titled "shirt size" for event with id
     *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
     *                                        'Question.QST_display_text'=>'shirt size',
     *                                        'Registration.Event.EVT_ID'=>12
     *                                        ),
     *                                        'order_by'=>array('ANS_value'=>'ASC')
     *                                        ));
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method get_all ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 907 - 916

      - Parameters [1] {
        Parameter #0 [  $query_params = [] ]
      }
    }

    /**
     * Modifies the query parameters so we only get back model objects
     * that "belong" to the current user
     *
     * @param array $query_params @see
     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @return array @see
     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @throws ReflectionException
     * @throws ReflectionException
     */
    Method [  public method alter_query_params_to_only_include_mine ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 930 - 937

      - Parameters [1] {
        Parameter #0 [  $query_params = [] ]
      }
    }

    /**
     * Returns the name of the field's name that points to the WP_User table
     *  on this model (or follows the _model_chain_to_wp_user and uses that model's
     * foreign key to the WP_User table)
     *
     * @return string|boolean string on success, boolean false when there is no
     * foreign key to the WP_User table
     * @throws ReflectionException
     * @throws ReflectionException
     */
    Method [  public method wp_user_field_name ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 950 - 967
    }

    /**
     * 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
     */
    Method [  public method model_chain_to_wp_user ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 980 - 983
    }

    /**
     * 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
     */
    Method [  public method is_owned ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 994 - 1005
    }

    /**
     * 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      @see
     *                                  https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
     * @param mixed  $columns_to_select What columns to select. By default, we select all columns specified by the
     *                                  fields on the model, and the models we joined to in the query. However, you can
     *                                  override this and set the select to "*", or a specific column name, like
     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
     *                                  the aliases used to refer to this selection, and values are to be
     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
     * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     */
    Method [  protected method _get_all_wpdb_results ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1029 - 1045

      - Parameters [3] {
        Parameter #0 [  $query_params = [] ]
        Parameter #1 [  $output = ARRAY_A ]
        Parameter #2 [  $columns_to_select = NULL ]
      }
    }

    /**
     * Get a CustomSelects object if the $query_params or $columns_to_select allows for it.
     * Note: $query_params['extra_selects'] will always override any $columns_to_select values. It is the preferred
     * method of including extra select information.
     *
     * @param array             $query_params
     * @param null|array|string $columns_to_select
     * @return null|CustomSelects
     * @throws InvalidArgumentException
     */
    Method [  protected method getCustomSelection ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1058 - 1068

      - Parameters [2] {
        Parameter #0 [  array $query_params ]
        Parameter #1 [  $columns_to_select = NULL ]
      }
    }

    /**
     * Gets an array of rows from the database just like $wpdb->get_results would,
     * but you can use the model query params to more easily
     * take care of joins, field preparation etc.
     *
     * @param array  $query_params      @see
     *                                  https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
     *                                  fields on the model, and the models we joined to in the query. However, you can
     *                                  override this and set the select to "*", or a specific column name, like
     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
     *                                  the aliases used to refer to this selection, and values are to be
     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
     * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method get_all_wpdb_results ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1091 - 1094

      - Parameters [3] {
        Parameter #0 [  $query_params = [] ]
        Parameter #1 [  $output = ARRAY_A ]
        Parameter #2 [  $columns_to_select = NULL ]
      }
    }

    /**
     * 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
     * @return string
     * @throws EE_Error
     */
    Method [  private method _construct_select_from_input ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1106 - 1144

      - Parameters [1] {
        Parameter #0 [  $columns_to_select ]
      }
    }

    /**
     * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
     *
     * @return string
     * @throws EE_Error
     */
    Method [  public method primary_key_name ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1153 - 1156
    }

    /**
     * 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|mixed|null
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method get_one_by_ID ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1168 - 1192

      - Parameters [1] {
        Parameter #0 [  $id ]
      }
    }

    /**
     * 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
     *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @throws EE_Error
     */
    Method [  public method alter_query_params_to_restrict_by_ID ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1206 - 1219

      - Parameters [2] {
        Parameter #0 [  $id ]
        Parameter #1 [  $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
     * @throws ReflectionException
     */
    Method [  public method get_one ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1231 - 1250

      - Parameters [1] {
        Parameter #0 [  $query_params = [] ]
      }
    }

    /**
     * Returns the next x number of items in sequence from the given value as
     * found in the database matching the given query conditions.
     *
     * @param mixed $current_field_value    Value used for the reference point.
     * @param null  $field_to_order_by      What field is used for the
     *                                      reference point.
     * @param int   $limit                  How many to return.
     * @param array $query_params           Extra conditions on the query.
     * @param null  $columns_to_select      If left null, then an array of
     *                                      EE_Base_Class objects is returned,
     *                                      otherwise you can indicate just the
     *                                      columns you want returned.
     * @return EE_Base_Class[]|array
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method next_x ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1270 - 1285

      - Parameters [5] {
        Parameter #0 [  $current_field_value ]
        Parameter #1 [  $field_to_order_by = NULL ]
        Parameter #2 [  $limit = 1 ]
        Parameter #3 [  $query_params = [] ]
        Parameter #4 [  $columns_to_select = NULL ]
      }
    }

    /**
     * Returns the previous x number of items in sequence from the given value
     * as found in the database matching the given query conditions.
     *
     * @param mixed $current_field_value    Value used for the reference point.
     * @param null  $field_to_order_by      What field is used for the
     *                                      reference point.
     * @param int   $limit                  How many to return.
     * @param array $query_params           Extra conditions on the query.
     * @param null  $columns_to_select      If left null, then an array of
     *                                      EE_Base_Class objects is returned,
     *                                      otherwise you can indicate just the
     *                                      columns you want returned.
     * @return EE_Base_Class[]|array
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method previous_x ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1305 - 1320

      - Parameters [5] {
        Parameter #0 [  $current_field_value ]
        Parameter #1 [  $field_to_order_by = NULL ]
        Parameter #2 [  $limit = 1 ]
        Parameter #3 [  $query_params = [] ]
        Parameter #4 [  $columns_to_select = NULL ]
      }
    }

    /**
     * Returns the next item in sequence from the given value as found in the
     * database matching the given query conditions.
     *
     * @param mixed $current_field_value    Value used for the reference point.
     * @param null  $field_to_order_by      What field is used for the
     *                                      reference point.
     * @param array $query_params           Extra conditions on the query.
     * @param null  $columns_to_select      If left null, then an EE_Base_Class
     *                                      object is returned, otherwise you
     *                                      can indicate just the columns you
     *                                      want and a single array indexed by
     *                                      the columns will be returned.
     * @return EE_Base_Class|null|array()
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method next ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1340 - 1357

      - Parameters [4] {
        Parameter #0 [  $current_field_value ]
        Parameter #1 [  $field_to_order_by = NULL ]
        Parameter #2 [  $query_params = [] ]
        Parameter #3 [  $columns_to_select = NULL ]
      }
    }

    /**
     * Returns the previous item in sequence from the given value as found in
     * the database matching the given query conditions.
     *
     * @param mixed $current_field_value    Value used for the reference point.
     * @param null  $field_to_order_by      What field is used for the
     *                                      reference point.
     * @param array $query_params           Extra conditions on the query.
     * @param null  $columns_to_select      If left null, then an EE_Base_Class
     *                                      object is returned, otherwise you
     *                                      can indicate just the columns you
     *                                      want and a single array indexed by
     *                                      the columns will be returned.
     * @return EE_Base_Class|null|array()
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method previous ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1377 - 1394

      - Parameters [4] {
        Parameter #0 [  $current_field_value ]
        Parameter #1 [  $field_to_order_by = NULL ]
        Parameter #2 [  $query_params = [] ]
        Parameter #3 [  $columns_to_select = NULL ]
      }
    }

    /**
     * Returns the a consecutive number of items in sequence from the given
     * value as found in the database matching the given query conditions.
     *
     * @param mixed  $current_field_value   Value used for the reference point.
     * @param string $operand               What operand is used for the sequence.
     * @param string $field_to_order_by     What field is used for the reference point.
     * @param int    $limit                 How many to return.
     * @param array  $query_params          Extra conditions on the query.
     * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
     *                                      otherwise you can indicate just the columns you want returned.
     * @return EE_Base_Class[]|array
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  protected method _get_consecutive ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1412 - 1469

      - Parameters [6] {
        Parameter #0 [  $current_field_value ]
        Parameter #1 [  $operand = '>' ]
        Parameter #2 [  $field_to_order_by = NULL ]
        Parameter #3 [  $limit = 1 ]
        Parameter #4 [  $query_params = [] ]
        Parameter #5 [  $columns_to_select = NULL ]
      }
    }

    /**
     * This sets the _timezone property after model object has been instantiated.
     *
     * @param string|null $timezone valid PHP DateTimeZone timezone string
     * @throws Exception
     */
    Method [  public method set_timezone ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1478 - 1494

      - Parameters [1] {
        Parameter #0 [  ?string $timezone = '' ]
      }
    }

    /**
     * This just returns whatever is set for the current timezone.
     *
     * @access public
     * @return string
     * @throws Exception
     */
    Method [  public method get_timezone ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1504 - 1520
    }

    /**
     * This returns the date formats set for the given field name and also ensures that
     * $this->_timezone property is set correctly.
     *
     * @param string $field_name The name of the field the formats are being retrieved for.
     * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
     * @return array formats in an array with the date format first, and the time format last.
     * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
     * @since 4.6.x
     */
    Method [  public method get_formats_for ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1533 - 1552

      - Parameters [2] {
        Parameter #0 [  $field_name ]
        Parameter #1 [  $pretty = false ]
      }
    }

    /**
     * This returns the current time in a format setup for a query on this model.
     * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
     * it will return:
     *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
     *  NOW
     *  - or a unix timestamp (equivalent to time())
     * Note: When requesting a formatted string, if the date or time format doesn't include seconds, for example,
     * the time returned, because it uses that format, will also NOT include seconds. For this reason, if you want
     * the time returned to be the current time down to the exact second, set $timestamp to true.
     *
     * @param string $field_name       The field the current time is needed for.
     * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
     *                                 formatted string matching the set format for the field in the set timezone will
     *                                 be returned.
     * @param string $what             Whether to return the string in just the time format, the date format, or both.
     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
     *                                 exception is triggered.
     * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
     * @throws Exception
     * @since 4.6.x
     */
    Method [  public method current_time_for_query ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1577 - 1593

      - Parameters [3] {
        Parameter #0 [  $field_name ]
        Parameter #1 [  $timestamp = false ]
        Parameter #2 [  $what = 'both' ]
      }
    }

    /**
     * This receives a time string for a given field and ensures
     * that it is set up 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|null $timezone_string By default, it is assumed the incoming time string is in timezone for
     *                                     the blog.  If this is not the case, then it can be specified here.  If
     *                                     incoming format is
     *                                     'U', this is ignored.
     * @return DbSafeDateTime
     * @throws EE_Error
     * @throws Exception
     */
    Method [  public method convert_datetime_for_query ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1615 - 1628

      - Parameters [4] {
        Parameter #0 [  string $field_name ]
        Parameter #1 [  string $timestring ]
        Parameter #2 [  string $incoming_format ]
        Parameter #3 [  ?string $timezone_string = '' ]
      }
      - Return [ EventEspresso\core\domain\entities\DbSafeDateTime ]
    }

    /**
     * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
     *
     * @return EE_Table_Base[]
     */
    Method [  public method get_tables ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1636 - 1639
    }

    /**
     * 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            @see
     *                                         https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     *                                         Eg, consider updating Question's QST_admin_label field is of type
     *                                         Simple_HTML. If you use this function to update that field to $new_value
     *                                         = (note replace 8's with appropriate opening and closing tags in the
     *                                         following example)"8script8alert('I hack all');8/script88b8boom
     *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
     *                                         TRUE, it is assumed that you've already called
     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
     *                                         malicious javascript. However, if
     *                                         $values_already_prepared_by_model_object is left as FALSE, then
     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
     *                                         and every other field, before insertion. We provide this parameter
     *                                         because model objects perform their prepare_for_set function on all
     *                                         their values, and so don't need to be called again (and in many cases,
     *                                         shouldn't be called again. Eg: if we escape HTML characters in the
     *                                         prepare_for_set method...)
     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
     *                                         in this model's entity map according to $fields_n_values that match
     *                                         $query_params. This obviously has some overhead, so you can disable it
     *                                         by setting this to FALSE, but be aware that model objects being used
     *                                         could get out-of-sync with the database
     * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
     *                                         rows affected which *could* include 0 which DOES NOT mean the query was
     *                                         bad)
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method update ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1692 - 1842

      - Parameters [3] {
        Parameter #0 [  $fields_n_values ]
        Parameter #1 [  $query_params ]
        Parameter #2 [  $keep_model_objs_in_sync = true ]
      }
    }

    /**
     * Analogous to $wpdb->get_col, returns a 1-dimensional array where the values
     * are the values of the field specified (or by default the primary key field)
     * that matched the query params. Note that you should pass the name of the
     * model FIELD, not the database table's column name.
     *
     * @param array  $query_params
     * @param string $field_to_select
     * @return array just like $wpdb->get_col()
     * @throws EE_Error
     * @throws ReflectionException
     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md for $query_params values
     */
    Method [  public method get_col ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1858 - 1876

      - Parameters [2] {
        Parameter #0 [  $query_params = [] ]
        Parameter #1 [  $field_to_select = NULL ]
      }
    }

    /**
     * Returns a single column value for a single row from the database
     *
     * @param array  $query_params    @see
     *                                https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @param string $field_to_select @see EEM_Base::get_col()
     * @return string
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method get_var ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1889 - 1897

      - Parameters [2] {
        Parameter #0 [  $query_params = [] ]
        Parameter #1 [  $field_to_select = NULL ]
      }
    }

    /**
     * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
     * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
     * injection, but currently no further filtering is done
     *
     * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
     *                               be updated to in the DB
     * @return string of SQL
     * @throws EE_Error
     * @global      $wpdb
     */
    Method [  public method _construct_update_sql ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1911 - 1927

      - Parameters [1] {
        Parameter #0 [  $fields_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 bool  $block_deletes whether to allow related model objects to block (prevent) this deletion
     *                             ie: enforce referential integrity
     *                             It's advisable to always leave this as TRUE, otherwise you could corrupt your DB
     * @return int the number of rows deleted
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method delete_permanently_by_ID ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1944 - 1953

      - Parameters [2] {
        Parameter #0 [  $id ]
        Parameter #1 [  $block_deletes = true ]
      }
      - Return [ int ]
    }

    /**
     * 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 bool  $block_deletes whether to allow related model objects to block (prevent) this deletion
     *                             ie: enforce referential integrity
     *                             It's advisable to always leave this as TRUE, otherwise you could corrupt your DB
     * @return int the number of rows deleted
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method delete_by_ID ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1968 - 1977

      - Parameters [2] {
        Parameter #0 [  $id ]
        Parameter #1 [  $block_deletes = true ]
      }
    }

    /**
     * Identical to delete_permanently, but does a "soft" delete if possible,
     * meaning if the model has a field that indicates its been "trashed" or
     * "soft deleted", we will just set that instead of actually deleting the rows.
     *
     * @param array   $query_params
     * @param boolean $block_deletes whether to allow related model objects to block (prevent) this deletion
     *                               ie: enforce referential integrity
     *                               It's advisable to always leave this as TRUE, otherwise you could corrupt your DB
     * @return int how many rows got deleted
     * @throws EE_Error
     * @throws ReflectionException
     * @see EEM_Base::delete_permanently
     */
    Method [  public method delete ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 1994 - 1997

      - Parameters [2] {
        Parameter #0 [  $query_params ]
        Parameter #1 [  $block_deletes = true ]
      }
    }

    /**
     * Deletes the model objects that meet the query params. Note: this method is overridden
     * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
     * as archived, not actually deleted
     *
     * @param array   $query_params
     * @param boolean $block_deletes  whether to allow related model objects to block (prevent) this deletion
     *                                ie: enforce referential integrity
     *                                It's advisable to always leave this as TRUE, otherwise you could corrupt your DB
     * @return int how many rows got deleted
     * @throws EE_Error
     * @throws ReflectionException
     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     */
    Method [  public method delete_permanently ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2014 - 2116

      - Parameters [2] {
        Parameter #0 [  $query_params ]
        Parameter #1 [  $block_deletes = true ]
      }
      - Return [ int ]
    }

    /**
     * Checks all the relations that throw error messages when there are blocking related objects
     * for related model objects. If there are any related model objects on those relations,
     * adds an EE_Error, and return true
     *
     * @param EE_Base_Class|int $this_model_obj_or_id
     * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
     *                                                 should be ignored when determining whether there are related
     *                                                 model objects which block this model object's deletion. Useful
     *                                                 if you know A is related to B and are considering deleting A,
     *                                                 but want to see if A has any other objects blocking its deletion
     *                                                 before removing the relation between A and B
     * @return boolean
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method delete_is_blocked_by_related_models ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2135 - 2170

      - Parameters [2] {
        Parameter #0 [  $this_model_obj_or_id ]
        Parameter #1 [  $ignore_this_model_obj = NULL ]
      }
    }

    /**
     * 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  $block_deletes whether to allow related model objects to block (prevent) this deletion
     *                             ie: enforce referential integrity
     *                             It's advisable to always leave this as TRUE, otherwise you could corrupt your DB
     * @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:
     *                              [ 'Event.EVT_ID' => [ 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:
     *                              [
     *                                  0 => [
     *                                      'Term_Relationship.object_id' => 1
     *                                      'Term_Relationship.term_taxonomy_id' => 5
     *                                  ],
     *                                  1 => [
     *                                      'Term_Relationship.object_id' => 1
     *                                      'Term_Relationship.term_taxonomy_id' => 6
     *                                  ]
     *                              ]
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  protected method _get_ids_for_delete ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2202 - 2256

      - Parameters [2] {
        Parameter #0 [  array $row_results_for_deleting ]
        Parameter #1 [  $block_deletes = true ]
      }
    }

    /**
     * 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 deletion.
     *
     * @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
     */
    Method [  protected method _build_query_part_for_deleting_from_columns_and_values ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2267 - 2294

      - Parameters [1] {
        Parameter #0 [  array $ids_to_delete_indexed_by_column ]
      }
    }

    /**
     * Gets the model field by the fully qualified name
     *
     * @param string $qualified_column_name eg 'Event_CPT.post_name' or $field_obj->get_qualified_column()
     * @return EE_Model_Field_Base
     * @throws EE_Error
     * @throws EE_Error
     */
    Method [  public method get_field_by_column ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2305 - 2319

      - Parameters [1] {
        Parameter #0 [  $qualified_column_name ]
      }
    }

    /**
     * Count all the rows that match criteria the model query params.
     * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
     * column
     *
     * @param array  $query_params   @see
     *                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @param string $field_to_count field on model to count by (not column name)
     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
     *                               that by the setting $distinct to TRUE;
     * @return int
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method count ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2336 - 2366

      - Parameters [3] {
        Parameter #0 [  $query_params = [] ]
        Parameter #1 [  $field_to_count = '' ]
        Parameter #2 [  $distinct = false ]
      }
    }

    /**
     * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
     *
     * @param array  $query_params @see
     *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @param string $field_to_sum name of field (array key in $_fields array)
     * @return float
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method sum ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2379 - 2397

      - Parameters [2] {
        Parameter #0 [  $query_params ]
        Parameter #1 [  $field_to_sum = NULL ]
      }
    }

    /**
     * Just calls the specified method on $wpdb with the given arguments
     * Consolidates a little extra error handling code
     *
     * @param string $wpdb_method
     * @param array  $arguments_to_provide
     * @return mixed
     * @throws EE_Error
     * @global wpdb  $wpdb
     */
    Method [  protected method _do_wpdb_query ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2410 - 2476

      - Parameters [2] {
        Parameter #0 [  $wpdb_method ]
        Parameter #1 [  $arguments_to_provide ]
      }
    }

    /**
     * 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
     */
    Method [  private method _process_wpdb_query ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2489 - 2521

      - Parameters [2] {
        Parameter #0 [  $wpdb_method ]
        Parameter #1 [  $arguments_to_provide ]
      }
    }

    /**
     * Verifies the EE core database is up-to-date and records that we've done it on
     * EEM_Base::$_db_verification_level
     *
     * @param string $wpdb_method
     * @param array  $arguments_to_provide
     * @return string
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  private method _verify_core_db ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2534 - 2551

      - Parameters [2] {
        Parameter #0 [  $wpdb_method ]
        Parameter #1 [  $arguments_to_provide ]
      }
    }

    /**
     * Verifies the EE addons' database is up-to-date and records that we've done it on
     * EEM_Base::$_db_verification_level
     *
     * @param $wpdb_method
     * @param $arguments_to_provide
     * @return string
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  private method _verify_addons_db ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2564 - 2581

      - Parameters [2] {
        Parameter #0 [  $wpdb_method ]
        Parameter #1 [  $arguments_to_provide ]
      }
    }

    /**
     * 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
     */
    Method [  private method _construct_2nd_half_of_select_query ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2593 - 2601

      - Parameters [1] {
        Parameter #0 [  EE_Model_Query_Info_Carrier $model_query_info ]
      }
    }

    /**
     * Set to easily debug the next X queries ran from this model.
     *
     * @param int $count
     */
    Method [  public method show_next_x_db_queries ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2609 - 2612

      - Parameters [1] {
        Parameter #0 [  $count = 1 ]
      }
    }

    /**
     * @param $sql_query
     */
    Method [  public method show_db_query_if_previously_requested ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2618 - 2628

      - Parameters [1] {
        Parameter #0 [  $sql_query ]
      }
    }

    /**
     * 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 $id_or_obj                        EE_base_Class or ID of $thisModelObject
     * @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
     *                                                            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|null        $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
     */
    Method [  public method add_relationship_to ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2659 - 2667

      - Parameters [4] {
        Parameter #0 [  $id_or_obj ]
        Parameter #1 [  $other_model_id_or_obj ]
        Parameter #2 [  $relationName ]
        Parameter #3 [  $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             EE_base_Class or ID of $thisModelObject
     * @param EE_Base_Class|int $other_model_id_or_obj EE_base_Class or ID of other Model Object
     * @param string            $relationName          key in EEM_Base::_relations
     * @param array|null        $where_query           This allows you to enter further query params for the relation
     *                                                 to for relation to methods that allow you to further specify
     *                                                 extra columns to join by (such as HABTM). Keep in mind that the
     *                                                 only acceptable query_params is strict "col" => "value" pairs
     *                                                 because these will be inserted in any new rows created as well.
     * @return EE_Base_Class
     * @throws EE_Error
     */
    Method [  public method remove_relationship_to ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2690 - 2694

      - Parameters [4] {
        Parameter #0 [  $id_or_obj ]
        Parameter #1 [  $other_model_id_or_obj ]
        Parameter #2 [  $relationName ]
        Parameter #3 [  $where_query = [] ]
      }
    }

    /**
     * @param mixed       $id_or_obj
     * @param string      $relationName
     * @param array|null  $where_query_params
     * @return EE_Base_Class[]
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method remove_relations ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2705 - 2709

      - Parameters [3] {
        Parameter #0 [  $id_or_obj ]
        Parameter #1 [  $relationName ]
        Parameter #2 [  $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|null  $query_params @see
     *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @return EE_Base_Class[]
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method get_all_related ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2725 - 2730

      - Parameters [3] {
        Parameter #0 [  $id_or_obj ]
        Parameter #1 [  $model_name ]
        Parameter #2 [  ?array $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|null               $query_params
     * @return int how many deleted
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method delete_related ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2746 - 2751

      - Parameters [3] {
        Parameter #0 [  $id_or_obj ]
        Parameter #1 [  $model_name ]
        Parameter #2 [  $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|null               $query_params
     * @return int how many deleted
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method delete_related_permanently ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2767 - 2772

      - Parameters [3] {
        Parameter #0 [  $id_or_obj ]
        Parameter #1 [  $model_name ]
        Parameter #2 [  $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 EE_Base_Class|int|string $id_or_obj
     * @param string                   $model_name     like 'Event', or 'Registration'
     * @param array|null               $query_params   @see
     *                                                 https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @param string                   $field_to_count name of field to count by. By default, uses primary key
     * @param bool                     $distinct       if we want to only count the distinct values for the column then
     *                                                 you can trigger that by the setting $distinct to TRUE;
     * @return int
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method count_related ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2790 - 2807

      - Parameters [5] {
        Parameter #0 [  $id_or_obj ]
        Parameter #1 [  $model_name ]
        Parameter #2 [  $query_params = [] ]
        Parameter #3 [  $field_to_count = NULL ]
        Parameter #4 [  $distinct = false ]
      }
    }

    /**
     * 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 EE_Base_Class|int|string $id_or_obj
     * @param string                   $model_name   like 'Event', or 'Registration'
     * @param array|null               $query_params @see
     *                                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @param string                   $field_to_sum name of field to count by. By default, uses primary key
     * @return float
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method sum_related ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2823 - 2846

      - Parameters [4] {
        Parameter #0 [  $id_or_obj ]
        Parameter #1 [  $model_name ]
        Parameter #2 [  $query_params ]
        Parameter #3 [  $field_to_sum = NULL ]
      }
    }

    /**
     * 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|null          $query_params     @see
     *                                              https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @return EE_Base_Class
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method get_first_related ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2861 - 2869

      - Parameters [3] {
        Parameter #0 [  EE_Base_Class $id_or_obj ]
        Parameter #1 [  $other_model_name ]
        Parameter #2 [  $query_params ]
      }
    }

    /**
     * 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
     */
    Method [  public method get_this_model_name ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2877 - 2880
    }

    /**
     * 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
     */
    Method [  public method get_field_containing_related_model_name ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2889 - 2905
    }

    /**
     * Inserts a new entry into the database, for each table.
     * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
     * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
     * we also know there is no model object with the newly inserted item's ID at the moment (because
     * if there were, then they would already be in the DB and this would fail); and in the future if someone
     * creates a model object with this ID (or grabs it from the DB) then it will be added to the
     * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
     *
     * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
     *                              $values_already_prepared_by_model_object is false, in the model object's domain if
     *                              $values_already_prepared_by_model_object is true. See comment about this at the top
     *                              of EEM_Base)
     * @return int|string new primary key on main table that got inserted
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method insert ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2925 - 2953

      - Parameters [1] {
        Parameter #0 [  $field_n_values ]
      }
    }

    /**
     * Checks that the result would satisfy the unique indexes on this model
     *
     * @param array  $field_n_values
     * @param string $action
     * @return boolean
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  protected method _satisfies_unique_indexes ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 2965 - 2990

      - Parameters [2] {
        Parameter #0 [  array $field_n_values ]
        Parameter #1 [  $action = 'insert' ]
      }
    }

    /**
     * Checks the database for an item that conflicts (ie, if this item were
     * saved to the DB would break some uniqueness requirement, like a primary key
     * or an index primary key set) with the item specified. $id_obj_or_fields_array
     * can be either an EE_Base_Class or an array of fields n values
     *
     * @param EE_Base_Class|array $obj_or_fields_array
     * @param boolean             $include_primary_key whether to use the model object's primary key
     *                                                 when looking for conflicts
     *                                                 (ie, if false, we ignore the model object's primary key
     *                                                 when finding "conflicts". If true, it's also considered).
     *                                                 Only works for INT primary key,
     *                                                 STRING primary keys cannot be ignored
     * @return EE_Base_Class|array
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method get_one_conflicting ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3010 - 3049

      - Parameters [2] {
        Parameter #0 [  $obj_or_fields_array ]
        Parameter #1 [  $include_primary_key = true ]
      }
    }

    /**
     * Like count, but is optimized and returns a boolean instead of an int
     *
     * @param array $query_params
     * @return boolean
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method exists ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3060 - 3064

      - Parameters [1] {
        Parameter #0 [  $query_params ]
      }
    }

    /**
     * Wrapper for exists, except ignores default query parameters so we're only considering ID
     *
     * @param int|string $id
     * @return boolean
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method exists_by_ID ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3075 - 3085

      - Parameters [1] {
        Parameter #0 [  $id ]
      }
    }

    /**
     * Inserts a new row in $table, using the $cols_n_values which apply to that table.
     * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
     * we need to add a foreign key column to point to $new_id (which should be the primary key's value
     * on the main table)
     * This is protected rather than private because private is not accessible to any child methods and there MAY be
     * cases where we want to call it directly rather than via insert().
     *
     * @access   protected
     * @param EE_Table_Base $table
     * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
     *                                       float
     * @param int           $new_id          for now we assume only int keys
     * @return int ID of new row inserted, or FALSE on failure
     * @throws EE_Error
     * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
     */
    Method [  protected method _insert_into_specific_table ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3105 - 3151

      - Parameters [3] {
        Parameter #0 [  EE_Table_Base $table ]
        Parameter #1 [  $fields_n_values ]
        Parameter #2 [  $new_id = 0 ]
      }
    }

    /**
     * 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
     */
    Method [  protected method _prepare_value_or_use_default ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3164 - 3173

      - Parameters [2] {
        Parameter #0 [  $field_obj ]
        Parameter #1 [  $fields_n_values ]
      }
    }

    /**
     * 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
     */
    Method [  private method _prepare_value_for_use_in_db ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3188 - 3208

      - Parameters [2] {
        Parameter #0 [  $value ]
        Parameter #1 [  $field ]
      }
    }

    /**
     * Returns the main table on this model
     *
     * @return EE_Primary_Table
     * @throws EE_Error
     */
    Method [  protected method _get_main_table ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3217 - 3233
    }

    /**
     * table
     * returns EE_Primary_Table table name
     *
     * @return string
     * @throws EE_Error
     */
    Method [  public method table ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3243 - 3246
    }

    /**
     * table
     * returns first EE_Secondary_Table table name
     *
     * @return string
     */
    Method [  public method second_table ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3255 - 3262
    }

    /**
     * get_table_obj_by_alias
     * returns table name given it's alias
     *
     * @param string $table_alias
     * @return EE_Primary_Table | EE_Secondary_Table
     */
    Method [  public method get_table_obj_by_alias ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3272 - 3275

      - Parameters [1] {
        Parameter #0 [  $table_alias = '' ]
      }
    }

    /**
     * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
     *
     * @return EE_Secondary_Table[]
     */
    Method [  protected method _get_other_tables ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3283 - 3292
    }

    /**
     * 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[]
     */
    Method [  public method _get_fields_for_table ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3301 - 3304

      - Parameters [1] {
        Parameter #0 [  $table_alias ]
      }
    }

    /**
     * Recurses through all the where parameters, and finds all the related models we'll need
     * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
     * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
     * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
     * related Registration, Transaction, and Payment models.
     *
     * @param array $query_params @see
     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @return EE_Model_Query_Info_Carrier
     * @throws EE_Error
     */
    Method [  public method _extract_related_models_from_query ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3319 - 3371

      - Parameters [1] {
        Parameter #0 [  $query_params ]
      }
    }

    /**
     * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
     *
     * @param array                       $sub_query_params
     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
     * @param string                      $query_param_type one of $this->_allowed_query_params
     * @return EE_Model_Query_Info_Carrier
     * @throws EE_Error
     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#-0-where-conditions
     */
    Method [  private method _extract_related_models_from_sub_params_array_keys ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3384 - 3452

      - Parameters [3] {
        Parameter #0 [  $sub_query_params ]
        Parameter #1 [  EE_Model_Query_Info_Carrier $model_query_info_carrier ]
        Parameter #2 [  $query_param_type ]
      }
    }

    /**
     * For extracting related models from forced_joins, where the array values contain the info about what
     * models to join with. Eg an array like array('Attendee','Price.Price_Type');
     *
     * @param array                       $sub_query_params @see
     *                                                      https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
     * @param string                      $query_param_type one of $this->_allowed_query_params
     * @return EE_Model_Query_Info_Carrier
     * @throws EE_Error
     */
    Method [  private method _extract_related_models_from_sub_params_array_values ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3466 - 3490

      - Parameters [3] {
        Parameter #0 [  $sub_query_params ]
        Parameter #1 [  EE_Model_Query_Info_Carrier $model_query_info_carrier ]
        Parameter #2 [  $query_param_type ]
      }
    }

    /**
     * Extract all the query parts from  model query params
     * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
     * instead of directly constructing the SQL because often we need to extract info from the $query_params
     * but use them in a different order. Eg, we need to know what models we are querying
     * before we know what joins to perform. However, we need to know what data types correspond to which fields on
     * other models before we can finalize the where clause SQL.
     *
     * @param array $query_params
     * @return EE_Model_Query_Info_Carrier
     * @throws EE_Error
     * @throws ModelConfigurationException
     * @throws ReflectionException
     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     */
    Method [  public method _create_model_query_info_carrier ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3508 - 3709

      - Parameters [1] {
        Parameter #0 [  $query_params ]
      }
    }

    /**
     * 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 @see
     *                        https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
     * @throws EE_Error
     */
    Method [  public method caps_where_conditions ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3721 - 3739

      - Parameters [1] {
        Parameter #0 [  $context = self::caps_read ]
      }
    }

    /**
     * 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
     */
    Method [  private method _extract_order ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3750 - 3765

      - Parameters [1] {
        Parameter #0 [  $should_be_order_string ]
      }
    }

    /**
     * Looks at all the models which are included in this query, and asks each
     * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
     * so they can be merged
     *
     * @param EE_Model_Query_Info_Carrier $query_info_carrier
     * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
     *                                                                  'none' means NO default where conditions will
     *                                                                  be used AT ALL during this query.
     *                                                                  'other_models_only' means default where
     *                                                                  conditions from other models will be used, but
     *                                                                  not for this primary model. 'all', the default,
     *                                                                  means default where conditions will apply as
     *                                                                  normal
     * @param array                       $where_query_params
     * @return array
     * @throws EE_Error
     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params
     *                                                                  .md#0-where-conditions
     */
    Method [  private method _get_default_where_conditions_for_models_in_query ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3788 - 3836

      - Parameters [3] {
        Parameter #0 [  EE_Model_Query_Info_Carrier $query_info_carrier ]
        Parameter #1 [  $use_default_where_conditions = EE_Default_Where_Conditions::ALL ]
        Parameter #2 [  $where_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
     */
    Method [  private method _should_use_default_where_conditions ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3851 - 3876

      - Parameters [2] {
        Parameter #0 [  $default_where_conditions_value ]
        Parameter #1 [  $for_this_model = 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
     */
    Method [  private method _should_use_minimum_where_conditions ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3891 - 3908

      - Parameters [2] {
        Parameter #0 [  $default_where_conditions_value ]
        Parameter #1 [  $for_this_model = 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 @see
     *                                      https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
     * @throws EE_Error
     */
    Method [  private method _override_defaults_or_make_null_friendly ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3925 - 3952

      - Parameters [4] {
        Parameter #0 [  $default_where_conditions ]
        Parameter #1 [  $provided_where_conditions ]
        Parameter #2 [  $model ]
        Parameter #3 [  $model_relation_path ]
      }
    }

    /**
     * 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 @see
     *                                    https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
     * @throws EE_Error
     * @throws EE_Error
     */
    Method [  private method _get_default_where_conditions ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3967 - 3973

      - Parameters [1] {
        Parameter #0 [  $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 @see
     *                                    https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
     * @throws EE_Error
     * @throws EE_Error
     */
    Method [  protected method _get_minimum_where_conditions ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 3989 - 3995

      - Parameters [1] {
        Parameter #0 [  $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
     */
    Method [  private method _construct_default_select_sql ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4006 - 4019

      - Parameters [1] {
        Parameter #0 [  EE_Model_Query_Info_Carrier $model_query_info ]
      }
    }

    /**
     * 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'"
     */
    Method [  public method _get_columns_to_select_for_this_model ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4029 - 4062

      - Parameters [1] {
        Parameter #0 [  $model_relation_chain = '' ]
      }
    }

    /**
     * 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
     * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
     * @throws EE_Error
     */
    Method [  private method _extract_related_model_info_from_query_param ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4084 - 4183

      - Parameters [4] {
        Parameter #0 [  $query_param ]
        Parameter #1 [  EE_Model_Query_Info_Carrier $passed_in_query_info ]
        Parameter #2 [  $query_param_type ]
        Parameter #3 [  $original_query_param = NULL ]
      }
    }

    /**
     * Extracts any possible join model information from the provided possible_join_string.
     * This method will read the provided $possible_join_string value and determine if there are any possible model
     * join
     * parts that should be added to the query.
     *
     * @param EE_Model_Query_Info_Carrier $query_info_carrier
     * @param string                      $possible_join_string  Such as Registration.REG_ID, or Registration
     * @param null|string                 $original_query_param
     * @param string                      $query_parameter_type  The type for the source of the $possible_join_string
     *                                                           ('where', 'order_by', 'group_by', 'custom_selects'
     *                                                           etc.)
     * @return bool  returns true if a join was added and false if not.
     * @throws EE_Error
     */
    Method [  private method extractJoinModelFromQueryParams ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4201 - 4246

      - Parameters [4] {
        Parameter #0 [  EE_Model_Query_Info_Carrier $query_info_carrier ]
        Parameter #1 [  $possible_join_string ]
        Parameter #2 [  $original_query_param ]
        Parameter #3 [  $query_parameter_type ]
      }
    }

    /**
     * Extracts related models from Custom Selects and sets up any joins for those related models.
     *
     * @param EE_Model_Query_Info_Carrier $query_info_carrier
     * @throws EE_Error
     */
    Method [  private method extractRelatedModelsFromCustomSelects ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4255 - 4274

      - Parameters [1] {
        Parameter #0 [  EE_Model_Query_Info_Carrier $query_info_carrier ]
      }
    }

    /**
     * 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
     */
    Method [  private method _add_join_to_model ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4296 - 4328

      - Parameters [3] {
        Parameter #0 [  $model_name ]
        Parameter #1 [  EE_Model_Query_Info_Carrier $passed_in_query_info ]
        Parameter #2 [  $original_query_param ]
      }
    }

    /**
     * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
     *
     * @param array $where_params @see
     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
     * @return string of SQL
     * @throws EE_Error
     */
    Method [  private method _construct_where_clause ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4339 - 4346

      - Parameters [1] {
        Parameter #0 [  $where_params ]
      }
    }

    /**
     * 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
     */
    Method [  private method _construct_having_clause ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4357 - 4364

      - Parameters [1] {
        Parameter #0 [  $having_params ]
      }
    }

    /**
     * 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
     *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
     * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
     * @return string of SQL
     * @throws EE_Error
     */
    Method [  private method _construct_condition_clause_recursive ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4377 - 4437

      - Parameters [2] {
        Parameter #0 [  $where_params ]
        Parameter #1 [  $glue = ' AND' ]
      }
    }

    /**
     * Takes the input parameter and extract the table name (alias) and column name
     *
     * @param string $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
     * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
     * @throws EE_Error
     */
    Method [  private method _deduce_column_name_from_query_param ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4447 - 4478

      - Parameters [1] {
        Parameter #0 [  $query_param ]
      }
    }

    /**
     * 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
     */
    Method [  private method _remove_stars_and_anything_after_from_condition_query_param_key ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4490 - 4497

      - Parameters [1] {
        Parameter #0 [  $condition_query_param_key ]
      }
    }

    /**
     * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
     *
     * @param array|string               $op_and_value
     * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
     * @return string
     * @throws EE_Error
     */
    Method [  private method _construct_op_and_value ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4508 - 4618

      - Parameters [2] {
        Parameter #0 [  $op_and_value ]
        Parameter #1 [  $field_obj ]
      }
    }

    /**
     * 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
     */
    Method [  public method _construct_between_value ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4630 - 4637

      - Parameters [2] {
        Parameter #0 [  $values ]
        Parameter #1 [  $field_obj ]
      }
    }

    /**
     * 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
     */
    Method [  public method _construct_in_value ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4652 - 4675

      - Parameters [2] {
        Parameter #0 [  $values ]
        Parameter #1 [  $field_obj ]
      }
    }

    /**
     * @param mixed                      $value
     * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
     * @return false|null|string
     * @throws EE_Error
     */
    Method [  private method _wpdb_prepare_using_field ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4684 - 4704

      - Parameters [2] {
        Parameter #0 [  $value ]
        Parameter #1 [  $field_obj ]
      }
    }

    /**
     * Takes the input parameter and finds the model field that it indicates.
     *
     * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
     * @return EE_Model_Field_Base
     * @throws EE_Error
     */
    Method [  protected method _deduce_field_from_query_param ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4714 - 4745

      - Parameters [1] {
        Parameter #0 [  $query_param_name ]
      }
    }

    /**
     * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
     * alias and column which corresponds to it
     *
     * @param string $field_name
     * @return string
     * @throws EE_Error
     */
    Method [  public method _get_qualified_column_for_field ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4756 - 4773

      - Parameters [1] {
        Parameter #0 [  $field_name ]
      }
    }

    /**
     * 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( '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
     */
    Method [  public method get_qualified_columns_for_all_fields ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4827 - 4839

      - Parameters [2] {
        Parameter #0 [  $model_relation_chain = '' ]
        Parameter #1 [  $return_string = true ]
      }
    }

    /**
     * constructs the select use on special limit joins
     * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
     * its setup so the select query will be setup on and just doing the special select join off of the primary table
     * (as that is typically where the limits would be set).
     *
     * @param string       $table_alias The table the select is being built for
     * @param mixed|string $limit       The limit for this select
     * @return string                The final select join element for the query.
     * @throws EE_Error
     * @throws EE_Error
     */
    Method [  public method _construct_limit_join_select ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4854 - 4869

      - Parameters [2] {
        Parameter #0 [  $table_alias ]
        Parameter #1 [  $limit ]
      }
    }

    /**
     * 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
     */
    Method [  public method _construct_internal_join ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4879 - 4884
    }

    /**
     * Constructs the SQL for joining all the tables on this model.
     * Normally $alias should be the primary table's alias, but in cases where
     * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
     * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
     * alias, this will construct SQL like:
     * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
     * With $alias being a secondary table's alias, this will construct SQL like:
     * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
     *
     * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
     * @return string
     * @throws EE_Error
     * @throws EE_Error
     */
    Method [  public method _construct_internal_join_to_table_with_alias ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4902 - 4920

      - Parameters [1] {
        Parameter #0 [  $alias_prefixed ]
      }
    }

    /**
     * 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
     */
    Method [  public method _get_data_types ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4930 - 4939
    }

    /**
     * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
     *
     * @param string $model_name
     * @return EEM_Base
     * @throws EE_Error
     */
    Method [  public method get_related_model_obj ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4949 - 4965

      - Parameters [1] {
        Parameter #0 [  $model_name ]
      }
    }

    /**
     * Returns the array of EE_ModelRelations for this model.
     *
     * @return EE_Model_Relation_Base[]
     */
    Method [  public method relation_settings ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4973 - 4976
    }

    /**
     * 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[]
     */
    Method [  public method belongs_to_relations ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 4986 - 4995
    }

    /**
     * Returns the specified EE_Model_Relation, or throws an exception
     *
     * @param string $relation_name name of relation, key in $this->_relatedModels
     * @return EE_Model_Relation_Base
     * @throws EE_Error
     */
    Method [  public method related_settings_for ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5005 - 5022

      - Parameters [1] {
        Parameter #0 [  $relation_name ]
      }
    }

    /**
     * A convenience method for getting a specific field's settings, instead of getting all field settings for all
     * fields
     *
     * @param string  $fieldName
     * @param boolean $include_db_only_fields
     * @return EE_Model_Field_Base
     * @throws EE_Error
     */
    Method [  public method field_settings_for ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5034 - 5047

      - Parameters [2] {
        Parameter #0 [  $fieldName ]
        Parameter #1 [  $include_db_only_fields = true ]
      }
    }

    /**
     * Checks if this field exists on this model
     *
     * @param string $fieldName a key in the model's _field_settings array
     * @return boolean
     */
    Method [  public method has_field ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5056 - 5063

      - Parameters [1] {
        Parameter #0 [  $fieldName ]
      }
    }

    /**
     * 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
     */
    Method [  public method has_relation ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5072 - 5079

      - Parameters [1] {
        Parameter #0 [  $relation_name ]
      }
    }

    /**
     * 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
     */
    Method [  public method is_primary_key_field ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5089 - 5092

      - Parameters [1] {
        Parameter #0 [  $field_obj ]
      }
      - Return [ bool ]
    }

    /**
     * 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_Primary_Key_Field_Base
     * @throws EE_Error
     */
    Method [  public method get_primary_key_field ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5102 - 5121
    }

    /**
     * Returns whether or not not there is a primary key on this model.
     * Internally does some caching.
     *
     * @return boolean
     */
    Method [  public method has_primary_key_field ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5130 - 5141
    }

    /**
     * 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
     */
    Method [  public method get_a_field_of_type ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5151 - 5159

      - Parameters [1] {
        Parameter #0 [  $field_class_name ]
      }
    }

    /**
     * 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
     */
    Method [  public method get_foreign_key_to ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5169 - 5195

      - Parameters [1] {
        Parameter #0 [  $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
     */
    Method [  public method get_table_for_alias ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5206 - 5211

      - Parameters [1] {
        Parameter #0 [  $table_alias ]
      }
    }

    /**
     * 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
     */
    Method [  public method field_settings ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5221 - 5246

      - Parameters [1] {
        Parameter #0 [  $include_db_only_fields = false ]
      }
    }

    /**
     *        cycle though array of attendees and create objects out of each item
     *
     * @access        private
     * @param array $rows        of results of $wpdb->get_results($query,ARRAY_A)
     * @return EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
     *                           numerically indexed)
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  protected method _create_objects ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5259 - 5332

      - Parameters [1] {
        Parameter #0 [  $rows = [] ]
      }
    }

    /**
     * This will parse a given row of results from the db and see if any keys in the results match an alias within the
     * current CustomSelects object. This will be used to build an array of values indexed by those keys.
     *
     * @param array $db_results_row
     * @return array
     */
    Method [  protected method getValuesForCustomSelectAliasesFromResults ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5342 - 5356

      - Parameters [1] {
        Parameter #0 [  array $db_results_row ]
      }
    }

    /**
     * This will set the value for the given alias
     *
     * @param string $value
     * @param string $datatype (one of %d, %s, %f)
     * @return int|string|float (int for %d, string for %s, float for %f)
     */
    Method [  protected method convertValueToDataType ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5366 - 5376

      - Parameters [2] {
        Parameter #0 [  $value ]
        Parameter #1 [  $datatype ]
      }
    }

    /**
     * The purpose of this method is to allow us to create a model object that is not in the db that holds default
     * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
     * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
     * object (as set in the model_field!).
     *
     * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method create_default_object ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5389 - 5398
    }

    /**
     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
     *                             or an stdClass where each property is the name of a column,
     * @return EE_Base_Class
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method instantiate_class_from_array_or_object ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5408 - 5455

      - Parameters [1] {
        Parameter #0 [  $cols_n_values ]
      }
    }

    /**
     * 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
     */
    Method [  public method get_from_entity_map ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5464 - 5467

      - Parameters [1] {
        Parameter #0 [  $id ]
      }
    }

    /**
     * add_to_entity_map
     * Adds the object to the model's entity mappings
     *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
     *        and for the remainder of the request, it's even more up-to-date than what's in the database.
     *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
     *        If the database gets updated directly and you want the entity mapper to reflect that change,
     *        then this method should be called immediately after the update query
     * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
     * so on multisite, the entity map is specific to the query being done for a specific site.
     *
     * @param EE_Base_Class $object
     * @return EE_Base_Class
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method add_to_entity_map ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5486 - 5519

      - Parameters [1] {
        Parameter #0 [  EE_Base_Class $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
     */
    Method [  public method clear_entity_map ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5529 - 5540

      - Parameters [1] {
        Parameter #0 [  $id = NULL ]
      }
    }

    /**
     * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
     * Given an array where keys are column (or column alias) names and values,
     * returns an array of their corresponding field names and database values
     *
     * @param array $cols_n_values
     * @return array
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method deduce_fields_n_values_from_cols_n_values ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5553 - 5556

      - Parameters [1] {
        Parameter #0 [  array $cols_n_values ]
      }
      - Return [ array ]
    }

    /**
     * _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|stdClass $cols_n_values
     * @return array
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  protected method _deduce_fields_n_values_from_cols_n_values ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5569 - 5605

      - Parameters [1] {
        Parameter #0 [  $cols_n_values ]
      }
      - Return [ array ]
    }

    /**
     * @param $cols_n_values
     * @param $qualified_column
     * @param $regular_column
     * @return null
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  protected method _get_column_value_with_table_alias_or_not ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5616 - 5646

      - Parameters [3] {
        Parameter #0 [  $cols_n_values ]
        Parameter #1 [  $qualified_column ]
        Parameter #2 [  $regular_column ]
      }
    }

    /**
     * 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|EE_Soft_Delete_Base_Class|mixed|null
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method refresh_entity_map_from_db ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5659 - 5680

      - Parameters [1] {
        Parameter #0 [  $id ]
      }
    }

    /**
     * refresh_entity_map_with
     * Leaves the entry in the entity map alone, but updates it to match the provided
     * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
     * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
     * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
     *
     * @param int|string    $id
     * @param EE_Base_Class $replacing_model_obj
     * @return EE_Base_Class
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method refresh_entity_map_with ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5696 - 5716

      - Parameters [2] {
        Parameter #0 [  $id ]
        Parameter #1 [  $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
     */
    Method [  private method _get_class_name ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5726 - 5729
    }

    /**
     * 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|float|null $quantity
     * @return string
     */
    Method [  public method item_name ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5740 - 5752

      - Parameters [1] {
        Parameter #0 [  $quantity = 1 ]
      }
      - Return [ string ]
    }

    /**
     * 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');
     * echo EEM_Answer::instance()->my_callback('monkeys',100);
     * // will output "you called my_callback! and passed args:monkeys,100"
     *
     * @param string $methodName name of method which was called on a child of EE_TempBase, but which
     * @param array  $args       array of original arguments passed to the function
     * @return mixed whatever the plugin which calls add_filter decides
     * @throws EE_Error
     */
    Method [  public method __call ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5778 - 5797

      - Parameters [2] {
        Parameter #0 [  $methodName ]
        Parameter #1 [  $args ]
      }
    }

    /**
     * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
     * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
     *
     * @param EE_Base_Class|string|int $base_class_obj_or_id either:
     *                                                       the EE_Base_Class object that corresponds to this Model,
     *                                                       the object's class name
     *                                                       or object's ID
     * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
     *                                                       exists in the database. If it does not, we add it
     * @return EE_Base_Class
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method ensure_is_obj ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5814 - 5855

      - Parameters [2] {
        Parameter #0 [  $base_class_obj_or_id ]
        Parameter #1 [  $ensure_is_in_db = false ]
      }
    }

    /**
     * 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
     * @throws ReflectionException
     */
    Method [  public method ensure_is_ID ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5868 - 5894

      - Parameters [1] {
        Parameter #0 [  $base_class_obj_or_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
     */
    Method [  public method assume_values_already_prepared_by_model_object ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5914 - 5918

      - Parameters [1] {
        Parameter #0 [  $values_already_prepared = self::not_prepared_by_model_object ]
      }
    }

    /**
     * Read comments for assume_values_already_prepared_by_model_object()
     *
     * @return int
     */
    Method [  public method get_assumption_concerning_values_already_prepared_by_model_object ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5926 - 5929
    }

    /**
     * Gets all the indexes on this model
     *
     * @return EE_Index[]
     */
    Method [  public method indexes ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5937 - 5940
    }

    /**
     * Gets all the Unique Indexes on this model
     *
     * @return EE_Unique_Index[]
     */
    Method [  public method unique_indexes ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5948 - 5957
    }

    /**
     * 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
     */
    Method [  public method get_combined_primary_key_fields ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5969 - 5977
    }

    /**
     * Used to build a primary key string (when the model has no primary key),
     * which can be used a unique string to identify this model object.
     *
     * @param array $fields_n_values keys are field names, values are their values.
     *                               Note: if you have results from `EEM_Base::get_all_wpdb_results()`, you need to
     *                               run it through `EEM_Base::deduce_fields_n_values_from_cols_n_values()`
     *                               before passing it to this function (that will convert it from columns-n-values
     *                               to field-names-n-values).
     * @return string
     * @throws EE_Error
     */
    Method [  public method get_index_primary_key_string ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 5992 - 5999

      - Parameters [1] {
        Parameter #0 [  $fields_n_values ]
      }
    }

    /**
     * Gets the field values from the primary key string
     *
     * @param string $index_primary_key_string
     * @return null|array
     * @throws EE_Error
     * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
     */
    Method [  public method parse_index_primary_key_string ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6010 - 6022

      - Parameters [1] {
        Parameter #0 [  $index_primary_key_string ]
      }
    }

    /**
     * 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
     */
    Method [  public method has_all_combined_primary_key_fields ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6033 - 6042

      - Parameters [1] {
        Parameter #0 [  $key_vals ]
      }
    }

    /**
     * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
     * We consider something to be a copy if all the attributes match (except the ID, of course).
     *
     * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
     * @param array               $query_params                     @see
     *                                                              https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
     * @throws EE_Error
     * @throws ReflectionException
     * @return EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
     *                                                              indexed)
     */
    Method [  public method get_all_copies ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6057 - 6085

      - Parameters [2] {
        Parameter #0 [  $model_object_or_attributes_array ]
        Parameter #1 [  $query_params = [] ]
      }
    }

    /**
     * Gets the first copy we find. See get_all_copies for more details
     *
     * @param mixed EE_Base_Class | array        $model_object_or_attributes_array
     * @param array $query_params
     * @return EE_Base_Class
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method get_one_copy ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6097 - 6116

      - Parameters [2] {
        Parameter #0 [  $model_object_or_attributes_array ]
        Parameter #1 [  $query_params = [] ]
      }
    }

    /**
     * Updates the item with the specified id. Ignores default query parameters because
     * we have specified the ID, and its assumed we KNOW what we're doing
     *
     * @param array      $fields_n_values keys are field names, values are their new values
     * @param int|string $id              the value of the primary key to update
     * @return int number of rows updated
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method update_by_ID ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6129 - 6136

      - Parameters [2] {
        Parameter #0 [  $fields_n_values ]
        Parameter #1 [  $id ]
      }
    }

    /**
     * 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
     */
    Method [  private method _prepare_operator_for_sql ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6146 - 6162

      - Parameters [1] {
        Parameter #0 [  $operator_supplied ]
      }
    }

    /**
     * Gets the valid operators
     *
     * @return array keys are accepted strings, values are the SQL they are converted to
     */
    Method [  public method valid_operators ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6170 - 6173
    }

    /**
     * Gets the between-style operators (take 2 arguments).
     *
     * @return array keys are accepted strings, values are the SQL they are converted to
     */
    Method [  public method valid_between_style_operators ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6181 - 6187
    }

    /**
     * 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
     */
    Method [  public method valid_like_style_operators ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6195 - 6201
    }

    /**
     * Gets the "in"-style operators
     *
     * @return array keys are accepted strings, values are the SQL they are converted to
     */
    Method [  public method valid_in_style_operators ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6209 - 6215
    }

    /**
     * Gets the "null"-style operators (accept no arguments)
     *
     * @return array keys are accepted strings, values are the SQL they are converted to
     */
    Method [  public method valid_null_style_operators ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6223 - 6229
    }

    /**
     * Gets an array where keys are the primary keys and values are their 'names'
     * (as determined by the model object's name() function, which is often overridden)
     *
     * @param array $query_params like get_all's
     * @return string[]
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method get_all_names ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6241 - 6249

      - Parameters [1] {
        Parameter #0 [  $query_params = [] ]
      }
    }

    /**
     * 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
     * @throws ReflectionException
     */
    Method [  public method get_IDs ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6265 - 6299

      - Parameters [2] {
        Parameter #0 [  $model_objects ]
        Parameter #1 [  $filter_out_empty_ids = false ]
      }
    }

    /**
     * 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
     */
    Method [  public method cap_slug ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6308 - 6311
    }

    /**
     * Returns the capability-restrictions array (@param string $context
     *
     * @return EE_Default_Where_Conditions[] indexed by associated capability
     * @throws EE_Error
     * @see EEM_Base::_cap_restrictions).
     *      If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
     *      only returns the cap restrictions array in that context (ie, the array
     *      at that key)
     */
    Method [  public method cap_restrictions ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6324 - 6345

      - Parameters [1] {
        Parameter #0 [  $context = EEM_Base::caps_read ]
      }
    }

    /**
     * Indicating whether or not this model thinks its a wp core model
     *
     * @return boolean
     */
    Method [  public method is_wp_core_model ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6353 - 6356
    }

    /**
     * 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
     */
    Method [  public method caps_missing ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6367 - 6380

      - Parameters [1] {
        Parameter #0 [  $context = EEM_Base::caps_read ]
      }
    }

    /**
     * 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'
     */
    Method [  public method cap_contexts_to_cap_action_map ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6389 - 6396
    }

    /**
     * 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
     */
    Method [  public method cap_action_for_context ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6406 - 6425

      - Parameters [1] {
        Parameter #0 [  $context ]
      }
    }

    /**
     * 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
     */
    Method [  protected method _invalidate_field_caches ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6498 - 6503
    }

    /**
     * Gets the list of all the where query param keys that relate to logic instead of field names
     * (eg "and", "or", "not").
     *
     * @return array
     */
    Method [  public method logic_query_param_keys ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6512 - 6515

      - Parameters [0] {
      }
      - Return [ array ]
    }

    /**
     * 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
     */
    Method [  public method is_logic_query_param_key ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6526 - 6537

      - Parameters [1] {
        Parameter #0 [  $query_param_key ]
      }
      - Return [ bool ]
    }

    /**
     * Returns true if this model has a password field on it (regardless of whether that password field has any content)
     *
     * @return boolean
     * @since 4.9.74.p
     */
    Method [  public method hasPassword ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6546 - 6554

      - Parameters [0] {
      }
      - Return [ bool ]
    }

    /**
     * Returns the password field on this model, if there is one
     *
     * @return EE_Password_Field|null
     * @since 4.9.74.p
     */
    Method [  public method getPasswordField ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6563 - 6572
    }

    /**
     * Returns the list of field (as EE_Model_Field_Bases) that are protected by the password
     *
     * @return EE_Model_Field_Base[]
     * @throws EE_Error
     * @since 4.9.74.p
     */
    Method [  public method getPasswordProtectedFields ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6582 - 6593
    }

    /**
     * Checks if the current user can perform the requested action on this model
     *
     * @param string              $cap_to_check one of the array keys from _cap_contexts_to_cap_action_map
     * @param EE_Base_Class|array $model_obj_or_fields_n_values
     * @return bool
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     * @throws ReflectionException
     * @throws UnexpectedEntityException
     * @since 4.9.74.p
     */
    Method [  public method currentUserCan ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6610 - 6637

      - Parameters [2] {
        Parameter #0 [  $cap_to_check ]
        Parameter #1 [  $model_obj_or_fields_n_values ]
      }
    }

    /**
     * Returns the query param where conditions key to the password affecting this model.
     * Eg on EEM_Event this would just be "password", on EEM_Datetime this would be "Event.password", etc.
     *
     * @return null|string
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     * @throws ModelConfigurationException
     * @throws ReflectionException
     * @since 4.9.74.p
     */
    Method [  public method modelChainAndPassword ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6653 - 6700
    }

    /**
     * Returns true if there is a password on a related model which restricts access to some of this model's rows,
     * or if this model itself has a password affecting access to some of its other fields.
     *
     * @return boolean
     * @since 4.9.74.p
     */
    Method [  public method restrictedByRelatedModelPassword ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/db_models/EEM_Base.model.php 6710 - 6713

      - Parameters [0] {
      }
      - Return [ bool ]
    }

    /**
     * override magic methods
     * @return void
     */
    Method [  public method __get ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/EE_Base.core.php 18 - 21

      - Parameters [1] {
        Parameter #0 [  $a ]
      }
    }

    Method [  public method __set ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/EE_Base.core.php 23 - 26

      - Parameters [2] {
        Parameter #0 [  $a ]
        Parameter #1 [  $b ]
      }
    }

    Method [  public method __isset ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/EE_Base.core.php 28 - 31

      - Parameters [1] {
        Parameter #0 [  $a ]
      }
    }

    Method [  public method __unset ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/EE_Base.core.php 33 - 36

      - Parameters [1] {
        Parameter #0 [  $a ]
      }
    }

    Method [  public method __clone ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/EE_Base.core.php 38 - 41
    }

    Method [  public method __wakeup ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/EE_Base.core.php 43 - 46
    }

    Method [  public method __destruct ] {
      @@ /var/www/swallowinginnovators/wp-content/plugins/event-espresso-core-reg/core/EE_Base.core.php 48 - 51
    }
  }
}