Completed
Branch BUG-10059-allow-multiple-invoi... (76c0cc)
by
unknown
40:24 queued 26:41
created
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   +1355 added lines, -1355 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,1364 +16,1364 @@  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
-
90
-    /**
91
-     * @singleton method used to instantiate class object
92
-     * @access    public
93
-     * @param  \EE_Registry $Registry
94
-     * @return \EE_System
95
-     */
96
-    public static function instance(EE_Registry $Registry = null)
97
-    {
98
-        // check if class object is instantiated
99
-        if ( ! self::$_instance instanceof EE_System) {
100
-            self::$_instance = new self($Registry);
101
-        }
102
-        return self::$_instance;
103
-    }
104
-
105
-
106
-
107
-    /**
108
-     * resets the instance and returns it
109
-     *
110
-     * @return EE_System
111
-     */
112
-    public static function reset()
113
-    {
114
-        self::$_instance->_req_type = null;
115
-        //make sure none of the old hooks are left hanging around
116
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
117
-        //we need to reset the migration manager in order for it to detect DMSs properly
118
-        EE_Data_Migration_Manager::reset();
119
-        self::instance()->detect_activations_or_upgrades();
120
-        self::instance()->perform_activations_upgrades_and_migrations();
121
-        return self::instance();
122
-    }
123
-
124
-
125
-
126
-    /**
127
-     *    sets hooks for running rest of system
128
-     *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
129
-     *    starting EE Addons from any other point may lead to problems
130
-     *
131
-     * @access private
132
-     * @param  \EE_Registry $Registry
133
-     */
134
-    private function __construct(EE_Registry $Registry)
135
-    {
136
-        $this->registry = $Registry;
137
-        do_action('AHEE__EE_System__construct__begin', $this);
138
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
139
-        add_action('AHEE__EE_Bootstrap__load_espresso_addons', array($this, 'load_espresso_addons'));
140
-        // when an ee addon is activated, we want to call the core hook(s) again
141
-        // because the newly-activated addon didn't get a chance to run at all
142
-        add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
143
-        // detect whether install or upgrade
144
-        add_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades', array($this, 'detect_activations_or_upgrades'),
145
-            3);
146
-        // load EE_Config, EE_Textdomain, etc
147
-        add_action('AHEE__EE_Bootstrap__load_core_configuration', array($this, 'load_core_configuration'), 5);
148
-        // load EE_Config, EE_Textdomain, etc
149
-        add_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
150
-            array($this, 'register_shortcodes_modules_and_widgets'), 7);
151
-        // you wanna get going? I wanna get going... let's get going!
152
-        add_action('AHEE__EE_Bootstrap__brew_espresso', array($this, 'brew_espresso'), 9);
153
-        //other housekeeping
154
-        //exclude EE critical pages from wp_list_pages
155
-        add_filter('wp_list_pages_excludes', array($this, 'remove_pages_from_wp_list_pages'), 10);
156
-        // ALL EE Addons should use the following hook point to attach their initial setup too
157
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
158
-        do_action('AHEE__EE_System__construct__complete', $this);
159
-    }
160
-
161
-
162
-
163
-    /**
164
-     * load_espresso_addons
165
-     * allow addons to load first so that they can set hooks for running DMS's, etc
166
-     * this is hooked into both:
167
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
168
-     *        which runs during the WP 'plugins_loaded' action at priority 5
169
-     *    and the WP 'activate_plugin' hookpoint
170
-     *
171
-     * @access public
172
-     * @return void
173
-     */
174
-    public function load_espresso_addons()
175
-    {
176
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
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');
179
-        //load and setup EE_Capabilities
180
-        $this->registry->load_core('Capabilities');
181
-        //caps need to be initialized on every request so that capability maps are set.
182
-        //@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
183
-        $this->registry->CAP->init_caps();
184
-        do_action('AHEE__EE_System__load_espresso_addons');
185
-        //if the WP API basic auth plugin isn't already loaded, load it now.
186
-        //We want it for mobile apps. Just include the entire plugin
187
-        //also, don't load the basic auth when a plugin is getting activated, because
188
-        //it could be the basic auth plugin, and it doesn't check if its methods are already defined
189
-        //and causes a fatal error
190
-        if ( ! function_exists('json_basic_auth_handler')
191
-             && ! function_exists('json_basic_auth_error')
192
-             && ! (
193
-                isset($_GET['action'])
194
-                && in_array($_GET['action'], array('activate', 'activate-selected'))
195
-            )
196
-             && ! (
197
-                isset($_GET['activate'])
198
-                && $_GET['activate'] === 'true'
199
-            )
200
-        ) {
201
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
202
-        }
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
+
90
+	/**
91
+	 * @singleton method used to instantiate class object
92
+	 * @access    public
93
+	 * @param  \EE_Registry $Registry
94
+	 * @return \EE_System
95
+	 */
96
+	public static function instance(EE_Registry $Registry = null)
97
+	{
98
+		// check if class object is instantiated
99
+		if ( ! self::$_instance instanceof EE_System) {
100
+			self::$_instance = new self($Registry);
101
+		}
102
+		return self::$_instance;
103
+	}
104
+
105
+
106
+
107
+	/**
108
+	 * resets the instance and returns it
109
+	 *
110
+	 * @return EE_System
111
+	 */
112
+	public static function reset()
113
+	{
114
+		self::$_instance->_req_type = null;
115
+		//make sure none of the old hooks are left hanging around
116
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
117
+		//we need to reset the migration manager in order for it to detect DMSs properly
118
+		EE_Data_Migration_Manager::reset();
119
+		self::instance()->detect_activations_or_upgrades();
120
+		self::instance()->perform_activations_upgrades_and_migrations();
121
+		return self::instance();
122
+	}
123
+
124
+
125
+
126
+	/**
127
+	 *    sets hooks for running rest of system
128
+	 *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
129
+	 *    starting EE Addons from any other point may lead to problems
130
+	 *
131
+	 * @access private
132
+	 * @param  \EE_Registry $Registry
133
+	 */
134
+	private function __construct(EE_Registry $Registry)
135
+	{
136
+		$this->registry = $Registry;
137
+		do_action('AHEE__EE_System__construct__begin', $this);
138
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
139
+		add_action('AHEE__EE_Bootstrap__load_espresso_addons', array($this, 'load_espresso_addons'));
140
+		// when an ee addon is activated, we want to call the core hook(s) again
141
+		// because the newly-activated addon didn't get a chance to run at all
142
+		add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
143
+		// detect whether install or upgrade
144
+		add_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades', array($this, 'detect_activations_or_upgrades'),
145
+			3);
146
+		// load EE_Config, EE_Textdomain, etc
147
+		add_action('AHEE__EE_Bootstrap__load_core_configuration', array($this, 'load_core_configuration'), 5);
148
+		// load EE_Config, EE_Textdomain, etc
149
+		add_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
150
+			array($this, 'register_shortcodes_modules_and_widgets'), 7);
151
+		// you wanna get going? I wanna get going... let's get going!
152
+		add_action('AHEE__EE_Bootstrap__brew_espresso', array($this, 'brew_espresso'), 9);
153
+		//other housekeeping
154
+		//exclude EE critical pages from wp_list_pages
155
+		add_filter('wp_list_pages_excludes', array($this, 'remove_pages_from_wp_list_pages'), 10);
156
+		// ALL EE Addons should use the following hook point to attach their initial setup too
157
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
158
+		do_action('AHEE__EE_System__construct__complete', $this);
159
+	}
160
+
161
+
162
+
163
+	/**
164
+	 * load_espresso_addons
165
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
166
+	 * this is hooked into both:
167
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
168
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
169
+	 *    and the WP 'activate_plugin' hookpoint
170
+	 *
171
+	 * @access public
172
+	 * @return void
173
+	 */
174
+	public function load_espresso_addons()
175
+	{
176
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
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');
179
+		//load and setup EE_Capabilities
180
+		$this->registry->load_core('Capabilities');
181
+		//caps need to be initialized on every request so that capability maps are set.
182
+		//@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
183
+		$this->registry->CAP->init_caps();
184
+		do_action('AHEE__EE_System__load_espresso_addons');
185
+		//if the WP API basic auth plugin isn't already loaded, load it now.
186
+		//We want it for mobile apps. Just include the entire plugin
187
+		//also, don't load the basic auth when a plugin is getting activated, because
188
+		//it could be the basic auth plugin, and it doesn't check if its methods are already defined
189
+		//and causes a fatal error
190
+		if ( ! function_exists('json_basic_auth_handler')
191
+			 && ! function_exists('json_basic_auth_error')
192
+			 && ! (
193
+				isset($_GET['action'])
194
+				&& in_array($_GET['action'], array('activate', 'activate-selected'))
195
+			)
196
+			 && ! (
197
+				isset($_GET['activate'])
198
+				&& $_GET['activate'] === 'true'
199
+			)
200
+		) {
201
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
202
+		}
203 203
         
204
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
205
-    }
206
-
207
-
208
-
209
-    /**
210
-     * detect_activations_or_upgrades
211
-     * Checks for activation or upgrade of core first;
212
-     * then also checks if any registered addons have been activated or upgraded
213
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
214
-     * which runs during the WP 'plugins_loaded' action at priority 3
215
-     *
216
-     * @access public
217
-     * @return void
218
-     */
219
-    public function detect_activations_or_upgrades()
220
-    {
221
-        //first off: let's make sure to handle core
222
-        $this->detect_if_activation_or_upgrade();
223
-        foreach ($this->registry->addons as $addon) {
224
-            //detect teh request type for that addon
225
-            $addon->detect_activation_or_upgrade();
226
-        }
227
-    }
228
-
229
-
230
-
231
-    /**
232
-     * detect_if_activation_or_upgrade
233
-     * Takes care of detecting whether this is a brand new install or code upgrade,
234
-     * and either setting up the DB or setting up maintenance mode etc.
235
-     *
236
-     * @access public
237
-     * @return void
238
-     */
239
-    public function detect_if_activation_or_upgrade()
240
-    {
241
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
242
-        // load M-Mode class
243
-        $this->registry->load_core('Maintenance_Mode');
244
-        // check if db has been updated, or if its a brand-new installation
245
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
246
-        $request_type = $this->detect_req_type($espresso_db_update);
247
-        //EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
248
-        switch ($request_type) {
249
-            case EE_System::req_type_new_activation:
250
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
251
-                $this->_handle_core_version_change($espresso_db_update);
252
-                break;
253
-            case EE_System::req_type_reactivation:
254
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
255
-                $this->_handle_core_version_change($espresso_db_update);
256
-                break;
257
-            case EE_System::req_type_upgrade:
258
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
259
-                //migrations may be required now that we've upgraded
260
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
261
-                $this->_handle_core_version_change($espresso_db_update);
204
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
205
+	}
206
+
207
+
208
+
209
+	/**
210
+	 * detect_activations_or_upgrades
211
+	 * Checks for activation or upgrade of core first;
212
+	 * then also checks if any registered addons have been activated or upgraded
213
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
214
+	 * which runs during the WP 'plugins_loaded' action at priority 3
215
+	 *
216
+	 * @access public
217
+	 * @return void
218
+	 */
219
+	public function detect_activations_or_upgrades()
220
+	{
221
+		//first off: let's make sure to handle core
222
+		$this->detect_if_activation_or_upgrade();
223
+		foreach ($this->registry->addons as $addon) {
224
+			//detect teh request type for that addon
225
+			$addon->detect_activation_or_upgrade();
226
+		}
227
+	}
228
+
229
+
230
+
231
+	/**
232
+	 * detect_if_activation_or_upgrade
233
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
234
+	 * and either setting up the DB or setting up maintenance mode etc.
235
+	 *
236
+	 * @access public
237
+	 * @return void
238
+	 */
239
+	public function detect_if_activation_or_upgrade()
240
+	{
241
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
242
+		// load M-Mode class
243
+		$this->registry->load_core('Maintenance_Mode');
244
+		// check if db has been updated, or if its a brand-new installation
245
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
246
+		$request_type = $this->detect_req_type($espresso_db_update);
247
+		//EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
248
+		switch ($request_type) {
249
+			case EE_System::req_type_new_activation:
250
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
251
+				$this->_handle_core_version_change($espresso_db_update);
252
+				break;
253
+			case EE_System::req_type_reactivation:
254
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
255
+				$this->_handle_core_version_change($espresso_db_update);
256
+				break;
257
+			case EE_System::req_type_upgrade:
258
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
259
+				//migrations may be required now that we've upgraded
260
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
261
+				$this->_handle_core_version_change($espresso_db_update);
262 262
 //				echo "done upgrade";die;
263
-                break;
264
-            case EE_System::req_type_downgrade:
265
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
266
-                //its possible migrations are no longer required
267
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
268
-                $this->_handle_core_version_change($espresso_db_update);
269
-                break;
270
-            case EE_System::req_type_normal:
271
-            default:
263
+				break;
264
+			case EE_System::req_type_downgrade:
265
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
266
+				//its possible migrations are no longer required
267
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
268
+				$this->_handle_core_version_change($espresso_db_update);
269
+				break;
270
+			case EE_System::req_type_normal:
271
+			default:
272 272
 //				$this->_maybe_redirect_to_ee_about();
273
-                break;
274
-        }
275
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
276
-    }
277
-
278
-
279
-
280
-    /**
281
-     * Updates the list of installed versions and sets hooks for
282
-     * initializing the database later during the request
283
-     *
284
-     * @param array $espresso_db_update
285
-     */
286
-    protected function _handle_core_version_change($espresso_db_update)
287
-    {
288
-        $this->update_list_of_installed_versions($espresso_db_update);
289
-        //get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
290
-        add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
291
-            array($this, 'initialize_db_if_no_migrations_required'));
292
-    }
293
-
294
-
295
-
296
-    /**
297
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
298
-     * information about what versions of EE have been installed and activated,
299
-     * NOT necessarily the state of the database
300
-     *
301
-     * @param null $espresso_db_update
302
-     * @internal param array $espresso_db_update_value the value of the WordPress option. If not supplied, fetches it
303
-     *           from the options table
304
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
305
-     */
306
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null)
307
-    {
308
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
309
-        if ( ! $espresso_db_update) {
310
-            $espresso_db_update = get_option('espresso_db_update');
311
-        }
312
-        // check that option is an array
313
-        if ( ! is_array($espresso_db_update)) {
314
-            // if option is FALSE, then it never existed
315
-            if ($espresso_db_update === false) {
316
-                // make $espresso_db_update an array and save option with autoload OFF
317
-                $espresso_db_update = array();
318
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
319
-            } else {
320
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
321
-                $espresso_db_update = array($espresso_db_update => array());
322
-                update_option('espresso_db_update', $espresso_db_update);
323
-            }
324
-        } else {
325
-            $corrected_db_update = array();
326
-            //if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
327
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
328
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
329
-                    //the key is an int, and the value IS NOT an array
330
-                    //so it must be numerically-indexed, where values are versions installed...
331
-                    //fix it!
332
-                    $version_string = $should_be_array;
333
-                    $corrected_db_update[$version_string] = array('unknown-date');
334
-                } else {
335
-                    //ok it checks out
336
-                    $corrected_db_update[$should_be_version_string] = $should_be_array;
337
-                }
338
-            }
339
-            $espresso_db_update = $corrected_db_update;
340
-            update_option('espresso_db_update', $espresso_db_update);
341
-        }
342
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
343
-        return $espresso_db_update;
344
-    }
345
-
346
-
347
-
348
-    /**
349
-     * Does the traditional work of setting up the plugin's database and adding default data.
350
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
351
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
352
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
353
-     * so that it will be done when migrations are finished
354
-     *
355
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
356
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
357
-     *                                       This is a resource-intensive job
358
-     *                                       so we prefer to only do it when necessary
359
-     * @return void
360
-     */
361
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
362
-    {
363
-        $request_type = $this->detect_req_type();
364
-        //only initialize system if we're not in maintenance mode.
365
-        if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
366
-            update_option('ee_flush_rewrite_rules', true);
367
-            if ($verify_schema) {
368
-                EEH_Activation::initialize_db_and_folders();
369
-            }
370
-            EEH_Activation::initialize_db_content();
371
-            EEH_Activation::system_initialization();
372
-            if ($initialize_addons_too) {
373
-                $this->initialize_addons();
374
-            }
375
-        } else {
376
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
377
-        }
378
-        if ($request_type == EE_System::req_type_new_activation
379
-            || $request_type == EE_System::req_type_reactivation
380
-            || $request_type == EE_System::req_type_upgrade
381
-        ) {
382
-            add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
383
-        }
384
-    }
385
-
386
-
387
-
388
-    /**
389
-     * Initializes the db for all registered addons
390
-     */
391
-    public function initialize_addons()
392
-    {
393
-        //foreach registered addon, make sure its db is up-to-date too
394
-        foreach ($this->registry->addons as $addon) {
395
-            $addon->initialize_db_if_no_migrations_required();
396
-        }
397
-    }
398
-
399
-
400
-
401
-    /**
402
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
403
-     *
404
-     * @param    array  $version_history
405
-     * @param    string $current_version_to_add version to be added to the version history
406
-     * @return    boolean success as to whether or not this option was changed
407
-     */
408
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
409
-    {
410
-        if ( ! $version_history) {
411
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
412
-        }
413
-        if ($current_version_to_add == null) {
414
-            $current_version_to_add = espresso_version();
415
-        }
416
-        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
417
-        // re-save
418
-        return update_option('espresso_db_update', $version_history);
419
-    }
420
-
421
-
422
-
423
-    /**
424
-     * Detects if the current version indicated in the has existed in the list of
425
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
426
-     *
427
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
428
-     *                                  If not supplied, fetches it from the options table.
429
-     *                                  Also, caches its result so later parts of the code can also know whether
430
-     *                                  there's been an update or not. This way we can add the current version to
431
-     *                                  espresso_db_update, but still know if this is a new install or not
432
-     * @return int one of the constants on EE_System::req_type_
433
-     */
434
-    public function detect_req_type($espresso_db_update = null)
435
-    {
436
-        if ($this->_req_type === null) {
437
-            $espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
438
-                : $this->fix_espresso_db_upgrade_option();
439
-            $this->_req_type = $this->detect_req_type_given_activation_history($espresso_db_update,
440
-                'ee_espresso_activation', espresso_version());
441
-        }
442
-        return $this->_req_type;
443
-    }
444
-
445
-
446
-
447
-    /**
448
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
449
-     * histories (for core that' 'espresso_db_update' wp option); the name of the wordpress option which is temporarily
450
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
451
-     * just activated to (for core that will always be espresso_version())
452
-     *
453
-     * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
454
-     *                                                 ee plugin. for core that's 'espresso_db_update'
455
-     * @param string $activation_indicator_option_name the name of the wordpress option that is temporarily set to
456
-     *                                                 indicate that this plugin was just activated
457
-     * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
458
-     *                                                 espresso_version())
459
-     * @return int one of the constants on EE_System::req_type_*
460
-     */
461
-    public static function detect_req_type_given_activation_history(
462
-        $activation_history_for_addon,
463
-        $activation_indicator_option_name,
464
-        $version_to_upgrade_to
465
-    ) {
466
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
467
-        if ($activation_history_for_addon) {
468
-            //it exists, so this isn't a completely new install
469
-            //check if this version already in that list of previously installed versions
470
-            if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
471
-                //it a version we haven't seen before
472
-                if ($version_is_higher === 1) {
473
-                    $req_type = EE_System::req_type_upgrade;
474
-                } else {
475
-                    $req_type = EE_System::req_type_downgrade;
476
-                }
477
-                delete_option($activation_indicator_option_name);
478
-            } else {
479
-                // its not an update. maybe a reactivation?
480
-                if (get_option($activation_indicator_option_name, false)) {
481
-                    if ($version_is_higher === -1) {
482
-                        $req_type = EE_System::req_type_downgrade;
483
-                    } elseif ($version_is_higher === 0) {
484
-                        //we've seen this version before, but it's an activation. must be a reactivation
485
-                        $req_type = EE_System::req_type_reactivation;
486
-                    } else {//$version_is_higher === 1
487
-                        $req_type = EE_System::req_type_upgrade;
488
-                    }
489
-                    delete_option($activation_indicator_option_name);
490
-                } else {
491
-                    //we've seen this version before and the activation indicate doesn't show it was just activated
492
-                    if ($version_is_higher === -1) {
493
-                        $req_type = EE_System::req_type_downgrade;
494
-                    } elseif ($version_is_higher === 0) {
495
-                        //we've seen this version before and it's not an activation. its normal request
496
-                        $req_type = EE_System::req_type_normal;
497
-                    } else {//$version_is_higher === 1
498
-                        $req_type = EE_System::req_type_upgrade;
499
-                    }
500
-                }
501
-            }
502
-        } else {
503
-            //brand new install
504
-            $req_type = EE_System::req_type_new_activation;
505
-            delete_option($activation_indicator_option_name);
506
-        }
507
-        return $req_type;
508
-    }
509
-
510
-
511
-
512
-    /**
513
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
514
-     * the $activation_history_for_addon
515
-     *
516
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
517
-     *                                             sometimes containing 'unknown-date'
518
-     * @param string $version_to_upgrade_to        (current version)
519
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
520
-     *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
521
-     *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
522
-     *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
523
-     */
524
-    protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
525
-    {
526
-        //find the most recently-activated version
527
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
528
-        $most_recently_active_version = '0.0.0.dev.000';
529
-        if (is_array($activation_history_for_addon)) {
530
-            foreach ($activation_history_for_addon as $version => $times_activated) {
531
-                //check there is a record of when this version was activated. Otherwise,
532
-                //mark it as unknown
533
-                if ( ! $times_activated) {
534
-                    $times_activated = array('unknown-date');
535
-                }
536
-                if (is_string($times_activated)) {
537
-                    $times_activated = array($times_activated);
538
-                }
539
-                foreach ($times_activated as $an_activation) {
540
-                    if ($an_activation != 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
541
-                        $most_recently_active_version = $version;
542
-                        $most_recently_active_version_activation = $an_activation == 'unknown-date'
543
-                            ? '1970-01-01 00:00:00' : $an_activation;
544
-                    }
545
-                }
546
-            }
547
-        }
548
-        return version_compare($version_to_upgrade_to, $most_recently_active_version);
549
-    }
550
-
551
-
552
-
553
-    /**
554
-     * This redirects to the about EE page after activation
555
-     *
556
-     * @return void
557
-     */
558
-    public function redirect_to_about_ee()
559
-    {
560
-        $notices = EE_Error::get_notices(false);
561
-        //if current user is an admin and it's not an ajax request
562
-        if (
563
-            $this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
564
-            && ! (defined('DOING_AJAX') && DOING_AJAX)
565
-            && ! isset($notices['errors'])
566
-        ) {
567
-            $query_params = array('page' => 'espresso_about');
568
-            if (EE_System::instance()->detect_req_type() == EE_System::req_type_new_activation) {
569
-                $query_params['new_activation'] = true;
570
-            }
571
-            if (EE_System::instance()->detect_req_type() == EE_System::req_type_reactivation) {
572
-                $query_params['reactivation'] = true;
573
-            }
574
-            $url = add_query_arg($query_params, admin_url('admin.php'));
575
-            wp_safe_redirect($url);
576
-            exit();
577
-        }
578
-    }
579
-
580
-
581
-
582
-    /**
583
-     * load_core_configuration
584
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
585
-     * which runs during the WP 'plugins_loaded' action at priority 5
586
-     *
587
-     * @return void
588
-     */
589
-    public function load_core_configuration()
590
-    {
591
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
592
-        $this->registry->load_core('EE_Load_Textdomain');
593
-        //load textdomain
594
-        EE_Load_Textdomain::load_textdomain();
595
-        // load and setup EE_Config and EE_Network_Config
596
-        $this->registry->load_core('Config');
597
-        $this->registry->load_core('Network_Config');
598
-        // setup autoloaders
599
-        // enable logging?
600
-        if ($this->registry->CFG->admin->use_full_logging) {
601
-            $this->registry->load_core('Log');
602
-        }
603
-        // check for activation errors
604
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
605
-        if ($activation_errors) {
606
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
607
-            update_option('ee_plugin_activation_errors', false);
608
-        }
609
-        // get model names
610
-        $this->_parse_model_names();
611
-        //load caf stuff a chance to play during the activation process too.
612
-        $this->_maybe_brew_regular();
613
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
614
-    }
615
-
616
-
617
-
618
-    /**
619
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
620
-     *
621
-     * @return void
622
-     */
623
-    private function _parse_model_names()
624
-    {
625
-        //get all the files in the EE_MODELS folder that end in .model.php
626
-        $models = glob(EE_MODELS . '*.model.php');
627
-        $model_names = array();
628
-        $non_abstract_db_models = array();
629
-        foreach ($models as $model) {
630
-            // get model classname
631
-            $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
632
-            $short_name = str_replace('EEM_', '', $classname);
633
-            $reflectionClass = new ReflectionClass($classname);
634
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
635
-                $non_abstract_db_models[$short_name] = $classname;
636
-            }
637
-            $model_names[$short_name] = $classname;
638
-        }
639
-        $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
640
-        $this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
641
-            $non_abstract_db_models);
642
-    }
643
-
644
-
645
-
646
-    /**
647
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
648
-     * that need to be setup before our EE_System launches.
649
-     *
650
-     * @return void
651
-     */
652
-    private function _maybe_brew_regular()
653
-    {
654
-        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
655
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
656
-        }
657
-    }
658
-
659
-
660
-
661
-    /**
662
-     * register_shortcodes_modules_and_widgets
663
-     * generate lists of shortcodes and modules, then verify paths and classes
664
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
665
-     * which runs during the WP 'plugins_loaded' action at priority 7
666
-     *
667
-     * @access public
668
-     * @return void
669
-     */
670
-    public function register_shortcodes_modules_and_widgets()
671
-    {
672
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
673
-        // check for addons using old hookpoint
674
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
675
-            $this->_incompatible_addon_error();
676
-        }
677
-    }
678
-
679
-
680
-
681
-    /**
682
-     * _incompatible_addon_error
683
-     *
684
-     * @access public
685
-     * @return void
686
-     */
687
-    private function _incompatible_addon_error()
688
-    {
689
-        // get array of classes hooking into here
690
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
691
-        if ( ! empty($class_names)) {
692
-            $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:',
693
-                'event_espresso');
694
-            $msg .= '<ul>';
695
-            foreach ($class_names as $class_name) {
696
-                $msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
697
-                        $class_name) . '</b></li>';
698
-            }
699
-            $msg .= '</ul>';
700
-            $msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
701
-                'event_espresso');
702
-            // save list of incompatible addons to wp-options for later use
703
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
704
-            if (is_admin()) {
705
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
706
-            }
707
-        }
708
-    }
709
-
710
-
711
-
712
-    /**
713
-     * brew_espresso
714
-     * begins the process of setting hooks for initializing EE in the correct order
715
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hookpoint
716
-     * which runs during the WP 'plugins_loaded' action at priority 9
717
-     *
718
-     * @return void
719
-     */
720
-    public function brew_espresso()
721
-    {
722
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
723
-        // load some final core systems
724
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
725
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
726
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
727
-        add_action('init', array($this, 'load_controllers'), 7);
728
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
729
-        add_action('init', array($this, 'initialize'), 10);
730
-        add_action('init', array($this, 'initialize_last'), 100);
731
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 25);
732
-        add_action('admin_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 25);
733
-        add_action('admin_bar_menu', array($this, 'espresso_toolbar_items'), 100);
734
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
735
-            // pew pew pew
736
-            $this->registry->load_core('PUE');
737
-            do_action('AHEE__EE_System__brew_espresso__after_pue_init');
738
-        }
739
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
740
-    }
741
-
742
-
743
-
744
-    /**
745
-     *    set_hooks_for_core
746
-     *
747
-     * @access public
748
-     * @return    void
749
-     */
750
-    public function set_hooks_for_core()
751
-    {
752
-        $this->_deactivate_incompatible_addons();
753
-        do_action('AHEE__EE_System__set_hooks_for_core');
754
-    }
755
-
756
-
757
-
758
-    /**
759
-     * Using the information gathered in EE_System::_incompatible_addon_error,
760
-     * deactivates any addons considered incompatible with the current version of EE
761
-     */
762
-    private function _deactivate_incompatible_addons()
763
-    {
764
-        $incompatible_addons = get_option('ee_incompatible_addons', array());
765
-        if ( ! empty($incompatible_addons)) {
766
-            $active_plugins = get_option('active_plugins', array());
767
-            foreach ($active_plugins as $active_plugin) {
768
-                foreach ($incompatible_addons as $incompatible_addon) {
769
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
770
-                        unset($_GET['activate']);
771
-                        espresso_deactivate_plugin($active_plugin);
772
-                    }
773
-                }
774
-            }
775
-        }
776
-    }
777
-
778
-
779
-
780
-    /**
781
-     *    perform_activations_upgrades_and_migrations
782
-     *
783
-     * @access public
784
-     * @return    void
785
-     */
786
-    public function perform_activations_upgrades_and_migrations()
787
-    {
788
-        //first check if we had previously attempted to setup EE's directories but failed
789
-        if (EEH_Activation::upload_directories_incomplete()) {
790
-            EEH_Activation::create_upload_directories();
791
-        }
792
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
793
-    }
794
-
795
-
796
-
797
-    /**
798
-     *    load_CPTs_and_session
799
-     *
800
-     * @access public
801
-     * @return    void
802
-     */
803
-    public function load_CPTs_and_session()
804
-    {
805
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
806
-        // register Custom Post Types
807
-        $this->registry->load_core('Register_CPTs');
808
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
809
-    }
810
-
811
-
812
-
813
-    /**
814
-     * load_controllers
815
-     * this is the best place to load any additional controllers that needs access to EE core.
816
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
817
-     * time
818
-     *
819
-     * @access public
820
-     * @return void
821
-     */
822
-    public function load_controllers()
823
-    {
824
-        do_action('AHEE__EE_System__load_controllers__start');
825
-        // let's get it started
826
-        if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
827
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
828
-            $this->registry->load_core('Front_Controller', array(), false, true);
829
-        } else if ( ! EE_FRONT_AJAX) {
830
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
831
-            EE_Registry::instance()->load_core('Admin');
832
-        }
833
-        do_action('AHEE__EE_System__load_controllers__complete');
834
-    }
835
-
836
-
837
-
838
-    /**
839
-     * core_loaded_and_ready
840
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
841
-     *
842
-     * @access public
843
-     * @return void
844
-     */
845
-    public function core_loaded_and_ready()
846
-    {
847
-        do_action('AHEE__EE_System__core_loaded_and_ready');
848
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
849
-        $this->registry->load_core('Session');
850
-        //		add_action( 'wp_loaded', array( $this, 'set_hooks_for_shortcodes_modules_and_addons' ), 1 );
851
-    }
852
-
853
-
854
-
855
-    /**
856
-     * initialize
857
-     * this is the best place to begin initializing client code
858
-     *
859
-     * @access public
860
-     * @return void
861
-     */
862
-    public function initialize()
863
-    {
864
-        do_action('AHEE__EE_System__initialize');
865
-    }
866
-
867
-
868
-
869
-    /**
870
-     * initialize_last
871
-     * this is run really late during the WP init hookpoint, and ensures that mostly everything else that needs to
872
-     * initialize has done so
873
-     *
874
-     * @access public
875
-     * @return void
876
-     */
877
-    public function initialize_last()
878
-    {
879
-        do_action('AHEE__EE_System__initialize_last');
880
-    }
881
-
882
-
883
-
884
-    /**
885
-     * set_hooks_for_shortcodes_modules_and_addons
886
-     * this is the best place for other systems to set callbacks for hooking into other parts of EE
887
-     * this happens at the very beginning of the wp_loaded hookpoint
888
-     *
889
-     * @access public
890
-     * @return void
891
-     */
892
-    public function set_hooks_for_shortcodes_modules_and_addons()
893
-    {
273
+				break;
274
+		}
275
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
276
+	}
277
+
278
+
279
+
280
+	/**
281
+	 * Updates the list of installed versions and sets hooks for
282
+	 * initializing the database later during the request
283
+	 *
284
+	 * @param array $espresso_db_update
285
+	 */
286
+	protected function _handle_core_version_change($espresso_db_update)
287
+	{
288
+		$this->update_list_of_installed_versions($espresso_db_update);
289
+		//get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
290
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
291
+			array($this, 'initialize_db_if_no_migrations_required'));
292
+	}
293
+
294
+
295
+
296
+	/**
297
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
298
+	 * information about what versions of EE have been installed and activated,
299
+	 * NOT necessarily the state of the database
300
+	 *
301
+	 * @param null $espresso_db_update
302
+	 * @internal param array $espresso_db_update_value the value of the WordPress option. If not supplied, fetches it
303
+	 *           from the options table
304
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
305
+	 */
306
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null)
307
+	{
308
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
309
+		if ( ! $espresso_db_update) {
310
+			$espresso_db_update = get_option('espresso_db_update');
311
+		}
312
+		// check that option is an array
313
+		if ( ! is_array($espresso_db_update)) {
314
+			// if option is FALSE, then it never existed
315
+			if ($espresso_db_update === false) {
316
+				// make $espresso_db_update an array and save option with autoload OFF
317
+				$espresso_db_update = array();
318
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
319
+			} else {
320
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
321
+				$espresso_db_update = array($espresso_db_update => array());
322
+				update_option('espresso_db_update', $espresso_db_update);
323
+			}
324
+		} else {
325
+			$corrected_db_update = array();
326
+			//if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
327
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
328
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
329
+					//the key is an int, and the value IS NOT an array
330
+					//so it must be numerically-indexed, where values are versions installed...
331
+					//fix it!
332
+					$version_string = $should_be_array;
333
+					$corrected_db_update[$version_string] = array('unknown-date');
334
+				} else {
335
+					//ok it checks out
336
+					$corrected_db_update[$should_be_version_string] = $should_be_array;
337
+				}
338
+			}
339
+			$espresso_db_update = $corrected_db_update;
340
+			update_option('espresso_db_update', $espresso_db_update);
341
+		}
342
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
343
+		return $espresso_db_update;
344
+	}
345
+
346
+
347
+
348
+	/**
349
+	 * Does the traditional work of setting up the plugin's database and adding default data.
350
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
351
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
352
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
353
+	 * so that it will be done when migrations are finished
354
+	 *
355
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
356
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
357
+	 *                                       This is a resource-intensive job
358
+	 *                                       so we prefer to only do it when necessary
359
+	 * @return void
360
+	 */
361
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
362
+	{
363
+		$request_type = $this->detect_req_type();
364
+		//only initialize system if we're not in maintenance mode.
365
+		if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
366
+			update_option('ee_flush_rewrite_rules', true);
367
+			if ($verify_schema) {
368
+				EEH_Activation::initialize_db_and_folders();
369
+			}
370
+			EEH_Activation::initialize_db_content();
371
+			EEH_Activation::system_initialization();
372
+			if ($initialize_addons_too) {
373
+				$this->initialize_addons();
374
+			}
375
+		} else {
376
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
377
+		}
378
+		if ($request_type == EE_System::req_type_new_activation
379
+			|| $request_type == EE_System::req_type_reactivation
380
+			|| $request_type == EE_System::req_type_upgrade
381
+		) {
382
+			add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
383
+		}
384
+	}
385
+
386
+
387
+
388
+	/**
389
+	 * Initializes the db for all registered addons
390
+	 */
391
+	public function initialize_addons()
392
+	{
393
+		//foreach registered addon, make sure its db is up-to-date too
394
+		foreach ($this->registry->addons as $addon) {
395
+			$addon->initialize_db_if_no_migrations_required();
396
+		}
397
+	}
398
+
399
+
400
+
401
+	/**
402
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
403
+	 *
404
+	 * @param    array  $version_history
405
+	 * @param    string $current_version_to_add version to be added to the version history
406
+	 * @return    boolean success as to whether or not this option was changed
407
+	 */
408
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
409
+	{
410
+		if ( ! $version_history) {
411
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
412
+		}
413
+		if ($current_version_to_add == null) {
414
+			$current_version_to_add = espresso_version();
415
+		}
416
+		$version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
417
+		// re-save
418
+		return update_option('espresso_db_update', $version_history);
419
+	}
420
+
421
+
422
+
423
+	/**
424
+	 * Detects if the current version indicated in the has existed in the list of
425
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
426
+	 *
427
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
428
+	 *                                  If not supplied, fetches it from the options table.
429
+	 *                                  Also, caches its result so later parts of the code can also know whether
430
+	 *                                  there's been an update or not. This way we can add the current version to
431
+	 *                                  espresso_db_update, but still know if this is a new install or not
432
+	 * @return int one of the constants on EE_System::req_type_
433
+	 */
434
+	public function detect_req_type($espresso_db_update = null)
435
+	{
436
+		if ($this->_req_type === null) {
437
+			$espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
438
+				: $this->fix_espresso_db_upgrade_option();
439
+			$this->_req_type = $this->detect_req_type_given_activation_history($espresso_db_update,
440
+				'ee_espresso_activation', espresso_version());
441
+		}
442
+		return $this->_req_type;
443
+	}
444
+
445
+
446
+
447
+	/**
448
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
449
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the wordpress option which is temporarily
450
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
451
+	 * just activated to (for core that will always be espresso_version())
452
+	 *
453
+	 * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
454
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
455
+	 * @param string $activation_indicator_option_name the name of the wordpress option that is temporarily set to
456
+	 *                                                 indicate that this plugin was just activated
457
+	 * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
458
+	 *                                                 espresso_version())
459
+	 * @return int one of the constants on EE_System::req_type_*
460
+	 */
461
+	public static function detect_req_type_given_activation_history(
462
+		$activation_history_for_addon,
463
+		$activation_indicator_option_name,
464
+		$version_to_upgrade_to
465
+	) {
466
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
467
+		if ($activation_history_for_addon) {
468
+			//it exists, so this isn't a completely new install
469
+			//check if this version already in that list of previously installed versions
470
+			if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
471
+				//it a version we haven't seen before
472
+				if ($version_is_higher === 1) {
473
+					$req_type = EE_System::req_type_upgrade;
474
+				} else {
475
+					$req_type = EE_System::req_type_downgrade;
476
+				}
477
+				delete_option($activation_indicator_option_name);
478
+			} else {
479
+				// its not an update. maybe a reactivation?
480
+				if (get_option($activation_indicator_option_name, false)) {
481
+					if ($version_is_higher === -1) {
482
+						$req_type = EE_System::req_type_downgrade;
483
+					} elseif ($version_is_higher === 0) {
484
+						//we've seen this version before, but it's an activation. must be a reactivation
485
+						$req_type = EE_System::req_type_reactivation;
486
+					} else {//$version_is_higher === 1
487
+						$req_type = EE_System::req_type_upgrade;
488
+					}
489
+					delete_option($activation_indicator_option_name);
490
+				} else {
491
+					//we've seen this version before and the activation indicate doesn't show it was just activated
492
+					if ($version_is_higher === -1) {
493
+						$req_type = EE_System::req_type_downgrade;
494
+					} elseif ($version_is_higher === 0) {
495
+						//we've seen this version before and it's not an activation. its normal request
496
+						$req_type = EE_System::req_type_normal;
497
+					} else {//$version_is_higher === 1
498
+						$req_type = EE_System::req_type_upgrade;
499
+					}
500
+				}
501
+			}
502
+		} else {
503
+			//brand new install
504
+			$req_type = EE_System::req_type_new_activation;
505
+			delete_option($activation_indicator_option_name);
506
+		}
507
+		return $req_type;
508
+	}
509
+
510
+
511
+
512
+	/**
513
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
514
+	 * the $activation_history_for_addon
515
+	 *
516
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
517
+	 *                                             sometimes containing 'unknown-date'
518
+	 * @param string $version_to_upgrade_to        (current version)
519
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
520
+	 *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
521
+	 *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
522
+	 *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
523
+	 */
524
+	protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
525
+	{
526
+		//find the most recently-activated version
527
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
528
+		$most_recently_active_version = '0.0.0.dev.000';
529
+		if (is_array($activation_history_for_addon)) {
530
+			foreach ($activation_history_for_addon as $version => $times_activated) {
531
+				//check there is a record of when this version was activated. Otherwise,
532
+				//mark it as unknown
533
+				if ( ! $times_activated) {
534
+					$times_activated = array('unknown-date');
535
+				}
536
+				if (is_string($times_activated)) {
537
+					$times_activated = array($times_activated);
538
+				}
539
+				foreach ($times_activated as $an_activation) {
540
+					if ($an_activation != 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
541
+						$most_recently_active_version = $version;
542
+						$most_recently_active_version_activation = $an_activation == 'unknown-date'
543
+							? '1970-01-01 00:00:00' : $an_activation;
544
+					}
545
+				}
546
+			}
547
+		}
548
+		return version_compare($version_to_upgrade_to, $most_recently_active_version);
549
+	}
550
+
551
+
552
+
553
+	/**
554
+	 * This redirects to the about EE page after activation
555
+	 *
556
+	 * @return void
557
+	 */
558
+	public function redirect_to_about_ee()
559
+	{
560
+		$notices = EE_Error::get_notices(false);
561
+		//if current user is an admin and it's not an ajax request
562
+		if (
563
+			$this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
564
+			&& ! (defined('DOING_AJAX') && DOING_AJAX)
565
+			&& ! isset($notices['errors'])
566
+		) {
567
+			$query_params = array('page' => 'espresso_about');
568
+			if (EE_System::instance()->detect_req_type() == EE_System::req_type_new_activation) {
569
+				$query_params['new_activation'] = true;
570
+			}
571
+			if (EE_System::instance()->detect_req_type() == EE_System::req_type_reactivation) {
572
+				$query_params['reactivation'] = true;
573
+			}
574
+			$url = add_query_arg($query_params, admin_url('admin.php'));
575
+			wp_safe_redirect($url);
576
+			exit();
577
+		}
578
+	}
579
+
580
+
581
+
582
+	/**
583
+	 * load_core_configuration
584
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
585
+	 * which runs during the WP 'plugins_loaded' action at priority 5
586
+	 *
587
+	 * @return void
588
+	 */
589
+	public function load_core_configuration()
590
+	{
591
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
592
+		$this->registry->load_core('EE_Load_Textdomain');
593
+		//load textdomain
594
+		EE_Load_Textdomain::load_textdomain();
595
+		// load and setup EE_Config and EE_Network_Config
596
+		$this->registry->load_core('Config');
597
+		$this->registry->load_core('Network_Config');
598
+		// setup autoloaders
599
+		// enable logging?
600
+		if ($this->registry->CFG->admin->use_full_logging) {
601
+			$this->registry->load_core('Log');
602
+		}
603
+		// check for activation errors
604
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
605
+		if ($activation_errors) {
606
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
607
+			update_option('ee_plugin_activation_errors', false);
608
+		}
609
+		// get model names
610
+		$this->_parse_model_names();
611
+		//load caf stuff a chance to play during the activation process too.
612
+		$this->_maybe_brew_regular();
613
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
614
+	}
615
+
616
+
617
+
618
+	/**
619
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
620
+	 *
621
+	 * @return void
622
+	 */
623
+	private function _parse_model_names()
624
+	{
625
+		//get all the files in the EE_MODELS folder that end in .model.php
626
+		$models = glob(EE_MODELS . '*.model.php');
627
+		$model_names = array();
628
+		$non_abstract_db_models = array();
629
+		foreach ($models as $model) {
630
+			// get model classname
631
+			$classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
632
+			$short_name = str_replace('EEM_', '', $classname);
633
+			$reflectionClass = new ReflectionClass($classname);
634
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
635
+				$non_abstract_db_models[$short_name] = $classname;
636
+			}
637
+			$model_names[$short_name] = $classname;
638
+		}
639
+		$this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
640
+		$this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
641
+			$non_abstract_db_models);
642
+	}
643
+
644
+
645
+
646
+	/**
647
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
648
+	 * that need to be setup before our EE_System launches.
649
+	 *
650
+	 * @return void
651
+	 */
652
+	private function _maybe_brew_regular()
653
+	{
654
+		if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
655
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
656
+		}
657
+	}
658
+
659
+
660
+
661
+	/**
662
+	 * register_shortcodes_modules_and_widgets
663
+	 * generate lists of shortcodes and modules, then verify paths and classes
664
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
665
+	 * which runs during the WP 'plugins_loaded' action at priority 7
666
+	 *
667
+	 * @access public
668
+	 * @return void
669
+	 */
670
+	public function register_shortcodes_modules_and_widgets()
671
+	{
672
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
673
+		// check for addons using old hookpoint
674
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
675
+			$this->_incompatible_addon_error();
676
+		}
677
+	}
678
+
679
+
680
+
681
+	/**
682
+	 * _incompatible_addon_error
683
+	 *
684
+	 * @access public
685
+	 * @return void
686
+	 */
687
+	private function _incompatible_addon_error()
688
+	{
689
+		// get array of classes hooking into here
690
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
691
+		if ( ! empty($class_names)) {
692
+			$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:',
693
+				'event_espresso');
694
+			$msg .= '<ul>';
695
+			foreach ($class_names as $class_name) {
696
+				$msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
697
+						$class_name) . '</b></li>';
698
+			}
699
+			$msg .= '</ul>';
700
+			$msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
701
+				'event_espresso');
702
+			// save list of incompatible addons to wp-options for later use
703
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
704
+			if (is_admin()) {
705
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
706
+			}
707
+		}
708
+	}
709
+
710
+
711
+
712
+	/**
713
+	 * brew_espresso
714
+	 * begins the process of setting hooks for initializing EE in the correct order
715
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hookpoint
716
+	 * which runs during the WP 'plugins_loaded' action at priority 9
717
+	 *
718
+	 * @return void
719
+	 */
720
+	public function brew_espresso()
721
+	{
722
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
723
+		// load some final core systems
724
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
725
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
726
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
727
+		add_action('init', array($this, 'load_controllers'), 7);
728
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
729
+		add_action('init', array($this, 'initialize'), 10);
730
+		add_action('init', array($this, 'initialize_last'), 100);
731
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 25);
732
+		add_action('admin_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 25);
733
+		add_action('admin_bar_menu', array($this, 'espresso_toolbar_items'), 100);
734
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
735
+			// pew pew pew
736
+			$this->registry->load_core('PUE');
737
+			do_action('AHEE__EE_System__brew_espresso__after_pue_init');
738
+		}
739
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
740
+	}
741
+
742
+
743
+
744
+	/**
745
+	 *    set_hooks_for_core
746
+	 *
747
+	 * @access public
748
+	 * @return    void
749
+	 */
750
+	public function set_hooks_for_core()
751
+	{
752
+		$this->_deactivate_incompatible_addons();
753
+		do_action('AHEE__EE_System__set_hooks_for_core');
754
+	}
755
+
756
+
757
+
758
+	/**
759
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
760
+	 * deactivates any addons considered incompatible with the current version of EE
761
+	 */
762
+	private function _deactivate_incompatible_addons()
763
+	{
764
+		$incompatible_addons = get_option('ee_incompatible_addons', array());
765
+		if ( ! empty($incompatible_addons)) {
766
+			$active_plugins = get_option('active_plugins', array());
767
+			foreach ($active_plugins as $active_plugin) {
768
+				foreach ($incompatible_addons as $incompatible_addon) {
769
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
770
+						unset($_GET['activate']);
771
+						espresso_deactivate_plugin($active_plugin);
772
+					}
773
+				}
774
+			}
775
+		}
776
+	}
777
+
778
+
779
+
780
+	/**
781
+	 *    perform_activations_upgrades_and_migrations
782
+	 *
783
+	 * @access public
784
+	 * @return    void
785
+	 */
786
+	public function perform_activations_upgrades_and_migrations()
787
+	{
788
+		//first check if we had previously attempted to setup EE's directories but failed
789
+		if (EEH_Activation::upload_directories_incomplete()) {
790
+			EEH_Activation::create_upload_directories();
791
+		}
792
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
793
+	}
794
+
795
+
796
+
797
+	/**
798
+	 *    load_CPTs_and_session
799
+	 *
800
+	 * @access public
801
+	 * @return    void
802
+	 */
803
+	public function load_CPTs_and_session()
804
+	{
805
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
806
+		// register Custom Post Types
807
+		$this->registry->load_core('Register_CPTs');
808
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
809
+	}
810
+
811
+
812
+
813
+	/**
814
+	 * load_controllers
815
+	 * this is the best place to load any additional controllers that needs access to EE core.
816
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
817
+	 * time
818
+	 *
819
+	 * @access public
820
+	 * @return void
821
+	 */
822
+	public function load_controllers()
823
+	{
824
+		do_action('AHEE__EE_System__load_controllers__start');
825
+		// let's get it started
826
+		if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
827
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
828
+			$this->registry->load_core('Front_Controller', array(), false, true);
829
+		} else if ( ! EE_FRONT_AJAX) {
830
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
831
+			EE_Registry::instance()->load_core('Admin');
832
+		}
833
+		do_action('AHEE__EE_System__load_controllers__complete');
834
+	}
835
+
836
+
837
+
838
+	/**
839
+	 * core_loaded_and_ready
840
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
841
+	 *
842
+	 * @access public
843
+	 * @return void
844
+	 */
845
+	public function core_loaded_and_ready()
846
+	{
847
+		do_action('AHEE__EE_System__core_loaded_and_ready');
848
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
849
+		$this->registry->load_core('Session');
850
+		//		add_action( 'wp_loaded', array( $this, 'set_hooks_for_shortcodes_modules_and_addons' ), 1 );
851
+	}
852
+
853
+
854
+
855
+	/**
856
+	 * initialize
857
+	 * this is the best place to begin initializing client code
858
+	 *
859
+	 * @access public
860
+	 * @return void
861
+	 */
862
+	public function initialize()
863
+	{
864
+		do_action('AHEE__EE_System__initialize');
865
+	}
866
+
867
+
868
+
869
+	/**
870
+	 * initialize_last
871
+	 * this is run really late during the WP init hookpoint, and ensures that mostly everything else that needs to
872
+	 * initialize has done so
873
+	 *
874
+	 * @access public
875
+	 * @return void
876
+	 */
877
+	public function initialize_last()
878
+	{
879
+		do_action('AHEE__EE_System__initialize_last');
880
+	}
881
+
882
+
883
+
884
+	/**
885
+	 * set_hooks_for_shortcodes_modules_and_addons
886
+	 * this is the best place for other systems to set callbacks for hooking into other parts of EE
887
+	 * this happens at the very beginning of the wp_loaded hookpoint
888
+	 *
889
+	 * @access public
890
+	 * @return void
891
+	 */
892
+	public function set_hooks_for_shortcodes_modules_and_addons()
893
+	{
894 894
 //		do_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons' );
895
-    }
896
-
897
-
898
-
899
-    /**
900
-     * do_not_cache
901
-     * sets no cache headers and defines no cache constants for WP plugins
902
-     *
903
-     * @access public
904
-     * @return void
905
-     */
906
-    public static function do_not_cache()
907
-    {
908
-        // set no cache constants
909
-        if ( ! defined('DONOTCACHEPAGE')) {
910
-            define('DONOTCACHEPAGE', true);
911
-        }
912
-        if ( ! defined('DONOTCACHCEOBJECT')) {
913
-            define('DONOTCACHCEOBJECT', true);
914
-        }
915
-        if ( ! defined('DONOTCACHEDB')) {
916
-            define('DONOTCACHEDB', true);
917
-        }
918
-        // add no cache headers
919
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
920
-        // plus a little extra for nginx and Google Chrome
921
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
922
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
923
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
924
-    }
925
-
926
-
927
-
928
-    /**
929
-     *    extra_nocache_headers
930
-     *
931
-     * @access    public
932
-     * @param $headers
933
-     * @return    array
934
-     */
935
-    public static function extra_nocache_headers($headers)
936
-    {
937
-        // for NGINX
938
-        $headers['X-Accel-Expires'] = 0;
939
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
940
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
941
-        return $headers;
942
-    }
943
-
944
-
945
-
946
-    /**
947
-     *    nocache_headers
948
-     *
949
-     * @access    public
950
-     * @return    void
951
-     */
952
-    public static function nocache_headers()
953
-    {
954
-        nocache_headers();
955
-    }
956
-
957
-
958
-
959
-    /**
960
-     *    espresso_toolbar_items
961
-     *
962
-     * @access public
963
-     * @param  WP_Admin_Bar $admin_bar
964
-     * @return void
965
-     */
966
-    public function espresso_toolbar_items(WP_Admin_Bar $admin_bar)
967
-    {
968
-        // if in full M-Mode, or its an AJAX request, or user is NOT an admin
969
-        if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
970
-            || defined('DOING_AJAX')
971
-            || ! $this->registry->CAP->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
972
-        ) {
973
-            return;
974
-        }
975
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
976
-        $menu_class = 'espresso_menu_item_class';
977
-        //we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
978
-        //because they're only defined in each of their respective constructors
979
-        //and this might be a frontend request, in which case they aren't available
980
-        $events_admin_url = admin_url("admin.php?page=espresso_events");
981
-        $reg_admin_url = admin_url("admin.php?page=espresso_registrations");
982
-        $extensions_admin_url = admin_url("admin.php?page=espresso_packages");
983
-        //Top Level
984
-        $admin_bar->add_menu(array(
985
-            'id'    => 'espresso-toolbar',
986
-            'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
987
-                       . _x('Event Espresso', 'admin bar menu group label', 'event_espresso')
988
-                       . '</span>',
989
-            'href'  => $events_admin_url,
990
-            'meta'  => array(
991
-                'title' => __('Event Espresso', 'event_espresso'),
992
-                'class' => $menu_class . 'first',
993
-            ),
994
-        ));
995
-        //Events
996
-        if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events')) {
997
-            $admin_bar->add_menu(array(
998
-                'id'     => 'espresso-toolbar-events',
999
-                'parent' => 'espresso-toolbar',
1000
-                'title'  => __('Events', 'event_espresso'),
1001
-                'href'   => $events_admin_url,
1002
-                'meta'   => array(
1003
-                    'title'  => __('Events', 'event_espresso'),
1004
-                    'target' => '',
1005
-                    'class'  => $menu_class,
1006
-                ),
1007
-            ));
1008
-        }
1009
-        if ($this->registry->CAP->current_user_can('ee_edit_events', 'ee_admin_bar_menu_espresso-toolbar-events-new')) {
1010
-            //Events Add New
1011
-            $admin_bar->add_menu(array(
1012
-                'id'     => 'espresso-toolbar-events-new',
1013
-                'parent' => 'espresso-toolbar-events',
1014
-                'title'  => __('Add New', 'event_espresso'),
1015
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'create_new'), $events_admin_url),
1016
-                'meta'   => array(
1017
-                    'title'  => __('Add New', 'event_espresso'),
1018
-                    'target' => '',
1019
-                    'class'  => $menu_class,
1020
-                ),
1021
-            ));
1022
-        }
1023
-        if (is_single() && (get_post_type() == 'espresso_events')) {
1024
-            //Current post
1025
-            global $post;
1026
-            if ($this->registry->CAP->current_user_can('ee_edit_event',
1027
-                'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID)
1028
-            ) {
1029
-                //Events Edit Current Event
1030
-                $admin_bar->add_menu(array(
1031
-                    'id'     => 'espresso-toolbar-events-edit',
1032
-                    'parent' => 'espresso-toolbar-events',
1033
-                    'title'  => __('Edit Event', 'event_espresso'),
1034
-                    'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'edit', 'post' => $post->ID),
1035
-                        $events_admin_url),
1036
-                    'meta'   => array(
1037
-                        'title'  => __('Edit Event', 'event_espresso'),
1038
-                        'target' => '',
1039
-                        'class'  => $menu_class,
1040
-                    ),
1041
-                ));
1042
-            }
1043
-        }
1044
-        //Events View
1045
-        if ($this->registry->CAP->current_user_can('ee_read_events',
1046
-            'ee_admin_bar_menu_espresso-toolbar-events-view')
1047
-        ) {
1048
-            $admin_bar->add_menu(array(
1049
-                'id'     => 'espresso-toolbar-events-view',
1050
-                'parent' => 'espresso-toolbar-events',
1051
-                'title'  => __('View', 'event_espresso'),
1052
-                'href'   => $events_admin_url,
1053
-                'meta'   => array(
1054
-                    'title'  => __('View', 'event_espresso'),
1055
-                    'target' => '',
1056
-                    'class'  => $menu_class,
1057
-                ),
1058
-            ));
1059
-        }
1060
-        if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events-all')) {
1061
-            //Events View All
1062
-            $admin_bar->add_menu(array(
1063
-                'id'     => 'espresso-toolbar-events-all',
1064
-                'parent' => 'espresso-toolbar-events-view',
1065
-                'title'  => __('All', 'event_espresso'),
1066
-                'href'   => $events_admin_url,
1067
-                'meta'   => array(
1068
-                    'title'  => __('All', 'event_espresso'),
1069
-                    'target' => '',
1070
-                    'class'  => $menu_class,
1071
-                ),
1072
-            ));
1073
-        }
1074
-        if ($this->registry->CAP->current_user_can('ee_read_events',
1075
-            'ee_admin_bar_menu_espresso-toolbar-events-today')
1076
-        ) {
1077
-            //Events View Today
1078
-            $admin_bar->add_menu(array(
1079
-                'id'     => 'espresso-toolbar-events-today',
1080
-                'parent' => 'espresso-toolbar-events-view',
1081
-                'title'  => __('Today', 'event_espresso'),
1082
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
1083
-                    $events_admin_url),
1084
-                'meta'   => array(
1085
-                    'title'  => __('Today', 'event_espresso'),
1086
-                    'target' => '',
1087
-                    'class'  => $menu_class,
1088
-                ),
1089
-            ));
1090
-        }
1091
-        if ($this->registry->CAP->current_user_can('ee_read_events',
1092
-            'ee_admin_bar_menu_espresso-toolbar-events-month')
1093
-        ) {
1094
-            //Events View This Month
1095
-            $admin_bar->add_menu(array(
1096
-                'id'     => 'espresso-toolbar-events-month',
1097
-                'parent' => 'espresso-toolbar-events-view',
1098
-                'title'  => __('This Month', 'event_espresso'),
1099
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
1100
-                    $events_admin_url),
1101
-                'meta'   => array(
1102
-                    'title'  => __('This Month', 'event_espresso'),
1103
-                    'target' => '',
1104
-                    'class'  => $menu_class,
1105
-                ),
1106
-            ));
1107
-        }
1108
-        //Registration Overview
1109
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1110
-            'ee_admin_bar_menu_espresso-toolbar-registrations')
1111
-        ) {
1112
-            $admin_bar->add_menu(array(
1113
-                'id'     => 'espresso-toolbar-registrations',
1114
-                'parent' => 'espresso-toolbar',
1115
-                'title'  => __('Registrations', 'event_espresso'),
1116
-                'href'   => $reg_admin_url,
1117
-                'meta'   => array(
1118
-                    'title'  => __('Registrations', 'event_espresso'),
1119
-                    'target' => '',
1120
-                    'class'  => $menu_class,
1121
-                ),
1122
-            ));
1123
-        }
1124
-        //Registration Overview Today
1125
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1126
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today')
1127
-        ) {
1128
-            $admin_bar->add_menu(array(
1129
-                'id'     => 'espresso-toolbar-registrations-today',
1130
-                'parent' => 'espresso-toolbar-registrations',
1131
-                'title'  => __('Today', 'event_espresso'),
1132
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
1133
-                    $reg_admin_url),
1134
-                'meta'   => array(
1135
-                    'title'  => __('Today', 'event_espresso'),
1136
-                    'target' => '',
1137
-                    'class'  => $menu_class,
1138
-                ),
1139
-            ));
1140
-        }
1141
-        //Registration Overview Today Completed
1142
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1143
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved')
1144
-        ) {
1145
-            $admin_bar->add_menu(array(
1146
-                'id'     => 'espresso-toolbar-registrations-today-approved',
1147
-                'parent' => 'espresso-toolbar-registrations-today',
1148
-                'title'  => __('Approved', 'event_espresso'),
1149
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1150
-                    'action'      => 'default',
1151
-                    'status'      => 'today',
1152
-                    '_reg_status' => EEM_Registration::status_id_approved,
1153
-                ), $reg_admin_url),
1154
-                'meta'   => array(
1155
-                    'title'  => __('Approved', 'event_espresso'),
1156
-                    'target' => '',
1157
-                    'class'  => $menu_class,
1158
-                ),
1159
-            ));
1160
-        }
1161
-        //Registration Overview Today Pending\
1162
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1163
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending')
1164
-        ) {
1165
-            $admin_bar->add_menu(array(
1166
-                'id'     => 'espresso-toolbar-registrations-today-pending',
1167
-                'parent' => 'espresso-toolbar-registrations-today',
1168
-                'title'  => __('Pending', 'event_espresso'),
1169
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1170
-                    'action'     => 'default',
1171
-                    'status'     => 'today',
1172
-                    'reg_status' => EEM_Registration::status_id_pending_payment,
1173
-                ), $reg_admin_url),
1174
-                'meta'   => array(
1175
-                    'title'  => __('Pending Payment', 'event_espresso'),
1176
-                    'target' => '',
1177
-                    'class'  => $menu_class,
1178
-                ),
1179
-            ));
1180
-        }
1181
-        //Registration Overview Today Incomplete
1182
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1183
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved')
1184
-        ) {
1185
-            $admin_bar->add_menu(array(
1186
-                'id'     => 'espresso-toolbar-registrations-today-not-approved',
1187
-                'parent' => 'espresso-toolbar-registrations-today',
1188
-                'title'  => __('Not Approved', 'event_espresso'),
1189
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1190
-                    'action'      => 'default',
1191
-                    'status'      => 'today',
1192
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
1193
-                ), $reg_admin_url),
1194
-                'meta'   => array(
1195
-                    'title'  => __('Not Approved', 'event_espresso'),
1196
-                    'target' => '',
1197
-                    'class'  => $menu_class,
1198
-                ),
1199
-            ));
1200
-        }
1201
-        //Registration Overview Today Incomplete
1202
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1203
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled')
1204
-        ) {
1205
-            $admin_bar->add_menu(array(
1206
-                'id'     => 'espresso-toolbar-registrations-today-cancelled',
1207
-                'parent' => 'espresso-toolbar-registrations-today',
1208
-                'title'  => __('Cancelled', 'event_espresso'),
1209
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1210
-                    'action'      => 'default',
1211
-                    'status'      => 'today',
1212
-                    '_reg_status' => EEM_Registration::status_id_cancelled,
1213
-                ), $reg_admin_url),
1214
-                'meta'   => array(
1215
-                    'title'  => __('Cancelled', 'event_espresso'),
1216
-                    'target' => '',
1217
-                    'class'  => $menu_class,
1218
-                ),
1219
-            ));
1220
-        }
1221
-        //Registration Overview This Month
1222
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1223
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month')
1224
-        ) {
1225
-            $admin_bar->add_menu(array(
1226
-                'id'     => 'espresso-toolbar-registrations-month',
1227
-                'parent' => 'espresso-toolbar-registrations',
1228
-                'title'  => __('This Month', 'event_espresso'),
1229
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
1230
-                    $reg_admin_url),
1231
-                'meta'   => array(
1232
-                    'title'  => __('This Month', 'event_espresso'),
1233
-                    'target' => '',
1234
-                    'class'  => $menu_class,
1235
-                ),
1236
-            ));
1237
-        }
1238
-        //Registration Overview This Month Approved
1239
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1240
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved')
1241
-        ) {
1242
-            $admin_bar->add_menu(array(
1243
-                'id'     => 'espresso-toolbar-registrations-month-approved',
1244
-                'parent' => 'espresso-toolbar-registrations-month',
1245
-                'title'  => __('Approved', 'event_espresso'),
1246
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1247
-                    'action'      => 'default',
1248
-                    'status'      => 'month',
1249
-                    '_reg_status' => EEM_Registration::status_id_approved,
1250
-                ), $reg_admin_url),
1251
-                'meta'   => array(
1252
-                    'title'  => __('Approved', 'event_espresso'),
1253
-                    'target' => '',
1254
-                    'class'  => $menu_class,
1255
-                ),
1256
-            ));
1257
-        }
1258
-        //Registration Overview This Month Pending
1259
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1260
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending')
1261
-        ) {
1262
-            $admin_bar->add_menu(array(
1263
-                'id'     => 'espresso-toolbar-registrations-month-pending',
1264
-                'parent' => 'espresso-toolbar-registrations-month',
1265
-                'title'  => __('Pending', 'event_espresso'),
1266
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1267
-                    'action'      => 'default',
1268
-                    'status'      => 'month',
1269
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
1270
-                ), $reg_admin_url),
1271
-                'meta'   => array(
1272
-                    'title'  => __('Pending', 'event_espresso'),
1273
-                    'target' => '',
1274
-                    'class'  => $menu_class,
1275
-                ),
1276
-            ));
1277
-        }
1278
-        //Registration Overview This Month Not Approved
1279
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1280
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved')
1281
-        ) {
1282
-            $admin_bar->add_menu(array(
1283
-                'id'     => 'espresso-toolbar-registrations-month-not-approved',
1284
-                'parent' => 'espresso-toolbar-registrations-month',
1285
-                'title'  => __('Not Approved', 'event_espresso'),
1286
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1287
-                    'action'      => 'default',
1288
-                    'status'      => 'month',
1289
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
1290
-                ), $reg_admin_url),
1291
-                'meta'   => array(
1292
-                    'title'  => __('Not Approved', 'event_espresso'),
1293
-                    'target' => '',
1294
-                    'class'  => $menu_class,
1295
-                ),
1296
-            ));
1297
-        }
1298
-        //Registration Overview This Month Cancelled
1299
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
1300
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled')
1301
-        ) {
1302
-            $admin_bar->add_menu(array(
1303
-                'id'     => 'espresso-toolbar-registrations-month-cancelled',
1304
-                'parent' => 'espresso-toolbar-registrations-month',
1305
-                'title'  => __('Cancelled', 'event_espresso'),
1306
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
1307
-                    'action'      => 'default',
1308
-                    'status'      => 'month',
1309
-                    '_reg_status' => EEM_Registration::status_id_cancelled,
1310
-                ), $reg_admin_url),
1311
-                'meta'   => array(
1312
-                    'title'  => __('Cancelled', 'event_espresso'),
1313
-                    'target' => '',
1314
-                    'class'  => $menu_class,
1315
-                ),
1316
-            ));
1317
-        }
1318
-        //Extensions & Services
1319
-        if ($this->registry->CAP->current_user_can('ee_read_ee',
1320
-            'ee_admin_bar_menu_espresso-toolbar-extensions-and-services')
1321
-        ) {
1322
-            $admin_bar->add_menu(array(
1323
-                'id'     => 'espresso-toolbar-extensions-and-services',
1324
-                'parent' => 'espresso-toolbar',
1325
-                'title'  => __('Extensions & Services', 'event_espresso'),
1326
-                'href'   => $extensions_admin_url,
1327
-                'meta'   => array(
1328
-                    'title'  => __('Extensions & Services', 'event_espresso'),
1329
-                    'target' => '',
1330
-                    'class'  => $menu_class,
1331
-                ),
1332
-            ));
1333
-        }
1334
-    }
1335
-
1336
-
1337
-
1338
-    /**
1339
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
1340
-     * never returned with the function.
1341
-     *
1342
-     * @param  array $exclude_array any existing pages being excluded are in this array.
1343
-     * @return array
1344
-     */
1345
-    public function remove_pages_from_wp_list_pages($exclude_array)
1346
-    {
1347
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
1348
-    }
1349
-
1350
-
1351
-
1352
-
1353
-
1354
-
1355
-    /***********************************************        WP_ENQUEUE_SCRIPTS HOOK         ***********************************************/
1356
-    /**
1357
-     *    wp_enqueue_scripts
1358
-     *
1359
-     * @access    public
1360
-     * @return    void
1361
-     */
1362
-    public function wp_enqueue_scripts()
1363
-    {
1364
-        // 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' );
1365
-        if (apply_filters('FHEE_load_EE_System_scripts', true)) {
1366
-            // 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' );
1367
-            if (apply_filters('FHEE_load_jquery_validate', false)) {
1368
-                // register jQuery Validate and additional methods
1369
-                wp_register_script('jquery-validate', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
1370
-                    array('jquery'), '1.15.0', true);
1371
-                wp_register_script('jquery-validate-extra-methods',
1372
-                    EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
1373
-                    array('jquery', 'jquery-validate'), '1.15.0', true);
1374
-            }
1375
-        }
1376
-    }
895
+	}
896
+
897
+
898
+
899
+	/**
900
+	 * do_not_cache
901
+	 * sets no cache headers and defines no cache constants for WP plugins
902
+	 *
903
+	 * @access public
904
+	 * @return void
905
+	 */
906
+	public static function do_not_cache()
907
+	{
908
+		// set no cache constants
909
+		if ( ! defined('DONOTCACHEPAGE')) {
910
+			define('DONOTCACHEPAGE', true);
911
+		}
912
+		if ( ! defined('DONOTCACHCEOBJECT')) {
913
+			define('DONOTCACHCEOBJECT', true);
914
+		}
915
+		if ( ! defined('DONOTCACHEDB')) {
916
+			define('DONOTCACHEDB', true);
917
+		}
918
+		// add no cache headers
919
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
920
+		// plus a little extra for nginx and Google Chrome
921
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
922
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
923
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
924
+	}
925
+
926
+
927
+
928
+	/**
929
+	 *    extra_nocache_headers
930
+	 *
931
+	 * @access    public
932
+	 * @param $headers
933
+	 * @return    array
934
+	 */
935
+	public static function extra_nocache_headers($headers)
936
+	{
937
+		// for NGINX
938
+		$headers['X-Accel-Expires'] = 0;
939
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
940
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
941
+		return $headers;
942
+	}
943
+
944
+
945
+
946
+	/**
947
+	 *    nocache_headers
948
+	 *
949
+	 * @access    public
950
+	 * @return    void
951
+	 */
952
+	public static function nocache_headers()
953
+	{
954
+		nocache_headers();
955
+	}
956
+
957
+
958
+
959
+	/**
960
+	 *    espresso_toolbar_items
961
+	 *
962
+	 * @access public
963
+	 * @param  WP_Admin_Bar $admin_bar
964
+	 * @return void
965
+	 */
966
+	public function espresso_toolbar_items(WP_Admin_Bar $admin_bar)
967
+	{
968
+		// if in full M-Mode, or its an AJAX request, or user is NOT an admin
969
+		if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
970
+			|| defined('DOING_AJAX')
971
+			|| ! $this->registry->CAP->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
972
+		) {
973
+			return;
974
+		}
975
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
976
+		$menu_class = 'espresso_menu_item_class';
977
+		//we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
978
+		//because they're only defined in each of their respective constructors
979
+		//and this might be a frontend request, in which case they aren't available
980
+		$events_admin_url = admin_url("admin.php?page=espresso_events");
981
+		$reg_admin_url = admin_url("admin.php?page=espresso_registrations");
982
+		$extensions_admin_url = admin_url("admin.php?page=espresso_packages");
983
+		//Top Level
984
+		$admin_bar->add_menu(array(
985
+			'id'    => 'espresso-toolbar',
986
+			'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
987
+					   . _x('Event Espresso', 'admin bar menu group label', 'event_espresso')
988
+					   . '</span>',
989
+			'href'  => $events_admin_url,
990
+			'meta'  => array(
991
+				'title' => __('Event Espresso', 'event_espresso'),
992
+				'class' => $menu_class . 'first',
993
+			),
994
+		));
995
+		//Events
996
+		if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events')) {
997
+			$admin_bar->add_menu(array(
998
+				'id'     => 'espresso-toolbar-events',
999
+				'parent' => 'espresso-toolbar',
1000
+				'title'  => __('Events', 'event_espresso'),
1001
+				'href'   => $events_admin_url,
1002
+				'meta'   => array(
1003
+					'title'  => __('Events', 'event_espresso'),
1004
+					'target' => '',
1005
+					'class'  => $menu_class,
1006
+				),
1007
+			));
1008
+		}
1009
+		if ($this->registry->CAP->current_user_can('ee_edit_events', 'ee_admin_bar_menu_espresso-toolbar-events-new')) {
1010
+			//Events Add New
1011
+			$admin_bar->add_menu(array(
1012
+				'id'     => 'espresso-toolbar-events-new',
1013
+				'parent' => 'espresso-toolbar-events',
1014
+				'title'  => __('Add New', 'event_espresso'),
1015
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'create_new'), $events_admin_url),
1016
+				'meta'   => array(
1017
+					'title'  => __('Add New', 'event_espresso'),
1018
+					'target' => '',
1019
+					'class'  => $menu_class,
1020
+				),
1021
+			));
1022
+		}
1023
+		if (is_single() && (get_post_type() == 'espresso_events')) {
1024
+			//Current post
1025
+			global $post;
1026
+			if ($this->registry->CAP->current_user_can('ee_edit_event',
1027
+				'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID)
1028
+			) {
1029
+				//Events Edit Current Event
1030
+				$admin_bar->add_menu(array(
1031
+					'id'     => 'espresso-toolbar-events-edit',
1032
+					'parent' => 'espresso-toolbar-events',
1033
+					'title'  => __('Edit Event', 'event_espresso'),
1034
+					'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'edit', 'post' => $post->ID),
1035
+						$events_admin_url),
1036
+					'meta'   => array(
1037
+						'title'  => __('Edit Event', 'event_espresso'),
1038
+						'target' => '',
1039
+						'class'  => $menu_class,
1040
+					),
1041
+				));
1042
+			}
1043
+		}
1044
+		//Events View
1045
+		if ($this->registry->CAP->current_user_can('ee_read_events',
1046
+			'ee_admin_bar_menu_espresso-toolbar-events-view')
1047
+		) {
1048
+			$admin_bar->add_menu(array(
1049
+				'id'     => 'espresso-toolbar-events-view',
1050
+				'parent' => 'espresso-toolbar-events',
1051
+				'title'  => __('View', 'event_espresso'),
1052
+				'href'   => $events_admin_url,
1053
+				'meta'   => array(
1054
+					'title'  => __('View', 'event_espresso'),
1055
+					'target' => '',
1056
+					'class'  => $menu_class,
1057
+				),
1058
+			));
1059
+		}
1060
+		if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events-all')) {
1061
+			//Events View All
1062
+			$admin_bar->add_menu(array(
1063
+				'id'     => 'espresso-toolbar-events-all',
1064
+				'parent' => 'espresso-toolbar-events-view',
1065
+				'title'  => __('All', 'event_espresso'),
1066
+				'href'   => $events_admin_url,
1067
+				'meta'   => array(
1068
+					'title'  => __('All', 'event_espresso'),
1069
+					'target' => '',
1070
+					'class'  => $menu_class,
1071
+				),
1072
+			));
1073
+		}
1074
+		if ($this->registry->CAP->current_user_can('ee_read_events',
1075
+			'ee_admin_bar_menu_espresso-toolbar-events-today')
1076
+		) {
1077
+			//Events View Today
1078
+			$admin_bar->add_menu(array(
1079
+				'id'     => 'espresso-toolbar-events-today',
1080
+				'parent' => 'espresso-toolbar-events-view',
1081
+				'title'  => __('Today', 'event_espresso'),
1082
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
1083
+					$events_admin_url),
1084
+				'meta'   => array(
1085
+					'title'  => __('Today', 'event_espresso'),
1086
+					'target' => '',
1087
+					'class'  => $menu_class,
1088
+				),
1089
+			));
1090
+		}
1091
+		if ($this->registry->CAP->current_user_can('ee_read_events',
1092
+			'ee_admin_bar_menu_espresso-toolbar-events-month')
1093
+		) {
1094
+			//Events View This Month
1095
+			$admin_bar->add_menu(array(
1096
+				'id'     => 'espresso-toolbar-events-month',
1097
+				'parent' => 'espresso-toolbar-events-view',
1098
+				'title'  => __('This Month', 'event_espresso'),
1099
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
1100
+					$events_admin_url),
1101
+				'meta'   => array(
1102
+					'title'  => __('This Month', 'event_espresso'),
1103
+					'target' => '',
1104
+					'class'  => $menu_class,
1105
+				),
1106
+			));
1107
+		}
1108
+		//Registration Overview
1109
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1110
+			'ee_admin_bar_menu_espresso-toolbar-registrations')
1111
+		) {
1112
+			$admin_bar->add_menu(array(
1113
+				'id'     => 'espresso-toolbar-registrations',
1114
+				'parent' => 'espresso-toolbar',
1115
+				'title'  => __('Registrations', 'event_espresso'),
1116
+				'href'   => $reg_admin_url,
1117
+				'meta'   => array(
1118
+					'title'  => __('Registrations', 'event_espresso'),
1119
+					'target' => '',
1120
+					'class'  => $menu_class,
1121
+				),
1122
+			));
1123
+		}
1124
+		//Registration Overview Today
1125
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1126
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today')
1127
+		) {
1128
+			$admin_bar->add_menu(array(
1129
+				'id'     => 'espresso-toolbar-registrations-today',
1130
+				'parent' => 'espresso-toolbar-registrations',
1131
+				'title'  => __('Today', 'event_espresso'),
1132
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
1133
+					$reg_admin_url),
1134
+				'meta'   => array(
1135
+					'title'  => __('Today', 'event_espresso'),
1136
+					'target' => '',
1137
+					'class'  => $menu_class,
1138
+				),
1139
+			));
1140
+		}
1141
+		//Registration Overview Today Completed
1142
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1143
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved')
1144
+		) {
1145
+			$admin_bar->add_menu(array(
1146
+				'id'     => 'espresso-toolbar-registrations-today-approved',
1147
+				'parent' => 'espresso-toolbar-registrations-today',
1148
+				'title'  => __('Approved', 'event_espresso'),
1149
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1150
+					'action'      => 'default',
1151
+					'status'      => 'today',
1152
+					'_reg_status' => EEM_Registration::status_id_approved,
1153
+				), $reg_admin_url),
1154
+				'meta'   => array(
1155
+					'title'  => __('Approved', 'event_espresso'),
1156
+					'target' => '',
1157
+					'class'  => $menu_class,
1158
+				),
1159
+			));
1160
+		}
1161
+		//Registration Overview Today Pending\
1162
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1163
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending')
1164
+		) {
1165
+			$admin_bar->add_menu(array(
1166
+				'id'     => 'espresso-toolbar-registrations-today-pending',
1167
+				'parent' => 'espresso-toolbar-registrations-today',
1168
+				'title'  => __('Pending', 'event_espresso'),
1169
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1170
+					'action'     => 'default',
1171
+					'status'     => 'today',
1172
+					'reg_status' => EEM_Registration::status_id_pending_payment,
1173
+				), $reg_admin_url),
1174
+				'meta'   => array(
1175
+					'title'  => __('Pending Payment', 'event_espresso'),
1176
+					'target' => '',
1177
+					'class'  => $menu_class,
1178
+				),
1179
+			));
1180
+		}
1181
+		//Registration Overview Today Incomplete
1182
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1183
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved')
1184
+		) {
1185
+			$admin_bar->add_menu(array(
1186
+				'id'     => 'espresso-toolbar-registrations-today-not-approved',
1187
+				'parent' => 'espresso-toolbar-registrations-today',
1188
+				'title'  => __('Not Approved', 'event_espresso'),
1189
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1190
+					'action'      => 'default',
1191
+					'status'      => 'today',
1192
+					'_reg_status' => EEM_Registration::status_id_not_approved,
1193
+				), $reg_admin_url),
1194
+				'meta'   => array(
1195
+					'title'  => __('Not Approved', 'event_espresso'),
1196
+					'target' => '',
1197
+					'class'  => $menu_class,
1198
+				),
1199
+			));
1200
+		}
1201
+		//Registration Overview Today Incomplete
1202
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1203
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled')
1204
+		) {
1205
+			$admin_bar->add_menu(array(
1206
+				'id'     => 'espresso-toolbar-registrations-today-cancelled',
1207
+				'parent' => 'espresso-toolbar-registrations-today',
1208
+				'title'  => __('Cancelled', 'event_espresso'),
1209
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1210
+					'action'      => 'default',
1211
+					'status'      => 'today',
1212
+					'_reg_status' => EEM_Registration::status_id_cancelled,
1213
+				), $reg_admin_url),
1214
+				'meta'   => array(
1215
+					'title'  => __('Cancelled', 'event_espresso'),
1216
+					'target' => '',
1217
+					'class'  => $menu_class,
1218
+				),
1219
+			));
1220
+		}
1221
+		//Registration Overview This Month
1222
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1223
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month')
1224
+		) {
1225
+			$admin_bar->add_menu(array(
1226
+				'id'     => 'espresso-toolbar-registrations-month',
1227
+				'parent' => 'espresso-toolbar-registrations',
1228
+				'title'  => __('This Month', 'event_espresso'),
1229
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
1230
+					$reg_admin_url),
1231
+				'meta'   => array(
1232
+					'title'  => __('This Month', 'event_espresso'),
1233
+					'target' => '',
1234
+					'class'  => $menu_class,
1235
+				),
1236
+			));
1237
+		}
1238
+		//Registration Overview This Month Approved
1239
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1240
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved')
1241
+		) {
1242
+			$admin_bar->add_menu(array(
1243
+				'id'     => 'espresso-toolbar-registrations-month-approved',
1244
+				'parent' => 'espresso-toolbar-registrations-month',
1245
+				'title'  => __('Approved', 'event_espresso'),
1246
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1247
+					'action'      => 'default',
1248
+					'status'      => 'month',
1249
+					'_reg_status' => EEM_Registration::status_id_approved,
1250
+				), $reg_admin_url),
1251
+				'meta'   => array(
1252
+					'title'  => __('Approved', 'event_espresso'),
1253
+					'target' => '',
1254
+					'class'  => $menu_class,
1255
+				),
1256
+			));
1257
+		}
1258
+		//Registration Overview This Month Pending
1259
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1260
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending')
1261
+		) {
1262
+			$admin_bar->add_menu(array(
1263
+				'id'     => 'espresso-toolbar-registrations-month-pending',
1264
+				'parent' => 'espresso-toolbar-registrations-month',
1265
+				'title'  => __('Pending', 'event_espresso'),
1266
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1267
+					'action'      => 'default',
1268
+					'status'      => 'month',
1269
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
1270
+				), $reg_admin_url),
1271
+				'meta'   => array(
1272
+					'title'  => __('Pending', 'event_espresso'),
1273
+					'target' => '',
1274
+					'class'  => $menu_class,
1275
+				),
1276
+			));
1277
+		}
1278
+		//Registration Overview This Month Not Approved
1279
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1280
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved')
1281
+		) {
1282
+			$admin_bar->add_menu(array(
1283
+				'id'     => 'espresso-toolbar-registrations-month-not-approved',
1284
+				'parent' => 'espresso-toolbar-registrations-month',
1285
+				'title'  => __('Not Approved', 'event_espresso'),
1286
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1287
+					'action'      => 'default',
1288
+					'status'      => 'month',
1289
+					'_reg_status' => EEM_Registration::status_id_not_approved,
1290
+				), $reg_admin_url),
1291
+				'meta'   => array(
1292
+					'title'  => __('Not Approved', 'event_espresso'),
1293
+					'target' => '',
1294
+					'class'  => $menu_class,
1295
+				),
1296
+			));
1297
+		}
1298
+		//Registration Overview This Month Cancelled
1299
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
1300
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled')
1301
+		) {
1302
+			$admin_bar->add_menu(array(
1303
+				'id'     => 'espresso-toolbar-registrations-month-cancelled',
1304
+				'parent' => 'espresso-toolbar-registrations-month',
1305
+				'title'  => __('Cancelled', 'event_espresso'),
1306
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
1307
+					'action'      => 'default',
1308
+					'status'      => 'month',
1309
+					'_reg_status' => EEM_Registration::status_id_cancelled,
1310
+				), $reg_admin_url),
1311
+				'meta'   => array(
1312
+					'title'  => __('Cancelled', 'event_espresso'),
1313
+					'target' => '',
1314
+					'class'  => $menu_class,
1315
+				),
1316
+			));
1317
+		}
1318
+		//Extensions & Services
1319
+		if ($this->registry->CAP->current_user_can('ee_read_ee',
1320
+			'ee_admin_bar_menu_espresso-toolbar-extensions-and-services')
1321
+		) {
1322
+			$admin_bar->add_menu(array(
1323
+				'id'     => 'espresso-toolbar-extensions-and-services',
1324
+				'parent' => 'espresso-toolbar',
1325
+				'title'  => __('Extensions & Services', 'event_espresso'),
1326
+				'href'   => $extensions_admin_url,
1327
+				'meta'   => array(
1328
+					'title'  => __('Extensions & Services', 'event_espresso'),
1329
+					'target' => '',
1330
+					'class'  => $menu_class,
1331
+				),
1332
+			));
1333
+		}
1334
+	}
1335
+
1336
+
1337
+
1338
+	/**
1339
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
1340
+	 * never returned with the function.
1341
+	 *
1342
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
1343
+	 * @return array
1344
+	 */
1345
+	public function remove_pages_from_wp_list_pages($exclude_array)
1346
+	{
1347
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
1348
+	}
1349
+
1350
+
1351
+
1352
+
1353
+
1354
+
1355
+	/***********************************************        WP_ENQUEUE_SCRIPTS HOOK         ***********************************************/
1356
+	/**
1357
+	 *    wp_enqueue_scripts
1358
+	 *
1359
+	 * @access    public
1360
+	 * @return    void
1361
+	 */
1362
+	public function wp_enqueue_scripts()
1363
+	{
1364
+		// 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' );
1365
+		if (apply_filters('FHEE_load_EE_System_scripts', true)) {
1366
+			// 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' );
1367
+			if (apply_filters('FHEE_load_jquery_validate', false)) {
1368
+				// register jQuery Validate and additional methods
1369
+				wp_register_script('jquery-validate', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
1370
+					array('jquery'), '1.15.0', true);
1371
+				wp_register_script('jquery-validate-extra-methods',
1372
+					EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
1373
+					array('jquery', 'jquery-validate'), '1.15.0', true);
1374
+			}
1375
+		}
1376
+	}
1377 1377
 
