Completed
Branch BUG-10738-inconsistency-in-ses... (860590)
by
unknown
57:39 queued 45:30
created
core/EE_Psr4AutoloaderInit.core.php 1 patch
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -1,7 +1,7 @@  discard block
 block discarded – undo
1 1
 <?php
2 2
 use EventEspresso\core\Psr4Autoloader;
3 3
 
4
-if ( ! defined( 'EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
4
+if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
5 5
 
6 6
 /**
7 7
  * Class EE_Psr4AutoloaderInit
@@ -37,15 +37,15 @@  discard block
 block discarded – undo
37 37
 	 */
38 38
 	public static function initialize_psr4_loader() {
39 39
 		static $initialized = false;
40
-		if ( ! $initialized ) {
40
+		if ( ! $initialized) {
41 41
 			// instantiate PSR4 autoloader
42
-			espresso_load_required( 'Psr4Autoloader', EE_CORE . 'Psr4Autoloader.php' );
42
+			espresso_load_required('Psr4Autoloader', EE_CORE.'Psr4Autoloader.php');
43 43
 			EE_Psr4AutoloaderInit::$psr4_loader = new Psr4Autoloader();
44 44
 			// register the autoloader
45 45
 			EE_Psr4AutoloaderInit::$psr4_loader->register();
46 46
 			// register the base directories for the namespace prefix
47
-			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace( 'EventEspresso', EE_PLUGIN_DIR_PATH );
48
-			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace( 'EventEspressoBatchRequest', EE_LIBRARIES . 'batch' );
47
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
48
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES.'batch');
49 49
 			$initialized = true;
50 50
 		}
51 51
 	}
Please login to merge, or discard this patch.
core/interfaces/ResettableInterface.php 1 patch
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -1,8 +1,8 @@
 block discarded – undo
1 1
 <?php
2 2
 namespace EventEspresso\core\interfaces;
3 3
 
4
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
5
-	exit( 'No direct script access allowed' );
4
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
5
+	exit('No direct script access allowed');
6 6
 }
7 7
 
8 8
 
Please login to merge, or discard this patch.
core/helpers/EEH_Line_Item.helper.php 1 patch
Spacing   +347 added lines, -347 removed lines patch added patch discarded remove patch
@@ -1,4 +1,4 @@  discard block
 block discarded – undo
1
-<?php if (!defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
1
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
2 2
 /**
3 3
  *
4 4
  * EEH_Line_Item
@@ -45,8 +45,8 @@  discard block
 block discarded – undo
45 45
 	 * @return boolean success
46 46
 	 * @throws \EE_Error
47 47
 	 */
48
-	public static function add_unrelated_item( EE_Line_Item $parent_line_item, $name, $unit_price, $description = '', $quantity = 1, $taxable = FALSE, $code = NULL  ){
49
-		$items_subtotal = self::get_pre_tax_subtotal( $parent_line_item );
48
+	public static function add_unrelated_item(EE_Line_Item $parent_line_item, $name, $unit_price, $description = '', $quantity = 1, $taxable = FALSE, $code = NULL) {
49
+		$items_subtotal = self::get_pre_tax_subtotal($parent_line_item);
50 50
 		$line_item = EE_Line_Item::new_instance(array(
51 51
 			'LIN_name' => $name,
52 52
 			'LIN_desc' => $description,
@@ -54,7 +54,7 @@  discard block
 block discarded – undo
54 54
 			'LIN_quantity' => $quantity,
55 55
 			'LIN_percent' => null,
56 56
 			'LIN_is_taxable' => $taxable,
57
-			'LIN_order' => $items_subtotal instanceof EE_Line_Item ? count( $items_subtotal->children() ) : 0,
57
+			'LIN_order' => $items_subtotal instanceof EE_Line_Item ? count($items_subtotal->children()) : 0,
58 58
 			'LIN_total' => (float) $unit_price * (int) $quantity,
59 59
 			'LIN_type'=>  EEM_Line_Item::type_line_item,
60 60
 			'LIN_code' => $code,
@@ -64,7 +64,7 @@  discard block
 block discarded – undo
64 64
 			$line_item,
65 65
 			$parent_line_item
66 66
 		);
67
-		return self::add_item( $parent_line_item, $line_item );
67
+		return self::add_item($parent_line_item, $line_item);
68 68
 	}
69 69
 
70 70
 
@@ -86,7 +86,7 @@  discard block
 block discarded – undo
86 86
 	 * @return boolean success
87 87
 	 * @throws \EE_Error
88 88
 	 */
89
-	public static function add_percentage_based_item( EE_Line_Item $parent_line_item, $name, $percentage_amount, $description = '', $taxable = FALSE ){
89
+	public static function add_percentage_based_item(EE_Line_Item $parent_line_item, $name, $percentage_amount, $description = '', $taxable = FALSE) {
90 90
 		$line_item = EE_Line_Item::new_instance(array(
91 91
 			'LIN_name' => $name,
92 92
 			'LIN_desc' => $description,
@@ -94,7 +94,7 @@  discard block
 block discarded – undo
94 94
 			'LIN_percent' => $percentage_amount,
95 95
 			'LIN_quantity' => NULL,
96 96
 			'LIN_is_taxable' => $taxable,
97
-			'LIN_total' => (float) ( $percentage_amount * ( $parent_line_item->total() / 100 ) ),
97
+			'LIN_total' => (float) ($percentage_amount * ($parent_line_item->total() / 100)),
98 98
 			'LIN_type'=>  EEM_Line_Item::type_line_item,
99 99
 			'LIN_parent' => $parent_line_item->ID()
100 100
 		));
@@ -102,7 +102,7 @@  discard block
 block discarded – undo
102 102
 			'FHEE__EEH_Line_Item__add_percentage_based_item__line_item',
103 103
 			$line_item
104 104
 		);
105
-		return self::add_item( $parent_line_item, $line_item );
105
+		return self::add_item($parent_line_item, $line_item);
106 106
 	}
107 107
 
108 108
 
@@ -123,15 +123,15 @@  discard block
 block discarded – undo
123 123
 	 * @return \EE_Line_Item
124 124
 	 * @throws \EE_Error
125 125
 	 */
126
-	public static function add_ticket_purchase( EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1 ){
127
-		if ( ! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total() ) {
128
-			throw new EE_Error( sprintf( __( 'A valid line item total is required in order to add tickets. A line item of type "%s" was passed.', 'event_espresso' ), $ticket->ID(), $total_line_item->ID() ) );
126
+	public static function add_ticket_purchase(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) {
127
+		if ( ! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) {
128
+			throw new EE_Error(sprintf(__('A valid line item total is required in order to add tickets. A line item of type "%s" was passed.', 'event_espresso'), $ticket->ID(), $total_line_item->ID()));
129 129
 		}
130 130
 		// either increment the qty for an existing ticket
131
-		$line_item = self::increment_ticket_qty_if_already_in_cart( $total_line_item, $ticket, $qty );
131
+		$line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty);
132 132
 		// or add a new one
133
-		if ( ! $line_item instanceof EE_Line_Item ) {
134
-			$line_item = self::create_ticket_line_item( $total_line_item, $ticket, $qty );
133
+		if ( ! $line_item instanceof EE_Line_Item) {
134
+			$line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty);
135 135
 		}
136 136
 		$total_line_item->recalculate_total_including_taxes();
137 137
 		return $line_item;
@@ -147,11 +147,11 @@  discard block
 block discarded – undo
147 147
 	 * @return \EE_Line_Item
148 148
 	 * @throws \EE_Error
149 149
 	 */
150
-	public static function increment_ticket_qty_if_already_in_cart( EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1 ) {
150
+	public static function increment_ticket_qty_if_already_in_cart(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) {
151 151
 		$line_item = null;
152
-		if ( $total_line_item instanceof EE_Line_Item && $total_line_item->is_total() ) {
153
-			$ticket_line_items = EEH_Line_Item::get_ticket_line_items( $total_line_item );
154
-			foreach ( (array)$ticket_line_items as $ticket_line_item ) {
152
+		if ($total_line_item instanceof EE_Line_Item && $total_line_item->is_total()) {
153
+			$ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
154
+			foreach ((array) $ticket_line_items as $ticket_line_item) {
155 155
 				if (
156 156
 					$ticket_line_item instanceof EE_Line_Item
157 157
 					&& (int) $ticket_line_item->OBJ_ID() === (int) $ticket->ID()
@@ -161,8 +161,8 @@  discard block
 block discarded – undo
161 161
 				}
162 162
 			}
163 163
 		}
164
-		if ( $line_item instanceof EE_Line_Item ) {
165
-			EEH_Line_Item::increment_quantity( $line_item, $qty );
164
+		if ($line_item instanceof EE_Line_Item) {
165
+			EEH_Line_Item::increment_quantity($line_item, $qty);
166 166
 			return $line_item;
167 167
 		}
168 168
 		return null;
@@ -179,16 +179,16 @@  discard block
 block discarded – undo
179 179
 	 * @return void
180 180
 	 * @throws \EE_Error
181 181
 	 */
182
-	public static function increment_quantity( EE_Line_Item $line_item, $qty = 1 ) {
183
-		if( ! $line_item->is_percent() ) {
182
+	public static function increment_quantity(EE_Line_Item $line_item, $qty = 1) {
183
+		if ( ! $line_item->is_percent()) {
184 184
 			$qty += $line_item->quantity();
185
-			$line_item->set_quantity( $qty );
186
-			$line_item->set_total( $line_item->unit_price() * $qty );
185
+			$line_item->set_quantity($qty);
186
+			$line_item->set_total($line_item->unit_price() * $qty);
187 187
 			$line_item->save();
188 188
 		}
189
-		foreach( $line_item->children() as $child ) {
190
-			if( $child->is_sub_line_item() ) {
191
-				EEH_Line_Item::update_quantity( $child, $qty );
189
+		foreach ($line_item->children() as $child) {
190
+			if ($child->is_sub_line_item()) {
191
+				EEH_Line_Item::update_quantity($child, $qty);
192 192
 			}
193 193
 		}
194 194
 	}
@@ -204,17 +204,17 @@  discard block
 block discarded – undo
204 204
 	 * @return void
205 205
 	 * @throws \EE_Error
206 206
 	 */
207
-	public static function decrement_quantity( EE_Line_Item $line_item, $qty = 1 ) {
208
-		if( ! $line_item->is_percent() ) {
207
+	public static function decrement_quantity(EE_Line_Item $line_item, $qty = 1) {
208
+		if ( ! $line_item->is_percent()) {
209 209
 			$qty = $line_item->quantity() - $qty;
210
-			$qty = max( $qty, 0 );
211
-			$line_item->set_quantity( $qty );
212
-			$line_item->set_total( $line_item->unit_price() * $qty );
210
+			$qty = max($qty, 0);
211
+			$line_item->set_quantity($qty);
212
+			$line_item->set_total($line_item->unit_price() * $qty);
213 213
 			$line_item->save();
214 214
 		}
215
-		foreach( $line_item->children() as $child ) {
216
-			if( $child->is_sub_line_item() ) {
217
-				EEH_Line_Item::update_quantity( $child, $qty );
215
+		foreach ($line_item->children() as $child) {
216
+			if ($child->is_sub_line_item()) {
217
+				EEH_Line_Item::update_quantity($child, $qty);
218 218
 			}
219 219
 		}
220 220
 	}
@@ -229,15 +229,15 @@  discard block
 block discarded – undo
229 229
 	 * @param int          $new_quantity
230 230
 	 * @throws \EE_Error
231 231
 	 */
232
-	public static function update_quantity( EE_Line_Item $line_item, $new_quantity ) {
233
-		if( ! $line_item->is_percent() ) {
234
-			$line_item->set_quantity( $new_quantity );
235
-			$line_item->set_total( $line_item->unit_price() * $new_quantity );
232
+	public static function update_quantity(EE_Line_Item $line_item, $new_quantity) {
233
+		if ( ! $line_item->is_percent()) {
234
+			$line_item->set_quantity($new_quantity);
235
+			$line_item->set_total($line_item->unit_price() * $new_quantity);
236 236
 			$line_item->save();
237 237
 		}
238
-		foreach( $line_item->children() as $child ) {
239
-			if( $child->is_sub_line_item() ) {
240
-				EEH_Line_Item::update_quantity( $child, $new_quantity );
238
+		foreach ($line_item->children() as $child) {
239
+			if ($child->is_sub_line_item()) {
240
+				EEH_Line_Item::update_quantity($child, $new_quantity);
241 241
 			}
242 242
 		}
243 243
 	}
@@ -252,43 +252,43 @@  discard block
 block discarded – undo
252 252
 	 * @return \EE_Line_Item
253 253
 	 * @throws \EE_Error
254 254
 	 */
255
-	public static function create_ticket_line_item( EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1 ) {
255
+	public static function create_ticket_line_item(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) {
256 256
 		$datetimes = $ticket->datetimes();
257
-		$first_datetime = reset( $datetimes );
258
-		if( $first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event ) {
257
+		$first_datetime = reset($datetimes);
258
+		if ($first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event) {
259 259
 			$first_datetime_name = $first_datetime->event()->name();
260 260
 		} else {
261
-			$first_datetime_name = __( 'Event', 'event_espresso' );
261
+			$first_datetime_name = __('Event', 'event_espresso');
262 262
 		}
263
-		$event = sprintf( _x( '(For %1$s)', '(For Event Name)', 'event_espresso' ), $first_datetime_name );
263
+		$event = sprintf(_x('(For %1$s)', '(For Event Name)', 'event_espresso'), $first_datetime_name);
264 264
 		// get event subtotal line
265
-		$events_sub_total = self::get_event_line_item_for_ticket( $total_line_item, $ticket );
265
+		$events_sub_total = self::get_event_line_item_for_ticket($total_line_item, $ticket);
266 266
 		// add $ticket to cart
267
-		$line_item = EE_Line_Item::new_instance( array(
267
+		$line_item = EE_Line_Item::new_instance(array(
268 268
 			'LIN_name'       	=> $ticket->name(),
269
-			'LIN_desc'       		=> $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event,
269
+			'LIN_desc'       		=> $ticket->description() !== '' ? $ticket->description().' '.$event : $event,
270 270
 			'LIN_unit_price' 	=> $ticket->price(),
271 271
 			'LIN_quantity'   	=> $qty,
272 272
 			'LIN_is_taxable' 	=> $ticket->taxable(),
273
-			'LIN_order'      	=> count( $events_sub_total->children() ),
273
+			'LIN_order'      	=> count($events_sub_total->children()),
274 274
 			'LIN_total'      		=> $ticket->price() * $qty,
275 275
 			'LIN_type'       		=> EEM_Line_Item::type_line_item,
276 276
 			'OBJ_ID'         		=> $ticket->ID(),
277 277
 			'OBJ_type'       	=> 'Ticket'
278
-		) );
278
+		));
279 279
 		$line_item = apply_filters(
280 280
 			'FHEE__EEH_Line_Item__create_ticket_line_item__line_item',
281 281
 			$line_item
282 282
 		);
283
-		$events_sub_total->add_child_line_item( $line_item );
283
+		$events_sub_total->add_child_line_item($line_item);
284 284
 		//now add the sub-line items
285 285
 		$running_total_for_ticket = 0;
286
-		foreach ( $ticket->prices( array( 'order_by' => array( 'PRC_order' => 'ASC' ) ) ) as $price ) {
286
+		foreach ($ticket->prices(array('order_by' => array('PRC_order' => 'ASC'))) as $price) {
287 287
 			$sign = $price->is_discount() ? -1 : 1;
288 288
 			$price_total = $price->is_percent()
289 289
 				? $running_total_for_ticket * $price->amount() / 100
290 290
 				: $price->amount() * $qty;
291
-			$sub_line_item = EE_Line_Item::new_instance( array(
291
+			$sub_line_item = EE_Line_Item::new_instance(array(
292 292
 				'LIN_name'       	=> $price->name(),
293 293
 				'LIN_desc'       		=> $price->desc(),
294 294
 				'LIN_quantity'   	=> $price->is_percent() ? null : $qty,
@@ -298,18 +298,18 @@  discard block
 block discarded – undo
298 298
 				'LIN_type'       		=> EEM_Line_Item::type_sub_line_item,
299 299
 				'OBJ_ID'         		=> $price->ID(),
300 300
 				'OBJ_type'       	=> 'Price'
301
-			) );
301
+			));
302 302
 			$sub_line_item = apply_filters(
303 303
 				'FHEE__EEH_Line_Item__create_ticket_line_item__sub_line_item',
304 304
 				$sub_line_item
305 305
 			);
306
-			if ( $price->is_percent() ) {
307
-				$sub_line_item->set_percent( $sign * $price->amount() );
306
+			if ($price->is_percent()) {
307
+				$sub_line_item->set_percent($sign * $price->amount());
308 308
 			} else {
309
-				$sub_line_item->set_unit_price( $sign * $price->amount() );
309
+				$sub_line_item->set_unit_price($sign * $price->amount());
310 310
 			}
311 311
 			$running_total_for_ticket += $price_total;
312
-			$line_item->add_child_line_item( $sub_line_item );
312
+			$line_item->add_child_line_item($sub_line_item);
313 313
 		}
314 314
 		return $line_item;
315 315
 	}
@@ -329,11 +329,11 @@  discard block
 block discarded – undo
329 329
 	 * @return boolean
330 330
 	 * @throws \EE_Error
331 331
 	 */
332
-	public static function add_item( EE_Line_Item $total_line_item, EE_Line_Item $item ){
333
-		$pre_tax_subtotal = self::get_pre_tax_subtotal( $total_line_item );
334
-		if ( $pre_tax_subtotal instanceof EE_Line_Item ){
332
+	public static function add_item(EE_Line_Item $total_line_item, EE_Line_Item $item) {
333
+		$pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item);
334
+		if ($pre_tax_subtotal instanceof EE_Line_Item) {
335 335
 			$success = $pre_tax_subtotal->add_child_line_item($item);
336
-		}else{
336
+		} else {
337 337
 			return FALSE;
338 338
 		}
339 339
 		$total_line_item->recalculate_total_including_taxes();
@@ -352,34 +352,34 @@  discard block
 block discarded – undo
352 352
 	 * @return bool success
353 353
 	 * @throws \EE_Error
354 354
 	 */
355
-	public static function cancel_ticket_line_item( EE_Line_Item $ticket_line_item, $qty = 1 ) {
355
+	public static function cancel_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1) {
356 356
 		// validate incoming line_item
357
-		if ( $ticket_line_item->OBJ_type() !== 'Ticket' ) {
357
+		if ($ticket_line_item->OBJ_type() !== 'Ticket') {
358 358
 			throw new EE_Error(
359 359
 				sprintf(
360
-					__( 'The supplied line item must have an Object Type of "Ticket", not %1$s.', 'event_espresso' ),
360
+					__('The supplied line item must have an Object Type of "Ticket", not %1$s.', 'event_espresso'),
361 361
 					$ticket_line_item->type()
362 362
 				)
363 363
 			);
364 364
 		}
365
-		if ( $ticket_line_item->quantity() < $qty ) {
365
+		if ($ticket_line_item->quantity() < $qty) {
366 366
 			throw new EE_Error(
367 367
 				sprintf(
368
-					__( 'Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.', 'event_espresso' ),
368
+					__('Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.', 'event_espresso'),
369 369
 					$qty,
370 370
 					$ticket_line_item->quantity()
371 371
 				)
372 372
 			);
373 373
 		}
374 374
 		// decrement ticket quantity; don't rely on auto-fixing when recalculating totals to do this
375
-		$ticket_line_item->set_quantity( $ticket_line_item->quantity() - $qty );
376
-		foreach( $ticket_line_item->children() as $child_line_item ) {
377
-			if(
375
+		$ticket_line_item->set_quantity($ticket_line_item->quantity() - $qty);
376
+		foreach ($ticket_line_item->children() as $child_line_item) {
377
+			if (
378 378
 				$child_line_item->is_sub_line_item()
379 379
 				&& ! $child_line_item->is_percent()
380 380
 				&& ! $child_line_item->is_cancellation()
381 381
 			) {
382
-				$child_line_item->set_quantity( $child_line_item->quantity() - $qty );
382
+				$child_line_item->set_quantity($child_line_item->quantity() - $qty);
383 383
 			}
384 384
 		}
385 385
 		// get cancellation sub line item
@@ -387,37 +387,37 @@  discard block
 block discarded – undo
387 387
 			$ticket_line_item,
388 388
 			EEM_Line_Item::type_cancellation
389 389
 		);
390
-		$cancellation_line_item = reset( $cancellation_line_item );
390
+		$cancellation_line_item = reset($cancellation_line_item);
391 391
 		// verify that this ticket was indeed previously cancelled
392
-		if ( $cancellation_line_item instanceof EE_Line_Item ) {
392
+		if ($cancellation_line_item instanceof EE_Line_Item) {
393 393
 			// increment cancelled quantity
394
-			$cancellation_line_item->set_quantity( $cancellation_line_item->quantity() + $qty );
394
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() + $qty);
395 395
 		} else {
396 396
 			// create cancellation sub line item
397
-			$cancellation_line_item = EE_Line_Item::new_instance( array(
398
-				'LIN_name'       => __( 'Cancellation', 'event_espresso' ),
397
+			$cancellation_line_item = EE_Line_Item::new_instance(array(
398
+				'LIN_name'       => __('Cancellation', 'event_espresso'),
399 399
 				'LIN_desc'       => sprintf(
400
-					_x( 'Cancelled %1$s : %2$s', 'Cancelled Ticket Name : 2015-01-01 11:11', 'event_espresso' ),
400
+					_x('Cancelled %1$s : %2$s', 'Cancelled Ticket Name : 2015-01-01 11:11', 'event_espresso'),
401 401
 					$ticket_line_item->name(),
402
-					current_time( get_option( 'date_format' ) . ' ' . get_option( 'time_format' ) )
402
+					current_time(get_option('date_format').' '.get_option('time_format'))
403 403
 				),
404 404
 				'LIN_unit_price' => 0, // $ticket_line_item->unit_price()
405 405
 				'LIN_quantity'   => $qty,
406 406
 				'LIN_is_taxable' => $ticket_line_item->is_taxable(),
407
-				'LIN_order'      => count( $ticket_line_item->children() ),
407
+				'LIN_order'      => count($ticket_line_item->children()),
408 408
 				'LIN_total'      => 0, // $ticket_line_item->unit_price()
409 409
 				'LIN_type'       => EEM_Line_Item::type_cancellation,
410
-			) );
411
-			$ticket_line_item->add_child_line_item( $cancellation_line_item );
410
+			));
411
+			$ticket_line_item->add_child_line_item($cancellation_line_item);
412 412
 		}
413
-		if ( $ticket_line_item->save_this_and_descendants() > 0 ) {
413
+		if ($ticket_line_item->save_this_and_descendants() > 0) {
414 414
 			// decrement parent line item quantity
415 415
 			$event_line_item = $ticket_line_item->parent();
416
-			if ( $event_line_item instanceof EE_Line_Item && $event_line_item->OBJ_type() === 'Event' ) {
417
-				$event_line_item->set_quantity( $event_line_item->quantity() - $qty );
416
+			if ($event_line_item instanceof EE_Line_Item && $event_line_item->OBJ_type() === 'Event') {
417
+				$event_line_item->set_quantity($event_line_item->quantity() - $qty);
418 418
 				$event_line_item->save();
419 419
 			}
420
-			EEH_Line_Item::get_grand_total_and_recalculate_everything( $ticket_line_item );
420
+			EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
421 421
 			return true;
422 422
 		}
423 423
 		return false;
@@ -435,12 +435,12 @@  discard block
 block discarded – undo
435 435
 	 * @return bool success
436 436
 	 * @throws \EE_Error
437 437
 	 */
438
-	public static function reinstate_canceled_ticket_line_item( EE_Line_Item $ticket_line_item, $qty = 1 ) {
438
+	public static function reinstate_canceled_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1) {
439 439
 		// validate incoming line_item
440
-		if ( $ticket_line_item->OBJ_type() !== 'Ticket' ) {
440
+		if ($ticket_line_item->OBJ_type() !== 'Ticket') {
441 441
 			throw new EE_Error(
442 442
 				sprintf(
443
-					__( 'The supplied line item must have an Object Type of "Ticket", not %1$s.', 'event_espresso' ),
443
+					__('The supplied line item must have an Object Type of "Ticket", not %1$s.', 'event_espresso'),
444 444
 					$ticket_line_item->type()
445 445
 				)
446 446
 			);
@@ -450,42 +450,42 @@  discard block
 block discarded – undo
450 450
 			$ticket_line_item,
451 451
 			EEM_Line_Item::type_cancellation
452 452
 		);
453
-		$cancellation_line_item = reset( $cancellation_line_item );
453
+		$cancellation_line_item = reset($cancellation_line_item);
454 454
 		// verify that this ticket was indeed previously cancelled
455
-		if ( ! $cancellation_line_item instanceof EE_Line_Item ) {
455
+		if ( ! $cancellation_line_item instanceof EE_Line_Item) {
456 456
 			return false;
457 457
 		}
458
-		if ( $cancellation_line_item->quantity() > $qty ) {
458
+		if ($cancellation_line_item->quantity() > $qty) {
459 459
 			// decrement cancelled quantity
460
-			$cancellation_line_item->set_quantity( $cancellation_line_item->quantity() - $qty );
461
-		} else if ( $cancellation_line_item->quantity() == $qty ) {
460
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
461
+		} else if ($cancellation_line_item->quantity() == $qty) {
462 462
 			// decrement cancelled quantity in case anyone still has the object kicking around
463
-			$cancellation_line_item->set_quantity( $cancellation_line_item->quantity() - $qty );
463
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
464 464
 			// delete because quantity will end up as 0
465 465
 			$cancellation_line_item->delete();
466 466
 			// and attempt to destroy the object,
467 467
 			// even though PHP won't actually destroy it until it needs the memory
468
-			unset( $cancellation_line_item );
468
+			unset($cancellation_line_item);
469 469
 		} else {
470 470
 			// what ?!?! negative quantity ?!?!
471 471
 			throw new EE_Error(
472 472
 				sprintf(
473
-					__( 'Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.',
474
-						'event_espresso' ),
473
+					__('Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.',
474
+						'event_espresso'),
475 475
 					$qty,
476 476
 					$cancellation_line_item->quantity()
477 477
 				)
478 478
 			);
479 479
 		}
480 480
 		// increment ticket quantity
481
-		$ticket_line_item->set_quantity( $ticket_line_item->quantity() + $qty );
482
-		if ( $ticket_line_item->save_this_and_descendants() > 0 ) {
481
+		$ticket_line_item->set_quantity($ticket_line_item->quantity() + $qty);
482
+		if ($ticket_line_item->save_this_and_descendants() > 0) {
483 483
 			// increment parent line item quantity
484 484
 			$event_line_item = $ticket_line_item->parent();
485
-			if ( $event_line_item instanceof EE_Line_Item && $event_line_item->OBJ_type() === 'Event' ) {
486
-				$event_line_item->set_quantity( $event_line_item->quantity() + $qty );
485
+			if ($event_line_item instanceof EE_Line_Item && $event_line_item->OBJ_type() === 'Event') {
486
+				$event_line_item->set_quantity($event_line_item->quantity() + $qty);
487 487
 			}
488
-			EEH_Line_Item::get_grand_total_and_recalculate_everything( $ticket_line_item );
488
+			EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
489 489
 			return true;
490 490
 		}
491 491
 		return false;
@@ -500,8 +500,8 @@  discard block
 block discarded – undo
500 500
 	 * @param EE_Line_Item $line_item
501 501
 	 * @return \EE_Line_Item
502 502
 	 */
503
-	public static function get_grand_total_and_recalculate_everything( EE_Line_Item $line_item ){
504
-		$grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item( $line_item );
503
+	public static function get_grand_total_and_recalculate_everything(EE_Line_Item $line_item) {
504
+		$grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item);
505 505
 		return $grand_total_line_item->recalculate_total_including_taxes();
506 506
 	}
507 507
 
@@ -514,11 +514,11 @@  discard block
 block discarded – undo
514 514
 	 * @return \EE_Line_Item
515 515
 	 * @throws \EE_Error
516 516
 	 */
517
-	public static function get_pre_tax_subtotal( EE_Line_Item $total_line_item ){
518
-		$pre_tax_subtotal = $total_line_item->get_child_line_item( 'pre-tax-subtotal' );
517
+	public static function get_pre_tax_subtotal(EE_Line_Item $total_line_item) {
518
+		$pre_tax_subtotal = $total_line_item->get_child_line_item('pre-tax-subtotal');
519 519
 		return $pre_tax_subtotal instanceof EE_Line_Item
520 520
 			? $pre_tax_subtotal
521
-			: self::create_pre_tax_subtotal( $total_line_item );
521
+			: self::create_pre_tax_subtotal($total_line_item);
522 522
 	}
523 523
 
524 524
 
@@ -530,9 +530,9 @@  discard block
 block discarded – undo
530 530
 	 * @return \EE_Line_Item
531 531
 	 * @throws \EE_Error
532 532
 	 */
533
-	public static function get_taxes_subtotal( EE_Line_Item $total_line_item ){
534
-		$taxes = $total_line_item->get_child_line_item( 'taxes' );
535
-		return $taxes ? $taxes : self::create_taxes_subtotal( $total_line_item );
533
+	public static function get_taxes_subtotal(EE_Line_Item $total_line_item) {
534
+		$taxes = $total_line_item->get_child_line_item('taxes');
535
+		return $taxes ? $taxes : self::create_taxes_subtotal($total_line_item);
536 536
 	}
537 537
 
538 538
 
@@ -545,12 +545,12 @@  discard block
 block discarded – undo
545 545
 	 * @return void
546 546
 	 * @throws \EE_Error
547 547
 	 */
548
-	public static function set_TXN_ID( EE_Line_Item $line_item, $transaction = NULL ){
549
-		if( $transaction ){
548
+	public static function set_TXN_ID(EE_Line_Item $line_item, $transaction = NULL) {
549
+		if ($transaction) {
550 550
 			/** @type EEM_Transaction $EEM_Transaction */
551
-			$EEM_Transaction = EE_Registry::instance()->load_model( 'Transaction' );
552
-			$TXN_ID = $EEM_Transaction->ensure_is_ID( $transaction );
553
-			$line_item->set_TXN_ID( $TXN_ID );
551
+			$EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
552
+			$TXN_ID = $EEM_Transaction->ensure_is_ID($transaction);
553
+			$line_item->set_TXN_ID($TXN_ID);
554 554
 		}
555 555
 	}
556 556
 
@@ -565,8 +565,8 @@  discard block
 block discarded – undo
565 565
 	 * @return \EE_Line_Item of type total
566 566
 	 * @throws \EE_Error
567 567
 	 */
568
-	public static function create_total_line_item( $transaction = NULL ){
569
-		$total_line_item = EE_Line_Item::new_instance( array(
568
+	public static function create_total_line_item($transaction = NULL) {
569
+		$total_line_item = EE_Line_Item::new_instance(array(
570 570
 			'LIN_code'	=> 'total',
571 571
 			'LIN_name'	=> __('Grand Total', 'event_espresso'),
572 572
 			'LIN_type'	=> EEM_Line_Item::type_total,
@@ -576,9 +576,9 @@  discard block
 block discarded – undo
576 576
 			'FHEE__EEH_Line_Item__create_total_line_item__total_line_item',
577 577
 			$total_line_item
578 578
 		);
579
-		self::set_TXN_ID( $total_line_item, $transaction );
580
-		self::create_pre_tax_subtotal( $total_line_item, $transaction );
581
-		self::create_taxes_subtotal( $total_line_item, $transaction );
579
+		self::set_TXN_ID($total_line_item, $transaction);
580
+		self::create_pre_tax_subtotal($total_line_item, $transaction);
581
+		self::create_taxes_subtotal($total_line_item, $transaction);
582 582
 		return $total_line_item;
583 583
 	}
584 584
 
@@ -592,19 +592,19 @@  discard block
 block discarded – undo
592 592
 	 * @return EE_Line_Item
593 593
 	 * @throws \EE_Error
594 594
 	 */
595
-	protected static function create_pre_tax_subtotal( EE_Line_Item $total_line_item, $transaction = NULL ){
596
-		$pre_tax_line_item = EE_Line_Item::new_instance( array(
595
+	protected static function create_pre_tax_subtotal(EE_Line_Item $total_line_item, $transaction = NULL) {
596
+		$pre_tax_line_item = EE_Line_Item::new_instance(array(
597 597
 			'LIN_code' 	=> 'pre-tax-subtotal',
598
-			'LIN_name' 	=> __( 'Pre-Tax Subtotal', 'event_espresso' ),
598
+			'LIN_name' 	=> __('Pre-Tax Subtotal', 'event_espresso'),
599 599
 			'LIN_type' 	=> EEM_Line_Item::type_sub_total
600
-		) );
600
+		));
601 601
 		$pre_tax_line_item = apply_filters(
602 602
 			'FHEE__EEH_Line_Item__create_pre_tax_subtotal__pre_tax_line_item',
603 603
 			$pre_tax_line_item
604 604
 		);
605
-		self::set_TXN_ID( $pre_tax_line_item, $transaction );
606
-		$total_line_item->add_child_line_item( $pre_tax_line_item );
607
-		self::create_event_subtotal( $pre_tax_line_item, $transaction );
605
+		self::set_TXN_ID($pre_tax_line_item, $transaction);
606
+		$total_line_item->add_child_line_item($pre_tax_line_item);
607
+		self::create_event_subtotal($pre_tax_line_item, $transaction);
608 608
 		return $pre_tax_line_item;
609 609
 	}
610 610
 
@@ -619,21 +619,21 @@  discard block
 block discarded – undo
619 619
 	 * @return EE_Line_Item
620 620
 	 * @throws \EE_Error
621 621
 	 */
622
-	protected static function create_taxes_subtotal( EE_Line_Item $total_line_item, $transaction = NULL ){
622
+	protected static function create_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = NULL) {
623 623
 		$tax_line_item = EE_Line_Item::new_instance(array(
624 624
 			'LIN_code'	=> 'taxes',
625 625
 			'LIN_name' 	=> __('Taxes', 'event_espresso'),
626 626
 			'LIN_type'	=> EEM_Line_Item::type_tax_sub_total,
627
-			'LIN_order' => 1000,//this should always come last
627
+			'LIN_order' => 1000, //this should always come last
628 628
 		));
629 629
 		$tax_line_item = apply_filters(
630 630
 			'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item',
631 631
 			$tax_line_item
632 632
 		);
633
-		self::set_TXN_ID( $tax_line_item, $transaction );
634
-		$total_line_item->add_child_line_item( $tax_line_item );
633
+		self::set_TXN_ID($tax_line_item, $transaction);
634
+		$total_line_item->add_child_line_item($tax_line_item);
635 635
 		//and lastly, add the actual taxes
636
-		self::apply_taxes( $total_line_item );
636
+		self::apply_taxes($total_line_item);
637 637
 		return $tax_line_item;
638 638
 	}
639 639
 
@@ -648,11 +648,11 @@  discard block
 block discarded – undo
648 648
 	 * @return EE_Line_Item
649 649
 	 * @throws \EE_Error
650 650
 	 */
651
-	public static function create_event_subtotal( EE_Line_Item $pre_tax_line_item, $transaction = NULL, $event = NULL ){
651
+	public static function create_event_subtotal(EE_Line_Item $pre_tax_line_item, $transaction = NULL, $event = NULL) {
652 652
 		$event_line_item = EE_Line_Item::new_instance(array(
653
-			'LIN_code'	=> self::get_event_code( $event ),
654
-			'LIN_name' 	=> self::get_event_name( $event ),
655
-			'LIN_desc' 	=> self::get_event_desc( $event ),
653
+			'LIN_code'	=> self::get_event_code($event),
654
+			'LIN_name' 	=> self::get_event_name($event),
655
+			'LIN_desc' 	=> self::get_event_desc($event),
656 656
 			'LIN_type'	=> EEM_Line_Item::type_sub_total,
657 657
 			'OBJ_type' 	=> 'Event',
658 658
 			'OBJ_ID' 		=>  $event instanceof EE_Event ? $event->ID() : 0
@@ -661,8 +661,8 @@  discard block
 block discarded – undo
661 661
 			'FHEE__EEH_Line_Item__create_event_subtotal__event_line_item',
662 662
 			$event_line_item
663 663
 		);
664
-		self::set_TXN_ID( $event_line_item, $transaction );
665
-		$pre_tax_line_item->add_child_line_item( $event_line_item );
664
+		self::set_TXN_ID($event_line_item, $transaction);
665
+		$pre_tax_line_item->add_child_line_item($event_line_item);
666 666
 		return $event_line_item;
667 667
 	}
668 668
 
@@ -675,8 +675,8 @@  discard block
 block discarded – undo
675 675
 	 * @return string
676 676
 	 * @throws \EE_Error
677 677
 	 */
678
-	public static function get_event_code( $event ) {
679
-		return 'event-' . ( $event instanceof EE_Event ? $event->ID() : '0' );
678
+	public static function get_event_code($event) {
679
+		return 'event-'.($event instanceof EE_Event ? $event->ID() : '0');
680 680
 	}
681 681
 
682 682
 	/**
@@ -684,8 +684,8 @@  discard block
 block discarded – undo
684 684
 	 * @param EE_Event $event
685 685
 	 * @return string
686 686
 	 */
687
-	public static function get_event_name( $event ) {
688
-		return $event instanceof EE_Event ? $event->name() : __( 'Event', 'event_espresso' );
687
+	public static function get_event_name($event) {
688
+		return $event instanceof EE_Event ? $event->name() : __('Event', 'event_espresso');
689 689
 	}
690 690
 
691 691
 	/**
@@ -693,7 +693,7 @@  discard block
 block discarded – undo
693 693
 	 * @param EE_Event $event
694 694
 	 * @return string
695 695
 	 */
696
-	public static function get_event_desc( $event ) {
696
+	public static function get_event_desc($event) {
697 697
 		return $event instanceof EE_Event ? $event->short_description() : '';
698 698
 	}
699 699
 
@@ -707,27 +707,27 @@  discard block
 block discarded – undo
707 707
 	  * @throws \EE_Error
708 708
 	  * @return EE_Line_Item
709 709
 	  */
710
-	public static function get_event_line_item_for_ticket( EE_Line_Item $grand_total, EE_Ticket $ticket ) {
710
+	public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket) {
711 711
 		$first_datetime = $ticket->first_datetime();
712
-		if ( ! $first_datetime instanceof EE_Datetime ) {
712
+		if ( ! $first_datetime instanceof EE_Datetime) {
713 713
 			throw new EE_Error(
714
-				sprintf( __( 'The supplied ticket (ID %d) has no datetimes', 'event_espresso' ), $ticket->ID() )
714
+				sprintf(__('The supplied ticket (ID %d) has no datetimes', 'event_espresso'), $ticket->ID())
715 715
 			);
716 716
 		}
717 717
 		$event = $first_datetime->event();
718
-		if ( ! $event instanceof EE_Event ) {
718
+		if ( ! $event instanceof EE_Event) {
719 719
 			throw new EE_Error(
720 720
 				sprintf(
721
-					__( 'The supplied ticket (ID %d) has no event data associated with it.', 'event_espresso' ),
721
+					__('The supplied ticket (ID %d) has no event data associated with it.', 'event_espresso'),
722 722
 					$ticket->ID()
723 723
 				)
724 724
 			);
725 725
 		}
726
-		$events_sub_total = EEH_Line_Item::get_event_line_item( $grand_total, $event );
727
-		if ( ! $events_sub_total instanceof EE_Line_Item ) {
726
+		$events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event);
727
+		if ( ! $events_sub_total instanceof EE_Line_Item) {
728 728
 			throw new EE_Error(
729 729
 				sprintf(
730
-					__( 'There is no events sub-total for ticket %s on total line item %d', 'event_espresso' ),
730
+					__('There is no events sub-total for ticket %s on total line item %d', 'event_espresso'),
731 731
 					$ticket->ID(),
732 732
 					$grand_total->ID()
733 733
 				)
@@ -746,31 +746,31 @@  discard block
 block discarded – undo
746 746
 	 * @return EE_Line_Item for the event subtotal which is a child of $grand_total
747 747
 	 * @throws \EE_Error
748 748
 	 */
749
-	public static function get_event_line_item( EE_Line_Item $grand_total, $event ) {
749
+	public static function get_event_line_item(EE_Line_Item $grand_total, $event) {
750 750
 		/** @type EE_Event $event */
751
-		$event = EEM_Event::instance()->ensure_is_obj( $event, true );
751
+		$event = EEM_Event::instance()->ensure_is_obj($event, true);
752 752
 		$event_line_item = NULL;
753 753
 		$found = false;
754
-		foreach ( EEH_Line_Item::get_event_subtotals( $grand_total ) as $event_line_item ) {
754
+		foreach (EEH_Line_Item::get_event_subtotals($grand_total) as $event_line_item) {
755 755
 			// default event subtotal, we should only ever find this the first time this method is called
756
-			if ( ! $event_line_item->OBJ_ID() ) {
756
+			if ( ! $event_line_item->OBJ_ID()) {
757 757
 				// let's use this! but first... set the event details
758
-				EEH_Line_Item::set_event_subtotal_details( $event_line_item, $event );
758
+				EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
759 759
 				$found = true;
760 760
 				break;
761
-			} else if ( $event_line_item->OBJ_ID() === $event->ID() ) {
761
+			} else if ($event_line_item->OBJ_ID() === $event->ID()) {
762 762
 				// found existing line item for this event in the cart, so break out of loop and use this one
763 763
 				$found = true;
764 764
 				break;
765 765
 			}
766 766
 		}
767
-		if ( ! $found ) {
767
+		if ( ! $found) {
768 768
 			//there is no event sub-total yet, so add it
769
-			$pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal( $grand_total );
769
+			$pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal($grand_total);
770 770
 			// create a new "event" subtotal below that
771
-			$event_line_item = EEH_Line_Item::create_event_subtotal( $pre_tax_subtotal, null, $event );
771
+			$event_line_item = EEH_Line_Item::create_event_subtotal($pre_tax_subtotal, null, $event);
772 772
 			// and set the event details
773
-			EEH_Line_Item::set_event_subtotal_details( $event_line_item, $event );
773
+			EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
774 774
 		}
775 775
 		return $event_line_item;
776 776
 	}
@@ -791,13 +791,13 @@  discard block
 block discarded – undo
791 791
 		EE_Event $event,
792 792
 		$transaction = null
793 793
 	) {
794
-		if ( $event instanceof EE_Event ) {
795
-			$event_line_item->set_code( self::get_event_code( $event ) );
796
-			$event_line_item->set_name( self::get_event_name( $event ) );
797
-			$event_line_item->set_desc( self::get_event_desc( $event ) );
798
-			$event_line_item->set_OBJ_ID( $event->ID() );
794
+		if ($event instanceof EE_Event) {
795
+			$event_line_item->set_code(self::get_event_code($event));
796
+			$event_line_item->set_name(self::get_event_name($event));
797
+			$event_line_item->set_desc(self::get_event_desc($event));
798
+			$event_line_item->set_OBJ_ID($event->ID());
799 799
 		}
800
-		self::set_TXN_ID( $event_line_item, $transaction );
800
+		self::set_TXN_ID($event_line_item, $transaction);
801 801
 	}
802 802
 
803 803
 
@@ -810,19 +810,19 @@  discard block
 block discarded – undo
810 810
 	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
811 811
 	 * @throws \EE_Error
812 812
 	 */
813
-	public static function apply_taxes( EE_Line_Item $total_line_item ){
813
+	public static function apply_taxes(EE_Line_Item $total_line_item) {
814 814
 		/** @type EEM_Price $EEM_Price */
815
-		$EEM_Price = EE_Registry::instance()->load_model( 'Price' );
815
+		$EEM_Price = EE_Registry::instance()->load_model('Price');
816 816
 		// get array of taxes via Price Model
817 817
 		$ordered_taxes = $EEM_Price->get_all_prices_that_are_taxes();
818
-		ksort( $ordered_taxes );
819
-		$taxes_line_item = self::get_taxes_subtotal( $total_line_item );
818
+		ksort($ordered_taxes);
819
+		$taxes_line_item = self::get_taxes_subtotal($total_line_item);
820 820
 		//just to be safe, remove its old tax line items
821 821
 		$taxes_line_item->delete_children_line_items();
822 822
 		//loop thru taxes
823
-		foreach ( $ordered_taxes as $order => $taxes ) {
824
-			foreach ( $taxes as $tax ) {
825
-				if ( $tax instanceof EE_Price ) {
823
+		foreach ($ordered_taxes as $order => $taxes) {
824
+			foreach ($taxes as $tax) {
825
+				if ($tax instanceof EE_Price) {
826 826
 					$tax_line_item = EE_Line_Item::new_instance(
827 827
 						array(
828 828
 							'LIN_name'       => $tax->name(),
@@ -840,7 +840,7 @@  discard block
 block discarded – undo
840 840
 						'FHEE__EEH_Line_Item__apply_taxes__tax_line_item',
841 841
 						$tax_line_item
842 842
 					);
843
-					$taxes_line_item->add_child_line_item( $tax_line_item );
843
+					$taxes_line_item->add_child_line_item($tax_line_item);
844 844
 				}
845 845
 			}
846 846
 		}
@@ -857,10 +857,10 @@  discard block
 block discarded – undo
857 857
 	 * @return float
858 858
 	 * @throws \EE_Error
859 859
 	 */
860
-	public static function ensure_taxes_applied( $total_line_item ){
861
-		$taxes_subtotal = self::get_taxes_subtotal( $total_line_item );
862
-		if( ! $taxes_subtotal->children()){
863
-			self::apply_taxes( $total_line_item );
860
+	public static function ensure_taxes_applied($total_line_item) {
861
+		$taxes_subtotal = self::get_taxes_subtotal($total_line_item);
862
+		if ( ! $taxes_subtotal->children()) {
863
+			self::apply_taxes($total_line_item);
864 864
 		}
865 865
 		return $taxes_subtotal->total();
866 866
 	}
@@ -874,16 +874,16 @@  discard block
 block discarded – undo
874 874
 	 * @return bool
875 875
 	 * @throws \EE_Error
876 876
 	 */
877
-	public static function delete_all_child_items( EE_Line_Item $parent_line_item ) {
877
+	public static function delete_all_child_items(EE_Line_Item $parent_line_item) {
878 878
 		$deleted = 0;
879
-		foreach ( $parent_line_item->children() as $child_line_item ) {
880
-			if ( $child_line_item instanceof EE_Line_Item ) {
881
-				$deleted += EEH_Line_Item::delete_all_child_items( $child_line_item );
882
-				if ( $child_line_item->ID() ) {
879
+		foreach ($parent_line_item->children() as $child_line_item) {
880
+			if ($child_line_item instanceof EE_Line_Item) {
881
+				$deleted += EEH_Line_Item::delete_all_child_items($child_line_item);
882
+				if ($child_line_item->ID()) {
883 883
 					$child_line_item->delete();
884
-					unset( $child_line_item );
884
+					unset($child_line_item);
885 885
 				} else {
886
-					$parent_line_item->delete_child_line_item( $child_line_item->code() );
886
+					$parent_line_item->delete_child_line_item($child_line_item->code());
887 887
 				}
888 888
 				$deleted++;
889 889
 			}
@@ -905,9 +905,9 @@  discard block
 block discarded – undo
905 905
 	 * @param array|bool|string $line_item_codes
906 906
 	 * @return int number of items successfully removed
907 907
 	 */
908
-	public static function delete_items( EE_Line_Item $total_line_item, $line_item_codes = FALSE ) {
908
+	public static function delete_items(EE_Line_Item $total_line_item, $line_item_codes = FALSE) {
909 909
 
910
-		if( $total_line_item->type() !== EEM_Line_Item::type_total ){
910
+		if ($total_line_item->type() !== EEM_Line_Item::type_total) {
911 911
 			EE_Error::doing_it_wrong(
912 912
 				'EEH_Line_Item::delete_items',
913 913
 				__(
@@ -917,20 +917,20 @@  discard block
 block discarded – undo
917 917
 				'4.6.18'
918 918
 			);
919 919
 		}
920
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
920
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
921 921
 
922 922
 		// check if only a single line_item_id was passed
923
-		if ( ! empty( $line_item_codes ) && ! is_array( $line_item_codes )) {
923
+		if ( ! empty($line_item_codes) && ! is_array($line_item_codes)) {
924 924
 			// place single line_item_id in an array to appear as multiple line_item_ids
925
-			$line_item_codes = array ( $line_item_codes );
925
+			$line_item_codes = array($line_item_codes);
926 926
 		}
927 927
 		$removals = 0;
928 928
 		// cycle thru line_item_ids
929
-		foreach ( $line_item_codes as $line_item_id ) {
929
+		foreach ($line_item_codes as $line_item_id) {
930 930
 			$removals += $total_line_item->delete_child_line_item($line_item_id);
931 931
 		}
932 932
 
933
-		if ( $removals > 0 ) {
933
+		if ($removals > 0) {
934 934
 			$total_line_item->recalculate_taxes_and_tax_total();
935 935
 			return $removals;
936 936
 		} else {
@@ -963,33 +963,33 @@  discard block
 block discarded – undo
963 963
 		$code = null,
964 964
 		$add_to_existing_line_item = false
965 965
 	) {
966
-		$tax_subtotal = self::get_taxes_subtotal( $total_line_item );
966
+		$tax_subtotal = self::get_taxes_subtotal($total_line_item);
967 967
             $taxable_total = $total_line_item->taxable_total();
968 968
 
969
-            if( $add_to_existing_line_item ) {
970
-                $new_tax = $tax_subtotal->get_child_line_item( $code );
969
+            if ($add_to_existing_line_item) {
970
+                $new_tax = $tax_subtotal->get_child_line_item($code);
971 971
 	            EEM_Line_Item::instance()->delete(
972
-		            array( array( 'LIN_code' => array( '!=', $code ), 'LIN_parent' => $tax_subtotal->ID() ) )
972
+		            array(array('LIN_code' => array('!=', $code), 'LIN_parent' => $tax_subtotal->ID()))
973 973
 	            );
974 974
             } else {
975 975
                 $new_tax = null;
976 976
                 $tax_subtotal->delete_children_line_items();
977 977
             }
978
-            if( $new_tax ) {
979
-                $new_tax->set_total( $new_tax->total() + $amount );
980
-                $new_tax->set_percent( $taxable_total ? $new_tax->total() / $taxable_total * 100 : 0 );
978
+            if ($new_tax) {
979
+                $new_tax->set_total($new_tax->total() + $amount);
980
+                $new_tax->set_percent($taxable_total ? $new_tax->total() / $taxable_total * 100 : 0);
981 981
             } else {
982 982
                 //no existing tax item. Create it
983
-				$new_tax = EE_Line_Item::new_instance( array(
983
+				$new_tax = EE_Line_Item::new_instance(array(
984 984
 					'TXN_ID'      => $total_line_item->TXN_ID(),
985
-					'LIN_name'    => $name ? $name : __( 'Tax', 'event_espresso' ),
985
+					'LIN_name'    => $name ? $name : __('Tax', 'event_espresso'),
986 986
 					'LIN_desc'    => $description ? $description : '',
987
-					'LIN_percent' => $taxable_total ? ( $amount / $taxable_total * 100 ) : 0,
987
+					'LIN_percent' => $taxable_total ? ($amount / $taxable_total * 100) : 0,
988 988
 					'LIN_total'   => $amount,
989 989
 					'LIN_parent'  => $tax_subtotal->ID(),
990 990
 					'LIN_type'    => EEM_Line_Item::type_tax,
991 991
 					'LIN_code'    => $code
992
-				) );
992
+				));
993 993
 			}
994 994
 
995 995
             $new_tax = apply_filters(
@@ -998,7 +998,7 @@  discard block
 block discarded – undo
998 998
 				$total_line_item
999 999
             );
1000 1000
             $new_tax->save();
1001
-            $tax_subtotal->set_total( $new_tax->total() );
1001
+            $tax_subtotal->set_total($new_tax->total());
1002 1002
             $tax_subtotal->save();
1003 1003
             $total_line_item->recalculate_total_including_taxes();
1004 1004
             return $new_tax;
@@ -1020,14 +1020,14 @@  discard block
 block discarded – undo
1020 1020
 		$code_substring_for_whitelist = null
1021 1021
 	) {
1022 1022
 		$whitelisted = false;
1023
-		if( $code_substring_for_whitelist !== null ) {
1024
-			$whitelisted = strpos( $line_item->code(), $code_substring_for_whitelist ) !== false ? true : false;
1023
+		if ($code_substring_for_whitelist !== null) {
1024
+			$whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false ? true : false;
1025 1025
 		}
1026
-		if( ! $whitelisted && $line_item->is_line_item() ) {
1027
-			$line_item->set_is_taxable( $taxable );
1026
+		if ( ! $whitelisted && $line_item->is_line_item()) {
1027
+			$line_item->set_is_taxable($taxable);
1028 1028
 		}
1029
-		foreach( $line_item->children() as $child_line_item ) {
1030
-			EEH_Line_Item::set_line_items_taxable( $child_line_item, $taxable, $code_substring_for_whitelist );
1029
+		foreach ($line_item->children() as $child_line_item) {
1030
+			EEH_Line_Item::set_line_items_taxable($child_line_item, $taxable, $code_substring_for_whitelist);
1031 1031
 		}
1032 1032
 	}
1033 1033
 
@@ -1040,8 +1040,8 @@  discard block
 block discarded – undo
1040 1040
 	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
1041 1041
 	 * @return EE_Line_Item[]
1042 1042
 	 */
1043
-	public static function get_event_subtotals( EE_Line_Item $parent_line_item ) {
1044
-		return self::get_subtotals_of_object_type( $parent_line_item, 'Event' );
1043
+	public static function get_event_subtotals(EE_Line_Item $parent_line_item) {
1044
+		return self::get_subtotals_of_object_type($parent_line_item, 'Event');
1045 1045
 	}
1046 1046
 
1047 1047
 
@@ -1054,7 +1054,7 @@  discard block
 block discarded – undo
1054 1054
 	 * @param string $obj_type
1055 1055
 	 * @return EE_Line_Item[]
1056 1056
 	 */
1057
-	public static function get_subtotals_of_object_type( EE_Line_Item $parent_line_item, $obj_type = '' ) {
1057
+	public static function get_subtotals_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '') {
1058 1058
 		return self::_get_descendants_by_type_and_object_type(
1059 1059
 			$parent_line_item,
1060 1060
 			EEM_Line_Item::type_sub_total,
@@ -1071,8 +1071,8 @@  discard block
 block discarded – undo
1071 1071
 	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
1072 1072
 	 * @return EE_Line_Item[]
1073 1073
 	 */
1074
-	public static function get_ticket_line_items( EE_Line_Item $parent_line_item ) {
1075
-		return self::get_line_items_of_object_type( $parent_line_item, 'Ticket' );
1074
+	public static function get_ticket_line_items(EE_Line_Item $parent_line_item) {
1075
+		return self::get_line_items_of_object_type($parent_line_item, 'Ticket');
1076 1076
 	}
1077 1077
 
1078 1078
 
@@ -1085,8 +1085,8 @@  discard block
 block discarded – undo
1085 1085
 	 * @param string $obj_type
1086 1086
 	 * @return EE_Line_Item[]
1087 1087
 	 */
1088
-	public static function get_line_items_of_object_type( EE_Line_Item $parent_line_item, $obj_type = '' ) {
1089
-		return self::_get_descendants_by_type_and_object_type( $parent_line_item, EEM_Line_Item::type_line_item, $obj_type );
1088
+	public static function get_line_items_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '') {
1089
+		return self::_get_descendants_by_type_and_object_type($parent_line_item, EEM_Line_Item::type_line_item, $obj_type);
1090 1090
 	}
1091 1091
 
1092 1092
 
@@ -1097,8 +1097,8 @@  discard block
 block discarded – undo
1097 1097
 	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
1098 1098
 	 * @return EE_Line_Item[]
1099 1099
 	 */
1100
-	public static function get_tax_descendants( EE_Line_Item $parent_line_item ) {
1101
-		return EEH_Line_Item::get_descendants_of_type( $parent_line_item, EEM_Line_Item::type_tax );
1100
+	public static function get_tax_descendants(EE_Line_Item $parent_line_item) {
1101
+		return EEH_Line_Item::get_descendants_of_type($parent_line_item, EEM_Line_Item::type_tax);
1102 1102
 	}
1103 1103
 
1104 1104
 
@@ -1109,8 +1109,8 @@  discard block
 block discarded – undo
1109 1109
 	 * @param \EE_Line_Item $parent_line_item - the line item to find descendants of
1110 1110
 	 * @return EE_Line_Item[]
1111 1111
 	 */
1112
-	public static function get_line_item_descendants( EE_Line_Item $parent_line_item ) {
1113
-		return EEH_Line_Item::get_descendants_of_type( $parent_line_item, EEM_Line_Item::type_line_item );
1112
+	public static function get_line_item_descendants(EE_Line_Item $parent_line_item) {
1113
+		return EEH_Line_Item::get_descendants_of_type($parent_line_item, EEM_Line_Item::type_line_item);
1114 1114
 	}
1115 1115
 
1116 1116
 
@@ -1123,8 +1123,8 @@  discard block
 block discarded – undo
1123 1123
 	 * @param string $line_item_type one of the EEM_Line_Item constants
1124 1124
 	 * @return EE_Line_Item[]
1125 1125
 	 */
1126
-	public static function get_descendants_of_type( EE_Line_Item $parent_line_item, $line_item_type ) {
1127
-		return self::_get_descendants_by_type_and_object_type( $parent_line_item, $line_item_type, NULL );
1126
+	public static function get_descendants_of_type(EE_Line_Item $parent_line_item, $line_item_type) {
1127
+		return self::_get_descendants_by_type_and_object_type($parent_line_item, $line_item_type, NULL);
1128 1128
 	}
1129 1129
 
1130 1130
 
@@ -1143,8 +1143,8 @@  discard block
 block discarded – undo
1143 1143
 		$obj_type = null
1144 1144
 	) {
1145 1145
 		$objects = array();
1146
-		foreach ( $parent_line_item->children() as $child_line_item ) {
1147
-			if ( $child_line_item instanceof EE_Line_Item ) {
1146
+		foreach ($parent_line_item->children() as $child_line_item) {
1147
+			if ($child_line_item instanceof EE_Line_Item) {
1148 1148
 				if (
1149 1149
 					$child_line_item->type() === $line_item_type
1150 1150
 				    && (
@@ -1184,7 +1184,7 @@  discard block
 block discarded – undo
1184 1184
 		$OBJ_type = '',
1185 1185
 		$OBJ_IDs = array()
1186 1186
 	) {
1187
-		return self::_get_descendants_by_object_type_and_object_ID( $parent_line_item, $OBJ_type, $OBJ_IDs );
1187
+		return self::_get_descendants_by_object_type_and_object_ID($parent_line_item, $OBJ_type, $OBJ_IDs);
1188 1188
 	}
1189 1189
 
1190 1190
 
@@ -1203,12 +1203,12 @@  discard block
 block discarded – undo
1203 1203
 		$OBJ_IDs
1204 1204
 	) {
1205 1205
 		$objects = array();
1206
-		foreach ( $parent_line_item->children() as $child_line_item ) {
1207
-			if ( $child_line_item instanceof EE_Line_Item ) {
1206
+		foreach ($parent_line_item->children() as $child_line_item) {
1207
+			if ($child_line_item instanceof EE_Line_Item) {
1208 1208
 				if (
1209 1209
 					$child_line_item->OBJ_type() === $OBJ_type
1210
-					&& is_array( $OBJ_IDs )
1211
-					&& in_array( $child_line_item->OBJ_ID(), $OBJ_IDs )
1210
+					&& is_array($OBJ_IDs)
1211
+					&& in_array($child_line_item->OBJ_ID(), $OBJ_IDs)
1212 1212
 				) {
1213 1213
 					$objects[] = $child_line_item;
1214 1214
 				} else {
@@ -1238,8 +1238,8 @@  discard block
 block discarded – undo
1238 1238
 	 * @param string $type like one of the EEM_Line_Item::type_*
1239 1239
 	 * @return EE_Line_Item
1240 1240
 	 */
1241
-	public static function get_nearest_descendant_of_type( EE_Line_Item $parent_line_item, $type ) {
1242
-		return self::_get_nearest_descendant( $parent_line_item, 'LIN_type' , $type );
1241
+	public static function get_nearest_descendant_of_type(EE_Line_Item $parent_line_item, $type) {
1242
+		return self::_get_nearest_descendant($parent_line_item, 'LIN_type', $type);
1243 1243
 	}
1244 1244
 
1245 1245
 
@@ -1253,8 +1253,8 @@  discard block
 block discarded – undo
1253 1253
 	 * @param string $code any value used for LIN_code
1254 1254
 	 * @return EE_Line_Item
1255 1255
 	 */
1256
-	public static function get_nearest_descendant_having_code( EE_Line_Item $parent_line_item, $code ) {
1257
-		return self::_get_nearest_descendant( $parent_line_item, 'LIN_code' , $code );
1256
+	public static function get_nearest_descendant_having_code(EE_Line_Item $parent_line_item, $code) {
1257
+		return self::_get_nearest_descendant($parent_line_item, 'LIN_code', $code);
1258 1258
 	}
1259 1259
 
1260 1260
 
@@ -1268,15 +1268,15 @@  discard block
 block discarded – undo
1268 1268
 	 * @param string $value any value stored in $search_field
1269 1269
 	 * @return EE_Line_Item
1270 1270
 	 */
1271
-	protected static function _get_nearest_descendant( EE_Line_Item $parent_line_item, $search_field, $value ) {
1272
-		foreach( $parent_line_item->children() as $child ){
1273
-			if ( $child->get( $search_field ) == $value ){
1271
+	protected static function _get_nearest_descendant(EE_Line_Item $parent_line_item, $search_field, $value) {
1272
+		foreach ($parent_line_item->children() as $child) {
1273
+			if ($child->get($search_field) == $value) {
1274 1274
 				return $child;
1275 1275
 			}
1276 1276
 		}
1277
-		foreach( $parent_line_item->children() as $child ){
1278
-			$descendant_found = self::_get_nearest_descendant( $child, $search_field, $value );
1279
-			if ( $descendant_found ){
1277
+		foreach ($parent_line_item->children() as $child) {
1278
+			$descendant_found = self::_get_nearest_descendant($child, $search_field, $value);
1279
+			if ($descendant_found) {
1280 1280
 				return $descendant_found;
1281 1281
 			}
1282 1282
 		}
@@ -1293,24 +1293,24 @@  discard block
 block discarded – undo
1293 1293
 	 * @return \EE_Line_Item
1294 1294
 	 * @throws \EE_Error
1295 1295
 	 */
1296
-	public static function find_transaction_grand_total_for_line_item( EE_Line_Item $line_item ){
1297
-		if ( $line_item->TXN_ID() ) {
1298
-			$total_line_item = $line_item->transaction()->total_line_item( false );
1299
-			if ( $total_line_item instanceof EE_Line_Item ) {
1296
+	public static function find_transaction_grand_total_for_line_item(EE_Line_Item $line_item) {
1297
+		if ($line_item->TXN_ID()) {
1298
+			$total_line_item = $line_item->transaction()->total_line_item(false);
1299
+			if ($total_line_item instanceof EE_Line_Item) {
1300 1300
 				return $total_line_item;
1301 1301
 			}
1302 1302
 		} else {
1303 1303
 			$line_item_parent = $line_item->parent();
1304
-			if ( $line_item_parent instanceof EE_Line_Item ) {
1305
-				if ( $line_item_parent->is_total() ) {
1304
+			if ($line_item_parent instanceof EE_Line_Item) {
1305
+				if ($line_item_parent->is_total()) {
1306 1306
 					return $line_item_parent;
1307 1307
 				}
1308
-				return EEH_Line_Item::find_transaction_grand_total_for_line_item( $line_item_parent );
1308
+				return EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item_parent);
1309 1309
 			}
1310 1310
 		}
1311 1311
 		throw new EE_Error(
1312 1312
 			sprintf(
1313
-				__( 'A valid grand total for line item %1$d was not found.', 'event_espresso' ),
1313
+				__('A valid grand total for line item %1$d was not found.', 'event_espresso'),
1314 1314
 				$line_item->ID()
1315 1315
 			)
1316 1316
 		);
@@ -1327,31 +1327,31 @@  discard block
 block discarded – undo
1327 1327
 	 * @return void
1328 1328
 	 * @throws \EE_Error
1329 1329
 	 */
1330
-	public static function visualize( EE_Line_Item $line_item, $indentation = 0 ){
1330
+	public static function visualize(EE_Line_Item $line_item, $indentation = 0) {
1331 1331
 		echo defined('EE_TESTS_DIR') ? "\n" : '<br />';
1332
-		if ( ! $indentation ) {
1333
-			echo defined( 'EE_TESTS_DIR' ) ? "\n" : '<br />';
1332
+		if ( ! $indentation) {
1333
+			echo defined('EE_TESTS_DIR') ? "\n" : '<br />';
1334 1334
 		}
1335
-		for( $i = 0; $i < $indentation; $i++ ){
1335
+		for ($i = 0; $i < $indentation; $i++) {
1336 1336
 			echo ". ";
1337 1337
 		}
1338 1338
 		$breakdown = '';
1339
-		if ( $line_item->is_line_item()){
1340
-			if ( $line_item->is_percent() ) {
1339
+		if ($line_item->is_line_item()) {
1340
+			if ($line_item->is_percent()) {
1341 1341
 				$breakdown = "{$line_item->percent()}%";
1342 1342
 			} else {
1343
-				$breakdown = '$' . "{$line_item->unit_price()} x {$line_item->quantity()}";
1343
+				$breakdown = '$'."{$line_item->unit_price()} x {$line_item->quantity()}";
1344 1344
 			}
1345 1345
 		}
1346
-		echo $line_item->name() . " [ ID:{$line_item->ID()} | qty:{$line_item->quantity()} ] {$line_item->type()} : " . '$' . "{$line_item->total()}";
1347
-		if ( $breakdown ) {
1346
+		echo $line_item->name()." [ ID:{$line_item->ID()} | qty:{$line_item->quantity()} ] {$line_item->type()} : ".'$'."{$line_item->total()}";
1347
+		if ($breakdown) {
1348 1348
 			echo " ( {$breakdown} )";
1349 1349
 		}
1350
-		if( $line_item->is_taxable() ){
1350
+		if ($line_item->is_taxable()) {
1351 1351
 			echo "  * taxable";
1352 1352
 		}
1353
-		if( $line_item->children() ){
1354
-			foreach($line_item->children() as $child){
1353
+		if ($line_item->children()) {
1354
+			foreach ($line_item->children() as $child) {
1355 1355
 				self::visualize($child, $indentation + 1);
1356 1356
 			}
1357 1357
 		}
@@ -1392,97 +1392,97 @@  discard block
 block discarded – undo
1392 1392
 	 *                                          is theirs, which can be done with
1393 1393
 	 *                                          `EEM_Line_Item::instance()->get_line_item_for_registration( $registration );`
1394 1394
 	 */
1395
-	public static function calculate_reg_final_prices_per_line_item( EE_Line_Item $line_item, $billable_ticket_quantities = array() ) {
1395
+	public static function calculate_reg_final_prices_per_line_item(EE_Line_Item $line_item, $billable_ticket_quantities = array()) {
1396 1396
 		//init running grand total if not already
1397
-		if ( ! isset( $running_totals[ 'total' ] ) ) {
1398
-			$running_totals[ 'total' ] = 0;
1397
+		if ( ! isset($running_totals['total'])) {
1398
+			$running_totals['total'] = 0;
1399 1399
 		}
1400
-		if( ! isset( $running_totals[ 'taxable' ] ) ) {
1401
-			$running_totals[ 'taxable' ] = array( 'total' => 0 );
1400
+		if ( ! isset($running_totals['taxable'])) {
1401
+			$running_totals['taxable'] = array('total' => 0);
1402 1402
 		}
1403
-		foreach ( $line_item->children() as $child_line_item ) {
1404
-			switch ( $child_line_item->type() ) {
1403
+		foreach ($line_item->children() as $child_line_item) {
1404
+			switch ($child_line_item->type()) {
1405 1405
 
1406 1406
 				case EEM_Line_Item::type_sub_total :
1407
-					$running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item( $child_line_item, $billable_ticket_quantities );
1407
+					$running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item($child_line_item, $billable_ticket_quantities);
1408 1408
 					//combine arrays but preserve numeric keys
1409
-					$running_totals = array_replace_recursive( $running_totals_from_subtotal, $running_totals );
1410
-					$running_totals[ 'total' ] += $running_totals_from_subtotal[ 'total' ];
1411
-					$running_totals[ 'taxable'][ 'total' ] += $running_totals_from_subtotal[ 'taxable' ][ 'total' ];
1409
+					$running_totals = array_replace_recursive($running_totals_from_subtotal, $running_totals);
1410
+					$running_totals['total'] += $running_totals_from_subtotal['total'];
1411
+					$running_totals['taxable']['total'] += $running_totals_from_subtotal['taxable']['total'];
1412 1412
 					break;
1413 1413
 
1414 1414
 				case EEM_Line_Item::type_tax_sub_total :
1415 1415
 
1416 1416
 					//find how much the taxes percentage is
1417
-					if ( $child_line_item->percent() !== 0 ) {
1417
+					if ($child_line_item->percent() !== 0) {
1418 1418
 						$tax_percent_decimal = $child_line_item->percent() / 100;
1419 1419
 					} else {
1420 1420
 						$tax_percent_decimal = EE_Taxes::get_total_taxes_percentage() / 100;
1421 1421
 					}
1422 1422
 					//and apply to all the taxable totals, and add to the pretax totals
1423
-					foreach ( $running_totals as $line_item_id => $this_running_total ) {
1423
+					foreach ($running_totals as $line_item_id => $this_running_total) {
1424 1424
 						//"total" and "taxable" array key is an exception
1425
-						if ( $line_item_id === 'taxable' ) {
1425
+						if ($line_item_id === 'taxable') {
1426 1426
 							continue;
1427 1427
 						}
1428
-						$taxable_total = $running_totals[ 'taxable' ][ $line_item_id ];
1429
-						$running_totals[ $line_item_id ] += ( $taxable_total * $tax_percent_decimal );
1428
+						$taxable_total = $running_totals['taxable'][$line_item_id];
1429
+						$running_totals[$line_item_id] += ($taxable_total * $tax_percent_decimal);
1430 1430
 					}
1431 1431
 					break;
1432 1432
 
1433 1433
 				case EEM_Line_Item::type_line_item :
1434 1434
 
1435 1435
 					// ticket line items or ????
1436
-					if ( $child_line_item->OBJ_type() === 'Ticket' ) {
1436
+					if ($child_line_item->OBJ_type() === 'Ticket') {
1437 1437
 						// kk it's a ticket
1438
-						if ( isset( $running_totals[ $child_line_item->ID() ] ) ) {
1438
+						if (isset($running_totals[$child_line_item->ID()])) {
1439 1439
 							//huh? that shouldn't happen.
1440
-							$running_totals[ 'total' ] += $child_line_item->total();
1440
+							$running_totals['total'] += $child_line_item->total();
1441 1441
 						} else {
1442 1442
 							//its not in our running totals yet. great.
1443
-							if ( $child_line_item->is_taxable() ) {
1443
+							if ($child_line_item->is_taxable()) {
1444 1444
 								$taxable_amount = $child_line_item->unit_price();
1445 1445
 							} else {
1446 1446
 								$taxable_amount = 0;
1447 1447
 							}
1448 1448
 							// are we only calculating totals for some tickets?
1449
-							if ( isset( $billable_ticket_quantities[ $child_line_item->OBJ_ID() ] ) ) {
1450
-								$quantity = $billable_ticket_quantities[ $child_line_item->OBJ_ID() ];
1451
-								$running_totals[ $child_line_item->ID() ] = $quantity
1449
+							if (isset($billable_ticket_quantities[$child_line_item->OBJ_ID()])) {
1450
+								$quantity = $billable_ticket_quantities[$child_line_item->OBJ_ID()];
1451
+								$running_totals[$child_line_item->ID()] = $quantity
1452 1452
 									? $child_line_item->unit_price()
1453 1453
 									: 0;
1454
-								$running_totals[ 'taxable' ][ $child_line_item->ID() ] = $quantity
1454
+								$running_totals['taxable'][$child_line_item->ID()] = $quantity
1455 1455
 									? $taxable_amount
1456 1456
 									: 0;
1457 1457
 							} else {
1458 1458
 								$quantity = $child_line_item->quantity();
1459
-								$running_totals[ $child_line_item->ID() ] = $child_line_item->unit_price();
1460
-								$running_totals[ 'taxable' ][ $child_line_item->ID() ] = $taxable_amount;
1459
+								$running_totals[$child_line_item->ID()] = $child_line_item->unit_price();
1460
+								$running_totals['taxable'][$child_line_item->ID()] = $taxable_amount;
1461 1461
 							}
1462
-							$running_totals[ 'taxable' ][ 'total' ] += $taxable_amount * $quantity;
1463
-							$running_totals[ 'total' ] += $child_line_item->unit_price() * $quantity;
1462
+							$running_totals['taxable']['total'] += $taxable_amount * $quantity;
1463
+							$running_totals['total'] += $child_line_item->unit_price() * $quantity;
1464 1464
 						}
1465 1465
 					} else {
1466 1466
 						// it's some other type of item added to the cart
1467 1467
 						// it should affect the running totals
1468 1468
 						// basically we want to convert it into a PERCENT modifier. Because
1469 1469
 						// more clearly affect all registration's final price equally
1470
-						$line_items_percent_of_running_total = $running_totals[ 'total' ] > 0
1471
-							? ( $child_line_item->total() / $running_totals[ 'total' ] ) + 1
1470
+						$line_items_percent_of_running_total = $running_totals['total'] > 0
1471
+							? ($child_line_item->total() / $running_totals['total']) + 1
1472 1472
 							: 1;
1473
-						foreach ( $running_totals as $line_item_id => $this_running_total ) {
1473
+						foreach ($running_totals as $line_item_id => $this_running_total) {
1474 1474
 							//the "taxable" array key is an exception
1475
-							if ( $line_item_id === 'taxable' ) {
1475
+							if ($line_item_id === 'taxable') {
1476 1476
 								continue;
1477 1477
 							}
1478 1478
 							// update the running totals
1479 1479
 							// yes this actually even works for the running grand total!
1480
-							$running_totals[ $line_item_id ] =
1480
+							$running_totals[$line_item_id] =
1481 1481
 								$line_items_percent_of_running_total * $this_running_total;
1482 1482
 
1483
-							if ( $child_line_item->is_taxable() ) {
1484
-								$running_totals[ 'taxable' ][ $line_item_id ] =
1485
-									$line_items_percent_of_running_total * $running_totals[ 'taxable' ][ $line_item_id ];
1483
+							if ($child_line_item->is_taxable()) {
1484
+								$running_totals['taxable'][$line_item_id] =
1485
+									$line_items_percent_of_running_total * $running_totals['taxable'][$line_item_id];
1486 1486
 							}
1487 1487
 						}
1488 1488
 					}
@@ -1500,16 +1500,16 @@  discard block
 block discarded – undo
1500 1500
 	 * @return float | null
1501 1501
 	 * @throws \OutOfRangeException
1502 1502
 	 */
1503
-	public static function calculate_final_price_for_ticket_line_item( \EE_Line_Item $total_line_item, \EE_Line_Item $ticket_line_item ) {
1503
+	public static function calculate_final_price_for_ticket_line_item(\EE_Line_Item $total_line_item, \EE_Line_Item $ticket_line_item) {
1504 1504
 		static $final_prices_per_ticket_line_item = array();
1505
-		if ( empty( $final_prices_per_ticket_line_item ) ) {
1505
+		if (empty($final_prices_per_ticket_line_item)) {
1506 1506
 			$final_prices_per_ticket_line_item = \EEH_Line_Item::calculate_reg_final_prices_per_line_item(
1507 1507
 				$total_line_item
1508 1508
 			);
1509 1509
 		}
1510 1510
 		//ok now find this new registration's final price
1511
-		if ( isset( $final_prices_per_ticket_line_item[ $ticket_line_item->ID() ] ) ) {
1512
-			return $final_prices_per_ticket_line_item[ $ticket_line_item->ID() ];
1511
+		if (isset($final_prices_per_ticket_line_item[$ticket_line_item->ID()])) {
1512
+			return $final_prices_per_ticket_line_item[$ticket_line_item->ID()];
1513 1513
 		}
1514 1514
 		$message = sprintf(
1515 1515
 			__(
@@ -1518,11 +1518,11 @@  discard block
 block discarded – undo
1518 1518
 			),
1519 1519
 			$ticket_line_item->ID()
1520 1520
 		);
1521
-		if ( WP_DEBUG ) {
1522
-			$message .= '<br>' . print_r( $final_prices_per_ticket_line_item, true );
1523
-			throw new \OutOfRangeException( $message );
1521
+		if (WP_DEBUG) {
1522
+			$message .= '<br>'.print_r($final_prices_per_ticket_line_item, true);
1523
+			throw new \OutOfRangeException($message);
1524 1524
 		} else {
1525
-			EE_Log::instance()->log( __CLASS__, __FUNCTION__, $message );
1525
+			EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message);
1526 1526
 		}
1527 1527
 		return null;
1528 1528
 	}
@@ -1538,15 +1538,15 @@  discard block
 block discarded – undo
1538 1538
 	 * @return \EE_Line_Item
1539 1539
 	 * @throws \EE_Error
1540 1540
 	 */
1541
-	public static function billable_line_item_tree( EE_Line_Item $line_item, $registrations ) {
1542
-		$copy_li = EEH_Line_Item::billable_line_item( $line_item, $registrations );
1543
-		foreach ( $line_item->children() as $child_li ) {
1544
-			$copy_li->add_child_line_item( EEH_Line_Item::billable_line_item_tree( $child_li, $registrations ) );
1541
+	public static function billable_line_item_tree(EE_Line_Item $line_item, $registrations) {
1542
+		$copy_li = EEH_Line_Item::billable_line_item($line_item, $registrations);
1543
+		foreach ($line_item->children() as $child_li) {
1544
+			$copy_li->add_child_line_item(EEH_Line_Item::billable_line_item_tree($child_li, $registrations));
1545 1545
 		}
1546 1546
 		//if this is the grand total line item, make sure the totals all add up
1547 1547
 		//(we could have duplicated this logic AS we copied the line items, but
1548 1548
 		//it seems DRYer this way)
1549
-		if ( $copy_li->type() === EEM_Line_Item::type_total ) {
1549
+		if ($copy_li->type() === EEM_Line_Item::type_total) {
1550 1550
 			$copy_li->recalculate_total_including_taxes();
1551 1551
 		}
1552 1552
 		return $copy_li;
@@ -1563,24 +1563,24 @@  discard block
 block discarded – undo
1563 1563
 	 * @throws \EE_Error
1564 1564
 	 * @param EE_Registration[] $registrations
1565 1565
 	 */
1566
-	public static function billable_line_item( EE_Line_Item $line_item, $registrations ) {
1566
+	public static function billable_line_item(EE_Line_Item $line_item, $registrations) {
1567 1567
 		$new_li_fields = $line_item->model_field_array();
1568
-		if ( $line_item->type() === EEM_Line_Item::type_line_item &&
1568
+		if ($line_item->type() === EEM_Line_Item::type_line_item &&
1569 1569
 			$line_item->OBJ_type() === 'Ticket'
1570 1570
 		) {
1571 1571
 			$count = 0;
1572
-			foreach ( $registrations as $registration ) {
1573
-				if ( $line_item->OBJ_ID() === $registration->ticket_ID() &&
1574
-					in_array( $registration->status_ID(), EEM_Registration::reg_statuses_that_allow_payment() )
1572
+			foreach ($registrations as $registration) {
1573
+				if ($line_item->OBJ_ID() === $registration->ticket_ID() &&
1574
+					in_array($registration->status_ID(), EEM_Registration::reg_statuses_that_allow_payment())
1575 1575
 				) {
1576 1576
 					$count++;
1577 1577
 				}
1578 1578
 			}
1579
-			$new_li_fields[ 'LIN_quantity' ] = $count;
1579
+			$new_li_fields['LIN_quantity'] = $count;
1580 1580
 		}
1581 1581
 		//don't set the total. We'll leave that up to the code that calculates it
1582
-		unset( $new_li_fields[ 'LIN_ID' ], $new_li_fields[ 'LIN_parent' ], $new_li_fields[ 'LIN_total' ] );
1583
-		return EE_Line_Item::new_instance( $new_li_fields );
1582
+		unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent'], $new_li_fields['LIN_total']);
1583
+		return EE_Line_Item::new_instance($new_li_fields);
1584 1584
 	}
1585 1585
 
1586 1586
 
@@ -1593,19 +1593,19 @@  discard block
 block discarded – undo
1593 1593
 	 * @return \EE_Line_Item|null
1594 1594
 	 * @throws \EE_Error
1595 1595
 	 */
1596
-	public static function non_empty_line_items( EE_Line_Item $line_item ) {
1597
-		$copied_li = EEH_Line_Item::non_empty_line_item( $line_item );
1598
-		if ( $copied_li === null ) {
1596
+	public static function non_empty_line_items(EE_Line_Item $line_item) {
1597
+		$copied_li = EEH_Line_Item::non_empty_line_item($line_item);
1598
+		if ($copied_li === null) {
1599 1599
 			return null;
1600 1600
 		}
1601 1601
 		//if this is an event subtotal, we want to only include it if it
1602 1602
 		//has a non-zero total and at least one ticket line item child
1603 1603
 		$ticket_children = 0;
1604
-		foreach ( $line_item->children() as $child_li ) {
1605
-			$child_li_copy = EEH_Line_Item::non_empty_line_items( $child_li );
1606
-			if ( $child_li_copy !== null ) {
1607
-				$copied_li->add_child_line_item( $child_li_copy );
1608
-				if ( $child_li_copy->type() === EEM_Line_Item::type_line_item &&
1604
+		foreach ($line_item->children() as $child_li) {
1605
+			$child_li_copy = EEH_Line_Item::non_empty_line_items($child_li);
1606
+			if ($child_li_copy !== null) {
1607
+				$copied_li->add_child_line_item($child_li_copy);
1608
+				if ($child_li_copy->type() === EEM_Line_Item::type_line_item &&
1609 1609
 					$child_li_copy->OBJ_type() === 'Ticket'
1610 1610
 				) {
1611 1611
 					$ticket_children++;
@@ -1635,8 +1635,8 @@  discard block
 block discarded – undo
1635 1635
 	 * @return EE_Line_Item
1636 1636
 	 * @throws \EE_Error
1637 1637
 	 */
1638
-	public static function non_empty_line_item( EE_Line_Item $line_item ) {
1639
-		if ( $line_item->type() === EEM_Line_Item::type_line_item &&
1638
+	public static function non_empty_line_item(EE_Line_Item $line_item) {
1639
+		if ($line_item->type() === EEM_Line_Item::type_line_item &&
1640 1640
 			$line_item->OBJ_type() === 'Ticket' &&
1641 1641
 			$line_item->quantity() === 0
1642 1642
 		) {
@@ -1644,8 +1644,8 @@  discard block
 block discarded – undo
1644 1644
 		}
1645 1645
 		$new_li_fields = $line_item->model_field_array();
1646 1646
 		//don't set the total. We'll leave that up to the code that calculates it
1647
-		unset( $new_li_fields[ 'LIN_ID' ], $new_li_fields[ 'LIN_parent' ] );
1648
-		return EE_Line_Item::new_instance( $new_li_fields );
1647
+		unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent']);
1648
+		return EE_Line_Item::new_instance($new_li_fields);
1649 1649
 	}
1650 1650
 
1651 1651
 
@@ -1657,9 +1657,9 @@  discard block
 block discarded – undo
1657 1657
 	 * @return \EE_Line_Item
1658 1658
 	 * @throws \EE_Error
1659 1659
 	 */
1660
-	public static function get_items_subtotal( EE_Line_Item $total_line_item ){
1661
-		EE_Error::doing_it_wrong( 'EEH_Line_Item::get_items_subtotal()', __('Method replaced with EEH_Line_Item::get_pre_tax_subtotal()', 'event_espresso'), '4.6.0' );
1662
-		return self::get_pre_tax_subtotal( $total_line_item );
1660
+	public static function get_items_subtotal(EE_Line_Item $total_line_item) {
1661
+		EE_Error::doing_it_wrong('EEH_Line_Item::get_items_subtotal()', __('Method replaced with EEH_Line_Item::get_pre_tax_subtotal()', 'event_espresso'), '4.6.0');
1662
+		return self::get_pre_tax_subtotal($total_line_item);
1663 1663
 	}
1664 1664
 
1665 1665
 
@@ -1670,9 +1670,9 @@  discard block
 block discarded – undo
1670 1670
 	 * @return \EE_Line_Item
1671 1671
 	 * @throws \EE_Error
1672 1672
 	 */
1673
-	public static function create_default_total_line_item( $transaction = NULL) {
1674
-		EE_Error::doing_it_wrong( 'EEH_Line_Item::create_default_total_line_item()', __('Method replaced with EEH_Line_Item::create_total_line_item()', 'event_espresso'), '4.6.0' );
1675
-		return self::create_total_line_item( $transaction );
1673
+	public static function create_default_total_line_item($transaction = NULL) {
1674
+		EE_Error::doing_it_wrong('EEH_Line_Item::create_default_total_line_item()', __('Method replaced with EEH_Line_Item::create_total_line_item()', 'event_espresso'), '4.6.0');
1675
+		return self::create_total_line_item($transaction);
1676 1676
 	}
1677 1677
 
1678 1678
 
@@ -1684,9 +1684,9 @@  discard block
 block discarded – undo
1684 1684
 	 * @return \EE_Line_Item
1685 1685
 	 * @throws \EE_Error
1686 1686
 	 */
1687
-	public static function create_default_tickets_subtotal( EE_Line_Item $total_line_item, $transaction = NULL) {
1688
-		EE_Error::doing_it_wrong( 'EEH_Line_Item::create_default_tickets_subtotal()', __('Method replaced with EEH_Line_Item::create_pre_tax_subtotal()', 'event_espresso'), '4.6.0' );
1689
-		return self::create_pre_tax_subtotal( $total_line_item, $transaction );
1687
+	public static function create_default_tickets_subtotal(EE_Line_Item $total_line_item, $transaction = NULL) {
1688
+		EE_Error::doing_it_wrong('EEH_Line_Item::create_default_tickets_subtotal()', __('Method replaced with EEH_Line_Item::create_pre_tax_subtotal()', 'event_espresso'), '4.6.0');
1689
+		return self::create_pre_tax_subtotal($total_line_item, $transaction);
1690 1690
 	}
1691 1691
 
1692 1692
 
@@ -1698,9 +1698,9 @@  discard block
 block discarded – undo
1698 1698
 	 * @return \EE_Line_Item
1699 1699
 	 * @throws \EE_Error
1700 1700
 	 */
1701
-	public static function create_default_taxes_subtotal( EE_Line_Item $total_line_item, $transaction = NULL) {
1702
-		EE_Error::doing_it_wrong( 'EEH_Line_Item::create_default_taxes_subtotal()', __('Method replaced with EEH_Line_Item::create_taxes_subtotal()', 'event_espresso'), '4.6.0' );
1703
-		return self::create_taxes_subtotal( $total_line_item, $transaction );
1701
+	public static function create_default_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = NULL) {
1702
+		EE_Error::doing_it_wrong('EEH_Line_Item::create_default_taxes_subtotal()', __('Method replaced with EEH_Line_Item::create_taxes_subtotal()', 'event_espresso'), '4.6.0');
1703
+		return self::create_taxes_subtotal($total_line_item, $transaction);
1704 1704
 	}
1705 1705
 
1706 1706
 
@@ -1712,9 +1712,9 @@  discard block
 block discarded – undo
1712 1712
 	 * @return \EE_Line_Item
1713 1713
 	 * @throws \EE_Error
1714 1714
 	 */
1715
-	public static function create_default_event_subtotal( EE_Line_Item $total_line_item, $transaction = NULL) {
1716
-		EE_Error::doing_it_wrong( 'EEH_Line_Item::create_default_event_subtotal()', __('Method replaced with EEH_Line_Item::create_event_subtotal()', 'event_espresso'), '4.6.0' );
1717
-		return self::create_event_subtotal( $total_line_item, $transaction );
1715
+	public static function create_default_event_subtotal(EE_Line_Item $total_line_item, $transaction = NULL) {
1716
+		EE_Error::doing_it_wrong('EEH_Line_Item::create_default_event_subtotal()', __('Method replaced with EEH_Line_Item::create_event_subtotal()', 'event_espresso'), '4.6.0');
1717
+		return self::create_event_subtotal($total_line_item, $transaction);
1718 1718
 	}
1719 1719
 
1720 1720
 
Please login to merge, or discard this patch.
core/db_models/EEM_Base.model.php 2 patches
Spacing   +155 added lines, -155 removed lines patch added patch discarded remove patch
@@ -516,8 +516,8 @@  discard block
 block discarded – undo
516 516
     protected function __construct($timezone = null)
517 517
     {
518 518
         // check that the model has not been loaded too soon
519
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
520
-            throw new EE_Error (
519
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')) {
520
+            throw new EE_Error(
521 521
                 sprintf(
522 522
                     __('The %1$s model can not be loaded before the "AHEE__EE_System__load_espresso_addons" hook has been called. This gives other addons a chance to extend this model.',
523 523
                         'event_espresso'),
@@ -537,7 +537,7 @@  discard block
 block discarded – undo
537 537
          *
538 538
          * @var EE_Table_Base[] $_tables
539 539
          */
540
-        $this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
540
+        $this->_tables = apply_filters('FHEE__'.get_class($this).'__construct__tables', $this->_tables);
541 541
         foreach ($this->_tables as $table_alias => $table_obj) {
542 542
             /** @var $table_obj EE_Table_Base */
543 543
             $table_obj->_construct_finalize_with_alias($table_alias);
@@ -552,10 +552,10 @@  discard block
 block discarded – undo
552 552
          *
553 553
          * @param EE_Model_Field_Base[] $_fields
554 554
          */
555
-        $this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
555
+        $this->_fields = apply_filters('FHEE__'.get_class($this).'__construct__fields', $this->_fields);
556 556
         $this->_invalidate_field_caches();
557 557
         foreach ($this->_fields as $table_alias => $fields_for_table) {
558
-            if (! array_key_exists($table_alias, $this->_tables)) {
558
+            if ( ! array_key_exists($table_alias, $this->_tables)) {
559 559
                 throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
560 560
                     'event_espresso'), $table_alias, implode(",", $this->_fields)));
561 561
             }
@@ -583,7 +583,7 @@  discard block
 block discarded – undo
583 583
          *
584 584
          * @param EE_Model_Relation_Base[] $_model_relations
585 585
          */
586
-        $this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
586
+        $this->_model_relations = apply_filters('FHEE__'.get_class($this).'__construct__model_relations',
587 587
             $this->_model_relations);
588 588
         foreach ($this->_model_relations as $model_name => $relation_obj) {
589 589
             /** @var $relation_obj EE_Model_Relation_Base */
@@ -595,12 +595,12 @@  discard block
 block discarded – undo
595 595
         }
596 596
         $this->set_timezone($timezone);
597 597
         //finalize default where condition strategy, or set default
598
-        if (! $this->_default_where_conditions_strategy) {
598
+        if ( ! $this->_default_where_conditions_strategy) {
599 599
             //nothing was set during child constructor, so set default
600 600
             $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
601 601
         }
602 602
         $this->_default_where_conditions_strategy->_finalize_construct($this);
603
-        if (! $this->_minimum_where_conditions_strategy) {
603
+        if ( ! $this->_minimum_where_conditions_strategy) {
604 604
             //nothing was set during child constructor, so set default
605 605
             $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
606 606
         }
@@ -613,7 +613,7 @@  discard block
 block discarded – undo
613 613
         //initialize the standard cap restriction generators if none were specified by the child constructor
614 614
         if ($this->_cap_restriction_generators !== false) {
615 615
             foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
616
-                if (! isset($this->_cap_restriction_generators[$cap_context])) {
616
+                if ( ! isset($this->_cap_restriction_generators[$cap_context])) {
617 617
                     $this->_cap_restriction_generators[$cap_context] = apply_filters(
618 618
                         'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
619 619
                         new EE_Restriction_Generator_Protected(),
@@ -626,10 +626,10 @@  discard block
 block discarded – undo
626 626
         //if there are cap restriction generators, use them to make the default cap restrictions
627 627
         if ($this->_cap_restriction_generators !== false) {
628 628
             foreach ($this->_cap_restriction_generators as $context => $generator_object) {
629
-                if (! $generator_object) {
629
+                if ( ! $generator_object) {
630 630
                     continue;
631 631
                 }
632
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
632
+                if ( ! $generator_object instanceof EE_Restriction_Generator_Base) {
633 633
                     throw new EE_Error(
634 634
                         sprintf(
635 635
                             __('Index "%1$s" in the model %2$s\'s _cap_restriction_generators is not a child of EE_Restriction_Generator_Base. It should be that or NULL.',
@@ -640,12 +640,12 @@  discard block
 block discarded – undo
640 640
                     );
641 641
                 }
642 642
                 $action = $this->cap_action_for_context($context);
643
-                if (! $generator_object->construction_finalized()) {
643
+                if ( ! $generator_object->construction_finalized()) {
644 644
                     $generator_object->_construct_finalize($this, $action);
645 645
                 }
646 646
             }
647 647
         }
648
-        do_action('AHEE__' . get_class($this) . '__construct__end');
648
+        do_action('AHEE__'.get_class($this).'__construct__end');
649 649
     }
650 650
 
651 651
 
@@ -680,7 +680,7 @@  discard block
 block discarded – undo
680 680
      */
681 681
     public static function set_model_query_blog_id($blog_id = 0)
682 682
     {
683
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
683
+        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int) $blog_id : get_current_blog_id();
684 684
     }
685 685
 
686 686
 
@@ -710,7 +710,7 @@  discard block
 block discarded – undo
710 710
     public static function instance($timezone = null)
711 711
     {
712 712
         // check if instance of Espresso_model already exists
713
-        if (! static::$_instance instanceof static) {
713
+        if ( ! static::$_instance instanceof static) {
714 714
             // instantiate Espresso_model
715 715
             static::$_instance = new static($timezone);
716 716
         }
@@ -741,7 +741,7 @@  discard block
 block discarded – undo
741 741
             foreach ($r->getDefaultProperties() as $property => $value) {
742 742
                 //don't set instance to null like it was originally,
743 743
                 //but it's static anyways, and we're ignoring static properties (for now at least)
744
-                if (! isset($static_properties[$property])) {
744
+                if ( ! isset($static_properties[$property])) {
745 745
                     static::$_instance->{$property} = $value;
746 746
                 }
747 747
             }
@@ -764,7 +764,7 @@  discard block
 block discarded – undo
764 764
      */
765 765
     public function status_array($translated = false)
766 766
     {
767
-        if (! array_key_exists('Status', $this->_model_relations)) {
767
+        if ( ! array_key_exists('Status', $this->_model_relations)) {
768 768
             return array();
769 769
         }
770 770
         $model_name = $this->get_this_model_name();
@@ -967,17 +967,17 @@  discard block
 block discarded – undo
967 967
     public function wp_user_field_name()
968 968
     {
969 969
         try {
970
-            if (! empty($this->_model_chain_to_wp_user)) {
970
+            if ( ! empty($this->_model_chain_to_wp_user)) {
971 971
                 $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
972 972
                 $last_model_name = end($models_to_follow_to_wp_users);
973 973
                 $model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
974
-                $model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
974
+                $model_chain_to_wp_user = $this->_model_chain_to_wp_user.'.';
975 975
             } else {
976 976
                 $model_with_fk_to_wp_users = $this;
977 977
                 $model_chain_to_wp_user = '';
978 978
             }
979 979
             $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
980
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
980
+            return $model_chain_to_wp_user.$wp_user_field->get_name();
981 981
         } catch (EE_Error $e) {
982 982
             return false;
983 983
         }
@@ -1049,12 +1049,12 @@  discard block
 block discarded – undo
1049 1049
         // remember the custom selections, if any, and type cast as array
1050 1050
         // (unless $columns_to_select is an object, then just set as an empty array)
1051 1051
         // Note: (array) 'some string' === array( 'some string' )
1052
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1052
+        $this->_custom_selections = ! is_object($columns_to_select) ? (array) $columns_to_select : array();
1053 1053
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
1054 1054
         $select_expressions = $columns_to_select !== null
1055 1055
             ? $this->_construct_select_from_input($columns_to_select)
1056 1056
             : $this->_construct_default_select_sql($model_query_info);
1057
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1057
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
1058 1058
         return $this->_do_wpdb_query('get_results', array($SQL, $output));
1059 1059
     }
1060 1060
 
@@ -1099,7 +1099,7 @@  discard block
 block discarded – undo
1099 1099
         if (is_array($columns_to_select)) {
1100 1100
             $select_sql_array = array();
1101 1101
             foreach ($columns_to_select as $alias => $selection_and_datatype) {
1102
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1102
+                if ( ! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1103 1103
                     throw new EE_Error(
1104 1104
                         sprintf(
1105 1105
                             __(
@@ -1111,7 +1111,7 @@  discard block
 block discarded – undo
1111 1111
                         )
1112 1112
                     );
1113 1113
                 }
1114
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1114
+                if ( ! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1115 1115
                     throw new EE_Error(
1116 1116
                         sprintf(
1117 1117
                             __(
@@ -1183,7 +1183,7 @@  discard block
 block discarded – undo
1183 1183
      */
1184 1184
     public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1185 1185
     {
1186
-        if (! isset($query_params[0])) {
1186
+        if ( ! isset($query_params[0])) {
1187 1187
             $query_params[0] = array();
1188 1188
         }
1189 1189
         $conditions_from_id = $this->parse_index_primary_key_string($id);
@@ -1208,7 +1208,7 @@  discard block
 block discarded – undo
1208 1208
      */
1209 1209
     public function get_one($query_params = array())
1210 1210
     {
1211
-        if (! is_array($query_params)) {
1211
+        if ( ! is_array($query_params)) {
1212 1212
             EE_Error::doing_it_wrong('EEM_Base::get_one',
1213 1213
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1214 1214
                     gettype($query_params)), '4.6.0');
@@ -1376,7 +1376,7 @@  discard block
 block discarded – undo
1376 1376
                 return array();
1377 1377
             }
1378 1378
         }
1379
-        if (! is_array($query_params)) {
1379
+        if ( ! is_array($query_params)) {
1380 1380
             EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1381 1381
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1382 1382
                     gettype($query_params)), '4.6.0');
@@ -1386,7 +1386,7 @@  discard block
 block discarded – undo
1386 1386
         $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1387 1387
         $query_params['limit'] = $limit;
1388 1388
         //set direction
1389
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1389
+        $incoming_orderby = isset($query_params['order_by']) ? (array) $query_params['order_by'] : array();
1390 1390
         $query_params['order_by'] = $operand === '>'
1391 1391
             ? array($field_to_order_by => 'ASC') + $incoming_orderby
1392 1392
             : array($field_to_order_by => 'DESC') + $incoming_orderby;
@@ -1465,7 +1465,7 @@  discard block
 block discarded – undo
1465 1465
     {
1466 1466
         $field_settings = $this->field_settings_for($field_name);
1467 1467
         //if not a valid EE_Datetime_Field then throw error
1468
-        if (! $field_settings instanceof EE_Datetime_Field) {
1468
+        if ( ! $field_settings instanceof EE_Datetime_Field) {
1469 1469
             throw new EE_Error(sprintf(__('The field sent into EEM_Base::get_formats_for (%s) is not registered as a EE_Datetime_Field. Please check the spelling and make sure you are submitting the right field name to retrieve date_formats for.',
1470 1470
                 'event_espresso'), $field_name));
1471 1471
         }
@@ -1542,7 +1542,7 @@  discard block
 block discarded – undo
1542 1542
         //load EEH_DTT_Helper
1543 1543
         $set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1544 1544
         $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1545
-        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1545
+        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime($incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)));
1546 1546
     }
1547 1547
 
1548 1548
 
@@ -1610,7 +1610,7 @@  discard block
 block discarded – undo
1610 1610
      */
1611 1611
     public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1612 1612
     {
1613
-        if (! is_array($query_params)) {
1613
+        if ( ! is_array($query_params)) {
1614 1614
             EE_Error::doing_it_wrong('EEM_Base::update',
1615 1615
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1616 1616
                     gettype($query_params)), '4.6.0');
@@ -1632,7 +1632,7 @@  discard block
 block discarded – undo
1632 1632
          * @param EEM_Base $model           the model being queried
1633 1633
          * @param array    $query_params    see EEM_Base::get_all()
1634 1634
          */
1635
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1635
+        $fields_n_values = (array) apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1636 1636
             $query_params);
1637 1637
         //need to verify that, for any entry we want to update, there are entries in each secondary table.
1638 1638
         //to do that, for each table, verify that it's PK isn't null.
@@ -1646,7 +1646,7 @@  discard block
 block discarded – undo
1646 1646
         $wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1647 1647
         foreach ($wpdb_select_results as $wpdb_result) {
1648 1648
             // type cast stdClass as array
1649
-            $wpdb_result = (array)$wpdb_result;
1649
+            $wpdb_result = (array) $wpdb_result;
1650 1650
             //get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1651 1651
             if ($this->has_primary_key_field()) {
1652 1652
                 $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
@@ -1663,13 +1663,13 @@  discard block
 block discarded – undo
1663 1663
                     $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1664 1664
                     //if there is no private key for this table on the results, it means there's no entry
1665 1665
                     //in this table, right? so insert a row in the current table, using any fields available
1666
-                    if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1666
+                    if ( ! (array_key_exists($this_table_pk_column, $wpdb_result)
1667 1667
                            && $wpdb_result[$this_table_pk_column])
1668 1668
                     ) {
1669 1669
                         $success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1670 1670
                             $main_table_pk_value);
1671 1671
                         //if we died here, report the error
1672
-                        if (! $success) {
1672
+                        if ( ! $success) {
1673 1673
                             return false;
1674 1674
                         }
1675 1675
                     }
@@ -1700,7 +1700,7 @@  discard block
 block discarded – undo
1700 1700
                     $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1701 1701
                 }
1702 1702
             }
1703
-            if (! $model_objs_affected_ids) {
1703
+            if ( ! $model_objs_affected_ids) {
1704 1704
                 //wait wait wait- if nothing was affected let's stop here
1705 1705
                 return 0;
1706 1706
             }
@@ -1727,7 +1727,7 @@  discard block
 block discarded – undo
1727 1727
                . $model_query_info->get_full_join_sql()
1728 1728
                . " SET "
1729 1729
                . $this->_construct_update_sql($fields_n_values)
1730
-               . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1730
+               . $model_query_info->get_where_sql(); //note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1731 1731
         $rows_affected = $this->_do_wpdb_query('query', array($SQL));
1732 1732
         /**
1733 1733
          * Action called after a model update call has been made.
@@ -1738,7 +1738,7 @@  discard block
 block discarded – undo
1738 1738
          * @param int      $rows_affected
1739 1739
          */
1740 1740
         do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1741
-        return $rows_affected;//how many supposedly got updated
1741
+        return $rows_affected; //how many supposedly got updated
1742 1742
     }
1743 1743
 
1744 1744
 
@@ -1766,7 +1766,7 @@  discard block
 block discarded – undo
1766 1766
         }
1767 1767
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
1768 1768
         $select_expressions = $field->get_qualified_column();
1769
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1769
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
1770 1770
         return $this->_do_wpdb_query('get_col', array($SQL));
1771 1771
     }
1772 1772
 
@@ -1784,7 +1784,7 @@  discard block
 block discarded – undo
1784 1784
     {
1785 1785
         $query_params['limit'] = 1;
1786 1786
         $col = $this->get_col($query_params, $field_to_select);
1787
-        if (! empty($col)) {
1787
+        if ( ! empty($col)) {
1788 1788
             return reset($col);
1789 1789
         } else {
1790 1790
             return null;
@@ -1816,7 +1816,7 @@  discard block
 block discarded – undo
1816 1816
             $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1817 1817
             $value_sql = $prepared_value === null ? 'NULL'
1818 1818
                 : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1819
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1819
+            $cols_n_values[] = $field_obj->get_qualified_column()."=".$value_sql;
1820 1820
         }
1821 1821
         return implode(",", $cols_n_values);
1822 1822
     }
@@ -1948,7 +1948,7 @@  discard block
 block discarded – undo
1948 1948
          * @param int      $rows_deleted
1949 1949
          */
1950 1950
         do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
1951
-        return $rows_deleted;//how many supposedly got deleted
1951
+        return $rows_deleted; //how many supposedly got deleted
1952 1952
     }
1953 1953
 
1954 1954
 
@@ -2041,7 +2041,7 @@  discard block
 block discarded – undo
2041 2041
                     $deletes[$primary_table->get_fully_qualified_pk_column()][] = $delete_object[$primary_table->get_fully_qualified_pk_column()];
2042 2042
                 }
2043 2043
                 //other tables
2044
-                if (! empty($other_tables)) {
2044
+                if ( ! empty($other_tables)) {
2045 2045
                     foreach ($other_tables as $ot) {
2046 2046
                         //first check if we've got the foreign key column here.
2047 2047
                         if (isset($delete_object[$ot->get_fully_qualified_fk_column()])) {
@@ -2064,7 +2064,7 @@  discard block
 block discarded – undo
2064 2064
             foreach ($deletes as $column => $values) {
2065 2065
                 //make sure we have unique $values;
2066 2066
                 $values = array_unique($values);
2067
-                $query[] = $column . ' IN(' . implode(",", $values) . ')';
2067
+                $query[] = $column.' IN('.implode(",", $values).')';
2068 2068
             }
2069 2069
             return ! empty($query) ? implode(' AND ', $query) : '';
2070 2070
         } elseif (count($this->get_combined_primary_key_fields()) > 1) {
@@ -2080,7 +2080,7 @@  discard block
 block discarded – undo
2080 2080
                                                            . $delete_object[$cpk_field->get_qualified_column()];
2081 2081
                     }
2082 2082
                 }
2083
-                $ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
2083
+                $ways_to_identify_a_row[] = "(".implode(" AND ", $values_for_each_cpk_for_a_row).")";
2084 2084
             }
2085 2085
             return implode(" OR ", $ways_to_identify_a_row);
2086 2086
         } else {
@@ -2129,9 +2129,9 @@  discard block
 block discarded – undo
2129 2129
                 $column_to_count = '*';
2130 2130
             }
2131 2131
         }
2132
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2133
-        $SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2134
-        return (int)$this->_do_wpdb_query('get_var', array($SQL));
2132
+        $column_to_count = $distinct ? "DISTINCT ".$column_to_count : $column_to_count;
2133
+        $SQL = "SELECT COUNT(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
2134
+        return (int) $this->_do_wpdb_query('get_var', array($SQL));
2135 2135
     }
2136 2136
 
2137 2137
 
@@ -2153,13 +2153,13 @@  discard block
 block discarded – undo
2153 2153
             $field_obj = $this->get_primary_key_field();
2154 2154
         }
2155 2155
         $column_to_count = $field_obj->get_qualified_column();
2156
-        $SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2156
+        $SQL = "SELECT SUM(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
2157 2157
         $return_value = $this->_do_wpdb_query('get_var', array($SQL));
2158 2158
         $data_type = $field_obj->get_wpdb_data_type();
2159 2159
         if ($data_type === '%d' || $data_type === '%s') {
2160
-            return (float)$return_value;
2160
+            return (float) $return_value;
2161 2161
         } else {//must be %f
2162
-            return (float)$return_value;
2162
+            return (float) $return_value;
2163 2163
         }
2164 2164
     }
2165 2165
 
@@ -2180,13 +2180,13 @@  discard block
 block discarded – undo
2180 2180
         //if we're in maintenance mode level 2, DON'T run any queries
2181 2181
         //because level 2 indicates the database needs updating and
2182 2182
         //is probably out of sync with the code
2183
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2183
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
2184 2184
             throw new EE_Error(sprintf(__("Event Espresso Level 2 Maintenance mode is active. That means EE can not run ANY database queries until the necessary migration scripts have run which will take EE out of maintenance mode level 2. Please inform support of this error.",
2185 2185
                 "event_espresso")));
2186 2186
         }
2187 2187
         /** @type WPDB $wpdb */
2188 2188
         global $wpdb;
2189
-        if (! method_exists($wpdb, $wpdb_method)) {
2189
+        if ( ! method_exists($wpdb, $wpdb_method)) {
2190 2190
             throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2191 2191
                 'event_espresso'), $wpdb_method));
2192 2192
         }
@@ -2198,7 +2198,7 @@  discard block
 block discarded – undo
2198 2198
         $this->show_db_query_if_previously_requested($wpdb->last_query);
2199 2199
         if (WP_DEBUG) {
2200 2200
             $wpdb->show_errors($old_show_errors_value);
2201
-            if (! empty($wpdb->last_error)) {
2201
+            if ( ! empty($wpdb->last_error)) {
2202 2202
                 throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2203 2203
             } elseif ($result === false) {
2204 2204
                 throw new EE_Error(sprintf(__('WPDB Error occurred, but no error message was logged by wpdb! The wpdb method called was "%1$s" and the arguments were "%2$s"',
@@ -2258,7 +2258,7 @@  discard block
 block discarded – undo
2258 2258
                     return $result;
2259 2259
                     break;
2260 2260
             }
2261
-            if (! empty($error_message)) {
2261
+            if ( ! empty($error_message)) {
2262 2262
                 EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2263 2263
                 trigger_error($error_message);
2264 2264
             }
@@ -2334,11 +2334,11 @@  discard block
 block discarded – undo
2334 2334
      */
2335 2335
     private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2336 2336
     {
2337
-        return " FROM " . $model_query_info->get_full_join_sql() .
2338
-               $model_query_info->get_where_sql() .
2339
-               $model_query_info->get_group_by_sql() .
2340
-               $model_query_info->get_having_sql() .
2341
-               $model_query_info->get_order_by_sql() .
2337
+        return " FROM ".$model_query_info->get_full_join_sql().
2338
+               $model_query_info->get_where_sql().
2339
+               $model_query_info->get_group_by_sql().
2340
+               $model_query_info->get_having_sql().
2341
+               $model_query_info->get_order_by_sql().
2342 2342
                $model_query_info->get_limit_sql();
2343 2343
     }
2344 2344
 
@@ -2534,12 +2534,12 @@  discard block
 block discarded – undo
2534 2534
         $related_model = $this->get_related_model_obj($model_name);
2535 2535
         //we're just going to use the query params on the related model's normal get_all query,
2536 2536
         //except add a condition to say to match the current mod
2537
-        if (! isset($query_params['default_where_conditions'])) {
2537
+        if ( ! isset($query_params['default_where_conditions'])) {
2538 2538
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2539 2539
         }
2540 2540
         $this_model_name = $this->get_this_model_name();
2541 2541
         $this_pk_field_name = $this->get_primary_key_field()->get_name();
2542
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2542
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
2543 2543
         return $related_model->count($query_params, $field_to_count, $distinct);
2544 2544
     }
2545 2545
 
@@ -2559,7 +2559,7 @@  discard block
 block discarded – undo
2559 2559
     public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2560 2560
     {
2561 2561
         $related_model = $this->get_related_model_obj($model_name);
2562
-        if (! is_array($query_params)) {
2562
+        if ( ! is_array($query_params)) {
2563 2563
             EE_Error::doing_it_wrong('EEM_Base::sum_related',
2564 2564
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2565 2565
                     gettype($query_params)), '4.6.0');
@@ -2567,12 +2567,12 @@  discard block
 block discarded – undo
2567 2567
         }
2568 2568
         //we're just going to use the query params on the related model's normal get_all query,
2569 2569
         //except add a condition to say to match the current mod
2570
-        if (! isset($query_params['default_where_conditions'])) {
2570
+        if ( ! isset($query_params['default_where_conditions'])) {
2571 2571
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2572 2572
         }
2573 2573
         $this_model_name = $this->get_this_model_name();
2574 2574
         $this_pk_field_name = $this->get_primary_key_field()->get_name();
2575
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2575
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
2576 2576
         return $related_model->sum($query_params, $field_to_sum);
2577 2577
     }
2578 2578
 
@@ -2626,7 +2626,7 @@  discard block
 block discarded – undo
2626 2626
                 $field_with_model_name = $field;
2627 2627
             }
2628 2628
         }
2629
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
2629
+        if ( ! isset($field_with_model_name) || ! $field_with_model_name) {
2630 2630
             throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2631 2631
                 $this->get_this_model_name()));
2632 2632
         }
@@ -2659,7 +2659,7 @@  discard block
 block discarded – undo
2659 2659
          * @param array    $fields_n_values keys are the fields and values are their new values
2660 2660
          * @param EEM_Base $model           the model used
2661 2661
          */
2662
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2662
+        $field_n_values = (array) apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2663 2663
         if ($this->_satisfies_unique_indexes($field_n_values)) {
2664 2664
             $main_table = $this->_get_main_table();
2665 2665
             $new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
@@ -2767,7 +2767,7 @@  discard block
 block discarded – undo
2767 2767
         }
2768 2768
         foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2769 2769
             $uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2770
-            $query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2770
+            $query_params[0]['OR']['AND*'.$unique_index_name] = $uniqueness_where_params;
2771 2771
         }
2772 2772
         //if there is nothing to base this search on, then we shouldn't find anything
2773 2773
         if (empty($query_params)) {
@@ -2854,7 +2854,7 @@  discard block
 block discarded – undo
2854 2854
             //its not the main table, so we should have already saved the main table's PK which we just inserted
2855 2855
             //so add the fk to the main table as a column
2856 2856
             $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2857
-            $format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2857
+            $format_for_insertion[] = '%d'; //yes right now we're only allowing these foreign keys to be INTs
2858 2858
         }
2859 2859
         //insert the new entry
2860 2860
         $result = $this->_do_wpdb_query('insert',
@@ -3060,7 +3060,7 @@  discard block
 block discarded – undo
3060 3060
                     $query_info_carrier,
3061 3061
                     'group_by'
3062 3062
                 );
3063
-            } elseif (! empty ($query_params['group_by'])) {
3063
+            } elseif ( ! empty ($query_params['group_by'])) {
3064 3064
                 $this->_extract_related_model_info_from_query_param(
3065 3065
                     $query_params['group_by'],
3066 3066
                     $query_info_carrier,
@@ -3082,7 +3082,7 @@  discard block
 block discarded – undo
3082 3082
                     $query_info_carrier,
3083 3083
                     'order_by'
3084 3084
                 );
3085
-            } elseif (! empty($query_params['order_by'])) {
3085
+            } elseif ( ! empty($query_params['order_by'])) {
3086 3086
                 $this->_extract_related_model_info_from_query_param(
3087 3087
                     $query_params['order_by'],
3088 3088
                     $query_info_carrier,
@@ -3117,8 +3117,8 @@  discard block
 block discarded – undo
3117 3117
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
3118 3118
         $query_param_type
3119 3119
     ) {
3120
-        if (! empty($sub_query_params)) {
3121
-            $sub_query_params = (array)$sub_query_params;
3120
+        if ( ! empty($sub_query_params)) {
3121
+            $sub_query_params = (array) $sub_query_params;
3122 3122
             foreach ($sub_query_params as $param => $possibly_array_of_params) {
3123 3123
                 //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3124 3124
                 $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
@@ -3129,7 +3129,7 @@  discard block
 block discarded – undo
3129 3129
                 //of array('Registration.TXN_ID'=>23)
3130 3130
                 $query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3131 3131
                 if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3132
-                    if (! is_array($possibly_array_of_params)) {
3132
+                    if ( ! is_array($possibly_array_of_params)) {
3133 3133
                         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'))",
3134 3134
                             "event_espresso"),
3135 3135
                             $param, $possibly_array_of_params));
@@ -3145,7 +3145,7 @@  discard block
 block discarded – undo
3145 3145
                     //then $possible_array_of_params looks something like array('<','DTT_sold',true)
3146 3146
                     //indicating that $possible_array_of_params[1] is actually a field name,
3147 3147
                     //from which we should extract query parameters!
3148
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3148
+                    if ( ! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3149 3149
                         throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3150 3150
                             "event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3151 3151
                     }
@@ -3175,8 +3175,8 @@  discard block
 block discarded – undo
3175 3175
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
3176 3176
         $query_param_type
3177 3177
     ) {
3178
-        if (! empty($sub_query_params)) {
3179
-            if (! is_array($sub_query_params)) {
3178
+        if ( ! empty($sub_query_params)) {
3179
+            if ( ! is_array($sub_query_params)) {
3180 3180
                 throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3181 3181
                     $sub_query_params));
3182 3182
             }
@@ -3205,7 +3205,7 @@  discard block
 block discarded – undo
3205 3205
      */
3206 3206
     public function _create_model_query_info_carrier($query_params)
3207 3207
     {
3208
-        if (! is_array($query_params)) {
3208
+        if ( ! is_array($query_params)) {
3209 3209
             EE_Error::doing_it_wrong(
3210 3210
                 'EEM_Base::_create_model_query_info_carrier',
3211 3211
                 sprintf(
@@ -3281,7 +3281,7 @@  discard block
 block discarded – undo
3281 3281
         //set limit
3282 3282
         if (array_key_exists('limit', $query_params)) {
3283 3283
             if (is_array($query_params['limit'])) {
3284
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3284
+                if ( ! isset($query_params['limit'][0], $query_params['limit'][1])) {
3285 3285
                     $e = sprintf(
3286 3286
                         __(
3287 3287
                             "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)",
@@ -3289,12 +3289,12 @@  discard block
 block discarded – undo
3289 3289
                         ),
3290 3290
                         http_build_query($query_params['limit'])
3291 3291
                     );
3292
-                    throw new EE_Error($e . "|" . $e);
3292
+                    throw new EE_Error($e."|".$e);
3293 3293
                 }
3294 3294
                 //they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3295
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3296
-            } elseif (! empty ($query_params['limit'])) {
3297
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3295
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit'][0].",".$query_params['limit'][1]);
3296
+            } elseif ( ! empty ($query_params['limit'])) {
3297
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit']);
3298 3298
             }
3299 3299
         }
3300 3300
         //set order by
@@ -3326,10 +3326,10 @@  discard block
 block discarded – undo
3326 3326
                 $order_array = array();
3327 3327
                 foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3328 3328
                     $order = $this->_extract_order($order);
3329
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3329
+                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by).SP.$order;
3330 3330
                 }
3331
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3332
-            } elseif (! empty ($query_params['order_by'])) {
3331
+                $query_object->set_order_by_sql(" ORDER BY ".implode(",", $order_array));
3332
+            } elseif ( ! empty ($query_params['order_by'])) {
3333 3333
                 $this->_extract_related_model_info_from_query_param(
3334 3334
                     $query_params['order_by'],
3335 3335
                     $query_object,
@@ -3340,18 +3340,18 @@  discard block
 block discarded – undo
3340 3340
                     ? $this->_extract_order($query_params['order'])
3341 3341
                     : 'DESC';
3342 3342
                 $query_object->set_order_by_sql(
3343
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3343
+                    " ORDER BY ".$this->_deduce_column_name_from_query_param($query_params['order_by']).SP.$order
3344 3344
                 );
3345 3345
             }
3346 3346
         }
3347 3347
         //if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3348
-        if (! array_key_exists('order_by', $query_params)
3348
+        if ( ! array_key_exists('order_by', $query_params)
3349 3349
             && array_key_exists('order', $query_params)
3350 3350
             && ! empty($query_params['order'])
3351 3351
         ) {
3352 3352
             $pk_field = $this->get_primary_key_field();
3353 3353
             $order = $this->_extract_order($query_params['order']);
3354
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3354
+            $query_object->set_order_by_sql(" ORDER BY ".$pk_field->get_qualified_column().SP.$order);
3355 3355
         }
3356 3356
         //set group by
3357 3357
         if (array_key_exists('group_by', $query_params)) {
@@ -3361,10 +3361,10 @@  discard block
 block discarded – undo
3361 3361
                 foreach ($query_params['group_by'] as $field_name_to_group_by) {
3362 3362
                     $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3363 3363
                 }
3364
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3365
-            } elseif (! empty ($query_params['group_by'])) {
3364
+                $query_object->set_group_by_sql(" GROUP BY ".implode(", ", $group_by_array));
3365
+            } elseif ( ! empty ($query_params['group_by'])) {
3366 3366
                 $query_object->set_group_by_sql(
3367
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3367
+                    " GROUP BY ".$this->_deduce_column_name_from_query_param($query_params['group_by'])
3368 3368
                 );
3369 3369
             }
3370 3370
         }
@@ -3374,7 +3374,7 @@  discard block
 block discarded – undo
3374 3374
         }
3375 3375
         //now, just verify they didn't pass anything wack
3376 3376
         foreach ($query_params as $query_key => $query_value) {
3377
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
3377
+            if ( ! in_array($query_key, $this->_allowed_query_params, true)) {
3378 3378
                 throw new EE_Error(
3379 3379
                     sprintf(
3380 3380
                         __(
@@ -3468,22 +3468,22 @@  discard block
 block discarded – undo
3468 3468
         $where_query_params = array()
3469 3469
     ) {
3470 3470
         $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3471
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3471
+        if ( ! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3472 3472
             throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3473 3473
                 "event_espresso"), $use_default_where_conditions,
3474 3474
                 implode(", ", $allowed_used_default_where_conditions_values)));
3475 3475
         }
3476 3476
         $universal_query_params = array();
3477
-        if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3477
+        if ($this->_should_use_default_where_conditions($use_default_where_conditions, true)) {
3478 3478
             $universal_query_params = $this->_get_default_where_conditions();
3479
-        } else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3479
+        } else if ($this->_should_use_minimum_where_conditions($use_default_where_conditions, true)) {
3480 3480
             $universal_query_params = $this->_get_minimum_where_conditions();
3481 3481
         }
3482 3482
         foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3483 3483
             $related_model = $this->get_related_model_obj($model_name);
3484
-            if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3484
+            if ($this->_should_use_default_where_conditions($use_default_where_conditions, false)) {
3485 3485
                 $related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3486
-            } elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3486
+            } elseif ($this->_should_use_minimum_where_conditions($use_default_where_conditions, false)) {
3487 3487
                 $related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3488 3488
             } else {
3489 3489
                 //we don't want to add full or even minimum default where conditions from this model, so just continue
@@ -3516,7 +3516,7 @@  discard block
 block discarded – undo
3516 3516
      * @param bool $for_this_model false means this is for OTHER related models
3517 3517
      * @return bool
3518 3518
      */
3519
-    private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3519
+    private function _should_use_default_where_conditions($default_where_conditions_value, $for_this_model = true)
3520 3520
     {
3521 3521
         return (
3522 3522
                    $for_this_model
@@ -3595,7 +3595,7 @@  discard block
 block discarded – undo
3595 3595
     ) {
3596 3596
         $null_friendly_where_conditions = array();
3597 3597
         $none_overridden = true;
3598
-        $or_condition_key_for_defaults = 'OR*' . get_class($model);
3598
+        $or_condition_key_for_defaults = 'OR*'.get_class($model);
3599 3599
         foreach ($default_where_conditions as $key => $val) {
3600 3600
             if (isset($provided_where_conditions[$key])) {
3601 3601
                 $none_overridden = false;
@@ -3713,7 +3713,7 @@  discard block
 block discarded – undo
3713 3713
             foreach ($tables as $table_obj) {
3714 3714
                 $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3715 3715
                                        . $table_obj->get_fully_qualified_pk_column();
3716
-                if (! in_array($qualified_pk_column, $selects)) {
3716
+                if ( ! in_array($qualified_pk_column, $selects)) {
3717 3717
                     $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3718 3718
                 }
3719 3719
             }
@@ -3799,9 +3799,9 @@  discard block
 block discarded – undo
3799 3799
         //and
3800 3800
         //check if it's a field on a related model
3801 3801
         foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3802
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3802
+            if (strpos($query_param, $valid_related_model_name.".") === 0) {
3803 3803
                 $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3804
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
3804
+                $query_param = substr($query_param, strlen($valid_related_model_name."."));
3805 3805
                 if ($query_param === '') {
3806 3806
                     //nothing left to $query_param
3807 3807
                     //we should actually end in a field name, not a model like this!
@@ -3887,7 +3887,7 @@  discard block
 block discarded – undo
3887 3887
     {
3888 3888
         $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
3889 3889
         if ($SQL) {
3890
-            return " WHERE " . $SQL;
3890
+            return " WHERE ".$SQL;
3891 3891
         } else {
3892 3892
             return '';
3893 3893
         }
@@ -3907,7 +3907,7 @@  discard block
 block discarded – undo
3907 3907
     {
3908 3908
         $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
3909 3909
         if ($SQL) {
3910
-            return " HAVING " . $SQL;
3910
+            return " HAVING ".$SQL;
3911 3911
         } else {
3912 3912
             return '';
3913 3913
         }
@@ -3927,11 +3927,11 @@  discard block
 block discarded – undo
3927 3927
      */
3928 3928
     protected function _get_field_on_model($field_name, $model_name)
3929 3929
     {
3930
-        $model_class = 'EEM_' . $model_name;
3931
-        $model_filepath = $model_class . ".model.php";
3930
+        $model_class = 'EEM_'.$model_name;
3931
+        $model_filepath = $model_class.".model.php";
3932 3932
         if (is_readable($model_filepath)) {
3933 3933
             require_once($model_filepath);
3934
-            $model_instance = call_user_func($model_name . "::instance");
3934
+            $model_instance = call_user_func($model_name."::instance");
3935 3935
             /* @var $model_instance EEM_Base */
3936 3936
             return $model_instance->field_settings_for($field_name);
3937 3937
         } else {
@@ -3955,7 +3955,7 @@  discard block
 block discarded – undo
3955 3955
     {
3956 3956
         $where_clauses = array();
3957 3957
         foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
3958
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
3958
+            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param); //str_replace("*",'',$query_param);
3959 3959
             if (in_array($query_param, $this->_logic_query_param_keys)) {
3960 3960
                 switch ($query_param) {
3961 3961
                     case 'not':
@@ -3983,7 +3983,7 @@  discard block
 block discarded – undo
3983 3983
             } else {
3984 3984
                 $field_obj = $this->_deduce_field_from_query_param($query_param);
3985 3985
                 //if it's not a normal field, maybe it's a custom selection?
3986
-                if (! $field_obj) {
3986
+                if ( ! $field_obj) {
3987 3987
                     if (isset($this->_custom_selections[$query_param][1])) {
3988 3988
                         $field_obj = $this->_custom_selections[$query_param][1];
3989 3989
                     } else {
@@ -3992,7 +3992,7 @@  discard block
 block discarded – undo
3992 3992
                     }
3993 3993
                 }
3994 3994
                 $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
3995
-                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
3995
+                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param).SP.$op_and_value_sql;
3996 3996
             }
3997 3997
         }
3998 3998
         return $where_clauses ? implode($glue, $where_clauses) : '';
@@ -4013,7 +4013,7 @@  discard block
 block discarded – undo
4013 4013
         if ($field) {
4014 4014
             $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4015 4015
                 $query_param);
4016
-            return $table_alias_prefix . $field->get_qualified_column();
4016
+            return $table_alias_prefix.$field->get_qualified_column();
4017 4017
         } elseif (array_key_exists($query_param, $this->_custom_selections)) {
4018 4018
             //maybe it's custom selection item?
4019 4019
             //if so, just use it as the "column name"
@@ -4060,7 +4060,7 @@  discard block
 block discarded – undo
4060 4060
     {
4061 4061
         if (is_array($op_and_value)) {
4062 4062
             $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4063
-            if (! $operator) {
4063
+            if ( ! $operator) {
4064 4064
                 $php_array_like_string = array();
4065 4065
                 foreach ($op_and_value as $key => $value) {
4066 4066
                     $php_array_like_string[] = "$key=>$value";
@@ -4082,13 +4082,13 @@  discard block
 block discarded – undo
4082 4082
         }
4083 4083
         //check to see if the value is actually another field
4084 4084
         if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4085
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4085
+            return $operator.SP.$this->_deduce_column_name_from_query_param($value);
4086 4086
         } elseif (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4087 4087
             //in this case, the value should be an array, or at least a comma-separated list
4088 4088
             //it will need to handle a little differently
4089 4089
             $cleaned_value = $this->_construct_in_value($value, $field_obj);
4090 4090
             //note: $cleaned_value has already been run through $wpdb->prepare()
4091
-            return $operator . SP . $cleaned_value;
4091
+            return $operator.SP.$cleaned_value;
4092 4092
         } elseif (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4093 4093
             //the value should be an array with count of two.
4094 4094
             if (count($value) !== 2) {
@@ -4103,7 +4103,7 @@  discard block
 block discarded – undo
4103 4103
                 );
4104 4104
             }
4105 4105
             $cleaned_value = $this->_construct_between_value($value, $field_obj);
4106
-            return $operator . SP . $cleaned_value;
4106
+            return $operator.SP.$cleaned_value;
4107 4107
         } elseif (in_array($operator, $this->_null_style_operators)) {
4108 4108
             if ($value !== null) {
4109 4109
                 throw new EE_Error(
@@ -4121,9 +4121,9 @@  discard block
 block discarded – undo
4121 4121
         } elseif ($operator === 'LIKE' && ! is_array($value)) {
4122 4122
             //if the operator is 'LIKE', we want to allow percent signs (%) and not
4123 4123
             //remove other junk. So just treat it as a string.
4124
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4125
-        } elseif (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4126
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4124
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, '%s');
4125
+        } elseif ( ! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4126
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, $field_obj);
4127 4127
         } elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4128 4128
             throw new EE_Error(
4129 4129
                 sprintf(
@@ -4135,7 +4135,7 @@  discard block
 block discarded – undo
4135 4135
                     $operator
4136 4136
                 )
4137 4137
             );
4138
-        } elseif (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4138
+        } elseif ( ! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4139 4139
             throw new EE_Error(
4140 4140
                 sprintf(
4141 4141
                     __(
@@ -4176,7 +4176,7 @@  discard block
 block discarded – undo
4176 4176
         foreach ($values as $value) {
4177 4177
             $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4178 4178
         }
4179
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
4179
+        return $cleaned_values[0]." AND ".$cleaned_values[1];
4180 4180
     }
4181 4181
 
4182 4182
 
@@ -4217,7 +4217,7 @@  discard block
 block discarded – undo
4217 4217
                                 . $main_table->get_table_name()
4218 4218
                                 . " WHERE FALSE";
4219 4219
         }
4220
-        return "(" . implode(",", $cleaned_values) . ")";
4220
+        return "(".implode(",", $cleaned_values).")";
4221 4221
     }
4222 4222
 
4223 4223
 
@@ -4236,7 +4236,7 @@  discard block
 block discarded – undo
4236 4236
             return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4237 4237
                 $this->_prepare_value_for_use_in_db($value, $field_obj));
4238 4238
         } else {//$field_obj should really just be a data type
4239
-            if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4239
+            if ( ! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4240 4240
                 throw new EE_Error(sprintf(__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4241 4241
                     $field_obj, implode(",", $this->_valid_wpdb_data_types)));
4242 4242
             }
@@ -4356,10 +4356,10 @@  discard block
 block discarded – undo
4356 4356
      */
4357 4357
     public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4358 4358
     {
4359
-        $table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4359
+        $table_prefix = str_replace('.', '__', $model_relation_chain).(empty($model_relation_chain) ? '' : '__');
4360 4360
         $qualified_columns = array();
4361 4361
         foreach ($this->field_settings() as $field_name => $field) {
4362
-            $qualified_columns[] = $table_prefix . $field->get_qualified_column();
4362
+            $qualified_columns[] = $table_prefix.$field->get_qualified_column();
4363 4363
         }
4364 4364
         return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4365 4365
     }
@@ -4383,11 +4383,11 @@  discard block
 block discarded – undo
4383 4383
             if ($table_obj instanceof EE_Primary_Table) {
4384 4384
                 $SQL .= $table_alias === $table_obj->get_table_alias()
4385 4385
                     ? $table_obj->get_select_join_limit($limit)
4386
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4386
+                    : SP.$table_obj->get_table_name()." AS ".$table_obj->get_table_alias().SP;
4387 4387
             } elseif ($table_obj instanceof EE_Secondary_Table) {
4388 4388
                 $SQL .= $table_alias === $table_obj->get_table_alias()
4389 4389
                     ? $table_obj->get_select_join_limit_join($limit)
4390
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
4390
+                    : SP.$table_obj->get_join_sql($table_alias).SP;
4391 4391
             }
4392 4392
         }
4393 4393
         return $SQL;
@@ -4475,12 +4475,12 @@  discard block
 block discarded – undo
4475 4475
      */
4476 4476
     public function get_related_model_obj($model_name)
4477 4477
     {
4478
-        $model_classname = "EEM_" . $model_name;
4479
-        if (! class_exists($model_classname)) {
4478
+        $model_classname = "EEM_".$model_name;
4479
+        if ( ! class_exists($model_classname)) {
4480 4480
             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",
4481 4481
                 'event_espresso'), $model_name, $model_classname));
4482 4482
         }
4483
-        return call_user_func($model_classname . "::instance");
4483
+        return call_user_func($model_classname."::instance");
4484 4484
     }
4485 4485
 
4486 4486
 
@@ -4527,7 +4527,7 @@  discard block
 block discarded – undo
4527 4527
     public function related_settings_for($relation_name)
4528 4528
     {
4529 4529
         $relatedModels = $this->relation_settings();
4530
-        if (! array_key_exists($relation_name, $relatedModels)) {
4530
+        if ( ! array_key_exists($relation_name, $relatedModels)) {
4531 4531
             throw new EE_Error(
4532 4532
                 sprintf(
4533 4533
                     __('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
@@ -4554,7 +4554,7 @@  discard block
 block discarded – undo
4554 4554
     public function field_settings_for($fieldName)
4555 4555
     {
4556 4556
         $fieldSettings = $this->field_settings(true);
4557
-        if (! array_key_exists($fieldName, $fieldSettings)) {
4557
+        if ( ! array_key_exists($fieldName, $fieldSettings)) {
4558 4558
             throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4559 4559
                 get_class($this)));
4560 4560
         }
@@ -4629,7 +4629,7 @@  discard block
 block discarded – undo
4629 4629
                     break;
4630 4630
                 }
4631 4631
             }
4632
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4632
+            if ( ! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4633 4633
                 throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4634 4634
                     get_class($this)));
4635 4635
             }
@@ -4688,7 +4688,7 @@  discard block
 block discarded – undo
4688 4688
      */
4689 4689
     public function get_foreign_key_to($model_name)
4690 4690
     {
4691
-        if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4691
+        if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4692 4692
             foreach ($this->field_settings() as $field) {
4693 4693
                 if (
4694 4694
                     $field instanceof EE_Foreign_Key_Field_Base
@@ -4698,7 +4698,7 @@  discard block
 block discarded – undo
4698 4698
                     break;
4699 4699
                 }
4700 4700
             }
4701
-            if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4701
+            if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4702 4702
                 throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4703 4703
                     'event_espresso'), $model_name, get_class($this)));
4704 4704
             }
@@ -4749,7 +4749,7 @@  discard block
 block discarded – undo
4749 4749
                 foreach ($this->_fields as $fields_corresponding_to_table) {
4750 4750
                     foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4751 4751
                         /** @var $field_obj EE_Model_Field_Base */
4752
-                        if (! $field_obj->is_db_only_field()) {
4752
+                        if ( ! $field_obj->is_db_only_field()) {
4753 4753
                             $this->_cached_fields_non_db_only[$field_name] = $field_obj;
4754 4754
                         }
4755 4755
                     }
@@ -4779,7 +4779,7 @@  discard block
 block discarded – undo
4779 4779
         $count_if_model_has_no_primary_key = 0;
4780 4780
         $has_primary_key = $this->has_primary_key_field();
4781 4781
         $primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4782
-        foreach ((array)$rows as $row) {
4782
+        foreach ((array) $rows as $row) {
4783 4783
             if (empty($row)) {
4784 4784
                 //wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4785 4785
                 return array();
@@ -4797,7 +4797,7 @@  discard block
 block discarded – undo
4797 4797
                 }
4798 4798
             }
4799 4799
             $classInstance = $this->instantiate_class_from_array_or_object($row);
4800
-            if (! $classInstance) {
4800
+            if ( ! $classInstance) {
4801 4801
                 throw new EE_Error(
4802 4802
                     sprintf(
4803 4803
                         __('Could not create instance of class %s from row %s', 'event_espresso'),
@@ -4866,7 +4866,7 @@  discard block
 block discarded – undo
4866 4866
      */
4867 4867
     public function instantiate_class_from_array_or_object($cols_n_values)
4868 4868
     {
4869
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
4869
+        if ( ! is_array($cols_n_values) && is_object($cols_n_values)) {
4870 4870
             $cols_n_values = get_object_vars($cols_n_values);
4871 4871
         }
4872 4872
         $primary_key = null;
@@ -4891,7 +4891,7 @@  discard block
 block discarded – undo
4891 4891
         // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
4892 4892
         if ($primary_key) {
4893 4893
             $classInstance = $this->get_from_entity_map($primary_key);
4894
-            if (! $classInstance) {
4894
+            if ( ! $classInstance) {
4895 4895
                 $classInstance = EE_Registry::instance()
4896 4896
                                             ->load_class($className,
4897 4897
                                                 array($this_model_fields_n_values, $this->_timezone), true, false);
@@ -4942,12 +4942,12 @@  discard block
 block discarded – undo
4942 4942
     public function add_to_entity_map(EE_Base_Class $object)
4943 4943
     {
4944 4944
         $className = $this->_get_class_name();
4945
-        if (! $object instanceof $className) {
4945
+        if ( ! $object instanceof $className) {
4946 4946
             throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
4947 4947
                 is_object($object) ? get_class($object) : $object, $className));
4948 4948
         }
4949 4949
         /** @var $object EE_Base_Class */
4950
-        if (! $object->ID()) {
4950
+        if ( ! $object->ID()) {
4951 4951
             throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
4952 4952
                 "event_espresso"), get_class($this)));
4953 4953
         }
@@ -5017,7 +5017,7 @@  discard block
 block discarded – undo
5017 5017
             //there is a primary key on this table and its not set. Use defaults for all its columns
5018 5018
             if ($table_pk_value === null && $table_obj->get_pk_column()) {
5019 5019
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5020
-                    if (! $field_obj->is_db_only_field()) {
5020
+                    if ( ! $field_obj->is_db_only_field()) {
5021 5021
                         //prepare field as if its coming from db
5022 5022
                         $prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5023 5023
                         $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
@@ -5026,7 +5026,7 @@  discard block
 block discarded – undo
5026 5026
             } else {
5027 5027
                 //the table's rows existed. Use their values
5028 5028
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5029
-                    if (! $field_obj->is_db_only_field()) {
5029
+                    if ( ! $field_obj->is_db_only_field()) {
5030 5030
                         $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5031 5031
                             $cols_n_values, $field_obj->get_qualified_column(),
5032 5032
                             $field_obj->get_table_column()
@@ -5143,7 +5143,7 @@  discard block
 block discarded – undo
5143 5143
      */
5144 5144
     private function _get_class_name()
5145 5145
     {
5146
-        return "EE_" . $this->get_this_model_name();
5146
+        return "EE_".$this->get_this_model_name();
5147 5147
     }
5148 5148
 
5149 5149
 
@@ -5158,7 +5158,7 @@  discard block
 block discarded – undo
5158 5158
      */
5159 5159
     public function item_name($quantity = 1)
5160 5160
     {
5161
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5161
+        return (int) $quantity === 1 ? $this->singular_item : $this->plural_item;
5162 5162
     }
5163 5163
 
5164 5164
 
@@ -5191,7 +5191,7 @@  discard block
 block discarded – undo
5191 5191
     {
5192 5192
         $className = get_class($this);
5193 5193
         $tagName = "FHEE__{$className}__{$methodName}";
5194
-        if (! has_filter($tagName)) {
5194
+        if ( ! has_filter($tagName)) {
5195 5195
             throw new EE_Error(
5196 5196
                 sprintf(
5197 5197
                     __('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 );',
@@ -5417,7 +5417,7 @@  discard block
 block discarded – undo
5417 5417
         $key_vals_in_combined_pk = array();
5418 5418
         parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5419 5419
         foreach ($key_fields as $key_field_name => $field_obj) {
5420
-            if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5420
+            if ( ! isset($key_vals_in_combined_pk[$key_field_name])) {
5421 5421
                 return null;
5422 5422
             }
5423 5423
         }
@@ -5438,7 +5438,7 @@  discard block
 block discarded – undo
5438 5438
     {
5439 5439
         $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5440 5440
         foreach ($keys_it_should_have as $key) {
5441
-            if (! isset($key_vals[$key])) {
5441
+            if ( ! isset($key_vals[$key])) {
5442 5442
                 return false;
5443 5443
             }
5444 5444
         }
@@ -5492,7 +5492,7 @@  discard block
 block discarded – undo
5492 5492
      */
5493 5493
     public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5494 5494
     {
5495
-        if (! is_array($query_params)) {
5495
+        if ( ! is_array($query_params)) {
5496 5496
             EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5497 5497
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5498 5498
                     gettype($query_params)), '4.6.0');
@@ -5584,7 +5584,7 @@  discard block
 block discarded – undo
5584 5584
      */
5585 5585
     public function get_IDs($model_objects, $filter_out_empty_ids = false)
5586 5586
     {
5587
-        if (! $this->has_primary_key_field()) {
5587
+        if ( ! $this->has_primary_key_field()) {
5588 5588
             if (WP_DEBUG) {
5589 5589
                 EE_Error::add_error(
5590 5590
                     __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
@@ -5597,7 +5597,7 @@  discard block
 block discarded – undo
5597 5597
         $IDs = array();
5598 5598
         foreach ($model_objects as $model_object) {
5599 5599
             $id = $model_object->ID();
5600
-            if (! $id) {
5600
+            if ( ! $id) {
5601 5601
                 if ($filter_out_empty_ids) {
5602 5602
                     continue;
5603 5603
                 }
@@ -5693,8 +5693,8 @@  discard block
 block discarded – undo
5693 5693
         $missing_caps = array();
5694 5694
         $cap_restrictions = $this->cap_restrictions($context);
5695 5695
         foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5696
-            if (! EE_Capabilities::instance()
5697
-                                 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5696
+            if ( ! EE_Capabilities::instance()
5697
+                                 ->current_user_can($cap, $this->get_this_model_name().'_model_applying_caps')
5698 5698
             ) {
5699 5699
                 $missing_caps[$cap] = $restriction_if_no_cap;
5700 5700
             }
@@ -5845,7 +5845,7 @@  discard block
 block discarded – undo
5845 5845
     {
5846 5846
         foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
5847 5847
             if ($query_param_key === $logic_query_param_key
5848
-                || strpos($query_param_key, $logic_query_param_key . '*') === 0
5848
+                || strpos($query_param_key, $logic_query_param_key.'*') === 0
5849 5849
             ) {
5850 5850
                 return true;
5851 5851
             }
Please login to merge, or discard this patch.
Indentation   +5823 added lines, -5823 removed lines patch added patch discarded remove patch
@@ -28,5831 +28,5831 @@
 block discarded – undo
28 28
 abstract class EEM_Base extends EE_Base implements EventEspresso\core\interfaces\ResettableInterface
29 29
 {
30 30
 
31
-    //admin posty
32
-    //basic -> grants access to mine -> if they don't have it, select none
33
-    //*_others -> grants access to others that aren't private, and all mine -> if they don't have it, select mine
34
-    //*_private -> grants full access -> if dont have it, select all mine and others' non-private
35
-    //*_published -> grants access to published -> if they dont have it, select non-published
36
-    //*_global/default/system -> grants access to global items -> if they don't have it, select non-global
37
-    //publish_{thing} -> can change status TO publish; SPECIAL CASE
38
-    //frontend posty
39
-    //by default has access to published
40
-    //basic -> grants access to mine that aren't published, and all published
41
-    //*_others ->grants access to others that aren't private, all mine
42
-    //*_private -> grants full access
43
-    //frontend non-posty
44
-    //like admin posty
45
-    //category-y
46
-    //assign -> grants access to join-table
47
-    //(delete, edit)
48
-    //payment-method-y
49
-    //for each registered payment method,
50
-    //ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
51
-    /**
52
-     * Flag to indicate whether the values provided to EEM_Base have already been prepared
53
-     * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
54
-     * They almost always WILL NOT, but it's not necessarily a requirement.
55
-     * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
56
-     *
57
-     * @var boolean
58
-     */
59
-    private $_values_already_prepared_by_model_object = 0;
60
-
61
-    /**
62
-     * when $_values_already_prepared_by_model_object equals this, we assume
63
-     * the data is just like form input that needs to have the model fields'
64
-     * prepare_for_set and prepare_for_use_in_db called on it
65
-     */
66
-    const not_prepared_by_model_object = 0;
67
-
68
-    /**
69
-     * when $_values_already_prepared_by_model_object equals this, we
70
-     * assume this value is coming from a model object and doesn't need to have
71
-     * prepare_for_set called on it, just prepare_for_use_in_db is used
72
-     */
73
-    const prepared_by_model_object = 1;
74
-
75
-    /**
76
-     * when $_values_already_prepared_by_model_object equals this, we assume
77
-     * the values are already to be used in the database (ie no processing is done
78
-     * on them by the model's fields)
79
-     */
80
-    const prepared_for_use_in_db = 2;
81
-
82
-
83
-    protected $singular_item = 'Item';
84
-
85
-    protected $plural_item   = 'Items';
86
-
87
-    /**
88
-     * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
89
-     */
90
-    protected $_tables;
91
-
92
-    /**
93
-     * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
94
-     * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
95
-     * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
96
-     *
97
-     * @var \EE_Model_Field_Base[] $_fields
98
-     */
99
-    protected $_fields;
100
-
101
-    /**
102
-     * array of different kinds of relations
103
-     *
104
-     * @var \EE_Model_Relation_Base[] $_model_relations
105
-     */
106
-    protected $_model_relations;
107
-
108
-    /**
109
-     * @var \EE_Index[] $_indexes
110
-     */
111
-    protected $_indexes = array();
112
-
113
-    /**
114
-     * Default strategy for getting where conditions on this model. This strategy is used to get default
115
-     * where conditions which are added to get_all, update, and delete queries. They can be overridden
116
-     * by setting the same columns as used in these queries in the query yourself.
117
-     *
118
-     * @var EE_Default_Where_Conditions
119
-     */
120
-    protected $_default_where_conditions_strategy;
121
-
122
-    /**
123
-     * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
124
-     * This is particularly useful when you want something between 'none' and 'default'
125
-     *
126
-     * @var EE_Default_Where_Conditions
127
-     */
128
-    protected $_minimum_where_conditions_strategy;
129
-
130
-    /**
131
-     * String describing how to find the "owner" of this model's objects.
132
-     * When there is a foreign key on this model to the wp_users table, this isn't needed.
133
-     * But when there isn't, this indicates which related model, or transiently-related model,
134
-     * has the foreign key to the wp_users table.
135
-     * Eg, for EEM_Registration this would be 'Event' because registrations are directly
136
-     * related to events, and events have a foreign key to wp_users.
137
-     * On EEM_Transaction, this would be 'Transaction.Event'
138
-     *
139
-     * @var string
140
-     */
141
-    protected $_model_chain_to_wp_user = '';
142
-
143
-    /**
144
-     * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
145
-     * don't need it (particularly CPT models)
146
-     *
147
-     * @var bool
148
-     */
149
-    protected $_ignore_where_strategy = false;
150
-
151
-    /**
152
-     * String used in caps relating to this model. Eg, if the caps relating to this
153
-     * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
154
-     *
155
-     * @var string. If null it hasn't been initialized yet. If false then we
156
-     * have indicated capabilities don't apply to this
157
-     */
158
-    protected $_caps_slug = null;
159
-
160
-    /**
161
-     * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
162
-     * and next-level keys are capability names, and each's value is a
163
-     * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
164
-     * they specify which context to use (ie, frontend, backend, edit or delete)
165
-     * and then each capability in the corresponding sub-array that they're missing
166
-     * adds the where conditions onto the query.
167
-     *
168
-     * @var array
169
-     */
170
-    protected $_cap_restrictions = array(
171
-        self::caps_read       => array(),
172
-        self::caps_read_admin => array(),
173
-        self::caps_edit       => array(),
174
-        self::caps_delete     => array(),
175
-    );
176
-
177
-    /**
178
-     * Array defining which cap restriction generators to use to create default
179
-     * cap restrictions to put in EEM_Base::_cap_restrictions.
180
-     * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
181
-     * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
182
-     * automatically set this to false (not just null).
183
-     *
184
-     * @var EE_Restriction_Generator_Base[]
185
-     */
186
-    protected $_cap_restriction_generators = array();
187
-
188
-    /**
189
-     * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
190
-     */
191
-    const caps_read       = 'read';
192
-
193
-    const caps_read_admin = 'read_admin';
194
-
195
-    const caps_edit       = 'edit';
196
-
197
-    const caps_delete     = 'delete';
198
-
199
-    /**
200
-     * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
201
-     * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
202
-     * maps to 'read' because when looking for relevant permissions we're going to use
203
-     * 'read' in teh capabilities names like 'ee_read_events' etc.
204
-     *
205
-     * @var array
206
-     */
207
-    protected $_cap_contexts_to_cap_action_map = array(
208
-        self::caps_read       => 'read',
209
-        self::caps_read_admin => 'read',
210
-        self::caps_edit       => 'edit',
211
-        self::caps_delete     => 'delete',
212
-    );
213
-
214
-    /**
215
-     * Timezone
216
-     * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
217
-     * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
218
-     * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
219
-     * EE_Datetime_Field data type will have access to it.
220
-     *
221
-     * @var string
222
-     */
223
-    protected $_timezone;
224
-
225
-
226
-    /**
227
-     * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
228
-     * multisite.
229
-     *
230
-     * @var int
231
-     */
232
-    protected static $_model_query_blog_id;
233
-
234
-    /**
235
-     * A copy of _fields, except the array keys are the model names pointed to by
236
-     * the field
237
-     *
238
-     * @var EE_Model_Field_Base[]
239
-     */
240
-    private $_cache_foreign_key_to_fields = array();
241
-
242
-    /**
243
-     * Cached list of all the fields on the model, indexed by their name
244
-     *
245
-     * @var EE_Model_Field_Base[]
246
-     */
247
-    private $_cached_fields = null;
248
-
249
-    /**
250
-     * Cached list of all the fields on the model, except those that are
251
-     * marked as only pertinent to the database
252
-     *
253
-     * @var EE_Model_Field_Base[]
254
-     */
255
-    private $_cached_fields_non_db_only = null;
256
-
257
-    /**
258
-     * A cached reference to the primary key for quick lookup
259
-     *
260
-     * @var EE_Model_Field_Base
261
-     */
262
-    private $_primary_key_field = null;
263
-
264
-    /**
265
-     * Flag indicating whether this model has a primary key or not
266
-     *
267
-     * @var boolean
268
-     */
269
-    protected $_has_primary_key_field = null;
270
-
271
-    /**
272
-     * Whether or not this model is based off a table in WP core only (CPTs should set
273
-     * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
274
-     *
275
-     * @var boolean
276
-     */
277
-    protected $_wp_core_model = false;
278
-
279
-    /**
280
-     *    List of valid operators that can be used for querying.
281
-     * The keys are all operators we'll accept, the values are the real SQL
282
-     * operators used
283
-     *
284
-     * @var array
285
-     */
286
-    protected $_valid_operators = array(
287
-        '='           => '=',
288
-        '<='          => '<=',
289
-        '<'           => '<',
290
-        '>='          => '>=',
291
-        '>'           => '>',
292
-        '!='          => '!=',
293
-        'LIKE'        => 'LIKE',
294
-        'like'        => 'LIKE',
295
-        'NOT_LIKE'    => 'NOT LIKE',
296
-        'not_like'    => 'NOT LIKE',
297
-        'NOT LIKE'    => 'NOT LIKE',
298
-        'not like'    => 'NOT LIKE',
299
-        'IN'          => 'IN',
300
-        'in'          => 'IN',
301
-        'NOT_IN'      => 'NOT IN',
302
-        'not_in'      => 'NOT IN',
303
-        'NOT IN'      => 'NOT IN',
304
-        'not in'      => 'NOT IN',
305
-        'between'     => 'BETWEEN',
306
-        'BETWEEN'     => 'BETWEEN',
307
-        'IS_NOT_NULL' => 'IS NOT NULL',
308
-        'is_not_null' => 'IS NOT NULL',
309
-        'IS NOT NULL' => 'IS NOT NULL',
310
-        'is not null' => 'IS NOT NULL',
311
-        'IS_NULL'     => 'IS NULL',
312
-        'is_null'     => 'IS NULL',
313
-        'IS NULL'     => 'IS NULL',
314
-        'is null'     => 'IS NULL',
315
-        'REGEXP'      => 'REGEXP',
316
-        'regexp'      => 'REGEXP',
317
-        'NOT_REGEXP'  => 'NOT REGEXP',
318
-        'not_regexp'  => 'NOT REGEXP',
319
-        'NOT REGEXP'  => 'NOT REGEXP',
320
-        'not regexp'  => 'NOT REGEXP',
321
-    );
322
-
323
-    /**
324
-     * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
325
-     *
326
-     * @var array
327
-     */
328
-    protected $_in_style_operators = array('IN', 'NOT IN');
329
-
330
-    /**
331
-     * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
332
-     * '12-31-2012'"
333
-     *
334
-     * @var array
335
-     */
336
-    protected $_between_style_operators = array('BETWEEN');
337
-
338
-    /**
339
-     * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
340
-     * on a join table.
341
-     *
342
-     * @var array
343
-     */
344
-    protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
345
-
346
-    /**
347
-     * Allowed values for $query_params['order'] for ordering in queries
348
-     *
349
-     * @var array
350
-     */
351
-    protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
352
-
353
-    /**
354
-     * When these are keys in a WHERE or HAVING clause, they are handled much differently
355
-     * than regular field names. It is assumed that their values are an array of WHERE conditions
356
-     *
357
-     * @var array
358
-     */
359
-    private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
360
-
361
-    /**
362
-     * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
363
-     * 'where', but 'where' clauses are so common that we thought we'd omit it
364
-     *
365
-     * @var array
366
-     */
367
-    private $_allowed_query_params = array(
368
-        0,
369
-        'limit',
370
-        'order_by',
371
-        'group_by',
372
-        'having',
373
-        'force_join',
374
-        'order',
375
-        'on_join_limit',
376
-        'default_where_conditions',
377
-        'caps',
378
-    );
379
-
380
-    /**
381
-     * All the data types that can be used in $wpdb->prepare statements.
382
-     *
383
-     * @var array
384
-     */
385
-    private $_valid_wpdb_data_types = array('%d', '%s', '%f');
386
-
387
-    /**
388
-     *    EE_Registry Object
389
-     *
390
-     * @var    object
391
-     * @access    protected
392
-     */
393
-    protected $EE = null;
394
-
395
-
396
-    /**
397
-     * Property which, when set, will have this model echo out the next X queries to the page for debugging.
398
-     *
399
-     * @var int
400
-     */
401
-    protected $_show_next_x_db_queries = 0;
402
-
403
-    /**
404
-     * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
405
-     * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
406
-     *
407
-     * @var array
408
-     */
409
-    protected $_custom_selections = array();
410
-
411
-    /**
412
-     * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
413
-     * caches every model object we've fetched from the DB on this request
414
-     *
415
-     * @var array
416
-     */
417
-    protected $_entity_map;
418
-
419
-    /**
420
-     * constant used to show EEM_Base has not yet verified the db on this http request
421
-     */
422
-    const db_verified_none = 0;
423
-
424
-    /**
425
-     * constant used to show EEM_Base has verified the EE core db on this http request,
426
-     * but not the addons' dbs
427
-     */
428
-    const db_verified_core = 1;
429
-
430
-    /**
431
-     * constant used to show EEM_Base has verified the addons' dbs (and implicitly
432
-     * the EE core db too)
433
-     */
434
-    const db_verified_addons = 2;
435
-
436
-    /**
437
-     * indicates whether an EEM_Base child has already re-verified the DB
438
-     * is ok (we don't want to do it repetitively). Should be set to one the constants
439
-     * looking like EEM_Base::db_verified_*
440
-     *
441
-     * @var int - 0 = none, 1 = core, 2 = addons
442
-     */
443
-    protected static $_db_verification_level = EEM_Base::db_verified_none;
444
-
445
-    /**
446
-     * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
447
-     *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
448
-     *        registrations for non-trashed tickets for non-trashed datetimes)
449
-     */
450
-    const default_where_conditions_all = 'all';
451
-
452
-    /**
453
-     * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
454
-     *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
455
-     *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
456
-     *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
457
-     *        models which share tables with other models, this can return data for the wrong model.
458
-     */
459
-    const default_where_conditions_this_only = 'this_model_only';
460
-
461
-    /**
462
-     * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
463
-     *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
464
-     *        return all registrations related to non-trashed tickets and non-trashed datetimes)
465
-     */
466
-    const default_where_conditions_others_only = 'other_models_only';
467
-
468
-    /**
469
-     * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
470
-     *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
471
-     *        their table with other models, like the Event and Venue models. For example, when querying for events
472
-     *        ordered by their venues' name, this will be sure to only return real events with associated real venues
473
-     *        (regardless of whether those events and venues are trashed)
474
-     *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
475
-     *        events.
476
-     */
477
-    const default_where_conditions_minimum_all = 'minimum';
478
-
479
-    /**
480
-     * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
481
-     *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
482
-     *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
483
-     *        not)
484
-     */
485
-    const default_where_conditions_minimum_others = 'full_this_minimum_others';
486
-
487
-    /**
488
-     * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
489
-     *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
490
-     *        it's possible it will return table entries for other models. You should use
491
-     *        EEM_Base::default_where_conditions_minimum_all instead.
492
-     */
493
-    const default_where_conditions_none = 'none';
494
-
495
-
496
-
497
-    /**
498
-     * About all child constructors:
499
-     * they should define the _tables, _fields and _model_relations arrays.
500
-     * Should ALWAYS be called after child constructor.
501
-     * In order to make the child constructors to be as simple as possible, this parent constructor
502
-     * finalizes constructing all the object's attributes.
503
-     * Generally, rather than requiring a child to code
504
-     * $this->_tables = array(
505
-     *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
506
-     *        ...);
507
-     *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
508
-     * each EE_Table has a function to set the table's alias after the constructor, using
509
-     * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
510
-     * do something similar.
511
-     *
512
-     * @param null $timezone
513
-     * @throws \EE_Error
514
-     */
515
-    protected function __construct($timezone = null)
516
-    {
517
-        // check that the model has not been loaded too soon
518
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
519
-            throw new EE_Error (
520
-                sprintf(
521
-                    __('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.',
522
-                        'event_espresso'),
523
-                    get_class($this)
524
-                )
525
-            );
526
-        }
527
-        /**
528
-         * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
529
-         */
530
-        if (empty(EEM_Base::$_model_query_blog_id)) {
531
-            EEM_Base::set_model_query_blog_id();
532
-        }
533
-        /**
534
-         * Filters the list of tables on a model. It is best to NOT use this directly and instead
535
-         * just use EE_Register_Model_Extension
536
-         *
537
-         * @var EE_Table_Base[] $_tables
538
-         */
539
-        $this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
540
-        foreach ($this->_tables as $table_alias => $table_obj) {
541
-            /** @var $table_obj EE_Table_Base */
542
-            $table_obj->_construct_finalize_with_alias($table_alias);
543
-            if ($table_obj instanceof EE_Secondary_Table) {
544
-                /** @var $table_obj EE_Secondary_Table */
545
-                $table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
546
-            }
547
-        }
548
-        /**
549
-         * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
550
-         * EE_Register_Model_Extension
551
-         *
552
-         * @param EE_Model_Field_Base[] $_fields
553
-         */
554
-        $this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
555
-        $this->_invalidate_field_caches();
556
-        foreach ($this->_fields as $table_alias => $fields_for_table) {
557
-            if (! array_key_exists($table_alias, $this->_tables)) {
558
-                throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
559
-                    'event_espresso'), $table_alias, implode(",", $this->_fields)));
560
-            }
561
-            foreach ($fields_for_table as $field_name => $field_obj) {
562
-                /** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
563
-                //primary key field base has a slightly different _construct_finalize
564
-                /** @var $field_obj EE_Model_Field_Base */
565
-                $field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
566
-            }
567
-        }
568
-        // everything is related to Extra_Meta
569
-        if (get_class($this) !== 'EEM_Extra_Meta') {
570
-            //make extra meta related to everything, but don't block deleting things just
571
-            //because they have related extra meta info. For now just orphan those extra meta
572
-            //in the future we should automatically delete them
573
-            $this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
574
-        }
575
-        //and change logs
576
-        if (get_class($this) !== 'EEM_Change_Log') {
577
-            $this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
578
-        }
579
-        /**
580
-         * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
581
-         * EE_Register_Model_Extension
582
-         *
583
-         * @param EE_Model_Relation_Base[] $_model_relations
584
-         */
585
-        $this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
586
-            $this->_model_relations);
587
-        foreach ($this->_model_relations as $model_name => $relation_obj) {
588
-            /** @var $relation_obj EE_Model_Relation_Base */
589
-            $relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
590
-        }
591
-        foreach ($this->_indexes as $index_name => $index_obj) {
592
-            /** @var $index_obj EE_Index */
593
-            $index_obj->_construct_finalize($index_name, $this->get_this_model_name());
594
-        }
595
-        $this->set_timezone($timezone);
596
-        //finalize default where condition strategy, or set default
597
-        if (! $this->_default_where_conditions_strategy) {
598
-            //nothing was set during child constructor, so set default
599
-            $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
600
-        }
601
-        $this->_default_where_conditions_strategy->_finalize_construct($this);
602
-        if (! $this->_minimum_where_conditions_strategy) {
603
-            //nothing was set during child constructor, so set default
604
-            $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
605
-        }
606
-        $this->_minimum_where_conditions_strategy->_finalize_construct($this);
607
-        //if the cap slug hasn't been set, and we haven't set it to false on purpose
608
-        //to indicate to NOT set it, set it to the logical default
609
-        if ($this->_caps_slug === null) {
610
-            $this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
611
-        }
612
-        //initialize the standard cap restriction generators if none were specified by the child constructor
613
-        if ($this->_cap_restriction_generators !== false) {
614
-            foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
615
-                if (! isset($this->_cap_restriction_generators[$cap_context])) {
616
-                    $this->_cap_restriction_generators[$cap_context] = apply_filters(
617
-                        'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
618
-                        new EE_Restriction_Generator_Protected(),
619
-                        $cap_context,
620
-                        $this
621
-                    );
622
-                }
623
-            }
624
-        }
625
-        //if there are cap restriction generators, use them to make the default cap restrictions
626
-        if ($this->_cap_restriction_generators !== false) {
627
-            foreach ($this->_cap_restriction_generators as $context => $generator_object) {
628
-                if (! $generator_object) {
629
-                    continue;
630
-                }
631
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
632
-                    throw new EE_Error(
633
-                        sprintf(
634
-                            __('Index "%1$s" in the model %2$s\'s _cap_restriction_generators is not a child of EE_Restriction_Generator_Base. It should be that or NULL.',
635
-                                'event_espresso'),
636
-                            $context,
637
-                            $this->get_this_model_name()
638
-                        )
639
-                    );
640
-                }
641
-                $action = $this->cap_action_for_context($context);
642
-                if (! $generator_object->construction_finalized()) {
643
-                    $generator_object->_construct_finalize($this, $action);
644
-                }
645
-            }
646
-        }
647
-        do_action('AHEE__' . get_class($this) . '__construct__end');
648
-    }
649
-
650
-
651
-
652
-    /**
653
-     * Generates the cap restrictions for the given context, or if they were
654
-     * already generated just gets what's cached
655
-     *
656
-     * @param string $context one of EEM_Base::valid_cap_contexts()
657
-     * @return EE_Default_Where_Conditions[]
658
-     */
659
-    protected function _generate_cap_restrictions($context)
660
-    {
661
-        if (isset($this->_cap_restriction_generators[$context])
662
-            && $this->_cap_restriction_generators[$context]
663
-               instanceof
664
-               EE_Restriction_Generator_Base
665
-        ) {
666
-            return $this->_cap_restriction_generators[$context]->generate_restrictions();
667
-        } else {
668
-            return array();
669
-        }
670
-    }
671
-
672
-
673
-
674
-    /**
675
-     * Used to set the $_model_query_blog_id static property.
676
-     *
677
-     * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
678
-     *                      value for get_current_blog_id() will be used.
679
-     */
680
-    public static function set_model_query_blog_id($blog_id = 0)
681
-    {
682
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
683
-    }
684
-
685
-
686
-
687
-    /**
688
-     * Returns whatever is set as the internal $model_query_blog_id.
689
-     *
690
-     * @return int
691
-     */
692
-    public static function get_model_query_blog_id()
693
-    {
694
-        return EEM_Base::$_model_query_blog_id;
695
-    }
696
-
697
-
698
-
699
-    /**
700
-     *        This function is a singleton method used to instantiate the Espresso_model object
701
-     *
702
-     * @access public
703
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
704
-     *                         incoming timezone data that gets saved).  Note this just sends the timezone info to the
705
-     *                         date time model field objects.  Default is NULL (and will be assumed using the set
706
-     *                         timezone in the 'timezone_string' wp option)
707
-     * @return static (as in the concrete child class)
708
-     */
709
-    public static function instance($timezone = null)
710
-    {
711
-        // check if instance of Espresso_model already exists
712
-        if (! static::$_instance instanceof static) {
713
-            // instantiate Espresso_model
714
-            static::$_instance = new static($timezone);
715
-        }
716
-        //we might have a timezone set, let set_timezone decide what to do with it
717
-        static::$_instance->set_timezone($timezone);
718
-        // Espresso_model object
719
-        return static::$_instance;
720
-    }
721
-
722
-
723
-
724
-    /**
725
-     * resets the model and returns it
726
-     *
727
-     * @param null | string $timezone
728
-     * @return EEM_Base|null (if the model was already instantiated, returns it, with
729
-     * all its properties reset; if it wasn't instantiated, returns null)
730
-     */
731
-    public static function reset($timezone = null)
732
-    {
733
-        if (static::$_instance instanceof EEM_Base) {
734
-            //let's try to NOT swap out the current instance for a new one
735
-            //because if someone has a reference to it, we can't remove their reference
736
-            //so it's best to keep using the same reference, but change the original object
737
-            //reset all its properties to their original values as defined in the class
738
-            $r = new ReflectionClass(get_class(static::$_instance));
739
-            $static_properties = $r->getStaticProperties();
740
-            foreach ($r->getDefaultProperties() as $property => $value) {
741
-                //don't set instance to null like it was originally,
742
-                //but it's static anyways, and we're ignoring static properties (for now at least)
743
-                if (! isset($static_properties[$property])) {
744
-                    static::$_instance->{$property} = $value;
745
-                }
746
-            }
747
-            //and then directly call its constructor again, like we would if we
748
-            //were creating a new one
749
-            static::$_instance->__construct($timezone);
750
-            return self::instance();
751
-        }
752
-        return null;
753
-    }
754
-
755
-
756
-
757
-    /**
758
-     * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
759
-     *
760
-     * @param  boolean $translated return localized strings or JUST the array.
761
-     * @return array
762
-     * @throws \EE_Error
763
-     */
764
-    public function status_array($translated = false)
765
-    {
766
-        if (! array_key_exists('Status', $this->_model_relations)) {
767
-            return array();
768
-        }
769
-        $model_name = $this->get_this_model_name();
770
-        $status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
771
-        $stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
772
-        $status_array = array();
773
-        foreach ($stati as $status) {
774
-            $status_array[$status->ID()] = $status->get('STS_code');
775
-        }
776
-        return $translated
777
-            ? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
778
-            : $status_array;
779
-    }
780
-
781
-
782
-
783
-    /**
784
-     * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
785
-     *
786
-     * @param array $query_params             {
787
-     * @var array $0 (where) array {
788
-     *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
789
-     *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
790
-     *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
791
-     *                                        conditions based on related models (and even
792
-     *                                        models-related-to-related-models) prepend the model's name onto the field
793
-     *                                        name. Eg,
794
-     *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
795
-     *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
796
-     *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
797
-     *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
798
-     *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
799
-     *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
800
-     *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
801
-     *                                        to Venues (even when each of those models actually consisted of two
802
-     *                                        tables). Also, you may chain the model relations together. Eg instead of
803
-     *                                        just having
804
-     *                                        "Venue.VNU_ID", you could have
805
-     *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
806
-     *                                        events are related to Registrations, which are related to Attendees). You
807
-     *                                        can take it even further with
808
-     *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
809
-     *                                        (from the default of '='), change the value to an numerically-indexed
810
-     *                                        array, where the first item in the list is the operator. eg: array(
811
-     *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
812
-     *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
813
-     *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
814
-     *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
815
-     *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
816
-     *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
817
-     *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
818
-     *                                        the operator is IN. Also, values can actually be field names. To indicate
819
-     *                                        the value is a field, simply provide a third array item (true) to the
820
-     *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
821
-     *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
822
-     *                                        Note: you can also use related model field names like you would any other
823
-     *                                        field name. eg:
824
-     *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
825
-     *                                        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__>' =>
826
-     *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
827
-     *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
828
-     *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
829
-     *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
830
-     *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
831
-     *                                        to be what you last specified. IE, "AND"s by default, but if you had
832
-     *                                        previously specified to use ORs to join, ORs will continue to be used.
833
-     *                                        So, if you specify to use an "OR" to join conditions, it will continue to
834
-     *                                        "stick" until you specify an AND. eg
835
-     *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
836
-     *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
837
-     *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
838
-     *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
839
-     *                                        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 >>
840
-     *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
841
-     *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
842
-     *                                        too, eg:
843
-     *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
844
-     * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
845
-     *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
846
-     *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
847
-     *                                        Remember when you provide two numbers for the limit, the 1st number is
848
-     *                                        the OFFSET, the 2nd is the LIMIT
849
-     * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
850
-     *                                        can do paging on one-to-many multi-table-joins. Send an array in the
851
-     *                                        following format array('on_join_limit'
852
-     *                                        => array( 'table_alias', array(1,2) ) ).
853
-     * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
854
-     *                                        values are either 'ASC' or 'DESC'.
855
-     *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
856
-     *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
857
-     *                                        DESC..." respectively. Like the
858
-     *                                        'where' conditions, these fields can be on related models. Eg
859
-     *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
860
-     *                                        perfectly valid from any model related to 'Registration' (like Event,
861
-     *                                        Attendee, Price, Datetime, etc.)
862
-     * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
863
-     *                                        'order' specifies whether to order the field specified in 'order_by' in
864
-     *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
865
-     *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
866
-     *                                        order by the primary key. Eg,
867
-     *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
868
-     *                                        //(will join with the Datetime model's table(s) and order by its field
869
-     *                                        DTT_EVT_start) or
870
-     *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
871
-     *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
872
-     * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
873
-     *                                        'group_by'=>'VNU_ID', or
874
-     *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
875
-     *                                        if no
876
-     *                                        $group_by is specified, and a limit is set, automatically groups by the
877
-     *                                        model's primary key (or combined primary keys). This avoids some
878
-     *                                        weirdness that results when using limits, tons of joins, and no group by,
879
-     *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
880
-     * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
881
-     *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
882
-     *                                        results)
883
-     * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
884
-     *                                        array where values are models to be joined in the query.Eg
885
-     *                                        array('Attendee','Payment','Datetime'). You may join with transient
886
-     *                                        models using period, eg "Registration.Transaction.Payment". You will
887
-     *                                        probably only want to do this in hopes of increasing efficiency, as
888
-     *                                        related models which belongs to the current model
889
-     *                                        (ie, the current model has a foreign key to them, like how Registration
890
-     *                                        belongs to Attendee) can be cached in order to avoid future queries
891
-     * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
892
-     *                                        set this to 'none' to disable all default where conditions. Eg, usually
893
-     *                                        soft-deleted objects are filtered-out if you want to include them, set
894
-     *                                        this query param to 'none'. If you want to ONLY disable THIS model's
895
-     *                                        default where conditions set it to 'other_models_only'. If you only want
896
-     *                                        this model's default where conditions added to the query, use
897
-     *                                        'this_model_only'. If you want to use all default where conditions
898
-     *                                        (default), set to 'all'.
899
-     * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
900
-     *                                        we just NOT apply any capabilities/permissions/restrictions and return
901
-     *                                        everything? Or should we only show the current user items they should be
902
-     *                                        able to view on the frontend, backend, edit, or delete? can be set to
903
-     *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
904
-     *                                        }
905
-     * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
906
-     *                                        from EE_Base_Class[], use _get_all_wpdb_results()and make it public
907
-     *                                        again. Array keys are object IDs (if there is a primary key on the model.
908
-     *                                        if not, numerically indexed) Some full examples: get 10 transactions
909
-     *                                        which have Scottish attendees: EEM_Transaction::instance()->get_all(
910
-     *                                        array( array(
911
-     *                                        'OR'=>array(
912
-     *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
913
-     *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
914
-     *                                        )
915
-     *                                        ),
916
-     *                                        'limit'=>10,
917
-     *                                        'group_by'=>'TXN_ID'
918
-     *                                        ));
919
-     *                                        get all the answers to the question titled "shirt size" for event with id
920
-     *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
921
-     *                                        'Question.QST_display_text'=>'shirt size',
922
-     *                                        'Registration.Event.EVT_ID'=>12
923
-     *                                        ),
924
-     *                                        'order_by'=>array('ANS_value'=>'ASC')
925
-     *                                        ));
926
-     * @throws \EE_Error
927
-     */
928
-    public function get_all($query_params = array())
929
-    {
930
-        if (isset($query_params['limit'])
931
-            && ! isset($query_params['group_by'])
932
-        ) {
933
-            $query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
934
-        }
935
-        return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
936
-    }
937
-
938
-
939
-
940
-    /**
941
-     * Modifies the query parameters so we only get back model objects
942
-     * that "belong" to the current user
943
-     *
944
-     * @param array $query_params @see EEM_Base::get_all()
945
-     * @return array like EEM_Base::get_all
946
-     */
947
-    public function alter_query_params_to_only_include_mine($query_params = array())
948
-    {
949
-        $wp_user_field_name = $this->wp_user_field_name();
950
-        if ($wp_user_field_name) {
951
-            $query_params[0][$wp_user_field_name] = get_current_user_id();
952
-        }
953
-        return $query_params;
954
-    }
955
-
956
-
957
-
958
-    /**
959
-     * Returns the name of the field's name that points to the WP_User table
960
-     *  on this model (or follows the _model_chain_to_wp_user and uses that model's
961
-     * foreign key to the WP_User table)
962
-     *
963
-     * @return string|boolean string on success, boolean false when there is no
964
-     * foreign key to the WP_User table
965
-     */
966
-    public function wp_user_field_name()
967
-    {
968
-        try {
969
-            if (! empty($this->_model_chain_to_wp_user)) {
970
-                $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
971
-                $last_model_name = end($models_to_follow_to_wp_users);
972
-                $model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
973
-                $model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
974
-            } else {
975
-                $model_with_fk_to_wp_users = $this;
976
-                $model_chain_to_wp_user = '';
977
-            }
978
-            $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
979
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
980
-        } catch (EE_Error $e) {
981
-            return false;
982
-        }
983
-    }
984
-
985
-
986
-
987
-    /**
988
-     * Returns the _model_chain_to_wp_user string, which indicates which related model
989
-     * (or transiently-related model) has a foreign key to the wp_users table;
990
-     * useful for finding if model objects of this type are 'owned' by the current user.
991
-     * This is an empty string when the foreign key is on this model and when it isn't,
992
-     * but is only non-empty when this model's ownership is indicated by a RELATED model
993
-     * (or transiently-related model)
994
-     *
995
-     * @return string
996
-     */
997
-    public function model_chain_to_wp_user()
998
-    {
999
-        return $this->_model_chain_to_wp_user;
1000
-    }
1001
-
1002
-
1003
-
1004
-    /**
1005
-     * Whether this model is 'owned' by a specific wordpress user (even indirectly,
1006
-     * like how registrations don't have a foreign key to wp_users, but the
1007
-     * events they are for are), or is unrelated to wp users.
1008
-     * generally available
1009
-     *
1010
-     * @return boolean
1011
-     */
1012
-    public function is_owned()
1013
-    {
1014
-        if ($this->model_chain_to_wp_user()) {
1015
-            return true;
1016
-        } else {
1017
-            try {
1018
-                $this->get_foreign_key_to('WP_User');
1019
-                return true;
1020
-            } catch (EE_Error $e) {
1021
-                return false;
1022
-            }
1023
-        }
1024
-    }
1025
-
1026
-
1027
-
1028
-    /**
1029
-     * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
1030
-     * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
1031
-     * the model)
1032
-     *
1033
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
1034
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1035
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1036
-     *                                  fields on the model, and the models we joined to in the query. However, you can
1037
-     *                                  override this and set the select to "*", or a specific column name, like
1038
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1039
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1040
-     *                                  the aliases used to refer to this selection, and values are to be
1041
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1042
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1043
-     * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1044
-     * @throws \EE_Error
1045
-     */
1046
-    protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1047
-    {
1048
-        // remember the custom selections, if any, and type cast as array
1049
-        // (unless $columns_to_select is an object, then just set as an empty array)
1050
-        // Note: (array) 'some string' === array( 'some string' )
1051
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1052
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1053
-        $select_expressions = $columns_to_select !== null
1054
-            ? $this->_construct_select_from_input($columns_to_select)
1055
-            : $this->_construct_default_select_sql($model_query_info);
1056
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1057
-        return $this->_do_wpdb_query('get_results', array($SQL, $output));
1058
-    }
1059
-
1060
-
1061
-
1062
-    /**
1063
-     * Gets an array of rows from the database just like $wpdb->get_results would,
1064
-     * but you can use the $query_params like on EEM_Base::get_all() to more easily
1065
-     * take care of joins, field preparation etc.
1066
-     *
1067
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
1068
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1069
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1070
-     *                                  fields on the model, and the models we joined to in the query. However, you can
1071
-     *                                  override this and set the select to "*", or a specific column name, like
1072
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1073
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1074
-     *                                  the aliases used to refer to this selection, and values are to be
1075
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1076
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1077
-     * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1078
-     * @throws \EE_Error
1079
-     */
1080
-    public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1081
-    {
1082
-        return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
1083
-    }
1084
-
1085
-
1086
-
1087
-    /**
1088
-     * For creating a custom select statement
1089
-     *
1090
-     * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
1091
-     *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
1092
-     *                                 SQL, and 1=>is the datatype
1093
-     * @throws EE_Error
1094
-     * @return string
1095
-     */
1096
-    private function _construct_select_from_input($columns_to_select)
1097
-    {
1098
-        if (is_array($columns_to_select)) {
1099
-            $select_sql_array = array();
1100
-            foreach ($columns_to_select as $alias => $selection_and_datatype) {
1101
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1102
-                    throw new EE_Error(
1103
-                        sprintf(
1104
-                            __(
1105
-                                "Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1106
-                                "event_espresso"
1107
-                            ),
1108
-                            $selection_and_datatype,
1109
-                            $alias
1110
-                        )
1111
-                    );
1112
-                }
1113
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1114
-                    throw new EE_Error(
1115
-                        sprintf(
1116
-                            __(
1117
-                                "Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1118
-                                "event_espresso"
1119
-                            ),
1120
-                            $selection_and_datatype[1],
1121
-                            $selection_and_datatype[0],
1122
-                            $alias,
1123
-                            implode(",", $this->_valid_wpdb_data_types)
1124
-                        )
1125
-                    );
1126
-                }
1127
-                $select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1128
-            }
1129
-            $columns_to_select_string = implode(", ", $select_sql_array);
1130
-        } else {
1131
-            $columns_to_select_string = $columns_to_select;
1132
-        }
1133
-        return $columns_to_select_string;
1134
-    }
1135
-
1136
-
1137
-
1138
-    /**
1139
-     * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1140
-     *
1141
-     * @return string
1142
-     * @throws \EE_Error
1143
-     */
1144
-    public function primary_key_name()
1145
-    {
1146
-        return $this->get_primary_key_field()->get_name();
1147
-    }
1148
-
1149
-
1150
-
1151
-    /**
1152
-     * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1153
-     * If there is no primary key on this model, $id is treated as primary key string
1154
-     *
1155
-     * @param mixed $id int or string, depending on the type of the model's primary key
1156
-     * @return EE_Base_Class
1157
-     */
1158
-    public function get_one_by_ID($id)
1159
-    {
1160
-        if ($this->get_from_entity_map($id)) {
1161
-            return $this->get_from_entity_map($id);
1162
-        }
1163
-        return $this->get_one(
1164
-            $this->alter_query_params_to_restrict_by_ID(
1165
-                $id,
1166
-                array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
1167
-            )
1168
-        );
1169
-    }
1170
-
1171
-
1172
-
1173
-    /**
1174
-     * Alters query parameters to only get items with this ID are returned.
1175
-     * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1176
-     * or could just be a simple primary key ID
1177
-     *
1178
-     * @param int   $id
1179
-     * @param array $query_params
1180
-     * @return array of normal query params, @see EEM_Base::get_all
1181
-     * @throws \EE_Error
1182
-     */
1183
-    public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1184
-    {
1185
-        if (! isset($query_params[0])) {
1186
-            $query_params[0] = array();
1187
-        }
1188
-        $conditions_from_id = $this->parse_index_primary_key_string($id);
1189
-        if ($conditions_from_id === null) {
1190
-            $query_params[0][$this->primary_key_name()] = $id;
1191
-        } else {
1192
-            //no primary key, so the $id must be from the get_index_primary_key_string()
1193
-            $query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1194
-        }
1195
-        return $query_params;
1196
-    }
1197
-
1198
-
1199
-
1200
-    /**
1201
-     * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1202
-     * array. If no item is found, null is returned.
1203
-     *
1204
-     * @param array $query_params like EEM_Base's $query_params variable.
1205
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1206
-     * @throws \EE_Error
1207
-     */
1208
-    public function get_one($query_params = array())
1209
-    {
1210
-        if (! is_array($query_params)) {
1211
-            EE_Error::doing_it_wrong('EEM_Base::get_one',
1212
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1213
-                    gettype($query_params)), '4.6.0');
1214
-            $query_params = array();
1215
-        }
1216
-        $query_params['limit'] = 1;
1217
-        $items = $this->get_all($query_params);
1218
-        if (empty($items)) {
1219
-            return null;
1220
-        } else {
1221
-            return array_shift($items);
1222
-        }
1223
-    }
1224
-
1225
-
1226
-
1227
-    /**
1228
-     * Returns the next x number of items in sequence from the given value as
1229
-     * found in the database matching the given query conditions.
1230
-     *
1231
-     * @param mixed $current_field_value    Value used for the reference point.
1232
-     * @param null  $field_to_order_by      What field is used for the
1233
-     *                                      reference point.
1234
-     * @param int   $limit                  How many to return.
1235
-     * @param array $query_params           Extra conditions on the query.
1236
-     * @param null  $columns_to_select      If left null, then an array of
1237
-     *                                      EE_Base_Class objects is returned,
1238
-     *                                      otherwise you can indicate just the
1239
-     *                                      columns you want returned.
1240
-     * @return EE_Base_Class[]|array
1241
-     * @throws \EE_Error
1242
-     */
1243
-    public function next_x(
1244
-        $current_field_value,
1245
-        $field_to_order_by = null,
1246
-        $limit = 1,
1247
-        $query_params = array(),
1248
-        $columns_to_select = null
1249
-    ) {
1250
-        return $this->_get_consecutive($current_field_value, '>', $field_to_order_by, $limit, $query_params,
1251
-            $columns_to_select);
1252
-    }
1253
-
1254
-
1255
-
1256
-    /**
1257
-     * Returns the previous x number of items in sequence from the given value
1258
-     * as found in the database matching the given query conditions.
1259
-     *
1260
-     * @param mixed $current_field_value    Value used for the reference point.
1261
-     * @param null  $field_to_order_by      What field is used for the
1262
-     *                                      reference point.
1263
-     * @param int   $limit                  How many to return.
1264
-     * @param array $query_params           Extra conditions on the query.
1265
-     * @param null  $columns_to_select      If left null, then an array of
1266
-     *                                      EE_Base_Class objects is returned,
1267
-     *                                      otherwise you can indicate just the
1268
-     *                                      columns you want returned.
1269
-     * @return EE_Base_Class[]|array
1270
-     * @throws \EE_Error
1271
-     */
1272
-    public function previous_x(
1273
-        $current_field_value,
1274
-        $field_to_order_by = null,
1275
-        $limit = 1,
1276
-        $query_params = array(),
1277
-        $columns_to_select = null
1278
-    ) {
1279
-        return $this->_get_consecutive($current_field_value, '<', $field_to_order_by, $limit, $query_params,
1280
-            $columns_to_select);
1281
-    }
1282
-
1283
-
1284
-
1285
-    /**
1286
-     * Returns the next item in sequence from the given value as found in the
1287
-     * database matching the given query conditions.
1288
-     *
1289
-     * @param mixed $current_field_value    Value used for the reference point.
1290
-     * @param null  $field_to_order_by      What field is used for the
1291
-     *                                      reference point.
1292
-     * @param array $query_params           Extra conditions on the query.
1293
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1294
-     *                                      object is returned, otherwise you
1295
-     *                                      can indicate just the columns you
1296
-     *                                      want and a single array indexed by
1297
-     *                                      the columns will be returned.
1298
-     * @return EE_Base_Class|null|array()
1299
-     * @throws \EE_Error
1300
-     */
1301
-    public function next(
1302
-        $current_field_value,
1303
-        $field_to_order_by = null,
1304
-        $query_params = array(),
1305
-        $columns_to_select = null
1306
-    ) {
1307
-        $results = $this->_get_consecutive($current_field_value, '>', $field_to_order_by, 1, $query_params,
1308
-            $columns_to_select);
1309
-        return empty($results) ? null : reset($results);
1310
-    }
1311
-
1312
-
1313
-
1314
-    /**
1315
-     * Returns the previous item in sequence from the given value as found in
1316
-     * the database matching the given query conditions.
1317
-     *
1318
-     * @param mixed $current_field_value    Value used for the reference point.
1319
-     * @param null  $field_to_order_by      What field is used for the
1320
-     *                                      reference point.
1321
-     * @param array $query_params           Extra conditions on the query.
1322
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1323
-     *                                      object is returned, otherwise you
1324
-     *                                      can indicate just the columns you
1325
-     *                                      want and a single array indexed by
1326
-     *                                      the columns will be returned.
1327
-     * @return EE_Base_Class|null|array()
1328
-     * @throws EE_Error
1329
-     */
1330
-    public function previous(
1331
-        $current_field_value,
1332
-        $field_to_order_by = null,
1333
-        $query_params = array(),
1334
-        $columns_to_select = null
1335
-    ) {
1336
-        $results = $this->_get_consecutive($current_field_value, '<', $field_to_order_by, 1, $query_params,
1337
-            $columns_to_select);
1338
-        return empty($results) ? null : reset($results);
1339
-    }
1340
-
1341
-
1342
-
1343
-    /**
1344
-     * Returns the a consecutive number of items in sequence from the given
1345
-     * value as found in the database matching the given query conditions.
1346
-     *
1347
-     * @param mixed  $current_field_value   Value used for the reference point.
1348
-     * @param string $operand               What operand is used for the sequence.
1349
-     * @param string $field_to_order_by     What field is used for the reference point.
1350
-     * @param int    $limit                 How many to return.
1351
-     * @param array  $query_params          Extra conditions on the query.
1352
-     * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1353
-     *                                      otherwise you can indicate just the columns you want returned.
1354
-     * @return EE_Base_Class[]|array
1355
-     * @throws EE_Error
1356
-     */
1357
-    protected function _get_consecutive(
1358
-        $current_field_value,
1359
-        $operand = '>',
1360
-        $field_to_order_by = null,
1361
-        $limit = 1,
1362
-        $query_params = array(),
1363
-        $columns_to_select = null
1364
-    ) {
1365
-        //if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1366
-        if (empty($field_to_order_by)) {
1367
-            if ($this->has_primary_key_field()) {
1368
-                $field_to_order_by = $this->get_primary_key_field()->get_name();
1369
-            } else {
1370
-                if (WP_DEBUG) {
1371
-                    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).',
1372
-                        'event_espresso'));
1373
-                }
1374
-                EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1375
-                return array();
1376
-            }
1377
-        }
1378
-        if (! is_array($query_params)) {
1379
-            EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1380
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1381
-                    gettype($query_params)), '4.6.0');
1382
-            $query_params = array();
1383
-        }
1384
-        //let's add the where query param for consecutive look up.
1385
-        $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1386
-        $query_params['limit'] = $limit;
1387
-        //set direction
1388
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1389
-        $query_params['order_by'] = $operand === '>'
1390
-            ? array($field_to_order_by => 'ASC') + $incoming_orderby
1391
-            : array($field_to_order_by => 'DESC') + $incoming_orderby;
1392
-        //if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1393
-        if (empty($columns_to_select)) {
1394
-            return $this->get_all($query_params);
1395
-        } else {
1396
-            //getting just the fields
1397
-            return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1398
-        }
1399
-    }
1400
-
1401
-
1402
-
1403
-    /**
1404
-     * This sets the _timezone property after model object has been instantiated.
1405
-     *
1406
-     * @param null | string $timezone valid PHP DateTimeZone timezone string
1407
-     */
1408
-    public function set_timezone($timezone)
1409
-    {
1410
-        if ($timezone !== null) {
1411
-            $this->_timezone = $timezone;
1412
-        }
1413
-        //note we need to loop through relations and set the timezone on those objects as well.
1414
-        foreach ($this->_model_relations as $relation) {
1415
-            $relation->set_timezone($timezone);
1416
-        }
1417
-        //and finally we do the same for any datetime fields
1418
-        foreach ($this->_fields as $field) {
1419
-            if ($field instanceof EE_Datetime_Field) {
1420
-                $field->set_timezone($timezone);
1421
-            }
1422
-        }
1423
-    }
1424
-
1425
-
1426
-
1427
-    /**
1428
-     * This just returns whatever is set for the current timezone.
1429
-     *
1430
-     * @access public
1431
-     * @return string
1432
-     */
1433
-    public function get_timezone()
1434
-    {
1435
-        //first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1436
-        if (empty($this->_timezone)) {
1437
-            foreach ($this->_fields as $field) {
1438
-                if ($field instanceof EE_Datetime_Field) {
1439
-                    $this->set_timezone($field->get_timezone());
1440
-                    break;
1441
-                }
1442
-            }
1443
-        }
1444
-        //if timezone STILL empty then return the default timezone for the site.
1445
-        if (empty($this->_timezone)) {
1446
-            $this->set_timezone(EEH_DTT_Helper::get_timezone());
1447
-        }
1448
-        return $this->_timezone;
1449
-    }
1450
-
1451
-
1452
-
1453
-    /**
1454
-     * This returns the date formats set for the given field name and also ensures that
1455
-     * $this->_timezone property is set correctly.
1456
-     *
1457
-     * @since 4.6.x
1458
-     * @param string $field_name The name of the field the formats are being retrieved for.
1459
-     * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1460
-     * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1461
-     * @return array formats in an array with the date format first, and the time format last.
1462
-     */
1463
-    public function get_formats_for($field_name, $pretty = false)
1464
-    {
1465
-        $field_settings = $this->field_settings_for($field_name);
1466
-        //if not a valid EE_Datetime_Field then throw error
1467
-        if (! $field_settings instanceof EE_Datetime_Field) {
1468
-            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.',
1469
-                'event_espresso'), $field_name));
1470
-        }
1471
-        //while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1472
-        //the field.
1473
-        $this->_timezone = $field_settings->get_timezone();
1474
-        return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1475
-    }
1476
-
1477
-
1478
-
1479
-    /**
1480
-     * This returns the current time in a format setup for a query on this model.
1481
-     * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1482
-     * it will return:
1483
-     *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1484
-     *  NOW
1485
-     *  - or a unix timestamp (equivalent to time())
1486
-     * Note: When requesting a formatted string, if the date or time format doesn't include seconds, for example,
1487
-     * the time returned, because it uses that format, will also NOT include seconds. For this reason, if you want
1488
-     * the time returned to be the current time down to the exact second, set $timestamp to true.
1489
-     * @since 4.6.x
1490
-     * @param string $field_name       The field the current time is needed for.
1491
-     * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1492
-     *                                 formatted string matching the set format for the field in the set timezone will
1493
-     *                                 be returned.
1494
-     * @param string $what             Whether to return the string in just the time format, the date format, or both.
1495
-     * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1496
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1497
-     *                                 exception is triggered.
1498
-     */
1499
-    public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1500
-    {
1501
-        $formats = $this->get_formats_for($field_name);
1502
-        $DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1503
-        if ($timestamp) {
1504
-            return $DateTime->format('U');
1505
-        }
1506
-        //not returning timestamp, so return formatted string in timezone.
1507
-        switch ($what) {
1508
-            case 'time' :
1509
-                return $DateTime->format($formats[1]);
1510
-                break;
1511
-            case 'date' :
1512
-                return $DateTime->format($formats[0]);
1513
-                break;
1514
-            default :
1515
-                return $DateTime->format(implode(' ', $formats));
1516
-                break;
1517
-        }
1518
-    }
1519
-
1520
-
1521
-
1522
-    /**
1523
-     * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1524
-     * for the model are.  Returns a DateTime object.
1525
-     * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1526
-     * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1527
-     * ignored.
1528
-     *
1529
-     * @param string $field_name      The field being setup.
1530
-     * @param string $timestring      The date time string being used.
1531
-     * @param string $incoming_format The format for the time string.
1532
-     * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1533
-     *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1534
-     *                                format is
1535
-     *                                'U', this is ignored.
1536
-     * @return DateTime
1537
-     * @throws \EE_Error
1538
-     */
1539
-    public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1540
-    {
1541
-        //just using this to ensure the timezone is set correctly internally
1542
-        $this->get_formats_for($field_name);
1543
-        //load EEH_DTT_Helper
1544
-        $set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1545
-        $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1546
-        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1547
-    }
1548
-
1549
-
1550
-
1551
-    /**
1552
-     * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1553
-     *
1554
-     * @return EE_Table_Base[]
1555
-     */
1556
-    public function get_tables()
1557
-    {
1558
-        return $this->_tables;
1559
-    }
1560
-
1561
-
1562
-
1563
-    /**
1564
-     * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1565
-     * also updates all the model objects, where the criteria expressed in $query_params are met..
1566
-     * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1567
-     * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1568
-     * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1569
-     * model object with EVT_ID = 1
1570
-     * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1571
-     * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1572
-     * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1573
-     * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1574
-     * are not specified)
1575
-     *
1576
-     * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1577
-     *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1578
-     *                                         are to be serialized. Basically, the values are what you'd expect to be
1579
-     *                                         values on the model, NOT necessarily what's in the DB. For example, if
1580
-     *                                         we wanted to update only the TXN_details on any Transactions where its
1581
-     *                                         ID=34, we'd use this method as follows:
1582
-     *                                         EEM_Transaction::instance()->update(
1583
-     *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1584
-     *                                         array(array('TXN_ID'=>34)));
1585
-     * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1586
-     *                                         in client code into what's expected to be stored on each field. Eg,
1587
-     *                                         consider updating Question's QST_admin_label field is of type
1588
-     *                                         Simple_HTML. If you use this function to update that field to $new_value
1589
-     *                                         = (note replace 8's with appropriate opening and closing tags in the
1590
-     *                                         following example)"8script8alert('I hack all');8/script88b8boom
1591
-     *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1592
-     *                                         TRUE, it is assumed that you've already called
1593
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1594
-     *                                         malicious javascript. However, if
1595
-     *                                         $values_already_prepared_by_model_object is left as FALSE, then
1596
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
1597
-     *                                         and every other field, before insertion. We provide this parameter
1598
-     *                                         because model objects perform their prepare_for_set function on all
1599
-     *                                         their values, and so don't need to be called again (and in many cases,
1600
-     *                                         shouldn't be called again. Eg: if we escape HTML characters in the
1601
-     *                                         prepare_for_set method...)
1602
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1603
-     *                                         in this model's entity map according to $fields_n_values that match
1604
-     *                                         $query_params. This obviously has some overhead, so you can disable it
1605
-     *                                         by setting this to FALSE, but be aware that model objects being used
1606
-     *                                         could get out-of-sync with the database
1607
-     * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1608
-     *                                         rows affected which *could* include 0 which DOES NOT mean the query was
1609
-     *                                         bad)
1610
-     * @throws \EE_Error
1611
-     */
1612
-    public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1613
-    {
1614
-        if (! is_array($query_params)) {
1615
-            EE_Error::doing_it_wrong('EEM_Base::update',
1616
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1617
-                    gettype($query_params)), '4.6.0');
1618
-            $query_params = array();
1619
-        }
1620
-        /**
1621
-         * Action called before a model update call has been made.
1622
-         *
1623
-         * @param EEM_Base $model
1624
-         * @param array    $fields_n_values the updated fields and their new values
1625
-         * @param array    $query_params    @see EEM_Base::get_all()
1626
-         */
1627
-        do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1628
-        /**
1629
-         * Filters the fields about to be updated given the query parameters. You can provide the
1630
-         * $query_params to $this->get_all() to find exactly which records will be updated
1631
-         *
1632
-         * @param array    $fields_n_values fields and their new values
1633
-         * @param EEM_Base $model           the model being queried
1634
-         * @param array    $query_params    see EEM_Base::get_all()
1635
-         */
1636
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1637
-            $query_params);
1638
-        //need to verify that, for any entry we want to update, there are entries in each secondary table.
1639
-        //to do that, for each table, verify that it's PK isn't null.
1640
-        $tables = $this->get_tables();
1641
-        //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
1642
-        //NOTE: we should make this code more efficient by NOT querying twice
1643
-        //before the real update, but that needs to first go through ALPHA testing
1644
-        //as it's dangerous. says Mike August 8 2014
1645
-        //we want to make sure the default_where strategy is ignored
1646
-        $this->_ignore_where_strategy = true;
1647
-        $wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1648
-        foreach ($wpdb_select_results as $wpdb_result) {
1649
-            // type cast stdClass as array
1650
-            $wpdb_result = (array)$wpdb_result;
1651
-            //get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1652
-            if ($this->has_primary_key_field()) {
1653
-                $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1654
-            } else {
1655
-                //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)
1656
-                $main_table_pk_value = null;
1657
-            }
1658
-            //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
1659
-            //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
1660
-            if (count($tables) > 1) {
1661
-                //foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1662
-                //in that table, and so we'll want to insert one
1663
-                foreach ($tables as $table_obj) {
1664
-                    $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1665
-                    //if there is no private key for this table on the results, it means there's no entry
1666
-                    //in this table, right? so insert a row in the current table, using any fields available
1667
-                    if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1668
-                           && $wpdb_result[$this_table_pk_column])
1669
-                    ) {
1670
-                        $success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1671
-                            $main_table_pk_value);
1672
-                        //if we died here, report the error
1673
-                        if (! $success) {
1674
-                            return false;
1675
-                        }
1676
-                    }
1677
-                }
1678
-            }
1679
-            //				//and now check that if we have cached any models by that ID on the model, that
1680
-            //				//they also get updated properly
1681
-            //				$model_object = $this->get_from_entity_map( $main_table_pk_value );
1682
-            //				if( $model_object ){
1683
-            //					foreach( $fields_n_values as $field => $value ){
1684
-            //						$model_object->set($field, $value);
1685
-            //let's make sure default_where strategy is followed now
1686
-            $this->_ignore_where_strategy = false;
1687
-        }
1688
-        //if we want to keep model objects in sync, AND
1689
-        //if this wasn't called from a model object (to update itself)
1690
-        //then we want to make sure we keep all the existing
1691
-        //model objects in sync with the db
1692
-        if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1693
-            if ($this->has_primary_key_field()) {
1694
-                $model_objs_affected_ids = $this->get_col($query_params);
1695
-            } else {
1696
-                //we need to select a bunch of columns and then combine them into the the "index primary key string"s
1697
-                $models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1698
-                $model_objs_affected_ids = array();
1699
-                foreach ($models_affected_key_columns as $row) {
1700
-                    $combined_index_key = $this->get_index_primary_key_string($row);
1701
-                    $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1702
-                }
1703
-            }
1704
-            if (! $model_objs_affected_ids) {
1705
-                //wait wait wait- if nothing was affected let's stop here
1706
-                return 0;
1707
-            }
1708
-            foreach ($model_objs_affected_ids as $id) {
1709
-                $model_obj_in_entity_map = $this->get_from_entity_map($id);
1710
-                if ($model_obj_in_entity_map) {
1711
-                    foreach ($fields_n_values as $field => $new_value) {
1712
-                        $model_obj_in_entity_map->set($field, $new_value);
1713
-                    }
1714
-                }
1715
-            }
1716
-            //if there is a primary key on this model, we can now do a slight optimization
1717
-            if ($this->has_primary_key_field()) {
1718
-                //we already know what we want to update. So let's make the query simpler so it's a little more efficient
1719
-                $query_params = array(
1720
-                    array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1721
-                    'limit'                    => count($model_objs_affected_ids),
1722
-                    'default_where_conditions' => EEM_Base::default_where_conditions_none,
1723
-                );
1724
-            }
1725
-        }
1726
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1727
-        $SQL = "UPDATE "
1728
-               . $model_query_info->get_full_join_sql()
1729
-               . " SET "
1730
-               . $this->_construct_update_sql($fields_n_values)
1731
-               . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1732
-        $rows_affected = $this->_do_wpdb_query('query', array($SQL));
1733
-        /**
1734
-         * Action called after a model update call has been made.
1735
-         *
1736
-         * @param EEM_Base $model
1737
-         * @param array    $fields_n_values the updated fields and their new values
1738
-         * @param array    $query_params    @see EEM_Base::get_all()
1739
-         * @param int      $rows_affected
1740
-         */
1741
-        do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1742
-        return $rows_affected;//how many supposedly got updated
1743
-    }
1744
-
1745
-
1746
-
1747
-    /**
1748
-     * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1749
-     * are teh values of the field specified (or by default the primary key field)
1750
-     * that matched the query params. Note that you should pass the name of the
1751
-     * model FIELD, not the database table's column name.
1752
-     *
1753
-     * @param array  $query_params @see EEM_Base::get_all()
1754
-     * @param string $field_to_select
1755
-     * @return array just like $wpdb->get_col()
1756
-     * @throws \EE_Error
1757
-     */
1758
-    public function get_col($query_params = array(), $field_to_select = null)
1759
-    {
1760
-        if ($field_to_select) {
1761
-            $field = $this->field_settings_for($field_to_select);
1762
-        } elseif ($this->has_primary_key_field()) {
1763
-            $field = $this->get_primary_key_field();
1764
-        } else {
1765
-            //no primary key, just grab the first column
1766
-            $field = reset($this->field_settings());
1767
-        }
1768
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1769
-        $select_expressions = $field->get_qualified_column();
1770
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1771
-        return $this->_do_wpdb_query('get_col', array($SQL));
1772
-    }
1773
-
1774
-
1775
-
1776
-    /**
1777
-     * Returns a single column value for a single row from the database
1778
-     *
1779
-     * @param array  $query_params    @see EEM_Base::get_all()
1780
-     * @param string $field_to_select @see EEM_Base::get_col()
1781
-     * @return string
1782
-     * @throws \EE_Error
1783
-     */
1784
-    public function get_var($query_params = array(), $field_to_select = null)
1785
-    {
1786
-        $query_params['limit'] = 1;
1787
-        $col = $this->get_col($query_params, $field_to_select);
1788
-        if (! empty($col)) {
1789
-            return reset($col);
1790
-        } else {
1791
-            return null;
1792
-        }
1793
-    }
1794
-
1795
-
1796
-
1797
-    /**
1798
-     * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1799
-     * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1800
-     * injection, but currently no further filtering is done
1801
-     *
1802
-     * @global      $wpdb
1803
-     * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1804
-     *                               be updated to in the DB
1805
-     * @return string of SQL
1806
-     * @throws \EE_Error
1807
-     */
1808
-    public function _construct_update_sql($fields_n_values)
1809
-    {
1810
-        /** @type WPDB $wpdb */
1811
-        global $wpdb;
1812
-        $cols_n_values = array();
1813
-        foreach ($fields_n_values as $field_name => $value) {
1814
-            $field_obj = $this->field_settings_for($field_name);
1815
-            //if the value is NULL, we want to assign the value to that.
1816
-            //wpdb->prepare doesn't really handle that properly
1817
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1818
-            $value_sql = $prepared_value === null ? 'NULL'
1819
-                : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1820
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1821
-        }
1822
-        return implode(",", $cols_n_values);
1823
-    }
1824
-
1825
-
1826
-
1827
-    /**
1828
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1829
-     * Performs a HARD delete, meaning the database row should always be removed,
1830
-     * not just have a flag field on it switched
1831
-     * Wrapper for EEM_Base::delete_permanently()
1832
-     *
1833
-     * @param mixed $id
1834
-     * @return boolean whether the row got deleted or not
1835
-     * @throws \EE_Error
1836
-     */
1837
-    public function delete_permanently_by_ID($id)
1838
-    {
1839
-        return $this->delete_permanently(
1840
-            array(
1841
-                array($this->get_primary_key_field()->get_name() => $id),
1842
-                'limit' => 1,
1843
-            )
1844
-        );
1845
-    }
1846
-
1847
-
1848
-
1849
-    /**
1850
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1851
-     * Wrapper for EEM_Base::delete()
1852
-     *
1853
-     * @param mixed $id
1854
-     * @return boolean whether the row got deleted or not
1855
-     * @throws \EE_Error
1856
-     */
1857
-    public function delete_by_ID($id)
1858
-    {
1859
-        return $this->delete(
1860
-            array(
1861
-                array($this->get_primary_key_field()->get_name() => $id),
1862
-                'limit' => 1,
1863
-            )
1864
-        );
1865
-    }
1866
-
1867
-
1868
-
1869
-    /**
1870
-     * Identical to delete_permanently, but does a "soft" delete if possible,
1871
-     * meaning if the model has a field that indicates its been "trashed" or
1872
-     * "soft deleted", we will just set that instead of actually deleting the rows.
1873
-     *
1874
-     * @see EEM_Base::delete_permanently
1875
-     * @param array   $query_params
1876
-     * @param boolean $allow_blocking
1877
-     * @return int how many rows got deleted
1878
-     * @throws \EE_Error
1879
-     */
1880
-    public function delete($query_params, $allow_blocking = true)
1881
-    {
1882
-        return $this->delete_permanently($query_params, $allow_blocking);
1883
-    }
1884
-
1885
-
1886
-
1887
-    /**
1888
-     * Deletes the model objects that meet the query params. Note: this method is overridden
1889
-     * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1890
-     * as archived, not actually deleted
1891
-     *
1892
-     * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1893
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1894
-     *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1895
-     *                                deletes regardless of other objects which may depend on it. Its generally
1896
-     *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1897
-     *                                DB
1898
-     * @return int how many rows got deleted
1899
-     * @throws \EE_Error
1900
-     */
1901
-    public function delete_permanently($query_params, $allow_blocking = true)
1902
-    {
1903
-        /**
1904
-         * Action called just before performing a real deletion query. You can use the
1905
-         * model and its $query_params to find exactly which items will be deleted
1906
-         *
1907
-         * @param EEM_Base $model
1908
-         * @param array    $query_params   @see EEM_Base::get_all()
1909
-         * @param boolean  $allow_blocking whether or not to allow related model objects
1910
-         *                                 to block (prevent) this deletion
1911
-         */
1912
-        do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1913
-        //some MySQL databases may be running safe mode, which may restrict
1914
-        //deletion if there is no KEY column used in the WHERE statement of a deletion.
1915
-        //to get around this, we first do a SELECT, get all the IDs, and then run another query
1916
-        //to delete them
1917
-        $items_for_deletion = $this->_get_all_wpdb_results($query_params);
1918
-        $deletion_where = $this->_setup_ids_for_delete($items_for_deletion, $allow_blocking);
1919
-        if ($deletion_where) {
1920
-            //echo "objects for deletion:";var_dump($objects_for_deletion);
1921
-            $model_query_info = $this->_create_model_query_info_carrier($query_params);
1922
-            $table_aliases = array_keys($this->_tables);
1923
-            $SQL = "DELETE "
1924
-                   . implode(", ", $table_aliases)
1925
-                   . " FROM "
1926
-                   . $model_query_info->get_full_join_sql()
1927
-                   . " WHERE "
1928
-                   . $deletion_where;
1929
-            //		/echo "delete sql:$SQL";
1930
-            $rows_deleted = $this->_do_wpdb_query('query', array($SQL));
1931
-        } else {
1932
-            $rows_deleted = 0;
1933
-        }
1934
-        //and lastly make sure those items are removed from the entity map; if they could be put into it at all
1935
-        if ($this->has_primary_key_field()) {
1936
-            foreach ($items_for_deletion as $item_for_deletion_row) {
1937
-                $pk_value = $item_for_deletion_row[$this->get_primary_key_field()->get_qualified_column()];
1938
-                if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value])) {
1939
-                    unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value]);
1940
-                }
1941
-            }
1942
-        }
1943
-        /**
1944
-         * Action called just after performing a real deletion query. Although at this point the
1945
-         * items should have been deleted
1946
-         *
1947
-         * @param EEM_Base $model
1948
-         * @param array    $query_params @see EEM_Base::get_all()
1949
-         * @param int      $rows_deleted
1950
-         */
1951
-        do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
1952
-        return $rows_deleted;//how many supposedly got deleted
1953
-    }
1954
-
1955
-
1956
-
1957
-    /**
1958
-     * Checks all the relations that throw error messages when there are blocking related objects
1959
-     * for related model objects. If there are any related model objects on those relations,
1960
-     * adds an EE_Error, and return true
1961
-     *
1962
-     * @param EE_Base_Class|int $this_model_obj_or_id
1963
-     * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
1964
-     *                                                 should be ignored when determining whether there are related
1965
-     *                                                 model objects which block this model object's deletion. Useful
1966
-     *                                                 if you know A is related to B and are considering deleting A,
1967
-     *                                                 but want to see if A has any other objects blocking its deletion
1968
-     *                                                 before removing the relation between A and B
1969
-     * @return boolean
1970
-     * @throws \EE_Error
1971
-     */
1972
-    public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
1973
-    {
1974
-        //first, if $ignore_this_model_obj was supplied, get its model
1975
-        if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
1976
-            $ignored_model = $ignore_this_model_obj->get_model();
1977
-        } else {
1978
-            $ignored_model = null;
1979
-        }
1980
-        //now check all the relations of $this_model_obj_or_id and see if there
1981
-        //are any related model objects blocking it?
1982
-        $is_blocked = false;
1983
-        foreach ($this->_model_relations as $relation_name => $relation_obj) {
1984
-            if ($relation_obj->block_delete_if_related_models_exist()) {
1985
-                //if $ignore_this_model_obj was supplied, then for the query
1986
-                //on that model needs to be told to ignore $ignore_this_model_obj
1987
-                if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
1988
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
1989
-                        array(
1990
-                            $ignored_model->get_primary_key_field()->get_name() => array(
1991
-                                '!=',
1992
-                                $ignore_this_model_obj->ID(),
1993
-                            ),
1994
-                        ),
1995
-                    ));
1996
-                } else {
1997
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
1998
-                }
1999
-                if ($related_model_objects) {
2000
-                    EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
2001
-                    $is_blocked = true;
2002
-                }
2003
-            }
2004
-        }
2005
-        return $is_blocked;
2006
-    }
2007
-
2008
-
2009
-
2010
-    /**
2011
-     * This sets up our delete where sql and accounts for if we have secondary tables that will have rows deleted as
2012
-     * well.
2013
-     *
2014
-     * @param  array  $objects_for_deletion This should be the values returned by $this->_get_all_wpdb_results()
2015
-     * @param boolean $allow_blocking       if TRUE, matched objects will only be deleted if there is no related model
2016
-     *                                      info that blocks it (ie, there' sno other data that depends on this data);
2017
-     *                                      if false, deletes regardless of other objects which may depend on it. Its
2018
-     *                                      generally advisable to always leave this as TRUE, otherwise you could
2019
-     *                                      easily corrupt your DB
2020
-     * @throws EE_Error
2021
-     * @return string    everything that comes after the WHERE statement.
2022
-     */
2023
-    protected function _setup_ids_for_delete($objects_for_deletion, $allow_blocking = true)
2024
-    {
2025
-        if ($this->has_primary_key_field()) {
2026
-            $primary_table = $this->_get_main_table();
2027
-            $other_tables = $this->_get_other_tables();
2028
-            $deletes = $query = array();
2029
-            foreach ($objects_for_deletion as $delete_object) {
2030
-                //before we mark this object for deletion,
2031
-                //make sure there's no related objects blocking its deletion (if we're checking)
2032
-                if (
2033
-                    $allow_blocking
2034
-                    && $this->delete_is_blocked_by_related_models(
2035
-                        $delete_object[$primary_table->get_fully_qualified_pk_column()]
2036
-                    )
2037
-                ) {
2038
-                    continue;
2039
-                }
2040
-                //primary table deletes
2041
-                if (isset($delete_object[$primary_table->get_fully_qualified_pk_column()])) {
2042
-                    $deletes[$primary_table->get_fully_qualified_pk_column()][] = $delete_object[$primary_table->get_fully_qualified_pk_column()];
2043
-                }
2044
-                //other tables
2045
-                if (! empty($other_tables)) {
2046
-                    foreach ($other_tables as $ot) {
2047
-                        //first check if we've got the foreign key column here.
2048
-                        if (isset($delete_object[$ot->get_fully_qualified_fk_column()])) {
2049
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_fk_column()];
2050
-                        }
2051
-                        // wait! it's entirely possible that we'll have a the primary key
2052
-                        // for this table in here, if it's a foreign key for one of the other secondary tables
2053
-                        if (isset($delete_object[$ot->get_fully_qualified_pk_column()])) {
2054
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
2055
-                        }
2056
-                        // finally, it is possible that the fk for this table is found
2057
-                        // in the fully qualified pk column for the fk table, so let's see if that's there!
2058
-                        if (isset($delete_object[$ot->get_fully_qualified_pk_on_fk_table()])) {
2059
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
2060
-                        }
2061
-                    }
2062
-                }
2063
-            }
2064
-            //we should have deletes now, so let's just go through and setup the where statement
2065
-            foreach ($deletes as $column => $values) {
2066
-                //make sure we have unique $values;
2067
-                $values = array_unique($values);
2068
-                $query[] = $column . ' IN(' . implode(",", $values) . ')';
2069
-            }
2070
-            return ! empty($query) ? implode(' AND ', $query) : '';
2071
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
2072
-            $ways_to_identify_a_row = array();
2073
-            $fields = $this->get_combined_primary_key_fields();
2074
-            //note: because there' sno primary key, that means nothing else  can be pointing to this model, right?
2075
-            foreach ($objects_for_deletion as $delete_object) {
2076
-                $values_for_each_cpk_for_a_row = array();
2077
-                foreach ($fields as $cpk_field) {
2078
-                    if ($cpk_field instanceof EE_Model_Field_Base) {
2079
-                        $values_for_each_cpk_for_a_row[] = $cpk_field->get_qualified_column()
2080
-                                                           . "="
2081
-                                                           . $delete_object[$cpk_field->get_qualified_column()];
2082
-                    }
2083
-                }
2084
-                $ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
2085
-            }
2086
-            return implode(" OR ", $ways_to_identify_a_row);
2087
-        } else {
2088
-            //so there's no primary key and no combined key...
2089
-            //sorry, can't help you
2090
-            throw new EE_Error(sprintf(__("Cannot delete objects of type %s because there is no primary key NOR combined key",
2091
-                "event_espresso"), get_class($this)));
2092
-        }
2093
-    }
2094
-
2095
-
2096
-
2097
-    /**
2098
-     * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
2099
-     * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
2100
-     * column
2101
-     *
2102
-     * @param array  $query_params   like EEM_Base::get_all's
2103
-     * @param string $field_to_count field on model to count by (not column name)
2104
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2105
-     *                               that by the setting $distinct to TRUE;
2106
-     * @return int
2107
-     * @throws \EE_Error
2108
-     */
2109
-    public function count($query_params = array(), $field_to_count = null, $distinct = false)
2110
-    {
2111
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2112
-        if ($field_to_count) {
2113
-            $field_obj = $this->field_settings_for($field_to_count);
2114
-            $column_to_count = $field_obj->get_qualified_column();
2115
-        } elseif ($this->has_primary_key_field()) {
2116
-            $pk_field_obj = $this->get_primary_key_field();
2117
-            $column_to_count = $pk_field_obj->get_qualified_column();
2118
-        } else {
2119
-            //there's no primary key
2120
-            //if we're counting distinct items, and there's no primary key,
2121
-            //we need to list out the columns for distinction;
2122
-            //otherwise we can just use star
2123
-            if ($distinct) {
2124
-                $columns_to_use = array();
2125
-                foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2126
-                    $columns_to_use[] = $field_obj->get_qualified_column();
2127
-                }
2128
-                $column_to_count = implode(',', $columns_to_use);
2129
-            } else {
2130
-                $column_to_count = '*';
2131
-            }
2132
-        }
2133
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2134
-        $SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2135
-        return (int)$this->_do_wpdb_query('get_var', array($SQL));
2136
-    }
2137
-
2138
-
2139
-
2140
-    /**
2141
-     * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2142
-     *
2143
-     * @param array  $query_params like EEM_Base::get_all
2144
-     * @param string $field_to_sum name of field (array key in $_fields array)
2145
-     * @return float
2146
-     * @throws \EE_Error
2147
-     */
2148
-    public function sum($query_params, $field_to_sum = null)
2149
-    {
2150
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2151
-        if ($field_to_sum) {
2152
-            $field_obj = $this->field_settings_for($field_to_sum);
2153
-        } else {
2154
-            $field_obj = $this->get_primary_key_field();
2155
-        }
2156
-        $column_to_count = $field_obj->get_qualified_column();
2157
-        $SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2158
-        $return_value = $this->_do_wpdb_query('get_var', array($SQL));
2159
-        $data_type = $field_obj->get_wpdb_data_type();
2160
-        if ($data_type === '%d' || $data_type === '%s') {
2161
-            return (float)$return_value;
2162
-        } else {//must be %f
2163
-            return (float)$return_value;
2164
-        }
2165
-    }
2166
-
2167
-
2168
-
2169
-    /**
2170
-     * Just calls the specified method on $wpdb with the given arguments
2171
-     * Consolidates a little extra error handling code
2172
-     *
2173
-     * @param string $wpdb_method
2174
-     * @param array  $arguments_to_provide
2175
-     * @throws EE_Error
2176
-     * @global wpdb  $wpdb
2177
-     * @return mixed
2178
-     */
2179
-    protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2180
-    {
2181
-        //if we're in maintenance mode level 2, DON'T run any queries
2182
-        //because level 2 indicates the database needs updating and
2183
-        //is probably out of sync with the code
2184
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2185
-            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.",
2186
-                "event_espresso")));
2187
-        }
2188
-        /** @type WPDB $wpdb */
2189
-        global $wpdb;
2190
-        if (! method_exists($wpdb, $wpdb_method)) {
2191
-            throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2192
-                'event_espresso'), $wpdb_method));
2193
-        }
2194
-        if (WP_DEBUG) {
2195
-            $old_show_errors_value = $wpdb->show_errors;
2196
-            $wpdb->show_errors(false);
2197
-        }
2198
-        $result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2199
-        $this->show_db_query_if_previously_requested($wpdb->last_query);
2200
-        if (WP_DEBUG) {
2201
-            $wpdb->show_errors($old_show_errors_value);
2202
-            if (! empty($wpdb->last_error)) {
2203
-                throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2204
-            } elseif ($result === false) {
2205
-                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"',
2206
-                    'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2207
-            }
2208
-        } elseif ($result === false) {
2209
-            EE_Error::add_error(
2210
-                sprintf(
2211
-                    __('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"',
2212
-                        'event_espresso'),
2213
-                    $wpdb_method,
2214
-                    var_export($arguments_to_provide, true),
2215
-                    $wpdb->last_error
2216
-                ),
2217
-                __FILE__,
2218
-                __FUNCTION__,
2219
-                __LINE__
2220
-            );
2221
-        }
2222
-        return $result;
2223
-    }
2224
-
2225
-
2226
-
2227
-    /**
2228
-     * Attempts to run the indicated WPDB method with the provided arguments,
2229
-     * and if there's an error tries to verify the DB is correct. Uses
2230
-     * the static property EEM_Base::$_db_verification_level to determine whether
2231
-     * we should try to fix the EE core db, the addons, or just give up
2232
-     *
2233
-     * @param string $wpdb_method
2234
-     * @param array  $arguments_to_provide
2235
-     * @return mixed
2236
-     */
2237
-    private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2238
-    {
2239
-        /** @type WPDB $wpdb */
2240
-        global $wpdb;
2241
-        $wpdb->last_error = null;
2242
-        $result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2243
-        // was there an error running the query? but we don't care on new activations
2244
-        // (we're going to setup the DB anyway on new activations)
2245
-        if (($result === false || ! empty($wpdb->last_error))
2246
-            && EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2247
-        ) {
2248
-            switch (EEM_Base::$_db_verification_level) {
2249
-                case EEM_Base::db_verified_none :
2250
-                    // let's double-check core's DB
2251
-                    $error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2252
-                    break;
2253
-                case EEM_Base::db_verified_core :
2254
-                    // STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2255
-                    $error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2256
-                    break;
2257
-                case EEM_Base::db_verified_addons :
2258
-                    // ummmm... you in trouble
2259
-                    return $result;
2260
-                    break;
2261
-            }
2262
-            if (! empty($error_message)) {
2263
-                EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2264
-                trigger_error($error_message);
2265
-            }
2266
-            return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2267
-        }
2268
-        return $result;
2269
-    }
2270
-
2271
-
2272
-
2273
-    /**
2274
-     * Verifies the EE core database is up-to-date and records that we've done it on
2275
-     * EEM_Base::$_db_verification_level
2276
-     *
2277
-     * @param string $wpdb_method
2278
-     * @param array  $arguments_to_provide
2279
-     * @return string
2280
-     */
2281
-    private function _verify_core_db($wpdb_method, $arguments_to_provide)
2282
-    {
2283
-        /** @type WPDB $wpdb */
2284
-        global $wpdb;
2285
-        //ok remember that we've already attempted fixing the core db, in case the problem persists
2286
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2287
-        $error_message = sprintf(
2288
-            __('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2289
-                'event_espresso'),
2290
-            $wpdb->last_error,
2291
-            $wpdb_method,
2292
-            wp_json_encode($arguments_to_provide)
2293
-        );
2294
-        EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2295
-        return $error_message;
2296
-    }
2297
-
2298
-
2299
-
2300
-    /**
2301
-     * Verifies the EE addons' database is up-to-date and records that we've done it on
2302
-     * EEM_Base::$_db_verification_level
2303
-     *
2304
-     * @param $wpdb_method
2305
-     * @param $arguments_to_provide
2306
-     * @return string
2307
-     */
2308
-    private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2309
-    {
2310
-        /** @type WPDB $wpdb */
2311
-        global $wpdb;
2312
-        //ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2313
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2314
-        $error_message = sprintf(
2315
-            __('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2316
-                'event_espresso'),
2317
-            $wpdb->last_error,
2318
-            $wpdb_method,
2319
-            wp_json_encode($arguments_to_provide)
2320
-        );
2321
-        EE_System::instance()->initialize_addons();
2322
-        return $error_message;
2323
-    }
2324
-
2325
-
2326
-
2327
-    /**
2328
-     * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2329
-     * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2330
-     * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2331
-     * ..."
2332
-     *
2333
-     * @param EE_Model_Query_Info_Carrier $model_query_info
2334
-     * @return string
2335
-     */
2336
-    private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2337
-    {
2338
-        return " FROM " . $model_query_info->get_full_join_sql() .
2339
-               $model_query_info->get_where_sql() .
2340
-               $model_query_info->get_group_by_sql() .
2341
-               $model_query_info->get_having_sql() .
2342
-               $model_query_info->get_order_by_sql() .
2343
-               $model_query_info->get_limit_sql();
2344
-    }
2345
-
2346
-
2347
-
2348
-    /**
2349
-     * Set to easily debug the next X queries ran from this model.
2350
-     *
2351
-     * @param int $count
2352
-     */
2353
-    public function show_next_x_db_queries($count = 1)
2354
-    {
2355
-        $this->_show_next_x_db_queries = $count;
2356
-    }
2357
-
2358
-
2359
-
2360
-    /**
2361
-     * @param $sql_query
2362
-     */
2363
-    public function show_db_query_if_previously_requested($sql_query)
2364
-    {
2365
-        if ($this->_show_next_x_db_queries > 0) {
2366
-            echo $sql_query;
2367
-            $this->_show_next_x_db_queries--;
2368
-        }
2369
-    }
2370
-
2371
-
2372
-
2373
-    /**
2374
-     * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2375
-     * There are the 3 cases:
2376
-     * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2377
-     * $otherModelObject has no ID, it is first saved.
2378
-     * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2379
-     * has no ID, it is first saved.
2380
-     * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2381
-     * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2382
-     * join table
2383
-     *
2384
-     * @param        EE_Base_Class                     /int $thisModelObject
2385
-     * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2386
-     * @param string $relationName                     , key in EEM_Base::_relations
2387
-     *                                                 an attendee to a group, you also want to specify which role they
2388
-     *                                                 will have in that group. So you would use this parameter to
2389
-     *                                                 specify array('role-column-name'=>'role-id')
2390
-     * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2391
-     *                                                 to for relation to methods that allow you to further specify
2392
-     *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2393
-     *                                                 only acceptable query_params is strict "col" => "value" pairs
2394
-     *                                                 because these will be inserted in any new rows created as well.
2395
-     * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2396
-     * @throws \EE_Error
2397
-     */
2398
-    public function add_relationship_to(
2399
-        $id_or_obj,
2400
-        $other_model_id_or_obj,
2401
-        $relationName,
2402
-        $extra_join_model_fields_n_values = array()
2403
-    ) {
2404
-        $relation_obj = $this->related_settings_for($relationName);
2405
-        return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2406
-    }
2407
-
2408
-
2409
-
2410
-    /**
2411
-     * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2412
-     * There are the 3 cases:
2413
-     * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2414
-     * error
2415
-     * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2416
-     * an error
2417
-     * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2418
-     *
2419
-     * @param        EE_Base_Class /int $id_or_obj
2420
-     * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2421
-     * @param string $relationName key in EEM_Base::_relations
2422
-     * @return boolean of success
2423
-     * @throws \EE_Error
2424
-     * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2425
-     *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2426
-     *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2427
-     *                             because these will be inserted in any new rows created as well.
2428
-     */
2429
-    public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2430
-    {
2431
-        $relation_obj = $this->related_settings_for($relationName);
2432
-        return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2433
-    }
2434
-
2435
-
2436
-
2437
-    /**
2438
-     * @param mixed           $id_or_obj
2439
-     * @param string          $relationName
2440
-     * @param array           $where_query_params
2441
-     * @param EE_Base_Class[] objects to which relations were removed
2442
-     * @return \EE_Base_Class[]
2443
-     * @throws \EE_Error
2444
-     */
2445
-    public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2446
-    {
2447
-        $relation_obj = $this->related_settings_for($relationName);
2448
-        return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2449
-    }
2450
-
2451
-
2452
-
2453
-    /**
2454
-     * Gets all the related items of the specified $model_name, using $query_params.
2455
-     * Note: by default, we remove the "default query params"
2456
-     * because we want to get even deleted items etc.
2457
-     *
2458
-     * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2459
-     * @param string $model_name   like 'Event', 'Registration', etc. always singular
2460
-     * @param array  $query_params like EEM_Base::get_all
2461
-     * @return EE_Base_Class[]
2462
-     * @throws \EE_Error
2463
-     */
2464
-    public function get_all_related($id_or_obj, $model_name, $query_params = null)
2465
-    {
2466
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2467
-        $relation_settings = $this->related_settings_for($model_name);
2468
-        return $relation_settings->get_all_related($model_obj, $query_params);
2469
-    }
2470
-
2471
-
2472
-
2473
-    /**
2474
-     * Deletes all the model objects across the relation indicated by $model_name
2475
-     * which are related to $id_or_obj which meet the criteria set in $query_params.
2476
-     * However, if the model objects can't be deleted because of blocking related model objects, then
2477
-     * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2478
-     *
2479
-     * @param EE_Base_Class|int|string $id_or_obj
2480
-     * @param string                   $model_name
2481
-     * @param array                    $query_params
2482
-     * @return int how many deleted
2483
-     * @throws \EE_Error
2484
-     */
2485
-    public function delete_related($id_or_obj, $model_name, $query_params = array())
2486
-    {
2487
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2488
-        $relation_settings = $this->related_settings_for($model_name);
2489
-        return $relation_settings->delete_all_related($model_obj, $query_params);
2490
-    }
2491
-
2492
-
2493
-
2494
-    /**
2495
-     * Hard deletes all the model objects across the relation indicated by $model_name
2496
-     * which are related to $id_or_obj which meet the criteria set in $query_params. If
2497
-     * the model objects can't be hard deleted because of blocking related model objects,
2498
-     * just does a soft-delete on them instead.
2499
-     *
2500
-     * @param EE_Base_Class|int|string $id_or_obj
2501
-     * @param string                   $model_name
2502
-     * @param array                    $query_params
2503
-     * @return int how many deleted
2504
-     * @throws \EE_Error
2505
-     */
2506
-    public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2507
-    {
2508
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2509
-        $relation_settings = $this->related_settings_for($model_name);
2510
-        return $relation_settings->delete_related_permanently($model_obj, $query_params);
2511
-    }
2512
-
2513
-
2514
-
2515
-    /**
2516
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2517
-     * unless otherwise specified in the $query_params
2518
-     *
2519
-     * @param        int             /EE_Base_Class $id_or_obj
2520
-     * @param string $model_name     like 'Event', or 'Registration'
2521
-     * @param array  $query_params   like EEM_Base::get_all's
2522
-     * @param string $field_to_count name of field to count by. By default, uses primary key
2523
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2524
-     *                               that by the setting $distinct to TRUE;
2525
-     * @return int
2526
-     * @throws \EE_Error
2527
-     */
2528
-    public function count_related(
2529
-        $id_or_obj,
2530
-        $model_name,
2531
-        $query_params = array(),
2532
-        $field_to_count = null,
2533
-        $distinct = false
2534
-    ) {
2535
-        $related_model = $this->get_related_model_obj($model_name);
2536
-        //we're just going to use the query params on the related model's normal get_all query,
2537
-        //except add a condition to say to match the current mod
2538
-        if (! isset($query_params['default_where_conditions'])) {
2539
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2540
-        }
2541
-        $this_model_name = $this->get_this_model_name();
2542
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2543
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2544
-        return $related_model->count($query_params, $field_to_count, $distinct);
2545
-    }
2546
-
2547
-
2548
-
2549
-    /**
2550
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
2551
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2552
-     *
2553
-     * @param        int           /EE_Base_Class $id_or_obj
2554
-     * @param string $model_name   like 'Event', or 'Registration'
2555
-     * @param array  $query_params like EEM_Base::get_all's
2556
-     * @param string $field_to_sum name of field to count by. By default, uses primary key
2557
-     * @return float
2558
-     * @throws \EE_Error
2559
-     */
2560
-    public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2561
-    {
2562
-        $related_model = $this->get_related_model_obj($model_name);
2563
-        if (! is_array($query_params)) {
2564
-            EE_Error::doing_it_wrong('EEM_Base::sum_related',
2565
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2566
-                    gettype($query_params)), '4.6.0');
2567
-            $query_params = array();
2568
-        }
2569
-        //we're just going to use the query params on the related model's normal get_all query,
2570
-        //except add a condition to say to match the current mod
2571
-        if (! isset($query_params['default_where_conditions'])) {
2572
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2573
-        }
2574
-        $this_model_name = $this->get_this_model_name();
2575
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2576
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2577
-        return $related_model->sum($query_params, $field_to_sum);
2578
-    }
2579
-
2580
-
2581
-
2582
-    /**
2583
-     * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2584
-     * $modelObject
2585
-     *
2586
-     * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2587
-     * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2588
-     * @param array               $query_params     like EEM_Base::get_all's
2589
-     * @return EE_Base_Class
2590
-     * @throws \EE_Error
2591
-     */
2592
-    public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2593
-    {
2594
-        $query_params['limit'] = 1;
2595
-        $results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2596
-        if ($results) {
2597
-            return array_shift($results);
2598
-        } else {
2599
-            return null;
2600
-        }
2601
-    }
2602
-
2603
-
2604
-
2605
-    /**
2606
-     * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2607
-     *
2608
-     * @return string
2609
-     */
2610
-    public function get_this_model_name()
2611
-    {
2612
-        return str_replace("EEM_", "", get_class($this));
2613
-    }
2614
-
2615
-
2616
-
2617
-    /**
2618
-     * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2619
-     *
2620
-     * @return EE_Any_Foreign_Model_Name_Field
2621
-     * @throws EE_Error
2622
-     */
2623
-    public function get_field_containing_related_model_name()
2624
-    {
2625
-        foreach ($this->field_settings(true) as $field) {
2626
-            if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2627
-                $field_with_model_name = $field;
2628
-            }
2629
-        }
2630
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
2631
-            throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2632
-                $this->get_this_model_name()));
2633
-        }
2634
-        return $field_with_model_name;
2635
-    }
2636
-
2637
-
2638
-
2639
-    /**
2640
-     * Inserts a new entry into the database, for each table.
2641
-     * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2642
-     * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2643
-     * we also know there is no model object with the newly inserted item's ID at the moment (because
2644
-     * if there were, then they would already be in the DB and this would fail); and in the future if someone
2645
-     * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2646
-     * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2647
-     *
2648
-     * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2649
-     *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2650
-     *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2651
-     *                              of EEM_Base)
2652
-     * @return int new primary key on main table that got inserted
2653
-     * @throws EE_Error
2654
-     */
2655
-    public function insert($field_n_values)
2656
-    {
2657
-        /**
2658
-         * Filters the fields and their values before inserting an item using the models
2659
-         *
2660
-         * @param array    $fields_n_values keys are the fields and values are their new values
2661
-         * @param EEM_Base $model           the model used
2662
-         */
2663
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2664
-        if ($this->_satisfies_unique_indexes($field_n_values)) {
2665
-            $main_table = $this->_get_main_table();
2666
-            $new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2667
-            if ($new_id !== false) {
2668
-                foreach ($this->_get_other_tables() as $other_table) {
2669
-                    $this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2670
-                }
2671
-            }
2672
-            /**
2673
-             * Done just after attempting to insert a new model object
2674
-             *
2675
-             * @param EEM_Base   $model           used
2676
-             * @param array      $fields_n_values fields and their values
2677
-             * @param int|string the              ID of the newly-inserted model object
2678
-             */
2679
-            do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2680
-            return $new_id;
2681
-        } else {
2682
-            return false;
2683
-        }
2684
-    }
2685
-
2686
-
2687
-
2688
-    /**
2689
-     * Checks that the result would satisfy the unique indexes on this model
2690
-     *
2691
-     * @param array  $field_n_values
2692
-     * @param string $action
2693
-     * @return boolean
2694
-     * @throws \EE_Error
2695
-     */
2696
-    protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2697
-    {
2698
-        foreach ($this->unique_indexes() as $index_name => $index) {
2699
-            $uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2700
-            if ($this->exists(array($uniqueness_where_params))) {
2701
-                EE_Error::add_error(
2702
-                    sprintf(
2703
-                        __(
2704
-                            "Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2705
-                            "event_espresso"
2706
-                        ),
2707
-                        $action,
2708
-                        $this->_get_class_name(),
2709
-                        $index_name,
2710
-                        implode(",", $index->field_names()),
2711
-                        http_build_query($uniqueness_where_params)
2712
-                    ),
2713
-                    __FILE__,
2714
-                    __FUNCTION__,
2715
-                    __LINE__
2716
-                );
2717
-                return false;
2718
-            }
2719
-        }
2720
-        return true;
2721
-    }
2722
-
2723
-
2724
-
2725
-    /**
2726
-     * Checks the database for an item that conflicts (ie, if this item were
2727
-     * saved to the DB would break some uniqueness requirement, like a primary key
2728
-     * or an index primary key set) with the item specified. $id_obj_or_fields_array
2729
-     * can be either an EE_Base_Class or an array of fields n values
2730
-     *
2731
-     * @param EE_Base_Class|array $obj_or_fields_array
2732
-     * @param boolean             $include_primary_key whether to use the model object's primary key
2733
-     *                                                 when looking for conflicts
2734
-     *                                                 (ie, if false, we ignore the model object's primary key
2735
-     *                                                 when finding "conflicts". If true, it's also considered).
2736
-     *                                                 Only works for INT primary key,
2737
-     *                                                 STRING primary keys cannot be ignored
2738
-     * @throws EE_Error
2739
-     * @return EE_Base_Class|array
2740
-     */
2741
-    public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2742
-    {
2743
-        if ($obj_or_fields_array instanceof EE_Base_Class) {
2744
-            $fields_n_values = $obj_or_fields_array->model_field_array();
2745
-        } elseif (is_array($obj_or_fields_array)) {
2746
-            $fields_n_values = $obj_or_fields_array;
2747
-        } else {
2748
-            throw new EE_Error(
2749
-                sprintf(
2750
-                    __(
2751
-                        "%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2752
-                        "event_espresso"
2753
-                    ),
2754
-                    get_class($this),
2755
-                    $obj_or_fields_array
2756
-                )
2757
-            );
2758
-        }
2759
-        $query_params = array();
2760
-        if ($this->has_primary_key_field()
2761
-            && ($include_primary_key
2762
-                || $this->get_primary_key_field()
2763
-                   instanceof
2764
-                   EE_Primary_Key_String_Field)
2765
-            && isset($fields_n_values[$this->primary_key_name()])
2766
-        ) {
2767
-            $query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2768
-        }
2769
-        foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2770
-            $uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2771
-            $query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2772
-        }
2773
-        //if there is nothing to base this search on, then we shouldn't find anything
2774
-        if (empty($query_params)) {
2775
-            return array();
2776
-        } else {
2777
-            return $this->get_one($query_params);
2778
-        }
2779
-    }
2780
-
2781
-
2782
-
2783
-    /**
2784
-     * Like count, but is optimized and returns a boolean instead of an int
2785
-     *
2786
-     * @param array $query_params
2787
-     * @return boolean
2788
-     * @throws \EE_Error
2789
-     */
2790
-    public function exists($query_params)
2791
-    {
2792
-        $query_params['limit'] = 1;
2793
-        return $this->count($query_params) > 0;
2794
-    }
2795
-
2796
-
2797
-
2798
-    /**
2799
-     * Wrapper for exists, except ignores default query parameters so we're only considering ID
2800
-     *
2801
-     * @param int|string $id
2802
-     * @return boolean
2803
-     * @throws \EE_Error
2804
-     */
2805
-    public function exists_by_ID($id)
2806
-    {
2807
-        return $this->exists(
2808
-            array(
2809
-                'default_where_conditions' => EEM_Base::default_where_conditions_none,
2810
-                array(
2811
-                    $this->primary_key_name() => $id,
2812
-                ),
2813
-            )
2814
-        );
2815
-    }
2816
-
2817
-
2818
-
2819
-    /**
2820
-     * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2821
-     * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2822
-     * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2823
-     * on the main table)
2824
-     * This is protected rather than private because private is not accessible to any child methods and there MAY be
2825
-     * cases where we want to call it directly rather than via insert().
2826
-     *
2827
-     * @access   protected
2828
-     * @param EE_Table_Base $table
2829
-     * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2830
-     *                                       float
2831
-     * @param int           $new_id          for now we assume only int keys
2832
-     * @throws EE_Error
2833
-     * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2834
-     * @return int ID of new row inserted, or FALSE on failure
2835
-     */
2836
-    protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2837
-    {
2838
-        global $wpdb;
2839
-        $insertion_col_n_values = array();
2840
-        $format_for_insertion = array();
2841
-        $fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2842
-        foreach ($fields_on_table as $field_name => $field_obj) {
2843
-            //check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2844
-            if ($field_obj->is_auto_increment()) {
2845
-                continue;
2846
-            }
2847
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2848
-            //if the value we want to assign it to is NULL, just don't mention it for the insertion
2849
-            if ($prepared_value !== null) {
2850
-                $insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2851
-                $format_for_insertion[] = $field_obj->get_wpdb_data_type();
2852
-            }
2853
-        }
2854
-        if ($table instanceof EE_Secondary_Table && $new_id) {
2855
-            //its not the main table, so we should have already saved the main table's PK which we just inserted
2856
-            //so add the fk to the main table as a column
2857
-            $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2858
-            $format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2859
-        }
2860
-        //insert the new entry
2861
-        $result = $this->_do_wpdb_query('insert',
2862
-            array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2863
-        if ($result === false) {
2864
-            return false;
2865
-        }
2866
-        //ok, now what do we return for the ID of the newly-inserted thing?
2867
-        if ($this->has_primary_key_field()) {
2868
-            if ($this->get_primary_key_field()->is_auto_increment()) {
2869
-                return $wpdb->insert_id;
2870
-            } else {
2871
-                //it's not an auto-increment primary key, so
2872
-                //it must have been supplied
2873
-                return $fields_n_values[$this->get_primary_key_field()->get_name()];
2874
-            }
2875
-        } else {
2876
-            //we can't return a  primary key because there is none. instead return
2877
-            //a unique string indicating this model
2878
-            return $this->get_index_primary_key_string($fields_n_values);
2879
-        }
2880
-    }
2881
-
2882
-
2883
-
2884
-    /**
2885
-     * Prepare the $field_obj 's value in $fields_n_values for use in the database.
2886
-     * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
2887
-     * and there is no default, we pass it along. WPDB will take care of it)
2888
-     *
2889
-     * @param EE_Model_Field_Base $field_obj
2890
-     * @param array               $fields_n_values
2891
-     * @return mixed string|int|float depending on what the table column will be expecting
2892
-     * @throws \EE_Error
2893
-     */
2894
-    protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
2895
-    {
2896
-        //if this field doesn't allow nullable, don't allow it
2897
-        if (
2898
-            ! $field_obj->is_nullable()
2899
-            && (
2900
-                ! isset($fields_n_values[$field_obj->get_name()])
2901
-                || $fields_n_values[$field_obj->get_name()] === null
2902
-            )
2903
-        ) {
2904
-            $fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
2905
-        }
2906
-        $unprepared_value = isset($fields_n_values[$field_obj->get_name()])
2907
-            ? $fields_n_values[$field_obj->get_name()]
2908
-            : null;
2909
-        return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
2910
-    }
2911
-
2912
-
2913
-
2914
-    /**
2915
-     * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
2916
-     * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
2917
-     * the field's prepare_for_set() method.
2918
-     *
2919
-     * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
2920
-     *                                   false, otherwise a value in the model object's domain (see lengthy comment at
2921
-     *                                   top of file)
2922
-     * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
2923
-     *                                   $value is a custom selection
2924
-     * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
2925
-     */
2926
-    private function _prepare_value_for_use_in_db($value, $field)
2927
-    {
2928
-        if ($field && $field instanceof EE_Model_Field_Base) {
2929
-            switch ($this->_values_already_prepared_by_model_object) {
2930
-                /** @noinspection PhpMissingBreakStatementInspection */
2931
-                case self::not_prepared_by_model_object:
2932
-                    $value = $field->prepare_for_set($value);
2933
-                //purposefully left out "return"
2934
-                case self::prepared_by_model_object:
2935
-                    $value = $field->prepare_for_use_in_db($value);
2936
-                case self::prepared_for_use_in_db:
2937
-                    //leave the value alone
2938
-            }
2939
-            return $value;
2940
-        } else {
2941
-            return $value;
2942
-        }
2943
-    }
2944
-
2945
-
2946
-
2947
-    /**
2948
-     * Returns the main table on this model
2949
-     *
2950
-     * @return EE_Primary_Table
2951
-     * @throws EE_Error
2952
-     */
2953
-    protected function _get_main_table()
2954
-    {
2955
-        foreach ($this->_tables as $table) {
2956
-            if ($table instanceof EE_Primary_Table) {
2957
-                return $table;
2958
-            }
2959
-        }
2960
-        throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
2961
-            'event_espresso'), get_class($this)));
2962
-    }
2963
-
2964
-
2965
-
2966
-    /**
2967
-     * table
2968
-     * returns EE_Primary_Table table name
2969
-     *
2970
-     * @return string
2971
-     * @throws \EE_Error
2972
-     */
2973
-    public function table()
2974
-    {
2975
-        return $this->_get_main_table()->get_table_name();
2976
-    }
2977
-
2978
-
2979
-
2980
-    /**
2981
-     * table
2982
-     * returns first EE_Secondary_Table table name
2983
-     *
2984
-     * @return string
2985
-     */
2986
-    public function second_table()
2987
-    {
2988
-        // grab second table from tables array
2989
-        $second_table = end($this->_tables);
2990
-        return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
2991
-    }
2992
-
2993
-
2994
-
2995
-    /**
2996
-     * get_table_obj_by_alias
2997
-     * returns table name given it's alias
2998
-     *
2999
-     * @param string $table_alias
3000
-     * @return EE_Primary_Table | EE_Secondary_Table
3001
-     */
3002
-    public function get_table_obj_by_alias($table_alias = '')
3003
-    {
3004
-        return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
3005
-    }
3006
-
3007
-
3008
-
3009
-    /**
3010
-     * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
3011
-     *
3012
-     * @return EE_Secondary_Table[]
3013
-     */
3014
-    protected function _get_other_tables()
3015
-    {
3016
-        $other_tables = array();
3017
-        foreach ($this->_tables as $table_alias => $table) {
3018
-            if ($table instanceof EE_Secondary_Table) {
3019
-                $other_tables[$table_alias] = $table;
3020
-            }
3021
-        }
3022
-        return $other_tables;
3023
-    }
3024
-
3025
-
3026
-
3027
-    /**
3028
-     * Finds all the fields that correspond to the given table
3029
-     *
3030
-     * @param string $table_alias , array key in EEM_Base::_tables
3031
-     * @return EE_Model_Field_Base[]
3032
-     */
3033
-    public function _get_fields_for_table($table_alias)
3034
-    {
3035
-        return $this->_fields[$table_alias];
3036
-    }
3037
-
3038
-
3039
-
3040
-    /**
3041
-     * Recurses through all the where parameters, and finds all the related models we'll need
3042
-     * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
3043
-     * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
3044
-     * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
3045
-     * related Registration, Transaction, and Payment models.
3046
-     *
3047
-     * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
3048
-     * @return EE_Model_Query_Info_Carrier
3049
-     * @throws \EE_Error
3050
-     */
3051
-    public function _extract_related_models_from_query($query_params)
3052
-    {
3053
-        $query_info_carrier = new EE_Model_Query_Info_Carrier();
3054
-        if (array_key_exists(0, $query_params)) {
3055
-            $this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
3056
-        }
3057
-        if (array_key_exists('group_by', $query_params)) {
3058
-            if (is_array($query_params['group_by'])) {
3059
-                $this->_extract_related_models_from_sub_params_array_values(
3060
-                    $query_params['group_by'],
3061
-                    $query_info_carrier,
3062
-                    'group_by'
3063
-                );
3064
-            } elseif (! empty ($query_params['group_by'])) {
3065
-                $this->_extract_related_model_info_from_query_param(
3066
-                    $query_params['group_by'],
3067
-                    $query_info_carrier,
3068
-                    'group_by'
3069
-                );
3070
-            }
3071
-        }
3072
-        if (array_key_exists('having', $query_params)) {
3073
-            $this->_extract_related_models_from_sub_params_array_keys(
3074
-                $query_params[0],
3075
-                $query_info_carrier,
3076
-                'having'
3077
-            );
3078
-        }
3079
-        if (array_key_exists('order_by', $query_params)) {
3080
-            if (is_array($query_params['order_by'])) {
3081
-                $this->_extract_related_models_from_sub_params_array_keys(
3082
-                    $query_params['order_by'],
3083
-                    $query_info_carrier,
3084
-                    'order_by'
3085
-                );
3086
-            } elseif (! empty($query_params['order_by'])) {
3087
-                $this->_extract_related_model_info_from_query_param(
3088
-                    $query_params['order_by'],
3089
-                    $query_info_carrier,
3090
-                    'order_by'
3091
-                );
3092
-            }
3093
-        }
3094
-        if (array_key_exists('force_join', $query_params)) {
3095
-            $this->_extract_related_models_from_sub_params_array_values(
3096
-                $query_params['force_join'],
3097
-                $query_info_carrier,
3098
-                'force_join'
3099
-            );
3100
-        }
3101
-        return $query_info_carrier;
3102
-    }
3103
-
3104
-
3105
-
3106
-    /**
3107
-     * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
3108
-     *
3109
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3110
-     *                                                      $query_params['having']
3111
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3112
-     * @param string                      $query_param_type one of $this->_allowed_query_params
3113
-     * @throws EE_Error
3114
-     * @return \EE_Model_Query_Info_Carrier
3115
-     */
3116
-    private function _extract_related_models_from_sub_params_array_keys(
3117
-        $sub_query_params,
3118
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3119
-        $query_param_type
3120
-    ) {
3121
-        if (! empty($sub_query_params)) {
3122
-            $sub_query_params = (array)$sub_query_params;
3123
-            foreach ($sub_query_params as $param => $possibly_array_of_params) {
3124
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3125
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3126
-                    $query_param_type);
3127
-                //if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3128
-                //indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3129
-                //extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3130
-                //of array('Registration.TXN_ID'=>23)
3131
-                $query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3132
-                if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3133
-                    if (! is_array($possibly_array_of_params)) {
3134
-                        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'))",
3135
-                            "event_espresso"),
3136
-                            $param, $possibly_array_of_params));
3137
-                    } else {
3138
-                        $this->_extract_related_models_from_sub_params_array_keys($possibly_array_of_params,
3139
-                            $model_query_info_carrier, $query_param_type);
3140
-                    }
3141
-                } elseif ($query_param_type === 0 //ie WHERE
3142
-                          && is_array($possibly_array_of_params)
3143
-                          && isset($possibly_array_of_params[2])
3144
-                          && $possibly_array_of_params[2] == true
3145
-                ) {
3146
-                    //then $possible_array_of_params looks something like array('<','DTT_sold',true)
3147
-                    //indicating that $possible_array_of_params[1] is actually a field name,
3148
-                    //from which we should extract query parameters!
3149
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3150
-                        throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3151
-                            "event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3152
-                    }
3153
-                    $this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3154
-                        $model_query_info_carrier, $query_param_type);
3155
-                }
3156
-            }
3157
-        }
3158
-        return $model_query_info_carrier;
3159
-    }
3160
-
3161
-
3162
-
3163
-    /**
3164
-     * For extracting related models from forced_joins, where the array values contain the info about what
3165
-     * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3166
-     *
3167
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3168
-     *                                                      $query_params['having']
3169
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3170
-     * @param string                      $query_param_type one of $this->_allowed_query_params
3171
-     * @throws EE_Error
3172
-     * @return \EE_Model_Query_Info_Carrier
3173
-     */
3174
-    private function _extract_related_models_from_sub_params_array_values(
3175
-        $sub_query_params,
3176
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3177
-        $query_param_type
3178
-    ) {
3179
-        if (! empty($sub_query_params)) {
3180
-            if (! is_array($sub_query_params)) {
3181
-                throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3182
-                    $sub_query_params));
3183
-            }
3184
-            foreach ($sub_query_params as $param) {
3185
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3186
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3187
-                    $query_param_type);
3188
-            }
3189
-        }
3190
-        return $model_query_info_carrier;
3191
-    }
3192
-
3193
-
3194
-
3195
-    /**
3196
-     * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3197
-     * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3198
-     * instead of directly constructing the SQL because often we need to extract info from the $query_params
3199
-     * but use them in a different order. Eg, we need to know what models we are querying
3200
-     * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3201
-     * other models before we can finalize the where clause SQL.
3202
-     *
3203
-     * @param array $query_params
3204
-     * @throws EE_Error
3205
-     * @return EE_Model_Query_Info_Carrier
3206
-     */
3207
-    public function _create_model_query_info_carrier($query_params)
3208
-    {
3209
-        if (! is_array($query_params)) {
3210
-            EE_Error::doing_it_wrong(
3211
-                'EEM_Base::_create_model_query_info_carrier',
3212
-                sprintf(
3213
-                    __(
3214
-                        '$query_params should be an array, you passed a variable of type %s',
3215
-                        'event_espresso'
3216
-                    ),
3217
-                    gettype($query_params)
3218
-                ),
3219
-                '4.6.0'
3220
-            );
3221
-            $query_params = array();
3222
-        }
3223
-        $where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3224
-        //first check if we should alter the query to account for caps or not
3225
-        //because the caps might require us to do extra joins
3226
-        if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3227
-            $query_params[0] = $where_query_params = array_replace_recursive(
3228
-                $where_query_params,
3229
-                $this->caps_where_conditions(
3230
-                    $query_params['caps']
3231
-                )
3232
-            );
3233
-        }
3234
-        $query_object = $this->_extract_related_models_from_query($query_params);
3235
-        //verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3236
-        foreach ($where_query_params as $key => $value) {
3237
-            if (is_int($key)) {
3238
-                throw new EE_Error(
3239
-                    sprintf(
3240
-                        __(
3241
-                            "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.",
3242
-                            "event_espresso"
3243
-                        ),
3244
-                        $key,
3245
-                        var_export($value, true),
3246
-                        var_export($query_params, true),
3247
-                        get_class($this)
3248
-                    )
3249
-                );
3250
-            }
3251
-        }
3252
-        if (
3253
-            array_key_exists('default_where_conditions', $query_params)
3254
-            && ! empty($query_params['default_where_conditions'])
3255
-        ) {
3256
-            $use_default_where_conditions = $query_params['default_where_conditions'];
3257
-        } else {
3258
-            $use_default_where_conditions = EEM_Base::default_where_conditions_all;
3259
-        }
3260
-        $where_query_params = array_merge(
3261
-            $this->_get_default_where_conditions_for_models_in_query(
3262
-                $query_object,
3263
-                $use_default_where_conditions,
3264
-                $where_query_params
3265
-            ),
3266
-            $where_query_params
3267
-        );
3268
-        $query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3269
-        // if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3270
-        // So we need to setup a subquery and use that for the main join.
3271
-        // Note for now this only works on the primary table for the model.
3272
-        // So for instance, you could set the limit array like this:
3273
-        // array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3274
-        if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3275
-            $query_object->set_main_model_join_sql(
3276
-                $this->_construct_limit_join_select(
3277
-                    $query_params['on_join_limit'][0],
3278
-                    $query_params['on_join_limit'][1]
3279
-                )
3280
-            );
3281
-        }
3282
-        //set limit
3283
-        if (array_key_exists('limit', $query_params)) {
3284
-            if (is_array($query_params['limit'])) {
3285
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3286
-                    $e = sprintf(
3287
-                        __(
3288
-                            "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)",
3289
-                            "event_espresso"
3290
-                        ),
3291
-                        http_build_query($query_params['limit'])
3292
-                    );
3293
-                    throw new EE_Error($e . "|" . $e);
3294
-                }
3295
-                //they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3296
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3297
-            } elseif (! empty ($query_params['limit'])) {
3298
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3299
-            }
3300
-        }
3301
-        //set order by
3302
-        if (array_key_exists('order_by', $query_params)) {
3303
-            if (is_array($query_params['order_by'])) {
3304
-                //if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3305
-                //specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3306
-                //including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3307
-                if (array_key_exists('order', $query_params)) {
3308
-                    throw new EE_Error(
3309
-                        sprintf(
3310
-                            __(
3311
-                                "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 ",
3312
-                                "event_espresso"
3313
-                            ),
3314
-                            get_class($this),
3315
-                            implode(", ", array_keys($query_params['order_by'])),
3316
-                            implode(", ", $query_params['order_by']),
3317
-                            $query_params['order']
3318
-                        )
3319
-                    );
3320
-                }
3321
-                $this->_extract_related_models_from_sub_params_array_keys(
3322
-                    $query_params['order_by'],
3323
-                    $query_object,
3324
-                    'order_by'
3325
-                );
3326
-                //assume it's an array of fields to order by
3327
-                $order_array = array();
3328
-                foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3329
-                    $order = $this->_extract_order($order);
3330
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3331
-                }
3332
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3333
-            } elseif (! empty ($query_params['order_by'])) {
3334
-                $this->_extract_related_model_info_from_query_param(
3335
-                    $query_params['order_by'],
3336
-                    $query_object,
3337
-                    'order',
3338
-                    $query_params['order_by']
3339
-                );
3340
-                $order = isset($query_params['order'])
3341
-                    ? $this->_extract_order($query_params['order'])
3342
-                    : 'DESC';
3343
-                $query_object->set_order_by_sql(
3344
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3345
-                );
3346
-            }
3347
-        }
3348
-        //if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3349
-        if (! array_key_exists('order_by', $query_params)
3350
-            && array_key_exists('order', $query_params)
3351
-            && ! empty($query_params['order'])
3352
-        ) {
3353
-            $pk_field = $this->get_primary_key_field();
3354
-            $order = $this->_extract_order($query_params['order']);
3355
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3356
-        }
3357
-        //set group by
3358
-        if (array_key_exists('group_by', $query_params)) {
3359
-            if (is_array($query_params['group_by'])) {
3360
-                //it's an array, so assume we'll be grouping by a bunch of stuff
3361
-                $group_by_array = array();
3362
-                foreach ($query_params['group_by'] as $field_name_to_group_by) {
3363
-                    $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3364
-                }
3365
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3366
-            } elseif (! empty ($query_params['group_by'])) {
3367
-                $query_object->set_group_by_sql(
3368
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3369
-                );
3370
-            }
3371
-        }
3372
-        //set having
3373
-        if (array_key_exists('having', $query_params) && $query_params['having']) {
3374
-            $query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3375
-        }
3376
-        //now, just verify they didn't pass anything wack
3377
-        foreach ($query_params as $query_key => $query_value) {
3378
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
3379
-                throw new EE_Error(
3380
-                    sprintf(
3381
-                        __(
3382
-                            "You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3383
-                            'event_espresso'
3384
-                        ),
3385
-                        $query_key,
3386
-                        get_class($this),
3387
-                        //						print_r( $this->_allowed_query_params, TRUE )
3388
-                        implode(',', $this->_allowed_query_params)
3389
-                    )
3390
-                );
3391
-            }
3392
-        }
3393
-        $main_model_join_sql = $query_object->get_main_model_join_sql();
3394
-        if (empty($main_model_join_sql)) {
3395
-            $query_object->set_main_model_join_sql($this->_construct_internal_join());
3396
-        }
3397
-        return $query_object;
3398
-    }
3399
-
3400
-
3401
-
3402
-    /**
3403
-     * Gets the where conditions that should be imposed on the query based on the
3404
-     * context (eg reading frontend, backend, edit or delete).
3405
-     *
3406
-     * @param string $context one of EEM_Base::valid_cap_contexts()
3407
-     * @return array like EEM_Base::get_all() 's $query_params[0]
3408
-     * @throws \EE_Error
3409
-     */
3410
-    public function caps_where_conditions($context = self::caps_read)
3411
-    {
3412
-        EEM_Base::verify_is_valid_cap_context($context);
3413
-        $cap_where_conditions = array();
3414
-        $cap_restrictions = $this->caps_missing($context);
3415
-        /**
3416
-         * @var $cap_restrictions EE_Default_Where_Conditions[]
3417
-         */
3418
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3419
-            $cap_where_conditions = array_replace_recursive($cap_where_conditions,
3420
-                $restriction_if_no_cap->get_default_where_conditions());
3421
-        }
3422
-        return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3423
-            $cap_restrictions);
3424
-    }
3425
-
3426
-
3427
-
3428
-    /**
3429
-     * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3430
-     * otherwise throws an exception
3431
-     *
3432
-     * @param string $should_be_order_string
3433
-     * @return string either ASC, asc, DESC or desc
3434
-     * @throws EE_Error
3435
-     */
3436
-    private function _extract_order($should_be_order_string)
3437
-    {
3438
-        if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3439
-            return $should_be_order_string;
3440
-        } else {
3441
-            throw new EE_Error(sprintf(__("While performing a query on '%s', tried to use '%s' as an order parameter. ",
3442
-                "event_espresso"), get_class($this), $should_be_order_string));
3443
-        }
3444
-    }
3445
-
3446
-
3447
-
3448
-    /**
3449
-     * Looks at all the models which are included in this query, and asks each
3450
-     * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3451
-     * so they can be merged
3452
-     *
3453
-     * @param EE_Model_Query_Info_Carrier $query_info_carrier
3454
-     * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3455
-     *                                                                  'none' means NO default where conditions will
3456
-     *                                                                  be used AT ALL during this query.
3457
-     *                                                                  'other_models_only' means default where
3458
-     *                                                                  conditions from other models will be used, but
3459
-     *                                                                  not for this primary model. 'all', the default,
3460
-     *                                                                  means default where conditions will apply as
3461
-     *                                                                  normal
3462
-     * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3463
-     * @throws EE_Error
3464
-     * @return array like $query_params[0], see EEM_Base::get_all for documentation
3465
-     */
3466
-    private function _get_default_where_conditions_for_models_in_query(
3467
-        EE_Model_Query_Info_Carrier $query_info_carrier,
3468
-        $use_default_where_conditions = EEM_Base::default_where_conditions_all,
3469
-        $where_query_params = array()
3470
-    ) {
3471
-        $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3472
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3473
-            throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3474
-                "event_espresso"), $use_default_where_conditions,
3475
-                implode(", ", $allowed_used_default_where_conditions_values)));
3476
-        }
3477
-        $universal_query_params = array();
3478
-        if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3479
-            $universal_query_params = $this->_get_default_where_conditions();
3480
-        } else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3481
-            $universal_query_params = $this->_get_minimum_where_conditions();
3482
-        }
3483
-        foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3484
-            $related_model = $this->get_related_model_obj($model_name);
3485
-            if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3486
-                $related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3487
-            } elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3488
-                $related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3489
-            } else {
3490
-                //we don't want to add full or even minimum default where conditions from this model, so just continue
3491
-                continue;
3492
-            }
3493
-            $overrides = $this->_override_defaults_or_make_null_friendly(
3494
-                $related_model_universal_where_params,
3495
-                $where_query_params,
3496
-                $related_model,
3497
-                $model_relation_path
3498
-            );
3499
-            $universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3500
-                $universal_query_params,
3501
-                $overrides
3502
-            );
3503
-        }
3504
-        return $universal_query_params;
3505
-    }
3506
-
3507
-
3508
-
3509
-    /**
3510
-     * Determines whether or not we should use default where conditions for the model in question
3511
-     * (this model, or other related models).
3512
-     * Basically, we should use default where conditions on this model if they have requested to use them on all models,
3513
-     * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3514
-     * We should use default where conditions on related models when they requested to use default where conditions
3515
-     * on all models, or specifically just on other related models
3516
-     * @param      $default_where_conditions_value
3517
-     * @param bool $for_this_model false means this is for OTHER related models
3518
-     * @return bool
3519
-     */
3520
-    private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3521
-    {
3522
-        return (
3523
-                   $for_this_model
3524
-                   && in_array(
3525
-                       $default_where_conditions_value,
3526
-                       array(
3527
-                           EEM_Base::default_where_conditions_all,
3528
-                           EEM_Base::default_where_conditions_this_only,
3529
-                           EEM_Base::default_where_conditions_minimum_others,
3530
-                       ),
3531
-                       true
3532
-                   )
3533
-               )
3534
-               || (
3535
-                   ! $for_this_model
3536
-                   && in_array(
3537
-                       $default_where_conditions_value,
3538
-                       array(
3539
-                           EEM_Base::default_where_conditions_all,
3540
-                           EEM_Base::default_where_conditions_others_only,
3541
-                       ),
3542
-                       true
3543
-                   )
3544
-               );
3545
-    }
3546
-
3547
-    /**
3548
-     * Determines whether or not we should use default minimum conditions for the model in question
3549
-     * (this model, or other related models).
3550
-     * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
3551
-     * where conditions.
3552
-     * We should use minimum where conditions on related models if they requested to use minimum where conditions
3553
-     * on this model or others
3554
-     * @param      $default_where_conditions_value
3555
-     * @param bool $for_this_model false means this is for OTHER related models
3556
-     * @return bool
3557
-     */
3558
-    private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
3559
-    {
3560
-        return (
3561
-                   $for_this_model
3562
-                   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
3563
-               )
3564
-               || (
3565
-                   ! $for_this_model
3566
-                   && in_array(
3567
-                       $default_where_conditions_value,
3568
-                       array(
3569
-                           EEM_Base::default_where_conditions_minimum_others,
3570
-                           EEM_Base::default_where_conditions_minimum_all,
3571
-                       ),
3572
-                       true
3573
-                   )
3574
-               );
3575
-    }
3576
-
3577
-
3578
-    /**
3579
-     * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3580
-     * then we also add a special where condition which allows for that model's primary key
3581
-     * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3582
-     * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3583
-     *
3584
-     * @param array    $default_where_conditions
3585
-     * @param array    $provided_where_conditions
3586
-     * @param EEM_Base $model
3587
-     * @param string   $model_relation_path like 'Transaction.Payment.'
3588
-     * @return array like EEM_Base::get_all's $query_params[0]
3589
-     * @throws \EE_Error
3590
-     */
3591
-    private function _override_defaults_or_make_null_friendly(
3592
-        $default_where_conditions,
3593
-        $provided_where_conditions,
3594
-        $model,
3595
-        $model_relation_path
3596
-    ) {
3597
-        $null_friendly_where_conditions = array();
3598
-        $none_overridden = true;
3599
-        $or_condition_key_for_defaults = 'OR*' . get_class($model);
3600
-        foreach ($default_where_conditions as $key => $val) {
3601
-            if (isset($provided_where_conditions[$key])) {
3602
-                $none_overridden = false;
3603
-            } else {
3604
-                $null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3605
-            }
3606
-        }
3607
-        if ($none_overridden && $default_where_conditions) {
3608
-            if ($model->has_primary_key_field()) {
3609
-                $null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3610
-                                                                                . "."
3611
-                                                                                . $model->primary_key_name()] = array('IS NULL');
3612
-            }/*else{
31
+	//admin posty
32
+	//basic -> grants access to mine -> if they don't have it, select none
33
+	//*_others -> grants access to others that aren't private, and all mine -> if they don't have it, select mine
34
+	//*_private -> grants full access -> if dont have it, select all mine and others' non-private
35
+	//*_published -> grants access to published -> if they dont have it, select non-published
36
+	//*_global/default/system -> grants access to global items -> if they don't have it, select non-global
37
+	//publish_{thing} -> can change status TO publish; SPECIAL CASE
38
+	//frontend posty
39
+	//by default has access to published
40
+	//basic -> grants access to mine that aren't published, and all published
41
+	//*_others ->grants access to others that aren't private, all mine
42
+	//*_private -> grants full access
43
+	//frontend non-posty
44
+	//like admin posty
45
+	//category-y
46
+	//assign -> grants access to join-table
47
+	//(delete, edit)
48
+	//payment-method-y
49
+	//for each registered payment method,
50
+	//ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
51
+	/**
52
+	 * Flag to indicate whether the values provided to EEM_Base have already been prepared
53
+	 * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
54
+	 * They almost always WILL NOT, but it's not necessarily a requirement.
55
+	 * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
56
+	 *
57
+	 * @var boolean
58
+	 */
59
+	private $_values_already_prepared_by_model_object = 0;
60
+
61
+	/**
62
+	 * when $_values_already_prepared_by_model_object equals this, we assume
63
+	 * the data is just like form input that needs to have the model fields'
64
+	 * prepare_for_set and prepare_for_use_in_db called on it
65
+	 */
66
+	const not_prepared_by_model_object = 0;
67
+
68
+	/**
69
+	 * when $_values_already_prepared_by_model_object equals this, we
70
+	 * assume this value is coming from a model object and doesn't need to have
71
+	 * prepare_for_set called on it, just prepare_for_use_in_db is used
72
+	 */
73
+	const prepared_by_model_object = 1;
74
+
75
+	/**
76
+	 * when $_values_already_prepared_by_model_object equals this, we assume
77
+	 * the values are already to be used in the database (ie no processing is done
78
+	 * on them by the model's fields)
79
+	 */
80
+	const prepared_for_use_in_db = 2;
81
+
82
+
83
+	protected $singular_item = 'Item';
84
+
85
+	protected $plural_item   = 'Items';
86
+
87
+	/**
88
+	 * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
89
+	 */
90
+	protected $_tables;
91
+
92
+	/**
93
+	 * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
94
+	 * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
95
+	 * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
96
+	 *
97
+	 * @var \EE_Model_Field_Base[] $_fields
98
+	 */
99
+	protected $_fields;
100
+
101
+	/**
102
+	 * array of different kinds of relations
103
+	 *
104
+	 * @var \EE_Model_Relation_Base[] $_model_relations
105
+	 */
106
+	protected $_model_relations;
107
+
108
+	/**
109
+	 * @var \EE_Index[] $_indexes
110
+	 */
111
+	protected $_indexes = array();
112
+
113
+	/**
114
+	 * Default strategy for getting where conditions on this model. This strategy is used to get default
115
+	 * where conditions which are added to get_all, update, and delete queries. They can be overridden
116
+	 * by setting the same columns as used in these queries in the query yourself.
117
+	 *
118
+	 * @var EE_Default_Where_Conditions
119
+	 */
120
+	protected $_default_where_conditions_strategy;
121
+
122
+	/**
123
+	 * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
124
+	 * This is particularly useful when you want something between 'none' and 'default'
125
+	 *
126
+	 * @var EE_Default_Where_Conditions
127
+	 */
128
+	protected $_minimum_where_conditions_strategy;
129
+
130
+	/**
131
+	 * String describing how to find the "owner" of this model's objects.
132
+	 * When there is a foreign key on this model to the wp_users table, this isn't needed.
133
+	 * But when there isn't, this indicates which related model, or transiently-related model,
134
+	 * has the foreign key to the wp_users table.
135
+	 * Eg, for EEM_Registration this would be 'Event' because registrations are directly
136
+	 * related to events, and events have a foreign key to wp_users.
137
+	 * On EEM_Transaction, this would be 'Transaction.Event'
138
+	 *
139
+	 * @var string
140
+	 */
141
+	protected $_model_chain_to_wp_user = '';
142
+
143
+	/**
144
+	 * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
145
+	 * don't need it (particularly CPT models)
146
+	 *
147
+	 * @var bool
148
+	 */
149
+	protected $_ignore_where_strategy = false;
150
+
151
+	/**
152
+	 * String used in caps relating to this model. Eg, if the caps relating to this
153
+	 * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
154
+	 *
155
+	 * @var string. If null it hasn't been initialized yet. If false then we
156
+	 * have indicated capabilities don't apply to this
157
+	 */
158
+	protected $_caps_slug = null;
159
+
160
+	/**
161
+	 * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
162
+	 * and next-level keys are capability names, and each's value is a
163
+	 * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
164
+	 * they specify which context to use (ie, frontend, backend, edit or delete)
165
+	 * and then each capability in the corresponding sub-array that they're missing
166
+	 * adds the where conditions onto the query.
167
+	 *
168
+	 * @var array
169
+	 */
170
+	protected $_cap_restrictions = array(
171
+		self::caps_read       => array(),
172
+		self::caps_read_admin => array(),
173
+		self::caps_edit       => array(),
174
+		self::caps_delete     => array(),
175
+	);
176
+
177
+	/**
178
+	 * Array defining which cap restriction generators to use to create default
179
+	 * cap restrictions to put in EEM_Base::_cap_restrictions.
180
+	 * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
181
+	 * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
182
+	 * automatically set this to false (not just null).
183
+	 *
184
+	 * @var EE_Restriction_Generator_Base[]
185
+	 */
186
+	protected $_cap_restriction_generators = array();
187
+
188
+	/**
189
+	 * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
190
+	 */
191
+	const caps_read       = 'read';
192
+
193
+	const caps_read_admin = 'read_admin';
194
+
195
+	const caps_edit       = 'edit';
196
+
197
+	const caps_delete     = 'delete';
198
+
199
+	/**
200
+	 * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
201
+	 * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
202
+	 * maps to 'read' because when looking for relevant permissions we're going to use
203
+	 * 'read' in teh capabilities names like 'ee_read_events' etc.
204
+	 *
205
+	 * @var array
206
+	 */
207
+	protected $_cap_contexts_to_cap_action_map = array(
208
+		self::caps_read       => 'read',
209
+		self::caps_read_admin => 'read',
210
+		self::caps_edit       => 'edit',
211
+		self::caps_delete     => 'delete',
212
+	);
213
+
214
+	/**
215
+	 * Timezone
216
+	 * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
217
+	 * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
218
+	 * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
219
+	 * EE_Datetime_Field data type will have access to it.
220
+	 *
221
+	 * @var string
222
+	 */
223
+	protected $_timezone;
224
+
225
+
226
+	/**
227
+	 * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
228
+	 * multisite.
229
+	 *
230
+	 * @var int
231
+	 */
232
+	protected static $_model_query_blog_id;
233
+
234
+	/**
235
+	 * A copy of _fields, except the array keys are the model names pointed to by
236
+	 * the field
237
+	 *
238
+	 * @var EE_Model_Field_Base[]
239
+	 */
240
+	private $_cache_foreign_key_to_fields = array();
241
+
242
+	/**
243
+	 * Cached list of all the fields on the model, indexed by their name
244
+	 *
245
+	 * @var EE_Model_Field_Base[]
246
+	 */
247
+	private $_cached_fields = null;
248
+
249
+	/**
250
+	 * Cached list of all the fields on the model, except those that are
251
+	 * marked as only pertinent to the database
252
+	 *
253
+	 * @var EE_Model_Field_Base[]
254
+	 */
255
+	private $_cached_fields_non_db_only = null;
256
+
257
+	/**
258
+	 * A cached reference to the primary key for quick lookup
259
+	 *
260
+	 * @var EE_Model_Field_Base
261
+	 */
262
+	private $_primary_key_field = null;
263
+
264
+	/**
265
+	 * Flag indicating whether this model has a primary key or not
266
+	 *
267
+	 * @var boolean
268
+	 */
269
+	protected $_has_primary_key_field = null;
270
+
271
+	/**
272
+	 * Whether or not this model is based off a table in WP core only (CPTs should set
273
+	 * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
274
+	 *
275
+	 * @var boolean
276
+	 */
277
+	protected $_wp_core_model = false;
278
+
279
+	/**
280
+	 *    List of valid operators that can be used for querying.
281
+	 * The keys are all operators we'll accept, the values are the real SQL
282
+	 * operators used
283
+	 *
284
+	 * @var array
285
+	 */
286
+	protected $_valid_operators = array(
287
+		'='           => '=',
288
+		'<='          => '<=',
289
+		'<'           => '<',
290
+		'>='          => '>=',
291
+		'>'           => '>',
292
+		'!='          => '!=',
293
+		'LIKE'        => 'LIKE',
294
+		'like'        => 'LIKE',
295
+		'NOT_LIKE'    => 'NOT LIKE',
296
+		'not_like'    => 'NOT LIKE',
297
+		'NOT LIKE'    => 'NOT LIKE',
298
+		'not like'    => 'NOT LIKE',
299
+		'IN'          => 'IN',
300
+		'in'          => 'IN',
301
+		'NOT_IN'      => 'NOT IN',
302
+		'not_in'      => 'NOT IN',
303
+		'NOT IN'      => 'NOT IN',
304
+		'not in'      => 'NOT IN',
305
+		'between'     => 'BETWEEN',
306
+		'BETWEEN'     => 'BETWEEN',
307
+		'IS_NOT_NULL' => 'IS NOT NULL',
308
+		'is_not_null' => 'IS NOT NULL',
309
+		'IS NOT NULL' => 'IS NOT NULL',
310
+		'is not null' => 'IS NOT NULL',
311
+		'IS_NULL'     => 'IS NULL',
312
+		'is_null'     => 'IS NULL',
313
+		'IS NULL'     => 'IS NULL',
314
+		'is null'     => 'IS NULL',
315
+		'REGEXP'      => 'REGEXP',
316
+		'regexp'      => 'REGEXP',
317
+		'NOT_REGEXP'  => 'NOT REGEXP',
318
+		'not_regexp'  => 'NOT REGEXP',
319
+		'NOT REGEXP'  => 'NOT REGEXP',
320
+		'not regexp'  => 'NOT REGEXP',
321
+	);
322
+
323
+	/**
324
+	 * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
325
+	 *
326
+	 * @var array
327
+	 */
328
+	protected $_in_style_operators = array('IN', 'NOT IN');
329
+
330
+	/**
331
+	 * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
332
+	 * '12-31-2012'"
333
+	 *
334
+	 * @var array
335
+	 */
336
+	protected $_between_style_operators = array('BETWEEN');
337
+
338
+	/**
339
+	 * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
340
+	 * on a join table.
341
+	 *
342
+	 * @var array
343
+	 */
344
+	protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
345
+
346
+	/**
347
+	 * Allowed values for $query_params['order'] for ordering in queries
348
+	 *
349
+	 * @var array
350
+	 */
351
+	protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
352
+
353
+	/**
354
+	 * When these are keys in a WHERE or HAVING clause, they are handled much differently
355
+	 * than regular field names. It is assumed that their values are an array of WHERE conditions
356
+	 *
357
+	 * @var array
358
+	 */
359
+	private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
360
+
361
+	/**
362
+	 * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
363
+	 * 'where', but 'where' clauses are so common that we thought we'd omit it
364
+	 *
365
+	 * @var array
366
+	 */
367
+	private $_allowed_query_params = array(
368
+		0,
369
+		'limit',
370
+		'order_by',
371
+		'group_by',
372
+		'having',
373
+		'force_join',
374
+		'order',
375
+		'on_join_limit',
376
+		'default_where_conditions',
377
+		'caps',
378
+	);
379
+
380
+	/**
381
+	 * All the data types that can be used in $wpdb->prepare statements.
382
+	 *
383
+	 * @var array
384
+	 */
385
+	private $_valid_wpdb_data_types = array('%d', '%s', '%f');
386
+
387
+	/**
388
+	 *    EE_Registry Object
389
+	 *
390
+	 * @var    object
391
+	 * @access    protected
392
+	 */
393
+	protected $EE = null;
394
+
395
+
396
+	/**
397
+	 * Property which, when set, will have this model echo out the next X queries to the page for debugging.
398
+	 *
399
+	 * @var int
400
+	 */
401
+	protected $_show_next_x_db_queries = 0;
402
+
403
+	/**
404
+	 * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
405
+	 * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
406
+	 *
407
+	 * @var array
408
+	 */
409
+	protected $_custom_selections = array();
410
+
411
+	/**
412
+	 * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
413
+	 * caches every model object we've fetched from the DB on this request
414
+	 *
415
+	 * @var array
416
+	 */
417
+	protected $_entity_map;
418
+
419
+	/**
420
+	 * constant used to show EEM_Base has not yet verified the db on this http request
421
+	 */
422
+	const db_verified_none = 0;
423
+
424
+	/**
425
+	 * constant used to show EEM_Base has verified the EE core db on this http request,
426
+	 * but not the addons' dbs
427
+	 */
428
+	const db_verified_core = 1;
429
+
430
+	/**
431
+	 * constant used to show EEM_Base has verified the addons' dbs (and implicitly
432
+	 * the EE core db too)
433
+	 */
434
+	const db_verified_addons = 2;
435
+
436
+	/**
437
+	 * indicates whether an EEM_Base child has already re-verified the DB
438
+	 * is ok (we don't want to do it repetitively). Should be set to one the constants
439
+	 * looking like EEM_Base::db_verified_*
440
+	 *
441
+	 * @var int - 0 = none, 1 = core, 2 = addons
442
+	 */
443
+	protected static $_db_verification_level = EEM_Base::db_verified_none;
444
+
445
+	/**
446
+	 * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
447
+	 *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
448
+	 *        registrations for non-trashed tickets for non-trashed datetimes)
449
+	 */
450
+	const default_where_conditions_all = 'all';
451
+
452
+	/**
453
+	 * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
454
+	 *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
455
+	 *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
456
+	 *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
457
+	 *        models which share tables with other models, this can return data for the wrong model.
458
+	 */
459
+	const default_where_conditions_this_only = 'this_model_only';
460
+
461
+	/**
462
+	 * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
463
+	 *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
464
+	 *        return all registrations related to non-trashed tickets and non-trashed datetimes)
465
+	 */
466
+	const default_where_conditions_others_only = 'other_models_only';
467
+
468
+	/**
469
+	 * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
470
+	 *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
471
+	 *        their table with other models, like the Event and Venue models. For example, when querying for events
472
+	 *        ordered by their venues' name, this will be sure to only return real events with associated real venues
473
+	 *        (regardless of whether those events and venues are trashed)
474
+	 *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
475
+	 *        events.
476
+	 */
477
+	const default_where_conditions_minimum_all = 'minimum';
478
+
479
+	/**
480
+	 * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
481
+	 *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
482
+	 *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
483
+	 *        not)
484
+	 */
485
+	const default_where_conditions_minimum_others = 'full_this_minimum_others';
486
+
487
+	/**
488
+	 * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
489
+	 *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
490
+	 *        it's possible it will return table entries for other models. You should use
491
+	 *        EEM_Base::default_where_conditions_minimum_all instead.
492
+	 */
493
+	const default_where_conditions_none = 'none';
494
+
495
+
496
+
497
+	/**
498
+	 * About all child constructors:
499
+	 * they should define the _tables, _fields and _model_relations arrays.
500
+	 * Should ALWAYS be called after child constructor.
501
+	 * In order to make the child constructors to be as simple as possible, this parent constructor
502
+	 * finalizes constructing all the object's attributes.
503
+	 * Generally, rather than requiring a child to code
504
+	 * $this->_tables = array(
505
+	 *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
506
+	 *        ...);
507
+	 *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
508
+	 * each EE_Table has a function to set the table's alias after the constructor, using
509
+	 * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
510
+	 * do something similar.
511
+	 *
512
+	 * @param null $timezone
513
+	 * @throws \EE_Error
514
+	 */
515
+	protected function __construct($timezone = null)
516
+	{
517
+		// check that the model has not been loaded too soon
518
+		if (! did_action('AHEE__EE_System__load_espresso_addons')) {
519
+			throw new EE_Error (
520
+				sprintf(
521
+					__('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.',
522
+						'event_espresso'),
523
+					get_class($this)
524
+				)
525
+			);
526
+		}
527
+		/**
528
+		 * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
529
+		 */
530
+		if (empty(EEM_Base::$_model_query_blog_id)) {
531
+			EEM_Base::set_model_query_blog_id();
532
+		}
533
+		/**
534
+		 * Filters the list of tables on a model. It is best to NOT use this directly and instead
535
+		 * just use EE_Register_Model_Extension
536
+		 *
537
+		 * @var EE_Table_Base[] $_tables
538
+		 */
539
+		$this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
540
+		foreach ($this->_tables as $table_alias => $table_obj) {
541
+			/** @var $table_obj EE_Table_Base */
542
+			$table_obj->_construct_finalize_with_alias($table_alias);
543
+			if ($table_obj instanceof EE_Secondary_Table) {
544
+				/** @var $table_obj EE_Secondary_Table */
545
+				$table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
546
+			}
547
+		}
548
+		/**
549
+		 * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
550
+		 * EE_Register_Model_Extension
551
+		 *
552
+		 * @param EE_Model_Field_Base[] $_fields
553
+		 */
554
+		$this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
555
+		$this->_invalidate_field_caches();
556
+		foreach ($this->_fields as $table_alias => $fields_for_table) {
557
+			if (! array_key_exists($table_alias, $this->_tables)) {
558
+				throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
559
+					'event_espresso'), $table_alias, implode(",", $this->_fields)));
560
+			}
561
+			foreach ($fields_for_table as $field_name => $field_obj) {
562
+				/** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
563
+				//primary key field base has a slightly different _construct_finalize
564
+				/** @var $field_obj EE_Model_Field_Base */
565
+				$field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
566
+			}
567
+		}
568
+		// everything is related to Extra_Meta
569
+		if (get_class($this) !== 'EEM_Extra_Meta') {
570
+			//make extra meta related to everything, but don't block deleting things just
571
+			//because they have related extra meta info. For now just orphan those extra meta
572
+			//in the future we should automatically delete them
573
+			$this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
574
+		}
575
+		//and change logs
576
+		if (get_class($this) !== 'EEM_Change_Log') {
577
+			$this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
578
+		}
579
+		/**
580
+		 * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
581
+		 * EE_Register_Model_Extension
582
+		 *
583
+		 * @param EE_Model_Relation_Base[] $_model_relations
584
+		 */
585
+		$this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
586
+			$this->_model_relations);
587
+		foreach ($this->_model_relations as $model_name => $relation_obj) {
588
+			/** @var $relation_obj EE_Model_Relation_Base */
589
+			$relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
590
+		}
591
+		foreach ($this->_indexes as $index_name => $index_obj) {
592
+			/** @var $index_obj EE_Index */
593
+			$index_obj->_construct_finalize($index_name, $this->get_this_model_name());
594
+		}
595
+		$this->set_timezone($timezone);
596
+		//finalize default where condition strategy, or set default
597
+		if (! $this->_default_where_conditions_strategy) {
598
+			//nothing was set during child constructor, so set default
599
+			$this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
600
+		}
601
+		$this->_default_where_conditions_strategy->_finalize_construct($this);
602
+		if (! $this->_minimum_where_conditions_strategy) {
603
+			//nothing was set during child constructor, so set default
604
+			$this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
605
+		}
606
+		$this->_minimum_where_conditions_strategy->_finalize_construct($this);
607
+		//if the cap slug hasn't been set, and we haven't set it to false on purpose
608
+		//to indicate to NOT set it, set it to the logical default
609
+		if ($this->_caps_slug === null) {
610
+			$this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
611
+		}
612
+		//initialize the standard cap restriction generators if none were specified by the child constructor
613
+		if ($this->_cap_restriction_generators !== false) {
614
+			foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
615
+				if (! isset($this->_cap_restriction_generators[$cap_context])) {
616
+					$this->_cap_restriction_generators[$cap_context] = apply_filters(
617
+						'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
618
+						new EE_Restriction_Generator_Protected(),
619
+						$cap_context,
620
+						$this
621
+					);
622
+				}
623
+			}
624
+		}
625
+		//if there are cap restriction generators, use them to make the default cap restrictions
626
+		if ($this->_cap_restriction_generators !== false) {
627
+			foreach ($this->_cap_restriction_generators as $context => $generator_object) {
628
+				if (! $generator_object) {
629
+					continue;
630
+				}
631
+				if (! $generator_object instanceof EE_Restriction_Generator_Base) {
632
+					throw new EE_Error(
633
+						sprintf(
634
+							__('Index "%1$s" in the model %2$s\'s _cap_restriction_generators is not a child of EE_Restriction_Generator_Base. It should be that or NULL.',
635
+								'event_espresso'),
636
+							$context,
637
+							$this->get_this_model_name()
638
+						)
639
+					);
640
+				}
641
+				$action = $this->cap_action_for_context($context);
642
+				if (! $generator_object->construction_finalized()) {
643
+					$generator_object->_construct_finalize($this, $action);
644
+				}
645
+			}
646
+		}
647
+		do_action('AHEE__' . get_class($this) . '__construct__end');
648
+	}
649
+
650
+
651
+
652
+	/**
653
+	 * Generates the cap restrictions for the given context, or if they were
654
+	 * already generated just gets what's cached
655
+	 *
656
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
657
+	 * @return EE_Default_Where_Conditions[]
658
+	 */
659
+	protected function _generate_cap_restrictions($context)
660
+	{
661
+		if (isset($this->_cap_restriction_generators[$context])
662
+			&& $this->_cap_restriction_generators[$context]
663
+			   instanceof
664
+			   EE_Restriction_Generator_Base
665
+		) {
666
+			return $this->_cap_restriction_generators[$context]->generate_restrictions();
667
+		} else {
668
+			return array();
669
+		}
670
+	}
671
+
672
+
673
+
674
+	/**
675
+	 * Used to set the $_model_query_blog_id static property.
676
+	 *
677
+	 * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
678
+	 *                      value for get_current_blog_id() will be used.
679
+	 */
680
+	public static function set_model_query_blog_id($blog_id = 0)
681
+	{
682
+		EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
683
+	}
684
+
685
+
686
+
687
+	/**
688
+	 * Returns whatever is set as the internal $model_query_blog_id.
689
+	 *
690
+	 * @return int
691
+	 */
692
+	public static function get_model_query_blog_id()
693
+	{
694
+		return EEM_Base::$_model_query_blog_id;
695
+	}
696
+
697
+
698
+
699
+	/**
700
+	 *        This function is a singleton method used to instantiate the Espresso_model object
701
+	 *
702
+	 * @access public
703
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
704
+	 *                         incoming timezone data that gets saved).  Note this just sends the timezone info to the
705
+	 *                         date time model field objects.  Default is NULL (and will be assumed using the set
706
+	 *                         timezone in the 'timezone_string' wp option)
707
+	 * @return static (as in the concrete child class)
708
+	 */
709
+	public static function instance($timezone = null)
710
+	{
711
+		// check if instance of Espresso_model already exists
712
+		if (! static::$_instance instanceof static) {
713
+			// instantiate Espresso_model
714
+			static::$_instance = new static($timezone);
715
+		}
716
+		//we might have a timezone set, let set_timezone decide what to do with it
717
+		static::$_instance->set_timezone($timezone);
718
+		// Espresso_model object
719
+		return static::$_instance;
720
+	}
721
+
722
+
723
+
724
+	/**
725
+	 * resets the model and returns it
726
+	 *
727
+	 * @param null | string $timezone
728
+	 * @return EEM_Base|null (if the model was already instantiated, returns it, with
729
+	 * all its properties reset; if it wasn't instantiated, returns null)
730
+	 */
731
+	public static function reset($timezone = null)
732
+	{
733
+		if (static::$_instance instanceof EEM_Base) {
734
+			//let's try to NOT swap out the current instance for a new one
735
+			//because if someone has a reference to it, we can't remove their reference
736
+			//so it's best to keep using the same reference, but change the original object
737
+			//reset all its properties to their original values as defined in the class
738
+			$r = new ReflectionClass(get_class(static::$_instance));
739
+			$static_properties = $r->getStaticProperties();
740
+			foreach ($r->getDefaultProperties() as $property => $value) {
741
+				//don't set instance to null like it was originally,
742
+				//but it's static anyways, and we're ignoring static properties (for now at least)
743
+				if (! isset($static_properties[$property])) {
744
+					static::$_instance->{$property} = $value;
745
+				}
746
+			}
747
+			//and then directly call its constructor again, like we would if we
748
+			//were creating a new one
749
+			static::$_instance->__construct($timezone);
750
+			return self::instance();
751
+		}
752
+		return null;
753
+	}
754
+
755
+
756
+
757
+	/**
758
+	 * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
759
+	 *
760
+	 * @param  boolean $translated return localized strings or JUST the array.
761
+	 * @return array
762
+	 * @throws \EE_Error
763
+	 */
764
+	public function status_array($translated = false)
765
+	{
766
+		if (! array_key_exists('Status', $this->_model_relations)) {
767
+			return array();
768
+		}
769
+		$model_name = $this->get_this_model_name();
770
+		$status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
771
+		$stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
772
+		$status_array = array();
773
+		foreach ($stati as $status) {
774
+			$status_array[$status->ID()] = $status->get('STS_code');
775
+		}
776
+		return $translated
777
+			? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
778
+			: $status_array;
779
+	}
780
+
781
+
782
+
783
+	/**
784
+	 * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
785
+	 *
786
+	 * @param array $query_params             {
787
+	 * @var array $0 (where) array {
788
+	 *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
789
+	 *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
790
+	 *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
791
+	 *                                        conditions based on related models (and even
792
+	 *                                        models-related-to-related-models) prepend the model's name onto the field
793
+	 *                                        name. Eg,
794
+	 *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
795
+	 *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
796
+	 *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
797
+	 *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
798
+	 *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
799
+	 *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
800
+	 *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
801
+	 *                                        to Venues (even when each of those models actually consisted of two
802
+	 *                                        tables). Also, you may chain the model relations together. Eg instead of
803
+	 *                                        just having
804
+	 *                                        "Venue.VNU_ID", you could have
805
+	 *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
806
+	 *                                        events are related to Registrations, which are related to Attendees). You
807
+	 *                                        can take it even further with
808
+	 *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
809
+	 *                                        (from the default of '='), change the value to an numerically-indexed
810
+	 *                                        array, where the first item in the list is the operator. eg: array(
811
+	 *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
812
+	 *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
813
+	 *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
814
+	 *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
815
+	 *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
816
+	 *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
817
+	 *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
818
+	 *                                        the operator is IN. Also, values can actually be field names. To indicate
819
+	 *                                        the value is a field, simply provide a third array item (true) to the
820
+	 *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
821
+	 *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
822
+	 *                                        Note: you can also use related model field names like you would any other
823
+	 *                                        field name. eg:
824
+	 *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
825
+	 *                                        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__>' =>
826
+	 *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
827
+	 *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
828
+	 *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
829
+	 *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
830
+	 *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
831
+	 *                                        to be what you last specified. IE, "AND"s by default, but if you had
832
+	 *                                        previously specified to use ORs to join, ORs will continue to be used.
833
+	 *                                        So, if you specify to use an "OR" to join conditions, it will continue to
834
+	 *                                        "stick" until you specify an AND. eg
835
+	 *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
836
+	 *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
837
+	 *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
838
+	 *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
839
+	 *                                        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 >>
840
+	 *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
841
+	 *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
842
+	 *                                        too, eg:
843
+	 *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
844
+	 * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
845
+	 *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
846
+	 *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
847
+	 *                                        Remember when you provide two numbers for the limit, the 1st number is
848
+	 *                                        the OFFSET, the 2nd is the LIMIT
849
+	 * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
850
+	 *                                        can do paging on one-to-many multi-table-joins. Send an array in the
851
+	 *                                        following format array('on_join_limit'
852
+	 *                                        => array( 'table_alias', array(1,2) ) ).
853
+	 * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
854
+	 *                                        values are either 'ASC' or 'DESC'.
855
+	 *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
856
+	 *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
857
+	 *                                        DESC..." respectively. Like the
858
+	 *                                        'where' conditions, these fields can be on related models. Eg
859
+	 *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
860
+	 *                                        perfectly valid from any model related to 'Registration' (like Event,
861
+	 *                                        Attendee, Price, Datetime, etc.)
862
+	 * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
863
+	 *                                        'order' specifies whether to order the field specified in 'order_by' in
864
+	 *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
865
+	 *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
866
+	 *                                        order by the primary key. Eg,
867
+	 *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
868
+	 *                                        //(will join with the Datetime model's table(s) and order by its field
869
+	 *                                        DTT_EVT_start) or
870
+	 *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
871
+	 *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
872
+	 * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
873
+	 *                                        'group_by'=>'VNU_ID', or
874
+	 *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
875
+	 *                                        if no
876
+	 *                                        $group_by is specified, and a limit is set, automatically groups by the
877
+	 *                                        model's primary key (or combined primary keys). This avoids some
878
+	 *                                        weirdness that results when using limits, tons of joins, and no group by,
879
+	 *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
880
+	 * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
881
+	 *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
882
+	 *                                        results)
883
+	 * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
884
+	 *                                        array where values are models to be joined in the query.Eg
885
+	 *                                        array('Attendee','Payment','Datetime'). You may join with transient
886
+	 *                                        models using period, eg "Registration.Transaction.Payment". You will
887
+	 *                                        probably only want to do this in hopes of increasing efficiency, as
888
+	 *                                        related models which belongs to the current model
889
+	 *                                        (ie, the current model has a foreign key to them, like how Registration
890
+	 *                                        belongs to Attendee) can be cached in order to avoid future queries
891
+	 * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
892
+	 *                                        set this to 'none' to disable all default where conditions. Eg, usually
893
+	 *                                        soft-deleted objects are filtered-out if you want to include them, set
894
+	 *                                        this query param to 'none'. If you want to ONLY disable THIS model's
895
+	 *                                        default where conditions set it to 'other_models_only'. If you only want
896
+	 *                                        this model's default where conditions added to the query, use
897
+	 *                                        'this_model_only'. If you want to use all default where conditions
898
+	 *                                        (default), set to 'all'.
899
+	 * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
900
+	 *                                        we just NOT apply any capabilities/permissions/restrictions and return
901
+	 *                                        everything? Or should we only show the current user items they should be
902
+	 *                                        able to view on the frontend, backend, edit, or delete? can be set to
903
+	 *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
904
+	 *                                        }
905
+	 * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
906
+	 *                                        from EE_Base_Class[], use _get_all_wpdb_results()and make it public
907
+	 *                                        again. Array keys are object IDs (if there is a primary key on the model.
908
+	 *                                        if not, numerically indexed) Some full examples: get 10 transactions
909
+	 *                                        which have Scottish attendees: EEM_Transaction::instance()->get_all(
910
+	 *                                        array( array(
911
+	 *                                        'OR'=>array(
912
+	 *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
913
+	 *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
914
+	 *                                        )
915
+	 *                                        ),
916
+	 *                                        'limit'=>10,
917
+	 *                                        'group_by'=>'TXN_ID'
918
+	 *                                        ));
919
+	 *                                        get all the answers to the question titled "shirt size" for event with id
920
+	 *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
921
+	 *                                        'Question.QST_display_text'=>'shirt size',
922
+	 *                                        'Registration.Event.EVT_ID'=>12
923
+	 *                                        ),
924
+	 *                                        'order_by'=>array('ANS_value'=>'ASC')
925
+	 *                                        ));
926
+	 * @throws \EE_Error
927
+	 */
928
+	public function get_all($query_params = array())
929
+	{
930
+		if (isset($query_params['limit'])
931
+			&& ! isset($query_params['group_by'])
932
+		) {
933
+			$query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
934
+		}
935
+		return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
936
+	}
937
+
938
+
939
+
940
+	/**
941
+	 * Modifies the query parameters so we only get back model objects
942
+	 * that "belong" to the current user
943
+	 *
944
+	 * @param array $query_params @see EEM_Base::get_all()
945
+	 * @return array like EEM_Base::get_all
946
+	 */
947
+	public function alter_query_params_to_only_include_mine($query_params = array())
948
+	{
949
+		$wp_user_field_name = $this->wp_user_field_name();
950
+		if ($wp_user_field_name) {
951
+			$query_params[0][$wp_user_field_name] = get_current_user_id();
952
+		}
953
+		return $query_params;
954
+	}
955
+
956
+
957
+
958
+	/**
959
+	 * Returns the name of the field's name that points to the WP_User table
960
+	 *  on this model (or follows the _model_chain_to_wp_user and uses that model's
961
+	 * foreign key to the WP_User table)
962
+	 *
963
+	 * @return string|boolean string on success, boolean false when there is no
964
+	 * foreign key to the WP_User table
965
+	 */
966
+	public function wp_user_field_name()
967
+	{
968
+		try {
969
+			if (! empty($this->_model_chain_to_wp_user)) {
970
+				$models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
971
+				$last_model_name = end($models_to_follow_to_wp_users);
972
+				$model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
973
+				$model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
974
+			} else {
975
+				$model_with_fk_to_wp_users = $this;
976
+				$model_chain_to_wp_user = '';
977
+			}
978
+			$wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
979
+			return $model_chain_to_wp_user . $wp_user_field->get_name();
980
+		} catch (EE_Error $e) {
981
+			return false;
982
+		}
983
+	}
984
+
985
+
986
+
987
+	/**
988
+	 * Returns the _model_chain_to_wp_user string, which indicates which related model
989
+	 * (or transiently-related model) has a foreign key to the wp_users table;
990
+	 * useful for finding if model objects of this type are 'owned' by the current user.
991
+	 * This is an empty string when the foreign key is on this model and when it isn't,
992
+	 * but is only non-empty when this model's ownership is indicated by a RELATED model
993
+	 * (or transiently-related model)
994
+	 *
995
+	 * @return string
996
+	 */
997
+	public function model_chain_to_wp_user()
998
+	{
999
+		return $this->_model_chain_to_wp_user;
1000
+	}
1001
+
1002
+
1003
+
1004
+	/**
1005
+	 * Whether this model is 'owned' by a specific wordpress user (even indirectly,
1006
+	 * like how registrations don't have a foreign key to wp_users, but the
1007
+	 * events they are for are), or is unrelated to wp users.
1008
+	 * generally available
1009
+	 *
1010
+	 * @return boolean
1011
+	 */
1012
+	public function is_owned()
1013
+	{
1014
+		if ($this->model_chain_to_wp_user()) {
1015
+			return true;
1016
+		} else {
1017
+			try {
1018
+				$this->get_foreign_key_to('WP_User');
1019
+				return true;
1020
+			} catch (EE_Error $e) {
1021
+				return false;
1022
+			}
1023
+		}
1024
+	}
1025
+
1026
+
1027
+
1028
+	/**
1029
+	 * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
1030
+	 * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
1031
+	 * the model)
1032
+	 *
1033
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
1034
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1035
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1036
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
1037
+	 *                                  override this and set the select to "*", or a specific column name, like
1038
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1039
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1040
+	 *                                  the aliases used to refer to this selection, and values are to be
1041
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1042
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1043
+	 * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1044
+	 * @throws \EE_Error
1045
+	 */
1046
+	protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1047
+	{
1048
+		// remember the custom selections, if any, and type cast as array
1049
+		// (unless $columns_to_select is an object, then just set as an empty array)
1050
+		// Note: (array) 'some string' === array( 'some string' )
1051
+		$this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1052
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1053
+		$select_expressions = $columns_to_select !== null
1054
+			? $this->_construct_select_from_input($columns_to_select)
1055
+			: $this->_construct_default_select_sql($model_query_info);
1056
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1057
+		return $this->_do_wpdb_query('get_results', array($SQL, $output));
1058
+	}
1059
+
1060
+
1061
+
1062
+	/**
1063
+	 * Gets an array of rows from the database just like $wpdb->get_results would,
1064
+	 * but you can use the $query_params like on EEM_Base::get_all() to more easily
1065
+	 * take care of joins, field preparation etc.
1066
+	 *
1067
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
1068
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1069
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1070
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
1071
+	 *                                  override this and set the select to "*", or a specific column name, like
1072
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1073
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1074
+	 *                                  the aliases used to refer to this selection, and values are to be
1075
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1076
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1077
+	 * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1078
+	 * @throws \EE_Error
1079
+	 */
1080
+	public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1081
+	{
1082
+		return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
1083
+	}
1084
+
1085
+
1086
+
1087
+	/**
1088
+	 * For creating a custom select statement
1089
+	 *
1090
+	 * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
1091
+	 *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
1092
+	 *                                 SQL, and 1=>is the datatype
1093
+	 * @throws EE_Error
1094
+	 * @return string
1095
+	 */
1096
+	private function _construct_select_from_input($columns_to_select)
1097
+	{
1098
+		if (is_array($columns_to_select)) {
1099
+			$select_sql_array = array();
1100
+			foreach ($columns_to_select as $alias => $selection_and_datatype) {
1101
+				if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1102
+					throw new EE_Error(
1103
+						sprintf(
1104
+							__(
1105
+								"Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1106
+								"event_espresso"
1107
+							),
1108
+							$selection_and_datatype,
1109
+							$alias
1110
+						)
1111
+					);
1112
+				}
1113
+				if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1114
+					throw new EE_Error(
1115
+						sprintf(
1116
+							__(
1117
+								"Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1118
+								"event_espresso"
1119
+							),
1120
+							$selection_and_datatype[1],
1121
+							$selection_and_datatype[0],
1122
+							$alias,
1123
+							implode(",", $this->_valid_wpdb_data_types)
1124
+						)
1125
+					);
1126
+				}
1127
+				$select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1128
+			}
1129
+			$columns_to_select_string = implode(", ", $select_sql_array);
1130
+		} else {
1131
+			$columns_to_select_string = $columns_to_select;
1132
+		}
1133
+		return $columns_to_select_string;
1134
+	}
1135
+
1136
+
1137
+
1138
+	/**
1139
+	 * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1140
+	 *
1141
+	 * @return string
1142
+	 * @throws \EE_Error
1143
+	 */
1144
+	public function primary_key_name()
1145
+	{
1146
+		return $this->get_primary_key_field()->get_name();
1147
+	}
1148
+
1149
+
1150
+
1151
+	/**
1152
+	 * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1153
+	 * If there is no primary key on this model, $id is treated as primary key string
1154
+	 *
1155
+	 * @param mixed $id int or string, depending on the type of the model's primary key
1156
+	 * @return EE_Base_Class
1157
+	 */
1158
+	public function get_one_by_ID($id)
1159
+	{
1160
+		if ($this->get_from_entity_map($id)) {
1161
+			return $this->get_from_entity_map($id);
1162
+		}
1163
+		return $this->get_one(
1164
+			$this->alter_query_params_to_restrict_by_ID(
1165
+				$id,
1166
+				array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
1167
+			)
1168
+		);
1169
+	}
1170
+
1171
+
1172
+
1173
+	/**
1174
+	 * Alters query parameters to only get items with this ID are returned.
1175
+	 * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1176
+	 * or could just be a simple primary key ID
1177
+	 *
1178
+	 * @param int   $id
1179
+	 * @param array $query_params
1180
+	 * @return array of normal query params, @see EEM_Base::get_all
1181
+	 * @throws \EE_Error
1182
+	 */
1183
+	public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1184
+	{
1185
+		if (! isset($query_params[0])) {
1186
+			$query_params[0] = array();
1187
+		}
1188
+		$conditions_from_id = $this->parse_index_primary_key_string($id);
1189
+		if ($conditions_from_id === null) {
1190
+			$query_params[0][$this->primary_key_name()] = $id;
1191
+		} else {
1192
+			//no primary key, so the $id must be from the get_index_primary_key_string()
1193
+			$query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1194
+		}
1195
+		return $query_params;
1196
+	}
1197
+
1198
+
1199
+
1200
+	/**
1201
+	 * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1202
+	 * array. If no item is found, null is returned.
1203
+	 *
1204
+	 * @param array $query_params like EEM_Base's $query_params variable.
1205
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1206
+	 * @throws \EE_Error
1207
+	 */
1208
+	public function get_one($query_params = array())
1209
+	{
1210
+		if (! is_array($query_params)) {
1211
+			EE_Error::doing_it_wrong('EEM_Base::get_one',
1212
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1213
+					gettype($query_params)), '4.6.0');
1214
+			$query_params = array();
1215
+		}
1216
+		$query_params['limit'] = 1;
1217
+		$items = $this->get_all($query_params);
1218
+		if (empty($items)) {
1219
+			return null;
1220
+		} else {
1221
+			return array_shift($items);
1222
+		}
1223
+	}
1224
+
1225
+
1226
+
1227
+	/**
1228
+	 * Returns the next x number of items in sequence from the given value as
1229
+	 * found in the database matching the given query conditions.
1230
+	 *
1231
+	 * @param mixed $current_field_value    Value used for the reference point.
1232
+	 * @param null  $field_to_order_by      What field is used for the
1233
+	 *                                      reference point.
1234
+	 * @param int   $limit                  How many to return.
1235
+	 * @param array $query_params           Extra conditions on the query.
1236
+	 * @param null  $columns_to_select      If left null, then an array of
1237
+	 *                                      EE_Base_Class objects is returned,
1238
+	 *                                      otherwise you can indicate just the
1239
+	 *                                      columns you want returned.
1240
+	 * @return EE_Base_Class[]|array
1241
+	 * @throws \EE_Error
1242
+	 */
1243
+	public function next_x(
1244
+		$current_field_value,
1245
+		$field_to_order_by = null,
1246
+		$limit = 1,
1247
+		$query_params = array(),
1248
+		$columns_to_select = null
1249
+	) {
1250
+		return $this->_get_consecutive($current_field_value, '>', $field_to_order_by, $limit, $query_params,
1251
+			$columns_to_select);
1252
+	}
1253
+
1254
+
1255
+
1256
+	/**
1257
+	 * Returns the previous x number of items in sequence from the given value
1258
+	 * as found in the database matching the given query conditions.
1259
+	 *
1260
+	 * @param mixed $current_field_value    Value used for the reference point.
1261
+	 * @param null  $field_to_order_by      What field is used for the
1262
+	 *                                      reference point.
1263
+	 * @param int   $limit                  How many to return.
1264
+	 * @param array $query_params           Extra conditions on the query.
1265
+	 * @param null  $columns_to_select      If left null, then an array of
1266
+	 *                                      EE_Base_Class objects is returned,
1267
+	 *                                      otherwise you can indicate just the
1268
+	 *                                      columns you want returned.
1269
+	 * @return EE_Base_Class[]|array
1270
+	 * @throws \EE_Error
1271
+	 */
1272
+	public function previous_x(
1273
+		$current_field_value,
1274
+		$field_to_order_by = null,
1275
+		$limit = 1,
1276
+		$query_params = array(),
1277
+		$columns_to_select = null
1278
+	) {
1279
+		return $this->_get_consecutive($current_field_value, '<', $field_to_order_by, $limit, $query_params,
1280
+			$columns_to_select);
1281
+	}
1282
+
1283
+
1284
+
1285
+	/**
1286
+	 * Returns the next item in sequence from the given value as found in the
1287
+	 * database matching the given query conditions.
1288
+	 *
1289
+	 * @param mixed $current_field_value    Value used for the reference point.
1290
+	 * @param null  $field_to_order_by      What field is used for the
1291
+	 *                                      reference point.
1292
+	 * @param array $query_params           Extra conditions on the query.
1293
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1294
+	 *                                      object is returned, otherwise you
1295
+	 *                                      can indicate just the columns you
1296
+	 *                                      want and a single array indexed by
1297
+	 *                                      the columns will be returned.
1298
+	 * @return EE_Base_Class|null|array()
1299
+	 * @throws \EE_Error
1300
+	 */
1301
+	public function next(
1302
+		$current_field_value,
1303
+		$field_to_order_by = null,
1304
+		$query_params = array(),
1305
+		$columns_to_select = null
1306
+	) {
1307
+		$results = $this->_get_consecutive($current_field_value, '>', $field_to_order_by, 1, $query_params,
1308
+			$columns_to_select);
1309
+		return empty($results) ? null : reset($results);
1310
+	}
1311
+
1312
+
1313
+
1314
+	/**
1315
+	 * Returns the previous item in sequence from the given value as found in
1316
+	 * the database matching the given query conditions.
1317
+	 *
1318
+	 * @param mixed $current_field_value    Value used for the reference point.
1319
+	 * @param null  $field_to_order_by      What field is used for the
1320
+	 *                                      reference point.
1321
+	 * @param array $query_params           Extra conditions on the query.
1322
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1323
+	 *                                      object is returned, otherwise you
1324
+	 *                                      can indicate just the columns you
1325
+	 *                                      want and a single array indexed by
1326
+	 *                                      the columns will be returned.
1327
+	 * @return EE_Base_Class|null|array()
1328
+	 * @throws EE_Error
1329
+	 */
1330
+	public function previous(
1331
+		$current_field_value,
1332
+		$field_to_order_by = null,
1333
+		$query_params = array(),
1334
+		$columns_to_select = null
1335
+	) {
1336
+		$results = $this->_get_consecutive($current_field_value, '<', $field_to_order_by, 1, $query_params,
1337
+			$columns_to_select);
1338
+		return empty($results) ? null : reset($results);
1339
+	}
1340
+
1341
+
1342
+
1343
+	/**
1344
+	 * Returns the a consecutive number of items in sequence from the given
1345
+	 * value as found in the database matching the given query conditions.
1346
+	 *
1347
+	 * @param mixed  $current_field_value   Value used for the reference point.
1348
+	 * @param string $operand               What operand is used for the sequence.
1349
+	 * @param string $field_to_order_by     What field is used for the reference point.
1350
+	 * @param int    $limit                 How many to return.
1351
+	 * @param array  $query_params          Extra conditions on the query.
1352
+	 * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1353
+	 *                                      otherwise you can indicate just the columns you want returned.
1354
+	 * @return EE_Base_Class[]|array
1355
+	 * @throws EE_Error
1356
+	 */
1357
+	protected function _get_consecutive(
1358
+		$current_field_value,
1359
+		$operand = '>',
1360
+		$field_to_order_by = null,
1361
+		$limit = 1,
1362
+		$query_params = array(),
1363
+		$columns_to_select = null
1364
+	) {
1365
+		//if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1366
+		if (empty($field_to_order_by)) {
1367
+			if ($this->has_primary_key_field()) {
1368
+				$field_to_order_by = $this->get_primary_key_field()->get_name();
1369
+			} else {
1370
+				if (WP_DEBUG) {
1371
+					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).',
1372
+						'event_espresso'));
1373
+				}
1374
+				EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1375
+				return array();
1376
+			}
1377
+		}
1378
+		if (! is_array($query_params)) {
1379
+			EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1380
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1381
+					gettype($query_params)), '4.6.0');
1382
+			$query_params = array();
1383
+		}
1384
+		//let's add the where query param for consecutive look up.
1385
+		$query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1386
+		$query_params['limit'] = $limit;
1387
+		//set direction
1388
+		$incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1389
+		$query_params['order_by'] = $operand === '>'
1390
+			? array($field_to_order_by => 'ASC') + $incoming_orderby
1391
+			: array($field_to_order_by => 'DESC') + $incoming_orderby;
1392
+		//if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1393
+		if (empty($columns_to_select)) {
1394
+			return $this->get_all($query_params);
1395
+		} else {
1396
+			//getting just the fields
1397
+			return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1398
+		}
1399
+	}
1400
+
1401
+
1402
+
1403
+	/**
1404
+	 * This sets the _timezone property after model object has been instantiated.
1405
+	 *
1406
+	 * @param null | string $timezone valid PHP DateTimeZone timezone string
1407
+	 */
1408
+	public function set_timezone($timezone)
1409
+	{
1410
+		if ($timezone !== null) {
1411
+			$this->_timezone = $timezone;
1412
+		}
1413
+		//note we need to loop through relations and set the timezone on those objects as well.
1414
+		foreach ($this->_model_relations as $relation) {
1415
+			$relation->set_timezone($timezone);
1416
+		}
1417
+		//and finally we do the same for any datetime fields
1418
+		foreach ($this->_fields as $field) {
1419
+			if ($field instanceof EE_Datetime_Field) {
1420
+				$field->set_timezone($timezone);
1421
+			}
1422
+		}
1423
+	}
1424
+
1425
+
1426
+
1427
+	/**
1428
+	 * This just returns whatever is set for the current timezone.
1429
+	 *
1430
+	 * @access public
1431
+	 * @return string
1432
+	 */
1433
+	public function get_timezone()
1434
+	{
1435
+		//first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1436
+		if (empty($this->_timezone)) {
1437
+			foreach ($this->_fields as $field) {
1438
+				if ($field instanceof EE_Datetime_Field) {
1439
+					$this->set_timezone($field->get_timezone());
1440
+					break;
1441
+				}
1442
+			}
1443
+		}
1444
+		//if timezone STILL empty then return the default timezone for the site.
1445
+		if (empty($this->_timezone)) {
1446
+			$this->set_timezone(EEH_DTT_Helper::get_timezone());
1447
+		}
1448
+		return $this->_timezone;
1449
+	}
1450
+
1451
+
1452
+
1453
+	/**
1454
+	 * This returns the date formats set for the given field name and also ensures that
1455
+	 * $this->_timezone property is set correctly.
1456
+	 *
1457
+	 * @since 4.6.x
1458
+	 * @param string $field_name The name of the field the formats are being retrieved for.
1459
+	 * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1460
+	 * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1461
+	 * @return array formats in an array with the date format first, and the time format last.
1462
+	 */
1463
+	public function get_formats_for($field_name, $pretty = false)
1464
+	{
1465
+		$field_settings = $this->field_settings_for($field_name);
1466
+		//if not a valid EE_Datetime_Field then throw error
1467
+		if (! $field_settings instanceof EE_Datetime_Field) {
1468
+			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.',
1469
+				'event_espresso'), $field_name));
1470
+		}
1471
+		//while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1472
+		//the field.
1473
+		$this->_timezone = $field_settings->get_timezone();
1474
+		return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1475
+	}
1476
+
1477
+
1478
+
1479
+	/**
1480
+	 * This returns the current time in a format setup for a query on this model.
1481
+	 * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1482
+	 * it will return:
1483
+	 *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1484
+	 *  NOW
1485
+	 *  - or a unix timestamp (equivalent to time())
1486
+	 * Note: When requesting a formatted string, if the date or time format doesn't include seconds, for example,
1487
+	 * the time returned, because it uses that format, will also NOT include seconds. For this reason, if you want
1488
+	 * the time returned to be the current time down to the exact second, set $timestamp to true.
1489
+	 * @since 4.6.x
1490
+	 * @param string $field_name       The field the current time is needed for.
1491
+	 * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1492
+	 *                                 formatted string matching the set format for the field in the set timezone will
1493
+	 *                                 be returned.
1494
+	 * @param string $what             Whether to return the string in just the time format, the date format, or both.
1495
+	 * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1496
+	 * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1497
+	 *                                 exception is triggered.
1498
+	 */
1499
+	public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1500
+	{
1501
+		$formats = $this->get_formats_for($field_name);
1502
+		$DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1503
+		if ($timestamp) {
1504
+			return $DateTime->format('U');
1505
+		}
1506
+		//not returning timestamp, so return formatted string in timezone.
1507
+		switch ($what) {
1508
+			case 'time' :
1509
+				return $DateTime->format($formats[1]);
1510
+				break;
1511
+			case 'date' :
1512
+				return $DateTime->format($formats[0]);
1513
+				break;
1514
+			default :
1515
+				return $DateTime->format(implode(' ', $formats));
1516
+				break;
1517
+		}
1518
+	}
1519
+
1520
+
1521
+
1522
+	/**
1523
+	 * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1524
+	 * for the model are.  Returns a DateTime object.
1525
+	 * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1526
+	 * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1527
+	 * ignored.
1528
+	 *
1529
+	 * @param string $field_name      The field being setup.
1530
+	 * @param string $timestring      The date time string being used.
1531
+	 * @param string $incoming_format The format for the time string.
1532
+	 * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1533
+	 *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1534
+	 *                                format is
1535
+	 *                                'U', this is ignored.
1536
+	 * @return DateTime
1537
+	 * @throws \EE_Error
1538
+	 */
1539
+	public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1540
+	{
1541
+		//just using this to ensure the timezone is set correctly internally
1542
+		$this->get_formats_for($field_name);
1543
+		//load EEH_DTT_Helper
1544
+		$set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1545
+		$incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1546
+		return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1547
+	}
1548
+
1549
+
1550
+
1551
+	/**
1552
+	 * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1553
+	 *
1554
+	 * @return EE_Table_Base[]
1555
+	 */
1556
+	public function get_tables()
1557
+	{
1558
+		return $this->_tables;
1559
+	}
1560
+
1561
+
1562
+
1563
+	/**
1564
+	 * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1565
+	 * also updates all the model objects, where the criteria expressed in $query_params are met..
1566
+	 * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1567
+	 * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1568
+	 * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1569
+	 * model object with EVT_ID = 1
1570
+	 * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1571
+	 * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1572
+	 * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1573
+	 * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1574
+	 * are not specified)
1575
+	 *
1576
+	 * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1577
+	 *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1578
+	 *                                         are to be serialized. Basically, the values are what you'd expect to be
1579
+	 *                                         values on the model, NOT necessarily what's in the DB. For example, if
1580
+	 *                                         we wanted to update only the TXN_details on any Transactions where its
1581
+	 *                                         ID=34, we'd use this method as follows:
1582
+	 *                                         EEM_Transaction::instance()->update(
1583
+	 *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1584
+	 *                                         array(array('TXN_ID'=>34)));
1585
+	 * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1586
+	 *                                         in client code into what's expected to be stored on each field. Eg,
1587
+	 *                                         consider updating Question's QST_admin_label field is of type
1588
+	 *                                         Simple_HTML. If you use this function to update that field to $new_value
1589
+	 *                                         = (note replace 8's with appropriate opening and closing tags in the
1590
+	 *                                         following example)"8script8alert('I hack all');8/script88b8boom
1591
+	 *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1592
+	 *                                         TRUE, it is assumed that you've already called
1593
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1594
+	 *                                         malicious javascript. However, if
1595
+	 *                                         $values_already_prepared_by_model_object is left as FALSE, then
1596
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
1597
+	 *                                         and every other field, before insertion. We provide this parameter
1598
+	 *                                         because model objects perform their prepare_for_set function on all
1599
+	 *                                         their values, and so don't need to be called again (and in many cases,
1600
+	 *                                         shouldn't be called again. Eg: if we escape HTML characters in the
1601
+	 *                                         prepare_for_set method...)
1602
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1603
+	 *                                         in this model's entity map according to $fields_n_values that match
1604
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
1605
+	 *                                         by setting this to FALSE, but be aware that model objects being used
1606
+	 *                                         could get out-of-sync with the database
1607
+	 * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1608
+	 *                                         rows affected which *could* include 0 which DOES NOT mean the query was
1609
+	 *                                         bad)
1610
+	 * @throws \EE_Error
1611
+	 */
1612
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1613
+	{
1614
+		if (! is_array($query_params)) {
1615
+			EE_Error::doing_it_wrong('EEM_Base::update',
1616
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1617
+					gettype($query_params)), '4.6.0');
1618
+			$query_params = array();
1619
+		}
1620
+		/**
1621
+		 * Action called before a model update call has been made.
1622
+		 *
1623
+		 * @param EEM_Base $model
1624
+		 * @param array    $fields_n_values the updated fields and their new values
1625
+		 * @param array    $query_params    @see EEM_Base::get_all()
1626
+		 */
1627
+		do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1628
+		/**
1629
+		 * Filters the fields about to be updated given the query parameters. You can provide the
1630
+		 * $query_params to $this->get_all() to find exactly which records will be updated
1631
+		 *
1632
+		 * @param array    $fields_n_values fields and their new values
1633
+		 * @param EEM_Base $model           the model being queried
1634
+		 * @param array    $query_params    see EEM_Base::get_all()
1635
+		 */
1636
+		$fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1637
+			$query_params);
1638
+		//need to verify that, for any entry we want to update, there are entries in each secondary table.
1639
+		//to do that, for each table, verify that it's PK isn't null.
1640
+		$tables = $this->get_tables();
1641
+		//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
1642
+		//NOTE: we should make this code more efficient by NOT querying twice
1643
+		//before the real update, but that needs to first go through ALPHA testing
1644
+		//as it's dangerous. says Mike August 8 2014
1645
+		//we want to make sure the default_where strategy is ignored
1646
+		$this->_ignore_where_strategy = true;
1647
+		$wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1648
+		foreach ($wpdb_select_results as $wpdb_result) {
1649
+			// type cast stdClass as array
1650
+			$wpdb_result = (array)$wpdb_result;
1651
+			//get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1652
+			if ($this->has_primary_key_field()) {
1653
+				$main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1654
+			} else {
1655
+				//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)
1656
+				$main_table_pk_value = null;
1657
+			}
1658
+			//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
1659
+			//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
1660
+			if (count($tables) > 1) {
1661
+				//foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1662
+				//in that table, and so we'll want to insert one
1663
+				foreach ($tables as $table_obj) {
1664
+					$this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1665
+					//if there is no private key for this table on the results, it means there's no entry
1666
+					//in this table, right? so insert a row in the current table, using any fields available
1667
+					if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1668
+						   && $wpdb_result[$this_table_pk_column])
1669
+					) {
1670
+						$success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1671
+							$main_table_pk_value);
1672
+						//if we died here, report the error
1673
+						if (! $success) {
1674
+							return false;
1675
+						}
1676
+					}
1677
+				}
1678
+			}
1679
+			//				//and now check that if we have cached any models by that ID on the model, that
1680
+			//				//they also get updated properly
1681
+			//				$model_object = $this->get_from_entity_map( $main_table_pk_value );
1682
+			//				if( $model_object ){
1683
+			//					foreach( $fields_n_values as $field => $value ){
1684
+			//						$model_object->set($field, $value);
1685
+			//let's make sure default_where strategy is followed now
1686
+			$this->_ignore_where_strategy = false;
1687
+		}
1688
+		//if we want to keep model objects in sync, AND
1689
+		//if this wasn't called from a model object (to update itself)
1690
+		//then we want to make sure we keep all the existing
1691
+		//model objects in sync with the db
1692
+		if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1693
+			if ($this->has_primary_key_field()) {
1694
+				$model_objs_affected_ids = $this->get_col($query_params);
1695
+			} else {
1696
+				//we need to select a bunch of columns and then combine them into the the "index primary key string"s
1697
+				$models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1698
+				$model_objs_affected_ids = array();
1699
+				foreach ($models_affected_key_columns as $row) {
1700
+					$combined_index_key = $this->get_index_primary_key_string($row);
1701
+					$model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1702
+				}
1703
+			}
1704
+			if (! $model_objs_affected_ids) {
1705
+				//wait wait wait- if nothing was affected let's stop here
1706
+				return 0;
1707
+			}
1708
+			foreach ($model_objs_affected_ids as $id) {
1709
+				$model_obj_in_entity_map = $this->get_from_entity_map($id);
1710
+				if ($model_obj_in_entity_map) {
1711
+					foreach ($fields_n_values as $field => $new_value) {
1712
+						$model_obj_in_entity_map->set($field, $new_value);
1713
+					}
1714
+				}
1715
+			}
1716
+			//if there is a primary key on this model, we can now do a slight optimization
1717
+			if ($this->has_primary_key_field()) {
1718
+				//we already know what we want to update. So let's make the query simpler so it's a little more efficient
1719
+				$query_params = array(
1720
+					array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1721
+					'limit'                    => count($model_objs_affected_ids),
1722
+					'default_where_conditions' => EEM_Base::default_where_conditions_none,
1723
+				);
1724
+			}
1725
+		}
1726
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1727
+		$SQL = "UPDATE "
1728
+			   . $model_query_info->get_full_join_sql()
1729
+			   . " SET "
1730
+			   . $this->_construct_update_sql($fields_n_values)
1731
+			   . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1732
+		$rows_affected = $this->_do_wpdb_query('query', array($SQL));
1733
+		/**
1734
+		 * Action called after a model update call has been made.
1735
+		 *
1736
+		 * @param EEM_Base $model
1737
+		 * @param array    $fields_n_values the updated fields and their new values
1738
+		 * @param array    $query_params    @see EEM_Base::get_all()
1739
+		 * @param int      $rows_affected
1740
+		 */
1741
+		do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1742
+		return $rows_affected;//how many supposedly got updated
1743
+	}
1744
+
1745
+
1746
+
1747
+	/**
1748
+	 * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1749
+	 * are teh values of the field specified (or by default the primary key field)
1750
+	 * that matched the query params. Note that you should pass the name of the
1751
+	 * model FIELD, not the database table's column name.
1752
+	 *
1753
+	 * @param array  $query_params @see EEM_Base::get_all()
1754
+	 * @param string $field_to_select
1755
+	 * @return array just like $wpdb->get_col()
1756
+	 * @throws \EE_Error
1757
+	 */
1758
+	public function get_col($query_params = array(), $field_to_select = null)
1759
+	{
1760
+		if ($field_to_select) {
1761
+			$field = $this->field_settings_for($field_to_select);
1762
+		} elseif ($this->has_primary_key_field()) {
1763
+			$field = $this->get_primary_key_field();
1764
+		} else {
1765
+			//no primary key, just grab the first column
1766
+			$field = reset($this->field_settings());
1767
+		}
1768
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1769
+		$select_expressions = $field->get_qualified_column();
1770
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1771
+		return $this->_do_wpdb_query('get_col', array($SQL));
1772
+	}
1773
+
1774
+
1775
+
1776
+	/**
1777
+	 * Returns a single column value for a single row from the database
1778
+	 *
1779
+	 * @param array  $query_params    @see EEM_Base::get_all()
1780
+	 * @param string $field_to_select @see EEM_Base::get_col()
1781
+	 * @return string
1782
+	 * @throws \EE_Error
1783
+	 */
1784
+	public function get_var($query_params = array(), $field_to_select = null)
1785
+	{
1786
+		$query_params['limit'] = 1;
1787
+		$col = $this->get_col($query_params, $field_to_select);
1788
+		if (! empty($col)) {
1789
+			return reset($col);
1790
+		} else {
1791
+			return null;
1792
+		}
1793
+	}
1794
+
1795
+
1796
+
1797
+	/**
1798
+	 * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1799
+	 * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1800
+	 * injection, but currently no further filtering is done
1801
+	 *
1802
+	 * @global      $wpdb
1803
+	 * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1804
+	 *                               be updated to in the DB
1805
+	 * @return string of SQL
1806
+	 * @throws \EE_Error
1807
+	 */
1808
+	public function _construct_update_sql($fields_n_values)
1809
+	{
1810
+		/** @type WPDB $wpdb */
1811
+		global $wpdb;
1812
+		$cols_n_values = array();
1813
+		foreach ($fields_n_values as $field_name => $value) {
1814
+			$field_obj = $this->field_settings_for($field_name);
1815
+			//if the value is NULL, we want to assign the value to that.
1816
+			//wpdb->prepare doesn't really handle that properly
1817
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1818
+			$value_sql = $prepared_value === null ? 'NULL'
1819
+				: $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1820
+			$cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1821
+		}
1822
+		return implode(",", $cols_n_values);
1823
+	}
1824
+
1825
+
1826
+
1827
+	/**
1828
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1829
+	 * Performs a HARD delete, meaning the database row should always be removed,
1830
+	 * not just have a flag field on it switched
1831
+	 * Wrapper for EEM_Base::delete_permanently()
1832
+	 *
1833
+	 * @param mixed $id
1834
+	 * @return boolean whether the row got deleted or not
1835
+	 * @throws \EE_Error
1836
+	 */
1837
+	public function delete_permanently_by_ID($id)
1838
+	{
1839
+		return $this->delete_permanently(
1840
+			array(
1841
+				array($this->get_primary_key_field()->get_name() => $id),
1842
+				'limit' => 1,
1843
+			)
1844
+		);
1845
+	}
1846
+
1847
+
1848
+
1849
+	/**
1850
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1851
+	 * Wrapper for EEM_Base::delete()
1852
+	 *
1853
+	 * @param mixed $id
1854
+	 * @return boolean whether the row got deleted or not
1855
+	 * @throws \EE_Error
1856
+	 */
1857
+	public function delete_by_ID($id)
1858
+	{
1859
+		return $this->delete(
1860
+			array(
1861
+				array($this->get_primary_key_field()->get_name() => $id),
1862
+				'limit' => 1,
1863
+			)
1864
+		);
1865
+	}
1866
+
1867
+
1868
+
1869
+	/**
1870
+	 * Identical to delete_permanently, but does a "soft" delete if possible,
1871
+	 * meaning if the model has a field that indicates its been "trashed" or
1872
+	 * "soft deleted", we will just set that instead of actually deleting the rows.
1873
+	 *
1874
+	 * @see EEM_Base::delete_permanently
1875
+	 * @param array   $query_params
1876
+	 * @param boolean $allow_blocking
1877
+	 * @return int how many rows got deleted
1878
+	 * @throws \EE_Error
1879
+	 */
1880
+	public function delete($query_params, $allow_blocking = true)
1881
+	{
1882
+		return $this->delete_permanently($query_params, $allow_blocking);
1883
+	}
1884
+
1885
+
1886
+
1887
+	/**
1888
+	 * Deletes the model objects that meet the query params. Note: this method is overridden
1889
+	 * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1890
+	 * as archived, not actually deleted
1891
+	 *
1892
+	 * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1893
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1894
+	 *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1895
+	 *                                deletes regardless of other objects which may depend on it. Its generally
1896
+	 *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1897
+	 *                                DB
1898
+	 * @return int how many rows got deleted
1899
+	 * @throws \EE_Error
1900
+	 */
1901
+	public function delete_permanently($query_params, $allow_blocking = true)
1902
+	{
1903
+		/**
1904
+		 * Action called just before performing a real deletion query. You can use the
1905
+		 * model and its $query_params to find exactly which items will be deleted
1906
+		 *
1907
+		 * @param EEM_Base $model
1908
+		 * @param array    $query_params   @see EEM_Base::get_all()
1909
+		 * @param boolean  $allow_blocking whether or not to allow related model objects
1910
+		 *                                 to block (prevent) this deletion
1911
+		 */
1912
+		do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1913
+		//some MySQL databases may be running safe mode, which may restrict
1914
+		//deletion if there is no KEY column used in the WHERE statement of a deletion.
1915
+		//to get around this, we first do a SELECT, get all the IDs, and then run another query
1916
+		//to delete them
1917
+		$items_for_deletion = $this->_get_all_wpdb_results($query_params);
1918
+		$deletion_where = $this->_setup_ids_for_delete($items_for_deletion, $allow_blocking);
1919
+		if ($deletion_where) {
1920
+			//echo "objects for deletion:";var_dump($objects_for_deletion);
1921
+			$model_query_info = $this->_create_model_query_info_carrier($query_params);
1922
+			$table_aliases = array_keys($this->_tables);
1923
+			$SQL = "DELETE "
1924
+				   . implode(", ", $table_aliases)
1925
+				   . " FROM "
1926
+				   . $model_query_info->get_full_join_sql()
1927
+				   . " WHERE "
1928
+				   . $deletion_where;
1929
+			//		/echo "delete sql:$SQL";
1930
+			$rows_deleted = $this->_do_wpdb_query('query', array($SQL));
1931
+		} else {
1932
+			$rows_deleted = 0;
1933
+		}
1934
+		//and lastly make sure those items are removed from the entity map; if they could be put into it at all
1935
+		if ($this->has_primary_key_field()) {
1936
+			foreach ($items_for_deletion as $item_for_deletion_row) {
1937
+				$pk_value = $item_for_deletion_row[$this->get_primary_key_field()->get_qualified_column()];
1938
+				if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value])) {
1939
+					unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value]);
1940
+				}
1941
+			}
1942
+		}
1943
+		/**
1944
+		 * Action called just after performing a real deletion query. Although at this point the
1945
+		 * items should have been deleted
1946
+		 *
1947
+		 * @param EEM_Base $model
1948
+		 * @param array    $query_params @see EEM_Base::get_all()
1949
+		 * @param int      $rows_deleted
1950
+		 */
1951
+		do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
1952
+		return $rows_deleted;//how many supposedly got deleted
1953
+	}
1954
+
1955
+
1956
+
1957
+	/**
1958
+	 * Checks all the relations that throw error messages when there are blocking related objects
1959
+	 * for related model objects. If there are any related model objects on those relations,
1960
+	 * adds an EE_Error, and return true
1961
+	 *
1962
+	 * @param EE_Base_Class|int $this_model_obj_or_id
1963
+	 * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
1964
+	 *                                                 should be ignored when determining whether there are related
1965
+	 *                                                 model objects which block this model object's deletion. Useful
1966
+	 *                                                 if you know A is related to B and are considering deleting A,
1967
+	 *                                                 but want to see if A has any other objects blocking its deletion
1968
+	 *                                                 before removing the relation between A and B
1969
+	 * @return boolean
1970
+	 * @throws \EE_Error
1971
+	 */
1972
+	public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
1973
+	{
1974
+		//first, if $ignore_this_model_obj was supplied, get its model
1975
+		if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
1976
+			$ignored_model = $ignore_this_model_obj->get_model();
1977
+		} else {
1978
+			$ignored_model = null;
1979
+		}
1980
+		//now check all the relations of $this_model_obj_or_id and see if there
1981
+		//are any related model objects blocking it?
1982
+		$is_blocked = false;
1983
+		foreach ($this->_model_relations as $relation_name => $relation_obj) {
1984
+			if ($relation_obj->block_delete_if_related_models_exist()) {
1985
+				//if $ignore_this_model_obj was supplied, then for the query
1986
+				//on that model needs to be told to ignore $ignore_this_model_obj
1987
+				if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
1988
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
1989
+						array(
1990
+							$ignored_model->get_primary_key_field()->get_name() => array(
1991
+								'!=',
1992
+								$ignore_this_model_obj->ID(),
1993
+							),
1994
+						),
1995
+					));
1996
+				} else {
1997
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
1998
+				}
1999
+				if ($related_model_objects) {
2000
+					EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
2001
+					$is_blocked = true;
2002
+				}
2003
+			}
2004
+		}
2005
+		return $is_blocked;
2006
+	}
2007
+
2008
+
2009
+
2010
+	/**
2011
+	 * This sets up our delete where sql and accounts for if we have secondary tables that will have rows deleted as
2012
+	 * well.
2013
+	 *
2014
+	 * @param  array  $objects_for_deletion This should be the values returned by $this->_get_all_wpdb_results()
2015
+	 * @param boolean $allow_blocking       if TRUE, matched objects will only be deleted if there is no related model
2016
+	 *                                      info that blocks it (ie, there' sno other data that depends on this data);
2017
+	 *                                      if false, deletes regardless of other objects which may depend on it. Its
2018
+	 *                                      generally advisable to always leave this as TRUE, otherwise you could
2019
+	 *                                      easily corrupt your DB
2020
+	 * @throws EE_Error
2021
+	 * @return string    everything that comes after the WHERE statement.
2022
+	 */
2023
+	protected function _setup_ids_for_delete($objects_for_deletion, $allow_blocking = true)
2024
+	{
2025
+		if ($this->has_primary_key_field()) {
2026
+			$primary_table = $this->_get_main_table();
2027
+			$other_tables = $this->_get_other_tables();
2028
+			$deletes = $query = array();
2029
+			foreach ($objects_for_deletion as $delete_object) {
2030
+				//before we mark this object for deletion,
2031
+				//make sure there's no related objects blocking its deletion (if we're checking)
2032
+				if (
2033
+					$allow_blocking
2034
+					&& $this->delete_is_blocked_by_related_models(
2035
+						$delete_object[$primary_table->get_fully_qualified_pk_column()]
2036
+					)
2037
+				) {
2038
+					continue;
2039
+				}
2040
+				//primary table deletes
2041
+				if (isset($delete_object[$primary_table->get_fully_qualified_pk_column()])) {
2042
+					$deletes[$primary_table->get_fully_qualified_pk_column()][] = $delete_object[$primary_table->get_fully_qualified_pk_column()];
2043
+				}
2044
+				//other tables
2045
+				if (! empty($other_tables)) {
2046
+					foreach ($other_tables as $ot) {
2047
+						//first check if we've got the foreign key column here.
2048
+						if (isset($delete_object[$ot->get_fully_qualified_fk_column()])) {
2049
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_fk_column()];
2050
+						}
2051
+						// wait! it's entirely possible that we'll have a the primary key
2052
+						// for this table in here, if it's a foreign key for one of the other secondary tables
2053
+						if (isset($delete_object[$ot->get_fully_qualified_pk_column()])) {
2054
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
2055
+						}
2056
+						// finally, it is possible that the fk for this table is found
2057
+						// in the fully qualified pk column for the fk table, so let's see if that's there!
2058
+						if (isset($delete_object[$ot->get_fully_qualified_pk_on_fk_table()])) {
2059
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
2060
+						}
2061
+					}
2062
+				}
2063
+			}
2064
+			//we should have deletes now, so let's just go through and setup the where statement
2065
+			foreach ($deletes as $column => $values) {
2066
+				//make sure we have unique $values;
2067
+				$values = array_unique($values);
2068
+				$query[] = $column . ' IN(' . implode(",", $values) . ')';
2069
+			}
2070
+			return ! empty($query) ? implode(' AND ', $query) : '';
2071
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
2072
+			$ways_to_identify_a_row = array();
2073
+			$fields = $this->get_combined_primary_key_fields();
2074
+			//note: because there' sno primary key, that means nothing else  can be pointing to this model, right?
2075
+			foreach ($objects_for_deletion as $delete_object) {
2076
+				$values_for_each_cpk_for_a_row = array();
2077
+				foreach ($fields as $cpk_field) {
2078
+					if ($cpk_field instanceof EE_Model_Field_Base) {
2079
+						$values_for_each_cpk_for_a_row[] = $cpk_field->get_qualified_column()
2080
+														   . "="
2081
+														   . $delete_object[$cpk_field->get_qualified_column()];
2082
+					}
2083
+				}
2084
+				$ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
2085
+			}
2086
+			return implode(" OR ", $ways_to_identify_a_row);
2087
+		} else {
2088
+			//so there's no primary key and no combined key...
2089
+			//sorry, can't help you
2090
+			throw new EE_Error(sprintf(__("Cannot delete objects of type %s because there is no primary key NOR combined key",
2091
+				"event_espresso"), get_class($this)));
2092
+		}
2093
+	}
2094
+
2095
+
2096
+
2097
+	/**
2098
+	 * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
2099
+	 * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
2100
+	 * column
2101
+	 *
2102
+	 * @param array  $query_params   like EEM_Base::get_all's
2103
+	 * @param string $field_to_count field on model to count by (not column name)
2104
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2105
+	 *                               that by the setting $distinct to TRUE;
2106
+	 * @return int
2107
+	 * @throws \EE_Error
2108
+	 */
2109
+	public function count($query_params = array(), $field_to_count = null, $distinct = false)
2110
+	{
2111
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2112
+		if ($field_to_count) {
2113
+			$field_obj = $this->field_settings_for($field_to_count);
2114
+			$column_to_count = $field_obj->get_qualified_column();
2115
+		} elseif ($this->has_primary_key_field()) {
2116
+			$pk_field_obj = $this->get_primary_key_field();
2117
+			$column_to_count = $pk_field_obj->get_qualified_column();
2118
+		} else {
2119
+			//there's no primary key
2120
+			//if we're counting distinct items, and there's no primary key,
2121
+			//we need to list out the columns for distinction;
2122
+			//otherwise we can just use star
2123
+			if ($distinct) {
2124
+				$columns_to_use = array();
2125
+				foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2126
+					$columns_to_use[] = $field_obj->get_qualified_column();
2127
+				}
2128
+				$column_to_count = implode(',', $columns_to_use);
2129
+			} else {
2130
+				$column_to_count = '*';
2131
+			}
2132
+		}
2133
+		$column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2134
+		$SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2135
+		return (int)$this->_do_wpdb_query('get_var', array($SQL));
2136
+	}
2137
+
2138
+
2139
+
2140
+	/**
2141
+	 * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2142
+	 *
2143
+	 * @param array  $query_params like EEM_Base::get_all
2144
+	 * @param string $field_to_sum name of field (array key in $_fields array)
2145
+	 * @return float
2146
+	 * @throws \EE_Error
2147
+	 */
2148
+	public function sum($query_params, $field_to_sum = null)
2149
+	{
2150
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2151
+		if ($field_to_sum) {
2152
+			$field_obj = $this->field_settings_for($field_to_sum);
2153
+		} else {
2154
+			$field_obj = $this->get_primary_key_field();
2155
+		}
2156
+		$column_to_count = $field_obj->get_qualified_column();
2157
+		$SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2158
+		$return_value = $this->_do_wpdb_query('get_var', array($SQL));
2159
+		$data_type = $field_obj->get_wpdb_data_type();
2160
+		if ($data_type === '%d' || $data_type === '%s') {
2161
+			return (float)$return_value;
2162
+		} else {//must be %f
2163
+			return (float)$return_value;
2164
+		}
2165
+	}
2166
+
2167
+
2168
+
2169
+	/**
2170
+	 * Just calls the specified method on $wpdb with the given arguments
2171
+	 * Consolidates a little extra error handling code
2172
+	 *
2173
+	 * @param string $wpdb_method
2174
+	 * @param array  $arguments_to_provide
2175
+	 * @throws EE_Error
2176
+	 * @global wpdb  $wpdb
2177
+	 * @return mixed
2178
+	 */
2179
+	protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2180
+	{
2181
+		//if we're in maintenance mode level 2, DON'T run any queries
2182
+		//because level 2 indicates the database needs updating and
2183
+		//is probably out of sync with the code
2184
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2185
+			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.",
2186
+				"event_espresso")));
2187
+		}
2188
+		/** @type WPDB $wpdb */
2189
+		global $wpdb;
2190
+		if (! method_exists($wpdb, $wpdb_method)) {
2191
+			throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2192
+				'event_espresso'), $wpdb_method));
2193
+		}
2194
+		if (WP_DEBUG) {
2195
+			$old_show_errors_value = $wpdb->show_errors;
2196
+			$wpdb->show_errors(false);
2197
+		}
2198
+		$result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2199
+		$this->show_db_query_if_previously_requested($wpdb->last_query);
2200
+		if (WP_DEBUG) {
2201
+			$wpdb->show_errors($old_show_errors_value);
2202
+			if (! empty($wpdb->last_error)) {
2203
+				throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2204
+			} elseif ($result === false) {
2205
+				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"',
2206
+					'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2207
+			}
2208
+		} elseif ($result === false) {
2209
+			EE_Error::add_error(
2210
+				sprintf(
2211
+					__('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"',
2212
+						'event_espresso'),
2213
+					$wpdb_method,
2214
+					var_export($arguments_to_provide, true),
2215
+					$wpdb->last_error
2216
+				),
2217
+				__FILE__,
2218
+				__FUNCTION__,
2219
+				__LINE__
2220
+			);
2221
+		}
2222
+		return $result;
2223
+	}
2224
+
2225
+
2226
+
2227
+	/**
2228
+	 * Attempts to run the indicated WPDB method with the provided arguments,
2229
+	 * and if there's an error tries to verify the DB is correct. Uses
2230
+	 * the static property EEM_Base::$_db_verification_level to determine whether
2231
+	 * we should try to fix the EE core db, the addons, or just give up
2232
+	 *
2233
+	 * @param string $wpdb_method
2234
+	 * @param array  $arguments_to_provide
2235
+	 * @return mixed
2236
+	 */
2237
+	private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2238
+	{
2239
+		/** @type WPDB $wpdb */
2240
+		global $wpdb;
2241
+		$wpdb->last_error = null;
2242
+		$result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2243
+		// was there an error running the query? but we don't care on new activations
2244
+		// (we're going to setup the DB anyway on new activations)
2245
+		if (($result === false || ! empty($wpdb->last_error))
2246
+			&& EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2247
+		) {
2248
+			switch (EEM_Base::$_db_verification_level) {
2249
+				case EEM_Base::db_verified_none :
2250
+					// let's double-check core's DB
2251
+					$error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2252
+					break;
2253
+				case EEM_Base::db_verified_core :
2254
+					// STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2255
+					$error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2256
+					break;
2257
+				case EEM_Base::db_verified_addons :
2258
+					// ummmm... you in trouble
2259
+					return $result;
2260
+					break;
2261
+			}
2262
+			if (! empty($error_message)) {
2263
+				EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2264
+				trigger_error($error_message);
2265
+			}
2266
+			return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2267
+		}
2268
+		return $result;
2269
+	}
2270
+
2271
+
2272
+
2273
+	/**
2274
+	 * Verifies the EE core database is up-to-date and records that we've done it on
2275
+	 * EEM_Base::$_db_verification_level
2276
+	 *
2277
+	 * @param string $wpdb_method
2278
+	 * @param array  $arguments_to_provide
2279
+	 * @return string
2280
+	 */
2281
+	private function _verify_core_db($wpdb_method, $arguments_to_provide)
2282
+	{
2283
+		/** @type WPDB $wpdb */
2284
+		global $wpdb;
2285
+		//ok remember that we've already attempted fixing the core db, in case the problem persists
2286
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2287
+		$error_message = sprintf(
2288
+			__('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2289
+				'event_espresso'),
2290
+			$wpdb->last_error,
2291
+			$wpdb_method,
2292
+			wp_json_encode($arguments_to_provide)
2293
+		);
2294
+		EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2295
+		return $error_message;
2296
+	}
2297
+
2298
+
2299
+
2300
+	/**
2301
+	 * Verifies the EE addons' database is up-to-date and records that we've done it on
2302
+	 * EEM_Base::$_db_verification_level
2303
+	 *
2304
+	 * @param $wpdb_method
2305
+	 * @param $arguments_to_provide
2306
+	 * @return string
2307
+	 */
2308
+	private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2309
+	{
2310
+		/** @type WPDB $wpdb */
2311
+		global $wpdb;
2312
+		//ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2313
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2314
+		$error_message = sprintf(
2315
+			__('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2316
+				'event_espresso'),
2317
+			$wpdb->last_error,
2318
+			$wpdb_method,
2319
+			wp_json_encode($arguments_to_provide)
2320
+		);
2321
+		EE_System::instance()->initialize_addons();
2322
+		return $error_message;
2323
+	}
2324
+
2325
+
2326
+
2327
+	/**
2328
+	 * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2329
+	 * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2330
+	 * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2331
+	 * ..."
2332
+	 *
2333
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
2334
+	 * @return string
2335
+	 */
2336
+	private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2337
+	{
2338
+		return " FROM " . $model_query_info->get_full_join_sql() .
2339
+			   $model_query_info->get_where_sql() .
2340
+			   $model_query_info->get_group_by_sql() .
2341
+			   $model_query_info->get_having_sql() .
2342
+			   $model_query_info->get_order_by_sql() .
2343
+			   $model_query_info->get_limit_sql();
2344
+	}
2345
+
2346
+
2347
+
2348
+	/**
2349
+	 * Set to easily debug the next X queries ran from this model.
2350
+	 *
2351
+	 * @param int $count
2352
+	 */
2353
+	public function show_next_x_db_queries($count = 1)
2354
+	{
2355
+		$this->_show_next_x_db_queries = $count;
2356
+	}
2357
+
2358
+
2359
+
2360
+	/**
2361
+	 * @param $sql_query
2362
+	 */
2363
+	public function show_db_query_if_previously_requested($sql_query)
2364
+	{
2365
+		if ($this->_show_next_x_db_queries > 0) {
2366
+			echo $sql_query;
2367
+			$this->_show_next_x_db_queries--;
2368
+		}
2369
+	}
2370
+
2371
+
2372
+
2373
+	/**
2374
+	 * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2375
+	 * There are the 3 cases:
2376
+	 * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2377
+	 * $otherModelObject has no ID, it is first saved.
2378
+	 * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2379
+	 * has no ID, it is first saved.
2380
+	 * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2381
+	 * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2382
+	 * join table
2383
+	 *
2384
+	 * @param        EE_Base_Class                     /int $thisModelObject
2385
+	 * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2386
+	 * @param string $relationName                     , key in EEM_Base::_relations
2387
+	 *                                                 an attendee to a group, you also want to specify which role they
2388
+	 *                                                 will have in that group. So you would use this parameter to
2389
+	 *                                                 specify array('role-column-name'=>'role-id')
2390
+	 * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2391
+	 *                                                 to for relation to methods that allow you to further specify
2392
+	 *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2393
+	 *                                                 only acceptable query_params is strict "col" => "value" pairs
2394
+	 *                                                 because these will be inserted in any new rows created as well.
2395
+	 * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2396
+	 * @throws \EE_Error
2397
+	 */
2398
+	public function add_relationship_to(
2399
+		$id_or_obj,
2400
+		$other_model_id_or_obj,
2401
+		$relationName,
2402
+		$extra_join_model_fields_n_values = array()
2403
+	) {
2404
+		$relation_obj = $this->related_settings_for($relationName);
2405
+		return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2406
+	}
2407
+
2408
+
2409
+
2410
+	/**
2411
+	 * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2412
+	 * There are the 3 cases:
2413
+	 * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2414
+	 * error
2415
+	 * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2416
+	 * an error
2417
+	 * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2418
+	 *
2419
+	 * @param        EE_Base_Class /int $id_or_obj
2420
+	 * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2421
+	 * @param string $relationName key in EEM_Base::_relations
2422
+	 * @return boolean of success
2423
+	 * @throws \EE_Error
2424
+	 * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2425
+	 *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2426
+	 *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2427
+	 *                             because these will be inserted in any new rows created as well.
2428
+	 */
2429
+	public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2430
+	{
2431
+		$relation_obj = $this->related_settings_for($relationName);
2432
+		return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2433
+	}
2434
+
2435
+
2436
+
2437
+	/**
2438
+	 * @param mixed           $id_or_obj
2439
+	 * @param string          $relationName
2440
+	 * @param array           $where_query_params
2441
+	 * @param EE_Base_Class[] objects to which relations were removed
2442
+	 * @return \EE_Base_Class[]
2443
+	 * @throws \EE_Error
2444
+	 */
2445
+	public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2446
+	{
2447
+		$relation_obj = $this->related_settings_for($relationName);
2448
+		return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2449
+	}
2450
+
2451
+
2452
+
2453
+	/**
2454
+	 * Gets all the related items of the specified $model_name, using $query_params.
2455
+	 * Note: by default, we remove the "default query params"
2456
+	 * because we want to get even deleted items etc.
2457
+	 *
2458
+	 * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2459
+	 * @param string $model_name   like 'Event', 'Registration', etc. always singular
2460
+	 * @param array  $query_params like EEM_Base::get_all
2461
+	 * @return EE_Base_Class[]
2462
+	 * @throws \EE_Error
2463
+	 */
2464
+	public function get_all_related($id_or_obj, $model_name, $query_params = null)
2465
+	{
2466
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2467
+		$relation_settings = $this->related_settings_for($model_name);
2468
+		return $relation_settings->get_all_related($model_obj, $query_params);
2469
+	}
2470
+
2471
+
2472
+
2473
+	/**
2474
+	 * Deletes all the model objects across the relation indicated by $model_name
2475
+	 * which are related to $id_or_obj which meet the criteria set in $query_params.
2476
+	 * However, if the model objects can't be deleted because of blocking related model objects, then
2477
+	 * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2478
+	 *
2479
+	 * @param EE_Base_Class|int|string $id_or_obj
2480
+	 * @param string                   $model_name
2481
+	 * @param array                    $query_params
2482
+	 * @return int how many deleted
2483
+	 * @throws \EE_Error
2484
+	 */
2485
+	public function delete_related($id_or_obj, $model_name, $query_params = array())
2486
+	{
2487
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2488
+		$relation_settings = $this->related_settings_for($model_name);
2489
+		return $relation_settings->delete_all_related($model_obj, $query_params);
2490
+	}
2491
+
2492
+
2493
+
2494
+	/**
2495
+	 * Hard deletes all the model objects across the relation indicated by $model_name
2496
+	 * which are related to $id_or_obj which meet the criteria set in $query_params. If
2497
+	 * the model objects can't be hard deleted because of blocking related model objects,
2498
+	 * just does a soft-delete on them instead.
2499
+	 *
2500
+	 * @param EE_Base_Class|int|string $id_or_obj
2501
+	 * @param string                   $model_name
2502
+	 * @param array                    $query_params
2503
+	 * @return int how many deleted
2504
+	 * @throws \EE_Error
2505
+	 */
2506
+	public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2507
+	{
2508
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2509
+		$relation_settings = $this->related_settings_for($model_name);
2510
+		return $relation_settings->delete_related_permanently($model_obj, $query_params);
2511
+	}
2512
+
2513
+
2514
+
2515
+	/**
2516
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2517
+	 * unless otherwise specified in the $query_params
2518
+	 *
2519
+	 * @param        int             /EE_Base_Class $id_or_obj
2520
+	 * @param string $model_name     like 'Event', or 'Registration'
2521
+	 * @param array  $query_params   like EEM_Base::get_all's
2522
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
2523
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2524
+	 *                               that by the setting $distinct to TRUE;
2525
+	 * @return int
2526
+	 * @throws \EE_Error
2527
+	 */
2528
+	public function count_related(
2529
+		$id_or_obj,
2530
+		$model_name,
2531
+		$query_params = array(),
2532
+		$field_to_count = null,
2533
+		$distinct = false
2534
+	) {
2535
+		$related_model = $this->get_related_model_obj($model_name);
2536
+		//we're just going to use the query params on the related model's normal get_all query,
2537
+		//except add a condition to say to match the current mod
2538
+		if (! isset($query_params['default_where_conditions'])) {
2539
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2540
+		}
2541
+		$this_model_name = $this->get_this_model_name();
2542
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2543
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2544
+		return $related_model->count($query_params, $field_to_count, $distinct);
2545
+	}
2546
+
2547
+
2548
+
2549
+	/**
2550
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
2551
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2552
+	 *
2553
+	 * @param        int           /EE_Base_Class $id_or_obj
2554
+	 * @param string $model_name   like 'Event', or 'Registration'
2555
+	 * @param array  $query_params like EEM_Base::get_all's
2556
+	 * @param string $field_to_sum name of field to count by. By default, uses primary key
2557
+	 * @return float
2558
+	 * @throws \EE_Error
2559
+	 */
2560
+	public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2561
+	{
2562
+		$related_model = $this->get_related_model_obj($model_name);
2563
+		if (! is_array($query_params)) {
2564
+			EE_Error::doing_it_wrong('EEM_Base::sum_related',
2565
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2566
+					gettype($query_params)), '4.6.0');
2567
+			$query_params = array();
2568
+		}
2569
+		//we're just going to use the query params on the related model's normal get_all query,
2570
+		//except add a condition to say to match the current mod
2571
+		if (! isset($query_params['default_where_conditions'])) {
2572
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2573
+		}
2574
+		$this_model_name = $this->get_this_model_name();
2575
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2576
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2577
+		return $related_model->sum($query_params, $field_to_sum);
2578
+	}
2579
+
2580
+
2581
+
2582
+	/**
2583
+	 * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2584
+	 * $modelObject
2585
+	 *
2586
+	 * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2587
+	 * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2588
+	 * @param array               $query_params     like EEM_Base::get_all's
2589
+	 * @return EE_Base_Class
2590
+	 * @throws \EE_Error
2591
+	 */
2592
+	public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2593
+	{
2594
+		$query_params['limit'] = 1;
2595
+		$results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2596
+		if ($results) {
2597
+			return array_shift($results);
2598
+		} else {
2599
+			return null;
2600
+		}
2601
+	}
2602
+
2603
+
2604
+
2605
+	/**
2606
+	 * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2607
+	 *
2608
+	 * @return string
2609
+	 */
2610
+	public function get_this_model_name()
2611
+	{
2612
+		return str_replace("EEM_", "", get_class($this));
2613
+	}
2614
+
2615
+
2616
+
2617
+	/**
2618
+	 * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2619
+	 *
2620
+	 * @return EE_Any_Foreign_Model_Name_Field
2621
+	 * @throws EE_Error
2622
+	 */
2623
+	public function get_field_containing_related_model_name()
2624
+	{
2625
+		foreach ($this->field_settings(true) as $field) {
2626
+			if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2627
+				$field_with_model_name = $field;
2628
+			}
2629
+		}
2630
+		if (! isset($field_with_model_name) || ! $field_with_model_name) {
2631
+			throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2632
+				$this->get_this_model_name()));
2633
+		}
2634
+		return $field_with_model_name;
2635
+	}
2636
+
2637
+
2638
+
2639
+	/**
2640
+	 * Inserts a new entry into the database, for each table.
2641
+	 * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2642
+	 * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2643
+	 * we also know there is no model object with the newly inserted item's ID at the moment (because
2644
+	 * if there were, then they would already be in the DB and this would fail); and in the future if someone
2645
+	 * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2646
+	 * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2647
+	 *
2648
+	 * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2649
+	 *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2650
+	 *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2651
+	 *                              of EEM_Base)
2652
+	 * @return int new primary key on main table that got inserted
2653
+	 * @throws EE_Error
2654
+	 */
2655
+	public function insert($field_n_values)
2656
+	{
2657
+		/**
2658
+		 * Filters the fields and their values before inserting an item using the models
2659
+		 *
2660
+		 * @param array    $fields_n_values keys are the fields and values are their new values
2661
+		 * @param EEM_Base $model           the model used
2662
+		 */
2663
+		$field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2664
+		if ($this->_satisfies_unique_indexes($field_n_values)) {
2665
+			$main_table = $this->_get_main_table();
2666
+			$new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2667
+			if ($new_id !== false) {
2668
+				foreach ($this->_get_other_tables() as $other_table) {
2669
+					$this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2670
+				}
2671
+			}
2672
+			/**
2673
+			 * Done just after attempting to insert a new model object
2674
+			 *
2675
+			 * @param EEM_Base   $model           used
2676
+			 * @param array      $fields_n_values fields and their values
2677
+			 * @param int|string the              ID of the newly-inserted model object
2678
+			 */
2679
+			do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2680
+			return $new_id;
2681
+		} else {
2682
+			return false;
2683
+		}
2684
+	}
2685
+
2686
+
2687
+
2688
+	/**
2689
+	 * Checks that the result would satisfy the unique indexes on this model
2690
+	 *
2691
+	 * @param array  $field_n_values
2692
+	 * @param string $action
2693
+	 * @return boolean
2694
+	 * @throws \EE_Error
2695
+	 */
2696
+	protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2697
+	{
2698
+		foreach ($this->unique_indexes() as $index_name => $index) {
2699
+			$uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2700
+			if ($this->exists(array($uniqueness_where_params))) {
2701
+				EE_Error::add_error(
2702
+					sprintf(
2703
+						__(
2704
+							"Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2705
+							"event_espresso"
2706
+						),
2707
+						$action,
2708
+						$this->_get_class_name(),
2709
+						$index_name,
2710
+						implode(",", $index->field_names()),
2711
+						http_build_query($uniqueness_where_params)
2712
+					),
2713
+					__FILE__,
2714
+					__FUNCTION__,
2715
+					__LINE__
2716
+				);
2717
+				return false;
2718
+			}
2719
+		}
2720
+		return true;
2721
+	}
2722
+
2723
+
2724
+
2725
+	/**
2726
+	 * Checks the database for an item that conflicts (ie, if this item were
2727
+	 * saved to the DB would break some uniqueness requirement, like a primary key
2728
+	 * or an index primary key set) with the item specified. $id_obj_or_fields_array
2729
+	 * can be either an EE_Base_Class or an array of fields n values
2730
+	 *
2731
+	 * @param EE_Base_Class|array $obj_or_fields_array
2732
+	 * @param boolean             $include_primary_key whether to use the model object's primary key
2733
+	 *                                                 when looking for conflicts
2734
+	 *                                                 (ie, if false, we ignore the model object's primary key
2735
+	 *                                                 when finding "conflicts". If true, it's also considered).
2736
+	 *                                                 Only works for INT primary key,
2737
+	 *                                                 STRING primary keys cannot be ignored
2738
+	 * @throws EE_Error
2739
+	 * @return EE_Base_Class|array
2740
+	 */
2741
+	public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2742
+	{
2743
+		if ($obj_or_fields_array instanceof EE_Base_Class) {
2744
+			$fields_n_values = $obj_or_fields_array->model_field_array();
2745
+		} elseif (is_array($obj_or_fields_array)) {
2746
+			$fields_n_values = $obj_or_fields_array;
2747
+		} else {
2748
+			throw new EE_Error(
2749
+				sprintf(
2750
+					__(
2751
+						"%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2752
+						"event_espresso"
2753
+					),
2754
+					get_class($this),
2755
+					$obj_or_fields_array
2756
+				)
2757
+			);
2758
+		}
2759
+		$query_params = array();
2760
+		if ($this->has_primary_key_field()
2761
+			&& ($include_primary_key
2762
+				|| $this->get_primary_key_field()
2763
+				   instanceof
2764
+				   EE_Primary_Key_String_Field)
2765
+			&& isset($fields_n_values[$this->primary_key_name()])
2766
+		) {
2767
+			$query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2768
+		}
2769
+		foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2770
+			$uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2771
+			$query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2772
+		}
2773
+		//if there is nothing to base this search on, then we shouldn't find anything
2774
+		if (empty($query_params)) {
2775
+			return array();
2776
+		} else {
2777
+			return $this->get_one($query_params);
2778
+		}
2779
+	}
2780
+
2781
+
2782
+
2783
+	/**
2784
+	 * Like count, but is optimized and returns a boolean instead of an int
2785
+	 *
2786
+	 * @param array $query_params
2787
+	 * @return boolean
2788
+	 * @throws \EE_Error
2789
+	 */
2790
+	public function exists($query_params)
2791
+	{
2792
+		$query_params['limit'] = 1;
2793
+		return $this->count($query_params) > 0;
2794
+	}
2795
+
2796
+
2797
+
2798
+	/**
2799
+	 * Wrapper for exists, except ignores default query parameters so we're only considering ID
2800
+	 *
2801
+	 * @param int|string $id
2802
+	 * @return boolean
2803
+	 * @throws \EE_Error
2804
+	 */
2805
+	public function exists_by_ID($id)
2806
+	{
2807
+		return $this->exists(
2808
+			array(
2809
+				'default_where_conditions' => EEM_Base::default_where_conditions_none,
2810
+				array(
2811
+					$this->primary_key_name() => $id,
2812
+				),
2813
+			)
2814
+		);
2815
+	}
2816
+
2817
+
2818
+
2819
+	/**
2820
+	 * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2821
+	 * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2822
+	 * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2823
+	 * on the main table)
2824
+	 * This is protected rather than private because private is not accessible to any child methods and there MAY be
2825
+	 * cases where we want to call it directly rather than via insert().
2826
+	 *
2827
+	 * @access   protected
2828
+	 * @param EE_Table_Base $table
2829
+	 * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2830
+	 *                                       float
2831
+	 * @param int           $new_id          for now we assume only int keys
2832
+	 * @throws EE_Error
2833
+	 * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2834
+	 * @return int ID of new row inserted, or FALSE on failure
2835
+	 */
2836
+	protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2837
+	{
2838
+		global $wpdb;
2839
+		$insertion_col_n_values = array();
2840
+		$format_for_insertion = array();
2841
+		$fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2842
+		foreach ($fields_on_table as $field_name => $field_obj) {
2843
+			//check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2844
+			if ($field_obj->is_auto_increment()) {
2845
+				continue;
2846
+			}
2847
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2848
+			//if the value we want to assign it to is NULL, just don't mention it for the insertion
2849
+			if ($prepared_value !== null) {
2850
+				$insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2851
+				$format_for_insertion[] = $field_obj->get_wpdb_data_type();
2852
+			}
2853
+		}
2854
+		if ($table instanceof EE_Secondary_Table && $new_id) {
2855
+			//its not the main table, so we should have already saved the main table's PK which we just inserted
2856
+			//so add the fk to the main table as a column
2857
+			$insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2858
+			$format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2859
+		}
2860
+		//insert the new entry
2861
+		$result = $this->_do_wpdb_query('insert',
2862
+			array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2863
+		if ($result === false) {
2864
+			return false;
2865
+		}
2866
+		//ok, now what do we return for the ID of the newly-inserted thing?
2867
+		if ($this->has_primary_key_field()) {
2868
+			if ($this->get_primary_key_field()->is_auto_increment()) {
2869
+				return $wpdb->insert_id;
2870
+			} else {
2871
+				//it's not an auto-increment primary key, so
2872
+				//it must have been supplied
2873
+				return $fields_n_values[$this->get_primary_key_field()->get_name()];
2874
+			}
2875
+		} else {
2876
+			//we can't return a  primary key because there is none. instead return
2877
+			//a unique string indicating this model
2878
+			return $this->get_index_primary_key_string($fields_n_values);
2879
+		}
2880
+	}
2881
+
2882
+
2883
+
2884
+	/**
2885
+	 * Prepare the $field_obj 's value in $fields_n_values for use in the database.
2886
+	 * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
2887
+	 * and there is no default, we pass it along. WPDB will take care of it)
2888
+	 *
2889
+	 * @param EE_Model_Field_Base $field_obj
2890
+	 * @param array               $fields_n_values
2891
+	 * @return mixed string|int|float depending on what the table column will be expecting
2892
+	 * @throws \EE_Error
2893
+	 */
2894
+	protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
2895
+	{
2896
+		//if this field doesn't allow nullable, don't allow it
2897
+		if (
2898
+			! $field_obj->is_nullable()
2899
+			&& (
2900
+				! isset($fields_n_values[$field_obj->get_name()])
2901
+				|| $fields_n_values[$field_obj->get_name()] === null
2902
+			)
2903
+		) {
2904
+			$fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
2905
+		}
2906
+		$unprepared_value = isset($fields_n_values[$field_obj->get_name()])
2907
+			? $fields_n_values[$field_obj->get_name()]
2908
+			: null;
2909
+		return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
2910
+	}
2911
+
2912
+
2913
+
2914
+	/**
2915
+	 * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
2916
+	 * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
2917
+	 * the field's prepare_for_set() method.
2918
+	 *
2919
+	 * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
2920
+	 *                                   false, otherwise a value in the model object's domain (see lengthy comment at
2921
+	 *                                   top of file)
2922
+	 * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
2923
+	 *                                   $value is a custom selection
2924
+	 * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
2925
+	 */
2926
+	private function _prepare_value_for_use_in_db($value, $field)
2927
+	{
2928
+		if ($field && $field instanceof EE_Model_Field_Base) {
2929
+			switch ($this->_values_already_prepared_by_model_object) {
2930
+				/** @noinspection PhpMissingBreakStatementInspection */
2931
+				case self::not_prepared_by_model_object:
2932
+					$value = $field->prepare_for_set($value);
2933
+				//purposefully left out "return"
2934
+				case self::prepared_by_model_object:
2935
+					$value = $field->prepare_for_use_in_db($value);
2936
+				case self::prepared_for_use_in_db:
2937
+					//leave the value alone
2938
+			}
2939
+			return $value;
2940
+		} else {
2941
+			return $value;
2942
+		}
2943
+	}
2944
+
2945
+
2946
+
2947
+	/**
2948
+	 * Returns the main table on this model
2949
+	 *
2950
+	 * @return EE_Primary_Table
2951
+	 * @throws EE_Error
2952
+	 */
2953
+	protected function _get_main_table()
2954
+	{
2955
+		foreach ($this->_tables as $table) {
2956
+			if ($table instanceof EE_Primary_Table) {
2957
+				return $table;
2958
+			}
2959
+		}
2960
+		throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
2961
+			'event_espresso'), get_class($this)));
2962
+	}
2963
+
2964
+
2965
+
2966
+	/**
2967
+	 * table
2968
+	 * returns EE_Primary_Table table name
2969
+	 *
2970
+	 * @return string
2971
+	 * @throws \EE_Error
2972
+	 */
2973
+	public function table()
2974
+	{
2975
+		return $this->_get_main_table()->get_table_name();
2976
+	}
2977
+
2978
+
2979
+
2980
+	/**
2981
+	 * table
2982
+	 * returns first EE_Secondary_Table table name
2983
+	 *
2984
+	 * @return string
2985
+	 */
2986
+	public function second_table()
2987
+	{
2988
+		// grab second table from tables array
2989
+		$second_table = end($this->_tables);
2990
+		return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
2991
+	}
2992
+
2993
+
2994
+
2995
+	/**
2996
+	 * get_table_obj_by_alias
2997
+	 * returns table name given it's alias
2998
+	 *
2999
+	 * @param string $table_alias
3000
+	 * @return EE_Primary_Table | EE_Secondary_Table
3001
+	 */
3002
+	public function get_table_obj_by_alias($table_alias = '')
3003
+	{
3004
+		return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
3005
+	}
3006
+
3007
+
3008
+
3009
+	/**
3010
+	 * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
3011
+	 *
3012
+	 * @return EE_Secondary_Table[]
3013
+	 */
3014
+	protected function _get_other_tables()
3015
+	{
3016
+		$other_tables = array();
3017
+		foreach ($this->_tables as $table_alias => $table) {
3018
+			if ($table instanceof EE_Secondary_Table) {
3019
+				$other_tables[$table_alias] = $table;
3020
+			}
3021
+		}
3022
+		return $other_tables;
3023
+	}
3024
+
3025
+
3026
+
3027
+	/**
3028
+	 * Finds all the fields that correspond to the given table
3029
+	 *
3030
+	 * @param string $table_alias , array key in EEM_Base::_tables
3031
+	 * @return EE_Model_Field_Base[]
3032
+	 */
3033
+	public function _get_fields_for_table($table_alias)
3034
+	{
3035
+		return $this->_fields[$table_alias];
3036
+	}
3037
+
3038
+
3039
+
3040
+	/**
3041
+	 * Recurses through all the where parameters, and finds all the related models we'll need
3042
+	 * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
3043
+	 * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
3044
+	 * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
3045
+	 * related Registration, Transaction, and Payment models.
3046
+	 *
3047
+	 * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
3048
+	 * @return EE_Model_Query_Info_Carrier
3049
+	 * @throws \EE_Error
3050
+	 */
3051
+	public function _extract_related_models_from_query($query_params)
3052
+	{
3053
+		$query_info_carrier = new EE_Model_Query_Info_Carrier();
3054
+		if (array_key_exists(0, $query_params)) {
3055
+			$this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
3056
+		}
3057
+		if (array_key_exists('group_by', $query_params)) {
3058
+			if (is_array($query_params['group_by'])) {
3059
+				$this->_extract_related_models_from_sub_params_array_values(
3060
+					$query_params['group_by'],
3061
+					$query_info_carrier,
3062
+					'group_by'
3063
+				);
3064
+			} elseif (! empty ($query_params['group_by'])) {
3065
+				$this->_extract_related_model_info_from_query_param(
3066
+					$query_params['group_by'],
3067
+					$query_info_carrier,
3068
+					'group_by'
3069
+				);
3070
+			}
3071
+		}
3072
+		if (array_key_exists('having', $query_params)) {
3073
+			$this->_extract_related_models_from_sub_params_array_keys(
3074
+				$query_params[0],
3075
+				$query_info_carrier,
3076
+				'having'
3077
+			);
3078
+		}
3079
+		if (array_key_exists('order_by', $query_params)) {
3080
+			if (is_array($query_params['order_by'])) {
3081
+				$this->_extract_related_models_from_sub_params_array_keys(
3082
+					$query_params['order_by'],
3083
+					$query_info_carrier,
3084
+					'order_by'
3085
+				);
3086
+			} elseif (! empty($query_params['order_by'])) {
3087
+				$this->_extract_related_model_info_from_query_param(
3088
+					$query_params['order_by'],
3089
+					$query_info_carrier,
3090
+					'order_by'
3091
+				);
3092
+			}
3093
+		}
3094
+		if (array_key_exists('force_join', $query_params)) {
3095
+			$this->_extract_related_models_from_sub_params_array_values(
3096
+				$query_params['force_join'],
3097
+				$query_info_carrier,
3098
+				'force_join'
3099
+			);
3100
+		}
3101
+		return $query_info_carrier;
3102
+	}
3103
+
3104
+
3105
+
3106
+	/**
3107
+	 * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
3108
+	 *
3109
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3110
+	 *                                                      $query_params['having']
3111
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3112
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
3113
+	 * @throws EE_Error
3114
+	 * @return \EE_Model_Query_Info_Carrier
3115
+	 */
3116
+	private function _extract_related_models_from_sub_params_array_keys(
3117
+		$sub_query_params,
3118
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3119
+		$query_param_type
3120
+	) {
3121
+		if (! empty($sub_query_params)) {
3122
+			$sub_query_params = (array)$sub_query_params;
3123
+			foreach ($sub_query_params as $param => $possibly_array_of_params) {
3124
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3125
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3126
+					$query_param_type);
3127
+				//if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3128
+				//indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3129
+				//extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3130
+				//of array('Registration.TXN_ID'=>23)
3131
+				$query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3132
+				if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3133
+					if (! is_array($possibly_array_of_params)) {
3134
+						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'))",
3135
+							"event_espresso"),
3136
+							$param, $possibly_array_of_params));
3137
+					} else {
3138
+						$this->_extract_related_models_from_sub_params_array_keys($possibly_array_of_params,
3139
+							$model_query_info_carrier, $query_param_type);
3140
+					}
3141
+				} elseif ($query_param_type === 0 //ie WHERE
3142
+						  && is_array($possibly_array_of_params)
3143
+						  && isset($possibly_array_of_params[2])
3144
+						  && $possibly_array_of_params[2] == true
3145
+				) {
3146
+					//then $possible_array_of_params looks something like array('<','DTT_sold',true)
3147
+					//indicating that $possible_array_of_params[1] is actually a field name,
3148
+					//from which we should extract query parameters!
3149
+					if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3150
+						throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3151
+							"event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3152
+					}
3153
+					$this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3154
+						$model_query_info_carrier, $query_param_type);
3155
+				}
3156
+			}
3157
+		}
3158
+		return $model_query_info_carrier;
3159
+	}
3160
+
3161
+
3162
+
3163
+	/**
3164
+	 * For extracting related models from forced_joins, where the array values contain the info about what
3165
+	 * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3166
+	 *
3167
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3168
+	 *                                                      $query_params['having']
3169
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3170
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
3171
+	 * @throws EE_Error
3172
+	 * @return \EE_Model_Query_Info_Carrier
3173
+	 */
3174
+	private function _extract_related_models_from_sub_params_array_values(
3175
+		$sub_query_params,
3176
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3177
+		$query_param_type
3178
+	) {
3179
+		if (! empty($sub_query_params)) {
3180
+			if (! is_array($sub_query_params)) {
3181
+				throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3182
+					$sub_query_params));
3183
+			}
3184
+			foreach ($sub_query_params as $param) {
3185
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3186
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3187
+					$query_param_type);
3188
+			}
3189
+		}
3190
+		return $model_query_info_carrier;
3191
+	}
3192
+
3193
+
3194
+
3195
+	/**
3196
+	 * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3197
+	 * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3198
+	 * instead of directly constructing the SQL because often we need to extract info from the $query_params
3199
+	 * but use them in a different order. Eg, we need to know what models we are querying
3200
+	 * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3201
+	 * other models before we can finalize the where clause SQL.
3202
+	 *
3203
+	 * @param array $query_params
3204
+	 * @throws EE_Error
3205
+	 * @return EE_Model_Query_Info_Carrier
3206
+	 */
3207
+	public function _create_model_query_info_carrier($query_params)
3208
+	{
3209
+		if (! is_array($query_params)) {
3210
+			EE_Error::doing_it_wrong(
3211
+				'EEM_Base::_create_model_query_info_carrier',
3212
+				sprintf(
3213
+					__(
3214
+						'$query_params should be an array, you passed a variable of type %s',
3215
+						'event_espresso'
3216
+					),
3217
+					gettype($query_params)
3218
+				),
3219
+				'4.6.0'
3220
+			);
3221
+			$query_params = array();
3222
+		}
3223
+		$where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3224
+		//first check if we should alter the query to account for caps or not
3225
+		//because the caps might require us to do extra joins
3226
+		if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3227
+			$query_params[0] = $where_query_params = array_replace_recursive(
3228
+				$where_query_params,
3229
+				$this->caps_where_conditions(
3230
+					$query_params['caps']
3231
+				)
3232
+			);
3233
+		}
3234
+		$query_object = $this->_extract_related_models_from_query($query_params);
3235
+		//verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3236
+		foreach ($where_query_params as $key => $value) {
3237
+			if (is_int($key)) {
3238
+				throw new EE_Error(
3239
+					sprintf(
3240
+						__(
3241
+							"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.",
3242
+							"event_espresso"
3243
+						),
3244
+						$key,
3245
+						var_export($value, true),
3246
+						var_export($query_params, true),
3247
+						get_class($this)
3248
+					)
3249
+				);
3250
+			}
3251
+		}
3252
+		if (
3253
+			array_key_exists('default_where_conditions', $query_params)
3254
+			&& ! empty($query_params['default_where_conditions'])
3255
+		) {
3256
+			$use_default_where_conditions = $query_params['default_where_conditions'];
3257
+		} else {
3258
+			$use_default_where_conditions = EEM_Base::default_where_conditions_all;
3259
+		}
3260
+		$where_query_params = array_merge(
3261
+			$this->_get_default_where_conditions_for_models_in_query(
3262
+				$query_object,
3263
+				$use_default_where_conditions,
3264
+				$where_query_params
3265
+			),
3266
+			$where_query_params
3267
+		);
3268
+		$query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3269
+		// if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3270
+		// So we need to setup a subquery and use that for the main join.
3271
+		// Note for now this only works on the primary table for the model.
3272
+		// So for instance, you could set the limit array like this:
3273
+		// array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3274
+		if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3275
+			$query_object->set_main_model_join_sql(
3276
+				$this->_construct_limit_join_select(
3277
+					$query_params['on_join_limit'][0],
3278
+					$query_params['on_join_limit'][1]
3279
+				)
3280
+			);
3281
+		}
3282
+		//set limit
3283
+		if (array_key_exists('limit', $query_params)) {
3284
+			if (is_array($query_params['limit'])) {
3285
+				if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3286
+					$e = sprintf(
3287
+						__(
3288
+							"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)",
3289
+							"event_espresso"
3290
+						),
3291
+						http_build_query($query_params['limit'])
3292
+					);
3293
+					throw new EE_Error($e . "|" . $e);
3294
+				}
3295
+				//they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3296
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3297
+			} elseif (! empty ($query_params['limit'])) {
3298
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3299
+			}
3300
+		}
3301
+		//set order by
3302
+		if (array_key_exists('order_by', $query_params)) {
3303
+			if (is_array($query_params['order_by'])) {
3304
+				//if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3305
+				//specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3306
+				//including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3307
+				if (array_key_exists('order', $query_params)) {
3308
+					throw new EE_Error(
3309
+						sprintf(
3310
+							__(
3311
+								"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 ",
3312
+								"event_espresso"
3313
+							),
3314
+							get_class($this),
3315
+							implode(", ", array_keys($query_params['order_by'])),
3316
+							implode(", ", $query_params['order_by']),
3317
+							$query_params['order']
3318
+						)
3319
+					);
3320
+				}
3321
+				$this->_extract_related_models_from_sub_params_array_keys(
3322
+					$query_params['order_by'],
3323
+					$query_object,
3324
+					'order_by'
3325
+				);
3326
+				//assume it's an array of fields to order by
3327
+				$order_array = array();
3328
+				foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3329
+					$order = $this->_extract_order($order);
3330
+					$order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3331
+				}
3332
+				$query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3333
+			} elseif (! empty ($query_params['order_by'])) {
3334
+				$this->_extract_related_model_info_from_query_param(
3335
+					$query_params['order_by'],
3336
+					$query_object,
3337
+					'order',
3338
+					$query_params['order_by']
3339
+				);
3340
+				$order = isset($query_params['order'])
3341
+					? $this->_extract_order($query_params['order'])
3342
+					: 'DESC';
3343
+				$query_object->set_order_by_sql(
3344
+					" ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3345
+				);
3346
+			}
3347
+		}
3348
+		//if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3349
+		if (! array_key_exists('order_by', $query_params)
3350
+			&& array_key_exists('order', $query_params)
3351
+			&& ! empty($query_params['order'])
3352
+		) {
3353
+			$pk_field = $this->get_primary_key_field();
3354
+			$order = $this->_extract_order($query_params['order']);
3355
+			$query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3356
+		}
3357
+		//set group by
3358
+		if (array_key_exists('group_by', $query_params)) {
3359
+			if (is_array($query_params['group_by'])) {
3360
+				//it's an array, so assume we'll be grouping by a bunch of stuff
3361
+				$group_by_array = array();
3362
+				foreach ($query_params['group_by'] as $field_name_to_group_by) {
3363
+					$group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3364
+				}
3365
+				$query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3366
+			} elseif (! empty ($query_params['group_by'])) {
3367
+				$query_object->set_group_by_sql(
3368
+					" GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3369
+				);
3370
+			}
3371
+		}
3372
+		//set having
3373
+		if (array_key_exists('having', $query_params) && $query_params['having']) {
3374
+			$query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3375
+		}
3376
+		//now, just verify they didn't pass anything wack
3377
+		foreach ($query_params as $query_key => $query_value) {
3378
+			if (! in_array($query_key, $this->_allowed_query_params, true)) {
3379
+				throw new EE_Error(
3380
+					sprintf(
3381
+						__(
3382
+							"You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3383
+							'event_espresso'
3384
+						),
3385
+						$query_key,
3386
+						get_class($this),
3387
+						//						print_r( $this->_allowed_query_params, TRUE )
3388
+						implode(',', $this->_allowed_query_params)
3389
+					)
3390
+				);
3391
+			}
3392
+		}
3393
+		$main_model_join_sql = $query_object->get_main_model_join_sql();
3394
+		if (empty($main_model_join_sql)) {
3395
+			$query_object->set_main_model_join_sql($this->_construct_internal_join());
3396
+		}
3397
+		return $query_object;
3398
+	}
3399
+
3400
+
3401
+
3402
+	/**
3403
+	 * Gets the where conditions that should be imposed on the query based on the
3404
+	 * context (eg reading frontend, backend, edit or delete).
3405
+	 *
3406
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
3407
+	 * @return array like EEM_Base::get_all() 's $query_params[0]
3408
+	 * @throws \EE_Error
3409
+	 */
3410
+	public function caps_where_conditions($context = self::caps_read)
3411
+	{
3412
+		EEM_Base::verify_is_valid_cap_context($context);
3413
+		$cap_where_conditions = array();
3414
+		$cap_restrictions = $this->caps_missing($context);
3415
+		/**
3416
+		 * @var $cap_restrictions EE_Default_Where_Conditions[]
3417
+		 */
3418
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3419
+			$cap_where_conditions = array_replace_recursive($cap_where_conditions,
3420
+				$restriction_if_no_cap->get_default_where_conditions());
3421
+		}
3422
+		return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3423
+			$cap_restrictions);
3424
+	}
3425
+
3426
+
3427
+
3428
+	/**
3429
+	 * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3430
+	 * otherwise throws an exception
3431
+	 *
3432
+	 * @param string $should_be_order_string
3433
+	 * @return string either ASC, asc, DESC or desc
3434
+	 * @throws EE_Error
3435
+	 */
3436
+	private function _extract_order($should_be_order_string)
3437
+	{
3438
+		if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3439
+			return $should_be_order_string;
3440
+		} else {
3441
+			throw new EE_Error(sprintf(__("While performing a query on '%s', tried to use '%s' as an order parameter. ",
3442
+				"event_espresso"), get_class($this), $should_be_order_string));
3443
+		}
3444
+	}
3445
+
3446
+
3447
+
3448
+	/**
3449
+	 * Looks at all the models which are included in this query, and asks each
3450
+	 * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3451
+	 * so they can be merged
3452
+	 *
3453
+	 * @param EE_Model_Query_Info_Carrier $query_info_carrier
3454
+	 * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3455
+	 *                                                                  'none' means NO default where conditions will
3456
+	 *                                                                  be used AT ALL during this query.
3457
+	 *                                                                  'other_models_only' means default where
3458
+	 *                                                                  conditions from other models will be used, but
3459
+	 *                                                                  not for this primary model. 'all', the default,
3460
+	 *                                                                  means default where conditions will apply as
3461
+	 *                                                                  normal
3462
+	 * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3463
+	 * @throws EE_Error
3464
+	 * @return array like $query_params[0], see EEM_Base::get_all for documentation
3465
+	 */
3466
+	private function _get_default_where_conditions_for_models_in_query(
3467
+		EE_Model_Query_Info_Carrier $query_info_carrier,
3468
+		$use_default_where_conditions = EEM_Base::default_where_conditions_all,
3469
+		$where_query_params = array()
3470
+	) {
3471
+		$allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3472
+		if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3473
+			throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3474
+				"event_espresso"), $use_default_where_conditions,
3475
+				implode(", ", $allowed_used_default_where_conditions_values)));
3476
+		}
3477
+		$universal_query_params = array();
3478
+		if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3479
+			$universal_query_params = $this->_get_default_where_conditions();
3480
+		} else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3481
+			$universal_query_params = $this->_get_minimum_where_conditions();
3482
+		}
3483
+		foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3484
+			$related_model = $this->get_related_model_obj($model_name);
3485
+			if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3486
+				$related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3487
+			} elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3488
+				$related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3489
+			} else {
3490
+				//we don't want to add full or even minimum default where conditions from this model, so just continue
3491
+				continue;
3492
+			}
3493
+			$overrides = $this->_override_defaults_or_make_null_friendly(
3494
+				$related_model_universal_where_params,
3495
+				$where_query_params,
3496
+				$related_model,
3497
+				$model_relation_path
3498
+			);
3499
+			$universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3500
+				$universal_query_params,
3501
+				$overrides
3502
+			);
3503
+		}
3504
+		return $universal_query_params;
3505
+	}
3506
+
3507
+
3508
+
3509
+	/**
3510
+	 * Determines whether or not we should use default where conditions for the model in question
3511
+	 * (this model, or other related models).
3512
+	 * Basically, we should use default where conditions on this model if they have requested to use them on all models,
3513
+	 * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3514
+	 * We should use default where conditions on related models when they requested to use default where conditions
3515
+	 * on all models, or specifically just on other related models
3516
+	 * @param      $default_where_conditions_value
3517
+	 * @param bool $for_this_model false means this is for OTHER related models
3518
+	 * @return bool
3519
+	 */
3520
+	private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3521
+	{
3522
+		return (
3523
+				   $for_this_model
3524
+				   && in_array(
3525
+					   $default_where_conditions_value,
3526
+					   array(
3527
+						   EEM_Base::default_where_conditions_all,
3528
+						   EEM_Base::default_where_conditions_this_only,
3529
+						   EEM_Base::default_where_conditions_minimum_others,
3530
+					   ),
3531
+					   true
3532
+				   )
3533
+			   )
3534
+			   || (
3535
+				   ! $for_this_model
3536
+				   && in_array(
3537
+					   $default_where_conditions_value,
3538
+					   array(
3539
+						   EEM_Base::default_where_conditions_all,
3540
+						   EEM_Base::default_where_conditions_others_only,
3541
+					   ),
3542
+					   true
3543
+				   )
3544
+			   );
3545
+	}
3546
+
3547
+	/**
3548
+	 * Determines whether or not we should use default minimum conditions for the model in question
3549
+	 * (this model, or other related models).
3550
+	 * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
3551
+	 * where conditions.
3552
+	 * We should use minimum where conditions on related models if they requested to use minimum where conditions
3553
+	 * on this model or others
3554
+	 * @param      $default_where_conditions_value
3555
+	 * @param bool $for_this_model false means this is for OTHER related models
3556
+	 * @return bool
3557
+	 */
3558
+	private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
3559
+	{
3560
+		return (
3561
+				   $for_this_model
3562
+				   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
3563
+			   )
3564
+			   || (
3565
+				   ! $for_this_model
3566
+				   && in_array(
3567
+					   $default_where_conditions_value,
3568
+					   array(
3569
+						   EEM_Base::default_where_conditions_minimum_others,
3570
+						   EEM_Base::default_where_conditions_minimum_all,
3571
+					   ),
3572
+					   true
3573
+				   )
3574
+			   );
3575
+	}
3576
+
3577
+
3578
+	/**
3579
+	 * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3580
+	 * then we also add a special where condition which allows for that model's primary key
3581
+	 * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3582
+	 * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3583
+	 *
3584
+	 * @param array    $default_where_conditions
3585
+	 * @param array    $provided_where_conditions
3586
+	 * @param EEM_Base $model
3587
+	 * @param string   $model_relation_path like 'Transaction.Payment.'
3588
+	 * @return array like EEM_Base::get_all's $query_params[0]
3589
+	 * @throws \EE_Error
3590
+	 */
3591
+	private function _override_defaults_or_make_null_friendly(
3592
+		$default_where_conditions,
3593
+		$provided_where_conditions,
3594
+		$model,
3595
+		$model_relation_path
3596
+	) {
3597
+		$null_friendly_where_conditions = array();
3598
+		$none_overridden = true;
3599
+		$or_condition_key_for_defaults = 'OR*' . get_class($model);
3600
+		foreach ($default_where_conditions as $key => $val) {
3601
+			if (isset($provided_where_conditions[$key])) {
3602
+				$none_overridden = false;
3603
+			} else {
3604
+				$null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3605
+			}
3606
+		}
3607
+		if ($none_overridden && $default_where_conditions) {
3608
+			if ($model->has_primary_key_field()) {
3609
+				$null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3610
+																				. "."
3611
+																				. $model->primary_key_name()] = array('IS NULL');
3612
+			}/*else{
3613 3613
 				//@todo NO PK, use other defaults
3614 3614
 			}*/
3615
-        }
3616
-        return $null_friendly_where_conditions;
3617
-    }
3618
-
3619
-
3620
-
3621
-    /**
3622
-     * Uses the _default_where_conditions_strategy set during __construct() to get
3623
-     * default where conditions on all get_all, update, and delete queries done by this model.
3624
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3625
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3626
-     *
3627
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3628
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3629
-     */
3630
-    private function _get_default_where_conditions($model_relation_path = null)
3631
-    {
3632
-        if ($this->_ignore_where_strategy) {
3633
-            return array();
3634
-        }
3635
-        return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3636
-    }
3637
-
3638
-
3639
-
3640
-    /**
3641
-     * Uses the _minimum_where_conditions_strategy set during __construct() to get
3642
-     * minimum where conditions on all get_all, update, and delete queries done by this model.
3643
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3644
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3645
-     * Similar to _get_default_where_conditions
3646
-     *
3647
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3648
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3649
-     */
3650
-    protected function _get_minimum_where_conditions($model_relation_path = null)
3651
-    {
3652
-        if ($this->_ignore_where_strategy) {
3653
-            return array();
3654
-        }
3655
-        return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3656
-    }
3657
-
3658
-
3659
-
3660
-    /**
3661
-     * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3662
-     * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3663
-     *
3664
-     * @param EE_Model_Query_Info_Carrier $model_query_info
3665
-     * @return string
3666
-     * @throws \EE_Error
3667
-     */
3668
-    private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3669
-    {
3670
-        $selects = $this->_get_columns_to_select_for_this_model();
3671
-        foreach (
3672
-            $model_query_info->get_model_names_included() as $model_relation_chain =>
3673
-            $name_of_other_model_included
3674
-        ) {
3675
-            $other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3676
-            $other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3677
-            foreach ($other_model_selects as $key => $value) {
3678
-                $selects[] = $value;
3679
-            }
3680
-        }
3681
-        return implode(", ", $selects);
3682
-    }
3683
-
3684
-
3685
-
3686
-    /**
3687
-     * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3688
-     * So that's going to be the columns for all the fields on the model
3689
-     *
3690
-     * @param string $model_relation_chain like 'Question.Question_Group.Event'
3691
-     * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3692
-     */
3693
-    public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3694
-    {
3695
-        $fields = $this->field_settings();
3696
-        $selects = array();
3697
-        $table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3698
-            $this->get_this_model_name());
3699
-        foreach ($fields as $field_obj) {
3700
-            $selects[] = $table_alias_with_model_relation_chain_prefix
3701
-                         . $field_obj->get_table_alias()
3702
-                         . "."
3703
-                         . $field_obj->get_table_column()
3704
-                         . " AS '"
3705
-                         . $table_alias_with_model_relation_chain_prefix
3706
-                         . $field_obj->get_table_alias()
3707
-                         . "."
3708
-                         . $field_obj->get_table_column()
3709
-                         . "'";
3710
-        }
3711
-        //make sure we are also getting the PKs of each table
3712
-        $tables = $this->get_tables();
3713
-        if (count($tables) > 1) {
3714
-            foreach ($tables as $table_obj) {
3715
-                $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3716
-                                       . $table_obj->get_fully_qualified_pk_column();
3717
-                if (! in_array($qualified_pk_column, $selects)) {
3718
-                    $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3719
-                }
3720
-            }
3721
-        }
3722
-        return $selects;
3723
-    }
3724
-
3725
-
3726
-
3727
-    /**
3728
-     * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3729
-     * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3730
-     * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3731
-     * SQL for joining, and the data types
3732
-     *
3733
-     * @param null|string                 $original_query_param
3734
-     * @param string                      $query_param          like Registration.Transaction.TXN_ID
3735
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3736
-     * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3737
-     *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3738
-     *                                                          column name. We only want model names, eg 'Event.Venue'
3739
-     *                                                          or 'Registration's
3740
-     * @param string                      $original_query_param what it originally was (eg
3741
-     *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3742
-     *                                                          matches $query_param
3743
-     * @throws EE_Error
3744
-     * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3745
-     */
3746
-    private function _extract_related_model_info_from_query_param(
3747
-        $query_param,
3748
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3749
-        $query_param_type,
3750
-        $original_query_param = null
3751
-    ) {
3752
-        if ($original_query_param === null) {
3753
-            $original_query_param = $query_param;
3754
-        }
3755
-        $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3756
-        /** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3757
-        $allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3758
-        $allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3759
-        //check to see if we have a field on this model
3760
-        $this_model_fields = $this->field_settings(true);
3761
-        if (array_key_exists($query_param, $this_model_fields)) {
3762
-            if ($allow_fields) {
3763
-                return;
3764
-            } else {
3765
-                throw new EE_Error(sprintf(__("Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
3766
-                    "event_espresso"),
3767
-                    $query_param, get_class($this), $query_param_type, $original_query_param));
3768
-            }
3769
-        } //check if this is a special logic query param
3770
-        elseif (in_array($query_param, $this->_logic_query_param_keys, true)) {
3771
-            if ($allow_logic_query_params) {
3772
-                return;
3773
-            } else {
3774
-                throw new EE_Error(
3775
-                    sprintf(
3776
-                        __('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',
3777
-                            'event_espresso'),
3778
-                        implode('", "', $this->_logic_query_param_keys),
3779
-                        $query_param,
3780
-                        get_class($this),
3781
-                        '<br />',
3782
-                        "\t"
3783
-                        . ' $passed_in_query_info = <pre>'
3784
-                        . print_r($passed_in_query_info, true)
3785
-                        . '</pre>'
3786
-                        . "\n\t"
3787
-                        . ' $query_param_type = '
3788
-                        . $query_param_type
3789
-                        . "\n\t"
3790
-                        . ' $original_query_param = '
3791
-                        . $original_query_param
3792
-                    )
3793
-                );
3794
-            }
3795
-        } //check if it's a custom selection
3796
-        elseif (array_key_exists($query_param, $this->_custom_selections)) {
3797
-            return;
3798
-        }
3799
-        //check if has a model name at the beginning
3800
-        //and
3801
-        //check if it's a field on a related model
3802
-        foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3803
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3804
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3805
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
3806
-                if ($query_param === '') {
3807
-                    //nothing left to $query_param
3808
-                    //we should actually end in a field name, not a model like this!
3809
-                    throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3810
-                        "event_espresso"),
3811
-                        $query_param, $query_param_type, get_class($this), $valid_related_model_name));
3812
-                } else {
3813
-                    $related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3814
-                    $related_model_obj->_extract_related_model_info_from_query_param($query_param,
3815
-                        $passed_in_query_info, $query_param_type, $original_query_param);
3816
-                    return;
3817
-                }
3818
-            } elseif ($query_param === $valid_related_model_name) {
3819
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3820
-                return;
3821
-            }
3822
-        }
3823
-        //ok so $query_param didn't start with a model name
3824
-        //and we previously confirmed it wasn't a logic query param or field on the current model
3825
-        //it's wack, that's what it is
3826
-        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",
3827
-            "event_espresso"),
3828
-            $query_param, get_class($this), $query_param_type, $original_query_param));
3829
-    }
3830
-
3831
-
3832
-
3833
-    /**
3834
-     * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3835
-     * and store it on $passed_in_query_info
3836
-     *
3837
-     * @param string                      $model_name
3838
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3839
-     * @param string                      $original_query_param used to extract the relation chain between the queried
3840
-     *                                                          model and $model_name. Eg, if we are querying Event,
3841
-     *                                                          and are adding a join to 'Payment' with the original
3842
-     *                                                          query param key
3843
-     *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3844
-     *                                                          to extract 'Registration.Transaction.Payment', in case
3845
-     *                                                          Payment wants to add default query params so that it
3846
-     *                                                          will know what models to prepend onto its default query
3847
-     *                                                          params or in case it wants to rename tables (in case
3848
-     *                                                          there are multiple joins to the same table)
3849
-     * @return void
3850
-     * @throws \EE_Error
3851
-     */
3852
-    private function _add_join_to_model(
3853
-        $model_name,
3854
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3855
-        $original_query_param
3856
-    ) {
3857
-        $relation_obj = $this->related_settings_for($model_name);
3858
-        $model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3859
-        //check if the relation is HABTM, because then we're essentially doing two joins
3860
-        //If so, join first to the JOIN table, and add its data types, and then continue as normal
3861
-        if ($relation_obj instanceof EE_HABTM_Relation) {
3862
-            $join_model_obj = $relation_obj->get_join_model();
3863
-            //replace the model specified with the join model for this relation chain, whi
3864
-            $relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
3865
-                $join_model_obj->get_this_model_name(), $model_relation_chain);
3866
-            $new_query_info = new EE_Model_Query_Info_Carrier(
3867
-                array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
3868
-                $relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model));
3869
-            $passed_in_query_info->merge($new_query_info);
3870
-        }
3871
-        //now just join to the other table pointed to by the relation object, and add its data types
3872
-        $new_query_info = new EE_Model_Query_Info_Carrier(
3873
-            array($model_relation_chain => $model_name),
3874
-            $relation_obj->get_join_statement($model_relation_chain));
3875
-        $passed_in_query_info->merge($new_query_info);
3876
-    }
3877
-
3878
-
3879
-
3880
-    /**
3881
-     * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
3882
-     *
3883
-     * @param array $where_params like EEM_Base::get_all
3884
-     * @return string of SQL
3885
-     * @throws \EE_Error
3886
-     */
3887
-    private function _construct_where_clause($where_params)
3888
-    {
3889
-        $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
3890
-        if ($SQL) {
3891
-            return " WHERE " . $SQL;
3892
-        } else {
3893
-            return '';
3894
-        }
3895
-    }
3896
-
3897
-
3898
-
3899
-    /**
3900
-     * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
3901
-     * and should be passed HAVING parameters, not WHERE parameters
3902
-     *
3903
-     * @param array $having_params
3904
-     * @return string
3905
-     * @throws \EE_Error
3906
-     */
3907
-    private function _construct_having_clause($having_params)
3908
-    {
3909
-        $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
3910
-        if ($SQL) {
3911
-            return " HAVING " . $SQL;
3912
-        } else {
3913
-            return '';
3914
-        }
3915
-    }
3916
-
3917
-
3918
-
3919
-    /**
3920
-     * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
3921
-     * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
3922
-     * EEM_Attendee.
3923
-     *
3924
-     * @param string $field_name
3925
-     * @param string $model_name
3926
-     * @return EE_Model_Field_Base
3927
-     * @throws EE_Error
3928
-     */
3929
-    protected function _get_field_on_model($field_name, $model_name)
3930
-    {
3931
-        $model_class = 'EEM_' . $model_name;
3932
-        $model_filepath = $model_class . ".model.php";
3933
-        if (is_readable($model_filepath)) {
3934
-            require_once($model_filepath);
3935
-            $model_instance = call_user_func($model_name . "::instance");
3936
-            /* @var $model_instance EEM_Base */
3937
-            return $model_instance->field_settings_for($field_name);
3938
-        } else {
3939
-            throw new EE_Error(sprintf(__('No model named %s exists, with classname %s and filepath %s',
3940
-                'event_espresso'), $model_name, $model_class, $model_filepath));
3941
-        }
3942
-    }
3943
-
3944
-
3945
-
3946
-    /**
3947
-     * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
3948
-     * Event_Meta.meta_value = 'foo'))"
3949
-     *
3950
-     * @param array  $where_params see EEM_Base::get_all for documentation
3951
-     * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
3952
-     * @throws EE_Error
3953
-     * @return string of SQL
3954
-     */
3955
-    private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
3956
-    {
3957
-        $where_clauses = array();
3958
-        foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
3959
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
3960
-            if (in_array($query_param, $this->_logic_query_param_keys)) {
3961
-                switch ($query_param) {
3962
-                    case 'not':
3963
-                    case 'NOT':
3964
-                        $where_clauses[] = "! ("
3965
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3966
-                                $glue)
3967
-                                           . ")";
3968
-                        break;
3969
-                    case 'and':
3970
-                    case 'AND':
3971
-                        $where_clauses[] = " ("
3972
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3973
-                                ' AND ')
3974
-                                           . ")";
3975
-                        break;
3976
-                    case 'or':
3977
-                    case 'OR':
3978
-                        $where_clauses[] = " ("
3979
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3980
-                                ' OR ')
3981
-                                           . ")";
3982
-                        break;
3983
-                }
3984
-            } else {
3985
-                $field_obj = $this->_deduce_field_from_query_param($query_param);
3986
-                //if it's not a normal field, maybe it's a custom selection?
3987
-                if (! $field_obj) {
3988
-                    if (isset($this->_custom_selections[$query_param][1])) {
3989
-                        $field_obj = $this->_custom_selections[$query_param][1];
3990
-                    } else {
3991
-                        throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
3992
-                            "event_espresso"), $query_param));
3993
-                    }
3994
-                }
3995
-                $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
3996
-                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
3997
-            }
3998
-        }
3999
-        return $where_clauses ? implode($glue, $where_clauses) : '';
4000
-    }
4001
-
4002
-
4003
-
4004
-    /**
4005
-     * Takes the input parameter and extract the table name (alias) and column name
4006
-     *
4007
-     * @param array $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4008
-     * @throws EE_Error
4009
-     * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
4010
-     */
4011
-    private function _deduce_column_name_from_query_param($query_param)
4012
-    {
4013
-        $field = $this->_deduce_field_from_query_param($query_param);
4014
-        if ($field) {
4015
-            $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4016
-                $query_param);
4017
-            return $table_alias_prefix . $field->get_qualified_column();
4018
-        } elseif (array_key_exists($query_param, $this->_custom_selections)) {
4019
-            //maybe it's custom selection item?
4020
-            //if so, just use it as the "column name"
4021
-            return $query_param;
4022
-        } else {
4023
-            throw new EE_Error(sprintf(__("%s is not a valid field on this model, nor a custom selection (%s)",
4024
-                "event_espresso"), $query_param, implode(",", $this->_custom_selections)));
4025
-        }
4026
-    }
4027
-
4028
-
4029
-
4030
-    /**
4031
-     * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
4032
-     * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
4033
-     * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
4034
-     * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
4035
-     *
4036
-     * @param string $condition_query_param_key
4037
-     * @return string
4038
-     */
4039
-    private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
4040
-    {
4041
-        $pos_of_star = strpos($condition_query_param_key, '*');
4042
-        if ($pos_of_star === false) {
4043
-            return $condition_query_param_key;
4044
-        } else {
4045
-            $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
4046
-            return $condition_query_param_sans_star;
4047
-        }
4048
-    }
4049
-
4050
-
4051
-
4052
-    /**
4053
-     * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
4054
-     *
4055
-     * @param                            mixed      array | string    $op_and_value
4056
-     * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
4057
-     * @throws EE_Error
4058
-     * @return string
4059
-     */
4060
-    private function _construct_op_and_value($op_and_value, $field_obj)
4061
-    {
4062
-        if (is_array($op_and_value)) {
4063
-            $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4064
-            if (! $operator) {
4065
-                $php_array_like_string = array();
4066
-                foreach ($op_and_value as $key => $value) {
4067
-                    $php_array_like_string[] = "$key=>$value";
4068
-                }
4069
-                throw new EE_Error(
4070
-                    sprintf(
4071
-                        __(
4072
-                            "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))",
4073
-                            "event_espresso"
4074
-                        ),
4075
-                        implode(",", $php_array_like_string)
4076
-                    )
4077
-                );
4078
-            }
4079
-            $value = isset($op_and_value[1]) ? $op_and_value[1] : null;
4080
-        } else {
4081
-            $operator = '=';
4082
-            $value = $op_and_value;
4083
-        }
4084
-        //check to see if the value is actually another field
4085
-        if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4086
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4087
-        } elseif (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4088
-            //in this case, the value should be an array, or at least a comma-separated list
4089
-            //it will need to handle a little differently
4090
-            $cleaned_value = $this->_construct_in_value($value, $field_obj);
4091
-            //note: $cleaned_value has already been run through $wpdb->prepare()
4092
-            return $operator . SP . $cleaned_value;
4093
-        } elseif (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4094
-            //the value should be an array with count of two.
4095
-            if (count($value) !== 2) {
4096
-                throw new EE_Error(
4097
-                    sprintf(
4098
-                        __(
4099
-                            "The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
4100
-                            'event_espresso'
4101
-                        ),
4102
-                        "BETWEEN"
4103
-                    )
4104
-                );
4105
-            }
4106
-            $cleaned_value = $this->_construct_between_value($value, $field_obj);
4107
-            return $operator . SP . $cleaned_value;
4108
-        } elseif (in_array($operator, $this->_null_style_operators)) {
4109
-            if ($value !== null) {
4110
-                throw new EE_Error(
4111
-                    sprintf(
4112
-                        __(
4113
-                            "You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
4114
-                            "event_espresso"
4115
-                        ),
4116
-                        $value,
4117
-                        $operator
4118
-                    )
4119
-                );
4120
-            }
4121
-            return $operator;
4122
-        } elseif ($operator === 'LIKE' && ! is_array($value)) {
4123
-            //if the operator is 'LIKE', we want to allow percent signs (%) and not
4124
-            //remove other junk. So just treat it as a string.
4125
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4126
-        } elseif (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4127
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4128
-        } elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4129
-            throw new EE_Error(
4130
-                sprintf(
4131
-                    __(
4132
-                        "Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
4133
-                        'event_espresso'
4134
-                    ),
4135
-                    $operator,
4136
-                    $operator
4137
-                )
4138
-            );
4139
-        } elseif (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4140
-            throw new EE_Error(
4141
-                sprintf(
4142
-                    __(
4143
-                        "Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
4144
-                        'event_espresso'
4145
-                    ),
4146
-                    $operator,
4147
-                    $operator
4148
-                )
4149
-            );
4150
-        } else {
4151
-            throw new EE_Error(
4152
-                sprintf(
4153
-                    __(
4154
-                        "It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
4155
-                        "event_espresso"
4156
-                    ),
4157
-                    http_build_query($op_and_value)
4158
-                )
4159
-            );
4160
-        }
4161
-    }
4162
-
4163
-
4164
-
4165
-    /**
4166
-     * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
4167
-     *
4168
-     * @param array                      $values
4169
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
4170
-     *                                              '%s'
4171
-     * @return string
4172
-     * @throws \EE_Error
4173
-     */
4174
-    public function _construct_between_value($values, $field_obj)
4175
-    {
4176
-        $cleaned_values = array();
4177
-        foreach ($values as $value) {
4178
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4179
-        }
4180
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
4181
-    }
4182
-
4183
-
4184
-
4185
-    /**
4186
-     * Takes an array or a comma-separated list of $values and cleans them
4187
-     * according to $data_type using $wpdb->prepare, and then makes the list a
4188
-     * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4189
-     * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4190
-     * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4191
-     *
4192
-     * @param mixed                      $values    array or comma-separated string
4193
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4194
-     * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4195
-     * @throws \EE_Error
4196
-     */
4197
-    public function _construct_in_value($values, $field_obj)
4198
-    {
4199
-        //check if the value is a CSV list
4200
-        if (is_string($values)) {
4201
-            //in which case, turn it into an array
4202
-            $values = explode(",", $values);
4203
-        }
4204
-        $cleaned_values = array();
4205
-        foreach ($values as $value) {
4206
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4207
-        }
4208
-        //we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4209
-        //but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4210
-        //which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4211
-        if (empty($cleaned_values)) {
4212
-            $all_fields = $this->field_settings();
4213
-            $a_field = array_shift($all_fields);
4214
-            $main_table = $this->_get_main_table();
4215
-            $cleaned_values[] = "SELECT "
4216
-                                . $a_field->get_table_column()
4217
-                                . " FROM "
4218
-                                . $main_table->get_table_name()
4219
-                                . " WHERE FALSE";
4220
-        }
4221
-        return "(" . implode(",", $cleaned_values) . ")";
4222
-    }
4223
-
4224
-
4225
-
4226
-    /**
4227
-     * @param mixed                      $value
4228
-     * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4229
-     * @throws EE_Error
4230
-     * @return false|null|string
4231
-     */
4232
-    private function _wpdb_prepare_using_field($value, $field_obj)
4233
-    {
4234
-        /** @type WPDB $wpdb */
4235
-        global $wpdb;
4236
-        if ($field_obj instanceof EE_Model_Field_Base) {
4237
-            return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4238
-                $this->_prepare_value_for_use_in_db($value, $field_obj));
4239
-        } else {//$field_obj should really just be a data type
4240
-            if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4241
-                throw new EE_Error(sprintf(__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4242
-                    $field_obj, implode(",", $this->_valid_wpdb_data_types)));
4243
-            }
4244
-            return $wpdb->prepare($field_obj, $value);
4245
-        }
4246
-    }
4247
-
4248
-
4249
-
4250
-    /**
4251
-     * Takes the input parameter and finds the model field that it indicates.
4252
-     *
4253
-     * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4254
-     * @throws EE_Error
4255
-     * @return EE_Model_Field_Base
4256
-     */
4257
-    protected function _deduce_field_from_query_param($query_param_name)
4258
-    {
4259
-        //ok, now proceed with deducing which part is the model's name, and which is the field's name
4260
-        //which will help us find the database table and column
4261
-        $query_param_parts = explode(".", $query_param_name);
4262
-        if (empty($query_param_parts)) {
4263
-            throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4264
-                'event_espresso'), $query_param_name));
4265
-        }
4266
-        $number_of_parts = count($query_param_parts);
4267
-        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4268
-        if ($number_of_parts === 1) {
4269
-            $field_name = $last_query_param_part;
4270
-            $model_obj = $this;
4271
-        } else {// $number_of_parts >= 2
4272
-            //the last part is the column name, and there are only 2parts. therefore...
4273
-            $field_name = $last_query_param_part;
4274
-            $model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4275
-        }
4276
-        try {
4277
-            return $model_obj->field_settings_for($field_name);
4278
-        } catch (EE_Error $e) {
4279
-            return null;
4280
-        }
4281
-    }
4282
-
4283
-
4284
-
4285
-    /**
4286
-     * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4287
-     * alias and column which corresponds to it
4288
-     *
4289
-     * @param string $field_name
4290
-     * @throws EE_Error
4291
-     * @return string
4292
-     */
4293
-    public function _get_qualified_column_for_field($field_name)
4294
-    {
4295
-        $all_fields = $this->field_settings();
4296
-        $field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4297
-        if ($field) {
4298
-            return $field->get_qualified_column();
4299
-        } else {
4300
-            throw new EE_Error(sprintf(__("There is no field titled %s on model %s. Either the query trying to use it is bad, or you need to add it to the list of fields on the model.",
4301
-                'event_espresso'), $field_name, get_class($this)));
4302
-        }
4303
-    }
4304
-
4305
-
4306
-
4307
-    /**
4308
-     * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
4309
-     * Example usage:
4310
-     * EEM_Ticket::instance()->get_all_wpdb_results(
4311
-     *      array(),
4312
-     *      ARRAY_A,
4313
-     *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
4314
-     *  );
4315
-     * is equivalent to
4316
-     *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
4317
-     * and
4318
-     *  EEM_Event::instance()->get_all_wpdb_results(
4319
-     *      array(
4320
-     *          array(
4321
-     *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
4322
-     *          ),
4323
-     *          ARRAY_A,
4324
-     *          implode(
4325
-     *              ', ',
4326
-     *              array_merge(
4327
-     *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
4328
-     *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
4329
-     *              )
4330
-     *          )
4331
-     *      )
4332
-     *  );
4333
-     * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
4334
-     *
4335
-     * @param string $model_relation_chain        the chain of models used to join between the model you want to query
4336
-     *                                            and the one whose fields you are selecting for example: when querying
4337
-     *                                            tickets model and selecting fields from the tickets model you would
4338
-     *                                            leave this parameter empty, because no models are needed to join
4339
-     *                                            between the queried model and the selected one. Likewise when
4340
-     *                                            querying the datetime model and selecting fields from the tickets
4341
-     *                                            model, it would also be left empty, because there is a direct
4342
-     *                                            relation from datetimes to tickets, so no model is needed to join
4343
-     *                                            them together. However, when querying from the event model and
4344
-     *                                            selecting fields from the ticket model, you should provide the string
4345
-     *                                            'Datetime', indicating that the event model must first join to the
4346
-     *                                            datetime model in order to find its relation to ticket model.
4347
-     *                                            Also, when querying from the venue model and selecting fields from
4348
-     *                                            the ticket model, you should provide the string 'Event.Datetime',
4349
-     *                                            indicating you need to join the venue model to the event model,
4350
-     *                                            to the datetime model, in order to find its relation to the ticket model.
4351
-     *                                            This string is used to deduce the prefix that gets added onto the
4352
-     *                                            models' tables qualified columns
4353
-     * @param bool   $return_string               if true, will return a string with qualified column names separated
4354
-     *                                            by ', ' if false, will simply return a numerically indexed array of
4355
-     *                                            qualified column names
4356
-     * @return array|string
4357
-     */
4358
-    public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4359
-    {
4360
-        $table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4361
-        $qualified_columns = array();
4362
-        foreach ($this->field_settings() as $field_name => $field) {
4363
-            $qualified_columns[] = $table_prefix . $field->get_qualified_column();
4364
-        }
4365
-        return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4366
-    }
4367
-
4368
-
4369
-
4370
-    /**
4371
-     * constructs the select use on special limit joins
4372
-     * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4373
-     * its setup so the select query will be setup on and just doing the special select join off of the primary table
4374
-     * (as that is typically where the limits would be set).
4375
-     *
4376
-     * @param  string       $table_alias The table the select is being built for
4377
-     * @param  mixed|string $limit       The limit for this select
4378
-     * @return string                The final select join element for the query.
4379
-     */
4380
-    public function _construct_limit_join_select($table_alias, $limit)
4381
-    {
4382
-        $SQL = '';
4383
-        foreach ($this->_tables as $table_obj) {
4384
-            if ($table_obj instanceof EE_Primary_Table) {
4385
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4386
-                    ? $table_obj->get_select_join_limit($limit)
4387
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4388
-            } elseif ($table_obj instanceof EE_Secondary_Table) {
4389
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4390
-                    ? $table_obj->get_select_join_limit_join($limit)
4391
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
4392
-            }
4393
-        }
4394
-        return $SQL;
4395
-    }
4396
-
4397
-
4398
-
4399
-    /**
4400
-     * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4401
-     * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4402
-     *
4403
-     * @return string SQL
4404
-     * @throws \EE_Error
4405
-     */
4406
-    public function _construct_internal_join()
4407
-    {
4408
-        $SQL = $this->_get_main_table()->get_table_sql();
4409
-        $SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4410
-        return $SQL;
4411
-    }
4412
-
4413
-
4414
-
4415
-    /**
4416
-     * Constructs the SQL for joining all the tables on this model.
4417
-     * Normally $alias should be the primary table's alias, but in cases where
4418
-     * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4419
-     * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4420
-     * alias, this will construct SQL like:
4421
-     * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4422
-     * With $alias being a secondary table's alias, this will construct SQL like:
4423
-     * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4424
-     *
4425
-     * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4426
-     * @return string
4427
-     */
4428
-    public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4429
-    {
4430
-        $SQL = '';
4431
-        $alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4432
-        foreach ($this->_tables as $table_obj) {
4433
-            if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4434
-                if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4435
-                    //so we're joining to this table, meaning the table is already in
4436
-                    //the FROM statement, BUT the primary table isn't. So we want
4437
-                    //to add the inverse join sql
4438
-                    $SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4439
-                } else {
4440
-                    //just add a regular JOIN to this table from the primary table
4441
-                    $SQL .= $table_obj->get_join_sql($alias_prefixed);
4442
-                }
4443
-            }//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4444
-        }
4445
-        return $SQL;
4446
-    }
4447
-
4448
-
4449
-
4450
-    /**
4451
-     * Gets an array for storing all the data types on the next-to-be-executed-query.
4452
-     * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4453
-     * their data type (eg, '%s', '%d', etc)
4454
-     *
4455
-     * @return array
4456
-     */
4457
-    public function _get_data_types()
4458
-    {
4459
-        $data_types = array();
4460
-        foreach ($this->field_settings() as $field_obj) {
4461
-            //$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4462
-            /** @var $field_obj EE_Model_Field_Base */
4463
-            $data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4464
-        }
4465
-        return $data_types;
4466
-    }
4467
-
4468
-
4469
-
4470
-    /**
4471
-     * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4472
-     *
4473
-     * @param string $model_name
4474
-     * @throws EE_Error
4475
-     * @return EEM_Base
4476
-     */
4477
-    public function get_related_model_obj($model_name)
4478
-    {
4479
-        $model_classname = "EEM_" . $model_name;
4480
-        if (! class_exists($model_classname)) {
4481
-            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",
4482
-                'event_espresso'), $model_name, $model_classname));
4483
-        }
4484
-        return call_user_func($model_classname . "::instance");
4485
-    }
4486
-
4487
-
4488
-
4489
-    /**
4490
-     * Returns the array of EE_ModelRelations for this model.
4491
-     *
4492
-     * @return EE_Model_Relation_Base[]
4493
-     */
4494
-    public function relation_settings()
4495
-    {
4496
-        return $this->_model_relations;
4497
-    }
4498
-
4499
-
4500
-
4501
-    /**
4502
-     * Gets all related models that this model BELONGS TO. Handy to know sometimes
4503
-     * because without THOSE models, this model probably doesn't have much purpose.
4504
-     * (Eg, without an event, datetimes have little purpose.)
4505
-     *
4506
-     * @return EE_Belongs_To_Relation[]
4507
-     */
4508
-    public function belongs_to_relations()
4509
-    {
4510
-        $belongs_to_relations = array();
4511
-        foreach ($this->relation_settings() as $model_name => $relation_obj) {
4512
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
4513
-                $belongs_to_relations[$model_name] = $relation_obj;
4514
-            }
4515
-        }
4516
-        return $belongs_to_relations;
4517
-    }
4518
-
4519
-
4520
-
4521
-    /**
4522
-     * Returns the specified EE_Model_Relation, or throws an exception
4523
-     *
4524
-     * @param string $relation_name name of relation, key in $this->_relatedModels
4525
-     * @throws EE_Error
4526
-     * @return EE_Model_Relation_Base
4527
-     */
4528
-    public function related_settings_for($relation_name)
4529
-    {
4530
-        $relatedModels = $this->relation_settings();
4531
-        if (! array_key_exists($relation_name, $relatedModels)) {
4532
-            throw new EE_Error(
4533
-                sprintf(
4534
-                    __('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4535
-                        'event_espresso'),
4536
-                    $relation_name,
4537
-                    $this->_get_class_name(),
4538
-                    implode(', ', array_keys($relatedModels))
4539
-                )
4540
-            );
4541
-        }
4542
-        return $relatedModels[$relation_name];
4543
-    }
4544
-
4545
-
4546
-
4547
-    /**
4548
-     * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4549
-     * fields
4550
-     *
4551
-     * @param string $fieldName
4552
-     * @throws EE_Error
4553
-     * @return EE_Model_Field_Base
4554
-     */
4555
-    public function field_settings_for($fieldName)
4556
-    {
4557
-        $fieldSettings = $this->field_settings(true);
4558
-        if (! array_key_exists($fieldName, $fieldSettings)) {
4559
-            throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4560
-                get_class($this)));
4561
-        }
4562
-        return $fieldSettings[$fieldName];
4563
-    }
4564
-
4565
-
4566
-
4567
-    /**
4568
-     * Checks if this field exists on this model
4569
-     *
4570
-     * @param string $fieldName a key in the model's _field_settings array
4571
-     * @return boolean
4572
-     */
4573
-    public function has_field($fieldName)
4574
-    {
4575
-        $fieldSettings = $this->field_settings(true);
4576
-        if (isset($fieldSettings[$fieldName])) {
4577
-            return true;
4578
-        } else {
4579
-            return false;
4580
-        }
4581
-    }
4582
-
4583
-
4584
-
4585
-    /**
4586
-     * Returns whether or not this model has a relation to the specified model
4587
-     *
4588
-     * @param string $relation_name possibly one of the keys in the relation_settings array
4589
-     * @return boolean
4590
-     */
4591
-    public function has_relation($relation_name)
4592
-    {
4593
-        $relations = $this->relation_settings();
4594
-        if (isset($relations[$relation_name])) {
4595
-            return true;
4596
-        } else {
4597
-            return false;
4598
-        }
4599
-    }
4600
-
4601
-
4602
-
4603
-    /**
4604
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4605
-     * Eg, on EE_Answer that would be ANS_ID field object
4606
-     *
4607
-     * @param $field_obj
4608
-     * @return boolean
4609
-     */
4610
-    public function is_primary_key_field($field_obj)
4611
-    {
4612
-        return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4613
-    }
4614
-
4615
-
4616
-
4617
-    /**
4618
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4619
-     * Eg, on EE_Answer that would be ANS_ID field object
4620
-     *
4621
-     * @return EE_Model_Field_Base
4622
-     * @throws EE_Error
4623
-     */
4624
-    public function get_primary_key_field()
4625
-    {
4626
-        if ($this->_primary_key_field === null) {
4627
-            foreach ($this->field_settings(true) as $field_obj) {
4628
-                if ($this->is_primary_key_field($field_obj)) {
4629
-                    $this->_primary_key_field = $field_obj;
4630
-                    break;
4631
-                }
4632
-            }
4633
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4634
-                throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4635
-                    get_class($this)));
4636
-            }
4637
-        }
4638
-        return $this->_primary_key_field;
4639
-    }
4640
-
4641
-
4642
-
4643
-    /**
4644
-     * Returns whether or not not there is a primary key on this model.
4645
-     * Internally does some caching.
4646
-     *
4647
-     * @return boolean
4648
-     */
4649
-    public function has_primary_key_field()
4650
-    {
4651
-        if ($this->_has_primary_key_field === null) {
4652
-            try {
4653
-                $this->get_primary_key_field();
4654
-                $this->_has_primary_key_field = true;
4655
-            } catch (EE_Error $e) {
4656
-                $this->_has_primary_key_field = false;
4657
-            }
4658
-        }
4659
-        return $this->_has_primary_key_field;
4660
-    }
4661
-
4662
-
4663
-
4664
-    /**
4665
-     * Finds the first field of type $field_class_name.
4666
-     *
4667
-     * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4668
-     *                                 EE_Foreign_Key_Field, etc
4669
-     * @return EE_Model_Field_Base or null if none is found
4670
-     */
4671
-    public function get_a_field_of_type($field_class_name)
4672
-    {
4673
-        foreach ($this->field_settings() as $field) {
4674
-            if ($field instanceof $field_class_name) {
4675
-                return $field;
4676
-            }
4677
-        }
4678
-        return null;
4679
-    }
4680
-
4681
-
4682
-
4683
-    /**
4684
-     * Gets a foreign key field pointing to model.
4685
-     *
4686
-     * @param string $model_name eg Event, Registration, not EEM_Event
4687
-     * @return EE_Foreign_Key_Field_Base
4688
-     * @throws EE_Error
4689
-     */
4690
-    public function get_foreign_key_to($model_name)
4691
-    {
4692
-        if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4693
-            foreach ($this->field_settings() as $field) {
4694
-                if (
4695
-                    $field instanceof EE_Foreign_Key_Field_Base
4696
-                    && in_array($model_name, $field->get_model_names_pointed_to())
4697
-                ) {
4698
-                    $this->_cache_foreign_key_to_fields[$model_name] = $field;
4699
-                    break;
4700
-                }
4701
-            }
4702
-            if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4703
-                throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4704
-                    'event_espresso'), $model_name, get_class($this)));
4705
-            }
4706
-        }
4707
-        return $this->_cache_foreign_key_to_fields[$model_name];
4708
-    }
4709
-
4710
-
4711
-
4712
-    /**
4713
-     * Gets the actual table for the table alias
4714
-     *
4715
-     * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4716
-     *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4717
-     *                            Either one works
4718
-     * @return EE_Table_Base
4719
-     */
4720
-    public function get_table_for_alias($table_alias)
4721
-    {
4722
-        $table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4723
-        return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4724
-    }
4725
-
4726
-
4727
-
4728
-    /**
4729
-     * Returns a flat array of all field son this model, instead of organizing them
4730
-     * by table_alias as they are in the constructor.
4731
-     *
4732
-     * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4733
-     * @return EE_Model_Field_Base[] where the keys are the field's name
4734
-     */
4735
-    public function field_settings($include_db_only_fields = false)
4736
-    {
4737
-        if ($include_db_only_fields) {
4738
-            if ($this->_cached_fields === null) {
4739
-                $this->_cached_fields = array();
4740
-                foreach ($this->_fields as $fields_corresponding_to_table) {
4741
-                    foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4742
-                        $this->_cached_fields[$field_name] = $field_obj;
4743
-                    }
4744
-                }
4745
-            }
4746
-            return $this->_cached_fields;
4747
-        } else {
4748
-            if ($this->_cached_fields_non_db_only === null) {
4749
-                $this->_cached_fields_non_db_only = array();
4750
-                foreach ($this->_fields as $fields_corresponding_to_table) {
4751
-                    foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4752
-                        /** @var $field_obj EE_Model_Field_Base */
4753
-                        if (! $field_obj->is_db_only_field()) {
4754
-                            $this->_cached_fields_non_db_only[$field_name] = $field_obj;
4755
-                        }
4756
-                    }
4757
-                }
4758
-            }
4759
-            return $this->_cached_fields_non_db_only;
4760
-        }
4761
-    }
4762
-
4763
-
4764
-
4765
-    /**
4766
-     *        cycle though array of attendees and create objects out of each item
4767
-     *
4768
-     * @access        private
4769
-     * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4770
-     * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4771
-     *                           numerically indexed)
4772
-     * @throws \EE_Error
4773
-     */
4774
-    protected function _create_objects($rows = array())
4775
-    {
4776
-        $array_of_objects = array();
4777
-        if (empty($rows)) {
4778
-            return array();
4779
-        }
4780
-        $count_if_model_has_no_primary_key = 0;
4781
-        $has_primary_key = $this->has_primary_key_field();
4782
-        $primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4783
-        foreach ((array)$rows as $row) {
4784
-            if (empty($row)) {
4785
-                //wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4786
-                return array();
4787
-            }
4788
-            //check if we've already set this object in the results array,
4789
-            //in which case there's no need to process it further (again)
4790
-            if ($has_primary_key) {
4791
-                $table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4792
-                    $row,
4793
-                    $primary_key_field->get_qualified_column(),
4794
-                    $primary_key_field->get_table_column()
4795
-                );
4796
-                if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4797
-                    continue;
4798
-                }
4799
-            }
4800
-            $classInstance = $this->instantiate_class_from_array_or_object($row);
4801
-            if (! $classInstance) {
4802
-                throw new EE_Error(
4803
-                    sprintf(
4804
-                        __('Could not create instance of class %s from row %s', 'event_espresso'),
4805
-                        $this->get_this_model_name(),
4806
-                        http_build_query($row)
4807
-                    )
4808
-                );
4809
-            }
4810
-            //set the timezone on the instantiated objects
4811
-            $classInstance->set_timezone($this->_timezone);
4812
-            //make sure if there is any timezone setting present that we set the timezone for the object
4813
-            $key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4814
-            $array_of_objects[$key] = $classInstance;
4815
-            //also, for all the relations of type BelongsTo, see if we can cache
4816
-            //those related models
4817
-            //(we could do this for other relations too, but if there are conditions
4818
-            //that filtered out some fo the results, then we'd be caching an incomplete set
4819
-            //so it requires a little more thought than just caching them immediately...)
4820
-            foreach ($this->_model_relations as $modelName => $relation_obj) {
4821
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
4822
-                    //check if this model's INFO is present. If so, cache it on the model
4823
-                    $other_model = $relation_obj->get_other_model();
4824
-                    $other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4825
-                    //if we managed to make a model object from the results, cache it on the main model object
4826
-                    if ($other_model_obj_maybe) {
4827
-                        //set timezone on these other model objects if they are present
4828
-                        $other_model_obj_maybe->set_timezone($this->_timezone);
4829
-                        $classInstance->cache($modelName, $other_model_obj_maybe);
4830
-                    }
4831
-                }
4832
-            }
4833
-        }
4834
-        return $array_of_objects;
4835
-    }
4836
-
4837
-
4838
-
4839
-    /**
4840
-     * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4841
-     * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4842
-     * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4843
-     * object (as set in the model_field!).
4844
-     *
4845
-     * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4846
-     */
4847
-    public function create_default_object()
4848
-    {
4849
-        $this_model_fields_and_values = array();
4850
-        //setup the row using default values;
4851
-        foreach ($this->field_settings() as $field_name => $field_obj) {
4852
-            $this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
4853
-        }
4854
-        $className = $this->_get_class_name();
4855
-        $classInstance = EE_Registry::instance()
4856
-                                    ->load_class($className, array($this_model_fields_and_values), false, false);
4857
-        return $classInstance;
4858
-    }
4859
-
4860
-
4861
-
4862
-    /**
4863
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
4864
-     *                             or an stdClass where each property is the name of a column,
4865
-     * @return EE_Base_Class
4866
-     * @throws \EE_Error
4867
-     */
4868
-    public function instantiate_class_from_array_or_object($cols_n_values)
4869
-    {
4870
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
4871
-            $cols_n_values = get_object_vars($cols_n_values);
4872
-        }
4873
-        $primary_key = null;
4874
-        //make sure the array only has keys that are fields/columns on this model
4875
-        $this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4876
-        if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
4877
-            $primary_key = $this_model_fields_n_values[$this->primary_key_name()];
4878
-        }
4879
-        $className = $this->_get_class_name();
4880
-        //check we actually found results that we can use to build our model object
4881
-        //if not, return null
4882
-        if ($this->has_primary_key_field()) {
4883
-            if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
4884
-                return null;
4885
-            }
4886
-        } else if ($this->unique_indexes()) {
4887
-            $first_column = reset($this_model_fields_n_values);
4888
-            if (empty($first_column)) {
4889
-                return null;
4890
-            }
4891
-        }
4892
-        // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
4893
-        if ($primary_key) {
4894
-            $classInstance = $this->get_from_entity_map($primary_key);
4895
-            if (! $classInstance) {
4896
-                $classInstance = EE_Registry::instance()
4897
-                                            ->load_class($className,
4898
-                                                array($this_model_fields_n_values, $this->_timezone), true, false);
4899
-                // add this new object to the entity map
4900
-                $classInstance = $this->add_to_entity_map($classInstance);
4901
-            }
4902
-        } else {
4903
-            $classInstance = EE_Registry::instance()
4904
-                                        ->load_class($className, array($this_model_fields_n_values, $this->_timezone),
4905
-                                            true, false);
4906
-        }
4907
-        //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.
4908
-        $this->set_timezone($classInstance->get_timezone());
4909
-        return $classInstance;
4910
-    }
4911
-
4912
-
4913
-
4914
-    /**
4915
-     * Gets the model object from the  entity map if it exists
4916
-     *
4917
-     * @param int|string $id the ID of the model object
4918
-     * @return EE_Base_Class
4919
-     */
4920
-    public function get_from_entity_map($id)
4921
-    {
4922
-        return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
4923
-            ? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
4924
-    }
4925
-
4926
-
4927
-
4928
-    /**
4929
-     * add_to_entity_map
4930
-     * Adds the object to the model's entity mappings
4931
-     *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
4932
-     *        and for the remainder of the request, it's even more up-to-date than what's in the database.
4933
-     *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
4934
-     *        If the database gets updated directly and you want the entity mapper to reflect that change,
4935
-     *        then this method should be called immediately after the update query
4936
-     * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
4937
-     * so on multisite, the entity map is specific to the query being done for a specific site.
4938
-     *
4939
-     * @param    EE_Base_Class $object
4940
-     * @throws EE_Error
4941
-     * @return \EE_Base_Class
4942
-     */
4943
-    public function add_to_entity_map(EE_Base_Class $object)
4944
-    {
4945
-        $className = $this->_get_class_name();
4946
-        if (! $object instanceof $className) {
4947
-            throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
4948
-                is_object($object) ? get_class($object) : $object, $className));
4949
-        }
4950
-        /** @var $object EE_Base_Class */
4951
-        if (! $object->ID()) {
4952
-            throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
4953
-                "event_espresso"), get_class($this)));
4954
-        }
4955
-        // double check it's not already there
4956
-        $classInstance = $this->get_from_entity_map($object->ID());
4957
-        if ($classInstance) {
4958
-            return $classInstance;
4959
-        } else {
4960
-            $this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
4961
-            return $object;
4962
-        }
4963
-    }
4964
-
4965
-
4966
-
4967
-    /**
4968
-     * if a valid identifier is provided, then that entity is unset from the entity map,
4969
-     * if no identifier is provided, then the entire entity map is emptied
4970
-     *
4971
-     * @param int|string $id the ID of the model object
4972
-     * @return boolean
4973
-     */
4974
-    public function clear_entity_map($id = null)
4975
-    {
4976
-        if (empty($id)) {
4977
-            $this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
4978
-            return true;
4979
-        }
4980
-        if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
4981
-            unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
4982
-            return true;
4983
-        }
4984
-        return false;
4985
-    }
4986
-
4987
-
4988
-
4989
-    /**
4990
-     * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
4991
-     * Given an array where keys are column (or column alias) names and values,
4992
-     * returns an array of their corresponding field names and database values
4993
-     *
4994
-     * @param array $cols_n_values
4995
-     * @return array
4996
-     */
4997
-    public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
4998
-    {
4999
-        return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5000
-    }
5001
-
5002
-
5003
-
5004
-    /**
5005
-     * _deduce_fields_n_values_from_cols_n_values
5006
-     * Given an array where keys are column (or column alias) names and values,
5007
-     * returns an array of their corresponding field names and database values
5008
-     *
5009
-     * @param string $cols_n_values
5010
-     * @return array
5011
-     */
5012
-    protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
5013
-    {
5014
-        $this_model_fields_n_values = array();
5015
-        foreach ($this->get_tables() as $table_alias => $table_obj) {
5016
-            $table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
5017
-                $table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
5018
-            //there is a primary key on this table and its not set. Use defaults for all its columns
5019
-            if ($table_pk_value === null && $table_obj->get_pk_column()) {
5020
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5021
-                    if (! $field_obj->is_db_only_field()) {
5022
-                        //prepare field as if its coming from db
5023
-                        $prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5024
-                        $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
5025
-                    }
5026
-                }
5027
-            } else {
5028
-                //the table's rows existed. Use their values
5029
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5030
-                    if (! $field_obj->is_db_only_field()) {
5031
-                        $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5032
-                            $cols_n_values, $field_obj->get_qualified_column(),
5033
-                            $field_obj->get_table_column()
5034
-                        );
5035
-                    }
5036
-                }
5037
-            }
5038
-        }
5039
-        return $this_model_fields_n_values;
5040
-    }
5041
-
5042
-
5043
-
5044
-    /**
5045
-     * @param $cols_n_values
5046
-     * @param $qualified_column
5047
-     * @param $regular_column
5048
-     * @return null
5049
-     */
5050
-    protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
5051
-    {
5052
-        $value = null;
5053
-        //ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
5054
-        //does the field on the model relate to this column retrieved from the db?
5055
-        //or is it a db-only field? (not relating to the model)
5056
-        if (isset($cols_n_values[$qualified_column])) {
5057
-            $value = $cols_n_values[$qualified_column];
5058
-        } elseif (isset($cols_n_values[$regular_column])) {
5059
-            $value = $cols_n_values[$regular_column];
5060
-        }
5061
-        return $value;
5062
-    }
5063
-
5064
-
5065
-
5066
-    /**
5067
-     * refresh_entity_map_from_db
5068
-     * Makes sure the model object in the entity map at $id assumes the values
5069
-     * of the database (opposite of EE_base_Class::save())
5070
-     *
5071
-     * @param int|string $id
5072
-     * @return EE_Base_Class
5073
-     * @throws \EE_Error
5074
-     */
5075
-    public function refresh_entity_map_from_db($id)
5076
-    {
5077
-        $obj_in_map = $this->get_from_entity_map($id);
5078
-        if ($obj_in_map) {
5079
-            $wpdb_results = $this->_get_all_wpdb_results(
5080
-                array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
5081
-            );
5082
-            if ($wpdb_results && is_array($wpdb_results)) {
5083
-                $one_row = reset($wpdb_results);
5084
-                foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
5085
-                    $obj_in_map->set_from_db($field_name, $db_value);
5086
-                }
5087
-                //clear the cache of related model objects
5088
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5089
-                    $obj_in_map->clear_cache($relation_name, null, true);
5090
-                }
5091
-            }
5092
-            $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
5093
-            return $obj_in_map;
5094
-        } else {
5095
-            return $this->get_one_by_ID($id);
5096
-        }
5097
-    }
5098
-
5099
-
5100
-
5101
-    /**
5102
-     * refresh_entity_map_with
5103
-     * Leaves the entry in the entity map alone, but updates it to match the provided
5104
-     * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
5105
-     * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
5106
-     * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
5107
-     *
5108
-     * @param int|string    $id
5109
-     * @param EE_Base_Class $replacing_model_obj
5110
-     * @return \EE_Base_Class
5111
-     * @throws \EE_Error
5112
-     */
5113
-    public function refresh_entity_map_with($id, $replacing_model_obj)
5114
-    {
5115
-        $obj_in_map = $this->get_from_entity_map($id);
5116
-        if ($obj_in_map) {
5117
-            if ($replacing_model_obj instanceof EE_Base_Class) {
5118
-                foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
5119
-                    $obj_in_map->set($field_name, $value);
5120
-                }
5121
-                //make the model object in the entity map's cache match the $replacing_model_obj
5122
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5123
-                    $obj_in_map->clear_cache($relation_name, null, true);
5124
-                    foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
5125
-                        $obj_in_map->cache($relation_name, $cached_obj, $cache_id);
5126
-                    }
5127
-                }
5128
-            }
5129
-            return $obj_in_map;
5130
-        } else {
5131
-            $this->add_to_entity_map($replacing_model_obj);
5132
-            return $replacing_model_obj;
5133
-        }
5134
-    }
5135
-
5136
-
5137
-
5138
-    /**
5139
-     * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
5140
-     * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
5141
-     * require_once($this->_getClassName().".class.php");
5142
-     *
5143
-     * @return string
5144
-     */
5145
-    private function _get_class_name()
5146
-    {
5147
-        return "EE_" . $this->get_this_model_name();
5148
-    }
5149
-
5150
-
5151
-
5152
-    /**
5153
-     * Get the name of the items this model represents, for the quantity specified. Eg,
5154
-     * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
5155
-     * it would be 'Events'.
5156
-     *
5157
-     * @param int $quantity
5158
-     * @return string
5159
-     */
5160
-    public function item_name($quantity = 1)
5161
-    {
5162
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5163
-    }
5164
-
5165
-
5166
-
5167
-    /**
5168
-     * Very handy general function to allow for plugins to extend any child of EE_TempBase.
5169
-     * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
5170
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
5171
-     * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
5172
-     * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
5173
-     * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
5174
-     * was called, and an array of the original arguments passed to the function. Whatever their callback function
5175
-     * returns will be returned by this function. Example: in functions.php (or in a plugin):
5176
-     * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
5177
-     * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
5178
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
5179
-     *        return $previousReturnValue.$returnString;
5180
-     * }
5181
-     * require('EEM_Answer.model.php');
5182
-     * $answer=EEM_Answer::instance();
5183
-     * echo $answer->my_callback('monkeys',100);
5184
-     * //will output "you called my_callback! and passed args:monkeys,100"
5185
-     *
5186
-     * @param string $methodName name of method which was called on a child of EE_TempBase, but which
5187
-     * @param array  $args       array of original arguments passed to the function
5188
-     * @throws EE_Error
5189
-     * @return mixed whatever the plugin which calls add_filter decides
5190
-     */
5191
-    public function __call($methodName, $args)
5192
-    {
5193
-        $className = get_class($this);
5194
-        $tagName = "FHEE__{$className}__{$methodName}";
5195
-        if (! has_filter($tagName)) {
5196
-            throw new EE_Error(
5197
-                sprintf(
5198
-                    __('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 );',
5199
-                        'event_espresso'),
5200
-                    $methodName,
5201
-                    $className,
5202
-                    $tagName,
5203
-                    '<br />'
5204
-                )
5205
-            );
5206
-        }
5207
-        return apply_filters($tagName, null, $this, $args);
5208
-    }
5209
-
5210
-
5211
-
5212
-    /**
5213
-     * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
5214
-     * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
5215
-     *
5216
-     * @param EE_Base_Class|string|int $base_class_obj_or_id either:
5217
-     *                                                       the EE_Base_Class object that corresponds to this Model,
5218
-     *                                                       the object's class name
5219
-     *                                                       or object's ID
5220
-     * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
5221
-     *                                                       exists in the database. If it does not, we add it
5222
-     * @throws EE_Error
5223
-     * @return EE_Base_Class
5224
-     */
5225
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
5226
-    {
5227
-        $className = $this->_get_class_name();
5228
-        if ($base_class_obj_or_id instanceof $className) {
5229
-            $model_object = $base_class_obj_or_id;
5230
-        } else {
5231
-            $primary_key_field = $this->get_primary_key_field();
5232
-            if (
5233
-                $primary_key_field instanceof EE_Primary_Key_Int_Field
5234
-                && (
5235
-                    is_int($base_class_obj_or_id)
5236
-                    || is_string($base_class_obj_or_id)
5237
-                )
5238
-            ) {
5239
-                // assume it's an ID.
5240
-                // either a proper integer or a string representing an integer (eg "101" instead of 101)
5241
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
5242
-            } else if (
5243
-                $primary_key_field instanceof EE_Primary_Key_String_Field
5244
-                && is_string($base_class_obj_or_id)
5245
-            ) {
5246
-                // assume its a string representation of the object
5247
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
5248
-            } else {
5249
-                throw new EE_Error(
5250
-                    sprintf(
5251
-                        __(
5252
-                            "'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5253
-                            'event_espresso'
5254
-                        ),
5255
-                        $base_class_obj_or_id,
5256
-                        $this->_get_class_name(),
5257
-                        print_r($base_class_obj_or_id, true)
5258
-                    )
5259
-                );
5260
-            }
5261
-        }
5262
-        if ($ensure_is_in_db && $model_object->ID() !== null) {
5263
-            $model_object->save();
5264
-        }
5265
-        return $model_object;
5266
-    }
5267
-
5268
-
5269
-
5270
-    /**
5271
-     * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5272
-     * is a value of the this model's primary key. If it's an EE_Base_Class child,
5273
-     * returns it ID.
5274
-     *
5275
-     * @param EE_Base_Class|int|string $base_class_obj_or_id
5276
-     * @return int|string depending on the type of this model object's ID
5277
-     * @throws EE_Error
5278
-     */
5279
-    public function ensure_is_ID($base_class_obj_or_id)
5280
-    {
5281
-        $className = $this->_get_class_name();
5282
-        if ($base_class_obj_or_id instanceof $className) {
5283
-            /** @var $base_class_obj_or_id EE_Base_Class */
5284
-            $id = $base_class_obj_or_id->ID();
5285
-        } elseif (is_int($base_class_obj_or_id)) {
5286
-            //assume it's an ID
5287
-            $id = $base_class_obj_or_id;
5288
-        } elseif (is_string($base_class_obj_or_id)) {
5289
-            //assume its a string representation of the object
5290
-            $id = $base_class_obj_or_id;
5291
-        } else {
5292
-            throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5293
-                'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5294
-                print_r($base_class_obj_or_id, true)));
5295
-        }
5296
-        return $id;
5297
-    }
5298
-
5299
-
5300
-
5301
-    /**
5302
-     * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5303
-     * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5304
-     * been sanitized and converted into the appropriate domain.
5305
-     * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5306
-     * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5307
-     * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5308
-     * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5309
-     * $EVT = EEM_Event::instance(); $old_setting =
5310
-     * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5311
-     * $EVT->assume_values_already_prepared_by_model_object(true);
5312
-     * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5313
-     * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5314
-     *
5315
-     * @param int $values_already_prepared like one of the constants on EEM_Base
5316
-     * @return void
5317
-     */
5318
-    public function assume_values_already_prepared_by_model_object(
5319
-        $values_already_prepared = self::not_prepared_by_model_object
5320
-    ) {
5321
-        $this->_values_already_prepared_by_model_object = $values_already_prepared;
5322
-    }
5323
-
5324
-
5325
-
5326
-    /**
5327
-     * Read comments for assume_values_already_prepared_by_model_object()
5328
-     *
5329
-     * @return int
5330
-     */
5331
-    public function get_assumption_concerning_values_already_prepared_by_model_object()
5332
-    {
5333
-        return $this->_values_already_prepared_by_model_object;
5334
-    }
5335
-
5336
-
5337
-
5338
-    /**
5339
-     * Gets all the indexes on this model
5340
-     *
5341
-     * @return EE_Index[]
5342
-     */
5343
-    public function indexes()
5344
-    {
5345
-        return $this->_indexes;
5346
-    }
5347
-
5348
-
5349
-
5350
-    /**
5351
-     * Gets all the Unique Indexes on this model
5352
-     *
5353
-     * @return EE_Unique_Index[]
5354
-     */
5355
-    public function unique_indexes()
5356
-    {
5357
-        $unique_indexes = array();
5358
-        foreach ($this->_indexes as $name => $index) {
5359
-            if ($index instanceof EE_Unique_Index) {
5360
-                $unique_indexes [$name] = $index;
5361
-            }
5362
-        }
5363
-        return $unique_indexes;
5364
-    }
5365
-
5366
-
5367
-
5368
-    /**
5369
-     * Gets all the fields which, when combined, make the primary key.
5370
-     * This is usually just an array with 1 element (the primary key), but in cases
5371
-     * where there is no primary key, it's a combination of fields as defined
5372
-     * on a primary index
5373
-     *
5374
-     * @return EE_Model_Field_Base[] indexed by the field's name
5375
-     * @throws \EE_Error
5376
-     */
5377
-    public function get_combined_primary_key_fields()
5378
-    {
5379
-        foreach ($this->indexes() as $index) {
5380
-            if ($index instanceof EE_Primary_Key_Index) {
5381
-                return $index->fields();
5382
-            }
5383
-        }
5384
-        return array($this->primary_key_name() => $this->get_primary_key_field());
5385
-    }
5386
-
5387
-
5388
-
5389
-    /**
5390
-     * Used to build a primary key string (when the model has no primary key),
5391
-     * which can be used a unique string to identify this model object.
5392
-     *
5393
-     * @param array $cols_n_values keys are field names, values are their values
5394
-     * @return string
5395
-     * @throws \EE_Error
5396
-     */
5397
-    public function get_index_primary_key_string($cols_n_values)
5398
-    {
5399
-        $cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5400
-            $this->get_combined_primary_key_fields());
5401
-        return http_build_query($cols_n_values_for_primary_key_index);
5402
-    }
5403
-
5404
-
5405
-
5406
-    /**
5407
-     * Gets the field values from the primary key string
5408
-     *
5409
-     * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5410
-     * @param string $index_primary_key_string
5411
-     * @return null|array
5412
-     * @throws \EE_Error
5413
-     */
5414
-    public function parse_index_primary_key_string($index_primary_key_string)
5415
-    {
5416
-        $key_fields = $this->get_combined_primary_key_fields();
5417
-        //check all of them are in the $id
5418
-        $key_vals_in_combined_pk = array();
5419
-        parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5420
-        foreach ($key_fields as $key_field_name => $field_obj) {
5421
-            if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5422
-                return null;
5423
-            }
5424
-        }
5425
-        return $key_vals_in_combined_pk;
5426
-    }
5427
-
5428
-
5429
-
5430
-    /**
5431
-     * verifies that an array of key-value pairs for model fields has a key
5432
-     * for each field comprising the primary key index
5433
-     *
5434
-     * @param array $key_vals
5435
-     * @return boolean
5436
-     * @throws \EE_Error
5437
-     */
5438
-    public function has_all_combined_primary_key_fields($key_vals)
5439
-    {
5440
-        $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5441
-        foreach ($keys_it_should_have as $key) {
5442
-            if (! isset($key_vals[$key])) {
5443
-                return false;
5444
-            }
5445
-        }
5446
-        return true;
5447
-    }
5448
-
5449
-
5450
-
5451
-    /**
5452
-     * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5453
-     * We consider something to be a copy if all the attributes match (except the ID, of course).
5454
-     *
5455
-     * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5456
-     * @param array               $query_params                     like EEM_Base::get_all's query_params.
5457
-     * @throws EE_Error
5458
-     * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5459
-     *                                                              indexed)
5460
-     */
5461
-    public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5462
-    {
5463
-        if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5464
-            $attributes_array = $model_object_or_attributes_array->model_field_array();
5465
-        } elseif (is_array($model_object_or_attributes_array)) {
5466
-            $attributes_array = $model_object_or_attributes_array;
5467
-        } else {
5468
-            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",
5469
-                "event_espresso"), $model_object_or_attributes_array));
5470
-        }
5471
-        //even copies obviously won't have the same ID, so remove the primary key
5472
-        //from the WHERE conditions for finding copies (if there is a primary key, of course)
5473
-        if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5474
-            unset($attributes_array[$this->primary_key_name()]);
5475
-        }
5476
-        if (isset($query_params[0])) {
5477
-            $query_params[0] = array_merge($attributes_array, $query_params);
5478
-        } else {
5479
-            $query_params[0] = $attributes_array;
5480
-        }
5481
-        return $this->get_all($query_params);
5482
-    }
5483
-
5484
-
5485
-
5486
-    /**
5487
-     * Gets the first copy we find. See get_all_copies for more details
5488
-     *
5489
-     * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5490
-     * @param array $query_params
5491
-     * @return EE_Base_Class
5492
-     * @throws \EE_Error
5493
-     */
5494
-    public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5495
-    {
5496
-        if (! is_array($query_params)) {
5497
-            EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5498
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5499
-                    gettype($query_params)), '4.6.0');
5500
-            $query_params = array();
5501
-        }
5502
-        $query_params['limit'] = 1;
5503
-        $copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5504
-        if (is_array($copies)) {
5505
-            return array_shift($copies);
5506
-        } else {
5507
-            return null;
5508
-        }
5509
-    }
5510
-
5511
-
5512
-
5513
-    /**
5514
-     * Updates the item with the specified id. Ignores default query parameters because
5515
-     * we have specified the ID, and its assumed we KNOW what we're doing
5516
-     *
5517
-     * @param array      $fields_n_values keys are field names, values are their new values
5518
-     * @param int|string $id              the value of the primary key to update
5519
-     * @return int number of rows updated
5520
-     * @throws \EE_Error
5521
-     */
5522
-    public function update_by_ID($fields_n_values, $id)
5523
-    {
5524
-        $query_params = array(
5525
-            0                          => array($this->get_primary_key_field()->get_name() => $id),
5526
-            'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
5527
-        );
5528
-        return $this->update($fields_n_values, $query_params);
5529
-    }
5530
-
5531
-
5532
-
5533
-    /**
5534
-     * Changes an operator which was supplied to the models into one usable in SQL
5535
-     *
5536
-     * @param string $operator_supplied
5537
-     * @return string an operator which can be used in SQL
5538
-     * @throws EE_Error
5539
-     */
5540
-    private function _prepare_operator_for_sql($operator_supplied)
5541
-    {
5542
-        $sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5543
-            : null;
5544
-        if ($sql_operator) {
5545
-            return $sql_operator;
5546
-        } else {
5547
-            throw new EE_Error(sprintf(__("The operator '%s' is not in the list of valid operators: %s",
5548
-                "event_espresso"), $operator_supplied, implode(",", array_keys($this->_valid_operators))));
5549
-        }
5550
-    }
5551
-
5552
-
5553
-
5554
-    /**
5555
-     * Gets an array where keys are the primary keys and values are their 'names'
5556
-     * (as determined by the model object's name() function, which is often overridden)
5557
-     *
5558
-     * @param array $query_params like get_all's
5559
-     * @return string[]
5560
-     * @throws \EE_Error
5561
-     */
5562
-    public function get_all_names($query_params = array())
5563
-    {
5564
-        $objs = $this->get_all($query_params);
5565
-        $names = array();
5566
-        foreach ($objs as $obj) {
5567
-            $names[$obj->ID()] = $obj->name();
5568
-        }
5569
-        return $names;
5570
-    }
5571
-
5572
-
5573
-
5574
-    /**
5575
-     * Gets an array of primary keys from the model objects. If you acquired the model objects
5576
-     * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5577
-     * this is duplicated effort and reduces efficiency) you would be better to use
5578
-     * array_keys() on $model_objects.
5579
-     *
5580
-     * @param \EE_Base_Class[] $model_objects
5581
-     * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5582
-     *                                               in the returned array
5583
-     * @return array
5584
-     * @throws \EE_Error
5585
-     */
5586
-    public function get_IDs($model_objects, $filter_out_empty_ids = false)
5587
-    {
5588
-        if (! $this->has_primary_key_field()) {
5589
-            if (WP_DEBUG) {
5590
-                EE_Error::add_error(
5591
-                    __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5592
-                    __FILE__,
5593
-                    __FUNCTION__,
5594
-                    __LINE__
5595
-                );
5596
-            }
5597
-        }
5598
-        $IDs = array();
5599
-        foreach ($model_objects as $model_object) {
5600
-            $id = $model_object->ID();
5601
-            if (! $id) {
5602
-                if ($filter_out_empty_ids) {
5603
-                    continue;
5604
-                }
5605
-                if (WP_DEBUG) {
5606
-                    EE_Error::add_error(
5607
-                        __(
5608
-                            'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5609
-                            'event_espresso'
5610
-                        ),
5611
-                        __FILE__,
5612
-                        __FUNCTION__,
5613
-                        __LINE__
5614
-                    );
5615
-                }
5616
-            }
5617
-            $IDs[] = $id;
5618
-        }
5619
-        return $IDs;
5620
-    }
5621
-
5622
-
5623
-
5624
-    /**
5625
-     * Returns the string used in capabilities relating to this model. If there
5626
-     * are no capabilities that relate to this model returns false
5627
-     *
5628
-     * @return string|false
5629
-     */
5630
-    public function cap_slug()
5631
-    {
5632
-        return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5633
-    }
5634
-
5635
-
5636
-
5637
-    /**
5638
-     * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5639
-     * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5640
-     * only returns the cap restrictions array in that context (ie, the array
5641
-     * at that key)
5642
-     *
5643
-     * @param string $context
5644
-     * @return EE_Default_Where_Conditions[] indexed by associated capability
5645
-     * @throws \EE_Error
5646
-     */
5647
-    public function cap_restrictions($context = EEM_Base::caps_read)
5648
-    {
5649
-        EEM_Base::verify_is_valid_cap_context($context);
5650
-        //check if we ought to run the restriction generator first
5651
-        if (
5652
-            isset($this->_cap_restriction_generators[$context])
5653
-            && $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5654
-            && ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5655
-        ) {
5656
-            $this->_cap_restrictions[$context] = array_merge(
5657
-                $this->_cap_restrictions[$context],
5658
-                $this->_cap_restriction_generators[$context]->generate_restrictions()
5659
-            );
5660
-        }
5661
-        //and make sure we've finalized the construction of each restriction
5662
-        foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5663
-            if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5664
-                $where_conditions_obj->_finalize_construct($this);
5665
-            }
5666
-        }
5667
-        return $this->_cap_restrictions[$context];
5668
-    }
5669
-
5670
-
5671
-
5672
-    /**
5673
-     * Indicating whether or not this model thinks its a wp core model
5674
-     *
5675
-     * @return boolean
5676
-     */
5677
-    public function is_wp_core_model()
5678
-    {
5679
-        return $this->_wp_core_model;
5680
-    }
5681
-
5682
-
5683
-
5684
-    /**
5685
-     * Gets all the caps that are missing which impose a restriction on
5686
-     * queries made in this context
5687
-     *
5688
-     * @param string $context one of EEM_Base::caps_ constants
5689
-     * @return EE_Default_Where_Conditions[] indexed by capability name
5690
-     * @throws \EE_Error
5691
-     */
5692
-    public function caps_missing($context = EEM_Base::caps_read)
5693
-    {
5694
-        $missing_caps = array();
5695
-        $cap_restrictions = $this->cap_restrictions($context);
5696
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5697
-            if (! EE_Capabilities::instance()
5698
-                                 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5699
-            ) {
5700
-                $missing_caps[$cap] = $restriction_if_no_cap;
5701
-            }
5702
-        }
5703
-        return $missing_caps;
5704
-    }
5705
-
5706
-
5707
-
5708
-    /**
5709
-     * Gets the mapping from capability contexts to action strings used in capability names
5710
-     *
5711
-     * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5712
-     * one of 'read', 'edit', or 'delete'
5713
-     */
5714
-    public function cap_contexts_to_cap_action_map()
5715
-    {
5716
-        return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5717
-            $this);
5718
-    }
5719
-
5720
-
5721
-
5722
-    /**
5723
-     * Gets the action string for the specified capability context
5724
-     *
5725
-     * @param string $context
5726
-     * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5727
-     * @throws \EE_Error
5728
-     */
5729
-    public function cap_action_for_context($context)
5730
-    {
5731
-        $mapping = $this->cap_contexts_to_cap_action_map();
5732
-        if (isset($mapping[$context])) {
5733
-            return $mapping[$context];
5734
-        }
5735
-        if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5736
-            return $action;
5737
-        }
5738
-        throw new EE_Error(
5739
-            sprintf(
5740
-                __('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5741
-                $context,
5742
-                implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5743
-            )
5744
-        );
5745
-    }
5746
-
5747
-
5748
-
5749
-    /**
5750
-     * Returns all the capability contexts which are valid when querying models
5751
-     *
5752
-     * @return array
5753
-     */
5754
-    public static function valid_cap_contexts()
5755
-    {
5756
-        return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5757
-            self::caps_read,
5758
-            self::caps_read_admin,
5759
-            self::caps_edit,
5760
-            self::caps_delete,
5761
-        ));
5762
-    }
5763
-
5764
-
5765
-
5766
-    /**
5767
-     * Returns all valid options for 'default_where_conditions'
5768
-     *
5769
-     * @return array
5770
-     */
5771
-    public static function valid_default_where_conditions()
5772
-    {
5773
-        return array(
5774
-            EEM_Base::default_where_conditions_all,
5775
-            EEM_Base::default_where_conditions_this_only,
5776
-            EEM_Base::default_where_conditions_others_only,
5777
-            EEM_Base::default_where_conditions_minimum_all,
5778
-            EEM_Base::default_where_conditions_minimum_others,
5779
-            EEM_Base::default_where_conditions_none
5780
-        );
5781
-    }
5782
-
5783
-    // public static function default_where_conditions_full
5784
-    /**
5785
-     * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5786
-     *
5787
-     * @param string $context
5788
-     * @return bool
5789
-     * @throws \EE_Error
5790
-     */
5791
-    static public function verify_is_valid_cap_context($context)
5792
-    {
5793
-        $valid_cap_contexts = EEM_Base::valid_cap_contexts();
5794
-        if (in_array($context, $valid_cap_contexts)) {
5795
-            return true;
5796
-        } else {
5797
-            throw new EE_Error(
5798
-                sprintf(
5799
-                    __('Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5800
-                        'event_espresso'),
5801
-                    $context,
5802
-                    'EEM_Base',
5803
-                    implode(',', $valid_cap_contexts)
5804
-                )
5805
-            );
5806
-        }
5807
-    }
5808
-
5809
-
5810
-
5811
-    /**
5812
-     * Clears all the models field caches. This is only useful when a sub-class
5813
-     * might have added a field or something and these caches might be invalidated
5814
-     */
5815
-    protected function _invalidate_field_caches()
5816
-    {
5817
-        $this->_cache_foreign_key_to_fields = array();
5818
-        $this->_cached_fields = null;
5819
-        $this->_cached_fields_non_db_only = null;
5820
-    }
5821
-
5822
-
5823
-
5824
-    /**
5825
-     * Gets the list of all the where query param keys that relate to logic instead of field names
5826
-     * (eg "and", "or", "not").
5827
-     *
5828
-     * @return array
5829
-     */
5830
-    public function logic_query_param_keys()
5831
-    {
5832
-        return $this->_logic_query_param_keys;
5833
-    }
5834
-
5835
-
5836
-
5837
-    /**
5838
-     * Determines whether or not the where query param array key is for a logic query param.
5839
-     * Eg 'OR', 'not*', and 'and*because-i-say-so' shoudl all return true, whereas
5840
-     * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
5841
-     *
5842
-     * @param $query_param_key
5843
-     * @return bool
5844
-     */
5845
-    public function is_logic_query_param_key($query_param_key)
5846
-    {
5847
-        foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
5848
-            if ($query_param_key === $logic_query_param_key
5849
-                || strpos($query_param_key, $logic_query_param_key . '*') === 0
5850
-            ) {
5851
-                return true;
5852
-            }
5853
-        }
5854
-        return false;
5855
-    }
3615
+		}
3616
+		return $null_friendly_where_conditions;
3617
+	}
3618
+
3619
+
3620
+
3621
+	/**
3622
+	 * Uses the _default_where_conditions_strategy set during __construct() to get
3623
+	 * default where conditions on all get_all, update, and delete queries done by this model.
3624
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3625
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3626
+	 *
3627
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3628
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3629
+	 */
3630
+	private function _get_default_where_conditions($model_relation_path = null)
3631
+	{
3632
+		if ($this->_ignore_where_strategy) {
3633
+			return array();
3634
+		}
3635
+		return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3636
+	}
3637
+
3638
+
3639
+
3640
+	/**
3641
+	 * Uses the _minimum_where_conditions_strategy set during __construct() to get
3642
+	 * minimum where conditions on all get_all, update, and delete queries done by this model.
3643
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3644
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3645
+	 * Similar to _get_default_where_conditions
3646
+	 *
3647
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3648
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3649
+	 */
3650
+	protected function _get_minimum_where_conditions($model_relation_path = null)
3651
+	{
3652
+		if ($this->_ignore_where_strategy) {
3653
+			return array();
3654
+		}
3655
+		return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3656
+	}
3657
+
3658
+
3659
+
3660
+	/**
3661
+	 * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3662
+	 * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3663
+	 *
3664
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
3665
+	 * @return string
3666
+	 * @throws \EE_Error
3667
+	 */
3668
+	private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3669
+	{
3670
+		$selects = $this->_get_columns_to_select_for_this_model();
3671
+		foreach (
3672
+			$model_query_info->get_model_names_included() as $model_relation_chain =>
3673
+			$name_of_other_model_included
3674
+		) {
3675
+			$other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3676
+			$other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3677
+			foreach ($other_model_selects as $key => $value) {
3678
+				$selects[] = $value;
3679
+			}
3680
+		}
3681
+		return implode(", ", $selects);
3682
+	}
3683
+
3684
+
3685
+
3686
+	/**
3687
+	 * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3688
+	 * So that's going to be the columns for all the fields on the model
3689
+	 *
3690
+	 * @param string $model_relation_chain like 'Question.Question_Group.Event'
3691
+	 * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3692
+	 */
3693
+	public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3694
+	{
3695
+		$fields = $this->field_settings();
3696
+		$selects = array();
3697
+		$table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3698
+			$this->get_this_model_name());
3699
+		foreach ($fields as $field_obj) {
3700
+			$selects[] = $table_alias_with_model_relation_chain_prefix
3701
+						 . $field_obj->get_table_alias()
3702
+						 . "."
3703
+						 . $field_obj->get_table_column()
3704
+						 . " AS '"
3705
+						 . $table_alias_with_model_relation_chain_prefix
3706
+						 . $field_obj->get_table_alias()
3707
+						 . "."
3708
+						 . $field_obj->get_table_column()
3709
+						 . "'";
3710
+		}
3711
+		//make sure we are also getting the PKs of each table
3712
+		$tables = $this->get_tables();
3713
+		if (count($tables) > 1) {
3714
+			foreach ($tables as $table_obj) {
3715
+				$qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3716
+									   . $table_obj->get_fully_qualified_pk_column();
3717
+				if (! in_array($qualified_pk_column, $selects)) {
3718
+					$selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3719
+				}
3720
+			}
3721
+		}
3722
+		return $selects;
3723
+	}
3724
+
3725
+
3726
+
3727
+	/**
3728
+	 * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3729
+	 * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3730
+	 * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3731
+	 * SQL for joining, and the data types
3732
+	 *
3733
+	 * @param null|string                 $original_query_param
3734
+	 * @param string                      $query_param          like Registration.Transaction.TXN_ID
3735
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3736
+	 * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3737
+	 *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3738
+	 *                                                          column name. We only want model names, eg 'Event.Venue'
3739
+	 *                                                          or 'Registration's
3740
+	 * @param string                      $original_query_param what it originally was (eg
3741
+	 *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3742
+	 *                                                          matches $query_param
3743
+	 * @throws EE_Error
3744
+	 * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3745
+	 */
3746
+	private function _extract_related_model_info_from_query_param(
3747
+		$query_param,
3748
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3749
+		$query_param_type,
3750
+		$original_query_param = null
3751
+	) {
3752
+		if ($original_query_param === null) {
3753
+			$original_query_param = $query_param;
3754
+		}
3755
+		$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3756
+		/** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3757
+		$allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3758
+		$allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3759
+		//check to see if we have a field on this model
3760
+		$this_model_fields = $this->field_settings(true);
3761
+		if (array_key_exists($query_param, $this_model_fields)) {
3762
+			if ($allow_fields) {
3763
+				return;
3764
+			} else {
3765
+				throw new EE_Error(sprintf(__("Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
3766
+					"event_espresso"),
3767
+					$query_param, get_class($this), $query_param_type, $original_query_param));
3768
+			}
3769
+		} //check if this is a special logic query param
3770
+		elseif (in_array($query_param, $this->_logic_query_param_keys, true)) {
3771
+			if ($allow_logic_query_params) {
3772
+				return;
3773
+			} else {
3774
+				throw new EE_Error(
3775
+					sprintf(
3776
+						__('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',
3777
+							'event_espresso'),
3778
+						implode('", "', $this->_logic_query_param_keys),
3779
+						$query_param,
3780
+						get_class($this),
3781
+						'<br />',
3782
+						"\t"
3783
+						. ' $passed_in_query_info = <pre>'
3784
+						. print_r($passed_in_query_info, true)
3785
+						. '</pre>'
3786
+						. "\n\t"
3787
+						. ' $query_param_type = '
3788
+						. $query_param_type
3789
+						. "\n\t"
3790
+						. ' $original_query_param = '
3791
+						. $original_query_param
3792
+					)
3793
+				);
3794
+			}
3795
+		} //check if it's a custom selection
3796
+		elseif (array_key_exists($query_param, $this->_custom_selections)) {
3797
+			return;
3798
+		}
3799
+		//check if has a model name at the beginning
3800
+		//and
3801
+		//check if it's a field on a related model
3802
+		foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3803
+			if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3804
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3805
+				$query_param = substr($query_param, strlen($valid_related_model_name . "."));
3806
+				if ($query_param === '') {
3807
+					//nothing left to $query_param
3808
+					//we should actually end in a field name, not a model like this!
3809
+					throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3810
+						"event_espresso"),
3811
+						$query_param, $query_param_type, get_class($this), $valid_related_model_name));
3812
+				} else {
3813
+					$related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3814
+					$related_model_obj->_extract_related_model_info_from_query_param($query_param,
3815
+						$passed_in_query_info, $query_param_type, $original_query_param);
3816
+					return;
3817
+				}
3818
+			} elseif ($query_param === $valid_related_model_name) {
3819
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3820
+				return;
3821
+			}
3822
+		}
3823
+		//ok so $query_param didn't start with a model name
3824
+		//and we previously confirmed it wasn't a logic query param or field on the current model
3825
+		//it's wack, that's what it is
3826
+		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",
3827
+			"event_espresso"),
3828
+			$query_param, get_class($this), $query_param_type, $original_query_param));
3829
+	}
3830
+
3831
+
3832
+
3833
+	/**
3834
+	 * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3835
+	 * and store it on $passed_in_query_info
3836
+	 *
3837
+	 * @param string                      $model_name
3838
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3839
+	 * @param string                      $original_query_param used to extract the relation chain between the queried
3840
+	 *                                                          model and $model_name. Eg, if we are querying Event,
3841
+	 *                                                          and are adding a join to 'Payment' with the original
3842
+	 *                                                          query param key
3843
+	 *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3844
+	 *                                                          to extract 'Registration.Transaction.Payment', in case
3845
+	 *                                                          Payment wants to add default query params so that it
3846
+	 *                                                          will know what models to prepend onto its default query
3847
+	 *                                                          params or in case it wants to rename tables (in case
3848
+	 *                                                          there are multiple joins to the same table)
3849
+	 * @return void
3850
+	 * @throws \EE_Error
3851
+	 */
3852
+	private function _add_join_to_model(
3853
+		$model_name,
3854
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3855
+		$original_query_param
3856
+	) {
3857
+		$relation_obj = $this->related_settings_for($model_name);
3858
+		$model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3859
+		//check if the relation is HABTM, because then we're essentially doing two joins
3860
+		//If so, join first to the JOIN table, and add its data types, and then continue as normal
3861
+		if ($relation_obj instanceof EE_HABTM_Relation) {
3862
+			$join_model_obj = $relation_obj->get_join_model();
3863
+			//replace the model specified with the join model for this relation chain, whi
3864
+			$relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
3865
+				$join_model_obj->get_this_model_name(), $model_relation_chain);
3866
+			$new_query_info = new EE_Model_Query_Info_Carrier(
3867
+				array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
3868
+				$relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model));
3869
+			$passed_in_query_info->merge($new_query_info);
3870
+		}
3871
+		//now just join to the other table pointed to by the relation object, and add its data types
3872
+		$new_query_info = new EE_Model_Query_Info_Carrier(
3873
+			array($model_relation_chain => $model_name),
3874
+			$relation_obj->get_join_statement($model_relation_chain));
3875
+		$passed_in_query_info->merge($new_query_info);
3876
+	}
3877
+
3878
+
3879
+
3880
+	/**
3881
+	 * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
3882
+	 *
3883
+	 * @param array $where_params like EEM_Base::get_all
3884
+	 * @return string of SQL
3885
+	 * @throws \EE_Error
3886
+	 */
3887
+	private function _construct_where_clause($where_params)
3888
+	{
3889
+		$SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
3890
+		if ($SQL) {
3891
+			return " WHERE " . $SQL;
3892
+		} else {
3893
+			return '';
3894
+		}
3895
+	}
3896
+
3897
+
3898
+
3899
+	/**
3900
+	 * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
3901
+	 * and should be passed HAVING parameters, not WHERE parameters
3902
+	 *
3903
+	 * @param array $having_params
3904
+	 * @return string
3905
+	 * @throws \EE_Error
3906
+	 */
3907
+	private function _construct_having_clause($having_params)
3908
+	{
3909
+		$SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
3910
+		if ($SQL) {
3911
+			return " HAVING " . $SQL;
3912
+		} else {
3913
+			return '';
3914
+		}
3915
+	}
3916
+
3917
+
3918
+
3919
+	/**
3920
+	 * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
3921
+	 * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
3922
+	 * EEM_Attendee.
3923
+	 *
3924
+	 * @param string $field_name
3925
+	 * @param string $model_name
3926
+	 * @return EE_Model_Field_Base
3927
+	 * @throws EE_Error
3928
+	 */
3929
+	protected function _get_field_on_model($field_name, $model_name)
3930
+	{
3931
+		$model_class = 'EEM_' . $model_name;
3932
+		$model_filepath = $model_class . ".model.php";
3933
+		if (is_readable($model_filepath)) {
3934
+			require_once($model_filepath);
3935
+			$model_instance = call_user_func($model_name . "::instance");
3936
+			/* @var $model_instance EEM_Base */
3937
+			return $model_instance->field_settings_for($field_name);
3938
+		} else {
3939
+			throw new EE_Error(sprintf(__('No model named %s exists, with classname %s and filepath %s',
3940
+				'event_espresso'), $model_name, $model_class, $model_filepath));
3941
+		}
3942
+	}
3943
+
3944
+
3945
+
3946
+	/**
3947
+	 * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
3948
+	 * Event_Meta.meta_value = 'foo'))"
3949
+	 *
3950
+	 * @param array  $where_params see EEM_Base::get_all for documentation
3951
+	 * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
3952
+	 * @throws EE_Error
3953
+	 * @return string of SQL
3954
+	 */
3955
+	private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
3956
+	{
3957
+		$where_clauses = array();
3958
+		foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
3959
+			$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
3960
+			if (in_array($query_param, $this->_logic_query_param_keys)) {
3961
+				switch ($query_param) {
3962
+					case 'not':
3963
+					case 'NOT':
3964
+						$where_clauses[] = "! ("
3965
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3966
+								$glue)
3967
+										   . ")";
3968
+						break;
3969
+					case 'and':
3970
+					case 'AND':
3971
+						$where_clauses[] = " ("
3972
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3973
+								' AND ')
3974
+										   . ")";
3975
+						break;
3976
+					case 'or':
3977
+					case 'OR':
3978
+						$where_clauses[] = " ("
3979
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3980
+								' OR ')
3981
+										   . ")";
3982
+						break;
3983
+				}
3984
+			} else {
3985
+				$field_obj = $this->_deduce_field_from_query_param($query_param);
3986
+				//if it's not a normal field, maybe it's a custom selection?
3987
+				if (! $field_obj) {
3988
+					if (isset($this->_custom_selections[$query_param][1])) {
3989
+						$field_obj = $this->_custom_selections[$query_param][1];
3990
+					} else {
3991
+						throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
3992
+							"event_espresso"), $query_param));
3993
+					}
3994
+				}
3995
+				$op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
3996
+				$where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
3997
+			}
3998
+		}
3999
+		return $where_clauses ? implode($glue, $where_clauses) : '';
4000
+	}
4001
+
4002
+
4003
+
4004
+	/**
4005
+	 * Takes the input parameter and extract the table name (alias) and column name
4006
+	 *
4007
+	 * @param array $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4008
+	 * @throws EE_Error
4009
+	 * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
4010
+	 */
4011
+	private function _deduce_column_name_from_query_param($query_param)
4012
+	{
4013
+		$field = $this->_deduce_field_from_query_param($query_param);
4014
+		if ($field) {
4015
+			$table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4016
+				$query_param);
4017
+			return $table_alias_prefix . $field->get_qualified_column();
4018
+		} elseif (array_key_exists($query_param, $this->_custom_selections)) {
4019
+			//maybe it's custom selection item?
4020
+			//if so, just use it as the "column name"
4021
+			return $query_param;
4022
+		} else {
4023
+			throw new EE_Error(sprintf(__("%s is not a valid field on this model, nor a custom selection (%s)",
4024
+				"event_espresso"), $query_param, implode(",", $this->_custom_selections)));
4025
+		}
4026
+	}
4027
+
4028
+
4029
+
4030
+	/**
4031
+	 * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
4032
+	 * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
4033
+	 * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
4034
+	 * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
4035
+	 *
4036
+	 * @param string $condition_query_param_key
4037
+	 * @return string
4038
+	 */
4039
+	private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
4040
+	{
4041
+		$pos_of_star = strpos($condition_query_param_key, '*');
4042
+		if ($pos_of_star === false) {
4043
+			return $condition_query_param_key;
4044
+		} else {
4045
+			$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
4046
+			return $condition_query_param_sans_star;
4047
+		}
4048
+	}
4049
+
4050
+
4051
+
4052
+	/**
4053
+	 * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
4054
+	 *
4055
+	 * @param                            mixed      array | string    $op_and_value
4056
+	 * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
4057
+	 * @throws EE_Error
4058
+	 * @return string
4059
+	 */
4060
+	private function _construct_op_and_value($op_and_value, $field_obj)
4061
+	{
4062
+		if (is_array($op_and_value)) {
4063
+			$operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4064
+			if (! $operator) {
4065
+				$php_array_like_string = array();
4066
+				foreach ($op_and_value as $key => $value) {
4067
+					$php_array_like_string[] = "$key=>$value";
4068
+				}
4069
+				throw new EE_Error(
4070
+					sprintf(
4071
+						__(
4072
+							"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))",
4073
+							"event_espresso"
4074
+						),
4075
+						implode(",", $php_array_like_string)
4076
+					)
4077
+				);
4078
+			}
4079
+			$value = isset($op_and_value[1]) ? $op_and_value[1] : null;
4080
+		} else {
4081
+			$operator = '=';
4082
+			$value = $op_and_value;
4083
+		}
4084
+		//check to see if the value is actually another field
4085
+		if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4086
+			return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4087
+		} elseif (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4088
+			//in this case, the value should be an array, or at least a comma-separated list
4089
+			//it will need to handle a little differently
4090
+			$cleaned_value = $this->_construct_in_value($value, $field_obj);
4091
+			//note: $cleaned_value has already been run through $wpdb->prepare()
4092
+			return $operator . SP . $cleaned_value;
4093
+		} elseif (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4094
+			//the value should be an array with count of two.
4095
+			if (count($value) !== 2) {
4096
+				throw new EE_Error(
4097
+					sprintf(
4098
+						__(
4099
+							"The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
4100
+							'event_espresso'
4101
+						),
4102
+						"BETWEEN"
4103
+					)
4104
+				);
4105
+			}
4106
+			$cleaned_value = $this->_construct_between_value($value, $field_obj);
4107
+			return $operator . SP . $cleaned_value;
4108
+		} elseif (in_array($operator, $this->_null_style_operators)) {
4109
+			if ($value !== null) {
4110
+				throw new EE_Error(
4111
+					sprintf(
4112
+						__(
4113
+							"You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
4114
+							"event_espresso"
4115
+						),
4116
+						$value,
4117
+						$operator
4118
+					)
4119
+				);
4120
+			}
4121
+			return $operator;
4122
+		} elseif ($operator === 'LIKE' && ! is_array($value)) {
4123
+			//if the operator is 'LIKE', we want to allow percent signs (%) and not
4124
+			//remove other junk. So just treat it as a string.
4125
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4126
+		} elseif (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4127
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4128
+		} elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4129
+			throw new EE_Error(
4130
+				sprintf(
4131
+					__(
4132
+						"Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
4133
+						'event_espresso'
4134
+					),
4135
+					$operator,
4136
+					$operator
4137
+				)
4138
+			);
4139
+		} elseif (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4140
+			throw new EE_Error(
4141
+				sprintf(
4142
+					__(
4143
+						"Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
4144
+						'event_espresso'
4145
+					),
4146
+					$operator,
4147
+					$operator
4148
+				)
4149
+			);
4150
+		} else {
4151
+			throw new EE_Error(
4152
+				sprintf(
4153
+					__(
4154
+						"It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
4155
+						"event_espresso"
4156
+					),
4157
+					http_build_query($op_and_value)
4158
+				)
4159
+			);
4160
+		}
4161
+	}
4162
+
4163
+
4164
+
4165
+	/**
4166
+	 * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
4167
+	 *
4168
+	 * @param array                      $values
4169
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
4170
+	 *                                              '%s'
4171
+	 * @return string
4172
+	 * @throws \EE_Error
4173
+	 */
4174
+	public function _construct_between_value($values, $field_obj)
4175
+	{
4176
+		$cleaned_values = array();
4177
+		foreach ($values as $value) {
4178
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4179
+		}
4180
+		return $cleaned_values[0] . " AND " . $cleaned_values[1];
4181
+	}
4182
+
4183
+
4184
+
4185
+	/**
4186
+	 * Takes an array or a comma-separated list of $values and cleans them
4187
+	 * according to $data_type using $wpdb->prepare, and then makes the list a
4188
+	 * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4189
+	 * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4190
+	 * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4191
+	 *
4192
+	 * @param mixed                      $values    array or comma-separated string
4193
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4194
+	 * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4195
+	 * @throws \EE_Error
4196
+	 */
4197
+	public function _construct_in_value($values, $field_obj)
4198
+	{
4199
+		//check if the value is a CSV list
4200
+		if (is_string($values)) {
4201
+			//in which case, turn it into an array
4202
+			$values = explode(",", $values);
4203
+		}
4204
+		$cleaned_values = array();
4205
+		foreach ($values as $value) {
4206
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4207
+		}
4208
+		//we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4209
+		//but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4210
+		//which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4211
+		if (empty($cleaned_values)) {
4212
+			$all_fields = $this->field_settings();
4213
+			$a_field = array_shift($all_fields);
4214
+			$main_table = $this->_get_main_table();
4215
+			$cleaned_values[] = "SELECT "
4216
+								. $a_field->get_table_column()
4217
+								. " FROM "
4218
+								. $main_table->get_table_name()
4219
+								. " WHERE FALSE";
4220
+		}
4221
+		return "(" . implode(",", $cleaned_values) . ")";
4222
+	}
4223
+
4224
+
4225
+
4226
+	/**
4227
+	 * @param mixed                      $value
4228
+	 * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4229
+	 * @throws EE_Error
4230
+	 * @return false|null|string
4231
+	 */
4232
+	private function _wpdb_prepare_using_field($value, $field_obj)
4233
+	{
4234
+		/** @type WPDB $wpdb */
4235
+		global $wpdb;
4236
+		if ($field_obj instanceof EE_Model_Field_Base) {
4237
+			return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4238
+				$this->_prepare_value_for_use_in_db($value, $field_obj));
4239
+		} else {//$field_obj should really just be a data type
4240
+			if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4241
+				throw new EE_Error(sprintf(__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4242
+					$field_obj, implode(",", $this->_valid_wpdb_data_types)));
4243
+			}
4244
+			return $wpdb->prepare($field_obj, $value);
4245
+		}
4246
+	}
4247
+
4248
+
4249
+
4250
+	/**
4251
+	 * Takes the input parameter and finds the model field that it indicates.
4252
+	 *
4253
+	 * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4254
+	 * @throws EE_Error
4255
+	 * @return EE_Model_Field_Base
4256
+	 */
4257
+	protected function _deduce_field_from_query_param($query_param_name)
4258
+	{
4259
+		//ok, now proceed with deducing which part is the model's name, and which is the field's name
4260
+		//which will help us find the database table and column
4261
+		$query_param_parts = explode(".", $query_param_name);
4262
+		if (empty($query_param_parts)) {
4263
+			throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4264
+				'event_espresso'), $query_param_name));
4265
+		}
4266
+		$number_of_parts = count($query_param_parts);
4267
+		$last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4268
+		if ($number_of_parts === 1) {
4269
+			$field_name = $last_query_param_part;
4270
+			$model_obj = $this;
4271
+		} else {// $number_of_parts >= 2
4272
+			//the last part is the column name, and there are only 2parts. therefore...
4273
+			$field_name = $last_query_param_part;
4274
+			$model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4275
+		}
4276
+		try {
4277
+			return $model_obj->field_settings_for($field_name);
4278
+		} catch (EE_Error $e) {
4279
+			return null;
4280
+		}
4281
+	}
4282
+
4283
+
4284
+
4285
+	/**
4286
+	 * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4287
+	 * alias and column which corresponds to it
4288
+	 *
4289
+	 * @param string $field_name
4290
+	 * @throws EE_Error
4291
+	 * @return string
4292
+	 */
4293
+	public function _get_qualified_column_for_field($field_name)
4294
+	{
4295
+		$all_fields = $this->field_settings();
4296
+		$field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4297
+		if ($field) {
4298
+			return $field->get_qualified_column();
4299
+		} else {
4300
+			throw new EE_Error(sprintf(__("There is no field titled %s on model %s. Either the query trying to use it is bad, or you need to add it to the list of fields on the model.",
4301
+				'event_espresso'), $field_name, get_class($this)));
4302
+		}
4303
+	}
4304
+
4305
+
4306
+
4307
+	/**
4308
+	 * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
4309
+	 * Example usage:
4310
+	 * EEM_Ticket::instance()->get_all_wpdb_results(
4311
+	 *      array(),
4312
+	 *      ARRAY_A,
4313
+	 *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
4314
+	 *  );
4315
+	 * is equivalent to
4316
+	 *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
4317
+	 * and
4318
+	 *  EEM_Event::instance()->get_all_wpdb_results(
4319
+	 *      array(
4320
+	 *          array(
4321
+	 *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
4322
+	 *          ),
4323
+	 *          ARRAY_A,
4324
+	 *          implode(
4325
+	 *              ', ',
4326
+	 *              array_merge(
4327
+	 *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
4328
+	 *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
4329
+	 *              )
4330
+	 *          )
4331
+	 *      )
4332
+	 *  );
4333
+	 * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
4334
+	 *
4335
+	 * @param string $model_relation_chain        the chain of models used to join between the model you want to query
4336
+	 *                                            and the one whose fields you are selecting for example: when querying
4337
+	 *                                            tickets model and selecting fields from the tickets model you would
4338
+	 *                                            leave this parameter empty, because no models are needed to join
4339
+	 *                                            between the queried model and the selected one. Likewise when
4340
+	 *                                            querying the datetime model and selecting fields from the tickets
4341
+	 *                                            model, it would also be left empty, because there is a direct
4342
+	 *                                            relation from datetimes to tickets, so no model is needed to join
4343
+	 *                                            them together. However, when querying from the event model and
4344
+	 *                                            selecting fields from the ticket model, you should provide the string
4345
+	 *                                            'Datetime', indicating that the event model must first join to the
4346
+	 *                                            datetime model in order to find its relation to ticket model.
4347
+	 *                                            Also, when querying from the venue model and selecting fields from
4348
+	 *                                            the ticket model, you should provide the string 'Event.Datetime',
4349
+	 *                                            indicating you need to join the venue model to the event model,
4350
+	 *                                            to the datetime model, in order to find its relation to the ticket model.
4351
+	 *                                            This string is used to deduce the prefix that gets added onto the
4352
+	 *                                            models' tables qualified columns
4353
+	 * @param bool   $return_string               if true, will return a string with qualified column names separated
4354
+	 *                                            by ', ' if false, will simply return a numerically indexed array of
4355
+	 *                                            qualified column names
4356
+	 * @return array|string
4357
+	 */
4358
+	public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4359
+	{
4360
+		$table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4361
+		$qualified_columns = array();
4362
+		foreach ($this->field_settings() as $field_name => $field) {
4363
+			$qualified_columns[] = $table_prefix . $field->get_qualified_column();
4364
+		}
4365
+		return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4366
+	}
4367
+
4368
+
4369
+
4370
+	/**
4371
+	 * constructs the select use on special limit joins
4372
+	 * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4373
+	 * its setup so the select query will be setup on and just doing the special select join off of the primary table
4374
+	 * (as that is typically where the limits would be set).
4375
+	 *
4376
+	 * @param  string       $table_alias The table the select is being built for
4377
+	 * @param  mixed|string $limit       The limit for this select
4378
+	 * @return string                The final select join element for the query.
4379
+	 */
4380
+	public function _construct_limit_join_select($table_alias, $limit)
4381
+	{
4382
+		$SQL = '';
4383
+		foreach ($this->_tables as $table_obj) {
4384
+			if ($table_obj instanceof EE_Primary_Table) {
4385
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4386
+					? $table_obj->get_select_join_limit($limit)
4387
+					: SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4388
+			} elseif ($table_obj instanceof EE_Secondary_Table) {
4389
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4390
+					? $table_obj->get_select_join_limit_join($limit)
4391
+					: SP . $table_obj->get_join_sql($table_alias) . SP;
4392
+			}
4393
+		}
4394
+		return $SQL;
4395
+	}
4396
+
4397
+
4398
+
4399
+	/**
4400
+	 * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4401
+	 * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4402
+	 *
4403
+	 * @return string SQL
4404
+	 * @throws \EE_Error
4405
+	 */
4406
+	public function _construct_internal_join()
4407
+	{
4408
+		$SQL = $this->_get_main_table()->get_table_sql();
4409
+		$SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4410
+		return $SQL;
4411
+	}
4412
+
4413
+
4414
+
4415
+	/**
4416
+	 * Constructs the SQL for joining all the tables on this model.
4417
+	 * Normally $alias should be the primary table's alias, but in cases where
4418
+	 * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4419
+	 * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4420
+	 * alias, this will construct SQL like:
4421
+	 * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4422
+	 * With $alias being a secondary table's alias, this will construct SQL like:
4423
+	 * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4424
+	 *
4425
+	 * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4426
+	 * @return string
4427
+	 */
4428
+	public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4429
+	{
4430
+		$SQL = '';
4431
+		$alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4432
+		foreach ($this->_tables as $table_obj) {
4433
+			if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4434
+				if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4435
+					//so we're joining to this table, meaning the table is already in
4436
+					//the FROM statement, BUT the primary table isn't. So we want
4437
+					//to add the inverse join sql
4438
+					$SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4439
+				} else {
4440
+					//just add a regular JOIN to this table from the primary table
4441
+					$SQL .= $table_obj->get_join_sql($alias_prefixed);
4442
+				}
4443
+			}//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4444
+		}
4445
+		return $SQL;
4446
+	}
4447
+
4448
+
4449
+
4450
+	/**
4451
+	 * Gets an array for storing all the data types on the next-to-be-executed-query.
4452
+	 * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4453
+	 * their data type (eg, '%s', '%d', etc)
4454
+	 *
4455
+	 * @return array
4456
+	 */
4457
+	public function _get_data_types()
4458
+	{
4459
+		$data_types = array();
4460
+		foreach ($this->field_settings() as $field_obj) {
4461
+			//$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4462
+			/** @var $field_obj EE_Model_Field_Base */
4463
+			$data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4464
+		}
4465
+		return $data_types;
4466
+	}
4467
+
4468
+
4469
+
4470
+	/**
4471
+	 * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4472
+	 *
4473
+	 * @param string $model_name
4474
+	 * @throws EE_Error
4475
+	 * @return EEM_Base
4476
+	 */
4477
+	public function get_related_model_obj($model_name)
4478
+	{
4479
+		$model_classname = "EEM_" . $model_name;
4480
+		if (! class_exists($model_classname)) {
4481
+			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",
4482
+				'event_espresso'), $model_name, $model_classname));
4483
+		}
4484
+		return call_user_func($model_classname . "::instance");
4485
+	}
4486
+
4487
+
4488
+
4489
+	/**
4490
+	 * Returns the array of EE_ModelRelations for this model.
4491
+	 *
4492
+	 * @return EE_Model_Relation_Base[]
4493
+	 */
4494
+	public function relation_settings()
4495
+	{
4496
+		return $this->_model_relations;
4497
+	}
4498
+
4499
+
4500
+
4501
+	/**
4502
+	 * Gets all related models that this model BELONGS TO. Handy to know sometimes
4503
+	 * because without THOSE models, this model probably doesn't have much purpose.
4504
+	 * (Eg, without an event, datetimes have little purpose.)
4505
+	 *
4506
+	 * @return EE_Belongs_To_Relation[]
4507
+	 */
4508
+	public function belongs_to_relations()
4509
+	{
4510
+		$belongs_to_relations = array();
4511
+		foreach ($this->relation_settings() as $model_name => $relation_obj) {
4512
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
4513
+				$belongs_to_relations[$model_name] = $relation_obj;
4514
+			}
4515
+		}
4516
+		return $belongs_to_relations;
4517
+	}
4518
+
4519
+
4520
+
4521
+	/**
4522
+	 * Returns the specified EE_Model_Relation, or throws an exception
4523
+	 *
4524
+	 * @param string $relation_name name of relation, key in $this->_relatedModels
4525
+	 * @throws EE_Error
4526
+	 * @return EE_Model_Relation_Base
4527
+	 */
4528
+	public function related_settings_for($relation_name)
4529
+	{
4530
+		$relatedModels = $this->relation_settings();
4531
+		if (! array_key_exists($relation_name, $relatedModels)) {
4532
+			throw new EE_Error(
4533
+				sprintf(
4534
+					__('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4535
+						'event_espresso'),
4536
+					$relation_name,
4537
+					$this->_get_class_name(),
4538
+					implode(', ', array_keys($relatedModels))
4539
+				)
4540
+			);
4541
+		}
4542
+		return $relatedModels[$relation_name];
4543
+	}
4544
+
4545
+
4546
+
4547
+	/**
4548
+	 * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4549
+	 * fields
4550
+	 *
4551
+	 * @param string $fieldName
4552
+	 * @throws EE_Error
4553
+	 * @return EE_Model_Field_Base
4554
+	 */
4555
+	public function field_settings_for($fieldName)
4556
+	{
4557
+		$fieldSettings = $this->field_settings(true);
4558
+		if (! array_key_exists($fieldName, $fieldSettings)) {
4559
+			throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4560
+				get_class($this)));
4561
+		}
4562
+		return $fieldSettings[$fieldName];
4563
+	}
4564
+
4565
+
4566
+
4567
+	/**
4568
+	 * Checks if this field exists on this model
4569
+	 *
4570
+	 * @param string $fieldName a key in the model's _field_settings array
4571
+	 * @return boolean
4572
+	 */
4573
+	public function has_field($fieldName)
4574
+	{
4575
+		$fieldSettings = $this->field_settings(true);
4576
+		if (isset($fieldSettings[$fieldName])) {
4577
+			return true;
4578
+		} else {
4579
+			return false;
4580
+		}
4581
+	}
4582
+
4583
+
4584
+
4585
+	/**
4586
+	 * Returns whether or not this model has a relation to the specified model
4587
+	 *
4588
+	 * @param string $relation_name possibly one of the keys in the relation_settings array
4589
+	 * @return boolean
4590
+	 */
4591
+	public function has_relation($relation_name)
4592
+	{
4593
+		$relations = $this->relation_settings();
4594
+		if (isset($relations[$relation_name])) {
4595
+			return true;
4596
+		} else {
4597
+			return false;
4598
+		}
4599
+	}
4600
+
4601
+
4602
+
4603
+	/**
4604
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4605
+	 * Eg, on EE_Answer that would be ANS_ID field object
4606
+	 *
4607
+	 * @param $field_obj
4608
+	 * @return boolean
4609
+	 */
4610
+	public function is_primary_key_field($field_obj)
4611
+	{
4612
+		return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4613
+	}
4614
+
4615
+
4616
+
4617
+	/**
4618
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4619
+	 * Eg, on EE_Answer that would be ANS_ID field object
4620
+	 *
4621
+	 * @return EE_Model_Field_Base
4622
+	 * @throws EE_Error
4623
+	 */
4624
+	public function get_primary_key_field()
4625
+	{
4626
+		if ($this->_primary_key_field === null) {
4627
+			foreach ($this->field_settings(true) as $field_obj) {
4628
+				if ($this->is_primary_key_field($field_obj)) {
4629
+					$this->_primary_key_field = $field_obj;
4630
+					break;
4631
+				}
4632
+			}
4633
+			if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4634
+				throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4635
+					get_class($this)));
4636
+			}
4637
+		}
4638
+		return $this->_primary_key_field;
4639
+	}
4640
+
4641
+
4642
+
4643
+	/**
4644
+	 * Returns whether or not not there is a primary key on this model.
4645
+	 * Internally does some caching.
4646
+	 *
4647
+	 * @return boolean
4648
+	 */
4649
+	public function has_primary_key_field()
4650
+	{
4651
+		if ($this->_has_primary_key_field === null) {
4652
+			try {
4653
+				$this->get_primary_key_field();
4654
+				$this->_has_primary_key_field = true;
4655
+			} catch (EE_Error $e) {
4656
+				$this->_has_primary_key_field = false;
4657
+			}
4658
+		}
4659
+		return $this->_has_primary_key_field;
4660
+	}
4661
+
4662
+
4663
+
4664
+	/**
4665
+	 * Finds the first field of type $field_class_name.
4666
+	 *
4667
+	 * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4668
+	 *                                 EE_Foreign_Key_Field, etc
4669
+	 * @return EE_Model_Field_Base or null if none is found
4670
+	 */
4671
+	public function get_a_field_of_type($field_class_name)
4672
+	{
4673
+		foreach ($this->field_settings() as $field) {
4674
+			if ($field instanceof $field_class_name) {
4675
+				return $field;
4676
+			}
4677
+		}
4678
+		return null;
4679
+	}
4680
+
4681
+
4682
+
4683
+	/**
4684
+	 * Gets a foreign key field pointing to model.
4685
+	 *
4686
+	 * @param string $model_name eg Event, Registration, not EEM_Event
4687
+	 * @return EE_Foreign_Key_Field_Base
4688
+	 * @throws EE_Error
4689
+	 */
4690
+	public function get_foreign_key_to($model_name)
4691
+	{
4692
+		if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4693
+			foreach ($this->field_settings() as $field) {
4694
+				if (
4695
+					$field instanceof EE_Foreign_Key_Field_Base
4696
+					&& in_array($model_name, $field->get_model_names_pointed_to())
4697
+				) {
4698
+					$this->_cache_foreign_key_to_fields[$model_name] = $field;
4699
+					break;
4700
+				}
4701
+			}
4702
+			if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4703
+				throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4704
+					'event_espresso'), $model_name, get_class($this)));
4705
+			}
4706
+		}
4707
+		return $this->_cache_foreign_key_to_fields[$model_name];
4708
+	}
4709
+
4710
+
4711
+
4712
+	/**
4713
+	 * Gets the actual table for the table alias
4714
+	 *
4715
+	 * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4716
+	 *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4717
+	 *                            Either one works
4718
+	 * @return EE_Table_Base
4719
+	 */
4720
+	public function get_table_for_alias($table_alias)
4721
+	{
4722
+		$table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4723
+		return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4724
+	}
4725
+
4726
+
4727
+
4728
+	/**
4729
+	 * Returns a flat array of all field son this model, instead of organizing them
4730
+	 * by table_alias as they are in the constructor.
4731
+	 *
4732
+	 * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4733
+	 * @return EE_Model_Field_Base[] where the keys are the field's name
4734
+	 */
4735
+	public function field_settings($include_db_only_fields = false)
4736
+	{
4737
+		if ($include_db_only_fields) {
4738
+			if ($this->_cached_fields === null) {
4739
+				$this->_cached_fields = array();
4740
+				foreach ($this->_fields as $fields_corresponding_to_table) {
4741
+					foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4742
+						$this->_cached_fields[$field_name] = $field_obj;
4743
+					}
4744
+				}
4745
+			}
4746
+			return $this->_cached_fields;
4747
+		} else {
4748
+			if ($this->_cached_fields_non_db_only === null) {
4749
+				$this->_cached_fields_non_db_only = array();
4750
+				foreach ($this->_fields as $fields_corresponding_to_table) {
4751
+					foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4752
+						/** @var $field_obj EE_Model_Field_Base */
4753
+						if (! $field_obj->is_db_only_field()) {
4754
+							$this->_cached_fields_non_db_only[$field_name] = $field_obj;
4755
+						}
4756
+					}
4757
+				}
4758
+			}
4759
+			return $this->_cached_fields_non_db_only;
4760
+		}
4761
+	}
4762
+
4763
+
4764
+
4765
+	/**
4766
+	 *        cycle though array of attendees and create objects out of each item
4767
+	 *
4768
+	 * @access        private
4769
+	 * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4770
+	 * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4771
+	 *                           numerically indexed)
4772
+	 * @throws \EE_Error
4773
+	 */
4774
+	protected function _create_objects($rows = array())
4775
+	{
4776
+		$array_of_objects = array();
4777
+		if (empty($rows)) {
4778
+			return array();
4779
+		}
4780
+		$count_if_model_has_no_primary_key = 0;
4781
+		$has_primary_key = $this->has_primary_key_field();
4782
+		$primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4783
+		foreach ((array)$rows as $row) {
4784
+			if (empty($row)) {
4785
+				//wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4786
+				return array();
4787
+			}
4788
+			//check if we've already set this object in the results array,
4789
+			//in which case there's no need to process it further (again)
4790
+			if ($has_primary_key) {
4791
+				$table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4792
+					$row,
4793
+					$primary_key_field->get_qualified_column(),
4794
+					$primary_key_field->get_table_column()
4795
+				);
4796
+				if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4797
+					continue;
4798
+				}
4799
+			}
4800
+			$classInstance = $this->instantiate_class_from_array_or_object($row);
4801
+			if (! $classInstance) {
4802
+				throw new EE_Error(
4803
+					sprintf(
4804
+						__('Could not create instance of class %s from row %s', 'event_espresso'),
4805
+						$this->get_this_model_name(),
4806
+						http_build_query($row)
4807
+					)
4808
+				);
4809
+			}
4810
+			//set the timezone on the instantiated objects
4811
+			$classInstance->set_timezone($this->_timezone);
4812
+			//make sure if there is any timezone setting present that we set the timezone for the object
4813
+			$key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4814
+			$array_of_objects[$key] = $classInstance;
4815
+			//also, for all the relations of type BelongsTo, see if we can cache
4816
+			//those related models
4817
+			//(we could do this for other relations too, but if there are conditions
4818
+			//that filtered out some fo the results, then we'd be caching an incomplete set
4819
+			//so it requires a little more thought than just caching them immediately...)
4820
+			foreach ($this->_model_relations as $modelName => $relation_obj) {
4821
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
4822
+					//check if this model's INFO is present. If so, cache it on the model
4823
+					$other_model = $relation_obj->get_other_model();
4824
+					$other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4825
+					//if we managed to make a model object from the results, cache it on the main model object
4826
+					if ($other_model_obj_maybe) {
4827
+						//set timezone on these other model objects if they are present
4828
+						$other_model_obj_maybe->set_timezone($this->_timezone);
4829
+						$classInstance->cache($modelName, $other_model_obj_maybe);
4830
+					}
4831
+				}
4832
+			}
4833
+		}
4834
+		return $array_of_objects;
4835
+	}
4836
+
4837
+
4838
+
4839
+	/**
4840
+	 * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4841
+	 * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4842
+	 * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4843
+	 * object (as set in the model_field!).
4844
+	 *
4845
+	 * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4846
+	 */
4847
+	public function create_default_object()
4848
+	{
4849
+		$this_model_fields_and_values = array();
4850
+		//setup the row using default values;
4851
+		foreach ($this->field_settings() as $field_name => $field_obj) {
4852
+			$this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
4853
+		}
4854
+		$className = $this->_get_class_name();
4855
+		$classInstance = EE_Registry::instance()
4856
+									->load_class($className, array($this_model_fields_and_values), false, false);
4857
+		return $classInstance;
4858
+	}
4859
+
4860
+
4861
+
4862
+	/**
4863
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
4864
+	 *                             or an stdClass where each property is the name of a column,
4865
+	 * @return EE_Base_Class
4866
+	 * @throws \EE_Error
4867
+	 */
4868
+	public function instantiate_class_from_array_or_object($cols_n_values)
4869
+	{
4870
+		if (! is_array($cols_n_values) && is_object($cols_n_values)) {
4871
+			$cols_n_values = get_object_vars($cols_n_values);
4872
+		}
4873
+		$primary_key = null;
4874
+		//make sure the array only has keys that are fields/columns on this model
4875
+		$this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4876
+		if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
4877
+			$primary_key = $this_model_fields_n_values[$this->primary_key_name()];
4878
+		}
4879
+		$className = $this->_get_class_name();
4880
+		//check we actually found results that we can use to build our model object
4881
+		//if not, return null
4882
+		if ($this->has_primary_key_field()) {
4883
+			if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
4884
+				return null;
4885
+			}
4886
+		} else if ($this->unique_indexes()) {
4887
+			$first_column = reset($this_model_fields_n_values);
4888
+			if (empty($first_column)) {
4889
+				return null;
4890
+			}
4891
+		}
4892
+		// if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
4893
+		if ($primary_key) {
4894
+			$classInstance = $this->get_from_entity_map($primary_key);
4895
+			if (! $classInstance) {
4896
+				$classInstance = EE_Registry::instance()
4897
+											->load_class($className,
4898
+												array($this_model_fields_n_values, $this->_timezone), true, false);
4899
+				// add this new object to the entity map
4900
+				$classInstance = $this->add_to_entity_map($classInstance);
4901
+			}
4902
+		} else {
4903
+			$classInstance = EE_Registry::instance()
4904
+										->load_class($className, array($this_model_fields_n_values, $this->_timezone),
4905
+											true, false);
4906
+		}
4907
+		//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.
4908
+		$this->set_timezone($classInstance->get_timezone());
4909
+		return $classInstance;
4910
+	}
4911
+
4912
+
4913
+
4914
+	/**
4915
+	 * Gets the model object from the  entity map if it exists
4916
+	 *
4917
+	 * @param int|string $id the ID of the model object
4918
+	 * @return EE_Base_Class
4919
+	 */
4920
+	public function get_from_entity_map($id)
4921
+	{
4922
+		return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
4923
+			? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
4924
+	}
4925
+
4926
+
4927
+
4928
+	/**
4929
+	 * add_to_entity_map
4930
+	 * Adds the object to the model's entity mappings
4931
+	 *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
4932
+	 *        and for the remainder of the request, it's even more up-to-date than what's in the database.
4933
+	 *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
4934
+	 *        If the database gets updated directly and you want the entity mapper to reflect that change,
4935
+	 *        then this method should be called immediately after the update query
4936
+	 * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
4937
+	 * so on multisite, the entity map is specific to the query being done for a specific site.
4938
+	 *
4939
+	 * @param    EE_Base_Class $object
4940
+	 * @throws EE_Error
4941
+	 * @return \EE_Base_Class
4942
+	 */
4943
+	public function add_to_entity_map(EE_Base_Class $object)
4944
+	{
4945
+		$className = $this->_get_class_name();
4946
+		if (! $object instanceof $className) {
4947
+			throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
4948
+				is_object($object) ? get_class($object) : $object, $className));
4949
+		}
4950
+		/** @var $object EE_Base_Class */
4951
+		if (! $object->ID()) {
4952
+			throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
4953
+				"event_espresso"), get_class($this)));
4954
+		}
4955
+		// double check it's not already there
4956
+		$classInstance = $this->get_from_entity_map($object->ID());
4957
+		if ($classInstance) {
4958
+			return $classInstance;
4959
+		} else {
4960
+			$this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
4961
+			return $object;
4962
+		}
4963
+	}
4964
+
4965
+
4966
+
4967
+	/**
4968
+	 * if a valid identifier is provided, then that entity is unset from the entity map,
4969
+	 * if no identifier is provided, then the entire entity map is emptied
4970
+	 *
4971
+	 * @param int|string $id the ID of the model object
4972
+	 * @return boolean
4973
+	 */
4974
+	public function clear_entity_map($id = null)
4975
+	{
4976
+		if (empty($id)) {
4977
+			$this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
4978
+			return true;
4979
+		}
4980
+		if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
4981
+			unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
4982
+			return true;
4983
+		}
4984
+		return false;
4985
+	}
4986
+
4987
+
4988
+
4989
+	/**
4990
+	 * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
4991
+	 * Given an array where keys are column (or column alias) names and values,
4992
+	 * returns an array of their corresponding field names and database values
4993
+	 *
4994
+	 * @param array $cols_n_values
4995
+	 * @return array
4996
+	 */
4997
+	public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
4998
+	{
4999
+		return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5000
+	}
5001
+
5002
+
5003
+
5004
+	/**
5005
+	 * _deduce_fields_n_values_from_cols_n_values
5006
+	 * Given an array where keys are column (or column alias) names and values,
5007
+	 * returns an array of their corresponding field names and database values
5008
+	 *
5009
+	 * @param string $cols_n_values
5010
+	 * @return array
5011
+	 */
5012
+	protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
5013
+	{
5014
+		$this_model_fields_n_values = array();
5015
+		foreach ($this->get_tables() as $table_alias => $table_obj) {
5016
+			$table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
5017
+				$table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
5018
+			//there is a primary key on this table and its not set. Use defaults for all its columns
5019
+			if ($table_pk_value === null && $table_obj->get_pk_column()) {
5020
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5021
+					if (! $field_obj->is_db_only_field()) {
5022
+						//prepare field as if its coming from db
5023
+						$prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5024
+						$this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
5025
+					}
5026
+				}
5027
+			} else {
5028
+				//the table's rows existed. Use their values
5029
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5030
+					if (! $field_obj->is_db_only_field()) {
5031
+						$this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5032
+							$cols_n_values, $field_obj->get_qualified_column(),
5033
+							$field_obj->get_table_column()
5034
+						);
5035
+					}
5036
+				}
5037
+			}
5038
+		}
5039
+		return $this_model_fields_n_values;
5040
+	}
5041
+
5042
+
5043
+
5044
+	/**
5045
+	 * @param $cols_n_values
5046
+	 * @param $qualified_column
5047
+	 * @param $regular_column
5048
+	 * @return null
5049
+	 */
5050
+	protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
5051
+	{
5052
+		$value = null;
5053
+		//ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
5054
+		//does the field on the model relate to this column retrieved from the db?
5055
+		//or is it a db-only field? (not relating to the model)
5056
+		if (isset($cols_n_values[$qualified_column])) {
5057
+			$value = $cols_n_values[$qualified_column];
5058
+		} elseif (isset($cols_n_values[$regular_column])) {
5059
+			$value = $cols_n_values[$regular_column];
5060
+		}
5061
+		return $value;
5062
+	}
5063
+
5064
+
5065
+
5066
+	/**
5067
+	 * refresh_entity_map_from_db
5068
+	 * Makes sure the model object in the entity map at $id assumes the values
5069
+	 * of the database (opposite of EE_base_Class::save())
5070
+	 *
5071
+	 * @param int|string $id
5072
+	 * @return EE_Base_Class
5073
+	 * @throws \EE_Error
5074
+	 */
5075
+	public function refresh_entity_map_from_db($id)
5076
+	{
5077
+		$obj_in_map = $this->get_from_entity_map($id);
5078
+		if ($obj_in_map) {
5079
+			$wpdb_results = $this->_get_all_wpdb_results(
5080
+				array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
5081
+			);
5082
+			if ($wpdb_results && is_array($wpdb_results)) {
5083
+				$one_row = reset($wpdb_results);
5084
+				foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
5085
+					$obj_in_map->set_from_db($field_name, $db_value);
5086
+				}
5087
+				//clear the cache of related model objects
5088
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5089
+					$obj_in_map->clear_cache($relation_name, null, true);
5090
+				}
5091
+			}
5092
+			$this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
5093
+			return $obj_in_map;
5094
+		} else {
5095
+			return $this->get_one_by_ID($id);
5096
+		}
5097
+	}
5098
+
5099
+
5100
+
5101
+	/**
5102
+	 * refresh_entity_map_with
5103
+	 * Leaves the entry in the entity map alone, but updates it to match the provided
5104
+	 * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
5105
+	 * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
5106
+	 * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
5107
+	 *
5108
+	 * @param int|string    $id
5109
+	 * @param EE_Base_Class $replacing_model_obj
5110
+	 * @return \EE_Base_Class
5111
+	 * @throws \EE_Error
5112
+	 */
5113
+	public function refresh_entity_map_with($id, $replacing_model_obj)
5114
+	{
5115
+		$obj_in_map = $this->get_from_entity_map($id);
5116
+		if ($obj_in_map) {
5117
+			if ($replacing_model_obj instanceof EE_Base_Class) {
5118
+				foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
5119
+					$obj_in_map->set($field_name, $value);
5120
+				}
5121
+				//make the model object in the entity map's cache match the $replacing_model_obj
5122
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5123
+					$obj_in_map->clear_cache($relation_name, null, true);
5124
+					foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
5125
+						$obj_in_map->cache($relation_name, $cached_obj, $cache_id);
5126
+					}
5127
+				}
5128
+			}
5129
+			return $obj_in_map;
5130
+		} else {
5131
+			$this->add_to_entity_map($replacing_model_obj);
5132
+			return $replacing_model_obj;
5133
+		}
5134
+	}
5135
+
5136
+
5137
+
5138
+	/**
5139
+	 * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
5140
+	 * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
5141
+	 * require_once($this->_getClassName().".class.php");
5142
+	 *
5143
+	 * @return string
5144
+	 */
5145
+	private function _get_class_name()
5146
+	{
5147
+		return "EE_" . $this->get_this_model_name();
5148
+	}
5149
+
5150
+
5151
+
5152
+	/**
5153
+	 * Get the name of the items this model represents, for the quantity specified. Eg,
5154
+	 * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
5155
+	 * it would be 'Events'.
5156
+	 *
5157
+	 * @param int $quantity
5158
+	 * @return string
5159
+	 */
5160
+	public function item_name($quantity = 1)
5161
+	{
5162
+		return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5163
+	}
5164
+
5165
+
5166
+
5167
+	/**
5168
+	 * Very handy general function to allow for plugins to extend any child of EE_TempBase.
5169
+	 * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
5170
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
5171
+	 * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
5172
+	 * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
5173
+	 * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
5174
+	 * was called, and an array of the original arguments passed to the function. Whatever their callback function
5175
+	 * returns will be returned by this function. Example: in functions.php (or in a plugin):
5176
+	 * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
5177
+	 * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
5178
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
5179
+	 *        return $previousReturnValue.$returnString;
5180
+	 * }
5181
+	 * require('EEM_Answer.model.php');
5182
+	 * $answer=EEM_Answer::instance();
5183
+	 * echo $answer->my_callback('monkeys',100);
5184
+	 * //will output "you called my_callback! and passed args:monkeys,100"
5185
+	 *
5186
+	 * @param string $methodName name of method which was called on a child of EE_TempBase, but which
5187
+	 * @param array  $args       array of original arguments passed to the function
5188
+	 * @throws EE_Error
5189
+	 * @return mixed whatever the plugin which calls add_filter decides
5190
+	 */
5191
+	public function __call($methodName, $args)
5192
+	{
5193
+		$className = get_class($this);
5194
+		$tagName = "FHEE__{$className}__{$methodName}";
5195
+		if (! has_filter($tagName)) {
5196
+			throw new EE_Error(
5197
+				sprintf(
5198
+					__('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 );',
5199
+						'event_espresso'),
5200
+					$methodName,
5201
+					$className,
5202
+					$tagName,
5203
+					'<br />'
5204
+				)
5205
+			);
5206
+		}
5207
+		return apply_filters($tagName, null, $this, $args);
5208
+	}
5209
+
5210
+
5211
+
5212
+	/**
5213
+	 * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
5214
+	 * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
5215
+	 *
5216
+	 * @param EE_Base_Class|string|int $base_class_obj_or_id either:
5217
+	 *                                                       the EE_Base_Class object that corresponds to this Model,
5218
+	 *                                                       the object's class name
5219
+	 *                                                       or object's ID
5220
+	 * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
5221
+	 *                                                       exists in the database. If it does not, we add it
5222
+	 * @throws EE_Error
5223
+	 * @return EE_Base_Class
5224
+	 */
5225
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
5226
+	{
5227
+		$className = $this->_get_class_name();
5228
+		if ($base_class_obj_or_id instanceof $className) {
5229
+			$model_object = $base_class_obj_or_id;
5230
+		} else {
5231
+			$primary_key_field = $this->get_primary_key_field();
5232
+			if (
5233
+				$primary_key_field instanceof EE_Primary_Key_Int_Field
5234
+				&& (
5235
+					is_int($base_class_obj_or_id)
5236
+					|| is_string($base_class_obj_or_id)
5237
+				)
5238
+			) {
5239
+				// assume it's an ID.
5240
+				// either a proper integer or a string representing an integer (eg "101" instead of 101)
5241
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
5242
+			} else if (
5243
+				$primary_key_field instanceof EE_Primary_Key_String_Field
5244
+				&& is_string($base_class_obj_or_id)
5245
+			) {
5246
+				// assume its a string representation of the object
5247
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
5248
+			} else {
5249
+				throw new EE_Error(
5250
+					sprintf(
5251
+						__(
5252
+							"'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5253
+							'event_espresso'
5254
+						),
5255
+						$base_class_obj_or_id,
5256
+						$this->_get_class_name(),
5257
+						print_r($base_class_obj_or_id, true)
5258
+					)
5259
+				);
5260
+			}
5261
+		}
5262
+		if ($ensure_is_in_db && $model_object->ID() !== null) {
5263
+			$model_object->save();
5264
+		}
5265
+		return $model_object;
5266
+	}
5267
+
5268
+
5269
+
5270
+	/**
5271
+	 * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5272
+	 * is a value of the this model's primary key. If it's an EE_Base_Class child,
5273
+	 * returns it ID.
5274
+	 *
5275
+	 * @param EE_Base_Class|int|string $base_class_obj_or_id
5276
+	 * @return int|string depending on the type of this model object's ID
5277
+	 * @throws EE_Error
5278
+	 */
5279
+	public function ensure_is_ID($base_class_obj_or_id)
5280
+	{
5281
+		$className = $this->_get_class_name();
5282
+		if ($base_class_obj_or_id instanceof $className) {
5283
+			/** @var $base_class_obj_or_id EE_Base_Class */
5284
+			$id = $base_class_obj_or_id->ID();
5285
+		} elseif (is_int($base_class_obj_or_id)) {
5286
+			//assume it's an ID
5287
+			$id = $base_class_obj_or_id;
5288
+		} elseif (is_string($base_class_obj_or_id)) {
5289
+			//assume its a string representation of the object
5290
+			$id = $base_class_obj_or_id;
5291
+		} else {
5292
+			throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5293
+				'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5294
+				print_r($base_class_obj_or_id, true)));
5295
+		}
5296
+		return $id;
5297
+	}
5298
+
5299
+
5300
+
5301
+	/**
5302
+	 * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5303
+	 * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5304
+	 * been sanitized and converted into the appropriate domain.
5305
+	 * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5306
+	 * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5307
+	 * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5308
+	 * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5309
+	 * $EVT = EEM_Event::instance(); $old_setting =
5310
+	 * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5311
+	 * $EVT->assume_values_already_prepared_by_model_object(true);
5312
+	 * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5313
+	 * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5314
+	 *
5315
+	 * @param int $values_already_prepared like one of the constants on EEM_Base
5316
+	 * @return void
5317
+	 */
5318
+	public function assume_values_already_prepared_by_model_object(
5319
+		$values_already_prepared = self::not_prepared_by_model_object
5320
+	) {
5321
+		$this->_values_already_prepared_by_model_object = $values_already_prepared;
5322
+	}
5323
+
5324
+
5325
+
5326
+	/**
5327
+	 * Read comments for assume_values_already_prepared_by_model_object()
5328
+	 *
5329
+	 * @return int
5330
+	 */
5331
+	public function get_assumption_concerning_values_already_prepared_by_model_object()
5332
+	{
5333
+		return $this->_values_already_prepared_by_model_object;
5334
+	}
5335
+
5336
+
5337
+
5338
+	/**
5339
+	 * Gets all the indexes on this model
5340
+	 *
5341
+	 * @return EE_Index[]
5342
+	 */
5343
+	public function indexes()
5344
+	{
5345
+		return $this->_indexes;
5346
+	}
5347
+
5348
+
5349
+
5350
+	/**
5351
+	 * Gets all the Unique Indexes on this model
5352
+	 *
5353
+	 * @return EE_Unique_Index[]
5354
+	 */
5355
+	public function unique_indexes()
5356
+	{
5357
+		$unique_indexes = array();
5358
+		foreach ($this->_indexes as $name => $index) {
5359
+			if ($index instanceof EE_Unique_Index) {
5360
+				$unique_indexes [$name] = $index;
5361
+			}
5362
+		}
5363
+		return $unique_indexes;
5364
+	}
5365
+
5366
+
5367
+
5368
+	/**
5369
+	 * Gets all the fields which, when combined, make the primary key.
5370
+	 * This is usually just an array with 1 element (the primary key), but in cases
5371
+	 * where there is no primary key, it's a combination of fields as defined
5372
+	 * on a primary index
5373
+	 *
5374
+	 * @return EE_Model_Field_Base[] indexed by the field's name
5375
+	 * @throws \EE_Error
5376
+	 */
5377
+	public function get_combined_primary_key_fields()
5378
+	{
5379
+		foreach ($this->indexes() as $index) {
5380
+			if ($index instanceof EE_Primary_Key_Index) {
5381
+				return $index->fields();
5382
+			}
5383
+		}
5384
+		return array($this->primary_key_name() => $this->get_primary_key_field());
5385
+	}
5386
+
5387
+
5388
+
5389
+	/**
5390
+	 * Used to build a primary key string (when the model has no primary key),
5391
+	 * which can be used a unique string to identify this model object.
5392
+	 *
5393
+	 * @param array $cols_n_values keys are field names, values are their values
5394
+	 * @return string
5395
+	 * @throws \EE_Error
5396
+	 */
5397
+	public function get_index_primary_key_string($cols_n_values)
5398
+	{
5399
+		$cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5400
+			$this->get_combined_primary_key_fields());
5401
+		return http_build_query($cols_n_values_for_primary_key_index);
5402
+	}
5403
+
5404
+
5405
+
5406
+	/**
5407
+	 * Gets the field values from the primary key string
5408
+	 *
5409
+	 * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5410
+	 * @param string $index_primary_key_string
5411
+	 * @return null|array
5412
+	 * @throws \EE_Error
5413
+	 */
5414
+	public function parse_index_primary_key_string($index_primary_key_string)
5415
+	{
5416
+		$key_fields = $this->get_combined_primary_key_fields();
5417
+		//check all of them are in the $id
5418
+		$key_vals_in_combined_pk = array();
5419
+		parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5420
+		foreach ($key_fields as $key_field_name => $field_obj) {
5421
+			if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5422
+				return null;
5423
+			}
5424
+		}
5425
+		return $key_vals_in_combined_pk;
5426
+	}
5427
+
5428
+
5429
+
5430
+	/**
5431
+	 * verifies that an array of key-value pairs for model fields has a key
5432
+	 * for each field comprising the primary key index
5433
+	 *
5434
+	 * @param array $key_vals
5435
+	 * @return boolean
5436
+	 * @throws \EE_Error
5437
+	 */
5438
+	public function has_all_combined_primary_key_fields($key_vals)
5439
+	{
5440
+		$keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5441
+		foreach ($keys_it_should_have as $key) {
5442
+			if (! isset($key_vals[$key])) {
5443
+				return false;
5444
+			}
5445
+		}
5446
+		return true;
5447
+	}
5448
+
5449
+
5450
+
5451
+	/**
5452
+	 * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5453
+	 * We consider something to be a copy if all the attributes match (except the ID, of course).
5454
+	 *
5455
+	 * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5456
+	 * @param array               $query_params                     like EEM_Base::get_all's query_params.
5457
+	 * @throws EE_Error
5458
+	 * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5459
+	 *                                                              indexed)
5460
+	 */
5461
+	public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5462
+	{
5463
+		if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5464
+			$attributes_array = $model_object_or_attributes_array->model_field_array();
5465
+		} elseif (is_array($model_object_or_attributes_array)) {
5466
+			$attributes_array = $model_object_or_attributes_array;
5467
+		} else {
5468
+			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",
5469
+				"event_espresso"), $model_object_or_attributes_array));
5470
+		}
5471
+		//even copies obviously won't have the same ID, so remove the primary key
5472
+		//from the WHERE conditions for finding copies (if there is a primary key, of course)
5473
+		if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5474
+			unset($attributes_array[$this->primary_key_name()]);
5475
+		}
5476
+		if (isset($query_params[0])) {
5477
+			$query_params[0] = array_merge($attributes_array, $query_params);
5478
+		} else {
5479
+			$query_params[0] = $attributes_array;
5480
+		}
5481
+		return $this->get_all($query_params);
5482
+	}
5483
+
5484
+
5485
+
5486
+	/**
5487
+	 * Gets the first copy we find. See get_all_copies for more details
5488
+	 *
5489
+	 * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5490
+	 * @param array $query_params
5491
+	 * @return EE_Base_Class
5492
+	 * @throws \EE_Error
5493
+	 */
5494
+	public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5495
+	{
5496
+		if (! is_array($query_params)) {
5497
+			EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5498
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5499
+					gettype($query_params)), '4.6.0');
5500
+			$query_params = array();
5501
+		}
5502
+		$query_params['limit'] = 1;
5503
+		$copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5504
+		if (is_array($copies)) {
5505
+			return array_shift($copies);
5506
+		} else {
5507
+			return null;
5508
+		}
5509
+	}
5510
+
5511
+
5512
+
5513
+	/**
5514
+	 * Updates the item with the specified id. Ignores default query parameters because
5515
+	 * we have specified the ID, and its assumed we KNOW what we're doing
5516
+	 *
5517
+	 * @param array      $fields_n_values keys are field names, values are their new values
5518
+	 * @param int|string $id              the value of the primary key to update
5519
+	 * @return int number of rows updated
5520
+	 * @throws \EE_Error
5521
+	 */
5522
+	public function update_by_ID($fields_n_values, $id)
5523
+	{
5524
+		$query_params = array(
5525
+			0                          => array($this->get_primary_key_field()->get_name() => $id),
5526
+			'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
5527
+		);
5528
+		return $this->update($fields_n_values, $query_params);
5529
+	}
5530
+
5531
+
5532
+
5533
+	/**
5534
+	 * Changes an operator which was supplied to the models into one usable in SQL
5535
+	 *
5536
+	 * @param string $operator_supplied
5537
+	 * @return string an operator which can be used in SQL
5538
+	 * @throws EE_Error
5539
+	 */
5540
+	private function _prepare_operator_for_sql($operator_supplied)
5541
+	{
5542
+		$sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5543
+			: null;
5544
+		if ($sql_operator) {
5545
+			return $sql_operator;
5546
+		} else {
5547
+			throw new EE_Error(sprintf(__("The operator '%s' is not in the list of valid operators: %s",
5548
+				"event_espresso"), $operator_supplied, implode(",", array_keys($this->_valid_operators))));
5549
+		}
5550
+	}
5551
+
5552
+
5553
+
5554
+	/**
5555
+	 * Gets an array where keys are the primary keys and values are their 'names'
5556
+	 * (as determined by the model object's name() function, which is often overridden)
5557
+	 *
5558
+	 * @param array $query_params like get_all's
5559
+	 * @return string[]
5560
+	 * @throws \EE_Error
5561
+	 */
5562
+	public function get_all_names($query_params = array())
5563
+	{
5564
+		$objs = $this->get_all($query_params);
5565
+		$names = array();
5566
+		foreach ($objs as $obj) {
5567
+			$names[$obj->ID()] = $obj->name();
5568
+		}
5569
+		return $names;
5570
+	}
5571
+
5572
+
5573
+
5574
+	/**
5575
+	 * Gets an array of primary keys from the model objects. If you acquired the model objects
5576
+	 * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5577
+	 * this is duplicated effort and reduces efficiency) you would be better to use
5578
+	 * array_keys() on $model_objects.
5579
+	 *
5580
+	 * @param \EE_Base_Class[] $model_objects
5581
+	 * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5582
+	 *                                               in the returned array
5583
+	 * @return array
5584
+	 * @throws \EE_Error
5585
+	 */
5586
+	public function get_IDs($model_objects, $filter_out_empty_ids = false)
5587
+	{
5588
+		if (! $this->has_primary_key_field()) {
5589
+			if (WP_DEBUG) {
5590
+				EE_Error::add_error(
5591
+					__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5592
+					__FILE__,
5593
+					__FUNCTION__,
5594
+					__LINE__
5595
+				);
5596
+			}
5597
+		}
5598
+		$IDs = array();
5599
+		foreach ($model_objects as $model_object) {
5600
+			$id = $model_object->ID();
5601
+			if (! $id) {
5602
+				if ($filter_out_empty_ids) {
5603
+					continue;
5604
+				}
5605
+				if (WP_DEBUG) {
5606
+					EE_Error::add_error(
5607
+						__(
5608
+							'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5609
+							'event_espresso'
5610
+						),
5611
+						__FILE__,
5612
+						__FUNCTION__,
5613
+						__LINE__
5614
+					);
5615
+				}
5616
+			}
5617
+			$IDs[] = $id;
5618
+		}
5619
+		return $IDs;
5620
+	}
5621
+
5622
+
5623
+
5624
+	/**
5625
+	 * Returns the string used in capabilities relating to this model. If there
5626
+	 * are no capabilities that relate to this model returns false
5627
+	 *
5628
+	 * @return string|false
5629
+	 */
5630
+	public function cap_slug()
5631
+	{
5632
+		return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5633
+	}
5634
+
5635
+
5636
+
5637
+	/**
5638
+	 * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5639
+	 * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5640
+	 * only returns the cap restrictions array in that context (ie, the array
5641
+	 * at that key)
5642
+	 *
5643
+	 * @param string $context
5644
+	 * @return EE_Default_Where_Conditions[] indexed by associated capability
5645
+	 * @throws \EE_Error
5646
+	 */
5647
+	public function cap_restrictions($context = EEM_Base::caps_read)
5648
+	{
5649
+		EEM_Base::verify_is_valid_cap_context($context);
5650
+		//check if we ought to run the restriction generator first
5651
+		if (
5652
+			isset($this->_cap_restriction_generators[$context])
5653
+			&& $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5654
+			&& ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5655
+		) {
5656
+			$this->_cap_restrictions[$context] = array_merge(
5657
+				$this->_cap_restrictions[$context],
5658
+				$this->_cap_restriction_generators[$context]->generate_restrictions()
5659
+			);
5660
+		}
5661
+		//and make sure we've finalized the construction of each restriction
5662
+		foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5663
+			if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5664
+				$where_conditions_obj->_finalize_construct($this);
5665
+			}
5666
+		}
5667
+		return $this->_cap_restrictions[$context];
5668
+	}
5669
+
5670
+
5671
+
5672
+	/**
5673
+	 * Indicating whether or not this model thinks its a wp core model
5674
+	 *
5675
+	 * @return boolean
5676
+	 */
5677
+	public function is_wp_core_model()
5678
+	{
5679
+		return $this->_wp_core_model;
5680
+	}
5681
+
5682
+
5683
+
5684
+	/**
5685
+	 * Gets all the caps that are missing which impose a restriction on
5686
+	 * queries made in this context
5687
+	 *
5688
+	 * @param string $context one of EEM_Base::caps_ constants
5689
+	 * @return EE_Default_Where_Conditions[] indexed by capability name
5690
+	 * @throws \EE_Error
5691
+	 */
5692
+	public function caps_missing($context = EEM_Base::caps_read)
5693
+	{
5694
+		$missing_caps = array();
5695
+		$cap_restrictions = $this->cap_restrictions($context);
5696
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5697
+			if (! EE_Capabilities::instance()
5698
+								 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5699
+			) {
5700
+				$missing_caps[$cap] = $restriction_if_no_cap;
5701
+			}
5702
+		}
5703
+		return $missing_caps;
5704
+	}
5705
+
5706
+
5707
+
5708
+	/**
5709
+	 * Gets the mapping from capability contexts to action strings used in capability names
5710
+	 *
5711
+	 * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5712
+	 * one of 'read', 'edit', or 'delete'
5713
+	 */
5714
+	public function cap_contexts_to_cap_action_map()
5715
+	{
5716
+		return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5717
+			$this);
5718
+	}
5719
+
5720
+
5721
+
5722
+	/**
5723
+	 * Gets the action string for the specified capability context
5724
+	 *
5725
+	 * @param string $context
5726
+	 * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5727
+	 * @throws \EE_Error
5728
+	 */
5729
+	public function cap_action_for_context($context)
5730
+	{
5731
+		$mapping = $this->cap_contexts_to_cap_action_map();
5732
+		if (isset($mapping[$context])) {
5733
+			return $mapping[$context];
5734
+		}
5735
+		if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5736
+			return $action;
5737
+		}
5738
+		throw new EE_Error(
5739
+			sprintf(
5740
+				__('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5741
+				$context,
5742
+				implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5743
+			)
5744
+		);
5745
+	}
5746
+
5747
+
5748
+
5749
+	/**
5750
+	 * Returns all the capability contexts which are valid when querying models
5751
+	 *
5752
+	 * @return array
5753
+	 */
5754
+	public static function valid_cap_contexts()
5755
+	{
5756
+		return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5757
+			self::caps_read,
5758
+			self::caps_read_admin,
5759
+			self::caps_edit,
5760
+			self::caps_delete,
5761
+		));
5762
+	}
5763
+
5764
+
5765
+
5766
+	/**
5767
+	 * Returns all valid options for 'default_where_conditions'
5768
+	 *
5769
+	 * @return array
5770
+	 */
5771
+	public static function valid_default_where_conditions()
5772
+	{
5773
+		return array(
5774
+			EEM_Base::default_where_conditions_all,
5775
+			EEM_Base::default_where_conditions_this_only,
5776
+			EEM_Base::default_where_conditions_others_only,
5777
+			EEM_Base::default_where_conditions_minimum_all,
5778
+			EEM_Base::default_where_conditions_minimum_others,
5779
+			EEM_Base::default_where_conditions_none
5780
+		);
5781
+	}
5782
+
5783
+	// public static function default_where_conditions_full
5784
+	/**
5785
+	 * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5786
+	 *
5787
+	 * @param string $context
5788
+	 * @return bool
5789
+	 * @throws \EE_Error
5790
+	 */
5791
+	static public function verify_is_valid_cap_context($context)
5792
+	{
5793
+		$valid_cap_contexts = EEM_Base::valid_cap_contexts();
5794
+		if (in_array($context, $valid_cap_contexts)) {
5795
+			return true;
5796
+		} else {
5797
+			throw new EE_Error(
5798
+				sprintf(
5799
+					__('Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5800
+						'event_espresso'),
5801
+					$context,
5802
+					'EEM_Base',
5803
+					implode(',', $valid_cap_contexts)
5804
+				)
5805
+			);
5806
+		}
5807
+	}
5808
+
5809
+
5810
+
5811
+	/**
5812
+	 * Clears all the models field caches. This is only useful when a sub-class
5813
+	 * might have added a field or something and these caches might be invalidated
5814
+	 */
5815
+	protected function _invalidate_field_caches()
5816
+	{
5817
+		$this->_cache_foreign_key_to_fields = array();
5818
+		$this->_cached_fields = null;
5819
+		$this->_cached_fields_non_db_only = null;
5820
+	}
5821
+
5822
+
5823
+
5824
+	/**
5825
+	 * Gets the list of all the where query param keys that relate to logic instead of field names
5826
+	 * (eg "and", "or", "not").
5827
+	 *
5828
+	 * @return array
5829
+	 */
5830
+	public function logic_query_param_keys()
5831
+	{
5832
+		return $this->_logic_query_param_keys;
5833
+	}
5834
+
5835
+
5836
+
5837
+	/**
5838
+	 * Determines whether or not the where query param array key is for a logic query param.
5839
+	 * Eg 'OR', 'not*', and 'and*because-i-say-so' shoudl all return true, whereas
5840
+	 * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
5841
+	 *
5842
+	 * @param $query_param_key
5843
+	 * @return bool
5844
+	 */
5845
+	public function is_logic_query_param_key($query_param_key)
5846
+	{
5847
+		foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
5848
+			if ($query_param_key === $logic_query_param_key
5849
+				|| strpos($query_param_key, $logic_query_param_key . '*') === 0
5850
+			) {
5851
+				return true;
5852
+			}
5853
+		}
5854
+		return false;
5855
+	}
5856 5856
 
5857 5857
 
5858 5858
 
Please login to merge, or discard this patch.
core/db_models/fields/EE_Datetime_Field.php 2 patches
Indentation   +753 added lines, -753 removed lines patch added patch discarded remove patch
@@ -15,758 +15,758 @@
 block discarded – undo
15 15
 class EE_Datetime_Field extends EE_Model_Field_Base
16 16
 {
17 17
 
18
-    /**
19
-     * The pattern we're looking for is if only the characters 0-9 are found and there are only
20
-     * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
21
-     *
22
-     * @type string unix_timestamp_regex
23
-     */
24
-    const unix_timestamp_regex = '/[0-9]{10,}/';
25
-
26
-    /**
27
-     * @type string mysql_timestamp_format
28
-     */
29
-    const mysql_timestamp_format = 'Y-m-d H:i:s';
30
-
31
-    /**
32
-     * @type string mysql_date_format
33
-     */
34
-    const mysql_date_format = 'Y-m-d';
35
-
36
-    /**
37
-     * @type string mysql_time_format
38
-     */
39
-    const mysql_time_format = 'H:i:s';
40
-
41
-    /**
42
-     * Const for using in the default value. If the field's default is set to this,
43
-     * then we will return the time of calling `get_default_value()`, not
44
-     * just the current time at construction
45
-     */
46
-    const now = 'now';
47
-
48
-    /**
49
-     * The following properties hold the default formats for date and time.
50
-     * Defaults are set via the constructor and can be overridden on class instantiation.
51
-     * However they can also be overridden later by the set_format() method
52
-     * (and corresponding set_date_format, set_time_format methods);
53
-     */
54
-    /**
55
-     * @type string $_date_format
56
-     */
57
-    protected $_date_format = '';
58
-
59
-    /**
60
-     * @type string $_time_format
61
-     */
62
-    protected $_time_format = '';
63
-
64
-    /**
65
-     * @type string $_pretty_date_format
66
-     */
67
-    protected $_pretty_date_format = '';
68
-
69
-    /**
70
-     * @type string $_pretty_time_format
71
-     */
72
-    protected $_pretty_time_format = '';
73
-
74
-    /**
75
-     * @type DateTimeZone $_DateTimeZone
76
-     */
77
-    protected $_DateTimeZone;
78
-
79
-    /**
80
-     * @type DateTimeZone $_UTC_DateTimeZone
81
-     */
82
-    protected $_UTC_DateTimeZone;
83
-
84
-    /**
85
-     * @type DateTimeZone $_blog_DateTimeZone
86
-     */
87
-    protected $_blog_DateTimeZone;
88
-
89
-
90
-    /**
91
-     * This property holds how we want the output returned when getting a datetime string.  It is set for the
92
-     * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
93
-     * and time returned via getters.
94
-     *
95
-     * @var mixed (null|string)
96
-     */
97
-    protected $_date_time_output;
98
-
99
-
100
-    /**
101
-     * timezone string
102
-     * This gets set by the constructor and can be changed by the "set_timezone()" method so that we know what timezone
103
-     * incoming strings|timestamps are in.  This can also be used before a get to set what timezone you want strings
104
-     * coming out of the object to be in.  Default timezone is the current WP timezone option setting
105
-     *
106
-     * @var string
107
-     */
108
-    protected $_timezone_string;
109
-
110
-
111
-    /**
112
-     * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
113
-     * offsets for comparison purposes).
114
-     *
115
-     * @var int
116
-     */
117
-    protected $_blog_offset;
118
-
119
-
120
-    /**
121
-     * @param string $table_column
122
-     * @param string $nice_name
123
-     * @param bool   $nullable
124
-     * @param string $default_value
125
-     * @param string $timezone_string
126
-     * @param string $date_format
127
-     * @param string $time_format
128
-     * @param string $pretty_date_format
129
-     * @param string $pretty_time_format
130
-     * @throws \EE_Error
131
-     */
132
-    public function __construct(
133
-        $table_column,
134
-        $nice_name,
135
-        $nullable,
136
-        $default_value,
137
-        $timezone_string = '',
138
-        $date_format = '',
139
-        $time_format = '',
140
-        $pretty_date_format = '',
141
-        $pretty_time_format = ''
142
-    ) {
143
-
144
-        $this->_date_format        = ! empty($date_format) ? $date_format : get_option('date_format');
145
-        $this->_time_format        = ! empty($time_format) ? $time_format : get_option('time_format');
146
-        $this->_pretty_date_format = ! empty($pretty_date_format) ? $pretty_date_format : get_option('date_format');
147
-        $this->_pretty_time_format = ! empty($pretty_time_format) ? $pretty_time_format : get_option('time_format');
148
-
149
-        parent::__construct($table_column, $nice_name, $nullable, $default_value);
150
-        $this->set_timezone($timezone_string);
151
-        $this->setSchemaFormat('date-time');
152
-    }
153
-
154
-
155
-    /**
156
-     * @return DateTimeZone
157
-     * @throws \EE_Error
158
-     */
159
-    public function get_UTC_DateTimeZone()
160
-    {
161
-        return $this->_UTC_DateTimeZone instanceof DateTimeZone
162
-            ? $this->_UTC_DateTimeZone
163
-            : $this->_create_timezone_object_from_timezone_string('UTC');
164
-    }
165
-
166
-
167
-    /**
168
-     * @return DateTimeZone
169
-     * @throws \EE_Error
170
-     */
171
-    public function get_blog_DateTimeZone()
172
-    {
173
-        return $this->_blog_DateTimeZone instanceof DateTimeZone
174
-            ? $this->_blog_DateTimeZone
175
-            : $this->_create_timezone_object_from_timezone_string('');
176
-    }
177
-
178
-
179
-    /**
180
-     * this prepares any incoming date data and make sure its converted to a utc unix timestamp
181
-     *
182
-     * @param  string|int $value_inputted_for_field_on_model_object could be a string formatted date time or int unix
183
-     *                                                              timestamp
184
-     * @return DateTime
185
-     */
186
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
187
-    {
188
-        return $this->_get_date_object($value_inputted_for_field_on_model_object);
189
-    }
190
-
191
-
192
-    /**
193
-     * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
194
-     * getters need to know whether we're just returning the date or the time or both.  By default we return both.
195
-     *
196
-     * @param bool $pretty If we're returning the pretty formats or standard format string.
197
-     * @return string    The final assembled format string.
198
-     */
199
-    protected function _get_date_time_output($pretty = false)
200
-    {
201
-
202
-        switch ($this->_date_time_output) {
203
-            case 'time' :
204
-                return $pretty ? $this->_pretty_time_format : $this->_time_format;
205
-                break;
206
-
207
-            case 'date' :
208
-                return $pretty ? $this->_pretty_date_format : $this->_date_format;
209
-                break;
210
-
211
-            default :
212
-                return $pretty
213
-                    ? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
214
-                    : $this->_date_format . ' ' . $this->_time_format;
215
-        }
216
-    }
217
-
218
-
219
-    /**
220
-     * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
221
-     * returned (using the format properties)
222
-     *
223
-     * @param string $what acceptable values are 'time' or 'date'.
224
-     *                     Any other value will be set but will always result
225
-     *                     in both 'date' and 'time' being returned.
226
-     * @return void
227
-     */
228
-    public function set_date_time_output($what = null)
229
-    {
230
-        $this->_date_time_output = $what;
231
-    }
232
-
233
-
234
-    /**
235
-     * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
236
-     * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
237
-     * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp).
238
-     * We also set some other properties in this method.
239
-     *
240
-     * @param string $timezone_string A valid timezone string as described by @link
241
-     *                                http://www.php.net/manual/en/timezones.php
242
-     * @return void
243
-     * @throws \EE_Error
244
-     */
245
-    public function set_timezone($timezone_string)
246
-    {
247
-        if (empty($timezone_string) && $this->_timezone_string !== null) {
248
-            // leave the timezone AS-IS if we already have one and
249
-            // the function arg didn't provide one
250
-            return;
251
-        }
252
-        $timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
253
-        $this->_timezone_string = ! empty($timezone_string) ? $timezone_string : 'UTC';
254
-        $this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
255
-    }
256
-
257
-
258
-    /**
259
-     * _create_timezone_object_from_timezone_name
260
-     *
261
-     * @access protected
262
-     * @param string $timezone_string
263
-     * @return \DateTimeZone
264
-     * @throws \EE_Error
265
-     */
266
-    protected function _create_timezone_object_from_timezone_string($timezone_string = '')
267
-    {
268
-        return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
269
-    }
270
-
271
-
272
-    /**
273
-     * This just returns whatever is set for the current timezone.
274
-     *
275
-     * @access public
276
-     * @return string timezone string
277
-     */
278
-    public function get_timezone()
279
-    {
280
-        return $this->_timezone_string;
281
-    }
282
-
283
-
284
-    /**
285
-     * set the $_date_format property
286
-     *
287
-     * @access public
288
-     * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
289
-     * @param bool   $pretty Whether to set pretty format or not.
290
-     * @return void
291
-     */
292
-    public function set_date_format($format, $pretty = false)
293
-    {
294
-        if ($pretty) {
295
-            $this->_pretty_date_format = $format;
296
-        } else {
297
-            $this->_date_format = $format;
298
-        }
299
-    }
300
-
301
-
302
-    /**
303
-     * return the $_date_format property value.
304
-     *
305
-     * @param bool $pretty Whether to get pretty format or not.
306
-     * @return string
307
-     */
308
-    public function get_date_format($pretty = false)
309
-    {
310
-        return $pretty ? $this->_pretty_date_format : $this->_date_format;
311
-    }
312
-
313
-
314
-    /**
315
-     * set the $_time_format property
316
-     *
317
-     * @access public
318
-     * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
319
-     * @param bool   $pretty Whether to set pretty format or not.
320
-     * @return void
321
-     */
322
-    public function set_time_format($format, $pretty = false)
323
-    {
324
-        if ($pretty) {
325
-            $this->_pretty_time_format = $format;
326
-        } else {
327
-            $this->_time_format = $format;
328
-        }
329
-    }
330
-
331
-
332
-    /**
333
-     * return the $_time_format property value.
334
-     *
335
-     * @param bool $pretty Whether to get pretty format or not.
336
-     * @return string
337
-     */
338
-    public function get_time_format($pretty = false)
339
-    {
340
-        return $pretty ? $this->_pretty_time_format : $this->_time_format;
341
-    }
342
-
343
-
344
-    /**
345
-     * set the $_pretty_date_format property
346
-     *
347
-     * @access public
348
-     * @param string $format a new pretty date format (corresponding to formats accepted by PHP date() function)
349
-     * @return void
350
-     */
351
-    public function set_pretty_date_format($format)
352
-    {
353
-        $this->_pretty_date_format = $format;
354
-    }
355
-
356
-
357
-    /**
358
-     * set the $_pretty_time_format property
359
-     *
360
-     * @access public
361
-     * @param string $format a new pretty time format (corresponding to formats accepted by PHP date() function)
362
-     * @return void
363
-     */
364
-    public function set_pretty_time_format($format)
365
-    {
366
-        $this->_pretty_time_format = $format;
367
-    }
368
-
369
-
370
-    /**
371
-     * Only sets the time portion of the datetime.
372
-     *
373
-     * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
374
-     * @param DateTime        $current            current DateTime object for the datetime field
375
-     * @return DateTime
376
-     */
377
-    public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current)
378
-    {
379
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
380
-        // Otherwise parse the string.
381
-        if ($time_to_set_string instanceof DateTime) {
382
-            $parsed = array(
383
-                'hour'   => $time_to_set_string->format('H'),
384
-                'minute' => $time_to_set_string->format('i'),
385
-                'second' => $time_to_set_string->format('s'),
386
-            );
387
-        } else {
388
-            //parse incoming string
389
-            $parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
390
-        }
391
-
392
-        //make sure $current is in the correct timezone.
393
-        $current->setTimezone($this->_DateTimeZone);
394
-
395
-        return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
396
-    }
397
-
398
-
399
-    /**
400
-     * Only sets the date portion of the datetime.
401
-     *
402
-     * @param string|DateTime $date_to_set_string like Friday, January 8th or a DateTime object.
403
-     * @param DateTime        $current            current DateTime object for the datetime field
404
-     * @return DateTime
405
-     */
406
-    public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current)
407
-    {
408
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
409
-        // Otherwise parse the string.
410
-        if ($date_to_set_string instanceof DateTime) {
411
-            $parsed = array(
412
-                'year'  => $date_to_set_string->format('Y'),
413
-                'month' => $date_to_set_string->format('m'),
414
-                'day'   => $date_to_set_string->format('d'),
415
-            );
416
-        } else {
417
-            //parse incoming string
418
-            $parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
419
-        }
420
-
421
-        //make sure $current is in the correct timezone
422
-        $current->setTimezone($this->_DateTimeZone);
423
-
424
-        return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
425
-    }
426
-
427
-
428
-    /**
429
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).  When the
430
-     * datetime gets to this stage it should ALREADY be in UTC time
431
-     *
432
-     * @param  DateTime $DateTime
433
-     * @return string formatted date time for given timezone
434
-     * @throws \EE_Error
435
-     */
436
-    public function prepare_for_get($DateTime)
437
-    {
438
-        return $this->_prepare_for_display($DateTime);
439
-    }
440
-
441
-
442
-    /**
443
-     * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
444
-     * from the set wp timezone.  If so, then it returns the datetime string formatted via
445
-     * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
446
-     * abbreviation to the date_string.
447
-     *
448
-     * @param mixed $DateTime
449
-     * @param null  $schema
450
-     * @return string
451
-     * @throws \EE_Error
452
-     */
453
-    public function prepare_for_pretty_echoing($DateTime, $schema = null)
454
-    {
455
-        return $this->_prepare_for_display($DateTime, $schema ? $schema : true);
456
-    }
457
-
458
-
459
-    /**
460
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
461
-     * timezone).
462
-     *
463
-     * @param DateTime    $DateTime
464
-     * @param bool|string $schema
465
-     * @return string
466
-     * @throws \EE_Error
467
-     */
468
-    protected function _prepare_for_display($DateTime, $schema = false)
469
-    {
470
-        if (! $DateTime instanceof DateTime) {
471
-            if ($this->_nullable) {
472
-                return '';
473
-            } else {
474
-                if (WP_DEBUG) {
475
-                    throw new EE_Error(
476
-                        sprintf(
477
-                            __(
478
-                                'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
479
-                                'event_espresso'
480
-                            ),
481
-                            $this->_nicename
482
-                        )
483
-                    );
484
-                } else {
485
-                    $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now);
486
-                    EE_Error::add_error(
487
-                        sprintf(
488
-                            __(
489
-                                'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
490
-                                'event_espresso'
491
-                            ),
492
-                            $this->_nicename
493
-                        )
494
-                    );
495
-                }
496
-            }
497
-        }
498
-        $format_string = $this->_get_date_time_output($schema);
499
-        //make sure datetime_value is in the correct timezone (in case that's been updated).
500
-        $DateTime->setTimezone($this->_DateTimeZone);
501
-        if ($schema) {
502
-            if ($this->_display_timezone()) {
503
-                //must be explicit because schema could equal true.
504
-                if ($schema === 'no_html') {
505
-                    $timezone_string = ' (' . $DateTime->format('T') . ')';
506
-                } else {
507
-                    $timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
508
-                }
509
-            } else {
510
-                $timezone_string = '';
511
-            }
512
-
513
-            return $DateTime->format($format_string) . $timezone_string;
514
-        } else {
515
-            return $DateTime->format($format_string);
516
-        }
517
-    }
518
-
519
-
520
-    /**
521
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
522
-     * timezone).
523
-     *
524
-     * @param  mixed $datetime_value u
525
-     * @return string mysql timestamp in UTC
526
-     * @throws \EE_Error
527
-     */
528
-    public function prepare_for_use_in_db($datetime_value)
529
-    {
530
-        //we allow an empty value or DateTime object, but nothing else.
531
-        if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
532
-            throw new EE_Error(
533
-            	sprintf(
534
-            	    __(
535
-            		    'The incoming value being prepared for setting in the database must either be empty or a php 
18
+	/**
19
+	 * The pattern we're looking for is if only the characters 0-9 are found and there are only
20
+	 * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
21
+	 *
22
+	 * @type string unix_timestamp_regex
23
+	 */
24
+	const unix_timestamp_regex = '/[0-9]{10,}/';
25
+
26
+	/**
27
+	 * @type string mysql_timestamp_format
28
+	 */
29
+	const mysql_timestamp_format = 'Y-m-d H:i:s';
30
+
31
+	/**
32
+	 * @type string mysql_date_format
33
+	 */
34
+	const mysql_date_format = 'Y-m-d';
35
+
36
+	/**
37
+	 * @type string mysql_time_format
38
+	 */
39
+	const mysql_time_format = 'H:i:s';
40
+
41
+	/**
42
+	 * Const for using in the default value. If the field's default is set to this,
43
+	 * then we will return the time of calling `get_default_value()`, not
44
+	 * just the current time at construction
45
+	 */
46
+	const now = 'now';
47
+
48
+	/**
49
+	 * The following properties hold the default formats for date and time.
50
+	 * Defaults are set via the constructor and can be overridden on class instantiation.
51
+	 * However they can also be overridden later by the set_format() method
52
+	 * (and corresponding set_date_format, set_time_format methods);
53
+	 */
54
+	/**
55
+	 * @type string $_date_format
56
+	 */
57
+	protected $_date_format = '';
58
+
59
+	/**
60
+	 * @type string $_time_format
61
+	 */
62
+	protected $_time_format = '';
63
+
64
+	/**
65
+	 * @type string $_pretty_date_format
66
+	 */
67
+	protected $_pretty_date_format = '';
68
+
69
+	/**
70
+	 * @type string $_pretty_time_format
71
+	 */
72
+	protected $_pretty_time_format = '';
73
+
74
+	/**
75
+	 * @type DateTimeZone $_DateTimeZone
76
+	 */
77
+	protected $_DateTimeZone;
78
+
79
+	/**
80
+	 * @type DateTimeZone $_UTC_DateTimeZone
81
+	 */
82
+	protected $_UTC_DateTimeZone;
83
+
84
+	/**
85
+	 * @type DateTimeZone $_blog_DateTimeZone
86
+	 */
87
+	protected $_blog_DateTimeZone;
88
+
89
+
90
+	/**
91
+	 * This property holds how we want the output returned when getting a datetime string.  It is set for the
92
+	 * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
93
+	 * and time returned via getters.
94
+	 *
95
+	 * @var mixed (null|string)
96
+	 */
97
+	protected $_date_time_output;
98
+
99
+
100
+	/**
101
+	 * timezone string
102
+	 * This gets set by the constructor and can be changed by the "set_timezone()" method so that we know what timezone
103
+	 * incoming strings|timestamps are in.  This can also be used before a get to set what timezone you want strings
104
+	 * coming out of the object to be in.  Default timezone is the current WP timezone option setting
105
+	 *
106
+	 * @var string
107
+	 */
108
+	protected $_timezone_string;
109
+
110
+
111
+	/**
112
+	 * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
113
+	 * offsets for comparison purposes).
114
+	 *
115
+	 * @var int
116
+	 */
117
+	protected $_blog_offset;
118
+
119
+
120
+	/**
121
+	 * @param string $table_column
122
+	 * @param string $nice_name
123
+	 * @param bool   $nullable
124
+	 * @param string $default_value
125
+	 * @param string $timezone_string
126
+	 * @param string $date_format
127
+	 * @param string $time_format
128
+	 * @param string $pretty_date_format
129
+	 * @param string $pretty_time_format
130
+	 * @throws \EE_Error
131
+	 */
132
+	public function __construct(
133
+		$table_column,
134
+		$nice_name,
135
+		$nullable,
136
+		$default_value,
137
+		$timezone_string = '',
138
+		$date_format = '',
139
+		$time_format = '',
140
+		$pretty_date_format = '',
141
+		$pretty_time_format = ''
142
+	) {
143
+
144
+		$this->_date_format        = ! empty($date_format) ? $date_format : get_option('date_format');
145
+		$this->_time_format        = ! empty($time_format) ? $time_format : get_option('time_format');
146
+		$this->_pretty_date_format = ! empty($pretty_date_format) ? $pretty_date_format : get_option('date_format');
147
+		$this->_pretty_time_format = ! empty($pretty_time_format) ? $pretty_time_format : get_option('time_format');
148
+
149
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
150
+		$this->set_timezone($timezone_string);
151
+		$this->setSchemaFormat('date-time');
152
+	}
153
+
154
+
155
+	/**
156
+	 * @return DateTimeZone
157
+	 * @throws \EE_Error
158
+	 */
159
+	public function get_UTC_DateTimeZone()
160
+	{
161
+		return $this->_UTC_DateTimeZone instanceof DateTimeZone
162
+			? $this->_UTC_DateTimeZone
163
+			: $this->_create_timezone_object_from_timezone_string('UTC');
164
+	}
165
+
166
+
167
+	/**
168
+	 * @return DateTimeZone
169
+	 * @throws \EE_Error
170
+	 */
171
+	public function get_blog_DateTimeZone()
172
+	{
173
+		return $this->_blog_DateTimeZone instanceof DateTimeZone
174
+			? $this->_blog_DateTimeZone
175
+			: $this->_create_timezone_object_from_timezone_string('');
176
+	}
177
+
178
+
179
+	/**
180
+	 * this prepares any incoming date data and make sure its converted to a utc unix timestamp
181
+	 *
182
+	 * @param  string|int $value_inputted_for_field_on_model_object could be a string formatted date time or int unix
183
+	 *                                                              timestamp
184
+	 * @return DateTime
185
+	 */
186
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
187
+	{
188
+		return $this->_get_date_object($value_inputted_for_field_on_model_object);
189
+	}
190
+
191
+
192
+	/**
193
+	 * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
194
+	 * getters need to know whether we're just returning the date or the time or both.  By default we return both.
195
+	 *
196
+	 * @param bool $pretty If we're returning the pretty formats or standard format string.
197
+	 * @return string    The final assembled format string.
198
+	 */
199
+	protected function _get_date_time_output($pretty = false)
200
+	{
201
+
202
+		switch ($this->_date_time_output) {
203
+			case 'time' :
204
+				return $pretty ? $this->_pretty_time_format : $this->_time_format;
205
+				break;
206
+
207
+			case 'date' :
208
+				return $pretty ? $this->_pretty_date_format : $this->_date_format;
209
+				break;
210
+
211
+			default :
212
+				return $pretty
213
+					? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
214
+					: $this->_date_format . ' ' . $this->_time_format;
215
+		}
216
+	}
217
+
218
+
219
+	/**
220
+	 * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
221
+	 * returned (using the format properties)
222
+	 *
223
+	 * @param string $what acceptable values are 'time' or 'date'.
224
+	 *                     Any other value will be set but will always result
225
+	 *                     in both 'date' and 'time' being returned.
226
+	 * @return void
227
+	 */
228
+	public function set_date_time_output($what = null)
229
+	{
230
+		$this->_date_time_output = $what;
231
+	}
232
+
233
+
234
+	/**
235
+	 * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
236
+	 * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
237
+	 * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp).
238
+	 * We also set some other properties in this method.
239
+	 *
240
+	 * @param string $timezone_string A valid timezone string as described by @link
241
+	 *                                http://www.php.net/manual/en/timezones.php
242
+	 * @return void
243
+	 * @throws \EE_Error
244
+	 */
245
+	public function set_timezone($timezone_string)
246
+	{
247
+		if (empty($timezone_string) && $this->_timezone_string !== null) {
248
+			// leave the timezone AS-IS if we already have one and
249
+			// the function arg didn't provide one
250
+			return;
251
+		}
252
+		$timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
253
+		$this->_timezone_string = ! empty($timezone_string) ? $timezone_string : 'UTC';
254
+		$this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
255
+	}
256
+
257
+
258
+	/**
259
+	 * _create_timezone_object_from_timezone_name
260
+	 *
261
+	 * @access protected
262
+	 * @param string $timezone_string
263
+	 * @return \DateTimeZone
264
+	 * @throws \EE_Error
265
+	 */
266
+	protected function _create_timezone_object_from_timezone_string($timezone_string = '')
267
+	{
268
+		return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
269
+	}
270
+
271
+
272
+	/**
273
+	 * This just returns whatever is set for the current timezone.
274
+	 *
275
+	 * @access public
276
+	 * @return string timezone string
277
+	 */
278
+	public function get_timezone()
279
+	{
280
+		return $this->_timezone_string;
281
+	}
282
+
283
+
284
+	/**
285
+	 * set the $_date_format property
286
+	 *
287
+	 * @access public
288
+	 * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
289
+	 * @param bool   $pretty Whether to set pretty format or not.
290
+	 * @return void
291
+	 */
292
+	public function set_date_format($format, $pretty = false)
293
+	{
294
+		if ($pretty) {
295
+			$this->_pretty_date_format = $format;
296
+		} else {
297
+			$this->_date_format = $format;
298
+		}
299
+	}
300
+
301
+
302
+	/**
303
+	 * return the $_date_format property value.
304
+	 *
305
+	 * @param bool $pretty Whether to get pretty format or not.
306
+	 * @return string
307
+	 */
308
+	public function get_date_format($pretty = false)
309
+	{
310
+		return $pretty ? $this->_pretty_date_format : $this->_date_format;
311
+	}
312
+
313
+
314
+	/**
315
+	 * set the $_time_format property
316
+	 *
317
+	 * @access public
318
+	 * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
319
+	 * @param bool   $pretty Whether to set pretty format or not.
320
+	 * @return void
321
+	 */
322
+	public function set_time_format($format, $pretty = false)
323
+	{
324
+		if ($pretty) {
325
+			$this->_pretty_time_format = $format;
326
+		} else {
327
+			$this->_time_format = $format;
328
+		}
329
+	}
330
+
331
+
332
+	/**
333
+	 * return the $_time_format property value.
334
+	 *
335
+	 * @param bool $pretty Whether to get pretty format or not.
336
+	 * @return string
337
+	 */
338
+	public function get_time_format($pretty = false)
339
+	{
340
+		return $pretty ? $this->_pretty_time_format : $this->_time_format;
341
+	}
342
+
343
+
344
+	/**
345
+	 * set the $_pretty_date_format property
346
+	 *
347
+	 * @access public
348
+	 * @param string $format a new pretty date format (corresponding to formats accepted by PHP date() function)
349
+	 * @return void
350
+	 */
351
+	public function set_pretty_date_format($format)
352
+	{
353
+		$this->_pretty_date_format = $format;
354
+	}
355
+
356
+
357
+	/**
358
+	 * set the $_pretty_time_format property
359
+	 *
360
+	 * @access public
361
+	 * @param string $format a new pretty time format (corresponding to formats accepted by PHP date() function)
362
+	 * @return void
363
+	 */
364
+	public function set_pretty_time_format($format)
365
+	{
366
+		$this->_pretty_time_format = $format;
367
+	}
368
+
369
+
370
+	/**
371
+	 * Only sets the time portion of the datetime.
372
+	 *
373
+	 * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
374
+	 * @param DateTime        $current            current DateTime object for the datetime field
375
+	 * @return DateTime
376
+	 */
377
+	public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current)
378
+	{
379
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
380
+		// Otherwise parse the string.
381
+		if ($time_to_set_string instanceof DateTime) {
382
+			$parsed = array(
383
+				'hour'   => $time_to_set_string->format('H'),
384
+				'minute' => $time_to_set_string->format('i'),
385
+				'second' => $time_to_set_string->format('s'),
386
+			);
387
+		} else {
388
+			//parse incoming string
389
+			$parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
390
+		}
391
+
392
+		//make sure $current is in the correct timezone.
393
+		$current->setTimezone($this->_DateTimeZone);
394
+
395
+		return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
396
+	}
397
+
398
+
399
+	/**
400
+	 * Only sets the date portion of the datetime.
401
+	 *
402
+	 * @param string|DateTime $date_to_set_string like Friday, January 8th or a DateTime object.
403
+	 * @param DateTime        $current            current DateTime object for the datetime field
404
+	 * @return DateTime
405
+	 */
406
+	public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current)
407
+	{
408
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
409
+		// Otherwise parse the string.
410
+		if ($date_to_set_string instanceof DateTime) {
411
+			$parsed = array(
412
+				'year'  => $date_to_set_string->format('Y'),
413
+				'month' => $date_to_set_string->format('m'),
414
+				'day'   => $date_to_set_string->format('d'),
415
+			);
416
+		} else {
417
+			//parse incoming string
418
+			$parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
419
+		}
420
+
421
+		//make sure $current is in the correct timezone
422
+		$current->setTimezone($this->_DateTimeZone);
423
+
424
+		return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
425
+	}
426
+
427
+
428
+	/**
429
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).  When the
430
+	 * datetime gets to this stage it should ALREADY be in UTC time
431
+	 *
432
+	 * @param  DateTime $DateTime
433
+	 * @return string formatted date time for given timezone
434
+	 * @throws \EE_Error
435
+	 */
436
+	public function prepare_for_get($DateTime)
437
+	{
438
+		return $this->_prepare_for_display($DateTime);
439
+	}
440
+
441
+
442
+	/**
443
+	 * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
444
+	 * from the set wp timezone.  If so, then it returns the datetime string formatted via
445
+	 * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
446
+	 * abbreviation to the date_string.
447
+	 *
448
+	 * @param mixed $DateTime
449
+	 * @param null  $schema
450
+	 * @return string
451
+	 * @throws \EE_Error
452
+	 */
453
+	public function prepare_for_pretty_echoing($DateTime, $schema = null)
454
+	{
455
+		return $this->_prepare_for_display($DateTime, $schema ? $schema : true);
456
+	}
457
+
458
+
459
+	/**
460
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
461
+	 * timezone).
462
+	 *
463
+	 * @param DateTime    $DateTime
464
+	 * @param bool|string $schema
465
+	 * @return string
466
+	 * @throws \EE_Error
467
+	 */
468
+	protected function _prepare_for_display($DateTime, $schema = false)
469
+	{
470
+		if (! $DateTime instanceof DateTime) {
471
+			if ($this->_nullable) {
472
+				return '';
473
+			} else {
474
+				if (WP_DEBUG) {
475
+					throw new EE_Error(
476
+						sprintf(
477
+							__(
478
+								'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
479
+								'event_espresso'
480
+							),
481
+							$this->_nicename
482
+						)
483
+					);
484
+				} else {
485
+					$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now);
486
+					EE_Error::add_error(
487
+						sprintf(
488
+							__(
489
+								'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
490
+								'event_espresso'
491
+							),
492
+							$this->_nicename
493
+						)
494
+					);
495
+				}
496
+			}
497
+		}
498
+		$format_string = $this->_get_date_time_output($schema);
499
+		//make sure datetime_value is in the correct timezone (in case that's been updated).
500
+		$DateTime->setTimezone($this->_DateTimeZone);
501
+		if ($schema) {
502
+			if ($this->_display_timezone()) {
503
+				//must be explicit because schema could equal true.
504
+				if ($schema === 'no_html') {
505
+					$timezone_string = ' (' . $DateTime->format('T') . ')';
506
+				} else {
507
+					$timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
508
+				}
509
+			} else {
510
+				$timezone_string = '';
511
+			}
512
+
513
+			return $DateTime->format($format_string) . $timezone_string;
514
+		} else {
515
+			return $DateTime->format($format_string);
516
+		}
517
+	}
518
+
519
+
520
+	/**
521
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
522
+	 * timezone).
523
+	 *
524
+	 * @param  mixed $datetime_value u
525
+	 * @return string mysql timestamp in UTC
526
+	 * @throws \EE_Error
527
+	 */
528
+	public function prepare_for_use_in_db($datetime_value)
529
+	{
530
+		//we allow an empty value or DateTime object, but nothing else.
531
+		if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
532
+			throw new EE_Error(
533
+				sprintf(
534
+					__(
535
+						'The incoming value being prepared for setting in the database must either be empty or a php 
536 536
             		    DateTime object, instead of: %1$s %2$s',
537
-                        'event_espresso'
538
-	                ),
539
-                    '<br />',
540
-                    print_r($datetime_value, true)
541
-                )
542
-            );
543
-        }
544
-
545
-        if ($datetime_value instanceof DateTime) {
546
-            if ( ! $datetime_value instanceof DbSafeDateTime) {
547
-                $datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
548
-            }
549
-
550
-            return $datetime_value->setTimezone($this->get_UTC_DateTimeZone())->format(
551
-                EE_Datetime_Field::mysql_timestamp_format
552
-            );
553
-        }
554
-
555
-        // if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
556
-        return ! $this->_nullable && empty($datetime_value) ? current_time('mysql', true) : null;
557
-    }
558
-
559
-
560
-    /**
561
-     * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
562
-     * allowed)
563
-     *
564
-     * @param string $datetime_string mysql timestamp in UTC
565
-     * @return  mixed null | DateTime
566
-     * @throws \EE_Error
567
-     */
568
-    public function prepare_for_set_from_db($datetime_string)
569
-    {
570
-        //if $datetime_value is empty, and ! $this->_nullable, just use time()
571
-        if (empty($datetime_string) && $this->_nullable) {
572
-            return null;
573
-        }
574
-        // datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
575
-        if (empty($datetime_string)) {
576
-            $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
577
-        } else {
578
-            $DateTime = DateTime::createFromFormat(
579
-                EE_Datetime_Field::mysql_timestamp_format,
580
-                $datetime_string,
581
-                $this->get_UTC_DateTimeZone()
582
-            );
583
-            if ($DateTime instanceof \DateTime) {
584
-                $DateTime = new DbSafeDateTime(
585
-                    $DateTime->format(\EE_Datetime_Field::mysql_timestamp_format),
586
-                    $this->get_UTC_DateTimeZone()
587
-                );
588
-            }
589
-        }
590
-
591
-        if (! $DateTime instanceof DbSafeDateTime) {
592
-            // if still no datetime object, then let's just use now
593
-            $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
594
-        }
595
-        // THEN apply the field's set DateTimeZone
596
-        $DateTime->setTimezone($this->_DateTimeZone);
597
-
598
-        return $DateTime;
599
-    }
600
-
601
-
602
-    /**
603
-     * All this method does is determine if we're going to display the timezone string or not on any output.
604
-     * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
605
-     * If so, then true.
606
-     *
607
-     * @return bool true for yes false for no
608
-     * @throws \EE_Error
609
-     */
610
-    protected function _display_timezone()
611
-    {
612
-
613
-        // first let's do a comparison of timezone strings.
614
-        // If they match then we can get out without any further calculations
615
-        $blog_string = get_option('timezone_string');
616
-        if ($blog_string === $this->_timezone_string) {
617
-            return false;
618
-        }
619
-        // now we need to calc the offset for the timezone string so we can compare with the blog offset.
620
-        $this_offset = $this->get_timezone_offset($this->_DateTimeZone);
621
-        $blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
622
-        // now compare
623
-        return $blog_offset !== $this_offset;
624
-    }
625
-
626
-
627
-    /**
628
-     * This method returns a php DateTime object for setting on the EE_Base_Class model.
629
-     * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
630
-     * with.
631
-     *
632
-     * @param int|string|DateTime $date_string            This should be the incoming date string.  It's assumed to be
633
-     *                                                    in the format that is set on the date_field (or DateTime
634
-     *                                                    object)!
635
-     * @return DateTime
636
-     */
637
-    protected function _get_date_object($date_string)
638
-    {
639
-        //first if this is an empty date_string and nullable is allowed, just return null.
640
-        if ($this->_nullable && empty($date_string)) {
641
-            return null;
642
-        }
643
-
644
-        // if incoming date
645
-        if ($date_string instanceof DateTime) {
646
-            $date_string->setTimezone($this->_DateTimeZone);
647
-
648
-            return $date_string;
649
-        }
650
-        // if empty date_string and made it here.
651
-        // Return a datetime object for now in the given timezone.
652
-        if (empty($date_string)) {
653
-            return new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
654
-        }
655
-        // if $date_string is matches something that looks like a Unix timestamp let's just use it.
656
-        if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
657
-            try {
658
-                // This is operating under the assumption that the incoming Unix timestamp
659
-                // is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
660
-                $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
661
-                $DateTime->setTimestamp($date_string);
662
-
663
-                return $DateTime;
664
-            } catch (Exception $e) {
665
-                // should be rare, but if things got fooled then let's just continue
666
-            }
667
-        }
668
-        //not a unix timestamp.  So we will use the set format on this object and set timezone to
669
-        //create the DateTime object.
670
-        $format = $this->_date_format . ' ' . $this->_time_format;
671
-        try {
672
-            $DateTime = DateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
673
-            if ($DateTime instanceof DateTime) {
674
-                $DateTime = new DbSafeDateTime(
675
-                    $DateTime->format(\EE_Datetime_Field::mysql_timestamp_format),
676
-                    $this->_DateTimeZone
677
-                );
678
-            }
679
-            if (! $DateTime instanceof DbSafeDateTime) {
680
-                throw new EE_Error(
681
-                    sprintf(
682
-                        __('"%1$s" does not represent a valid Date Time in the format "%2$s".', 'event_espresso'),
683
-                        $date_string,
684
-                        $format
685
-                    )
686
-                );
687
-            }
688
-        } catch (Exception $e) {
689
-            // if we made it here then likely then something went really wrong.
690
-            // Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
691
-            $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
692
-        }
693
-
694
-        return $DateTime;
695
-    }
696
-
697
-
698
-
699
-    /**
700
-     * get_timezone_transitions
701
-     *
702
-     * @param \DateTimeZone $DateTimeZone
703
-     * @param int           $time
704
-     * @param bool          $first_only
705
-     * @return mixed
706
-     */
707
-    public function get_timezone_transitions(DateTimeZone $DateTimeZone, $time = null, $first_only = true)
708
-    {
709
-        $time = is_int($time) || $time === null ? $time : strtotime($time);
710
-        $time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
711
-        $transitions = $DateTimeZone->getTransitions($time);
712
-        return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions;
713
-    }
714
-
715
-
716
-
717
-    /**
718
-     * get_timezone_offset
719
-     *
720
-     * @param \DateTimeZone $DateTimeZone
721
-     * @param int           $time
722
-     * @return mixed
723
-     * @throws \DomainException
724
-     */
725
-    public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
726
-    {
727
-        $transitions = $this->get_timezone_transitions($DateTimeZone, $time);
728
-        if ( ! isset($transitions['offset'])) {
729
-            throw new DomainException();
730
-        }
731
-        return $transitions['offset'];
732
-    }
733
-
734
-
735
-    /**
736
-     * This will take an incoming timezone string and return the abbreviation for that timezone
737
-     *
738
-     * @param  string $timezone_string
739
-     * @return string           abbreviation
740
-     * @throws \EE_Error
741
-     */
742
-    public function get_timezone_abbrev($timezone_string)
743
-    {
744
-        $timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
745
-        $dateTime        = new DateTime(\EE_Datetime_Field::now, new DateTimeZone($timezone_string));
746
-
747
-        return $dateTime->format('T');
748
-    }
749
-
750
-    /**
751
-     * Overrides the parent to allow for having a dynamic "now" value
752
-     *
753
-     * @return mixed
754
-     */
755
-    public function get_default_value()
756
-    {
757
-        if ($this->_default_value === EE_Datetime_Field::now) {
758
-            return time();
759
-        } else {
760
-            return parent::get_default_value();
761
-        }
762
-    }
763
-
764
-
765
-    public function getSchemaDescription()
766
-    {
767
-        return sprintf(
768
-            esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
769
-            $this->get_nicename()
770
-        );
771
-    }
537
+						'event_espresso'
538
+					),
539
+					'<br />',
540
+					print_r($datetime_value, true)
541
+				)
542
+			);
543
+		}
544
+
545
+		if ($datetime_value instanceof DateTime) {
546
+			if ( ! $datetime_value instanceof DbSafeDateTime) {
547
+				$datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
548
+			}
549
+
550
+			return $datetime_value->setTimezone($this->get_UTC_DateTimeZone())->format(
551
+				EE_Datetime_Field::mysql_timestamp_format
552
+			);
553
+		}
554
+
555
+		// if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
556
+		return ! $this->_nullable && empty($datetime_value) ? current_time('mysql', true) : null;
557
+	}
558
+
559
+
560
+	/**
561
+	 * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
562
+	 * allowed)
563
+	 *
564
+	 * @param string $datetime_string mysql timestamp in UTC
565
+	 * @return  mixed null | DateTime
566
+	 * @throws \EE_Error
567
+	 */
568
+	public function prepare_for_set_from_db($datetime_string)
569
+	{
570
+		//if $datetime_value is empty, and ! $this->_nullable, just use time()
571
+		if (empty($datetime_string) && $this->_nullable) {
572
+			return null;
573
+		}
574
+		// datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
575
+		if (empty($datetime_string)) {
576
+			$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
577
+		} else {
578
+			$DateTime = DateTime::createFromFormat(
579
+				EE_Datetime_Field::mysql_timestamp_format,
580
+				$datetime_string,
581
+				$this->get_UTC_DateTimeZone()
582
+			);
583
+			if ($DateTime instanceof \DateTime) {
584
+				$DateTime = new DbSafeDateTime(
585
+					$DateTime->format(\EE_Datetime_Field::mysql_timestamp_format),
586
+					$this->get_UTC_DateTimeZone()
587
+				);
588
+			}
589
+		}
590
+
591
+		if (! $DateTime instanceof DbSafeDateTime) {
592
+			// if still no datetime object, then let's just use now
593
+			$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
594
+		}
595
+		// THEN apply the field's set DateTimeZone
596
+		$DateTime->setTimezone($this->_DateTimeZone);
597
+
598
+		return $DateTime;
599
+	}
600
+
601
+
602
+	/**
603
+	 * All this method does is determine if we're going to display the timezone string or not on any output.
604
+	 * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
605
+	 * If so, then true.
606
+	 *
607
+	 * @return bool true for yes false for no
608
+	 * @throws \EE_Error
609
+	 */
610
+	protected function _display_timezone()
611
+	{
612
+
613
+		// first let's do a comparison of timezone strings.
614
+		// If they match then we can get out without any further calculations
615
+		$blog_string = get_option('timezone_string');
616
+		if ($blog_string === $this->_timezone_string) {
617
+			return false;
618
+		}
619
+		// now we need to calc the offset for the timezone string so we can compare with the blog offset.
620
+		$this_offset = $this->get_timezone_offset($this->_DateTimeZone);
621
+		$blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
622
+		// now compare
623
+		return $blog_offset !== $this_offset;
624
+	}
625
+
626
+
627
+	/**
628
+	 * This method returns a php DateTime object for setting on the EE_Base_Class model.
629
+	 * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
630
+	 * with.
631
+	 *
632
+	 * @param int|string|DateTime $date_string            This should be the incoming date string.  It's assumed to be
633
+	 *                                                    in the format that is set on the date_field (or DateTime
634
+	 *                                                    object)!
635
+	 * @return DateTime
636
+	 */
637
+	protected function _get_date_object($date_string)
638
+	{
639
+		//first if this is an empty date_string and nullable is allowed, just return null.
640
+		if ($this->_nullable && empty($date_string)) {
641
+			return null;
642
+		}
643
+
644
+		// if incoming date
645
+		if ($date_string instanceof DateTime) {
646
+			$date_string->setTimezone($this->_DateTimeZone);
647
+
648
+			return $date_string;
649
+		}
650
+		// if empty date_string and made it here.
651
+		// Return a datetime object for now in the given timezone.
652
+		if (empty($date_string)) {
653
+			return new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
654
+		}
655
+		// if $date_string is matches something that looks like a Unix timestamp let's just use it.
656
+		if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
657
+			try {
658
+				// This is operating under the assumption that the incoming Unix timestamp
659
+				// is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
660
+				$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
661
+				$DateTime->setTimestamp($date_string);
662
+
663
+				return $DateTime;
664
+			} catch (Exception $e) {
665
+				// should be rare, but if things got fooled then let's just continue
666
+			}
667
+		}
668
+		//not a unix timestamp.  So we will use the set format on this object and set timezone to
669
+		//create the DateTime object.
670
+		$format = $this->_date_format . ' ' . $this->_time_format;
671
+		try {
672
+			$DateTime = DateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
673
+			if ($DateTime instanceof DateTime) {
674
+				$DateTime = new DbSafeDateTime(
675
+					$DateTime->format(\EE_Datetime_Field::mysql_timestamp_format),
676
+					$this->_DateTimeZone
677
+				);
678
+			}
679
+			if (! $DateTime instanceof DbSafeDateTime) {
680
+				throw new EE_Error(
681
+					sprintf(
682
+						__('"%1$s" does not represent a valid Date Time in the format "%2$s".', 'event_espresso'),
683
+						$date_string,
684
+						$format
685
+					)
686
+				);
687
+			}
688
+		} catch (Exception $e) {
689
+			// if we made it here then likely then something went really wrong.
690
+			// Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
691
+			$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
692
+		}
693
+
694
+		return $DateTime;
695
+	}
696
+
697
+
698
+
699
+	/**
700
+	 * get_timezone_transitions
701
+	 *
702
+	 * @param \DateTimeZone $DateTimeZone
703
+	 * @param int           $time
704
+	 * @param bool          $first_only
705
+	 * @return mixed
706
+	 */
707
+	public function get_timezone_transitions(DateTimeZone $DateTimeZone, $time = null, $first_only = true)
708
+	{
709
+		$time = is_int($time) || $time === null ? $time : strtotime($time);
710
+		$time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
711
+		$transitions = $DateTimeZone->getTransitions($time);
712
+		return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions;
713
+	}
714
+
715
+
716
+
717
+	/**
718
+	 * get_timezone_offset
719
+	 *
720
+	 * @param \DateTimeZone $DateTimeZone
721
+	 * @param int           $time
722
+	 * @return mixed
723
+	 * @throws \DomainException
724
+	 */
725
+	public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
726
+	{
727
+		$transitions = $this->get_timezone_transitions($DateTimeZone, $time);
728
+		if ( ! isset($transitions['offset'])) {
729
+			throw new DomainException();
730
+		}
731
+		return $transitions['offset'];
732
+	}
733
+
734
+
735
+	/**
736
+	 * This will take an incoming timezone string and return the abbreviation for that timezone
737
+	 *
738
+	 * @param  string $timezone_string
739
+	 * @return string           abbreviation
740
+	 * @throws \EE_Error
741
+	 */
742
+	public function get_timezone_abbrev($timezone_string)
743
+	{
744
+		$timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
745
+		$dateTime        = new DateTime(\EE_Datetime_Field::now, new DateTimeZone($timezone_string));
746
+
747
+		return $dateTime->format('T');
748
+	}
749
+
750
+	/**
751
+	 * Overrides the parent to allow for having a dynamic "now" value
752
+	 *
753
+	 * @return mixed
754
+	 */
755
+	public function get_default_value()
756
+	{
757
+		if ($this->_default_value === EE_Datetime_Field::now) {
758
+			return time();
759
+		} else {
760
+			return parent::get_default_value();
761
+		}
762
+	}
763
+
764
+
765
+	public function getSchemaDescription()
766
+	{
767
+		return sprintf(
768
+			esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
769
+			$this->get_nicename()
770
+		);
771
+	}
772 772
 }
Please login to merge, or discard this patch.
Spacing   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -210,8 +210,8 @@  discard block
 block discarded – undo
210 210
 
211 211
             default :
212 212
                 return $pretty
213
-                    ? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
214
-                    : $this->_date_format . ' ' . $this->_time_format;
213
+                    ? $this->_pretty_date_format.' '.$this->_pretty_time_format
214
+                    : $this->_date_format.' '.$this->_time_format;
215 215
         }
216 216
     }
217 217
 
@@ -467,7 +467,7 @@  discard block
 block discarded – undo
467 467
      */
468 468
     protected function _prepare_for_display($DateTime, $schema = false)
469 469
     {
470
-        if (! $DateTime instanceof DateTime) {
470
+        if ( ! $DateTime instanceof DateTime) {
471 471
             if ($this->_nullable) {
472 472
                 return '';
473 473
             } else {
@@ -502,15 +502,15 @@  discard block
 block discarded – undo
502 502
             if ($this->_display_timezone()) {
503 503
                 //must be explicit because schema could equal true.
504 504
                 if ($schema === 'no_html') {
505
-                    $timezone_string = ' (' . $DateTime->format('T') . ')';
505
+                    $timezone_string = ' ('.$DateTime->format('T').')';
506 506
                 } else {
507
-                    $timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
507
+                    $timezone_string = ' <span class="ee_dtt_timezone_string">('.$DateTime->format('T').')</span>';
508 508
                 }
509 509
             } else {
510 510
                 $timezone_string = '';
511 511
             }
512 512
 
513
-            return $DateTime->format($format_string) . $timezone_string;
513
+            return $DateTime->format($format_string).$timezone_string;
514 514
         } else {
515 515
             return $DateTime->format($format_string);
516 516
         }
@@ -528,7 +528,7 @@  discard block
 block discarded – undo
528 528
     public function prepare_for_use_in_db($datetime_value)
529 529
     {
530 530
         //we allow an empty value or DateTime object, but nothing else.
531
-        if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
531
+        if ( ! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
532 532
             throw new EE_Error(
533 533
             	sprintf(
534 534
             	    __(
@@ -588,7 +588,7 @@  discard block
 block discarded – undo
588 588
             }
589 589
         }
590 590
 
591
-        if (! $DateTime instanceof DbSafeDateTime) {
591
+        if ( ! $DateTime instanceof DbSafeDateTime) {
592 592
             // if still no datetime object, then let's just use now
593 593
             $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
594 594
         }
@@ -667,7 +667,7 @@  discard block
 block discarded – undo
667 667
         }
668 668
         //not a unix timestamp.  So we will use the set format on this object and set timezone to
669 669
         //create the DateTime object.
670
-        $format = $this->_date_format . ' ' . $this->_time_format;
670
+        $format = $this->_date_format.' '.$this->_time_format;
671 671
         try {
672 672
             $DateTime = DateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
673 673
             if ($DateTime instanceof DateTime) {
@@ -676,7 +676,7 @@  discard block
 block discarded – undo
676 676
                     $this->_DateTimeZone
677 677
                 );
678 678
             }
679
-            if (! $DateTime instanceof DbSafeDateTime) {
679
+            if ( ! $DateTime instanceof DbSafeDateTime) {
680 680
                 throw new EE_Error(
681 681
                     sprintf(
682 682
                         __('"%1$s" does not represent a valid Date Time in the format "%2$s".', 'event_espresso'),
Please login to merge, or discard this patch.
core/services/commands/middleware/CapChecker.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -7,7 +7,7 @@
 block discarded – undo
7 7
 use EventEspresso\core\services\commands\CommandInterface;
8 8
 use EventEspresso\core\services\commands\CommandRequiresCapCheckInterface;
9 9
 
10
-if (! defined('EVENT_ESPRESSO_VERSION')) {
10
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
11 11
     exit('No direct script access allowed');
12 12
 }
13 13
 
Please login to merge, or discard this patch.
Indentation   +30 added lines, -30 removed lines patch added patch discarded remove patch
@@ -9,7 +9,7 @@  discard block
 block discarded – undo
9 9
 use EventEspresso\core\services\commands\CommandRequiresCapCheckInterface;
10 10
 
11 11
 if (! defined('EVENT_ESPRESSO_VERSION')) {
12
-    exit('No direct script access allowed');
12
+	exit('No direct script access allowed');
13 13
 }
14 14
 
15 15
 
@@ -29,41 +29,41 @@  discard block
 block discarded – undo
29 29
 class CapChecker implements CommandBusMiddlewareInterface
30 30
 {
31 31
 
32
-    /**
33
-     * @type CapabilitiesCheckerInterface $capabilities_checker
34
-     */
35
-    private $capabilities_checker;
32
+	/**
33
+	 * @type CapabilitiesCheckerInterface $capabilities_checker
34
+	 */
35
+	private $capabilities_checker;
36 36
 
37 37
 
38 38
 
39
-    /**
40
-     * CapChecker constructor
41
-     *
42
-     * @param CapabilitiesCheckerInterface $capabilities_checker
43
-     */
44
-    public function __construct(CapabilitiesCheckerInterface $capabilities_checker)
45
-    {
46
-        $this->capabilities_checker = $capabilities_checker;
47
-    }
39
+	/**
40
+	 * CapChecker constructor
41
+	 *
42
+	 * @param CapabilitiesCheckerInterface $capabilities_checker
43
+	 */
44
+	public function __construct(CapabilitiesCheckerInterface $capabilities_checker)
45
+	{
46
+		$this->capabilities_checker = $capabilities_checker;
47
+	}
48 48
 
49 49
 
50 50
 
51
-    /**
52
-     * @param CommandInterface $command
53
-     * @param Closure         $next
54
-     * @return mixed
55
-     * @throws InvalidClassException
56
-     * @throws InsufficientPermissionsException
57
-     */
58
-    public function handle(CommandInterface $command, Closure $next)
59
-    {
60
-        if ($command instanceof CommandRequiresCapCheckInterface) {
61
-            $this->capabilities_checker->processCapCheck(
62
-                $command->getCapCheck()
63
-            );
64
-        }
65
-        return $next($command);
66
-    }
51
+	/**
52
+	 * @param CommandInterface $command
53
+	 * @param Closure         $next
54
+	 * @return mixed
55
+	 * @throws InvalidClassException
56
+	 * @throws InsufficientPermissionsException
57
+	 */
58
+	public function handle(CommandInterface $command, Closure $next)
59
+	{
60
+		if ($command instanceof CommandRequiresCapCheckInterface) {
61
+			$this->capabilities_checker->processCapCheck(
62
+				$command->getCapCheck()
63
+			);
64
+		}
65
+		return $next($command);
66
+	}
67 67
 
68 68
 
69 69
 }
Please login to merge, or discard this patch.
core/services/commands/transaction/CreateTransactionCommand.php 2 patches
Indentation   +60 added lines, -60 removed lines patch added patch discarded remove patch
@@ -24,66 +24,66 @@
 block discarded – undo
24 24
 class CreateTransactionCommand extends Command implements CommandRequiresCapCheckInterface
25 25
 {
26 26
 
27
-    /**
28
-     * @var EE_Checkout $checkout
29
-     */
30
-    protected $checkout;
31
-
32
-    /**
33
-     * @var array $transaction_details
34
-     */
35
-    protected $transaction_details;
36
-
37
-
38
-
39
-    /**
40
-     * CreateTransactionCommand constructor.
41
-     *
42
-     * @param EE_Checkout $checkout
43
-     * @param array       $transaction_details
44
-     */
45
-    public function __construct(EE_Checkout $checkout = null, array $transaction_details = array())
46
-    {
47
-        $this->checkout = $checkout;
48
-        $this->transaction_details = $transaction_details;
49
-    }
50
-
51
-
52
-
53
-    /**
54
-     * @return CapCheckInterface
55
-     * @throws InvalidDataTypeException
56
-     */
57
-    public function getCapCheck()
58
-    {
59
-        // need cap for non-AJAX admin requests
60
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
61
-            // there's no specific caps for editing/creating transactions,
62
-            // so that's why we are using ee_edit_registrations
63
-            return new CapCheck('ee_edit_registrations', 'create_new_transaction');
64
-        }
65
-        return new PublicCapabilities('', 'create_new_transaction');
66
-    }
67
-
68
-
69
-
70
-    /**
71
-     * @return EE_Checkout
72
-     */
73
-    public function checkout()
74
-    {
75
-        return $this->checkout;
76
-    }
77
-
78
-
79
-
80
-    /**
81
-     * @return array
82
-     */
83
-    public function transactionDetails()
84
-    {
85
-        return $this->transaction_details;
86
-    }
27
+	/**
28
+	 * @var EE_Checkout $checkout
29
+	 */
30
+	protected $checkout;
31
+
32
+	/**
33
+	 * @var array $transaction_details
34
+	 */
35
+	protected $transaction_details;
36
+
37
+
38
+
39
+	/**
40
+	 * CreateTransactionCommand constructor.
41
+	 *
42
+	 * @param EE_Checkout $checkout
43
+	 * @param array       $transaction_details
44
+	 */
45
+	public function __construct(EE_Checkout $checkout = null, array $transaction_details = array())
46
+	{
47
+		$this->checkout = $checkout;
48
+		$this->transaction_details = $transaction_details;
49
+	}
50
+
51
+
52
+
53
+	/**
54
+	 * @return CapCheckInterface
55
+	 * @throws InvalidDataTypeException
56
+	 */
57
+	public function getCapCheck()
58
+	{
59
+		// need cap for non-AJAX admin requests
60
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
61
+			// there's no specific caps for editing/creating transactions,
62
+			// so that's why we are using ee_edit_registrations
63
+			return new CapCheck('ee_edit_registrations', 'create_new_transaction');
64
+		}
65
+		return new PublicCapabilities('', 'create_new_transaction');
66
+	}
67
+
68
+
69
+
70
+	/**
71
+	 * @return EE_Checkout
72
+	 */
73
+	public function checkout()
74
+	{
75
+		return $this->checkout;
76
+	}
77
+
78
+
79
+
80
+	/**
81
+	 * @return array
82
+	 */
83
+	public function transactionDetails()
84
+	{
85
+		return $this->transaction_details;
86
+	}
87 87
 
88 88
 
89 89
 
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -57,7 +57,7 @@
 block discarded – undo
57 57
     public function getCapCheck()
58 58
     {
59 59
         // need cap for non-AJAX admin requests
60
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
60
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
61 61
             // there's no specific caps for editing/creating transactions,
62 62
             // so that's why we are using ee_edit_registrations
63 63
             return new CapCheck('ee_edit_registrations', 'create_new_transaction');
Please login to merge, or discard this patch.
core/services/commands/transaction/CreateTransactionCommandHandler.php 2 patches
Indentation   +38 added lines, -38 removed lines patch added patch discarded remove patch
@@ -26,44 +26,44 @@
 block discarded – undo
26 26
 {
27 27
 
28 28
 
29
-    /**
30
-     * @param CommandInterface $command
31
-     * @return mixed
32
-     * @throws EE_Error
33
-     * @throws InvalidEntityException
34
-     */
35
-    public function handle(CommandInterface $command)
36
-    {
37
-        /** @var CreateTransactionCommand $command */
38
-        if (! $command instanceof CreateTransactionCommand) {
39
-            throw new InvalidEntityException(get_class($command), 'CreateTransactionCommand');
40
-        }
41
-        $transaction_details = $command->transactionDetails();
42
-        $cart_total = null;
43
-        if ($command->checkout() instanceof EE_Checkout) {
44
-            // ensure cart totals have been calculated
45
-            $command->checkout()->cart->get_grand_total()->recalculate_total_including_taxes();
46
-            // grab the cart grand total
47
-            $cart_total = $command->checkout()->cart->get_cart_grand_total();
48
-            $transaction_details['TXN_reg_steps'] = $command->checkout()->initialize_txn_reg_steps_array();
49
-            $transaction_details['TXN_total'] = $cart_total > 0 ? $cart_total : 0;
50
-        }
51
-        // create new TXN and save it so it has an ID
52
-        $transaction = EE_Transaction::new_instance($transaction_details);
53
-        if (! $transaction instanceof EE_Transaction) {
54
-            throw new InvalidEntityException(get_class($transaction), 'EE_Transaction');
55
-        }
56
-        $transaction->save();
57
-        // ensure grand total line item created
58
-        $cart_total = $cart_total instanceof EE_Line_Item
59
-            ? $cart_total
60
-            : EEH_Line_Item::create_total_line_item($transaction);
61
-        if (! $cart_total instanceof EE_Line_Item) {
62
-            throw new InvalidEntityException(get_class($cart_total), 'EE_Line_Item');
63
-        }
64
-        $cart_total->save_this_and_descendants_to_txn($transaction->ID());
65
-        return $transaction;
66
-    }
29
+	/**
30
+	 * @param CommandInterface $command
31
+	 * @return mixed
32
+	 * @throws EE_Error
33
+	 * @throws InvalidEntityException
34
+	 */
35
+	public function handle(CommandInterface $command)
36
+	{
37
+		/** @var CreateTransactionCommand $command */
38
+		if (! $command instanceof CreateTransactionCommand) {
39
+			throw new InvalidEntityException(get_class($command), 'CreateTransactionCommand');
40
+		}
41
+		$transaction_details = $command->transactionDetails();
42
+		$cart_total = null;
43
+		if ($command->checkout() instanceof EE_Checkout) {
44
+			// ensure cart totals have been calculated
45
+			$command->checkout()->cart->get_grand_total()->recalculate_total_including_taxes();
46
+			// grab the cart grand total
47
+			$cart_total = $command->checkout()->cart->get_cart_grand_total();
48
+			$transaction_details['TXN_reg_steps'] = $command->checkout()->initialize_txn_reg_steps_array();
49
+			$transaction_details['TXN_total'] = $cart_total > 0 ? $cart_total : 0;
50
+		}
51
+		// create new TXN and save it so it has an ID
52
+		$transaction = EE_Transaction::new_instance($transaction_details);
53
+		if (! $transaction instanceof EE_Transaction) {
54
+			throw new InvalidEntityException(get_class($transaction), 'EE_Transaction');
55
+		}
56
+		$transaction->save();
57
+		// ensure grand total line item created
58
+		$cart_total = $cart_total instanceof EE_Line_Item
59
+			? $cart_total
60
+			: EEH_Line_Item::create_total_line_item($transaction);
61
+		if (! $cart_total instanceof EE_Line_Item) {
62
+			throw new InvalidEntityException(get_class($cart_total), 'EE_Line_Item');
63
+		}
64
+		$cart_total->save_this_and_descendants_to_txn($transaction->ID());
65
+		return $transaction;
66
+	}
67 67
 
68 68
 
69 69
 }
Please login to merge, or discard this patch.
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -35,7 +35,7 @@  discard block
 block discarded – undo
35 35
     public function handle(CommandInterface $command)
36 36
     {
37 37
         /** @var CreateTransactionCommand $command */
38
-        if (! $command instanceof CreateTransactionCommand) {
38
+        if ( ! $command instanceof CreateTransactionCommand) {
39 39
             throw new InvalidEntityException(get_class($command), 'CreateTransactionCommand');
40 40
         }
41 41
         $transaction_details = $command->transactionDetails();
@@ -50,7 +50,7 @@  discard block
 block discarded – undo
50 50
         }
51 51
         // create new TXN and save it so it has an ID
52 52
         $transaction = EE_Transaction::new_instance($transaction_details);
53
-        if (! $transaction instanceof EE_Transaction) {
53
+        if ( ! $transaction instanceof EE_Transaction) {
54 54
             throw new InvalidEntityException(get_class($transaction), 'EE_Transaction');
55 55
         }
56 56
         $transaction->save();
@@ -58,7 +58,7 @@  discard block
 block discarded – undo
58 58
         $cart_total = $cart_total instanceof EE_Line_Item
59 59
             ? $cart_total
60 60
             : EEH_Line_Item::create_total_line_item($transaction);
61
-        if (! $cart_total instanceof EE_Line_Item) {
61
+        if ( ! $cart_total instanceof EE_Line_Item) {
62 62
             throw new InvalidEntityException(get_class($cart_total), 'EE_Line_Item');
63 63
         }
64 64
         $cart_total->save_this_and_descendants_to_txn($transaction->ID());
Please login to merge, or discard this patch.
core/services/commands/attendee/CreateAttendeeCommand.php 2 patches
Indentation   +62 added lines, -62 removed lines patch added patch discarded remove patch
@@ -24,68 +24,68 @@
 block discarded – undo
24 24
 class CreateAttendeeCommand extends Command implements CommandRequiresCapCheckInterface
25 25
 {
26 26
 
27
-    /**
28
-     * array of details where keys are names of EEM_Attendee model fields
29
-     *
30
-     * @var array $attendee_details
31
-     */
32
-    protected $attendee_details;
33
-
34
-    /**
35
-     * an existing registration to associate this attendee with
36
-     *
37
-     * @var EE_Registration $registration
38
-     */
39
-    protected $registration;
40
-
41
-
42
-
43
-    /**
44
-     * CreateAttendeeCommand constructor.
45
-     *
46
-     * @param array            $attendee_details
47
-     * @param EE_Registration $registration
48
-     */
49
-    public function __construct(array $attendee_details, EE_Registration $registration)
50
-    {
51
-        $this->attendee_details = $attendee_details;
52
-        $this->registration = $registration;
53
-    }
54
-
55
-
56
-
57
-    /**
58
-     * @return array
59
-     */
60
-    public function attendeeDetails()
61
-    {
62
-        return $this->attendee_details;
63
-    }
64
-
65
-
66
-
67
-    /**
68
-     * @return EE_Registration
69
-     */
70
-    public function registration()
71
-    {
72
-        return $this->registration;
73
-    }
74
-
75
-
76
-
77
-    /**
78
-     * @return CapCheckInterface
79
-     * @throws InvalidDataTypeException
80
-     */
81
-    public function getCapCheck()
82
-    {
83
-        // need cap for non-AJAX admin requests
84
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
85
-            return new CapCheck('ee_edit_contacts', 'create_new_contact');
86
-        }
87
-        return new PublicCapabilities('', 'create_new_contact');
88
-    }
27
+	/**
28
+	 * array of details where keys are names of EEM_Attendee model fields
29
+	 *
30
+	 * @var array $attendee_details
31
+	 */
32
+	protected $attendee_details;
33
+
34
+	/**
35
+	 * an existing registration to associate this attendee with
36
+	 *
37
+	 * @var EE_Registration $registration
38
+	 */
39
+	protected $registration;
40
+
41
+
42
+
43
+	/**
44
+	 * CreateAttendeeCommand constructor.
45
+	 *
46
+	 * @param array            $attendee_details
47
+	 * @param EE_Registration $registration
48
+	 */
49
+	public function __construct(array $attendee_details, EE_Registration $registration)
50
+	{
51
+		$this->attendee_details = $attendee_details;
52
+		$this->registration = $registration;
53
+	}
54
+
55
+
56
+
57
+	/**
58
+	 * @return array
59
+	 */
60
+	public function attendeeDetails()
61
+	{
62
+		return $this->attendee_details;
63
+	}
64
+
65
+
66
+
67
+	/**
68
+	 * @return EE_Registration
69
+	 */
70
+	public function registration()
71
+	{
72
+		return $this->registration;
73
+	}
74
+
75
+
76
+
77
+	/**
78
+	 * @return CapCheckInterface
79
+	 * @throws InvalidDataTypeException
80
+	 */
81
+	public function getCapCheck()
82
+	{
83
+		// need cap for non-AJAX admin requests
84
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
85
+			return new CapCheck('ee_edit_contacts', 'create_new_contact');
86
+		}
87
+		return new PublicCapabilities('', 'create_new_contact');
88
+	}
89 89
 
90 90
 
91 91
 
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -81,7 +81,7 @@
 block discarded – undo
81 81
     public function getCapCheck()
82 82
     {
83 83
         // need cap for non-AJAX admin requests
84
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
84
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
85 85
             return new CapCheck('ee_edit_contacts', 'create_new_contact');
86 86
         }
87 87
         return new PublicCapabilities('', 'create_new_contact');
Please login to merge, or discard this patch.