Completed
Branch FET-10260-expose-default-query... (8b9673)
by
unknown
75:49 queued 65:29
created
core/db_models/EEM_Base.model.php 3 patches
Doc Comments   +18 added lines, -16 removed lines patch added patch discarded remove patch
@@ -961,7 +961,7 @@  discard block
 block discarded – undo
961 961
      *  on this model (or follows the _model_chain_to_wp_user and uses that model's
962 962
      * foreign key to the WP_User table)
963 963
      *
964
-     * @return string|boolean string on success, boolean false when there is no
964
+     * @return string|false string on success, boolean false when there is no
965 965
      * foreign key to the WP_User table
966 966
      */
967 967
     public function wp_user_field_name()
@@ -1067,7 +1067,7 @@  discard block
 block discarded – undo
1067 1067
      *
1068 1068
      * @param array  $query_params      like EEM_Base::get_all's $query_params
1069 1069
      * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1070
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1070
+     * @param string  $columns_to_select , What columns to select. By default, we select all columns specified by the
1071 1071
      *                                  fields on the model, and the models we joined to in the query. However, you can
1072 1072
      *                                  override this and set the select to "*", or a specific column name, like
1073 1073
      *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
@@ -1459,7 +1459,7 @@  discard block
 block discarded – undo
1459 1459
      * @param string $field_name The name of the field the formats are being retrieved for.
1460 1460
      * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1461 1461
      * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1462
-     * @return array formats in an array with the date format first, and the time format last.
1462
+     * @return string[] formats in an array with the date format first, and the time format last.
1463 1463
      */
1464 1464
     public function get_formats_for($field_name, $pretty = false)
1465 1465
     {
@@ -1492,7 +1492,7 @@  discard block
 block discarded – undo
1492 1492
      *                                 be returned.
1493 1493
      * @param string $what             Whether to return the string in just the time format, the date format, or both.
1494 1494
      * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1495
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1495
+     * @return string|null  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1496 1496
      *                                 exception is triggered.
1497 1497
      */
1498 1498
     public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
@@ -1830,7 +1830,7 @@  discard block
 block discarded – undo
1830 1830
      * Wrapper for EEM_Base::delete_permanently()
1831 1831
      *
1832 1832
      * @param mixed $id
1833
-     * @return boolean whether the row got deleted or not
1833
+     * @return integer whether the row got deleted or not
1834 1834
      * @throws \EE_Error
1835 1835
      */
1836 1836
     public function delete_permanently_by_ID($id)
@@ -1850,7 +1850,7 @@  discard block
 block discarded – undo
1850 1850
      * Wrapper for EEM_Base::delete()
1851 1851
      *
1852 1852
      * @param mixed $id
1853
-     * @return boolean whether the row got deleted or not
1853
+     * @return integer whether the row got deleted or not
1854 1854
      * @throws \EE_Error
1855 1855
      */
1856 1856
     public function delete_by_ID($id)
@@ -2300,7 +2300,7 @@  discard block
 block discarded – undo
2300 2300
      * Verifies the EE addons' database is up-to-date and records that we've done it on
2301 2301
      * EEM_Base::$_db_verification_level
2302 2302
      *
2303
-     * @param $wpdb_method
2303
+     * @param string $wpdb_method
2304 2304
      * @param $arguments_to_provide
2305 2305
      * @return string
2306 2306
      */
@@ -2424,6 +2424,7 @@  discard block
 block discarded – undo
2424 2424
      *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2425 2425
      *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2426 2426
      *                             because these will be inserted in any new rows created as well.
2427
+     * @param EE_Base_Class $id_or_obj
2427 2428
      */
2428 2429
     public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2429 2430
     {
@@ -2434,7 +2435,7 @@  discard block
 block discarded – undo
2434 2435
 
2435 2436
 
2436 2437
     /**
2437
-     * @param mixed           $id_or_obj
2438
+     * @param EE_Base_Class           $id_or_obj
2438 2439
      * @param string          $relationName
2439 2440
      * @param array           $where_query_params
2440 2441
      * @param EE_Base_Class[] objects to which relations were removed
@@ -2475,7 +2476,7 @@  discard block
 block discarded – undo
2475 2476
      * However, if the model objects can't be deleted because of blocking related model objects, then
2476 2477
      * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2477 2478
      *
2478
-     * @param EE_Base_Class|int|string $id_or_obj
2479
+     * @param EE_Base_Class $id_or_obj
2479 2480
      * @param string                   $model_name
2480 2481
      * @param array                    $query_params
2481 2482
      * @return int how many deleted
@@ -2496,7 +2497,7 @@  discard block
 block discarded – undo
2496 2497
      * the model objects can't be hard deleted because of blocking related model objects,
2497 2498
      * just does a soft-delete on them instead.
2498 2499
      *
2499
-     * @param EE_Base_Class|int|string $id_or_obj
2500
+     * @param EE_Base_Class $id_or_obj
2500 2501
      * @param string                   $model_name
2501 2502
      * @param array                    $query_params
2502 2503
      * @return int how many deleted
@@ -2553,6 +2554,7 @@  discard block
 block discarded – undo
2553 2554
      * @param string $model_name   like 'Event', or 'Registration'
2554 2555
      * @param array  $query_params like EEM_Base::get_all's
2555 2556
      * @param string $field_to_sum name of field to count by. By default, uses primary key
2557
+     * @param EE_Base_Class $id_or_obj
2556 2558
      * @return float
2557 2559
      * @throws \EE_Error
2558 2560
      */
@@ -3023,7 +3025,7 @@  discard block
 block discarded – undo
3023 3025
      * Finds all the fields that correspond to the given table
3024 3026
      *
3025 3027
      * @param string $table_alias , array key in EEM_Base::_tables
3026
-     * @return EE_Model_Field_Base[]
3028
+     * @return EE_Model_Field_Base
3027 3029
      */
3028 3030
     public function _get_fields_for_table($table_alias)
3029 3031
     {
@@ -3508,7 +3510,7 @@  discard block
 block discarded – undo
3508 3510
      * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3509 3511
      * We should use default where conditions on related models when they requested to use default where conditions
3510 3512
      * on all models, or specifically just on other related models
3511
-     * @param      $default_where_conditions_value
3513
+     * @param      string $default_where_conditions_value
3512 3514
      * @param bool $for_this_model false means this is for OTHER related models
3513 3515
      * @return bool
3514 3516
      */
@@ -3546,7 +3548,7 @@  discard block
 block discarded – undo
3546 3548
      * where conditions.
3547 3549
      * We should use minimum where conditions on related models if they requested to use minimum where conditions
3548 3550
      * on this model or others
3549
-     * @param      $default_where_conditions_value
3551
+     * @param      string $default_where_conditions_value
3550 3552
      * @param bool $for_this_model false means this is for OTHER related models
3551 3553
      * @return bool
3552 3554
      */
@@ -4536,7 +4538,7 @@  discard block
 block discarded – undo
4536 4538
      * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4537 4539
      * Eg, on EE_Answer that would be ANS_ID field object
4538 4540
      *
4539
-     * @param $field_obj
4541
+     * @param EE_Model_Field_Base $field_obj
4540 4542
      * @return boolean
4541 4543
      */
4542 4544
     public function is_primary_key_field($field_obj)
@@ -4647,7 +4649,7 @@  discard block
 block discarded – undo
4647 4649
      * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4648 4650
      *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4649 4651
      *                            Either one works
4650
-     * @return EE_Table_Base
4652
+     * @return string
4651 4653
      */
4652 4654
     public function get_table_for_alias($table_alias)
4653 4655
     {
@@ -5258,7 +5260,7 @@  discard block
 block discarded – undo
5258 5260
     /**
5259 5261
      * Read comments for assume_values_already_prepared_by_model_object()
5260 5262
      *
5261
-     * @return int
5263
+     * @return boolean
5262 5264
      */
5263 5265
     public function get_assumption_concerning_values_already_prepared_by_model_object()
5264 5266
     {
Please login to merge, or discard this patch.
Indentation   +5719 added lines, -5719 removed lines patch added patch discarded remove patch
@@ -29,5727 +29,5727 @@
 block discarded – undo
29 29
 abstract class EEM_Base extends EE_Base
30 30
 {
31 31
 
32
-    //admin posty
33
-    //basic -> grants access to mine -> if they don't have it, select none
34
-    //*_others -> grants access to others that arent private, and all mine -> if they don't have it, select mine
35
-    //*_private -> grants full access -> if dont have it, select all mine and others' non-private
36
-    //*_published -> grants access to published -> if they dont have it, select non-published
37
-    //*_global/default/system -> grants access to global items -> if they don't have it, select non-global
38
-    //publish_{thing} -> can change status TO publish; SPECIAL CASE
39
-    //frontend posty
40
-    //by default has access to published
41
-    //basic -> grants access to mine that arent published, and all published
42
-    //*_others ->grants access to others that arent private, all mine
43
-    //*_private -> grants full access
44
-    //frontend non-posty
45
-    //like admin posty
46
-    //category-y
47
-    //assign -> grants access to join-table
48
-    //(delete, edit)
49
-    //payment-method-y
50
-    //for each registered payment method,
51
-    //ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
52
-    /**
53
-     * Flag to indicate whether the values provided to EEM_Base have already been prepared
54
-     * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
55
-     * They almost always WILL NOT, but it's not necessarily a requirement.
56
-     * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
57
-     *
58
-     * @var boolean
59
-     */
60
-    private $_values_already_prepared_by_model_object = 0;
61
-
62
-    /**
63
-     * when $_values_already_prepared_by_model_object equals this, we assume
64
-     * the data is just like form input that needs to have the model fields'
65
-     * prepare_for_set and prepare_for_use_in_db called on it
66
-     */
67
-    const not_prepared_by_model_object = 0;
68
-
69
-    /**
70
-     * when $_values_already_prepared_by_model_object equals this, we
71
-     * assume this value is coming from a model object and doesn't need to have
72
-     * prepare_for_set called on it, just prepare_for_use_in_db is used
73
-     */
74
-    const prepared_by_model_object = 1;
75
-
76
-    /**
77
-     * when $_values_already_prepared_by_model_object equals this, we assume
78
-     * the values are already to be used in the database (ie no processing is done
79
-     * on them by the model's fields)
80
-     */
81
-    const prepared_for_use_in_db = 2;
82
-
83
-
84
-    protected $singular_item = 'Item';
85
-
86
-    protected $plural_item   = 'Items';
87
-
88
-    /**
89
-     * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
90
-     */
91
-    protected $_tables;
92
-
93
-    /**
94
-     * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
95
-     * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
96
-     * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
97
-     *
98
-     * @var \EE_Model_Field_Base[] $_fields
99
-     */
100
-    protected $_fields;
101
-
102
-    /**
103
-     * array of different kinds of relations
104
-     *
105
-     * @var \EE_Model_Relation_Base[] $_model_relations
106
-     */
107
-    protected $_model_relations;
108
-
109
-    /**
110
-     * @var \EE_Index[] $_indexes
111
-     */
112
-    protected $_indexes = array();
113
-
114
-    /**
115
-     * Default strategy for getting where conditions on this model. This strategy is used to get default
116
-     * where conditions which are added to get_all, update, and delete queries. They can be overridden
117
-     * by setting the same columns as used in these queries in the query yourself.
118
-     *
119
-     * @var EE_Default_Where_Conditions
120
-     */
121
-    protected $_default_where_conditions_strategy;
122
-
123
-    /**
124
-     * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
125
-     * This is particularly useful when you want something between 'none' and 'default'
126
-     *
127
-     * @var EE_Default_Where_Conditions
128
-     */
129
-    protected $_minimum_where_conditions_strategy;
130
-
131
-    /**
132
-     * String describing how to find the "owner" of this model's objects.
133
-     * When there is a foreign key on this model to the wp_users table, this isn't needed.
134
-     * But when there isn't, this indicates which related model, or transiently-related model,
135
-     * has the foreign key to the wp_users table.
136
-     * Eg, for EEM_Registration this would be 'Event' because registrations are directly
137
-     * related to events, and events have a foreign key to wp_users.
138
-     * On EEM_Transaction, this would be 'Transaction.Event'
139
-     *
140
-     * @var string
141
-     */
142
-    protected $_model_chain_to_wp_user = '';
143
-
144
-    /**
145
-     * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
146
-     * don't need it (particularly CPT models)
147
-     *
148
-     * @var bool
149
-     */
150
-    protected $_ignore_where_strategy = false;
151
-
152
-    /**
153
-     * String used in caps relating to this model. Eg, if the caps relating to this
154
-     * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
155
-     *
156
-     * @var string. If null it hasn't been initialized yet. If false then we
157
-     * have indicated capabilities don't apply to this
158
-     */
159
-    protected $_caps_slug = null;
160
-
161
-    /**
162
-     * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
163
-     * and next-level keys are capability names, and each's value is a
164
-     * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
165
-     * they specify which context to use (ie, frontend, backend, edit or delete)
166
-     * and then each capability in the corresponding sub-array that they're missing
167
-     * adds the where conditions onto the query.
168
-     *
169
-     * @var array
170
-     */
171
-    protected $_cap_restrictions = array(
172
-        self::caps_read       => array(),
173
-        self::caps_read_admin => array(),
174
-        self::caps_edit       => array(),
175
-        self::caps_delete     => array(),
176
-    );
177
-
178
-    /**
179
-     * Array defining which cap restriction generators to use to create default
180
-     * cap restrictions to put in EEM_Base::_cap_restrictions.
181
-     * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
182
-     * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
183
-     * automatically set this to false (not just null).
184
-     *
185
-     * @var EE_Restriction_Generator_Base[]
186
-     */
187
-    protected $_cap_restriction_generators = array();
188
-
189
-    /**
190
-     * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
191
-     */
192
-    const caps_read       = 'read';
193
-
194
-    const caps_read_admin = 'read_admin';
195
-
196
-    const caps_edit       = 'edit';
197
-
198
-    const caps_delete     = 'delete';
199
-
200
-    /**
201
-     * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
202
-     * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
203
-     * maps to 'read' because when looking for relevant permissions we're going to use
204
-     * 'read' in teh capabilities names like 'ee_read_events' etc.
205
-     *
206
-     * @var array
207
-     */
208
-    protected $_cap_contexts_to_cap_action_map = array(
209
-        self::caps_read       => 'read',
210
-        self::caps_read_admin => 'read',
211
-        self::caps_edit       => 'edit',
212
-        self::caps_delete     => 'delete',
213
-    );
214
-
215
-    /**
216
-     * Timezone
217
-     * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
218
-     * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
219
-     * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
220
-     * EE_Datetime_Field data type will have access to it.
221
-     *
222
-     * @var string
223
-     */
224
-    protected $_timezone;
225
-
226
-
227
-    /**
228
-     * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
229
-     * multisite.
230
-     *
231
-     * @var int
232
-     */
233
-    protected static $_model_query_blog_id;
234
-
235
-    /**
236
-     * A copy of _fields, except the array keys are the model names pointed to by
237
-     * the field
238
-     *
239
-     * @var EE_Model_Field_Base[]
240
-     */
241
-    private $_cache_foreign_key_to_fields = array();
242
-
243
-    /**
244
-     * Cached list of all the fields on the model, indexed by their name
245
-     *
246
-     * @var EE_Model_Field_Base[]
247
-     */
248
-    private $_cached_fields = null;
249
-
250
-    /**
251
-     * Cached list of all the fields on the model, except those that are
252
-     * marked as only pertinent to the database
253
-     *
254
-     * @var EE_Model_Field_Base[]
255
-     */
256
-    private $_cached_fields_non_db_only = null;
257
-
258
-    /**
259
-     * A cached reference to the primary key for quick lookup
260
-     *
261
-     * @var EE_Model_Field_Base
262
-     */
263
-    private $_primary_key_field = null;
264
-
265
-    /**
266
-     * Flag indicating whether this model has a primary key or not
267
-     *
268
-     * @var boolean
269
-     */
270
-    protected $_has_primary_key_field = null;
271
-
272
-    /**
273
-     * Whether or not this model is based off a table in WP core only (CPTs should set
274
-     * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
275
-     *
276
-     * @var boolean
277
-     */
278
-    protected $_wp_core_model = false;
279
-
280
-    /**
281
-     *    List of valid operators that can be used for querying.
282
-     * The keys are all operators we'll accept, the values are the real SQL
283
-     * operators used
284
-     *
285
-     * @var array
286
-     */
287
-    protected $_valid_operators = array(
288
-        '='           => '=',
289
-        '<='          => '<=',
290
-        '<'           => '<',
291
-        '>='          => '>=',
292
-        '>'           => '>',
293
-        '!='          => '!=',
294
-        'LIKE'        => 'LIKE',
295
-        'like'        => 'LIKE',
296
-        'NOT_LIKE'    => 'NOT LIKE',
297
-        'not_like'    => 'NOT LIKE',
298
-        'NOT LIKE'    => 'NOT LIKE',
299
-        'not like'    => 'NOT LIKE',
300
-        'IN'          => 'IN',
301
-        'in'          => 'IN',
302
-        'NOT_IN'      => 'NOT IN',
303
-        'not_in'      => 'NOT IN',
304
-        'NOT IN'      => 'NOT IN',
305
-        'not in'      => 'NOT IN',
306
-        'between'     => 'BETWEEN',
307
-        'BETWEEN'     => 'BETWEEN',
308
-        'IS_NOT_NULL' => 'IS NOT NULL',
309
-        'is_not_null' => 'IS NOT NULL',
310
-        'IS NOT NULL' => 'IS NOT NULL',
311
-        'is not null' => 'IS NOT NULL',
312
-        'IS_NULL'     => 'IS NULL',
313
-        'is_null'     => 'IS NULL',
314
-        'IS NULL'     => 'IS NULL',
315
-        'is null'     => 'IS NULL',
316
-        'REGEXP'      => 'REGEXP',
317
-        'regexp'      => 'REGEXP',
318
-        'NOT_REGEXP'  => 'NOT REGEXP',
319
-        'not_regexp'  => 'NOT REGEXP',
320
-        'NOT REGEXP'  => 'NOT REGEXP',
321
-        'not regexp'  => 'NOT REGEXP',
322
-    );
323
-
324
-    /**
325
-     * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
326
-     *
327
-     * @var array
328
-     */
329
-    protected $_in_style_operators = array('IN', 'NOT IN');
330
-
331
-    /**
332
-     * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
333
-     * '12-31-2012'"
334
-     *
335
-     * @var array
336
-     */
337
-    protected $_between_style_operators = array('BETWEEN');
338
-
339
-    /**
340
-     * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
341
-     * on a join table.
342
-     *
343
-     * @var array
344
-     */
345
-    protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
346
-
347
-    /**
348
-     * Allowed values for $query_params['order'] for ordering in queries
349
-     *
350
-     * @var array
351
-     */
352
-    protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
353
-
354
-    /**
355
-     * When these are keys in a WHERE or HAVING clause, they are handled much differently
356
-     * than regular field names. It is assumed that their values are an array of WHERE conditions
357
-     *
358
-     * @var array
359
-     */
360
-    private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
361
-
362
-    /**
363
-     * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
364
-     * 'where', but 'where' clauses are so common that we thought we'd omit it
365
-     *
366
-     * @var array
367
-     */
368
-    private $_allowed_query_params = array(
369
-        0,
370
-        'limit',
371
-        'order_by',
372
-        'group_by',
373
-        'having',
374
-        'force_join',
375
-        'order',
376
-        'on_join_limit',
377
-        'default_where_conditions',
378
-        'caps',
379
-    );
380
-
381
-    /**
382
-     * All the data types that can be used in $wpdb->prepare statements.
383
-     *
384
-     * @var array
385
-     */
386
-    private $_valid_wpdb_data_types = array('%d', '%s', '%f');
387
-
388
-    /**
389
-     *    EE_Registry Object
390
-     *
391
-     * @var    object
392
-     * @access    protected
393
-     */
394
-    protected $EE = null;
395
-
396
-
397
-    /**
398
-     * Property which, when set, will have this model echo out the next X queries to the page for debugging.
399
-     *
400
-     * @var int
401
-     */
402
-    protected $_show_next_x_db_queries = 0;
403
-
404
-    /**
405
-     * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
406
-     * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
407
-     *
408
-     * @var array
409
-     */
410
-    protected $_custom_selections = array();
411
-
412
-    /**
413
-     * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
414
-     * caches every model object we've fetched from the DB on this request
415
-     *
416
-     * @var array
417
-     */
418
-    protected $_entity_map;
419
-
420
-    /**
421
-     * constant used to show EEM_Base has not yet verified the db on this http request
422
-     */
423
-    const db_verified_none = 0;
424
-
425
-    /**
426
-     * constant used to show EEM_Base has verified the EE core db on this http request,
427
-     * but not the addons' dbs
428
-     */
429
-    const db_verified_core = 1;
430
-
431
-    /**
432
-     * constant used to show EEM_Base has verified the addons' dbs (and implicitly
433
-     * the EE core db too)
434
-     */
435
-    const db_verified_addons = 2;
436
-
437
-    /**
438
-     * indicates whether an EEM_Base child has already re-verified the DB
439
-     * is ok (we don't want to do it repetitively). Should be set to one the constants
440
-     * looking like EEM_Base::db_verified_*
441
-     *
442
-     * @var int - 0 = none, 1 = core, 2 = addons
443
-     */
444
-    protected static $_db_verification_level = EEM_Base::db_verified_none;
445
-
446
-    /**
447
-     * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
448
-     *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
449
-     *        registrations for non-trashed tickets for non-trashed datetimes)
450
-     */
451
-    const default_where_conditions_all = 'all';
452
-
453
-    /**
454
-     * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
455
-     *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
456
-     *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
457
-     *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
458
-     *        models which share tables with other models, this can return data for the wrong model.
459
-     */
460
-    const default_where_conditions_this_only = 'this_model_only';
461
-
462
-    /**
463
-     * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
464
-     *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
465
-     *        return all registrations related to non-trashed tickets and non-trashed datetimes)
466
-     */
467
-    const default_where_conditions_others_only = 'other_models_only';
468
-
469
-    /**
470
-     * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
471
-     *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
472
-     *        their table with other models, like the Event and Venue models. For example, when querying for events
473
-     *        ordered by their venues' name, this will be sure to only return real events with associated real venues
474
-     *        (regardless of whether those events and venues are trashed)
475
-     *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
476
-     *        events.
477
-     */
478
-    const default_where_conditions_minimum_all = 'minimum';
479
-
480
-    /**
481
-     * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
482
-     *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
483
-     *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
484
-     *        not)
485
-     */
486
-    const default_where_conditions_minimum_others = 'full_this_minimum_others';
487
-
488
-    /**
489
-     * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
490
-     *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
491
-     *        it's possible it will return table entries for other models. You should use
492
-     *        EEM_Base::default_where_conditions_minimum_all instead.
493
-     */
494
-    const default_where_conditions_none = 'none';
495
-
496
-
497
-
498
-    /**
499
-     * About all child constructors:
500
-     * they should define the _tables, _fields and _model_relations arrays.
501
-     * Should ALWAYS be called after child constructor.
502
-     * In order to make the child constructors to be as simple as possible, this parent constructor
503
-     * finalizes constructing all the object's attributes.
504
-     * Generally, rather than requiring a child to code
505
-     * $this->_tables = array(
506
-     *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
507
-     *        ...);
508
-     *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
509
-     * each EE_Table has a function to set the table's alias after the constructor, using
510
-     * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
511
-     * do something similar.
512
-     *
513
-     * @param null $timezone
514
-     * @throws \EE_Error
515
-     */
516
-    protected function __construct($timezone = null)
517
-    {
518
-        // check that the model has not been loaded too soon
519
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
520
-            throw new EE_Error (
521
-                sprintf(
522
-                    __('The %1$s model can not be loaded before the "AHEE__EE_System__load_espresso_addons" hook has been called. This gives other addons a chance to extend this model.',
523
-                        'event_espresso'),
524
-                    get_class($this)
525
-                )
526
-            );
527
-        }
528
-        /**
529
-         * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
530
-         */
531
-        if (empty(EEM_Base::$_model_query_blog_id)) {
532
-            EEM_Base::set_model_query_blog_id();
533
-        }
534
-        /**
535
-         * Filters the list of tables on a model. It is best to NOT use this directly and instead
536
-         * just use EE_Register_Model_Extension
537
-         *
538
-         * @var EE_Table_Base[] $_tables
539
-         */
540
-        $this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
541
-        foreach ($this->_tables as $table_alias => $table_obj) {
542
-            /** @var $table_obj EE_Table_Base */
543
-            $table_obj->_construct_finalize_with_alias($table_alias);
544
-            if ($table_obj instanceof EE_Secondary_Table) {
545
-                /** @var $table_obj EE_Secondary_Table */
546
-                $table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
547
-            }
548
-        }
549
-        /**
550
-         * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
551
-         * EE_Register_Model_Extension
552
-         *
553
-         * @param EE_Model_Field_Base[] $_fields
554
-         */
555
-        $this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
556
-        $this->_invalidate_field_caches();
557
-        foreach ($this->_fields as $table_alias => $fields_for_table) {
558
-            if (! array_key_exists($table_alias, $this->_tables)) {
559
-                throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
560
-                    'event_espresso'), $table_alias, implode(",", $this->_fields)));
561
-            }
562
-            foreach ($fields_for_table as $field_name => $field_obj) {
563
-                /** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
564
-                //primary key field base has a slightly different _construct_finalize
565
-                /** @var $field_obj EE_Model_Field_Base */
566
-                $field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
567
-            }
568
-        }
569
-        // everything is related to Extra_Meta
570
-        if (get_class($this) !== 'EEM_Extra_Meta') {
571
-            //make extra meta related to everything, but don't block deleting things just
572
-            //because they have related extra meta info. For now just orphan those extra meta
573
-            //in the future we should automatically delete them
574
-            $this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
575
-        }
576
-        //and change logs
577
-        if (get_class($this) !== 'EEM_Change_Log') {
578
-            $this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
579
-        }
580
-        /**
581
-         * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
582
-         * EE_Register_Model_Extension
583
-         *
584
-         * @param EE_Model_Relation_Base[] $_model_relations
585
-         */
586
-        $this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
587
-            $this->_model_relations);
588
-        foreach ($this->_model_relations as $model_name => $relation_obj) {
589
-            /** @var $relation_obj EE_Model_Relation_Base */
590
-            $relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
591
-        }
592
-        foreach ($this->_indexes as $index_name => $index_obj) {
593
-            /** @var $index_obj EE_Index */
594
-            $index_obj->_construct_finalize($index_name, $this->get_this_model_name());
595
-        }
596
-        $this->set_timezone($timezone);
597
-        //finalize default where condition strategy, or set default
598
-        if (! $this->_default_where_conditions_strategy) {
599
-            //nothing was set during child constructor, so set default
600
-            $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
601
-        }
602
-        $this->_default_where_conditions_strategy->_finalize_construct($this);
603
-        if (! $this->_minimum_where_conditions_strategy) {
604
-            //nothing was set during child constructor, so set default
605
-            $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
606
-        }
607
-        $this->_minimum_where_conditions_strategy->_finalize_construct($this);
608
-        //if the cap slug hasn't been set, and we haven't set it to false on purpose
609
-        //to indicate to NOT set it, set it to the logical default
610
-        if ($this->_caps_slug === null) {
611
-            $this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
612
-        }
613
-        //initialize the standard cap restriction generators if none were specified by the child constructor
614
-        if ($this->_cap_restriction_generators !== false) {
615
-            foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
616
-                if (! isset($this->_cap_restriction_generators[$cap_context])) {
617
-                    $this->_cap_restriction_generators[$cap_context] = apply_filters(
618
-                        'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
619
-                        new EE_Restriction_Generator_Protected(),
620
-                        $cap_context,
621
-                        $this
622
-                    );
623
-                }
624
-            }
625
-        }
626
-        //if there are cap restriction generators, use them to make the default cap restrictions
627
-        if ($this->_cap_restriction_generators !== false) {
628
-            foreach ($this->_cap_restriction_generators as $context => $generator_object) {
629
-                if (! $generator_object) {
630
-                    continue;
631
-                }
632
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
633
-                    throw new EE_Error(
634
-                        sprintf(
635
-                            __('Index "%1$s" in the model %2$s\'s _cap_restriction_generators is not a child of EE_Restriction_Generator_Base. It should be that or NULL.',
636
-                                'event_espresso'),
637
-                            $context,
638
-                            $this->get_this_model_name()
639
-                        )
640
-                    );
641
-                }
642
-                $action = $this->cap_action_for_context($context);
643
-                if (! $generator_object->construction_finalized()) {
644
-                    $generator_object->_construct_finalize($this, $action);
645
-                }
646
-            }
647
-        }
648
-        do_action('AHEE__' . get_class($this) . '__construct__end');
649
-    }
650
-
651
-
652
-
653
-    /**
654
-     * Generates the cap restrictions for the given context, or if they were
655
-     * already generated just gets what's cached
656
-     *
657
-     * @param string $context one of EEM_Base::valid_cap_contexts()
658
-     * @return EE_Default_Where_Conditions[]
659
-     */
660
-    protected function _generate_cap_restrictions($context)
661
-    {
662
-        if (isset($this->_cap_restriction_generators[$context])
663
-            && $this->_cap_restriction_generators[$context]
664
-               instanceof
665
-               EE_Restriction_Generator_Base
666
-        ) {
667
-            return $this->_cap_restriction_generators[$context]->generate_restrictions();
668
-        } else {
669
-            return array();
670
-        }
671
-    }
672
-
673
-
674
-
675
-    /**
676
-     * Used to set the $_model_query_blog_id static property.
677
-     *
678
-     * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
679
-     *                      value for get_current_blog_id() will be used.
680
-     */
681
-    public static function set_model_query_blog_id($blog_id = 0)
682
-    {
683
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
684
-    }
685
-
686
-
687
-
688
-    /**
689
-     * Returns whatever is set as the internal $model_query_blog_id.
690
-     *
691
-     * @return int
692
-     */
693
-    public static function get_model_query_blog_id()
694
-    {
695
-        return EEM_Base::$_model_query_blog_id;
696
-    }
697
-
698
-
699
-
700
-    /**
701
-     *        This function is a singleton method used to instantiate the Espresso_model object
702
-     *
703
-     * @access public
704
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
705
-     *                         incoming timezone data that gets saved).  Note this just sends the timezone info to the
706
-     *                         date time model field objects.  Default is NULL (and will be assumed using the set
707
-     *                         timezone in the 'timezone_string' wp option)
708
-     * @return static (as in the concrete child class)
709
-     */
710
-    public static function instance($timezone = null)
711
-    {
712
-        // check if instance of Espresso_model already exists
713
-        if (! static::$_instance instanceof static) {
714
-            // instantiate Espresso_model
715
-            static::$_instance = new static($timezone);
716
-        }
717
-        //we might have a timezone set, let set_timezone decide what to do with it
718
-        static::$_instance->set_timezone($timezone);
719
-        // Espresso_model object
720
-        return static::$_instance;
721
-    }
722
-
723
-
724
-
725
-    /**
726
-     * resets the model and returns it
727
-     *
728
-     * @param null | string $timezone
729
-     * @return EEM_Base|null (if the model was already instantiated, returns it, with
730
-     * all its properties reset; if it wasn't instantiated, returns null)
731
-     */
732
-    public static function reset($timezone = null)
733
-    {
734
-        if (static::$_instance instanceof EEM_Base) {
735
-            //let's try to NOT swap out the current instance for a new one
736
-            //because if someone has a reference to it, we can't remove their reference
737
-            //so it's best to keep using the same reference, but change the original object
738
-            //reset all its properties to their original values as defined in the class
739
-            $r = new ReflectionClass(get_class(static::$_instance));
740
-            $static_properties = $r->getStaticProperties();
741
-            foreach ($r->getDefaultProperties() as $property => $value) {
742
-                //don't set instance to null like it was originally,
743
-                //but it's static anyways, and we're ignoring static properties (for now at least)
744
-                if (! isset($static_properties[$property])) {
745
-                    static::$_instance->{$property} = $value;
746
-                }
747
-            }
748
-            //and then directly call its constructor again, like we would if we
749
-            //were creating a new one
750
-            static::$_instance->__construct($timezone);
751
-            return self::instance();
752
-        }
753
-        return null;
754
-    }
755
-
756
-
757
-
758
-    /**
759
-     * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
760
-     *
761
-     * @param  boolean $translated return localized strings or JUST the array.
762
-     * @return array
763
-     * @throws \EE_Error
764
-     */
765
-    public function status_array($translated = false)
766
-    {
767
-        if (! array_key_exists('Status', $this->_model_relations)) {
768
-            return array();
769
-        }
770
-        $model_name = $this->get_this_model_name();
771
-        $status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
772
-        $stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
773
-        $status_array = array();
774
-        foreach ($stati as $status) {
775
-            $status_array[$status->ID()] = $status->get('STS_code');
776
-        }
777
-        return $translated
778
-            ? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
779
-            : $status_array;
780
-    }
781
-
782
-
783
-
784
-    /**
785
-     * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
786
-     *
787
-     * @param array $query_params             {
788
-     * @var array $0 (where) array {
789
-     *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
790
-     *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
791
-     *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
792
-     *                                        conditions based on related models (and even
793
-     *                                        models-related-to-related-models) prepend the model's name onto the field
794
-     *                                        name. Eg,
795
-     *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
796
-     *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
797
-     *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
798
-     *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
799
-     *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
800
-     *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
801
-     *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
802
-     *                                        to Venues (even when each of those models actually consisted of two
803
-     *                                        tables). Also, you may chain the model relations together. Eg instead of
804
-     *                                        just having
805
-     *                                        "Venue.VNU_ID", you could have
806
-     *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
807
-     *                                        events are related to Registrations, which are related to Attendees). You
808
-     *                                        can take it even further with
809
-     *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
810
-     *                                        (from the default of '='), change the value to an numerically-indexed
811
-     *                                        array, where the first item in the list is the operator. eg: array(
812
-     *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
813
-     *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
814
-     *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
815
-     *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
816
-     *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
817
-     *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
818
-     *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
819
-     *                                        the operator is IN. Also, values can actually be field names. To indicate
820
-     *                                        the value is a field, simply provide a third array item (true) to the
821
-     *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
822
-     *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
823
-     *                                        Note: you can also use related model field names like you would any other
824
-     *                                        field name. eg:
825
-     *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
826
-     *                                        be used if you were querying EEM_Tickets (because Datetime is directly related to tickets) Also, by default all the where conditions are AND'd together. To override this, add an array key 'OR' (or 'AND') and the array to be OR'd together eg: array('OR'=>array('TXN_ID' => 23 , 'TXN_timestamp__>' =>
827
-     *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
828
-     *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
829
-     *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
830
-     *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
831
-     *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
832
-     *                                        to be what you last specified. IE, "AND"s by default, but if you had
833
-     *                                        previously specified to use ORs to join, ORs will continue to be used.
834
-     *                                        So, if you specify to use an "OR" to join conditions, it will continue to
835
-     *                                        "stick" until you specify an AND. eg
836
-     *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
837
-     *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
838
-     *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
839
-     *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
840
-     *                                        array('OR'=>array('TXN_total' => 23, 'NOT'=> array( 'TXN_timestamp'=> 345678912, 'AND'=>array('TXN_paid' => 53, 'STS_ID' => 'TIN')))) becomes SQL >> "...WHERE TXN_total = 23 OR ! (TXN_timestamp = 345678912 OR (TXN_paid = 53 AND STS_ID = 'TIN'))..." GOTCHA: because this is an array, array keys must be unique, making it impossible to place two or more where conditions applying to the same field. eg: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp'=>array('<',$end_date),'PAY_timestamp'=>array('!=',$special_date)), as PHP enforces that the array keys must be unique, thus removing the first two array entries with key 'PAY_timestamp'. becomes SQL >> "PAY_timestamp !=  4234232", ignoring the first two PAY_timestamp conditions). To overcome this, you can add a '*' character to the end of the field's name, followed by anything. These will be removed when generating the SQL string, but allow for the array keys to be unique. eg: you could rewrite the previous query as: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp*1st'=>array('<',$end_date),'PAY_timestamp*2nd'=>array('!=',$special_date)) which correctly becomes SQL >>
841
-     *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
842
-     *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
843
-     *                                        too, eg:
844
-     *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
845
-     * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
846
-     *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
847
-     *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
848
-     *                                        Remember when you provide two numbers for the limit, the 1st number is
849
-     *                                        the OFFSET, the 2nd is the LIMIT
850
-     * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
851
-     *                                        can do paging on one-to-many multi-table-joins. Send an array in the
852
-     *                                        following format array('on_join_limit'
853
-     *                                        => array( 'table_alias', array(1,2) ) ).
854
-     * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
855
-     *                                        values are either 'ASC' or 'DESC'.
856
-     *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
857
-     *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
858
-     *                                        DESC..." respectively. Like the
859
-     *                                        'where' conditions, these fields can be on related models. Eg
860
-     *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
861
-     *                                        perfectly valid from any model related to 'Registration' (like Event,
862
-     *                                        Attendee, Price, Datetime, etc.)
863
-     * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
864
-     *                                        'order' specifies whether to order the field specified in 'order_by' in
865
-     *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
866
-     *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
867
-     *                                        order by the primary key. Eg,
868
-     *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
869
-     *                                        //(will join with the Datetime model's table(s) and order by its field
870
-     *                                        DTT_EVT_start) or
871
-     *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
872
-     *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
873
-     * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
874
-     *                                        'group_by'=>'VNU_ID', or
875
-     *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
876
-     *                                        if no
877
-     *                                        $group_by is specified, and a limit is set, automatically groups by the
878
-     *                                        model's primary key (or combined primary keys). This avoids some
879
-     *                                        weirdness that results when using limits, tons of joins, and no group by,
880
-     *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
881
-     * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
882
-     *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
883
-     *                                        results)
884
-     * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
885
-     *                                        array where values are models to be joined in the query.Eg
886
-     *                                        array('Attendee','Payment','Datetime'). You may join with transient
887
-     *                                        models using period, eg "Registration.Transaction.Payment". You will
888
-     *                                        probably only want to do this in hopes of increasing efficiency, as
889
-     *                                        related models which belongs to the current model
890
-     *                                        (ie, the current model has a foreign key to them, like how Registration
891
-     *                                        belongs to Attendee) can be cached in order to avoid future queries
892
-     * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
893
-     *                                        set this to 'none' to disable all default where conditions. Eg, usually
894
-     *                                        soft-deleted objects are filtered-out if you want to include them, set
895
-     *                                        this query param to 'none'. If you want to ONLY disable THIS model's
896
-     *                                        default where conditions set it to 'other_models_only'. If you only want
897
-     *                                        this model's default where conditions added to the query, use
898
-     *                                        'this_model_only'. If you want to use all default where conditions
899
-     *                                        (default), set to 'all'.
900
-     * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
901
-     *                                        we just NOT apply any capabilities/permissions/restrictions and return
902
-     *                                        everything? Or should we only show the current user items they should be
903
-     *                                        able to view on the frontend, backend, edit, or delete? can be set to
904
-     *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
905
-     *                                        }
906
-     * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
907
-     *                                        from EE_Base_Class[], use _get_all_wpdb_results()and make it public
908
-     *                                        again. Array keys are object IDs (if there is a primary key on the model.
909
-     *                                        if not, numerically indexed) Some full examples: get 10 transactions
910
-     *                                        which have Scottish attendees: EEM_Transaction::instance()->get_all(
911
-     *                                        array( array(
912
-     *                                        'OR'=>array(
913
-     *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
914
-     *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
915
-     *                                        )
916
-     *                                        ),
917
-     *                                        'limit'=>10,
918
-     *                                        'group_by'=>'TXN_ID'
919
-     *                                        ));
920
-     *                                        get all the answers to the question titled "shirt size" for event with id
921
-     *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
922
-     *                                        'Question.QST_display_text'=>'shirt size',
923
-     *                                        'Registration.Event.EVT_ID'=>12
924
-     *                                        ),
925
-     *                                        'order_by'=>array('ANS_value'=>'ASC')
926
-     *                                        ));
927
-     * @throws \EE_Error
928
-     */
929
-    public function get_all($query_params = array())
930
-    {
931
-        if (isset($query_params['limit'])
932
-            && ! isset($query_params['group_by'])
933
-        ) {
934
-            $query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
935
-        }
936
-        return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
937
-    }
938
-
939
-
940
-
941
-    /**
942
-     * Modifies the query parameters so we only get back model objects
943
-     * that "belong" to the current user
944
-     *
945
-     * @param array $query_params @see EEM_Base::get_all()
946
-     * @return array like EEM_Base::get_all
947
-     */
948
-    public function alter_query_params_to_only_include_mine($query_params = array())
949
-    {
950
-        $wp_user_field_name = $this->wp_user_field_name();
951
-        if ($wp_user_field_name) {
952
-            $query_params[0][$wp_user_field_name] = get_current_user_id();
953
-        }
954
-        return $query_params;
955
-    }
956
-
957
-
958
-
959
-    /**
960
-     * Returns the name of the field's name that points to the WP_User table
961
-     *  on this model (or follows the _model_chain_to_wp_user and uses that model's
962
-     * foreign key to the WP_User table)
963
-     *
964
-     * @return string|boolean string on success, boolean false when there is no
965
-     * foreign key to the WP_User table
966
-     */
967
-    public function wp_user_field_name()
968
-    {
969
-        try {
970
-            if (! empty($this->_model_chain_to_wp_user)) {
971
-                $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
972
-                $last_model_name = end($models_to_follow_to_wp_users);
973
-                $model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
974
-                $model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
975
-            } else {
976
-                $model_with_fk_to_wp_users = $this;
977
-                $model_chain_to_wp_user = '';
978
-            }
979
-            $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
980
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
981
-        } catch (EE_Error $e) {
982
-            return false;
983
-        }
984
-    }
985
-
986
-
987
-
988
-    /**
989
-     * Returns the _model_chain_to_wp_user string, which indicates which related model
990
-     * (or transiently-related model) has a foreign key to the wp_users table;
991
-     * useful for finding if model objects of this type are 'owned' by the current user.
992
-     * This is an empty string when the foreign key is on this model and when it isn't,
993
-     * but is only non-empty when this model's ownership is indicated by a RELATED model
994
-     * (or transiently-related model)
995
-     *
996
-     * @return string
997
-     */
998
-    public function model_chain_to_wp_user()
999
-    {
1000
-        return $this->_model_chain_to_wp_user;
1001
-    }
1002
-
1003
-
1004
-
1005
-    /**
1006
-     * Whether this model is 'owned' by a specific wordpress user (even indirectly,
1007
-     * like how registrations don't have a foreign key to wp_users, but the
1008
-     * events they are for are), or is unrelated to wp users.
1009
-     * generally available
1010
-     *
1011
-     * @return boolean
1012
-     */
1013
-    public function is_owned()
1014
-    {
1015
-        if ($this->model_chain_to_wp_user()) {
1016
-            return true;
1017
-        } else {
1018
-            try {
1019
-                $this->get_foreign_key_to('WP_User');
1020
-                return true;
1021
-            } catch (EE_Error $e) {
1022
-                return false;
1023
-            }
1024
-        }
1025
-    }
1026
-
1027
-
1028
-
1029
-    /**
1030
-     * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
1031
-     * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
1032
-     * the model)
1033
-     *
1034
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
1035
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1036
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1037
-     *                                  fields on the model, and the models we joined to in the query. However, you can
1038
-     *                                  override this and set the select to "*", or a specific column name, like
1039
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1040
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1041
-     *                                  the aliases used to refer to this selection, and values are to be
1042
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1043
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1044
-     * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1045
-     * @throws \EE_Error
1046
-     */
1047
-    protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1048
-    {
1049
-        // remember the custom selections, if any, and type cast as array
1050
-        // (unless $columns_to_select is an object, then just set as an empty array)
1051
-        // Note: (array) 'some string' === array( 'some string' )
1052
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1053
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1054
-        $select_expressions = $columns_to_select !== null
1055
-            ? $this->_construct_select_from_input($columns_to_select)
1056
-            : $this->_construct_default_select_sql($model_query_info);
1057
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1058
-        return $this->_do_wpdb_query('get_results', array($SQL, $output));
1059
-    }
1060
-
1061
-
1062
-
1063
-    /**
1064
-     * Gets an array of rows from the database just like $wpdb->get_results would,
1065
-     * but you can use the $query_params like on EEM_Base::get_all() to more easily
1066
-     * take care of joins, field preparation etc.
1067
-     *
1068
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
1069
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1070
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1071
-     *                                  fields on the model, and the models we joined to in the query. However, you can
1072
-     *                                  override this and set the select to "*", or a specific column name, like
1073
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1074
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1075
-     *                                  the aliases used to refer to this selection, and values are to be
1076
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1077
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1078
-     * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1079
-     * @throws \EE_Error
1080
-     */
1081
-    public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1082
-    {
1083
-        return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
1084
-    }
1085
-
1086
-
1087
-
1088
-    /**
1089
-     * For creating a custom select statement
1090
-     *
1091
-     * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
1092
-     *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
1093
-     *                                 SQL, and 1=>is the datatype
1094
-     * @throws EE_Error
1095
-     * @return string
1096
-     */
1097
-    private function _construct_select_from_input($columns_to_select)
1098
-    {
1099
-        if (is_array($columns_to_select)) {
1100
-            $select_sql_array = array();
1101
-            foreach ($columns_to_select as $alias => $selection_and_datatype) {
1102
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1103
-                    throw new EE_Error(
1104
-                        sprintf(
1105
-                            __(
1106
-                                "Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1107
-                                "event_espresso"
1108
-                            ),
1109
-                            $selection_and_datatype,
1110
-                            $alias
1111
-                        )
1112
-                    );
1113
-                }
1114
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1115
-                    throw new EE_Error(
1116
-                        sprintf(
1117
-                            __(
1118
-                                "Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1119
-                                "event_espresso"
1120
-                            ),
1121
-                            $selection_and_datatype[1],
1122
-                            $selection_and_datatype[0],
1123
-                            $alias,
1124
-                            implode(",", $this->_valid_wpdb_data_types)
1125
-                        )
1126
-                    );
1127
-                }
1128
-                $select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1129
-            }
1130
-            $columns_to_select_string = implode(", ", $select_sql_array);
1131
-        } else {
1132
-            $columns_to_select_string = $columns_to_select;
1133
-        }
1134
-        return $columns_to_select_string;
1135
-    }
1136
-
1137
-
1138
-
1139
-    /**
1140
-     * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1141
-     *
1142
-     * @return string
1143
-     * @throws \EE_Error
1144
-     */
1145
-    public function primary_key_name()
1146
-    {
1147
-        return $this->get_primary_key_field()->get_name();
1148
-    }
1149
-
1150
-
1151
-
1152
-    /**
1153
-     * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1154
-     * If there is no primary key on this model, $id is treated as primary key string
1155
-     *
1156
-     * @param mixed $id int or string, depending on the type of the model's primary key
1157
-     * @return EE_Base_Class
1158
-     */
1159
-    public function get_one_by_ID($id)
1160
-    {
1161
-        if ($this->get_from_entity_map($id)) {
1162
-            return $this->get_from_entity_map($id);
1163
-        }
1164
-        return $this->get_one(
1165
-            $this->alter_query_params_to_restrict_by_ID(
1166
-                $id,
1167
-                array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
1168
-            )
1169
-        );
1170
-    }
1171
-
1172
-
1173
-
1174
-    /**
1175
-     * Alters query parameters to only get items with this ID are returned.
1176
-     * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1177
-     * or could just be a simple primary key ID
1178
-     *
1179
-     * @param int   $id
1180
-     * @param array $query_params
1181
-     * @return array of normal query params, @see EEM_Base::get_all
1182
-     * @throws \EE_Error
1183
-     */
1184
-    public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1185
-    {
1186
-        if (! isset($query_params[0])) {
1187
-            $query_params[0] = array();
1188
-        }
1189
-        $conditions_from_id = $this->parse_index_primary_key_string($id);
1190
-        if ($conditions_from_id === null) {
1191
-            $query_params[0][$this->primary_key_name()] = $id;
1192
-        } else {
1193
-            //no primary key, so the $id must be from the get_index_primary_key_string()
1194
-            $query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1195
-        }
1196
-        return $query_params;
1197
-    }
1198
-
1199
-
1200
-
1201
-    /**
1202
-     * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1203
-     * array. If no item is found, null is returned.
1204
-     *
1205
-     * @param array $query_params like EEM_Base's $query_params variable.
1206
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1207
-     * @throws \EE_Error
1208
-     */
1209
-    public function get_one($query_params = array())
1210
-    {
1211
-        if (! is_array($query_params)) {
1212
-            EE_Error::doing_it_wrong('EEM_Base::get_one',
1213
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1214
-                    gettype($query_params)), '4.6.0');
1215
-            $query_params = array();
1216
-        }
1217
-        $query_params['limit'] = 1;
1218
-        $items = $this->get_all($query_params);
1219
-        if (empty($items)) {
1220
-            return null;
1221
-        } else {
1222
-            return array_shift($items);
1223
-        }
1224
-    }
1225
-
1226
-
1227
-
1228
-    /**
1229
-     * Returns the next x number of items in sequence from the given value as
1230
-     * found in the database matching the given query conditions.
1231
-     *
1232
-     * @param mixed $current_field_value    Value used for the reference point.
1233
-     * @param null  $field_to_order_by      What field is used for the
1234
-     *                                      reference point.
1235
-     * @param int   $limit                  How many to return.
1236
-     * @param array $query_params           Extra conditions on the query.
1237
-     * @param null  $columns_to_select      If left null, then an array of
1238
-     *                                      EE_Base_Class objects is returned,
1239
-     *                                      otherwise you can indicate just the
1240
-     *                                      columns you want returned.
1241
-     * @return EE_Base_Class[]|array
1242
-     * @throws \EE_Error
1243
-     */
1244
-    public function next_x(
1245
-        $current_field_value,
1246
-        $field_to_order_by = null,
1247
-        $limit = 1,
1248
-        $query_params = array(),
1249
-        $columns_to_select = null
1250
-    ) {
1251
-        return $this->_get_consecutive($current_field_value, '>', $field_to_order_by, $limit, $query_params,
1252
-            $columns_to_select);
1253
-    }
1254
-
1255
-
1256
-
1257
-    /**
1258
-     * Returns the previous x number of items in sequence from the given value
1259
-     * as found in the database matching the given query conditions.
1260
-     *
1261
-     * @param mixed $current_field_value    Value used for the reference point.
1262
-     * @param null  $field_to_order_by      What field is used for the
1263
-     *                                      reference point.
1264
-     * @param int   $limit                  How many to return.
1265
-     * @param array $query_params           Extra conditions on the query.
1266
-     * @param null  $columns_to_select      If left null, then an array of
1267
-     *                                      EE_Base_Class objects is returned,
1268
-     *                                      otherwise you can indicate just the
1269
-     *                                      columns you want returned.
1270
-     * @return EE_Base_Class[]|array
1271
-     * @throws \EE_Error
1272
-     */
1273
-    public function previous_x(
1274
-        $current_field_value,
1275
-        $field_to_order_by = null,
1276
-        $limit = 1,
1277
-        $query_params = array(),
1278
-        $columns_to_select = null
1279
-    ) {
1280
-        return $this->_get_consecutive($current_field_value, '<', $field_to_order_by, $limit, $query_params,
1281
-            $columns_to_select);
1282
-    }
1283
-
1284
-
1285
-
1286
-    /**
1287
-     * Returns the next item in sequence from the given value as found in the
1288
-     * database matching the given query conditions.
1289
-     *
1290
-     * @param mixed $current_field_value    Value used for the reference point.
1291
-     * @param null  $field_to_order_by      What field is used for the
1292
-     *                                      reference point.
1293
-     * @param array $query_params           Extra conditions on the query.
1294
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1295
-     *                                      object is returned, otherwise you
1296
-     *                                      can indicate just the columns you
1297
-     *                                      want and a single array indexed by
1298
-     *                                      the columns will be returned.
1299
-     * @return EE_Base_Class|null|array()
1300
-     * @throws \EE_Error
1301
-     */
1302
-    public function next(
1303
-        $current_field_value,
1304
-        $field_to_order_by = null,
1305
-        $query_params = array(),
1306
-        $columns_to_select = null
1307
-    ) {
1308
-        $results = $this->_get_consecutive($current_field_value, '>', $field_to_order_by, 1, $query_params,
1309
-            $columns_to_select);
1310
-        return empty($results) ? null : reset($results);
1311
-    }
1312
-
1313
-
1314
-
1315
-    /**
1316
-     * Returns the previous item in sequence from the given value as found in
1317
-     * the database matching the given query conditions.
1318
-     *
1319
-     * @param mixed $current_field_value    Value used for the reference point.
1320
-     * @param null  $field_to_order_by      What field is used for the
1321
-     *                                      reference point.
1322
-     * @param array $query_params           Extra conditions on the query.
1323
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1324
-     *                                      object is returned, otherwise you
1325
-     *                                      can indicate just the columns you
1326
-     *                                      want and a single array indexed by
1327
-     *                                      the columns will be returned.
1328
-     * @return EE_Base_Class|null|array()
1329
-     * @throws EE_Error
1330
-     */
1331
-    public function previous(
1332
-        $current_field_value,
1333
-        $field_to_order_by = null,
1334
-        $query_params = array(),
1335
-        $columns_to_select = null
1336
-    ) {
1337
-        $results = $this->_get_consecutive($current_field_value, '<', $field_to_order_by, 1, $query_params,
1338
-            $columns_to_select);
1339
-        return empty($results) ? null : reset($results);
1340
-    }
1341
-
1342
-
1343
-
1344
-    /**
1345
-     * Returns the a consecutive number of items in sequence from the given
1346
-     * value as found in the database matching the given query conditions.
1347
-     *
1348
-     * @param mixed  $current_field_value   Value used for the reference point.
1349
-     * @param string $operand               What operand is used for the sequence.
1350
-     * @param string $field_to_order_by     What field is used for the reference point.
1351
-     * @param int    $limit                 How many to return.
1352
-     * @param array  $query_params          Extra conditions on the query.
1353
-     * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1354
-     *                                      otherwise you can indicate just the columns you want returned.
1355
-     * @return EE_Base_Class[]|array
1356
-     * @throws EE_Error
1357
-     */
1358
-    protected function _get_consecutive(
1359
-        $current_field_value,
1360
-        $operand = '>',
1361
-        $field_to_order_by = null,
1362
-        $limit = 1,
1363
-        $query_params = array(),
1364
-        $columns_to_select = null
1365
-    ) {
1366
-        //if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1367
-        if (empty($field_to_order_by)) {
1368
-            if ($this->has_primary_key_field()) {
1369
-                $field_to_order_by = $this->get_primary_key_field()->get_name();
1370
-            } else {
1371
-                if (WP_DEBUG) {
1372
-                    throw new EE_Error(__('EEM_Base::_get_consecutive() has been called with no $field_to_order_by argument and there is no primary key on the field.  Please provide the field you would like to use as the base for retrieving the next item(s).',
1373
-                        'event_espresso'));
1374
-                }
1375
-                EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1376
-                return array();
1377
-            }
1378
-        }
1379
-        if (! is_array($query_params)) {
1380
-            EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1381
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1382
-                    gettype($query_params)), '4.6.0');
1383
-            $query_params = array();
1384
-        }
1385
-        //let's add the where query param for consecutive look up.
1386
-        $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1387
-        $query_params['limit'] = $limit;
1388
-        //set direction
1389
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1390
-        $query_params['order_by'] = $operand === '>'
1391
-            ? array($field_to_order_by => 'ASC') + $incoming_orderby
1392
-            : array($field_to_order_by => 'DESC') + $incoming_orderby;
1393
-        //if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1394
-        if (empty($columns_to_select)) {
1395
-            return $this->get_all($query_params);
1396
-        } else {
1397
-            //getting just the fields
1398
-            return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1399
-        }
1400
-    }
1401
-
1402
-
1403
-
1404
-    /**
1405
-     * This sets the _timezone property after model object has been instantiated.
1406
-     *
1407
-     * @param null | string $timezone valid PHP DateTimeZone timezone string
1408
-     */
1409
-    public function set_timezone($timezone)
1410
-    {
1411
-        if ($timezone !== null) {
1412
-            $this->_timezone = $timezone;
1413
-        }
1414
-        //note we need to loop through relations and set the timezone on those objects as well.
1415
-        foreach ($this->_model_relations as $relation) {
1416
-            $relation->set_timezone($timezone);
1417
-        }
1418
-        //and finally we do the same for any datetime fields
1419
-        foreach ($this->_fields as $field) {
1420
-            if ($field instanceof EE_Datetime_Field) {
1421
-                $field->set_timezone($timezone);
1422
-            }
1423
-        }
1424
-    }
1425
-
1426
-
1427
-
1428
-    /**
1429
-     * This just returns whatever is set for the current timezone.
1430
-     *
1431
-     * @access public
1432
-     * @return string
1433
-     */
1434
-    public function get_timezone()
1435
-    {
1436
-        //first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1437
-        if (empty($this->_timezone)) {
1438
-            foreach ($this->_fields as $field) {
1439
-                if ($field instanceof EE_Datetime_Field) {
1440
-                    $this->set_timezone($field->get_timezone());
1441
-                    break;
1442
-                }
1443
-            }
1444
-        }
1445
-        //if timezone STILL empty then return the default timezone for the site.
1446
-        if (empty($this->_timezone)) {
1447
-            $this->set_timezone(EEH_DTT_Helper::get_timezone());
1448
-        }
1449
-        return $this->_timezone;
1450
-    }
1451
-
1452
-
1453
-
1454
-    /**
1455
-     * This returns the date formats set for the given field name and also ensures that
1456
-     * $this->_timezone property is set correctly.
1457
-     *
1458
-     * @since 4.6.x
1459
-     * @param string $field_name The name of the field the formats are being retrieved for.
1460
-     * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1461
-     * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1462
-     * @return array formats in an array with the date format first, and the time format last.
1463
-     */
1464
-    public function get_formats_for($field_name, $pretty = false)
1465
-    {
1466
-        $field_settings = $this->field_settings_for($field_name);
1467
-        //if not a valid EE_Datetime_Field then throw error
1468
-        if (! $field_settings instanceof EE_Datetime_Field) {
1469
-            throw new EE_Error(sprintf(__('The field sent into EEM_Base::get_formats_for (%s) is not registered as a EE_Datetime_Field. Please check the spelling and make sure you are submitting the right field name to retrieve date_formats for.',
1470
-                'event_espresso'), $field_name));
1471
-        }
1472
-        //while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1473
-        //the field.
1474
-        $this->_timezone = $field_settings->get_timezone();
1475
-        return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1476
-    }
1477
-
1478
-
1479
-
1480
-    /**
1481
-     * This returns the current time in a format setup for a query on this model.
1482
-     * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1483
-     * it will return:
1484
-     *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1485
-     *  NOW
1486
-     *  - or a unix timestamp (equivalent to time())
1487
-     *
1488
-     * @since 4.6.x
1489
-     * @param string $field_name       The field the current time is needed for.
1490
-     * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1491
-     *                                 formatted string matching the set format for the field in the set timezone will
1492
-     *                                 be returned.
1493
-     * @param string $what             Whether to return the string in just the time format, the date format, or both.
1494
-     * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1495
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1496
-     *                                 exception is triggered.
1497
-     */
1498
-    public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1499
-    {
1500
-        $formats = $this->get_formats_for($field_name);
1501
-        $DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1502
-        if ($timestamp) {
1503
-            return $DateTime->format('U');
1504
-        }
1505
-        //not returning timestamp, so return formatted string in timezone.
1506
-        switch ($what) {
1507
-            case 'time' :
1508
-                return $DateTime->format($formats[1]);
1509
-                break;
1510
-            case 'date' :
1511
-                return $DateTime->format($formats[0]);
1512
-                break;
1513
-            default :
1514
-                return $DateTime->format(implode(' ', $formats));
1515
-                break;
1516
-        }
1517
-    }
1518
-
1519
-
1520
-
1521
-    /**
1522
-     * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1523
-     * for the model are.  Returns a DateTime object.
1524
-     * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1525
-     * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1526
-     * ignored.
1527
-     *
1528
-     * @param string $field_name      The field being setup.
1529
-     * @param string $timestring      The date time string being used.
1530
-     * @param string $incoming_format The format for the time string.
1531
-     * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1532
-     *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1533
-     *                                format is
1534
-     *                                'U', this is ignored.
1535
-     * @return DateTime
1536
-     * @throws \EE_Error
1537
-     */
1538
-    public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1539
-    {
1540
-        //just using this to ensure the timezone is set correctly internally
1541
-        $this->get_formats_for($field_name);
1542
-        //load EEH_DTT_Helper
1543
-        $set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1544
-        $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1545
-        return $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone));
1546
-    }
1547
-
1548
-
1549
-
1550
-    /**
1551
-     * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1552
-     *
1553
-     * @return EE_Table_Base[]
1554
-     */
1555
-    public function get_tables()
1556
-    {
1557
-        return $this->_tables;
1558
-    }
1559
-
1560
-
1561
-
1562
-    /**
1563
-     * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1564
-     * also updates all the model objects, where the criteria expressed in $query_params are met..
1565
-     * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1566
-     * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1567
-     * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1568
-     * model object with EVT_ID = 1
1569
-     * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1570
-     * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1571
-     * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1572
-     * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1573
-     * are not specified)
1574
-     *
1575
-     * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1576
-     *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1577
-     *                                         are to be serialized. Basically, the values are what you'd expect to be
1578
-     *                                         values on the model, NOT necessarily what's in the DB. For example, if
1579
-     *                                         we wanted to update only the TXN_details on any Transactions where its
1580
-     *                                         ID=34, we'd use this method as follows:
1581
-     *                                         EEM_Transaction::instance()->update(
1582
-     *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1583
-     *                                         array(array('TXN_ID'=>34)));
1584
-     * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1585
-     *                                         in client code into what's expected to be stored on each field. Eg,
1586
-     *                                         consider updating Question's QST_admin_label field is of type
1587
-     *                                         Simple_HTML. If you use this function to update that field to $new_value
1588
-     *                                         = (note replace 8's with appropriate opening and closing tags in the
1589
-     *                                         following example)"8script8alert('I hack all');8/script88b8boom
1590
-     *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1591
-     *                                         TRUE, it is assumed that you've already called
1592
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1593
-     *                                         malicious javascript. However, if
1594
-     *                                         $values_already_prepared_by_model_object is left as FALSE, then
1595
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
1596
-     *                                         and every other field, before insertion. We provide this parameter
1597
-     *                                         because model objects perform their prepare_for_set function on all
1598
-     *                                         their values, and so don't need to be called again (and in many cases,
1599
-     *                                         shouldn't be called again. Eg: if we escape HTML characters in the
1600
-     *                                         prepare_for_set method...)
1601
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1602
-     *                                         in this model's entity map according to $fields_n_values that match
1603
-     *                                         $query_params. This obviously has some overhead, so you can disable it
1604
-     *                                         by setting this to FALSE, but be aware that model objects being used
1605
-     *                                         could get out-of-sync with the database
1606
-     * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1607
-     *                                         rows affected which *could* include 0 which DOES NOT mean the query was
1608
-     *                                         bad)
1609
-     * @throws \EE_Error
1610
-     */
1611
-    public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1612
-    {
1613
-        if (! is_array($query_params)) {
1614
-            EE_Error::doing_it_wrong('EEM_Base::update',
1615
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1616
-                    gettype($query_params)), '4.6.0');
1617
-            $query_params = array();
1618
-        }
1619
-        /**
1620
-         * Action called before a model update call has been made.
1621
-         *
1622
-         * @param EEM_Base $model
1623
-         * @param array    $fields_n_values the updated fields and their new values
1624
-         * @param array    $query_params    @see EEM_Base::get_all()
1625
-         */
1626
-        do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1627
-        /**
1628
-         * Filters the fields about to be updated given the query parameters. You can provide the
1629
-         * $query_params to $this->get_all() to find exactly which records will be updated
1630
-         *
1631
-         * @param array    $fields_n_values fields and their new values
1632
-         * @param EEM_Base $model           the model being queried
1633
-         * @param array    $query_params    see EEM_Base::get_all()
1634
-         */
1635
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1636
-            $query_params);
1637
-        //need to verify that, for any entry we want to update, there are entries in each secondary table.
1638
-        //to do that, for each table, verify that it's PK isn't null.
1639
-        $tables = $this->get_tables();
1640
-        //and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
1641
-        //NOTE: we should make this code more efficient by NOT querying twice
1642
-        //before the real update, but that needs to first go through ALPHA testing
1643
-        //as it's dangerous. says Mike August 8 2014
1644
-        //we want to make sure the default_where strategy is ignored
1645
-        $this->_ignore_where_strategy = true;
1646
-        $wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1647
-        foreach ($wpdb_select_results as $wpdb_result) {
1648
-            // type cast stdClass as array
1649
-            $wpdb_result = (array)$wpdb_result;
1650
-            //get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1651
-            if ($this->has_primary_key_field()) {
1652
-                $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1653
-            } else {
1654
-                //if there's no primary key, we basically can't support having a 2nd table on the model (we could but it would be lots of work)
1655
-                $main_table_pk_value = null;
1656
-            }
1657
-            //if there are more than 1 tables, we'll want to verify that each table for this model has an entry in the other tables
1658
-            //and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
1659
-            if (count($tables) > 1) {
1660
-                //foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1661
-                //in that table, and so we'll want to insert one
1662
-                foreach ($tables as $table_obj) {
1663
-                    $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1664
-                    //if there is no private key for this table on the results, it means there's no entry
1665
-                    //in this table, right? so insert a row in the current table, using any fields available
1666
-                    if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1667
-                           && $wpdb_result[$this_table_pk_column])
1668
-                    ) {
1669
-                        $success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1670
-                            $main_table_pk_value);
1671
-                        //if we died here, report the error
1672
-                        if (! $success) {
1673
-                            return false;
1674
-                        }
1675
-                    }
1676
-                }
1677
-            }
1678
-            //				//and now check that if we have cached any models by that ID on the model, that
1679
-            //				//they also get updated properly
1680
-            //				$model_object = $this->get_from_entity_map( $main_table_pk_value );
1681
-            //				if( $model_object ){
1682
-            //					foreach( $fields_n_values as $field => $value ){
1683
-            //						$model_object->set($field, $value);
1684
-            //let's make sure default_where strategy is followed now
1685
-            $this->_ignore_where_strategy = false;
1686
-        }
1687
-        //if we want to keep model objects in sync, AND
1688
-        //if this wasn't called from a model object (to update itself)
1689
-        //then we want to make sure we keep all the existing
1690
-        //model objects in sync with the db
1691
-        if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1692
-            if ($this->has_primary_key_field()) {
1693
-                $model_objs_affected_ids = $this->get_col($query_params);
1694
-            } else {
1695
-                //we need to select a bunch of columns and then combine them into the the "index primary key string"s
1696
-                $models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1697
-                $model_objs_affected_ids = array();
1698
-                foreach ($models_affected_key_columns as $row) {
1699
-                    $combined_index_key = $this->get_index_primary_key_string($row);
1700
-                    $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1701
-                }
1702
-            }
1703
-            if (! $model_objs_affected_ids) {
1704
-                //wait wait wait- if nothing was affected let's stop here
1705
-                return 0;
1706
-            }
1707
-            foreach ($model_objs_affected_ids as $id) {
1708
-                $model_obj_in_entity_map = $this->get_from_entity_map($id);
1709
-                if ($model_obj_in_entity_map) {
1710
-                    foreach ($fields_n_values as $field => $new_value) {
1711
-                        $model_obj_in_entity_map->set($field, $new_value);
1712
-                    }
1713
-                }
1714
-            }
1715
-            //if there is a primary key on this model, we can now do a slight optimization
1716
-            if ($this->has_primary_key_field()) {
1717
-                //we already know what we want to update. So let's make the query simpler so it's a little more efficient
1718
-                $query_params = array(
1719
-                    array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1720
-                    'limit'                    => count($model_objs_affected_ids),
1721
-                    'default_where_conditions' => EEM_Base::default_where_conditions_none,
1722
-                );
1723
-            }
1724
-        }
1725
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1726
-        $SQL = "UPDATE "
1727
-               . $model_query_info->get_full_join_sql()
1728
-               . " SET "
1729
-               . $this->_construct_update_sql($fields_n_values)
1730
-               . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1731
-        $rows_affected = $this->_do_wpdb_query('query', array($SQL));
1732
-        /**
1733
-         * Action called after a model update call has been made.
1734
-         *
1735
-         * @param EEM_Base $model
1736
-         * @param array    $fields_n_values the updated fields and their new values
1737
-         * @param array    $query_params    @see EEM_Base::get_all()
1738
-         * @param int      $rows_affected
1739
-         */
1740
-        do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1741
-        return $rows_affected;//how many supposedly got updated
1742
-    }
1743
-
1744
-
1745
-
1746
-    /**
1747
-     * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1748
-     * are teh values of the field specified (or by default the primary key field)
1749
-     * that matched the query params. Note that you should pass the name of the
1750
-     * model FIELD, not the database table's column name.
1751
-     *
1752
-     * @param array  $query_params @see EEM_Base::get_all()
1753
-     * @param string $field_to_select
1754
-     * @return array just like $wpdb->get_col()
1755
-     * @throws \EE_Error
1756
-     */
1757
-    public function get_col($query_params = array(), $field_to_select = null)
1758
-    {
1759
-        if ($field_to_select) {
1760
-            $field = $this->field_settings_for($field_to_select);
1761
-        } elseif ($this->has_primary_key_field()) {
1762
-            $field = $this->get_primary_key_field();
1763
-        } else {
1764
-            //no primary key, just grab the first column
1765
-            $field = reset($this->field_settings());
1766
-        }
1767
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1768
-        $select_expressions = $field->get_qualified_column();
1769
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1770
-        return $this->_do_wpdb_query('get_col', array($SQL));
1771
-    }
1772
-
1773
-
1774
-
1775
-    /**
1776
-     * Returns a single column value for a single row from the database
1777
-     *
1778
-     * @param array  $query_params    @see EEM_Base::get_all()
1779
-     * @param string $field_to_select @see EEM_Base::get_col()
1780
-     * @return string
1781
-     * @throws \EE_Error
1782
-     */
1783
-    public function get_var($query_params = array(), $field_to_select = null)
1784
-    {
1785
-        $query_params['limit'] = 1;
1786
-        $col = $this->get_col($query_params, $field_to_select);
1787
-        if (! empty($col)) {
1788
-            return reset($col);
1789
-        } else {
1790
-            return null;
1791
-        }
1792
-    }
1793
-
1794
-
1795
-
1796
-    /**
1797
-     * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1798
-     * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1799
-     * injection, but currently no further filtering is done
1800
-     *
1801
-     * @global      $wpdb
1802
-     * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1803
-     *                               be updated to in the DB
1804
-     * @return string of SQL
1805
-     * @throws \EE_Error
1806
-     */
1807
-    public function _construct_update_sql($fields_n_values)
1808
-    {
1809
-        /** @type WPDB $wpdb */
1810
-        global $wpdb;
1811
-        $cols_n_values = array();
1812
-        foreach ($fields_n_values as $field_name => $value) {
1813
-            $field_obj = $this->field_settings_for($field_name);
1814
-            //if the value is NULL, we want to assign the value to that.
1815
-            //wpdb->prepare doesn't really handle that properly
1816
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1817
-            $value_sql = $prepared_value === null ? 'NULL'
1818
-                : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1819
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1820
-        }
1821
-        return implode(",", $cols_n_values);
1822
-    }
1823
-
1824
-
1825
-
1826
-    /**
1827
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1828
-     * Performs a HARD delete, meaning the database row should always be removed,
1829
-     * not just have a flag field on it switched
1830
-     * Wrapper for EEM_Base::delete_permanently()
1831
-     *
1832
-     * @param mixed $id
1833
-     * @return boolean whether the row got deleted or not
1834
-     * @throws \EE_Error
1835
-     */
1836
-    public function delete_permanently_by_ID($id)
1837
-    {
1838
-        return $this->delete_permanently(
1839
-            array(
1840
-                array($this->get_primary_key_field()->get_name() => $id),
1841
-                'limit' => 1,
1842
-            )
1843
-        );
1844
-    }
1845
-
1846
-
1847
-
1848
-    /**
1849
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1850
-     * Wrapper for EEM_Base::delete()
1851
-     *
1852
-     * @param mixed $id
1853
-     * @return boolean whether the row got deleted or not
1854
-     * @throws \EE_Error
1855
-     */
1856
-    public function delete_by_ID($id)
1857
-    {
1858
-        return $this->delete(
1859
-            array(
1860
-                array($this->get_primary_key_field()->get_name() => $id),
1861
-                'limit' => 1,
1862
-            )
1863
-        );
1864
-    }
1865
-
1866
-
1867
-
1868
-    /**
1869
-     * Identical to delete_permanently, but does a "soft" delete if possible,
1870
-     * meaning if the model has a field that indicates its been "trashed" or
1871
-     * "soft deleted", we will just set that instead of actually deleting the rows.
1872
-     *
1873
-     * @see EEM_Base::delete_permanently
1874
-     * @param array   $query_params
1875
-     * @param boolean $allow_blocking
1876
-     * @return int how many rows got deleted
1877
-     * @throws \EE_Error
1878
-     */
1879
-    public function delete($query_params, $allow_blocking = true)
1880
-    {
1881
-        return $this->delete_permanently($query_params, $allow_blocking);
1882
-    }
1883
-
1884
-
1885
-
1886
-    /**
1887
-     * Deletes the model objects that meet the query params. Note: this method is overridden
1888
-     * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1889
-     * as archived, not actually deleted
1890
-     *
1891
-     * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1892
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1893
-     *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1894
-     *                                deletes regardless of other objects which may depend on it. Its generally
1895
-     *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1896
-     *                                DB
1897
-     * @return int how many rows got deleted
1898
-     * @throws \EE_Error
1899
-     */
1900
-    public function delete_permanently($query_params, $allow_blocking = true)
1901
-    {
1902
-        /**
1903
-         * Action called just before performing a real deletion query. You can use the
1904
-         * model and its $query_params to find exactly which items will be deleted
1905
-         *
1906
-         * @param EEM_Base $model
1907
-         * @param array    $query_params   @see EEM_Base::get_all()
1908
-         * @param boolean  $allow_blocking whether or not to allow related model objects
1909
-         *                                 to block (prevent) this deletion
1910
-         */
1911
-        do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1912
-        //some MySQL databases may be running safe mode, which may restrict
1913
-        //deletion if there is no KEY column used in the WHERE statement of a deletion.
1914
-        //to get around this, we first do a SELECT, get all the IDs, and then run another query
1915
-        //to delete them
1916
-        $items_for_deletion = $this->_get_all_wpdb_results($query_params);
1917
-        $deletion_where = $this->_setup_ids_for_delete($items_for_deletion, $allow_blocking);
1918
-        if ($deletion_where) {
1919
-            //echo "objects for deletion:";var_dump($objects_for_deletion);
1920
-            $model_query_info = $this->_create_model_query_info_carrier($query_params);
1921
-            $table_aliases = array_keys($this->_tables);
1922
-            $SQL = "DELETE "
1923
-                   . implode(", ", $table_aliases)
1924
-                   . " FROM "
1925
-                   . $model_query_info->get_full_join_sql()
1926
-                   . " WHERE "
1927
-                   . $deletion_where;
1928
-            //		/echo "delete sql:$SQL";
1929
-            $rows_deleted = $this->_do_wpdb_query('query', array($SQL));
1930
-        } else {
1931
-            $rows_deleted = 0;
1932
-        }
1933
-        //and lastly make sure those items are removed from the entity map; if they could be put into it at all
1934
-        if ($this->has_primary_key_field()) {
1935
-            foreach ($items_for_deletion as $item_for_deletion_row) {
1936
-                $pk_value = $item_for_deletion_row[$this->get_primary_key_field()->get_qualified_column()];
1937
-                if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value])) {
1938
-                    unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value]);
1939
-                }
1940
-            }
1941
-        }
1942
-        /**
1943
-         * Action called just after performing a real deletion query. Although at this point the
1944
-         * items should have been deleted
1945
-         *
1946
-         * @param EEM_Base $model
1947
-         * @param array    $query_params @see EEM_Base::get_all()
1948
-         * @param int      $rows_deleted
1949
-         */
1950
-        do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
1951
-        return $rows_deleted;//how many supposedly got deleted
1952
-    }
1953
-
1954
-
1955
-
1956
-    /**
1957
-     * Checks all the relations that throw error messages when there are blocking related objects
1958
-     * for related model objects. If there are any related model objects on those relations,
1959
-     * adds an EE_Error, and return true
1960
-     *
1961
-     * @param EE_Base_Class|int $this_model_obj_or_id
1962
-     * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
1963
-     *                                                 should be ignored when determining whether there are related
1964
-     *                                                 model objects which block this model object's deletion. Useful
1965
-     *                                                 if you know A is related to B and are considering deleting A,
1966
-     *                                                 but want to see if A has any other objects blocking its deletion
1967
-     *                                                 before removing the relation between A and B
1968
-     * @return boolean
1969
-     * @throws \EE_Error
1970
-     */
1971
-    public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
1972
-    {
1973
-        //first, if $ignore_this_model_obj was supplied, get its model
1974
-        if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
1975
-            $ignored_model = $ignore_this_model_obj->get_model();
1976
-        } else {
1977
-            $ignored_model = null;
1978
-        }
1979
-        //now check all the relations of $this_model_obj_or_id and see if there
1980
-        //are any related model objects blocking it?
1981
-        $is_blocked = false;
1982
-        foreach ($this->_model_relations as $relation_name => $relation_obj) {
1983
-            if ($relation_obj->block_delete_if_related_models_exist()) {
1984
-                //if $ignore_this_model_obj was supplied, then for the query
1985
-                //on that model needs to be told to ignore $ignore_this_model_obj
1986
-                if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
1987
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
1988
-                        array(
1989
-                            $ignored_model->get_primary_key_field()->get_name() => array(
1990
-                                '!=',
1991
-                                $ignore_this_model_obj->ID(),
1992
-                            ),
1993
-                        ),
1994
-                    ));
1995
-                } else {
1996
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
1997
-                }
1998
-                if ($related_model_objects) {
1999
-                    EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
2000
-                    $is_blocked = true;
2001
-                }
2002
-            }
2003
-        }
2004
-        return $is_blocked;
2005
-    }
2006
-
2007
-
2008
-
2009
-    /**
2010
-     * This sets up our delete where sql and accounts for if we have secondary tables that will have rows deleted as
2011
-     * well.
2012
-     *
2013
-     * @param  array  $objects_for_deletion This should be the values returned by $this->_get_all_wpdb_results()
2014
-     * @param boolean $allow_blocking       if TRUE, matched objects will only be deleted if there is no related model
2015
-     *                                      info that blocks it (ie, there' sno other data that depends on this data);
2016
-     *                                      if false, deletes regardless of other objects which may depend on it. Its
2017
-     *                                      generally advisable to always leave this as TRUE, otherwise you could
2018
-     *                                      easily corrupt your DB
2019
-     * @throws EE_Error
2020
-     * @return string    everything that comes after the WHERE statement.
2021
-     */
2022
-    protected function _setup_ids_for_delete($objects_for_deletion, $allow_blocking = true)
2023
-    {
2024
-        if ($this->has_primary_key_field()) {
2025
-            $primary_table = $this->_get_main_table();
2026
-            $other_tables = $this->_get_other_tables();
2027
-            $deletes = $query = array();
2028
-            foreach ($objects_for_deletion as $delete_object) {
2029
-                //before we mark this object for deletion,
2030
-                //make sure there's no related objects blocking its deletion (if we're checking)
2031
-                if (
2032
-                    $allow_blocking
2033
-                    && $this->delete_is_blocked_by_related_models(
2034
-                        $delete_object[$primary_table->get_fully_qualified_pk_column()]
2035
-                    )
2036
-                ) {
2037
-                    continue;
2038
-                }
2039
-                //primary table deletes
2040
-                if (isset($delete_object[$primary_table->get_fully_qualified_pk_column()])) {
2041
-                    $deletes[$primary_table->get_fully_qualified_pk_column()][] = $delete_object[$primary_table->get_fully_qualified_pk_column()];
2042
-                }
2043
-                //other tables
2044
-                if (! empty($other_tables)) {
2045
-                    foreach ($other_tables as $ot) {
2046
-                        //first check if we've got the foreign key column here.
2047
-                        if (isset($delete_object[$ot->get_fully_qualified_fk_column()])) {
2048
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_fk_column()];
2049
-                        }
2050
-                        // wait! it's entirely possible that we'll have a the primary key
2051
-                        // for this table in here, if it's a foreign key for one of the other secondary tables
2052
-                        if (isset($delete_object[$ot->get_fully_qualified_pk_column()])) {
2053
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
2054
-                        }
2055
-                        // finally, it is possible that the fk for this table is found
2056
-                        // in the fully qualified pk column for the fk table, so let's see if that's there!
2057
-                        if (isset($delete_object[$ot->get_fully_qualified_pk_on_fk_table()])) {
2058
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
2059
-                        }
2060
-                    }
2061
-                }
2062
-            }
2063
-            //we should have deletes now, so let's just go through and setup the where statement
2064
-            foreach ($deletes as $column => $values) {
2065
-                //make sure we have unique $values;
2066
-                $values = array_unique($values);
2067
-                $query[] = $column . ' IN(' . implode(",", $values) . ')';
2068
-            }
2069
-            return ! empty($query) ? implode(' AND ', $query) : '';
2070
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
2071
-            $ways_to_identify_a_row = array();
2072
-            $fields = $this->get_combined_primary_key_fields();
2073
-            //note: because there' sno primary key, that means nothing else  can be pointing to this model, right?
2074
-            foreach ($objects_for_deletion as $delete_object) {
2075
-                $values_for_each_cpk_for_a_row = array();
2076
-                foreach ($fields as $cpk_field) {
2077
-                    if ($cpk_field instanceof EE_Model_Field_Base) {
2078
-                        $values_for_each_cpk_for_a_row[] = $cpk_field->get_qualified_column()
2079
-                                                           . "="
2080
-                                                           . $delete_object[$cpk_field->get_qualified_column()];
2081
-                    }
2082
-                }
2083
-                $ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
2084
-            }
2085
-            return implode(" OR ", $ways_to_identify_a_row);
2086
-        } else {
2087
-            //so there's no primary key and no combined key...
2088
-            //sorry, can't help you
2089
-            throw new EE_Error(sprintf(__("Cannot delete objects of type %s because there is no primary key NOR combined key",
2090
-                "event_espresso"), get_class($this)));
2091
-        }
2092
-    }
2093
-
2094
-
2095
-
2096
-    /**
2097
-     * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
2098
-     * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
2099
-     * column
2100
-     *
2101
-     * @param array  $query_params   like EEM_Base::get_all's
2102
-     * @param string $field_to_count field on model to count by (not column name)
2103
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2104
-     *                               that by the setting $distinct to TRUE;
2105
-     * @return int
2106
-     * @throws \EE_Error
2107
-     */
2108
-    public function count($query_params = array(), $field_to_count = null, $distinct = false)
2109
-    {
2110
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2111
-        if ($field_to_count) {
2112
-            $field_obj = $this->field_settings_for($field_to_count);
2113
-            $column_to_count = $field_obj->get_qualified_column();
2114
-        } elseif ($this->has_primary_key_field()) {
2115
-            $pk_field_obj = $this->get_primary_key_field();
2116
-            $column_to_count = $pk_field_obj->get_qualified_column();
2117
-        } else {
2118
-            //there's no primary key
2119
-            //if we're counting distinct items, and there's no primary key,
2120
-            //we need to list out the columns for distinction;
2121
-            //otherwise we can just use star
2122
-            if ($distinct) {
2123
-                $columns_to_use = array();
2124
-                foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2125
-                    $columns_to_use[] = $field_obj->get_qualified_column();
2126
-                }
2127
-                $column_to_count = implode(',', $columns_to_use);
2128
-            } else {
2129
-                $column_to_count = '*';
2130
-            }
2131
-        }
2132
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2133
-        $SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2134
-        return (int)$this->_do_wpdb_query('get_var', array($SQL));
2135
-    }
2136
-
2137
-
2138
-
2139
-    /**
2140
-     * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2141
-     *
2142
-     * @param array  $query_params like EEM_Base::get_all
2143
-     * @param string $field_to_sum name of field (array key in $_fields array)
2144
-     * @return float
2145
-     * @throws \EE_Error
2146
-     */
2147
-    public function sum($query_params, $field_to_sum = null)
2148
-    {
2149
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2150
-        if ($field_to_sum) {
2151
-            $field_obj = $this->field_settings_for($field_to_sum);
2152
-        } else {
2153
-            $field_obj = $this->get_primary_key_field();
2154
-        }
2155
-        $column_to_count = $field_obj->get_qualified_column();
2156
-        $SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2157
-        $return_value = $this->_do_wpdb_query('get_var', array($SQL));
2158
-        $data_type = $field_obj->get_wpdb_data_type();
2159
-        if ($data_type === '%d' || $data_type === '%s') {
2160
-            return (float)$return_value;
2161
-        } else {//must be %f
2162
-            return (float)$return_value;
2163
-        }
2164
-    }
2165
-
2166
-
2167
-
2168
-    /**
2169
-     * Just calls the specified method on $wpdb with the given arguments
2170
-     * Consolidates a little extra error handling code
2171
-     *
2172
-     * @param string $wpdb_method
2173
-     * @param array  $arguments_to_provide
2174
-     * @throws EE_Error
2175
-     * @global wpdb  $wpdb
2176
-     * @return mixed
2177
-     */
2178
-    protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2179
-    {
2180
-        //if we're in maintenance mode level 2, DON'T run any queries
2181
-        //because level 2 indicates the database needs updating and
2182
-        //is probably out of sync with the code
2183
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2184
-            throw new EE_Error(sprintf(__("Event Espresso Level 2 Maintenance mode is active. That means EE can not run ANY database queries until the necessary migration scripts have run which will take EE out of maintenance mode level 2. Please inform support of this error.",
2185
-                "event_espresso")));
2186
-        }
2187
-        /** @type WPDB $wpdb */
2188
-        global $wpdb;
2189
-        if (! method_exists($wpdb, $wpdb_method)) {
2190
-            throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2191
-                'event_espresso'), $wpdb_method));
2192
-        }
2193
-        if (WP_DEBUG) {
2194
-            $old_show_errors_value = $wpdb->show_errors;
2195
-            $wpdb->show_errors(false);
2196
-        }
2197
-        $result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2198
-        $this->show_db_query_if_previously_requested($wpdb->last_query);
2199
-        if (WP_DEBUG) {
2200
-            $wpdb->show_errors($old_show_errors_value);
2201
-            if (! empty($wpdb->last_error)) {
2202
-                throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2203
-            } elseif ($result === false) {
2204
-                throw new EE_Error(sprintf(__('WPDB Error occurred, but no error message was logged by wpdb! The wpdb method called was "%1$s" and the arguments were "%2$s"',
2205
-                    'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2206
-            }
2207
-        } elseif ($result === false) {
2208
-            EE_Error::add_error(
2209
-                sprintf(
2210
-                    __('A database error has occurred. Turn on WP_DEBUG for more information.||A database error occurred doing wpdb method "%1$s", with arguments "%2$s". The error was "%3$s"',
2211
-                        'event_espresso'),
2212
-                    $wpdb_method,
2213
-                    var_export($arguments_to_provide, true),
2214
-                    $wpdb->last_error
2215
-                ),
2216
-                __FILE__,
2217
-                __FUNCTION__,
2218
-                __LINE__
2219
-            );
2220
-        }
2221
-        return $result;
2222
-    }
2223
-
2224
-
2225
-
2226
-    /**
2227
-     * Attempts to run the indicated WPDB method with the provided arguments,
2228
-     * and if there's an error tries to verify the DB is correct. Uses
2229
-     * the static property EEM_Base::$_db_verification_level to determine whether
2230
-     * we should try to fix the EE core db, the addons, or just give up
2231
-     *
2232
-     * @param string $wpdb_method
2233
-     * @param array  $arguments_to_provide
2234
-     * @return mixed
2235
-     */
2236
-    private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2237
-    {
2238
-        /** @type WPDB $wpdb */
2239
-        global $wpdb;
2240
-        $wpdb->last_error = null;
2241
-        $result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2242
-        // was there an error running the query? but we don't care on new activations
2243
-        // (we're going to setup the DB anyway on new activations)
2244
-        if (($result === false || ! empty($wpdb->last_error))
2245
-            && EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2246
-        ) {
2247
-            switch (EEM_Base::$_db_verification_level) {
2248
-                case EEM_Base::db_verified_none :
2249
-                    // let's double-check core's DB
2250
-                    $error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2251
-                    break;
2252
-                case EEM_Base::db_verified_core :
2253
-                    // STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2254
-                    $error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2255
-                    break;
2256
-                case EEM_Base::db_verified_addons :
2257
-                    // ummmm... you in trouble
2258
-                    return $result;
2259
-                    break;
2260
-            }
2261
-            if (! empty($error_message)) {
2262
-                EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2263
-                trigger_error($error_message);
2264
-            }
2265
-            return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2266
-        }
2267
-        return $result;
2268
-    }
2269
-
2270
-
2271
-
2272
-    /**
2273
-     * Verifies the EE core database is up-to-date and records that we've done it on
2274
-     * EEM_Base::$_db_verification_level
2275
-     *
2276
-     * @param string $wpdb_method
2277
-     * @param array  $arguments_to_provide
2278
-     * @return string
2279
-     */
2280
-    private function _verify_core_db($wpdb_method, $arguments_to_provide)
2281
-    {
2282
-        /** @type WPDB $wpdb */
2283
-        global $wpdb;
2284
-        //ok remember that we've already attempted fixing the core db, in case the problem persists
2285
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2286
-        $error_message = sprintf(
2287
-            __('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2288
-                'event_espresso'),
2289
-            $wpdb->last_error,
2290
-            $wpdb_method,
2291
-            wp_json_encode($arguments_to_provide)
2292
-        );
2293
-        EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2294
-        return $error_message;
2295
-    }
2296
-
2297
-
2298
-
2299
-    /**
2300
-     * Verifies the EE addons' database is up-to-date and records that we've done it on
2301
-     * EEM_Base::$_db_verification_level
2302
-     *
2303
-     * @param $wpdb_method
2304
-     * @param $arguments_to_provide
2305
-     * @return string
2306
-     */
2307
-    private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2308
-    {
2309
-        /** @type WPDB $wpdb */
2310
-        global $wpdb;
2311
-        //ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2312
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2313
-        $error_message = sprintf(
2314
-            __('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2315
-                'event_espresso'),
2316
-            $wpdb->last_error,
2317
-            $wpdb_method,
2318
-            wp_json_encode($arguments_to_provide)
2319
-        );
2320
-        EE_System::instance()->initialize_addons();
2321
-        return $error_message;
2322
-    }
2323
-
2324
-
2325
-
2326
-    /**
2327
-     * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2328
-     * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2329
-     * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2330
-     * ..."
2331
-     *
2332
-     * @param EE_Model_Query_Info_Carrier $model_query_info
2333
-     * @return string
2334
-     */
2335
-    private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2336
-    {
2337
-        return " FROM " . $model_query_info->get_full_join_sql() .
2338
-               $model_query_info->get_where_sql() .
2339
-               $model_query_info->get_group_by_sql() .
2340
-               $model_query_info->get_having_sql() .
2341
-               $model_query_info->get_order_by_sql() .
2342
-               $model_query_info->get_limit_sql();
2343
-    }
2344
-
2345
-
2346
-
2347
-    /**
2348
-     * Set to easily debug the next X queries ran from this model.
2349
-     *
2350
-     * @param int $count
2351
-     */
2352
-    public function show_next_x_db_queries($count = 1)
2353
-    {
2354
-        $this->_show_next_x_db_queries = $count;
2355
-    }
2356
-
2357
-
2358
-
2359
-    /**
2360
-     * @param $sql_query
2361
-     */
2362
-    public function show_db_query_if_previously_requested($sql_query)
2363
-    {
2364
-        if ($this->_show_next_x_db_queries > 0) {
2365
-            echo $sql_query;
2366
-            $this->_show_next_x_db_queries--;
2367
-        }
2368
-    }
2369
-
2370
-
2371
-
2372
-    /**
2373
-     * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2374
-     * There are the 3 cases:
2375
-     * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2376
-     * $otherModelObject has no ID, it is first saved.
2377
-     * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2378
-     * has no ID, it is first saved.
2379
-     * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2380
-     * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2381
-     * join table
2382
-     *
2383
-     * @param        EE_Base_Class                     /int $thisModelObject
2384
-     * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2385
-     * @param string $relationName                     , key in EEM_Base::_relations
2386
-     *                                                 an attendee to a group, you also want to specify which role they
2387
-     *                                                 will have in that group. So you would use this parameter to
2388
-     *                                                 specify array('role-column-name'=>'role-id')
2389
-     * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2390
-     *                                                 to for relation to methods that allow you to further specify
2391
-     *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2392
-     *                                                 only acceptable query_params is strict "col" => "value" pairs
2393
-     *                                                 because these will be inserted in any new rows created as well.
2394
-     * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2395
-     * @throws \EE_Error
2396
-     */
2397
-    public function add_relationship_to(
2398
-        $id_or_obj,
2399
-        $other_model_id_or_obj,
2400
-        $relationName,
2401
-        $extra_join_model_fields_n_values = array()
2402
-    ) {
2403
-        $relation_obj = $this->related_settings_for($relationName);
2404
-        return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2405
-    }
2406
-
2407
-
2408
-
2409
-    /**
2410
-     * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2411
-     * There are the 3 cases:
2412
-     * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2413
-     * error
2414
-     * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2415
-     * an error
2416
-     * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2417
-     *
2418
-     * @param        EE_Base_Class /int $id_or_obj
2419
-     * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2420
-     * @param string $relationName key in EEM_Base::_relations
2421
-     * @return boolean of success
2422
-     * @throws \EE_Error
2423
-     * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2424
-     *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2425
-     *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2426
-     *                             because these will be inserted in any new rows created as well.
2427
-     */
2428
-    public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2429
-    {
2430
-        $relation_obj = $this->related_settings_for($relationName);
2431
-        return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2432
-    }
2433
-
2434
-
2435
-
2436
-    /**
2437
-     * @param mixed           $id_or_obj
2438
-     * @param string          $relationName
2439
-     * @param array           $where_query_params
2440
-     * @param EE_Base_Class[] objects to which relations were removed
2441
-     * @return \EE_Base_Class[]
2442
-     * @throws \EE_Error
2443
-     */
2444
-    public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2445
-    {
2446
-        $relation_obj = $this->related_settings_for($relationName);
2447
-        return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2448
-    }
2449
-
2450
-
2451
-
2452
-    /**
2453
-     * Gets all the related items of the specified $model_name, using $query_params.
2454
-     * Note: by default, we remove the "default query params"
2455
-     * because we want to get even deleted items etc.
2456
-     *
2457
-     * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2458
-     * @param string $model_name   like 'Event', 'Registration', etc. always singular
2459
-     * @param array  $query_params like EEM_Base::get_all
2460
-     * @return EE_Base_Class[]
2461
-     * @throws \EE_Error
2462
-     */
2463
-    public function get_all_related($id_or_obj, $model_name, $query_params = null)
2464
-    {
2465
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2466
-        $relation_settings = $this->related_settings_for($model_name);
2467
-        return $relation_settings->get_all_related($model_obj, $query_params);
2468
-    }
2469
-
2470
-
2471
-
2472
-    /**
2473
-     * Deletes all the model objects across the relation indicated by $model_name
2474
-     * which are related to $id_or_obj which meet the criteria set in $query_params.
2475
-     * However, if the model objects can't be deleted because of blocking related model objects, then
2476
-     * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2477
-     *
2478
-     * @param EE_Base_Class|int|string $id_or_obj
2479
-     * @param string                   $model_name
2480
-     * @param array                    $query_params
2481
-     * @return int how many deleted
2482
-     * @throws \EE_Error
2483
-     */
2484
-    public function delete_related($id_or_obj, $model_name, $query_params = array())
2485
-    {
2486
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2487
-        $relation_settings = $this->related_settings_for($model_name);
2488
-        return $relation_settings->delete_all_related($model_obj, $query_params);
2489
-    }
2490
-
2491
-
2492
-
2493
-    /**
2494
-     * Hard deletes all the model objects across the relation indicated by $model_name
2495
-     * which are related to $id_or_obj which meet the criteria set in $query_params. If
2496
-     * the model objects can't be hard deleted because of blocking related model objects,
2497
-     * just does a soft-delete on them instead.
2498
-     *
2499
-     * @param EE_Base_Class|int|string $id_or_obj
2500
-     * @param string                   $model_name
2501
-     * @param array                    $query_params
2502
-     * @return int how many deleted
2503
-     * @throws \EE_Error
2504
-     */
2505
-    public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2506
-    {
2507
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2508
-        $relation_settings = $this->related_settings_for($model_name);
2509
-        return $relation_settings->delete_related_permanently($model_obj, $query_params);
2510
-    }
2511
-
2512
-
2513
-
2514
-    /**
2515
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2516
-     * unless otherwise specified in the $query_params
2517
-     *
2518
-     * @param        int             /EE_Base_Class $id_or_obj
2519
-     * @param string $model_name     like 'Event', or 'Registration'
2520
-     * @param array  $query_params   like EEM_Base::get_all's
2521
-     * @param string $field_to_count name of field to count by. By default, uses primary key
2522
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2523
-     *                               that by the setting $distinct to TRUE;
2524
-     * @return int
2525
-     * @throws \EE_Error
2526
-     */
2527
-    public function count_related(
2528
-        $id_or_obj,
2529
-        $model_name,
2530
-        $query_params = array(),
2531
-        $field_to_count = null,
2532
-        $distinct = false
2533
-    ) {
2534
-        $related_model = $this->get_related_model_obj($model_name);
2535
-        //we're just going to use the query params on the related model's normal get_all query,
2536
-        //except add a condition to say to match the current mod
2537
-        if (! isset($query_params['default_where_conditions'])) {
2538
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2539
-        }
2540
-        $this_model_name = $this->get_this_model_name();
2541
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2542
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2543
-        return $related_model->count($query_params, $field_to_count, $distinct);
2544
-    }
2545
-
2546
-
2547
-
2548
-    /**
2549
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
2550
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2551
-     *
2552
-     * @param        int           /EE_Base_Class $id_or_obj
2553
-     * @param string $model_name   like 'Event', or 'Registration'
2554
-     * @param array  $query_params like EEM_Base::get_all's
2555
-     * @param string $field_to_sum name of field to count by. By default, uses primary key
2556
-     * @return float
2557
-     * @throws \EE_Error
2558
-     */
2559
-    public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2560
-    {
2561
-        $related_model = $this->get_related_model_obj($model_name);
2562
-        if (! is_array($query_params)) {
2563
-            EE_Error::doing_it_wrong('EEM_Base::sum_related',
2564
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2565
-                    gettype($query_params)), '4.6.0');
2566
-            $query_params = array();
2567
-        }
2568
-        //we're just going to use the query params on the related model's normal get_all query,
2569
-        //except add a condition to say to match the current mod
2570
-        if (! isset($query_params['default_where_conditions'])) {
2571
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2572
-        }
2573
-        $this_model_name = $this->get_this_model_name();
2574
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2575
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2576
-        return $related_model->sum($query_params, $field_to_sum);
2577
-    }
2578
-
2579
-
2580
-
2581
-    /**
2582
-     * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2583
-     * $modelObject
2584
-     *
2585
-     * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2586
-     * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2587
-     * @param array               $query_params     like EEM_Base::get_all's
2588
-     * @return EE_Base_Class
2589
-     * @throws \EE_Error
2590
-     */
2591
-    public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2592
-    {
2593
-        $query_params['limit'] = 1;
2594
-        $results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2595
-        if ($results) {
2596
-            return array_shift($results);
2597
-        } else {
2598
-            return null;
2599
-        }
2600
-    }
2601
-
2602
-
2603
-
2604
-    /**
2605
-     * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2606
-     *
2607
-     * @return string
2608
-     */
2609
-    public function get_this_model_name()
2610
-    {
2611
-        return str_replace("EEM_", "", get_class($this));
2612
-    }
2613
-
2614
-
2615
-
2616
-    /**
2617
-     * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2618
-     *
2619
-     * @return EE_Any_Foreign_Model_Name_Field
2620
-     * @throws EE_Error
2621
-     */
2622
-    public function get_field_containing_related_model_name()
2623
-    {
2624
-        foreach ($this->field_settings(true) as $field) {
2625
-            if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2626
-                $field_with_model_name = $field;
2627
-            }
2628
-        }
2629
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
2630
-            throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2631
-                $this->get_this_model_name()));
2632
-        }
2633
-        return $field_with_model_name;
2634
-    }
2635
-
2636
-
2637
-
2638
-    /**
2639
-     * Inserts a new entry into the database, for each table.
2640
-     * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2641
-     * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2642
-     * we also know there is no model object with the newly inserted item's ID at the moment (because
2643
-     * if there were, then they would already be in the DB and this would fail); and in the future if someone
2644
-     * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2645
-     * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2646
-     *
2647
-     * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2648
-     *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2649
-     *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2650
-     *                              of EEM_Base)
2651
-     * @return int new primary key on main table that got inserted
2652
-     * @throws EE_Error
2653
-     */
2654
-    public function insert($field_n_values)
2655
-    {
2656
-        /**
2657
-         * Filters the fields and their values before inserting an item using the models
2658
-         *
2659
-         * @param array    $fields_n_values keys are the fields and values are their new values
2660
-         * @param EEM_Base $model           the model used
2661
-         */
2662
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2663
-        if ($this->_satisfies_unique_indexes($field_n_values)) {
2664
-            $main_table = $this->_get_main_table();
2665
-            $new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2666
-            if ($new_id !== false) {
2667
-                foreach ($this->_get_other_tables() as $other_table) {
2668
-                    $this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2669
-                }
2670
-            }
2671
-            /**
2672
-             * Done just after attempting to insert a new model object
2673
-             *
2674
-             * @param EEM_Base   $model           used
2675
-             * @param array      $fields_n_values fields and their values
2676
-             * @param int|string the              ID of the newly-inserted model object
2677
-             */
2678
-            do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2679
-            return $new_id;
2680
-        } else {
2681
-            return false;
2682
-        }
2683
-    }
2684
-
2685
-
2686
-
2687
-    /**
2688
-     * Checks that the result would satisfy the unique indexes on this model
2689
-     *
2690
-     * @param array  $field_n_values
2691
-     * @param string $action
2692
-     * @return boolean
2693
-     * @throws \EE_Error
2694
-     */
2695
-    protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2696
-    {
2697
-        foreach ($this->unique_indexes() as $index_name => $index) {
2698
-            $uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2699
-            if ($this->exists(array($uniqueness_where_params))) {
2700
-                EE_Error::add_error(
2701
-                    sprintf(
2702
-                        __(
2703
-                            "Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2704
-                            "event_espresso"
2705
-                        ),
2706
-                        $action,
2707
-                        $this->_get_class_name(),
2708
-                        $index_name,
2709
-                        implode(",", $index->field_names()),
2710
-                        http_build_query($uniqueness_where_params)
2711
-                    ),
2712
-                    __FILE__,
2713
-                    __FUNCTION__,
2714
-                    __LINE__
2715
-                );
2716
-                return false;
2717
-            }
2718
-        }
2719
-        return true;
2720
-    }
2721
-
2722
-
2723
-
2724
-    /**
2725
-     * Checks the database for an item that conflicts (ie, if this item were
2726
-     * saved to the DB would break some uniqueness requirement, like a primary key
2727
-     * or an index primary key set) with the item specified. $id_obj_or_fields_array
2728
-     * can be either an EE_Base_Class or an array of fields n values
2729
-     *
2730
-     * @param EE_Base_Class|array $obj_or_fields_array
2731
-     * @param boolean             $include_primary_key whether to use the model object's primary key
2732
-     *                                                 when looking for conflicts
2733
-     *                                                 (ie, if false, we ignore the model object's primary key
2734
-     *                                                 when finding "conflicts". If true, it's also considered).
2735
-     *                                                 Only works for INT primary key,
2736
-     *                                                 STRING primary keys cannot be ignored
2737
-     * @throws EE_Error
2738
-     * @return EE_Base_Class|array
2739
-     */
2740
-    public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2741
-    {
2742
-        if ($obj_or_fields_array instanceof EE_Base_Class) {
2743
-            $fields_n_values = $obj_or_fields_array->model_field_array();
2744
-        } elseif (is_array($obj_or_fields_array)) {
2745
-            $fields_n_values = $obj_or_fields_array;
2746
-        } else {
2747
-            throw new EE_Error(
2748
-                sprintf(
2749
-                    __(
2750
-                        "%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2751
-                        "event_espresso"
2752
-                    ),
2753
-                    get_class($this),
2754
-                    $obj_or_fields_array
2755
-                )
2756
-            );
2757
-        }
2758
-        $query_params = array();
2759
-        if ($this->has_primary_key_field()
2760
-            && ($include_primary_key
2761
-                || $this->get_primary_key_field()
2762
-                   instanceof
2763
-                   EE_Primary_Key_String_Field)
2764
-            && isset($fields_n_values[$this->primary_key_name()])
2765
-        ) {
2766
-            $query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2767
-        }
2768
-        foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2769
-            $uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2770
-            $query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2771
-        }
2772
-        //if there is nothing to base this search on, then we shouldn't find anything
2773
-        if (empty($query_params)) {
2774
-            return array();
2775
-        } else {
2776
-            return $this->get_one($query_params);
2777
-        }
2778
-    }
2779
-
2780
-
2781
-
2782
-    /**
2783
-     * Like count, but is optimized and returns a boolean instead of an int
2784
-     *
2785
-     * @param array $query_params
2786
-     * @return boolean
2787
-     * @throws \EE_Error
2788
-     */
2789
-    public function exists($query_params)
2790
-    {
2791
-        $query_params['limit'] = 1;
2792
-        return $this->count($query_params) > 0;
2793
-    }
2794
-
2795
-
2796
-
2797
-    /**
2798
-     * Wrapper for exists, except ignores default query parameters so we're only considering ID
2799
-     *
2800
-     * @param int|string $id
2801
-     * @return boolean
2802
-     * @throws \EE_Error
2803
-     */
2804
-    public function exists_by_ID($id)
2805
-    {
2806
-        return $this->exists(
2807
-            array(
2808
-                'default_where_conditions' => EEM_Base::default_where_conditions_none,
2809
-                array(
2810
-                    $this->primary_key_name() => $id,
2811
-                ),
2812
-            )
2813
-        );
2814
-    }
2815
-
2816
-
2817
-
2818
-    /**
2819
-     * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2820
-     * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2821
-     * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2822
-     * on the main table)
2823
-     * This is protected rather than private because private is not accessible to any child methods and there MAY be
2824
-     * cases where we want to call it directly rather than via insert().
2825
-     *
2826
-     * @access   protected
2827
-     * @param EE_Table_Base $table
2828
-     * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2829
-     *                                       float
2830
-     * @param int           $new_id          for now we assume only int keys
2831
-     * @throws EE_Error
2832
-     * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2833
-     * @return int ID of new row inserted, or FALSE on failure
2834
-     */
2835
-    protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2836
-    {
2837
-        global $wpdb;
2838
-        $insertion_col_n_values = array();
2839
-        $format_for_insertion = array();
2840
-        $fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2841
-        foreach ($fields_on_table as $field_name => $field_obj) {
2842
-            //check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2843
-            if ($field_obj->is_auto_increment()) {
2844
-                continue;
2845
-            }
2846
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2847
-            //if the value we want to assign it to is NULL, just don't mention it for the insertion
2848
-            if ($prepared_value !== null) {
2849
-                $insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2850
-                $format_for_insertion[] = $field_obj->get_wpdb_data_type();
2851
-            }
2852
-        }
2853
-        if ($table instanceof EE_Secondary_Table && $new_id) {
2854
-            //its not the main table, so we should have already saved the main table's PK which we just inserted
2855
-            //so add the fk to the main table as a column
2856
-            $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2857
-            $format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2858
-        }
2859
-        //insert the new entry
2860
-        $result = $this->_do_wpdb_query('insert',
2861
-            array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2862
-        if ($result === false) {
2863
-            return false;
2864
-        }
2865
-        //ok, now what do we return for the ID of the newly-inserted thing?
2866
-        if ($this->has_primary_key_field()) {
2867
-            if ($this->get_primary_key_field()->is_auto_increment()) {
2868
-                return $wpdb->insert_id;
2869
-            } else {
2870
-                //it's not an auto-increment primary key, so
2871
-                //it must have been supplied
2872
-                return $fields_n_values[$this->get_primary_key_field()->get_name()];
2873
-            }
2874
-        } else {
2875
-            //we can't return a  primary key because there is none. instead return
2876
-            //a unique string indicating this model
2877
-            return $this->get_index_primary_key_string($fields_n_values);
2878
-        }
2879
-    }
2880
-
2881
-
2882
-
2883
-    /**
2884
-     * Prepare the $field_obj 's value in $fields_n_values for use in the database.
2885
-     * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
2886
-     * and there is no default, we pass it along. WPDB will take care of it)
2887
-     *
2888
-     * @param EE_Model_Field_Base $field_obj
2889
-     * @param array               $fields_n_values
2890
-     * @return mixed string|int|float depending on what the table column will be expecting
2891
-     * @throws \EE_Error
2892
-     */
2893
-    protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
2894
-    {
2895
-        //if this field doesn't allow nullable, don't allow it
2896
-        if (! $field_obj->is_nullable()
2897
-            && (
2898
-                ! isset($fields_n_values[$field_obj->get_name()]) || $fields_n_values[$field_obj->get_name()] === null)
2899
-        ) {
2900
-            $fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
2901
-        }
2902
-        $unprepared_value = isset($fields_n_values[$field_obj->get_name()]) ? $fields_n_values[$field_obj->get_name()]
2903
-            : null;
2904
-        return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
2905
-    }
2906
-
2907
-
2908
-
2909
-    /**
2910
-     * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
2911
-     * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
2912
-     * the field's prepare_for_set() method.
2913
-     *
2914
-     * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
2915
-     *                                   false, otherwise a value in the model object's domain (see lengthy comment at
2916
-     *                                   top of file)
2917
-     * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
2918
-     *                                   $value is a custom selection
2919
-     * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
2920
-     */
2921
-    private function _prepare_value_for_use_in_db($value, $field)
2922
-    {
2923
-        if ($field && $field instanceof EE_Model_Field_Base) {
2924
-            switch ($this->_values_already_prepared_by_model_object) {
2925
-                /** @noinspection PhpMissingBreakStatementInspection */
2926
-                case self::not_prepared_by_model_object:
2927
-                    $value = $field->prepare_for_set($value);
2928
-                //purposefully left out "return"
2929
-                case self::prepared_by_model_object:
2930
-                    $value = $field->prepare_for_use_in_db($value);
2931
-                case self::prepared_for_use_in_db:
2932
-                    //leave the value alone
2933
-            }
2934
-            return $value;
2935
-        } else {
2936
-            return $value;
2937
-        }
2938
-    }
2939
-
2940
-
2941
-
2942
-    /**
2943
-     * Returns the main table on this model
2944
-     *
2945
-     * @return EE_Primary_Table
2946
-     * @throws EE_Error
2947
-     */
2948
-    protected function _get_main_table()
2949
-    {
2950
-        foreach ($this->_tables as $table) {
2951
-            if ($table instanceof EE_Primary_Table) {
2952
-                return $table;
2953
-            }
2954
-        }
2955
-        throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
2956
-            'event_espresso'), get_class($this)));
2957
-    }
2958
-
2959
-
2960
-
2961
-    /**
2962
-     * table
2963
-     * returns EE_Primary_Table table name
2964
-     *
2965
-     * @return string
2966
-     * @throws \EE_Error
2967
-     */
2968
-    public function table()
2969
-    {
2970
-        return $this->_get_main_table()->get_table_name();
2971
-    }
2972
-
2973
-
2974
-
2975
-    /**
2976
-     * table
2977
-     * returns first EE_Secondary_Table table name
2978
-     *
2979
-     * @return string
2980
-     */
2981
-    public function second_table()
2982
-    {
2983
-        // grab second table from tables array
2984
-        $second_table = end($this->_tables);
2985
-        return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
2986
-    }
2987
-
2988
-
2989
-
2990
-    /**
2991
-     * get_table_obj_by_alias
2992
-     * returns table name given it's alias
2993
-     *
2994
-     * @param string $table_alias
2995
-     * @return EE_Primary_Table | EE_Secondary_Table
2996
-     */
2997
-    public function get_table_obj_by_alias($table_alias = '')
2998
-    {
2999
-        return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
3000
-    }
3001
-
3002
-
3003
-
3004
-    /**
3005
-     * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
3006
-     *
3007
-     * @return EE_Secondary_Table[]
3008
-     */
3009
-    protected function _get_other_tables()
3010
-    {
3011
-        $other_tables = array();
3012
-        foreach ($this->_tables as $table_alias => $table) {
3013
-            if ($table instanceof EE_Secondary_Table) {
3014
-                $other_tables[$table_alias] = $table;
3015
-            }
3016
-        }
3017
-        return $other_tables;
3018
-    }
3019
-
3020
-
3021
-
3022
-    /**
3023
-     * Finds all the fields that correspond to the given table
3024
-     *
3025
-     * @param string $table_alias , array key in EEM_Base::_tables
3026
-     * @return EE_Model_Field_Base[]
3027
-     */
3028
-    public function _get_fields_for_table($table_alias)
3029
-    {
3030
-        return $this->_fields[$table_alias];
3031
-    }
3032
-
3033
-
3034
-
3035
-    /**
3036
-     * Recurses through all the where parameters, and finds all the related models we'll need
3037
-     * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
3038
-     * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
3039
-     * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
3040
-     * related Registration, Transaction, and Payment models.
3041
-     *
3042
-     * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
3043
-     * @return EE_Model_Query_Info_Carrier
3044
-     * @throws \EE_Error
3045
-     */
3046
-    public function _extract_related_models_from_query($query_params)
3047
-    {
3048
-        $query_info_carrier = new EE_Model_Query_Info_Carrier();
3049
-        if (array_key_exists(0, $query_params)) {
3050
-            $this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
3051
-        }
3052
-        if (array_key_exists('group_by', $query_params)) {
3053
-            if (is_array($query_params['group_by'])) {
3054
-                $this->_extract_related_models_from_sub_params_array_values(
3055
-                    $query_params['group_by'],
3056
-                    $query_info_carrier,
3057
-                    'group_by'
3058
-                );
3059
-            } elseif (! empty ($query_params['group_by'])) {
3060
-                $this->_extract_related_model_info_from_query_param(
3061
-                    $query_params['group_by'],
3062
-                    $query_info_carrier,
3063
-                    'group_by'
3064
-                );
3065
-            }
3066
-        }
3067
-        if (array_key_exists('having', $query_params)) {
3068
-            $this->_extract_related_models_from_sub_params_array_keys(
3069
-                $query_params[0],
3070
-                $query_info_carrier,
3071
-                'having'
3072
-            );
3073
-        }
3074
-        if (array_key_exists('order_by', $query_params)) {
3075
-            if (is_array($query_params['order_by'])) {
3076
-                $this->_extract_related_models_from_sub_params_array_keys(
3077
-                    $query_params['order_by'],
3078
-                    $query_info_carrier,
3079
-                    'order_by'
3080
-                );
3081
-            } elseif (! empty($query_params['order_by'])) {
3082
-                $this->_extract_related_model_info_from_query_param(
3083
-                    $query_params['order_by'],
3084
-                    $query_info_carrier,
3085
-                    'order_by'
3086
-                );
3087
-            }
3088
-        }
3089
-        if (array_key_exists('force_join', $query_params)) {
3090
-            $this->_extract_related_models_from_sub_params_array_values(
3091
-                $query_params['force_join'],
3092
-                $query_info_carrier,
3093
-                'force_join'
3094
-            );
3095
-        }
3096
-        return $query_info_carrier;
3097
-    }
3098
-
3099
-
3100
-
3101
-    /**
3102
-     * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
3103
-     *
3104
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3105
-     *                                                      $query_params['having']
3106
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3107
-     * @param string                      $query_param_type one of $this->_allowed_query_params
3108
-     * @throws EE_Error
3109
-     * @return \EE_Model_Query_Info_Carrier
3110
-     */
3111
-    private function _extract_related_models_from_sub_params_array_keys(
3112
-        $sub_query_params,
3113
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3114
-        $query_param_type
3115
-    ) {
3116
-        if (! empty($sub_query_params)) {
3117
-            $sub_query_params = (array)$sub_query_params;
3118
-            foreach ($sub_query_params as $param => $possibly_array_of_params) {
3119
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3120
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3121
-                    $query_param_type);
3122
-                //if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3123
-                //indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3124
-                //extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3125
-                //of array('Registration.TXN_ID'=>23)
3126
-                $query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3127
-                if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3128
-                    if (! is_array($possibly_array_of_params)) {
3129
-                        throw new EE_Error(sprintf(__("You used a special where query param %s, but the value isn't an array of where query params, it's just %s'. It should be an array, eg array('EVT_ID'=>23,'OR'=>array('Venue.VNU_ID'=>32,'Venue.VNU_name'=>'monkey_land'))",
3130
-                            "event_espresso"),
3131
-                            $param, $possibly_array_of_params));
3132
-                    } else {
3133
-                        $this->_extract_related_models_from_sub_params_array_keys($possibly_array_of_params,
3134
-                            $model_query_info_carrier, $query_param_type);
3135
-                    }
3136
-                } elseif ($query_param_type === 0 //ie WHERE
3137
-                          && is_array($possibly_array_of_params)
3138
-                          && isset($possibly_array_of_params[2])
3139
-                          && $possibly_array_of_params[2] == true
3140
-                ) {
3141
-                    //then $possible_array_of_params looks something like array('<','DTT_sold',true)
3142
-                    //indicating that $possible_array_of_params[1] is actually a field name,
3143
-                    //from which we should extract query parameters!
3144
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3145
-                        throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3146
-                            "event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3147
-                    }
3148
-                    $this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3149
-                        $model_query_info_carrier, $query_param_type);
3150
-                }
3151
-            }
3152
-        }
3153
-        return $model_query_info_carrier;
3154
-    }
3155
-
3156
-
3157
-
3158
-    /**
3159
-     * For extracting related models from forced_joins, where the array values contain the info about what
3160
-     * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3161
-     *
3162
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3163
-     *                                                      $query_params['having']
3164
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3165
-     * @param string                      $query_param_type one of $this->_allowed_query_params
3166
-     * @throws EE_Error
3167
-     * @return \EE_Model_Query_Info_Carrier
3168
-     */
3169
-    private function _extract_related_models_from_sub_params_array_values(
3170
-        $sub_query_params,
3171
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3172
-        $query_param_type
3173
-    ) {
3174
-        if (! empty($sub_query_params)) {
3175
-            if (! is_array($sub_query_params)) {
3176
-                throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3177
-                    $sub_query_params));
3178
-            }
3179
-            foreach ($sub_query_params as $param) {
3180
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3181
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3182
-                    $query_param_type);
3183
-            }
3184
-        }
3185
-        return $model_query_info_carrier;
3186
-    }
3187
-
3188
-
3189
-
3190
-    /**
3191
-     * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3192
-     * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3193
-     * instead of directly constructing the SQL because often we need to extract info from the $query_params
3194
-     * but use them in a different order. Eg, we need to know what models we are querying
3195
-     * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3196
-     * other models before we can finalize the where clause SQL.
3197
-     *
3198
-     * @param array $query_params
3199
-     * @throws EE_Error
3200
-     * @return EE_Model_Query_Info_Carrier
3201
-     */
3202
-    public function _create_model_query_info_carrier($query_params)
3203
-    {
3204
-        if (! is_array($query_params)) {
3205
-            EE_Error::doing_it_wrong(
3206
-                'EEM_Base::_create_model_query_info_carrier',
3207
-                sprintf(
3208
-                    __(
3209
-                        '$query_params should be an array, you passed a variable of type %s',
3210
-                        'event_espresso'
3211
-                    ),
3212
-                    gettype($query_params)
3213
-                ),
3214
-                '4.6.0'
3215
-            );
3216
-            $query_params = array();
3217
-        }
3218
-        $where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3219
-        //first check if we should alter the query to account for caps or not
3220
-        //because the caps might require us to do extra joins
3221
-        if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3222
-            $query_params[0] = $where_query_params = array_replace_recursive(
3223
-                $where_query_params,
3224
-                $this->caps_where_conditions(
3225
-                    $query_params['caps']
3226
-                )
3227
-            );
3228
-        }
3229
-        $query_object = $this->_extract_related_models_from_query($query_params);
3230
-        //verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3231
-        foreach ($where_query_params as $key => $value) {
3232
-            if (is_int($key)) {
3233
-                throw new EE_Error(
3234
-                    sprintf(
3235
-                        __(
3236
-                            "WHERE query params must NOT be numerically-indexed. You provided the array key '%s' for value '%s' while querying model %s. All the query params provided were '%s' Please read documentation on EEM_Base::get_all.",
3237
-                            "event_espresso"
3238
-                        ),
3239
-                        $key,
3240
-                        var_export($value, true),
3241
-                        var_export($query_params, true),
3242
-                        get_class($this)
3243
-                    )
3244
-                );
3245
-            }
3246
-        }
3247
-        if (
3248
-            array_key_exists('default_where_conditions', $query_params)
3249
-            && ! empty($query_params['default_where_conditions'])
3250
-        ) {
3251
-            $use_default_where_conditions = $query_params['default_where_conditions'];
3252
-        } else {
3253
-            $use_default_where_conditions = EEM_Base::default_where_conditions_all;
3254
-        }
3255
-        $where_query_params = array_merge(
3256
-            $this->_get_default_where_conditions_for_models_in_query(
3257
-                $query_object,
3258
-                $use_default_where_conditions,
3259
-                $where_query_params
3260
-            ),
3261
-            $where_query_params
3262
-        );
3263
-        $query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3264
-        // if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3265
-        // So we need to setup a subquery and use that for the main join.
3266
-        // Note for now this only works on the primary table for the model.
3267
-        // So for instance, you could set the limit array like this:
3268
-        // array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3269
-        if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3270
-            $query_object->set_main_model_join_sql(
3271
-                $this->_construct_limit_join_select(
3272
-                    $query_params['on_join_limit'][0],
3273
-                    $query_params['on_join_limit'][1]
3274
-                )
3275
-            );
3276
-        }
3277
-        //set limit
3278
-        if (array_key_exists('limit', $query_params)) {
3279
-            if (is_array($query_params['limit'])) {
3280
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3281
-                    $e = sprintf(
3282
-                        __(
3283
-                            "Invalid DB query. You passed '%s' for the LIMIT, but only the following are valid: an integer, string representing an integer, a string like 'int,int', or an array like array(int,int)",
3284
-                            "event_espresso"
3285
-                        ),
3286
-                        http_build_query($query_params['limit'])
3287
-                    );
3288
-                    throw new EE_Error($e . "|" . $e);
3289
-                }
3290
-                //they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3291
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3292
-            } elseif (! empty ($query_params['limit'])) {
3293
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3294
-            }
3295
-        }
3296
-        //set order by
3297
-        if (array_key_exists('order_by', $query_params)) {
3298
-            if (is_array($query_params['order_by'])) {
3299
-                //if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3300
-                //specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3301
-                //including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3302
-                if (array_key_exists('order', $query_params)) {
3303
-                    throw new EE_Error(
3304
-                        sprintf(
3305
-                            __(
3306
-                                "In querying %s, we are using query parameter 'order_by' as an array (keys:%s,values:%s), and so we can't use query parameter 'order' (value %s). You should just use the 'order_by' parameter ",
3307
-                                "event_espresso"
3308
-                            ),
3309
-                            get_class($this),
3310
-                            implode(", ", array_keys($query_params['order_by'])),
3311
-                            implode(", ", $query_params['order_by']),
3312
-                            $query_params['order']
3313
-                        )
3314
-                    );
3315
-                }
3316
-                $this->_extract_related_models_from_sub_params_array_keys(
3317
-                    $query_params['order_by'],
3318
-                    $query_object,
3319
-                    'order_by'
3320
-                );
3321
-                //assume it's an array of fields to order by
3322
-                $order_array = array();
3323
-                foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3324
-                    $order = $this->_extract_order($order);
3325
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3326
-                }
3327
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3328
-            } elseif (! empty ($query_params['order_by'])) {
3329
-                $this->_extract_related_model_info_from_query_param(
3330
-                    $query_params['order_by'],
3331
-                    $query_object,
3332
-                    'order',
3333
-                    $query_params['order_by']
3334
-                );
3335
-                $order = isset($query_params['order'])
3336
-                    ? $this->_extract_order($query_params['order'])
3337
-                    : 'DESC';
3338
-                $query_object->set_order_by_sql(
3339
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3340
-                );
3341
-            }
3342
-        }
3343
-        //if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3344
-        if (! array_key_exists('order_by', $query_params)
3345
-            && array_key_exists('order', $query_params)
3346
-            && ! empty($query_params['order'])
3347
-        ) {
3348
-            $pk_field = $this->get_primary_key_field();
3349
-            $order = $this->_extract_order($query_params['order']);
3350
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3351
-        }
3352
-        //set group by
3353
-        if (array_key_exists('group_by', $query_params)) {
3354
-            if (is_array($query_params['group_by'])) {
3355
-                //it's an array, so assume we'll be grouping by a bunch of stuff
3356
-                $group_by_array = array();
3357
-                foreach ($query_params['group_by'] as $field_name_to_group_by) {
3358
-                    $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3359
-                }
3360
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3361
-            } elseif (! empty ($query_params['group_by'])) {
3362
-                $query_object->set_group_by_sql(
3363
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3364
-                );
3365
-            }
3366
-        }
3367
-        //set having
3368
-        if (array_key_exists('having', $query_params) && $query_params['having']) {
3369
-            $query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3370
-        }
3371
-        //now, just verify they didn't pass anything wack
3372
-        foreach ($query_params as $query_key => $query_value) {
3373
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
3374
-                throw new EE_Error(
3375
-                    sprintf(
3376
-                        __(
3377
-                            "You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3378
-                            'event_espresso'
3379
-                        ),
3380
-                        $query_key,
3381
-                        get_class($this),
3382
-                        //						print_r( $this->_allowed_query_params, TRUE )
3383
-                        implode(',', $this->_allowed_query_params)
3384
-                    )
3385
-                );
3386
-            }
3387
-        }
3388
-        $main_model_join_sql = $query_object->get_main_model_join_sql();
3389
-        if (empty($main_model_join_sql)) {
3390
-            $query_object->set_main_model_join_sql($this->_construct_internal_join());
3391
-        }
3392
-        return $query_object;
3393
-    }
3394
-
3395
-
3396
-
3397
-    /**
3398
-     * Gets the where conditions that should be imposed on the query based on the
3399
-     * context (eg reading frontend, backend, edit or delete).
3400
-     *
3401
-     * @param string $context one of EEM_Base::valid_cap_contexts()
3402
-     * @return array like EEM_Base::get_all() 's $query_params[0]
3403
-     * @throws \EE_Error
3404
-     */
3405
-    public function caps_where_conditions($context = self::caps_read)
3406
-    {
3407
-        EEM_Base::verify_is_valid_cap_context($context);
3408
-        $cap_where_conditions = array();
3409
-        $cap_restrictions = $this->caps_missing($context);
3410
-        /**
3411
-         * @var $cap_restrictions EE_Default_Where_Conditions[]
3412
-         */
3413
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3414
-            $cap_where_conditions = array_replace_recursive($cap_where_conditions,
3415
-                $restriction_if_no_cap->get_default_where_conditions());
3416
-        }
3417
-        return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3418
-            $cap_restrictions);
3419
-    }
3420
-
3421
-
3422
-
3423
-    /**
3424
-     * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3425
-     * otherwise throws an exception
3426
-     *
3427
-     * @param string $should_be_order_string
3428
-     * @return string either ASC, asc, DESC or desc
3429
-     * @throws EE_Error
3430
-     */
3431
-    private function _extract_order($should_be_order_string)
3432
-    {
3433
-        if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3434
-            return $should_be_order_string;
3435
-        } else {
3436
-            throw new EE_Error(sprintf(__("While performing a query on '%s', tried to use '%s' as an order parameter. ",
3437
-                "event_espresso"), get_class($this), $should_be_order_string));
3438
-        }
3439
-    }
3440
-
3441
-
3442
-
3443
-    /**
3444
-     * Looks at all the models which are included in this query, and asks each
3445
-     * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3446
-     * so they can be merged
3447
-     *
3448
-     * @param EE_Model_Query_Info_Carrier $query_info_carrier
3449
-     * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3450
-     *                                                                  'none' means NO default where conditions will
3451
-     *                                                                  be used AT ALL during this query.
3452
-     *                                                                  'other_models_only' means default where
3453
-     *                                                                  conditions from other models will be used, but
3454
-     *                                                                  not for this primary model. 'all', the default,
3455
-     *                                                                  means default where conditions will apply as
3456
-     *                                                                  normal
3457
-     * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3458
-     * @throws EE_Error
3459
-     * @return array like $query_params[0], see EEM_Base::get_all for documentation
3460
-     */
3461
-    private function _get_default_where_conditions_for_models_in_query(
3462
-        EE_Model_Query_Info_Carrier $query_info_carrier,
3463
-        $use_default_where_conditions = EEM_Base::default_where_conditions_all,
3464
-        $where_query_params = array()
3465
-    ) {
3466
-        $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3467
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3468
-            throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3469
-                "event_espresso"), $use_default_where_conditions,
3470
-                implode(", ", $allowed_used_default_where_conditions_values)));
3471
-        }
3472
-        $universal_query_params = array();
3473
-        if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3474
-            $universal_query_params = $this->_get_default_where_conditions();
3475
-        } else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3476
-            $universal_query_params = $this->_get_minimum_where_conditions();
3477
-        }
3478
-        foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3479
-            $related_model = $this->get_related_model_obj($model_name);
3480
-            if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3481
-                $related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3482
-            } elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3483
-                $related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3484
-            } else {
3485
-                //we don't want to add full or even minimum default where conditions from this model, so just continue
3486
-                continue;
3487
-            }
3488
-            $overrides = $this->_override_defaults_or_make_null_friendly(
3489
-                $related_model_universal_where_params,
3490
-                $where_query_params,
3491
-                $related_model,
3492
-                $model_relation_path
3493
-            );
3494
-            $universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3495
-                $universal_query_params,
3496
-                $overrides
3497
-            );
3498
-        }
3499
-        return $universal_query_params;
3500
-    }
3501
-
3502
-
3503
-
3504
-    /**
3505
-     * Determines whether or not we should use default where conditions for the model in question
3506
-     * (this model, or other related models).
3507
-     * Basically, we should use default where conditions on this model if they have requested to use them on all models,
3508
-     * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3509
-     * We should use default where conditions on related models when they requested to use default where conditions
3510
-     * on all models, or specifically just on other related models
3511
-     * @param      $default_where_conditions_value
3512
-     * @param bool $for_this_model false means this is for OTHER related models
3513
-     * @return bool
3514
-     */
3515
-    private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3516
-    {
3517
-        return (
3518
-                   $for_this_model
3519
-                   && in_array(
3520
-                       $default_where_conditions_value,
3521
-                       array(
3522
-                           EEM_Base::default_where_conditions_all,
3523
-                           EEM_Base::default_where_conditions_this_only,
3524
-                           EEM_Base::default_where_conditions_minimum_others,
3525
-                       ),
3526
-                       true
3527
-                   )
3528
-               )
3529
-               || (
3530
-                   ! $for_this_model
3531
-                   && in_array(
3532
-                       $default_where_conditions_value,
3533
-                       array(
3534
-                           EEM_Base::default_where_conditions_all,
3535
-                           EEM_Base::default_where_conditions_others_only,
3536
-                       ),
3537
-                       true
3538
-                   )
3539
-               );
3540
-    }
3541
-
3542
-    /**
3543
-     * Determines whether or not we should use default minimum conditions for the model in question
3544
-     * (this model, or other related models).
3545
-     * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
3546
-     * where conditions.
3547
-     * We should use minimum where conditions on related models if they requested to use minimum where conditions
3548
-     * on this model or others
3549
-     * @param      $default_where_conditions_value
3550
-     * @param bool $for_this_model false means this is for OTHER related models
3551
-     * @return bool
3552
-     */
3553
-    private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
3554
-    {
3555
-        return (
3556
-                   $for_this_model
3557
-                   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
3558
-               )
3559
-               || (
3560
-                   ! $for_this_model
3561
-                   && in_array(
3562
-                       $default_where_conditions_value,
3563
-                       array(
3564
-                           EEM_Base::default_where_conditions_minimum_others,
3565
-                           EEM_Base::default_where_conditions_minimum_all,
3566
-                       ),
3567
-                       true
3568
-                   )
3569
-               );
3570
-    }
3571
-
3572
-
3573
-    /**
3574
-     * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3575
-     * then we also add a special where condition which allows for that model's primary key
3576
-     * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3577
-     * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3578
-     *
3579
-     * @param array    $default_where_conditions
3580
-     * @param array    $provided_where_conditions
3581
-     * @param EEM_Base $model
3582
-     * @param string   $model_relation_path like 'Transaction.Payment.'
3583
-     * @return array like EEM_Base::get_all's $query_params[0]
3584
-     * @throws \EE_Error
3585
-     */
3586
-    private function _override_defaults_or_make_null_friendly(
3587
-        $default_where_conditions,
3588
-        $provided_where_conditions,
3589
-        $model,
3590
-        $model_relation_path
3591
-    ) {
3592
-        $null_friendly_where_conditions = array();
3593
-        $none_overridden = true;
3594
-        $or_condition_key_for_defaults = 'OR*' . get_class($model);
3595
-        foreach ($default_where_conditions as $key => $val) {
3596
-            if (isset($provided_where_conditions[$key])) {
3597
-                $none_overridden = false;
3598
-            } else {
3599
-                $null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3600
-            }
3601
-        }
3602
-        if ($none_overridden && $default_where_conditions) {
3603
-            if ($model->has_primary_key_field()) {
3604
-                $null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3605
-                                                                                . "."
3606
-                                                                                . $model->primary_key_name()] = array('IS NULL');
3607
-            }/*else{
32
+	//admin posty
33
+	//basic -> grants access to mine -> if they don't have it, select none
34
+	//*_others -> grants access to others that arent private, and all mine -> if they don't have it, select mine
35
+	//*_private -> grants full access -> if dont have it, select all mine and others' non-private
36
+	//*_published -> grants access to published -> if they dont have it, select non-published
37
+	//*_global/default/system -> grants access to global items -> if they don't have it, select non-global
38
+	//publish_{thing} -> can change status TO publish; SPECIAL CASE
39
+	//frontend posty
40
+	//by default has access to published
41
+	//basic -> grants access to mine that arent published, and all published
42
+	//*_others ->grants access to others that arent private, all mine
43
+	//*_private -> grants full access
44
+	//frontend non-posty
45
+	//like admin posty
46
+	//category-y
47
+	//assign -> grants access to join-table
48
+	//(delete, edit)
49
+	//payment-method-y
50
+	//for each registered payment method,
51
+	//ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
52
+	/**
53
+	 * Flag to indicate whether the values provided to EEM_Base have already been prepared
54
+	 * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
55
+	 * They almost always WILL NOT, but it's not necessarily a requirement.
56
+	 * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
57
+	 *
58
+	 * @var boolean
59
+	 */
60
+	private $_values_already_prepared_by_model_object = 0;
61
+
62
+	/**
63
+	 * when $_values_already_prepared_by_model_object equals this, we assume
64
+	 * the data is just like form input that needs to have the model fields'
65
+	 * prepare_for_set and prepare_for_use_in_db called on it
66
+	 */
67
+	const not_prepared_by_model_object = 0;
68
+
69
+	/**
70
+	 * when $_values_already_prepared_by_model_object equals this, we
71
+	 * assume this value is coming from a model object and doesn't need to have
72
+	 * prepare_for_set called on it, just prepare_for_use_in_db is used
73
+	 */
74
+	const prepared_by_model_object = 1;
75
+
76
+	/**
77
+	 * when $_values_already_prepared_by_model_object equals this, we assume
78
+	 * the values are already to be used in the database (ie no processing is done
79
+	 * on them by the model's fields)
80
+	 */
81
+	const prepared_for_use_in_db = 2;
82
+
83
+
84
+	protected $singular_item = 'Item';
85
+
86
+	protected $plural_item   = 'Items';
87
+
88
+	/**
89
+	 * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
90
+	 */
91
+	protected $_tables;
92
+
93
+	/**
94
+	 * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
95
+	 * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
96
+	 * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
97
+	 *
98
+	 * @var \EE_Model_Field_Base[] $_fields
99
+	 */
100
+	protected $_fields;
101
+
102
+	/**
103
+	 * array of different kinds of relations
104
+	 *
105
+	 * @var \EE_Model_Relation_Base[] $_model_relations
106
+	 */
107
+	protected $_model_relations;
108
+
109
+	/**
110
+	 * @var \EE_Index[] $_indexes
111
+	 */
112
+	protected $_indexes = array();
113
+
114
+	/**
115
+	 * Default strategy for getting where conditions on this model. This strategy is used to get default
116
+	 * where conditions which are added to get_all, update, and delete queries. They can be overridden
117
+	 * by setting the same columns as used in these queries in the query yourself.
118
+	 *
119
+	 * @var EE_Default_Where_Conditions
120
+	 */
121
+	protected $_default_where_conditions_strategy;
122
+
123
+	/**
124
+	 * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
125
+	 * This is particularly useful when you want something between 'none' and 'default'
126
+	 *
127
+	 * @var EE_Default_Where_Conditions
128
+	 */
129
+	protected $_minimum_where_conditions_strategy;
130
+
131
+	/**
132
+	 * String describing how to find the "owner" of this model's objects.
133
+	 * When there is a foreign key on this model to the wp_users table, this isn't needed.
134
+	 * But when there isn't, this indicates which related model, or transiently-related model,
135
+	 * has the foreign key to the wp_users table.
136
+	 * Eg, for EEM_Registration this would be 'Event' because registrations are directly
137
+	 * related to events, and events have a foreign key to wp_users.
138
+	 * On EEM_Transaction, this would be 'Transaction.Event'
139
+	 *
140
+	 * @var string
141
+	 */
142
+	protected $_model_chain_to_wp_user = '';
143
+
144
+	/**
145
+	 * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
146
+	 * don't need it (particularly CPT models)
147
+	 *
148
+	 * @var bool
149
+	 */
150
+	protected $_ignore_where_strategy = false;
151
+
152
+	/**
153
+	 * String used in caps relating to this model. Eg, if the caps relating to this
154
+	 * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
155
+	 *
156
+	 * @var string. If null it hasn't been initialized yet. If false then we
157
+	 * have indicated capabilities don't apply to this
158
+	 */
159
+	protected $_caps_slug = null;
160
+
161
+	/**
162
+	 * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
163
+	 * and next-level keys are capability names, and each's value is a
164
+	 * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
165
+	 * they specify which context to use (ie, frontend, backend, edit or delete)
166
+	 * and then each capability in the corresponding sub-array that they're missing
167
+	 * adds the where conditions onto the query.
168
+	 *
169
+	 * @var array
170
+	 */
171
+	protected $_cap_restrictions = array(
172
+		self::caps_read       => array(),
173
+		self::caps_read_admin => array(),
174
+		self::caps_edit       => array(),
175
+		self::caps_delete     => array(),
176
+	);
177
+
178
+	/**
179
+	 * Array defining which cap restriction generators to use to create default
180
+	 * cap restrictions to put in EEM_Base::_cap_restrictions.
181
+	 * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
182
+	 * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
183
+	 * automatically set this to false (not just null).
184
+	 *
185
+	 * @var EE_Restriction_Generator_Base[]
186
+	 */
187
+	protected $_cap_restriction_generators = array();
188
+
189
+	/**
190
+	 * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
191
+	 */
192
+	const caps_read       = 'read';
193
+
194
+	const caps_read_admin = 'read_admin';
195
+
196
+	const caps_edit       = 'edit';
197
+
198
+	const caps_delete     = 'delete';
199
+
200
+	/**
201
+	 * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
202
+	 * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
203
+	 * maps to 'read' because when looking for relevant permissions we're going to use
204
+	 * 'read' in teh capabilities names like 'ee_read_events' etc.
205
+	 *
206
+	 * @var array
207
+	 */
208
+	protected $_cap_contexts_to_cap_action_map = array(
209
+		self::caps_read       => 'read',
210
+		self::caps_read_admin => 'read',
211
+		self::caps_edit       => 'edit',
212
+		self::caps_delete     => 'delete',
213
+	);
214
+
215
+	/**
216
+	 * Timezone
217
+	 * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
218
+	 * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
219
+	 * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
220
+	 * EE_Datetime_Field data type will have access to it.
221
+	 *
222
+	 * @var string
223
+	 */
224
+	protected $_timezone;
225
+
226
+
227
+	/**
228
+	 * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
229
+	 * multisite.
230
+	 *
231
+	 * @var int
232
+	 */
233
+	protected static $_model_query_blog_id;
234
+
235
+	/**
236
+	 * A copy of _fields, except the array keys are the model names pointed to by
237
+	 * the field
238
+	 *
239
+	 * @var EE_Model_Field_Base[]
240
+	 */
241
+	private $_cache_foreign_key_to_fields = array();
242
+
243
+	/**
244
+	 * Cached list of all the fields on the model, indexed by their name
245
+	 *
246
+	 * @var EE_Model_Field_Base[]
247
+	 */
248
+	private $_cached_fields = null;
249
+
250
+	/**
251
+	 * Cached list of all the fields on the model, except those that are
252
+	 * marked as only pertinent to the database
253
+	 *
254
+	 * @var EE_Model_Field_Base[]
255
+	 */
256
+	private $_cached_fields_non_db_only = null;
257
+
258
+	/**
259
+	 * A cached reference to the primary key for quick lookup
260
+	 *
261
+	 * @var EE_Model_Field_Base
262
+	 */
263
+	private $_primary_key_field = null;
264
+
265
+	/**
266
+	 * Flag indicating whether this model has a primary key or not
267
+	 *
268
+	 * @var boolean
269
+	 */
270
+	protected $_has_primary_key_field = null;
271
+
272
+	/**
273
+	 * Whether or not this model is based off a table in WP core only (CPTs should set
274
+	 * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
275
+	 *
276
+	 * @var boolean
277
+	 */
278
+	protected $_wp_core_model = false;
279
+
280
+	/**
281
+	 *    List of valid operators that can be used for querying.
282
+	 * The keys are all operators we'll accept, the values are the real SQL
283
+	 * operators used
284
+	 *
285
+	 * @var array
286
+	 */
287
+	protected $_valid_operators = array(
288
+		'='           => '=',
289
+		'<='          => '<=',
290
+		'<'           => '<',
291
+		'>='          => '>=',
292
+		'>'           => '>',
293
+		'!='          => '!=',
294
+		'LIKE'        => 'LIKE',
295
+		'like'        => 'LIKE',
296
+		'NOT_LIKE'    => 'NOT LIKE',
297
+		'not_like'    => 'NOT LIKE',
298
+		'NOT LIKE'    => 'NOT LIKE',
299
+		'not like'    => 'NOT LIKE',
300
+		'IN'          => 'IN',
301
+		'in'          => 'IN',
302
+		'NOT_IN'      => 'NOT IN',
303
+		'not_in'      => 'NOT IN',
304
+		'NOT IN'      => 'NOT IN',
305
+		'not in'      => 'NOT IN',
306
+		'between'     => 'BETWEEN',
307
+		'BETWEEN'     => 'BETWEEN',
308
+		'IS_NOT_NULL' => 'IS NOT NULL',
309
+		'is_not_null' => 'IS NOT NULL',
310
+		'IS NOT NULL' => 'IS NOT NULL',
311
+		'is not null' => 'IS NOT NULL',
312
+		'IS_NULL'     => 'IS NULL',
313
+		'is_null'     => 'IS NULL',
314
+		'IS NULL'     => 'IS NULL',
315
+		'is null'     => 'IS NULL',
316
+		'REGEXP'      => 'REGEXP',
317
+		'regexp'      => 'REGEXP',
318
+		'NOT_REGEXP'  => 'NOT REGEXP',
319
+		'not_regexp'  => 'NOT REGEXP',
320
+		'NOT REGEXP'  => 'NOT REGEXP',
321
+		'not regexp'  => 'NOT REGEXP',
322
+	);
323
+
324
+	/**
325
+	 * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
326
+	 *
327
+	 * @var array
328
+	 */
329
+	protected $_in_style_operators = array('IN', 'NOT IN');
330
+
331
+	/**
332
+	 * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
333
+	 * '12-31-2012'"
334
+	 *
335
+	 * @var array
336
+	 */
337
+	protected $_between_style_operators = array('BETWEEN');
338
+
339
+	/**
340
+	 * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
341
+	 * on a join table.
342
+	 *
343
+	 * @var array
344
+	 */
345
+	protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
346
+
347
+	/**
348
+	 * Allowed values for $query_params['order'] for ordering in queries
349
+	 *
350
+	 * @var array
351
+	 */
352
+	protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
353
+
354
+	/**
355
+	 * When these are keys in a WHERE or HAVING clause, they are handled much differently
356
+	 * than regular field names. It is assumed that their values are an array of WHERE conditions
357
+	 *
358
+	 * @var array
359
+	 */
360
+	private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
361
+
362
+	/**
363
+	 * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
364
+	 * 'where', but 'where' clauses are so common that we thought we'd omit it
365
+	 *
366
+	 * @var array
367
+	 */
368
+	private $_allowed_query_params = array(
369
+		0,
370
+		'limit',
371
+		'order_by',
372
+		'group_by',
373
+		'having',
374
+		'force_join',
375
+		'order',
376
+		'on_join_limit',
377
+		'default_where_conditions',
378
+		'caps',
379
+	);
380
+
381
+	/**
382
+	 * All the data types that can be used in $wpdb->prepare statements.
383
+	 *
384
+	 * @var array
385
+	 */
386
+	private $_valid_wpdb_data_types = array('%d', '%s', '%f');
387
+
388
+	/**
389
+	 *    EE_Registry Object
390
+	 *
391
+	 * @var    object
392
+	 * @access    protected
393
+	 */
394
+	protected $EE = null;
395
+
396
+
397
+	/**
398
+	 * Property which, when set, will have this model echo out the next X queries to the page for debugging.
399
+	 *
400
+	 * @var int
401
+	 */
402
+	protected $_show_next_x_db_queries = 0;
403
+
404
+	/**
405
+	 * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
406
+	 * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
407
+	 *
408
+	 * @var array
409
+	 */
410
+	protected $_custom_selections = array();
411
+
412
+	/**
413
+	 * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
414
+	 * caches every model object we've fetched from the DB on this request
415
+	 *
416
+	 * @var array
417
+	 */
418
+	protected $_entity_map;
419
+
420
+	/**
421
+	 * constant used to show EEM_Base has not yet verified the db on this http request
422
+	 */
423
+	const db_verified_none = 0;
424
+
425
+	/**
426
+	 * constant used to show EEM_Base has verified the EE core db on this http request,
427
+	 * but not the addons' dbs
428
+	 */
429
+	const db_verified_core = 1;
430
+
431
+	/**
432
+	 * constant used to show EEM_Base has verified the addons' dbs (and implicitly
433
+	 * the EE core db too)
434
+	 */
435
+	const db_verified_addons = 2;
436
+
437
+	/**
438
+	 * indicates whether an EEM_Base child has already re-verified the DB
439
+	 * is ok (we don't want to do it repetitively). Should be set to one the constants
440
+	 * looking like EEM_Base::db_verified_*
441
+	 *
442
+	 * @var int - 0 = none, 1 = core, 2 = addons
443
+	 */
444
+	protected static $_db_verification_level = EEM_Base::db_verified_none;
445
+
446
+	/**
447
+	 * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
448
+	 *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
449
+	 *        registrations for non-trashed tickets for non-trashed datetimes)
450
+	 */
451
+	const default_where_conditions_all = 'all';
452
+
453
+	/**
454
+	 * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
455
+	 *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
456
+	 *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
457
+	 *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
458
+	 *        models which share tables with other models, this can return data for the wrong model.
459
+	 */
460
+	const default_where_conditions_this_only = 'this_model_only';
461
+
462
+	/**
463
+	 * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
464
+	 *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
465
+	 *        return all registrations related to non-trashed tickets and non-trashed datetimes)
466
+	 */
467
+	const default_where_conditions_others_only = 'other_models_only';
468
+
469
+	/**
470
+	 * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
471
+	 *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
472
+	 *        their table with other models, like the Event and Venue models. For example, when querying for events
473
+	 *        ordered by their venues' name, this will be sure to only return real events with associated real venues
474
+	 *        (regardless of whether those events and venues are trashed)
475
+	 *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
476
+	 *        events.
477
+	 */
478
+	const default_where_conditions_minimum_all = 'minimum';
479
+
480
+	/**
481
+	 * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
482
+	 *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
483
+	 *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
484
+	 *        not)
485
+	 */
486
+	const default_where_conditions_minimum_others = 'full_this_minimum_others';
487
+
488
+	/**
489
+	 * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
490
+	 *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
491
+	 *        it's possible it will return table entries for other models. You should use
492
+	 *        EEM_Base::default_where_conditions_minimum_all instead.
493
+	 */
494
+	const default_where_conditions_none = 'none';
495
+
496
+
497
+
498
+	/**
499
+	 * About all child constructors:
500
+	 * they should define the _tables, _fields and _model_relations arrays.
501
+	 * Should ALWAYS be called after child constructor.
502
+	 * In order to make the child constructors to be as simple as possible, this parent constructor
503
+	 * finalizes constructing all the object's attributes.
504
+	 * Generally, rather than requiring a child to code
505
+	 * $this->_tables = array(
506
+	 *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
507
+	 *        ...);
508
+	 *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
509
+	 * each EE_Table has a function to set the table's alias after the constructor, using
510
+	 * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
511
+	 * do something similar.
512
+	 *
513
+	 * @param null $timezone
514
+	 * @throws \EE_Error
515
+	 */
516
+	protected function __construct($timezone = null)
517
+	{
518
+		// check that the model has not been loaded too soon
519
+		if (! did_action('AHEE__EE_System__load_espresso_addons')) {
520
+			throw new EE_Error (
521
+				sprintf(
522
+					__('The %1$s model can not be loaded before the "AHEE__EE_System__load_espresso_addons" hook has been called. This gives other addons a chance to extend this model.',
523
+						'event_espresso'),
524
+					get_class($this)
525
+				)
526
+			);
527
+		}
528
+		/**
529
+		 * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
530
+		 */
531
+		if (empty(EEM_Base::$_model_query_blog_id)) {
532
+			EEM_Base::set_model_query_blog_id();
533
+		}
534
+		/**
535
+		 * Filters the list of tables on a model. It is best to NOT use this directly and instead
536
+		 * just use EE_Register_Model_Extension
537
+		 *
538
+		 * @var EE_Table_Base[] $_tables
539
+		 */
540
+		$this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
541
+		foreach ($this->_tables as $table_alias => $table_obj) {
542
+			/** @var $table_obj EE_Table_Base */
543
+			$table_obj->_construct_finalize_with_alias($table_alias);
544
+			if ($table_obj instanceof EE_Secondary_Table) {
545
+				/** @var $table_obj EE_Secondary_Table */
546
+				$table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
547
+			}
548
+		}
549
+		/**
550
+		 * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
551
+		 * EE_Register_Model_Extension
552
+		 *
553
+		 * @param EE_Model_Field_Base[] $_fields
554
+		 */
555
+		$this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
556
+		$this->_invalidate_field_caches();
557
+		foreach ($this->_fields as $table_alias => $fields_for_table) {
558
+			if (! array_key_exists($table_alias, $this->_tables)) {
559
+				throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
560
+					'event_espresso'), $table_alias, implode(",", $this->_fields)));
561
+			}
562
+			foreach ($fields_for_table as $field_name => $field_obj) {
563
+				/** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
564
+				//primary key field base has a slightly different _construct_finalize
565
+				/** @var $field_obj EE_Model_Field_Base */
566
+				$field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
567
+			}
568
+		}
569
+		// everything is related to Extra_Meta
570
+		if (get_class($this) !== 'EEM_Extra_Meta') {
571
+			//make extra meta related to everything, but don't block deleting things just
572
+			//because they have related extra meta info. For now just orphan those extra meta
573
+			//in the future we should automatically delete them
574
+			$this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
575
+		}
576
+		//and change logs
577
+		if (get_class($this) !== 'EEM_Change_Log') {
578
+			$this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
579
+		}
580
+		/**
581
+		 * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
582
+		 * EE_Register_Model_Extension
583
+		 *
584
+		 * @param EE_Model_Relation_Base[] $_model_relations
585
+		 */
586
+		$this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
587
+			$this->_model_relations);
588
+		foreach ($this->_model_relations as $model_name => $relation_obj) {
589
+			/** @var $relation_obj EE_Model_Relation_Base */
590
+			$relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
591
+		}
592
+		foreach ($this->_indexes as $index_name => $index_obj) {
593
+			/** @var $index_obj EE_Index */
594
+			$index_obj->_construct_finalize($index_name, $this->get_this_model_name());
595
+		}
596
+		$this->set_timezone($timezone);
597
+		//finalize default where condition strategy, or set default
598
+		if (! $this->_default_where_conditions_strategy) {
599
+			//nothing was set during child constructor, so set default
600
+			$this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
601
+		}
602
+		$this->_default_where_conditions_strategy->_finalize_construct($this);
603
+		if (! $this->_minimum_where_conditions_strategy) {
604
+			//nothing was set during child constructor, so set default
605
+			$this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
606
+		}
607
+		$this->_minimum_where_conditions_strategy->_finalize_construct($this);
608
+		//if the cap slug hasn't been set, and we haven't set it to false on purpose
609
+		//to indicate to NOT set it, set it to the logical default
610
+		if ($this->_caps_slug === null) {
611
+			$this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
612
+		}
613
+		//initialize the standard cap restriction generators if none were specified by the child constructor
614
+		if ($this->_cap_restriction_generators !== false) {
615
+			foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
616
+				if (! isset($this->_cap_restriction_generators[$cap_context])) {
617
+					$this->_cap_restriction_generators[$cap_context] = apply_filters(
618
+						'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
619
+						new EE_Restriction_Generator_Protected(),
620
+						$cap_context,
621
+						$this
622
+					);
623
+				}
624
+			}
625
+		}
626
+		//if there are cap restriction generators, use them to make the default cap restrictions
627
+		if ($this->_cap_restriction_generators !== false) {
628
+			foreach ($this->_cap_restriction_generators as $context => $generator_object) {
629
+				if (! $generator_object) {
630
+					continue;
631
+				}
632
+				if (! $generator_object instanceof EE_Restriction_Generator_Base) {
633
+					throw new EE_Error(
634
+						sprintf(
635
+							__('Index "%1$s" in the model %2$s\'s _cap_restriction_generators is not a child of EE_Restriction_Generator_Base. It should be that or NULL.',
636
+								'event_espresso'),
637
+							$context,
638
+							$this->get_this_model_name()
639
+						)
640
+					);
641
+				}
642
+				$action = $this->cap_action_for_context($context);
643
+				if (! $generator_object->construction_finalized()) {
644
+					$generator_object->_construct_finalize($this, $action);
645
+				}
646
+			}
647
+		}
648
+		do_action('AHEE__' . get_class($this) . '__construct__end');
649
+	}
650
+
651
+
652
+
653
+	/**
654
+	 * Generates the cap restrictions for the given context, or if they were
655
+	 * already generated just gets what's cached
656
+	 *
657
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
658
+	 * @return EE_Default_Where_Conditions[]
659
+	 */
660
+	protected function _generate_cap_restrictions($context)
661
+	{
662
+		if (isset($this->_cap_restriction_generators[$context])
663
+			&& $this->_cap_restriction_generators[$context]
664
+			   instanceof
665
+			   EE_Restriction_Generator_Base
666
+		) {
667
+			return $this->_cap_restriction_generators[$context]->generate_restrictions();
668
+		} else {
669
+			return array();
670
+		}
671
+	}
672
+
673
+
674
+
675
+	/**
676
+	 * Used to set the $_model_query_blog_id static property.
677
+	 *
678
+	 * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
679
+	 *                      value for get_current_blog_id() will be used.
680
+	 */
681
+	public static function set_model_query_blog_id($blog_id = 0)
682
+	{
683
+		EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
684
+	}
685
+
686
+
687
+
688
+	/**
689
+	 * Returns whatever is set as the internal $model_query_blog_id.
690
+	 *
691
+	 * @return int
692
+	 */
693
+	public static function get_model_query_blog_id()
694
+	{
695
+		return EEM_Base::$_model_query_blog_id;
696
+	}
697
+
698
+
699
+
700
+	/**
701
+	 *        This function is a singleton method used to instantiate the Espresso_model object
702
+	 *
703
+	 * @access public
704
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
705
+	 *                         incoming timezone data that gets saved).  Note this just sends the timezone info to the
706
+	 *                         date time model field objects.  Default is NULL (and will be assumed using the set
707
+	 *                         timezone in the 'timezone_string' wp option)
708
+	 * @return static (as in the concrete child class)
709
+	 */
710
+	public static function instance($timezone = null)
711
+	{
712
+		// check if instance of Espresso_model already exists
713
+		if (! static::$_instance instanceof static) {
714
+			// instantiate Espresso_model
715
+			static::$_instance = new static($timezone);
716
+		}
717
+		//we might have a timezone set, let set_timezone decide what to do with it
718
+		static::$_instance->set_timezone($timezone);
719
+		// Espresso_model object
720
+		return static::$_instance;
721
+	}
722
+
723
+
724
+
725
+	/**
726
+	 * resets the model and returns it
727
+	 *
728
+	 * @param null | string $timezone
729
+	 * @return EEM_Base|null (if the model was already instantiated, returns it, with
730
+	 * all its properties reset; if it wasn't instantiated, returns null)
731
+	 */
732
+	public static function reset($timezone = null)
733
+	{
734
+		if (static::$_instance instanceof EEM_Base) {
735
+			//let's try to NOT swap out the current instance for a new one
736
+			//because if someone has a reference to it, we can't remove their reference
737
+			//so it's best to keep using the same reference, but change the original object
738
+			//reset all its properties to their original values as defined in the class
739
+			$r = new ReflectionClass(get_class(static::$_instance));
740
+			$static_properties = $r->getStaticProperties();
741
+			foreach ($r->getDefaultProperties() as $property => $value) {
742
+				//don't set instance to null like it was originally,
743
+				//but it's static anyways, and we're ignoring static properties (for now at least)
744
+				if (! isset($static_properties[$property])) {
745
+					static::$_instance->{$property} = $value;
746
+				}
747
+			}
748
+			//and then directly call its constructor again, like we would if we
749
+			//were creating a new one
750
+			static::$_instance->__construct($timezone);
751
+			return self::instance();
752
+		}
753
+		return null;
754
+	}
755
+
756
+
757
+
758
+	/**
759
+	 * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
760
+	 *
761
+	 * @param  boolean $translated return localized strings or JUST the array.
762
+	 * @return array
763
+	 * @throws \EE_Error
764
+	 */
765
+	public function status_array($translated = false)
766
+	{
767
+		if (! array_key_exists('Status', $this->_model_relations)) {
768
+			return array();
769
+		}
770
+		$model_name = $this->get_this_model_name();
771
+		$status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
772
+		$stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
773
+		$status_array = array();
774
+		foreach ($stati as $status) {
775
+			$status_array[$status->ID()] = $status->get('STS_code');
776
+		}
777
+		return $translated
778
+			? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
779
+			: $status_array;
780
+	}
781
+
782
+
783
+
784
+	/**
785
+	 * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
786
+	 *
787
+	 * @param array $query_params             {
788
+	 * @var array $0 (where) array {
789
+	 *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
790
+	 *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
791
+	 *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
792
+	 *                                        conditions based on related models (and even
793
+	 *                                        models-related-to-related-models) prepend the model's name onto the field
794
+	 *                                        name. Eg,
795
+	 *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
796
+	 *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
797
+	 *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
798
+	 *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
799
+	 *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
800
+	 *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
801
+	 *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
802
+	 *                                        to Venues (even when each of those models actually consisted of two
803
+	 *                                        tables). Also, you may chain the model relations together. Eg instead of
804
+	 *                                        just having
805
+	 *                                        "Venue.VNU_ID", you could have
806
+	 *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
807
+	 *                                        events are related to Registrations, which are related to Attendees). You
808
+	 *                                        can take it even further with
809
+	 *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
810
+	 *                                        (from the default of '='), change the value to an numerically-indexed
811
+	 *                                        array, where the first item in the list is the operator. eg: array(
812
+	 *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
813
+	 *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
814
+	 *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
815
+	 *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
816
+	 *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
817
+	 *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
818
+	 *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
819
+	 *                                        the operator is IN. Also, values can actually be field names. To indicate
820
+	 *                                        the value is a field, simply provide a third array item (true) to the
821
+	 *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
822
+	 *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
823
+	 *                                        Note: you can also use related model field names like you would any other
824
+	 *                                        field name. eg:
825
+	 *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
826
+	 *                                        be used if you were querying EEM_Tickets (because Datetime is directly related to tickets) Also, by default all the where conditions are AND'd together. To override this, add an array key 'OR' (or 'AND') and the array to be OR'd together eg: array('OR'=>array('TXN_ID' => 23 , 'TXN_timestamp__>' =>
827
+	 *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
828
+	 *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
829
+	 *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
830
+	 *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
831
+	 *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
832
+	 *                                        to be what you last specified. IE, "AND"s by default, but if you had
833
+	 *                                        previously specified to use ORs to join, ORs will continue to be used.
834
+	 *                                        So, if you specify to use an "OR" to join conditions, it will continue to
835
+	 *                                        "stick" until you specify an AND. eg
836
+	 *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
837
+	 *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
838
+	 *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
839
+	 *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
840
+	 *                                        array('OR'=>array('TXN_total' => 23, 'NOT'=> array( 'TXN_timestamp'=> 345678912, 'AND'=>array('TXN_paid' => 53, 'STS_ID' => 'TIN')))) becomes SQL >> "...WHERE TXN_total = 23 OR ! (TXN_timestamp = 345678912 OR (TXN_paid = 53 AND STS_ID = 'TIN'))..." GOTCHA: because this is an array, array keys must be unique, making it impossible to place two or more where conditions applying to the same field. eg: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp'=>array('<',$end_date),'PAY_timestamp'=>array('!=',$special_date)), as PHP enforces that the array keys must be unique, thus removing the first two array entries with key 'PAY_timestamp'. becomes SQL >> "PAY_timestamp !=  4234232", ignoring the first two PAY_timestamp conditions). To overcome this, you can add a '*' character to the end of the field's name, followed by anything. These will be removed when generating the SQL string, but allow for the array keys to be unique. eg: you could rewrite the previous query as: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp*1st'=>array('<',$end_date),'PAY_timestamp*2nd'=>array('!=',$special_date)) which correctly becomes SQL >>
841
+	 *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
842
+	 *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
843
+	 *                                        too, eg:
844
+	 *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
845
+	 * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
846
+	 *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
847
+	 *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
848
+	 *                                        Remember when you provide two numbers for the limit, the 1st number is
849
+	 *                                        the OFFSET, the 2nd is the LIMIT
850
+	 * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
851
+	 *                                        can do paging on one-to-many multi-table-joins. Send an array in the
852
+	 *                                        following format array('on_join_limit'
853
+	 *                                        => array( 'table_alias', array(1,2) ) ).
854
+	 * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
855
+	 *                                        values are either 'ASC' or 'DESC'.
856
+	 *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
857
+	 *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
858
+	 *                                        DESC..." respectively. Like the
859
+	 *                                        'where' conditions, these fields can be on related models. Eg
860
+	 *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
861
+	 *                                        perfectly valid from any model related to 'Registration' (like Event,
862
+	 *                                        Attendee, Price, Datetime, etc.)
863
+	 * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
864
+	 *                                        'order' specifies whether to order the field specified in 'order_by' in
865
+	 *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
866
+	 *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
867
+	 *                                        order by the primary key. Eg,
868
+	 *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
869
+	 *                                        //(will join with the Datetime model's table(s) and order by its field
870
+	 *                                        DTT_EVT_start) or
871
+	 *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
872
+	 *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
873
+	 * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
874
+	 *                                        'group_by'=>'VNU_ID', or
875
+	 *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
876
+	 *                                        if no
877
+	 *                                        $group_by is specified, and a limit is set, automatically groups by the
878
+	 *                                        model's primary key (or combined primary keys). This avoids some
879
+	 *                                        weirdness that results when using limits, tons of joins, and no group by,
880
+	 *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
881
+	 * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
882
+	 *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
883
+	 *                                        results)
884
+	 * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
885
+	 *                                        array where values are models to be joined in the query.Eg
886
+	 *                                        array('Attendee','Payment','Datetime'). You may join with transient
887
+	 *                                        models using period, eg "Registration.Transaction.Payment". You will
888
+	 *                                        probably only want to do this in hopes of increasing efficiency, as
889
+	 *                                        related models which belongs to the current model
890
+	 *                                        (ie, the current model has a foreign key to them, like how Registration
891
+	 *                                        belongs to Attendee) can be cached in order to avoid future queries
892
+	 * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
893
+	 *                                        set this to 'none' to disable all default where conditions. Eg, usually
894
+	 *                                        soft-deleted objects are filtered-out if you want to include them, set
895
+	 *                                        this query param to 'none'. If you want to ONLY disable THIS model's
896
+	 *                                        default where conditions set it to 'other_models_only'. If you only want
897
+	 *                                        this model's default where conditions added to the query, use
898
+	 *                                        'this_model_only'. If you want to use all default where conditions
899
+	 *                                        (default), set to 'all'.
900
+	 * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
901
+	 *                                        we just NOT apply any capabilities/permissions/restrictions and return
902
+	 *                                        everything? Or should we only show the current user items they should be
903
+	 *                                        able to view on the frontend, backend, edit, or delete? can be set to
904
+	 *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
905
+	 *                                        }
906
+	 * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
907
+	 *                                        from EE_Base_Class[], use _get_all_wpdb_results()and make it public
908
+	 *                                        again. Array keys are object IDs (if there is a primary key on the model.
909
+	 *                                        if not, numerically indexed) Some full examples: get 10 transactions
910
+	 *                                        which have Scottish attendees: EEM_Transaction::instance()->get_all(
911
+	 *                                        array( array(
912
+	 *                                        'OR'=>array(
913
+	 *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
914
+	 *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
915
+	 *                                        )
916
+	 *                                        ),
917
+	 *                                        'limit'=>10,
918
+	 *                                        'group_by'=>'TXN_ID'
919
+	 *                                        ));
920
+	 *                                        get all the answers to the question titled "shirt size" for event with id
921
+	 *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
922
+	 *                                        'Question.QST_display_text'=>'shirt size',
923
+	 *                                        'Registration.Event.EVT_ID'=>12
924
+	 *                                        ),
925
+	 *                                        'order_by'=>array('ANS_value'=>'ASC')
926
+	 *                                        ));
927
+	 * @throws \EE_Error
928
+	 */
929
+	public function get_all($query_params = array())
930
+	{
931
+		if (isset($query_params['limit'])
932
+			&& ! isset($query_params['group_by'])
933
+		) {
934
+			$query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
935
+		}
936
+		return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
937
+	}
938
+
939
+
940
+
941
+	/**
942
+	 * Modifies the query parameters so we only get back model objects
943
+	 * that "belong" to the current user
944
+	 *
945
+	 * @param array $query_params @see EEM_Base::get_all()
946
+	 * @return array like EEM_Base::get_all
947
+	 */
948
+	public function alter_query_params_to_only_include_mine($query_params = array())
949
+	{
950
+		$wp_user_field_name = $this->wp_user_field_name();
951
+		if ($wp_user_field_name) {
952
+			$query_params[0][$wp_user_field_name] = get_current_user_id();
953
+		}
954
+		return $query_params;
955
+	}
956
+
957
+
958
+
959
+	/**
960
+	 * Returns the name of the field's name that points to the WP_User table
961
+	 *  on this model (or follows the _model_chain_to_wp_user and uses that model's
962
+	 * foreign key to the WP_User table)
963
+	 *
964
+	 * @return string|boolean string on success, boolean false when there is no
965
+	 * foreign key to the WP_User table
966
+	 */
967
+	public function wp_user_field_name()
968
+	{
969
+		try {
970
+			if (! empty($this->_model_chain_to_wp_user)) {
971
+				$models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
972
+				$last_model_name = end($models_to_follow_to_wp_users);
973
+				$model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
974
+				$model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
975
+			} else {
976
+				$model_with_fk_to_wp_users = $this;
977
+				$model_chain_to_wp_user = '';
978
+			}
979
+			$wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
980
+			return $model_chain_to_wp_user . $wp_user_field->get_name();
981
+		} catch (EE_Error $e) {
982
+			return false;
983
+		}
984
+	}
985
+
986
+
987
+
988
+	/**
989
+	 * Returns the _model_chain_to_wp_user string, which indicates which related model
990
+	 * (or transiently-related model) has a foreign key to the wp_users table;
991
+	 * useful for finding if model objects of this type are 'owned' by the current user.
992
+	 * This is an empty string when the foreign key is on this model and when it isn't,
993
+	 * but is only non-empty when this model's ownership is indicated by a RELATED model
994
+	 * (or transiently-related model)
995
+	 *
996
+	 * @return string
997
+	 */
998
+	public function model_chain_to_wp_user()
999
+	{
1000
+		return $this->_model_chain_to_wp_user;
1001
+	}
1002
+
1003
+
1004
+
1005
+	/**
1006
+	 * Whether this model is 'owned' by a specific wordpress user (even indirectly,
1007
+	 * like how registrations don't have a foreign key to wp_users, but the
1008
+	 * events they are for are), or is unrelated to wp users.
1009
+	 * generally available
1010
+	 *
1011
+	 * @return boolean
1012
+	 */
1013
+	public function is_owned()
1014
+	{
1015
+		if ($this->model_chain_to_wp_user()) {
1016
+			return true;
1017
+		} else {
1018
+			try {
1019
+				$this->get_foreign_key_to('WP_User');
1020
+				return true;
1021
+			} catch (EE_Error $e) {
1022
+				return false;
1023
+			}
1024
+		}
1025
+	}
1026
+
1027
+
1028
+
1029
+	/**
1030
+	 * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
1031
+	 * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
1032
+	 * the model)
1033
+	 *
1034
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
1035
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1036
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1037
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
1038
+	 *                                  override this and set the select to "*", or a specific column name, like
1039
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1040
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1041
+	 *                                  the aliases used to refer to this selection, and values are to be
1042
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1043
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1044
+	 * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1045
+	 * @throws \EE_Error
1046
+	 */
1047
+	protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1048
+	{
1049
+		// remember the custom selections, if any, and type cast as array
1050
+		// (unless $columns_to_select is an object, then just set as an empty array)
1051
+		// Note: (array) 'some string' === array( 'some string' )
1052
+		$this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1053
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1054
+		$select_expressions = $columns_to_select !== null
1055
+			? $this->_construct_select_from_input($columns_to_select)
1056
+			: $this->_construct_default_select_sql($model_query_info);
1057
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1058
+		return $this->_do_wpdb_query('get_results', array($SQL, $output));
1059
+	}
1060
+
1061
+
1062
+
1063
+	/**
1064
+	 * Gets an array of rows from the database just like $wpdb->get_results would,
1065
+	 * but you can use the $query_params like on EEM_Base::get_all() to more easily
1066
+	 * take care of joins, field preparation etc.
1067
+	 *
1068
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
1069
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1070
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1071
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
1072
+	 *                                  override this and set the select to "*", or a specific column name, like
1073
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1074
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1075
+	 *                                  the aliases used to refer to this selection, and values are to be
1076
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1077
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1078
+	 * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1079
+	 * @throws \EE_Error
1080
+	 */
1081
+	public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1082
+	{
1083
+		return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
1084
+	}
1085
+
1086
+
1087
+
1088
+	/**
1089
+	 * For creating a custom select statement
1090
+	 *
1091
+	 * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
1092
+	 *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
1093
+	 *                                 SQL, and 1=>is the datatype
1094
+	 * @throws EE_Error
1095
+	 * @return string
1096
+	 */
1097
+	private function _construct_select_from_input($columns_to_select)
1098
+	{
1099
+		if (is_array($columns_to_select)) {
1100
+			$select_sql_array = array();
1101
+			foreach ($columns_to_select as $alias => $selection_and_datatype) {
1102
+				if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1103
+					throw new EE_Error(
1104
+						sprintf(
1105
+							__(
1106
+								"Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1107
+								"event_espresso"
1108
+							),
1109
+							$selection_and_datatype,
1110
+							$alias
1111
+						)
1112
+					);
1113
+				}
1114
+				if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1115
+					throw new EE_Error(
1116
+						sprintf(
1117
+							__(
1118
+								"Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1119
+								"event_espresso"
1120
+							),
1121
+							$selection_and_datatype[1],
1122
+							$selection_and_datatype[0],
1123
+							$alias,
1124
+							implode(",", $this->_valid_wpdb_data_types)
1125
+						)
1126
+					);
1127
+				}
1128
+				$select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1129
+			}
1130
+			$columns_to_select_string = implode(", ", $select_sql_array);
1131
+		} else {
1132
+			$columns_to_select_string = $columns_to_select;
1133
+		}
1134
+		return $columns_to_select_string;
1135
+	}
1136
+
1137
+
1138
+
1139
+	/**
1140
+	 * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1141
+	 *
1142
+	 * @return string
1143
+	 * @throws \EE_Error
1144
+	 */
1145
+	public function primary_key_name()
1146
+	{
1147
+		return $this->get_primary_key_field()->get_name();
1148
+	}
1149
+
1150
+
1151
+
1152
+	/**
1153
+	 * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1154
+	 * If there is no primary key on this model, $id is treated as primary key string
1155
+	 *
1156
+	 * @param mixed $id int or string, depending on the type of the model's primary key
1157
+	 * @return EE_Base_Class
1158
+	 */
1159
+	public function get_one_by_ID($id)
1160
+	{
1161
+		if ($this->get_from_entity_map($id)) {
1162
+			return $this->get_from_entity_map($id);
1163
+		}
1164
+		return $this->get_one(
1165
+			$this->alter_query_params_to_restrict_by_ID(
1166
+				$id,
1167
+				array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
1168
+			)
1169
+		);
1170
+	}
1171
+
1172
+
1173
+
1174
+	/**
1175
+	 * Alters query parameters to only get items with this ID are returned.
1176
+	 * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1177
+	 * or could just be a simple primary key ID
1178
+	 *
1179
+	 * @param int   $id
1180
+	 * @param array $query_params
1181
+	 * @return array of normal query params, @see EEM_Base::get_all
1182
+	 * @throws \EE_Error
1183
+	 */
1184
+	public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1185
+	{
1186
+		if (! isset($query_params[0])) {
1187
+			$query_params[0] = array();
1188
+		}
1189
+		$conditions_from_id = $this->parse_index_primary_key_string($id);
1190
+		if ($conditions_from_id === null) {
1191
+			$query_params[0][$this->primary_key_name()] = $id;
1192
+		} else {
1193
+			//no primary key, so the $id must be from the get_index_primary_key_string()
1194
+			$query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1195
+		}
1196
+		return $query_params;
1197
+	}
1198
+
1199
+
1200
+
1201
+	/**
1202
+	 * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1203
+	 * array. If no item is found, null is returned.
1204
+	 *
1205
+	 * @param array $query_params like EEM_Base's $query_params variable.
1206
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1207
+	 * @throws \EE_Error
1208
+	 */
1209
+	public function get_one($query_params = array())
1210
+	{
1211
+		if (! is_array($query_params)) {
1212
+			EE_Error::doing_it_wrong('EEM_Base::get_one',
1213
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1214
+					gettype($query_params)), '4.6.0');
1215
+			$query_params = array();
1216
+		}
1217
+		$query_params['limit'] = 1;
1218
+		$items = $this->get_all($query_params);
1219
+		if (empty($items)) {
1220
+			return null;
1221
+		} else {
1222
+			return array_shift($items);
1223
+		}
1224
+	}
1225
+
1226
+
1227
+
1228
+	/**
1229
+	 * Returns the next x number of items in sequence from the given value as
1230
+	 * found in the database matching the given query conditions.
1231
+	 *
1232
+	 * @param mixed $current_field_value    Value used for the reference point.
1233
+	 * @param null  $field_to_order_by      What field is used for the
1234
+	 *                                      reference point.
1235
+	 * @param int   $limit                  How many to return.
1236
+	 * @param array $query_params           Extra conditions on the query.
1237
+	 * @param null  $columns_to_select      If left null, then an array of
1238
+	 *                                      EE_Base_Class objects is returned,
1239
+	 *                                      otherwise you can indicate just the
1240
+	 *                                      columns you want returned.
1241
+	 * @return EE_Base_Class[]|array
1242
+	 * @throws \EE_Error
1243
+	 */
1244
+	public function next_x(
1245
+		$current_field_value,
1246
+		$field_to_order_by = null,
1247
+		$limit = 1,
1248
+		$query_params = array(),
1249
+		$columns_to_select = null
1250
+	) {
1251
+		return $this->_get_consecutive($current_field_value, '>', $field_to_order_by, $limit, $query_params,
1252
+			$columns_to_select);
1253
+	}
1254
+
1255
+
1256
+
1257
+	/**
1258
+	 * Returns the previous x number of items in sequence from the given value
1259
+	 * as found in the database matching the given query conditions.
1260
+	 *
1261
+	 * @param mixed $current_field_value    Value used for the reference point.
1262
+	 * @param null  $field_to_order_by      What field is used for the
1263
+	 *                                      reference point.
1264
+	 * @param int   $limit                  How many to return.
1265
+	 * @param array $query_params           Extra conditions on the query.
1266
+	 * @param null  $columns_to_select      If left null, then an array of
1267
+	 *                                      EE_Base_Class objects is returned,
1268
+	 *                                      otherwise you can indicate just the
1269
+	 *                                      columns you want returned.
1270
+	 * @return EE_Base_Class[]|array
1271
+	 * @throws \EE_Error
1272
+	 */
1273
+	public function previous_x(
1274
+		$current_field_value,
1275
+		$field_to_order_by = null,
1276
+		$limit = 1,
1277
+		$query_params = array(),
1278
+		$columns_to_select = null
1279
+	) {
1280
+		return $this->_get_consecutive($current_field_value, '<', $field_to_order_by, $limit, $query_params,
1281
+			$columns_to_select);
1282
+	}
1283
+
1284
+
1285
+
1286
+	/**
1287
+	 * Returns the next item in sequence from the given value as found in the
1288
+	 * database matching the given query conditions.
1289
+	 *
1290
+	 * @param mixed $current_field_value    Value used for the reference point.
1291
+	 * @param null  $field_to_order_by      What field is used for the
1292
+	 *                                      reference point.
1293
+	 * @param array $query_params           Extra conditions on the query.
1294
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1295
+	 *                                      object is returned, otherwise you
1296
+	 *                                      can indicate just the columns you
1297
+	 *                                      want and a single array indexed by
1298
+	 *                                      the columns will be returned.
1299
+	 * @return EE_Base_Class|null|array()
1300
+	 * @throws \EE_Error
1301
+	 */
1302
+	public function next(
1303
+		$current_field_value,
1304
+		$field_to_order_by = null,
1305
+		$query_params = array(),
1306
+		$columns_to_select = null
1307
+	) {
1308
+		$results = $this->_get_consecutive($current_field_value, '>', $field_to_order_by, 1, $query_params,
1309
+			$columns_to_select);
1310
+		return empty($results) ? null : reset($results);
1311
+	}
1312
+
1313
+
1314
+
1315
+	/**
1316
+	 * Returns the previous item in sequence from the given value as found in
1317
+	 * the database matching the given query conditions.
1318
+	 *
1319
+	 * @param mixed $current_field_value    Value used for the reference point.
1320
+	 * @param null  $field_to_order_by      What field is used for the
1321
+	 *                                      reference point.
1322
+	 * @param array $query_params           Extra conditions on the query.
1323
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1324
+	 *                                      object is returned, otherwise you
1325
+	 *                                      can indicate just the columns you
1326
+	 *                                      want and a single array indexed by
1327
+	 *                                      the columns will be returned.
1328
+	 * @return EE_Base_Class|null|array()
1329
+	 * @throws EE_Error
1330
+	 */
1331
+	public function previous(
1332
+		$current_field_value,
1333
+		$field_to_order_by = null,
1334
+		$query_params = array(),
1335
+		$columns_to_select = null
1336
+	) {
1337
+		$results = $this->_get_consecutive($current_field_value, '<', $field_to_order_by, 1, $query_params,
1338
+			$columns_to_select);
1339
+		return empty($results) ? null : reset($results);
1340
+	}
1341
+
1342
+
1343
+
1344
+	/**
1345
+	 * Returns the a consecutive number of items in sequence from the given
1346
+	 * value as found in the database matching the given query conditions.
1347
+	 *
1348
+	 * @param mixed  $current_field_value   Value used for the reference point.
1349
+	 * @param string $operand               What operand is used for the sequence.
1350
+	 * @param string $field_to_order_by     What field is used for the reference point.
1351
+	 * @param int    $limit                 How many to return.
1352
+	 * @param array  $query_params          Extra conditions on the query.
1353
+	 * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1354
+	 *                                      otherwise you can indicate just the columns you want returned.
1355
+	 * @return EE_Base_Class[]|array
1356
+	 * @throws EE_Error
1357
+	 */
1358
+	protected function _get_consecutive(
1359
+		$current_field_value,
1360
+		$operand = '>',
1361
+		$field_to_order_by = null,
1362
+		$limit = 1,
1363
+		$query_params = array(),
1364
+		$columns_to_select = null
1365
+	) {
1366
+		//if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1367
+		if (empty($field_to_order_by)) {
1368
+			if ($this->has_primary_key_field()) {
1369
+				$field_to_order_by = $this->get_primary_key_field()->get_name();
1370
+			} else {
1371
+				if (WP_DEBUG) {
1372
+					throw new EE_Error(__('EEM_Base::_get_consecutive() has been called with no $field_to_order_by argument and there is no primary key on the field.  Please provide the field you would like to use as the base for retrieving the next item(s).',
1373
+						'event_espresso'));
1374
+				}
1375
+				EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1376
+				return array();
1377
+			}
1378
+		}
1379
+		if (! is_array($query_params)) {
1380
+			EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1381
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1382
+					gettype($query_params)), '4.6.0');
1383
+			$query_params = array();
1384
+		}
1385
+		//let's add the where query param for consecutive look up.
1386
+		$query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1387
+		$query_params['limit'] = $limit;
1388
+		//set direction
1389
+		$incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1390
+		$query_params['order_by'] = $operand === '>'
1391
+			? array($field_to_order_by => 'ASC') + $incoming_orderby
1392
+			: array($field_to_order_by => 'DESC') + $incoming_orderby;
1393
+		//if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1394
+		if (empty($columns_to_select)) {
1395
+			return $this->get_all($query_params);
1396
+		} else {
1397
+			//getting just the fields
1398
+			return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1399
+		}
1400
+	}
1401
+
1402
+
1403
+
1404
+	/**
1405
+	 * This sets the _timezone property after model object has been instantiated.
1406
+	 *
1407
+	 * @param null | string $timezone valid PHP DateTimeZone timezone string
1408
+	 */
1409
+	public function set_timezone($timezone)
1410
+	{
1411
+		if ($timezone !== null) {
1412
+			$this->_timezone = $timezone;
1413
+		}
1414
+		//note we need to loop through relations and set the timezone on those objects as well.
1415
+		foreach ($this->_model_relations as $relation) {
1416
+			$relation->set_timezone($timezone);
1417
+		}
1418
+		//and finally we do the same for any datetime fields
1419
+		foreach ($this->_fields as $field) {
1420
+			if ($field instanceof EE_Datetime_Field) {
1421
+				$field->set_timezone($timezone);
1422
+			}
1423
+		}
1424
+	}
1425
+
1426
+
1427
+
1428
+	/**
1429
+	 * This just returns whatever is set for the current timezone.
1430
+	 *
1431
+	 * @access public
1432
+	 * @return string
1433
+	 */
1434
+	public function get_timezone()
1435
+	{
1436
+		//first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1437
+		if (empty($this->_timezone)) {
1438
+			foreach ($this->_fields as $field) {
1439
+				if ($field instanceof EE_Datetime_Field) {
1440
+					$this->set_timezone($field->get_timezone());
1441
+					break;
1442
+				}
1443
+			}
1444
+		}
1445
+		//if timezone STILL empty then return the default timezone for the site.
1446
+		if (empty($this->_timezone)) {
1447
+			$this->set_timezone(EEH_DTT_Helper::get_timezone());
1448
+		}
1449
+		return $this->_timezone;
1450
+	}
1451
+
1452
+
1453
+
1454
+	/**
1455
+	 * This returns the date formats set for the given field name and also ensures that
1456
+	 * $this->_timezone property is set correctly.
1457
+	 *
1458
+	 * @since 4.6.x
1459
+	 * @param string $field_name The name of the field the formats are being retrieved for.
1460
+	 * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1461
+	 * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1462
+	 * @return array formats in an array with the date format first, and the time format last.
1463
+	 */
1464
+	public function get_formats_for($field_name, $pretty = false)
1465
+	{
1466
+		$field_settings = $this->field_settings_for($field_name);
1467
+		//if not a valid EE_Datetime_Field then throw error
1468
+		if (! $field_settings instanceof EE_Datetime_Field) {
1469
+			throw new EE_Error(sprintf(__('The field sent into EEM_Base::get_formats_for (%s) is not registered as a EE_Datetime_Field. Please check the spelling and make sure you are submitting the right field name to retrieve date_formats for.',
1470
+				'event_espresso'), $field_name));
1471
+		}
1472
+		//while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1473
+		//the field.
1474
+		$this->_timezone = $field_settings->get_timezone();
1475
+		return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1476
+	}
1477
+
1478
+
1479
+
1480
+	/**
1481
+	 * This returns the current time in a format setup for a query on this model.
1482
+	 * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1483
+	 * it will return:
1484
+	 *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1485
+	 *  NOW
1486
+	 *  - or a unix timestamp (equivalent to time())
1487
+	 *
1488
+	 * @since 4.6.x
1489
+	 * @param string $field_name       The field the current time is needed for.
1490
+	 * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1491
+	 *                                 formatted string matching the set format for the field in the set timezone will
1492
+	 *                                 be returned.
1493
+	 * @param string $what             Whether to return the string in just the time format, the date format, or both.
1494
+	 * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1495
+	 * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1496
+	 *                                 exception is triggered.
1497
+	 */
1498
+	public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1499
+	{
1500
+		$formats = $this->get_formats_for($field_name);
1501
+		$DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1502
+		if ($timestamp) {
1503
+			return $DateTime->format('U');
1504
+		}
1505
+		//not returning timestamp, so return formatted string in timezone.
1506
+		switch ($what) {
1507
+			case 'time' :
1508
+				return $DateTime->format($formats[1]);
1509
+				break;
1510
+			case 'date' :
1511
+				return $DateTime->format($formats[0]);
1512
+				break;
1513
+			default :
1514
+				return $DateTime->format(implode(' ', $formats));
1515
+				break;
1516
+		}
1517
+	}
1518
+
1519
+
1520
+
1521
+	/**
1522
+	 * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1523
+	 * for the model are.  Returns a DateTime object.
1524
+	 * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1525
+	 * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1526
+	 * ignored.
1527
+	 *
1528
+	 * @param string $field_name      The field being setup.
1529
+	 * @param string $timestring      The date time string being used.
1530
+	 * @param string $incoming_format The format for the time string.
1531
+	 * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1532
+	 *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1533
+	 *                                format is
1534
+	 *                                'U', this is ignored.
1535
+	 * @return DateTime
1536
+	 * @throws \EE_Error
1537
+	 */
1538
+	public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1539
+	{
1540
+		//just using this to ensure the timezone is set correctly internally
1541
+		$this->get_formats_for($field_name);
1542
+		//load EEH_DTT_Helper
1543
+		$set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1544
+		$incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1545
+		return $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone));
1546
+	}
1547
+
1548
+
1549
+
1550
+	/**
1551
+	 * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1552
+	 *
1553
+	 * @return EE_Table_Base[]
1554
+	 */
1555
+	public function get_tables()
1556
+	{
1557
+		return $this->_tables;
1558
+	}
1559
+
1560
+
1561
+
1562
+	/**
1563
+	 * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1564
+	 * also updates all the model objects, where the criteria expressed in $query_params are met..
1565
+	 * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1566
+	 * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1567
+	 * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1568
+	 * model object with EVT_ID = 1
1569
+	 * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1570
+	 * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1571
+	 * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1572
+	 * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1573
+	 * are not specified)
1574
+	 *
1575
+	 * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1576
+	 *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1577
+	 *                                         are to be serialized. Basically, the values are what you'd expect to be
1578
+	 *                                         values on the model, NOT necessarily what's in the DB. For example, if
1579
+	 *                                         we wanted to update only the TXN_details on any Transactions where its
1580
+	 *                                         ID=34, we'd use this method as follows:
1581
+	 *                                         EEM_Transaction::instance()->update(
1582
+	 *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1583
+	 *                                         array(array('TXN_ID'=>34)));
1584
+	 * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1585
+	 *                                         in client code into what's expected to be stored on each field. Eg,
1586
+	 *                                         consider updating Question's QST_admin_label field is of type
1587
+	 *                                         Simple_HTML. If you use this function to update that field to $new_value
1588
+	 *                                         = (note replace 8's with appropriate opening and closing tags in the
1589
+	 *                                         following example)"8script8alert('I hack all');8/script88b8boom
1590
+	 *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1591
+	 *                                         TRUE, it is assumed that you've already called
1592
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1593
+	 *                                         malicious javascript. However, if
1594
+	 *                                         $values_already_prepared_by_model_object is left as FALSE, then
1595
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
1596
+	 *                                         and every other field, before insertion. We provide this parameter
1597
+	 *                                         because model objects perform their prepare_for_set function on all
1598
+	 *                                         their values, and so don't need to be called again (and in many cases,
1599
+	 *                                         shouldn't be called again. Eg: if we escape HTML characters in the
1600
+	 *                                         prepare_for_set method...)
1601
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1602
+	 *                                         in this model's entity map according to $fields_n_values that match
1603
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
1604
+	 *                                         by setting this to FALSE, but be aware that model objects being used
1605
+	 *                                         could get out-of-sync with the database
1606
+	 * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1607
+	 *                                         rows affected which *could* include 0 which DOES NOT mean the query was
1608
+	 *                                         bad)
1609
+	 * @throws \EE_Error
1610
+	 */
1611
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1612
+	{
1613
+		if (! is_array($query_params)) {
1614
+			EE_Error::doing_it_wrong('EEM_Base::update',
1615
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1616
+					gettype($query_params)), '4.6.0');
1617
+			$query_params = array();
1618
+		}
1619
+		/**
1620
+		 * Action called before a model update call has been made.
1621
+		 *
1622
+		 * @param EEM_Base $model
1623
+		 * @param array    $fields_n_values the updated fields and their new values
1624
+		 * @param array    $query_params    @see EEM_Base::get_all()
1625
+		 */
1626
+		do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1627
+		/**
1628
+		 * Filters the fields about to be updated given the query parameters. You can provide the
1629
+		 * $query_params to $this->get_all() to find exactly which records will be updated
1630
+		 *
1631
+		 * @param array    $fields_n_values fields and their new values
1632
+		 * @param EEM_Base $model           the model being queried
1633
+		 * @param array    $query_params    see EEM_Base::get_all()
1634
+		 */
1635
+		$fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1636
+			$query_params);
1637
+		//need to verify that, for any entry we want to update, there are entries in each secondary table.
1638
+		//to do that, for each table, verify that it's PK isn't null.
1639
+		$tables = $this->get_tables();
1640
+		//and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
1641
+		//NOTE: we should make this code more efficient by NOT querying twice
1642
+		//before the real update, but that needs to first go through ALPHA testing
1643
+		//as it's dangerous. says Mike August 8 2014
1644
+		//we want to make sure the default_where strategy is ignored
1645
+		$this->_ignore_where_strategy = true;
1646
+		$wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1647
+		foreach ($wpdb_select_results as $wpdb_result) {
1648
+			// type cast stdClass as array
1649
+			$wpdb_result = (array)$wpdb_result;
1650
+			//get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1651
+			if ($this->has_primary_key_field()) {
1652
+				$main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1653
+			} else {
1654
+				//if there's no primary key, we basically can't support having a 2nd table on the model (we could but it would be lots of work)
1655
+				$main_table_pk_value = null;
1656
+			}
1657
+			//if there are more than 1 tables, we'll want to verify that each table for this model has an entry in the other tables
1658
+			//and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
1659
+			if (count($tables) > 1) {
1660
+				//foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1661
+				//in that table, and so we'll want to insert one
1662
+				foreach ($tables as $table_obj) {
1663
+					$this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1664
+					//if there is no private key for this table on the results, it means there's no entry
1665
+					//in this table, right? so insert a row in the current table, using any fields available
1666
+					if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1667
+						   && $wpdb_result[$this_table_pk_column])
1668
+					) {
1669
+						$success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1670
+							$main_table_pk_value);
1671
+						//if we died here, report the error
1672
+						if (! $success) {
1673
+							return false;
1674
+						}
1675
+					}
1676
+				}
1677
+			}
1678
+			//				//and now check that if we have cached any models by that ID on the model, that
1679
+			//				//they also get updated properly
1680
+			//				$model_object = $this->get_from_entity_map( $main_table_pk_value );
1681
+			//				if( $model_object ){
1682
+			//					foreach( $fields_n_values as $field => $value ){
1683
+			//						$model_object->set($field, $value);
1684
+			//let's make sure default_where strategy is followed now
1685
+			$this->_ignore_where_strategy = false;
1686
+		}
1687
+		//if we want to keep model objects in sync, AND
1688
+		//if this wasn't called from a model object (to update itself)
1689
+		//then we want to make sure we keep all the existing
1690
+		//model objects in sync with the db
1691
+		if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1692
+			if ($this->has_primary_key_field()) {
1693
+				$model_objs_affected_ids = $this->get_col($query_params);
1694
+			} else {
1695
+				//we need to select a bunch of columns and then combine them into the the "index primary key string"s
1696
+				$models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1697
+				$model_objs_affected_ids = array();
1698
+				foreach ($models_affected_key_columns as $row) {
1699
+					$combined_index_key = $this->get_index_primary_key_string($row);
1700
+					$model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1701
+				}
1702
+			}
1703
+			if (! $model_objs_affected_ids) {
1704
+				//wait wait wait- if nothing was affected let's stop here
1705
+				return 0;
1706
+			}
1707
+			foreach ($model_objs_affected_ids as $id) {
1708
+				$model_obj_in_entity_map = $this->get_from_entity_map($id);
1709
+				if ($model_obj_in_entity_map) {
1710
+					foreach ($fields_n_values as $field => $new_value) {
1711
+						$model_obj_in_entity_map->set($field, $new_value);
1712
+					}
1713
+				}
1714
+			}
1715
+			//if there is a primary key on this model, we can now do a slight optimization
1716
+			if ($this->has_primary_key_field()) {
1717
+				//we already know what we want to update. So let's make the query simpler so it's a little more efficient
1718
+				$query_params = array(
1719
+					array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1720
+					'limit'                    => count($model_objs_affected_ids),
1721
+					'default_where_conditions' => EEM_Base::default_where_conditions_none,
1722
+				);
1723
+			}
1724
+		}
1725
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1726
+		$SQL = "UPDATE "
1727
+			   . $model_query_info->get_full_join_sql()
1728
+			   . " SET "
1729
+			   . $this->_construct_update_sql($fields_n_values)
1730
+			   . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1731
+		$rows_affected = $this->_do_wpdb_query('query', array($SQL));
1732
+		/**
1733
+		 * Action called after a model update call has been made.
1734
+		 *
1735
+		 * @param EEM_Base $model
1736
+		 * @param array    $fields_n_values the updated fields and their new values
1737
+		 * @param array    $query_params    @see EEM_Base::get_all()
1738
+		 * @param int      $rows_affected
1739
+		 */
1740
+		do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1741
+		return $rows_affected;//how many supposedly got updated
1742
+	}
1743
+
1744
+
1745
+
1746
+	/**
1747
+	 * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1748
+	 * are teh values of the field specified (or by default the primary key field)
1749
+	 * that matched the query params. Note that you should pass the name of the
1750
+	 * model FIELD, not the database table's column name.
1751
+	 *
1752
+	 * @param array  $query_params @see EEM_Base::get_all()
1753
+	 * @param string $field_to_select
1754
+	 * @return array just like $wpdb->get_col()
1755
+	 * @throws \EE_Error
1756
+	 */
1757
+	public function get_col($query_params = array(), $field_to_select = null)
1758
+	{
1759
+		if ($field_to_select) {
1760
+			$field = $this->field_settings_for($field_to_select);
1761
+		} elseif ($this->has_primary_key_field()) {
1762
+			$field = $this->get_primary_key_field();
1763
+		} else {
1764
+			//no primary key, just grab the first column
1765
+			$field = reset($this->field_settings());
1766
+		}
1767
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1768
+		$select_expressions = $field->get_qualified_column();
1769
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1770
+		return $this->_do_wpdb_query('get_col', array($SQL));
1771
+	}
1772
+
1773
+
1774
+
1775
+	/**
1776
+	 * Returns a single column value for a single row from the database
1777
+	 *
1778
+	 * @param array  $query_params    @see EEM_Base::get_all()
1779
+	 * @param string $field_to_select @see EEM_Base::get_col()
1780
+	 * @return string
1781
+	 * @throws \EE_Error
1782
+	 */
1783
+	public function get_var($query_params = array(), $field_to_select = null)
1784
+	{
1785
+		$query_params['limit'] = 1;
1786
+		$col = $this->get_col($query_params, $field_to_select);
1787
+		if (! empty($col)) {
1788
+			return reset($col);
1789
+		} else {
1790
+			return null;
1791
+		}
1792
+	}
1793
+
1794
+
1795
+
1796
+	/**
1797
+	 * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1798
+	 * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1799
+	 * injection, but currently no further filtering is done
1800
+	 *
1801
+	 * @global      $wpdb
1802
+	 * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1803
+	 *                               be updated to in the DB
1804
+	 * @return string of SQL
1805
+	 * @throws \EE_Error
1806
+	 */
1807
+	public function _construct_update_sql($fields_n_values)
1808
+	{
1809
+		/** @type WPDB $wpdb */
1810
+		global $wpdb;
1811
+		$cols_n_values = array();
1812
+		foreach ($fields_n_values as $field_name => $value) {
1813
+			$field_obj = $this->field_settings_for($field_name);
1814
+			//if the value is NULL, we want to assign the value to that.
1815
+			//wpdb->prepare doesn't really handle that properly
1816
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1817
+			$value_sql = $prepared_value === null ? 'NULL'
1818
+				: $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1819
+			$cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1820
+		}
1821
+		return implode(",", $cols_n_values);
1822
+	}
1823
+
1824
+
1825
+
1826
+	/**
1827
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1828
+	 * Performs a HARD delete, meaning the database row should always be removed,
1829
+	 * not just have a flag field on it switched
1830
+	 * Wrapper for EEM_Base::delete_permanently()
1831
+	 *
1832
+	 * @param mixed $id
1833
+	 * @return boolean whether the row got deleted or not
1834
+	 * @throws \EE_Error
1835
+	 */
1836
+	public function delete_permanently_by_ID($id)
1837
+	{
1838
+		return $this->delete_permanently(
1839
+			array(
1840
+				array($this->get_primary_key_field()->get_name() => $id),
1841
+				'limit' => 1,
1842
+			)
1843
+		);
1844
+	}
1845
+
1846
+
1847
+
1848
+	/**
1849
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1850
+	 * Wrapper for EEM_Base::delete()
1851
+	 *
1852
+	 * @param mixed $id
1853
+	 * @return boolean whether the row got deleted or not
1854
+	 * @throws \EE_Error
1855
+	 */
1856
+	public function delete_by_ID($id)
1857
+	{
1858
+		return $this->delete(
1859
+			array(
1860
+				array($this->get_primary_key_field()->get_name() => $id),
1861
+				'limit' => 1,
1862
+			)
1863
+		);
1864
+	}
1865
+
1866
+
1867
+
1868
+	/**
1869
+	 * Identical to delete_permanently, but does a "soft" delete if possible,
1870
+	 * meaning if the model has a field that indicates its been "trashed" or
1871
+	 * "soft deleted", we will just set that instead of actually deleting the rows.
1872
+	 *
1873
+	 * @see EEM_Base::delete_permanently
1874
+	 * @param array   $query_params
1875
+	 * @param boolean $allow_blocking
1876
+	 * @return int how many rows got deleted
1877
+	 * @throws \EE_Error
1878
+	 */
1879
+	public function delete($query_params, $allow_blocking = true)
1880
+	{
1881
+		return $this->delete_permanently($query_params, $allow_blocking);
1882
+	}
1883
+
1884
+
1885
+
1886
+	/**
1887
+	 * Deletes the model objects that meet the query params. Note: this method is overridden
1888
+	 * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1889
+	 * as archived, not actually deleted
1890
+	 *
1891
+	 * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1892
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1893
+	 *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1894
+	 *                                deletes regardless of other objects which may depend on it. Its generally
1895
+	 *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1896
+	 *                                DB
1897
+	 * @return int how many rows got deleted
1898
+	 * @throws \EE_Error
1899
+	 */
1900
+	public function delete_permanently($query_params, $allow_blocking = true)
1901
+	{
1902
+		/**
1903
+		 * Action called just before performing a real deletion query. You can use the
1904
+		 * model and its $query_params to find exactly which items will be deleted
1905
+		 *
1906
+		 * @param EEM_Base $model
1907
+		 * @param array    $query_params   @see EEM_Base::get_all()
1908
+		 * @param boolean  $allow_blocking whether or not to allow related model objects
1909
+		 *                                 to block (prevent) this deletion
1910
+		 */
1911
+		do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1912
+		//some MySQL databases may be running safe mode, which may restrict
1913
+		//deletion if there is no KEY column used in the WHERE statement of a deletion.
1914
+		//to get around this, we first do a SELECT, get all the IDs, and then run another query
1915
+		//to delete them
1916
+		$items_for_deletion = $this->_get_all_wpdb_results($query_params);
1917
+		$deletion_where = $this->_setup_ids_for_delete($items_for_deletion, $allow_blocking);
1918
+		if ($deletion_where) {
1919
+			//echo "objects for deletion:";var_dump($objects_for_deletion);
1920
+			$model_query_info = $this->_create_model_query_info_carrier($query_params);
1921
+			$table_aliases = array_keys($this->_tables);
1922
+			$SQL = "DELETE "
1923
+				   . implode(", ", $table_aliases)
1924
+				   . " FROM "
1925
+				   . $model_query_info->get_full_join_sql()
1926
+				   . " WHERE "
1927
+				   . $deletion_where;
1928
+			//		/echo "delete sql:$SQL";
1929
+			$rows_deleted = $this->_do_wpdb_query('query', array($SQL));
1930
+		} else {
1931
+			$rows_deleted = 0;
1932
+		}
1933
+		//and lastly make sure those items are removed from the entity map; if they could be put into it at all
1934
+		if ($this->has_primary_key_field()) {
1935
+			foreach ($items_for_deletion as $item_for_deletion_row) {
1936
+				$pk_value = $item_for_deletion_row[$this->get_primary_key_field()->get_qualified_column()];
1937
+				if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value])) {
1938
+					unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value]);
1939
+				}
1940
+			}
1941
+		}
1942
+		/**
1943
+		 * Action called just after performing a real deletion query. Although at this point the
1944
+		 * items should have been deleted
1945
+		 *
1946
+		 * @param EEM_Base $model
1947
+		 * @param array    $query_params @see EEM_Base::get_all()
1948
+		 * @param int      $rows_deleted
1949
+		 */
1950
+		do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
1951
+		return $rows_deleted;//how many supposedly got deleted
1952
+	}
1953
+
1954
+
1955
+
1956
+	/**
1957
+	 * Checks all the relations that throw error messages when there are blocking related objects
1958
+	 * for related model objects. If there are any related model objects on those relations,
1959
+	 * adds an EE_Error, and return true
1960
+	 *
1961
+	 * @param EE_Base_Class|int $this_model_obj_or_id
1962
+	 * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
1963
+	 *                                                 should be ignored when determining whether there are related
1964
+	 *                                                 model objects which block this model object's deletion. Useful
1965
+	 *                                                 if you know A is related to B and are considering deleting A,
1966
+	 *                                                 but want to see if A has any other objects blocking its deletion
1967
+	 *                                                 before removing the relation between A and B
1968
+	 * @return boolean
1969
+	 * @throws \EE_Error
1970
+	 */
1971
+	public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
1972
+	{
1973
+		//first, if $ignore_this_model_obj was supplied, get its model
1974
+		if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
1975
+			$ignored_model = $ignore_this_model_obj->get_model();
1976
+		} else {
1977
+			$ignored_model = null;
1978
+		}
1979
+		//now check all the relations of $this_model_obj_or_id and see if there
1980
+		//are any related model objects blocking it?
1981
+		$is_blocked = false;
1982
+		foreach ($this->_model_relations as $relation_name => $relation_obj) {
1983
+			if ($relation_obj->block_delete_if_related_models_exist()) {
1984
+				//if $ignore_this_model_obj was supplied, then for the query
1985
+				//on that model needs to be told to ignore $ignore_this_model_obj
1986
+				if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
1987
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
1988
+						array(
1989
+							$ignored_model->get_primary_key_field()->get_name() => array(
1990
+								'!=',
1991
+								$ignore_this_model_obj->ID(),
1992
+							),
1993
+						),
1994
+					));
1995
+				} else {
1996
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
1997
+				}
1998
+				if ($related_model_objects) {
1999
+					EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
2000
+					$is_blocked = true;
2001
+				}
2002
+			}
2003
+		}
2004
+		return $is_blocked;
2005
+	}
2006
+
2007
+
2008
+
2009
+	/**
2010
+	 * This sets up our delete where sql and accounts for if we have secondary tables that will have rows deleted as
2011
+	 * well.
2012
+	 *
2013
+	 * @param  array  $objects_for_deletion This should be the values returned by $this->_get_all_wpdb_results()
2014
+	 * @param boolean $allow_blocking       if TRUE, matched objects will only be deleted if there is no related model
2015
+	 *                                      info that blocks it (ie, there' sno other data that depends on this data);
2016
+	 *                                      if false, deletes regardless of other objects which may depend on it. Its
2017
+	 *                                      generally advisable to always leave this as TRUE, otherwise you could
2018
+	 *                                      easily corrupt your DB
2019
+	 * @throws EE_Error
2020
+	 * @return string    everything that comes after the WHERE statement.
2021
+	 */
2022
+	protected function _setup_ids_for_delete($objects_for_deletion, $allow_blocking = true)
2023
+	{
2024
+		if ($this->has_primary_key_field()) {
2025
+			$primary_table = $this->_get_main_table();
2026
+			$other_tables = $this->_get_other_tables();
2027
+			$deletes = $query = array();
2028
+			foreach ($objects_for_deletion as $delete_object) {
2029
+				//before we mark this object for deletion,
2030
+				//make sure there's no related objects blocking its deletion (if we're checking)
2031
+				if (
2032
+					$allow_blocking
2033
+					&& $this->delete_is_blocked_by_related_models(
2034
+						$delete_object[$primary_table->get_fully_qualified_pk_column()]
2035
+					)
2036
+				) {
2037
+					continue;
2038
+				}
2039
+				//primary table deletes
2040
+				if (isset($delete_object[$primary_table->get_fully_qualified_pk_column()])) {
2041
+					$deletes[$primary_table->get_fully_qualified_pk_column()][] = $delete_object[$primary_table->get_fully_qualified_pk_column()];
2042
+				}
2043
+				//other tables
2044
+				if (! empty($other_tables)) {
2045
+					foreach ($other_tables as $ot) {
2046
+						//first check if we've got the foreign key column here.
2047
+						if (isset($delete_object[$ot->get_fully_qualified_fk_column()])) {
2048
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_fk_column()];
2049
+						}
2050
+						// wait! it's entirely possible that we'll have a the primary key
2051
+						// for this table in here, if it's a foreign key for one of the other secondary tables
2052
+						if (isset($delete_object[$ot->get_fully_qualified_pk_column()])) {
2053
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
2054
+						}
2055
+						// finally, it is possible that the fk for this table is found
2056
+						// in the fully qualified pk column for the fk table, so let's see if that's there!
2057
+						if (isset($delete_object[$ot->get_fully_qualified_pk_on_fk_table()])) {
2058
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
2059
+						}
2060
+					}
2061
+				}
2062
+			}
2063
+			//we should have deletes now, so let's just go through and setup the where statement
2064
+			foreach ($deletes as $column => $values) {
2065
+				//make sure we have unique $values;
2066
+				$values = array_unique($values);
2067
+				$query[] = $column . ' IN(' . implode(",", $values) . ')';
2068
+			}
2069
+			return ! empty($query) ? implode(' AND ', $query) : '';
2070
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
2071
+			$ways_to_identify_a_row = array();
2072
+			$fields = $this->get_combined_primary_key_fields();
2073
+			//note: because there' sno primary key, that means nothing else  can be pointing to this model, right?
2074
+			foreach ($objects_for_deletion as $delete_object) {
2075
+				$values_for_each_cpk_for_a_row = array();
2076
+				foreach ($fields as $cpk_field) {
2077
+					if ($cpk_field instanceof EE_Model_Field_Base) {
2078
+						$values_for_each_cpk_for_a_row[] = $cpk_field->get_qualified_column()
2079
+														   . "="
2080
+														   . $delete_object[$cpk_field->get_qualified_column()];
2081
+					}
2082
+				}
2083
+				$ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
2084
+			}
2085
+			return implode(" OR ", $ways_to_identify_a_row);
2086
+		} else {
2087
+			//so there's no primary key and no combined key...
2088
+			//sorry, can't help you
2089
+			throw new EE_Error(sprintf(__("Cannot delete objects of type %s because there is no primary key NOR combined key",
2090
+				"event_espresso"), get_class($this)));
2091
+		}
2092
+	}
2093
+
2094
+
2095
+
2096
+	/**
2097
+	 * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
2098
+	 * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
2099
+	 * column
2100
+	 *
2101
+	 * @param array  $query_params   like EEM_Base::get_all's
2102
+	 * @param string $field_to_count field on model to count by (not column name)
2103
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2104
+	 *                               that by the setting $distinct to TRUE;
2105
+	 * @return int
2106
+	 * @throws \EE_Error
2107
+	 */
2108
+	public function count($query_params = array(), $field_to_count = null, $distinct = false)
2109
+	{
2110
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2111
+		if ($field_to_count) {
2112
+			$field_obj = $this->field_settings_for($field_to_count);
2113
+			$column_to_count = $field_obj->get_qualified_column();
2114
+		} elseif ($this->has_primary_key_field()) {
2115
+			$pk_field_obj = $this->get_primary_key_field();
2116
+			$column_to_count = $pk_field_obj->get_qualified_column();
2117
+		} else {
2118
+			//there's no primary key
2119
+			//if we're counting distinct items, and there's no primary key,
2120
+			//we need to list out the columns for distinction;
2121
+			//otherwise we can just use star
2122
+			if ($distinct) {
2123
+				$columns_to_use = array();
2124
+				foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2125
+					$columns_to_use[] = $field_obj->get_qualified_column();
2126
+				}
2127
+				$column_to_count = implode(',', $columns_to_use);
2128
+			} else {
2129
+				$column_to_count = '*';
2130
+			}
2131
+		}
2132
+		$column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2133
+		$SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2134
+		return (int)$this->_do_wpdb_query('get_var', array($SQL));
2135
+	}
2136
+
2137
+
2138
+
2139
+	/**
2140
+	 * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2141
+	 *
2142
+	 * @param array  $query_params like EEM_Base::get_all
2143
+	 * @param string $field_to_sum name of field (array key in $_fields array)
2144
+	 * @return float
2145
+	 * @throws \EE_Error
2146
+	 */
2147
+	public function sum($query_params, $field_to_sum = null)
2148
+	{
2149
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2150
+		if ($field_to_sum) {
2151
+			$field_obj = $this->field_settings_for($field_to_sum);
2152
+		} else {
2153
+			$field_obj = $this->get_primary_key_field();
2154
+		}
2155
+		$column_to_count = $field_obj->get_qualified_column();
2156
+		$SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2157
+		$return_value = $this->_do_wpdb_query('get_var', array($SQL));
2158
+		$data_type = $field_obj->get_wpdb_data_type();
2159
+		if ($data_type === '%d' || $data_type === '%s') {
2160
+			return (float)$return_value;
2161
+		} else {//must be %f
2162
+			return (float)$return_value;
2163
+		}
2164
+	}
2165
+
2166
+
2167
+
2168
+	/**
2169
+	 * Just calls the specified method on $wpdb with the given arguments
2170
+	 * Consolidates a little extra error handling code
2171
+	 *
2172
+	 * @param string $wpdb_method
2173
+	 * @param array  $arguments_to_provide
2174
+	 * @throws EE_Error
2175
+	 * @global wpdb  $wpdb
2176
+	 * @return mixed
2177
+	 */
2178
+	protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2179
+	{
2180
+		//if we're in maintenance mode level 2, DON'T run any queries
2181
+		//because level 2 indicates the database needs updating and
2182
+		//is probably out of sync with the code
2183
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2184
+			throw new EE_Error(sprintf(__("Event Espresso Level 2 Maintenance mode is active. That means EE can not run ANY database queries until the necessary migration scripts have run which will take EE out of maintenance mode level 2. Please inform support of this error.",
2185
+				"event_espresso")));
2186
+		}
2187
+		/** @type WPDB $wpdb */
2188
+		global $wpdb;
2189
+		if (! method_exists($wpdb, $wpdb_method)) {
2190
+			throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2191
+				'event_espresso'), $wpdb_method));
2192
+		}
2193
+		if (WP_DEBUG) {
2194
+			$old_show_errors_value = $wpdb->show_errors;
2195
+			$wpdb->show_errors(false);
2196
+		}
2197
+		$result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2198
+		$this->show_db_query_if_previously_requested($wpdb->last_query);
2199
+		if (WP_DEBUG) {
2200
+			$wpdb->show_errors($old_show_errors_value);
2201
+			if (! empty($wpdb->last_error)) {
2202
+				throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2203
+			} elseif ($result === false) {
2204
+				throw new EE_Error(sprintf(__('WPDB Error occurred, but no error message was logged by wpdb! The wpdb method called was "%1$s" and the arguments were "%2$s"',
2205
+					'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2206
+			}
2207
+		} elseif ($result === false) {
2208
+			EE_Error::add_error(
2209
+				sprintf(
2210
+					__('A database error has occurred. Turn on WP_DEBUG for more information.||A database error occurred doing wpdb method "%1$s", with arguments "%2$s". The error was "%3$s"',
2211
+						'event_espresso'),
2212
+					$wpdb_method,
2213
+					var_export($arguments_to_provide, true),
2214
+					$wpdb->last_error
2215
+				),
2216
+				__FILE__,
2217
+				__FUNCTION__,
2218
+				__LINE__
2219
+			);
2220
+		}
2221
+		return $result;
2222
+	}
2223
+
2224
+
2225
+
2226
+	/**
2227
+	 * Attempts to run the indicated WPDB method with the provided arguments,
2228
+	 * and if there's an error tries to verify the DB is correct. Uses
2229
+	 * the static property EEM_Base::$_db_verification_level to determine whether
2230
+	 * we should try to fix the EE core db, the addons, or just give up
2231
+	 *
2232
+	 * @param string $wpdb_method
2233
+	 * @param array  $arguments_to_provide
2234
+	 * @return mixed
2235
+	 */
2236
+	private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2237
+	{
2238
+		/** @type WPDB $wpdb */
2239
+		global $wpdb;
2240
+		$wpdb->last_error = null;
2241
+		$result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2242
+		// was there an error running the query? but we don't care on new activations
2243
+		// (we're going to setup the DB anyway on new activations)
2244
+		if (($result === false || ! empty($wpdb->last_error))
2245
+			&& EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2246
+		) {
2247
+			switch (EEM_Base::$_db_verification_level) {
2248
+				case EEM_Base::db_verified_none :
2249
+					// let's double-check core's DB
2250
+					$error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2251
+					break;
2252
+				case EEM_Base::db_verified_core :
2253
+					// STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2254
+					$error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2255
+					break;
2256
+				case EEM_Base::db_verified_addons :
2257
+					// ummmm... you in trouble
2258
+					return $result;
2259
+					break;
2260
+			}
2261
+			if (! empty($error_message)) {
2262
+				EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2263
+				trigger_error($error_message);
2264
+			}
2265
+			return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2266
+		}
2267
+		return $result;
2268
+	}
2269
+
2270
+
2271
+
2272
+	/**
2273
+	 * Verifies the EE core database is up-to-date and records that we've done it on
2274
+	 * EEM_Base::$_db_verification_level
2275
+	 *
2276
+	 * @param string $wpdb_method
2277
+	 * @param array  $arguments_to_provide
2278
+	 * @return string
2279
+	 */
2280
+	private function _verify_core_db($wpdb_method, $arguments_to_provide)
2281
+	{
2282
+		/** @type WPDB $wpdb */
2283
+		global $wpdb;
2284
+		//ok remember that we've already attempted fixing the core db, in case the problem persists
2285
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2286
+		$error_message = sprintf(
2287
+			__('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2288
+				'event_espresso'),
2289
+			$wpdb->last_error,
2290
+			$wpdb_method,
2291
+			wp_json_encode($arguments_to_provide)
2292
+		);
2293
+		EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2294
+		return $error_message;
2295
+	}
2296
+
2297
+
2298
+
2299
+	/**
2300
+	 * Verifies the EE addons' database is up-to-date and records that we've done it on
2301
+	 * EEM_Base::$_db_verification_level
2302
+	 *
2303
+	 * @param $wpdb_method
2304
+	 * @param $arguments_to_provide
2305
+	 * @return string
2306
+	 */
2307
+	private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2308
+	{
2309
+		/** @type WPDB $wpdb */
2310
+		global $wpdb;
2311
+		//ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2312
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2313
+		$error_message = sprintf(
2314
+			__('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2315
+				'event_espresso'),
2316
+			$wpdb->last_error,
2317
+			$wpdb_method,
2318
+			wp_json_encode($arguments_to_provide)
2319
+		);
2320
+		EE_System::instance()->initialize_addons();
2321
+		return $error_message;
2322
+	}
2323
+
2324
+
2325
+
2326
+	/**
2327
+	 * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2328
+	 * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2329
+	 * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2330
+	 * ..."
2331
+	 *
2332
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
2333
+	 * @return string
2334
+	 */
2335
+	private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2336
+	{
2337
+		return " FROM " . $model_query_info->get_full_join_sql() .
2338
+			   $model_query_info->get_where_sql() .
2339
+			   $model_query_info->get_group_by_sql() .
2340
+			   $model_query_info->get_having_sql() .
2341
+			   $model_query_info->get_order_by_sql() .
2342
+			   $model_query_info->get_limit_sql();
2343
+	}
2344
+
2345
+
2346
+
2347
+	/**
2348
+	 * Set to easily debug the next X queries ran from this model.
2349
+	 *
2350
+	 * @param int $count
2351
+	 */
2352
+	public function show_next_x_db_queries($count = 1)
2353
+	{
2354
+		$this->_show_next_x_db_queries = $count;
2355
+	}
2356
+
2357
+
2358
+
2359
+	/**
2360
+	 * @param $sql_query
2361
+	 */
2362
+	public function show_db_query_if_previously_requested($sql_query)
2363
+	{
2364
+		if ($this->_show_next_x_db_queries > 0) {
2365
+			echo $sql_query;
2366
+			$this->_show_next_x_db_queries--;
2367
+		}
2368
+	}
2369
+
2370
+
2371
+
2372
+	/**
2373
+	 * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2374
+	 * There are the 3 cases:
2375
+	 * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2376
+	 * $otherModelObject has no ID, it is first saved.
2377
+	 * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2378
+	 * has no ID, it is first saved.
2379
+	 * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2380
+	 * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2381
+	 * join table
2382
+	 *
2383
+	 * @param        EE_Base_Class                     /int $thisModelObject
2384
+	 * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2385
+	 * @param string $relationName                     , key in EEM_Base::_relations
2386
+	 *                                                 an attendee to a group, you also want to specify which role they
2387
+	 *                                                 will have in that group. So you would use this parameter to
2388
+	 *                                                 specify array('role-column-name'=>'role-id')
2389
+	 * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2390
+	 *                                                 to for relation to methods that allow you to further specify
2391
+	 *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2392
+	 *                                                 only acceptable query_params is strict "col" => "value" pairs
2393
+	 *                                                 because these will be inserted in any new rows created as well.
2394
+	 * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2395
+	 * @throws \EE_Error
2396
+	 */
2397
+	public function add_relationship_to(
2398
+		$id_or_obj,
2399
+		$other_model_id_or_obj,
2400
+		$relationName,
2401
+		$extra_join_model_fields_n_values = array()
2402
+	) {
2403
+		$relation_obj = $this->related_settings_for($relationName);
2404
+		return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2405
+	}
2406
+
2407
+
2408
+
2409
+	/**
2410
+	 * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2411
+	 * There are the 3 cases:
2412
+	 * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2413
+	 * error
2414
+	 * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2415
+	 * an error
2416
+	 * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2417
+	 *
2418
+	 * @param        EE_Base_Class /int $id_or_obj
2419
+	 * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2420
+	 * @param string $relationName key in EEM_Base::_relations
2421
+	 * @return boolean of success
2422
+	 * @throws \EE_Error
2423
+	 * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2424
+	 *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2425
+	 *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2426
+	 *                             because these will be inserted in any new rows created as well.
2427
+	 */
2428
+	public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2429
+	{
2430
+		$relation_obj = $this->related_settings_for($relationName);
2431
+		return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2432
+	}
2433
+
2434
+
2435
+
2436
+	/**
2437
+	 * @param mixed           $id_or_obj
2438
+	 * @param string          $relationName
2439
+	 * @param array           $where_query_params
2440
+	 * @param EE_Base_Class[] objects to which relations were removed
2441
+	 * @return \EE_Base_Class[]
2442
+	 * @throws \EE_Error
2443
+	 */
2444
+	public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2445
+	{
2446
+		$relation_obj = $this->related_settings_for($relationName);
2447
+		return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2448
+	}
2449
+
2450
+
2451
+
2452
+	/**
2453
+	 * Gets all the related items of the specified $model_name, using $query_params.
2454
+	 * Note: by default, we remove the "default query params"
2455
+	 * because we want to get even deleted items etc.
2456
+	 *
2457
+	 * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2458
+	 * @param string $model_name   like 'Event', 'Registration', etc. always singular
2459
+	 * @param array  $query_params like EEM_Base::get_all
2460
+	 * @return EE_Base_Class[]
2461
+	 * @throws \EE_Error
2462
+	 */
2463
+	public function get_all_related($id_or_obj, $model_name, $query_params = null)
2464
+	{
2465
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2466
+		$relation_settings = $this->related_settings_for($model_name);
2467
+		return $relation_settings->get_all_related($model_obj, $query_params);
2468
+	}
2469
+
2470
+
2471
+
2472
+	/**
2473
+	 * Deletes all the model objects across the relation indicated by $model_name
2474
+	 * which are related to $id_or_obj which meet the criteria set in $query_params.
2475
+	 * However, if the model objects can't be deleted because of blocking related model objects, then
2476
+	 * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2477
+	 *
2478
+	 * @param EE_Base_Class|int|string $id_or_obj
2479
+	 * @param string                   $model_name
2480
+	 * @param array                    $query_params
2481
+	 * @return int how many deleted
2482
+	 * @throws \EE_Error
2483
+	 */
2484
+	public function delete_related($id_or_obj, $model_name, $query_params = array())
2485
+	{
2486
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2487
+		$relation_settings = $this->related_settings_for($model_name);
2488
+		return $relation_settings->delete_all_related($model_obj, $query_params);
2489
+	}
2490
+
2491
+
2492
+
2493
+	/**
2494
+	 * Hard deletes all the model objects across the relation indicated by $model_name
2495
+	 * which are related to $id_or_obj which meet the criteria set in $query_params. If
2496
+	 * the model objects can't be hard deleted because of blocking related model objects,
2497
+	 * just does a soft-delete on them instead.
2498
+	 *
2499
+	 * @param EE_Base_Class|int|string $id_or_obj
2500
+	 * @param string                   $model_name
2501
+	 * @param array                    $query_params
2502
+	 * @return int how many deleted
2503
+	 * @throws \EE_Error
2504
+	 */
2505
+	public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2506
+	{
2507
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2508
+		$relation_settings = $this->related_settings_for($model_name);
2509
+		return $relation_settings->delete_related_permanently($model_obj, $query_params);
2510
+	}
2511
+
2512
+
2513
+
2514
+	/**
2515
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2516
+	 * unless otherwise specified in the $query_params
2517
+	 *
2518
+	 * @param        int             /EE_Base_Class $id_or_obj
2519
+	 * @param string $model_name     like 'Event', or 'Registration'
2520
+	 * @param array  $query_params   like EEM_Base::get_all's
2521
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
2522
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2523
+	 *                               that by the setting $distinct to TRUE;
2524
+	 * @return int
2525
+	 * @throws \EE_Error
2526
+	 */
2527
+	public function count_related(
2528
+		$id_or_obj,
2529
+		$model_name,
2530
+		$query_params = array(),
2531
+		$field_to_count = null,
2532
+		$distinct = false
2533
+	) {
2534
+		$related_model = $this->get_related_model_obj($model_name);
2535
+		//we're just going to use the query params on the related model's normal get_all query,
2536
+		//except add a condition to say to match the current mod
2537
+		if (! isset($query_params['default_where_conditions'])) {
2538
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2539
+		}
2540
+		$this_model_name = $this->get_this_model_name();
2541
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2542
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2543
+		return $related_model->count($query_params, $field_to_count, $distinct);
2544
+	}
2545
+
2546
+
2547
+
2548
+	/**
2549
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
2550
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2551
+	 *
2552
+	 * @param        int           /EE_Base_Class $id_or_obj
2553
+	 * @param string $model_name   like 'Event', or 'Registration'
2554
+	 * @param array  $query_params like EEM_Base::get_all's
2555
+	 * @param string $field_to_sum name of field to count by. By default, uses primary key
2556
+	 * @return float
2557
+	 * @throws \EE_Error
2558
+	 */
2559
+	public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2560
+	{
2561
+		$related_model = $this->get_related_model_obj($model_name);
2562
+		if (! is_array($query_params)) {
2563
+			EE_Error::doing_it_wrong('EEM_Base::sum_related',
2564
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2565
+					gettype($query_params)), '4.6.0');
2566
+			$query_params = array();
2567
+		}
2568
+		//we're just going to use the query params on the related model's normal get_all query,
2569
+		//except add a condition to say to match the current mod
2570
+		if (! isset($query_params['default_where_conditions'])) {
2571
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2572
+		}
2573
+		$this_model_name = $this->get_this_model_name();
2574
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2575
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2576
+		return $related_model->sum($query_params, $field_to_sum);
2577
+	}
2578
+
2579
+
2580
+
2581
+	/**
2582
+	 * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2583
+	 * $modelObject
2584
+	 *
2585
+	 * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2586
+	 * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2587
+	 * @param array               $query_params     like EEM_Base::get_all's
2588
+	 * @return EE_Base_Class
2589
+	 * @throws \EE_Error
2590
+	 */
2591
+	public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2592
+	{
2593
+		$query_params['limit'] = 1;
2594
+		$results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2595
+		if ($results) {
2596
+			return array_shift($results);
2597
+		} else {
2598
+			return null;
2599
+		}
2600
+	}
2601
+
2602
+
2603
+
2604
+	/**
2605
+	 * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2606
+	 *
2607
+	 * @return string
2608
+	 */
2609
+	public function get_this_model_name()
2610
+	{
2611
+		return str_replace("EEM_", "", get_class($this));
2612
+	}
2613
+
2614
+
2615
+
2616
+	/**
2617
+	 * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2618
+	 *
2619
+	 * @return EE_Any_Foreign_Model_Name_Field
2620
+	 * @throws EE_Error
2621
+	 */
2622
+	public function get_field_containing_related_model_name()
2623
+	{
2624
+		foreach ($this->field_settings(true) as $field) {
2625
+			if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2626
+				$field_with_model_name = $field;
2627
+			}
2628
+		}
2629
+		if (! isset($field_with_model_name) || ! $field_with_model_name) {
2630
+			throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2631
+				$this->get_this_model_name()));
2632
+		}
2633
+		return $field_with_model_name;
2634
+	}
2635
+
2636
+
2637
+
2638
+	/**
2639
+	 * Inserts a new entry into the database, for each table.
2640
+	 * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2641
+	 * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2642
+	 * we also know there is no model object with the newly inserted item's ID at the moment (because
2643
+	 * if there were, then they would already be in the DB and this would fail); and in the future if someone
2644
+	 * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2645
+	 * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2646
+	 *
2647
+	 * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2648
+	 *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2649
+	 *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2650
+	 *                              of EEM_Base)
2651
+	 * @return int new primary key on main table that got inserted
2652
+	 * @throws EE_Error
2653
+	 */
2654
+	public function insert($field_n_values)
2655
+	{
2656
+		/**
2657
+		 * Filters the fields and their values before inserting an item using the models
2658
+		 *
2659
+		 * @param array    $fields_n_values keys are the fields and values are their new values
2660
+		 * @param EEM_Base $model           the model used
2661
+		 */
2662
+		$field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2663
+		if ($this->_satisfies_unique_indexes($field_n_values)) {
2664
+			$main_table = $this->_get_main_table();
2665
+			$new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2666
+			if ($new_id !== false) {
2667
+				foreach ($this->_get_other_tables() as $other_table) {
2668
+					$this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2669
+				}
2670
+			}
2671
+			/**
2672
+			 * Done just after attempting to insert a new model object
2673
+			 *
2674
+			 * @param EEM_Base   $model           used
2675
+			 * @param array      $fields_n_values fields and their values
2676
+			 * @param int|string the              ID of the newly-inserted model object
2677
+			 */
2678
+			do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2679
+			return $new_id;
2680
+		} else {
2681
+			return false;
2682
+		}
2683
+	}
2684
+
2685
+
2686
+
2687
+	/**
2688
+	 * Checks that the result would satisfy the unique indexes on this model
2689
+	 *
2690
+	 * @param array  $field_n_values
2691
+	 * @param string $action
2692
+	 * @return boolean
2693
+	 * @throws \EE_Error
2694
+	 */
2695
+	protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2696
+	{
2697
+		foreach ($this->unique_indexes() as $index_name => $index) {
2698
+			$uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2699
+			if ($this->exists(array($uniqueness_where_params))) {
2700
+				EE_Error::add_error(
2701
+					sprintf(
2702
+						__(
2703
+							"Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2704
+							"event_espresso"
2705
+						),
2706
+						$action,
2707
+						$this->_get_class_name(),
2708
+						$index_name,
2709
+						implode(",", $index->field_names()),
2710
+						http_build_query($uniqueness_where_params)
2711
+					),
2712
+					__FILE__,
2713
+					__FUNCTION__,
2714
+					__LINE__
2715
+				);
2716
+				return false;
2717
+			}
2718
+		}
2719
+		return true;
2720
+	}
2721
+
2722
+
2723
+
2724
+	/**
2725
+	 * Checks the database for an item that conflicts (ie, if this item were
2726
+	 * saved to the DB would break some uniqueness requirement, like a primary key
2727
+	 * or an index primary key set) with the item specified. $id_obj_or_fields_array
2728
+	 * can be either an EE_Base_Class or an array of fields n values
2729
+	 *
2730
+	 * @param EE_Base_Class|array $obj_or_fields_array
2731
+	 * @param boolean             $include_primary_key whether to use the model object's primary key
2732
+	 *                                                 when looking for conflicts
2733
+	 *                                                 (ie, if false, we ignore the model object's primary key
2734
+	 *                                                 when finding "conflicts". If true, it's also considered).
2735
+	 *                                                 Only works for INT primary key,
2736
+	 *                                                 STRING primary keys cannot be ignored
2737
+	 * @throws EE_Error
2738
+	 * @return EE_Base_Class|array
2739
+	 */
2740
+	public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2741
+	{
2742
+		if ($obj_or_fields_array instanceof EE_Base_Class) {
2743
+			$fields_n_values = $obj_or_fields_array->model_field_array();
2744
+		} elseif (is_array($obj_or_fields_array)) {
2745
+			$fields_n_values = $obj_or_fields_array;
2746
+		} else {
2747
+			throw new EE_Error(
2748
+				sprintf(
2749
+					__(
2750
+						"%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2751
+						"event_espresso"
2752
+					),
2753
+					get_class($this),
2754
+					$obj_or_fields_array
2755
+				)
2756
+			);
2757
+		}
2758
+		$query_params = array();
2759
+		if ($this->has_primary_key_field()
2760
+			&& ($include_primary_key
2761
+				|| $this->get_primary_key_field()
2762
+				   instanceof
2763
+				   EE_Primary_Key_String_Field)
2764
+			&& isset($fields_n_values[$this->primary_key_name()])
2765
+		) {
2766
+			$query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2767
+		}
2768
+		foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2769
+			$uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2770
+			$query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2771
+		}
2772
+		//if there is nothing to base this search on, then we shouldn't find anything
2773
+		if (empty($query_params)) {
2774
+			return array();
2775
+		} else {
2776
+			return $this->get_one($query_params);
2777
+		}
2778
+	}
2779
+
2780
+
2781
+
2782
+	/**
2783
+	 * Like count, but is optimized and returns a boolean instead of an int
2784
+	 *
2785
+	 * @param array $query_params
2786
+	 * @return boolean
2787
+	 * @throws \EE_Error
2788
+	 */
2789
+	public function exists($query_params)
2790
+	{
2791
+		$query_params['limit'] = 1;
2792
+		return $this->count($query_params) > 0;
2793
+	}
2794
+
2795
+
2796
+
2797
+	/**
2798
+	 * Wrapper for exists, except ignores default query parameters so we're only considering ID
2799
+	 *
2800
+	 * @param int|string $id
2801
+	 * @return boolean
2802
+	 * @throws \EE_Error
2803
+	 */
2804
+	public function exists_by_ID($id)
2805
+	{
2806
+		return $this->exists(
2807
+			array(
2808
+				'default_where_conditions' => EEM_Base::default_where_conditions_none,
2809
+				array(
2810
+					$this->primary_key_name() => $id,
2811
+				),
2812
+			)
2813
+		);
2814
+	}
2815
+
2816
+
2817
+
2818
+	/**
2819
+	 * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2820
+	 * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2821
+	 * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2822
+	 * on the main table)
2823
+	 * This is protected rather than private because private is not accessible to any child methods and there MAY be
2824
+	 * cases where we want to call it directly rather than via insert().
2825
+	 *
2826
+	 * @access   protected
2827
+	 * @param EE_Table_Base $table
2828
+	 * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2829
+	 *                                       float
2830
+	 * @param int           $new_id          for now we assume only int keys
2831
+	 * @throws EE_Error
2832
+	 * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2833
+	 * @return int ID of new row inserted, or FALSE on failure
2834
+	 */
2835
+	protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2836
+	{
2837
+		global $wpdb;
2838
+		$insertion_col_n_values = array();
2839
+		$format_for_insertion = array();
2840
+		$fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2841
+		foreach ($fields_on_table as $field_name => $field_obj) {
2842
+			//check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2843
+			if ($field_obj->is_auto_increment()) {
2844
+				continue;
2845
+			}
2846
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2847
+			//if the value we want to assign it to is NULL, just don't mention it for the insertion
2848
+			if ($prepared_value !== null) {
2849
+				$insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2850
+				$format_for_insertion[] = $field_obj->get_wpdb_data_type();
2851
+			}
2852
+		}
2853
+		if ($table instanceof EE_Secondary_Table && $new_id) {
2854
+			//its not the main table, so we should have already saved the main table's PK which we just inserted
2855
+			//so add the fk to the main table as a column
2856
+			$insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2857
+			$format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2858
+		}
2859
+		//insert the new entry
2860
+		$result = $this->_do_wpdb_query('insert',
2861
+			array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2862
+		if ($result === false) {
2863
+			return false;
2864
+		}
2865
+		//ok, now what do we return for the ID of the newly-inserted thing?
2866
+		if ($this->has_primary_key_field()) {
2867
+			if ($this->get_primary_key_field()->is_auto_increment()) {
2868
+				return $wpdb->insert_id;
2869
+			} else {
2870
+				//it's not an auto-increment primary key, so
2871
+				//it must have been supplied
2872
+				return $fields_n_values[$this->get_primary_key_field()->get_name()];
2873
+			}
2874
+		} else {
2875
+			//we can't return a  primary key because there is none. instead return
2876
+			//a unique string indicating this model
2877
+			return $this->get_index_primary_key_string($fields_n_values);
2878
+		}
2879
+	}
2880
+
2881
+
2882
+
2883
+	/**
2884
+	 * Prepare the $field_obj 's value in $fields_n_values for use in the database.
2885
+	 * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
2886
+	 * and there is no default, we pass it along. WPDB will take care of it)
2887
+	 *
2888
+	 * @param EE_Model_Field_Base $field_obj
2889
+	 * @param array               $fields_n_values
2890
+	 * @return mixed string|int|float depending on what the table column will be expecting
2891
+	 * @throws \EE_Error
2892
+	 */
2893
+	protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
2894
+	{
2895
+		//if this field doesn't allow nullable, don't allow it
2896
+		if (! $field_obj->is_nullable()
2897
+			&& (
2898
+				! isset($fields_n_values[$field_obj->get_name()]) || $fields_n_values[$field_obj->get_name()] === null)
2899
+		) {
2900
+			$fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
2901
+		}
2902
+		$unprepared_value = isset($fields_n_values[$field_obj->get_name()]) ? $fields_n_values[$field_obj->get_name()]
2903
+			: null;
2904
+		return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
2905
+	}
2906
+
2907
+
2908
+
2909
+	/**
2910
+	 * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
2911
+	 * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
2912
+	 * the field's prepare_for_set() method.
2913
+	 *
2914
+	 * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
2915
+	 *                                   false, otherwise a value in the model object's domain (see lengthy comment at
2916
+	 *                                   top of file)
2917
+	 * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
2918
+	 *                                   $value is a custom selection
2919
+	 * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
2920
+	 */
2921
+	private function _prepare_value_for_use_in_db($value, $field)
2922
+	{
2923
+		if ($field && $field instanceof EE_Model_Field_Base) {
2924
+			switch ($this->_values_already_prepared_by_model_object) {
2925
+				/** @noinspection PhpMissingBreakStatementInspection */
2926
+				case self::not_prepared_by_model_object:
2927
+					$value = $field->prepare_for_set($value);
2928
+				//purposefully left out "return"
2929
+				case self::prepared_by_model_object:
2930
+					$value = $field->prepare_for_use_in_db($value);
2931
+				case self::prepared_for_use_in_db:
2932
+					//leave the value alone
2933
+			}
2934
+			return $value;
2935
+		} else {
2936
+			return $value;
2937
+		}
2938
+	}
2939
+
2940
+
2941
+
2942
+	/**
2943
+	 * Returns the main table on this model
2944
+	 *
2945
+	 * @return EE_Primary_Table
2946
+	 * @throws EE_Error
2947
+	 */
2948
+	protected function _get_main_table()
2949
+	{
2950
+		foreach ($this->_tables as $table) {
2951
+			if ($table instanceof EE_Primary_Table) {
2952
+				return $table;
2953
+			}
2954
+		}
2955
+		throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
2956
+			'event_espresso'), get_class($this)));
2957
+	}
2958
+
2959
+
2960
+
2961
+	/**
2962
+	 * table
2963
+	 * returns EE_Primary_Table table name
2964
+	 *
2965
+	 * @return string
2966
+	 * @throws \EE_Error
2967
+	 */
2968
+	public function table()
2969
+	{
2970
+		return $this->_get_main_table()->get_table_name();
2971
+	}
2972
+
2973
+
2974
+
2975
+	/**
2976
+	 * table
2977
+	 * returns first EE_Secondary_Table table name
2978
+	 *
2979
+	 * @return string
2980
+	 */
2981
+	public function second_table()
2982
+	{
2983
+		// grab second table from tables array
2984
+		$second_table = end($this->_tables);
2985
+		return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
2986
+	}
2987
+
2988
+
2989
+
2990
+	/**
2991
+	 * get_table_obj_by_alias
2992
+	 * returns table name given it's alias
2993
+	 *
2994
+	 * @param string $table_alias
2995
+	 * @return EE_Primary_Table | EE_Secondary_Table
2996
+	 */
2997
+	public function get_table_obj_by_alias($table_alias = '')
2998
+	{
2999
+		return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
3000
+	}
3001
+
3002
+
3003
+
3004
+	/**
3005
+	 * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
3006
+	 *
3007
+	 * @return EE_Secondary_Table[]
3008
+	 */
3009
+	protected function _get_other_tables()
3010
+	{
3011
+		$other_tables = array();
3012
+		foreach ($this->_tables as $table_alias => $table) {
3013
+			if ($table instanceof EE_Secondary_Table) {
3014
+				$other_tables[$table_alias] = $table;
3015
+			}
3016
+		}
3017
+		return $other_tables;
3018
+	}
3019
+
3020
+
3021
+
3022
+	/**
3023
+	 * Finds all the fields that correspond to the given table
3024
+	 *
3025
+	 * @param string $table_alias , array key in EEM_Base::_tables
3026
+	 * @return EE_Model_Field_Base[]
3027
+	 */
3028
+	public function _get_fields_for_table($table_alias)
3029
+	{
3030
+		return $this->_fields[$table_alias];
3031
+	}
3032
+
3033
+
3034
+
3035
+	/**
3036
+	 * Recurses through all the where parameters, and finds all the related models we'll need
3037
+	 * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
3038
+	 * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
3039
+	 * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
3040
+	 * related Registration, Transaction, and Payment models.
3041
+	 *
3042
+	 * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
3043
+	 * @return EE_Model_Query_Info_Carrier
3044
+	 * @throws \EE_Error
3045
+	 */
3046
+	public function _extract_related_models_from_query($query_params)
3047
+	{
3048
+		$query_info_carrier = new EE_Model_Query_Info_Carrier();
3049
+		if (array_key_exists(0, $query_params)) {
3050
+			$this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
3051
+		}
3052
+		if (array_key_exists('group_by', $query_params)) {
3053
+			if (is_array($query_params['group_by'])) {
3054
+				$this->_extract_related_models_from_sub_params_array_values(
3055
+					$query_params['group_by'],
3056
+					$query_info_carrier,
3057
+					'group_by'
3058
+				);
3059
+			} elseif (! empty ($query_params['group_by'])) {
3060
+				$this->_extract_related_model_info_from_query_param(
3061
+					$query_params['group_by'],
3062
+					$query_info_carrier,
3063
+					'group_by'
3064
+				);
3065
+			}
3066
+		}
3067
+		if (array_key_exists('having', $query_params)) {
3068
+			$this->_extract_related_models_from_sub_params_array_keys(
3069
+				$query_params[0],
3070
+				$query_info_carrier,
3071
+				'having'
3072
+			);
3073
+		}
3074
+		if (array_key_exists('order_by', $query_params)) {
3075
+			if (is_array($query_params['order_by'])) {
3076
+				$this->_extract_related_models_from_sub_params_array_keys(
3077
+					$query_params['order_by'],
3078
+					$query_info_carrier,
3079
+					'order_by'
3080
+				);
3081
+			} elseif (! empty($query_params['order_by'])) {
3082
+				$this->_extract_related_model_info_from_query_param(
3083
+					$query_params['order_by'],
3084
+					$query_info_carrier,
3085
+					'order_by'
3086
+				);
3087
+			}
3088
+		}
3089
+		if (array_key_exists('force_join', $query_params)) {
3090
+			$this->_extract_related_models_from_sub_params_array_values(
3091
+				$query_params['force_join'],
3092
+				$query_info_carrier,
3093
+				'force_join'
3094
+			);
3095
+		}
3096
+		return $query_info_carrier;
3097
+	}
3098
+
3099
+
3100
+
3101
+	/**
3102
+	 * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
3103
+	 *
3104
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3105
+	 *                                                      $query_params['having']
3106
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3107
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
3108
+	 * @throws EE_Error
3109
+	 * @return \EE_Model_Query_Info_Carrier
3110
+	 */
3111
+	private function _extract_related_models_from_sub_params_array_keys(
3112
+		$sub_query_params,
3113
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3114
+		$query_param_type
3115
+	) {
3116
+		if (! empty($sub_query_params)) {
3117
+			$sub_query_params = (array)$sub_query_params;
3118
+			foreach ($sub_query_params as $param => $possibly_array_of_params) {
3119
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3120
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3121
+					$query_param_type);
3122
+				//if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3123
+				//indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3124
+				//extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3125
+				//of array('Registration.TXN_ID'=>23)
3126
+				$query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3127
+				if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3128
+					if (! is_array($possibly_array_of_params)) {
3129
+						throw new EE_Error(sprintf(__("You used a special where query param %s, but the value isn't an array of where query params, it's just %s'. It should be an array, eg array('EVT_ID'=>23,'OR'=>array('Venue.VNU_ID'=>32,'Venue.VNU_name'=>'monkey_land'))",
3130
+							"event_espresso"),
3131
+							$param, $possibly_array_of_params));
3132
+					} else {
3133
+						$this->_extract_related_models_from_sub_params_array_keys($possibly_array_of_params,
3134
+							$model_query_info_carrier, $query_param_type);
3135
+					}
3136
+				} elseif ($query_param_type === 0 //ie WHERE
3137
+						  && is_array($possibly_array_of_params)
3138
+						  && isset($possibly_array_of_params[2])
3139
+						  && $possibly_array_of_params[2] == true
3140
+				) {
3141
+					//then $possible_array_of_params looks something like array('<','DTT_sold',true)
3142
+					//indicating that $possible_array_of_params[1] is actually a field name,
3143
+					//from which we should extract query parameters!
3144
+					if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3145
+						throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3146
+							"event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3147
+					}
3148
+					$this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3149
+						$model_query_info_carrier, $query_param_type);
3150
+				}
3151
+			}
3152
+		}
3153
+		return $model_query_info_carrier;
3154
+	}
3155
+
3156
+
3157
+
3158
+	/**
3159
+	 * For extracting related models from forced_joins, where the array values contain the info about what
3160
+	 * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3161
+	 *
3162
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3163
+	 *                                                      $query_params['having']
3164
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3165
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
3166
+	 * @throws EE_Error
3167
+	 * @return \EE_Model_Query_Info_Carrier
3168
+	 */
3169
+	private function _extract_related_models_from_sub_params_array_values(
3170
+		$sub_query_params,
3171
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3172
+		$query_param_type
3173
+	) {
3174
+		if (! empty($sub_query_params)) {
3175
+			if (! is_array($sub_query_params)) {
3176
+				throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3177
+					$sub_query_params));
3178
+			}
3179
+			foreach ($sub_query_params as $param) {
3180
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3181
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3182
+					$query_param_type);
3183
+			}
3184
+		}
3185
+		return $model_query_info_carrier;
3186
+	}
3187
+
3188
+
3189
+
3190
+	/**
3191
+	 * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3192
+	 * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3193
+	 * instead of directly constructing the SQL because often we need to extract info from the $query_params
3194
+	 * but use them in a different order. Eg, we need to know what models we are querying
3195
+	 * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3196
+	 * other models before we can finalize the where clause SQL.
3197
+	 *
3198
+	 * @param array $query_params
3199
+	 * @throws EE_Error
3200
+	 * @return EE_Model_Query_Info_Carrier
3201
+	 */
3202
+	public function _create_model_query_info_carrier($query_params)
3203
+	{
3204
+		if (! is_array($query_params)) {
3205
+			EE_Error::doing_it_wrong(
3206
+				'EEM_Base::_create_model_query_info_carrier',
3207
+				sprintf(
3208
+					__(
3209
+						'$query_params should be an array, you passed a variable of type %s',
3210
+						'event_espresso'
3211
+					),
3212
+					gettype($query_params)
3213
+				),
3214
+				'4.6.0'
3215
+			);
3216
+			$query_params = array();
3217
+		}
3218
+		$where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3219
+		//first check if we should alter the query to account for caps or not
3220
+		//because the caps might require us to do extra joins
3221
+		if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3222
+			$query_params[0] = $where_query_params = array_replace_recursive(
3223
+				$where_query_params,
3224
+				$this->caps_where_conditions(
3225
+					$query_params['caps']
3226
+				)
3227
+			);
3228
+		}
3229
+		$query_object = $this->_extract_related_models_from_query($query_params);
3230
+		//verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3231
+		foreach ($where_query_params as $key => $value) {
3232
+			if (is_int($key)) {
3233
+				throw new EE_Error(
3234
+					sprintf(
3235
+						__(
3236
+							"WHERE query params must NOT be numerically-indexed. You provided the array key '%s' for value '%s' while querying model %s. All the query params provided were '%s' Please read documentation on EEM_Base::get_all.",
3237
+							"event_espresso"
3238
+						),
3239
+						$key,
3240
+						var_export($value, true),
3241
+						var_export($query_params, true),
3242
+						get_class($this)
3243
+					)
3244
+				);
3245
+			}
3246
+		}
3247
+		if (
3248
+			array_key_exists('default_where_conditions', $query_params)
3249
+			&& ! empty($query_params['default_where_conditions'])
3250
+		) {
3251
+			$use_default_where_conditions = $query_params['default_where_conditions'];
3252
+		} else {
3253
+			$use_default_where_conditions = EEM_Base::default_where_conditions_all;
3254
+		}
3255
+		$where_query_params = array_merge(
3256
+			$this->_get_default_where_conditions_for_models_in_query(
3257
+				$query_object,
3258
+				$use_default_where_conditions,
3259
+				$where_query_params
3260
+			),
3261
+			$where_query_params
3262
+		);
3263
+		$query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3264
+		// if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3265
+		// So we need to setup a subquery and use that for the main join.
3266
+		// Note for now this only works on the primary table for the model.
3267
+		// So for instance, you could set the limit array like this:
3268
+		// array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3269
+		if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3270
+			$query_object->set_main_model_join_sql(
3271
+				$this->_construct_limit_join_select(
3272
+					$query_params['on_join_limit'][0],
3273
+					$query_params['on_join_limit'][1]
3274
+				)
3275
+			);
3276
+		}
3277
+		//set limit
3278
+		if (array_key_exists('limit', $query_params)) {
3279
+			if (is_array($query_params['limit'])) {
3280
+				if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3281
+					$e = sprintf(
3282
+						__(
3283
+							"Invalid DB query. You passed '%s' for the LIMIT, but only the following are valid: an integer, string representing an integer, a string like 'int,int', or an array like array(int,int)",
3284
+							"event_espresso"
3285
+						),
3286
+						http_build_query($query_params['limit'])
3287
+					);
3288
+					throw new EE_Error($e . "|" . $e);
3289
+				}
3290
+				//they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3291
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3292
+			} elseif (! empty ($query_params['limit'])) {
3293
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3294
+			}
3295
+		}
3296
+		//set order by
3297
+		if (array_key_exists('order_by', $query_params)) {
3298
+			if (is_array($query_params['order_by'])) {
3299
+				//if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3300
+				//specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3301
+				//including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3302
+				if (array_key_exists('order', $query_params)) {
3303
+					throw new EE_Error(
3304
+						sprintf(
3305
+							__(
3306
+								"In querying %s, we are using query parameter 'order_by' as an array (keys:%s,values:%s), and so we can't use query parameter 'order' (value %s). You should just use the 'order_by' parameter ",
3307
+								"event_espresso"
3308
+							),
3309
+							get_class($this),
3310
+							implode(", ", array_keys($query_params['order_by'])),
3311
+							implode(", ", $query_params['order_by']),
3312
+							$query_params['order']
3313
+						)
3314
+					);
3315
+				}
3316
+				$this->_extract_related_models_from_sub_params_array_keys(
3317
+					$query_params['order_by'],
3318
+					$query_object,
3319
+					'order_by'
3320
+				);
3321
+				//assume it's an array of fields to order by
3322
+				$order_array = array();
3323
+				foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3324
+					$order = $this->_extract_order($order);
3325
+					$order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3326
+				}
3327
+				$query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3328
+			} elseif (! empty ($query_params['order_by'])) {
3329
+				$this->_extract_related_model_info_from_query_param(
3330
+					$query_params['order_by'],
3331
+					$query_object,
3332
+					'order',
3333
+					$query_params['order_by']
3334
+				);
3335
+				$order = isset($query_params['order'])
3336
+					? $this->_extract_order($query_params['order'])
3337
+					: 'DESC';
3338
+				$query_object->set_order_by_sql(
3339
+					" ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3340
+				);
3341
+			}
3342
+		}
3343
+		//if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3344
+		if (! array_key_exists('order_by', $query_params)
3345
+			&& array_key_exists('order', $query_params)
3346
+			&& ! empty($query_params['order'])
3347
+		) {
3348
+			$pk_field = $this->get_primary_key_field();
3349
+			$order = $this->_extract_order($query_params['order']);
3350
+			$query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3351
+		}
3352
+		//set group by
3353
+		if (array_key_exists('group_by', $query_params)) {
3354
+			if (is_array($query_params['group_by'])) {
3355
+				//it's an array, so assume we'll be grouping by a bunch of stuff
3356
+				$group_by_array = array();
3357
+				foreach ($query_params['group_by'] as $field_name_to_group_by) {
3358
+					$group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3359
+				}
3360
+				$query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3361
+			} elseif (! empty ($query_params['group_by'])) {
3362
+				$query_object->set_group_by_sql(
3363
+					" GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3364
+				);
3365
+			}
3366
+		}
3367
+		//set having
3368
+		if (array_key_exists('having', $query_params) && $query_params['having']) {
3369
+			$query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3370
+		}
3371
+		//now, just verify they didn't pass anything wack
3372
+		foreach ($query_params as $query_key => $query_value) {
3373
+			if (! in_array($query_key, $this->_allowed_query_params, true)) {
3374
+				throw new EE_Error(
3375
+					sprintf(
3376
+						__(
3377
+							"You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3378
+							'event_espresso'
3379
+						),
3380
+						$query_key,
3381
+						get_class($this),
3382
+						//						print_r( $this->_allowed_query_params, TRUE )
3383
+						implode(',', $this->_allowed_query_params)
3384
+					)
3385
+				);
3386
+			}
3387
+		}
3388
+		$main_model_join_sql = $query_object->get_main_model_join_sql();
3389
+		if (empty($main_model_join_sql)) {
3390
+			$query_object->set_main_model_join_sql($this->_construct_internal_join());
3391
+		}
3392
+		return $query_object;
3393
+	}
3394
+
3395
+
3396
+
3397
+	/**
3398
+	 * Gets the where conditions that should be imposed on the query based on the
3399
+	 * context (eg reading frontend, backend, edit or delete).
3400
+	 *
3401
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
3402
+	 * @return array like EEM_Base::get_all() 's $query_params[0]
3403
+	 * @throws \EE_Error
3404
+	 */
3405
+	public function caps_where_conditions($context = self::caps_read)
3406
+	{
3407
+		EEM_Base::verify_is_valid_cap_context($context);
3408
+		$cap_where_conditions = array();
3409
+		$cap_restrictions = $this->caps_missing($context);
3410
+		/**
3411
+		 * @var $cap_restrictions EE_Default_Where_Conditions[]
3412
+		 */
3413
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3414
+			$cap_where_conditions = array_replace_recursive($cap_where_conditions,
3415
+				$restriction_if_no_cap->get_default_where_conditions());
3416
+		}
3417
+		return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3418
+			$cap_restrictions);
3419
+	}
3420
+
3421
+
3422
+
3423
+	/**
3424
+	 * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3425
+	 * otherwise throws an exception
3426
+	 *
3427
+	 * @param string $should_be_order_string
3428
+	 * @return string either ASC, asc, DESC or desc
3429
+	 * @throws EE_Error
3430
+	 */
3431
+	private function _extract_order($should_be_order_string)
3432
+	{
3433
+		if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3434
+			return $should_be_order_string;
3435
+		} else {
3436
+			throw new EE_Error(sprintf(__("While performing a query on '%s', tried to use '%s' as an order parameter. ",
3437
+				"event_espresso"), get_class($this), $should_be_order_string));
3438
+		}
3439
+	}
3440
+
3441
+
3442
+
3443
+	/**
3444
+	 * Looks at all the models which are included in this query, and asks each
3445
+	 * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3446
+	 * so they can be merged
3447
+	 *
3448
+	 * @param EE_Model_Query_Info_Carrier $query_info_carrier
3449
+	 * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3450
+	 *                                                                  'none' means NO default where conditions will
3451
+	 *                                                                  be used AT ALL during this query.
3452
+	 *                                                                  'other_models_only' means default where
3453
+	 *                                                                  conditions from other models will be used, but
3454
+	 *                                                                  not for this primary model. 'all', the default,
3455
+	 *                                                                  means default where conditions will apply as
3456
+	 *                                                                  normal
3457
+	 * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3458
+	 * @throws EE_Error
3459
+	 * @return array like $query_params[0], see EEM_Base::get_all for documentation
3460
+	 */
3461
+	private function _get_default_where_conditions_for_models_in_query(
3462
+		EE_Model_Query_Info_Carrier $query_info_carrier,
3463
+		$use_default_where_conditions = EEM_Base::default_where_conditions_all,
3464
+		$where_query_params = array()
3465
+	) {
3466
+		$allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3467
+		if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3468
+			throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3469
+				"event_espresso"), $use_default_where_conditions,
3470
+				implode(", ", $allowed_used_default_where_conditions_values)));
3471
+		}
3472
+		$universal_query_params = array();
3473
+		if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3474
+			$universal_query_params = $this->_get_default_where_conditions();
3475
+		} else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3476
+			$universal_query_params = $this->_get_minimum_where_conditions();
3477
+		}
3478
+		foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3479
+			$related_model = $this->get_related_model_obj($model_name);
3480
+			if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3481
+				$related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3482
+			} elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3483
+				$related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3484
+			} else {
3485
+				//we don't want to add full or even minimum default where conditions from this model, so just continue
3486
+				continue;
3487
+			}
3488
+			$overrides = $this->_override_defaults_or_make_null_friendly(
3489
+				$related_model_universal_where_params,
3490
+				$where_query_params,
3491
+				$related_model,
3492
+				$model_relation_path
3493
+			);
3494
+			$universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3495
+				$universal_query_params,
3496
+				$overrides
3497
+			);
3498
+		}
3499
+		return $universal_query_params;
3500
+	}
3501
+
3502
+
3503
+
3504
+	/**
3505
+	 * Determines whether or not we should use default where conditions for the model in question
3506
+	 * (this model, or other related models).
3507
+	 * Basically, we should use default where conditions on this model if they have requested to use them on all models,
3508
+	 * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3509
+	 * We should use default where conditions on related models when they requested to use default where conditions
3510
+	 * on all models, or specifically just on other related models
3511
+	 * @param      $default_where_conditions_value
3512
+	 * @param bool $for_this_model false means this is for OTHER related models
3513
+	 * @return bool
3514
+	 */
3515
+	private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3516
+	{
3517
+		return (
3518
+				   $for_this_model
3519
+				   && in_array(
3520
+					   $default_where_conditions_value,
3521
+					   array(
3522
+						   EEM_Base::default_where_conditions_all,
3523
+						   EEM_Base::default_where_conditions_this_only,
3524
+						   EEM_Base::default_where_conditions_minimum_others,
3525
+					   ),
3526
+					   true
3527
+				   )
3528
+			   )
3529
+			   || (
3530
+				   ! $for_this_model
3531
+				   && in_array(
3532
+					   $default_where_conditions_value,
3533
+					   array(
3534
+						   EEM_Base::default_where_conditions_all,
3535
+						   EEM_Base::default_where_conditions_others_only,
3536
+					   ),
3537
+					   true
3538
+				   )
3539
+			   );
3540
+	}
3541
+
3542
+	/**
3543
+	 * Determines whether or not we should use default minimum conditions for the model in question
3544
+	 * (this model, or other related models).
3545
+	 * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
3546
+	 * where conditions.
3547
+	 * We should use minimum where conditions on related models if they requested to use minimum where conditions
3548
+	 * on this model or others
3549
+	 * @param      $default_where_conditions_value
3550
+	 * @param bool $for_this_model false means this is for OTHER related models
3551
+	 * @return bool
3552
+	 */
3553
+	private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
3554
+	{
3555
+		return (
3556
+				   $for_this_model
3557
+				   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
3558
+			   )
3559
+			   || (
3560
+				   ! $for_this_model
3561
+				   && in_array(
3562
+					   $default_where_conditions_value,
3563
+					   array(
3564
+						   EEM_Base::default_where_conditions_minimum_others,
3565
+						   EEM_Base::default_where_conditions_minimum_all,
3566
+					   ),
3567
+					   true
3568
+				   )
3569
+			   );
3570
+	}
3571
+
3572
+
3573
+	/**
3574
+	 * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3575
+	 * then we also add a special where condition which allows for that model's primary key
3576
+	 * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3577
+	 * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3578
+	 *
3579
+	 * @param array    $default_where_conditions
3580
+	 * @param array    $provided_where_conditions
3581
+	 * @param EEM_Base $model
3582
+	 * @param string   $model_relation_path like 'Transaction.Payment.'
3583
+	 * @return array like EEM_Base::get_all's $query_params[0]
3584
+	 * @throws \EE_Error
3585
+	 */
3586
+	private function _override_defaults_or_make_null_friendly(
3587
+		$default_where_conditions,
3588
+		$provided_where_conditions,
3589
+		$model,
3590
+		$model_relation_path
3591
+	) {
3592
+		$null_friendly_where_conditions = array();
3593
+		$none_overridden = true;
3594
+		$or_condition_key_for_defaults = 'OR*' . get_class($model);
3595
+		foreach ($default_where_conditions as $key => $val) {
3596
+			if (isset($provided_where_conditions[$key])) {
3597
+				$none_overridden = false;
3598
+			} else {
3599
+				$null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3600
+			}
3601
+		}
3602
+		if ($none_overridden && $default_where_conditions) {
3603
+			if ($model->has_primary_key_field()) {
3604
+				$null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3605
+																				. "."
3606
+																				. $model->primary_key_name()] = array('IS NULL');
3607
+			}/*else{
3608 3608
 				//@todo NO PK, use other defaults
3609 3609
 			}*/
3610
-        }
3611
-        return $null_friendly_where_conditions;
3612
-    }
3613
-
3614
-
3615
-
3616
-    /**
3617
-     * Uses the _default_where_conditions_strategy set during __construct() to get
3618
-     * default where conditions on all get_all, update, and delete queries done by this model.
3619
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3620
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3621
-     *
3622
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3623
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3624
-     */
3625
-    private function _get_default_where_conditions($model_relation_path = null)
3626
-    {
3627
-        if ($this->_ignore_where_strategy) {
3628
-            return array();
3629
-        }
3630
-        return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3631
-    }
3632
-
3633
-
3634
-
3635
-    /**
3636
-     * Uses the _minimum_where_conditions_strategy set during __construct() to get
3637
-     * minimum where conditions on all get_all, update, and delete queries done by this model.
3638
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3639
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3640
-     * Similar to _get_default_where_conditions
3641
-     *
3642
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3643
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3644
-     */
3645
-    protected function _get_minimum_where_conditions($model_relation_path = null)
3646
-    {
3647
-        if ($this->_ignore_where_strategy) {
3648
-            return array();
3649
-        }
3650
-        return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3651
-    }
3652
-
3653
-
3654
-
3655
-    /**
3656
-     * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3657
-     * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3658
-     *
3659
-     * @param EE_Model_Query_Info_Carrier $model_query_info
3660
-     * @return string
3661
-     * @throws \EE_Error
3662
-     */
3663
-    private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3664
-    {
3665
-        $selects = $this->_get_columns_to_select_for_this_model();
3666
-        foreach (
3667
-            $model_query_info->get_model_names_included() as $model_relation_chain =>
3668
-            $name_of_other_model_included
3669
-        ) {
3670
-            $other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3671
-            $other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3672
-            foreach ($other_model_selects as $key => $value) {
3673
-                $selects[] = $value;
3674
-            }
3675
-        }
3676
-        return implode(", ", $selects);
3677
-    }
3678
-
3679
-
3680
-
3681
-    /**
3682
-     * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3683
-     * So that's going to be the columns for all the fields on the model
3684
-     *
3685
-     * @param string $model_relation_chain like 'Question.Question_Group.Event'
3686
-     * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3687
-     */
3688
-    public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3689
-    {
3690
-        $fields = $this->field_settings();
3691
-        $selects = array();
3692
-        $table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3693
-            $this->get_this_model_name());
3694
-        foreach ($fields as $field_obj) {
3695
-            $selects[] = $table_alias_with_model_relation_chain_prefix
3696
-                         . $field_obj->get_table_alias()
3697
-                         . "."
3698
-                         . $field_obj->get_table_column()
3699
-                         . " AS '"
3700
-                         . $table_alias_with_model_relation_chain_prefix
3701
-                         . $field_obj->get_table_alias()
3702
-                         . "."
3703
-                         . $field_obj->get_table_column()
3704
-                         . "'";
3705
-        }
3706
-        //make sure we are also getting the PKs of each table
3707
-        $tables = $this->get_tables();
3708
-        if (count($tables) > 1) {
3709
-            foreach ($tables as $table_obj) {
3710
-                $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3711
-                                       . $table_obj->get_fully_qualified_pk_column();
3712
-                if (! in_array($qualified_pk_column, $selects)) {
3713
-                    $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3714
-                }
3715
-            }
3716
-        }
3717
-        return $selects;
3718
-    }
3719
-
3720
-
3721
-
3722
-    /**
3723
-     * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3724
-     * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3725
-     * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3726
-     * SQL for joining, and the data types
3727
-     *
3728
-     * @param null|string                 $original_query_param
3729
-     * @param string                      $query_param          like Registration.Transaction.TXN_ID
3730
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3731
-     * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3732
-     *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3733
-     *                                                          column name. We only want model names, eg 'Event.Venue'
3734
-     *                                                          or 'Registration's
3735
-     * @param string                      $original_query_param what it originally was (eg
3736
-     *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3737
-     *                                                          matches $query_param
3738
-     * @throws EE_Error
3739
-     * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3740
-     */
3741
-    private function _extract_related_model_info_from_query_param(
3742
-        $query_param,
3743
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3744
-        $query_param_type,
3745
-        $original_query_param = null
3746
-    ) {
3747
-        if ($original_query_param === null) {
3748
-            $original_query_param = $query_param;
3749
-        }
3750
-        $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3751
-        /** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3752
-        $allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3753
-        $allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3754
-        //check to see if we have a field on this model
3755
-        $this_model_fields = $this->field_settings(true);
3756
-        if (array_key_exists($query_param, $this_model_fields)) {
3757
-            if ($allow_fields) {
3758
-                return;
3759
-            } else {
3760
-                throw new EE_Error(sprintf(__("Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
3761
-                    "event_espresso"),
3762
-                    $query_param, get_class($this), $query_param_type, $original_query_param));
3763
-            }
3764
-        } //check if this is a special logic query param
3765
-        elseif (in_array($query_param, $this->_logic_query_param_keys, true)) {
3766
-            if ($allow_logic_query_params) {
3767
-                return;
3768
-            } else {
3769
-                throw new EE_Error(
3770
-                    sprintf(
3771
-                        __('Logic query params ("%1$s") are being used incorrectly with the following query param ("%2$s") on model %3$s. %4$sAdditional Info:%4$s%5$s',
3772
-                            'event_espresso'),
3773
-                        implode('", "', $this->_logic_query_param_keys),
3774
-                        $query_param,
3775
-                        get_class($this),
3776
-                        '<br />',
3777
-                        "\t"
3778
-                        . ' $passed_in_query_info = <pre>'
3779
-                        . print_r($passed_in_query_info, true)
3780
-                        . '</pre>'
3781
-                        . "\n\t"
3782
-                        . ' $query_param_type = '
3783
-                        . $query_param_type
3784
-                        . "\n\t"
3785
-                        . ' $original_query_param = '
3786
-                        . $original_query_param
3787
-                    )
3788
-                );
3789
-            }
3790
-        } //check if it's a custom selection
3791
-        elseif (array_key_exists($query_param, $this->_custom_selections)) {
3792
-            return;
3793
-        }
3794
-        //check if has a model name at the beginning
3795
-        //and
3796
-        //check if it's a field on a related model
3797
-        foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3798
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3799
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3800
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
3801
-                if ($query_param === '') {
3802
-                    //nothing left to $query_param
3803
-                    //we should actually end in a field name, not a model like this!
3804
-                    throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3805
-                        "event_espresso"),
3806
-                        $query_param, $query_param_type, get_class($this), $valid_related_model_name));
3807
-                } else {
3808
-                    $related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3809
-                    $related_model_obj->_extract_related_model_info_from_query_param($query_param,
3810
-                        $passed_in_query_info, $query_param_type, $original_query_param);
3811
-                    return;
3812
-                }
3813
-            } elseif ($query_param === $valid_related_model_name) {
3814
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3815
-                return;
3816
-            }
3817
-        }
3818
-        //ok so $query_param didn't start with a model name
3819
-        //and we previously confirmed it wasn't a logic query param or field on the current model
3820
-        //it's wack, that's what it is
3821
-        throw new EE_Error(sprintf(__("There is no model named '%s' related to %s. Query param type is %s and original query param is %s",
3822
-            "event_espresso"),
3823
-            $query_param, get_class($this), $query_param_type, $original_query_param));
3824
-    }
3825
-
3826
-
3827
-
3828
-    /**
3829
-     * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3830
-     * and store it on $passed_in_query_info
3831
-     *
3832
-     * @param string                      $model_name
3833
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3834
-     * @param string                      $original_query_param used to extract the relation chain between the queried
3835
-     *                                                          model and $model_name. Eg, if we are querying Event,
3836
-     *                                                          and are adding a join to 'Payment' with the original
3837
-     *                                                          query param key
3838
-     *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3839
-     *                                                          to extract 'Registration.Transaction.Payment', in case
3840
-     *                                                          Payment wants to add default query params so that it
3841
-     *                                                          will know what models to prepend onto its default query
3842
-     *                                                          params or in case it wants to rename tables (in case
3843
-     *                                                          there are multiple joins to the same table)
3844
-     * @return void
3845
-     * @throws \EE_Error
3846
-     */
3847
-    private function _add_join_to_model(
3848
-        $model_name,
3849
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3850
-        $original_query_param
3851
-    ) {
3852
-        $relation_obj = $this->related_settings_for($model_name);
3853
-        $model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3854
-        //check if the relation is HABTM, because then we're essentially doing two joins
3855
-        //If so, join first to the JOIN table, and add its data types, and then continue as normal
3856
-        if ($relation_obj instanceof EE_HABTM_Relation) {
3857
-            $join_model_obj = $relation_obj->get_join_model();
3858
-            //replace the model specified with the join model for this relation chain, whi
3859
-            $relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
3860
-                $join_model_obj->get_this_model_name(), $model_relation_chain);
3861
-            $new_query_info = new EE_Model_Query_Info_Carrier(
3862
-                array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
3863
-                $relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model));
3864
-            $passed_in_query_info->merge($new_query_info);
3865
-        }
3866
-        //now just join to the other table pointed to by the relation object, and add its data types
3867
-        $new_query_info = new EE_Model_Query_Info_Carrier(
3868
-            array($model_relation_chain => $model_name),
3869
-            $relation_obj->get_join_statement($model_relation_chain));
3870
-        $passed_in_query_info->merge($new_query_info);
3871
-    }
3872
-
3873
-
3874
-
3875
-    /**
3876
-     * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
3877
-     *
3878
-     * @param array $where_params like EEM_Base::get_all
3879
-     * @return string of SQL
3880
-     * @throws \EE_Error
3881
-     */
3882
-    private function _construct_where_clause($where_params)
3883
-    {
3884
-        $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
3885
-        if ($SQL) {
3886
-            return " WHERE " . $SQL;
3887
-        } else {
3888
-            return '';
3889
-        }
3890
-    }
3891
-
3892
-
3893
-
3894
-    /**
3895
-     * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
3896
-     * and should be passed HAVING parameters, not WHERE parameters
3897
-     *
3898
-     * @param array $having_params
3899
-     * @return string
3900
-     * @throws \EE_Error
3901
-     */
3902
-    private function _construct_having_clause($having_params)
3903
-    {
3904
-        $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
3905
-        if ($SQL) {
3906
-            return " HAVING " . $SQL;
3907
-        } else {
3908
-            return '';
3909
-        }
3910
-    }
3911
-
3912
-
3913
-
3914
-    /**
3915
-     * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
3916
-     * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
3917
-     * EEM_Attendee.
3918
-     *
3919
-     * @param string $field_name
3920
-     * @param string $model_name
3921
-     * @return EE_Model_Field_Base
3922
-     * @throws EE_Error
3923
-     */
3924
-    protected function _get_field_on_model($field_name, $model_name)
3925
-    {
3926
-        $model_class = 'EEM_' . $model_name;
3927
-        $model_filepath = $model_class . ".model.php";
3928
-        if (is_readable($model_filepath)) {
3929
-            require_once($model_filepath);
3930
-            $model_instance = call_user_func($model_name . "::instance");
3931
-            /* @var $model_instance EEM_Base */
3932
-            return $model_instance->field_settings_for($field_name);
3933
-        } else {
3934
-            throw new EE_Error(sprintf(__('No model named %s exists, with classname %s and filepath %s',
3935
-                'event_espresso'), $model_name, $model_class, $model_filepath));
3936
-        }
3937
-    }
3938
-
3939
-
3940
-
3941
-    /**
3942
-     * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
3943
-     * Event_Meta.meta_value = 'foo'))"
3944
-     *
3945
-     * @param array  $where_params see EEM_Base::get_all for documentation
3946
-     * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
3947
-     * @throws EE_Error
3948
-     * @return string of SQL
3949
-     */
3950
-    private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
3951
-    {
3952
-        $where_clauses = array();
3953
-        foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
3954
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
3955
-            if (in_array($query_param, $this->_logic_query_param_keys)) {
3956
-                switch ($query_param) {
3957
-                    case 'not':
3958
-                    case 'NOT':
3959
-                        $where_clauses[] = "! ("
3960
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3961
-                                $glue)
3962
-                                           . ")";
3963
-                        break;
3964
-                    case 'and':
3965
-                    case 'AND':
3966
-                        $where_clauses[] = " ("
3967
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3968
-                                ' AND ')
3969
-                                           . ")";
3970
-                        break;
3971
-                    case 'or':
3972
-                    case 'OR':
3973
-                        $where_clauses[] = " ("
3974
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3975
-                                ' OR ')
3976
-                                           . ")";
3977
-                        break;
3978
-                }
3979
-            } else {
3980
-                $field_obj = $this->_deduce_field_from_query_param($query_param);
3981
-                //if it's not a normal field, maybe it's a custom selection?
3982
-                if (! $field_obj) {
3983
-                    if (isset($this->_custom_selections[$query_param][1])) {
3984
-                        $field_obj = $this->_custom_selections[$query_param][1];
3985
-                    } else {
3986
-                        throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
3987
-                            "event_espresso"), $query_param));
3988
-                    }
3989
-                }
3990
-                $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
3991
-                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
3992
-            }
3993
-        }
3994
-        return $where_clauses ? implode($glue, $where_clauses) : '';
3995
-    }
3996
-
3997
-
3998
-
3999
-    /**
4000
-     * Takes the input parameter and extract the table name (alias) and column name
4001
-     *
4002
-     * @param array $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4003
-     * @throws EE_Error
4004
-     * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
4005
-     */
4006
-    private function _deduce_column_name_from_query_param($query_param)
4007
-    {
4008
-        $field = $this->_deduce_field_from_query_param($query_param);
4009
-        if ($field) {
4010
-            $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4011
-                $query_param);
4012
-            return $table_alias_prefix . $field->get_qualified_column();
4013
-        } elseif (array_key_exists($query_param, $this->_custom_selections)) {
4014
-            //maybe it's custom selection item?
4015
-            //if so, just use it as the "column name"
4016
-            return $query_param;
4017
-        } else {
4018
-            throw new EE_Error(sprintf(__("%s is not a valid field on this model, nor a custom selection (%s)",
4019
-                "event_espresso"), $query_param, implode(",", $this->_custom_selections)));
4020
-        }
4021
-    }
4022
-
4023
-
4024
-
4025
-    /**
4026
-     * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
4027
-     * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
4028
-     * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
4029
-     * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
4030
-     *
4031
-     * @param string $condition_query_param_key
4032
-     * @return string
4033
-     */
4034
-    private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
4035
-    {
4036
-        $pos_of_star = strpos($condition_query_param_key, '*');
4037
-        if ($pos_of_star === false) {
4038
-            return $condition_query_param_key;
4039
-        } else {
4040
-            $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
4041
-            return $condition_query_param_sans_star;
4042
-        }
4043
-    }
4044
-
4045
-
4046
-
4047
-    /**
4048
-     * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
4049
-     *
4050
-     * @param                            mixed      array | string    $op_and_value
4051
-     * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
4052
-     * @throws EE_Error
4053
-     * @return string
4054
-     */
4055
-    private function _construct_op_and_value($op_and_value, $field_obj)
4056
-    {
4057
-        if (is_array($op_and_value)) {
4058
-            $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4059
-            if (! $operator) {
4060
-                $php_array_like_string = array();
4061
-                foreach ($op_and_value as $key => $value) {
4062
-                    $php_array_like_string[] = "$key=>$value";
4063
-                }
4064
-                throw new EE_Error(
4065
-                    sprintf(
4066
-                        __(
4067
-                            "You setup a query parameter like you were going to specify an operator, but didn't. You provided '(%s)', but the operator should be at array key index 0 (eg array('>',32))",
4068
-                            "event_espresso"
4069
-                        ),
4070
-                        implode(",", $php_array_like_string)
4071
-                    )
4072
-                );
4073
-            }
4074
-            $value = isset($op_and_value[1]) ? $op_and_value[1] : null;
4075
-        } else {
4076
-            $operator = '=';
4077
-            $value = $op_and_value;
4078
-        }
4079
-        //check to see if the value is actually another field
4080
-        if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4081
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4082
-        } elseif (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4083
-            //in this case, the value should be an array, or at least a comma-separated list
4084
-            //it will need to handle a little differently
4085
-            $cleaned_value = $this->_construct_in_value($value, $field_obj);
4086
-            //note: $cleaned_value has already been run through $wpdb->prepare()
4087
-            return $operator . SP . $cleaned_value;
4088
-        } elseif (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4089
-            //the value should be an array with count of two.
4090
-            if (count($value) !== 2) {
4091
-                throw new EE_Error(
4092
-                    sprintf(
4093
-                        __(
4094
-                            "The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
4095
-                            'event_espresso'
4096
-                        ),
4097
-                        "BETWEEN"
4098
-                    )
4099
-                );
4100
-            }
4101
-            $cleaned_value = $this->_construct_between_value($value, $field_obj);
4102
-            return $operator . SP . $cleaned_value;
4103
-        } elseif (in_array($operator, $this->_null_style_operators)) {
4104
-            if ($value !== null) {
4105
-                throw new EE_Error(
4106
-                    sprintf(
4107
-                        __(
4108
-                            "You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
4109
-                            "event_espresso"
4110
-                        ),
4111
-                        $value,
4112
-                        $operator
4113
-                    )
4114
-                );
4115
-            }
4116
-            return $operator;
4117
-        } elseif ($operator === 'LIKE' && ! is_array($value)) {
4118
-            //if the operator is 'LIKE', we want to allow percent signs (%) and not
4119
-            //remove other junk. So just treat it as a string.
4120
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4121
-        } elseif (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4122
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4123
-        } elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4124
-            throw new EE_Error(
4125
-                sprintf(
4126
-                    __(
4127
-                        "Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
4128
-                        'event_espresso'
4129
-                    ),
4130
-                    $operator,
4131
-                    $operator
4132
-                )
4133
-            );
4134
-        } elseif (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4135
-            throw new EE_Error(
4136
-                sprintf(
4137
-                    __(
4138
-                        "Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
4139
-                        'event_espresso'
4140
-                    ),
4141
-                    $operator,
4142
-                    $operator
4143
-                )
4144
-            );
4145
-        } else {
4146
-            throw new EE_Error(
4147
-                sprintf(
4148
-                    __(
4149
-                        "It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
4150
-                        "event_espresso"
4151
-                    ),
4152
-                    http_build_query($op_and_value)
4153
-                )
4154
-            );
4155
-        }
4156
-    }
4157
-
4158
-
4159
-
4160
-    /**
4161
-     * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
4162
-     *
4163
-     * @param array                      $values
4164
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
4165
-     *                                              '%s'
4166
-     * @return string
4167
-     * @throws \EE_Error
4168
-     */
4169
-    public function _construct_between_value($values, $field_obj)
4170
-    {
4171
-        $cleaned_values = array();
4172
-        foreach ($values as $value) {
4173
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4174
-        }
4175
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
4176
-    }
4177
-
4178
-
4179
-
4180
-    /**
4181
-     * Takes an array or a comma-separated list of $values and cleans them
4182
-     * according to $data_type using $wpdb->prepare, and then makes the list a
4183
-     * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4184
-     * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4185
-     * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4186
-     *
4187
-     * @param mixed                      $values    array or comma-separated string
4188
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4189
-     * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4190
-     * @throws \EE_Error
4191
-     */
4192
-    public function _construct_in_value($values, $field_obj)
4193
-    {
4194
-        //check if the value is a CSV list
4195
-        if (is_string($values)) {
4196
-            //in which case, turn it into an array
4197
-            $values = explode(",", $values);
4198
-        }
4199
-        $cleaned_values = array();
4200
-        foreach ($values as $value) {
4201
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4202
-        }
4203
-        //we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4204
-        //but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4205
-        //which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4206
-        if (empty($cleaned_values)) {
4207
-            $all_fields = $this->field_settings();
4208
-            $a_field = array_shift($all_fields);
4209
-            $main_table = $this->_get_main_table();
4210
-            $cleaned_values[] = "SELECT "
4211
-                                . $a_field->get_table_column()
4212
-                                . " FROM "
4213
-                                . $main_table->get_table_name()
4214
-                                . " WHERE FALSE";
4215
-        }
4216
-        return "(" . implode(",", $cleaned_values) . ")";
4217
-    }
4218
-
4219
-
4220
-
4221
-    /**
4222
-     * @param mixed                      $value
4223
-     * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4224
-     * @throws EE_Error
4225
-     * @return false|null|string
4226
-     */
4227
-    private function _wpdb_prepare_using_field($value, $field_obj)
4228
-    {
4229
-        /** @type WPDB $wpdb */
4230
-        global $wpdb;
4231
-        if ($field_obj instanceof EE_Model_Field_Base) {
4232
-            return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4233
-                $this->_prepare_value_for_use_in_db($value, $field_obj));
4234
-        } else {//$field_obj should really just be a data type
4235
-            if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4236
-                throw new EE_Error(sprintf(__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4237
-                    $field_obj, implode(",", $this->_valid_wpdb_data_types)));
4238
-            }
4239
-            return $wpdb->prepare($field_obj, $value);
4240
-        }
4241
-    }
4242
-
4243
-
4244
-
4245
-    /**
4246
-     * Takes the input parameter and finds the model field that it indicates.
4247
-     *
4248
-     * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4249
-     * @throws EE_Error
4250
-     * @return EE_Model_Field_Base
4251
-     */
4252
-    protected function _deduce_field_from_query_param($query_param_name)
4253
-    {
4254
-        //ok, now proceed with deducing which part is the model's name, and which is the field's name
4255
-        //which will help us find the database table and column
4256
-        $query_param_parts = explode(".", $query_param_name);
4257
-        if (empty($query_param_parts)) {
4258
-            throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4259
-                'event_espresso'), $query_param_name));
4260
-        }
4261
-        $number_of_parts = count($query_param_parts);
4262
-        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4263
-        if ($number_of_parts === 1) {
4264
-            $field_name = $last_query_param_part;
4265
-            $model_obj = $this;
4266
-        } else {// $number_of_parts >= 2
4267
-            //the last part is the column name, and there are only 2parts. therefore...
4268
-            $field_name = $last_query_param_part;
4269
-            $model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4270
-        }
4271
-        try {
4272
-            return $model_obj->field_settings_for($field_name);
4273
-        } catch (EE_Error $e) {
4274
-            return null;
4275
-        }
4276
-    }
4277
-
4278
-
4279
-
4280
-    /**
4281
-     * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4282
-     * alias and column which corresponds to it
4283
-     *
4284
-     * @param string $field_name
4285
-     * @throws EE_Error
4286
-     * @return string
4287
-     */
4288
-    public function _get_qualified_column_for_field($field_name)
4289
-    {
4290
-        $all_fields = $this->field_settings();
4291
-        $field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4292
-        if ($field) {
4293
-            return $field->get_qualified_column();
4294
-        } else {
4295
-            throw new EE_Error(sprintf(__("There is no field titled %s on model %s. Either the query trying to use it is bad, or you need to add it to the list of fields on the model.",
4296
-                'event_espresso'), $field_name, get_class($this)));
4297
-        }
4298
-    }
4299
-
4300
-
4301
-
4302
-    /**
4303
-     * constructs the select use on special limit joins
4304
-     * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4305
-     * its setup so the select query will be setup on and just doing the special select join off of the primary table
4306
-     * (as that is typically where the limits would be set).
4307
-     *
4308
-     * @param  string       $table_alias The table the select is being built for
4309
-     * @param  mixed|string $limit       The limit for this select
4310
-     * @return string                The final select join element for the query.
4311
-     */
4312
-    public function _construct_limit_join_select($table_alias, $limit)
4313
-    {
4314
-        $SQL = '';
4315
-        foreach ($this->_tables as $table_obj) {
4316
-            if ($table_obj instanceof EE_Primary_Table) {
4317
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4318
-                    ? $table_obj->get_select_join_limit($limit)
4319
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4320
-            } elseif ($table_obj instanceof EE_Secondary_Table) {
4321
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4322
-                    ? $table_obj->get_select_join_limit_join($limit)
4323
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
4324
-            }
4325
-        }
4326
-        return $SQL;
4327
-    }
4328
-
4329
-
4330
-
4331
-    /**
4332
-     * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4333
-     * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4334
-     *
4335
-     * @return string SQL
4336
-     * @throws \EE_Error
4337
-     */
4338
-    public function _construct_internal_join()
4339
-    {
4340
-        $SQL = $this->_get_main_table()->get_table_sql();
4341
-        $SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4342
-        return $SQL;
4343
-    }
4344
-
4345
-
4346
-
4347
-    /**
4348
-     * Constructs the SQL for joining all the tables on this model.
4349
-     * Normally $alias should be the primary table's alias, but in cases where
4350
-     * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4351
-     * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4352
-     * alias, this will construct SQL like:
4353
-     * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4354
-     * With $alias being a secondary table's alias, this will construct SQL like:
4355
-     * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4356
-     *
4357
-     * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4358
-     * @return string
4359
-     */
4360
-    public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4361
-    {
4362
-        $SQL = '';
4363
-        $alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4364
-        foreach ($this->_tables as $table_obj) {
4365
-            if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4366
-                if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4367
-                    //so we're joining to this table, meaning the table is already in
4368
-                    //the FROM statement, BUT the primary table isn't. So we want
4369
-                    //to add the inverse join sql
4370
-                    $SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4371
-                } else {
4372
-                    //just add a regular JOIN to this table from the primary table
4373
-                    $SQL .= $table_obj->get_join_sql($alias_prefixed);
4374
-                }
4375
-            }//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4376
-        }
4377
-        return $SQL;
4378
-    }
4379
-
4380
-
4381
-
4382
-    /**
4383
-     * Gets an array for storing all the data types on the next-to-be-executed-query.
4384
-     * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4385
-     * their data type (eg, '%s', '%d', etc)
4386
-     *
4387
-     * @return array
4388
-     */
4389
-    public function _get_data_types()
4390
-    {
4391
-        $data_types = array();
4392
-        foreach ($this->field_settings() as $field_obj) {
4393
-            //$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4394
-            /** @var $field_obj EE_Model_Field_Base */
4395
-            $data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4396
-        }
4397
-        return $data_types;
4398
-    }
4399
-
4400
-
4401
-
4402
-    /**
4403
-     * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4404
-     *
4405
-     * @param string $model_name
4406
-     * @throws EE_Error
4407
-     * @return EEM_Base
4408
-     */
4409
-    public function get_related_model_obj($model_name)
4410
-    {
4411
-        $model_classname = "EEM_" . $model_name;
4412
-        if (! class_exists($model_classname)) {
4413
-            throw new EE_Error(sprintf(__("You specified a related model named %s in your query. No such model exists, if it did, it would have the classname %s",
4414
-                'event_espresso'), $model_name, $model_classname));
4415
-        }
4416
-        return call_user_func($model_classname . "::instance");
4417
-    }
4418
-
4419
-
4420
-
4421
-    /**
4422
-     * Returns the array of EE_ModelRelations for this model.
4423
-     *
4424
-     * @return EE_Model_Relation_Base[]
4425
-     */
4426
-    public function relation_settings()
4427
-    {
4428
-        return $this->_model_relations;
4429
-    }
4430
-
4431
-
4432
-
4433
-    /**
4434
-     * Gets all related models that this model BELONGS TO. Handy to know sometimes
4435
-     * because without THOSE models, this model probably doesn't have much purpose.
4436
-     * (Eg, without an event, datetimes have little purpose.)
4437
-     *
4438
-     * @return EE_Belongs_To_Relation[]
4439
-     */
4440
-    public function belongs_to_relations()
4441
-    {
4442
-        $belongs_to_relations = array();
4443
-        foreach ($this->relation_settings() as $model_name => $relation_obj) {
4444
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
4445
-                $belongs_to_relations[$model_name] = $relation_obj;
4446
-            }
4447
-        }
4448
-        return $belongs_to_relations;
4449
-    }
4450
-
4451
-
4452
-
4453
-    /**
4454
-     * Returns the specified EE_Model_Relation, or throws an exception
4455
-     *
4456
-     * @param string $relation_name name of relation, key in $this->_relatedModels
4457
-     * @throws EE_Error
4458
-     * @return EE_Model_Relation_Base
4459
-     */
4460
-    public function related_settings_for($relation_name)
4461
-    {
4462
-        $relatedModels = $this->relation_settings();
4463
-        if (! array_key_exists($relation_name, $relatedModels)) {
4464
-            throw new EE_Error(
4465
-                sprintf(
4466
-                    __('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4467
-                        'event_espresso'),
4468
-                    $relation_name,
4469
-                    $this->_get_class_name(),
4470
-                    implode(', ', array_keys($relatedModels))
4471
-                )
4472
-            );
4473
-        }
4474
-        return $relatedModels[$relation_name];
4475
-    }
4476
-
4477
-
4478
-
4479
-    /**
4480
-     * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4481
-     * fields
4482
-     *
4483
-     * @param string $fieldName
4484
-     * @throws EE_Error
4485
-     * @return EE_Model_Field_Base
4486
-     */
4487
-    public function field_settings_for($fieldName)
4488
-    {
4489
-        $fieldSettings = $this->field_settings(true);
4490
-        if (! array_key_exists($fieldName, $fieldSettings)) {
4491
-            throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4492
-                get_class($this)));
4493
-        }
4494
-        return $fieldSettings[$fieldName];
4495
-    }
4496
-
4497
-
4498
-
4499
-    /**
4500
-     * Checks if this field exists on this model
4501
-     *
4502
-     * @param string $fieldName a key in the model's _field_settings array
4503
-     * @return boolean
4504
-     */
4505
-    public function has_field($fieldName)
4506
-    {
4507
-        $fieldSettings = $this->field_settings(true);
4508
-        if (isset($fieldSettings[$fieldName])) {
4509
-            return true;
4510
-        } else {
4511
-            return false;
4512
-        }
4513
-    }
4514
-
4515
-
4516
-
4517
-    /**
4518
-     * Returns whether or not this model has a relation to the specified model
4519
-     *
4520
-     * @param string $relation_name possibly one of the keys in the relation_settings array
4521
-     * @return boolean
4522
-     */
4523
-    public function has_relation($relation_name)
4524
-    {
4525
-        $relations = $this->relation_settings();
4526
-        if (isset($relations[$relation_name])) {
4527
-            return true;
4528
-        } else {
4529
-            return false;
4530
-        }
4531
-    }
4532
-
4533
-
4534
-
4535
-    /**
4536
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4537
-     * Eg, on EE_Answer that would be ANS_ID field object
4538
-     *
4539
-     * @param $field_obj
4540
-     * @return boolean
4541
-     */
4542
-    public function is_primary_key_field($field_obj)
4543
-    {
4544
-        return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4545
-    }
4546
-
4547
-
4548
-
4549
-    /**
4550
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4551
-     * Eg, on EE_Answer that would be ANS_ID field object
4552
-     *
4553
-     * @return EE_Model_Field_Base
4554
-     * @throws EE_Error
4555
-     */
4556
-    public function get_primary_key_field()
4557
-    {
4558
-        if ($this->_primary_key_field === null) {
4559
-            foreach ($this->field_settings(true) as $field_obj) {
4560
-                if ($this->is_primary_key_field($field_obj)) {
4561
-                    $this->_primary_key_field = $field_obj;
4562
-                    break;
4563
-                }
4564
-            }
4565
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4566
-                throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4567
-                    get_class($this)));
4568
-            }
4569
-        }
4570
-        return $this->_primary_key_field;
4571
-    }
4572
-
4573
-
4574
-
4575
-    /**
4576
-     * Returns whether or not not there is a primary key on this model.
4577
-     * Internally does some caching.
4578
-     *
4579
-     * @return boolean
4580
-     */
4581
-    public function has_primary_key_field()
4582
-    {
4583
-        if ($this->_has_primary_key_field === null) {
4584
-            try {
4585
-                $this->get_primary_key_field();
4586
-                $this->_has_primary_key_field = true;
4587
-            } catch (EE_Error $e) {
4588
-                $this->_has_primary_key_field = false;
4589
-            }
4590
-        }
4591
-        return $this->_has_primary_key_field;
4592
-    }
4593
-
4594
-
4595
-
4596
-    /**
4597
-     * Finds the first field of type $field_class_name.
4598
-     *
4599
-     * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4600
-     *                                 EE_Foreign_Key_Field, etc
4601
-     * @return EE_Model_Field_Base or null if none is found
4602
-     */
4603
-    public function get_a_field_of_type($field_class_name)
4604
-    {
4605
-        foreach ($this->field_settings() as $field) {
4606
-            if ($field instanceof $field_class_name) {
4607
-                return $field;
4608
-            }
4609
-        }
4610
-        return null;
4611
-    }
4612
-
4613
-
4614
-
4615
-    /**
4616
-     * Gets a foreign key field pointing to model.
4617
-     *
4618
-     * @param string $model_name eg Event, Registration, not EEM_Event
4619
-     * @return EE_Foreign_Key_Field_Base
4620
-     * @throws EE_Error
4621
-     */
4622
-    public function get_foreign_key_to($model_name)
4623
-    {
4624
-        if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4625
-            foreach ($this->field_settings() as $field) {
4626
-                if (
4627
-                    $field instanceof EE_Foreign_Key_Field_Base
4628
-                    && in_array($model_name, $field->get_model_names_pointed_to())
4629
-                ) {
4630
-                    $this->_cache_foreign_key_to_fields[$model_name] = $field;
4631
-                    break;
4632
-                }
4633
-            }
4634
-            if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4635
-                throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4636
-                    'event_espresso'), $model_name, get_class($this)));
4637
-            }
4638
-        }
4639
-        return $this->_cache_foreign_key_to_fields[$model_name];
4640
-    }
4641
-
4642
-
4643
-
4644
-    /**
4645
-     * Gets the actual table for the table alias
4646
-     *
4647
-     * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4648
-     *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4649
-     *                            Either one works
4650
-     * @return EE_Table_Base
4651
-     */
4652
-    public function get_table_for_alias($table_alias)
4653
-    {
4654
-        $table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4655
-        return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4656
-    }
4657
-
4658
-
4659
-
4660
-    /**
4661
-     * Returns a flat array of all field son this model, instead of organizing them
4662
-     * by table_alias as they are in the constructor.
4663
-     *
4664
-     * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4665
-     * @return EE_Model_Field_Base[] where the keys are the field's name
4666
-     */
4667
-    public function field_settings($include_db_only_fields = false)
4668
-    {
4669
-        if ($include_db_only_fields) {
4670
-            if ($this->_cached_fields === null) {
4671
-                $this->_cached_fields = array();
4672
-                foreach ($this->_fields as $fields_corresponding_to_table) {
4673
-                    foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4674
-                        $this->_cached_fields[$field_name] = $field_obj;
4675
-                    }
4676
-                }
4677
-            }
4678
-            return $this->_cached_fields;
4679
-        } else {
4680
-            if ($this->_cached_fields_non_db_only === null) {
4681
-                $this->_cached_fields_non_db_only = array();
4682
-                foreach ($this->_fields as $fields_corresponding_to_table) {
4683
-                    foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4684
-                        /** @var $field_obj EE_Model_Field_Base */
4685
-                        if (! $field_obj->is_db_only_field()) {
4686
-                            $this->_cached_fields_non_db_only[$field_name] = $field_obj;
4687
-                        }
4688
-                    }
4689
-                }
4690
-            }
4691
-            return $this->_cached_fields_non_db_only;
4692
-        }
4693
-    }
4694
-
4695
-
4696
-
4697
-    /**
4698
-     *        cycle though array of attendees and create objects out of each item
4699
-     *
4700
-     * @access        private
4701
-     * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4702
-     * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4703
-     *                           numerically indexed)
4704
-     * @throws \EE_Error
4705
-     */
4706
-    protected function _create_objects($rows = array())
4707
-    {
4708
-        $array_of_objects = array();
4709
-        if (empty($rows)) {
4710
-            return array();
4711
-        }
4712
-        $count_if_model_has_no_primary_key = 0;
4713
-        $has_primary_key = $this->has_primary_key_field();
4714
-        $primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4715
-        foreach ((array)$rows as $row) {
4716
-            if (empty($row)) {
4717
-                //wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4718
-                return array();
4719
-            }
4720
-            //check if we've already set this object in the results array,
4721
-            //in which case there's no need to process it further (again)
4722
-            if ($has_primary_key) {
4723
-                $table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4724
-                    $row,
4725
-                    $primary_key_field->get_qualified_column(),
4726
-                    $primary_key_field->get_table_column()
4727
-                );
4728
-                if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4729
-                    continue;
4730
-                }
4731
-            }
4732
-            $classInstance = $this->instantiate_class_from_array_or_object($row);
4733
-            if (! $classInstance) {
4734
-                throw new EE_Error(
4735
-                    sprintf(
4736
-                        __('Could not create instance of class %s from row %s', 'event_espresso'),
4737
-                        $this->get_this_model_name(),
4738
-                        http_build_query($row)
4739
-                    )
4740
-                );
4741
-            }
4742
-            //set the timezone on the instantiated objects
4743
-            $classInstance->set_timezone($this->_timezone);
4744
-            //make sure if there is any timezone setting present that we set the timezone for the object
4745
-            $key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4746
-            $array_of_objects[$key] = $classInstance;
4747
-            //also, for all the relations of type BelongsTo, see if we can cache
4748
-            //those related models
4749
-            //(we could do this for other relations too, but if there are conditions
4750
-            //that filtered out some fo the results, then we'd be caching an incomplete set
4751
-            //so it requires a little more thought than just caching them immediately...)
4752
-            foreach ($this->_model_relations as $modelName => $relation_obj) {
4753
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
4754
-                    //check if this model's INFO is present. If so, cache it on the model
4755
-                    $other_model = $relation_obj->get_other_model();
4756
-                    $other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4757
-                    //if we managed to make a model object from the results, cache it on the main model object
4758
-                    if ($other_model_obj_maybe) {
4759
-                        //set timezone on these other model objects if they are present
4760
-                        $other_model_obj_maybe->set_timezone($this->_timezone);
4761
-                        $classInstance->cache($modelName, $other_model_obj_maybe);
4762
-                    }
4763
-                }
4764
-            }
4765
-        }
4766
-        return $array_of_objects;
4767
-    }
4768
-
4769
-
4770
-
4771
-    /**
4772
-     * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4773
-     * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4774
-     * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4775
-     * object (as set in the model_field!).
4776
-     *
4777
-     * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4778
-     */
4779
-    public function create_default_object()
4780
-    {
4781
-        $this_model_fields_and_values = array();
4782
-        //setup the row using default values;
4783
-        foreach ($this->field_settings() as $field_name => $field_obj) {
4784
-            $this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
4785
-        }
4786
-        $className = $this->_get_class_name();
4787
-        $classInstance = EE_Registry::instance()
4788
-                                    ->load_class($className, array($this_model_fields_and_values), false, false);
4789
-        return $classInstance;
4790
-    }
4791
-
4792
-
4793
-
4794
-    /**
4795
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
4796
-     *                             or an stdClass where each property is the name of a column,
4797
-     * @return EE_Base_Class
4798
-     * @throws \EE_Error
4799
-     */
4800
-    public function instantiate_class_from_array_or_object($cols_n_values)
4801
-    {
4802
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
4803
-            $cols_n_values = get_object_vars($cols_n_values);
4804
-        }
4805
-        $primary_key = null;
4806
-        //make sure the array only has keys that are fields/columns on this model
4807
-        $this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4808
-        if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
4809
-            $primary_key = $this_model_fields_n_values[$this->primary_key_name()];
4810
-        }
4811
-        $className = $this->_get_class_name();
4812
-        //check we actually found results that we can use to build our model object
4813
-        //if not, return null
4814
-        if ($this->has_primary_key_field()) {
4815
-            if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
4816
-                return null;
4817
-            }
4818
-        } else if ($this->unique_indexes()) {
4819
-            $first_column = reset($this_model_fields_n_values);
4820
-            if (empty($first_column)) {
4821
-                return null;
4822
-            }
4823
-        }
4824
-        // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
4825
-        if ($primary_key) {
4826
-            $classInstance = $this->get_from_entity_map($primary_key);
4827
-            if (! $classInstance) {
4828
-                $classInstance = EE_Registry::instance()
4829
-                                            ->load_class($className,
4830
-                                                array($this_model_fields_n_values, $this->_timezone), true, false);
4831
-                // add this new object to the entity map
4832
-                $classInstance = $this->add_to_entity_map($classInstance);
4833
-            }
4834
-        } else {
4835
-            $classInstance = EE_Registry::instance()
4836
-                                        ->load_class($className, array($this_model_fields_n_values, $this->_timezone),
4837
-                                            true, false);
4838
-        }
4839
-        //it is entirely possible that the instantiated class object has a set timezone_string db field and has set it's internal _timezone property accordingly (see new_instance_from_db in model objects particularly EE_Event for example).  In this case, we want to make sure the model object doesn't have its timezone string overwritten by any timezone property currently set here on the model so, we intentionally override the model _timezone property with the model_object timezone property.
4840
-        $this->set_timezone($classInstance->get_timezone());
4841
-        return $classInstance;
4842
-    }
4843
-
4844
-
4845
-
4846
-    /**
4847
-     * Gets the model object from the  entity map if it exists
4848
-     *
4849
-     * @param int|string $id the ID of the model object
4850
-     * @return EE_Base_Class
4851
-     */
4852
-    public function get_from_entity_map($id)
4853
-    {
4854
-        return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
4855
-            ? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
4856
-    }
4857
-
4858
-
4859
-
4860
-    /**
4861
-     * add_to_entity_map
4862
-     * Adds the object to the model's entity mappings
4863
-     *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
4864
-     *        and for the remainder of the request, it's even more up-to-date than what's in the database.
4865
-     *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
4866
-     *        If the database gets updated directly and you want the entity mapper to reflect that change,
4867
-     *        then this method should be called immediately after the update query
4868
-     * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
4869
-     * so on multisite, the entity map is specific to the query being done for a specific site.
4870
-     *
4871
-     * @param    EE_Base_Class $object
4872
-     * @throws EE_Error
4873
-     * @return \EE_Base_Class
4874
-     */
4875
-    public function add_to_entity_map(EE_Base_Class $object)
4876
-    {
4877
-        $className = $this->_get_class_name();
4878
-        if (! $object instanceof $className) {
4879
-            throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
4880
-                is_object($object) ? get_class($object) : $object, $className));
4881
-        }
4882
-        /** @var $object EE_Base_Class */
4883
-        if (! $object->ID()) {
4884
-            throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
4885
-                "event_espresso"), get_class($this)));
4886
-        }
4887
-        // double check it's not already there
4888
-        $classInstance = $this->get_from_entity_map($object->ID());
4889
-        if ($classInstance) {
4890
-            return $classInstance;
4891
-        } else {
4892
-            $this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
4893
-            return $object;
4894
-        }
4895
-    }
4896
-
4897
-
4898
-
4899
-    /**
4900
-     * if a valid identifier is provided, then that entity is unset from the entity map,
4901
-     * if no identifier is provided, then the entire entity map is emptied
4902
-     *
4903
-     * @param int|string $id the ID of the model object
4904
-     * @return boolean
4905
-     */
4906
-    public function clear_entity_map($id = null)
4907
-    {
4908
-        if (empty($id)) {
4909
-            $this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
4910
-            return true;
4911
-        }
4912
-        if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
4913
-            unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
4914
-            return true;
4915
-        }
4916
-        return false;
4917
-    }
4918
-
4919
-
4920
-
4921
-    /**
4922
-     * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
4923
-     * Given an array where keys are column (or column alias) names and values,
4924
-     * returns an array of their corresponding field names and database values
4925
-     *
4926
-     * @param array $cols_n_values
4927
-     * @return array
4928
-     */
4929
-    public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
4930
-    {
4931
-        return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4932
-    }
4933
-
4934
-
4935
-
4936
-    /**
4937
-     * _deduce_fields_n_values_from_cols_n_values
4938
-     * Given an array where keys are column (or column alias) names and values,
4939
-     * returns an array of their corresponding field names and database values
4940
-     *
4941
-     * @param string $cols_n_values
4942
-     * @return array
4943
-     */
4944
-    protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
4945
-    {
4946
-        $this_model_fields_n_values = array();
4947
-        foreach ($this->get_tables() as $table_alias => $table_obj) {
4948
-            $table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
4949
-                $table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
4950
-            //there is a primary key on this table and its not set. Use defaults for all its columns
4951
-            if ($table_pk_value === null && $table_obj->get_pk_column()) {
4952
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
4953
-                    if (! $field_obj->is_db_only_field()) {
4954
-                        //prepare field as if its coming from db
4955
-                        $prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
4956
-                        $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
4957
-                    }
4958
-                }
4959
-            } else {
4960
-                //the table's rows existed. Use their values
4961
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
4962
-                    if (! $field_obj->is_db_only_field()) {
4963
-                        $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
4964
-                            $cols_n_values, $field_obj->get_qualified_column(),
4965
-                            $field_obj->get_table_column()
4966
-                        );
4967
-                    }
4968
-                }
4969
-            }
4970
-        }
4971
-        return $this_model_fields_n_values;
4972
-    }
4973
-
4974
-
4975
-
4976
-    /**
4977
-     * @param $cols_n_values
4978
-     * @param $qualified_column
4979
-     * @param $regular_column
4980
-     * @return null
4981
-     */
4982
-    protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
4983
-    {
4984
-        $value = null;
4985
-        //ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
4986
-        //does the field on the model relate to this column retrieved from the db?
4987
-        //or is it a db-only field? (not relating to the model)
4988
-        if (isset($cols_n_values[$qualified_column])) {
4989
-            $value = $cols_n_values[$qualified_column];
4990
-        } elseif (isset($cols_n_values[$regular_column])) {
4991
-            $value = $cols_n_values[$regular_column];
4992
-        }
4993
-        return $value;
4994
-    }
4995
-
4996
-
4997
-
4998
-    /**
4999
-     * refresh_entity_map_from_db
5000
-     * Makes sure the model object in the entity map at $id assumes the values
5001
-     * of the database (opposite of EE_base_Class::save())
5002
-     *
5003
-     * @param int|string $id
5004
-     * @return EE_Base_Class
5005
-     * @throws \EE_Error
5006
-     */
5007
-    public function refresh_entity_map_from_db($id)
5008
-    {
5009
-        $obj_in_map = $this->get_from_entity_map($id);
5010
-        if ($obj_in_map) {
5011
-            $wpdb_results = $this->_get_all_wpdb_results(
5012
-                array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
5013
-            );
5014
-            if ($wpdb_results && is_array($wpdb_results)) {
5015
-                $one_row = reset($wpdb_results);
5016
-                foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
5017
-                    $obj_in_map->set_from_db($field_name, $db_value);
5018
-                }
5019
-                //clear the cache of related model objects
5020
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5021
-                    $obj_in_map->clear_cache($relation_name, null, true);
5022
-                }
5023
-            }
5024
-            $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
5025
-            return $obj_in_map;
5026
-        } else {
5027
-            return $this->get_one_by_ID($id);
5028
-        }
5029
-    }
5030
-
5031
-
5032
-
5033
-    /**
5034
-     * refresh_entity_map_with
5035
-     * Leaves the entry in the entity map alone, but updates it to match the provided
5036
-     * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
5037
-     * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
5038
-     * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
5039
-     *
5040
-     * @param int|string    $id
5041
-     * @param EE_Base_Class $replacing_model_obj
5042
-     * @return \EE_Base_Class
5043
-     * @throws \EE_Error
5044
-     */
5045
-    public function refresh_entity_map_with($id, $replacing_model_obj)
5046
-    {
5047
-        $obj_in_map = $this->get_from_entity_map($id);
5048
-        if ($obj_in_map) {
5049
-            if ($replacing_model_obj instanceof EE_Base_Class) {
5050
-                foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
5051
-                    $obj_in_map->set($field_name, $value);
5052
-                }
5053
-                //make the model object in the entity map's cache match the $replacing_model_obj
5054
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5055
-                    $obj_in_map->clear_cache($relation_name, null, true);
5056
-                    foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
5057
-                        $obj_in_map->cache($relation_name, $cached_obj, $cache_id);
5058
-                    }
5059
-                }
5060
-            }
5061
-            return $obj_in_map;
5062
-        } else {
5063
-            $this->add_to_entity_map($replacing_model_obj);
5064
-            return $replacing_model_obj;
5065
-        }
5066
-    }
5067
-
5068
-
5069
-
5070
-    /**
5071
-     * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
5072
-     * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
5073
-     * require_once($this->_getClassName().".class.php");
5074
-     *
5075
-     * @return string
5076
-     */
5077
-    private function _get_class_name()
5078
-    {
5079
-        return "EE_" . $this->get_this_model_name();
5080
-    }
5081
-
5082
-
5083
-
5084
-    /**
5085
-     * Get the name of the items this model represents, for the quantity specified. Eg,
5086
-     * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
5087
-     * it would be 'Events'.
5088
-     *
5089
-     * @param int $quantity
5090
-     * @return string
5091
-     */
5092
-    public function item_name($quantity = 1)
5093
-    {
5094
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5095
-    }
5096
-
5097
-
5098
-
5099
-    /**
5100
-     * Very handy general function to allow for plugins to extend any child of EE_TempBase.
5101
-     * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
5102
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
5103
-     * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
5104
-     * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
5105
-     * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
5106
-     * was called, and an array of the original arguments passed to the function. Whatever their callback function
5107
-     * returns will be returned by this function. Example: in functions.php (or in a plugin):
5108
-     * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
5109
-     * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
5110
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
5111
-     *        return $previousReturnValue.$returnString;
5112
-     * }
5113
-     * require('EEM_Answer.model.php');
5114
-     * $answer=EEM_Answer::instance();
5115
-     * echo $answer->my_callback('monkeys',100);
5116
-     * //will output "you called my_callback! and passed args:monkeys,100"
5117
-     *
5118
-     * @param string $methodName name of method which was called on a child of EE_TempBase, but which
5119
-     * @param array  $args       array of original arguments passed to the function
5120
-     * @throws EE_Error
5121
-     * @return mixed whatever the plugin which calls add_filter decides
5122
-     */
5123
-    public function __call($methodName, $args)
5124
-    {
5125
-        $className = get_class($this);
5126
-        $tagName = "FHEE__{$className}__{$methodName}";
5127
-        if (! has_filter($tagName)) {
5128
-            throw new EE_Error(
5129
-                sprintf(
5130
-                    __('Method %1$s on model %2$s does not exist! You can create one with the following code in functions.php or in a plugin: %4$s function my_callback(%4$s \$previousReturnValue, EEM_Base \$object\ $argsArray=NULL ){%4$s     /*function body*/%4$s      return \$whatever;%4$s }%4$s add_filter( \'%3$s\', \'my_callback\', 10, 3 );',
5131
-                        'event_espresso'),
5132
-                    $methodName,
5133
-                    $className,
5134
-                    $tagName,
5135
-                    '<br />'
5136
-                )
5137
-            );
5138
-        }
5139
-        return apply_filters($tagName, null, $this, $args);
5140
-    }
5141
-
5142
-
5143
-
5144
-    /**
5145
-     * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
5146
-     * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
5147
-     *
5148
-     * @param EE_Base_Class|string|int $base_class_obj_or_id either:
5149
-     *                                                       the EE_Base_Class object that corresponds to this Model,
5150
-     *                                                       the object's class name
5151
-     *                                                       or object's ID
5152
-     * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
5153
-     *                                                       exists in the database. If it does not, we add it
5154
-     * @throws EE_Error
5155
-     * @return EE_Base_Class
5156
-     */
5157
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
5158
-    {
5159
-        $className = $this->_get_class_name();
5160
-        if ($base_class_obj_or_id instanceof $className) {
5161
-            $model_object = $base_class_obj_or_id;
5162
-        } else {
5163
-            $primary_key_field = $this->get_primary_key_field();
5164
-            if (
5165
-                $primary_key_field instanceof EE_Primary_Key_Int_Field
5166
-                && (
5167
-                    is_int($base_class_obj_or_id)
5168
-                    || is_string($base_class_obj_or_id)
5169
-                )
5170
-            ) {
5171
-                // assume it's an ID.
5172
-                // either a proper integer or a string representing an integer (eg "101" instead of 101)
5173
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
5174
-            } else if (
5175
-                $primary_key_field instanceof EE_Primary_Key_String_Field
5176
-                && is_string($base_class_obj_or_id)
5177
-            ) {
5178
-                // assume its a string representation of the object
5179
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
5180
-            } else {
5181
-                throw new EE_Error(
5182
-                    sprintf(
5183
-                        __(
5184
-                            "'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5185
-                            'event_espresso'
5186
-                        ),
5187
-                        $base_class_obj_or_id,
5188
-                        $this->_get_class_name(),
5189
-                        print_r($base_class_obj_or_id, true)
5190
-                    )
5191
-                );
5192
-            }
5193
-        }
5194
-        if ($ensure_is_in_db && $model_object->ID() !== null) {
5195
-            $model_object->save();
5196
-        }
5197
-        return $model_object;
5198
-    }
5199
-
5200
-
5201
-
5202
-    /**
5203
-     * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5204
-     * is a value of the this model's primary key. If it's an EE_Base_Class child,
5205
-     * returns it ID.
5206
-     *
5207
-     * @param EE_Base_Class|int|string $base_class_obj_or_id
5208
-     * @return int|string depending on the type of this model object's ID
5209
-     * @throws EE_Error
5210
-     */
5211
-    public function ensure_is_ID($base_class_obj_or_id)
5212
-    {
5213
-        $className = $this->_get_class_name();
5214
-        if ($base_class_obj_or_id instanceof $className) {
5215
-            /** @var $base_class_obj_or_id EE_Base_Class */
5216
-            $id = $base_class_obj_or_id->ID();
5217
-        } elseif (is_int($base_class_obj_or_id)) {
5218
-            //assume it's an ID
5219
-            $id = $base_class_obj_or_id;
5220
-        } elseif (is_string($base_class_obj_or_id)) {
5221
-            //assume its a string representation of the object
5222
-            $id = $base_class_obj_or_id;
5223
-        } else {
5224
-            throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5225
-                'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5226
-                print_r($base_class_obj_or_id, true)));
5227
-        }
5228
-        return $id;
5229
-    }
5230
-
5231
-
5232
-
5233
-    /**
5234
-     * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5235
-     * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5236
-     * been sanitized and converted into the appropriate domain.
5237
-     * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5238
-     * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5239
-     * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5240
-     * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5241
-     * $EVT = EEM_Event::instance(); $old_setting =
5242
-     * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5243
-     * $EVT->assume_values_already_prepared_by_model_object(true);
5244
-     * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5245
-     * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5246
-     *
5247
-     * @param int $values_already_prepared like one of the constants on EEM_Base
5248
-     * @return void
5249
-     */
5250
-    public function assume_values_already_prepared_by_model_object(
5251
-        $values_already_prepared = self::not_prepared_by_model_object
5252
-    ) {
5253
-        $this->_values_already_prepared_by_model_object = $values_already_prepared;
5254
-    }
5255
-
5256
-
5257
-
5258
-    /**
5259
-     * Read comments for assume_values_already_prepared_by_model_object()
5260
-     *
5261
-     * @return int
5262
-     */
5263
-    public function get_assumption_concerning_values_already_prepared_by_model_object()
5264
-    {
5265
-        return $this->_values_already_prepared_by_model_object;
5266
-    }
5267
-
5268
-
5269
-
5270
-    /**
5271
-     * Gets all the indexes on this model
5272
-     *
5273
-     * @return EE_Index[]
5274
-     */
5275
-    public function indexes()
5276
-    {
5277
-        return $this->_indexes;
5278
-    }
5279
-
5280
-
5281
-
5282
-    /**
5283
-     * Gets all the Unique Indexes on this model
5284
-     *
5285
-     * @return EE_Unique_Index[]
5286
-     */
5287
-    public function unique_indexes()
5288
-    {
5289
-        $unique_indexes = array();
5290
-        foreach ($this->_indexes as $name => $index) {
5291
-            if ($index instanceof EE_Unique_Index) {
5292
-                $unique_indexes [$name] = $index;
5293
-            }
5294
-        }
5295
-        return $unique_indexes;
5296
-    }
5297
-
5298
-
5299
-
5300
-    /**
5301
-     * Gets all the fields which, when combined, make the primary key.
5302
-     * This is usually just an array with 1 element (the primary key), but in cases
5303
-     * where there is no primary key, it's a combination of fields as defined
5304
-     * on a primary index
5305
-     *
5306
-     * @return EE_Model_Field_Base[] indexed by the field's name
5307
-     * @throws \EE_Error
5308
-     */
5309
-    public function get_combined_primary_key_fields()
5310
-    {
5311
-        foreach ($this->indexes() as $index) {
5312
-            if ($index instanceof EE_Primary_Key_Index) {
5313
-                return $index->fields();
5314
-            }
5315
-        }
5316
-        return array($this->primary_key_name() => $this->get_primary_key_field());
5317
-    }
5318
-
5319
-
5320
-
5321
-    /**
5322
-     * Used to build a primary key string (when the model has no primary key),
5323
-     * which can be used a unique string to identify this model object.
5324
-     *
5325
-     * @param array $cols_n_values keys are field names, values are their values
5326
-     * @return string
5327
-     * @throws \EE_Error
5328
-     */
5329
-    public function get_index_primary_key_string($cols_n_values)
5330
-    {
5331
-        $cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5332
-            $this->get_combined_primary_key_fields());
5333
-        return http_build_query($cols_n_values_for_primary_key_index);
5334
-    }
5335
-
5336
-
5337
-
5338
-    /**
5339
-     * Gets the field values from the primary key string
5340
-     *
5341
-     * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5342
-     * @param string $index_primary_key_string
5343
-     * @return null|array
5344
-     * @throws \EE_Error
5345
-     */
5346
-    public function parse_index_primary_key_string($index_primary_key_string)
5347
-    {
5348
-        $key_fields = $this->get_combined_primary_key_fields();
5349
-        //check all of them are in the $id
5350
-        $key_vals_in_combined_pk = array();
5351
-        parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5352
-        foreach ($key_fields as $key_field_name => $field_obj) {
5353
-            if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5354
-                return null;
5355
-            }
5356
-        }
5357
-        return $key_vals_in_combined_pk;
5358
-    }
5359
-
5360
-
5361
-
5362
-    /**
5363
-     * verifies that an array of key-value pairs for model fields has a key
5364
-     * for each field comprising the primary key index
5365
-     *
5366
-     * @param array $key_vals
5367
-     * @return boolean
5368
-     * @throws \EE_Error
5369
-     */
5370
-    public function has_all_combined_primary_key_fields($key_vals)
5371
-    {
5372
-        $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5373
-        foreach ($keys_it_should_have as $key) {
5374
-            if (! isset($key_vals[$key])) {
5375
-                return false;
5376
-            }
5377
-        }
5378
-        return true;
5379
-    }
5380
-
5381
-
5382
-
5383
-    /**
5384
-     * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5385
-     * We consider something to be a copy if all the attributes match (except the ID, of course).
5386
-     *
5387
-     * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5388
-     * @param array               $query_params                     like EEM_Base::get_all's query_params.
5389
-     * @throws EE_Error
5390
-     * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5391
-     *                                                              indexed)
5392
-     */
5393
-    public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5394
-    {
5395
-        if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5396
-            $attributes_array = $model_object_or_attributes_array->model_field_array();
5397
-        } elseif (is_array($model_object_or_attributes_array)) {
5398
-            $attributes_array = $model_object_or_attributes_array;
5399
-        } else {
5400
-            throw new EE_Error(sprintf(__("get_all_copies should be provided with either a model object or an array of field-value-pairs, but was given %s",
5401
-                "event_espresso"), $model_object_or_attributes_array));
5402
-        }
5403
-        //even copies obviously won't have the same ID, so remove the primary key
5404
-        //from the WHERE conditions for finding copies (if there is a primary key, of course)
5405
-        if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5406
-            unset($attributes_array[$this->primary_key_name()]);
5407
-        }
5408
-        if (isset($query_params[0])) {
5409
-            $query_params[0] = array_merge($attributes_array, $query_params);
5410
-        } else {
5411
-            $query_params[0] = $attributes_array;
5412
-        }
5413
-        return $this->get_all($query_params);
5414
-    }
5415
-
5416
-
5417
-
5418
-    /**
5419
-     * Gets the first copy we find. See get_all_copies for more details
5420
-     *
5421
-     * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5422
-     * @param array $query_params
5423
-     * @return EE_Base_Class
5424
-     * @throws \EE_Error
5425
-     */
5426
-    public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5427
-    {
5428
-        if (! is_array($query_params)) {
5429
-            EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5430
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5431
-                    gettype($query_params)), '4.6.0');
5432
-            $query_params = array();
5433
-        }
5434
-        $query_params['limit'] = 1;
5435
-        $copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5436
-        if (is_array($copies)) {
5437
-            return array_shift($copies);
5438
-        } else {
5439
-            return null;
5440
-        }
5441
-    }
5442
-
5443
-
5444
-
5445
-    /**
5446
-     * Updates the item with the specified id. Ignores default query parameters because
5447
-     * we have specified the ID, and its assumed we KNOW what we're doing
5448
-     *
5449
-     * @param array      $fields_n_values keys are field names, values are their new values
5450
-     * @param int|string $id              the value of the primary key to update
5451
-     * @return int number of rows updated
5452
-     * @throws \EE_Error
5453
-     */
5454
-    public function update_by_ID($fields_n_values, $id)
5455
-    {
5456
-        $query_params = array(
5457
-            0                          => array($this->get_primary_key_field()->get_name() => $id),
5458
-            'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
5459
-        );
5460
-        return $this->update($fields_n_values, $query_params);
5461
-    }
5462
-
5463
-
5464
-
5465
-    /**
5466
-     * Changes an operator which was supplied to the models into one usable in SQL
5467
-     *
5468
-     * @param string $operator_supplied
5469
-     * @return string an operator which can be used in SQL
5470
-     * @throws EE_Error
5471
-     */
5472
-    private function _prepare_operator_for_sql($operator_supplied)
5473
-    {
5474
-        $sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5475
-            : null;
5476
-        if ($sql_operator) {
5477
-            return $sql_operator;
5478
-        } else {
5479
-            throw new EE_Error(sprintf(__("The operator '%s' is not in the list of valid operators: %s",
5480
-                "event_espresso"), $operator_supplied, implode(",", array_keys($this->_valid_operators))));
5481
-        }
5482
-    }
5483
-
5484
-
5485
-
5486
-    /**
5487
-     * Gets an array where keys are the primary keys and values are their 'names'
5488
-     * (as determined by the model object's name() function, which is often overridden)
5489
-     *
5490
-     * @param array $query_params like get_all's
5491
-     * @return string[]
5492
-     * @throws \EE_Error
5493
-     */
5494
-    public function get_all_names($query_params = array())
5495
-    {
5496
-        $objs = $this->get_all($query_params);
5497
-        $names = array();
5498
-        foreach ($objs as $obj) {
5499
-            $names[$obj->ID()] = $obj->name();
5500
-        }
5501
-        return $names;
5502
-    }
5503
-
5504
-
5505
-
5506
-    /**
5507
-     * Gets an array of primary keys from the model objects. If you acquired the model objects
5508
-     * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5509
-     * this is duplicated effort and reduces efficiency) you would be better to use
5510
-     * array_keys() on $model_objects.
5511
-     *
5512
-     * @param \EE_Base_Class[] $model_objects
5513
-     * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5514
-     *                                               in the returned array
5515
-     * @return array
5516
-     * @throws \EE_Error
5517
-     */
5518
-    public function get_IDs($model_objects, $filter_out_empty_ids = false)
5519
-    {
5520
-        if (! $this->has_primary_key_field()) {
5521
-            if (WP_DEBUG) {
5522
-                EE_Error::add_error(
5523
-                    __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5524
-                    __FILE__,
5525
-                    __FUNCTION__,
5526
-                    __LINE__
5527
-                );
5528
-            }
5529
-        }
5530
-        $IDs = array();
5531
-        foreach ($model_objects as $model_object) {
5532
-            $id = $model_object->ID();
5533
-            if (! $id) {
5534
-                if ($filter_out_empty_ids) {
5535
-                    continue;
5536
-                }
5537
-                if (WP_DEBUG) {
5538
-                    EE_Error::add_error(
5539
-                        __(
5540
-                            'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5541
-                            'event_espresso'
5542
-                        ),
5543
-                        __FILE__,
5544
-                        __FUNCTION__,
5545
-                        __LINE__
5546
-                    );
5547
-                }
5548
-            }
5549
-            $IDs[] = $id;
5550
-        }
5551
-        return $IDs;
5552
-    }
5553
-
5554
-
5555
-
5556
-    /**
5557
-     * Returns the string used in capabilities relating to this model. If there
5558
-     * are no capabilities that relate to this model returns false
5559
-     *
5560
-     * @return string|false
5561
-     */
5562
-    public function cap_slug()
5563
-    {
5564
-        return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5565
-    }
5566
-
5567
-
5568
-
5569
-    /**
5570
-     * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5571
-     * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5572
-     * only returns the cap restrictions array in that context (ie, the array
5573
-     * at that key)
5574
-     *
5575
-     * @param string $context
5576
-     * @return EE_Default_Where_Conditions[] indexed by associated capability
5577
-     * @throws \EE_Error
5578
-     */
5579
-    public function cap_restrictions($context = EEM_Base::caps_read)
5580
-    {
5581
-        EEM_Base::verify_is_valid_cap_context($context);
5582
-        //check if we ought to run the restriction generator first
5583
-        if (
5584
-            isset($this->_cap_restriction_generators[$context])
5585
-            && $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5586
-            && ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5587
-        ) {
5588
-            $this->_cap_restrictions[$context] = array_merge(
5589
-                $this->_cap_restrictions[$context],
5590
-                $this->_cap_restriction_generators[$context]->generate_restrictions()
5591
-            );
5592
-        }
5593
-        //and make sure we've finalized the construction of each restriction
5594
-        foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5595
-            if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5596
-                $where_conditions_obj->_finalize_construct($this);
5597
-            }
5598
-        }
5599
-        return $this->_cap_restrictions[$context];
5600
-    }
5601
-
5602
-
5603
-
5604
-    /**
5605
-     * Indicating whether or not this model thinks its a wp core model
5606
-     *
5607
-     * @return boolean
5608
-     */
5609
-    public function is_wp_core_model()
5610
-    {
5611
-        return $this->_wp_core_model;
5612
-    }
5613
-
5614
-
5615
-
5616
-    /**
5617
-     * Gets all the caps that are missing which impose a restriction on
5618
-     * queries made in this context
5619
-     *
5620
-     * @param string $context one of EEM_Base::caps_ constants
5621
-     * @return EE_Default_Where_Conditions[] indexed by capability name
5622
-     * @throws \EE_Error
5623
-     */
5624
-    public function caps_missing($context = EEM_Base::caps_read)
5625
-    {
5626
-        $missing_caps = array();
5627
-        $cap_restrictions = $this->cap_restrictions($context);
5628
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5629
-            if (! EE_Capabilities::instance()
5630
-                                 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5631
-            ) {
5632
-                $missing_caps[$cap] = $restriction_if_no_cap;
5633
-            }
5634
-        }
5635
-        return $missing_caps;
5636
-    }
5637
-
5638
-
5639
-
5640
-    /**
5641
-     * Gets the mapping from capability contexts to action strings used in capability names
5642
-     *
5643
-     * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5644
-     * one of 'read', 'edit', or 'delete'
5645
-     */
5646
-    public function cap_contexts_to_cap_action_map()
5647
-    {
5648
-        return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5649
-            $this);
5650
-    }
5651
-
5652
-
5653
-
5654
-    /**
5655
-     * Gets the action string for the specified capability context
5656
-     *
5657
-     * @param string $context
5658
-     * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5659
-     * @throws \EE_Error
5660
-     */
5661
-    public function cap_action_for_context($context)
5662
-    {
5663
-        $mapping = $this->cap_contexts_to_cap_action_map();
5664
-        if (isset($mapping[$context])) {
5665
-            return $mapping[$context];
5666
-        }
5667
-        if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5668
-            return $action;
5669
-        }
5670
-        throw new EE_Error(
5671
-            sprintf(
5672
-                __('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5673
-                $context,
5674
-                implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5675
-            )
5676
-        );
5677
-    }
5678
-
5679
-
5680
-
5681
-    /**
5682
-     * Returns all the capability contexts which are valid when querying models
5683
-     *
5684
-     * @return array
5685
-     */
5686
-    public static function valid_cap_contexts()
5687
-    {
5688
-        return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5689
-            self::caps_read,
5690
-            self::caps_read_admin,
5691
-            self::caps_edit,
5692
-            self::caps_delete,
5693
-        ));
5694
-    }
5695
-
5696
-
5697
-
5698
-    /**
5699
-     * Returns all valid options for 'default_where_conditions'
5700
-     *
5701
-     * @return array
5702
-     */
5703
-    public static function valid_default_where_conditions()
5704
-    {
5705
-        return array(
5706
-            EEM_Base::default_where_conditions_all,
5707
-            EEM_Base::default_where_conditions_this_only,
5708
-            EEM_Base::default_where_conditions_others_only,
5709
-            EEM_Base::default_where_conditions_minimum_all,
5710
-            EEM_Base::default_where_conditions_minimum_others,
5711
-            EEM_Base::default_where_conditions_none
5712
-        );
5713
-    }
5714
-
5715
-    // public static function default_where_conditions_full
5716
-    /**
5717
-     * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5718
-     *
5719
-     * @param string $context
5720
-     * @return bool
5721
-     * @throws \EE_Error
5722
-     */
5723
-    static public function verify_is_valid_cap_context($context)
5724
-    {
5725
-        $valid_cap_contexts = EEM_Base::valid_cap_contexts();
5726
-        if (in_array($context, $valid_cap_contexts)) {
5727
-            return true;
5728
-        } else {
5729
-            throw new EE_Error(
5730
-                sprintf(
5731
-                    __('Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5732
-                        'event_espresso'),
5733
-                    $context,
5734
-                    'EEM_Base',
5735
-                    implode(',', $valid_cap_contexts)
5736
-                )
5737
-            );
5738
-        }
5739
-    }
5740
-
5741
-
5742
-
5743
-    /**
5744
-     * Clears all the models field caches. This is only useful when a sub-class
5745
-     * might have added a field or something and these caches might be invalidated
5746
-     */
5747
-    protected function _invalidate_field_caches()
5748
-    {
5749
-        $this->_cache_foreign_key_to_fields = array();
5750
-        $this->_cached_fields = null;
5751
-        $this->_cached_fields_non_db_only = null;
5752
-    }
3610
+		}
3611
+		return $null_friendly_where_conditions;
3612
+	}
3613
+
3614
+
3615
+
3616
+	/**
3617
+	 * Uses the _default_where_conditions_strategy set during __construct() to get
3618
+	 * default where conditions on all get_all, update, and delete queries done by this model.
3619
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3620
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3621
+	 *
3622
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3623
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3624
+	 */
3625
+	private function _get_default_where_conditions($model_relation_path = null)
3626
+	{
3627
+		if ($this->_ignore_where_strategy) {
3628
+			return array();
3629
+		}
3630
+		return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3631
+	}
3632
+
3633
+
3634
+
3635
+	/**
3636
+	 * Uses the _minimum_where_conditions_strategy set during __construct() to get
3637
+	 * minimum where conditions on all get_all, update, and delete queries done by this model.
3638
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3639
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3640
+	 * Similar to _get_default_where_conditions
3641
+	 *
3642
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3643
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3644
+	 */
3645
+	protected function _get_minimum_where_conditions($model_relation_path = null)
3646
+	{
3647
+		if ($this->_ignore_where_strategy) {
3648
+			return array();
3649
+		}
3650
+		return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3651
+	}
3652
+
3653
+
3654
+
3655
+	/**
3656
+	 * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3657
+	 * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3658
+	 *
3659
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
3660
+	 * @return string
3661
+	 * @throws \EE_Error
3662
+	 */
3663
+	private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3664
+	{
3665
+		$selects = $this->_get_columns_to_select_for_this_model();
3666
+		foreach (
3667
+			$model_query_info->get_model_names_included() as $model_relation_chain =>
3668
+			$name_of_other_model_included
3669
+		) {
3670
+			$other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3671
+			$other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3672
+			foreach ($other_model_selects as $key => $value) {
3673
+				$selects[] = $value;
3674
+			}
3675
+		}
3676
+		return implode(", ", $selects);
3677
+	}
3678
+
3679
+
3680
+
3681
+	/**
3682
+	 * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3683
+	 * So that's going to be the columns for all the fields on the model
3684
+	 *
3685
+	 * @param string $model_relation_chain like 'Question.Question_Group.Event'
3686
+	 * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3687
+	 */
3688
+	public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3689
+	{
3690
+		$fields = $this->field_settings();
3691
+		$selects = array();
3692
+		$table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3693
+			$this->get_this_model_name());
3694
+		foreach ($fields as $field_obj) {
3695
+			$selects[] = $table_alias_with_model_relation_chain_prefix
3696
+						 . $field_obj->get_table_alias()
3697
+						 . "."
3698
+						 . $field_obj->get_table_column()
3699
+						 . " AS '"
3700
+						 . $table_alias_with_model_relation_chain_prefix
3701
+						 . $field_obj->get_table_alias()
3702
+						 . "."
3703
+						 . $field_obj->get_table_column()
3704
+						 . "'";
3705
+		}
3706
+		//make sure we are also getting the PKs of each table
3707
+		$tables = $this->get_tables();
3708
+		if (count($tables) > 1) {
3709
+			foreach ($tables as $table_obj) {
3710
+				$qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3711
+									   . $table_obj->get_fully_qualified_pk_column();
3712
+				if (! in_array($qualified_pk_column, $selects)) {
3713
+					$selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3714
+				}
3715
+			}
3716
+		}
3717
+		return $selects;
3718
+	}
3719
+
3720
+
3721
+
3722
+	/**
3723
+	 * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3724
+	 * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3725
+	 * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3726
+	 * SQL for joining, and the data types
3727
+	 *
3728
+	 * @param null|string                 $original_query_param
3729
+	 * @param string                      $query_param          like Registration.Transaction.TXN_ID
3730
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3731
+	 * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3732
+	 *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3733
+	 *                                                          column name. We only want model names, eg 'Event.Venue'
3734
+	 *                                                          or 'Registration's
3735
+	 * @param string                      $original_query_param what it originally was (eg
3736
+	 *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3737
+	 *                                                          matches $query_param
3738
+	 * @throws EE_Error
3739
+	 * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3740
+	 */
3741
+	private function _extract_related_model_info_from_query_param(
3742
+		$query_param,
3743
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3744
+		$query_param_type,
3745
+		$original_query_param = null
3746
+	) {
3747
+		if ($original_query_param === null) {
3748
+			$original_query_param = $query_param;
3749
+		}
3750
+		$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3751
+		/** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3752
+		$allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3753
+		$allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3754
+		//check to see if we have a field on this model
3755
+		$this_model_fields = $this->field_settings(true);
3756
+		if (array_key_exists($query_param, $this_model_fields)) {
3757
+			if ($allow_fields) {
3758
+				return;
3759
+			} else {
3760
+				throw new EE_Error(sprintf(__("Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
3761
+					"event_espresso"),
3762
+					$query_param, get_class($this), $query_param_type, $original_query_param));
3763
+			}
3764
+		} //check if this is a special logic query param
3765
+		elseif (in_array($query_param, $this->_logic_query_param_keys, true)) {
3766
+			if ($allow_logic_query_params) {
3767
+				return;
3768
+			} else {
3769
+				throw new EE_Error(
3770
+					sprintf(
3771
+						__('Logic query params ("%1$s") are being used incorrectly with the following query param ("%2$s") on model %3$s. %4$sAdditional Info:%4$s%5$s',
3772
+							'event_espresso'),
3773
+						implode('", "', $this->_logic_query_param_keys),
3774
+						$query_param,
3775
+						get_class($this),
3776
+						'<br />',
3777
+						"\t"
3778
+						. ' $passed_in_query_info = <pre>'
3779
+						. print_r($passed_in_query_info, true)
3780
+						. '</pre>'
3781
+						. "\n\t"
3782
+						. ' $query_param_type = '
3783
+						. $query_param_type
3784
+						. "\n\t"
3785
+						. ' $original_query_param = '
3786
+						. $original_query_param
3787
+					)
3788
+				);
3789
+			}
3790
+		} //check if it's a custom selection
3791
+		elseif (array_key_exists($query_param, $this->_custom_selections)) {
3792
+			return;
3793
+		}
3794
+		//check if has a model name at the beginning
3795
+		//and
3796
+		//check if it's a field on a related model
3797
+		foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3798
+			if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3799
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3800
+				$query_param = substr($query_param, strlen($valid_related_model_name . "."));
3801
+				if ($query_param === '') {
3802
+					//nothing left to $query_param
3803
+					//we should actually end in a field name, not a model like this!
3804
+					throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3805
+						"event_espresso"),
3806
+						$query_param, $query_param_type, get_class($this), $valid_related_model_name));
3807
+				} else {
3808
+					$related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3809
+					$related_model_obj->_extract_related_model_info_from_query_param($query_param,
3810
+						$passed_in_query_info, $query_param_type, $original_query_param);
3811
+					return;
3812
+				}
3813
+			} elseif ($query_param === $valid_related_model_name) {
3814
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3815
+				return;
3816
+			}
3817
+		}
3818
+		//ok so $query_param didn't start with a model name
3819
+		//and we previously confirmed it wasn't a logic query param or field on the current model
3820
+		//it's wack, that's what it is
3821
+		throw new EE_Error(sprintf(__("There is no model named '%s' related to %s. Query param type is %s and original query param is %s",
3822
+			"event_espresso"),
3823
+			$query_param, get_class($this), $query_param_type, $original_query_param));
3824
+	}
3825
+
3826
+
3827
+
3828
+	/**
3829
+	 * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3830
+	 * and store it on $passed_in_query_info
3831
+	 *
3832
+	 * @param string                      $model_name
3833
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3834
+	 * @param string                      $original_query_param used to extract the relation chain between the queried
3835
+	 *                                                          model and $model_name. Eg, if we are querying Event,
3836
+	 *                                                          and are adding a join to 'Payment' with the original
3837
+	 *                                                          query param key
3838
+	 *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3839
+	 *                                                          to extract 'Registration.Transaction.Payment', in case
3840
+	 *                                                          Payment wants to add default query params so that it
3841
+	 *                                                          will know what models to prepend onto its default query
3842
+	 *                                                          params or in case it wants to rename tables (in case
3843
+	 *                                                          there are multiple joins to the same table)
3844
+	 * @return void
3845
+	 * @throws \EE_Error
3846
+	 */
3847
+	private function _add_join_to_model(
3848
+		$model_name,
3849
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3850
+		$original_query_param
3851
+	) {
3852
+		$relation_obj = $this->related_settings_for($model_name);
3853
+		$model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3854
+		//check if the relation is HABTM, because then we're essentially doing two joins
3855
+		//If so, join first to the JOIN table, and add its data types, and then continue as normal
3856
+		if ($relation_obj instanceof EE_HABTM_Relation) {
3857
+			$join_model_obj = $relation_obj->get_join_model();
3858
+			//replace the model specified with the join model for this relation chain, whi
3859
+			$relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
3860
+				$join_model_obj->get_this_model_name(), $model_relation_chain);
3861
+			$new_query_info = new EE_Model_Query_Info_Carrier(
3862
+				array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
3863
+				$relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model));
3864
+			$passed_in_query_info->merge($new_query_info);
3865
+		}
3866
+		//now just join to the other table pointed to by the relation object, and add its data types
3867
+		$new_query_info = new EE_Model_Query_Info_Carrier(
3868
+			array($model_relation_chain => $model_name),
3869
+			$relation_obj->get_join_statement($model_relation_chain));
3870
+		$passed_in_query_info->merge($new_query_info);
3871
+	}
3872
+
3873
+
3874
+
3875
+	/**
3876
+	 * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
3877
+	 *
3878
+	 * @param array $where_params like EEM_Base::get_all
3879
+	 * @return string of SQL
3880
+	 * @throws \EE_Error
3881
+	 */
3882
+	private function _construct_where_clause($where_params)
3883
+	{
3884
+		$SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
3885
+		if ($SQL) {
3886
+			return " WHERE " . $SQL;
3887
+		} else {
3888
+			return '';
3889
+		}
3890
+	}
3891
+
3892
+
3893
+
3894
+	/**
3895
+	 * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
3896
+	 * and should be passed HAVING parameters, not WHERE parameters
3897
+	 *
3898
+	 * @param array $having_params
3899
+	 * @return string
3900
+	 * @throws \EE_Error
3901
+	 */
3902
+	private function _construct_having_clause($having_params)
3903
+	{
3904
+		$SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
3905
+		if ($SQL) {
3906
+			return " HAVING " . $SQL;
3907
+		} else {
3908
+			return '';
3909
+		}
3910
+	}
3911
+
3912
+
3913
+
3914
+	/**
3915
+	 * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
3916
+	 * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
3917
+	 * EEM_Attendee.
3918
+	 *
3919
+	 * @param string $field_name
3920
+	 * @param string $model_name
3921
+	 * @return EE_Model_Field_Base
3922
+	 * @throws EE_Error
3923
+	 */
3924
+	protected function _get_field_on_model($field_name, $model_name)
3925
+	{
3926
+		$model_class = 'EEM_' . $model_name;
3927
+		$model_filepath = $model_class . ".model.php";
3928
+		if (is_readable($model_filepath)) {
3929
+			require_once($model_filepath);
3930
+			$model_instance = call_user_func($model_name . "::instance");
3931
+			/* @var $model_instance EEM_Base */
3932
+			return $model_instance->field_settings_for($field_name);
3933
+		} else {
3934
+			throw new EE_Error(sprintf(__('No model named %s exists, with classname %s and filepath %s',
3935
+				'event_espresso'), $model_name, $model_class, $model_filepath));
3936
+		}
3937
+	}
3938
+
3939
+
3940
+
3941
+	/**
3942
+	 * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
3943
+	 * Event_Meta.meta_value = 'foo'))"
3944
+	 *
3945
+	 * @param array  $where_params see EEM_Base::get_all for documentation
3946
+	 * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
3947
+	 * @throws EE_Error
3948
+	 * @return string of SQL
3949
+	 */
3950
+	private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
3951
+	{
3952
+		$where_clauses = array();
3953
+		foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
3954
+			$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
3955
+			if (in_array($query_param, $this->_logic_query_param_keys)) {
3956
+				switch ($query_param) {
3957
+					case 'not':
3958
+					case 'NOT':
3959
+						$where_clauses[] = "! ("
3960
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3961
+								$glue)
3962
+										   . ")";
3963
+						break;
3964
+					case 'and':
3965
+					case 'AND':
3966
+						$where_clauses[] = " ("
3967
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3968
+								' AND ')
3969
+										   . ")";
3970
+						break;
3971
+					case 'or':
3972
+					case 'OR':
3973
+						$where_clauses[] = " ("
3974
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3975
+								' OR ')
3976
+										   . ")";
3977
+						break;
3978
+				}
3979
+			} else {
3980
+				$field_obj = $this->_deduce_field_from_query_param($query_param);
3981
+				//if it's not a normal field, maybe it's a custom selection?
3982
+				if (! $field_obj) {
3983
+					if (isset($this->_custom_selections[$query_param][1])) {
3984
+						$field_obj = $this->_custom_selections[$query_param][1];
3985
+					} else {
3986
+						throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
3987
+							"event_espresso"), $query_param));
3988
+					}
3989
+				}
3990
+				$op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
3991
+				$where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
3992
+			}
3993
+		}
3994
+		return $where_clauses ? implode($glue, $where_clauses) : '';
3995
+	}
3996
+
3997
+
3998
+
3999
+	/**
4000
+	 * Takes the input parameter and extract the table name (alias) and column name
4001
+	 *
4002
+	 * @param array $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4003
+	 * @throws EE_Error
4004
+	 * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
4005
+	 */
4006
+	private function _deduce_column_name_from_query_param($query_param)
4007
+	{
4008
+		$field = $this->_deduce_field_from_query_param($query_param);
4009
+		if ($field) {
4010
+			$table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4011
+				$query_param);
4012
+			return $table_alias_prefix . $field->get_qualified_column();
4013
+		} elseif (array_key_exists($query_param, $this->_custom_selections)) {
4014
+			//maybe it's custom selection item?
4015
+			//if so, just use it as the "column name"
4016
+			return $query_param;
4017
+		} else {
4018
+			throw new EE_Error(sprintf(__("%s is not a valid field on this model, nor a custom selection (%s)",
4019
+				"event_espresso"), $query_param, implode(",", $this->_custom_selections)));
4020
+		}
4021
+	}
4022
+
4023
+
4024
+
4025
+	/**
4026
+	 * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
4027
+	 * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
4028
+	 * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
4029
+	 * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
4030
+	 *
4031
+	 * @param string $condition_query_param_key
4032
+	 * @return string
4033
+	 */
4034
+	private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
4035
+	{
4036
+		$pos_of_star = strpos($condition_query_param_key, '*');
4037
+		if ($pos_of_star === false) {
4038
+			return $condition_query_param_key;
4039
+		} else {
4040
+			$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
4041
+			return $condition_query_param_sans_star;
4042
+		}
4043
+	}
4044
+
4045
+
4046
+
4047
+	/**
4048
+	 * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
4049
+	 *
4050
+	 * @param                            mixed      array | string    $op_and_value
4051
+	 * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
4052
+	 * @throws EE_Error
4053
+	 * @return string
4054
+	 */
4055
+	private function _construct_op_and_value($op_and_value, $field_obj)
4056
+	{
4057
+		if (is_array($op_and_value)) {
4058
+			$operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4059
+			if (! $operator) {
4060
+				$php_array_like_string = array();
4061
+				foreach ($op_and_value as $key => $value) {
4062
+					$php_array_like_string[] = "$key=>$value";
4063
+				}
4064
+				throw new EE_Error(
4065
+					sprintf(
4066
+						__(
4067
+							"You setup a query parameter like you were going to specify an operator, but didn't. You provided '(%s)', but the operator should be at array key index 0 (eg array('>',32))",
4068
+							"event_espresso"
4069
+						),
4070
+						implode(",", $php_array_like_string)
4071
+					)
4072
+				);
4073
+			}
4074
+			$value = isset($op_and_value[1]) ? $op_and_value[1] : null;
4075
+		} else {
4076
+			$operator = '=';
4077
+			$value = $op_and_value;
4078
+		}
4079
+		//check to see if the value is actually another field
4080
+		if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4081
+			return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4082
+		} elseif (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4083
+			//in this case, the value should be an array, or at least a comma-separated list
4084
+			//it will need to handle a little differently
4085
+			$cleaned_value = $this->_construct_in_value($value, $field_obj);
4086
+			//note: $cleaned_value has already been run through $wpdb->prepare()
4087
+			return $operator . SP . $cleaned_value;
4088
+		} elseif (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4089
+			//the value should be an array with count of two.
4090
+			if (count($value) !== 2) {
4091
+				throw new EE_Error(
4092
+					sprintf(
4093
+						__(
4094
+							"The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
4095
+							'event_espresso'
4096
+						),
4097
+						"BETWEEN"
4098
+					)
4099
+				);
4100
+			}
4101
+			$cleaned_value = $this->_construct_between_value($value, $field_obj);
4102
+			return $operator . SP . $cleaned_value;
4103
+		} elseif (in_array($operator, $this->_null_style_operators)) {
4104
+			if ($value !== null) {
4105
+				throw new EE_Error(
4106
+					sprintf(
4107
+						__(
4108
+							"You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
4109
+							"event_espresso"
4110
+						),
4111
+						$value,
4112
+						$operator
4113
+					)
4114
+				);
4115
+			}
4116
+			return $operator;
4117
+		} elseif ($operator === 'LIKE' && ! is_array($value)) {
4118
+			//if the operator is 'LIKE', we want to allow percent signs (%) and not
4119
+			//remove other junk. So just treat it as a string.
4120
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4121
+		} elseif (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4122
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4123
+		} elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4124
+			throw new EE_Error(
4125
+				sprintf(
4126
+					__(
4127
+						"Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
4128
+						'event_espresso'
4129
+					),
4130
+					$operator,
4131
+					$operator
4132
+				)
4133
+			);
4134
+		} elseif (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4135
+			throw new EE_Error(
4136
+				sprintf(
4137
+					__(
4138
+						"Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
4139
+						'event_espresso'
4140
+					),
4141
+					$operator,
4142
+					$operator
4143
+				)
4144
+			);
4145
+		} else {
4146
+			throw new EE_Error(
4147
+				sprintf(
4148
+					__(
4149
+						"It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
4150
+						"event_espresso"
4151
+					),
4152
+					http_build_query($op_and_value)
4153
+				)
4154
+			);
4155
+		}
4156
+	}
4157
+
4158
+
4159
+
4160
+	/**
4161
+	 * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
4162
+	 *
4163
+	 * @param array                      $values
4164
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
4165
+	 *                                              '%s'
4166
+	 * @return string
4167
+	 * @throws \EE_Error
4168
+	 */
4169
+	public function _construct_between_value($values, $field_obj)
4170
+	{
4171
+		$cleaned_values = array();
4172
+		foreach ($values as $value) {
4173
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4174
+		}
4175
+		return $cleaned_values[0] . " AND " . $cleaned_values[1];
4176
+	}
4177
+
4178
+
4179
+
4180
+	/**
4181
+	 * Takes an array or a comma-separated list of $values and cleans them
4182
+	 * according to $data_type using $wpdb->prepare, and then makes the list a
4183
+	 * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4184
+	 * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4185
+	 * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4186
+	 *
4187
+	 * @param mixed                      $values    array or comma-separated string
4188
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4189
+	 * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4190
+	 * @throws \EE_Error
4191
+	 */
4192
+	public function _construct_in_value($values, $field_obj)
4193
+	{
4194
+		//check if the value is a CSV list
4195
+		if (is_string($values)) {
4196
+			//in which case, turn it into an array
4197
+			$values = explode(",", $values);
4198
+		}
4199
+		$cleaned_values = array();
4200
+		foreach ($values as $value) {
4201
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4202
+		}
4203
+		//we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4204
+		//but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4205
+		//which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4206
+		if (empty($cleaned_values)) {
4207
+			$all_fields = $this->field_settings();
4208
+			$a_field = array_shift($all_fields);
4209
+			$main_table = $this->_get_main_table();
4210
+			$cleaned_values[] = "SELECT "
4211
+								. $a_field->get_table_column()
4212
+								. " FROM "
4213
+								. $main_table->get_table_name()
4214
+								. " WHERE FALSE";
4215
+		}
4216
+		return "(" . implode(",", $cleaned_values) . ")";
4217
+	}
4218
+
4219
+
4220
+
4221
+	/**
4222
+	 * @param mixed                      $value
4223
+	 * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4224
+	 * @throws EE_Error
4225
+	 * @return false|null|string
4226
+	 */
4227
+	private function _wpdb_prepare_using_field($value, $field_obj)
4228
+	{
4229
+		/** @type WPDB $wpdb */
4230
+		global $wpdb;
4231
+		if ($field_obj instanceof EE_Model_Field_Base) {
4232
+			return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4233
+				$this->_prepare_value_for_use_in_db($value, $field_obj));
4234
+		} else {//$field_obj should really just be a data type
4235
+			if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4236
+				throw new EE_Error(sprintf(__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4237
+					$field_obj, implode(",", $this->_valid_wpdb_data_types)));
4238
+			}
4239
+			return $wpdb->prepare($field_obj, $value);
4240
+		}
4241
+	}
4242
+
4243
+
4244
+
4245
+	/**
4246
+	 * Takes the input parameter and finds the model field that it indicates.
4247
+	 *
4248
+	 * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4249
+	 * @throws EE_Error
4250
+	 * @return EE_Model_Field_Base
4251
+	 */
4252
+	protected function _deduce_field_from_query_param($query_param_name)
4253
+	{
4254
+		//ok, now proceed with deducing which part is the model's name, and which is the field's name
4255
+		//which will help us find the database table and column
4256
+		$query_param_parts = explode(".", $query_param_name);
4257
+		if (empty($query_param_parts)) {
4258
+			throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4259
+				'event_espresso'), $query_param_name));
4260
+		}
4261
+		$number_of_parts = count($query_param_parts);
4262
+		$last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4263
+		if ($number_of_parts === 1) {
4264
+			$field_name = $last_query_param_part;
4265
+			$model_obj = $this;
4266
+		} else {// $number_of_parts >= 2
4267
+			//the last part is the column name, and there are only 2parts. therefore...
4268
+			$field_name = $last_query_param_part;
4269
+			$model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4270
+		}
4271
+		try {
4272
+			return $model_obj->field_settings_for($field_name);
4273
+		} catch (EE_Error $e) {
4274
+			return null;
4275
+		}
4276
+	}
4277
+
4278
+
4279
+
4280
+	/**
4281
+	 * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4282
+	 * alias and column which corresponds to it
4283
+	 *
4284
+	 * @param string $field_name
4285
+	 * @throws EE_Error
4286
+	 * @return string
4287
+	 */
4288
+	public function _get_qualified_column_for_field($field_name)
4289
+	{
4290
+		$all_fields = $this->field_settings();
4291
+		$field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4292
+		if ($field) {
4293
+			return $field->get_qualified_column();
4294
+		} else {
4295
+			throw new EE_Error(sprintf(__("There is no field titled %s on model %s. Either the query trying to use it is bad, or you need to add it to the list of fields on the model.",
4296
+				'event_espresso'), $field_name, get_class($this)));
4297
+		}
4298
+	}
4299
+
4300
+
4301
+
4302
+	/**
4303
+	 * constructs the select use on special limit joins
4304
+	 * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4305
+	 * its setup so the select query will be setup on and just doing the special select join off of the primary table
4306
+	 * (as that is typically where the limits would be set).
4307
+	 *
4308
+	 * @param  string       $table_alias The table the select is being built for
4309
+	 * @param  mixed|string $limit       The limit for this select
4310
+	 * @return string                The final select join element for the query.
4311
+	 */
4312
+	public function _construct_limit_join_select($table_alias, $limit)
4313
+	{
4314
+		$SQL = '';
4315
+		foreach ($this->_tables as $table_obj) {
4316
+			if ($table_obj instanceof EE_Primary_Table) {
4317
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4318
+					? $table_obj->get_select_join_limit($limit)
4319
+					: SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4320
+			} elseif ($table_obj instanceof EE_Secondary_Table) {
4321
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4322
+					? $table_obj->get_select_join_limit_join($limit)
4323
+					: SP . $table_obj->get_join_sql($table_alias) . SP;
4324
+			}
4325
+		}
4326
+		return $SQL;
4327
+	}
4328
+
4329
+
4330
+
4331
+	/**
4332
+	 * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4333
+	 * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4334
+	 *
4335
+	 * @return string SQL
4336
+	 * @throws \EE_Error
4337
+	 */
4338
+	public function _construct_internal_join()
4339
+	{
4340
+		$SQL = $this->_get_main_table()->get_table_sql();
4341
+		$SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4342
+		return $SQL;
4343
+	}
4344
+
4345
+
4346
+
4347
+	/**
4348
+	 * Constructs the SQL for joining all the tables on this model.
4349
+	 * Normally $alias should be the primary table's alias, but in cases where
4350
+	 * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4351
+	 * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4352
+	 * alias, this will construct SQL like:
4353
+	 * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4354
+	 * With $alias being a secondary table's alias, this will construct SQL like:
4355
+	 * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4356
+	 *
4357
+	 * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4358
+	 * @return string
4359
+	 */
4360
+	public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4361
+	{
4362
+		$SQL = '';
4363
+		$alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4364
+		foreach ($this->_tables as $table_obj) {
4365
+			if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4366
+				if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4367
+					//so we're joining to this table, meaning the table is already in
4368
+					//the FROM statement, BUT the primary table isn't. So we want
4369
+					//to add the inverse join sql
4370
+					$SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4371
+				} else {
4372
+					//just add a regular JOIN to this table from the primary table
4373
+					$SQL .= $table_obj->get_join_sql($alias_prefixed);
4374
+				}
4375
+			}//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4376
+		}
4377
+		return $SQL;
4378
+	}
4379
+
4380
+
4381
+
4382
+	/**
4383
+	 * Gets an array for storing all the data types on the next-to-be-executed-query.
4384
+	 * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4385
+	 * their data type (eg, '%s', '%d', etc)
4386
+	 *
4387
+	 * @return array
4388
+	 */
4389
+	public function _get_data_types()
4390
+	{
4391
+		$data_types = array();
4392
+		foreach ($this->field_settings() as $field_obj) {
4393
+			//$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4394
+			/** @var $field_obj EE_Model_Field_Base */
4395
+			$data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4396
+		}
4397
+		return $data_types;
4398
+	}
4399
+
4400
+
4401
+
4402
+	/**
4403
+	 * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4404
+	 *
4405
+	 * @param string $model_name
4406
+	 * @throws EE_Error
4407
+	 * @return EEM_Base
4408
+	 */
4409
+	public function get_related_model_obj($model_name)
4410
+	{
4411
+		$model_classname = "EEM_" . $model_name;
4412
+		if (! class_exists($model_classname)) {
4413
+			throw new EE_Error(sprintf(__("You specified a related model named %s in your query. No such model exists, if it did, it would have the classname %s",
4414
+				'event_espresso'), $model_name, $model_classname));
4415
+		}
4416
+		return call_user_func($model_classname . "::instance");
4417
+	}
4418
+
4419
+
4420
+
4421
+	/**
4422
+	 * Returns the array of EE_ModelRelations for this model.
4423
+	 *
4424
+	 * @return EE_Model_Relation_Base[]
4425
+	 */
4426
+	public function relation_settings()
4427
+	{
4428
+		return $this->_model_relations;
4429
+	}
4430
+
4431
+
4432
+
4433
+	/**
4434
+	 * Gets all related models that this model BELONGS TO. Handy to know sometimes
4435
+	 * because without THOSE models, this model probably doesn't have much purpose.
4436
+	 * (Eg, without an event, datetimes have little purpose.)
4437
+	 *
4438
+	 * @return EE_Belongs_To_Relation[]
4439
+	 */
4440
+	public function belongs_to_relations()
4441
+	{
4442
+		$belongs_to_relations = array();
4443
+		foreach ($this->relation_settings() as $model_name => $relation_obj) {
4444
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
4445
+				$belongs_to_relations[$model_name] = $relation_obj;
4446
+			}
4447
+		}
4448
+		return $belongs_to_relations;
4449
+	}
4450
+
4451
+
4452
+
4453
+	/**
4454
+	 * Returns the specified EE_Model_Relation, or throws an exception
4455
+	 *
4456
+	 * @param string $relation_name name of relation, key in $this->_relatedModels
4457
+	 * @throws EE_Error
4458
+	 * @return EE_Model_Relation_Base
4459
+	 */
4460
+	public function related_settings_for($relation_name)
4461
+	{
4462
+		$relatedModels = $this->relation_settings();
4463
+		if (! array_key_exists($relation_name, $relatedModels)) {
4464
+			throw new EE_Error(
4465
+				sprintf(
4466
+					__('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4467
+						'event_espresso'),
4468
+					$relation_name,
4469
+					$this->_get_class_name(),
4470
+					implode(', ', array_keys($relatedModels))
4471
+				)
4472
+			);
4473
+		}
4474
+		return $relatedModels[$relation_name];
4475
+	}
4476
+
4477
+
4478
+
4479
+	/**
4480
+	 * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4481
+	 * fields
4482
+	 *
4483
+	 * @param string $fieldName
4484
+	 * @throws EE_Error
4485
+	 * @return EE_Model_Field_Base
4486
+	 */
4487
+	public function field_settings_for($fieldName)
4488
+	{
4489
+		$fieldSettings = $this->field_settings(true);
4490
+		if (! array_key_exists($fieldName, $fieldSettings)) {
4491
+			throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4492
+				get_class($this)));
4493
+		}
4494
+		return $fieldSettings[$fieldName];
4495
+	}
4496
+
4497
+
4498
+
4499
+	/**
4500
+	 * Checks if this field exists on this model
4501
+	 *
4502
+	 * @param string $fieldName a key in the model's _field_settings array
4503
+	 * @return boolean
4504
+	 */
4505
+	public function has_field($fieldName)
4506
+	{
4507
+		$fieldSettings = $this->field_settings(true);
4508
+		if (isset($fieldSettings[$fieldName])) {
4509
+			return true;
4510
+		} else {
4511
+			return false;
4512
+		}
4513
+	}
4514
+
4515
+
4516
+
4517
+	/**
4518
+	 * Returns whether or not this model has a relation to the specified model
4519
+	 *
4520
+	 * @param string $relation_name possibly one of the keys in the relation_settings array
4521
+	 * @return boolean
4522
+	 */
4523
+	public function has_relation($relation_name)
4524
+	{
4525
+		$relations = $this->relation_settings();
4526
+		if (isset($relations[$relation_name])) {
4527
+			return true;
4528
+		} else {
4529
+			return false;
4530
+		}
4531
+	}
4532
+
4533
+
4534
+
4535
+	/**
4536
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4537
+	 * Eg, on EE_Answer that would be ANS_ID field object
4538
+	 *
4539
+	 * @param $field_obj
4540
+	 * @return boolean
4541
+	 */
4542
+	public function is_primary_key_field($field_obj)
4543
+	{
4544
+		return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4545
+	}
4546
+
4547
+
4548
+
4549
+	/**
4550
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4551
+	 * Eg, on EE_Answer that would be ANS_ID field object
4552
+	 *
4553
+	 * @return EE_Model_Field_Base
4554
+	 * @throws EE_Error
4555
+	 */
4556
+	public function get_primary_key_field()
4557
+	{
4558
+		if ($this->_primary_key_field === null) {
4559
+			foreach ($this->field_settings(true) as $field_obj) {
4560
+				if ($this->is_primary_key_field($field_obj)) {
4561
+					$this->_primary_key_field = $field_obj;
4562
+					break;
4563
+				}
4564
+			}
4565
+			if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4566
+				throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4567
+					get_class($this)));
4568
+			}
4569
+		}
4570
+		return $this->_primary_key_field;
4571
+	}
4572
+
4573
+
4574
+
4575
+	/**
4576
+	 * Returns whether or not not there is a primary key on this model.
4577
+	 * Internally does some caching.
4578
+	 *
4579
+	 * @return boolean
4580
+	 */
4581
+	public function has_primary_key_field()
4582
+	{
4583
+		if ($this->_has_primary_key_field === null) {
4584
+			try {
4585
+				$this->get_primary_key_field();
4586
+				$this->_has_primary_key_field = true;
4587
+			} catch (EE_Error $e) {
4588
+				$this->_has_primary_key_field = false;
4589
+			}
4590
+		}
4591
+		return $this->_has_primary_key_field;
4592
+	}
4593
+
4594
+
4595
+
4596
+	/**
4597
+	 * Finds the first field of type $field_class_name.
4598
+	 *
4599
+	 * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4600
+	 *                                 EE_Foreign_Key_Field, etc
4601
+	 * @return EE_Model_Field_Base or null if none is found
4602
+	 */
4603
+	public function get_a_field_of_type($field_class_name)
4604
+	{
4605
+		foreach ($this->field_settings() as $field) {
4606
+			if ($field instanceof $field_class_name) {
4607
+				return $field;
4608
+			}
4609
+		}
4610
+		return null;
4611
+	}
4612
+
4613
+
4614
+
4615
+	/**
4616
+	 * Gets a foreign key field pointing to model.
4617
+	 *
4618
+	 * @param string $model_name eg Event, Registration, not EEM_Event
4619
+	 * @return EE_Foreign_Key_Field_Base
4620
+	 * @throws EE_Error
4621
+	 */
4622
+	public function get_foreign_key_to($model_name)
4623
+	{
4624
+		if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4625
+			foreach ($this->field_settings() as $field) {
4626
+				if (
4627
+					$field instanceof EE_Foreign_Key_Field_Base
4628
+					&& in_array($model_name, $field->get_model_names_pointed_to())
4629
+				) {
4630
+					$this->_cache_foreign_key_to_fields[$model_name] = $field;
4631
+					break;
4632
+				}
4633
+			}
4634
+			if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4635
+				throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4636
+					'event_espresso'), $model_name, get_class($this)));
4637
+			}
4638
+		}
4639
+		return $this->_cache_foreign_key_to_fields[$model_name];
4640
+	}
4641
+
4642
+
4643
+
4644
+	/**
4645
+	 * Gets the actual table for the table alias
4646
+	 *
4647
+	 * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4648
+	 *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4649
+	 *                            Either one works
4650
+	 * @return EE_Table_Base
4651
+	 */
4652
+	public function get_table_for_alias($table_alias)
4653
+	{
4654
+		$table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4655
+		return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4656
+	}
4657
+
4658
+
4659
+
4660
+	/**
4661
+	 * Returns a flat array of all field son this model, instead of organizing them
4662
+	 * by table_alias as they are in the constructor.
4663
+	 *
4664
+	 * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4665
+	 * @return EE_Model_Field_Base[] where the keys are the field's name
4666
+	 */
4667
+	public function field_settings($include_db_only_fields = false)
4668
+	{
4669
+		if ($include_db_only_fields) {
4670
+			if ($this->_cached_fields === null) {
4671
+				$this->_cached_fields = array();
4672
+				foreach ($this->_fields as $fields_corresponding_to_table) {
4673
+					foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4674
+						$this->_cached_fields[$field_name] = $field_obj;
4675
+					}
4676
+				}
4677
+			}
4678
+			return $this->_cached_fields;
4679
+		} else {
4680
+			if ($this->_cached_fields_non_db_only === null) {
4681
+				$this->_cached_fields_non_db_only = array();
4682
+				foreach ($this->_fields as $fields_corresponding_to_table) {
4683
+					foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4684
+						/** @var $field_obj EE_Model_Field_Base */
4685
+						if (! $field_obj->is_db_only_field()) {
4686
+							$this->_cached_fields_non_db_only[$field_name] = $field_obj;
4687
+						}
4688
+					}
4689
+				}
4690
+			}
4691
+			return $this->_cached_fields_non_db_only;
4692
+		}
4693
+	}
4694
+
4695
+
4696
+
4697
+	/**
4698
+	 *        cycle though array of attendees and create objects out of each item
4699
+	 *
4700
+	 * @access        private
4701
+	 * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4702
+	 * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4703
+	 *                           numerically indexed)
4704
+	 * @throws \EE_Error
4705
+	 */
4706
+	protected function _create_objects($rows = array())
4707
+	{
4708
+		$array_of_objects = array();
4709
+		if (empty($rows)) {
4710
+			return array();
4711
+		}
4712
+		$count_if_model_has_no_primary_key = 0;
4713
+		$has_primary_key = $this->has_primary_key_field();
4714
+		$primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4715
+		foreach ((array)$rows as $row) {
4716
+			if (empty($row)) {
4717
+				//wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4718
+				return array();
4719
+			}
4720
+			//check if we've already set this object in the results array,
4721
+			//in which case there's no need to process it further (again)
4722
+			if ($has_primary_key) {
4723
+				$table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4724
+					$row,
4725
+					$primary_key_field->get_qualified_column(),
4726
+					$primary_key_field->get_table_column()
4727
+				);
4728
+				if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4729
+					continue;
4730
+				}
4731
+			}
4732
+			$classInstance = $this->instantiate_class_from_array_or_object($row);
4733
+			if (! $classInstance) {
4734
+				throw new EE_Error(
4735
+					sprintf(
4736
+						__('Could not create instance of class %s from row %s', 'event_espresso'),
4737
+						$this->get_this_model_name(),
4738
+						http_build_query($row)
4739
+					)
4740
+				);
4741
+			}
4742
+			//set the timezone on the instantiated objects
4743
+			$classInstance->set_timezone($this->_timezone);
4744
+			//make sure if there is any timezone setting present that we set the timezone for the object
4745
+			$key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4746
+			$array_of_objects[$key] = $classInstance;
4747
+			//also, for all the relations of type BelongsTo, see if we can cache
4748
+			//those related models
4749
+			//(we could do this for other relations too, but if there are conditions
4750
+			//that filtered out some fo the results, then we'd be caching an incomplete set
4751
+			//so it requires a little more thought than just caching them immediately...)
4752
+			foreach ($this->_model_relations as $modelName => $relation_obj) {
4753
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
4754
+					//check if this model's INFO is present. If so, cache it on the model
4755
+					$other_model = $relation_obj->get_other_model();
4756
+					$other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4757
+					//if we managed to make a model object from the results, cache it on the main model object
4758
+					if ($other_model_obj_maybe) {
4759
+						//set timezone on these other model objects if they are present
4760
+						$other_model_obj_maybe->set_timezone($this->_timezone);
4761
+						$classInstance->cache($modelName, $other_model_obj_maybe);
4762
+					}
4763
+				}
4764
+			}
4765
+		}
4766
+		return $array_of_objects;
4767
+	}
4768
+
4769
+
4770
+
4771
+	/**
4772
+	 * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4773
+	 * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4774
+	 * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4775
+	 * object (as set in the model_field!).
4776
+	 *
4777
+	 * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4778
+	 */
4779
+	public function create_default_object()
4780
+	{
4781
+		$this_model_fields_and_values = array();
4782
+		//setup the row using default values;
4783
+		foreach ($this->field_settings() as $field_name => $field_obj) {
4784
+			$this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
4785
+		}
4786
+		$className = $this->_get_class_name();
4787
+		$classInstance = EE_Registry::instance()
4788
+									->load_class($className, array($this_model_fields_and_values), false, false);
4789
+		return $classInstance;
4790
+	}
4791
+
4792
+
4793
+
4794
+	/**
4795
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
4796
+	 *                             or an stdClass where each property is the name of a column,
4797
+	 * @return EE_Base_Class
4798
+	 * @throws \EE_Error
4799
+	 */
4800
+	public function instantiate_class_from_array_or_object($cols_n_values)
4801
+	{
4802
+		if (! is_array($cols_n_values) && is_object($cols_n_values)) {
4803
+			$cols_n_values = get_object_vars($cols_n_values);
4804
+		}
4805
+		$primary_key = null;
4806
+		//make sure the array only has keys that are fields/columns on this model
4807
+		$this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4808
+		if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
4809
+			$primary_key = $this_model_fields_n_values[$this->primary_key_name()];
4810
+		}
4811
+		$className = $this->_get_class_name();
4812
+		//check we actually found results that we can use to build our model object
4813
+		//if not, return null
4814
+		if ($this->has_primary_key_field()) {
4815
+			if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
4816
+				return null;
4817
+			}
4818
+		} else if ($this->unique_indexes()) {
4819
+			$first_column = reset($this_model_fields_n_values);
4820
+			if (empty($first_column)) {
4821
+				return null;
4822
+			}
4823
+		}
4824
+		// if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
4825
+		if ($primary_key) {
4826
+			$classInstance = $this->get_from_entity_map($primary_key);
4827
+			if (! $classInstance) {
4828
+				$classInstance = EE_Registry::instance()
4829
+											->load_class($className,
4830
+												array($this_model_fields_n_values, $this->_timezone), true, false);
4831
+				// add this new object to the entity map
4832
+				$classInstance = $this->add_to_entity_map($classInstance);
4833
+			}
4834
+		} else {
4835
+			$classInstance = EE_Registry::instance()
4836
+										->load_class($className, array($this_model_fields_n_values, $this->_timezone),
4837
+											true, false);
4838
+		}
4839
+		//it is entirely possible that the instantiated class object has a set timezone_string db field and has set it's internal _timezone property accordingly (see new_instance_from_db in model objects particularly EE_Event for example).  In this case, we want to make sure the model object doesn't have its timezone string overwritten by any timezone property currently set here on the model so, we intentionally override the model _timezone property with the model_object timezone property.
4840
+		$this->set_timezone($classInstance->get_timezone());
4841
+		return $classInstance;
4842
+	}
4843
+
4844
+
4845
+
4846
+	/**
4847
+	 * Gets the model object from the  entity map if it exists
4848
+	 *
4849
+	 * @param int|string $id the ID of the model object
4850
+	 * @return EE_Base_Class
4851
+	 */
4852
+	public function get_from_entity_map($id)
4853
+	{
4854
+		return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
4855
+			? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
4856
+	}
4857
+
4858
+
4859
+
4860
+	/**
4861
+	 * add_to_entity_map
4862
+	 * Adds the object to the model's entity mappings
4863
+	 *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
4864
+	 *        and for the remainder of the request, it's even more up-to-date than what's in the database.
4865
+	 *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
4866
+	 *        If the database gets updated directly and you want the entity mapper to reflect that change,
4867
+	 *        then this method should be called immediately after the update query
4868
+	 * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
4869
+	 * so on multisite, the entity map is specific to the query being done for a specific site.
4870
+	 *
4871
+	 * @param    EE_Base_Class $object
4872
+	 * @throws EE_Error
4873
+	 * @return \EE_Base_Class
4874
+	 */
4875
+	public function add_to_entity_map(EE_Base_Class $object)
4876
+	{
4877
+		$className = $this->_get_class_name();
4878
+		if (! $object instanceof $className) {
4879
+			throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
4880
+				is_object($object) ? get_class($object) : $object, $className));
4881
+		}
4882
+		/** @var $object EE_Base_Class */
4883
+		if (! $object->ID()) {
4884
+			throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
4885
+				"event_espresso"), get_class($this)));
4886
+		}
4887
+		// double check it's not already there
4888
+		$classInstance = $this->get_from_entity_map($object->ID());
4889
+		if ($classInstance) {
4890
+			return $classInstance;
4891
+		} else {
4892
+			$this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
4893
+			return $object;
4894
+		}
4895
+	}
4896
+
4897
+
4898
+
4899
+	/**
4900
+	 * if a valid identifier is provided, then that entity is unset from the entity map,
4901
+	 * if no identifier is provided, then the entire entity map is emptied
4902
+	 *
4903
+	 * @param int|string $id the ID of the model object
4904
+	 * @return boolean
4905
+	 */
4906
+	public function clear_entity_map($id = null)
4907
+	{
4908
+		if (empty($id)) {
4909
+			$this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
4910
+			return true;
4911
+		}
4912
+		if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
4913
+			unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
4914
+			return true;
4915
+		}
4916
+		return false;
4917
+	}
4918
+
4919
+
4920
+
4921
+	/**
4922
+	 * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
4923
+	 * Given an array where keys are column (or column alias) names and values,
4924
+	 * returns an array of their corresponding field names and database values
4925
+	 *
4926
+	 * @param array $cols_n_values
4927
+	 * @return array
4928
+	 */
4929
+	public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
4930
+	{
4931
+		return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4932
+	}
4933
+
4934
+
4935
+
4936
+	/**
4937
+	 * _deduce_fields_n_values_from_cols_n_values
4938
+	 * Given an array where keys are column (or column alias) names and values,
4939
+	 * returns an array of their corresponding field names and database values
4940
+	 *
4941
+	 * @param string $cols_n_values
4942
+	 * @return array
4943
+	 */
4944
+	protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
4945
+	{
4946
+		$this_model_fields_n_values = array();
4947
+		foreach ($this->get_tables() as $table_alias => $table_obj) {
4948
+			$table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
4949
+				$table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
4950
+			//there is a primary key on this table and its not set. Use defaults for all its columns
4951
+			if ($table_pk_value === null && $table_obj->get_pk_column()) {
4952
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
4953
+					if (! $field_obj->is_db_only_field()) {
4954
+						//prepare field as if its coming from db
4955
+						$prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
4956
+						$this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
4957
+					}
4958
+				}
4959
+			} else {
4960
+				//the table's rows existed. Use their values
4961
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
4962
+					if (! $field_obj->is_db_only_field()) {
4963
+						$this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
4964
+							$cols_n_values, $field_obj->get_qualified_column(),
4965
+							$field_obj->get_table_column()
4966
+						);
4967
+					}
4968
+				}
4969
+			}
4970
+		}
4971
+		return $this_model_fields_n_values;
4972
+	}
4973
+
4974
+
4975
+
4976
+	/**
4977
+	 * @param $cols_n_values
4978
+	 * @param $qualified_column
4979
+	 * @param $regular_column
4980
+	 * @return null
4981
+	 */
4982
+	protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
4983
+	{
4984
+		$value = null;
4985
+		//ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
4986
+		//does the field on the model relate to this column retrieved from the db?
4987
+		//or is it a db-only field? (not relating to the model)
4988
+		if (isset($cols_n_values[$qualified_column])) {
4989
+			$value = $cols_n_values[$qualified_column];
4990
+		} elseif (isset($cols_n_values[$regular_column])) {
4991
+			$value = $cols_n_values[$regular_column];
4992
+		}
4993
+		return $value;
4994
+	}
4995
+
4996
+
4997
+
4998
+	/**
4999
+	 * refresh_entity_map_from_db
5000
+	 * Makes sure the model object in the entity map at $id assumes the values
5001
+	 * of the database (opposite of EE_base_Class::save())
5002
+	 *
5003
+	 * @param int|string $id
5004
+	 * @return EE_Base_Class
5005
+	 * @throws \EE_Error
5006
+	 */
5007
+	public function refresh_entity_map_from_db($id)
5008
+	{
5009
+		$obj_in_map = $this->get_from_entity_map($id);
5010
+		if ($obj_in_map) {
5011
+			$wpdb_results = $this->_get_all_wpdb_results(
5012
+				array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
5013
+			);
5014
+			if ($wpdb_results && is_array($wpdb_results)) {
5015
+				$one_row = reset($wpdb_results);
5016
+				foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
5017
+					$obj_in_map->set_from_db($field_name, $db_value);
5018
+				}
5019
+				//clear the cache of related model objects
5020
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5021
+					$obj_in_map->clear_cache($relation_name, null, true);
5022
+				}
5023
+			}
5024
+			$this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
5025
+			return $obj_in_map;
5026
+		} else {
5027
+			return $this->get_one_by_ID($id);
5028
+		}
5029
+	}
5030
+
5031
+
5032
+
5033
+	/**
5034
+	 * refresh_entity_map_with
5035
+	 * Leaves the entry in the entity map alone, but updates it to match the provided
5036
+	 * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
5037
+	 * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
5038
+	 * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
5039
+	 *
5040
+	 * @param int|string    $id
5041
+	 * @param EE_Base_Class $replacing_model_obj
5042
+	 * @return \EE_Base_Class
5043
+	 * @throws \EE_Error
5044
+	 */
5045
+	public function refresh_entity_map_with($id, $replacing_model_obj)
5046
+	{
5047
+		$obj_in_map = $this->get_from_entity_map($id);
5048
+		if ($obj_in_map) {
5049
+			if ($replacing_model_obj instanceof EE_Base_Class) {
5050
+				foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
5051
+					$obj_in_map->set($field_name, $value);
5052
+				}
5053
+				//make the model object in the entity map's cache match the $replacing_model_obj
5054
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5055
+					$obj_in_map->clear_cache($relation_name, null, true);
5056
+					foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
5057
+						$obj_in_map->cache($relation_name, $cached_obj, $cache_id);
5058
+					}
5059
+				}
5060
+			}
5061
+			return $obj_in_map;
5062
+		} else {
5063
+			$this->add_to_entity_map($replacing_model_obj);
5064
+			return $replacing_model_obj;
5065
+		}
5066
+	}
5067
+
5068
+
5069
+
5070
+	/**
5071
+	 * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
5072
+	 * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
5073
+	 * require_once($this->_getClassName().".class.php");
5074
+	 *
5075
+	 * @return string
5076
+	 */
5077
+	private function _get_class_name()
5078
+	{
5079
+		return "EE_" . $this->get_this_model_name();
5080
+	}
5081
+
5082
+
5083
+
5084
+	/**
5085
+	 * Get the name of the items this model represents, for the quantity specified. Eg,
5086
+	 * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
5087
+	 * it would be 'Events'.
5088
+	 *
5089
+	 * @param int $quantity
5090
+	 * @return string
5091
+	 */
5092
+	public function item_name($quantity = 1)
5093
+	{
5094
+		return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5095
+	}
5096
+
5097
+
5098
+
5099
+	/**
5100
+	 * Very handy general function to allow for plugins to extend any child of EE_TempBase.
5101
+	 * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
5102
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
5103
+	 * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
5104
+	 * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
5105
+	 * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
5106
+	 * was called, and an array of the original arguments passed to the function. Whatever their callback function
5107
+	 * returns will be returned by this function. Example: in functions.php (or in a plugin):
5108
+	 * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
5109
+	 * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
5110
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
5111
+	 *        return $previousReturnValue.$returnString;
5112
+	 * }
5113
+	 * require('EEM_Answer.model.php');
5114
+	 * $answer=EEM_Answer::instance();
5115
+	 * echo $answer->my_callback('monkeys',100);
5116
+	 * //will output "you called my_callback! and passed args:monkeys,100"
5117
+	 *
5118
+	 * @param string $methodName name of method which was called on a child of EE_TempBase, but which
5119
+	 * @param array  $args       array of original arguments passed to the function
5120
+	 * @throws EE_Error
5121
+	 * @return mixed whatever the plugin which calls add_filter decides
5122
+	 */
5123
+	public function __call($methodName, $args)
5124
+	{
5125
+		$className = get_class($this);
5126
+		$tagName = "FHEE__{$className}__{$methodName}";
5127
+		if (! has_filter($tagName)) {
5128
+			throw new EE_Error(
5129
+				sprintf(
5130
+					__('Method %1$s on model %2$s does not exist! You can create one with the following code in functions.php or in a plugin: %4$s function my_callback(%4$s \$previousReturnValue, EEM_Base \$object\ $argsArray=NULL ){%4$s     /*function body*/%4$s      return \$whatever;%4$s }%4$s add_filter( \'%3$s\', \'my_callback\', 10, 3 );',
5131
+						'event_espresso'),
5132
+					$methodName,
5133
+					$className,
5134
+					$tagName,
5135
+					'<br />'
5136
+				)
5137
+			);
5138
+		}
5139
+		return apply_filters($tagName, null, $this, $args);
5140
+	}
5141
+
5142
+
5143
+
5144
+	/**
5145
+	 * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
5146
+	 * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
5147
+	 *
5148
+	 * @param EE_Base_Class|string|int $base_class_obj_or_id either:
5149
+	 *                                                       the EE_Base_Class object that corresponds to this Model,
5150
+	 *                                                       the object's class name
5151
+	 *                                                       or object's ID
5152
+	 * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
5153
+	 *                                                       exists in the database. If it does not, we add it
5154
+	 * @throws EE_Error
5155
+	 * @return EE_Base_Class
5156
+	 */
5157
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
5158
+	{
5159
+		$className = $this->_get_class_name();
5160
+		if ($base_class_obj_or_id instanceof $className) {
5161
+			$model_object = $base_class_obj_or_id;
5162
+		} else {
5163
+			$primary_key_field = $this->get_primary_key_field();
5164
+			if (
5165
+				$primary_key_field instanceof EE_Primary_Key_Int_Field
5166
+				&& (
5167
+					is_int($base_class_obj_or_id)
5168
+					|| is_string($base_class_obj_or_id)
5169
+				)
5170
+			) {
5171
+				// assume it's an ID.
5172
+				// either a proper integer or a string representing an integer (eg "101" instead of 101)
5173
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
5174
+			} else if (
5175
+				$primary_key_field instanceof EE_Primary_Key_String_Field
5176
+				&& is_string($base_class_obj_or_id)
5177
+			) {
5178
+				// assume its a string representation of the object
5179
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
5180
+			} else {
5181
+				throw new EE_Error(
5182
+					sprintf(
5183
+						__(
5184
+							"'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5185
+							'event_espresso'
5186
+						),
5187
+						$base_class_obj_or_id,
5188
+						$this->_get_class_name(),
5189
+						print_r($base_class_obj_or_id, true)
5190
+					)
5191
+				);
5192
+			}
5193
+		}
5194
+		if ($ensure_is_in_db && $model_object->ID() !== null) {
5195
+			$model_object->save();
5196
+		}
5197
+		return $model_object;
5198
+	}
5199
+
5200
+
5201
+
5202
+	/**
5203
+	 * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5204
+	 * is a value of the this model's primary key. If it's an EE_Base_Class child,
5205
+	 * returns it ID.
5206
+	 *
5207
+	 * @param EE_Base_Class|int|string $base_class_obj_or_id
5208
+	 * @return int|string depending on the type of this model object's ID
5209
+	 * @throws EE_Error
5210
+	 */
5211
+	public function ensure_is_ID($base_class_obj_or_id)
5212
+	{
5213
+		$className = $this->_get_class_name();
5214
+		if ($base_class_obj_or_id instanceof $className) {
5215
+			/** @var $base_class_obj_or_id EE_Base_Class */
5216
+			$id = $base_class_obj_or_id->ID();
5217
+		} elseif (is_int($base_class_obj_or_id)) {
5218
+			//assume it's an ID
5219
+			$id = $base_class_obj_or_id;
5220
+		} elseif (is_string($base_class_obj_or_id)) {
5221
+			//assume its a string representation of the object
5222
+			$id = $base_class_obj_or_id;
5223
+		} else {
5224
+			throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5225
+				'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5226
+				print_r($base_class_obj_or_id, true)));
5227
+		}
5228
+		return $id;
5229
+	}
5230
+
5231
+
5232
+
5233
+	/**
5234
+	 * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5235
+	 * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5236
+	 * been sanitized and converted into the appropriate domain.
5237
+	 * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5238
+	 * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5239
+	 * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5240
+	 * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5241
+	 * $EVT = EEM_Event::instance(); $old_setting =
5242
+	 * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5243
+	 * $EVT->assume_values_already_prepared_by_model_object(true);
5244
+	 * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5245
+	 * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5246
+	 *
5247
+	 * @param int $values_already_prepared like one of the constants on EEM_Base
5248
+	 * @return void
5249
+	 */
5250
+	public function assume_values_already_prepared_by_model_object(
5251
+		$values_already_prepared = self::not_prepared_by_model_object
5252
+	) {
5253
+		$this->_values_already_prepared_by_model_object = $values_already_prepared;
5254
+	}
5255
+
5256
+
5257
+
5258
+	/**
5259
+	 * Read comments for assume_values_already_prepared_by_model_object()
5260
+	 *
5261
+	 * @return int
5262
+	 */
5263
+	public function get_assumption_concerning_values_already_prepared_by_model_object()
5264
+	{
5265
+		return $this->_values_already_prepared_by_model_object;
5266
+	}
5267
+
5268
+
5269
+
5270
+	/**
5271
+	 * Gets all the indexes on this model
5272
+	 *
5273
+	 * @return EE_Index[]
5274
+	 */
5275
+	public function indexes()
5276
+	{
5277
+		return $this->_indexes;
5278
+	}
5279
+
5280
+
5281
+
5282
+	/**
5283
+	 * Gets all the Unique Indexes on this model
5284
+	 *
5285
+	 * @return EE_Unique_Index[]
5286
+	 */
5287
+	public function unique_indexes()
5288
+	{
5289
+		$unique_indexes = array();
5290
+		foreach ($this->_indexes as $name => $index) {
5291
+			if ($index instanceof EE_Unique_Index) {
5292
+				$unique_indexes [$name] = $index;
5293
+			}
5294
+		}
5295
+		return $unique_indexes;
5296
+	}
5297
+
5298
+
5299
+
5300
+	/**
5301
+	 * Gets all the fields which, when combined, make the primary key.
5302
+	 * This is usually just an array with 1 element (the primary key), but in cases
5303
+	 * where there is no primary key, it's a combination of fields as defined
5304
+	 * on a primary index
5305
+	 *
5306
+	 * @return EE_Model_Field_Base[] indexed by the field's name
5307
+	 * @throws \EE_Error
5308
+	 */
5309
+	public function get_combined_primary_key_fields()
5310
+	{
5311
+		foreach ($this->indexes() as $index) {
5312
+			if ($index instanceof EE_Primary_Key_Index) {
5313
+				return $index->fields();
5314
+			}
5315
+		}
5316
+		return array($this->primary_key_name() => $this->get_primary_key_field());
5317
+	}
5318
+
5319
+
5320
+
5321
+	/**
5322
+	 * Used to build a primary key string (when the model has no primary key),
5323
+	 * which can be used a unique string to identify this model object.
5324
+	 *
5325
+	 * @param array $cols_n_values keys are field names, values are their values
5326
+	 * @return string
5327
+	 * @throws \EE_Error
5328
+	 */
5329
+	public function get_index_primary_key_string($cols_n_values)
5330
+	{
5331
+		$cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5332
+			$this->get_combined_primary_key_fields());
5333
+		return http_build_query($cols_n_values_for_primary_key_index);
5334
+	}
5335
+
5336
+
5337
+
5338
+	/**
5339
+	 * Gets the field values from the primary key string
5340
+	 *
5341
+	 * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5342
+	 * @param string $index_primary_key_string
5343
+	 * @return null|array
5344
+	 * @throws \EE_Error
5345
+	 */
5346
+	public function parse_index_primary_key_string($index_primary_key_string)
5347
+	{
5348
+		$key_fields = $this->get_combined_primary_key_fields();
5349
+		//check all of them are in the $id
5350
+		$key_vals_in_combined_pk = array();
5351
+		parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5352
+		foreach ($key_fields as $key_field_name => $field_obj) {
5353
+			if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5354
+				return null;
5355
+			}
5356
+		}
5357
+		return $key_vals_in_combined_pk;
5358
+	}
5359
+
5360
+
5361
+
5362
+	/**
5363
+	 * verifies that an array of key-value pairs for model fields has a key
5364
+	 * for each field comprising the primary key index
5365
+	 *
5366
+	 * @param array $key_vals
5367
+	 * @return boolean
5368
+	 * @throws \EE_Error
5369
+	 */
5370
+	public function has_all_combined_primary_key_fields($key_vals)
5371
+	{
5372
+		$keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5373
+		foreach ($keys_it_should_have as $key) {
5374
+			if (! isset($key_vals[$key])) {
5375
+				return false;
5376
+			}
5377
+		}
5378
+		return true;
5379
+	}
5380
+
5381
+
5382
+
5383
+	/**
5384
+	 * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5385
+	 * We consider something to be a copy if all the attributes match (except the ID, of course).
5386
+	 *
5387
+	 * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5388
+	 * @param array               $query_params                     like EEM_Base::get_all's query_params.
5389
+	 * @throws EE_Error
5390
+	 * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5391
+	 *                                                              indexed)
5392
+	 */
5393
+	public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5394
+	{
5395
+		if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5396
+			$attributes_array = $model_object_or_attributes_array->model_field_array();
5397
+		} elseif (is_array($model_object_or_attributes_array)) {
5398
+			$attributes_array = $model_object_or_attributes_array;
5399
+		} else {
5400
+			throw new EE_Error(sprintf(__("get_all_copies should be provided with either a model object or an array of field-value-pairs, but was given %s",
5401
+				"event_espresso"), $model_object_or_attributes_array));
5402
+		}
5403
+		//even copies obviously won't have the same ID, so remove the primary key
5404
+		//from the WHERE conditions for finding copies (if there is a primary key, of course)
5405
+		if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5406
+			unset($attributes_array[$this->primary_key_name()]);
5407
+		}
5408
+		if (isset($query_params[0])) {
5409
+			$query_params[0] = array_merge($attributes_array, $query_params);
5410
+		} else {
5411
+			$query_params[0] = $attributes_array;
5412
+		}
5413
+		return $this->get_all($query_params);
5414
+	}
5415
+
5416
+
5417
+
5418
+	/**
5419
+	 * Gets the first copy we find. See get_all_copies for more details
5420
+	 *
5421
+	 * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5422
+	 * @param array $query_params
5423
+	 * @return EE_Base_Class
5424
+	 * @throws \EE_Error
5425
+	 */
5426
+	public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5427
+	{
5428
+		if (! is_array($query_params)) {
5429
+			EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5430
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5431
+					gettype($query_params)), '4.6.0');
5432
+			$query_params = array();
5433
+		}
5434
+		$query_params['limit'] = 1;
5435
+		$copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5436
+		if (is_array($copies)) {
5437
+			return array_shift($copies);
5438
+		} else {
5439
+			return null;
5440
+		}
5441
+	}
5442
+
5443
+
5444
+
5445
+	/**
5446
+	 * Updates the item with the specified id. Ignores default query parameters because
5447
+	 * we have specified the ID, and its assumed we KNOW what we're doing
5448
+	 *
5449
+	 * @param array      $fields_n_values keys are field names, values are their new values
5450
+	 * @param int|string $id              the value of the primary key to update
5451
+	 * @return int number of rows updated
5452
+	 * @throws \EE_Error
5453
+	 */
5454
+	public function update_by_ID($fields_n_values, $id)
5455
+	{
5456
+		$query_params = array(
5457
+			0                          => array($this->get_primary_key_field()->get_name() => $id),
5458
+			'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
5459
+		);
5460
+		return $this->update($fields_n_values, $query_params);
5461
+	}
5462
+
5463
+
5464
+
5465
+	/**
5466
+	 * Changes an operator which was supplied to the models into one usable in SQL
5467
+	 *
5468
+	 * @param string $operator_supplied
5469
+	 * @return string an operator which can be used in SQL
5470
+	 * @throws EE_Error
5471
+	 */
5472
+	private function _prepare_operator_for_sql($operator_supplied)
5473
+	{
5474
+		$sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5475
+			: null;
5476
+		if ($sql_operator) {
5477
+			return $sql_operator;
5478
+		} else {
5479
+			throw new EE_Error(sprintf(__("The operator '%s' is not in the list of valid operators: %s",
5480
+				"event_espresso"), $operator_supplied, implode(",", array_keys($this->_valid_operators))));
5481
+		}
5482
+	}
5483
+
5484
+
5485
+
5486
+	/**
5487
+	 * Gets an array where keys are the primary keys and values are their 'names'
5488
+	 * (as determined by the model object's name() function, which is often overridden)
5489
+	 *
5490
+	 * @param array $query_params like get_all's
5491
+	 * @return string[]
5492
+	 * @throws \EE_Error
5493
+	 */
5494
+	public function get_all_names($query_params = array())
5495
+	{
5496
+		$objs = $this->get_all($query_params);
5497
+		$names = array();
5498
+		foreach ($objs as $obj) {
5499
+			$names[$obj->ID()] = $obj->name();
5500
+		}
5501
+		return $names;
5502
+	}
5503
+
5504
+
5505
+
5506
+	/**
5507
+	 * Gets an array of primary keys from the model objects. If you acquired the model objects
5508
+	 * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5509
+	 * this is duplicated effort and reduces efficiency) you would be better to use
5510
+	 * array_keys() on $model_objects.
5511
+	 *
5512
+	 * @param \EE_Base_Class[] $model_objects
5513
+	 * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5514
+	 *                                               in the returned array
5515
+	 * @return array
5516
+	 * @throws \EE_Error
5517
+	 */
5518
+	public function get_IDs($model_objects, $filter_out_empty_ids = false)
5519
+	{
5520
+		if (! $this->has_primary_key_field()) {
5521
+			if (WP_DEBUG) {
5522
+				EE_Error::add_error(
5523
+					__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5524
+					__FILE__,
5525
+					__FUNCTION__,
5526
+					__LINE__
5527
+				);
5528
+			}
5529
+		}
5530
+		$IDs = array();
5531
+		foreach ($model_objects as $model_object) {
5532
+			$id = $model_object->ID();
5533
+			if (! $id) {
5534
+				if ($filter_out_empty_ids) {
5535
+					continue;
5536
+				}
5537
+				if (WP_DEBUG) {
5538
+					EE_Error::add_error(
5539
+						__(
5540
+							'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5541
+							'event_espresso'
5542
+						),
5543
+						__FILE__,
5544
+						__FUNCTION__,
5545
+						__LINE__
5546
+					);
5547
+				}
5548
+			}
5549
+			$IDs[] = $id;
5550
+		}
5551
+		return $IDs;
5552
+	}
5553
+
5554
+
5555
+
5556
+	/**
5557
+	 * Returns the string used in capabilities relating to this model. If there
5558
+	 * are no capabilities that relate to this model returns false
5559
+	 *
5560
+	 * @return string|false
5561
+	 */
5562
+	public function cap_slug()
5563
+	{
5564
+		return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5565
+	}
5566
+
5567
+
5568
+
5569
+	/**
5570
+	 * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5571
+	 * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5572
+	 * only returns the cap restrictions array in that context (ie, the array
5573
+	 * at that key)
5574
+	 *
5575
+	 * @param string $context
5576
+	 * @return EE_Default_Where_Conditions[] indexed by associated capability
5577
+	 * @throws \EE_Error
5578
+	 */
5579
+	public function cap_restrictions($context = EEM_Base::caps_read)
5580
+	{
5581
+		EEM_Base::verify_is_valid_cap_context($context);
5582
+		//check if we ought to run the restriction generator first
5583
+		if (
5584
+			isset($this->_cap_restriction_generators[$context])
5585
+			&& $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5586
+			&& ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5587
+		) {
5588
+			$this->_cap_restrictions[$context] = array_merge(
5589
+				$this->_cap_restrictions[$context],
5590
+				$this->_cap_restriction_generators[$context]->generate_restrictions()
5591
+			);
5592
+		}
5593
+		//and make sure we've finalized the construction of each restriction
5594
+		foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5595
+			if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5596
+				$where_conditions_obj->_finalize_construct($this);
5597
+			}
5598
+		}
5599
+		return $this->_cap_restrictions[$context];
5600
+	}
5601
+
5602
+
5603
+
5604
+	/**
5605
+	 * Indicating whether or not this model thinks its a wp core model
5606
+	 *
5607
+	 * @return boolean
5608
+	 */
5609
+	public function is_wp_core_model()
5610
+	{
5611
+		return $this->_wp_core_model;
5612
+	}
5613
+
5614
+
5615
+
5616
+	/**
5617
+	 * Gets all the caps that are missing which impose a restriction on
5618
+	 * queries made in this context
5619
+	 *
5620
+	 * @param string $context one of EEM_Base::caps_ constants
5621
+	 * @return EE_Default_Where_Conditions[] indexed by capability name
5622
+	 * @throws \EE_Error
5623
+	 */
5624
+	public function caps_missing($context = EEM_Base::caps_read)
5625
+	{
5626
+		$missing_caps = array();
5627
+		$cap_restrictions = $this->cap_restrictions($context);
5628
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5629
+			if (! EE_Capabilities::instance()
5630
+								 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5631
+			) {
5632
+				$missing_caps[$cap] = $restriction_if_no_cap;
5633
+			}
5634
+		}
5635
+		return $missing_caps;
5636
+	}
5637
+
5638
+
5639
+
5640
+	/**
5641
+	 * Gets the mapping from capability contexts to action strings used in capability names
5642
+	 *
5643
+	 * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5644
+	 * one of 'read', 'edit', or 'delete'
5645
+	 */
5646
+	public function cap_contexts_to_cap_action_map()
5647
+	{
5648
+		return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5649
+			$this);
5650
+	}
5651
+
5652
+
5653
+
5654
+	/**
5655
+	 * Gets the action string for the specified capability context
5656
+	 *
5657
+	 * @param string $context
5658
+	 * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5659
+	 * @throws \EE_Error
5660
+	 */
5661
+	public function cap_action_for_context($context)
5662
+	{
5663
+		$mapping = $this->cap_contexts_to_cap_action_map();
5664
+		if (isset($mapping[$context])) {
5665
+			return $mapping[$context];
5666
+		}
5667
+		if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5668
+			return $action;
5669
+		}
5670
+		throw new EE_Error(
5671
+			sprintf(
5672
+				__('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5673
+				$context,
5674
+				implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5675
+			)
5676
+		);
5677
+	}
5678
+
5679
+
5680
+
5681
+	/**
5682
+	 * Returns all the capability contexts which are valid when querying models
5683
+	 *
5684
+	 * @return array
5685
+	 */
5686
+	public static function valid_cap_contexts()
5687
+	{
5688
+		return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5689
+			self::caps_read,
5690
+			self::caps_read_admin,
5691
+			self::caps_edit,
5692
+			self::caps_delete,
5693
+		));
5694
+	}
5695
+
5696
+
5697
+
5698
+	/**
5699
+	 * Returns all valid options for 'default_where_conditions'
5700
+	 *
5701
+	 * @return array
5702
+	 */
5703
+	public static function valid_default_where_conditions()
5704
+	{
5705
+		return array(
5706
+			EEM_Base::default_where_conditions_all,
5707
+			EEM_Base::default_where_conditions_this_only,
5708
+			EEM_Base::default_where_conditions_others_only,
5709
+			EEM_Base::default_where_conditions_minimum_all,
5710
+			EEM_Base::default_where_conditions_minimum_others,
5711
+			EEM_Base::default_where_conditions_none
5712
+		);
5713
+	}
5714
+
5715
+	// public static function default_where_conditions_full
5716
+	/**
5717
+	 * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5718
+	 *
5719
+	 * @param string $context
5720
+	 * @return bool
5721
+	 * @throws \EE_Error
5722
+	 */
5723
+	static public function verify_is_valid_cap_context($context)
5724
+	{
5725
+		$valid_cap_contexts = EEM_Base::valid_cap_contexts();
5726
+		if (in_array($context, $valid_cap_contexts)) {
5727
+			return true;
5728
+		} else {
5729
+			throw new EE_Error(
5730
+				sprintf(
5731
+					__('Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5732
+						'event_espresso'),
5733
+					$context,
5734
+					'EEM_Base',
5735
+					implode(',', $valid_cap_contexts)
5736
+				)
5737
+			);
5738
+		}
5739
+	}
5740
+
5741
+
5742
+
5743
+	/**
5744
+	 * Clears all the models field caches. This is only useful when a sub-class
5745
+	 * might have added a field or something and these caches might be invalidated
5746
+	 */
5747
+	protected function _invalidate_field_caches()
5748
+	{
5749
+		$this->_cache_foreign_key_to_fields = array();
5750
+		$this->_cached_fields = null;
5751
+		$this->_cached_fields_non_db_only = null;
5752
+	}
5753 5753
 
5754 5754
 
5755 5755
 
Please login to merge, or discard this patch.
Spacing   +152 added lines, -152 removed lines patch added patch discarded remove patch
@@ -516,8 +516,8 @@  discard block
 block discarded – undo
516 516
     protected function __construct($timezone = null)
517 517
     {
518 518
         // check that the model has not been loaded too soon
519
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
520
-            throw new EE_Error (
519
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')) {
520
+            throw new EE_Error(
521 521
                 sprintf(
522 522
                     __('The %1$s model can not be loaded before the "AHEE__EE_System__load_espresso_addons" hook has been called. This gives other addons a chance to extend this model.',
523 523
                         'event_espresso'),
@@ -537,7 +537,7 @@  discard block
 block discarded – undo
537 537
          *
538 538
          * @var EE_Table_Base[] $_tables
539 539
          */
540
-        $this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
540
+        $this->_tables = apply_filters('FHEE__'.get_class($this).'__construct__tables', $this->_tables);
541 541
         foreach ($this->_tables as $table_alias => $table_obj) {
542 542
             /** @var $table_obj EE_Table_Base */
543 543
             $table_obj->_construct_finalize_with_alias($table_alias);
@@ -552,10 +552,10 @@  discard block
 block discarded – undo
552 552
          *
553 553
          * @param EE_Model_Field_Base[] $_fields
554 554
          */
555
-        $this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
555
+        $this->_fields = apply_filters('FHEE__'.get_class($this).'__construct__fields', $this->_fields);
556 556
         $this->_invalidate_field_caches();
557 557
         foreach ($this->_fields as $table_alias => $fields_for_table) {
558
-            if (! array_key_exists($table_alias, $this->_tables)) {
558
+            if ( ! array_key_exists($table_alias, $this->_tables)) {
559 559
                 throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
560 560
                     'event_espresso'), $table_alias, implode(",", $this->_fields)));
561 561
             }
@@ -583,7 +583,7 @@  discard block
 block discarded – undo
583 583
          *
584 584
          * @param EE_Model_Relation_Base[] $_model_relations
585 585
          */
586
-        $this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
586
+        $this->_model_relations = apply_filters('FHEE__'.get_class($this).'__construct__model_relations',
587 587
             $this->_model_relations);
588 588
         foreach ($this->_model_relations as $model_name => $relation_obj) {
589 589
             /** @var $relation_obj EE_Model_Relation_Base */
@@ -595,12 +595,12 @@  discard block
 block discarded – undo
595 595
         }
596 596
         $this->set_timezone($timezone);
597 597
         //finalize default where condition strategy, or set default
598
-        if (! $this->_default_where_conditions_strategy) {
598
+        if ( ! $this->_default_where_conditions_strategy) {
599 599
             //nothing was set during child constructor, so set default
600 600
             $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
601 601
         }
602 602
         $this->_default_where_conditions_strategy->_finalize_construct($this);
603
-        if (! $this->_minimum_where_conditions_strategy) {
603
+        if ( ! $this->_minimum_where_conditions_strategy) {
604 604
             //nothing was set during child constructor, so set default
605 605
             $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
606 606
         }
@@ -613,7 +613,7 @@  discard block
 block discarded – undo
613 613
         //initialize the standard cap restriction generators if none were specified by the child constructor
614 614
         if ($this->_cap_restriction_generators !== false) {
615 615
             foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
616
-                if (! isset($this->_cap_restriction_generators[$cap_context])) {
616
+                if ( ! isset($this->_cap_restriction_generators[$cap_context])) {
617 617
                     $this->_cap_restriction_generators[$cap_context] = apply_filters(
618 618
                         'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
619 619
                         new EE_Restriction_Generator_Protected(),
@@ -626,10 +626,10 @@  discard block
 block discarded – undo
626 626
         //if there are cap restriction generators, use them to make the default cap restrictions
627 627
         if ($this->_cap_restriction_generators !== false) {
628 628
             foreach ($this->_cap_restriction_generators as $context => $generator_object) {
629
-                if (! $generator_object) {
629
+                if ( ! $generator_object) {
630 630
                     continue;
631 631
                 }
632
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
632
+                if ( ! $generator_object instanceof EE_Restriction_Generator_Base) {
633 633
                     throw new EE_Error(
634 634
                         sprintf(
635 635
                             __('Index "%1$s" in the model %2$s\'s _cap_restriction_generators is not a child of EE_Restriction_Generator_Base. It should be that or NULL.',
@@ -640,12 +640,12 @@  discard block
 block discarded – undo
640 640
                     );
641 641
                 }
642 642
                 $action = $this->cap_action_for_context($context);
643
-                if (! $generator_object->construction_finalized()) {
643
+                if ( ! $generator_object->construction_finalized()) {
644 644
                     $generator_object->_construct_finalize($this, $action);
645 645
                 }
646 646
             }
647 647
         }
648
-        do_action('AHEE__' . get_class($this) . '__construct__end');
648
+        do_action('AHEE__'.get_class($this).'__construct__end');
649 649
     }
650 650
 
651 651
 
@@ -680,7 +680,7 @@  discard block
 block discarded – undo
680 680
      */
681 681
     public static function set_model_query_blog_id($blog_id = 0)
682 682
     {
683
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
683
+        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int) $blog_id : get_current_blog_id();
684 684
     }
685 685
 
686 686
 
@@ -710,7 +710,7 @@  discard block
 block discarded – undo
710 710
     public static function instance($timezone = null)
711 711
     {
712 712
         // check if instance of Espresso_model already exists
713
-        if (! static::$_instance instanceof static) {
713
+        if ( ! static::$_instance instanceof static) {
714 714
             // instantiate Espresso_model
715 715
             static::$_instance = new static($timezone);
716 716
         }
@@ -741,7 +741,7 @@  discard block
 block discarded – undo
741 741
             foreach ($r->getDefaultProperties() as $property => $value) {
742 742
                 //don't set instance to null like it was originally,
743 743
                 //but it's static anyways, and we're ignoring static properties (for now at least)
744
-                if (! isset($static_properties[$property])) {
744
+                if ( ! isset($static_properties[$property])) {
745 745
                     static::$_instance->{$property} = $value;
746 746
                 }
747 747
             }
@@ -764,7 +764,7 @@  discard block
 block discarded – undo
764 764
      */
765 765
     public function status_array($translated = false)
766 766
     {
767
-        if (! array_key_exists('Status', $this->_model_relations)) {
767
+        if ( ! array_key_exists('Status', $this->_model_relations)) {
768 768
             return array();
769 769
         }
770 770
         $model_name = $this->get_this_model_name();
@@ -967,17 +967,17 @@  discard block
 block discarded – undo
967 967
     public function wp_user_field_name()
968 968
     {
969 969
         try {
970
-            if (! empty($this->_model_chain_to_wp_user)) {
970
+            if ( ! empty($this->_model_chain_to_wp_user)) {
971 971
                 $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
972 972
                 $last_model_name = end($models_to_follow_to_wp_users);
973 973
                 $model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
974
-                $model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
974
+                $model_chain_to_wp_user = $this->_model_chain_to_wp_user.'.';
975 975
             } else {
976 976
                 $model_with_fk_to_wp_users = $this;
977 977
                 $model_chain_to_wp_user = '';
978 978
             }
979 979
             $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
980
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
980
+            return $model_chain_to_wp_user.$wp_user_field->get_name();
981 981
         } catch (EE_Error $e) {
982 982
             return false;
983 983
         }
@@ -1049,12 +1049,12 @@  discard block
 block discarded – undo
1049 1049
         // remember the custom selections, if any, and type cast as array
1050 1050
         // (unless $columns_to_select is an object, then just set as an empty array)
1051 1051
         // Note: (array) 'some string' === array( 'some string' )
1052
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1052
+        $this->_custom_selections = ! is_object($columns_to_select) ? (array) $columns_to_select : array();
1053 1053
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
1054 1054
         $select_expressions = $columns_to_select !== null
1055 1055
             ? $this->_construct_select_from_input($columns_to_select)
1056 1056
             : $this->_construct_default_select_sql($model_query_info);
1057
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1057
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
1058 1058
         return $this->_do_wpdb_query('get_results', array($SQL, $output));
1059 1059
     }
1060 1060
 
@@ -1099,7 +1099,7 @@  discard block
 block discarded – undo
1099 1099
         if (is_array($columns_to_select)) {
1100 1100
             $select_sql_array = array();
1101 1101
             foreach ($columns_to_select as $alias => $selection_and_datatype) {
1102
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1102
+                if ( ! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1103 1103
                     throw new EE_Error(
1104 1104
                         sprintf(
1105 1105
                             __(
@@ -1111,7 +1111,7 @@  discard block
 block discarded – undo
1111 1111
                         )
1112 1112
                     );
1113 1113
                 }
1114
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1114
+                if ( ! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1115 1115
                     throw new EE_Error(
1116 1116
                         sprintf(
1117 1117
                             __(
@@ -1183,7 +1183,7 @@  discard block
 block discarded – undo
1183 1183
      */
1184 1184
     public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1185 1185
     {
1186
-        if (! isset($query_params[0])) {
1186
+        if ( ! isset($query_params[0])) {
1187 1187
             $query_params[0] = array();
1188 1188
         }
1189 1189
         $conditions_from_id = $this->parse_index_primary_key_string($id);
@@ -1208,7 +1208,7 @@  discard block
 block discarded – undo
1208 1208
      */
1209 1209
     public function get_one($query_params = array())
1210 1210
     {
1211
-        if (! is_array($query_params)) {
1211
+        if ( ! is_array($query_params)) {
1212 1212
             EE_Error::doing_it_wrong('EEM_Base::get_one',
1213 1213
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1214 1214
                     gettype($query_params)), '4.6.0');
@@ -1376,7 +1376,7 @@  discard block
 block discarded – undo
1376 1376
                 return array();
1377 1377
             }
1378 1378
         }
1379
-        if (! is_array($query_params)) {
1379
+        if ( ! is_array($query_params)) {
1380 1380
             EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1381 1381
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1382 1382
                     gettype($query_params)), '4.6.0');
@@ -1386,7 +1386,7 @@  discard block
 block discarded – undo
1386 1386
         $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1387 1387
         $query_params['limit'] = $limit;
1388 1388
         //set direction
1389
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1389
+        $incoming_orderby = isset($query_params['order_by']) ? (array) $query_params['order_by'] : array();
1390 1390
         $query_params['order_by'] = $operand === '>'
1391 1391
             ? array($field_to_order_by => 'ASC') + $incoming_orderby
1392 1392
             : array($field_to_order_by => 'DESC') + $incoming_orderby;
@@ -1465,7 +1465,7 @@  discard block
 block discarded – undo
1465 1465
     {
1466 1466
         $field_settings = $this->field_settings_for($field_name);
1467 1467
         //if not a valid EE_Datetime_Field then throw error
1468
-        if (! $field_settings instanceof EE_Datetime_Field) {
1468
+        if ( ! $field_settings instanceof EE_Datetime_Field) {
1469 1469
             throw new EE_Error(sprintf(__('The field sent into EEM_Base::get_formats_for (%s) is not registered as a EE_Datetime_Field. Please check the spelling and make sure you are submitting the right field name to retrieve date_formats for.',
1470 1470
                 'event_espresso'), $field_name));
1471 1471
         }
@@ -1610,7 +1610,7 @@  discard block
 block discarded – undo
1610 1610
      */
1611 1611
     public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1612 1612
     {
1613
-        if (! is_array($query_params)) {
1613
+        if ( ! is_array($query_params)) {
1614 1614
             EE_Error::doing_it_wrong('EEM_Base::update',
1615 1615
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1616 1616
                     gettype($query_params)), '4.6.0');
@@ -1632,7 +1632,7 @@  discard block
 block discarded – undo
1632 1632
          * @param EEM_Base $model           the model being queried
1633 1633
          * @param array    $query_params    see EEM_Base::get_all()
1634 1634
          */
1635
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1635
+        $fields_n_values = (array) apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1636 1636
             $query_params);
1637 1637
         //need to verify that, for any entry we want to update, there are entries in each secondary table.
1638 1638
         //to do that, for each table, verify that it's PK isn't null.
@@ -1646,7 +1646,7 @@  discard block
 block discarded – undo
1646 1646
         $wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1647 1647
         foreach ($wpdb_select_results as $wpdb_result) {
1648 1648
             // type cast stdClass as array
1649
-            $wpdb_result = (array)$wpdb_result;
1649
+            $wpdb_result = (array) $wpdb_result;
1650 1650
             //get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1651 1651
             if ($this->has_primary_key_field()) {
1652 1652
                 $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
@@ -1663,13 +1663,13 @@  discard block
 block discarded – undo
1663 1663
                     $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1664 1664
                     //if there is no private key for this table on the results, it means there's no entry
1665 1665
                     //in this table, right? so insert a row in the current table, using any fields available
1666
-                    if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1666
+                    if ( ! (array_key_exists($this_table_pk_column, $wpdb_result)
1667 1667
                            && $wpdb_result[$this_table_pk_column])
1668 1668
                     ) {
1669 1669
                         $success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1670 1670
                             $main_table_pk_value);
1671 1671
                         //if we died here, report the error
1672
-                        if (! $success) {
1672
+                        if ( ! $success) {
1673 1673
                             return false;
1674 1674
                         }
1675 1675
                     }
@@ -1700,7 +1700,7 @@  discard block
 block discarded – undo
1700 1700
                     $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1701 1701
                 }
1702 1702
             }
1703
-            if (! $model_objs_affected_ids) {
1703
+            if ( ! $model_objs_affected_ids) {
1704 1704
                 //wait wait wait- if nothing was affected let's stop here
1705 1705
                 return 0;
1706 1706
             }
@@ -1727,7 +1727,7 @@  discard block
 block discarded – undo
1727 1727
                . $model_query_info->get_full_join_sql()
1728 1728
                . " SET "
1729 1729
                . $this->_construct_update_sql($fields_n_values)
1730
-               . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1730
+               . $model_query_info->get_where_sql(); //note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1731 1731
         $rows_affected = $this->_do_wpdb_query('query', array($SQL));
1732 1732
         /**
1733 1733
          * Action called after a model update call has been made.
@@ -1738,7 +1738,7 @@  discard block
 block discarded – undo
1738 1738
          * @param int      $rows_affected
1739 1739
          */
1740 1740
         do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1741
-        return $rows_affected;//how many supposedly got updated
1741
+        return $rows_affected; //how many supposedly got updated
1742 1742
     }
1743 1743
 
1744 1744
 
@@ -1766,7 +1766,7 @@  discard block
 block discarded – undo
1766 1766
         }
1767 1767
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
1768 1768
         $select_expressions = $field->get_qualified_column();
1769
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1769
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
1770 1770
         return $this->_do_wpdb_query('get_col', array($SQL));
1771 1771
     }
1772 1772
 
@@ -1784,7 +1784,7 @@  discard block
 block discarded – undo
1784 1784
     {
1785 1785
         $query_params['limit'] = 1;
1786 1786
         $col = $this->get_col($query_params, $field_to_select);
1787
-        if (! empty($col)) {
1787
+        if ( ! empty($col)) {
1788 1788
             return reset($col);
1789 1789
         } else {
1790 1790
             return null;
@@ -1816,7 +1816,7 @@  discard block
 block discarded – undo
1816 1816
             $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1817 1817
             $value_sql = $prepared_value === null ? 'NULL'
1818 1818
                 : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1819
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1819
+            $cols_n_values[] = $field_obj->get_qualified_column()."=".$value_sql;
1820 1820
         }
1821 1821
         return implode(",", $cols_n_values);
1822 1822
     }
@@ -1948,7 +1948,7 @@  discard block
 block discarded – undo
1948 1948
          * @param int      $rows_deleted
1949 1949
          */
1950 1950
         do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
1951
-        return $rows_deleted;//how many supposedly got deleted
1951
+        return $rows_deleted; //how many supposedly got deleted
1952 1952
     }
1953 1953
 
1954 1954
 
@@ -2041,7 +2041,7 @@  discard block
 block discarded – undo
2041 2041
                     $deletes[$primary_table->get_fully_qualified_pk_column()][] = $delete_object[$primary_table->get_fully_qualified_pk_column()];
2042 2042
                 }
2043 2043
                 //other tables
2044
-                if (! empty($other_tables)) {
2044
+                if ( ! empty($other_tables)) {
2045 2045
                     foreach ($other_tables as $ot) {
2046 2046
                         //first check if we've got the foreign key column here.
2047 2047
                         if (isset($delete_object[$ot->get_fully_qualified_fk_column()])) {
@@ -2064,7 +2064,7 @@  discard block
 block discarded – undo
2064 2064
             foreach ($deletes as $column => $values) {
2065 2065
                 //make sure we have unique $values;
2066 2066
                 $values = array_unique($values);
2067
-                $query[] = $column . ' IN(' . implode(",", $values) . ')';
2067
+                $query[] = $column.' IN('.implode(",", $values).')';
2068 2068
             }
2069 2069
             return ! empty($query) ? implode(' AND ', $query) : '';
2070 2070
         } elseif (count($this->get_combined_primary_key_fields()) > 1) {
@@ -2080,7 +2080,7 @@  discard block
 block discarded – undo
2080 2080
                                                            . $delete_object[$cpk_field->get_qualified_column()];
2081 2081
                     }
2082 2082
                 }
2083
-                $ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
2083
+                $ways_to_identify_a_row[] = "(".implode(" AND ", $values_for_each_cpk_for_a_row).")";
2084 2084
             }
2085 2085
             return implode(" OR ", $ways_to_identify_a_row);
2086 2086
         } else {
@@ -2129,9 +2129,9 @@  discard block
 block discarded – undo
2129 2129
                 $column_to_count = '*';
2130 2130
             }
2131 2131
         }
2132
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2133
-        $SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2134
-        return (int)$this->_do_wpdb_query('get_var', array($SQL));
2132
+        $column_to_count = $distinct ? "DISTINCT ".$column_to_count : $column_to_count;
2133
+        $SQL = "SELECT COUNT(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
2134
+        return (int) $this->_do_wpdb_query('get_var', array($SQL));
2135 2135
     }
2136 2136
 
2137 2137
 
@@ -2153,13 +2153,13 @@  discard block
 block discarded – undo
2153 2153
             $field_obj = $this->get_primary_key_field();
2154 2154
         }
2155 2155
         $column_to_count = $field_obj->get_qualified_column();
2156
-        $SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2156
+        $SQL = "SELECT SUM(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
2157 2157
         $return_value = $this->_do_wpdb_query('get_var', array($SQL));
2158 2158
         $data_type = $field_obj->get_wpdb_data_type();
2159 2159
         if ($data_type === '%d' || $data_type === '%s') {
2160
-            return (float)$return_value;
2160
+            return (float) $return_value;
2161 2161
         } else {//must be %f
2162
-            return (float)$return_value;
2162
+            return (float) $return_value;
2163 2163
         }
2164 2164
     }
2165 2165
 
@@ -2180,13 +2180,13 @@  discard block
 block discarded – undo
2180 2180
         //if we're in maintenance mode level 2, DON'T run any queries
2181 2181
         //because level 2 indicates the database needs updating and
2182 2182
         //is probably out of sync with the code
2183
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2183
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
2184 2184
             throw new EE_Error(sprintf(__("Event Espresso Level 2 Maintenance mode is active. That means EE can not run ANY database queries until the necessary migration scripts have run which will take EE out of maintenance mode level 2. Please inform support of this error.",
2185 2185
                 "event_espresso")));
2186 2186
         }
2187 2187
         /** @type WPDB $wpdb */
2188 2188
         global $wpdb;
2189
-        if (! method_exists($wpdb, $wpdb_method)) {
2189
+        if ( ! method_exists($wpdb, $wpdb_method)) {
2190 2190
             throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2191 2191
                 'event_espresso'), $wpdb_method));
2192 2192
         }
@@ -2198,7 +2198,7 @@  discard block
 block discarded – undo
2198 2198
         $this->show_db_query_if_previously_requested($wpdb->last_query);
2199 2199
         if (WP_DEBUG) {
2200 2200
             $wpdb->show_errors($old_show_errors_value);
2201
-            if (! empty($wpdb->last_error)) {
2201
+            if ( ! empty($wpdb->last_error)) {
2202 2202
                 throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2203 2203
             } elseif ($result === false) {
2204 2204
                 throw new EE_Error(sprintf(__('WPDB Error occurred, but no error message was logged by wpdb! The wpdb method called was "%1$s" and the arguments were "%2$s"',
@@ -2258,7 +2258,7 @@  discard block
 block discarded – undo
2258 2258
                     return $result;
2259 2259
                     break;
2260 2260
             }
2261
-            if (! empty($error_message)) {
2261
+            if ( ! empty($error_message)) {
2262 2262
                 EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2263 2263
                 trigger_error($error_message);
2264 2264
             }
@@ -2334,11 +2334,11 @@  discard block
 block discarded – undo
2334 2334
      */
2335 2335
     private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2336 2336
     {
2337
-        return " FROM " . $model_query_info->get_full_join_sql() .
2338
-               $model_query_info->get_where_sql() .
2339
-               $model_query_info->get_group_by_sql() .
2340
-               $model_query_info->get_having_sql() .
2341
-               $model_query_info->get_order_by_sql() .
2337
+        return " FROM ".$model_query_info->get_full_join_sql().
2338
+               $model_query_info->get_where_sql().
2339
+               $model_query_info->get_group_by_sql().
2340
+               $model_query_info->get_having_sql().
2341
+               $model_query_info->get_order_by_sql().
2342 2342
                $model_query_info->get_limit_sql();
2343 2343
     }
2344 2344
 
@@ -2534,12 +2534,12 @@  discard block
 block discarded – undo
2534 2534
         $related_model = $this->get_related_model_obj($model_name);
2535 2535
         //we're just going to use the query params on the related model's normal get_all query,
2536 2536
         //except add a condition to say to match the current mod
2537
-        if (! isset($query_params['default_where_conditions'])) {
2537
+        if ( ! isset($query_params['default_where_conditions'])) {
2538 2538
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2539 2539
         }
2540 2540
         $this_model_name = $this->get_this_model_name();
2541 2541
         $this_pk_field_name = $this->get_primary_key_field()->get_name();
2542
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2542
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
2543 2543
         return $related_model->count($query_params, $field_to_count, $distinct);
2544 2544
     }
2545 2545
 
@@ -2559,7 +2559,7 @@  discard block
 block discarded – undo
2559 2559
     public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2560 2560
     {
2561 2561
         $related_model = $this->get_related_model_obj($model_name);
2562
-        if (! is_array($query_params)) {
2562
+        if ( ! is_array($query_params)) {
2563 2563
             EE_Error::doing_it_wrong('EEM_Base::sum_related',
2564 2564
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2565 2565
                     gettype($query_params)), '4.6.0');
@@ -2567,12 +2567,12 @@  discard block
 block discarded – undo
2567 2567
         }
2568 2568
         //we're just going to use the query params on the related model's normal get_all query,
2569 2569
         //except add a condition to say to match the current mod
2570
-        if (! isset($query_params['default_where_conditions'])) {
2570
+        if ( ! isset($query_params['default_where_conditions'])) {
2571 2571
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2572 2572
         }
2573 2573
         $this_model_name = $this->get_this_model_name();
2574 2574
         $this_pk_field_name = $this->get_primary_key_field()->get_name();
2575
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2575
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
2576 2576
         return $related_model->sum($query_params, $field_to_sum);
2577 2577
     }
2578 2578
 
@@ -2626,7 +2626,7 @@  discard block
 block discarded – undo
2626 2626
                 $field_with_model_name = $field;
2627 2627
             }
2628 2628
         }
2629
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
2629
+        if ( ! isset($field_with_model_name) || ! $field_with_model_name) {
2630 2630
             throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2631 2631
                 $this->get_this_model_name()));
2632 2632
         }
@@ -2659,7 +2659,7 @@  discard block
 block discarded – undo
2659 2659
          * @param array    $fields_n_values keys are the fields and values are their new values
2660 2660
          * @param EEM_Base $model           the model used
2661 2661
          */
2662
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2662
+        $field_n_values = (array) apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2663 2663
         if ($this->_satisfies_unique_indexes($field_n_values)) {
2664 2664
             $main_table = $this->_get_main_table();
2665 2665
             $new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
@@ -2767,7 +2767,7 @@  discard block
 block discarded – undo
2767 2767
         }
2768 2768
         foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2769 2769
             $uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2770
-            $query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2770
+            $query_params[0]['OR']['AND*'.$unique_index_name] = $uniqueness_where_params;
2771 2771
         }
2772 2772
         //if there is nothing to base this search on, then we shouldn't find anything
2773 2773
         if (empty($query_params)) {
@@ -2854,7 +2854,7 @@  discard block
 block discarded – undo
2854 2854
             //its not the main table, so we should have already saved the main table's PK which we just inserted
2855 2855
             //so add the fk to the main table as a column
2856 2856
             $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2857
-            $format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2857
+            $format_for_insertion[] = '%d'; //yes right now we're only allowing these foreign keys to be INTs
2858 2858
         }
2859 2859
         //insert the new entry
2860 2860
         $result = $this->_do_wpdb_query('insert',
@@ -2893,7 +2893,7 @@  discard block
 block discarded – undo
2893 2893
     protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
2894 2894
     {
2895 2895
         //if this field doesn't allow nullable, don't allow it
2896
-        if (! $field_obj->is_nullable()
2896
+        if ( ! $field_obj->is_nullable()
2897 2897
             && (
2898 2898
                 ! isset($fields_n_values[$field_obj->get_name()]) || $fields_n_values[$field_obj->get_name()] === null)
2899 2899
         ) {
@@ -3056,7 +3056,7 @@  discard block
 block discarded – undo
3056 3056
                     $query_info_carrier,
3057 3057
                     'group_by'
3058 3058
                 );
3059
-            } elseif (! empty ($query_params['group_by'])) {
3059
+            } elseif ( ! empty ($query_params['group_by'])) {
3060 3060
                 $this->_extract_related_model_info_from_query_param(
3061 3061
                     $query_params['group_by'],
3062 3062
                     $query_info_carrier,
@@ -3078,7 +3078,7 @@  discard block
 block discarded – undo
3078 3078
                     $query_info_carrier,
3079 3079
                     'order_by'
3080 3080
                 );
3081
-            } elseif (! empty($query_params['order_by'])) {
3081
+            } elseif ( ! empty($query_params['order_by'])) {
3082 3082
                 $this->_extract_related_model_info_from_query_param(
3083 3083
                     $query_params['order_by'],
3084 3084
                     $query_info_carrier,
@@ -3113,8 +3113,8 @@  discard block
 block discarded – undo
3113 3113
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
3114 3114
         $query_param_type
3115 3115
     ) {
3116
-        if (! empty($sub_query_params)) {
3117
-            $sub_query_params = (array)$sub_query_params;
3116
+        if ( ! empty($sub_query_params)) {
3117
+            $sub_query_params = (array) $sub_query_params;
3118 3118
             foreach ($sub_query_params as $param => $possibly_array_of_params) {
3119 3119
                 //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3120 3120
                 $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
@@ -3125,7 +3125,7 @@  discard block
 block discarded – undo
3125 3125
                 //of array('Registration.TXN_ID'=>23)
3126 3126
                 $query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3127 3127
                 if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3128
-                    if (! is_array($possibly_array_of_params)) {
3128
+                    if ( ! is_array($possibly_array_of_params)) {
3129 3129
                         throw new EE_Error(sprintf(__("You used a special where query param %s, but the value isn't an array of where query params, it's just %s'. It should be an array, eg array('EVT_ID'=>23,'OR'=>array('Venue.VNU_ID'=>32,'Venue.VNU_name'=>'monkey_land'))",
3130 3130
                             "event_espresso"),
3131 3131
                             $param, $possibly_array_of_params));
@@ -3141,7 +3141,7 @@  discard block
 block discarded – undo
3141 3141
                     //then $possible_array_of_params looks something like array('<','DTT_sold',true)
3142 3142
                     //indicating that $possible_array_of_params[1] is actually a field name,
3143 3143
                     //from which we should extract query parameters!
3144
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3144
+                    if ( ! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3145 3145
                         throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3146 3146
                             "event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3147 3147
                     }
@@ -3171,8 +3171,8 @@  discard block
 block discarded – undo
3171 3171
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
3172 3172
         $query_param_type
3173 3173
     ) {
3174
-        if (! empty($sub_query_params)) {
3175
-            if (! is_array($sub_query_params)) {
3174
+        if ( ! empty($sub_query_params)) {
3175
+            if ( ! is_array($sub_query_params)) {
3176 3176
                 throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3177 3177
                     $sub_query_params));
3178 3178
             }
@@ -3201,7 +3201,7 @@  discard block
 block discarded – undo
3201 3201
      */
3202 3202
     public function _create_model_query_info_carrier($query_params)
3203 3203
     {
3204
-        if (! is_array($query_params)) {
3204
+        if ( ! is_array($query_params)) {
3205 3205
             EE_Error::doing_it_wrong(
3206 3206
                 'EEM_Base::_create_model_query_info_carrier',
3207 3207
                 sprintf(
@@ -3277,7 +3277,7 @@  discard block
 block discarded – undo
3277 3277
         //set limit
3278 3278
         if (array_key_exists('limit', $query_params)) {
3279 3279
             if (is_array($query_params['limit'])) {
3280
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3280
+                if ( ! isset($query_params['limit'][0], $query_params['limit'][1])) {
3281 3281
                     $e = sprintf(
3282 3282
                         __(
3283 3283
                             "Invalid DB query. You passed '%s' for the LIMIT, but only the following are valid: an integer, string representing an integer, a string like 'int,int', or an array like array(int,int)",
@@ -3285,12 +3285,12 @@  discard block
 block discarded – undo
3285 3285
                         ),
3286 3286
                         http_build_query($query_params['limit'])
3287 3287
                     );
3288
-                    throw new EE_Error($e . "|" . $e);
3288
+                    throw new EE_Error($e."|".$e);
3289 3289
                 }
3290 3290
                 //they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3291
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3292
-            } elseif (! empty ($query_params['limit'])) {
3293
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3291
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit'][0].",".$query_params['limit'][1]);
3292
+            } elseif ( ! empty ($query_params['limit'])) {
3293
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit']);
3294 3294
             }
3295 3295
         }
3296 3296
         //set order by
@@ -3322,10 +3322,10 @@  discard block
 block discarded – undo
3322 3322
                 $order_array = array();
3323 3323
                 foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3324 3324
                     $order = $this->_extract_order($order);
3325
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3325
+                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by).SP.$order;
3326 3326
                 }
3327
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3328
-            } elseif (! empty ($query_params['order_by'])) {
3327
+                $query_object->set_order_by_sql(" ORDER BY ".implode(",", $order_array));
3328
+            } elseif ( ! empty ($query_params['order_by'])) {
3329 3329
                 $this->_extract_related_model_info_from_query_param(
3330 3330
                     $query_params['order_by'],
3331 3331
                     $query_object,
@@ -3336,18 +3336,18 @@  discard block
 block discarded – undo
3336 3336
                     ? $this->_extract_order($query_params['order'])
3337 3337
                     : 'DESC';
3338 3338
                 $query_object->set_order_by_sql(
3339
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3339
+                    " ORDER BY ".$this->_deduce_column_name_from_query_param($query_params['order_by']).SP.$order
3340 3340
                 );
3341 3341
             }
3342 3342
         }
3343 3343
         //if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3344
-        if (! array_key_exists('order_by', $query_params)
3344
+        if ( ! array_key_exists('order_by', $query_params)
3345 3345
             && array_key_exists('order', $query_params)
3346 3346
             && ! empty($query_params['order'])
3347 3347
         ) {
3348 3348
             $pk_field = $this->get_primary_key_field();
3349 3349
             $order = $this->_extract_order($query_params['order']);
3350
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3350
+            $query_object->set_order_by_sql(" ORDER BY ".$pk_field->get_qualified_column().SP.$order);
3351 3351
         }
3352 3352
         //set group by
3353 3353
         if (array_key_exists('group_by', $query_params)) {
@@ -3357,10 +3357,10 @@  discard block
 block discarded – undo
3357 3357
                 foreach ($query_params['group_by'] as $field_name_to_group_by) {
3358 3358
                     $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3359 3359
                 }
3360
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3361
-            } elseif (! empty ($query_params['group_by'])) {
3360
+                $query_object->set_group_by_sql(" GROUP BY ".implode(", ", $group_by_array));
3361
+            } elseif ( ! empty ($query_params['group_by'])) {
3362 3362
                 $query_object->set_group_by_sql(
3363
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3363
+                    " GROUP BY ".$this->_deduce_column_name_from_query_param($query_params['group_by'])
3364 3364
                 );
3365 3365
             }
3366 3366
         }
@@ -3370,7 +3370,7 @@  discard block
 block discarded – undo
3370 3370
         }
3371 3371
         //now, just verify they didn't pass anything wack
3372 3372
         foreach ($query_params as $query_key => $query_value) {
3373
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
3373
+            if ( ! in_array($query_key, $this->_allowed_query_params, true)) {
3374 3374
                 throw new EE_Error(
3375 3375
                     sprintf(
3376 3376
                         __(
@@ -3464,22 +3464,22 @@  discard block
 block discarded – undo
3464 3464
         $where_query_params = array()
3465 3465
     ) {
3466 3466
         $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3467
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3467
+        if ( ! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3468 3468
             throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3469 3469
                 "event_espresso"), $use_default_where_conditions,
3470 3470
                 implode(", ", $allowed_used_default_where_conditions_values)));
3471 3471
         }
3472 3472
         $universal_query_params = array();
3473
-        if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3473
+        if ($this->_should_use_default_where_conditions($use_default_where_conditions, true)) {
3474 3474
             $universal_query_params = $this->_get_default_where_conditions();
3475
-        } else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3475
+        } else if ($this->_should_use_minimum_where_conditions($use_default_where_conditions, true)) {
3476 3476
             $universal_query_params = $this->_get_minimum_where_conditions();
3477 3477
         }
3478 3478
         foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3479 3479
             $related_model = $this->get_related_model_obj($model_name);
3480
-            if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3480
+            if ($this->_should_use_default_where_conditions($use_default_where_conditions, false)) {
3481 3481
                 $related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3482
-            } elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3482
+            } elseif ($this->_should_use_minimum_where_conditions($use_default_where_conditions, false)) {
3483 3483
                 $related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3484 3484
             } else {
3485 3485
                 //we don't want to add full or even minimum default where conditions from this model, so just continue
@@ -3512,7 +3512,7 @@  discard block
 block discarded – undo
3512 3512
      * @param bool $for_this_model false means this is for OTHER related models
3513 3513
      * @return bool
3514 3514
      */
3515
-    private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3515
+    private function _should_use_default_where_conditions($default_where_conditions_value, $for_this_model = true)
3516 3516
     {
3517 3517
         return (
3518 3518
                    $for_this_model
@@ -3591,7 +3591,7 @@  discard block
 block discarded – undo
3591 3591
     ) {
3592 3592
         $null_friendly_where_conditions = array();
3593 3593
         $none_overridden = true;
3594
-        $or_condition_key_for_defaults = 'OR*' . get_class($model);
3594
+        $or_condition_key_for_defaults = 'OR*'.get_class($model);
3595 3595
         foreach ($default_where_conditions as $key => $val) {
3596 3596
             if (isset($provided_where_conditions[$key])) {
3597 3597
                 $none_overridden = false;
@@ -3709,7 +3709,7 @@  discard block
 block discarded – undo
3709 3709
             foreach ($tables as $table_obj) {
3710 3710
                 $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3711 3711
                                        . $table_obj->get_fully_qualified_pk_column();
3712
-                if (! in_array($qualified_pk_column, $selects)) {
3712
+                if ( ! in_array($qualified_pk_column, $selects)) {
3713 3713
                     $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3714 3714
                 }
3715 3715
             }
@@ -3795,9 +3795,9 @@  discard block
 block discarded – undo
3795 3795
         //and
3796 3796
         //check if it's a field on a related model
3797 3797
         foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3798
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3798
+            if (strpos($query_param, $valid_related_model_name.".") === 0) {
3799 3799
                 $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3800
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
3800
+                $query_param = substr($query_param, strlen($valid_related_model_name."."));
3801 3801
                 if ($query_param === '') {
3802 3802
                     //nothing left to $query_param
3803 3803
                     //we should actually end in a field name, not a model like this!
@@ -3883,7 +3883,7 @@  discard block
 block discarded – undo
3883 3883
     {
3884 3884
         $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
3885 3885
         if ($SQL) {
3886
-            return " WHERE " . $SQL;
3886
+            return " WHERE ".$SQL;
3887 3887
         } else {
3888 3888
             return '';
3889 3889
         }
@@ -3903,7 +3903,7 @@  discard block
 block discarded – undo
3903 3903
     {
3904 3904
         $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
3905 3905
         if ($SQL) {
3906
-            return " HAVING " . $SQL;
3906
+            return " HAVING ".$SQL;
3907 3907
         } else {
3908 3908
             return '';
3909 3909
         }
@@ -3923,11 +3923,11 @@  discard block
 block discarded – undo
3923 3923
      */
3924 3924
     protected function _get_field_on_model($field_name, $model_name)
3925 3925
     {
3926
-        $model_class = 'EEM_' . $model_name;
3927
-        $model_filepath = $model_class . ".model.php";
3926
+        $model_class = 'EEM_'.$model_name;
3927
+        $model_filepath = $model_class.".model.php";
3928 3928
         if (is_readable($model_filepath)) {
3929 3929
             require_once($model_filepath);
3930
-            $model_instance = call_user_func($model_name . "::instance");
3930
+            $model_instance = call_user_func($model_name."::instance");
3931 3931
             /* @var $model_instance EEM_Base */
3932 3932
             return $model_instance->field_settings_for($field_name);
3933 3933
         } else {
@@ -3951,7 +3951,7 @@  discard block
 block discarded – undo
3951 3951
     {
3952 3952
         $where_clauses = array();
3953 3953
         foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
3954
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
3954
+            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param); //str_replace("*",'',$query_param);
3955 3955
             if (in_array($query_param, $this->_logic_query_param_keys)) {
3956 3956
                 switch ($query_param) {
3957 3957
                     case 'not':
@@ -3979,7 +3979,7 @@  discard block
 block discarded – undo
3979 3979
             } else {
3980 3980
                 $field_obj = $this->_deduce_field_from_query_param($query_param);
3981 3981
                 //if it's not a normal field, maybe it's a custom selection?
3982
-                if (! $field_obj) {
3982
+                if ( ! $field_obj) {
3983 3983
                     if (isset($this->_custom_selections[$query_param][1])) {
3984 3984
                         $field_obj = $this->_custom_selections[$query_param][1];
3985 3985
                     } else {
@@ -3988,7 +3988,7 @@  discard block
 block discarded – undo
3988 3988
                     }
3989 3989
                 }
3990 3990
                 $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
3991
-                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
3991
+                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param).SP.$op_and_value_sql;
3992 3992
             }
3993 3993
         }
3994 3994
         return $where_clauses ? implode($glue, $where_clauses) : '';
@@ -4009,7 +4009,7 @@  discard block
 block discarded – undo
4009 4009
         if ($field) {
4010 4010
             $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4011 4011
                 $query_param);
4012
-            return $table_alias_prefix . $field->get_qualified_column();
4012
+            return $table_alias_prefix.$field->get_qualified_column();
4013 4013
         } elseif (array_key_exists($query_param, $this->_custom_selections)) {
4014 4014
             //maybe it's custom selection item?
4015 4015
             //if so, just use it as the "column name"
@@ -4056,7 +4056,7 @@  discard block
 block discarded – undo
4056 4056
     {
4057 4057
         if (is_array($op_and_value)) {
4058 4058
             $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4059
-            if (! $operator) {
4059
+            if ( ! $operator) {
4060 4060
                 $php_array_like_string = array();
4061 4061
                 foreach ($op_and_value as $key => $value) {
4062 4062
                     $php_array_like_string[] = "$key=>$value";
@@ -4078,13 +4078,13 @@  discard block
 block discarded – undo
4078 4078
         }
4079 4079
         //check to see if the value is actually another field
4080 4080
         if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4081
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4081
+            return $operator.SP.$this->_deduce_column_name_from_query_param($value);
4082 4082
         } elseif (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4083 4083
             //in this case, the value should be an array, or at least a comma-separated list
4084 4084
             //it will need to handle a little differently
4085 4085
             $cleaned_value = $this->_construct_in_value($value, $field_obj);
4086 4086
             //note: $cleaned_value has already been run through $wpdb->prepare()
4087
-            return $operator . SP . $cleaned_value;
4087
+            return $operator.SP.$cleaned_value;
4088 4088
         } elseif (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4089 4089
             //the value should be an array with count of two.
4090 4090
             if (count($value) !== 2) {
@@ -4099,7 +4099,7 @@  discard block
 block discarded – undo
4099 4099
                 );
4100 4100
             }
4101 4101
             $cleaned_value = $this->_construct_between_value($value, $field_obj);
4102
-            return $operator . SP . $cleaned_value;
4102
+            return $operator.SP.$cleaned_value;
4103 4103
         } elseif (in_array($operator, $this->_null_style_operators)) {
4104 4104
             if ($value !== null) {
4105 4105
                 throw new EE_Error(
@@ -4117,9 +4117,9 @@  discard block
 block discarded – undo
4117 4117
         } elseif ($operator === 'LIKE' && ! is_array($value)) {
4118 4118
             //if the operator is 'LIKE', we want to allow percent signs (%) and not
4119 4119
             //remove other junk. So just treat it as a string.
4120
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4121
-        } elseif (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4122
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4120
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, '%s');
4121
+        } elseif ( ! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4122
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, $field_obj);
4123 4123
         } elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4124 4124
             throw new EE_Error(
4125 4125
                 sprintf(
@@ -4131,7 +4131,7 @@  discard block
 block discarded – undo
4131 4131
                     $operator
4132 4132
                 )
4133 4133
             );
4134
-        } elseif (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4134
+        } elseif ( ! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4135 4135
             throw new EE_Error(
4136 4136
                 sprintf(
4137 4137
                     __(
@@ -4172,7 +4172,7 @@  discard block
 block discarded – undo
4172 4172
         foreach ($values as $value) {
4173 4173
             $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4174 4174
         }
4175
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
4175
+        return $cleaned_values[0]." AND ".$cleaned_values[1];
4176 4176
     }
4177 4177
 
4178 4178
 
@@ -4213,7 +4213,7 @@  discard block
 block discarded – undo
4213 4213
                                 . $main_table->get_table_name()
4214 4214
                                 . " WHERE FALSE";
4215 4215
         }
4216
-        return "(" . implode(",", $cleaned_values) . ")";
4216
+        return "(".implode(",", $cleaned_values).")";
4217 4217
     }
4218 4218
 
4219 4219
 
@@ -4232,7 +4232,7 @@  discard block
 block discarded – undo
4232 4232
             return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4233 4233
                 $this->_prepare_value_for_use_in_db($value, $field_obj));
4234 4234
         } else {//$field_obj should really just be a data type
4235
-            if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4235
+            if ( ! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4236 4236
                 throw new EE_Error(sprintf(__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4237 4237
                     $field_obj, implode(",", $this->_valid_wpdb_data_types)));
4238 4238
             }
@@ -4316,11 +4316,11 @@  discard block
 block discarded – undo
4316 4316
             if ($table_obj instanceof EE_Primary_Table) {
4317 4317
                 $SQL .= $table_alias === $table_obj->get_table_alias()
4318 4318
                     ? $table_obj->get_select_join_limit($limit)
4319
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4319
+                    : SP.$table_obj->get_table_name()." AS ".$table_obj->get_table_alias().SP;
4320 4320
             } elseif ($table_obj instanceof EE_Secondary_Table) {
4321 4321
                 $SQL .= $table_alias === $table_obj->get_table_alias()
4322 4322
                     ? $table_obj->get_select_join_limit_join($limit)
4323
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
4323
+                    : SP.$table_obj->get_join_sql($table_alias).SP;
4324 4324
             }
4325 4325
         }
4326 4326
         return $SQL;
@@ -4408,12 +4408,12 @@  discard block
 block discarded – undo
4408 4408
      */
4409 4409
     public function get_related_model_obj($model_name)
4410 4410
     {
4411
-        $model_classname = "EEM_" . $model_name;
4412
-        if (! class_exists($model_classname)) {
4411
+        $model_classname = "EEM_".$model_name;
4412
+        if ( ! class_exists($model_classname)) {
4413 4413
             throw new EE_Error(sprintf(__("You specified a related model named %s in your query. No such model exists, if it did, it would have the classname %s",
4414 4414
                 'event_espresso'), $model_name, $model_classname));
4415 4415
         }
4416
-        return call_user_func($model_classname . "::instance");
4416
+        return call_user_func($model_classname."::instance");
4417 4417
     }
4418 4418
 
4419 4419
 
@@ -4460,7 +4460,7 @@  discard block
 block discarded – undo
4460 4460
     public function related_settings_for($relation_name)
4461 4461
     {
4462 4462
         $relatedModels = $this->relation_settings();
4463
-        if (! array_key_exists($relation_name, $relatedModels)) {
4463
+        if ( ! array_key_exists($relation_name, $relatedModels)) {
4464 4464
             throw new EE_Error(
4465 4465
                 sprintf(
4466 4466
                     __('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
@@ -4487,7 +4487,7 @@  discard block
 block discarded – undo
4487 4487
     public function field_settings_for($fieldName)
4488 4488
     {
4489 4489
         $fieldSettings = $this->field_settings(true);
4490
-        if (! array_key_exists($fieldName, $fieldSettings)) {
4490
+        if ( ! array_key_exists($fieldName, $fieldSettings)) {
4491 4491
             throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4492 4492
                 get_class($this)));
4493 4493
         }
@@ -4562,7 +4562,7 @@  discard block
 block discarded – undo
4562 4562
                     break;
4563 4563
                 }
4564 4564
             }
4565
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4565
+            if ( ! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4566 4566
                 throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4567 4567
                     get_class($this)));
4568 4568
             }
@@ -4621,7 +4621,7 @@  discard block
 block discarded – undo
4621 4621
      */
4622 4622
     public function get_foreign_key_to($model_name)
4623 4623
     {
4624
-        if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4624
+        if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4625 4625
             foreach ($this->field_settings() as $field) {
4626 4626
                 if (
4627 4627
                     $field instanceof EE_Foreign_Key_Field_Base
@@ -4631,7 +4631,7 @@  discard block
 block discarded – undo
4631 4631
                     break;
4632 4632
                 }
4633 4633
             }
4634
-            if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4634
+            if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4635 4635
                 throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4636 4636
                     'event_espresso'), $model_name, get_class($this)));
4637 4637
             }
@@ -4682,7 +4682,7 @@  discard block
 block discarded – undo
4682 4682
                 foreach ($this->_fields as $fields_corresponding_to_table) {
4683 4683
                     foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4684 4684
                         /** @var $field_obj EE_Model_Field_Base */
4685
-                        if (! $field_obj->is_db_only_field()) {
4685
+                        if ( ! $field_obj->is_db_only_field()) {
4686 4686
                             $this->_cached_fields_non_db_only[$field_name] = $field_obj;
4687 4687
                         }
4688 4688
                     }
@@ -4712,7 +4712,7 @@  discard block
 block discarded – undo
4712 4712
         $count_if_model_has_no_primary_key = 0;
4713 4713
         $has_primary_key = $this->has_primary_key_field();
4714 4714
         $primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4715
-        foreach ((array)$rows as $row) {
4715
+        foreach ((array) $rows as $row) {
4716 4716
             if (empty($row)) {
4717 4717
                 //wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4718 4718
                 return array();
@@ -4730,7 +4730,7 @@  discard block
 block discarded – undo
4730 4730
                 }
4731 4731
             }
4732 4732
             $classInstance = $this->instantiate_class_from_array_or_object($row);
4733
-            if (! $classInstance) {
4733
+            if ( ! $classInstance) {
4734 4734
                 throw new EE_Error(
4735 4735
                     sprintf(
4736 4736
                         __('Could not create instance of class %s from row %s', 'event_espresso'),
@@ -4799,7 +4799,7 @@  discard block
 block discarded – undo
4799 4799
      */
4800 4800
     public function instantiate_class_from_array_or_object($cols_n_values)
4801 4801
     {
4802
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
4802
+        if ( ! is_array($cols_n_values) && is_object($cols_n_values)) {
4803 4803
             $cols_n_values = get_object_vars($cols_n_values);
4804 4804
         }
4805 4805
         $primary_key = null;
@@ -4824,7 +4824,7 @@  discard block
 block discarded – undo
4824 4824
         // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
4825 4825
         if ($primary_key) {
4826 4826
             $classInstance = $this->get_from_entity_map($primary_key);
4827
-            if (! $classInstance) {
4827
+            if ( ! $classInstance) {
4828 4828
                 $classInstance = EE_Registry::instance()
4829 4829
                                             ->load_class($className,
4830 4830
                                                 array($this_model_fields_n_values, $this->_timezone), true, false);
@@ -4875,12 +4875,12 @@  discard block
 block discarded – undo
4875 4875
     public function add_to_entity_map(EE_Base_Class $object)
4876 4876
     {
4877 4877
         $className = $this->_get_class_name();
4878
-        if (! $object instanceof $className) {
4878
+        if ( ! $object instanceof $className) {
4879 4879
             throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
4880 4880
                 is_object($object) ? get_class($object) : $object, $className));
4881 4881
         }
4882 4882
         /** @var $object EE_Base_Class */
4883
-        if (! $object->ID()) {
4883
+        if ( ! $object->ID()) {
4884 4884
             throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
4885 4885
                 "event_espresso"), get_class($this)));
4886 4886
         }
@@ -4950,7 +4950,7 @@  discard block
 block discarded – undo
4950 4950
             //there is a primary key on this table and its not set. Use defaults for all its columns
4951 4951
             if ($table_pk_value === null && $table_obj->get_pk_column()) {
4952 4952
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
4953
-                    if (! $field_obj->is_db_only_field()) {
4953
+                    if ( ! $field_obj->is_db_only_field()) {
4954 4954
                         //prepare field as if its coming from db
4955 4955
                         $prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
4956 4956
                         $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
@@ -4959,7 +4959,7 @@  discard block
 block discarded – undo
4959 4959
             } else {
4960 4960
                 //the table's rows existed. Use their values
4961 4961
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
4962
-                    if (! $field_obj->is_db_only_field()) {
4962
+                    if ( ! $field_obj->is_db_only_field()) {
4963 4963
                         $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
4964 4964
                             $cols_n_values, $field_obj->get_qualified_column(),
4965 4965
                             $field_obj->get_table_column()
@@ -5076,7 +5076,7 @@  discard block
 block discarded – undo
5076 5076
      */
5077 5077
     private function _get_class_name()
5078 5078
     {
5079
-        return "EE_" . $this->get_this_model_name();
5079
+        return "EE_".$this->get_this_model_name();
5080 5080
     }
5081 5081
 
5082 5082
 
@@ -5091,7 +5091,7 @@  discard block
 block discarded – undo
5091 5091
      */
5092 5092
     public function item_name($quantity = 1)
5093 5093
     {
5094
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5094
+        return (int) $quantity === 1 ? $this->singular_item : $this->plural_item;
5095 5095
     }
5096 5096
 
5097 5097
 
@@ -5124,7 +5124,7 @@  discard block
 block discarded – undo
5124 5124
     {
5125 5125
         $className = get_class($this);
5126 5126
         $tagName = "FHEE__{$className}__{$methodName}";
5127
-        if (! has_filter($tagName)) {
5127
+        if ( ! has_filter($tagName)) {
5128 5128
             throw new EE_Error(
5129 5129
                 sprintf(
5130 5130
                     __('Method %1$s on model %2$s does not exist! You can create one with the following code in functions.php or in a plugin: %4$s function my_callback(%4$s \$previousReturnValue, EEM_Base \$object\ $argsArray=NULL ){%4$s     /*function body*/%4$s      return \$whatever;%4$s }%4$s add_filter( \'%3$s\', \'my_callback\', 10, 3 );',
@@ -5350,7 +5350,7 @@  discard block
 block discarded – undo
5350 5350
         $key_vals_in_combined_pk = array();
5351 5351
         parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5352 5352
         foreach ($key_fields as $key_field_name => $field_obj) {
5353
-            if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5353
+            if ( ! isset($key_vals_in_combined_pk[$key_field_name])) {
5354 5354
                 return null;
5355 5355
             }
5356 5356
         }
@@ -5371,7 +5371,7 @@  discard block
 block discarded – undo
5371 5371
     {
5372 5372
         $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5373 5373
         foreach ($keys_it_should_have as $key) {
5374
-            if (! isset($key_vals[$key])) {
5374
+            if ( ! isset($key_vals[$key])) {
5375 5375
                 return false;
5376 5376
             }
5377 5377
         }
@@ -5425,7 +5425,7 @@  discard block
 block discarded – undo
5425 5425
      */
5426 5426
     public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5427 5427
     {
5428
-        if (! is_array($query_params)) {
5428
+        if ( ! is_array($query_params)) {
5429 5429
             EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5430 5430
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5431 5431
                     gettype($query_params)), '4.6.0');
@@ -5517,7 +5517,7 @@  discard block
 block discarded – undo
5517 5517
      */
5518 5518
     public function get_IDs($model_objects, $filter_out_empty_ids = false)
5519 5519
     {
5520
-        if (! $this->has_primary_key_field()) {
5520
+        if ( ! $this->has_primary_key_field()) {
5521 5521
             if (WP_DEBUG) {
5522 5522
                 EE_Error::add_error(
5523 5523
                     __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
@@ -5530,7 +5530,7 @@  discard block
 block discarded – undo
5530 5530
         $IDs = array();
5531 5531
         foreach ($model_objects as $model_object) {
5532 5532
             $id = $model_object->ID();
5533
-            if (! $id) {
5533
+            if ( ! $id) {
5534 5534
                 if ($filter_out_empty_ids) {
5535 5535
                     continue;
5536 5536
                 }
@@ -5626,8 +5626,8 @@  discard block
 block discarded – undo
5626 5626
         $missing_caps = array();
5627 5627
         $cap_restrictions = $this->cap_restrictions($context);
5628 5628
         foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5629
-            if (! EE_Capabilities::instance()
5630
-                                 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5629
+            if ( ! EE_Capabilities::instance()
5630
+                                 ->current_user_can($cap, $this->get_this_model_name().'_model_applying_caps')
5631 5631
             ) {
5632 5632
                 $missing_caps[$cap] = $restriction_if_no_cap;
5633 5633
             }
Please login to merge, or discard this patch.