1378 1378
 
1379 1379
 
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.
admin_pages/maintenance/Maintenance_Admin_Page_Init.core.php 2 patches
Indentation   +84 added lines, -84 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
 
@@ -29,91 +29,91 @@  discard block
 block discarded – undo
29 29
 {
30 30
 
31 31
 
32
-    public function __construct()
33
-    {
34
-        //define some page related constants
35
-        define('EE_MAINTENANCE_LABEL', __('Maintenance', 'event_espresso'));
36
-        define('EE_MAINTENANCE_PG_SLUG', 'espresso_maintenance_settings');
37
-        define('EE_MAINTENANCE_ADMIN_URL', admin_url('admin.php?page=' . EE_MAINTENANCE_PG_SLUG));
38
-        define('EE_MAINTENANCE_ADMIN', EE_ADMIN_PAGES . 'maintenance' . DS);
39
-        define('EE_MAINTENANCE_TEMPLATE_PATH', EE_MAINTENANCE_ADMIN . 'templates' . DS);
40
-        define('EE_MAINTENANCE_ASSETS_URL', EE_ADMIN_PAGES_URL . 'maintenance/assets/');
41
-        //check that if we're in maintenance mode that we tell the admin that
42
-        add_action('admin_notices', array($this, 'check_maintenance_mode'));
43
-        parent::__construct();
44
-    }
45
-
46
-
47
-
48
-    protected function _set_init_properties()
49
-    {
50
-        $this->label = EE_MAINTENANCE_LABEL;
51
-    }
52
-
53
-
54
-
55
-    protected function _set_menu_map()
56
-    {
57
-        $menu_map = $this->_menu_map();
58
-        $this->_menu_map = EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
59
-            ? new EE_Admin_Page_Main_Menu($menu_map) : new EE_Admin_Page_Sub_Menu($menu_map);
60
-    }
61
-
62
-
63
-
64
-    protected function _menu_map()
65
-    {
66
-        $map = array(
67
-            'menu_group'              => 'extras',
68
-            'menu_order'              => 30,
69
-            'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
70
-            'parent_slug'             => 'espresso_events',
71
-            'menu_slug'               => EE_MAINTENANCE_PG_SLUG,
72
-            'menu_label'              => EE_MAINTENANCE_LABEL,
73
-            'capability'              => 'manage_options',
74
-            'maintenance_mode_parent' => EE_MAINTENANCE_PG_SLUG,
75
-            'admin_init_page'         => $this,
76
-        );
77
-        if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance) {
78
-            $map['menu_group'] = 'main';
79
-            $map['subtitle'] = EE_MAINTENANCE_LABEL;
80
-            $map['menu_label'] = __('Event Espresso', 'event_espresso');
81
-        }
82
-        return $map;
83
-    }
84
-
85
-
86
-
87
-    /**
88
-     * Checks if we're in maintenance mode, and if so we notify the admin adn tell them how to take the site OUT of
89
-     * maintenance mode
90
-     */
91
-    public function check_maintenance_mode()
92
-    {
93
-        $notice = '';
94
-        $maintenance_page_url = '';
95
-        if (EE_Maintenance_Mode::instance()->level()) {
96
-            $maintenance_page_url = EE_Admin_Page::add_query_args_and_nonce(array(), EE_MAINTENANCE_ADMIN_URL);
97
-            switch (EE_Maintenance_Mode::instance()->level()) {
98
-                case EE_Maintenance_Mode::level_1_frontend_only_maintenance:
99
-                    $notice = '<div class="update-nag">
32
+	public function __construct()
33
+	{
34
+		//define some page related constants
35
+		define('EE_MAINTENANCE_LABEL', __('Maintenance', 'event_espresso'));
36
+		define('EE_MAINTENANCE_PG_SLUG', 'espresso_maintenance_settings');
37
+		define('EE_MAINTENANCE_ADMIN_URL', admin_url('admin.php?page=' . EE_MAINTENANCE_PG_SLUG));
38
+		define('EE_MAINTENANCE_ADMIN', EE_ADMIN_PAGES . 'maintenance' . DS);
39
+		define('EE_MAINTENANCE_TEMPLATE_PATH', EE_MAINTENANCE_ADMIN . 'templates' . DS);
40
+		define('EE_MAINTENANCE_ASSETS_URL', EE_ADMIN_PAGES_URL . 'maintenance/assets/');
41
+		//check that if we're in maintenance mode that we tell the admin that
42
+		add_action('admin_notices', array($this, 'check_maintenance_mode'));
43
+		parent::__construct();
44
+	}
45
+
46
+
47
+
48
+	protected function _set_init_properties()
49
+	{
50
+		$this->label = EE_MAINTENANCE_LABEL;
51
+	}
52
+
53
+
54
+
55
+	protected function _set_menu_map()
56
+	{
57
+		$menu_map = $this->_menu_map();
58
+		$this->_menu_map = EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
59
+			? new EE_Admin_Page_Main_Menu($menu_map) : new EE_Admin_Page_Sub_Menu($menu_map);
60
+	}
61
+
62
+
63
+
64
+	protected function _menu_map()
65
+	{
66
+		$map = array(
67
+			'menu_group'              => 'extras',
68
+			'menu_order'              => 30,
69
+			'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
70
+			'parent_slug'             => 'espresso_events',
71
+			'menu_slug'               => EE_MAINTENANCE_PG_SLUG,
72
+			'menu_label'              => EE_MAINTENANCE_LABEL,
73
+			'capability'              => 'manage_options',
74
+			'maintenance_mode_parent' => EE_MAINTENANCE_PG_SLUG,
75
+			'admin_init_page'         => $this,
76
+		);
77
+		if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance) {
78
+			$map['menu_group'] = 'main';
79
+			$map['subtitle'] = EE_MAINTENANCE_LABEL;
80
+			$map['menu_label'] = __('Event Espresso', 'event_espresso');
81
+		}
82
+		return $map;
83
+	}
84
+
85
+
86
+
87
+	/**
88
+	 * Checks if we're in maintenance mode, and if so we notify the admin adn tell them how to take the site OUT of
89
+	 * maintenance mode
90
+	 */
91
+	public function check_maintenance_mode()
92
+	{
93
+		$notice = '';
94
+		$maintenance_page_url = '';
95
+		if (EE_Maintenance_Mode::instance()->level()) {
96
+			$maintenance_page_url = EE_Admin_Page::add_query_args_and_nonce(array(), EE_MAINTENANCE_ADMIN_URL);
97
+			switch (EE_Maintenance_Mode::instance()->level()) {
98
+				case EE_Maintenance_Mode::level_1_frontend_only_maintenance:
99
+					$notice = '<div class="update-nag">
100 100
 						'
101
-                              . sprintf(__("Event Espresso is in Frontend-Only MAINTENANCE MODE. This means the front-end (ie, non-wp-admin pages) is disabled for ALL users except site admins. Visit the %s Maintenance Page %s to disable maintenance mode.",
102
-                            "event_espresso"), "<a href='$maintenance_page_url'>", "</a>")
103
-                              .
104
-                              '</div>';
105
-                    break;
106
-                case EE_Maintenance_Mode::level_2_complete_maintenance:
107
-                    $notice = '<div class="error">
101
+							  . sprintf(__("Event Espresso is in Frontend-Only MAINTENANCE MODE. This means the front-end (ie, non-wp-admin pages) is disabled for ALL users except site admins. Visit the %s Maintenance Page %s to disable maintenance mode.",
102
+							"event_espresso"), "<a href='$maintenance_page_url'>", "</a>")
103
+							  .
104
+							  '</div>';
105
+					break;
106
+				case EE_Maintenance_Mode::level_2_complete_maintenance:
107
+					$notice = '<div class="error">
108 108
 						<p>' . sprintf(__("As part of the process for updating Event Espresso, your database also
109 109
 needs to be updated. Event Espresso is in COMPLETE MAINTENANCE MODE (both WordPress admin pages and front-end event registration pages are disabled) until you run the database update script. %s Visit the Maintenance Page to get started,%s it only takes a moment.",
110
-                            "event_espresso"), "<a href='$maintenance_page_url'>", "</a>") .
111
-                              '</div>';
112
-                    break;
113
-            }
114
-        }
115
-        echo apply_filters('FHEE__Maintenance_Admin_Page_Init__check_maintenance_mode__notice', $notice,
116
-            $maintenance_page_url);
117
-    }
110
+							"event_espresso"), "<a href='$maintenance_page_url'>", "</a>") .
111
+							  '</div>';
112
+					break;
113
+			}
114
+		}
115
+		echo apply_filters('FHEE__Maintenance_Admin_Page_Init__check_maintenance_mode__notice', $notice,
116
+			$maintenance_page_url);
117
+	}
118 118
 
