Completed
Branch FET-9576-iframes (dd63ac)
by
unknown
85:44 queued 73:52
created
core/db_models/EEM_Registration.model.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -373,7 +373,7 @@
 block discarded – undo
373 373
      * @param    int $ATT_ID
374 374
      * @param    int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the
375 375
      *                         attendee number is required
376
-     * @return        mixed        array on success, FALSE on fail
376
+     * @return        null|EE_Base_Class        array on success, FALSE on fail
377 377
      */
378 378
     public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0)
379 379
     {
Please login to merge, or discard this patch.
Indentation   +711 added lines, -711 removed lines patch added patch discarded remove patch
@@ -2,7 +2,7 @@  discard block
 block discarded – undo
2 2
 use EventEspresso\core\services\database\TableAnalysis;
3 3
 
4 4
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
5
-    exit('No direct script access allowed');
5
+	exit('No direct script access allowed');
6 6
 }
7 7
 
8 8
 
@@ -18,699 +18,699 @@  discard block
 block discarded – undo
18 18
 class EEM_Registration extends EEM_Soft_Delete_Base
19 19
 {
20 20
 
21
-    // private instance of the Registration object
22
-    protected static $_instance = null;
23
-
24
-    /**
25
-     * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values
26
-     * are status codes (eg, approved, cancelled, etc)
27
-     *
28
-     * @var array
29
-     */
30
-    private static $_reg_status;
31
-
32
-    /**
33
-     * The value of REG_count for a primary registrant
34
-     */
35
-    const PRIMARY_REGISTRANT_COUNT = 1;
36
-
37
-    /**
38
-     * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration.
39
-     * Initial status for registrations when they are first created
40
-     * Payments are NOT allowed.
41
-     * Automatically toggled to whatever the default Event registration status is upon completion of the attendee
42
-     * information reg step NO space reserved. Registration is NOT active
43
-     */
44
-    const status_id_incomplete = 'RIC';
45
-
46
-    /**
47
-     * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration.
48
-     * Payments are NOT allowed.
49
-     * Event Admin must manually toggle STS_ID for it to change
50
-     * No space reserved.
51
-     * Registration is active
52
-     */
53
-    const status_id_not_approved = 'RNA';
54
-
55
-    /**
56
-     * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT .
57
-     * Payments are allowed.
58
-     * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
59
-     * No space reserved.
60
-     * Registration is active
61
-     */
62
-    const status_id_pending_payment = 'RPP';
63
-
64
-    /**
65
-     * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST .
66
-     * Payments are allowed.
67
-     * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
68
-     * No space reserved.
69
-     * Registration is active
70
-     */
71
-    const status_id_wait_list = 'RWL';
72
-
73
-    /**
74
-     * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration.
75
-     * the TXN may or may not be completed ( paid in full )
76
-     * Payments are allowed.
77
-     * A space IS reserved.
78
-     * Registration is active
79
-     */
80
-    const status_id_approved = 'RAP';
81
-
82
-    /**
83
-     * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee.
84
-     * Payments are NOT allowed.
85
-     * NO space reserved.
86
-     * Registration is NOT active
87
-     */
88
-    const status_id_cancelled = 'RCN';
89
-
90
-    /**
91
-     * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin
92
-     * Payments are NOT allowed.
93
-     * No space reserved.
94
-     * Registration is NOT active
95
-     */
96
-    const status_id_declined = 'RDC';
97
-
98
-    /**
99
-     * @var TableAnalysis $table_analysis
100
-     */
101
-    protected $_table_analysis;
102
-
103
-
104
-
105
-    /**
106
-     *    private constructor to prevent direct creation
107
-     *
108
-     * @Constructor
109
-     * @access protected
110
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
111
-     *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
112
-     *                         date time model field objects.  Default is NULL (and will be assumed using the set
113
-     *                         timezone in the 'timezone_string' wp option)
114
-     */
115
-    protected function __construct($timezone = null)
116
-    {
117
-        $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
118
-        $this->singular_item = __('Registration', 'event_espresso');
119
-        $this->plural_item = __('Registrations', 'event_espresso');
120
-        $this->_tables = array(
121
-            'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'),
122
-        );
123
-        $this->_fields = array(
124
-            'Registration' => array(
125
-                'REG_ID'           => new EE_Primary_Key_Int_Field('REG_ID', __('Registration ID', 'event_espresso')),
126
-                'EVT_ID'           => new EE_Foreign_Key_Int_Field('EVT_ID', __('Event ID', 'event_espresso'), false, 0,
127
-                    'Event'),
128
-                'ATT_ID'           => new EE_Foreign_Key_Int_Field('ATT_ID', __('Attendee ID', 'event_espresso'), false,
129
-                    0, 'Attendee'),
130
-                'TXN_ID'           => new EE_Foreign_Key_Int_Field('TXN_ID', __('Transaction ID', 'event_espresso'),
131
-                    false, 0, 'Transaction'),
132
-                'TKT_ID'           => new EE_Foreign_Key_Int_Field('TKT_ID', __('Ticket ID', 'event_espresso'), false,
133
-                    0, 'Ticket'),
134
-                'STS_ID'           => new EE_Foreign_Key_String_Field('STS_ID', __('Status ID', 'event_espresso'),
135
-                    false, EEM_Registration::status_id_incomplete, 'Status'),
136
-                'REG_date'         => new EE_Datetime_Field('REG_date',
137
-                    __('Time registration occurred', 'event_espresso'), false, EE_Datetime_Field::now, $timezone),
138
-                'REG_final_price'  => new EE_Money_Field('REG_final_price',
139
-                    __('Registration\'s share of the transaction total', 'event_espresso'), false, 0),
140
-                'REG_paid'         => new EE_Money_Field('REG_paid',
141
-                    __('Amount paid to date towards registration', 'event_espresso'), false, 0),
142
-                'REG_session'      => new EE_Plain_Text_Field('REG_session',
143
-                    __('Session ID of registration', 'event_espresso'), false, ''),
144
-                'REG_code'         => new EE_Plain_Text_Field('REG_code',
145
-                    __('Unique Code for this registration', 'event_espresso'), false, ''),
146
-                'REG_url_link'     => new EE_Plain_Text_Field('REG_url_link',
147
-                    __('String to be used in URL for identifying registration', 'event_espresso'), false, ''),
148
-                'REG_count'        => new EE_Integer_Field('REG_count',
149
-                    __('Count of this registration in the group registration ', 'event_espresso'), true, 1),
150
-                'REG_group_size'   => new EE_Integer_Field('REG_group_size',
151
-                    __('Number of registrations on this group', 'event_espresso'), false, 1),
152
-                'REG_att_is_going' => new EE_Boolean_Field('REG_att_is_going',
153
-                    __('Flag indicating the registrant plans on attending', 'event_espresso'), false, false),
154
-                'REG_deleted'      => new EE_Trashed_Flag_Field('REG_deleted',
155
-                    __('Flag indicating if registration has been archived or not.', 'event_espresso'), false, false),
156
-            ),
157
-        );
158
-        $this->_model_relations = array(
159
-            'Event'                => new EE_Belongs_To_Relation(),
160
-            'Attendee'             => new EE_Belongs_To_Relation(),
161
-            'Transaction'          => new EE_Belongs_To_Relation(),
162
-            'Ticket'               => new EE_Belongs_To_Relation(),
163
-            'Status'               => new EE_Belongs_To_Relation(),
164
-            'Answer'               => new EE_Has_Many_Relation(),
165
-            'Checkin'              => new EE_Has_Many_Relation(),
166
-            'Registration_Payment' => new EE_Has_Many_Relation(),
167
-            'Payment'              => new EE_HABTM_Relation('Registration_Payment'),
168
-            'Message'              => new EE_Has_Many_Any_Relation(false)
169
-            //allow deletes even if there are messages in the queue related
170
-        );
171
-        $this->_model_chain_to_wp_user = 'Event';
172
-        parent::__construct($timezone);
173
-    }
174
-
175
-
176
-
177
-    /**
178
-     * reg_statuses_that_allow_payment
179
-     * a filterable list of registration statuses that allow a registrant to make a payment
180
-     *
181
-     * @access public
182
-     * @return array
183
-     */
184
-    public static function reg_statuses_that_allow_payment()
185
-    {
186
-        return apply_filters('FHEE__EEM_Registration__reg_statuses_that_allow_payment', array(
187
-            EEM_Registration::status_id_approved,
188
-            EEM_Registration::status_id_pending_payment,
189
-            EEM_Registration::status_id_wait_list,
190
-        ));
191
-    }
192
-
193
-
194
-
195
-    /**
196
-     * inactive_reg_statuses
197
-     * a filterable list of registration statuses that are considered active
198
-     *
199
-     * @access public
200
-     * @return array
201
-     */
202
-    public static function active_reg_statuses()
203
-    {
204
-        return apply_filters('FHEE__EEM_Registration__reg_statuses_that_allow_payment', array(
205
-            EEM_Registration::status_id_approved,
206
-            EEM_Registration::status_id_pending_payment,
207
-            EEM_Registration::status_id_wait_list,
208
-            EEM_Registration::status_id_not_approved,
209
-        ));
210
-    }
211
-
212
-
213
-
214
-    /**
215
-     * inactive_reg_statuses
216
-     * a filterable list of registration statuses that are not considered active
217
-     *
218
-     * @access public
219
-     * @return array
220
-     */
221
-    public static function inactive_reg_statuses()
222
-    {
223
-        return apply_filters('FHEE__EEM_Registration__reg_statuses_that_allow_payment', array(
224
-            EEM_Registration::status_id_incomplete,
225
-            EEM_Registration::status_id_cancelled,
226
-            EEM_Registration::status_id_declined,
227
-        ));
228
-    }
229
-
230
-
231
-
232
-    /**
233
-     *    closed_reg_statuses
234
-     *    a filterable list of registration statuses that are considered "closed"
235
-     * meaning they should not be considered in any calculations involving monies owing
236
-     *
237
-     * @access public
238
-     * @return array
239
-     */
240
-    public static function closed_reg_statuses()
241
-    {
242
-        return apply_filters('FHEE__EEM_Registration__closed_reg_statuses', array(
243
-            EEM_Registration::status_id_cancelled,
244
-            EEM_Registration::status_id_declined,
245
-        ));
246
-    }
247
-
248
-
249
-
250
-    /**
251
-     *        get list of registration statuses
252
-     *
253
-     * @access public
254
-     * @param array $exclude    The status ids to exclude from the returned results
255
-     * @param bool  $translated If true will return the values as singular localized strings
256
-     * @return array
257
-     */
258
-    public static function reg_status_array($exclude = array(), $translated = false)
259
-    {
260
-        EEM_Registration::instance()->_get_registration_status_array($exclude);
261
-        return $translated ? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence')
262
-            : self::$_reg_status;
263
-    }
264
-
265
-
266
-
267
-    /**
268
-     *    get list of registration statuses
269
-     *
270
-     * @access private
271
-     * @param array $exclude
272
-     * @return array
273
-     */
274
-    private function _get_registration_status_array($exclude = array())
275
-    {
276
-        //in the very rare circumstance that we are deleting a model's table's data
277
-        //and the table hasn't actually been created, this could have an error
278
-        /** @type WPDB $wpdb */
279
-        global $wpdb;
280
-        if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
281
-            $SQL = 'SELECT STS_ID, STS_code FROM ' . $wpdb->prefix . 'esp_status WHERE STS_type = "registration"';
282
-            $results = $wpdb->get_results($SQL);
283
-            self::$_reg_status = array();
284
-            foreach ($results as $status) {
285
-                if ( ! in_array($status->STS_ID, $exclude)) {
286
-                    self::$_reg_status[$status->STS_ID] = $status->STS_code;
287
-                }
288
-            }
289
-        }
290
-    }
291
-
292
-
293
-
294
-    /**
295
-     * Gets the injected table analyzer, or throws an exception
296
-     *
297
-     * @return TableAnalysis
298
-     * @throws \EE_Error
299
-     */
300
-    protected function _get_table_analysis()
301
-    {
302
-        if ($this->_table_analysis instanceof TableAnalysis) {
303
-            return $this->_table_analysis;
304
-        } else {
305
-            throw new \EE_Error(sprintf(__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
306
-                get_class($this)));
307
-        }
308
-    }
309
-
310
-
311
-
312
-    /**
313
-     * This returns a wpdb->results array of all registration date month and years matching the incoming query params
314
-     * and grouped by month and year.
315
-     *
316
-     * @param  array $where_params Array of query_params as described in the comments for EEM_Base::get_all()
317
-     * @return array
318
-     * @throws \EE_Error
319
-     */
320
-    public function get_reg_months_and_years($where_params)
321
-    {
322
-        $query_params[0] = $where_params;
323
-        $query_params['group_by'] = array('reg_year', 'reg_month');
324
-        $query_params['order_by'] = array('REG_date' => 'DESC');
325
-        $columns_to_select = array(
326
-            'reg_year'  => array('YEAR(REG_date)', '%s'),
327
-            'reg_month' => array('MONTHNAME(REG_date)', '%s'),
328
-        );
329
-        return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
330
-    }
331
-
332
-
333
-
334
-    /**
335
-     *        retrieve ALL registrations for a particular Attendee from db
336
-     *
337
-     * @access        public
338
-     * @param        int $ATT_ID
339
-     * @return    EE_Registration[]
340
-     */
341
-    public function get_all_registrations_for_attendee($ATT_ID = 0)
342
-    {
343
-        if ( ! $ATT_ID) {
344
-            return false;
345
-        }
346
-        return $this->get_all(array(array('ATT_ID' => $ATT_ID)));
347
-    }
348
-
349
-
350
-
351
-    /**
352
-     * Gets a registration given their REG_url_link. Yes, this should usually
353
-     * be passed via a GET parameter.
354
-     *
355
-     * @param string $REG_url_link
356
-     * @return EE_Registration
357
-     */
358
-    public function get_registration_for_reg_url_link($REG_url_link)
359
-    {
360
-        if ( ! $REG_url_link) {
361
-            return false;
362
-        }
363
-        return $this->get_one(array(array('REG_url_link' => $REG_url_link)));
364
-    }
365
-
366
-
367
-
368
-    /**
369
-     *        retrieve registration for a specific transaction attendee from db
370
-     *
371
-     * @access        public
372
-     * @param    int $TXN_ID
373
-     * @param    int $ATT_ID
374
-     * @param    int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the
375
-     *                         attendee number is required
376
-     * @return        mixed        array on success, FALSE on fail
377
-     */
378
-    public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0)
379
-    {
380
-        return $this->get_one(array(
381
-            array(
382
-                'TXN_ID' => $TXN_ID,
383
-                'ATT_ID' => $ATT_ID,
384
-            ),
385
-            'limit' => array(min(($att_nmbr - 1), 0), 1),
386
-        ));
387
-    }
388
-
389
-
390
-
391
-    /**
392
-     *        get the number of registrations per day  for the Registration Admin page Reports Tab.
393
-     *        (doesn't utilize models because it's a fairly specialized query)
394
-     *
395
-     * @access        public
396
-     * @param $period string which can be passed to php's strtotime function (eg "-1 month")
397
-     * @return stdClass[] with properties regDate and total
398
-     */
399
-    public function get_registrations_per_day_report($period = '-1 month')
400
-    {
401
-        $sql_date = $this->convert_datetime_for_query('REG_date', date("Y-m-d H:i:s", strtotime($period)),
402
-            'Y-m-d H:i:s', 'UTC');
403
-        $where = array(
404
-            'REG_date' => array('>=', $sql_date),
405
-            'STS_ID'   => array('!=', EEM_Registration::status_id_incomplete),
406
-        );
407
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
408
-            $where['Event.EVT_wp_user'] = get_current_user_id();
409
-        }
410
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
411
-        $results = $this->_get_all_wpdb_results(array(
412
-            $where,
413
-            'group_by' => 'regDate',
414
-            'order_by' => array('REG_date' => 'ASC'),
415
-        ), OBJECT, array(
416
-            'regDate' => array('DATE(' . $query_interval . ')', '%s'),
417
-            'total'   => array('count(REG_ID)', '%d'),
418
-        ));
419
-        return $results;
420
-    }
421
-
422
-
423
-
424
-    /**
425
-     * Get the number of registrations per day including the count of registrations for each Registration Status.
426
-     * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
427
-     *
428
-     * @param string $period
429
-     * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID
430
-     *                    (i.e. RAP)
431
-     */
432
-    public function get_registrations_per_day_and_per_status_report($period = '-1 month')
433
-    {
434
-        global $wpdb;
435
-        $registration_table = $wpdb->prefix . 'esp_registration';
436
-        $event_table = $wpdb->posts;
437
-        $sql_date = date("Y-m-d H:i:s", strtotime($period));
438
-        //prepare the query interval for displaying offset
439
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date');
440
-        //inner date query
441
-        $inner_date_query = "SELECT DISTINCT REG_date from $registration_table ";
442
-        $inner_where = " WHERE";
443
-        //exclude events not authored by user if permissions in effect
444
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
445
-            $inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
446
-            $inner_where .= " post_author = " . get_current_user_id() . " AND";
447
-        }
448
-        $inner_where .= " REG_date >= '$sql_date'";
449
-        $inner_date_query .= $inner_where;
450
-        //start main query
451
-        $select = "SELECT DATE($query_interval) as Registration_REG_date, ";
452
-        $join = '';
453
-        $join_parts = array();
454
-        $select_parts = array();
455
-        //loop through registration stati to do parts for each status.
456
-        foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
457
-            if ($STS_ID === EEM_Registration::status_id_incomplete) {
458
-                continue;
459
-            }
460
-            $select_parts[] = "COUNT($STS_code.REG_ID) as $STS_ID";
461
-            $join_parts[] = "$registration_table AS $STS_code ON $STS_code.REG_date = dates.REG_date AND $STS_code.STS_ID = '$STS_ID'";
462
-        }
463
-        //setup the selects
464
-        $select .= implode(', ', $select_parts);
465
-        $select .= " FROM ($inner_date_query) AS dates LEFT JOIN ";
466
-        //setup the joins
467
-        $join .= implode(" LEFT JOIN ", $join_parts);
468
-        //now let's put it all together
469
-        $query = $select . $join . ' GROUP BY Registration_REG_date';
470
-        //and execute it
471
-        $results = $wpdb->get_results($query, ARRAY_A);
472
-        return $results;
473
-    }
474
-
475
-
476
-
477
-    /**
478
-     *        get the number of registrations per event  for the Registration Admin page Reports Tab
479
-     *
480
-     * @access        public
481
-     * @param $period string which can be passed to php's strtotime function (eg "-1 month")
482
-     * @return stdClass[] each with properties event_name, reg_limit, and total
483
-     */
484
-    public function get_registrations_per_event_report($period = '-1 month')
485
-    {
486
-        $date_sql = $this->convert_datetime_for_query('REG_date', date("Y-m-d H:i:s", strtotime($period)),
487
-            'Y-m-d H:i:s', 'UTC');
488
-        $where = array(
489
-            'REG_date' => array('>=', $date_sql),
490
-            'STS_ID'   => array('!=', EEM_Registration::status_id_incomplete),
491
-        );
492
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
493
-            $where['Event.EVT_wp_user'] = get_current_user_id();
494
-        }
495
-        $results = $this->_get_all_wpdb_results(array(
496
-            $where,
497
-            'group_by' => 'Event.EVT_name',
498
-            'order_by' => 'Event.EVT_name',
499
-            'limit'    => array(0, 24),
500
-        ), OBJECT, array(
501
-            'event_name' => array('Event_CPT.post_title', '%s'),
502
-            'total'      => array('COUNT(REG_ID)', '%s'),
503
-        ));
504
-        return $results;
505
-    }
506
-
507
-
508
-
509
-    /**
510
-     * Get the number of registrations per event grouped by registration status.
511
-     * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
512
-     *
513
-     * @param string $period
514
-     * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID
515
-     *                    (i.e. RAP)
516
-     */
517
-    public function get_registrations_per_event_and_per_status_report($period = '-1 month')
518
-    {
519
-        global $wpdb;
520
-        $registration_table = $wpdb->prefix . 'esp_registration';
521
-        $event_table = $wpdb->posts;
522
-        $sql_date = date("Y-m-d H:i:s", strtotime($period));
523
-        //inner date query
524
-        $inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
525
-        $inner_where = " WHERE";
526
-        //exclude events not authored by user if permissions in effect
527
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
528
-            $inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
529
-            $inner_where .= " post_author = " . get_current_user_id() . " AND";
530
-        }
531
-        $inner_where .= " REG_date >= '$sql_date'";
532
-        $inner_date_query .= $inner_where;
533
-        //build main query
534
-        $select = "SELECT Event.post_title as Registration_Event, ";
535
-        $join = '';
536
-        $join_parts = array();
537
-        $select_parts = array();
538
-        //loop through registration stati to do parts for each status.
539
-        foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
540
-            if ($STS_ID === EEM_Registration::status_id_incomplete) {
541
-                continue;
542
-            }
543
-            $select_parts[] = "COUNT($STS_code.REG_ID) as $STS_ID";
544
-            $join_parts[] = "$registration_table AS $STS_code ON $STS_code.EVT_ID = dates.EVT_ID AND $STS_code.STS_ID = '$STS_ID' AND $STS_code.REG_date = dates.REG_date";
545
-        }
546
-        //setup the selects
547
-        $select .= implode(', ', $select_parts);
548
-        $select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN ";
549
-        //setup remaining joins
550
-        $join .= implode(" LEFT JOIN ", $join_parts);
551
-        //now put it all together
552
-        $query = $select . $join . ' GROUP BY Registration_Event';
553
-        //and execute
554
-        $results = $wpdb->get_results($query, ARRAY_A);
555
-        return $results;
556
-    }
557
-
558
-
559
-
560
-    /**
561
-     * Returns the EE_Registration of the primary attendee on the transaction id provided
562
-     *
563
-     * @param int $TXN_ID
564
-     * @return EE_Registration
565
-     */
566
-    public function get_primary_registration_for_transaction_ID($TXN_ID = 0)
567
-    {
568
-        if ( ! $TXN_ID) {
569
-            return false;
570
-        }
571
-        return $this->get_one(array(
572
-            array(
573
-                'TXN_ID'    => $TXN_ID,
574
-                'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT,
575
-            ),
576
-        ));
577
-    }
578
-
579
-
580
-
581
-    /**
582
-     *        get_event_registration_count
583
-     *
584
-     * @access public
585
-     * @param int     $EVT_ID
586
-     * @param boolean $for_incomplete_payments
587
-     * @return int
588
-     */
589
-    public function get_event_registration_count($EVT_ID, $for_incomplete_payments = false)
590
-    {
591
-        // we only count approved registrations towards registration limits
592
-        $query_params = array(array('EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved));
593
-        if ($for_incomplete_payments) {
594
-            $query_params[0]['Transaction.STS_ID'] = array('!=', EEM_Transaction::complete_status_code);
595
-        }
596
-        return $this->count($query_params);
597
-    }
598
-
599
-
600
-
601
-    /**
602
-     * Deletes all registrations with no transactions. Note that this needs to be very efficient
603
-     * and so it uses wpdb directly
604
-     *
605
-     * @global WPDB $wpdb
606
-     * @return int number deleted
607
-     */
608
-    public function delete_registrations_with_no_transaction()
609
-    {
610
-        /** @type WPDB $wpdb */
611
-        global $wpdb;
612
-        return $wpdb->query('DELETE r FROM '
613
-                            . $this->table()
614
-                            . ' r LEFT JOIN '
615
-                            . EEM_Transaction::instance()->table()
616
-                            . ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL');
617
-    }
618
-
619
-
620
-
621
-    /**
622
-     *  Count registrations checked into (or out of) a datetime
623
-     *
624
-     * @param int     $DTT_ID     datetime ID
625
-     * @param boolean $checked_in whether to count registrations checked IN or OUT
626
-     * @return int
627
-     */
628
-    public function count_registrations_checked_into_datetime($DTT_ID, $checked_in = true)
629
-    {
630
-        global $wpdb;
631
-        //subquery to get latest checkin
632
-        $query = $wpdb->prepare('SELECT '
633
-                                . 'COUNT( DISTINCT checkins.REG_ID ) '
634
-                                . 'FROM '
635
-                                . EEM_Checkin::instance()
636
-                                             ->table()
637
-                                . ' AS checkins INNER JOIN'
638
-                                . '( SELECT '
639
-                                . 'max( CHK_timestamp ) AS latest_checkin, '
640
-                                . 'REG_ID AS REG_ID '
641
-                                . 'FROM '
642
-                                . EEM_Checkin::instance()->table()
643
-                                . ' '
644
-                                . 'WHERE DTT_ID=%d '
645
-                                . 'GROUP BY REG_ID'
646
-                                . ') AS most_recent_checkin_per_reg '
647
-                                . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
648
-                                . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
649
-                                . 'WHERE '
650
-                                . 'checkins.CHK_in=%d', $DTT_ID, $checked_in);
651
-        return (int)$wpdb->get_var($query);
652
-    }
653
-
654
-
655
-
656
-    /**
657
-     *  Count registrations checked into (or out of) an event.
658
-     *
659
-     * @param int     $EVT_ID     event ID
660
-     * @param boolean $checked_in whether to count registrations checked IN or OUT
661
-     * @return int
662
-     */
663
-    public function count_registrations_checked_into_event($EVT_ID, $checked_in = true)
664
-    {
665
-        global $wpdb;
666
-        //subquery to get latest checkin
667
-        $query = $wpdb->prepare('SELECT '
668
-                                . 'COUNT( DISTINCT checkins.REG_ID ) '
669
-                                . 'FROM '
670
-                                . EEM_Checkin::instance()
671
-                                             ->table()
672
-                                . ' AS checkins INNER JOIN'
673
-                                . '( SELECT '
674
-                                . 'max( CHK_timestamp ) AS latest_checkin, '
675
-                                . 'REG_ID AS REG_ID '
676
-                                . 'FROM '
677
-                                . EEM_Checkin::instance()->table()
678
-                                . ' AS c '
679
-                                . 'INNER JOIN '
680
-                                . EEM_Datetime::instance()->table()
681
-                                . ' AS d '
682
-                                . 'ON c.DTT_ID=d.DTT_ID '
683
-                                . 'WHERE d.EVT_ID=%d '
684
-                                . 'GROUP BY REG_ID'
685
-                                . ') AS most_recent_checkin_per_reg '
686
-                                . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
687
-                                . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
688
-                                . 'WHERE '
689
-                                . 'checkins.CHK_in=%d', $EVT_ID, $checked_in);
690
-        return (int)$wpdb->get_var($query);
691
-    }
692
-
693
-
694
-
695
-    /**
696
-     * The purpose of this method is to retrieve an array of
697
-     * EE_Registration objects that represent the latest registration
698
-     * for each ATT_ID given in the function argument.
699
-     *
700
-     * @param array $attendee_ids
701
-     * @return EE_Registration[]
702
-     */
703
-    public function get_latest_registration_for_each_of_given_contacts($attendee_ids = array())
704
-    {
705
-        //first do a native wp_query to get the latest REG_ID's matching these attendees.
706
-        global $wpdb;
707
-        $registration_table = $wpdb->prefix . 'esp_registration';
708
-        $attendee_table = $wpdb->posts;
709
-        $attendee_ids = is_array($attendee_ids) ? array_map('absint', $attendee_ids) : array((int)$attendee_ids);
710
-        $attendee_ids = implode(',', $attendee_ids);
711
-        //first we do a query to get the registration ids
712
-        // (because a group by before order by causes the order by to be ignored.)
713
-        $registration_id_query = "
21
+	// private instance of the Registration object
22
+	protected static $_instance = null;
23
+
24
+	/**
25
+	 * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values
26
+	 * are status codes (eg, approved, cancelled, etc)
27
+	 *
28
+	 * @var array
29
+	 */
30
+	private static $_reg_status;
31
+
32
+	/**
33
+	 * The value of REG_count for a primary registrant
34
+	 */
35
+	const PRIMARY_REGISTRANT_COUNT = 1;
36
+
37
+	/**
38
+	 * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration.
39
+	 * Initial status for registrations when they are first created
40
+	 * Payments are NOT allowed.
41
+	 * Automatically toggled to whatever the default Event registration status is upon completion of the attendee
42
+	 * information reg step NO space reserved. Registration is NOT active
43
+	 */
44
+	const status_id_incomplete = 'RIC';
45
+
46
+	/**
47
+	 * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration.
48
+	 * Payments are NOT allowed.
49
+	 * Event Admin must manually toggle STS_ID for it to change
50
+	 * No space reserved.
51
+	 * Registration is active
52
+	 */
53
+	const status_id_not_approved = 'RNA';
54
+
55
+	/**
56
+	 * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT .
57
+	 * Payments are allowed.
58
+	 * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
59
+	 * No space reserved.
60
+	 * Registration is active
61
+	 */
62
+	const status_id_pending_payment = 'RPP';
63
+
64
+	/**
65
+	 * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST .
66
+	 * Payments are allowed.
67
+	 * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
68
+	 * No space reserved.
69
+	 * Registration is active
70
+	 */
71
+	const status_id_wait_list = 'RWL';
72
+
73
+	/**
74
+	 * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration.
75
+	 * the TXN may or may not be completed ( paid in full )
76
+	 * Payments are allowed.
77
+	 * A space IS reserved.
78
+	 * Registration is active
79
+	 */
80
+	const status_id_approved = 'RAP';
81
+
82
+	/**
83
+	 * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee.
84
+	 * Payments are NOT allowed.
85
+	 * NO space reserved.
86
+	 * Registration is NOT active
87
+	 */
88
+	const status_id_cancelled = 'RCN';
89
+
90
+	/**
91
+	 * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin
92
+	 * Payments are NOT allowed.
93
+	 * No space reserved.
94
+	 * Registration is NOT active
95
+	 */
96
+	const status_id_declined = 'RDC';
97
+
98
+	/**
99
+	 * @var TableAnalysis $table_analysis
100
+	 */
101
+	protected $_table_analysis;
102
+
103
+
104
+
105
+	/**
106
+	 *    private constructor to prevent direct creation
107
+	 *
108
+	 * @Constructor
109
+	 * @access protected
110
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
111
+	 *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
112
+	 *                         date time model field objects.  Default is NULL (and will be assumed using the set
113
+	 *                         timezone in the 'timezone_string' wp option)
114
+	 */
115
+	protected function __construct($timezone = null)
116
+	{
117
+		$this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
118
+		$this->singular_item = __('Registration', 'event_espresso');
119
+		$this->plural_item = __('Registrations', 'event_espresso');
120
+		$this->_tables = array(
121
+			'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'),
122
+		);
123
+		$this->_fields = array(
124
+			'Registration' => array(
125
+				'REG_ID'           => new EE_Primary_Key_Int_Field('REG_ID', __('Registration ID', 'event_espresso')),
126
+				'EVT_ID'           => new EE_Foreign_Key_Int_Field('EVT_ID', __('Event ID', 'event_espresso'), false, 0,
127
+					'Event'),
128
+				'ATT_ID'           => new EE_Foreign_Key_Int_Field('ATT_ID', __('Attendee ID', 'event_espresso'), false,
129
+					0, 'Attendee'),
130
+				'TXN_ID'           => new EE_Foreign_Key_Int_Field('TXN_ID', __('Transaction ID', 'event_espresso'),
131
+					false, 0, 'Transaction'),
132
+				'TKT_ID'           => new EE_Foreign_Key_Int_Field('TKT_ID', __('Ticket ID', 'event_espresso'), false,
133
+					0, 'Ticket'),
134
+				'STS_ID'           => new EE_Foreign_Key_String_Field('STS_ID', __('Status ID', 'event_espresso'),
135
+					false, EEM_Registration::status_id_incomplete, 'Status'),
136
+				'REG_date'         => new EE_Datetime_Field('REG_date',
137
+					__('Time registration occurred', 'event_espresso'), false, EE_Datetime_Field::now, $timezone),
138
+				'REG_final_price'  => new EE_Money_Field('REG_final_price',
139
+					__('Registration\'s share of the transaction total', 'event_espresso'), false, 0),
140
+				'REG_paid'         => new EE_Money_Field('REG_paid',
141
+					__('Amount paid to date towards registration', 'event_espresso'), false, 0),
142
+				'REG_session'      => new EE_Plain_Text_Field('REG_session',
143
+					__('Session ID of registration', 'event_espresso'), false, ''),
144
+				'REG_code'         => new EE_Plain_Text_Field('REG_code',
145
+					__('Unique Code for this registration', 'event_espresso'), false, ''),
146
+				'REG_url_link'     => new EE_Plain_Text_Field('REG_url_link',
147
+					__('String to be used in URL for identifying registration', 'event_espresso'), false, ''),
148
+				'REG_count'        => new EE_Integer_Field('REG_count',
149
+					__('Count of this registration in the group registration ', 'event_espresso'), true, 1),
150
+				'REG_group_size'   => new EE_Integer_Field('REG_group_size',
151
+					__('Number of registrations on this group', 'event_espresso'), false, 1),
152
+				'REG_att_is_going' => new EE_Boolean_Field('REG_att_is_going',
153
+					__('Flag indicating the registrant plans on attending', 'event_espresso'), false, false),
154
+				'REG_deleted'      => new EE_Trashed_Flag_Field('REG_deleted',
155
+					__('Flag indicating if registration has been archived or not.', 'event_espresso'), false, false),
156
+			),
157
+		);
158
+		$this->_model_relations = array(
159
+			'Event'                => new EE_Belongs_To_Relation(),
160
+			'Attendee'             => new EE_Belongs_To_Relation(),
161
+			'Transaction'          => new EE_Belongs_To_Relation(),
162
+			'Ticket'               => new EE_Belongs_To_Relation(),
163
+			'Status'               => new EE_Belongs_To_Relation(),
164
+			'Answer'               => new EE_Has_Many_Relation(),
165
+			'Checkin'              => new EE_Has_Many_Relation(),
166
+			'Registration_Payment' => new EE_Has_Many_Relation(),
167
+			'Payment'              => new EE_HABTM_Relation('Registration_Payment'),
168
+			'Message'              => new EE_Has_Many_Any_Relation(false)
169
+			//allow deletes even if there are messages in the queue related
170
+		);
171
+		$this->_model_chain_to_wp_user = 'Event';
172
+		parent::__construct($timezone);
173
+	}
174
+
175
+
176
+
177
+	/**
178
+	 * reg_statuses_that_allow_payment
179
+	 * a filterable list of registration statuses that allow a registrant to make a payment
180
+	 *
181
+	 * @access public
182
+	 * @return array
183
+	 */
184
+	public static function reg_statuses_that_allow_payment()
185
+	{
186
+		return apply_filters('FHEE__EEM_Registration__reg_statuses_that_allow_payment', array(
187
+			EEM_Registration::status_id_approved,
188
+			EEM_Registration::status_id_pending_payment,
189
+			EEM_Registration::status_id_wait_list,
190
+		));
191
+	}
192
+
193
+
194
+
195
+	/**
196
+	 * inactive_reg_statuses
197
+	 * a filterable list of registration statuses that are considered active
198
+	 *
199
+	 * @access public
200
+	 * @return array
201
+	 */
202
+	public static function active_reg_statuses()
203
+	{
204
+		return apply_filters('FHEE__EEM_Registration__reg_statuses_that_allow_payment', array(
205
+			EEM_Registration::status_id_approved,
206
+			EEM_Registration::status_id_pending_payment,
207
+			EEM_Registration::status_id_wait_list,
208
+			EEM_Registration::status_id_not_approved,
209
+		));
210
+	}
211
+
212
+
213
+
214
+	/**
215
+	 * inactive_reg_statuses
216
+	 * a filterable list of registration statuses that are not considered active
217
+	 *
218
+	 * @access public
219
+	 * @return array
220
+	 */
221
+	public static function inactive_reg_statuses()
222
+	{
223
+		return apply_filters('FHEE__EEM_Registration__reg_statuses_that_allow_payment', array(
224
+			EEM_Registration::status_id_incomplete,
225
+			EEM_Registration::status_id_cancelled,
226
+			EEM_Registration::status_id_declined,
227
+		));
228
+	}
229
+
230
+
231
+
232
+	/**
233
+	 *    closed_reg_statuses
234
+	 *    a filterable list of registration statuses that are considered "closed"
235
+	 * meaning they should not be considered in any calculations involving monies owing
236
+	 *
237
+	 * @access public
238
+	 * @return array
239
+	 */
240
+	public static function closed_reg_statuses()
241
+	{
242
+		return apply_filters('FHEE__EEM_Registration__closed_reg_statuses', array(
243
+			EEM_Registration::status_id_cancelled,
244
+			EEM_Registration::status_id_declined,
245
+		));
246
+	}
247
+
248
+
249
+
250
+	/**
251
+	 *        get list of registration statuses
252
+	 *
253
+	 * @access public
254
+	 * @param array $exclude    The status ids to exclude from the returned results
255
+	 * @param bool  $translated If true will return the values as singular localized strings
256
+	 * @return array
257
+	 */
258
+	public static function reg_status_array($exclude = array(), $translated = false)
259
+	{
260
+		EEM_Registration::instance()->_get_registration_status_array($exclude);
261
+		return $translated ? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence')
262
+			: self::$_reg_status;
263
+	}
264
+
265
+
266
+
267
+	/**
268
+	 *    get list of registration statuses
269
+	 *
270
+	 * @access private
271
+	 * @param array $exclude
272
+	 * @return array
273
+	 */
274
+	private function _get_registration_status_array($exclude = array())
275
+	{
276
+		//in the very rare circumstance that we are deleting a model's table's data
277
+		//and the table hasn't actually been created, this could have an error
278
+		/** @type WPDB $wpdb */
279
+		global $wpdb;
280
+		if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
281
+			$SQL = 'SELECT STS_ID, STS_code FROM ' . $wpdb->prefix . 'esp_status WHERE STS_type = "registration"';
282
+			$results = $wpdb->get_results($SQL);
283
+			self::$_reg_status = array();
284
+			foreach ($results as $status) {
285
+				if ( ! in_array($status->STS_ID, $exclude)) {
286
+					self::$_reg_status[$status->STS_ID] = $status->STS_code;
287
+				}
288
+			}
289
+		}
290
+	}
291
+
292
+
293
+
294
+	/**
295
+	 * Gets the injected table analyzer, or throws an exception
296
+	 *
297
+	 * @return TableAnalysis
298
+	 * @throws \EE_Error
299
+	 */
300
+	protected function _get_table_analysis()
301
+	{
302
+		if ($this->_table_analysis instanceof TableAnalysis) {
303
+			return $this->_table_analysis;
304
+		} else {
305
+			throw new \EE_Error(sprintf(__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
306
+				get_class($this)));
307
+		}
308
+	}
309
+
310
+
311
+
312
+	/**
313
+	 * This returns a wpdb->results array of all registration date month and years matching the incoming query params
314
+	 * and grouped by month and year.
315
+	 *
316
+	 * @param  array $where_params Array of query_params as described in the comments for EEM_Base::get_all()
317
+	 * @return array
318
+	 * @throws \EE_Error
319
+	 */
320
+	public function get_reg_months_and_years($where_params)
321
+	{
322
+		$query_params[0] = $where_params;
323
+		$query_params['group_by'] = array('reg_year', 'reg_month');
324
+		$query_params['order_by'] = array('REG_date' => 'DESC');
325
+		$columns_to_select = array(
326
+			'reg_year'  => array('YEAR(REG_date)', '%s'),
327
+			'reg_month' => array('MONTHNAME(REG_date)', '%s'),
328
+		);
329
+		return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
330
+	}
331
+
332
+
333
+
334
+	/**
335
+	 *        retrieve ALL registrations for a particular Attendee from db
336
+	 *
337
+	 * @access        public
338
+	 * @param        int $ATT_ID
339
+	 * @return    EE_Registration[]
340
+	 */
341
+	public function get_all_registrations_for_attendee($ATT_ID = 0)
342
+	{
343
+		if ( ! $ATT_ID) {
344
+			return false;
345
+		}
346
+		return $this->get_all(array(array('ATT_ID' => $ATT_ID)));
347
+	}
348
+
349
+
350
+
351
+	/**
352
+	 * Gets a registration given their REG_url_link. Yes, this should usually
353
+	 * be passed via a GET parameter.
354
+	 *
355
+	 * @param string $REG_url_link
356
+	 * @return EE_Registration
357
+	 */
358
+	public function get_registration_for_reg_url_link($REG_url_link)
359
+	{
360
+		if ( ! $REG_url_link) {
361
+			return false;
362
+		}
363
+		return $this->get_one(array(array('REG_url_link' => $REG_url_link)));
364
+	}
365
+
366
+
367
+
368
+	/**
369
+	 *        retrieve registration for a specific transaction attendee from db
370
+	 *
371
+	 * @access        public
372
+	 * @param    int $TXN_ID
373
+	 * @param    int $ATT_ID
374
+	 * @param    int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the
375
+	 *                         attendee number is required
376
+	 * @return        mixed        array on success, FALSE on fail
377
+	 */
378
+	public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0)
379
+	{
380
+		return $this->get_one(array(
381
+			array(
382
+				'TXN_ID' => $TXN_ID,
383
+				'ATT_ID' => $ATT_ID,
384
+			),
385
+			'limit' => array(min(($att_nmbr - 1), 0), 1),
386
+		));
387
+	}
388
+
389
+
390
+
391
+	/**
392
+	 *        get the number of registrations per day  for the Registration Admin page Reports Tab.
393
+	 *        (doesn't utilize models because it's a fairly specialized query)
394
+	 *
395
+	 * @access        public
396
+	 * @param $period string which can be passed to php's strtotime function (eg "-1 month")
397
+	 * @return stdClass[] with properties regDate and total
398
+	 */
399
+	public function get_registrations_per_day_report($period = '-1 month')
400
+	{
401
+		$sql_date = $this->convert_datetime_for_query('REG_date', date("Y-m-d H:i:s", strtotime($period)),
402
+			'Y-m-d H:i:s', 'UTC');
403
+		$where = array(
404
+			'REG_date' => array('>=', $sql_date),
405
+			'STS_ID'   => array('!=', EEM_Registration::status_id_incomplete),
406
+		);
407
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
408
+			$where['Event.EVT_wp_user'] = get_current_user_id();
409
+		}
410
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
411
+		$results = $this->_get_all_wpdb_results(array(
412
+			$where,
413
+			'group_by' => 'regDate',
414
+			'order_by' => array('REG_date' => 'ASC'),
415
+		), OBJECT, array(
416
+			'regDate' => array('DATE(' . $query_interval . ')', '%s'),
417
+			'total'   => array('count(REG_ID)', '%d'),
418
+		));
419
+		return $results;
420
+	}
421
+
422
+
423
+
424
+	/**
425
+	 * Get the number of registrations per day including the count of registrations for each Registration Status.
426
+	 * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
427
+	 *
428
+	 * @param string $period
429
+	 * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID
430
+	 *                    (i.e. RAP)
431
+	 */
432
+	public function get_registrations_per_day_and_per_status_report($period = '-1 month')
433
+	{
434
+		global $wpdb;
435
+		$registration_table = $wpdb->prefix . 'esp_registration';
436
+		$event_table = $wpdb->posts;
437
+		$sql_date = date("Y-m-d H:i:s", strtotime($period));
438
+		//prepare the query interval for displaying offset
439
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date');
440
+		//inner date query
441
+		$inner_date_query = "SELECT DISTINCT REG_date from $registration_table ";
442
+		$inner_where = " WHERE";
443
+		//exclude events not authored by user if permissions in effect
444
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
445
+			$inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
446
+			$inner_where .= " post_author = " . get_current_user_id() . " AND";
447
+		}
448
+		$inner_where .= " REG_date >= '$sql_date'";
449
+		$inner_date_query .= $inner_where;
450
+		//start main query
451
+		$select = "SELECT DATE($query_interval) as Registration_REG_date, ";
452
+		$join = '';
453
+		$join_parts = array();
454
+		$select_parts = array();
455
+		//loop through registration stati to do parts for each status.
456
+		foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
457
+			if ($STS_ID === EEM_Registration::status_id_incomplete) {
458
+				continue;
459
+			}
460
+			$select_parts[] = "COUNT($STS_code.REG_ID) as $STS_ID";
461
+			$join_parts[] = "$registration_table AS $STS_code ON $STS_code.REG_date = dates.REG_date AND $STS_code.STS_ID = '$STS_ID'";
462
+		}
463
+		//setup the selects
464
+		$select .= implode(', ', $select_parts);
465
+		$select .= " FROM ($inner_date_query) AS dates LEFT JOIN ";
466
+		//setup the joins
467
+		$join .= implode(" LEFT JOIN ", $join_parts);
468
+		//now let's put it all together
469
+		$query = $select . $join . ' GROUP BY Registration_REG_date';
470
+		//and execute it
471
+		$results = $wpdb->get_results($query, ARRAY_A);
472
+		return $results;
473
+	}
474
+
475
+
476
+
477
+	/**
478
+	 *        get the number of registrations per event  for the Registration Admin page Reports Tab
479
+	 *
480
+	 * @access        public
481
+	 * @param $period string which can be passed to php's strtotime function (eg "-1 month")
482
+	 * @return stdClass[] each with properties event_name, reg_limit, and total
483
+	 */
484
+	public function get_registrations_per_event_report($period = '-1 month')
485
+	{
486
+		$date_sql = $this->convert_datetime_for_query('REG_date', date("Y-m-d H:i:s", strtotime($period)),
487
+			'Y-m-d H:i:s', 'UTC');
488
+		$where = array(
489
+			'REG_date' => array('>=', $date_sql),
490
+			'STS_ID'   => array('!=', EEM_Registration::status_id_incomplete),
491
+		);
492
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
493
+			$where['Event.EVT_wp_user'] = get_current_user_id();
494
+		}
495
+		$results = $this->_get_all_wpdb_results(array(
496
+			$where,
497
+			'group_by' => 'Event.EVT_name',
498
+			'order_by' => 'Event.EVT_name',
499
+			'limit'    => array(0, 24),
500
+		), OBJECT, array(
501
+			'event_name' => array('Event_CPT.post_title', '%s'),
502
+			'total'      => array('COUNT(REG_ID)', '%s'),
503
+		));
504
+		return $results;
505
+	}
506
+
507
+
508
+
509
+	/**
510
+	 * Get the number of registrations per event grouped by registration status.
511
+	 * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
512
+	 *
513
+	 * @param string $period
514
+	 * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID
515
+	 *                    (i.e. RAP)
516
+	 */
517
+	public function get_registrations_per_event_and_per_status_report($period = '-1 month')
518
+	{
519
+		global $wpdb;
520
+		$registration_table = $wpdb->prefix . 'esp_registration';
521
+		$event_table = $wpdb->posts;
522
+		$sql_date = date("Y-m-d H:i:s", strtotime($period));
523
+		//inner date query
524
+		$inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
525
+		$inner_where = " WHERE";
526
+		//exclude events not authored by user if permissions in effect
527
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
528
+			$inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
529
+			$inner_where .= " post_author = " . get_current_user_id() . " AND";
530
+		}
531
+		$inner_where .= " REG_date >= '$sql_date'";
532
+		$inner_date_query .= $inner_where;
533
+		//build main query
534
+		$select = "SELECT Event.post_title as Registration_Event, ";
535
+		$join = '';
536
+		$join_parts = array();
537
+		$select_parts = array();
538
+		//loop through registration stati to do parts for each status.
539
+		foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
540
+			if ($STS_ID === EEM_Registration::status_id_incomplete) {
541
+				continue;
542
+			}
543
+			$select_parts[] = "COUNT($STS_code.REG_ID) as $STS_ID";
544
+			$join_parts[] = "$registration_table AS $STS_code ON $STS_code.EVT_ID = dates.EVT_ID AND $STS_code.STS_ID = '$STS_ID' AND $STS_code.REG_date = dates.REG_date";
545
+		}
546
+		//setup the selects
547
+		$select .= implode(', ', $select_parts);
548
+		$select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN ";
549
+		//setup remaining joins
550
+		$join .= implode(" LEFT JOIN ", $join_parts);
551
+		//now put it all together
552
+		$query = $select . $join . ' GROUP BY Registration_Event';
553
+		//and execute
554
+		$results = $wpdb->get_results($query, ARRAY_A);
555
+		return $results;
556
+	}
557
+
558
+
559
+
560
+	/**
561
+	 * Returns the EE_Registration of the primary attendee on the transaction id provided
562
+	 *
563
+	 * @param int $TXN_ID
564
+	 * @return EE_Registration
565
+	 */
566
+	public function get_primary_registration_for_transaction_ID($TXN_ID = 0)
567
+	{
568
+		if ( ! $TXN_ID) {
569
+			return false;
570
+		}
571
+		return $this->get_one(array(
572
+			array(
573
+				'TXN_ID'    => $TXN_ID,
574
+				'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT,
575
+			),
576
+		));
577
+	}
578
+
579
+
580
+
581
+	/**
582
+	 *        get_event_registration_count
583
+	 *
584
+	 * @access public
585
+	 * @param int     $EVT_ID
586
+	 * @param boolean $for_incomplete_payments
587
+	 * @return int
588
+	 */
589
+	public function get_event_registration_count($EVT_ID, $for_incomplete_payments = false)
590
+	{
591
+		// we only count approved registrations towards registration limits
592
+		$query_params = array(array('EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved));
593
+		if ($for_incomplete_payments) {
594
+			$query_params[0]['Transaction.STS_ID'] = array('!=', EEM_Transaction::complete_status_code);
595
+		}
596
+		return $this->count($query_params);
597
+	}
598
+
599
+
600
+
601
+	/**
602
+	 * Deletes all registrations with no transactions. Note that this needs to be very efficient
603
+	 * and so it uses wpdb directly
604
+	 *
605
+	 * @global WPDB $wpdb
606
+	 * @return int number deleted
607
+	 */
608
+	public function delete_registrations_with_no_transaction()
609
+	{
610
+		/** @type WPDB $wpdb */
611
+		global $wpdb;
612
+		return $wpdb->query('DELETE r FROM '
613
+							. $this->table()
614
+							. ' r LEFT JOIN '
615
+							. EEM_Transaction::instance()->table()
616
+							. ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL');
617
+	}
618
+
619
+
620
+
621
+	/**
622
+	 *  Count registrations checked into (or out of) a datetime
623
+	 *
624
+	 * @param int     $DTT_ID     datetime ID
625
+	 * @param boolean $checked_in whether to count registrations checked IN or OUT
626
+	 * @return int
627
+	 */
628
+	public function count_registrations_checked_into_datetime($DTT_ID, $checked_in = true)
629
+	{
630
+		global $wpdb;
631
+		//subquery to get latest checkin
632
+		$query = $wpdb->prepare('SELECT '
633
+								. 'COUNT( DISTINCT checkins.REG_ID ) '
634
+								. 'FROM '
635
+								. EEM_Checkin::instance()
636
+											 ->table()
637
+								. ' AS checkins INNER JOIN'
638
+								. '( SELECT '
639
+								. 'max( CHK_timestamp ) AS latest_checkin, '
640
+								. 'REG_ID AS REG_ID '
641
+								. 'FROM '
642
+								. EEM_Checkin::instance()->table()
643
+								. ' '
644
+								. 'WHERE DTT_ID=%d '
645
+								. 'GROUP BY REG_ID'
646
+								. ') AS most_recent_checkin_per_reg '
647
+								. 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
648
+								. 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
649
+								. 'WHERE '
650
+								. 'checkins.CHK_in=%d', $DTT_ID, $checked_in);
651
+		return (int)$wpdb->get_var($query);
652
+	}
653
+
654
+
655
+
656
+	/**
657
+	 *  Count registrations checked into (or out of) an event.
658
+	 *
659
+	 * @param int     $EVT_ID     event ID
660
+	 * @param boolean $checked_in whether to count registrations checked IN or OUT
661
+	 * @return int
662
+	 */
663
+	public function count_registrations_checked_into_event($EVT_ID, $checked_in = true)
664
+	{
665
+		global $wpdb;
666
+		//subquery to get latest checkin
667
+		$query = $wpdb->prepare('SELECT '
668
+								. 'COUNT( DISTINCT checkins.REG_ID ) '
669
+								. 'FROM '
670
+								. EEM_Checkin::instance()
671
+											 ->table()
672
+								. ' AS checkins INNER JOIN'
673
+								. '( SELECT '
674
+								. 'max( CHK_timestamp ) AS latest_checkin, '
675
+								. 'REG_ID AS REG_ID '
676
+								. 'FROM '
677
+								. EEM_Checkin::instance()->table()
678
+								. ' AS c '
679
+								. 'INNER JOIN '
680
+								. EEM_Datetime::instance()->table()
681
+								. ' AS d '
682
+								. 'ON c.DTT_ID=d.DTT_ID '
683
+								. 'WHERE d.EVT_ID=%d '
684
+								. 'GROUP BY REG_ID'
685
+								. ') AS most_recent_checkin_per_reg '
686
+								. 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
687
+								. 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
688
+								. 'WHERE '
689
+								. 'checkins.CHK_in=%d', $EVT_ID, $checked_in);
690
+		return (int)$wpdb->get_var($query);
691
+	}
692
+
693
+
694
+
695
+	/**
696
+	 * The purpose of this method is to retrieve an array of
697
+	 * EE_Registration objects that represent the latest registration
698
+	 * for each ATT_ID given in the function argument.
699
+	 *
700
+	 * @param array $attendee_ids
701
+	 * @return EE_Registration[]
702
+	 */
703
+	public function get_latest_registration_for_each_of_given_contacts($attendee_ids = array())
704
+	{
705
+		//first do a native wp_query to get the latest REG_ID's matching these attendees.
706
+		global $wpdb;
707
+		$registration_table = $wpdb->prefix . 'esp_registration';
708
+		$attendee_table = $wpdb->posts;
709
+		$attendee_ids = is_array($attendee_ids) ? array_map('absint', $attendee_ids) : array((int)$attendee_ids);
710
+		$attendee_ids = implode(',', $attendee_ids);
711
+		//first we do a query to get the registration ids
712
+		// (because a group by before order by causes the order by to be ignored.)
713
+		$registration_id_query = "
714 714
 			SELECT registrations.registration_ids as registration_id
715 715
 			FROM (
716 716
 				SELECT
@@ -724,23 +724,23 @@  discard block
 block discarded – undo
724 724
 			  ) AS registrations
725 725
 			  GROUP BY registrations.attendee_ids
726 726
 		";
727
-        $registration_ids = $wpdb->get_results($registration_id_query, ARRAY_A);
728
-        if (empty($registration_ids)) {
729
-            return array();
730
-        }
731
-        $ids_for_model_query = array();
732
-        //let's flatten the ids so they can be used in the model query.
733
-        foreach ($registration_ids as $registration_id) {
734
-            if (isset($registration_id['registration_id'])) {
735
-                $ids_for_model_query[] = $registration_id['registration_id'];
736
-            }
737
-        }
738
-        //construct query
739
-        $_where = array(
740
-            'REG_ID' => array('IN', $ids_for_model_query),
741
-        );
742
-        return $this->get_all(array($_where));
743
-    }
727
+		$registration_ids = $wpdb->get_results($registration_id_query, ARRAY_A);
728
+		if (empty($registration_ids)) {
729
+			return array();
730
+		}
731
+		$ids_for_model_query = array();
732
+		//let's flatten the ids so they can be used in the model query.
733
+		foreach ($registration_ids as $registration_id) {
734
+			if (isset($registration_id['registration_id'])) {
735
+				$ids_for_model_query[] = $registration_id['registration_id'];
736
+			}
737
+		}
738
+		//construct query
739
+		$_where = array(
740
+			'REG_ID' => array('IN', $ids_for_model_query),
741
+		);
742
+		return $this->get_all(array($_where));
743
+	}
744 744
 
745 745
 
746 746
 
Please login to merge, or discard this patch.
Spacing   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -277,8 +277,8 @@  discard block
 block discarded – undo
277 277
         //and the table hasn't actually been created, this could have an error
278 278
         /** @type WPDB $wpdb */
279 279
         global $wpdb;
280
-        if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
281
-            $SQL = 'SELECT STS_ID, STS_code FROM ' . $wpdb->prefix . 'esp_status WHERE STS_type = "registration"';
280
+        if ($this->_get_table_analysis()->tableExists($wpdb->prefix.'esp_status')) {
281
+            $SQL = 'SELECT STS_ID, STS_code FROM '.$wpdb->prefix.'esp_status WHERE STS_type = "registration"';
282 282
             $results = $wpdb->get_results($SQL);
283 283
             self::$_reg_status = array();
284 284
             foreach ($results as $status) {
@@ -413,7 +413,7 @@  discard block
 block discarded – undo
413 413
             'group_by' => 'regDate',
414 414
             'order_by' => array('REG_date' => 'ASC'),
415 415
         ), OBJECT, array(
416
-            'regDate' => array('DATE(' . $query_interval . ')', '%s'),
416
+            'regDate' => array('DATE('.$query_interval.')', '%s'),
417 417
             'total'   => array('count(REG_ID)', '%d'),
418 418
         ));
419 419
         return $results;
@@ -432,7 +432,7 @@  discard block
 block discarded – undo
432 432
     public function get_registrations_per_day_and_per_status_report($period = '-1 month')
433 433
     {
434 434
         global $wpdb;
435
-        $registration_table = $wpdb->prefix . 'esp_registration';
435
+        $registration_table = $wpdb->prefix.'esp_registration';
436 436
         $event_table = $wpdb->posts;
437 437
         $sql_date = date("Y-m-d H:i:s", strtotime($period));
438 438
         //prepare the query interval for displaying offset
@@ -443,7 +443,7 @@  discard block
 block discarded – undo
443 443
         //exclude events not authored by user if permissions in effect
444 444
         if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
445 445
             $inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
446
-            $inner_where .= " post_author = " . get_current_user_id() . " AND";
446
+            $inner_where .= " post_author = ".get_current_user_id()." AND";
447 447
         }
448 448
         $inner_where .= " REG_date >= '$sql_date'";
449 449
         $inner_date_query .= $inner_where;
@@ -466,7 +466,7 @@  discard block
 block discarded – undo
466 466
         //setup the joins
467 467
         $join .= implode(" LEFT JOIN ", $join_parts);
468 468
         //now let's put it all together
469
-        $query = $select . $join . ' GROUP BY Registration_REG_date';
469
+        $query = $select.$join.' GROUP BY Registration_REG_date';
470 470
         //and execute it
471 471
         $results = $wpdb->get_results($query, ARRAY_A);
472 472
         return $results;
@@ -517,7 +517,7 @@  discard block
 block discarded – undo
517 517
     public function get_registrations_per_event_and_per_status_report($period = '-1 month')
518 518
     {
519 519
         global $wpdb;
520
-        $registration_table = $wpdb->prefix . 'esp_registration';
520
+        $registration_table = $wpdb->prefix.'esp_registration';
521 521
         $event_table = $wpdb->posts;
522 522
         $sql_date = date("Y-m-d H:i:s", strtotime($period));
523 523
         //inner date query
@@ -526,7 +526,7 @@  discard block
 block discarded – undo
526 526
         //exclude events not authored by user if permissions in effect
527 527
         if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
528 528
             $inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
529
-            $inner_where .= " post_author = " . get_current_user_id() . " AND";
529
+            $inner_where .= " post_author = ".get_current_user_id()." AND";
530 530
         }
531 531
         $inner_where .= " REG_date >= '$sql_date'";
532 532
         $inner_date_query .= $inner_where;
@@ -549,7 +549,7 @@  discard block
 block discarded – undo
549 549
         //setup remaining joins
550 550
         $join .= implode(" LEFT JOIN ", $join_parts);
551 551
         //now put it all together
552
-        $query = $select . $join . ' GROUP BY Registration_Event';
552
+        $query = $select.$join.' GROUP BY Registration_Event';
553 553
         //and execute
554 554
         $results = $wpdb->get_results($query, ARRAY_A);
555 555
         return $results;
@@ -648,7 +648,7 @@  discard block
 block discarded – undo
648 648
                                 . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
649 649
                                 . 'WHERE '
650 650
                                 . 'checkins.CHK_in=%d', $DTT_ID, $checked_in);
651
-        return (int)$wpdb->get_var($query);
651
+        return (int) $wpdb->get_var($query);
652 652
     }
653 653
 
654 654
 
@@ -687,7 +687,7 @@  discard block
 block discarded – undo
687 687
                                 . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
688 688
                                 . 'WHERE '
689 689
                                 . 'checkins.CHK_in=%d', $EVT_ID, $checked_in);
690
-        return (int)$wpdb->get_var($query);
690
+        return (int) $wpdb->get_var($query);
691 691
     }
692 692
 
693 693
 
@@ -704,9 +704,9 @@  discard block
 block discarded – undo
704 704
     {
705 705
         //first do a native wp_query to get the latest REG_ID's matching these attendees.
706 706
         global $wpdb;
707
-        $registration_table = $wpdb->prefix . 'esp_registration';
707
+        $registration_table = $wpdb->prefix.'esp_registration';
708 708
         $attendee_table = $wpdb->posts;
709
-        $attendee_ids = is_array($attendee_ids) ? array_map('absint', $attendee_ids) : array((int)$attendee_ids);
709
+        $attendee_ids = is_array($attendee_ids) ? array_map('absint', $attendee_ids) : array((int) $attendee_ids);
710 710
         $attendee_ids = implode(',', $attendee_ids);
711 711
         //first we do a query to get the registration ids
712 712
         // (because a group by before order by causes the order by to be ignored.)
Please login to merge, or discard this patch.
core/libraries/batch/JobHandlers/RegistrationsReport.php 2 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -418,7 +418,7 @@
 block discarded – undo
418 418
      * In this case, we delete the temporary file
419 419
      *
420 420
      * @param JobParameters $job_parameters
421
-     * @return boolean
421
+     * @return JobStepResponse
422 422
      */
423 423
     public function cleanup_job(JobParameters $job_parameters)
424 424
     {
Please login to merge, or discard this patch.
Indentation   +385 added lines, -385 removed lines patch added patch discarded remove patch
@@ -17,7 +17,7 @@  discard block
 block discarded – undo
17 17
 use EventEspressoBatchRequest\Helpers\JobStepResponse;
18 18
 
19 19
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
20
-    exit('No direct script access allowed');
20
+	exit('No direct script access allowed');
21 21
 }
22 22
 
23 23
 
@@ -25,408 +25,408 @@  discard block
 block discarded – undo
25 25
 class RegistrationsReport extends JobHandlerFile
26 26
 {
27 27
 
28
-    /**
29
-     * Performs any necessary setup for starting the job. This is also a good
30
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
31
-     * when continue_job will be called
32
-     *
33
-     * @param JobParameters $job_parameters
34
-     * @throws BatchRequestException
35
-     * @return JobStepResponse
36
-     */
37
-    public function create_job(JobParameters $job_parameters)
38
-    {
39
-        $event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
40
-        if ( ! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
41
-            throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso'));
42
-        }
43
-        $filepath = $this->create_file_from_job_with_name($job_parameters->job_id(),
44
-            $this->get_filename_from_event($event_id));
45
-        $job_parameters->add_extra_data('filepath', $filepath);
46
-        $question_data_for_columns = $this->_get_questions_for_report($event_id);
47
-        $job_parameters->add_extra_data('questions_data', $question_data_for_columns);
48
-        $job_parameters->set_job_size($this->count_units_to_process($event_id));
49
-        //we should also set the header columns
50
-        $csv_data_for_row = $this->get_csv_data_for($event_id, 0, 1, $job_parameters->extra_datum('questions_data'));
51
-        \EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
52
-        //if we actually processed a row there, record it
53
-        if ($job_parameters->job_size()) {
54
-            $job_parameters->mark_processed(1);
55
-        }
56
-        return new JobStepResponse($job_parameters,
57
-            __('Registrations report started successfully...', 'event_espresso'));
58
-    }
28
+	/**
29
+	 * Performs any necessary setup for starting the job. This is also a good
30
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
31
+	 * when continue_job will be called
32
+	 *
33
+	 * @param JobParameters $job_parameters
34
+	 * @throws BatchRequestException
35
+	 * @return JobStepResponse
36
+	 */
37
+	public function create_job(JobParameters $job_parameters)
38
+	{
39
+		$event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
40
+		if ( ! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
41
+			throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso'));
42
+		}
43
+		$filepath = $this->create_file_from_job_with_name($job_parameters->job_id(),
44
+			$this->get_filename_from_event($event_id));
45
+		$job_parameters->add_extra_data('filepath', $filepath);
46
+		$question_data_for_columns = $this->_get_questions_for_report($event_id);
47
+		$job_parameters->add_extra_data('questions_data', $question_data_for_columns);
48
+		$job_parameters->set_job_size($this->count_units_to_process($event_id));
49
+		//we should also set the header columns
50
+		$csv_data_for_row = $this->get_csv_data_for($event_id, 0, 1, $job_parameters->extra_datum('questions_data'));
51
+		\EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
52
+		//if we actually processed a row there, record it
53
+		if ($job_parameters->job_size()) {
54
+			$job_parameters->mark_processed(1);
55
+		}
56
+		return new JobStepResponse($job_parameters,
57
+			__('Registrations report started successfully...', 'event_espresso'));
58
+	}
59 59
 
60 60
 
61 61
 
62
-    /**
63
-     * Creates teh filename form the event id (or lack thereof)
64
-     *
65
-     * @param int $event_id
66
-     * @return string
67
-     */
68
-    protected function get_filename_from_event($event_id)
69
-    {
70
-        if ($event_id) {
71
-            $event_slug = \EEM_Event::instance()->get_var(array(array('EVT_ID' => $event_id)), 'EVT_slug');
72
-            if ( ! $event_slug) {
73
-                $event_slug = __('unknown', 'event_espresso');
74
-            }
75
-        } else {
76
-            $event_slug = __('all', 'event_espresso');
77
-        }
78
-        return sprintf("registrations-for-%s.csv", $event_slug);
79
-    }
62
+	/**
63
+	 * Creates teh filename form the event id (or lack thereof)
64
+	 *
65
+	 * @param int $event_id
66
+	 * @return string
67
+	 */
68
+	protected function get_filename_from_event($event_id)
69
+	{
70
+		if ($event_id) {
71
+			$event_slug = \EEM_Event::instance()->get_var(array(array('EVT_ID' => $event_id)), 'EVT_slug');
72
+			if ( ! $event_slug) {
73
+				$event_slug = __('unknown', 'event_espresso');
74
+			}
75
+		} else {
76
+			$event_slug = __('all', 'event_espresso');
77
+		}
78
+		return sprintf("registrations-for-%s.csv", $event_slug);
79
+	}
80 80
 
81 81
 
82 82
 
83
-    /**
84
-     * Gets the questions which are to be used for this report, so they
85
-     * can be remembered for later
86
-     *
87
-     * @param int|null $event_id
88
-     * @return array of wpdb results for questions which are to be used for this report
89
-     */
90
-    protected function _get_questions_for_report($event_id)
91
-    {
92
-        $question_query_params = array(
93
-            array(
94
-                'Answer.ANS_ID' => array('IS_NOT_NULL'),
95
-            ),
96
-            'group_by' => array('QST_ID'),
97
-        );
98
-        if ($event_id) {
99
-            $question_query_params[0]['Answer.Registration.EVT_ID'] = $event_id;
100
-        }
101
-        return \EEM_Question::instance()->get_all_wpdb_results($question_query_params);
102
-    }
83
+	/**
84
+	 * Gets the questions which are to be used for this report, so they
85
+	 * can be remembered for later
86
+	 *
87
+	 * @param int|null $event_id
88
+	 * @return array of wpdb results for questions which are to be used for this report
89
+	 */
90
+	protected function _get_questions_for_report($event_id)
91
+	{
92
+		$question_query_params = array(
93
+			array(
94
+				'Answer.ANS_ID' => array('IS_NOT_NULL'),
95
+			),
96
+			'group_by' => array('QST_ID'),
97
+		);
98
+		if ($event_id) {
99
+			$question_query_params[0]['Answer.Registration.EVT_ID'] = $event_id;
100
+		}
101
+		return \EEM_Question::instance()->get_all_wpdb_results($question_query_params);
102
+	}
103 103
 
104 104
 
105 105
 
106
-    /**
107
-     * Performs another step of the job
108
-     *
109
-     * @param JobParameters $job_parameters
110
-     * @param int           $batch_size
111
-     * @return JobStepResponse
112
-     * @throws \EE_Error
113
-     */
114
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
115
-    {
116
-        $csv_data = $this->get_csv_data_for($job_parameters->request_datum('EVT_ID', '0'),
117
-            $job_parameters->units_processed(), $batch_size, $job_parameters->extra_datum('questions_data'));
118
-        \EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
119
-        $units_processed = count($csv_data);
120
-        $job_parameters->mark_processed($units_processed);
121
-        $extra_response_data = array(
122
-            'file_url' => '',
123
-        );
124
-        if ($units_processed < $batch_size) {
125
-            $job_parameters->set_status(JobParameters::status_complete);
126
-            $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
127
-        }
128
-        return new JobStepResponse($job_parameters,
129
-            sprintf(__('Wrote %1$s rows to report CSV file...', 'event_espresso'), count($csv_data)),
130
-            $extra_response_data);
131
-    }
106
+	/**
107
+	 * Performs another step of the job
108
+	 *
109
+	 * @param JobParameters $job_parameters
110
+	 * @param int           $batch_size
111
+	 * @return JobStepResponse
112
+	 * @throws \EE_Error
113
+	 */
114
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
115
+	{
116
+		$csv_data = $this->get_csv_data_for($job_parameters->request_datum('EVT_ID', '0'),
117
+			$job_parameters->units_processed(), $batch_size, $job_parameters->extra_datum('questions_data'));
118
+		\EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
119
+		$units_processed = count($csv_data);
120
+		$job_parameters->mark_processed($units_processed);
121
+		$extra_response_data = array(
122
+			'file_url' => '',
123
+		);
124
+		if ($units_processed < $batch_size) {
125
+			$job_parameters->set_status(JobParameters::status_complete);
126
+			$extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
127
+		}
128
+		return new JobStepResponse($job_parameters,
129
+			sprintf(__('Wrote %1$s rows to report CSV file...', 'event_espresso'), count($csv_data)),
130
+			$extra_response_data);
131
+	}
132 132
 
133 133
 
134 134
 
135
-    /**
136
-     * Gets the csv data for a batch of registrations
137
-     *
138
-     * @param int|null $event_id
139
-     * @param int      $offset
140
-     * @param int      $limit
141
-     * @param array    $questions_for_these_regs_rows results of $wpdb->get_results( $something, ARRAY_A) when querying
142
-     *                                                for questions
143
-     * @return array top-level keys are numeric, next-level keys are column headers
144
-     */
145
-    function get_csv_data_for($event_id, $offset, $limit, $questions_for_these_regs_rows)
146
-    {
147
-        $reg_fields_to_include = array(
148
-            'TXN_ID',
149
-            'ATT_ID',
150
-            'REG_ID',
151
-            'REG_date',
152
-            'REG_code',
153
-            'REG_count',
154
-            'REG_final_price',
155
-        );
156
-        $att_fields_to_include = array(
157
-            'ATT_fname',
158
-            'ATT_lname',
159
-            'ATT_email',
160
-            'ATT_address',
161
-            'ATT_address2',
162
-            'ATT_city',
163
-            'STA_ID',
164
-            'CNT_ISO',
165
-            'ATT_zip',
166
-            'ATT_phone',
167
-        );
168
-        $registrations_csv_ready_array = array();
169
-        $reg_model = \EE_Registry::instance()->load_model('Registration');
170
-        $query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array(
171
-                array(
172
-                    'OR'                 => array(
173
-                        //don't include registrations from failed or abandoned transactions...
174
-                        'Transaction.STS_ID' => array(
175
-                            'NOT IN',
176
-                            array(
177
-                                \EEM_Transaction::failed_status_code,
178
-                                \EEM_Transaction::abandoned_status_code,
179
-                            ),
180
-                        ),
181
-                        //unless the registration is approved, in which case include it regardless of transaction status
182
-                        'STS_ID'             => \EEM_Registration::status_id_approved,
183
-                    ),
184
-                    'Ticket.TKT_deleted' => array('IN', array(true, false)),
185
-                ),
186
-                'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
187
-                'force_join' => array('Transaction', 'Ticket', 'Attendee'),
188
-                'limit'      => array($offset, $limit),
189
-                'caps'       => \EEM_Base::caps_read_admin,
190
-            ), $event_id);
191
-        if ($event_id) {
192
-            $query_params[0]['EVT_ID'] = $event_id;
193
-        } else {
194
-            $query_params['force_join'][] = 'Event';
195
-        }
196
-        $registration_rows = $reg_model->get_all_wpdb_results($query_params);
197
-        //get all questions which relate to someone in this group
198
-        $registration_ids = array();
199
-        foreach ($registration_rows as $reg_row) {
200
-            $registration_ids[] = intval($reg_row['Registration.REG_ID']);
201
-        }
202
-        foreach ($registration_rows as $reg_row) {
203
-            if (is_array($reg_row)) {
204
-                $reg_csv_array = array();
205
-                if ( ! $event_id) {
206
-                    //get the event's name and Id
207
-                    $reg_csv_array[__('Event', 'event_espresso')] = sprintf(__('%1$s (%2$s)', 'event_espresso'),
208
-                        \EEH_Export::prepare_value_from_db_for_display(\EEM_Event::instance(), 'EVT_name',
209
-                            $reg_row['Event_CPT.post_title']), $reg_row['Event_CPT.ID']);
210
-                }
211
-                $is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
212
-                /*@var $reg_row EE_Registration */
213
-                foreach ($reg_fields_to_include as $field_name) {
214
-                    $field = $reg_model->field_settings_for($field_name);
215
-                    if ($field_name == 'REG_final_price') {
216
-                        $value = \EEH_Export::prepare_value_from_db_for_display($reg_model, $field_name,
217
-                            $reg_row['Registration.REG_final_price'], 'localized_float');
218
-                    } elseif ($field_name == 'REG_count') {
219
-                        $value = sprintf(__('%s of %s', 'event_espresso'),
220
-                            \EEH_Export::prepare_value_from_db_for_display($reg_model, 'REG_count',
221
-                                $reg_row['Registration.REG_count']),
222
-                            \EEH_Export::prepare_value_from_db_for_display($reg_model, 'REG_group_size',
223
-                                $reg_row['Registration.REG_group_size']));
224
-                    } elseif ($field_name == 'REG_date') {
225
-                        $value = \EEH_Export::prepare_value_from_db_for_display($reg_model, $field_name,
226
-                            $reg_row['Registration.REG_date'], 'no_html');
227
-                    } else {
228
-                        $value = \EEH_Export::prepare_value_from_db_for_display($reg_model, $field_name,
229
-                            $reg_row[$field->get_qualified_column()]);
230
-                    }
231
-                    $reg_csv_array[\EEH_Export::get_column_name_for_field($field)] = $value;
232
-                    if ($field_name == 'REG_final_price') {
233
-                        //add a column named Currency after the final price
234
-                        $reg_csv_array[__("Currency", "event_espresso")] = \EE_Config::instance()->currency->code;
235
-                    }
236
-                }
237
-                //get pretty status
238
-                $stati = \EEM_Status::instance()->localized_status(array(
239
-                    $reg_row['Registration.STS_ID']     => __('unknown', 'event_espresso'),
240
-                    $reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso'),
241
-                ), false, 'sentence');
242
-                $reg_csv_array[__("Registration Status", 'event_espresso')] = $stati[$reg_row['Registration.STS_ID']];
243
-                //get pretty transaction status
244
-                $reg_csv_array[__("Transaction Status",
245
-                    'event_espresso')] = $stati[$reg_row['TransactionTable.STS_ID']];
246
-                $reg_csv_array[__('Transaction Amount Due', 'event_espresso')] = $is_primary_reg
247
-                    ? \EEH_Export::prepare_value_from_db_for_display(\EEM_Transaction::instance(), 'TXN_total',
248
-                        $reg_row['TransactionTable.TXN_total'], 'localized_float') : '0.00';
249
-                $reg_csv_array[__('Amount Paid', 'event_espresso')] = $is_primary_reg
250
-                    ? \EEH_Export::prepare_value_from_db_for_display(\EEM_Transaction::instance(), 'TXN_paid',
251
-                        $reg_row['TransactionTable.TXN_paid'], 'localized_float') : '0.00';
252
-                $payment_methods = array();
253
-                $gateway_txn_ids_etc = array();
254
-                $payment_times = array();
255
-                if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
256
-                    $payments_info = \EEM_Payment::instance()->get_all_wpdb_results(array(
257
-                        array(
258
-                            'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
259
-                            'STS_ID' => \EEM_Payment::status_id_approved,
260
-                        ),
261
-                        'force_join' => array('Payment_Method'),
262
-                    ), ARRAY_A,
263
-                        'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time');
264
-                    foreach ($payments_info as $payment_method_and_gateway_txn_id) {
265
-                        $payment_methods[] = isset($payment_method_and_gateway_txn_id['name'])
266
-                            ? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso');
267
-                        $gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id'])
268
-                            ? $payment_method_and_gateway_txn_id['gateway_txn_id'] : '';
269
-                        $payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time'])
270
-                            ? $payment_method_and_gateway_txn_id['payment_time'] : '';
271
-                    }
272
-                }
273
-                $reg_csv_array[__('Payment Date(s)', 'event_espresso')] = implode(',', $payment_times);
274
-                $reg_csv_array[__('Payment Method(s)', 'event_espresso')] = implode(",", $payment_methods);
275
-                $reg_csv_array[__('Gateway Transaction ID(s)', 'event_espresso')] = implode(',', $gateway_txn_ids_etc);
276
-                //get whether or not the user has checked in
277
-                $reg_csv_array[__("Check-Ins",
278
-                    "event_espresso")] = $reg_model->count_related($reg_row['Registration.REG_ID'], 'Checkin');
279
-                //get ticket of registration and its price
280
-                $ticket_model = \EE_Registry::instance()->load_model('Ticket');
281
-                if ($reg_row['Ticket.TKT_ID']) {
282
-                    $ticket_name = \EEH_Export::prepare_value_from_db_for_display($ticket_model, 'TKT_name',
283
-                        $reg_row['Ticket.TKT_name']);
284
-                    $datetimes_strings = array();
285
-                    foreach (
286
-                        \EEM_Datetime::instance()
287
-                                     ->get_all_wpdb_results(array(
288
-                                         array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']),
289
-                                         'order_by'                 => array('DTT_EVT_start' => 'ASC'),
290
-                                         'default_where_conditions' => 'none',
291
-                                     )) as $datetime
292
-                    ) {
293
-                        $datetimes_strings[] = \EEH_Export::prepare_value_from_db_for_display(\EEM_Datetime::instance(),
294
-                            'DTT_EVT_start', $datetime['Datetime.DTT_EVT_start']);
295
-                    }
296
-                } else {
297
-                    $ticket_name = __('Unknown', 'event_espresso');
298
-                    $datetimes_strings = array(__('Unknown', 'event_espresso'));
299
-                }
300
-                $reg_csv_array[$ticket_model->field_settings_for('TKT_name')->get_nicename()] = $ticket_name;
301
-                $reg_csv_array[__("Datetimes of Ticket", "event_espresso")] = implode(", ", $datetimes_strings);
302
-                //get datetime(s) of registration
303
-                //add attendee columns
304
-                foreach ($att_fields_to_include as $att_field_name) {
305
-                    $field_obj = \EEM_Attendee::instance()->field_settings_for($att_field_name);
306
-                    if ($reg_row['Attendee_CPT.ID']) {
307
-                        if ($att_field_name == 'STA_ID') {
308
-                            $value = \EEM_State::instance()
309
-                                               ->get_var(array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])),
310
-                                                   'STA_name');
311
-                        } elseif ($att_field_name == 'CNT_ISO') {
312
-                            $value = \EEM_Country::instance()
313
-                                                 ->get_var(array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])),
314
-                                                     'CNT_name');
315
-                        } else {
316
-                            $value = \EEH_Export::prepare_value_from_db_for_display(\EEM_Attendee::instance(),
317
-                                $att_field_name, $reg_row[$field_obj->get_qualified_column()]);
318
-                        }
319
-                    } else {
320
-                        $value = '';
321
-                    }
322
-                    $reg_csv_array[\EEH_Export::get_column_name_for_field($field_obj)] = $value;
323
-                }
324
-                //make sure each registration has the same questions in the same order
325
-                foreach ($questions_for_these_regs_rows as $question_row) {
326
-                    if ( ! isset($reg_csv_array[$question_row['Question.QST_admin_label']])) {
327
-                        $reg_csv_array[$question_row['Question.QST_admin_label']] = null;
328
-                    }
329
-                }
330
-                $answers = \EEM_Answer::instance()->get_all_wpdb_results(array(
331
-                        array('REG_ID' => $reg_row['Registration.REG_ID']),
332
-                        'force_join' => array('Question'),
333
-                    ));
334
-                //now fill out the questions THEY answered
335
-                foreach ($answers as $answer_row) {
336
-                    if ($answer_row['Question.QST_ID']) {
337
-                        $question_label = \EEH_Export::prepare_value_from_db_for_display(\EEM_Question::instance(),
338
-                            'QST_admin_label', $answer_row['Question.QST_admin_label']);
339
-                    } else {
340
-                        $question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
341
-                    }
342
-                    if (isset($answer_row['Question.QST_type'])
343
-                        && $answer_row['Question.QST_type'] == \EEM_Question::QST_type_state
344
-                    ) {
345
-                        $reg_csv_array[$question_label] = \EEM_State::instance()
346
-                                                                    ->get_state_name_by_ID($answer_row['Answer.ANS_value']);
347
-                    } else {
348
-                        //this isn't for html, so don't show html entities
349
-                        $reg_csv_array[$question_label] = html_entity_decode(\EEH_Export::prepare_value_from_db_for_display(\EEM_Answer::instance(),
350
-                            'ANS_value', $answer_row['Answer.ANS_value']));
351
-                    }
352
-                }
353
-                $registrations_csv_ready_array[] = apply_filters('FHEE__EE_Export__report_registrations__reg_csv_array',
354
-                    $reg_csv_array, $reg_row);
355
-            }
356
-        }
357
-        //if we couldn't export anything, we want to at least show the column headers
358
-        if (empty($registrations_csv_ready_array)) {
359
-            $reg_csv_array = array();
360
-            $model_and_fields_to_include = array(
361
-                'Registration' => $reg_fields_to_include,
362
-                'Attendee'     => $att_fields_to_include,
363
-            );
364
-            foreach ($model_and_fields_to_include as $model_name => $field_list) {
365
-                $model = \EE_Registry::instance()->load_model($model_name);
366
-                foreach ($field_list as $field_name) {
367
-                    $field = $model->field_settings_for($field_name);
368
-                    $reg_csv_array[\EEH_Export::get_column_name_for_field($field)] = null;
369
-                }
370
-            }
371
-            $registrations_csv_ready_array[] = $reg_csv_array;
372
-        }
373
-        return $registrations_csv_ready_array;
374
-    }
135
+	/**
136
+	 * Gets the csv data for a batch of registrations
137
+	 *
138
+	 * @param int|null $event_id
139
+	 * @param int      $offset
140
+	 * @param int      $limit
141
+	 * @param array    $questions_for_these_regs_rows results of $wpdb->get_results( $something, ARRAY_A) when querying
142
+	 *                                                for questions
143
+	 * @return array top-level keys are numeric, next-level keys are column headers
144
+	 */
145
+	function get_csv_data_for($event_id, $offset, $limit, $questions_for_these_regs_rows)
146
+	{
147
+		$reg_fields_to_include = array(
148
+			'TXN_ID',
149
+			'ATT_ID',
150
+			'REG_ID',
151
+			'REG_date',
152
+			'REG_code',
153
+			'REG_count',
154
+			'REG_final_price',
155
+		);
156
+		$att_fields_to_include = array(
157
+			'ATT_fname',
158
+			'ATT_lname',
159
+			'ATT_email',
160
+			'ATT_address',
161
+			'ATT_address2',
162
+			'ATT_city',
163
+			'STA_ID',
164
+			'CNT_ISO',
165
+			'ATT_zip',
166
+			'ATT_phone',
167
+		);
168
+		$registrations_csv_ready_array = array();
169
+		$reg_model = \EE_Registry::instance()->load_model('Registration');
170
+		$query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array(
171
+				array(
172
+					'OR'                 => array(
173
+						//don't include registrations from failed or abandoned transactions...
174
+						'Transaction.STS_ID' => array(
175
+							'NOT IN',
176
+							array(
177
+								\EEM_Transaction::failed_status_code,
178
+								\EEM_Transaction::abandoned_status_code,
179
+							),
180
+						),
181
+						//unless the registration is approved, in which case include it regardless of transaction status
182
+						'STS_ID'             => \EEM_Registration::status_id_approved,
183
+					),
184
+					'Ticket.TKT_deleted' => array('IN', array(true, false)),
185
+				),
186
+				'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
187
+				'force_join' => array('Transaction', 'Ticket', 'Attendee'),
188
+				'limit'      => array($offset, $limit),
189
+				'caps'       => \EEM_Base::caps_read_admin,
190
+			), $event_id);
191
+		if ($event_id) {
192
+			$query_params[0]['EVT_ID'] = $event_id;
193
+		} else {
194
+			$query_params['force_join'][] = 'Event';
195
+		}
196
+		$registration_rows = $reg_model->get_all_wpdb_results($query_params);
197
+		//get all questions which relate to someone in this group
198
+		$registration_ids = array();
199
+		foreach ($registration_rows as $reg_row) {
200
+			$registration_ids[] = intval($reg_row['Registration.REG_ID']);
201
+		}
202
+		foreach ($registration_rows as $reg_row) {
203
+			if (is_array($reg_row)) {
204
+				$reg_csv_array = array();
205
+				if ( ! $event_id) {
206
+					//get the event's name and Id
207
+					$reg_csv_array[__('Event', 'event_espresso')] = sprintf(__('%1$s (%2$s)', 'event_espresso'),
208
+						\EEH_Export::prepare_value_from_db_for_display(\EEM_Event::instance(), 'EVT_name',
209
+							$reg_row['Event_CPT.post_title']), $reg_row['Event_CPT.ID']);
210
+				}
211
+				$is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
212
+				/*@var $reg_row EE_Registration */
213
+				foreach ($reg_fields_to_include as $field_name) {
214
+					$field = $reg_model->field_settings_for($field_name);
215
+					if ($field_name == 'REG_final_price') {
216
+						$value = \EEH_Export::prepare_value_from_db_for_display($reg_model, $field_name,
217
+							$reg_row['Registration.REG_final_price'], 'localized_float');
218
+					} elseif ($field_name == 'REG_count') {
219
+						$value = sprintf(__('%s of %s', 'event_espresso'),
220
+							\EEH_Export::prepare_value_from_db_for_display($reg_model, 'REG_count',
221
+								$reg_row['Registration.REG_count']),
222
+							\EEH_Export::prepare_value_from_db_for_display($reg_model, 'REG_group_size',
223
+								$reg_row['Registration.REG_group_size']));
224
+					} elseif ($field_name == 'REG_date') {
225
+						$value = \EEH_Export::prepare_value_from_db_for_display($reg_model, $field_name,
226
+							$reg_row['Registration.REG_date'], 'no_html');
227
+					} else {
228
+						$value = \EEH_Export::prepare_value_from_db_for_display($reg_model, $field_name,
229
+							$reg_row[$field->get_qualified_column()]);
230
+					}
231
+					$reg_csv_array[\EEH_Export::get_column_name_for_field($field)] = $value;
232
+					if ($field_name == 'REG_final_price') {
233
+						//add a column named Currency after the final price
234
+						$reg_csv_array[__("Currency", "event_espresso")] = \EE_Config::instance()->currency->code;
235
+					}
236
+				}
237
+				//get pretty status
238
+				$stati = \EEM_Status::instance()->localized_status(array(
239
+					$reg_row['Registration.STS_ID']     => __('unknown', 'event_espresso'),
240
+					$reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso'),
241
+				), false, 'sentence');
242
+				$reg_csv_array[__("Registration Status", 'event_espresso')] = $stati[$reg_row['Registration.STS_ID']];
243
+				//get pretty transaction status
244
+				$reg_csv_array[__("Transaction Status",
245
+					'event_espresso')] = $stati[$reg_row['TransactionTable.STS_ID']];
246
+				$reg_csv_array[__('Transaction Amount Due', 'event_espresso')] = $is_primary_reg
247
+					? \EEH_Export::prepare_value_from_db_for_display(\EEM_Transaction::instance(), 'TXN_total',
248
+						$reg_row['TransactionTable.TXN_total'], 'localized_float') : '0.00';
249
+				$reg_csv_array[__('Amount Paid', 'event_espresso')] = $is_primary_reg
250
+					? \EEH_Export::prepare_value_from_db_for_display(\EEM_Transaction::instance(), 'TXN_paid',
251
+						$reg_row['TransactionTable.TXN_paid'], 'localized_float') : '0.00';
252
+				$payment_methods = array();
253
+				$gateway_txn_ids_etc = array();
254
+				$payment_times = array();
255
+				if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
256
+					$payments_info = \EEM_Payment::instance()->get_all_wpdb_results(array(
257
+						array(
258
+							'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
259
+							'STS_ID' => \EEM_Payment::status_id_approved,
260
+						),
261
+						'force_join' => array('Payment_Method'),
262
+					), ARRAY_A,
263
+						'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time');
264
+					foreach ($payments_info as $payment_method_and_gateway_txn_id) {
265
+						$payment_methods[] = isset($payment_method_and_gateway_txn_id['name'])
266
+							? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso');
267
+						$gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id'])
268
+							? $payment_method_and_gateway_txn_id['gateway_txn_id'] : '';
269
+						$payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time'])
270
+							? $payment_method_and_gateway_txn_id['payment_time'] : '';
271
+					}
272
+				}
273
+				$reg_csv_array[__('Payment Date(s)', 'event_espresso')] = implode(',', $payment_times);
274
+				$reg_csv_array[__('Payment Method(s)', 'event_espresso')] = implode(",", $payment_methods);
275
+				$reg_csv_array[__('Gateway Transaction ID(s)', 'event_espresso')] = implode(',', $gateway_txn_ids_etc);
276
+				//get whether or not the user has checked in
277
+				$reg_csv_array[__("Check-Ins",
278
+					"event_espresso")] = $reg_model->count_related($reg_row['Registration.REG_ID'], 'Checkin');
279
+				//get ticket of registration and its price
280
+				$ticket_model = \EE_Registry::instance()->load_model('Ticket');
281
+				if ($reg_row['Ticket.TKT_ID']) {
282
+					$ticket_name = \EEH_Export::prepare_value_from_db_for_display($ticket_model, 'TKT_name',
283
+						$reg_row['Ticket.TKT_name']);
284
+					$datetimes_strings = array();
285
+					foreach (
286
+						\EEM_Datetime::instance()
287
+									 ->get_all_wpdb_results(array(
288
+										 array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']),
289
+										 'order_by'                 => array('DTT_EVT_start' => 'ASC'),
290
+										 'default_where_conditions' => 'none',
291
+									 )) as $datetime
292
+					) {
293
+						$datetimes_strings[] = \EEH_Export::prepare_value_from_db_for_display(\EEM_Datetime::instance(),
294
+							'DTT_EVT_start', $datetime['Datetime.DTT_EVT_start']);
295
+					}
296
+				} else {
297
+					$ticket_name = __('Unknown', 'event_espresso');
298
+					$datetimes_strings = array(__('Unknown', 'event_espresso'));
299
+				}
300
+				$reg_csv_array[$ticket_model->field_settings_for('TKT_name')->get_nicename()] = $ticket_name;
301
+				$reg_csv_array[__("Datetimes of Ticket", "event_espresso")] = implode(", ", $datetimes_strings);
302
+				//get datetime(s) of registration
303
+				//add attendee columns
304
+				foreach ($att_fields_to_include as $att_field_name) {
305
+					$field_obj = \EEM_Attendee::instance()->field_settings_for($att_field_name);
306
+					if ($reg_row['Attendee_CPT.ID']) {
307
+						if ($att_field_name == 'STA_ID') {
308
+							$value = \EEM_State::instance()
309
+											   ->get_var(array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])),
310
+												   'STA_name');
311
+						} elseif ($att_field_name == 'CNT_ISO') {
312
+							$value = \EEM_Country::instance()
313
+												 ->get_var(array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])),
314
+													 'CNT_name');
315
+						} else {
316
+							$value = \EEH_Export::prepare_value_from_db_for_display(\EEM_Attendee::instance(),
317
+								$att_field_name, $reg_row[$field_obj->get_qualified_column()]);
318
+						}
319
+					} else {
320
+						$value = '';
321
+					}
322
+					$reg_csv_array[\EEH_Export::get_column_name_for_field($field_obj)] = $value;
323
+				}
324
+				//make sure each registration has the same questions in the same order
325
+				foreach ($questions_for_these_regs_rows as $question_row) {
326
+					if ( ! isset($reg_csv_array[$question_row['Question.QST_admin_label']])) {
327
+						$reg_csv_array[$question_row['Question.QST_admin_label']] = null;
328
+					}
329
+				}
330
+				$answers = \EEM_Answer::instance()->get_all_wpdb_results(array(
331
+						array('REG_ID' => $reg_row['Registration.REG_ID']),
332
+						'force_join' => array('Question'),
333
+					));
334
+				//now fill out the questions THEY answered
335
+				foreach ($answers as $answer_row) {
336
+					if ($answer_row['Question.QST_ID']) {
337
+						$question_label = \EEH_Export::prepare_value_from_db_for_display(\EEM_Question::instance(),
338
+							'QST_admin_label', $answer_row['Question.QST_admin_label']);
339
+					} else {
340
+						$question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
341
+					}
342
+					if (isset($answer_row['Question.QST_type'])
343
+						&& $answer_row['Question.QST_type'] == \EEM_Question::QST_type_state
344
+					) {
345
+						$reg_csv_array[$question_label] = \EEM_State::instance()
346
+																	->get_state_name_by_ID($answer_row['Answer.ANS_value']);
347
+					} else {
348
+						//this isn't for html, so don't show html entities
349
+						$reg_csv_array[$question_label] = html_entity_decode(\EEH_Export::prepare_value_from_db_for_display(\EEM_Answer::instance(),
350
+							'ANS_value', $answer_row['Answer.ANS_value']));
351
+					}
352
+				}
353
+				$registrations_csv_ready_array[] = apply_filters('FHEE__EE_Export__report_registrations__reg_csv_array',
354
+					$reg_csv_array, $reg_row);
355
+			}
356
+		}
357
+		//if we couldn't export anything, we want to at least show the column headers
358
+		if (empty($registrations_csv_ready_array)) {
359
+			$reg_csv_array = array();
360
+			$model_and_fields_to_include = array(
361
+				'Registration' => $reg_fields_to_include,
362
+				'Attendee'     => $att_fields_to_include,
363
+			);
364
+			foreach ($model_and_fields_to_include as $model_name => $field_list) {
365
+				$model = \EE_Registry::instance()->load_model($model_name);
366
+				foreach ($field_list as $field_name) {
367
+					$field = $model->field_settings_for($field_name);
368
+					$reg_csv_array[\EEH_Export::get_column_name_for_field($field)] = null;
369
+				}
370
+			}
371
+			$registrations_csv_ready_array[] = $reg_csv_array;
372
+		}
373
+		return $registrations_csv_ready_array;
374
+	}
375 375
 
376 376
 
377 377
 
378
-    /**
379
-     * Counts total unit to process
380
-     *
381
-     * @param int $event_id
382
-     * @return int
383
-     */
384
-    public function count_units_to_process($event_id)
385
-    {
386
-        //use the legacy filter
387
-        $query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array(
388
-                array(
389
-                    'OR'                 => array(
390
-                        //don't include registrations from failed or abandoned transactions...
391
-                        'Transaction.STS_ID' => array(
392
-                            'NOT IN',
393
-                            array(
394
-                                \EEM_Transaction::failed_status_code,
395
-                                \EEM_Transaction::abandoned_status_code,
396
-                            ),
397
-                        ),
398
-                        //unless the registration is approved, in which case include it regardless of transaction status
399
-                        'STS_ID'             => \EEM_Registration::status_id_approved,
400
-                    ),
401
-                    'Ticket.TKT_deleted' => array('IN', array(true, false)),
402
-                ),
403
-                'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
404
-                'force_join' => array('Transaction', 'Ticket', 'Attendee'),
405
-                'caps'       => \EEM_Base::caps_read_admin,
406
-            ), $event_id);
407
-        if ($event_id) {
408
-            $query_params[0]['EVT_ID'] = $event_id;
409
-        } else {
410
-            $query_params['force_join'][] = 'Event';
411
-        }
412
-        return \EEM_Registration::instance()->count($query_params);
413
-    }
378
+	/**
379
+	 * Counts total unit to process
380
+	 *
381
+	 * @param int $event_id
382
+	 * @return int
383
+	 */
384
+	public function count_units_to_process($event_id)
385
+	{
386
+		//use the legacy filter
387
+		$query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array(
388
+				array(
389
+					'OR'                 => array(
390
+						//don't include registrations from failed or abandoned transactions...
391
+						'Transaction.STS_ID' => array(
392
+							'NOT IN',
393
+							array(
394
+								\EEM_Transaction::failed_status_code,
395
+								\EEM_Transaction::abandoned_status_code,
396
+							),
397
+						),
398
+						//unless the registration is approved, in which case include it regardless of transaction status
399
+						'STS_ID'             => \EEM_Registration::status_id_approved,
400
+					),
401
+					'Ticket.TKT_deleted' => array('IN', array(true, false)),
402
+				),
403
+				'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
404
+				'force_join' => array('Transaction', 'Ticket', 'Attendee'),
405
+				'caps'       => \EEM_Base::caps_read_admin,
406
+			), $event_id);
407
+		if ($event_id) {
408
+			$query_params[0]['EVT_ID'] = $event_id;
409
+		} else {
410
+			$query_params['force_join'][] = 'Event';
411
+		}
412
+		return \EEM_Registration::instance()->count($query_params);
413
+	}
414 414
 
415 415
 
416 416
 
417
-    /**
418
-     * Performs any clean-up logic when we know the job is completed.
419
-     * In this case, we delete the temporary file
420
-     *
421
-     * @param JobParameters $job_parameters
422
-     * @return boolean
423
-     */
424
-    public function cleanup_job(JobParameters $job_parameters)
425
-    {
426
-        $this->_file_helper->delete(\EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
427
-            true, 'd');
428
-        return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
429
-    }
417
+	/**
418
+	 * Performs any clean-up logic when we know the job is completed.
419
+	 * In this case, we delete the temporary file
420
+	 *
421
+	 * @param JobParameters $job_parameters
422
+	 * @return boolean
423
+	 */
424
+	public function cleanup_job(JobParameters $job_parameters)
425
+	{
426
+		$this->_file_helper->delete(\EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
427
+			true, 'd');
428
+		return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
429
+	}
430 430
 }
431 431
 
432 432
 
Please login to merge, or discard this patch.
admin_pages/registrations/Registrations_Admin_Page.core.php 2 patches
Spacing   +71 added lines, -71 removed lines patch added patch discarded remove patch
@@ -586,11 +586,11 @@  discard block
 block discarded – undo
586 586
     {
587 587
         //style
588 588
         //wp_register_style('espresso_attendees', ATT_ASSETS_URL . 'espresso_attendees_admin.css', array(), EVENT_ESPRESSO_VERSION );
589
-        wp_register_style('espresso_reg', REG_ASSETS_URL . 'espresso_registrations_admin.css', array('ee-admin-css'),
589
+        wp_register_style('espresso_reg', REG_ASSETS_URL.'espresso_registrations_admin.css', array('ee-admin-css'),
590 590
             EVENT_ESPRESSO_VERSION);
591 591
         wp_enqueue_style('espresso_reg');
592 592
         //script
593
-        wp_register_script('espresso_reg', REG_ASSETS_URL . 'espresso_registrations_admin.js',
593
+        wp_register_script('espresso_reg', REG_ASSETS_URL.'espresso_registrations_admin.js',
594 594
             array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'), EVENT_ESPRESSO_VERSION, true);
595 595
         wp_enqueue_script('espresso_reg');
596 596
     }
@@ -624,7 +624,7 @@  discard block
 block discarded – undo
624 624
     public function load_scripts_styles_contact_list()
625 625
     {
626 626
         wp_deregister_style('espresso_reg');
627
-        wp_register_style('espresso_att', REG_ASSETS_URL . 'espresso_attendees_admin.css', array('ee-admin-css'),
627
+        wp_register_style('espresso_att', REG_ASSETS_URL.'espresso_attendees_admin.css', array('ee-admin-css'),
628 628
             EVENT_ESPRESSO_VERSION);
629 629
         wp_enqueue_style('espresso_att');
630 630
     }
@@ -633,7 +633,7 @@  discard block
 block discarded – undo
633 633
 
634 634
     public function load_scripts_styles_new_registration()
635 635
     {
636
-        wp_register_script('ee-spco-for-admin', REG_ASSETS_URL . 'spco_for_admin.js', array('underscore', 'jquery'),
636
+        wp_register_script('ee-spco-for-admin', REG_ASSETS_URL.'spco_for_admin.js', array('underscore', 'jquery'),
637 637
             EVENT_ESPRESSO_VERSION, true);
638 638
         wp_enqueue_script('ee-spco-for-admin');
639 639
         add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
@@ -833,31 +833,31 @@  discard block
 block discarded – undo
833 833
         }
834 834
         $sc_items = array(
835 835
             'approved_status'   => array(
836
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
836
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_approved,
837 837
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
838 838
             ),
839 839
             'pending_status'    => array(
840
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
840
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_pending_payment,
841 841
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
842 842
             ),
843 843
             'wait_list'         => array(
844
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
844
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_wait_list,
845 845
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
846 846
             ),
847 847
             'incomplete_status' => array(
848
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
848
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_incomplete,
849 849
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_incomplete, false, 'sentence'),
850 850
             ),
851 851
             'not_approved'      => array(
852
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
852
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_not_approved,
853 853
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
854 854
             ),
855 855
             'declined_status'   => array(
856
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
856
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_declined,
857 857
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
858 858
             ),
859 859
             'cancelled_status'  => array(
860
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
860
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_cancelled,
861 861
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
862 862
             ),
863 863
         );
@@ -878,17 +878,17 @@  discard block
 block discarded – undo
878 878
             if (EE_Registry::instance()->CAP->current_user_can('ee_edit_registrations',
879 879
                 'espresso_registrations_new_registration', $EVT_ID)
880 880
             ) {
881
-                $this->_admin_page_title .= ' ' . $this->get_action_link_or_button('new_registration', 'add-registrant',
881
+                $this->_admin_page_title .= ' '.$this->get_action_link_or_button('new_registration', 'add-registrant',
882 882
                         array('event_id' => $EVT_ID), 'add-new-h2');
883 883
             }
884 884
             $event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
885 885
             if ($event instanceof EE_Event) {
886 886
                 $this->_template_args['admin_page_header'] = sprintf(__('%s Viewing registrations for the event: %s%s',
887 887
                     'event_espresso'), '<h3 style="line-height:1.5em;">',
888
-                    '<br /><a href="' . EE_Admin_Page::add_query_args_and_nonce(array(
888
+                    '<br /><a href="'.EE_Admin_Page::add_query_args_and_nonce(array(
889 889
                         'action' => 'edit',
890 890
                         'post'   => $event->ID(),
891
-                    ), EVENTS_ADMIN_URL) . '">&nbsp;' . $event->get('EVT_name') . '&nbsp;</a>&nbsp;', '</h3>');
891
+                    ), EVENTS_ADMIN_URL).'">&nbsp;'.$event->get('EVT_name').'&nbsp;</a>&nbsp;', '</h3>');
892 892
             }
893 893
             $DTT_ID = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0;
894 894
             $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
@@ -897,7 +897,7 @@  discard block
 block discarded – undo
897 897
                 $this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
898 898
                 $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
899 899
                 $this->_template_args['admin_page_header'] .= $datetime->name();
900
-                $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
900
+                $this->_template_args['admin_page_header'] .= ' ( '.$datetime->start_date().' )';
901 901
                 $this->_template_args['admin_page_header'] .= '</span></h3>';
902 902
             }
903 903
         }
@@ -948,13 +948,13 @@  discard block
 block discarded – undo
948 948
     {
949 949
         $EVT_ID = ! empty($this->_req_data['event_id']) && $this->_req_data['event_id'] > 0
950 950
             ? absint($this->_req_data['event_id']) : false;
951
-        $CAT_ID = ! empty($this->_req_data['EVT_CAT']) && (int)$this->_req_data['EVT_CAT'] > 0
951
+        $CAT_ID = ! empty($this->_req_data['EVT_CAT']) && (int) $this->_req_data['EVT_CAT'] > 0
952 952
             ? absint($this->_req_data['EVT_CAT']) : false;
953 953
         $DTT_ID = isset($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : null;
954 954
         $reg_status = ! empty($this->_req_data['_reg_status']) ? sanitize_text_field($this->_req_data['_reg_status'])
955 955
             : false;
956 956
         $month_range = ! empty($this->_req_data['month_range']) ? sanitize_text_field($this->_req_data['month_range'])
957
-            : false;//should be like 2013-april
957
+            : false; //should be like 2013-april
958 958
         $today_a = ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'today' ? true : false;
959 959
         $this_month_a = ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'month' ? true : false;
960 960
         $start_date = false;
@@ -1018,9 +1018,9 @@  discard block
 block discarded – undo
1018 1018
                 'BETWEEN',
1019 1019
                 array(
1020 1020
                     EEM_Registration::instance()
1021
-                                    ->convert_datetime_for_query('REG_date', $curdate . $time_start, 'Y-m-d H:i:s'),
1021
+                                    ->convert_datetime_for_query('REG_date', $curdate.$time_start, 'Y-m-d H:i:s'),
1022 1022
                     EEM_Registration::instance()
1023
-                                    ->convert_datetime_for_query('REG_date', $curdate . $time_end, 'Y-m-d H:i:s'),
1023
+                                    ->convert_datetime_for_query('REG_date', $curdate.$time_end, 'Y-m-d H:i:s'),
1024 1024
                 ),
1025 1025
             );
1026 1026
         } elseif ($this_month_a || $this_month) {
@@ -1031,10 +1031,10 @@  discard block
 block discarded – undo
1031 1031
                 array(
1032 1032
                     EEM_Registration::instance()
1033 1033
                                     ->convert_datetime_for_query('REG_date',
1034
-                                        $this_year_r . '-' . $this_month_r . '-01' . ' ' . $time_start, 'Y-m-d H:i:s'),
1034
+                                        $this_year_r.'-'.$this_month_r.'-01'.' '.$time_start, 'Y-m-d H:i:s'),
1035 1035
                     EEM_Registration::instance()
1036 1036
                                     ->convert_datetime_for_query('REG_date',
1037
-                                        $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' ' . $time_end,
1037
+                                        $this_year_r.'-'.$this_month_r.'-'.$days_this_month.' '.$time_end,
1038 1038
                                         'Y-m-d H:i:s'),
1039 1039
                 ),
1040 1040
             );
@@ -1042,16 +1042,16 @@  discard block
 block discarded – undo
1042 1042
             $pieces = explode(' ', $this->_req_data['month_range'], 3);
1043 1043
             $month_r = ! empty($pieces[0]) ? date('m', strtotime($month_range)) : '';
1044 1044
             $year_r = ! empty($pieces[1]) ? $pieces[1] : '';
1045
-            $days_in_month = date('t', strtotime($year_r . '-' . $month_r . '-' . '01'));
1045
+            $days_in_month = date('t', strtotime($year_r.'-'.$month_r.'-'.'01'));
1046 1046
             $_where['REG_date'] = array(
1047 1047
                 'BETWEEN',
1048 1048
                 array(
1049 1049
                     EEM_Registration::instance()
1050
-                                    ->convert_datetime_for_query('REG_date', $year_r . '-' . $month_r . '-01 00:00:00',
1050
+                                    ->convert_datetime_for_query('REG_date', $year_r.'-'.$month_r.'-01 00:00:00',
1051 1051
                                         'Y-m-d H:i:s'),
1052 1052
                     EEM_Registration::instance()
1053 1053
                                     ->convert_datetime_for_query('REG_date',
1054
-                                        $year_r . '-' . $month_r . '-' . $days_in_month . ' 23:59:59', 'Y-m-d H:i:s'),
1054
+                                        $year_r.'-'.$month_r.'-'.$days_in_month.' 23:59:59', 'Y-m-d H:i:s'),
1055 1055
                 ),
1056 1056
             );
1057 1057
         } elseif ($start_date && $end_date) {
@@ -1062,7 +1062,7 @@  discard block
 block discarded – undo
1062 1062
             throw new EE_Error("not yet supported");
1063 1063
         }
1064 1064
         if ( ! empty($this->_req_data['s'])) {
1065
-            $sstr = '%' . $this->_req_data['s'] . '%';
1065
+            $sstr = '%'.$this->_req_data['s'].'%';
1066 1066
             $_where['OR'] = array(
1067 1067
                 'Event.EVT_name'                          => array('LIKE', $sstr),
1068 1068
                 'Event.EVT_desc'                          => array('LIKE', $sstr),
@@ -1123,16 +1123,16 @@  discard block
 block discarded – undo
1123 1123
                 $event_name = $first_registration->event_obj()->name();
1124 1124
                 $event_date = $first_registration->date_obj()
1125 1125
                                                  ->start_date_and_time('l F j, Y,',
1126
-                                                     'g:i:s a');// isset( $registrations[0]->DTT_EVT_start ) ? date( 'l F j, Y,    g:i:s a', $registrations[0]->DTT_EVT_start ) : '';
1126
+                                                     'g:i:s a'); // isset( $registrations[0]->DTT_EVT_start ) ? date( 'l F j, Y,    g:i:s a', $registrations[0]->DTT_EVT_start ) : '';
1127 1127
                 // edit event link
1128 1128
                 if ($event_name != '') {
1129 1129
                     $edit_event_url = self::add_query_args_and_nonce(array(
1130 1130
                         'action' => 'edit_event',
1131 1131
                         'EVT_ID' => $EVT_ID,
1132 1132
                     ), EVENTS_ADMIN_URL);
1133
-                    $edit_event_lnk = '<a href="' . $edit_event_url . '" title="' . esc_attr__('Edit ',
1134
-                            'event_espresso') . $event_name . '">' . __('Edit Event', 'event_espresso') . '</a>';
1135
-                    $event_name .= ' <span class="admin-page-header-edit-lnk not-bold">' . $edit_event_lnk . '</span>';
1133
+                    $edit_event_lnk = '<a href="'.$edit_event_url.'" title="'.esc_attr__('Edit ',
1134
+                            'event_espresso').$event_name.'">'.__('Edit Event', 'event_espresso').'</a>';
1135
+                    $event_name .= ' <span class="admin-page-header-edit-lnk not-bold">'.$edit_event_lnk.'</span>';
1136 1136
                 }
1137 1137
                 $back_2_reg_url = self::add_query_args_and_nonce(array('action' => 'default'), REG_ADMIN_URL);
1138 1138
                 $back_2_reg_lnk = '<a href="'
@@ -1144,9 +1144,9 @@  discard block
 block discarded – undo
1144 1144
                                   . '</a>';
1145 1145
                 $this->_template_args['before_admin_page_content'] = '
1146 1146
 			<div id="admin-page-header">
1147
-				<h1><span class="small-text not-bold">' . __('Event: ', 'event_espresso') . '</span>' . $event_name . '</h1>
1148
-				<h3><span class="small-text not-bold">' . __('Date: ', 'event_espresso') . '</span>' . $event_date . '</h3>
1149
-				<span class="admin-page-header-go-back-lnk not-bold">' . $back_2_reg_lnk . '</span>
1147
+				<h1><span class="small-text not-bold">' . __('Event: ', 'event_espresso').'</span>'.$event_name.'</h1>
1148
+				<h3><span class="small-text not-bold">' . __('Date: ', 'event_espresso').'</span>'.$event_date.'</h3>
1149
+				<span class="admin-page-header-go-back-lnk not-bold">' . $back_2_reg_lnk.'</span>
1150 1150
 			</div>
1151 1151
 			';
1152 1152
             }
@@ -1217,7 +1217,7 @@  discard block
 block discarded – undo
1217 1217
                     '_REG_ID' => $previous_reg['REG_ID'],
1218 1218
                 ), REG_ADMIN_URL), 'dashicons dashicons-arrow-left ee-icon-size-22') : '';
1219 1219
             // grab header
1220
-            $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
1220
+            $template_path = REG_TEMPLATE_PATH.'reg_admin_details_header.template.php';
1221 1221
             $this->_template_args['REG_ID'] = $this->_registration->ID();
1222 1222
             $this->_template_args['admin_page_header'] = EEH_Template::display_template($template_path,
1223 1223
                 $this->_template_args, true);
@@ -1294,8 +1294,8 @@  discard block
 block discarded – undo
1294 1294
                         'default' => $this->_registration->ID(),
1295 1295
                     )),
1296 1296
                     'current_status'     => new EE_Form_Section_HTML(EEH_HTML::tr(EEH_HTML::th(EEH_HTML::label(EEH_HTML::strong(__('Current Registration Status',
1297
-                            'event_espresso')))) . EEH_HTML::td(EEH_HTML::strong($this->_registration->pretty_status(),
1298
-                            '', 'status-' . $this->_registration->status_ID(),
1297
+                            'event_espresso')))).EEH_HTML::td(EEH_HTML::strong($this->_registration->pretty_status(),
1298
+                            '', 'status-'.$this->_registration->status_ID(),
1299 1299
                             'line-height: 1em; font-size: 1.5em; font-weight: bold;')))),
1300 1300
                     'reg_status'         => new EE_Select_Input($this->_get_reg_statuses(), array(
1301 1301
                             'html_label_text' => __('Change Registration Status to', 'event_espresso'),
@@ -1383,9 +1383,9 @@  discard block
 block discarded – undo
1383 1383
     {
1384 1384
         if (isset($this->_req_data['reg_status_change_form'])) {
1385 1385
             $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
1386
-                ? (array)$this->_req_data['reg_status_change_form']['REG_ID'] : array();
1386
+                ? (array) $this->_req_data['reg_status_change_form']['REG_ID'] : array();
1387 1387
         } else {
1388
-            $REG_IDs = isset($this->_req_data['_REG_ID']) ? (array)$this->_req_data['_REG_ID'] : array();
1388
+            $REG_IDs = isset($this->_req_data['_REG_ID']) ? (array) $this->_req_data['_REG_ID'] : array();
1389 1389
         }
1390 1390
         $success = $this->_set_registration_status($REG_IDs, $status);
1391 1391
         //notify?
@@ -1414,7 +1414,7 @@  discard block
 block discarded – undo
1414 1414
     {
1415 1415
         $success = false;
1416 1416
         // typecast $REG_IDs
1417
-        $REG_IDs = (array)$REG_IDs;
1417
+        $REG_IDs = (array) $REG_IDs;
1418 1418
         if ( ! empty($REG_IDs)) {
1419 1419
             $success = true;
1420 1420
             // set default status if none is passed
@@ -1714,7 +1714,7 @@  discard block
 block discarded – undo
1714 1714
         ), REG_ADMIN_URL);
1715 1715
         $this->_template_args['REG_ID'] = $this->_registration->ID();
1716 1716
         $this->_template_args['event_id'] = $this->_registration->event_ID();
1717
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
1717
+        $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_details.template.php';
1718 1718
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
1719 1719
     }
1720 1720
 
@@ -1737,7 +1737,7 @@  discard block
 block discarded – undo
1737 1737
             $this->_template_args['att_questions'] = count($form->subforms()) > 0 ? $form->get_html_and_js() : '';
1738 1738
             $this->_template_args['reg_questions_form_action'] = 'edit_registration';
1739 1739
             $this->_template_args['REG_ID'] = $this->_registration->ID();
1740
-            $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
1740
+            $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php';
1741 1741
             echo EEH_Template::display_template($template_path, $this->_template_args, true);
1742 1742
         }
1743 1743
     }
@@ -1754,7 +1754,7 @@  discard block
 block discarded – undo
1754 1754
      */
1755 1755
     public function form_before_question_group($output)
1756 1756
     {
1757
-        EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__,
1757
+        EE_Error::doing_it_wrong(__CLASS__.'::'.__FUNCTION__,
1758 1758
             __('This method would have been protected but was used on a filter callback'
1759 1759
                . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'),
1760 1760
             '4.8.32.rc.000');
@@ -1776,7 +1776,7 @@  discard block
 block discarded – undo
1776 1776
      */
1777 1777
     public function form_after_question_group($output)
1778 1778
     {
1779
-        EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__,
1779
+        EE_Error::doing_it_wrong(__CLASS__.'::'.__FUNCTION__,
1780 1780
             __('This method would have been protected but was used on a filter callback'
1781 1781
                . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'),
1782 1782
             '4.8.32.rc.000');
@@ -1811,14 +1811,14 @@  discard block
 block discarded – undo
1811 1811
      */
1812 1812
     public function form_form_field_label_wrap($label)
1813 1813
     {
1814
-        EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__,
1814
+        EE_Error::doing_it_wrong(__CLASS__.'::'.__FUNCTION__,
1815 1815
             __('This method would have been protected but was used on a filter callback'
1816 1816
                . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'),
1817 1817
             '4.8.32.rc.000');
1818 1818
         return '
1819 1819
 			<tr>
1820 1820
 				<th>
1821
-					' . $label . '
1821
+					' . $label.'
1822 1822
 				</th>';
1823 1823
     }
1824 1824
 
@@ -1834,13 +1834,13 @@  discard block
 block discarded – undo
1834 1834
      */
1835 1835
     public function form_form_field_input__wrap($input)
1836 1836
     {
1837
-        EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__,
1837
+        EE_Error::doing_it_wrong(__CLASS__.'::'.__FUNCTION__,
1838 1838
             __('This method would have been protected but was used on a filter callback'
1839 1839
                . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'),
1840 1840
             '4.8.32.rc.000');
1841 1841
         return '
1842 1842
 				<td class="reg-admin-attendee-questions-input-td disabled-input">
1843
-					' . $input . '
1843
+					' . $input.'
1844 1844
 				</td>
1845 1845
 			</tr>';
1846 1846
     }
@@ -1882,7 +1882,7 @@  discard block
 block discarded – undo
1882 1882
     protected function _get_reg_custom_questions_form($REG_ID)
1883 1883
     {
1884 1884
         if ( ! $this->_reg_custom_questions_form) {
1885
-            require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
1885
+            require_once(REG_ADMIN.'form_sections'.DS.'EE_Registration_Custom_Questions_Form.form.php');
1886 1886
             $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(EEM_Registration::instance()
1887 1887
                                                                                                           ->get_one_by_ID($REG_ID));
1888 1888
             $this->_reg_custom_questions_form->_construct_finalize(null, null);
@@ -1973,10 +1973,10 @@  discard block
 block discarded – undo
1973 1973
                     : EEM_Attendee::instance()
1974 1974
                                   ->create_default_object();
1975 1975
                 $this->_template_args['attendees'][$att_nmbr]['STS_ID'] = $registration->status_ID();
1976
-                $this->_template_args['attendees'][$att_nmbr]['fname'] = $attendee->fname();//( isset( $registration->ATT_fname ) & ! empty( $registration->ATT_fname ) ) ? $registration->ATT_fname : '';
1977
-                $this->_template_args['attendees'][$att_nmbr]['lname'] = $attendee->lname();//( isset( $registration->ATT_lname ) & ! empty( $registration->ATT_lname ) ) ? $registration->ATT_lname : '';
1978
-                $this->_template_args['attendees'][$att_nmbr]['email'] = $attendee->email();//( isset( $registration->ATT_email ) & ! empty( $registration->ATT_email ) ) ? $registration->ATT_email : '';
1979
-                $this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();//( isset( $registration->REG_final_price ) & ! empty( $registration->REG_final_price ) ) ? $registration->REG_final_price : '';
1976
+                $this->_template_args['attendees'][$att_nmbr]['fname'] = $attendee->fname(); //( isset( $registration->ATT_fname ) & ! empty( $registration->ATT_fname ) ) ? $registration->ATT_fname : '';
1977
+                $this->_template_args['attendees'][$att_nmbr]['lname'] = $attendee->lname(); //( isset( $registration->ATT_lname ) & ! empty( $registration->ATT_lname ) ) ? $registration->ATT_lname : '';
1978
+                $this->_template_args['attendees'][$att_nmbr]['email'] = $attendee->email(); //( isset( $registration->ATT_email ) & ! empty( $registration->ATT_email ) ) ? $registration->ATT_email : '';
1979
+                $this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price(); //( isset( $registration->REG_final_price ) & ! empty( $registration->REG_final_price ) ) ? $registration->REG_final_price : '';
1980 1980
                 $this->_template_args['attendees'][$att_nmbr]['address'] = implode(', ',
1981 1981
                     $attendee->full_address_as_array());
1982 1982
                 $this->_template_args['attendees'][$att_nmbr]['att_link'] = self::add_query_args_and_nonce(array(
@@ -1990,7 +1990,7 @@  discard block
 block discarded – undo
1990 1990
             $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
1991 1991
             //			$this->_template_args['registration_form_url'] = add_query_arg( array( 'action' => 'edit_registration', 'process' => 'attendees'  ), REG_ADMIN_URL );
1992 1992
         }
1993
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
1993
+        $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_attendees.template.php';
1994 1994
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
1995 1995
     }
1996 1996
 
@@ -2020,9 +2020,9 @@  discard block
 block discarded – undo
2020 2020
             $primary_registration = null;
2021 2021
         }
2022 2022
         $this->_template_args['ATT_ID'] = $attendee->ID();
2023
-        $this->_template_args['fname'] = $attendee->fname();//$this->_registration->ATT_fname;
2024
-        $this->_template_args['lname'] = $attendee->lname();//$this->_registration->ATT_lname;
2025
-        $this->_template_args['email'] = $attendee->email();//$this->_registration->ATT_email;
2023
+        $this->_template_args['fname'] = $attendee->fname(); //$this->_registration->ATT_fname;
2024
+        $this->_template_args['lname'] = $attendee->lname(); //$this->_registration->ATT_lname;
2025
+        $this->_template_args['email'] = $attendee->email(); //$this->_registration->ATT_email;
2026 2026
         $this->_template_args['phone'] = $attendee->phone();
2027 2027
         $this->_template_args['formatted_address'] = EEH_Address::format($attendee);
2028 2028
         //edit link
@@ -2039,7 +2039,7 @@  discard block
 block discarded – undo
2039 2039
             ), REG_ADMIN_URL) : '';
2040 2040
         $this->_template_args['create_label'] = __('Create Contact', 'event_espresso');
2041 2041
         $this->_template_args['att_check'] = $att_check;
2042
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
2042
+        $template_path = REG_TEMPLATE_PATH.'reg_admin_details_side_meta_box_registrant.template.php';
2043 2043
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
2044 2044
     }
2045 2045
 
@@ -2274,7 +2274,7 @@  discard block
 block discarded – undo
2274 2274
             $this->_return_json();
2275 2275
         }
2276 2276
         // grab header
2277
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
2277
+        $template_path = REG_TEMPLATE_PATH.'reg_admin_register_new_attendee.template.php';
2278 2278
         $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
2279 2279
             $this->_template_args, true);
2280 2280
         //$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
@@ -2297,7 +2297,7 @@  discard block
 block discarded – undo
2297 2297
                 'event_espresso'), '<br />', '<h3 class="important-notice">', '</h3>', '<div class="float-right">',
2298 2298
                 '<span id="redirect_timer" class="important-notice">30</span>', '</div>', '<b>', '</b>');
2299 2299
             return '
2300
-	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div>
2300
+	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg.'</p></div>
2301 2301
 	<script >
2302 2302
 		// WHOAH !!! it appears that someone is using the back button from the Transaction admin page
2303 2303
 		// after just adding a new registration... we gotta try to put a stop to that !!!
@@ -2518,7 +2518,7 @@  discard block
 block discarded – undo
2518 2518
     public function get_attendees($per_page, $count = false, $trash = false)
2519 2519
     {
2520 2520
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2521
-        require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
2521
+        require_once(REG_ADMIN.'EE_Attendee_Contact_List_Table.class.php');
2522 2522
         $ATT_MDL = EEM_Attendee::instance();
2523 2523
         $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
2524 2524
         switch ($this->_req_data['orderby']) {
@@ -2552,7 +2552,7 @@  discard block
 block discarded – undo
2552 2552
             ? $this->_req_data['perpage'] : $per_page;
2553 2553
         $_where = array();
2554 2554
         if ( ! empty($this->_req_data['s'])) {
2555
-            $sstr = '%' . $this->_req_data['s'] . '%';
2555
+            $sstr = '%'.$this->_req_data['s'].'%';
2556 2556
             $_where['OR'] = array(
2557 2557
                 'Registration.Event.EVT_name'       => array('LIKE', $sstr),
2558 2558
                 'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
@@ -2643,8 +2643,8 @@  discard block
 block discarded – undo
2643 2643
                 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
2644 2644
             );
2645 2645
             $this->_req_data = array_merge($this->_req_data, $new_request_args);
2646
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
2647
-                require_once(EE_CLASSES . 'EE_Export.class.php');
2646
+            if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
2647
+                require_once(EE_CLASSES.'EE_Export.class.php');
2648 2648
                 $EE_Export = EE_Export::instance($this->_req_data);
2649 2649
                 $EE_Export->export();
2650 2650
             }
@@ -2655,8 +2655,8 @@  discard block
 block discarded – undo
2655 2655
 
2656 2656
     public function _contact_list_export()
2657 2657
     {
2658
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
2659
-            require_once(EE_CLASSES . 'EE_Export.class.php');
2658
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
2659
+            require_once(EE_CLASSES.'EE_Export.class.php');
2660 2660
             $EE_Export = EE_Export::instance($this->_req_data);
2661 2661
             $EE_Export->export_attendees();
2662 2662
         }
@@ -2674,8 +2674,8 @@  discard block
 block discarded – undo
2674 2674
                 'return_url'  => urlencode($this->_req_data['return_url']),
2675 2675
             )));
2676 2676
         } else {
2677
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
2678
-                require_once(EE_CLASSES . 'EE_Export.class.php');
2677
+            if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
2678
+                require_once(EE_CLASSES.'EE_Export.class.php');
2679 2679
                 $EE_Export = EE_Export::instance($this->_req_data);
2680 2680
                 $EE_Export->report_attendees();
2681 2681
             }
@@ -2733,7 +2733,7 @@  discard block
 block discarded – undo
2733 2733
             $updated_fields = array(
2734 2734
                 'ATT_fname'     => $this->_req_data['ATT_fname'],
2735 2735
                 'ATT_lname'     => $this->_req_data['ATT_lname'],
2736
-                'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
2736
+                'ATT_full_name' => $this->_req_data['ATT_fname'].' '.$this->_req_data['ATT_lname'],
2737 2737
                 'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
2738 2738
                 'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
2739 2739
                 'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
@@ -2822,7 +2822,7 @@  discard block
 block discarded – undo
2822 2822
     {
2823 2823
         //get attendee object ( should already have it )
2824 2824
         $this->_template_args['attendee'] = $this->_cpt_model_obj;
2825
-        $template = REG_TEMPLATE_PATH . 'attendee_contact_info_metabox_content.template.php';
2825
+        $template = REG_TEMPLATE_PATH.'attendee_contact_info_metabox_content.template.php';
2826 2826
         EEH_Template::display_template($template, $this->_template_args);
2827 2827
     }
2828 2828
 
@@ -2864,7 +2864,7 @@  discard block
 block discarded – undo
2864 2864
                 'input_prefix'   => '',
2865 2865
                 'append_qstn_id' => false,
2866 2866
             )));
2867
-        $template = REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
2867
+        $template = REG_TEMPLATE_PATH.'attendee_address_details_metabox_content.template.php';
2868 2868
         EEH_Template::display_template($template, $this->_template_args);
2869 2869
     }
2870 2870
 
@@ -2880,7 +2880,7 @@  discard block
 block discarded – undo
2880 2880
     {
2881 2881
         $this->_template_args['attendee'] = $this->_cpt_model_obj;
2882 2882
         $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
2883
-        $template = REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
2883
+        $template = REG_TEMPLATE_PATH.'attendee_registrations_main_meta_box.template.php';
2884 2884
         EEH_Template::display_template($template, $this->_template_args);
2885 2885
     }
2886 2886
 
@@ -2895,7 +2895,7 @@  discard block
 block discarded – undo
2895 2895
     public function after_title_form_fields($post)
2896 2896
     {
2897 2897
         if ($post->post_type == 'espresso_attendees') {
2898
-            $template = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
2898
+            $template = REG_TEMPLATE_PATH.'attendee_details_after_title_form_fields.template.php';
2899 2899
             $template_args['attendee'] = $this->_cpt_model_obj;
2900 2900
             EEH_Template::display_template($template, $template_args);
2901 2901
         }
Please login to merge, or discard this patch.
Indentation   +2885 added lines, -2885 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@  discard block
 block discarded – undo
1 1
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
2
-    exit('No direct script access allowed');
2
+	exit('No direct script access allowed');
3 3
 }
4 4
 
5 5
 
@@ -24,1772 +24,1772 @@  discard block
 block discarded – undo
24 24
 class Registrations_Admin_Page extends EE_Admin_Page_CPT
25 25
 {
26 26
 
27
-    /**
28
-     * @var EE_Registration
29
-     */
30
-    private $_registration;
31
-
32
-    /**
33
-     * @var EE_Event
34
-     */
35
-    private $_reg_event;
36
-
37
-    /**
38
-     * @var EE_Session
39
-     */
40
-    private        $_session;
41
-
42
-    private static $_reg_status;
43
-
44
-    /**
45
-     * Form for displaying the custom questions for this registration.
46
-     * This gets used a few times throughout the request so its best to cache it
47
-     *
48
-     * @var EE_Registration_Custom_Questions_Form
49
-     */
50
-    protected $_reg_custom_questions_form = null;
51
-
52
-
53
-
54
-    /**
55
-     *        constructor
56
-     *
57
-     * @Constructor
58
-     * @access public
59
-     * @param bool $routing
60
-     * @return Registrations_Admin_Page
61
-     */
62
-    public function __construct($routing = true)
63
-    {
64
-        parent::__construct($routing);
65
-        add_action('wp_loaded', array($this, 'wp_loaded'));
66
-    }
67
-
68
-
69
-
70
-    public function wp_loaded()
71
-    {
72
-        // when adding a new registration...
73
-        if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
74
-            EE_System::do_not_cache();
75
-            if ( ! isset($this->_req_data['processing_registration'])
76
-                 || absint($this->_req_data['processing_registration']) !== 1
77
-            ) {
78
-                // and it's NOT the attendee information reg step
79
-                // force cookie expiration by setting time to last week
80
-                setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
81
-                // and update the global
82
-                $_COOKIE['ee_registration_added'] = 0;
83
-            }
84
-        }
85
-    }
86
-
87
-
88
-
89
-    protected function _init_page_props()
90
-    {
91
-        $this->page_slug = REG_PG_SLUG;
92
-        $this->_admin_base_url = REG_ADMIN_URL;
93
-        $this->_admin_base_path = REG_ADMIN;
94
-        $this->page_label = __('Registrations', 'event_espresso');
95
-        $this->_cpt_routes = array(
96
-            'add_new_attendee' => 'espresso_attendees',
97
-            'edit_attendee'    => 'espresso_attendees',
98
-            'insert_attendee'  => 'espresso_attendees',
99
-            'update_attendee'  => 'espresso_attendees',
100
-        );
101
-        $this->_cpt_model_names = array(
102
-            'add_new_attendee' => 'EEM_Attendee',
103
-            'edit_attendee'    => 'EEM_Attendee',
104
-        );
105
-        $this->_cpt_edit_routes = array(
106
-            'espresso_attendees' => 'edit_attendee',
107
-        );
108
-        $this->_pagenow_map = array(
109
-            'add_new_attendee' => 'post-new.php',
110
-            'edit_attendee'    => 'post.php',
111
-            'trash'            => 'post.php',
112
-        );
113
-        add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10);
114
-        //add filters so that the comment urls don't take users to a confusing 404 page
115
-        add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3);
116
-    }
117
-
118
-
119
-
120
-    public function clear_comment_link($link, $comment, $args)
121
-    {
122
-        //gotta make sure this only happens on this route
123
-        $post_type = get_post_type($comment->comment_post_ID);
124
-        if ($post_type === 'espresso_attendees') {
125
-            return '#commentsdiv';
126
-        }
127
-        return $link;
128
-    }
129
-
130
-
131
-
132
-    protected function _ajax_hooks()
133
-    {
134
-        //todo: all hooks for registrations ajax goes in here
135
-        add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status'));
136
-    }
137
-
138
-
139
-
140
-    protected function _define_page_props()
141
-    {
142
-        $this->_admin_page_title = $this->page_label;
143
-        $this->_labels = array(
144
-            'buttons'                      => array(
145
-                'add-registrant'      => __('Add New Registration', 'event_espresso'),
146
-                'add-attendee'        => __('Add Contact', 'event_espresso'),
147
-                'edit'                => __('Edit Contact', 'event_espresso'),
148
-                'report'              => __("Event Registrations CSV Report", "event_espresso"),
149
-                'report_all'          => __('All Registrations CSV Report', 'event_espresso'),
150
-                'contact_list_report' => __('Contact List Report', 'event_espresso'),
151
-                'contact_list_export' => __("Export Data", "event_espresso"),
152
-            ),
153
-            'publishbox'                   => array(
154
-                'add_new_attendee' => __("Add Contact Record", 'event_espresso'),
155
-                'edit_attendee'    => __("Update Contact Record", 'event_espresso'),
156
-            ),
157
-            'hide_add_button_on_cpt_route' => array(
158
-                'edit_attendee' => true,
159
-            ),
160
-        );
161
-    }
162
-
163
-
164
-
165
-    /**
166
-     *        grab url requests and route them
167
-     *
168
-     * @access private
169
-     * @return void
170
-     */
171
-    public function _set_page_routes()
172
-    {
173
-        $this->_get_registration_status_array();
174
-        $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
175
-            ? $this->_req_data['_REG_ID'] : 0;
176
-        $att_id = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID'])
177
-            ? $this->_req_data['ATT_ID'] : 0;
178
-        $att_id = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post']) ? $this->_req_data['post']
179
-            : $att_id;
180
-        $this->_page_routes = array(
181
-            'default' => array(
182
-                'func'       => '_registrations_overview_list_table',
183
-                'capability' => 'ee_read_registrations',
184
-            ),
185
-            'view_registration' => array(
186
-                'func'       => '_registration_details',
187
-                'capability' => 'ee_read_registration',
188
-                'obj_id'     => $reg_id,
189
-            ),
190
-            'edit_registration' => array(
191
-                'func'               => '_update_attendee_registration_form',
192
-                'noheader'           => true,
193
-                'headers_sent_route' => 'view_registration',
194
-                'capability'         => 'ee_edit_registration',
195
-                'obj_id'             => $reg_id,
196
-                '_REG_ID'            => $reg_id,
197
-            ),
198
-            'trash_registrations' => array(
199
-                'func'       => '_trash_or_restore_registrations',
200
-                'args'       => array('trash' => true),
201
-                'noheader'   => true,
202
-                'capability' => 'ee_delete_registrations',
203
-            ),
204
-            'restore_registrations' => array(
205
-                'func'       => '_trash_or_restore_registrations',
206
-                'args'       => array('trash' => false),
207
-                'noheader'   => true,
208
-                'capability' => 'ee_delete_registrations',
209
-            ),
210
-            'delete_registrations' => array(
211
-                'func'       => '_delete_registrations',
212
-                'noheader'   => true,
213
-                'capability' => 'ee_delete_registrations',
214
-            ),
215
-            'new_registration' => array(
216
-                'func'       => 'new_registration',
217
-                'capability' => 'ee_edit_registrations',
218
-            ),
219
-            'process_reg_step' => array(
220
-                'func'       => 'process_reg_step',
221
-                'noheader'   => true,
222
-                'capability' => 'ee_edit_registrations',
223
-            ),
224
-            'redirect_to_txn' => array(
225
-                'func'       => 'redirect_to_txn',
226
-                'noheader'   => true,
227
-                'capability' => 'ee_edit_registrations',
228
-            ),
229
-            'change_reg_status' => array(
230
-                'func'       => '_change_reg_status',
231
-                'noheader'   => true,
232
-                'capability' => 'ee_edit_registration',
233
-                'obj_id'     => $reg_id,
234
-            ),
235
-            'approve_registration' => array(
236
-                'func'       => 'approve_registration',
237
-                'noheader'   => true,
238
-                'capability' => 'ee_edit_registration',
239
-                'obj_id'     => $reg_id,
240
-            ),
241
-            'approve_and_notify_registration' => array(
242
-                'func'       => 'approve_registration',
243
-                'noheader'   => true,
244
-                'args'       => array(true),
245
-                'capability' => 'ee_edit_registration',
246
-                'obj_id'     => $reg_id,
247
-            ),
248
-            'decline_registration' => array(
249
-                'func'       => 'decline_registration',
250
-                'noheader'   => true,
251
-                'capability' => 'ee_edit_registration',
252
-                'obj_id'     => $reg_id,
253
-            ),
254
-            'decline_and_notify_registration' => array(
255
-                'func'       => 'decline_registration',
256
-                'noheader'   => true,
257
-                'args'       => array(true),
258
-                'capability' => 'ee_edit_registration',
259
-                'obj_id'     => $reg_id,
260
-            ),
261
-            'pending_registration' => array(
262
-                'func'       => 'pending_registration',
263
-                'noheader'   => true,
264
-                'capability' => 'ee_edit_registration',
265
-                'obj_id'     => $reg_id,
266
-            ),
267
-            'pending_and_notify_registration' => array(
268
-                'func'       => 'pending_registration',
269
-                'noheader'   => true,
270
-                'args'       => array(true),
271
-                'capability' => 'ee_edit_registration',
272
-                'obj_id'     => $reg_id,
273
-            ),
274
-            'no_approve_registration' => array(
275
-                'func'       => 'not_approve_registration',
276
-                'noheader'   => true,
277
-                'capability' => 'ee_edit_registration',
278
-                'obj_id'     => $reg_id,
279
-            ),
280
-            'no_approve_and_notify_registration' => array(
281
-                'func'       => 'not_approve_registration',
282
-                'noheader'   => true,
283
-                'args'       => array(true),
284
-                'capability' => 'ee_edit_registration',
285
-                'obj_id'     => $reg_id,
286
-            ),
287
-            'cancel_registration' => array(
288
-                'func'       => 'cancel_registration',
289
-                'noheader'   => true,
290
-                'capability' => 'ee_edit_registration',
291
-                'obj_id'     => $reg_id,
292
-            ),
293
-            'cancel_and_notify_registration' => array(
294
-                'func'       => 'cancel_registration',
295
-                'noheader'   => true,
296
-                'args'       => array(true),
297
-                'capability' => 'ee_edit_registration',
298
-                'obj_id'     => $reg_id,
299
-            ),
300
-            'contact_list' => array(
301
-                'func'       => '_attendee_contact_list_table',
302
-                'capability' => 'ee_read_contacts',
303
-            ),
304
-            'add_new_attendee' => array(
305
-                'func' => '_create_new_cpt_item',
306
-                'args' => array(
307
-                    'new_attendee' => true,
308
-                    'capability'   => 'ee_edit_contacts',
309
-                ),
310
-            ),
311
-            'edit_attendee' => array(
312
-                'func'       => '_edit_cpt_item',
313
-                'capability' => 'ee_edit_contacts',
314
-                'obj_id'     => $att_id,
315
-            ),
316
-            'duplicate_attendee' => array(
317
-                'func'       => '_duplicate_attendee',
318
-                'noheader'   => true,
319
-                'capability' => 'ee_edit_contacts',
320
-                'obj_id'     => $att_id,
321
-            ),
322
-            'insert_attendee' => array(
323
-                'func'       => '_insert_or_update_attendee',
324
-                'args'       => array(
325
-                    'new_attendee' => true,
326
-                ),
327
-                'noheader'   => true,
328
-                'capability' => 'ee_edit_contacts',
329
-            ),
330
-            'update_attendee' => array(
331
-                'func'       => '_insert_or_update_attendee',
332
-                'args'       => array(
333
-                    'new_attendee' => false,
334
-                ),
335
-                'noheader'   => true,
336
-                'capability' => 'ee_edit_contacts',
337
-                'obj_id'     => $att_id,
338
-            ),
339
-            'trash_attendees' => array(
340
-                'func'       => '_trash_or_restore_attendees',
341
-                'args'       => array(
342
-                    'trash' => true,
343
-                ),
344
-                'noheader'   => true,
345
-                'capability' => 'ee_delete_contacts',
346
-                'obj_id'     => $att_id,
347
-            ),
348
-            'restore_attendees'    => array(
349
-                'func'       => '_trash_or_restore_attendees',
350
-                'args'       => array(
351
-                    'trash' => false,
352
-                ),
353
-                'noheader'   => true,
354
-                'capability' => 'ee_delete_contacts',
355
-                'obj_id'     => $att_id,
356
-            ),
357
-            'resend_registration'  => array(
358
-                'func'       => '_resend_registration',
359
-                'noheader'   => true,
360
-                'capability' => 'ee_send_message',
361
-            ),
362
-            'registrations_report' => array(
363
-                'func'       => '_registrations_report',
364
-                'noheader'   => true,
365
-                'capability' => 'ee_read_registrations',
366
-            ),
367
-            'contact_list_export'  => array(
368
-                'func'       => '_contact_list_export',
369
-                'noheader'   => true,
370
-                'capability' => 'export',
371
-            ),
372
-            'contact_list_report'  => array(
373
-                'func'       => '_contact_list_report',
374
-                'noheader'   => true,
375
-                'capability' => 'ee_read_contacts',
376
-            ),
377
-        );
378
-    }
379
-
380
-
381
-
382
-    protected function _set_page_config()
383
-    {
384
-        $this->_page_config = array(
385
-            'default' => array(
386
-                'nav'           => array(
387
-                    'label' => __('Overview', 'event_espresso'),
388
-                    'order' => 5,
389
-                ),
390
-                'help_tabs'     => array(
391
-                    'registrations_overview_help_tab'                       => array(
392
-                        'title'    => __('Registrations Overview', 'event_espresso'),
393
-                        'filename' => 'registrations_overview',
394
-                    ),
395
-                    'registrations_overview_table_column_headings_help_tab' => array(
396
-                        'title'    => __('Registrations Table Column Headings', 'event_espresso'),
397
-                        'filename' => 'registrations_overview_table_column_headings',
398
-                    ),
399
-                    'registrations_overview_filters_help_tab'               => array(
400
-                        'title'    => __('Registration Filters', 'event_espresso'),
401
-                        'filename' => 'registrations_overview_filters',
402
-                    ),
403
-                    'registrations_overview_views_help_tab'                 => array(
404
-                        'title'    => __('Registration Views', 'event_espresso'),
405
-                        'filename' => 'registrations_overview_views',
406
-                    ),
407
-                    'registrations_regoverview_other_help_tab'              => array(
408
-                        'title'    => __('Registrations Other', 'event_espresso'),
409
-                        'filename' => 'registrations_overview_other',
410
-                    ),
411
-                ),
412
-                'help_tour'     => array('Registration_Overview_Help_Tour'),
413
-                'qtips'         => array('Registration_List_Table_Tips'),
414
-                'list_table'    => 'EE_Registrations_List_Table',
415
-                'require_nonce' => false,
416
-            ),
417
-            'view_registration' => array(
418
-                'nav'           => array(
419
-                    'label'      => __('REG Details', 'event_espresso'),
420
-                    'order'      => 15,
421
-                    'url'        => isset($this->_req_data['_REG_ID'])
422
-                        ? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url)
423
-                        : $this->_admin_base_url,
424
-                    'persistent' => false,
425
-                ),
426
-                'help_tabs'     => array(
427
-                    'registrations_details_help_tab'                    => array(
428
-                        'title'    => __('Registration Details', 'event_espresso'),
429
-                        'filename' => 'registrations_details',
430
-                    ),
431
-                    'registrations_details_table_help_tab'              => array(
432
-                        'title'    => __('Registration Details Table', 'event_espresso'),
433
-                        'filename' => 'registrations_details_table',
434
-                    ),
435
-                    'registrations_details_form_answers_help_tab'       => array(
436
-                        'title'    => __('Registration Form Answers', 'event_espresso'),
437
-                        'filename' => 'registrations_details_form_answers',
438
-                    ),
439
-                    'registrations_details_registrant_details_help_tab' => array(
440
-                        'title'    => __('Contact Details', 'event_espresso'),
441
-                        'filename' => 'registrations_details_registrant_details',
442
-                    ),
443
-                ),
444
-                'help_tour'     => array('Registration_Details_Help_Tour'),
445
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes,
446
-                    array('_registration_details_metaboxes')),
447
-                'require_nonce' => false,
448
-            ),
449
-            'new_registration' => array(
450
-                'nav'           => array(
451
-                    'label'      => __('Add New Registration', 'event_espresso'),
452
-                    'url'        => '#',
453
-                    'order'      => 15,
454
-                    'persistent' => false,
455
-                ),
456
-                'metaboxes'     => $this->_default_espresso_metaboxes,
457
-                'labels'        => array(
458
-                    'publishbox' => __('Save Registration', 'event_espresso'),
459
-                ),
460
-                'require_nonce' => false,
461
-            ),
462
-            'add_new_attendee' => array(
463
-                'nav'           => array(
464
-                    'label'      => __('Add Contact', 'event_espresso'),
465
-                    'order'      => 15,
466
-                    'persistent' => false,
467
-                ),
468
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes,
469
-                    array('_publish_post_box', 'attendee_editor_metaboxes')),
470
-                'require_nonce' => false,
471
-            ),
472
-            'edit_attendee' => array(
473
-                'nav'           => array(
474
-                    'label'      => __('Edit Contact', 'event_espresso'),
475
-                    'order'      => 15,
476
-                    'persistent' => false,
477
-                    'url'        => isset($this->_req_data['ATT_ID'])
478
-                        ? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url)
479
-                        : $this->_admin_base_url,
480
-                ),
481
-                'metaboxes'     => array('attendee_editor_metaboxes'),
482
-                'require_nonce' => false,
483
-            ),
484
-            'contact_list' => array(
485
-                'nav'           => array(
486
-                    'label' => __('Contact List', 'event_espresso'),
487
-                    'order' => 20,
488
-                ),
489
-                'list_table'    => 'EE_Attendee_Contact_List_Table',
490
-                'help_tabs'     => array(
491
-                    'registrations_contact_list_help_tab'                       => array(
492
-                        'title'    => __('Registrations Contact List', 'event_espresso'),
493
-                        'filename' => 'registrations_contact_list',
494
-                    ),
495
-                    'registrations_contact-list_table_column_headings_help_tab' => array(
496
-                        'title'    => __('Contact List Table Column Headings', 'event_espresso'),
497
-                        'filename' => 'registrations_contact_list_table_column_headings',
498
-                    ),
499
-                    'registrations_contact_list_views_help_tab'                 => array(
500
-                        'title'    => __('Contact List Views', 'event_espresso'),
501
-                        'filename' => 'registrations_contact_list_views',
502
-                    ),
503
-                    'registrations_contact_list_other_help_tab'                 => array(
504
-                        'title'    => __('Contact List Other', 'event_espresso'),
505
-                        'filename' => 'registrations_contact_list_other',
506
-                    ),
507
-                ),
508
-                'help_tour'     => array('Contact_List_Help_Tour'),
509
-                'metaboxes'     => array(),
510
-                'require_nonce' => false,
511
-            ),
512
-            //override default cpt routes
513
-            'create_new'   => '',
514
-            'edit'         => '',
515
-        );
516
-    }
517
-
518
-
519
-
520
-    /**
521
-     * The below methods aren't used by this class currently
522
-     */
523
-    protected function _add_screen_options()
524
-    {
525
-    }
526
-
527
-
528
-
529
-    protected function _add_feature_pointers()
530
-    {
531
-    }
532
-
533
-
534
-
535
-    public function admin_init()
536
-    {
537
-        EE_Registry::$i18n_js_strings['update_att_qstns'] = __('click "Update Registration Questions" to save your changes',
538
-            'event_espresso');
539
-    }
540
-
541
-
542
-
543
-    public function admin_notices()
544
-    {
545
-    }
546
-
547
-
548
-
549
-    public function admin_footer_scripts()
550
-    {
551
-    }
552
-
553
-
554
-
555
-    /**
556
-     *        get list of registration statuses
557
-     *
558
-     * @access private
559
-     * @return void
560
-     */
561
-    private function _get_registration_status_array()
562
-    {
563
-        self::$_reg_status = EEM_Registration::reg_status_array(array(), true);
564
-    }
565
-
566
-
567
-
568
-    protected function _add_screen_options_default()
569
-    {
570
-        $this->_per_page_screen_option();
571
-    }
572
-
573
-
574
-
575
-    protected function _add_screen_options_contact_list()
576
-    {
577
-        $page_title = $this->_admin_page_title;
578
-        $this->_admin_page_title = __("Contacts", 'event_espresso');
579
-        $this->_per_page_screen_option();
580
-        $this->_admin_page_title = $page_title;
581
-    }
582
-
583
-
584
-
585
-    public function load_scripts_styles()
586
-    {
587
-        //style
588
-        //wp_register_style('espresso_attendees', ATT_ASSETS_URL . 'espresso_attendees_admin.css', array(), EVENT_ESPRESSO_VERSION );
589
-        wp_register_style('espresso_reg', REG_ASSETS_URL . 'espresso_registrations_admin.css', array('ee-admin-css'),
590
-            EVENT_ESPRESSO_VERSION);
591
-        wp_enqueue_style('espresso_reg');
592
-        //script
593
-        wp_register_script('espresso_reg', REG_ASSETS_URL . 'espresso_registrations_admin.js',
594
-            array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'), EVENT_ESPRESSO_VERSION, true);
595
-        wp_enqueue_script('espresso_reg');
596
-    }
597
-
598
-
599
-
600
-    public function load_scripts_styles_edit_attendee()
601
-    {
602
-        //stuff to only show up on our attendee edit details page.
603
-        $attendee_details_translations = array(
604
-            'att_publish_text' => sprintf(__('Created on: <b>%1$s</b>', 'event_espresso'),
605
-                $this->_cpt_model_obj->get_datetime('ATT_created')),
606
-        );
607
-        wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
608
-        wp_enqueue_script('jquery-validate');
609
-    }
610
-
611
-
612
-
613
-    public function load_scripts_styles_view_registration()
614
-    {
615
-        //styles
616
-        wp_enqueue_style('espresso-ui-theme');
617
-        //scripts
618
-        $this->_get_reg_custom_questions_form($this->_registration->ID());
619
-        $this->_reg_custom_questions_form->wp_enqueue_scripts(true);
620
-    }
621
-
622
-
623
-
624
-    public function load_scripts_styles_contact_list()
625
-    {
626
-        wp_deregister_style('espresso_reg');
627
-        wp_register_style('espresso_att', REG_ASSETS_URL . 'espresso_attendees_admin.css', array('ee-admin-css'),
628
-            EVENT_ESPRESSO_VERSION);
629
-        wp_enqueue_style('espresso_att');
630
-    }
631
-
632
-
633
-
634
-    public function load_scripts_styles_new_registration()
635
-    {
636
-        wp_register_script('ee-spco-for-admin', REG_ASSETS_URL . 'spco_for_admin.js', array('underscore', 'jquery'),
637
-            EVENT_ESPRESSO_VERSION, true);
638
-        wp_enqueue_script('ee-spco-for-admin');
639
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
640
-        EE_Form_Section_Proper::wp_enqueue_scripts();
641
-        EED_Ticket_Selector::load_tckt_slctr_assets();
642
-        EE_Datepicker_Input::enqueue_styles_and_scripts();
643
-    }
644
-
645
-
646
-
647
-    public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
648
-    {
649
-        add_filter('FHEE_load_EE_messages', '__return_true');
650
-    }
651
-
652
-
653
-
654
-    public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
655
-    {
656
-        add_filter('FHEE_load_EE_messages', '__return_true');
657
-    }
658
-
659
-
660
-
661
-    protected function _set_list_table_views_default()
662
-    {
663
-        //for notification related bulk actions we need to make sure only active messengers have an option.
664
-        EED_Messages::set_autoloaders();
665
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
666
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
667
-        $active_mts = $message_resource_manager->list_of_active_message_types();
668
-        //key= bulk_action_slug, value= message type.
669
-        $match_array = array(
670
-            'approve_registration'    => 'registration',
671
-            'decline_registration'    => 'declined_registration',
672
-            'pending_registration'    => 'pending_approval',
673
-            'no_approve_registration' => 'not_approved_registration',
674
-            'cancel_registration'     => 'cancelled_registration',
675
-        );
676
-        /** setup reg status bulk actions **/
677
-        $def_reg_status_actions['approve_registration'] = __('Approve Registrations', 'event_espresso');
678
-        if (in_array($match_array['approve_registration'], $active_mts)
679
-            && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
680
-        ) {
681
-            $def_reg_status_actions['approve_and_notify_registration'] = __('Approve and Notify Registrations',
682
-                'event_espresso');
683
-        }
684
-        $def_reg_status_actions['decline_registration'] = __('Decline Registrations', 'event_espresso');
685
-        if (in_array($match_array['decline_registration'], $active_mts)
686
-            && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
687
-        ) {
688
-            $def_reg_status_actions['decline_and_notify_registration'] = __('Decline and Notify Registrations',
689
-                'event_espresso');
690
-        }
691
-        $def_reg_status_actions['pending_registration'] = __('Set Registrations to Pending Payment', 'event_espresso');
692
-        if (in_array($match_array['pending_registration'], $active_mts)
693
-            && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
694
-        ) {
695
-            $def_reg_status_actions['pending_and_notify_registration'] = __('Set Registrations to Pending Payment and Notify',
696
-                'event_espresso');
697
-        }
698
-        $def_reg_status_actions['no_approve_registration'] = __('Set Registrations to Not Approved', 'event_espresso');
699
-        if (in_array($match_array['no_approve_registration'], $active_mts)
700
-            && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
701
-        ) {
702
-            $def_reg_status_actions['no_approve_and_notify_registration'] = __('Set Registrations to Not Approved and Notify',
703
-                'event_espresso');
704
-        }
705
-        $def_reg_status_actions['cancel_registration'] = __('Cancel Registrations', 'event_espresso');
706
-        if (in_array($match_array['cancel_registration'], $active_mts)
707
-            && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
708
-        ) {
709
-            $def_reg_status_actions['cancel_and_notify_registration'] = __('Cancel Registrations and Notify',
710
-                'event_espresso');
711
-        }
712
-        $this->_views = array(
713
-            'all'   => array(
714
-                'slug'        => 'all',
715
-                'label'       => __('View All Registrations', 'event_espresso'),
716
-                'count'       => 0,
717
-                'bulk_action' => array_merge($def_reg_status_actions, array(
718
-                    'trash_registrations' => __('Trash Registrations', 'event_espresso'),
719
-                )),
720
-            ),
721
-            'month' => array(
722
-                'slug'        => 'month',
723
-                'label'       => __('This Month', 'event_espresso'),
724
-                'count'       => 0,
725
-                'bulk_action' => array_merge($def_reg_status_actions, array(
726
-                    'trash_registrations' => __('Trash Registrations', 'event_espresso'),
727
-                )),
728
-            ),
729
-            'today' => array(
730
-                'slug'        => 'today',
731
-                'label'       => sprintf(__('Today - %s', 'event_espresso'), date('M d, Y', current_time('timestamp'))),
732
-                'count'       => 0,
733
-                'bulk_action' => array_merge($def_reg_status_actions, array(
734
-                    'trash_registrations' => __('Trash Registrations', 'event_espresso'),
735
-                )),
736
-            ),
737
-        );
738
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_registrations',
739
-            'espresso_registrations_delete_registration')
740
-        ) {
741
-            $this->_views['incomplete'] = array(
742
-                'slug'        => 'incomplete',
743
-                'label'       => __('Incomplete', 'event_espresso'),
744
-                'count'       => 0,
745
-                'bulk_action' => array(
746
-                    'trash_registrations' => __('Trash Registrations', 'event_espresso'),
747
-                ),
748
-            );
749
-            $this->_views['trash'] = array(
750
-                'slug'        => 'trash',
751
-                'label'       => __('Trash', 'event_espresso'),
752
-                'count'       => 0,
753
-                'bulk_action' => array(
754
-                    'restore_registrations' => __('Restore Registrations', 'event_espresso'),
755
-                    'delete_registrations'  => __('Delete Registrations Permanently', 'event_espresso'),
756
-                ),
757
-            );
758
-        }
759
-    }
760
-
761
-
762
-
763
-    protected function _set_list_table_views_contact_list()
764
-    {
765
-        $this->_views = array(
766
-            'in_use' => array(
767
-                'slug'        => 'in_use',
768
-                'label'       => __('In Use', 'event_espresso'),
769
-                'count'       => 0,
770
-                'bulk_action' => array(
771
-                    'trash_attendees' => __('Move to Trash', 'event_espresso'),
772
-                ),
773
-            ),
774
-        );
775
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts',
776
-            'espresso_registrations_trash_attendees')
777
-        ) {
778
-            $this->_views['trash'] = array(
779
-                'slug'        => 'trash',
780
-                'label'       => __('Trash', 'event_espresso'),
781
-                'count'       => 0,
782
-                'bulk_action' => array(
783
-                    'restore_attendees' => __('Restore from Trash', 'event_espresso'),
784
-                ),
785
-            );
786
-        }
787
-    }
788
-
789
-
790
-
791
-    protected function _registration_legend_items()
792
-    {
793
-        $fc_items = array(
794
-            'star-icon'        => array(
795
-                'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
796
-                'desc'  => __('This is the Primary Registrant', 'event_espresso'),
797
-            ),
798
-            'view_details'     => array(
799
-                'class' => 'dashicons dashicons-clipboard',
800
-                'desc'  => __('View Registration Details', 'event_espresso'),
801
-            ),
802
-            'edit_attendee'    => array(
803
-                'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16',
804
-                'desc'  => __('Edit Contact Details', 'event_espresso'),
805
-            ),
806
-            'view_transaction' => array(
807
-                'class' => 'dashicons dashicons-cart',
808
-                'desc'  => __('View Transaction Details', 'event_espresso'),
809
-            ),
810
-            'view_invoice'     => array(
811
-                'class' => 'dashicons dashicons-media-spreadsheet',
812
-                'desc'  => __('View Transaction Invoice', 'event_espresso'),
813
-            ),
814
-        );
815
-        if (EE_Registry::instance()->CAP->current_user_can('ee_send_message',
816
-            'espresso_registrations_resend_registration')
817
-        ) {
818
-            $fc_items['resend_registration'] = array(
819
-                'class' => 'dashicons dashicons-email-alt',
820
-                'desc'  => __('Resend Registration Details', 'event_espresso'),
821
-            );
822
-        } else {
823
-            $fc_items['blank'] = array('class' => 'blank', 'desc' => '');
824
-        }
825
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
826
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
827
-            if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
828
-                $fc_items['view_related_messages'] = array(
829
-                    'class' => $related_for_icon['css_class'],
830
-                    'desc'  => $related_for_icon['label'],
831
-                );
832
-            }
833
-        }
834
-        $sc_items = array(
835
-            'approved_status'   => array(
836
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
837
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
838
-            ),
839
-            'pending_status'    => array(
840
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
841
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
842
-            ),
843
-            'wait_list'         => array(
844
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
845
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
846
-            ),
847
-            'incomplete_status' => array(
848
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
849
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_incomplete, false, 'sentence'),
850
-            ),
851
-            'not_approved'      => array(
852
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
853
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
854
-            ),
855
-            'declined_status'   => array(
856
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
857
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
858
-            ),
859
-            'cancelled_status'  => array(
860
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
861
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
862
-            ),
863
-        );
864
-        return array_merge($fc_items, $sc_items);
865
-    }
866
-
867
-
868
-
869
-    /***************************************        REGISTRATION OVERVIEW        **************************************/
870
-    /**
871
-     * @throws \EE_Error
872
-     */
873
-    protected function _registrations_overview_list_table()
874
-    {
875
-        $this->_template_args['admin_page_header'] = '';
876
-        $EVT_ID = ! empty($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : 0;
877
-        if ($EVT_ID) {
878
-            if (EE_Registry::instance()->CAP->current_user_can('ee_edit_registrations',
879
-                'espresso_registrations_new_registration', $EVT_ID)
880
-            ) {
881
-                $this->_admin_page_title .= ' ' . $this->get_action_link_or_button('new_registration', 'add-registrant',
882
-                        array('event_id' => $EVT_ID), 'add-new-h2');
883
-            }
884
-            $event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
885
-            if ($event instanceof EE_Event) {
886
-                $this->_template_args['admin_page_header'] = sprintf(__('%s Viewing registrations for the event: %s%s',
887
-                    'event_espresso'), '<h3 style="line-height:1.5em;">',
888
-                    '<br /><a href="' . EE_Admin_Page::add_query_args_and_nonce(array(
889
-                        'action' => 'edit',
890
-                        'post'   => $event->ID(),
891
-                    ), EVENTS_ADMIN_URL) . '">&nbsp;' . $event->get('EVT_name') . '&nbsp;</a>&nbsp;', '</h3>');
892
-            }
893
-            $DTT_ID = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0;
894
-            $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
895
-            if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') {
896
-                $this->_template_args['admin_page_header'] = substr($this->_template_args['admin_page_header'], 0, -5);
897
-                $this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
898
-                $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
899
-                $this->_template_args['admin_page_header'] .= $datetime->name();
900
-                $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
901
-                $this->_template_args['admin_page_header'] .= '</span></h3>';
902
-            }
903
-        }
904
-        $this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items());
905
-        $this->display_admin_list_table_page_with_no_sidebar();
906
-    }
907
-
908
-
909
-
910
-    /**
911
-     * This sets the _registration property for the registration details screen
912
-     *
913
-     * @access private
914
-     * @return bool
915
-     */
916
-    private function _set_registration_object()
917
-    {
918
-        //get out if we've already set the object
919
-        if (is_object($this->_registration)) {
920
-            return true;
921
-        }
922
-        $REG = EEM_Registration::instance();
923
-        $REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
924
-        if ($this->_registration = $REG->get_one_by_ID($REG_ID)) {
925
-            return true;
926
-        } else {
927
-            $error_msg = sprintf(__('An error occurred and the details for Registration ID #%s could not be retrieved.',
928
-                'event_espresso'), $REG_ID);
929
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
930
-            $this->_registration = null;
931
-            return false;
932
-        }
933
-    }
934
-
935
-
936
-
937
-    /**
938
-     * get registrations for given parameters (used by list table)
939
-     *
940
-     * @param  int     $per_page   how many registrations displayed per page
941
-     * @param  boolean $count      return the count or objects
942
-     * @param  boolean $this_month whether to return for just this month
943
-     * @param  boolean $today      whether to return results for just today
944
-     * @throws \EE_Error
945
-     * @return mixed (int|array)  int = count || array of registration objects
946
-     */
947
-    public function get_registrations($per_page = 10, $count = false, $this_month = false, $today = false)
948
-    {
949
-        $EVT_ID = ! empty($this->_req_data['event_id']) && $this->_req_data['event_id'] > 0
950
-            ? absint($this->_req_data['event_id']) : false;
951
-        $CAT_ID = ! empty($this->_req_data['EVT_CAT']) && (int)$this->_req_data['EVT_CAT'] > 0
952
-            ? absint($this->_req_data['EVT_CAT']) : false;
953
-        $DTT_ID = isset($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : null;
954
-        $reg_status = ! empty($this->_req_data['_reg_status']) ? sanitize_text_field($this->_req_data['_reg_status'])
955
-            : false;
956
-        $month_range = ! empty($this->_req_data['month_range']) ? sanitize_text_field($this->_req_data['month_range'])
957
-            : false;//should be like 2013-april
958
-        $today_a = ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'today' ? true : false;
959
-        $this_month_a = ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'month' ? true : false;
960
-        $start_date = false;
961
-        $end_date = false;
962
-        $_where = array();
963
-        $trash = ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'trash' ? true : false;
964
-        $incomplete = ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'incomplete' ? true : false;
965
-        //set orderby
966
-        $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
967
-        switch ($this->_req_data['orderby']) {
968
-            case '_REG_ID':
969
-                $orderby = 'REG_ID';
970
-                break;
971
-            case '_Reg_status':
972
-                $orderby = 'STS_ID';
973
-                break;
974
-            case 'ATT_fname':
975
-                $orderby = 'Attendee.ATT_lname';
976
-                break;
977
-            case 'event_name':
978
-                $orderby = 'Event.EVT_name';
979
-                break;
980
-            case 'DTT_EVT_start':
981
-                $orderby = 'Event.Datetime.DTT_EVT_start';
982
-                break;
983
-            default: //'REG_date'
984
-                $orderby = 'REG_date';
985
-        }
986
-        $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
987
-            : 'DESC';
988
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
989
-            ? $this->_req_data['paged'] : 1;
990
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
991
-            ? $this->_req_data['perpage'] : $per_page;
992
-        $offset = ($current_page - 1) * $per_page;
993
-        $limit = $count ? null : array($offset, $per_page);
994
-        if ($EVT_ID) {
995
-            $_where['EVT_ID'] = $EVT_ID;
996
-        }
997
-        if ($CAT_ID) {
998
-            $_where['Event.Term_Taxonomy.term_id'] = $CAT_ID;
999
-        }
1000
-        //if DTT is included we filter by that datetime.
1001
-        if ($DTT_ID) {
1002
-            $_where['Ticket.Datetime.DTT_ID'] = $DTT_ID;
1003
-        }
1004
-        if ($incomplete) {
1005
-            $_where['STS_ID'] = EEM_Registration::status_id_incomplete;
1006
-        } else if ( ! $trash) {
1007
-            $_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
1008
-        }
1009
-        if ($reg_status) {
1010
-            $_where['STS_ID'] = $reg_status;
1011
-        }
1012
-        $this_year_r = date('Y', current_time('timestamp'));
1013
-        $time_start = ' 00:00:00';
1014
-        $time_end = ' 23:59:59';
1015
-        if ($today_a || $today) {
1016
-            $curdate = date('Y-m-d', current_time('timestamp'));
1017
-            $_where['REG_date'] = array(
1018
-                'BETWEEN',
1019
-                array(
1020
-                    EEM_Registration::instance()
1021
-                                    ->convert_datetime_for_query('REG_date', $curdate . $time_start, 'Y-m-d H:i:s'),
1022
-                    EEM_Registration::instance()
1023
-                                    ->convert_datetime_for_query('REG_date', $curdate . $time_end, 'Y-m-d H:i:s'),
1024
-                ),
1025
-            );
1026
-        } elseif ($this_month_a || $this_month) {
1027
-            $this_month_r = date('m', current_time('timestamp'));
1028
-            $days_this_month = date('t', current_time('timestamp'));
1029
-            $_where['REG_date'] = array(
1030
-                'BETWEEN',
1031
-                array(
1032
-                    EEM_Registration::instance()
1033
-                                    ->convert_datetime_for_query('REG_date',
1034
-                                        $this_year_r . '-' . $this_month_r . '-01' . ' ' . $time_start, 'Y-m-d H:i:s'),
1035
-                    EEM_Registration::instance()
1036
-                                    ->convert_datetime_for_query('REG_date',
1037
-                                        $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' ' . $time_end,
1038
-                                        'Y-m-d H:i:s'),
1039
-                ),
1040
-            );
1041
-        } elseif ($month_range) {
1042
-            $pieces = explode(' ', $this->_req_data['month_range'], 3);
1043
-            $month_r = ! empty($pieces[0]) ? date('m', strtotime($month_range)) : '';
1044
-            $year_r = ! empty($pieces[1]) ? $pieces[1] : '';
1045
-            $days_in_month = date('t', strtotime($year_r . '-' . $month_r . '-' . '01'));
1046
-            $_where['REG_date'] = array(
1047
-                'BETWEEN',
1048
-                array(
1049
-                    EEM_Registration::instance()
1050
-                                    ->convert_datetime_for_query('REG_date', $year_r . '-' . $month_r . '-01 00:00:00',
1051
-                                        'Y-m-d H:i:s'),
1052
-                    EEM_Registration::instance()
1053
-                                    ->convert_datetime_for_query('REG_date',
1054
-                                        $year_r . '-' . $month_r . '-' . $days_in_month . ' 23:59:59', 'Y-m-d H:i:s'),
1055
-                ),
1056
-            );
1057
-        } elseif ($start_date && $end_date) {
1058
-            throw new EE_Error("not yet supported");
1059
-        } elseif ($start_date) {
1060
-            throw new EE_Error("not yet supported");
1061
-        } elseif ($end_date) {
1062
-            throw new EE_Error("not yet supported");
1063
-        }
1064
-        if ( ! empty($this->_req_data['s'])) {
1065
-            $sstr = '%' . $this->_req_data['s'] . '%';
1066
-            $_where['OR'] = array(
1067
-                'Event.EVT_name'                          => array('LIKE', $sstr),
1068
-                'Event.EVT_desc'                          => array('LIKE', $sstr),
1069
-                'Event.EVT_short_desc'                    => array('LIKE', $sstr),
1070
-                'Attendee.ATT_full_name'                  => array('LIKE', $sstr),
1071
-                'Attendee.ATT_fname'                      => array('LIKE', $sstr),
1072
-                'Attendee.ATT_lname'                      => array('LIKE', $sstr),
1073
-                'Attendee.ATT_short_bio'                  => array('LIKE', $sstr),
1074
-                'Attendee.ATT_email'                      => array('LIKE', $sstr),
1075
-                'Attendee.ATT_address'                    => array('LIKE', $sstr),
1076
-                'Attendee.ATT_address2'                   => array('LIKE', $sstr),
1077
-                'Attendee.ATT_city'                       => array('LIKE', $sstr),
1078
-                'REG_final_price'                         => array('LIKE', $sstr),
1079
-                'REG_code'                                => array('LIKE', $sstr),
1080
-                'REG_count'                               => array('LIKE', $sstr),
1081
-                'REG_group_size'                          => array('LIKE', $sstr),
1082
-                'Ticket.TKT_name'                         => array('LIKE', $sstr),
1083
-                'Ticket.TKT_description'                  => array('LIKE', $sstr),
1084
-                'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $sstr),
1085
-            );
1086
-        }
1087
-        //capability checks
1088
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'get_registrations')) {
1089
-            $_where['AND'] = array(
1090
-                'Event.EVT_wp_user' => get_current_user_id(),
1091
-            );
1092
-        }
1093
-        if ($count) {
1094
-            if ($trash) {
1095
-                return EEM_Registration::instance()->count_deleted(array($_where));
1096
-            } else if ($incomplete) {
1097
-                return EEM_Registration::instance()->count(array($_where));
1098
-            } else {
1099
-                return EEM_Registration::instance()->count(array(
1100
-                    $_where,
1101
-                    'default_where_conditions' => 'this_model_only',
1102
-                ));
1103
-            }
1104
-        } else {
1105
-            //make sure we remove default where conditions cause all registrations matching query are returned
1106
-            $query_params = array(
1107
-                $_where,
1108
-                'order_by'                 => array($orderby => $sort),
1109
-                'default_where_conditions' => 'this_model_only',
1110
-            );
1111
-            if ($per_page !== -1) {
1112
-                $query_params['limit'] = $limit;
1113
-            }
1114
-            $registrations = $trash ? EEM_Registration::instance()->get_all_deleted($query_params)
1115
-                : EEM_Registration::instance()->get_all($query_params);
1116
-            if ($EVT_ID
1117
-                && isset($registrations[0])
1118
-                && $registrations[0] instanceof EE_Registration
1119
-                && $registrations[0]->event_obj()
1120
-            ) {
1121
-                $first_registration = $registrations[0];
1122
-                //EEH_Debug_Tools::printr( $registrations[0], '$registrations  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
1123
-                $event_name = $first_registration->event_obj()->name();
1124
-                $event_date = $first_registration->date_obj()
1125
-                                                 ->start_date_and_time('l F j, Y,',
1126
-                                                     'g:i:s a');// isset( $registrations[0]->DTT_EVT_start ) ? date( 'l F j, Y,    g:i:s a', $registrations[0]->DTT_EVT_start ) : '';
1127
-                // edit event link
1128
-                if ($event_name != '') {
1129
-                    $edit_event_url = self::add_query_args_and_nonce(array(
1130
-                        'action' => 'edit_event',
1131
-                        'EVT_ID' => $EVT_ID,
1132
-                    ), EVENTS_ADMIN_URL);
1133
-                    $edit_event_lnk = '<a href="' . $edit_event_url . '" title="' . esc_attr__('Edit ',
1134
-                            'event_espresso') . $event_name . '">' . __('Edit Event', 'event_espresso') . '</a>';
1135
-                    $event_name .= ' <span class="admin-page-header-edit-lnk not-bold">' . $edit_event_lnk . '</span>';
1136
-                }
1137
-                $back_2_reg_url = self::add_query_args_and_nonce(array('action' => 'default'), REG_ADMIN_URL);
1138
-                $back_2_reg_lnk = '<a href="'
1139
-                                  . $back_2_reg_url
1140
-                                  . '" title="'
1141
-                                  . esc_attr__('click to return to viewing all registrations ', 'event_espresso')
1142
-                                  . '">&laquo; '
1143
-                                  . __('Back to All Registrations', 'event_espresso')
1144
-                                  . '</a>';
1145
-                $this->_template_args['before_admin_page_content'] = '
27
+	/**
28
+	 * @var EE_Registration
29
+	 */
30
+	private $_registration;
31
+
32
+	/**
33
+	 * @var EE_Event
34
+	 */
35
+	private $_reg_event;
36
+
37
+	/**
38
+	 * @var EE_Session
39
+	 */
40
+	private        $_session;
41
+
42
+	private static $_reg_status;
43
+
44
+	/**
45
+	 * Form for displaying the custom questions for this registration.
46
+	 * This gets used a few times throughout the request so its best to cache it
47
+	 *
48
+	 * @var EE_Registration_Custom_Questions_Form
49
+	 */
50
+	protected $_reg_custom_questions_form = null;
51
+
52
+
53
+
54
+	/**
55
+	 *        constructor
56
+	 *
57
+	 * @Constructor
58
+	 * @access public
59
+	 * @param bool $routing
60
+	 * @return Registrations_Admin_Page
61
+	 */
62
+	public function __construct($routing = true)
63
+	{
64
+		parent::__construct($routing);
65
+		add_action('wp_loaded', array($this, 'wp_loaded'));
66
+	}
67
+
68
+
69
+
70
+	public function wp_loaded()
71
+	{
72
+		// when adding a new registration...
73
+		if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
74
+			EE_System::do_not_cache();
75
+			if ( ! isset($this->_req_data['processing_registration'])
76
+				 || absint($this->_req_data['processing_registration']) !== 1
77
+			) {
78
+				// and it's NOT the attendee information reg step
79
+				// force cookie expiration by setting time to last week
80
+				setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
81
+				// and update the global
82
+				$_COOKIE['ee_registration_added'] = 0;
83
+			}
84
+		}
85
+	}
86
+
87
+
88
+
89
+	protected function _init_page_props()
90
+	{
91
+		$this->page_slug = REG_PG_SLUG;
92
+		$this->_admin_base_url = REG_ADMIN_URL;
93
+		$this->_admin_base_path = REG_ADMIN;
94
+		$this->page_label = __('Registrations', 'event_espresso');
95
+		$this->_cpt_routes = array(
96
+			'add_new_attendee' => 'espresso_attendees',
97
+			'edit_attendee'    => 'espresso_attendees',
98
+			'insert_attendee'  => 'espresso_attendees',
99
+			'update_attendee'  => 'espresso_attendees',
100
+		);
101
+		$this->_cpt_model_names = array(
102
+			'add_new_attendee' => 'EEM_Attendee',
103
+			'edit_attendee'    => 'EEM_Attendee',
104
+		);
105
+		$this->_cpt_edit_routes = array(
106
+			'espresso_attendees' => 'edit_attendee',
107
+		);
108
+		$this->_pagenow_map = array(
109
+			'add_new_attendee' => 'post-new.php',
110
+			'edit_attendee'    => 'post.php',
111
+			'trash'            => 'post.php',
112
+		);
113
+		add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10);
114
+		//add filters so that the comment urls don't take users to a confusing 404 page
115
+		add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3);
116
+	}
117
+
118
+
119
+
120
+	public function clear_comment_link($link, $comment, $args)
121
+	{
122
+		//gotta make sure this only happens on this route
123
+		$post_type = get_post_type($comment->comment_post_ID);
124
+		if ($post_type === 'espresso_attendees') {
125
+			return '#commentsdiv';
126
+		}
127
+		return $link;
128
+	}
129
+
130
+
131
+
132
+	protected function _ajax_hooks()
133
+	{
134
+		//todo: all hooks for registrations ajax goes in here
135
+		add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status'));
136
+	}
137
+
138
+
139
+
140
+	protected function _define_page_props()
141
+	{
142
+		$this->_admin_page_title = $this->page_label;
143
+		$this->_labels = array(
144
+			'buttons'                      => array(
145
+				'add-registrant'      => __('Add New Registration', 'event_espresso'),
146
+				'add-attendee'        => __('Add Contact', 'event_espresso'),
147
+				'edit'                => __('Edit Contact', 'event_espresso'),
148
+				'report'              => __("Event Registrations CSV Report", "event_espresso"),
149
+				'report_all'          => __('All Registrations CSV Report', 'event_espresso'),
150
+				'contact_list_report' => __('Contact List Report', 'event_espresso'),
151
+				'contact_list_export' => __("Export Data", "event_espresso"),
152
+			),
153
+			'publishbox'                   => array(
154
+				'add_new_attendee' => __("Add Contact Record", 'event_espresso'),
155
+				'edit_attendee'    => __("Update Contact Record", 'event_espresso'),
156
+			),
157
+			'hide_add_button_on_cpt_route' => array(
158
+				'edit_attendee' => true,
159
+			),
160
+		);
161
+	}
162
+
163
+
164
+
165
+	/**
166
+	 *        grab url requests and route them
167
+	 *
168
+	 * @access private
169
+	 * @return void
170
+	 */
171
+	public function _set_page_routes()
172
+	{
173
+		$this->_get_registration_status_array();
174
+		$reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
175
+			? $this->_req_data['_REG_ID'] : 0;
176
+		$att_id = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID'])
177
+			? $this->_req_data['ATT_ID'] : 0;
178
+		$att_id = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post']) ? $this->_req_data['post']
179
+			: $att_id;
180
+		$this->_page_routes = array(
181
+			'default' => array(
182
+				'func'       => '_registrations_overview_list_table',
183
+				'capability' => 'ee_read_registrations',
184
+			),
185
+			'view_registration' => array(
186
+				'func'       => '_registration_details',
187
+				'capability' => 'ee_read_registration',
188
+				'obj_id'     => $reg_id,
189
+			),
190
+			'edit_registration' => array(
191
+				'func'               => '_update_attendee_registration_form',
192
+				'noheader'           => true,
193
+				'headers_sent_route' => 'view_registration',
194
+				'capability'         => 'ee_edit_registration',
195
+				'obj_id'             => $reg_id,
196
+				'_REG_ID'            => $reg_id,
197
+			),
198
+			'trash_registrations' => array(
199
+				'func'       => '_trash_or_restore_registrations',
200
+				'args'       => array('trash' => true),
201
+				'noheader'   => true,
202
+				'capability' => 'ee_delete_registrations',
203
+			),
204
+			'restore_registrations' => array(
205
+				'func'       => '_trash_or_restore_registrations',
206
+				'args'       => array('trash' => false),
207
+				'noheader'   => true,
208
+				'capability' => 'ee_delete_registrations',
209
+			),
210
+			'delete_registrations' => array(
211
+				'func'       => '_delete_registrations',
212
+				'noheader'   => true,
213
+				'capability' => 'ee_delete_registrations',
214
+			),
215
+			'new_registration' => array(
216
+				'func'       => 'new_registration',
217
+				'capability' => 'ee_edit_registrations',
218
+			),
219
+			'process_reg_step' => array(
220
+				'func'       => 'process_reg_step',
221
+				'noheader'   => true,
222
+				'capability' => 'ee_edit_registrations',
223
+			),
224
+			'redirect_to_txn' => array(
225
+				'func'       => 'redirect_to_txn',
226
+				'noheader'   => true,
227
+				'capability' => 'ee_edit_registrations',
228
+			),
229
+			'change_reg_status' => array(
230
+				'func'       => '_change_reg_status',
231
+				'noheader'   => true,
232
+				'capability' => 'ee_edit_registration',
233
+				'obj_id'     => $reg_id,
234
+			),
235
+			'approve_registration' => array(
236
+				'func'       => 'approve_registration',
237
+				'noheader'   => true,
238
+				'capability' => 'ee_edit_registration',
239
+				'obj_id'     => $reg_id,
240
+			),
241
+			'approve_and_notify_registration' => array(
242
+				'func'       => 'approve_registration',
243
+				'noheader'   => true,
244
+				'args'       => array(true),
245
+				'capability' => 'ee_edit_registration',
246
+				'obj_id'     => $reg_id,
247
+			),
248
+			'decline_registration' => array(
249
+				'func'       => 'decline_registration',
250
+				'noheader'   => true,
251
+				'capability' => 'ee_edit_registration',
252
+				'obj_id'     => $reg_id,
253
+			),
254
+			'decline_and_notify_registration' => array(
255
+				'func'       => 'decline_registration',
256
+				'noheader'   => true,
257
+				'args'       => array(true),
258
+				'capability' => 'ee_edit_registration',
259
+				'obj_id'     => $reg_id,
260
+			),
261
+			'pending_registration' => array(
262
+				'func'       => 'pending_registration',
263
+				'noheader'   => true,
264
+				'capability' => 'ee_edit_registration',
265
+				'obj_id'     => $reg_id,
266
+			),
267
+			'pending_and_notify_registration' => array(
268
+				'func'       => 'pending_registration',
269
+				'noheader'   => true,
270
+				'args'       => array(true),
271
+				'capability' => 'ee_edit_registration',
272
+				'obj_id'     => $reg_id,
273
+			),
274
+			'no_approve_registration' => array(
275
+				'func'       => 'not_approve_registration',
276
+				'noheader'   => true,
277
+				'capability' => 'ee_edit_registration',
278
+				'obj_id'     => $reg_id,
279
+			),
280
+			'no_approve_and_notify_registration' => array(
281
+				'func'       => 'not_approve_registration',
282
+				'noheader'   => true,
283
+				'args'       => array(true),
284
+				'capability' => 'ee_edit_registration',
285
+				'obj_id'     => $reg_id,
286
+			),
287
+			'cancel_registration' => array(
288
+				'func'       => 'cancel_registration',
289
+				'noheader'   => true,
290
+				'capability' => 'ee_edit_registration',
291
+				'obj_id'     => $reg_id,
292
+			),
293
+			'cancel_and_notify_registration' => array(
294
+				'func'       => 'cancel_registration',
295
+				'noheader'   => true,
296
+				'args'       => array(true),
297
+				'capability' => 'ee_edit_registration',
298
+				'obj_id'     => $reg_id,
299
+			),
300
+			'contact_list' => array(
301
+				'func'       => '_attendee_contact_list_table',
302
+				'capability' => 'ee_read_contacts',
303
+			),
304
+			'add_new_attendee' => array(
305
+				'func' => '_create_new_cpt_item',
306
+				'args' => array(
307
+					'new_attendee' => true,
308
+					'capability'   => 'ee_edit_contacts',
309
+				),
310
+			),
311
+			'edit_attendee' => array(
312
+				'func'       => '_edit_cpt_item',
313
+				'capability' => 'ee_edit_contacts',
314
+				'obj_id'     => $att_id,
315
+			),
316
+			'duplicate_attendee' => array(
317
+				'func'       => '_duplicate_attendee',
318
+				'noheader'   => true,
319
+				'capability' => 'ee_edit_contacts',
320
+				'obj_id'     => $att_id,
321
+			),
322
+			'insert_attendee' => array(
323
+				'func'       => '_insert_or_update_attendee',
324
+				'args'       => array(
325
+					'new_attendee' => true,
326
+				),
327
+				'noheader'   => true,
328
+				'capability' => 'ee_edit_contacts',
329
+			),
330
+			'update_attendee' => array(
331
+				'func'       => '_insert_or_update_attendee',
332
+				'args'       => array(
333
+					'new_attendee' => false,
334
+				),
335
+				'noheader'   => true,
336
+				'capability' => 'ee_edit_contacts',
337
+				'obj_id'     => $att_id,
338
+			),
339
+			'trash_attendees' => array(
340
+				'func'       => '_trash_or_restore_attendees',
341
+				'args'       => array(
342
+					'trash' => true,
343
+				),
344
+				'noheader'   => true,
345
+				'capability' => 'ee_delete_contacts',
346
+				'obj_id'     => $att_id,
347
+			),
348
+			'restore_attendees'    => array(
349
+				'func'       => '_trash_or_restore_attendees',
350
+				'args'       => array(
351
+					'trash' => false,
352
+				),
353
+				'noheader'   => true,
354
+				'capability' => 'ee_delete_contacts',
355
+				'obj_id'     => $att_id,
356
+			),
357
+			'resend_registration'  => array(
358
+				'func'       => '_resend_registration',
359
+				'noheader'   => true,
360
+				'capability' => 'ee_send_message',
361
+			),
362
+			'registrations_report' => array(
363
+				'func'       => '_registrations_report',
364
+				'noheader'   => true,
365
+				'capability' => 'ee_read_registrations',
366
+			),
367
+			'contact_list_export'  => array(
368
+				'func'       => '_contact_list_export',
369
+				'noheader'   => true,
370
+				'capability' => 'export',
371
+			),
372
+			'contact_list_report'  => array(
373
+				'func'       => '_contact_list_report',
374
+				'noheader'   => true,
375
+				'capability' => 'ee_read_contacts',
376
+			),
377
+		);
378
+	}
379
+
380
+
381
+
382
+	protected function _set_page_config()
383
+	{
384
+		$this->_page_config = array(
385
+			'default' => array(
386
+				'nav'           => array(
387
+					'label' => __('Overview', 'event_espresso'),
388
+					'order' => 5,
389
+				),
390
+				'help_tabs'     => array(
391
+					'registrations_overview_help_tab'                       => array(
392
+						'title'    => __('Registrations Overview', 'event_espresso'),
393
+						'filename' => 'registrations_overview',
394
+					),
395
+					'registrations_overview_table_column_headings_help_tab' => array(
396
+						'title'    => __('Registrations Table Column Headings', 'event_espresso'),
397
+						'filename' => 'registrations_overview_table_column_headings',
398
+					),
399
+					'registrations_overview_filters_help_tab'               => array(
400
+						'title'    => __('Registration Filters', 'event_espresso'),
401
+						'filename' => 'registrations_overview_filters',
402
+					),
403
+					'registrations_overview_views_help_tab'                 => array(
404
+						'title'    => __('Registration Views', 'event_espresso'),
405
+						'filename' => 'registrations_overview_views',
406
+					),
407
+					'registrations_regoverview_other_help_tab'              => array(
408
+						'title'    => __('Registrations Other', 'event_espresso'),
409
+						'filename' => 'registrations_overview_other',
410
+					),
411
+				),
412
+				'help_tour'     => array('Registration_Overview_Help_Tour'),
413
+				'qtips'         => array('Registration_List_Table_Tips'),
414
+				'list_table'    => 'EE_Registrations_List_Table',
415
+				'require_nonce' => false,
416
+			),
417
+			'view_registration' => array(
418
+				'nav'           => array(
419
+					'label'      => __('REG Details', 'event_espresso'),
420
+					'order'      => 15,
421
+					'url'        => isset($this->_req_data['_REG_ID'])
422
+						? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url)
423
+						: $this->_admin_base_url,
424
+					'persistent' => false,
425
+				),
426
+				'help_tabs'     => array(
427
+					'registrations_details_help_tab'                    => array(
428
+						'title'    => __('Registration Details', 'event_espresso'),
429
+						'filename' => 'registrations_details',
430
+					),
431
+					'registrations_details_table_help_tab'              => array(
432
+						'title'    => __('Registration Details Table', 'event_espresso'),
433
+						'filename' => 'registrations_details_table',
434
+					),
435
+					'registrations_details_form_answers_help_tab'       => array(
436
+						'title'    => __('Registration Form Answers', 'event_espresso'),
437
+						'filename' => 'registrations_details_form_answers',
438
+					),
439
+					'registrations_details_registrant_details_help_tab' => array(
440
+						'title'    => __('Contact Details', 'event_espresso'),
441
+						'filename' => 'registrations_details_registrant_details',
442
+					),
443
+				),
444
+				'help_tour'     => array('Registration_Details_Help_Tour'),
445
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes,
446
+					array('_registration_details_metaboxes')),
447
+				'require_nonce' => false,
448
+			),
449
+			'new_registration' => array(
450
+				'nav'           => array(
451
+					'label'      => __('Add New Registration', 'event_espresso'),
452
+					'url'        => '#',
453
+					'order'      => 15,
454
+					'persistent' => false,
455
+				),
456
+				'metaboxes'     => $this->_default_espresso_metaboxes,
457
+				'labels'        => array(
458
+					'publishbox' => __('Save Registration', 'event_espresso'),
459
+				),
460
+				'require_nonce' => false,
461
+			),
462
+			'add_new_attendee' => array(
463
+				'nav'           => array(
464
+					'label'      => __('Add Contact', 'event_espresso'),
465
+					'order'      => 15,
466
+					'persistent' => false,
467
+				),
468
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes,
469
+					array('_publish_post_box', 'attendee_editor_metaboxes')),
470
+				'require_nonce' => false,
471
+			),
472
+			'edit_attendee' => array(
473
+				'nav'           => array(
474
+					'label'      => __('Edit Contact', 'event_espresso'),
475
+					'order'      => 15,
476
+					'persistent' => false,
477
+					'url'        => isset($this->_req_data['ATT_ID'])
478
+						? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url)
479
+						: $this->_admin_base_url,
480
+				),
481
+				'metaboxes'     => array('attendee_editor_metaboxes'),
482
+				'require_nonce' => false,
483
+			),
484
+			'contact_list' => array(
485
+				'nav'           => array(
486
+					'label' => __('Contact List', 'event_espresso'),
487
+					'order' => 20,
488
+				),
489
+				'list_table'    => 'EE_Attendee_Contact_List_Table',
490
+				'help_tabs'     => array(
491
+					'registrations_contact_list_help_tab'                       => array(
492
+						'title'    => __('Registrations Contact List', 'event_espresso'),
493
+						'filename' => 'registrations_contact_list',
494
+					),
495
+					'registrations_contact-list_table_column_headings_help_tab' => array(
496
+						'title'    => __('Contact List Table Column Headings', 'event_espresso'),
497
+						'filename' => 'registrations_contact_list_table_column_headings',
498
+					),
499
+					'registrations_contact_list_views_help_tab'                 => array(
500
+						'title'    => __('Contact List Views', 'event_espresso'),
501
+						'filename' => 'registrations_contact_list_views',
502
+					),
503
+					'registrations_contact_list_other_help_tab'                 => array(
504
+						'title'    => __('Contact List Other', 'event_espresso'),
505
+						'filename' => 'registrations_contact_list_other',
506
+					),
507
+				),
508
+				'help_tour'     => array('Contact_List_Help_Tour'),
509
+				'metaboxes'     => array(),
510
+				'require_nonce' => false,
511
+			),
512
+			//override default cpt routes
513
+			'create_new'   => '',
514
+			'edit'         => '',
515
+		);
516
+	}
517
+
518
+
519
+
520
+	/**
521
+	 * The below methods aren't used by this class currently
522
+	 */
523
+	protected function _add_screen_options()
524
+	{
525
+	}
526
+
527
+
528
+
529
+	protected function _add_feature_pointers()
530
+	{
531
+	}
532
+
533
+
534
+
535
+	public function admin_init()
536
+	{
537
+		EE_Registry::$i18n_js_strings['update_att_qstns'] = __('click "Update Registration Questions" to save your changes',
538
+			'event_espresso');
539
+	}
540
+
541
+
542
+
543
+	public function admin_notices()
544
+	{
545
+	}
546
+
547
+
548
+
549
+	public function admin_footer_scripts()
550
+	{
551
+	}
552
+
553
+
554
+
555
+	/**
556
+	 *        get list of registration statuses
557
+	 *
558
+	 * @access private
559
+	 * @return void
560
+	 */
561
+	private function _get_registration_status_array()
562
+	{
563
+		self::$_reg_status = EEM_Registration::reg_status_array(array(), true);
564
+	}
565
+
566
+
567
+
568
+	protected function _add_screen_options_default()
569
+	{
570
+		$this->_per_page_screen_option();
571
+	}
572
+
573
+
574
+
575
+	protected function _add_screen_options_contact_list()
576
+	{
577
+		$page_title = $this->_admin_page_title;
578
+		$this->_admin_page_title = __("Contacts", 'event_espresso');
579
+		$this->_per_page_screen_option();
580
+		$this->_admin_page_title = $page_title;
581
+	}
582
+
583
+
584
+
585
+	public function load_scripts_styles()
586
+	{
587
+		//style
588
+		//wp_register_style('espresso_attendees', ATT_ASSETS_URL . 'espresso_attendees_admin.css', array(), EVENT_ESPRESSO_VERSION );
589
+		wp_register_style('espresso_reg', REG_ASSETS_URL . 'espresso_registrations_admin.css', array('ee-admin-css'),
590
+			EVENT_ESPRESSO_VERSION);
591
+		wp_enqueue_style('espresso_reg');
592
+		//script
593
+		wp_register_script('espresso_reg', REG_ASSETS_URL . 'espresso_registrations_admin.js',
594
+			array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'), EVENT_ESPRESSO_VERSION, true);
595
+		wp_enqueue_script('espresso_reg');
596
+	}
597
+
598
+
599
+
600
+	public function load_scripts_styles_edit_attendee()
601
+	{
602
+		//stuff to only show up on our attendee edit details page.
603
+		$attendee_details_translations = array(
604
+			'att_publish_text' => sprintf(__('Created on: <b>%1$s</b>', 'event_espresso'),
605
+				$this->_cpt_model_obj->get_datetime('ATT_created')),
606
+		);
607
+		wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
608
+		wp_enqueue_script('jquery-validate');
609
+	}
610
+
611
+
612
+
613
+	public function load_scripts_styles_view_registration()
614
+	{
615
+		//styles
616
+		wp_enqueue_style('espresso-ui-theme');
617
+		//scripts
618
+		$this->_get_reg_custom_questions_form($this->_registration->ID());
619
+		$this->_reg_custom_questions_form->wp_enqueue_scripts(true);
620
+	}
621
+
622
+
623
+
624
+	public function load_scripts_styles_contact_list()
625
+	{
626
+		wp_deregister_style('espresso_reg');
627
+		wp_register_style('espresso_att', REG_ASSETS_URL . 'espresso_attendees_admin.css', array('ee-admin-css'),
628
+			EVENT_ESPRESSO_VERSION);
629
+		wp_enqueue_style('espresso_att');
630
+	}
631
+
632
+
633
+
634
+	public function load_scripts_styles_new_registration()
635
+	{
636
+		wp_register_script('ee-spco-for-admin', REG_ASSETS_URL . 'spco_for_admin.js', array('underscore', 'jquery'),
637
+			EVENT_ESPRESSO_VERSION, true);
638
+		wp_enqueue_script('ee-spco-for-admin');
639
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
640
+		EE_Form_Section_Proper::wp_enqueue_scripts();
641
+		EED_Ticket_Selector::load_tckt_slctr_assets();
642
+		EE_Datepicker_Input::enqueue_styles_and_scripts();
643
+	}
644
+
645
+
646
+
647
+	public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
648
+	{
649
+		add_filter('FHEE_load_EE_messages', '__return_true');
650
+	}
651
+
652
+
653
+
654
+	public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
655
+	{
656
+		add_filter('FHEE_load_EE_messages', '__return_true');
657
+	}
658
+
659
+
660
+
661
+	protected function _set_list_table_views_default()
662
+	{
663
+		//for notification related bulk actions we need to make sure only active messengers have an option.
664
+		EED_Messages::set_autoloaders();
665
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
666
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
667
+		$active_mts = $message_resource_manager->list_of_active_message_types();
668
+		//key= bulk_action_slug, value= message type.
669
+		$match_array = array(
670
+			'approve_registration'    => 'registration',
671
+			'decline_registration'    => 'declined_registration',
672
+			'pending_registration'    => 'pending_approval',
673
+			'no_approve_registration' => 'not_approved_registration',
674
+			'cancel_registration'     => 'cancelled_registration',
675
+		);
676
+		/** setup reg status bulk actions **/
677
+		$def_reg_status_actions['approve_registration'] = __('Approve Registrations', 'event_espresso');
678
+		if (in_array($match_array['approve_registration'], $active_mts)
679
+			&& EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
680
+		) {
681
+			$def_reg_status_actions['approve_and_notify_registration'] = __('Approve and Notify Registrations',
682
+				'event_espresso');
683
+		}
684
+		$def_reg_status_actions['decline_registration'] = __('Decline Registrations', 'event_espresso');
685
+		if (in_array($match_array['decline_registration'], $active_mts)
686
+			&& EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
687
+		) {
688
+			$def_reg_status_actions['decline_and_notify_registration'] = __('Decline and Notify Registrations',
689
+				'event_espresso');
690
+		}
691
+		$def_reg_status_actions['pending_registration'] = __('Set Registrations to Pending Payment', 'event_espresso');
692
+		if (in_array($match_array['pending_registration'], $active_mts)
693
+			&& EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
694
+		) {
695
+			$def_reg_status_actions['pending_and_notify_registration'] = __('Set Registrations to Pending Payment and Notify',
696
+				'event_espresso');
697
+		}
698
+		$def_reg_status_actions['no_approve_registration'] = __('Set Registrations to Not Approved', 'event_espresso');
699
+		if (in_array($match_array['no_approve_registration'], $active_mts)
700
+			&& EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
701
+		) {
702
+			$def_reg_status_actions['no_approve_and_notify_registration'] = __('Set Registrations to Not Approved and Notify',
703
+				'event_espresso');
704
+		}
705
+		$def_reg_status_actions['cancel_registration'] = __('Cancel Registrations', 'event_espresso');
706
+		if (in_array($match_array['cancel_registration'], $active_mts)
707
+			&& EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
708
+		) {
709
+			$def_reg_status_actions['cancel_and_notify_registration'] = __('Cancel Registrations and Notify',
710
+				'event_espresso');
711
+		}
712
+		$this->_views = array(
713
+			'all'   => array(
714
+				'slug'        => 'all',
715
+				'label'       => __('View All Registrations', 'event_espresso'),
716
+				'count'       => 0,
717
+				'bulk_action' => array_merge($def_reg_status_actions, array(
718
+					'trash_registrations' => __('Trash Registrations', 'event_espresso'),
719
+				)),
720
+			),
721
+			'month' => array(
722
+				'slug'        => 'month',
723
+				'label'       => __('This Month', 'event_espresso'),
724
+				'count'       => 0,
725
+				'bulk_action' => array_merge($def_reg_status_actions, array(
726
+					'trash_registrations' => __('Trash Registrations', 'event_espresso'),
727
+				)),
728
+			),
729
+			'today' => array(
730
+				'slug'        => 'today',
731
+				'label'       => sprintf(__('Today - %s', 'event_espresso'), date('M d, Y', current_time('timestamp'))),
732
+				'count'       => 0,
733
+				'bulk_action' => array_merge($def_reg_status_actions, array(
734
+					'trash_registrations' => __('Trash Registrations', 'event_espresso'),
735
+				)),
736
+			),
737
+		);
738
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_registrations',
739
+			'espresso_registrations_delete_registration')
740
+		) {
741
+			$this->_views['incomplete'] = array(
742
+				'slug'        => 'incomplete',
743
+				'label'       => __('Incomplete', 'event_espresso'),
744
+				'count'       => 0,
745
+				'bulk_action' => array(
746
+					'trash_registrations' => __('Trash Registrations', 'event_espresso'),
747
+				),
748
+			);
749
+			$this->_views['trash'] = array(
750
+				'slug'        => 'trash',
751
+				'label'       => __('Trash', 'event_espresso'),
752
+				'count'       => 0,
753
+				'bulk_action' => array(
754
+					'restore_registrations' => __('Restore Registrations', 'event_espresso'),
755
+					'delete_registrations'  => __('Delete Registrations Permanently', 'event_espresso'),
756
+				),
757
+			);
758
+		}
759
+	}
760
+
761
+
762
+
763
+	protected function _set_list_table_views_contact_list()
764
+	{
765
+		$this->_views = array(
766
+			'in_use' => array(
767
+				'slug'        => 'in_use',
768
+				'label'       => __('In Use', 'event_espresso'),
769
+				'count'       => 0,
770
+				'bulk_action' => array(
771
+					'trash_attendees' => __('Move to Trash', 'event_espresso'),
772
+				),
773
+			),
774
+		);
775
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts',
776
+			'espresso_registrations_trash_attendees')
777
+		) {
778
+			$this->_views['trash'] = array(
779
+				'slug'        => 'trash',
780
+				'label'       => __('Trash', 'event_espresso'),
781
+				'count'       => 0,
782
+				'bulk_action' => array(
783
+					'restore_attendees' => __('Restore from Trash', 'event_espresso'),
784
+				),
785
+			);
786
+		}
787
+	}
788
+
789
+
790
+
791
+	protected function _registration_legend_items()
792
+	{
793
+		$fc_items = array(
794
+			'star-icon'        => array(
795
+				'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
796
+				'desc'  => __('This is the Primary Registrant', 'event_espresso'),
797
+			),
798
+			'view_details'     => array(
799
+				'class' => 'dashicons dashicons-clipboard',
800
+				'desc'  => __('View Registration Details', 'event_espresso'),
801
+			),
802
+			'edit_attendee'    => array(
803
+				'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16',
804
+				'desc'  => __('Edit Contact Details', 'event_espresso'),
805
+			),
806
+			'view_transaction' => array(
807
+				'class' => 'dashicons dashicons-cart',
808
+				'desc'  => __('View Transaction Details', 'event_espresso'),
809
+			),
810
+			'view_invoice'     => array(
811
+				'class' => 'dashicons dashicons-media-spreadsheet',
812
+				'desc'  => __('View Transaction Invoice', 'event_espresso'),
813
+			),
814
+		);
815
+		if (EE_Registry::instance()->CAP->current_user_can('ee_send_message',
816
+			'espresso_registrations_resend_registration')
817
+		) {
818
+			$fc_items['resend_registration'] = array(
819
+				'class' => 'dashicons dashicons-email-alt',
820
+				'desc'  => __('Resend Registration Details', 'event_espresso'),
821
+			);
822
+		} else {
823
+			$fc_items['blank'] = array('class' => 'blank', 'desc' => '');
824
+		}
825
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
826
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
827
+			if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
828
+				$fc_items['view_related_messages'] = array(
829
+					'class' => $related_for_icon['css_class'],
830
+					'desc'  => $related_for_icon['label'],
831
+				);
832
+			}
833
+		}
834
+		$sc_items = array(
835
+			'approved_status'   => array(
836
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
837
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
838
+			),
839
+			'pending_status'    => array(
840
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
841
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
842
+			),
843
+			'wait_list'         => array(
844
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
845
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
846
+			),
847
+			'incomplete_status' => array(
848
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
849
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_incomplete, false, 'sentence'),
850
+			),
851
+			'not_approved'      => array(
852
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
853
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
854
+			),
855
+			'declined_status'   => array(
856
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
857
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
858
+			),
859
+			'cancelled_status'  => array(
860
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
861
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
862
+			),
863
+		);
864
+		return array_merge($fc_items, $sc_items);
865
+	}
866
+
867
+
868
+
869
+	/***************************************        REGISTRATION OVERVIEW        **************************************/
870
+	/**
871
+	 * @throws \EE_Error
872
+	 */
873
+	protected function _registrations_overview_list_table()
874
+	{
875
+		$this->_template_args['admin_page_header'] = '';
876
+		$EVT_ID = ! empty($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : 0;
877
+		if ($EVT_ID) {
878
+			if (EE_Registry::instance()->CAP->current_user_can('ee_edit_registrations',
879
+				'espresso_registrations_new_registration', $EVT_ID)
880
+			) {
881
+				$this->_admin_page_title .= ' ' . $this->get_action_link_or_button('new_registration', 'add-registrant',
882
+						array('event_id' => $EVT_ID), 'add-new-h2');
883
+			}
884
+			$event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
885
+			if ($event instanceof EE_Event) {
886
+				$this->_template_args['admin_page_header'] = sprintf(__('%s Viewing registrations for the event: %s%s',
887
+					'event_espresso'), '<h3 style="line-height:1.5em;">',
888
+					'<br /><a href="' . EE_Admin_Page::add_query_args_and_nonce(array(
889
+						'action' => 'edit',
890
+						'post'   => $event->ID(),
891
+					), EVENTS_ADMIN_URL) . '">&nbsp;' . $event->get('EVT_name') . '&nbsp;</a>&nbsp;', '</h3>');
892
+			}
893
+			$DTT_ID = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0;
894
+			$datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
895
+			if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') {
896
+				$this->_template_args['admin_page_header'] = substr($this->_template_args['admin_page_header'], 0, -5);
897
+				$this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
898
+				$this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
899
+				$this->_template_args['admin_page_header'] .= $datetime->name();
900
+				$this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
901
+				$this->_template_args['admin_page_header'] .= '</span></h3>';
902
+			}
903
+		}
904
+		$this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items());
905
+		$this->display_admin_list_table_page_with_no_sidebar();
906
+	}
907
+
908
+
909
+
910
+	/**
911
+	 * This sets the _registration property for the registration details screen
912
+	 *
913
+	 * @access private
914
+	 * @return bool
915
+	 */
916
+	private function _set_registration_object()
917
+	{
918
+		//get out if we've already set the object
919
+		if (is_object($this->_registration)) {
920
+			return true;
921
+		}
922
+		$REG = EEM_Registration::instance();
923
+		$REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
924
+		if ($this->_registration = $REG->get_one_by_ID($REG_ID)) {
925
+			return true;
926
+		} else {
927
+			$error_msg = sprintf(__('An error occurred and the details for Registration ID #%s could not be retrieved.',
928
+				'event_espresso'), $REG_ID);
929
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
930
+			$this->_registration = null;
931
+			return false;
932
+		}
933
+	}
934
+
935
+
936
+
937
+	/**
938
+	 * get registrations for given parameters (used by list table)
939
+	 *
940
+	 * @param  int     $per_page   how many registrations displayed per page
941
+	 * @param  boolean $count      return the count or objects
942
+	 * @param  boolean $this_month whether to return for just this month
943
+	 * @param  boolean $today      whether to return results for just today
944
+	 * @throws \EE_Error
945
+	 * @return mixed (int|array)  int = count || array of registration objects
946
+	 */
947
+	public function get_registrations($per_page = 10, $count = false, $this_month = false, $today = false)
948
+	{
949
+		$EVT_ID = ! empty($this->_req_data['event_id']) && $this->_req_data['event_id'] > 0
950
+			? absint($this->_req_data['event_id']) : false;
951
+		$CAT_ID = ! empty($this->_req_data['EVT_CAT']) && (int)$this->_req_data['EVT_CAT'] > 0
952
+			? absint($this->_req_data['EVT_CAT']) : false;
953
+		$DTT_ID = isset($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : null;
954
+		$reg_status = ! empty($this->_req_data['_reg_status']) ? sanitize_text_field($this->_req_data['_reg_status'])
955
+			: false;
956
+		$month_range = ! empty($this->_req_data['month_range']) ? sanitize_text_field($this->_req_data['month_range'])
957
+			: false;//should be like 2013-april
958
+		$today_a = ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'today' ? true : false;
959
+		$this_month_a = ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'month' ? true : false;
960
+		$start_date = false;
961
+		$end_date = false;
962
+		$_where = array();
963
+		$trash = ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'trash' ? true : false;
964
+		$incomplete = ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'incomplete' ? true : false;
965
+		//set orderby
966
+		$this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
967
+		switch ($this->_req_data['orderby']) {
968
+			case '_REG_ID':
969
+				$orderby = 'REG_ID';
970
+				break;
971
+			case '_Reg_status':
972
+				$orderby = 'STS_ID';
973
+				break;
974
+			case 'ATT_fname':
975
+				$orderby = 'Attendee.ATT_lname';
976
+				break;
977
+			case 'event_name':
978
+				$orderby = 'Event.EVT_name';
979
+				break;
980
+			case 'DTT_EVT_start':
981
+				$orderby = 'Event.Datetime.DTT_EVT_start';
982
+				break;
983
+			default: //'REG_date'
984
+				$orderby = 'REG_date';
985
+		}
986
+		$sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
987
+			: 'DESC';
988
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
989
+			? $this->_req_data['paged'] : 1;
990
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
991
+			? $this->_req_data['perpage'] : $per_page;
992
+		$offset = ($current_page - 1) * $per_page;
993
+		$limit = $count ? null : array($offset, $per_page);
994
+		if ($EVT_ID) {
995
+			$_where['EVT_ID'] = $EVT_ID;
996
+		}
997
+		if ($CAT_ID) {
998
+			$_where['Event.Term_Taxonomy.term_id'] = $CAT_ID;
999
+		}
1000
+		//if DTT is included we filter by that datetime.
1001
+		if ($DTT_ID) {
1002
+			$_where['Ticket.Datetime.DTT_ID'] = $DTT_ID;
1003
+		}
1004
+		if ($incomplete) {
1005
+			$_where['STS_ID'] = EEM_Registration::status_id_incomplete;
1006
+		} else if ( ! $trash) {
1007
+			$_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
1008
+		}
1009
+		if ($reg_status) {
1010
+			$_where['STS_ID'] = $reg_status;
1011
+		}
1012
+		$this_year_r = date('Y', current_time('timestamp'));
1013
+		$time_start = ' 00:00:00';
1014
+		$time_end = ' 23:59:59';
1015
+		if ($today_a || $today) {
1016
+			$curdate = date('Y-m-d', current_time('timestamp'));
1017
+			$_where['REG_date'] = array(
1018
+				'BETWEEN',
1019
+				array(
1020
+					EEM_Registration::instance()
1021
+									->convert_datetime_for_query('REG_date', $curdate . $time_start, 'Y-m-d H:i:s'),
1022
+					EEM_Registration::instance()
1023
+									->convert_datetime_for_query('REG_date', $curdate . $time_end, 'Y-m-d H:i:s'),
1024
+				),
1025
+			);
1026
+		} elseif ($this_month_a || $this_month) {
1027
+			$this_month_r = date('m', current_time('timestamp'));
1028
+			$days_this_month = date('t', current_time('timestamp'));
1029
+			$_where['REG_date'] = array(
1030
+				'BETWEEN',
1031
+				array(
1032
+					EEM_Registration::instance()
1033
+									->convert_datetime_for_query('REG_date',
1034
+										$this_year_r . '-' . $this_month_r . '-01' . ' ' . $time_start, 'Y-m-d H:i:s'),
1035
+					EEM_Registration::instance()
1036
+									->convert_datetime_for_query('REG_date',
1037
+										$this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' ' . $time_end,
1038
+										'Y-m-d H:i:s'),
1039
+				),
1040
+			);
1041
+		} elseif ($month_range) {
1042
+			$pieces = explode(' ', $this->_req_data['month_range'], 3);
1043
+			$month_r = ! empty($pieces[0]) ? date('m', strtotime($month_range)) : '';
1044
+			$year_r = ! empty($pieces[1]) ? $pieces[1] : '';
1045
+			$days_in_month = date('t', strtotime($year_r . '-' . $month_r . '-' . '01'));
1046
+			$_where['REG_date'] = array(
1047
+				'BETWEEN',
1048
+				array(
1049
+					EEM_Registration::instance()
1050
+									->convert_datetime_for_query('REG_date', $year_r . '-' . $month_r . '-01 00:00:00',
1051
+										'Y-m-d H:i:s'),
1052
+					EEM_Registration::instance()
1053
+									->convert_datetime_for_query('REG_date',
1054
+										$year_r . '-' . $month_r . '-' . $days_in_month . ' 23:59:59', 'Y-m-d H:i:s'),
1055
+				),
1056
+			);
1057
+		} elseif ($start_date && $end_date) {
1058
+			throw new EE_Error("not yet supported");
1059
+		} elseif ($start_date) {
1060
+			throw new EE_Error("not yet supported");
1061
+		} elseif ($end_date) {
1062
+			throw new EE_Error("not yet supported");
1063
+		}
1064
+		if ( ! empty($this->_req_data['s'])) {
1065
+			$sstr = '%' . $this->_req_data['s'] . '%';
1066
+			$_where['OR'] = array(
1067
+				'Event.EVT_name'                          => array('LIKE', $sstr),
1068
+				'Event.EVT_desc'                          => array('LIKE', $sstr),
1069
+				'Event.EVT_short_desc'                    => array('LIKE', $sstr),
1070
+				'Attendee.ATT_full_name'                  => array('LIKE', $sstr),
1071
+				'Attendee.ATT_fname'                      => array('LIKE', $sstr),
1072
+				'Attendee.ATT_lname'                      => array('LIKE', $sstr),
1073
+				'Attendee.ATT_short_bio'                  => array('LIKE', $sstr),
1074
+				'Attendee.ATT_email'                      => array('LIKE', $sstr),
1075
+				'Attendee.ATT_address'                    => array('LIKE', $sstr),
1076
+				'Attendee.ATT_address2'                   => array('LIKE', $sstr),
1077
+				'Attendee.ATT_city'                       => array('LIKE', $sstr),
1078
+				'REG_final_price'                         => array('LIKE', $sstr),
1079
+				'REG_code'                                => array('LIKE', $sstr),
1080
+				'REG_count'                               => array('LIKE', $sstr),
1081
+				'REG_group_size'                          => array('LIKE', $sstr),
1082
+				'Ticket.TKT_name'                         => array('LIKE', $sstr),
1083
+				'Ticket.TKT_description'                  => array('LIKE', $sstr),
1084
+				'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $sstr),
1085
+			);
1086
+		}
1087
+		//capability checks
1088
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'get_registrations')) {
1089
+			$_where['AND'] = array(
1090
+				'Event.EVT_wp_user' => get_current_user_id(),
1091
+			);
1092
+		}
1093
+		if ($count) {
1094
+			if ($trash) {
1095
+				return EEM_Registration::instance()->count_deleted(array($_where));
1096
+			} else if ($incomplete) {
1097
+				return EEM_Registration::instance()->count(array($_where));
1098
+			} else {
1099
+				return EEM_Registration::instance()->count(array(
1100
+					$_where,
1101
+					'default_where_conditions' => 'this_model_only',
1102
+				));
1103
+			}
1104
+		} else {
1105
+			//make sure we remove default where conditions cause all registrations matching query are returned
1106
+			$query_params = array(
1107
+				$_where,
1108
+				'order_by'                 => array($orderby => $sort),
1109
+				'default_where_conditions' => 'this_model_only',
1110
+			);
1111
+			if ($per_page !== -1) {
1112
+				$query_params['limit'] = $limit;
1113
+			}
1114
+			$registrations = $trash ? EEM_Registration::instance()->get_all_deleted($query_params)
1115
+				: EEM_Registration::instance()->get_all($query_params);
1116
+			if ($EVT_ID
1117
+				&& isset($registrations[0])
1118
+				&& $registrations[0] instanceof EE_Registration
1119
+				&& $registrations[0]->event_obj()
1120
+			) {
1121
+				$first_registration = $registrations[0];
1122
+				//EEH_Debug_Tools::printr( $registrations[0], '$registrations  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
1123
+				$event_name = $first_registration->event_obj()->name();
1124
+				$event_date = $first_registration->date_obj()
1125
+												 ->start_date_and_time('l F j, Y,',
1126
+													 'g:i:s a');// isset( $registrations[0]->DTT_EVT_start ) ? date( 'l F j, Y,    g:i:s a', $registrations[0]->DTT_EVT_start ) : '';
1127
+				// edit event link
1128
+				if ($event_name != '') {
1129
+					$edit_event_url = self::add_query_args_and_nonce(array(
1130
+						'action' => 'edit_event',
1131
+						'EVT_ID' => $EVT_ID,
1132
+					), EVENTS_ADMIN_URL);
1133
+					$edit_event_lnk = '<a href="' . $edit_event_url . '" title="' . esc_attr__('Edit ',
1134
+							'event_espresso') . $event_name . '">' . __('Edit Event', 'event_espresso') . '</a>';
1135
+					$event_name .= ' <span class="admin-page-header-edit-lnk not-bold">' . $edit_event_lnk . '</span>';
1136
+				}
1137
+				$back_2_reg_url = self::add_query_args_and_nonce(array('action' => 'default'), REG_ADMIN_URL);
1138
+				$back_2_reg_lnk = '<a href="'
1139
+								  . $back_2_reg_url
1140
+								  . '" title="'
1141
+								  . esc_attr__('click to return to viewing all registrations ', 'event_espresso')
1142
+								  . '">&laquo; '
1143
+								  . __('Back to All Registrations', 'event_espresso')
1144
+								  . '</a>';
1145
+				$this->_template_args['before_admin_page_content'] = '
1146 1146
 			<div id="admin-page-header">
1147 1147
 				<h1><span class="small-text not-bold">' . __('Event: ', 'event_espresso') . '</span>' . $event_name . '</h1>
1148 1148
 				<h3><span class="small-text not-bold">' . __('Date: ', 'event_espresso') . '</span>' . $event_date . '</h3>
1149 1149
 				<span class="admin-page-header-go-back-lnk not-bold">' . $back_2_reg_lnk . '</span>
1150 1150
 			</div>
1151 1151
 			';
1152
-            }
1153
-            return $registrations;
1154
-        }
1155
-    }
1156
-
1157
-
1158
-
1159
-    public function get_registration_status_array()
1160
-    {
1161
-        return self::$_reg_status;
1162
-    }
1163
-
1164
-
1165
-
1166
-
1167
-    /***************************************        REGISTRATION DETAILS        ***************************************/
1168
-    /**
1169
-     *        generates HTML for the View Registration Details Admin page
1170
-     *
1171
-     * @access protected
1172
-     * @return void
1173
-     */
1174
-    protected function _registration_details()
1175
-    {
1176
-        $this->_template_args = array();
1177
-        $this->_set_registration_object();
1178
-        if (is_object($this->_registration)) {
1179
-            $transaction = $this->_registration->transaction() ? $this->_registration->transaction()
1180
-                : EE_Transaction::new_instance();
1181
-            $this->_session = $transaction->session_data();
1182
-            $event_id = $this->_registration->event_ID();
1183
-            $this->_template_args['reg_nmbr']['value'] = $this->_registration->ID();
1184
-            $this->_template_args['reg_nmbr']['label'] = __('Registration Number', 'event_espresso');
1185
-            $this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
1186
-            $this->_template_args['reg_datetime']['label'] = __('Date', 'event_espresso');
1187
-            $this->_template_args['grand_total'] = $transaction->total();
1188
-            $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
1189
-            // link back to overview
1190
-            $this->_template_args['reg_overview_url'] = REG_ADMIN_URL;
1191
-            $this->_template_args['registration'] = $this->_registration;
1192
-            $this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(array(
1193
-                'action'   => 'default',
1194
-                'event_id' => $event_id,
1195
-            ), REG_ADMIN_URL);
1196
-            $this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce(array(
1197
-                'action' => 'default',
1198
-                'EVT_ID' => $event_id,
1199
-                'page'   => 'espresso_transactions',
1200
-            ), admin_url('admin.php'));
1201
-            $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(array(
1202
-                'page'   => 'espresso_events',
1203
-                'action' => 'edit',
1204
-                'post'   => $event_id,
1205
-            ), admin_url('admin.php'));
1206
-            //next and previous links
1207
-            $next_reg = $this->_registration->next(null, array(), 'REG_ID');
1208
-            $this->_template_args['next_registration'] = $next_reg
1209
-                ? $this->_next_link(EE_Admin_Page::add_query_args_and_nonce(array(
1210
-                    'action'  => 'view_registration',
1211
-                    '_REG_ID' => $next_reg['REG_ID'],
1212
-                ), REG_ADMIN_URL), 'dashicons dashicons-arrow-right ee-icon-size-22') : '';
1213
-            $previous_reg = $this->_registration->previous(null, array(), 'REG_ID');
1214
-            $this->_template_args['previous_registration'] = $previous_reg
1215
-                ? $this->_previous_link(EE_Admin_Page::add_query_args_and_nonce(array(
1216
-                    'action'  => 'view_registration',
1217
-                    '_REG_ID' => $previous_reg['REG_ID'],
1218
-                ), REG_ADMIN_URL), 'dashicons dashicons-arrow-left ee-icon-size-22') : '';
1219
-            // grab header
1220
-            $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
1221
-            $this->_template_args['REG_ID'] = $this->_registration->ID();
1222
-            $this->_template_args['admin_page_header'] = EEH_Template::display_template($template_path,
1223
-                $this->_template_args, true);
1224
-        } else {
1225
-            $this->_template_args['admin_page_header'] = $this->display_espresso_notices();
1226
-        }
1227
-        // the details template wrapper
1228
-        $this->display_admin_page_with_sidebar();
1229
-    }
1230
-
1231
-
1232
-
1233
-    protected function _registration_details_metaboxes()
1234
-    {
1235
-        do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
1236
-        $this->_set_registration_object();
1237
-        $attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
1238
-        add_meta_box('edit-reg-status-mbox', __('Registration Status', 'event_espresso'),
1239
-            array($this, 'set_reg_status_buttons_metabox'), $this->wp_page_slug, 'normal', 'high');
1240
-        add_meta_box('edit-reg-details-mbox', __('Registration Details', 'event_espresso'),
1241
-            array($this, '_reg_details_meta_box'), $this->wp_page_slug, 'normal', 'high');
1242
-        if ($attendee instanceof EE_Attendee
1243
-            && EE_Registry::instance()->CAP->current_user_can('ee_edit_registration', 'edit-reg-questions-mbox')
1244
-        ) {
1245
-            add_meta_box('edit-reg-questions-mbox', __('Registration Form Answers', 'event_espresso'),
1246
-                array($this, '_reg_questions_meta_box'), $this->wp_page_slug, 'normal', 'high');
1247
-        }
1248
-        add_meta_box('edit-reg-registrant-mbox', __('Contact Details', 'event_espresso'),
1249
-            array($this, '_reg_registrant_side_meta_box'), $this->wp_page_slug, 'side', 'high');
1250
-        if ($this->_registration->group_size() > 1) {
1251
-            add_meta_box('edit-reg-attendees-mbox', __('Other Registrations in this Transaction', 'event_espresso'),
1252
-                array($this, '_reg_attendees_meta_box'), $this->wp_page_slug, 'normal', 'high');
1253
-        }
1254
-    }
1255
-
1256
-
1257
-
1258
-    /**
1259
-     * set_reg_status_buttons_metabox
1260
-     *
1261
-     * @access protected
1262
-     * @return string
1263
-     * @throws \EE_Error
1264
-     */
1265
-    public function set_reg_status_buttons_metabox()
1266
-    {
1267
-        $this->_set_registration_object();
1268
-        $change_reg_status_form = $this->_generate_reg_status_change_form();
1269
-        echo $change_reg_status_form->form_open(self::add_query_args_and_nonce(array(
1270
-            'action' => 'change_reg_status',
1271
-        ), REG_ADMIN_URL));
1272
-        echo $change_reg_status_form->get_html();
1273
-        echo $change_reg_status_form->form_close();
1274
-    }
1275
-
1276
-
1277
-
1278
-    /**
1279
-     * @return EE_Form_Section_Proper
1280
-     */
1281
-    protected function _generate_reg_status_change_form()
1282
-    {
1283
-        return new EE_Form_Section_Proper(array(
1284
-                'name'            => 'reg_status_change_form',
1285
-                'html_id'         => 'reg-status-change-form',
1286
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
1287
-                'subsections'     => array(
1288
-                    'return'             => new EE_Hidden_Input(array(
1289
-                        'name'    => 'return',
1290
-                        'default' => 'view_registration',
1291
-                    )),
1292
-                    'REG_ID'             => new EE_Hidden_Input(array(
1293
-                        'name'    => 'REG_ID',
1294
-                        'default' => $this->_registration->ID(),
1295
-                    )),
1296
-                    'current_status'     => new EE_Form_Section_HTML(EEH_HTML::tr(EEH_HTML::th(EEH_HTML::label(EEH_HTML::strong(__('Current Registration Status',
1297
-                            'event_espresso')))) . EEH_HTML::td(EEH_HTML::strong($this->_registration->pretty_status(),
1298
-                            '', 'status-' . $this->_registration->status_ID(),
1299
-                            'line-height: 1em; font-size: 1.5em; font-weight: bold;')))),
1300
-                    'reg_status'         => new EE_Select_Input($this->_get_reg_statuses(), array(
1301
-                            'html_label_text' => __('Change Registration Status to', 'event_espresso'),
1302
-                            'default'         => $this->_registration->status_ID(),
1303
-                        )),
1304
-                    'send_notifications' => new EE_Yes_No_Input(array(
1305
-                            'html_label_text' => __('Send Related Messages', 'event_espresso'),
1306
-                            'default'         => false,
1307
-                            'html_help_text'  => __('If set to "Yes", then the related messages will be sent to the registrant.',
1308
-                                'event_espresso'),
1309
-                        )),
1310
-                    'submit'             => new EE_Submit_Input(array(
1311
-                        'html_class'      => 'button-primary',
1312
-                        'html_label_text' => '&nbsp;',
1313
-                        'default'         => __('Update Registration Status', 'event_espresso'),
1314
-                    )),
1315
-                ),
1316
-            ));
1317
-    }
1318
-
1319
-
1320
-
1321
-    /**
1322
-     * Returns an array of all the buttons for the various statuses and switch status actions
1323
-     *
1324
-     * @return string
1325
-     */
1326
-    protected function _get_current_reg_status_help_text($STS_ID = '')
1327
-    {
1328
-        //$reg_status_help_text = array(
1329
-        //	'RAP' => __( 'XXXXXXXXXXX', 'event_espresso' ),
1330
-        //	'RAP' => __( 'XXXXXXXXXXX', 'event_espresso' ),
1331
-        //	'RAP' => __( 'XXXXXXXXXXX', 'event_espresso' ),
1332
-        //	'RAP' => __( 'XXXXXXXXXXX', 'event_espresso' ),
1333
-        //	'RAP' => __( 'XXXXXXXXXXX', 'event_espresso' ),
1334
-        //	'RAP' => __( 'XXXXXXXXXXX', 'event_espresso' ),
1335
-        //);
1336
-        //Approved
1337
-        //An approved registration allows payments and may have a transaction status of incomplete or complete . The registration is marked as active and a space is reserved for the registrant .
1338
-        //Cancelled
1339
-        //	A {
1340
-        //	cancelled} registration is performed by the registrant . Payments are not allowed, the registration is inactive, and no space is reserved .
1341
-        //Declined
1342
-        //A declined registration is performed by the event admin . Payments are not allowed, the registration is inactive, and not space is reserved .
1343
-        //Not Approved
1344
-        //A not approved registration is performed by the event admin . Payments are not allowed, the registration is active, and no space is reserved .
1345
-        //Pending Payment
1346
-        //A pending registration allows payments . The status will be automatically toggled to approved if the {
1347
-        //	payment} is made in full by registrant .
1348
-    }
1349
-
1350
-
1351
-
1352
-    /**
1353
-     * Returns an array of all the buttons for the various statuses and switch status actions
1354
-     *
1355
-     * @return array
1356
-     */
1357
-    protected function _get_reg_statuses()
1358
-    {
1359
-        $reg_status_array = EEM_Registration::instance()->reg_status_array();
1360
-        unset ($reg_status_array[EEM_Registration::status_id_incomplete]);
1361
-        // get current reg status
1362
-        $current_status = $this->_registration->status_ID();
1363
-        // is registration for free event? This will determine whether to display the pending payment option
1364
-        if ($current_status != EEM_Registration::status_id_pending_payment
1365
-            && $this->_registration->transaction()
1366
-                                   ->is_free()
1367
-        ) {
1368
-            unset($reg_status_array[EEM_Registration::status_id_pending_payment]);
1369
-        }
1370
-        return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence');
1371
-    }
1372
-
1373
-
1374
-
1375
-    /**
1376
-     * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
1377
-     *
1378
-     * @param bool $status REG status given for changing registrations to.
1379
-     * @param bool $notify Whether to send messages notifications or not.
1380
-     * @return array  (array with reg_id(s) updated and whether update was successful.
1381
-     */
1382
-    protected function _set_registration_status_from_request($status = false, $notify = false)
1383
-    {
1384
-        if (isset($this->_req_data['reg_status_change_form'])) {
1385
-            $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
1386
-                ? (array)$this->_req_data['reg_status_change_form']['REG_ID'] : array();
1387
-        } else {
1388
-            $REG_IDs = isset($this->_req_data['_REG_ID']) ? (array)$this->_req_data['_REG_ID'] : array();
1389
-        }
1390
-        $success = $this->_set_registration_status($REG_IDs, $status);
1391
-        //notify?
1392
-        if ($success
1393
-            && $notify
1394
-            && EE_Registry::instance()->CAP->current_user_can('ee_send_message',
1395
-                'espresso_registrations_resend_registration')
1396
-        ) {
1397
-            $this->_process_resend_registration();
1398
-        }
1399
-        return $success;
1400
-    }
1401
-
1402
-
1403
-
1404
-    /**
1405
-     * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
1406
-     * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
1407
-     *
1408
-     * @param array $REG_IDs
1409
-     * @param bool  $status
1410
-     * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
1411
-     *               the array of updated registrations).
1412
-     */
1413
-    protected function _set_registration_status($REG_IDs = array(), $status = false)
1414
-    {
1415
-        $success = false;
1416
-        // typecast $REG_IDs
1417
-        $REG_IDs = (array)$REG_IDs;
1418
-        if ( ! empty($REG_IDs)) {
1419
-            $success = true;
1420
-            // set default status if none is passed
1421
-            $status = $status ? $status : EEM_Registration::status_id_pending_payment;
1422
-            // sanitize $REG_IDs
1423
-            $REG_IDs = array_filter($REG_IDs, 'absint');
1424
-            //loop through REG_ID's and change status
1425
-            foreach ($REG_IDs as $REG_ID) {
1426
-                $registration = EEM_Registration::instance()->get_one_by_ID($REG_ID);
1427
-                if ($registration instanceof EE_Registration) {
1428
-                    $registration->set_status($status);
1429
-                    $result = $registration->save();
1430
-                    // verifying explicit fails because update *may* just return 0 for 0 rows affected
1431
-                    $success = $result !== false ? $success : false;
1432
-                }
1433
-            }
1434
-        }
1435
-        //reset _req_data['_REG_ID'] for any potential future messages notifications
1436
-        $this->_req_data['_REG_ID'] = $REG_IDs;
1437
-        //return $success and processed registrations
1438
-        return array('REG_ID' => $REG_IDs, 'success' => $success);
1439
-    }
1440
-
1441
-
1442
-
1443
-    /**
1444
-     * Common logic for setting up success message and redirecting to appropriate route
1445
-     *
1446
-     * @param  string $STS_ID status id for the registration changed to
1447
-     * @param   bool  $notify indicates whether the _set_registration_status_from_request does notifications or not.
1448
-     * @return void
1449
-     */
1450
-    protected function _reg_status_change_return($STS_ID, $notify = false)
1451
-    {
1452
-        $result = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
1453
-            : array('success' => false);
1454
-        $success = isset($result['success']) && $result['success'];
1455
-        //setup success message
1456
-        if ($success) {
1457
-            if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
1458
-                $msg = sprintf(__('Registration status has been set to %s', 'event_espresso'),
1459
-                    EEH_Template::pretty_status($STS_ID, false, 'lower'));
1460
-            } else {
1461
-                $msg = sprintf(__('Registrations have been set to %s.', 'event_espresso'),
1462
-                    EEH_Template::pretty_status($STS_ID, false, 'lower'));
1463
-            }
1464
-            EE_Error::add_success($msg);
1465
-        } else {
1466
-            EE_Error::add_error(__('Something went wrong, and the status was not changed', 'event_espresso'), __FILE__,
1467
-                __LINE__, __FUNCTION__);
1468
-        }
1469
-        if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') {
1470
-            $route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID']));
1471
-        } else {
1472
-            $route = array('action' => 'default');
1473
-        }
1474
-        //unset nonces
1475
-        foreach ($this->_req_data as $ref => $value) {
1476
-            if (strpos($ref, 'nonce') !== false) {
1477
-                unset($this->_req_data[$ref]);
1478
-                continue;
1479
-            }
1480
-            $value = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
1481
-            $this->_req_data[$ref] = $value;
1482
-        }
1483
-        //merge request vars so that the reloaded list table contains any existing filter query params
1484
-        $route = array_merge($this->_req_data, $route);
1485
-        $this->_redirect_after_action($success, '', '', $route, true);
1486
-    }
1487
-
1488
-
1489
-
1490
-    /**
1491
-     * incoming reg status change from reg details page.
1492
-     *
1493
-     * @return void
1494
-     */
1495
-    protected function _change_reg_status()
1496
-    {
1497
-        $this->_req_data['return'] = 'view_registration';
1498
-        //set notify based on whether the send notifications toggle is set or not
1499
-        $notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']);
1500
-        //$notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] );
1501
-        $this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status'])
1502
-            ? $this->_req_data['reg_status_change_form']['reg_status'] : '';
1503
-        switch ($this->_req_data['reg_status_change_form']['reg_status']) {
1504
-            case EEM_Registration::status_id_approved :
1505
-            case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence') :
1506
-                $this->approve_registration($notify);
1507
-                break;
1508
-            case EEM_Registration::status_id_pending_payment :
1509
-            case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence') :
1510
-                $this->pending_registration($notify);
1511
-                break;
1512
-            case EEM_Registration::status_id_not_approved :
1513
-            case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence') :
1514
-                $this->not_approve_registration($notify);
1515
-                break;
1516
-            case EEM_Registration::status_id_declined :
1517
-            case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence') :
1518
-                $this->decline_registration($notify);
1519
-                break;
1520
-            case EEM_Registration::status_id_cancelled :
1521
-            case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence') :
1522
-                $this->cancel_registration($notify);
1523
-                break;
1524
-            case EEM_Registration::status_id_wait_list :
1525
-            case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence') :
1526
-                $this->waitlist_registration($notify);
1527
-                break;
1528
-            case EEM_Registration::status_id_incomplete :
1529
-            default :
1530
-                $result['success'] = false;
1531
-                unset($this->_req_data['return']);
1532
-                $this->_reg_status_change_return('', false);
1533
-                break;
1534
-        }
1535
-    }
1536
-
1537
-
1538
-
1539
-    /**
1540
-     * approve_registration
1541
-     *
1542
-     * @access protected
1543
-     * @param bool $notify whether or not to notify the registrant about their approval.
1544
-     * @return void
1545
-     */
1546
-    protected function approve_registration($notify = false)
1547
-    {
1548
-        $this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
1549
-    }
1550
-
1551
-
1552
-
1553
-    /**
1554
-     *        decline_registration
1555
-     *
1556
-     * @access protected
1557
-     * @param bool $notify whether or not to notify the registrant about their status change.
1558
-     * @return void
1559
-     */
1560
-    protected function decline_registration($notify = false)
1561
-    {
1562
-        $this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
1563
-    }
1564
-
1565
-
1566
-
1567
-    /**
1568
-     *        cancel_registration
1569
-     *
1570
-     * @access protected
1571
-     * @param bool $notify whether or not to notify the registrant about their status change.
1572
-     * @return void
1573
-     */
1574
-    protected function cancel_registration($notify = false)
1575
-    {
1576
-        $this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
1577
-    }
1578
-
1579
-
1580
-
1581
-    /**
1582
-     *        not_approve_registration
1583
-     *
1584
-     * @access protected
1585
-     * @param bool $notify whether or not to notify the registrant about their status change.
1586
-     * @return void
1587
-     */
1588
-    protected function not_approve_registration($notify = false)
1589
-    {
1590
-        $this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
1591
-    }
1592
-
1593
-
1594
-
1595
-    /**
1596
-     *        decline_registration
1597
-     *
1598
-     * @access protected
1599
-     * @param bool $notify whether or not to notify the registrant about their status change.
1600
-     * @return void
1601
-     */
1602
-    protected function pending_registration($notify = false)
1603
-    {
1604
-        $this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
1605
-    }
1606
-
1607
-
1608
-
1609
-    /**
1610
-     * waitlist_registration
1611
-     *
1612
-     * @access protected
1613
-     * @param bool $notify whether or not to notify the registrant about their status change.
1614
-     * @return void
1615
-     */
1616
-    protected function waitlist_registration($notify = false)
1617
-    {
1618
-        $this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
1619
-    }
1620
-
1621
-
1622
-
1623
-    /**
1624
-     *        generates HTML for the Registration main meta box
1625
-     *
1626
-     * @access public
1627
-     * @return void
1628
-     */
1629
-    public function _reg_details_meta_box()
1630
-    {
1631
-        EEH_Autoloader::register_line_item_display_autoloaders();
1632
-        EEH_Autoloader::register_line_item_filter_autoloaders();
1633
-        EE_Registry::instance()->load_helper('Line_Item');
1634
-        $transaction = $this->_registration->transaction() ? $this->_registration->transaction()
1635
-            : EE_Transaction::new_instance();
1636
-        $this->_session = $transaction->session_data();
1637
-        $filters = new EE_Line_Item_Filter_Collection();
1638
-        //$filters->add( new EE_Non_Zero_Line_Item_Filter() );
1639
-        $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
1640
-        $line_item_filter_processor = new EE_Line_Item_Filter_Processor($filters, $transaction->total_line_item());
1641
-        $filtered_line_item_tree = $line_item_filter_processor->process();
1642
-        $line_item_display = new EE_Line_Item_Display('reg_admin_table',
1643
-            'EE_Admin_Table_Registration_Line_Item_Display_Strategy');
1644
-        $this->_template_args['line_item_table'] = $line_item_display->display_line_item($filtered_line_item_tree,
1645
-            array('EE_Registration' => $this->_registration));
1646
-        $attendee = $this->_registration->attendee();
1647
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_transaction',
1648
-            'espresso_transactions_view_transaction')
1649
-        ) {
1650
-            $this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(EE_Admin_Page::add_query_args_and_nonce(array(
1651
-                'action' => 'view_transaction',
1652
-                'TXN_ID' => $transaction->ID(),
1653
-            ), TXN_ADMIN_URL), esc_html__(' View Transaction'), 'button secondary-button right',
1654
-                'dashicons dashicons-cart');
1655
-        } else {
1656
-            $this->_template_args['view_transaction_button'] = '';
1657
-        }
1658
-        if ($attendee instanceof EE_Attendee
1659
-            && EE_Registry::instance()->CAP->current_user_can('ee_send_message',
1660
-                'espresso_registrations_resend_registration')
1661
-        ) {
1662
-            $this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(EE_Admin_Page::add_query_args_and_nonce(array(
1663
-                'action'      => 'resend_registration',
1664
-                '_REG_ID'     => $this->_registration->ID(),
1665
-                'redirect_to' => 'view_registration',
1666
-            ), REG_ADMIN_URL), esc_html__(' Resend Registration'), 'button secondary-button right',
1667
-                'dashicons dashicons-email-alt');
1668
-        } else {
1669
-            $this->_template_args['resend_registration_button'] = '';
1670
-        }
1671
-        $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
1672
-        $payment = $transaction->get_first_related('Payment');
1673
-        $payment = ! $payment instanceof EE_Payment ? EE_Payment::new_instance() : $payment;
1674
-        $payment_method = $payment->get_first_related('Payment_Method');
1675
-        $payment_method = ! $payment_method instanceof EE_Payment_Method ? EE_Payment_Method::new_instance()
1676
-            : $payment_method;
1677
-        $reg_details = array(
1678
-            'payment_method'       => $payment_method->name(),
1679
-            'response_msg'         => $payment->gateway_response(),
1680
-            'registration_id'      => $this->_registration->get('REG_code'),
1681
-            'registration_session' => $this->_registration->session_ID(),
1682
-            'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
1683
-            'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
1684
-        );
1685
-        if (isset($reg_details['registration_id'])) {
1686
-            $this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
1687
-            $this->_template_args['reg_details']['registration_id']['label'] = __('Registration ID', 'event_espresso');
1688
-            $this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
1689
-        }
1690
-        if (isset($reg_details['payment_method'])) {
1691
-            $this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
1692
-            $this->_template_args['reg_details']['payment_method']['label'] = __('Most Recent Payment Method',
1693
-                'event_espresso');
1694
-            $this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
1695
-            $this->_template_args['reg_details']['response_msg']['value'] = $reg_details['response_msg'];
1696
-            $this->_template_args['reg_details']['response_msg']['label'] = __('Payment method response',
1697
-                'event_espresso');
1698
-            $this->_template_args['reg_details']['response_msg']['class'] = 'regular-text';
1699
-        }
1700
-        $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
1701
-        $this->_template_args['reg_details']['registration_session']['label'] = __('Registration Session',
1702
-            'event_espresso');
1703
-        $this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
1704
-        $this->_template_args['reg_details']['ip_address']['value'] = $reg_details['ip_address'];
1705
-        $this->_template_args['reg_details']['ip_address']['label'] = __('Registration placed from IP',
1706
-            'event_espresso');
1707
-        $this->_template_args['reg_details']['ip_address']['class'] = 'regular-text';
1708
-        $this->_template_args['reg_details']['user_agent']['value'] = $reg_details['user_agent'];
1709
-        $this->_template_args['reg_details']['user_agent']['label'] = __('Registrant User Agent', 'event_espresso');
1710
-        $this->_template_args['reg_details']['user_agent']['class'] = 'large-text';
1711
-        $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(array(
1712
-            'action'   => 'default',
1713
-            'event_id' => $this->_registration->event_ID(),
1714
-        ), REG_ADMIN_URL);
1715
-        $this->_template_args['REG_ID'] = $this->_registration->ID();
1716
-        $this->_template_args['event_id'] = $this->_registration->event_ID();
1717
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
1718
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
1719
-    }
1720
-
1721
-
1722
-
1723
-    /**
1724
-     * generates HTML for the Registration Questions meta box.
1725
-     * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
1726
-     * otherwise uses new forms system
1727
-     *
1728
-     * @access public
1729
-     * @return void
1730
-     */
1731
-    public function _reg_questions_meta_box()
1732
-    {
1733
-        //allow someone to override this method entirely
1734
-        if (apply_filters('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', true, $this,
1735
-            $this->_registration)) {
1736
-            $form = $this->_get_reg_custom_questions_form($this->_registration->ID());
1737
-            $this->_template_args['att_questions'] = count($form->subforms()) > 0 ? $form->get_html_and_js() : '';
1738
-            $this->_template_args['reg_questions_form_action'] = 'edit_registration';
1739
-            $this->_template_args['REG_ID'] = $this->_registration->ID();
1740
-            $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
1741
-            echo EEH_Template::display_template($template_path, $this->_template_args, true);
1742
-        }
1743
-    }
1744
-
1745
-
1746
-
1747
-    /**
1748
-     * form_before_question_group
1749
-     *
1750
-     * @deprecated    as of 4.8.32.rc.000
1751
-     * @access        public
1752
-     * @param        string $output
1753
-     * @return        string
1754
-     */
1755
-    public function form_before_question_group($output)
1756
-    {
1757
-        EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__,
1758
-            __('This method would have been protected but was used on a filter callback'
1759
-               . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'),
1760
-            '4.8.32.rc.000');
1761
-        return '
1152
+			}
1153
+			return $registrations;
1154
+		}
1155
+	}
1156
+
1157
+
1158
+
1159
+	public function get_registration_status_array()
1160
+	{
1161
+		return self::$_reg_status;
1162
+	}
1163
+
1164
+
1165
+
1166
+
1167
+	/***************************************        REGISTRATION DETAILS        ***************************************/
1168
+	/**
1169
+	 *        generates HTML for the View Registration Details Admin page
1170
+	 *
1171
+	 * @access protected
1172
+	 * @return void
1173
+	 */
1174
+	protected function _registration_details()
1175
+	{
1176
+		$this->_template_args = array();
1177
+		$this->_set_registration_object();
1178
+		if (is_object($this->_registration)) {
1179
+			$transaction = $this->_registration->transaction() ? $this->_registration->transaction()
1180
+				: EE_Transaction::new_instance();
1181
+			$this->_session = $transaction->session_data();
1182
+			$event_id = $this->_registration->event_ID();
1183
+			$this->_template_args['reg_nmbr']['value'] = $this->_registration->ID();
1184
+			$this->_template_args['reg_nmbr']['label'] = __('Registration Number', 'event_espresso');
1185
+			$this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
1186
+			$this->_template_args['reg_datetime']['label'] = __('Date', 'event_espresso');
1187
+			$this->_template_args['grand_total'] = $transaction->total();
1188
+			$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
1189
+			// link back to overview
1190
+			$this->_template_args['reg_overview_url'] = REG_ADMIN_URL;
1191
+			$this->_template_args['registration'] = $this->_registration;
1192
+			$this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(array(
1193
+				'action'   => 'default',
1194
+				'event_id' => $event_id,
1195
+			), REG_ADMIN_URL);
1196
+			$this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce(array(
1197
+				'action' => 'default',
1198
+				'EVT_ID' => $event_id,
1199
+				'page'   => 'espresso_transactions',
1200
+			), admin_url('admin.php'));
1201
+			$this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(array(
1202
+				'page'   => 'espresso_events',
1203
+				'action' => 'edit',
1204
+				'post'   => $event_id,
1205
+			), admin_url('admin.php'));
1206
+			//next and previous links
1207
+			$next_reg = $this->_registration->next(null, array(), 'REG_ID');
1208
+			$this->_template_args['next_registration'] = $next_reg
1209
+				? $this->_next_link(EE_Admin_Page::add_query_args_and_nonce(array(
1210
+					'action'  => 'view_registration',
1211
+					'_REG_ID' => $next_reg['REG_ID'],
1212
+				), REG_ADMIN_URL), 'dashicons dashicons-arrow-right ee-icon-size-22') : '';
1213
+			$previous_reg = $this->_registration->previous(null, array(), 'REG_ID');
1214
+			$this->_template_args['previous_registration'] = $previous_reg
1215
+				? $this->_previous_link(EE_Admin_Page::add_query_args_and_nonce(array(
1216
+					'action'  => 'view_registration',
1217
+					'_REG_ID' => $previous_reg['REG_ID'],
1218
+				), REG_ADMIN_URL), 'dashicons dashicons-arrow-left ee-icon-size-22') : '';
1219
+			// grab header
1220
+			$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
1221
+			$this->_template_args['REG_ID'] = $this->_registration->ID();
1222
+			$this->_template_args['admin_page_header'] = EEH_Template::display_template($template_path,
1223
+				$this->_template_args, true);
1224
+		} else {
1225
+			$this->_template_args['admin_page_header'] = $this->display_espresso_notices();
1226
+		}
1227
+		// the details template wrapper
1228
+		$this->display_admin_page_with_sidebar();
1229
+	}
1230
+
1231
+
1232
+
1233
+	protected function _registration_details_metaboxes()
1234
+	{
1235
+		do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
1236
+		$this->_set_registration_object();
1237
+		$attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
1238
+		add_meta_box('edit-reg-status-mbox', __('Registration Status', 'event_espresso'),
1239
+			array($this, 'set_reg_status_buttons_metabox'), $this->wp_page_slug, 'normal', 'high');
1240
+		add_meta_box('edit-reg-details-mbox', __('Registration Details', 'event_espresso'),
1241
+			array($this, '_reg_details_meta_box'), $this->wp_page_slug, 'normal', 'high');
1242
+		if ($attendee instanceof EE_Attendee
1243
+			&& EE_Registry::instance()->CAP->current_user_can('ee_edit_registration', 'edit-reg-questions-mbox')
1244
+		) {
1245
+			add_meta_box('edit-reg-questions-mbox', __('Registration Form Answers', 'event_espresso'),
1246
+				array($this, '_reg_questions_meta_box'), $this->wp_page_slug, 'normal', 'high');
1247
+		}
1248
+		add_meta_box('edit-reg-registrant-mbox', __('Contact Details', 'event_espresso'),
1249
+			array($this, '_reg_registrant_side_meta_box'), $this->wp_page_slug, 'side', 'high');
1250
+		if ($this->_registration->group_size() > 1) {
1251
+			add_meta_box('edit-reg-attendees-mbox', __('Other Registrations in this Transaction', 'event_espresso'),
1252
+				array($this, '_reg_attendees_meta_box'), $this->wp_page_slug, 'normal', 'high');
1253
+		}
1254
+	}
1255
+
1256
+
1257
+
1258
+	/**
1259
+	 * set_reg_status_buttons_metabox
1260
+	 *
1261
+	 * @access protected
1262
+	 * @return string
1263
+	 * @throws \EE_Error
1264
+	 */
1265
+	public function set_reg_status_buttons_metabox()
1266
+	{
1267
+		$this->_set_registration_object();
1268
+		$change_reg_status_form = $this->_generate_reg_status_change_form();
1269
+		echo $change_reg_status_form->form_open(self::add_query_args_and_nonce(array(
1270
+			'action' => 'change_reg_status',
1271
+		), REG_ADMIN_URL));
1272
+		echo $change_reg_status_form->get_html();
1273
+		echo $change_reg_status_form->form_close();
1274
+	}
1275
+
1276
+
1277
+
1278
+	/**
1279
+	 * @return EE_Form_Section_Proper
1280
+	 */
1281
+	protected function _generate_reg_status_change_form()
1282
+	{
1283
+		return new EE_Form_Section_Proper(array(
1284
+				'name'            => 'reg_status_change_form',
1285
+				'html_id'         => 'reg-status-change-form',
1286
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
1287
+				'subsections'     => array(
1288
+					'return'             => new EE_Hidden_Input(array(
1289
+						'name'    => 'return',
1290
+						'default' => 'view_registration',
1291
+					)),
1292
+					'REG_ID'             => new EE_Hidden_Input(array(
1293
+						'name'    => 'REG_ID',
1294
+						'default' => $this->_registration->ID(),
1295
+					)),
1296
+					'current_status'     => new EE_Form_Section_HTML(EEH_HTML::tr(EEH_HTML::th(EEH_HTML::label(EEH_HTML::strong(__('Current Registration Status',
1297
+							'event_espresso')))) . EEH_HTML::td(EEH_HTML::strong($this->_registration->pretty_status(),
1298
+							'', 'status-' . $this->_registration->status_ID(),
1299
+							'line-height: 1em; font-size: 1.5em; font-weight: bold;')))),
1300
+					'reg_status'         => new EE_Select_Input($this->_get_reg_statuses(), array(
1301
+							'html_label_text' => __('Change Registration Status to', 'event_espresso'),
1302
+							'default'         => $this->_registration->status_ID(),
1303
+						)),
1304
+					'send_notifications' => new EE_Yes_No_Input(array(
1305
+							'html_label_text' => __('Send Related Messages', 'event_espresso'),
1306
+							'default'         => false,
1307
+							'html_help_text'  => __('If set to "Yes", then the related messages will be sent to the registrant.',
1308
+								'event_espresso'),
1309
+						)),
1310
+					'submit'             => new EE_Submit_Input(array(
1311
+						'html_class'      => 'button-primary',
1312
+						'html_label_text' => '&nbsp;',
1313
+						'default'         => __('Update Registration Status', 'event_espresso'),
1314
+					)),
1315
+				),
1316
+			));
1317
+	}
1318
+
1319
+
1320
+
1321
+	/**
1322
+	 * Returns an array of all the buttons for the various statuses and switch status actions
1323
+	 *
1324
+	 * @return string
1325
+	 */
1326
+	protected function _get_current_reg_status_help_text($STS_ID = '')
1327
+	{
1328
+		//$reg_status_help_text = array(
1329
+		//	'RAP' => __( 'XXXXXXXXXXX', 'event_espresso' ),
1330
+		//	'RAP' => __( 'XXXXXXXXXXX', 'event_espresso' ),
1331
+		//	'RAP' => __( 'XXXXXXXXXXX', 'event_espresso' ),
1332
+		//	'RAP' => __( 'XXXXXXXXXXX', 'event_espresso' ),
1333
+		//	'RAP' => __( 'XXXXXXXXXXX', 'event_espresso' ),
1334
+		//	'RAP' => __( 'XXXXXXXXXXX', 'event_espresso' ),
1335
+		//);
1336
+		//Approved
1337
+		//An approved registration allows payments and may have a transaction status of incomplete or complete . The registration is marked as active and a space is reserved for the registrant .
1338
+		//Cancelled
1339
+		//	A {
1340
+		//	cancelled} registration is performed by the registrant . Payments are not allowed, the registration is inactive, and no space is reserved .
1341
+		//Declined
1342
+		//A declined registration is performed by the event admin . Payments are not allowed, the registration is inactive, and not space is reserved .
1343
+		//Not Approved
1344
+		//A not approved registration is performed by the event admin . Payments are not allowed, the registration is active, and no space is reserved .
1345
+		//Pending Payment
1346
+		//A pending registration allows payments . The status will be automatically toggled to approved if the {
1347
+		//	payment} is made in full by registrant .
1348
+	}
1349
+
1350
+
1351
+
1352
+	/**
1353
+	 * Returns an array of all the buttons for the various statuses and switch status actions
1354
+	 *
1355
+	 * @return array
1356
+	 */
1357
+	protected function _get_reg_statuses()
1358
+	{
1359
+		$reg_status_array = EEM_Registration::instance()->reg_status_array();
1360
+		unset ($reg_status_array[EEM_Registration::status_id_incomplete]);
1361
+		// get current reg status
1362
+		$current_status = $this->_registration->status_ID();
1363
+		// is registration for free event? This will determine whether to display the pending payment option
1364
+		if ($current_status != EEM_Registration::status_id_pending_payment
1365
+			&& $this->_registration->transaction()
1366
+								   ->is_free()
1367
+		) {
1368
+			unset($reg_status_array[EEM_Registration::status_id_pending_payment]);
1369
+		}
1370
+		return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence');
1371
+	}
1372
+
1373
+
1374
+
1375
+	/**
1376
+	 * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
1377
+	 *
1378
+	 * @param bool $status REG status given for changing registrations to.
1379
+	 * @param bool $notify Whether to send messages notifications or not.
1380
+	 * @return array  (array with reg_id(s) updated and whether update was successful.
1381
+	 */
1382
+	protected function _set_registration_status_from_request($status = false, $notify = false)
1383
+	{
1384
+		if (isset($this->_req_data['reg_status_change_form'])) {
1385
+			$REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
1386
+				? (array)$this->_req_data['reg_status_change_form']['REG_ID'] : array();
1387
+		} else {
1388
+			$REG_IDs = isset($this->_req_data['_REG_ID']) ? (array)$this->_req_data['_REG_ID'] : array();
1389
+		}
1390
+		$success = $this->_set_registration_status($REG_IDs, $status);
1391
+		//notify?
1392
+		if ($success
1393
+			&& $notify
1394
+			&& EE_Registry::instance()->CAP->current_user_can('ee_send_message',
1395
+				'espresso_registrations_resend_registration')
1396
+		) {
1397
+			$this->_process_resend_registration();
1398
+		}
1399
+		return $success;
1400
+	}
1401
+
1402
+
1403
+
1404
+	/**
1405
+	 * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
1406
+	 * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
1407
+	 *
1408
+	 * @param array $REG_IDs
1409
+	 * @param bool  $status
1410
+	 * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
1411
+	 *               the array of updated registrations).
1412
+	 */
1413
+	protected function _set_registration_status($REG_IDs = array(), $status = false)
1414
+	{
1415
+		$success = false;
1416
+		// typecast $REG_IDs
1417
+		$REG_IDs = (array)$REG_IDs;
1418
+		if ( ! empty($REG_IDs)) {
1419
+			$success = true;
1420
+			// set default status if none is passed
1421
+			$status = $status ? $status : EEM_Registration::status_id_pending_payment;
1422
+			// sanitize $REG_IDs
1423
+			$REG_IDs = array_filter($REG_IDs, 'absint');
1424
+			//loop through REG_ID's and change status
1425
+			foreach ($REG_IDs as $REG_ID) {
1426
+				$registration = EEM_Registration::instance()->get_one_by_ID($REG_ID);
1427
+				if ($registration instanceof EE_Registration) {
1428
+					$registration->set_status($status);
1429
+					$result = $registration->save();
1430
+					// verifying explicit fails because update *may* just return 0 for 0 rows affected
1431
+					$success = $result !== false ? $success : false;
1432
+				}
1433
+			}
1434
+		}
1435
+		//reset _req_data['_REG_ID'] for any potential future messages notifications
1436
+		$this->_req_data['_REG_ID'] = $REG_IDs;
1437
+		//return $success and processed registrations
1438
+		return array('REG_ID' => $REG_IDs, 'success' => $success);
1439
+	}
1440
+
1441
+
1442
+
1443
+	/**
1444
+	 * Common logic for setting up success message and redirecting to appropriate route
1445
+	 *
1446
+	 * @param  string $STS_ID status id for the registration changed to
1447
+	 * @param   bool  $notify indicates whether the _set_registration_status_from_request does notifications or not.
1448
+	 * @return void
1449
+	 */
1450
+	protected function _reg_status_change_return($STS_ID, $notify = false)
1451
+	{
1452
+		$result = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
1453
+			: array('success' => false);
1454
+		$success = isset($result['success']) && $result['success'];
1455
+		//setup success message
1456
+		if ($success) {
1457
+			if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
1458
+				$msg = sprintf(__('Registration status has been set to %s', 'event_espresso'),
1459
+					EEH_Template::pretty_status($STS_ID, false, 'lower'));
1460
+			} else {
1461
+				$msg = sprintf(__('Registrations have been set to %s.', 'event_espresso'),
1462
+					EEH_Template::pretty_status($STS_ID, false, 'lower'));
1463
+			}
1464
+			EE_Error::add_success($msg);
1465
+		} else {
1466
+			EE_Error::add_error(__('Something went wrong, and the status was not changed', 'event_espresso'), __FILE__,
1467
+				__LINE__, __FUNCTION__);
1468
+		}
1469
+		if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') {
1470
+			$route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID']));
1471
+		} else {
1472
+			$route = array('action' => 'default');
1473
+		}
1474
+		//unset nonces
1475
+		foreach ($this->_req_data as $ref => $value) {
1476
+			if (strpos($ref, 'nonce') !== false) {
1477
+				unset($this->_req_data[$ref]);
1478
+				continue;
1479
+			}
1480
+			$value = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
1481
+			$this->_req_data[$ref] = $value;
1482
+		}
1483
+		//merge request vars so that the reloaded list table contains any existing filter query params
1484
+		$route = array_merge($this->_req_data, $route);
1485
+		$this->_redirect_after_action($success, '', '', $route, true);
1486
+	}
1487
+
1488
+
1489
+
1490
+	/**
1491
+	 * incoming reg status change from reg details page.
1492
+	 *
1493
+	 * @return void
1494
+	 */
1495
+	protected function _change_reg_status()
1496
+	{
1497
+		$this->_req_data['return'] = 'view_registration';
1498
+		//set notify based on whether the send notifications toggle is set or not
1499
+		$notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']);
1500
+		//$notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] );
1501
+		$this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status'])
1502
+			? $this->_req_data['reg_status_change_form']['reg_status'] : '';
1503
+		switch ($this->_req_data['reg_status_change_form']['reg_status']) {
1504
+			case EEM_Registration::status_id_approved :
1505
+			case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence') :
1506
+				$this->approve_registration($notify);
1507
+				break;
1508
+			case EEM_Registration::status_id_pending_payment :
1509
+			case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence') :
1510
+				$this->pending_registration($notify);
1511
+				break;
1512
+			case EEM_Registration::status_id_not_approved :
1513
+			case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence') :
1514
+				$this->not_approve_registration($notify);
1515
+				break;
1516
+			case EEM_Registration::status_id_declined :
1517
+			case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence') :
1518
+				$this->decline_registration($notify);
1519
+				break;
1520
+			case EEM_Registration::status_id_cancelled :
1521
+			case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence') :
1522
+				$this->cancel_registration($notify);
1523
+				break;
1524
+			case EEM_Registration::status_id_wait_list :
1525
+			case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence') :
1526
+				$this->waitlist_registration($notify);
1527
+				break;
1528
+			case EEM_Registration::status_id_incomplete :
1529
+			default :
1530
+				$result['success'] = false;
1531
+				unset($this->_req_data['return']);
1532
+				$this->_reg_status_change_return('', false);
1533
+				break;
1534
+		}
1535
+	}
1536
+
1537
+
1538
+
1539
+	/**
1540
+	 * approve_registration
1541
+	 *
1542
+	 * @access protected
1543
+	 * @param bool $notify whether or not to notify the registrant about their approval.
1544
+	 * @return void
1545
+	 */
1546
+	protected function approve_registration($notify = false)
1547
+	{
1548
+		$this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
1549
+	}
1550
+
1551
+
1552
+
1553
+	/**
1554
+	 *        decline_registration
1555
+	 *
1556
+	 * @access protected
1557
+	 * @param bool $notify whether or not to notify the registrant about their status change.
1558
+	 * @return void
1559
+	 */
1560
+	protected function decline_registration($notify = false)
1561
+	{
1562
+		$this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
1563
+	}
1564
+
1565
+
1566
+
1567
+	/**
1568
+	 *        cancel_registration
1569
+	 *
1570
+	 * @access protected
1571
+	 * @param bool $notify whether or not to notify the registrant about their status change.
1572
+	 * @return void
1573
+	 */
1574
+	protected function cancel_registration($notify = false)
1575
+	{
1576
+		$this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
1577
+	}
1578
+
1579
+
1580
+
1581
+	/**
1582
+	 *        not_approve_registration
1583
+	 *
1584
+	 * @access protected
1585
+	 * @param bool $notify whether or not to notify the registrant about their status change.
1586
+	 * @return void
1587
+	 */
1588
+	protected function not_approve_registration($notify = false)
1589
+	{
1590
+		$this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
1591
+	}
1592
+
1593
+
1594
+
1595
+	/**
1596
+	 *        decline_registration
1597
+	 *
1598
+	 * @access protected
1599
+	 * @param bool $notify whether or not to notify the registrant about their status change.
1600
+	 * @return void
1601
+	 */
1602
+	protected function pending_registration($notify = false)
1603
+	{
1604
+		$this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
1605
+	}
1606
+
1607
+
1608
+
1609
+	/**
1610
+	 * waitlist_registration
1611
+	 *
1612
+	 * @access protected
1613
+	 * @param bool $notify whether or not to notify the registrant about their status change.
1614
+	 * @return void
1615
+	 */
1616
+	protected function waitlist_registration($notify = false)
1617
+	{
1618
+		$this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
1619
+	}
1620
+
1621
+
1622
+
1623
+	/**
1624
+	 *        generates HTML for the Registration main meta box
1625
+	 *
1626
+	 * @access public
1627
+	 * @return void
1628
+	 */
1629
+	public function _reg_details_meta_box()
1630
+	{
1631
+		EEH_Autoloader::register_line_item_display_autoloaders();
1632
+		EEH_Autoloader::register_line_item_filter_autoloaders();
1633
+		EE_Registry::instance()->load_helper('Line_Item');
1634
+		$transaction = $this->_registration->transaction() ? $this->_registration->transaction()
1635
+			: EE_Transaction::new_instance();
1636
+		$this->_session = $transaction->session_data();
1637
+		$filters = new EE_Line_Item_Filter_Collection();
1638
+		//$filters->add( new EE_Non_Zero_Line_Item_Filter() );
1639
+		$filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
1640
+		$line_item_filter_processor = new EE_Line_Item_Filter_Processor($filters, $transaction->total_line_item());
1641
+		$filtered_line_item_tree = $line_item_filter_processor->process();
1642
+		$line_item_display = new EE_Line_Item_Display('reg_admin_table',
1643
+			'EE_Admin_Table_Registration_Line_Item_Display_Strategy');
1644
+		$this->_template_args['line_item_table'] = $line_item_display->display_line_item($filtered_line_item_tree,
1645
+			array('EE_Registration' => $this->_registration));
1646
+		$attendee = $this->_registration->attendee();
1647
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_transaction',
1648
+			'espresso_transactions_view_transaction')
1649
+		) {
1650
+			$this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(EE_Admin_Page::add_query_args_and_nonce(array(
1651
+				'action' => 'view_transaction',
1652
+				'TXN_ID' => $transaction->ID(),
1653
+			), TXN_ADMIN_URL), esc_html__(' View Transaction'), 'button secondary-button right',
1654
+				'dashicons dashicons-cart');
1655
+		} else {
1656
+			$this->_template_args['view_transaction_button'] = '';
1657
+		}
1658
+		if ($attendee instanceof EE_Attendee
1659
+			&& EE_Registry::instance()->CAP->current_user_can('ee_send_message',
1660
+				'espresso_registrations_resend_registration')
1661
+		) {
1662
+			$this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(EE_Admin_Page::add_query_args_and_nonce(array(
1663
+				'action'      => 'resend_registration',
1664
+				'_REG_ID'     => $this->_registration->ID(),
1665
+				'redirect_to' => 'view_registration',
1666
+			), REG_ADMIN_URL), esc_html__(' Resend Registration'), 'button secondary-button right',
1667
+				'dashicons dashicons-email-alt');
1668
+		} else {
1669
+			$this->_template_args['resend_registration_button'] = '';
1670
+		}
1671
+		$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
1672
+		$payment = $transaction->get_first_related('Payment');
1673
+		$payment = ! $payment instanceof EE_Payment ? EE_Payment::new_instance() : $payment;
1674
+		$payment_method = $payment->get_first_related('Payment_Method');
1675
+		$payment_method = ! $payment_method instanceof EE_Payment_Method ? EE_Payment_Method::new_instance()
1676
+			: $payment_method;
1677
+		$reg_details = array(
1678
+			'payment_method'       => $payment_method->name(),
1679
+			'response_msg'         => $payment->gateway_response(),
1680
+			'registration_id'      => $this->_registration->get('REG_code'),
1681
+			'registration_session' => $this->_registration->session_ID(),
1682
+			'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
1683
+			'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
1684
+		);
1685
+		if (isset($reg_details['registration_id'])) {
1686
+			$this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
1687
+			$this->_template_args['reg_details']['registration_id']['label'] = __('Registration ID', 'event_espresso');
1688
+			$this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
1689
+		}
1690
+		if (isset($reg_details['payment_method'])) {
1691
+			$this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
1692
+			$this->_template_args['reg_details']['payment_method']['label'] = __('Most Recent Payment Method',
1693
+				'event_espresso');
1694
+			$this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
1695
+			$this->_template_args['reg_details']['response_msg']['value'] = $reg_details['response_msg'];
1696
+			$this->_template_args['reg_details']['response_msg']['label'] = __('Payment method response',
1697
+				'event_espresso');
1698
+			$this->_template_args['reg_details']['response_msg']['class'] = 'regular-text';
1699
+		}
1700
+		$this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
1701
+		$this->_template_args['reg_details']['registration_session']['label'] = __('Registration Session',
1702
+			'event_espresso');
1703
+		$this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
1704
+		$this->_template_args['reg_details']['ip_address']['value'] = $reg_details['ip_address'];
1705
+		$this->_template_args['reg_details']['ip_address']['label'] = __('Registration placed from IP',
1706
+			'event_espresso');
1707
+		$this->_template_args['reg_details']['ip_address']['class'] = 'regular-text';
1708
+		$this->_template_args['reg_details']['user_agent']['value'] = $reg_details['user_agent'];
1709
+		$this->_template_args['reg_details']['user_agent']['label'] = __('Registrant User Agent', 'event_espresso');
1710
+		$this->_template_args['reg_details']['user_agent']['class'] = 'large-text';
1711
+		$this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(array(
1712
+			'action'   => 'default',
1713
+			'event_id' => $this->_registration->event_ID(),
1714
+		), REG_ADMIN_URL);
1715
+		$this->_template_args['REG_ID'] = $this->_registration->ID();
1716
+		$this->_template_args['event_id'] = $this->_registration->event_ID();
1717
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
1718
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
1719
+	}
1720
+
1721
+
1722
+
1723
+	/**
1724
+	 * generates HTML for the Registration Questions meta box.
1725
+	 * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
1726
+	 * otherwise uses new forms system
1727
+	 *
1728
+	 * @access public
1729
+	 * @return void
1730
+	 */
1731
+	public function _reg_questions_meta_box()
1732
+	{
1733
+		//allow someone to override this method entirely
1734
+		if (apply_filters('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', true, $this,
1735
+			$this->_registration)) {
1736
+			$form = $this->_get_reg_custom_questions_form($this->_registration->ID());
1737
+			$this->_template_args['att_questions'] = count($form->subforms()) > 0 ? $form->get_html_and_js() : '';
1738
+			$this->_template_args['reg_questions_form_action'] = 'edit_registration';
1739
+			$this->_template_args['REG_ID'] = $this->_registration->ID();
1740
+			$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
1741
+			echo EEH_Template::display_template($template_path, $this->_template_args, true);
1742
+		}
1743
+	}
1744
+
1745
+
1746
+
1747
+	/**
1748
+	 * form_before_question_group
1749
+	 *
1750
+	 * @deprecated    as of 4.8.32.rc.000
1751
+	 * @access        public
1752
+	 * @param        string $output
1753
+	 * @return        string
1754
+	 */
1755
+	public function form_before_question_group($output)
1756
+	{
1757
+		EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__,
1758
+			__('This method would have been protected but was used on a filter callback'
1759
+			   . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'),
1760
+			'4.8.32.rc.000');
1761
+		return '
1762 1762
 	<table class="form-table ee-width-100">
1763 1763
 		<tbody>
1764 1764
 			';
1765
-    }
1766
-
1767
-
1768
-
1769
-    /**
1770
-     * form_after_question_group
1771
-     *
1772
-     * @deprecated    as of 4.8.32.rc.000
1773
-     * @access        public
1774
-     * @param        string $output
1775
-     * @return        string
1776
-     */
1777
-    public function form_after_question_group($output)
1778
-    {
1779
-        EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__,
1780
-            __('This method would have been protected but was used on a filter callback'
1781
-               . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'),
1782
-            '4.8.32.rc.000');
1783
-        return '
1765
+	}
1766
+
1767
+
1768
+
1769
+	/**
1770
+	 * form_after_question_group
1771
+	 *
1772
+	 * @deprecated    as of 4.8.32.rc.000
1773
+	 * @access        public
1774
+	 * @param        string $output
1775
+	 * @return        string
1776
+	 */
1777
+	public function form_after_question_group($output)
1778
+	{
1779
+		EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__,
1780
+			__('This method would have been protected but was used on a filter callback'
1781
+			   . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'),
1782
+			'4.8.32.rc.000');
1783
+		return '
1784 1784
 			<tr class="hide-if-no-js">
1785 1785
 				<th> </th>
1786 1786
 				<td class="reg-admin-edit-attendee-question-td">
1787 1787
 					<a class="reg-admin-edit-attendee-question-lnk" href="#" title="'
1788
-               . esc_attr__('click to edit question', 'event_espresso')
1789
-               . '">
1788
+			   . esc_attr__('click to edit question', 'event_espresso')
1789
+			   . '">
1790 1790
 						<span class="reg-admin-edit-question-group-spn lt-grey-txt">'
1791
-               . __('edit the above question group', 'event_espresso')
1792
-               . '</span>
1791
+			   . __('edit the above question group', 'event_espresso')
1792
+			   . '</span>
1793 1793
 						<div class="dashicons dashicons-edit"></div>
1794 1794
 					</a>
1795 1795
 				</td>
@@ -1797,506 +1797,506 @@  discard block
 block discarded – undo
1797 1797
 		</tbody>
1798 1798
 	</table>
1799 1799
 ';
1800
-    }
1801
-
1802
-
1803
-
1804
-    /**
1805
-     * form_form_field_label_wrap
1806
-     *
1807
-     * @deprecated    as of 4.8.32.rc.000
1808
-     * @access        public
1809
-     * @param        string $label
1810
-     * @return        string
1811
-     */
1812
-    public function form_form_field_label_wrap($label)
1813
-    {
1814
-        EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__,
1815
-            __('This method would have been protected but was used on a filter callback'
1816
-               . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'),
1817
-            '4.8.32.rc.000');
1818
-        return '
1800
+	}
1801
+
1802
+
1803
+
1804
+	/**
1805
+	 * form_form_field_label_wrap
1806
+	 *
1807
+	 * @deprecated    as of 4.8.32.rc.000
1808
+	 * @access        public
1809
+	 * @param        string $label
1810
+	 * @return        string
1811
+	 */
1812
+	public function form_form_field_label_wrap($label)
1813
+	{
1814
+		EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__,
1815
+			__('This method would have been protected but was used on a filter callback'
1816
+			   . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'),
1817
+			'4.8.32.rc.000');
1818
+		return '
1819 1819
 			<tr>
1820 1820
 				<th>
1821 1821
 					' . $label . '
1822 1822
 				</th>';
1823
-    }
1824
-
1825
-
1826
-
1827
-    /**
1828
-     * form_form_field_input__wrap
1829
-     *
1830
-     * @deprecated    as of 4.8.32.rc.000
1831
-     * @access        public
1832
-     * @param        string $input
1833
-     * @return        string
1834
-     */
1835
-    public function form_form_field_input__wrap($input)
1836
-    {
1837
-        EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__,
1838
-            __('This method would have been protected but was used on a filter callback'
1839
-               . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'),
1840
-            '4.8.32.rc.000');
1841
-        return '
1823
+	}
1824
+
1825
+
1826
+
1827
+	/**
1828
+	 * form_form_field_input__wrap
1829
+	 *
1830
+	 * @deprecated    as of 4.8.32.rc.000
1831
+	 * @access        public
1832
+	 * @param        string $input
1833
+	 * @return        string
1834
+	 */
1835
+	public function form_form_field_input__wrap($input)
1836
+	{
1837
+		EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__,
1838
+			__('This method would have been protected but was used on a filter callback'
1839
+			   . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'),
1840
+			'4.8.32.rc.000');
1841
+		return '
1842 1842
 				<td class="reg-admin-attendee-questions-input-td disabled-input">
1843 1843
 					' . $input . '
1844 1844
 				</td>
1845 1845
 			</tr>';
1846
-    }
1847
-
1848
-
1849
-
1850
-    /**
1851
-     * Updates the registration's custom questions according to the form info, if the form is submitted.
1852
-     * If it's not a post, the "view_registrations" route will be called next on the SAME request
1853
-     * to display the page
1854
-     *
1855
-     * @access protected
1856
-     * @return void
1857
-     */
1858
-    protected function _update_attendee_registration_form()
1859
-    {
1860
-        do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
1861
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
1862
-            $REG_ID = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false;
1863
-            $success = $this->_save_reg_custom_questions_form($REG_ID);
1864
-            if ($success) {
1865
-                $what = __('Registration Form', 'event_espresso');
1866
-                $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID)
1867
-                    : array('action' => 'default');
1868
-                $this->_redirect_after_action($success, $what, __('updated', 'event_espresso'), $route);
1869
-            }
1870
-        }
1871
-    }
1872
-
1873
-
1874
-
1875
-    /**
1876
-     * Gets the form for saving registrations custom questions (if done
1877
-     * previously retrieves the cached form object, which may have validation errors in it)
1878
-     *
1879
-     * @param int $REG_ID
1880
-     * @return EE_Registration_Custom_Questions_Form
1881
-     */
1882
-    protected function _get_reg_custom_questions_form($REG_ID)
1883
-    {
1884
-        if ( ! $this->_reg_custom_questions_form) {
1885
-            require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
1886
-            $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(EEM_Registration::instance()
1887
-                                                                                                          ->get_one_by_ID($REG_ID));
1888
-            $this->_reg_custom_questions_form->_construct_finalize(null, null);
1889
-        }
1890
-        return $this->_reg_custom_questions_form;
1891
-    }
1892
-
1893
-
1894
-
1895
-    /**
1896
-     * Saves
1897
-     *
1898
-     * @access private
1899
-     * @param bool $REG_ID
1900
-     * @return bool
1901
-     */
1902
-    private function _save_reg_custom_questions_form($REG_ID = false)
1903
-    {
1904
-        if ( ! $REG_ID) {
1905
-            EE_Error::add_error(__('An error occurred. No registration ID was received.', 'event_espresso'), __FILE__,
1906
-                __FUNCTION__, __LINE__);
1907
-        }
1908
-        $form = $this->_get_reg_custom_questions_form($REG_ID);
1909
-        $form->receive_form_submission($this->_req_data);
1910
-        $success = false;
1911
-        if ($form->is_valid()) {
1912
-            foreach ($form->subforms() as $question_group_id => $question_group_form) {
1913
-                foreach ($question_group_form->inputs() as $question_id => $input) {
1914
-                    $where_conditions = array(
1915
-                        'QST_ID' => $question_id,
1916
-                        'REG_ID' => $REG_ID,
1917
-                    );
1918
-                    $possibly_new_values = array(
1919
-                        'ANS_value' => $input->normalized_value(),
1920
-                    );
1921
-                    $answer = EEM_Answer::instance()->get_one(array($where_conditions));
1922
-                    if ($answer instanceof EE_Answer) {
1923
-                        $success = $answer->save($possibly_new_values);
1924
-                    } else {
1925
-                        //insert it then
1926
-                        $cols_n_vals = array_merge($where_conditions, $possibly_new_values);
1927
-                        $answer = EE_Answer::new_instance($cols_n_vals);
1928
-                        $success = $answer->save();
1929
-                    }
1930
-                }
1931
-            }
1932
-        } else {
1933
-            EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
1934
-        }
1935
-        return $success;
1936
-    }
1937
-
1938
-
1939
-
1940
-    /**
1941
-     *        generates HTML for the Registration main meta box
1942
-     *
1943
-     * @access public
1944
-     * @return void
1945
-     */
1946
-    public function _reg_attendees_meta_box()
1947
-    {
1948
-        $REG = EEM_Registration::instance();
1949
-        //get all other registrations on this transaction, and cache
1950
-        //the attendees for them so we don't have to run another query using force_join
1951
-        $registrations = $REG->get_all(array(
1952
-            array(
1953
-                'TXN_ID' => $this->_registration->transaction_ID(),
1954
-                'REG_ID' => array('!=', $this->_registration->ID()),
1955
-            ),
1956
-            'force_join' => array('Attendee'),
1957
-        ));
1958
-        $this->_template_args['attendees'] = array();
1959
-        $this->_template_args['attendee_notice'] = '';
1960
-        if (empty($registrations)
1961
-            || (is_array($registrations)
1962
-                && ! EEH_Array::get_one_item_from_array($registrations))
1963
-        ) {
1964
-            EE_Error::add_error(__('There are no records attached to this registration. Something may have gone wrong with the registration',
1965
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
1966
-            $this->_template_args['attendee_notice'] = EE_Error::get_notices();
1967
-        } else {
1968
-            $att_nmbr = 1;
1969
-            foreach ($registrations as $registration) {
1970
-                /* @var $registration EE_Registration */
1971
-                $attendee = $registration->attendee()
1972
-                    ? $registration->attendee()
1973
-                    : EEM_Attendee::instance()
1974
-                                  ->create_default_object();
1975
-                $this->_template_args['attendees'][$att_nmbr]['STS_ID'] = $registration->status_ID();
1976
-                $this->_template_args['attendees'][$att_nmbr]['fname'] = $attendee->fname();//( isset( $registration->ATT_fname ) & ! empty( $registration->ATT_fname ) ) ? $registration->ATT_fname : '';
1977
-                $this->_template_args['attendees'][$att_nmbr]['lname'] = $attendee->lname();//( isset( $registration->ATT_lname ) & ! empty( $registration->ATT_lname ) ) ? $registration->ATT_lname : '';
1978
-                $this->_template_args['attendees'][$att_nmbr]['email'] = $attendee->email();//( isset( $registration->ATT_email ) & ! empty( $registration->ATT_email ) ) ? $registration->ATT_email : '';
1979
-                $this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();//( isset( $registration->REG_final_price ) & ! empty( $registration->REG_final_price ) ) ? $registration->REG_final_price : '';
1980
-                $this->_template_args['attendees'][$att_nmbr]['address'] = implode(', ',
1981
-                    $attendee->full_address_as_array());
1982
-                $this->_template_args['attendees'][$att_nmbr]['att_link'] = self::add_query_args_and_nonce(array(
1983
-                    'action' => 'edit_attendee',
1984
-                    'post'   => $attendee->ID(),
1985
-                ), REG_ADMIN_URL);
1986
-                $this->_template_args['attendees'][$att_nmbr]['event_name'] = $registration->event_obj()->name();
1987
-                $att_nmbr++;
1988
-            }
1989
-            //EEH_Debug_Tools::printr( $attendees, '$attendees  <br /><span style="font-size:10px;font-weight:normal;">( file: '. __FILE__ . ' - line no: ' . __LINE__ . ' )</span>', 'auto' );
1990
-            $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
1991
-            //			$this->_template_args['registration_form_url'] = add_query_arg( array( 'action' => 'edit_registration', 'process' => 'attendees'  ), REG_ADMIN_URL );
1992
-        }
1993
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
1994
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
1995
-    }
1996
-
1997
-
1998
-
1999
-    /**
2000
-     *        generates HTML for the Edit Registration side meta box
2001
-     *
2002
-     * @access public
2003
-     * @return void
2004
-     */
2005
-    public function _reg_registrant_side_meta_box()
2006
-    {
2007
-        /*@var $attendee EE_Attendee */
2008
-        $att_check = $this->_registration->attendee();
2009
-        $attendee = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object();
2010
-        //now let's determine if this is not the primary registration.  If it isn't then we set the primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the primary registration object (that way we know if we need to show create button or not)
2011
-        if ( ! $this->_registration->is_primary_registrant()) {
2012
-            $primary_registration = $this->_registration->get_primary_registration();
2013
-            $primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
2014
-                : null;
2015
-            if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
2016
-                //in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own custom attendee object so let's not worry about the primary reg.
2017
-                $primary_registration = null;
2018
-            }
2019
-        } else {
2020
-            $primary_registration = null;
2021
-        }
2022
-        $this->_template_args['ATT_ID'] = $attendee->ID();
2023
-        $this->_template_args['fname'] = $attendee->fname();//$this->_registration->ATT_fname;
2024
-        $this->_template_args['lname'] = $attendee->lname();//$this->_registration->ATT_lname;
2025
-        $this->_template_args['email'] = $attendee->email();//$this->_registration->ATT_email;
2026
-        $this->_template_args['phone'] = $attendee->phone();
2027
-        $this->_template_args['formatted_address'] = EEH_Address::format($attendee);
2028
-        //edit link
2029
-        $this->_template_args['att_edit_link'] = EE_Admin_Page::add_query_args_and_nonce(array(
2030
-            'action' => 'edit_attendee',
2031
-            'post'   => $attendee->ID(),
2032
-        ), REG_ADMIN_URL);
2033
-        $this->_template_args['att_edit_label'] = __('View/Edit Contact', 'event_espresso');
2034
-        //create link
2035
-        $this->_template_args['create_link'] = $primary_registration instanceof EE_Registration
2036
-            ? EE_Admin_Page::add_query_args_and_nonce(array(
2037
-                'action'  => 'duplicate_attendee',
2038
-                '_REG_ID' => $this->_registration->ID(),
2039
-            ), REG_ADMIN_URL) : '';
2040
-        $this->_template_args['create_label'] = __('Create Contact', 'event_espresso');
2041
-        $this->_template_args['att_check'] = $att_check;
2042
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
2043
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
2044
-    }
2045
-
2046
-
2047
-
2048
-    /**
2049
-     * trash or restore registrations
2050
-     *
2051
-     * @param  boolean $trash whether to archive or restore
2052
-     * @access protected
2053
-     * @return void
2054
-     */
2055
-    protected function _trash_or_restore_registrations($trash = true)
2056
-    {
2057
-        $REGM = EEM_Registration::instance();
2058
-        $success = 1;
2059
-        $error = 0;
2060
-        $tickets = array();
2061
-        $dtts = array();
2062
-        //if empty _REG_ID then get out because there's nothing to do
2063
-        if (empty($this->_req_data['_REG_ID'])) {
2064
-            $msg = $trash
2065
-                ? __('In order to trash registrations you must select which ones you wish to trash by clicking the checkboxes.',
2066
-                    'event_espresso')
2067
-                : __('In order to restore registrations you must select which ones you wish to restore by clicking the checkboxes.',
2068
-                    'event_espresso');
2069
-            EE_Error::add_error($msg, __FILE__, __LINE__, __FUNCTION__);
2070
-            $this->_redirect_after_action(false, '', '', array(), true);
2071
-        }
2072
-        //Checkboxes
2073
-        if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
2074
-            // if array has more than one element than success message should be plural
2075
-            $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
2076
-            // cycle thru checkboxes
2077
-            while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
2078
-                /** @var EE_Registration $REG */
2079
-                $REG = $REGM->get_one_by_ID($REG_ID);
2080
-                $payment_count = $REG->get_first_related('Transaction')->count_related('Payment');
2081
-                if ($payment_count > 0) {
2082
-                    $name = $REG->attendee() instanceof EE_Attendee ? $REG->attendee()->full_name()
2083
-                        : __('Unknown Attendee', 'event_espresso');
2084
-                    $error = 1;
2085
-                    $success = 0;
2086
-                    EE_Error::add_error(sprintf(__('The registration for %s could not be trashed because it has payments attached to the related transaction.  If you wish to trash this registration you must first delete the payments on the related transaction.',
2087
-                        'event_espresso'), $name), __FILE__, __FUNCTION__, __LINE__);
2088
-                    continue; //can't trash this registration because it has payments.
2089
-                }
2090
-                $ticket = $REG->get_first_related('Ticket');
2091
-                $tickets[$ticket->ID()] = $ticket;
2092
-                $dtt = $ticket->get_many_related('Datetime');
2093
-                $dtts = array_merge($dtts, $dtt);
2094
-                $updated = $trash ? $REG->delete() : $REG->restore();
2095
-                if ( ! $updated) {
2096
-                    $success = 0;
2097
-                } else {
2098
-                    $success = 2;
2099
-                }/**/
2100
-            }
2101
-        } else {
2102
-            // grab single id and delete
2103
-            $REG_ID = absint($this->_req_data['_REG_ID']);
2104
-            $REG = $REGM->get_one_by_ID($REG_ID);
2105
-            $ticket = $REG->get_first_related('Ticket');
2106
-            $tickets[$ticket->ID()] = $ticket;
2107
-            $dtts = $ticket->get_many_related('Datetime');
2108
-            $updated = $trash ? $REG->delete() : $REG->restore();
2109
-            if ( ! $updated) {
2110
-                $success = 0;
2111
-            }
2112
-        }
2113
-        //now let's update counts
2114
-        EEM_Ticket::instance()->update_tickets_sold($tickets);
2115
-        EEM_Datetime::instance()->update_sold($dtts);
2116
-        $what = $success > 1 ? __('Registrations', 'event_espresso') : __('Registration', 'event_espresso');
2117
-        $action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso');
2118
-        $overwrite_msgs = $error ? true : false;
2119
-        $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'default'), $overwrite_msgs);
2120
-    }
2121
-
2122
-
2123
-
2124
-    /**
2125
-     * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
2126
-     * registration but also.
2127
-     * 1. Removing relations to EE_Attendee
2128
-     * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
2129
-     * ALSO trashed.
2130
-     * 3. Deleting permanently any related Line items but only if the above conditions are met.
2131
-     * 4. Removing relationships between all tickets and the related registrations
2132
-     * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
2133
-     * 6. Deleting permanently any related Checkins.
2134
-     *
2135
-     * @return void
2136
-     */
2137
-    protected function _delete_registrations()
2138
-    {
2139
-        $REG_MDL = EEM_Registration::instance();
2140
-        $success = 1;
2141
-        //Checkboxes
2142
-        if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
2143
-            // if array has more than one element than success message should be plural
2144
-            $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
2145
-            // cycle thru checkboxes
2146
-            while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
2147
-                $REG = $REG_MDL->get_one_by_ID($REG_ID);
2148
-                if ( ! $REG instanceof EE_Registration) {
2149
-                    continue;
2150
-                }
2151
-                $deleted = $this->_delete_registration($REG);
2152
-                if ( ! $deleted) {
2153
-                    $success = 0;
2154
-                }
2155
-            }
2156
-        } else {
2157
-            // grab single id and delete
2158
-            $REG_ID = $this->_req_data['_REG_ID'];
2159
-            $REG = $REG_MDL->get_one_by_ID($REG_ID);
2160
-            $deleted = $this->_delete_registration($REG);
2161
-            if ( ! $deleted) {
2162
-                $success = 0;
2163
-            }
2164
-        }
2165
-        $what = $success > 1 ? __('Registrations', 'event_espresso') : __('Registration', 'event_espresso');
2166
-        $action_desc = __('permanently deleted.', 'event_espresso');
2167
-        $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'default'), true);
2168
-    }
2169
-
2170
-
2171
-
2172
-    /**
2173
-     * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
2174
-     * models get affected.
2175
-     *
2176
-     * @param  EE_Registration $REG registration to be deleted permenantly
2177
-     * @return boolean              true = successful deletion, false = fail.
2178
-     */
2179
-    protected function _delete_registration(EE_Registration $REG)
2180
-    {
2181
-        //first we start with the transaction... ultimately, we WILL not delete permanently if there are any related registrations on the transaction that are NOT trashed.
2182
-        $TXN = $REG->get_first_related('Transaction');
2183
-        $REGS = $TXN->get_many_related('Registration');
2184
-        $all_trashed = true;
2185
-        foreach ($REGS as $registration) {
2186
-            if ( ! $registration->get('REG_deleted')) {
2187
-                $all_trashed = false;
2188
-            }
2189
-        }
2190
-        if ( ! $all_trashed) {
2191
-            EE_Error::add_error(__('Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
2192
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
2193
-            return false;
2194
-        }
2195
-        //k made it here so that means we can delete all the related transactions and their answers (but let's do them separately from THIS one).
2196
-        foreach ($REGS as $registration) {
2197
-            //delete related answers
2198
-            $registration->delete_related_permanently('Answer');
2199
-            //remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
2200
-            $attendee = $registration->get_first_related('Attendee');
2201
-            if ($attendee instanceof EE_Attendee) {
2202
-                $registration->_remove_relation_to($attendee, 'Attendee');
2203
-            }
2204
-            //now remove relationships to tickets on this registration.
2205
-            $registration->_remove_relations('Ticket');
2206
-            //now delete permanently the checkins related to this registration.
2207
-            $registration->delete_related_permanently('Checkin');
2208
-            if ($registration->ID() === $REG->ID()) {
2209
-                continue;
2210
-            } //we don't want to delete permanently the existing registration just yet.
2211
-            //remove relation to transaction for these registrations if NOT the existing registrations
2212
-            $registration->_remove_relations('Transaction');
2213
-            //delete permanently any related messages.
2214
-            $registration->delete_related_permanently('Message');
2215
-            //now delete this registration permanently
2216
-            $registration->delete_permanently();
2217
-        }
2218
-        //now all related registrations on the transaction are handled.  So let's just handle this registration itself (the transaction and line items should be all that's left).
2219
-        //delete the line items related to the transaction for this registration.
2220
-        $TXN->delete_related_permanently('Line_Item');
2221
-        //we need to remove all the relationships on the transaction
2222
-        $TXN->delete_related_permanently('Payment');
2223
-        $TXN->delete_related_permanently('Extra_Meta');
2224
-        $TXN->delete_related_permanently('Message');
2225
-        //now we can delete this REG permanently (and the transaction of course)
2226
-        $REG->delete_related_permanently('Transaction');
2227
-        return $REG->delete_permanently();
2228
-    }
2229
-
2230
-
2231
-
2232
-    /**
2233
-     *    generates HTML for the Register New Attendee Admin page
2234
-     *
2235
-     * @access private
2236
-     * @throws \EE_Error
2237
-     * @return void
2238
-     */
2239
-    public function new_registration()
2240
-    {
2241
-        if ( ! $this->_set_reg_event()) {
2242
-            throw new EE_Error(__('Unable to continue with registering because there is no Event ID in the request',
2243
-                'event_espresso'));
2244
-        }
2245
-        EE_Registry::instance()->REQ->set_espresso_page(true);
2246
-        // gotta start with a clean slate if we're not coming here via ajax
2247
-        if ( ! defined('DOING_AJAX')
2248
-             && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
2249
-        ) {
2250
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
2251
-        }
2252
-        $this->_template_args['event_name'] = '';
2253
-        // event name
2254
-        if ($this->_reg_event) {
2255
-            $this->_template_args['event_name'] = $this->_reg_event->name();
2256
-            $edit_event_url = self::add_query_args_and_nonce(array(
2257
-                'action' => 'edit',
2258
-                'post'   => $this->_reg_event->ID(),
2259
-            ), EVENTS_ADMIN_URL);
2260
-            $edit_event_lnk = '<a href="'
2261
-                              . $edit_event_url
2262
-                              . '" title="'
2263
-                              . esc_attr__('Edit ', 'event_espresso')
2264
-                              . $this->_reg_event->name()
2265
-                              . '">'
2266
-                              . __('Edit Event', 'event_espresso')
2267
-                              . '</a>';
2268
-            $this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
2269
-                                                   . $edit_event_lnk
2270
-                                                   . '</span>';
2271
-        }
2272
-        $this->_template_args['step_content'] = $this->_get_registration_step_content();
2273
-        if (defined('DOING_AJAX')) {
2274
-            $this->_return_json();
2275
-        }
2276
-        // grab header
2277
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
2278
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
2279
-            $this->_template_args, true);
2280
-        //$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
2281
-        // the details template wrapper
2282
-        $this->display_admin_page_with_sidebar();
2283
-    }
2284
-
2285
-
2286
-
2287
-    /**
2288
-     * This returns the content for a registration step
2289
-     *
2290
-     * @access protected
2291
-     * @return string html
2292
-     */
2293
-    protected function _get_registration_step_content()
2294
-    {
2295
-        if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
2296
-            $warning_msg = sprintf(__('%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s',
2297
-                'event_espresso'), '<br />', '<h3 class="important-notice">', '</h3>', '<div class="float-right">',
2298
-                '<span id="redirect_timer" class="important-notice">30</span>', '</div>', '<b>', '</b>');
2299
-            return '
1846
+	}
1847
+
1848
+
1849
+
1850
+	/**
1851
+	 * Updates the registration's custom questions according to the form info, if the form is submitted.
1852
+	 * If it's not a post, the "view_registrations" route will be called next on the SAME request
1853
+	 * to display the page
1854
+	 *
1855
+	 * @access protected
1856
+	 * @return void
1857
+	 */
1858
+	protected function _update_attendee_registration_form()
1859
+	{
1860
+		do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
1861
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
1862
+			$REG_ID = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false;
1863
+			$success = $this->_save_reg_custom_questions_form($REG_ID);
1864
+			if ($success) {
1865
+				$what = __('Registration Form', 'event_espresso');
1866
+				$route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID)
1867
+					: array('action' => 'default');
1868
+				$this->_redirect_after_action($success, $what, __('updated', 'event_espresso'), $route);
1869
+			}
1870
+		}
1871
+	}
1872
+
1873
+
1874
+
1875
+	/**
1876
+	 * Gets the form for saving registrations custom questions (if done
1877
+	 * previously retrieves the cached form object, which may have validation errors in it)
1878
+	 *
1879
+	 * @param int $REG_ID
1880
+	 * @return EE_Registration_Custom_Questions_Form
1881
+	 */
1882
+	protected function _get_reg_custom_questions_form($REG_ID)
1883
+	{
1884
+		if ( ! $this->_reg_custom_questions_form) {
1885
+			require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
1886
+			$this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(EEM_Registration::instance()
1887
+																										  ->get_one_by_ID($REG_ID));
1888
+			$this->_reg_custom_questions_form->_construct_finalize(null, null);
1889
+		}
1890
+		return $this->_reg_custom_questions_form;
1891
+	}
1892
+
1893
+
1894
+
1895
+	/**
1896
+	 * Saves
1897
+	 *
1898
+	 * @access private
1899
+	 * @param bool $REG_ID
1900
+	 * @return bool
1901
+	 */
1902
+	private function _save_reg_custom_questions_form($REG_ID = false)
1903
+	{
1904
+		if ( ! $REG_ID) {
1905
+			EE_Error::add_error(__('An error occurred. No registration ID was received.', 'event_espresso'), __FILE__,
1906
+				__FUNCTION__, __LINE__);
1907
+		}
1908
+		$form = $this->_get_reg_custom_questions_form($REG_ID);
1909
+		$form->receive_form_submission($this->_req_data);
1910
+		$success = false;
1911
+		if ($form->is_valid()) {
1912
+			foreach ($form->subforms() as $question_group_id => $question_group_form) {
1913
+				foreach ($question_group_form->inputs() as $question_id => $input) {
1914
+					$where_conditions = array(
1915
+						'QST_ID' => $question_id,
1916
+						'REG_ID' => $REG_ID,
1917
+					);
1918
+					$possibly_new_values = array(
1919
+						'ANS_value' => $input->normalized_value(),
1920
+					);
1921
+					$answer = EEM_Answer::instance()->get_one(array($where_conditions));
1922
+					if ($answer instanceof EE_Answer) {
1923
+						$success = $answer->save($possibly_new_values);
1924
+					} else {
1925
+						//insert it then
1926
+						$cols_n_vals = array_merge($where_conditions, $possibly_new_values);
1927
+						$answer = EE_Answer::new_instance($cols_n_vals);
1928
+						$success = $answer->save();
1929
+					}
1930
+				}
1931
+			}
1932
+		} else {
1933
+			EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
1934
+		}
1935
+		return $success;
1936
+	}
1937
+
1938
+
1939
+
1940
+	/**
1941
+	 *        generates HTML for the Registration main meta box
1942
+	 *
1943
+	 * @access public
1944
+	 * @return void
1945
+	 */
1946
+	public function _reg_attendees_meta_box()
1947
+	{
1948
+		$REG = EEM_Registration::instance();
1949
+		//get all other registrations on this transaction, and cache
1950
+		//the attendees for them so we don't have to run another query using force_join
1951
+		$registrations = $REG->get_all(array(
1952
+			array(
1953
+				'TXN_ID' => $this->_registration->transaction_ID(),
1954
+				'REG_ID' => array('!=', $this->_registration->ID()),
1955
+			),
1956
+			'force_join' => array('Attendee'),
1957
+		));
1958
+		$this->_template_args['attendees'] = array();
1959
+		$this->_template_args['attendee_notice'] = '';
1960
+		if (empty($registrations)
1961
+			|| (is_array($registrations)
1962
+				&& ! EEH_Array::get_one_item_from_array($registrations))
1963
+		) {
1964
+			EE_Error::add_error(__('There are no records attached to this registration. Something may have gone wrong with the registration',
1965
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
1966
+			$this->_template_args['attendee_notice'] = EE_Error::get_notices();
1967
+		} else {
1968
+			$att_nmbr = 1;
1969
+			foreach ($registrations as $registration) {
1970
+				/* @var $registration EE_Registration */
1971
+				$attendee = $registration->attendee()
1972
+					? $registration->attendee()
1973
+					: EEM_Attendee::instance()
1974
+								  ->create_default_object();
1975
+				$this->_template_args['attendees'][$att_nmbr]['STS_ID'] = $registration->status_ID();
1976
+				$this->_template_args['attendees'][$att_nmbr]['fname'] = $attendee->fname();//( isset( $registration->ATT_fname ) & ! empty( $registration->ATT_fname ) ) ? $registration->ATT_fname : '';
1977
+				$this->_template_args['attendees'][$att_nmbr]['lname'] = $attendee->lname();//( isset( $registration->ATT_lname ) & ! empty( $registration->ATT_lname ) ) ? $registration->ATT_lname : '';
1978
+				$this->_template_args['attendees'][$att_nmbr]['email'] = $attendee->email();//( isset( $registration->ATT_email ) & ! empty( $registration->ATT_email ) ) ? $registration->ATT_email : '';
1979
+				$this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();//( isset( $registration->REG_final_price ) & ! empty( $registration->REG_final_price ) ) ? $registration->REG_final_price : '';
1980
+				$this->_template_args['attendees'][$att_nmbr]['address'] = implode(', ',
1981
+					$attendee->full_address_as_array());
1982
+				$this->_template_args['attendees'][$att_nmbr]['att_link'] = self::add_query_args_and_nonce(array(
1983
+					'action' => 'edit_attendee',
1984
+					'post'   => $attendee->ID(),
1985
+				), REG_ADMIN_URL);
1986
+				$this->_template_args['attendees'][$att_nmbr]['event_name'] = $registration->event_obj()->name();
1987
+				$att_nmbr++;
1988
+			}
1989
+			//EEH_Debug_Tools::printr( $attendees, '$attendees  <br /><span style="font-size:10px;font-weight:normal;">( file: '. __FILE__ . ' - line no: ' . __LINE__ . ' )</span>', 'auto' );
1990
+			$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
1991
+			//			$this->_template_args['registration_form_url'] = add_query_arg( array( 'action' => 'edit_registration', 'process' => 'attendees'  ), REG_ADMIN_URL );
1992
+		}
1993
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
1994
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
1995
+	}
1996
+
1997
+
1998
+
1999
+	/**
2000
+	 *        generates HTML for the Edit Registration side meta box
2001
+	 *
2002
+	 * @access public
2003
+	 * @return void
2004
+	 */
2005
+	public function _reg_registrant_side_meta_box()
2006
+	{
2007
+		/*@var $attendee EE_Attendee */
2008
+		$att_check = $this->_registration->attendee();
2009
+		$attendee = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object();
2010
+		//now let's determine if this is not the primary registration.  If it isn't then we set the primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the primary registration object (that way we know if we need to show create button or not)
2011
+		if ( ! $this->_registration->is_primary_registrant()) {
2012
+			$primary_registration = $this->_registration->get_primary_registration();
2013
+			$primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
2014
+				: null;
2015
+			if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
2016
+				//in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own custom attendee object so let's not worry about the primary reg.
2017
+				$primary_registration = null;
2018
+			}
2019
+		} else {
2020
+			$primary_registration = null;
2021
+		}
2022
+		$this->_template_args['ATT_ID'] = $attendee->ID();
2023
+		$this->_template_args['fname'] = $attendee->fname();//$this->_registration->ATT_fname;
2024
+		$this->_template_args['lname'] = $attendee->lname();//$this->_registration->ATT_lname;
2025
+		$this->_template_args['email'] = $attendee->email();//$this->_registration->ATT_email;
2026
+		$this->_template_args['phone'] = $attendee->phone();
2027
+		$this->_template_args['formatted_address'] = EEH_Address::format($attendee);
2028
+		//edit link
2029
+		$this->_template_args['att_edit_link'] = EE_Admin_Page::add_query_args_and_nonce(array(
2030
+			'action' => 'edit_attendee',
2031
+			'post'   => $attendee->ID(),
2032
+		), REG_ADMIN_URL);
2033
+		$this->_template_args['att_edit_label'] = __('View/Edit Contact', 'event_espresso');
2034
+		//create link
2035
+		$this->_template_args['create_link'] = $primary_registration instanceof EE_Registration
2036
+			? EE_Admin_Page::add_query_args_and_nonce(array(
2037
+				'action'  => 'duplicate_attendee',
2038
+				'_REG_ID' => $this->_registration->ID(),
2039
+			), REG_ADMIN_URL) : '';
2040
+		$this->_template_args['create_label'] = __('Create Contact', 'event_espresso');
2041
+		$this->_template_args['att_check'] = $att_check;
2042
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
2043
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
2044
+	}
2045
+
2046
+
2047
+
2048
+	/**
2049
+	 * trash or restore registrations
2050
+	 *
2051
+	 * @param  boolean $trash whether to archive or restore
2052
+	 * @access protected
2053
+	 * @return void
2054
+	 */
2055
+	protected function _trash_or_restore_registrations($trash = true)
2056
+	{
2057
+		$REGM = EEM_Registration::instance();
2058
+		$success = 1;
2059
+		$error = 0;
2060
+		$tickets = array();
2061
+		$dtts = array();
2062
+		//if empty _REG_ID then get out because there's nothing to do
2063
+		if (empty($this->_req_data['_REG_ID'])) {
2064
+			$msg = $trash
2065
+				? __('In order to trash registrations you must select which ones you wish to trash by clicking the checkboxes.',
2066
+					'event_espresso')
2067
+				: __('In order to restore registrations you must select which ones you wish to restore by clicking the checkboxes.',
2068
+					'event_espresso');
2069
+			EE_Error::add_error($msg, __FILE__, __LINE__, __FUNCTION__);
2070
+			$this->_redirect_after_action(false, '', '', array(), true);
2071
+		}
2072
+		//Checkboxes
2073
+		if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
2074
+			// if array has more than one element than success message should be plural
2075
+			$success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
2076
+			// cycle thru checkboxes
2077
+			while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
2078
+				/** @var EE_Registration $REG */
2079
+				$REG = $REGM->get_one_by_ID($REG_ID);
2080
+				$payment_count = $REG->get_first_related('Transaction')->count_related('Payment');
2081
+				if ($payment_count > 0) {
2082
+					$name = $REG->attendee() instanceof EE_Attendee ? $REG->attendee()->full_name()
2083
+						: __('Unknown Attendee', 'event_espresso');
2084
+					$error = 1;
2085
+					$success = 0;
2086
+					EE_Error::add_error(sprintf(__('The registration for %s could not be trashed because it has payments attached to the related transaction.  If you wish to trash this registration you must first delete the payments on the related transaction.',
2087
+						'event_espresso'), $name), __FILE__, __FUNCTION__, __LINE__);
2088
+					continue; //can't trash this registration because it has payments.
2089
+				}
2090
+				$ticket = $REG->get_first_related('Ticket');
2091
+				$tickets[$ticket->ID()] = $ticket;
2092
+				$dtt = $ticket->get_many_related('Datetime');
2093
+				$dtts = array_merge($dtts, $dtt);
2094
+				$updated = $trash ? $REG->delete() : $REG->restore();
2095
+				if ( ! $updated) {
2096
+					$success = 0;
2097
+				} else {
2098
+					$success = 2;
2099
+				}/**/
2100
+			}
2101
+		} else {
2102
+			// grab single id and delete
2103
+			$REG_ID = absint($this->_req_data['_REG_ID']);
2104
+			$REG = $REGM->get_one_by_ID($REG_ID);
2105
+			$ticket = $REG->get_first_related('Ticket');
2106
+			$tickets[$ticket->ID()] = $ticket;
2107
+			$dtts = $ticket->get_many_related('Datetime');
2108
+			$updated = $trash ? $REG->delete() : $REG->restore();
2109
+			if ( ! $updated) {
2110
+				$success = 0;
2111
+			}
2112
+		}
2113
+		//now let's update counts
2114
+		EEM_Ticket::instance()->update_tickets_sold($tickets);
2115
+		EEM_Datetime::instance()->update_sold($dtts);
2116
+		$what = $success > 1 ? __('Registrations', 'event_espresso') : __('Registration', 'event_espresso');
2117
+		$action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso');
2118
+		$overwrite_msgs = $error ? true : false;
2119
+		$this->_redirect_after_action($success, $what, $action_desc, array('action' => 'default'), $overwrite_msgs);
2120
+	}
2121
+
2122
+
2123
+
2124
+	/**
2125
+	 * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
2126
+	 * registration but also.
2127
+	 * 1. Removing relations to EE_Attendee
2128
+	 * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
2129
+	 * ALSO trashed.
2130
+	 * 3. Deleting permanently any related Line items but only if the above conditions are met.
2131
+	 * 4. Removing relationships between all tickets and the related registrations
2132
+	 * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
2133
+	 * 6. Deleting permanently any related Checkins.
2134
+	 *
2135
+	 * @return void
2136
+	 */
2137
+	protected function _delete_registrations()
2138
+	{
2139
+		$REG_MDL = EEM_Registration::instance();
2140
+		$success = 1;
2141
+		//Checkboxes
2142
+		if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
2143
+			// if array has more than one element than success message should be plural
2144
+			$success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
2145
+			// cycle thru checkboxes
2146
+			while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
2147
+				$REG = $REG_MDL->get_one_by_ID($REG_ID);
2148
+				if ( ! $REG instanceof EE_Registration) {
2149
+					continue;
2150
+				}
2151
+				$deleted = $this->_delete_registration($REG);
2152
+				if ( ! $deleted) {
2153
+					$success = 0;
2154
+				}
2155
+			}
2156
+		} else {
2157
+			// grab single id and delete
2158
+			$REG_ID = $this->_req_data['_REG_ID'];
2159
+			$REG = $REG_MDL->get_one_by_ID($REG_ID);
2160
+			$deleted = $this->_delete_registration($REG);
2161
+			if ( ! $deleted) {
2162
+				$success = 0;
2163
+			}
2164
+		}
2165
+		$what = $success > 1 ? __('Registrations', 'event_espresso') : __('Registration', 'event_espresso');
2166
+		$action_desc = __('permanently deleted.', 'event_espresso');
2167
+		$this->_redirect_after_action($success, $what, $action_desc, array('action' => 'default'), true);
2168
+	}
2169
+
2170
+
2171
+
2172
+	/**
2173
+	 * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
2174
+	 * models get affected.
2175
+	 *
2176
+	 * @param  EE_Registration $REG registration to be deleted permenantly
2177
+	 * @return boolean              true = successful deletion, false = fail.
2178
+	 */
2179
+	protected function _delete_registration(EE_Registration $REG)
2180
+	{
2181
+		//first we start with the transaction... ultimately, we WILL not delete permanently if there are any related registrations on the transaction that are NOT trashed.
2182
+		$TXN = $REG->get_first_related('Transaction');
2183
+		$REGS = $TXN->get_many_related('Registration');
2184
+		$all_trashed = true;
2185
+		foreach ($REGS as $registration) {
2186
+			if ( ! $registration->get('REG_deleted')) {
2187
+				$all_trashed = false;
2188
+			}
2189
+		}
2190
+		if ( ! $all_trashed) {
2191
+			EE_Error::add_error(__('Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
2192
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
2193
+			return false;
2194
+		}
2195
+		//k made it here so that means we can delete all the related transactions and their answers (but let's do them separately from THIS one).
2196
+		foreach ($REGS as $registration) {
2197
+			//delete related answers
2198
+			$registration->delete_related_permanently('Answer');
2199
+			//remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
2200
+			$attendee = $registration->get_first_related('Attendee');
2201
+			if ($attendee instanceof EE_Attendee) {
2202
+				$registration->_remove_relation_to($attendee, 'Attendee');
2203
+			}
2204
+			//now remove relationships to tickets on this registration.
2205
+			$registration->_remove_relations('Ticket');
2206
+			//now delete permanently the checkins related to this registration.
2207
+			$registration->delete_related_permanently('Checkin');
2208
+			if ($registration->ID() === $REG->ID()) {
2209
+				continue;
2210
+			} //we don't want to delete permanently the existing registration just yet.
2211
+			//remove relation to transaction for these registrations if NOT the existing registrations
2212
+			$registration->_remove_relations('Transaction');
2213
+			//delete permanently any related messages.
2214
+			$registration->delete_related_permanently('Message');
2215
+			//now delete this registration permanently
2216
+			$registration->delete_permanently();
2217
+		}
2218
+		//now all related registrations on the transaction are handled.  So let's just handle this registration itself (the transaction and line items should be all that's left).
2219
+		//delete the line items related to the transaction for this registration.
2220
+		$TXN->delete_related_permanently('Line_Item');
2221
+		//we need to remove all the relationships on the transaction
2222
+		$TXN->delete_related_permanently('Payment');
2223
+		$TXN->delete_related_permanently('Extra_Meta');
2224
+		$TXN->delete_related_permanently('Message');
2225
+		//now we can delete this REG permanently (and the transaction of course)
2226
+		$REG->delete_related_permanently('Transaction');
2227
+		return $REG->delete_permanently();
2228
+	}
2229
+
2230
+
2231
+
2232
+	/**
2233
+	 *    generates HTML for the Register New Attendee Admin page
2234
+	 *
2235
+	 * @access private
2236
+	 * @throws \EE_Error
2237
+	 * @return void
2238
+	 */
2239
+	public function new_registration()
2240
+	{
2241
+		if ( ! $this->_set_reg_event()) {
2242
+			throw new EE_Error(__('Unable to continue with registering because there is no Event ID in the request',
2243
+				'event_espresso'));
2244
+		}
2245
+		EE_Registry::instance()->REQ->set_espresso_page(true);
2246
+		// gotta start with a clean slate if we're not coming here via ajax
2247
+		if ( ! defined('DOING_AJAX')
2248
+			 && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
2249
+		) {
2250
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
2251
+		}
2252
+		$this->_template_args['event_name'] = '';
2253
+		// event name
2254
+		if ($this->_reg_event) {
2255
+			$this->_template_args['event_name'] = $this->_reg_event->name();
2256
+			$edit_event_url = self::add_query_args_and_nonce(array(
2257
+				'action' => 'edit',
2258
+				'post'   => $this->_reg_event->ID(),
2259
+			), EVENTS_ADMIN_URL);
2260
+			$edit_event_lnk = '<a href="'
2261
+							  . $edit_event_url
2262
+							  . '" title="'
2263
+							  . esc_attr__('Edit ', 'event_espresso')
2264
+							  . $this->_reg_event->name()
2265
+							  . '">'
2266
+							  . __('Edit Event', 'event_espresso')
2267
+							  . '</a>';
2268
+			$this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
2269
+												   . $edit_event_lnk
2270
+												   . '</span>';
2271
+		}
2272
+		$this->_template_args['step_content'] = $this->_get_registration_step_content();
2273
+		if (defined('DOING_AJAX')) {
2274
+			$this->_return_json();
2275
+		}
2276
+		// grab header
2277
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
2278
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
2279
+			$this->_template_args, true);
2280
+		//$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
2281
+		// the details template wrapper
2282
+		$this->display_admin_page_with_sidebar();
2283
+	}
2284
+
2285
+
2286
+
2287
+	/**
2288
+	 * This returns the content for a registration step
2289
+	 *
2290
+	 * @access protected
2291
+	 * @return string html
2292
+	 */
2293
+	protected function _get_registration_step_content()
2294
+	{
2295
+		if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
2296
+			$warning_msg = sprintf(__('%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s',
2297
+				'event_espresso'), '<br />', '<h3 class="important-notice">', '</h3>', '<div class="float-right">',
2298
+				'<span id="redirect_timer" class="important-notice">30</span>', '</div>', '<b>', '</b>');
2299
+			return '
2300 2300
 	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div>
2301 2301
 	<script >
2302 2302
 		// WHOAH !!! it appears that someone is using the back button from the Transaction admin page
@@ -2309,646 +2309,646 @@  discard block
 block discarded – undo
2309 2309
 	        }
2310 2310
 	    }, 800 );
2311 2311
 	</script >';
2312
-        }
2313
-        $template_args = array(
2314
-            'title'                    => '',
2315
-            'content'                  => '',
2316
-            'step_button_text'         => '',
2317
-            'show_notification_toggle' => false,
2318
-        );
2319
-        //to indicate we're processing a new registration
2320
-        $hidden_fields = array(
2321
-            'processing_registration' => array(
2322
-                'type'  => 'hidden',
2323
-                'value' => 0,
2324
-            ),
2325
-            'event_id'                => array(
2326
-                'type'  => 'hidden',
2327
-                'value' => $this->_reg_event->ID(),
2328
-            ),
2329
-        );
2330
-        //if the cart is empty then we know we're at step one so we'll display ticket selector
2331
-        $cart = EE_Registry::instance()->SSN->cart();
2332
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
2333
-        switch ($step) {
2334
-            case 'ticket' :
2335
-                $hidden_fields['processing_registration']['value'] = 1;
2336
-                $template_args['title'] = __('Step One: Select the Ticket for this registration', 'event_espresso');
2337
-                $template_args['content'] = EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
2338
-                $template_args['step_button_text'] = __('Add Tickets and Continue to Registrant Details',
2339
-                    'event_espresso');
2340
-                $template_args['show_notification_toggle'] = false;
2341
-                break;
2342
-            case 'questions' :
2343
-                $hidden_fields['processing_registration']['value'] = 2;
2344
-                $template_args['title'] = __('Step Two: Add Registrant Details for this Registration',
2345
-                    'event_espresso');
2346
-                //in theory we should be able to run EED_SPCO at this point because the cart should have been setup properly by the first process_reg_step run.
2347
-                $template_args['content'] = EED_Single_Page_Checkout::registration_checkout_for_admin();
2348
-                $template_args['step_button_text'] = __('Save Registration and Continue to Details', 'event_espresso');
2349
-                $template_args['show_notification_toggle'] = true;
2350
-                break;
2351
-        }
2352
-        $this->_set_add_edit_form_tags('process_reg_step',
2353
-            $hidden_fields); //we come back to the process_registration_step route.
2354
-        return EEH_Template::display_template(REG_TEMPLATE_PATH
2355
-                                              . 'reg_admin_register_new_attendee_step_content.template.php',
2356
-            $template_args, true);
2357
-    }
2358
-
2359
-
2360
-
2361
-    /**
2362
-     *        set_reg_event
2363
-     *
2364
-     * @access private
2365
-     * @return boolean
2366
-     */
2367
-    private function _set_reg_event()
2368
-    {
2369
-        if (is_object($this->_reg_event)) {
2370
-            return true;
2371
-        }
2372
-        $EVT_ID = ( ! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
2373
-        if ( ! $EVT_ID) {
2374
-            return false;
2375
-        }
2376
-        $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
2377
-        return true;
2378
-    }
2379
-
2380
-
2381
-
2382
-    /**
2383
-     * process_reg_step
2384
-     *
2385
-     * @access        public
2386
-     * @return        string
2387
-     * @throws \RuntimeException
2388
-     * @throws \EE_Error
2389
-     */
2390
-    public function process_reg_step()
2391
-    {
2392
-        EE_System::do_not_cache();
2393
-        $this->_set_reg_event();
2394
-        EE_Registry::instance()->REQ->set_espresso_page(true);
2395
-        EE_Registry::instance()->REQ->set('uts', time());
2396
-        //what step are we on?
2397
-        $cart = EE_Registry::instance()->SSN->cart();
2398
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
2399
-        //if doing ajax then we need to verify the nonce
2400
-        if (defined('DOING_AJAX')) {
2401
-            $nonce = isset($this->_req_data[$this->_req_nonce])
2402
-                ? sanitize_text_field($this->_req_data[$this->_req_nonce]) : '';
2403
-            $this->_verify_nonce($nonce, $this->_req_nonce);
2404
-        }
2405
-        switch ($step) {
2406
-            case 'ticket' :
2407
-                //process ticket selection
2408
-                $success = EED_Ticket_Selector::instance()->process_ticket_selections();
2409
-                if ($success) {
2410
-                    EE_Error::add_success(esc_html__('Tickets Selected. Now complete the registration.',
2411
-                        'event_espresso'));
2412
-                } else {
2413
-                    $query_args['step_error'] = $this->_req_data['step_error'] = true;
2414
-                }
2415
-                if (defined('DOING_AJAX')) {
2416
-                    $this->new_registration(); //display next step
2417
-                } else {
2418
-                    $query_args = array(
2419
-                        'action'                  => 'new_registration',
2420
-                        'processing_registration' => 1,
2421
-                        'event_id'                => $this->_reg_event->ID(),
2422
-                        'uts'                     => time(),
2423
-                    );
2424
-                    $this->_redirect_after_action(false, '', '', $query_args, true);
2425
-                }
2426
-                break;
2427
-            case 'questions' :
2428
-                if ( ! isset($this->_req_data['txn_reg_status_change'], $this->_req_data['txn_reg_status_change']['send_notifications'])) {
2429
-                    add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
2430
-                }
2431
-                //process registration
2432
-                $transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
2433
-                if ($cart instanceof EE_Cart) {
2434
-                    $grand_total = $cart->get_cart_grand_total();
2435
-                    if ($grand_total instanceof EE_Line_Item) {
2436
-                        $grand_total->save_this_and_descendants_to_txn();
2437
-                    }
2438
-                }
2439
-                if ( ! $transaction instanceof EE_Transaction) {
2440
-                    $query_args = array(
2441
-                        'action'                  => 'new_registration',
2442
-                        'processing_registration' => 2,
2443
-                        'event_id'                => $this->_reg_event->ID(),
2444
-                        'uts'                     => time(),
2445
-                    );
2446
-                    if (defined('DOING_AJAX')) {
2447
-                        //display registration form again because there are errors (maybe validation?)
2448
-                        $this->new_registration();
2449
-                        return;
2450
-                    } else {
2451
-                        $this->_redirect_after_action(false, '', '', $query_args, true);
2452
-                        return;
2453
-                    }
2454
-                }
2455
-                // maybe update status, and make sure to save transaction if not done already
2456
-                if ( ! $transaction->update_status_based_on_total_paid()) {
2457
-                    $transaction->save();
2458
-                }
2459
-                EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
2460
-                $this->_req_data = array();
2461
-                $query_args = array(
2462
-                    'action'        => 'redirect_to_txn',
2463
-                    'TXN_ID'        => $transaction->ID(),
2464
-                    'EVT_ID'        => $this->_reg_event->ID(),
2465
-                    'event_name'    => urlencode($this->_reg_event->name()),
2466
-                    'redirect_from' => 'new_registration',
2467
-                );
2468
-                $this->_redirect_after_action(false, '', '', $query_args, true);
2469
-                break;
2470
-        }
2471
-        //what are you looking here for?  Should be nothing to do at this point.
2472
-    }
2473
-
2474
-
2475
-
2476
-    /**
2477
-     * redirect_to_txn
2478
-     *
2479
-     * @access public
2480
-     * @return void
2481
-     */
2482
-    public function redirect_to_txn()
2483
-    {
2484
-        EE_System::do_not_cache();
2485
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
2486
-        $query_args = array(
2487
-            'action' => 'view_transaction',
2488
-            'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0,
2489
-            'page'   => 'espresso_transactions',
2490
-        );
2491
-        if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) {
2492
-            $query_args['EVT_ID'] = $this->_req_data['EVT_ID'];
2493
-            $query_args['event_name'] = urlencode($this->_req_data['event_name']);
2494
-            $query_args['redirect_from'] = $this->_req_data['redirect_from'];
2495
-        }
2496
-        EE_Error::add_success(__('Registration Created.  Please review the transaction and add any payments as necessary',
2497
-                'event_espresso'));
2498
-        $this->_redirect_after_action(false, '', '', $query_args, true);
2499
-    }
2500
-
2501
-
2502
-
2503
-    /**
2504
-     *        generates HTML for the Attendee Contact List
2505
-     *
2506
-     * @access protected
2507
-     * @return void
2508
-     */
2509
-    protected function _attendee_contact_list_table()
2510
-    {
2511
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2512
-        $this->_search_btn_label = __('Contacts', 'event_espresso');
2513
-        $this->display_admin_list_table_page_with_no_sidebar();
2514
-    }
2515
-
2516
-
2517
-
2518
-    /**
2519
-     *        get_attendees
2520
-     *
2521
-     * @param bool $count whether to return count or data.
2522
-     * @access public
2523
-     * @return array
2524
-     */
2525
-    public function get_attendees($per_page, $count = false, $trash = false)
2526
-    {
2527
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2528
-        require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
2529
-        $ATT_MDL = EEM_Attendee::instance();
2530
-        $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
2531
-        switch ($this->_req_data['orderby']) {
2532
-            case 'ATT_ID':
2533
-                $orderby = 'ATT_ID';
2534
-                break;
2535
-            case 'ATT_fname':
2536
-                $orderby = 'ATT_fname';
2537
-                break;
2538
-            case 'ATT_email':
2539
-                $orderby = 'ATT_email';
2540
-                break;
2541
-            case 'ATT_city':
2542
-                $orderby = 'ATT_city';
2543
-                break;
2544
-            case 'STA_ID':
2545
-                $orderby = 'STA_ID';
2546
-                break;
2547
-            case 'CNT_ID':
2548
-                $orderby = 'CNT_ID';
2549
-                break;
2550
-            default:
2551
-                $orderby = 'ATT_lname';
2552
-        }
2553
-        $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
2554
-            : 'ASC';
2555
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
2556
-            ? $this->_req_data['paged'] : 1;
2557
-        $per_page = isset($per_page) && ! empty($per_page) ? $per_page : 10;
2558
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
2559
-            ? $this->_req_data['perpage'] : $per_page;
2560
-        $_where = array();
2561
-        if ( ! empty($this->_req_data['s'])) {
2562
-            $sstr = '%' . $this->_req_data['s'] . '%';
2563
-            $_where['OR'] = array(
2564
-                'Registration.Event.EVT_name'       => array('LIKE', $sstr),
2565
-                'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
2566
-                'Registration.Event.EVT_short_desc' => array('LIKE', $sstr),
2567
-                'ATT_fname'                         => array('LIKE', $sstr),
2568
-                'ATT_lname'                         => array('LIKE', $sstr),
2569
-                'ATT_short_bio'                     => array('LIKE', $sstr),
2570
-                'ATT_email'                         => array('LIKE', $sstr),
2571
-                'ATT_address'                       => array('LIKE', $sstr),
2572
-                'ATT_address2'                      => array('LIKE', $sstr),
2573
-                'ATT_city'                          => array('LIKE', $sstr),
2574
-                'Country.CNT_name'                  => array('LIKE', $sstr),
2575
-                'State.STA_name'                    => array('LIKE', $sstr),
2576
-                'ATT_phone'                         => array('LIKE', $sstr),
2577
-                'Registration.REG_final_price'      => array('LIKE', $sstr),
2578
-                'Registration.REG_code'             => array('LIKE', $sstr),
2579
-                'Registration.REG_count'            => array('LIKE', $sstr),
2580
-                'Registration.REG_group_size'       => array('LIKE', $sstr),
2581
-            );
2582
-        }
2583
-        $offset = ($current_page - 1) * $per_page;
2584
-        $limit = $count ? null : array($offset, $per_page);
2585
-        if ($trash) {
2586
-            $_where['status'] = array('!=', 'publish');
2587
-            $all_attendees = $count
2588
-                ? $ATT_MDL->count(array(
2589
-                    $_where,
2590
-                    'order_by' => array($orderby => $sort),
2591
-                    'limit'    => $limit,
2592
-                ), 'ATT_ID', true)
2593
-                : $ATT_MDL->get_all(array(
2594
-                    $_where,
2595
-                    'order_by' => array($orderby => $sort),
2596
-                    'limit'    => $limit,
2597
-                ));
2598
-        } else {
2599
-            $_where['status'] = array('IN', array('publish'));
2600
-            $all_attendees = $count
2601
-                ? $ATT_MDL->count(array(
2602
-                    $_where,
2603
-                    'order_by' => array($orderby => $sort),
2604
-                    'limit'    => $limit,
2605
-                ), 'ATT_ID', true)
2606
-                : $ATT_MDL->get_all(array(
2607
-                    $_where,
2608
-                    'order_by' => array($orderby => $sort),
2609
-                    'limit'    => $limit,
2610
-                ));
2611
-        }
2612
-        return $all_attendees;
2613
-    }
2614
-
2615
-
2616
-
2617
-    /**
2618
-     * This is just taking care of resending the registration confirmation
2619
-     *
2620
-     * @access protected
2621
-     * @return void
2622
-     */
2623
-    protected function _resend_registration()
2624
-    {
2625
-        $this->_process_resend_registration();
2626
-        $query_args = isset($this->_req_data['redirect_to'])
2627
-            ? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID'])
2628
-            : array(
2629
-                'action' => 'default',
2630
-            );
2631
-        $this->_redirect_after_action(false, '', '', $query_args, true);
2632
-    }
2633
-
2634
-
2635
-
2636
-    public function _registrations_report()
2637
-    {
2638
-        if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
2639
-            wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array(
2640
-                'page'        => 'espresso_batch',
2641
-                'batch'       => 'file',
2642
-                'EVT_ID'      => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
2643
-                'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
2644
-                'return_url'  => urlencode($this->_req_data['return_url']),
2645
-            )));
2646
-        } else {
2647
-            $new_request_args = array(
2648
-                'export' => 'report',
2649
-                'action' => 'registrations_report_for_event',
2650
-                'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
2651
-            );
2652
-            $this->_req_data = array_merge($this->_req_data, $new_request_args);
2653
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
2654
-                require_once(EE_CLASSES . 'EE_Export.class.php');
2655
-                $EE_Export = EE_Export::instance($this->_req_data);
2656
-                $EE_Export->export();
2657
-            }
2658
-        }
2659
-    }
2660
-
2661
-
2662
-
2663
-    public function _contact_list_export()
2664
-    {
2665
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
2666
-            require_once(EE_CLASSES . 'EE_Export.class.php');
2667
-            $EE_Export = EE_Export::instance($this->_req_data);
2668
-            $EE_Export->export_attendees();
2669
-        }
2670
-    }
2671
-
2672
-
2673
-
2674
-    public function _contact_list_report()
2675
-    {
2676
-        if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
2677
-            wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array(
2678
-                'page'        => 'espresso_batch',
2679
-                'batch'       => 'file',
2680
-                'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
2681
-                'return_url'  => urlencode($this->_req_data['return_url']),
2682
-            )));
2683
-        } else {
2684
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
2685
-                require_once(EE_CLASSES . 'EE_Export.class.php');
2686
-                $EE_Export = EE_Export::instance($this->_req_data);
2687
-                $EE_Export->report_attendees();
2688
-            }
2689
-        }
2690
-    }
2691
-
2692
-
2693
-
2694
-
2695
-
2696
-    /***************************************        ATTENDEE DETAILS        ***************************************/
2697
-    /**
2698
-     * This duplicates the attendee object for the given incoming registration id and attendee_id.
2699
-     *
2700
-     * @return void
2701
-     */
2702
-    protected function _duplicate_attendee()
2703
-    {
2704
-        $action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default';
2705
-        //verify we have necessary info
2706
-        if (empty($this->_req_data['_REG_ID'])) {
2707
-            EE_Error::add_error(__('Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
2708
-                'event_espresso'), __FILE__, __LINE__, __FUNCTION__);
2709
-            $query_args = array('action' => $action);
2710
-            $this->_redirect_after_action('', '', '', $query_args, true);
2711
-        }
2712
-        //okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
2713
-        $registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']);
2714
-        $attendee = $registration->attendee();
2715
-        //remove relation of existing attendee on registration
2716
-        $registration->_remove_relation_to($attendee, 'Attendee');
2717
-        //new attendee
2718
-        $new_attendee = clone $attendee;
2719
-        $new_attendee->set('ATT_ID', 0);
2720
-        $new_attendee->save();
2721
-        //add new attendee to reg
2722
-        $registration->_add_relation_to($new_attendee, 'Attendee');
2723
-        EE_Error::add_success(__('New Contact record created.  Now make any edits you wish to make for this contact.',
2724
-            'event_espresso'));
2725
-        //redirect to edit page for attendee
2726
-        $query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee');
2727
-        $this->_redirect_after_action('', '', '', $query_args, true);
2728
-    }
2729
-
2730
-
2731
-
2732
-    //related to cpt routes
2733
-    protected function _insert_update_cpt_item($post_id, $post)
2734
-    {
2735
-        $success = true;
2736
-        $attendee = EEM_Attendee::instance()->get_one_by_ID($post_id);
2737
-        //for attendee updates
2738
-        if ($post->post_type = 'espresso_attendees' && ! empty($attendee)) {
2739
-            //note we should only be UPDATING attendees at this point.
2740
-            $updated_fields = array(
2741
-                'ATT_fname'     => $this->_req_data['ATT_fname'],
2742
-                'ATT_lname'     => $this->_req_data['ATT_lname'],
2743
-                'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
2744
-                'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
2745
-                'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
2746
-                'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
2747
-                'STA_ID'        => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '',
2748
-                'CNT_ISO'       => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '',
2749
-                'ATT_zip'       => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '',
2750
-                'ATT_email'     => isset($this->_req_data['ATT_email']) ? $this->_req_data['ATT_email'] : '',
2751
-                'ATT_phone'     => isset($this->_req_data['ATT_phone']) ? $this->_req_data['ATT_phone'] : '',
2752
-            );
2753
-            foreach ($updated_fields as $field => $value) {
2754
-                $attendee->set($field, $value);
2755
-            }
2756
-            $success = $attendee->save();
2757
-            $attendee_update_callbacks = apply_filters('FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
2758
-                array());
2759
-            foreach ($attendee_update_callbacks as $a_callback) {
2760
-                if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) {
2761
-                    throw new EE_Error(sprintf(__('The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback.  Please check the spelling.',
2762
-                        'event_espresso'), $a_callback));
2763
-                }
2764
-            }
2765
-        }
2766
-        if ($success === false) {
2767
-            EE_Error::add_error(__('Something went wrong with updating the meta table data for the registration.',
2768
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
2769
-        }
2770
-    }
2771
-
2772
-
2773
-
2774
-    public function trash_cpt_item($post_id)
2775
-    {
2776
-    }
2777
-
2778
-
2779
-
2780
-    public function delete_cpt_item($post_id)
2781
-    {
2782
-    }
2783
-
2784
-
2785
-
2786
-    public function restore_cpt_item($post_id)
2787
-    {
2788
-    }
2789
-
2790
-
2791
-
2792
-    protected function _restore_cpt_item($post_id, $revision_id)
2793
-    {
2794
-    }
2795
-
2796
-
2797
-
2798
-    public function attendee_editor_metaboxes()
2799
-    {
2800
-        $this->verify_cpt_object();
2801
-        remove_meta_box('postexcerpt', __('Excerpt'), 'post_excerpt_meta_box', $this->_cpt_routes[$this->_req_action],
2802
-            'normal', 'core');
2803
-        remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core');
2804
-        if (post_type_supports('espresso_attendees', 'excerpt')) {
2805
-            add_meta_box('postexcerpt', __('Short Biography', 'event_espresso'), 'post_excerpt_meta_box',
2806
-                $this->_cpt_routes[$this->_req_action], 'normal');
2807
-        }
2808
-        if (post_type_supports('espresso_attendees', 'comments')) {
2809
-            add_meta_box('commentsdiv', __('Notes on the Contact', 'event_espresso'), 'post_comment_meta_box',
2810
-                $this->_cpt_routes[$this->_req_action], 'normal', 'core');
2811
-        }
2812
-        add_meta_box('attendee_contact_info', __('Contact Info', 'event_espresso'),
2813
-            array($this, 'attendee_contact_info'), $this->_cpt_routes[$this->_req_action], 'side', 'core');
2814
-        add_meta_box('attendee_details_address', __('Address Details', 'event_espresso'),
2815
-            array($this, 'attendee_address_details'), $this->_cpt_routes[$this->_req_action], 'normal', 'core');
2816
-        add_meta_box('attendee_registrations', __('Registrations for this Contact', 'event_espresso'),
2817
-            array($this, 'attendee_registrations_meta_box'), $this->_cpt_routes[$this->_req_action], 'normal', 'high');
2818
-    }
2819
-
2820
-
2821
-
2822
-    /**
2823
-     * Metabox for attendee contact info
2824
-     *
2825
-     * @param  WP_Post $post wp post object
2826
-     * @return string        attendee contact info ( and form )
2827
-     */
2828
-    public function attendee_contact_info($post)
2829
-    {
2830
-        //get attendee object ( should already have it )
2831
-        $this->_template_args['attendee'] = $this->_cpt_model_obj;
2832
-        $template = REG_TEMPLATE_PATH . 'attendee_contact_info_metabox_content.template.php';
2833
-        EEH_Template::display_template($template, $this->_template_args);
2834
-    }
2835
-
2836
-
2837
-
2838
-    /**
2839
-     * Metabox for attendee details
2840
-     *
2841
-     * @param  WP_Post $post wp post object
2842
-     * @return string        attendee address details (and form)
2843
-     */
2844
-    public function attendee_address_details($post)
2845
-    {
2846
-        //get attendee object (should already have it)
2847
-        $this->_template_args['attendee'] = $this->_cpt_model_obj;
2848
-        $this->_template_args['state_html'] = EEH_Form_Fields::generate_form_input(new EE_Question_Form_Input(EE_Question::new_instance(array(
2849
-            'QST_ID'           => 0,
2850
-            'QST_display_text' => __('State/Province', 'event_espresso'),
2851
-            'QST_system'       => 'admin-state',
2852
-        )), EE_Answer::new_instance(array(
2853
-            'ANS_ID'    => 0,
2854
-            'ANS_value' => $this->_cpt_model_obj->state_ID(),
2855
-        )), array(
2856
-                'input_id'       => 'STA_ID',
2857
-                'input_name'     => 'STA_ID',
2858
-                'input_prefix'   => '',
2859
-                'append_qstn_id' => false,
2860
-            )));
2861
-        $this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(new EE_Question_Form_Input(EE_Question::new_instance(array(
2862
-            'QST_ID'           => 0,
2863
-            'QST_display_text' => __('Country', 'event_espresso'),
2864
-            'QST_system'       => 'admin-country',
2865
-        )), EE_Answer::new_instance(array(
2866
-            'ANS_ID'    => 0,
2867
-            'ANS_value' => $this->_cpt_model_obj->country_ID(),
2868
-        )), array(
2869
-                'input_id'       => 'CNT_ISO',
2870
-                'input_name'     => 'CNT_ISO',
2871
-                'input_prefix'   => '',
2872
-                'append_qstn_id' => false,
2873
-            )));
2874
-        $template = REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
2875
-        EEH_Template::display_template($template, $this->_template_args);
2876
-    }
2877
-
2878
-
2879
-
2880
-    /**
2881
-     *        _attendee_details
2882
-     *
2883
-     * @access protected
2884
-     * @return void
2885
-     */
2886
-    public function attendee_registrations_meta_box($post)
2887
-    {
2888
-        $this->_template_args['attendee'] = $this->_cpt_model_obj;
2889
-        $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
2890
-        $template = REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
2891
-        EEH_Template::display_template($template, $this->_template_args);
2892
-    }
2893
-
2894
-
2895
-
2896
-    /**
2897
-     * add in the form fields for the attendee edit
2898
-     *
2899
-     * @param  WP_Post $post wp post object
2900
-     * @return string        html for new form.
2901
-     */
2902
-    public function after_title_form_fields($post)
2903
-    {
2904
-        if ($post->post_type == 'espresso_attendees') {
2905
-            $template = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
2906
-            $template_args['attendee'] = $this->_cpt_model_obj;
2907
-            EEH_Template::display_template($template, $template_args);
2908
-        }
2909
-    }
2910
-
2911
-
2912
-
2913
-    /**
2914
-     *        _trash_or_restore_attendee
2915
-     *
2916
-     * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
2917
-     * @access protected
2918
-     * @return void
2919
-     */
2920
-    protected function _trash_or_restore_attendees($trash = true)
2921
-    {
2922
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2923
-        $ATT_MDL = EEM_Attendee::instance();
2924
-        $success = 1;
2925
-        //Checkboxes
2926
-        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
2927
-            // if array has more than one element than success message should be plural
2928
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
2929
-            // cycle thru checkboxes
2930
-            while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) {
2931
-                $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID)
2932
-                    : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID);
2933
-                if ( ! $updated) {
2934
-                    $success = 0;
2935
-                }
2936
-            }
2937
-        } else {
2938
-            // grab single id and delete
2939
-            $ATT_ID = absint($this->_req_data['ATT_ID']);
2940
-            //get attendee
2941
-            $att = $ATT_MDL->get_one_by_ID($ATT_ID);
2942
-            $updated = $trash ? $att->set_status('trash') : $att->set_status('publish');
2943
-            $updated = $att->save();
2944
-            if ( ! $updated) {
2945
-                $success = 0;
2946
-            }
2947
-        }
2948
-        $what = $success > 1 ? __('Contacts', 'event_espresso') : __('Contact', 'event_espresso');
2949
-        $action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso');
2950
-        $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list'));
2951
-    }
2312
+		}
2313
+		$template_args = array(
2314
+			'title'                    => '',
2315
+			'content'                  => '',
2316
+			'step_button_text'         => '',
2317
+			'show_notification_toggle' => false,
2318
+		);
2319
+		//to indicate we're processing a new registration
2320
+		$hidden_fields = array(
2321
+			'processing_registration' => array(
2322
+				'type'  => 'hidden',
2323
+				'value' => 0,
2324
+			),
2325
+			'event_id'                => array(
2326
+				'type'  => 'hidden',
2327
+				'value' => $this->_reg_event->ID(),
2328
+			),
2329
+		);
2330
+		//if the cart is empty then we know we're at step one so we'll display ticket selector
2331
+		$cart = EE_Registry::instance()->SSN->cart();
2332
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
2333
+		switch ($step) {
2334
+			case 'ticket' :
2335
+				$hidden_fields['processing_registration']['value'] = 1;
2336
+				$template_args['title'] = __('Step One: Select the Ticket for this registration', 'event_espresso');
2337
+				$template_args['content'] = EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
2338
+				$template_args['step_button_text'] = __('Add Tickets and Continue to Registrant Details',
2339
+					'event_espresso');
2340
+				$template_args['show_notification_toggle'] = false;
2341
+				break;
2342
+			case 'questions' :
2343
+				$hidden_fields['processing_registration']['value'] = 2;
2344
+				$template_args['title'] = __('Step Two: Add Registrant Details for this Registration',
2345
+					'event_espresso');
2346
+				//in theory we should be able to run EED_SPCO at this point because the cart should have been setup properly by the first process_reg_step run.
2347
+				$template_args['content'] = EED_Single_Page_Checkout::registration_checkout_for_admin();
2348
+				$template_args['step_button_text'] = __('Save Registration and Continue to Details', 'event_espresso');
2349
+				$template_args['show_notification_toggle'] = true;
2350
+				break;
2351
+		}
2352
+		$this->_set_add_edit_form_tags('process_reg_step',
2353
+			$hidden_fields); //we come back to the process_registration_step route.
2354
+		return EEH_Template::display_template(REG_TEMPLATE_PATH
2355
+											  . 'reg_admin_register_new_attendee_step_content.template.php',
2356
+			$template_args, true);
2357
+	}
2358
+
2359
+
2360
+
2361
+	/**
2362
+	 *        set_reg_event
2363
+	 *
2364
+	 * @access private
2365
+	 * @return boolean
2366
+	 */
2367
+	private function _set_reg_event()
2368
+	{
2369
+		if (is_object($this->_reg_event)) {
2370
+			return true;
2371
+		}
2372
+		$EVT_ID = ( ! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
2373
+		if ( ! $EVT_ID) {
2374
+			return false;
2375
+		}
2376
+		$this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
2377
+		return true;
2378
+	}
2379
+
2380
+
2381
+
2382
+	/**
2383
+	 * process_reg_step
2384
+	 *
2385
+	 * @access        public
2386
+	 * @return        string
2387
+	 * @throws \RuntimeException
2388
+	 * @throws \EE_Error
2389
+	 */
2390
+	public function process_reg_step()
2391
+	{
2392
+		EE_System::do_not_cache();
2393
+		$this->_set_reg_event();
2394
+		EE_Registry::instance()->REQ->set_espresso_page(true);
2395
+		EE_Registry::instance()->REQ->set('uts', time());
2396
+		//what step are we on?
2397
+		$cart = EE_Registry::instance()->SSN->cart();
2398
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
2399
+		//if doing ajax then we need to verify the nonce
2400
+		if (defined('DOING_AJAX')) {
2401
+			$nonce = isset($this->_req_data[$this->_req_nonce])
2402
+				? sanitize_text_field($this->_req_data[$this->_req_nonce]) : '';
2403
+			$this->_verify_nonce($nonce, $this->_req_nonce);
2404
+		}
2405
+		switch ($step) {
2406
+			case 'ticket' :
2407
+				//process ticket selection
2408
+				$success = EED_Ticket_Selector::instance()->process_ticket_selections();
2409
+				if ($success) {
2410
+					EE_Error::add_success(esc_html__('Tickets Selected. Now complete the registration.',
2411
+						'event_espresso'));
2412
+				} else {
2413
+					$query_args['step_error'] = $this->_req_data['step_error'] = true;
2414
+				}
2415
+				if (defined('DOING_AJAX')) {
2416
+					$this->new_registration(); //display next step
2417
+				} else {
2418
+					$query_args = array(
2419
+						'action'                  => 'new_registration',
2420
+						'processing_registration' => 1,
2421
+						'event_id'                => $this->_reg_event->ID(),
2422
+						'uts'                     => time(),
2423
+					);
2424
+					$this->_redirect_after_action(false, '', '', $query_args, true);
2425
+				}
2426
+				break;
2427
+			case 'questions' :
2428
+				if ( ! isset($this->_req_data['txn_reg_status_change'], $this->_req_data['txn_reg_status_change']['send_notifications'])) {
2429
+					add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
2430
+				}
2431
+				//process registration
2432
+				$transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
2433
+				if ($cart instanceof EE_Cart) {
2434
+					$grand_total = $cart->get_cart_grand_total();
2435
+					if ($grand_total instanceof EE_Line_Item) {
2436
+						$grand_total->save_this_and_descendants_to_txn();
2437
+					}
2438
+				}
2439
+				if ( ! $transaction instanceof EE_Transaction) {
2440
+					$query_args = array(
2441
+						'action'                  => 'new_registration',
2442
+						'processing_registration' => 2,
2443
+						'event_id'                => $this->_reg_event->ID(),
2444
+						'uts'                     => time(),
2445
+					);
2446
+					if (defined('DOING_AJAX')) {
2447
+						//display registration form again because there are errors (maybe validation?)
2448
+						$this->new_registration();
2449
+						return;
2450
+					} else {
2451
+						$this->_redirect_after_action(false, '', '', $query_args, true);
2452
+						return;
2453
+					}
2454
+				}
2455
+				// maybe update status, and make sure to save transaction if not done already
2456
+				if ( ! $transaction->update_status_based_on_total_paid()) {
2457
+					$transaction->save();
2458
+				}
2459
+				EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
2460
+				$this->_req_data = array();
2461
+				$query_args = array(
2462
+					'action'        => 'redirect_to_txn',
2463
+					'TXN_ID'        => $transaction->ID(),
2464
+					'EVT_ID'        => $this->_reg_event->ID(),
2465
+					'event_name'    => urlencode($this->_reg_event->name()),
2466
+					'redirect_from' => 'new_registration',
2467
+				);
2468
+				$this->_redirect_after_action(false, '', '', $query_args, true);
2469
+				break;
2470
+		}
2471
+		//what are you looking here for?  Should be nothing to do at this point.
2472
+	}
2473
+
2474
+
2475
+
2476
+	/**
2477
+	 * redirect_to_txn
2478
+	 *
2479
+	 * @access public
2480
+	 * @return void
2481
+	 */
2482
+	public function redirect_to_txn()
2483
+	{
2484
+		EE_System::do_not_cache();
2485
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
2486
+		$query_args = array(
2487
+			'action' => 'view_transaction',
2488
+			'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0,
2489
+			'page'   => 'espresso_transactions',
2490
+		);
2491
+		if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) {
2492
+			$query_args['EVT_ID'] = $this->_req_data['EVT_ID'];
2493
+			$query_args['event_name'] = urlencode($this->_req_data['event_name']);
2494
+			$query_args['redirect_from'] = $this->_req_data['redirect_from'];
2495
+		}
2496
+		EE_Error::add_success(__('Registration Created.  Please review the transaction and add any payments as necessary',
2497
+				'event_espresso'));
2498
+		$this->_redirect_after_action(false, '', '', $query_args, true);
2499
+	}
2500
+
2501
+
2502
+
2503
+	/**
2504
+	 *        generates HTML for the Attendee Contact List
2505
+	 *
2506
+	 * @access protected
2507
+	 * @return void
2508
+	 */
2509
+	protected function _attendee_contact_list_table()
2510
+	{
2511
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2512
+		$this->_search_btn_label = __('Contacts', 'event_espresso');
2513
+		$this->display_admin_list_table_page_with_no_sidebar();
2514
+	}
2515
+
2516
+
2517
+
2518
+	/**
2519
+	 *        get_attendees
2520
+	 *
2521
+	 * @param bool $count whether to return count or data.
2522
+	 * @access public
2523
+	 * @return array
2524
+	 */
2525
+	public function get_attendees($per_page, $count = false, $trash = false)
2526
+	{
2527
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2528
+		require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
2529
+		$ATT_MDL = EEM_Attendee::instance();
2530
+		$this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
2531
+		switch ($this->_req_data['orderby']) {
2532
+			case 'ATT_ID':
2533
+				$orderby = 'ATT_ID';
2534
+				break;
2535
+			case 'ATT_fname':
2536
+				$orderby = 'ATT_fname';
2537
+				break;
2538
+			case 'ATT_email':
2539
+				$orderby = 'ATT_email';
2540
+				break;
2541
+			case 'ATT_city':
2542
+				$orderby = 'ATT_city';
2543
+				break;
2544
+			case 'STA_ID':
2545
+				$orderby = 'STA_ID';
2546
+				break;
2547
+			case 'CNT_ID':
2548
+				$orderby = 'CNT_ID';
2549
+				break;
2550
+			default:
2551
+				$orderby = 'ATT_lname';
2552
+		}
2553
+		$sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
2554
+			: 'ASC';
2555
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
2556
+			? $this->_req_data['paged'] : 1;
2557
+		$per_page = isset($per_page) && ! empty($per_page) ? $per_page : 10;
2558
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
2559
+			? $this->_req_data['perpage'] : $per_page;
2560
+		$_where = array();
2561
+		if ( ! empty($this->_req_data['s'])) {
2562
+			$sstr = '%' . $this->_req_data['s'] . '%';
2563
+			$_where['OR'] = array(
2564
+				'Registration.Event.EVT_name'       => array('LIKE', $sstr),
2565
+				'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
2566
+				'Registration.Event.EVT_short_desc' => array('LIKE', $sstr),
2567
+				'ATT_fname'                         => array('LIKE', $sstr),
2568
+				'ATT_lname'                         => array('LIKE', $sstr),
2569
+				'ATT_short_bio'                     => array('LIKE', $sstr),
2570
+				'ATT_email'                         => array('LIKE', $sstr),
2571
+				'ATT_address'                       => array('LIKE', $sstr),
2572
+				'ATT_address2'                      => array('LIKE', $sstr),
2573
+				'ATT_city'                          => array('LIKE', $sstr),
2574
+				'Country.CNT_name'                  => array('LIKE', $sstr),
2575
+				'State.STA_name'                    => array('LIKE', $sstr),
2576
+				'ATT_phone'                         => array('LIKE', $sstr),
2577
+				'Registration.REG_final_price'      => array('LIKE', $sstr),
2578
+				'Registration.REG_code'             => array('LIKE', $sstr),
2579
+				'Registration.REG_count'            => array('LIKE', $sstr),
2580
+				'Registration.REG_group_size'       => array('LIKE', $sstr),
2581
+			);
2582
+		}
2583
+		$offset = ($current_page - 1) * $per_page;
2584
+		$limit = $count ? null : array($offset, $per_page);
2585
+		if ($trash) {
2586
+			$_where['status'] = array('!=', 'publish');
2587
+			$all_attendees = $count
2588
+				? $ATT_MDL->count(array(
2589
+					$_where,
2590
+					'order_by' => array($orderby => $sort),
2591
+					'limit'    => $limit,
2592
+				), 'ATT_ID', true)
2593
+				: $ATT_MDL->get_all(array(
2594
+					$_where,
2595
+					'order_by' => array($orderby => $sort),
2596
+					'limit'    => $limit,
2597
+				));
2598
+		} else {
2599
+			$_where['status'] = array('IN', array('publish'));
2600
+			$all_attendees = $count
2601
+				? $ATT_MDL->count(array(
2602
+					$_where,
2603
+					'order_by' => array($orderby => $sort),
2604
+					'limit'    => $limit,
2605
+				), 'ATT_ID', true)
2606
+				: $ATT_MDL->get_all(array(
2607
+					$_where,
2608
+					'order_by' => array($orderby => $sort),
2609
+					'limit'    => $limit,
2610
+				));
2611
+		}
2612
+		return $all_attendees;
2613
+	}
2614
+
2615
+
2616
+
2617
+	/**
2618
+	 * This is just taking care of resending the registration confirmation
2619
+	 *
2620
+	 * @access protected
2621
+	 * @return void
2622
+	 */
2623
+	protected function _resend_registration()
2624
+	{
2625
+		$this->_process_resend_registration();
2626
+		$query_args = isset($this->_req_data['redirect_to'])
2627
+			? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID'])
2628
+			: array(
2629
+				'action' => 'default',
2630
+			);
2631
+		$this->_redirect_after_action(false, '', '', $query_args, true);
2632
+	}
2633
+
2634
+
2635
+
2636
+	public function _registrations_report()
2637
+	{
2638
+		if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
2639
+			wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array(
2640
+				'page'        => 'espresso_batch',
2641
+				'batch'       => 'file',
2642
+				'EVT_ID'      => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
2643
+				'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
2644
+				'return_url'  => urlencode($this->_req_data['return_url']),
2645
+			)));
2646
+		} else {
2647
+			$new_request_args = array(
2648
+				'export' => 'report',
2649
+				'action' => 'registrations_report_for_event',
2650
+				'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
2651
+			);
2652
+			$this->_req_data = array_merge($this->_req_data, $new_request_args);
2653
+			if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
2654
+				require_once(EE_CLASSES . 'EE_Export.class.php');
2655
+				$EE_Export = EE_Export::instance($this->_req_data);
2656
+				$EE_Export->export();
2657
+			}
2658
+		}
2659
+	}
2660
+
2661
+
2662
+
2663
+	public function _contact_list_export()
2664
+	{
2665
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
2666
+			require_once(EE_CLASSES . 'EE_Export.class.php');
2667
+			$EE_Export = EE_Export::instance($this->_req_data);
2668
+			$EE_Export->export_attendees();
2669
+		}
2670
+	}
2671
+
2672
+
2673
+
2674
+	public function _contact_list_report()
2675
+	{
2676
+		if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
2677
+			wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array(
2678
+				'page'        => 'espresso_batch',
2679
+				'batch'       => 'file',
2680
+				'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
2681
+				'return_url'  => urlencode($this->_req_data['return_url']),
2682
+			)));
2683
+		} else {
2684
+			if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
2685
+				require_once(EE_CLASSES . 'EE_Export.class.php');
2686
+				$EE_Export = EE_Export::instance($this->_req_data);
2687
+				$EE_Export->report_attendees();
2688
+			}
2689
+		}
2690
+	}
2691
+
2692
+
2693
+
2694
+
2695
+
2696
+	/***************************************        ATTENDEE DETAILS        ***************************************/
2697
+	/**
2698
+	 * This duplicates the attendee object for the given incoming registration id and attendee_id.
2699
+	 *
2700
+	 * @return void
2701
+	 */
2702
+	protected function _duplicate_attendee()
2703
+	{
2704
+		$action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default';
2705
+		//verify we have necessary info
2706
+		if (empty($this->_req_data['_REG_ID'])) {
2707
+			EE_Error::add_error(__('Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
2708
+				'event_espresso'), __FILE__, __LINE__, __FUNCTION__);
2709
+			$query_args = array('action' => $action);
2710
+			$this->_redirect_after_action('', '', '', $query_args, true);
2711
+		}
2712
+		//okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
2713
+		$registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']);
2714
+		$attendee = $registration->attendee();
2715
+		//remove relation of existing attendee on registration
2716
+		$registration->_remove_relation_to($attendee, 'Attendee');
2717
+		//new attendee
2718
+		$new_attendee = clone $attendee;
2719
+		$new_attendee->set('ATT_ID', 0);
2720
+		$new_attendee->save();
2721
+		//add new attendee to reg
2722
+		$registration->_add_relation_to($new_attendee, 'Attendee');
2723
+		EE_Error::add_success(__('New Contact record created.  Now make any edits you wish to make for this contact.',
2724
+			'event_espresso'));
2725
+		//redirect to edit page for attendee
2726
+		$query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee');
2727
+		$this->_redirect_after_action('', '', '', $query_args, true);
2728
+	}
2729
+
2730
+
2731
+
2732
+	//related to cpt routes
2733
+	protected function _insert_update_cpt_item($post_id, $post)
2734
+	{
2735
+		$success = true;
2736
+		$attendee = EEM_Attendee::instance()->get_one_by_ID($post_id);
2737
+		//for attendee updates
2738
+		if ($post->post_type = 'espresso_attendees' && ! empty($attendee)) {
2739
+			//note we should only be UPDATING attendees at this point.
2740
+			$updated_fields = array(
2741
+				'ATT_fname'     => $this->_req_data['ATT_fname'],
2742
+				'ATT_lname'     => $this->_req_data['ATT_lname'],
2743
+				'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
2744
+				'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
2745
+				'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
2746
+				'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
2747
+				'STA_ID'        => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '',
2748
+				'CNT_ISO'       => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '',
2749
+				'ATT_zip'       => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '',
2750
+				'ATT_email'     => isset($this->_req_data['ATT_email']) ? $this->_req_data['ATT_email'] : '',
2751
+				'ATT_phone'     => isset($this->_req_data['ATT_phone']) ? $this->_req_data['ATT_phone'] : '',
2752
+			);
2753
+			foreach ($updated_fields as $field => $value) {
2754
+				$attendee->set($field, $value);
2755
+			}
2756
+			$success = $attendee->save();
2757
+			$attendee_update_callbacks = apply_filters('FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
2758
+				array());
2759
+			foreach ($attendee_update_callbacks as $a_callback) {
2760
+				if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) {
2761
+					throw new EE_Error(sprintf(__('The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback.  Please check the spelling.',
2762
+						'event_espresso'), $a_callback));
2763
+				}
2764
+			}
2765
+		}
2766
+		if ($success === false) {
2767
+			EE_Error::add_error(__('Something went wrong with updating the meta table data for the registration.',
2768
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
2769
+		}
2770
+	}
2771
+
2772
+
2773
+
2774
+	public function trash_cpt_item($post_id)
2775
+	{
2776
+	}
2777
+
2778
+
2779
+
2780
+	public function delete_cpt_item($post_id)
2781
+	{
2782
+	}
2783
+
2784
+
2785
+
2786
+	public function restore_cpt_item($post_id)
2787
+	{
2788
+	}
2789
+
2790
+
2791
+
2792
+	protected function _restore_cpt_item($post_id, $revision_id)
2793
+	{
2794
+	}
2795
+
2796
+
2797
+
2798
+	public function attendee_editor_metaboxes()
2799
+	{
2800
+		$this->verify_cpt_object();
2801
+		remove_meta_box('postexcerpt', __('Excerpt'), 'post_excerpt_meta_box', $this->_cpt_routes[$this->_req_action],
2802
+			'normal', 'core');
2803
+		remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core');
2804
+		if (post_type_supports('espresso_attendees', 'excerpt')) {
2805
+			add_meta_box('postexcerpt', __('Short Biography', 'event_espresso'), 'post_excerpt_meta_box',
2806
+				$this->_cpt_routes[$this->_req_action], 'normal');
2807
+		}
2808
+		if (post_type_supports('espresso_attendees', 'comments')) {
2809
+			add_meta_box('commentsdiv', __('Notes on the Contact', 'event_espresso'), 'post_comment_meta_box',
2810
+				$this->_cpt_routes[$this->_req_action], 'normal', 'core');
2811
+		}
2812
+		add_meta_box('attendee_contact_info', __('Contact Info', 'event_espresso'),
2813
+			array($this, 'attendee_contact_info'), $this->_cpt_routes[$this->_req_action], 'side', 'core');
2814
+		add_meta_box('attendee_details_address', __('Address Details', 'event_espresso'),
2815
+			array($this, 'attendee_address_details'), $this->_cpt_routes[$this->_req_action], 'normal', 'core');
2816
+		add_meta_box('attendee_registrations', __('Registrations for this Contact', 'event_espresso'),
2817
+			array($this, 'attendee_registrations_meta_box'), $this->_cpt_routes[$this->_req_action], 'normal', 'high');
2818
+	}
2819
+
2820
+
2821
+
2822
+	/**
2823
+	 * Metabox for attendee contact info
2824
+	 *
2825
+	 * @param  WP_Post $post wp post object
2826
+	 * @return string        attendee contact info ( and form )
2827
+	 */
2828
+	public function attendee_contact_info($post)
2829
+	{
2830
+		//get attendee object ( should already have it )
2831
+		$this->_template_args['attendee'] = $this->_cpt_model_obj;
2832
+		$template = REG_TEMPLATE_PATH . 'attendee_contact_info_metabox_content.template.php';
2833
+		EEH_Template::display_template($template, $this->_template_args);
2834
+	}
2835
+
2836
+
2837
+
2838
+	/**
2839
+	 * Metabox for attendee details
2840
+	 *
2841
+	 * @param  WP_Post $post wp post object
2842
+	 * @return string        attendee address details (and form)
2843
+	 */
2844
+	public function attendee_address_details($post)
2845
+	{
2846
+		//get attendee object (should already have it)
2847
+		$this->_template_args['attendee'] = $this->_cpt_model_obj;
2848
+		$this->_template_args['state_html'] = EEH_Form_Fields::generate_form_input(new EE_Question_Form_Input(EE_Question::new_instance(array(
2849
+			'QST_ID'           => 0,
2850
+			'QST_display_text' => __('State/Province', 'event_espresso'),
2851
+			'QST_system'       => 'admin-state',
2852
+		)), EE_Answer::new_instance(array(
2853
+			'ANS_ID'    => 0,
2854
+			'ANS_value' => $this->_cpt_model_obj->state_ID(),
2855
+		)), array(
2856
+				'input_id'       => 'STA_ID',
2857
+				'input_name'     => 'STA_ID',
2858
+				'input_prefix'   => '',
2859
+				'append_qstn_id' => false,
2860
+			)));
2861
+		$this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(new EE_Question_Form_Input(EE_Question::new_instance(array(
2862
+			'QST_ID'           => 0,
2863
+			'QST_display_text' => __('Country', 'event_espresso'),
2864
+			'QST_system'       => 'admin-country',
2865
+		)), EE_Answer::new_instance(array(
2866
+			'ANS_ID'    => 0,
2867
+			'ANS_value' => $this->_cpt_model_obj->country_ID(),
2868
+		)), array(
2869
+				'input_id'       => 'CNT_ISO',
2870
+				'input_name'     => 'CNT_ISO',
2871
+				'input_prefix'   => '',
2872
+				'append_qstn_id' => false,
2873
+			)));
2874
+		$template = REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
2875
+		EEH_Template::display_template($template, $this->_template_args);
2876
+	}
2877
+
2878
+
2879
+
2880
+	/**
2881
+	 *        _attendee_details
2882
+	 *
2883
+	 * @access protected
2884
+	 * @return void
2885
+	 */
2886
+	public function attendee_registrations_meta_box($post)
2887
+	{
2888
+		$this->_template_args['attendee'] = $this->_cpt_model_obj;
2889
+		$this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
2890
+		$template = REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
2891
+		EEH_Template::display_template($template, $this->_template_args);
2892
+	}
2893
+
2894
+
2895
+
2896
+	/**
2897
+	 * add in the form fields for the attendee edit
2898
+	 *
2899
+	 * @param  WP_Post $post wp post object
2900
+	 * @return string        html for new form.
2901
+	 */
2902
+	public function after_title_form_fields($post)
2903
+	{
2904
+		if ($post->post_type == 'espresso_attendees') {
2905
+			$template = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
2906
+			$template_args['attendee'] = $this->_cpt_model_obj;
2907
+			EEH_Template::display_template($template, $template_args);
2908
+		}
2909
+	}
2910
+
2911
+
2912
+
2913
+	/**
2914
+	 *        _trash_or_restore_attendee
2915
+	 *
2916
+	 * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
2917
+	 * @access protected
2918
+	 * @return void
2919
+	 */
2920
+	protected function _trash_or_restore_attendees($trash = true)
2921
+	{
2922
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2923
+		$ATT_MDL = EEM_Attendee::instance();
2924
+		$success = 1;
2925
+		//Checkboxes
2926
+		if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
2927
+			// if array has more than one element than success message should be plural
2928
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
2929
+			// cycle thru checkboxes
2930
+			while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) {
2931
+				$updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID)
2932
+					: $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID);
2933
+				if ( ! $updated) {
2934
+					$success = 0;
2935
+				}
2936
+			}
2937
+		} else {
2938
+			// grab single id and delete
2939
+			$ATT_ID = absint($this->_req_data['ATT_ID']);
2940
+			//get attendee
2941
+			$att = $ATT_MDL->get_one_by_ID($ATT_ID);
2942
+			$updated = $trash ? $att->set_status('trash') : $att->set_status('publish');
2943
+			$updated = $att->save();
2944
+			if ( ! $updated) {
2945
+				$success = 0;
2946
+			}
2947
+		}
2948
+		$what = $success > 1 ? __('Contacts', 'event_espresso') : __('Contact', 'event_espresso');
2949
+		$action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso');
2950
+		$this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list'));
2951
+	}
2952 2952
 
2953 2953
 }
2954 2954
 
Please login to merge, or discard this patch.
core/request_stack/EE_Request.core.php 2 patches
Indentation   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@  discard block
 block discarded – undo
1 1
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
2
-    exit('No direct script access allowed');
2
+	exit('No direct script access allowed');
3 3
 }
4 4
 /**
5 5
  * class EE_Request
@@ -133,10 +133,10 @@  discard block
 block discarded – undo
133 133
 	public function set( $key, $value, $override_ee = FALSE ) {
134 134
 		// don't allow "ee" to be overwritten unless explicitly instructed to do so
135 135
 		if (
136
-		    $key !== 'ee'
137
-            || ( $key === 'ee' && empty( $this->_params['ee'] ))
138
-            || ( $key === 'ee' && ! empty( $this->_params['ee'] ) && $override_ee )
139
-        ) {
136
+			$key !== 'ee'
137
+			|| ( $key === 'ee' && empty( $this->_params['ee'] ))
138
+			|| ( $key === 'ee' && ! empty( $this->_params['ee'] ) && $override_ee )
139
+		) {
140 140
 			$this->_params[ $key ] = $value;
141 141
 		}
142 142
 	}
Please login to merge, or discard this patch.
Spacing   +19 added lines, -19 removed lines patch added patch discarded remove patch
@@ -69,15 +69,15 @@  discard block
 block discarded – undo
69 69
 	 * @param array $post
70 70
 	 * @param array $cookie
71 71
 	 */
72
-	public function __construct( $get, $post, $cookie ) {
72
+	public function __construct($get, $post, $cookie) {
73 73
 		// grab request vars
74 74
 		$this->_get    = (array) $get;
75 75
 		$this->_post   = (array) $post;
76 76
 		$this->_cookie = (array) $cookie;
77 77
 		$this->_params = array_merge($this->_get, $this->_post);
78 78
 		// AJAX ???
79
-		$this->ajax       = defined( 'DOING_AJAX' ) ? true : false;
80
-		$this->front_ajax = $this->is_set( 'ee_front_ajax' ) && (int) $this->get( 'ee_front_ajax' ) === 1;
79
+		$this->ajax       = defined('DOING_AJAX') ? true : false;
80
+		$this->front_ajax = $this->is_set('ee_front_ajax') && (int) $this->get('ee_front_ajax') === 1;
81 81
 		// grab user IP
82 82
 		$this->_ip_address = $this->_visitor_ip();
83 83
 	}
@@ -130,14 +130,14 @@  discard block
 block discarded – undo
130 130
 	 * @param bool $override_ee
131 131
 	 * @return    void
132 132
 	 */
133
-	public function set( $key, $value, $override_ee = FALSE ) {
133
+	public function set($key, $value, $override_ee = FALSE) {
134 134
 		// don't allow "ee" to be overwritten unless explicitly instructed to do so
135 135
 		if (
136 136
 		    $key !== 'ee'
137
-            || ( $key === 'ee' && empty( $this->_params['ee'] ))
138
-            || ( $key === 'ee' && ! empty( $this->_params['ee'] ) && $override_ee )
137
+            || ($key === 'ee' && empty($this->_params['ee']))
138
+            || ($key === 'ee' && ! empty($this->_params['ee']) && $override_ee)
139 139
         ) {
140
-			$this->_params[ $key ] = $value;
140
+			$this->_params[$key] = $value;
141 141
 		}
142 142
 	}
143 143
 
@@ -151,8 +151,8 @@  discard block
 block discarded – undo
151 151
 	 * @param null $default
152 152
 	 * @return    mixed
153 153
 	 */
154
-	public function get( $key, $default = NULL ) {
155
-		return isset( $this->_params[ $key ] ) ? $this->_params[ $key ] : $default;
154
+	public function get($key, $default = NULL) {
155
+		return isset($this->_params[$key]) ? $this->_params[$key] : $default;
156 156
 	}
157 157
 
158 158
 
@@ -164,8 +164,8 @@  discard block
 block discarded – undo
164 164
 	 * @param $key
165 165
 	 * @return    boolean
166 166
 	 */
167
-	public function is_set( $key ) {
168
-		return isset( $this->_params[ $key ] ) ? TRUE : FALSE;
167
+	public function is_set($key) {
168
+		return isset($this->_params[$key]) ? TRUE : FALSE;
169 169
 	}
170 170
 
171 171
 
@@ -177,10 +177,10 @@  discard block
 block discarded – undo
177 177
 	 * @param $key
178 178
 	 * @param bool $unset_from_global_too
179 179
 	 */
180
-	public function un_set( $key, $unset_from_global_too = false ) {
181
-		unset( $this->_params[ $key ] );
182
-		if ( $unset_from_global_too ) {
183
-			unset( $_REQUEST[ $key ] );
180
+	public function un_set($key, $unset_from_global_too = false) {
181
+		unset($this->_params[$key]);
182
+		if ($unset_from_global_too) {
183
+			unset($_REQUEST[$key]);
184 184
 		}
185 185
 	}
186 186
 
@@ -214,10 +214,10 @@  discard block
 block discarded – undo
214 214
 			'HTTP_FORWARDED',
215 215
 			'REMOTE_ADDR'
216 216
 		);
217
-		foreach ( $server_keys as $key ) {
218
-			if ( isset( $_SERVER[ $key ] ) ) {
219
-				foreach ( array_map( 'trim', explode( ',', $_SERVER[ $key ] ) ) as $ip ) {
220
-					if ( $ip === '127.0.0.1' || filter_var( $ip, FILTER_VALIDATE_IP ) !== false ) {
217
+		foreach ($server_keys as $key) {
218
+			if (isset($_SERVER[$key])) {
219
+				foreach (array_map('trim', explode(',', $_SERVER[$key])) as $ip) {
220
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
221 221
 						$visitor_ip = $ip;
222 222
 					}
223 223
 				}
Please login to merge, or discard this patch.
admin_pages/registrations/EE_Registrations_List_Table.class.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -227,7 +227,7 @@
 block discarded – undo
227 227
      *    _get_table_filters
228 228
      *
229 229
      * @access protected
230
-     * @return array
230
+     * @return string[]
231 231
      */
232 232
     protected function _get_table_filters()
233 233
     {
Please login to merge, or discard this patch.
Spacing   +27 added lines, -27 removed lines patch added patch discarded remove patch
@@ -157,7 +157,7 @@  discard block
 block discarded – undo
157 157
         );
158 158
         $this->_primary_column = '_REG_ID';
159 159
         $this->_sortable_columns = array(
160
-            '_REG_date'     => array('_REG_date' => true),   //true means its already sorted
160
+            '_REG_date'     => array('_REG_date' => true), //true means its already sorted
161 161
             'ATT_fname'     => array('ATT_fname' => false),
162 162
             'event_name'    => array('event_name' => false),
163 163
             'DTT_EVT_start' => array('DTT_EVT_start' => false),
@@ -179,7 +179,7 @@  discard block
 block discarded – undo
179 179
     {
180 180
         $class = parent::_get_row_class($item);
181 181
         //add status class
182
-        $class .= ' ee-status-strip reg-status-' . $item->status_ID();
182
+        $class .= ' ee-status-strip reg-status-'.$item->status_ID();
183 183
         if ($this->_has_checkbox_column) {
184 184
             $class .= ' has-checkbox-column';
185 185
         }
@@ -327,11 +327,11 @@  discard block
 block discarded – undo
327 327
         //setup date query.
328 328
         $beginning_string = EEM_Registration::instance()
329 329
                                             ->convert_datetime_for_query('REG_date',
330
-                                                $this_year_r . '-' . $this_month_r . '-01' . ' ' . $time_start,
330
+                                                $this_year_r.'-'.$this_month_r.'-01'.' '.$time_start,
331 331
                                                 'Y-m-d H:i:s');
332 332
         $end_string = EEM_Registration::instance()
333 333
                                       ->convert_datetime_for_query('REG_date',
334
-                                          $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' ' . $time_end,
334
+                                          $this_year_r.'-'.$this_month_r.'-'.$days_this_month.' '.$time_end,
335 335
                                           'Y-m-d H:i:s');
336 336
         $_where['REG_date'] = array(
337 337
             'BETWEEN',
@@ -364,9 +364,9 @@  discard block
 block discarded – undo
364 364
             'BETWEEN',
365 365
             array(
366 366
                 EEM_Registration::instance()
367
-                                ->convert_datetime_for_query('REG_date', $current_date . $time_start, 'Y-m-d H:i:s'),
367
+                                ->convert_datetime_for_query('REG_date', $current_date.$time_start, 'Y-m-d H:i:s'),
368 368
                 EEM_Registration::instance()
369
-                                ->convert_datetime_for_query('REG_date', $current_date . $time_end, 'Y-m-d H:i:s'),
369
+                                ->convert_datetime_for_query('REG_date', $current_date.$time_end, 'Y-m-d H:i:s'),
370 370
             ),
371 371
         );
372 372
         $_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
@@ -410,8 +410,8 @@  discard block
 block discarded – undo
410 410
         $content .= '<div class="show-on-mobile-view-only">';
411 411
         $content .= '<br>';
412 412
         $content .= $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
413
-        $content .= '&nbsp;' . sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
414
-        $content .= '<br>' . sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
413
+        $content .= '&nbsp;'.sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
414
+        $content .= '<br>'.sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
415 415
         $content .= '</div>';
416 416
         return $content;
417 417
     }
@@ -482,10 +482,10 @@  discard block
 block discarded – undo
482 482
                   . $event_name
483 483
                   . '</a>' : $event_name;
484 484
             $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(array('event_id' => $EVT_ID), REG_ADMIN_URL);
485
-            $actions['event_filter'] = '<a href="' . $edit_event_url . '" title="';
485
+            $actions['event_filter'] = '<a href="'.$edit_event_url.'" title="';
486 486
             $actions['event_filter'] .= sprintf(esc_attr__('Filter this list to only show registrations for %s',
487 487
                 'event_espresso'), $event_name);
488
-            $actions['event_filter'] .= '">' . __('View Registrations', 'event_espresso') . '</a>';
488
+            $actions['event_filter'] .= '">'.__('View Registrations', 'event_espresso').'</a>';
489 489
         } else {
490 490
             $edit_event = $event_name;
491 491
             $actions['event_filter'] = '';
@@ -551,12 +551,12 @@  discard block
 block discarded – undo
551 551
         $t = $item->get_first_related('Transaction');
552 552
         $payment_count = $t instanceof EE_Transaction ? $t->count_related('Payment') : 0;
553 553
         //append group count to name
554
-        $link .= '&nbsp;' . sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
554
+        $link .= '&nbsp;'.sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
555 555
         //append reg_code
556
-        $link .= '<br>' . sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
556
+        $link .= '<br>'.sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
557 557
         //reg status text for accessibility
558
-        $link .= '<br><span class="ee-status-text-small">' . EEH_Template::pretty_status($item->status_ID(), false,
559
-                'sentence') . '</span>';
558
+        $link .= '<br><span class="ee-status-text-small">'.EEH_Template::pretty_status($item->status_ID(), false,
559
+                'sentence').'</span>';
560 560
         //trash/restore/delete actions
561 561
         $actions = array();
562 562
         if ($this->_view !== 'trash'
@@ -568,8 +568,8 @@  discard block
 block discarded – undo
568 568
                 'action'  => 'trash_registrations',
569 569
                 '_REG_ID' => $item->ID(),
570 570
             ), REG_ADMIN_URL);
571
-            $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="' . esc_attr__('Trash Registration',
572
-                    'event_espresso') . '">' . __('Trash', 'event_espresso') . '</a>';
571
+            $actions['trash'] = '<a href="'.$trash_lnk_url.'" title="'.esc_attr__('Trash Registration',
572
+                    'event_espresso').'">'.__('Trash', 'event_espresso').'</a>';
573 573
         } elseif ($this->_view === 'trash') {
574 574
             // restore registration link
575 575
             if (EE_Registry::instance()->CAP->current_user_can('ee_delete_registration',
@@ -579,8 +579,8 @@  discard block
 block discarded – undo
579 579
                     'action'  => 'restore_registrations',
580 580
                     '_REG_ID' => $item->ID(),
581 581
                 ), REG_ADMIN_URL);
582
-                $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="' . esc_attr__('Restore Registration',
583
-                        'event_espresso') . '">' . __('Restore', 'event_espresso') . '</a>';
582
+                $actions['restore'] = '<a href="'.$restore_lnk_url.'" title="'.esc_attr__('Restore Registration',
583
+                        'event_espresso').'">'.__('Restore', 'event_espresso').'</a>';
584 584
             }
585 585
             if (EE_Registry::instance()->CAP->current_user_can('ee_delete_registration',
586 586
                 'espresso_registrations_ee_delete_registrations', $item->ID())
@@ -648,7 +648,7 @@  discard block
 block discarded – undo
648 648
                                                                               . $ticket->name()
649 649
                                                                               . '</span><br />' : '';
650 650
         if ($item->final_price() > 0) {
651
-            $content .= '<span class="reg-pad-rght">' . $item->pretty_final_price() . '</span>';
651
+            $content .= '<span class="reg-pad-rght">'.$item->pretty_final_price().'</span>';
652 652
         } else {
653 653
             // free event
654 654
             $content .= '<span class="reg-overview-free-event-spn reg-pad-rght">'
@@ -675,7 +675,7 @@  discard block
 block discarded – undo
675 675
             : '<span class="TKT_name">'
676 676
               . $ticket->name()
677 677
               . '</span><br />';
678
-        $content .= '<span class="reg-pad-rght">' . $item->pretty_final_price() . '</span>';
678
+        $content .= '<span class="reg-pad-rght">'.$item->pretty_final_price().'</span>';
679 679
         return $content;
680 680
     }
681 681
 
@@ -693,10 +693,10 @@  discard block
 block discarded – undo
693 693
         $payment_method = $item->payment_method();
694 694
         $payment_method_name = $payment_method instanceof EE_Payment_Method ? $payment_method->admin_name()
695 695
             : __('Unknown', 'event_espresso');
696
-        $content = '<span class="reg-pad-rght">' . $item->pretty_paid() . '</span>';
696
+        $content = '<span class="reg-pad-rght">'.$item->pretty_paid().'</span>';
697 697
         if ($item->paid() > 0) {
698
-            $content .= '<br><span class="ee-status-text-small">' . sprintf(__('...via %s', 'event_espresso'),
699
-                    $payment_method_name) . '</span>';
698
+            $content .= '<br><span class="ee-status-text-small">'.sprintf(__('...via %s', 'event_espresso'),
699
+                    $payment_method_name).'</span>';
700 700
         }
701 701
         return $content;
702 702
     }
@@ -728,7 +728,7 @@  discard block
 block discarded – undo
728 728
                   . esc_attr__('View Transaction', 'event_espresso')
729 729
                   . '">'
730 730
                   . $item->transaction()->pretty_total()
731
-                  . '</a></span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_total() . '</span>';
731
+                  . '</a></span>' : '<span class="reg-pad-rght">'.$item->transaction()->pretty_total().'</span>';
732 732
         } else {
733 733
             return __("None", "event_espresso");
734 734
         }
@@ -765,7 +765,7 @@  discard block
 block discarded – undo
765 765
                       . esc_attr__('View Transaction', 'event_espresso')
766 766
                       . '">'
767 767
                       . $item->transaction()->pretty_paid()
768
-                      . '</a><span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_paid() . '</span>';
768
+                      . '</a><span>' : '<span class="reg-pad-rght">'.$item->transaction()->pretty_paid().'</span>';
769 769
             }
770 770
         }
771 771
         return '&nbsp;';
@@ -805,7 +805,7 @@  discard block
 block discarded – undo
805 805
         $actions['view_lnk'] = EE_Registry::instance()->CAP->current_user_can('ee_read_registration',
806 806
             'espresso_registrations_view_registration', $item->ID()) ? '
807 807
 			<li>
808
-			<a href="' . $view_lnk_url . '" title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text">
808
+			<a href="' . $view_lnk_url.'" title="'.esc_attr__('View Registration Details', 'event_espresso').'" class="tiny-text">
809 809
 				<div class="dashicons dashicons-clipboard"></div>
810 810
 			</a>
811 811
 			</li>' : '';
@@ -813,7 +813,7 @@  discard block
 block discarded – undo
813 813
             'espresso_registrations_edit_attendee')
814 814
                                && $attendee instanceof EE_Attendee ? '
815 815
 			<li>
816
-			<a href="' . $edit_lnk_url . '" title="' . esc_attr__('Edit Contact Details', 'event_espresso') . '" class="tiny-text">
816
+			<a href="' . $edit_lnk_url.'" title="'.esc_attr__('Edit Contact Details', 'event_espresso').'" class="tiny-text">
817 817
 				<div class="ee-icon ee-icon-user-edit ee-icon-size-16"></div>
818 818
 			</a>
819 819
 			</li>' : '';
Please login to merge, or discard this patch.
Indentation   +818 added lines, -818 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@  discard block
 block discarded – undo
1 1
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
2
-    exit('No direct script access allowed');
2
+	exit('No direct script access allowed');
3 3
 }
4 4
 
5 5
 
@@ -26,847 +26,847 @@  discard block
 block discarded – undo
26 26
 
27 27
 
28 28
 
29
-    private $_status;
30
-
31
-
32
-
33
-    /**
34
-     * An array of transaction details for the related transaction to the registration being processed.
35
-     * This is set via the _set_related_details method.
36
-     *
37
-     * @var array
38
-     */
39
-    protected $_transaction_details = array();
40
-
41
-
42
-
43
-    /**
44
-     * An array of event details for the related event to the registration being processed.
45
-     * This is set via the _set_related_details method.
46
-     *
47
-     * @var array
48
-     */
49
-    protected $_event_details = array();
50
-
51
-
52
-
53
-    /**
54
-     * @param \Registrations_Admin_Page $admin_page
55
-     */
56
-    public function __construct(Registrations_Admin_Page $admin_page)
57
-    {
58
-        if ( ! empty($_GET['event_id'])) {
59
-            $extra_query_args = array();
60
-            foreach ($admin_page->get_views() as $key => $view_details) {
61
-                $extra_query_args[$view_details['slug']] = array('event_id' => $_GET['event_id']);
62
-            }
63
-            $this->_views = $admin_page->get_list_table_view_RLs($extra_query_args);
64
-        }
65
-        parent::__construct($admin_page);
66
-        $this->_status = $this->_admin_page->get_registration_status_array();
67
-    }
68
-
69
-
70
-
71
-    /**
72
-     *    _setup_data
73
-     *
74
-     * @access protected
75
-     * @return void
76
-     */
77
-    protected function _setup_data()
78
-    {
79
-        $this->_data = $this->_admin_page->get_registrations($this->_per_page);
80
-        $this->_all_data_count = $this->_admin_page->get_registrations($this->_per_page, true, false, false);
81
-    }
82
-
83
-
84
-
85
-    /**
86
-     *    _set_properties
87
-     *
88
-     * @access protected
89
-     * @return void
90
-     */
91
-    protected function _set_properties()
92
-    {
93
-        $this->_wp_list_args = array(
94
-            'singular' => __('registration', 'event_espresso'),
95
-            'plural'   => __('registrations', 'event_espresso'),
96
-            'ajax'     => true,
97
-            'screen'   => $this->_admin_page->get_current_screen()->id,
98
-        );
99
-        $ID_column_name = __('ID', 'event_espresso');
100
-        $ID_column_name .= ' : <span class="show-on-mobile-view-only" style="float:none">';
101
-        $ID_column_name .= __('Registrant Name', 'event_espresso');
102
-        $ID_column_name .= '</span> ';
103
-        if (isset($_GET['event_id'])) {
104
-            $this->_columns = array(
105
-                'cb'               => '<input type="checkbox" />', //Render a checkbox instead of text
106
-                '_REG_ID'          => $ID_column_name,
107
-                'ATT_fname'        => __('Name', 'event_espresso'),
108
-                'ATT_email'        => __('Email', 'event_espresso'),
109
-                '_REG_date'        => __('Reg Date', 'event_espresso'),
110
-                'PRC_amount'       => __('TKT Price', 'event_espresso'),
111
-                '_REG_final_price' => __('Final Price', 'event_espresso'),
112
-                'TXN_total'        => __('Total Txn', 'event_espresso'),
113
-                'TXN_paid'         => __('Paid', 'event_espresso'),
114
-                'actions'          => __('Actions', 'event_espresso'),
115
-            );
116
-            $this->_bottom_buttons = array(
117
-                'report' => array(
118
-                    'route'         => 'registrations_report',
119
-                    'extra_request' => array(
120
-                        'EVT_ID'     => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
121
-                        'return_url' => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
122
-                    ),
123
-                ),
124
-            );
125
-        } else {
126
-            $this->_columns = array(
127
-                'cb'               => '<input type="checkbox" />', //Render a checkbox instead of text
128
-                '_REG_ID'          => $ID_column_name,
129
-                'ATT_fname'        => __('Name', 'event_espresso'),
130
-                '_REG_date'        => __('TXN Date', 'event_espresso'),
131
-                'event_name'       => __('Event', 'event_espresso'),
132
-                'DTT_EVT_start'    => __('Event Date', 'event_espresso'),
133
-                '_REG_final_price' => __('Price', 'event_espresso'),
134
-                '_REG_paid'        => __('Paid', 'event_espresso'),
135
-                'actions'          => __('Actions', 'event_espresso'),
136
-            );
137
-            $this->_bottom_buttons = array(
138
-                'report_all' => array(
139
-                    'route'         => 'registrations_report',
140
-                    'extra_request' => array(
141
-                        'return_url' => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
142
-                    ),
143
-                ),
144
-            );
145
-        }
146
-        $this->_primary_column = '_REG_ID';
147
-        $this->_sortable_columns = array(
148
-            '_REG_date'     => array('_REG_date' => true),   //true means its already sorted
149
-            'ATT_fname'     => array('ATT_fname' => false),
150
-            'event_name'    => array('event_name' => false),
151
-            'DTT_EVT_start' => array('DTT_EVT_start' => false),
152
-            '_REG_ID'       => array('_REG_ID' => false),
153
-        );
154
-        $this->_hidden_columns = array();
155
-    }
156
-
157
-
158
-
159
-    /**
160
-     * This simply sets up the row class for the table rows.
161
-     * Allows for easier overriding of child methods for setting up sorting.
162
-     *
163
-     * @param  EE_Registration $item the current item
164
-     * @return string
165
-     */
166
-    protected function _get_row_class($item)
167
-    {
168
-        $class = parent::_get_row_class($item);
169
-        //add status class
170
-        $class .= ' ee-status-strip reg-status-' . $item->status_ID();
171
-        if ($this->_has_checkbox_column) {
172
-            $class .= ' has-checkbox-column';
173
-        }
174
-        return $class;
175
-    }
176
-
177
-
178
-
179
-    /**
180
-     * Set the $_transaction_details property if not set yet.
181
-     *
182
-     * @param EE_Registration $registration
183
-     * @throws \EE_Error
184
-     */
185
-    protected function _set_related_details(EE_Registration $registration)
186
-    {
187
-        $transaction = $registration->get_first_related('Transaction');
188
-        $status = $transaction instanceof EE_Transaction ? $transaction->status_ID()
189
-            : EEM_Transaction::failed_status_code;
190
-        $this->_transaction_details = array(
191
-            'transaction' => $transaction,
192
-            'status'      => $status,
193
-            'id'          => $transaction instanceof EE_Transaction ? $transaction->ID() : 0,
194
-            'title_attr'  => sprintf(__('View Transaction Details (%s)', 'event_espresso'),
195
-                EEH_Template::pretty_status($status, false, 'sentence')),
196
-        );
197
-        try {
198
-            $event = $registration->event();
199
-        } catch (\EventEspresso\core\exceptions\EntityNotFoundException $e) {
200
-            $event = null;
201
-        }
202
-        $status = $event instanceof EE_Event ? $event->get_active_status() : EE_Datetime::inactive;
203
-        $this->_event_details = array(
204
-            'event'      => $event,
205
-            'status'     => $status,
206
-            'id'         => $event instanceof EE_Event ? $event->ID() : 0,
207
-            'title_attr' => sprintf(__('Edit Event (%s)', 'event_espresso'),
208
-                EEH_Template::pretty_status($status, false, 'sentence')),
209
-        );
210
-    }
211
-
212
-
213
-
214
-    /**
215
-     *    _get_table_filters
216
-     *
217
-     * @access protected
218
-     * @return array
219
-     */
220
-    protected function _get_table_filters()
221
-    {
222
-        $filters = array();
223
-        //todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as methods.
224
-        $cur_date = isset($this->_req_data['month_range']) ? $this->_req_data['month_range'] : '';
225
-        $cur_category = isset($this->_req_data['EVT_CAT']) ? $this->_req_data['EVT_CAT'] : -1;
226
-        $reg_status = isset($this->_req_data['_reg_status']) ? $this->_req_data['_reg_status'] : '';
227
-        $filters[] = EEH_Form_Fields::generate_registration_months_dropdown($cur_date, $reg_status, $cur_category);
228
-        $filters[] = EEH_Form_Fields::generate_event_category_dropdown($cur_category);
229
-        $status = array();
230
-        $status[] = array('id' => 0, 'text' => __('Select Status', 'event_espresso'));
231
-        foreach ($this->_status as $key => $value) {
232
-            $status[] = array('id' => $key, 'text' => $value);
233
-        }
234
-        if ($this->_view !== 'incomplete') {
235
-            $filters[] = EEH_Form_Fields::select_input('_reg_status', $status,
236
-                isset($this->_req_data['_reg_status']) ? strtoupper(sanitize_key($this->_req_data['_reg_status']))
237
-                    : '');
238
-        }
239
-        if (isset($this->_req_data['event_id'])) {
240
-            $filters[] = EEH_Form_Fields::hidden_input('event_id', $this->_req_data['event_id'], 'reg_event_id');
241
-        }
242
-        return $filters;
243
-    }
244
-
245
-
246
-
247
-    /**
248
-     *    _add_view_counts
249
-     *
250
-     * @access protected
251
-     * @return void
252
-     * @throws \EE_Error
253
-     */
254
-    protected function _add_view_counts()
255
-    {
256
-        $this->_views['all']['count'] = $this->_total_registrations();
257
-        $this->_views['month']['count'] = $this->_total_registrations_this_month();
258
-        $this->_views['today']['count'] = $this->_total_registrations_today();
259
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_registrations',
260
-            'espresso_registrations_trash_registrations')
261
-        ) {
262
-            $this->_views['incomplete']['count'] = $this->_total_registrations('incomplete');
263
-            $this->_views['trash']['count'] = $this->_total_registrations('trash');
264
-        }
265
-    }
266
-
267
-
268
-
269
-    /**
270
-     * _total_registrations
271
-     *
272
-     * @access protected
273
-     * @param string $view
274
-     * @return int
275
-     * @throws \EE_Error
276
-     */
277
-    protected function _total_registrations($view = '')
278
-    {
279
-        $_where = array();
280
-        $EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
281
-        if ($EVT_ID) {
282
-            $_where['EVT_ID'] = $EVT_ID;
283
-        }
284
-        switch ($view) {
285
-            case 'trash' :
286
-                return EEM_Registration::instance()->count_deleted(array($_where));
287
-                break;
288
-            case 'incomplete' :
289
-                $_where['STS_ID'] = EEM_Registration::status_id_incomplete;
290
-                break;
291
-            default :
292
-                $_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
293
-        }
294
-        return EEM_Registration::instance()->count(array($_where));
295
-    }
296
-
297
-
298
-
299
-    /**
300
-     * _total_registrations_this_month
301
-     *
302
-     * @access protected
303
-     * @return int
304
-     * @throws \EE_Error
305
-     */
306
-    protected function _total_registrations_this_month()
307
-    {
308
-        $EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
309
-        $_where = $EVT_ID ? array('EVT_ID' => $EVT_ID) : array();
310
-        $this_year_r = date('Y', current_time('timestamp'));
311
-        $time_start = ' 00:00:00';
312
-        $time_end = ' 23:59:59';
313
-        $this_month_r = date('m', current_time('timestamp'));
314
-        $days_this_month = date('t', current_time('timestamp'));
315
-        //setup date query.
316
-        $beginning_string = EEM_Registration::instance()
317
-                                            ->convert_datetime_for_query('REG_date',
318
-                                                $this_year_r . '-' . $this_month_r . '-01' . ' ' . $time_start,
319
-                                                'Y-m-d H:i:s');
320
-        $end_string = EEM_Registration::instance()
321
-                                      ->convert_datetime_for_query('REG_date',
322
-                                          $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' ' . $time_end,
323
-                                          'Y-m-d H:i:s');
324
-        $_where['REG_date'] = array(
325
-            'BETWEEN',
326
-            array(
327
-                $beginning_string,
328
-                $end_string,
329
-            ),
330
-        );
331
-        $_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
332
-        return EEM_Registration::instance()->count(array($_where));
333
-    }
334
-
335
-
336
-
337
-    /**
338
-     * _total_registrations_today
339
-     *
340
-     * @access protected
341
-     * @return int
342
-     * @throws \EE_Error
343
-     */
344
-    protected function _total_registrations_today()
345
-    {
346
-        $EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
347
-        $_where = $EVT_ID ? array('EVT_ID' => $EVT_ID) : array();
348
-        $current_date = date('Y-m-d', current_time('timestamp'));
349
-        $time_start = ' 00:00:00';
350
-        $time_end = ' 23:59:59';
351
-        $_where['REG_date'] = array(
352
-            'BETWEEN',
353
-            array(
354
-                EEM_Registration::instance()
355
-                                ->convert_datetime_for_query('REG_date', $current_date . $time_start, 'Y-m-d H:i:s'),
356
-                EEM_Registration::instance()
357
-                                ->convert_datetime_for_query('REG_date', $current_date . $time_end, 'Y-m-d H:i:s'),
358
-            ),
359
-        );
360
-        $_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
361
-        return EEM_Registration::instance()->count(array($_where));
362
-    }
363
-
364
-
365
-
366
-    /**
367
-     * column_cb
368
-     *
369
-     * @access public
370
-     * @param \EE_Registration $item
371
-     * @return string
372
-     * @throws \EE_Error
373
-     */
374
-    public function column_cb($item)
375
-    {
376
-        /** checkbox/lock **/
377
-        $transaction = $item->get_first_related('Transaction');
378
-        $payment_count = $transaction instanceof EE_Transaction ? $transaction->count_related('Payment') : 0;
379
-        return $payment_count > 0 ? sprintf('<input type="checkbox" name="_REG_ID[]" value="%1$s" />', $item->ID())
380
-                                    . '<span class="ee-lock-icon"></span>'
381
-            : sprintf('<input type="checkbox" name="_REG_ID[]" value="%1$s" />', $item->ID());
382
-    }
383
-
384
-
385
-
386
-    /**
387
-     * column__REG_ID
388
-     *
389
-     * @access public
390
-     * @param \EE_Registration $item
391
-     * @return string
392
-     * @throws \EE_Error
393
-     */
394
-    public function column__REG_ID(EE_Registration $item)
395
-    {
396
-        $attendee = $item->attendee();
397
-        $content = $item->ID();
398
-        $content .= '<div class="show-on-mobile-view-only">';
399
-        $content .= '<br>';
400
-        $content .= $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
401
-        $content .= '&nbsp;' . sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
402
-        $content .= '<br>' . sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
403
-        $content .= '</div>';
404
-        return $content;
405
-    }
406
-
407
-
408
-
409
-    /**
410
-     * column__REG_date
411
-     *
412
-     * @access public
413
-     * @param \EE_Registration $item
414
-     * @return string
415
-     * @throws \EE_Error
416
-     */
417
-    public function column__REG_date(EE_Registration $item)
418
-    {
419
-        $this->_set_related_details($item);
420
-        //Build row actions
421
-        $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
422
-            'action' => 'view_transaction',
423
-            'TXN_ID' => $this->_transaction_details['id'],
424
-        ), TXN_ADMIN_URL);
425
-        $view_link = EE_Registry::instance()->CAP->current_user_can('ee_read_transaction',
426
-            'espresso_transactions_view_transaction') ? '<a class="ee-status-color-'
427
-                                                        . $this->_transaction_details['status']
428
-                                                        . '" href="'
429
-                                                        . $view_lnk_url
430
-                                                        . '" title="'
431
-                                                        . esc_attr($this->_transaction_details['title_attr'])
432
-                                                        . '">'
433
-                                                        . $item->get_i18n_datetime('REG_date')
434
-                                                        . '</a>' : $item->get_i18n_datetime('REG_date');
435
-        $view_link .= '<br><span class="ee-status-text-small">'
436
-                      . EEH_Template::pretty_status($this->_transaction_details['status'], false, 'sentence')
437
-                      . '</span>';
438
-        return $view_link;
439
-    }
440
-
441
-
442
-
443
-    /**
444
-     * column_event_name
445
-     *
446
-     * @access public
447
-     * @param \EE_Registration $item
448
-     * @return string
449
-     * @throws \EE_Error
450
-     */
451
-    public function column_event_name(EE_Registration $item)
452
-    {
453
-        $this->_set_related_details($item);
454
-        // page=espresso_events&action=edit_event&EVT_ID=2&edit_event_nonce=cf3a7e5b62
455
-        $EVT_ID = $item->event_ID();
456
-        $event_name = $item->event_name();
457
-        $event_name = $event_name ? $event_name : __("No Associated Event", 'event_espresso');
458
-        $event_name = wp_trim_words($event_name, 30, '...');
459
-        if ($EVT_ID) {
460
-            $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'edit', 'post' => $EVT_ID),
461
-                EVENTS_ADMIN_URL);
462
-            $edit_event = EE_Registry::instance()->CAP->current_user_can('ee_edit_event', 'edit_event', $EVT_ID)
463
-                ? '<a class="ee-status-color-'
464
-                  . $this->_event_details['status']
465
-                  . '" href="'
466
-                  . $edit_event_url
467
-                  . '" title="'
468
-                  . esc_attr($this->_event_details['title_attr'])
469
-                  . '">'
470
-                  . $event_name
471
-                  . '</a>' : $event_name;
472
-            $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(array('event_id' => $EVT_ID), REG_ADMIN_URL);
473
-            $actions['event_filter'] = '<a href="' . $edit_event_url . '" title="';
474
-            $actions['event_filter'] .= sprintf(esc_attr__('Filter this list to only show registrations for %s',
475
-                'event_espresso'), $event_name);
476
-            $actions['event_filter'] .= '">' . __('View Registrations', 'event_espresso') . '</a>';
477
-        } else {
478
-            $edit_event = $event_name;
479
-            $actions['event_filter'] = '';
480
-        }
481
-        return sprintf('%1$s %2$s', $edit_event, $this->row_actions($actions));
482
-    }
483
-
484
-
485
-
486
-    /**
487
-     * column_DTT_EVT_start
488
-     *
489
-     * @access public
490
-     * @param \EE_Registration $item
491
-     * @return string
492
-     * @throws \EE_Error
493
-     */
494
-    public function column_DTT_EVT_start(EE_Registration $item)
495
-    {
496
-        $datetime_strings = array();
497
-        $ticket = $item->ticket(true);
498
-        if ($ticket instanceof EE_Ticket) {
499
-            $remove_defaults = array('default_where_conditions' => 'none');
500
-            $datetimes = $ticket->datetimes($remove_defaults);
501
-            foreach ($datetimes as $datetime) {
502
-                $datetime_strings[] = $datetime->get_i18n_datetime('DTT_EVT_start');
503
-            }
504
-            return implode("<br />", $datetime_strings);
505
-        } else {
506
-            return __('There is no ticket on this registration', 'event_espresso');
507
-        }
508
-    }
509
-
510
-
511
-
512
-    /**
513
-     * column_ATT_fname
514
-     *
515
-     * @access public
516
-     * @param \EE_Registration $item
517
-     * @return string
518
-     * @throws \EE_Error
519
-     */
520
-    public function column_ATT_fname(EE_Registration $item)
521
-    {
522
-        $attendee = $item->attendee();
523
-        $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
524
-            'action'  => 'view_registration',
525
-            '_REG_ID' => $item->ID(),
526
-        ), REG_ADMIN_URL);
527
-        $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
528
-        $link = EE_Registry::instance()->CAP->current_user_can('ee_read_registration',
529
-            'espresso_registrations_view_registration', $item->ID()) ? '<a href="'
530
-                                                                       . $edit_lnk_url
531
-                                                                       . '" title="'
532
-                                                                       . esc_attr__('View Registration Details',
533
-                'event_espresso')
534
-                                                                       . '">'
535
-                                                                       . $attendee_name
536
-                                                                       . '</a>' : $attendee_name;
537
-        $link .= $item->count() === 1
538
-            ? '&nbsp;<sup><div class="dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8"></div></sup>' : '';
539
-        $t = $item->get_first_related('Transaction');
540
-        $payment_count = $t instanceof EE_Transaction ? $t->count_related('Payment') : 0;
541
-        //append group count to name
542
-        $link .= '&nbsp;' . sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
543
-        //append reg_code
544
-        $link .= '<br>' . sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
545
-        //reg status text for accessibility
546
-        $link .= '<br><span class="ee-status-text-small">' . EEH_Template::pretty_status($item->status_ID(), false,
547
-                'sentence') . '</span>';
548
-        //trash/restore/delete actions
549
-        $actions = array();
550
-        if ($this->_view !== 'trash'
551
-            && $payment_count === 0
552
-            && EE_Registry::instance()->CAP->current_user_can('ee_delete_registration',
553
-                'espresso_registrations_trash_registrations', $item->ID())
554
-        ) {
555
-            $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
556
-                'action'  => 'trash_registrations',
557
-                '_REG_ID' => $item->ID(),
558
-            ), REG_ADMIN_URL);
559
-            $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="' . esc_attr__('Trash Registration',
560
-                    'event_espresso') . '">' . __('Trash', 'event_espresso') . '</a>';
561
-        } elseif ($this->_view === 'trash') {
562
-            // restore registration link
563
-            if (EE_Registry::instance()->CAP->current_user_can('ee_delete_registration',
564
-                'espresso_registrations_restore_registrations', $item->ID())
565
-            ) {
566
-                $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
567
-                    'action'  => 'restore_registrations',
568
-                    '_REG_ID' => $item->ID(),
569
-                ), REG_ADMIN_URL);
570
-                $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="' . esc_attr__('Restore Registration',
571
-                        'event_espresso') . '">' . __('Restore', 'event_espresso') . '</a>';
572
-            }
573
-            if (EE_Registry::instance()->CAP->current_user_can('ee_delete_registration',
574
-                'espresso_registrations_ee_delete_registrations', $item->ID())
575
-            ) {
576
-                $delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
577
-                    'action'  => 'delete_registrations',
578
-                    '_REG_ID' => $item->ID(),
579
-                ), REG_ADMIN_URL);
580
-                $actions['delete'] = '<a href="'
581
-                                     . $delete_lnk_url
582
-                                     . '" title="'
583
-                                     . esc_attr__('Delete Registration Permanently', 'event_espresso')
584
-                                     . '">'
585
-                                     . __('Delete', 'event_espresso')
586
-                                     . '</a>';
587
-            }
588
-        }
589
-        return sprintf('%1$s %2$s', $link, $this->row_actions($actions));
590
-    }
591
-
592
-
593
-
594
-    /**
595
-     * column_ATT_email
596
-     *
597
-     * @access public
598
-     * @param \EE_Registration $item
599
-     * @return string
600
-     * @throws \EE_Error
601
-     */
602
-    public function column_ATT_email(EE_Registration $item)
603
-    {
604
-        $attendee = $item->get_first_related('Attendee');
605
-        return ! $attendee instanceof EE_Attendee ? __('No attached contact record.', 'event_espresso')
606
-            : $attendee->email();
607
-    }
608
-
609
-
610
-
611
-    /**
612
-     * column__REG_count
613
-     *
614
-     * @access public
615
-     * @param \EE_Registration $item
616
-     * @return string
617
-     */
618
-    public function column__REG_count(EE_Registration $item)
619
-    {
620
-        return sprintf(__('%1$s / %2$s', 'event_espresso'), $item->count(), $item->group_size());
621
-    }
622
-
623
-
624
-
625
-    /**
626
-     * column_PRC_amount
627
-     *
628
-     * @access public
629
-     * @param \EE_Registration $item
630
-     * @return string
631
-     */
632
-    public function column_PRC_amount(EE_Registration $item)
633
-    {
634
-        $ticket = $item->ticket();
635
-        $content = isset($_GET['event_id']) && $ticket instanceof EE_Ticket ? '<span class="TKT_name">'
636
-                                                                              . $ticket->name()
637
-                                                                              . '</span><br />' : '';
638
-        if ($item->final_price() > 0) {
639
-            $content .= '<span class="reg-pad-rght">' . $item->pretty_final_price() . '</span>';
640
-        } else {
641
-            // free event
642
-            $content .= '<span class="reg-overview-free-event-spn reg-pad-rght">'
643
-                        . __('free', 'event_espresso')
644
-                        . '</span>';
645
-        }
646
-        return $content;
647
-    }
648
-
649
-
650
-
651
-    /**
652
-     * column__REG_final_price
653
-     *
654
-     * @access public
655
-     * @param \EE_Registration $item
656
-     * @return string
657
-     */
658
-    public function column__REG_final_price(EE_Registration $item)
659
-    {
660
-        $ticket = $item->ticket();
661
-        $content = isset($_GET['event_id']) || ! $ticket instanceof EE_Ticket
662
-            ? ''
663
-            : '<span class="TKT_name">'
664
-              . $ticket->name()
665
-              . '</span><br />';
666
-        $content .= '<span class="reg-pad-rght">' . $item->pretty_final_price() . '</span>';
667
-        return $content;
668
-    }
669
-
670
-
671
-
672
-    /**
673
-     * column__REG_paid
674
-     *
675
-     * @access public
676
-     * @param \EE_Registration $item
677
-     * @return string
678
-     */
679
-    public function column__REG_paid(EE_Registration $item)
680
-    {
681
-        $payment_method = $item->payment_method();
682
-        $payment_method_name = $payment_method instanceof EE_Payment_Method ? $payment_method->admin_name()
683
-            : __('Unknown', 'event_espresso');
684
-        $content = '<span class="reg-pad-rght">' . $item->pretty_paid() . '</span>';
685
-        if ($item->paid() > 0) {
686
-            $content .= '<br><span class="ee-status-text-small">' . sprintf(__('...via %s', 'event_espresso'),
687
-                    $payment_method_name) . '</span>';
688
-        }
689
-        return $content;
690
-    }
691
-
692
-
693
-
694
-    /**
695
-     * column_TXN_total
696
-     *
697
-     * @access public
698
-     * @param \EE_Registration $item
699
-     * @return string
700
-     * @throws \EE_Error
701
-     */
702
-    public function column_TXN_total(EE_Registration $item)
703
-    {
704
-        if ($item->transaction()) {
705
-            $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
706
-                'action' => 'view_transaction',
707
-                'TXN_ID' => $item->transaction_ID(),
708
-            ), TXN_ADMIN_URL);
709
-            return EE_Registry::instance()->CAP->current_user_can('ee_read_transaction',
710
-                'espresso_transactions_view_transaction', $item->transaction_ID())
711
-                ? '<span class="reg-pad-rght"><a class="status-'
712
-                  . $item->transaction()->status_ID()
713
-                  . '" href="'
714
-                  . $view_txn_lnk_url
715
-                  . '"  title="'
716
-                  . esc_attr__('View Transaction', 'event_espresso')
717
-                  . '">'
718
-                  . $item->transaction()->pretty_total()
719
-                  . '</a></span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_total() . '</span>';
720
-        } else {
721
-            return __("None", "event_espresso");
722
-        }
723
-    }
724
-
725
-
726
-
727
-    /**
728
-     * column_TXN_paid
729
-     *
730
-     * @access public
731
-     * @param \EE_Registration $item
732
-     * @return string
733
-     * @throws \EE_Error
734
-     */
735
-    public function column_TXN_paid(EE_Registration $item)
736
-    {
737
-        if ($item->count() === 1) {
738
-            $transaction = $item->transaction() ? $item->transaction() : EE_Transaction::new_instance();
739
-            if ($transaction->paid() >= $transaction->total()) {
740
-                return '<span class="reg-pad-rght"><div class="dashicons dashicons-yes green-icon"></div></span>';
741
-            } else {
742
-                $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
743
-                    'action' => 'view_transaction',
744
-                    'TXN_ID' => $item->transaction_ID(),
745
-                ), TXN_ADMIN_URL);
746
-                return EE_Registry::instance()->CAP->current_user_can('ee_read_transaction',
747
-                    'espresso_transactions_view_transaction', $item->transaction_ID())
748
-                    ? '<span class="reg-pad-rght"><a class="status-'
749
-                      . $transaction->status_ID()
750
-                      . '" href="'
751
-                      . $view_txn_lnk_url
752
-                      . '"  title="'
753
-                      . esc_attr__('View Transaction', 'event_espresso')
754
-                      . '">'
755
-                      . $item->transaction()->pretty_paid()
756
-                      . '</a><span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_paid() . '</span>';
757
-            }
758
-        }
759
-        return '&nbsp;';
760
-    }
761
-
762
-
763
-
764
-    /**
765
-     * column_actions
766
-     *
767
-     * @access public
768
-     * @param \EE_Registration $item
769
-     * @return string
770
-     * @throws \EE_Error
771
-     */
772
-    public function column_actions(EE_Registration $item)
773
-    {
774
-        $actions = array();
775
-        $attendee = $item->attendee();
776
-        $this->_set_related_details($item);
777
-        //Build row actions
778
-        $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
779
-            'action'  => 'view_registration',
780
-            '_REG_ID' => $item->ID(),
781
-        ), REG_ADMIN_URL);
782
-        $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
783
-            'action' => 'edit_attendee',
784
-            'post'   => $item->attendee_ID(),
785
-        ), REG_ADMIN_URL);
786
-        // page=attendees&event_admin_reports=resend_email&registration_id=43653465634&event_id=2&form_action=resend_email
787
-        //$resend_reg_lnk_url_params = array( 'action'=>'resend_registration', '_REG_ID'=>$item->REG_ID );
788
-        $resend_reg_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
789
-            'action'  => 'resend_registration',
790
-            '_REG_ID' => $item->ID(),
791
-        ), REG_ADMIN_URL, true);
792
-        //Build row actions
793
-        $actions['view_lnk'] = EE_Registry::instance()->CAP->current_user_can('ee_read_registration',
794
-            'espresso_registrations_view_registration', $item->ID()) ? '
29
+	private $_status;
30
+
31
+
32
+
33
+	/**
34
+	 * An array of transaction details for the related transaction to the registration being processed.
35
+	 * This is set via the _set_related_details method.
36
+	 *
37
+	 * @var array
38
+	 */
39
+	protected $_transaction_details = array();
40
+
41
+
42
+
43
+	/**
44
+	 * An array of event details for the related event to the registration being processed.
45
+	 * This is set via the _set_related_details method.
46
+	 *
47
+	 * @var array
48
+	 */
49
+	protected $_event_details = array();
50
+
51
+
52
+
53
+	/**
54
+	 * @param \Registrations_Admin_Page $admin_page
55
+	 */
56
+	public function __construct(Registrations_Admin_Page $admin_page)
57
+	{
58
+		if ( ! empty($_GET['event_id'])) {
59
+			$extra_query_args = array();
60
+			foreach ($admin_page->get_views() as $key => $view_details) {
61
+				$extra_query_args[$view_details['slug']] = array('event_id' => $_GET['event_id']);
62
+			}
63
+			$this->_views = $admin_page->get_list_table_view_RLs($extra_query_args);
64
+		}
65
+		parent::__construct($admin_page);
66
+		$this->_status = $this->_admin_page->get_registration_status_array();
67
+	}
68
+
69
+
70
+
71
+	/**
72
+	 *    _setup_data
73
+	 *
74
+	 * @access protected
75
+	 * @return void
76
+	 */
77
+	protected function _setup_data()
78
+	{
79
+		$this->_data = $this->_admin_page->get_registrations($this->_per_page);
80
+		$this->_all_data_count = $this->_admin_page->get_registrations($this->_per_page, true, false, false);
81
+	}
82
+
83
+
84
+
85
+	/**
86
+	 *    _set_properties
87
+	 *
88
+	 * @access protected
89
+	 * @return void
90
+	 */
91
+	protected function _set_properties()
92
+	{
93
+		$this->_wp_list_args = array(
94
+			'singular' => __('registration', 'event_espresso'),
95
+			'plural'   => __('registrations', 'event_espresso'),
96
+			'ajax'     => true,
97
+			'screen'   => $this->_admin_page->get_current_screen()->id,
98
+		);
99
+		$ID_column_name = __('ID', 'event_espresso');
100
+		$ID_column_name .= ' : <span class="show-on-mobile-view-only" style="float:none">';
101
+		$ID_column_name .= __('Registrant Name', 'event_espresso');
102
+		$ID_column_name .= '</span> ';
103
+		if (isset($_GET['event_id'])) {
104
+			$this->_columns = array(
105
+				'cb'               => '<input type="checkbox" />', //Render a checkbox instead of text
106
+				'_REG_ID'          => $ID_column_name,
107
+				'ATT_fname'        => __('Name', 'event_espresso'),
108
+				'ATT_email'        => __('Email', 'event_espresso'),
109
+				'_REG_date'        => __('Reg Date', 'event_espresso'),
110
+				'PRC_amount'       => __('TKT Price', 'event_espresso'),
111
+				'_REG_final_price' => __('Final Price', 'event_espresso'),
112
+				'TXN_total'        => __('Total Txn', 'event_espresso'),
113
+				'TXN_paid'         => __('Paid', 'event_espresso'),
114
+				'actions'          => __('Actions', 'event_espresso'),
115
+			);
116
+			$this->_bottom_buttons = array(
117
+				'report' => array(
118
+					'route'         => 'registrations_report',
119
+					'extra_request' => array(
120
+						'EVT_ID'     => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
121
+						'return_url' => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
122
+					),
123
+				),
124
+			);
125
+		} else {
126
+			$this->_columns = array(
127
+				'cb'               => '<input type="checkbox" />', //Render a checkbox instead of text
128
+				'_REG_ID'          => $ID_column_name,
129
+				'ATT_fname'        => __('Name', 'event_espresso'),
130
+				'_REG_date'        => __('TXN Date', 'event_espresso'),
131
+				'event_name'       => __('Event', 'event_espresso'),
132
+				'DTT_EVT_start'    => __('Event Date', 'event_espresso'),
133
+				'_REG_final_price' => __('Price', 'event_espresso'),
134
+				'_REG_paid'        => __('Paid', 'event_espresso'),
135
+				'actions'          => __('Actions', 'event_espresso'),
136
+			);
137
+			$this->_bottom_buttons = array(
138
+				'report_all' => array(
139
+					'route'         => 'registrations_report',
140
+					'extra_request' => array(
141
+						'return_url' => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"),
142
+					),
143
+				),
144
+			);
145
+		}
146
+		$this->_primary_column = '_REG_ID';
147
+		$this->_sortable_columns = array(
148
+			'_REG_date'     => array('_REG_date' => true),   //true means its already sorted
149
+			'ATT_fname'     => array('ATT_fname' => false),
150
+			'event_name'    => array('event_name' => false),
151
+			'DTT_EVT_start' => array('DTT_EVT_start' => false),
152
+			'_REG_ID'       => array('_REG_ID' => false),
153
+		);
154
+		$this->_hidden_columns = array();
155
+	}
156
+
157
+
158
+
159
+	/**
160
+	 * This simply sets up the row class for the table rows.
161
+	 * Allows for easier overriding of child methods for setting up sorting.
162
+	 *
163
+	 * @param  EE_Registration $item the current item
164
+	 * @return string
165
+	 */
166
+	protected function _get_row_class($item)
167
+	{
168
+		$class = parent::_get_row_class($item);
169
+		//add status class
170
+		$class .= ' ee-status-strip reg-status-' . $item->status_ID();
171
+		if ($this->_has_checkbox_column) {
172
+			$class .= ' has-checkbox-column';
173
+		}
174
+		return $class;
175
+	}
176
+
177
+
178
+
179
+	/**
180
+	 * Set the $_transaction_details property if not set yet.
181
+	 *
182
+	 * @param EE_Registration $registration
183
+	 * @throws \EE_Error
184
+	 */
185
+	protected function _set_related_details(EE_Registration $registration)
186
+	{
187
+		$transaction = $registration->get_first_related('Transaction');
188
+		$status = $transaction instanceof EE_Transaction ? $transaction->status_ID()
189
+			: EEM_Transaction::failed_status_code;
190
+		$this->_transaction_details = array(
191
+			'transaction' => $transaction,
192
+			'status'      => $status,
193
+			'id'          => $transaction instanceof EE_Transaction ? $transaction->ID() : 0,
194
+			'title_attr'  => sprintf(__('View Transaction Details (%s)', 'event_espresso'),
195
+				EEH_Template::pretty_status($status, false, 'sentence')),
196
+		);
197
+		try {
198
+			$event = $registration->event();
199
+		} catch (\EventEspresso\core\exceptions\EntityNotFoundException $e) {
200
+			$event = null;
201
+		}
202
+		$status = $event instanceof EE_Event ? $event->get_active_status() : EE_Datetime::inactive;
203
+		$this->_event_details = array(
204
+			'event'      => $event,
205
+			'status'     => $status,
206
+			'id'         => $event instanceof EE_Event ? $event->ID() : 0,
207
+			'title_attr' => sprintf(__('Edit Event (%s)', 'event_espresso'),
208
+				EEH_Template::pretty_status($status, false, 'sentence')),
209
+		);
210
+	}
211
+
212
+
213
+
214
+	/**
215
+	 *    _get_table_filters
216
+	 *
217
+	 * @access protected
218
+	 * @return array
219
+	 */
220
+	protected function _get_table_filters()
221
+	{
222
+		$filters = array();
223
+		//todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as methods.
224
+		$cur_date = isset($this->_req_data['month_range']) ? $this->_req_data['month_range'] : '';
225
+		$cur_category = isset($this->_req_data['EVT_CAT']) ? $this->_req_data['EVT_CAT'] : -1;
226
+		$reg_status = isset($this->_req_data['_reg_status']) ? $this->_req_data['_reg_status'] : '';
227
+		$filters[] = EEH_Form_Fields::generate_registration_months_dropdown($cur_date, $reg_status, $cur_category);
228
+		$filters[] = EEH_Form_Fields::generate_event_category_dropdown($cur_category);
229
+		$status = array();
230
+		$status[] = array('id' => 0, 'text' => __('Select Status', 'event_espresso'));
231
+		foreach ($this->_status as $key => $value) {
232
+			$status[] = array('id' => $key, 'text' => $value);
233
+		}
234
+		if ($this->_view !== 'incomplete') {
235
+			$filters[] = EEH_Form_Fields::select_input('_reg_status', $status,
236
+				isset($this->_req_data['_reg_status']) ? strtoupper(sanitize_key($this->_req_data['_reg_status']))
237
+					: '');
238
+		}
239
+		if (isset($this->_req_data['event_id'])) {
240
+			$filters[] = EEH_Form_Fields::hidden_input('event_id', $this->_req_data['event_id'], 'reg_event_id');
241
+		}
242
+		return $filters;
243
+	}
244
+
245
+
246
+
247
+	/**
248
+	 *    _add_view_counts
249
+	 *
250
+	 * @access protected
251
+	 * @return void
252
+	 * @throws \EE_Error
253
+	 */
254
+	protected function _add_view_counts()
255
+	{
256
+		$this->_views['all']['count'] = $this->_total_registrations();
257
+		$this->_views['month']['count'] = $this->_total_registrations_this_month();
258
+		$this->_views['today']['count'] = $this->_total_registrations_today();
259
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_registrations',
260
+			'espresso_registrations_trash_registrations')
261
+		) {
262
+			$this->_views['incomplete']['count'] = $this->_total_registrations('incomplete');
263
+			$this->_views['trash']['count'] = $this->_total_registrations('trash');
264
+		}
265
+	}
266
+
267
+
268
+
269
+	/**
270
+	 * _total_registrations
271
+	 *
272
+	 * @access protected
273
+	 * @param string $view
274
+	 * @return int
275
+	 * @throws \EE_Error
276
+	 */
277
+	protected function _total_registrations($view = '')
278
+	{
279
+		$_where = array();
280
+		$EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
281
+		if ($EVT_ID) {
282
+			$_where['EVT_ID'] = $EVT_ID;
283
+		}
284
+		switch ($view) {
285
+			case 'trash' :
286
+				return EEM_Registration::instance()->count_deleted(array($_where));
287
+				break;
288
+			case 'incomplete' :
289
+				$_where['STS_ID'] = EEM_Registration::status_id_incomplete;
290
+				break;
291
+			default :
292
+				$_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
293
+		}
294
+		return EEM_Registration::instance()->count(array($_where));
295
+	}
296
+
297
+
298
+
299
+	/**
300
+	 * _total_registrations_this_month
301
+	 *
302
+	 * @access protected
303
+	 * @return int
304
+	 * @throws \EE_Error
305
+	 */
306
+	protected function _total_registrations_this_month()
307
+	{
308
+		$EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
309
+		$_where = $EVT_ID ? array('EVT_ID' => $EVT_ID) : array();
310
+		$this_year_r = date('Y', current_time('timestamp'));
311
+		$time_start = ' 00:00:00';
312
+		$time_end = ' 23:59:59';
313
+		$this_month_r = date('m', current_time('timestamp'));
314
+		$days_this_month = date('t', current_time('timestamp'));
315
+		//setup date query.
316
+		$beginning_string = EEM_Registration::instance()
317
+											->convert_datetime_for_query('REG_date',
318
+												$this_year_r . '-' . $this_month_r . '-01' . ' ' . $time_start,
319
+												'Y-m-d H:i:s');
320
+		$end_string = EEM_Registration::instance()
321
+									  ->convert_datetime_for_query('REG_date',
322
+										  $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' ' . $time_end,
323
+										  'Y-m-d H:i:s');
324
+		$_where['REG_date'] = array(
325
+			'BETWEEN',
326
+			array(
327
+				$beginning_string,
328
+				$end_string,
329
+			),
330
+		);
331
+		$_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
332
+		return EEM_Registration::instance()->count(array($_where));
333
+	}
334
+
335
+
336
+
337
+	/**
338
+	 * _total_registrations_today
339
+	 *
340
+	 * @access protected
341
+	 * @return int
342
+	 * @throws \EE_Error
343
+	 */
344
+	protected function _total_registrations_today()
345
+	{
346
+		$EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
347
+		$_where = $EVT_ID ? array('EVT_ID' => $EVT_ID) : array();
348
+		$current_date = date('Y-m-d', current_time('timestamp'));
349
+		$time_start = ' 00:00:00';
350
+		$time_end = ' 23:59:59';
351
+		$_where['REG_date'] = array(
352
+			'BETWEEN',
353
+			array(
354
+				EEM_Registration::instance()
355
+								->convert_datetime_for_query('REG_date', $current_date . $time_start, 'Y-m-d H:i:s'),
356
+				EEM_Registration::instance()
357
+								->convert_datetime_for_query('REG_date', $current_date . $time_end, 'Y-m-d H:i:s'),
358
+			),
359
+		);
360
+		$_where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
361
+		return EEM_Registration::instance()->count(array($_where));
362
+	}
363
+
364
+
365
+
366
+	/**
367
+	 * column_cb
368
+	 *
369
+	 * @access public
370
+	 * @param \EE_Registration $item
371
+	 * @return string
372
+	 * @throws \EE_Error
373
+	 */
374
+	public function column_cb($item)
375
+	{
376
+		/** checkbox/lock **/
377
+		$transaction = $item->get_first_related('Transaction');
378
+		$payment_count = $transaction instanceof EE_Transaction ? $transaction->count_related('Payment') : 0;
379
+		return $payment_count > 0 ? sprintf('<input type="checkbox" name="_REG_ID[]" value="%1$s" />', $item->ID())
380
+									. '<span class="ee-lock-icon"></span>'
381
+			: sprintf('<input type="checkbox" name="_REG_ID[]" value="%1$s" />', $item->ID());
382
+	}
383
+
384
+
385
+
386
+	/**
387
+	 * column__REG_ID
388
+	 *
389
+	 * @access public
390
+	 * @param \EE_Registration $item
391
+	 * @return string
392
+	 * @throws \EE_Error
393
+	 */
394
+	public function column__REG_ID(EE_Registration $item)
395
+	{
396
+		$attendee = $item->attendee();
397
+		$content = $item->ID();
398
+		$content .= '<div class="show-on-mobile-view-only">';
399
+		$content .= '<br>';
400
+		$content .= $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
401
+		$content .= '&nbsp;' . sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
402
+		$content .= '<br>' . sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
403
+		$content .= '</div>';
404
+		return $content;
405
+	}
406
+
407
+
408
+
409
+	/**
410
+	 * column__REG_date
411
+	 *
412
+	 * @access public
413
+	 * @param \EE_Registration $item
414
+	 * @return string
415
+	 * @throws \EE_Error
416
+	 */
417
+	public function column__REG_date(EE_Registration $item)
418
+	{
419
+		$this->_set_related_details($item);
420
+		//Build row actions
421
+		$view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
422
+			'action' => 'view_transaction',
423
+			'TXN_ID' => $this->_transaction_details['id'],
424
+		), TXN_ADMIN_URL);
425
+		$view_link = EE_Registry::instance()->CAP->current_user_can('ee_read_transaction',
426
+			'espresso_transactions_view_transaction') ? '<a class="ee-status-color-'
427
+														. $this->_transaction_details['status']
428
+														. '" href="'
429
+														. $view_lnk_url
430
+														. '" title="'
431
+														. esc_attr($this->_transaction_details['title_attr'])
432
+														. '">'
433
+														. $item->get_i18n_datetime('REG_date')
434
+														. '</a>' : $item->get_i18n_datetime('REG_date');
435
+		$view_link .= '<br><span class="ee-status-text-small">'
436
+					  . EEH_Template::pretty_status($this->_transaction_details['status'], false, 'sentence')
437
+					  . '</span>';
438
+		return $view_link;
439
+	}
440
+
441
+
442
+
443
+	/**
444
+	 * column_event_name
445
+	 *
446
+	 * @access public
447
+	 * @param \EE_Registration $item
448
+	 * @return string
449
+	 * @throws \EE_Error
450
+	 */
451
+	public function column_event_name(EE_Registration $item)
452
+	{
453
+		$this->_set_related_details($item);
454
+		// page=espresso_events&action=edit_event&EVT_ID=2&edit_event_nonce=cf3a7e5b62
455
+		$EVT_ID = $item->event_ID();
456
+		$event_name = $item->event_name();
457
+		$event_name = $event_name ? $event_name : __("No Associated Event", 'event_espresso');
458
+		$event_name = wp_trim_words($event_name, 30, '...');
459
+		if ($EVT_ID) {
460
+			$edit_event_url = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'edit', 'post' => $EVT_ID),
461
+				EVENTS_ADMIN_URL);
462
+			$edit_event = EE_Registry::instance()->CAP->current_user_can('ee_edit_event', 'edit_event', $EVT_ID)
463
+				? '<a class="ee-status-color-'
464
+				  . $this->_event_details['status']
465
+				  . '" href="'
466
+				  . $edit_event_url
467
+				  . '" title="'
468
+				  . esc_attr($this->_event_details['title_attr'])
469
+				  . '">'
470
+				  . $event_name
471
+				  . '</a>' : $event_name;
472
+			$edit_event_url = EE_Admin_Page::add_query_args_and_nonce(array('event_id' => $EVT_ID), REG_ADMIN_URL);
473
+			$actions['event_filter'] = '<a href="' . $edit_event_url . '" title="';
474
+			$actions['event_filter'] .= sprintf(esc_attr__('Filter this list to only show registrations for %s',
475
+				'event_espresso'), $event_name);
476
+			$actions['event_filter'] .= '">' . __('View Registrations', 'event_espresso') . '</a>';
477
+		} else {
478
+			$edit_event = $event_name;
479
+			$actions['event_filter'] = '';
480
+		}
481
+		return sprintf('%1$s %2$s', $edit_event, $this->row_actions($actions));
482
+	}
483
+
484
+
485
+
486
+	/**
487
+	 * column_DTT_EVT_start
488
+	 *
489
+	 * @access public
490
+	 * @param \EE_Registration $item
491
+	 * @return string
492
+	 * @throws \EE_Error
493
+	 */
494
+	public function column_DTT_EVT_start(EE_Registration $item)
495
+	{
496
+		$datetime_strings = array();
497
+		$ticket = $item->ticket(true);
498
+		if ($ticket instanceof EE_Ticket) {
499
+			$remove_defaults = array('default_where_conditions' => 'none');
500
+			$datetimes = $ticket->datetimes($remove_defaults);
501
+			foreach ($datetimes as $datetime) {
502
+				$datetime_strings[] = $datetime->get_i18n_datetime('DTT_EVT_start');
503
+			}
504
+			return implode("<br />", $datetime_strings);
505
+		} else {
506
+			return __('There is no ticket on this registration', 'event_espresso');
507
+		}
508
+	}
509
+
510
+
511
+
512
+	/**
513
+	 * column_ATT_fname
514
+	 *
515
+	 * @access public
516
+	 * @param \EE_Registration $item
517
+	 * @return string
518
+	 * @throws \EE_Error
519
+	 */
520
+	public function column_ATT_fname(EE_Registration $item)
521
+	{
522
+		$attendee = $item->attendee();
523
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
524
+			'action'  => 'view_registration',
525
+			'_REG_ID' => $item->ID(),
526
+		), REG_ADMIN_URL);
527
+		$attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
528
+		$link = EE_Registry::instance()->CAP->current_user_can('ee_read_registration',
529
+			'espresso_registrations_view_registration', $item->ID()) ? '<a href="'
530
+																	   . $edit_lnk_url
531
+																	   . '" title="'
532
+																	   . esc_attr__('View Registration Details',
533
+				'event_espresso')
534
+																	   . '">'
535
+																	   . $attendee_name
536
+																	   . '</a>' : $attendee_name;
537
+		$link .= $item->count() === 1
538
+			? '&nbsp;<sup><div class="dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8"></div></sup>' : '';
539
+		$t = $item->get_first_related('Transaction');
540
+		$payment_count = $t instanceof EE_Transaction ? $t->count_related('Payment') : 0;
541
+		//append group count to name
542
+		$link .= '&nbsp;' . sprintf(__('(%1$s / %2$s)', 'event_espresso'), $item->count(), $item->group_size());
543
+		//append reg_code
544
+		$link .= '<br>' . sprintf(__('Reg Code: %s', 'event_espresso'), $item->get('REG_code'));
545
+		//reg status text for accessibility
546
+		$link .= '<br><span class="ee-status-text-small">' . EEH_Template::pretty_status($item->status_ID(), false,
547
+				'sentence') . '</span>';
548
+		//trash/restore/delete actions
549
+		$actions = array();
550
+		if ($this->_view !== 'trash'
551
+			&& $payment_count === 0
552
+			&& EE_Registry::instance()->CAP->current_user_can('ee_delete_registration',
553
+				'espresso_registrations_trash_registrations', $item->ID())
554
+		) {
555
+			$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
556
+				'action'  => 'trash_registrations',
557
+				'_REG_ID' => $item->ID(),
558
+			), REG_ADMIN_URL);
559
+			$actions['trash'] = '<a href="' . $trash_lnk_url . '" title="' . esc_attr__('Trash Registration',
560
+					'event_espresso') . '">' . __('Trash', 'event_espresso') . '</a>';
561
+		} elseif ($this->_view === 'trash') {
562
+			// restore registration link
563
+			if (EE_Registry::instance()->CAP->current_user_can('ee_delete_registration',
564
+				'espresso_registrations_restore_registrations', $item->ID())
565
+			) {
566
+				$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
567
+					'action'  => 'restore_registrations',
568
+					'_REG_ID' => $item->ID(),
569
+				), REG_ADMIN_URL);
570
+				$actions['restore'] = '<a href="' . $restore_lnk_url . '" title="' . esc_attr__('Restore Registration',
571
+						'event_espresso') . '">' . __('Restore', 'event_espresso') . '</a>';
572
+			}
573
+			if (EE_Registry::instance()->CAP->current_user_can('ee_delete_registration',
574
+				'espresso_registrations_ee_delete_registrations', $item->ID())
575
+			) {
576
+				$delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
577
+					'action'  => 'delete_registrations',
578
+					'_REG_ID' => $item->ID(),
579
+				), REG_ADMIN_URL);
580
+				$actions['delete'] = '<a href="'
581
+									 . $delete_lnk_url
582
+									 . '" title="'
583
+									 . esc_attr__('Delete Registration Permanently', 'event_espresso')
584
+									 . '">'
585
+									 . __('Delete', 'event_espresso')
586
+									 . '</a>';
587
+			}
588
+		}
589
+		return sprintf('%1$s %2$s', $link, $this->row_actions($actions));
590
+	}
591
+
592
+
593
+
594
+	/**
595
+	 * column_ATT_email
596
+	 *
597
+	 * @access public
598
+	 * @param \EE_Registration $item
599
+	 * @return string
600
+	 * @throws \EE_Error
601
+	 */
602
+	public function column_ATT_email(EE_Registration $item)
603
+	{
604
+		$attendee = $item->get_first_related('Attendee');
605
+		return ! $attendee instanceof EE_Attendee ? __('No attached contact record.', 'event_espresso')
606
+			: $attendee->email();
607
+	}
608
+
609
+
610
+
611
+	/**
612
+	 * column__REG_count
613
+	 *
614
+	 * @access public
615
+	 * @param \EE_Registration $item
616
+	 * @return string
617
+	 */
618
+	public function column__REG_count(EE_Registration $item)
619
+	{
620
+		return sprintf(__('%1$s / %2$s', 'event_espresso'), $item->count(), $item->group_size());
621
+	}
622
+
623
+
624
+
625
+	/**
626
+	 * column_PRC_amount
627
+	 *
628
+	 * @access public
629
+	 * @param \EE_Registration $item
630
+	 * @return string
631
+	 */
632
+	public function column_PRC_amount(EE_Registration $item)
633
+	{
634
+		$ticket = $item->ticket();
635
+		$content = isset($_GET['event_id']) && $ticket instanceof EE_Ticket ? '<span class="TKT_name">'
636
+																			  . $ticket->name()
637
+																			  . '</span><br />' : '';
638
+		if ($item->final_price() > 0) {
639
+			$content .= '<span class="reg-pad-rght">' . $item->pretty_final_price() . '</span>';
640
+		} else {
641
+			// free event
642
+			$content .= '<span class="reg-overview-free-event-spn reg-pad-rght">'
643
+						. __('free', 'event_espresso')
644
+						. '</span>';
645
+		}
646
+		return $content;
647
+	}
648
+
649
+
650
+
651
+	/**
652
+	 * column__REG_final_price
653
+	 *
654
+	 * @access public
655
+	 * @param \EE_Registration $item
656
+	 * @return string
657
+	 */
658
+	public function column__REG_final_price(EE_Registration $item)
659
+	{
660
+		$ticket = $item->ticket();
661
+		$content = isset($_GET['event_id']) || ! $ticket instanceof EE_Ticket
662
+			? ''
663
+			: '<span class="TKT_name">'
664
+			  . $ticket->name()
665
+			  . '</span><br />';
666
+		$content .= '<span class="reg-pad-rght">' . $item->pretty_final_price() . '</span>';
667
+		return $content;
668
+	}
669
+
670
+
671
+
672
+	/**
673
+	 * column__REG_paid
674
+	 *
675
+	 * @access public
676
+	 * @param \EE_Registration $item
677
+	 * @return string
678
+	 */
679
+	public function column__REG_paid(EE_Registration $item)
680
+	{
681
+		$payment_method = $item->payment_method();
682
+		$payment_method_name = $payment_method instanceof EE_Payment_Method ? $payment_method->admin_name()
683
+			: __('Unknown', 'event_espresso');
684
+		$content = '<span class="reg-pad-rght">' . $item->pretty_paid() . '</span>';
685
+		if ($item->paid() > 0) {
686
+			$content .= '<br><span class="ee-status-text-small">' . sprintf(__('...via %s', 'event_espresso'),
687
+					$payment_method_name) . '</span>';
688
+		}
689
+		return $content;
690
+	}
691
+
692
+
693
+
694
+	/**
695
+	 * column_TXN_total
696
+	 *
697
+	 * @access public
698
+	 * @param \EE_Registration $item
699
+	 * @return string
700
+	 * @throws \EE_Error
701
+	 */
702
+	public function column_TXN_total(EE_Registration $item)
703
+	{
704
+		if ($item->transaction()) {
705
+			$view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
706
+				'action' => 'view_transaction',
707
+				'TXN_ID' => $item->transaction_ID(),
708
+			), TXN_ADMIN_URL);
709
+			return EE_Registry::instance()->CAP->current_user_can('ee_read_transaction',
710
+				'espresso_transactions_view_transaction', $item->transaction_ID())
711
+				? '<span class="reg-pad-rght"><a class="status-'
712
+				  . $item->transaction()->status_ID()
713
+				  . '" href="'
714
+				  . $view_txn_lnk_url
715
+				  . '"  title="'
716
+				  . esc_attr__('View Transaction', 'event_espresso')
717
+				  . '">'
718
+				  . $item->transaction()->pretty_total()
719
+				  . '</a></span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_total() . '</span>';
720
+		} else {
721
+			return __("None", "event_espresso");
722
+		}
723
+	}
724
+
725
+
726
+
727
+	/**
728
+	 * column_TXN_paid
729
+	 *
730
+	 * @access public
731
+	 * @param \EE_Registration $item
732
+	 * @return string
733
+	 * @throws \EE_Error
734
+	 */
735
+	public function column_TXN_paid(EE_Registration $item)
736
+	{
737
+		if ($item->count() === 1) {
738
+			$transaction = $item->transaction() ? $item->transaction() : EE_Transaction::new_instance();
739
+			if ($transaction->paid() >= $transaction->total()) {
740
+				return '<span class="reg-pad-rght"><div class="dashicons dashicons-yes green-icon"></div></span>';
741
+			} else {
742
+				$view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
743
+					'action' => 'view_transaction',
744
+					'TXN_ID' => $item->transaction_ID(),
745
+				), TXN_ADMIN_URL);
746
+				return EE_Registry::instance()->CAP->current_user_can('ee_read_transaction',
747
+					'espresso_transactions_view_transaction', $item->transaction_ID())
748
+					? '<span class="reg-pad-rght"><a class="status-'
749
+					  . $transaction->status_ID()
750
+					  . '" href="'
751
+					  . $view_txn_lnk_url
752
+					  . '"  title="'
753
+					  . esc_attr__('View Transaction', 'event_espresso')
754
+					  . '">'
755
+					  . $item->transaction()->pretty_paid()
756
+					  . '</a><span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_paid() . '</span>';
757
+			}
758
+		}
759
+		return '&nbsp;';
760
+	}
761
+
762
+
763
+
764
+	/**
765
+	 * column_actions
766
+	 *
767
+	 * @access public
768
+	 * @param \EE_Registration $item
769
+	 * @return string
770
+	 * @throws \EE_Error
771
+	 */
772
+	public function column_actions(EE_Registration $item)
773
+	{
774
+		$actions = array();
775
+		$attendee = $item->attendee();
776
+		$this->_set_related_details($item);
777
+		//Build row actions
778
+		$view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
779
+			'action'  => 'view_registration',
780
+			'_REG_ID' => $item->ID(),
781
+		), REG_ADMIN_URL);
782
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
783
+			'action' => 'edit_attendee',
784
+			'post'   => $item->attendee_ID(),
785
+		), REG_ADMIN_URL);
786
+		// page=attendees&event_admin_reports=resend_email&registration_id=43653465634&event_id=2&form_action=resend_email
787
+		//$resend_reg_lnk_url_params = array( 'action'=>'resend_registration', '_REG_ID'=>$item->REG_ID );
788
+		$resend_reg_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
789
+			'action'  => 'resend_registration',
790
+			'_REG_ID' => $item->ID(),
791
+		), REG_ADMIN_URL, true);
792
+		//Build row actions
793
+		$actions['view_lnk'] = EE_Registry::instance()->CAP->current_user_can('ee_read_registration',
794
+			'espresso_registrations_view_registration', $item->ID()) ? '
795 795
 			<li>
796 796
 			<a href="' . $view_lnk_url . '" title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text">
797 797
 				<div class="dashicons dashicons-clipboard"></div>
798 798
 			</a>
799 799
 			</li>' : '';
800
-        $actions['edit_lnk'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_contacts',
801
-            'espresso_registrations_edit_attendee')
802
-                               && $attendee instanceof EE_Attendee ? '
800
+		$actions['edit_lnk'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_contacts',
801
+			'espresso_registrations_edit_attendee')
802
+							   && $attendee instanceof EE_Attendee ? '
803 803
 			<li>
804 804
 			<a href="' . $edit_lnk_url . '" title="' . esc_attr__('Edit Contact Details', 'event_espresso') . '" class="tiny-text">
805 805
 				<div class="ee-icon ee-icon-user-edit ee-icon-size-16"></div>
806 806
 			</a>
807 807
 			</li>' : '';
808
-        $actions['resend_reg_lnk'] = $attendee instanceof EE_Attendee
809
-                                     && EE_Registry::instance()->CAP->current_user_can('ee_send_message',
810
-            'espresso_registrations_resend_registration', $item->ID()) ? '
808
+		$actions['resend_reg_lnk'] = $attendee instanceof EE_Attendee
809
+									 && EE_Registry::instance()->CAP->current_user_can('ee_send_message',
810
+			'espresso_registrations_resend_registration', $item->ID()) ? '
811 811
 			<li>
812 812
 			<a href="'
813
-                                                                         . $resend_reg_lnk_url
814
-                                                                         . '" title="'
815
-                                                                         . esc_attr__('Resend Registration Details',
816
-                'event_espresso')
817
-                                                                         . '" class="tiny-text">
813
+																		 . $resend_reg_lnk_url
814
+																		 . '" title="'
815
+																		 . esc_attr__('Resend Registration Details',
816
+				'event_espresso')
817
+																		 . '" class="tiny-text">
818 818
 				<div class="dashicons dashicons-email-alt"></div>
819 819
 			</a>
820 820
 			</li>' : '';
821
-        // page=transactions&action=view_transaction&txn=256&_wpnonce=6414da4dbb
822
-        $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
823
-            'action' => 'view_transaction',
824
-            'TXN_ID' => $this->_transaction_details['id'],
825
-        ), TXN_ADMIN_URL);
826
-        $actions['view_txn_lnk'] = EE_Registry::instance()->CAP->current_user_can('ee_read_transaction',
827
-            'espresso_transactions_view_transaction', $this->_transaction_details['id']) ? '
821
+		// page=transactions&action=view_transaction&txn=256&_wpnonce=6414da4dbb
822
+		$view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
823
+			'action' => 'view_transaction',
824
+			'TXN_ID' => $this->_transaction_details['id'],
825
+		), TXN_ADMIN_URL);
826
+		$actions['view_txn_lnk'] = EE_Registry::instance()->CAP->current_user_can('ee_read_transaction',
827
+			'espresso_transactions_view_transaction', $this->_transaction_details['id']) ? '
828 828
 			<li>
829 829
 			<a class="ee-status-color-'
830
-                                                                                           . $this->_transaction_details['status']
831
-                                                                                           . ' tiny-text" href="'
832
-                                                                                           . $view_txn_lnk_url
833
-                                                                                           . '"  title="'
834
-                                                                                           . $this->_transaction_details['title_attr']
835
-                                                                                           . '">
830
+																						   . $this->_transaction_details['status']
831
+																						   . ' tiny-text" href="'
832
+																						   . $view_txn_lnk_url
833
+																						   . '"  title="'
834
+																						   . $this->_transaction_details['title_attr']
835
+																						   . '">
836 836
 				<div class="dashicons dashicons-cart"></div>
837 837
 			</a>
838 838
 			</li>' : '';
839
-        //invoice link
840
-        $actions['dl_invoice_lnk'] = '';
841
-        $dl_invoice_lnk_url = $item->invoice_url();
842
-        //only show invoice link if message type is active.
843
-        if ($attendee instanceof EE_Attendee
844
-            && $item->is_primary_registrant()
845
-            && EEH_MSG_Template::is_mt_active('invoice')
846
-        ) {
847
-            $actions['dl_invoice_lnk'] = '
839
+		//invoice link
840
+		$actions['dl_invoice_lnk'] = '';
841
+		$dl_invoice_lnk_url = $item->invoice_url();
842
+		//only show invoice link if message type is active.
843
+		if ($attendee instanceof EE_Attendee
844
+			&& $item->is_primary_registrant()
845
+			&& EEH_MSG_Template::is_mt_active('invoice')
846
+		) {
847
+			$actions['dl_invoice_lnk'] = '
848 848
 		<li>
849 849
 			<a title="'
850
-                                         . esc_attr__('View Transaction Invoice', 'event_espresso')
851
-                                         . '" target="_blank" href="'
852
-                                         . $dl_invoice_lnk_url
853
-                                         . '" class="tiny-text">
850
+										 . esc_attr__('View Transaction Invoice', 'event_espresso')
851
+										 . '" target="_blank" href="'
852
+										 . $dl_invoice_lnk_url
853
+										 . '" class="tiny-text">
854 854
 				<span class="dashicons dashicons-media-spreadsheet ee-icon-size-18"></span>
855 855
 			</a>
856 856
 		</li>';
857
-        }
858
-        $actions['filtered_messages_link'] = '';
859
-        //message list table link (filtered by REG_ID
860
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
861
-            $actions['filtered_messages_link'] = '<li>'
862
-                                                 . EEH_MSG_Template::get_message_action_link('see_notifications_for',
863
-                    null, array(
864
-                        '_REG_ID' => $item->ID(),
865
-                    ))
866
-                                                 . '</li>';
867
-        }
868
-        $actions = apply_filters('FHEE__EE_Registrations_List_Table__column_actions__actions', $actions, $item, $this);
869
-        return $this->_action_string(implode('', $actions), $item, 'ul', 'reg-overview-actions-ul');
870
-    }
857
+		}
858
+		$actions['filtered_messages_link'] = '';
859
+		//message list table link (filtered by REG_ID
860
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
861
+			$actions['filtered_messages_link'] = '<li>'
862
+												 . EEH_MSG_Template::get_message_action_link('see_notifications_for',
863
+					null, array(
864
+						'_REG_ID' => $item->ID(),
865
+					))
866
+												 . '</li>';
867
+		}
868
+		$actions = apply_filters('FHEE__EE_Registrations_List_Table__column_actions__actions', $actions, $item, $this);
869
+		return $this->_action_string(implode('', $actions), $item, 'ul', 'reg-overview-actions-ul');
870
+	}
871 871
 
872 872
 }
Please login to merge, or discard this patch.
core/db_models/EEM_Base.model.php 3 patches
Doc Comments   +16 added lines, -14 removed lines patch added patch discarded remove patch
@@ -860,7 +860,7 @@  discard block
 block discarded – undo
860 860
      *  on this model (or follows the _model_chain_to_wp_user and uses that model's
861 861
      * foreign key to the WP_User table)
862 862
      *
863
-     * @return string|boolean string on success, boolean false when there is no
863
+     * @return string|false string on success, boolean false when there is no
864 864
      * foreign key to the WP_User table
865 865
      */
866 866
     public function wp_user_field_name()
@@ -966,7 +966,7 @@  discard block
 block discarded – undo
966 966
      *
967 967
      * @param array  $query_params      like EEM_Base::get_all's $query_params
968 968
      * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
969
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
969
+     * @param string  $columns_to_select , What columns to select. By default, we select all columns specified by the
970 970
      *                                  fields on the model, and the models we joined to in the query. However, you can
971 971
      *                                  override this and set the select to "*", or a specific column name, like
972 972
      *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
@@ -1358,7 +1358,7 @@  discard block
 block discarded – undo
1358 1358
      * @param string $field_name The name of the field the formats are being retrieved for.
1359 1359
      * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1360 1360
      * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1361
-     * @return array formats in an array with the date format first, and the time format last.
1361
+     * @return string[] formats in an array with the date format first, and the time format last.
1362 1362
      */
1363 1363
     public function get_formats_for($field_name, $pretty = false)
1364 1364
     {
@@ -1391,7 +1391,7 @@  discard block
 block discarded – undo
1391 1391
      *                                 be returned.
1392 1392
      * @param string $what             Whether to return the string in just the time format, the date format, or both.
1393 1393
      * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1394
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1394
+     * @return string|null  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1395 1395
      *                                 exception is triggered.
1396 1396
      */
1397 1397
     public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
@@ -1723,7 +1723,7 @@  discard block
 block discarded – undo
1723 1723
      * Wrapper for EEM_Base::delete_permanently()
1724 1724
      *
1725 1725
      * @param mixed $id
1726
-     * @return boolean whether the row got deleted or not
1726
+     * @return integer whether the row got deleted or not
1727 1727
      * @throws \EE_Error
1728 1728
      */
1729 1729
     public function delete_permanently_by_ID($id)
@@ -1743,7 +1743,7 @@  discard block
 block discarded – undo
1743 1743
      * Wrapper for EEM_Base::delete()
1744 1744
      *
1745 1745
      * @param mixed $id
1746
-     * @return boolean whether the row got deleted or not
1746
+     * @return integer whether the row got deleted or not
1747 1747
      * @throws \EE_Error
1748 1748
      */
1749 1749
     public function delete_by_ID($id)
@@ -2193,7 +2193,7 @@  discard block
 block discarded – undo
2193 2193
      * Verifies the EE addons' database is up-to-date and records that we've done it on
2194 2194
      * EEM_Base::$_db_verification_level
2195 2195
      *
2196
-     * @param $wpdb_method
2196
+     * @param string $wpdb_method
2197 2197
      * @param $arguments_to_provide
2198 2198
      * @return string
2199 2199
      */
@@ -2317,6 +2317,7 @@  discard block
 block discarded – undo
2317 2317
      *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2318 2318
      *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2319 2319
      *                             because these will be inserted in any new rows created as well.
2320
+     * @param EE_Base_Class $id_or_obj
2320 2321
      */
2321 2322
     public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2322 2323
     {
@@ -2327,7 +2328,7 @@  discard block
 block discarded – undo
2327 2328
 
2328 2329
 
2329 2330
     /**
2330
-     * @param mixed           $id_or_obj
2331
+     * @param EE_Base_Class           $id_or_obj
2331 2332
      * @param string          $relationName
2332 2333
      * @param array           $where_query_params
2333 2334
      * @param EE_Base_Class[] objects to which relations were removed
@@ -2368,7 +2369,7 @@  discard block
 block discarded – undo
2368 2369
      * However, if the model objects can't be deleted because of blocking related model objects, then
2369 2370
      * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2370 2371
      *
2371
-     * @param EE_Base_Class|int|string $id_or_obj
2372
+     * @param EE_Base_Class $id_or_obj
2372 2373
      * @param string                   $model_name
2373 2374
      * @param array                    $query_params
2374 2375
      * @return int how many deleted
@@ -2389,7 +2390,7 @@  discard block
 block discarded – undo
2389 2390
      * the model objects can't be hard deleted because of blocking related model objects,
2390 2391
      * just does a soft-delete on them instead.
2391 2392
      *
2392
-     * @param EE_Base_Class|int|string $id_or_obj
2393
+     * @param EE_Base_Class $id_or_obj
2393 2394
      * @param string                   $model_name
2394 2395
      * @param array                    $query_params
2395 2396
      * @return int how many deleted
@@ -2446,6 +2447,7 @@  discard block
 block discarded – undo
2446 2447
      * @param string $model_name   like 'Event', or 'Registration'
2447 2448
      * @param array  $query_params like EEM_Base::get_all's
2448 2449
      * @param string $field_to_sum name of field to count by. By default, uses primary key
2450
+     * @param EE_Base_Class $id_or_obj
2449 2451
      * @return float
2450 2452
      * @throws \EE_Error
2451 2453
      */
@@ -2909,7 +2911,7 @@  discard block
 block discarded – undo
2909 2911
      * Finds all the fields that correspond to the given table
2910 2912
      *
2911 2913
      * @param string $table_alias , array key in EEM_Base::_tables
2912
-     * @return EE_Model_Field_Base[]
2914
+     * @return EE_Model_Field_Base
2913 2915
      */
2914 2916
     public function _get_fields_for_table($table_alias)
2915 2917
     {
@@ -4354,7 +4356,7 @@  discard block
 block discarded – undo
4354 4356
      * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4355 4357
      * Eg, on EE_Answer that would be ANS_ID field object
4356 4358
      *
4357
-     * @param $field_obj
4359
+     * @param EE_Model_Field_Base $field_obj
4358 4360
      * @return boolean
4359 4361
      */
4360 4362
     public function is_primary_key_field($field_obj)
@@ -4465,7 +4467,7 @@  discard block
 block discarded – undo
4465 4467
      * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4466 4468
      *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4467 4469
      *                            Either one works
4468
-     * @return EE_Table_Base
4470
+     * @return string
4469 4471
      */
4470 4472
     public function get_table_for_alias($table_alias)
4471 4473
     {
@@ -5075,7 +5077,7 @@  discard block
 block discarded – undo
5075 5077
     /**
5076 5078
      * Read comments for assume_values_already_prepared_by_model_object()
5077 5079
      *
5078
-     * @return int
5080
+     * @return boolean
5079 5081
      */
5080 5082
     public function get_assumption_concerning_values_already_prepared_by_model_object()
5081 5083
     {
Please login to merge, or discard this patch.
Indentation   +5511 added lines, -5511 removed lines patch added patch discarded remove patch
@@ -29,5526 +29,5526 @@
 block discarded – undo
29 29
 abstract class EEM_Base extends EE_Base
30 30
 {
31 31
 
32
-    //admin posty
33
-    //basic -> grants access to mine -> if they don't have it, select none
34
-    //*_others -> grants access to others that arent private, and all mine -> if they don't have it, select mine
35
-    //*_private -> grants full access -> if dont have it, select all mine and others' non-private
36
-    //*_published -> grants access to published -> if they dont have it, select non-published
37
-    //*_global/default/system -> grants access to global items -> if they don't have it, select non-global
38
-    //publish_{thing} -> can change status TO publish; SPECIAL CASE
39
-    //frontend posty
40
-    //by default has access to published
41
-    //basic -> grants access to mine that arent published, and all published
42
-    //*_others ->grants access to others that arent private, all mine
43
-    //*_private -> grants full access
44
-    //frontend non-posty
45
-    //like admin posty
46
-    //category-y
47
-    //assign -> grants access to join-table
48
-    //(delete, edit)
49
-    //payment-method-y
50
-    //for each registered payment method,
51
-    //ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
52
-    /**
53
-     * Flag to indicate whether the values provided to EEM_Base have already been prepared
54
-     * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
55
-     * They almost always WILL NOT, but it's not necessarily a requirement.
56
-     * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
57
-     *
58
-     * @var boolean
59
-     */
60
-    private $_values_already_prepared_by_model_object = 0;
61
-
62
-    /**
63
-     * when $_values_already_prepared_by_model_object equals this, we assume
64
-     * the data is just like form input that needs to have the model fields'
65
-     * prepare_for_set and prepare_for_use_in_db called on it
66
-     */
67
-    const not_prepared_by_model_object = 0;
68
-
69
-    /**
70
-     * when $_values_already_prepared_by_model_object equals this, we
71
-     * assume this value is coming from a model object and doesn't need to have
72
-     * prepare_for_set called on it, just prepare_for_use_in_db is used
73
-     */
74
-    const prepared_by_model_object = 1;
75
-
76
-    /**
77
-     * when $_values_already_prepared_by_model_object equals this, we assume
78
-     * the values are already to be used in the database (ie no processing is done
79
-     * on them by the model's fields)
80
-     */
81
-    const prepared_for_use_in_db = 2;
82
-
83
-
84
-    protected $singular_item = 'Item';
85
-
86
-    protected $plural_item   = 'Items';
87
-
88
-    /**
89
-     * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
90
-     */
91
-    protected $_tables;
92
-
93
-    /**
94
-     * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
95
-     * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
96
-     * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
97
-     *
98
-     * @var \EE_Model_Field_Base[] $_fields
99
-     */
100
-    protected $_fields;
101
-
102
-    /**
103
-     * array of different kinds of relations
104
-     *
105
-     * @var \EE_Model_Relation_Base[] $_model_relations
106
-     */
107
-    protected $_model_relations;
108
-
109
-    /**
110
-     * @var \EE_Index[] $_indexes
111
-     */
112
-    protected $_indexes = array();
113
-
114
-    /**
115
-     * Default strategy for getting where conditions on this model. This strategy is used to get default
116
-     * where conditions which are added to get_all, update, and delete queries. They can be overridden
117
-     * by setting the same columns as used in these queries in the query yourself.
118
-     *
119
-     * @var EE_Default_Where_Conditions
120
-     */
121
-    protected $_default_where_conditions_strategy;
122
-
123
-    /**
124
-     * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
125
-     * This is particularly useful when you want something between 'none' and 'default'
126
-     *
127
-     * @var EE_Default_Where_Conditions
128
-     */
129
-    protected $_minimum_where_conditions_strategy;
130
-
131
-    /**
132
-     * String describing how to find the "owner" of this model's objects.
133
-     * When there is a foreign key on this model to the wp_users table, this isn't needed.
134
-     * But when there isn't, this indicates which related model, or transiently-related model,
135
-     * has the foreign key to the wp_users table.
136
-     * Eg, for EEM_Registration this would be 'Event' because registrations are directly
137
-     * related to events, and events have a foreign key to wp_users.
138
-     * On EEM_Transaction, this would be 'Transaction.Event'
139
-     *
140
-     * @var string
141
-     */
142
-    protected $_model_chain_to_wp_user = '';
143
-
144
-    /**
145
-     * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
146
-     * don't need it (particularly CPT models)
147
-     *
148
-     * @var bool
149
-     */
150
-    protected $_ignore_where_strategy = false;
151
-
152
-    /**
153
-     * String used in caps relating to this model. Eg, if the caps relating to this
154
-     * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
155
-     *
156
-     * @var string. If null it hasn't been initialized yet. If false then we
157
-     * have indicated capabilities don't apply to this
158
-     */
159
-    protected $_caps_slug = null;
160
-
161
-    /**
162
-     * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
163
-     * and next-level keys are capability names, and each's value is a
164
-     * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
165
-     * they specify which context to use (ie, frontend, backend, edit or delete)
166
-     * and then each capability in the corresponding sub-array that they're missing
167
-     * adds the where conditions onto the query.
168
-     *
169
-     * @var array
170
-     */
171
-    protected $_cap_restrictions = array(
172
-        self::caps_read       => array(),
173
-        self::caps_read_admin => array(),
174
-        self::caps_edit       => array(),
175
-        self::caps_delete     => array(),
176
-    );
177
-
178
-    /**
179
-     * Array defining which cap restriction generators to use to create default
180
-     * cap restrictions to put in EEM_Base::_cap_restrictions.
181
-     * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
182
-     * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
183
-     * automatically set this to false (not just null).
184
-     *
185
-     * @var EE_Restriction_Generator_Base[]
186
-     */
187
-    protected $_cap_restriction_generators = array();
188
-
189
-    /**
190
-     * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
191
-     */
192
-    const caps_read       = 'read';
193
-
194
-    const caps_read_admin = 'read_admin';
195
-
196
-    const caps_edit       = 'edit';
197
-
198
-    const caps_delete     = 'delete';
199
-
200
-    /**
201
-     * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
202
-     * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
203
-     * maps to 'read' because when looking for relevant permissions we're going to use
204
-     * 'read' in teh capabilities names like 'ee_read_events' etc.
205
-     *
206
-     * @var array
207
-     */
208
-    protected $_cap_contexts_to_cap_action_map = array(
209
-        self::caps_read       => 'read',
210
-        self::caps_read_admin => 'read',
211
-        self::caps_edit       => 'edit',
212
-        self::caps_delete     => 'delete',
213
-    );
214
-
215
-    /**
216
-     * Timezone
217
-     * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
218
-     * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
219
-     * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
220
-     * EE_Datetime_Field data type will have access to it.
221
-     *
222
-     * @var string
223
-     */
224
-    protected $_timezone;
225
-
226
-
227
-    /**
228
-     * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
229
-     * multisite.
230
-     *
231
-     * @var int
232
-     */
233
-    protected static $_model_query_blog_id;
234
-
235
-    /**
236
-     * A copy of _fields, except the array keys are the model names pointed to by
237
-     * the field
238
-     *
239
-     * @var EE_Model_Field_Base[]
240
-     */
241
-    private $_cache_foreign_key_to_fields = array();
242
-
243
-    /**
244
-     * Cached list of all the fields on the model, indexed by their name
245
-     *
246
-     * @var EE_Model_Field_Base[]
247
-     */
248
-    private $_cached_fields = null;
249
-
250
-    /**
251
-     * Cached list of all the fields on the model, except those that are
252
-     * marked as only pertinent to the database
253
-     *
254
-     * @var EE_Model_Field_Base[]
255
-     */
256
-    private $_cached_fields_non_db_only = null;
257
-
258
-    /**
259
-     * A cached reference to the primary key for quick lookup
260
-     *
261
-     * @var EE_Model_Field_Base
262
-     */
263
-    private $_primary_key_field = null;
264
-
265
-    /**
266
-     * Flag indicating whether this model has a primary key or not
267
-     *
268
-     * @var boolean
269
-     */
270
-    protected $_has_primary_key_field = null;
271
-
272
-    /**
273
-     * Whether or not this model is based off a table in WP core only (CPTs should set
274
-     * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
275
-     *
276
-     * @var boolean
277
-     */
278
-    protected $_wp_core_model = false;
279
-
280
-    /**
281
-     *    List of valid operators that can be used for querying.
282
-     * The keys are all operators we'll accept, the values are the real SQL
283
-     * operators used
284
-     *
285
-     * @var array
286
-     */
287
-    protected $_valid_operators = array(
288
-        '='           => '=',
289
-        '<='          => '<=',
290
-        '<'           => '<',
291
-        '>='          => '>=',
292
-        '>'           => '>',
293
-        '!='          => '!=',
294
-        'LIKE'        => 'LIKE',
295
-        'like'        => 'LIKE',
296
-        'NOT_LIKE'    => 'NOT LIKE',
297
-        'not_like'    => 'NOT LIKE',
298
-        'NOT LIKE'    => 'NOT LIKE',
299
-        'not like'    => 'NOT LIKE',
300
-        'IN'          => 'IN',
301
-        'in'          => 'IN',
302
-        'NOT_IN'      => 'NOT IN',
303
-        'not_in'      => 'NOT IN',
304
-        'NOT IN'      => 'NOT IN',
305
-        'not in'      => 'NOT IN',
306
-        'between'     => 'BETWEEN',
307
-        'BETWEEN'     => 'BETWEEN',
308
-        'IS_NOT_NULL' => 'IS NOT NULL',
309
-        'is_not_null' => 'IS NOT NULL',
310
-        'IS NOT NULL' => 'IS NOT NULL',
311
-        'is not null' => 'IS NOT NULL',
312
-        'IS_NULL'     => 'IS NULL',
313
-        'is_null'     => 'IS NULL',
314
-        'IS NULL'     => 'IS NULL',
315
-        'is null'     => 'IS NULL',
316
-        'REGEXP'      => 'REGEXP',
317
-        'regexp'      => 'REGEXP',
318
-        'NOT_REGEXP'  => 'NOT REGEXP',
319
-        'not_regexp'  => 'NOT REGEXP',
320
-        'NOT REGEXP'  => 'NOT REGEXP',
321
-        'not regexp'  => 'NOT REGEXP',
322
-    );
323
-
324
-    /**
325
-     * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
326
-     *
327
-     * @var array
328
-     */
329
-    protected $_in_style_operators = array('IN', 'NOT IN');
330
-
331
-    /**
332
-     * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
333
-     * '12-31-2012'"
334
-     *
335
-     * @var array
336
-     */
337
-    protected $_between_style_operators = array('BETWEEN');
338
-
339
-    /**
340
-     * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
341
-     * on a join table.
342
-     *
343
-     * @var array
344
-     */
345
-    protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
346
-
347
-    /**
348
-     * Allowed values for $query_params['order'] for ordering in queries
349
-     *
350
-     * @var array
351
-     */
352
-    protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
353
-
354
-    /**
355
-     * When these are keys in a WHERE or HAVING clause, they are handled much differently
356
-     * than regular field names. It is assumed that their values are an array of WHERE conditions
357
-     *
358
-     * @var array
359
-     */
360
-    private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
361
-
362
-    /**
363
-     * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
364
-     * 'where', but 'where' clauses are so common that we thought we'd omit it
365
-     *
366
-     * @var array
367
-     */
368
-    private $_allowed_query_params = array(
369
-        0,
370
-        'limit',
371
-        'order_by',
372
-        'group_by',
373
-        'having',
374
-        'force_join',
375
-        'order',
376
-        'on_join_limit',
377
-        'default_where_conditions',
378
-        'caps',
379
-    );
380
-
381
-    /**
382
-     * All the data types that can be used in $wpdb->prepare statements.
383
-     *
384
-     * @var array
385
-     */
386
-    private $_valid_wpdb_data_types = array('%d', '%s', '%f');
387
-
388
-    /**
389
-     *    EE_Registry Object
390
-     *
391
-     * @var    object
392
-     * @access    protected
393
-     */
394
-    protected $EE = null;
395
-
396
-
397
-    /**
398
-     * Property which, when set, will have this model echo out the next X queries to the page for debugging.
399
-     *
400
-     * @var int
401
-     */
402
-    protected $_show_next_x_db_queries = 0;
403
-
404
-    /**
405
-     * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
406
-     * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
407
-     *
408
-     * @var array
409
-     */
410
-    protected $_custom_selections = array();
411
-
412
-    /**
413
-     * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
414
-     * caches every model object we've fetched from the DB on this request
415
-     *
416
-     * @var array
417
-     */
418
-    protected $_entity_map;
419
-
420
-    /**
421
-     * constant used to show EEM_Base has not yet verified the db on this http request
422
-     */
423
-    const db_verified_none = 0;
424
-
425
-    /**
426
-     * constant used to show EEM_Base has verified the EE core db on this http request,
427
-     * but not the addons' dbs
428
-     */
429
-    const db_verified_core = 1;
430
-
431
-    /**
432
-     * constant used to show EEM_Base has verified the addons' dbs (and implicitly
433
-     * the EE core db too)
434
-     */
435
-    const db_verified_addons = 2;
436
-
437
-    /**
438
-     * indicates whether an EEM_Base child has already re-verified the DB
439
-     * is ok (we don't want to do it repetitively). Should be set to one the constants
440
-     * looking like EEM_Base::db_verified_*
441
-     *
442
-     * @var int - 0 = none, 1 = core, 2 = addons
443
-     */
444
-    protected static $_db_verification_level = EEM_Base::db_verified_none;
445
-
446
-
447
-
448
-    /**
449
-     * About all child constructors:
450
-     * they should define the _tables, _fields and _model_relations arrays.
451
-     * Should ALWAYS be called after child constructor.
452
-     * In order to make the child constructors to be as simple as possible, this parent constructor
453
-     * finalizes constructing all the object's attributes.
454
-     * Generally, rather than requiring a child to code
455
-     * $this->_tables = array(
456
-     *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
457
-     *        ...);
458
-     *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
459
-     * each EE_Table has a function to set the table's alias after the constructor, using
460
-     * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
461
-     * do something similar.
462
-     *
463
-     * @param null $timezone
464
-     * @throws \EE_Error
465
-     */
466
-    protected function __construct($timezone = null)
467
-    {
468
-        // check that the model has not been loaded too soon
469
-        if ( ! did_action('AHEE__EE_System__load_espresso_addons')) {
470
-            throw new EE_Error (
471
-                sprintf(
472
-                    __('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.',
473
-                        'event_espresso'),
474
-                    get_class($this)
475
-                )
476
-            );
477
-        }
478
-        /**
479
-         * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
480
-         */
481
-        if (empty(EEM_Base::$_model_query_blog_id)) {
482
-            EEM_Base::set_model_query_blog_id();
483
-        }
484
-        /**
485
-         * Filters the list of tables on a model. It is best to NOT use this directly and instead
486
-         * just use EE_Register_Model_Extension
487
-         *
488
-         * @var EE_Table_Base[] $_tables
489
-         */
490
-        $this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
491
-        foreach ($this->_tables as $table_alias => $table_obj) {
492
-            /** @var $table_obj EE_Table_Base */
493
-            $table_obj->_construct_finalize_with_alias($table_alias);
494
-            if ($table_obj instanceof EE_Secondary_Table) {
495
-                /** @var $table_obj EE_Secondary_Table */
496
-                $table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
497
-            }
498
-        }
499
-        /**
500
-         * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
501
-         * EE_Register_Model_Extension
502
-         *
503
-         * @param EE_Model_Field_Base[] $_fields
504
-         */
505
-        $this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
506
-        $this->_invalidate_field_caches();
507
-        foreach ($this->_fields as $table_alias => $fields_for_table) {
508
-            if ( ! array_key_exists($table_alias, $this->_tables)) {
509
-                throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
510
-                    'event_espresso'), $table_alias, implode(",", $this->_fields)));
511
-            }
512
-            foreach ($fields_for_table as $field_name => $field_obj) {
513
-                /** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
514
-                //primary key field base has a slightly different _construct_finalize
515
-                /** @var $field_obj EE_Model_Field_Base */
516
-                $field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
517
-            }
518
-        }
519
-        // everything is related to Extra_Meta
520
-        if (get_class($this) !== 'EEM_Extra_Meta') {
521
-            //make extra meta related to everything, but don't block deleting things just
522
-            //because they have related extra meta info. For now just orphan those extra meta
523
-            //in the future we should automatically delete them
524
-            $this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
525
-        }
526
-        //and change logs
527
-        if (get_class($this) !== 'EEM_Change_Log') {
528
-            $this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
529
-        }
530
-        /**
531
-         * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
532
-         * EE_Register_Model_Extension
533
-         *
534
-         * @param EE_Model_Relation_Base[] $_model_relations
535
-         */
536
-        $this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
537
-            $this->_model_relations);
538
-        foreach ($this->_model_relations as $model_name => $relation_obj) {
539
-            /** @var $relation_obj EE_Model_Relation_Base */
540
-            $relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
541
-        }
542
-        foreach ($this->_indexes as $index_name => $index_obj) {
543
-            /** @var $index_obj EE_Index */
544
-            $index_obj->_construct_finalize($index_name, $this->get_this_model_name());
545
-        }
546
-        $this->set_timezone($timezone);
547
-        //finalize default where condition strategy, or set default
548
-        if ( ! $this->_default_where_conditions_strategy) {
549
-            //nothing was set during child constructor, so set default
550
-            $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
551
-        }
552
-        $this->_default_where_conditions_strategy->_finalize_construct($this);
553
-        if ( ! $this->_minimum_where_conditions_strategy) {
554
-            //nothing was set during child constructor, so set default
555
-            $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
556
-        }
557
-        $this->_minimum_where_conditions_strategy->_finalize_construct($this);
558
-        //if the cap slug hasn't been set, and we haven't set it to false on purpose
559
-        //to indicate to NOT set it, set it to the logical default
560
-        if ($this->_caps_slug === null) {
561
-            $this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
562
-        }
563
-        //initialize the standard cap restriction generators if none were specified by the child constructor
564
-        if ($this->_cap_restriction_generators !== false) {
565
-            foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
566
-                if ( ! isset($this->_cap_restriction_generators[$cap_context])) {
567
-                    $this->_cap_restriction_generators[$cap_context] = apply_filters(
568
-                        'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
569
-                        new EE_Restriction_Generator_Protected(),
570
-                        $cap_context,
571
-                        $this
572
-                    );
573
-                }
574
-            }
575
-        }
576
-        //if there are cap restriction generators, use them to make the default cap restrictions
577
-        if ($this->_cap_restriction_generators !== false) {
578
-            foreach ($this->_cap_restriction_generators as $context => $generator_object) {
579
-                if ( ! $generator_object) {
580
-                    continue;
581
-                }
582
-                if ( ! $generator_object instanceof EE_Restriction_Generator_Base) {
583
-                    throw new EE_Error(
584
-                        sprintf(
585
-                            __('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.',
586
-                                'event_espresso'),
587
-                            $context,
588
-                            $this->get_this_model_name()
589
-                        )
590
-                    );
591
-                }
592
-                $action = $this->cap_action_for_context($context);
593
-                if ( ! $generator_object->construction_finalized()) {
594
-                    $generator_object->_construct_finalize($this, $action);
595
-                }
596
-            }
597
-        }
598
-        do_action('AHEE__' . get_class($this) . '__construct__end');
599
-    }
600
-
601
-
602
-
603
-    /**
604
-     * Generates the cap restrictions for the given context, or if they were
605
-     * already generated just gets what's cached
606
-     *
607
-     * @param string $context one of EEM_Base::valid_cap_contexts()
608
-     * @return EE_Default_Where_Conditions[]
609
-     */
610
-    protected function _generate_cap_restrictions($context)
611
-    {
612
-        if (isset($this->_cap_restriction_generators[$context])
613
-            && $this->_cap_restriction_generators[$context]
614
-               instanceof
615
-               EE_Restriction_Generator_Base
616
-        ) {
617
-            return $this->_cap_restriction_generators[$context]->generate_restrictions();
618
-        } else {
619
-            return array();
620
-        }
621
-    }
622
-
623
-
624
-
625
-    /**
626
-     * Used to set the $_model_query_blog_id static property.
627
-     *
628
-     * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
629
-     *                      value for get_current_blog_id() will be used.
630
-     */
631
-    public static function set_model_query_blog_id($blog_id = 0)
632
-    {
633
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
634
-    }
635
-
636
-
637
-
638
-    /**
639
-     * Returns whatever is set as the internal $model_query_blog_id.
640
-     *
641
-     * @return int
642
-     */
643
-    public static function get_model_query_blog_id()
644
-    {
645
-        return EEM_Base::$_model_query_blog_id;
646
-    }
647
-
648
-
649
-
650
-    /**
651
-     *        This function is a singleton method used to instantiate the Espresso_model object
652
-     *
653
-     * @access public
654
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
655
-     *                         incoming timezone data that gets saved).  Note this just sends the timezone info to the
656
-     *                         date time model field objects.  Default is NULL (and will be assumed using the set
657
-     *                         timezone in the 'timezone_string' wp option)
658
-     * @return static (as in the concrete child class)
659
-     */
660
-    public static function instance($timezone = null)
661
-    {
662
-        // check if instance of Espresso_model already exists
663
-        if ( ! static::$_instance instanceof static) {
664
-            // instantiate Espresso_model
665
-            static::$_instance = new static($timezone);
666
-        }
667
-        //we might have a timezone set, let set_timezone decide what to do with it
668
-        static::$_instance->set_timezone($timezone);
669
-        // Espresso_model object
670
-        return static::$_instance;
671
-    }
672
-
673
-
674
-
675
-    /**
676
-     * resets the model and returns it
677
-     *
678
-     * @param null | string $timezone
679
-     * @return EEM_Base|null (if the model was already instantiated, returns it, with
680
-     * all its properties reset; if it wasn't instantiated, returns null)
681
-     */
682
-    public static function reset($timezone = null)
683
-    {
684
-        if (static::$_instance instanceof EEM_Base) {
685
-            //let's try to NOT swap out the current instance for a new one
686
-            //because if someone has a reference to it, we can't remove their reference
687
-            //so it's best to keep using the same reference, but change the original object
688
-            //reset all its properties to their original values as defined in the class
689
-            $r = new ReflectionClass(get_class(static::$_instance));
690
-            $static_properties = $r->getStaticProperties();
691
-            foreach ($r->getDefaultProperties() as $property => $value) {
692
-                //don't set instance to null like it was originally,
693
-                //but it's static anyways, and we're ignoring static properties (for now at least)
694
-                if ( ! isset($static_properties[$property])) {
695
-                    static::$_instance->{$property} = $value;
696
-                }
697
-            }
698
-            //and then directly call its constructor again, like we would if we
699
-            //were creating a new one
700
-            static::$_instance->__construct($timezone);
701
-            return self::instance();
702
-        }
703
-        return null;
704
-    }
705
-
706
-
707
-
708
-    /**
709
-     * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
710
-     *
711
-     * @param  boolean $translated return localized strings or JUST the array.
712
-     * @return array
713
-     * @throws \EE_Error
714
-     */
715
-    public function status_array($translated = false)
716
-    {
717
-        if ( ! array_key_exists('Status', $this->_model_relations)) {
718
-            return array();
719
-        }
720
-        $model_name = $this->get_this_model_name();
721
-        $status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
722
-        $stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
723
-        $status_array = array();
724
-        foreach ($stati as $status) {
725
-            $status_array[$status->ID()] = $status->get('STS_code');
726
-        }
727
-        return $translated
728
-            ? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
729
-            : $status_array;
730
-    }
731
-
732
-
733
-
734
-    /**
735
-     * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
736
-     *
737
-     * @param array $query_params             {
738
-     * @var array $0 (where) array {
739
-     *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
740
-     *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
741
-     *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
742
-     *                                        conditions based on related models (and even
743
-     *                                        models-related-to-related-models) prepend the model's name onto the field
744
-     *                                        name. Eg,
745
-     *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
746
-     *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
747
-     *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
748
-     *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
749
-     *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE Venue_CPT.ID = 12 Notice that automatically took care of joining Events to Venues (even when each of those models actually consisted of two tables). Also, you may chain the model relations together. Eg instead of just having "Venue.VNU_ID", you could have
750
-     *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
751
-     *                                        events are related to Registrations, which are related to Attendees). You
752
-     *                                        can take it even further with
753
-     *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
754
-     *                                        (from the default of '='), change the value to an numerically-indexed
755
-     *                                        array, where the first item in the list is the operator. eg: array(
756
-     *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
757
-     *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
758
-     *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
759
-     *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
760
-     *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN (followed by an array with exactly 2 date strings), IS NULL, and IS NOT NULL Values can be a string, int, or float. They can also be arrays IFF the operator is IN. Also, values can actually be field names. To indicate the value is a field, simply provide a third array item (true) to the operator-value array like so: eg: array( 'DTT_reg_limit' => array('>', 'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold" Note: you can also use related model field names like you would any other field name. eg: array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could be used if you were querying EEM_Tickets (because Datetime is directly related to tickets) Also, by default all the where conditions are AND'd together. To override this, add an array key 'OR' (or 'AND') and the array to be OR'd together eg: array('OR'=>array('TXN_ID' => 23 , 'TXN_timestamp__>' => 345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp = 345678912...". Also, to negate an entire set of conditions, use 'NOT' as an array key. eg: array('NOT'=>array('TXN_total' => 50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND TXN_paid =23) Note: the 'glue' used to join each condition will continue to be what you last specified. IE, "AND"s by default, but if you had previously specified to use ORs to join, ORs will continue to be used. So, if you specify to use an "OR" to join conditions, it will continue to "stick" until you specify an AND. eg array('OR'=>array('NOT'=>array('TXN_total' => 50, 'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >> "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND STS_ID='TIN'" They can be nested indefinitely. eg: array('OR'=>array('TXN_total' => 23, 'NOT'=> array( 'TXN_timestamp'=> 345678912, 'AND'=>array('TXN_paid' => 53, 'STS_ID' => 'TIN')))) becomes SQL >> "...WHERE TXN_total = 23 OR ! (TXN_timestamp = 345678912 OR (TXN_paid = 53 AND STS_ID = 'TIN'))..." GOTCHA: because this is an array, array keys must be unique, making it impossible to place two or more where conditions applying to the same field. eg: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp'=>array('<',$end_date),'PAY_timestamp'=>array('!=',$special_date)), as PHP enforces that the array keys must be unique, thus removing the first two array entries with key 'PAY_timestamp'. becomes SQL >> "PAY_timestamp !=  4234232", ignoring the first two PAY_timestamp conditions). To overcome this, you can add a '*' character to the end of the field's name, followed by anything. These will be removed when generating the SQL string, but allow for the array keys to be unique. eg: you could rewrite the previous query as: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp*1st'=>array('<',$end_date),'PAY_timestamp*2nd'=>array('!=',$special_date)) which correctly becomes SQL >> "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND PAY_timestamp != 1241234123" This can be applied to condition operators too, eg: array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
761
-     * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
762
-     *      limits of "23", "25,50", and array(23,42) are all valid would become SQL "...LIMIT 23", "...LIMIT 25,50",
763
-     *      and "...LIMIT 23,42" respectively. Remember when you provide two numbers for the limit, the 1st number is
764
-     *      the OFFSET, the 2nd is the LIMIT
765
-     * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
766
-     *      can do paging on one-to-many multi-table-joins. Send an array in the following format array('on_join_limit'
767
-     *      => array( 'table_alias', array(1,2) ) ).
768
-     * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
769
-     *      values are either 'ASC' or 'DESC'. 'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
770
-     *      SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date DESC..." respectively. Like the
771
-     *      'where' conditions, these fields can be on related models. Eg
772
-     *      'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is perfectly valid from any model related
773
-     *      to 'Registration' (like Event, Attendee, Price, Datetime, etc.)
774
-     * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
775
-     *      'order' specifies whether to order the field specified in 'order_by' in ascending or descending order.
776
-     *      Acceptable values are 'ASC' or 'DESC'. If, 'order_by' isn't used, but 'order' is, then it is assumed you
777
-     *      want to order by the primary key. Eg,
778
-     *      EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC'); //(will join
779
-     *      with the Datetime model's table(s) and order by its field DTT_EVT_start) or
780
-     *      EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make SQL "SELECT * FROM
781
-     *      wp_esp_registration ORDER BY REG_ID ASC"
782
-     * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
783
-     *      'group_by'=>'VNU_ID', or 'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note: if no
784
-     *      $group_by is specified, and a limit is set, automatically groups by the model's primary key (or combined
785
-     *      primary keys). This avoids some weirdness that results when using limits, tons of joins, and no group by,
786
-     *      see https://events.codebasehq.com/projects/event-espresso/tickets/9389
787
-     * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
788
-     *      grouped results (whereas WHERE conditions apply to the pre-grouped results)
789
-     * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
790
-     *      array where values are models to be joined in the query.Eg array('Attendee','Payment','Datetime'). You may
791
-     *      join with transient models using period, eg "Registration.Transaction.Payment". You will probably only want
792
-     *      to do this in hopes of increasing efficiency, as related models which belongs to the current model
793
-     *                                        (ie, the current model has a foreign key to them, like how Registration
794
-     *                                        belongs to Attendee) can be cached in order to avoid future queries
795
-     * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
796
-     *      set this to 'none' to disable all default where conditions. Eg, usually soft-deleted objects are
797
-     *      filtered-out if you want to include them, set this query param to 'none'. If you want to ONLY disable THIS
798
-     *      model's default where conditions set it to 'other_models_only'. If you only want this model's default where
799
-     *      conditions added to the query, use 'this_model_only'. If you want to use all default where conditions
800
-     *      (default), set to 'all'.
801
-     * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
802
-     *      we just NOT apply any capabilities/permissions/restrictions and return everything? Or should we only show
803
-     *      the current user items they should be able to view on the frontend, backend, edit, or delete? can be set to
804
-     *      'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
805
-     *                                        }
806
-     * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
807
-     *                          from EE_Base_Class[], use _get_all_wpdb_results()and make it public again. Array keys
808
-     *                          are object IDs (if there is a primary key on the model. if not, numerically indexed)
809
-     *                          Some full examples: get 10 transactions which have Scottish attendees:
810
-     *                          EEM_Transaction::instance()->get_all( array( array(
811
-     *                                        'OR'=>array(
812
-     *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
813
-     *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
814
-     *                                        )
815
-     *                                        ),
816
-     *                                        'limit'=>10,
817
-     *                                        'group_by'=>'TXN_ID'
818
-     *                                        ));
819
-     *                                        get all the answers to the question titled "shirt size" for event with id
820
-     *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
821
-     *                                        'Question.QST_display_text'=>'shirt size',
822
-     *                                        'Registration.Event.EVT_ID'=>12
823
-     *                                        ),
824
-     *                                        'order_by'=>array('ANS_value'=>'ASC')
825
-     *                                        ));
826
-     * @throws \EE_Error
827
-     */
828
-    public function get_all($query_params = array())
829
-    {
830
-        if (isset($query_params['limit'])
831
-            && ! isset($query_params['group_by'])
832
-        ) {
833
-            $query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
834
-        }
835
-        return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
836
-    }
837
-
838
-
839
-
840
-    /**
841
-     * Modifies the query parameters so we only get back model objects
842
-     * that "belong" to the current user
843
-     *
844
-     * @param array $query_params @see EEM_Base::get_all()
845
-     * @return array like EEM_Base::get_all
846
-     */
847
-    public function alter_query_params_to_only_include_mine($query_params = array())
848
-    {
849
-        $wp_user_field_name = $this->wp_user_field_name();
850
-        if ($wp_user_field_name) {
851
-            $query_params[0][$wp_user_field_name] = get_current_user_id();
852
-        }
853
-        return $query_params;
854
-    }
855
-
856
-
857
-
858
-    /**
859
-     * Returns the name of the field's name that points to the WP_User table
860
-     *  on this model (or follows the _model_chain_to_wp_user and uses that model's
861
-     * foreign key to the WP_User table)
862
-     *
863
-     * @return string|boolean string on success, boolean false when there is no
864
-     * foreign key to the WP_User table
865
-     */
866
-    public function wp_user_field_name()
867
-    {
868
-        try {
869
-            if ( ! empty($this->_model_chain_to_wp_user)) {
870
-                $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
871
-                $last_model_name = end($models_to_follow_to_wp_users);
872
-                $model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
873
-                $model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
874
-            } else {
875
-                $model_with_fk_to_wp_users = $this;
876
-                $model_chain_to_wp_user = '';
877
-            }
878
-            $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
879
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
880
-        } catch (EE_Error $e) {
881
-            return false;
882
-        }
883
-    }
884
-
885
-
886
-
887
-    /**
888
-     * Returns the _model_chain_to_wp_user string, which indicates which related model
889
-     * (or transiently-related model) has a foreign key to the wp_users table;
890
-     * useful for finding if model objects of this type are 'owned' by the current user.
891
-     * This is an empty string when the foreign key is on this model and when it isn't,
892
-     * but is only non-empty when this model's ownership is indicated by a RELATED model
893
-     * (or transiently-related model)
894
-     *
895
-     * @return string
896
-     */
897
-    public function model_chain_to_wp_user()
898
-    {
899
-        return $this->_model_chain_to_wp_user;
900
-    }
901
-
902
-
903
-
904
-    /**
905
-     * Whether this model is 'owned' by a specific wordpress user (even indirectly,
906
-     * like how registrations don't have a foreign key to wp_users, but the
907
-     * events they are for are), or is unrelated to wp users.
908
-     * generally available
909
-     *
910
-     * @return boolean
911
-     */
912
-    public function is_owned()
913
-    {
914
-        if ($this->model_chain_to_wp_user()) {
915
-            return true;
916
-        } else {
917
-            try {
918
-                $this->get_foreign_key_to('WP_User');
919
-                return true;
920
-            } catch (EE_Error $e) {
921
-                return false;
922
-            }
923
-        }
924
-    }
925
-
926
-
927
-
928
-    /**
929
-     * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
930
-     * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
931
-     * the model)
932
-     *
933
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
934
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
935
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
936
-     *                                  fields on the model, and the models we joined to in the query. However, you can
937
-     *                                  override this and set the select to "*", or a specific column name, like
938
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
939
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
940
-     *                                  the aliases used to refer to this selection, and values are to be
941
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
942
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
943
-     * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
944
-     * @throws \EE_Error
945
-     */
946
-    protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
947
-    {
948
-        // remember the custom selections, if any, and type cast as array
949
-        // (unless $columns_to_select is an object, then just set as an empty array)
950
-        // Note: (array) 'some string' === array( 'some string' )
951
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
952
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
953
-        $select_expressions = $columns_to_select !== null
954
-            ? $this->_construct_select_from_input($columns_to_select)
955
-            : $this->_construct_default_select_sql($model_query_info);
956
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
957
-        return $this->_do_wpdb_query('get_results', array($SQL, $output));
958
-    }
959
-
960
-
961
-
962
-    /**
963
-     * Gets an array of rows from the database just like $wpdb->get_results would,
964
-     * but you can use the $query_params like on EEM_Base::get_all() to more easily
965
-     * take care of joins, field preparation etc.
966
-     *
967
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
968
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
969
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
970
-     *                                  fields on the model, and the models we joined to in the query. However, you can
971
-     *                                  override this and set the select to "*", or a specific column name, like
972
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
973
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
974
-     *                                  the aliases used to refer to this selection, and values are to be
975
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
976
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
977
-     * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
978
-     * @throws \EE_Error
979
-     */
980
-    public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
981
-    {
982
-        return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
983
-    }
984
-
985
-
986
-
987
-    /**
988
-     * For creating a custom select statement
989
-     *
990
-     * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
991
-     *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
992
-     *                                 SQL, and 1=>is the datatype
993
-     * @throws EE_Error
994
-     * @return string
995
-     */
996
-    private function _construct_select_from_input($columns_to_select)
997
-    {
998
-        if (is_array($columns_to_select)) {
999
-            $select_sql_array = array();
1000
-            foreach ($columns_to_select as $alias => $selection_and_datatype) {
1001
-                if ( ! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1002
-                    throw new EE_Error(
1003
-                        sprintf(
1004
-                            __(
1005
-                                "Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1006
-                                "event_espresso"
1007
-                            ),
1008
-                            $selection_and_datatype,
1009
-                            $alias
1010
-                        )
1011
-                    );
1012
-                }
1013
-                if ( ! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1014
-                    throw new EE_Error(
1015
-                        sprintf(
1016
-                            __(
1017
-                                "Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1018
-                                "event_espresso"
1019
-                            ),
1020
-                            $selection_and_datatype[1],
1021
-                            $selection_and_datatype[0],
1022
-                            $alias,
1023
-                            implode(",", $this->_valid_wpdb_data_types)
1024
-                        )
1025
-                    );
1026
-                }
1027
-                $select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1028
-            }
1029
-            $columns_to_select_string = implode(", ", $select_sql_array);
1030
-        } else {
1031
-            $columns_to_select_string = $columns_to_select;
1032
-        }
1033
-        return $columns_to_select_string;
1034
-    }
1035
-
1036
-
1037
-
1038
-    /**
1039
-     * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1040
-     *
1041
-     * @return string
1042
-     * @throws \EE_Error
1043
-     */
1044
-    public function primary_key_name()
1045
-    {
1046
-        return $this->get_primary_key_field()->get_name();
1047
-    }
1048
-
1049
-
1050
-
1051
-    /**
1052
-     * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1053
-     * If there is no primary key on this model, $id is treated as primary key string
1054
-     *
1055
-     * @param mixed $id int or string, depending on the type of the model's primary key
1056
-     * @return EE_Base_Class
1057
-     */
1058
-    public function get_one_by_ID($id)
1059
-    {
1060
-        if ($this->get_from_entity_map($id)) {
1061
-            return $this->get_from_entity_map($id);
1062
-        }
1063
-        return $this->get_one(
1064
-            $this->alter_query_params_to_restrict_by_ID(
1065
-                $id,
1066
-                array('default_where_conditions' => 'minimum')
1067
-            )
1068
-        );
1069
-    }
1070
-
1071
-
1072
-
1073
-    /**
1074
-     * Alters query parameters to only get items with this ID are returned.
1075
-     * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1076
-     * or could just be a simple primary key ID
1077
-     *
1078
-     * @param int   $id
1079
-     * @param array $query_params
1080
-     * @return array of normal query params, @see EEM_Base::get_all
1081
-     * @throws \EE_Error
1082
-     */
1083
-    public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1084
-    {
1085
-        if ( ! isset($query_params[0])) {
1086
-            $query_params[0] = array();
1087
-        }
1088
-        $conditions_from_id = $this->parse_index_primary_key_string($id);
1089
-        if ($conditions_from_id === null) {
1090
-            $query_params[0][$this->primary_key_name()] = $id;
1091
-        } else {
1092
-            //no primary key, so the $id must be from the get_index_primary_key_string()
1093
-            $query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1094
-        }
1095
-        return $query_params;
1096
-    }
1097
-
1098
-
1099
-
1100
-    /**
1101
-     * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1102
-     * array. If no item is found, null is returned.
1103
-     *
1104
-     * @param array $query_params like EEM_Base's $query_params variable.
1105
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1106
-     * @throws \EE_Error
1107
-     */
1108
-    public function get_one($query_params = array())
1109
-    {
1110
-        if ( ! is_array($query_params)) {
1111
-            EE_Error::doing_it_wrong('EEM_Base::get_one',
1112
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1113
-                    gettype($query_params)), '4.6.0');
1114
-            $query_params = array();
1115
-        }
1116
-        $query_params['limit'] = 1;
1117
-        $items = $this->get_all($query_params);
1118
-        if (empty($items)) {
1119
-            return null;
1120
-        } else {
1121
-            return array_shift($items);
1122
-        }
1123
-    }
1124
-
1125
-
1126
-
1127
-    /**
1128
-     * Returns the next x number of items in sequence from the given value as
1129
-     * found in the database matching the given query conditions.
1130
-     *
1131
-     * @param mixed $current_field_value    Value used for the reference point.
1132
-     * @param null  $field_to_order_by      What field is used for the
1133
-     *                                      reference point.
1134
-     * @param int   $limit                  How many to return.
1135
-     * @param array $query_params           Extra conditions on the query.
1136
-     * @param null  $columns_to_select      If left null, then an array of
1137
-     *                                      EE_Base_Class objects is returned,
1138
-     *                                      otherwise you can indicate just the
1139
-     *                                      columns you want returned.
1140
-     * @return EE_Base_Class[]|array
1141
-     * @throws \EE_Error
1142
-     */
1143
-    public function next_x(
1144
-        $current_field_value,
1145
-        $field_to_order_by = null,
1146
-        $limit = 1,
1147
-        $query_params = array(),
1148
-        $columns_to_select = null
1149
-    ) {
1150
-        return $this->_get_consecutive($current_field_value, '>', $field_to_order_by, $limit, $query_params,
1151
-            $columns_to_select);
1152
-    }
1153
-
1154
-
1155
-
1156
-    /**
1157
-     * Returns the previous x number of items in sequence from the given value
1158
-     * as found in the database matching the given query conditions.
1159
-     *
1160
-     * @param mixed $current_field_value    Value used for the reference point.
1161
-     * @param null  $field_to_order_by      What field is used for the
1162
-     *                                      reference point.
1163
-     * @param int   $limit                  How many to return.
1164
-     * @param array $query_params           Extra conditions on the query.
1165
-     * @param null  $columns_to_select      If left null, then an array of
1166
-     *                                      EE_Base_Class objects is returned,
1167
-     *                                      otherwise you can indicate just the
1168
-     *                                      columns you want returned.
1169
-     * @return EE_Base_Class[]|array
1170
-     * @throws \EE_Error
1171
-     */
1172
-    public function previous_x(
1173
-        $current_field_value,
1174
-        $field_to_order_by = null,
1175
-        $limit = 1,
1176
-        $query_params = array(),
1177
-        $columns_to_select = null
1178
-    ) {
1179
-        return $this->_get_consecutive($current_field_value, '<', $field_to_order_by, $limit, $query_params,
1180
-            $columns_to_select);
1181
-    }
1182
-
1183
-
1184
-
1185
-    /**
1186
-     * Returns the next item in sequence from the given value as found in the
1187
-     * database matching the given query conditions.
1188
-     *
1189
-     * @param mixed $current_field_value    Value used for the reference point.
1190
-     * @param null  $field_to_order_by      What field is used for the
1191
-     *                                      reference point.
1192
-     * @param array $query_params           Extra conditions on the query.
1193
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1194
-     *                                      object is returned, otherwise you
1195
-     *                                      can indicate just the columns you
1196
-     *                                      want and a single array indexed by
1197
-     *                                      the columns will be returned.
1198
-     * @return EE_Base_Class|null|array()
1199
-     * @throws \EE_Error
1200
-     */
1201
-    public function next(
1202
-        $current_field_value,
1203
-        $field_to_order_by = null,
1204
-        $query_params = array(),
1205
-        $columns_to_select = null
1206
-    ) {
1207
-        $results = $this->_get_consecutive($current_field_value, '>', $field_to_order_by, 1, $query_params,
1208
-            $columns_to_select);
1209
-        return empty($results) ? null : reset($results);
1210
-    }
1211
-
1212
-
1213
-
1214
-    /**
1215
-     * Returns the previous item in sequence from the given value as found in
1216
-     * the database matching the given query conditions.
1217
-     *
1218
-     * @param mixed $current_field_value    Value used for the reference point.
1219
-     * @param null  $field_to_order_by      What field is used for the
1220
-     *                                      reference point.
1221
-     * @param array $query_params           Extra conditions on the query.
1222
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1223
-     *                                      object is returned, otherwise you
1224
-     *                                      can indicate just the columns you
1225
-     *                                      want and a single array indexed by
1226
-     *                                      the columns will be returned.
1227
-     * @return EE_Base_Class|null|array()
1228
-     * @throws EE_Error
1229
-     */
1230
-    public function previous(
1231
-        $current_field_value,
1232
-        $field_to_order_by = null,
1233
-        $query_params = array(),
1234
-        $columns_to_select = null
1235
-    ) {
1236
-        $results = $this->_get_consecutive($current_field_value, '<', $field_to_order_by, 1, $query_params,
1237
-            $columns_to_select);
1238
-        return empty($results) ? null : reset($results);
1239
-    }
1240
-
1241
-
1242
-
1243
-    /**
1244
-     * Returns the a consecutive number of items in sequence from the given
1245
-     * value as found in the database matching the given query conditions.
1246
-     *
1247
-     * @param mixed  $current_field_value   Value used for the reference point.
1248
-     * @param string $operand               What operand is used for the sequence.
1249
-     * @param string $field_to_order_by     What field is used for the reference point.
1250
-     * @param int    $limit                 How many to return.
1251
-     * @param array  $query_params          Extra conditions on the query.
1252
-     * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1253
-     *                                      otherwise you can indicate just the columns you want returned.
1254
-     * @return EE_Base_Class[]|array
1255
-     * @throws EE_Error
1256
-     */
1257
-    protected function _get_consecutive(
1258
-        $current_field_value,
1259
-        $operand = '>',
1260
-        $field_to_order_by = null,
1261
-        $limit = 1,
1262
-        $query_params = array(),
1263
-        $columns_to_select = null
1264
-    ) {
1265
-        //if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1266
-        if (empty($field_to_order_by)) {
1267
-            if ($this->has_primary_key_field()) {
1268
-                $field_to_order_by = $this->get_primary_key_field()->get_name();
1269
-            } else {
1270
-                if (WP_DEBUG) {
1271
-                    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).',
1272
-                        'event_espresso'));
1273
-                }
1274
-                EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1275
-                return array();
1276
-            }
1277
-        }
1278
-        if ( ! is_array($query_params)) {
1279
-            EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1280
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1281
-                    gettype($query_params)), '4.6.0');
1282
-            $query_params = array();
1283
-        }
1284
-        //let's add the where query param for consecutive look up.
1285
-        $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1286
-        $query_params['limit'] = $limit;
1287
-        //set direction
1288
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1289
-        $query_params['order_by'] = $operand === '>'
1290
-            ? array($field_to_order_by => 'ASC') + $incoming_orderby
1291
-            : array($field_to_order_by => 'DESC') + $incoming_orderby;
1292
-        //if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1293
-        if (empty($columns_to_select)) {
1294
-            return $this->get_all($query_params);
1295
-        } else {
1296
-            //getting just the fields
1297
-            return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1298
-        }
1299
-    }
1300
-
1301
-
1302
-
1303
-    /**
1304
-     * This sets the _timezone property after model object has been instantiated.
1305
-     *
1306
-     * @param null | string $timezone valid PHP DateTimeZone timezone string
1307
-     */
1308
-    public function set_timezone($timezone)
1309
-    {
1310
-        if ($timezone !== null) {
1311
-            $this->_timezone = $timezone;
1312
-        }
1313
-        //note we need to loop through relations and set the timezone on those objects as well.
1314
-        foreach ($this->_model_relations as $relation) {
1315
-            $relation->set_timezone($timezone);
1316
-        }
1317
-        //and finally we do the same for any datetime fields
1318
-        foreach ($this->_fields as $field) {
1319
-            if ($field instanceof EE_Datetime_Field) {
1320
-                $field->set_timezone($timezone);
1321
-            }
1322
-        }
1323
-    }
1324
-
1325
-
1326
-
1327
-    /**
1328
-     * This just returns whatever is set for the current timezone.
1329
-     *
1330
-     * @access public
1331
-     * @return string
1332
-     */
1333
-    public function get_timezone()
1334
-    {
1335
-        //first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1336
-        if (empty($this->_timezone)) {
1337
-            foreach ($this->_fields as $field) {
1338
-                if ($field instanceof EE_Datetime_Field) {
1339
-                    $this->set_timezone($field->get_timezone());
1340
-                    break;
1341
-                }
1342
-            }
1343
-        }
1344
-        //if timezone STILL empty then return the default timezone for the site.
1345
-        if (empty($this->_timezone)) {
1346
-            $this->set_timezone(EEH_DTT_Helper::get_timezone());
1347
-        }
1348
-        return $this->_timezone;
1349
-    }
1350
-
1351
-
1352
-
1353
-    /**
1354
-     * This returns the date formats set for the given field name and also ensures that
1355
-     * $this->_timezone property is set correctly.
1356
-     *
1357
-     * @since 4.6.x
1358
-     * @param string $field_name The name of the field the formats are being retrieved for.
1359
-     * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1360
-     * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1361
-     * @return array formats in an array with the date format first, and the time format last.
1362
-     */
1363
-    public function get_formats_for($field_name, $pretty = false)
1364
-    {
1365
-        $field_settings = $this->field_settings_for($field_name);
1366
-        //if not a valid EE_Datetime_Field then throw error
1367
-        if ( ! $field_settings instanceof EE_Datetime_Field) {
1368
-            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.',
1369
-                'event_espresso'), $field_name));
1370
-        }
1371
-        //while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1372
-        //the field.
1373
-        $this->_timezone = $field_settings->get_timezone();
1374
-        return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1375
-    }
1376
-
1377
-
1378
-
1379
-    /**
1380
-     * This returns the current time in a format setup for a query on this model.
1381
-     * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1382
-     * it will return:
1383
-     *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1384
-     *  NOW
1385
-     *  - or a unix timestamp (equivalent to time())
1386
-     *
1387
-     * @since 4.6.x
1388
-     * @param string $field_name       The field the current time is needed for.
1389
-     * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1390
-     *                                 formatted string matching the set format for the field in the set timezone will
1391
-     *                                 be returned.
1392
-     * @param string $what             Whether to return the string in just the time format, the date format, or both.
1393
-     * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1394
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1395
-     *                                 exception is triggered.
1396
-     */
1397
-    public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1398
-    {
1399
-        $formats = $this->get_formats_for($field_name);
1400
-        $DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1401
-        if ($timestamp) {
1402
-            return $DateTime->format('U');
1403
-        }
1404
-        //not returning timestamp, so return formatted string in timezone.
1405
-        switch ($what) {
1406
-            case 'time' :
1407
-                return $DateTime->format($formats[1]);
1408
-                break;
1409
-            case 'date' :
1410
-                return $DateTime->format($formats[0]);
1411
-                break;
1412
-            default :
1413
-                return $DateTime->format(implode(' ', $formats));
1414
-                break;
1415
-        }
1416
-    }
1417
-
1418
-
1419
-
1420
-    /**
1421
-     * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1422
-     * for the model are.  Returns a DateTime object.
1423
-     * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1424
-     * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1425
-     * ignored.
1426
-     *
1427
-     * @param string $field_name      The field being setup.
1428
-     * @param string $timestring      The date time string being used.
1429
-     * @param string $incoming_format The format for the time string.
1430
-     * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1431
-     *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1432
-     *                                format is
1433
-     *                                'U', this is ignored.
1434
-     * @return DateTime
1435
-     * @throws \EE_Error
1436
-     */
1437
-    public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1438
-    {
1439
-        //just using this to ensure the timezone is set correctly internally
1440
-        $this->get_formats_for($field_name);
1441
-        //load EEH_DTT_Helper
1442
-        $set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1443
-        $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1444
-        return $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone));
1445
-    }
1446
-
1447
-
1448
-
1449
-    /**
1450
-     * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1451
-     *
1452
-     * @return EE_Table_Base[]
1453
-     */
1454
-    public function get_tables()
1455
-    {
1456
-        return $this->_tables;
1457
-    }
1458
-
1459
-
1460
-
1461
-    /**
1462
-     * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1463
-     * also updates all the model objects, where the criteria expressed in $query_params are met..
1464
-     * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1465
-     * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1466
-     * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1467
-     * model object with EVT_ID = 1
1468
-     * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1469
-     * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1470
-     * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1471
-     * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1472
-     * are not specified)
1473
-     *
1474
-     * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1475
-     *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1476
-     *                                         are to be serialized. Basically, the values are what you'd expect to be
1477
-     *                                         values on the model, NOT necessarily what's in the DB. For example, if
1478
-     *                                         we wanted to update only the TXN_details on any Transactions where its
1479
-     *                                         ID=34, we'd use this method as follows:
1480
-     *                                         EEM_Transaction::instance()->update(
1481
-     *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1482
-     *                                         array(array('TXN_ID'=>34)));
1483
-     * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1484
-     *                                         in client code into what's expected to be stored on each field. Eg,
1485
-     *                                         consider updating Question's QST_admin_label field is of type
1486
-     *                                         Simple_HTML. If you use this function to update that field to $new_value
1487
-     *                                         = (note replace 8's with appropriate opening and closing tags in the
1488
-     *                                         following example)"8script8alert('I hack all');8/script88b8boom
1489
-     *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1490
-     *                                         TRUE, it is assumed that you've already called
1491
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1492
-     *                                         malicious javascript. However, if
1493
-     *                                         $values_already_prepared_by_model_object is left as FALSE, then
1494
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it, and every other field, before insertion. We provide this parameter because model objects perform their prepare_for_set function on all their values, and so don't need to be called again (and in many cases, shouldn't be called again. Eg: if we escape HTML characters in the prepare_for_set method...)
1495
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1496
-     *                                         in this model's entity map according to $fields_n_values that match
1497
-     *                                         $query_params. This obviously has some overhead, so you can disable it
1498
-     *                                         by setting this to FALSE, but be aware that model objects being used
1499
-     *                                         could get out-of-sync with the database
1500
-     * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1501
-     *             rows affected which *could* include 0 which DOES NOT mean the query was bad)
1502
-     * @throws \EE_Error
1503
-     */
1504
-    public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1505
-    {
1506
-        if ( ! is_array($query_params)) {
1507
-            EE_Error::doing_it_wrong('EEM_Base::update',
1508
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1509
-                    gettype($query_params)), '4.6.0');
1510
-            $query_params = array();
1511
-        }
1512
-        /**
1513
-         * Action called before a model update call has been made.
1514
-         *
1515
-         * @param EEM_Base $model
1516
-         * @param array    $fields_n_values the updated fields and their new values
1517
-         * @param array    $query_params    @see EEM_Base::get_all()
1518
-         */
1519
-        do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1520
-        /**
1521
-         * Filters the fields about to be updated given the query parameters. You can provide the
1522
-         * $query_params to $this->get_all() to find exactly which records will be updated
1523
-         *
1524
-         * @param array    $fields_n_values fields and their new values
1525
-         * @param EEM_Base $model           the model being queried
1526
-         * @param array    $query_params    see EEM_Base::get_all()
1527
-         */
1528
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1529
-            $query_params);
1530
-        //need to verify that, for any entry we want to update, there are entries in each secondary table.
1531
-        //to do that, for each table, verify that it's PK isn't null.
1532
-        $tables = $this->get_tables();
1533
-        //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
1534
-        //NOTE: we should make this code more efficient by NOT querying twice
1535
-        //before the real update, but that needs to first go through ALPHA testing
1536
-        //as it's dangerous. says Mike August 8 2014
1537
-        //we want to make sure the default_where strategy is ignored
1538
-        $this->_ignore_where_strategy = true;
1539
-        $wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1540
-        foreach ($wpdb_select_results as $wpdb_result) {
1541
-            // type cast stdClass as array
1542
-            $wpdb_result = (array)$wpdb_result;
1543
-            //get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1544
-            if ($this->has_primary_key_field()) {
1545
-                $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1546
-            } else {
1547
-                //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)
1548
-                $main_table_pk_value = null;
1549
-            }
1550
-            //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
1551
-            //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
1552
-            if (count($tables) > 1) {
1553
-                //foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1554
-                //in that table, and so we'll want to insert one
1555
-                foreach ($tables as $table_obj) {
1556
-                    $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1557
-                    //if there is no private key for this table on the results, it means there's no entry
1558
-                    //in this table, right? so insert a row in the current table, using any fields available
1559
-                    if ( ! (array_key_exists($this_table_pk_column, $wpdb_result)
1560
-                            && $wpdb_result[$this_table_pk_column])
1561
-                    ) {
1562
-                        $success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1563
-                            $main_table_pk_value);
1564
-                        //if we died here, report the error
1565
-                        if ( ! $success) {
1566
-                            return false;
1567
-                        }
1568
-                    }
1569
-                }
1570
-            }
32
+	//admin posty
33
+	//basic -> grants access to mine -> if they don't have it, select none
34
+	//*_others -> grants access to others that arent private, and all mine -> if they don't have it, select mine
35
+	//*_private -> grants full access -> if dont have it, select all mine and others' non-private
36
+	//*_published -> grants access to published -> if they dont have it, select non-published
37
+	//*_global/default/system -> grants access to global items -> if they don't have it, select non-global
38
+	//publish_{thing} -> can change status TO publish; SPECIAL CASE
39
+	//frontend posty
40
+	//by default has access to published
41
+	//basic -> grants access to mine that arent published, and all published
42
+	//*_others ->grants access to others that arent private, all mine
43
+	//*_private -> grants full access
44
+	//frontend non-posty
45
+	//like admin posty
46
+	//category-y
47
+	//assign -> grants access to join-table
48
+	//(delete, edit)
49
+	//payment-method-y
50
+	//for each registered payment method,
51
+	//ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
52
+	/**
53
+	 * Flag to indicate whether the values provided to EEM_Base have already been prepared
54
+	 * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
55
+	 * They almost always WILL NOT, but it's not necessarily a requirement.
56
+	 * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
57
+	 *
58
+	 * @var boolean
59
+	 */
60
+	private $_values_already_prepared_by_model_object = 0;
61
+
62
+	/**
63
+	 * when $_values_already_prepared_by_model_object equals this, we assume
64
+	 * the data is just like form input that needs to have the model fields'
65
+	 * prepare_for_set and prepare_for_use_in_db called on it
66
+	 */
67
+	const not_prepared_by_model_object = 0;
68
+
69
+	/**
70
+	 * when $_values_already_prepared_by_model_object equals this, we
71
+	 * assume this value is coming from a model object and doesn't need to have
72
+	 * prepare_for_set called on it, just prepare_for_use_in_db is used
73
+	 */
74
+	const prepared_by_model_object = 1;
75
+
76
+	/**
77
+	 * when $_values_already_prepared_by_model_object equals this, we assume
78
+	 * the values are already to be used in the database (ie no processing is done
79
+	 * on them by the model's fields)
80
+	 */
81
+	const prepared_for_use_in_db = 2;
82
+
83
+
84
+	protected $singular_item = 'Item';
85
+
86
+	protected $plural_item   = 'Items';
87
+
88
+	/**
89
+	 * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
90
+	 */
91
+	protected $_tables;
92
+
93
+	/**
94
+	 * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
95
+	 * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
96
+	 * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
97
+	 *
98
+	 * @var \EE_Model_Field_Base[] $_fields
99
+	 */
100
+	protected $_fields;
101
+
102
+	/**
103
+	 * array of different kinds of relations
104
+	 *
105
+	 * @var \EE_Model_Relation_Base[] $_model_relations
106
+	 */
107
+	protected $_model_relations;
108
+
109
+	/**
110
+	 * @var \EE_Index[] $_indexes
111
+	 */
112
+	protected $_indexes = array();
113
+
114
+	/**
115
+	 * Default strategy for getting where conditions on this model. This strategy is used to get default
116
+	 * where conditions which are added to get_all, update, and delete queries. They can be overridden
117
+	 * by setting the same columns as used in these queries in the query yourself.
118
+	 *
119
+	 * @var EE_Default_Where_Conditions
120
+	 */
121
+	protected $_default_where_conditions_strategy;
122
+
123
+	/**
124
+	 * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
125
+	 * This is particularly useful when you want something between 'none' and 'default'
126
+	 *
127
+	 * @var EE_Default_Where_Conditions
128
+	 */
129
+	protected $_minimum_where_conditions_strategy;
130
+
131
+	/**
132
+	 * String describing how to find the "owner" of this model's objects.
133
+	 * When there is a foreign key on this model to the wp_users table, this isn't needed.
134
+	 * But when there isn't, this indicates which related model, or transiently-related model,
135
+	 * has the foreign key to the wp_users table.
136
+	 * Eg, for EEM_Registration this would be 'Event' because registrations are directly
137
+	 * related to events, and events have a foreign key to wp_users.
138
+	 * On EEM_Transaction, this would be 'Transaction.Event'
139
+	 *
140
+	 * @var string
141
+	 */
142
+	protected $_model_chain_to_wp_user = '';
143
+
144
+	/**
145
+	 * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
146
+	 * don't need it (particularly CPT models)
147
+	 *
148
+	 * @var bool
149
+	 */
150
+	protected $_ignore_where_strategy = false;
151
+
152
+	/**
153
+	 * String used in caps relating to this model. Eg, if the caps relating to this
154
+	 * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
155
+	 *
156
+	 * @var string. If null it hasn't been initialized yet. If false then we
157
+	 * have indicated capabilities don't apply to this
158
+	 */
159
+	protected $_caps_slug = null;
160
+
161
+	/**
162
+	 * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
163
+	 * and next-level keys are capability names, and each's value is a
164
+	 * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
165
+	 * they specify which context to use (ie, frontend, backend, edit or delete)
166
+	 * and then each capability in the corresponding sub-array that they're missing
167
+	 * adds the where conditions onto the query.
168
+	 *
169
+	 * @var array
170
+	 */
171
+	protected $_cap_restrictions = array(
172
+		self::caps_read       => array(),
173
+		self::caps_read_admin => array(),
174
+		self::caps_edit       => array(),
175
+		self::caps_delete     => array(),
176
+	);
177
+
178
+	/**
179
+	 * Array defining which cap restriction generators to use to create default
180
+	 * cap restrictions to put in EEM_Base::_cap_restrictions.
181
+	 * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
182
+	 * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
183
+	 * automatically set this to false (not just null).
184
+	 *
185
+	 * @var EE_Restriction_Generator_Base[]
186
+	 */
187
+	protected $_cap_restriction_generators = array();
188
+
189
+	/**
190
+	 * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
191
+	 */
192
+	const caps_read       = 'read';
193
+
194
+	const caps_read_admin = 'read_admin';
195
+
196
+	const caps_edit       = 'edit';
197
+
198
+	const caps_delete     = 'delete';
199
+
200
+	/**
201
+	 * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
202
+	 * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
203
+	 * maps to 'read' because when looking for relevant permissions we're going to use
204
+	 * 'read' in teh capabilities names like 'ee_read_events' etc.
205
+	 *
206
+	 * @var array
207
+	 */
208
+	protected $_cap_contexts_to_cap_action_map = array(
209
+		self::caps_read       => 'read',
210
+		self::caps_read_admin => 'read',
211
+		self::caps_edit       => 'edit',
212
+		self::caps_delete     => 'delete',
213
+	);
214
+
215
+	/**
216
+	 * Timezone
217
+	 * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
218
+	 * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
219
+	 * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
220
+	 * EE_Datetime_Field data type will have access to it.
221
+	 *
222
+	 * @var string
223
+	 */
224
+	protected $_timezone;
225
+
226
+
227
+	/**
228
+	 * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
229
+	 * multisite.
230
+	 *
231
+	 * @var int
232
+	 */
233
+	protected static $_model_query_blog_id;
234
+
235
+	/**
236
+	 * A copy of _fields, except the array keys are the model names pointed to by
237
+	 * the field
238
+	 *
239
+	 * @var EE_Model_Field_Base[]
240
+	 */
241
+	private $_cache_foreign_key_to_fields = array();
242
+
243
+	/**
244
+	 * Cached list of all the fields on the model, indexed by their name
245
+	 *
246
+	 * @var EE_Model_Field_Base[]
247
+	 */
248
+	private $_cached_fields = null;
249
+
250
+	/**
251
+	 * Cached list of all the fields on the model, except those that are
252
+	 * marked as only pertinent to the database
253
+	 *
254
+	 * @var EE_Model_Field_Base[]
255
+	 */
256
+	private $_cached_fields_non_db_only = null;
257
+
258
+	/**
259
+	 * A cached reference to the primary key for quick lookup
260
+	 *
261
+	 * @var EE_Model_Field_Base
262
+	 */
263
+	private $_primary_key_field = null;
264
+
265
+	/**
266
+	 * Flag indicating whether this model has a primary key or not
267
+	 *
268
+	 * @var boolean
269
+	 */
270
+	protected $_has_primary_key_field = null;
271
+
272
+	/**
273
+	 * Whether or not this model is based off a table in WP core only (CPTs should set
274
+	 * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
275
+	 *
276
+	 * @var boolean
277
+	 */
278
+	protected $_wp_core_model = false;
279
+
280
+	/**
281
+	 *    List of valid operators that can be used for querying.
282
+	 * The keys are all operators we'll accept, the values are the real SQL
283
+	 * operators used
284
+	 *
285
+	 * @var array
286
+	 */
287
+	protected $_valid_operators = array(
288
+		'='           => '=',
289
+		'<='          => '<=',
290
+		'<'           => '<',
291
+		'>='          => '>=',
292
+		'>'           => '>',
293
+		'!='          => '!=',
294
+		'LIKE'        => 'LIKE',
295
+		'like'        => 'LIKE',
296
+		'NOT_LIKE'    => 'NOT LIKE',
297
+		'not_like'    => 'NOT LIKE',
298
+		'NOT LIKE'    => 'NOT LIKE',
299
+		'not like'    => 'NOT LIKE',
300
+		'IN'          => 'IN',
301
+		'in'          => 'IN',
302
+		'NOT_IN'      => 'NOT IN',
303
+		'not_in'      => 'NOT IN',
304
+		'NOT IN'      => 'NOT IN',
305
+		'not in'      => 'NOT IN',
306
+		'between'     => 'BETWEEN',
307
+		'BETWEEN'     => 'BETWEEN',
308
+		'IS_NOT_NULL' => 'IS NOT NULL',
309
+		'is_not_null' => 'IS NOT NULL',
310
+		'IS NOT NULL' => 'IS NOT NULL',
311
+		'is not null' => 'IS NOT NULL',
312
+		'IS_NULL'     => 'IS NULL',
313
+		'is_null'     => 'IS NULL',
314
+		'IS NULL'     => 'IS NULL',
315
+		'is null'     => 'IS NULL',
316
+		'REGEXP'      => 'REGEXP',
317
+		'regexp'      => 'REGEXP',
318
+		'NOT_REGEXP'  => 'NOT REGEXP',
319
+		'not_regexp'  => 'NOT REGEXP',
320
+		'NOT REGEXP'  => 'NOT REGEXP',
321
+		'not regexp'  => 'NOT REGEXP',
322
+	);
323
+
324
+	/**
325
+	 * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
326
+	 *
327
+	 * @var array
328
+	 */
329
+	protected $_in_style_operators = array('IN', 'NOT IN');
330
+
331
+	/**
332
+	 * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
333
+	 * '12-31-2012'"
334
+	 *
335
+	 * @var array
336
+	 */
337
+	protected $_between_style_operators = array('BETWEEN');
338
+
339
+	/**
340
+	 * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
341
+	 * on a join table.
342
+	 *
343
+	 * @var array
344
+	 */
345
+	protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
346
+
347
+	/**
348
+	 * Allowed values for $query_params['order'] for ordering in queries
349
+	 *
350
+	 * @var array
351
+	 */
352
+	protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
353
+
354
+	/**
355
+	 * When these are keys in a WHERE or HAVING clause, they are handled much differently
356
+	 * than regular field names. It is assumed that their values are an array of WHERE conditions
357
+	 *
358
+	 * @var array
359
+	 */
360
+	private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
361
+
362
+	/**
363
+	 * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
364
+	 * 'where', but 'where' clauses are so common that we thought we'd omit it
365
+	 *
366
+	 * @var array
367
+	 */
368
+	private $_allowed_query_params = array(
369
+		0,
370
+		'limit',
371
+		'order_by',
372
+		'group_by',
373
+		'having',
374
+		'force_join',
375
+		'order',
376
+		'on_join_limit',
377
+		'default_where_conditions',
378
+		'caps',
379
+	);
380
+
381
+	/**
382
+	 * All the data types that can be used in $wpdb->prepare statements.
383
+	 *
384
+	 * @var array
385
+	 */
386
+	private $_valid_wpdb_data_types = array('%d', '%s', '%f');
387
+
388
+	/**
389
+	 *    EE_Registry Object
390
+	 *
391
+	 * @var    object
392
+	 * @access    protected
393
+	 */
394
+	protected $EE = null;
395
+
396
+
397
+	/**
398
+	 * Property which, when set, will have this model echo out the next X queries to the page for debugging.
399
+	 *
400
+	 * @var int
401
+	 */
402
+	protected $_show_next_x_db_queries = 0;
403
+
404
+	/**
405
+	 * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
406
+	 * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
407
+	 *
408
+	 * @var array
409
+	 */
410
+	protected $_custom_selections = array();
411
+
412
+	/**
413
+	 * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
414
+	 * caches every model object we've fetched from the DB on this request
415
+	 *
416
+	 * @var array
417
+	 */
418
+	protected $_entity_map;
419
+
420
+	/**
421
+	 * constant used to show EEM_Base has not yet verified the db on this http request
422
+	 */
423
+	const db_verified_none = 0;
424
+
425
+	/**
426
+	 * constant used to show EEM_Base has verified the EE core db on this http request,
427
+	 * but not the addons' dbs
428
+	 */
429
+	const db_verified_core = 1;
430
+
431
+	/**
432
+	 * constant used to show EEM_Base has verified the addons' dbs (and implicitly
433
+	 * the EE core db too)
434
+	 */
435
+	const db_verified_addons = 2;
436
+
437
+	/**
438
+	 * indicates whether an EEM_Base child has already re-verified the DB
439
+	 * is ok (we don't want to do it repetitively). Should be set to one the constants
440
+	 * looking like EEM_Base::db_verified_*
441
+	 *
442
+	 * @var int - 0 = none, 1 = core, 2 = addons
443
+	 */
444
+	protected static $_db_verification_level = EEM_Base::db_verified_none;
445
+
446
+
447
+
448
+	/**
449
+	 * About all child constructors:
450
+	 * they should define the _tables, _fields and _model_relations arrays.
451
+	 * Should ALWAYS be called after child constructor.
452
+	 * In order to make the child constructors to be as simple as possible, this parent constructor
453
+	 * finalizes constructing all the object's attributes.
454
+	 * Generally, rather than requiring a child to code
455
+	 * $this->_tables = array(
456
+	 *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
457
+	 *        ...);
458
+	 *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
459
+	 * each EE_Table has a function to set the table's alias after the constructor, using
460
+	 * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
461
+	 * do something similar.
462
+	 *
463
+	 * @param null $timezone
464
+	 * @throws \EE_Error
465
+	 */
466
+	protected function __construct($timezone = null)
467
+	{
468
+		// check that the model has not been loaded too soon
469
+		if ( ! did_action('AHEE__EE_System__load_espresso_addons')) {
470
+			throw new EE_Error (
471
+				sprintf(
472
+					__('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.',
473
+						'event_espresso'),
474
+					get_class($this)
475
+				)
476
+			);
477
+		}
478
+		/**
479
+		 * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
480
+		 */
481
+		if (empty(EEM_Base::$_model_query_blog_id)) {
482
+			EEM_Base::set_model_query_blog_id();
483
+		}
484
+		/**
485
+		 * Filters the list of tables on a model. It is best to NOT use this directly and instead
486
+		 * just use EE_Register_Model_Extension
487
+		 *
488
+		 * @var EE_Table_Base[] $_tables
489
+		 */
490
+		$this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
491
+		foreach ($this->_tables as $table_alias => $table_obj) {
492
+			/** @var $table_obj EE_Table_Base */
493
+			$table_obj->_construct_finalize_with_alias($table_alias);
494
+			if ($table_obj instanceof EE_Secondary_Table) {
495
+				/** @var $table_obj EE_Secondary_Table */
496
+				$table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
497
+			}
498
+		}
499
+		/**
500
+		 * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
501
+		 * EE_Register_Model_Extension
502
+		 *
503
+		 * @param EE_Model_Field_Base[] $_fields
504
+		 */
505
+		$this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
506
+		$this->_invalidate_field_caches();
507
+		foreach ($this->_fields as $table_alias => $fields_for_table) {
508
+			if ( ! array_key_exists($table_alias, $this->_tables)) {
509
+				throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
510
+					'event_espresso'), $table_alias, implode(",", $this->_fields)));
511
+			}
512
+			foreach ($fields_for_table as $field_name => $field_obj) {
513
+				/** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
514
+				//primary key field base has a slightly different _construct_finalize
515
+				/** @var $field_obj EE_Model_Field_Base */
516
+				$field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
517
+			}
518
+		}
519
+		// everything is related to Extra_Meta
520
+		if (get_class($this) !== 'EEM_Extra_Meta') {
521
+			//make extra meta related to everything, but don't block deleting things just
522
+			//because they have related extra meta info. For now just orphan those extra meta
523
+			//in the future we should automatically delete them
524
+			$this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
525
+		}
526
+		//and change logs
527
+		if (get_class($this) !== 'EEM_Change_Log') {
528
+			$this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
529
+		}
530
+		/**
531
+		 * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
532
+		 * EE_Register_Model_Extension
533
+		 *
534
+		 * @param EE_Model_Relation_Base[] $_model_relations
535
+		 */
536
+		$this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
537
+			$this->_model_relations);
538
+		foreach ($this->_model_relations as $model_name => $relation_obj) {
539
+			/** @var $relation_obj EE_Model_Relation_Base */
540
+			$relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
541
+		}
542
+		foreach ($this->_indexes as $index_name => $index_obj) {
543
+			/** @var $index_obj EE_Index */
544
+			$index_obj->_construct_finalize($index_name, $this->get_this_model_name());
545
+		}
546
+		$this->set_timezone($timezone);
547
+		//finalize default where condition strategy, or set default
548
+		if ( ! $this->_default_where_conditions_strategy) {
549
+			//nothing was set during child constructor, so set default
550
+			$this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
551
+		}
552
+		$this->_default_where_conditions_strategy->_finalize_construct($this);
553
+		if ( ! $this->_minimum_where_conditions_strategy) {
554
+			//nothing was set during child constructor, so set default
555
+			$this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
556
+		}
557
+		$this->_minimum_where_conditions_strategy->_finalize_construct($this);
558
+		//if the cap slug hasn't been set, and we haven't set it to false on purpose
559
+		//to indicate to NOT set it, set it to the logical default
560
+		if ($this->_caps_slug === null) {
561
+			$this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
562
+		}
563
+		//initialize the standard cap restriction generators if none were specified by the child constructor
564
+		if ($this->_cap_restriction_generators !== false) {
565
+			foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
566
+				if ( ! isset($this->_cap_restriction_generators[$cap_context])) {
567
+					$this->_cap_restriction_generators[$cap_context] = apply_filters(
568
+						'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
569
+						new EE_Restriction_Generator_Protected(),
570
+						$cap_context,
571
+						$this
572
+					);
573
+				}
574
+			}
575
+		}
576
+		//if there are cap restriction generators, use them to make the default cap restrictions
577
+		if ($this->_cap_restriction_generators !== false) {
578
+			foreach ($this->_cap_restriction_generators as $context => $generator_object) {
579
+				if ( ! $generator_object) {
580
+					continue;
581
+				}
582
+				if ( ! $generator_object instanceof EE_Restriction_Generator_Base) {
583
+					throw new EE_Error(
584
+						sprintf(
585
+							__('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.',
586
+								'event_espresso'),
587
+							$context,
588
+							$this->get_this_model_name()
589
+						)
590
+					);
591
+				}
592
+				$action = $this->cap_action_for_context($context);
593
+				if ( ! $generator_object->construction_finalized()) {
594
+					$generator_object->_construct_finalize($this, $action);
595
+				}
596
+			}
597
+		}
598
+		do_action('AHEE__' . get_class($this) . '__construct__end');
599
+	}
600
+
601
+
602
+
603
+	/**
604
+	 * Generates the cap restrictions for the given context, or if they were
605
+	 * already generated just gets what's cached
606
+	 *
607
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
608
+	 * @return EE_Default_Where_Conditions[]
609
+	 */
610
+	protected function _generate_cap_restrictions($context)
611
+	{
612
+		if (isset($this->_cap_restriction_generators[$context])
613
+			&& $this->_cap_restriction_generators[$context]
614
+			   instanceof
615
+			   EE_Restriction_Generator_Base
616
+		) {
617
+			return $this->_cap_restriction_generators[$context]->generate_restrictions();
618
+		} else {
619
+			return array();
620
+		}
621
+	}
622
+
623
+
624
+
625
+	/**
626
+	 * Used to set the $_model_query_blog_id static property.
627
+	 *
628
+	 * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
629
+	 *                      value for get_current_blog_id() will be used.
630
+	 */
631
+	public static function set_model_query_blog_id($blog_id = 0)
632
+	{
633
+		EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
634
+	}
635
+
636
+
637
+
638
+	/**
639
+	 * Returns whatever is set as the internal $model_query_blog_id.
640
+	 *
641
+	 * @return int
642
+	 */
643
+	public static function get_model_query_blog_id()
644
+	{
645
+		return EEM_Base::$_model_query_blog_id;
646
+	}
647
+
648
+
649
+
650
+	/**
651
+	 *        This function is a singleton method used to instantiate the Espresso_model object
652
+	 *
653
+	 * @access public
654
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
655
+	 *                         incoming timezone data that gets saved).  Note this just sends the timezone info to the
656
+	 *                         date time model field objects.  Default is NULL (and will be assumed using the set
657
+	 *                         timezone in the 'timezone_string' wp option)
658
+	 * @return static (as in the concrete child class)
659
+	 */
660
+	public static function instance($timezone = null)
661
+	{
662
+		// check if instance of Espresso_model already exists
663
+		if ( ! static::$_instance instanceof static) {
664
+			// instantiate Espresso_model
665
+			static::$_instance = new static($timezone);
666
+		}
667
+		//we might have a timezone set, let set_timezone decide what to do with it
668
+		static::$_instance->set_timezone($timezone);
669
+		// Espresso_model object
670
+		return static::$_instance;
671
+	}
672
+
673
+
674
+
675
+	/**
676
+	 * resets the model and returns it
677
+	 *
678
+	 * @param null | string $timezone
679
+	 * @return EEM_Base|null (if the model was already instantiated, returns it, with
680
+	 * all its properties reset; if it wasn't instantiated, returns null)
681
+	 */
682
+	public static function reset($timezone = null)
683
+	{
684
+		if (static::$_instance instanceof EEM_Base) {
685
+			//let's try to NOT swap out the current instance for a new one
686
+			//because if someone has a reference to it, we can't remove their reference
687
+			//so it's best to keep using the same reference, but change the original object
688
+			//reset all its properties to their original values as defined in the class
689
+			$r = new ReflectionClass(get_class(static::$_instance));
690
+			$static_properties = $r->getStaticProperties();
691
+			foreach ($r->getDefaultProperties() as $property => $value) {
692
+				//don't set instance to null like it was originally,
693
+				//but it's static anyways, and we're ignoring static properties (for now at least)
694
+				if ( ! isset($static_properties[$property])) {
695
+					static::$_instance->{$property} = $value;
696
+				}
697
+			}
698
+			//and then directly call its constructor again, like we would if we
699
+			//were creating a new one
700
+			static::$_instance->__construct($timezone);
701
+			return self::instance();
702
+		}
703
+		return null;
704
+	}
705
+
706
+
707
+
708
+	/**
709
+	 * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
710
+	 *
711
+	 * @param  boolean $translated return localized strings or JUST the array.
712
+	 * @return array
713
+	 * @throws \EE_Error
714
+	 */
715
+	public function status_array($translated = false)
716
+	{
717
+		if ( ! array_key_exists('Status', $this->_model_relations)) {
718
+			return array();
719
+		}
720
+		$model_name = $this->get_this_model_name();
721
+		$status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
722
+		$stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
723
+		$status_array = array();
724
+		foreach ($stati as $status) {
725
+			$status_array[$status->ID()] = $status->get('STS_code');
726
+		}
727
+		return $translated
728
+			? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
729
+			: $status_array;
730
+	}
731
+
732
+
733
+
734
+	/**
735
+	 * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
736
+	 *
737
+	 * @param array $query_params             {
738
+	 * @var array $0 (where) array {
739
+	 *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
740
+	 *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
741
+	 *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
742
+	 *                                        conditions based on related models (and even
743
+	 *                                        models-related-to-related-models) prepend the model's name onto the field
744
+	 *                                        name. Eg,
745
+	 *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
746
+	 *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
747
+	 *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
748
+	 *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
749
+	 *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE Venue_CPT.ID = 12 Notice that automatically took care of joining Events to Venues (even when each of those models actually consisted of two tables). Also, you may chain the model relations together. Eg instead of just having "Venue.VNU_ID", you could have
750
+	 *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
751
+	 *                                        events are related to Registrations, which are related to Attendees). You
752
+	 *                                        can take it even further with
753
+	 *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
754
+	 *                                        (from the default of '='), change the value to an numerically-indexed
755
+	 *                                        array, where the first item in the list is the operator. eg: array(
756
+	 *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
757
+	 *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
758
+	 *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
759
+	 *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
760
+	 *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN (followed by an array with exactly 2 date strings), IS NULL, and IS NOT NULL Values can be a string, int, or float. They can also be arrays IFF the operator is IN. Also, values can actually be field names. To indicate the value is a field, simply provide a third array item (true) to the operator-value array like so: eg: array( 'DTT_reg_limit' => array('>', 'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold" Note: you can also use related model field names like you would any other field name. eg: array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could be used if you were querying EEM_Tickets (because Datetime is directly related to tickets) Also, by default all the where conditions are AND'd together. To override this, add an array key 'OR' (or 'AND') and the array to be OR'd together eg: array('OR'=>array('TXN_ID' => 23 , 'TXN_timestamp__>' => 345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp = 345678912...". Also, to negate an entire set of conditions, use 'NOT' as an array key. eg: array('NOT'=>array('TXN_total' => 50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND TXN_paid =23) Note: the 'glue' used to join each condition will continue to be what you last specified. IE, "AND"s by default, but if you had previously specified to use ORs to join, ORs will continue to be used. So, if you specify to use an "OR" to join conditions, it will continue to "stick" until you specify an AND. eg array('OR'=>array('NOT'=>array('TXN_total' => 50, 'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >> "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND STS_ID='TIN'" They can be nested indefinitely. eg: array('OR'=>array('TXN_total' => 23, 'NOT'=> array( 'TXN_timestamp'=> 345678912, 'AND'=>array('TXN_paid' => 53, 'STS_ID' => 'TIN')))) becomes SQL >> "...WHERE TXN_total = 23 OR ! (TXN_timestamp = 345678912 OR (TXN_paid = 53 AND STS_ID = 'TIN'))..." GOTCHA: because this is an array, array keys must be unique, making it impossible to place two or more where conditions applying to the same field. eg: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp'=>array('<',$end_date),'PAY_timestamp'=>array('!=',$special_date)), as PHP enforces that the array keys must be unique, thus removing the first two array entries with key 'PAY_timestamp'. becomes SQL >> "PAY_timestamp !=  4234232", ignoring the first two PAY_timestamp conditions). To overcome this, you can add a '*' character to the end of the field's name, followed by anything. These will be removed when generating the SQL string, but allow for the array keys to be unique. eg: you could rewrite the previous query as: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp*1st'=>array('<',$end_date),'PAY_timestamp*2nd'=>array('!=',$special_date)) which correctly becomes SQL >> "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND PAY_timestamp != 1241234123" This can be applied to condition operators too, eg: array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
761
+	 * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
762
+	 *      limits of "23", "25,50", and array(23,42) are all valid would become SQL "...LIMIT 23", "...LIMIT 25,50",
763
+	 *      and "...LIMIT 23,42" respectively. Remember when you provide two numbers for the limit, the 1st number is
764
+	 *      the OFFSET, the 2nd is the LIMIT
765
+	 * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
766
+	 *      can do paging on one-to-many multi-table-joins. Send an array in the following format array('on_join_limit'
767
+	 *      => array( 'table_alias', array(1,2) ) ).
768
+	 * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
769
+	 *      values are either 'ASC' or 'DESC'. 'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
770
+	 *      SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date DESC..." respectively. Like the
771
+	 *      'where' conditions, these fields can be on related models. Eg
772
+	 *      'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is perfectly valid from any model related
773
+	 *      to 'Registration' (like Event, Attendee, Price, Datetime, etc.)
774
+	 * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
775
+	 *      'order' specifies whether to order the field specified in 'order_by' in ascending or descending order.
776
+	 *      Acceptable values are 'ASC' or 'DESC'. If, 'order_by' isn't used, but 'order' is, then it is assumed you
777
+	 *      want to order by the primary key. Eg,
778
+	 *      EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC'); //(will join
779
+	 *      with the Datetime model's table(s) and order by its field DTT_EVT_start) or
780
+	 *      EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make SQL "SELECT * FROM
781
+	 *      wp_esp_registration ORDER BY REG_ID ASC"
782
+	 * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
783
+	 *      'group_by'=>'VNU_ID', or 'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note: if no
784
+	 *      $group_by is specified, and a limit is set, automatically groups by the model's primary key (or combined
785
+	 *      primary keys). This avoids some weirdness that results when using limits, tons of joins, and no group by,
786
+	 *      see https://events.codebasehq.com/projects/event-espresso/tickets/9389
787
+	 * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
788
+	 *      grouped results (whereas WHERE conditions apply to the pre-grouped results)
789
+	 * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
790
+	 *      array where values are models to be joined in the query.Eg array('Attendee','Payment','Datetime'). You may
791
+	 *      join with transient models using period, eg "Registration.Transaction.Payment". You will probably only want
792
+	 *      to do this in hopes of increasing efficiency, as related models which belongs to the current model
793
+	 *                                        (ie, the current model has a foreign key to them, like how Registration
794
+	 *                                        belongs to Attendee) can be cached in order to avoid future queries
795
+	 * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
796
+	 *      set this to 'none' to disable all default where conditions. Eg, usually soft-deleted objects are
797
+	 *      filtered-out if you want to include them, set this query param to 'none'. If you want to ONLY disable THIS
798
+	 *      model's default where conditions set it to 'other_models_only'. If you only want this model's default where
799
+	 *      conditions added to the query, use 'this_model_only'. If you want to use all default where conditions
800
+	 *      (default), set to 'all'.
801
+	 * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
802
+	 *      we just NOT apply any capabilities/permissions/restrictions and return everything? Or should we only show
803
+	 *      the current user items they should be able to view on the frontend, backend, edit, or delete? can be set to
804
+	 *      'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
805
+	 *                                        }
806
+	 * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
807
+	 *                          from EE_Base_Class[], use _get_all_wpdb_results()and make it public again. Array keys
808
+	 *                          are object IDs (if there is a primary key on the model. if not, numerically indexed)
809
+	 *                          Some full examples: get 10 transactions which have Scottish attendees:
810
+	 *                          EEM_Transaction::instance()->get_all( array( array(
811
+	 *                                        'OR'=>array(
812
+	 *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
813
+	 *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
814
+	 *                                        )
815
+	 *                                        ),
816
+	 *                                        'limit'=>10,
817
+	 *                                        'group_by'=>'TXN_ID'
818
+	 *                                        ));
819
+	 *                                        get all the answers to the question titled "shirt size" for event with id
820
+	 *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
821
+	 *                                        'Question.QST_display_text'=>'shirt size',
822
+	 *                                        'Registration.Event.EVT_ID'=>12
823
+	 *                                        ),
824
+	 *                                        'order_by'=>array('ANS_value'=>'ASC')
825
+	 *                                        ));
826
+	 * @throws \EE_Error
827
+	 */
828
+	public function get_all($query_params = array())
829
+	{
830
+		if (isset($query_params['limit'])
831
+			&& ! isset($query_params['group_by'])
832
+		) {
833
+			$query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
834
+		}
835
+		return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
836
+	}
837
+
838
+
839
+
840
+	/**
841
+	 * Modifies the query parameters so we only get back model objects
842
+	 * that "belong" to the current user
843
+	 *
844
+	 * @param array $query_params @see EEM_Base::get_all()
845
+	 * @return array like EEM_Base::get_all
846
+	 */
847
+	public function alter_query_params_to_only_include_mine($query_params = array())
848
+	{
849
+		$wp_user_field_name = $this->wp_user_field_name();
850
+		if ($wp_user_field_name) {
851
+			$query_params[0][$wp_user_field_name] = get_current_user_id();
852
+		}
853
+		return $query_params;
854
+	}
855
+
856
+
857
+
858
+	/**
859
+	 * Returns the name of the field's name that points to the WP_User table
860
+	 *  on this model (or follows the _model_chain_to_wp_user and uses that model's
861
+	 * foreign key to the WP_User table)
862
+	 *
863
+	 * @return string|boolean string on success, boolean false when there is no
864
+	 * foreign key to the WP_User table
865
+	 */
866
+	public function wp_user_field_name()
867
+	{
868
+		try {
869
+			if ( ! empty($this->_model_chain_to_wp_user)) {
870
+				$models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
871
+				$last_model_name = end($models_to_follow_to_wp_users);
872
+				$model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
873
+				$model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
874
+			} else {
875
+				$model_with_fk_to_wp_users = $this;
876
+				$model_chain_to_wp_user = '';
877
+			}
878
+			$wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
879
+			return $model_chain_to_wp_user . $wp_user_field->get_name();
880
+		} catch (EE_Error $e) {
881
+			return false;
882
+		}
883
+	}
884
+
885
+
886
+
887
+	/**
888
+	 * Returns the _model_chain_to_wp_user string, which indicates which related model
889
+	 * (or transiently-related model) has a foreign key to the wp_users table;
890
+	 * useful for finding if model objects of this type are 'owned' by the current user.
891
+	 * This is an empty string when the foreign key is on this model and when it isn't,
892
+	 * but is only non-empty when this model's ownership is indicated by a RELATED model
893
+	 * (or transiently-related model)
894
+	 *
895
+	 * @return string
896
+	 */
897
+	public function model_chain_to_wp_user()
898
+	{
899
+		return $this->_model_chain_to_wp_user;
900
+	}
901
+
902
+
903
+
904
+	/**
905
+	 * Whether this model is 'owned' by a specific wordpress user (even indirectly,
906
+	 * like how registrations don't have a foreign key to wp_users, but the
907
+	 * events they are for are), or is unrelated to wp users.
908
+	 * generally available
909
+	 *
910
+	 * @return boolean
911
+	 */
912
+	public function is_owned()
913
+	{
914
+		if ($this->model_chain_to_wp_user()) {
915
+			return true;
916
+		} else {
917
+			try {
918
+				$this->get_foreign_key_to('WP_User');
919
+				return true;
920
+			} catch (EE_Error $e) {
921
+				return false;
922
+			}
923
+		}
924
+	}
925
+
926
+
927
+
928
+	/**
929
+	 * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
930
+	 * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
931
+	 * the model)
932
+	 *
933
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
934
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
935
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
936
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
937
+	 *                                  override this and set the select to "*", or a specific column name, like
938
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
939
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
940
+	 *                                  the aliases used to refer to this selection, and values are to be
941
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
942
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
943
+	 * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
944
+	 * @throws \EE_Error
945
+	 */
946
+	protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
947
+	{
948
+		// remember the custom selections, if any, and type cast as array
949
+		// (unless $columns_to_select is an object, then just set as an empty array)
950
+		// Note: (array) 'some string' === array( 'some string' )
951
+		$this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
952
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
953
+		$select_expressions = $columns_to_select !== null
954
+			? $this->_construct_select_from_input($columns_to_select)
955
+			: $this->_construct_default_select_sql($model_query_info);
956
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
957
+		return $this->_do_wpdb_query('get_results', array($SQL, $output));
958
+	}
959
+
960
+
961
+
962
+	/**
963
+	 * Gets an array of rows from the database just like $wpdb->get_results would,
964
+	 * but you can use the $query_params like on EEM_Base::get_all() to more easily
965
+	 * take care of joins, field preparation etc.
966
+	 *
967
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
968
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
969
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
970
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
971
+	 *                                  override this and set the select to "*", or a specific column name, like
972
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
973
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
974
+	 *                                  the aliases used to refer to this selection, and values are to be
975
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
976
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
977
+	 * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
978
+	 * @throws \EE_Error
979
+	 */
980
+	public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
981
+	{
982
+		return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
983
+	}
984
+
985
+
986
+
987
+	/**
988
+	 * For creating a custom select statement
989
+	 *
990
+	 * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
991
+	 *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
992
+	 *                                 SQL, and 1=>is the datatype
993
+	 * @throws EE_Error
994
+	 * @return string
995
+	 */
996
+	private function _construct_select_from_input($columns_to_select)
997
+	{
998
+		if (is_array($columns_to_select)) {
999
+			$select_sql_array = array();
1000
+			foreach ($columns_to_select as $alias => $selection_and_datatype) {
1001
+				if ( ! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1002
+					throw new EE_Error(
1003
+						sprintf(
1004
+							__(
1005
+								"Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1006
+								"event_espresso"
1007
+							),
1008
+							$selection_and_datatype,
1009
+							$alias
1010
+						)
1011
+					);
1012
+				}
1013
+				if ( ! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1014
+					throw new EE_Error(
1015
+						sprintf(
1016
+							__(
1017
+								"Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1018
+								"event_espresso"
1019
+							),
1020
+							$selection_and_datatype[1],
1021
+							$selection_and_datatype[0],
1022
+							$alias,
1023
+							implode(",", $this->_valid_wpdb_data_types)
1024
+						)
1025
+					);
1026
+				}
1027
+				$select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1028
+			}
1029
+			$columns_to_select_string = implode(", ", $select_sql_array);
1030
+		} else {
1031
+			$columns_to_select_string = $columns_to_select;
1032
+		}
1033
+		return $columns_to_select_string;
1034
+	}
1035
+
1036
+
1037
+
1038
+	/**
1039
+	 * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1040
+	 *
1041
+	 * @return string
1042
+	 * @throws \EE_Error
1043
+	 */
1044
+	public function primary_key_name()
1045
+	{
1046
+		return $this->get_primary_key_field()->get_name();
1047
+	}
1048
+
1049
+
1050
+
1051
+	/**
1052
+	 * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1053
+	 * If there is no primary key on this model, $id is treated as primary key string
1054
+	 *
1055
+	 * @param mixed $id int or string, depending on the type of the model's primary key
1056
+	 * @return EE_Base_Class
1057
+	 */
1058
+	public function get_one_by_ID($id)
1059
+	{
1060
+		if ($this->get_from_entity_map($id)) {
1061
+			return $this->get_from_entity_map($id);
1062
+		}
1063
+		return $this->get_one(
1064
+			$this->alter_query_params_to_restrict_by_ID(
1065
+				$id,
1066
+				array('default_where_conditions' => 'minimum')
1067
+			)
1068
+		);
1069
+	}
1070
+
1071
+
1072
+
1073
+	/**
1074
+	 * Alters query parameters to only get items with this ID are returned.
1075
+	 * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1076
+	 * or could just be a simple primary key ID
1077
+	 *
1078
+	 * @param int   $id
1079
+	 * @param array $query_params
1080
+	 * @return array of normal query params, @see EEM_Base::get_all
1081
+	 * @throws \EE_Error
1082
+	 */
1083
+	public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1084
+	{
1085
+		if ( ! isset($query_params[0])) {
1086
+			$query_params[0] = array();
1087
+		}
1088
+		$conditions_from_id = $this->parse_index_primary_key_string($id);
1089
+		if ($conditions_from_id === null) {
1090
+			$query_params[0][$this->primary_key_name()] = $id;
1091
+		} else {
1092
+			//no primary key, so the $id must be from the get_index_primary_key_string()
1093
+			$query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1094
+		}
1095
+		return $query_params;
1096
+	}
1097
+
1098
+
1099
+
1100
+	/**
1101
+	 * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1102
+	 * array. If no item is found, null is returned.
1103
+	 *
1104
+	 * @param array $query_params like EEM_Base's $query_params variable.
1105
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1106
+	 * @throws \EE_Error
1107
+	 */
1108
+	public function get_one($query_params = array())
1109
+	{
1110
+		if ( ! is_array($query_params)) {
1111
+			EE_Error::doing_it_wrong('EEM_Base::get_one',
1112
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1113
+					gettype($query_params)), '4.6.0');
1114
+			$query_params = array();
1115
+		}
1116
+		$query_params['limit'] = 1;
1117
+		$items = $this->get_all($query_params);
1118
+		if (empty($items)) {
1119
+			return null;
1120
+		} else {
1121
+			return array_shift($items);
1122
+		}
1123
+	}
1124
+
1125
+
1126
+
1127
+	/**
1128
+	 * Returns the next x number of items in sequence from the given value as
1129
+	 * found in the database matching the given query conditions.
1130
+	 *
1131
+	 * @param mixed $current_field_value    Value used for the reference point.
1132
+	 * @param null  $field_to_order_by      What field is used for the
1133
+	 *                                      reference point.
1134
+	 * @param int   $limit                  How many to return.
1135
+	 * @param array $query_params           Extra conditions on the query.
1136
+	 * @param null  $columns_to_select      If left null, then an array of
1137
+	 *                                      EE_Base_Class objects is returned,
1138
+	 *                                      otherwise you can indicate just the
1139
+	 *                                      columns you want returned.
1140
+	 * @return EE_Base_Class[]|array
1141
+	 * @throws \EE_Error
1142
+	 */
1143
+	public function next_x(
1144
+		$current_field_value,
1145
+		$field_to_order_by = null,
1146
+		$limit = 1,
1147
+		$query_params = array(),
1148
+		$columns_to_select = null
1149
+	) {
1150
+		return $this->_get_consecutive($current_field_value, '>', $field_to_order_by, $limit, $query_params,
1151
+			$columns_to_select);
1152
+	}
1153
+
1154
+
1155
+
1156
+	/**
1157
+	 * Returns the previous x number of items in sequence from the given value
1158
+	 * as found in the database matching the given query conditions.
1159
+	 *
1160
+	 * @param mixed $current_field_value    Value used for the reference point.
1161
+	 * @param null  $field_to_order_by      What field is used for the
1162
+	 *                                      reference point.
1163
+	 * @param int   $limit                  How many to return.
1164
+	 * @param array $query_params           Extra conditions on the query.
1165
+	 * @param null  $columns_to_select      If left null, then an array of
1166
+	 *                                      EE_Base_Class objects is returned,
1167
+	 *                                      otherwise you can indicate just the
1168
+	 *                                      columns you want returned.
1169
+	 * @return EE_Base_Class[]|array
1170
+	 * @throws \EE_Error
1171
+	 */
1172
+	public function previous_x(
1173
+		$current_field_value,
1174
+		$field_to_order_by = null,
1175
+		$limit = 1,
1176
+		$query_params = array(),
1177
+		$columns_to_select = null
1178
+	) {
1179
+		return $this->_get_consecutive($current_field_value, '<', $field_to_order_by, $limit, $query_params,
1180
+			$columns_to_select);
1181
+	}
1182
+
1183
+
1184
+
1185
+	/**
1186
+	 * Returns the next item in sequence from the given value as found in the
1187
+	 * database matching the given query conditions.
1188
+	 *
1189
+	 * @param mixed $current_field_value    Value used for the reference point.
1190
+	 * @param null  $field_to_order_by      What field is used for the
1191
+	 *                                      reference point.
1192
+	 * @param array $query_params           Extra conditions on the query.
1193
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1194
+	 *                                      object is returned, otherwise you
1195
+	 *                                      can indicate just the columns you
1196
+	 *                                      want and a single array indexed by
1197
+	 *                                      the columns will be returned.
1198
+	 * @return EE_Base_Class|null|array()
1199
+	 * @throws \EE_Error
1200
+	 */
1201
+	public function next(
1202
+		$current_field_value,
1203
+		$field_to_order_by = null,
1204
+		$query_params = array(),
1205
+		$columns_to_select = null
1206
+	) {
1207
+		$results = $this->_get_consecutive($current_field_value, '>', $field_to_order_by, 1, $query_params,
1208
+			$columns_to_select);
1209
+		return empty($results) ? null : reset($results);
1210
+	}
1211
+
1212
+
1213
+
1214
+	/**
1215
+	 * Returns the previous item in sequence from the given value as found in
1216
+	 * the database matching the given query conditions.
1217
+	 *
1218
+	 * @param mixed $current_field_value    Value used for the reference point.
1219
+	 * @param null  $field_to_order_by      What field is used for the
1220
+	 *                                      reference point.
1221
+	 * @param array $query_params           Extra conditions on the query.
1222
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1223
+	 *                                      object is returned, otherwise you
1224
+	 *                                      can indicate just the columns you
1225
+	 *                                      want and a single array indexed by
1226
+	 *                                      the columns will be returned.
1227
+	 * @return EE_Base_Class|null|array()
1228
+	 * @throws EE_Error
1229
+	 */
1230
+	public function previous(
1231
+		$current_field_value,
1232
+		$field_to_order_by = null,
1233
+		$query_params = array(),
1234
+		$columns_to_select = null
1235
+	) {
1236
+		$results = $this->_get_consecutive($current_field_value, '<', $field_to_order_by, 1, $query_params,
1237
+			$columns_to_select);
1238
+		return empty($results) ? null : reset($results);
1239
+	}
1240
+
1241
+
1242
+
1243
+	/**
1244
+	 * Returns the a consecutive number of items in sequence from the given
1245
+	 * value as found in the database matching the given query conditions.
1246
+	 *
1247
+	 * @param mixed  $current_field_value   Value used for the reference point.
1248
+	 * @param string $operand               What operand is used for the sequence.
1249
+	 * @param string $field_to_order_by     What field is used for the reference point.
1250
+	 * @param int    $limit                 How many to return.
1251
+	 * @param array  $query_params          Extra conditions on the query.
1252
+	 * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1253
+	 *                                      otherwise you can indicate just the columns you want returned.
1254
+	 * @return EE_Base_Class[]|array
1255
+	 * @throws EE_Error
1256
+	 */
1257
+	protected function _get_consecutive(
1258
+		$current_field_value,
1259
+		$operand = '>',
1260
+		$field_to_order_by = null,
1261
+		$limit = 1,
1262
+		$query_params = array(),
1263
+		$columns_to_select = null
1264
+	) {
1265
+		//if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1266
+		if (empty($field_to_order_by)) {
1267
+			if ($this->has_primary_key_field()) {
1268
+				$field_to_order_by = $this->get_primary_key_field()->get_name();
1269
+			} else {
1270
+				if (WP_DEBUG) {
1271
+					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).',
1272
+						'event_espresso'));
1273
+				}
1274
+				EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1275
+				return array();
1276
+			}
1277
+		}
1278
+		if ( ! is_array($query_params)) {
1279
+			EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1280
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1281
+					gettype($query_params)), '4.6.0');
1282
+			$query_params = array();
1283
+		}
1284
+		//let's add the where query param for consecutive look up.
1285
+		$query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1286
+		$query_params['limit'] = $limit;
1287
+		//set direction
1288
+		$incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1289
+		$query_params['order_by'] = $operand === '>'
1290
+			? array($field_to_order_by => 'ASC') + $incoming_orderby
1291
+			: array($field_to_order_by => 'DESC') + $incoming_orderby;
1292
+		//if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1293
+		if (empty($columns_to_select)) {
1294
+			return $this->get_all($query_params);
1295
+		} else {
1296
+			//getting just the fields
1297
+			return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1298
+		}
1299
+	}
1300
+
1301
+
1302
+
1303
+	/**
1304
+	 * This sets the _timezone property after model object has been instantiated.
1305
+	 *
1306
+	 * @param null | string $timezone valid PHP DateTimeZone timezone string
1307
+	 */
1308
+	public function set_timezone($timezone)
1309
+	{
1310
+		if ($timezone !== null) {
1311
+			$this->_timezone = $timezone;
1312
+		}
1313
+		//note we need to loop through relations and set the timezone on those objects as well.
1314
+		foreach ($this->_model_relations as $relation) {
1315
+			$relation->set_timezone($timezone);
1316
+		}
1317
+		//and finally we do the same for any datetime fields
1318
+		foreach ($this->_fields as $field) {
1319
+			if ($field instanceof EE_Datetime_Field) {
1320
+				$field->set_timezone($timezone);
1321
+			}
1322
+		}
1323
+	}
1324
+
1325
+
1326
+
1327
+	/**
1328
+	 * This just returns whatever is set for the current timezone.
1329
+	 *
1330
+	 * @access public
1331
+	 * @return string
1332
+	 */
1333
+	public function get_timezone()
1334
+	{
1335
+		//first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1336
+		if (empty($this->_timezone)) {
1337
+			foreach ($this->_fields as $field) {
1338
+				if ($field instanceof EE_Datetime_Field) {
1339
+					$this->set_timezone($field->get_timezone());
1340
+					break;
1341
+				}
1342
+			}
1343
+		}
1344
+		//if timezone STILL empty then return the default timezone for the site.
1345
+		if (empty($this->_timezone)) {
1346
+			$this->set_timezone(EEH_DTT_Helper::get_timezone());
1347
+		}
1348
+		return $this->_timezone;
1349
+	}
1350
+
1351
+
1352
+
1353
+	/**
1354
+	 * This returns the date formats set for the given field name and also ensures that
1355
+	 * $this->_timezone property is set correctly.
1356
+	 *
1357
+	 * @since 4.6.x
1358
+	 * @param string $field_name The name of the field the formats are being retrieved for.
1359
+	 * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1360
+	 * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1361
+	 * @return array formats in an array with the date format first, and the time format last.
1362
+	 */
1363
+	public function get_formats_for($field_name, $pretty = false)
1364
+	{
1365
+		$field_settings = $this->field_settings_for($field_name);
1366
+		//if not a valid EE_Datetime_Field then throw error
1367
+		if ( ! $field_settings instanceof EE_Datetime_Field) {
1368
+			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.',
1369
+				'event_espresso'), $field_name));
1370
+		}
1371
+		//while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1372
+		//the field.
1373
+		$this->_timezone = $field_settings->get_timezone();
1374
+		return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1375
+	}
1376
+
1377
+
1378
+
1379
+	/**
1380
+	 * This returns the current time in a format setup for a query on this model.
1381
+	 * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1382
+	 * it will return:
1383
+	 *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1384
+	 *  NOW
1385
+	 *  - or a unix timestamp (equivalent to time())
1386
+	 *
1387
+	 * @since 4.6.x
1388
+	 * @param string $field_name       The field the current time is needed for.
1389
+	 * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1390
+	 *                                 formatted string matching the set format for the field in the set timezone will
1391
+	 *                                 be returned.
1392
+	 * @param string $what             Whether to return the string in just the time format, the date format, or both.
1393
+	 * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1394
+	 * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1395
+	 *                                 exception is triggered.
1396
+	 */
1397
+	public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1398
+	{
1399
+		$formats = $this->get_formats_for($field_name);
1400
+		$DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1401
+		if ($timestamp) {
1402
+			return $DateTime->format('U');
1403
+		}
1404
+		//not returning timestamp, so return formatted string in timezone.
1405
+		switch ($what) {
1406
+			case 'time' :
1407
+				return $DateTime->format($formats[1]);
1408
+				break;
1409
+			case 'date' :
1410
+				return $DateTime->format($formats[0]);
1411
+				break;
1412
+			default :
1413
+				return $DateTime->format(implode(' ', $formats));
1414
+				break;
1415
+		}
1416
+	}
1417
+
1418
+
1419
+
1420
+	/**
1421
+	 * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1422
+	 * for the model are.  Returns a DateTime object.
1423
+	 * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1424
+	 * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1425
+	 * ignored.
1426
+	 *
1427
+	 * @param string $field_name      The field being setup.
1428
+	 * @param string $timestring      The date time string being used.
1429
+	 * @param string $incoming_format The format for the time string.
1430
+	 * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1431
+	 *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1432
+	 *                                format is
1433
+	 *                                'U', this is ignored.
1434
+	 * @return DateTime
1435
+	 * @throws \EE_Error
1436
+	 */
1437
+	public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1438
+	{
1439
+		//just using this to ensure the timezone is set correctly internally
1440
+		$this->get_formats_for($field_name);
1441
+		//load EEH_DTT_Helper
1442
+		$set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1443
+		$incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1444
+		return $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone));
1445
+	}
1446
+
1447
+
1448
+
1449
+	/**
1450
+	 * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1451
+	 *
1452
+	 * @return EE_Table_Base[]
1453
+	 */
1454
+	public function get_tables()
1455
+	{
1456
+		return $this->_tables;
1457
+	}
1458
+
1459
+
1460
+
1461
+	/**
1462
+	 * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1463
+	 * also updates all the model objects, where the criteria expressed in $query_params are met..
1464
+	 * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1465
+	 * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1466
+	 * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1467
+	 * model object with EVT_ID = 1
1468
+	 * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1469
+	 * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1470
+	 * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1471
+	 * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1472
+	 * are not specified)
1473
+	 *
1474
+	 * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1475
+	 *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1476
+	 *                                         are to be serialized. Basically, the values are what you'd expect to be
1477
+	 *                                         values on the model, NOT necessarily what's in the DB. For example, if
1478
+	 *                                         we wanted to update only the TXN_details on any Transactions where its
1479
+	 *                                         ID=34, we'd use this method as follows:
1480
+	 *                                         EEM_Transaction::instance()->update(
1481
+	 *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1482
+	 *                                         array(array('TXN_ID'=>34)));
1483
+	 * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1484
+	 *                                         in client code into what's expected to be stored on each field. Eg,
1485
+	 *                                         consider updating Question's QST_admin_label field is of type
1486
+	 *                                         Simple_HTML. If you use this function to update that field to $new_value
1487
+	 *                                         = (note replace 8's with appropriate opening and closing tags in the
1488
+	 *                                         following example)"8script8alert('I hack all');8/script88b8boom
1489
+	 *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1490
+	 *                                         TRUE, it is assumed that you've already called
1491
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1492
+	 *                                         malicious javascript. However, if
1493
+	 *                                         $values_already_prepared_by_model_object is left as FALSE, then
1494
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it, and every other field, before insertion. We provide this parameter because model objects perform their prepare_for_set function on all their values, and so don't need to be called again (and in many cases, shouldn't be called again. Eg: if we escape HTML characters in the prepare_for_set method...)
1495
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1496
+	 *                                         in this model's entity map according to $fields_n_values that match
1497
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
1498
+	 *                                         by setting this to FALSE, but be aware that model objects being used
1499
+	 *                                         could get out-of-sync with the database
1500
+	 * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1501
+	 *             rows affected which *could* include 0 which DOES NOT mean the query was bad)
1502
+	 * @throws \EE_Error
1503
+	 */
1504
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1505
+	{
1506
+		if ( ! is_array($query_params)) {
1507
+			EE_Error::doing_it_wrong('EEM_Base::update',
1508
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1509
+					gettype($query_params)), '4.6.0');
1510
+			$query_params = array();
1511
+		}
1512
+		/**
1513
+		 * Action called before a model update call has been made.
1514
+		 *
1515
+		 * @param EEM_Base $model
1516
+		 * @param array    $fields_n_values the updated fields and their new values
1517
+		 * @param array    $query_params    @see EEM_Base::get_all()
1518
+		 */
1519
+		do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1520
+		/**
1521
+		 * Filters the fields about to be updated given the query parameters. You can provide the
1522
+		 * $query_params to $this->get_all() to find exactly which records will be updated
1523
+		 *
1524
+		 * @param array    $fields_n_values fields and their new values
1525
+		 * @param EEM_Base $model           the model being queried
1526
+		 * @param array    $query_params    see EEM_Base::get_all()
1527
+		 */
1528
+		$fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1529
+			$query_params);
1530
+		//need to verify that, for any entry we want to update, there are entries in each secondary table.
1531
+		//to do that, for each table, verify that it's PK isn't null.
1532
+		$tables = $this->get_tables();
1533
+		//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
1534
+		//NOTE: we should make this code more efficient by NOT querying twice
1535
+		//before the real update, but that needs to first go through ALPHA testing
1536
+		//as it's dangerous. says Mike August 8 2014
1537
+		//we want to make sure the default_where strategy is ignored
1538
+		$this->_ignore_where_strategy = true;
1539
+		$wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1540
+		foreach ($wpdb_select_results as $wpdb_result) {
1541
+			// type cast stdClass as array
1542
+			$wpdb_result = (array)$wpdb_result;
1543
+			//get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1544
+			if ($this->has_primary_key_field()) {
1545
+				$main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1546
+			} else {
1547
+				//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)
1548
+				$main_table_pk_value = null;
1549
+			}
1550
+			//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
1551
+			//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
1552
+			if (count($tables) > 1) {
1553
+				//foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1554
+				//in that table, and so we'll want to insert one
1555
+				foreach ($tables as $table_obj) {
1556
+					$this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1557
+					//if there is no private key for this table on the results, it means there's no entry
1558
+					//in this table, right? so insert a row in the current table, using any fields available
1559
+					if ( ! (array_key_exists($this_table_pk_column, $wpdb_result)
1560
+							&& $wpdb_result[$this_table_pk_column])
1561
+					) {
1562
+						$success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1563
+							$main_table_pk_value);
1564
+						//if we died here, report the error
1565
+						if ( ! $success) {
1566
+							return false;
1567
+						}
1568
+					}
1569
+				}
1570
+			}
1571 1571
 //				//and now check that if we have cached any models by that ID on the model, that
1572 1572
 //				//they also get updated properly
1573 1573
 //				$model_object = $this->get_from_entity_map( $main_table_pk_value );
1574 1574
 //				if( $model_object ){
1575 1575
 //					foreach( $fields_n_values as $field => $value ){
1576 1576
 //						$model_object->set($field, $value);
1577
-            //let's make sure default_where strategy is followed now
1578
-            $this->_ignore_where_strategy = false;
1579
-        }
1580
-        //if we want to keep model objects in sync, AND
1581
-        //if this wasn't called from a model object (to update itself)
1582
-        //then we want to make sure we keep all the existing
1583
-        //model objects in sync with the db
1584
-        if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1585
-            if ($this->has_primary_key_field()) {
1586
-                $model_objs_affected_ids = $this->get_col($query_params);
1587
-            } else {
1588
-                //we need to select a bunch of columns and then combine them into the the "index primary key string"s
1589
-                $models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1590
-                $model_objs_affected_ids = array();
1591
-                foreach ($models_affected_key_columns as $row) {
1592
-                    $combined_index_key = $this->get_index_primary_key_string($row);
1593
-                    $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1594
-                }
1595
-            }
1596
-            if ( ! $model_objs_affected_ids) {
1597
-                //wait wait wait- if nothing was affected let's stop here
1598
-                return 0;
1599
-            }
1600
-            foreach ($model_objs_affected_ids as $id) {
1601
-                $model_obj_in_entity_map = $this->get_from_entity_map($id);
1602
-                if ($model_obj_in_entity_map) {
1603
-                    foreach ($fields_n_values as $field => $new_value) {
1604
-                        $model_obj_in_entity_map->set($field, $new_value);
1605
-                    }
1606
-                }
1607
-            }
1608
-            //if there is a primary key on this model, we can now do a slight optimization
1609
-            if ($this->has_primary_key_field()) {
1610
-                //we already know what we want to update. So let's make the query simpler so it's a little more efficient
1611
-                $query_params = array(
1612
-                    array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1613
-                    'limit'                    => count($model_objs_affected_ids),
1614
-                    'default_where_conditions' => 'none',
1615
-                );
1616
-            }
1617
-        }
1618
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1619
-        $SQL = "UPDATE "
1620
-               . $model_query_info->get_full_join_sql()
1621
-               . " SET "
1622
-               . $this->_construct_update_sql($fields_n_values)
1623
-               . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1624
-        $rows_affected = $this->_do_wpdb_query('query', array($SQL));
1625
-        /**
1626
-         * Action called after a model update call has been made.
1627
-         *
1628
-         * @param EEM_Base $model
1629
-         * @param array    $fields_n_values the updated fields and their new values
1630
-         * @param array    $query_params    @see EEM_Base::get_all()
1631
-         * @param int      $rows_affected
1632
-         */
1633
-        do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1634
-        return $rows_affected;//how many supposedly got updated
1635
-    }
1636
-
1637
-
1638
-
1639
-    /**
1640
-     * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1641
-     * are teh values of the field specified (or by default the primary key field)
1642
-     * that matched the query params. Note that you should pass the name of the
1643
-     * model FIELD, not the database table's column name.
1644
-     *
1645
-     * @param array  $query_params @see EEM_Base::get_all()
1646
-     * @param string $field_to_select
1647
-     * @return array just like $wpdb->get_col()
1648
-     * @throws \EE_Error
1649
-     */
1650
-    public function get_col($query_params = array(), $field_to_select = null)
1651
-    {
1652
-        if ($field_to_select) {
1653
-            $field = $this->field_settings_for($field_to_select);
1654
-        } elseif ($this->has_primary_key_field()) {
1655
-            $field = $this->get_primary_key_field();
1656
-        } else {
1657
-            //no primary key, just grab the first column
1658
-            $field = reset($this->field_settings());
1659
-        }
1660
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1661
-        $select_expressions = $field->get_qualified_column();
1662
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1663
-        return $this->_do_wpdb_query('get_col', array($SQL));
1664
-    }
1665
-
1666
-
1667
-
1668
-    /**
1669
-     * Returns a single column value for a single row from the database
1670
-     *
1671
-     * @param array  $query_params    @see EEM_Base::get_all()
1672
-     * @param string $field_to_select @see EEM_Base::get_col()
1673
-     * @return string
1674
-     * @throws \EE_Error
1675
-     */
1676
-    public function get_var($query_params = array(), $field_to_select = null)
1677
-    {
1678
-        $query_params['limit'] = 1;
1679
-        $col = $this->get_col($query_params, $field_to_select);
1680
-        if ( ! empty($col)) {
1681
-            return reset($col);
1682
-        } else {
1683
-            return null;
1684
-        }
1685
-    }
1686
-
1687
-
1688
-
1689
-    /**
1690
-     * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1691
-     * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1692
-     * injection, but currently no further filtering is done
1693
-     *
1694
-     * @global      $wpdb
1695
-     * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1696
-     *                               be updated to in the DB
1697
-     * @return string of SQL
1698
-     * @throws \EE_Error
1699
-     */
1700
-    public function _construct_update_sql($fields_n_values)
1701
-    {
1702
-        /** @type WPDB $wpdb */
1703
-        global $wpdb;
1704
-        $cols_n_values = array();
1705
-        foreach ($fields_n_values as $field_name => $value) {
1706
-            $field_obj = $this->field_settings_for($field_name);
1707
-            //if the value is NULL, we want to assign the value to that.
1708
-            //wpdb->prepare doesn't really handle that properly
1709
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1710
-            $value_sql = $prepared_value === null ? 'NULL'
1711
-                : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1712
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1713
-        }
1714
-        return implode(",", $cols_n_values);
1715
-    }
1716
-
1717
-
1718
-
1719
-    /**
1720
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1721
-     * Performs a HARD delete, meaning the database row should always be removed,
1722
-     * not just have a flag field on it switched
1723
-     * Wrapper for EEM_Base::delete_permanently()
1724
-     *
1725
-     * @param mixed $id
1726
-     * @return boolean whether the row got deleted or not
1727
-     * @throws \EE_Error
1728
-     */
1729
-    public function delete_permanently_by_ID($id)
1730
-    {
1731
-        return $this->delete_permanently(
1732
-            array(
1733
-                array($this->get_primary_key_field()->get_name() => $id),
1734
-                'limit' => 1,
1735
-            )
1736
-        );
1737
-    }
1738
-
1739
-
1740
-
1741
-    /**
1742
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1743
-     * Wrapper for EEM_Base::delete()
1744
-     *
1745
-     * @param mixed $id
1746
-     * @return boolean whether the row got deleted or not
1747
-     * @throws \EE_Error
1748
-     */
1749
-    public function delete_by_ID($id)
1750
-    {
1751
-        return $this->delete(
1752
-            array(
1753
-                array($this->get_primary_key_field()->get_name() => $id),
1754
-                'limit' => 1,
1755
-            )
1756
-        );
1757
-    }
1758
-
1759
-
1760
-
1761
-    /**
1762
-     * Identical to delete_permanently, but does a "soft" delete if possible,
1763
-     * meaning if the model has a field that indicates its been "trashed" or
1764
-     * "soft deleted", we will just set that instead of actually deleting the rows.
1765
-     *
1766
-     * @see EEM_Base::delete_permanently
1767
-     * @param array   $query_params
1768
-     * @param boolean $allow_blocking
1769
-     * @return int how many rows got deleted
1770
-     * @throws \EE_Error
1771
-     */
1772
-    public function delete($query_params, $allow_blocking = true)
1773
-    {
1774
-        return $this->delete_permanently($query_params, $allow_blocking);
1775
-    }
1776
-
1777
-
1778
-
1779
-    /**
1780
-     * Deletes the model objects that meet the query params. Note: this method is overridden
1781
-     * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1782
-     * as archived, not actually deleted
1783
-     *
1784
-     * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1785
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1786
-     *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1787
-     *                                deletes regardless of other objects which may depend on it. Its generally
1788
-     *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1789
-     *                                DB
1790
-     * @return int how many rows got deleted
1791
-     * @throws \EE_Error
1792
-     */
1793
-    public function delete_permanently($query_params, $allow_blocking = true)
1794
-    {
1795
-        /**
1796
-         * Action called just before performing a real deletion query. You can use the
1797
-         * model and its $query_params to find exactly which items will be deleted
1798
-         *
1799
-         * @param EEM_Base $model
1800
-         * @param array    $query_params   @see EEM_Base::get_all()
1801
-         * @param boolean  $allow_blocking whether or not to allow related model objects
1802
-         *                                 to block (prevent) this deletion
1803
-         */
1804
-        do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1805
-        //some MySQL databases may be running safe mode, which may restrict
1806
-        //deletion if there is no KEY column used in the WHERE statement of a deletion.
1807
-        //to get around this, we first do a SELECT, get all the IDs, and then run another query
1808
-        //to delete them
1809
-        $items_for_deletion = $this->_get_all_wpdb_results($query_params);
1810
-        $deletion_where = $this->_setup_ids_for_delete($items_for_deletion, $allow_blocking);
1811
-        if ($deletion_where) {
1812
-            //echo "objects for deletion:";var_dump($objects_for_deletion);
1813
-            $model_query_info = $this->_create_model_query_info_carrier($query_params);
1814
-            $table_aliases = array_keys($this->_tables);
1815
-            $SQL = "DELETE "
1816
-                   . implode(", ", $table_aliases)
1817
-                   . " FROM "
1818
-                   . $model_query_info->get_full_join_sql()
1819
-                   . " WHERE "
1820
-                   . $deletion_where;
1821
-            //		/echo "delete sql:$SQL";
1822
-            $rows_deleted = $this->_do_wpdb_query('query', array($SQL));
1823
-        } else {
1824
-            $rows_deleted = 0;
1825
-        }
1826
-        //and lastly make sure those items are removed from the entity map; if they could be put into it at all
1827
-        if ($this->has_primary_key_field()) {
1828
-            foreach ($items_for_deletion as $item_for_deletion_row) {
1829
-                $pk_value = $item_for_deletion_row[$this->get_primary_key_field()->get_qualified_column()];
1830
-                if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value])) {
1831
-                    unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value]);
1832
-                }
1833
-            }
1834
-        }
1835
-        /**
1836
-         * Action called just after performing a real deletion query. Although at this point the
1837
-         * items should have been deleted
1838
-         *
1839
-         * @param EEM_Base $model
1840
-         * @param array    $query_params @see EEM_Base::get_all()
1841
-         * @param int      $rows_deleted
1842
-         */
1843
-        do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
1844
-        return $rows_deleted;//how many supposedly got deleted
1845
-    }
1846
-
1847
-
1848
-
1849
-    /**
1850
-     * Checks all the relations that throw error messages when there are blocking related objects
1851
-     * for related model objects. If there are any related model objects on those relations,
1852
-     * adds an EE_Error, and return true
1853
-     *
1854
-     * @param EE_Base_Class|int $this_model_obj_or_id
1855
-     * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
1856
-     *                                                 should be ignored when determining whether there are related
1857
-     *                                                 model objects which block this model object's deletion. Useful
1858
-     *                                                 if you know A is related to B and are considering deleting A,
1859
-     *                                                 but want to see if A has any other objects blocking its deletion
1860
-     *                                                 before removing the relation between A and B
1861
-     * @return boolean
1862
-     * @throws \EE_Error
1863
-     */
1864
-    public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
1865
-    {
1866
-        //first, if $ignore_this_model_obj was supplied, get its model
1867
-        if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
1868
-            $ignored_model = $ignore_this_model_obj->get_model();
1869
-        } else {
1870
-            $ignored_model = null;
1871
-        }
1872
-        //now check all the relations of $this_model_obj_or_id and see if there
1873
-        //are any related model objects blocking it?
1874
-        $is_blocked = false;
1875
-        foreach ($this->_model_relations as $relation_name => $relation_obj) {
1876
-            if ($relation_obj->block_delete_if_related_models_exist()) {
1877
-                //if $ignore_this_model_obj was supplied, then for the query
1878
-                //on that model needs to be told to ignore $ignore_this_model_obj
1879
-                if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
1880
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
1881
-                        array(
1882
-                            $ignored_model->get_primary_key_field()->get_name() => array(
1883
-                                '!=',
1884
-                                $ignore_this_model_obj->ID(),
1885
-                            ),
1886
-                        ),
1887
-                    ));
1888
-                } else {
1889
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
1890
-                }
1891
-                if ($related_model_objects) {
1892
-                    EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
1893
-                    $is_blocked = true;
1894
-                }
1895
-            }
1896
-        }
1897
-        return $is_blocked;
1898
-    }
1899
-
1900
-
1901
-
1902
-    /**
1903
-     * This sets up our delete where sql and accounts for if we have secondary tables that will have rows deleted as
1904
-     * well.
1905
-     *
1906
-     * @param  array  $objects_for_deletion This should be the values returned by $this->_get_all_wpdb_results()
1907
-     * @param boolean $allow_blocking       if TRUE, matched objects will only be deleted if there is no related model
1908
-     *                                      info that blocks it (ie, there' sno other data that depends on this data);
1909
-     *                                      if false, deletes regardless of other objects which may depend on it. Its
1910
-     *                                      generally advisable to always leave this as TRUE, otherwise you could
1911
-     *                                      easily corrupt your DB
1912
-     * @throws EE_Error
1913
-     * @return string    everything that comes after the WHERE statement.
1914
-     */
1915
-    protected function _setup_ids_for_delete($objects_for_deletion, $allow_blocking = true)
1916
-    {
1917
-        if ($this->has_primary_key_field()) {
1918
-            $primary_table = $this->_get_main_table();
1919
-            $other_tables = $this->_get_other_tables();
1920
-            $deletes = $query = array();
1921
-            foreach ($objects_for_deletion as $delete_object) {
1922
-                //before we mark this object for deletion,
1923
-                //make sure there's no related objects blocking its deletion (if we're checking)
1924
-                if (
1925
-                    $allow_blocking
1926
-                    && $this->delete_is_blocked_by_related_models(
1927
-                        $delete_object[$primary_table->get_fully_qualified_pk_column()]
1928
-                    )
1929
-                ) {
1930
-                    continue;
1931
-                }
1932
-                //primary table deletes
1933
-                if (isset($delete_object[$primary_table->get_fully_qualified_pk_column()])) {
1934
-                    $deletes[$primary_table->get_fully_qualified_pk_column()][] = $delete_object[$primary_table->get_fully_qualified_pk_column()];
1935
-                }
1936
-                //other tables
1937
-                if ( ! empty($other_tables)) {
1938
-                    foreach ($other_tables as $ot) {
1939
-                        //first check if we've got the foreign key column here.
1940
-                        if (isset($delete_object[$ot->get_fully_qualified_fk_column()])) {
1941
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_fk_column()];
1942
-                        }
1943
-                        // wait! it's entirely possible that we'll have a the primary key
1944
-                        // for this table in here, if it's a foreign key for one of the other secondary tables
1945
-                        if (isset($delete_object[$ot->get_fully_qualified_pk_column()])) {
1946
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
1947
-                        }
1948
-                        // finally, it is possible that the fk for this table is found
1949
-                        // in the fully qualified pk column for the fk table, so let's see if that's there!
1950
-                        if (isset($delete_object[$ot->get_fully_qualified_pk_on_fk_table()])) {
1951
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
1952
-                        }
1953
-                    }
1954
-                }
1955
-            }
1956
-            //we should have deletes now, so let's just go through and setup the where statement
1957
-            foreach ($deletes as $column => $values) {
1958
-                //make sure we have unique $values;
1959
-                $values = array_unique($values);
1960
-                $query[] = $column . ' IN(' . implode(",", $values) . ')';
1961
-            }
1962
-            return ! empty($query) ? implode(' AND ', $query) : '';
1963
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
1964
-            $ways_to_identify_a_row = array();
1965
-            $fields = $this->get_combined_primary_key_fields();
1966
-            //note: because there' sno primary key, that means nothing else  can be pointing to this model, right?
1967
-            foreach ($objects_for_deletion as $delete_object) {
1968
-                $values_for_each_cpk_for_a_row = array();
1969
-                foreach ($fields as $cpk_field) {
1970
-                    if ($cpk_field instanceof EE_Model_Field_Base) {
1971
-                        $values_for_each_cpk_for_a_row[] = $cpk_field->get_qualified_column()
1972
-                                                           . "="
1973
-                                                           . $delete_object[$cpk_field->get_qualified_column()];
1974
-                    }
1975
-                }
1976
-                $ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
1977
-            }
1978
-            return implode(" OR ", $ways_to_identify_a_row);
1979
-        } else {
1980
-            //so there's no primary key and no combined key...
1981
-            //sorry, can't help you
1982
-            throw new EE_Error(sprintf(__("Cannot delete objects of type %s because there is no primary key NOR combined key",
1983
-                "event_espresso"), get_class($this)));
1984
-        }
1985
-    }
1986
-
1987
-
1988
-
1989
-    /**
1990
-     * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
1991
-     * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
1992
-     * column
1993
-     *
1994
-     * @param array  $query_params   like EEM_Base::get_all's
1995
-     * @param string $field_to_count field on model to count by (not column name)
1996
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
1997
-     *                               that by the setting $distinct to TRUE;
1998
-     * @return int
1999
-     * @throws \EE_Error
2000
-     */
2001
-    public function count($query_params = array(), $field_to_count = null, $distinct = false)
2002
-    {
2003
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2004
-        if ($field_to_count) {
2005
-            $field_obj = $this->field_settings_for($field_to_count);
2006
-            $column_to_count = $field_obj->get_qualified_column();
2007
-        } elseif ($this->has_primary_key_field()) {
2008
-            $pk_field_obj = $this->get_primary_key_field();
2009
-            $column_to_count = $pk_field_obj->get_qualified_column();
2010
-        } else {
2011
-            //there's no primary key
2012
-            //if we're counting distinct items, and there's no primary key,
2013
-            //we need to list out the columns for distinction;
2014
-            //otherwise we can just use star
2015
-            if ($distinct) {
2016
-                $columns_to_use = array();
2017
-                foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2018
-                    $columns_to_use[] = $field_obj->get_qualified_column();
2019
-                }
2020
-                $column_to_count = implode(',', $columns_to_use);
2021
-            } else {
2022
-                $column_to_count = '*';
2023
-            }
2024
-        }
2025
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2026
-        $SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2027
-        return (int)$this->_do_wpdb_query('get_var', array($SQL));
2028
-    }
2029
-
2030
-
2031
-
2032
-    /**
2033
-     * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2034
-     *
2035
-     * @param array  $query_params like EEM_Base::get_all
2036
-     * @param string $field_to_sum name of field (array key in $_fields array)
2037
-     * @return float
2038
-     * @throws \EE_Error
2039
-     */
2040
-    public function sum($query_params, $field_to_sum = null)
2041
-    {
2042
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2043
-        if ($field_to_sum) {
2044
-            $field_obj = $this->field_settings_for($field_to_sum);
2045
-        } else {
2046
-            $field_obj = $this->get_primary_key_field();
2047
-        }
2048
-        $column_to_count = $field_obj->get_qualified_column();
2049
-        $SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2050
-        $return_value = $this->_do_wpdb_query('get_var', array($SQL));
2051
-        $data_type = $field_obj->get_wpdb_data_type();
2052
-        if ($data_type === '%d' || $data_type === '%s') {
2053
-            return (float)$return_value;
2054
-        } else {//must be %f
2055
-            return (float)$return_value;
2056
-        }
2057
-    }
2058
-
2059
-
2060
-
2061
-    /**
2062
-     * Just calls the specified method on $wpdb with the given arguments
2063
-     * Consolidates a little extra error handling code
2064
-     *
2065
-     * @param string $wpdb_method
2066
-     * @param array  $arguments_to_provide
2067
-     * @throws EE_Error
2068
-     * @global wpdb  $wpdb
2069
-     * @return mixed
2070
-     */
2071
-    protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2072
-    {
2073
-        //if we're in maintenance mode level 2, DON'T run any queries
2074
-        //because level 2 indicates the database needs updating and
2075
-        //is probably out of sync with the code
2076
-        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
2077
-            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.",
2078
-                "event_espresso")));
2079
-        }
2080
-        /** @type WPDB $wpdb */
2081
-        global $wpdb;
2082
-        if ( ! method_exists($wpdb, $wpdb_method)) {
2083
-            throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2084
-                'event_espresso'), $wpdb_method));
2085
-        }
2086
-        if (WP_DEBUG) {
2087
-            $old_show_errors_value = $wpdb->show_errors;
2088
-            $wpdb->show_errors(false);
2089
-        }
2090
-        $result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2091
-        $this->show_db_query_if_previously_requested($wpdb->last_query);
2092
-        if (WP_DEBUG) {
2093
-            $wpdb->show_errors($old_show_errors_value);
2094
-            if ( ! empty($wpdb->last_error)) {
2095
-                throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2096
-            } elseif ($result === false) {
2097
-                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"',
2098
-                    'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2099
-            }
2100
-        } elseif ($result === false) {
2101
-            EE_Error::add_error(
2102
-                sprintf(
2103
-                    __('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"',
2104
-                        'event_espresso'),
2105
-                    $wpdb_method,
2106
-                    var_export($arguments_to_provide, true),
2107
-                    $wpdb->last_error
2108
-                ),
2109
-                __FILE__,
2110
-                __FUNCTION__,
2111
-                __LINE__
2112
-            );
2113
-        }
2114
-        return $result;
2115
-    }
2116
-
2117
-
2118
-
2119
-    /**
2120
-     * Attempts to run the indicated WPDB method with the provided arguments,
2121
-     * and if there's an error tries to verify the DB is correct. Uses
2122
-     * the static property EEM_Base::$_db_verification_level to determine whether
2123
-     * we should try to fix the EE core db, the addons, or just give up
2124
-     *
2125
-     * @param string $wpdb_method
2126
-     * @param array  $arguments_to_provide
2127
-     * @return mixed
2128
-     */
2129
-    private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2130
-    {
2131
-        /** @type WPDB $wpdb */
2132
-        global $wpdb;
2133
-        $wpdb->last_error = null;
2134
-        $result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2135
-        // was there an error running the query? but we don't care on new activations
2136
-        // (we're going to setup the DB anyway on new activations)
2137
-        if (($result === false || ! empty($wpdb->last_error))
2138
-            && EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2139
-        ) {
2140
-            switch (EEM_Base::$_db_verification_level) {
2141
-                case EEM_Base::db_verified_none :
2142
-                    // let's double-check core's DB
2143
-                    $error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2144
-                    break;
2145
-                case EEM_Base::db_verified_core :
2146
-                    // STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2147
-                    $error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2148
-                    break;
2149
-                case EEM_Base::db_verified_addons :
2150
-                    // ummmm... you in trouble
2151
-                    return $result;
2152
-                    break;
2153
-            }
2154
-            if ( ! empty($error_message)) {
2155
-                EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2156
-                trigger_error($error_message);
2157
-            }
2158
-            return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2159
-        }
2160
-        return $result;
2161
-    }
2162
-
2163
-
2164
-
2165
-    /**
2166
-     * Verifies the EE core database is up-to-date and records that we've done it on
2167
-     * EEM_Base::$_db_verification_level
2168
-     *
2169
-     * @param string $wpdb_method
2170
-     * @param array  $arguments_to_provide
2171
-     * @return string
2172
-     */
2173
-    private function _verify_core_db($wpdb_method, $arguments_to_provide)
2174
-    {
2175
-        /** @type WPDB $wpdb */
2176
-        global $wpdb;
2177
-        //ok remember that we've already attempted fixing the core db, in case the problem persists
2178
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2179
-        $error_message = sprintf(
2180
-            __('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2181
-                'event_espresso'),
2182
-            $wpdb->last_error,
2183
-            $wpdb_method,
2184
-            json_encode($arguments_to_provide)
2185
-        );
2186
-        EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2187
-        return $error_message;
2188
-    }
2189
-
2190
-
2191
-
2192
-    /**
2193
-     * Verifies the EE addons' database is up-to-date and records that we've done it on
2194
-     * EEM_Base::$_db_verification_level
2195
-     *
2196
-     * @param $wpdb_method
2197
-     * @param $arguments_to_provide
2198
-     * @return string
2199
-     */
2200
-    private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2201
-    {
2202
-        /** @type WPDB $wpdb */
2203
-        global $wpdb;
2204
-        //ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2205
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2206
-        $error_message = sprintf(
2207
-            __('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2208
-                'event_espresso'),
2209
-            $wpdb->last_error,
2210
-            $wpdb_method,
2211
-            json_encode($arguments_to_provide)
2212
-        );
2213
-        EE_System::instance()->initialize_addons();
2214
-        return $error_message;
2215
-    }
2216
-
2217
-
2218
-
2219
-    /**
2220
-     * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2221
-     * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2222
-     * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2223
-     * ..."
2224
-     *
2225
-     * @param EE_Model_Query_Info_Carrier $model_query_info
2226
-     * @return string
2227
-     */
2228
-    private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2229
-    {
2230
-        return " FROM " . $model_query_info->get_full_join_sql() .
2231
-               $model_query_info->get_where_sql() .
2232
-               $model_query_info->get_group_by_sql() .
2233
-               $model_query_info->get_having_sql() .
2234
-               $model_query_info->get_order_by_sql() .
2235
-               $model_query_info->get_limit_sql();
2236
-    }
2237
-
2238
-
2239
-
2240
-    /**
2241
-     * Set to easily debug the next X queries ran from this model.
2242
-     *
2243
-     * @param int $count
2244
-     */
2245
-    public function show_next_x_db_queries($count = 1)
2246
-    {
2247
-        $this->_show_next_x_db_queries = $count;
2248
-    }
2249
-
2250
-
2251
-
2252
-    /**
2253
-     * @param $sql_query
2254
-     */
2255
-    public function show_db_query_if_previously_requested($sql_query)
2256
-    {
2257
-        if ($this->_show_next_x_db_queries > 0) {
2258
-            echo $sql_query;
2259
-            $this->_show_next_x_db_queries--;
2260
-        }
2261
-    }
2262
-
2263
-
2264
-
2265
-    /**
2266
-     * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2267
-     * There are the 3 cases:
2268
-     * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2269
-     * $otherModelObject has no ID, it is first saved.
2270
-     * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2271
-     * has no ID, it is first saved.
2272
-     * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2273
-     * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2274
-     * join table
2275
-     *
2276
-     * @param        EE_Base_Class                     /int $thisModelObject
2277
-     * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2278
-     * @param string $relationName                     , key in EEM_Base::_relations
2279
-     *                                                 an attendee to a group, you also want to specify which role they
2280
-     *                                                 will have in that group. So you would use this parameter to
2281
-     *                                                 specify array('role-column-name'=>'role-id')
2282
-     * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2283
-     *                                                 to for relation to methods that allow you to further specify
2284
-     *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2285
-     *                                                 only acceptable query_params is strict "col" => "value" pairs
2286
-     *                                                 because these will be inserted in any new rows created as well.
2287
-     * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2288
-     * @throws \EE_Error
2289
-     */
2290
-    public function add_relationship_to(
2291
-        $id_or_obj,
2292
-        $other_model_id_or_obj,
2293
-        $relationName,
2294
-        $extra_join_model_fields_n_values = array()
2295
-    ) {
2296
-        $relation_obj = $this->related_settings_for($relationName);
2297
-        return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2298
-    }
2299
-
2300
-
2301
-
2302
-    /**
2303
-     * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2304
-     * There are the 3 cases:
2305
-     * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2306
-     * error
2307
-     * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2308
-     * an error
2309
-     * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2310
-     *
2311
-     * @param        EE_Base_Class /int $id_or_obj
2312
-     * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2313
-     * @param string $relationName key in EEM_Base::_relations
2314
-     * @return boolean of success
2315
-     * @throws \EE_Error
2316
-     * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2317
-     *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2318
-     *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2319
-     *                             because these will be inserted in any new rows created as well.
2320
-     */
2321
-    public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2322
-    {
2323
-        $relation_obj = $this->related_settings_for($relationName);
2324
-        return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2325
-    }
2326
-
2327
-
2328
-
2329
-    /**
2330
-     * @param mixed           $id_or_obj
2331
-     * @param string          $relationName
2332
-     * @param array           $where_query_params
2333
-     * @param EE_Base_Class[] objects to which relations were removed
2334
-     * @return \EE_Base_Class[]
2335
-     * @throws \EE_Error
2336
-     */
2337
-    public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2338
-    {
2339
-        $relation_obj = $this->related_settings_for($relationName);
2340
-        return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2341
-    }
2342
-
2343
-
2344
-
2345
-    /**
2346
-     * Gets all the related items of the specified $model_name, using $query_params.
2347
-     * Note: by default, we remove the "default query params"
2348
-     * because we want to get even deleted items etc.
2349
-     *
2350
-     * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2351
-     * @param string $model_name   like 'Event', 'Registration', etc. always singular
2352
-     * @param array  $query_params like EEM_Base::get_all
2353
-     * @return EE_Base_Class[]
2354
-     * @throws \EE_Error
2355
-     */
2356
-    public function get_all_related($id_or_obj, $model_name, $query_params = null)
2357
-    {
2358
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2359
-        $relation_settings = $this->related_settings_for($model_name);
2360
-        return $relation_settings->get_all_related($model_obj, $query_params);
2361
-    }
2362
-
2363
-
2364
-
2365
-    /**
2366
-     * Deletes all the model objects across the relation indicated by $model_name
2367
-     * which are related to $id_or_obj which meet the criteria set in $query_params.
2368
-     * However, if the model objects can't be deleted because of blocking related model objects, then
2369
-     * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2370
-     *
2371
-     * @param EE_Base_Class|int|string $id_or_obj
2372
-     * @param string                   $model_name
2373
-     * @param array                    $query_params
2374
-     * @return int how many deleted
2375
-     * @throws \EE_Error
2376
-     */
2377
-    public function delete_related($id_or_obj, $model_name, $query_params = array())
2378
-    {
2379
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2380
-        $relation_settings = $this->related_settings_for($model_name);
2381
-        return $relation_settings->delete_all_related($model_obj, $query_params);
2382
-    }
2383
-
2384
-
2385
-
2386
-    /**
2387
-     * Hard deletes all the model objects across the relation indicated by $model_name
2388
-     * which are related to $id_or_obj which meet the criteria set in $query_params. If
2389
-     * the model objects can't be hard deleted because of blocking related model objects,
2390
-     * just does a soft-delete on them instead.
2391
-     *
2392
-     * @param EE_Base_Class|int|string $id_or_obj
2393
-     * @param string                   $model_name
2394
-     * @param array                    $query_params
2395
-     * @return int how many deleted
2396
-     * @throws \EE_Error
2397
-     */
2398
-    public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2399
-    {
2400
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2401
-        $relation_settings = $this->related_settings_for($model_name);
2402
-        return $relation_settings->delete_related_permanently($model_obj, $query_params);
2403
-    }
2404
-
2405
-
2406
-
2407
-    /**
2408
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2409
-     * unless otherwise specified in the $query_params
2410
-     *
2411
-     * @param        int             /EE_Base_Class $id_or_obj
2412
-     * @param string $model_name     like 'Event', or 'Registration'
2413
-     * @param array  $query_params   like EEM_Base::get_all's
2414
-     * @param string $field_to_count name of field to count by. By default, uses primary key
2415
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2416
-     *                               that by the setting $distinct to TRUE;
2417
-     * @return int
2418
-     * @throws \EE_Error
2419
-     */
2420
-    public function count_related(
2421
-        $id_or_obj,
2422
-        $model_name,
2423
-        $query_params = array(),
2424
-        $field_to_count = null,
2425
-        $distinct = false
2426
-    ) {
2427
-        $related_model = $this->get_related_model_obj($model_name);
2428
-        //we're just going to use the query params on the related model's normal get_all query,
2429
-        //except add a condition to say to match the current mod
2430
-        if ( ! isset($query_params['default_where_conditions'])) {
2431
-            $query_params['default_where_conditions'] = 'none';
2432
-        }
2433
-        $this_model_name = $this->get_this_model_name();
2434
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2435
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2436
-        return $related_model->count($query_params, $field_to_count, $distinct);
2437
-    }
2438
-
2439
-
2440
-
2441
-    /**
2442
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
2443
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2444
-     *
2445
-     * @param        int           /EE_Base_Class $id_or_obj
2446
-     * @param string $model_name   like 'Event', or 'Registration'
2447
-     * @param array  $query_params like EEM_Base::get_all's
2448
-     * @param string $field_to_sum name of field to count by. By default, uses primary key
2449
-     * @return float
2450
-     * @throws \EE_Error
2451
-     */
2452
-    public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2453
-    {
2454
-        $related_model = $this->get_related_model_obj($model_name);
2455
-        if ( ! is_array($query_params)) {
2456
-            EE_Error::doing_it_wrong('EEM_Base::sum_related',
2457
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2458
-                    gettype($query_params)), '4.6.0');
2459
-            $query_params = array();
2460
-        }
2461
-        //we're just going to use the query params on the related model's normal get_all query,
2462
-        //except add a condition to say to match the current mod
2463
-        if ( ! isset($query_params['default_where_conditions'])) {
2464
-            $query_params['default_where_conditions'] = 'none';
2465
-        }
2466
-        $this_model_name = $this->get_this_model_name();
2467
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2468
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2469
-        return $related_model->sum($query_params, $field_to_sum);
2470
-    }
2471
-
2472
-
2473
-
2474
-    /**
2475
-     * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2476
-     * $modelObject
2477
-     *
2478
-     * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2479
-     * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2480
-     * @param array               $query_params     like EEM_Base::get_all's
2481
-     * @return EE_Base_Class
2482
-     * @throws \EE_Error
2483
-     */
2484
-    public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2485
-    {
2486
-        $query_params['limit'] = 1;
2487
-        $results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2488
-        if ($results) {
2489
-            return array_shift($results);
2490
-        } else {
2491
-            return null;
2492
-        }
2493
-    }
2494
-
2495
-
2496
-
2497
-    /**
2498
-     * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2499
-     *
2500
-     * @return string
2501
-     */
2502
-    public function get_this_model_name()
2503
-    {
2504
-        return str_replace("EEM_", "", get_class($this));
2505
-    }
2506
-
2507
-
2508
-
2509
-    /**
2510
-     * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2511
-     *
2512
-     * @return EE_Any_Foreign_Model_Name_Field
2513
-     * @throws EE_Error
2514
-     */
2515
-    public function get_field_containing_related_model_name()
2516
-    {
2517
-        foreach ($this->field_settings(true) as $field) {
2518
-            if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2519
-                $field_with_model_name = $field;
2520
-            }
2521
-        }
2522
-        if ( ! isset($field_with_model_name) || ! $field_with_model_name) {
2523
-            throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2524
-                $this->get_this_model_name()));
2525
-        }
2526
-        return $field_with_model_name;
2527
-    }
2528
-
2529
-
2530
-
2531
-    /**
2532
-     * Inserts a new entry into the database, for each table.
2533
-     * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2534
-     * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2535
-     * we also know there is no model object with the newly inserted item's ID at the moment (because
2536
-     * if there were, then they would already be in the DB and this would fail); and in the future if someone
2537
-     * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2538
-     * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2539
-     *
2540
-     * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2541
-     *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2542
-     *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2543
-     *                              of EEM_Base)
2544
-     * @return int new primary key on main table that got inserted
2545
-     * @throws EE_Error
2546
-     */
2547
-    public function insert($field_n_values)
2548
-    {
2549
-        /**
2550
-         * Filters the fields and their values before inserting an item using the models
2551
-         *
2552
-         * @param array    $fields_n_values keys are the fields and values are their new values
2553
-         * @param EEM_Base $model           the model used
2554
-         */
2555
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2556
-        if ($this->_satisfies_unique_indexes($field_n_values)) {
2557
-            $main_table = $this->_get_main_table();
2558
-            $new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2559
-            if ($new_id !== false) {
2560
-                foreach ($this->_get_other_tables() as $other_table) {
2561
-                    $this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2562
-                }
2563
-            }
2564
-            /**
2565
-             * Done just after attempting to insert a new model object
2566
-             *
2567
-             * @param EEM_Base   $model           used
2568
-             * @param array      $fields_n_values fields and their values
2569
-             * @param int|string the              ID of the newly-inserted model object
2570
-             */
2571
-            do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2572
-            return $new_id;
2573
-        } else {
2574
-            return false;
2575
-        }
2576
-    }
2577
-
2578
-
2579
-
2580
-    /**
2581
-     * Checks that the result would satisfy the unique indexes on this model
2582
-     *
2583
-     * @param array  $field_n_values
2584
-     * @param string $action
2585
-     * @return boolean
2586
-     * @throws \EE_Error
2587
-     */
2588
-    protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2589
-    {
2590
-        foreach ($this->unique_indexes() as $index_name => $index) {
2591
-            $uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2592
-            if ($this->exists(array($uniqueness_where_params))) {
2593
-                EE_Error::add_error(
2594
-                    sprintf(
2595
-                        __(
2596
-                            "Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2597
-                            "event_espresso"
2598
-                        ),
2599
-                        $action,
2600
-                        $this->_get_class_name(),
2601
-                        $index_name,
2602
-                        implode(",", $index->field_names()),
2603
-                        http_build_query($uniqueness_where_params)
2604
-                    ),
2605
-                    __FILE__,
2606
-                    __FUNCTION__,
2607
-                    __LINE__
2608
-                );
2609
-                return false;
2610
-            }
2611
-        }
2612
-        return true;
2613
-    }
2614
-
2615
-
2616
-
2617
-    /**
2618
-     * Checks the database for an item that conflicts (ie, if this item were
2619
-     * saved to the DB would break some uniqueness requirement, like a primary key
2620
-     * or an index primary key set) with the item specified. $id_obj_or_fields_array
2621
-     * can be either an EE_Base_Class or an array of fields n values
2622
-     *
2623
-     * @param EE_Base_Class|array $obj_or_fields_array
2624
-     * @param boolean             $include_primary_key whether to use the model object's primary key
2625
-     *                                                 when looking for conflicts
2626
-     *                                                 (ie, if false, we ignore the model object's primary key
2627
-     *                                                 when finding "conflicts". If true, it's also considered).
2628
-     *                                                 Only works for INT primary key,
2629
-     *                                                 STRING primary keys cannot be ignored
2630
-     * @throws EE_Error
2631
-     * @return EE_Base_Class|array
2632
-     */
2633
-    public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2634
-    {
2635
-        if ($obj_or_fields_array instanceof EE_Base_Class) {
2636
-            $fields_n_values = $obj_or_fields_array->model_field_array();
2637
-        } elseif (is_array($obj_or_fields_array)) {
2638
-            $fields_n_values = $obj_or_fields_array;
2639
-        } else {
2640
-            throw new EE_Error(
2641
-                sprintf(
2642
-                    __(
2643
-                        "%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2644
-                        "event_espresso"
2645
-                    ),
2646
-                    get_class($this),
2647
-                    $obj_or_fields_array
2648
-                )
2649
-            );
2650
-        }
2651
-        $query_params = array();
2652
-        if ($this->has_primary_key_field()
2653
-            && ($include_primary_key
2654
-                || $this->get_primary_key_field()
2655
-                   instanceof
2656
-                   EE_Primary_Key_String_Field)
2657
-            && isset($fields_n_values[$this->primary_key_name()])
2658
-        ) {
2659
-            $query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2660
-        }
2661
-        foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2662
-            $uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2663
-            $query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2664
-        }
2665
-        //if there is nothing to base this search on, then we shouldn't find anything
2666
-        if (empty($query_params)) {
2667
-            return array();
2668
-        } else {
2669
-            return $this->get_one($query_params);
2670
-        }
2671
-    }
2672
-
2673
-
2674
-
2675
-    /**
2676
-     * Like count, but is optimized and returns a boolean instead of an int
2677
-     *
2678
-     * @param array $query_params
2679
-     * @return boolean
2680
-     * @throws \EE_Error
2681
-     */
2682
-    public function exists($query_params)
2683
-    {
2684
-        $query_params['limit'] = 1;
2685
-        return $this->count($query_params) > 0;
2686
-    }
2687
-
2688
-
2689
-
2690
-    /**
2691
-     * Wrapper for exists, except ignores default query parameters so we're only considering ID
2692
-     *
2693
-     * @param int|string $id
2694
-     * @return boolean
2695
-     * @throws \EE_Error
2696
-     */
2697
-    public function exists_by_ID($id)
2698
-    {
2699
-        return $this->exists(array('default_where_conditions' => 'none', array($this->primary_key_name() => $id)));
2700
-    }
2701
-
2702
-
2703
-
2704
-    /**
2705
-     * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2706
-     * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2707
-     * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2708
-     * on the main table)
2709
-     * This is protected rather than private because private is not accessible to any child methods and there MAY be
2710
-     * cases where we want to call it directly rather than via insert().
2711
-     *
2712
-     * @access   protected
2713
-     * @param EE_Table_Base $table
2714
-     * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2715
-     *                                       float
2716
-     * @param int           $new_id          for now we assume only int keys
2717
-     * @throws EE_Error
2718
-     * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2719
-     * @return int ID of new row inserted, or FALSE on failure
2720
-     */
2721
-    protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2722
-    {
2723
-        global $wpdb;
2724
-        $insertion_col_n_values = array();
2725
-        $format_for_insertion = array();
2726
-        $fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2727
-        foreach ($fields_on_table as $field_name => $field_obj) {
2728
-            //check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2729
-            if ($field_obj->is_auto_increment()) {
2730
-                continue;
2731
-            }
2732
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2733
-            //if the value we want to assign it to is NULL, just don't mention it for the insertion
2734
-            if ($prepared_value !== null) {
2735
-                $insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2736
-                $format_for_insertion[] = $field_obj->get_wpdb_data_type();
2737
-            }
2738
-        }
2739
-        if ($table instanceof EE_Secondary_Table && $new_id) {
2740
-            //its not the main table, so we should have already saved the main table's PK which we just inserted
2741
-            //so add the fk to the main table as a column
2742
-            $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2743
-            $format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2744
-        }
2745
-        //insert the new entry
2746
-        $result = $this->_do_wpdb_query('insert',
2747
-            array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2748
-        if ($result === false) {
2749
-            return false;
2750
-        }
2751
-        //ok, now what do we return for the ID of the newly-inserted thing?
2752
-        if ($this->has_primary_key_field()) {
2753
-            if ($this->get_primary_key_field()->is_auto_increment()) {
2754
-                return $wpdb->insert_id;
2755
-            } else {
2756
-                //it's not an auto-increment primary key, so
2757
-                //it must have been supplied
2758
-                return $fields_n_values[$this->get_primary_key_field()->get_name()];
2759
-            }
2760
-        } else {
2761
-            //we can't return a  primary key because there is none. instead return
2762
-            //a unique string indicating this model
2763
-            return $this->get_index_primary_key_string($fields_n_values);
2764
-        }
2765
-    }
2766
-
2767
-
2768
-
2769
-    /**
2770
-     * Prepare the $field_obj 's value in $fields_n_values for use in the database.
2771
-     * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
2772
-     * and there is no default, we pass it along. WPDB will take care of it)
2773
-     *
2774
-     * @param EE_Model_Field_Base $field_obj
2775
-     * @param array               $fields_n_values
2776
-     * @return mixed string|int|float depending on what the table column will be expecting
2777
-     * @throws \EE_Error
2778
-     */
2779
-    protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
2780
-    {
2781
-        //if this field doesn't allow nullable, don't allow it
2782
-        if ( ! $field_obj->is_nullable()
2783
-             && (
2784
-                 ! isset($fields_n_values[$field_obj->get_name()]) || $fields_n_values[$field_obj->get_name()] === null)
2785
-        ) {
2786
-            $fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
2787
-        }
2788
-        $unprepared_value = isset($fields_n_values[$field_obj->get_name()]) ? $fields_n_values[$field_obj->get_name()]
2789
-            : null;
2790
-        return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
2791
-    }
2792
-
2793
-
2794
-
2795
-    /**
2796
-     * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
2797
-     * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
2798
-     * the field's prepare_for_set() method.
2799
-     *
2800
-     * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
2801
-     *                                   false, otherwise a value in the model object's domain (see lengthy comment at
2802
-     *                                   top of file)
2803
-     * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
2804
-     *                                   $value is a custom selection
2805
-     * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
2806
-     */
2807
-    private function _prepare_value_for_use_in_db($value, $field)
2808
-    {
2809
-        if ($field && $field instanceof EE_Model_Field_Base) {
2810
-            switch ($this->_values_already_prepared_by_model_object) {
2811
-                /** @noinspection PhpMissingBreakStatementInspection */
2812
-                case self::not_prepared_by_model_object:
2813
-                    $value = $field->prepare_for_set($value);
2814
-                //purposefully left out "return"
2815
-                case self::prepared_by_model_object:
2816
-                    $value = $field->prepare_for_use_in_db($value);
2817
-                case self::prepared_for_use_in_db:
2818
-                    //leave the value alone
2819
-            }
2820
-            return $value;
2821
-        } else {
2822
-            return $value;
2823
-        }
2824
-    }
2825
-
2826
-
2827
-
2828
-    /**
2829
-     * Returns the main table on this model
2830
-     *
2831
-     * @return EE_Primary_Table
2832
-     * @throws EE_Error
2833
-     */
2834
-    protected function _get_main_table()
2835
-    {
2836
-        foreach ($this->_tables as $table) {
2837
-            if ($table instanceof EE_Primary_Table) {
2838
-                return $table;
2839
-            }
2840
-        }
2841
-        throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
2842
-            'event_espresso'), get_class($this)));
2843
-    }
2844
-
2845
-
2846
-
2847
-    /**
2848
-     * table
2849
-     * returns EE_Primary_Table table name
2850
-     *
2851
-     * @return string
2852
-     * @throws \EE_Error
2853
-     */
2854
-    public function table()
2855
-    {
2856
-        return $this->_get_main_table()->get_table_name();
2857
-    }
2858
-
2859
-
2860
-
2861
-    /**
2862
-     * table
2863
-     * returns first EE_Secondary_Table table name
2864
-     *
2865
-     * @return string
2866
-     */
2867
-    public function second_table()
2868
-    {
2869
-        // grab second table from tables array
2870
-        $second_table = end($this->_tables);
2871
-        return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
2872
-    }
2873
-
2874
-
2875
-
2876
-    /**
2877
-     * get_table_obj_by_alias
2878
-     * returns table name given it's alias
2879
-     *
2880
-     * @param string $table_alias
2881
-     * @return EE_Primary_Table | EE_Secondary_Table
2882
-     */
2883
-    public function get_table_obj_by_alias($table_alias = '')
2884
-    {
2885
-        return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
2886
-    }
2887
-
2888
-
2889
-
2890
-    /**
2891
-     * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
2892
-     *
2893
-     * @return EE_Secondary_Table[]
2894
-     */
2895
-    protected function _get_other_tables()
2896
-    {
2897
-        $other_tables = array();
2898
-        foreach ($this->_tables as $table_alias => $table) {
2899
-            if ($table instanceof EE_Secondary_Table) {
2900
-                $other_tables[$table_alias] = $table;
2901
-            }
2902
-        }
2903
-        return $other_tables;
2904
-    }
2905
-
2906
-
2907
-
2908
-    /**
2909
-     * Finds all the fields that correspond to the given table
2910
-     *
2911
-     * @param string $table_alias , array key in EEM_Base::_tables
2912
-     * @return EE_Model_Field_Base[]
2913
-     */
2914
-    public function _get_fields_for_table($table_alias)
2915
-    {
2916
-        return $this->_fields[$table_alias];
2917
-    }
2918
-
2919
-
2920
-
2921
-    /**
2922
-     * Recurses through all the where parameters, and finds all the related models we'll need
2923
-     * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
2924
-     * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
2925
-     * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
2926
-     * related Registration, Transaction, and Payment models.
2927
-     *
2928
-     * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
2929
-     * @return EE_Model_Query_Info_Carrier
2930
-     * @throws \EE_Error
2931
-     */
2932
-    public function _extract_related_models_from_query($query_params)
2933
-    {
2934
-        $query_info_carrier = new EE_Model_Query_Info_Carrier();
2935
-        if (array_key_exists(0, $query_params)) {
2936
-            $this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
2937
-        }
2938
-        if (array_key_exists('group_by', $query_params)) {
2939
-            if (is_array($query_params['group_by'])) {
2940
-                $this->_extract_related_models_from_sub_params_array_values(
2941
-                    $query_params['group_by'],
2942
-                    $query_info_carrier,
2943
-                    'group_by'
2944
-                );
2945
-            } elseif ( ! empty ($query_params['group_by'])) {
2946
-                $this->_extract_related_model_info_from_query_param(
2947
-                    $query_params['group_by'],
2948
-                    $query_info_carrier,
2949
-                    'group_by'
2950
-                );
2951
-            }
2952
-        }
2953
-        if (array_key_exists('having', $query_params)) {
2954
-            $this->_extract_related_models_from_sub_params_array_keys(
2955
-                $query_params[0],
2956
-                $query_info_carrier,
2957
-                'having'
2958
-            );
2959
-        }
2960
-        if (array_key_exists('order_by', $query_params)) {
2961
-            if (is_array($query_params['order_by'])) {
2962
-                $this->_extract_related_models_from_sub_params_array_keys(
2963
-                    $query_params['order_by'],
2964
-                    $query_info_carrier,
2965
-                    'order_by'
2966
-                );
2967
-            } elseif ( ! empty($query_params['order_by'])) {
2968
-                $this->_extract_related_model_info_from_query_param(
2969
-                    $query_params['order_by'],
2970
-                    $query_info_carrier,
2971
-                    'order_by'
2972
-                );
2973
-            }
2974
-        }
2975
-        if (array_key_exists('force_join', $query_params)) {
2976
-            $this->_extract_related_models_from_sub_params_array_values(
2977
-                $query_params['force_join'],
2978
-                $query_info_carrier,
2979
-                'force_join'
2980
-            );
2981
-        }
2982
-        return $query_info_carrier;
2983
-    }
2984
-
2985
-
2986
-
2987
-    /**
2988
-     * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
2989
-     *
2990
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
2991
-     *                                                      $query_params['having']
2992
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
2993
-     * @param string                      $query_param_type one of $this->_allowed_query_params
2994
-     * @throws EE_Error
2995
-     * @return \EE_Model_Query_Info_Carrier
2996
-     */
2997
-    private function _extract_related_models_from_sub_params_array_keys(
2998
-        $sub_query_params,
2999
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3000
-        $query_param_type
3001
-    ) {
3002
-        if ( ! empty($sub_query_params)) {
3003
-            $sub_query_params = (array)$sub_query_params;
3004
-            foreach ($sub_query_params as $param => $possibly_array_of_params) {
3005
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3006
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3007
-                    $query_param_type);
3008
-                //if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3009
-                //indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3010
-                //extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3011
-                //of array('Registration.TXN_ID'=>23)
3012
-                $query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3013
-                if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3014
-                    if ( ! is_array($possibly_array_of_params)) {
3015
-                        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'))",
3016
-                            "event_espresso"),
3017
-                            $param, $possibly_array_of_params));
3018
-                    } else {
3019
-                        $this->_extract_related_models_from_sub_params_array_keys($possibly_array_of_params,
3020
-                            $model_query_info_carrier, $query_param_type);
3021
-                    }
3022
-                } elseif ($query_param_type === 0 //ie WHERE
3023
-                          && is_array($possibly_array_of_params)
3024
-                          && isset($possibly_array_of_params[2])
3025
-                          && $possibly_array_of_params[2] == true
3026
-                ) {
3027
-                    //then $possible_array_of_params looks something like array('<','DTT_sold',true)
3028
-                    //indicating that $possible_array_of_params[1] is actually a field name,
3029
-                    //from which we should extract query parameters!
3030
-                    if ( ! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3031
-                        throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3032
-                            "event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3033
-                    }
3034
-                    $this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3035
-                        $model_query_info_carrier, $query_param_type);
3036
-                }
3037
-            }
3038
-        }
3039
-        return $model_query_info_carrier;
3040
-    }
3041
-
3042
-
3043
-
3044
-    /**
3045
-     * For extracting related models from forced_joins, where the array values contain the info about what
3046
-     * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3047
-     *
3048
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3049
-     *                                                      $query_params['having']
3050
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3051
-     * @param string                      $query_param_type one of $this->_allowed_query_params
3052
-     * @throws EE_Error
3053
-     * @return \EE_Model_Query_Info_Carrier
3054
-     */
3055
-    private function _extract_related_models_from_sub_params_array_values(
3056
-        $sub_query_params,
3057
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3058
-        $query_param_type
3059
-    ) {
3060
-        if ( ! empty($sub_query_params)) {
3061
-            if ( ! is_array($sub_query_params)) {
3062
-                throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3063
-                    $sub_query_params));
3064
-            }
3065
-            foreach ($sub_query_params as $param) {
3066
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3067
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3068
-                    $query_param_type);
3069
-            }
3070
-        }
3071
-        return $model_query_info_carrier;
3072
-    }
3073
-
3074
-
3075
-
3076
-    /**
3077
-     * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3078
-     * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3079
-     * instead of directly constructing the SQL because often we need to extract info from the $query_params
3080
-     * but use them in a different order. Eg, we need to know what models we are querying
3081
-     * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3082
-     * other models before we can finalize the where clause SQL.
3083
-     *
3084
-     * @param array $query_params
3085
-     * @throws EE_Error
3086
-     * @return EE_Model_Query_Info_Carrier
3087
-     */
3088
-    public function _create_model_query_info_carrier($query_params)
3089
-    {
3090
-        if ( ! is_array($query_params)) {
3091
-            EE_Error::doing_it_wrong(
3092
-                'EEM_Base::_create_model_query_info_carrier',
3093
-                sprintf(
3094
-                    __(
3095
-                        '$query_params should be an array, you passed a variable of type %s',
3096
-                        'event_espresso'
3097
-                    ),
3098
-                    gettype($query_params)
3099
-                ),
3100
-                '4.6.0'
3101
-            );
3102
-            $query_params = array();
3103
-        }
3104
-        $where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3105
-        //first check if we should alter the query to account for caps or not
3106
-        //because the caps might require us to do extra joins
3107
-        if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3108
-            $query_params[0] = $where_query_params = array_replace_recursive(
3109
-                $where_query_params,
3110
-                $this->caps_where_conditions(
3111
-                    $query_params['caps']
3112
-                )
3113
-            );
3114
-        }
3115
-        $query_object = $this->_extract_related_models_from_query($query_params);
3116
-        //verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3117
-        foreach ($where_query_params as $key => $value) {
3118
-            if (is_int($key)) {
3119
-                throw new EE_Error(
3120
-                    sprintf(
3121
-                        __(
3122
-                            "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.",
3123
-                            "event_espresso"
3124
-                        ),
3125
-                        $key,
3126
-                        var_export($value, true),
3127
-                        var_export($query_params, true),
3128
-                        get_class($this)
3129
-                    )
3130
-                );
3131
-            }
3132
-        }
3133
-        if (
3134
-            array_key_exists('default_where_conditions', $query_params)
3135
-            && ! empty($query_params['default_where_conditions'])
3136
-        ) {
3137
-            $use_default_where_conditions = $query_params['default_where_conditions'];
3138
-        } else {
3139
-            $use_default_where_conditions = 'all';
3140
-        }
3141
-        $where_query_params = array_merge(
3142
-            $this->_get_default_where_conditions_for_models_in_query(
3143
-                $query_object,
3144
-                $use_default_where_conditions,
3145
-                $where_query_params
3146
-            ),
3147
-            $where_query_params
3148
-        );
3149
-        $query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3150
-        // if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3151
-        // So we need to setup a subquery and use that for the main join.
3152
-        // Note for now this only works on the primary table for the model.
3153
-        // So for instance, you could set the limit array like this:
3154
-        // array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3155
-        if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3156
-            $query_object->set_main_model_join_sql(
3157
-                $this->_construct_limit_join_select(
3158
-                    $query_params['on_join_limit'][0],
3159
-                    $query_params['on_join_limit'][1]
3160
-                )
3161
-            );
3162
-        }
3163
-        //set limit
3164
-        if (array_key_exists('limit', $query_params)) {
3165
-            if (is_array($query_params['limit'])) {
3166
-                if ( ! isset($query_params['limit'][0], $query_params['limit'][1])) {
3167
-                    $e = sprintf(
3168
-                        __(
3169
-                            "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)",
3170
-                            "event_espresso"
3171
-                        ),
3172
-                        http_build_query($query_params['limit'])
3173
-                    );
3174
-                    throw new EE_Error($e . "|" . $e);
3175
-                }
3176
-                //they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3177
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3178
-            } elseif ( ! empty ($query_params['limit'])) {
3179
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3180
-            }
3181
-        }
3182
-        //set order by
3183
-        if (array_key_exists('order_by', $query_params)) {
3184
-            if (is_array($query_params['order_by'])) {
3185
-                //if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3186
-                //specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3187
-                //including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3188
-                if (array_key_exists('order', $query_params)) {
3189
-                    throw new EE_Error(
3190
-                        sprintf(
3191
-                            __(
3192
-                                "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 ",
3193
-                                "event_espresso"
3194
-                            ),
3195
-                            get_class($this),
3196
-                            implode(", ", array_keys($query_params['order_by'])),
3197
-                            implode(", ", $query_params['order_by']),
3198
-                            $query_params['order']
3199
-                        )
3200
-                    );
3201
-                }
3202
-                $this->_extract_related_models_from_sub_params_array_keys(
3203
-                    $query_params['order_by'],
3204
-                    $query_object,
3205
-                    'order_by'
3206
-                );
3207
-                //assume it's an array of fields to order by
3208
-                $order_array = array();
3209
-                foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3210
-                    $order = $this->_extract_order($order);
3211
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3212
-                }
3213
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3214
-            } elseif ( ! empty ($query_params['order_by'])) {
3215
-                $this->_extract_related_model_info_from_query_param(
3216
-                    $query_params['order_by'],
3217
-                    $query_object,
3218
-                    'order',
3219
-                    $query_params['order_by']
3220
-                );
3221
-                $order = isset($query_params['order'])
3222
-                    ? $this->_extract_order($query_params['order'])
3223
-                    : 'DESC';
3224
-                $query_object->set_order_by_sql(
3225
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3226
-                );
3227
-            }
3228
-        }
3229
-        //if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3230
-        if ( ! array_key_exists('order_by', $query_params)
3231
-             && array_key_exists('order', $query_params)
3232
-             && ! empty($query_params['order'])
3233
-        ) {
3234
-            $pk_field = $this->get_primary_key_field();
3235
-            $order = $this->_extract_order($query_params['order']);
3236
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3237
-        }
3238
-        //set group by
3239
-        if (array_key_exists('group_by', $query_params)) {
3240
-            if (is_array($query_params['group_by'])) {
3241
-                //it's an array, so assume we'll be grouping by a bunch of stuff
3242
-                $group_by_array = array();
3243
-                foreach ($query_params['group_by'] as $field_name_to_group_by) {
3244
-                    $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3245
-                }
3246
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3247
-            } elseif ( ! empty ($query_params['group_by'])) {
3248
-                $query_object->set_group_by_sql(
3249
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3250
-                );
3251
-            }
3252
-        }
3253
-        //set having
3254
-        if (array_key_exists('having', $query_params) && $query_params['having']) {
3255
-            $query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3256
-        }
3257
-        //now, just verify they didn't pass anything wack
3258
-        foreach ($query_params as $query_key => $query_value) {
3259
-            if ( ! in_array($query_key, $this->_allowed_query_params, true)) {
3260
-                throw new EE_Error(
3261
-                    sprintf(
3262
-                        __(
3263
-                            "You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3264
-                            'event_espresso'
3265
-                        ),
3266
-                        $query_key,
3267
-                        get_class($this),
1577
+			//let's make sure default_where strategy is followed now
1578
+			$this->_ignore_where_strategy = false;
1579
+		}
1580
+		//if we want to keep model objects in sync, AND
1581
+		//if this wasn't called from a model object (to update itself)
1582
+		//then we want to make sure we keep all the existing
1583
+		//model objects in sync with the db
1584
+		if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1585
+			if ($this->has_primary_key_field()) {
1586
+				$model_objs_affected_ids = $this->get_col($query_params);
1587
+			} else {
1588
+				//we need to select a bunch of columns and then combine them into the the "index primary key string"s
1589
+				$models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1590
+				$model_objs_affected_ids = array();
1591
+				foreach ($models_affected_key_columns as $row) {
1592
+					$combined_index_key = $this->get_index_primary_key_string($row);
1593
+					$model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1594
+				}
1595
+			}
1596
+			if ( ! $model_objs_affected_ids) {
1597
+				//wait wait wait- if nothing was affected let's stop here
1598
+				return 0;
1599
+			}
1600
+			foreach ($model_objs_affected_ids as $id) {
1601
+				$model_obj_in_entity_map = $this->get_from_entity_map($id);
1602
+				if ($model_obj_in_entity_map) {
1603
+					foreach ($fields_n_values as $field => $new_value) {
1604
+						$model_obj_in_entity_map->set($field, $new_value);
1605
+					}
1606
+				}
1607
+			}
1608
+			//if there is a primary key on this model, we can now do a slight optimization
1609
+			if ($this->has_primary_key_field()) {
1610
+				//we already know what we want to update. So let's make the query simpler so it's a little more efficient
1611
+				$query_params = array(
1612
+					array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1613
+					'limit'                    => count($model_objs_affected_ids),
1614
+					'default_where_conditions' => 'none',
1615
+				);
1616
+			}
1617
+		}
1618
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1619
+		$SQL = "UPDATE "
1620
+			   . $model_query_info->get_full_join_sql()
1621
+			   . " SET "
1622
+			   . $this->_construct_update_sql($fields_n_values)
1623
+			   . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1624
+		$rows_affected = $this->_do_wpdb_query('query', array($SQL));
1625
+		/**
1626
+		 * Action called after a model update call has been made.
1627
+		 *
1628
+		 * @param EEM_Base $model
1629
+		 * @param array    $fields_n_values the updated fields and their new values
1630
+		 * @param array    $query_params    @see EEM_Base::get_all()
1631
+		 * @param int      $rows_affected
1632
+		 */
1633
+		do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1634
+		return $rows_affected;//how many supposedly got updated
1635
+	}
1636
+
1637
+
1638
+
1639
+	/**
1640
+	 * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1641
+	 * are teh values of the field specified (or by default the primary key field)
1642
+	 * that matched the query params. Note that you should pass the name of the
1643
+	 * model FIELD, not the database table's column name.
1644
+	 *
1645
+	 * @param array  $query_params @see EEM_Base::get_all()
1646
+	 * @param string $field_to_select
1647
+	 * @return array just like $wpdb->get_col()
1648
+	 * @throws \EE_Error
1649
+	 */
1650
+	public function get_col($query_params = array(), $field_to_select = null)
1651
+	{
1652
+		if ($field_to_select) {
1653
+			$field = $this->field_settings_for($field_to_select);
1654
+		} elseif ($this->has_primary_key_field()) {
1655
+			$field = $this->get_primary_key_field();
1656
+		} else {
1657
+			//no primary key, just grab the first column
1658
+			$field = reset($this->field_settings());
1659
+		}
1660
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1661
+		$select_expressions = $field->get_qualified_column();
1662
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1663
+		return $this->_do_wpdb_query('get_col', array($SQL));
1664
+	}
1665
+
1666
+
1667
+
1668
+	/**
1669
+	 * Returns a single column value for a single row from the database
1670
+	 *
1671
+	 * @param array  $query_params    @see EEM_Base::get_all()
1672
+	 * @param string $field_to_select @see EEM_Base::get_col()
1673
+	 * @return string
1674
+	 * @throws \EE_Error
1675
+	 */
1676
+	public function get_var($query_params = array(), $field_to_select = null)
1677
+	{
1678
+		$query_params['limit'] = 1;
1679
+		$col = $this->get_col($query_params, $field_to_select);
1680
+		if ( ! empty($col)) {
1681
+			return reset($col);
1682
+		} else {
1683
+			return null;
1684
+		}
1685
+	}
1686
+
1687
+
1688
+
1689
+	/**
1690
+	 * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1691
+	 * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1692
+	 * injection, but currently no further filtering is done
1693
+	 *
1694
+	 * @global      $wpdb
1695
+	 * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1696
+	 *                               be updated to in the DB
1697
+	 * @return string of SQL
1698
+	 * @throws \EE_Error
1699
+	 */
1700
+	public function _construct_update_sql($fields_n_values)
1701
+	{
1702
+		/** @type WPDB $wpdb */
1703
+		global $wpdb;
1704
+		$cols_n_values = array();
1705
+		foreach ($fields_n_values as $field_name => $value) {
1706
+			$field_obj = $this->field_settings_for($field_name);
1707
+			//if the value is NULL, we want to assign the value to that.
1708
+			//wpdb->prepare doesn't really handle that properly
1709
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1710
+			$value_sql = $prepared_value === null ? 'NULL'
1711
+				: $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1712
+			$cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1713
+		}
1714
+		return implode(",", $cols_n_values);
1715
+	}
1716
+
1717
+
1718
+
1719
+	/**
1720
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1721
+	 * Performs a HARD delete, meaning the database row should always be removed,
1722
+	 * not just have a flag field on it switched
1723
+	 * Wrapper for EEM_Base::delete_permanently()
1724
+	 *
1725
+	 * @param mixed $id
1726
+	 * @return boolean whether the row got deleted or not
1727
+	 * @throws \EE_Error
1728
+	 */
1729
+	public function delete_permanently_by_ID($id)
1730
+	{
1731
+		return $this->delete_permanently(
1732
+			array(
1733
+				array($this->get_primary_key_field()->get_name() => $id),
1734
+				'limit' => 1,
1735
+			)
1736
+		);
1737
+	}
1738
+
1739
+
1740
+
1741
+	/**
1742
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1743
+	 * Wrapper for EEM_Base::delete()
1744
+	 *
1745
+	 * @param mixed $id
1746
+	 * @return boolean whether the row got deleted or not
1747
+	 * @throws \EE_Error
1748
+	 */
1749
+	public function delete_by_ID($id)
1750
+	{
1751
+		return $this->delete(
1752
+			array(
1753
+				array($this->get_primary_key_field()->get_name() => $id),
1754
+				'limit' => 1,
1755
+			)
1756
+		);
1757
+	}
1758
+
1759
+
1760
+
1761
+	/**
1762
+	 * Identical to delete_permanently, but does a "soft" delete if possible,
1763
+	 * meaning if the model has a field that indicates its been "trashed" or
1764
+	 * "soft deleted", we will just set that instead of actually deleting the rows.
1765
+	 *
1766
+	 * @see EEM_Base::delete_permanently
1767
+	 * @param array   $query_params
1768
+	 * @param boolean $allow_blocking
1769
+	 * @return int how many rows got deleted
1770
+	 * @throws \EE_Error
1771
+	 */
1772
+	public function delete($query_params, $allow_blocking = true)
1773
+	{
1774
+		return $this->delete_permanently($query_params, $allow_blocking);
1775
+	}
1776
+
1777
+
1778
+
1779
+	/**
1780
+	 * Deletes the model objects that meet the query params. Note: this method is overridden
1781
+	 * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1782
+	 * as archived, not actually deleted
1783
+	 *
1784
+	 * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1785
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1786
+	 *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1787
+	 *                                deletes regardless of other objects which may depend on it. Its generally
1788
+	 *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1789
+	 *                                DB
1790
+	 * @return int how many rows got deleted
1791
+	 * @throws \EE_Error
1792
+	 */
1793
+	public function delete_permanently($query_params, $allow_blocking = true)
1794
+	{
1795
+		/**
1796
+		 * Action called just before performing a real deletion query. You can use the
1797
+		 * model and its $query_params to find exactly which items will be deleted
1798
+		 *
1799
+		 * @param EEM_Base $model
1800
+		 * @param array    $query_params   @see EEM_Base::get_all()
1801
+		 * @param boolean  $allow_blocking whether or not to allow related model objects
1802
+		 *                                 to block (prevent) this deletion
1803
+		 */
1804
+		do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1805
+		//some MySQL databases may be running safe mode, which may restrict
1806
+		//deletion if there is no KEY column used in the WHERE statement of a deletion.
1807
+		//to get around this, we first do a SELECT, get all the IDs, and then run another query
1808
+		//to delete them
1809
+		$items_for_deletion = $this->_get_all_wpdb_results($query_params);
1810
+		$deletion_where = $this->_setup_ids_for_delete($items_for_deletion, $allow_blocking);
1811
+		if ($deletion_where) {
1812
+			//echo "objects for deletion:";var_dump($objects_for_deletion);
1813
+			$model_query_info = $this->_create_model_query_info_carrier($query_params);
1814
+			$table_aliases = array_keys($this->_tables);
1815
+			$SQL = "DELETE "
1816
+				   . implode(", ", $table_aliases)
1817
+				   . " FROM "
1818
+				   . $model_query_info->get_full_join_sql()
1819
+				   . " WHERE "
1820
+				   . $deletion_where;
1821
+			//		/echo "delete sql:$SQL";
1822
+			$rows_deleted = $this->_do_wpdb_query('query', array($SQL));
1823
+		} else {
1824
+			$rows_deleted = 0;
1825
+		}
1826
+		//and lastly make sure those items are removed from the entity map; if they could be put into it at all
1827
+		if ($this->has_primary_key_field()) {
1828
+			foreach ($items_for_deletion as $item_for_deletion_row) {
1829
+				$pk_value = $item_for_deletion_row[$this->get_primary_key_field()->get_qualified_column()];
1830
+				if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value])) {
1831
+					unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value]);
1832
+				}
1833
+			}
1834
+		}
1835
+		/**
1836
+		 * Action called just after performing a real deletion query. Although at this point the
1837
+		 * items should have been deleted
1838
+		 *
1839
+		 * @param EEM_Base $model
1840
+		 * @param array    $query_params @see EEM_Base::get_all()
1841
+		 * @param int      $rows_deleted
1842
+		 */
1843
+		do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
1844
+		return $rows_deleted;//how many supposedly got deleted
1845
+	}
1846
+
1847
+
1848
+
1849
+	/**
1850
+	 * Checks all the relations that throw error messages when there are blocking related objects
1851
+	 * for related model objects. If there are any related model objects on those relations,
1852
+	 * adds an EE_Error, and return true
1853
+	 *
1854
+	 * @param EE_Base_Class|int $this_model_obj_or_id
1855
+	 * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
1856
+	 *                                                 should be ignored when determining whether there are related
1857
+	 *                                                 model objects which block this model object's deletion. Useful
1858
+	 *                                                 if you know A is related to B and are considering deleting A,
1859
+	 *                                                 but want to see if A has any other objects blocking its deletion
1860
+	 *                                                 before removing the relation between A and B
1861
+	 * @return boolean
1862
+	 * @throws \EE_Error
1863
+	 */
1864
+	public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
1865
+	{
1866
+		//first, if $ignore_this_model_obj was supplied, get its model
1867
+		if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
1868
+			$ignored_model = $ignore_this_model_obj->get_model();
1869
+		} else {
1870
+			$ignored_model = null;
1871
+		}
1872
+		//now check all the relations of $this_model_obj_or_id and see if there
1873
+		//are any related model objects blocking it?
1874
+		$is_blocked = false;
1875
+		foreach ($this->_model_relations as $relation_name => $relation_obj) {
1876
+			if ($relation_obj->block_delete_if_related_models_exist()) {
1877
+				//if $ignore_this_model_obj was supplied, then for the query
1878
+				//on that model needs to be told to ignore $ignore_this_model_obj
1879
+				if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
1880
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
1881
+						array(
1882
+							$ignored_model->get_primary_key_field()->get_name() => array(
1883
+								'!=',
1884
+								$ignore_this_model_obj->ID(),
1885
+							),
1886
+						),
1887
+					));
1888
+				} else {
1889
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
1890
+				}
1891
+				if ($related_model_objects) {
1892
+					EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
1893
+					$is_blocked = true;
1894
+				}
1895
+			}
1896
+		}
1897
+		return $is_blocked;
1898
+	}
1899
+
1900
+
1901
+
1902
+	/**
1903
+	 * This sets up our delete where sql and accounts for if we have secondary tables that will have rows deleted as
1904
+	 * well.
1905
+	 *
1906
+	 * @param  array  $objects_for_deletion This should be the values returned by $this->_get_all_wpdb_results()
1907
+	 * @param boolean $allow_blocking       if TRUE, matched objects will only be deleted if there is no related model
1908
+	 *                                      info that blocks it (ie, there' sno other data that depends on this data);
1909
+	 *                                      if false, deletes regardless of other objects which may depend on it. Its
1910
+	 *                                      generally advisable to always leave this as TRUE, otherwise you could
1911
+	 *                                      easily corrupt your DB
1912
+	 * @throws EE_Error
1913
+	 * @return string    everything that comes after the WHERE statement.
1914
+	 */
1915
+	protected function _setup_ids_for_delete($objects_for_deletion, $allow_blocking = true)
1916
+	{
1917
+		if ($this->has_primary_key_field()) {
1918
+			$primary_table = $this->_get_main_table();
1919
+			$other_tables = $this->_get_other_tables();
1920
+			$deletes = $query = array();
1921
+			foreach ($objects_for_deletion as $delete_object) {
1922
+				//before we mark this object for deletion,
1923
+				//make sure there's no related objects blocking its deletion (if we're checking)
1924
+				if (
1925
+					$allow_blocking
1926
+					&& $this->delete_is_blocked_by_related_models(
1927
+						$delete_object[$primary_table->get_fully_qualified_pk_column()]
1928
+					)
1929
+				) {
1930
+					continue;
1931
+				}
1932
+				//primary table deletes
1933
+				if (isset($delete_object[$primary_table->get_fully_qualified_pk_column()])) {
1934
+					$deletes[$primary_table->get_fully_qualified_pk_column()][] = $delete_object[$primary_table->get_fully_qualified_pk_column()];
1935
+				}
1936
+				//other tables
1937
+				if ( ! empty($other_tables)) {
1938
+					foreach ($other_tables as $ot) {
1939
+						//first check if we've got the foreign key column here.
1940
+						if (isset($delete_object[$ot->get_fully_qualified_fk_column()])) {
1941
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_fk_column()];
1942
+						}
1943
+						// wait! it's entirely possible that we'll have a the primary key
1944
+						// for this table in here, if it's a foreign key for one of the other secondary tables
1945
+						if (isset($delete_object[$ot->get_fully_qualified_pk_column()])) {
1946
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
1947
+						}
1948
+						// finally, it is possible that the fk for this table is found
1949
+						// in the fully qualified pk column for the fk table, so let's see if that's there!
1950
+						if (isset($delete_object[$ot->get_fully_qualified_pk_on_fk_table()])) {
1951
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
1952
+						}
1953
+					}
1954
+				}
1955
+			}
1956
+			//we should have deletes now, so let's just go through and setup the where statement
1957
+			foreach ($deletes as $column => $values) {
1958
+				//make sure we have unique $values;
1959
+				$values = array_unique($values);
1960
+				$query[] = $column . ' IN(' . implode(",", $values) . ')';
1961
+			}
1962
+			return ! empty($query) ? implode(' AND ', $query) : '';
1963
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
1964
+			$ways_to_identify_a_row = array();
1965
+			$fields = $this->get_combined_primary_key_fields();
1966
+			//note: because there' sno primary key, that means nothing else  can be pointing to this model, right?
1967
+			foreach ($objects_for_deletion as $delete_object) {
1968
+				$values_for_each_cpk_for_a_row = array();
1969
+				foreach ($fields as $cpk_field) {
1970
+					if ($cpk_field instanceof EE_Model_Field_Base) {
1971
+						$values_for_each_cpk_for_a_row[] = $cpk_field->get_qualified_column()
1972
+														   . "="
1973
+														   . $delete_object[$cpk_field->get_qualified_column()];
1974
+					}
1975
+				}
1976
+				$ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
1977
+			}
1978
+			return implode(" OR ", $ways_to_identify_a_row);
1979
+		} else {
1980
+			//so there's no primary key and no combined key...
1981
+			//sorry, can't help you
1982
+			throw new EE_Error(sprintf(__("Cannot delete objects of type %s because there is no primary key NOR combined key",
1983
+				"event_espresso"), get_class($this)));
1984
+		}
1985
+	}
1986
+
1987
+
1988
+
1989
+	/**
1990
+	 * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
1991
+	 * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
1992
+	 * column
1993
+	 *
1994
+	 * @param array  $query_params   like EEM_Base::get_all's
1995
+	 * @param string $field_to_count field on model to count by (not column name)
1996
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
1997
+	 *                               that by the setting $distinct to TRUE;
1998
+	 * @return int
1999
+	 * @throws \EE_Error
2000
+	 */
2001
+	public function count($query_params = array(), $field_to_count = null, $distinct = false)
2002
+	{
2003
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2004
+		if ($field_to_count) {
2005
+			$field_obj = $this->field_settings_for($field_to_count);
2006
+			$column_to_count = $field_obj->get_qualified_column();
2007
+		} elseif ($this->has_primary_key_field()) {
2008
+			$pk_field_obj = $this->get_primary_key_field();
2009
+			$column_to_count = $pk_field_obj->get_qualified_column();
2010
+		} else {
2011
+			//there's no primary key
2012
+			//if we're counting distinct items, and there's no primary key,
2013
+			//we need to list out the columns for distinction;
2014
+			//otherwise we can just use star
2015
+			if ($distinct) {
2016
+				$columns_to_use = array();
2017
+				foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2018
+					$columns_to_use[] = $field_obj->get_qualified_column();
2019
+				}
2020
+				$column_to_count = implode(',', $columns_to_use);
2021
+			} else {
2022
+				$column_to_count = '*';
2023
+			}
2024
+		}
2025
+		$column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2026
+		$SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2027
+		return (int)$this->_do_wpdb_query('get_var', array($SQL));
2028
+	}
2029
+
2030
+
2031
+
2032
+	/**
2033
+	 * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2034
+	 *
2035
+	 * @param array  $query_params like EEM_Base::get_all
2036
+	 * @param string $field_to_sum name of field (array key in $_fields array)
2037
+	 * @return float
2038
+	 * @throws \EE_Error
2039
+	 */
2040
+	public function sum($query_params, $field_to_sum = null)
2041
+	{
2042
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2043
+		if ($field_to_sum) {
2044
+			$field_obj = $this->field_settings_for($field_to_sum);
2045
+		} else {
2046
+			$field_obj = $this->get_primary_key_field();
2047
+		}
2048
+		$column_to_count = $field_obj->get_qualified_column();
2049
+		$SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2050
+		$return_value = $this->_do_wpdb_query('get_var', array($SQL));
2051
+		$data_type = $field_obj->get_wpdb_data_type();
2052
+		if ($data_type === '%d' || $data_type === '%s') {
2053
+			return (float)$return_value;
2054
+		} else {//must be %f
2055
+			return (float)$return_value;
2056
+		}
2057
+	}
2058
+
2059
+
2060
+
2061
+	/**
2062
+	 * Just calls the specified method on $wpdb with the given arguments
2063
+	 * Consolidates a little extra error handling code
2064
+	 *
2065
+	 * @param string $wpdb_method
2066
+	 * @param array  $arguments_to_provide
2067
+	 * @throws EE_Error
2068
+	 * @global wpdb  $wpdb
2069
+	 * @return mixed
2070
+	 */
2071
+	protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2072
+	{
2073
+		//if we're in maintenance mode level 2, DON'T run any queries
2074
+		//because level 2 indicates the database needs updating and
2075
+		//is probably out of sync with the code
2076
+		if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
2077
+			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.",
2078
+				"event_espresso")));
2079
+		}
2080
+		/** @type WPDB $wpdb */
2081
+		global $wpdb;
2082
+		if ( ! method_exists($wpdb, $wpdb_method)) {
2083
+			throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2084
+				'event_espresso'), $wpdb_method));
2085
+		}
2086
+		if (WP_DEBUG) {
2087
+			$old_show_errors_value = $wpdb->show_errors;
2088
+			$wpdb->show_errors(false);
2089
+		}
2090
+		$result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2091
+		$this->show_db_query_if_previously_requested($wpdb->last_query);
2092
+		if (WP_DEBUG) {
2093
+			$wpdb->show_errors($old_show_errors_value);
2094
+			if ( ! empty($wpdb->last_error)) {
2095
+				throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2096
+			} elseif ($result === false) {
2097
+				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"',
2098
+					'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2099
+			}
2100
+		} elseif ($result === false) {
2101
+			EE_Error::add_error(
2102
+				sprintf(
2103
+					__('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"',
2104
+						'event_espresso'),
2105
+					$wpdb_method,
2106
+					var_export($arguments_to_provide, true),
2107
+					$wpdb->last_error
2108
+				),
2109
+				__FILE__,
2110
+				__FUNCTION__,
2111
+				__LINE__
2112
+			);
2113
+		}
2114
+		return $result;
2115
+	}
2116
+
2117
+
2118
+
2119
+	/**
2120
+	 * Attempts to run the indicated WPDB method with the provided arguments,
2121
+	 * and if there's an error tries to verify the DB is correct. Uses
2122
+	 * the static property EEM_Base::$_db_verification_level to determine whether
2123
+	 * we should try to fix the EE core db, the addons, or just give up
2124
+	 *
2125
+	 * @param string $wpdb_method
2126
+	 * @param array  $arguments_to_provide
2127
+	 * @return mixed
2128
+	 */
2129
+	private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2130
+	{
2131
+		/** @type WPDB $wpdb */
2132
+		global $wpdb;
2133
+		$wpdb->last_error = null;
2134
+		$result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2135
+		// was there an error running the query? but we don't care on new activations
2136
+		// (we're going to setup the DB anyway on new activations)
2137
+		if (($result === false || ! empty($wpdb->last_error))
2138
+			&& EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2139
+		) {
2140
+			switch (EEM_Base::$_db_verification_level) {
2141
+				case EEM_Base::db_verified_none :
2142
+					// let's double-check core's DB
2143
+					$error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2144
+					break;
2145
+				case EEM_Base::db_verified_core :
2146
+					// STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2147
+					$error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2148
+					break;
2149
+				case EEM_Base::db_verified_addons :
2150
+					// ummmm... you in trouble
2151
+					return $result;
2152
+					break;
2153
+			}
2154
+			if ( ! empty($error_message)) {
2155
+				EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2156
+				trigger_error($error_message);
2157
+			}
2158
+			return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2159
+		}
2160
+		return $result;
2161
+	}
2162
+
2163
+
2164
+
2165
+	/**
2166
+	 * Verifies the EE core database is up-to-date and records that we've done it on
2167
+	 * EEM_Base::$_db_verification_level
2168
+	 *
2169
+	 * @param string $wpdb_method
2170
+	 * @param array  $arguments_to_provide
2171
+	 * @return string
2172
+	 */
2173
+	private function _verify_core_db($wpdb_method, $arguments_to_provide)
2174
+	{
2175
+		/** @type WPDB $wpdb */
2176
+		global $wpdb;
2177
+		//ok remember that we've already attempted fixing the core db, in case the problem persists
2178
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2179
+		$error_message = sprintf(
2180
+			__('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2181
+				'event_espresso'),
2182
+			$wpdb->last_error,
2183
+			$wpdb_method,
2184
+			json_encode($arguments_to_provide)
2185
+		);
2186
+		EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2187
+		return $error_message;
2188
+	}
2189
+
2190
+
2191
+
2192
+	/**
2193
+	 * Verifies the EE addons' database is up-to-date and records that we've done it on
2194
+	 * EEM_Base::$_db_verification_level
2195
+	 *
2196
+	 * @param $wpdb_method
2197
+	 * @param $arguments_to_provide
2198
+	 * @return string
2199
+	 */
2200
+	private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2201
+	{
2202
+		/** @type WPDB $wpdb */
2203
+		global $wpdb;
2204
+		//ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2205
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2206
+		$error_message = sprintf(
2207
+			__('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2208
+				'event_espresso'),
2209
+			$wpdb->last_error,
2210
+			$wpdb_method,
2211
+			json_encode($arguments_to_provide)
2212
+		);
2213
+		EE_System::instance()->initialize_addons();
2214
+		return $error_message;
2215
+	}
2216
+
2217
+
2218
+
2219
+	/**
2220
+	 * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2221
+	 * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2222
+	 * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2223
+	 * ..."
2224
+	 *
2225
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
2226
+	 * @return string
2227
+	 */
2228
+	private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2229
+	{
2230
+		return " FROM " . $model_query_info->get_full_join_sql() .
2231
+			   $model_query_info->get_where_sql() .
2232
+			   $model_query_info->get_group_by_sql() .
2233
+			   $model_query_info->get_having_sql() .
2234
+			   $model_query_info->get_order_by_sql() .
2235
+			   $model_query_info->get_limit_sql();
2236
+	}
2237
+
2238
+
2239
+
2240
+	/**
2241
+	 * Set to easily debug the next X queries ran from this model.
2242
+	 *
2243
+	 * @param int $count
2244
+	 */
2245
+	public function show_next_x_db_queries($count = 1)
2246
+	{
2247
+		$this->_show_next_x_db_queries = $count;
2248
+	}
2249
+
2250
+
2251
+
2252
+	/**
2253
+	 * @param $sql_query
2254
+	 */
2255
+	public function show_db_query_if_previously_requested($sql_query)
2256
+	{
2257
+		if ($this->_show_next_x_db_queries > 0) {
2258
+			echo $sql_query;
2259
+			$this->_show_next_x_db_queries--;
2260
+		}
2261
+	}
2262
+
2263
+
2264
+
2265
+	/**
2266
+	 * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2267
+	 * There are the 3 cases:
2268
+	 * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2269
+	 * $otherModelObject has no ID, it is first saved.
2270
+	 * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2271
+	 * has no ID, it is first saved.
2272
+	 * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2273
+	 * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2274
+	 * join table
2275
+	 *
2276
+	 * @param        EE_Base_Class                     /int $thisModelObject
2277
+	 * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2278
+	 * @param string $relationName                     , key in EEM_Base::_relations
2279
+	 *                                                 an attendee to a group, you also want to specify which role they
2280
+	 *                                                 will have in that group. So you would use this parameter to
2281
+	 *                                                 specify array('role-column-name'=>'role-id')
2282
+	 * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2283
+	 *                                                 to for relation to methods that allow you to further specify
2284
+	 *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2285
+	 *                                                 only acceptable query_params is strict "col" => "value" pairs
2286
+	 *                                                 because these will be inserted in any new rows created as well.
2287
+	 * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2288
+	 * @throws \EE_Error
2289
+	 */
2290
+	public function add_relationship_to(
2291
+		$id_or_obj,
2292
+		$other_model_id_or_obj,
2293
+		$relationName,
2294
+		$extra_join_model_fields_n_values = array()
2295
+	) {
2296
+		$relation_obj = $this->related_settings_for($relationName);
2297
+		return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2298
+	}
2299
+
2300
+
2301
+
2302
+	/**
2303
+	 * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2304
+	 * There are the 3 cases:
2305
+	 * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2306
+	 * error
2307
+	 * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2308
+	 * an error
2309
+	 * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2310
+	 *
2311
+	 * @param        EE_Base_Class /int $id_or_obj
2312
+	 * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2313
+	 * @param string $relationName key in EEM_Base::_relations
2314
+	 * @return boolean of success
2315
+	 * @throws \EE_Error
2316
+	 * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2317
+	 *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2318
+	 *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2319
+	 *                             because these will be inserted in any new rows created as well.
2320
+	 */
2321
+	public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2322
+	{
2323
+		$relation_obj = $this->related_settings_for($relationName);
2324
+		return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2325
+	}
2326
+
2327
+
2328
+
2329
+	/**
2330
+	 * @param mixed           $id_or_obj
2331
+	 * @param string          $relationName
2332
+	 * @param array           $where_query_params
2333
+	 * @param EE_Base_Class[] objects to which relations were removed
2334
+	 * @return \EE_Base_Class[]
2335
+	 * @throws \EE_Error
2336
+	 */
2337
+	public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2338
+	{
2339
+		$relation_obj = $this->related_settings_for($relationName);
2340
+		return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2341
+	}
2342
+
2343
+
2344
+
2345
+	/**
2346
+	 * Gets all the related items of the specified $model_name, using $query_params.
2347
+	 * Note: by default, we remove the "default query params"
2348
+	 * because we want to get even deleted items etc.
2349
+	 *
2350
+	 * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2351
+	 * @param string $model_name   like 'Event', 'Registration', etc. always singular
2352
+	 * @param array  $query_params like EEM_Base::get_all
2353
+	 * @return EE_Base_Class[]
2354
+	 * @throws \EE_Error
2355
+	 */
2356
+	public function get_all_related($id_or_obj, $model_name, $query_params = null)
2357
+	{
2358
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2359
+		$relation_settings = $this->related_settings_for($model_name);
2360
+		return $relation_settings->get_all_related($model_obj, $query_params);
2361
+	}
2362
+
2363
+
2364
+
2365
+	/**
2366
+	 * Deletes all the model objects across the relation indicated by $model_name
2367
+	 * which are related to $id_or_obj which meet the criteria set in $query_params.
2368
+	 * However, if the model objects can't be deleted because of blocking related model objects, then
2369
+	 * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2370
+	 *
2371
+	 * @param EE_Base_Class|int|string $id_or_obj
2372
+	 * @param string                   $model_name
2373
+	 * @param array                    $query_params
2374
+	 * @return int how many deleted
2375
+	 * @throws \EE_Error
2376
+	 */
2377
+	public function delete_related($id_or_obj, $model_name, $query_params = array())
2378
+	{
2379
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2380
+		$relation_settings = $this->related_settings_for($model_name);
2381
+		return $relation_settings->delete_all_related($model_obj, $query_params);
2382
+	}
2383
+
2384
+
2385
+
2386
+	/**
2387
+	 * Hard deletes all the model objects across the relation indicated by $model_name
2388
+	 * which are related to $id_or_obj which meet the criteria set in $query_params. If
2389
+	 * the model objects can't be hard deleted because of blocking related model objects,
2390
+	 * just does a soft-delete on them instead.
2391
+	 *
2392
+	 * @param EE_Base_Class|int|string $id_or_obj
2393
+	 * @param string                   $model_name
2394
+	 * @param array                    $query_params
2395
+	 * @return int how many deleted
2396
+	 * @throws \EE_Error
2397
+	 */
2398
+	public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2399
+	{
2400
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2401
+		$relation_settings = $this->related_settings_for($model_name);
2402
+		return $relation_settings->delete_related_permanently($model_obj, $query_params);
2403
+	}
2404
+
2405
+
2406
+
2407
+	/**
2408
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2409
+	 * unless otherwise specified in the $query_params
2410
+	 *
2411
+	 * @param        int             /EE_Base_Class $id_or_obj
2412
+	 * @param string $model_name     like 'Event', or 'Registration'
2413
+	 * @param array  $query_params   like EEM_Base::get_all's
2414
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
2415
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2416
+	 *                               that by the setting $distinct to TRUE;
2417
+	 * @return int
2418
+	 * @throws \EE_Error
2419
+	 */
2420
+	public function count_related(
2421
+		$id_or_obj,
2422
+		$model_name,
2423
+		$query_params = array(),
2424
+		$field_to_count = null,
2425
+		$distinct = false
2426
+	) {
2427
+		$related_model = $this->get_related_model_obj($model_name);
2428
+		//we're just going to use the query params on the related model's normal get_all query,
2429
+		//except add a condition to say to match the current mod
2430
+		if ( ! isset($query_params['default_where_conditions'])) {
2431
+			$query_params['default_where_conditions'] = 'none';
2432
+		}
2433
+		$this_model_name = $this->get_this_model_name();
2434
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2435
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2436
+		return $related_model->count($query_params, $field_to_count, $distinct);
2437
+	}
2438
+
2439
+
2440
+
2441
+	/**
2442
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
2443
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2444
+	 *
2445
+	 * @param        int           /EE_Base_Class $id_or_obj
2446
+	 * @param string $model_name   like 'Event', or 'Registration'
2447
+	 * @param array  $query_params like EEM_Base::get_all's
2448
+	 * @param string $field_to_sum name of field to count by. By default, uses primary key
2449
+	 * @return float
2450
+	 * @throws \EE_Error
2451
+	 */
2452
+	public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2453
+	{
2454
+		$related_model = $this->get_related_model_obj($model_name);
2455
+		if ( ! is_array($query_params)) {
2456
+			EE_Error::doing_it_wrong('EEM_Base::sum_related',
2457
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2458
+					gettype($query_params)), '4.6.0');
2459
+			$query_params = array();
2460
+		}
2461
+		//we're just going to use the query params on the related model's normal get_all query,
2462
+		//except add a condition to say to match the current mod
2463
+		if ( ! isset($query_params['default_where_conditions'])) {
2464
+			$query_params['default_where_conditions'] = 'none';
2465
+		}
2466
+		$this_model_name = $this->get_this_model_name();
2467
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2468
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2469
+		return $related_model->sum($query_params, $field_to_sum);
2470
+	}
2471
+
2472
+
2473
+
2474
+	/**
2475
+	 * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2476
+	 * $modelObject
2477
+	 *
2478
+	 * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2479
+	 * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2480
+	 * @param array               $query_params     like EEM_Base::get_all's
2481
+	 * @return EE_Base_Class
2482
+	 * @throws \EE_Error
2483
+	 */
2484
+	public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2485
+	{
2486
+		$query_params['limit'] = 1;
2487
+		$results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2488
+		if ($results) {
2489
+			return array_shift($results);
2490
+		} else {
2491
+			return null;
2492
+		}
2493
+	}
2494
+
2495
+
2496
+
2497
+	/**
2498
+	 * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2499
+	 *
2500
+	 * @return string
2501
+	 */
2502
+	public function get_this_model_name()
2503
+	{
2504
+		return str_replace("EEM_", "", get_class($this));
2505
+	}
2506
+
2507
+
2508
+
2509
+	/**
2510
+	 * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2511
+	 *
2512
+	 * @return EE_Any_Foreign_Model_Name_Field
2513
+	 * @throws EE_Error
2514
+	 */
2515
+	public function get_field_containing_related_model_name()
2516
+	{
2517
+		foreach ($this->field_settings(true) as $field) {
2518
+			if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2519
+				$field_with_model_name = $field;
2520
+			}
2521
+		}
2522
+		if ( ! isset($field_with_model_name) || ! $field_with_model_name) {
2523
+			throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2524
+				$this->get_this_model_name()));
2525
+		}
2526
+		return $field_with_model_name;
2527
+	}
2528
+
2529
+
2530
+
2531
+	/**
2532
+	 * Inserts a new entry into the database, for each table.
2533
+	 * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2534
+	 * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2535
+	 * we also know there is no model object with the newly inserted item's ID at the moment (because
2536
+	 * if there were, then they would already be in the DB and this would fail); and in the future if someone
2537
+	 * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2538
+	 * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2539
+	 *
2540
+	 * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2541
+	 *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2542
+	 *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2543
+	 *                              of EEM_Base)
2544
+	 * @return int new primary key on main table that got inserted
2545
+	 * @throws EE_Error
2546
+	 */
2547
+	public function insert($field_n_values)
2548
+	{
2549
+		/**
2550
+		 * Filters the fields and their values before inserting an item using the models
2551
+		 *
2552
+		 * @param array    $fields_n_values keys are the fields and values are their new values
2553
+		 * @param EEM_Base $model           the model used
2554
+		 */
2555
+		$field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2556
+		if ($this->_satisfies_unique_indexes($field_n_values)) {
2557
+			$main_table = $this->_get_main_table();
2558
+			$new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2559
+			if ($new_id !== false) {
2560
+				foreach ($this->_get_other_tables() as $other_table) {
2561
+					$this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2562
+				}
2563
+			}
2564
+			/**
2565
+			 * Done just after attempting to insert a new model object
2566
+			 *
2567
+			 * @param EEM_Base   $model           used
2568
+			 * @param array      $fields_n_values fields and their values
2569
+			 * @param int|string the              ID of the newly-inserted model object
2570
+			 */
2571
+			do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2572
+			return $new_id;
2573
+		} else {
2574
+			return false;
2575
+		}
2576
+	}
2577
+
2578
+
2579
+
2580
+	/**
2581
+	 * Checks that the result would satisfy the unique indexes on this model
2582
+	 *
2583
+	 * @param array  $field_n_values
2584
+	 * @param string $action
2585
+	 * @return boolean
2586
+	 * @throws \EE_Error
2587
+	 */
2588
+	protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2589
+	{
2590
+		foreach ($this->unique_indexes() as $index_name => $index) {
2591
+			$uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2592
+			if ($this->exists(array($uniqueness_where_params))) {
2593
+				EE_Error::add_error(
2594
+					sprintf(
2595
+						__(
2596
+							"Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2597
+							"event_espresso"
2598
+						),
2599
+						$action,
2600
+						$this->_get_class_name(),
2601
+						$index_name,
2602
+						implode(",", $index->field_names()),
2603
+						http_build_query($uniqueness_where_params)
2604
+					),
2605
+					__FILE__,
2606
+					__FUNCTION__,
2607
+					__LINE__
2608
+				);
2609
+				return false;
2610
+			}
2611
+		}
2612
+		return true;
2613
+	}
2614
+
2615
+
2616
+
2617
+	/**
2618
+	 * Checks the database for an item that conflicts (ie, if this item were
2619
+	 * saved to the DB would break some uniqueness requirement, like a primary key
2620
+	 * or an index primary key set) with the item specified. $id_obj_or_fields_array
2621
+	 * can be either an EE_Base_Class or an array of fields n values
2622
+	 *
2623
+	 * @param EE_Base_Class|array $obj_or_fields_array
2624
+	 * @param boolean             $include_primary_key whether to use the model object's primary key
2625
+	 *                                                 when looking for conflicts
2626
+	 *                                                 (ie, if false, we ignore the model object's primary key
2627
+	 *                                                 when finding "conflicts". If true, it's also considered).
2628
+	 *                                                 Only works for INT primary key,
2629
+	 *                                                 STRING primary keys cannot be ignored
2630
+	 * @throws EE_Error
2631
+	 * @return EE_Base_Class|array
2632
+	 */
2633
+	public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2634
+	{
2635
+		if ($obj_or_fields_array instanceof EE_Base_Class) {
2636
+			$fields_n_values = $obj_or_fields_array->model_field_array();
2637
+		} elseif (is_array($obj_or_fields_array)) {
2638
+			$fields_n_values = $obj_or_fields_array;
2639
+		} else {
2640
+			throw new EE_Error(
2641
+				sprintf(
2642
+					__(
2643
+						"%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2644
+						"event_espresso"
2645
+					),
2646
+					get_class($this),
2647
+					$obj_or_fields_array
2648
+				)
2649
+			);
2650
+		}
2651
+		$query_params = array();
2652
+		if ($this->has_primary_key_field()
2653
+			&& ($include_primary_key
2654
+				|| $this->get_primary_key_field()
2655
+				   instanceof
2656
+				   EE_Primary_Key_String_Field)
2657
+			&& isset($fields_n_values[$this->primary_key_name()])
2658
+		) {
2659
+			$query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2660
+		}
2661
+		foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2662
+			$uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2663
+			$query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2664
+		}
2665
+		//if there is nothing to base this search on, then we shouldn't find anything
2666
+		if (empty($query_params)) {
2667
+			return array();
2668
+		} else {
2669
+			return $this->get_one($query_params);
2670
+		}
2671
+	}
2672
+
2673
+
2674
+
2675
+	/**
2676
+	 * Like count, but is optimized and returns a boolean instead of an int
2677
+	 *
2678
+	 * @param array $query_params
2679
+	 * @return boolean
2680
+	 * @throws \EE_Error
2681
+	 */
2682
+	public function exists($query_params)
2683
+	{
2684
+		$query_params['limit'] = 1;
2685
+		return $this->count($query_params) > 0;
2686
+	}
2687
+
2688
+
2689
+
2690
+	/**
2691
+	 * Wrapper for exists, except ignores default query parameters so we're only considering ID
2692
+	 *
2693
+	 * @param int|string $id
2694
+	 * @return boolean
2695
+	 * @throws \EE_Error
2696
+	 */
2697
+	public function exists_by_ID($id)
2698
+	{
2699
+		return $this->exists(array('default_where_conditions' => 'none', array($this->primary_key_name() => $id)));
2700
+	}
2701
+
2702
+
2703
+
2704
+	/**
2705
+	 * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2706
+	 * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2707
+	 * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2708
+	 * on the main table)
2709
+	 * This is protected rather than private because private is not accessible to any child methods and there MAY be
2710
+	 * cases where we want to call it directly rather than via insert().
2711
+	 *
2712
+	 * @access   protected
2713
+	 * @param EE_Table_Base $table
2714
+	 * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2715
+	 *                                       float
2716
+	 * @param int           $new_id          for now we assume only int keys
2717
+	 * @throws EE_Error
2718
+	 * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2719
+	 * @return int ID of new row inserted, or FALSE on failure
2720
+	 */
2721
+	protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2722
+	{
2723
+		global $wpdb;
2724
+		$insertion_col_n_values = array();
2725
+		$format_for_insertion = array();
2726
+		$fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2727
+		foreach ($fields_on_table as $field_name => $field_obj) {
2728
+			//check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2729
+			if ($field_obj->is_auto_increment()) {
2730
+				continue;
2731
+			}
2732
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2733
+			//if the value we want to assign it to is NULL, just don't mention it for the insertion
2734
+			if ($prepared_value !== null) {
2735
+				$insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2736
+				$format_for_insertion[] = $field_obj->get_wpdb_data_type();
2737
+			}
2738
+		}
2739
+		if ($table instanceof EE_Secondary_Table && $new_id) {
2740
+			//its not the main table, so we should have already saved the main table's PK which we just inserted
2741
+			//so add the fk to the main table as a column
2742
+			$insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2743
+			$format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2744
+		}
2745
+		//insert the new entry
2746
+		$result = $this->_do_wpdb_query('insert',
2747
+			array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2748
+		if ($result === false) {
2749
+			return false;
2750
+		}
2751
+		//ok, now what do we return for the ID of the newly-inserted thing?
2752
+		if ($this->has_primary_key_field()) {
2753
+			if ($this->get_primary_key_field()->is_auto_increment()) {
2754
+				return $wpdb->insert_id;
2755
+			} else {
2756
+				//it's not an auto-increment primary key, so
2757
+				//it must have been supplied
2758
+				return $fields_n_values[$this->get_primary_key_field()->get_name()];
2759
+			}
2760
+		} else {
2761
+			//we can't return a  primary key because there is none. instead return
2762
+			//a unique string indicating this model
2763
+			return $this->get_index_primary_key_string($fields_n_values);
2764
+		}
2765
+	}
2766
+
2767
+
2768
+
2769
+	/**
2770
+	 * Prepare the $field_obj 's value in $fields_n_values for use in the database.
2771
+	 * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
2772
+	 * and there is no default, we pass it along. WPDB will take care of it)
2773
+	 *
2774
+	 * @param EE_Model_Field_Base $field_obj
2775
+	 * @param array               $fields_n_values
2776
+	 * @return mixed string|int|float depending on what the table column will be expecting
2777
+	 * @throws \EE_Error
2778
+	 */
2779
+	protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
2780
+	{
2781
+		//if this field doesn't allow nullable, don't allow it
2782
+		if ( ! $field_obj->is_nullable()
2783
+			 && (
2784
+				 ! isset($fields_n_values[$field_obj->get_name()]) || $fields_n_values[$field_obj->get_name()] === null)
2785
+		) {
2786
+			$fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
2787
+		}
2788
+		$unprepared_value = isset($fields_n_values[$field_obj->get_name()]) ? $fields_n_values[$field_obj->get_name()]
2789
+			: null;
2790
+		return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
2791
+	}
2792
+
2793
+
2794
+
2795
+	/**
2796
+	 * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
2797
+	 * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
2798
+	 * the field's prepare_for_set() method.
2799
+	 *
2800
+	 * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
2801
+	 *                                   false, otherwise a value in the model object's domain (see lengthy comment at
2802
+	 *                                   top of file)
2803
+	 * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
2804
+	 *                                   $value is a custom selection
2805
+	 * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
2806
+	 */
2807
+	private function _prepare_value_for_use_in_db($value, $field)
2808
+	{
2809
+		if ($field && $field instanceof EE_Model_Field_Base) {
2810
+			switch ($this->_values_already_prepared_by_model_object) {
2811
+				/** @noinspection PhpMissingBreakStatementInspection */
2812
+				case self::not_prepared_by_model_object:
2813
+					$value = $field->prepare_for_set($value);
2814
+				//purposefully left out "return"
2815
+				case self::prepared_by_model_object:
2816
+					$value = $field->prepare_for_use_in_db($value);
2817
+				case self::prepared_for_use_in_db:
2818
+					//leave the value alone
2819
+			}
2820
+			return $value;
2821
+		} else {
2822
+			return $value;
2823
+		}
2824
+	}
2825
+
2826
+
2827
+
2828
+	/**
2829
+	 * Returns the main table on this model
2830
+	 *
2831
+	 * @return EE_Primary_Table
2832
+	 * @throws EE_Error
2833
+	 */
2834
+	protected function _get_main_table()
2835
+	{
2836
+		foreach ($this->_tables as $table) {
2837
+			if ($table instanceof EE_Primary_Table) {
2838
+				return $table;
2839
+			}
2840
+		}
2841
+		throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
2842
+			'event_espresso'), get_class($this)));
2843
+	}
2844
+
2845
+
2846
+
2847
+	/**
2848
+	 * table
2849
+	 * returns EE_Primary_Table table name
2850
+	 *
2851
+	 * @return string
2852
+	 * @throws \EE_Error
2853
+	 */
2854
+	public function table()
2855
+	{
2856
+		return $this->_get_main_table()->get_table_name();
2857
+	}
2858
+
2859
+
2860
+
2861
+	/**
2862
+	 * table
2863
+	 * returns first EE_Secondary_Table table name
2864
+	 *
2865
+	 * @return string
2866
+	 */
2867
+	public function second_table()
2868
+	{
2869
+		// grab second table from tables array
2870
+		$second_table = end($this->_tables);
2871
+		return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
2872
+	}
2873
+
2874
+
2875
+
2876
+	/**
2877
+	 * get_table_obj_by_alias
2878
+	 * returns table name given it's alias
2879
+	 *
2880
+	 * @param string $table_alias
2881
+	 * @return EE_Primary_Table | EE_Secondary_Table
2882
+	 */
2883
+	public function get_table_obj_by_alias($table_alias = '')
2884
+	{
2885
+		return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
2886
+	}
2887
+
2888
+
2889
+
2890
+	/**
2891
+	 * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
2892
+	 *
2893
+	 * @return EE_Secondary_Table[]
2894
+	 */
2895
+	protected function _get_other_tables()
2896
+	{
2897
+		$other_tables = array();
2898
+		foreach ($this->_tables as $table_alias => $table) {
2899
+			if ($table instanceof EE_Secondary_Table) {
2900
+				$other_tables[$table_alias] = $table;
2901
+			}
2902
+		}
2903
+		return $other_tables;
2904
+	}
2905
+
2906
+
2907
+
2908
+	/**
2909
+	 * Finds all the fields that correspond to the given table
2910
+	 *
2911
+	 * @param string $table_alias , array key in EEM_Base::_tables
2912
+	 * @return EE_Model_Field_Base[]
2913
+	 */
2914
+	public function _get_fields_for_table($table_alias)
2915
+	{
2916
+		return $this->_fields[$table_alias];
2917
+	}
2918
+
2919
+
2920
+
2921
+	/**
2922
+	 * Recurses through all the where parameters, and finds all the related models we'll need
2923
+	 * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
2924
+	 * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
2925
+	 * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
2926
+	 * related Registration, Transaction, and Payment models.
2927
+	 *
2928
+	 * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
2929
+	 * @return EE_Model_Query_Info_Carrier
2930
+	 * @throws \EE_Error
2931
+	 */
2932
+	public function _extract_related_models_from_query($query_params)
2933
+	{
2934
+		$query_info_carrier = new EE_Model_Query_Info_Carrier();
2935
+		if (array_key_exists(0, $query_params)) {
2936
+			$this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
2937
+		}
2938
+		if (array_key_exists('group_by', $query_params)) {
2939
+			if (is_array($query_params['group_by'])) {
2940
+				$this->_extract_related_models_from_sub_params_array_values(
2941
+					$query_params['group_by'],
2942
+					$query_info_carrier,
2943
+					'group_by'
2944
+				);
2945
+			} elseif ( ! empty ($query_params['group_by'])) {
2946
+				$this->_extract_related_model_info_from_query_param(
2947
+					$query_params['group_by'],
2948
+					$query_info_carrier,
2949
+					'group_by'
2950
+				);
2951
+			}
2952
+		}
2953
+		if (array_key_exists('having', $query_params)) {
2954
+			$this->_extract_related_models_from_sub_params_array_keys(
2955
+				$query_params[0],
2956
+				$query_info_carrier,
2957
+				'having'
2958
+			);
2959
+		}
2960
+		if (array_key_exists('order_by', $query_params)) {
2961
+			if (is_array($query_params['order_by'])) {
2962
+				$this->_extract_related_models_from_sub_params_array_keys(
2963
+					$query_params['order_by'],
2964
+					$query_info_carrier,
2965
+					'order_by'
2966
+				);
2967
+			} elseif ( ! empty($query_params['order_by'])) {
2968
+				$this->_extract_related_model_info_from_query_param(
2969
+					$query_params['order_by'],
2970
+					$query_info_carrier,
2971
+					'order_by'
2972
+				);
2973
+			}
2974
+		}
2975
+		if (array_key_exists('force_join', $query_params)) {
2976
+			$this->_extract_related_models_from_sub_params_array_values(
2977
+				$query_params['force_join'],
2978
+				$query_info_carrier,
2979
+				'force_join'
2980
+			);
2981
+		}
2982
+		return $query_info_carrier;
2983
+	}
2984
+
2985
+
2986
+
2987
+	/**
2988
+	 * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
2989
+	 *
2990
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
2991
+	 *                                                      $query_params['having']
2992
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
2993
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
2994
+	 * @throws EE_Error
2995
+	 * @return \EE_Model_Query_Info_Carrier
2996
+	 */
2997
+	private function _extract_related_models_from_sub_params_array_keys(
2998
+		$sub_query_params,
2999
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3000
+		$query_param_type
3001
+	) {
3002
+		if ( ! empty($sub_query_params)) {
3003
+			$sub_query_params = (array)$sub_query_params;
3004
+			foreach ($sub_query_params as $param => $possibly_array_of_params) {
3005
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3006
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3007
+					$query_param_type);
3008
+				//if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3009
+				//indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3010
+				//extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3011
+				//of array('Registration.TXN_ID'=>23)
3012
+				$query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3013
+				if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3014
+					if ( ! is_array($possibly_array_of_params)) {
3015
+						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'))",
3016
+							"event_espresso"),
3017
+							$param, $possibly_array_of_params));
3018
+					} else {
3019
+						$this->_extract_related_models_from_sub_params_array_keys($possibly_array_of_params,
3020
+							$model_query_info_carrier, $query_param_type);
3021
+					}
3022
+				} elseif ($query_param_type === 0 //ie WHERE
3023
+						  && is_array($possibly_array_of_params)
3024
+						  && isset($possibly_array_of_params[2])
3025
+						  && $possibly_array_of_params[2] == true
3026
+				) {
3027
+					//then $possible_array_of_params looks something like array('<','DTT_sold',true)
3028
+					//indicating that $possible_array_of_params[1] is actually a field name,
3029
+					//from which we should extract query parameters!
3030
+					if ( ! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3031
+						throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3032
+							"event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3033
+					}
3034
+					$this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3035
+						$model_query_info_carrier, $query_param_type);
3036
+				}
3037
+			}
3038
+		}
3039
+		return $model_query_info_carrier;
3040
+	}
3041
+
3042
+
3043
+
3044
+	/**
3045
+	 * For extracting related models from forced_joins, where the array values contain the info about what
3046
+	 * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3047
+	 *
3048
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3049
+	 *                                                      $query_params['having']
3050
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3051
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
3052
+	 * @throws EE_Error
3053
+	 * @return \EE_Model_Query_Info_Carrier
3054
+	 */
3055
+	private function _extract_related_models_from_sub_params_array_values(
3056
+		$sub_query_params,
3057
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3058
+		$query_param_type
3059
+	) {
3060
+		if ( ! empty($sub_query_params)) {
3061
+			if ( ! is_array($sub_query_params)) {
3062
+				throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3063
+					$sub_query_params));
3064
+			}
3065
+			foreach ($sub_query_params as $param) {
3066
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3067
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3068
+					$query_param_type);
3069
+			}
3070
+		}
3071
+		return $model_query_info_carrier;
3072
+	}
3073
+
3074
+
3075
+
3076
+	/**
3077
+	 * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3078
+	 * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3079
+	 * instead of directly constructing the SQL because often we need to extract info from the $query_params
3080
+	 * but use them in a different order. Eg, we need to know what models we are querying
3081
+	 * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3082
+	 * other models before we can finalize the where clause SQL.
3083
+	 *
3084
+	 * @param array $query_params
3085
+	 * @throws EE_Error
3086
+	 * @return EE_Model_Query_Info_Carrier
3087
+	 */
3088
+	public function _create_model_query_info_carrier($query_params)
3089
+	{
3090
+		if ( ! is_array($query_params)) {
3091
+			EE_Error::doing_it_wrong(
3092
+				'EEM_Base::_create_model_query_info_carrier',
3093
+				sprintf(
3094
+					__(
3095
+						'$query_params should be an array, you passed a variable of type %s',
3096
+						'event_espresso'
3097
+					),
3098
+					gettype($query_params)
3099
+				),
3100
+				'4.6.0'
3101
+			);
3102
+			$query_params = array();
3103
+		}
3104
+		$where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3105
+		//first check if we should alter the query to account for caps or not
3106
+		//because the caps might require us to do extra joins
3107
+		if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3108
+			$query_params[0] = $where_query_params = array_replace_recursive(
3109
+				$where_query_params,
3110
+				$this->caps_where_conditions(
3111
+					$query_params['caps']
3112
+				)
3113
+			);
3114
+		}
3115
+		$query_object = $this->_extract_related_models_from_query($query_params);
3116
+		//verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3117
+		foreach ($where_query_params as $key => $value) {
3118
+			if (is_int($key)) {
3119
+				throw new EE_Error(
3120
+					sprintf(
3121
+						__(
3122
+							"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.",
3123
+							"event_espresso"
3124
+						),
3125
+						$key,
3126
+						var_export($value, true),
3127
+						var_export($query_params, true),
3128
+						get_class($this)
3129
+					)
3130
+				);
3131
+			}
3132
+		}
3133
+		if (
3134
+			array_key_exists('default_where_conditions', $query_params)
3135
+			&& ! empty($query_params['default_where_conditions'])
3136
+		) {
3137
+			$use_default_where_conditions = $query_params['default_where_conditions'];
3138
+		} else {
3139
+			$use_default_where_conditions = 'all';
3140
+		}
3141
+		$where_query_params = array_merge(
3142
+			$this->_get_default_where_conditions_for_models_in_query(
3143
+				$query_object,
3144
+				$use_default_where_conditions,
3145
+				$where_query_params
3146
+			),
3147
+			$where_query_params
3148
+		);
3149
+		$query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3150
+		// if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3151
+		// So we need to setup a subquery and use that for the main join.
3152
+		// Note for now this only works on the primary table for the model.
3153
+		// So for instance, you could set the limit array like this:
3154
+		// array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3155
+		if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3156
+			$query_object->set_main_model_join_sql(
3157
+				$this->_construct_limit_join_select(
3158
+					$query_params['on_join_limit'][0],
3159
+					$query_params['on_join_limit'][1]
3160
+				)
3161
+			);
3162
+		}
3163
+		//set limit
3164
+		if (array_key_exists('limit', $query_params)) {
3165
+			if (is_array($query_params['limit'])) {
3166
+				if ( ! isset($query_params['limit'][0], $query_params['limit'][1])) {
3167
+					$e = sprintf(
3168
+						__(
3169
+							"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)",
3170
+							"event_espresso"
3171
+						),
3172
+						http_build_query($query_params['limit'])
3173
+					);
3174
+					throw new EE_Error($e . "|" . $e);
3175
+				}
3176
+				//they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3177
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3178
+			} elseif ( ! empty ($query_params['limit'])) {
3179
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3180
+			}
3181
+		}
3182
+		//set order by
3183
+		if (array_key_exists('order_by', $query_params)) {
3184
+			if (is_array($query_params['order_by'])) {
3185
+				//if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3186
+				//specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3187
+				//including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3188
+				if (array_key_exists('order', $query_params)) {
3189
+					throw new EE_Error(
3190
+						sprintf(
3191
+							__(
3192
+								"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 ",
3193
+								"event_espresso"
3194
+							),
3195
+							get_class($this),
3196
+							implode(", ", array_keys($query_params['order_by'])),
3197
+							implode(", ", $query_params['order_by']),
3198
+							$query_params['order']
3199
+						)
3200
+					);
3201
+				}
3202
+				$this->_extract_related_models_from_sub_params_array_keys(
3203
+					$query_params['order_by'],
3204
+					$query_object,
3205
+					'order_by'
3206
+				);
3207
+				//assume it's an array of fields to order by
3208
+				$order_array = array();
3209
+				foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3210
+					$order = $this->_extract_order($order);
3211
+					$order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3212
+				}
3213
+				$query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3214
+			} elseif ( ! empty ($query_params['order_by'])) {
3215
+				$this->_extract_related_model_info_from_query_param(
3216
+					$query_params['order_by'],
3217
+					$query_object,
3218
+					'order',
3219
+					$query_params['order_by']
3220
+				);
3221
+				$order = isset($query_params['order'])
3222
+					? $this->_extract_order($query_params['order'])
3223
+					: 'DESC';
3224
+				$query_object->set_order_by_sql(
3225
+					" ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3226
+				);
3227
+			}
3228
+		}
3229
+		//if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3230
+		if ( ! array_key_exists('order_by', $query_params)
3231
+			 && array_key_exists('order', $query_params)
3232
+			 && ! empty($query_params['order'])
3233
+		) {
3234
+			$pk_field = $this->get_primary_key_field();
3235
+			$order = $this->_extract_order($query_params['order']);
3236
+			$query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3237
+		}
3238
+		//set group by
3239
+		if (array_key_exists('group_by', $query_params)) {
3240
+			if (is_array($query_params['group_by'])) {
3241
+				//it's an array, so assume we'll be grouping by a bunch of stuff
3242
+				$group_by_array = array();
3243
+				foreach ($query_params['group_by'] as $field_name_to_group_by) {
3244
+					$group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3245
+				}
3246
+				$query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3247
+			} elseif ( ! empty ($query_params['group_by'])) {
3248
+				$query_object->set_group_by_sql(
3249
+					" GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3250
+				);
3251
+			}
3252
+		}
3253
+		//set having
3254
+		if (array_key_exists('having', $query_params) && $query_params['having']) {
3255
+			$query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3256
+		}
3257
+		//now, just verify they didn't pass anything wack
3258
+		foreach ($query_params as $query_key => $query_value) {
3259
+			if ( ! in_array($query_key, $this->_allowed_query_params, true)) {
3260
+				throw new EE_Error(
3261
+					sprintf(
3262
+						__(
3263
+							"You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3264
+							'event_espresso'
3265
+						),
3266
+						$query_key,
3267
+						get_class($this),
3268 3268
 //						print_r( $this->_allowed_query_params, TRUE )
3269
-                        implode(',', $this->_allowed_query_params)
3270
-                    )
3271
-                );
3272
-            }
3273
-        }
3274
-        $main_model_join_sql = $query_object->get_main_model_join_sql();
3275
-        if (empty($main_model_join_sql)) {
3276
-            $query_object->set_main_model_join_sql($this->_construct_internal_join());
3277
-        }
3278
-        return $query_object;
3279
-    }
3280
-
3281
-
3282
-
3283
-    /**
3284
-     * Gets the where conditions that should be imposed on the query based on the
3285
-     * context (eg reading frontend, backend, edit or delete).
3286
-     *
3287
-     * @param string $context one of EEM_Base::valid_cap_contexts()
3288
-     * @return array like EEM_Base::get_all() 's $query_params[0]
3289
-     * @throws \EE_Error
3290
-     */
3291
-    public function caps_where_conditions($context = self::caps_read)
3292
-    {
3293
-        EEM_Base::verify_is_valid_cap_context($context);
3294
-        $cap_where_conditions = array();
3295
-        $cap_restrictions = $this->caps_missing($context);
3296
-        /**
3297
-         * @var $cap_restrictions EE_Default_Where_Conditions[]
3298
-         */
3299
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3300
-            $cap_where_conditions = array_replace_recursive($cap_where_conditions,
3301
-                $restriction_if_no_cap->get_default_where_conditions());
3302
-        }
3303
-        return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3304
-            $cap_restrictions);
3305
-    }
3306
-
3307
-
3308
-
3309
-    /**
3310
-     * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3311
-     * otherwise throws an exception
3312
-     *
3313
-     * @param string $should_be_order_string
3314
-     * @return string either ASC, asc, DESC or desc
3315
-     * @throws EE_Error
3316
-     */
3317
-    private function _extract_order($should_be_order_string)
3318
-    {
3319
-        if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3320
-            return $should_be_order_string;
3321
-        } else {
3322
-            throw new EE_Error(sprintf(__("While performing a query on '%s', tried to use '%s' as an order parameter. ",
3323
-                "event_espresso"), get_class($this), $should_be_order_string));
3324
-        }
3325
-    }
3326
-
3327
-
3328
-
3329
-    /**
3330
-     * Looks at all the models which are included in this query, and asks each
3331
-     * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3332
-     * so they can be merged
3333
-     *
3334
-     * @param EE_Model_Query_Info_Carrier $query_info_carrier
3335
-     * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3336
-     *                                                                  'none' means NO default where conditions will
3337
-     *                                                                  be used AT ALL during this query.
3338
-     *                                                                  'other_models_only' means default where
3339
-     *                                                                  conditions from other models will be used, but
3340
-     *                                                                  not for this primary model. 'all', the default,
3341
-     *                                                                  means default where conditions will apply as
3342
-     *                                                                  normal
3343
-     * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3344
-     * @throws EE_Error
3345
-     * @return array like $query_params[0], see EEM_Base::get_all for documentation
3346
-     */
3347
-    private function _get_default_where_conditions_for_models_in_query(
3348
-        EE_Model_Query_Info_Carrier $query_info_carrier,
3349
-        $use_default_where_conditions = 'all',
3350
-        $where_query_params = array()
3351
-    ) {
3352
-        $allowed_used_default_where_conditions_values = array(
3353
-            'all',
3354
-            'this_model_only',
3355
-            'other_models_only',
3356
-            'minimum',
3357
-            'none',
3358
-        );
3359
-        if ( ! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3360
-            throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3361
-                "event_espresso"), $use_default_where_conditions,
3362
-                implode(", ", $allowed_used_default_where_conditions_values)));
3363
-        }
3364
-        $universal_query_params = array();
3365
-        if ($use_default_where_conditions === 'all' || $use_default_where_conditions === 'this_model_only') {
3366
-            $universal_query_params = $this->_get_default_where_conditions();
3367
-        } else if ($use_default_where_conditions === 'minimum') {
3368
-            $universal_query_params = $this->_get_minimum_where_conditions();
3369
-        }
3370
-        if (in_array($use_default_where_conditions, array('all', 'other_models_only'))) {
3371
-            foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3372
-                $related_model = $this->get_related_model_obj($model_name);
3373
-                $related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3374
-                $overrides = $this->_override_defaults_or_make_null_friendly(
3375
-                    $related_model_universal_where_params,
3376
-                    $where_query_params,
3377
-                    $related_model,
3378
-                    $model_relation_path
3379
-                );
3380
-                $universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3381
-                    $universal_query_params,
3382
-                    $overrides
3383
-                );
3384
-            }
3385
-        }
3386
-        return $universal_query_params;
3387
-    }
3388
-
3389
-
3390
-
3391
-    /**
3392
-     * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3393
-     * then we also add a special where condition which allows for that model's primary key
3394
-     * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3395
-     * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3396
-     *
3397
-     * @param array    $default_where_conditions
3398
-     * @param array    $provided_where_conditions
3399
-     * @param EEM_Base $model
3400
-     * @param string   $model_relation_path like 'Transaction.Payment.'
3401
-     * @return array like EEM_Base::get_all's $query_params[0]
3402
-     * @throws \EE_Error
3403
-     */
3404
-    private function _override_defaults_or_make_null_friendly(
3405
-        $default_where_conditions,
3406
-        $provided_where_conditions,
3407
-        $model,
3408
-        $model_relation_path
3409
-    ) {
3410
-        $null_friendly_where_conditions = array();
3411
-        $none_overridden = true;
3412
-        $or_condition_key_for_defaults = 'OR*' . get_class($model);
3413
-        foreach ($default_where_conditions as $key => $val) {
3414
-            if (isset($provided_where_conditions[$key])) {
3415
-                $none_overridden = false;
3416
-            } else {
3417
-                $null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3418
-            }
3419
-        }
3420
-        if ($none_overridden && $default_where_conditions) {
3421
-            if ($model->has_primary_key_field()) {
3422
-                $null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3423
-                                                                                . "."
3424
-                                                                                . $model->primary_key_name()] = array('IS NULL');
3425
-            }/*else{
3269
+						implode(',', $this->_allowed_query_params)
3270
+					)
3271
+				);
3272
+			}
3273
+		}
3274
+		$main_model_join_sql = $query_object->get_main_model_join_sql();
3275
+		if (empty($main_model_join_sql)) {
3276
+			$query_object->set_main_model_join_sql($this->_construct_internal_join());
3277
+		}
3278
+		return $query_object;
3279
+	}
3280
+
3281
+
3282
+
3283
+	/**
3284
+	 * Gets the where conditions that should be imposed on the query based on the
3285
+	 * context (eg reading frontend, backend, edit or delete).
3286
+	 *
3287
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
3288
+	 * @return array like EEM_Base::get_all() 's $query_params[0]
3289
+	 * @throws \EE_Error
3290
+	 */
3291
+	public function caps_where_conditions($context = self::caps_read)
3292
+	{
3293
+		EEM_Base::verify_is_valid_cap_context($context);
3294
+		$cap_where_conditions = array();
3295
+		$cap_restrictions = $this->caps_missing($context);
3296
+		/**
3297
+		 * @var $cap_restrictions EE_Default_Where_Conditions[]
3298
+		 */
3299
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3300
+			$cap_where_conditions = array_replace_recursive($cap_where_conditions,
3301
+				$restriction_if_no_cap->get_default_where_conditions());
3302
+		}
3303
+		return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3304
+			$cap_restrictions);
3305
+	}
3306
+
3307
+
3308
+
3309
+	/**
3310
+	 * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3311
+	 * otherwise throws an exception
3312
+	 *
3313
+	 * @param string $should_be_order_string
3314
+	 * @return string either ASC, asc, DESC or desc
3315
+	 * @throws EE_Error
3316
+	 */
3317
+	private function _extract_order($should_be_order_string)
3318
+	{
3319
+		if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3320
+			return $should_be_order_string;
3321
+		} else {
3322
+			throw new EE_Error(sprintf(__("While performing a query on '%s', tried to use '%s' as an order parameter. ",
3323
+				"event_espresso"), get_class($this), $should_be_order_string));
3324
+		}
3325
+	}
3326
+
3327
+
3328
+
3329
+	/**
3330
+	 * Looks at all the models which are included in this query, and asks each
3331
+	 * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3332
+	 * so they can be merged
3333
+	 *
3334
+	 * @param EE_Model_Query_Info_Carrier $query_info_carrier
3335
+	 * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3336
+	 *                                                                  'none' means NO default where conditions will
3337
+	 *                                                                  be used AT ALL during this query.
3338
+	 *                                                                  'other_models_only' means default where
3339
+	 *                                                                  conditions from other models will be used, but
3340
+	 *                                                                  not for this primary model. 'all', the default,
3341
+	 *                                                                  means default where conditions will apply as
3342
+	 *                                                                  normal
3343
+	 * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3344
+	 * @throws EE_Error
3345
+	 * @return array like $query_params[0], see EEM_Base::get_all for documentation
3346
+	 */
3347
+	private function _get_default_where_conditions_for_models_in_query(
3348
+		EE_Model_Query_Info_Carrier $query_info_carrier,
3349
+		$use_default_where_conditions = 'all',
3350
+		$where_query_params = array()
3351
+	) {
3352
+		$allowed_used_default_where_conditions_values = array(
3353
+			'all',
3354
+			'this_model_only',
3355
+			'other_models_only',
3356
+			'minimum',
3357
+			'none',
3358
+		);
3359
+		if ( ! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3360
+			throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3361
+				"event_espresso"), $use_default_where_conditions,
3362
+				implode(", ", $allowed_used_default_where_conditions_values)));
3363
+		}
3364
+		$universal_query_params = array();
3365
+		if ($use_default_where_conditions === 'all' || $use_default_where_conditions === 'this_model_only') {
3366
+			$universal_query_params = $this->_get_default_where_conditions();
3367
+		} else if ($use_default_where_conditions === 'minimum') {
3368
+			$universal_query_params = $this->_get_minimum_where_conditions();
3369
+		}
3370
+		if (in_array($use_default_where_conditions, array('all', 'other_models_only'))) {
3371
+			foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3372
+				$related_model = $this->get_related_model_obj($model_name);
3373
+				$related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3374
+				$overrides = $this->_override_defaults_or_make_null_friendly(
3375
+					$related_model_universal_where_params,
3376
+					$where_query_params,
3377
+					$related_model,
3378
+					$model_relation_path
3379
+				);
3380
+				$universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3381
+					$universal_query_params,
3382
+					$overrides
3383
+				);
3384
+			}
3385
+		}
3386
+		return $universal_query_params;
3387
+	}
3388
+
3389
+
3390
+
3391
+	/**
3392
+	 * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3393
+	 * then we also add a special where condition which allows for that model's primary key
3394
+	 * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3395
+	 * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3396
+	 *
3397
+	 * @param array    $default_where_conditions
3398
+	 * @param array    $provided_where_conditions
3399
+	 * @param EEM_Base $model
3400
+	 * @param string   $model_relation_path like 'Transaction.Payment.'
3401
+	 * @return array like EEM_Base::get_all's $query_params[0]
3402
+	 * @throws \EE_Error
3403
+	 */
3404
+	private function _override_defaults_or_make_null_friendly(
3405
+		$default_where_conditions,
3406
+		$provided_where_conditions,
3407
+		$model,
3408
+		$model_relation_path
3409
+	) {
3410
+		$null_friendly_where_conditions = array();
3411
+		$none_overridden = true;
3412
+		$or_condition_key_for_defaults = 'OR*' . get_class($model);
3413
+		foreach ($default_where_conditions as $key => $val) {
3414
+			if (isset($provided_where_conditions[$key])) {
3415
+				$none_overridden = false;
3416
+			} else {
3417
+				$null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3418
+			}
3419
+		}
3420
+		if ($none_overridden && $default_where_conditions) {
3421
+			if ($model->has_primary_key_field()) {
3422
+				$null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3423
+																				. "."
3424
+																				. $model->primary_key_name()] = array('IS NULL');
3425
+			}/*else{
3426 3426
 				//@todo NO PK, use other defaults
3427 3427
 			}*/
3428
-        }
3429
-        return $null_friendly_where_conditions;
3430
-    }
3431
-
3432
-
3433
-
3434
-    /**
3435
-     * Uses the _default_where_conditions_strategy set during __construct() to get
3436
-     * default where conditions on all get_all, update, and delete queries done by this model.
3437
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3438
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3439
-     *
3440
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3441
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3442
-     */
3443
-    private function _get_default_where_conditions($model_relation_path = null)
3444
-    {
3445
-        if ($this->_ignore_where_strategy) {
3446
-            return array();
3447
-        }
3448
-        return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3449
-    }
3450
-
3451
-
3452
-
3453
-    /**
3454
-     * Uses the _minimum_where_conditions_strategy set during __construct() to get
3455
-     * minimum where conditions on all get_all, update, and delete queries done by this model.
3456
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3457
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3458
-     * Similar to _get_default_where_conditions
3459
-     *
3460
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3461
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3462
-     */
3463
-    protected function _get_minimum_where_conditions($model_relation_path = null)
3464
-    {
3465
-        if ($this->_ignore_where_strategy) {
3466
-            return array();
3467
-        }
3468
-        return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3469
-    }
3470
-
3471
-
3472
-
3473
-    /**
3474
-     * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3475
-     * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3476
-     *
3477
-     * @param EE_Model_Query_Info_Carrier $model_query_info
3478
-     * @return string
3479
-     * @throws \EE_Error
3480
-     */
3481
-    private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3482
-    {
3483
-        $selects = $this->_get_columns_to_select_for_this_model();
3484
-        foreach (
3485
-            $model_query_info->get_model_names_included() as $model_relation_chain =>
3486
-            $name_of_other_model_included
3487
-        ) {
3488
-            $other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3489
-            $other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3490
-            foreach ($other_model_selects as $key => $value) {
3491
-                $selects[] = $value;
3492
-            }
3493
-        }
3494
-        return implode(", ", $selects);
3495
-    }
3496
-
3497
-
3498
-
3499
-    /**
3500
-     * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3501
-     * So that's going to be the columns for all the fields on the model
3502
-     *
3503
-     * @param string $model_relation_chain like 'Question.Question_Group.Event'
3504
-     * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3505
-     */
3506
-    public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3507
-    {
3508
-        $fields = $this->field_settings();
3509
-        $selects = array();
3510
-        $table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3511
-            $this->get_this_model_name());
3512
-        foreach ($fields as $field_obj) {
3513
-            $selects[] = $table_alias_with_model_relation_chain_prefix
3514
-                         . $field_obj->get_table_alias()
3515
-                         . "."
3516
-                         . $field_obj->get_table_column()
3517
-                         . " AS '"
3518
-                         . $table_alias_with_model_relation_chain_prefix
3519
-                         . $field_obj->get_table_alias()
3520
-                         . "."
3521
-                         . $field_obj->get_table_column()
3522
-                         . "'";
3523
-        }
3524
-        //make sure we are also getting the PKs of each table
3525
-        $tables = $this->get_tables();
3526
-        if (count($tables) > 1) {
3527
-            foreach ($tables as $table_obj) {
3528
-                $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3529
-                                       . $table_obj->get_fully_qualified_pk_column();
3530
-                if ( ! in_array($qualified_pk_column, $selects)) {
3531
-                    $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3532
-                }
3533
-            }
3534
-        }
3535
-        return $selects;
3536
-    }
3537
-
3538
-
3539
-
3540
-    /**
3541
-     * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3542
-     * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3543
-     * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3544
-     * SQL for joining, and the data types
3545
-     *
3546
-     * @param null|string                 $original_query_param
3547
-     * @param string                      $query_param          like Registration.Transaction.TXN_ID
3548
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3549
-     * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3550
-     *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3551
-     *                                                          column name. We only want model names, eg 'Event.Venue'
3552
-     *                                                          or 'Registration's
3553
-     * @param string                      $original_query_param what it originally was (eg
3554
-     *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3555
-     *                                                          matches $query_param
3556
-     * @throws EE_Error
3557
-     * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3558
-     */
3559
-    private function _extract_related_model_info_from_query_param(
3560
-        $query_param,
3561
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3562
-        $query_param_type,
3563
-        $original_query_param = null
3564
-    ) {
3565
-        if ($original_query_param === null) {
3566
-            $original_query_param = $query_param;
3567
-        }
3568
-        $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3569
-        /** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3570
-        $allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3571
-        $allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3572
-        //check to see if we have a field on this model
3573
-        $this_model_fields = $this->field_settings(true);
3574
-        if (array_key_exists($query_param, $this_model_fields)) {
3575
-            if ($allow_fields) {
3576
-                return;
3577
-            } else {
3578
-                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",
3579
-                    "event_espresso"),
3580
-                    $query_param, get_class($this), $query_param_type, $original_query_param));
3581
-            }
3582
-        } //check if this is a special logic query param
3583
-        elseif (in_array($query_param, $this->_logic_query_param_keys, true)) {
3584
-            if ($allow_logic_query_params) {
3585
-                return;
3586
-            } else {
3587
-                throw new EE_Error(
3588
-                    sprintf(
3589
-                        __('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',
3590
-                            'event_espresso'),
3591
-                        implode('", "', $this->_logic_query_param_keys),
3592
-                        $query_param,
3593
-                        get_class($this),
3594
-                        '<br />',
3595
-                        "\t"
3596
-                        . ' $passed_in_query_info = <pre>'
3597
-                        . print_r($passed_in_query_info, true)
3598
-                        . '</pre>'
3599
-                        . "\n\t"
3600
-                        . ' $query_param_type = '
3601
-                        . $query_param_type
3602
-                        . "\n\t"
3603
-                        . ' $original_query_param = '
3604
-                        . $original_query_param
3605
-                    )
3606
-                );
3607
-            }
3608
-        } //check if it's a custom selection
3609
-        elseif (array_key_exists($query_param, $this->_custom_selections)) {
3610
-            return;
3611
-        }
3612
-        //check if has a model name at the beginning
3613
-        //and
3614
-        //check if it's a field on a related model
3615
-        foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3616
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3617
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3618
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
3619
-                if ($query_param === '') {
3620
-                    //nothing left to $query_param
3621
-                    //we should actually end in a field name, not a model like this!
3622
-                    throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3623
-                        "event_espresso"),
3624
-                        $query_param, $query_param_type, get_class($this), $valid_related_model_name));
3625
-                } else {
3626
-                    $related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3627
-                    $related_model_obj->_extract_related_model_info_from_query_param($query_param,
3628
-                        $passed_in_query_info, $query_param_type, $original_query_param);
3629
-                    return;
3630
-                }
3631
-            } elseif ($query_param === $valid_related_model_name) {
3632
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3633
-                return;
3634
-            }
3635
-        }
3636
-        //ok so $query_param didn't start with a model name
3637
-        //and we previously confirmed it wasn't a logic query param or field on the current model
3638
-        //it's wack, that's what it is
3639
-        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",
3640
-            "event_espresso"),
3641
-            $query_param, get_class($this), $query_param_type, $original_query_param));
3642
-    }
3643
-
3644
-
3645
-
3646
-    /**
3647
-     * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3648
-     * and store it on $passed_in_query_info
3649
-     *
3650
-     * @param string                      $model_name
3651
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3652
-     * @param string                      $original_query_param used to extract the relation chain between the queried
3653
-     *                                                          model and $model_name. Eg, if we are querying Event,
3654
-     *                                                          and are adding a join to 'Payment' with the original
3655
-     *                                                          query param key
3656
-     *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3657
-     *                                                          to extract 'Registration.Transaction.Payment', in case
3658
-     *                                                          Payment wants to add default query params so that it
3659
-     *                                                          will know what models to prepend onto its default query
3660
-     *                                                          params or in case it wants to rename tables (in case
3661
-     *                                                          there are multiple joins to the same table)
3662
-     * @return void
3663
-     * @throws \EE_Error
3664
-     */
3665
-    private function _add_join_to_model(
3666
-        $model_name,
3667
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3668
-        $original_query_param
3669
-    ) {
3670
-        $relation_obj = $this->related_settings_for($model_name);
3671
-        $model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3672
-        //check if the relation is HABTM, because then we're essentially doing two joins
3673
-        //If so, join first to the JOIN table, and add its data types, and then continue as normal
3674
-        if ($relation_obj instanceof EE_HABTM_Relation) {
3675
-            $join_model_obj = $relation_obj->get_join_model();
3676
-            //replace the model specified with the join model for this relation chain, whi
3677
-            $relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
3678
-                $join_model_obj->get_this_model_name(), $model_relation_chain);
3679
-            $new_query_info = new EE_Model_Query_Info_Carrier(
3680
-                array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
3681
-                $relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model));
3682
-            $passed_in_query_info->merge($new_query_info);
3683
-        }
3684
-        //now just join to the other table pointed to by the relation object, and add its data types
3685
-        $new_query_info = new EE_Model_Query_Info_Carrier(
3686
-            array($model_relation_chain => $model_name),
3687
-            $relation_obj->get_join_statement($model_relation_chain));
3688
-        $passed_in_query_info->merge($new_query_info);
3689
-    }
3690
-
3691
-
3692
-
3693
-    /**
3694
-     * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
3695
-     *
3696
-     * @param array $where_params like EEM_Base::get_all
3697
-     * @return string of SQL
3698
-     * @throws \EE_Error
3699
-     */
3700
-    private function _construct_where_clause($where_params)
3701
-    {
3702
-        $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
3703
-        if ($SQL) {
3704
-            return " WHERE " . $SQL;
3705
-        } else {
3706
-            return '';
3707
-        }
3708
-    }
3709
-
3710
-
3711
-
3712
-    /**
3713
-     * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
3714
-     * and should be passed HAVING parameters, not WHERE parameters
3715
-     *
3716
-     * @param array $having_params
3717
-     * @return string
3718
-     * @throws \EE_Error
3719
-     */
3720
-    private function _construct_having_clause($having_params)
3721
-    {
3722
-        $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
3723
-        if ($SQL) {
3724
-            return " HAVING " . $SQL;
3725
-        } else {
3726
-            return '';
3727
-        }
3728
-    }
3729
-
3730
-
3731
-
3732
-    /**
3733
-     * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
3734
-     * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
3735
-     * EEM_Attendee.
3736
-     *
3737
-     * @param string $field_name
3738
-     * @param string $model_name
3739
-     * @return EE_Model_Field_Base
3740
-     * @throws EE_Error
3741
-     */
3742
-    protected function _get_field_on_model($field_name, $model_name)
3743
-    {
3744
-        $model_class = 'EEM_' . $model_name;
3745
-        $model_filepath = $model_class . ".model.php";
3746
-        if (is_readable($model_filepath)) {
3747
-            require_once($model_filepath);
3748
-            $model_instance = call_user_func($model_name . "::instance");
3749
-            /* @var $model_instance EEM_Base */
3750
-            return $model_instance->field_settings_for($field_name);
3751
-        } else {
3752
-            throw new EE_Error(sprintf(__('No model named %s exists, with classname %s and filepath %s',
3753
-                'event_espresso'), $model_name, $model_class, $model_filepath));
3754
-        }
3755
-    }
3756
-
3757
-
3758
-
3759
-    /**
3760
-     * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
3761
-     * Event_Meta.meta_value = 'foo'))"
3762
-     *
3763
-     * @param array  $where_params see EEM_Base::get_all for documentation
3764
-     * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
3765
-     * @throws EE_Error
3766
-     * @return string of SQL
3767
-     */
3768
-    private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
3769
-    {
3770
-        $where_clauses = array();
3771
-        foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
3772
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
3773
-            if (in_array($query_param, $this->_logic_query_param_keys)) {
3774
-                switch ($query_param) {
3775
-                    case 'not':
3776
-                    case 'NOT':
3777
-                        $where_clauses[] = "! ("
3778
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3779
-                                $glue)
3780
-                                           . ")";
3781
-                        break;
3782
-                    case 'and':
3783
-                    case 'AND':
3784
-                        $where_clauses[] = " ("
3785
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3786
-                                ' AND ')
3787
-                                           . ")";
3788
-                        break;
3789
-                    case 'or':
3790
-                    case 'OR':
3791
-                        $where_clauses[] = " ("
3792
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3793
-                                ' OR ')
3794
-                                           . ")";
3795
-                        break;
3796
-                }
3797
-            } else {
3798
-                $field_obj = $this->_deduce_field_from_query_param($query_param);
3799
-                //if it's not a normal field, maybe it's a custom selection?
3800
-                if ( ! $field_obj) {
3801
-                    if (isset($this->_custom_selections[$query_param][1])) {
3802
-                        $field_obj = $this->_custom_selections[$query_param][1];
3803
-                    } else {
3804
-                        throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
3805
-                            "event_espresso"), $query_param));
3806
-                    }
3807
-                }
3808
-                $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
3809
-                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
3810
-            }
3811
-        }
3812
-        return $where_clauses ? implode($glue, $where_clauses) : '';
3813
-    }
3814
-
3815
-
3816
-
3817
-    /**
3818
-     * Takes the input parameter and extract the table name (alias) and column name
3819
-     *
3820
-     * @param array $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
3821
-     * @throws EE_Error
3822
-     * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
3823
-     */
3824
-    private function _deduce_column_name_from_query_param($query_param)
3825
-    {
3826
-        $field = $this->_deduce_field_from_query_param($query_param);
3827
-        if ($field) {
3828
-            $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
3829
-                $query_param);
3830
-            return $table_alias_prefix . $field->get_qualified_column();
3831
-        } elseif (array_key_exists($query_param, $this->_custom_selections)) {
3832
-            //maybe it's custom selection item?
3833
-            //if so, just use it as the "column name"
3834
-            return $query_param;
3835
-        } else {
3836
-            throw new EE_Error(sprintf(__("%s is not a valid field on this model, nor a custom selection (%s)",
3837
-                "event_espresso"), $query_param, implode(",", $this->_custom_selections)));
3838
-        }
3839
-    }
3840
-
3841
-
3842
-
3843
-    /**
3844
-     * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
3845
-     * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
3846
-     * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
3847
-     * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
3848
-     *
3849
-     * @param string $condition_query_param_key
3850
-     * @return string
3851
-     */
3852
-    private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
3853
-    {
3854
-        $pos_of_star = strpos($condition_query_param_key, '*');
3855
-        if ($pos_of_star === false) {
3856
-            return $condition_query_param_key;
3857
-        } else {
3858
-            $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
3859
-            return $condition_query_param_sans_star;
3860
-        }
3861
-    }
3862
-
3863
-
3864
-
3865
-    /**
3866
-     * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
3867
-     *
3868
-     * @param                            mixed      array | string    $op_and_value
3869
-     * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
3870
-     * @throws EE_Error
3871
-     * @return string
3872
-     */
3873
-    private function _construct_op_and_value($op_and_value, $field_obj)
3874
-    {
3875
-        if (is_array($op_and_value)) {
3876
-            $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
3877
-            if ( ! $operator) {
3878
-                $php_array_like_string = array();
3879
-                foreach ($op_and_value as $key => $value) {
3880
-                    $php_array_like_string[] = "$key=>$value";
3881
-                }
3882
-                throw new EE_Error(
3883
-                    sprintf(
3884
-                        __(
3885
-                            "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))",
3886
-                            "event_espresso"
3887
-                        ),
3888
-                        implode(",", $php_array_like_string)
3889
-                    )
3890
-                );
3891
-            }
3892
-            $value = isset($op_and_value[1]) ? $op_and_value[1] : null;
3893
-        } else {
3894
-            $operator = '=';
3895
-            $value = $op_and_value;
3896
-        }
3897
-        //check to see if the value is actually another field
3898
-        if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
3899
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
3900
-        } elseif (in_array($operator, $this->_in_style_operators) && is_array($value)) {
3901
-            //in this case, the value should be an array, or at least a comma-separated list
3902
-            //it will need to handle a little differently
3903
-            $cleaned_value = $this->_construct_in_value($value, $field_obj);
3904
-            //note: $cleaned_value has already been run through $wpdb->prepare()
3905
-            return $operator . SP . $cleaned_value;
3906
-        } elseif (in_array($operator, $this->_between_style_operators) && is_array($value)) {
3907
-            //the value should be an array with count of two.
3908
-            if (count($value) !== 2) {
3909
-                throw new EE_Error(
3910
-                    sprintf(
3911
-                        __(
3912
-                            "The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
3913
-                            'event_espresso'
3914
-                        ),
3915
-                        "BETWEEN"
3916
-                    )
3917
-                );
3918
-            }
3919
-            $cleaned_value = $this->_construct_between_value($value, $field_obj);
3920
-            return $operator . SP . $cleaned_value;
3921
-        } elseif (in_array($operator, $this->_null_style_operators)) {
3922
-            if ($value !== null) {
3923
-                throw new EE_Error(
3924
-                    sprintf(
3925
-                        __(
3926
-                            "You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
3927
-                            "event_espresso"
3928
-                        ),
3929
-                        $value,
3930
-                        $operator
3931
-                    )
3932
-                );
3933
-            }
3934
-            return $operator;
3935
-        } elseif ($operator === 'LIKE' && ! is_array($value)) {
3936
-            //if the operator is 'LIKE', we want to allow percent signs (%) and not
3937
-            //remove other junk. So just treat it as a string.
3938
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
3939
-        } elseif ( ! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
3940
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
3941
-        } elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
3942
-            throw new EE_Error(
3943
-                sprintf(
3944
-                    __(
3945
-                        "Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
3946
-                        'event_espresso'
3947
-                    ),
3948
-                    $operator,
3949
-                    $operator
3950
-                )
3951
-            );
3952
-        } elseif ( ! in_array($operator, $this->_in_style_operators) && is_array($value)) {
3953
-            throw new EE_Error(
3954
-                sprintf(
3955
-                    __(
3956
-                        "Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
3957
-                        'event_espresso'
3958
-                    ),
3959
-                    $operator,
3960
-                    $operator
3961
-                )
3962
-            );
3963
-        } else {
3964
-            throw new EE_Error(
3965
-                sprintf(
3966
-                    __(
3967
-                        "It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
3968
-                        "event_espresso"
3969
-                    ),
3970
-                    http_build_query($op_and_value)
3971
-                )
3972
-            );
3973
-        }
3974
-    }
3975
-
3976
-
3977
-
3978
-    /**
3979
-     * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
3980
-     *
3981
-     * @param array                      $values
3982
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
3983
-     *                                              '%s'
3984
-     * @return string
3985
-     * @throws \EE_Error
3986
-     */
3987
-    public function _construct_between_value($values, $field_obj)
3988
-    {
3989
-        $cleaned_values = array();
3990
-        foreach ($values as $value) {
3991
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
3992
-        }
3993
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
3994
-    }
3995
-
3996
-
3997
-
3998
-    /**
3999
-     * Takes an array or a comma-separated list of $values and cleans them
4000
-     * according to $data_type using $wpdb->prepare, and then makes the list a
4001
-     * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4002
-     * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4003
-     * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4004
-     *
4005
-     * @param mixed                      $values    array or comma-separated string
4006
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4007
-     * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4008
-     * @throws \EE_Error
4009
-     */
4010
-    public function _construct_in_value($values, $field_obj)
4011
-    {
4012
-        //check if the value is a CSV list
4013
-        if (is_string($values)) {
4014
-            //in which case, turn it into an array
4015
-            $values = explode(",", $values);
4016
-        }
4017
-        $cleaned_values = array();
4018
-        foreach ($values as $value) {
4019
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4020
-        }
4021
-        //we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4022
-        //but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4023
-        //which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4024
-        if (empty($cleaned_values)) {
4025
-            $all_fields = $this->field_settings();
4026
-            $a_field = array_shift($all_fields);
4027
-            $main_table = $this->_get_main_table();
4028
-            $cleaned_values[] = "SELECT "
4029
-                                . $a_field->get_table_column()
4030
-                                . " FROM "
4031
-                                . $main_table->get_table_name()
4032
-                                . " WHERE FALSE";
4033
-        }
4034
-        return "(" . implode(",", $cleaned_values) . ")";
4035
-    }
4036
-
4037
-
4038
-
4039
-    /**
4040
-     * @param mixed                      $value
4041
-     * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4042
-     * @throws EE_Error
4043
-     * @return false|null|string
4044
-     */
4045
-    private function _wpdb_prepare_using_field($value, $field_obj)
4046
-    {
4047
-        /** @type WPDB $wpdb */
4048
-        global $wpdb;
4049
-        if ($field_obj instanceof EE_Model_Field_Base) {
4050
-            return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4051
-                $this->_prepare_value_for_use_in_db($value, $field_obj));
4052
-        } else {//$field_obj should really just be a data type
4053
-            if ( ! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4054
-                throw new EE_Error(sprintf(__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4055
-                    $field_obj, implode(",", $this->_valid_wpdb_data_types)));
4056
-            }
4057
-            return $wpdb->prepare($field_obj, $value);
4058
-        }
4059
-    }
4060
-
4061
-
4062
-
4063
-    /**
4064
-     * Takes the input parameter and finds the model field that it indicates.
4065
-     *
4066
-     * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4067
-     * @throws EE_Error
4068
-     * @return EE_Model_Field_Base
4069
-     */
4070
-    protected function _deduce_field_from_query_param($query_param_name)
4071
-    {
4072
-        //ok, now proceed with deducing which part is the model's name, and which is the field's name
4073
-        //which will help us find the database table and column
4074
-        $query_param_parts = explode(".", $query_param_name);
4075
-        if (empty($query_param_parts)) {
4076
-            throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4077
-                'event_espresso'), $query_param_name));
4078
-        }
4079
-        $number_of_parts = count($query_param_parts);
4080
-        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4081
-        if ($number_of_parts === 1) {
4082
-            $field_name = $last_query_param_part;
4083
-            $model_obj = $this;
4084
-        } else {// $number_of_parts >= 2
4085
-            //the last part is the column name, and there are only 2parts. therefore...
4086
-            $field_name = $last_query_param_part;
4087
-            $model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4088
-        }
4089
-        try {
4090
-            return $model_obj->field_settings_for($field_name);
4091
-        } catch (EE_Error $e) {
4092
-            return null;
4093
-        }
4094
-    }
4095
-
4096
-
4097
-
4098
-    /**
4099
-     * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4100
-     * alias and column which corresponds to it
4101
-     *
4102
-     * @param string $field_name
4103
-     * @throws EE_Error
4104
-     * @return string
4105
-     */
4106
-    public function _get_qualified_column_for_field($field_name)
4107
-    {
4108
-        $all_fields = $this->field_settings();
4109
-        $field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4110
-        if ($field) {
4111
-            return $field->get_qualified_column();
4112
-        } else {
4113
-            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.",
4114
-                'event_espresso'), $field_name, get_class($this)));
4115
-        }
4116
-    }
4117
-
4118
-
4119
-
4120
-    /**
4121
-     * constructs the select use on special limit joins
4122
-     * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4123
-     * its setup so the select query will be setup on and just doing the special select join off of the primary table
4124
-     * (as that is typically where the limits would be set).
4125
-     *
4126
-     * @param  string       $table_alias The table the select is being built for
4127
-     * @param  mixed|string $limit       The limit for this select
4128
-     * @return string                The final select join element for the query.
4129
-     */
4130
-    public function _construct_limit_join_select($table_alias, $limit)
4131
-    {
4132
-        $SQL = '';
4133
-        foreach ($this->_tables as $table_obj) {
4134
-            if ($table_obj instanceof EE_Primary_Table) {
4135
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4136
-                    ? $table_obj->get_select_join_limit($limit)
4137
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4138
-            } elseif ($table_obj instanceof EE_Secondary_Table) {
4139
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4140
-                    ? $table_obj->get_select_join_limit_join($limit)
4141
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
4142
-            }
4143
-        }
4144
-        return $SQL;
4145
-    }
4146
-
4147
-
4148
-
4149
-    /**
4150
-     * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4151
-     * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4152
-     *
4153
-     * @return string SQL
4154
-     * @throws \EE_Error
4155
-     */
4156
-    public function _construct_internal_join()
4157
-    {
4158
-        $SQL = $this->_get_main_table()->get_table_sql();
4159
-        $SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4160
-        return $SQL;
4161
-    }
4162
-
4163
-
4164
-
4165
-    /**
4166
-     * Constructs the SQL for joining all the tables on this model.
4167
-     * Normally $alias should be the primary table's alias, but in cases where
4168
-     * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4169
-     * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4170
-     * alias, this will construct SQL like:
4171
-     * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4172
-     * With $alias being a secondary table's alias, this will construct SQL like:
4173
-     * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4174
-     *
4175
-     * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4176
-     * @return string
4177
-     */
4178
-    public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4179
-    {
4180
-        $SQL = '';
4181
-        $alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4182
-        foreach ($this->_tables as $table_obj) {
4183
-            if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4184
-                if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4185
-                    //so we're joining to this table, meaning the table is already in
4186
-                    //the FROM statement, BUT the primary table isn't. So we want
4187
-                    //to add the inverse join sql
4188
-                    $SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4189
-                } else {
4190
-                    //just add a regular JOIN to this table from the primary table
4191
-                    $SQL .= $table_obj->get_join_sql($alias_prefixed);
4192
-                }
4193
-            }//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4194
-        }
4195
-        return $SQL;
4196
-    }
4197
-
4198
-
4199
-
4200
-    /**
4201
-     * Gets an array for storing all the data types on the next-to-be-executed-query.
4202
-     * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4203
-     * their data type (eg, '%s', '%d', etc)
4204
-     *
4205
-     * @return array
4206
-     */
4207
-    public function _get_data_types()
4208
-    {
4209
-        $data_types = array();
4210
-        foreach ($this->field_settings() as $field_obj) {
4211
-            //$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4212
-            /** @var $field_obj EE_Model_Field_Base */
4213
-            $data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4214
-        }
4215
-        return $data_types;
4216
-    }
4217
-
4218
-
4219
-
4220
-    /**
4221
-     * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4222
-     *
4223
-     * @param string $model_name
4224
-     * @throws EE_Error
4225
-     * @return EEM_Base
4226
-     */
4227
-    public function get_related_model_obj($model_name)
4228
-    {
4229
-        $model_classname = "EEM_" . $model_name;
4230
-        if ( ! class_exists($model_classname)) {
4231
-            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",
4232
-                'event_espresso'), $model_name, $model_classname));
4233
-        }
4234
-        return call_user_func($model_classname . "::instance");
4235
-    }
4236
-
4237
-
4238
-
4239
-    /**
4240
-     * Returns the array of EE_ModelRelations for this model.
4241
-     *
4242
-     * @return EE_Model_Relation_Base[]
4243
-     */
4244
-    public function relation_settings()
4245
-    {
4246
-        return $this->_model_relations;
4247
-    }
4248
-
4249
-
4250
-
4251
-    /**
4252
-     * Gets all related models that this model BELONGS TO. Handy to know sometimes
4253
-     * because without THOSE models, this model probably doesn't have much purpose.
4254
-     * (Eg, without an event, datetimes have little purpose.)
4255
-     *
4256
-     * @return EE_Belongs_To_Relation[]
4257
-     */
4258
-    public function belongs_to_relations()
4259
-    {
4260
-        $belongs_to_relations = array();
4261
-        foreach ($this->relation_settings() as $model_name => $relation_obj) {
4262
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
4263
-                $belongs_to_relations[$model_name] = $relation_obj;
4264
-            }
4265
-        }
4266
-        return $belongs_to_relations;
4267
-    }
4268
-
4269
-
4270
-
4271
-    /**
4272
-     * Returns the specified EE_Model_Relation, or throws an exception
4273
-     *
4274
-     * @param string $relation_name name of relation, key in $this->_relatedModels
4275
-     * @throws EE_Error
4276
-     * @return EE_Model_Relation_Base
4277
-     */
4278
-    public function related_settings_for($relation_name)
4279
-    {
4280
-        $relatedModels = $this->relation_settings();
4281
-        if ( ! array_key_exists($relation_name, $relatedModels)) {
4282
-            throw new EE_Error(
4283
-                sprintf(
4284
-                    __('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4285
-                        'event_espresso'),
4286
-                    $relation_name,
4287
-                    $this->_get_class_name(),
4288
-                    implode(', ', array_keys($relatedModels))
4289
-                )
4290
-            );
4291
-        }
4292
-        return $relatedModels[$relation_name];
4293
-    }
4294
-
4295
-
4296
-
4297
-    /**
4298
-     * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4299
-     * fields
4300
-     *
4301
-     * @param string $fieldName
4302
-     * @throws EE_Error
4303
-     * @return EE_Model_Field_Base
4304
-     */
4305
-    public function field_settings_for($fieldName)
4306
-    {
4307
-        $fieldSettings = $this->field_settings(true);
4308
-        if ( ! array_key_exists($fieldName, $fieldSettings)) {
4309
-            throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4310
-                get_class($this)));
4311
-        }
4312
-        return $fieldSettings[$fieldName];
4313
-    }
4314
-
4315
-
4316
-
4317
-    /**
4318
-     * Checks if this field exists on this model
4319
-     *
4320
-     * @param string $fieldName a key in the model's _field_settings array
4321
-     * @return boolean
4322
-     */
4323
-    public function has_field($fieldName)
4324
-    {
4325
-        $fieldSettings = $this->field_settings(true);
4326
-        if (isset($fieldSettings[$fieldName])) {
4327
-            return true;
4328
-        } else {
4329
-            return false;
4330
-        }
4331
-    }
4332
-
4333
-
4334
-
4335
-    /**
4336
-     * Returns whether or not this model has a relation to the specified model
4337
-     *
4338
-     * @param string $relation_name possibly one of the keys in the relation_settings array
4339
-     * @return boolean
4340
-     */
4341
-    public function has_relation($relation_name)
4342
-    {
4343
-        $relations = $this->relation_settings();
4344
-        if (isset($relations[$relation_name])) {
4345
-            return true;
4346
-        } else {
4347
-            return false;
4348
-        }
4349
-    }
4350
-
4351
-
4352
-
4353
-    /**
4354
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4355
-     * Eg, on EE_Answer that would be ANS_ID field object
4356
-     *
4357
-     * @param $field_obj
4358
-     * @return boolean
4359
-     */
4360
-    public function is_primary_key_field($field_obj)
4361
-    {
4362
-        return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4363
-    }
4364
-
4365
-
4366
-
4367
-    /**
4368
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4369
-     * Eg, on EE_Answer that would be ANS_ID field object
4370
-     *
4371
-     * @return EE_Model_Field_Base
4372
-     * @throws EE_Error
4373
-     */
4374
-    public function get_primary_key_field()
4375
-    {
4376
-        if ($this->_primary_key_field === null) {
4377
-            foreach ($this->field_settings(true) as $field_obj) {
4378
-                if ($this->is_primary_key_field($field_obj)) {
4379
-                    $this->_primary_key_field = $field_obj;
4380
-                    break;
4381
-                }
4382
-            }
4383
-            if ( ! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4384
-                throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4385
-                    get_class($this)));
4386
-            }
4387
-        }
4388
-        return $this->_primary_key_field;
4389
-    }
4390
-
4391
-
4392
-
4393
-    /**
4394
-     * Returns whether or not not there is a primary key on this model.
4395
-     * Internally does some caching.
4396
-     *
4397
-     * @return boolean
4398
-     */
4399
-    public function has_primary_key_field()
4400
-    {
4401
-        if ($this->_has_primary_key_field === null) {
4402
-            try {
4403
-                $this->get_primary_key_field();
4404
-                $this->_has_primary_key_field = true;
4405
-            } catch (EE_Error $e) {
4406
-                $this->_has_primary_key_field = false;
4407
-            }
4408
-        }
4409
-        return $this->_has_primary_key_field;
4410
-    }
4411
-
4412
-
4413
-
4414
-    /**
4415
-     * Finds the first field of type $field_class_name.
4416
-     *
4417
-     * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4418
-     *                                 EE_Foreign_Key_Field, etc
4419
-     * @return EE_Model_Field_Base or null if none is found
4420
-     */
4421
-    public function get_a_field_of_type($field_class_name)
4422
-    {
4423
-        foreach ($this->field_settings() as $field) {
4424
-            if ($field instanceof $field_class_name) {
4425
-                return $field;
4426
-            }
4427
-        }
4428
-        return null;
4429
-    }
4430
-
4431
-
4432
-
4433
-    /**
4434
-     * Gets a foreign key field pointing to model.
4435
-     *
4436
-     * @param string $model_name eg Event, Registration, not EEM_Event
4437
-     * @return EE_Foreign_Key_Field_Base
4438
-     * @throws EE_Error
4439
-     */
4440
-    public function get_foreign_key_to($model_name)
4441
-    {
4442
-        if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4443
-            foreach ($this->field_settings() as $field) {
4444
-                if (
4445
-                    $field instanceof EE_Foreign_Key_Field_Base
4446
-                    && in_array($model_name, $field->get_model_names_pointed_to())
4447
-                ) {
4448
-                    $this->_cache_foreign_key_to_fields[$model_name] = $field;
4449
-                    break;
4450
-                }
4451
-            }
4452
-            if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4453
-                throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4454
-                    'event_espresso'), $model_name, get_class($this)));
4455
-            }
4456
-        }
4457
-        return $this->_cache_foreign_key_to_fields[$model_name];
4458
-    }
4459
-
4460
-
4461
-
4462
-    /**
4463
-     * Gets the actual table for the table alias
4464
-     *
4465
-     * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4466
-     *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4467
-     *                            Either one works
4468
-     * @return EE_Table_Base
4469
-     */
4470
-    public function get_table_for_alias($table_alias)
4471
-    {
4472
-        $table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4473
-        return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4474
-    }
4475
-
4476
-
4477
-
4478
-    /**
4479
-     * Returns a flat array of all field son this model, instead of organizing them
4480
-     * by table_alias as they are in the constructor.
4481
-     *
4482
-     * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4483
-     * @return EE_Model_Field_Base[] where the keys are the field's name
4484
-     */
4485
-    public function field_settings($include_db_only_fields = false)
4486
-    {
4487
-        if ($include_db_only_fields) {
4488
-            if ($this->_cached_fields === null) {
4489
-                $this->_cached_fields = array();
4490
-                foreach ($this->_fields as $fields_corresponding_to_table) {
4491
-                    foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4492
-                        $this->_cached_fields[$field_name] = $field_obj;
4493
-                    }
4494
-                }
4495
-            }
4496
-            return $this->_cached_fields;
4497
-        } else {
4498
-            if ($this->_cached_fields_non_db_only === null) {
4499
-                $this->_cached_fields_non_db_only = array();
4500
-                foreach ($this->_fields as $fields_corresponding_to_table) {
4501
-                    foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4502
-                        /** @var $field_obj EE_Model_Field_Base */
4503
-                        if ( ! $field_obj->is_db_only_field()) {
4504
-                            $this->_cached_fields_non_db_only[$field_name] = $field_obj;
4505
-                        }
4506
-                    }
4507
-                }
4508
-            }
4509
-            return $this->_cached_fields_non_db_only;
4510
-        }
4511
-    }
4512
-
4513
-
4514
-
4515
-    /**
4516
-     *        cycle though array of attendees and create objects out of each item
4517
-     *
4518
-     * @access        private
4519
-     * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4520
-     * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4521
-     *                          numerically indexed)
4522
-     * @throws \EE_Error
4523
-     */
4524
-    protected function _create_objects($rows = array())
4525
-    {
4526
-        $array_of_objects = array();
4527
-        if (empty($rows)) {
4528
-            return array();
4529
-        }
4530
-        $count_if_model_has_no_primary_key = 0;
4531
-        $has_primary_key = $this->has_primary_key_field();
4532
-        $primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4533
-        foreach ((array)$rows as $row) {
4534
-            if (empty($row)) {
4535
-                //wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4536
-                return array();
4537
-            }
4538
-            //check if we've already set this object in the results array,
4539
-            //in which case there's no need to process it further (again)
4540
-            if ($has_primary_key) {
4541
-                $table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4542
-                    $row,
4543
-                    $primary_key_field->get_qualified_column(),
4544
-                    $primary_key_field->get_table_column()
4545
-                );
4546
-                if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4547
-                    continue;
4548
-                }
4549
-            }
4550
-            $classInstance = $this->instantiate_class_from_array_or_object($row);
4551
-            if ( ! $classInstance) {
4552
-                throw new EE_Error(
4553
-                    sprintf(
4554
-                        __('Could not create instance of class %s from row %s', 'event_espresso'),
4555
-                        $this->get_this_model_name(),
4556
-                        http_build_query($row)
4557
-                    )
4558
-                );
4559
-            }
4560
-            //set the timezone on the instantiated objects
4561
-            $classInstance->set_timezone($this->_timezone);
4562
-            //make sure if there is any timezone setting present that we set the timezone for the object
4563
-            $key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4564
-            $array_of_objects[$key] = $classInstance;
4565
-            //also, for all the relations of type BelongsTo, see if we can cache
4566
-            //those related models
4567
-            //(we could do this for other relations too, but if there are conditions
4568
-            //that filtered out some fo the results, then we'd be caching an incomplete set
4569
-            //so it requires a little more thought than just caching them immediately...)
4570
-            foreach ($this->_model_relations as $modelName => $relation_obj) {
4571
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
4572
-                    //check if this model's INFO is present. If so, cache it on the model
4573
-                    $other_model = $relation_obj->get_other_model();
4574
-                    $other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4575
-                    //if we managed to make a model object from the results, cache it on the main model object
4576
-                    if ($other_model_obj_maybe) {
4577
-                        //set timezone on these other model objects if they are present
4578
-                        $other_model_obj_maybe->set_timezone($this->_timezone);
4579
-                        $classInstance->cache($modelName, $other_model_obj_maybe);
4580
-                    }
4581
-                }
4582
-            }
4583
-        }
4584
-        return $array_of_objects;
4585
-    }
4586
-
4587
-
4588
-
4589
-    /**
4590
-     * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4591
-     * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4592
-     * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4593
-     * object (as set in the model_field!).
4594
-     *
4595
-     * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4596
-     */
4597
-    public function create_default_object()
4598
-    {
4599
-        $this_model_fields_and_values = array();
4600
-        //setup the row using default values;
4601
-        foreach ($this->field_settings() as $field_name => $field_obj) {
4602
-            $this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
4603
-        }
4604
-        $className = $this->_get_class_name();
4605
-        $classInstance = EE_Registry::instance()
4606
-                                    ->load_class($className, array($this_model_fields_and_values), false, false);
4607
-        return $classInstance;
4608
-    }
4609
-
4610
-
4611
-
4612
-    /**
4613
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
4614
-     *                             or an stdClass where each property is the name of a column,
4615
-     * @return EE_Base_Class
4616
-     * @throws \EE_Error
4617
-     */
4618
-    public function instantiate_class_from_array_or_object($cols_n_values)
4619
-    {
4620
-        if ( ! is_array($cols_n_values) && is_object($cols_n_values)) {
4621
-            $cols_n_values = get_object_vars($cols_n_values);
4622
-        }
4623
-        $primary_key = null;
4624
-        //make sure the array only has keys that are fields/columns on this model
4625
-        $this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4626
-        if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
4627
-            $primary_key = $this_model_fields_n_values[$this->primary_key_name()];
4628
-        }
4629
-        $className = $this->_get_class_name();
4630
-        //check we actually found results that we can use to build our model object
4631
-        //if not, return null
4632
-        if ($this->has_primary_key_field()) {
4633
-            if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
4634
-                return null;
4635
-            }
4636
-        } else if ($this->unique_indexes()) {
4637
-            $first_column = reset($this_model_fields_n_values);
4638
-            if (empty($first_column)) {
4639
-                return null;
4640
-            }
4641
-        }
4642
-        // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
4643
-        if ($primary_key) {
4644
-            $classInstance = $this->get_from_entity_map($primary_key);
4645
-            if ( ! $classInstance) {
4646
-                $classInstance = EE_Registry::instance()
4647
-                                            ->load_class($className,
4648
-                                                array($this_model_fields_n_values, $this->_timezone), true, false);
4649
-                // add this new object to the entity map
4650
-                $classInstance = $this->add_to_entity_map($classInstance);
4651
-            }
4652
-        } else {
4653
-            $classInstance = EE_Registry::instance()
4654
-                                        ->load_class($className, array($this_model_fields_n_values, $this->_timezone),
4655
-                                            true, false);
4656
-        }
4657
-        //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.
4658
-        $this->set_timezone($classInstance->get_timezone());
4659
-        return $classInstance;
4660
-    }
4661
-
4662
-
4663
-
4664
-    /**
4665
-     * Gets the model object from the  entity map if it exists
4666
-     *
4667
-     * @param int|string $id the ID of the model object
4668
-     * @return EE_Base_Class
4669
-     */
4670
-    public function get_from_entity_map($id)
4671
-    {
4672
-        return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
4673
-            ? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
4674
-    }
4675
-
4676
-
4677
-
4678
-    /**
4679
-     * add_to_entity_map
4680
-     * Adds the object to the model's entity mappings
4681
-     *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
4682
-     *        and for the remainder of the request, it's even more up-to-date than what's in the database.
4683
-     *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
4684
-     *        If the database gets updated directly and you want the entity mapper to reflect that change,
4685
-     *        then this method should be called immediately after the update query
4686
-     * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
4687
-     * so on multisite, the entity map is specific to the query being done for a specific site.
4688
-     *
4689
-     * @param    EE_Base_Class $object
4690
-     * @throws EE_Error
4691
-     * @return \EE_Base_Class
4692
-     */
4693
-    public function add_to_entity_map(EE_Base_Class $object)
4694
-    {
4695
-        $className = $this->_get_class_name();
4696
-        if ( ! $object instanceof $className) {
4697
-            throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
4698
-                is_object($object) ? get_class($object) : $object, $className));
4699
-        }
4700
-        /** @var $object EE_Base_Class */
4701
-        if ( ! $object->ID()) {
4702
-            throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
4703
-                "event_espresso"), get_class($this)));
4704
-        }
4705
-        // double check it's not already there
4706
-        $classInstance = $this->get_from_entity_map($object->ID());
4707
-        if ($classInstance) {
4708
-            return $classInstance;
4709
-        } else {
4710
-            $this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
4711
-            return $object;
4712
-        }
4713
-    }
4714
-
4715
-
4716
-
4717
-    /**
4718
-     * if a valid identifier is provided, then that entity is unset from the entity map,
4719
-     * if no identifier is provided, then the entire entity map is emptied
4720
-     *
4721
-     * @param int|string $id the ID of the model object
4722
-     * @return boolean
4723
-     */
4724
-    public function clear_entity_map($id = null)
4725
-    {
4726
-        if (empty($id)) {
4727
-            $this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
4728
-            return true;
4729
-        }
4730
-        if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
4731
-            unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
4732
-            return true;
4733
-        }
4734
-        return false;
4735
-    }
4736
-
4737
-
4738
-
4739
-    /**
4740
-     * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
4741
-     * Given an array where keys are column (or column alias) names and values,
4742
-     * returns an array of their corresponding field names and database values
4743
-     *
4744
-     * @param array $cols_n_values
4745
-     * @return array
4746
-     */
4747
-    public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
4748
-    {
4749
-        return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4750
-    }
4751
-
4752
-
4753
-
4754
-    /**
4755
-     * _deduce_fields_n_values_from_cols_n_values
4756
-     * Given an array where keys are column (or column alias) names and values,
4757
-     * returns an array of their corresponding field names and database values
4758
-     *
4759
-     * @param string $cols_n_values
4760
-     * @return array
4761
-     */
4762
-    protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
4763
-    {
4764
-        $this_model_fields_n_values = array();
4765
-        foreach ($this->get_tables() as $table_alias => $table_obj) {
4766
-            $table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
4767
-                $table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
4768
-            //there is a primary key on this table and its not set. Use defaults for all its columns
4769
-            if ($table_pk_value === null && $table_obj->get_pk_column()) {
4770
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
4771
-                    if ( ! $field_obj->is_db_only_field()) {
4772
-                        //prepare field as if its coming from db
4773
-                        $prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
4774
-                        $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
4775
-                    }
4776
-                }
4777
-            } else {
4778
-                //the table's rows existed. Use their values
4779
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
4780
-                    if ( ! $field_obj->is_db_only_field()) {
4781
-                        $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
4782
-                            $cols_n_values, $field_obj->get_qualified_column(),
4783
-                            $field_obj->get_table_column()
4784
-                        );
4785
-                    }
4786
-                }
4787
-            }
4788
-        }
4789
-        return $this_model_fields_n_values;
4790
-    }
4791
-
4792
-
4793
-
4794
-    /**
4795
-     * @param $cols_n_values
4796
-     * @param $qualified_column
4797
-     * @param $regular_column
4798
-     * @return null
4799
-     */
4800
-    protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
4801
-    {
4802
-        $value = null;
4803
-        //ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
4804
-        //does the field on the model relate to this column retrieved from the db?
4805
-        //or is it a db-only field? (not relating to the model)
4806
-        if (isset($cols_n_values[$qualified_column])) {
4807
-            $value = $cols_n_values[$qualified_column];
4808
-        } elseif (isset($cols_n_values[$regular_column])) {
4809
-            $value = $cols_n_values[$regular_column];
4810
-        }
4811
-        return $value;
4812
-    }
4813
-
4814
-
4815
-
4816
-    /**
4817
-     * refresh_entity_map_from_db
4818
-     * Makes sure the model object in the entity map at $id assumes the values
4819
-     * of the database (opposite of EE_base_Class::save())
4820
-     *
4821
-     * @param int|string $id
4822
-     * @return EE_Base_Class
4823
-     * @throws \EE_Error
4824
-     */
4825
-    public function refresh_entity_map_from_db($id)
4826
-    {
4827
-        $obj_in_map = $this->get_from_entity_map($id);
4828
-        if ($obj_in_map) {
4829
-            $wpdb_results = $this->_get_all_wpdb_results(
4830
-                array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
4831
-            );
4832
-            if ($wpdb_results && is_array($wpdb_results)) {
4833
-                $one_row = reset($wpdb_results);
4834
-                foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
4835
-                    $obj_in_map->set_from_db($field_name, $db_value);
4836
-                }
4837
-                //clear the cache of related model objects
4838
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
4839
-                    $obj_in_map->clear_cache($relation_name, null, true);
4840
-                }
4841
-            }
4842
-            return $obj_in_map;
4843
-        } else {
4844
-            return $this->get_one_by_ID($id);
4845
-        }
4846
-    }
4847
-
4848
-
4849
-
4850
-    /**
4851
-     * refresh_entity_map_with
4852
-     * Leaves the entry in the entity map alone, but updates it to match the provided
4853
-     * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
4854
-     * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
4855
-     * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
4856
-     *
4857
-     * @param int|string    $id
4858
-     * @param EE_Base_Class $replacing_model_obj
4859
-     * @return \EE_Base_Class
4860
-     * @throws \EE_Error
4861
-     */
4862
-    public function refresh_entity_map_with($id, $replacing_model_obj)
4863
-    {
4864
-        $obj_in_map = $this->get_from_entity_map($id);
4865
-        if ($obj_in_map) {
4866
-            if ($replacing_model_obj instanceof EE_Base_Class) {
4867
-                foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
4868
-                    $obj_in_map->set($field_name, $value);
4869
-                }
4870
-                //make the model object in the entity map's cache match the $replacing_model_obj
4871
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
4872
-                    $obj_in_map->clear_cache($relation_name, null, true);
4873
-                    foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
4874
-                        $obj_in_map->cache($relation_name, $cached_obj, $cache_id);
4875
-                    }
4876
-                }
4877
-            }
4878
-            return $obj_in_map;
4879
-        } else {
4880
-            $this->add_to_entity_map($replacing_model_obj);
4881
-            return $replacing_model_obj;
4882
-        }
4883
-    }
4884
-
4885
-
4886
-
4887
-    /**
4888
-     * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
4889
-     * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
4890
-     * require_once($this->_getClassName().".class.php");
4891
-     *
4892
-     * @return string
4893
-     */
4894
-    private function _get_class_name()
4895
-    {
4896
-        return "EE_" . $this->get_this_model_name();
4897
-    }
4898
-
4899
-
4900
-
4901
-    /**
4902
-     * Get the name of the items this model represents, for the quantity specified. Eg,
4903
-     * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
4904
-     * it would be 'Events'.
4905
-     *
4906
-     * @param int $quantity
4907
-     * @return string
4908
-     */
4909
-    public function item_name($quantity = 1)
4910
-    {
4911
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
4912
-    }
4913
-
4914
-
4915
-
4916
-    /**
4917
-     * Very handy general function to allow for plugins to extend any child of EE_TempBase.
4918
-     * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
4919
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
4920
-     * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
4921
-     * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
4922
-     * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
4923
-     * was called, and an array of the original arguments passed to the function. Whatever their callback function
4924
-     * returns will be returned by this function. Example: in functions.php (or in a plugin):
4925
-     * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
4926
-     * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
4927
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
4928
-     *        return $previousReturnValue.$returnString;
4929
-     * }
4930
-     * require('EEM_Answer.model.php');
4931
-     * $answer=EEM_Answer::instance();
4932
-     * echo $answer->my_callback('monkeys',100);
4933
-     * //will output "you called my_callback! and passed args:monkeys,100"
4934
-     *
4935
-     * @param string $methodName name of method which was called on a child of EE_TempBase, but which
4936
-     * @param array  $args       array of original arguments passed to the function
4937
-     * @throws EE_Error
4938
-     * @return mixed whatever the plugin which calls add_filter decides
4939
-     */
4940
-    public function __call($methodName, $args)
4941
-    {
4942
-        $className = get_class($this);
4943
-        $tagName = "FHEE__{$className}__{$methodName}";
4944
-        if ( ! has_filter($tagName)) {
4945
-            throw new EE_Error(
4946
-                sprintf(
4947
-                    __('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 );',
4948
-                        'event_espresso'),
4949
-                    $methodName,
4950
-                    $className,
4951
-                    $tagName,
4952
-                    '<br />'
4953
-                )
4954
-            );
4955
-        }
4956
-        return apply_filters($tagName, null, $this, $args);
4957
-    }
4958
-
4959
-
4960
-
4961
-    /**
4962
-     * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
4963
-     * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
4964
-     *
4965
-     * @param EE_Base_Class|string|int $base_class_obj_or_id either:
4966
-     *                                                       the EE_Base_Class object that corresponds to this Model,
4967
-     *                                                       the object's class name
4968
-     *                                                       or object's ID
4969
-     * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
4970
-     *                                                       exists in the database. If it does not, we add it
4971
-     * @throws EE_Error
4972
-     * @return EE_Base_Class
4973
-     */
4974
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
4975
-    {
4976
-        $className = $this->_get_class_name();
4977
-        if ($base_class_obj_or_id instanceof $className) {
4978
-            $model_object = $base_class_obj_or_id;
4979
-        } else {
4980
-            $primary_key_field = $this->get_primary_key_field();
4981
-            if (
4982
-                $primary_key_field instanceof EE_Primary_Key_Int_Field
4983
-                && (
4984
-                    is_int($base_class_obj_or_id)
4985
-                    || is_string($base_class_obj_or_id)
4986
-                )
4987
-            ) {
4988
-                // assume it's an ID.
4989
-                // either a proper integer or a string representing an integer (eg "101" instead of 101)
4990
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
4991
-            } else if (
4992
-                $primary_key_field instanceof EE_Primary_Key_String_Field
4993
-                && is_string($base_class_obj_or_id)
4994
-            ) {
4995
-                // assume its a string representation of the object
4996
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
4997
-            } else {
4998
-                throw new EE_Error(
4999
-                    sprintf(
5000
-                        __(
5001
-                            "'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5002
-                            'event_espresso'
5003
-                        ),
5004
-                        $base_class_obj_or_id,
5005
-                        $this->_get_class_name(),
5006
-                        print_r($base_class_obj_or_id, true)
5007
-                    )
5008
-                );
5009
-            }
5010
-        }
5011
-        if ($ensure_is_in_db && $model_object->ID() !== null) {
5012
-            $model_object->save();
5013
-        }
5014
-        return $model_object;
5015
-    }
5016
-
5017
-
5018
-
5019
-    /**
5020
-     * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5021
-     * is a value of the this model's primary key. If it's an EE_Base_Class child,
5022
-     * returns it ID.
5023
-     *
5024
-     * @param EE_Base_Class|int|string $base_class_obj_or_id
5025
-     * @return int|string depending on the type of this model object's ID
5026
-     * @throws EE_Error
5027
-     */
5028
-    public function ensure_is_ID($base_class_obj_or_id)
5029
-    {
5030
-        $className = $this->_get_class_name();
5031
-        if ($base_class_obj_or_id instanceof $className) {
5032
-            /** @var $base_class_obj_or_id EE_Base_Class */
5033
-            $id = $base_class_obj_or_id->ID();
5034
-        } elseif (is_int($base_class_obj_or_id)) {
5035
-            //assume it's an ID
5036
-            $id = $base_class_obj_or_id;
5037
-        } elseif (is_string($base_class_obj_or_id)) {
5038
-            //assume its a string representation of the object
5039
-            $id = $base_class_obj_or_id;
5040
-        } else {
5041
-            throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5042
-                'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5043
-                print_r($base_class_obj_or_id, true)));
5044
-        }
5045
-        return $id;
5046
-    }
5047
-
5048
-
5049
-
5050
-    /**
5051
-     * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5052
-     * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5053
-     * been sanitized and converted into the appropriate domain.
5054
-     * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5055
-     * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5056
-     * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5057
-     * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5058
-     * $EVT = EEM_Event::instance(); $old_setting =
5059
-     * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5060
-     * $EVT->assume_values_already_prepared_by_model_object(true);
5061
-     * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5062
-     * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5063
-     *
5064
-     * @param int $values_already_prepared like one of the constants on EEM_Base
5065
-     * @return void
5066
-     */
5067
-    public function assume_values_already_prepared_by_model_object(
5068
-        $values_already_prepared = self::not_prepared_by_model_object
5069
-    ) {
5070
-        $this->_values_already_prepared_by_model_object = $values_already_prepared;
5071
-    }
5072
-
5073
-
5074
-
5075
-    /**
5076
-     * Read comments for assume_values_already_prepared_by_model_object()
5077
-     *
5078
-     * @return int
5079
-     */
5080
-    public function get_assumption_concerning_values_already_prepared_by_model_object()
5081
-    {
5082
-        return $this->_values_already_prepared_by_model_object;
5083
-    }
5084
-
5085
-
5086
-
5087
-    /**
5088
-     * Gets all the indexes on this model
5089
-     *
5090
-     * @return EE_Index[]
5091
-     */
5092
-    public function indexes()
5093
-    {
5094
-        return $this->_indexes;
5095
-    }
5096
-
5097
-
5098
-
5099
-    /**
5100
-     * Gets all the Unique Indexes on this model
5101
-     *
5102
-     * @return EE_Unique_Index[]
5103
-     */
5104
-    public function unique_indexes()
5105
-    {
5106
-        $unique_indexes = array();
5107
-        foreach ($this->_indexes as $name => $index) {
5108
-            if ($index instanceof EE_Unique_Index) {
5109
-                $unique_indexes [$name] = $index;
5110
-            }
5111
-        }
5112
-        return $unique_indexes;
5113
-    }
5114
-
5115
-
5116
-
5117
-    /**
5118
-     * Gets all the fields which, when combined, make the primary key.
5119
-     * This is usually just an array with 1 element (the primary key), but in cases
5120
-     * where there is no primary key, it's a combination of fields as defined
5121
-     * on a primary index
5122
-     *
5123
-     * @return EE_Model_Field_Base[] indexed by the field's name
5124
-     * @throws \EE_Error
5125
-     */
5126
-    public function get_combined_primary_key_fields()
5127
-    {
5128
-        foreach ($this->indexes() as $index) {
5129
-            if ($index instanceof EE_Primary_Key_Index) {
5130
-                return $index->fields();
5131
-            }
5132
-        }
5133
-        return array($this->primary_key_name() => $this->get_primary_key_field());
5134
-    }
5135
-
5136
-
5137
-
5138
-    /**
5139
-     * Used to build a primary key string (when the model has no primary key),
5140
-     * which can be used a unique string to identify this model object.
5141
-     *
5142
-     * @param array $cols_n_values keys are field names, values are their values
5143
-     * @return string
5144
-     * @throws \EE_Error
5145
-     */
5146
-    public function get_index_primary_key_string($cols_n_values)
5147
-    {
5148
-        $cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5149
-            $this->get_combined_primary_key_fields());
5150
-        return http_build_query($cols_n_values_for_primary_key_index);
5151
-    }
5152
-
5153
-
5154
-
5155
-    /**
5156
-     * Gets the field values from the primary key string
5157
-     *
5158
-     * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5159
-     * @param string $index_primary_key_string
5160
-     * @return null|array
5161
-     * @throws \EE_Error
5162
-     */
5163
-    public function parse_index_primary_key_string($index_primary_key_string)
5164
-    {
5165
-        $key_fields = $this->get_combined_primary_key_fields();
5166
-        //check all of them are in the $id
5167
-        $key_vals_in_combined_pk = array();
5168
-        parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5169
-        foreach ($key_fields as $key_field_name => $field_obj) {
5170
-            if ( ! isset($key_vals_in_combined_pk[$key_field_name])) {
5171
-                return null;
5172
-            }
5173
-        }
5174
-        return $key_vals_in_combined_pk;
5175
-    }
5176
-
5177
-
5178
-
5179
-    /**
5180
-     * verifies that an array of key-value pairs for model fields has a key
5181
-     * for each field comprising the primary key index
5182
-     *
5183
-     * @param array $key_vals
5184
-     * @return boolean
5185
-     * @throws \EE_Error
5186
-     */
5187
-    public function has_all_combined_primary_key_fields($key_vals)
5188
-    {
5189
-        $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5190
-        foreach ($keys_it_should_have as $key) {
5191
-            if ( ! isset($key_vals[$key])) {
5192
-                return false;
5193
-            }
5194
-        }
5195
-        return true;
5196
-    }
5197
-
5198
-
5199
-
5200
-    /**
5201
-     * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5202
-     * We consider something to be a copy if all the attributes match (except the ID, of course).
5203
-     *
5204
-     * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5205
-     * @param array               $query_params                     like EEM_Base::get_all's query_params.
5206
-     * @throws EE_Error
5207
-     * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5208
-     *                          indexed)
5209
-     */
5210
-    public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5211
-    {
5212
-        if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5213
-            $attributes_array = $model_object_or_attributes_array->model_field_array();
5214
-        } elseif (is_array($model_object_or_attributes_array)) {
5215
-            $attributes_array = $model_object_or_attributes_array;
5216
-        } else {
5217
-            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",
5218
-                "event_espresso"), $model_object_or_attributes_array));
5219
-        }
5220
-        //even copies obviously won't have the same ID, so remove the primary key
5221
-        //from the WHERE conditions for finding copies (if there is a primary key, of course)
5222
-        if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5223
-            unset($attributes_array[$this->primary_key_name()]);
5224
-        }
5225
-        if (isset($query_params[0])) {
5226
-            $query_params[0] = array_merge($attributes_array, $query_params);
5227
-        } else {
5228
-            $query_params[0] = $attributes_array;
5229
-        }
5230
-        return $this->get_all($query_params);
5231
-    }
5232
-
5233
-
5234
-
5235
-    /**
5236
-     * Gets the first copy we find. See get_all_copies for more details
5237
-     *
5238
-     * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5239
-     * @param array $query_params
5240
-     * @return EE_Base_Class
5241
-     * @throws \EE_Error
5242
-     */
5243
-    public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5244
-    {
5245
-        if ( ! is_array($query_params)) {
5246
-            EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5247
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5248
-                    gettype($query_params)), '4.6.0');
5249
-            $query_params = array();
5250
-        }
5251
-        $query_params['limit'] = 1;
5252
-        $copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5253
-        if (is_array($copies)) {
5254
-            return array_shift($copies);
5255
-        } else {
5256
-            return null;
5257
-        }
5258
-    }
5259
-
5260
-
5261
-
5262
-    /**
5263
-     * Updates the item with the specified id. Ignores default query parameters because
5264
-     * we have specified the ID, and its assumed we KNOW what we're doing
5265
-     *
5266
-     * @param array      $fields_n_values keys are field names, values are their new values
5267
-     * @param int|string $id              the value of the primary key to update
5268
-     * @return int number of rows updated
5269
-     * @throws \EE_Error
5270
-     */
5271
-    public function update_by_ID($fields_n_values, $id)
5272
-    {
5273
-        $query_params = array(
5274
-            0                          => array($this->get_primary_key_field()->get_name() => $id),
5275
-            'default_where_conditions' => 'other_models_only',
5276
-        );
5277
-        return $this->update($fields_n_values, $query_params);
5278
-    }
5279
-
5280
-
5281
-
5282
-    /**
5283
-     * Changes an operator which was supplied to the models into one usable in SQL
5284
-     *
5285
-     * @param string $operator_supplied
5286
-     * @return string an operator which can be used in SQL
5287
-     * @throws EE_Error
5288
-     */
5289
-    private function _prepare_operator_for_sql($operator_supplied)
5290
-    {
5291
-        $sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5292
-            : null;
5293
-        if ($sql_operator) {
5294
-            return $sql_operator;
5295
-        } else {
5296
-            throw new EE_Error(sprintf(__("The operator '%s' is not in the list of valid operators: %s",
5297
-                "event_espresso"), $operator_supplied, implode(",", array_keys($this->_valid_operators))));
5298
-        }
5299
-    }
5300
-
5301
-
5302
-
5303
-    /**
5304
-     * Gets an array where keys are the primary keys and values are their 'names'
5305
-     * (as determined by the model object's name() function, which is often overridden)
5306
-     *
5307
-     * @param array $query_params like get_all's
5308
-     * @return string[]
5309
-     * @throws \EE_Error
5310
-     */
5311
-    public function get_all_names($query_params = array())
5312
-    {
5313
-        $objs = $this->get_all($query_params);
5314
-        $names = array();
5315
-        foreach ($objs as $obj) {
5316
-            $names[$obj->ID()] = $obj->name();
5317
-        }
5318
-        return $names;
5319
-    }
5320
-
5321
-
5322
-
5323
-    /**
5324
-     * Gets an array of primary keys from the model objects. If you acquired the model objects
5325
-     * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5326
-     * this is duplicated effort and reduces efficiency) you would be better to use
5327
-     * array_keys() on $model_objects.
5328
-     *
5329
-     * @param \EE_Base_Class[] $model_objects
5330
-     * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5331
-     *                                               in the returned array
5332
-     * @return array
5333
-     * @throws \EE_Error
5334
-     */
5335
-    public function get_IDs($model_objects, $filter_out_empty_ids = false)
5336
-    {
5337
-        if ( ! $this->has_primary_key_field()) {
5338
-            if (WP_DEBUG) {
5339
-                EE_Error::add_error(
5340
-                    __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5341
-                    __FILE__,
5342
-                    __FUNCTION__,
5343
-                    __LINE__
5344
-                );
5345
-            }
5346
-        }
5347
-        $IDs = array();
5348
-        foreach ($model_objects as $model_object) {
5349
-            $id = $model_object->ID();
5350
-            if ( ! $id) {
5351
-                if ($filter_out_empty_ids) {
5352
-                    continue;
5353
-                }
5354
-                if (WP_DEBUG) {
5355
-                    EE_Error::add_error(
5356
-                        __(
5357
-                            'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5358
-                            'event_espresso'
5359
-                        ),
5360
-                        __FILE__,
5361
-                        __FUNCTION__,
5362
-                        __LINE__
5363
-                    );
5364
-                }
5365
-            }
5366
-            $IDs[] = $id;
5367
-        }
5368
-        return $IDs;
5369
-    }
5370
-
5371
-
5372
-
5373
-    /**
5374
-     * Returns the string used in capabilities relating to this model. If there
5375
-     * are no capabilities that relate to this model returns false
5376
-     *
5377
-     * @return string|false
5378
-     */
5379
-    public function cap_slug()
5380
-    {
5381
-        return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5382
-    }
5383
-
5384
-
5385
-
5386
-    /**
5387
-     * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5388
-     * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5389
-     * only returns the cap restrictions array in that context (ie, the array
5390
-     * at that key)
5391
-     *
5392
-     * @param string $context
5393
-     * @return EE_Default_Where_Conditions[] indexed by associated capability
5394
-     * @throws \EE_Error
5395
-     */
5396
-    public function cap_restrictions($context = EEM_Base::caps_read)
5397
-    {
5398
-        EEM_Base::verify_is_valid_cap_context($context);
5399
-        //check if we ought to run the restriction generator first
5400
-        if (
5401
-            isset($this->_cap_restriction_generators[$context])
5402
-            && $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5403
-            && ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5404
-        ) {
5405
-            $this->_cap_restrictions[$context] = array_merge(
5406
-                $this->_cap_restrictions[$context],
5407
-                $this->_cap_restriction_generators[$context]->generate_restrictions()
5408
-            );
5409
-        }
5410
-        //and make sure we've finalized the construction of each restriction
5411
-        foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5412
-            if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5413
-                $where_conditions_obj->_finalize_construct($this);
5414
-            }
5415
-        }
5416
-        return $this->_cap_restrictions[$context];
5417
-    }
5418
-
5419
-
5420
-
5421
-    /**
5422
-     * Indicating whether or not this model thinks its a wp core model
5423
-     *
5424
-     * @return boolean
5425
-     */
5426
-    public function is_wp_core_model()
5427
-    {
5428
-        return $this->_wp_core_model;
5429
-    }
5430
-
5431
-
5432
-
5433
-    /**
5434
-     * Gets all the caps that are missing which impose a restriction on
5435
-     * queries made in this context
5436
-     *
5437
-     * @param string $context one of EEM_Base::caps_ constants
5438
-     * @return EE_Default_Where_Conditions[] indexed by capability name
5439
-     * @throws \EE_Error
5440
-     */
5441
-    public function caps_missing($context = EEM_Base::caps_read)
5442
-    {
5443
-        $missing_caps = array();
5444
-        $cap_restrictions = $this->cap_restrictions($context);
5445
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5446
-            if ( ! EE_Capabilities::instance()
5447
-                                  ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5448
-            ) {
5449
-                $missing_caps[$cap] = $restriction_if_no_cap;
5450
-            }
5451
-        }
5452
-        return $missing_caps;
5453
-    }
5454
-
5455
-
5456
-
5457
-    /**
5458
-     * Gets the mapping from capability contexts to action strings used in capability names
5459
-     *
5460
-     * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5461
-     * one of 'read', 'edit', or 'delete'
5462
-     */
5463
-    public function cap_contexts_to_cap_action_map()
5464
-    {
5465
-        return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5466
-            $this);
5467
-    }
5468
-
5469
-
5470
-
5471
-    /**
5472
-     * Gets the action string for the specified capability context
5473
-     *
5474
-     * @param string $context
5475
-     * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5476
-     * @throws \EE_Error
5477
-     */
5478
-    public function cap_action_for_context($context)
5479
-    {
5480
-        $mapping = $this->cap_contexts_to_cap_action_map();
5481
-        if (isset($mapping[$context])) {
5482
-            return $mapping[$context];
5483
-        }
5484
-        if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5485
-            return $action;
5486
-        }
5487
-        throw new EE_Error(
5488
-            sprintf(
5489
-                __('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5490
-                $context,
5491
-                implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5492
-            )
5493
-        );
5494
-    }
5495
-
5496
-
5497
-
5498
-    /**
5499
-     * Returns all the capability contexts which are valid when querying models
5500
-     *
5501
-     * @return array
5502
-     */
5503
-    static public function valid_cap_contexts()
5504
-    {
5505
-        return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5506
-            self::caps_read,
5507
-            self::caps_read_admin,
5508
-            self::caps_edit,
5509
-            self::caps_delete,
5510
-        ));
5511
-    }
5512
-
5513
-
5514
-
5515
-    /**
5516
-     * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5517
-     *
5518
-     * @param string $context
5519
-     * @return bool
5520
-     * @throws \EE_Error
5521
-     */
5522
-    static public function verify_is_valid_cap_context($context)
5523
-    {
5524
-        $valid_cap_contexts = EEM_Base::valid_cap_contexts();
5525
-        if (in_array($context, $valid_cap_contexts)) {
5526
-            return true;
5527
-        } else {
5528
-            throw new EE_Error(
5529
-                sprintf(
5530
-                    __('Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5531
-                        'event_espresso'),
5532
-                    $context,
5533
-                    'EEM_Base',
5534
-                    implode(',', $valid_cap_contexts)
5535
-                )
5536
-            );
5537
-        }
5538
-    }
5539
-
5540
-
5541
-
5542
-    /**
5543
-     * Clears all the models field caches. This is only useful when a sub-class
5544
-     * might have added a field or something and these caches might be invalidated
5545
-     */
5546
-    protected function _invalidate_field_caches()
5547
-    {
5548
-        $this->_cache_foreign_key_to_fields = array();
5549
-        $this->_cached_fields = null;
5550
-        $this->_cached_fields_non_db_only = null;
5551
-    }
3428
+		}
3429
+		return $null_friendly_where_conditions;
3430
+	}
3431
+
3432
+
3433
+
3434
+	/**
3435
+	 * Uses the _default_where_conditions_strategy set during __construct() to get
3436
+	 * default where conditions on all get_all, update, and delete queries done by this model.
3437
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3438
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3439
+	 *
3440
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3441
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3442
+	 */
3443
+	private function _get_default_where_conditions($model_relation_path = null)
3444
+	{
3445
+		if ($this->_ignore_where_strategy) {
3446
+			return array();
3447
+		}
3448
+		return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3449
+	}
3450
+
3451
+
3452
+
3453
+	/**
3454
+	 * Uses the _minimum_where_conditions_strategy set during __construct() to get
3455
+	 * minimum where conditions on all get_all, update, and delete queries done by this model.
3456
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3457
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3458
+	 * Similar to _get_default_where_conditions
3459
+	 *
3460
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3461
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3462
+	 */
3463
+	protected function _get_minimum_where_conditions($model_relation_path = null)
3464
+	{
3465
+		if ($this->_ignore_where_strategy) {
3466
+			return array();
3467
+		}
3468
+		return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3469
+	}
3470
+
3471
+
3472
+
3473
+	/**
3474
+	 * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3475
+	 * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3476
+	 *
3477
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
3478
+	 * @return string
3479
+	 * @throws \EE_Error
3480
+	 */
3481
+	private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3482
+	{
3483
+		$selects = $this->_get_columns_to_select_for_this_model();
3484
+		foreach (
3485
+			$model_query_info->get_model_names_included() as $model_relation_chain =>
3486
+			$name_of_other_model_included
3487
+		) {
3488
+			$other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3489
+			$other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3490
+			foreach ($other_model_selects as $key => $value) {
3491
+				$selects[] = $value;
3492
+			}
3493
+		}
3494
+		return implode(", ", $selects);
3495
+	}
3496
+
3497
+
3498
+
3499
+	/**
3500
+	 * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3501
+	 * So that's going to be the columns for all the fields on the model
3502
+	 *
3503
+	 * @param string $model_relation_chain like 'Question.Question_Group.Event'
3504
+	 * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3505
+	 */
3506
+	public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3507
+	{
3508
+		$fields = $this->field_settings();
3509
+		$selects = array();
3510
+		$table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3511
+			$this->get_this_model_name());
3512
+		foreach ($fields as $field_obj) {
3513
+			$selects[] = $table_alias_with_model_relation_chain_prefix
3514
+						 . $field_obj->get_table_alias()
3515
+						 . "."
3516
+						 . $field_obj->get_table_column()
3517
+						 . " AS '"
3518
+						 . $table_alias_with_model_relation_chain_prefix
3519
+						 . $field_obj->get_table_alias()
3520
+						 . "."
3521
+						 . $field_obj->get_table_column()
3522
+						 . "'";
3523
+		}
3524
+		//make sure we are also getting the PKs of each table
3525
+		$tables = $this->get_tables();
3526
+		if (count($tables) > 1) {
3527
+			foreach ($tables as $table_obj) {
3528
+				$qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3529
+									   . $table_obj->get_fully_qualified_pk_column();
3530
+				if ( ! in_array($qualified_pk_column, $selects)) {
3531
+					$selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3532
+				}
3533
+			}
3534
+		}
3535
+		return $selects;
3536
+	}
3537
+
3538
+
3539
+
3540
+	/**
3541
+	 * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3542
+	 * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3543
+	 * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3544
+	 * SQL for joining, and the data types
3545
+	 *
3546
+	 * @param null|string                 $original_query_param
3547
+	 * @param string                      $query_param          like Registration.Transaction.TXN_ID
3548
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3549
+	 * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3550
+	 *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3551
+	 *                                                          column name. We only want model names, eg 'Event.Venue'
3552
+	 *                                                          or 'Registration's
3553
+	 * @param string                      $original_query_param what it originally was (eg
3554
+	 *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3555
+	 *                                                          matches $query_param
3556
+	 * @throws EE_Error
3557
+	 * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3558
+	 */
3559
+	private function _extract_related_model_info_from_query_param(
3560
+		$query_param,
3561
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3562
+		$query_param_type,
3563
+		$original_query_param = null
3564
+	) {
3565
+		if ($original_query_param === null) {
3566
+			$original_query_param = $query_param;
3567
+		}
3568
+		$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3569
+		/** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3570
+		$allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3571
+		$allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3572
+		//check to see if we have a field on this model
3573
+		$this_model_fields = $this->field_settings(true);
3574
+		if (array_key_exists($query_param, $this_model_fields)) {
3575
+			if ($allow_fields) {
3576
+				return;
3577
+			} else {
3578
+				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",
3579
+					"event_espresso"),
3580
+					$query_param, get_class($this), $query_param_type, $original_query_param));
3581
+			}
3582
+		} //check if this is a special logic query param
3583
+		elseif (in_array($query_param, $this->_logic_query_param_keys, true)) {
3584
+			if ($allow_logic_query_params) {
3585
+				return;
3586
+			} else {
3587
+				throw new EE_Error(
3588
+					sprintf(
3589
+						__('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',
3590
+							'event_espresso'),
3591
+						implode('", "', $this->_logic_query_param_keys),
3592
+						$query_param,
3593
+						get_class($this),
3594
+						'<br />',
3595
+						"\t"
3596
+						. ' $passed_in_query_info = <pre>'
3597
+						. print_r($passed_in_query_info, true)
3598
+						. '</pre>'
3599
+						. "\n\t"
3600
+						. ' $query_param_type = '
3601
+						. $query_param_type
3602
+						. "\n\t"
3603
+						. ' $original_query_param = '
3604
+						. $original_query_param
3605
+					)
3606
+				);
3607
+			}
3608
+		} //check if it's a custom selection
3609
+		elseif (array_key_exists($query_param, $this->_custom_selections)) {
3610
+			return;
3611
+		}
3612
+		//check if has a model name at the beginning
3613
+		//and
3614
+		//check if it's a field on a related model
3615
+		foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3616
+			if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3617
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3618
+				$query_param = substr($query_param, strlen($valid_related_model_name . "."));
3619
+				if ($query_param === '') {
3620
+					//nothing left to $query_param
3621
+					//we should actually end in a field name, not a model like this!
3622
+					throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3623
+						"event_espresso"),
3624
+						$query_param, $query_param_type, get_class($this), $valid_related_model_name));
3625
+				} else {
3626
+					$related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3627
+					$related_model_obj->_extract_related_model_info_from_query_param($query_param,
3628
+						$passed_in_query_info, $query_param_type, $original_query_param);
3629
+					return;
3630
+				}
3631
+			} elseif ($query_param === $valid_related_model_name) {
3632
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3633
+				return;
3634
+			}
3635
+		}
3636
+		//ok so $query_param didn't start with a model name
3637
+		//and we previously confirmed it wasn't a logic query param or field on the current model
3638
+		//it's wack, that's what it is
3639
+		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",
3640
+			"event_espresso"),
3641
+			$query_param, get_class($this), $query_param_type, $original_query_param));
3642
+	}
3643
+
3644
+
3645
+
3646
+	/**
3647
+	 * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3648
+	 * and store it on $passed_in_query_info
3649
+	 *
3650
+	 * @param string                      $model_name
3651
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3652
+	 * @param string                      $original_query_param used to extract the relation chain between the queried
3653
+	 *                                                          model and $model_name. Eg, if we are querying Event,
3654
+	 *                                                          and are adding a join to 'Payment' with the original
3655
+	 *                                                          query param key
3656
+	 *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3657
+	 *                                                          to extract 'Registration.Transaction.Payment', in case
3658
+	 *                                                          Payment wants to add default query params so that it
3659
+	 *                                                          will know what models to prepend onto its default query
3660
+	 *                                                          params or in case it wants to rename tables (in case
3661
+	 *                                                          there are multiple joins to the same table)
3662
+	 * @return void
3663
+	 * @throws \EE_Error
3664
+	 */
3665
+	private function _add_join_to_model(
3666
+		$model_name,
3667
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3668
+		$original_query_param
3669
+	) {
3670
+		$relation_obj = $this->related_settings_for($model_name);
3671
+		$model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3672
+		//check if the relation is HABTM, because then we're essentially doing two joins
3673
+		//If so, join first to the JOIN table, and add its data types, and then continue as normal
3674
+		if ($relation_obj instanceof EE_HABTM_Relation) {
3675
+			$join_model_obj = $relation_obj->get_join_model();
3676
+			//replace the model specified with the join model for this relation chain, whi
3677
+			$relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
3678
+				$join_model_obj->get_this_model_name(), $model_relation_chain);
3679
+			$new_query_info = new EE_Model_Query_Info_Carrier(
3680
+				array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
3681
+				$relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model));
3682
+			$passed_in_query_info->merge($new_query_info);
3683
+		}
3684
+		//now just join to the other table pointed to by the relation object, and add its data types
3685
+		$new_query_info = new EE_Model_Query_Info_Carrier(
3686
+			array($model_relation_chain => $model_name),
3687
+			$relation_obj->get_join_statement($model_relation_chain));
3688
+		$passed_in_query_info->merge($new_query_info);
3689
+	}
3690
+
3691
+
3692
+
3693
+	/**
3694
+	 * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
3695
+	 *
3696
+	 * @param array $where_params like EEM_Base::get_all
3697
+	 * @return string of SQL
3698
+	 * @throws \EE_Error
3699
+	 */
3700
+	private function _construct_where_clause($where_params)
3701
+	{
3702
+		$SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
3703
+		if ($SQL) {
3704
+			return " WHERE " . $SQL;
3705
+		} else {
3706
+			return '';
3707
+		}
3708
+	}
3709
+
3710
+
3711
+
3712
+	/**
3713
+	 * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
3714
+	 * and should be passed HAVING parameters, not WHERE parameters
3715
+	 *
3716
+	 * @param array $having_params
3717
+	 * @return string
3718
+	 * @throws \EE_Error
3719
+	 */
3720
+	private function _construct_having_clause($having_params)
3721
+	{
3722
+		$SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
3723
+		if ($SQL) {
3724
+			return " HAVING " . $SQL;
3725
+		} else {
3726
+			return '';
3727
+		}
3728
+	}
3729
+
3730
+
3731
+
3732
+	/**
3733
+	 * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
3734
+	 * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
3735
+	 * EEM_Attendee.
3736
+	 *
3737
+	 * @param string $field_name
3738
+	 * @param string $model_name
3739
+	 * @return EE_Model_Field_Base
3740
+	 * @throws EE_Error
3741
+	 */
3742
+	protected function _get_field_on_model($field_name, $model_name)
3743
+	{
3744
+		$model_class = 'EEM_' . $model_name;
3745
+		$model_filepath = $model_class . ".model.php";
3746
+		if (is_readable($model_filepath)) {
3747
+			require_once($model_filepath);
3748
+			$model_instance = call_user_func($model_name . "::instance");
3749
+			/* @var $model_instance EEM_Base */
3750
+			return $model_instance->field_settings_for($field_name);
3751
+		} else {
3752
+			throw new EE_Error(sprintf(__('No model named %s exists, with classname %s and filepath %s',
3753
+				'event_espresso'), $model_name, $model_class, $model_filepath));
3754
+		}
3755
+	}
3756
+
3757
+
3758
+
3759
+	/**
3760
+	 * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
3761
+	 * Event_Meta.meta_value = 'foo'))"
3762
+	 *
3763
+	 * @param array  $where_params see EEM_Base::get_all for documentation
3764
+	 * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
3765
+	 * @throws EE_Error
3766
+	 * @return string of SQL
3767
+	 */
3768
+	private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
3769
+	{
3770
+		$where_clauses = array();
3771
+		foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
3772
+			$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
3773
+			if (in_array($query_param, $this->_logic_query_param_keys)) {
3774
+				switch ($query_param) {
3775
+					case 'not':
3776
+					case 'NOT':
3777
+						$where_clauses[] = "! ("
3778
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3779
+								$glue)
3780
+										   . ")";
3781
+						break;
3782
+					case 'and':
3783
+					case 'AND':
3784
+						$where_clauses[] = " ("
3785
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3786
+								' AND ')
3787
+										   . ")";
3788
+						break;
3789
+					case 'or':
3790
+					case 'OR':
3791
+						$where_clauses[] = " ("
3792
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3793
+								' OR ')
3794
+										   . ")";
3795
+						break;
3796
+				}
3797
+			} else {
3798
+				$field_obj = $this->_deduce_field_from_query_param($query_param);
3799
+				//if it's not a normal field, maybe it's a custom selection?
3800
+				if ( ! $field_obj) {
3801
+					if (isset($this->_custom_selections[$query_param][1])) {
3802
+						$field_obj = $this->_custom_selections[$query_param][1];
3803
+					} else {
3804
+						throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
3805
+							"event_espresso"), $query_param));
3806
+					}
3807
+				}
3808
+				$op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
3809
+				$where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
3810
+			}
3811
+		}
3812
+		return $where_clauses ? implode($glue, $where_clauses) : '';
3813
+	}
3814
+
3815
+
3816
+
3817
+	/**
3818
+	 * Takes the input parameter and extract the table name (alias) and column name
3819
+	 *
3820
+	 * @param array $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
3821
+	 * @throws EE_Error
3822
+	 * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
3823
+	 */
3824
+	private function _deduce_column_name_from_query_param($query_param)
3825
+	{
3826
+		$field = $this->_deduce_field_from_query_param($query_param);
3827
+		if ($field) {
3828
+			$table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
3829
+				$query_param);
3830
+			return $table_alias_prefix . $field->get_qualified_column();
3831
+		} elseif (array_key_exists($query_param, $this->_custom_selections)) {
3832
+			//maybe it's custom selection item?
3833
+			//if so, just use it as the "column name"
3834
+			return $query_param;
3835
+		} else {
3836
+			throw new EE_Error(sprintf(__("%s is not a valid field on this model, nor a custom selection (%s)",
3837
+				"event_espresso"), $query_param, implode(",", $this->_custom_selections)));
3838
+		}
3839
+	}
3840
+
3841
+
3842
+
3843
+	/**
3844
+	 * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
3845
+	 * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
3846
+	 * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
3847
+	 * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
3848
+	 *
3849
+	 * @param string $condition_query_param_key
3850
+	 * @return string
3851
+	 */
3852
+	private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
3853
+	{
3854
+		$pos_of_star = strpos($condition_query_param_key, '*');
3855
+		if ($pos_of_star === false) {
3856
+			return $condition_query_param_key;
3857
+		} else {
3858
+			$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
3859
+			return $condition_query_param_sans_star;
3860
+		}
3861
+	}
3862
+
3863
+
3864
+
3865
+	/**
3866
+	 * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
3867
+	 *
3868
+	 * @param                            mixed      array | string    $op_and_value
3869
+	 * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
3870
+	 * @throws EE_Error
3871
+	 * @return string
3872
+	 */
3873
+	private function _construct_op_and_value($op_and_value, $field_obj)
3874
+	{
3875
+		if (is_array($op_and_value)) {
3876
+			$operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
3877
+			if ( ! $operator) {
3878
+				$php_array_like_string = array();
3879
+				foreach ($op_and_value as $key => $value) {
3880
+					$php_array_like_string[] = "$key=>$value";
3881
+				}
3882
+				throw new EE_Error(
3883
+					sprintf(
3884
+						__(
3885
+							"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))",
3886
+							"event_espresso"
3887
+						),
3888
+						implode(",", $php_array_like_string)
3889
+					)
3890
+				);
3891
+			}
3892
+			$value = isset($op_and_value[1]) ? $op_and_value[1] : null;
3893
+		} else {
3894
+			$operator = '=';
3895
+			$value = $op_and_value;
3896
+		}
3897
+		//check to see if the value is actually another field
3898
+		if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
3899
+			return $operator . SP . $this->_deduce_column_name_from_query_param($value);
3900
+		} elseif (in_array($operator, $this->_in_style_operators) && is_array($value)) {
3901
+			//in this case, the value should be an array, or at least a comma-separated list
3902
+			//it will need to handle a little differently
3903
+			$cleaned_value = $this->_construct_in_value($value, $field_obj);
3904
+			//note: $cleaned_value has already been run through $wpdb->prepare()
3905
+			return $operator . SP . $cleaned_value;
3906
+		} elseif (in_array($operator, $this->_between_style_operators) && is_array($value)) {
3907
+			//the value should be an array with count of two.
3908
+			if (count($value) !== 2) {
3909
+				throw new EE_Error(
3910
+					sprintf(
3911
+						__(
3912
+							"The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
3913
+							'event_espresso'
3914
+						),
3915
+						"BETWEEN"
3916
+					)
3917
+				);
3918
+			}
3919
+			$cleaned_value = $this->_construct_between_value($value, $field_obj);
3920
+			return $operator . SP . $cleaned_value;
3921
+		} elseif (in_array($operator, $this->_null_style_operators)) {
3922
+			if ($value !== null) {
3923
+				throw new EE_Error(
3924
+					sprintf(
3925
+						__(
3926
+							"You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
3927
+							"event_espresso"
3928
+						),
3929
+						$value,
3930
+						$operator
3931
+					)
3932
+				);
3933
+			}
3934
+			return $operator;
3935
+		} elseif ($operator === 'LIKE' && ! is_array($value)) {
3936
+			//if the operator is 'LIKE', we want to allow percent signs (%) and not
3937
+			//remove other junk. So just treat it as a string.
3938
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
3939
+		} elseif ( ! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
3940
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
3941
+		} elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
3942
+			throw new EE_Error(
3943
+				sprintf(
3944
+					__(
3945
+						"Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
3946
+						'event_espresso'
3947
+					),
3948
+					$operator,
3949
+					$operator
3950
+				)
3951
+			);
3952
+		} elseif ( ! in_array($operator, $this->_in_style_operators) && is_array($value)) {
3953
+			throw new EE_Error(
3954
+				sprintf(
3955
+					__(
3956
+						"Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
3957
+						'event_espresso'
3958
+					),
3959
+					$operator,
3960
+					$operator
3961
+				)
3962
+			);
3963
+		} else {
3964
+			throw new EE_Error(
3965
+				sprintf(
3966
+					__(
3967
+						"It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
3968
+						"event_espresso"
3969
+					),
3970
+					http_build_query($op_and_value)
3971
+				)
3972
+			);
3973
+		}
3974
+	}
3975
+
3976
+
3977
+
3978
+	/**
3979
+	 * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
3980
+	 *
3981
+	 * @param array                      $values
3982
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
3983
+	 *                                              '%s'
3984
+	 * @return string
3985
+	 * @throws \EE_Error
3986
+	 */
3987
+	public function _construct_between_value($values, $field_obj)
3988
+	{
3989
+		$cleaned_values = array();
3990
+		foreach ($values as $value) {
3991
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
3992
+		}
3993
+		return $cleaned_values[0] . " AND " . $cleaned_values[1];
3994
+	}
3995
+
3996
+
3997
+
3998
+	/**
3999
+	 * Takes an array or a comma-separated list of $values and cleans them
4000
+	 * according to $data_type using $wpdb->prepare, and then makes the list a
4001
+	 * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4002
+	 * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4003
+	 * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4004
+	 *
4005
+	 * @param mixed                      $values    array or comma-separated string
4006
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4007
+	 * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4008
+	 * @throws \EE_Error
4009
+	 */
4010
+	public function _construct_in_value($values, $field_obj)
4011
+	{
4012
+		//check if the value is a CSV list
4013
+		if (is_string($values)) {
4014
+			//in which case, turn it into an array
4015
+			$values = explode(",", $values);
4016
+		}
4017
+		$cleaned_values = array();
4018
+		foreach ($values as $value) {
4019
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4020
+		}
4021
+		//we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4022
+		//but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4023
+		//which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4024
+		if (empty($cleaned_values)) {
4025
+			$all_fields = $this->field_settings();
4026
+			$a_field = array_shift($all_fields);
4027
+			$main_table = $this->_get_main_table();
4028
+			$cleaned_values[] = "SELECT "
4029
+								. $a_field->get_table_column()
4030
+								. " FROM "
4031
+								. $main_table->get_table_name()
4032
+								. " WHERE FALSE";
4033
+		}
4034
+		return "(" . implode(",", $cleaned_values) . ")";
4035
+	}
4036
+
4037
+
4038
+
4039
+	/**
4040
+	 * @param mixed                      $value
4041
+	 * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4042
+	 * @throws EE_Error
4043
+	 * @return false|null|string
4044
+	 */
4045
+	private function _wpdb_prepare_using_field($value, $field_obj)
4046
+	{
4047
+		/** @type WPDB $wpdb */
4048
+		global $wpdb;
4049
+		if ($field_obj instanceof EE_Model_Field_Base) {
4050
+			return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4051
+				$this->_prepare_value_for_use_in_db($value, $field_obj));
4052
+		} else {//$field_obj should really just be a data type
4053
+			if ( ! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4054
+				throw new EE_Error(sprintf(__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4055
+					$field_obj, implode(",", $this->_valid_wpdb_data_types)));
4056
+			}
4057
+			return $wpdb->prepare($field_obj, $value);
4058
+		}
4059
+	}
4060
+
4061
+
4062
+
4063
+	/**
4064
+	 * Takes the input parameter and finds the model field that it indicates.
4065
+	 *
4066
+	 * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4067
+	 * @throws EE_Error
4068
+	 * @return EE_Model_Field_Base
4069
+	 */
4070
+	protected function _deduce_field_from_query_param($query_param_name)
4071
+	{
4072
+		//ok, now proceed with deducing which part is the model's name, and which is the field's name
4073
+		//which will help us find the database table and column
4074
+		$query_param_parts = explode(".", $query_param_name);
4075
+		if (empty($query_param_parts)) {
4076
+			throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4077
+				'event_espresso'), $query_param_name));
4078
+		}
4079
+		$number_of_parts = count($query_param_parts);
4080
+		$last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4081
+		if ($number_of_parts === 1) {
4082
+			$field_name = $last_query_param_part;
4083
+			$model_obj = $this;
4084
+		} else {// $number_of_parts >= 2
4085
+			//the last part is the column name, and there are only 2parts. therefore...
4086
+			$field_name = $last_query_param_part;
4087
+			$model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4088
+		}
4089
+		try {
4090
+			return $model_obj->field_settings_for($field_name);
4091
+		} catch (EE_Error $e) {
4092
+			return null;
4093
+		}
4094
+	}
4095
+
4096
+
4097
+
4098
+	/**
4099
+	 * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4100
+	 * alias and column which corresponds to it
4101
+	 *
4102
+	 * @param string $field_name
4103
+	 * @throws EE_Error
4104
+	 * @return string
4105
+	 */
4106
+	public function _get_qualified_column_for_field($field_name)
4107
+	{
4108
+		$all_fields = $this->field_settings();
4109
+		$field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4110
+		if ($field) {
4111
+			return $field->get_qualified_column();
4112
+		} else {
4113
+			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.",
4114
+				'event_espresso'), $field_name, get_class($this)));
4115
+		}
4116
+	}
4117
+
4118
+
4119
+
4120
+	/**
4121
+	 * constructs the select use on special limit joins
4122
+	 * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4123
+	 * its setup so the select query will be setup on and just doing the special select join off of the primary table
4124
+	 * (as that is typically where the limits would be set).
4125
+	 *
4126
+	 * @param  string       $table_alias The table the select is being built for
4127
+	 * @param  mixed|string $limit       The limit for this select
4128
+	 * @return string                The final select join element for the query.
4129
+	 */
4130
+	public function _construct_limit_join_select($table_alias, $limit)
4131
+	{
4132
+		$SQL = '';
4133
+		foreach ($this->_tables as $table_obj) {
4134
+			if ($table_obj instanceof EE_Primary_Table) {
4135
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4136
+					? $table_obj->get_select_join_limit($limit)
4137
+					: SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4138
+			} elseif ($table_obj instanceof EE_Secondary_Table) {
4139
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4140
+					? $table_obj->get_select_join_limit_join($limit)
4141
+					: SP . $table_obj->get_join_sql($table_alias) . SP;
4142
+			}
4143
+		}
4144
+		return $SQL;
4145
+	}
4146
+
4147
+
4148
+
4149
+	/**
4150
+	 * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4151
+	 * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4152
+	 *
4153
+	 * @return string SQL
4154
+	 * @throws \EE_Error
4155
+	 */
4156
+	public function _construct_internal_join()
4157
+	{
4158
+		$SQL = $this->_get_main_table()->get_table_sql();
4159
+		$SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4160
+		return $SQL;
4161
+	}
4162
+
4163
+
4164
+
4165
+	/**
4166
+	 * Constructs the SQL for joining all the tables on this model.
4167
+	 * Normally $alias should be the primary table's alias, but in cases where
4168
+	 * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4169
+	 * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4170
+	 * alias, this will construct SQL like:
4171
+	 * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4172
+	 * With $alias being a secondary table's alias, this will construct SQL like:
4173
+	 * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4174
+	 *
4175
+	 * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4176
+	 * @return string
4177
+	 */
4178
+	public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4179
+	{
4180
+		$SQL = '';
4181
+		$alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4182
+		foreach ($this->_tables as $table_obj) {
4183
+			if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4184
+				if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4185
+					//so we're joining to this table, meaning the table is already in
4186
+					//the FROM statement, BUT the primary table isn't. So we want
4187
+					//to add the inverse join sql
4188
+					$SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4189
+				} else {
4190
+					//just add a regular JOIN to this table from the primary table
4191
+					$SQL .= $table_obj->get_join_sql($alias_prefixed);
4192
+				}
4193
+			}//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4194
+		}
4195
+		return $SQL;
4196
+	}
4197
+
4198
+
4199
+
4200
+	/**
4201
+	 * Gets an array for storing all the data types on the next-to-be-executed-query.
4202
+	 * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4203
+	 * their data type (eg, '%s', '%d', etc)
4204
+	 *
4205
+	 * @return array
4206
+	 */
4207
+	public function _get_data_types()
4208
+	{
4209
+		$data_types = array();
4210
+		foreach ($this->field_settings() as $field_obj) {
4211
+			//$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4212
+			/** @var $field_obj EE_Model_Field_Base */
4213
+			$data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4214
+		}
4215
+		return $data_types;
4216
+	}
4217
+
4218
+
4219
+
4220
+	/**
4221
+	 * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4222
+	 *
4223
+	 * @param string $model_name
4224
+	 * @throws EE_Error
4225
+	 * @return EEM_Base
4226
+	 */
4227
+	public function get_related_model_obj($model_name)
4228
+	{
4229
+		$model_classname = "EEM_" . $model_name;
4230
+		if ( ! class_exists($model_classname)) {
4231
+			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",
4232
+				'event_espresso'), $model_name, $model_classname));
4233
+		}
4234
+		return call_user_func($model_classname . "::instance");
4235
+	}
4236
+
4237
+
4238
+
4239
+	/**
4240
+	 * Returns the array of EE_ModelRelations for this model.
4241
+	 *
4242
+	 * @return EE_Model_Relation_Base[]
4243
+	 */
4244
+	public function relation_settings()
4245
+	{
4246
+		return $this->_model_relations;
4247
+	}
4248
+
4249
+
4250
+
4251
+	/**
4252
+	 * Gets all related models that this model BELONGS TO. Handy to know sometimes
4253
+	 * because without THOSE models, this model probably doesn't have much purpose.
4254
+	 * (Eg, without an event, datetimes have little purpose.)
4255
+	 *
4256
+	 * @return EE_Belongs_To_Relation[]
4257
+	 */
4258
+	public function belongs_to_relations()
4259
+	{
4260
+		$belongs_to_relations = array();
4261
+		foreach ($this->relation_settings() as $model_name => $relation_obj) {
4262
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
4263
+				$belongs_to_relations[$model_name] = $relation_obj;
4264
+			}
4265
+		}
4266
+		return $belongs_to_relations;
4267
+	}
4268
+
4269
+
4270
+
4271
+	/**
4272
+	 * Returns the specified EE_Model_Relation, or throws an exception
4273
+	 *
4274
+	 * @param string $relation_name name of relation, key in $this->_relatedModels
4275
+	 * @throws EE_Error
4276
+	 * @return EE_Model_Relation_Base
4277
+	 */
4278
+	public function related_settings_for($relation_name)
4279
+	{
4280
+		$relatedModels = $this->relation_settings();
4281
+		if ( ! array_key_exists($relation_name, $relatedModels)) {
4282
+			throw new EE_Error(
4283
+				sprintf(
4284
+					__('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4285
+						'event_espresso'),
4286
+					$relation_name,
4287
+					$this->_get_class_name(),
4288
+					implode(', ', array_keys($relatedModels))
4289
+				)
4290
+			);
4291
+		}
4292
+		return $relatedModels[$relation_name];
4293
+	}
4294
+
4295
+
4296
+
4297
+	/**
4298
+	 * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4299
+	 * fields
4300
+	 *
4301
+	 * @param string $fieldName
4302
+	 * @throws EE_Error
4303
+	 * @return EE_Model_Field_Base
4304
+	 */
4305
+	public function field_settings_for($fieldName)
4306
+	{
4307
+		$fieldSettings = $this->field_settings(true);
4308
+		if ( ! array_key_exists($fieldName, $fieldSettings)) {
4309
+			throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4310
+				get_class($this)));
4311
+		}
4312
+		return $fieldSettings[$fieldName];
4313
+	}
4314
+
4315
+
4316
+
4317
+	/**
4318
+	 * Checks if this field exists on this model
4319
+	 *
4320
+	 * @param string $fieldName a key in the model's _field_settings array
4321
+	 * @return boolean
4322
+	 */
4323
+	public function has_field($fieldName)
4324
+	{
4325
+		$fieldSettings = $this->field_settings(true);
4326
+		if (isset($fieldSettings[$fieldName])) {
4327
+			return true;
4328
+		} else {
4329
+			return false;
4330
+		}
4331
+	}
4332
+
4333
+
4334
+
4335
+	/**
4336
+	 * Returns whether or not this model has a relation to the specified model
4337
+	 *
4338
+	 * @param string $relation_name possibly one of the keys in the relation_settings array
4339
+	 * @return boolean
4340
+	 */
4341
+	public function has_relation($relation_name)
4342
+	{
4343
+		$relations = $this->relation_settings();
4344
+		if (isset($relations[$relation_name])) {
4345
+			return true;
4346
+		} else {
4347
+			return false;
4348
+		}
4349
+	}
4350
+
4351
+
4352
+
4353
+	/**
4354
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4355
+	 * Eg, on EE_Answer that would be ANS_ID field object
4356
+	 *
4357
+	 * @param $field_obj
4358
+	 * @return boolean
4359
+	 */
4360
+	public function is_primary_key_field($field_obj)
4361
+	{
4362
+		return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4363
+	}
4364
+
4365
+
4366
+
4367
+	/**
4368
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4369
+	 * Eg, on EE_Answer that would be ANS_ID field object
4370
+	 *
4371
+	 * @return EE_Model_Field_Base
4372
+	 * @throws EE_Error
4373
+	 */
4374
+	public function get_primary_key_field()
4375
+	{
4376
+		if ($this->_primary_key_field === null) {
4377
+			foreach ($this->field_settings(true) as $field_obj) {
4378
+				if ($this->is_primary_key_field($field_obj)) {
4379
+					$this->_primary_key_field = $field_obj;
4380
+					break;
4381
+				}
4382
+			}
4383
+			if ( ! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4384
+				throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4385
+					get_class($this)));
4386
+			}
4387
+		}
4388
+		return $this->_primary_key_field;
4389
+	}
4390
+
4391
+
4392
+
4393
+	/**
4394
+	 * Returns whether or not not there is a primary key on this model.
4395
+	 * Internally does some caching.
4396
+	 *
4397
+	 * @return boolean
4398
+	 */
4399
+	public function has_primary_key_field()
4400
+	{
4401
+		if ($this->_has_primary_key_field === null) {
4402
+			try {
4403
+				$this->get_primary_key_field();
4404
+				$this->_has_primary_key_field = true;
4405
+			} catch (EE_Error $e) {
4406
+				$this->_has_primary_key_field = false;
4407
+			}
4408
+		}
4409
+		return $this->_has_primary_key_field;
4410
+	}
4411
+
4412
+
4413
+
4414
+	/**
4415
+	 * Finds the first field of type $field_class_name.
4416
+	 *
4417
+	 * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4418
+	 *                                 EE_Foreign_Key_Field, etc
4419
+	 * @return EE_Model_Field_Base or null if none is found
4420
+	 */
4421
+	public function get_a_field_of_type($field_class_name)
4422
+	{
4423
+		foreach ($this->field_settings() as $field) {
4424
+			if ($field instanceof $field_class_name) {
4425
+				return $field;
4426
+			}
4427
+		}
4428
+		return null;
4429
+	}
4430
+
4431
+
4432
+
4433
+	/**
4434
+	 * Gets a foreign key field pointing to model.
4435
+	 *
4436
+	 * @param string $model_name eg Event, Registration, not EEM_Event
4437
+	 * @return EE_Foreign_Key_Field_Base
4438
+	 * @throws EE_Error
4439
+	 */
4440
+	public function get_foreign_key_to($model_name)
4441
+	{
4442
+		if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4443
+			foreach ($this->field_settings() as $field) {
4444
+				if (
4445
+					$field instanceof EE_Foreign_Key_Field_Base
4446
+					&& in_array($model_name, $field->get_model_names_pointed_to())
4447
+				) {
4448
+					$this->_cache_foreign_key_to_fields[$model_name] = $field;
4449
+					break;
4450
+				}
4451
+			}
4452
+			if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4453
+				throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4454
+					'event_espresso'), $model_name, get_class($this)));
4455
+			}
4456
+		}
4457
+		return $this->_cache_foreign_key_to_fields[$model_name];
4458
+	}
4459
+
4460
+
4461
+
4462
+	/**
4463
+	 * Gets the actual table for the table alias
4464
+	 *
4465
+	 * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4466
+	 *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4467
+	 *                            Either one works
4468
+	 * @return EE_Table_Base
4469
+	 */
4470
+	public function get_table_for_alias($table_alias)
4471
+	{
4472
+		$table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4473
+		return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4474
+	}
4475
+
4476
+
4477
+
4478
+	/**
4479
+	 * Returns a flat array of all field son this model, instead of organizing them
4480
+	 * by table_alias as they are in the constructor.
4481
+	 *
4482
+	 * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4483
+	 * @return EE_Model_Field_Base[] where the keys are the field's name
4484
+	 */
4485
+	public function field_settings($include_db_only_fields = false)
4486
+	{
4487
+		if ($include_db_only_fields) {
4488
+			if ($this->_cached_fields === null) {
4489
+				$this->_cached_fields = array();
4490
+				foreach ($this->_fields as $fields_corresponding_to_table) {
4491
+					foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4492
+						$this->_cached_fields[$field_name] = $field_obj;
4493
+					}
4494
+				}
4495
+			}
4496
+			return $this->_cached_fields;
4497
+		} else {
4498
+			if ($this->_cached_fields_non_db_only === null) {
4499
+				$this->_cached_fields_non_db_only = array();
4500
+				foreach ($this->_fields as $fields_corresponding_to_table) {
4501
+					foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4502
+						/** @var $field_obj EE_Model_Field_Base */
4503
+						if ( ! $field_obj->is_db_only_field()) {
4504
+							$this->_cached_fields_non_db_only[$field_name] = $field_obj;
4505
+						}
4506
+					}
4507
+				}
4508
+			}
4509
+			return $this->_cached_fields_non_db_only;
4510
+		}
4511
+	}
4512
+
4513
+
4514
+
4515
+	/**
4516
+	 *        cycle though array of attendees and create objects out of each item
4517
+	 *
4518
+	 * @access        private
4519
+	 * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4520
+	 * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4521
+	 *                          numerically indexed)
4522
+	 * @throws \EE_Error
4523
+	 */
4524
+	protected function _create_objects($rows = array())
4525
+	{
4526
+		$array_of_objects = array();
4527
+		if (empty($rows)) {
4528
+			return array();
4529
+		}
4530
+		$count_if_model_has_no_primary_key = 0;
4531
+		$has_primary_key = $this->has_primary_key_field();
4532
+		$primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4533
+		foreach ((array)$rows as $row) {
4534
+			if (empty($row)) {
4535
+				//wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4536
+				return array();
4537
+			}
4538
+			//check if we've already set this object in the results array,
4539
+			//in which case there's no need to process it further (again)
4540
+			if ($has_primary_key) {
4541
+				$table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4542
+					$row,
4543
+					$primary_key_field->get_qualified_column(),
4544
+					$primary_key_field->get_table_column()
4545
+				);
4546
+				if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4547
+					continue;
4548
+				}
4549
+			}
4550
+			$classInstance = $this->instantiate_class_from_array_or_object($row);
4551
+			if ( ! $classInstance) {
4552
+				throw new EE_Error(
4553
+					sprintf(
4554
+						__('Could not create instance of class %s from row %s', 'event_espresso'),
4555
+						$this->get_this_model_name(),
4556
+						http_build_query($row)
4557
+					)
4558
+				);
4559
+			}
4560
+			//set the timezone on the instantiated objects
4561
+			$classInstance->set_timezone($this->_timezone);
4562
+			//make sure if there is any timezone setting present that we set the timezone for the object
4563
+			$key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4564
+			$array_of_objects[$key] = $classInstance;
4565
+			//also, for all the relations of type BelongsTo, see if we can cache
4566
+			//those related models
4567
+			//(we could do this for other relations too, but if there are conditions
4568
+			//that filtered out some fo the results, then we'd be caching an incomplete set
4569
+			//so it requires a little more thought than just caching them immediately...)
4570
+			foreach ($this->_model_relations as $modelName => $relation_obj) {
4571
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
4572
+					//check if this model's INFO is present. If so, cache it on the model
4573
+					$other_model = $relation_obj->get_other_model();
4574
+					$other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4575
+					//if we managed to make a model object from the results, cache it on the main model object
4576
+					if ($other_model_obj_maybe) {
4577
+						//set timezone on these other model objects if they are present
4578
+						$other_model_obj_maybe->set_timezone($this->_timezone);
4579
+						$classInstance->cache($modelName, $other_model_obj_maybe);
4580
+					}
4581
+				}
4582
+			}
4583
+		}
4584
+		return $array_of_objects;
4585
+	}
4586
+
4587
+
4588
+
4589
+	/**
4590
+	 * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4591
+	 * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4592
+	 * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4593
+	 * object (as set in the model_field!).
4594
+	 *
4595
+	 * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4596
+	 */
4597
+	public function create_default_object()
4598
+	{
4599
+		$this_model_fields_and_values = array();
4600
+		//setup the row using default values;
4601
+		foreach ($this->field_settings() as $field_name => $field_obj) {
4602
+			$this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
4603
+		}
4604
+		$className = $this->_get_class_name();
4605
+		$classInstance = EE_Registry::instance()
4606
+									->load_class($className, array($this_model_fields_and_values), false, false);
4607
+		return $classInstance;
4608
+	}
4609
+
4610
+
4611
+
4612
+	/**
4613
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
4614
+	 *                             or an stdClass where each property is the name of a column,
4615
+	 * @return EE_Base_Class
4616
+	 * @throws \EE_Error
4617
+	 */
4618
+	public function instantiate_class_from_array_or_object($cols_n_values)
4619
+	{
4620
+		if ( ! is_array($cols_n_values) && is_object($cols_n_values)) {
4621
+			$cols_n_values = get_object_vars($cols_n_values);
4622
+		}
4623
+		$primary_key = null;
4624
+		//make sure the array only has keys that are fields/columns on this model
4625
+		$this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4626
+		if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
4627
+			$primary_key = $this_model_fields_n_values[$this->primary_key_name()];
4628
+		}
4629
+		$className = $this->_get_class_name();
4630
+		//check we actually found results that we can use to build our model object
4631
+		//if not, return null
4632
+		if ($this->has_primary_key_field()) {
4633
+			if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
4634
+				return null;
4635
+			}
4636
+		} else if ($this->unique_indexes()) {
4637
+			$first_column = reset($this_model_fields_n_values);
4638
+			if (empty($first_column)) {
4639
+				return null;
4640
+			}
4641
+		}
4642
+		// if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
4643
+		if ($primary_key) {
4644
+			$classInstance = $this->get_from_entity_map($primary_key);
4645
+			if ( ! $classInstance) {
4646
+				$classInstance = EE_Registry::instance()
4647
+											->load_class($className,
4648
+												array($this_model_fields_n_values, $this->_timezone), true, false);
4649
+				// add this new object to the entity map
4650
+				$classInstance = $this->add_to_entity_map($classInstance);
4651
+			}
4652
+		} else {
4653
+			$classInstance = EE_Registry::instance()
4654
+										->load_class($className, array($this_model_fields_n_values, $this->_timezone),
4655
+											true, false);
4656
+		}
4657
+		//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.
4658
+		$this->set_timezone($classInstance->get_timezone());
4659
+		return $classInstance;
4660
+	}
4661
+
4662
+
4663
+
4664
+	/**
4665
+	 * Gets the model object from the  entity map if it exists
4666
+	 *
4667
+	 * @param int|string $id the ID of the model object
4668
+	 * @return EE_Base_Class
4669
+	 */
4670
+	public function get_from_entity_map($id)
4671
+	{
4672
+		return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
4673
+			? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
4674
+	}
4675
+
4676
+
4677
+
4678
+	/**
4679
+	 * add_to_entity_map
4680
+	 * Adds the object to the model's entity mappings
4681
+	 *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
4682
+	 *        and for the remainder of the request, it's even more up-to-date than what's in the database.
4683
+	 *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
4684
+	 *        If the database gets updated directly and you want the entity mapper to reflect that change,
4685
+	 *        then this method should be called immediately after the update query
4686
+	 * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
4687
+	 * so on multisite, the entity map is specific to the query being done for a specific site.
4688
+	 *
4689
+	 * @param    EE_Base_Class $object
4690
+	 * @throws EE_Error
4691
+	 * @return \EE_Base_Class
4692
+	 */
4693
+	public function add_to_entity_map(EE_Base_Class $object)
4694
+	{
4695
+		$className = $this->_get_class_name();
4696
+		if ( ! $object instanceof $className) {
4697
+			throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
4698
+				is_object($object) ? get_class($object) : $object, $className));
4699
+		}
4700
+		/** @var $object EE_Base_Class */
4701
+		if ( ! $object->ID()) {
4702
+			throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
4703
+				"event_espresso"), get_class($this)));
4704
+		}
4705
+		// double check it's not already there
4706
+		$classInstance = $this->get_from_entity_map($object->ID());
4707
+		if ($classInstance) {
4708
+			return $classInstance;
4709
+		} else {
4710
+			$this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
4711
+			return $object;
4712
+		}
4713
+	}
4714
+
4715
+
4716
+
4717
+	/**
4718
+	 * if a valid identifier is provided, then that entity is unset from the entity map,
4719
+	 * if no identifier is provided, then the entire entity map is emptied
4720
+	 *
4721
+	 * @param int|string $id the ID of the model object
4722
+	 * @return boolean
4723
+	 */
4724
+	public function clear_entity_map($id = null)
4725
+	{
4726
+		if (empty($id)) {
4727
+			$this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
4728
+			return true;
4729
+		}
4730
+		if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
4731
+			unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
4732
+			return true;
4733
+		}
4734
+		return false;
4735
+	}
4736
+
4737
+
4738
+
4739
+	/**
4740
+	 * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
4741
+	 * Given an array where keys are column (or column alias) names and values,
4742
+	 * returns an array of their corresponding field names and database values
4743
+	 *
4744
+	 * @param array $cols_n_values
4745
+	 * @return array
4746
+	 */
4747
+	public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
4748
+	{
4749
+		return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4750
+	}
4751
+
4752
+
4753
+
4754
+	/**
4755
+	 * _deduce_fields_n_values_from_cols_n_values
4756
+	 * Given an array where keys are column (or column alias) names and values,
4757
+	 * returns an array of their corresponding field names and database values
4758
+	 *
4759
+	 * @param string $cols_n_values
4760
+	 * @return array
4761
+	 */
4762
+	protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
4763
+	{
4764
+		$this_model_fields_n_values = array();
4765
+		foreach ($this->get_tables() as $table_alias => $table_obj) {
4766
+			$table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
4767
+				$table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
4768
+			//there is a primary key on this table and its not set. Use defaults for all its columns
4769
+			if ($table_pk_value === null && $table_obj->get_pk_column()) {
4770
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
4771
+					if ( ! $field_obj->is_db_only_field()) {
4772
+						//prepare field as if its coming from db
4773
+						$prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
4774
+						$this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
4775
+					}
4776
+				}
4777
+			} else {
4778
+				//the table's rows existed. Use their values
4779
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
4780
+					if ( ! $field_obj->is_db_only_field()) {
4781
+						$this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
4782
+							$cols_n_values, $field_obj->get_qualified_column(),
4783
+							$field_obj->get_table_column()
4784
+						);
4785
+					}
4786
+				}
4787
+			}
4788
+		}
4789
+		return $this_model_fields_n_values;
4790
+	}
4791
+
4792
+
4793
+
4794
+	/**
4795
+	 * @param $cols_n_values
4796
+	 * @param $qualified_column
4797
+	 * @param $regular_column
4798
+	 * @return null
4799
+	 */
4800
+	protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
4801
+	{
4802
+		$value = null;
4803
+		//ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
4804
+		//does the field on the model relate to this column retrieved from the db?
4805
+		//or is it a db-only field? (not relating to the model)
4806
+		if (isset($cols_n_values[$qualified_column])) {
4807
+			$value = $cols_n_values[$qualified_column];
4808
+		} elseif (isset($cols_n_values[$regular_column])) {
4809
+			$value = $cols_n_values[$regular_column];
4810
+		}
4811
+		return $value;
4812
+	}
4813
+
4814
+
4815
+
4816
+	/**
4817
+	 * refresh_entity_map_from_db
4818
+	 * Makes sure the model object in the entity map at $id assumes the values
4819
+	 * of the database (opposite of EE_base_Class::save())
4820
+	 *
4821
+	 * @param int|string $id
4822
+	 * @return EE_Base_Class
4823
+	 * @throws \EE_Error
4824
+	 */
4825
+	public function refresh_entity_map_from_db($id)
4826
+	{
4827
+		$obj_in_map = $this->get_from_entity_map($id);
4828
+		if ($obj_in_map) {
4829
+			$wpdb_results = $this->_get_all_wpdb_results(
4830
+				array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
4831
+			);
4832
+			if ($wpdb_results && is_array($wpdb_results)) {
4833
+				$one_row = reset($wpdb_results);
4834
+				foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
4835
+					$obj_in_map->set_from_db($field_name, $db_value);
4836
+				}
4837
+				//clear the cache of related model objects
4838
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
4839
+					$obj_in_map->clear_cache($relation_name, null, true);
4840
+				}
4841
+			}
4842
+			return $obj_in_map;
4843
+		} else {
4844
+			return $this->get_one_by_ID($id);
4845
+		}
4846
+	}
4847
+
4848
+
4849
+
4850
+	/**
4851
+	 * refresh_entity_map_with
4852
+	 * Leaves the entry in the entity map alone, but updates it to match the provided
4853
+	 * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
4854
+	 * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
4855
+	 * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
4856
+	 *
4857
+	 * @param int|string    $id
4858
+	 * @param EE_Base_Class $replacing_model_obj
4859
+	 * @return \EE_Base_Class
4860
+	 * @throws \EE_Error
4861
+	 */
4862
+	public function refresh_entity_map_with($id, $replacing_model_obj)
4863
+	{
4864
+		$obj_in_map = $this->get_from_entity_map($id);
4865
+		if ($obj_in_map) {
4866
+			if ($replacing_model_obj instanceof EE_Base_Class) {
4867
+				foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
4868
+					$obj_in_map->set($field_name, $value);
4869
+				}
4870
+				//make the model object in the entity map's cache match the $replacing_model_obj
4871
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
4872
+					$obj_in_map->clear_cache($relation_name, null, true);
4873
+					foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
4874
+						$obj_in_map->cache($relation_name, $cached_obj, $cache_id);
4875
+					}
4876
+				}
4877
+			}
4878
+			return $obj_in_map;
4879
+		} else {
4880
+			$this->add_to_entity_map($replacing_model_obj);
4881
+			return $replacing_model_obj;
4882
+		}
4883
+	}
4884
+
4885
+
4886
+
4887
+	/**
4888
+	 * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
4889
+	 * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
4890
+	 * require_once($this->_getClassName().".class.php");
4891
+	 *
4892
+	 * @return string
4893
+	 */
4894
+	private function _get_class_name()
4895
+	{
4896
+		return "EE_" . $this->get_this_model_name();
4897
+	}
4898
+
4899
+
4900
+
4901
+	/**
4902
+	 * Get the name of the items this model represents, for the quantity specified. Eg,
4903
+	 * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
4904
+	 * it would be 'Events'.
4905
+	 *
4906
+	 * @param int $quantity
4907
+	 * @return string
4908
+	 */
4909
+	public function item_name($quantity = 1)
4910
+	{
4911
+		return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
4912
+	}
4913
+
4914
+
4915
+
4916
+	/**
4917
+	 * Very handy general function to allow for plugins to extend any child of EE_TempBase.
4918
+	 * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
4919
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
4920
+	 * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
4921
+	 * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
4922
+	 * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
4923
+	 * was called, and an array of the original arguments passed to the function. Whatever their callback function
4924
+	 * returns will be returned by this function. Example: in functions.php (or in a plugin):
4925
+	 * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
4926
+	 * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
4927
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
4928
+	 *        return $previousReturnValue.$returnString;
4929
+	 * }
4930
+	 * require('EEM_Answer.model.php');
4931
+	 * $answer=EEM_Answer::instance();
4932
+	 * echo $answer->my_callback('monkeys',100);
4933
+	 * //will output "you called my_callback! and passed args:monkeys,100"
4934
+	 *
4935
+	 * @param string $methodName name of method which was called on a child of EE_TempBase, but which
4936
+	 * @param array  $args       array of original arguments passed to the function
4937
+	 * @throws EE_Error
4938
+	 * @return mixed whatever the plugin which calls add_filter decides
4939
+	 */
4940
+	public function __call($methodName, $args)
4941
+	{
4942
+		$className = get_class($this);
4943
+		$tagName = "FHEE__{$className}__{$methodName}";
4944
+		if ( ! has_filter($tagName)) {
4945
+			throw new EE_Error(
4946
+				sprintf(
4947
+					__('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 );',
4948
+						'event_espresso'),
4949
+					$methodName,
4950
+					$className,
4951
+					$tagName,
4952
+					'<br />'
4953
+				)
4954
+			);
4955
+		}
4956
+		return apply_filters($tagName, null, $this, $args);
4957
+	}
4958
+
4959
+
4960
+
4961
+	/**
4962
+	 * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
4963
+	 * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
4964
+	 *
4965
+	 * @param EE_Base_Class|string|int $base_class_obj_or_id either:
4966
+	 *                                                       the EE_Base_Class object that corresponds to this Model,
4967
+	 *                                                       the object's class name
4968
+	 *                                                       or object's ID
4969
+	 * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
4970
+	 *                                                       exists in the database. If it does not, we add it
4971
+	 * @throws EE_Error
4972
+	 * @return EE_Base_Class
4973
+	 */
4974
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
4975
+	{
4976
+		$className = $this->_get_class_name();
4977
+		if ($base_class_obj_or_id instanceof $className) {
4978
+			$model_object = $base_class_obj_or_id;
4979
+		} else {
4980
+			$primary_key_field = $this->get_primary_key_field();
4981
+			if (
4982
+				$primary_key_field instanceof EE_Primary_Key_Int_Field
4983
+				&& (
4984
+					is_int($base_class_obj_or_id)
4985
+					|| is_string($base_class_obj_or_id)
4986
+				)
4987
+			) {
4988
+				// assume it's an ID.
4989
+				// either a proper integer or a string representing an integer (eg "101" instead of 101)
4990
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
4991
+			} else if (
4992
+				$primary_key_field instanceof EE_Primary_Key_String_Field
4993
+				&& is_string($base_class_obj_or_id)
4994
+			) {
4995
+				// assume its a string representation of the object
4996
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
4997
+			} else {
4998
+				throw new EE_Error(
4999
+					sprintf(
5000
+						__(
5001
+							"'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5002
+							'event_espresso'
5003
+						),
5004
+						$base_class_obj_or_id,
5005
+						$this->_get_class_name(),
5006
+						print_r($base_class_obj_or_id, true)
5007
+					)
5008
+				);
5009
+			}
5010
+		}
5011
+		if ($ensure_is_in_db && $model_object->ID() !== null) {
5012
+			$model_object->save();
5013
+		}
5014
+		return $model_object;
5015
+	}
5016
+
5017
+
5018
+
5019
+	/**
5020
+	 * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5021
+	 * is a value of the this model's primary key. If it's an EE_Base_Class child,
5022
+	 * returns it ID.
5023
+	 *
5024
+	 * @param EE_Base_Class|int|string $base_class_obj_or_id
5025
+	 * @return int|string depending on the type of this model object's ID
5026
+	 * @throws EE_Error
5027
+	 */
5028
+	public function ensure_is_ID($base_class_obj_or_id)
5029
+	{
5030
+		$className = $this->_get_class_name();
5031
+		if ($base_class_obj_or_id instanceof $className) {
5032
+			/** @var $base_class_obj_or_id EE_Base_Class */
5033
+			$id = $base_class_obj_or_id->ID();
5034
+		} elseif (is_int($base_class_obj_or_id)) {
5035
+			//assume it's an ID
5036
+			$id = $base_class_obj_or_id;
5037
+		} elseif (is_string($base_class_obj_or_id)) {
5038
+			//assume its a string representation of the object
5039
+			$id = $base_class_obj_or_id;
5040
+		} else {
5041
+			throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5042
+				'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5043
+				print_r($base_class_obj_or_id, true)));
5044
+		}
5045
+		return $id;
5046
+	}
5047
+
5048
+
5049
+
5050
+	/**
5051
+	 * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5052
+	 * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5053
+	 * been sanitized and converted into the appropriate domain.
5054
+	 * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5055
+	 * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5056
+	 * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5057
+	 * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5058
+	 * $EVT = EEM_Event::instance(); $old_setting =
5059
+	 * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5060
+	 * $EVT->assume_values_already_prepared_by_model_object(true);
5061
+	 * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5062
+	 * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5063
+	 *
5064
+	 * @param int $values_already_prepared like one of the constants on EEM_Base
5065
+	 * @return void
5066
+	 */
5067
+	public function assume_values_already_prepared_by_model_object(
5068
+		$values_already_prepared = self::not_prepared_by_model_object
5069
+	) {
5070
+		$this->_values_already_prepared_by_model_object = $values_already_prepared;
5071
+	}
5072
+
5073
+
5074
+
5075
+	/**
5076
+	 * Read comments for assume_values_already_prepared_by_model_object()
5077
+	 *
5078
+	 * @return int
5079
+	 */
5080
+	public function get_assumption_concerning_values_already_prepared_by_model_object()
5081
+	{
5082
+		return $this->_values_already_prepared_by_model_object;
5083
+	}
5084
+
5085
+
5086
+
5087
+	/**
5088
+	 * Gets all the indexes on this model
5089
+	 *
5090
+	 * @return EE_Index[]
5091
+	 */
5092
+	public function indexes()
5093
+	{
5094
+		return $this->_indexes;
5095
+	}
5096
+
5097
+
5098
+
5099
+	/**
5100
+	 * Gets all the Unique Indexes on this model
5101
+	 *
5102
+	 * @return EE_Unique_Index[]
5103
+	 */
5104
+	public function unique_indexes()
5105
+	{
5106
+		$unique_indexes = array();
5107
+		foreach ($this->_indexes as $name => $index) {
5108
+			if ($index instanceof EE_Unique_Index) {
5109
+				$unique_indexes [$name] = $index;
5110
+			}
5111
+		}
5112
+		return $unique_indexes;
5113
+	}
5114
+
5115
+
5116
+
5117
+	/**
5118
+	 * Gets all the fields which, when combined, make the primary key.
5119
+	 * This is usually just an array with 1 element (the primary key), but in cases
5120
+	 * where there is no primary key, it's a combination of fields as defined
5121
+	 * on a primary index
5122
+	 *
5123
+	 * @return EE_Model_Field_Base[] indexed by the field's name
5124
+	 * @throws \EE_Error
5125
+	 */
5126
+	public function get_combined_primary_key_fields()
5127
+	{
5128
+		foreach ($this->indexes() as $index) {
5129
+			if ($index instanceof EE_Primary_Key_Index) {
5130
+				return $index->fields();
5131
+			}
5132
+		}
5133
+		return array($this->primary_key_name() => $this->get_primary_key_field());
5134
+	}
5135
+
5136
+
5137
+
5138
+	/**
5139
+	 * Used to build a primary key string (when the model has no primary key),
5140
+	 * which can be used a unique string to identify this model object.
5141
+	 *
5142
+	 * @param array $cols_n_values keys are field names, values are their values
5143
+	 * @return string
5144
+	 * @throws \EE_Error
5145
+	 */
5146
+	public function get_index_primary_key_string($cols_n_values)
5147
+	{
5148
+		$cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5149
+			$this->get_combined_primary_key_fields());
5150
+		return http_build_query($cols_n_values_for_primary_key_index);
5151
+	}
5152
+
5153
+
5154
+
5155
+	/**
5156
+	 * Gets the field values from the primary key string
5157
+	 *
5158
+	 * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5159
+	 * @param string $index_primary_key_string
5160
+	 * @return null|array
5161
+	 * @throws \EE_Error
5162
+	 */
5163
+	public function parse_index_primary_key_string($index_primary_key_string)
5164
+	{
5165
+		$key_fields = $this->get_combined_primary_key_fields();
5166
+		//check all of them are in the $id
5167
+		$key_vals_in_combined_pk = array();
5168
+		parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5169
+		foreach ($key_fields as $key_field_name => $field_obj) {
5170
+			if ( ! isset($key_vals_in_combined_pk[$key_field_name])) {
5171
+				return null;
5172
+			}
5173
+		}
5174
+		return $key_vals_in_combined_pk;
5175
+	}
5176
+
5177
+
5178
+
5179
+	/**
5180
+	 * verifies that an array of key-value pairs for model fields has a key
5181
+	 * for each field comprising the primary key index
5182
+	 *
5183
+	 * @param array $key_vals
5184
+	 * @return boolean
5185
+	 * @throws \EE_Error
5186
+	 */
5187
+	public function has_all_combined_primary_key_fields($key_vals)
5188
+	{
5189
+		$keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5190
+		foreach ($keys_it_should_have as $key) {
5191
+			if ( ! isset($key_vals[$key])) {
5192
+				return false;
5193
+			}
5194
+		}
5195
+		return true;
5196
+	}
5197
+
5198
+
5199
+
5200
+	/**
5201
+	 * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5202
+	 * We consider something to be a copy if all the attributes match (except the ID, of course).
5203
+	 *
5204
+	 * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5205
+	 * @param array               $query_params                     like EEM_Base::get_all's query_params.
5206
+	 * @throws EE_Error
5207
+	 * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5208
+	 *                          indexed)
5209
+	 */
5210
+	public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5211
+	{
5212
+		if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5213
+			$attributes_array = $model_object_or_attributes_array->model_field_array();
5214
+		} elseif (is_array($model_object_or_attributes_array)) {
5215
+			$attributes_array = $model_object_or_attributes_array;
5216
+		} else {
5217
+			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",
5218
+				"event_espresso"), $model_object_or_attributes_array));
5219
+		}
5220
+		//even copies obviously won't have the same ID, so remove the primary key
5221
+		//from the WHERE conditions for finding copies (if there is a primary key, of course)
5222
+		if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5223
+			unset($attributes_array[$this->primary_key_name()]);
5224
+		}
5225
+		if (isset($query_params[0])) {
5226
+			$query_params[0] = array_merge($attributes_array, $query_params);
5227
+		} else {
5228
+			$query_params[0] = $attributes_array;
5229
+		}
5230
+		return $this->get_all($query_params);
5231
+	}
5232
+
5233
+
5234
+
5235
+	/**
5236
+	 * Gets the first copy we find. See get_all_copies for more details
5237
+	 *
5238
+	 * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5239
+	 * @param array $query_params
5240
+	 * @return EE_Base_Class
5241
+	 * @throws \EE_Error
5242
+	 */
5243
+	public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5244
+	{
5245
+		if ( ! is_array($query_params)) {
5246
+			EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5247
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5248
+					gettype($query_params)), '4.6.0');
5249
+			$query_params = array();
5250
+		}
5251
+		$query_params['limit'] = 1;
5252
+		$copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5253
+		if (is_array($copies)) {
5254
+			return array_shift($copies);
5255
+		} else {
5256
+			return null;
5257
+		}
5258
+	}
5259
+
5260
+
5261
+
5262
+	/**
5263
+	 * Updates the item with the specified id. Ignores default query parameters because
5264
+	 * we have specified the ID, and its assumed we KNOW what we're doing
5265
+	 *
5266
+	 * @param array      $fields_n_values keys are field names, values are their new values
5267
+	 * @param int|string $id              the value of the primary key to update
5268
+	 * @return int number of rows updated
5269
+	 * @throws \EE_Error
5270
+	 */
5271
+	public function update_by_ID($fields_n_values, $id)
5272
+	{
5273
+		$query_params = array(
5274
+			0                          => array($this->get_primary_key_field()->get_name() => $id),
5275
+			'default_where_conditions' => 'other_models_only',
5276
+		);
5277
+		return $this->update($fields_n_values, $query_params);
5278
+	}
5279
+
5280
+
5281
+
5282
+	/**
5283
+	 * Changes an operator which was supplied to the models into one usable in SQL
5284
+	 *
5285
+	 * @param string $operator_supplied
5286
+	 * @return string an operator which can be used in SQL
5287
+	 * @throws EE_Error
5288
+	 */
5289
+	private function _prepare_operator_for_sql($operator_supplied)
5290
+	{
5291
+		$sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5292
+			: null;
5293
+		if ($sql_operator) {
5294
+			return $sql_operator;
5295
+		} else {
5296
+			throw new EE_Error(sprintf(__("The operator '%s' is not in the list of valid operators: %s",
5297
+				"event_espresso"), $operator_supplied, implode(",", array_keys($this->_valid_operators))));
5298
+		}
5299
+	}
5300
+
5301
+
5302
+
5303
+	/**
5304
+	 * Gets an array where keys are the primary keys and values are their 'names'
5305
+	 * (as determined by the model object's name() function, which is often overridden)
5306
+	 *
5307
+	 * @param array $query_params like get_all's
5308
+	 * @return string[]
5309
+	 * @throws \EE_Error
5310
+	 */
5311
+	public function get_all_names($query_params = array())
5312
+	{
5313
+		$objs = $this->get_all($query_params);
5314
+		$names = array();
5315
+		foreach ($objs as $obj) {
5316
+			$names[$obj->ID()] = $obj->name();
5317
+		}
5318
+		return $names;
5319
+	}
5320
+
5321
+
5322
+
5323
+	/**
5324
+	 * Gets an array of primary keys from the model objects. If you acquired the model objects
5325
+	 * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5326
+	 * this is duplicated effort and reduces efficiency) you would be better to use
5327
+	 * array_keys() on $model_objects.
5328
+	 *
5329
+	 * @param \EE_Base_Class[] $model_objects
5330
+	 * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5331
+	 *                                               in the returned array
5332
+	 * @return array
5333
+	 * @throws \EE_Error
5334
+	 */
5335
+	public function get_IDs($model_objects, $filter_out_empty_ids = false)
5336
+	{
5337
+		if ( ! $this->has_primary_key_field()) {
5338
+			if (WP_DEBUG) {
5339
+				EE_Error::add_error(
5340
+					__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5341
+					__FILE__,
5342
+					__FUNCTION__,
5343
+					__LINE__
5344
+				);
5345
+			}
5346
+		}
5347
+		$IDs = array();
5348
+		foreach ($model_objects as $model_object) {
5349
+			$id = $model_object->ID();
5350
+			if ( ! $id) {
5351
+				if ($filter_out_empty_ids) {
5352
+					continue;
5353
+				}
5354
+				if (WP_DEBUG) {
5355
+					EE_Error::add_error(
5356
+						__(
5357
+							'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5358
+							'event_espresso'
5359
+						),
5360
+						__FILE__,
5361
+						__FUNCTION__,
5362
+						__LINE__
5363
+					);
5364
+				}
5365
+			}
5366
+			$IDs[] = $id;
5367
+		}
5368
+		return $IDs;
5369
+	}
5370
+
5371
+
5372
+
5373
+	/**
5374
+	 * Returns the string used in capabilities relating to this model. If there
5375
+	 * are no capabilities that relate to this model returns false
5376
+	 *
5377
+	 * @return string|false
5378
+	 */
5379
+	public function cap_slug()
5380
+	{
5381
+		return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5382
+	}
5383
+
5384
+
5385
+
5386
+	/**
5387
+	 * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5388
+	 * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5389
+	 * only returns the cap restrictions array in that context (ie, the array
5390
+	 * at that key)
5391
+	 *
5392
+	 * @param string $context
5393
+	 * @return EE_Default_Where_Conditions[] indexed by associated capability
5394
+	 * @throws \EE_Error
5395
+	 */
5396
+	public function cap_restrictions($context = EEM_Base::caps_read)
5397
+	{
5398
+		EEM_Base::verify_is_valid_cap_context($context);
5399
+		//check if we ought to run the restriction generator first
5400
+		if (
5401
+			isset($this->_cap_restriction_generators[$context])
5402
+			&& $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5403
+			&& ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5404
+		) {
5405
+			$this->_cap_restrictions[$context] = array_merge(
5406
+				$this->_cap_restrictions[$context],
5407
+				$this->_cap_restriction_generators[$context]->generate_restrictions()
5408
+			);
5409
+		}
5410
+		//and make sure we've finalized the construction of each restriction
5411
+		foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5412
+			if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5413
+				$where_conditions_obj->_finalize_construct($this);
5414
+			}
5415
+		}
5416
+		return $this->_cap_restrictions[$context];
5417
+	}
5418
+
5419
+
5420
+
5421
+	/**
5422
+	 * Indicating whether or not this model thinks its a wp core model
5423
+	 *
5424
+	 * @return boolean
5425
+	 */
5426
+	public function is_wp_core_model()
5427
+	{
5428
+		return $this->_wp_core_model;
5429
+	}
5430
+
5431
+
5432
+
5433
+	/**
5434
+	 * Gets all the caps that are missing which impose a restriction on
5435
+	 * queries made in this context
5436
+	 *
5437
+	 * @param string $context one of EEM_Base::caps_ constants
5438
+	 * @return EE_Default_Where_Conditions[] indexed by capability name
5439
+	 * @throws \EE_Error
5440
+	 */
5441
+	public function caps_missing($context = EEM_Base::caps_read)
5442
+	{
5443
+		$missing_caps = array();
5444
+		$cap_restrictions = $this->cap_restrictions($context);
5445
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5446
+			if ( ! EE_Capabilities::instance()
5447
+								  ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5448
+			) {
5449
+				$missing_caps[$cap] = $restriction_if_no_cap;
5450
+			}
5451
+		}
5452
+		return $missing_caps;
5453
+	}
5454
+
5455
+
5456
+
5457
+	/**
5458
+	 * Gets the mapping from capability contexts to action strings used in capability names
5459
+	 *
5460
+	 * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5461
+	 * one of 'read', 'edit', or 'delete'
5462
+	 */
5463
+	public function cap_contexts_to_cap_action_map()
5464
+	{
5465
+		return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5466
+			$this);
5467
+	}
5468
+
5469
+
5470
+
5471
+	/**
5472
+	 * Gets the action string for the specified capability context
5473
+	 *
5474
+	 * @param string $context
5475
+	 * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5476
+	 * @throws \EE_Error
5477
+	 */
5478
+	public function cap_action_for_context($context)
5479
+	{
5480
+		$mapping = $this->cap_contexts_to_cap_action_map();
5481
+		if (isset($mapping[$context])) {
5482
+			return $mapping[$context];
5483
+		}
5484
+		if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5485
+			return $action;
5486
+		}
5487
+		throw new EE_Error(
5488
+			sprintf(
5489
+				__('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5490
+				$context,
5491
+				implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5492
+			)
5493
+		);
5494
+	}
5495
+
5496
+
5497
+
5498
+	/**
5499
+	 * Returns all the capability contexts which are valid when querying models
5500
+	 *
5501
+	 * @return array
5502
+	 */
5503
+	static public function valid_cap_contexts()
5504
+	{
5505
+		return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5506
+			self::caps_read,
5507
+			self::caps_read_admin,
5508
+			self::caps_edit,
5509
+			self::caps_delete,
5510
+		));
5511
+	}
5512
+
5513
+
5514
+
5515
+	/**
5516
+	 * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5517
+	 *
5518
+	 * @param string $context
5519
+	 * @return bool
5520
+	 * @throws \EE_Error
5521
+	 */
5522
+	static public function verify_is_valid_cap_context($context)
5523
+	{
5524
+		$valid_cap_contexts = EEM_Base::valid_cap_contexts();
5525
+		if (in_array($context, $valid_cap_contexts)) {
5526
+			return true;
5527
+		} else {
5528
+			throw new EE_Error(
5529
+				sprintf(
5530
+					__('Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5531
+						'event_espresso'),
5532
+					$context,
5533
+					'EEM_Base',
5534
+					implode(',', $valid_cap_contexts)
5535
+				)
5536
+			);
5537
+		}
5538
+	}
5539
+
5540
+
5541
+
5542
+	/**
5543
+	 * Clears all the models field caches. This is only useful when a sub-class
5544
+	 * might have added a field or something and these caches might be invalidated
5545
+	 */
5546
+	protected function _invalidate_field_caches()
5547
+	{
5548
+		$this->_cache_foreign_key_to_fields = array();
5549
+		$this->_cached_fields = null;
5550
+		$this->_cached_fields_non_db_only = null;
5551
+	}
5552 5552
 
5553 5553
 
5554 5554
 
Please login to merge, or discard this patch.
Spacing   +72 added lines, -72 removed lines patch added patch discarded remove patch
@@ -467,7 +467,7 @@  discard block
 block discarded – undo
467 467
     {
468 468
         // check that the model has not been loaded too soon
469 469
         if ( ! did_action('AHEE__EE_System__load_espresso_addons')) {
470
-            throw new EE_Error (
470
+            throw new EE_Error(
471 471
                 sprintf(
472 472
                     __('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.',
473 473
                         'event_espresso'),
@@ -487,7 +487,7 @@  discard block
 block discarded – undo
487 487
          *
488 488
          * @var EE_Table_Base[] $_tables
489 489
          */
490
-        $this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
490
+        $this->_tables = apply_filters('FHEE__'.get_class($this).'__construct__tables', $this->_tables);
491 491
         foreach ($this->_tables as $table_alias => $table_obj) {
492 492
             /** @var $table_obj EE_Table_Base */
493 493
             $table_obj->_construct_finalize_with_alias($table_alias);
@@ -502,7 +502,7 @@  discard block
 block discarded – undo
502 502
          *
503 503
          * @param EE_Model_Field_Base[] $_fields
504 504
          */
505
-        $this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
505
+        $this->_fields = apply_filters('FHEE__'.get_class($this).'__construct__fields', $this->_fields);
506 506
         $this->_invalidate_field_caches();
507 507
         foreach ($this->_fields as $table_alias => $fields_for_table) {
508 508
             if ( ! array_key_exists($table_alias, $this->_tables)) {
@@ -533,7 +533,7 @@  discard block
 block discarded – undo
533 533
          *
534 534
          * @param EE_Model_Relation_Base[] $_model_relations
535 535
          */
536
-        $this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
536
+        $this->_model_relations = apply_filters('FHEE__'.get_class($this).'__construct__model_relations',
537 537
             $this->_model_relations);
538 538
         foreach ($this->_model_relations as $model_name => $relation_obj) {
539 539
             /** @var $relation_obj EE_Model_Relation_Base */
@@ -595,7 +595,7 @@  discard block
 block discarded – undo
595 595
                 }
596 596
             }
597 597
         }
598
-        do_action('AHEE__' . get_class($this) . '__construct__end');
598
+        do_action('AHEE__'.get_class($this).'__construct__end');
599 599
     }
600 600
 
601 601
 
@@ -630,7 +630,7 @@  discard block
 block discarded – undo
630 630
      */
631 631
     public static function set_model_query_blog_id($blog_id = 0)
632 632
     {
633
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
633
+        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int) $blog_id : get_current_blog_id();
634 634
     }
635 635
 
636 636
 
@@ -870,13 +870,13 @@  discard block
 block discarded – undo
870 870
                 $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
871 871
                 $last_model_name = end($models_to_follow_to_wp_users);
872 872
                 $model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
873
-                $model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
873
+                $model_chain_to_wp_user = $this->_model_chain_to_wp_user.'.';
874 874
             } else {
875 875
                 $model_with_fk_to_wp_users = $this;
876 876
                 $model_chain_to_wp_user = '';
877 877
             }
878 878
             $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
879
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
879
+            return $model_chain_to_wp_user.$wp_user_field->get_name();
880 880
         } catch (EE_Error $e) {
881 881
             return false;
882 882
         }
@@ -948,12 +948,12 @@  discard block
 block discarded – undo
948 948
         // remember the custom selections, if any, and type cast as array
949 949
         // (unless $columns_to_select is an object, then just set as an empty array)
950 950
         // Note: (array) 'some string' === array( 'some string' )
951
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
951
+        $this->_custom_selections = ! is_object($columns_to_select) ? (array) $columns_to_select : array();
952 952
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
953 953
         $select_expressions = $columns_to_select !== null
954 954
             ? $this->_construct_select_from_input($columns_to_select)
955 955
             : $this->_construct_default_select_sql($model_query_info);
956
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
956
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
957 957
         return $this->_do_wpdb_query('get_results', array($SQL, $output));
958 958
     }
959 959
 
@@ -1285,7 +1285,7 @@  discard block
 block discarded – undo
1285 1285
         $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1286 1286
         $query_params['limit'] = $limit;
1287 1287
         //set direction
1288
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1288
+        $incoming_orderby = isset($query_params['order_by']) ? (array) $query_params['order_by'] : array();
1289 1289
         $query_params['order_by'] = $operand === '>'
1290 1290
             ? array($field_to_order_by => 'ASC') + $incoming_orderby
1291 1291
             : array($field_to_order_by => 'DESC') + $incoming_orderby;
@@ -1525,7 +1525,7 @@  discard block
 block discarded – undo
1525 1525
          * @param EEM_Base $model           the model being queried
1526 1526
          * @param array    $query_params    see EEM_Base::get_all()
1527 1527
          */
1528
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1528
+        $fields_n_values = (array) apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1529 1529
             $query_params);
1530 1530
         //need to verify that, for any entry we want to update, there are entries in each secondary table.
1531 1531
         //to do that, for each table, verify that it's PK isn't null.
@@ -1539,7 +1539,7 @@  discard block
 block discarded – undo
1539 1539
         $wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1540 1540
         foreach ($wpdb_select_results as $wpdb_result) {
1541 1541
             // type cast stdClass as array
1542
-            $wpdb_result = (array)$wpdb_result;
1542
+            $wpdb_result = (array) $wpdb_result;
1543 1543
             //get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1544 1544
             if ($this->has_primary_key_field()) {
1545 1545
                 $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
@@ -1620,7 +1620,7 @@  discard block
 block discarded – undo
1620 1620
                . $model_query_info->get_full_join_sql()
1621 1621
                . " SET "
1622 1622
                . $this->_construct_update_sql($fields_n_values)
1623
-               . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1623
+               . $model_query_info->get_where_sql(); //note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1624 1624
         $rows_affected = $this->_do_wpdb_query('query', array($SQL));
1625 1625
         /**
1626 1626
          * Action called after a model update call has been made.
@@ -1631,7 +1631,7 @@  discard block
 block discarded – undo
1631 1631
          * @param int      $rows_affected
1632 1632
          */
1633 1633
         do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1634
-        return $rows_affected;//how many supposedly got updated
1634
+        return $rows_affected; //how many supposedly got updated
1635 1635
     }
1636 1636
 
1637 1637
 
@@ -1659,7 +1659,7 @@  discard block
 block discarded – undo
1659 1659
         }
1660 1660
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
1661 1661
         $select_expressions = $field->get_qualified_column();
1662
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1662
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
1663 1663
         return $this->_do_wpdb_query('get_col', array($SQL));
1664 1664
     }
1665 1665
 
@@ -1709,7 +1709,7 @@  discard block
 block discarded – undo
1709 1709
             $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1710 1710
             $value_sql = $prepared_value === null ? 'NULL'
1711 1711
                 : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1712
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1712
+            $cols_n_values[] = $field_obj->get_qualified_column()."=".$value_sql;
1713 1713
         }
1714 1714
         return implode(",", $cols_n_values);
1715 1715
     }
@@ -1841,7 +1841,7 @@  discard block
 block discarded – undo
1841 1841
          * @param int      $rows_deleted
1842 1842
          */
1843 1843
         do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
1844
-        return $rows_deleted;//how many supposedly got deleted
1844
+        return $rows_deleted; //how many supposedly got deleted
1845 1845
     }
1846 1846
 
1847 1847
 
@@ -1957,7 +1957,7 @@  discard block
 block discarded – undo
1957 1957
             foreach ($deletes as $column => $values) {
1958 1958
                 //make sure we have unique $values;
1959 1959
                 $values = array_unique($values);
1960
-                $query[] = $column . ' IN(' . implode(",", $values) . ')';
1960
+                $query[] = $column.' IN('.implode(",", $values).')';
1961 1961
             }
1962 1962
             return ! empty($query) ? implode(' AND ', $query) : '';
1963 1963
         } elseif (count($this->get_combined_primary_key_fields()) > 1) {
@@ -1973,7 +1973,7 @@  discard block
 block discarded – undo
1973 1973
                                                            . $delete_object[$cpk_field->get_qualified_column()];
1974 1974
                     }
1975 1975
                 }
1976
-                $ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
1976
+                $ways_to_identify_a_row[] = "(".implode(" AND ", $values_for_each_cpk_for_a_row).")";
1977 1977
             }
1978 1978
             return implode(" OR ", $ways_to_identify_a_row);
1979 1979
         } else {
@@ -2022,9 +2022,9 @@  discard block
 block discarded – undo
2022 2022
                 $column_to_count = '*';
2023 2023
             }
2024 2024
         }
2025
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2026
-        $SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2027
-        return (int)$this->_do_wpdb_query('get_var', array($SQL));
2025
+        $column_to_count = $distinct ? "DISTINCT ".$column_to_count : $column_to_count;
2026
+        $SQL = "SELECT COUNT(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
2027
+        return (int) $this->_do_wpdb_query('get_var', array($SQL));
2028 2028
     }
2029 2029
 
2030 2030
 
@@ -2046,13 +2046,13 @@  discard block
 block discarded – undo
2046 2046
             $field_obj = $this->get_primary_key_field();
2047 2047
         }
2048 2048
         $column_to_count = $field_obj->get_qualified_column();
2049
-        $SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2049
+        $SQL = "SELECT SUM(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
2050 2050
         $return_value = $this->_do_wpdb_query('get_var', array($SQL));
2051 2051
         $data_type = $field_obj->get_wpdb_data_type();
2052 2052
         if ($data_type === '%d' || $data_type === '%s') {
2053
-            return (float)$return_value;
2053
+            return (float) $return_value;
2054 2054
         } else {//must be %f
2055
-            return (float)$return_value;
2055
+            return (float) $return_value;
2056 2056
         }
2057 2057
     }
2058 2058
 
@@ -2227,11 +2227,11 @@  discard block
 block discarded – undo
2227 2227
      */
2228 2228
     private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2229 2229
     {
2230
-        return " FROM " . $model_query_info->get_full_join_sql() .
2231
-               $model_query_info->get_where_sql() .
2232
-               $model_query_info->get_group_by_sql() .
2233
-               $model_query_info->get_having_sql() .
2234
-               $model_query_info->get_order_by_sql() .
2230
+        return " FROM ".$model_query_info->get_full_join_sql().
2231
+               $model_query_info->get_where_sql().
2232
+               $model_query_info->get_group_by_sql().
2233
+               $model_query_info->get_having_sql().
2234
+               $model_query_info->get_order_by_sql().
2235 2235
                $model_query_info->get_limit_sql();
2236 2236
     }
2237 2237
 
@@ -2432,7 +2432,7 @@  discard block
 block discarded – undo
2432 2432
         }
2433 2433
         $this_model_name = $this->get_this_model_name();
2434 2434
         $this_pk_field_name = $this->get_primary_key_field()->get_name();
2435
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2435
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
2436 2436
         return $related_model->count($query_params, $field_to_count, $distinct);
2437 2437
     }
2438 2438
 
@@ -2465,7 +2465,7 @@  discard block
 block discarded – undo
2465 2465
         }
2466 2466
         $this_model_name = $this->get_this_model_name();
2467 2467
         $this_pk_field_name = $this->get_primary_key_field()->get_name();
2468
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2468
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
2469 2469
         return $related_model->sum($query_params, $field_to_sum);
2470 2470
     }
2471 2471
 
@@ -2552,7 +2552,7 @@  discard block
 block discarded – undo
2552 2552
          * @param array    $fields_n_values keys are the fields and values are their new values
2553 2553
          * @param EEM_Base $model           the model used
2554 2554
          */
2555
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2555
+        $field_n_values = (array) apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2556 2556
         if ($this->_satisfies_unique_indexes($field_n_values)) {
2557 2557
             $main_table = $this->_get_main_table();
2558 2558
             $new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
@@ -2660,7 +2660,7 @@  discard block
 block discarded – undo
2660 2660
         }
2661 2661
         foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2662 2662
             $uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2663
-            $query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2663
+            $query_params[0]['OR']['AND*'.$unique_index_name] = $uniqueness_where_params;
2664 2664
         }
2665 2665
         //if there is nothing to base this search on, then we shouldn't find anything
2666 2666
         if (empty($query_params)) {
@@ -2740,7 +2740,7 @@  discard block
 block discarded – undo
2740 2740
             //its not the main table, so we should have already saved the main table's PK which we just inserted
2741 2741
             //so add the fk to the main table as a column
2742 2742
             $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2743
-            $format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2743
+            $format_for_insertion[] = '%d'; //yes right now we're only allowing these foreign keys to be INTs
2744 2744
         }
2745 2745
         //insert the new entry
2746 2746
         $result = $this->_do_wpdb_query('insert',
@@ -3000,7 +3000,7 @@  discard block
 block discarded – undo
3000 3000
         $query_param_type
3001 3001
     ) {
3002 3002
         if ( ! empty($sub_query_params)) {
3003
-            $sub_query_params = (array)$sub_query_params;
3003
+            $sub_query_params = (array) $sub_query_params;
3004 3004
             foreach ($sub_query_params as $param => $possibly_array_of_params) {
3005 3005
                 //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3006 3006
                 $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
@@ -3171,12 +3171,12 @@  discard block
 block discarded – undo
3171 3171
                         ),
3172 3172
                         http_build_query($query_params['limit'])
3173 3173
                     );
3174
-                    throw new EE_Error($e . "|" . $e);
3174
+                    throw new EE_Error($e."|".$e);
3175 3175
                 }
3176 3176
                 //they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3177
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3177
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit'][0].",".$query_params['limit'][1]);
3178 3178
             } elseif ( ! empty ($query_params['limit'])) {
3179
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3179
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit']);
3180 3180
             }
3181 3181
         }
3182 3182
         //set order by
@@ -3208,9 +3208,9 @@  discard block
 block discarded – undo
3208 3208
                 $order_array = array();
3209 3209
                 foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3210 3210
                     $order = $this->_extract_order($order);
3211
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3211
+                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by).SP.$order;
3212 3212
                 }
3213
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3213
+                $query_object->set_order_by_sql(" ORDER BY ".implode(",", $order_array));
3214 3214
             } elseif ( ! empty ($query_params['order_by'])) {
3215 3215
                 $this->_extract_related_model_info_from_query_param(
3216 3216
                     $query_params['order_by'],
@@ -3222,7 +3222,7 @@  discard block
 block discarded – undo
3222 3222
                     ? $this->_extract_order($query_params['order'])
3223 3223
                     : 'DESC';
3224 3224
                 $query_object->set_order_by_sql(
3225
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3225
+                    " ORDER BY ".$this->_deduce_column_name_from_query_param($query_params['order_by']).SP.$order
3226 3226
                 );
3227 3227
             }
3228 3228
         }
@@ -3233,7 +3233,7 @@  discard block
 block discarded – undo
3233 3233
         ) {
3234 3234
             $pk_field = $this->get_primary_key_field();
3235 3235
             $order = $this->_extract_order($query_params['order']);
3236
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3236
+            $query_object->set_order_by_sql(" ORDER BY ".$pk_field->get_qualified_column().SP.$order);
3237 3237
         }
3238 3238
         //set group by
3239 3239
         if (array_key_exists('group_by', $query_params)) {
@@ -3243,10 +3243,10 @@  discard block
 block discarded – undo
3243 3243
                 foreach ($query_params['group_by'] as $field_name_to_group_by) {
3244 3244
                     $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3245 3245
                 }
3246
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3246
+                $query_object->set_group_by_sql(" GROUP BY ".implode(", ", $group_by_array));
3247 3247
             } elseif ( ! empty ($query_params['group_by'])) {
3248 3248
                 $query_object->set_group_by_sql(
3249
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3249
+                    " GROUP BY ".$this->_deduce_column_name_from_query_param($query_params['group_by'])
3250 3250
                 );
3251 3251
             }
3252 3252
         }
@@ -3409,7 +3409,7 @@  discard block
 block discarded – undo
3409 3409
     ) {
3410 3410
         $null_friendly_where_conditions = array();
3411 3411
         $none_overridden = true;
3412
-        $or_condition_key_for_defaults = 'OR*' . get_class($model);
3412
+        $or_condition_key_for_defaults = 'OR*'.get_class($model);
3413 3413
         foreach ($default_where_conditions as $key => $val) {
3414 3414
             if (isset($provided_where_conditions[$key])) {
3415 3415
                 $none_overridden = false;
@@ -3613,9 +3613,9 @@  discard block
 block discarded – undo
3613 3613
         //and
3614 3614
         //check if it's a field on a related model
3615 3615
         foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3616
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3616
+            if (strpos($query_param, $valid_related_model_name.".") === 0) {
3617 3617
                 $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3618
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
3618
+                $query_param = substr($query_param, strlen($valid_related_model_name."."));
3619 3619
                 if ($query_param === '') {
3620 3620
                     //nothing left to $query_param
3621 3621
                     //we should actually end in a field name, not a model like this!
@@ -3701,7 +3701,7 @@  discard block
 block discarded – undo
3701 3701
     {
3702 3702
         $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
3703 3703
         if ($SQL) {
3704
-            return " WHERE " . $SQL;
3704
+            return " WHERE ".$SQL;
3705 3705
         } else {
3706 3706
             return '';
3707 3707
         }
@@ -3721,7 +3721,7 @@  discard block
 block discarded – undo
3721 3721
     {
3722 3722
         $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
3723 3723
         if ($SQL) {
3724
-            return " HAVING " . $SQL;
3724
+            return " HAVING ".$SQL;
3725 3725
         } else {
3726 3726
             return '';
3727 3727
         }
@@ -3741,11 +3741,11 @@  discard block
 block discarded – undo
3741 3741
      */
3742 3742
     protected function _get_field_on_model($field_name, $model_name)
3743 3743
     {
3744
-        $model_class = 'EEM_' . $model_name;
3745
-        $model_filepath = $model_class . ".model.php";
3744
+        $model_class = 'EEM_'.$model_name;
3745
+        $model_filepath = $model_class.".model.php";
3746 3746
         if (is_readable($model_filepath)) {
3747 3747
             require_once($model_filepath);
3748
-            $model_instance = call_user_func($model_name . "::instance");
3748
+            $model_instance = call_user_func($model_name."::instance");
3749 3749
             /* @var $model_instance EEM_Base */
3750 3750
             return $model_instance->field_settings_for($field_name);
3751 3751
         } else {
@@ -3769,7 +3769,7 @@  discard block
 block discarded – undo
3769 3769
     {
3770 3770
         $where_clauses = array();
3771 3771
         foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
3772
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
3772
+            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param); //str_replace("*",'',$query_param);
3773 3773
             if (in_array($query_param, $this->_logic_query_param_keys)) {
3774 3774
                 switch ($query_param) {
3775 3775
                     case 'not':
@@ -3806,7 +3806,7 @@  discard block
 block discarded – undo
3806 3806
                     }
3807 3807
                 }
3808 3808
                 $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
3809
-                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
3809
+                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param).SP.$op_and_value_sql;
3810 3810
             }
3811 3811
         }
3812 3812
         return $where_clauses ? implode($glue, $where_clauses) : '';
@@ -3827,7 +3827,7 @@  discard block
 block discarded – undo
3827 3827
         if ($field) {
3828 3828
             $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
3829 3829
                 $query_param);
3830
-            return $table_alias_prefix . $field->get_qualified_column();
3830
+            return $table_alias_prefix.$field->get_qualified_column();
3831 3831
         } elseif (array_key_exists($query_param, $this->_custom_selections)) {
3832 3832
             //maybe it's custom selection item?
3833 3833
             //if so, just use it as the "column name"
@@ -3896,13 +3896,13 @@  discard block
 block discarded – undo
3896 3896
         }
3897 3897
         //check to see if the value is actually another field
3898 3898
         if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
3899
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
3899
+            return $operator.SP.$this->_deduce_column_name_from_query_param($value);
3900 3900
         } elseif (in_array($operator, $this->_in_style_operators) && is_array($value)) {
3901 3901
             //in this case, the value should be an array, or at least a comma-separated list
3902 3902
             //it will need to handle a little differently
3903 3903
             $cleaned_value = $this->_construct_in_value($value, $field_obj);
3904 3904
             //note: $cleaned_value has already been run through $wpdb->prepare()
3905
-            return $operator . SP . $cleaned_value;
3905
+            return $operator.SP.$cleaned_value;
3906 3906
         } elseif (in_array($operator, $this->_between_style_operators) && is_array($value)) {
3907 3907
             //the value should be an array with count of two.
3908 3908
             if (count($value) !== 2) {
@@ -3917,7 +3917,7 @@  discard block
 block discarded – undo
3917 3917
                 );
3918 3918
             }
3919 3919
             $cleaned_value = $this->_construct_between_value($value, $field_obj);
3920
-            return $operator . SP . $cleaned_value;
3920
+            return $operator.SP.$cleaned_value;
3921 3921
         } elseif (in_array($operator, $this->_null_style_operators)) {
3922 3922
             if ($value !== null) {
3923 3923
                 throw new EE_Error(
@@ -3935,9 +3935,9 @@  discard block
 block discarded – undo
3935 3935
         } elseif ($operator === 'LIKE' && ! is_array($value)) {
3936 3936
             //if the operator is 'LIKE', we want to allow percent signs (%) and not
3937 3937
             //remove other junk. So just treat it as a string.
3938
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
3938
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, '%s');
3939 3939
         } elseif ( ! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
3940
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
3940
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, $field_obj);
3941 3941
         } elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
3942 3942
             throw new EE_Error(
3943 3943
                 sprintf(
@@ -3990,7 +3990,7 @@  discard block
 block discarded – undo
3990 3990
         foreach ($values as $value) {
3991 3991
             $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
3992 3992
         }
3993
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
3993
+        return $cleaned_values[0]." AND ".$cleaned_values[1];
3994 3994
     }
3995 3995
 
3996 3996
 
@@ -4031,7 +4031,7 @@  discard block
 block discarded – undo
4031 4031
                                 . $main_table->get_table_name()
4032 4032
                                 . " WHERE FALSE";
4033 4033
         }
4034
-        return "(" . implode(",", $cleaned_values) . ")";
4034
+        return "(".implode(",", $cleaned_values).")";
4035 4035
     }
4036 4036
 
4037 4037
 
@@ -4134,11 +4134,11 @@  discard block
 block discarded – undo
4134 4134
             if ($table_obj instanceof EE_Primary_Table) {
4135 4135
                 $SQL .= $table_alias === $table_obj->get_table_alias()
4136 4136
                     ? $table_obj->get_select_join_limit($limit)
4137
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4137
+                    : SP.$table_obj->get_table_name()." AS ".$table_obj->get_table_alias().SP;
4138 4138
             } elseif ($table_obj instanceof EE_Secondary_Table) {
4139 4139
                 $SQL .= $table_alias === $table_obj->get_table_alias()
4140 4140
                     ? $table_obj->get_select_join_limit_join($limit)
4141
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
4141
+                    : SP.$table_obj->get_join_sql($table_alias).SP;
4142 4142
             }
4143 4143
         }
4144 4144
         return $SQL;
@@ -4226,12 +4226,12 @@  discard block
 block discarded – undo
4226 4226
      */
4227 4227
     public function get_related_model_obj($model_name)
4228 4228
     {
4229
-        $model_classname = "EEM_" . $model_name;
4229
+        $model_classname = "EEM_".$model_name;
4230 4230
         if ( ! class_exists($model_classname)) {
4231 4231
             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",
4232 4232
                 'event_espresso'), $model_name, $model_classname));
4233 4233
         }
4234
-        return call_user_func($model_classname . "::instance");
4234
+        return call_user_func($model_classname."::instance");
4235 4235
     }
4236 4236
 
4237 4237
 
@@ -4530,7 +4530,7 @@  discard block
 block discarded – undo
4530 4530
         $count_if_model_has_no_primary_key = 0;
4531 4531
         $has_primary_key = $this->has_primary_key_field();
4532 4532
         $primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4533
-        foreach ((array)$rows as $row) {
4533
+        foreach ((array) $rows as $row) {
4534 4534
             if (empty($row)) {
4535 4535
                 //wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4536 4536
                 return array();
@@ -4893,7 +4893,7 @@  discard block
 block discarded – undo
4893 4893
      */
4894 4894
     private function _get_class_name()
4895 4895
     {
4896
-        return "EE_" . $this->get_this_model_name();
4896
+        return "EE_".$this->get_this_model_name();
4897 4897
     }
4898 4898
 
4899 4899
 
@@ -4908,7 +4908,7 @@  discard block
 block discarded – undo
4908 4908
      */
4909 4909
     public function item_name($quantity = 1)
4910 4910
     {
4911
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
4911
+        return (int) $quantity === 1 ? $this->singular_item : $this->plural_item;
4912 4912
     }
4913 4913
 
4914 4914
 
@@ -5444,7 +5444,7 @@  discard block
 block discarded – undo
5444 5444
         $cap_restrictions = $this->cap_restrictions($context);
5445 5445
         foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5446 5446
             if ( ! EE_Capabilities::instance()
5447
-                                  ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5447
+                                  ->current_user_can($cap, $this->get_this_model_name().'_model_applying_caps')
5448 5448
             ) {
5449 5449
                 $missing_caps[$cap] = $restriction_if_no_cap;
5450 5450
             }
Please login to merge, or discard this patch.
core/EE_System.core.php 2 patches
Spacing   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -175,7 +175,7 @@  discard block
 block discarded – undo
175 175
     {
176 176
         // set autoloaders for all of the classes implementing EEI_Plugin_API
177 177
         // which provide helpers for EE plugin authors to more easily register certain components with EE.
178
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
178
+        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'plugin_api');
179 179
         //load and setup EE_Capabilities
180 180
         $this->registry->load_core('Capabilities');
181 181
         //caps need to be initialized on every request so that capability maps are set.
@@ -198,7 +198,7 @@  discard block
 block discarded – undo
198 198
                 && $_GET['activate'] === 'true'
199 199
             )
200 200
         ) {
201
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
201
+            include_once EE_THIRD_PARTY.'wp-api-basic-auth'.DS.'basic-auth.php';
202 202
         }
203 203
     }
204 204
 
@@ -621,7 +621,7 @@  discard block
 block discarded – undo
621 621
     private function _parse_model_names()
622 622
     {
623 623
         //get all the files in the EE_MODELS folder that end in .model.php
624
-        $models = glob(EE_MODELS . '*.model.php');
624
+        $models = glob(EE_MODELS.'*.model.php');
625 625
         $model_names = array();
626 626
         $non_abstract_db_models = array();
627 627
         foreach ($models as $model) {
@@ -649,8 +649,8 @@  discard block
 block discarded – undo
649 649
      */
650 650
     private function _maybe_brew_regular()
651 651
     {
652
-        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
653
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
652
+        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH.'brewing_regular.php')) {
653
+            require_once EE_CAFF_PATH.'brewing_regular.php';
654 654
         }
655 655
     }
656 656
 
@@ -691,8 +691,8 @@  discard block
 block discarded – undo
691 691
                 'event_espresso');
692 692
             $msg .= '<ul>';
693 693
             foreach ($class_names as $class_name) {
694
-                $msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
695
-                        $class_name) . '</b></li>';
694
+                $msg .= '<li><b>Event Espresso - '.str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
695
+                        $class_name).'</b></li>';
696 696
             }
697 697
             $msg .= '</ul>';
698 698
             $msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
@@ -987,7 +987,7 @@  discard block
 block discarded – undo
987 987
             'href'  => $events_admin_url,
988 988
             'meta'  => array(
989 989
                 'title' => __('Event Espresso', 'event_espresso'),
990
-                'class' => $menu_class . 'first',
990
+                'class' => $menu_class.'first',
991 991
             ),
992 992
         ));
993 993
         //Events
@@ -1364,10 +1364,10 @@  discard block
 block discarded – undo
1364 1364
             // jquery_validate loading is turned OFF by default, but prior to the wp_enqueue_scripts hook, can be turned back on again via:  add_filter( 'FHEE_load_jquery_validate', '__return_true' );
1365 1365
             if (apply_filters('FHEE_load_jquery_validate', false)) {
1366 1366
                 // register jQuery Validate and additional methods
1367
-                wp_register_script('jquery-validate', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
1367
+                wp_register_script('jquery-validate', EE_GLOBAL_ASSETS_URL.'scripts/jquery.validate.min.js',
1368 1368
                     array('jquery'), '1.15.0', true);
1369 1369
                 wp_register_script('jquery-validate-extra-methods',
1370
-                    EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
1370
+                    EE_GLOBAL_ASSETS_URL.'scripts/jquery.validate.additional-methods.min.js',
1371 1371
                     array('jquery', 'jquery-validate'), '1.15.0', true);
1372 1372
             }
1373 1373
         }
Please login to merge, or discard this patch.
Indentation   +1420 added lines, -1420 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@  discard block
 block discarded – undo
1 1
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
2
-    exit('No direct script access allowed');
2
+	exit('No direct script access allowed');
3 3
 }
4 4
 
5 5
 
@@ -16,1429 +16,1429 @@  discard block
 block discarded – undo
16 16
 {
17 17
 
18 18
 
19
-    /**
20
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
21
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
22
-     */
23
-    const req_type_normal = 0;
24
-
25
-    /**
26
-     * Indicates this is a brand new installation of EE so we should install
27
-     * tables and default data etc
28
-     */
29
-    const req_type_new_activation = 1;
30
-
31
-    /**
32
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
33
-     * and we just exited maintenance mode). We MUST check the database is setup properly
34
-     * and that default data is setup too
35
-     */
36
-    const req_type_reactivation = 2;
37
-
38
-    /**
39
-     * indicates that EE has been upgraded since its previous request.
40
-     * We may have data migration scripts to call and will want to trigger maintenance mode
41
-     */
42
-    const req_type_upgrade = 3;
43
-
44
-    /**
45
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
46
-     */
47
-    const req_type_downgrade = 4;
48
-
49
-    /**
50
-     * @deprecated since version 4.6.0.dev.006
51
-     * Now whenever a new_activation is detected the request type is still just
52
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
53
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
54
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
55
-     * (Specifically, when the migration manager indicates migrations are finished
56
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
57
-     */
58
-    const req_type_activation_but_not_installed = 5;
59
-
60
-    /**
61
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
62
-     */
63
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
64
-
65
-
66
-    /**
67
-     *    instance of the EE_System object
68
-     *
69
-     * @var    $_instance
70
-     * @access    private
71
-     */
72
-    private static $_instance = null;
73
-
74
-    /**
75
-     * @type  EE_Registry $Registry
76
-     * @access    protected
77
-     */
78
-    protected $registry;
79
-
80
-    /**
81
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
82
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
83
-     *
84
-     * @var int
85
-     */
86
-    private $_req_type;
87
-
88
-    /**
89
-     * Whether or not there was a non-micro version change in EE core version during this request
90
-     *
91
-     * @var boolean
92
-     */
93
-    private $_major_version_change = false;
94
-
95
-
96
-
97
-    /**
98
-     * @singleton method used to instantiate class object
99
-     * @access    public
100
-     * @param  \EE_Registry $Registry
101
-     * @return \EE_System
102
-     */
103
-    public static function instance(EE_Registry $Registry = null)
104
-    {
105
-        // check if class object is instantiated
106
-        if ( ! self::$_instance instanceof EE_System) {
107
-            self::$_instance = new self($Registry);
108
-        }
109
-        return self::$_instance;
110
-    }
111
-
112
-
113
-
114
-    /**
115
-     * resets the instance and returns it
116
-     *
117
-     * @return EE_System
118
-     */
119
-    public static function reset()
120
-    {
121
-        self::$_instance->_req_type = null;
122
-        //make sure none of the old hooks are left hanging around
123
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
124
-        //we need to reset the migration manager in order for it to detect DMSs properly
125
-        EE_Data_Migration_Manager::reset();
126
-        self::instance()->detect_activations_or_upgrades();
127
-        self::instance()->perform_activations_upgrades_and_migrations();
128
-        return self::instance();
129
-    }
130
-
131
-
132
-
133
-    /**
134
-     *    sets hooks for running rest of system
135
-     *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
136
-     *    starting EE Addons from any other point may lead to problems
137
-     *
138
-     * @access private
139
-     * @param  \EE_Registry $Registry
140
-     */
141
-    private function __construct(EE_Registry $Registry)
142
-    {
143
-        $this->registry = $Registry;
144
-        do_action('AHEE__EE_System__construct__begin', $this);
145
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
146
-        add_action('AHEE__EE_Bootstrap__load_espresso_addons', array($this, 'load_espresso_addons'));
147
-        // when an ee addon is activated, we want to call the core hook(s) again
148
-        // because the newly-activated addon didn't get a chance to run at all
149
-        add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
150
-        // detect whether install or upgrade
151
-        add_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades', array($this, 'detect_activations_or_upgrades'),
152
-            3);
153
-        // load EE_Config, EE_Textdomain, etc
154
-        add_action('AHEE__EE_Bootstrap__load_core_configuration', array($this, 'load_core_configuration'), 5);
155
-        // load EE_Config, EE_Textdomain, etc
156
-        add_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
157
-            array($this, 'register_shortcodes_modules_and_widgets'), 7);
158
-        // you wanna get going? I wanna get going... let's get going!
159
-        add_action('AHEE__EE_Bootstrap__brew_espresso', array($this, 'brew_espresso'), 9);
160
-        //other housekeeping
161
-        //exclude EE critical pages from wp_list_pages
162
-        add_filter('wp_list_pages_excludes', array($this, 'remove_pages_from_wp_list_pages'), 10);
163
-        // ALL EE Addons should use the following hook point to attach their initial setup too
164
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
165
-        do_action('AHEE__EE_System__construct__complete', $this);
166
-    }
167
-
168
-
169
-
170
-    /**
171
-     * load_espresso_addons
172
-     * allow addons to load first so that they can set hooks for running DMS's, etc
173
-     * this is hooked into both:
174
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
175
-     *        which runs during the WP 'plugins_loaded' action at priority 5
176
-     *    and the WP 'activate_plugin' hookpoint
177
-     *
178
-     * @access public
179
-     * @return void
180
-     */
181
-    public function load_espresso_addons()
182
-    {
183
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
184
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
185
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
186
-        //load and setup EE_Capabilities
187
-        $this->registry->load_core('Capabilities');
188
-        //caps need to be initialized on every request so that capability maps are set.
189
-        //@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
190
-        $this->registry->CAP->init_caps();
191
-        do_action('AHEE__EE_System__load_espresso_addons');
192
-        //if the WP API basic auth plugin isn't already loaded, load it now.
193
-        //We want it for mobile apps. Just include the entire plugin
194
-        //also, don't load the basic auth when a plugin is getting activated, because
195
-        //it could be the basic auth plugin, and it doesn't check if its methods are already defined
196
-        //and causes a fatal error
197
-        if ( ! function_exists('json_basic_auth_handler')
198
-             && ! function_exists('json_basic_auth_error')
199
-             && ! (
200
-                isset($_GET['action'])
201
-                && in_array($_GET['action'], array('activate', 'activate-selected'))
202
-            )
203
-             && ! (
204
-                isset($_GET['activate'])
205
-                && $_GET['activate'] === 'true'
206
-            )
207
-        ) {
208
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
209
-        }
19
+	/**
20
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
21
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
22
+	 */
23
+	const req_type_normal = 0;
24
+
25
+	/**
26
+	 * Indicates this is a brand new installation of EE so we should install
27
+	 * tables and default data etc
28
+	 */
29
+	const req_type_new_activation = 1;
30
+
31
+	/**
32
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
33
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
34
+	 * and that default data is setup too
35
+	 */
36
+	const req_type_reactivation = 2;
37
+
38
+	/**
39
+	 * indicates that EE has been upgraded since its previous request.
40
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
41
+	 */
42
+	const req_type_upgrade = 3;
43
+
44
+	/**
45
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
46
+	 */
47
+	const req_type_downgrade = 4;
48
+
49
+	/**
50
+	 * @deprecated since version 4.6.0.dev.006
51
+	 * Now whenever a new_activation is detected the request type is still just
52
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
53
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
54
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
55
+	 * (Specifically, when the migration manager indicates migrations are finished
56
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
57
+	 */
58
+	const req_type_activation_but_not_installed = 5;
59
+
60
+	/**
61
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
62
+	 */
63
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
64
+
65
+
66
+	/**
67
+	 *    instance of the EE_System object
68
+	 *
69
+	 * @var    $_instance
70
+	 * @access    private
71
+	 */
72
+	private static $_instance = null;
73
+
74
+	/**
75
+	 * @type  EE_Registry $Registry
76
+	 * @access    protected
77
+	 */
78
+	protected $registry;
79
+
80
+	/**
81
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
82
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
83
+	 *
84
+	 * @var int
85
+	 */
86
+	private $_req_type;
87
+
88
+	/**
89
+	 * Whether or not there was a non-micro version change in EE core version during this request
90
+	 *
91
+	 * @var boolean
92
+	 */
93
+	private $_major_version_change = false;
94
+
95
+
96
+
97
+	/**
98
+	 * @singleton method used to instantiate class object
99
+	 * @access    public
100
+	 * @param  \EE_Registry $Registry
101
+	 * @return \EE_System
102
+	 */
103
+	public static function instance(EE_Registry $Registry = null)
104
+	{
105
+		// check if class object is instantiated
106
+		if ( ! self::$_instance instanceof EE_System) {
107
+			self::$_instance = new self($Registry);
108
+		}
109
+		return self::$_instance;
110
+	}
111
+
112
+
113
+
114
+	/**
115
+	 * resets the instance and returns it
116
+	 *
117
+	 * @return EE_System
118
+	 */
119
+	public static function reset()
120
+	{
121
+		self::$_instance->_req_type = null;
122
+		//make sure none of the old hooks are left hanging around
123
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
124
+		//we need to reset the migration manager in order for it to detect DMSs properly
125
+		EE_Data_Migration_Manager::reset();
126
+		self::instance()->detect_activations_or_upgrades();
127
+		self::instance()->perform_activations_upgrades_and_migrations();
128
+		return self::instance();
129
+	}
130
+
131
+
132
+
133
+	/**
134
+	 *    sets hooks for running rest of system
135
+	 *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
136
+	 *    starting EE Addons from any other point may lead to problems
137
+	 *
138
+	 * @access private
139
+	 * @param  \EE_Registry $Registry
140
+	 */
141
+	private function __construct(EE_Registry $Registry)
142
+	{
143
+		$this->registry = $Registry;
144
+		do_action('AHEE__EE_System__construct__begin', $this);
145
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
146
+		add_action('AHEE__EE_Bootstrap__load_espresso_addons', array($this, 'load_espresso_addons'));
147
+		// when an ee addon is activated, we want to call the core hook(s) again
148
+		// because the newly-activated addon didn't get a chance to run at all
149
+		add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
150
+		// detect whether install or upgrade
151
+		add_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades', array($this, 'detect_activations_or_upgrades'),
152
+			3);
153
+		// load EE_Config, EE_Textdomain, etc
154
+		add_action('AHEE__EE_Bootstrap__load_core_configuration', array($this, 'load_core_configuration'), 5);
155
+		// load EE_Config, EE_Textdomain, etc
156
+		add_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
157
+			array($this, 'register_shortcodes_modules_and_widgets'), 7);
158
+		// you wanna get going? I wanna get going... let's get going!
159
+		add_action('AHEE__EE_Bootstrap__brew_espresso', array($this, 'brew_espresso'), 9);
160
+		//other housekeeping
161
+		//exclude EE critical pages from wp_list_pages
162
+		add_filter('wp_list_pages_excludes', array($this, 'remove_pages_from_wp_list_pages'), 10);
163
+		// ALL EE Addons should use the following hook point to attach their initial setup too
164
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
165
+		do_action('AHEE__EE_System__construct__complete', $this);
166
+	}
167
+
168
+
169
+
170
+	/**
171
+	 * load_espresso_addons
172
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
173
+	 * this is hooked into both:
174
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
175
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
176
+	 *    and the WP 'activate_plugin' hookpoint
177
+	 *
178
+	 * @access public
179
+	 * @return void
180
+	 */
181
+	public function load_espresso_addons()
182
+	{
183
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
184
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
185
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
186
+		//load and setup EE_Capabilities
187
+		$this->registry->load_core('Capabilities');
188
+		//caps need to be initialized on every request so that capability maps are set.
189
+		//@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
190
+		$this->registry->CAP->init_caps();
191
+		do_action('AHEE__EE_System__load_espresso_addons');
192
+		//if the WP API basic auth plugin isn't already loaded, load it now.
193
+		//We want it for mobile apps. Just include the entire plugin
194
+		//also, don't load the basic auth when a plugin is getting activated, because
195
+		//it could be the basic auth plugin, and it doesn't check if its methods are already defined
196
+		//and causes a fatal error
197
+		if ( ! function_exists('json_basic_auth_handler')
198
+			 && ! function_exists('json_basic_auth_error')
199
+			 && ! (
200
+				isset($_GET['action'])
201
+				&& in_array($_GET['action'], array('activate', 'activate-selected'))
202
+			)
203
+			 && ! (
204
+				isset($_GET['activate'])
205
+				&& $_GET['activate'] === 'true'
206
+			)
207
+		) {
208
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
209
+		}
210 210
         
211
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
212
-    }
213
-
214
-
215
-
216
-    /**
217
-     * detect_activations_or_upgrades
218
-     * Checks for activation or upgrade of core first;
219
-     * then also checks if any registered addons have been activated or upgraded
220
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
221
-     * which runs during the WP 'plugins_loaded' action at priority 3
222
-     *
223
-     * @access public
224
-     * @return void
225
-     */
226
-    public function detect_activations_or_upgrades()
227
-    {
228
-        //first off: let's make sure to handle core
229
-        $this->detect_if_activation_or_upgrade();
230
-        foreach ($this->registry->addons as $addon) {
231
-            //detect teh request type for that addon
232
-            $addon->detect_activation_or_upgrade();
233
-        }
234
-    }
235
-
236
-
237
-
238
-    /**
239
-     * detect_if_activation_or_upgrade
240
-     * Takes care of detecting whether this is a brand new install or code upgrade,
241
-     * and either setting up the DB or setting up maintenance mode etc.
242
-     *
243
-     * @access public
244
-     * @return void
245
-     */
246
-    public function detect_if_activation_or_upgrade()
247
-    {
248
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
249
-        // load M-Mode class
250
-        $this->registry->load_core('Maintenance_Mode');
251
-        // check if db has been updated, or if its a brand-new installation
252
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
253
-        $request_type = $this->detect_req_type($espresso_db_update);
254
-        //EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
255
-        switch ($request_type) {
256
-            case EE_System::req_type_new_activation:
257
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
258
-                $this->_handle_core_version_change($espresso_db_update);
259
-                break;
260
-            case EE_System::req_type_reactivation:
261
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
262
-                $this->_handle_core_version_change($espresso_db_update);
263
-                break;
264
-            case EE_System::req_type_upgrade:
265
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
266
-                //migrations may be required now that we've upgraded
267
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
268
-                $this->_handle_core_version_change($espresso_db_update);
211
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
212
+	}
213
+
214
+
215
+
216
+	/**
217
+	 * detect_activations_or_upgrades
218
+	 * Checks for activation or upgrade of core first;
219
+	 * then also checks if any registered addons have been activated or upgraded
220
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
221
+	 * which runs during the WP 'plugins_loaded' action at priority 3
222
+	 *
223
+	 * @access public
224
+	 * @return void
225
+	 */
226
+	public function detect_activations_or_upgrades()
227
+	{
228
+		//first off: let's make sure to handle core
229
+		$this->detect_if_activation_or_upgrade();
230
+		foreach ($this->registry->addons as $addon) {
231
+			//detect teh request type for that addon
232
+			$addon->detect_activation_or_upgrade();
233
+		}
234
+	}
235
+
236
+
237
+
238
+	/**
239
+	 * detect_if_activation_or_upgrade
240
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
241
+	 * and either setting up the DB or setting up maintenance mode etc.
242
+	 *
243
+	 * @access public
244
+	 * @return void
245
+	 */
246
+	public function detect_if_activation_or_upgrade()
247
+	{
248
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
249
+		// load M-Mode class
250
+		$this->registry->load_core('Maintenance_Mode');
251
+		// check if db has been updated, or if its a brand-new installation
252
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
253
+		$request_type = $this->detect_req_type($espresso_db_update);
254
+		//EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
255
+		switch ($request_type) {
256
+			case EE_System::req_type_new_activation:
257
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
258
+				$this->_handle_core_version_change($espresso_db_update);
259
+				break;
260
+			case EE_System::req_type_reactivation:
261
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
262
+				$this->_handle_core_version_change($espresso_db_update);
263
+				break;
264
+			case EE_System::req_type_upgrade:
265
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
266
+				//migrations may be required now that we've upgraded
267
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
268
+				$this->_handle_core_version_change($espresso_db_update);
269 269
 //				echo "done upgrade";die;
270
-                break;
271
-            case EE_System::req_type_downgrade:
272
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
273
-                //its possible migrations are no longer required
274
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
275
-                $this->_handle_core_version_change($espresso_db_update);
276
-                break;
277
-            case EE_System::req_type_normal:
278
-            default:
270
+				break;
271
+			case EE_System::req_type_downgrade:
272
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
273
+				//its possible migrations are no longer required
274
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
275
+				$this->_handle_core_version_change($espresso_db_update);
276
+				break;
277
+			case EE_System::req_type_normal:
278
+			default:
279 279
 //				$this->_maybe_redirect_to_ee_about();
280
-                break;
281
-        }
282
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
283
-    }
284
-
285
-
286
-
287
-    /**
288
-     * Updates the list of installed versions and sets hooks for
289
-     * initializing the database later during the request
290
-     *
291
-     * @param array $espresso_db_update
292
-     */
293
-    protected function _handle_core_version_change($espresso_db_update)
294
-    {
295
-        $this->update_list_of_installed_versions($espresso_db_update);
296
-        //get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
297
-        add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
298
-            array($this, 'initialize_db_if_no_migrations_required'));
299
-    }
300
-
301
-
302
-
303
-    /**
304
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
305
-     * information about what versions of EE have been installed and activated,
306
-     * NOT necessarily the state of the database
307
-     *
308
-     * @param null $espresso_db_update
309
-     * @internal param array $espresso_db_update_value the value of the WordPress option. If not supplied, fetches it
310
-     *           from the options table
311
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
312
-     */
313
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null)
314
-    {
315
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
316
-        if ( ! $espresso_db_update) {
317
-            $espresso_db_update = get_option('espresso_db_update');
318
-        }
319
-        // check that option is an array
320
-        if ( ! is_array($espresso_db_update)) {
321
-            // if option is FALSE, then it never existed
322
-            if ($espresso_db_update === false) {
323
-                // make $espresso_db_update an array and save option with autoload OFF
324
-                $espresso_db_update = array();
325
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
326
-            } else {
327
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
328
-                $espresso_db_update = array($espresso_db_update => array());
329
-                update_option('espresso_db_update', $espresso_db_update);
330
-            }
331
-        } else {
332
-            $corrected_db_update = array();
333
-            //if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
334
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
335
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
336
-                    //the key is an int, and the value IS NOT an array
337
-                    //so it must be numerically-indexed, where values are versions installed...
338
-                    //fix it!
339
-                    $version_string = $should_be_array;
340
-                    $corrected_db_update[$version_string] = array('unknown-date');
341
-                } else {
342
-                    //ok it checks out
343
-                    $corrected_db_update[$should_be_version_string] = $should_be_array;
344
-                }
345
-            }
346
-            $espresso_db_update = $corrected_db_update;
347
-            update_option('espresso_db_update', $espresso_db_update);
348
-        }
349
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
350
-        return $espresso_db_update;
351
-    }
352
-
353
-
354
-
355
-    /**
356
-     * Does the traditional work of setting up the plugin's database and adding default data.
357
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
358
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
359
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
360
-     * so that it will be done when migrations are finished
361
-     *
362
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
363
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
364
-     *                                       This is a resource-intensive job
365
-     *                                       so we prefer to only do it when necessary
366
-     * @return void
367
-     */
368
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
369
-    {
370
-        $request_type = $this->detect_req_type();
371
-        //only initialize system if we're not in maintenance mode.
372
-        if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
373
-            update_option('ee_flush_rewrite_rules', true);
374
-            if ($verify_schema) {
375
-                EEH_Activation::initialize_db_and_folders();
376
-            }
377
-            EEH_Activation::initialize_db_content();
378
-            EEH_Activation::system_initialization();
379
-            if ($initialize_addons_too) {
380
-                $this->initialize_addons();
381
-            }
382
-        } else {
383
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
384
-        }
385
-        if ($request_type === EE_System::req_type_new_activation
386
-            || $request_type === EE_System::req_type_reactivation
387
-            || (
388
-                $request_type === EE_System::req_type_upgrade
389
-                && $this->is_major_version_change()
390
-            )
391
-        ) {
392
-            add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
393
-        }
394
-    }
395
-
396
-
397
-
398
-    /**
399
-     * Initializes the db for all registered addons
400
-     */
401
-    public function initialize_addons()
402
-    {
403
-        //foreach registered addon, make sure its db is up-to-date too
404
-        foreach ($this->registry->addons as $addon) {
405
-            $addon->initialize_db_if_no_migrations_required();
406
-        }
407
-    }
408
-
409
-
410
-
411
-    /**
412
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
413
-     *
414
-     * @param    array  $version_history
415
-     * @param    string $current_version_to_add version to be added to the version history
416
-     * @return    boolean success as to whether or not this option was changed
417
-     */
418
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
419
-    {
420
-        if ( ! $version_history) {
421
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
422
-        }
423
-        if ($current_version_to_add == null) {
424
-            $current_version_to_add = espresso_version();
425
-        }
426
-        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
427
-        // re-save
428
-        return update_option('espresso_db_update', $version_history);
429
-    }
430
-
431
-
432
-
433
-    /**
434
-     * Detects if the current version indicated in the has existed in the list of
435
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
436
-     *
437
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
438
-     *                                  If not supplied, fetches it from the options table.
439
-     *                                  Also, caches its result so later parts of the code can also know whether
440
-     *                                  there's been an update or not. This way we can add the current version to
441
-     *                                  espresso_db_update, but still know if this is a new install or not
442
-     * @return int one of the constants on EE_System::req_type_
443
-     */
444
-    public function detect_req_type($espresso_db_update = null)
445
-    {
446
-        if ($this->_req_type === null) {
447
-            $espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
448
-                : $this->fix_espresso_db_upgrade_option();
449
-            $this->_req_type = $this->detect_req_type_given_activation_history($espresso_db_update,
450
-                'ee_espresso_activation', espresso_version());
451
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
452
-        }
453
-        return $this->_req_type;
454
-    }
455
-
456
-
457
-
458
-    /**
459
-     * Returns whether or not there was a non-micro version change (ie, change in either
460
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
461
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
462
-     *
463
-     * @param $activation_history
464
-     * @return bool
465
-     */
466
-    protected function _detect_major_version_change($activation_history)
467
-    {
468
-        $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
469
-        $previous_version_parts = explode('.', $previous_version);
470
-        $current_version_parts = explode('.', espresso_version());
471
-        return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
472
-               && ($previous_version_parts[0] !== $current_version_parts[0]
473
-                   || $previous_version_parts[1] !== $current_version_parts[1]
474
-               );
475
-    }
476
-
477
-
478
-
479
-    /**
480
-     * Returns true if either the major or minor version of EE changed during this request.
481
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
482
-     *
483
-     * @return bool
484
-     */
485
-    public function is_major_version_change()
486
-    {
487
-        return $this->_major_version_change;
488
-    }
489
-
490
-
491
-
492
-    /**
493
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
494
-     * histories (for core that' 'espresso_db_update' wp option); the name of the wordpress option which is temporarily
495
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
496
-     * just activated to (for core that will always be espresso_version())
497
-     *
498
-     * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
499
-     *                                                 ee plugin. for core that's 'espresso_db_update'
500
-     * @param string $activation_indicator_option_name the name of the wordpress option that is temporarily set to
501
-     *                                                 indicate that this plugin was just activated
502
-     * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
503
-     *                                                 espresso_version())
504
-     * @return int one of the constants on EE_System::req_type_*
505
-     */
506
-    public static function detect_req_type_given_activation_history(
507
-        $activation_history_for_addon,
508
-        $activation_indicator_option_name,
509
-        $version_to_upgrade_to
510
-    ) {
511
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
512
-        if ($activation_history_for_addon) {
513
-            //it exists, so this isn't a completely new install
514
-            //check if this version already in that list of previously installed versions
515
-            if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
516
-                //it a version we haven't seen before
517
-                if ($version_is_higher === 1) {
518
-                    $req_type = EE_System::req_type_upgrade;
519
-                } else {
520
-                    $req_type = EE_System::req_type_downgrade;
521
-                }
522
-                delete_option($activation_indicator_option_name);
523
-            } else {
524
-                // its not an update. maybe a reactivation?
525
-                if (get_option($activation_indicator_option_name, false)) {
526
-                    if ($version_is_higher === -1) {
527
-                        $req_type = EE_System::req_type_downgrade;
528
-                    } elseif ($version_is_higher === 0) {
529
-                        //we've seen this version before, but it's an activation. must be a reactivation
530
-                        $req_type = EE_System::req_type_reactivation;
531
-                    } else {//$version_is_higher === 1
532
-                        $req_type = EE_System::req_type_upgrade;
533
-                    }
534
-                    delete_option($activation_indicator_option_name);
535
-                } else {
536
-                    //we've seen this version before and the activation indicate doesn't show it was just activated
537
-                    if ($version_is_higher === -1) {
538
-                        $req_type = EE_System::req_type_downgrade;
539
-                    } elseif ($version_is_higher === 0) {
540
-                        //we've seen this version before and it's not an activation. its normal request
541
-                        $req_type = EE_System::req_type_normal;
542
-                    } else {//$version_is_higher === 1
543
-                        $req_type = EE_System::req_type_upgrade;
544
-                    }
545
-                }
546
-            }
547
-        } else {
548
-            //brand new install
549
-            $req_type = EE_System::req_type_new_activation;
550
-            delete_option($activation_indicator_option_name);
551
-        }
552
-        return $req_type;
553
-    }
554
-
555
-
556
-
557
-    /**
558
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
559
-     * the $activation_history_for_addon
560
-     *
561
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
562
-     *                                             sometimes containing 'unknown-date'
563
-     * @param string $version_to_upgrade_to        (current version)
564
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
565
-     *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
566
-     *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
567
-     *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
568
-     */
569
-    protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
570
-    {
571
-        //find the most recently-activated version
572
-        $most_recently_active_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
573
-        return version_compare($version_to_upgrade_to, $most_recently_active_version);
574
-    }
575
-
576
-
577
-
578
-    /**
579
-     * Gets the most recently active version listed in the activation history,
580
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
581
-     *
582
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
583
-     *                                   sometimes containing 'unknown-date'
584
-     * @return string
585
-     */
586
-    protected static function _get_most_recently_active_version_from_activation_history($activation_history)
587
-    {
588
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
589
-        $most_recently_active_version = '0.0.0.dev.000';
590
-        if (is_array($activation_history)) {
591
-            foreach ($activation_history as $version => $times_activated) {
592
-                //check there is a record of when this version was activated. Otherwise,
593
-                //mark it as unknown
594
-                if ( ! $times_activated) {
595
-                    $times_activated = array('unknown-date');
596
-                }
597
-                if (is_string($times_activated)) {
598
-                    $times_activated = array($times_activated);
599
-                }
600
-                foreach ($times_activated as $an_activation) {
601
-                    if ($an_activation != 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
602
-                        $most_recently_active_version = $version;
603
-                        $most_recently_active_version_activation = $an_activation == 'unknown-date'
604
-                            ? '1970-01-01 00:00:00' : $an_activation;
605
-                    }
606
-                }
607
-            }
608
-        }
609
-        return $most_recently_active_version;
610
-    }
611
-
612
-
613
-
614
-    /**
615
-     * This redirects to the about EE page after activation
616
-     *
617
-     * @return void
618
-     */
619
-    public function redirect_to_about_ee()
620
-    {
621
-        $notices = EE_Error::get_notices(false);
622
-        //if current user is an admin and it's not an ajax or rest request
623
-        if (
624
-            ! (defined('DOING_AJAX') && DOING_AJAX)
625
-            && ! (defined('REST_REQUEST') && REST_REQUEST)
626
-            && ! isset($notices['errors'])
627
-            && apply_filters(
628
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
629
-                $this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
630
-            )
631
-        ) {
632
-            $query_params = array('page' => 'espresso_about');
633
-            if (EE_System::instance()->detect_req_type() == EE_System::req_type_new_activation) {
634
-                $query_params['new_activation'] = true;
635
-            }
636
-            if (EE_System::instance()->detect_req_type() == EE_System::req_type_reactivation) {
637
-                $query_params['reactivation'] = true;
638
-            }
639
-            $url = add_query_arg($query_params, admin_url('admin.php'));
640
-            wp_safe_redirect($url);
641
-            exit();
642
-        }
643
-    }
644
-
645
-
646
-
647
-    /**
648
-     * load_core_configuration
649
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
650
-     * which runs during the WP 'plugins_loaded' action at priority 5
651
-     *
652
-     * @return void
653
-     */
654
-    public function load_core_configuration()
655
-    {
656
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
657
-        $this->registry->load_core('EE_Load_Textdomain');
658
-        //load textdomain
659
-        EE_Load_Textdomain::load_textdomain();
660
-        // load and setup EE_Config and EE_Network_Config
661
-        $this->registry->load_core('Config');
662
-        $this->registry->load_core('Network_Config');
663
-        // setup autoloaders
664
-        // enable logging?
665
-        if ($this->registry->CFG->admin->use_full_logging) {
666
-            $this->registry->load_core('Log');
667
-        }
668
-        // check for activation errors
669
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
670
-        if ($activation_errors) {
671
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
672
-            update_option('ee_plugin_activation_errors', false);
673
-        }
674
-        // get model names
675
-        $this->_parse_model_names();
676
-        //load caf stuff a chance to play during the activation process too.
677
-        $this->_maybe_brew_regular();
678
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
679
-    }
680
-
681
-
682
-
683
-    /**
684
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
685
-     *
686
-     * @return void
687
-     */
688
-    private function _parse_model_names()
689
-    {
690
-        //get all the files in the EE_MODELS folder that end in .model.php
691
-        $models = glob(EE_MODELS . '*.model.php');
692
-        $model_names = array();
693
-        $non_abstract_db_models = array();
694
-        foreach ($models as $model) {
695
-            // get model classname
696
-            $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
697
-            $short_name = str_replace('EEM_', '', $classname);
698
-            $reflectionClass = new ReflectionClass($classname);
699
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
700
-                $non_abstract_db_models[$short_name] = $classname;
701
-            }
702
-            $model_names[$short_name] = $classname;
703
-        }
704
-        $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
705
-        $this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
706
-            $non_abstract_db_models);
707
-    }
708
-
709
-
710
-
711
-    /**
712
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
713
-     * that need to be setup before our EE_System launches.
714
-     *
715
-     * @return void
716
-     */
717
-    private function _maybe_brew_regular()
718
-    {
719
-        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
720
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
721
-        }
722
-    }
723
-
724
-
725
-
726
-    /**
727
-     * register_shortcodes_modules_and_widgets
728
-     * generate lists of shortcodes and modules, then verify paths and classes
729
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
730
-     * which runs during the WP 'plugins_loaded' action at priority 7
731
-     *
732
-     * @access public
733
-     * @return void
734
-     */
735
-    public function register_shortcodes_modules_and_widgets()
736
-    {
737
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
738
-        // check for addons using old hookpoint
739
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
740
-            $this->_incompatible_addon_error();
741
-        }
742
-    }
743
-
744
-
745
-
746
-    /**
747
-     * _incompatible_addon_error
748
-     *
749
-     * @access public
750
-     * @return void
751
-     */
752
-    private function _incompatible_addon_error()
753
-    {
754
-        // get array of classes hooking into here
755
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
756
-        if ( ! empty($class_names)) {
757
-            $msg = __('The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
758
-                'event_espresso');
759
-            $msg .= '<ul>';
760
-            foreach ($class_names as $class_name) {
761
-                $msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
762
-                        $class_name) . '</b></li>';
763
-            }
764
-            $msg .= '</ul>';
765
-            $msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
766
-                'event_espresso');
767
-            // save list of incompatible addons to wp-options for later use
768
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
769
-            if (is_admin()) {
770
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
771
-            }
772
-        }
773
-    }
774
-
775
-
776
-
777
-    /**
778
-     * brew_espresso
779
-     * begins the process of setting hooks for initializing EE in the correct order
780
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hookpoint
781
-     * which runs during the WP 'plugins_loaded' action at priority 9
782
-     *
783
-     * @return void
784
-     */
785
-    public function brew_espresso()
786
-    {
787
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
788
-        // load some final core systems
789
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
790
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
791
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
792
-        add_action('init', array($this, 'load_controllers'), 7);
793
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
794
-        add_action('init', array($this, 'initialize'), 10);
795
-        add_action('init', array($this, 'initialize_last'), 100);
796
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 25);
797
-        add_action('admin_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 25);
798
-        add_action('admin_bar_menu', array($this, 'espresso_toolbar_items'), 100);
799
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
800
-            // pew pew pew
801
-            $this->registry->load_core('PUE');
802
-            do_action('AHEE__EE_System__brew_espresso__after_pue_init');
803
-        }
804
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
805
-    }
806
-
807
-
808
-
809
-    /**
810
-     *    set_hooks_for_core
811
-     *
812
-     * @access public
813
-     * @return    void
814
-     */
815
-    public function set_hooks_for_core()
816
-    {
817
-        $this->_deactivate_incompatible_addons();
818
-        do_action('AHEE__EE_System__set_hooks_for_core');
819
-    }
820
-
821
-
822
-
823
-    /**
824
-     * Using the information gathered in EE_System::_incompatible_addon_error,
825
-     * deactivates any addons considered incompatible with the current version of EE
826
-     */
827
-    private function _deactivate_incompatible_addons()
828
-    {
829
-        $incompatible_addons = get_option('ee_incompatible_addons', array());
830
-        if ( ! empty($incompatible_addons)) {
831
-            $active_plugins = get_option('active_plugins', array());
832
-            foreach ($active_plugins as $active_plugin) {
833
-                foreach ($incompatible_addons as $incompatible_addon) {
834
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
835
-                        unset($_GET['activate']);
836
-                        espresso_deactivate_plugin($active_plugin);
837
-                    }
838
-                }
839
-            }
840
-        }
841
-    }
842
-
843
-
844
-
845
-    /**
846
-     *    perform_activations_upgrades_and_migrations
847
-     *
848
-     * @access public
849
-     * @return    void
850
-     */
851
-    public function perform_activations_upgrades_and_migrations()
852
-    {
853
-        //first check if we had previously attempted to setup EE's directories but failed
854
-        if (EEH_Activation::upload_directories_incomplete()) {
855
-            EEH_Activation::create_upload_directories();
856
-        }
857
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
858
-    }
859
-
860
-
861
-
862
-    /**
863
-     *    load_CPTs_and_session
864
-     *
865
-     * @access public
866
-     * @return    void
867
-     */
868
-    public function load_CPTs_and_session()
869
-    {
870
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
871
-        // register Custom Post Types
872
-        $this->registry->load_core('Register_CPTs');
873
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
874
-    }
875
-
876
-
877
-
878
-    /**
879
-     * load_controllers
880
-     * this is the best place to load any additional controllers that needs access to EE core.
881
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
882
-     * time
883
-     *
884
-     * @access public
885
-     * @return void
886
-     */
887
-    public function load_controllers()
888
-    {
889
-        do_action('AHEE__EE_System__load_controllers__start');
890
-        // let's get it started
891
-        if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
892
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
893
-            $this->registry->load_core('Front_Controller', array(), false, true);
894
-        } else if ( ! EE_FRONT_AJAX) {
895
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
896
-            EE_Registry::instance()->load_core('Admin');
897
-        }
898
-        do_action('AHEE__EE_System__load_controllers__complete');
899
-    }
900
-
901
-
902
-
903
-    /**
904
-     * core_loaded_and_ready
905
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
906
-     *
907
-     * @access public
908
-     * @return void
909
-     */
910
-    public function core_loaded_and_ready()
911
-    {
912
-        do_action('AHEE__EE_System__core_loaded_and_ready');
913
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
914
-        $this->registry->load_core('Session');
915
-        //		add_action( 'wp_loaded', array( $this, 'set_hooks_for_shortcodes_modules_and_addons' ), 1 );
916
-    }
917
-
918
-
919
-
920
-    /**
921
-     * initialize
922
-     * this is the best place to begin initializing client code
923
-     *
924
-     * @access public
925
-     * @return void
926
-     */
927
-    public function initialize()
928
-    {
929
-        do_action('AHEE__EE_System__initialize');
930
-    }
931
-
932
-
933
-
934
-    /**
935
-     * initialize_last
936
-     * this is run really late during the WP init hookpoint, and ensures that mostly everything else that needs to
937
-     * initialize has done so
938
-     *
939
-     * @access public
940
-     * @return void
941
-     */
942
-    public function initialize_last()
943
-    {
944
-        do_action('AHEE__EE_System__initialize_last');
945
-    }
946
-
947
-
948
-
949
-    /**
950
-     * set_hooks_for_shortcodes_modules_and_addons
951
-     * this is the best place for other systems to set callbacks for hooking into other parts of EE
952
-     * this happens at the very beginning of the wp_loaded hookpoint
953
-     *
954
-     * @access public
955
-     * @return void
956
-     */
957
-    public function set_hooks_for_shortcodes_modules_and_addons()
958
-    {
280
+				break;
281
+		}
282
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
283
+	}
284
+
285
+
286
+
287
+	/**
288
+	 * Updates the list of installed versions and sets hooks for
289
+	 * initializing the database later during the request
290
+	 *
291
+	 * @param array $espresso_db_update
292
+	 */
293
+	protected function _handle_core_version_change($espresso_db_update)
294
+	{
295
+		$this->update_list_of_installed_versions($espresso_db_update);
296
+		//get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
297
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
298
+			array($this, 'initialize_db_if_no_migrations_required'));
299
+	}
300
+
301
+
302
+
303
+	/**
304
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
305
+	 * information about what versions of EE have been installed and activated,
306
+	 * NOT necessarily the state of the database
307
+	 *
308
+	 * @param null $espresso_db_update
309
+	 * @internal param array $espresso_db_update_value the value of the WordPress option. If not supplied, fetches it
310
+	 *           from the options table
311
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
312
+	 */
313
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null)
314
+	{
315
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
316
+		if ( ! $espresso_db_update) {
317
+			$espresso_db_update = get_option('espresso_db_update');
318
+		}
319
+		// check that option is an array
320
+		if ( ! is_array($espresso_db_update)) {
321
+			// if option is FALSE, then it never existed
322
+			if ($espresso_db_update === false) {
323
+				// make $espresso_db_update an array and save option with autoload OFF
324
+				$espresso_db_update = array();
325
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
326
+			} else {
327
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
328
+				$espresso_db_update = array($espresso_db_update => array());
329
+				update_option('espresso_db_update', $espresso_db_update);
330
+			}
331
+		} else {
332
+			$corrected_db_update = array();
333
+			//if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
334
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
335
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
336
+					//the key is an int, and the value IS NOT an array
337
+					//so it must be numerically-indexed, where values are versions installed...
338
+					//fix it!
339
+					$version_string = $should_be_array;
340
+					$corrected_db_update[$version_string] = array('unknown-date');
341
+				} else {
342
+					//ok it checks out
343
+					$corrected_db_update[$should_be_version_string] = $should_be_array;
344
+				}
345
+			}
346
+			$espresso_db_update = $corrected_db_update;
347
+			update_option('espresso_db_update', $espresso_db_update);
348
+		}
349
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
350
+		return $espresso_db_update;
351
+	}
352
+
353
+
354
+
355
+	/**
356
+	 * Does the traditional work of setting up the plugin's database and adding default data.
357
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
358
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
359
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
360
+	 * so that it will be done when migrations are finished
361
+	 *
362
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
363
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
364
+	 *                                       This is a resource-intensive job
365
+	 *                                       so we prefer to only do it when necessary
366
+	 * @return void
367
+	 */
368
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
369
+	{
370
+		$request_type = $this->detect_req_type();
371
+		//only initialize system if we're not in maintenance mode.
372
+		if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
373
+			update_option('ee_flush_rewrite_rules', true);
374
+			if ($verify_schema) {
375
+				EEH_Activation::initialize_db_and_folders();
376
+			}
377
+			EEH_Activation::initialize_db_content();
378
+			EEH_Activation::system_initialization();
379
+			if ($initialize_addons_too) {
380
+				$this->initialize_addons();
381
+			}
382
+		} else {
383
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
384
+		}
385
+		if ($request_type === EE_System::req_type_new_activation
386
+			|| $request_type === EE_System::req_type_reactivation
387
+			|| (
388
+				$request_type === EE_System::req_type_upgrade
389
+				&& $this->is_major_version_change()
390
+			)
391
+		) {
392
+			add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
393
+		}
394
+	}
395
+
396
+
397
+
398
+	/**
399
+	 * Initializes the db for all registered addons
400
+	 */
401
+	public function initialize_addons()
402
+	{
403
+		//foreach registered addon, make sure its db is up-to-date too
404
+		foreach ($this->registry->addons as $addon) {
405
+			$addon->initialize_db_if_no_migrations_required();
406
+		}
407
+	}
408
+
409
+
410
+
411
+	/**
412
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
413
+	 *
414
+	 * @param    array  $version_history
415
+	 * @param    string $current_version_to_add version to be added to the version history
416
+	 * @return    boolean success as to whether or not this option was changed
417
+	 */
418
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
419
+	{
420
+		if ( ! $version_history) {
421
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
422
+		}
423
+		if ($current_version_to_add == null) {
424
+			$current_version_to_add = espresso_version();
425
+		}
426
+		$version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
427
+		// re-save
428
+		return update_option('espresso_db_update', $version_history);
429
+	}
430
+
431
+
432
+
433
+	/**
434
+	 * Detects if the current version indicated in the has existed in the list of
435
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
436
+	 *
437
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
438
+	 *                                  If not supplied, fetches it from the options table.
439
+	 *                                  Also, caches its result so later parts of the code can also know whether
440
+	 *                                  there's been an update or not. This way we can add the current version to
441
+	 *                                  espresso_db_update, but still know if this is a new install or not
442
+	 * @return int one of the constants on EE_System::req_type_
443
+	 */
444
+	public function detect_req_type($espresso_db_update = null)
445
+	{
446
+		if ($this->_req_type === null) {
447
+			$espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
448
+				: $this->fix_espresso_db_upgrade_option();
449
+			$this->_req_type = $this->detect_req_type_given_activation_history($espresso_db_update,
450
+				'ee_espresso_activation', espresso_version());
451
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
452
+		}
453
+		return $this->_req_type;
454
+	}
455
+
456
+
457
+
458
+	/**
459
+	 * Returns whether or not there was a non-micro version change (ie, change in either
460
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
461
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
462
+	 *
463
+	 * @param $activation_history
464
+	 * @return bool
465
+	 */
466
+	protected function _detect_major_version_change($activation_history)
467
+	{
468
+		$previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
469
+		$previous_version_parts = explode('.', $previous_version);
470
+		$current_version_parts = explode('.', espresso_version());
471
+		return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
472
+			   && ($previous_version_parts[0] !== $current_version_parts[0]
473
+				   || $previous_version_parts[1] !== $current_version_parts[1]
474
+			   );
475
+	}
476
+
477
+
478
+
479
+	/**
480
+	 * Returns true if either the major or minor version of EE changed during this request.
481
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
482
+	 *
483
+	 * @return bool
484
+	 */
485
+	public function is_major_version_change()
486
+	{
487
+		return $this->_major_version_change;
488
+	}
489
+
490
+
491
+
492
+	/**
493
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
494
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the wordpress option which is temporarily
495
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
496
+	 * just activated to (for core that will always be espresso_version())
497
+	 *
498
+	 * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
499
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
500
+	 * @param string $activation_indicator_option_name the name of the wordpress option that is temporarily set to
501
+	 *                                                 indicate that this plugin was just activated
502
+	 * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
503
+	 *                                                 espresso_version())
504
+	 * @return int one of the constants on EE_System::req_type_*
505
+	 */
506
+	public static function detect_req_type_given_activation_history(
507
+		$activation_history_for_addon,
508
+		$activation_indicator_option_name,
509
+		$version_to_upgrade_to
510
+	) {
511
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
512
+		if ($activation_history_for_addon) {
513
+			//it exists, so this isn't a completely new install
514
+			//check if this version already in that list of previously installed versions
515
+			if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
516
+				//it a version we haven't seen before
517
+				if ($version_is_higher === 1) {
518
+					$req_type = EE_System::req_type_upgrade;
519
+				} else {
520
+					$req_type = EE_System::req_type_downgrade;
521
+				}
522
+				delete_option($activation_indicator_option_name);
523
+			} else {
524
+				// its not an update. maybe a reactivation?
525
+				if (get_option($activation_indicator_option_name, false)) {
526
+					if ($version_is_higher === -1) {
527
+						$req_type = EE_System::req_type_downgrade;
528
+					} elseif ($version_is_higher === 0) {
529
+						//we've seen this version before, but it's an activation. must be a reactivation
530
+						$req_type = EE_System::req_type_reactivation;
531
+					} else {//$version_is_higher === 1
532
+						$req_type = EE_System::req_type_upgrade;
533
+					}
534
+					delete_option($activation_indicator_option_name);
535
+				} else {
536
+					//we've seen this version before and the activation indicate doesn't show it was just activated
537
+					if ($version_is_higher === -1) {
538
+						$req_type = EE_System::req_type_downgrade;
539
+					} elseif ($version_is_higher === 0) {
540
+						//we've seen this version before and it's not an activation. its normal request
541
+						$req_type = EE_System::req_type_normal;
542
+					} else {//$version_is_higher === 1
543
+						$req_type = EE_System::req_type_upgrade;
544
+					}
545
+				}
546
+			}
547
+		} else {
548
+			//brand new install
549
+			$req_type = EE_System::req_type_new_activation;
550
+			delete_option($activation_indicator_option_name);
551
+		}
552
+		return $req_type;
553
+	}
554
+
555
+
556
+
557
+	/**
558
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
559
+	 * the $activation_history_for_addon
560
+	 *
561
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
562
+	 *                                             sometimes containing 'unknown-date'
563
+	 * @param string $version_to_upgrade_to        (current version)
564
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
565
+	 *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
566
+	 *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
567
+	 *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
568
+	 */
569
+	protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
570
+	{
571
+		//find the most recently-activated version
572
+		$most_recently_active_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
573
+		return version_compare($version_to_upgrade_to, $most_recently_active_version);
574
+	}
575
+
576
+
577
+
578
+	/**
579
+	 * Gets the most recently active version listed in the activation history,
580
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
581
+	 *
582
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
583
+	 *                                   sometimes containing 'unknown-date'
584
+	 * @return string
585
+	 */
586
+	protected static function _get_most_recently_active_version_from_activation_history($activation_history)
587
+	{
588
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
589
+		$most_recently_active_version = '0.0.0.dev.000';
590
+		if (is_array($activation_history)) {
591
+			foreach ($activation_history as $version => $times_activated) {
592
+				//check there is a record of when this version was activated. Otherwise,
593
+				//mark it as unknown
594
+				if ( ! $times_activated) {
595
+					$times_activated = array('unknown-date');
596
+				}
597
+				if (is_string($times_activated)) {
598
+					$times_activated = array($times_activated);
599
+				}
600
+				foreach ($times_activated as $an_activation) {
601
+					if ($an_activation != 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
602
+						$most_recently_active_version = $version;
603
+						$most_recently_active_version_activation = $an_activation == 'unknown-date'
604
+							? '1970-01-01 00:00:00' : $an_activation;
605
+					}
606
+				}
607
+			}
608
+		}
609
+		return $most_recently_active_version;
610
+	}
611
+
612
+
613
+
614
+	/**
615
+	 * This redirects to the about EE page after activation
616
+	 *
617
+	 * @return void
618
+	 */
619
+	public function redirect_to_about_ee()
620
+	{
621
+		$notices = EE_Error::get_notices(false);
622
+		//if current user is an admin and it's not an ajax or rest request
623
+		if (
624
+			! (defined('DOING_AJAX') && DOING_AJAX)
625
+			&& ! (defined('REST_REQUEST') && REST_REQUEST)
626
+			&& ! isset($notices['errors'])
627
+			&& apply_filters(
628
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
629
+				$this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
630
+			)
631
+		) {
632
+			$query_params = array('page' => 'espresso_about');
633
+			if (EE_System::instance()->detect_req_type() == EE_System::req_type_new_activation) {
634
+				$query_params['new_activation'] = true;
635
+			}
636
+			if (EE_System::instance()->detect_req_type() == EE_System::req_type_reactivation) {
637
+				$query_params['reactivation'] = true;
638
+			}
639
+			$url = add_query_arg($query_params, admin_url('admin.php'));
640
+			wp_safe_redirect($url);
641
+			exit();
642
+		}
643
+	}
644
+
645
+
646
+
647
+	/**
648
+	 * load_core_configuration
649
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
650
+	 * which runs during the WP 'plugins_loaded' action at priority 5
651
+	 *
652
+	 * @return void
653
+	 */
654
+	public function load_core_configuration()
655
+	{
656
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
657
+		$this->registry->load_core('EE_Load_Textdomain');
658
+		//load textdomain
659
+		EE_Load_Textdomain::load_textdomain();
660
+		// load and setup EE_Config and EE_Network_Config
661
+		$this->registry->load_core('Config');
662
+		$this->registry->load_core('Network_Config');
663
+		// setup autoloaders
664
+		// enable logging?
665
+		if ($this->registry->CFG->admin->use_full_logging) {
666
+			$this->registry->load_core('Log');
667
+		}
668
+		// check for activation errors
669
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
670
+		if ($activation_errors) {
671
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
672
+			update_option('ee_plugin_activation_errors', false);
673
+		}
674
+		// get model names
675
+		$this->_parse_model_names();
676
+		//load caf stuff a chance to play during the activation process too.
677
+		$this->_maybe_brew_regular();
678
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
679
+	}
680
+
681
+
682
+
683
+	/**
684
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
685
+	 *
686
+	 * @return void
687
+	 */
688
+	private function _parse_model_names()
689
+	{
690
+		//get all the files in the EE_MODELS folder that end in .model.php
691
+		$models = glob(EE_MODELS . '*.model.php');
692
+		$model_names = array();
693
+		$non_abstract_db_models = array();
694
+		foreach ($models as $model) {
695
+			// get model classname
696
+			$classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
697
+			$short_name = str_replace('EEM_', '', $classname);
698
+			$reflectionClass = new ReflectionClass($classname);
699
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
700
+				$non_abstract_db_models[$short_name] = $classname;
701
+			}
702
+			$model_names[$short_name] = $classname;
703
+		}
704
+		$this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
705
+		$this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
706
+			$non_abstract_db_models);
707
+	}
708
+
709
+
710
+
711
+	/**
712
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
713
+	 * that need to be setup before our EE_System launches.
714
+	 *
715
+	 * @return void
716
+	 */
717
+	private function _maybe_brew_regular()
718
+	{
719
+		if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
720
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
721
+		}
722
+	}
723
+
724
+
725
+
726
+	/**
727
+	 * register_shortcodes_modules_and_widgets
728
+	 * generate lists of shortcodes and modules, then verify paths and classes
729
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
730
+	 * which runs during the WP 'plugins_loaded' action at priority 7
731
+	 *
732
+	 * @access public
733
+	 * @return void
734
+	 */
735
+	public function register_shortcodes_modules_and_widgets()
736
+	{
737
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
738
+		// check for addons using old hookpoint
739
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
740
+			$this->_incompatible_addon_error();
741
+		}
742
+	}
743
+
744
+
745
+
746
+	/**
747
+	 * _incompatible_addon_error
748
+	 *
749
+	 * @access public
750
+	 * @return void
751
+	 */
752
+	private function _incompatible_addon_error()
753
+	{
754
+		// get array of classes hooking into here
755
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
756
+		if ( ! empty($class_names)) {
757
+			$msg = __('The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
758
+				'event_espresso');
759
+			$msg .= '<ul>';
760
+			foreach ($class_names as $class_name) {
761
+				$msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
762
+						$class_name) . '</b></li>';
763
+			}
764
+			$msg .= '</ul>';
765
+			$msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
766
+				'event_espresso');
767
+			// save list of incompatible addons to wp-options for later use
768
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
769
+			if (is_admin()) {
770
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
771
+			}
772
+		}
773
+	}
774
+
775
+
776
+
777
+	/**
778
+	 * brew_espresso
779
+	 * begins the process of setting hooks for initializing EE in the correct order
780
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hookpoint
781
+	 * which runs during the WP 'plugins_loaded' action at priority 9
782
+	 *
783
+	 * @return void
784
+	 */
785
+	public function brew_espresso()
786
+	{
787
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
788
+		// load some final core systems
789
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
790
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
791
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
792
+		add_action('init', array($this, 'load_controllers'), 7);
793
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
794
+		add_action('init', array($this, 'initialize'), 10);
795
+		add_action('init', array($this, 'initialize_last'), 100);
796
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 25);
797
+		add_action('admin_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 25);
798
+		add_action('admin_bar_menu', array($this, 'espresso_toolbar_items'), 100);
799
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
800
+			// pew pew pew
801
+			$this->registry->load_core('PUE');
802
+			do_action('AHEE__EE_System__brew_espresso__after_pue_init');
803
+		}
804
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
805
+	}
806
+
807
+
808
+
809
+	/**
810
+	 *    set_hooks_for_core
811
+	 *
812
+	 * @access public
813
+	 * @return    void
814
+	 */
815
+	public function set_hooks_for_core()
816
+	{
817
+		$this->_deactivate_incompatible_addons();
818
+		do_action('AHEE__EE_System__set_hooks_for_core');
819
+	}
820
+
821
+
822
+
823
+	/**
824
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
825
+	 * deactivates any addons considered incompatible with the current version of EE
826
+	 */
827
+	private function _deactivate_incompatible_addons()
828
+	{
829
+		$incompatible_addons = get_option('ee_incompatible_addons', array());
830
+		if ( ! empty($incompatible_addons)) {
831
+			$active_plugins = get_option('active_plugins', array());
832
+			foreach ($active_plugins as $active_plugin) {
833
+				foreach ($incompatible_addons as $incompatible_addon) {
834
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
835
+						unset($_GET['activate']);
836
+						espresso_deactivate_plugin($active_plugin);
837
+					}
838
+				}
839
+			}
840
+		}
841
+	}
842
+
843
+
844
+
845
+	/**
846
+	 *    perform_activations_upgrades_and_migrations
847
+	 *
848
+	 * @access public
849
+	 * @return    void
850
+	 */
851
+	public function perform_activations_upgrades_and_migrations()
852
+	{
853
+		//first check if we had previously attempted to setup EE's directories but failed
854
+		if (EEH_Activation::upload_directories_incomplete()) {
855
+			EEH_Activation::create_upload_directories();
856
+		}
857
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
858
+	}
859
+
860
+
861
+
862
+	/**
863
+	 *    load_CPTs_and_session
864
+	 *
865
+	 * @access public
866
+	 * @return    void
867
+	 */
868
+	public function load_CPTs_and_session()
869
+	{
870
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
871
+		// register Custom Post Types
872
+		$this->registry->load_core('Register_CPTs');
873
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
874
+	}
875
+
876
+
877
+
878
+	/**
879
+	 * load_controllers
880
+	 * this is the best place to load any additional controllers that needs access to EE core.
881
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
882
+	 * time
883
+	 *
884
+	 * @access public
885
+	 * @return void
886
+	 */
887
+	public function load_controllers()
888
+	{
889
+		do_action('AHEE__EE_System__load_controllers__start');
890
+		// let's get it started
891
+		if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
892
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
893
+			$this->registry->load_core('Front_Controller', array(), false, true);
894
+		} else if ( ! EE_FRONT_AJAX) {
895
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
896
+			EE_Registry::instance()->load_core('Admin');
897
+		}
898
+		do_action('AHEE__EE_System__load_controllers__complete');
899
+	}
900
+
901
+
902
+
903
+	/**
904
+	 * core_loaded_and_ready
905
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
906
+	 *
907
+	 * @access public
908
+	 * @return void
909
+	 */
910
+	public function core_loaded_and_ready()
911
+	{
912
+		do_action('AHEE__EE_System__core_loaded_and_ready');
913
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
914
+		$this->registry->load_core('Session');
915
+		//		add_action( 'wp_loaded', array( $this, 'set_hooks_for_shortcodes_modules_and_addons' ), 1 );
916
+	}
917
+
918
+
919
+
920
+	/**
921
+	 * initialize
922
+	 * this is the best place to begin initializing client code
923
+	 *
924
+	 * @access public
925
+	 * @return void
926
+	 */
927
+	public function initialize()
928
+	{
929
+		do_action('AHEE__EE_System__initialize');
930
+	}
931
+
932
+
933
+
934
+	/**
935
+	 * initialize_last
936
+	 * this is run really late during the WP init hookpoint, and ensures that mostly everything else that needs to
937
+	 * initialize has done so
938
+	 *
939
+	 * @access public
940
+	 * @return void
941
+	 */
942
+	public function initialize_last()
943
+	{
944
+		do_action('AHEE__EE_System__initialize_last');
945
+	}
946
+
947
+
948
+
949
+	/**
950
+	 * set_hooks_for_shortcodes_modules_and_addons
951
+	 * this is the best place for other systems to set callbacks for hooking into other parts of EE
952
+	 * this happens at the very beginning of the wp_loaded hookpoint
953
+	 *
954
+	 * @access public
955
+	 * @return void
956
+	 */
957
+	public function set_hooks_for_shortcodes_modules_and_addons()
958
+	{
959 959
 //		do_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons' );
960
-    }
961
-
962
-
963
-
964
-    /**
965
-     * do_not_cache
966
-     * sets no cache headers and defines no cache constants for WP plugins
967
-     *
968
-     * @access public
969
-     * @return void
970
-     */
971
-    public static function do_not_cache()
972
-    {
973
-        // set no cache constants
974
-        if ( ! defined('DONOTCACHEPAGE')) {
975
-            define('DONOTCACHEPAGE', true);
976
-        }
977
-        if ( ! defined('DONOTCACHCEOBJECT')) {
978
-            define('DONOTCACHCEOBJECT', true);
979
-        }
980
-        if ( ! defined('DONOTCACHEDB')) {
981
-            define('DONOTCACHEDB', true);
982
-        }
983
-        // add no cache headers
984
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
985
-        // plus a little extra for nginx and Google Chrome
986
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
987
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
988
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
989
-    }
990
-
991
-
992
-
993
-    /**
994
-     *    extra_nocache_headers
995
-     *
996
-     * @access    public
997
-     * @param $headers
998
-     * @return    array
999
-     */
1000
-    public static function extra_nocache_headers($headers)
1001
-    {
1002
-        // for NGINX
1003
-        $headers['X-Accel-Expires'] = 0;
1004
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
1005
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
1006
-        return $headers;
1007
-    }
1008
-
1009
-
1010
-
1011
-    /**
1012
-     *    nocache_headers
1013
-     *
1014
-     * @access    public
1015
-     * @return    void
1016
-     */
1017
-    public static function nocache_headers()
1018
-    {
1019
-        nocache_headers();
1020
-    }
1021
-
1022
-
1023
-
1024
-    /**
1025
-     *    espresso_toolbar_items
1026
-     *
1027
-     * @access public
1028
-     * @param  WP_Admin_Bar $admin_bar
1029
-     * @return void
1030
-     */
1031
-    public function espresso_toolbar_items(WP_Admin_Bar $admin_bar)
1032
-    {
1033
-        // if in full M-Mode, or its an AJAX request, or user is NOT an admin
1034
-        if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
1035
-            || defined('DOING_AJAX')
1036
-            || ! $this->registry->CAP->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
1037
-        ) {
1038
-            return;
1039
-        }
1040
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1041
-        $menu_class = 'espresso_menu_item_class';
1042
-        //we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
1043
-        //because they're only defined in each of their respective constructors
1044
-        //and this might be a frontend request, in which case they aren't available
1045
-        $events_admin_url = admin_url("admin.php?page=espresso_events");
1046
-        $reg_admin_url = admin_url("admin.php?page=espresso_registrations");
1047
-        $extensions_admin_url = admin_url("admin.php?page=espresso_packages");
1048
-        //Top Level
1049
-        $admin_bar->add_menu(array(
1050
-            'id'    => 'espresso-toolbar',
1051
-            'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
1052
-                       . _x('Event Espresso', 'admin bar menu group label', 'event_espresso')
1053
-                       . '</span>',
1054
-            'href'  => $events_admin_url,
1055
-            'meta'  => array(
1056
-                'title' => __('Event Espresso', 'event_espresso'),
1057
-                'class' => $menu_class . 'first',
1058
-            ),
1059
-        ));
1060
-        //Events
1061
-        if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events')) {
1062
-            $admin_bar->add_menu(array(
1063
-                'id'     => 'espresso-toolbar-events',
1064
-                'parent' => 'espresso-toolbar',
1065
-                'title'  => __('Events', 'event_espresso'),
1066
-                'href'   => $events_admin_url,
1067
-                'meta'   => array(
1068
-                    'title'  => __('Events', 'event_espresso'),
1069
-                    'target' => '',
1070
-                    'class'  => $menu_class,
1071
-                ),
1072
-            ));
1073
-        }
1074
-        if ($this->registry->CAP->current_user_can('ee_edit_events', 'ee_admin_bar_menu_espresso-toolbar-events-new')) {
1075
-            //Events Add New
1076
-            $admin_bar->add_menu(array(
1077
-                'id'     => 'espresso-toolbar-events-new',
1078
-                'parent' => 'espresso-toolbar-events',
1079
-                'title'  => __('Add New', 'event_espresso'),
1080
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'create_new'), $events_admin_url),
1081
-                'meta'   => array(
1082
-                    'title'  => __('Add New', 'event_espresso'),
1083
-                    'target' => '',
1084
-                    'class'  => $menu_class,
1085
-                ),
1086
-            ));
1087
-        }
1088
-        if (is_single() && (get_post_type() == 'espresso_events')) {
1089
-            //Current post
1090
-            global $post;
1091
-            if ($this->registry->CAP->current_user_can('ee_edit_event',
1092
-                'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID)
1093
-            ) {
1094
-                //Events Edit Current Event
1095
-                $admin_bar->add_menu(array(
1096
-                    'id'     => 'espresso-toolbar-events-edit',
1097
-                    'parent' => 'espresso-toolbar-events',
1098
-                    'title'  => __('Edit Event', 'event_espresso'),
1099
-                    'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'edit', 'post' => $post->ID),
1100
-                        $events_admin_url),
1101
-                    'meta'   => array(
1102
-                        'title'  => __('Edit Event', 'event_espresso'),
1103
-                        'target' => '',
1104
-                        'class'  => $menu_class,
1105
-                    ),
1106
-                ));
1107
-            }
1108
-        }
1109
-        //Events View
1110
-        if ($this->registry->CAP->current_user_can('ee_read_events',
1111
-            'ee_admin_bar_menu_espresso-toolbar-events-view')
1112
-        ) {
1113
-            $admin_bar->add_menu(array(
1114
-                'id'     => 'espresso-toolbar-events-view',
1115
-                'parent' => 'espresso-toolbar-events',
1116
-                'title'  => __('View', 'event_espresso'),
1117
-                'href'   => $events_admin_url,
1118
-                'meta'   => array(
1119
-                    'title'  => __('View', 'event_espresso'),
1120
-                    'target' => '',
1121
-                    'class'  => $menu_class,
1122
-                ),
1123
-            ));
1124
-        }
1125
-        if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events-all')) {
1126
-            //Events View All
1127
-            $admin_bar->add_menu(array(
1128
-                'id'     => 'espresso-toolbar-events-all',
1129
-                'parent' => 'espresso-toolbar-events-view',
1130
-                'title'  => __('All', 'event_espresso'),
1131
-                'href'   => $events_admin_url,
1132
-                'meta'   => array(
1133
-                    'title'  => __('All', 'event_espresso'),
1134
-                    'target' => '',
1135
-                    'class'  => $menu_class,
1136
-                ),
1137
-            ));
1138
-        }
1139
-        if ($this->registry->CAP->current_user_can('ee_read_events',
1140
-            'ee_admin_bar_menu_espresso-toolbar-events-today')
1141
-        ) {
1142
-            //Events View Today
1143
-            $admin_bar->add_menu(array(
1144
-                'id'     => 'espresso-toolbar-events-today',
1145
-                'parent' => 'espresso-toolbar-events-view',
1146
-                'title'  => __('Today', 'event_espresso'),
1147
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
1148
-                    $events_admin_url),
1149
-                'meta'   => array(
1150
-                    'title'  => __('Today', 'event_espresso'),
1151
-                    'target' => '',
1152
-                    'class'  => $menu_class,
1153
-                ),
1154
-            ));
1155
-        }
1156
-        if ($this->registry->CAP->current_user_can('ee_read_events',
1157
-            'ee_admin_bar_menu_espresso-toolbar-events-month')
1158
-        ) {
1159
-            //Events View This Month
1160
-            $admin_bar->add_menu(array(
1161
-                'id'     => 'espresso-toolbar-events-month',
1162
-                'parent' => 'espresso-toolbar-events-view',
1163
-                'title'  => __('This Month', 'event_espresso'),
1164
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
1165
-                    $events_admin_url),
1166
-                'meta'   => array(
1167
-                    'title'  => __('This Month', 'event_espresso'),
1168
-                    'target' => '',
1169
-                    'class'  => $menu_class,
1170
-                ),
1171
-            ));
1172
-        }
1173
-        //Registration Overview
1174
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1175
-            'ee_admin_bar_menu_espresso-toolbar-registrations')
1176
-        ) {
1177
-            $admin_bar->add_menu(array(
1178
-                'id'     => 'espresso-toolbar-registrations',
1179
-                'parent' => 'espresso-toolbar',
1180
-                'title'  => __('Registrations', 'event_espresso'),
1181
-                'href'   => $reg_admin_url,
1182
-                'meta'   => array(
1183
-                    'title'  => __('Registrations', 'event_espresso'),
1184
-                    'target' => '',
1185
-                    'class'  => $menu_class,
1186
-                ),
1187
-            ));
1188
-        }
1189
-        //Registration Overview Today
1190
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1191
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today')
1192
-        ) {
1193
-            $admin_bar->add_menu(array(
1194
-                'id'     => 'espresso-toolbar-registrations-today',
1195
-                'parent' => 'espresso-toolbar-registrations',
1196
-                'title'  => __('Today', 'event_espresso'),
1197
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
1198
-                    $reg_admin_url),
1199
-                'meta'   => array(
1200
-                    'title'  => __('Today', 'event_espresso'),
1201
-                    'target' => '',
1202
-                    'class'  => $menu_class,
1203
-                ),
1204
-            ));
1205
-        }
1206
-        //Registration Overview Today Completed
1207
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1208
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved')
1209
-        ) {
1210
-            $admin_bar->add_menu(array(
1211
-                'id'     => 'espresso-toolbar-registrations-today-approved',
1212
-                'parent' => 'espresso-toolbar-registrations-today',
1213
-                'title'  => __('Approved', 'event_espresso'),
1214
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1215
-                    'action'      => 'default',
1216
-                    'status'      => 'today',
1217
-                    '_reg_status' => EEM_Registration::status_id_approved,
1218
-                ), $reg_admin_url),
1219
-                'meta'   => array(
1220
-                    'title'  => __('Approved', 'event_espresso'),
1221
-                    'target' => '',
1222
-                    'class'  => $menu_class,
1223
-                ),
1224
-            ));
1225
-        }
1226
-        //Registration Overview Today Pending\
1227
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1228
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending')
1229
-        ) {
1230
-            $admin_bar->add_menu(array(
1231
-                'id'     => 'espresso-toolbar-registrations-today-pending',
1232
-                'parent' => 'espresso-toolbar-registrations-today',
1233
-                'title'  => __('Pending', 'event_espresso'),
1234
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1235
-                    'action'     => 'default',
1236
-                    'status'     => 'today',
1237
-                    'reg_status' => EEM_Registration::status_id_pending_payment,
1238
-                ), $reg_admin_url),
1239
-                'meta'   => array(
1240
-                    'title'  => __('Pending Payment', 'event_espresso'),
1241
-                    'target' => '',
1242
-                    'class'  => $menu_class,
1243
-                ),
1244
-            ));
1245
-        }
1246
-        //Registration Overview Today Incomplete
1247
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1248
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved')
1249
-        ) {
1250
-            $admin_bar->add_menu(array(
1251
-                'id'     => 'espresso-toolbar-registrations-today-not-approved',
1252
-                'parent' => 'espresso-toolbar-registrations-today',
1253
-                'title'  => __('Not Approved', 'event_espresso'),
1254
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1255
-                    'action'      => 'default',
1256
-                    'status'      => 'today',
1257
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
1258
-                ), $reg_admin_url),
1259
-                'meta'   => array(
1260
-                    'title'  => __('Not Approved', 'event_espresso'),
1261
-                    'target' => '',
1262
-                    'class'  => $menu_class,
1263
-                ),
1264
-            ));
1265
-        }
1266
-        //Registration Overview Today Incomplete
1267
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1268
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled')
1269
-        ) {
1270
-            $admin_bar->add_menu(array(
1271
-                'id'     => 'espresso-toolbar-registrations-today-cancelled',
1272
-                'parent' => 'espresso-toolbar-registrations-today',
1273
-                'title'  => __('Cancelled', 'event_espresso'),
1274
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1275
-                    'action'      => 'default',
1276
-                    'status'      => 'today',
1277
-                    '_reg_status' => EEM_Registration::status_id_cancelled,
1278
-                ), $reg_admin_url),
1279
-                'meta'   => array(
1280
-                    'title'  => __('Cancelled', 'event_espresso'),
1281
-                    'target' => '',
1282
-                    'class'  => $menu_class,
1283
-                ),
1284
-            ));
1285
-        }
1286
-        //Registration Overview This Month
1287
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1288
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month')
1289
-        ) {
1290
-            $admin_bar->add_menu(array(
1291
-                'id'     => 'espresso-toolbar-registrations-month',
1292
-                'parent' => 'espresso-toolbar-registrations',
1293
-                'title'  => __('This Month', 'event_espresso'),
1294
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
1295
-                    $reg_admin_url),
1296
-                'meta'   => array(
1297
-                    'title'  => __('This Month', 'event_espresso'),
1298
-                    'target' => '',
1299
-                    'class'  => $menu_class,
1300
-                ),
1301
-            ));
1302
-        }
1303
-        //Registration Overview This Month Approved
1304
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1305
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved')
1306
-        ) {
1307
-            $admin_bar->add_menu(array(
1308
-                'id'     => 'espresso-toolbar-registrations-month-approved',
1309
-                'parent' => 'espresso-toolbar-registrations-month',
1310
-                'title'  => __('Approved', 'event_espresso'),
1311
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1312
-                    'action'      => 'default',
1313
-                    'status'      => 'month',
1314
-                    '_reg_status' => EEM_Registration::status_id_approved,
1315
-                ), $reg_admin_url),
1316
-                'meta'   => array(
1317
-                    'title'  => __('Approved', 'event_espresso'),
1318
-                    'target' => '',
1319
-                    'class'  => $menu_class,
1320
-                ),
1321
-            ));
1322
-        }
1323
-        //Registration Overview This Month Pending
1324
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1325
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending')
1326
-        ) {
1327
-            $admin_bar->add_menu(array(
1328
-                'id'     => 'espresso-toolbar-registrations-month-pending',
1329
-                'parent' => 'espresso-toolbar-registrations-month',
1330
-                'title'  => __('Pending', 'event_espresso'),
1331
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1332
-                    'action'      => 'default',
1333
-                    'status'      => 'month',
1334
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
1335
-                ), $reg_admin_url),
1336
-                'meta'   => array(
1337
-                    'title'  => __('Pending', 'event_espresso'),
1338
-                    'target' => '',
1339
-                    'class'  => $menu_class,
1340
-                ),
1341
-            ));
1342
-        }
1343
-        //Registration Overview This Month Not Approved
1344
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1345
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved')
1346
-        ) {
1347
-            $admin_bar->add_menu(array(
1348
-                'id'     => 'espresso-toolbar-registrations-month-not-approved',
1349
-                'parent' => 'espresso-toolbar-registrations-month',
1350
-                'title'  => __('Not Approved', 'event_espresso'),
1351
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1352
-                    'action'      => 'default',
1353
-                    'status'      => 'month',
1354
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
1355
-                ), $reg_admin_url),
1356
-                'meta'   => array(
1357
-                    'title'  => __('Not Approved', 'event_espresso'),
1358
-                    'target' => '',
1359
-                    'class'  => $menu_class,
1360
-                ),
1361
-            ));
1362
-        }
1363
-        //Registration Overview This Month Cancelled
1364
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1365
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled')
1366
-        ) {
1367
-            $admin_bar->add_menu(array(
1368
-                'id'     => 'espresso-toolbar-registrations-month-cancelled',
1369
-                'parent' => 'espresso-toolbar-registrations-month',
1370
-                'title'  => __('Cancelled', 'event_espresso'),
1371
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1372
-                    'action'      => 'default',
1373
-                    'status'      => 'month',
1374
-                    '_reg_status' => EEM_Registration::status_id_cancelled,
1375
-                ), $reg_admin_url),
1376
-                'meta'   => array(
1377
-                    'title'  => __('Cancelled', 'event_espresso'),
1378
-                    'target' => '',
1379
-                    'class'  => $menu_class,
1380
-                ),
1381
-            ));
1382
-        }
1383
-        //Extensions & Services
1384
-        if ($this->registry->CAP->current_user_can('ee_read_ee',
1385
-            'ee_admin_bar_menu_espresso-toolbar-extensions-and-services')
1386
-        ) {
1387
-            $admin_bar->add_menu(array(
1388
-                'id'     => 'espresso-toolbar-extensions-and-services',
1389
-                'parent' => 'espresso-toolbar',
1390
-                'title'  => __('Extensions & Services', 'event_espresso'),
1391
-                'href'   => $extensions_admin_url,
1392
-                'meta'   => array(
1393
-                    'title'  => __('Extensions & Services', 'event_espresso'),
1394
-                    'target' => '',
1395
-                    'class'  => $menu_class,
1396
-                ),
1397
-            ));
1398
-        }
1399
-    }
1400
-
1401
-
1402
-
1403
-    /**
1404
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
1405
-     * never returned with the function.
1406
-     *
1407
-     * @param  array $exclude_array any existing pages being excluded are in this array.
1408
-     * @return array
1409
-     */
1410
-    public function remove_pages_from_wp_list_pages($exclude_array)
1411
-    {
1412
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
1413
-    }
1414
-
1415
-
1416
-
1417
-
1418
-
1419
-
1420
-    /***********************************************        WP_ENQUEUE_SCRIPTS HOOK         ***********************************************/
1421
-    /**
1422
-     *    wp_enqueue_scripts
1423
-     *
1424
-     * @access    public
1425
-     * @return    void
1426
-     */
1427
-    public function wp_enqueue_scripts()
1428
-    {
1429
-        // unlike other systems, EE_System_scripts loading is turned ON by default, but prior to the init hook, can be turned off via: add_filter( 'FHEE_load_EE_System_scripts', '__return_false' );
1430
-        if (apply_filters('FHEE_load_EE_System_scripts', true)) {
1431
-            // jquery_validate loading is turned OFF by default, but prior to the wp_enqueue_scripts hook, can be turned back on again via:  add_filter( 'FHEE_load_jquery_validate', '__return_true' );
1432
-            if (apply_filters('FHEE_load_jquery_validate', false)) {
1433
-                // register jQuery Validate and additional methods
1434
-                wp_register_script('jquery-validate', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
1435
-                    array('jquery'), '1.15.0', true);
1436
-                wp_register_script('jquery-validate-extra-methods',
1437
-                    EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
1438
-                    array('jquery', 'jquery-validate'), '1.15.0', true);
1439
-            }
1440
-        }
1441
-    }
960
+	}
961
+
962
+
963
+
964
+	/**
965
+	 * do_not_cache
966
+	 * sets no cache headers and defines no cache constants for WP plugins
967
+	 *
968
+	 * @access public
969
+	 * @return void
970
+	 */
971
+	public static function do_not_cache()
972
+	{
973
+		// set no cache constants
974
+		if ( ! defined('DONOTCACHEPAGE')) {
975
+			define('DONOTCACHEPAGE', true);
976
+		}
977
+		if ( ! defined('DONOTCACHCEOBJECT')) {
978
+			define('DONOTCACHCEOBJECT', true);
979
+		}
980
+		if ( ! defined('DONOTCACHEDB')) {
981
+			define('DONOTCACHEDB', true);
982
+		}
983
+		// add no cache headers
984
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
985
+		// plus a little extra for nginx and Google Chrome
986
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
987
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
988
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
989
+	}
990
+
991
+
992
+
993
+	/**
994
+	 *    extra_nocache_headers
995
+	 *
996
+	 * @access    public
997
+	 * @param $headers
998
+	 * @return    array
999
+	 */
1000
+	public static function extra_nocache_headers($headers)
1001
+	{
1002
+		// for NGINX
1003
+		$headers['X-Accel-Expires'] = 0;
1004
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
1005
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
1006
+		return $headers;
1007
+	}
1008
+
1009
+
1010
+
1011
+	/**
1012
+	 *    nocache_headers
1013
+	 *
1014
+	 * @access    public
1015
+	 * @return    void
1016
+	 */
1017
+	public static function nocache_headers()
1018
+	{
1019
+		nocache_headers();
1020
+	}
1021
+
1022
+
1023
+
1024
+	/**
1025
+	 *    espresso_toolbar_items
1026
+	 *
1027
+	 * @access public
1028
+	 * @param  WP_Admin_Bar $admin_bar
1029
+	 * @return void
1030
+	 */
1031
+	public function espresso_toolbar_items(WP_Admin_Bar $admin_bar)
1032
+	{
1033
+		// if in full M-Mode, or its an AJAX request, or user is NOT an admin
1034
+		if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
1035
+			|| defined('DOING_AJAX')
1036
+			|| ! $this->registry->CAP->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
1037
+		) {
1038
+			return;
1039
+		}
1040
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1041
+		$menu_class = 'espresso_menu_item_class';
1042
+		//we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
1043
+		//because they're only defined in each of their respective constructors
1044
+		//and this might be a frontend request, in which case they aren't available
1045
+		$events_admin_url = admin_url("admin.php?page=espresso_events");
1046
+		$reg_admin_url = admin_url("admin.php?page=espresso_registrations");
1047
+		$extensions_admin_url = admin_url("admin.php?page=espresso_packages");
1048
+		//Top Level
1049
+		$admin_bar->add_menu(array(
1050
+			'id'    => 'espresso-toolbar',
1051
+			'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
1052
+					   . _x('Event Espresso', 'admin bar menu group label', 'event_espresso')
1053
+					   . '</span>',
1054
+			'href'  => $events_admin_url,
1055
+			'meta'  => array(
1056
+				'title' => __('Event Espresso', 'event_espresso'),
1057
+				'class' => $menu_class . 'first',
1058
+			),
1059
+		));
1060
+		//Events
1061
+		if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events')) {
1062
+			$admin_bar->add_menu(array(
1063
+				'id'     => 'espresso-toolbar-events',
1064
+				'parent' => 'espresso-toolbar',
1065
+				'title'  => __('Events', 'event_espresso'),
1066
+				'href'   => $events_admin_url,
1067
+				'meta'   => array(
1068
+					'title'  => __('Events', 'event_espresso'),
1069
+					'target' => '',
1070
+					'class'  => $menu_class,
1071
+				),
1072
+			));
1073
+		}
1074
+		if ($this->registry->CAP->current_user_can('ee_edit_events', 'ee_admin_bar_menu_espresso-toolbar-events-new')) {
1075
+			//Events Add New
1076
+			$admin_bar->add_menu(array(
1077
+				'id'     => 'espresso-toolbar-events-new',
1078
+				'parent' => 'espresso-toolbar-events',
1079
+				'title'  => __('Add New', 'event_espresso'),
1080
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'create_new'), $events_admin_url),
1081
+				'meta'   => array(
1082
+					'title'  => __('Add New', 'event_espresso'),
1083
+					'target' => '',
1084
+					'class'  => $menu_class,
1085
+				),
1086
+			));
1087
+		}
1088
+		if (is_single() && (get_post_type() == 'espresso_events')) {
1089
+			//Current post
1090
+			global $post;
1091
+			if ($this->registry->CAP->current_user_can('ee_edit_event',
1092
+				'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID)
1093
+			) {
1094
+				//Events Edit Current Event
1095
+				$admin_bar->add_menu(array(
1096
+					'id'     => 'espresso-toolbar-events-edit',
1097
+					'parent' => 'espresso-toolbar-events',
1098
+					'title'  => __('Edit Event', 'event_espresso'),
1099
+					'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'edit', 'post' => $post->ID),
1100
+						$events_admin_url),
1101
+					'meta'   => array(
1102
+						'title'  => __('Edit Event', 'event_espresso'),
1103
+						'target' => '',
1104
+						'class'  => $menu_class,
1105
+					),
1106
+				));
1107
+			}
1108
+		}
1109
+		//Events View
1110
+		if ($this->registry->CAP->current_user_can('ee_read_events',
1111
+			'ee_admin_bar_menu_espresso-toolbar-events-view')
1112
+		) {
1113
+			$admin_bar->add_menu(array(
1114
+				'id'     => 'espresso-toolbar-events-view',
1115
+				'parent' => 'espresso-toolbar-events',
1116
+				'title'  => __('View', 'event_espresso'),
1117
+				'href'   => $events_admin_url,
1118
+				'meta'   => array(
1119
+					'title'  => __('View', 'event_espresso'),
1120
+					'target' => '',
1121
+					'class'  => $menu_class,
1122
+				),
1123
+			));
1124
+		}
1125
+		if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events-all')) {
1126
+			//Events View All
1127
+			$admin_bar->add_menu(array(
1128
+				'id'     => 'espresso-toolbar-events-all',
1129
+				'parent' => 'espresso-toolbar-events-view',
1130
+				'title'  => __('All', 'event_espresso'),
1131
+				'href'   => $events_admin_url,
1132
+				'meta'   => array(
1133
+					'title'  => __('All', 'event_espresso'),
1134
+					'target' => '',
1135
+					'class'  => $menu_class,
1136
+				),
1137
+			));
1138
+		}
1139
+		if ($this->registry->CAP->current_user_can('ee_read_events',
1140
+			'ee_admin_bar_menu_espresso-toolbar-events-today')
1141
+		) {
1142
+			//Events View Today
1143
+			$admin_bar->add_menu(array(
1144
+				'id'     => 'espresso-toolbar-events-today',
1145
+				'parent' => 'espresso-toolbar-events-view',
1146
+				'title'  => __('Today', 'event_espresso'),
1147
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
1148
+					$events_admin_url),
1149
+				'meta'   => array(
1150
+					'title'  => __('Today', 'event_espresso'),
1151
+					'target' => '',
1152
+					'class'  => $menu_class,
1153
+				),
1154
+			));
1155
+		}
1156
+		if ($this->registry->CAP->current_user_can('ee_read_events',
1157
+			'ee_admin_bar_menu_espresso-toolbar-events-month')
1158
+		) {
1159
+			//Events View This Month
1160
+			$admin_bar->add_menu(array(
1161
+				'id'     => 'espresso-toolbar-events-month',
1162
+				'parent' => 'espresso-toolbar-events-view',
1163
+				'title'  => __('This Month', 'event_espresso'),
1164
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
1165
+					$events_admin_url),
1166
+				'meta'   => array(
1167
+					'title'  => __('This Month', 'event_espresso'),
1168
+					'target' => '',
1169
+					'class'  => $menu_class,
1170
+				),
1171
+			));
1172
+		}
1173
+		//Registration Overview
1174
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1175
+			'ee_admin_bar_menu_espresso-toolbar-registrations')
1176
+		) {
1177
+			$admin_bar->add_menu(array(
1178
+				'id'     => 'espresso-toolbar-registrations',
1179
+				'parent' => 'espresso-toolbar',
1180
+				'title'  => __('Registrations', 'event_espresso'),
1181
+				'href'   => $reg_admin_url,
1182
+				'meta'   => array(
1183
+					'title'  => __('Registrations', 'event_espresso'),
1184
+					'target' => '',
1185
+					'class'  => $menu_class,
1186
+				),
1187
+			));
1188
+		}
1189
+		//Registration Overview Today
1190
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1191
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today')
1192
+		) {
1193
+			$admin_bar->add_menu(array(
1194
+				'id'     => 'espresso-toolbar-registrations-today',
1195
+				'parent' => 'espresso-toolbar-registrations',
1196
+				'title'  => __('Today', 'event_espresso'),
1197
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
1198
+					$reg_admin_url),
1199
+				'meta'   => array(
1200
+					'title'  => __('Today', 'event_espresso'),
1201
+					'target' => '',
1202
+					'class'  => $menu_class,
1203
+				),
1204
+			));
1205
+		}
1206
+		//Registration Overview Today Completed
1207
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1208
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved')
1209
+		) {
1210
+			$admin_bar->add_menu(array(
1211
+				'id'     => 'espresso-toolbar-registrations-today-approved',
1212
+				'parent' => 'espresso-toolbar-registrations-today',
1213
+				'title'  => __('Approved', 'event_espresso'),
1214
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1215
+					'action'      => 'default',
1216
+					'status'      => 'today',
1217
+					'_reg_status' => EEM_Registration::status_id_approved,
1218
+				), $reg_admin_url),
1219
+				'meta'   => array(
1220
+					'title'  => __('Approved', 'event_espresso'),
1221
+					'target' => '',
1222
+					'class'  => $menu_class,
1223
+				),
1224
+			));
1225
+		}
1226
+		//Registration Overview Today Pending\
1227
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1228
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending')
1229
+		) {
1230
+			$admin_bar->add_menu(array(
1231
+				'id'     => 'espresso-toolbar-registrations-today-pending',
1232
+				'parent' => 'espresso-toolbar-registrations-today',
1233
+				'title'  => __('Pending', 'event_espresso'),
1234
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1235
+					'action'     => 'default',
1236
+					'status'     => 'today',
1237
+					'reg_status' => EEM_Registration::status_id_pending_payment,
1238
+				), $reg_admin_url),
1239
+				'meta'   => array(
1240
+					'title'  => __('Pending Payment', 'event_espresso'),
1241
+					'target' => '',
1242
+					'class'  => $menu_class,
1243
+				),
1244
+			));
1245
+		}
1246
+		//Registration Overview Today Incomplete
1247
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1248
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved')
1249
+		) {
1250
+			$admin_bar->add_menu(array(
1251
+				'id'     => 'espresso-toolbar-registrations-today-not-approved',
1252
+				'parent' => 'espresso-toolbar-registrations-today',
1253
+				'title'  => __('Not Approved', 'event_espresso'),
1254
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1255
+					'action'      => 'default',
1256
+					'status'      => 'today',
1257
+					'_reg_status' => EEM_Registration::status_id_not_approved,
1258
+				), $reg_admin_url),
1259
+				'meta'   => array(
1260
+					'title'  => __('Not Approved', 'event_espresso'),
1261
+					'target' => '',
1262
+					'class'  => $menu_class,
1263
+				),
1264
+			));
1265
+		}
1266
+		//Registration Overview Today Incomplete
1267
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1268
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled')
1269
+		) {
1270
+			$admin_bar->add_menu(array(
1271
+				'id'     => 'espresso-toolbar-registrations-today-cancelled',
1272
+				'parent' => 'espresso-toolbar-registrations-today',
1273
+				'title'  => __('Cancelled', 'event_espresso'),
1274
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1275
+					'action'      => 'default',
1276
+					'status'      => 'today',
1277
+					'_reg_status' => EEM_Registration::status_id_cancelled,
1278
+				), $reg_admin_url),
1279
+				'meta'   => array(
1280
+					'title'  => __('Cancelled', 'event_espresso'),
1281
+					'target' => '',
1282
+					'class'  => $menu_class,
1283
+				),
1284
+			));
1285
+		}
1286
+		//Registration Overview This Month
1287
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1288
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month')
1289
+		) {
1290
+			$admin_bar->add_menu(array(
1291
+				'id'     => 'espresso-toolbar-registrations-month',
1292
+				'parent' => 'espresso-toolbar-registrations',
1293
+				'title'  => __('This Month', 'event_espresso'),
1294
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
1295
+					$reg_admin_url),
1296
+				'meta'   => array(
1297
+					'title'  => __('This Month', 'event_espresso'),
1298
+					'target' => '',
1299
+					'class'  => $menu_class,
1300
+				),
1301
+			));
1302
+		}
1303
+		//Registration Overview This Month Approved
1304
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1305
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved')
1306
+		) {
1307
+			$admin_bar->add_menu(array(
1308
+				'id'     => 'espresso-toolbar-registrations-month-approved',
1309
+				'parent' => 'espresso-toolbar-registrations-month',
1310
+				'title'  => __('Approved', 'event_espresso'),
1311
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1312
+					'action'      => 'default',
1313
+					'status'      => 'month',
1314
+					'_reg_status' => EEM_Registration::status_id_approved,
1315
+				), $reg_admin_url),
1316
+				'meta'   => array(
1317
+					'title'  => __('Approved', 'event_espresso'),
1318
+					'target' => '',
1319
+					'class'  => $menu_class,
1320
+				),
1321
+			));
1322
+		}
1323
+		//Registration Overview This Month Pending
1324
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1325
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending')
1326
+		) {
1327
+			$admin_bar->add_menu(array(
1328
+				'id'     => 'espresso-toolbar-registrations-month-pending',
1329
+				'parent' => 'espresso-toolbar-registrations-month',
1330
+				'title'  => __('Pending', 'event_espresso'),
1331
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1332
+					'action'      => 'default',
1333
+					'status'      => 'month',
1334
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
1335
+				), $reg_admin_url),
1336
+				'meta'   => array(
1337
+					'title'  => __('Pending', 'event_espresso'),
1338
+					'target' => '',
1339
+					'class'  => $menu_class,
1340
+				),
1341
+			));
1342
+		}
1343
+		//Registration Overview This Month Not Approved
1344
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1345
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved')
1346
+		) {
1347
+			$admin_bar->add_menu(array(
1348
+				'id'     => 'espresso-toolbar-registrations-month-not-approved',
1349
+				'parent' => 'espresso-toolbar-registrations-month',
1350
+				'title'  => __('Not Approved', 'event_espresso'),
1351
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1352
+					'action'      => 'default',
1353
+					'status'      => 'month',
1354
+					'_reg_status' => EEM_Registration::status_id_not_approved,
1355
+				), $reg_admin_url),
1356
+				'meta'   => array(
1357
+					'title'  => __('Not Approved', 'event_espresso'),
1358
+					'target' => '',
1359
+					'class'  => $menu_class,
1360
+				),
1361
+			));
1362
+		}
1363
+		//Registration Overview This Month Cancelled
1364
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1365
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled')
1366
+		) {
1367
+			$admin_bar->add_menu(array(
1368
+				'id'     => 'espresso-toolbar-registrations-month-cancelled',
1369
+				'parent' => 'espresso-toolbar-registrations-month',
1370
+				'title'  => __('Cancelled', 'event_espresso'),
1371
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1372
+					'action'      => 'default',
1373
+					'status'      => 'month',
1374
+					'_reg_status' => EEM_Registration::status_id_cancelled,
1375
+				), $reg_admin_url),
1376
+				'meta'   => array(
1377
+					'title'  => __('Cancelled', 'event_espresso'),
1378
+					'target' => '',
1379
+					'class'  => $menu_class,
1380
+				),
1381
+			));
1382
+		}
1383
+		//Extensions & Services
1384
+		if ($this->registry->CAP->current_user_can('ee_read_ee',
1385
+			'ee_admin_bar_menu_espresso-toolbar-extensions-and-services')
1386
+		) {
1387
+			$admin_bar->add_menu(array(
1388
+				'id'     => 'espresso-toolbar-extensions-and-services',
1389
+				'parent' => 'espresso-toolbar',
1390
+				'title'  => __('Extensions & Services', 'event_espresso'),
1391
+				'href'   => $extensions_admin_url,
1392
+				'meta'   => array(
1393
+					'title'  => __('Extensions & Services', 'event_espresso'),
1394
+					'target' => '',
1395
+					'class'  => $menu_class,
1396
+				),
1397
+			));
1398
+		}
1399
+	}
1400
+
1401
+
1402
+
1403
+	/**
1404
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
1405
+	 * never returned with the function.
1406
+	 *
1407
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
1408
+	 * @return array
1409
+	 */
1410
+	public function remove_pages_from_wp_list_pages($exclude_array)
1411
+	{
1412
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
1413
+	}
1414
+
1415
+
1416
+
1417
+
1418
+
1419
+
1420
+	/***********************************************        WP_ENQUEUE_SCRIPTS HOOK         ***********************************************/
1421
+	/**
1422
+	 *    wp_enqueue_scripts
1423
+	 *
1424
+	 * @access    public
1425
+	 * @return    void
1426
+	 */
1427
+	public function wp_enqueue_scripts()
1428
+	{
1429
+		// unlike other systems, EE_System_scripts loading is turned ON by default, but prior to the init hook, can be turned off via: add_filter( 'FHEE_load_EE_System_scripts', '__return_false' );
1430
+		if (apply_filters('FHEE_load_EE_System_scripts', true)) {
1431
+			// jquery_validate loading is turned OFF by default, but prior to the wp_enqueue_scripts hook, can be turned back on again via:  add_filter( 'FHEE_load_jquery_validate', '__return_true' );
1432
+			if (apply_filters('FHEE_load_jquery_validate', false)) {
1433
+				// register jQuery Validate and additional methods
1434
+				wp_register_script('jquery-validate', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
1435
+					array('jquery'), '1.15.0', true);
1436
+				wp_register_script('jquery-validate-extra-methods',
1437
+					EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
1438
+					array('jquery', 'jquery-validate'), '1.15.0', true);
1439
+			}
1440
+		}
1441
+	}
1442 1442
 
1443 1443
 
1444 1444
 
Please login to merge, or discard this patch.
core/EE_Session.core.php 2 patches
Indentation   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -414,7 +414,7 @@  discard block
 block discarded – undo
414 414
 				}
415 415
 			}
416 416
 			// decode the data ?
417
-            $session_data = $this->valid_base_64($session_data) ? base64_decode($session_data) : $session_data;
417
+			$session_data = $this->valid_base_64($session_data) ? base64_decode($session_data) : $session_data;
418 418
 			// un-encrypt the data ?
419 419
 			$session_data = $this->_use_encryption ? $this->encryption->decrypt( $session_data ) : $session_data;
420 420
 			if ( ! is_array( $session_data ) ) {
@@ -684,12 +684,12 @@  discard block
 block discarded – undo
684 684
 		) {
685 685
 			return false;
686 686
 		}
687
-        // then serialize all of our session data
688
-        $session_data = serialize($this->_session_data);
689
-        // do we need to also encode it to avoid corrupted data when saved to the db?
690
-        if (EE_Registry::instance()->CFG->admin->encode_session_data()) {
691
-            $session_data = base64_encode($session_data);
692
-        }
687
+		// then serialize all of our session data
688
+		$session_data = serialize($this->_session_data);
689
+		// do we need to also encode it to avoid corrupted data when saved to the db?
690
+		if (EE_Registry::instance()->CFG->admin->encode_session_data()) {
691
+			$session_data = base64_encode($session_data);
692
+		}
693 693
 		// encrypt it if we are using encryption
694 694
 		$session_data = $this->_use_encryption ? $this->encryption->encrypt( $session_data ) : $session_data;
695 695
 		// maybe save hash check
@@ -969,10 +969,10 @@  discard block
 block discarded – undo
969 969
 	  * @return bool
970 970
 	  */
971 971
 	 private function valid_base_64( $string ) {
972
-         // ensure data is a string
973
-         if ( ! is_string($string)) {
974
-             return false;
975
-         }
972
+		 // ensure data is a string
973
+		 if ( ! is_string($string)) {
974
+			 return false;
975
+		 }
976 976
 		 $decoded = base64_decode( $string, true );
977 977
 		 // Check if there is no invalid character in string
978 978
 		 if ( ! preg_match( '/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string ) ) {
Please login to merge, or discard this patch.
Spacing   +182 added lines, -182 removed lines patch added patch discarded remove patch
@@ -1,6 +1,6 @@  discard block
 block discarded – undo
1 1
 <?php use EventEspresso\core\exceptions\InvalidSessionDataException;
2 2
 
3
-if (!defined( 'EVENT_ESPRESSO_VERSION')) {exit('No direct script access allowed');}
3
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {exit('No direct script access allowed'); }
4 4
 /**
5 5
  *
6 6
  * EE_Session class
@@ -91,7 +91,7 @@  discard block
 block discarded – undo
91 91
 	  * array for defining default session vars
92 92
 	  * @var array
93 93
 	  */
94
-	 private $_default_session_vars = array (
94
+	 private $_default_session_vars = array(
95 95
 		'id' => NULL,
96 96
 		'user_id' => NULL,
97 97
 		'ip_address' => NULL,
@@ -111,12 +111,12 @@  discard block
 block discarded – undo
111 111
 	  * @throws InvalidSessionDataException
112 112
 	  * @throws \EE_Error
113 113
 	  */
114
-	public static function instance( EE_Encryption $encryption = null ) {
114
+	public static function instance(EE_Encryption $encryption = null) {
115 115
 		// check if class object is instantiated
116 116
 		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
117 117
 		// add_filter( 'FHEE_load_EE_Session', '__return_false' );
118
-		if ( ! self::$_instance instanceof EE_Session && apply_filters( 'FHEE_load_EE_Session', true ) ) {
119
-			self::$_instance = new self( $encryption );
118
+		if ( ! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
119
+			self::$_instance = new self($encryption);
120 120
 		}
121 121
 		return self::$_instance;
122 122
 	}
@@ -132,15 +132,15 @@  discard block
 block discarded – undo
132 132
 	  * @throws \EE_Error
133 133
 	  * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
134 134
 	  */
135
-	 protected function __construct( EE_Encryption $encryption = null ) {
135
+	 protected function __construct(EE_Encryption $encryption = null) {
136 136
 
137 137
 		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
138
-		if ( ! apply_filters( 'FHEE_load_EE_Session', TRUE ) ) {
138
+		if ( ! apply_filters('FHEE_load_EE_Session', TRUE)) {
139 139
 			return;
140 140
 		}
141
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
142
-		if ( ! defined( 'ESPRESSO_SESSION' ) ) {
143
-			define( 'ESPRESSO_SESSION', true );
141
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
142
+		if ( ! defined('ESPRESSO_SESSION')) {
143
+			define('ESPRESSO_SESSION', true);
144 144
 		}
145 145
 		// default session lifespan in seconds
146 146
 		$this->_lifespan = apply_filters(
@@ -154,36 +154,36 @@  discard block
 block discarded – undo
154 154
 		 * 		}
155 155
 		 */
156 156
 		// retrieve session options from db
157
-		$session_settings = get_option( 'ee_session_settings' );
158
-		if ( $session_settings !== FALSE ) {
157
+		$session_settings = get_option('ee_session_settings');
158
+		if ($session_settings !== FALSE) {
159 159
 			// cycle though existing session options
160
-			foreach ( $session_settings as $var_name => $session_setting ) {
160
+			foreach ($session_settings as $var_name => $session_setting) {
161 161
 				// set values for class properties
162
-				$var_name = '_' . $var_name;
162
+				$var_name = '_'.$var_name;
163 163
 				$this->{$var_name} = $session_setting;
164 164
 			}
165 165
 		}
166 166
 		// are we using encryption?
167
-		if ( $this->_use_encryption && $encryption instanceof EE_Encryption ) {
167
+		if ($this->_use_encryption && $encryption instanceof EE_Encryption) {
168 168
 			// encrypt data via: $this->encryption->encrypt();
169 169
 			$this->encryption = $encryption;
170 170
 		}
171 171
 		// filter hook allows outside functions/classes/plugins to change default empty cart
172
-		$extra_default_session_vars = apply_filters( 'FHEE__EE_Session__construct__extra_default_session_vars', array() );
173
-		array_merge( $this->_default_session_vars, $extra_default_session_vars );
172
+		$extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
173
+		array_merge($this->_default_session_vars, $extra_default_session_vars);
174 174
 		// apply default session vars
175 175
 		$this->_set_defaults();
176 176
 		// check for existing session and retrieve it from db
177
-		if ( ! $this->_espresso_session() ) {
177
+		if ( ! $this->_espresso_session()) {
178 178
 			// or just start a new one
179 179
 			$this->_create_espresso_session();
180 180
 		}
181 181
 		// check request for 'clear_session' param
182
-		add_action( 'AHEE__EE_Request_Handler__construct__complete', array( $this, 'wp_loaded' ));
182
+		add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
183 183
 		// once everything is all said and done,
184
-		add_action( 'shutdown', array( $this, 'update' ), 100 );
185
-		add_action( 'shutdown', array( $this, 'garbage_collection' ), 999 );
186
-		add_filter( 'wp_redirect', array( $this, 'update_on_redirect' ), 100, 1 );
184
+		add_action('shutdown', array($this, 'update'), 100);
185
+		add_action('shutdown', array($this, 'garbage_collection'), 999);
186
+		add_filter('wp_redirect', array($this, 'update_on_redirect'), 100, 1);
187 187
 	}
188 188
 
189 189
 
@@ -214,11 +214,11 @@  discard block
 block discarded – undo
214 214
 	 */
215 215
 	private function _set_defaults() {
216 216
 		// set some defaults
217
-		foreach ( $this->_default_session_vars as $key => $default_var ) {
218
-			if ( is_array( $default_var )) {
219
-				$this->_session_data[ $key ] = array();
217
+		foreach ($this->_default_session_vars as $key => $default_var) {
218
+			if (is_array($default_var)) {
219
+				$this->_session_data[$key] = array();
220 220
 			} else {
221
-				$this->_session_data[ $key ] = '';
221
+				$this->_session_data[$key] = '';
222 222
 			}
223 223
 		}
224 224
 	}
@@ -240,7 +240,7 @@  discard block
 block discarded – undo
240 240
 	  * @param \EE_Cart $cart
241 241
 	  * @return bool
242 242
 	  */
243
-	 public function set_cart( EE_Cart $cart ) {
243
+	 public function set_cart(EE_Cart $cart) {
244 244
 		 $this->_session_data['cart'] = $cart;
245 245
 		 return TRUE;
246 246
 	 }
@@ -260,7 +260,7 @@  discard block
 block discarded – undo
260 260
 	  * @return \EE_Cart
261 261
 	  */
262 262
 	 public function cart() {
263
-		 return isset( $this->_session_data['cart'] ) ? $this->_session_data['cart'] : NULL;
263
+		 return isset($this->_session_data['cart']) ? $this->_session_data['cart'] : NULL;
264 264
 	 }
265 265
 
266 266
 
@@ -269,7 +269,7 @@  discard block
 block discarded – undo
269 269
 	  * @param \EE_Checkout $checkout
270 270
 	  * @return bool
271 271
 	  */
272
-	 public function set_checkout( EE_Checkout $checkout ) {
272
+	 public function set_checkout(EE_Checkout $checkout) {
273 273
 		 $this->_session_data['checkout'] = $checkout;
274 274
 		 return TRUE;
275 275
 	 }
@@ -289,7 +289,7 @@  discard block
 block discarded – undo
289 289
 	  * @return \EE_Checkout
290 290
 	  */
291 291
 	 public function checkout() {
292
-		 return isset( $this->_session_data['checkout'] ) ? $this->_session_data['checkout'] : NULL;
292
+		 return isset($this->_session_data['checkout']) ? $this->_session_data['checkout'] : NULL;
293 293
 	 }
294 294
 
295 295
 
@@ -299,9 +299,9 @@  discard block
 block discarded – undo
299 299
 	  * @return bool
300 300
 	  * @throws \EE_Error
301 301
 	  */
302
-	 public function set_transaction( EE_Transaction $transaction ) {
302
+	 public function set_transaction(EE_Transaction $transaction) {
303 303
 		 // first remove the session from the transaction before we save the transaction in the session
304
-		 $transaction->set_txn_session_data( NULL );
304
+		 $transaction->set_txn_session_data(NULL);
305 305
 		 $this->_session_data['transaction'] = $transaction;
306 306
 		 return TRUE;
307 307
 	 }
@@ -321,7 +321,7 @@  discard block
 block discarded – undo
321 321
 	  * @return \EE_Transaction
322 322
 	  */
323 323
 	 public function transaction() {
324
-		 return isset( $this->_session_data['transaction'] ) ? $this->_session_data['transaction'] : NULL;
324
+		 return isset($this->_session_data['transaction']) ? $this->_session_data['transaction'] : NULL;
325 325
 	 }
326 326
 
327 327
 
@@ -333,15 +333,15 @@  discard block
 block discarded – undo
333 333
 	  * @param bool $reset_cache
334 334
 	  * @return    array
335 335
 	  */
336
-	public function get_session_data( $key = NULL, $reset_cache = FALSE ) {
337
-		if ( $reset_cache ) {
336
+	public function get_session_data($key = NULL, $reset_cache = FALSE) {
337
+		if ($reset_cache) {
338 338
 			$this->reset_cart();
339 339
 			$this->reset_checkout();
340 340
 			$this->reset_transaction();
341 341
 		}
342
-		 if ( ! empty( $key ))  {
343
-			return  isset( $this->_session_data[ $key ] ) ? $this->_session_data[ $key ] : NULL;
344
-		}  else  {
342
+		 if ( ! empty($key)) {
343
+			return  isset($this->_session_data[$key]) ? $this->_session_data[$key] : NULL;
344
+		} else {
345 345
 			return $this->_session_data;
346 346
 		}
347 347
 	}
@@ -354,20 +354,20 @@  discard block
 block discarded – undo
354 354
 	  * @param 	array $data
355 355
 	  * @return 	TRUE on success, FALSE on fail
356 356
 	  */
357
-	public function set_session_data( $data ) {
357
+	public function set_session_data($data) {
358 358
 
359 359
 		// nothing ??? bad data ??? go home!
360
-		if ( empty( $data ) || ! is_array( $data )) {
361
-			EE_Error::add_error( __( 'No session data or invalid session data was provided.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
360
+		if (empty($data) || ! is_array($data)) {
361
+			EE_Error::add_error(__('No session data or invalid session data was provided.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
362 362
 			return FALSE;
363 363
 		}
364 364
 
365
-		foreach ( $data as $key =>$value ) {
366
-			if ( isset( $this->_default_session_vars[ $key ] )) {
367
-				EE_Error::add_error( sprintf( __( 'Sorry! %s is a default session datum and can not be reset.', 'event_espresso' ), $key ), __FILE__, __FUNCTION__, __LINE__ );
365
+		foreach ($data as $key =>$value) {
366
+			if (isset($this->_default_session_vars[$key])) {
367
+				EE_Error::add_error(sprintf(__('Sorry! %s is a default session datum and can not be reset.', 'event_espresso'), $key), __FILE__, __FUNCTION__, __LINE__);
368 368
 				return FALSE;
369 369
 			} else {
370
-				$this->_session_data[ $key ] = $value;
370
+				$this->_session_data[$key] = $value;
371 371
 			}
372 372
 		}
373 373
 
@@ -385,9 +385,9 @@  discard block
 block discarded – undo
385 385
 	  * @throws \EE_Error
386 386
 	  */
387 387
 	private function _espresso_session() {
388
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
388
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
389 389
 		// check that session has started
390
-		if ( session_id() === '' ) {
390
+		if (session_id() === '') {
391 391
 			//starts a new session if one doesn't already exist, or re-initiates an existing one
392 392
 			session_start();
393 393
 		}
@@ -396,18 +396,18 @@  discard block
 block discarded – undo
396 396
 		// and the visitors IP
397 397
 		$this->_ip_address = $this->_visitor_ip();
398 398
 		// set the "user agent"
399
-		$this->_user_agent = ( isset($_SERVER['HTTP_USER_AGENT'])) ? esc_attr( $_SERVER['HTTP_USER_AGENT'] ) : FALSE;
399
+		$this->_user_agent = (isset($_SERVER['HTTP_USER_AGENT'])) ? esc_attr($_SERVER['HTTP_USER_AGENT']) : FALSE;
400 400
 		// now let's retrieve what's in the db
401 401
 		// we're using WP's Transient API to store session data using the PHP session ID as the option name
402
-		$session_data = get_transient( EE_Session::session_id_prefix . $this->_sid );
403
-		if ( $session_data ) {
404
-			if ( apply_filters( 'FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG ) ) {
405
-				$hash_check = get_transient( EE_Session::hash_check_prefix . $this->_sid );
406
-				if ( $hash_check && $hash_check !== md5( $session_data ) ) {
402
+		$session_data = get_transient(EE_Session::session_id_prefix.$this->_sid);
403
+		if ($session_data) {
404
+			if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
405
+				$hash_check = get_transient(EE_Session::hash_check_prefix.$this->_sid);
406
+				if ($hash_check && $hash_check !== md5($session_data)) {
407 407
 					EE_Error::add_error(
408 408
 						sprintf(
409
-							__( 'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.', 'event_espresso' ),
410
-							EE_Session::session_id_prefix . $this->_sid
409
+							__('The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.', 'event_espresso'),
410
+							EE_Session::session_id_prefix.$this->_sid
411 411
 						),
412 412
 						__FILE__, __FUNCTION__, __LINE__
413 413
 					);
@@ -416,33 +416,33 @@  discard block
 block discarded – undo
416 416
 			// decode the data ?
417 417
             $session_data = $this->valid_base_64($session_data) ? base64_decode($session_data) : $session_data;
418 418
 			// un-encrypt the data ?
419
-			$session_data = $this->_use_encryption ? $this->encryption->decrypt( $session_data ) : $session_data;
420
-			if ( ! is_array( $session_data ) ) {
419
+			$session_data = $this->_use_encryption ? $this->encryption->decrypt($session_data) : $session_data;
420
+			if ( ! is_array($session_data)) {
421 421
 				try {
422
-					$session_data = maybe_unserialize( $session_data );
423
-				} catch ( Exception $e ) {
422
+					$session_data = maybe_unserialize($session_data);
423
+				} catch (Exception $e) {
424 424
 					$msg = esc_html__(
425 425
 						'An error occurred while attempting to unserialize the session data.',
426 426
 						'event_espresso'
427 427
 					);
428
-					$msg .= WP_DEBUG ? '<br>' . $this->find_serialize_error( $session_data ) : '';
429
-					throw new InvalidSessionDataException( $msg, 0, $e );
428
+					$msg .= WP_DEBUG ? '<br>'.$this->find_serialize_error($session_data) : '';
429
+					throw new InvalidSessionDataException($msg, 0, $e);
430 430
 				}
431 431
 			}
432 432
 			// just a check to make sure the session array is indeed an array
433
-			if ( ! is_array( $session_data ) ) {
433
+			if ( ! is_array($session_data)) {
434 434
 				// no?!?! then something is wrong
435 435
 				$msg = esc_html__(
436 436
 					'The session data is missing, invalid, or corrupted.',
437 437
 					'event_espresso'
438 438
 				);
439
-				$msg .= WP_DEBUG ? '<br>' . $this->find_serialize_error( $session_data ) : '';
440
-				throw new InvalidSessionDataException( $msg );
439
+				$msg .= WP_DEBUG ? '<br>'.$this->find_serialize_error($session_data) : '';
440
+				throw new InvalidSessionDataException($msg);
441 441
 			}
442 442
 			// get the current time in UTC
443
-			$this->_time = isset( $this->_time ) ? $this->_time : time();
443
+			$this->_time = isset($this->_time) ? $this->_time : time();
444 444
 			// and reset the session expiration
445
-			$this->_expiration = isset( $session_data['expiration'] )
445
+			$this->_expiration = isset($session_data['expiration'])
446 446
 				? $session_data['expiration']
447 447
 				: $this->_time + $this->_lifespan;
448 448
 
@@ -450,24 +450,24 @@  discard block
 block discarded – undo
450 450
 			// set initial site access time and the session expiration
451 451
 			$this->_set_init_access_and_expiration();
452 452
 			// set referer
453
-			$this->_session_data[ 'pages_visited' ][ $this->_session_data['init_access'] ] = isset( $_SERVER['HTTP_REFERER'] )
454
-				? esc_attr( $_SERVER['HTTP_REFERER'] )
453
+			$this->_session_data['pages_visited'][$this->_session_data['init_access']] = isset($_SERVER['HTTP_REFERER'])
454
+				? esc_attr($_SERVER['HTTP_REFERER'])
455 455
 				: '';
456 456
 			// no previous session = go back and create one (on top of the data above)
457 457
 			return FALSE;
458 458
 		}
459 459
 		// now the user agent
460
-		if ( $session_data['user_agent'] !== $this->_user_agent ) {
460
+		if ($session_data['user_agent'] !== $this->_user_agent) {
461 461
 			return FALSE;
462 462
 		}
463 463
 		// wait a minute... how old are you?
464
-		if ( $this->_time > $this->_expiration ) {
464
+		if ($this->_time > $this->_expiration) {
465 465
 			// yer too old fer me!
466 466
 			// wipe out everything that isn't a default session datum
467
-			$this->clear_session( __CLASS__, __FUNCTION__ );
467
+			$this->clear_session(__CLASS__, __FUNCTION__);
468 468
 		}
469 469
 		// make event espresso session data available to plugin
470
-		$this->_session_data = array_merge( $this->_session_data, $session_data );
470
+		$this->_session_data = array_merge($this->_session_data, $session_data);
471 471
 		return TRUE;
472 472
 
473 473
 	}
@@ -485,12 +485,12 @@  discard block
 block discarded – undo
485 485
 	  */
486 486
 	protected function _generate_session_id() {
487 487
 		// check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
488
-		if ( isset( $_REQUEST[ 'EESID' ] ) ) {
489
-			$session_id = sanitize_text_field( $_REQUEST[ 'EESID' ] );
488
+		if (isset($_REQUEST['EESID'])) {
489
+			$session_id = sanitize_text_field($_REQUEST['EESID']);
490 490
 		} else {
491
-			$session_id = md5( session_id() . get_current_blog_id() . $this->_get_sid_salt() );
491
+			$session_id = md5(session_id().get_current_blog_id().$this->_get_sid_salt());
492 492
 		}
493
-		return apply_filters( 'FHEE__EE_Session___generate_session_id__session_id', $session_id );
493
+		return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
494 494
 	}
495 495
 
496 496
 
@@ -502,20 +502,20 @@  discard block
 block discarded – undo
502 502
 	  */
503 503
 	protected function _get_sid_salt() {
504 504
 		// was session id salt already saved to db ?
505
-		if ( empty( $this->_sid_salt ) ) {
505
+		if (empty($this->_sid_salt)) {
506 506
 			// no?  then maybe use WP defined constant
507
-			if ( defined( 'AUTH_SALT' ) ) {
507
+			if (defined('AUTH_SALT')) {
508 508
 				$this->_sid_salt = AUTH_SALT;
509 509
 			}
510 510
 			// if salt doesn't exist or is too short
511
-			if ( empty( $this->_sid_salt ) || strlen( $this->_sid_salt ) < 32 ) {
511
+			if (empty($this->_sid_salt) || strlen($this->_sid_salt) < 32) {
512 512
 				// create a new one
513
-				$this->_sid_salt = wp_generate_password( 64 );
513
+				$this->_sid_salt = wp_generate_password(64);
514 514
 			}
515 515
 			// and save it as a permanent session setting
516
-			$session_settings = get_option( 'ee_session_settings' );
517
-			$session_settings[ 'sid_salt' ] = $this->_sid_salt;
518
-			update_option( 'ee_session_settings', $session_settings );
516
+			$session_settings = get_option('ee_session_settings');
517
+			$session_settings['sid_salt'] = $this->_sid_salt;
518
+			update_option('ee_session_settings', $session_settings);
519 519
 		}
520 520
 		return $this->_sid_salt;
521 521
 	}
@@ -543,19 +543,19 @@  discard block
 block discarded – undo
543 543
 	  * @param bool $new_session
544 544
 	  * @return TRUE on success, FALSE on fail
545 545
 	  */
546
-	public function update( $new_session = FALSE ) {
547
-		$this->_session_data = isset( $this->_session_data )
548
-			&& is_array( $this->_session_data )
549
-			&& isset( $this->_session_data['id'])
546
+	public function update($new_session = FALSE) {
547
+		$this->_session_data = isset($this->_session_data)
548
+			&& is_array($this->_session_data)
549
+			&& isset($this->_session_data['id'])
550 550
 			? $this->_session_data
551 551
 			: NULL;
552
-		if ( empty( $this->_session_data )) {
552
+		if (empty($this->_session_data)) {
553 553
 			$this->_set_defaults();
554 554
 		}
555 555
 		$session_data = array();
556
-		foreach ( $this->_session_data as $key => $value ) {
556
+		foreach ($this->_session_data as $key => $value) {
557 557
 
558
-			switch( $key ) {
558
+			switch ($key) {
559 559
 
560 560
 				case 'id' :
561 561
 					// session ID
@@ -573,7 +573,7 @@  discard block
 block discarded – undo
573 573
 				break;
574 574
 
575 575
 				case 'init_access' :
576
-					$session_data['init_access'] = absint( $value );
576
+					$session_data['init_access'] = absint($value);
577 577
 				break;
578 578
 
579 579
 				case 'last_access' :
@@ -583,7 +583,7 @@  discard block
 block discarded – undo
583 583
 
584 584
 				case 'expiration' :
585 585
 					// when the session expires
586
-					$session_data['expiration'] = ! empty( $this->_expiration )
586
+					$session_data['expiration'] = ! empty($this->_expiration)
587 587
 						? $this->_expiration
588 588
 						: $session_data['init_access'] + $this->_lifespan;
589 589
 				break;
@@ -595,11 +595,11 @@  discard block
 block discarded – undo
595 595
 
596 596
 				case 'pages_visited' :
597 597
 					$page_visit = $this->_get_page_visit();
598
-					if ( $page_visit ) {
598
+					if ($page_visit) {
599 599
 						// set pages visited where the first will be the http referrer
600
-						$this->_session_data[ 'pages_visited' ][ $this->_time ] = $page_visit;
600
+						$this->_session_data['pages_visited'][$this->_time] = $page_visit;
601 601
 						// we'll only save the last 10 page visits.
602
-						$session_data[ 'pages_visited' ] = array_slice( $this->_session_data['pages_visited'], -10 );
602
+						$session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
603 603
 					}
604 604
 				break;
605 605
 
@@ -613,9 +613,9 @@  discard block
 block discarded – undo
613 613
 
614 614
 		$this->_session_data = $session_data;
615 615
 		// creating a new session does not require saving to the db just yet
616
-		if ( ! $new_session ) {
616
+		if ( ! $new_session) {
617 617
 			// ready? let's save
618
-			if ( $this->_save_session_to_db() ) {
618
+			if ($this->_save_session_to_db()) {
619 619
 				return TRUE;
620 620
 			} else {
621 621
 				return FALSE;
@@ -637,7 +637,7 @@  discard block
 block discarded – undo
637 637
 	  * @param string $location
638 638
 	  * @return mixed
639 639
 	  */
640
-	 public function update_on_redirect( $location ) {
640
+	 public function update_on_redirect($location) {
641 641
 		 $this->update();
642 642
 		 return $location;
643 643
 	}
@@ -649,9 +649,9 @@  discard block
 block discarded – undo
649 649
 	 * 	@return bool
650 650
 	 */
651 651
 	private function _create_espresso_session( ) {
652
-		do_action( 'AHEE_log', __CLASS__, __FUNCTION__, '' );
652
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
653 653
 		// use the update function for now with $new_session arg set to TRUE
654
-		return  $this->update( TRUE ) ? TRUE : FALSE;
654
+		return  $this->update(TRUE) ? TRUE : FALSE;
655 655
 	}
656 656
 
657 657
 
@@ -678,7 +678,7 @@  discard block
 block discarded – undo
678 678
 				// OR an admin request that is NOT AJAX
679 679
 				|| (
680 680
 					is_admin()
681
-					&& ! ( defined( 'DOING_AJAX' ) && DOING_AJAX )
681
+					&& ! (defined('DOING_AJAX') && DOING_AJAX)
682 682
 				)
683 683
 			)
684 684
 		) {
@@ -691,13 +691,13 @@  discard block
 block discarded – undo
691 691
             $session_data = base64_encode($session_data);
692 692
         }
693 693
 		// encrypt it if we are using encryption
694
-		$session_data = $this->_use_encryption ? $this->encryption->encrypt( $session_data ) : $session_data;
694
+		$session_data = $this->_use_encryption ? $this->encryption->encrypt($session_data) : $session_data;
695 695
 		// maybe save hash check
696
-		if ( apply_filters( 'FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG ) ) {
697
-			set_transient( EE_Session::hash_check_prefix . $this->_sid, md5( $session_data ), $this->_lifespan );
696
+		if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
697
+			set_transient(EE_Session::hash_check_prefix.$this->_sid, md5($session_data), $this->_lifespan);
698 698
 		}
699 699
 		// we're using the Transient API for storing session data, cuz it's so damn simple -> set_transient(  transient ID, data, expiry )
700
-		return set_transient( EE_Session::session_id_prefix . $this->_sid, $session_data, $this->_lifespan );
700
+		return set_transient(EE_Session::session_id_prefix.$this->_sid, $session_data, $this->_lifespan);
701 701
 	}
702 702
 
703 703
 
@@ -723,10 +723,10 @@  discard block
 block discarded – undo
723 723
 			'HTTP_FORWARDED',
724 724
 			'REMOTE_ADDR'
725 725
 		);
726
-		foreach ( $server_keys as $key ){
727
-			if ( isset( $_SERVER[ $key ] )) {
728
-				foreach ( array_map( 'trim', explode( ',', $_SERVER[ $key ] )) as $ip ) {
729
-					if ( $ip === '127.0.0.1' || filter_var( $ip, FILTER_VALIDATE_IP ) !== FALSE ) {
726
+		foreach ($server_keys as $key) {
727
+			if (isset($_SERVER[$key])) {
728
+				foreach (array_map('trim', explode(',', $_SERVER[$key])) as $ip) {
729
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== FALSE) {
730 730
 						$visitor_ip = $ip;
731 731
 					}
732 732
 				}
@@ -745,32 +745,32 @@  discard block
 block discarded – undo
745 745
 	 *			@return string
746 746
 	 */
747 747
 	public function _get_page_visit() {
748
-		$page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
748
+		$page_visit = home_url('/').'wp-admin/admin-ajax.php';
749 749
 		// check for request url
750
-		if ( isset( $_SERVER['REQUEST_URI'] )) {
750
+		if (isset($_SERVER['REQUEST_URI'])) {
751 751
 			$http_host = '';
752 752
 			$page_id = '?';
753 753
 			$e_reg = '';
754
-			$request_uri = esc_url( $_SERVER['REQUEST_URI'] );
755
-			$ru_bits = explode( '?', $request_uri );
754
+			$request_uri = esc_url($_SERVER['REQUEST_URI']);
755
+			$ru_bits = explode('?', $request_uri);
756 756
 			$request_uri = $ru_bits[0];
757 757
 			// check for and grab host as well
758
-			if ( isset( $_SERVER['HTTP_HOST'] )) {
759
-				$http_host = esc_url( $_SERVER['HTTP_HOST'] );
758
+			if (isset($_SERVER['HTTP_HOST'])) {
759
+				$http_host = esc_url($_SERVER['HTTP_HOST']);
760 760
 			}
761 761
 			// check for page_id in SERVER REQUEST
762
-			if ( isset( $_REQUEST['page_id'] )) {
762
+			if (isset($_REQUEST['page_id'])) {
763 763
 				// rebuild $e_reg without any of the extra parameters
764
-				$page_id = '?page_id=' . esc_attr( $_REQUEST['page_id'] ) . '&amp;';
764
+				$page_id = '?page_id='.esc_attr($_REQUEST['page_id']).'&amp;';
765 765
 			}
766 766
 			// check for $e_reg in SERVER REQUEST
767
-			if ( isset( $_REQUEST['ee'] )) {
767
+			if (isset($_REQUEST['ee'])) {
768 768
 				// rebuild $e_reg without any of the extra parameters
769
-				$e_reg = 'ee=' . esc_attr( $_REQUEST['ee'] );
769
+				$e_reg = 'ee='.esc_attr($_REQUEST['ee']);
770 770
 			}
771
-			$page_visit = rtrim( $http_host . $request_uri . $page_id . $e_reg, '?' );
771
+			$page_visit = rtrim($http_host.$request_uri.$page_id.$e_reg, '?');
772 772
 		}
773
-		return $page_visit !== home_url( '/wp-admin/admin-ajax.php' ) ? $page_visit : '';
773
+		return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
774 774
 
775 775
 	}
776 776
 
@@ -799,14 +799,14 @@  discard block
 block discarded – undo
799 799
 	  * @param string $function
800 800
 	  * @return void
801 801
 	  */
802
-	public function clear_session( $class = '', $function = '' ) {
802
+	public function clear_session($class = '', $function = '') {
803 803
 		//echo '<h3 style="color:#999;line-height:.9em;"><span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/><span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b></h3>';
804
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' .  $function . '()' );
804
+		do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : '.$class.'::'.$function.'()');
805 805
 		$this->reset_cart();
806 806
 		$this->reset_checkout();
807 807
 		$this->reset_transaction();
808 808
 		// wipe out everything that isn't a default session datum
809
-		$this->reset_data( array_keys( $this->_session_data ));
809
+		$this->reset_data(array_keys($this->_session_data));
810 810
 		// reset initial site access time and the session expiration
811 811
 		$this->_set_init_access_and_expiration();
812 812
 		$this->_save_session_to_db();
@@ -821,42 +821,42 @@  discard block
 block discarded – undo
821 821
 	  * @param bool  $show_all_notices
822 822
 	  * @return TRUE on success, FALSE on fail
823 823
 	  */
824
-	public function reset_data( $data_to_reset = array(), $show_all_notices = FALSE ) {
824
+	public function reset_data($data_to_reset = array(), $show_all_notices = FALSE) {
825 825
 		// if $data_to_reset is not in an array, then put it in one
826
-		if ( ! is_array( $data_to_reset ) ) {
827
-			$data_to_reset = array ( $data_to_reset );
826
+		if ( ! is_array($data_to_reset)) {
827
+			$data_to_reset = array($data_to_reset);
828 828
 		}
829 829
 		// nothing ??? go home!
830
-		if ( empty( $data_to_reset )) {
831
-			EE_Error::add_error( __( 'No session data could be reset, because no session var name was provided.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
830
+		if (empty($data_to_reset)) {
831
+			EE_Error::add_error(__('No session data could be reset, because no session var name was provided.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
832 832
 			return FALSE;
833 833
 		}
834 834
 		$return_value = TRUE;
835 835
 		// since $data_to_reset is an array, cycle through the values
836
-		foreach ( $data_to_reset as $reset ) {
836
+		foreach ($data_to_reset as $reset) {
837 837
 
838 838
 			// first check to make sure it is a valid session var
839
-			if ( isset( $this->_session_data[ $reset ] )) {
839
+			if (isset($this->_session_data[$reset])) {
840 840
 				// then check to make sure it is not a default var
841
-				if ( ! array_key_exists( $reset, $this->_default_session_vars )) {
841
+				if ( ! array_key_exists($reset, $this->_default_session_vars)) {
842 842
 					// remove session var
843
-					unset( $this->_session_data[ $reset ] );
844
-					if ( $show_all_notices ) {
845
-						EE_Error::add_success( sprintf( __( 'The session variable %s was removed.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
843
+					unset($this->_session_data[$reset]);
844
+					if ($show_all_notices) {
845
+						EE_Error::add_success(sprintf(__('The session variable %s was removed.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
846 846
 					}
847
-					$return_value = !isset($return_value) ? TRUE : $return_value;
847
+					$return_value = ! isset($return_value) ? TRUE : $return_value;
848 848
 
849 849
 				} else {
850 850
 					// yeeeeeeeeerrrrrrrrrrr OUT !!!!
851
-					if ( $show_all_notices ) {
852
-						EE_Error::add_error( sprintf( __( 'Sorry! %s is a default session datum and can not be reset.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
851
+					if ($show_all_notices) {
852
+						EE_Error::add_error(sprintf(__('Sorry! %s is a default session datum and can not be reset.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
853 853
 					}
854 854
 					$return_value = FALSE;
855 855
 				}
856 856
 
857
-			} else if ( $show_all_notices ) {
857
+			} else if ($show_all_notices) {
858 858
 				// oops! that session var does not exist!
859
-				EE_Error::add_error( sprintf( __( 'The session item provided, %s, is invalid or does not exist.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
859
+				EE_Error::add_error(sprintf(__('The session item provided, %s, is invalid or does not exist.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
860 860
 				$return_value = FALSE;
861 861
 			}
862 862
 
@@ -876,8 +876,8 @@  discard block
 block discarded – undo
876 876
 	 *   @access public
877 877
 	 */
878 878
 	public function wp_loaded() {
879
-		if ( isset(  EE_Registry::instance()->REQ ) && EE_Registry::instance()->REQ->is_set( 'clear_session' )) {
880
-			$this->clear_session( __CLASS__, __FUNCTION__ );
879
+		if (isset(EE_Registry::instance()->REQ) && EE_Registry::instance()->REQ->is_set('clear_session')) {
880
+			$this->clear_session(__CLASS__, __FUNCTION__);
881 881
 		}
882 882
 	}
883 883
 
@@ -902,24 +902,24 @@  discard block
 block discarded – undo
902 902
 	  */
903 903
 	 public function garbage_collection() {
904 904
 		 // only perform during regular requests
905
-		 if ( ! defined( 'DOING_AJAX') || ! DOING_AJAX ) {
905
+		 if ( ! defined('DOING_AJAX') || ! DOING_AJAX) {
906 906
 			 /** @type WPDB $wpdb */
907 907
 			 global $wpdb;
908 908
 			 // since transient expiration timestamps are set in the future, we can compare against NOW
909 909
 			 $expiration = time();
910
-			 $too_far_in_the_the_future = $expiration + ( $this->_lifespan * 2 );
910
+			 $too_far_in_the_the_future = $expiration + ($this->_lifespan * 2);
911 911
 			 // filter the query limit. Set to 0 to turn off garbage collection
912
-			 $expired_session_transient_delete_query_limit = absint( apply_filters( 'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit', 50 ));
912
+			 $expired_session_transient_delete_query_limit = absint(apply_filters('FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit', 50));
913 913
 			 // non-zero LIMIT means take out the trash
914
-			 if ( $expired_session_transient_delete_query_limit ) {
914
+			 if ($expired_session_transient_delete_query_limit) {
915 915
 				 //array of transient keys that require garbage collection
916 916
 				 $session_keys = array(
917 917
 					 EE_Session::session_id_prefix,
918 918
 					 EE_Session::hash_check_prefix,
919 919
 				 );
920
-				 foreach ( $session_keys as $session_key ) {
921
-					 $session_key = str_replace( '_', '\_', $session_key );
922
-					 $session_key = '\_transient\_timeout\_' . $session_key . '%';
920
+				 foreach ($session_keys as $session_key) {
921
+					 $session_key = str_replace('_', '\_', $session_key);
922
+					 $session_key = '\_transient\_timeout\_'.$session_key.'%';
923 923
 					 $SQL = "
924 924
 					SELECT option_name
925 925
 					FROM {$wpdb->options}
@@ -929,25 +929,25 @@  discard block
 block discarded – undo
929 929
 					OR option_value > {$too_far_in_the_the_future} )
930 930
 					LIMIT {$expired_session_transient_delete_query_limit}
931 931
 				";
932
-					 $expired_sessions = $wpdb->get_col( $SQL );
932
+					 $expired_sessions = $wpdb->get_col($SQL);
933 933
 					 // valid results?
934
-					 if ( ! $expired_sessions instanceof WP_Error && ! empty( $expired_sessions ) ) {
934
+					 if ( ! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
935 935
 						 // format array of results into something usable within the actual DELETE query's IN clause
936 936
 						 $expired = array();
937
-						 foreach ( $expired_sessions as $expired_session ) {
938
-							 $expired[ ] = "'" . $expired_session . "'";
939
-							 $expired[ ] = "'" . str_replace( 'timeout_', '', $expired_session ) . "'";
937
+						 foreach ($expired_sessions as $expired_session) {
938
+							 $expired[] = "'".$expired_session."'";
939
+							 $expired[] = "'".str_replace('timeout_', '', $expired_session)."'";
940 940
 						 }
941
-						 $expired = implode( ', ', $expired );
941
+						 $expired = implode(', ', $expired);
942 942
 						 $SQL = "
943 943
 						DELETE FROM {$wpdb->options}
944 944
 						WHERE option_name
945 945
 						IN ( $expired );
946 946
 					 ";
947
-						 $results = $wpdb->query( $SQL );
947
+						 $results = $wpdb->query($SQL);
948 948
 						 // if something went wrong, then notify the admin
949
-						 if ( $results instanceof WP_Error && is_admin() ) {
950
-							 EE_Error::add_error( $results->get_error_message(), __FILE__, __FUNCTION__, __LINE__ );
949
+						 if ($results instanceof WP_Error && is_admin()) {
950
+							 EE_Error::add_error($results->get_error_message(), __FILE__, __FUNCTION__, __LINE__);
951 951
 						 }
952 952
 					 }
953 953
 				 }
@@ -968,22 +968,22 @@  discard block
 block discarded – undo
968 968
 	  * @param $string
969 969
 	  * @return bool
970 970
 	  */
971
-	 private function valid_base_64( $string ) {
971
+	 private function valid_base_64($string) {
972 972
          // ensure data is a string
973 973
          if ( ! is_string($string)) {
974 974
              return false;
975 975
          }
976
-		 $decoded = base64_decode( $string, true );
976
+		 $decoded = base64_decode($string, true);
977 977
 		 // Check if there is no invalid character in string
978
-		 if ( ! preg_match( '/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string ) ) {
978
+		 if ( ! preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string)) {
979 979
 			 return false;
980 980
 		 }
981 981
 		 // Decode the string in strict mode and send the response
982
-		 if ( ! base64_decode( $string, true ) ) {
982
+		 if ( ! base64_decode($string, true)) {
983 983
 			 return false;
984 984
 		 }
985 985
 		 // Encode and compare it to original one
986
-		 return base64_encode( $decoded ) === $string;
986
+		 return base64_encode($decoded) === $string;
987 987
 	 }
988 988
 
989 989
 
@@ -993,34 +993,34 @@  discard block
 block discarded – undo
993 993
 	  * @param $data1
994 994
 	  * @return string
995 995
 	  */
996
-	 private function find_serialize_error( $data1 ) {
996
+	 private function find_serialize_error($data1) {
997 997
 		$error = "<pre>";
998 998
 		 $data2 = preg_replace_callback(
999 999
 			 '!s:(\d+):"(.*?)";!',
1000
-			 function ( $match ) {
1001
-				 return ( $match[1] === strlen( $match[2] ) )
1000
+			 function($match) {
1001
+				 return ($match[1] === strlen($match[2]))
1002 1002
 					 ? $match[0]
1003 1003
 					 : 's:'
1004
-					   . strlen( $match[2] )
1004
+					   . strlen($match[2])
1005 1005
 					   . ':"'
1006 1006
 					   . $match[2]
1007 1007
 					   . '";';
1008 1008
 			 },
1009 1009
 			 $data1
1010 1010
 		 );
1011
-		$max = ( strlen( $data1 ) > strlen( $data2 ) ) ? strlen( $data1 ) : strlen( $data2 );
1012
-		$error .= $data1 . PHP_EOL;
1013
-		$error .= $data2 . PHP_EOL;
1014
-		for ( $i = 0; $i < $max; $i++ ) {
1015
-			if ( @$data1[ $i ] !== @$data2[ $i ] ) {
1016
-				$error .= "Difference " . @$data1[ $i ] . " != " . @$data2[ $i ] . PHP_EOL;
1017
-				$error .= "\t-> ORD number " . ord( @$data1[ $i ] ) . " != " . ord( @$data2[ $i ] ) . PHP_EOL;
1018
-				$error .= "\t-> Line Number = $i" . PHP_EOL;
1019
-				$start = ( $i - 20 );
1020
-				$start = ( $start < 0 ) ? 0 : $start;
1011
+		$max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
1012
+		$error .= $data1.PHP_EOL;
1013
+		$error .= $data2.PHP_EOL;
1014
+		for ($i = 0; $i < $max; $i++) {
1015
+			if (@$data1[$i] !== @$data2[$i]) {
1016
+				$error .= "Difference ".@$data1[$i]." != ".@$data2[$i].PHP_EOL;
1017
+				$error .= "\t-> ORD number ".ord(@$data1[$i])." != ".ord(@$data2[$i]).PHP_EOL;
1018
+				$error .= "\t-> Line Number = $i".PHP_EOL;
1019
+				$start = ($i - 20);
1020
+				$start = ($start < 0) ? 0 : $start;
1021 1021
 				$length = 40;
1022 1022
 				$point = $max - $i;
1023
-				if ( $point < 20 ) {
1023
+				if ($point < 20) {
1024 1024
 					$rlength = 1;
1025 1025
 					$rpoint = -$point;
1026 1026
 				} else {
@@ -1029,16 +1029,16 @@  discard block
 block discarded – undo
1029 1029
 				}
1030 1030
 				$error .= "\t-> Section Data1  = ";
1031 1031
 				$error .= substr_replace(
1032
-					substr( $data1, $start, $length ),
1033
-					"<b style=\"color:green\">{$data1[ $i ]}</b>",
1032
+					substr($data1, $start, $length),
1033
+					"<b style=\"color:green\">{$data1[$i]}</b>",
1034 1034
 					$rpoint,
1035 1035
 					$rlength
1036 1036
 				);
1037 1037
 				$error .= PHP_EOL;
1038 1038
 				$error .= "\t-> Section Data2  = ";
1039 1039
 				$error .= substr_replace(
1040
-					substr( $data2, $start, $length ),
1041
-					"<b style=\"color:red\">{$data2[ $i ]}</b>",
1040
+					substr($data2, $start, $length),
1041
+					"<b style=\"color:red\">{$data2[$i]}</b>",
1042 1042
 					$rpoint,
1043 1043
 					$rlength
1044 1044
 				);
Please login to merge, or discard this patch.
admin_pages/maintenance/Maintenance_Admin_Page.core.php 2 patches
Indentation   +542 added lines, -542 removed lines patch added patch discarded remove patch
@@ -1,6 +1,6 @@  discard block
 block discarded – undo
1 1
 <?php
2 2
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
3
-    exit('NO direct script access allowed');
3
+	exit('NO direct script access allowed');
4 4
 }
5 5
 
6 6
 
@@ -28,562 +28,562 @@  discard block
 block discarded – undo
28 28
 {
29 29
 
30 30
 
31
-    public function __construct($routing = true)
32
-    {
33
-        parent::__construct($routing);
34
-    }
35
-
36
-
37
-
38
-    protected function _init_page_props()
39
-    {
40
-        $this->page_slug = EE_MAINTENANCE_PG_SLUG;
41
-        $this->page_label = EE_MAINTENANCE_LABEL;
42
-        $this->_admin_base_url = EE_MAINTENANCE_ADMIN_URL;
43
-        $this->_admin_base_path = EE_MAINTENANCE_ADMIN;
44
-    }
45
-
46
-
47
-
48
-    protected function _ajax_hooks()
49
-    {
50
-        add_action('wp_ajax_migration_step', array($this, 'migration_step'));
51
-        add_action('wp_ajax_add_error_to_migrations_ran', array($this, 'add_error_to_migrations_ran'));
52
-    }
53
-
54
-
55
-
56
-    protected function _define_page_props()
57
-    {
58
-        $this->_admin_page_title = EE_MAINTENANCE_LABEL;
59
-        $this->_labels = array(
60
-            'buttons' => array(
61
-                'reset_capabilities' => __('Reset Event Espresso Capabilities', 'event_espresso'),
62
-            ),
63
-        );
64
-    }
65
-
66
-
67
-
68
-    protected function _set_page_routes()
69
-    {
70
-        $this->_page_routes = array(
71
-            'default'                             => array(
72
-                'func'       => '_maintenance',
73
-                'capability' => 'manage_options',
74
-            ),
75
-            'change_maintenance_level'            => array(
76
-                'func'       => '_change_maintenance_level',
77
-                'capability' => 'manage_options',
78
-                'noheader'   => true,
79
-            ),
80
-            'system_status'                       => array(
81
-                'func'       => '_system_status',
82
-                'capability' => 'manage_options',
83
-            ),
84
-            'send_migration_crash_report'         => array(
85
-                'func'       => '_send_migration_crash_report',
86
-                'capability' => 'manage_options',
87
-                'noheader'   => true,
88
-            ),
89
-            'confirm_migration_crash_report_sent' => array(
90
-                'func'       => '_confirm_migration_crash_report_sent',
91
-                'capability' => 'manage_options',
92
-            ),
93
-            'data_reset'                          => array(
94
-                'func'       => '_data_reset_and_delete',
95
-                'capability' => 'manage_options',
96
-            ),
97
-            'reset_db'                            => array(
98
-                'func'       => '_reset_db',
99
-                'capability' => 'manage_options',
100
-                'noheader'   => true,
101
-                'args'       => array('nuke_old_ee4_data' => true),
102
-            ),
103
-            'start_with_fresh_ee4_db'             => array(
104
-                'func'       => '_reset_db',
105
-                'capability' => 'manage_options',
106
-                'noheader'   => true,
107
-                'args'       => array('nuke_old_ee4_data' => false),
108
-            ),
109
-            'delete_db'                           => array(
110
-                'func'       => '_delete_db',
111
-                'capability' => 'manage_options',
112
-                'noheader'   => true,
113
-            ),
114
-            'rerun_migration_from_ee3'            => array(
115
-                'func'       => '_rerun_migration_from_ee3',
116
-                'capability' => 'manage_options',
117
-                'noheader'   => true,
118
-            ),
119
-            'reset_capabilities'                  => array(
120
-                'func'       => '_reset_capabilities',
121
-                'capability' => 'manage_options',
122
-                'noheader'   => true,
123
-            ),
124
-            'reattempt_migration'                 => array(
125
-                'func'       => '_reattempt_migration',
126
-                'capability' => 'manage_options',
127
-                'noheader'   => true,
128
-            ),
129
-        );
130
-    }
131
-
132
-
133
-
134
-    protected function _set_page_config()
135
-    {
136
-        $this->_page_config = array(
137
-            'default'       => array(
138
-                'nav'           => array(
139
-                    'label' => __('Maintenance', 'event_espresso'),
140
-                    'order' => 10,
141
-                ),
142
-                'require_nonce' => false,
143
-            ),
144
-            'data_reset'    => array(
145
-                'nav'           => array(
146
-                    'label' => __('Reset/Delete Data', 'event_espresso'),
147
-                    'order' => 20,
148
-                ),
149
-                'require_nonce' => false,
150
-            ),
151
-            'system_status' => array(
152
-                'nav'           => array(
153
-                    'label' => __("System Information", "event_espresso"),
154
-                    'order' => 30,
155
-                ),
156
-                'require_nonce' => false,
157
-            ),
158
-        );
159
-    }
160
-
161
-
162
-
163
-    /**
164
-     * default maintenance page. If we're in maintenance mode level 2, then we need to show
165
-     * the migration scripts and all that UI.
166
-     */
167
-    public function _maintenance()
168
-    {
169
-        //it all depends if we're in maintenance model level 1 (frontend-only) or
170
-        //level 2 (everything except maintenance page)
171
-        try {
172
-            //get the current maintenance level and check if
173
-            //we are removed
174
-            $mm = EE_Maintenance_Mode::instance()->level();
175
-            $placed_in_mm = EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
176
-            if ($mm == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) {
177
-                //we just took the site out of maintenance mode, so notify the user.
178
-                //unfortunately this message appears to be echoed on the NEXT page load...
179
-                //oh well, we should really be checking for this on addon deactivation anyways
180
-                EE_Error::add_attention(__('Site taken out of maintenance mode because no data migration scripts are required',
181
-                    'event_espresso'));
182
-                $this->_process_notices(array('page' => 'espresso_maintenance_settings'), false);
183
-            }
184
-            //in case an exception is thrown while trying to handle migrations
185
-            switch (EE_Maintenance_Mode::instance()->level()) {
186
-                case EE_Maintenance_Mode::level_0_not_in_maintenance:
187
-                case EE_Maintenance_Mode::level_1_frontend_only_maintenance:
188
-                    $show_maintenance_switch = true;
189
-                    $show_backup_db_text = false;
190
-                    $show_migration_progress = false;
191
-                    $script_names = array();
192
-                    $addons_should_be_upgraded_first = false;
193
-                    break;
194
-                case EE_Maintenance_Mode::level_2_complete_maintenance:
195
-                    $show_maintenance_switch = false;
196
-                    $show_migration_progress = true;
197
-                    if (isset($this->_req_data['continue_migration'])) {
198
-                        $show_backup_db_text = false;
199
-                    } else {
200
-                        $show_backup_db_text = true;
201
-                    }
202
-                    $scripts_needing_to_run = EE_Data_Migration_Manager::instance()
203
-                                                                       ->check_for_applicable_data_migration_scripts();
204
-                    $addons_should_be_upgraded_first = EE_Data_Migration_Manager::instance()->addons_need_updating();
205
-                    $script_names = array();
206
-                    $current_script = null;
207
-                    foreach ($scripts_needing_to_run as $script) {
208
-                        if ($script instanceof EE_Data_Migration_Script_Base) {
209
-                            if ( ! $current_script) {
210
-                                $current_script = $script;
211
-                                $current_script->migration_page_hooks();
212
-                            }
213
-                            $script_names[] = $script->pretty_name();
214
-                        }
215
-                    }
216
-                    break;
217
-            }
218
-            $most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
219
-            $exception_thrown = false;
220
-        } catch (EE_Error $e) {
221
-            EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
222
-            //now, just so we can display the page correctly, make a error migration script stage object
223
-            //and also put the error on it. It only persists for the duration of this request
224
-            $most_recent_migration = new EE_DMS_Unknown_1_0_0();
225
-            $most_recent_migration->add_error($e->getMessage());
226
-            $exception_thrown = true;
227
-        }
228
-        $current_db_state = EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set();
229
-        $current_db_state = str_replace('.decaf', '', $current_db_state);
230
-        if ($exception_thrown
231
-            || ($most_recent_migration
232
-                && $most_recent_migration instanceof EE_Data_Migration_Script_Base
233
-                && $most_recent_migration->is_broken()
234
-            )
235
-        ) {
236
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
237
-            $this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/';
238
-            $this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce(array('action'  => 'confirm_migration_crash_report_sent',
239
-                                                                                        'success' => '0',
240
-            ), EE_MAINTENANCE_ADMIN_URL);
241
-        } elseif ($addons_should_be_upgraded_first) {
242
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
243
-        } else {
244
-            if ($most_recent_migration
245
-                && $most_recent_migration instanceof EE_Data_Migration_Script_Base
246
-                && $most_recent_migration->can_continue()
247
-            ) {
248
-                $show_backup_db_text = false;
249
-                $show_continue_current_migration_script = true;
250
-                $show_most_recent_migration = true;
251
-            } elseif (isset($this->_req_data['continue_migration'])) {
252
-                $show_most_recent_migration = true;
253
-                $show_continue_current_migration_script = false;
254
-            } else {
255
-                $show_most_recent_migration = false;
256
-                $show_continue_current_migration_script = false;
257
-            }
258
-            if (isset($current_script)) {
259
-                $migrates_to = $current_script->migrates_to_version();
260
-                $plugin_slug = $migrates_to['slug'];
261
-                $new_version = $migrates_to['version'];
262
-                $this->_template_args = array_merge($this->_template_args, array(
263
-                    'current_db_state' => sprintf(__("EE%s (%s)", "event_espresso"),
264
-                        isset($current_db_state[$plugin_slug]) ? $current_db_state[$plugin_slug] : 3, $plugin_slug),
265
-                    'next_db_state'    => isset($current_script) ? sprintf(__("EE%s (%s)", 'event_espresso'),
266
-                        $new_version, $plugin_slug) : null,
267
-                ));
268
-            }
269
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
270
-            $this->_template_args = array_merge(
271
-                $this->_template_args,
272
-                array(
273
-                    'show_most_recent_migration'             => $show_most_recent_migration,
274
-                    //flag for showing the most recent migration's status and/or errors
275
-                    'show_migration_progress'                => $show_migration_progress,
276
-                    //flag for showing the option to run migrations and see their progress
277
-                    'show_backup_db_text'                    => $show_backup_db_text,
278
-                    //flag for showing text telling the user to backup their DB
279
-                    'show_maintenance_switch'                => $show_maintenance_switch,
280
-                    //flag for showing the option to change maintenance mode between levels 0 and 1
281
-                    'script_names'                           => $script_names,
282
-                    //array of names of scripts that have run
283
-                    'show_continue_current_migration_script' => $show_continue_current_migration_script,
284
-                    //flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
285
-                    'reset_db_page_link'                     => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reset_db'),
286
-                        EE_MAINTENANCE_ADMIN_URL),
287
-                    'update_migration_script_page_link'      => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'change_maintenance_level'),
288
-                        EE_MAINTENANCE_ADMIN_URL),
289
-                    'ultimate_db_state'                      => sprintf(__("EE%s", 'event_espresso'),
290
-                        espresso_version()),
291
-                )
292
-            );
293
-            //make sure we have the form fields helper available. It usually is, but sometimes it isn't
294
-            //localize script stuff
295
-            wp_localize_script('ee-maintenance', 'ee_maintenance', array(
296
-                'migrating'                        => __("Migrating...", "event_espresso"),
297
-                'next'                             => __("Next", "event_espresso"),
298
-                'fatal_error'                      => __("A Fatal Error Has Occurred", "event_espresso"),
299
-                'click_next_when_ready'            => __("The current Migration has ended. Click 'next' when ready to proceed",
300
-                    "event_espresso"),
301
-                'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts,
302
-                'status_fatal_error'               => EE_Data_Migration_Manager::status_fatal_error,
303
-                'status_completed'                 => EE_Data_Migration_Manager::status_completed,
304
-            ));
305
-        }
306
-        $this->_template_args['most_recent_migration'] = $most_recent_migration;//the actual most recently ran migration
307
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
308
-            $this->_template_args, true);
309
-        $this->display_admin_page_with_sidebar();
310
-    }
311
-
312
-
313
-
314
-    /**
315
-     * returns JSON and executes another step of the currently-executing data migration (called via ajax)
316
-     */
317
-    public function migration_step()
318
-    {
319
-        $this->_template_args['data'] = EE_Data_Migration_Manager::instance()->response_to_migration_ajax_request();
320
-        $this->_return_json();
321
-    }
322
-
323
-
324
-
325
-    /**
326
-     * Can be used by js when it notices a response with HTML in it in order
327
-     * to log the malformed response
328
-     */
329
-    public function add_error_to_migrations_ran()
330
-    {
331
-        EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($this->_req_data['message']);
332
-        $this->_template_args['data'] = array('ok' => true);
333
-        $this->_return_json();
334
-    }
335
-
336
-
337
-
338
-    /**
339
-     * changes the maintenance level, provided there are still no migration scripts that shoudl run
340
-     */
341
-    public function _change_maintenance_level()
342
-    {
343
-        $new_level = intval($this->_req_data['maintenance_mode_level']);
344
-        if ( ! EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
345
-            EE_Maintenance_Mode::instance()->set_maintenance_level($new_level);
346
-            $success = true;
347
-        } else {
348
-            EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
349
-            $success = false;
350
-        }
351
-        $this->_redirect_after_action($success, 'Maintenance Mode', __("Updated", "event_espresso"));
352
-    }
353
-
354
-
355
-
356
-    /**
357
-     * a tab with options for resetting and/or deleting EE data
358
-     *
359
-     * @throws \EE_Error
360
-     */
361
-    public function _data_reset_and_delete()
362
-    {
363
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
364
-        $this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button(
365
-            'reset_capabilities',
366
-            'reset_capabilities',
367
-            array(),
368
-            'button button-primary',
369
-            '',
370
-            false
371
-        );
372
-        $this->_template_args['delete_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
373
-            array('action' => 'delete_db'),
374
-            EE_MAINTENANCE_ADMIN_URL
375
-        );
376
-        $this->_template_args['reset_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
377
-            array('action' => 'reset_db'),
378
-            EE_MAINTENANCE_ADMIN_URL
379
-        );
380
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
381
-            $this->_template_path,
382
-            $this->_template_args,
383
-            true
384
-        );
385
-        $this->display_admin_page_with_sidebar();
386
-    }
387
-
388
-
389
-
390
-    protected function _reset_capabilities()
391
-    {
392
-        EE_Registry::instance()->CAP->init_caps(true);
393
-        EE_Error::add_success(__('Default Event Espresso capabilities have been restored for all current roles.',
394
-            'event_espresso'));
395
-        $this->_redirect_after_action(false, '', '', array('action' => 'data_reset'), true);
396
-    }
397
-
398
-
399
-
400
-    /**
401
-     * resets the DMSs so we can attempt to continue migrating after a fatal error
402
-     * (only a good idea when someone has somehow tried ot fix whatever caused
403
-     * the fatal error in teh first place)
404
-     */
405
-    protected function _reattempt_migration()
406
-    {
407
-        EE_Data_Migration_Manager::instance()->reattempt();
408
-        $this->_redirect_after_action(false, '', '', array('action' => 'default'), true);
409
-    }
410
-
411
-
412
-
413
-    /**
414
-     * shows the big ol' System Information page
415
-     */
416
-    public function _system_status()
417
-    {
418
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
419
-        $this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati();
420
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
421
-            $this->_template_args, true);
422
-        $this->display_admin_page_with_sidebar();
423
-    }
424
-
425
-
426
-
427
-    public function _send_migration_crash_report()
428
-    {
429
-        $from = $this->_req_data['from'];
430
-        $from_name = $this->_req_data['from_name'];
431
-        $body = $this->_req_data['body'];
432
-        try {
433
-            $success = wp_mail(EE_SUPPORT_EMAIL,
434
-                'Migration Crash Report',
435
-                $body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
436
-                array(
437
-                    "from:$from_name<$from>",
438
-                    //					'content-type:text/html charset=UTF-8'
439
-                ));
440
-        } catch (Exception $e) {
441
-            $success = false;
442
-        }
443
-        $this->_redirect_after_action($success, __("Migration Crash Report", "event_espresso"),
444
-            __("sent", "event_espresso"),
445
-            array('success' => $success, 'action' => 'confirm_migration_crash_report_sent'));
446
-    }
447
-
448
-
449
-
450
-    public function _confirm_migration_crash_report_sent()
451
-    {
452
-        try {
453
-            $most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
454
-        } catch (EE_Error $e) {
455
-            EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
456
-            //now, just so we can display the page correctly, make a error migration script stage object
457
-            //and also put the error on it. It only persists for the duration of this request
458
-            $most_recent_migration = new EE_DMS_Unknown_1_0_0();
459
-            $most_recent_migration->add_error($e->getMessage());
460
-        }
461
-        $success = $this->_req_data['success'] == '1' ? true : false;
462
-        $this->_template_args['success'] = $success;
463
-        $this->_template_args['most_recent_migration'] = $most_recent_migration;
464
-        $this->_template_args['reset_db_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reset_db'),
465
-            EE_MAINTENANCE_ADMIN_URL);
466
-        $this->_template_args['reset_db_page_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'data_reset'),
467
-            EE_MAINTENANCE_ADMIN_URL);
468
-        $this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reattempt_migration'),
469
-            EE_MAINTENANCE_ADMIN_URL);
470
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
471
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
472
-            $this->_template_args, true);
473
-        $this->display_admin_page_with_sidebar();
474
-    }
475
-
476
-
477
-
478
-    /**
479
-     * Resets the entire EE4 database.
480
-     * Currently basically only sets up ee4 database for a fresh install- doesn't
481
-     * actually clean out the old wp options, or cpts (although does erase old ee table data)
482
-     *
483
-     * @param boolean $nuke_old_ee4_data controls whether or not we
484
-     *                                   destroy the old ee4 data, or just try initializing ee4 default data
485
-     */
486
-    public function _reset_db($nuke_old_ee4_data = true)
487
-    {
488
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
489
-        if ($nuke_old_ee4_data) {
490
-            EEH_Activation::delete_all_espresso_cpt_data();
491
-            EEH_Activation::delete_all_espresso_tables_and_data(false);
492
-            EEH_Activation::remove_cron_tasks();
493
-        }
494
-        //make sure when we reset the registry's config that it
495
-        //switches to using the new singleton
496
-        EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true);
497
-        EE_System::instance()->initialize_db_if_no_migrations_required(true);
498
-        EE_System::instance()->redirect_to_about_ee();
499
-    }
500
-
501
-
502
-
503
-    /**
504
-     * Deletes ALL EE tables, Records, and Options from the database.
505
-     */
506
-    public function _delete_db()
507
-    {
508
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
509
-        EEH_Activation::delete_all_espresso_cpt_data();
510
-        EEH_Activation::delete_all_espresso_tables_and_data();
511
-        EEH_Activation::remove_cron_tasks();
512
-        EEH_Activation::deactivate_event_espresso();
513
-        wp_safe_redirect(admin_url('plugins.php'));
514
-        exit;
515
-    }
516
-
517
-
518
-
519
-    /**
520
-     * sets up EE4 to rerun the migrations from ee3 to ee4
521
-     */
522
-    public function _rerun_migration_from_ee3()
523
-    {
524
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
525
-        EEH_Activation::delete_all_espresso_cpt_data();
526
-        EEH_Activation::delete_all_espresso_tables_and_data(false);
527
-        //set the db state to something that will require migrations
528
-        update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0');
529
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance);
530
-        $this->_redirect_after_action(true, __("Database", 'event_espresso'), __("reset", 'event_espresso'));
531
-    }
532
-
533
-
534
-
535
-    //none of the below group are currently used for Gateway Settings
536
-    protected function _add_screen_options()
537
-    {
538
-    }
539
-
540
-
541
-
542
-    protected function _add_feature_pointers()
543
-    {
544
-    }
545
-
31
+	public function __construct($routing = true)
32
+	{
33
+		parent::__construct($routing);
34
+	}
35
+
36
+
37
+
38
+	protected function _init_page_props()
39
+	{
40
+		$this->page_slug = EE_MAINTENANCE_PG_SLUG;
41
+		$this->page_label = EE_MAINTENANCE_LABEL;
42
+		$this->_admin_base_url = EE_MAINTENANCE_ADMIN_URL;
43
+		$this->_admin_base_path = EE_MAINTENANCE_ADMIN;
44
+	}
45
+
46
+
47
+
48
+	protected function _ajax_hooks()
49
+	{
50
+		add_action('wp_ajax_migration_step', array($this, 'migration_step'));
51
+		add_action('wp_ajax_add_error_to_migrations_ran', array($this, 'add_error_to_migrations_ran'));
52
+	}
53
+
54
+
55
+
56
+	protected function _define_page_props()
57
+	{
58
+		$this->_admin_page_title = EE_MAINTENANCE_LABEL;
59
+		$this->_labels = array(
60
+			'buttons' => array(
61
+				'reset_capabilities' => __('Reset Event Espresso Capabilities', 'event_espresso'),
62
+			),
63
+		);
64
+	}
65
+
66
+
67
+
68
+	protected function _set_page_routes()
69
+	{
70
+		$this->_page_routes = array(
71
+			'default'                             => array(
72
+				'func'       => '_maintenance',
73
+				'capability' => 'manage_options',
74
+			),
75
+			'change_maintenance_level'            => array(
76
+				'func'       => '_change_maintenance_level',
77
+				'capability' => 'manage_options',
78
+				'noheader'   => true,
79
+			),
80
+			'system_status'                       => array(
81
+				'func'       => '_system_status',
82
+				'capability' => 'manage_options',
83
+			),
84
+			'send_migration_crash_report'         => array(
85
+				'func'       => '_send_migration_crash_report',
86
+				'capability' => 'manage_options',
87
+				'noheader'   => true,
88
+			),
89
+			'confirm_migration_crash_report_sent' => array(
90
+				'func'       => '_confirm_migration_crash_report_sent',
91
+				'capability' => 'manage_options',
92
+			),
93
+			'data_reset'                          => array(
94
+				'func'       => '_data_reset_and_delete',
95
+				'capability' => 'manage_options',
96
+			),
97
+			'reset_db'                            => array(
98
+				'func'       => '_reset_db',
99
+				'capability' => 'manage_options',
100
+				'noheader'   => true,
101
+				'args'       => array('nuke_old_ee4_data' => true),
102
+			),
103
+			'start_with_fresh_ee4_db'             => array(
104
+				'func'       => '_reset_db',
105
+				'capability' => 'manage_options',
106
+				'noheader'   => true,
107
+				'args'       => array('nuke_old_ee4_data' => false),
108
+			),
109
+			'delete_db'                           => array(
110
+				'func'       => '_delete_db',
111
+				'capability' => 'manage_options',
112
+				'noheader'   => true,
113
+			),
114
+			'rerun_migration_from_ee3'            => array(
115
+				'func'       => '_rerun_migration_from_ee3',
116
+				'capability' => 'manage_options',
117
+				'noheader'   => true,
118
+			),
119
+			'reset_capabilities'                  => array(
120
+				'func'       => '_reset_capabilities',
121
+				'capability' => 'manage_options',
122
+				'noheader'   => true,
123
+			),
124
+			'reattempt_migration'                 => array(
125
+				'func'       => '_reattempt_migration',
126
+				'capability' => 'manage_options',
127
+				'noheader'   => true,
128
+			),
129
+		);
130
+	}
131
+
132
+
133
+
134
+	protected function _set_page_config()
135
+	{
136
+		$this->_page_config = array(
137
+			'default'       => array(
138
+				'nav'           => array(
139
+					'label' => __('Maintenance', 'event_espresso'),
140
+					'order' => 10,
141
+				),
142
+				'require_nonce' => false,
143
+			),
144
+			'data_reset'    => array(
145
+				'nav'           => array(
146
+					'label' => __('Reset/Delete Data', 'event_espresso'),
147
+					'order' => 20,
148
+				),
149
+				'require_nonce' => false,
150
+			),
151
+			'system_status' => array(
152
+				'nav'           => array(
153
+					'label' => __("System Information", "event_espresso"),
154
+					'order' => 30,
155
+				),
156
+				'require_nonce' => false,
157
+			),
158
+		);
159
+	}
160
+
161
+
162
+
163
+	/**
164
+	 * default maintenance page. If we're in maintenance mode level 2, then we need to show
165
+	 * the migration scripts and all that UI.
166
+	 */
167
+	public function _maintenance()
168
+	{
169
+		//it all depends if we're in maintenance model level 1 (frontend-only) or
170
+		//level 2 (everything except maintenance page)
171
+		try {
172
+			//get the current maintenance level and check if
173
+			//we are removed
174
+			$mm = EE_Maintenance_Mode::instance()->level();
175
+			$placed_in_mm = EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
176
+			if ($mm == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) {
177
+				//we just took the site out of maintenance mode, so notify the user.
178
+				//unfortunately this message appears to be echoed on the NEXT page load...
179
+				//oh well, we should really be checking for this on addon deactivation anyways
180
+				EE_Error::add_attention(__('Site taken out of maintenance mode because no data migration scripts are required',
181
+					'event_espresso'));
182
+				$this->_process_notices(array('page' => 'espresso_maintenance_settings'), false);
183
+			}
184
+			//in case an exception is thrown while trying to handle migrations
185
+			switch (EE_Maintenance_Mode::instance()->level()) {
186
+				case EE_Maintenance_Mode::level_0_not_in_maintenance:
187
+				case EE_Maintenance_Mode::level_1_frontend_only_maintenance:
188
+					$show_maintenance_switch = true;
189
+					$show_backup_db_text = false;
190
+					$show_migration_progress = false;
191
+					$script_names = array();
192
+					$addons_should_be_upgraded_first = false;
193
+					break;
194
+				case EE_Maintenance_Mode::level_2_complete_maintenance:
195
+					$show_maintenance_switch = false;
196
+					$show_migration_progress = true;
197
+					if (isset($this->_req_data['continue_migration'])) {
198
+						$show_backup_db_text = false;
199
+					} else {
200
+						$show_backup_db_text = true;
201
+					}
202
+					$scripts_needing_to_run = EE_Data_Migration_Manager::instance()
203
+																	   ->check_for_applicable_data_migration_scripts();
204
+					$addons_should_be_upgraded_first = EE_Data_Migration_Manager::instance()->addons_need_updating();
205
+					$script_names = array();
206
+					$current_script = null;
207
+					foreach ($scripts_needing_to_run as $script) {
208
+						if ($script instanceof EE_Data_Migration_Script_Base) {
209
+							if ( ! $current_script) {
210
+								$current_script = $script;
211
+								$current_script->migration_page_hooks();
212
+							}
213
+							$script_names[] = $script->pretty_name();
214
+						}
215
+					}
216
+					break;
217
+			}
218
+			$most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
219
+			$exception_thrown = false;
220
+		} catch (EE_Error $e) {
221
+			EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
222
+			//now, just so we can display the page correctly, make a error migration script stage object
223
+			//and also put the error on it. It only persists for the duration of this request
224
+			$most_recent_migration = new EE_DMS_Unknown_1_0_0();
225
+			$most_recent_migration->add_error($e->getMessage());
226
+			$exception_thrown = true;
227
+		}
228
+		$current_db_state = EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set();
229
+		$current_db_state = str_replace('.decaf', '', $current_db_state);
230
+		if ($exception_thrown
231
+			|| ($most_recent_migration
232
+				&& $most_recent_migration instanceof EE_Data_Migration_Script_Base
233
+				&& $most_recent_migration->is_broken()
234
+			)
235
+		) {
236
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
237
+			$this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/';
238
+			$this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce(array('action'  => 'confirm_migration_crash_report_sent',
239
+																						'success' => '0',
240
+			), EE_MAINTENANCE_ADMIN_URL);
241
+		} elseif ($addons_should_be_upgraded_first) {
242
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
243
+		} else {
244
+			if ($most_recent_migration
245
+				&& $most_recent_migration instanceof EE_Data_Migration_Script_Base
246
+				&& $most_recent_migration->can_continue()
247
+			) {
248
+				$show_backup_db_text = false;
249
+				$show_continue_current_migration_script = true;
250
+				$show_most_recent_migration = true;
251
+			} elseif (isset($this->_req_data['continue_migration'])) {
252
+				$show_most_recent_migration = true;
253
+				$show_continue_current_migration_script = false;
254
+			} else {
255
+				$show_most_recent_migration = false;
256
+				$show_continue_current_migration_script = false;
257
+			}
258
+			if (isset($current_script)) {
259
+				$migrates_to = $current_script->migrates_to_version();
260
+				$plugin_slug = $migrates_to['slug'];
261
+				$new_version = $migrates_to['version'];
262
+				$this->_template_args = array_merge($this->_template_args, array(
263
+					'current_db_state' => sprintf(__("EE%s (%s)", "event_espresso"),
264
+						isset($current_db_state[$plugin_slug]) ? $current_db_state[$plugin_slug] : 3, $plugin_slug),
265
+					'next_db_state'    => isset($current_script) ? sprintf(__("EE%s (%s)", 'event_espresso'),
266
+						$new_version, $plugin_slug) : null,
267
+				));
268
+			}
269
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
270
+			$this->_template_args = array_merge(
271
+				$this->_template_args,
272
+				array(
273
+					'show_most_recent_migration'             => $show_most_recent_migration,
274
+					//flag for showing the most recent migration's status and/or errors
275
+					'show_migration_progress'                => $show_migration_progress,
276
+					//flag for showing the option to run migrations and see their progress
277
+					'show_backup_db_text'                    => $show_backup_db_text,
278
+					//flag for showing text telling the user to backup their DB
279
+					'show_maintenance_switch'                => $show_maintenance_switch,
280
+					//flag for showing the option to change maintenance mode between levels 0 and 1
281
+					'script_names'                           => $script_names,
282
+					//array of names of scripts that have run
283
+					'show_continue_current_migration_script' => $show_continue_current_migration_script,
284
+					//flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
285
+					'reset_db_page_link'                     => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reset_db'),
286
+						EE_MAINTENANCE_ADMIN_URL),
287
+					'update_migration_script_page_link'      => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'change_maintenance_level'),
288
+						EE_MAINTENANCE_ADMIN_URL),
289
+					'ultimate_db_state'                      => sprintf(__("EE%s", 'event_espresso'),
290
+						espresso_version()),
291
+				)
292
+			);
293
+			//make sure we have the form fields helper available. It usually is, but sometimes it isn't
294
+			//localize script stuff
295
+			wp_localize_script('ee-maintenance', 'ee_maintenance', array(
296
+				'migrating'                        => __("Migrating...", "event_espresso"),
297
+				'next'                             => __("Next", "event_espresso"),
298
+				'fatal_error'                      => __("A Fatal Error Has Occurred", "event_espresso"),
299
+				'click_next_when_ready'            => __("The current Migration has ended. Click 'next' when ready to proceed",
300
+					"event_espresso"),
301
+				'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts,
302
+				'status_fatal_error'               => EE_Data_Migration_Manager::status_fatal_error,
303
+				'status_completed'                 => EE_Data_Migration_Manager::status_completed,
304
+			));
305
+		}
306
+		$this->_template_args['most_recent_migration'] = $most_recent_migration;//the actual most recently ran migration
307
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
308
+			$this->_template_args, true);
309
+		$this->display_admin_page_with_sidebar();
310
+	}
311
+
312
+
313
+
314
+	/**
315
+	 * returns JSON and executes another step of the currently-executing data migration (called via ajax)
316
+	 */
317
+	public function migration_step()
318
+	{
319
+		$this->_template_args['data'] = EE_Data_Migration_Manager::instance()->response_to_migration_ajax_request();
320
+		$this->_return_json();
321
+	}
322
+
323
+
324
+
325
+	/**
326
+	 * Can be used by js when it notices a response with HTML in it in order
327
+	 * to log the malformed response
328
+	 */
329
+	public function add_error_to_migrations_ran()
330
+	{
331
+		EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($this->_req_data['message']);
332
+		$this->_template_args['data'] = array('ok' => true);
333
+		$this->_return_json();
334
+	}
335
+
336
+
337
+
338
+	/**
339
+	 * changes the maintenance level, provided there are still no migration scripts that shoudl run
340
+	 */
341
+	public function _change_maintenance_level()
342
+	{
343
+		$new_level = intval($this->_req_data['maintenance_mode_level']);
344
+		if ( ! EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
345
+			EE_Maintenance_Mode::instance()->set_maintenance_level($new_level);
346
+			$success = true;
347
+		} else {
348
+			EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
349
+			$success = false;
350
+		}
351
+		$this->_redirect_after_action($success, 'Maintenance Mode', __("Updated", "event_espresso"));
352
+	}
353
+
354
+
355
+
356
+	/**
357
+	 * a tab with options for resetting and/or deleting EE data
358
+	 *
359
+	 * @throws \EE_Error
360
+	 */
361
+	public function _data_reset_and_delete()
362
+	{
363
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
364
+		$this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button(
365
+			'reset_capabilities',
366
+			'reset_capabilities',
367
+			array(),
368
+			'button button-primary',
369
+			'',
370
+			false
371
+		);
372
+		$this->_template_args['delete_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
373
+			array('action' => 'delete_db'),
374
+			EE_MAINTENANCE_ADMIN_URL
375
+		);
376
+		$this->_template_args['reset_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
377
+			array('action' => 'reset_db'),
378
+			EE_MAINTENANCE_ADMIN_URL
379
+		);
380
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
381
+			$this->_template_path,
382
+			$this->_template_args,
383
+			true
384
+		);
385
+		$this->display_admin_page_with_sidebar();
386
+	}
387
+
388
+
389
+
390
+	protected function _reset_capabilities()
391
+	{
392
+		EE_Registry::instance()->CAP->init_caps(true);
393
+		EE_Error::add_success(__('Default Event Espresso capabilities have been restored for all current roles.',
394
+			'event_espresso'));
395
+		$this->_redirect_after_action(false, '', '', array('action' => 'data_reset'), true);
396
+	}
397
+
398
+
399
+
400
+	/**
401
+	 * resets the DMSs so we can attempt to continue migrating after a fatal error
402
+	 * (only a good idea when someone has somehow tried ot fix whatever caused
403
+	 * the fatal error in teh first place)
404
+	 */
405
+	protected function _reattempt_migration()
406
+	{
407
+		EE_Data_Migration_Manager::instance()->reattempt();
408
+		$this->_redirect_after_action(false, '', '', array('action' => 'default'), true);
409
+	}
410
+
411
+
412
+
413
+	/**
414
+	 * shows the big ol' System Information page
415
+	 */
416
+	public function _system_status()
417
+	{
418
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
419
+		$this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati();
420
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
421
+			$this->_template_args, true);
422
+		$this->display_admin_page_with_sidebar();
423
+	}
424
+
425
+
426
+
427
+	public function _send_migration_crash_report()
428
+	{
429
+		$from = $this->_req_data['from'];
430
+		$from_name = $this->_req_data['from_name'];
431
+		$body = $this->_req_data['body'];
432
+		try {
433
+			$success = wp_mail(EE_SUPPORT_EMAIL,
434
+				'Migration Crash Report',
435
+				$body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
436
+				array(
437
+					"from:$from_name<$from>",
438
+					//					'content-type:text/html charset=UTF-8'
439
+				));
440
+		} catch (Exception $e) {
441
+			$success = false;
442
+		}
443
+		$this->_redirect_after_action($success, __("Migration Crash Report", "event_espresso"),
444
+			__("sent", "event_espresso"),
445
+			array('success' => $success, 'action' => 'confirm_migration_crash_report_sent'));
446
+	}
447
+
448
+
449
+
450
+	public function _confirm_migration_crash_report_sent()
451
+	{
452
+		try {
453
+			$most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
454
+		} catch (EE_Error $e) {
455
+			EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
456
+			//now, just so we can display the page correctly, make a error migration script stage object
457
+			//and also put the error on it. It only persists for the duration of this request
458
+			$most_recent_migration = new EE_DMS_Unknown_1_0_0();
459
+			$most_recent_migration->add_error($e->getMessage());
460
+		}
461
+		$success = $this->_req_data['success'] == '1' ? true : false;
462
+		$this->_template_args['success'] = $success;
463
+		$this->_template_args['most_recent_migration'] = $most_recent_migration;
464
+		$this->_template_args['reset_db_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reset_db'),
465
+			EE_MAINTENANCE_ADMIN_URL);
466
+		$this->_template_args['reset_db_page_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'data_reset'),
467
+			EE_MAINTENANCE_ADMIN_URL);
468
+		$this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reattempt_migration'),
469
+			EE_MAINTENANCE_ADMIN_URL);
470
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
471
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
472
+			$this->_template_args, true);
473
+		$this->display_admin_page_with_sidebar();
474
+	}
475
+
476
+
477
+
478
+	/**
479
+	 * Resets the entire EE4 database.
480
+	 * Currently basically only sets up ee4 database for a fresh install- doesn't
481
+	 * actually clean out the old wp options, or cpts (although does erase old ee table data)
482
+	 *
483
+	 * @param boolean $nuke_old_ee4_data controls whether or not we
484
+	 *                                   destroy the old ee4 data, or just try initializing ee4 default data
485
+	 */
486
+	public function _reset_db($nuke_old_ee4_data = true)
487
+	{
488
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
489
+		if ($nuke_old_ee4_data) {
490
+			EEH_Activation::delete_all_espresso_cpt_data();
491
+			EEH_Activation::delete_all_espresso_tables_and_data(false);
492
+			EEH_Activation::remove_cron_tasks();
493
+		}
494
+		//make sure when we reset the registry's config that it
495
+		//switches to using the new singleton
496
+		EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true);
497
+		EE_System::instance()->initialize_db_if_no_migrations_required(true);
498
+		EE_System::instance()->redirect_to_about_ee();
499
+	}
500
+
501
+
502
+
503
+	/**
504
+	 * Deletes ALL EE tables, Records, and Options from the database.
505
+	 */
506
+	public function _delete_db()
507
+	{
508
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
509
+		EEH_Activation::delete_all_espresso_cpt_data();
510
+		EEH_Activation::delete_all_espresso_tables_and_data();
511
+		EEH_Activation::remove_cron_tasks();
512
+		EEH_Activation::deactivate_event_espresso();
513
+		wp_safe_redirect(admin_url('plugins.php'));
514
+		exit;
515
+	}
516
+
517
+
518
+
519
+	/**
520
+	 * sets up EE4 to rerun the migrations from ee3 to ee4
521
+	 */
522
+	public function _rerun_migration_from_ee3()
523
+	{
524
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
525
+		EEH_Activation::delete_all_espresso_cpt_data();
526
+		EEH_Activation::delete_all_espresso_tables_and_data(false);
527
+		//set the db state to something that will require migrations
528
+		update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0');
529
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance);
530
+		$this->_redirect_after_action(true, __("Database", 'event_espresso'), __("reset", 'event_espresso'));
531
+	}
532
+
533
+
534
+
535
+	//none of the below group are currently used for Gateway Settings
536
+	protected function _add_screen_options()
537
+	{
538
+	}
539
+
540
+
541
+
542
+	protected function _add_feature_pointers()
543
+	{
544
+	}
545
+
546 546
 
547 547
 
548
-    public function admin_init()
549
-    {
550
-    }
551
-
552
-
553
-
554
-    public function admin_notices()
555
-    {
556
-    }
557
-
548
+	public function admin_init()
549
+	{
550
+	}
551
+
552
+
553
+
554
+	public function admin_notices()
555
+	{
556
+	}
557
+
558 558
 
559 559
 
560
-    public function admin_footer_scripts()
561
-    {
562
-    }
560
+	public function admin_footer_scripts()
561
+	{
562
+	}
563 563
 
564 564
 
565 565
 
566
-    public function load_scripts_styles()
567
-    {
568
-        wp_enqueue_script('ee_admin_js');
566
+	public function load_scripts_styles()
567
+	{
568
+		wp_enqueue_script('ee_admin_js');
569 569
 //		wp_enqueue_media();
570 570
 //		wp_enqueue_script('media-upload');
571
-        wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL . '/ee-maintenance.js', array('jquery'),
572
-            EVENT_ESPRESSO_VERSION, true);
573
-        wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css', array(),
574
-            EVENT_ESPRESSO_VERSION);
575
-        wp_enqueue_style('espresso_maintenance');
576
-    }
571
+		wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL . '/ee-maintenance.js', array('jquery'),
572
+			EVENT_ESPRESSO_VERSION, true);
573
+		wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css', array(),
574
+			EVENT_ESPRESSO_VERSION);
575
+		wp_enqueue_style('espresso_maintenance');
576
+	}
577 577
 
578 578
 
579 579
 
580
-    public function load_scripts_styles_default()
581
-    {
582
-        //styles
580
+	public function load_scripts_styles_default()
581
+	{
582
+		//styles
583 583
 //		wp_enqueue_style('ee-text-links');
584 584
 //		//scripts
585 585
 //		wp_enqueue_script('ee-text-links');
586
-    }
586
+	}
587 587
 
588 588
 
589 589
 
Please login to merge, or discard this patch.
Spacing   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -233,13 +233,13 @@  discard block
 block discarded – undo
233 233
                 && $most_recent_migration->is_broken()
234 234
             )
235 235
         ) {
236
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
236
+            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_migration_was_borked_page.template.php';
237 237
             $this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/';
238 238
             $this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce(array('action'  => 'confirm_migration_crash_report_sent',
239 239
                                                                                         'success' => '0',
240 240
             ), EE_MAINTENANCE_ADMIN_URL);
241 241
         } elseif ($addons_should_be_upgraded_first) {
242
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
242
+            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_upgrade_addons_before_migrating.template.php';
243 243
         } else {
244 244
             if ($most_recent_migration
245 245
                 && $most_recent_migration instanceof EE_Data_Migration_Script_Base
@@ -266,7 +266,7 @@  discard block
 block discarded – undo
266 266
                         $new_version, $plugin_slug) : null,
267 267
                 ));
268 268
             }
269
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
269
+            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_migration_page.template.php';
270 270
             $this->_template_args = array_merge(
271 271
                 $this->_template_args,
272 272
                 array(
@@ -303,7 +303,7 @@  discard block
 block discarded – undo
303 303
                 'status_completed'                 => EE_Data_Migration_Manager::status_completed,
304 304
             ));
305 305
         }
306
-        $this->_template_args['most_recent_migration'] = $most_recent_migration;//the actual most recently ran migration
306
+        $this->_template_args['most_recent_migration'] = $most_recent_migration; //the actual most recently ran migration
307 307
         $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
308 308
             $this->_template_args, true);
309 309
         $this->display_admin_page_with_sidebar();
@@ -360,7 +360,7 @@  discard block
 block discarded – undo
360 360
      */
361 361
     public function _data_reset_and_delete()
362 362
     {
363
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
363
+        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_data_reset_and_delete.template.php';
364 364
         $this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button(
365 365
             'reset_capabilities',
366 366
             'reset_capabilities',
@@ -415,7 +415,7 @@  discard block
 block discarded – undo
415 415
      */
416 416
     public function _system_status()
417 417
     {
418
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
418
+        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_system_stati_page.template.php';
419 419
         $this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati();
420 420
         $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
421 421
             $this->_template_args, true);
@@ -432,7 +432,7 @@  discard block
 block discarded – undo
432 432
         try {
433 433
             $success = wp_mail(EE_SUPPORT_EMAIL,
434 434
                 'Migration Crash Report',
435
-                $body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
435
+                $body."/r/n<br>".print_r(EEM_System_Status::instance()->get_system_stati(), true),
436 436
                 array(
437 437
                     "from:$from_name<$from>",
438 438
                     //					'content-type:text/html charset=UTF-8'
@@ -467,7 +467,7 @@  discard block
 block discarded – undo
467 467
             EE_MAINTENANCE_ADMIN_URL);
468 468
         $this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reattempt_migration'),
469 469
             EE_MAINTENANCE_ADMIN_URL);
470
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
470
+        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_confirm_migration_crash_report_sent.template.php';
471 471
         $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
472 472
             $this->_template_args, true);
473 473
         $this->display_admin_page_with_sidebar();
@@ -568,9 +568,9 @@  discard block
 block discarded – undo
568 568
         wp_enqueue_script('ee_admin_js');
569 569
 //		wp_enqueue_media();
570 570
 //		wp_enqueue_script('media-upload');
571
-        wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL . '/ee-maintenance.js', array('jquery'),
571
+        wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL.'/ee-maintenance.js', array('jquery'),
572 572
             EVENT_ESPRESSO_VERSION, true);
573
-        wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css', array(),
573
+        wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL.'ee-maintenance.css', array(),
574 574
             EVENT_ESPRESSO_VERSION);
575 575
         wp_enqueue_style('espresso_maintenance');
576 576
     }
Please login to merge, or discard this patch.