Completed
Branch FET-10857-model-field-factory (375188)
by
unknown
118:39 queued 107:14
created
core/services/loaders/LoaderDecoratorInterface.php 1 patch
Indentation   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -9,20 +9,20 @@
 block discarded – undo
9 9
 interface LoaderDecoratorInterface
10 10
 {
11 11
 
12
-    /**
13
-     * @param string $fqcn
14
-     * @param array  $arguments
15
-     * @param bool   $shared
16
-     * @return mixed
17
-     */
18
-    public function load($fqcn, $arguments = array(), $shared = true);
12
+	/**
13
+	 * @param string $fqcn
14
+	 * @param array  $arguments
15
+	 * @param bool   $shared
16
+	 * @return mixed
17
+	 */
18
+	public function load($fqcn, $arguments = array(), $shared = true);
19 19
 
20 20
 
21 21
 
22
-    /**
23
-     * calls reset() on loader if method exists
24
-     */
25
-    public function reset();
22
+	/**
23
+	 * calls reset() on loader if method exists
24
+	 */
25
+	public function reset();
26 26
 
27 27
 }
28 28
 // End of file LoaderInterface.php
Please login to merge, or discard this patch.
core/services/loaders/Loader.php 1 patch
Indentation   +97 added lines, -97 removed lines patch added patch discarded remove patch
@@ -22,103 +22,103 @@
 block discarded – undo
22 22
 {
23 23
 
24 24
 
25
-    /**
26
-     * @var LoaderDecoratorInterface $new_loader
27
-     */
28
-    private $new_loader;
29
-
30
-
31
-    /**
32
-     * @var LoaderDecoratorInterface $shared_loader
33
-     */
34
-    private $shared_loader;
35
-
36
-
37
-
38
-    /**
39
-     * Loader constructor.
40
-     *
41
-     * @param LoaderDecoratorInterface|null $new_loader
42
-     * @param LoaderDecoratorInterface|null $shared_loader
43
-     * @throws InvalidInterfaceException
44
-     * @throws InvalidArgumentException
45
-     * @throws InvalidDataTypeException
46
-     */
47
-    public function __construct(LoaderDecoratorInterface $new_loader, LoaderDecoratorInterface $shared_loader)
48
-    {
49
-        $this->new_loader = $new_loader;
50
-        $this->shared_loader = $shared_loader;
51
-    }
52
-
53
-
54
-
55
-    /**
56
-     * @return LoaderDecoratorInterface
57
-     */
58
-    public function getNewLoader()
59
-    {
60
-        return $this->new_loader;
61
-    }
62
-
63
-
64
-
65
-    /**
66
-     * @return LoaderDecoratorInterface
67
-     */
68
-    public function getSharedLoader()
69
-    {
70
-        return $this->shared_loader;
71
-    }
72
-
73
-
74
-
75
-    /**
76
-     * @param string $fqcn
77
-     * @param array  $arguments
78
-     * @param bool   $shared
79
-     * @return mixed
80
-     */
81
-    public function load($fqcn, $arguments = array(), $shared = true)
82
-    {
83
-        return $shared
84
-            ? $this->getSharedLoader()->load($fqcn, $arguments)
85
-            : $this->getNewLoader()->load($fqcn, $arguments, false);
86
-    }
87
-
88
-
89
-
90
-    /**
91
-     * @param string $fqcn
92
-     * @param array  $arguments
93
-     * @return mixed
94
-     */
95
-    public function getNew($fqcn, $arguments = array())
96
-    {
97
-        return $this->getNewLoader()->load($fqcn, $arguments, false);
98
-    }
99
-
100
-
101
-
102
-    /**
103
-     * @param string $fqcn
104
-     * @param array  $arguments
105
-     * @return mixed
106
-     */
107
-    public function getShared($fqcn, $arguments = array())
108
-    {
109
-        return $this->getSharedLoader()->load($fqcn, $arguments);
110
-    }
111
-
112
-
113
-
114
-    /**
115
-     * calls reset() on loaders if that method exists
116
-     */
117
-    public function reset()
118
-    {
119
-        $this->new_loader->reset();
120
-        $this->shared_loader->reset();
121
-    }
25
+	/**
26
+	 * @var LoaderDecoratorInterface $new_loader
27
+	 */
28
+	private $new_loader;
29
+
30
+
31
+	/**
32
+	 * @var LoaderDecoratorInterface $shared_loader
33
+	 */
34
+	private $shared_loader;
35
+
36
+
37
+
38
+	/**
39
+	 * Loader constructor.
40
+	 *
41
+	 * @param LoaderDecoratorInterface|null $new_loader
42
+	 * @param LoaderDecoratorInterface|null $shared_loader
43
+	 * @throws InvalidInterfaceException
44
+	 * @throws InvalidArgumentException
45
+	 * @throws InvalidDataTypeException
46
+	 */
47
+	public function __construct(LoaderDecoratorInterface $new_loader, LoaderDecoratorInterface $shared_loader)
48
+	{
49
+		$this->new_loader = $new_loader;
50
+		$this->shared_loader = $shared_loader;
51
+	}
52
+
53
+
54
+
55
+	/**
56
+	 * @return LoaderDecoratorInterface
57
+	 */
58
+	public function getNewLoader()
59
+	{
60
+		return $this->new_loader;
61
+	}
62
+
63
+
64
+
65
+	/**
66
+	 * @return LoaderDecoratorInterface
67
+	 */
68
+	public function getSharedLoader()
69
+	{
70
+		return $this->shared_loader;
71
+	}
72
+
73
+
74
+
75
+	/**
76
+	 * @param string $fqcn
77
+	 * @param array  $arguments
78
+	 * @param bool   $shared
79
+	 * @return mixed
80
+	 */
81
+	public function load($fqcn, $arguments = array(), $shared = true)
82
+	{
83
+		return $shared
84
+			? $this->getSharedLoader()->load($fqcn, $arguments)
85
+			: $this->getNewLoader()->load($fqcn, $arguments, false);
86
+	}
87
+
88
+
89
+
90
+	/**
91
+	 * @param string $fqcn
92
+	 * @param array  $arguments
93
+	 * @return mixed
94
+	 */
95
+	public function getNew($fqcn, $arguments = array())
96
+	{
97
+		return $this->getNewLoader()->load($fqcn, $arguments, false);
98
+	}
99
+
100
+
101
+
102
+	/**
103
+	 * @param string $fqcn
104
+	 * @param array  $arguments
105
+	 * @return mixed
106
+	 */
107
+	public function getShared($fqcn, $arguments = array())
108
+	{
109
+		return $this->getSharedLoader()->load($fqcn, $arguments);
110
+	}
111
+
112
+
113
+
114
+	/**
115
+	 * calls reset() on loaders if that method exists
116
+	 */
117
+	public function reset()
118
+	{
119
+		$this->new_loader->reset();
120
+		$this->shared_loader->reset();
121
+	}
122 122
 
123 123
 }
124 124
 // End of file Loader.php
Please login to merge, or discard this patch.
core/db_models/EEM_Base.model.php 2 patches
Indentation   +5970 added lines, -5970 removed lines patch added patch discarded remove patch
@@ -32,5982 +32,5982 @@
 block discarded – undo
32 32
 abstract class EEM_Base extends EE_Base implements ResettableInterface
33 33
 {
34 34
 
35
-    //admin posty
36
-    //basic -> grants access to mine -> if they don't have it, select none
37
-    //*_others -> grants access to others that aren't private, and all mine -> if they don't have it, select mine
38
-    //*_private -> grants full access -> if dont have it, select all mine and others' non-private
39
-    //*_published -> grants access to published -> if they dont have it, select non-published
40
-    //*_global/default/system -> grants access to global items -> if they don't have it, select non-global
41
-    //publish_{thing} -> can change status TO publish; SPECIAL CASE
42
-    //frontend posty
43
-    //by default has access to published
44
-    //basic -> grants access to mine that aren't published, and all published
45
-    //*_others ->grants access to others that aren't private, all mine
46
-    //*_private -> grants full access
47
-    //frontend non-posty
48
-    //like admin posty
49
-    //category-y
50
-    //assign -> grants access to join-table
51
-    //(delete, edit)
52
-    //payment-method-y
53
-    //for each registered payment method,
54
-    //ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
55
-    /**
56
-     * Flag to indicate whether the values provided to EEM_Base have already been prepared
57
-     * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
58
-     * They almost always WILL NOT, but it's not necessarily a requirement.
59
-     * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
60
-     *
61
-     * @var boolean
62
-     */
63
-    private $_values_already_prepared_by_model_object = 0;
64
-
65
-    /**
66
-     * when $_values_already_prepared_by_model_object equals this, we assume
67
-     * the data is just like form input that needs to have the model fields'
68
-     * prepare_for_set and prepare_for_use_in_db called on it
69
-     */
70
-    const not_prepared_by_model_object = 0;
71
-
72
-    /**
73
-     * when $_values_already_prepared_by_model_object equals this, we
74
-     * assume this value is coming from a model object and doesn't need to have
75
-     * prepare_for_set called on it, just prepare_for_use_in_db is used
76
-     */
77
-    const prepared_by_model_object = 1;
78
-
79
-    /**
80
-     * when $_values_already_prepared_by_model_object equals this, we assume
81
-     * the values are already to be used in the database (ie no processing is done
82
-     * on them by the model's fields)
83
-     */
84
-    const prepared_for_use_in_db = 2;
85
-
86
-
87
-    protected $singular_item = 'Item';
88
-
89
-    protected $plural_item   = 'Items';
90
-
91
-    /**
92
-     * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
93
-     */
94
-    protected $_tables;
95
-
96
-    /**
97
-     * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
98
-     * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
99
-     * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
100
-     *
101
-     * @var \EE_Model_Field_Base[] $_fields
102
-     */
103
-    protected $_fields;
104
-
105
-    /**
106
-     * array of different kinds of relations
107
-     *
108
-     * @var \EE_Model_Relation_Base[] $_model_relations
109
-     */
110
-    protected $_model_relations;
111
-
112
-    /**
113
-     * @var \EE_Index[] $_indexes
114
-     */
115
-    protected $_indexes = array();
116
-
117
-    /**
118
-     * Default strategy for getting where conditions on this model. This strategy is used to get default
119
-     * where conditions which are added to get_all, update, and delete queries. They can be overridden
120
-     * by setting the same columns as used in these queries in the query yourself.
121
-     *
122
-     * @var EE_Default_Where_Conditions
123
-     */
124
-    protected $_default_where_conditions_strategy;
125
-
126
-    /**
127
-     * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
128
-     * This is particularly useful when you want something between 'none' and 'default'
129
-     *
130
-     * @var EE_Default_Where_Conditions
131
-     */
132
-    protected $_minimum_where_conditions_strategy;
133
-
134
-    /**
135
-     * String describing how to find the "owner" of this model's objects.
136
-     * When there is a foreign key on this model to the wp_users table, this isn't needed.
137
-     * But when there isn't, this indicates which related model, or transiently-related model,
138
-     * has the foreign key to the wp_users table.
139
-     * Eg, for EEM_Registration this would be 'Event' because registrations are directly
140
-     * related to events, and events have a foreign key to wp_users.
141
-     * On EEM_Transaction, this would be 'Transaction.Event'
142
-     *
143
-     * @var string
144
-     */
145
-    protected $_model_chain_to_wp_user = '';
146
-
147
-    /**
148
-     * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
149
-     * don't need it (particularly CPT models)
150
-     *
151
-     * @var bool
152
-     */
153
-    protected $_ignore_where_strategy = false;
154
-
155
-    /**
156
-     * String used in caps relating to this model. Eg, if the caps relating to this
157
-     * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
158
-     *
159
-     * @var string. If null it hasn't been initialized yet. If false then we
160
-     * have indicated capabilities don't apply to this
161
-     */
162
-    protected $_caps_slug = null;
163
-
164
-    /**
165
-     * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
166
-     * and next-level keys are capability names, and each's value is a
167
-     * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
168
-     * they specify which context to use (ie, frontend, backend, edit or delete)
169
-     * and then each capability in the corresponding sub-array that they're missing
170
-     * adds the where conditions onto the query.
171
-     *
172
-     * @var array
173
-     */
174
-    protected $_cap_restrictions = array(
175
-        self::caps_read       => array(),
176
-        self::caps_read_admin => array(),
177
-        self::caps_edit       => array(),
178
-        self::caps_delete     => array(),
179
-    );
180
-
181
-    /**
182
-     * Array defining which cap restriction generators to use to create default
183
-     * cap restrictions to put in EEM_Base::_cap_restrictions.
184
-     * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
185
-     * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
186
-     * automatically set this to false (not just null).
187
-     *
188
-     * @var EE_Restriction_Generator_Base[]
189
-     */
190
-    protected $_cap_restriction_generators = array();
191
-
192
-    /**
193
-     * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
194
-     */
195
-    const caps_read       = 'read';
196
-
197
-    const caps_read_admin = 'read_admin';
198
-
199
-    const caps_edit       = 'edit';
200
-
201
-    const caps_delete     = 'delete';
202
-
203
-    /**
204
-     * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
205
-     * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
206
-     * maps to 'read' because when looking for relevant permissions we're going to use
207
-     * 'read' in teh capabilities names like 'ee_read_events' etc.
208
-     *
209
-     * @var array
210
-     */
211
-    protected $_cap_contexts_to_cap_action_map = array(
212
-        self::caps_read       => 'read',
213
-        self::caps_read_admin => 'read',
214
-        self::caps_edit       => 'edit',
215
-        self::caps_delete     => 'delete',
216
-    );
217
-
218
-    /**
219
-     * Timezone
220
-     * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
221
-     * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
222
-     * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
223
-     * EE_Datetime_Field data type will have access to it.
224
-     *
225
-     * @var string
226
-     */
227
-    protected $_timezone;
228
-
229
-
230
-    /**
231
-     * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
232
-     * multisite.
233
-     *
234
-     * @var int
235
-     */
236
-    protected static $_model_query_blog_id;
237
-
238
-    /**
239
-     * A copy of _fields, except the array keys are the model names pointed to by
240
-     * the field
241
-     *
242
-     * @var EE_Model_Field_Base[]
243
-     */
244
-    private $_cache_foreign_key_to_fields = array();
245
-
246
-    /**
247
-     * Cached list of all the fields on the model, indexed by their name
248
-     *
249
-     * @var EE_Model_Field_Base[]
250
-     */
251
-    private $_cached_fields = null;
252
-
253
-    /**
254
-     * Cached list of all the fields on the model, except those that are
255
-     * marked as only pertinent to the database
256
-     *
257
-     * @var EE_Model_Field_Base[]
258
-     */
259
-    private $_cached_fields_non_db_only = null;
260
-
261
-    /**
262
-     * A cached reference to the primary key for quick lookup
263
-     *
264
-     * @var EE_Model_Field_Base
265
-     */
266
-    private $_primary_key_field = null;
267
-
268
-    /**
269
-     * Flag indicating whether this model has a primary key or not
270
-     *
271
-     * @var boolean
272
-     */
273
-    protected $_has_primary_key_field = null;
274
-
275
-    /**
276
-     * Whether or not this model is based off a table in WP core only (CPTs should set
277
-     * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
278
-     *
279
-     * @var boolean
280
-     */
281
-    protected $_wp_core_model = false;
282
-
283
-    /**
284
-     *    List of valid operators that can be used for querying.
285
-     * The keys are all operators we'll accept, the values are the real SQL
286
-     * operators used
287
-     *
288
-     * @var array
289
-     */
290
-    protected $_valid_operators = array(
291
-        '='           => '=',
292
-        '<='          => '<=',
293
-        '<'           => '<',
294
-        '>='          => '>=',
295
-        '>'           => '>',
296
-        '!='          => '!=',
297
-        'LIKE'        => 'LIKE',
298
-        'like'        => 'LIKE',
299
-        'NOT_LIKE'    => 'NOT LIKE',
300
-        'not_like'    => 'NOT LIKE',
301
-        'NOT LIKE'    => 'NOT LIKE',
302
-        'not like'    => 'NOT LIKE',
303
-        'IN'          => 'IN',
304
-        'in'          => 'IN',
305
-        'NOT_IN'      => 'NOT IN',
306
-        'not_in'      => 'NOT IN',
307
-        'NOT IN'      => 'NOT IN',
308
-        'not in'      => 'NOT IN',
309
-        'between'     => 'BETWEEN',
310
-        'BETWEEN'     => 'BETWEEN',
311
-        'IS_NOT_NULL' => 'IS NOT NULL',
312
-        'is_not_null' => 'IS NOT NULL',
313
-        'IS NOT NULL' => 'IS NOT NULL',
314
-        'is not null' => 'IS NOT NULL',
315
-        'IS_NULL'     => 'IS NULL',
316
-        'is_null'     => 'IS NULL',
317
-        'IS NULL'     => 'IS NULL',
318
-        'is null'     => 'IS NULL',
319
-        'REGEXP'      => 'REGEXP',
320
-        'regexp'      => 'REGEXP',
321
-        'NOT_REGEXP'  => 'NOT REGEXP',
322
-        'not_regexp'  => 'NOT REGEXP',
323
-        'NOT REGEXP'  => 'NOT REGEXP',
324
-        'not regexp'  => 'NOT REGEXP',
325
-    );
326
-
327
-    /**
328
-     * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
329
-     *
330
-     * @var array
331
-     */
332
-    protected $_in_style_operators = array('IN', 'NOT IN');
333
-
334
-    /**
335
-     * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
336
-     * '12-31-2012'"
337
-     *
338
-     * @var array
339
-     */
340
-    protected $_between_style_operators = array('BETWEEN');
341
-
342
-    /**
343
-     * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
344
-     * on a join table.
345
-     *
346
-     * @var array
347
-     */
348
-    protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
349
-
350
-    /**
351
-     * Allowed values for $query_params['order'] for ordering in queries
352
-     *
353
-     * @var array
354
-     */
355
-    protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
356
-
357
-    /**
358
-     * When these are keys in a WHERE or HAVING clause, they are handled much differently
359
-     * than regular field names. It is assumed that their values are an array of WHERE conditions
360
-     *
361
-     * @var array
362
-     */
363
-    private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
364
-
365
-    /**
366
-     * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
367
-     * 'where', but 'where' clauses are so common that we thought we'd omit it
368
-     *
369
-     * @var array
370
-     */
371
-    private $_allowed_query_params = array(
372
-        0,
373
-        'limit',
374
-        'order_by',
375
-        'group_by',
376
-        'having',
377
-        'force_join',
378
-        'order',
379
-        'on_join_limit',
380
-        'default_where_conditions',
381
-        'caps',
382
-    );
383
-
384
-    /**
385
-     * All the data types that can be used in $wpdb->prepare statements.
386
-     *
387
-     * @var array
388
-     */
389
-    private $_valid_wpdb_data_types = array('%d', '%s', '%f');
390
-
391
-    /**
392
-     *    EE_Registry Object
393
-     *
394
-     * @var    object
395
-     * @access    protected
396
-     */
397
-    protected $EE = null;
398
-
399
-
400
-    /**
401
-     * Property which, when set, will have this model echo out the next X queries to the page for debugging.
402
-     *
403
-     * @var int
404
-     */
405
-    protected $_show_next_x_db_queries = 0;
406
-
407
-    /**
408
-     * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
409
-     * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
410
-     *
411
-     * @var array
412
-     */
413
-    protected $_custom_selections = array();
414
-
415
-    /**
416
-     * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
417
-     * caches every model object we've fetched from the DB on this request
418
-     *
419
-     * @var array
420
-     */
421
-    protected $_entity_map;
422
-
423
-    /**
424
-     * constant used to show EEM_Base has not yet verified the db on this http request
425
-     */
426
-    const db_verified_none = 0;
427
-
428
-    /**
429
-     * constant used to show EEM_Base has verified the EE core db on this http request,
430
-     * but not the addons' dbs
431
-     */
432
-    const db_verified_core = 1;
433
-
434
-    /**
435
-     * constant used to show EEM_Base has verified the addons' dbs (and implicitly
436
-     * the EE core db too)
437
-     */
438
-    const db_verified_addons = 2;
439
-
440
-    /**
441
-     * indicates whether an EEM_Base child has already re-verified the DB
442
-     * is ok (we don't want to do it repetitively). Should be set to one the constants
443
-     * looking like EEM_Base::db_verified_*
444
-     *
445
-     * @var int - 0 = none, 1 = core, 2 = addons
446
-     */
447
-    protected static $_db_verification_level = EEM_Base::db_verified_none;
448
-
449
-    /**
450
-     * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
451
-     *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
452
-     *        registrations for non-trashed tickets for non-trashed datetimes)
453
-     */
454
-    const default_where_conditions_all = 'all';
455
-
456
-    /**
457
-     * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
458
-     *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
459
-     *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
460
-     *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
461
-     *        models which share tables with other models, this can return data for the wrong model.
462
-     */
463
-    const default_where_conditions_this_only = 'this_model_only';
464
-
465
-    /**
466
-     * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
467
-     *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
468
-     *        return all registrations related to non-trashed tickets and non-trashed datetimes)
469
-     */
470
-    const default_where_conditions_others_only = 'other_models_only';
471
-
472
-    /**
473
-     * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
474
-     *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
475
-     *        their table with other models, like the Event and Venue models. For example, when querying for events
476
-     *        ordered by their venues' name, this will be sure to only return real events with associated real venues
477
-     *        (regardless of whether those events and venues are trashed)
478
-     *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
479
-     *        events.
480
-     */
481
-    const default_where_conditions_minimum_all = 'minimum';
482
-
483
-    /**
484
-     * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
485
-     *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
486
-     *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
487
-     *        not)
488
-     */
489
-    const default_where_conditions_minimum_others = 'full_this_minimum_others';
490
-
491
-    /**
492
-     * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
493
-     *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
494
-     *        it's possible it will return table entries for other models. You should use
495
-     *        EEM_Base::default_where_conditions_minimum_all instead.
496
-     */
497
-    const default_where_conditions_none = 'none';
498
-
499
-
500
-
501
-    /**
502
-     * About all child constructors:
503
-     * they should define the _tables, _fields and _model_relations arrays.
504
-     * Should ALWAYS be called after child constructor.
505
-     * In order to make the child constructors to be as simple as possible, this parent constructor
506
-     * finalizes constructing all the object's attributes.
507
-     * Generally, rather than requiring a child to code
508
-     * $this->_tables = array(
509
-     *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
510
-     *        ...);
511
-     *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
512
-     * each EE_Table has a function to set the table's alias after the constructor, using
513
-     * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
514
-     * do something similar.
515
-     *
516
-     * @param null $timezone
517
-     * @throws EE_Error
518
-     */
519
-    protected function __construct($timezone = null)
520
-    {
521
-        // check that the model has not been loaded too soon
522
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
523
-            throw new EE_Error (
524
-                sprintf(
525
-                    __('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.',
526
-                        'event_espresso'),
527
-                    get_class($this)
528
-                )
529
-            );
530
-        }
531
-        /**
532
-         * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
533
-         */
534
-        if (empty(EEM_Base::$_model_query_blog_id)) {
535
-            EEM_Base::set_model_query_blog_id();
536
-        }
537
-        /**
538
-         * Filters the list of tables on a model. It is best to NOT use this directly and instead
539
-         * just use EE_Register_Model_Extension
540
-         *
541
-         * @var EE_Table_Base[] $_tables
542
-         */
543
-        $this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
544
-        foreach ($this->_tables as $table_alias => $table_obj) {
545
-            /** @var $table_obj EE_Table_Base */
546
-            $table_obj->_construct_finalize_with_alias($table_alias);
547
-            if ($table_obj instanceof EE_Secondary_Table) {
548
-                /** @var $table_obj EE_Secondary_Table */
549
-                $table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
550
-            }
551
-        }
552
-        /**
553
-         * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
554
-         * EE_Register_Model_Extension
555
-         *
556
-         * @param EE_Model_Field_Base[] $_fields
557
-         */
558
-        $this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
559
-        $this->_invalidate_field_caches();
560
-        foreach ($this->_fields as $table_alias => $fields_for_table) {
561
-            if (! array_key_exists($table_alias, $this->_tables)) {
562
-                throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
563
-                    'event_espresso'), $table_alias, implode(",", $this->_fields)));
564
-            }
565
-            foreach ($fields_for_table as $field_name => $field_obj) {
566
-                /** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
567
-                //primary key field base has a slightly different _construct_finalize
568
-                /** @var $field_obj EE_Model_Field_Base */
569
-                $field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
570
-            }
571
-        }
572
-        // everything is related to Extra_Meta
573
-        if (get_class($this) !== 'EEM_Extra_Meta') {
574
-            //make extra meta related to everything, but don't block deleting things just
575
-            //because they have related extra meta info. For now just orphan those extra meta
576
-            //in the future we should automatically delete them
577
-            $this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
578
-        }
579
-        //and change logs
580
-        if (get_class($this) !== 'EEM_Change_Log') {
581
-            $this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
582
-        }
583
-        /**
584
-         * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
585
-         * EE_Register_Model_Extension
586
-         *
587
-         * @param EE_Model_Relation_Base[] $_model_relations
588
-         */
589
-        $this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
590
-            $this->_model_relations);
591
-        foreach ($this->_model_relations as $model_name => $relation_obj) {
592
-            /** @var $relation_obj EE_Model_Relation_Base */
593
-            $relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
594
-        }
595
-        foreach ($this->_indexes as $index_name => $index_obj) {
596
-            /** @var $index_obj EE_Index */
597
-            $index_obj->_construct_finalize($index_name, $this->get_this_model_name());
598
-        }
599
-        $this->set_timezone($timezone);
600
-        //finalize default where condition strategy, or set default
601
-        if (! $this->_default_where_conditions_strategy) {
602
-            //nothing was set during child constructor, so set default
603
-            $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
604
-        }
605
-        $this->_default_where_conditions_strategy->_finalize_construct($this);
606
-        if (! $this->_minimum_where_conditions_strategy) {
607
-            //nothing was set during child constructor, so set default
608
-            $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
609
-        }
610
-        $this->_minimum_where_conditions_strategy->_finalize_construct($this);
611
-        //if the cap slug hasn't been set, and we haven't set it to false on purpose
612
-        //to indicate to NOT set it, set it to the logical default
613
-        if ($this->_caps_slug === null) {
614
-            $this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
615
-        }
616
-        //initialize the standard cap restriction generators if none were specified by the child constructor
617
-        if ($this->_cap_restriction_generators !== false) {
618
-            foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
619
-                if (! isset($this->_cap_restriction_generators[$cap_context])) {
620
-                    $this->_cap_restriction_generators[$cap_context] = apply_filters(
621
-                        'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
622
-                        new EE_Restriction_Generator_Protected(),
623
-                        $cap_context,
624
-                        $this
625
-                    );
626
-                }
627
-            }
628
-        }
629
-        //if there are cap restriction generators, use them to make the default cap restrictions
630
-        if ($this->_cap_restriction_generators !== false) {
631
-            foreach ($this->_cap_restriction_generators as $context => $generator_object) {
632
-                if (! $generator_object) {
633
-                    continue;
634
-                }
635
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
636
-                    throw new EE_Error(
637
-                        sprintf(
638
-                            __('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.',
639
-                                'event_espresso'),
640
-                            $context,
641
-                            $this->get_this_model_name()
642
-                        )
643
-                    );
644
-                }
645
-                $action = $this->cap_action_for_context($context);
646
-                if (! $generator_object->construction_finalized()) {
647
-                    $generator_object->_construct_finalize($this, $action);
648
-                }
649
-            }
650
-        }
651
-        do_action('AHEE__' . get_class($this) . '__construct__end');
652
-    }
653
-
654
-
655
-
656
-    /**
657
-     * Generates the cap restrictions for the given context, or if they were
658
-     * already generated just gets what's cached
659
-     *
660
-     * @param string $context one of EEM_Base::valid_cap_contexts()
661
-     * @return EE_Default_Where_Conditions[]
662
-     */
663
-    protected function _generate_cap_restrictions($context)
664
-    {
665
-        if (isset($this->_cap_restriction_generators[$context])
666
-            && $this->_cap_restriction_generators[$context]
667
-               instanceof
668
-               EE_Restriction_Generator_Base
669
-        ) {
670
-            return $this->_cap_restriction_generators[$context]->generate_restrictions();
671
-        } else {
672
-            return array();
673
-        }
674
-    }
675
-
676
-
677
-
678
-    /**
679
-     * Used to set the $_model_query_blog_id static property.
680
-     *
681
-     * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
682
-     *                      value for get_current_blog_id() will be used.
683
-     */
684
-    public static function set_model_query_blog_id($blog_id = 0)
685
-    {
686
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
687
-    }
688
-
689
-
690
-
691
-    /**
692
-     * Returns whatever is set as the internal $model_query_blog_id.
693
-     *
694
-     * @return int
695
-     */
696
-    public static function get_model_query_blog_id()
697
-    {
698
-        return EEM_Base::$_model_query_blog_id;
699
-    }
700
-
701
-
702
-
703
-    /**
704
-     * This function is a singleton method used to instantiate the Espresso_model object
705
-     *
706
-     * @param string            $timezone string representing the timezone we want to set for returned Date Time Strings
707
-     *                                    (and any incoming timezone data that gets saved).
708
-     *                                    Note this just sends the timezone info to the date time model field objects.
709
-     *                                    Default is NULL
710
-     *                                    (and will be assumed using the set timezone in the 'timezone_string' wp option)
711
-     * @param ModelFieldFactory $model_field_factory
712
-     * @return static (as in the concrete child class)
713
-     * @throws InvalidArgumentException
714
-     * @throws InvalidInterfaceException
715
-     * @throws InvalidDataTypeException
716
-     * @throws EE_Error
717
-     */
718
-    public static function instance($timezone = null, ModelFieldFactory $model_field_factory = null)
719
-    {
720
-        // check if instance of Espresso_model already exists
721
-        if (! static::$_instance instanceof static) {
722
-            $model_field_factory = self::getModelFieldFactory($model_field_factory);
723
-            // instantiate Espresso_model
724
-            static::$_instance = new static($timezone, $model_field_factory);
725
-        }
726
-        //we might have a timezone set, let set_timezone decide what to do with it
727
-        static::$_instance->set_timezone($timezone);
728
-        // Espresso_model object
729
-        return static::$_instance;
730
-    }
731
-
732
-
733
-
734
-    /**
735
-     * @param $model_field_factory
736
-     * @return ModelFieldFactory
737
-     * @throws InvalidArgumentException
738
-     * @throws InvalidDataTypeException
739
-     * @throws InvalidInterfaceException
740
-     */
741
-    private static function getModelFieldFactory($model_field_factory)
742
-    {
743
-        return $model_field_factory instanceof ModelFieldFactory
744
-            ? $model_field_factory
745
-            : LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory');
746
-    }
747
-
748
-
749
-
750
-    /**
751
-     * resets the model and returns it
752
-     *
753
-     * @param null | string          $timezone
754
-     * @param ModelFieldFactory|null $model_field_factory
755
-     * @return EEM_Base|null (if the model was already instantiated, returns it, with
756
-     * @throws ReflectionException
757
-     * all its properties reset; if it wasn't instantiated, returns null)
758
-     * @throws EE_Error
759
-     * @throws InvalidArgumentException
760
-     * @throws InvalidDataTypeException
761
-     * @throws InvalidInterfaceException
762
-     */
763
-    public static function reset($timezone = null, ModelFieldFactory $model_field_factory = null)
764
-    {
765
-        if (static::$_instance instanceof EEM_Base) {
766
-            //let's try to NOT swap out the current instance for a new one
767
-            //because if someone has a reference to it, we can't remove their reference
768
-            //so it's best to keep using the same reference, but change the original object
769
-            //reset all its properties to their original values as defined in the class
770
-            $r = new ReflectionClass(get_class(static::$_instance));
771
-            $static_properties = $r->getStaticProperties();
772
-            foreach ($r->getDefaultProperties() as $property => $value) {
773
-                //don't set instance to null like it was originally,
774
-                //but it's static anyways, and we're ignoring static properties (for now at least)
775
-                if (! isset($static_properties[$property])) {
776
-                    static::$_instance->{$property} = $value;
777
-                }
778
-            }
779
-            //and then directly call its constructor again, like we would if we were creating a new one
780
-            $model_field_factory = self::getModelFieldFactory($model_field_factory);
781
-            static::$_instance->__construct($timezone, $model_field_factory);
782
-            return self::instance();
783
-        }
784
-        return null;
785
-    }
786
-
787
-
788
-
789
-    /**
790
-     * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
791
-     *
792
-     * @param  boolean $translated return localized strings or JUST the array.
793
-     * @return array
794
-     * @throws EE_Error
795
-     */
796
-    public function status_array($translated = false)
797
-    {
798
-        if (! array_key_exists('Status', $this->_model_relations)) {
799
-            return array();
800
-        }
801
-        $model_name = $this->get_this_model_name();
802
-        $status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
803
-        $stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
804
-        $status_array = array();
805
-        foreach ($stati as $status) {
806
-            $status_array[$status->ID()] = $status->get('STS_code');
807
-        }
808
-        return $translated
809
-            ? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
810
-            : $status_array;
811
-    }
812
-
813
-
814
-
815
-    /**
816
-     * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
817
-     *
818
-     * @param array $query_params             {
819
-     * @var array $0 (where) array {
820
-     *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
821
-     *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
822
-     *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
823
-     *                                        conditions based on related models (and even
824
-     *                                        models-related-to-related-models) prepend the model's name onto the field
825
-     *                                        name. Eg,
826
-     *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
827
-     *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
828
-     *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
829
-     *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
830
-     *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
831
-     *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
832
-     *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
833
-     *                                        to Venues (even when each of those models actually consisted of two
834
-     *                                        tables). Also, you may chain the model relations together. Eg instead of
835
-     *                                        just having
836
-     *                                        "Venue.VNU_ID", you could have
837
-     *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
838
-     *                                        events are related to Registrations, which are related to Attendees). You
839
-     *                                        can take it even further with
840
-     *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
841
-     *                                        (from the default of '='), change the value to an numerically-indexed
842
-     *                                        array, where the first item in the list is the operator. eg: array(
843
-     *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
844
-     *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
845
-     *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
846
-     *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
847
-     *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
848
-     *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
849
-     *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
850
-     *                                        the operator is IN. Also, values can actually be field names. To indicate
851
-     *                                        the value is a field, simply provide a third array item (true) to the
852
-     *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
853
-     *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
854
-     *                                        Note: you can also use related model field names like you would any other
855
-     *                                        field name. eg:
856
-     *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
857
-     *                                        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__>' =>
858
-     *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
859
-     *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
860
-     *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
861
-     *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
862
-     *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
863
-     *                                        to be what you last specified. IE, "AND"s by default, but if you had
864
-     *                                        previously specified to use ORs to join, ORs will continue to be used.
865
-     *                                        So, if you specify to use an "OR" to join conditions, it will continue to
866
-     *                                        "stick" until you specify an AND. eg
867
-     *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
868
-     *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
869
-     *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
870
-     *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
871
-     *                                        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 >>
872
-     *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
873
-     *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
874
-     *                                        too, eg:
875
-     *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
876
-     * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
877
-     *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
878
-     *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
879
-     *                                        Remember when you provide two numbers for the limit, the 1st number is
880
-     *                                        the OFFSET, the 2nd is the LIMIT
881
-     * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
882
-     *                                        can do paging on one-to-many multi-table-joins. Send an array in the
883
-     *                                        following format array('on_join_limit'
884
-     *                                        => array( 'table_alias', array(1,2) ) ).
885
-     * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
886
-     *                                        values are either 'ASC' or 'DESC'.
887
-     *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
888
-     *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
889
-     *                                        DESC..." respectively. Like the
890
-     *                                        'where' conditions, these fields can be on related models. Eg
891
-     *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
892
-     *                                        perfectly valid from any model related to 'Registration' (like Event,
893
-     *                                        Attendee, Price, Datetime, etc.)
894
-     * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
895
-     *                                        'order' specifies whether to order the field specified in 'order_by' in
896
-     *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
897
-     *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
898
-     *                                        order by the primary key. Eg,
899
-     *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
900
-     *                                        //(will join with the Datetime model's table(s) and order by its field
901
-     *                                        DTT_EVT_start) or
902
-     *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
903
-     *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
904
-     * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
905
-     *                                        'group_by'=>'VNU_ID', or
906
-     *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
907
-     *                                        if no
908
-     *                                        $group_by is specified, and a limit is set, automatically groups by the
909
-     *                                        model's primary key (or combined primary keys). This avoids some
910
-     *                                        weirdness that results when using limits, tons of joins, and no group by,
911
-     *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
912
-     * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
913
-     *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
914
-     *                                        results)
915
-     * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
916
-     *                                        array where values are models to be joined in the query.Eg
917
-     *                                        array('Attendee','Payment','Datetime'). You may join with transient
918
-     *                                        models using period, eg "Registration.Transaction.Payment". You will
919
-     *                                        probably only want to do this in hopes of increasing efficiency, as
920
-     *                                        related models which belongs to the current model
921
-     *                                        (ie, the current model has a foreign key to them, like how Registration
922
-     *                                        belongs to Attendee) can be cached in order to avoid future queries
923
-     * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
924
-     *                                        set this to 'none' to disable all default where conditions. Eg, usually
925
-     *                                        soft-deleted objects are filtered-out if you want to include them, set
926
-     *                                        this query param to 'none'. If you want to ONLY disable THIS model's
927
-     *                                        default where conditions set it to 'other_models_only'. If you only want
928
-     *                                        this model's default where conditions added to the query, use
929
-     *                                        'this_model_only'. If you want to use all default where conditions
930
-     *                                        (default), set to 'all'.
931
-     * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
932
-     *                                        we just NOT apply any capabilities/permissions/restrictions and return
933
-     *                                        everything? Or should we only show the current user items they should be
934
-     *                                        able to view on the frontend, backend, edit, or delete? can be set to
935
-     *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
936
-     *                                        }
937
-     * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
938
-     *                                        from EE_Base_Class[], use _get_all_wpdb_results()and make it public
939
-     *                                        again. Array keys are object IDs (if there is a primary key on the model.
940
-     *                                        if not, numerically indexed) Some full examples: get 10 transactions
941
-     *                                        which have Scottish attendees: EEM_Transaction::instance()->get_all(
942
-     *                                        array( array(
943
-     *                                        'OR'=>array(
944
-     *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
945
-     *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
946
-     *                                        )
947
-     *                                        ),
948
-     *                                        'limit'=>10,
949
-     *                                        'group_by'=>'TXN_ID'
950
-     *                                        ));
951
-     *                                        get all the answers to the question titled "shirt size" for event with id
952
-     *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
953
-     *                                        'Question.QST_display_text'=>'shirt size',
954
-     *                                        'Registration.Event.EVT_ID'=>12
955
-     *                                        ),
956
-     *                                        'order_by'=>array('ANS_value'=>'ASC')
957
-     *                                        ));
958
-     * @throws EE_Error
959
-     */
960
-    public function get_all($query_params = array())
961
-    {
962
-        if (isset($query_params['limit'])
963
-            && ! isset($query_params['group_by'])
964
-        ) {
965
-            $query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
966
-        }
967
-        return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
968
-    }
969
-
970
-
971
-
972
-    /**
973
-     * Modifies the query parameters so we only get back model objects
974
-     * that "belong" to the current user
975
-     *
976
-     * @param array $query_params @see EEM_Base::get_all()
977
-     * @return array like EEM_Base::get_all
978
-     */
979
-    public function alter_query_params_to_only_include_mine($query_params = array())
980
-    {
981
-        $wp_user_field_name = $this->wp_user_field_name();
982
-        if ($wp_user_field_name) {
983
-            $query_params[0][$wp_user_field_name] = get_current_user_id();
984
-        }
985
-        return $query_params;
986
-    }
987
-
988
-
989
-
990
-    /**
991
-     * Returns the name of the field's name that points to the WP_User table
992
-     *  on this model (or follows the _model_chain_to_wp_user and uses that model's
993
-     * foreign key to the WP_User table)
994
-     *
995
-     * @return string|boolean string on success, boolean false when there is no
996
-     * foreign key to the WP_User table
997
-     */
998
-    public function wp_user_field_name()
999
-    {
1000
-        try {
1001
-            if (! empty($this->_model_chain_to_wp_user)) {
1002
-                $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
1003
-                $last_model_name = end($models_to_follow_to_wp_users);
1004
-                $model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
1005
-                $model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
1006
-            } else {
1007
-                $model_with_fk_to_wp_users = $this;
1008
-                $model_chain_to_wp_user = '';
1009
-            }
1010
-            $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
1011
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
1012
-        } catch (EE_Error $e) {
1013
-            return false;
1014
-        }
1015
-    }
1016
-
1017
-
1018
-
1019
-    /**
1020
-     * Returns the _model_chain_to_wp_user string, which indicates which related model
1021
-     * (or transiently-related model) has a foreign key to the wp_users table;
1022
-     * useful for finding if model objects of this type are 'owned' by the current user.
1023
-     * This is an empty string when the foreign key is on this model and when it isn't,
1024
-     * but is only non-empty when this model's ownership is indicated by a RELATED model
1025
-     * (or transiently-related model)
1026
-     *
1027
-     * @return string
1028
-     */
1029
-    public function model_chain_to_wp_user()
1030
-    {
1031
-        return $this->_model_chain_to_wp_user;
1032
-    }
1033
-
1034
-
1035
-
1036
-    /**
1037
-     * Whether this model is 'owned' by a specific wordpress user (even indirectly,
1038
-     * like how registrations don't have a foreign key to wp_users, but the
1039
-     * events they are for are), or is unrelated to wp users.
1040
-     * generally available
1041
-     *
1042
-     * @return boolean
1043
-     */
1044
-    public function is_owned()
1045
-    {
1046
-        if ($this->model_chain_to_wp_user()) {
1047
-            return true;
1048
-        }
1049
-        try {
1050
-            $this->get_foreign_key_to('WP_User');
1051
-            return true;
1052
-        } catch (EE_Error $e) {
1053
-            return false;
1054
-        }
1055
-    }
1056
-
1057
-
1058
-
1059
-    /**
1060
-     * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
1061
-     * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
1062
-     * the model)
1063
-     *
1064
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
1065
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1066
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1067
-     *                                  fields on the model, and the models we joined to in the query. However, you can
1068
-     *                                  override this and set the select to "*", or a specific column name, like
1069
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1070
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1071
-     *                                  the aliases used to refer to this selection, and values are to be
1072
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1073
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1074
-     * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1075
-     * @throws EE_Error
1076
-     */
1077
-    protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1078
-    {
1079
-        // remember the custom selections, if any, and type cast as array
1080
-        // (unless $columns_to_select is an object, then just set as an empty array)
1081
-        // Note: (array) 'some string' === array( 'some string' )
1082
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1083
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1084
-        $select_expressions = $columns_to_select !== null
1085
-            ? $this->_construct_select_from_input($columns_to_select)
1086
-            : $this->_construct_default_select_sql($model_query_info);
1087
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1088
-        return $this->_do_wpdb_query('get_results', array($SQL, $output));
1089
-    }
1090
-
1091
-
1092
-
1093
-    /**
1094
-     * Gets an array of rows from the database just like $wpdb->get_results would,
1095
-     * but you can use the $query_params like on EEM_Base::get_all() to more easily
1096
-     * take care of joins, field preparation etc.
1097
-     *
1098
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
1099
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1100
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1101
-     *                                  fields on the model, and the models we joined to in the query. However, you can
1102
-     *                                  override this and set the select to "*", or a specific column name, like
1103
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1104
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1105
-     *                                  the aliases used to refer to this selection, and values are to be
1106
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1107
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1108
-     * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1109
-     * @throws EE_Error
1110
-     */
1111
-    public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1112
-    {
1113
-        return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
1114
-    }
1115
-
1116
-
1117
-
1118
-    /**
1119
-     * For creating a custom select statement
1120
-     *
1121
-     * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
1122
-     *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
1123
-     *                                 SQL, and 1=>is the datatype
1124
-     * @throws EE_Error
1125
-     * @return string
1126
-     */
1127
-    private function _construct_select_from_input($columns_to_select)
1128
-    {
1129
-        if (is_array($columns_to_select)) {
1130
-            $select_sql_array = array();
1131
-            foreach ($columns_to_select as $alias => $selection_and_datatype) {
1132
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1133
-                    throw new EE_Error(
1134
-                        sprintf(
1135
-                            __(
1136
-                                "Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1137
-                                "event_espresso"
1138
-                            ),
1139
-                            $selection_and_datatype,
1140
-                            $alias
1141
-                        )
1142
-                    );
1143
-                }
1144
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1145
-                    throw new EE_Error(
1146
-                        sprintf(
1147
-                            __(
1148
-                                "Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1149
-                                "event_espresso"
1150
-                            ),
1151
-                            $selection_and_datatype[1],
1152
-                            $selection_and_datatype[0],
1153
-                            $alias,
1154
-                            implode(",", $this->_valid_wpdb_data_types)
1155
-                        )
1156
-                    );
1157
-                }
1158
-                $select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1159
-            }
1160
-            $columns_to_select_string = implode(", ", $select_sql_array);
1161
-        } else {
1162
-            $columns_to_select_string = $columns_to_select;
1163
-        }
1164
-        return $columns_to_select_string;
1165
-    }
1166
-
1167
-
1168
-
1169
-    /**
1170
-     * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1171
-     *
1172
-     * @return string
1173
-     * @throws EE_Error
1174
-     */
1175
-    public function primary_key_name()
1176
-    {
1177
-        return $this->get_primary_key_field()->get_name();
1178
-    }
1179
-
1180
-
1181
-
1182
-    /**
1183
-     * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1184
-     * If there is no primary key on this model, $id is treated as primary key string
1185
-     *
1186
-     * @param mixed $id int or string, depending on the type of the model's primary key
1187
-     * @return EE_Base_Class
1188
-     */
1189
-    public function get_one_by_ID($id)
1190
-    {
1191
-        if ($this->get_from_entity_map($id)) {
1192
-            return $this->get_from_entity_map($id);
1193
-        }
1194
-        return $this->get_one(
1195
-            $this->alter_query_params_to_restrict_by_ID(
1196
-                $id,
1197
-                array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
1198
-            )
1199
-        );
1200
-    }
1201
-
1202
-
1203
-
1204
-    /**
1205
-     * Alters query parameters to only get items with this ID are returned.
1206
-     * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1207
-     * or could just be a simple primary key ID
1208
-     *
1209
-     * @param int   $id
1210
-     * @param array $query_params
1211
-     * @return array of normal query params, @see EEM_Base::get_all
1212
-     * @throws EE_Error
1213
-     */
1214
-    public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1215
-    {
1216
-        if (! isset($query_params[0])) {
1217
-            $query_params[0] = array();
1218
-        }
1219
-        $conditions_from_id = $this->parse_index_primary_key_string($id);
1220
-        if ($conditions_from_id === null) {
1221
-            $query_params[0][$this->primary_key_name()] = $id;
1222
-        } else {
1223
-            //no primary key, so the $id must be from the get_index_primary_key_string()
1224
-            $query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1225
-        }
1226
-        return $query_params;
1227
-    }
1228
-
1229
-
1230
-
1231
-    /**
1232
-     * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1233
-     * array. If no item is found, null is returned.
1234
-     *
1235
-     * @param array $query_params like EEM_Base's $query_params variable.
1236
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1237
-     * @throws EE_Error
1238
-     */
1239
-    public function get_one($query_params = array())
1240
-    {
1241
-        if (! is_array($query_params)) {
1242
-            EE_Error::doing_it_wrong('EEM_Base::get_one',
1243
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1244
-                    gettype($query_params)), '4.6.0');
1245
-            $query_params = array();
1246
-        }
1247
-        $query_params['limit'] = 1;
1248
-        $items = $this->get_all($query_params);
1249
-        if (empty($items)) {
1250
-            return null;
1251
-        }
1252
-        return array_shift($items);
1253
-    }
1254
-
1255
-
1256
-
1257
-    /**
1258
-     * Returns the next x number of items in sequence from the given value as
1259
-     * 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 next_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(
1281
-            $current_field_value,
1282
-            '>',
1283
-            $field_to_order_by,
1284
-            $limit,
1285
-            $query_params,
1286
-            $columns_to_select
1287
-        );
1288
-    }
1289
-
1290
-
1291
-
1292
-    /**
1293
-     * Returns the previous x number of items in sequence from the given value
1294
-     * as found in the database matching the given query conditions.
1295
-     *
1296
-     * @param mixed $current_field_value    Value used for the reference point.
1297
-     * @param null  $field_to_order_by      What field is used for the
1298
-     *                                      reference point.
1299
-     * @param int   $limit                  How many to return.
1300
-     * @param array $query_params           Extra conditions on the query.
1301
-     * @param null  $columns_to_select      If left null, then an array of
1302
-     *                                      EE_Base_Class objects is returned,
1303
-     *                                      otherwise you can indicate just the
1304
-     *                                      columns you want returned.
1305
-     * @return EE_Base_Class[]|array
1306
-     * @throws EE_Error
1307
-     */
1308
-    public function previous_x(
1309
-        $current_field_value,
1310
-        $field_to_order_by = null,
1311
-        $limit = 1,
1312
-        $query_params = array(),
1313
-        $columns_to_select = null
1314
-    ) {
1315
-        return $this->_get_consecutive(
1316
-            $current_field_value,
1317
-            '<',
1318
-            $field_to_order_by,
1319
-            $limit,
1320
-            $query_params,
1321
-            $columns_to_select
1322
-        );
1323
-    }
1324
-
1325
-
1326
-
1327
-    /**
1328
-     * Returns the next item in sequence from the given value as found in the
1329
-     * database matching the given query conditions.
1330
-     *
1331
-     * @param mixed $current_field_value    Value used for the reference point.
1332
-     * @param null  $field_to_order_by      What field is used for the
1333
-     *                                      reference point.
1334
-     * @param array $query_params           Extra conditions on the query.
1335
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1336
-     *                                      object is returned, otherwise you
1337
-     *                                      can indicate just the columns you
1338
-     *                                      want and a single array indexed by
1339
-     *                                      the columns will be returned.
1340
-     * @return EE_Base_Class|null|array()
1341
-     * @throws EE_Error
1342
-     */
1343
-    public function next(
1344
-        $current_field_value,
1345
-        $field_to_order_by = null,
1346
-        $query_params = array(),
1347
-        $columns_to_select = null
1348
-    ) {
1349
-        $results = $this->_get_consecutive(
1350
-            $current_field_value,
1351
-            '>',
1352
-            $field_to_order_by,
1353
-            1,
1354
-            $query_params,
1355
-            $columns_to_select
1356
-        );
1357
-        return empty($results) ? null : reset($results);
1358
-    }
1359
-
1360
-
1361
-
1362
-    /**
1363
-     * Returns the previous item in sequence from the given value as found in
1364
-     * the database matching the given query conditions.
1365
-     *
1366
-     * @param mixed $current_field_value    Value used for the reference point.
1367
-     * @param null  $field_to_order_by      What field is used for the
1368
-     *                                      reference point.
1369
-     * @param array $query_params           Extra conditions on the query.
1370
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1371
-     *                                      object is returned, otherwise you
1372
-     *                                      can indicate just the columns you
1373
-     *                                      want and a single array indexed by
1374
-     *                                      the columns will be returned.
1375
-     * @return EE_Base_Class|null|array()
1376
-     * @throws EE_Error
1377
-     */
1378
-    public function previous(
1379
-        $current_field_value,
1380
-        $field_to_order_by = null,
1381
-        $query_params = array(),
1382
-        $columns_to_select = null
1383
-    ) {
1384
-        $results = $this->_get_consecutive(
1385
-            $current_field_value,
1386
-            '<',
1387
-            $field_to_order_by,
1388
-            1,
1389
-            $query_params,
1390
-            $columns_to_select
1391
-        );
1392
-        return empty($results) ? null : reset($results);
1393
-    }
1394
-
1395
-
1396
-
1397
-    /**
1398
-     * Returns the a consecutive number of items in sequence from the given
1399
-     * value as found in the database matching the given query conditions.
1400
-     *
1401
-     * @param mixed  $current_field_value   Value used for the reference point.
1402
-     * @param string $operand               What operand is used for the sequence.
1403
-     * @param string $field_to_order_by     What field is used for the reference point.
1404
-     * @param int    $limit                 How many to return.
1405
-     * @param array  $query_params          Extra conditions on the query.
1406
-     * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1407
-     *                                      otherwise you can indicate just the columns you want returned.
1408
-     * @return EE_Base_Class[]|array
1409
-     * @throws EE_Error
1410
-     */
1411
-    protected function _get_consecutive(
1412
-        $current_field_value,
1413
-        $operand = '>',
1414
-        $field_to_order_by = null,
1415
-        $limit = 1,
1416
-        $query_params = array(),
1417
-        $columns_to_select = null
1418
-    ) {
1419
-        //if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1420
-        if (empty($field_to_order_by)) {
1421
-            if ($this->has_primary_key_field()) {
1422
-                $field_to_order_by = $this->get_primary_key_field()->get_name();
1423
-            } else {
1424
-                if (WP_DEBUG) {
1425
-                    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).',
1426
-                        'event_espresso'));
1427
-                }
1428
-                EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1429
-                return array();
1430
-            }
1431
-        }
1432
-        if (! is_array($query_params)) {
1433
-            EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1434
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1435
-                    gettype($query_params)), '4.6.0');
1436
-            $query_params = array();
1437
-        }
1438
-        //let's add the where query param for consecutive look up.
1439
-        $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1440
-        $query_params['limit'] = $limit;
1441
-        //set direction
1442
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1443
-        $query_params['order_by'] = $operand === '>'
1444
-            ? array($field_to_order_by => 'ASC') + $incoming_orderby
1445
-            : array($field_to_order_by => 'DESC') + $incoming_orderby;
1446
-        //if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1447
-        if (empty($columns_to_select)) {
1448
-            return $this->get_all($query_params);
1449
-        }
1450
-        //getting just the fields
1451
-        return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1452
-    }
1453
-
1454
-
1455
-
1456
-    /**
1457
-     * This sets the _timezone property after model object has been instantiated.
1458
-     *
1459
-     * @param null | string $timezone valid PHP DateTimeZone timezone string
1460
-     */
1461
-    public function set_timezone($timezone)
1462
-    {
1463
-        if ($timezone !== null) {
1464
-            $this->_timezone = $timezone;
1465
-        }
1466
-        //note we need to loop through relations and set the timezone on those objects as well.
1467
-        foreach ($this->_model_relations as $relation) {
1468
-            $relation->set_timezone($timezone);
1469
-        }
1470
-        //and finally we do the same for any datetime fields
1471
-        foreach ($this->_fields as $field) {
1472
-            if ($field instanceof EE_Datetime_Field) {
1473
-                $field->set_timezone($timezone);
1474
-            }
1475
-        }
1476
-    }
1477
-
1478
-
1479
-
1480
-    /**
1481
-     * This just returns whatever is set for the current timezone.
1482
-     *
1483
-     * @access public
1484
-     * @return string
1485
-     */
1486
-    public function get_timezone()
1487
-    {
1488
-        //first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1489
-        if (empty($this->_timezone)) {
1490
-            foreach ($this->_fields as $field) {
1491
-                if ($field instanceof EE_Datetime_Field) {
1492
-                    $this->set_timezone($field->get_timezone());
1493
-                    break;
1494
-                }
1495
-            }
1496
-        }
1497
-        //if timezone STILL empty then return the default timezone for the site.
1498
-        if (empty($this->_timezone)) {
1499
-            $this->set_timezone(EEH_DTT_Helper::get_timezone());
1500
-        }
1501
-        return $this->_timezone;
1502
-    }
1503
-
1504
-
1505
-
1506
-    /**
1507
-     * This returns the date formats set for the given field name and also ensures that
1508
-     * $this->_timezone property is set correctly.
1509
-     *
1510
-     * @since 4.6.x
1511
-     * @param string $field_name The name of the field the formats are being retrieved for.
1512
-     * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1513
-     * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1514
-     * @return array formats in an array with the date format first, and the time format last.
1515
-     */
1516
-    public function get_formats_for($field_name, $pretty = false)
1517
-    {
1518
-        $field_settings = $this->field_settings_for($field_name);
1519
-        //if not a valid EE_Datetime_Field then throw error
1520
-        if (! $field_settings instanceof EE_Datetime_Field) {
1521
-            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.',
1522
-                'event_espresso'), $field_name));
1523
-        }
1524
-        //while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1525
-        //the field.
1526
-        $this->_timezone = $field_settings->get_timezone();
1527
-        return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1528
-    }
1529
-
1530
-
1531
-
1532
-    /**
1533
-     * This returns the current time in a format setup for a query on this model.
1534
-     * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1535
-     * it will return:
1536
-     *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1537
-     *  NOW
1538
-     *  - or a unix timestamp (equivalent to time())
1539
-     * Note: When requesting a formatted string, if the date or time format doesn't include seconds, for example,
1540
-     * the time returned, because it uses that format, will also NOT include seconds. For this reason, if you want
1541
-     * the time returned to be the current time down to the exact second, set $timestamp to true.
1542
-     * @since 4.6.x
1543
-     * @param string $field_name       The field the current time is needed for.
1544
-     * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1545
-     *                                 formatted string matching the set format for the field in the set timezone will
1546
-     *                                 be returned.
1547
-     * @param string $what             Whether to return the string in just the time format, the date format, or both.
1548
-     * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1549
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1550
-     *                                 exception is triggered.
1551
-     */
1552
-    public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1553
-    {
1554
-        $formats = $this->get_formats_for($field_name);
1555
-        $DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1556
-        if ($timestamp) {
1557
-            return $DateTime->format('U');
1558
-        }
1559
-        //not returning timestamp, so return formatted string in timezone.
1560
-        switch ($what) {
1561
-            case 'time' :
1562
-                return $DateTime->format($formats[1]);
1563
-                break;
1564
-            case 'date' :
1565
-                return $DateTime->format($formats[0]);
1566
-                break;
1567
-            default :
1568
-                return $DateTime->format(implode(' ', $formats));
1569
-                break;
1570
-        }
1571
-    }
1572
-
1573
-
1574
-
1575
-    /**
1576
-     * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1577
-     * for the model are.  Returns a DateTime object.
1578
-     * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1579
-     * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1580
-     * ignored.
1581
-     *
1582
-     * @param string $field_name      The field being setup.
1583
-     * @param string $timestring      The date time string being used.
1584
-     * @param string $incoming_format The format for the time string.
1585
-     * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1586
-     *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1587
-     *                                format is
1588
-     *                                'U', this is ignored.
1589
-     * @return DateTime
1590
-     * @throws EE_Error
1591
-     */
1592
-    public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1593
-    {
1594
-        //just using this to ensure the timezone is set correctly internally
1595
-        $this->get_formats_for($field_name);
1596
-        //load EEH_DTT_Helper
1597
-        $set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1598
-        $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1599
-        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1600
-    }
1601
-
1602
-
1603
-
1604
-    /**
1605
-     * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1606
-     *
1607
-     * @return EE_Table_Base[]
1608
-     */
1609
-    public function get_tables()
1610
-    {
1611
-        return $this->_tables;
1612
-    }
1613
-
1614
-
1615
-
1616
-    /**
1617
-     * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1618
-     * also updates all the model objects, where the criteria expressed in $query_params are met..
1619
-     * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1620
-     * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1621
-     * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1622
-     * model object with EVT_ID = 1
1623
-     * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1624
-     * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1625
-     * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1626
-     * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1627
-     * are not specified)
1628
-     *
1629
-     * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1630
-     *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1631
-     *                                         are to be serialized. Basically, the values are what you'd expect to be
1632
-     *                                         values on the model, NOT necessarily what's in the DB. For example, if
1633
-     *                                         we wanted to update only the TXN_details on any Transactions where its
1634
-     *                                         ID=34, we'd use this method as follows:
1635
-     *                                         EEM_Transaction::instance()->update(
1636
-     *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1637
-     *                                         array(array('TXN_ID'=>34)));
1638
-     * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1639
-     *                                         in client code into what's expected to be stored on each field. Eg,
1640
-     *                                         consider updating Question's QST_admin_label field is of type
1641
-     *                                         Simple_HTML. If you use this function to update that field to $new_value
1642
-     *                                         = (note replace 8's with appropriate opening and closing tags in the
1643
-     *                                         following example)"8script8alert('I hack all');8/script88b8boom
1644
-     *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1645
-     *                                         TRUE, it is assumed that you've already called
1646
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1647
-     *                                         malicious javascript. However, if
1648
-     *                                         $values_already_prepared_by_model_object is left as FALSE, then
1649
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
1650
-     *                                         and every other field, before insertion. We provide this parameter
1651
-     *                                         because model objects perform their prepare_for_set function on all
1652
-     *                                         their values, and so don't need to be called again (and in many cases,
1653
-     *                                         shouldn't be called again. Eg: if we escape HTML characters in the
1654
-     *                                         prepare_for_set method...)
1655
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1656
-     *                                         in this model's entity map according to $fields_n_values that match
1657
-     *                                         $query_params. This obviously has some overhead, so you can disable it
1658
-     *                                         by setting this to FALSE, but be aware that model objects being used
1659
-     *                                         could get out-of-sync with the database
1660
-     * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1661
-     *                                         rows affected which *could* include 0 which DOES NOT mean the query was
1662
-     *                                         bad)
1663
-     * @throws EE_Error
1664
-     */
1665
-    public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1666
-    {
1667
-        if (! is_array($query_params)) {
1668
-            EE_Error::doing_it_wrong('EEM_Base::update',
1669
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1670
-                    gettype($query_params)), '4.6.0');
1671
-            $query_params = array();
1672
-        }
1673
-        /**
1674
-         * Action called before a model update call has been made.
1675
-         *
1676
-         * @param EEM_Base $model
1677
-         * @param array    $fields_n_values the updated fields and their new values
1678
-         * @param array    $query_params    @see EEM_Base::get_all()
1679
-         */
1680
-        do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1681
-        /**
1682
-         * Filters the fields about to be updated given the query parameters. You can provide the
1683
-         * $query_params to $this->get_all() to find exactly which records will be updated
1684
-         *
1685
-         * @param array    $fields_n_values fields and their new values
1686
-         * @param EEM_Base $model           the model being queried
1687
-         * @param array    $query_params    see EEM_Base::get_all()
1688
-         */
1689
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1690
-            $query_params);
1691
-        //need to verify that, for any entry we want to update, there are entries in each secondary table.
1692
-        //to do that, for each table, verify that it's PK isn't null.
1693
-        $tables = $this->get_tables();
1694
-        //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
1695
-        //NOTE: we should make this code more efficient by NOT querying twice
1696
-        //before the real update, but that needs to first go through ALPHA testing
1697
-        //as it's dangerous. says Mike August 8 2014
1698
-        //we want to make sure the default_where strategy is ignored
1699
-        $this->_ignore_where_strategy = true;
1700
-        $wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1701
-        foreach ($wpdb_select_results as $wpdb_result) {
1702
-            // type cast stdClass as array
1703
-            $wpdb_result = (array)$wpdb_result;
1704
-            //get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1705
-            if ($this->has_primary_key_field()) {
1706
-                $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1707
-            } else {
1708
-                //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)
1709
-                $main_table_pk_value = null;
1710
-            }
1711
-            //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
1712
-            //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
1713
-            if (count($tables) > 1) {
1714
-                //foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1715
-                //in that table, and so we'll want to insert one
1716
-                foreach ($tables as $table_obj) {
1717
-                    $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1718
-                    //if there is no private key for this table on the results, it means there's no entry
1719
-                    //in this table, right? so insert a row in the current table, using any fields available
1720
-                    if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1721
-                           && $wpdb_result[$this_table_pk_column])
1722
-                    ) {
1723
-                        $success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1724
-                            $main_table_pk_value);
1725
-                        //if we died here, report the error
1726
-                        if (! $success) {
1727
-                            return false;
1728
-                        }
1729
-                    }
1730
-                }
1731
-            }
1732
-            //				//and now check that if we have cached any models by that ID on the model, that
1733
-            //				//they also get updated properly
1734
-            //				$model_object = $this->get_from_entity_map( $main_table_pk_value );
1735
-            //				if( $model_object ){
1736
-            //					foreach( $fields_n_values as $field => $value ){
1737
-            //						$model_object->set($field, $value);
1738
-            //let's make sure default_where strategy is followed now
1739
-            $this->_ignore_where_strategy = false;
1740
-        }
1741
-        //if we want to keep model objects in sync, AND
1742
-        //if this wasn't called from a model object (to update itself)
1743
-        //then we want to make sure we keep all the existing
1744
-        //model objects in sync with the db
1745
-        if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1746
-            if ($this->has_primary_key_field()) {
1747
-                $model_objs_affected_ids = $this->get_col($query_params);
1748
-            } else {
1749
-                //we need to select a bunch of columns and then combine them into the the "index primary key string"s
1750
-                $models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1751
-                $model_objs_affected_ids = array();
1752
-                foreach ($models_affected_key_columns as $row) {
1753
-                    $combined_index_key = $this->get_index_primary_key_string($row);
1754
-                    $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1755
-                }
1756
-            }
1757
-            if (! $model_objs_affected_ids) {
1758
-                //wait wait wait- if nothing was affected let's stop here
1759
-                return 0;
1760
-            }
1761
-            foreach ($model_objs_affected_ids as $id) {
1762
-                $model_obj_in_entity_map = $this->get_from_entity_map($id);
1763
-                if ($model_obj_in_entity_map) {
1764
-                    foreach ($fields_n_values as $field => $new_value) {
1765
-                        $model_obj_in_entity_map->set($field, $new_value);
1766
-                    }
1767
-                }
1768
-            }
1769
-            //if there is a primary key on this model, we can now do a slight optimization
1770
-            if ($this->has_primary_key_field()) {
1771
-                //we already know what we want to update. So let's make the query simpler so it's a little more efficient
1772
-                $query_params = array(
1773
-                    array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1774
-                    'limit'                    => count($model_objs_affected_ids),
1775
-                    'default_where_conditions' => EEM_Base::default_where_conditions_none,
1776
-                );
1777
-            }
1778
-        }
1779
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1780
-        $SQL = "UPDATE "
1781
-               . $model_query_info->get_full_join_sql()
1782
-               . " SET "
1783
-               . $this->_construct_update_sql($fields_n_values)
1784
-               . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1785
-        $rows_affected = $this->_do_wpdb_query('query', array($SQL));
1786
-        /**
1787
-         * Action called after a model update call has been made.
1788
-         *
1789
-         * @param EEM_Base $model
1790
-         * @param array    $fields_n_values the updated fields and their new values
1791
-         * @param array    $query_params    @see EEM_Base::get_all()
1792
-         * @param int      $rows_affected
1793
-         */
1794
-        do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1795
-        return $rows_affected;//how many supposedly got updated
1796
-    }
1797
-
1798
-
1799
-
1800
-    /**
1801
-     * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1802
-     * are teh values of the field specified (or by default the primary key field)
1803
-     * that matched the query params. Note that you should pass the name of the
1804
-     * model FIELD, not the database table's column name.
1805
-     *
1806
-     * @param array  $query_params @see EEM_Base::get_all()
1807
-     * @param string $field_to_select
1808
-     * @return array just like $wpdb->get_col()
1809
-     * @throws EE_Error
1810
-     */
1811
-    public function get_col($query_params = array(), $field_to_select = null)
1812
-    {
1813
-        if ($field_to_select) {
1814
-            $field = $this->field_settings_for($field_to_select);
1815
-        } elseif ($this->has_primary_key_field()) {
1816
-            $field = $this->get_primary_key_field();
1817
-        } else {
1818
-            //no primary key, just grab the first column
1819
-            $field = reset($this->field_settings());
1820
-        }
1821
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1822
-        $select_expressions = $field->get_qualified_column();
1823
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1824
-        return $this->_do_wpdb_query('get_col', array($SQL));
1825
-    }
1826
-
1827
-
1828
-
1829
-    /**
1830
-     * Returns a single column value for a single row from the database
1831
-     *
1832
-     * @param array  $query_params    @see EEM_Base::get_all()
1833
-     * @param string $field_to_select @see EEM_Base::get_col()
1834
-     * @return string
1835
-     * @throws EE_Error
1836
-     */
1837
-    public function get_var($query_params = array(), $field_to_select = null)
1838
-    {
1839
-        $query_params['limit'] = 1;
1840
-        $col = $this->get_col($query_params, $field_to_select);
1841
-        if (! empty($col)) {
1842
-            return reset($col);
1843
-        }
1844
-        return null;
1845
-    }
1846
-
1847
-
1848
-
1849
-    /**
1850
-     * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1851
-     * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1852
-     * injection, but currently no further filtering is done
1853
-     *
1854
-     * @global      $wpdb
1855
-     * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1856
-     *                               be updated to in the DB
1857
-     * @return string of SQL
1858
-     * @throws EE_Error
1859
-     */
1860
-    public function _construct_update_sql($fields_n_values)
1861
-    {
1862
-        /** @type WPDB $wpdb */
1863
-        global $wpdb;
1864
-        $cols_n_values = array();
1865
-        foreach ($fields_n_values as $field_name => $value) {
1866
-            $field_obj = $this->field_settings_for($field_name);
1867
-            //if the value is NULL, we want to assign the value to that.
1868
-            //wpdb->prepare doesn't really handle that properly
1869
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1870
-            $value_sql = $prepared_value === null ? 'NULL'
1871
-                : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1872
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1873
-        }
1874
-        return implode(",", $cols_n_values);
1875
-    }
1876
-
1877
-
1878
-
1879
-    /**
1880
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1881
-     * Performs a HARD delete, meaning the database row should always be removed,
1882
-     * not just have a flag field on it switched
1883
-     * Wrapper for EEM_Base::delete_permanently()
1884
-     *
1885
-     * @param mixed $id
1886
-     * @return boolean whether the row got deleted or not
1887
-     * @throws EE_Error
1888
-     */
1889
-    public function delete_permanently_by_ID($id)
1890
-    {
1891
-        return $this->delete_permanently(
1892
-            array(
1893
-                array($this->get_primary_key_field()->get_name() => $id),
1894
-                'limit' => 1,
1895
-            )
1896
-        );
1897
-    }
1898
-
1899
-
1900
-
1901
-    /**
1902
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1903
-     * Wrapper for EEM_Base::delete()
1904
-     *
1905
-     * @param mixed $id
1906
-     * @return boolean whether the row got deleted or not
1907
-     * @throws EE_Error
1908
-     */
1909
-    public function delete_by_ID($id)
1910
-    {
1911
-        return $this->delete(
1912
-            array(
1913
-                array($this->get_primary_key_field()->get_name() => $id),
1914
-                'limit' => 1,
1915
-            )
1916
-        );
1917
-    }
1918
-
1919
-
1920
-
1921
-    /**
1922
-     * Identical to delete_permanently, but does a "soft" delete if possible,
1923
-     * meaning if the model has a field that indicates its been "trashed" or
1924
-     * "soft deleted", we will just set that instead of actually deleting the rows.
1925
-     *
1926
-     * @see EEM_Base::delete_permanently
1927
-     * @param array   $query_params
1928
-     * @param boolean $allow_blocking
1929
-     * @return int how many rows got deleted
1930
-     * @throws EE_Error
1931
-     */
1932
-    public function delete($query_params, $allow_blocking = true)
1933
-    {
1934
-        return $this->delete_permanently($query_params, $allow_blocking);
1935
-    }
1936
-
1937
-
1938
-
1939
-    /**
1940
-     * Deletes the model objects that meet the query params. Note: this method is overridden
1941
-     * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1942
-     * as archived, not actually deleted
1943
-     *
1944
-     * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1945
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1946
-     *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1947
-     *                                deletes regardless of other objects which may depend on it. Its generally
1948
-     *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1949
-     *                                DB
1950
-     * @return int how many rows got deleted
1951
-     * @throws EE_Error
1952
-     */
1953
-    public function delete_permanently($query_params, $allow_blocking = true)
1954
-    {
1955
-        /**
1956
-         * Action called just before performing a real deletion query. You can use the
1957
-         * model and its $query_params to find exactly which items will be deleted
1958
-         *
1959
-         * @param EEM_Base $model
1960
-         * @param array    $query_params   @see EEM_Base::get_all()
1961
-         * @param boolean  $allow_blocking whether or not to allow related model objects
1962
-         *                                 to block (prevent) this deletion
1963
-         */
1964
-        do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1965
-        //some MySQL databases may be running safe mode, which may restrict
1966
-        //deletion if there is no KEY column used in the WHERE statement of a deletion.
1967
-        //to get around this, we first do a SELECT, get all the IDs, and then run another query
1968
-        //to delete them
1969
-        $items_for_deletion = $this->_get_all_wpdb_results($query_params);
1970
-        $columns_and_ids_for_deleting = $this->_get_ids_for_delete($items_for_deletion, $allow_blocking);
1971
-        $deletion_where_query_part = $this->_build_query_part_for_deleting_from_columns_and_values(
1972
-            $columns_and_ids_for_deleting
1973
-        );
1974
-        /**
1975
-         * Allows client code to act on the items being deleted before the query is actually executed.
1976
-         *
1977
-         * @param EEM_Base $this  The model instance being acted on.
1978
-         * @param array    $query_params  The incoming array of query parameters influencing what gets deleted.
1979
-         * @param bool     $allow_blocking @see param description in method phpdoc block.
1980
-         * @param array $columns_and_ids_for_deleting       An array indicating what entities will get removed as
1981
-         *                                                  derived from the incoming query parameters.
1982
-         *                                                  @see details on the structure of this array in the phpdocs
1983
-         *                                                  for the `_get_ids_for_delete_method`
1984
-         *
1985
-         */
1986
-        do_action('AHEE__EEM_Base__delete__before_query',
1987
-            $this,
1988
-            $query_params,
1989
-            $allow_blocking,
1990
-            $columns_and_ids_for_deleting
1991
-        );
1992
-        if ($deletion_where_query_part) {
1993
-            $model_query_info = $this->_create_model_query_info_carrier($query_params);
1994
-            $table_aliases = array_keys($this->_tables);
1995
-            $SQL = "DELETE "
1996
-                   . implode(", ", $table_aliases)
1997
-                   . " FROM "
1998
-                   . $model_query_info->get_full_join_sql()
1999
-                   . " WHERE "
2000
-                   . $deletion_where_query_part;
2001
-            $rows_deleted = $this->_do_wpdb_query('query', array($SQL));
2002
-        } else {
2003
-            $rows_deleted = 0;
2004
-        }
2005
-
2006
-        //Next, make sure those items are removed from the entity map; if they could be put into it at all; and if
2007
-        //there was no error with the delete query.
2008
-        if ($this->has_primary_key_field()
2009
-            && $rows_deleted !== false
2010
-            && isset($columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()])
2011
-        ) {
2012
-            $ids_for_removal = $columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()];
2013
-            foreach ($ids_for_removal as $id) {
2014
-                if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
2015
-                    unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
2016
-                }
2017
-            }
2018
-
2019
-            // delete any extra meta attached to the deleted entities but ONLY if this model is not an instance of
2020
-            //`EEM_Extra_Meta`.  In other words we want to prevent recursion on EEM_Extra_Meta::delete_permanently calls
2021
-            //unnecessarily.  It's very unlikely that users will have assigned Extra Meta to Extra Meta
2022
-            // (although it is possible).
2023
-            //Note this can be skipped by using the provided filter and returning false.
2024
-            if (apply_filters(
2025
-                'FHEE__EEM_Base__delete_permanently__dont_delete_extra_meta_for_extra_meta',
2026
-                ! $this instanceof EEM_Extra_Meta,
2027
-                $this
2028
-            )) {
2029
-                EEM_Extra_Meta::instance()->delete_permanently(array(
2030
-                    0 => array(
2031
-                        'EXM_type' => $this->get_this_model_name(),
2032
-                        'OBJ_ID'   => array(
2033
-                            'IN',
2034
-                            $ids_for_removal
2035
-                        )
2036
-                    )
2037
-                ));
2038
-            }
2039
-        }
2040
-
2041
-        /**
2042
-         * Action called just after performing a real deletion query. Although at this point the
2043
-         * items should have been deleted
2044
-         *
2045
-         * @param EEM_Base $model
2046
-         * @param array    $query_params @see EEM_Base::get_all()
2047
-         * @param int      $rows_deleted
2048
-         */
2049
-        do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
2050
-        return $rows_deleted;//how many supposedly got deleted
2051
-    }
2052
-
2053
-
2054
-
2055
-    /**
2056
-     * Checks all the relations that throw error messages when there are blocking related objects
2057
-     * for related model objects. If there are any related model objects on those relations,
2058
-     * adds an EE_Error, and return true
2059
-     *
2060
-     * @param EE_Base_Class|int $this_model_obj_or_id
2061
-     * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
2062
-     *                                                 should be ignored when determining whether there are related
2063
-     *                                                 model objects which block this model object's deletion. Useful
2064
-     *                                                 if you know A is related to B and are considering deleting A,
2065
-     *                                                 but want to see if A has any other objects blocking its deletion
2066
-     *                                                 before removing the relation between A and B
2067
-     * @return boolean
2068
-     * @throws EE_Error
2069
-     */
2070
-    public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
2071
-    {
2072
-        //first, if $ignore_this_model_obj was supplied, get its model
2073
-        if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
2074
-            $ignored_model = $ignore_this_model_obj->get_model();
2075
-        } else {
2076
-            $ignored_model = null;
2077
-        }
2078
-        //now check all the relations of $this_model_obj_or_id and see if there
2079
-        //are any related model objects blocking it?
2080
-        $is_blocked = false;
2081
-        foreach ($this->_model_relations as $relation_name => $relation_obj) {
2082
-            if ($relation_obj->block_delete_if_related_models_exist()) {
2083
-                //if $ignore_this_model_obj was supplied, then for the query
2084
-                //on that model needs to be told to ignore $ignore_this_model_obj
2085
-                if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
2086
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
2087
-                        array(
2088
-                            $ignored_model->get_primary_key_field()->get_name() => array(
2089
-                                '!=',
2090
-                                $ignore_this_model_obj->ID(),
2091
-                            ),
2092
-                        ),
2093
-                    ));
2094
-                } else {
2095
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
2096
-                }
2097
-                if ($related_model_objects) {
2098
-                    EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
2099
-                    $is_blocked = true;
2100
-                }
2101
-            }
2102
-        }
2103
-        return $is_blocked;
2104
-    }
2105
-
2106
-
2107
-    /**
2108
-     * Builds the columns and values for items to delete from the incoming $row_results_for_deleting array.
2109
-     * @param array $row_results_for_deleting
2110
-     * @param bool  $allow_blocking
2111
-     * @return array   The shape of this array depends on whether the model `has_primary_key_field` or not.  If the
2112
-     *                 model DOES have a primary_key_field, then the array will be a simple single dimension array where
2113
-     *                 the key is the fully qualified primary key column and the value is an array of ids that will be
2114
-     *                 deleted. Example:
2115
-     *                      array('Event.EVT_ID' => array( 1,2,3))
2116
-     *                 If the model DOES NOT have a primary_key_field, then the array will be a two dimensional array
2117
-     *                 where each element is a group of columns and values that get deleted. Example:
2118
-     *                      array(
2119
-     *                          0 => array(
2120
-     *                              'Term_Relationship.object_id' => 1
2121
-     *                              'Term_Relationship.term_taxonomy_id' => 5
2122
-     *                          ),
2123
-     *                          1 => array(
2124
-     *                              'Term_Relationship.object_id' => 1
2125
-     *                              'Term_Relationship.term_taxonomy_id' => 6
2126
-     *                          )
2127
-     *                      )
2128
-     * @throws EE_Error
2129
-     */
2130
-    protected function _get_ids_for_delete(array $row_results_for_deleting, $allow_blocking = true)
2131
-    {
2132
-        $ids_to_delete_indexed_by_column = array();
2133
-        if ($this->has_primary_key_field()) {
2134
-            $primary_table = $this->_get_main_table();
2135
-            $other_tables = $this->_get_other_tables();
2136
-            $ids_to_delete_indexed_by_column = $query = array();
2137
-            foreach ($row_results_for_deleting as $item_to_delete) {
2138
-                //before we mark this item for deletion,
2139
-                //make sure there's no related entities blocking its deletion (if we're checking)
2140
-                if (
2141
-                    $allow_blocking
2142
-                    && $this->delete_is_blocked_by_related_models(
2143
-                        $item_to_delete[$primary_table->get_fully_qualified_pk_column()]
2144
-                    )
2145
-                ) {
2146
-                    continue;
2147
-                }
2148
-                //primary table deletes
2149
-                if (isset($item_to_delete[$primary_table->get_fully_qualified_pk_column()])) {
2150
-                    $ids_to_delete_indexed_by_column[$primary_table->get_fully_qualified_pk_column()][] =
2151
-                        $item_to_delete[$primary_table->get_fully_qualified_pk_column()];
2152
-                }
2153
-            }
2154
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
2155
-            $fields = $this->get_combined_primary_key_fields();
2156
-            foreach ($row_results_for_deleting as $item_to_delete) {
2157
-                $ids_to_delete_indexed_by_column_for_row = array();
2158
-                foreach ($fields as $cpk_field) {
2159
-                    if ($cpk_field instanceof EE_Model_Field_Base) {
2160
-                        $ids_to_delete_indexed_by_column_for_row[$cpk_field->get_qualified_column()] =
2161
-                            $item_to_delete[$cpk_field->get_qualified_column()];
2162
-                    }
2163
-                }
2164
-                $ids_to_delete_indexed_by_column[] = $ids_to_delete_indexed_by_column_for_row;
2165
-            }
2166
-        } else {
2167
-            //so there's no primary key and no combined key...
2168
-            //sorry, can't help you
2169
-            throw new EE_Error(
2170
-                sprintf(
2171
-                    __(
2172
-                        "Cannot delete objects of type %s because there is no primary key NOR combined key",
2173
-                        "event_espresso"
2174
-                    ), get_class($this)
2175
-                )
2176
-            );
2177
-        }    
2178
-        return $ids_to_delete_indexed_by_column;
2179
-    }
2180
-
2181
-
2182
-    /**
2183
-     * This receives an array of columns and values set to be deleted (as prepared by _get_ids_for_delete) and prepares
2184
-     * the corresponding query_part for the query performing the delete.
2185
-     *
2186
-     * @param array $ids_to_delete_indexed_by_column @see _get_ids_for_delete for how this array might be shaped.
2187
-     * @return string
2188
-     * @throws EE_Error
2189
-     */
2190
-    protected function _build_query_part_for_deleting_from_columns_and_values(array $ids_to_delete_indexed_by_column) {
2191
-        $query_part = '';
2192
-        if (empty($ids_to_delete_indexed_by_column)) {
2193
-            return $query_part;
2194
-        } elseif ($this->has_primary_key_field()) {
2195
-            $query = array();
2196
-            foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
2197
-                //make sure we have unique $ids
2198
-                $ids = array_unique($ids);
2199
-                $query[] = $column . ' IN(' . implode(',', $ids) . ')';
2200
-            }
2201
-            $query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
2202
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
2203
-            $ways_to_identify_a_row = array();
2204
-            foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
2205
-                $values_for_each_combined_primary_key_for_a_row = array();
2206
-                foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
2207
-                    $values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
2208
-                }
2209
-                $ways_to_identify_a_row[] = '(' . implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
2210
-            }
2211
-            $query_part = implode(' OR ', $ways_to_identify_a_row);
2212
-        }
2213
-        return $query_part;
2214
-    }
35
+	//admin posty
36
+	//basic -> grants access to mine -> if they don't have it, select none
37
+	//*_others -> grants access to others that aren't private, and all mine -> if they don't have it, select mine
38
+	//*_private -> grants full access -> if dont have it, select all mine and others' non-private
39
+	//*_published -> grants access to published -> if they dont have it, select non-published
40
+	//*_global/default/system -> grants access to global items -> if they don't have it, select non-global
41
+	//publish_{thing} -> can change status TO publish; SPECIAL CASE
42
+	//frontend posty
43
+	//by default has access to published
44
+	//basic -> grants access to mine that aren't published, and all published
45
+	//*_others ->grants access to others that aren't private, all mine
46
+	//*_private -> grants full access
47
+	//frontend non-posty
48
+	//like admin posty
49
+	//category-y
50
+	//assign -> grants access to join-table
51
+	//(delete, edit)
52
+	//payment-method-y
53
+	//for each registered payment method,
54
+	//ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
55
+	/**
56
+	 * Flag to indicate whether the values provided to EEM_Base have already been prepared
57
+	 * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
58
+	 * They almost always WILL NOT, but it's not necessarily a requirement.
59
+	 * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
60
+	 *
61
+	 * @var boolean
62
+	 */
63
+	private $_values_already_prepared_by_model_object = 0;
64
+
65
+	/**
66
+	 * when $_values_already_prepared_by_model_object equals this, we assume
67
+	 * the data is just like form input that needs to have the model fields'
68
+	 * prepare_for_set and prepare_for_use_in_db called on it
69
+	 */
70
+	const not_prepared_by_model_object = 0;
71
+
72
+	/**
73
+	 * when $_values_already_prepared_by_model_object equals this, we
74
+	 * assume this value is coming from a model object and doesn't need to have
75
+	 * prepare_for_set called on it, just prepare_for_use_in_db is used
76
+	 */
77
+	const prepared_by_model_object = 1;
78
+
79
+	/**
80
+	 * when $_values_already_prepared_by_model_object equals this, we assume
81
+	 * the values are already to be used in the database (ie no processing is done
82
+	 * on them by the model's fields)
83
+	 */
84
+	const prepared_for_use_in_db = 2;
85
+
86
+
87
+	protected $singular_item = 'Item';
88
+
89
+	protected $plural_item   = 'Items';
90
+
91
+	/**
92
+	 * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
93
+	 */
94
+	protected $_tables;
95
+
96
+	/**
97
+	 * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
98
+	 * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
99
+	 * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
100
+	 *
101
+	 * @var \EE_Model_Field_Base[] $_fields
102
+	 */
103
+	protected $_fields;
104
+
105
+	/**
106
+	 * array of different kinds of relations
107
+	 *
108
+	 * @var \EE_Model_Relation_Base[] $_model_relations
109
+	 */
110
+	protected $_model_relations;
111
+
112
+	/**
113
+	 * @var \EE_Index[] $_indexes
114
+	 */
115
+	protected $_indexes = array();
116
+
117
+	/**
118
+	 * Default strategy for getting where conditions on this model. This strategy is used to get default
119
+	 * where conditions which are added to get_all, update, and delete queries. They can be overridden
120
+	 * by setting the same columns as used in these queries in the query yourself.
121
+	 *
122
+	 * @var EE_Default_Where_Conditions
123
+	 */
124
+	protected $_default_where_conditions_strategy;
125
+
126
+	/**
127
+	 * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
128
+	 * This is particularly useful when you want something between 'none' and 'default'
129
+	 *
130
+	 * @var EE_Default_Where_Conditions
131
+	 */
132
+	protected $_minimum_where_conditions_strategy;
133
+
134
+	/**
135
+	 * String describing how to find the "owner" of this model's objects.
136
+	 * When there is a foreign key on this model to the wp_users table, this isn't needed.
137
+	 * But when there isn't, this indicates which related model, or transiently-related model,
138
+	 * has the foreign key to the wp_users table.
139
+	 * Eg, for EEM_Registration this would be 'Event' because registrations are directly
140
+	 * related to events, and events have a foreign key to wp_users.
141
+	 * On EEM_Transaction, this would be 'Transaction.Event'
142
+	 *
143
+	 * @var string
144
+	 */
145
+	protected $_model_chain_to_wp_user = '';
146
+
147
+	/**
148
+	 * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
149
+	 * don't need it (particularly CPT models)
150
+	 *
151
+	 * @var bool
152
+	 */
153
+	protected $_ignore_where_strategy = false;
154
+
155
+	/**
156
+	 * String used in caps relating to this model. Eg, if the caps relating to this
157
+	 * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
158
+	 *
159
+	 * @var string. If null it hasn't been initialized yet. If false then we
160
+	 * have indicated capabilities don't apply to this
161
+	 */
162
+	protected $_caps_slug = null;
163
+
164
+	/**
165
+	 * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
166
+	 * and next-level keys are capability names, and each's value is a
167
+	 * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
168
+	 * they specify which context to use (ie, frontend, backend, edit or delete)
169
+	 * and then each capability in the corresponding sub-array that they're missing
170
+	 * adds the where conditions onto the query.
171
+	 *
172
+	 * @var array
173
+	 */
174
+	protected $_cap_restrictions = array(
175
+		self::caps_read       => array(),
176
+		self::caps_read_admin => array(),
177
+		self::caps_edit       => array(),
178
+		self::caps_delete     => array(),
179
+	);
180
+
181
+	/**
182
+	 * Array defining which cap restriction generators to use to create default
183
+	 * cap restrictions to put in EEM_Base::_cap_restrictions.
184
+	 * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
185
+	 * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
186
+	 * automatically set this to false (not just null).
187
+	 *
188
+	 * @var EE_Restriction_Generator_Base[]
189
+	 */
190
+	protected $_cap_restriction_generators = array();
191
+
192
+	/**
193
+	 * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
194
+	 */
195
+	const caps_read       = 'read';
196
+
197
+	const caps_read_admin = 'read_admin';
198
+
199
+	const caps_edit       = 'edit';
200
+
201
+	const caps_delete     = 'delete';
202
+
203
+	/**
204
+	 * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
205
+	 * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
206
+	 * maps to 'read' because when looking for relevant permissions we're going to use
207
+	 * 'read' in teh capabilities names like 'ee_read_events' etc.
208
+	 *
209
+	 * @var array
210
+	 */
211
+	protected $_cap_contexts_to_cap_action_map = array(
212
+		self::caps_read       => 'read',
213
+		self::caps_read_admin => 'read',
214
+		self::caps_edit       => 'edit',
215
+		self::caps_delete     => 'delete',
216
+	);
217
+
218
+	/**
219
+	 * Timezone
220
+	 * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
221
+	 * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
222
+	 * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
223
+	 * EE_Datetime_Field data type will have access to it.
224
+	 *
225
+	 * @var string
226
+	 */
227
+	protected $_timezone;
228
+
229
+
230
+	/**
231
+	 * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
232
+	 * multisite.
233
+	 *
234
+	 * @var int
235
+	 */
236
+	protected static $_model_query_blog_id;
237
+
238
+	/**
239
+	 * A copy of _fields, except the array keys are the model names pointed to by
240
+	 * the field
241
+	 *
242
+	 * @var EE_Model_Field_Base[]
243
+	 */
244
+	private $_cache_foreign_key_to_fields = array();
245
+
246
+	/**
247
+	 * Cached list of all the fields on the model, indexed by their name
248
+	 *
249
+	 * @var EE_Model_Field_Base[]
250
+	 */
251
+	private $_cached_fields = null;
252
+
253
+	/**
254
+	 * Cached list of all the fields on the model, except those that are
255
+	 * marked as only pertinent to the database
256
+	 *
257
+	 * @var EE_Model_Field_Base[]
258
+	 */
259
+	private $_cached_fields_non_db_only = null;
260
+
261
+	/**
262
+	 * A cached reference to the primary key for quick lookup
263
+	 *
264
+	 * @var EE_Model_Field_Base
265
+	 */
266
+	private $_primary_key_field = null;
267
+
268
+	/**
269
+	 * Flag indicating whether this model has a primary key or not
270
+	 *
271
+	 * @var boolean
272
+	 */
273
+	protected $_has_primary_key_field = null;
274
+
275
+	/**
276
+	 * Whether or not this model is based off a table in WP core only (CPTs should set
277
+	 * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
278
+	 *
279
+	 * @var boolean
280
+	 */
281
+	protected $_wp_core_model = false;
282
+
283
+	/**
284
+	 *    List of valid operators that can be used for querying.
285
+	 * The keys are all operators we'll accept, the values are the real SQL
286
+	 * operators used
287
+	 *
288
+	 * @var array
289
+	 */
290
+	protected $_valid_operators = array(
291
+		'='           => '=',
292
+		'<='          => '<=',
293
+		'<'           => '<',
294
+		'>='          => '>=',
295
+		'>'           => '>',
296
+		'!='          => '!=',
297
+		'LIKE'        => 'LIKE',
298
+		'like'        => 'LIKE',
299
+		'NOT_LIKE'    => 'NOT LIKE',
300
+		'not_like'    => 'NOT LIKE',
301
+		'NOT LIKE'    => 'NOT LIKE',
302
+		'not like'    => 'NOT LIKE',
303
+		'IN'          => 'IN',
304
+		'in'          => 'IN',
305
+		'NOT_IN'      => 'NOT IN',
306
+		'not_in'      => 'NOT IN',
307
+		'NOT IN'      => 'NOT IN',
308
+		'not in'      => 'NOT IN',
309
+		'between'     => 'BETWEEN',
310
+		'BETWEEN'     => 'BETWEEN',
311
+		'IS_NOT_NULL' => 'IS NOT NULL',
312
+		'is_not_null' => 'IS NOT NULL',
313
+		'IS NOT NULL' => 'IS NOT NULL',
314
+		'is not null' => 'IS NOT NULL',
315
+		'IS_NULL'     => 'IS NULL',
316
+		'is_null'     => 'IS NULL',
317
+		'IS NULL'     => 'IS NULL',
318
+		'is null'     => 'IS NULL',
319
+		'REGEXP'      => 'REGEXP',
320
+		'regexp'      => 'REGEXP',
321
+		'NOT_REGEXP'  => 'NOT REGEXP',
322
+		'not_regexp'  => 'NOT REGEXP',
323
+		'NOT REGEXP'  => 'NOT REGEXP',
324
+		'not regexp'  => 'NOT REGEXP',
325
+	);
326
+
327
+	/**
328
+	 * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
329
+	 *
330
+	 * @var array
331
+	 */
332
+	protected $_in_style_operators = array('IN', 'NOT IN');
333
+
334
+	/**
335
+	 * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
336
+	 * '12-31-2012'"
337
+	 *
338
+	 * @var array
339
+	 */
340
+	protected $_between_style_operators = array('BETWEEN');
341
+
342
+	/**
343
+	 * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
344
+	 * on a join table.
345
+	 *
346
+	 * @var array
347
+	 */
348
+	protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
349
+
350
+	/**
351
+	 * Allowed values for $query_params['order'] for ordering in queries
352
+	 *
353
+	 * @var array
354
+	 */
355
+	protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
356
+
357
+	/**
358
+	 * When these are keys in a WHERE or HAVING clause, they are handled much differently
359
+	 * than regular field names. It is assumed that their values are an array of WHERE conditions
360
+	 *
361
+	 * @var array
362
+	 */
363
+	private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
364
+
365
+	/**
366
+	 * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
367
+	 * 'where', but 'where' clauses are so common that we thought we'd omit it
368
+	 *
369
+	 * @var array
370
+	 */
371
+	private $_allowed_query_params = array(
372
+		0,
373
+		'limit',
374
+		'order_by',
375
+		'group_by',
376
+		'having',
377
+		'force_join',
378
+		'order',
379
+		'on_join_limit',
380
+		'default_where_conditions',
381
+		'caps',
382
+	);
383
+
384
+	/**
385
+	 * All the data types that can be used in $wpdb->prepare statements.
386
+	 *
387
+	 * @var array
388
+	 */
389
+	private $_valid_wpdb_data_types = array('%d', '%s', '%f');
390
+
391
+	/**
392
+	 *    EE_Registry Object
393
+	 *
394
+	 * @var    object
395
+	 * @access    protected
396
+	 */
397
+	protected $EE = null;
398
+
399
+
400
+	/**
401
+	 * Property which, when set, will have this model echo out the next X queries to the page for debugging.
402
+	 *
403
+	 * @var int
404
+	 */
405
+	protected $_show_next_x_db_queries = 0;
406
+
407
+	/**
408
+	 * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
409
+	 * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
410
+	 *
411
+	 * @var array
412
+	 */
413
+	protected $_custom_selections = array();
414
+
415
+	/**
416
+	 * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
417
+	 * caches every model object we've fetched from the DB on this request
418
+	 *
419
+	 * @var array
420
+	 */
421
+	protected $_entity_map;
422
+
423
+	/**
424
+	 * constant used to show EEM_Base has not yet verified the db on this http request
425
+	 */
426
+	const db_verified_none = 0;
427
+
428
+	/**
429
+	 * constant used to show EEM_Base has verified the EE core db on this http request,
430
+	 * but not the addons' dbs
431
+	 */
432
+	const db_verified_core = 1;
433
+
434
+	/**
435
+	 * constant used to show EEM_Base has verified the addons' dbs (and implicitly
436
+	 * the EE core db too)
437
+	 */
438
+	const db_verified_addons = 2;
439
+
440
+	/**
441
+	 * indicates whether an EEM_Base child has already re-verified the DB
442
+	 * is ok (we don't want to do it repetitively). Should be set to one the constants
443
+	 * looking like EEM_Base::db_verified_*
444
+	 *
445
+	 * @var int - 0 = none, 1 = core, 2 = addons
446
+	 */
447
+	protected static $_db_verification_level = EEM_Base::db_verified_none;
448
+
449
+	/**
450
+	 * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
451
+	 *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
452
+	 *        registrations for non-trashed tickets for non-trashed datetimes)
453
+	 */
454
+	const default_where_conditions_all = 'all';
455
+
456
+	/**
457
+	 * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
458
+	 *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
459
+	 *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
460
+	 *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
461
+	 *        models which share tables with other models, this can return data for the wrong model.
462
+	 */
463
+	const default_where_conditions_this_only = 'this_model_only';
464
+
465
+	/**
466
+	 * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
467
+	 *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
468
+	 *        return all registrations related to non-trashed tickets and non-trashed datetimes)
469
+	 */
470
+	const default_where_conditions_others_only = 'other_models_only';
471
+
472
+	/**
473
+	 * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
474
+	 *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
475
+	 *        their table with other models, like the Event and Venue models. For example, when querying for events
476
+	 *        ordered by their venues' name, this will be sure to only return real events with associated real venues
477
+	 *        (regardless of whether those events and venues are trashed)
478
+	 *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
479
+	 *        events.
480
+	 */
481
+	const default_where_conditions_minimum_all = 'minimum';
482
+
483
+	/**
484
+	 * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
485
+	 *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
486
+	 *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
487
+	 *        not)
488
+	 */
489
+	const default_where_conditions_minimum_others = 'full_this_minimum_others';
490
+
491
+	/**
492
+	 * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
493
+	 *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
494
+	 *        it's possible it will return table entries for other models. You should use
495
+	 *        EEM_Base::default_where_conditions_minimum_all instead.
496
+	 */
497
+	const default_where_conditions_none = 'none';
498
+
499
+
500
+
501
+	/**
502
+	 * About all child constructors:
503
+	 * they should define the _tables, _fields and _model_relations arrays.
504
+	 * Should ALWAYS be called after child constructor.
505
+	 * In order to make the child constructors to be as simple as possible, this parent constructor
506
+	 * finalizes constructing all the object's attributes.
507
+	 * Generally, rather than requiring a child to code
508
+	 * $this->_tables = array(
509
+	 *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
510
+	 *        ...);
511
+	 *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
512
+	 * each EE_Table has a function to set the table's alias after the constructor, using
513
+	 * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
514
+	 * do something similar.
515
+	 *
516
+	 * @param null $timezone
517
+	 * @throws EE_Error
518
+	 */
519
+	protected function __construct($timezone = null)
520
+	{
521
+		// check that the model has not been loaded too soon
522
+		if (! did_action('AHEE__EE_System__load_espresso_addons')) {
523
+			throw new EE_Error (
524
+				sprintf(
525
+					__('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.',
526
+						'event_espresso'),
527
+					get_class($this)
528
+				)
529
+			);
530
+		}
531
+		/**
532
+		 * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
533
+		 */
534
+		if (empty(EEM_Base::$_model_query_blog_id)) {
535
+			EEM_Base::set_model_query_blog_id();
536
+		}
537
+		/**
538
+		 * Filters the list of tables on a model. It is best to NOT use this directly and instead
539
+		 * just use EE_Register_Model_Extension
540
+		 *
541
+		 * @var EE_Table_Base[] $_tables
542
+		 */
543
+		$this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
544
+		foreach ($this->_tables as $table_alias => $table_obj) {
545
+			/** @var $table_obj EE_Table_Base */
546
+			$table_obj->_construct_finalize_with_alias($table_alias);
547
+			if ($table_obj instanceof EE_Secondary_Table) {
548
+				/** @var $table_obj EE_Secondary_Table */
549
+				$table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
550
+			}
551
+		}
552
+		/**
553
+		 * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
554
+		 * EE_Register_Model_Extension
555
+		 *
556
+		 * @param EE_Model_Field_Base[] $_fields
557
+		 */
558
+		$this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
559
+		$this->_invalidate_field_caches();
560
+		foreach ($this->_fields as $table_alias => $fields_for_table) {
561
+			if (! array_key_exists($table_alias, $this->_tables)) {
562
+				throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
563
+					'event_espresso'), $table_alias, implode(",", $this->_fields)));
564
+			}
565
+			foreach ($fields_for_table as $field_name => $field_obj) {
566
+				/** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
567
+				//primary key field base has a slightly different _construct_finalize
568
+				/** @var $field_obj EE_Model_Field_Base */
569
+				$field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
570
+			}
571
+		}
572
+		// everything is related to Extra_Meta
573
+		if (get_class($this) !== 'EEM_Extra_Meta') {
574
+			//make extra meta related to everything, but don't block deleting things just
575
+			//because they have related extra meta info. For now just orphan those extra meta
576
+			//in the future we should automatically delete them
577
+			$this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
578
+		}
579
+		//and change logs
580
+		if (get_class($this) !== 'EEM_Change_Log') {
581
+			$this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
582
+		}
583
+		/**
584
+		 * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
585
+		 * EE_Register_Model_Extension
586
+		 *
587
+		 * @param EE_Model_Relation_Base[] $_model_relations
588
+		 */
589
+		$this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
590
+			$this->_model_relations);
591
+		foreach ($this->_model_relations as $model_name => $relation_obj) {
592
+			/** @var $relation_obj EE_Model_Relation_Base */
593
+			$relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
594
+		}
595
+		foreach ($this->_indexes as $index_name => $index_obj) {
596
+			/** @var $index_obj EE_Index */
597
+			$index_obj->_construct_finalize($index_name, $this->get_this_model_name());
598
+		}
599
+		$this->set_timezone($timezone);
600
+		//finalize default where condition strategy, or set default
601
+		if (! $this->_default_where_conditions_strategy) {
602
+			//nothing was set during child constructor, so set default
603
+			$this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
604
+		}
605
+		$this->_default_where_conditions_strategy->_finalize_construct($this);
606
+		if (! $this->_minimum_where_conditions_strategy) {
607
+			//nothing was set during child constructor, so set default
608
+			$this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
609
+		}
610
+		$this->_minimum_where_conditions_strategy->_finalize_construct($this);
611
+		//if the cap slug hasn't been set, and we haven't set it to false on purpose
612
+		//to indicate to NOT set it, set it to the logical default
613
+		if ($this->_caps_slug === null) {
614
+			$this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
615
+		}
616
+		//initialize the standard cap restriction generators if none were specified by the child constructor
617
+		if ($this->_cap_restriction_generators !== false) {
618
+			foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
619
+				if (! isset($this->_cap_restriction_generators[$cap_context])) {
620
+					$this->_cap_restriction_generators[$cap_context] = apply_filters(
621
+						'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
622
+						new EE_Restriction_Generator_Protected(),
623
+						$cap_context,
624
+						$this
625
+					);
626
+				}
627
+			}
628
+		}
629
+		//if there are cap restriction generators, use them to make the default cap restrictions
630
+		if ($this->_cap_restriction_generators !== false) {
631
+			foreach ($this->_cap_restriction_generators as $context => $generator_object) {
632
+				if (! $generator_object) {
633
+					continue;
634
+				}
635
+				if (! $generator_object instanceof EE_Restriction_Generator_Base) {
636
+					throw new EE_Error(
637
+						sprintf(
638
+							__('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.',
639
+								'event_espresso'),
640
+							$context,
641
+							$this->get_this_model_name()
642
+						)
643
+					);
644
+				}
645
+				$action = $this->cap_action_for_context($context);
646
+				if (! $generator_object->construction_finalized()) {
647
+					$generator_object->_construct_finalize($this, $action);
648
+				}
649
+			}
650
+		}
651
+		do_action('AHEE__' . get_class($this) . '__construct__end');
652
+	}
653
+
654
+
655
+
656
+	/**
657
+	 * Generates the cap restrictions for the given context, or if they were
658
+	 * already generated just gets what's cached
659
+	 *
660
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
661
+	 * @return EE_Default_Where_Conditions[]
662
+	 */
663
+	protected function _generate_cap_restrictions($context)
664
+	{
665
+		if (isset($this->_cap_restriction_generators[$context])
666
+			&& $this->_cap_restriction_generators[$context]
667
+			   instanceof
668
+			   EE_Restriction_Generator_Base
669
+		) {
670
+			return $this->_cap_restriction_generators[$context]->generate_restrictions();
671
+		} else {
672
+			return array();
673
+		}
674
+	}
675
+
676
+
677
+
678
+	/**
679
+	 * Used to set the $_model_query_blog_id static property.
680
+	 *
681
+	 * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
682
+	 *                      value for get_current_blog_id() will be used.
683
+	 */
684
+	public static function set_model_query_blog_id($blog_id = 0)
685
+	{
686
+		EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
687
+	}
688
+
689
+
690
+
691
+	/**
692
+	 * Returns whatever is set as the internal $model_query_blog_id.
693
+	 *
694
+	 * @return int
695
+	 */
696
+	public static function get_model_query_blog_id()
697
+	{
698
+		return EEM_Base::$_model_query_blog_id;
699
+	}
700
+
701
+
702
+
703
+	/**
704
+	 * This function is a singleton method used to instantiate the Espresso_model object
705
+	 *
706
+	 * @param string            $timezone string representing the timezone we want to set for returned Date Time Strings
707
+	 *                                    (and any incoming timezone data that gets saved).
708
+	 *                                    Note this just sends the timezone info to the date time model field objects.
709
+	 *                                    Default is NULL
710
+	 *                                    (and will be assumed using the set timezone in the 'timezone_string' wp option)
711
+	 * @param ModelFieldFactory $model_field_factory
712
+	 * @return static (as in the concrete child class)
713
+	 * @throws InvalidArgumentException
714
+	 * @throws InvalidInterfaceException
715
+	 * @throws InvalidDataTypeException
716
+	 * @throws EE_Error
717
+	 */
718
+	public static function instance($timezone = null, ModelFieldFactory $model_field_factory = null)
719
+	{
720
+		// check if instance of Espresso_model already exists
721
+		if (! static::$_instance instanceof static) {
722
+			$model_field_factory = self::getModelFieldFactory($model_field_factory);
723
+			// instantiate Espresso_model
724
+			static::$_instance = new static($timezone, $model_field_factory);
725
+		}
726
+		//we might have a timezone set, let set_timezone decide what to do with it
727
+		static::$_instance->set_timezone($timezone);
728
+		// Espresso_model object
729
+		return static::$_instance;
730
+	}
731
+
732
+
733
+
734
+	/**
735
+	 * @param $model_field_factory
736
+	 * @return ModelFieldFactory
737
+	 * @throws InvalidArgumentException
738
+	 * @throws InvalidDataTypeException
739
+	 * @throws InvalidInterfaceException
740
+	 */
741
+	private static function getModelFieldFactory($model_field_factory)
742
+	{
743
+		return $model_field_factory instanceof ModelFieldFactory
744
+			? $model_field_factory
745
+			: LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory');
746
+	}
747
+
748
+
749
+
750
+	/**
751
+	 * resets the model and returns it
752
+	 *
753
+	 * @param null | string          $timezone
754
+	 * @param ModelFieldFactory|null $model_field_factory
755
+	 * @return EEM_Base|null (if the model was already instantiated, returns it, with
756
+	 * @throws ReflectionException
757
+	 * all its properties reset; if it wasn't instantiated, returns null)
758
+	 * @throws EE_Error
759
+	 * @throws InvalidArgumentException
760
+	 * @throws InvalidDataTypeException
761
+	 * @throws InvalidInterfaceException
762
+	 */
763
+	public static function reset($timezone = null, ModelFieldFactory $model_field_factory = null)
764
+	{
765
+		if (static::$_instance instanceof EEM_Base) {
766
+			//let's try to NOT swap out the current instance for a new one
767
+			//because if someone has a reference to it, we can't remove their reference
768
+			//so it's best to keep using the same reference, but change the original object
769
+			//reset all its properties to their original values as defined in the class
770
+			$r = new ReflectionClass(get_class(static::$_instance));
771
+			$static_properties = $r->getStaticProperties();
772
+			foreach ($r->getDefaultProperties() as $property => $value) {
773
+				//don't set instance to null like it was originally,
774
+				//but it's static anyways, and we're ignoring static properties (for now at least)
775
+				if (! isset($static_properties[$property])) {
776
+					static::$_instance->{$property} = $value;
777
+				}
778
+			}
779
+			//and then directly call its constructor again, like we would if we were creating a new one
780
+			$model_field_factory = self::getModelFieldFactory($model_field_factory);
781
+			static::$_instance->__construct($timezone, $model_field_factory);
782
+			return self::instance();
783
+		}
784
+		return null;
785
+	}
786
+
787
+
788
+
789
+	/**
790
+	 * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
791
+	 *
792
+	 * @param  boolean $translated return localized strings or JUST the array.
793
+	 * @return array
794
+	 * @throws EE_Error
795
+	 */
796
+	public function status_array($translated = false)
797
+	{
798
+		if (! array_key_exists('Status', $this->_model_relations)) {
799
+			return array();
800
+		}
801
+		$model_name = $this->get_this_model_name();
802
+		$status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
803
+		$stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
804
+		$status_array = array();
805
+		foreach ($stati as $status) {
806
+			$status_array[$status->ID()] = $status->get('STS_code');
807
+		}
808
+		return $translated
809
+			? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
810
+			: $status_array;
811
+	}
812
+
813
+
814
+
815
+	/**
816
+	 * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
817
+	 *
818
+	 * @param array $query_params             {
819
+	 * @var array $0 (where) array {
820
+	 *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
821
+	 *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
822
+	 *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
823
+	 *                                        conditions based on related models (and even
824
+	 *                                        models-related-to-related-models) prepend the model's name onto the field
825
+	 *                                        name. Eg,
826
+	 *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
827
+	 *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
828
+	 *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
829
+	 *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
830
+	 *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
831
+	 *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
832
+	 *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
833
+	 *                                        to Venues (even when each of those models actually consisted of two
834
+	 *                                        tables). Also, you may chain the model relations together. Eg instead of
835
+	 *                                        just having
836
+	 *                                        "Venue.VNU_ID", you could have
837
+	 *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
838
+	 *                                        events are related to Registrations, which are related to Attendees). You
839
+	 *                                        can take it even further with
840
+	 *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
841
+	 *                                        (from the default of '='), change the value to an numerically-indexed
842
+	 *                                        array, where the first item in the list is the operator. eg: array(
843
+	 *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
844
+	 *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
845
+	 *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
846
+	 *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
847
+	 *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
848
+	 *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
849
+	 *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
850
+	 *                                        the operator is IN. Also, values can actually be field names. To indicate
851
+	 *                                        the value is a field, simply provide a third array item (true) to the
852
+	 *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
853
+	 *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
854
+	 *                                        Note: you can also use related model field names like you would any other
855
+	 *                                        field name. eg:
856
+	 *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
857
+	 *                                        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__>' =>
858
+	 *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
859
+	 *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
860
+	 *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
861
+	 *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
862
+	 *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
863
+	 *                                        to be what you last specified. IE, "AND"s by default, but if you had
864
+	 *                                        previously specified to use ORs to join, ORs will continue to be used.
865
+	 *                                        So, if you specify to use an "OR" to join conditions, it will continue to
866
+	 *                                        "stick" until you specify an AND. eg
867
+	 *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
868
+	 *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
869
+	 *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
870
+	 *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
871
+	 *                                        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 >>
872
+	 *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
873
+	 *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
874
+	 *                                        too, eg:
875
+	 *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
876
+	 * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
877
+	 *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
878
+	 *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
879
+	 *                                        Remember when you provide two numbers for the limit, the 1st number is
880
+	 *                                        the OFFSET, the 2nd is the LIMIT
881
+	 * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
882
+	 *                                        can do paging on one-to-many multi-table-joins. Send an array in the
883
+	 *                                        following format array('on_join_limit'
884
+	 *                                        => array( 'table_alias', array(1,2) ) ).
885
+	 * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
886
+	 *                                        values are either 'ASC' or 'DESC'.
887
+	 *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
888
+	 *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
889
+	 *                                        DESC..." respectively. Like the
890
+	 *                                        'where' conditions, these fields can be on related models. Eg
891
+	 *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
892
+	 *                                        perfectly valid from any model related to 'Registration' (like Event,
893
+	 *                                        Attendee, Price, Datetime, etc.)
894
+	 * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
895
+	 *                                        'order' specifies whether to order the field specified in 'order_by' in
896
+	 *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
897
+	 *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
898
+	 *                                        order by the primary key. Eg,
899
+	 *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
900
+	 *                                        //(will join with the Datetime model's table(s) and order by its field
901
+	 *                                        DTT_EVT_start) or
902
+	 *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
903
+	 *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
904
+	 * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
905
+	 *                                        'group_by'=>'VNU_ID', or
906
+	 *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
907
+	 *                                        if no
908
+	 *                                        $group_by is specified, and a limit is set, automatically groups by the
909
+	 *                                        model's primary key (or combined primary keys). This avoids some
910
+	 *                                        weirdness that results when using limits, tons of joins, and no group by,
911
+	 *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
912
+	 * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
913
+	 *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
914
+	 *                                        results)
915
+	 * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
916
+	 *                                        array where values are models to be joined in the query.Eg
917
+	 *                                        array('Attendee','Payment','Datetime'). You may join with transient
918
+	 *                                        models using period, eg "Registration.Transaction.Payment". You will
919
+	 *                                        probably only want to do this in hopes of increasing efficiency, as
920
+	 *                                        related models which belongs to the current model
921
+	 *                                        (ie, the current model has a foreign key to them, like how Registration
922
+	 *                                        belongs to Attendee) can be cached in order to avoid future queries
923
+	 * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
924
+	 *                                        set this to 'none' to disable all default where conditions. Eg, usually
925
+	 *                                        soft-deleted objects are filtered-out if you want to include them, set
926
+	 *                                        this query param to 'none'. If you want to ONLY disable THIS model's
927
+	 *                                        default where conditions set it to 'other_models_only'. If you only want
928
+	 *                                        this model's default where conditions added to the query, use
929
+	 *                                        'this_model_only'. If you want to use all default where conditions
930
+	 *                                        (default), set to 'all'.
931
+	 * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
932
+	 *                                        we just NOT apply any capabilities/permissions/restrictions and return
933
+	 *                                        everything? Or should we only show the current user items they should be
934
+	 *                                        able to view on the frontend, backend, edit, or delete? can be set to
935
+	 *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
936
+	 *                                        }
937
+	 * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
938
+	 *                                        from EE_Base_Class[], use _get_all_wpdb_results()and make it public
939
+	 *                                        again. Array keys are object IDs (if there is a primary key on the model.
940
+	 *                                        if not, numerically indexed) Some full examples: get 10 transactions
941
+	 *                                        which have Scottish attendees: EEM_Transaction::instance()->get_all(
942
+	 *                                        array( array(
943
+	 *                                        'OR'=>array(
944
+	 *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
945
+	 *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
946
+	 *                                        )
947
+	 *                                        ),
948
+	 *                                        'limit'=>10,
949
+	 *                                        'group_by'=>'TXN_ID'
950
+	 *                                        ));
951
+	 *                                        get all the answers to the question titled "shirt size" for event with id
952
+	 *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
953
+	 *                                        'Question.QST_display_text'=>'shirt size',
954
+	 *                                        'Registration.Event.EVT_ID'=>12
955
+	 *                                        ),
956
+	 *                                        'order_by'=>array('ANS_value'=>'ASC')
957
+	 *                                        ));
958
+	 * @throws EE_Error
959
+	 */
960
+	public function get_all($query_params = array())
961
+	{
962
+		if (isset($query_params['limit'])
963
+			&& ! isset($query_params['group_by'])
964
+		) {
965
+			$query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
966
+		}
967
+		return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
968
+	}
969
+
970
+
971
+
972
+	/**
973
+	 * Modifies the query parameters so we only get back model objects
974
+	 * that "belong" to the current user
975
+	 *
976
+	 * @param array $query_params @see EEM_Base::get_all()
977
+	 * @return array like EEM_Base::get_all
978
+	 */
979
+	public function alter_query_params_to_only_include_mine($query_params = array())
980
+	{
981
+		$wp_user_field_name = $this->wp_user_field_name();
982
+		if ($wp_user_field_name) {
983
+			$query_params[0][$wp_user_field_name] = get_current_user_id();
984
+		}
985
+		return $query_params;
986
+	}
987
+
988
+
989
+
990
+	/**
991
+	 * Returns the name of the field's name that points to the WP_User table
992
+	 *  on this model (or follows the _model_chain_to_wp_user and uses that model's
993
+	 * foreign key to the WP_User table)
994
+	 *
995
+	 * @return string|boolean string on success, boolean false when there is no
996
+	 * foreign key to the WP_User table
997
+	 */
998
+	public function wp_user_field_name()
999
+	{
1000
+		try {
1001
+			if (! empty($this->_model_chain_to_wp_user)) {
1002
+				$models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
1003
+				$last_model_name = end($models_to_follow_to_wp_users);
1004
+				$model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
1005
+				$model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
1006
+			} else {
1007
+				$model_with_fk_to_wp_users = $this;
1008
+				$model_chain_to_wp_user = '';
1009
+			}
1010
+			$wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
1011
+			return $model_chain_to_wp_user . $wp_user_field->get_name();
1012
+		} catch (EE_Error $e) {
1013
+			return false;
1014
+		}
1015
+	}
1016
+
1017
+
1018
+
1019
+	/**
1020
+	 * Returns the _model_chain_to_wp_user string, which indicates which related model
1021
+	 * (or transiently-related model) has a foreign key to the wp_users table;
1022
+	 * useful for finding if model objects of this type are 'owned' by the current user.
1023
+	 * This is an empty string when the foreign key is on this model and when it isn't,
1024
+	 * but is only non-empty when this model's ownership is indicated by a RELATED model
1025
+	 * (or transiently-related model)
1026
+	 *
1027
+	 * @return string
1028
+	 */
1029
+	public function model_chain_to_wp_user()
1030
+	{
1031
+		return $this->_model_chain_to_wp_user;
1032
+	}
1033
+
1034
+
1035
+
1036
+	/**
1037
+	 * Whether this model is 'owned' by a specific wordpress user (even indirectly,
1038
+	 * like how registrations don't have a foreign key to wp_users, but the
1039
+	 * events they are for are), or is unrelated to wp users.
1040
+	 * generally available
1041
+	 *
1042
+	 * @return boolean
1043
+	 */
1044
+	public function is_owned()
1045
+	{
1046
+		if ($this->model_chain_to_wp_user()) {
1047
+			return true;
1048
+		}
1049
+		try {
1050
+			$this->get_foreign_key_to('WP_User');
1051
+			return true;
1052
+		} catch (EE_Error $e) {
1053
+			return false;
1054
+		}
1055
+	}
1056
+
1057
+
1058
+
1059
+	/**
1060
+	 * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
1061
+	 * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
1062
+	 * the model)
1063
+	 *
1064
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
1065
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1066
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1067
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
1068
+	 *                                  override this and set the select to "*", or a specific column name, like
1069
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1070
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1071
+	 *                                  the aliases used to refer to this selection, and values are to be
1072
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1073
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1074
+	 * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1075
+	 * @throws EE_Error
1076
+	 */
1077
+	protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1078
+	{
1079
+		// remember the custom selections, if any, and type cast as array
1080
+		// (unless $columns_to_select is an object, then just set as an empty array)
1081
+		// Note: (array) 'some string' === array( 'some string' )
1082
+		$this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1083
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1084
+		$select_expressions = $columns_to_select !== null
1085
+			? $this->_construct_select_from_input($columns_to_select)
1086
+			: $this->_construct_default_select_sql($model_query_info);
1087
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1088
+		return $this->_do_wpdb_query('get_results', array($SQL, $output));
1089
+	}
1090
+
1091
+
1092
+
1093
+	/**
1094
+	 * Gets an array of rows from the database just like $wpdb->get_results would,
1095
+	 * but you can use the $query_params like on EEM_Base::get_all() to more easily
1096
+	 * take care of joins, field preparation etc.
1097
+	 *
1098
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
1099
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1100
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1101
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
1102
+	 *                                  override this and set the select to "*", or a specific column name, like
1103
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1104
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1105
+	 *                                  the aliases used to refer to this selection, and values are to be
1106
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1107
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1108
+	 * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1109
+	 * @throws EE_Error
1110
+	 */
1111
+	public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1112
+	{
1113
+		return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
1114
+	}
1115
+
1116
+
1117
+
1118
+	/**
1119
+	 * For creating a custom select statement
1120
+	 *
1121
+	 * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
1122
+	 *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
1123
+	 *                                 SQL, and 1=>is the datatype
1124
+	 * @throws EE_Error
1125
+	 * @return string
1126
+	 */
1127
+	private function _construct_select_from_input($columns_to_select)
1128
+	{
1129
+		if (is_array($columns_to_select)) {
1130
+			$select_sql_array = array();
1131
+			foreach ($columns_to_select as $alias => $selection_and_datatype) {
1132
+				if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1133
+					throw new EE_Error(
1134
+						sprintf(
1135
+							__(
1136
+								"Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1137
+								"event_espresso"
1138
+							),
1139
+							$selection_and_datatype,
1140
+							$alias
1141
+						)
1142
+					);
1143
+				}
1144
+				if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1145
+					throw new EE_Error(
1146
+						sprintf(
1147
+							__(
1148
+								"Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1149
+								"event_espresso"
1150
+							),
1151
+							$selection_and_datatype[1],
1152
+							$selection_and_datatype[0],
1153
+							$alias,
1154
+							implode(",", $this->_valid_wpdb_data_types)
1155
+						)
1156
+					);
1157
+				}
1158
+				$select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1159
+			}
1160
+			$columns_to_select_string = implode(", ", $select_sql_array);
1161
+		} else {
1162
+			$columns_to_select_string = $columns_to_select;
1163
+		}
1164
+		return $columns_to_select_string;
1165
+	}
1166
+
1167
+
1168
+
1169
+	/**
1170
+	 * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1171
+	 *
1172
+	 * @return string
1173
+	 * @throws EE_Error
1174
+	 */
1175
+	public function primary_key_name()
1176
+	{
1177
+		return $this->get_primary_key_field()->get_name();
1178
+	}
1179
+
1180
+
1181
+
1182
+	/**
1183
+	 * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1184
+	 * If there is no primary key on this model, $id is treated as primary key string
1185
+	 *
1186
+	 * @param mixed $id int or string, depending on the type of the model's primary key
1187
+	 * @return EE_Base_Class
1188
+	 */
1189
+	public function get_one_by_ID($id)
1190
+	{
1191
+		if ($this->get_from_entity_map($id)) {
1192
+			return $this->get_from_entity_map($id);
1193
+		}
1194
+		return $this->get_one(
1195
+			$this->alter_query_params_to_restrict_by_ID(
1196
+				$id,
1197
+				array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
1198
+			)
1199
+		);
1200
+	}
1201
+
1202
+
1203
+
1204
+	/**
1205
+	 * Alters query parameters to only get items with this ID are returned.
1206
+	 * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1207
+	 * or could just be a simple primary key ID
1208
+	 *
1209
+	 * @param int   $id
1210
+	 * @param array $query_params
1211
+	 * @return array of normal query params, @see EEM_Base::get_all
1212
+	 * @throws EE_Error
1213
+	 */
1214
+	public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1215
+	{
1216
+		if (! isset($query_params[0])) {
1217
+			$query_params[0] = array();
1218
+		}
1219
+		$conditions_from_id = $this->parse_index_primary_key_string($id);
1220
+		if ($conditions_from_id === null) {
1221
+			$query_params[0][$this->primary_key_name()] = $id;
1222
+		} else {
1223
+			//no primary key, so the $id must be from the get_index_primary_key_string()
1224
+			$query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1225
+		}
1226
+		return $query_params;
1227
+	}
1228
+
1229
+
1230
+
1231
+	/**
1232
+	 * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1233
+	 * array. If no item is found, null is returned.
1234
+	 *
1235
+	 * @param array $query_params like EEM_Base's $query_params variable.
1236
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1237
+	 * @throws EE_Error
1238
+	 */
1239
+	public function get_one($query_params = array())
1240
+	{
1241
+		if (! is_array($query_params)) {
1242
+			EE_Error::doing_it_wrong('EEM_Base::get_one',
1243
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1244
+					gettype($query_params)), '4.6.0');
1245
+			$query_params = array();
1246
+		}
1247
+		$query_params['limit'] = 1;
1248
+		$items = $this->get_all($query_params);
1249
+		if (empty($items)) {
1250
+			return null;
1251
+		}
1252
+		return array_shift($items);
1253
+	}
1254
+
1255
+
1256
+
1257
+	/**
1258
+	 * Returns the next x number of items in sequence from the given value as
1259
+	 * 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 next_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(
1281
+			$current_field_value,
1282
+			'>',
1283
+			$field_to_order_by,
1284
+			$limit,
1285
+			$query_params,
1286
+			$columns_to_select
1287
+		);
1288
+	}
1289
+
1290
+
1291
+
1292
+	/**
1293
+	 * Returns the previous x number of items in sequence from the given value
1294
+	 * as found in the database matching the given query conditions.
1295
+	 *
1296
+	 * @param mixed $current_field_value    Value used for the reference point.
1297
+	 * @param null  $field_to_order_by      What field is used for the
1298
+	 *                                      reference point.
1299
+	 * @param int   $limit                  How many to return.
1300
+	 * @param array $query_params           Extra conditions on the query.
1301
+	 * @param null  $columns_to_select      If left null, then an array of
1302
+	 *                                      EE_Base_Class objects is returned,
1303
+	 *                                      otherwise you can indicate just the
1304
+	 *                                      columns you want returned.
1305
+	 * @return EE_Base_Class[]|array
1306
+	 * @throws EE_Error
1307
+	 */
1308
+	public function previous_x(
1309
+		$current_field_value,
1310
+		$field_to_order_by = null,
1311
+		$limit = 1,
1312
+		$query_params = array(),
1313
+		$columns_to_select = null
1314
+	) {
1315
+		return $this->_get_consecutive(
1316
+			$current_field_value,
1317
+			'<',
1318
+			$field_to_order_by,
1319
+			$limit,
1320
+			$query_params,
1321
+			$columns_to_select
1322
+		);
1323
+	}
1324
+
1325
+
1326
+
1327
+	/**
1328
+	 * Returns the next item in sequence from the given value as found in the
1329
+	 * database matching the given query conditions.
1330
+	 *
1331
+	 * @param mixed $current_field_value    Value used for the reference point.
1332
+	 * @param null  $field_to_order_by      What field is used for the
1333
+	 *                                      reference point.
1334
+	 * @param array $query_params           Extra conditions on the query.
1335
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1336
+	 *                                      object is returned, otherwise you
1337
+	 *                                      can indicate just the columns you
1338
+	 *                                      want and a single array indexed by
1339
+	 *                                      the columns will be returned.
1340
+	 * @return EE_Base_Class|null|array()
1341
+	 * @throws EE_Error
1342
+	 */
1343
+	public function next(
1344
+		$current_field_value,
1345
+		$field_to_order_by = null,
1346
+		$query_params = array(),
1347
+		$columns_to_select = null
1348
+	) {
1349
+		$results = $this->_get_consecutive(
1350
+			$current_field_value,
1351
+			'>',
1352
+			$field_to_order_by,
1353
+			1,
1354
+			$query_params,
1355
+			$columns_to_select
1356
+		);
1357
+		return empty($results) ? null : reset($results);
1358
+	}
1359
+
1360
+
1361
+
1362
+	/**
1363
+	 * Returns the previous item in sequence from the given value as found in
1364
+	 * the database matching the given query conditions.
1365
+	 *
1366
+	 * @param mixed $current_field_value    Value used for the reference point.
1367
+	 * @param null  $field_to_order_by      What field is used for the
1368
+	 *                                      reference point.
1369
+	 * @param array $query_params           Extra conditions on the query.
1370
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1371
+	 *                                      object is returned, otherwise you
1372
+	 *                                      can indicate just the columns you
1373
+	 *                                      want and a single array indexed by
1374
+	 *                                      the columns will be returned.
1375
+	 * @return EE_Base_Class|null|array()
1376
+	 * @throws EE_Error
1377
+	 */
1378
+	public function previous(
1379
+		$current_field_value,
1380
+		$field_to_order_by = null,
1381
+		$query_params = array(),
1382
+		$columns_to_select = null
1383
+	) {
1384
+		$results = $this->_get_consecutive(
1385
+			$current_field_value,
1386
+			'<',
1387
+			$field_to_order_by,
1388
+			1,
1389
+			$query_params,
1390
+			$columns_to_select
1391
+		);
1392
+		return empty($results) ? null : reset($results);
1393
+	}
1394
+
1395
+
1396
+
1397
+	/**
1398
+	 * Returns the a consecutive number of items in sequence from the given
1399
+	 * value as found in the database matching the given query conditions.
1400
+	 *
1401
+	 * @param mixed  $current_field_value   Value used for the reference point.
1402
+	 * @param string $operand               What operand is used for the sequence.
1403
+	 * @param string $field_to_order_by     What field is used for the reference point.
1404
+	 * @param int    $limit                 How many to return.
1405
+	 * @param array  $query_params          Extra conditions on the query.
1406
+	 * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1407
+	 *                                      otherwise you can indicate just the columns you want returned.
1408
+	 * @return EE_Base_Class[]|array
1409
+	 * @throws EE_Error
1410
+	 */
1411
+	protected function _get_consecutive(
1412
+		$current_field_value,
1413
+		$operand = '>',
1414
+		$field_to_order_by = null,
1415
+		$limit = 1,
1416
+		$query_params = array(),
1417
+		$columns_to_select = null
1418
+	) {
1419
+		//if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1420
+		if (empty($field_to_order_by)) {
1421
+			if ($this->has_primary_key_field()) {
1422
+				$field_to_order_by = $this->get_primary_key_field()->get_name();
1423
+			} else {
1424
+				if (WP_DEBUG) {
1425
+					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).',
1426
+						'event_espresso'));
1427
+				}
1428
+				EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1429
+				return array();
1430
+			}
1431
+		}
1432
+		if (! is_array($query_params)) {
1433
+			EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1434
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1435
+					gettype($query_params)), '4.6.0');
1436
+			$query_params = array();
1437
+		}
1438
+		//let's add the where query param for consecutive look up.
1439
+		$query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1440
+		$query_params['limit'] = $limit;
1441
+		//set direction
1442
+		$incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1443
+		$query_params['order_by'] = $operand === '>'
1444
+			? array($field_to_order_by => 'ASC') + $incoming_orderby
1445
+			: array($field_to_order_by => 'DESC') + $incoming_orderby;
1446
+		//if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1447
+		if (empty($columns_to_select)) {
1448
+			return $this->get_all($query_params);
1449
+		}
1450
+		//getting just the fields
1451
+		return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1452
+	}
1453
+
1454
+
1455
+
1456
+	/**
1457
+	 * This sets the _timezone property after model object has been instantiated.
1458
+	 *
1459
+	 * @param null | string $timezone valid PHP DateTimeZone timezone string
1460
+	 */
1461
+	public function set_timezone($timezone)
1462
+	{
1463
+		if ($timezone !== null) {
1464
+			$this->_timezone = $timezone;
1465
+		}
1466
+		//note we need to loop through relations and set the timezone on those objects as well.
1467
+		foreach ($this->_model_relations as $relation) {
1468
+			$relation->set_timezone($timezone);
1469
+		}
1470
+		//and finally we do the same for any datetime fields
1471
+		foreach ($this->_fields as $field) {
1472
+			if ($field instanceof EE_Datetime_Field) {
1473
+				$field->set_timezone($timezone);
1474
+			}
1475
+		}
1476
+	}
1477
+
1478
+
1479
+
1480
+	/**
1481
+	 * This just returns whatever is set for the current timezone.
1482
+	 *
1483
+	 * @access public
1484
+	 * @return string
1485
+	 */
1486
+	public function get_timezone()
1487
+	{
1488
+		//first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1489
+		if (empty($this->_timezone)) {
1490
+			foreach ($this->_fields as $field) {
1491
+				if ($field instanceof EE_Datetime_Field) {
1492
+					$this->set_timezone($field->get_timezone());
1493
+					break;
1494
+				}
1495
+			}
1496
+		}
1497
+		//if timezone STILL empty then return the default timezone for the site.
1498
+		if (empty($this->_timezone)) {
1499
+			$this->set_timezone(EEH_DTT_Helper::get_timezone());
1500
+		}
1501
+		return $this->_timezone;
1502
+	}
1503
+
1504
+
1505
+
1506
+	/**
1507
+	 * This returns the date formats set for the given field name and also ensures that
1508
+	 * $this->_timezone property is set correctly.
1509
+	 *
1510
+	 * @since 4.6.x
1511
+	 * @param string $field_name The name of the field the formats are being retrieved for.
1512
+	 * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1513
+	 * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1514
+	 * @return array formats in an array with the date format first, and the time format last.
1515
+	 */
1516
+	public function get_formats_for($field_name, $pretty = false)
1517
+	{
1518
+		$field_settings = $this->field_settings_for($field_name);
1519
+		//if not a valid EE_Datetime_Field then throw error
1520
+		if (! $field_settings instanceof EE_Datetime_Field) {
1521
+			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.',
1522
+				'event_espresso'), $field_name));
1523
+		}
1524
+		//while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1525
+		//the field.
1526
+		$this->_timezone = $field_settings->get_timezone();
1527
+		return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1528
+	}
1529
+
1530
+
1531
+
1532
+	/**
1533
+	 * This returns the current time in a format setup for a query on this model.
1534
+	 * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1535
+	 * it will return:
1536
+	 *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1537
+	 *  NOW
1538
+	 *  - or a unix timestamp (equivalent to time())
1539
+	 * Note: When requesting a formatted string, if the date or time format doesn't include seconds, for example,
1540
+	 * the time returned, because it uses that format, will also NOT include seconds. For this reason, if you want
1541
+	 * the time returned to be the current time down to the exact second, set $timestamp to true.
1542
+	 * @since 4.6.x
1543
+	 * @param string $field_name       The field the current time is needed for.
1544
+	 * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1545
+	 *                                 formatted string matching the set format for the field in the set timezone will
1546
+	 *                                 be returned.
1547
+	 * @param string $what             Whether to return the string in just the time format, the date format, or both.
1548
+	 * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1549
+	 * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1550
+	 *                                 exception is triggered.
1551
+	 */
1552
+	public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1553
+	{
1554
+		$formats = $this->get_formats_for($field_name);
1555
+		$DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1556
+		if ($timestamp) {
1557
+			return $DateTime->format('U');
1558
+		}
1559
+		//not returning timestamp, so return formatted string in timezone.
1560
+		switch ($what) {
1561
+			case 'time' :
1562
+				return $DateTime->format($formats[1]);
1563
+				break;
1564
+			case 'date' :
1565
+				return $DateTime->format($formats[0]);
1566
+				break;
1567
+			default :
1568
+				return $DateTime->format(implode(' ', $formats));
1569
+				break;
1570
+		}
1571
+	}
1572
+
1573
+
1574
+
1575
+	/**
1576
+	 * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1577
+	 * for the model are.  Returns a DateTime object.
1578
+	 * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1579
+	 * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1580
+	 * ignored.
1581
+	 *
1582
+	 * @param string $field_name      The field being setup.
1583
+	 * @param string $timestring      The date time string being used.
1584
+	 * @param string $incoming_format The format for the time string.
1585
+	 * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1586
+	 *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1587
+	 *                                format is
1588
+	 *                                'U', this is ignored.
1589
+	 * @return DateTime
1590
+	 * @throws EE_Error
1591
+	 */
1592
+	public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1593
+	{
1594
+		//just using this to ensure the timezone is set correctly internally
1595
+		$this->get_formats_for($field_name);
1596
+		//load EEH_DTT_Helper
1597
+		$set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1598
+		$incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1599
+		return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1600
+	}
1601
+
1602
+
1603
+
1604
+	/**
1605
+	 * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1606
+	 *
1607
+	 * @return EE_Table_Base[]
1608
+	 */
1609
+	public function get_tables()
1610
+	{
1611
+		return $this->_tables;
1612
+	}
1613
+
1614
+
1615
+
1616
+	/**
1617
+	 * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1618
+	 * also updates all the model objects, where the criteria expressed in $query_params are met..
1619
+	 * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1620
+	 * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1621
+	 * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1622
+	 * model object with EVT_ID = 1
1623
+	 * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1624
+	 * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1625
+	 * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1626
+	 * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1627
+	 * are not specified)
1628
+	 *
1629
+	 * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1630
+	 *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1631
+	 *                                         are to be serialized. Basically, the values are what you'd expect to be
1632
+	 *                                         values on the model, NOT necessarily what's in the DB. For example, if
1633
+	 *                                         we wanted to update only the TXN_details on any Transactions where its
1634
+	 *                                         ID=34, we'd use this method as follows:
1635
+	 *                                         EEM_Transaction::instance()->update(
1636
+	 *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1637
+	 *                                         array(array('TXN_ID'=>34)));
1638
+	 * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1639
+	 *                                         in client code into what's expected to be stored on each field. Eg,
1640
+	 *                                         consider updating Question's QST_admin_label field is of type
1641
+	 *                                         Simple_HTML. If you use this function to update that field to $new_value
1642
+	 *                                         = (note replace 8's with appropriate opening and closing tags in the
1643
+	 *                                         following example)"8script8alert('I hack all');8/script88b8boom
1644
+	 *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1645
+	 *                                         TRUE, it is assumed that you've already called
1646
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1647
+	 *                                         malicious javascript. However, if
1648
+	 *                                         $values_already_prepared_by_model_object is left as FALSE, then
1649
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
1650
+	 *                                         and every other field, before insertion. We provide this parameter
1651
+	 *                                         because model objects perform their prepare_for_set function on all
1652
+	 *                                         their values, and so don't need to be called again (and in many cases,
1653
+	 *                                         shouldn't be called again. Eg: if we escape HTML characters in the
1654
+	 *                                         prepare_for_set method...)
1655
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1656
+	 *                                         in this model's entity map according to $fields_n_values that match
1657
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
1658
+	 *                                         by setting this to FALSE, but be aware that model objects being used
1659
+	 *                                         could get out-of-sync with the database
1660
+	 * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1661
+	 *                                         rows affected which *could* include 0 which DOES NOT mean the query was
1662
+	 *                                         bad)
1663
+	 * @throws EE_Error
1664
+	 */
1665
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1666
+	{
1667
+		if (! is_array($query_params)) {
1668
+			EE_Error::doing_it_wrong('EEM_Base::update',
1669
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1670
+					gettype($query_params)), '4.6.0');
1671
+			$query_params = array();
1672
+		}
1673
+		/**
1674
+		 * Action called before a model update call has been made.
1675
+		 *
1676
+		 * @param EEM_Base $model
1677
+		 * @param array    $fields_n_values the updated fields and their new values
1678
+		 * @param array    $query_params    @see EEM_Base::get_all()
1679
+		 */
1680
+		do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1681
+		/**
1682
+		 * Filters the fields about to be updated given the query parameters. You can provide the
1683
+		 * $query_params to $this->get_all() to find exactly which records will be updated
1684
+		 *
1685
+		 * @param array    $fields_n_values fields and their new values
1686
+		 * @param EEM_Base $model           the model being queried
1687
+		 * @param array    $query_params    see EEM_Base::get_all()
1688
+		 */
1689
+		$fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1690
+			$query_params);
1691
+		//need to verify that, for any entry we want to update, there are entries in each secondary table.
1692
+		//to do that, for each table, verify that it's PK isn't null.
1693
+		$tables = $this->get_tables();
1694
+		//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
1695
+		//NOTE: we should make this code more efficient by NOT querying twice
1696
+		//before the real update, but that needs to first go through ALPHA testing
1697
+		//as it's dangerous. says Mike August 8 2014
1698
+		//we want to make sure the default_where strategy is ignored
1699
+		$this->_ignore_where_strategy = true;
1700
+		$wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1701
+		foreach ($wpdb_select_results as $wpdb_result) {
1702
+			// type cast stdClass as array
1703
+			$wpdb_result = (array)$wpdb_result;
1704
+			//get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1705
+			if ($this->has_primary_key_field()) {
1706
+				$main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1707
+			} else {
1708
+				//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)
1709
+				$main_table_pk_value = null;
1710
+			}
1711
+			//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
1712
+			//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
1713
+			if (count($tables) > 1) {
1714
+				//foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1715
+				//in that table, and so we'll want to insert one
1716
+				foreach ($tables as $table_obj) {
1717
+					$this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1718
+					//if there is no private key for this table on the results, it means there's no entry
1719
+					//in this table, right? so insert a row in the current table, using any fields available
1720
+					if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1721
+						   && $wpdb_result[$this_table_pk_column])
1722
+					) {
1723
+						$success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1724
+							$main_table_pk_value);
1725
+						//if we died here, report the error
1726
+						if (! $success) {
1727
+							return false;
1728
+						}
1729
+					}
1730
+				}
1731
+			}
1732
+			//				//and now check that if we have cached any models by that ID on the model, that
1733
+			//				//they also get updated properly
1734
+			//				$model_object = $this->get_from_entity_map( $main_table_pk_value );
1735
+			//				if( $model_object ){
1736
+			//					foreach( $fields_n_values as $field => $value ){
1737
+			//						$model_object->set($field, $value);
1738
+			//let's make sure default_where strategy is followed now
1739
+			$this->_ignore_where_strategy = false;
1740
+		}
1741
+		//if we want to keep model objects in sync, AND
1742
+		//if this wasn't called from a model object (to update itself)
1743
+		//then we want to make sure we keep all the existing
1744
+		//model objects in sync with the db
1745
+		if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1746
+			if ($this->has_primary_key_field()) {
1747
+				$model_objs_affected_ids = $this->get_col($query_params);
1748
+			} else {
1749
+				//we need to select a bunch of columns and then combine them into the the "index primary key string"s
1750
+				$models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1751
+				$model_objs_affected_ids = array();
1752
+				foreach ($models_affected_key_columns as $row) {
1753
+					$combined_index_key = $this->get_index_primary_key_string($row);
1754
+					$model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1755
+				}
1756
+			}
1757
+			if (! $model_objs_affected_ids) {
1758
+				//wait wait wait- if nothing was affected let's stop here
1759
+				return 0;
1760
+			}
1761
+			foreach ($model_objs_affected_ids as $id) {
1762
+				$model_obj_in_entity_map = $this->get_from_entity_map($id);
1763
+				if ($model_obj_in_entity_map) {
1764
+					foreach ($fields_n_values as $field => $new_value) {
1765
+						$model_obj_in_entity_map->set($field, $new_value);
1766
+					}
1767
+				}
1768
+			}
1769
+			//if there is a primary key on this model, we can now do a slight optimization
1770
+			if ($this->has_primary_key_field()) {
1771
+				//we already know what we want to update. So let's make the query simpler so it's a little more efficient
1772
+				$query_params = array(
1773
+					array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1774
+					'limit'                    => count($model_objs_affected_ids),
1775
+					'default_where_conditions' => EEM_Base::default_where_conditions_none,
1776
+				);
1777
+			}
1778
+		}
1779
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1780
+		$SQL = "UPDATE "
1781
+			   . $model_query_info->get_full_join_sql()
1782
+			   . " SET "
1783
+			   . $this->_construct_update_sql($fields_n_values)
1784
+			   . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1785
+		$rows_affected = $this->_do_wpdb_query('query', array($SQL));
1786
+		/**
1787
+		 * Action called after a model update call has been made.
1788
+		 *
1789
+		 * @param EEM_Base $model
1790
+		 * @param array    $fields_n_values the updated fields and their new values
1791
+		 * @param array    $query_params    @see EEM_Base::get_all()
1792
+		 * @param int      $rows_affected
1793
+		 */
1794
+		do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1795
+		return $rows_affected;//how many supposedly got updated
1796
+	}
1797
+
1798
+
1799
+
1800
+	/**
1801
+	 * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1802
+	 * are teh values of the field specified (or by default the primary key field)
1803
+	 * that matched the query params. Note that you should pass the name of the
1804
+	 * model FIELD, not the database table's column name.
1805
+	 *
1806
+	 * @param array  $query_params @see EEM_Base::get_all()
1807
+	 * @param string $field_to_select
1808
+	 * @return array just like $wpdb->get_col()
1809
+	 * @throws EE_Error
1810
+	 */
1811
+	public function get_col($query_params = array(), $field_to_select = null)
1812
+	{
1813
+		if ($field_to_select) {
1814
+			$field = $this->field_settings_for($field_to_select);
1815
+		} elseif ($this->has_primary_key_field()) {
1816
+			$field = $this->get_primary_key_field();
1817
+		} else {
1818
+			//no primary key, just grab the first column
1819
+			$field = reset($this->field_settings());
1820
+		}
1821
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1822
+		$select_expressions = $field->get_qualified_column();
1823
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1824
+		return $this->_do_wpdb_query('get_col', array($SQL));
1825
+	}
1826
+
1827
+
1828
+
1829
+	/**
1830
+	 * Returns a single column value for a single row from the database
1831
+	 *
1832
+	 * @param array  $query_params    @see EEM_Base::get_all()
1833
+	 * @param string $field_to_select @see EEM_Base::get_col()
1834
+	 * @return string
1835
+	 * @throws EE_Error
1836
+	 */
1837
+	public function get_var($query_params = array(), $field_to_select = null)
1838
+	{
1839
+		$query_params['limit'] = 1;
1840
+		$col = $this->get_col($query_params, $field_to_select);
1841
+		if (! empty($col)) {
1842
+			return reset($col);
1843
+		}
1844
+		return null;
1845
+	}
1846
+
1847
+
1848
+
1849
+	/**
1850
+	 * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1851
+	 * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1852
+	 * injection, but currently no further filtering is done
1853
+	 *
1854
+	 * @global      $wpdb
1855
+	 * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1856
+	 *                               be updated to in the DB
1857
+	 * @return string of SQL
1858
+	 * @throws EE_Error
1859
+	 */
1860
+	public function _construct_update_sql($fields_n_values)
1861
+	{
1862
+		/** @type WPDB $wpdb */
1863
+		global $wpdb;
1864
+		$cols_n_values = array();
1865
+		foreach ($fields_n_values as $field_name => $value) {
1866
+			$field_obj = $this->field_settings_for($field_name);
1867
+			//if the value is NULL, we want to assign the value to that.
1868
+			//wpdb->prepare doesn't really handle that properly
1869
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1870
+			$value_sql = $prepared_value === null ? 'NULL'
1871
+				: $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1872
+			$cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1873
+		}
1874
+		return implode(",", $cols_n_values);
1875
+	}
1876
+
1877
+
1878
+
1879
+	/**
1880
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1881
+	 * Performs a HARD delete, meaning the database row should always be removed,
1882
+	 * not just have a flag field on it switched
1883
+	 * Wrapper for EEM_Base::delete_permanently()
1884
+	 *
1885
+	 * @param mixed $id
1886
+	 * @return boolean whether the row got deleted or not
1887
+	 * @throws EE_Error
1888
+	 */
1889
+	public function delete_permanently_by_ID($id)
1890
+	{
1891
+		return $this->delete_permanently(
1892
+			array(
1893
+				array($this->get_primary_key_field()->get_name() => $id),
1894
+				'limit' => 1,
1895
+			)
1896
+		);
1897
+	}
1898
+
1899
+
1900
+
1901
+	/**
1902
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1903
+	 * Wrapper for EEM_Base::delete()
1904
+	 *
1905
+	 * @param mixed $id
1906
+	 * @return boolean whether the row got deleted or not
1907
+	 * @throws EE_Error
1908
+	 */
1909
+	public function delete_by_ID($id)
1910
+	{
1911
+		return $this->delete(
1912
+			array(
1913
+				array($this->get_primary_key_field()->get_name() => $id),
1914
+				'limit' => 1,
1915
+			)
1916
+		);
1917
+	}
1918
+
1919
+
1920
+
1921
+	/**
1922
+	 * Identical to delete_permanently, but does a "soft" delete if possible,
1923
+	 * meaning if the model has a field that indicates its been "trashed" or
1924
+	 * "soft deleted", we will just set that instead of actually deleting the rows.
1925
+	 *
1926
+	 * @see EEM_Base::delete_permanently
1927
+	 * @param array   $query_params
1928
+	 * @param boolean $allow_blocking
1929
+	 * @return int how many rows got deleted
1930
+	 * @throws EE_Error
1931
+	 */
1932
+	public function delete($query_params, $allow_blocking = true)
1933
+	{
1934
+		return $this->delete_permanently($query_params, $allow_blocking);
1935
+	}
1936
+
1937
+
1938
+
1939
+	/**
1940
+	 * Deletes the model objects that meet the query params. Note: this method is overridden
1941
+	 * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1942
+	 * as archived, not actually deleted
1943
+	 *
1944
+	 * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1945
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1946
+	 *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1947
+	 *                                deletes regardless of other objects which may depend on it. Its generally
1948
+	 *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1949
+	 *                                DB
1950
+	 * @return int how many rows got deleted
1951
+	 * @throws EE_Error
1952
+	 */
1953
+	public function delete_permanently($query_params, $allow_blocking = true)
1954
+	{
1955
+		/**
1956
+		 * Action called just before performing a real deletion query. You can use the
1957
+		 * model and its $query_params to find exactly which items will be deleted
1958
+		 *
1959
+		 * @param EEM_Base $model
1960
+		 * @param array    $query_params   @see EEM_Base::get_all()
1961
+		 * @param boolean  $allow_blocking whether or not to allow related model objects
1962
+		 *                                 to block (prevent) this deletion
1963
+		 */
1964
+		do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1965
+		//some MySQL databases may be running safe mode, which may restrict
1966
+		//deletion if there is no KEY column used in the WHERE statement of a deletion.
1967
+		//to get around this, we first do a SELECT, get all the IDs, and then run another query
1968
+		//to delete them
1969
+		$items_for_deletion = $this->_get_all_wpdb_results($query_params);
1970
+		$columns_and_ids_for_deleting = $this->_get_ids_for_delete($items_for_deletion, $allow_blocking);
1971
+		$deletion_where_query_part = $this->_build_query_part_for_deleting_from_columns_and_values(
1972
+			$columns_and_ids_for_deleting
1973
+		);
1974
+		/**
1975
+		 * Allows client code to act on the items being deleted before the query is actually executed.
1976
+		 *
1977
+		 * @param EEM_Base $this  The model instance being acted on.
1978
+		 * @param array    $query_params  The incoming array of query parameters influencing what gets deleted.
1979
+		 * @param bool     $allow_blocking @see param description in method phpdoc block.
1980
+		 * @param array $columns_and_ids_for_deleting       An array indicating what entities will get removed as
1981
+		 *                                                  derived from the incoming query parameters.
1982
+		 *                                                  @see details on the structure of this array in the phpdocs
1983
+		 *                                                  for the `_get_ids_for_delete_method`
1984
+		 *
1985
+		 */
1986
+		do_action('AHEE__EEM_Base__delete__before_query',
1987
+			$this,
1988
+			$query_params,
1989
+			$allow_blocking,
1990
+			$columns_and_ids_for_deleting
1991
+		);
1992
+		if ($deletion_where_query_part) {
1993
+			$model_query_info = $this->_create_model_query_info_carrier($query_params);
1994
+			$table_aliases = array_keys($this->_tables);
1995
+			$SQL = "DELETE "
1996
+				   . implode(", ", $table_aliases)
1997
+				   . " FROM "
1998
+				   . $model_query_info->get_full_join_sql()
1999
+				   . " WHERE "
2000
+				   . $deletion_where_query_part;
2001
+			$rows_deleted = $this->_do_wpdb_query('query', array($SQL));
2002
+		} else {
2003
+			$rows_deleted = 0;
2004
+		}
2005
+
2006
+		//Next, make sure those items are removed from the entity map; if they could be put into it at all; and if
2007
+		//there was no error with the delete query.
2008
+		if ($this->has_primary_key_field()
2009
+			&& $rows_deleted !== false
2010
+			&& isset($columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()])
2011
+		) {
2012
+			$ids_for_removal = $columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()];
2013
+			foreach ($ids_for_removal as $id) {
2014
+				if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
2015
+					unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
2016
+				}
2017
+			}
2018
+
2019
+			// delete any extra meta attached to the deleted entities but ONLY if this model is not an instance of
2020
+			//`EEM_Extra_Meta`.  In other words we want to prevent recursion on EEM_Extra_Meta::delete_permanently calls
2021
+			//unnecessarily.  It's very unlikely that users will have assigned Extra Meta to Extra Meta
2022
+			// (although it is possible).
2023
+			//Note this can be skipped by using the provided filter and returning false.
2024
+			if (apply_filters(
2025
+				'FHEE__EEM_Base__delete_permanently__dont_delete_extra_meta_for_extra_meta',
2026
+				! $this instanceof EEM_Extra_Meta,
2027
+				$this
2028
+			)) {
2029
+				EEM_Extra_Meta::instance()->delete_permanently(array(
2030
+					0 => array(
2031
+						'EXM_type' => $this->get_this_model_name(),
2032
+						'OBJ_ID'   => array(
2033
+							'IN',
2034
+							$ids_for_removal
2035
+						)
2036
+					)
2037
+				));
2038
+			}
2039
+		}
2040
+
2041
+		/**
2042
+		 * Action called just after performing a real deletion query. Although at this point the
2043
+		 * items should have been deleted
2044
+		 *
2045
+		 * @param EEM_Base $model
2046
+		 * @param array    $query_params @see EEM_Base::get_all()
2047
+		 * @param int      $rows_deleted
2048
+		 */
2049
+		do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
2050
+		return $rows_deleted;//how many supposedly got deleted
2051
+	}
2052
+
2053
+
2054
+
2055
+	/**
2056
+	 * Checks all the relations that throw error messages when there are blocking related objects
2057
+	 * for related model objects. If there are any related model objects on those relations,
2058
+	 * adds an EE_Error, and return true
2059
+	 *
2060
+	 * @param EE_Base_Class|int $this_model_obj_or_id
2061
+	 * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
2062
+	 *                                                 should be ignored when determining whether there are related
2063
+	 *                                                 model objects which block this model object's deletion. Useful
2064
+	 *                                                 if you know A is related to B and are considering deleting A,
2065
+	 *                                                 but want to see if A has any other objects blocking its deletion
2066
+	 *                                                 before removing the relation between A and B
2067
+	 * @return boolean
2068
+	 * @throws EE_Error
2069
+	 */
2070
+	public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
2071
+	{
2072
+		//first, if $ignore_this_model_obj was supplied, get its model
2073
+		if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
2074
+			$ignored_model = $ignore_this_model_obj->get_model();
2075
+		} else {
2076
+			$ignored_model = null;
2077
+		}
2078
+		//now check all the relations of $this_model_obj_or_id and see if there
2079
+		//are any related model objects blocking it?
2080
+		$is_blocked = false;
2081
+		foreach ($this->_model_relations as $relation_name => $relation_obj) {
2082
+			if ($relation_obj->block_delete_if_related_models_exist()) {
2083
+				//if $ignore_this_model_obj was supplied, then for the query
2084
+				//on that model needs to be told to ignore $ignore_this_model_obj
2085
+				if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
2086
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
2087
+						array(
2088
+							$ignored_model->get_primary_key_field()->get_name() => array(
2089
+								'!=',
2090
+								$ignore_this_model_obj->ID(),
2091
+							),
2092
+						),
2093
+					));
2094
+				} else {
2095
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
2096
+				}
2097
+				if ($related_model_objects) {
2098
+					EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
2099
+					$is_blocked = true;
2100
+				}
2101
+			}
2102
+		}
2103
+		return $is_blocked;
2104
+	}
2105
+
2106
+
2107
+	/**
2108
+	 * Builds the columns and values for items to delete from the incoming $row_results_for_deleting array.
2109
+	 * @param array $row_results_for_deleting
2110
+	 * @param bool  $allow_blocking
2111
+	 * @return array   The shape of this array depends on whether the model `has_primary_key_field` or not.  If the
2112
+	 *                 model DOES have a primary_key_field, then the array will be a simple single dimension array where
2113
+	 *                 the key is the fully qualified primary key column and the value is an array of ids that will be
2114
+	 *                 deleted. Example:
2115
+	 *                      array('Event.EVT_ID' => array( 1,2,3))
2116
+	 *                 If the model DOES NOT have a primary_key_field, then the array will be a two dimensional array
2117
+	 *                 where each element is a group of columns and values that get deleted. Example:
2118
+	 *                      array(
2119
+	 *                          0 => array(
2120
+	 *                              'Term_Relationship.object_id' => 1
2121
+	 *                              'Term_Relationship.term_taxonomy_id' => 5
2122
+	 *                          ),
2123
+	 *                          1 => array(
2124
+	 *                              'Term_Relationship.object_id' => 1
2125
+	 *                              'Term_Relationship.term_taxonomy_id' => 6
2126
+	 *                          )
2127
+	 *                      )
2128
+	 * @throws EE_Error
2129
+	 */
2130
+	protected function _get_ids_for_delete(array $row_results_for_deleting, $allow_blocking = true)
2131
+	{
2132
+		$ids_to_delete_indexed_by_column = array();
2133
+		if ($this->has_primary_key_field()) {
2134
+			$primary_table = $this->_get_main_table();
2135
+			$other_tables = $this->_get_other_tables();
2136
+			$ids_to_delete_indexed_by_column = $query = array();
2137
+			foreach ($row_results_for_deleting as $item_to_delete) {
2138
+				//before we mark this item for deletion,
2139
+				//make sure there's no related entities blocking its deletion (if we're checking)
2140
+				if (
2141
+					$allow_blocking
2142
+					&& $this->delete_is_blocked_by_related_models(
2143
+						$item_to_delete[$primary_table->get_fully_qualified_pk_column()]
2144
+					)
2145
+				) {
2146
+					continue;
2147
+				}
2148
+				//primary table deletes
2149
+				if (isset($item_to_delete[$primary_table->get_fully_qualified_pk_column()])) {
2150
+					$ids_to_delete_indexed_by_column[$primary_table->get_fully_qualified_pk_column()][] =
2151
+						$item_to_delete[$primary_table->get_fully_qualified_pk_column()];
2152
+				}
2153
+			}
2154
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
2155
+			$fields = $this->get_combined_primary_key_fields();
2156
+			foreach ($row_results_for_deleting as $item_to_delete) {
2157
+				$ids_to_delete_indexed_by_column_for_row = array();
2158
+				foreach ($fields as $cpk_field) {
2159
+					if ($cpk_field instanceof EE_Model_Field_Base) {
2160
+						$ids_to_delete_indexed_by_column_for_row[$cpk_field->get_qualified_column()] =
2161
+							$item_to_delete[$cpk_field->get_qualified_column()];
2162
+					}
2163
+				}
2164
+				$ids_to_delete_indexed_by_column[] = $ids_to_delete_indexed_by_column_for_row;
2165
+			}
2166
+		} else {
2167
+			//so there's no primary key and no combined key...
2168
+			//sorry, can't help you
2169
+			throw new EE_Error(
2170
+				sprintf(
2171
+					__(
2172
+						"Cannot delete objects of type %s because there is no primary key NOR combined key",
2173
+						"event_espresso"
2174
+					), get_class($this)
2175
+				)
2176
+			);
2177
+		}    
2178
+		return $ids_to_delete_indexed_by_column;
2179
+	}
2180
+
2181
+
2182
+	/**
2183
+	 * This receives an array of columns and values set to be deleted (as prepared by _get_ids_for_delete) and prepares
2184
+	 * the corresponding query_part for the query performing the delete.
2185
+	 *
2186
+	 * @param array $ids_to_delete_indexed_by_column @see _get_ids_for_delete for how this array might be shaped.
2187
+	 * @return string
2188
+	 * @throws EE_Error
2189
+	 */
2190
+	protected function _build_query_part_for_deleting_from_columns_and_values(array $ids_to_delete_indexed_by_column) {
2191
+		$query_part = '';
2192
+		if (empty($ids_to_delete_indexed_by_column)) {
2193
+			return $query_part;
2194
+		} elseif ($this->has_primary_key_field()) {
2195
+			$query = array();
2196
+			foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
2197
+				//make sure we have unique $ids
2198
+				$ids = array_unique($ids);
2199
+				$query[] = $column . ' IN(' . implode(',', $ids) . ')';
2200
+			}
2201
+			$query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
2202
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
2203
+			$ways_to_identify_a_row = array();
2204
+			foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
2205
+				$values_for_each_combined_primary_key_for_a_row = array();
2206
+				foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
2207
+					$values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
2208
+				}
2209
+				$ways_to_identify_a_row[] = '(' . implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
2210
+			}
2211
+			$query_part = implode(' OR ', $ways_to_identify_a_row);
2212
+		}
2213
+		return $query_part;
2214
+	}
2215 2215
     
2216 2216
 
2217 2217
 
2218 2218
 
2219
-    /**
2220
-     * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
2221
-     * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
2222
-     * column
2223
-     *
2224
-     * @param array  $query_params   like EEM_Base::get_all's
2225
-     * @param string $field_to_count field on model to count by (not column name)
2226
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2227
-     *                               that by the setting $distinct to TRUE;
2228
-     * @return int
2229
-     * @throws EE_Error
2230
-     */
2231
-    public function count($query_params = array(), $field_to_count = null, $distinct = false)
2232
-    {
2233
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2234
-        if ($field_to_count) {
2235
-            $field_obj = $this->field_settings_for($field_to_count);
2236
-            $column_to_count = $field_obj->get_qualified_column();
2237
-        } elseif ($this->has_primary_key_field()) {
2238
-            $pk_field_obj = $this->get_primary_key_field();
2239
-            $column_to_count = $pk_field_obj->get_qualified_column();
2240
-        } else {
2241
-            //there's no primary key
2242
-            //if we're counting distinct items, and there's no primary key,
2243
-            //we need to list out the columns for distinction;
2244
-            //otherwise we can just use star
2245
-            if ($distinct) {
2246
-                $columns_to_use = array();
2247
-                foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2248
-                    $columns_to_use[] = $field_obj->get_qualified_column();
2249
-                }
2250
-                $column_to_count = implode(',', $columns_to_use);
2251
-            } else {
2252
-                $column_to_count = '*';
2253
-            }
2254
-        }
2255
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2256
-        $SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2257
-        return (int)$this->_do_wpdb_query('get_var', array($SQL));
2258
-    }
2259
-
2260
-
2261
-
2262
-    /**
2263
-     * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2264
-     *
2265
-     * @param array  $query_params like EEM_Base::get_all
2266
-     * @param string $field_to_sum name of field (array key in $_fields array)
2267
-     * @return float
2268
-     * @throws EE_Error
2269
-     */
2270
-    public function sum($query_params, $field_to_sum = null)
2271
-    {
2272
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2273
-        if ($field_to_sum) {
2274
-            $field_obj = $this->field_settings_for($field_to_sum);
2275
-        } else {
2276
-            $field_obj = $this->get_primary_key_field();
2277
-        }
2278
-        $column_to_count = $field_obj->get_qualified_column();
2279
-        $SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2280
-        $return_value = $this->_do_wpdb_query('get_var', array($SQL));
2281
-        $data_type = $field_obj->get_wpdb_data_type();
2282
-        if ($data_type === '%d' || $data_type === '%s') {
2283
-            return (float)$return_value;
2284
-        }
2285
-        //must be %f
2286
-        return (float)$return_value;
2287
-    }
2288
-
2289
-
2290
-
2291
-    /**
2292
-     * Just calls the specified method on $wpdb with the given arguments
2293
-     * Consolidates a little extra error handling code
2294
-     *
2295
-     * @param string $wpdb_method
2296
-     * @param array  $arguments_to_provide
2297
-     * @throws EE_Error
2298
-     * @global wpdb  $wpdb
2299
-     * @return mixed
2300
-     */
2301
-    protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2302
-    {
2303
-        //if we're in maintenance mode level 2, DON'T run any queries
2304
-        //because level 2 indicates the database needs updating and
2305
-        //is probably out of sync with the code
2306
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2307
-            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.",
2308
-                "event_espresso")));
2309
-        }
2310
-        /** @type WPDB $wpdb */
2311
-        global $wpdb;
2312
-        if (! method_exists($wpdb, $wpdb_method)) {
2313
-            throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2314
-                'event_espresso'), $wpdb_method));
2315
-        }
2316
-        if (WP_DEBUG) {
2317
-            $old_show_errors_value = $wpdb->show_errors;
2318
-            $wpdb->show_errors(false);
2319
-        }
2320
-        $result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2321
-        $this->show_db_query_if_previously_requested($wpdb->last_query);
2322
-        if (WP_DEBUG) {
2323
-            $wpdb->show_errors($old_show_errors_value);
2324
-            if (! empty($wpdb->last_error)) {
2325
-                throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2326
-            }
2327
-            if ($result === false) {
2328
-                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"',
2329
-                    'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2330
-            }
2331
-        } elseif ($result === false) {
2332
-            EE_Error::add_error(
2333
-                sprintf(
2334
-                    __('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"',
2335
-                        'event_espresso'),
2336
-                    $wpdb_method,
2337
-                    var_export($arguments_to_provide, true),
2338
-                    $wpdb->last_error
2339
-                ),
2340
-                __FILE__,
2341
-                __FUNCTION__,
2342
-                __LINE__
2343
-            );
2344
-        }
2345
-        return $result;
2346
-    }
2347
-
2348
-
2349
-
2350
-    /**
2351
-     * Attempts to run the indicated WPDB method with the provided arguments,
2352
-     * and if there's an error tries to verify the DB is correct. Uses
2353
-     * the static property EEM_Base::$_db_verification_level to determine whether
2354
-     * we should try to fix the EE core db, the addons, or just give up
2355
-     *
2356
-     * @param string $wpdb_method
2357
-     * @param array  $arguments_to_provide
2358
-     * @return mixed
2359
-     */
2360
-    private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2361
-    {
2362
-        /** @type WPDB $wpdb */
2363
-        global $wpdb;
2364
-        $wpdb->last_error = null;
2365
-        $result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2366
-        // was there an error running the query? but we don't care on new activations
2367
-        // (we're going to setup the DB anyway on new activations)
2368
-        if (($result === false || ! empty($wpdb->last_error))
2369
-            && EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2370
-        ) {
2371
-            switch (EEM_Base::$_db_verification_level) {
2372
-                case EEM_Base::db_verified_none :
2373
-                    // let's double-check core's DB
2374
-                    $error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2375
-                    break;
2376
-                case EEM_Base::db_verified_core :
2377
-                    // STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2378
-                    $error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2379
-                    break;
2380
-                case EEM_Base::db_verified_addons :
2381
-                    // ummmm... you in trouble
2382
-                    return $result;
2383
-                    break;
2384
-            }
2385
-            if (! empty($error_message)) {
2386
-                EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2387
-                trigger_error($error_message);
2388
-            }
2389
-            return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2390
-        }
2391
-        return $result;
2392
-    }
2393
-
2394
-
2395
-
2396
-    /**
2397
-     * Verifies the EE core database is up-to-date and records that we've done it on
2398
-     * EEM_Base::$_db_verification_level
2399
-     *
2400
-     * @param string $wpdb_method
2401
-     * @param array  $arguments_to_provide
2402
-     * @return string
2403
-     */
2404
-    private function _verify_core_db($wpdb_method, $arguments_to_provide)
2405
-    {
2406
-        /** @type WPDB $wpdb */
2407
-        global $wpdb;
2408
-        //ok remember that we've already attempted fixing the core db, in case the problem persists
2409
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2410
-        $error_message = sprintf(
2411
-            __('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2412
-                'event_espresso'),
2413
-            $wpdb->last_error,
2414
-            $wpdb_method,
2415
-            wp_json_encode($arguments_to_provide)
2416
-        );
2417
-        EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2418
-        return $error_message;
2419
-    }
2420
-
2421
-
2422
-
2423
-    /**
2424
-     * Verifies the EE addons' database is up-to-date and records that we've done it on
2425
-     * EEM_Base::$_db_verification_level
2426
-     *
2427
-     * @param $wpdb_method
2428
-     * @param $arguments_to_provide
2429
-     * @return string
2430
-     */
2431
-    private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2432
-    {
2433
-        /** @type WPDB $wpdb */
2434
-        global $wpdb;
2435
-        //ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2436
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2437
-        $error_message = sprintf(
2438
-            __('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2439
-                'event_espresso'),
2440
-            $wpdb->last_error,
2441
-            $wpdb_method,
2442
-            wp_json_encode($arguments_to_provide)
2443
-        );
2444
-        EE_System::instance()->initialize_addons();
2445
-        return $error_message;
2446
-    }
2447
-
2448
-
2449
-
2450
-    /**
2451
-     * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2452
-     * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2453
-     * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2454
-     * ..."
2455
-     *
2456
-     * @param EE_Model_Query_Info_Carrier $model_query_info
2457
-     * @return string
2458
-     */
2459
-    private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2460
-    {
2461
-        return " FROM " . $model_query_info->get_full_join_sql() .
2462
-               $model_query_info->get_where_sql() .
2463
-               $model_query_info->get_group_by_sql() .
2464
-               $model_query_info->get_having_sql() .
2465
-               $model_query_info->get_order_by_sql() .
2466
-               $model_query_info->get_limit_sql();
2467
-    }
2468
-
2469
-
2470
-
2471
-    /**
2472
-     * Set to easily debug the next X queries ran from this model.
2473
-     *
2474
-     * @param int $count
2475
-     */
2476
-    public function show_next_x_db_queries($count = 1)
2477
-    {
2478
-        $this->_show_next_x_db_queries = $count;
2479
-    }
2480
-
2481
-
2482
-
2483
-    /**
2484
-     * @param $sql_query
2485
-     */
2486
-    public function show_db_query_if_previously_requested($sql_query)
2487
-    {
2488
-        if ($this->_show_next_x_db_queries > 0) {
2489
-            echo $sql_query;
2490
-            $this->_show_next_x_db_queries--;
2491
-        }
2492
-    }
2493
-
2494
-
2495
-
2496
-    /**
2497
-     * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2498
-     * There are the 3 cases:
2499
-     * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2500
-     * $otherModelObject has no ID, it is first saved.
2501
-     * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2502
-     * has no ID, it is first saved.
2503
-     * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2504
-     * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2505
-     * join table
2506
-     *
2507
-     * @param        EE_Base_Class                     /int $thisModelObject
2508
-     * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2509
-     * @param string $relationName                     , key in EEM_Base::_relations
2510
-     *                                                 an attendee to a group, you also want to specify which role they
2511
-     *                                                 will have in that group. So you would use this parameter to
2512
-     *                                                 specify array('role-column-name'=>'role-id')
2513
-     * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2514
-     *                                                 to for relation to methods that allow you to further specify
2515
-     *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2516
-     *                                                 only acceptable query_params is strict "col" => "value" pairs
2517
-     *                                                 because these will be inserted in any new rows created as well.
2518
-     * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2519
-     * @throws EE_Error
2520
-     */
2521
-    public function add_relationship_to(
2522
-        $id_or_obj,
2523
-        $other_model_id_or_obj,
2524
-        $relationName,
2525
-        $extra_join_model_fields_n_values = array()
2526
-    ) {
2527
-        $relation_obj = $this->related_settings_for($relationName);
2528
-        return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2529
-    }
2530
-
2531
-
2532
-
2533
-    /**
2534
-     * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2535
-     * There are the 3 cases:
2536
-     * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2537
-     * error
2538
-     * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2539
-     * an error
2540
-     * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2541
-     *
2542
-     * @param        EE_Base_Class /int $id_or_obj
2543
-     * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2544
-     * @param string $relationName key in EEM_Base::_relations
2545
-     * @return boolean of success
2546
-     * @throws EE_Error
2547
-     * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2548
-     *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2549
-     *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2550
-     *                             because these will be inserted in any new rows created as well.
2551
-     */
2552
-    public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2553
-    {
2554
-        $relation_obj = $this->related_settings_for($relationName);
2555
-        return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2556
-    }
2557
-
2558
-
2559
-
2560
-    /**
2561
-     * @param mixed           $id_or_obj
2562
-     * @param string          $relationName
2563
-     * @param array           $where_query_params
2564
-     * @param EE_Base_Class[] objects to which relations were removed
2565
-     * @return \EE_Base_Class[]
2566
-     * @throws EE_Error
2567
-     */
2568
-    public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2569
-    {
2570
-        $relation_obj = $this->related_settings_for($relationName);
2571
-        return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2572
-    }
2573
-
2574
-
2575
-
2576
-    /**
2577
-     * Gets all the related items of the specified $model_name, using $query_params.
2578
-     * Note: by default, we remove the "default query params"
2579
-     * because we want to get even deleted items etc.
2580
-     *
2581
-     * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2582
-     * @param string $model_name   like 'Event', 'Registration', etc. always singular
2583
-     * @param array  $query_params like EEM_Base::get_all
2584
-     * @return EE_Base_Class[]
2585
-     * @throws EE_Error
2586
-     */
2587
-    public function get_all_related($id_or_obj, $model_name, $query_params = null)
2588
-    {
2589
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2590
-        $relation_settings = $this->related_settings_for($model_name);
2591
-        return $relation_settings->get_all_related($model_obj, $query_params);
2592
-    }
2593
-
2594
-
2595
-
2596
-    /**
2597
-     * Deletes all the model objects across the relation indicated by $model_name
2598
-     * which are related to $id_or_obj which meet the criteria set in $query_params.
2599
-     * However, if the model objects can't be deleted because of blocking related model objects, then
2600
-     * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2601
-     *
2602
-     * @param EE_Base_Class|int|string $id_or_obj
2603
-     * @param string                   $model_name
2604
-     * @param array                    $query_params
2605
-     * @return int how many deleted
2606
-     * @throws EE_Error
2607
-     */
2608
-    public function delete_related($id_or_obj, $model_name, $query_params = array())
2609
-    {
2610
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2611
-        $relation_settings = $this->related_settings_for($model_name);
2612
-        return $relation_settings->delete_all_related($model_obj, $query_params);
2613
-    }
2614
-
2615
-
2616
-
2617
-    /**
2618
-     * Hard deletes all the model objects across the relation indicated by $model_name
2619
-     * which are related to $id_or_obj which meet the criteria set in $query_params. If
2620
-     * the model objects can't be hard deleted because of blocking related model objects,
2621
-     * just does a soft-delete on them instead.
2622
-     *
2623
-     * @param EE_Base_Class|int|string $id_or_obj
2624
-     * @param string                   $model_name
2625
-     * @param array                    $query_params
2626
-     * @return int how many deleted
2627
-     * @throws EE_Error
2628
-     */
2629
-    public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2630
-    {
2631
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2632
-        $relation_settings = $this->related_settings_for($model_name);
2633
-        return $relation_settings->delete_related_permanently($model_obj, $query_params);
2634
-    }
2635
-
2636
-
2637
-
2638
-    /**
2639
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2640
-     * unless otherwise specified in the $query_params
2641
-     *
2642
-     * @param        int             /EE_Base_Class $id_or_obj
2643
-     * @param string $model_name     like 'Event', or 'Registration'
2644
-     * @param array  $query_params   like EEM_Base::get_all's
2645
-     * @param string $field_to_count name of field to count by. By default, uses primary key
2646
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2647
-     *                               that by the setting $distinct to TRUE;
2648
-     * @return int
2649
-     * @throws EE_Error
2650
-     */
2651
-    public function count_related(
2652
-        $id_or_obj,
2653
-        $model_name,
2654
-        $query_params = array(),
2655
-        $field_to_count = null,
2656
-        $distinct = false
2657
-    ) {
2658
-        $related_model = $this->get_related_model_obj($model_name);
2659
-        //we're just going to use the query params on the related model's normal get_all query,
2660
-        //except add a condition to say to match the current mod
2661
-        if (! isset($query_params['default_where_conditions'])) {
2662
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2663
-        }
2664
-        $this_model_name = $this->get_this_model_name();
2665
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2666
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2667
-        return $related_model->count($query_params, $field_to_count, $distinct);
2668
-    }
2669
-
2670
-
2671
-
2672
-    /**
2673
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
2674
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2675
-     *
2676
-     * @param        int           /EE_Base_Class $id_or_obj
2677
-     * @param string $model_name   like 'Event', or 'Registration'
2678
-     * @param array  $query_params like EEM_Base::get_all's
2679
-     * @param string $field_to_sum name of field to count by. By default, uses primary key
2680
-     * @return float
2681
-     * @throws EE_Error
2682
-     */
2683
-    public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2684
-    {
2685
-        $related_model = $this->get_related_model_obj($model_name);
2686
-        if (! is_array($query_params)) {
2687
-            EE_Error::doing_it_wrong('EEM_Base::sum_related',
2688
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2689
-                    gettype($query_params)), '4.6.0');
2690
-            $query_params = array();
2691
-        }
2692
-        //we're just going to use the query params on the related model's normal get_all query,
2693
-        //except add a condition to say to match the current mod
2694
-        if (! isset($query_params['default_where_conditions'])) {
2695
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2696
-        }
2697
-        $this_model_name = $this->get_this_model_name();
2698
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2699
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2700
-        return $related_model->sum($query_params, $field_to_sum);
2701
-    }
2702
-
2703
-
2704
-
2705
-    /**
2706
-     * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2707
-     * $modelObject
2708
-     *
2709
-     * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2710
-     * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2711
-     * @param array               $query_params     like EEM_Base::get_all's
2712
-     * @return EE_Base_Class
2713
-     * @throws EE_Error
2714
-     */
2715
-    public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2716
-    {
2717
-        $query_params['limit'] = 1;
2718
-        $results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2719
-        if ($results) {
2720
-            return array_shift($results);
2721
-        }
2722
-        return null;
2723
-    }
2724
-
2725
-
2726
-
2727
-    /**
2728
-     * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2729
-     *
2730
-     * @return string
2731
-     */
2732
-    public function get_this_model_name()
2733
-    {
2734
-        return str_replace("EEM_", "", get_class($this));
2735
-    }
2736
-
2737
-
2738
-
2739
-    /**
2740
-     * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2741
-     *
2742
-     * @return EE_Any_Foreign_Model_Name_Field
2743
-     * @throws EE_Error
2744
-     */
2745
-    public function get_field_containing_related_model_name()
2746
-    {
2747
-        foreach ($this->field_settings(true) as $field) {
2748
-            if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2749
-                $field_with_model_name = $field;
2750
-            }
2751
-        }
2752
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
2753
-            throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2754
-                $this->get_this_model_name()));
2755
-        }
2756
-        return $field_with_model_name;
2757
-    }
2758
-
2759
-
2760
-
2761
-    /**
2762
-     * Inserts a new entry into the database, for each table.
2763
-     * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2764
-     * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2765
-     * we also know there is no model object with the newly inserted item's ID at the moment (because
2766
-     * if there were, then they would already be in the DB and this would fail); and in the future if someone
2767
-     * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2768
-     * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2769
-     *
2770
-     * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2771
-     *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2772
-     *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2773
-     *                              of EEM_Base)
2774
-     * @return int new primary key on main table that got inserted
2775
-     * @throws EE_Error
2776
-     */
2777
-    public function insert($field_n_values)
2778
-    {
2779
-        /**
2780
-         * Filters the fields and their values before inserting an item using the models
2781
-         *
2782
-         * @param array    $fields_n_values keys are the fields and values are their new values
2783
-         * @param EEM_Base $model           the model used
2784
-         */
2785
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2786
-        if ($this->_satisfies_unique_indexes($field_n_values)) {
2787
-            $main_table = $this->_get_main_table();
2788
-            $new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2789
-            if ($new_id !== false) {
2790
-                foreach ($this->_get_other_tables() as $other_table) {
2791
-                    $this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2792
-                }
2793
-            }
2794
-            /**
2795
-             * Done just after attempting to insert a new model object
2796
-             *
2797
-             * @param EEM_Base   $model           used
2798
-             * @param array      $fields_n_values fields and their values
2799
-             * @param int|string the              ID of the newly-inserted model object
2800
-             */
2801
-            do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2802
-            return $new_id;
2803
-        }
2804
-        return false;
2805
-    }
2806
-
2807
-
2808
-
2809
-    /**
2810
-     * Checks that the result would satisfy the unique indexes on this model
2811
-     *
2812
-     * @param array  $field_n_values
2813
-     * @param string $action
2814
-     * @return boolean
2815
-     * @throws EE_Error
2816
-     */
2817
-    protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2818
-    {
2819
-        foreach ($this->unique_indexes() as $index_name => $index) {
2820
-            $uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2821
-            if ($this->exists(array($uniqueness_where_params))) {
2822
-                EE_Error::add_error(
2823
-                    sprintf(
2824
-                        __(
2825
-                            "Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2826
-                            "event_espresso"
2827
-                        ),
2828
-                        $action,
2829
-                        $this->_get_class_name(),
2830
-                        $index_name,
2831
-                        implode(",", $index->field_names()),
2832
-                        http_build_query($uniqueness_where_params)
2833
-                    ),
2834
-                    __FILE__,
2835
-                    __FUNCTION__,
2836
-                    __LINE__
2837
-                );
2838
-                return false;
2839
-            }
2840
-        }
2841
-        return true;
2842
-    }
2843
-
2844
-
2845
-
2846
-    /**
2847
-     * Checks the database for an item that conflicts (ie, if this item were
2848
-     * saved to the DB would break some uniqueness requirement, like a primary key
2849
-     * or an index primary key set) with the item specified. $id_obj_or_fields_array
2850
-     * can be either an EE_Base_Class or an array of fields n values
2851
-     *
2852
-     * @param EE_Base_Class|array $obj_or_fields_array
2853
-     * @param boolean             $include_primary_key whether to use the model object's primary key
2854
-     *                                                 when looking for conflicts
2855
-     *                                                 (ie, if false, we ignore the model object's primary key
2856
-     *                                                 when finding "conflicts". If true, it's also considered).
2857
-     *                                                 Only works for INT primary key,
2858
-     *                                                 STRING primary keys cannot be ignored
2859
-     * @throws EE_Error
2860
-     * @return EE_Base_Class|array
2861
-     */
2862
-    public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2863
-    {
2864
-        if ($obj_or_fields_array instanceof EE_Base_Class) {
2865
-            $fields_n_values = $obj_or_fields_array->model_field_array();
2866
-        } elseif (is_array($obj_or_fields_array)) {
2867
-            $fields_n_values = $obj_or_fields_array;
2868
-        } else {
2869
-            throw new EE_Error(
2870
-                sprintf(
2871
-                    __(
2872
-                        "%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2873
-                        "event_espresso"
2874
-                    ),
2875
-                    get_class($this),
2876
-                    $obj_or_fields_array
2877
-                )
2878
-            );
2879
-        }
2880
-        $query_params = array();
2881
-        if ($this->has_primary_key_field()
2882
-            && ($include_primary_key
2883
-                || $this->get_primary_key_field()
2884
-                   instanceof
2885
-                   EE_Primary_Key_String_Field)
2886
-            && isset($fields_n_values[$this->primary_key_name()])
2887
-        ) {
2888
-            $query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2889
-        }
2890
-        foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2891
-            $uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2892
-            $query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2893
-        }
2894
-        //if there is nothing to base this search on, then we shouldn't find anything
2895
-        if (empty($query_params)) {
2896
-            return array();
2897
-        }
2898
-        return $this->get_one($query_params);
2899
-    }
2900
-
2901
-
2902
-
2903
-    /**
2904
-     * Like count, but is optimized and returns a boolean instead of an int
2905
-     *
2906
-     * @param array $query_params
2907
-     * @return boolean
2908
-     * @throws EE_Error
2909
-     */
2910
-    public function exists($query_params)
2911
-    {
2912
-        $query_params['limit'] = 1;
2913
-        return $this->count($query_params) > 0;
2914
-    }
2915
-
2916
-
2917
-
2918
-    /**
2919
-     * Wrapper for exists, except ignores default query parameters so we're only considering ID
2920
-     *
2921
-     * @param int|string $id
2922
-     * @return boolean
2923
-     * @throws EE_Error
2924
-     */
2925
-    public function exists_by_ID($id)
2926
-    {
2927
-        return $this->exists(
2928
-            array(
2929
-                'default_where_conditions' => EEM_Base::default_where_conditions_none,
2930
-                array(
2931
-                    $this->primary_key_name() => $id,
2932
-                ),
2933
-            )
2934
-        );
2935
-    }
2936
-
2937
-
2938
-
2939
-    /**
2940
-     * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2941
-     * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2942
-     * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2943
-     * on the main table)
2944
-     * This is protected rather than private because private is not accessible to any child methods and there MAY be
2945
-     * cases where we want to call it directly rather than via insert().
2946
-     *
2947
-     * @access   protected
2948
-     * @param EE_Table_Base $table
2949
-     * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2950
-     *                                       float
2951
-     * @param int           $new_id          for now we assume only int keys
2952
-     * @throws EE_Error
2953
-     * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2954
-     * @return int ID of new row inserted, or FALSE on failure
2955
-     */
2956
-    protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2957
-    {
2958
-        global $wpdb;
2959
-        $insertion_col_n_values = array();
2960
-        $format_for_insertion = array();
2961
-        $fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2962
-        foreach ($fields_on_table as $field_name => $field_obj) {
2963
-            //check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2964
-            if ($field_obj->is_auto_increment()) {
2965
-                continue;
2966
-            }
2967
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2968
-            //if the value we want to assign it to is NULL, just don't mention it for the insertion
2969
-            if ($prepared_value !== null) {
2970
-                $insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2971
-                $format_for_insertion[] = $field_obj->get_wpdb_data_type();
2972
-            }
2973
-        }
2974
-        if ($table instanceof EE_Secondary_Table && $new_id) {
2975
-            //its not the main table, so we should have already saved the main table's PK which we just inserted
2976
-            //so add the fk to the main table as a column
2977
-            $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2978
-            $format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2979
-        }
2980
-        //insert the new entry
2981
-        $result = $this->_do_wpdb_query('insert',
2982
-            array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2983
-        if ($result === false) {
2984
-            return false;
2985
-        }
2986
-        //ok, now what do we return for the ID of the newly-inserted thing?
2987
-        if ($this->has_primary_key_field()) {
2988
-            if ($this->get_primary_key_field()->is_auto_increment()) {
2989
-                return $wpdb->insert_id;
2990
-            }
2991
-            //it's not an auto-increment primary key, so
2992
-            //it must have been supplied
2993
-            return $fields_n_values[$this->get_primary_key_field()->get_name()];
2994
-        }
2995
-        //we can't return a  primary key because there is none. instead return
2996
-        //a unique string indicating this model
2997
-        return $this->get_index_primary_key_string($fields_n_values);
2998
-    }
2999
-
3000
-
3001
-
3002
-    /**
3003
-     * Prepare the $field_obj 's value in $fields_n_values for use in the database.
3004
-     * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
3005
-     * and there is no default, we pass it along. WPDB will take care of it)
3006
-     *
3007
-     * @param EE_Model_Field_Base $field_obj
3008
-     * @param array               $fields_n_values
3009
-     * @return mixed string|int|float depending on what the table column will be expecting
3010
-     * @throws EE_Error
3011
-     */
3012
-    protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
3013
-    {
3014
-        //if this field doesn't allow nullable, don't allow it
3015
-        if (
3016
-            ! $field_obj->is_nullable()
3017
-            && (
3018
-                ! isset($fields_n_values[$field_obj->get_name()])
3019
-                || $fields_n_values[$field_obj->get_name()] === null
3020
-            )
3021
-        ) {
3022
-            $fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
3023
-        }
3024
-        $unprepared_value = isset($fields_n_values[$field_obj->get_name()])
3025
-            ? $fields_n_values[$field_obj->get_name()]
3026
-            : null;
3027
-        return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
3028
-    }
3029
-
3030
-
3031
-
3032
-    /**
3033
-     * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
3034
-     * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
3035
-     * the field's prepare_for_set() method.
3036
-     *
3037
-     * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
3038
-     *                                   false, otherwise a value in the model object's domain (see lengthy comment at
3039
-     *                                   top of file)
3040
-     * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
3041
-     *                                   $value is a custom selection
3042
-     * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
3043
-     */
3044
-    private function _prepare_value_for_use_in_db($value, $field)
3045
-    {
3046
-        if ($field && $field instanceof EE_Model_Field_Base) {
3047
-            switch ($this->_values_already_prepared_by_model_object) {
3048
-                /** @noinspection PhpMissingBreakStatementInspection */
3049
-                case self::not_prepared_by_model_object:
3050
-                    $value = $field->prepare_for_set($value);
3051
-                //purposefully left out "return"
3052
-                case self::prepared_by_model_object:
3053
-                    /** @noinspection SuspiciousAssignmentsInspection */
3054
-                    $value = $field->prepare_for_use_in_db($value);
3055
-                case self::prepared_for_use_in_db:
3056
-                    //leave the value alone
3057
-            }
3058
-            return $value;
3059
-        }
3060
-        return $value;
3061
-    }
3062
-
3063
-
3064
-
3065
-    /**
3066
-     * Returns the main table on this model
3067
-     *
3068
-     * @return EE_Primary_Table
3069
-     * @throws EE_Error
3070
-     */
3071
-    protected function _get_main_table()
3072
-    {
3073
-        foreach ($this->_tables as $table) {
3074
-            if ($table instanceof EE_Primary_Table) {
3075
-                return $table;
3076
-            }
3077
-        }
3078
-        throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
3079
-            'event_espresso'), get_class($this)));
3080
-    }
3081
-
3082
-
3083
-
3084
-    /**
3085
-     * table
3086
-     * returns EE_Primary_Table table name
3087
-     *
3088
-     * @return string
3089
-     * @throws EE_Error
3090
-     */
3091
-    public function table()
3092
-    {
3093
-        return $this->_get_main_table()->get_table_name();
3094
-    }
3095
-
3096
-
3097
-
3098
-    /**
3099
-     * table
3100
-     * returns first EE_Secondary_Table table name
3101
-     *
3102
-     * @return string
3103
-     */
3104
-    public function second_table()
3105
-    {
3106
-        // grab second table from tables array
3107
-        $second_table = end($this->_tables);
3108
-        return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
3109
-    }
3110
-
3111
-
3112
-
3113
-    /**
3114
-     * get_table_obj_by_alias
3115
-     * returns table name given it's alias
3116
-     *
3117
-     * @param string $table_alias
3118
-     * @return EE_Primary_Table | EE_Secondary_Table
3119
-     */
3120
-    public function get_table_obj_by_alias($table_alias = '')
3121
-    {
3122
-        return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
3123
-    }
3124
-
3125
-
3126
-
3127
-    /**
3128
-     * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
3129
-     *
3130
-     * @return EE_Secondary_Table[]
3131
-     */
3132
-    protected function _get_other_tables()
3133
-    {
3134
-        $other_tables = array();
3135
-        foreach ($this->_tables as $table_alias => $table) {
3136
-            if ($table instanceof EE_Secondary_Table) {
3137
-                $other_tables[$table_alias] = $table;
3138
-            }
3139
-        }
3140
-        return $other_tables;
3141
-    }
3142
-
3143
-
3144
-
3145
-    /**
3146
-     * Finds all the fields that correspond to the given table
3147
-     *
3148
-     * @param string $table_alias , array key in EEM_Base::_tables
3149
-     * @return EE_Model_Field_Base[]
3150
-     */
3151
-    public function _get_fields_for_table($table_alias)
3152
-    {
3153
-        return $this->_fields[$table_alias];
3154
-    }
3155
-
3156
-
3157
-
3158
-    /**
3159
-     * Recurses through all the where parameters, and finds all the related models we'll need
3160
-     * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
3161
-     * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
3162
-     * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
3163
-     * related Registration, Transaction, and Payment models.
3164
-     *
3165
-     * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
3166
-     * @return EE_Model_Query_Info_Carrier
3167
-     * @throws EE_Error
3168
-     */
3169
-    public function _extract_related_models_from_query($query_params)
3170
-    {
3171
-        $query_info_carrier = new EE_Model_Query_Info_Carrier();
3172
-        if (array_key_exists(0, $query_params)) {
3173
-            $this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
3174
-        }
3175
-        if (array_key_exists('group_by', $query_params)) {
3176
-            if (is_array($query_params['group_by'])) {
3177
-                $this->_extract_related_models_from_sub_params_array_values(
3178
-                    $query_params['group_by'],
3179
-                    $query_info_carrier,
3180
-                    'group_by'
3181
-                );
3182
-            } elseif (! empty ($query_params['group_by'])) {
3183
-                $this->_extract_related_model_info_from_query_param(
3184
-                    $query_params['group_by'],
3185
-                    $query_info_carrier,
3186
-                    'group_by'
3187
-                );
3188
-            }
3189
-        }
3190
-        if (array_key_exists('having', $query_params)) {
3191
-            $this->_extract_related_models_from_sub_params_array_keys(
3192
-                $query_params[0],
3193
-                $query_info_carrier,
3194
-                'having'
3195
-            );
3196
-        }
3197
-        if (array_key_exists('order_by', $query_params)) {
3198
-            if (is_array($query_params['order_by'])) {
3199
-                $this->_extract_related_models_from_sub_params_array_keys(
3200
-                    $query_params['order_by'],
3201
-                    $query_info_carrier,
3202
-                    'order_by'
3203
-                );
3204
-            } elseif (! empty($query_params['order_by'])) {
3205
-                $this->_extract_related_model_info_from_query_param(
3206
-                    $query_params['order_by'],
3207
-                    $query_info_carrier,
3208
-                    'order_by'
3209
-                );
3210
-            }
3211
-        }
3212
-        if (array_key_exists('force_join', $query_params)) {
3213
-            $this->_extract_related_models_from_sub_params_array_values(
3214
-                $query_params['force_join'],
3215
-                $query_info_carrier,
3216
-                'force_join'
3217
-            );
3218
-        }
3219
-        return $query_info_carrier;
3220
-    }
3221
-
3222
-
3223
-
3224
-    /**
3225
-     * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
3226
-     *
3227
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3228
-     *                                                      $query_params['having']
3229
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3230
-     * @param string                      $query_param_type one of $this->_allowed_query_params
3231
-     * @throws EE_Error
3232
-     * @return \EE_Model_Query_Info_Carrier
3233
-     */
3234
-    private function _extract_related_models_from_sub_params_array_keys(
3235
-        $sub_query_params,
3236
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3237
-        $query_param_type
3238
-    ) {
3239
-        if (! empty($sub_query_params)) {
3240
-            $sub_query_params = (array)$sub_query_params;
3241
-            foreach ($sub_query_params as $param => $possibly_array_of_params) {
3242
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3243
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3244
-                    $query_param_type);
3245
-                //if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3246
-                //indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3247
-                //extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3248
-                //of array('Registration.TXN_ID'=>23)
3249
-                $query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3250
-                if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3251
-                    if (! is_array($possibly_array_of_params)) {
3252
-                        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'))",
3253
-                            "event_espresso"),
3254
-                            $param, $possibly_array_of_params));
3255
-                    }
3256
-                    $this->_extract_related_models_from_sub_params_array_keys(
3257
-                        $possibly_array_of_params,
3258
-                        $model_query_info_carrier, $query_param_type
3259
-                    );
3260
-                } elseif ($query_param_type === 0 //ie WHERE
3261
-                          && is_array($possibly_array_of_params)
3262
-                          && isset($possibly_array_of_params[2])
3263
-                          && $possibly_array_of_params[2] == true
3264
-                ) {
3265
-                    //then $possible_array_of_params looks something like array('<','DTT_sold',true)
3266
-                    //indicating that $possible_array_of_params[1] is actually a field name,
3267
-                    //from which we should extract query parameters!
3268
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3269
-                        throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3270
-                            "event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3271
-                    }
3272
-                    $this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3273
-                        $model_query_info_carrier, $query_param_type);
3274
-                }
3275
-            }
3276
-        }
3277
-        return $model_query_info_carrier;
3278
-    }
3279
-
3280
-
3281
-
3282
-    /**
3283
-     * For extracting related models from forced_joins, where the array values contain the info about what
3284
-     * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3285
-     *
3286
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3287
-     *                                                      $query_params['having']
3288
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3289
-     * @param string                      $query_param_type one of $this->_allowed_query_params
3290
-     * @throws EE_Error
3291
-     * @return \EE_Model_Query_Info_Carrier
3292
-     */
3293
-    private function _extract_related_models_from_sub_params_array_values(
3294
-        $sub_query_params,
3295
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3296
-        $query_param_type
3297
-    ) {
3298
-        if (! empty($sub_query_params)) {
3299
-            if (! is_array($sub_query_params)) {
3300
-                throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3301
-                    $sub_query_params));
3302
-            }
3303
-            foreach ($sub_query_params as $param) {
3304
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3305
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3306
-                    $query_param_type);
3307
-            }
3308
-        }
3309
-        return $model_query_info_carrier;
3310
-    }
3311
-
3312
-
3313
-
3314
-    /**
3315
-     * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3316
-     * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3317
-     * instead of directly constructing the SQL because often we need to extract info from the $query_params
3318
-     * but use them in a different order. Eg, we need to know what models we are querying
3319
-     * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3320
-     * other models before we can finalize the where clause SQL.
3321
-     *
3322
-     * @param array $query_params
3323
-     * @throws EE_Error
3324
-     * @return EE_Model_Query_Info_Carrier
3325
-     */
3326
-    public function _create_model_query_info_carrier($query_params)
3327
-    {
3328
-        if (! is_array($query_params)) {
3329
-            EE_Error::doing_it_wrong(
3330
-                'EEM_Base::_create_model_query_info_carrier',
3331
-                sprintf(
3332
-                    __(
3333
-                        '$query_params should be an array, you passed a variable of type %s',
3334
-                        'event_espresso'
3335
-                    ),
3336
-                    gettype($query_params)
3337
-                ),
3338
-                '4.6.0'
3339
-            );
3340
-            $query_params = array();
3341
-        }
3342
-        $where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3343
-        //first check if we should alter the query to account for caps or not
3344
-        //because the caps might require us to do extra joins
3345
-        if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3346
-            $query_params[0] = $where_query_params = array_replace_recursive(
3347
-                $where_query_params,
3348
-                $this->caps_where_conditions(
3349
-                    $query_params['caps']
3350
-                )
3351
-            );
3352
-        }
3353
-        $query_object = $this->_extract_related_models_from_query($query_params);
3354
-        //verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3355
-        foreach ($where_query_params as $key => $value) {
3356
-            if (is_int($key)) {
3357
-                throw new EE_Error(
3358
-                    sprintf(
3359
-                        __(
3360
-                            "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.",
3361
-                            "event_espresso"
3362
-                        ),
3363
-                        $key,
3364
-                        var_export($value, true),
3365
-                        var_export($query_params, true),
3366
-                        get_class($this)
3367
-                    )
3368
-                );
3369
-            }
3370
-        }
3371
-        if (
3372
-            array_key_exists('default_where_conditions', $query_params)
3373
-            && ! empty($query_params['default_where_conditions'])
3374
-        ) {
3375
-            $use_default_where_conditions = $query_params['default_where_conditions'];
3376
-        } else {
3377
-            $use_default_where_conditions = EEM_Base::default_where_conditions_all;
3378
-        }
3379
-        $where_query_params = array_merge(
3380
-            $this->_get_default_where_conditions_for_models_in_query(
3381
-                $query_object,
3382
-                $use_default_where_conditions,
3383
-                $where_query_params
3384
-            ),
3385
-            $where_query_params
3386
-        );
3387
-        $query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3388
-        // if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3389
-        // So we need to setup a subquery and use that for the main join.
3390
-        // Note for now this only works on the primary table for the model.
3391
-        // So for instance, you could set the limit array like this:
3392
-        // array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3393
-        if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3394
-            $query_object->set_main_model_join_sql(
3395
-                $this->_construct_limit_join_select(
3396
-                    $query_params['on_join_limit'][0],
3397
-                    $query_params['on_join_limit'][1]
3398
-                )
3399
-            );
3400
-        }
3401
-        //set limit
3402
-        if (array_key_exists('limit', $query_params)) {
3403
-            if (is_array($query_params['limit'])) {
3404
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3405
-                    $e = sprintf(
3406
-                        __(
3407
-                            "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)",
3408
-                            "event_espresso"
3409
-                        ),
3410
-                        http_build_query($query_params['limit'])
3411
-                    );
3412
-                    throw new EE_Error($e . "|" . $e);
3413
-                }
3414
-                //they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3415
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3416
-            } elseif (! empty ($query_params['limit'])) {
3417
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3418
-            }
3419
-        }
3420
-        //set order by
3421
-        if (array_key_exists('order_by', $query_params)) {
3422
-            if (is_array($query_params['order_by'])) {
3423
-                //if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3424
-                //specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3425
-                //including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3426
-                if (array_key_exists('order', $query_params)) {
3427
-                    throw new EE_Error(
3428
-                        sprintf(
3429
-                            __(
3430
-                                "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 ",
3431
-                                "event_espresso"
3432
-                            ),
3433
-                            get_class($this),
3434
-                            implode(", ", array_keys($query_params['order_by'])),
3435
-                            implode(", ", $query_params['order_by']),
3436
-                            $query_params['order']
3437
-                        )
3438
-                    );
3439
-                }
3440
-                $this->_extract_related_models_from_sub_params_array_keys(
3441
-                    $query_params['order_by'],
3442
-                    $query_object,
3443
-                    'order_by'
3444
-                );
3445
-                //assume it's an array of fields to order by
3446
-                $order_array = array();
3447
-                foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3448
-                    $order = $this->_extract_order($order);
3449
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3450
-                }
3451
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3452
-            } elseif (! empty ($query_params['order_by'])) {
3453
-                $this->_extract_related_model_info_from_query_param(
3454
-                    $query_params['order_by'],
3455
-                    $query_object,
3456
-                    'order',
3457
-                    $query_params['order_by']
3458
-                );
3459
-                $order = isset($query_params['order'])
3460
-                    ? $this->_extract_order($query_params['order'])
3461
-                    : 'DESC';
3462
-                $query_object->set_order_by_sql(
3463
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3464
-                );
3465
-            }
3466
-        }
3467
-        //if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3468
-        if (! array_key_exists('order_by', $query_params)
3469
-            && array_key_exists('order', $query_params)
3470
-            && ! empty($query_params['order'])
3471
-        ) {
3472
-            $pk_field = $this->get_primary_key_field();
3473
-            $order = $this->_extract_order($query_params['order']);
3474
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3475
-        }
3476
-        //set group by
3477
-        if (array_key_exists('group_by', $query_params)) {
3478
-            if (is_array($query_params['group_by'])) {
3479
-                //it's an array, so assume we'll be grouping by a bunch of stuff
3480
-                $group_by_array = array();
3481
-                foreach ($query_params['group_by'] as $field_name_to_group_by) {
3482
-                    $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3483
-                }
3484
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3485
-            } elseif (! empty ($query_params['group_by'])) {
3486
-                $query_object->set_group_by_sql(
3487
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3488
-                );
3489
-            }
3490
-        }
3491
-        //set having
3492
-        if (array_key_exists('having', $query_params) && $query_params['having']) {
3493
-            $query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3494
-        }
3495
-        //now, just verify they didn't pass anything wack
3496
-        foreach ($query_params as $query_key => $query_value) {
3497
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
3498
-                throw new EE_Error(
3499
-                    sprintf(
3500
-                        __(
3501
-                            "You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3502
-                            'event_espresso'
3503
-                        ),
3504
-                        $query_key,
3505
-                        get_class($this),
3506
-                        //						print_r( $this->_allowed_query_params, TRUE )
3507
-                        implode(',', $this->_allowed_query_params)
3508
-                    )
3509
-                );
3510
-            }
3511
-        }
3512
-        $main_model_join_sql = $query_object->get_main_model_join_sql();
3513
-        if (empty($main_model_join_sql)) {
3514
-            $query_object->set_main_model_join_sql($this->_construct_internal_join());
3515
-        }
3516
-        return $query_object;
3517
-    }
3518
-
3519
-
3520
-
3521
-    /**
3522
-     * Gets the where conditions that should be imposed on the query based on the
3523
-     * context (eg reading frontend, backend, edit or delete).
3524
-     *
3525
-     * @param string $context one of EEM_Base::valid_cap_contexts()
3526
-     * @return array like EEM_Base::get_all() 's $query_params[0]
3527
-     * @throws EE_Error
3528
-     */
3529
-    public function caps_where_conditions($context = self::caps_read)
3530
-    {
3531
-        EEM_Base::verify_is_valid_cap_context($context);
3532
-        $cap_where_conditions = array();
3533
-        $cap_restrictions = $this->caps_missing($context);
3534
-        /**
3535
-         * @var $cap_restrictions EE_Default_Where_Conditions[]
3536
-         */
3537
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3538
-            $cap_where_conditions = array_replace_recursive($cap_where_conditions,
3539
-                $restriction_if_no_cap->get_default_where_conditions());
3540
-        }
3541
-        return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3542
-            $cap_restrictions);
3543
-    }
3544
-
3545
-
3546
-
3547
-    /**
3548
-     * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3549
-     * otherwise throws an exception
3550
-     *
3551
-     * @param string $should_be_order_string
3552
-     * @return string either ASC, asc, DESC or desc
3553
-     * @throws EE_Error
3554
-     */
3555
-    private function _extract_order($should_be_order_string)
3556
-    {
3557
-        if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3558
-            return $should_be_order_string;
3559
-        }
3560
-        throw new EE_Error(
3561
-            sprintf(
3562
-                __(
3563
-                    "While performing a query on '%s', tried to use '%s' as an order parameter. ",
3564
-                    "event_espresso"
3565
-                ), get_class($this), $should_be_order_string
3566
-            )
3567
-        );
3568
-    }
3569
-
3570
-
3571
-
3572
-    /**
3573
-     * Looks at all the models which are included in this query, and asks each
3574
-     * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3575
-     * so they can be merged
3576
-     *
3577
-     * @param EE_Model_Query_Info_Carrier $query_info_carrier
3578
-     * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3579
-     *                                                                  'none' means NO default where conditions will
3580
-     *                                                                  be used AT ALL during this query.
3581
-     *                                                                  'other_models_only' means default where
3582
-     *                                                                  conditions from other models will be used, but
3583
-     *                                                                  not for this primary model. 'all', the default,
3584
-     *                                                                  means default where conditions will apply as
3585
-     *                                                                  normal
3586
-     * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3587
-     * @throws EE_Error
3588
-     * @return array like $query_params[0], see EEM_Base::get_all for documentation
3589
-     */
3590
-    private function _get_default_where_conditions_for_models_in_query(
3591
-        EE_Model_Query_Info_Carrier $query_info_carrier,
3592
-        $use_default_where_conditions = EEM_Base::default_where_conditions_all,
3593
-        $where_query_params = array()
3594
-    ) {
3595
-        $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3596
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3597
-            throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3598
-                "event_espresso"), $use_default_where_conditions,
3599
-                implode(", ", $allowed_used_default_where_conditions_values)));
3600
-        }
3601
-        $universal_query_params = array();
3602
-        if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3603
-            $universal_query_params = $this->_get_default_where_conditions();
3604
-        } else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3605
-            $universal_query_params = $this->_get_minimum_where_conditions();
3606
-        }
3607
-        foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3608
-            $related_model = $this->get_related_model_obj($model_name);
3609
-            if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3610
-                $related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3611
-            } elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3612
-                $related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3613
-            } else {
3614
-                //we don't want to add full or even minimum default where conditions from this model, so just continue
3615
-                continue;
3616
-            }
3617
-            $overrides = $this->_override_defaults_or_make_null_friendly(
3618
-                $related_model_universal_where_params,
3619
-                $where_query_params,
3620
-                $related_model,
3621
-                $model_relation_path
3622
-            );
3623
-            $universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3624
-                $universal_query_params,
3625
-                $overrides
3626
-            );
3627
-        }
3628
-        return $universal_query_params;
3629
-    }
3630
-
3631
-
3632
-
3633
-    /**
3634
-     * Determines whether or not we should use default where conditions for the model in question
3635
-     * (this model, or other related models).
3636
-     * Basically, we should use default where conditions on this model if they have requested to use them on all models,
3637
-     * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3638
-     * We should use default where conditions on related models when they requested to use default where conditions
3639
-     * on all models, or specifically just on other related models
3640
-     * @param      $default_where_conditions_value
3641
-     * @param bool $for_this_model false means this is for OTHER related models
3642
-     * @return bool
3643
-     */
3644
-    private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3645
-    {
3646
-        return (
3647
-                   $for_this_model
3648
-                   && in_array(
3649
-                       $default_where_conditions_value,
3650
-                       array(
3651
-                           EEM_Base::default_where_conditions_all,
3652
-                           EEM_Base::default_where_conditions_this_only,
3653
-                           EEM_Base::default_where_conditions_minimum_others,
3654
-                       ),
3655
-                       true
3656
-                   )
3657
-               )
3658
-               || (
3659
-                   ! $for_this_model
3660
-                   && in_array(
3661
-                       $default_where_conditions_value,
3662
-                       array(
3663
-                           EEM_Base::default_where_conditions_all,
3664
-                           EEM_Base::default_where_conditions_others_only,
3665
-                       ),
3666
-                       true
3667
-                   )
3668
-               );
3669
-    }
3670
-
3671
-    /**
3672
-     * Determines whether or not we should use default minimum conditions for the model in question
3673
-     * (this model, or other related models).
3674
-     * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
3675
-     * where conditions.
3676
-     * We should use minimum where conditions on related models if they requested to use minimum where conditions
3677
-     * on this model or others
3678
-     * @param      $default_where_conditions_value
3679
-     * @param bool $for_this_model false means this is for OTHER related models
3680
-     * @return bool
3681
-     */
3682
-    private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
3683
-    {
3684
-        return (
3685
-                   $for_this_model
3686
-                   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
3687
-               )
3688
-               || (
3689
-                   ! $for_this_model
3690
-                   && in_array(
3691
-                       $default_where_conditions_value,
3692
-                       array(
3693
-                           EEM_Base::default_where_conditions_minimum_others,
3694
-                           EEM_Base::default_where_conditions_minimum_all,
3695
-                       ),
3696
-                       true
3697
-                   )
3698
-               );
3699
-    }
3700
-
3701
-
3702
-    /**
3703
-     * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3704
-     * then we also add a special where condition which allows for that model's primary key
3705
-     * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3706
-     * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3707
-     *
3708
-     * @param array    $default_where_conditions
3709
-     * @param array    $provided_where_conditions
3710
-     * @param EEM_Base $model
3711
-     * @param string   $model_relation_path like 'Transaction.Payment.'
3712
-     * @return array like EEM_Base::get_all's $query_params[0]
3713
-     * @throws EE_Error
3714
-     */
3715
-    private function _override_defaults_or_make_null_friendly(
3716
-        $default_where_conditions,
3717
-        $provided_where_conditions,
3718
-        $model,
3719
-        $model_relation_path
3720
-    ) {
3721
-        $null_friendly_where_conditions = array();
3722
-        $none_overridden = true;
3723
-        $or_condition_key_for_defaults = 'OR*' . get_class($model);
3724
-        foreach ($default_where_conditions as $key => $val) {
3725
-            if (isset($provided_where_conditions[$key])) {
3726
-                $none_overridden = false;
3727
-            } else {
3728
-                $null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3729
-            }
3730
-        }
3731
-        if ($none_overridden && $default_where_conditions) {
3732
-            if ($model->has_primary_key_field()) {
3733
-                $null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3734
-                                                                                . "."
3735
-                                                                                . $model->primary_key_name()] = array('IS NULL');
3736
-            }/*else{
2219
+	/**
2220
+	 * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
2221
+	 * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
2222
+	 * column
2223
+	 *
2224
+	 * @param array  $query_params   like EEM_Base::get_all's
2225
+	 * @param string $field_to_count field on model to count by (not column name)
2226
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2227
+	 *                               that by the setting $distinct to TRUE;
2228
+	 * @return int
2229
+	 * @throws EE_Error
2230
+	 */
2231
+	public function count($query_params = array(), $field_to_count = null, $distinct = false)
2232
+	{
2233
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2234
+		if ($field_to_count) {
2235
+			$field_obj = $this->field_settings_for($field_to_count);
2236
+			$column_to_count = $field_obj->get_qualified_column();
2237
+		} elseif ($this->has_primary_key_field()) {
2238
+			$pk_field_obj = $this->get_primary_key_field();
2239
+			$column_to_count = $pk_field_obj->get_qualified_column();
2240
+		} else {
2241
+			//there's no primary key
2242
+			//if we're counting distinct items, and there's no primary key,
2243
+			//we need to list out the columns for distinction;
2244
+			//otherwise we can just use star
2245
+			if ($distinct) {
2246
+				$columns_to_use = array();
2247
+				foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2248
+					$columns_to_use[] = $field_obj->get_qualified_column();
2249
+				}
2250
+				$column_to_count = implode(',', $columns_to_use);
2251
+			} else {
2252
+				$column_to_count = '*';
2253
+			}
2254
+		}
2255
+		$column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2256
+		$SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2257
+		return (int)$this->_do_wpdb_query('get_var', array($SQL));
2258
+	}
2259
+
2260
+
2261
+
2262
+	/**
2263
+	 * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2264
+	 *
2265
+	 * @param array  $query_params like EEM_Base::get_all
2266
+	 * @param string $field_to_sum name of field (array key in $_fields array)
2267
+	 * @return float
2268
+	 * @throws EE_Error
2269
+	 */
2270
+	public function sum($query_params, $field_to_sum = null)
2271
+	{
2272
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2273
+		if ($field_to_sum) {
2274
+			$field_obj = $this->field_settings_for($field_to_sum);
2275
+		} else {
2276
+			$field_obj = $this->get_primary_key_field();
2277
+		}
2278
+		$column_to_count = $field_obj->get_qualified_column();
2279
+		$SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2280
+		$return_value = $this->_do_wpdb_query('get_var', array($SQL));
2281
+		$data_type = $field_obj->get_wpdb_data_type();
2282
+		if ($data_type === '%d' || $data_type === '%s') {
2283
+			return (float)$return_value;
2284
+		}
2285
+		//must be %f
2286
+		return (float)$return_value;
2287
+	}
2288
+
2289
+
2290
+
2291
+	/**
2292
+	 * Just calls the specified method on $wpdb with the given arguments
2293
+	 * Consolidates a little extra error handling code
2294
+	 *
2295
+	 * @param string $wpdb_method
2296
+	 * @param array  $arguments_to_provide
2297
+	 * @throws EE_Error
2298
+	 * @global wpdb  $wpdb
2299
+	 * @return mixed
2300
+	 */
2301
+	protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2302
+	{
2303
+		//if we're in maintenance mode level 2, DON'T run any queries
2304
+		//because level 2 indicates the database needs updating and
2305
+		//is probably out of sync with the code
2306
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2307
+			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.",
2308
+				"event_espresso")));
2309
+		}
2310
+		/** @type WPDB $wpdb */
2311
+		global $wpdb;
2312
+		if (! method_exists($wpdb, $wpdb_method)) {
2313
+			throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2314
+				'event_espresso'), $wpdb_method));
2315
+		}
2316
+		if (WP_DEBUG) {
2317
+			$old_show_errors_value = $wpdb->show_errors;
2318
+			$wpdb->show_errors(false);
2319
+		}
2320
+		$result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2321
+		$this->show_db_query_if_previously_requested($wpdb->last_query);
2322
+		if (WP_DEBUG) {
2323
+			$wpdb->show_errors($old_show_errors_value);
2324
+			if (! empty($wpdb->last_error)) {
2325
+				throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2326
+			}
2327
+			if ($result === false) {
2328
+				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"',
2329
+					'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2330
+			}
2331
+		} elseif ($result === false) {
2332
+			EE_Error::add_error(
2333
+				sprintf(
2334
+					__('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"',
2335
+						'event_espresso'),
2336
+					$wpdb_method,
2337
+					var_export($arguments_to_provide, true),
2338
+					$wpdb->last_error
2339
+				),
2340
+				__FILE__,
2341
+				__FUNCTION__,
2342
+				__LINE__
2343
+			);
2344
+		}
2345
+		return $result;
2346
+	}
2347
+
2348
+
2349
+
2350
+	/**
2351
+	 * Attempts to run the indicated WPDB method with the provided arguments,
2352
+	 * and if there's an error tries to verify the DB is correct. Uses
2353
+	 * the static property EEM_Base::$_db_verification_level to determine whether
2354
+	 * we should try to fix the EE core db, the addons, or just give up
2355
+	 *
2356
+	 * @param string $wpdb_method
2357
+	 * @param array  $arguments_to_provide
2358
+	 * @return mixed
2359
+	 */
2360
+	private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2361
+	{
2362
+		/** @type WPDB $wpdb */
2363
+		global $wpdb;
2364
+		$wpdb->last_error = null;
2365
+		$result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2366
+		// was there an error running the query? but we don't care on new activations
2367
+		// (we're going to setup the DB anyway on new activations)
2368
+		if (($result === false || ! empty($wpdb->last_error))
2369
+			&& EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2370
+		) {
2371
+			switch (EEM_Base::$_db_verification_level) {
2372
+				case EEM_Base::db_verified_none :
2373
+					// let's double-check core's DB
2374
+					$error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2375
+					break;
2376
+				case EEM_Base::db_verified_core :
2377
+					// STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2378
+					$error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2379
+					break;
2380
+				case EEM_Base::db_verified_addons :
2381
+					// ummmm... you in trouble
2382
+					return $result;
2383
+					break;
2384
+			}
2385
+			if (! empty($error_message)) {
2386
+				EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2387
+				trigger_error($error_message);
2388
+			}
2389
+			return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2390
+		}
2391
+		return $result;
2392
+	}
2393
+
2394
+
2395
+
2396
+	/**
2397
+	 * Verifies the EE core database is up-to-date and records that we've done it on
2398
+	 * EEM_Base::$_db_verification_level
2399
+	 *
2400
+	 * @param string $wpdb_method
2401
+	 * @param array  $arguments_to_provide
2402
+	 * @return string
2403
+	 */
2404
+	private function _verify_core_db($wpdb_method, $arguments_to_provide)
2405
+	{
2406
+		/** @type WPDB $wpdb */
2407
+		global $wpdb;
2408
+		//ok remember that we've already attempted fixing the core db, in case the problem persists
2409
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2410
+		$error_message = sprintf(
2411
+			__('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2412
+				'event_espresso'),
2413
+			$wpdb->last_error,
2414
+			$wpdb_method,
2415
+			wp_json_encode($arguments_to_provide)
2416
+		);
2417
+		EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2418
+		return $error_message;
2419
+	}
2420
+
2421
+
2422
+
2423
+	/**
2424
+	 * Verifies the EE addons' database is up-to-date and records that we've done it on
2425
+	 * EEM_Base::$_db_verification_level
2426
+	 *
2427
+	 * @param $wpdb_method
2428
+	 * @param $arguments_to_provide
2429
+	 * @return string
2430
+	 */
2431
+	private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2432
+	{
2433
+		/** @type WPDB $wpdb */
2434
+		global $wpdb;
2435
+		//ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2436
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2437
+		$error_message = sprintf(
2438
+			__('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2439
+				'event_espresso'),
2440
+			$wpdb->last_error,
2441
+			$wpdb_method,
2442
+			wp_json_encode($arguments_to_provide)
2443
+		);
2444
+		EE_System::instance()->initialize_addons();
2445
+		return $error_message;
2446
+	}
2447
+
2448
+
2449
+
2450
+	/**
2451
+	 * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2452
+	 * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2453
+	 * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2454
+	 * ..."
2455
+	 *
2456
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
2457
+	 * @return string
2458
+	 */
2459
+	private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2460
+	{
2461
+		return " FROM " . $model_query_info->get_full_join_sql() .
2462
+			   $model_query_info->get_where_sql() .
2463
+			   $model_query_info->get_group_by_sql() .
2464
+			   $model_query_info->get_having_sql() .
2465
+			   $model_query_info->get_order_by_sql() .
2466
+			   $model_query_info->get_limit_sql();
2467
+	}
2468
+
2469
+
2470
+
2471
+	/**
2472
+	 * Set to easily debug the next X queries ran from this model.
2473
+	 *
2474
+	 * @param int $count
2475
+	 */
2476
+	public function show_next_x_db_queries($count = 1)
2477
+	{
2478
+		$this->_show_next_x_db_queries = $count;
2479
+	}
2480
+
2481
+
2482
+
2483
+	/**
2484
+	 * @param $sql_query
2485
+	 */
2486
+	public function show_db_query_if_previously_requested($sql_query)
2487
+	{
2488
+		if ($this->_show_next_x_db_queries > 0) {
2489
+			echo $sql_query;
2490
+			$this->_show_next_x_db_queries--;
2491
+		}
2492
+	}
2493
+
2494
+
2495
+
2496
+	/**
2497
+	 * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2498
+	 * There are the 3 cases:
2499
+	 * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2500
+	 * $otherModelObject has no ID, it is first saved.
2501
+	 * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2502
+	 * has no ID, it is first saved.
2503
+	 * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2504
+	 * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2505
+	 * join table
2506
+	 *
2507
+	 * @param        EE_Base_Class                     /int $thisModelObject
2508
+	 * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2509
+	 * @param string $relationName                     , key in EEM_Base::_relations
2510
+	 *                                                 an attendee to a group, you also want to specify which role they
2511
+	 *                                                 will have in that group. So you would use this parameter to
2512
+	 *                                                 specify array('role-column-name'=>'role-id')
2513
+	 * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2514
+	 *                                                 to for relation to methods that allow you to further specify
2515
+	 *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2516
+	 *                                                 only acceptable query_params is strict "col" => "value" pairs
2517
+	 *                                                 because these will be inserted in any new rows created as well.
2518
+	 * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2519
+	 * @throws EE_Error
2520
+	 */
2521
+	public function add_relationship_to(
2522
+		$id_or_obj,
2523
+		$other_model_id_or_obj,
2524
+		$relationName,
2525
+		$extra_join_model_fields_n_values = array()
2526
+	) {
2527
+		$relation_obj = $this->related_settings_for($relationName);
2528
+		return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2529
+	}
2530
+
2531
+
2532
+
2533
+	/**
2534
+	 * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2535
+	 * There are the 3 cases:
2536
+	 * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2537
+	 * error
2538
+	 * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2539
+	 * an error
2540
+	 * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2541
+	 *
2542
+	 * @param        EE_Base_Class /int $id_or_obj
2543
+	 * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2544
+	 * @param string $relationName key in EEM_Base::_relations
2545
+	 * @return boolean of success
2546
+	 * @throws EE_Error
2547
+	 * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2548
+	 *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2549
+	 *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2550
+	 *                             because these will be inserted in any new rows created as well.
2551
+	 */
2552
+	public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2553
+	{
2554
+		$relation_obj = $this->related_settings_for($relationName);
2555
+		return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2556
+	}
2557
+
2558
+
2559
+
2560
+	/**
2561
+	 * @param mixed           $id_or_obj
2562
+	 * @param string          $relationName
2563
+	 * @param array           $where_query_params
2564
+	 * @param EE_Base_Class[] objects to which relations were removed
2565
+	 * @return \EE_Base_Class[]
2566
+	 * @throws EE_Error
2567
+	 */
2568
+	public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2569
+	{
2570
+		$relation_obj = $this->related_settings_for($relationName);
2571
+		return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2572
+	}
2573
+
2574
+
2575
+
2576
+	/**
2577
+	 * Gets all the related items of the specified $model_name, using $query_params.
2578
+	 * Note: by default, we remove the "default query params"
2579
+	 * because we want to get even deleted items etc.
2580
+	 *
2581
+	 * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2582
+	 * @param string $model_name   like 'Event', 'Registration', etc. always singular
2583
+	 * @param array  $query_params like EEM_Base::get_all
2584
+	 * @return EE_Base_Class[]
2585
+	 * @throws EE_Error
2586
+	 */
2587
+	public function get_all_related($id_or_obj, $model_name, $query_params = null)
2588
+	{
2589
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2590
+		$relation_settings = $this->related_settings_for($model_name);
2591
+		return $relation_settings->get_all_related($model_obj, $query_params);
2592
+	}
2593
+
2594
+
2595
+
2596
+	/**
2597
+	 * Deletes all the model objects across the relation indicated by $model_name
2598
+	 * which are related to $id_or_obj which meet the criteria set in $query_params.
2599
+	 * However, if the model objects can't be deleted because of blocking related model objects, then
2600
+	 * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2601
+	 *
2602
+	 * @param EE_Base_Class|int|string $id_or_obj
2603
+	 * @param string                   $model_name
2604
+	 * @param array                    $query_params
2605
+	 * @return int how many deleted
2606
+	 * @throws EE_Error
2607
+	 */
2608
+	public function delete_related($id_or_obj, $model_name, $query_params = array())
2609
+	{
2610
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2611
+		$relation_settings = $this->related_settings_for($model_name);
2612
+		return $relation_settings->delete_all_related($model_obj, $query_params);
2613
+	}
2614
+
2615
+
2616
+
2617
+	/**
2618
+	 * Hard deletes all the model objects across the relation indicated by $model_name
2619
+	 * which are related to $id_or_obj which meet the criteria set in $query_params. If
2620
+	 * the model objects can't be hard deleted because of blocking related model objects,
2621
+	 * just does a soft-delete on them instead.
2622
+	 *
2623
+	 * @param EE_Base_Class|int|string $id_or_obj
2624
+	 * @param string                   $model_name
2625
+	 * @param array                    $query_params
2626
+	 * @return int how many deleted
2627
+	 * @throws EE_Error
2628
+	 */
2629
+	public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2630
+	{
2631
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2632
+		$relation_settings = $this->related_settings_for($model_name);
2633
+		return $relation_settings->delete_related_permanently($model_obj, $query_params);
2634
+	}
2635
+
2636
+
2637
+
2638
+	/**
2639
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2640
+	 * unless otherwise specified in the $query_params
2641
+	 *
2642
+	 * @param        int             /EE_Base_Class $id_or_obj
2643
+	 * @param string $model_name     like 'Event', or 'Registration'
2644
+	 * @param array  $query_params   like EEM_Base::get_all's
2645
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
2646
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2647
+	 *                               that by the setting $distinct to TRUE;
2648
+	 * @return int
2649
+	 * @throws EE_Error
2650
+	 */
2651
+	public function count_related(
2652
+		$id_or_obj,
2653
+		$model_name,
2654
+		$query_params = array(),
2655
+		$field_to_count = null,
2656
+		$distinct = false
2657
+	) {
2658
+		$related_model = $this->get_related_model_obj($model_name);
2659
+		//we're just going to use the query params on the related model's normal get_all query,
2660
+		//except add a condition to say to match the current mod
2661
+		if (! isset($query_params['default_where_conditions'])) {
2662
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2663
+		}
2664
+		$this_model_name = $this->get_this_model_name();
2665
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2666
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2667
+		return $related_model->count($query_params, $field_to_count, $distinct);
2668
+	}
2669
+
2670
+
2671
+
2672
+	/**
2673
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
2674
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2675
+	 *
2676
+	 * @param        int           /EE_Base_Class $id_or_obj
2677
+	 * @param string $model_name   like 'Event', or 'Registration'
2678
+	 * @param array  $query_params like EEM_Base::get_all's
2679
+	 * @param string $field_to_sum name of field to count by. By default, uses primary key
2680
+	 * @return float
2681
+	 * @throws EE_Error
2682
+	 */
2683
+	public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2684
+	{
2685
+		$related_model = $this->get_related_model_obj($model_name);
2686
+		if (! is_array($query_params)) {
2687
+			EE_Error::doing_it_wrong('EEM_Base::sum_related',
2688
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2689
+					gettype($query_params)), '4.6.0');
2690
+			$query_params = array();
2691
+		}
2692
+		//we're just going to use the query params on the related model's normal get_all query,
2693
+		//except add a condition to say to match the current mod
2694
+		if (! isset($query_params['default_where_conditions'])) {
2695
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2696
+		}
2697
+		$this_model_name = $this->get_this_model_name();
2698
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2699
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2700
+		return $related_model->sum($query_params, $field_to_sum);
2701
+	}
2702
+
2703
+
2704
+
2705
+	/**
2706
+	 * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2707
+	 * $modelObject
2708
+	 *
2709
+	 * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2710
+	 * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2711
+	 * @param array               $query_params     like EEM_Base::get_all's
2712
+	 * @return EE_Base_Class
2713
+	 * @throws EE_Error
2714
+	 */
2715
+	public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2716
+	{
2717
+		$query_params['limit'] = 1;
2718
+		$results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2719
+		if ($results) {
2720
+			return array_shift($results);
2721
+		}
2722
+		return null;
2723
+	}
2724
+
2725
+
2726
+
2727
+	/**
2728
+	 * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2729
+	 *
2730
+	 * @return string
2731
+	 */
2732
+	public function get_this_model_name()
2733
+	{
2734
+		return str_replace("EEM_", "", get_class($this));
2735
+	}
2736
+
2737
+
2738
+
2739
+	/**
2740
+	 * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2741
+	 *
2742
+	 * @return EE_Any_Foreign_Model_Name_Field
2743
+	 * @throws EE_Error
2744
+	 */
2745
+	public function get_field_containing_related_model_name()
2746
+	{
2747
+		foreach ($this->field_settings(true) as $field) {
2748
+			if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2749
+				$field_with_model_name = $field;
2750
+			}
2751
+		}
2752
+		if (! isset($field_with_model_name) || ! $field_with_model_name) {
2753
+			throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2754
+				$this->get_this_model_name()));
2755
+		}
2756
+		return $field_with_model_name;
2757
+	}
2758
+
2759
+
2760
+
2761
+	/**
2762
+	 * Inserts a new entry into the database, for each table.
2763
+	 * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2764
+	 * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2765
+	 * we also know there is no model object with the newly inserted item's ID at the moment (because
2766
+	 * if there were, then they would already be in the DB and this would fail); and in the future if someone
2767
+	 * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2768
+	 * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2769
+	 *
2770
+	 * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2771
+	 *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2772
+	 *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2773
+	 *                              of EEM_Base)
2774
+	 * @return int new primary key on main table that got inserted
2775
+	 * @throws EE_Error
2776
+	 */
2777
+	public function insert($field_n_values)
2778
+	{
2779
+		/**
2780
+		 * Filters the fields and their values before inserting an item using the models
2781
+		 *
2782
+		 * @param array    $fields_n_values keys are the fields and values are their new values
2783
+		 * @param EEM_Base $model           the model used
2784
+		 */
2785
+		$field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2786
+		if ($this->_satisfies_unique_indexes($field_n_values)) {
2787
+			$main_table = $this->_get_main_table();
2788
+			$new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2789
+			if ($new_id !== false) {
2790
+				foreach ($this->_get_other_tables() as $other_table) {
2791
+					$this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2792
+				}
2793
+			}
2794
+			/**
2795
+			 * Done just after attempting to insert a new model object
2796
+			 *
2797
+			 * @param EEM_Base   $model           used
2798
+			 * @param array      $fields_n_values fields and their values
2799
+			 * @param int|string the              ID of the newly-inserted model object
2800
+			 */
2801
+			do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2802
+			return $new_id;
2803
+		}
2804
+		return false;
2805
+	}
2806
+
2807
+
2808
+
2809
+	/**
2810
+	 * Checks that the result would satisfy the unique indexes on this model
2811
+	 *
2812
+	 * @param array  $field_n_values
2813
+	 * @param string $action
2814
+	 * @return boolean
2815
+	 * @throws EE_Error
2816
+	 */
2817
+	protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2818
+	{
2819
+		foreach ($this->unique_indexes() as $index_name => $index) {
2820
+			$uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2821
+			if ($this->exists(array($uniqueness_where_params))) {
2822
+				EE_Error::add_error(
2823
+					sprintf(
2824
+						__(
2825
+							"Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2826
+							"event_espresso"
2827
+						),
2828
+						$action,
2829
+						$this->_get_class_name(),
2830
+						$index_name,
2831
+						implode(",", $index->field_names()),
2832
+						http_build_query($uniqueness_where_params)
2833
+					),
2834
+					__FILE__,
2835
+					__FUNCTION__,
2836
+					__LINE__
2837
+				);
2838
+				return false;
2839
+			}
2840
+		}
2841
+		return true;
2842
+	}
2843
+
2844
+
2845
+
2846
+	/**
2847
+	 * Checks the database for an item that conflicts (ie, if this item were
2848
+	 * saved to the DB would break some uniqueness requirement, like a primary key
2849
+	 * or an index primary key set) with the item specified. $id_obj_or_fields_array
2850
+	 * can be either an EE_Base_Class or an array of fields n values
2851
+	 *
2852
+	 * @param EE_Base_Class|array $obj_or_fields_array
2853
+	 * @param boolean             $include_primary_key whether to use the model object's primary key
2854
+	 *                                                 when looking for conflicts
2855
+	 *                                                 (ie, if false, we ignore the model object's primary key
2856
+	 *                                                 when finding "conflicts". If true, it's also considered).
2857
+	 *                                                 Only works for INT primary key,
2858
+	 *                                                 STRING primary keys cannot be ignored
2859
+	 * @throws EE_Error
2860
+	 * @return EE_Base_Class|array
2861
+	 */
2862
+	public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2863
+	{
2864
+		if ($obj_or_fields_array instanceof EE_Base_Class) {
2865
+			$fields_n_values = $obj_or_fields_array->model_field_array();
2866
+		} elseif (is_array($obj_or_fields_array)) {
2867
+			$fields_n_values = $obj_or_fields_array;
2868
+		} else {
2869
+			throw new EE_Error(
2870
+				sprintf(
2871
+					__(
2872
+						"%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2873
+						"event_espresso"
2874
+					),
2875
+					get_class($this),
2876
+					$obj_or_fields_array
2877
+				)
2878
+			);
2879
+		}
2880
+		$query_params = array();
2881
+		if ($this->has_primary_key_field()
2882
+			&& ($include_primary_key
2883
+				|| $this->get_primary_key_field()
2884
+				   instanceof
2885
+				   EE_Primary_Key_String_Field)
2886
+			&& isset($fields_n_values[$this->primary_key_name()])
2887
+		) {
2888
+			$query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2889
+		}
2890
+		foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2891
+			$uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2892
+			$query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2893
+		}
2894
+		//if there is nothing to base this search on, then we shouldn't find anything
2895
+		if (empty($query_params)) {
2896
+			return array();
2897
+		}
2898
+		return $this->get_one($query_params);
2899
+	}
2900
+
2901
+
2902
+
2903
+	/**
2904
+	 * Like count, but is optimized and returns a boolean instead of an int
2905
+	 *
2906
+	 * @param array $query_params
2907
+	 * @return boolean
2908
+	 * @throws EE_Error
2909
+	 */
2910
+	public function exists($query_params)
2911
+	{
2912
+		$query_params['limit'] = 1;
2913
+		return $this->count($query_params) > 0;
2914
+	}
2915
+
2916
+
2917
+
2918
+	/**
2919
+	 * Wrapper for exists, except ignores default query parameters so we're only considering ID
2920
+	 *
2921
+	 * @param int|string $id
2922
+	 * @return boolean
2923
+	 * @throws EE_Error
2924
+	 */
2925
+	public function exists_by_ID($id)
2926
+	{
2927
+		return $this->exists(
2928
+			array(
2929
+				'default_where_conditions' => EEM_Base::default_where_conditions_none,
2930
+				array(
2931
+					$this->primary_key_name() => $id,
2932
+				),
2933
+			)
2934
+		);
2935
+	}
2936
+
2937
+
2938
+
2939
+	/**
2940
+	 * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2941
+	 * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2942
+	 * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2943
+	 * on the main table)
2944
+	 * This is protected rather than private because private is not accessible to any child methods and there MAY be
2945
+	 * cases where we want to call it directly rather than via insert().
2946
+	 *
2947
+	 * @access   protected
2948
+	 * @param EE_Table_Base $table
2949
+	 * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2950
+	 *                                       float
2951
+	 * @param int           $new_id          for now we assume only int keys
2952
+	 * @throws EE_Error
2953
+	 * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2954
+	 * @return int ID of new row inserted, or FALSE on failure
2955
+	 */
2956
+	protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2957
+	{
2958
+		global $wpdb;
2959
+		$insertion_col_n_values = array();
2960
+		$format_for_insertion = array();
2961
+		$fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2962
+		foreach ($fields_on_table as $field_name => $field_obj) {
2963
+			//check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2964
+			if ($field_obj->is_auto_increment()) {
2965
+				continue;
2966
+			}
2967
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2968
+			//if the value we want to assign it to is NULL, just don't mention it for the insertion
2969
+			if ($prepared_value !== null) {
2970
+				$insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2971
+				$format_for_insertion[] = $field_obj->get_wpdb_data_type();
2972
+			}
2973
+		}
2974
+		if ($table instanceof EE_Secondary_Table && $new_id) {
2975
+			//its not the main table, so we should have already saved the main table's PK which we just inserted
2976
+			//so add the fk to the main table as a column
2977
+			$insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2978
+			$format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2979
+		}
2980
+		//insert the new entry
2981
+		$result = $this->_do_wpdb_query('insert',
2982
+			array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2983
+		if ($result === false) {
2984
+			return false;
2985
+		}
2986
+		//ok, now what do we return for the ID of the newly-inserted thing?
2987
+		if ($this->has_primary_key_field()) {
2988
+			if ($this->get_primary_key_field()->is_auto_increment()) {
2989
+				return $wpdb->insert_id;
2990
+			}
2991
+			//it's not an auto-increment primary key, so
2992
+			//it must have been supplied
2993
+			return $fields_n_values[$this->get_primary_key_field()->get_name()];
2994
+		}
2995
+		//we can't return a  primary key because there is none. instead return
2996
+		//a unique string indicating this model
2997
+		return $this->get_index_primary_key_string($fields_n_values);
2998
+	}
2999
+
3000
+
3001
+
3002
+	/**
3003
+	 * Prepare the $field_obj 's value in $fields_n_values for use in the database.
3004
+	 * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
3005
+	 * and there is no default, we pass it along. WPDB will take care of it)
3006
+	 *
3007
+	 * @param EE_Model_Field_Base $field_obj
3008
+	 * @param array               $fields_n_values
3009
+	 * @return mixed string|int|float depending on what the table column will be expecting
3010
+	 * @throws EE_Error
3011
+	 */
3012
+	protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
3013
+	{
3014
+		//if this field doesn't allow nullable, don't allow it
3015
+		if (
3016
+			! $field_obj->is_nullable()
3017
+			&& (
3018
+				! isset($fields_n_values[$field_obj->get_name()])
3019
+				|| $fields_n_values[$field_obj->get_name()] === null
3020
+			)
3021
+		) {
3022
+			$fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
3023
+		}
3024
+		$unprepared_value = isset($fields_n_values[$field_obj->get_name()])
3025
+			? $fields_n_values[$field_obj->get_name()]
3026
+			: null;
3027
+		return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
3028
+	}
3029
+
3030
+
3031
+
3032
+	/**
3033
+	 * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
3034
+	 * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
3035
+	 * the field's prepare_for_set() method.
3036
+	 *
3037
+	 * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
3038
+	 *                                   false, otherwise a value in the model object's domain (see lengthy comment at
3039
+	 *                                   top of file)
3040
+	 * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
3041
+	 *                                   $value is a custom selection
3042
+	 * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
3043
+	 */
3044
+	private function _prepare_value_for_use_in_db($value, $field)
3045
+	{
3046
+		if ($field && $field instanceof EE_Model_Field_Base) {
3047
+			switch ($this->_values_already_prepared_by_model_object) {
3048
+				/** @noinspection PhpMissingBreakStatementInspection */
3049
+				case self::not_prepared_by_model_object:
3050
+					$value = $field->prepare_for_set($value);
3051
+				//purposefully left out "return"
3052
+				case self::prepared_by_model_object:
3053
+					/** @noinspection SuspiciousAssignmentsInspection */
3054
+					$value = $field->prepare_for_use_in_db($value);
3055
+				case self::prepared_for_use_in_db:
3056
+					//leave the value alone
3057
+			}
3058
+			return $value;
3059
+		}
3060
+		return $value;
3061
+	}
3062
+
3063
+
3064
+
3065
+	/**
3066
+	 * Returns the main table on this model
3067
+	 *
3068
+	 * @return EE_Primary_Table
3069
+	 * @throws EE_Error
3070
+	 */
3071
+	protected function _get_main_table()
3072
+	{
3073
+		foreach ($this->_tables as $table) {
3074
+			if ($table instanceof EE_Primary_Table) {
3075
+				return $table;
3076
+			}
3077
+		}
3078
+		throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
3079
+			'event_espresso'), get_class($this)));
3080
+	}
3081
+
3082
+
3083
+
3084
+	/**
3085
+	 * table
3086
+	 * returns EE_Primary_Table table name
3087
+	 *
3088
+	 * @return string
3089
+	 * @throws EE_Error
3090
+	 */
3091
+	public function table()
3092
+	{
3093
+		return $this->_get_main_table()->get_table_name();
3094
+	}
3095
+
3096
+
3097
+
3098
+	/**
3099
+	 * table
3100
+	 * returns first EE_Secondary_Table table name
3101
+	 *
3102
+	 * @return string
3103
+	 */
3104
+	public function second_table()
3105
+	{
3106
+		// grab second table from tables array
3107
+		$second_table = end($this->_tables);
3108
+		return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
3109
+	}
3110
+
3111
+
3112
+
3113
+	/**
3114
+	 * get_table_obj_by_alias
3115
+	 * returns table name given it's alias
3116
+	 *
3117
+	 * @param string $table_alias
3118
+	 * @return EE_Primary_Table | EE_Secondary_Table
3119
+	 */
3120
+	public function get_table_obj_by_alias($table_alias = '')
3121
+	{
3122
+		return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
3123
+	}
3124
+
3125
+
3126
+
3127
+	/**
3128
+	 * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
3129
+	 *
3130
+	 * @return EE_Secondary_Table[]
3131
+	 */
3132
+	protected function _get_other_tables()
3133
+	{
3134
+		$other_tables = array();
3135
+		foreach ($this->_tables as $table_alias => $table) {
3136
+			if ($table instanceof EE_Secondary_Table) {
3137
+				$other_tables[$table_alias] = $table;
3138
+			}
3139
+		}
3140
+		return $other_tables;
3141
+	}
3142
+
3143
+
3144
+
3145
+	/**
3146
+	 * Finds all the fields that correspond to the given table
3147
+	 *
3148
+	 * @param string $table_alias , array key in EEM_Base::_tables
3149
+	 * @return EE_Model_Field_Base[]
3150
+	 */
3151
+	public function _get_fields_for_table($table_alias)
3152
+	{
3153
+		return $this->_fields[$table_alias];
3154
+	}
3155
+
3156
+
3157
+
3158
+	/**
3159
+	 * Recurses through all the where parameters, and finds all the related models we'll need
3160
+	 * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
3161
+	 * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
3162
+	 * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
3163
+	 * related Registration, Transaction, and Payment models.
3164
+	 *
3165
+	 * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
3166
+	 * @return EE_Model_Query_Info_Carrier
3167
+	 * @throws EE_Error
3168
+	 */
3169
+	public function _extract_related_models_from_query($query_params)
3170
+	{
3171
+		$query_info_carrier = new EE_Model_Query_Info_Carrier();
3172
+		if (array_key_exists(0, $query_params)) {
3173
+			$this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
3174
+		}
3175
+		if (array_key_exists('group_by', $query_params)) {
3176
+			if (is_array($query_params['group_by'])) {
3177
+				$this->_extract_related_models_from_sub_params_array_values(
3178
+					$query_params['group_by'],
3179
+					$query_info_carrier,
3180
+					'group_by'
3181
+				);
3182
+			} elseif (! empty ($query_params['group_by'])) {
3183
+				$this->_extract_related_model_info_from_query_param(
3184
+					$query_params['group_by'],
3185
+					$query_info_carrier,
3186
+					'group_by'
3187
+				);
3188
+			}
3189
+		}
3190
+		if (array_key_exists('having', $query_params)) {
3191
+			$this->_extract_related_models_from_sub_params_array_keys(
3192
+				$query_params[0],
3193
+				$query_info_carrier,
3194
+				'having'
3195
+			);
3196
+		}
3197
+		if (array_key_exists('order_by', $query_params)) {
3198
+			if (is_array($query_params['order_by'])) {
3199
+				$this->_extract_related_models_from_sub_params_array_keys(
3200
+					$query_params['order_by'],
3201
+					$query_info_carrier,
3202
+					'order_by'
3203
+				);
3204
+			} elseif (! empty($query_params['order_by'])) {
3205
+				$this->_extract_related_model_info_from_query_param(
3206
+					$query_params['order_by'],
3207
+					$query_info_carrier,
3208
+					'order_by'
3209
+				);
3210
+			}
3211
+		}
3212
+		if (array_key_exists('force_join', $query_params)) {
3213
+			$this->_extract_related_models_from_sub_params_array_values(
3214
+				$query_params['force_join'],
3215
+				$query_info_carrier,
3216
+				'force_join'
3217
+			);
3218
+		}
3219
+		return $query_info_carrier;
3220
+	}
3221
+
3222
+
3223
+
3224
+	/**
3225
+	 * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
3226
+	 *
3227
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3228
+	 *                                                      $query_params['having']
3229
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3230
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
3231
+	 * @throws EE_Error
3232
+	 * @return \EE_Model_Query_Info_Carrier
3233
+	 */
3234
+	private function _extract_related_models_from_sub_params_array_keys(
3235
+		$sub_query_params,
3236
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3237
+		$query_param_type
3238
+	) {
3239
+		if (! empty($sub_query_params)) {
3240
+			$sub_query_params = (array)$sub_query_params;
3241
+			foreach ($sub_query_params as $param => $possibly_array_of_params) {
3242
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3243
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3244
+					$query_param_type);
3245
+				//if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3246
+				//indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3247
+				//extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3248
+				//of array('Registration.TXN_ID'=>23)
3249
+				$query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3250
+				if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3251
+					if (! is_array($possibly_array_of_params)) {
3252
+						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'))",
3253
+							"event_espresso"),
3254
+							$param, $possibly_array_of_params));
3255
+					}
3256
+					$this->_extract_related_models_from_sub_params_array_keys(
3257
+						$possibly_array_of_params,
3258
+						$model_query_info_carrier, $query_param_type
3259
+					);
3260
+				} elseif ($query_param_type === 0 //ie WHERE
3261
+						  && is_array($possibly_array_of_params)
3262
+						  && isset($possibly_array_of_params[2])
3263
+						  && $possibly_array_of_params[2] == true
3264
+				) {
3265
+					//then $possible_array_of_params looks something like array('<','DTT_sold',true)
3266
+					//indicating that $possible_array_of_params[1] is actually a field name,
3267
+					//from which we should extract query parameters!
3268
+					if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3269
+						throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3270
+							"event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3271
+					}
3272
+					$this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3273
+						$model_query_info_carrier, $query_param_type);
3274
+				}
3275
+			}
3276
+		}
3277
+		return $model_query_info_carrier;
3278
+	}
3279
+
3280
+
3281
+
3282
+	/**
3283
+	 * For extracting related models from forced_joins, where the array values contain the info about what
3284
+	 * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3285
+	 *
3286
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3287
+	 *                                                      $query_params['having']
3288
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3289
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
3290
+	 * @throws EE_Error
3291
+	 * @return \EE_Model_Query_Info_Carrier
3292
+	 */
3293
+	private function _extract_related_models_from_sub_params_array_values(
3294
+		$sub_query_params,
3295
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3296
+		$query_param_type
3297
+	) {
3298
+		if (! empty($sub_query_params)) {
3299
+			if (! is_array($sub_query_params)) {
3300
+				throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3301
+					$sub_query_params));
3302
+			}
3303
+			foreach ($sub_query_params as $param) {
3304
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3305
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3306
+					$query_param_type);
3307
+			}
3308
+		}
3309
+		return $model_query_info_carrier;
3310
+	}
3311
+
3312
+
3313
+
3314
+	/**
3315
+	 * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3316
+	 * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3317
+	 * instead of directly constructing the SQL because often we need to extract info from the $query_params
3318
+	 * but use them in a different order. Eg, we need to know what models we are querying
3319
+	 * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3320
+	 * other models before we can finalize the where clause SQL.
3321
+	 *
3322
+	 * @param array $query_params
3323
+	 * @throws EE_Error
3324
+	 * @return EE_Model_Query_Info_Carrier
3325
+	 */
3326
+	public function _create_model_query_info_carrier($query_params)
3327
+	{
3328
+		if (! is_array($query_params)) {
3329
+			EE_Error::doing_it_wrong(
3330
+				'EEM_Base::_create_model_query_info_carrier',
3331
+				sprintf(
3332
+					__(
3333
+						'$query_params should be an array, you passed a variable of type %s',
3334
+						'event_espresso'
3335
+					),
3336
+					gettype($query_params)
3337
+				),
3338
+				'4.6.0'
3339
+			);
3340
+			$query_params = array();
3341
+		}
3342
+		$where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3343
+		//first check if we should alter the query to account for caps or not
3344
+		//because the caps might require us to do extra joins
3345
+		if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3346
+			$query_params[0] = $where_query_params = array_replace_recursive(
3347
+				$where_query_params,
3348
+				$this->caps_where_conditions(
3349
+					$query_params['caps']
3350
+				)
3351
+			);
3352
+		}
3353
+		$query_object = $this->_extract_related_models_from_query($query_params);
3354
+		//verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3355
+		foreach ($where_query_params as $key => $value) {
3356
+			if (is_int($key)) {
3357
+				throw new EE_Error(
3358
+					sprintf(
3359
+						__(
3360
+							"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.",
3361
+							"event_espresso"
3362
+						),
3363
+						$key,
3364
+						var_export($value, true),
3365
+						var_export($query_params, true),
3366
+						get_class($this)
3367
+					)
3368
+				);
3369
+			}
3370
+		}
3371
+		if (
3372
+			array_key_exists('default_where_conditions', $query_params)
3373
+			&& ! empty($query_params['default_where_conditions'])
3374
+		) {
3375
+			$use_default_where_conditions = $query_params['default_where_conditions'];
3376
+		} else {
3377
+			$use_default_where_conditions = EEM_Base::default_where_conditions_all;
3378
+		}
3379
+		$where_query_params = array_merge(
3380
+			$this->_get_default_where_conditions_for_models_in_query(
3381
+				$query_object,
3382
+				$use_default_where_conditions,
3383
+				$where_query_params
3384
+			),
3385
+			$where_query_params
3386
+		);
3387
+		$query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3388
+		// if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3389
+		// So we need to setup a subquery and use that for the main join.
3390
+		// Note for now this only works on the primary table for the model.
3391
+		// So for instance, you could set the limit array like this:
3392
+		// array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3393
+		if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3394
+			$query_object->set_main_model_join_sql(
3395
+				$this->_construct_limit_join_select(
3396
+					$query_params['on_join_limit'][0],
3397
+					$query_params['on_join_limit'][1]
3398
+				)
3399
+			);
3400
+		}
3401
+		//set limit
3402
+		if (array_key_exists('limit', $query_params)) {
3403
+			if (is_array($query_params['limit'])) {
3404
+				if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3405
+					$e = sprintf(
3406
+						__(
3407
+							"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)",
3408
+							"event_espresso"
3409
+						),
3410
+						http_build_query($query_params['limit'])
3411
+					);
3412
+					throw new EE_Error($e . "|" . $e);
3413
+				}
3414
+				//they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3415
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3416
+			} elseif (! empty ($query_params['limit'])) {
3417
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3418
+			}
3419
+		}
3420
+		//set order by
3421
+		if (array_key_exists('order_by', $query_params)) {
3422
+			if (is_array($query_params['order_by'])) {
3423
+				//if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3424
+				//specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3425
+				//including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3426
+				if (array_key_exists('order', $query_params)) {
3427
+					throw new EE_Error(
3428
+						sprintf(
3429
+							__(
3430
+								"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 ",
3431
+								"event_espresso"
3432
+							),
3433
+							get_class($this),
3434
+							implode(", ", array_keys($query_params['order_by'])),
3435
+							implode(", ", $query_params['order_by']),
3436
+							$query_params['order']
3437
+						)
3438
+					);
3439
+				}
3440
+				$this->_extract_related_models_from_sub_params_array_keys(
3441
+					$query_params['order_by'],
3442
+					$query_object,
3443
+					'order_by'
3444
+				);
3445
+				//assume it's an array of fields to order by
3446
+				$order_array = array();
3447
+				foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3448
+					$order = $this->_extract_order($order);
3449
+					$order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3450
+				}
3451
+				$query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3452
+			} elseif (! empty ($query_params['order_by'])) {
3453
+				$this->_extract_related_model_info_from_query_param(
3454
+					$query_params['order_by'],
3455
+					$query_object,
3456
+					'order',
3457
+					$query_params['order_by']
3458
+				);
3459
+				$order = isset($query_params['order'])
3460
+					? $this->_extract_order($query_params['order'])
3461
+					: 'DESC';
3462
+				$query_object->set_order_by_sql(
3463
+					" ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3464
+				);
3465
+			}
3466
+		}
3467
+		//if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3468
+		if (! array_key_exists('order_by', $query_params)
3469
+			&& array_key_exists('order', $query_params)
3470
+			&& ! empty($query_params['order'])
3471
+		) {
3472
+			$pk_field = $this->get_primary_key_field();
3473
+			$order = $this->_extract_order($query_params['order']);
3474
+			$query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3475
+		}
3476
+		//set group by
3477
+		if (array_key_exists('group_by', $query_params)) {
3478
+			if (is_array($query_params['group_by'])) {
3479
+				//it's an array, so assume we'll be grouping by a bunch of stuff
3480
+				$group_by_array = array();
3481
+				foreach ($query_params['group_by'] as $field_name_to_group_by) {
3482
+					$group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3483
+				}
3484
+				$query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3485
+			} elseif (! empty ($query_params['group_by'])) {
3486
+				$query_object->set_group_by_sql(
3487
+					" GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3488
+				);
3489
+			}
3490
+		}
3491
+		//set having
3492
+		if (array_key_exists('having', $query_params) && $query_params['having']) {
3493
+			$query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3494
+		}
3495
+		//now, just verify they didn't pass anything wack
3496
+		foreach ($query_params as $query_key => $query_value) {
3497
+			if (! in_array($query_key, $this->_allowed_query_params, true)) {
3498
+				throw new EE_Error(
3499
+					sprintf(
3500
+						__(
3501
+							"You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3502
+							'event_espresso'
3503
+						),
3504
+						$query_key,
3505
+						get_class($this),
3506
+						//						print_r( $this->_allowed_query_params, TRUE )
3507
+						implode(',', $this->_allowed_query_params)
3508
+					)
3509
+				);
3510
+			}
3511
+		}
3512
+		$main_model_join_sql = $query_object->get_main_model_join_sql();
3513
+		if (empty($main_model_join_sql)) {
3514
+			$query_object->set_main_model_join_sql($this->_construct_internal_join());
3515
+		}
3516
+		return $query_object;
3517
+	}
3518
+
3519
+
3520
+
3521
+	/**
3522
+	 * Gets the where conditions that should be imposed on the query based on the
3523
+	 * context (eg reading frontend, backend, edit or delete).
3524
+	 *
3525
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
3526
+	 * @return array like EEM_Base::get_all() 's $query_params[0]
3527
+	 * @throws EE_Error
3528
+	 */
3529
+	public function caps_where_conditions($context = self::caps_read)
3530
+	{
3531
+		EEM_Base::verify_is_valid_cap_context($context);
3532
+		$cap_where_conditions = array();
3533
+		$cap_restrictions = $this->caps_missing($context);
3534
+		/**
3535
+		 * @var $cap_restrictions EE_Default_Where_Conditions[]
3536
+		 */
3537
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3538
+			$cap_where_conditions = array_replace_recursive($cap_where_conditions,
3539
+				$restriction_if_no_cap->get_default_where_conditions());
3540
+		}
3541
+		return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3542
+			$cap_restrictions);
3543
+	}
3544
+
3545
+
3546
+
3547
+	/**
3548
+	 * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3549
+	 * otherwise throws an exception
3550
+	 *
3551
+	 * @param string $should_be_order_string
3552
+	 * @return string either ASC, asc, DESC or desc
3553
+	 * @throws EE_Error
3554
+	 */
3555
+	private function _extract_order($should_be_order_string)
3556
+	{
3557
+		if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3558
+			return $should_be_order_string;
3559
+		}
3560
+		throw new EE_Error(
3561
+			sprintf(
3562
+				__(
3563
+					"While performing a query on '%s', tried to use '%s' as an order parameter. ",
3564
+					"event_espresso"
3565
+				), get_class($this), $should_be_order_string
3566
+			)
3567
+		);
3568
+	}
3569
+
3570
+
3571
+
3572
+	/**
3573
+	 * Looks at all the models which are included in this query, and asks each
3574
+	 * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3575
+	 * so they can be merged
3576
+	 *
3577
+	 * @param EE_Model_Query_Info_Carrier $query_info_carrier
3578
+	 * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3579
+	 *                                                                  'none' means NO default where conditions will
3580
+	 *                                                                  be used AT ALL during this query.
3581
+	 *                                                                  'other_models_only' means default where
3582
+	 *                                                                  conditions from other models will be used, but
3583
+	 *                                                                  not for this primary model. 'all', the default,
3584
+	 *                                                                  means default where conditions will apply as
3585
+	 *                                                                  normal
3586
+	 * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3587
+	 * @throws EE_Error
3588
+	 * @return array like $query_params[0], see EEM_Base::get_all for documentation
3589
+	 */
3590
+	private function _get_default_where_conditions_for_models_in_query(
3591
+		EE_Model_Query_Info_Carrier $query_info_carrier,
3592
+		$use_default_where_conditions = EEM_Base::default_where_conditions_all,
3593
+		$where_query_params = array()
3594
+	) {
3595
+		$allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3596
+		if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3597
+			throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3598
+				"event_espresso"), $use_default_where_conditions,
3599
+				implode(", ", $allowed_used_default_where_conditions_values)));
3600
+		}
3601
+		$universal_query_params = array();
3602
+		if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3603
+			$universal_query_params = $this->_get_default_where_conditions();
3604
+		} else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3605
+			$universal_query_params = $this->_get_minimum_where_conditions();
3606
+		}
3607
+		foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3608
+			$related_model = $this->get_related_model_obj($model_name);
3609
+			if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3610
+				$related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3611
+			} elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3612
+				$related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3613
+			} else {
3614
+				//we don't want to add full or even minimum default where conditions from this model, so just continue
3615
+				continue;
3616
+			}
3617
+			$overrides = $this->_override_defaults_or_make_null_friendly(
3618
+				$related_model_universal_where_params,
3619
+				$where_query_params,
3620
+				$related_model,
3621
+				$model_relation_path
3622
+			);
3623
+			$universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3624
+				$universal_query_params,
3625
+				$overrides
3626
+			);
3627
+		}
3628
+		return $universal_query_params;
3629
+	}
3630
+
3631
+
3632
+
3633
+	/**
3634
+	 * Determines whether or not we should use default where conditions for the model in question
3635
+	 * (this model, or other related models).
3636
+	 * Basically, we should use default where conditions on this model if they have requested to use them on all models,
3637
+	 * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3638
+	 * We should use default where conditions on related models when they requested to use default where conditions
3639
+	 * on all models, or specifically just on other related models
3640
+	 * @param      $default_where_conditions_value
3641
+	 * @param bool $for_this_model false means this is for OTHER related models
3642
+	 * @return bool
3643
+	 */
3644
+	private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3645
+	{
3646
+		return (
3647
+				   $for_this_model
3648
+				   && in_array(
3649
+					   $default_where_conditions_value,
3650
+					   array(
3651
+						   EEM_Base::default_where_conditions_all,
3652
+						   EEM_Base::default_where_conditions_this_only,
3653
+						   EEM_Base::default_where_conditions_minimum_others,
3654
+					   ),
3655
+					   true
3656
+				   )
3657
+			   )
3658
+			   || (
3659
+				   ! $for_this_model
3660
+				   && in_array(
3661
+					   $default_where_conditions_value,
3662
+					   array(
3663
+						   EEM_Base::default_where_conditions_all,
3664
+						   EEM_Base::default_where_conditions_others_only,
3665
+					   ),
3666
+					   true
3667
+				   )
3668
+			   );
3669
+	}
3670
+
3671
+	/**
3672
+	 * Determines whether or not we should use default minimum conditions for the model in question
3673
+	 * (this model, or other related models).
3674
+	 * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
3675
+	 * where conditions.
3676
+	 * We should use minimum where conditions on related models if they requested to use minimum where conditions
3677
+	 * on this model or others
3678
+	 * @param      $default_where_conditions_value
3679
+	 * @param bool $for_this_model false means this is for OTHER related models
3680
+	 * @return bool
3681
+	 */
3682
+	private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
3683
+	{
3684
+		return (
3685
+				   $for_this_model
3686
+				   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
3687
+			   )
3688
+			   || (
3689
+				   ! $for_this_model
3690
+				   && in_array(
3691
+					   $default_where_conditions_value,
3692
+					   array(
3693
+						   EEM_Base::default_where_conditions_minimum_others,
3694
+						   EEM_Base::default_where_conditions_minimum_all,
3695
+					   ),
3696
+					   true
3697
+				   )
3698
+			   );
3699
+	}
3700
+
3701
+
3702
+	/**
3703
+	 * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3704
+	 * then we also add a special where condition which allows for that model's primary key
3705
+	 * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3706
+	 * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3707
+	 *
3708
+	 * @param array    $default_where_conditions
3709
+	 * @param array    $provided_where_conditions
3710
+	 * @param EEM_Base $model
3711
+	 * @param string   $model_relation_path like 'Transaction.Payment.'
3712
+	 * @return array like EEM_Base::get_all's $query_params[0]
3713
+	 * @throws EE_Error
3714
+	 */
3715
+	private function _override_defaults_or_make_null_friendly(
3716
+		$default_where_conditions,
3717
+		$provided_where_conditions,
3718
+		$model,
3719
+		$model_relation_path
3720
+	) {
3721
+		$null_friendly_where_conditions = array();
3722
+		$none_overridden = true;
3723
+		$or_condition_key_for_defaults = 'OR*' . get_class($model);
3724
+		foreach ($default_where_conditions as $key => $val) {
3725
+			if (isset($provided_where_conditions[$key])) {
3726
+				$none_overridden = false;
3727
+			} else {
3728
+				$null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3729
+			}
3730
+		}
3731
+		if ($none_overridden && $default_where_conditions) {
3732
+			if ($model->has_primary_key_field()) {
3733
+				$null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3734
+																				. "."
3735
+																				. $model->primary_key_name()] = array('IS NULL');
3736
+			}/*else{
3737 3737
 				//@todo NO PK, use other defaults
3738 3738
 			}*/
3739
-        }
3740
-        return $null_friendly_where_conditions;
3741
-    }
3742
-
3743
-
3744
-
3745
-    /**
3746
-     * Uses the _default_where_conditions_strategy set during __construct() to get
3747
-     * default where conditions on all get_all, update, and delete queries done by this model.
3748
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3749
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3750
-     *
3751
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3752
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3753
-     */
3754
-    private function _get_default_where_conditions($model_relation_path = null)
3755
-    {
3756
-        if ($this->_ignore_where_strategy) {
3757
-            return array();
3758
-        }
3759
-        return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3760
-    }
3761
-
3762
-
3763
-
3764
-    /**
3765
-     * Uses the _minimum_where_conditions_strategy set during __construct() to get
3766
-     * minimum where conditions on all get_all, update, and delete queries done by this model.
3767
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3768
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3769
-     * Similar to _get_default_where_conditions
3770
-     *
3771
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3772
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3773
-     */
3774
-    protected function _get_minimum_where_conditions($model_relation_path = null)
3775
-    {
3776
-        if ($this->_ignore_where_strategy) {
3777
-            return array();
3778
-        }
3779
-        return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3780
-    }
3781
-
3782
-
3783
-
3784
-    /**
3785
-     * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3786
-     * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3787
-     *
3788
-     * @param EE_Model_Query_Info_Carrier $model_query_info
3789
-     * @return string
3790
-     * @throws EE_Error
3791
-     */
3792
-    private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3793
-    {
3794
-        $selects = $this->_get_columns_to_select_for_this_model();
3795
-        foreach (
3796
-            $model_query_info->get_model_names_included() as $model_relation_chain =>
3797
-            $name_of_other_model_included
3798
-        ) {
3799
-            $other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3800
-            $other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3801
-            foreach ($other_model_selects as $key => $value) {
3802
-                $selects[] = $value;
3803
-            }
3804
-        }
3805
-        return implode(", ", $selects);
3806
-    }
3807
-
3808
-
3809
-
3810
-    /**
3811
-     * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3812
-     * So that's going to be the columns for all the fields on the model
3813
-     *
3814
-     * @param string $model_relation_chain like 'Question.Question_Group.Event'
3815
-     * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3816
-     */
3817
-    public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3818
-    {
3819
-        $fields = $this->field_settings();
3820
-        $selects = array();
3821
-        $table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3822
-            $this->get_this_model_name());
3823
-        foreach ($fields as $field_obj) {
3824
-            $selects[] = $table_alias_with_model_relation_chain_prefix
3825
-                         . $field_obj->get_table_alias()
3826
-                         . "."
3827
-                         . $field_obj->get_table_column()
3828
-                         . " AS '"
3829
-                         . $table_alias_with_model_relation_chain_prefix
3830
-                         . $field_obj->get_table_alias()
3831
-                         . "."
3832
-                         . $field_obj->get_table_column()
3833
-                         . "'";
3834
-        }
3835
-        //make sure we are also getting the PKs of each table
3836
-        $tables = $this->get_tables();
3837
-        if (count($tables) > 1) {
3838
-            foreach ($tables as $table_obj) {
3839
-                $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3840
-                                       . $table_obj->get_fully_qualified_pk_column();
3841
-                if (! in_array($qualified_pk_column, $selects)) {
3842
-                    $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3843
-                }
3844
-            }
3845
-        }
3846
-        return $selects;
3847
-    }
3848
-
3849
-
3850
-
3851
-    /**
3852
-     * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3853
-     * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3854
-     * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3855
-     * SQL for joining, and the data types
3856
-     *
3857
-     * @param null|string                 $original_query_param
3858
-     * @param string                      $query_param          like Registration.Transaction.TXN_ID
3859
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3860
-     * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3861
-     *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3862
-     *                                                          column name. We only want model names, eg 'Event.Venue'
3863
-     *                                                          or 'Registration's
3864
-     * @param string                      $original_query_param what it originally was (eg
3865
-     *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3866
-     *                                                          matches $query_param
3867
-     * @throws EE_Error
3868
-     * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3869
-     */
3870
-    private function _extract_related_model_info_from_query_param(
3871
-        $query_param,
3872
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3873
-        $query_param_type,
3874
-        $original_query_param = null
3875
-    ) {
3876
-        if ($original_query_param === null) {
3877
-            $original_query_param = $query_param;
3878
-        }
3879
-        $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3880
-        /** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3881
-        $allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3882
-        $allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3883
-        //check to see if we have a field on this model
3884
-        $this_model_fields = $this->field_settings(true);
3885
-        if (array_key_exists($query_param, $this_model_fields)) {
3886
-            if ($allow_fields) {
3887
-                return;
3888
-            }
3889
-            throw new EE_Error(
3890
-                sprintf(
3891
-                    __(
3892
-                        "Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
3893
-                        "event_espresso"
3894
-                    ),
3895
-                    $query_param, get_class($this), $query_param_type, $original_query_param
3896
-                )
3897
-            );
3898
-        }
3899
-        //check if this is a special logic query param
3900
-        if (in_array($query_param, $this->_logic_query_param_keys, true)) {
3901
-            if ($allow_logic_query_params) {
3902
-                return;
3903
-            }
3904
-            throw new EE_Error(
3905
-                sprintf(
3906
-                    __(
3907
-                        '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',
3908
-                        'event_espresso'
3909
-                    ),
3910
-                    implode('", "', $this->_logic_query_param_keys),
3911
-                    $query_param,
3912
-                    get_class($this),
3913
-                    '<br />',
3914
-                    "\t"
3915
-                    . ' $passed_in_query_info = <pre>'
3916
-                    . print_r($passed_in_query_info, true)
3917
-                    . '</pre>'
3918
-                    . "\n\t"
3919
-                    . ' $query_param_type = '
3920
-                    . $query_param_type
3921
-                    . "\n\t"
3922
-                    . ' $original_query_param = '
3923
-                    . $original_query_param
3924
-                )
3925
-            );
3926
-        }
3927
-        //check if it's a custom selection
3928
-        if (array_key_exists($query_param, $this->_custom_selections)) {
3929
-            return;
3930
-        }
3931
-        //check if has a model name at the beginning
3932
-        //and
3933
-        //check if it's a field on a related model
3934
-        foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3935
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3936
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3937
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
3938
-                if ($query_param === '') {
3939
-                    //nothing left to $query_param
3940
-                    //we should actually end in a field name, not a model like this!
3941
-                    throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3942
-                        "event_espresso"),
3943
-                        $query_param, $query_param_type, get_class($this), $valid_related_model_name));
3944
-                }
3945
-                $related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3946
-                $related_model_obj->_extract_related_model_info_from_query_param(
3947
-                    $query_param,
3948
-                    $passed_in_query_info, $query_param_type, $original_query_param
3949
-                );
3950
-                return;
3951
-            }
3952
-            if ($query_param === $valid_related_model_name) {
3953
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3954
-                return;
3955
-            }
3956
-        }
3957
-        //ok so $query_param didn't start with a model name
3958
-        //and we previously confirmed it wasn't a logic query param or field on the current model
3959
-        //it's wack, that's what it is
3960
-        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",
3961
-            "event_espresso"),
3962
-            $query_param, get_class($this), $query_param_type, $original_query_param));
3963
-    }
3964
-
3965
-
3966
-
3967
-    /**
3968
-     * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3969
-     * and store it on $passed_in_query_info
3970
-     *
3971
-     * @param string                      $model_name
3972
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3973
-     * @param string                      $original_query_param used to extract the relation chain between the queried
3974
-     *                                                          model and $model_name. Eg, if we are querying Event,
3975
-     *                                                          and are adding a join to 'Payment' with the original
3976
-     *                                                          query param key
3977
-     *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3978
-     *                                                          to extract 'Registration.Transaction.Payment', in case
3979
-     *                                                          Payment wants to add default query params so that it
3980
-     *                                                          will know what models to prepend onto its default query
3981
-     *                                                          params or in case it wants to rename tables (in case
3982
-     *                                                          there are multiple joins to the same table)
3983
-     * @return void
3984
-     * @throws EE_Error
3985
-     */
3986
-    private function _add_join_to_model(
3987
-        $model_name,
3988
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3989
-        $original_query_param
3990
-    ) {
3991
-        $relation_obj = $this->related_settings_for($model_name);
3992
-        $model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3993
-        //check if the relation is HABTM, because then we're essentially doing two joins
3994
-        //If so, join first to the JOIN table, and add its data types, and then continue as normal
3995
-        if ($relation_obj instanceof EE_HABTM_Relation) {
3996
-            $join_model_obj = $relation_obj->get_join_model();
3997
-            //replace the model specified with the join model for this relation chain, whi
3998
-            $relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
3999
-                $join_model_obj->get_this_model_name(), $model_relation_chain);
4000
-            $new_query_info = new EE_Model_Query_Info_Carrier(
4001
-                array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
4002
-                $relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model));
4003
-            $passed_in_query_info->merge($new_query_info);
4004
-        }
4005
-        //now just join to the other table pointed to by the relation object, and add its data types
4006
-        $new_query_info = new EE_Model_Query_Info_Carrier(
4007
-            array($model_relation_chain => $model_name),
4008
-            $relation_obj->get_join_statement($model_relation_chain));
4009
-        $passed_in_query_info->merge($new_query_info);
4010
-    }
4011
-
4012
-
4013
-
4014
-    /**
4015
-     * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
4016
-     *
4017
-     * @param array $where_params like EEM_Base::get_all
4018
-     * @return string of SQL
4019
-     * @throws EE_Error
4020
-     */
4021
-    private function _construct_where_clause($where_params)
4022
-    {
4023
-        $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
4024
-        if ($SQL) {
4025
-            return " WHERE " . $SQL;
4026
-        }
4027
-        return '';
4028
-    }
4029
-
4030
-
4031
-
4032
-    /**
4033
-     * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
4034
-     * and should be passed HAVING parameters, not WHERE parameters
4035
-     *
4036
-     * @param array $having_params
4037
-     * @return string
4038
-     * @throws EE_Error
4039
-     */
4040
-    private function _construct_having_clause($having_params)
4041
-    {
4042
-        $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
4043
-        if ($SQL) {
4044
-            return " HAVING " . $SQL;
4045
-        }
4046
-        return '';
4047
-    }
4048
-
4049
-
4050
-
4051
-    /**
4052
-     * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
4053
-     * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
4054
-     * EEM_Attendee.
4055
-     *
4056
-     * @param string $field_name
4057
-     * @param string $model_name
4058
-     * @return EE_Model_Field_Base
4059
-     * @throws EE_Error
4060
-     */
4061
-    protected function _get_field_on_model($field_name, $model_name)
4062
-    {
4063
-        $model_class = 'EEM_' . $model_name;
4064
-        $model_filepath = $model_class . ".model.php";
4065
-        if (is_readable($model_filepath)) {
4066
-            require_once($model_filepath);
4067
-            $model_instance = call_user_func($model_name . "::instance");
4068
-            /* @var $model_instance EEM_Base */
4069
-            return $model_instance->field_settings_for($field_name);
4070
-        }
4071
-        throw new EE_Error(
4072
-            sprintf(
4073
-                __(
4074
-                    'No model named %s exists, with classname %s and filepath %s',
4075
-                    'event_espresso'
4076
-                ), $model_name, $model_class, $model_filepath
4077
-            )
4078
-        );
4079
-    }
4080
-
4081
-
4082
-
4083
-    /**
4084
-     * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
4085
-     * Event_Meta.meta_value = 'foo'))"
4086
-     *
4087
-     * @param array  $where_params see EEM_Base::get_all for documentation
4088
-     * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
4089
-     * @throws EE_Error
4090
-     * @return string of SQL
4091
-     */
4092
-    private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
4093
-    {
4094
-        $where_clauses = array();
4095
-        foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
4096
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
4097
-            if (in_array($query_param, $this->_logic_query_param_keys)) {
4098
-                switch ($query_param) {
4099
-                    case 'not':
4100
-                    case 'NOT':
4101
-                        $where_clauses[] = "! ("
4102
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4103
-                                $glue)
4104
-                                           . ")";
4105
-                        break;
4106
-                    case 'and':
4107
-                    case 'AND':
4108
-                        $where_clauses[] = " ("
4109
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4110
-                                ' AND ')
4111
-                                           . ")";
4112
-                        break;
4113
-                    case 'or':
4114
-                    case 'OR':
4115
-                        $where_clauses[] = " ("
4116
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4117
-                                ' OR ')
4118
-                                           . ")";
4119
-                        break;
4120
-                }
4121
-            } else {
4122
-                $field_obj = $this->_deduce_field_from_query_param($query_param);
4123
-                //if it's not a normal field, maybe it's a custom selection?
4124
-                if (! $field_obj) {
4125
-                    if (isset($this->_custom_selections[$query_param][1])) {
4126
-                        $field_obj = $this->_custom_selections[$query_param][1];
4127
-                    } else {
4128
-                        throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
4129
-                            "event_espresso"), $query_param));
4130
-                    }
4131
-                }
4132
-                $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
4133
-                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
4134
-            }
4135
-        }
4136
-        return $where_clauses ? implode($glue, $where_clauses) : '';
4137
-    }
4138
-
4139
-
4140
-
4141
-    /**
4142
-     * Takes the input parameter and extract the table name (alias) and column name
4143
-     *
4144
-     * @param string $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4145
-     * @throws EE_Error
4146
-     * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
4147
-     */
4148
-    private function _deduce_column_name_from_query_param($query_param)
4149
-    {
4150
-        $field = $this->_deduce_field_from_query_param($query_param);
4151
-        if ($field) {
4152
-            $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4153
-                $query_param);
4154
-            return $table_alias_prefix . $field->get_qualified_column();
4155
-        }
4156
-        if (array_key_exists($query_param, $this->_custom_selections)) {
4157
-            //maybe it's custom selection item?
4158
-            //if so, just use it as the "column name"
4159
-            return $query_param;
4160
-        }
4161
-        throw new EE_Error(
4162
-            sprintf(
4163
-                __(
4164
-                    "%s is not a valid field on this model, nor a custom selection (%s)",
4165
-                    "event_espresso"
4166
-                ), $query_param, implode(",", $this->_custom_selections)
4167
-            )
4168
-        );
4169
-    }
4170
-
4171
-
4172
-
4173
-    /**
4174
-     * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
4175
-     * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
4176
-     * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
4177
-     * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
4178
-     *
4179
-     * @param string $condition_query_param_key
4180
-     * @return string
4181
-     */
4182
-    private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
4183
-    {
4184
-        $pos_of_star = strpos($condition_query_param_key, '*');
4185
-        if ($pos_of_star === false) {
4186
-            return $condition_query_param_key;
4187
-        }
4188
-        $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
4189
-        return $condition_query_param_sans_star;
4190
-    }
4191
-
4192
-
4193
-
4194
-    /**
4195
-     * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
4196
-     *
4197
-     * @param                            mixed      array | string    $op_and_value
4198
-     * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
4199
-     * @throws EE_Error
4200
-     * @return string
4201
-     */
4202
-    private function _construct_op_and_value($op_and_value, $field_obj)
4203
-    {
4204
-        if (is_array($op_and_value)) {
4205
-            $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4206
-            if (! $operator) {
4207
-                $php_array_like_string = array();
4208
-                foreach ($op_and_value as $key => $value) {
4209
-                    $php_array_like_string[] = "$key=>$value";
4210
-                }
4211
-                throw new EE_Error(
4212
-                    sprintf(
4213
-                        __(
4214
-                            "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))",
4215
-                            "event_espresso"
4216
-                        ),
4217
-                        implode(",", $php_array_like_string)
4218
-                    )
4219
-                );
4220
-            }
4221
-            $value = isset($op_and_value[1]) ? $op_and_value[1] : null;
4222
-        } else {
4223
-            $operator = '=';
4224
-            $value = $op_and_value;
4225
-        }
4226
-        //check to see if the value is actually another field
4227
-        if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4228
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4229
-        }
4230
-        if (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4231
-            //in this case, the value should be an array, or at least a comma-separated list
4232
-            //it will need to handle a little differently
4233
-            $cleaned_value = $this->_construct_in_value($value, $field_obj);
4234
-            //note: $cleaned_value has already been run through $wpdb->prepare()
4235
-            return $operator . SP . $cleaned_value;
4236
-        }
4237
-        if (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4238
-            //the value should be an array with count of two.
4239
-            if (count($value) !== 2) {
4240
-                throw new EE_Error(
4241
-                    sprintf(
4242
-                        __(
4243
-                            "The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
4244
-                            'event_espresso'
4245
-                        ),
4246
-                        "BETWEEN"
4247
-                    )
4248
-                );
4249
-            }
4250
-            $cleaned_value = $this->_construct_between_value($value, $field_obj);
4251
-            return $operator . SP . $cleaned_value;
4252
-        }
4253
-        if (in_array($operator, $this->_null_style_operators)) {
4254
-            if ($value !== null) {
4255
-                throw new EE_Error(
4256
-                    sprintf(
4257
-                        __(
4258
-                            "You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
4259
-                            "event_espresso"
4260
-                        ),
4261
-                        $value,
4262
-                        $operator
4263
-                    )
4264
-                );
4265
-            }
4266
-            return $operator;
4267
-        }
4268
-        if ($operator === 'LIKE' && ! is_array($value)) {
4269
-            //if the operator is 'LIKE', we want to allow percent signs (%) and not
4270
-            //remove other junk. So just treat it as a string.
4271
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4272
-        }
4273
-        if (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4274
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4275
-        }
4276
-        if (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4277
-            throw new EE_Error(
4278
-                sprintf(
4279
-                    __(
4280
-                        "Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
4281
-                        'event_espresso'
4282
-                    ),
4283
-                    $operator,
4284
-                    $operator
4285
-                )
4286
-            );
4287
-        }
4288
-        if (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4289
-            throw new EE_Error(
4290
-                sprintf(
4291
-                    __(
4292
-                        "Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
4293
-                        'event_espresso'
4294
-                    ),
4295
-                    $operator,
4296
-                    $operator
4297
-                )
4298
-            );
4299
-        }
4300
-        throw new EE_Error(
4301
-            sprintf(
4302
-                __(
4303
-                    "It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
4304
-                    "event_espresso"
4305
-                ),
4306
-                http_build_query($op_and_value)
4307
-            )
4308
-        );
4309
-    }
4310
-
4311
-
4312
-
4313
-    /**
4314
-     * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
4315
-     *
4316
-     * @param array                      $values
4317
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
4318
-     *                                              '%s'
4319
-     * @return string
4320
-     * @throws EE_Error
4321
-     */
4322
-    public function _construct_between_value($values, $field_obj)
4323
-    {
4324
-        $cleaned_values = array();
4325
-        foreach ($values as $value) {
4326
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4327
-        }
4328
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
4329
-    }
4330
-
4331
-
4332
-
4333
-    /**
4334
-     * Takes an array or a comma-separated list of $values and cleans them
4335
-     * according to $data_type using $wpdb->prepare, and then makes the list a
4336
-     * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4337
-     * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4338
-     * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4339
-     *
4340
-     * @param mixed                      $values    array or comma-separated string
4341
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4342
-     * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4343
-     * @throws EE_Error
4344
-     */
4345
-    public function _construct_in_value($values, $field_obj)
4346
-    {
4347
-        //check if the value is a CSV list
4348
-        if (is_string($values)) {
4349
-            //in which case, turn it into an array
4350
-            $values = explode(",", $values);
4351
-        }
4352
-        $cleaned_values = array();
4353
-        foreach ($values as $value) {
4354
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4355
-        }
4356
-        //we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4357
-        //but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4358
-        //which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4359
-        if (empty($cleaned_values)) {
4360
-            $all_fields = $this->field_settings();
4361
-            $a_field = array_shift($all_fields);
4362
-            $main_table = $this->_get_main_table();
4363
-            $cleaned_values[] = "SELECT "
4364
-                                . $a_field->get_table_column()
4365
-                                . " FROM "
4366
-                                . $main_table->get_table_name()
4367
-                                . " WHERE FALSE";
4368
-        }
4369
-        return "(" . implode(",", $cleaned_values) . ")";
4370
-    }
4371
-
4372
-
4373
-
4374
-    /**
4375
-     * @param mixed                      $value
4376
-     * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4377
-     * @throws EE_Error
4378
-     * @return false|null|string
4379
-     */
4380
-    private function _wpdb_prepare_using_field($value, $field_obj)
4381
-    {
4382
-        /** @type WPDB $wpdb */
4383
-        global $wpdb;
4384
-        if ($field_obj instanceof EE_Model_Field_Base) {
4385
-            return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4386
-                $this->_prepare_value_for_use_in_db($value, $field_obj));
4387
-        } //$field_obj should really just be a data type
4388
-        if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4389
-            throw new EE_Error(
4390
-                sprintf(
4391
-                    __("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4392
-                    $field_obj, implode(",", $this->_valid_wpdb_data_types)
4393
-                )
4394
-            );
4395
-        }
4396
-        return $wpdb->prepare($field_obj, $value);
4397
-    }
4398
-
4399
-
4400
-
4401
-    /**
4402
-     * Takes the input parameter and finds the model field that it indicates.
4403
-     *
4404
-     * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4405
-     * @throws EE_Error
4406
-     * @return EE_Model_Field_Base
4407
-     */
4408
-    protected function _deduce_field_from_query_param($query_param_name)
4409
-    {
4410
-        //ok, now proceed with deducing which part is the model's name, and which is the field's name
4411
-        //which will help us find the database table and column
4412
-        $query_param_parts = explode(".", $query_param_name);
4413
-        if (empty($query_param_parts)) {
4414
-            throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4415
-                'event_espresso'), $query_param_name));
4416
-        }
4417
-        $number_of_parts = count($query_param_parts);
4418
-        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4419
-        if ($number_of_parts === 1) {
4420
-            $field_name = $last_query_param_part;
4421
-            $model_obj = $this;
4422
-        } else {// $number_of_parts >= 2
4423
-            //the last part is the column name, and there are only 2parts. therefore...
4424
-            $field_name = $last_query_param_part;
4425
-            $model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4426
-        }
4427
-        try {
4428
-            return $model_obj->field_settings_for($field_name);
4429
-        } catch (EE_Error $e) {
4430
-            return null;
4431
-        }
4432
-    }
4433
-
4434
-
4435
-
4436
-    /**
4437
-     * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4438
-     * alias and column which corresponds to it
4439
-     *
4440
-     * @param string $field_name
4441
-     * @throws EE_Error
4442
-     * @return string
4443
-     */
4444
-    public function _get_qualified_column_for_field($field_name)
4445
-    {
4446
-        $all_fields = $this->field_settings();
4447
-        $field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4448
-        if ($field) {
4449
-            return $field->get_qualified_column();
4450
-        }
4451
-        throw new EE_Error(
4452
-            sprintf(
4453
-                __(
4454
-                    "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.",
4455
-                    'event_espresso'
4456
-                ), $field_name, get_class($this)
4457
-            )
4458
-        );
4459
-    }
4460
-
4461
-
4462
-
4463
-    /**
4464
-     * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
4465
-     * Example usage:
4466
-     * EEM_Ticket::instance()->get_all_wpdb_results(
4467
-     *      array(),
4468
-     *      ARRAY_A,
4469
-     *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
4470
-     *  );
4471
-     * is equivalent to
4472
-     *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
4473
-     * and
4474
-     *  EEM_Event::instance()->get_all_wpdb_results(
4475
-     *      array(
4476
-     *          array(
4477
-     *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
4478
-     *          ),
4479
-     *          ARRAY_A,
4480
-     *          implode(
4481
-     *              ', ',
4482
-     *              array_merge(
4483
-     *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
4484
-     *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
4485
-     *              )
4486
-     *          )
4487
-     *      )
4488
-     *  );
4489
-     * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
4490
-     *
4491
-     * @param string $model_relation_chain        the chain of models used to join between the model you want to query
4492
-     *                                            and the one whose fields you are selecting for example: when querying
4493
-     *                                            tickets model and selecting fields from the tickets model you would
4494
-     *                                            leave this parameter empty, because no models are needed to join
4495
-     *                                            between the queried model and the selected one. Likewise when
4496
-     *                                            querying the datetime model and selecting fields from the tickets
4497
-     *                                            model, it would also be left empty, because there is a direct
4498
-     *                                            relation from datetimes to tickets, so no model is needed to join
4499
-     *                                            them together. However, when querying from the event model and
4500
-     *                                            selecting fields from the ticket model, you should provide the string
4501
-     *                                            'Datetime', indicating that the event model must first join to the
4502
-     *                                            datetime model in order to find its relation to ticket model.
4503
-     *                                            Also, when querying from the venue model and selecting fields from
4504
-     *                                            the ticket model, you should provide the string 'Event.Datetime',
4505
-     *                                            indicating you need to join the venue model to the event model,
4506
-     *                                            to the datetime model, in order to find its relation to the ticket model.
4507
-     *                                            This string is used to deduce the prefix that gets added onto the
4508
-     *                                            models' tables qualified columns
4509
-     * @param bool   $return_string               if true, will return a string with qualified column names separated
4510
-     *                                            by ', ' if false, will simply return a numerically indexed array of
4511
-     *                                            qualified column names
4512
-     * @return array|string
4513
-     */
4514
-    public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4515
-    {
4516
-        $table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4517
-        $qualified_columns = array();
4518
-        foreach ($this->field_settings() as $field_name => $field) {
4519
-            $qualified_columns[] = $table_prefix . $field->get_qualified_column();
4520
-        }
4521
-        return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4522
-    }
4523
-
4524
-
4525
-
4526
-    /**
4527
-     * constructs the select use on special limit joins
4528
-     * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4529
-     * its setup so the select query will be setup on and just doing the special select join off of the primary table
4530
-     * (as that is typically where the limits would be set).
4531
-     *
4532
-     * @param  string       $table_alias The table the select is being built for
4533
-     * @param  mixed|string $limit       The limit for this select
4534
-     * @return string                The final select join element for the query.
4535
-     */
4536
-    public function _construct_limit_join_select($table_alias, $limit)
4537
-    {
4538
-        $SQL = '';
4539
-        foreach ($this->_tables as $table_obj) {
4540
-            if ($table_obj instanceof EE_Primary_Table) {
4541
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4542
-                    ? $table_obj->get_select_join_limit($limit)
4543
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4544
-            } elseif ($table_obj instanceof EE_Secondary_Table) {
4545
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4546
-                    ? $table_obj->get_select_join_limit_join($limit)
4547
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
4548
-            }
4549
-        }
4550
-        return $SQL;
4551
-    }
4552
-
4553
-
4554
-
4555
-    /**
4556
-     * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4557
-     * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4558
-     *
4559
-     * @return string SQL
4560
-     * @throws EE_Error
4561
-     */
4562
-    public function _construct_internal_join()
4563
-    {
4564
-        $SQL = $this->_get_main_table()->get_table_sql();
4565
-        $SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4566
-        return $SQL;
4567
-    }
4568
-
4569
-
4570
-
4571
-    /**
4572
-     * Constructs the SQL for joining all the tables on this model.
4573
-     * Normally $alias should be the primary table's alias, but in cases where
4574
-     * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4575
-     * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4576
-     * alias, this will construct SQL like:
4577
-     * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4578
-     * With $alias being a secondary table's alias, this will construct SQL like:
4579
-     * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4580
-     *
4581
-     * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4582
-     * @return string
4583
-     */
4584
-    public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4585
-    {
4586
-        $SQL = '';
4587
-        $alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4588
-        foreach ($this->_tables as $table_obj) {
4589
-            if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4590
-                if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4591
-                    //so we're joining to this table, meaning the table is already in
4592
-                    //the FROM statement, BUT the primary table isn't. So we want
4593
-                    //to add the inverse join sql
4594
-                    $SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4595
-                } else {
4596
-                    //just add a regular JOIN to this table from the primary table
4597
-                    $SQL .= $table_obj->get_join_sql($alias_prefixed);
4598
-                }
4599
-            }//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4600
-        }
4601
-        return $SQL;
4602
-    }
4603
-
4604
-
4605
-
4606
-    /**
4607
-     * Gets an array for storing all the data types on the next-to-be-executed-query.
4608
-     * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4609
-     * their data type (eg, '%s', '%d', etc)
4610
-     *
4611
-     * @return array
4612
-     */
4613
-    public function _get_data_types()
4614
-    {
4615
-        $data_types = array();
4616
-        foreach ($this->field_settings() as $field_obj) {
4617
-            //$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4618
-            /** @var $field_obj EE_Model_Field_Base */
4619
-            $data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4620
-        }
4621
-        return $data_types;
4622
-    }
4623
-
4624
-
4625
-
4626
-    /**
4627
-     * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4628
-     *
4629
-     * @param string $model_name
4630
-     * @throws EE_Error
4631
-     * @return EEM_Base
4632
-     */
4633
-    public function get_related_model_obj($model_name)
4634
-    {
4635
-        $model_classname = "EEM_" . $model_name;
4636
-        if (! class_exists($model_classname)) {
4637
-            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",
4638
-                'event_espresso'), $model_name, $model_classname));
4639
-        }
4640
-        return call_user_func($model_classname . "::instance");
4641
-    }
4642
-
4643
-
4644
-
4645
-    /**
4646
-     * Returns the array of EE_ModelRelations for this model.
4647
-     *
4648
-     * @return EE_Model_Relation_Base[]
4649
-     */
4650
-    public function relation_settings()
4651
-    {
4652
-        return $this->_model_relations;
4653
-    }
4654
-
4655
-
4656
-
4657
-    /**
4658
-     * Gets all related models that this model BELONGS TO. Handy to know sometimes
4659
-     * because without THOSE models, this model probably doesn't have much purpose.
4660
-     * (Eg, without an event, datetimes have little purpose.)
4661
-     *
4662
-     * @return EE_Belongs_To_Relation[]
4663
-     */
4664
-    public function belongs_to_relations()
4665
-    {
4666
-        $belongs_to_relations = array();
4667
-        foreach ($this->relation_settings() as $model_name => $relation_obj) {
4668
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
4669
-                $belongs_to_relations[$model_name] = $relation_obj;
4670
-            }
4671
-        }
4672
-        return $belongs_to_relations;
4673
-    }
4674
-
4675
-
4676
-
4677
-    /**
4678
-     * Returns the specified EE_Model_Relation, or throws an exception
4679
-     *
4680
-     * @param string $relation_name name of relation, key in $this->_relatedModels
4681
-     * @throws EE_Error
4682
-     * @return EE_Model_Relation_Base
4683
-     */
4684
-    public function related_settings_for($relation_name)
4685
-    {
4686
-        $relatedModels = $this->relation_settings();
4687
-        if (! array_key_exists($relation_name, $relatedModels)) {
4688
-            throw new EE_Error(
4689
-                sprintf(
4690
-                    __('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4691
-                        'event_espresso'),
4692
-                    $relation_name,
4693
-                    $this->_get_class_name(),
4694
-                    implode(', ', array_keys($relatedModels))
4695
-                )
4696
-            );
4697
-        }
4698
-        return $relatedModels[$relation_name];
4699
-    }
4700
-
4701
-
4702
-
4703
-    /**
4704
-     * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4705
-     * fields
4706
-     *
4707
-     * @param string $fieldName
4708
-     * @throws EE_Error
4709
-     * @return EE_Model_Field_Base
4710
-     */
4711
-    public function field_settings_for($fieldName)
4712
-    {
4713
-        $fieldSettings = $this->field_settings(true);
4714
-        if (! array_key_exists($fieldName, $fieldSettings)) {
4715
-            throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4716
-                get_class($this)));
4717
-        }
4718
-        return $fieldSettings[$fieldName];
4719
-    }
4720
-
4721
-
4722
-
4723
-    /**
4724
-     * Checks if this field exists on this model
4725
-     *
4726
-     * @param string $fieldName a key in the model's _field_settings array
4727
-     * @return boolean
4728
-     */
4729
-    public function has_field($fieldName)
4730
-    {
4731
-        $fieldSettings = $this->field_settings(true);
4732
-        if (isset($fieldSettings[$fieldName])) {
4733
-            return true;
4734
-        }
4735
-        return false;
4736
-    }
4737
-
4738
-
4739
-
4740
-    /**
4741
-     * Returns whether or not this model has a relation to the specified model
4742
-     *
4743
-     * @param string $relation_name possibly one of the keys in the relation_settings array
4744
-     * @return boolean
4745
-     */
4746
-    public function has_relation($relation_name)
4747
-    {
4748
-        $relations = $this->relation_settings();
4749
-        if (isset($relations[$relation_name])) {
4750
-            return true;
4751
-        }
4752
-        return false;
4753
-    }
4754
-
4755
-
4756
-
4757
-    /**
4758
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4759
-     * Eg, on EE_Answer that would be ANS_ID field object
4760
-     *
4761
-     * @param $field_obj
4762
-     * @return boolean
4763
-     */
4764
-    public function is_primary_key_field($field_obj)
4765
-    {
4766
-        return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4767
-    }
4768
-
4769
-
4770
-
4771
-    /**
4772
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4773
-     * Eg, on EE_Answer that would be ANS_ID field object
4774
-     *
4775
-     * @return EE_Model_Field_Base
4776
-     * @throws EE_Error
4777
-     */
4778
-    public function get_primary_key_field()
4779
-    {
4780
-        if ($this->_primary_key_field === null) {
4781
-            foreach ($this->field_settings(true) as $field_obj) {
4782
-                if ($this->is_primary_key_field($field_obj)) {
4783
-                    $this->_primary_key_field = $field_obj;
4784
-                    break;
4785
-                }
4786
-            }
4787
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4788
-                throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4789
-                    get_class($this)));
4790
-            }
4791
-        }
4792
-        return $this->_primary_key_field;
4793
-    }
4794
-
4795
-
4796
-
4797
-    /**
4798
-     * Returns whether or not not there is a primary key on this model.
4799
-     * Internally does some caching.
4800
-     *
4801
-     * @return boolean
4802
-     */
4803
-    public function has_primary_key_field()
4804
-    {
4805
-        if ($this->_has_primary_key_field === null) {
4806
-            try {
4807
-                $this->get_primary_key_field();
4808
-                $this->_has_primary_key_field = true;
4809
-            } catch (EE_Error $e) {
4810
-                $this->_has_primary_key_field = false;
4811
-            }
4812
-        }
4813
-        return $this->_has_primary_key_field;
4814
-    }
4815
-
4816
-
4817
-
4818
-    /**
4819
-     * Finds the first field of type $field_class_name.
4820
-     *
4821
-     * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4822
-     *                                 EE_Foreign_Key_Field, etc
4823
-     * @return EE_Model_Field_Base or null if none is found
4824
-     */
4825
-    public function get_a_field_of_type($field_class_name)
4826
-    {
4827
-        foreach ($this->field_settings() as $field) {
4828
-            if ($field instanceof $field_class_name) {
4829
-                return $field;
4830
-            }
4831
-        }
4832
-        return null;
4833
-    }
4834
-
4835
-
4836
-
4837
-    /**
4838
-     * Gets a foreign key field pointing to model.
4839
-     *
4840
-     * @param string $model_name eg Event, Registration, not EEM_Event
4841
-     * @return EE_Foreign_Key_Field_Base
4842
-     * @throws EE_Error
4843
-     */
4844
-    public function get_foreign_key_to($model_name)
4845
-    {
4846
-        if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4847
-            foreach ($this->field_settings() as $field) {
4848
-                if (
4849
-                    $field instanceof EE_Foreign_Key_Field_Base
4850
-                    && in_array($model_name, $field->get_model_names_pointed_to())
4851
-                ) {
4852
-                    $this->_cache_foreign_key_to_fields[$model_name] = $field;
4853
-                    break;
4854
-                }
4855
-            }
4856
-            if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4857
-                throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4858
-                    'event_espresso'), $model_name, get_class($this)));
4859
-            }
4860
-        }
4861
-        return $this->_cache_foreign_key_to_fields[$model_name];
4862
-    }
4863
-
4864
-
4865
-
4866
-    /**
4867
-     * Gets the table name (including $wpdb->prefix) for the table alias
4868
-     *
4869
-     * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4870
-     *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4871
-     *                            Either one works
4872
-     * @return string
4873
-     */
4874
-    public function get_table_for_alias($table_alias)
4875
-    {
4876
-        $table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4877
-        return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4878
-    }
4879
-
4880
-
4881
-
4882
-    /**
4883
-     * Returns a flat array of all field son this model, instead of organizing them
4884
-     * by table_alias as they are in the constructor.
4885
-     *
4886
-     * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4887
-     * @return EE_Model_Field_Base[] where the keys are the field's name
4888
-     */
4889
-    public function field_settings($include_db_only_fields = false)
4890
-    {
4891
-        if ($include_db_only_fields) {
4892
-            if ($this->_cached_fields === null) {
4893
-                $this->_cached_fields = array();
4894
-                foreach ($this->_fields as $fields_corresponding_to_table) {
4895
-                    foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4896
-                        $this->_cached_fields[$field_name] = $field_obj;
4897
-                    }
4898
-                }
4899
-            }
4900
-            return $this->_cached_fields;
4901
-        }
4902
-        if ($this->_cached_fields_non_db_only === null) {
4903
-            $this->_cached_fields_non_db_only = array();
4904
-            foreach ($this->_fields as $fields_corresponding_to_table) {
4905
-                foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4906
-                    /** @var $field_obj EE_Model_Field_Base */
4907
-                    if (! $field_obj->is_db_only_field()) {
4908
-                        $this->_cached_fields_non_db_only[$field_name] = $field_obj;
4909
-                    }
4910
-                }
4911
-            }
4912
-        }
4913
-        return $this->_cached_fields_non_db_only;
4914
-    }
4915
-
4916
-
4917
-
4918
-    /**
4919
-     *        cycle though array of attendees and create objects out of each item
4920
-     *
4921
-     * @access        private
4922
-     * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4923
-     * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4924
-     *                           numerically indexed)
4925
-     * @throws EE_Error
4926
-     */
4927
-    protected function _create_objects($rows = array())
4928
-    {
4929
-        $array_of_objects = array();
4930
-        if (empty($rows)) {
4931
-            return array();
4932
-        }
4933
-        $count_if_model_has_no_primary_key = 0;
4934
-        $has_primary_key = $this->has_primary_key_field();
4935
-        $primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4936
-        foreach ((array)$rows as $row) {
4937
-            if (empty($row)) {
4938
-                //wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4939
-                return array();
4940
-            }
4941
-            //check if we've already set this object in the results array,
4942
-            //in which case there's no need to process it further (again)
4943
-            if ($has_primary_key) {
4944
-                $table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4945
-                    $row,
4946
-                    $primary_key_field->get_qualified_column(),
4947
-                    $primary_key_field->get_table_column()
4948
-                );
4949
-                if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4950
-                    continue;
4951
-                }
4952
-            }
4953
-            $classInstance = $this->instantiate_class_from_array_or_object($row);
4954
-            if (! $classInstance) {
4955
-                throw new EE_Error(
4956
-                    sprintf(
4957
-                        __('Could not create instance of class %s from row %s', 'event_espresso'),
4958
-                        $this->get_this_model_name(),
4959
-                        http_build_query($row)
4960
-                    )
4961
-                );
4962
-            }
4963
-            //set the timezone on the instantiated objects
4964
-            $classInstance->set_timezone($this->_timezone);
4965
-            //make sure if there is any timezone setting present that we set the timezone for the object
4966
-            $key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4967
-            $array_of_objects[$key] = $classInstance;
4968
-            //also, for all the relations of type BelongsTo, see if we can cache
4969
-            //those related models
4970
-            //(we could do this for other relations too, but if there are conditions
4971
-            //that filtered out some fo the results, then we'd be caching an incomplete set
4972
-            //so it requires a little more thought than just caching them immediately...)
4973
-            foreach ($this->_model_relations as $modelName => $relation_obj) {
4974
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
4975
-                    //check if this model's INFO is present. If so, cache it on the model
4976
-                    $other_model = $relation_obj->get_other_model();
4977
-                    $other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4978
-                    //if we managed to make a model object from the results, cache it on the main model object
4979
-                    if ($other_model_obj_maybe) {
4980
-                        //set timezone on these other model objects if they are present
4981
-                        $other_model_obj_maybe->set_timezone($this->_timezone);
4982
-                        $classInstance->cache($modelName, $other_model_obj_maybe);
4983
-                    }
4984
-                }
4985
-            }
4986
-        }
4987
-        return $array_of_objects;
4988
-    }
4989
-
4990
-
4991
-
4992
-    /**
4993
-     * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4994
-     * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4995
-     * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4996
-     * object (as set in the model_field!).
4997
-     *
4998
-     * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4999
-     */
5000
-    public function create_default_object()
5001
-    {
5002
-        $this_model_fields_and_values = array();
5003
-        //setup the row using default values;
5004
-        foreach ($this->field_settings() as $field_name => $field_obj) {
5005
-            $this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
5006
-        }
5007
-        $className = $this->_get_class_name();
5008
-        $classInstance = EE_Registry::instance()
5009
-                                    ->load_class($className, array($this_model_fields_and_values), false, false);
5010
-        return $classInstance;
5011
-    }
5012
-
5013
-
5014
-
5015
-    /**
5016
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
5017
-     *                             or an stdClass where each property is the name of a column,
5018
-     * @return EE_Base_Class
5019
-     * @throws EE_Error
5020
-     */
5021
-    public function instantiate_class_from_array_or_object($cols_n_values)
5022
-    {
5023
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
5024
-            $cols_n_values = get_object_vars($cols_n_values);
5025
-        }
5026
-        $primary_key = null;
5027
-        //make sure the array only has keys that are fields/columns on this model
5028
-        $this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5029
-        if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
5030
-            $primary_key = $this_model_fields_n_values[$this->primary_key_name()];
5031
-        }
5032
-        $className = $this->_get_class_name();
5033
-        //check we actually found results that we can use to build our model object
5034
-        //if not, return null
5035
-        if ($this->has_primary_key_field()) {
5036
-            if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
5037
-                return null;
5038
-            }
5039
-        } else if ($this->unique_indexes()) {
5040
-            $first_column = reset($this_model_fields_n_values);
5041
-            if (empty($first_column)) {
5042
-                return null;
5043
-            }
5044
-        }
5045
-        // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
5046
-        if ($primary_key) {
5047
-            $classInstance = $this->get_from_entity_map($primary_key);
5048
-            if (! $classInstance) {
5049
-                $classInstance = EE_Registry::instance()
5050
-                                            ->load_class($className,
5051
-                                                array($this_model_fields_n_values, $this->_timezone), true, false);
5052
-                // add this new object to the entity map
5053
-                $classInstance = $this->add_to_entity_map($classInstance);
5054
-            }
5055
-        } else {
5056
-            $classInstance = EE_Registry::instance()
5057
-                                        ->load_class($className, array($this_model_fields_n_values, $this->_timezone),
5058
-                                            true, false);
5059
-        }
5060
-        //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.
5061
-        $this->set_timezone($classInstance->get_timezone());
5062
-        return $classInstance;
5063
-    }
5064
-
5065
-
5066
-
5067
-    /**
5068
-     * Gets the model object from the  entity map if it exists
5069
-     *
5070
-     * @param int|string $id the ID of the model object
5071
-     * @return EE_Base_Class
5072
-     */
5073
-    public function get_from_entity_map($id)
5074
-    {
5075
-        return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
5076
-            ? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
5077
-    }
5078
-
5079
-
5080
-
5081
-    /**
5082
-     * add_to_entity_map
5083
-     * Adds the object to the model's entity mappings
5084
-     *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
5085
-     *        and for the remainder of the request, it's even more up-to-date than what's in the database.
5086
-     *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
5087
-     *        If the database gets updated directly and you want the entity mapper to reflect that change,
5088
-     *        then this method should be called immediately after the update query
5089
-     * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
5090
-     * so on multisite, the entity map is specific to the query being done for a specific site.
5091
-     *
5092
-     * @param    EE_Base_Class $object
5093
-     * @throws EE_Error
5094
-     * @return \EE_Base_Class
5095
-     */
5096
-    public function add_to_entity_map(EE_Base_Class $object)
5097
-    {
5098
-        $className = $this->_get_class_name();
5099
-        if (! $object instanceof $className) {
5100
-            throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
5101
-                is_object($object) ? get_class($object) : $object, $className));
5102
-        }
5103
-        /** @var $object EE_Base_Class */
5104
-        if (! $object->ID()) {
5105
-            throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
5106
-                "event_espresso"), get_class($this)));
5107
-        }
5108
-        // double check it's not already there
5109
-        $classInstance = $this->get_from_entity_map($object->ID());
5110
-        if ($classInstance) {
5111
-            return $classInstance;
5112
-        }
5113
-        $this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
5114
-        return $object;
5115
-    }
5116
-
5117
-
5118
-
5119
-    /**
5120
-     * if a valid identifier is provided, then that entity is unset from the entity map,
5121
-     * if no identifier is provided, then the entire entity map is emptied
5122
-     *
5123
-     * @param int|string $id the ID of the model object
5124
-     * @return boolean
5125
-     */
5126
-    public function clear_entity_map($id = null)
5127
-    {
5128
-        if (empty($id)) {
5129
-            $this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
5130
-            return true;
5131
-        }
5132
-        if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
5133
-            unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
5134
-            return true;
5135
-        }
5136
-        return false;
5137
-    }
5138
-
5139
-
5140
-
5141
-    /**
5142
-     * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
5143
-     * Given an array where keys are column (or column alias) names and values,
5144
-     * returns an array of their corresponding field names and database values
5145
-     *
5146
-     * @param array $cols_n_values
5147
-     * @return array
5148
-     */
5149
-    public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
5150
-    {
5151
-        return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5152
-    }
5153
-
5154
-
5155
-
5156
-    /**
5157
-     * _deduce_fields_n_values_from_cols_n_values
5158
-     * Given an array where keys are column (or column alias) names and values,
5159
-     * returns an array of their corresponding field names and database values
5160
-     *
5161
-     * @param string $cols_n_values
5162
-     * @return array
5163
-     */
5164
-    protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
5165
-    {
5166
-        $this_model_fields_n_values = array();
5167
-        foreach ($this->get_tables() as $table_alias => $table_obj) {
5168
-            $table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
5169
-                $table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
5170
-            //there is a primary key on this table and its not set. Use defaults for all its columns
5171
-            if ($table_pk_value === null && $table_obj->get_pk_column()) {
5172
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5173
-                    if (! $field_obj->is_db_only_field()) {
5174
-                        //prepare field as if its coming from db
5175
-                        $prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5176
-                        $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
5177
-                    }
5178
-                }
5179
-            } else {
5180
-                //the table's rows existed. Use their values
5181
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5182
-                    if (! $field_obj->is_db_only_field()) {
5183
-                        $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5184
-                            $cols_n_values, $field_obj->get_qualified_column(),
5185
-                            $field_obj->get_table_column()
5186
-                        );
5187
-                    }
5188
-                }
5189
-            }
5190
-        }
5191
-        return $this_model_fields_n_values;
5192
-    }
5193
-
5194
-
5195
-
5196
-    /**
5197
-     * @param $cols_n_values
5198
-     * @param $qualified_column
5199
-     * @param $regular_column
5200
-     * @return null
5201
-     */
5202
-    protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
5203
-    {
5204
-        $value = null;
5205
-        //ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
5206
-        //does the field on the model relate to this column retrieved from the db?
5207
-        //or is it a db-only field? (not relating to the model)
5208
-        if (isset($cols_n_values[$qualified_column])) {
5209
-            $value = $cols_n_values[$qualified_column];
5210
-        } elseif (isset($cols_n_values[$regular_column])) {
5211
-            $value = $cols_n_values[$regular_column];
5212
-        }
5213
-        return $value;
5214
-    }
5215
-
5216
-
5217
-
5218
-    /**
5219
-     * refresh_entity_map_from_db
5220
-     * Makes sure the model object in the entity map at $id assumes the values
5221
-     * of the database (opposite of EE_base_Class::save())
5222
-     *
5223
-     * @param int|string $id
5224
-     * @return EE_Base_Class
5225
-     * @throws EE_Error
5226
-     */
5227
-    public function refresh_entity_map_from_db($id)
5228
-    {
5229
-        $obj_in_map = $this->get_from_entity_map($id);
5230
-        if ($obj_in_map) {
5231
-            $wpdb_results = $this->_get_all_wpdb_results(
5232
-                array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
5233
-            );
5234
-            if ($wpdb_results && is_array($wpdb_results)) {
5235
-                $one_row = reset($wpdb_results);
5236
-                foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
5237
-                    $obj_in_map->set_from_db($field_name, $db_value);
5238
-                }
5239
-                //clear the cache of related model objects
5240
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5241
-                    $obj_in_map->clear_cache($relation_name, null, true);
5242
-                }
5243
-            }
5244
-            $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
5245
-            return $obj_in_map;
5246
-        }
5247
-        return $this->get_one_by_ID($id);
5248
-    }
5249
-
5250
-
5251
-
5252
-    /**
5253
-     * refresh_entity_map_with
5254
-     * Leaves the entry in the entity map alone, but updates it to match the provided
5255
-     * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
5256
-     * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
5257
-     * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
5258
-     *
5259
-     * @param int|string    $id
5260
-     * @param EE_Base_Class $replacing_model_obj
5261
-     * @return \EE_Base_Class
5262
-     * @throws EE_Error
5263
-     */
5264
-    public function refresh_entity_map_with($id, $replacing_model_obj)
5265
-    {
5266
-        $obj_in_map = $this->get_from_entity_map($id);
5267
-        if ($obj_in_map) {
5268
-            if ($replacing_model_obj instanceof EE_Base_Class) {
5269
-                foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
5270
-                    $obj_in_map->set($field_name, $value);
5271
-                }
5272
-                //make the model object in the entity map's cache match the $replacing_model_obj
5273
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5274
-                    $obj_in_map->clear_cache($relation_name, null, true);
5275
-                    foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
5276
-                        $obj_in_map->cache($relation_name, $cached_obj, $cache_id);
5277
-                    }
5278
-                }
5279
-            }
5280
-            return $obj_in_map;
5281
-        }
5282
-        $this->add_to_entity_map($replacing_model_obj);
5283
-        return $replacing_model_obj;
5284
-    }
5285
-
5286
-
5287
-
5288
-    /**
5289
-     * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
5290
-     * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
5291
-     * require_once($this->_getClassName().".class.php");
5292
-     *
5293
-     * @return string
5294
-     */
5295
-    private function _get_class_name()
5296
-    {
5297
-        return "EE_" . $this->get_this_model_name();
5298
-    }
5299
-
5300
-
5301
-
5302
-    /**
5303
-     * Get the name of the items this model represents, for the quantity specified. Eg,
5304
-     * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
5305
-     * it would be 'Events'.
5306
-     *
5307
-     * @param int $quantity
5308
-     * @return string
5309
-     */
5310
-    public function item_name($quantity = 1)
5311
-    {
5312
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5313
-    }
5314
-
5315
-
5316
-
5317
-    /**
5318
-     * Very handy general function to allow for plugins to extend any child of EE_TempBase.
5319
-     * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
5320
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
5321
-     * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
5322
-     * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
5323
-     * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
5324
-     * was called, and an array of the original arguments passed to the function. Whatever their callback function
5325
-     * returns will be returned by this function. Example: in functions.php (or in a plugin):
5326
-     * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
5327
-     * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
5328
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
5329
-     *        return $previousReturnValue.$returnString;
5330
-     * }
5331
-     * require('EEM_Answer.model.php');
5332
-     * $answer=EEM_Answer::instance();
5333
-     * echo $answer->my_callback('monkeys',100);
5334
-     * //will output "you called my_callback! and passed args:monkeys,100"
5335
-     *
5336
-     * @param string $methodName name of method which was called on a child of EE_TempBase, but which
5337
-     * @param array  $args       array of original arguments passed to the function
5338
-     * @throws EE_Error
5339
-     * @return mixed whatever the plugin which calls add_filter decides
5340
-     */
5341
-    public function __call($methodName, $args)
5342
-    {
5343
-        $className = get_class($this);
5344
-        $tagName = "FHEE__{$className}__{$methodName}";
5345
-        if (! has_filter($tagName)) {
5346
-            throw new EE_Error(
5347
-                sprintf(
5348
-                    __('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 );',
5349
-                        'event_espresso'),
5350
-                    $methodName,
5351
-                    $className,
5352
-                    $tagName,
5353
-                    '<br />'
5354
-                )
5355
-            );
5356
-        }
5357
-        return apply_filters($tagName, null, $this, $args);
5358
-    }
5359
-
5360
-
5361
-
5362
-    /**
5363
-     * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
5364
-     * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
5365
-     *
5366
-     * @param EE_Base_Class|string|int $base_class_obj_or_id either:
5367
-     *                                                       the EE_Base_Class object that corresponds to this Model,
5368
-     *                                                       the object's class name
5369
-     *                                                       or object's ID
5370
-     * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
5371
-     *                                                       exists in the database. If it does not, we add it
5372
-     * @throws EE_Error
5373
-     * @return EE_Base_Class
5374
-     */
5375
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
5376
-    {
5377
-        $className = $this->_get_class_name();
5378
-        if ($base_class_obj_or_id instanceof $className) {
5379
-            $model_object = $base_class_obj_or_id;
5380
-        } else {
5381
-            $primary_key_field = $this->get_primary_key_field();
5382
-            if (
5383
-                $primary_key_field instanceof EE_Primary_Key_Int_Field
5384
-                && (
5385
-                    is_int($base_class_obj_or_id)
5386
-                    || is_string($base_class_obj_or_id)
5387
-                )
5388
-            ) {
5389
-                // assume it's an ID.
5390
-                // either a proper integer or a string representing an integer (eg "101" instead of 101)
5391
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
5392
-            } else if (
5393
-                $primary_key_field instanceof EE_Primary_Key_String_Field
5394
-                && is_string($base_class_obj_or_id)
5395
-            ) {
5396
-                // assume its a string representation of the object
5397
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
5398
-            } else {
5399
-                throw new EE_Error(
5400
-                    sprintf(
5401
-                        __(
5402
-                            "'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5403
-                            'event_espresso'
5404
-                        ),
5405
-                        $base_class_obj_or_id,
5406
-                        $this->_get_class_name(),
5407
-                        print_r($base_class_obj_or_id, true)
5408
-                    )
5409
-                );
5410
-            }
5411
-        }
5412
-        if ($ensure_is_in_db && $model_object->ID() !== null) {
5413
-            $model_object->save();
5414
-        }
5415
-        return $model_object;
5416
-    }
5417
-
5418
-
5419
-
5420
-    /**
5421
-     * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5422
-     * is a value of the this model's primary key. If it's an EE_Base_Class child,
5423
-     * returns it ID.
5424
-     *
5425
-     * @param EE_Base_Class|int|string $base_class_obj_or_id
5426
-     * @return int|string depending on the type of this model object's ID
5427
-     * @throws EE_Error
5428
-     */
5429
-    public function ensure_is_ID($base_class_obj_or_id)
5430
-    {
5431
-        $className = $this->_get_class_name();
5432
-        if ($base_class_obj_or_id instanceof $className) {
5433
-            /** @var $base_class_obj_or_id EE_Base_Class */
5434
-            $id = $base_class_obj_or_id->ID();
5435
-        } elseif (is_int($base_class_obj_or_id)) {
5436
-            //assume it's an ID
5437
-            $id = $base_class_obj_or_id;
5438
-        } elseif (is_string($base_class_obj_or_id)) {
5439
-            //assume its a string representation of the object
5440
-            $id = $base_class_obj_or_id;
5441
-        } else {
5442
-            throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5443
-                'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5444
-                print_r($base_class_obj_or_id, true)));
5445
-        }
5446
-        return $id;
5447
-    }
5448
-
5449
-
5450
-
5451
-    /**
5452
-     * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5453
-     * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5454
-     * been sanitized and converted into the appropriate domain.
5455
-     * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5456
-     * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5457
-     * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5458
-     * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5459
-     * $EVT = EEM_Event::instance(); $old_setting =
5460
-     * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5461
-     * $EVT->assume_values_already_prepared_by_model_object(true);
5462
-     * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5463
-     * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5464
-     *
5465
-     * @param int $values_already_prepared like one of the constants on EEM_Base
5466
-     * @return void
5467
-     */
5468
-    public function assume_values_already_prepared_by_model_object(
5469
-        $values_already_prepared = self::not_prepared_by_model_object
5470
-    ) {
5471
-        $this->_values_already_prepared_by_model_object = $values_already_prepared;
5472
-    }
5473
-
5474
-
5475
-
5476
-    /**
5477
-     * Read comments for assume_values_already_prepared_by_model_object()
5478
-     *
5479
-     * @return int
5480
-     */
5481
-    public function get_assumption_concerning_values_already_prepared_by_model_object()
5482
-    {
5483
-        return $this->_values_already_prepared_by_model_object;
5484
-    }
5485
-
5486
-
5487
-
5488
-    /**
5489
-     * Gets all the indexes on this model
5490
-     *
5491
-     * @return EE_Index[]
5492
-     */
5493
-    public function indexes()
5494
-    {
5495
-        return $this->_indexes;
5496
-    }
5497
-
5498
-
5499
-
5500
-    /**
5501
-     * Gets all the Unique Indexes on this model
5502
-     *
5503
-     * @return EE_Unique_Index[]
5504
-     */
5505
-    public function unique_indexes()
5506
-    {
5507
-        $unique_indexes = array();
5508
-        foreach ($this->_indexes as $name => $index) {
5509
-            if ($index instanceof EE_Unique_Index) {
5510
-                $unique_indexes [$name] = $index;
5511
-            }
5512
-        }
5513
-        return $unique_indexes;
5514
-    }
5515
-
5516
-
5517
-
5518
-    /**
5519
-     * Gets all the fields which, when combined, make the primary key.
5520
-     * This is usually just an array with 1 element (the primary key), but in cases
5521
-     * where there is no primary key, it's a combination of fields as defined
5522
-     * on a primary index
5523
-     *
5524
-     * @return EE_Model_Field_Base[] indexed by the field's name
5525
-     * @throws EE_Error
5526
-     */
5527
-    public function get_combined_primary_key_fields()
5528
-    {
5529
-        foreach ($this->indexes() as $index) {
5530
-            if ($index instanceof EE_Primary_Key_Index) {
5531
-                return $index->fields();
5532
-            }
5533
-        }
5534
-        return array($this->primary_key_name() => $this->get_primary_key_field());
5535
-    }
5536
-
5537
-
5538
-
5539
-    /**
5540
-     * Used to build a primary key string (when the model has no primary key),
5541
-     * which can be used a unique string to identify this model object.
5542
-     *
5543
-     * @param array $cols_n_values keys are field names, values are their values
5544
-     * @return string
5545
-     * @throws EE_Error
5546
-     */
5547
-    public function get_index_primary_key_string($cols_n_values)
5548
-    {
5549
-        $cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5550
-            $this->get_combined_primary_key_fields());
5551
-        return http_build_query($cols_n_values_for_primary_key_index);
5552
-    }
5553
-
5554
-
5555
-
5556
-    /**
5557
-     * Gets the field values from the primary key string
5558
-     *
5559
-     * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5560
-     * @param string $index_primary_key_string
5561
-     * @return null|array
5562
-     * @throws EE_Error
5563
-     */
5564
-    public function parse_index_primary_key_string($index_primary_key_string)
5565
-    {
5566
-        $key_fields = $this->get_combined_primary_key_fields();
5567
-        //check all of them are in the $id
5568
-        $key_vals_in_combined_pk = array();
5569
-        parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5570
-        foreach ($key_fields as $key_field_name => $field_obj) {
5571
-            if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5572
-                return null;
5573
-            }
5574
-        }
5575
-        return $key_vals_in_combined_pk;
5576
-    }
5577
-
5578
-
5579
-
5580
-    /**
5581
-     * verifies that an array of key-value pairs for model fields has a key
5582
-     * for each field comprising the primary key index
5583
-     *
5584
-     * @param array $key_vals
5585
-     * @return boolean
5586
-     * @throws EE_Error
5587
-     */
5588
-    public function has_all_combined_primary_key_fields($key_vals)
5589
-    {
5590
-        $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5591
-        foreach ($keys_it_should_have as $key) {
5592
-            if (! isset($key_vals[$key])) {
5593
-                return false;
5594
-            }
5595
-        }
5596
-        return true;
5597
-    }
5598
-
5599
-
5600
-
5601
-    /**
5602
-     * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5603
-     * We consider something to be a copy if all the attributes match (except the ID, of course).
5604
-     *
5605
-     * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5606
-     * @param array               $query_params                     like EEM_Base::get_all's query_params.
5607
-     * @throws EE_Error
5608
-     * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5609
-     *                                                              indexed)
5610
-     */
5611
-    public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5612
-    {
5613
-        if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5614
-            $attributes_array = $model_object_or_attributes_array->model_field_array();
5615
-        } elseif (is_array($model_object_or_attributes_array)) {
5616
-            $attributes_array = $model_object_or_attributes_array;
5617
-        } else {
5618
-            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",
5619
-                "event_espresso"), $model_object_or_attributes_array));
5620
-        }
5621
-        //even copies obviously won't have the same ID, so remove the primary key
5622
-        //from the WHERE conditions for finding copies (if there is a primary key, of course)
5623
-        if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5624
-            unset($attributes_array[$this->primary_key_name()]);
5625
-        }
5626
-        if (isset($query_params[0])) {
5627
-            $query_params[0] = array_merge($attributes_array, $query_params);
5628
-        } else {
5629
-            $query_params[0] = $attributes_array;
5630
-        }
5631
-        return $this->get_all($query_params);
5632
-    }
5633
-
5634
-
5635
-
5636
-    /**
5637
-     * Gets the first copy we find. See get_all_copies for more details
5638
-     *
5639
-     * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5640
-     * @param array $query_params
5641
-     * @return EE_Base_Class
5642
-     * @throws EE_Error
5643
-     */
5644
-    public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5645
-    {
5646
-        if (! is_array($query_params)) {
5647
-            EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5648
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5649
-                    gettype($query_params)), '4.6.0');
5650
-            $query_params = array();
5651
-        }
5652
-        $query_params['limit'] = 1;
5653
-        $copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5654
-        if (is_array($copies)) {
5655
-            return array_shift($copies);
5656
-        }
5657
-        return null;
5658
-    }
5659
-
5660
-
5661
-
5662
-    /**
5663
-     * Updates the item with the specified id. Ignores default query parameters because
5664
-     * we have specified the ID, and its assumed we KNOW what we're doing
5665
-     *
5666
-     * @param array      $fields_n_values keys are field names, values are their new values
5667
-     * @param int|string $id              the value of the primary key to update
5668
-     * @return int number of rows updated
5669
-     * @throws EE_Error
5670
-     */
5671
-    public function update_by_ID($fields_n_values, $id)
5672
-    {
5673
-        $query_params = array(
5674
-            0                          => array($this->get_primary_key_field()->get_name() => $id),
5675
-            'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
5676
-        );
5677
-        return $this->update($fields_n_values, $query_params);
5678
-    }
5679
-
5680
-
5681
-
5682
-    /**
5683
-     * Changes an operator which was supplied to the models into one usable in SQL
5684
-     *
5685
-     * @param string $operator_supplied
5686
-     * @return string an operator which can be used in SQL
5687
-     * @throws EE_Error
5688
-     */
5689
-    private function _prepare_operator_for_sql($operator_supplied)
5690
-    {
5691
-        $sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5692
-            : null;
5693
-        if ($sql_operator) {
5694
-            return $sql_operator;
5695
-        }
5696
-        throw new EE_Error(
5697
-            sprintf(
5698
-                __(
5699
-                    "The operator '%s' is not in the list of valid operators: %s",
5700
-                    "event_espresso"
5701
-                ), $operator_supplied, implode(",", array_keys($this->_valid_operators))
5702
-            )
5703
-        );
5704
-    }
5705
-
5706
-
5707
-
5708
-    /**
5709
-     * Gets an array where keys are the primary keys and values are their 'names'
5710
-     * (as determined by the model object's name() function, which is often overridden)
5711
-     *
5712
-     * @param array $query_params like get_all's
5713
-     * @return string[]
5714
-     * @throws EE_Error
5715
-     */
5716
-    public function get_all_names($query_params = array())
5717
-    {
5718
-        $objs = $this->get_all($query_params);
5719
-        $names = array();
5720
-        foreach ($objs as $obj) {
5721
-            $names[$obj->ID()] = $obj->name();
5722
-        }
5723
-        return $names;
5724
-    }
5725
-
5726
-
5727
-
5728
-    /**
5729
-     * Gets an array of primary keys from the model objects. If you acquired the model objects
5730
-     * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5731
-     * this is duplicated effort and reduces efficiency) you would be better to use
5732
-     * array_keys() on $model_objects.
5733
-     *
5734
-     * @param \EE_Base_Class[] $model_objects
5735
-     * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5736
-     *                                               in the returned array
5737
-     * @return array
5738
-     * @throws EE_Error
5739
-     */
5740
-    public function get_IDs($model_objects, $filter_out_empty_ids = false)
5741
-    {
5742
-        if (! $this->has_primary_key_field()) {
5743
-            if (WP_DEBUG) {
5744
-                EE_Error::add_error(
5745
-                    __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5746
-                    __FILE__,
5747
-                    __FUNCTION__,
5748
-                    __LINE__
5749
-                );
5750
-            }
5751
-        }
5752
-        $IDs = array();
5753
-        foreach ($model_objects as $model_object) {
5754
-            $id = $model_object->ID();
5755
-            if (! $id) {
5756
-                if ($filter_out_empty_ids) {
5757
-                    continue;
5758
-                }
5759
-                if (WP_DEBUG) {
5760
-                    EE_Error::add_error(
5761
-                        __(
5762
-                            'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5763
-                            'event_espresso'
5764
-                        ),
5765
-                        __FILE__,
5766
-                        __FUNCTION__,
5767
-                        __LINE__
5768
-                    );
5769
-                }
5770
-            }
5771
-            $IDs[] = $id;
5772
-        }
5773
-        return $IDs;
5774
-    }
5775
-
5776
-
5777
-
5778
-    /**
5779
-     * Returns the string used in capabilities relating to this model. If there
5780
-     * are no capabilities that relate to this model returns false
5781
-     *
5782
-     * @return string|false
5783
-     */
5784
-    public function cap_slug()
5785
-    {
5786
-        return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5787
-    }
5788
-
5789
-
5790
-
5791
-    /**
5792
-     * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5793
-     * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5794
-     * only returns the cap restrictions array in that context (ie, the array
5795
-     * at that key)
5796
-     *
5797
-     * @param string $context
5798
-     * @return EE_Default_Where_Conditions[] indexed by associated capability
5799
-     * @throws EE_Error
5800
-     */
5801
-    public function cap_restrictions($context = EEM_Base::caps_read)
5802
-    {
5803
-        EEM_Base::verify_is_valid_cap_context($context);
5804
-        //check if we ought to run the restriction generator first
5805
-        if (
5806
-            isset($this->_cap_restriction_generators[$context])
5807
-            && $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5808
-            && ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5809
-        ) {
5810
-            $this->_cap_restrictions[$context] = array_merge(
5811
-                $this->_cap_restrictions[$context],
5812
-                $this->_cap_restriction_generators[$context]->generate_restrictions()
5813
-            );
5814
-        }
5815
-        //and make sure we've finalized the construction of each restriction
5816
-        foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5817
-            if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5818
-                $where_conditions_obj->_finalize_construct($this);
5819
-            }
5820
-        }
5821
-        return $this->_cap_restrictions[$context];
5822
-    }
5823
-
5824
-
5825
-
5826
-    /**
5827
-     * Indicating whether or not this model thinks its a wp core model
5828
-     *
5829
-     * @return boolean
5830
-     */
5831
-    public function is_wp_core_model()
5832
-    {
5833
-        return $this->_wp_core_model;
5834
-    }
5835
-
5836
-
5837
-
5838
-    /**
5839
-     * Gets all the caps that are missing which impose a restriction on
5840
-     * queries made in this context
5841
-     *
5842
-     * @param string $context one of EEM_Base::caps_ constants
5843
-     * @return EE_Default_Where_Conditions[] indexed by capability name
5844
-     * @throws EE_Error
5845
-     */
5846
-    public function caps_missing($context = EEM_Base::caps_read)
5847
-    {
5848
-        $missing_caps = array();
5849
-        $cap_restrictions = $this->cap_restrictions($context);
5850
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5851
-            if (! EE_Capabilities::instance()
5852
-                                 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5853
-            ) {
5854
-                $missing_caps[$cap] = $restriction_if_no_cap;
5855
-            }
5856
-        }
5857
-        return $missing_caps;
5858
-    }
5859
-
5860
-
5861
-
5862
-    /**
5863
-     * Gets the mapping from capability contexts to action strings used in capability names
5864
-     *
5865
-     * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5866
-     * one of 'read', 'edit', or 'delete'
5867
-     */
5868
-    public function cap_contexts_to_cap_action_map()
5869
-    {
5870
-        return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5871
-            $this);
5872
-    }
5873
-
5874
-
5875
-
5876
-    /**
5877
-     * Gets the action string for the specified capability context
5878
-     *
5879
-     * @param string $context
5880
-     * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5881
-     * @throws EE_Error
5882
-     */
5883
-    public function cap_action_for_context($context)
5884
-    {
5885
-        $mapping = $this->cap_contexts_to_cap_action_map();
5886
-        if (isset($mapping[$context])) {
5887
-            return $mapping[$context];
5888
-        }
5889
-        if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5890
-            return $action;
5891
-        }
5892
-        throw new EE_Error(
5893
-            sprintf(
5894
-                __('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5895
-                $context,
5896
-                implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5897
-            )
5898
-        );
5899
-    }
5900
-
5901
-
5902
-
5903
-    /**
5904
-     * Returns all the capability contexts which are valid when querying models
5905
-     *
5906
-     * @return array
5907
-     */
5908
-    public static function valid_cap_contexts()
5909
-    {
5910
-        return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5911
-            self::caps_read,
5912
-            self::caps_read_admin,
5913
-            self::caps_edit,
5914
-            self::caps_delete,
5915
-        ));
5916
-    }
5917
-
5918
-
5919
-
5920
-    /**
5921
-     * Returns all valid options for 'default_where_conditions'
5922
-     *
5923
-     * @return array
5924
-     */
5925
-    public static function valid_default_where_conditions()
5926
-    {
5927
-        return array(
5928
-            EEM_Base::default_where_conditions_all,
5929
-            EEM_Base::default_where_conditions_this_only,
5930
-            EEM_Base::default_where_conditions_others_only,
5931
-            EEM_Base::default_where_conditions_minimum_all,
5932
-            EEM_Base::default_where_conditions_minimum_others,
5933
-            EEM_Base::default_where_conditions_none
5934
-        );
5935
-    }
5936
-
5937
-    // public static function default_where_conditions_full
5938
-    /**
5939
-     * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5940
-     *
5941
-     * @param string $context
5942
-     * @return bool
5943
-     * @throws EE_Error
5944
-     */
5945
-    static public function verify_is_valid_cap_context($context)
5946
-    {
5947
-        $valid_cap_contexts = EEM_Base::valid_cap_contexts();
5948
-        if (in_array($context, $valid_cap_contexts)) {
5949
-            return true;
5950
-        }
5951
-        throw new EE_Error(
5952
-            sprintf(
5953
-                __(
5954
-                    'Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5955
-                    'event_espresso'
5956
-                ),
5957
-                $context,
5958
-                'EEM_Base',
5959
-                implode(',', $valid_cap_contexts)
5960
-            )
5961
-        );
5962
-    }
5963
-
5964
-
5965
-
5966
-    /**
5967
-     * Clears all the models field caches. This is only useful when a sub-class
5968
-     * might have added a field or something and these caches might be invalidated
5969
-     */
5970
-    protected function _invalidate_field_caches()
5971
-    {
5972
-        $this->_cache_foreign_key_to_fields = array();
5973
-        $this->_cached_fields = null;
5974
-        $this->_cached_fields_non_db_only = null;
5975
-    }
5976
-
5977
-
5978
-
5979
-    /**
5980
-     * Gets the list of all the where query param keys that relate to logic instead of field names
5981
-     * (eg "and", "or", "not").
5982
-     *
5983
-     * @return array
5984
-     */
5985
-    public function logic_query_param_keys()
5986
-    {
5987
-        return $this->_logic_query_param_keys;
5988
-    }
5989
-
5990
-
5991
-
5992
-    /**
5993
-     * Determines whether or not the where query param array key is for a logic query param.
5994
-     * Eg 'OR', 'not*', and 'and*because-i-say-so' should all return true, whereas
5995
-     * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
5996
-     *
5997
-     * @param $query_param_key
5998
-     * @return bool
5999
-     */
6000
-    public function is_logic_query_param_key($query_param_key)
6001
-    {
6002
-        foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
6003
-            if ($query_param_key === $logic_query_param_key
6004
-                || strpos($query_param_key, $logic_query_param_key . '*') === 0
6005
-            ) {
6006
-                return true;
6007
-            }
6008
-        }
6009
-        return false;
6010
-    }
3739
+		}
3740
+		return $null_friendly_where_conditions;
3741
+	}
3742
+
3743
+
3744
+
3745
+	/**
3746
+	 * Uses the _default_where_conditions_strategy set during __construct() to get
3747
+	 * default where conditions on all get_all, update, and delete queries done by this model.
3748
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3749
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3750
+	 *
3751
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3752
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3753
+	 */
3754
+	private function _get_default_where_conditions($model_relation_path = null)
3755
+	{
3756
+		if ($this->_ignore_where_strategy) {
3757
+			return array();
3758
+		}
3759
+		return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3760
+	}
3761
+
3762
+
3763
+
3764
+	/**
3765
+	 * Uses the _minimum_where_conditions_strategy set during __construct() to get
3766
+	 * minimum where conditions on all get_all, update, and delete queries done by this model.
3767
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3768
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3769
+	 * Similar to _get_default_where_conditions
3770
+	 *
3771
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3772
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3773
+	 */
3774
+	protected function _get_minimum_where_conditions($model_relation_path = null)
3775
+	{
3776
+		if ($this->_ignore_where_strategy) {
3777
+			return array();
3778
+		}
3779
+		return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3780
+	}
3781
+
3782
+
3783
+
3784
+	/**
3785
+	 * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3786
+	 * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3787
+	 *
3788
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
3789
+	 * @return string
3790
+	 * @throws EE_Error
3791
+	 */
3792
+	private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3793
+	{
3794
+		$selects = $this->_get_columns_to_select_for_this_model();
3795
+		foreach (
3796
+			$model_query_info->get_model_names_included() as $model_relation_chain =>
3797
+			$name_of_other_model_included
3798
+		) {
3799
+			$other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3800
+			$other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3801
+			foreach ($other_model_selects as $key => $value) {
3802
+				$selects[] = $value;
3803
+			}
3804
+		}
3805
+		return implode(", ", $selects);
3806
+	}
3807
+
3808
+
3809
+
3810
+	/**
3811
+	 * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3812
+	 * So that's going to be the columns for all the fields on the model
3813
+	 *
3814
+	 * @param string $model_relation_chain like 'Question.Question_Group.Event'
3815
+	 * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3816
+	 */
3817
+	public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3818
+	{
3819
+		$fields = $this->field_settings();
3820
+		$selects = array();
3821
+		$table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3822
+			$this->get_this_model_name());
3823
+		foreach ($fields as $field_obj) {
3824
+			$selects[] = $table_alias_with_model_relation_chain_prefix
3825
+						 . $field_obj->get_table_alias()
3826
+						 . "."
3827
+						 . $field_obj->get_table_column()
3828
+						 . " AS '"
3829
+						 . $table_alias_with_model_relation_chain_prefix
3830
+						 . $field_obj->get_table_alias()
3831
+						 . "."
3832
+						 . $field_obj->get_table_column()
3833
+						 . "'";
3834
+		}
3835
+		//make sure we are also getting the PKs of each table
3836
+		$tables = $this->get_tables();
3837
+		if (count($tables) > 1) {
3838
+			foreach ($tables as $table_obj) {
3839
+				$qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3840
+									   . $table_obj->get_fully_qualified_pk_column();
3841
+				if (! in_array($qualified_pk_column, $selects)) {
3842
+					$selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3843
+				}
3844
+			}
3845
+		}
3846
+		return $selects;
3847
+	}
3848
+
3849
+
3850
+
3851
+	/**
3852
+	 * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3853
+	 * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3854
+	 * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3855
+	 * SQL for joining, and the data types
3856
+	 *
3857
+	 * @param null|string                 $original_query_param
3858
+	 * @param string                      $query_param          like Registration.Transaction.TXN_ID
3859
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3860
+	 * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3861
+	 *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3862
+	 *                                                          column name. We only want model names, eg 'Event.Venue'
3863
+	 *                                                          or 'Registration's
3864
+	 * @param string                      $original_query_param what it originally was (eg
3865
+	 *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3866
+	 *                                                          matches $query_param
3867
+	 * @throws EE_Error
3868
+	 * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3869
+	 */
3870
+	private function _extract_related_model_info_from_query_param(
3871
+		$query_param,
3872
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3873
+		$query_param_type,
3874
+		$original_query_param = null
3875
+	) {
3876
+		if ($original_query_param === null) {
3877
+			$original_query_param = $query_param;
3878
+		}
3879
+		$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3880
+		/** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3881
+		$allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3882
+		$allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3883
+		//check to see if we have a field on this model
3884
+		$this_model_fields = $this->field_settings(true);
3885
+		if (array_key_exists($query_param, $this_model_fields)) {
3886
+			if ($allow_fields) {
3887
+				return;
3888
+			}
3889
+			throw new EE_Error(
3890
+				sprintf(
3891
+					__(
3892
+						"Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
3893
+						"event_espresso"
3894
+					),
3895
+					$query_param, get_class($this), $query_param_type, $original_query_param
3896
+				)
3897
+			);
3898
+		}
3899
+		//check if this is a special logic query param
3900
+		if (in_array($query_param, $this->_logic_query_param_keys, true)) {
3901
+			if ($allow_logic_query_params) {
3902
+				return;
3903
+			}
3904
+			throw new EE_Error(
3905
+				sprintf(
3906
+					__(
3907
+						'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',
3908
+						'event_espresso'
3909
+					),
3910
+					implode('", "', $this->_logic_query_param_keys),
3911
+					$query_param,
3912
+					get_class($this),
3913
+					'<br />',
3914
+					"\t"
3915
+					. ' $passed_in_query_info = <pre>'
3916
+					. print_r($passed_in_query_info, true)
3917
+					. '</pre>'
3918
+					. "\n\t"
3919
+					. ' $query_param_type = '
3920
+					. $query_param_type
3921
+					. "\n\t"
3922
+					. ' $original_query_param = '
3923
+					. $original_query_param
3924
+				)
3925
+			);
3926
+		}
3927
+		//check if it's a custom selection
3928
+		if (array_key_exists($query_param, $this->_custom_selections)) {
3929
+			return;
3930
+		}
3931
+		//check if has a model name at the beginning
3932
+		//and
3933
+		//check if it's a field on a related model
3934
+		foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3935
+			if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3936
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3937
+				$query_param = substr($query_param, strlen($valid_related_model_name . "."));
3938
+				if ($query_param === '') {
3939
+					//nothing left to $query_param
3940
+					//we should actually end in a field name, not a model like this!
3941
+					throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3942
+						"event_espresso"),
3943
+						$query_param, $query_param_type, get_class($this), $valid_related_model_name));
3944
+				}
3945
+				$related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3946
+				$related_model_obj->_extract_related_model_info_from_query_param(
3947
+					$query_param,
3948
+					$passed_in_query_info, $query_param_type, $original_query_param
3949
+				);
3950
+				return;
3951
+			}
3952
+			if ($query_param === $valid_related_model_name) {
3953
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3954
+				return;
3955
+			}
3956
+		}
3957
+		//ok so $query_param didn't start with a model name
3958
+		//and we previously confirmed it wasn't a logic query param or field on the current model
3959
+		//it's wack, that's what it is
3960
+		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",
3961
+			"event_espresso"),
3962
+			$query_param, get_class($this), $query_param_type, $original_query_param));
3963
+	}
3964
+
3965
+
3966
+
3967
+	/**
3968
+	 * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3969
+	 * and store it on $passed_in_query_info
3970
+	 *
3971
+	 * @param string                      $model_name
3972
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3973
+	 * @param string                      $original_query_param used to extract the relation chain between the queried
3974
+	 *                                                          model and $model_name. Eg, if we are querying Event,
3975
+	 *                                                          and are adding a join to 'Payment' with the original
3976
+	 *                                                          query param key
3977
+	 *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3978
+	 *                                                          to extract 'Registration.Transaction.Payment', in case
3979
+	 *                                                          Payment wants to add default query params so that it
3980
+	 *                                                          will know what models to prepend onto its default query
3981
+	 *                                                          params or in case it wants to rename tables (in case
3982
+	 *                                                          there are multiple joins to the same table)
3983
+	 * @return void
3984
+	 * @throws EE_Error
3985
+	 */
3986
+	private function _add_join_to_model(
3987
+		$model_name,
3988
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3989
+		$original_query_param
3990
+	) {
3991
+		$relation_obj = $this->related_settings_for($model_name);
3992
+		$model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3993
+		//check if the relation is HABTM, because then we're essentially doing two joins
3994
+		//If so, join first to the JOIN table, and add its data types, and then continue as normal
3995
+		if ($relation_obj instanceof EE_HABTM_Relation) {
3996
+			$join_model_obj = $relation_obj->get_join_model();
3997
+			//replace the model specified with the join model for this relation chain, whi
3998
+			$relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
3999
+				$join_model_obj->get_this_model_name(), $model_relation_chain);
4000
+			$new_query_info = new EE_Model_Query_Info_Carrier(
4001
+				array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
4002
+				$relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model));
4003
+			$passed_in_query_info->merge($new_query_info);
4004
+		}
4005
+		//now just join to the other table pointed to by the relation object, and add its data types
4006
+		$new_query_info = new EE_Model_Query_Info_Carrier(
4007
+			array($model_relation_chain => $model_name),
4008
+			$relation_obj->get_join_statement($model_relation_chain));
4009
+		$passed_in_query_info->merge($new_query_info);
4010
+	}
4011
+
4012
+
4013
+
4014
+	/**
4015
+	 * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
4016
+	 *
4017
+	 * @param array $where_params like EEM_Base::get_all
4018
+	 * @return string of SQL
4019
+	 * @throws EE_Error
4020
+	 */
4021
+	private function _construct_where_clause($where_params)
4022
+	{
4023
+		$SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
4024
+		if ($SQL) {
4025
+			return " WHERE " . $SQL;
4026
+		}
4027
+		return '';
4028
+	}
4029
+
4030
+
4031
+
4032
+	/**
4033
+	 * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
4034
+	 * and should be passed HAVING parameters, not WHERE parameters
4035
+	 *
4036
+	 * @param array $having_params
4037
+	 * @return string
4038
+	 * @throws EE_Error
4039
+	 */
4040
+	private function _construct_having_clause($having_params)
4041
+	{
4042
+		$SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
4043
+		if ($SQL) {
4044
+			return " HAVING " . $SQL;
4045
+		}
4046
+		return '';
4047
+	}
4048
+
4049
+
4050
+
4051
+	/**
4052
+	 * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
4053
+	 * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
4054
+	 * EEM_Attendee.
4055
+	 *
4056
+	 * @param string $field_name
4057
+	 * @param string $model_name
4058
+	 * @return EE_Model_Field_Base
4059
+	 * @throws EE_Error
4060
+	 */
4061
+	protected function _get_field_on_model($field_name, $model_name)
4062
+	{
4063
+		$model_class = 'EEM_' . $model_name;
4064
+		$model_filepath = $model_class . ".model.php";
4065
+		if (is_readable($model_filepath)) {
4066
+			require_once($model_filepath);
4067
+			$model_instance = call_user_func($model_name . "::instance");
4068
+			/* @var $model_instance EEM_Base */
4069
+			return $model_instance->field_settings_for($field_name);
4070
+		}
4071
+		throw new EE_Error(
4072
+			sprintf(
4073
+				__(
4074
+					'No model named %s exists, with classname %s and filepath %s',
4075
+					'event_espresso'
4076
+				), $model_name, $model_class, $model_filepath
4077
+			)
4078
+		);
4079
+	}
4080
+
4081
+
4082
+
4083
+	/**
4084
+	 * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
4085
+	 * Event_Meta.meta_value = 'foo'))"
4086
+	 *
4087
+	 * @param array  $where_params see EEM_Base::get_all for documentation
4088
+	 * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
4089
+	 * @throws EE_Error
4090
+	 * @return string of SQL
4091
+	 */
4092
+	private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
4093
+	{
4094
+		$where_clauses = array();
4095
+		foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
4096
+			$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
4097
+			if (in_array($query_param, $this->_logic_query_param_keys)) {
4098
+				switch ($query_param) {
4099
+					case 'not':
4100
+					case 'NOT':
4101
+						$where_clauses[] = "! ("
4102
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4103
+								$glue)
4104
+										   . ")";
4105
+						break;
4106
+					case 'and':
4107
+					case 'AND':
4108
+						$where_clauses[] = " ("
4109
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4110
+								' AND ')
4111
+										   . ")";
4112
+						break;
4113
+					case 'or':
4114
+					case 'OR':
4115
+						$where_clauses[] = " ("
4116
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4117
+								' OR ')
4118
+										   . ")";
4119
+						break;
4120
+				}
4121
+			} else {
4122
+				$field_obj = $this->_deduce_field_from_query_param($query_param);
4123
+				//if it's not a normal field, maybe it's a custom selection?
4124
+				if (! $field_obj) {
4125
+					if (isset($this->_custom_selections[$query_param][1])) {
4126
+						$field_obj = $this->_custom_selections[$query_param][1];
4127
+					} else {
4128
+						throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
4129
+							"event_espresso"), $query_param));
4130
+					}
4131
+				}
4132
+				$op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
4133
+				$where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
4134
+			}
4135
+		}
4136
+		return $where_clauses ? implode($glue, $where_clauses) : '';
4137
+	}
4138
+
4139
+
4140
+
4141
+	/**
4142
+	 * Takes the input parameter and extract the table name (alias) and column name
4143
+	 *
4144
+	 * @param string $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4145
+	 * @throws EE_Error
4146
+	 * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
4147
+	 */
4148
+	private function _deduce_column_name_from_query_param($query_param)
4149
+	{
4150
+		$field = $this->_deduce_field_from_query_param($query_param);
4151
+		if ($field) {
4152
+			$table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4153
+				$query_param);
4154
+			return $table_alias_prefix . $field->get_qualified_column();
4155
+		}
4156
+		if (array_key_exists($query_param, $this->_custom_selections)) {
4157
+			//maybe it's custom selection item?
4158
+			//if so, just use it as the "column name"
4159
+			return $query_param;
4160
+		}
4161
+		throw new EE_Error(
4162
+			sprintf(
4163
+				__(
4164
+					"%s is not a valid field on this model, nor a custom selection (%s)",
4165
+					"event_espresso"
4166
+				), $query_param, implode(",", $this->_custom_selections)
4167
+			)
4168
+		);
4169
+	}
4170
+
4171
+
4172
+
4173
+	/**
4174
+	 * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
4175
+	 * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
4176
+	 * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
4177
+	 * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
4178
+	 *
4179
+	 * @param string $condition_query_param_key
4180
+	 * @return string
4181
+	 */
4182
+	private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
4183
+	{
4184
+		$pos_of_star = strpos($condition_query_param_key, '*');
4185
+		if ($pos_of_star === false) {
4186
+			return $condition_query_param_key;
4187
+		}
4188
+		$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
4189
+		return $condition_query_param_sans_star;
4190
+	}
4191
+
4192
+
4193
+
4194
+	/**
4195
+	 * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
4196
+	 *
4197
+	 * @param                            mixed      array | string    $op_and_value
4198
+	 * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
4199
+	 * @throws EE_Error
4200
+	 * @return string
4201
+	 */
4202
+	private function _construct_op_and_value($op_and_value, $field_obj)
4203
+	{
4204
+		if (is_array($op_and_value)) {
4205
+			$operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4206
+			if (! $operator) {
4207
+				$php_array_like_string = array();
4208
+				foreach ($op_and_value as $key => $value) {
4209
+					$php_array_like_string[] = "$key=>$value";
4210
+				}
4211
+				throw new EE_Error(
4212
+					sprintf(
4213
+						__(
4214
+							"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))",
4215
+							"event_espresso"
4216
+						),
4217
+						implode(",", $php_array_like_string)
4218
+					)
4219
+				);
4220
+			}
4221
+			$value = isset($op_and_value[1]) ? $op_and_value[1] : null;
4222
+		} else {
4223
+			$operator = '=';
4224
+			$value = $op_and_value;
4225
+		}
4226
+		//check to see if the value is actually another field
4227
+		if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4228
+			return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4229
+		}
4230
+		if (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4231
+			//in this case, the value should be an array, or at least a comma-separated list
4232
+			//it will need to handle a little differently
4233
+			$cleaned_value = $this->_construct_in_value($value, $field_obj);
4234
+			//note: $cleaned_value has already been run through $wpdb->prepare()
4235
+			return $operator . SP . $cleaned_value;
4236
+		}
4237
+		if (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4238
+			//the value should be an array with count of two.
4239
+			if (count($value) !== 2) {
4240
+				throw new EE_Error(
4241
+					sprintf(
4242
+						__(
4243
+							"The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
4244
+							'event_espresso'
4245
+						),
4246
+						"BETWEEN"
4247
+					)
4248
+				);
4249
+			}
4250
+			$cleaned_value = $this->_construct_between_value($value, $field_obj);
4251
+			return $operator . SP . $cleaned_value;
4252
+		}
4253
+		if (in_array($operator, $this->_null_style_operators)) {
4254
+			if ($value !== null) {
4255
+				throw new EE_Error(
4256
+					sprintf(
4257
+						__(
4258
+							"You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
4259
+							"event_espresso"
4260
+						),
4261
+						$value,
4262
+						$operator
4263
+					)
4264
+				);
4265
+			}
4266
+			return $operator;
4267
+		}
4268
+		if ($operator === 'LIKE' && ! is_array($value)) {
4269
+			//if the operator is 'LIKE', we want to allow percent signs (%) and not
4270
+			//remove other junk. So just treat it as a string.
4271
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4272
+		}
4273
+		if (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4274
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4275
+		}
4276
+		if (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4277
+			throw new EE_Error(
4278
+				sprintf(
4279
+					__(
4280
+						"Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
4281
+						'event_espresso'
4282
+					),
4283
+					$operator,
4284
+					$operator
4285
+				)
4286
+			);
4287
+		}
4288
+		if (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4289
+			throw new EE_Error(
4290
+				sprintf(
4291
+					__(
4292
+						"Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
4293
+						'event_espresso'
4294
+					),
4295
+					$operator,
4296
+					$operator
4297
+				)
4298
+			);
4299
+		}
4300
+		throw new EE_Error(
4301
+			sprintf(
4302
+				__(
4303
+					"It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
4304
+					"event_espresso"
4305
+				),
4306
+				http_build_query($op_and_value)
4307
+			)
4308
+		);
4309
+	}
4310
+
4311
+
4312
+
4313
+	/**
4314
+	 * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
4315
+	 *
4316
+	 * @param array                      $values
4317
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
4318
+	 *                                              '%s'
4319
+	 * @return string
4320
+	 * @throws EE_Error
4321
+	 */
4322
+	public function _construct_between_value($values, $field_obj)
4323
+	{
4324
+		$cleaned_values = array();
4325
+		foreach ($values as $value) {
4326
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4327
+		}
4328
+		return $cleaned_values[0] . " AND " . $cleaned_values[1];
4329
+	}
4330
+
4331
+
4332
+
4333
+	/**
4334
+	 * Takes an array or a comma-separated list of $values and cleans them
4335
+	 * according to $data_type using $wpdb->prepare, and then makes the list a
4336
+	 * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4337
+	 * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4338
+	 * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4339
+	 *
4340
+	 * @param mixed                      $values    array or comma-separated string
4341
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4342
+	 * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4343
+	 * @throws EE_Error
4344
+	 */
4345
+	public function _construct_in_value($values, $field_obj)
4346
+	{
4347
+		//check if the value is a CSV list
4348
+		if (is_string($values)) {
4349
+			//in which case, turn it into an array
4350
+			$values = explode(",", $values);
4351
+		}
4352
+		$cleaned_values = array();
4353
+		foreach ($values as $value) {
4354
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4355
+		}
4356
+		//we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4357
+		//but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4358
+		//which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4359
+		if (empty($cleaned_values)) {
4360
+			$all_fields = $this->field_settings();
4361
+			$a_field = array_shift($all_fields);
4362
+			$main_table = $this->_get_main_table();
4363
+			$cleaned_values[] = "SELECT "
4364
+								. $a_field->get_table_column()
4365
+								. " FROM "
4366
+								. $main_table->get_table_name()
4367
+								. " WHERE FALSE";
4368
+		}
4369
+		return "(" . implode(",", $cleaned_values) . ")";
4370
+	}
4371
+
4372
+
4373
+
4374
+	/**
4375
+	 * @param mixed                      $value
4376
+	 * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4377
+	 * @throws EE_Error
4378
+	 * @return false|null|string
4379
+	 */
4380
+	private function _wpdb_prepare_using_field($value, $field_obj)
4381
+	{
4382
+		/** @type WPDB $wpdb */
4383
+		global $wpdb;
4384
+		if ($field_obj instanceof EE_Model_Field_Base) {
4385
+			return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4386
+				$this->_prepare_value_for_use_in_db($value, $field_obj));
4387
+		} //$field_obj should really just be a data type
4388
+		if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4389
+			throw new EE_Error(
4390
+				sprintf(
4391
+					__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4392
+					$field_obj, implode(",", $this->_valid_wpdb_data_types)
4393
+				)
4394
+			);
4395
+		}
4396
+		return $wpdb->prepare($field_obj, $value);
4397
+	}
4398
+
4399
+
4400
+
4401
+	/**
4402
+	 * Takes the input parameter and finds the model field that it indicates.
4403
+	 *
4404
+	 * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4405
+	 * @throws EE_Error
4406
+	 * @return EE_Model_Field_Base
4407
+	 */
4408
+	protected function _deduce_field_from_query_param($query_param_name)
4409
+	{
4410
+		//ok, now proceed with deducing which part is the model's name, and which is the field's name
4411
+		//which will help us find the database table and column
4412
+		$query_param_parts = explode(".", $query_param_name);
4413
+		if (empty($query_param_parts)) {
4414
+			throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4415
+				'event_espresso'), $query_param_name));
4416
+		}
4417
+		$number_of_parts = count($query_param_parts);
4418
+		$last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4419
+		if ($number_of_parts === 1) {
4420
+			$field_name = $last_query_param_part;
4421
+			$model_obj = $this;
4422
+		} else {// $number_of_parts >= 2
4423
+			//the last part is the column name, and there are only 2parts. therefore...
4424
+			$field_name = $last_query_param_part;
4425
+			$model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4426
+		}
4427
+		try {
4428
+			return $model_obj->field_settings_for($field_name);
4429
+		} catch (EE_Error $e) {
4430
+			return null;
4431
+		}
4432
+	}
4433
+
4434
+
4435
+
4436
+	/**
4437
+	 * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4438
+	 * alias and column which corresponds to it
4439
+	 *
4440
+	 * @param string $field_name
4441
+	 * @throws EE_Error
4442
+	 * @return string
4443
+	 */
4444
+	public function _get_qualified_column_for_field($field_name)
4445
+	{
4446
+		$all_fields = $this->field_settings();
4447
+		$field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4448
+		if ($field) {
4449
+			return $field->get_qualified_column();
4450
+		}
4451
+		throw new EE_Error(
4452
+			sprintf(
4453
+				__(
4454
+					"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.",
4455
+					'event_espresso'
4456
+				), $field_name, get_class($this)
4457
+			)
4458
+		);
4459
+	}
4460
+
4461
+
4462
+
4463
+	/**
4464
+	 * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
4465
+	 * Example usage:
4466
+	 * EEM_Ticket::instance()->get_all_wpdb_results(
4467
+	 *      array(),
4468
+	 *      ARRAY_A,
4469
+	 *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
4470
+	 *  );
4471
+	 * is equivalent to
4472
+	 *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
4473
+	 * and
4474
+	 *  EEM_Event::instance()->get_all_wpdb_results(
4475
+	 *      array(
4476
+	 *          array(
4477
+	 *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
4478
+	 *          ),
4479
+	 *          ARRAY_A,
4480
+	 *          implode(
4481
+	 *              ', ',
4482
+	 *              array_merge(
4483
+	 *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
4484
+	 *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
4485
+	 *              )
4486
+	 *          )
4487
+	 *      )
4488
+	 *  );
4489
+	 * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
4490
+	 *
4491
+	 * @param string $model_relation_chain        the chain of models used to join between the model you want to query
4492
+	 *                                            and the one whose fields you are selecting for example: when querying
4493
+	 *                                            tickets model and selecting fields from the tickets model you would
4494
+	 *                                            leave this parameter empty, because no models are needed to join
4495
+	 *                                            between the queried model and the selected one. Likewise when
4496
+	 *                                            querying the datetime model and selecting fields from the tickets
4497
+	 *                                            model, it would also be left empty, because there is a direct
4498
+	 *                                            relation from datetimes to tickets, so no model is needed to join
4499
+	 *                                            them together. However, when querying from the event model and
4500
+	 *                                            selecting fields from the ticket model, you should provide the string
4501
+	 *                                            'Datetime', indicating that the event model must first join to the
4502
+	 *                                            datetime model in order to find its relation to ticket model.
4503
+	 *                                            Also, when querying from the venue model and selecting fields from
4504
+	 *                                            the ticket model, you should provide the string 'Event.Datetime',
4505
+	 *                                            indicating you need to join the venue model to the event model,
4506
+	 *                                            to the datetime model, in order to find its relation to the ticket model.
4507
+	 *                                            This string is used to deduce the prefix that gets added onto the
4508
+	 *                                            models' tables qualified columns
4509
+	 * @param bool   $return_string               if true, will return a string with qualified column names separated
4510
+	 *                                            by ', ' if false, will simply return a numerically indexed array of
4511
+	 *                                            qualified column names
4512
+	 * @return array|string
4513
+	 */
4514
+	public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4515
+	{
4516
+		$table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4517
+		$qualified_columns = array();
4518
+		foreach ($this->field_settings() as $field_name => $field) {
4519
+			$qualified_columns[] = $table_prefix . $field->get_qualified_column();
4520
+		}
4521
+		return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4522
+	}
4523
+
4524
+
4525
+
4526
+	/**
4527
+	 * constructs the select use on special limit joins
4528
+	 * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4529
+	 * its setup so the select query will be setup on and just doing the special select join off of the primary table
4530
+	 * (as that is typically where the limits would be set).
4531
+	 *
4532
+	 * @param  string       $table_alias The table the select is being built for
4533
+	 * @param  mixed|string $limit       The limit for this select
4534
+	 * @return string                The final select join element for the query.
4535
+	 */
4536
+	public function _construct_limit_join_select($table_alias, $limit)
4537
+	{
4538
+		$SQL = '';
4539
+		foreach ($this->_tables as $table_obj) {
4540
+			if ($table_obj instanceof EE_Primary_Table) {
4541
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4542
+					? $table_obj->get_select_join_limit($limit)
4543
+					: SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4544
+			} elseif ($table_obj instanceof EE_Secondary_Table) {
4545
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4546
+					? $table_obj->get_select_join_limit_join($limit)
4547
+					: SP . $table_obj->get_join_sql($table_alias) . SP;
4548
+			}
4549
+		}
4550
+		return $SQL;
4551
+	}
4552
+
4553
+
4554
+
4555
+	/**
4556
+	 * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4557
+	 * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4558
+	 *
4559
+	 * @return string SQL
4560
+	 * @throws EE_Error
4561
+	 */
4562
+	public function _construct_internal_join()
4563
+	{
4564
+		$SQL = $this->_get_main_table()->get_table_sql();
4565
+		$SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4566
+		return $SQL;
4567
+	}
4568
+
4569
+
4570
+
4571
+	/**
4572
+	 * Constructs the SQL for joining all the tables on this model.
4573
+	 * Normally $alias should be the primary table's alias, but in cases where
4574
+	 * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4575
+	 * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4576
+	 * alias, this will construct SQL like:
4577
+	 * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4578
+	 * With $alias being a secondary table's alias, this will construct SQL like:
4579
+	 * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4580
+	 *
4581
+	 * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4582
+	 * @return string
4583
+	 */
4584
+	public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4585
+	{
4586
+		$SQL = '';
4587
+		$alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4588
+		foreach ($this->_tables as $table_obj) {
4589
+			if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4590
+				if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4591
+					//so we're joining to this table, meaning the table is already in
4592
+					//the FROM statement, BUT the primary table isn't. So we want
4593
+					//to add the inverse join sql
4594
+					$SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4595
+				} else {
4596
+					//just add a regular JOIN to this table from the primary table
4597
+					$SQL .= $table_obj->get_join_sql($alias_prefixed);
4598
+				}
4599
+			}//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4600
+		}
4601
+		return $SQL;
4602
+	}
4603
+
4604
+
4605
+
4606
+	/**
4607
+	 * Gets an array for storing all the data types on the next-to-be-executed-query.
4608
+	 * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4609
+	 * their data type (eg, '%s', '%d', etc)
4610
+	 *
4611
+	 * @return array
4612
+	 */
4613
+	public function _get_data_types()
4614
+	{
4615
+		$data_types = array();
4616
+		foreach ($this->field_settings() as $field_obj) {
4617
+			//$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4618
+			/** @var $field_obj EE_Model_Field_Base */
4619
+			$data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4620
+		}
4621
+		return $data_types;
4622
+	}
4623
+
4624
+
4625
+
4626
+	/**
4627
+	 * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4628
+	 *
4629
+	 * @param string $model_name
4630
+	 * @throws EE_Error
4631
+	 * @return EEM_Base
4632
+	 */
4633
+	public function get_related_model_obj($model_name)
4634
+	{
4635
+		$model_classname = "EEM_" . $model_name;
4636
+		if (! class_exists($model_classname)) {
4637
+			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",
4638
+				'event_espresso'), $model_name, $model_classname));
4639
+		}
4640
+		return call_user_func($model_classname . "::instance");
4641
+	}
4642
+
4643
+
4644
+
4645
+	/**
4646
+	 * Returns the array of EE_ModelRelations for this model.
4647
+	 *
4648
+	 * @return EE_Model_Relation_Base[]
4649
+	 */
4650
+	public function relation_settings()
4651
+	{
4652
+		return $this->_model_relations;
4653
+	}
4654
+
4655
+
4656
+
4657
+	/**
4658
+	 * Gets all related models that this model BELONGS TO. Handy to know sometimes
4659
+	 * because without THOSE models, this model probably doesn't have much purpose.
4660
+	 * (Eg, without an event, datetimes have little purpose.)
4661
+	 *
4662
+	 * @return EE_Belongs_To_Relation[]
4663
+	 */
4664
+	public function belongs_to_relations()
4665
+	{
4666
+		$belongs_to_relations = array();
4667
+		foreach ($this->relation_settings() as $model_name => $relation_obj) {
4668
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
4669
+				$belongs_to_relations[$model_name] = $relation_obj;
4670
+			}
4671
+		}
4672
+		return $belongs_to_relations;
4673
+	}
4674
+
4675
+
4676
+
4677
+	/**
4678
+	 * Returns the specified EE_Model_Relation, or throws an exception
4679
+	 *
4680
+	 * @param string $relation_name name of relation, key in $this->_relatedModels
4681
+	 * @throws EE_Error
4682
+	 * @return EE_Model_Relation_Base
4683
+	 */
4684
+	public function related_settings_for($relation_name)
4685
+	{
4686
+		$relatedModels = $this->relation_settings();
4687
+		if (! array_key_exists($relation_name, $relatedModels)) {
4688
+			throw new EE_Error(
4689
+				sprintf(
4690
+					__('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4691
+						'event_espresso'),
4692
+					$relation_name,
4693
+					$this->_get_class_name(),
4694
+					implode(', ', array_keys($relatedModels))
4695
+				)
4696
+			);
4697
+		}
4698
+		return $relatedModels[$relation_name];
4699
+	}
4700
+
4701
+
4702
+
4703
+	/**
4704
+	 * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4705
+	 * fields
4706
+	 *
4707
+	 * @param string $fieldName
4708
+	 * @throws EE_Error
4709
+	 * @return EE_Model_Field_Base
4710
+	 */
4711
+	public function field_settings_for($fieldName)
4712
+	{
4713
+		$fieldSettings = $this->field_settings(true);
4714
+		if (! array_key_exists($fieldName, $fieldSettings)) {
4715
+			throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4716
+				get_class($this)));
4717
+		}
4718
+		return $fieldSettings[$fieldName];
4719
+	}
4720
+
4721
+
4722
+
4723
+	/**
4724
+	 * Checks if this field exists on this model
4725
+	 *
4726
+	 * @param string $fieldName a key in the model's _field_settings array
4727
+	 * @return boolean
4728
+	 */
4729
+	public function has_field($fieldName)
4730
+	{
4731
+		$fieldSettings = $this->field_settings(true);
4732
+		if (isset($fieldSettings[$fieldName])) {
4733
+			return true;
4734
+		}
4735
+		return false;
4736
+	}
4737
+
4738
+
4739
+
4740
+	/**
4741
+	 * Returns whether or not this model has a relation to the specified model
4742
+	 *
4743
+	 * @param string $relation_name possibly one of the keys in the relation_settings array
4744
+	 * @return boolean
4745
+	 */
4746
+	public function has_relation($relation_name)
4747
+	{
4748
+		$relations = $this->relation_settings();
4749
+		if (isset($relations[$relation_name])) {
4750
+			return true;
4751
+		}
4752
+		return false;
4753
+	}
4754
+
4755
+
4756
+
4757
+	/**
4758
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4759
+	 * Eg, on EE_Answer that would be ANS_ID field object
4760
+	 *
4761
+	 * @param $field_obj
4762
+	 * @return boolean
4763
+	 */
4764
+	public function is_primary_key_field($field_obj)
4765
+	{
4766
+		return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4767
+	}
4768
+
4769
+
4770
+
4771
+	/**
4772
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4773
+	 * Eg, on EE_Answer that would be ANS_ID field object
4774
+	 *
4775
+	 * @return EE_Model_Field_Base
4776
+	 * @throws EE_Error
4777
+	 */
4778
+	public function get_primary_key_field()
4779
+	{
4780
+		if ($this->_primary_key_field === null) {
4781
+			foreach ($this->field_settings(true) as $field_obj) {
4782
+				if ($this->is_primary_key_field($field_obj)) {
4783
+					$this->_primary_key_field = $field_obj;
4784
+					break;
4785
+				}
4786
+			}
4787
+			if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4788
+				throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4789
+					get_class($this)));
4790
+			}
4791
+		}
4792
+		return $this->_primary_key_field;
4793
+	}
4794
+
4795
+
4796
+
4797
+	/**
4798
+	 * Returns whether or not not there is a primary key on this model.
4799
+	 * Internally does some caching.
4800
+	 *
4801
+	 * @return boolean
4802
+	 */
4803
+	public function has_primary_key_field()
4804
+	{
4805
+		if ($this->_has_primary_key_field === null) {
4806
+			try {
4807
+				$this->get_primary_key_field();
4808
+				$this->_has_primary_key_field = true;
4809
+			} catch (EE_Error $e) {
4810
+				$this->_has_primary_key_field = false;
4811
+			}
4812
+		}
4813
+		return $this->_has_primary_key_field;
4814
+	}
4815
+
4816
+
4817
+
4818
+	/**
4819
+	 * Finds the first field of type $field_class_name.
4820
+	 *
4821
+	 * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4822
+	 *                                 EE_Foreign_Key_Field, etc
4823
+	 * @return EE_Model_Field_Base or null if none is found
4824
+	 */
4825
+	public function get_a_field_of_type($field_class_name)
4826
+	{
4827
+		foreach ($this->field_settings() as $field) {
4828
+			if ($field instanceof $field_class_name) {
4829
+				return $field;
4830
+			}
4831
+		}
4832
+		return null;
4833
+	}
4834
+
4835
+
4836
+
4837
+	/**
4838
+	 * Gets a foreign key field pointing to model.
4839
+	 *
4840
+	 * @param string $model_name eg Event, Registration, not EEM_Event
4841
+	 * @return EE_Foreign_Key_Field_Base
4842
+	 * @throws EE_Error
4843
+	 */
4844
+	public function get_foreign_key_to($model_name)
4845
+	{
4846
+		if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4847
+			foreach ($this->field_settings() as $field) {
4848
+				if (
4849
+					$field instanceof EE_Foreign_Key_Field_Base
4850
+					&& in_array($model_name, $field->get_model_names_pointed_to())
4851
+				) {
4852
+					$this->_cache_foreign_key_to_fields[$model_name] = $field;
4853
+					break;
4854
+				}
4855
+			}
4856
+			if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4857
+				throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4858
+					'event_espresso'), $model_name, get_class($this)));
4859
+			}
4860
+		}
4861
+		return $this->_cache_foreign_key_to_fields[$model_name];
4862
+	}
4863
+
4864
+
4865
+
4866
+	/**
4867
+	 * Gets the table name (including $wpdb->prefix) for the table alias
4868
+	 *
4869
+	 * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4870
+	 *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4871
+	 *                            Either one works
4872
+	 * @return string
4873
+	 */
4874
+	public function get_table_for_alias($table_alias)
4875
+	{
4876
+		$table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4877
+		return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4878
+	}
4879
+
4880
+
4881
+
4882
+	/**
4883
+	 * Returns a flat array of all field son this model, instead of organizing them
4884
+	 * by table_alias as they are in the constructor.
4885
+	 *
4886
+	 * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4887
+	 * @return EE_Model_Field_Base[] where the keys are the field's name
4888
+	 */
4889
+	public function field_settings($include_db_only_fields = false)
4890
+	{
4891
+		if ($include_db_only_fields) {
4892
+			if ($this->_cached_fields === null) {
4893
+				$this->_cached_fields = array();
4894
+				foreach ($this->_fields as $fields_corresponding_to_table) {
4895
+					foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4896
+						$this->_cached_fields[$field_name] = $field_obj;
4897
+					}
4898
+				}
4899
+			}
4900
+			return $this->_cached_fields;
4901
+		}
4902
+		if ($this->_cached_fields_non_db_only === null) {
4903
+			$this->_cached_fields_non_db_only = array();
4904
+			foreach ($this->_fields as $fields_corresponding_to_table) {
4905
+				foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4906
+					/** @var $field_obj EE_Model_Field_Base */
4907
+					if (! $field_obj->is_db_only_field()) {
4908
+						$this->_cached_fields_non_db_only[$field_name] = $field_obj;
4909
+					}
4910
+				}
4911
+			}
4912
+		}
4913
+		return $this->_cached_fields_non_db_only;
4914
+	}
4915
+
4916
+
4917
+
4918
+	/**
4919
+	 *        cycle though array of attendees and create objects out of each item
4920
+	 *
4921
+	 * @access        private
4922
+	 * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4923
+	 * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4924
+	 *                           numerically indexed)
4925
+	 * @throws EE_Error
4926
+	 */
4927
+	protected function _create_objects($rows = array())
4928
+	{
4929
+		$array_of_objects = array();
4930
+		if (empty($rows)) {
4931
+			return array();
4932
+		}
4933
+		$count_if_model_has_no_primary_key = 0;
4934
+		$has_primary_key = $this->has_primary_key_field();
4935
+		$primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4936
+		foreach ((array)$rows as $row) {
4937
+			if (empty($row)) {
4938
+				//wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4939
+				return array();
4940
+			}
4941
+			//check if we've already set this object in the results array,
4942
+			//in which case there's no need to process it further (again)
4943
+			if ($has_primary_key) {
4944
+				$table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4945
+					$row,
4946
+					$primary_key_field->get_qualified_column(),
4947
+					$primary_key_field->get_table_column()
4948
+				);
4949
+				if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4950
+					continue;
4951
+				}
4952
+			}
4953
+			$classInstance = $this->instantiate_class_from_array_or_object($row);
4954
+			if (! $classInstance) {
4955
+				throw new EE_Error(
4956
+					sprintf(
4957
+						__('Could not create instance of class %s from row %s', 'event_espresso'),
4958
+						$this->get_this_model_name(),
4959
+						http_build_query($row)
4960
+					)
4961
+				);
4962
+			}
4963
+			//set the timezone on the instantiated objects
4964
+			$classInstance->set_timezone($this->_timezone);
4965
+			//make sure if there is any timezone setting present that we set the timezone for the object
4966
+			$key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4967
+			$array_of_objects[$key] = $classInstance;
4968
+			//also, for all the relations of type BelongsTo, see if we can cache
4969
+			//those related models
4970
+			//(we could do this for other relations too, but if there are conditions
4971
+			//that filtered out some fo the results, then we'd be caching an incomplete set
4972
+			//so it requires a little more thought than just caching them immediately...)
4973
+			foreach ($this->_model_relations as $modelName => $relation_obj) {
4974
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
4975
+					//check if this model's INFO is present. If so, cache it on the model
4976
+					$other_model = $relation_obj->get_other_model();
4977
+					$other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4978
+					//if we managed to make a model object from the results, cache it on the main model object
4979
+					if ($other_model_obj_maybe) {
4980
+						//set timezone on these other model objects if they are present
4981
+						$other_model_obj_maybe->set_timezone($this->_timezone);
4982
+						$classInstance->cache($modelName, $other_model_obj_maybe);
4983
+					}
4984
+				}
4985
+			}
4986
+		}
4987
+		return $array_of_objects;
4988
+	}
4989
+
4990
+
4991
+
4992
+	/**
4993
+	 * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4994
+	 * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4995
+	 * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4996
+	 * object (as set in the model_field!).
4997
+	 *
4998
+	 * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4999
+	 */
5000
+	public function create_default_object()
5001
+	{
5002
+		$this_model_fields_and_values = array();
5003
+		//setup the row using default values;
5004
+		foreach ($this->field_settings() as $field_name => $field_obj) {
5005
+			$this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
5006
+		}
5007
+		$className = $this->_get_class_name();
5008
+		$classInstance = EE_Registry::instance()
5009
+									->load_class($className, array($this_model_fields_and_values), false, false);
5010
+		return $classInstance;
5011
+	}
5012
+
5013
+
5014
+
5015
+	/**
5016
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
5017
+	 *                             or an stdClass where each property is the name of a column,
5018
+	 * @return EE_Base_Class
5019
+	 * @throws EE_Error
5020
+	 */
5021
+	public function instantiate_class_from_array_or_object($cols_n_values)
5022
+	{
5023
+		if (! is_array($cols_n_values) && is_object($cols_n_values)) {
5024
+			$cols_n_values = get_object_vars($cols_n_values);
5025
+		}
5026
+		$primary_key = null;
5027
+		//make sure the array only has keys that are fields/columns on this model
5028
+		$this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5029
+		if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
5030
+			$primary_key = $this_model_fields_n_values[$this->primary_key_name()];
5031
+		}
5032
+		$className = $this->_get_class_name();
5033
+		//check we actually found results that we can use to build our model object
5034
+		//if not, return null
5035
+		if ($this->has_primary_key_field()) {
5036
+			if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
5037
+				return null;
5038
+			}
5039
+		} else if ($this->unique_indexes()) {
5040
+			$first_column = reset($this_model_fields_n_values);
5041
+			if (empty($first_column)) {
5042
+				return null;
5043
+			}
5044
+		}
5045
+		// if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
5046
+		if ($primary_key) {
5047
+			$classInstance = $this->get_from_entity_map($primary_key);
5048
+			if (! $classInstance) {
5049
+				$classInstance = EE_Registry::instance()
5050
+											->load_class($className,
5051
+												array($this_model_fields_n_values, $this->_timezone), true, false);
5052
+				// add this new object to the entity map
5053
+				$classInstance = $this->add_to_entity_map($classInstance);
5054
+			}
5055
+		} else {
5056
+			$classInstance = EE_Registry::instance()
5057
+										->load_class($className, array($this_model_fields_n_values, $this->_timezone),
5058
+											true, false);
5059
+		}
5060
+		//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.
5061
+		$this->set_timezone($classInstance->get_timezone());
5062
+		return $classInstance;
5063
+	}
5064
+
5065
+
5066
+
5067
+	/**
5068
+	 * Gets the model object from the  entity map if it exists
5069
+	 *
5070
+	 * @param int|string $id the ID of the model object
5071
+	 * @return EE_Base_Class
5072
+	 */
5073
+	public function get_from_entity_map($id)
5074
+	{
5075
+		return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
5076
+			? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
5077
+	}
5078
+
5079
+
5080
+
5081
+	/**
5082
+	 * add_to_entity_map
5083
+	 * Adds the object to the model's entity mappings
5084
+	 *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
5085
+	 *        and for the remainder of the request, it's even more up-to-date than what's in the database.
5086
+	 *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
5087
+	 *        If the database gets updated directly and you want the entity mapper to reflect that change,
5088
+	 *        then this method should be called immediately after the update query
5089
+	 * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
5090
+	 * so on multisite, the entity map is specific to the query being done for a specific site.
5091
+	 *
5092
+	 * @param    EE_Base_Class $object
5093
+	 * @throws EE_Error
5094
+	 * @return \EE_Base_Class
5095
+	 */
5096
+	public function add_to_entity_map(EE_Base_Class $object)
5097
+	{
5098
+		$className = $this->_get_class_name();
5099
+		if (! $object instanceof $className) {
5100
+			throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
5101
+				is_object($object) ? get_class($object) : $object, $className));
5102
+		}
5103
+		/** @var $object EE_Base_Class */
5104
+		if (! $object->ID()) {
5105
+			throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
5106
+				"event_espresso"), get_class($this)));
5107
+		}
5108
+		// double check it's not already there
5109
+		$classInstance = $this->get_from_entity_map($object->ID());
5110
+		if ($classInstance) {
5111
+			return $classInstance;
5112
+		}
5113
+		$this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
5114
+		return $object;
5115
+	}
5116
+
5117
+
5118
+
5119
+	/**
5120
+	 * if a valid identifier is provided, then that entity is unset from the entity map,
5121
+	 * if no identifier is provided, then the entire entity map is emptied
5122
+	 *
5123
+	 * @param int|string $id the ID of the model object
5124
+	 * @return boolean
5125
+	 */
5126
+	public function clear_entity_map($id = null)
5127
+	{
5128
+		if (empty($id)) {
5129
+			$this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
5130
+			return true;
5131
+		}
5132
+		if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
5133
+			unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
5134
+			return true;
5135
+		}
5136
+		return false;
5137
+	}
5138
+
5139
+
5140
+
5141
+	/**
5142
+	 * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
5143
+	 * Given an array where keys are column (or column alias) names and values,
5144
+	 * returns an array of their corresponding field names and database values
5145
+	 *
5146
+	 * @param array $cols_n_values
5147
+	 * @return array
5148
+	 */
5149
+	public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
5150
+	{
5151
+		return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5152
+	}
5153
+
5154
+
5155
+
5156
+	/**
5157
+	 * _deduce_fields_n_values_from_cols_n_values
5158
+	 * Given an array where keys are column (or column alias) names and values,
5159
+	 * returns an array of their corresponding field names and database values
5160
+	 *
5161
+	 * @param string $cols_n_values
5162
+	 * @return array
5163
+	 */
5164
+	protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
5165
+	{
5166
+		$this_model_fields_n_values = array();
5167
+		foreach ($this->get_tables() as $table_alias => $table_obj) {
5168
+			$table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
5169
+				$table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
5170
+			//there is a primary key on this table and its not set. Use defaults for all its columns
5171
+			if ($table_pk_value === null && $table_obj->get_pk_column()) {
5172
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5173
+					if (! $field_obj->is_db_only_field()) {
5174
+						//prepare field as if its coming from db
5175
+						$prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5176
+						$this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
5177
+					}
5178
+				}
5179
+			} else {
5180
+				//the table's rows existed. Use their values
5181
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5182
+					if (! $field_obj->is_db_only_field()) {
5183
+						$this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5184
+							$cols_n_values, $field_obj->get_qualified_column(),
5185
+							$field_obj->get_table_column()
5186
+						);
5187
+					}
5188
+				}
5189
+			}
5190
+		}
5191
+		return $this_model_fields_n_values;
5192
+	}
5193
+
5194
+
5195
+
5196
+	/**
5197
+	 * @param $cols_n_values
5198
+	 * @param $qualified_column
5199
+	 * @param $regular_column
5200
+	 * @return null
5201
+	 */
5202
+	protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
5203
+	{
5204
+		$value = null;
5205
+		//ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
5206
+		//does the field on the model relate to this column retrieved from the db?
5207
+		//or is it a db-only field? (not relating to the model)
5208
+		if (isset($cols_n_values[$qualified_column])) {
5209
+			$value = $cols_n_values[$qualified_column];
5210
+		} elseif (isset($cols_n_values[$regular_column])) {
5211
+			$value = $cols_n_values[$regular_column];
5212
+		}
5213
+		return $value;
5214
+	}
5215
+
5216
+
5217
+
5218
+	/**
5219
+	 * refresh_entity_map_from_db
5220
+	 * Makes sure the model object in the entity map at $id assumes the values
5221
+	 * of the database (opposite of EE_base_Class::save())
5222
+	 *
5223
+	 * @param int|string $id
5224
+	 * @return EE_Base_Class
5225
+	 * @throws EE_Error
5226
+	 */
5227
+	public function refresh_entity_map_from_db($id)
5228
+	{
5229
+		$obj_in_map = $this->get_from_entity_map($id);
5230
+		if ($obj_in_map) {
5231
+			$wpdb_results = $this->_get_all_wpdb_results(
5232
+				array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
5233
+			);
5234
+			if ($wpdb_results && is_array($wpdb_results)) {
5235
+				$one_row = reset($wpdb_results);
5236
+				foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
5237
+					$obj_in_map->set_from_db($field_name, $db_value);
5238
+				}
5239
+				//clear the cache of related model objects
5240
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5241
+					$obj_in_map->clear_cache($relation_name, null, true);
5242
+				}
5243
+			}
5244
+			$this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
5245
+			return $obj_in_map;
5246
+		}
5247
+		return $this->get_one_by_ID($id);
5248
+	}
5249
+
5250
+
5251
+
5252
+	/**
5253
+	 * refresh_entity_map_with
5254
+	 * Leaves the entry in the entity map alone, but updates it to match the provided
5255
+	 * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
5256
+	 * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
5257
+	 * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
5258
+	 *
5259
+	 * @param int|string    $id
5260
+	 * @param EE_Base_Class $replacing_model_obj
5261
+	 * @return \EE_Base_Class
5262
+	 * @throws EE_Error
5263
+	 */
5264
+	public function refresh_entity_map_with($id, $replacing_model_obj)
5265
+	{
5266
+		$obj_in_map = $this->get_from_entity_map($id);
5267
+		if ($obj_in_map) {
5268
+			if ($replacing_model_obj instanceof EE_Base_Class) {
5269
+				foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
5270
+					$obj_in_map->set($field_name, $value);
5271
+				}
5272
+				//make the model object in the entity map's cache match the $replacing_model_obj
5273
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5274
+					$obj_in_map->clear_cache($relation_name, null, true);
5275
+					foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
5276
+						$obj_in_map->cache($relation_name, $cached_obj, $cache_id);
5277
+					}
5278
+				}
5279
+			}
5280
+			return $obj_in_map;
5281
+		}
5282
+		$this->add_to_entity_map($replacing_model_obj);
5283
+		return $replacing_model_obj;
5284
+	}
5285
+
5286
+
5287
+
5288
+	/**
5289
+	 * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
5290
+	 * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
5291
+	 * require_once($this->_getClassName().".class.php");
5292
+	 *
5293
+	 * @return string
5294
+	 */
5295
+	private function _get_class_name()
5296
+	{
5297
+		return "EE_" . $this->get_this_model_name();
5298
+	}
5299
+
5300
+
5301
+
5302
+	/**
5303
+	 * Get the name of the items this model represents, for the quantity specified. Eg,
5304
+	 * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
5305
+	 * it would be 'Events'.
5306
+	 *
5307
+	 * @param int $quantity
5308
+	 * @return string
5309
+	 */
5310
+	public function item_name($quantity = 1)
5311
+	{
5312
+		return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5313
+	}
5314
+
5315
+
5316
+
5317
+	/**
5318
+	 * Very handy general function to allow for plugins to extend any child of EE_TempBase.
5319
+	 * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
5320
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
5321
+	 * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
5322
+	 * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
5323
+	 * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
5324
+	 * was called, and an array of the original arguments passed to the function. Whatever their callback function
5325
+	 * returns will be returned by this function. Example: in functions.php (or in a plugin):
5326
+	 * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
5327
+	 * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
5328
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
5329
+	 *        return $previousReturnValue.$returnString;
5330
+	 * }
5331
+	 * require('EEM_Answer.model.php');
5332
+	 * $answer=EEM_Answer::instance();
5333
+	 * echo $answer->my_callback('monkeys',100);
5334
+	 * //will output "you called my_callback! and passed args:monkeys,100"
5335
+	 *
5336
+	 * @param string $methodName name of method which was called on a child of EE_TempBase, but which
5337
+	 * @param array  $args       array of original arguments passed to the function
5338
+	 * @throws EE_Error
5339
+	 * @return mixed whatever the plugin which calls add_filter decides
5340
+	 */
5341
+	public function __call($methodName, $args)
5342
+	{
5343
+		$className = get_class($this);
5344
+		$tagName = "FHEE__{$className}__{$methodName}";
5345
+		if (! has_filter($tagName)) {
5346
+			throw new EE_Error(
5347
+				sprintf(
5348
+					__('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 );',
5349
+						'event_espresso'),
5350
+					$methodName,
5351
+					$className,
5352
+					$tagName,
5353
+					'<br />'
5354
+				)
5355
+			);
5356
+		}
5357
+		return apply_filters($tagName, null, $this, $args);
5358
+	}
5359
+
5360
+
5361
+
5362
+	/**
5363
+	 * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
5364
+	 * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
5365
+	 *
5366
+	 * @param EE_Base_Class|string|int $base_class_obj_or_id either:
5367
+	 *                                                       the EE_Base_Class object that corresponds to this Model,
5368
+	 *                                                       the object's class name
5369
+	 *                                                       or object's ID
5370
+	 * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
5371
+	 *                                                       exists in the database. If it does not, we add it
5372
+	 * @throws EE_Error
5373
+	 * @return EE_Base_Class
5374
+	 */
5375
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
5376
+	{
5377
+		$className = $this->_get_class_name();
5378
+		if ($base_class_obj_or_id instanceof $className) {
5379
+			$model_object = $base_class_obj_or_id;
5380
+		} else {
5381
+			$primary_key_field = $this->get_primary_key_field();
5382
+			if (
5383
+				$primary_key_field instanceof EE_Primary_Key_Int_Field
5384
+				&& (
5385
+					is_int($base_class_obj_or_id)
5386
+					|| is_string($base_class_obj_or_id)
5387
+				)
5388
+			) {
5389
+				// assume it's an ID.
5390
+				// either a proper integer or a string representing an integer (eg "101" instead of 101)
5391
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
5392
+			} else if (
5393
+				$primary_key_field instanceof EE_Primary_Key_String_Field
5394
+				&& is_string($base_class_obj_or_id)
5395
+			) {
5396
+				// assume its a string representation of the object
5397
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
5398
+			} else {
5399
+				throw new EE_Error(
5400
+					sprintf(
5401
+						__(
5402
+							"'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5403
+							'event_espresso'
5404
+						),
5405
+						$base_class_obj_or_id,
5406
+						$this->_get_class_name(),
5407
+						print_r($base_class_obj_or_id, true)
5408
+					)
5409
+				);
5410
+			}
5411
+		}
5412
+		if ($ensure_is_in_db && $model_object->ID() !== null) {
5413
+			$model_object->save();
5414
+		}
5415
+		return $model_object;
5416
+	}
5417
+
5418
+
5419
+
5420
+	/**
5421
+	 * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5422
+	 * is a value of the this model's primary key. If it's an EE_Base_Class child,
5423
+	 * returns it ID.
5424
+	 *
5425
+	 * @param EE_Base_Class|int|string $base_class_obj_or_id
5426
+	 * @return int|string depending on the type of this model object's ID
5427
+	 * @throws EE_Error
5428
+	 */
5429
+	public function ensure_is_ID($base_class_obj_or_id)
5430
+	{
5431
+		$className = $this->_get_class_name();
5432
+		if ($base_class_obj_or_id instanceof $className) {
5433
+			/** @var $base_class_obj_or_id EE_Base_Class */
5434
+			$id = $base_class_obj_or_id->ID();
5435
+		} elseif (is_int($base_class_obj_or_id)) {
5436
+			//assume it's an ID
5437
+			$id = $base_class_obj_or_id;
5438
+		} elseif (is_string($base_class_obj_or_id)) {
5439
+			//assume its a string representation of the object
5440
+			$id = $base_class_obj_or_id;
5441
+		} else {
5442
+			throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5443
+				'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5444
+				print_r($base_class_obj_or_id, true)));
5445
+		}
5446
+		return $id;
5447
+	}
5448
+
5449
+
5450
+
5451
+	/**
5452
+	 * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5453
+	 * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5454
+	 * been sanitized and converted into the appropriate domain.
5455
+	 * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5456
+	 * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5457
+	 * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5458
+	 * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5459
+	 * $EVT = EEM_Event::instance(); $old_setting =
5460
+	 * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5461
+	 * $EVT->assume_values_already_prepared_by_model_object(true);
5462
+	 * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5463
+	 * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5464
+	 *
5465
+	 * @param int $values_already_prepared like one of the constants on EEM_Base
5466
+	 * @return void
5467
+	 */
5468
+	public function assume_values_already_prepared_by_model_object(
5469
+		$values_already_prepared = self::not_prepared_by_model_object
5470
+	) {
5471
+		$this->_values_already_prepared_by_model_object = $values_already_prepared;
5472
+	}
5473
+
5474
+
5475
+
5476
+	/**
5477
+	 * Read comments for assume_values_already_prepared_by_model_object()
5478
+	 *
5479
+	 * @return int
5480
+	 */
5481
+	public function get_assumption_concerning_values_already_prepared_by_model_object()
5482
+	{
5483
+		return $this->_values_already_prepared_by_model_object;
5484
+	}
5485
+
5486
+
5487
+
5488
+	/**
5489
+	 * Gets all the indexes on this model
5490
+	 *
5491
+	 * @return EE_Index[]
5492
+	 */
5493
+	public function indexes()
5494
+	{
5495
+		return $this->_indexes;
5496
+	}
5497
+
5498
+
5499
+
5500
+	/**
5501
+	 * Gets all the Unique Indexes on this model
5502
+	 *
5503
+	 * @return EE_Unique_Index[]
5504
+	 */
5505
+	public function unique_indexes()
5506
+	{
5507
+		$unique_indexes = array();
5508
+		foreach ($this->_indexes as $name => $index) {
5509
+			if ($index instanceof EE_Unique_Index) {
5510
+				$unique_indexes [$name] = $index;
5511
+			}
5512
+		}
5513
+		return $unique_indexes;
5514
+	}
5515
+
5516
+
5517
+
5518
+	/**
5519
+	 * Gets all the fields which, when combined, make the primary key.
5520
+	 * This is usually just an array with 1 element (the primary key), but in cases
5521
+	 * where there is no primary key, it's a combination of fields as defined
5522
+	 * on a primary index
5523
+	 *
5524
+	 * @return EE_Model_Field_Base[] indexed by the field's name
5525
+	 * @throws EE_Error
5526
+	 */
5527
+	public function get_combined_primary_key_fields()
5528
+	{
5529
+		foreach ($this->indexes() as $index) {
5530
+			if ($index instanceof EE_Primary_Key_Index) {
5531
+				return $index->fields();
5532
+			}
5533
+		}
5534
+		return array($this->primary_key_name() => $this->get_primary_key_field());
5535
+	}
5536
+
5537
+
5538
+
5539
+	/**
5540
+	 * Used to build a primary key string (when the model has no primary key),
5541
+	 * which can be used a unique string to identify this model object.
5542
+	 *
5543
+	 * @param array $cols_n_values keys are field names, values are their values
5544
+	 * @return string
5545
+	 * @throws EE_Error
5546
+	 */
5547
+	public function get_index_primary_key_string($cols_n_values)
5548
+	{
5549
+		$cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5550
+			$this->get_combined_primary_key_fields());
5551
+		return http_build_query($cols_n_values_for_primary_key_index);
5552
+	}
5553
+
5554
+
5555
+
5556
+	/**
5557
+	 * Gets the field values from the primary key string
5558
+	 *
5559
+	 * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5560
+	 * @param string $index_primary_key_string
5561
+	 * @return null|array
5562
+	 * @throws EE_Error
5563
+	 */
5564
+	public function parse_index_primary_key_string($index_primary_key_string)
5565
+	{
5566
+		$key_fields = $this->get_combined_primary_key_fields();
5567
+		//check all of them are in the $id
5568
+		$key_vals_in_combined_pk = array();
5569
+		parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5570
+		foreach ($key_fields as $key_field_name => $field_obj) {
5571
+			if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5572
+				return null;
5573
+			}
5574
+		}
5575
+		return $key_vals_in_combined_pk;
5576
+	}
5577
+
5578
+
5579
+
5580
+	/**
5581
+	 * verifies that an array of key-value pairs for model fields has a key
5582
+	 * for each field comprising the primary key index
5583
+	 *
5584
+	 * @param array $key_vals
5585
+	 * @return boolean
5586
+	 * @throws EE_Error
5587
+	 */
5588
+	public function has_all_combined_primary_key_fields($key_vals)
5589
+	{
5590
+		$keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5591
+		foreach ($keys_it_should_have as $key) {
5592
+			if (! isset($key_vals[$key])) {
5593
+				return false;
5594
+			}
5595
+		}
5596
+		return true;
5597
+	}
5598
+
5599
+
5600
+
5601
+	/**
5602
+	 * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5603
+	 * We consider something to be a copy if all the attributes match (except the ID, of course).
5604
+	 *
5605
+	 * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5606
+	 * @param array               $query_params                     like EEM_Base::get_all's query_params.
5607
+	 * @throws EE_Error
5608
+	 * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5609
+	 *                                                              indexed)
5610
+	 */
5611
+	public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5612
+	{
5613
+		if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5614
+			$attributes_array = $model_object_or_attributes_array->model_field_array();
5615
+		} elseif (is_array($model_object_or_attributes_array)) {
5616
+			$attributes_array = $model_object_or_attributes_array;
5617
+		} else {
5618
+			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",
5619
+				"event_espresso"), $model_object_or_attributes_array));
5620
+		}
5621
+		//even copies obviously won't have the same ID, so remove the primary key
5622
+		//from the WHERE conditions for finding copies (if there is a primary key, of course)
5623
+		if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5624
+			unset($attributes_array[$this->primary_key_name()]);
5625
+		}
5626
+		if (isset($query_params[0])) {
5627
+			$query_params[0] = array_merge($attributes_array, $query_params);
5628
+		} else {
5629
+			$query_params[0] = $attributes_array;
5630
+		}
5631
+		return $this->get_all($query_params);
5632
+	}
5633
+
5634
+
5635
+
5636
+	/**
5637
+	 * Gets the first copy we find. See get_all_copies for more details
5638
+	 *
5639
+	 * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5640
+	 * @param array $query_params
5641
+	 * @return EE_Base_Class
5642
+	 * @throws EE_Error
5643
+	 */
5644
+	public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5645
+	{
5646
+		if (! is_array($query_params)) {
5647
+			EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5648
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5649
+					gettype($query_params)), '4.6.0');
5650
+			$query_params = array();
5651
+		}
5652
+		$query_params['limit'] = 1;
5653
+		$copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5654
+		if (is_array($copies)) {
5655
+			return array_shift($copies);
5656
+		}
5657
+		return null;
5658
+	}
5659
+
5660
+
5661
+
5662
+	/**
5663
+	 * Updates the item with the specified id. Ignores default query parameters because
5664
+	 * we have specified the ID, and its assumed we KNOW what we're doing
5665
+	 *
5666
+	 * @param array      $fields_n_values keys are field names, values are their new values
5667
+	 * @param int|string $id              the value of the primary key to update
5668
+	 * @return int number of rows updated
5669
+	 * @throws EE_Error
5670
+	 */
5671
+	public function update_by_ID($fields_n_values, $id)
5672
+	{
5673
+		$query_params = array(
5674
+			0                          => array($this->get_primary_key_field()->get_name() => $id),
5675
+			'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
5676
+		);
5677
+		return $this->update($fields_n_values, $query_params);
5678
+	}
5679
+
5680
+
5681
+
5682
+	/**
5683
+	 * Changes an operator which was supplied to the models into one usable in SQL
5684
+	 *
5685
+	 * @param string $operator_supplied
5686
+	 * @return string an operator which can be used in SQL
5687
+	 * @throws EE_Error
5688
+	 */
5689
+	private function _prepare_operator_for_sql($operator_supplied)
5690
+	{
5691
+		$sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5692
+			: null;
5693
+		if ($sql_operator) {
5694
+			return $sql_operator;
5695
+		}
5696
+		throw new EE_Error(
5697
+			sprintf(
5698
+				__(
5699
+					"The operator '%s' is not in the list of valid operators: %s",
5700
+					"event_espresso"
5701
+				), $operator_supplied, implode(",", array_keys($this->_valid_operators))
5702
+			)
5703
+		);
5704
+	}
5705
+
5706
+
5707
+
5708
+	/**
5709
+	 * Gets an array where keys are the primary keys and values are their 'names'
5710
+	 * (as determined by the model object's name() function, which is often overridden)
5711
+	 *
5712
+	 * @param array $query_params like get_all's
5713
+	 * @return string[]
5714
+	 * @throws EE_Error
5715
+	 */
5716
+	public function get_all_names($query_params = array())
5717
+	{
5718
+		$objs = $this->get_all($query_params);
5719
+		$names = array();
5720
+		foreach ($objs as $obj) {
5721
+			$names[$obj->ID()] = $obj->name();
5722
+		}
5723
+		return $names;
5724
+	}
5725
+
5726
+
5727
+
5728
+	/**
5729
+	 * Gets an array of primary keys from the model objects. If you acquired the model objects
5730
+	 * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5731
+	 * this is duplicated effort and reduces efficiency) you would be better to use
5732
+	 * array_keys() on $model_objects.
5733
+	 *
5734
+	 * @param \EE_Base_Class[] $model_objects
5735
+	 * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5736
+	 *                                               in the returned array
5737
+	 * @return array
5738
+	 * @throws EE_Error
5739
+	 */
5740
+	public function get_IDs($model_objects, $filter_out_empty_ids = false)
5741
+	{
5742
+		if (! $this->has_primary_key_field()) {
5743
+			if (WP_DEBUG) {
5744
+				EE_Error::add_error(
5745
+					__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5746
+					__FILE__,
5747
+					__FUNCTION__,
5748
+					__LINE__
5749
+				);
5750
+			}
5751
+		}
5752
+		$IDs = array();
5753
+		foreach ($model_objects as $model_object) {
5754
+			$id = $model_object->ID();
5755
+			if (! $id) {
5756
+				if ($filter_out_empty_ids) {
5757
+					continue;
5758
+				}
5759
+				if (WP_DEBUG) {
5760
+					EE_Error::add_error(
5761
+						__(
5762
+							'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5763
+							'event_espresso'
5764
+						),
5765
+						__FILE__,
5766
+						__FUNCTION__,
5767
+						__LINE__
5768
+					);
5769
+				}
5770
+			}
5771
+			$IDs[] = $id;
5772
+		}
5773
+		return $IDs;
5774
+	}
5775
+
5776
+
5777
+
5778
+	/**
5779
+	 * Returns the string used in capabilities relating to this model. If there
5780
+	 * are no capabilities that relate to this model returns false
5781
+	 *
5782
+	 * @return string|false
5783
+	 */
5784
+	public function cap_slug()
5785
+	{
5786
+		return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5787
+	}
5788
+
5789
+
5790
+
5791
+	/**
5792
+	 * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5793
+	 * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5794
+	 * only returns the cap restrictions array in that context (ie, the array
5795
+	 * at that key)
5796
+	 *
5797
+	 * @param string $context
5798
+	 * @return EE_Default_Where_Conditions[] indexed by associated capability
5799
+	 * @throws EE_Error
5800
+	 */
5801
+	public function cap_restrictions($context = EEM_Base::caps_read)
5802
+	{
5803
+		EEM_Base::verify_is_valid_cap_context($context);
5804
+		//check if we ought to run the restriction generator first
5805
+		if (
5806
+			isset($this->_cap_restriction_generators[$context])
5807
+			&& $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5808
+			&& ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5809
+		) {
5810
+			$this->_cap_restrictions[$context] = array_merge(
5811
+				$this->_cap_restrictions[$context],
5812
+				$this->_cap_restriction_generators[$context]->generate_restrictions()
5813
+			);
5814
+		}
5815
+		//and make sure we've finalized the construction of each restriction
5816
+		foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5817
+			if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5818
+				$where_conditions_obj->_finalize_construct($this);
5819
+			}
5820
+		}
5821
+		return $this->_cap_restrictions[$context];
5822
+	}
5823
+
5824
+
5825
+
5826
+	/**
5827
+	 * Indicating whether or not this model thinks its a wp core model
5828
+	 *
5829
+	 * @return boolean
5830
+	 */
5831
+	public function is_wp_core_model()
5832
+	{
5833
+		return $this->_wp_core_model;
5834
+	}
5835
+
5836
+
5837
+
5838
+	/**
5839
+	 * Gets all the caps that are missing which impose a restriction on
5840
+	 * queries made in this context
5841
+	 *
5842
+	 * @param string $context one of EEM_Base::caps_ constants
5843
+	 * @return EE_Default_Where_Conditions[] indexed by capability name
5844
+	 * @throws EE_Error
5845
+	 */
5846
+	public function caps_missing($context = EEM_Base::caps_read)
5847
+	{
5848
+		$missing_caps = array();
5849
+		$cap_restrictions = $this->cap_restrictions($context);
5850
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5851
+			if (! EE_Capabilities::instance()
5852
+								 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5853
+			) {
5854
+				$missing_caps[$cap] = $restriction_if_no_cap;
5855
+			}
5856
+		}
5857
+		return $missing_caps;
5858
+	}
5859
+
5860
+
5861
+
5862
+	/**
5863
+	 * Gets the mapping from capability contexts to action strings used in capability names
5864
+	 *
5865
+	 * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5866
+	 * one of 'read', 'edit', or 'delete'
5867
+	 */
5868
+	public function cap_contexts_to_cap_action_map()
5869
+	{
5870
+		return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5871
+			$this);
5872
+	}
5873
+
5874
+
5875
+
5876
+	/**
5877
+	 * Gets the action string for the specified capability context
5878
+	 *
5879
+	 * @param string $context
5880
+	 * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5881
+	 * @throws EE_Error
5882
+	 */
5883
+	public function cap_action_for_context($context)
5884
+	{
5885
+		$mapping = $this->cap_contexts_to_cap_action_map();
5886
+		if (isset($mapping[$context])) {
5887
+			return $mapping[$context];
5888
+		}
5889
+		if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5890
+			return $action;
5891
+		}
5892
+		throw new EE_Error(
5893
+			sprintf(
5894
+				__('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5895
+				$context,
5896
+				implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5897
+			)
5898
+		);
5899
+	}
5900
+
5901
+
5902
+
5903
+	/**
5904
+	 * Returns all the capability contexts which are valid when querying models
5905
+	 *
5906
+	 * @return array
5907
+	 */
5908
+	public static function valid_cap_contexts()
5909
+	{
5910
+		return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5911
+			self::caps_read,
5912
+			self::caps_read_admin,
5913
+			self::caps_edit,
5914
+			self::caps_delete,
5915
+		));
5916
+	}
5917
+
5918
+
5919
+
5920
+	/**
5921
+	 * Returns all valid options for 'default_where_conditions'
5922
+	 *
5923
+	 * @return array
5924
+	 */
5925
+	public static function valid_default_where_conditions()
5926
+	{
5927
+		return array(
5928
+			EEM_Base::default_where_conditions_all,
5929
+			EEM_Base::default_where_conditions_this_only,
5930
+			EEM_Base::default_where_conditions_others_only,
5931
+			EEM_Base::default_where_conditions_minimum_all,
5932
+			EEM_Base::default_where_conditions_minimum_others,
5933
+			EEM_Base::default_where_conditions_none
5934
+		);
5935
+	}
5936
+
5937
+	// public static function default_where_conditions_full
5938
+	/**
5939
+	 * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5940
+	 *
5941
+	 * @param string $context
5942
+	 * @return bool
5943
+	 * @throws EE_Error
5944
+	 */
5945
+	static public function verify_is_valid_cap_context($context)
5946
+	{
5947
+		$valid_cap_contexts = EEM_Base::valid_cap_contexts();
5948
+		if (in_array($context, $valid_cap_contexts)) {
5949
+			return true;
5950
+		}
5951
+		throw new EE_Error(
5952
+			sprintf(
5953
+				__(
5954
+					'Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5955
+					'event_espresso'
5956
+				),
5957
+				$context,
5958
+				'EEM_Base',
5959
+				implode(',', $valid_cap_contexts)
5960
+			)
5961
+		);
5962
+	}
5963
+
5964
+
5965
+
5966
+	/**
5967
+	 * Clears all the models field caches. This is only useful when a sub-class
5968
+	 * might have added a field or something and these caches might be invalidated
5969
+	 */
5970
+	protected function _invalidate_field_caches()
5971
+	{
5972
+		$this->_cache_foreign_key_to_fields = array();
5973
+		$this->_cached_fields = null;
5974
+		$this->_cached_fields_non_db_only = null;
5975
+	}
5976
+
5977
+
5978
+
5979
+	/**
5980
+	 * Gets the list of all the where query param keys that relate to logic instead of field names
5981
+	 * (eg "and", "or", "not").
5982
+	 *
5983
+	 * @return array
5984
+	 */
5985
+	public function logic_query_param_keys()
5986
+	{
5987
+		return $this->_logic_query_param_keys;
5988
+	}
5989
+
5990
+
5991
+
5992
+	/**
5993
+	 * Determines whether or not the where query param array key is for a logic query param.
5994
+	 * Eg 'OR', 'not*', and 'and*because-i-say-so' should all return true, whereas
5995
+	 * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
5996
+	 *
5997
+	 * @param $query_param_key
5998
+	 * @return bool
5999
+	 */
6000
+	public function is_logic_query_param_key($query_param_key)
6001
+	{
6002
+		foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
6003
+			if ($query_param_key === $logic_query_param_key
6004
+				|| strpos($query_param_key, $logic_query_param_key . '*') === 0
6005
+			) {
6006
+				return true;
6007
+			}
6008
+		}
6009
+		return false;
6010
+	}
6011 6011
 
6012 6012
 
6013 6013
 
Please login to merge, or discard this patch.
Spacing   +155 added lines, -155 removed lines patch added patch discarded remove patch
@@ -519,8 +519,8 @@  discard block
 block discarded – undo
519 519
     protected function __construct($timezone = null)
520 520
     {
521 521
         // check that the model has not been loaded too soon
522
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
523
-            throw new EE_Error (
522
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')) {
523
+            throw new EE_Error(
524 524
                 sprintf(
525 525
                     __('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.',
526 526
                         'event_espresso'),
@@ -540,7 +540,7 @@  discard block
 block discarded – undo
540 540
          *
541 541
          * @var EE_Table_Base[] $_tables
542 542
          */
543
-        $this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
543
+        $this->_tables = apply_filters('FHEE__'.get_class($this).'__construct__tables', $this->_tables);
544 544
         foreach ($this->_tables as $table_alias => $table_obj) {
545 545
             /** @var $table_obj EE_Table_Base */
546 546
             $table_obj->_construct_finalize_with_alias($table_alias);
@@ -555,10 +555,10 @@  discard block
 block discarded – undo
555 555
          *
556 556
          * @param EE_Model_Field_Base[] $_fields
557 557
          */
558
-        $this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
558
+        $this->_fields = apply_filters('FHEE__'.get_class($this).'__construct__fields', $this->_fields);
559 559
         $this->_invalidate_field_caches();
560 560
         foreach ($this->_fields as $table_alias => $fields_for_table) {
561
-            if (! array_key_exists($table_alias, $this->_tables)) {
561
+            if ( ! array_key_exists($table_alias, $this->_tables)) {
562 562
                 throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
563 563
                     'event_espresso'), $table_alias, implode(",", $this->_fields)));
564 564
             }
@@ -586,7 +586,7 @@  discard block
 block discarded – undo
586 586
          *
587 587
          * @param EE_Model_Relation_Base[] $_model_relations
588 588
          */
589
-        $this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
589
+        $this->_model_relations = apply_filters('FHEE__'.get_class($this).'__construct__model_relations',
590 590
             $this->_model_relations);
591 591
         foreach ($this->_model_relations as $model_name => $relation_obj) {
592 592
             /** @var $relation_obj EE_Model_Relation_Base */
@@ -598,12 +598,12 @@  discard block
 block discarded – undo
598 598
         }
599 599
         $this->set_timezone($timezone);
600 600
         //finalize default where condition strategy, or set default
601
-        if (! $this->_default_where_conditions_strategy) {
601
+        if ( ! $this->_default_where_conditions_strategy) {
602 602
             //nothing was set during child constructor, so set default
603 603
             $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
604 604
         }
605 605
         $this->_default_where_conditions_strategy->_finalize_construct($this);
606
-        if (! $this->_minimum_where_conditions_strategy) {
606
+        if ( ! $this->_minimum_where_conditions_strategy) {
607 607
             //nothing was set during child constructor, so set default
608 608
             $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
609 609
         }
@@ -616,7 +616,7 @@  discard block
 block discarded – undo
616 616
         //initialize the standard cap restriction generators if none were specified by the child constructor
617 617
         if ($this->_cap_restriction_generators !== false) {
618 618
             foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
619
-                if (! isset($this->_cap_restriction_generators[$cap_context])) {
619
+                if ( ! isset($this->_cap_restriction_generators[$cap_context])) {
620 620
                     $this->_cap_restriction_generators[$cap_context] = apply_filters(
621 621
                         'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
622 622
                         new EE_Restriction_Generator_Protected(),
@@ -629,10 +629,10 @@  discard block
 block discarded – undo
629 629
         //if there are cap restriction generators, use them to make the default cap restrictions
630 630
         if ($this->_cap_restriction_generators !== false) {
631 631
             foreach ($this->_cap_restriction_generators as $context => $generator_object) {
632
-                if (! $generator_object) {
632
+                if ( ! $generator_object) {
633 633
                     continue;
634 634
                 }
635
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
635
+                if ( ! $generator_object instanceof EE_Restriction_Generator_Base) {
636 636
                     throw new EE_Error(
637 637
                         sprintf(
638 638
                             __('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.',
@@ -643,12 +643,12 @@  discard block
 block discarded – undo
643 643
                     );
644 644
                 }
645 645
                 $action = $this->cap_action_for_context($context);
646
-                if (! $generator_object->construction_finalized()) {
646
+                if ( ! $generator_object->construction_finalized()) {
647 647
                     $generator_object->_construct_finalize($this, $action);
648 648
                 }
649 649
             }
650 650
         }
651
-        do_action('AHEE__' . get_class($this) . '__construct__end');
651
+        do_action('AHEE__'.get_class($this).'__construct__end');
652 652
     }
653 653
 
654 654
 
@@ -683,7 +683,7 @@  discard block
 block discarded – undo
683 683
      */
684 684
     public static function set_model_query_blog_id($blog_id = 0)
685 685
     {
686
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
686
+        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int) $blog_id : get_current_blog_id();
687 687
     }
688 688
 
689 689
 
@@ -718,7 +718,7 @@  discard block
 block discarded – undo
718 718
     public static function instance($timezone = null, ModelFieldFactory $model_field_factory = null)
719 719
     {
720 720
         // check if instance of Espresso_model already exists
721
-        if (! static::$_instance instanceof static) {
721
+        if ( ! static::$_instance instanceof static) {
722 722
             $model_field_factory = self::getModelFieldFactory($model_field_factory);
723 723
             // instantiate Espresso_model
724 724
             static::$_instance = new static($timezone, $model_field_factory);
@@ -772,7 +772,7 @@  discard block
 block discarded – undo
772 772
             foreach ($r->getDefaultProperties() as $property => $value) {
773 773
                 //don't set instance to null like it was originally,
774 774
                 //but it's static anyways, and we're ignoring static properties (for now at least)
775
-                if (! isset($static_properties[$property])) {
775
+                if ( ! isset($static_properties[$property])) {
776 776
                     static::$_instance->{$property} = $value;
777 777
                 }
778 778
             }
@@ -795,7 +795,7 @@  discard block
 block discarded – undo
795 795
      */
796 796
     public function status_array($translated = false)
797 797
     {
798
-        if (! array_key_exists('Status', $this->_model_relations)) {
798
+        if ( ! array_key_exists('Status', $this->_model_relations)) {
799 799
             return array();
800 800
         }
801 801
         $model_name = $this->get_this_model_name();
@@ -998,17 +998,17 @@  discard block
 block discarded – undo
998 998
     public function wp_user_field_name()
999 999
     {
1000 1000
         try {
1001
-            if (! empty($this->_model_chain_to_wp_user)) {
1001
+            if ( ! empty($this->_model_chain_to_wp_user)) {
1002 1002
                 $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
1003 1003
                 $last_model_name = end($models_to_follow_to_wp_users);
1004 1004
                 $model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
1005
-                $model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
1005
+                $model_chain_to_wp_user = $this->_model_chain_to_wp_user.'.';
1006 1006
             } else {
1007 1007
                 $model_with_fk_to_wp_users = $this;
1008 1008
                 $model_chain_to_wp_user = '';
1009 1009
             }
1010 1010
             $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
1011
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
1011
+            return $model_chain_to_wp_user.$wp_user_field->get_name();
1012 1012
         } catch (EE_Error $e) {
1013 1013
             return false;
1014 1014
         }
@@ -1079,12 +1079,12 @@  discard block
 block discarded – undo
1079 1079
         // remember the custom selections, if any, and type cast as array
1080 1080
         // (unless $columns_to_select is an object, then just set as an empty array)
1081 1081
         // Note: (array) 'some string' === array( 'some string' )
1082
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1082
+        $this->_custom_selections = ! is_object($columns_to_select) ? (array) $columns_to_select : array();
1083 1083
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
1084 1084
         $select_expressions = $columns_to_select !== null
1085 1085
             ? $this->_construct_select_from_input($columns_to_select)
1086 1086
             : $this->_construct_default_select_sql($model_query_info);
1087
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1087
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
1088 1088
         return $this->_do_wpdb_query('get_results', array($SQL, $output));
1089 1089
     }
1090 1090
 
@@ -1129,7 +1129,7 @@  discard block
 block discarded – undo
1129 1129
         if (is_array($columns_to_select)) {
1130 1130
             $select_sql_array = array();
1131 1131
             foreach ($columns_to_select as $alias => $selection_and_datatype) {
1132
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1132
+                if ( ! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1133 1133
                     throw new EE_Error(
1134 1134
                         sprintf(
1135 1135
                             __(
@@ -1141,7 +1141,7 @@  discard block
 block discarded – undo
1141 1141
                         )
1142 1142
                     );
1143 1143
                 }
1144
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1144
+                if ( ! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1145 1145
                     throw new EE_Error(
1146 1146
                         sprintf(
1147 1147
                             __(
@@ -1213,7 +1213,7 @@  discard block
 block discarded – undo
1213 1213
      */
1214 1214
     public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1215 1215
     {
1216
-        if (! isset($query_params[0])) {
1216
+        if ( ! isset($query_params[0])) {
1217 1217
             $query_params[0] = array();
1218 1218
         }
1219 1219
         $conditions_from_id = $this->parse_index_primary_key_string($id);
@@ -1238,7 +1238,7 @@  discard block
 block discarded – undo
1238 1238
      */
1239 1239
     public function get_one($query_params = array())
1240 1240
     {
1241
-        if (! is_array($query_params)) {
1241
+        if ( ! is_array($query_params)) {
1242 1242
             EE_Error::doing_it_wrong('EEM_Base::get_one',
1243 1243
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1244 1244
                     gettype($query_params)), '4.6.0');
@@ -1429,7 +1429,7 @@  discard block
 block discarded – undo
1429 1429
                 return array();
1430 1430
             }
1431 1431
         }
1432
-        if (! is_array($query_params)) {
1432
+        if ( ! is_array($query_params)) {
1433 1433
             EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1434 1434
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1435 1435
                     gettype($query_params)), '4.6.0');
@@ -1439,7 +1439,7 @@  discard block
 block discarded – undo
1439 1439
         $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1440 1440
         $query_params['limit'] = $limit;
1441 1441
         //set direction
1442
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1442
+        $incoming_orderby = isset($query_params['order_by']) ? (array) $query_params['order_by'] : array();
1443 1443
         $query_params['order_by'] = $operand === '>'
1444 1444
             ? array($field_to_order_by => 'ASC') + $incoming_orderby
1445 1445
             : array($field_to_order_by => 'DESC') + $incoming_orderby;
@@ -1517,7 +1517,7 @@  discard block
 block discarded – undo
1517 1517
     {
1518 1518
         $field_settings = $this->field_settings_for($field_name);
1519 1519
         //if not a valid EE_Datetime_Field then throw error
1520
-        if (! $field_settings instanceof EE_Datetime_Field) {
1520
+        if ( ! $field_settings instanceof EE_Datetime_Field) {
1521 1521
             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.',
1522 1522
                 'event_espresso'), $field_name));
1523 1523
         }
@@ -1596,7 +1596,7 @@  discard block
 block discarded – undo
1596 1596
         //load EEH_DTT_Helper
1597 1597
         $set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1598 1598
         $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1599
-        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1599
+        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime($incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)));
1600 1600
     }
1601 1601
 
1602 1602
 
@@ -1664,7 +1664,7 @@  discard block
 block discarded – undo
1664 1664
      */
1665 1665
     public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1666 1666
     {
1667
-        if (! is_array($query_params)) {
1667
+        if ( ! is_array($query_params)) {
1668 1668
             EE_Error::doing_it_wrong('EEM_Base::update',
1669 1669
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1670 1670
                     gettype($query_params)), '4.6.0');
@@ -1686,7 +1686,7 @@  discard block
 block discarded – undo
1686 1686
          * @param EEM_Base $model           the model being queried
1687 1687
          * @param array    $query_params    see EEM_Base::get_all()
1688 1688
          */
1689
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1689
+        $fields_n_values = (array) apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1690 1690
             $query_params);
1691 1691
         //need to verify that, for any entry we want to update, there are entries in each secondary table.
1692 1692
         //to do that, for each table, verify that it's PK isn't null.
@@ -1700,7 +1700,7 @@  discard block
 block discarded – undo
1700 1700
         $wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1701 1701
         foreach ($wpdb_select_results as $wpdb_result) {
1702 1702
             // type cast stdClass as array
1703
-            $wpdb_result = (array)$wpdb_result;
1703
+            $wpdb_result = (array) $wpdb_result;
1704 1704
             //get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1705 1705
             if ($this->has_primary_key_field()) {
1706 1706
                 $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
@@ -1717,13 +1717,13 @@  discard block
 block discarded – undo
1717 1717
                     $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1718 1718
                     //if there is no private key for this table on the results, it means there's no entry
1719 1719
                     //in this table, right? so insert a row in the current table, using any fields available
1720
-                    if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1720
+                    if ( ! (array_key_exists($this_table_pk_column, $wpdb_result)
1721 1721
                            && $wpdb_result[$this_table_pk_column])
1722 1722
                     ) {
1723 1723
                         $success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1724 1724
                             $main_table_pk_value);
1725 1725
                         //if we died here, report the error
1726
-                        if (! $success) {
1726
+                        if ( ! $success) {
1727 1727
                             return false;
1728 1728
                         }
1729 1729
                     }
@@ -1754,7 +1754,7 @@  discard block
 block discarded – undo
1754 1754
                     $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1755 1755
                 }
1756 1756
             }
1757
-            if (! $model_objs_affected_ids) {
1757
+            if ( ! $model_objs_affected_ids) {
1758 1758
                 //wait wait wait- if nothing was affected let's stop here
1759 1759
                 return 0;
1760 1760
             }
@@ -1781,7 +1781,7 @@  discard block
 block discarded – undo
1781 1781
                . $model_query_info->get_full_join_sql()
1782 1782
                . " SET "
1783 1783
                . $this->_construct_update_sql($fields_n_values)
1784
-               . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1784
+               . $model_query_info->get_where_sql(); //note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1785 1785
         $rows_affected = $this->_do_wpdb_query('query', array($SQL));
1786 1786
         /**
1787 1787
          * Action called after a model update call has been made.
@@ -1792,7 +1792,7 @@  discard block
 block discarded – undo
1792 1792
          * @param int      $rows_affected
1793 1793
          */
1794 1794
         do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1795
-        return $rows_affected;//how many supposedly got updated
1795
+        return $rows_affected; //how many supposedly got updated
1796 1796
     }
1797 1797
 
1798 1798
 
@@ -1820,7 +1820,7 @@  discard block
 block discarded – undo
1820 1820
         }
1821 1821
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
1822 1822
         $select_expressions = $field->get_qualified_column();
1823
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1823
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
1824 1824
         return $this->_do_wpdb_query('get_col', array($SQL));
1825 1825
     }
1826 1826
 
@@ -1838,7 +1838,7 @@  discard block
 block discarded – undo
1838 1838
     {
1839 1839
         $query_params['limit'] = 1;
1840 1840
         $col = $this->get_col($query_params, $field_to_select);
1841
-        if (! empty($col)) {
1841
+        if ( ! empty($col)) {
1842 1842
             return reset($col);
1843 1843
         }
1844 1844
         return null;
@@ -1869,7 +1869,7 @@  discard block
 block discarded – undo
1869 1869
             $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1870 1870
             $value_sql = $prepared_value === null ? 'NULL'
1871 1871
                 : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1872
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1872
+            $cols_n_values[] = $field_obj->get_qualified_column()."=".$value_sql;
1873 1873
         }
1874 1874
         return implode(",", $cols_n_values);
1875 1875
     }
@@ -2047,7 +2047,7 @@  discard block
 block discarded – undo
2047 2047
          * @param int      $rows_deleted
2048 2048
          */
2049 2049
         do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
2050
-        return $rows_deleted;//how many supposedly got deleted
2050
+        return $rows_deleted; //how many supposedly got deleted
2051 2051
     }
2052 2052
 
2053 2053
 
@@ -2196,7 +2196,7 @@  discard block
 block discarded – undo
2196 2196
             foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
2197 2197
                 //make sure we have unique $ids
2198 2198
                 $ids = array_unique($ids);
2199
-                $query[] = $column . ' IN(' . implode(',', $ids) . ')';
2199
+                $query[] = $column.' IN('.implode(',', $ids).')';
2200 2200
             }
2201 2201
             $query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
2202 2202
         } elseif (count($this->get_combined_primary_key_fields()) > 1) {
@@ -2204,9 +2204,9 @@  discard block
 block discarded – undo
2204 2204
             foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
2205 2205
                 $values_for_each_combined_primary_key_for_a_row = array();
2206 2206
                 foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
2207
-                    $values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
2207
+                    $values_for_each_combined_primary_key_for_a_row[] = $column.'='.$id;
2208 2208
                 }
2209
-                $ways_to_identify_a_row[] = '(' . implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
2209
+                $ways_to_identify_a_row[] = '('.implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
2210 2210
             }
2211 2211
             $query_part = implode(' OR ', $ways_to_identify_a_row);
2212 2212
         }
@@ -2252,9 +2252,9 @@  discard block
 block discarded – undo
2252 2252
                 $column_to_count = '*';
2253 2253
             }
2254 2254
         }
2255
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2256
-        $SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2257
-        return (int)$this->_do_wpdb_query('get_var', array($SQL));
2255
+        $column_to_count = $distinct ? "DISTINCT ".$column_to_count : $column_to_count;
2256
+        $SQL = "SELECT COUNT(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
2257
+        return (int) $this->_do_wpdb_query('get_var', array($SQL));
2258 2258
     }
2259 2259
 
2260 2260
 
@@ -2276,14 +2276,14 @@  discard block
 block discarded – undo
2276 2276
             $field_obj = $this->get_primary_key_field();
2277 2277
         }
2278 2278
         $column_to_count = $field_obj->get_qualified_column();
2279
-        $SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2279
+        $SQL = "SELECT SUM(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
2280 2280
         $return_value = $this->_do_wpdb_query('get_var', array($SQL));
2281 2281
         $data_type = $field_obj->get_wpdb_data_type();
2282 2282
         if ($data_type === '%d' || $data_type === '%s') {
2283
-            return (float)$return_value;
2283
+            return (float) $return_value;
2284 2284
         }
2285 2285
         //must be %f
2286
-        return (float)$return_value;
2286
+        return (float) $return_value;
2287 2287
     }
2288 2288
 
2289 2289
 
@@ -2303,13 +2303,13 @@  discard block
 block discarded – undo
2303 2303
         //if we're in maintenance mode level 2, DON'T run any queries
2304 2304
         //because level 2 indicates the database needs updating and
2305 2305
         //is probably out of sync with the code
2306
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2306
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
2307 2307
             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.",
2308 2308
                 "event_espresso")));
2309 2309
         }
2310 2310
         /** @type WPDB $wpdb */
2311 2311
         global $wpdb;
2312
-        if (! method_exists($wpdb, $wpdb_method)) {
2312
+        if ( ! method_exists($wpdb, $wpdb_method)) {
2313 2313
             throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2314 2314
                 'event_espresso'), $wpdb_method));
2315 2315
         }
@@ -2321,7 +2321,7 @@  discard block
 block discarded – undo
2321 2321
         $this->show_db_query_if_previously_requested($wpdb->last_query);
2322 2322
         if (WP_DEBUG) {
2323 2323
             $wpdb->show_errors($old_show_errors_value);
2324
-            if (! empty($wpdb->last_error)) {
2324
+            if ( ! empty($wpdb->last_error)) {
2325 2325
                 throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2326 2326
             }
2327 2327
             if ($result === false) {
@@ -2382,7 +2382,7 @@  discard block
 block discarded – undo
2382 2382
                     return $result;
2383 2383
                     break;
2384 2384
             }
2385
-            if (! empty($error_message)) {
2385
+            if ( ! empty($error_message)) {
2386 2386
                 EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2387 2387
                 trigger_error($error_message);
2388 2388
             }
@@ -2458,11 +2458,11 @@  discard block
 block discarded – undo
2458 2458
      */
2459 2459
     private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2460 2460
     {
2461
-        return " FROM " . $model_query_info->get_full_join_sql() .
2462
-               $model_query_info->get_where_sql() .
2463
-               $model_query_info->get_group_by_sql() .
2464
-               $model_query_info->get_having_sql() .
2465
-               $model_query_info->get_order_by_sql() .
2461
+        return " FROM ".$model_query_info->get_full_join_sql().
2462
+               $model_query_info->get_where_sql().
2463
+               $model_query_info->get_group_by_sql().
2464
+               $model_query_info->get_having_sql().
2465
+               $model_query_info->get_order_by_sql().
2466 2466
                $model_query_info->get_limit_sql();
2467 2467
     }
2468 2468
 
@@ -2658,12 +2658,12 @@  discard block
 block discarded – undo
2658 2658
         $related_model = $this->get_related_model_obj($model_name);
2659 2659
         //we're just going to use the query params on the related model's normal get_all query,
2660 2660
         //except add a condition to say to match the current mod
2661
-        if (! isset($query_params['default_where_conditions'])) {
2661
+        if ( ! isset($query_params['default_where_conditions'])) {
2662 2662
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2663 2663
         }
2664 2664
         $this_model_name = $this->get_this_model_name();
2665 2665
         $this_pk_field_name = $this->get_primary_key_field()->get_name();
2666
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2666
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
2667 2667
         return $related_model->count($query_params, $field_to_count, $distinct);
2668 2668
     }
2669 2669
 
@@ -2683,7 +2683,7 @@  discard block
 block discarded – undo
2683 2683
     public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2684 2684
     {
2685 2685
         $related_model = $this->get_related_model_obj($model_name);
2686
-        if (! is_array($query_params)) {
2686
+        if ( ! is_array($query_params)) {
2687 2687
             EE_Error::doing_it_wrong('EEM_Base::sum_related',
2688 2688
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2689 2689
                     gettype($query_params)), '4.6.0');
@@ -2691,12 +2691,12 @@  discard block
 block discarded – undo
2691 2691
         }
2692 2692
         //we're just going to use the query params on the related model's normal get_all query,
2693 2693
         //except add a condition to say to match the current mod
2694
-        if (! isset($query_params['default_where_conditions'])) {
2694
+        if ( ! isset($query_params['default_where_conditions'])) {
2695 2695
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2696 2696
         }
2697 2697
         $this_model_name = $this->get_this_model_name();
2698 2698
         $this_pk_field_name = $this->get_primary_key_field()->get_name();
2699
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2699
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
2700 2700
         return $related_model->sum($query_params, $field_to_sum);
2701 2701
     }
2702 2702
 
@@ -2749,7 +2749,7 @@  discard block
 block discarded – undo
2749 2749
                 $field_with_model_name = $field;
2750 2750
             }
2751 2751
         }
2752
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
2752
+        if ( ! isset($field_with_model_name) || ! $field_with_model_name) {
2753 2753
             throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2754 2754
                 $this->get_this_model_name()));
2755 2755
         }
@@ -2782,7 +2782,7 @@  discard block
 block discarded – undo
2782 2782
          * @param array    $fields_n_values keys are the fields and values are their new values
2783 2783
          * @param EEM_Base $model           the model used
2784 2784
          */
2785
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2785
+        $field_n_values = (array) apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2786 2786
         if ($this->_satisfies_unique_indexes($field_n_values)) {
2787 2787
             $main_table = $this->_get_main_table();
2788 2788
             $new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
@@ -2889,7 +2889,7 @@  discard block
 block discarded – undo
2889 2889
         }
2890 2890
         foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2891 2891
             $uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2892
-            $query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2892
+            $query_params[0]['OR']['AND*'.$unique_index_name] = $uniqueness_where_params;
2893 2893
         }
2894 2894
         //if there is nothing to base this search on, then we shouldn't find anything
2895 2895
         if (empty($query_params)) {
@@ -2975,7 +2975,7 @@  discard block
 block discarded – undo
2975 2975
             //its not the main table, so we should have already saved the main table's PK which we just inserted
2976 2976
             //so add the fk to the main table as a column
2977 2977
             $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2978
-            $format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2978
+            $format_for_insertion[] = '%d'; //yes right now we're only allowing these foreign keys to be INTs
2979 2979
         }
2980 2980
         //insert the new entry
2981 2981
         $result = $this->_do_wpdb_query('insert',
@@ -3179,7 +3179,7 @@  discard block
 block discarded – undo
3179 3179
                     $query_info_carrier,
3180 3180
                     'group_by'
3181 3181
                 );
3182
-            } elseif (! empty ($query_params['group_by'])) {
3182
+            } elseif ( ! empty ($query_params['group_by'])) {
3183 3183
                 $this->_extract_related_model_info_from_query_param(
3184 3184
                     $query_params['group_by'],
3185 3185
                     $query_info_carrier,
@@ -3201,7 +3201,7 @@  discard block
 block discarded – undo
3201 3201
                     $query_info_carrier,
3202 3202
                     'order_by'
3203 3203
                 );
3204
-            } elseif (! empty($query_params['order_by'])) {
3204
+            } elseif ( ! empty($query_params['order_by'])) {
3205 3205
                 $this->_extract_related_model_info_from_query_param(
3206 3206
                     $query_params['order_by'],
3207 3207
                     $query_info_carrier,
@@ -3236,8 +3236,8 @@  discard block
 block discarded – undo
3236 3236
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
3237 3237
         $query_param_type
3238 3238
     ) {
3239
-        if (! empty($sub_query_params)) {
3240
-            $sub_query_params = (array)$sub_query_params;
3239
+        if ( ! empty($sub_query_params)) {
3240
+            $sub_query_params = (array) $sub_query_params;
3241 3241
             foreach ($sub_query_params as $param => $possibly_array_of_params) {
3242 3242
                 //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3243 3243
                 $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
@@ -3248,7 +3248,7 @@  discard block
 block discarded – undo
3248 3248
                 //of array('Registration.TXN_ID'=>23)
3249 3249
                 $query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3250 3250
                 if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3251
-                    if (! is_array($possibly_array_of_params)) {
3251
+                    if ( ! is_array($possibly_array_of_params)) {
3252 3252
                         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'))",
3253 3253
                             "event_espresso"),
3254 3254
                             $param, $possibly_array_of_params));
@@ -3265,7 +3265,7 @@  discard block
 block discarded – undo
3265 3265
                     //then $possible_array_of_params looks something like array('<','DTT_sold',true)
3266 3266
                     //indicating that $possible_array_of_params[1] is actually a field name,
3267 3267
                     //from which we should extract query parameters!
3268
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3268
+                    if ( ! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3269 3269
                         throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3270 3270
                             "event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3271 3271
                     }
@@ -3295,8 +3295,8 @@  discard block
 block discarded – undo
3295 3295
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
3296 3296
         $query_param_type
3297 3297
     ) {
3298
-        if (! empty($sub_query_params)) {
3299
-            if (! is_array($sub_query_params)) {
3298
+        if ( ! empty($sub_query_params)) {
3299
+            if ( ! is_array($sub_query_params)) {
3300 3300
                 throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3301 3301
                     $sub_query_params));
3302 3302
             }
@@ -3325,7 +3325,7 @@  discard block
 block discarded – undo
3325 3325
      */
3326 3326
     public function _create_model_query_info_carrier($query_params)
3327 3327
     {
3328
-        if (! is_array($query_params)) {
3328
+        if ( ! is_array($query_params)) {
3329 3329
             EE_Error::doing_it_wrong(
3330 3330
                 'EEM_Base::_create_model_query_info_carrier',
3331 3331
                 sprintf(
@@ -3401,7 +3401,7 @@  discard block
 block discarded – undo
3401 3401
         //set limit
3402 3402
         if (array_key_exists('limit', $query_params)) {
3403 3403
             if (is_array($query_params['limit'])) {
3404
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3404
+                if ( ! isset($query_params['limit'][0], $query_params['limit'][1])) {
3405 3405
                     $e = sprintf(
3406 3406
                         __(
3407 3407
                             "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)",
@@ -3409,12 +3409,12 @@  discard block
 block discarded – undo
3409 3409
                         ),
3410 3410
                         http_build_query($query_params['limit'])
3411 3411
                     );
3412
-                    throw new EE_Error($e . "|" . $e);
3412
+                    throw new EE_Error($e."|".$e);
3413 3413
                 }
3414 3414
                 //they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3415
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3416
-            } elseif (! empty ($query_params['limit'])) {
3417
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3415
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit'][0].",".$query_params['limit'][1]);
3416
+            } elseif ( ! empty ($query_params['limit'])) {
3417
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit']);
3418 3418
             }
3419 3419
         }
3420 3420
         //set order by
@@ -3446,10 +3446,10 @@  discard block
 block discarded – undo
3446 3446
                 $order_array = array();
3447 3447
                 foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3448 3448
                     $order = $this->_extract_order($order);
3449
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3449
+                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by).SP.$order;
3450 3450
                 }
3451
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3452
-            } elseif (! empty ($query_params['order_by'])) {
3451
+                $query_object->set_order_by_sql(" ORDER BY ".implode(",", $order_array));
3452
+            } elseif ( ! empty ($query_params['order_by'])) {
3453 3453
                 $this->_extract_related_model_info_from_query_param(
3454 3454
                     $query_params['order_by'],
3455 3455
                     $query_object,
@@ -3460,18 +3460,18 @@  discard block
 block discarded – undo
3460 3460
                     ? $this->_extract_order($query_params['order'])
3461 3461
                     : 'DESC';
3462 3462
                 $query_object->set_order_by_sql(
3463
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3463
+                    " ORDER BY ".$this->_deduce_column_name_from_query_param($query_params['order_by']).SP.$order
3464 3464
                 );
3465 3465
             }
3466 3466
         }
3467 3467
         //if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3468
-        if (! array_key_exists('order_by', $query_params)
3468
+        if ( ! array_key_exists('order_by', $query_params)
3469 3469
             && array_key_exists('order', $query_params)
3470 3470
             && ! empty($query_params['order'])
3471 3471
         ) {
3472 3472
             $pk_field = $this->get_primary_key_field();
3473 3473
             $order = $this->_extract_order($query_params['order']);
3474
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3474
+            $query_object->set_order_by_sql(" ORDER BY ".$pk_field->get_qualified_column().SP.$order);
3475 3475
         }
3476 3476
         //set group by
3477 3477
         if (array_key_exists('group_by', $query_params)) {
@@ -3481,10 +3481,10 @@  discard block
 block discarded – undo
3481 3481
                 foreach ($query_params['group_by'] as $field_name_to_group_by) {
3482 3482
                     $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3483 3483
                 }
3484
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3485
-            } elseif (! empty ($query_params['group_by'])) {
3484
+                $query_object->set_group_by_sql(" GROUP BY ".implode(", ", $group_by_array));
3485
+            } elseif ( ! empty ($query_params['group_by'])) {
3486 3486
                 $query_object->set_group_by_sql(
3487
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3487
+                    " GROUP BY ".$this->_deduce_column_name_from_query_param($query_params['group_by'])
3488 3488
                 );
3489 3489
             }
3490 3490
         }
@@ -3494,7 +3494,7 @@  discard block
 block discarded – undo
3494 3494
         }
3495 3495
         //now, just verify they didn't pass anything wack
3496 3496
         foreach ($query_params as $query_key => $query_value) {
3497
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
3497
+            if ( ! in_array($query_key, $this->_allowed_query_params, true)) {
3498 3498
                 throw new EE_Error(
3499 3499
                     sprintf(
3500 3500
                         __(
@@ -3593,22 +3593,22 @@  discard block
 block discarded – undo
3593 3593
         $where_query_params = array()
3594 3594
     ) {
3595 3595
         $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3596
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3596
+        if ( ! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3597 3597
             throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3598 3598
                 "event_espresso"), $use_default_where_conditions,
3599 3599
                 implode(", ", $allowed_used_default_where_conditions_values)));
3600 3600
         }
3601 3601
         $universal_query_params = array();
3602
-        if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3602
+        if ($this->_should_use_default_where_conditions($use_default_where_conditions, true)) {
3603 3603
             $universal_query_params = $this->_get_default_where_conditions();
3604
-        } else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3604
+        } else if ($this->_should_use_minimum_where_conditions($use_default_where_conditions, true)) {
3605 3605
             $universal_query_params = $this->_get_minimum_where_conditions();
3606 3606
         }
3607 3607
         foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3608 3608
             $related_model = $this->get_related_model_obj($model_name);
3609
-            if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3609
+            if ($this->_should_use_default_where_conditions($use_default_where_conditions, false)) {
3610 3610
                 $related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3611
-            } elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3611
+            } elseif ($this->_should_use_minimum_where_conditions($use_default_where_conditions, false)) {
3612 3612
                 $related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3613 3613
             } else {
3614 3614
                 //we don't want to add full or even minimum default where conditions from this model, so just continue
@@ -3641,7 +3641,7 @@  discard block
 block discarded – undo
3641 3641
      * @param bool $for_this_model false means this is for OTHER related models
3642 3642
      * @return bool
3643 3643
      */
3644
-    private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3644
+    private function _should_use_default_where_conditions($default_where_conditions_value, $for_this_model = true)
3645 3645
     {
3646 3646
         return (
3647 3647
                    $for_this_model
@@ -3720,7 +3720,7 @@  discard block
 block discarded – undo
3720 3720
     ) {
3721 3721
         $null_friendly_where_conditions = array();
3722 3722
         $none_overridden = true;
3723
-        $or_condition_key_for_defaults = 'OR*' . get_class($model);
3723
+        $or_condition_key_for_defaults = 'OR*'.get_class($model);
3724 3724
         foreach ($default_where_conditions as $key => $val) {
3725 3725
             if (isset($provided_where_conditions[$key])) {
3726 3726
                 $none_overridden = false;
@@ -3838,7 +3838,7 @@  discard block
 block discarded – undo
3838 3838
             foreach ($tables as $table_obj) {
3839 3839
                 $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3840 3840
                                        . $table_obj->get_fully_qualified_pk_column();
3841
-                if (! in_array($qualified_pk_column, $selects)) {
3841
+                if ( ! in_array($qualified_pk_column, $selects)) {
3842 3842
                     $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3843 3843
                 }
3844 3844
             }
@@ -3932,9 +3932,9 @@  discard block
 block discarded – undo
3932 3932
         //and
3933 3933
         //check if it's a field on a related model
3934 3934
         foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3935
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3935
+            if (strpos($query_param, $valid_related_model_name.".") === 0) {
3936 3936
                 $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3937
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
3937
+                $query_param = substr($query_param, strlen($valid_related_model_name."."));
3938 3938
                 if ($query_param === '') {
3939 3939
                     //nothing left to $query_param
3940 3940
                     //we should actually end in a field name, not a model like this!
@@ -4022,7 +4022,7 @@  discard block
 block discarded – undo
4022 4022
     {
4023 4023
         $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
4024 4024
         if ($SQL) {
4025
-            return " WHERE " . $SQL;
4025
+            return " WHERE ".$SQL;
4026 4026
         }
4027 4027
         return '';
4028 4028
     }
@@ -4041,7 +4041,7 @@  discard block
 block discarded – undo
4041 4041
     {
4042 4042
         $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
4043 4043
         if ($SQL) {
4044
-            return " HAVING " . $SQL;
4044
+            return " HAVING ".$SQL;
4045 4045
         }
4046 4046
         return '';
4047 4047
     }
@@ -4060,11 +4060,11 @@  discard block
 block discarded – undo
4060 4060
      */
4061 4061
     protected function _get_field_on_model($field_name, $model_name)
4062 4062
     {
4063
-        $model_class = 'EEM_' . $model_name;
4064
-        $model_filepath = $model_class . ".model.php";
4063
+        $model_class = 'EEM_'.$model_name;
4064
+        $model_filepath = $model_class.".model.php";
4065 4065
         if (is_readable($model_filepath)) {
4066 4066
             require_once($model_filepath);
4067
-            $model_instance = call_user_func($model_name . "::instance");
4067
+            $model_instance = call_user_func($model_name."::instance");
4068 4068
             /* @var $model_instance EEM_Base */
4069 4069
             return $model_instance->field_settings_for($field_name);
4070 4070
         }
@@ -4093,7 +4093,7 @@  discard block
 block discarded – undo
4093 4093
     {
4094 4094
         $where_clauses = array();
4095 4095
         foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
4096
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
4096
+            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param); //str_replace("*",'',$query_param);
4097 4097
             if (in_array($query_param, $this->_logic_query_param_keys)) {
4098 4098
                 switch ($query_param) {
4099 4099
                     case 'not':
@@ -4121,7 +4121,7 @@  discard block
 block discarded – undo
4121 4121
             } else {
4122 4122
                 $field_obj = $this->_deduce_field_from_query_param($query_param);
4123 4123
                 //if it's not a normal field, maybe it's a custom selection?
4124
-                if (! $field_obj) {
4124
+                if ( ! $field_obj) {
4125 4125
                     if (isset($this->_custom_selections[$query_param][1])) {
4126 4126
                         $field_obj = $this->_custom_selections[$query_param][1];
4127 4127
                     } else {
@@ -4130,7 +4130,7 @@  discard block
 block discarded – undo
4130 4130
                     }
4131 4131
                 }
4132 4132
                 $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
4133
-                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
4133
+                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param).SP.$op_and_value_sql;
4134 4134
             }
4135 4135
         }
4136 4136
         return $where_clauses ? implode($glue, $where_clauses) : '';
@@ -4151,7 +4151,7 @@  discard block
 block discarded – undo
4151 4151
         if ($field) {
4152 4152
             $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4153 4153
                 $query_param);
4154
-            return $table_alias_prefix . $field->get_qualified_column();
4154
+            return $table_alias_prefix.$field->get_qualified_column();
4155 4155
         }
4156 4156
         if (array_key_exists($query_param, $this->_custom_selections)) {
4157 4157
             //maybe it's custom selection item?
@@ -4203,7 +4203,7 @@  discard block
 block discarded – undo
4203 4203
     {
4204 4204
         if (is_array($op_and_value)) {
4205 4205
             $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4206
-            if (! $operator) {
4206
+            if ( ! $operator) {
4207 4207
                 $php_array_like_string = array();
4208 4208
                 foreach ($op_and_value as $key => $value) {
4209 4209
                     $php_array_like_string[] = "$key=>$value";
@@ -4225,14 +4225,14 @@  discard block
 block discarded – undo
4225 4225
         }
4226 4226
         //check to see if the value is actually another field
4227 4227
         if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4228
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4228
+            return $operator.SP.$this->_deduce_column_name_from_query_param($value);
4229 4229
         }
4230 4230
         if (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4231 4231
             //in this case, the value should be an array, or at least a comma-separated list
4232 4232
             //it will need to handle a little differently
4233 4233
             $cleaned_value = $this->_construct_in_value($value, $field_obj);
4234 4234
             //note: $cleaned_value has already been run through $wpdb->prepare()
4235
-            return $operator . SP . $cleaned_value;
4235
+            return $operator.SP.$cleaned_value;
4236 4236
         }
4237 4237
         if (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4238 4238
             //the value should be an array with count of two.
@@ -4248,7 +4248,7 @@  discard block
 block discarded – undo
4248 4248
                 );
4249 4249
             }
4250 4250
             $cleaned_value = $this->_construct_between_value($value, $field_obj);
4251
-            return $operator . SP . $cleaned_value;
4251
+            return $operator.SP.$cleaned_value;
4252 4252
         }
4253 4253
         if (in_array($operator, $this->_null_style_operators)) {
4254 4254
             if ($value !== null) {
@@ -4268,10 +4268,10 @@  discard block
 block discarded – undo
4268 4268
         if ($operator === 'LIKE' && ! is_array($value)) {
4269 4269
             //if the operator is 'LIKE', we want to allow percent signs (%) and not
4270 4270
             //remove other junk. So just treat it as a string.
4271
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4271
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, '%s');
4272 4272
         }
4273
-        if (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4274
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4273
+        if ( ! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4274
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, $field_obj);
4275 4275
         }
4276 4276
         if (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4277 4277
             throw new EE_Error(
@@ -4285,7 +4285,7 @@  discard block
 block discarded – undo
4285 4285
                 )
4286 4286
             );
4287 4287
         }
4288
-        if (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4288
+        if ( ! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4289 4289
             throw new EE_Error(
4290 4290
                 sprintf(
4291 4291
                     __(
@@ -4325,7 +4325,7 @@  discard block
 block discarded – undo
4325 4325
         foreach ($values as $value) {
4326 4326
             $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4327 4327
         }
4328
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
4328
+        return $cleaned_values[0]." AND ".$cleaned_values[1];
4329 4329
     }
4330 4330
 
4331 4331
 
@@ -4366,7 +4366,7 @@  discard block
 block discarded – undo
4366 4366
                                 . $main_table->get_table_name()
4367 4367
                                 . " WHERE FALSE";
4368 4368
         }
4369
-        return "(" . implode(",", $cleaned_values) . ")";
4369
+        return "(".implode(",", $cleaned_values).")";
4370 4370
     }
4371 4371
 
4372 4372
 
@@ -4385,7 +4385,7 @@  discard block
 block discarded – undo
4385 4385
             return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4386 4386
                 $this->_prepare_value_for_use_in_db($value, $field_obj));
4387 4387
         } //$field_obj should really just be a data type
4388
-        if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4388
+        if ( ! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4389 4389
             throw new EE_Error(
4390 4390
                 sprintf(
4391 4391
                     __("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
@@ -4513,10 +4513,10 @@  discard block
 block discarded – undo
4513 4513
      */
4514 4514
     public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4515 4515
     {
4516
-        $table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4516
+        $table_prefix = str_replace('.', '__', $model_relation_chain).(empty($model_relation_chain) ? '' : '__');
4517 4517
         $qualified_columns = array();
4518 4518
         foreach ($this->field_settings() as $field_name => $field) {
4519
-            $qualified_columns[] = $table_prefix . $field->get_qualified_column();
4519
+            $qualified_columns[] = $table_prefix.$field->get_qualified_column();
4520 4520
         }
4521 4521
         return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4522 4522
     }
@@ -4540,11 +4540,11 @@  discard block
 block discarded – undo
4540 4540
             if ($table_obj instanceof EE_Primary_Table) {
4541 4541
                 $SQL .= $table_alias === $table_obj->get_table_alias()
4542 4542
                     ? $table_obj->get_select_join_limit($limit)
4543
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4543
+                    : SP.$table_obj->get_table_name()." AS ".$table_obj->get_table_alias().SP;
4544 4544
             } elseif ($table_obj instanceof EE_Secondary_Table) {
4545 4545
                 $SQL .= $table_alias === $table_obj->get_table_alias()
4546 4546
                     ? $table_obj->get_select_join_limit_join($limit)
4547
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
4547
+                    : SP.$table_obj->get_join_sql($table_alias).SP;
4548 4548
             }
4549 4549
         }
4550 4550
         return $SQL;
@@ -4632,12 +4632,12 @@  discard block
 block discarded – undo
4632 4632
      */
4633 4633
     public function get_related_model_obj($model_name)
4634 4634
     {
4635
-        $model_classname = "EEM_" . $model_name;
4636
-        if (! class_exists($model_classname)) {
4635
+        $model_classname = "EEM_".$model_name;
4636
+        if ( ! class_exists($model_classname)) {
4637 4637
             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",
4638 4638
                 'event_espresso'), $model_name, $model_classname));
4639 4639
         }
4640
-        return call_user_func($model_classname . "::instance");
4640
+        return call_user_func($model_classname."::instance");
4641 4641
     }
4642 4642
 
4643 4643
 
@@ -4684,7 +4684,7 @@  discard block
 block discarded – undo
4684 4684
     public function related_settings_for($relation_name)
4685 4685
     {
4686 4686
         $relatedModels = $this->relation_settings();
4687
-        if (! array_key_exists($relation_name, $relatedModels)) {
4687
+        if ( ! array_key_exists($relation_name, $relatedModels)) {
4688 4688
             throw new EE_Error(
4689 4689
                 sprintf(
4690 4690
                     __('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
@@ -4711,7 +4711,7 @@  discard block
 block discarded – undo
4711 4711
     public function field_settings_for($fieldName)
4712 4712
     {
4713 4713
         $fieldSettings = $this->field_settings(true);
4714
-        if (! array_key_exists($fieldName, $fieldSettings)) {
4714
+        if ( ! array_key_exists($fieldName, $fieldSettings)) {
4715 4715
             throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4716 4716
                 get_class($this)));
4717 4717
         }
@@ -4784,7 +4784,7 @@  discard block
 block discarded – undo
4784 4784
                     break;
4785 4785
                 }
4786 4786
             }
4787
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4787
+            if ( ! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4788 4788
                 throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4789 4789
                     get_class($this)));
4790 4790
             }
@@ -4843,7 +4843,7 @@  discard block
 block discarded – undo
4843 4843
      */
4844 4844
     public function get_foreign_key_to($model_name)
4845 4845
     {
4846
-        if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4846
+        if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4847 4847
             foreach ($this->field_settings() as $field) {
4848 4848
                 if (
4849 4849
                     $field instanceof EE_Foreign_Key_Field_Base
@@ -4853,7 +4853,7 @@  discard block
 block discarded – undo
4853 4853
                     break;
4854 4854
                 }
4855 4855
             }
4856
-            if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4856
+            if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4857 4857
                 throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4858 4858
                     'event_espresso'), $model_name, get_class($this)));
4859 4859
             }
@@ -4904,7 +4904,7 @@  discard block
 block discarded – undo
4904 4904
             foreach ($this->_fields as $fields_corresponding_to_table) {
4905 4905
                 foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4906 4906
                     /** @var $field_obj EE_Model_Field_Base */
4907
-                    if (! $field_obj->is_db_only_field()) {
4907
+                    if ( ! $field_obj->is_db_only_field()) {
4908 4908
                         $this->_cached_fields_non_db_only[$field_name] = $field_obj;
4909 4909
                     }
4910 4910
                 }
@@ -4933,7 +4933,7 @@  discard block
 block discarded – undo
4933 4933
         $count_if_model_has_no_primary_key = 0;
4934 4934
         $has_primary_key = $this->has_primary_key_field();
4935 4935
         $primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4936
-        foreach ((array)$rows as $row) {
4936
+        foreach ((array) $rows as $row) {
4937 4937
             if (empty($row)) {
4938 4938
                 //wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4939 4939
                 return array();
@@ -4951,7 +4951,7 @@  discard block
 block discarded – undo
4951 4951
                 }
4952 4952
             }
4953 4953
             $classInstance = $this->instantiate_class_from_array_or_object($row);
4954
-            if (! $classInstance) {
4954
+            if ( ! $classInstance) {
4955 4955
                 throw new EE_Error(
4956 4956
                     sprintf(
4957 4957
                         __('Could not create instance of class %s from row %s', 'event_espresso'),
@@ -5020,7 +5020,7 @@  discard block
 block discarded – undo
5020 5020
      */
5021 5021
     public function instantiate_class_from_array_or_object($cols_n_values)
5022 5022
     {
5023
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
5023
+        if ( ! is_array($cols_n_values) && is_object($cols_n_values)) {
5024 5024
             $cols_n_values = get_object_vars($cols_n_values);
5025 5025
         }
5026 5026
         $primary_key = null;
@@ -5045,7 +5045,7 @@  discard block
 block discarded – undo
5045 5045
         // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
5046 5046
         if ($primary_key) {
5047 5047
             $classInstance = $this->get_from_entity_map($primary_key);
5048
-            if (! $classInstance) {
5048
+            if ( ! $classInstance) {
5049 5049
                 $classInstance = EE_Registry::instance()
5050 5050
                                             ->load_class($className,
5051 5051
                                                 array($this_model_fields_n_values, $this->_timezone), true, false);
@@ -5096,12 +5096,12 @@  discard block
 block discarded – undo
5096 5096
     public function add_to_entity_map(EE_Base_Class $object)
5097 5097
     {
5098 5098
         $className = $this->_get_class_name();
5099
-        if (! $object instanceof $className) {
5099
+        if ( ! $object instanceof $className) {
5100 5100
             throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
5101 5101
                 is_object($object) ? get_class($object) : $object, $className));
5102 5102
         }
5103 5103
         /** @var $object EE_Base_Class */
5104
-        if (! $object->ID()) {
5104
+        if ( ! $object->ID()) {
5105 5105
             throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
5106 5106
                 "event_espresso"), get_class($this)));
5107 5107
         }
@@ -5170,7 +5170,7 @@  discard block
 block discarded – undo
5170 5170
             //there is a primary key on this table and its not set. Use defaults for all its columns
5171 5171
             if ($table_pk_value === null && $table_obj->get_pk_column()) {
5172 5172
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5173
-                    if (! $field_obj->is_db_only_field()) {
5173
+                    if ( ! $field_obj->is_db_only_field()) {
5174 5174
                         //prepare field as if its coming from db
5175 5175
                         $prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5176 5176
                         $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
@@ -5179,7 +5179,7 @@  discard block
 block discarded – undo
5179 5179
             } else {
5180 5180
                 //the table's rows existed. Use their values
5181 5181
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5182
-                    if (! $field_obj->is_db_only_field()) {
5182
+                    if ( ! $field_obj->is_db_only_field()) {
5183 5183
                         $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5184 5184
                             $cols_n_values, $field_obj->get_qualified_column(),
5185 5185
                             $field_obj->get_table_column()
@@ -5294,7 +5294,7 @@  discard block
 block discarded – undo
5294 5294
      */
5295 5295
     private function _get_class_name()
5296 5296
     {
5297
-        return "EE_" . $this->get_this_model_name();
5297
+        return "EE_".$this->get_this_model_name();
5298 5298
     }
5299 5299
 
5300 5300
 
@@ -5309,7 +5309,7 @@  discard block
 block discarded – undo
5309 5309
      */
5310 5310
     public function item_name($quantity = 1)
5311 5311
     {
5312
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5312
+        return (int) $quantity === 1 ? $this->singular_item : $this->plural_item;
5313 5313
     }
5314 5314
 
5315 5315
 
@@ -5342,7 +5342,7 @@  discard block
 block discarded – undo
5342 5342
     {
5343 5343
         $className = get_class($this);
5344 5344
         $tagName = "FHEE__{$className}__{$methodName}";
5345
-        if (! has_filter($tagName)) {
5345
+        if ( ! has_filter($tagName)) {
5346 5346
             throw new EE_Error(
5347 5347
                 sprintf(
5348 5348
                     __('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 );',
@@ -5568,7 +5568,7 @@  discard block
 block discarded – undo
5568 5568
         $key_vals_in_combined_pk = array();
5569 5569
         parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5570 5570
         foreach ($key_fields as $key_field_name => $field_obj) {
5571
-            if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5571
+            if ( ! isset($key_vals_in_combined_pk[$key_field_name])) {
5572 5572
                 return null;
5573 5573
             }
5574 5574
         }
@@ -5589,7 +5589,7 @@  discard block
 block discarded – undo
5589 5589
     {
5590 5590
         $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5591 5591
         foreach ($keys_it_should_have as $key) {
5592
-            if (! isset($key_vals[$key])) {
5592
+            if ( ! isset($key_vals[$key])) {
5593 5593
                 return false;
5594 5594
             }
5595 5595
         }
@@ -5643,7 +5643,7 @@  discard block
 block discarded – undo
5643 5643
      */
5644 5644
     public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5645 5645
     {
5646
-        if (! is_array($query_params)) {
5646
+        if ( ! is_array($query_params)) {
5647 5647
             EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5648 5648
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5649 5649
                     gettype($query_params)), '4.6.0');
@@ -5739,7 +5739,7 @@  discard block
 block discarded – undo
5739 5739
      */
5740 5740
     public function get_IDs($model_objects, $filter_out_empty_ids = false)
5741 5741
     {
5742
-        if (! $this->has_primary_key_field()) {
5742
+        if ( ! $this->has_primary_key_field()) {
5743 5743
             if (WP_DEBUG) {
5744 5744
                 EE_Error::add_error(
5745 5745
                     __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
@@ -5752,7 +5752,7 @@  discard block
 block discarded – undo
5752 5752
         $IDs = array();
5753 5753
         foreach ($model_objects as $model_object) {
5754 5754
             $id = $model_object->ID();
5755
-            if (! $id) {
5755
+            if ( ! $id) {
5756 5756
                 if ($filter_out_empty_ids) {
5757 5757
                     continue;
5758 5758
                 }
@@ -5848,8 +5848,8 @@  discard block
 block discarded – undo
5848 5848
         $missing_caps = array();
5849 5849
         $cap_restrictions = $this->cap_restrictions($context);
5850 5850
         foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5851
-            if (! EE_Capabilities::instance()
5852
-                                 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5851
+            if ( ! EE_Capabilities::instance()
5852
+                                 ->current_user_can($cap, $this->get_this_model_name().'_model_applying_caps')
5853 5853
             ) {
5854 5854
                 $missing_caps[$cap] = $restriction_if_no_cap;
5855 5855
             }
@@ -6001,7 +6001,7 @@  discard block
 block discarded – undo
6001 6001
     {
6002 6002
         foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
6003 6003
             if ($query_param_key === $logic_query_param_key
6004
-                || strpos($query_param_key, $logic_query_param_key . '*') === 0
6004
+                || strpos($query_param_key, $logic_query_param_key.'*') === 0
6005 6005
             ) {
6006 6006
                 return true;
6007 6007
             }
Please login to merge, or discard this patch.