119 119
 } //end class Payments_Admin_Page_Init
Please login to merge, or discard this patch.
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -34,10 +34,10 @@  discard block
 block discarded – undo
34 34
         //define some page related constants
35 35
         define('EE_MAINTENANCE_LABEL', __('Maintenance', 'event_espresso'));
36 36
         define('EE_MAINTENANCE_PG_SLUG', 'espresso_maintenance_settings');
37
-        define('EE_MAINTENANCE_ADMIN_URL', admin_url('admin.php?page=' . EE_MAINTENANCE_PG_SLUG));
38
-        define('EE_MAINTENANCE_ADMIN', EE_ADMIN_PAGES . 'maintenance' . DS);
39
-        define('EE_MAINTENANCE_TEMPLATE_PATH', EE_MAINTENANCE_ADMIN . 'templates' . DS);
40
-        define('EE_MAINTENANCE_ASSETS_URL', EE_ADMIN_PAGES_URL . 'maintenance/assets/');
37
+        define('EE_MAINTENANCE_ADMIN_URL', admin_url('admin.php?page='.EE_MAINTENANCE_PG_SLUG));
38
+        define('EE_MAINTENANCE_ADMIN', EE_ADMIN_PAGES.'maintenance'.DS);
39
+        define('EE_MAINTENANCE_TEMPLATE_PATH', EE_MAINTENANCE_ADMIN.'templates'.DS);
40
+        define('EE_MAINTENANCE_ASSETS_URL', EE_ADMIN_PAGES_URL.'maintenance/assets/');
41 41
         //check that if we're in maintenance mode that we tell the admin that
42 42
         add_action('admin_notices', array($this, 'check_maintenance_mode'));
43 43
         parent::__construct();
@@ -107,7 +107,7 @@  discard block
 block discarded – undo
107 107
                     $notice = '<div class="error">
108 108
 						<p>' . sprintf(__("As part of the process for updating Event Espresso, your database also
109 109
 needs to be updated. Event Espresso is in COMPLETE MAINTENANCE MODE (both WordPress admin pages and front-end event registration pages are disabled) until you run the database update script. %s Visit the Maintenance Page to get started,%s it only takes a moment.",
110
-                            "event_espresso"), "<a href='$maintenance_page_url'>", "</a>") .
110
+                            "event_espresso"), "<a href='$maintenance_page_url'>", "</a>").
111 111
                               '</div>';
112 112
                     break;
113 113
             }
Please login to merge, or discard this patch.
admin_pages/maintenance/templates/ee_migration_page.template.php 1 patch
Indentation   +104 added lines, -104 removed lines patch added patch discarded remove patch
@@ -27,35 +27,35 @@  discard block
 block discarded – undo
27 27
             <h3 class="espresso-header">
28 28
                 <span class="dashicons dashicons-flag ee-icon-size-22"></span>
29 29
                 <?php
30
-                echo apply_filters(
31
-                        'FHEE__ee_migration_page__header',
32
-                        sprintf(
33
-                                __("Event Espresso has detected event data from version %s that can be migrated (updated) to work with version %s.",
34
-                                        "event_espresso"),
35
-                                $current_db_state,
36
-                                $next_db_state
37
-                        ),
38
-                        $current_db_state,
39
-                        $next_db_state
40
-                );
41
-                ?>
30
+				echo apply_filters(
31
+						'FHEE__ee_migration_page__header',
32
+						sprintf(
33
+								__("Event Espresso has detected event data from version %s that can be migrated (updated) to work with version %s.",
34
+										"event_espresso"),
35
+								$current_db_state,
36
+								$next_db_state
37
+						),
38
+						$current_db_state,
39
+						$next_db_state
40
+				);
41
+				?>
42 42
             </h3>
43 43
             <p>
44 44
                 <?php echo apply_filters('FHEE__ee_migration_page__p_after_header',
45
-                        sprintf(__("Since you have already been using Event Espresso and have previous event and registration data in your database, you have the option to migrate, or copy over, this existing data into a format that is compatible with %s.",
46
-                                "event_espresso"), $next_db_state), $next_db_state); ?>
45
+						sprintf(__("Since you have already been using Event Espresso and have previous event and registration data in your database, you have the option to migrate, or copy over, this existing data into a format that is compatible with %s.",
46
+								"event_espresso"), $next_db_state), $next_db_state); ?>
47 47
             </p>
48 48
         <?php } elseif ($show_most_recent_migration) { ?>
49 49
             <h3 class="espresso-header">
50 50
                 <span class="dashicons dashicons-awards ee-icon-size-22"></span>
51 51
                 <?php echo apply_filters('FHEE__ee_migration_page__done_migration_header',
52
-                        sprintf(__('Congratulations! Your database is "up-to-date" and you are ready to begin using %s',
53
-                                "event_espresso"), $ultimate_db_state)); ?>
52
+						sprintf(__('Congratulations! Your database is "up-to-date" and you are ready to begin using %s',
53
+								"event_espresso"), $ultimate_db_state)); ?>
54 54
             </h3>
55 55
             <p>
56 56
                 <?php echo apply_filters('FHEE__ee_migration_page__p_after_done_migration_header',
57
-                        sprintf(__("Time to find out about all the great new features %s has to offer.",
58
-                                "event_espresso"), $ultimate_db_state)); ?> &nbsp;
57
+						sprintf(__("Time to find out about all the great new features %s has to offer.",
58
+								"event_espresso"), $ultimate_db_state)); ?> &nbsp;
59 59
                 <b><a id="get-started-after-migrate" class="button-primary"
60 60
                       href="<?php echo add_query_arg(array('page' => 'espresso_about'), admin_url('admin.php')); ?>">
61 61
                         <?php _e("Let's Get Started", "event_espresso"); ?>&nbsp;<span
@@ -71,7 +71,7 @@  discard block
 block discarded – undo
71 71
                     <span class="dashicons dashicons-admin-tools"></span>
72 72
                     <?php _e("Migration Options", "event_espresso"); ?>
73 73
                     <span class="tiny-text lt-grey-text"> &nbsp; <?php _e(' to migrate or not to migrate?',
74
-                                "event_espresso"); ?></span>
74
+								"event_espresso"); ?></span>
75 75
                 </h2>
76 76
                 <div class="ee-table-wrap">
77 77
                     <table>
@@ -80,24 +80,24 @@  discard block
 block discarded – undo
80 80
                             <td><h3><?php _e('1', 'event_espresso'); ?></h3></td>
81 81
                             <td>
82 82
                                 <?php
83
-                                echo apply_filters(
84
-                                        'FHEE__ee_migration_page__option_1_main',
85
-                                        sprintf(
86
-                                                __('%1$sYes. I have backed up my database%2$s, %3$sunderstand the risks involved%4$s, and am ready to migrate my existing %5$s data to %6$s.',
87
-                                                        "event_espresso"),
88
-                                                '<strong>',
89
-                                                '</strong>',
90
-                                                '<a id="migration-risks" class="" title="'
91
-                                                . esc_attr__('click for more details', "event_espresso")
92
-                                                . '">',
93
-                                                '</a>',
94
-                                                $current_db_state,
95
-                                                $next_db_state
96
-                                        ),
97
-                                        $current_db_state,
98
-                                        $next_db_state
99
-                                );
100
-                                ?>
83
+								echo apply_filters(
84
+										'FHEE__ee_migration_page__option_1_main',
85
+										sprintf(
86
+												__('%1$sYes. I have backed up my database%2$s, %3$sunderstand the risks involved%4$s, and am ready to migrate my existing %5$s data to %6$s.',
87
+														"event_espresso"),
88
+												'<strong>',
89
+												'</strong>',
90
+												'<a id="migration-risks" class="" title="'
91
+												. esc_attr__('click for more details', "event_espresso")
92
+												. '">',
93
+												'</a>',
94
+												$current_db_state,
95
+												$next_db_state
96
+										),
97
+										$current_db_state,
98
+										$next_db_state
99
+								);
100
+								?>
101 101
                                 <a id="display-migration-details"
102 102
                                    class="display-the-hidden lt-grey-text smaller-text hide-if-no-js"
103 103
                                    rel="migration-details"><?php _e('click for more details', "event_espresso"); ?>
@@ -106,13 +106,13 @@  discard block
 block discarded – undo
106 106
                                    class="hide-the-displayed lt-grey-text smaller-text hide-if-no-js"
107 107
                                    rel="migration-details"
108 108
                                    style="display:none;"><?php echo sprintf(__('hide%1$sdetails%1$s-',
109
-                                            'event_espresso'), '&nbsp;'); ?></a>
109
+											'event_espresso'), '&nbsp;'); ?></a>
110 110
                             </td>
111 111
                             <td>
112 112
                                 <a id="db-backed-up"
113 113
                                    class="toggle-migration-monitor button-primary"><?php echo apply_filters('FHEE__ee_migration_page__option_1_button_text',
114
-                                            sprintf(__("Migrate My %s Data to %s", "event_espresso"), $current_db_state,
115
-                                                    $next_db_state), $current_db_state, $next_db_state); ?></a>
114
+											sprintf(__("Migrate My %s Data to %s", "event_espresso"), $current_db_state,
115
+													$next_db_state), $current_db_state, $next_db_state); ?></a>
116 116
                             </td>
117 117
                         </tr>
118 118
                         <tr>
@@ -120,24 +120,24 @@  discard block
 block discarded – undo
120 120
                                 <div id="migration-details-dv" style="display: none; padding: 1em;">
121 121
 
122 122
                                     <span class="reminder-spn"><?php printf(__("%s Important: %s Before migrating, please back up your database and files.",
123
-                                                "event_espresso"), "<b>", "</b>"); ?></span>
123
+												"event_espresso"), "<b>", "</b>"); ?></span>
124 124
                                     <p>
125 125
                                         <?php
126
-                                        printf(
127
-                                                __('%1$sNot sure how to backup your existing data?%2$s Here is %3$sWordPress\'s explanation%7$s, and here\'s %6$sour explanation%7$s.%8$sYou can also search the WordPress plugin database for %4$s database backup plugins %7$s,%8$sor have one of our dedicated support technicians help you by purchasing a %5$sPriority Support Token%7$s.',
128
-                                                        "event_espresso"),
129
-                                                '<b>',
130
-                                                '</b>',
131
-                                                "<a href='http://codex.wordpress.org/Backing_Up_Your_Database'>",
132
-                                                "<a href='"
133
-                                                . admin_url('plugin-install.php?tab=search&type=term&s=database+backup&plugin-search-input=Search+Plugins')
134
-                                                . "'>",
135
-                                                "<a href='http://eventespresso.com/product/priority-support-tokens/'>",
136
-                                                '<a href="http://eventespresso.com/wiki/how-to-back-up-your-site/">',
137
-                                                "</a>",
138
-                                                '<br/>'
139
-                                        );
140
-                                        ?>
126
+										printf(
127
+												__('%1$sNot sure how to backup your existing data?%2$s Here is %3$sWordPress\'s explanation%7$s, and here\'s %6$sour explanation%7$s.%8$sYou can also search the WordPress plugin database for %4$s database backup plugins %7$s,%8$sor have one of our dedicated support technicians help you by purchasing a %5$sPriority Support Token%7$s.',
128
+														"event_espresso"),
129
+												'<b>',
130
+												'</b>',
131
+												"<a href='http://codex.wordpress.org/Backing_Up_Your_Database'>",
132
+												"<a href='"
133
+												. admin_url('plugin-install.php?tab=search&type=term&s=database+backup&plugin-search-input=Search+Plugins')
134
+												. "'>",
135
+												"<a href='http://eventespresso.com/product/priority-support-tokens/'>",
136
+												'<a href="http://eventespresso.com/wiki/how-to-back-up-your-site/">',
137
+												"</a>",
138
+												'<br/>'
139
+										);
140
+										?>
141 141
                                     </p>
142 142
                                     <?php do_action('AHEE__ee_migration_page__option_1_extra_details'); ?>
143 143
                                 </div>
@@ -147,12 +147,12 @@  discard block
 block discarded – undo
147 147
                             <td><h3><?php _e('2', 'event_espresso'); ?></h3></td>
148 148
                             <td>
149 149
                                 <?php echo apply_filters('FHEE__ee_migration_page__option_2_main',
150
-                                        sprintf(__('I do NOT want to migrate my %1$s data to %2$s at this time and just want to use %3$s without migrating data.',
151
-                                                "event_espresso"), $current_db_state, $next_db_state,
152
-                                                $ultimate_db_state), $current_db_state, $next_db_state,
153
-                                        $ultimate_db_state); ?><br/>
150
+										sprintf(__('I do NOT want to migrate my %1$s data to %2$s at this time and just want to use %3$s without migrating data.',
151
+												"event_espresso"), $current_db_state, $next_db_state,
152
+												$ultimate_db_state), $current_db_state, $next_db_state,
153
+										$ultimate_db_state); ?><br/>
154 154
                                 <span class="reminder-spn"><?php _e('Please Note: In order to avoid errors, any existing Event Espresso data (events, ticket, registrations, etc) in your db will be erased! Regular WP data will NOT be affected.',
155
-                                            'event_espresso'); ?></span>
155
+											'event_espresso'); ?></span>
156 156
                                 <a id="display-no-migration-details"
157 157
                                    class="display-the-hidden lt-grey-text smaller-text hide-if-no-js"
158 158
                                    rel="no-migration-details"><?php _e('click for more details', "event_espresso"); ?>
@@ -161,13 +161,13 @@  discard block
 block discarded – undo
161 161
                                    class="hide-the-displayed lt-grey-text smaller-text hide-if-no-js"
162 162
                                    rel="no-migration-details"
163 163
                                    style="display:none;"><?php echo sprintf(__('hide%1$sdetails%1$s-',
164
-                                            'event_espresso'), '&nbsp;'); ?></a>
164
+											'event_espresso'), '&nbsp;'); ?></a>
165 165
                             </td>
166 166
                             <td>
167 167
                                 <a id="do-not-migrate" class="do-not-migrate button-primary"
168 168
                                    href="<?php echo $reset_db_page_link; ?>"><?php echo apply_filters('FHEE__ee_migration_page__option_2_button_text',
169
-                                            sprintf(__("Just Start %s and Delete Existing Data", "event_espresso"),
170
-                                                    $ultimate_db_state), $ultimate_db_state); ?></a>
169
+											sprintf(__("Just Start %s and Delete Existing Data", "event_espresso"),
170
+													$ultimate_db_state), $ultimate_db_state); ?></a>
171 171
                             </td>
172 172
                         </tr>
173 173
                         <tr>
@@ -175,8 +175,8 @@  discard block
 block discarded – undo
175 175
                                 <div id="no-migration-details-dv" style="display: none; padding: 1em;">
176 176
                                     <p>
177 177
                                         <?php echo apply_filters('FHEE__ee_migration_page__option_2_details',
178
-                                                sprintf(__("If your existing Event and Registration Data is no longer relevant nor required, you can just start up %s without performing a data migration.",
179
-                                                        "event_espresso"), $ultimate_db_state), $ultimate_db_state); ?>
178
+												sprintf(__("If your existing Event and Registration Data is no longer relevant nor required, you can just start up %s without performing a data migration.",
179
+														"event_espresso"), $ultimate_db_state), $ultimate_db_state); ?>
180 180
                                     </p>
181 181
                                 </div>
182 182
                             </td>
@@ -189,29 +189,29 @@  discard block
 block discarded – undo
189 189
         <?php } ?>
190 190
 
191 191
         <?php
192
-        if ($show_most_recent_migration) {
193
-            if ($most_recent_migration && $most_recent_migration instanceof EE_Data_Migration_Script_Base) {
194
-                if ($most_recent_migration->can_continue()) {
195
-                    //tell the user they should continue their migration because it appears to be unfinished... well, assuming there were no errors ?>
192
+		if ($show_most_recent_migration) {
193
+			if ($most_recent_migration && $most_recent_migration instanceof EE_Data_Migration_Script_Base) {
194
+				if ($most_recent_migration->can_continue()) {
195
+					//tell the user they should continue their migration because it appears to be unfinished... well, assuming there were no errors ?>
196 196
                     <h3 class="espresso-header">
197 197
                         <span class="dashicons dashicons-star-half ee-icon-size-22"></span>
198 198
                         <?php printf(__("It appears that your previous Data Migration Task (%s) is incomplete, and should be resumed",
199
-                                "event_espresso"), $most_recent_migration->pretty_name()); ?>
199
+								"event_espresso"), $most_recent_migration->pretty_name()); ?>
200 200
                     </h3>
201 201
                 <?php } elseif ($most_recent_migration->is_broken()) {
202
-                    //tell the user the migration failed and they should notify EE?>
202
+					//tell the user the migration failed and they should notify EE?>
203 203
                     <h3 class="espresso-header">
204 204
                         <span class="dashicons dashicons-no ee-icon-size-22"></span>
205 205
                         <?php echo $most_recent_migration->get_feedback_message() ?>
206 206
                     </h3>
207 207
                 <?php }
208
-                //display errors or not of the most recent migration ran
209
-                if ($most_recent_migration->get_errors()) { ?>
208
+				//display errors or not of the most recent migration ran
209
+				if ($most_recent_migration->get_errors()) { ?>
210 210
                     <div class="ee-attention">
211 211
                         <strong><?php printf(__("Warnings occurred during your last migration (%s):", 'event_espresso'),
212
-                                    $most_recent_migration->pretty_name()) ?></strong>
212
+									$most_recent_migration->pretty_name()) ?></strong>
213 213
                         <a id="show-hide-migration-warnings" class="display-the-hidden"><?php _e("Show Warnings",
214
-                                    'event_espresso'); ?></a>
214
+									'event_espresso'); ?></a>
215 215
                         <ul class="migration-warnings" style="display:none">
216 216
                             <?php foreach ($most_recent_migration->get_errors() as $error) { ?>
217 217
                                 <li><?php echo htmlentities($error) ?></li>
@@ -219,15 +219,15 @@  discard block
 block discarded – undo
219 219
                         </ul>
220 220
                     </div>
221 221
                 <?php } else {
222
-                    //there were no errors during the last migration, just say so?>
222
+					//there were no errors during the last migration, just say so?>
223 223
                     <h2><?php printf(__("The last data migration task (%s) ran successfully without errors.",
224
-                                "event_espresso"), $most_recent_migration->pretty_name()) ?></h2>
224
+								"event_espresso"), $most_recent_migration->pretty_name()) ?></h2>
225 225
                 <?php }
226
-            } else {
227
-            }
228
-        }
229
-        // end of: if ( $show_most_recent_migration )
230
-        ?>
226
+			} else {
227
+			}
228
+		}
229
+		// end of: if ( $show_most_recent_migration )
230
+		?>
231 231
 
232 232
     </div>
233 233
     <!--end of #migration-prep-->
@@ -247,12 +247,12 @@  discard block
 block discarded – undo
247 247
             <div id='progress-area'>
248 248
                 <h3 class="espresso-header">
249 249
                     <?php
250
-                    echo sprintf(_n(
251
-                            "In order to import all of your existing Event Espresso data, the following upgrade task needs to be performed:",
252
-                            "In order to import all of your existing Event Espresso data, the following %s upgrade tasks need to be performed:",
253
-                            count($script_names),
254
-                            "event_espresso"
255
-                    ), count($script_names)); ?>
250
+					echo sprintf(_n(
251
+							"In order to import all of your existing Event Espresso data, the following upgrade task needs to be performed:",
252
+							"In order to import all of your existing Event Espresso data, the following %s upgrade tasks need to be performed:",
253
+							count($script_names),
254
+							"event_espresso"
255
+					), count($script_names)); ?>
256 256
                 </h3>
257 257
                 <ul style="list-style: inside;">
258 258
                     <?php foreach ($script_names as $script_name) { ?>
@@ -262,7 +262,7 @@  discard block
 block discarded – undo
262 262
                 <br/>
263 263
                 <?php if (count($script_names) > 1) { ?>
264 264
                     <p><?php _e("Please note: after each task is completed you will need to continue the data migration, or report an error to Event Espresso.",
265
-                                "event_espresso"); ?></p>
265
+								"event_espresso"); ?></p>
266 266
                 <?php } ?>
267 267
 
268 268
                 <div class="ee-attention">
@@ -272,11 +272,11 @@  discard block
 block discarded – undo
272 272
 					</span>
273 273
                         <br/>
274 274
                         <?php _e("Depending on the number of events and the complexity of the information in your database, this could take a few minutes.",
275
-                                "event_espresso"); ?>
275
+								"event_espresso"); ?>
276 276
                     </p>
277 277
                     <p>
278 278
                         <?php printf(__("%sPlease be patient and do NOT navigate away from this page once the migration has begun%s. If any issues arise due to existing malformed data, an itemized report will be made available to you after the migration has completed.",
279
-                                "event_espresso"), '<strong>', '</strong>'); ?>
279
+								"event_espresso"), '<strong>', '</strong>'); ?>
280 280
                     </p>
281 281
                     <p>
282 282
                         <?php _e("Click the button below to begin the migration process.", "event_espresso") ?>
@@ -292,7 +292,7 @@  discard block
 block discarded – undo
292 292
 
293 293
                 <button id='start-migration' class='button-primary'>
294 294
                     <?php echo $show_continue_current_migration_script ? __("Continue Migration", "event_espresso")
295
-                            : __("Begin Migration", "event_espresso"); ?>
295
+							: __("Begin Migration", "event_espresso"); ?>
296 296
                 </button>
297 297
                 <br class="clear"/>
298 298
 
@@ -308,10 +308,10 @@  discard block
 block discarded – undo
308 308
         </div>
309 309
 
310 310
     <?php }
311
-    if ($show_maintenance_switch) {
312
-        ?>
311
+	if ($show_maintenance_switch) {
312
+		?>
313 313
         <h2><span class="dashicons dashicons-admin-tools"></span><?php _e('Set Event Espresso Maintenance Mode',
314
-                    'event_espresso'); ?></h2>
314
+					'event_espresso'); ?></h2>
315 315
         <form method='post' action='<?php echo $update_migration_script_page_link ?>'>
316 316
             <div class="ee-table-wrap">
317 317
                 <table>
@@ -319,15 +319,15 @@  discard block
 block discarded – undo
319 319
                         <td width="40px" align="center">
320 320
                             <input type="radio" id="maintenance_mode_level_off" name="maintenance_mode_level"
321 321
                                    value="0" <?php echo EE_Maintenance_Mode::instance()->level()
322
-                                                        == EE_Maintenance_Mode::level_0_not_in_maintenance
323
-                                    ? 'checked="checked"' : '' ?>>
322
+														== EE_Maintenance_Mode::level_0_not_in_maintenance
323
+									? 'checked="checked"' : '' ?>>
324 324
                         </td>
325 325
                         <th align="left">
326 326
                             <label for="maintenance_mode_level_off"><?php _e('Maintenance Mode OFF',
327
-                                        'event_espresso'); ?></label>
327
+										'event_espresso'); ?></label>
328 328
                             <p class='description' style="font-weight: normal;">
329 329
                                 <?php _e("This is the normal operating mode for Event Espresso and allows all functionality to be viewed by all site visitors.",
330
-                                        "event_espresso"); ?>
330
+										"event_espresso"); ?>
331 331
                             </p>
332 332
                         </th>
333 333
                     </tr>
@@ -335,8 +335,8 @@  discard block
 block discarded – undo
335 335
                         <td width="40px" align="center">
336 336
                             <input type="radio" id="maintenance_mode_level_on" name="maintenance_mode_level"
337 337
                                    value="1" <?php echo EE_Maintenance_Mode::instance()->level()
338
-                                                        == EE_Maintenance_Mode::level_1_frontend_only_maintenance
339
-                                    ? 'checked="checked"' : '' ?>>
338
+														== EE_Maintenance_Mode::level_1_frontend_only_maintenance
339
+									? 'checked="checked"' : '' ?>>
340 340
                         </td>
341 341
                         <th align="left">
342 342
                             <label for="maintenance_mode_level_on">
@@ -344,7 +344,7 @@  discard block
 block discarded – undo
344 344
                             </label>
345 345
                             <p class='description' style="font-weight: normal;">
346 346
                                 <?php _e("This disables Event Espresso frontend functionality for all site visitors that are not administrators, and allows you to configure and/or test things on the frontend of your website before others can see.",
347
-                                        "event_espresso"); ?>
347
+										"event_espresso"); ?>
348 348
                             </p>
349 349
                         </th>
350 350
                     </tr>
@@ -356,6 +356,6 @@  discard block
 block discarded – undo
356 356
             </p>
357 357
         </form>
358 358
         <?php
359
-    } ?>
359
+	} ?>
360 360
 
361 361
 </div>
Please login to merge, or discard this patch.
core/helpers/EEH_URL.helper.php 2 patches
Indentation   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -139,7 +139,7 @@  discard block
 block discarded – undo
139 139
 		foreach ( $query as $query_args ) {
140 140
 			// break apart the key value pairs
141 141
 			$query_args = explode( '=', $query_args );
142
-            // and add to our results array
142
+			// and add to our results array
143 143
 			$query_params[ $query_args[0] ] = $query_args[1];
144 144
 		}
145 145
 		return $query_params;
@@ -204,9 +204,9 @@  discard block
 block discarded – undo
204 204
 		$server_variable = strtoupper( $server_variable );
205 205
 		// whitelist INPUT_SERVER var
206 206
 		if ( isset( $server_variables[ $server_variable ] ) ) {
207
-            $URL = filter_input( INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE );
208
-            if ( empty( $URL ) ) {
209
-                 // fallback sanitization if the above fails
207
+			$URL = filter_input( INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE );
208
+			if ( empty( $URL ) ) {
209
+				 // fallback sanitization if the above fails
210 210
 				$URL = wp_sanitize_redirect( $_SERVER[ $server_variable ] );
211 211
 			}
212 212
 		}
Please login to merge, or discard this patch.
Spacing   +59 added lines, -59 removed lines patch added patch discarded remove patch
@@ -9,7 +9,7 @@  discard block
 block discarded – undo
9 9
  *
10 10
  * ------------------------------------------------------------------------
11 11
  */
12
-class EEH_URL{
12
+class EEH_URL {
13 13
 
14 14
 	/**
15 15
 	 * _add_query_arg
@@ -21,30 +21,30 @@  discard block
 block discarded – undo
21 21
 	 * @param bool  $exclude_nonce  If true then the nonce will be excluded from the generated url.
22 22
 	 * @return string
23 23
 	 */
24
-	public static function add_query_args_and_nonce( $args = array(), $url = '', $exclude_nonce = false ) {
25
-		if ( empty( $url ) ) {
26
-			$user_msg = __('An error occurred. A URL is a required parameter for the add_query_args_and_nonce method.', 'event_espresso' );
27
-			$dev_msg = $user_msg . "\n" . sprintf(
28
-					__('In order to dynamically generate nonces for your actions, you need to supply a valid URL as a second parameter for the %s::add_query_args_and_nonce method.', 'event_espresso' ),
24
+	public static function add_query_args_and_nonce($args = array(), $url = '', $exclude_nonce = false) {
25
+		if (empty($url)) {
26
+			$user_msg = __('An error occurred. A URL is a required parameter for the add_query_args_and_nonce method.', 'event_espresso');
27
+			$dev_msg = $user_msg."\n".sprintf(
28
+					__('In order to dynamically generate nonces for your actions, you need to supply a valid URL as a second parameter for the %s::add_query_args_and_nonce method.', 'event_espresso'),
29 29
 					__CLASS__
30 30
 				);
31
-			EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
31
+			EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
32 32
 		}
33 33
 		// check that an action exists and add nonce
34
-		if ( ! $exclude_nonce ) {
35
-			if ( isset( $args['action'] ) && ! empty( $args['action'] ) ) {
36
-				$args = array_merge( $args, array( $args['action'] . '_nonce' => wp_create_nonce( $args['action'] . '_nonce' ) ) );
34
+		if ( ! $exclude_nonce) {
35
+			if (isset($args['action']) && ! empty($args['action'])) {
36
+				$args = array_merge($args, array($args['action'].'_nonce' => wp_create_nonce($args['action'].'_nonce')));
37 37
 			} else {
38
-				$args = array_merge( $args, array( 'action' => 'default', 'default_nonce' => wp_create_nonce( 'default_nonce' ) ) );
38
+				$args = array_merge($args, array('action' => 'default', 'default_nonce' => wp_create_nonce('default_nonce')));
39 39
 			}
40 40
 		}
41 41
 
42 42
 		//finally, let's always add a return address (if present) :)
43
-		$args = ! empty( $_REQUEST['action'] ) && ! isset( $_REQUEST[ 'return' ] )
44
-			? array_merge( $args, array( 'return' => $_REQUEST['action'] ) )
43
+		$args = ! empty($_REQUEST['action']) && ! isset($_REQUEST['return'])
44
+			? array_merge($args, array('return' => $_REQUEST['action']))
45 45
 			: $args;
46 46
 
47
-		return add_query_arg( $args, $url );
47
+		return add_query_arg($args, $url);
48 48
 
49 49
 	}
50 50
 
@@ -57,17 +57,17 @@  discard block
 block discarded – undo
57 57
 	 * @param boolean $sslverify whether we care if the SSL certificate for the requested site is setup properly
58 58
 	 * @return boolean
59 59
 	 */
60
-	public static function remote_file_exists( $url, $args = array() ){
61
-		$results = wp_remote_request($url,array_merge( array(
60
+	public static function remote_file_exists($url, $args = array()) {
61
+		$results = wp_remote_request($url, array_merge(array(
62 62
 			'method'=>'GET',
63 63
 			'redirection'=>1
64
-		), $args ) );
65
-		if( ! $results instanceof WP_Error &&
64
+		), $args));
65
+		if ( ! $results instanceof WP_Error &&
66 66
 				isset($results['response']) &&
67 67
 				isset($results['response']['code']) &&
68
-				$results['response']['code'] == '200'){
68
+				$results['response']['code'] == '200') {
69 69
 			return true;
70
-		}else{
70
+		} else {
71 71
 			return false;
72 72
 		}
73 73
 	}
@@ -83,29 +83,29 @@  discard block
 block discarded – undo
83 83
 	 * @param bool   $base_url_only - TRUE will only return the scheme and host with no other parameters
84 84
 	 * @return string
85 85
 	 */
86
-	public static function refactor_url( $url = '', $remove_query = TRUE, $base_url_only = FALSE ) {
86
+	public static function refactor_url($url = '', $remove_query = TRUE, $base_url_only = FALSE) {
87 87
 		// break apart incoming URL
88
-		$url_bits = parse_url( $url );
88
+		$url_bits = parse_url($url);
89 89
 		// HTTP or HTTPS ?
90
-		$scheme = isset( $url_bits[ 'scheme' ] ) ? $url_bits[ 'scheme' ] . '://' : 'http://';
90
+		$scheme = isset($url_bits['scheme']) ? $url_bits['scheme'].'://' : 'http://';
91 91
 		// domain
92
-		$host = isset( $url_bits[ 'host' ] ) ? $url_bits[ 'host' ] : '';
92
+		$host = isset($url_bits['host']) ? $url_bits['host'] : '';
93 93
 		// if only the base URL is requested, then return that now
94
-		if ( $base_url_only ) {
95
-			return $scheme . $host;
94
+		if ($base_url_only) {
95
+			return $scheme.$host;
96 96
 		}
97
-		$port = isset( $url_bits[ 'port' ] ) ? ':' . $url_bits[ 'port' ] : '';
98
-		$user = isset( $url_bits[ 'user' ] ) ? $url_bits[ 'user' ] : '';
99
-		$pass = isset( $url_bits[ 'pass' ] ) ? ':' . $url_bits[ 'pass' ] : '';
100
-		$pass = ( $user || $pass ) ? $pass . '@' : '';
101
-		$path = isset( $url_bits[ 'path' ] ) ? $url_bits[ 'path' ] : '';
97
+		$port = isset($url_bits['port']) ? ':'.$url_bits['port'] : '';
98
+		$user = isset($url_bits['user']) ? $url_bits['user'] : '';
99
+		$pass = isset($url_bits['pass']) ? ':'.$url_bits['pass'] : '';
100
+		$pass = ($user || $pass) ? $pass.'@' : '';
101
+		$path = isset($url_bits['path']) ? $url_bits['path'] : '';
102 102
 		// if the query string is not required, then return what we have so far
103
-		if ( $remove_query ) {
104
-			return $scheme . $user . $pass . $host . $port . $path;
103
+		if ($remove_query) {
104
+			return $scheme.$user.$pass.$host.$port.$path;
105 105
 		}
106
-		$query = isset( $url_bits[ 'query' ] ) ? '?' . $url_bits[ 'query' ] : '';
107
-		$fragment = isset( $url_bits[ 'fragment' ] ) ? '#' . $url_bits[ 'fragment' ] : '';
108
-		return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
106
+		$query = isset($url_bits['query']) ? '?'.$url_bits['query'] : '';
107
+		$fragment = isset($url_bits['fragment']) ? '#'.$url_bits['fragment'] : '';
108
+		return $scheme.$user.$pass.$host.$port.$path.$query.$fragment;
109 109
 	}
110 110
 
111 111
 
@@ -118,29 +118,29 @@  discard block
 block discarded – undo
118 118
 	 * @param bool   $as_array TRUE (default) will return query params as an array of key value pairs, FALSE will simply return the query string
119 119
 	 * @return string|array
120 120
 	 */
121
-	public static function get_query_string( $url = '', $as_array = TRUE ) {
121
+	public static function get_query_string($url = '', $as_array = TRUE) {
122 122
 		// decode, then break apart incoming URL
123
-		$url_bits = parse_url( html_entity_decode( $url ) );
123
+		$url_bits = parse_url(html_entity_decode($url));
124 124
 		// grab query string from URL
125
-		$query = isset( $url_bits[ 'query' ] ) ? $url_bits[ 'query' ] : '';
125
+		$query = isset($url_bits['query']) ? $url_bits['query'] : '';
126 126
 		// if we don't want the query string formatted into an array of key => value pairs, then just return it as is
127
-		if ( ! $as_array ) {
127
+		if ( ! $as_array) {
128 128
 			return $query;
129 129
 		}
130 130
 		// if no query string exists then just return an empty array now
131
-		if ( empty( $query )) {
131
+		if (empty($query)) {
132 132
 			return array();
133 133
 		}
134 134
 		// empty array to hold results
135 135
 		$query_params = array();
136 136
 		// now break apart the query string into separate params
137
-		$query = explode( '&', $query );
137
+		$query = explode('&', $query);
138 138
 		// loop thru our query params
139
-		foreach ( $query as $query_args ) {
139
+		foreach ($query as $query_args) {
140 140
 			// break apart the key value pairs
141
-			$query_args = explode( '=', $query_args );
141
+			$query_args = explode('=', $query_args);
142 142
             // and add to our results array
143
-			$query_params[ $query_args[0] ] = $query_args[1];
143
+			$query_params[$query_args[0]] = $query_args[1];
144 144
 		}
145 145
 		return $query_params;
146 146
 	}
@@ -151,7 +151,7 @@  discard block
 block discarded – undo
151 151
 	 * prevent_prefetching
152 152
 	 * @return void
153 153
 	 */
154
-	public static function prevent_prefetching(){
154
+	public static function prevent_prefetching() {
155 155
 		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
156 156
 		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
157 157
 	}
@@ -166,9 +166,9 @@  discard block
 block discarded – undo
166 166
 	 * @param   string $prefix Use this to prefix the string with something.
167 167
 	 * @return string
168 168
 	 */
169
-	public static function generate_unique_token( $prefix = '' ) {
170
-		$token =  md5( uniqid() . mt_rand() );
171
-		return $prefix ? $prefix . '_' . $token : $token;
169
+	public static function generate_unique_token($prefix = '') {
170
+		$token = md5(uniqid().mt_rand());
171
+		return $prefix ? $prefix.'_'.$token : $token;
172 172
 	}
173 173
 
174 174
 
@@ -177,7 +177,7 @@  discard block
 block discarded – undo
177 177
 	 * add_nocache_headers
178 178
 	 * @return void
179 179
 	 */
180
-	public static function add_nocache_headers(){
180
+	public static function add_nocache_headers() {
181 181
 		// add no cache headers
182 182
 //		add_action( 'wp_head' , array( 'EED_Single_Page_Checkout', 'nocache_headers' ), 10 );
183 183
 		// plus a little extra for nginx
@@ -194,20 +194,20 @@  discard block
 block discarded – undo
194 194
 	 * @param string $server_variable
195 195
 	 * @return string
196 196
 	 */
197
-	public static function filter_input_server_url( $server_variable = 'REQUEST_URI' ){
197
+	public static function filter_input_server_url($server_variable = 'REQUEST_URI') {
198 198
 		$URL = '';
199 199
 		$server_variables = array(
200 200
 			'REQUEST_URI' => 1,
201 201
 			'HTTP_HOST' => 1,
202 202
 			'PHP_SELF' => 1,
203 203
 		);
204
-		$server_variable = strtoupper( $server_variable );
204
+		$server_variable = strtoupper($server_variable);
205 205
 		// whitelist INPUT_SERVER var
206
-		if ( isset( $server_variables[ $server_variable ] ) ) {
207
-            $URL = filter_input( INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE );
208
-            if ( empty( $URL ) ) {
206
+		if (isset($server_variables[$server_variable])) {
207
+            $URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
208
+            if (empty($URL)) {
209 209
                  // fallback sanitization if the above fails
210
-				$URL = wp_sanitize_redirect( $_SERVER[ $server_variable ] );
210
+				$URL = wp_sanitize_redirect($_SERVER[$server_variable]);
211 211
 			}
212 212
 		}
213 213
 		return $URL;
@@ -220,10 +220,10 @@  discard block
 block discarded – undo
220 220
 	 * @return string
221 221
 	 */
222 222
 	public static function current_url() {
223
-		if ( isset( $_SERVER[ 'HTTP_HOST' ], $_SERVER[ 'REQUEST_URI' ] ) ) {
223
+		if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
224 224
 			$url = is_ssl() ? 'https://' : 'http://';
225
-			$url .= \EEH_URL::filter_input_server_url( 'HTTP_HOST' );
226
-			$url .= \EEH_URL::filter_input_server_url( 'REQUEST_URI' );
225
+			$url .= \EEH_URL::filter_input_server_url('HTTP_HOST');
226
+			$url .= \EEH_URL::filter_input_server_url('REQUEST_URI');
227 227
 		} else {
228 228
 			$url = 'unknown';
229 229
 		}
Please login to merge, or discard this patch.
modules/invalid_checkout_access/InvalidCheckoutAccess.php 2 patches
Indentation   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -39,8 +39,8 @@  discard block
 block discarded – undo
39 39
 		if (
40 40
 			! ( $checkout->uts || $checkout->reg_url_link )
41 41
 			&& ! ( defined( 'DOING_AJAX' ) && DOING_AJAX )
42
-            && \EE_Config::instance()->registration->track_invalid_checkout_access()
43
-        ) {
42
+			&& \EE_Config::instance()->registration->track_invalid_checkout_access()
43
+		) {
44 44
 			/** @var \EE_Request $request */
45 45
 			$request = \EE_Registry::instance()->load_core( 'EE_Request' );
46 46
 			$ip_address = $request->ip_address();
@@ -60,14 +60,14 @@  discard block
 block discarded – undo
60 60
 			}
61 61
 			$ee_bot_checkout[ $ip_address ][ $http_referer ]++;
62 62
 			update_option( InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout );
63
-            if (WP_DEBUG) {
64
-                \EE_Error::add_error(
65
-                    esc_html__('Direct access to the registration checkout page is not allowed.', 'event_espresso'),
66
-                    __FILE__,
67
-                    __FUNCTION__,
68
-                    __LINE__
69
-                );
70
-            }
63
+			if (WP_DEBUG) {
64
+				\EE_Error::add_error(
65
+					esc_html__('Direct access to the registration checkout page is not allowed.', 'event_espresso'),
66
+					__FILE__,
67
+					__FUNCTION__,
68
+					__LINE__
69
+				);
70
+			}
71 71
 			return true;
72 72
 		}
73 73
 		return false;
Please login to merge, or discard this patch.
Spacing   +29 added lines, -29 removed lines patch added patch discarded remove patch
@@ -1,8 +1,8 @@  discard block
 block discarded – undo
1 1
 <?php
2 2
 namespace EventEspresso\modules\invalid_checkout_access;
3 3
 
4
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
5
-	exit( 'No direct script access allowed' );
4
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
5
+	exit('No direct script access allowed');
6 6
 }
7 7
 
8 8
 
@@ -35,31 +35,31 @@  discard block
 block discarded – undo
35 35
 	 * @param \EE_Checkout $checkout
36 36
 	 * @return bool true if access to registration checkout appears to be invalid
37 37
 	 */
38
-	public function checkoutAccessIsInvalid( \EE_Checkout $checkout ) {
38
+	public function checkoutAccessIsInvalid(\EE_Checkout $checkout) {
39 39
 		if (
40
-			! ( $checkout->uts || $checkout->reg_url_link )
41
-			&& ! ( defined( 'DOING_AJAX' ) && DOING_AJAX )
40
+			! ($checkout->uts || $checkout->reg_url_link)
41
+			&& ! (defined('DOING_AJAX') && DOING_AJAX)
42 42
             && \EE_Config::instance()->registration->track_invalid_checkout_access()
43 43
         ) {
44 44
 			/** @var \EE_Request $request */
45
-			$request = \EE_Registry::instance()->load_core( 'EE_Request' );
45
+			$request = \EE_Registry::instance()->load_core('EE_Request');
46 46
 			$ip_address = $request->ip_address();
47
-			$ee_bot_checkout = get_option( InvalidCheckoutAccess::OPTION_KEY );
48
-			if ( $ee_bot_checkout === false ) {
47
+			$ee_bot_checkout = get_option(InvalidCheckoutAccess::OPTION_KEY);
48
+			if ($ee_bot_checkout === false) {
49 49
 				$ee_bot_checkout = array();
50
-				add_option( InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout, '', false );
50
+				add_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout, '', false);
51 51
 			}
52
-			if ( ! isset( $ee_bot_checkout[ $ip_address ] ) ) {
53
-				$ee_bot_checkout[ $ip_address ] = array();
52
+			if ( ! isset($ee_bot_checkout[$ip_address])) {
53
+				$ee_bot_checkout[$ip_address] = array();
54 54
 			}
55
-			$http_referer = isset( $_SERVER['HTTP_REFERER'] )
56
-				? esc_attr( $_SERVER['HTTP_REFERER'] )
55
+			$http_referer = isset($_SERVER['HTTP_REFERER'])
56
+				? esc_attr($_SERVER['HTTP_REFERER'])
57 57
 				: 0;
58
-			if ( ! isset( $ee_bot_checkout[ $ip_address ][ $http_referer ] ) ) {
59
-				$ee_bot_checkout[ $ip_address ][ $http_referer ] = 0;
58
+			if ( ! isset($ee_bot_checkout[$ip_address][$http_referer])) {
59
+				$ee_bot_checkout[$ip_address][$http_referer] = 0;
60 60
 			}
61
-			$ee_bot_checkout[ $ip_address ][ $http_referer ]++;
62
-			update_option( InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout );
61
+			$ee_bot_checkout[$ip_address][$http_referer]++;
62
+			update_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout);
63 63
             if (WP_DEBUG) {
64 64
                 \EE_Error::add_error(
65 65
                     esc_html__('Direct access to the registration checkout page is not allowed.', 'event_espresso'),
@@ -88,13 +88,13 @@  discard block
 block discarded – undo
88 88
 				'layout_strategy' => new \EE_Admin_Two_Column_Layout(),
89 89
 				'subsections'     => array(
90 90
 					'invalid_checkout_access_hdr'   => new \EE_Form_Section_HTML(
91
-						\EEH_HTML::h2( esc_html__( 'Invalid Checkout Access', 'event_espresso' ) )
91
+						\EEH_HTML::h2(esc_html__('Invalid Checkout Access', 'event_espresso'))
92 92
 					),
93 93
 					'ee_bot_checkout_data'          => new \EE_Text_Area_Input(
94 94
 						array(
95
-							'html_label_text' => esc_html__( 'Invalid Checkout Data', 'event_espresso' ),
95
+							'html_label_text' => esc_html__('Invalid Checkout Data', 'event_espresso'),
96 96
 							'default'         => var_export(
97
-								get_option( InvalidCheckoutAccess::OPTION_KEY, array() ),
97
+								get_option(InvalidCheckoutAccess::OPTION_KEY, array()),
98 98
 								true
99 99
 							),
100 100
 							'required'        => false,
@@ -106,7 +106,7 @@  discard block
 block discarded – undo
106 106
 					),
107 107
 					'track_invalid_checkout_access' => new \EE_Yes_No_Input(
108 108
 						array(
109
-							'html_label_text'         => __( 'Track Invalid Checkout Access?', 'event_espresso' ),
109
+							'html_label_text'         => __('Track Invalid Checkout Access?', 'event_espresso'),
110 110
 							'html_help_text'          => esc_html__(
111 111
 								'Controls whether or not invalid attempts to directly access the registration checkout page should be tracked. Setting this to "No" means that the above data will no longer be collected.',
112 112
 								'event_espresso'
@@ -119,7 +119,7 @@  discard block
 block discarded – undo
119 119
 					),
120 120
 					'delete_invalid_checkout_data'  => new \EE_Yes_No_Input(
121 121
 						array(
122
-							'html_label_text'         => __( 'Reset Invalid Checkout Data', 'event_espresso' ),
122
+							'html_label_text'         => __('Reset Invalid Checkout Data', 'event_espresso'),
123 123
 							'html_help_text'          => esc_html__(
124 124
 								'Setting this to "Yes" will delete all existing invalid checkout access data.',
125 125
 								'event_espresso'
@@ -141,15 +141,15 @@  discard block
 block discarded – undo
141 141
 	 * @param \EE_Registration_Config $EE_Registration_Config
142 142
 	 * @return \EE_Registration_Config
143 143
 	 */
144
-	public function processForm( \EE_Registration_Config $EE_Registration_Config ) {
144
+	public function processForm(\EE_Registration_Config $EE_Registration_Config) {
145 145
 		try {
146 146
 			$invalid_checkout_access_form = $this->getForm();
147 147
 			// if not displaying a form, then check for form submission
148
-			if ( $invalid_checkout_access_form->was_submitted() ) {
148
+			if ($invalid_checkout_access_form->was_submitted()) {
149 149
 				// capture form data
150 150
 				$invalid_checkout_access_form->receive_form_submission();
151 151
 				// validate form data
152
-				if ( $invalid_checkout_access_form->is_valid() ) {
152
+				if ($invalid_checkout_access_form->is_valid()) {
153 153
 					// grab validated data from form
154 154
 					$valid_data = $invalid_checkout_access_form->valid_data();
155 155
 					// ensure form inputs we want are set
@@ -163,8 +163,8 @@  discard block
 block discarded – undo
163 163
 							$valid_data['track_invalid_checkout_access']
164 164
 						);
165 165
 						// if deleting, then update option with empty array
166
-						if ( filter_var( $valid_data['delete_invalid_checkout_data'], FILTER_VALIDATE_BOOLEAN ) ) {
167
-							update_option( InvalidCheckoutAccess::OPTION_KEY, array() );
166
+						if (filter_var($valid_data['delete_invalid_checkout_data'], FILTER_VALIDATE_BOOLEAN)) {
167
+							update_option(InvalidCheckoutAccess::OPTION_KEY, array());
168 168
 						}
169 169
 					} else {
170 170
 						\EE_Error::add_error(
@@ -178,7 +178,7 @@  discard block
 block discarded – undo
178 178
 						);
179 179
 					}
180 180
 				} else {
181
-					if ( $invalid_checkout_access_form->submission_error_message() !== '' ) {
181
+					if ($invalid_checkout_access_form->submission_error_message() !== '') {
182 182
 						\EE_Error::add_error(
183 183
 							$invalid_checkout_access_form->submission_error_message(),
184 184
 							__FILE__,
@@ -188,7 +188,7 @@  discard block
 block discarded – undo
188 188
 					}
189 189
 				}
190 190
 			}
191
-		} catch ( \EE_Error $e ) {
191
+		} catch (\EE_Error $e) {
192 192
 			$e->get_error();
193 193
 		}
194 194
 		return $EE_Registration_Config;
Please login to merge, or discard this patch.
core/libraries/form_sections/base/EE_Form_Section_Proper.form.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -370,7 +370,7 @@
 block discarded – undo
370 370
      *                                                      with construction finalize being called later
371 371
      *                                                      (realizing that the subsections' html names
372 372
      *                                                      might not be set yet, etc.)
373
-     * @return EE_Form_Section_Base
373
+     * @return EE_Form_Section_Validatable|null
374 374
      * @throws \EE_Error
375 375
      */
376 376
     public function get_subsection($name, $require_construction_to_be_finalized = true)
Please login to merge, or discard this patch.
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -86,7 +86,7 @@  discard block
 block discarded – undo
86 86
      */
87 87
     public function __construct($options_array = array())
88 88
     {
89
-        $options_array = (array)apply_filters('FHEE__EE_Form_Section_Proper___construct__options_array', $options_array,
89
+        $options_array = (array) apply_filters('FHEE__EE_Form_Section_Proper___construct__options_array', $options_array,
90 90
             $this);
91 91
         //call parent first, as it may be setting the name
92 92
         parent::__construct($options_array);
@@ -606,7 +606,7 @@  discard block
 block discarded – undo
606 606
         add_filter('FHEE_load_jquery_validate', '__return_true');
607 607
         wp_register_script(
608 608
             'ee_form_section_validation',
609
-            EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
609
+            EE_GLOBAL_ASSETS_URL.'scripts'.DS.'form_section_validation.js',
610 610
             array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
611 611
             EVENT_ESPRESSO_VERSION,
612 612
             true
@@ -848,8 +848,8 @@  discard block
 block discarded – undo
848 848
     protected function _validate()
849 849
     {
850 850
         foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
851
-            if (method_exists($this, '_validate_' . $subsection_name)) {
852
-                call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
851
+            if (method_exists($this, '_validate_'.$subsection_name)) {
852
+                call_user_func_array(array($this, '_validate_'.$subsection_name), array($subsection));
853 853
             }
854 854
             $subsection->_validate();
855 855
         }
@@ -1215,7 +1215,7 @@  discard block
 block discarded – undo
1215 1215
     public function html_name_prefix()
1216 1216
     {
1217 1217
         if ($this->parent_section() instanceof EE_Form_Section_Proper) {
1218
-            return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
1218
+            return $this->parent_section()->html_name_prefix().'['.$this->name().']';
1219 1219
         } else {
1220 1220
             return $this->name();
1221 1221
         }
Please login to merge, or discard this patch.
Indentation   +1348 added lines, -1348 removed lines patch added patch discarded remove patch
@@ -13,1354 +13,1354 @@
 block discarded – undo
13 13
 class EE_Form_Section_Proper extends EE_Form_Section_Validatable
14 14
 {
15 15
 
16
-    const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
17
-
18
-    /**
19
-     * Subsections
20
-     *
21
-     * @var EE_Form_Section_Validatable[]
22
-     */
23
-    protected $_subsections = array();
24
-
25
-    /**
26
-     * Strategy for laying out the form
27
-     *
28
-     * @var EE_Form_Section_Layout_Base
29
-     */
30
-    protected $_layout_strategy;
31
-
32
-    /**
33
-     * Whether or not this form has received and validated a form submission yet
34
-     *
35
-     * @var boolean
36
-     */
37
-    protected $_received_submission = false;
38
-
39
-    /**
40
-     * message displayed to users upon successful form submission
41
-     *
42
-     * @var string
43
-     */
44
-    protected $_form_submission_success_message = '';
45
-
46
-    /**
47
-     * message displayed to users upon unsuccessful form submission
48
-     *
49
-     * @var string
50
-     */
51
-    protected $_form_submission_error_message = '';
52
-
53
-    /**
54
-     * Stores all the data that will localized for form validation
55
-     *
56
-     * @var array
57
-     */
58
-    static protected $_js_localization = array();
59
-
60
-    /**
61
-     * whether or not the form's localized validation JS vars have been set
62
-     *
63
-     * @type boolean
64
-     */
65
-    static protected $_scripts_localized = false;
66
-
67
-
68
-
69
-    /**
70
-     * when constructing a proper form section, calls _construct_finalize on children
71
-     * so that they know who their parent is, and what name they've been given.
72
-     *
73
-     * @param array $options_array   {
74
-     * @type        $subsections     EE_Form_Section_Validatable[] where keys are the section's name
75
-     * @type        $include         string[] numerically-indexed where values are section names to be included,
76
-     *                               and in that order. This is handy if you want
77
-     *                               the subsections to be ordered differently than the default, and if you override
78
-     *                               which fields are shown
79
-     * @type        $exclude         string[] values are subsections to be excluded. This is handy if you want
80
-     *                               to remove certain default subsections (note: if you specify BOTH 'include' AND
81
-     *                               'exclude', the inclusions will be applied first, and the exclusions will exclude
82
-     *                               items from that list of inclusions)
83
-     * @type        $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
84
-     *                               } @see EE_Form_Section_Validatable::__construct()
85
-     * @throws \EE_Error
86
-     */
87
-    public function __construct($options_array = array())
88
-    {
89
-        $options_array = (array)apply_filters('FHEE__EE_Form_Section_Proper___construct__options_array', $options_array,
90
-            $this);
91
-        //call parent first, as it may be setting the name
92
-        parent::__construct($options_array);
93
-        //if they've included subsections in the constructor, add them now
94
-        if (isset($options_array['include'])) {
95
-            //we are going to make sure we ONLY have those subsections to include
96
-            //AND we are going to make sure they're in that specified order
97
-            $reordered_subsections = array();
98
-            foreach ($options_array['include'] as $input_name) {
99
-                if (isset($this->_subsections[$input_name])) {
100
-                    $reordered_subsections[$input_name] = $this->_subsections[$input_name];
101
-                }
102
-            }
103
-            $this->_subsections = $reordered_subsections;
104
-        }
105
-        if (isset($options_array['exclude'])) {
106
-            $exclude = $options_array['exclude'];
107
-            $this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
108
-        }
109
-        if (isset($options_array['layout_strategy'])) {
110
-            $this->_layout_strategy = $options_array['layout_strategy'];
111
-        }
112
-        if ( ! $this->_layout_strategy) {
113
-            $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
114
-        }
115
-        $this->_layout_strategy->_construct_finalize($this);
116
-        //ok so we are definitely going to want the forms JS,
117
-        //so enqueue it or remember to enqueue it during wp_enqueue_scripts
118
-        if (did_action('wp_enqueue_scripts')
119
-            || did_action('admin_enqueue_scripts')
120
-        ) {
121
-            //ok so they've constructed this object after when they should have.
122
-            //just enqueue the generic form scripts and initialize the form immediately in the JS
123
-            \EE_Form_Section_Proper::wp_enqueue_scripts(true);
124
-        } else {
125
-            add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
126
-            add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
127
-        }
128
-        add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
129
-        if (isset($options_array['name'])) {
130
-            $this->_construct_finalize(null, $options_array['name']);
131
-        }
132
-    }
133
-
134
-
135
-
136
-    /**
137
-     * Finishes construction given the parent form section and this form section's name
138
-     *
139
-     * @param EE_Form_Section_Proper $parent_form_section
140
-     * @param string                 $name
141
-     * @throws \EE_Error
142
-     */
143
-    public function _construct_finalize($parent_form_section, $name)
144
-    {
145
-        parent::_construct_finalize($parent_form_section, $name);
146
-        $this->_set_default_name_if_empty();
147
-        $this->_set_default_html_id_if_empty();
148
-        foreach ($this->_subsections as $subsection_name => $subsection) {
149
-            if ($subsection instanceof EE_Form_Section_Base) {
150
-                $subsection->_construct_finalize($this, $subsection_name);
151
-            } else {
152
-                throw new EE_Error(
153
-                    sprintf(
154
-                        __('Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
155
-                            'event_espresso'),
156
-                        $subsection_name,
157
-                        get_class($this),
158
-                        $subsection ? get_class($subsection) : __('NULL', 'event_espresso')
159
-                    )
160
-                );
161
-            }
162
-        }
163
-        do_action('AHEE__EE_Form_Section_Proper___construct_finalize__end', $this, $parent_form_section, $name);
164
-    }
165
-
166
-
167
-
168
-    /**
169
-     * Gets the layout strategy for this form section
170
-     *
171
-     * @return EE_Form_Section_Layout_Base
172
-     */
173
-    public function get_layout_strategy()
174
-    {
175
-        return $this->_layout_strategy;
176
-    }
177
-
178
-
179
-
180
-    /**
181
-     * Gets the HTML for a single input for this form section according
182
-     * to the layout strategy
183
-     *
184
-     * @param EE_Form_Input_Base $input
185
-     * @return string
186
-     */
187
-    public function get_html_for_input($input)
188
-    {
189
-        return $this->_layout_strategy->layout_input($input);
190
-    }
191
-
192
-
193
-
194
-    /**
195
-     * was_submitted - checks if form inputs are present in request data
196
-     * Basically an alias for form_data_present_in() (which is used by both
197
-     * proper form sections and form inputs)
198
-     *
199
-     * @param null $form_data
200
-     * @return boolean
201
-     */
202
-    public function was_submitted($form_data = null)
203
-    {
204
-        return $this->form_data_present_in($form_data);
205
-    }
206
-
207
-
208
-
209
-    /**
210
-     * After the form section is initially created, call this to sanitize the data in the submission
211
-     * which relates to this form section, validate it, and set it as properties on the form.
212
-     *
213
-     * @param array|null $req_data should usually be $_POST (the default).
214
-     *                             However, you CAN supply a different array.
215
-     *                             Consider using set_defaults() instead however.
216
-     *                             (If you rendered the form in the page using echo $form_x->get_html()
217
-     *                             the inputs will have the correct name in the request data for this function
218
-     *                             to find them and populate the form with them.
219
-     *                             If you have a flat form (with only input subsections),
220
-     *                             you can supply a flat array where keys
221
-     *                             are the form input names and values are their values)
222
-     * @param boolean    $validate whether or not to perform validation on this data. Default is,
223
-     *                             of course, to validate that data, and set errors on the invalid values.
224
-     *                             But if the data has already been validated
225
-     *                             (eg you validated the data then stored it in the DB)
226
-     *                             you may want to skip this step.
227
-     */
228
-    public function receive_form_submission($req_data = null, $validate = true)
229
-    {
230
-        $req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', $req_data, $this,
231
-            $validate);
232
-        if ($req_data === null) {
233
-            $req_data = array_merge($_GET, $_POST);
234
-        }
235
-        $req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__request_data', $req_data,
236
-            $this);
237
-        $this->_normalize($req_data);
238
-        if ($validate) {
239
-            $this->_validate();
240
-            //if it's invalid, we're going to want to re-display so remember what they submitted
241
-            if ( ! $this->is_valid()) {
242
-                $this->store_submitted_form_data_in_session();
243
-            }
244
-        }
245
-        do_action('AHEE__EE_Form_Section_Proper__receive_form_submission__end', $req_data, $this, $validate);
246
-    }
247
-
248
-
249
-
250
-    /**
251
-     * caches the originally submitted input values in the session
252
-     * so that they can be used to repopulate the form if it failed validation
253
-     *
254
-     * @return boolean whether or not the data was successfully stored in the session
255
-     */
256
-    protected function store_submitted_form_data_in_session()
257
-    {
258
-        return EE_Registry::instance()->SSN->set_session_data(
259
-            array(
260
-                \EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
261
-            )
262
-        );
263
-    }
264
-
265
-
266
-
267
-    /**
268
-     * retrieves the originally submitted input values in the session
269
-     * so that they can be used to repopulate the form if it failed validation
270
-     *
271
-     * @return array
272
-     */
273
-    protected function get_submitted_form_data_from_session()
274
-    {
275
-        $session = EE_Registry::instance()->SSN;
276
-        if ($session instanceof EE_Session) {
277
-            return $session->get_session_data(
278
-                \EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
279
-            );
280
-        } else {
281
-            return array();
282
-        }
283
-    }
284
-
285
-
286
-
287
-    /**
288
-     * flushed the originally submitted input values from the session
289
-     *
290
-     * @return boolean whether or not the data was successfully removed from the session
291
-     */
292
-    protected function flush_submitted_form_data_from_session()
293
-    {
294
-        return EE_Registry::instance()->SSN->reset_data(
295
-            array(\EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
296
-        );
297
-    }
298
-
299
-
300
-
301
-    /**
302
-     * Populates this form and its subsections with data from the session.
303
-     * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
304
-     * validation errors when displaying too)
305
-     * Returns true if the form was populated from the session, false otherwise
306
-     *
307
-     * @return boolean
308
-     */
309
-    public function populate_from_session()
310
-    {
311
-        $form_data_in_session = $this->get_submitted_form_data_from_session();
312
-        if (empty($form_data_in_session)) {
313
-            return false;
314
-        }
315
-        $this->receive_form_submission($form_data_in_session);
316
-        $this->flush_submitted_form_data_from_session();
317
-        if ($this->form_data_present_in($form_data_in_session)) {
318
-            return true;
319
-        } else {
320
-            return false;
321
-        }
322
-    }
323
-
324
-
325
-
326
-    /**
327
-     * Populates the default data for the form, given an array where keys are
328
-     * the input names, and values are their values (preferably normalized to be their
329
-     * proper PHP types, not all strings... although that should be ok too).
330
-     * Proper subsections are sub-arrays, the key being the subsection's name, and
331
-     * the value being an array formatted in teh same way
332
-     *
333
-     * @param array $default_data
334
-     */
335
-    public function populate_defaults($default_data)
336
-    {
337
-        foreach ($this->subsections() as $subsection_name => $subsection) {
338
-            if (isset($default_data[$subsection_name])) {
339
-                if ($subsection instanceof EE_Form_Input_Base) {
340
-                    $subsection->set_default($default_data[$subsection_name]);
341
-                } elseif ($subsection instanceof EE_Form_Section_Proper) {
342
-                    $subsection->populate_defaults($default_data[$subsection_name]);
343
-                }
344
-            }
345
-        }
346
-    }
347
-
348
-
349
-
350
-    /**
351
-     * returns true if subsection exists
352
-     *
353
-     * @param string $name
354
-     * @return boolean
355
-     */
356
-    public function subsection_exists($name)
357
-    {
358
-        return isset($this->_subsections[$name]) ? true : false;
359
-    }
360
-
361
-
362
-
363
-    /**
364
-     * Gets the subsection specified by its name
365
-     *
366
-     * @param string  $name
367
-     * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
368
-     *                                                      so that the inputs will be properly configured.
369
-     *                                                      However, some client code may be ok
370
-     *                                                      with construction finalize being called later
371
-     *                                                      (realizing that the subsections' html names
372
-     *                                                      might not be set yet, etc.)
373
-     * @return EE_Form_Section_Base
374
-     * @throws \EE_Error
375
-     */
376
-    public function get_subsection($name, $require_construction_to_be_finalized = true)
377
-    {
378
-        if ($require_construction_to_be_finalized) {
379
-            $this->ensure_construct_finalized_called();
380
-        }
381
-        return $this->subsection_exists($name) ? $this->_subsections[$name] : null;
382
-    }
383
-
384
-
385
-
386
-    /**
387
-     * Gets all the validatable subsections of this form section
388
-     *
389
-     * @return EE_Form_Section_Validatable[]
390
-     */
391
-    public function get_validatable_subsections()
392
-    {
393
-        $validatable_subsections = array();
394
-        foreach ($this->subsections() as $name => $obj) {
395
-            if ($obj instanceof EE_Form_Section_Validatable) {
396
-                $validatable_subsections[$name] = $obj;
397
-            }
398
-        }
399
-        return $validatable_subsections;
400
-    }
401
-
402
-
403
-
404
-    /**
405
-     * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
406
-     * throw an EE_Error.
407
-     *
408
-     * @param string  $name
409
-     * @param boolean $require_construction_to_be_finalized most client code should
410
-     *                                                      leave this as TRUE so that the inputs will be properly
411
-     *                                                      configured. However, some client code may be ok with
412
-     *                                                      construction finalize being called later
413
-     *                                                      (realizing that the subsections' html names might not be
414
-     *                                                      set yet, etc.)
415
-     * @return EE_Form_Input_Base
416
-     * @throws EE_Error
417
-     */
418
-    public function get_input($name, $require_construction_to_be_finalized = true)
419
-    {
420
-        $subsection = $this->get_subsection($name, $require_construction_to_be_finalized);
421
-        if ( ! $subsection instanceof EE_Form_Input_Base) {
422
-            throw new EE_Error(
423
-                sprintf(
424
-                    __(
425
-                        "Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
426
-                        'event_espresso'
427
-                    ),
428
-                    $name,
429
-                    get_class($this),
430
-                    $subsection ? get_class($subsection) : __("NULL", 'event_espresso')
431
-                )
432
-            );
433
-        }
434
-        return $subsection;
435
-    }
436
-
437
-
438
-
439
-    /**
440
-     * Like get_input(), gets the proper subsection of the form given the name,
441
-     * otherwise throws an EE_Error
442
-     *
443
-     * @param string  $name
444
-     * @param boolean $require_construction_to_be_finalized most client code should
445
-     *                                                      leave this as TRUE so that the inputs will be properly
446
-     *                                                      configured. However, some client code may be ok with
447
-     *                                                      construction finalize being called later
448
-     *                                                      (realizing that the subsections' html names might not be
449
-     *                                                      set yet, etc.)
450
-     * @return EE_Form_Section_Proper
451
-     * @throws EE_Error
452
-     */
453
-    public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
454
-    {
455
-        $subsection = $this->get_subsection($name, $require_construction_to_be_finalized);
456
-        if ( ! $subsection instanceof EE_Form_Section_Proper) {
457
-            throw new EE_Error(
458
-                sprintf(
459
-                    __("Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'", 'event_espresso'),
460
-                    $name,
461
-                    get_class($this)
462
-                )
463
-            );
464
-        }
465
-        return $subsection;
466
-    }
467
-
468
-
469
-
470
-    /**
471
-     * Gets the value of the specified input. Should be called after receive_form_submission()
472
-     * or populate_defaults() on the form, where the normalized value on the input is set.
473
-     *
474
-     * @param string $name
475
-     * @return mixed depending on the input's type and its normalization strategy
476
-     * @throws \EE_Error
477
-     */
478
-    public function get_input_value($name)
479
-    {
480
-        $input = $this->get_input($name);
481
-        return $input->normalized_value();
482
-    }
483
-
484
-
485
-
486
-    /**
487
-     * Checks if this form section itself is valid, and then checks its subsections
488
-     *
489
-     * @throws EE_Error
490
-     * @return boolean
491
-     */
492
-    public function is_valid()
493
-    {
494
-        if ( ! $this->has_received_submission()) {
495
-            throw new EE_Error(
496
-                sprintf(
497
-                    __(
498
-                        "You cannot check if a form is valid before receiving the form submission using receive_form_submission",
499
-                        "event_espresso"
500
-                    )
501
-                )
502
-            );
503
-        }
504
-        if ( ! parent::is_valid()) {
505
-            return false;
506
-        }
507
-        // ok so no general errors to this entire form section.
508
-        // so let's check the subsections, but only set errors if that hasn't been done yet
509
-        $set_submission_errors = $this->submission_error_message() === '' ? true : false;
510
-        foreach ($this->get_validatable_subsections() as $subsection) {
511
-            if ( ! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') {
512
-                if ($set_submission_errors) {
513
-                    $this->set_submission_error_message($subsection->get_validation_error_string());
514
-                }
515
-                return false;
516
-            }
517
-        }
518
-        return true;
519
-    }
520
-
521
-
522
-
523
-    /**
524
-     * gets teh default name of this form section if none is specified
525
-     *
526
-     * @return string
527
-     */
528
-    protected function _set_default_name_if_empty()
529
-    {
530
-        if ( ! $this->_name) {
531
-            $classname = get_class($this);
532
-            $default_name = str_replace("EE_", "", $classname);
533
-            $this->_name = $default_name;
534
-        }
535
-    }
536
-
537
-
538
-
539
-    /**
540
-     * Returns the HTML for the form, except for the form opening and closing tags
541
-     * (as the form section doesn't know where you necessarily want to send the information to),
542
-     * and except for a submit button. Enqueus JS and CSS; if called early enough we will
543
-     * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
544
-     * Not doing_it_wrong because theoretically this CAN be used properly,
545
-     * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
546
-     * any CSS.
547
-     *
548
-     * @throws \EE_Error
549
-     */
550
-    public function get_html_and_js()
551
-    {
552
-        $this->enqueue_js();
553
-        return $this->get_html();
554
-    }
555
-
556
-
557
-
558
-    /**
559
-     * returns HTML for displaying this form section. recursively calls display_section() on all subsections
560
-     *
561
-     * @param bool $display_previously_submitted_data
562
-     * @return string
563
-     */
564
-    public function get_html($display_previously_submitted_data = true)
565
-    {
566
-        $this->ensure_construct_finalized_called();
567
-        if ($display_previously_submitted_data) {
568
-            $this->populate_from_session();
569
-        }
570
-        return $this->_layout_strategy->layout_form();
571
-    }
572
-
573
-
574
-
575
-    /**
576
-     * enqueues JS and CSS for the form.
577
-     * It is preferred to call this before wp_enqueue_scripts so the
578
-     * scripts and styles can be put in the header, but if called later
579
-     * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
580
-     * only be in the header; but in HTML5 its ok in the body.
581
-     * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
582
-     * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
583
-     *
584
-     * @return string
585
-     * @throws \EE_Error
586
-     */
587
-    public function enqueue_js()
588
-    {
589
-        $this->_enqueue_and_localize_form_js();
590
-        foreach ($this->subsections() as $subsection) {
591
-            $subsection->enqueue_js();
592
-        }
593
-    }
594
-
595
-
596
-
597
-    /**
598
-     * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
599
-     * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
600
-     * the wp_enqueue_scripts hook.
601
-     * However, registering the form js and localizing it can happen when we
602
-     * actually output the form (which is preferred, seeing how teh form's fields
603
-     * could change until it's actually outputted)
604
-     *
605
-     * @param boolean $init_form_validation_automatically whether or not we want the form validation
606
-     *                                                    to be triggered automatically or not
607
-     * @return void
608
-     */
609
-    public static function wp_enqueue_scripts($init_form_validation_automatically = true)
610
-    {
611
-        add_filter('FHEE_load_jquery_validate', '__return_true');
612
-        wp_register_script(
613
-            'ee_form_section_validation',
614
-            EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
615
-            array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
616
-            EVENT_ESPRESSO_VERSION,
617
-            true
618
-        );
619
-        wp_localize_script(
620
-            'ee_form_section_validation',
621
-            'ee_form_section_validation_init',
622
-            array('init' => $init_form_validation_automatically ? true : false)
623
-        );
624
-    }
625
-
626
-
627
-
628
-    /**
629
-     * gets the variables used by form_section_validation.js.
630
-     * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
631
-     * but before the wordpress hook wp_loaded
632
-     *
633
-     * @throws \EE_Error
634
-     */
635
-    public function _enqueue_and_localize_form_js()
636
-    {
637
-        $this->ensure_construct_finalized_called();
638
-        //actually, we don't want to localize just yet. There may be other forms on the page.
639
-        //so we need to add our form section data to a static variable accessible by all form sections
640
-        //and localize it just before the footer
641
-        $this->localize_validation_rules();
642
-        add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
643
-        add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
644
-    }
645
-
646
-
647
-
648
-    /**
649
-     * add our form section data to a static variable accessible by all form sections
650
-     *
651
-     * @param bool $return_for_subsection
652
-     * @return void
653
-     * @throws \EE_Error
654
-     */
655
-    public function localize_validation_rules($return_for_subsection = false)
656
-    {
657
-        // we only want to localize vars ONCE for the entire form,
658
-        // so if the form section doesn't have a parent, then it must be the top dog
659
-        if ($return_for_subsection || ! $this->parent_section()) {
660
-            EE_Form_Section_Proper::$_js_localization['form_data'][$this->html_id()] = array(
661
-                'form_section_id'  => $this->html_id(true),
662
-                'validation_rules' => $this->get_jquery_validation_rules(),
663
-                'other_data'       => $this->get_other_js_data(),
664
-                'errors'           => $this->subsection_validation_errors_by_html_name(),
665
-            );
666
-            EE_Form_Section_Proper::$_scripts_localized = true;
667
-        }
668
-    }
669
-
670
-
671
-
672
-    /**
673
-     * Gets an array of extra data that will be useful for client-side javascript.
674
-     * This is primarily data added by inputs and forms in addition to any
675
-     * scripts they might enqueue
676
-     *
677
-     * @param array $form_other_js_data
678
-     * @return array
679
-     */
680
-    public function get_other_js_data($form_other_js_data = array())
681
-    {
682
-        foreach ($this->subsections() as $subsection) {
683
-            $form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
684
-        }
685
-        return $form_other_js_data;
686
-    }
687
-
688
-
689
-
690
-    /**
691
-     * Gets a flat array of inputs for this form section and its subsections.
692
-     * Keys are their form names, and values are the inputs themselves
693
-     *
694
-     * @return EE_Form_Input_Base
695
-     */
696
-    public function inputs_in_subsections()
697
-    {
698
-        $inputs = array();
699
-        foreach ($this->subsections() as $subsection) {
700
-            if ($subsection instanceof EE_Form_Input_Base) {
701
-                $inputs[$subsection->html_name()] = $subsection;
702
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
703
-                $inputs += $subsection->inputs_in_subsections();
704
-            }
705
-        }
706
-        return $inputs;
707
-    }
708
-
709
-
710
-
711
-    /**
712
-     * Gets a flat array of all the validation errors.
713
-     * Keys are html names (because those should be unique)
714
-     * and values are a string of all their validation errors
715
-     *
716
-     * @return string[]
717
-     */
718
-    public function subsection_validation_errors_by_html_name()
719
-    {
720
-        $inputs = $this->inputs();
721
-        $errors = array();
722
-        foreach ($inputs as $form_input) {
723
-            if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
724
-                $errors[$form_input->html_name()] = $form_input->get_validation_error_string();
725
-            }
726
-        }
727
-        return $errors;
728
-    }
729
-
730
-
731
-
732
-    /**
733
-     * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
734
-     * Should be setup by each form during the _enqueues_and_localize_form_js
735
-     */
736
-    public static function localize_script_for_all_forms()
737
-    {
738
-        //allow inputs and stuff to hook in their JS and stuff here
739
-        do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
740
-        EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
741
-        $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
742
-            ? EE_Registry::instance()->CFG->registration->email_validation_level
743
-            : 'wp_default';
744
-        EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level;
745
-        wp_enqueue_script('ee_form_section_validation');
746
-        wp_localize_script(
747
-            'ee_form_section_validation',
748
-            'ee_form_section_vars',
749
-            EE_Form_Section_Proper::$_js_localization
750
-        );
751
-    }
752
-
753
-
754
-
755
-    /**
756
-     * ensure_scripts_localized
757
-     */
758
-    public function ensure_scripts_localized()
759
-    {
760
-        if ( ! EE_Form_Section_Proper::$_scripts_localized) {
761
-            $this->_enqueue_and_localize_form_js();
762
-        }
763
-    }
764
-
765
-
766
-
767
-    /**
768
-     * Gets the hard-coded validation error messages to be used in the JS. The convention
769
-     * is that the key here should be the same as the custom validation rule put in the JS file
770
-     *
771
-     * @return array keys are custom validation rules, and values are internationalized strings
772
-     */
773
-    private static function _get_localized_error_messages()
774
-    {
775
-        return array(
776
-            'validUrl' => __("This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg", "event_espresso"),
777
-            'regex'    => __('Please check your input', 'event_espresso'),
778
-        );
779
-    }
780
-
781
-
782
-
783
-    /**
784
-     * @return array
785
-     */
786
-    public static function js_localization()
787
-    {
788
-        return self::$_js_localization;
789
-    }
790
-
791
-
792
-
793
-    /**
794
-     * @return array
795
-     */
796
-    public static function reset_js_localization()
797
-    {
798
-        self::$_js_localization = array();
799
-    }
800
-
801
-
802
-
803
-    /**
804
-     * Gets the JS to put inside the jquery validation rules for subsection of this form section.
805
-     * See parent function for more...
806
-     *
807
-     * @return array
808
-     */
809
-    public function get_jquery_validation_rules()
810
-    {
811
-        $jquery_validation_rules = array();
812
-        foreach ($this->get_validatable_subsections() as $subsection) {
813
-            $jquery_validation_rules = array_merge(
814
-                $jquery_validation_rules,
815
-                $subsection->get_jquery_validation_rules()
816
-            );
817
-        }
818
-        return $jquery_validation_rules;
819
-    }
820
-
821
-
822
-
823
-    /**
824
-     * Sanitizes all the data and sets the sanitized value of each field
825
-     *
826
-     * @param array $req_data like $_POST
827
-     * @return void
828
-     */
829
-    protected function _normalize($req_data)
830
-    {
831
-        $this->_received_submission = true;
832
-        $this->_validation_errors = array();
833
-        foreach ($this->get_validatable_subsections() as $subsection) {
834
-            try {
835
-                $subsection->_normalize($req_data);
836
-            } catch (EE_Validation_Error $e) {
837
-                $subsection->add_validation_error($e);
838
-            }
839
-        }
840
-    }
841
-
842
-
843
-
844
-    /**
845
-     * Performs validation on this form section and its subsections.
846
-     * For each subsection,
847
-     * calls _validate_{subsection_name} on THIS form (if the function exists)
848
-     * and passes it the subsection, then calls _validate on that subsection.
849
-     * If you need to perform validation on the form as a whole (considering multiple)
850
-     * you would be best to override this _validate method,
851
-     * calling parent::_validate() first.
852
-     */
853
-    protected function _validate()
854
-    {
855
-        foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
856
-            if (method_exists($this, '_validate_' . $subsection_name)) {
857
-                call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
858
-            }
859
-            $subsection->_validate();
860
-        }
861
-    }
862
-
863
-
864
-
865
-    /**
866
-     * Gets all the validated inputs for the form section
867
-     *
868
-     * @return array
869
-     */
870
-    public function valid_data()
871
-    {
872
-        $inputs = array();
873
-        foreach ($this->subsections() as $subsection_name => $subsection) {
874
-            if ($subsection instanceof EE_Form_Section_Proper) {
875
-                $inputs[$subsection_name] = $subsection->valid_data();
876
-            } else if ($subsection instanceof EE_Form_Input_Base) {
877
-                $inputs[$subsection_name] = $subsection->normalized_value();
878
-            }
879
-        }
880
-        return $inputs;
881
-    }
882
-
883
-
884
-
885
-    /**
886
-     * Gets all the inputs on this form section
887
-     *
888
-     * @return EE_Form_Input_Base[]
889
-     */
890
-    public function inputs()
891
-    {
892
-        $inputs = array();
893
-        foreach ($this->subsections() as $subsection_name => $subsection) {
894
-            if ($subsection instanceof EE_Form_Input_Base) {
895
-                $inputs[$subsection_name] = $subsection;
896
-            }
897
-        }
898
-        return $inputs;
899
-    }
900
-
901
-
902
-
903
-    /**
904
-     * Gets all the subsections which are a proper form
905
-     *
906
-     * @return EE_Form_Section_Proper[]
907
-     */
908
-    public function subforms()
909
-    {
910
-        $form_sections = array();
911
-        foreach ($this->subsections() as $name => $obj) {
912
-            if ($obj instanceof EE_Form_Section_Proper) {
913
-                $form_sections[$name] = $obj;
914
-            }
915
-        }
916
-        return $form_sections;
917
-    }
918
-
919
-
920
-
921
-    /**
922
-     * Gets all the subsections (inputs, proper subsections, or html-only sections).
923
-     * Consider using inputs() or subforms()
924
-     * if you only want form inputs or proper form sections.
925
-     *
926
-     * @return EE_Form_Section_Proper[]
927
-     */
928
-    public function subsections()
929
-    {
930
-        $this->ensure_construct_finalized_called();
931
-        return $this->_subsections;
932
-    }
933
-
934
-
935
-
936
-    /**
937
-     * Returns a simple array where keys are input names, and values are their normalized
938
-     * values. (Similar to calling get_input_value on inputs)
939
-     *
940
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
941
-     *                                        or just this forms' direct children inputs
942
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
943
-     *                                        or allow multidimensional array
944
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
945
-     *                                        with array keys being input names
946
-     *                                        (regardless of whether they are from a subsection or not),
947
-     *                                        and if $flatten is FALSE it can be a multidimensional array
948
-     *                                        where keys are always subsection names and values are either
949
-     *                                        the input's normalized value, or an array like the top-level array
950
-     */
951
-    public function input_values($include_subform_inputs = false, $flatten = false)
952
-    {
953
-        return $this->_input_values(false, $include_subform_inputs, $flatten);
954
-    }
955
-
956
-
957
-
958
-    /**
959
-     * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
960
-     * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
961
-     * is not necessarily the value we want to display to users. This creates an array
962
-     * where keys are the input names, and values are their display values
963
-     *
964
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
965
-     *                                        or just this forms' direct children inputs
966
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
967
-     *                                        or allow multidimensional array
968
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
969
-     *                                        with array keys being input names
970
-     *                                        (regardless of whether they are from a subsection or not),
971
-     *                                        and if $flatten is FALSE it can be a multidimensional array
972
-     *                                        where keys are always subsection names and values are either
973
-     *                                        the input's normalized value, or an array like the top-level array
974
-     */
975
-    public function input_pretty_values($include_subform_inputs = false, $flatten = false)
976
-    {
977
-        return $this->_input_values(true, $include_subform_inputs, $flatten);
978
-    }
979
-
980
-
981
-
982
-    /**
983
-     * Gets the input values from the form
984
-     *
985
-     * @param boolean $pretty                 Whether to retrieve the pretty value,
986
-     *                                        or just the normalized value
987
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
988
-     *                                        or just this forms' direct children inputs
989
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
990
-     *                                        or allow multidimensional array
991
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
992
-     *                                        input names (regardless of whether they are from a subsection or not),
993
-     *                                        and if $flatten is FALSE it can be a multidimensional array
994
-     *                                        where keys are always subsection names and values are either
995
-     *                                        the input's normalized value, or an array like the top-level array
996
-     */
997
-    public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
998
-    {
999
-        $input_values = array();
1000
-        foreach ($this->subsections() as $subsection_name => $subsection) {
1001
-            if ($subsection instanceof EE_Form_Input_Base) {
1002
-                $input_values[$subsection_name] = $pretty
1003
-                    ? $subsection->pretty_value()
1004
-                    : $subsection->normalized_value();
1005
-            } else if ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
1006
-                $subform_input_values = $subsection->_input_values($pretty, $include_subform_inputs, $flatten);
1007
-                if ($flatten) {
1008
-                    $input_values = array_merge($input_values, $subform_input_values);
1009
-                } else {
1010
-                    $input_values[$subsection_name] = $subform_input_values;
1011
-                }
1012
-            }
1013
-        }
1014
-        return $input_values;
1015
-    }
1016
-
1017
-
1018
-
1019
-    /**
1020
-     * Gets the originally submitted input values from the form
1021
-     *
1022
-     * @param boolean $include_subforms  Whether to include inputs from subforms,
1023
-     *                                   or just this forms' direct children inputs
1024
-     * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
1025
-     *                                   with array keys being input names
1026
-     *                                   (regardless of whether they are from a subsection or not),
1027
-     *                                   and if $flatten is FALSE it can be a multidimensional array
1028
-     *                                   where keys are always subsection names and values are either
1029
-     *                                   the input's normalized value, or an array like the top-level array
1030
-     */
1031
-    public function submitted_values($include_subforms = false)
1032
-    {
1033
-        $submitted_values = array();
1034
-        foreach ($this->subsections() as $subsection) {
1035
-            if ($subsection instanceof EE_Form_Input_Base) {
1036
-                // is this input part of an array of inputs?
1037
-                if (strpos($subsection->html_name(), '[') !== false) {
1038
-                    $full_input_name = \EEH_Array::convert_array_values_to_keys(
1039
-                        explode('[', str_replace(']', '', $subsection->html_name())),
1040
-                        $subsection->raw_value()
1041
-                    );
1042
-                    $submitted_values = array_replace_recursive($submitted_values, $full_input_name);
1043
-                } else {
1044
-                    $submitted_values[$subsection->html_name()] = $subsection->raw_value();
1045
-                }
1046
-            } else if ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
1047
-                $subform_input_values = $subsection->submitted_values($include_subforms);
1048
-                $submitted_values = array_replace_recursive($submitted_values, $subform_input_values);
1049
-            }
1050
-        }
1051
-        return $submitted_values;
1052
-    }
1053
-
1054
-
1055
-
1056
-    /**
1057
-     * Indicates whether or not this form has received a submission yet
1058
-     * (ie, had receive_form_submission called on it yet)
1059
-     *
1060
-     * @return boolean
1061
-     * @throws \EE_Error
1062
-     */
1063
-    public function has_received_submission()
1064
-    {
1065
-        $this->ensure_construct_finalized_called();
1066
-        return $this->_received_submission;
1067
-    }
1068
-
1069
-
1070
-
1071
-    /**
1072
-     * Equivalent to passing 'exclude' in the constructor's options array.
1073
-     * Removes the listed inputs from the form
1074
-     *
1075
-     * @param array $inputs_to_exclude values are the input names
1076
-     * @return void
1077
-     */
1078
-    public function exclude($inputs_to_exclude = array())
1079
-    {
1080
-        foreach ($inputs_to_exclude as $input_to_exclude_name) {
1081
-            unset($this->_subsections[$input_to_exclude_name]);
1082
-        }
1083
-    }
1084
-
1085
-
1086
-
1087
-    /**
1088
-     * @param array $inputs_to_hide
1089
-     * @throws \EE_Error
1090
-     */
1091
-    public function hide($inputs_to_hide = array())
1092
-    {
1093
-        foreach ($inputs_to_hide as $input_to_hide) {
1094
-            $input = $this->get_input($input_to_hide);
1095
-            $input->set_display_strategy(new EE_Hidden_Display_Strategy());
1096
-        }
1097
-    }
1098
-
1099
-
1100
-
1101
-    /**
1102
-     * add_subsections
1103
-     * Adds the listed subsections to the form section.
1104
-     * If $subsection_name_to_target is provided,
1105
-     * then new subsections are added before or after that subsection,
1106
-     * otherwise to the start or end of the entire subsections array.
1107
-     *
1108
-     * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
1109
-     *                                                          where keys are their names
1110
-     * @param string                 $subsection_name_to_target an existing for section that $new_subsections
1111
-     *                                                          should be added before or after
1112
-     *                                                          IF $subsection_name_to_target is null,
1113
-     *                                                          then $new_subsections will be added to
1114
-     *                                                          the beginning or end of the entire subsections array
1115
-     * @param boolean                $add_before                whether to add $new_subsections, before or after
1116
-     *                                                          $subsection_name_to_target,
1117
-     *                                                          or if $subsection_name_to_target is null,
1118
-     *                                                          before or after entire subsections array
1119
-     * @return void
1120
-     * @throws \EE_Error
1121
-     */
1122
-    public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
1123
-    {
1124
-        foreach ($new_subsections as $subsection_name => $subsection) {
1125
-            if ( ! $subsection instanceof EE_Form_Section_Base) {
1126
-                EE_Error::add_error(
1127
-                    sprintf(
1128
-                        __(
1129
-                            "Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
1130
-                            "event_espresso"
1131
-                        ),
1132
-                        get_class($subsection),
1133
-                        $subsection_name,
1134
-                        $this->name()
1135
-                    )
1136
-                );
1137
-                unset($new_subsections[$subsection_name]);
1138
-            }
1139
-        }
1140
-        $this->_subsections = EEH_Array::insert_into_array(
1141
-            $this->_subsections,
1142
-            $new_subsections,
1143
-            $subsection_name_to_target,
1144
-            $add_before
1145
-        );
1146
-        if ($this->_construction_finalized) {
1147
-            foreach ($this->_subsections as $name => $subsection) {
1148
-                $subsection->_construct_finalize($this, $name);
1149
-            }
1150
-        }
1151
-    }
1152
-
1153
-
1154
-
1155
-    /**
1156
-     * Just gets all validatable subsections to clean their sensitive data
1157
-     */
1158
-    public function clean_sensitive_data()
1159
-    {
1160
-        foreach ($this->get_validatable_subsections() as $subsection) {
1161
-            $subsection->clean_sensitive_data();
1162
-        }
1163
-    }
1164
-
1165
-
1166
-
1167
-    /**
1168
-     * @param string $form_submission_error_message
1169
-     */
1170
-    public function set_submission_error_message($form_submission_error_message = '')
1171
-    {
1172
-        $this->_form_submission_error_message .= ! empty($form_submission_error_message)
1173
-            ? $form_submission_error_message
1174
-            : __('Form submission failed due to errors', 'event_espresso');
1175
-    }
1176
-
1177
-
1178
-
1179
-    /**
1180
-     * @return string
1181
-     */
1182
-    public function submission_error_message()
1183
-    {
1184
-        return $this->_form_submission_error_message;
1185
-    }
1186
-
1187
-
1188
-
1189
-    /**
1190
-     * @param string $form_submission_success_message
1191
-     */
1192
-    public function set_submission_success_message($form_submission_success_message)
1193
-    {
1194
-        $this->_form_submission_success_message .= ! empty($form_submission_success_message)
1195
-            ? $form_submission_success_message
1196
-            : __('Form submitted successfully', 'event_espresso');
1197
-    }
1198
-
1199
-
1200
-
1201
-    /**
1202
-     * @return string
1203
-     */
1204
-    public function submission_success_message()
1205
-    {
1206
-        return $this->_form_submission_success_message;
1207
-    }
1208
-
1209
-
1210
-
1211
-    /**
1212
-     * Returns the prefix that should be used on child of this form section for
1213
-     * their html names. If this form section itself has a parent, prepends ITS
1214
-     * prefix onto this form section's prefix. Used primarily by
1215
-     * EE_Form_Input_Base::_set_default_html_name_if_empty
1216
-     *
1217
-     * @return string
1218
-     * @throws \EE_Error
1219
-     */
1220
-    public function html_name_prefix()
1221
-    {
1222
-        if ($this->parent_section() instanceof EE_Form_Section_Proper) {
1223
-            return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
1224
-        } else {
1225
-            return $this->name();
1226
-        }
1227
-    }
1228
-
1229
-
1230
-
1231
-    /**
1232
-     * Gets the name, but first checks _construct_finalize has been called. If not,
1233
-     * calls it (assumes there is no parent and that we want the name to be whatever
1234
-     * was set, which is probably nothing, or the classname)
1235
-     *
1236
-     * @return string
1237
-     * @throws \EE_Error
1238
-     */
1239
-    public function name()
1240
-    {
1241
-        $this->ensure_construct_finalized_called();
1242
-        return parent::name();
1243
-    }
1244
-
1245
-
1246
-
1247
-    /**
1248
-     * @return EE_Form_Section_Proper
1249
-     * @throws \EE_Error
1250
-     */
1251
-    public function parent_section()
1252
-    {
1253
-        $this->ensure_construct_finalized_called();
1254
-        return parent::parent_section();
1255
-    }
1256
-
1257
-
1258
-
1259
-    /**
1260
-     * make sure construction finalized was called, otherwise children might not be ready
1261
-     *
1262
-     * @return void
1263
-     * @throws \EE_Error
1264
-     */
1265
-    public function ensure_construct_finalized_called()
1266
-    {
1267
-        if ( ! $this->_construction_finalized) {
1268
-            $this->_construct_finalize($this->_parent_section, $this->_name);
1269
-        }
1270
-    }
1271
-
1272
-
1273
-
1274
-    /**
1275
-     * Checks if any of this form section's inputs, or any of its children's inputs,
1276
-     * are in teh form data. If any are found, returns true. Else false
1277
-     *
1278
-     * @param array $req_data
1279
-     * @return boolean
1280
-     */
1281
-    public function form_data_present_in($req_data = null)
1282
-    {
1283
-        if ($req_data === null) {
1284
-            $req_data = $_POST;
1285
-        }
1286
-        foreach ($this->subsections() as $subsection) {
1287
-            if ($subsection instanceof EE_Form_Input_Base) {
1288
-                if ($subsection->form_data_present_in($req_data)) {
1289
-                    return true;
1290
-                }
1291
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
1292
-                if ($subsection->form_data_present_in($req_data)) {
1293
-                    return true;
1294
-                }
1295
-            }
1296
-        }
1297
-        return false;
1298
-    }
1299
-
1300
-
1301
-
1302
-    /**
1303
-     * Gets validation errors for this form section and subsections
1304
-     * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
1305
-     * gets the validation errors for ALL subsection
1306
-     *
1307
-     * @return EE_Validation_Error[]
1308
-     */
1309
-    public function get_validation_errors_accumulated()
1310
-    {
1311
-        $validation_errors = $this->get_validation_errors();
1312
-        foreach ($this->get_validatable_subsections() as $subsection) {
1313
-            if ($subsection instanceof EE_Form_Section_Proper) {
1314
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
1315
-            } else {
1316
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors();
1317
-            }
1318
-            if ($validation_errors_on_this_subsection) {
1319
-                $validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
1320
-            }
1321
-        }
1322
-        return $validation_errors;
1323
-    }
1324
-
1325
-
1326
-
1327
-    /**
1328
-     * This isn't just the name of an input, it's a path pointing to an input. The
1329
-     * path is similar to a folder path: slash (/) means to descend into a subsection,
1330
-     * dot-dot-slash (../) means to ascend into the parent section.
1331
-     * After a series of slashes and dot-dot-slashes, there should be the name of an input,
1332
-     * which will be returned.
1333
-     * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
1334
-     * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
1335
-     * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
1336
-     * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
1337
-     * Etc
1338
-     *
1339
-     * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
1340
-     * @return EE_Form_Section_Base
1341
-     */
1342
-    public function find_section_from_path($form_section_path)
1343
-    {
1344
-        //check if we can find the input from purely going straight up the tree
1345
-        $input = parent::find_section_from_path($form_section_path);
1346
-        if ($input instanceof EE_Form_Section_Base) {
1347
-            return $input;
1348
-        }
1349
-        $next_slash_pos = strpos($form_section_path, '/');
1350
-        if ($next_slash_pos !== false) {
1351
-            $child_section_name = substr($form_section_path, 0, $next_slash_pos);
1352
-            $subpath = substr($form_section_path, $next_slash_pos + 1);
1353
-        } else {
1354
-            $child_section_name = $form_section_path;
1355
-            $subpath = '';
1356
-        }
1357
-        $child_section = $this->get_subsection($child_section_name);
1358
-        if ($child_section instanceof EE_Form_Section_Base) {
1359
-            return $child_section->find_section_from_path($subpath);
1360
-        } else {
1361
-            return null;
1362
-        }
1363
-    }
16
+	const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
17
+
18
+	/**
19
+	 * Subsections
20
+	 *
21
+	 * @var EE_Form_Section_Validatable[]
22
+	 */
23
+	protected $_subsections = array();
24
+
25
+	/**
26
+	 * Strategy for laying out the form
27
+	 *
28
+	 * @var EE_Form_Section_Layout_Base
29
+	 */
30
+	protected $_layout_strategy;
31
+
32
+	/**
33
+	 * Whether or not this form has received and validated a form submission yet
34
+	 *
35
+	 * @var boolean
36
+	 */
37
+	protected $_received_submission = false;
38
+
39
+	/**
40
+	 * message displayed to users upon successful form submission
41
+	 *
42
+	 * @var string
43
+	 */
44
+	protected $_form_submission_success_message = '';
45
+
46
+	/**
47
+	 * message displayed to users upon unsuccessful form submission
48
+	 *
49
+	 * @var string
50
+	 */
51
+	protected $_form_submission_error_message = '';
52
+
53
+	/**
54
+	 * Stores all the data that will localized for form validation
55
+	 *
56
+	 * @var array
57
+	 */
58
+	static protected $_js_localization = array();
59
+
60
+	/**
61
+	 * whether or not the form's localized validation JS vars have been set
62
+	 *
63
+	 * @type boolean
64
+	 */
65
+	static protected $_scripts_localized = false;
66
+
67
+
68
+
69
+	/**
70
+	 * when constructing a proper form section, calls _construct_finalize on children
71
+	 * so that they know who their parent is, and what name they've been given.
72
+	 *
73
+	 * @param array $options_array   {
74
+	 * @type        $subsections     EE_Form_Section_Validatable[] where keys are the section's name
75
+	 * @type        $include         string[] numerically-indexed where values are section names to be included,
76
+	 *                               and in that order. This is handy if you want
77
+	 *                               the subsections to be ordered differently than the default, and if you override
78
+	 *                               which fields are shown
79
+	 * @type        $exclude         string[] values are subsections to be excluded. This is handy if you want
80
+	 *                               to remove certain default subsections (note: if you specify BOTH 'include' AND
81
+	 *                               'exclude', the inclusions will be applied first, and the exclusions will exclude
82
+	 *                               items from that list of inclusions)
83
+	 * @type        $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
84
+	 *                               } @see EE_Form_Section_Validatable::__construct()
85
+	 * @throws \EE_Error
86
+	 */
87
+	public function __construct($options_array = array())
88
+	{
89
+		$options_array = (array)apply_filters('FHEE__EE_Form_Section_Proper___construct__options_array', $options_array,
90
+			$this);
91
+		//call parent first, as it may be setting the name
92
+		parent::__construct($options_array);
93
+		//if they've included subsections in the constructor, add them now
94
+		if (isset($options_array['include'])) {
95
+			//we are going to make sure we ONLY have those subsections to include
96
+			//AND we are going to make sure they're in that specified order
97
+			$reordered_subsections = array();
98
+			foreach ($options_array['include'] as $input_name) {
99
+				if (isset($this->_subsections[$input_name])) {
100
+					$reordered_subsections[$input_name] = $this->_subsections[$input_name];
101
+				}
102
+			}
103
+			$this->_subsections = $reordered_subsections;
104
+		}
105
+		if (isset($options_array['exclude'])) {
106
+			$exclude = $options_array['exclude'];
107
+			$this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
108
+		}
109
+		if (isset($options_array['layout_strategy'])) {
110
+			$this->_layout_strategy = $options_array['layout_strategy'];
111
+		}
112
+		if ( ! $this->_layout_strategy) {
113
+			$this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
114
+		}
115
+		$this->_layout_strategy->_construct_finalize($this);
116
+		//ok so we are definitely going to want the forms JS,
117
+		//so enqueue it or remember to enqueue it during wp_enqueue_scripts
118
+		if (did_action('wp_enqueue_scripts')
119
+			|| did_action('admin_enqueue_scripts')
120
+		) {
121
+			//ok so they've constructed this object after when they should have.
122
+			//just enqueue the generic form scripts and initialize the form immediately in the JS
123
+			\EE_Form_Section_Proper::wp_enqueue_scripts(true);
124
+		} else {
125
+			add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
126
+			add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
127
+		}
128
+		add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
129
+		if (isset($options_array['name'])) {
130
+			$this->_construct_finalize(null, $options_array['name']);
131
+		}
132
+	}
133
+
134
+
135
+
136
+	/**
137
+	 * Finishes construction given the parent form section and this form section's name
138
+	 *
139
+	 * @param EE_Form_Section_Proper $parent_form_section
140
+	 * @param string                 $name
141
+	 * @throws \EE_Error
142
+	 */
143
+	public function _construct_finalize($parent_form_section, $name)
144
+	{
145
+		parent::_construct_finalize($parent_form_section, $name);
146
+		$this->_set_default_name_if_empty();
147
+		$this->_set_default_html_id_if_empty();
148
+		foreach ($this->_subsections as $subsection_name => $subsection) {
149
+			if ($subsection instanceof EE_Form_Section_Base) {
150
+				$subsection->_construct_finalize($this, $subsection_name);
151
+			} else {
152
+				throw new EE_Error(
153
+					sprintf(
154
+						__('Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
155
+							'event_espresso'),
156
+						$subsection_name,
157
+						get_class($this),
158
+						$subsection ? get_class($subsection) : __('NULL', 'event_espresso')
159
+					)
160
+				);
161
+			}
162
+		}
163
+		do_action('AHEE__EE_Form_Section_Proper___construct_finalize__end', $this, $parent_form_section, $name);
164
+	}
165
+
166
+
167
+
168
+	/**
169
+	 * Gets the layout strategy for this form section
170
+	 *
171
+	 * @return EE_Form_Section_Layout_Base
172
+	 */
173
+	public function get_layout_strategy()
174
+	{
175
+		return $this->_layout_strategy;
176
+	}
177
+
178
+
179
+
180
+	/**
181
+	 * Gets the HTML for a single input for this form section according
182
+	 * to the layout strategy
183
+	 *
184
+	 * @param EE_Form_Input_Base $input
185
+	 * @return string
186
+	 */
187
+	public function get_html_for_input($input)
188
+	{
189
+		return $this->_layout_strategy->layout_input($input);
190
+	}
191
+
192
+
193
+
194
+	/**
195
+	 * was_submitted - checks if form inputs are present in request data
196
+	 * Basically an alias for form_data_present_in() (which is used by both
197
+	 * proper form sections and form inputs)
198
+	 *
199
+	 * @param null $form_data
200
+	 * @return boolean
201
+	 */
202
+	public function was_submitted($form_data = null)
203
+	{
204
+		return $this->form_data_present_in($form_data);
205
+	}
206
+
207
+
208
+
209
+	/**
210
+	 * After the form section is initially created, call this to sanitize the data in the submission
211
+	 * which relates to this form section, validate it, and set it as properties on the form.
212
+	 *
213
+	 * @param array|null $req_data should usually be $_POST (the default).
214
+	 *                             However, you CAN supply a different array.
215
+	 *                             Consider using set_defaults() instead however.
216
+	 *                             (If you rendered the form in the page using echo $form_x->get_html()
217
+	 *                             the inputs will have the correct name in the request data for this function
218
+	 *                             to find them and populate the form with them.
219
+	 *                             If you have a flat form (with only input subsections),
220
+	 *                             you can supply a flat array where keys
221
+	 *                             are the form input names and values are their values)
222
+	 * @param boolean    $validate whether or not to perform validation on this data. Default is,
223
+	 *                             of course, to validate that data, and set errors on the invalid values.
224
+	 *                             But if the data has already been validated
225
+	 *                             (eg you validated the data then stored it in the DB)
226
+	 *                             you may want to skip this step.
227
+	 */
228
+	public function receive_form_submission($req_data = null, $validate = true)
229
+	{
230
+		$req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', $req_data, $this,
231
+			$validate);
232
+		if ($req_data === null) {
233
+			$req_data = array_merge($_GET, $_POST);
234
+		}
235
+		$req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__request_data', $req_data,
236
+			$this);
237
+		$this->_normalize($req_data);
238
+		if ($validate) {
239
+			$this->_validate();
240
+			//if it's invalid, we're going to want to re-display so remember what they submitted
241
+			if ( ! $this->is_valid()) {
242
+				$this->store_submitted_form_data_in_session();
243
+			}
244
+		}
245
+		do_action('AHEE__EE_Form_Section_Proper__receive_form_submission__end', $req_data, $this, $validate);
246
+	}
247
+
248
+
249
+
250
+	/**
251
+	 * caches the originally submitted input values in the session
252
+	 * so that they can be used to repopulate the form if it failed validation
253
+	 *
254
+	 * @return boolean whether or not the data was successfully stored in the session
255
+	 */
256
+	protected function store_submitted_form_data_in_session()
257
+	{
258
+		return EE_Registry::instance()->SSN->set_session_data(
259
+			array(
260
+				\EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
261
+			)
262
+		);
263
+	}
264
+
265
+
266
+
267
+	/**
268
+	 * retrieves the originally submitted input values in the session
269
+	 * so that they can be used to repopulate the form if it failed validation
270
+	 *
271
+	 * @return array
272
+	 */
273
+	protected function get_submitted_form_data_from_session()
274
+	{
275
+		$session = EE_Registry::instance()->SSN;
276
+		if ($session instanceof EE_Session) {
277
+			return $session->get_session_data(
278
+				\EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
279
+			);
280
+		} else {
281
+			return array();
282
+		}
283
+	}
284
+
285
+
286
+
287
+	/**
288
+	 * flushed the originally submitted input values from the session
289
+	 *
290
+	 * @return boolean whether or not the data was successfully removed from the session
291
+	 */
292
+	protected function flush_submitted_form_data_from_session()
293
+	{
294
+		return EE_Registry::instance()->SSN->reset_data(
295
+			array(\EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
296
+		);
297
+	}
298
+
299
+
300
+
301
+	/**
302
+	 * Populates this form and its subsections with data from the session.
303
+	 * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
304
+	 * validation errors when displaying too)
305
+	 * Returns true if the form was populated from the session, false otherwise
306
+	 *
307
+	 * @return boolean
308
+	 */
309
+	public function populate_from_session()
310
+	{
311
+		$form_data_in_session = $this->get_submitted_form_data_from_session();
312
+		if (empty($form_data_in_session)) {
313
+			return false;
314
+		}
315
+		$this->receive_form_submission($form_data_in_session);
316
+		$this->flush_submitted_form_data_from_session();
317
+		if ($this->form_data_present_in($form_data_in_session)) {
318
+			return true;
319
+		} else {
320
+			return false;
321
+		}
322
+	}
323
+
324
+
325
+
326
+	/**
327
+	 * Populates the default data for the form, given an array where keys are
328
+	 * the input names, and values are their values (preferably normalized to be their
329
+	 * proper PHP types, not all strings... although that should be ok too).
330
+	 * Proper subsections are sub-arrays, the key being the subsection's name, and
331
+	 * the value being an array formatted in teh same way
332
+	 *
333
+	 * @param array $default_data
334
+	 */
335
+	public function populate_defaults($default_data)
336
+	{
337
+		foreach ($this->subsections() as $subsection_name => $subsection) {
338
+			if (isset($default_data[$subsection_name])) {
339
+				if ($subsection instanceof EE_Form_Input_Base) {
340
+					$subsection->set_default($default_data[$subsection_name]);
341
+				} elseif ($subsection instanceof EE_Form_Section_Proper) {
342
+					$subsection->populate_defaults($default_data[$subsection_name]);
343
+				}
344
+			}
345
+		}
346
+	}
347
+
348
+
349
+
350
+	/**
351
+	 * returns true if subsection exists
352
+	 *
353
+	 * @param string $name
354
+	 * @return boolean
355
+	 */
356
+	public function subsection_exists($name)
357
+	{
358
+		return isset($this->_subsections[$name]) ? true : false;
359
+	}
360
+
361
+
362
+
363
+	/**
364
+	 * Gets the subsection specified by its name
365
+	 *
366
+	 * @param string  $name
367
+	 * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
368
+	 *                                                      so that the inputs will be properly configured.
369
+	 *                                                      However, some client code may be ok
370
+	 *                                                      with construction finalize being called later
371
+	 *                                                      (realizing that the subsections' html names
372
+	 *                                                      might not be set yet, etc.)
373
+	 * @return EE_Form_Section_Base
374
+	 * @throws \EE_Error
375
+	 */
376
+	public function get_subsection($name, $require_construction_to_be_finalized = true)
377
+	{
378
+		if ($require_construction_to_be_finalized) {
379
+			$this->ensure_construct_finalized_called();
380
+		}
381
+		return $this->subsection_exists($name) ? $this->_subsections[$name] : null;
382
+	}
383
+
384
+
385
+
386
+	/**
387
+	 * Gets all the validatable subsections of this form section
388
+	 *
389
+	 * @return EE_Form_Section_Validatable[]
390
+	 */
391
+	public function get_validatable_subsections()
392
+	{
393
+		$validatable_subsections = array();
394
+		foreach ($this->subsections() as $name => $obj) {
395
+			if ($obj instanceof EE_Form_Section_Validatable) {
396
+				$validatable_subsections[$name] = $obj;
397
+			}
398
+		}
399
+		return $validatable_subsections;
400
+	}
401
+
402
+
403
+
404
+	/**
405
+	 * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
406
+	 * throw an EE_Error.
407
+	 *
408
+	 * @param string  $name
409
+	 * @param boolean $require_construction_to_be_finalized most client code should
410
+	 *                                                      leave this as TRUE so that the inputs will be properly
411
+	 *                                                      configured. However, some client code may be ok with
412
+	 *                                                      construction finalize being called later
413
+	 *                                                      (realizing that the subsections' html names might not be
414
+	 *                                                      set yet, etc.)
415
+	 * @return EE_Form_Input_Base
416
+	 * @throws EE_Error
417
+	 */
418
+	public function get_input($name, $require_construction_to_be_finalized = true)
419
+	{
420
+		$subsection = $this->get_subsection($name, $require_construction_to_be_finalized);
421
+		if ( ! $subsection instanceof EE_Form_Input_Base) {
422
+			throw new EE_Error(
423
+				sprintf(
424
+					__(
425
+						"Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
426
+						'event_espresso'
427
+					),
428
+					$name,
429
+					get_class($this),
430
+					$subsection ? get_class($subsection) : __("NULL", 'event_espresso')
431
+				)
432
+			);
433
+		}
434
+		return $subsection;
435
+	}
436
+
437
+
438
+
439
+	/**
440
+	 * Like get_input(), gets the proper subsection of the form given the name,
441
+	 * otherwise throws an EE_Error
442
+	 *
443
+	 * @param string  $name
444
+	 * @param boolean $require_construction_to_be_finalized most client code should
445
+	 *                                                      leave this as TRUE so that the inputs will be properly
446
+	 *                                                      configured. However, some client code may be ok with
447
+	 *                                                      construction finalize being called later
448
+	 *                                                      (realizing that the subsections' html names might not be
449
+	 *                                                      set yet, etc.)
450
+	 * @return EE_Form_Section_Proper
451
+	 * @throws EE_Error
452
+	 */
453
+	public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
454
+	{
455
+		$subsection = $this->get_subsection($name, $require_construction_to_be_finalized);
456
+		if ( ! $subsection instanceof EE_Form_Section_Proper) {
457
+			throw new EE_Error(
458
+				sprintf(
459
+					__("Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'", 'event_espresso'),
460
+					$name,
461
+					get_class($this)
462
+				)
463
+			);
464
+		}
465
+		return $subsection;
466
+	}
467
+
468
+
469
+
470
+	/**
471
+	 * Gets the value of the specified input. Should be called after receive_form_submission()
472
+	 * or populate_defaults() on the form, where the normalized value on the input is set.
473
+	 *
474
+	 * @param string $name
475
+	 * @return mixed depending on the input's type and its normalization strategy
476
+	 * @throws \EE_Error
477
+	 */
478
+	public function get_input_value($name)
479
+	{
480
+		$input = $this->get_input($name);
481
+		return $input->normalized_value();
482
+	}
483
+
484
+
485
+
486
+	/**
487
+	 * Checks if this form section itself is valid, and then checks its subsections
488
+	 *
489
+	 * @throws EE_Error
490
+	 * @return boolean
491
+	 */
492
+	public function is_valid()
493
+	{
494
+		if ( ! $this->has_received_submission()) {
495
+			throw new EE_Error(
496
+				sprintf(
497
+					__(
498
+						"You cannot check if a form is valid before receiving the form submission using receive_form_submission",
499
+						"event_espresso"
500
+					)
501
+				)
502
+			);
503
+		}
504
+		if ( ! parent::is_valid()) {
505
+			return false;
506
+		}
507
+		// ok so no general errors to this entire form section.
508
+		// so let's check the subsections, but only set errors if that hasn't been done yet
509
+		$set_submission_errors = $this->submission_error_message() === '' ? true : false;
510
+		foreach ($this->get_validatable_subsections() as $subsection) {
511
+			if ( ! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') {
512
+				if ($set_submission_errors) {
513
+					$this->set_submission_error_message($subsection->get_validation_error_string());
514
+				}
515
+				return false;
516
+			}
517
+		}
518
+		return true;
519
+	}
520
+
521
+
522
+
523
+	/**
524
+	 * gets teh default name of this form section if none is specified
525
+	 *
526
+	 * @return string
527
+	 */
528
+	protected function _set_default_name_if_empty()
529
+	{
530
+		if ( ! $this->_name) {
531
+			$classname = get_class($this);
532
+			$default_name = str_replace("EE_", "", $classname);
533
+			$this->_name = $default_name;
534
+		}
535
+	}
536
+
537
+
538
+
539
+	/**
540
+	 * Returns the HTML for the form, except for the form opening and closing tags
541
+	 * (as the form section doesn't know where you necessarily want to send the information to),
542
+	 * and except for a submit button. Enqueus JS and CSS; if called early enough we will
543
+	 * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
544
+	 * Not doing_it_wrong because theoretically this CAN be used properly,
545
+	 * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
546
+	 * any CSS.
547
+	 *
548
+	 * @throws \EE_Error
549
+	 */
550
+	public function get_html_and_js()
551
+	{
552
+		$this->enqueue_js();
553
+		return $this->get_html();
554
+	}
555
+
556
+
557
+
558
+	/**
559
+	 * returns HTML for displaying this form section. recursively calls display_section() on all subsections
560
+	 *
561
+	 * @param bool $display_previously_submitted_data
562
+	 * @return string
563
+	 */
564
+	public function get_html($display_previously_submitted_data = true)
565
+	{
566
+		$this->ensure_construct_finalized_called();
567
+		if ($display_previously_submitted_data) {
568
+			$this->populate_from_session();
569
+		}
570
+		return $this->_layout_strategy->layout_form();
571
+	}
572
+
573
+
574
+
575
+	/**
576
+	 * enqueues JS and CSS for the form.
577
+	 * It is preferred to call this before wp_enqueue_scripts so the
578
+	 * scripts and styles can be put in the header, but if called later
579
+	 * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
580
+	 * only be in the header; but in HTML5 its ok in the body.
581
+	 * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
582
+	 * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
583
+	 *
584
+	 * @return string
585
+	 * @throws \EE_Error
586
+	 */
587
+	public function enqueue_js()
588
+	{
589
+		$this->_enqueue_and_localize_form_js();
590
+		foreach ($this->subsections() as $subsection) {
591
+			$subsection->enqueue_js();
592
+		}
593
+	}
594
+
595
+
596
+
597
+	/**
598
+	 * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
599
+	 * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
600
+	 * the wp_enqueue_scripts hook.
601
+	 * However, registering the form js and localizing it can happen when we
602
+	 * actually output the form (which is preferred, seeing how teh form's fields
603
+	 * could change until it's actually outputted)
604
+	 *
605
+	 * @param boolean $init_form_validation_automatically whether or not we want the form validation
606
+	 *                                                    to be triggered automatically or not
607
+	 * @return void
608
+	 */
609
+	public static function wp_enqueue_scripts($init_form_validation_automatically = true)
610
+	{
611
+		add_filter('FHEE_load_jquery_validate', '__return_true');
612
+		wp_register_script(
613
+			'ee_form_section_validation',
614
+			EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
615
+			array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
616
+			EVENT_ESPRESSO_VERSION,
617
+			true
618
+		);
619
+		wp_localize_script(
620
+			'ee_form_section_validation',
621
+			'ee_form_section_validation_init',
622
+			array('init' => $init_form_validation_automatically ? true : false)
623
+		);
624
+	}
625
+
626
+
627
+
628
+	/**
629
+	 * gets the variables used by form_section_validation.js.
630
+	 * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
631
+	 * but before the wordpress hook wp_loaded
632
+	 *
633
+	 * @throws \EE_Error
634
+	 */
635
+	public function _enqueue_and_localize_form_js()
636
+	{
637
+		$this->ensure_construct_finalized_called();
638
+		//actually, we don't want to localize just yet. There may be other forms on the page.
639
+		//so we need to add our form section data to a static variable accessible by all form sections
640
+		//and localize it just before the footer
641
+		$this->localize_validation_rules();
642
+		add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
643
+		add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
644
+	}
645
+
646
+
647
+
648
+	/**
649
+	 * add our form section data to a static variable accessible by all form sections
650
+	 *
651
+	 * @param bool $return_for_subsection
652
+	 * @return void
653
+	 * @throws \EE_Error
654
+	 */
655
+	public function localize_validation_rules($return_for_subsection = false)
656
+	{
657
+		// we only want to localize vars ONCE for the entire form,
658
+		// so if the form section doesn't have a parent, then it must be the top dog
659
+		if ($return_for_subsection || ! $this->parent_section()) {
660
+			EE_Form_Section_Proper::$_js_localization['form_data'][$this->html_id()] = array(
661
+				'form_section_id'  => $this->html_id(true),
662
+				'validation_rules' => $this->get_jquery_validation_rules(),
663
+				'other_data'       => $this->get_other_js_data(),
664
+				'errors'           => $this->subsection_validation_errors_by_html_name(),
665
+			);
666
+			EE_Form_Section_Proper::$_scripts_localized = true;
667
+		}
668
+	}
669
+
670
+
671
+
672
+	/**
673
+	 * Gets an array of extra data that will be useful for client-side javascript.
674
+	 * This is primarily data added by inputs and forms in addition to any
675
+	 * scripts they might enqueue
676
+	 *
677
+	 * @param array $form_other_js_data
678
+	 * @return array
679
+	 */
680
+	public function get_other_js_data($form_other_js_data = array())
681
+	{
682
+		foreach ($this->subsections() as $subsection) {
683
+			$form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
684
+		}
685
+		return $form_other_js_data;
686
+	}
687
+
688
+
689
+
690
+	/**
691
+	 * Gets a flat array of inputs for this form section and its subsections.
692
+	 * Keys are their form names, and values are the inputs themselves
693
+	 *
694
+	 * @return EE_Form_Input_Base
695
+	 */
696
+	public function inputs_in_subsections()
697
+	{
698
+		$inputs = array();
699
+		foreach ($this->subsections() as $subsection) {
700
+			if ($subsection instanceof EE_Form_Input_Base) {
701
+				$inputs[$subsection->html_name()] = $subsection;
702
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
703
+				$inputs += $subsection->inputs_in_subsections();
704
+			}
705
+		}
706
+		return $inputs;
707
+	}
708
+
709
+
710
+
711
+	/**
712
+	 * Gets a flat array of all the validation errors.
713
+	 * Keys are html names (because those should be unique)
714
+	 * and values are a string of all their validation errors
715
+	 *
716
+	 * @return string[]
717
+	 */
718
+	public function subsection_validation_errors_by_html_name()
719
+	{
720
+		$inputs = $this->inputs();
721
+		$errors = array();
722
+		foreach ($inputs as $form_input) {
723
+			if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
724
+				$errors[$form_input->html_name()] = $form_input->get_validation_error_string();
725
+			}
726
+		}
727
+		return $errors;
728
+	}
729
+
730
+
731
+
732
+	/**
733
+	 * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
734
+	 * Should be setup by each form during the _enqueues_and_localize_form_js
735
+	 */
736
+	public static function localize_script_for_all_forms()
737
+	{
738
+		//allow inputs and stuff to hook in their JS and stuff here
739
+		do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
740
+		EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
741
+		$email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
742
+			? EE_Registry::instance()->CFG->registration->email_validation_level
743
+			: 'wp_default';
744
+		EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level;
745
+		wp_enqueue_script('ee_form_section_validation');
746
+		wp_localize_script(
747
+			'ee_form_section_validation',
748
+			'ee_form_section_vars',
749
+			EE_Form_Section_Proper::$_js_localization
750
+		);
751
+	}
752
+
753
+
754
+
755
+	/**
756
+	 * ensure_scripts_localized
757
+	 */
758
+	public function ensure_scripts_localized()
759
+	{
760
+		if ( ! EE_Form_Section_Proper::$_scripts_localized) {
761
+			$this->_enqueue_and_localize_form_js();
762
+		}
763
+	}
764
+
765
+
766
+
767
+	/**
768
+	 * Gets the hard-coded validation error messages to be used in the JS. The convention
769
+	 * is that the key here should be the same as the custom validation rule put in the JS file
770
+	 *
771
+	 * @return array keys are custom validation rules, and values are internationalized strings
772
+	 */
773
+	private static function _get_localized_error_messages()
774
+	{
775
+		return array(
776
+			'validUrl' => __("This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg", "event_espresso"),
777
+			'regex'    => __('Please check your input', 'event_espresso'),
778
+		);
779
+	}
780
+
781
+
782
+
783
+	/**
784
+	 * @return array
785
+	 */
786
+	public static function js_localization()
787
+	{
788
+		return self::$_js_localization;
789
+	}
790
+
791
+
792
+
793
+	/**
794
+	 * @return array
795
+	 */
796
+	public static function reset_js_localization()
797
+	{
798
+		self::$_js_localization = array();
799
+	}
800
+
801
+
802
+
803
+	/**
804
+	 * Gets the JS to put inside the jquery validation rules for subsection of this form section.
805
+	 * See parent function for more...
806
+	 *
807
+	 * @return array
808
+	 */
809
+	public function get_jquery_validation_rules()
810
+	{
811
+		$jquery_validation_rules = array();
812
+		foreach ($this->get_validatable_subsections() as $subsection) {
813
+			$jquery_validation_rules = array_merge(
814
+				$jquery_validation_rules,
815
+				$subsection->get_jquery_validation_rules()
816
+			);
817
+		}
818
+		return $jquery_validation_rules;
819
+	}
820
+
821
+
822
+
823
+	/**
824
+	 * Sanitizes all the data and sets the sanitized value of each field
825
+	 *
826
+	 * @param array $req_data like $_POST
827
+	 * @return void
828
+	 */
829
+	protected function _normalize($req_data)
830
+	{
831
+		$this->_received_submission = true;
832
+		$this->_validation_errors = array();
833
+		foreach ($this->get_validatable_subsections() as $subsection) {
834
+			try {
835
+				$subsection->_normalize($req_data);
836
+			} catch (EE_Validation_Error $e) {
837
+				$subsection->add_validation_error($e);
838
+			}
839
+		}
840
+	}
841
+
842
+
843
+
844
+	/**
845
+	 * Performs validation on this form section and its subsections.
846
+	 * For each subsection,
847
+	 * calls _validate_{subsection_name} on THIS form (if the function exists)
848
+	 * and passes it the subsection, then calls _validate on that subsection.
849
+	 * If you need to perform validation on the form as a whole (considering multiple)
850
+	 * you would be best to override this _validate method,
851
+	 * calling parent::_validate() first.
852
+	 */
853
+	protected function _validate()
854
+	{
855
+		foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
856
+			if (method_exists($this, '_validate_' . $subsection_name)) {
857
+				call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
858
+			}
859
+			$subsection->_validate();
860
+		}
861
+	}
862
+
863
+
864
+
865
+	/**
866
+	 * Gets all the validated inputs for the form section
867
+	 *
868
+	 * @return array
869
+	 */
870
+	public function valid_data()
871
+	{
872
+		$inputs = array();
873
+		foreach ($this->subsections() as $subsection_name => $subsection) {
874
+			if ($subsection instanceof EE_Form_Section_Proper) {
875
+				$inputs[$subsection_name] = $subsection->valid_data();
876
+			} else if ($subsection instanceof EE_Form_Input_Base) {
877
+				$inputs[$subsection_name] = $subsection->normalized_value();
878
+			}
879
+		}
880
+		return $inputs;
881
+	}
882
+
883
+
884
+
885
+	/**
886
+	 * Gets all the inputs on this form section
887
+	 *
888
+	 * @return EE_Form_Input_Base[]
889
+	 */
890
+	public function inputs()
891
+	{
892
+		$inputs = array();
893
+		foreach ($this->subsections() as $subsection_name => $subsection) {
894
+			if ($subsection instanceof EE_Form_Input_Base) {
895
+				$inputs[$subsection_name] = $subsection;
896
+			}
897
+		}
898
+		return $inputs;
899
+	}
900
+
901
+
902
+
903
+	/**
904
+	 * Gets all the subsections which are a proper form
905
+	 *
906
+	 * @return EE_Form_Section_Proper[]
907
+	 */
908
+	public function subforms()
909
+	{
910
+		$form_sections = array();
911
+		foreach ($this->subsections() as $name => $obj) {
912
+			if ($obj instanceof EE_Form_Section_Proper) {
913
+				$form_sections[$name] = $obj;
914
+			}
915
+		}
916
+		return $form_sections;
917
+	}
918
+
919
+
920
+
921
+	/**
922
+	 * Gets all the subsections (inputs, proper subsections, or html-only sections).
923
+	 * Consider using inputs() or subforms()
924
+	 * if you only want form inputs or proper form sections.
925
+	 *
926
+	 * @return EE_Form_Section_Proper[]
927
+	 */
928
+	public function subsections()
929
+	{
930
+		$this->ensure_construct_finalized_called();
931
+		return $this->_subsections;
932
+	}
933
+
934
+
935
+
936
+	/**
937
+	 * Returns a simple array where keys are input names, and values are their normalized
938
+	 * values. (Similar to calling get_input_value on inputs)
939
+	 *
940
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
941
+	 *                                        or just this forms' direct children inputs
942
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
943
+	 *                                        or allow multidimensional array
944
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
945
+	 *                                        with array keys being input names
946
+	 *                                        (regardless of whether they are from a subsection or not),
947
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
948
+	 *                                        where keys are always subsection names and values are either
949
+	 *                                        the input's normalized value, or an array like the top-level array
950
+	 */
951
+	public function input_values($include_subform_inputs = false, $flatten = false)
952
+	{
953
+		return $this->_input_values(false, $include_subform_inputs, $flatten);
954
+	}
955
+
956
+
957
+
958
+	/**
959
+	 * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
960
+	 * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
961
+	 * is not necessarily the value we want to display to users. This creates an array
962
+	 * where keys are the input names, and values are their display values
963
+	 *
964
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
965
+	 *                                        or just this forms' direct children inputs
966
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
967
+	 *                                        or allow multidimensional array
968
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
969
+	 *                                        with array keys being input names
970
+	 *                                        (regardless of whether they are from a subsection or not),
971
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
972
+	 *                                        where keys are always subsection names and values are either
973
+	 *                                        the input's normalized value, or an array like the top-level array
974
+	 */
975
+	public function input_pretty_values($include_subform_inputs = false, $flatten = false)
976
+	{
977
+		return $this->_input_values(true, $include_subform_inputs, $flatten);
978
+	}
979
+
980
+
981
+
982
+	/**
983
+	 * Gets the input values from the form
984
+	 *
985
+	 * @param boolean $pretty                 Whether to retrieve the pretty value,
986
+	 *                                        or just the normalized value
987
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
988
+	 *                                        or just this forms' direct children inputs
989
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
990
+	 *                                        or allow multidimensional array
991
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
992
+	 *                                        input names (regardless of whether they are from a subsection or not),
993
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
994
+	 *                                        where keys are always subsection names and values are either
995
+	 *                                        the input's normalized value, or an array like the top-level array
996
+	 */
997
+	public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
998
+	{
999
+		$input_values = array();
1000
+		foreach ($this->subsections() as $subsection_name => $subsection) {
1001
+			if ($subsection instanceof EE_Form_Input_Base) {
1002
+				$input_values[$subsection_name] = $pretty
1003
+					? $subsection->pretty_value()
1004
+					: $subsection->normalized_value();
1005
+			} else if ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
1006
+				$subform_input_values = $subsection->_input_values($pretty, $include_subform_inputs, $flatten);
1007
+				if ($flatten) {
1008
+					$input_values = array_merge($input_values, $subform_input_values);
1009
+				} else {
1010
+					$input_values[$subsection_name] = $subform_input_values;
1011
+				}
1012
+			}
1013
+		}
1014
+		return $input_values;
1015
+	}
1016
+
1017
+
1018
+
1019
+	/**
1020
+	 * Gets the originally submitted input values from the form
1021
+	 *
1022
+	 * @param boolean $include_subforms  Whether to include inputs from subforms,
1023
+	 *                                   or just this forms' direct children inputs
1024
+	 * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
1025
+	 *                                   with array keys being input names
1026
+	 *                                   (regardless of whether they are from a subsection or not),
1027
+	 *                                   and if $flatten is FALSE it can be a multidimensional array
1028
+	 *                                   where keys are always subsection names and values are either
1029
+	 *                                   the input's normalized value, or an array like the top-level array
1030
+	 */
1031
+	public function submitted_values($include_subforms = false)
1032
+	{
1033
+		$submitted_values = array();
1034
+		foreach ($this->subsections() as $subsection) {
1035
+			if ($subsection instanceof EE_Form_Input_Base) {
1036
+				// is this input part of an array of inputs?
1037
+				if (strpos($subsection->html_name(), '[') !== false) {
1038
+					$full_input_name = \EEH_Array::convert_array_values_to_keys(
1039
+						explode('[', str_replace(']', '', $subsection->html_name())),
1040
+						$subsection->raw_value()
1041
+					);
1042
+					$submitted_values = array_replace_recursive($submitted_values, $full_input_name);
1043
+				} else {
1044
+					$submitted_values[$subsection->html_name()] = $subsection->raw_value();
1045
+				}
1046
+			} else if ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
1047
+				$subform_input_values = $subsection->submitted_values($include_subforms);
1048
+				$submitted_values = array_replace_recursive($submitted_values, $subform_input_values);
1049
+			}
1050
+		}
1051
+		return $submitted_values;
1052
+	}
1053
+
1054
+
1055
+
1056
+	/**
1057
+	 * Indicates whether or not this form has received a submission yet
1058
+	 * (ie, had receive_form_submission called on it yet)
1059
+	 *
1060
+	 * @return boolean
1061
+	 * @throws \EE_Error
1062
+	 */
1063
+	public function has_received_submission()
1064
+	{
1065
+		$this->ensure_construct_finalized_called();
1066
+		return $this->_received_submission;
1067
+	}
1068
+
1069
+
1070
+
1071
+	/**
1072
+	 * Equivalent to passing 'exclude' in the constructor's options array.
1073
+	 * Removes the listed inputs from the form
1074
+	 *
1075
+	 * @param array $inputs_to_exclude values are the input names
1076
+	 * @return void
1077
+	 */
1078
+	public function exclude($inputs_to_exclude = array())
1079
+	{
1080
+		foreach ($inputs_to_exclude as $input_to_exclude_name) {
1081
+			unset($this->_subsections[$input_to_exclude_name]);
1082
+		}
1083
+	}
1084
+
1085
+
1086
+
1087
+	/**
1088
+	 * @param array $inputs_to_hide
1089
+	 * @throws \EE_Error
1090
+	 */
1091
+	public function hide($inputs_to_hide = array())
1092
+	{
1093
+		foreach ($inputs_to_hide as $input_to_hide) {
1094
+			$input = $this->get_input($input_to_hide);
1095
+			$input->set_display_strategy(new EE_Hidden_Display_Strategy());
1096
+		}
1097
+	}
1098
+
1099
+
1100
+
1101
+	/**
1102
+	 * add_subsections
1103
+	 * Adds the listed subsections to the form section.
1104
+	 * If $subsection_name_to_target is provided,
1105
+	 * then new subsections are added before or after that subsection,
1106
+	 * otherwise to the start or end of the entire subsections array.
1107
+	 *
1108
+	 * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
1109
+	 *                                                          where keys are their names
1110
+	 * @param string                 $subsection_name_to_target an existing for section that $new_subsections
1111
+	 *                                                          should be added before or after
1112
+	 *                                                          IF $subsection_name_to_target is null,
1113
+	 *                                                          then $new_subsections will be added to
1114
+	 *                                                          the beginning or end of the entire subsections array
1115
+	 * @param boolean                $add_before                whether to add $new_subsections, before or after
1116
+	 *                                                          $subsection_name_to_target,
1117
+	 *                                                          or if $subsection_name_to_target is null,
1118
+	 *                                                          before or after entire subsections array
1119
+	 * @return void
1120
+	 * @throws \EE_Error
1121
+	 */
1122
+	public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
1123
+	{
1124
+		foreach ($new_subsections as $subsection_name => $subsection) {
1125
+			if ( ! $subsection instanceof EE_Form_Section_Base) {
1126
+				EE_Error::add_error(
1127
+					sprintf(
1128
+						__(
1129
+							"Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
1130
+							"event_espresso"
1131
+						),
1132
+						get_class($subsection),
1133
+						$subsection_name,
1134
+						$this->name()
1135
+					)
1136
+				);
1137
+				unset($new_subsections[$subsection_name]);
1138
+			}
1139
+		}
1140
+		$this->_subsections = EEH_Array::insert_into_array(
1141
+			$this->_subsections,
1142
+			$new_subsections,
1143
+			$subsection_name_to_target,
1144
+			$add_before
1145
+		);
1146
+		if ($this->_construction_finalized) {
1147
+			foreach ($this->_subsections as $name => $subsection) {
1148
+				$subsection->_construct_finalize($this, $name);
1149
+			}
1150
+		}
1151
+	}
1152
+
1153
+
1154
+
1155
+	/**
1156
+	 * Just gets all validatable subsections to clean their sensitive data
1157
+	 */
1158
+	public function clean_sensitive_data()
1159
+	{
1160
+		foreach ($this->get_validatable_subsections() as $subsection) {
1161
+			$subsection->clean_sensitive_data();
1162
+		}
1163
+	}
1164
+
1165
+
1166
+
1167
+	/**
1168
+	 * @param string $form_submission_error_message
1169
+	 */
1170
+	public function set_submission_error_message($form_submission_error_message = '')
1171
+	{
1172
+		$this->_form_submission_error_message .= ! empty($form_submission_error_message)
1173
+			? $form_submission_error_message
1174
+			: __('Form submission failed due to errors', 'event_espresso');
1175
+	}
1176
+
1177
+
1178
+
1179
+	/**
1180
+	 * @return string
1181
+	 */
1182
+	public function submission_error_message()
1183
+	{
1184
+		return $this->_form_submission_error_message;
1185
+	}
1186
+
1187
+
1188
+
1189
+	/**
1190
+	 * @param string $form_submission_success_message
1191
+	 */
1192
+	public function set_submission_success_message($form_submission_success_message)
1193
+	{
1194
+		$this->_form_submission_success_message .= ! empty($form_submission_success_message)
1195
+			? $form_submission_success_message
1196
+			: __('Form submitted successfully', 'event_espresso');
1197
+	}
1198
+
1199
+
1200
+
1201
+	/**
1202
+	 * @return string
1203
+	 */
1204
+	public function submission_success_message()
1205
+	{
1206
+		return $this->_form_submission_success_message;
1207
+	}
1208
+
1209
+
1210
+
1211
+	/**
1212
+	 * Returns the prefix that should be used on child of this form section for
1213
+	 * their html names. If this form section itself has a parent, prepends ITS
1214
+	 * prefix onto this form section's prefix. Used primarily by
1215
+	 * EE_Form_Input_Base::_set_default_html_name_if_empty
1216
+	 *
1217
+	 * @return string
1218
+	 * @throws \EE_Error
1219
+	 */
1220
+	public function html_name_prefix()
1221
+	{
1222
+		if ($this->parent_section() instanceof EE_Form_Section_Proper) {
1223
+			return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
1224
+		} else {
1225
+			return $this->name();
1226
+		}
1227
+	}
1228
+
1229
+
1230
+
1231
+	/**
1232
+	 * Gets the name, but first checks _construct_finalize has been called. If not,
1233
+	 * calls it (assumes there is no parent and that we want the name to be whatever
1234
+	 * was set, which is probably nothing, or the classname)
1235
+	 *
1236
+	 * @return string
1237
+	 * @throws \EE_Error
1238
+	 */
1239
+	public function name()
1240
+	{
1241
+		$this->ensure_construct_finalized_called();
1242
+		return parent::name();
1243
+	}
1244
+
1245
+
1246
+
1247
+	/**
1248
+	 * @return EE_Form_Section_Proper
1249
+	 * @throws \EE_Error
1250
+	 */
1251
+	public function parent_section()
1252
+	{
1253
+		$this->ensure_construct_finalized_called();
1254
+		return parent::parent_section();
1255
+	}
1256
+
1257
+
1258
+
1259
+	/**
1260
+	 * make sure construction finalized was called, otherwise children might not be ready
1261
+	 *
1262
+	 * @return void
1263
+	 * @throws \EE_Error
1264
+	 */
1265
+	public function ensure_construct_finalized_called()
1266
+	{
1267
+		if ( ! $this->_construction_finalized) {
1268
+			$this->_construct_finalize($this->_parent_section, $this->_name);
1269
+		}
1270
+	}
1271
+
1272
+
1273
+
1274
+	/**
1275
+	 * Checks if any of this form section's inputs, or any of its children's inputs,
1276
+	 * are in teh form data. If any are found, returns true. Else false
1277
+	 *
1278
+	 * @param array $req_data
1279
+	 * @return boolean
1280
+	 */
1281
+	public function form_data_present_in($req_data = null)
1282
+	{
1283
+		if ($req_data === null) {
1284
+			$req_data = $_POST;
1285
+		}
1286
+		foreach ($this->subsections() as $subsection) {
1287
+			if ($subsection instanceof EE_Form_Input_Base) {
1288
+				if ($subsection->form_data_present_in($req_data)) {
1289
+					return true;
1290
+				}
1291
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
1292
+				if ($subsection->form_data_present_in($req_data)) {
1293
+					return true;
1294
+				}
1295
+			}
1296
+		}
1297
+		return false;
1298
+	}
1299
+
1300
+
1301
+
1302
+	/**
1303
+	 * Gets validation errors for this form section and subsections
1304
+	 * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
1305
+	 * gets the validation errors for ALL subsection
1306
+	 *
1307
+	 * @return EE_Validation_Error[]
1308
+	 */
1309
+	public function get_validation_errors_accumulated()
1310
+	{
1311
+		$validation_errors = $this->get_validation_errors();
1312
+		foreach ($this->get_validatable_subsections() as $subsection) {
1313
+			if ($subsection instanceof EE_Form_Section_Proper) {
1314
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
1315
+			} else {
1316
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors();
1317
+			}
1318
+			if ($validation_errors_on_this_subsection) {
1319
+				$validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
1320
+			}
1321
+		}
1322
+		return $validation_errors;
1323
+	}
1324
+
1325
+
1326
+
1327
+	/**
1328
+	 * This isn't just the name of an input, it's a path pointing to an input. The
1329
+	 * path is similar to a folder path: slash (/) means to descend into a subsection,
1330
+	 * dot-dot-slash (../) means to ascend into the parent section.
1331
+	 * After a series of slashes and dot-dot-slashes, there should be the name of an input,
1332
+	 * which will be returned.
1333
+	 * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
1334
+	 * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
1335
+	 * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
1336
+	 * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
1337
+	 * Etc
1338
+	 *
1339
+	 * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
1340
+	 * @return EE_Form_Section_Base
1341
+	 */
1342
+	public function find_section_from_path($form_section_path)
1343
+	{
1344
+		//check if we can find the input from purely going straight up the tree
1345
+		$input = parent::find_section_from_path($form_section_path);
1346
+		if ($input instanceof EE_Form_Section_Base) {
1347
+			return $input;
1348
+		}
1349
+		$next_slash_pos = strpos($form_section_path, '/');
1350
+		if ($next_slash_pos !== false) {
1351
+			$child_section_name = substr($form_section_path, 0, $next_slash_pos);
1352
+			$subpath = substr($form_section_path, $next_slash_pos + 1);
1353
+		} else {
1354
+			$child_section_name = $form_section_path;
1355
+			$subpath = '';
1356
+		}
1357
+		$child_section = $this->get_subsection($child_section_name);
1358
+		if ($child_section instanceof EE_Form_Section_Base) {
1359
+			return $child_section->find_section_from_path($subpath);
1360
+		} else {
1361
+			return null;
1362
+		}
1363
+	}
1364 1364
 
1365 1365
 }
1366 1366
 
Please login to merge, or discard this patch.