@@ -303,7 +303,7 @@ discard block |
||
303 | 303 | * ATT_address column |
304 | 304 | * |
305 | 305 | * @param EE_Attendee $attendee |
306 | - * @return mixed |
|
306 | + * @return string |
|
307 | 307 | * @throws EE_Error |
308 | 308 | */ |
309 | 309 | public function column_ATT_address(EE_Attendee $attendee) |
@@ -316,7 +316,7 @@ discard block |
||
316 | 316 | * ATT_city column |
317 | 317 | * |
318 | 318 | * @param EE_Attendee $attendee |
319 | - * @return mixed |
|
319 | + * @return string |
|
320 | 320 | * @throws EE_Error |
321 | 321 | */ |
322 | 322 | public function column_ATT_city(EE_Attendee $attendee) |
@@ -369,7 +369,7 @@ discard block |
||
369 | 369 | * Phone Number column |
370 | 370 | * |
371 | 371 | * @param EE_Attendee $attendee |
372 | - * @return mixed |
|
372 | + * @return string |
|
373 | 373 | * @throws EE_Error |
374 | 374 | */ |
375 | 375 | public function column_ATT_phone(EE_Attendee $attendee) |
@@ -12,374 +12,374 @@ |
||
12 | 12 | */ |
13 | 13 | class EE_Attendee_Contact_List_Table extends EE_Admin_List_Table |
14 | 14 | { |
15 | - /** |
|
16 | - * Initial setup of data (called by parent). |
|
17 | - */ |
|
18 | - protected function _setup_data() |
|
19 | - { |
|
20 | - $this->_data = $this->_view !== 'trash' |
|
21 | - ? $this->_admin_page->get_attendees($this->_per_page) |
|
22 | - : $this->_admin_page->get_attendees($this->_per_page, false, true); |
|
23 | - $this->_all_data_count = $this->_view !== 'trash' |
|
24 | - ? $this->_admin_page->get_attendees($this->_per_page, true) |
|
25 | - : $this->_admin_page->get_attendees($this->_per_page, true, true); |
|
26 | - } |
|
27 | - |
|
28 | - |
|
29 | - /** |
|
30 | - * Initial setup of properties. |
|
31 | - */ |
|
32 | - protected function _set_properties() |
|
33 | - { |
|
34 | - $this->_wp_list_args = array( |
|
35 | - 'singular' => esc_html__('attendee', 'event_espresso'), |
|
36 | - 'plural' => esc_html__('attendees', 'event_espresso'), |
|
37 | - 'ajax' => true, |
|
38 | - 'screen' => $this->_admin_page->get_current_screen()->id, |
|
39 | - ); |
|
40 | - |
|
41 | - $this->_columns = array( |
|
42 | - 'cb' => '<input type="checkbox" />', // Render a checkbox instead of text |
|
43 | - 'ATT_ID' => esc_html__('ID', 'event_espresso'), |
|
44 | - 'ATT_fname' => esc_html__('First Name', 'event_espresso'), |
|
45 | - 'ATT_lname' => esc_html__('Last Name', 'event_espresso'), |
|
46 | - 'ATT_email' => esc_html__('Email Address', 'event_espresso'), |
|
47 | - 'Registration_Count' => esc_html__('# Registrations', 'event_espresso'), |
|
48 | - 'ATT_phone' => esc_html__('Phone', 'event_espresso'), |
|
49 | - 'ATT_address' => esc_html__('Address', 'event_espresso'), |
|
50 | - 'ATT_city' => esc_html__('City', 'event_espresso'), |
|
51 | - 'STA_ID' => esc_html__('State/Province', 'event_espresso'), |
|
52 | - 'CNT_ISO' => esc_html__('Country', 'event_espresso'), |
|
53 | - ); |
|
54 | - |
|
55 | - $this->_sortable_columns = array( |
|
56 | - 'ATT_ID' => array('ATT_ID' => false), |
|
57 | - 'ATT_lname' => array('ATT_lname' => true), // true means its already sorted |
|
58 | - 'ATT_fname' => array('ATT_fname' => false), |
|
59 | - 'ATT_email' => array('ATT_email' => false), |
|
60 | - 'Registration_Count' => array('Registration_Count' => false), |
|
61 | - 'ATT_city' => array('ATT_city' => false), |
|
62 | - 'STA_ID' => array('STA_ID' => false), |
|
63 | - 'CNT_ISO' => array('CNT_ISO' => false), |
|
64 | - ); |
|
65 | - |
|
66 | - $this->_hidden_columns = array( |
|
67 | - 'ATT_phone', |
|
68 | - 'ATT_address', |
|
69 | - 'ATT_city', |
|
70 | - 'STA_ID', |
|
71 | - 'CNT_ISO', |
|
72 | - ); |
|
73 | - } |
|
74 | - |
|
75 | - |
|
76 | - /** |
|
77 | - * Initial setup of filters |
|
78 | - * |
|
79 | - * @return array |
|
80 | - */ |
|
81 | - protected function _get_table_filters() |
|
82 | - { |
|
83 | - return array(); |
|
84 | - } |
|
85 | - |
|
86 | - |
|
87 | - /** |
|
88 | - * Initial setup of counts for views |
|
89 | - * |
|
90 | - * @throws InvalidArgumentException |
|
91 | - * @throws InvalidDataTypeException |
|
92 | - * @throws InvalidInterfaceException |
|
93 | - */ |
|
94 | - protected function _add_view_counts() |
|
95 | - { |
|
96 | - $this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, true); |
|
97 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
98 | - 'ee_delete_contacts', |
|
99 | - 'espresso_registrations_delete_registration' |
|
100 | - )) { |
|
101 | - $this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, true, true); |
|
102 | - } |
|
103 | - } |
|
104 | - |
|
105 | - |
|
106 | - /** |
|
107 | - * Get count of attendees. |
|
108 | - * |
|
109 | - * @return int |
|
110 | - * @throws EE_Error |
|
111 | - * @throws InvalidArgumentException |
|
112 | - * @throws InvalidDataTypeException |
|
113 | - * @throws InvalidInterfaceException |
|
114 | - */ |
|
115 | - protected function _get_attendees_count() |
|
116 | - { |
|
117 | - return EEM_Attendee::instance()->count(); |
|
118 | - } |
|
119 | - |
|
120 | - |
|
121 | - /** |
|
122 | - * Checkbox column |
|
123 | - * |
|
124 | - * @param EE_Attendee $attendee Unable to typehint this method because overrides parent. |
|
125 | - * @return string |
|
126 | - * @throws EE_Error |
|
127 | - */ |
|
128 | - public function column_cb($attendee) |
|
129 | - { |
|
130 | - if (! $attendee instanceof EE_Attendee) { |
|
131 | - return ''; |
|
132 | - } |
|
133 | - return sprintf( |
|
134 | - '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', |
|
135 | - $attendee->ID() |
|
136 | - ); |
|
137 | - } |
|
138 | - |
|
139 | - |
|
140 | - /** |
|
141 | - * ATT_ID column |
|
142 | - * |
|
143 | - * @param EE_Attendee $attendee |
|
144 | - * @return string |
|
145 | - * @throws EE_Error |
|
146 | - */ |
|
147 | - public function column_ATT_ID(EE_Attendee $attendee) |
|
148 | - { |
|
149 | - $content = $attendee->ID(); |
|
150 | - $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : ''; |
|
151 | - $content .= ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>'; |
|
152 | - return $content; |
|
153 | - } |
|
154 | - |
|
155 | - |
|
156 | - /** |
|
157 | - * ATT_lname column |
|
158 | - * |
|
159 | - * @param EE_Attendee $attendee |
|
160 | - * @return string |
|
161 | - * @throws InvalidArgumentException |
|
162 | - * @throws InvalidDataTypeException |
|
163 | - * @throws InvalidInterfaceException |
|
164 | - * @throws EE_Error |
|
165 | - */ |
|
166 | - public function column_ATT_lname(EE_Attendee $attendee) |
|
167 | - { |
|
168 | - // edit attendee link |
|
169 | - $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
170 | - array( |
|
171 | - 'action' => 'edit_attendee', |
|
172 | - 'post' => $attendee->ID(), |
|
173 | - ), |
|
174 | - REG_ADMIN_URL |
|
175 | - ); |
|
176 | - $name_link = EE_Registry::instance()->CAP->current_user_can( |
|
177 | - 'ee_edit_contacts', |
|
178 | - 'espresso_registrations_edit_attendee' |
|
179 | - ) |
|
180 | - ? '<a href="' . $edit_lnk_url . '" title="' |
|
181 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
182 | - . $attendee->lname() . '</a>' |
|
183 | - : $attendee->lname(); |
|
184 | - return $name_link; |
|
185 | - } |
|
186 | - |
|
187 | - |
|
188 | - /** |
|
189 | - * ATT_fname column |
|
190 | - * |
|
191 | - * @param EE_Attendee $attendee |
|
192 | - * @return string |
|
193 | - * @throws InvalidArgumentException |
|
194 | - * @throws InvalidDataTypeException |
|
195 | - * @throws InvalidInterfaceException |
|
196 | - * @throws EE_Error |
|
197 | - */ |
|
198 | - public function column_ATT_fname(EE_Attendee $attendee) |
|
199 | - { |
|
200 | - // Build row actions |
|
201 | - $actions = array(); |
|
202 | - // edit attendee link |
|
203 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
204 | - 'ee_edit_contacts', |
|
205 | - 'espresso_registrations_edit_attendee' |
|
206 | - )) { |
|
207 | - $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
208 | - array( |
|
209 | - 'action' => 'edit_attendee', |
|
210 | - 'post' => $attendee->ID(), |
|
211 | - ), |
|
212 | - REG_ADMIN_URL |
|
213 | - ); |
|
214 | - $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="' |
|
215 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
216 | - . esc_html__('Edit', 'event_espresso') . '</a>'; |
|
217 | - } |
|
218 | - |
|
219 | - if ($this->_view === 'in_use') { |
|
220 | - // trash attendee link |
|
221 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
222 | - 'ee_delete_contacts', |
|
223 | - 'espresso_registrations_trash_attendees' |
|
224 | - )) { |
|
225 | - $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
226 | - array( |
|
227 | - 'action' => 'trash_attendee', |
|
228 | - 'ATT_ID' => $attendee->ID(), |
|
229 | - ), |
|
230 | - REG_ADMIN_URL |
|
231 | - ); |
|
232 | - $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="' |
|
233 | - . esc_attr__('Move Contact to Trash', 'event_espresso') |
|
234 | - . '">' . esc_html__('Trash', 'event_espresso') . '</a>'; |
|
235 | - } |
|
236 | - } else { |
|
237 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
238 | - 'ee_delete_contacts', |
|
239 | - 'espresso_registrations_restore_attendees' |
|
240 | - )) { |
|
241 | - // restore attendee link |
|
242 | - $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
243 | - array( |
|
244 | - 'action' => 'restore_attendees', |
|
245 | - 'ATT_ID' => $attendee->ID(), |
|
246 | - ), |
|
247 | - REG_ADMIN_URL |
|
248 | - ); |
|
249 | - $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="' |
|
250 | - . esc_attr__('Restore Contact', 'event_espresso') . '">' |
|
251 | - . esc_html__('Restore', 'event_espresso') . '</a>'; |
|
252 | - } |
|
253 | - } |
|
254 | - |
|
255 | - $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
256 | - array( |
|
257 | - 'action' => 'edit_attendee', |
|
258 | - 'post' => $attendee->ID(), |
|
259 | - ), |
|
260 | - REG_ADMIN_URL |
|
261 | - ); |
|
262 | - $name_link = EE_Registry::instance()->CAP->current_user_can( |
|
263 | - 'ee_edit_contacts', |
|
264 | - 'espresso_registrations_edit_attendee' |
|
265 | - ) |
|
266 | - ? '<a href="' . $edit_lnk_url . '" title="' |
|
267 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>' |
|
268 | - : $attendee->fname(); |
|
269 | - |
|
270 | - // Return the name contents |
|
271 | - return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions)); |
|
272 | - } |
|
273 | - |
|
274 | - |
|
275 | - /** |
|
276 | - * Email Column |
|
277 | - * |
|
278 | - * @param EE_Attendee $attendee |
|
279 | - * @return string |
|
280 | - * @throws EE_Error |
|
281 | - */ |
|
282 | - public function column_ATT_email(EE_Attendee $attendee) |
|
283 | - { |
|
284 | - return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>'; |
|
285 | - } |
|
286 | - |
|
287 | - |
|
288 | - /** |
|
289 | - * Column displaying count of registrations attached to Attendee. |
|
290 | - * |
|
291 | - * @param EE_Attendee $attendee |
|
292 | - * @return string |
|
293 | - * @throws EE_Error |
|
294 | - */ |
|
295 | - public function column_Registration_Count(EE_Attendee $attendee) |
|
296 | - { |
|
297 | - $link = EEH_URL::add_query_args_and_nonce( |
|
298 | - array( |
|
299 | - 'action' => 'default', |
|
300 | - 'ATT_ID' => $attendee->ID(), |
|
301 | - ), |
|
302 | - REG_ADMIN_URL |
|
303 | - ); |
|
304 | - return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>'; |
|
305 | - } |
|
306 | - |
|
307 | - |
|
308 | - /** |
|
309 | - * ATT_address column |
|
310 | - * |
|
311 | - * @param EE_Attendee $attendee |
|
312 | - * @return mixed |
|
313 | - * @throws EE_Error |
|
314 | - */ |
|
315 | - public function column_ATT_address(EE_Attendee $attendee) |
|
316 | - { |
|
317 | - return $attendee->address(); |
|
318 | - } |
|
319 | - |
|
320 | - |
|
321 | - /** |
|
322 | - * ATT_city column |
|
323 | - * |
|
324 | - * @param EE_Attendee $attendee |
|
325 | - * @return mixed |
|
326 | - * @throws EE_Error |
|
327 | - */ |
|
328 | - public function column_ATT_city(EE_Attendee $attendee) |
|
329 | - { |
|
330 | - return $attendee->city(); |
|
331 | - } |
|
332 | - |
|
333 | - |
|
334 | - /** |
|
335 | - * State Column |
|
336 | - * |
|
337 | - * @param EE_Attendee $attendee |
|
338 | - * @return string |
|
339 | - * @throws EE_Error |
|
340 | - * @throws InvalidArgumentException |
|
341 | - * @throws InvalidDataTypeException |
|
342 | - * @throws InvalidInterfaceException |
|
343 | - */ |
|
344 | - public function column_STA_ID(EE_Attendee $attendee) |
|
345 | - { |
|
346 | - $states = EEM_State::instance()->get_all_states(); |
|
347 | - $state = isset($states[ $attendee->state_ID() ]) |
|
348 | - ? $states[ $attendee->state_ID() ]->get('STA_name') |
|
349 | - : $attendee->state_ID(); |
|
350 | - return ! is_numeric($state) ? $state : ''; |
|
351 | - } |
|
352 | - |
|
353 | - |
|
354 | - /** |
|
355 | - * Country Column |
|
356 | - * |
|
357 | - * @param EE_Attendee $attendee |
|
358 | - * @return string |
|
359 | - * @throws EE_Error |
|
360 | - * @throws InvalidArgumentException |
|
361 | - * @throws InvalidDataTypeException |
|
362 | - * @throws InvalidInterfaceException |
|
363 | - */ |
|
364 | - public function column_CNT_ISO(EE_Attendee $attendee) |
|
365 | - { |
|
366 | - $countries = EEM_Country::instance()->get_all_countries(); |
|
367 | - $country = isset($countries[ $attendee->country_ID() ]) |
|
368 | - ? $countries[ $attendee->country_ID() ]->get('CNT_name') |
|
369 | - : $attendee->country_ID(); |
|
370 | - return ! is_numeric($country) ? $country : ''; |
|
371 | - } |
|
372 | - |
|
373 | - |
|
374 | - /** |
|
375 | - * Phone Number column |
|
376 | - * |
|
377 | - * @param EE_Attendee $attendee |
|
378 | - * @return mixed |
|
379 | - * @throws EE_Error |
|
380 | - */ |
|
381 | - public function column_ATT_phone(EE_Attendee $attendee) |
|
382 | - { |
|
383 | - return $attendee->phone(); |
|
384 | - } |
|
15 | + /** |
|
16 | + * Initial setup of data (called by parent). |
|
17 | + */ |
|
18 | + protected function _setup_data() |
|
19 | + { |
|
20 | + $this->_data = $this->_view !== 'trash' |
|
21 | + ? $this->_admin_page->get_attendees($this->_per_page) |
|
22 | + : $this->_admin_page->get_attendees($this->_per_page, false, true); |
|
23 | + $this->_all_data_count = $this->_view !== 'trash' |
|
24 | + ? $this->_admin_page->get_attendees($this->_per_page, true) |
|
25 | + : $this->_admin_page->get_attendees($this->_per_page, true, true); |
|
26 | + } |
|
27 | + |
|
28 | + |
|
29 | + /** |
|
30 | + * Initial setup of properties. |
|
31 | + */ |
|
32 | + protected function _set_properties() |
|
33 | + { |
|
34 | + $this->_wp_list_args = array( |
|
35 | + 'singular' => esc_html__('attendee', 'event_espresso'), |
|
36 | + 'plural' => esc_html__('attendees', 'event_espresso'), |
|
37 | + 'ajax' => true, |
|
38 | + 'screen' => $this->_admin_page->get_current_screen()->id, |
|
39 | + ); |
|
40 | + |
|
41 | + $this->_columns = array( |
|
42 | + 'cb' => '<input type="checkbox" />', // Render a checkbox instead of text |
|
43 | + 'ATT_ID' => esc_html__('ID', 'event_espresso'), |
|
44 | + 'ATT_fname' => esc_html__('First Name', 'event_espresso'), |
|
45 | + 'ATT_lname' => esc_html__('Last Name', 'event_espresso'), |
|
46 | + 'ATT_email' => esc_html__('Email Address', 'event_espresso'), |
|
47 | + 'Registration_Count' => esc_html__('# Registrations', 'event_espresso'), |
|
48 | + 'ATT_phone' => esc_html__('Phone', 'event_espresso'), |
|
49 | + 'ATT_address' => esc_html__('Address', 'event_espresso'), |
|
50 | + 'ATT_city' => esc_html__('City', 'event_espresso'), |
|
51 | + 'STA_ID' => esc_html__('State/Province', 'event_espresso'), |
|
52 | + 'CNT_ISO' => esc_html__('Country', 'event_espresso'), |
|
53 | + ); |
|
54 | + |
|
55 | + $this->_sortable_columns = array( |
|
56 | + 'ATT_ID' => array('ATT_ID' => false), |
|
57 | + 'ATT_lname' => array('ATT_lname' => true), // true means its already sorted |
|
58 | + 'ATT_fname' => array('ATT_fname' => false), |
|
59 | + 'ATT_email' => array('ATT_email' => false), |
|
60 | + 'Registration_Count' => array('Registration_Count' => false), |
|
61 | + 'ATT_city' => array('ATT_city' => false), |
|
62 | + 'STA_ID' => array('STA_ID' => false), |
|
63 | + 'CNT_ISO' => array('CNT_ISO' => false), |
|
64 | + ); |
|
65 | + |
|
66 | + $this->_hidden_columns = array( |
|
67 | + 'ATT_phone', |
|
68 | + 'ATT_address', |
|
69 | + 'ATT_city', |
|
70 | + 'STA_ID', |
|
71 | + 'CNT_ISO', |
|
72 | + ); |
|
73 | + } |
|
74 | + |
|
75 | + |
|
76 | + /** |
|
77 | + * Initial setup of filters |
|
78 | + * |
|
79 | + * @return array |
|
80 | + */ |
|
81 | + protected function _get_table_filters() |
|
82 | + { |
|
83 | + return array(); |
|
84 | + } |
|
85 | + |
|
86 | + |
|
87 | + /** |
|
88 | + * Initial setup of counts for views |
|
89 | + * |
|
90 | + * @throws InvalidArgumentException |
|
91 | + * @throws InvalidDataTypeException |
|
92 | + * @throws InvalidInterfaceException |
|
93 | + */ |
|
94 | + protected function _add_view_counts() |
|
95 | + { |
|
96 | + $this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, true); |
|
97 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
98 | + 'ee_delete_contacts', |
|
99 | + 'espresso_registrations_delete_registration' |
|
100 | + )) { |
|
101 | + $this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, true, true); |
|
102 | + } |
|
103 | + } |
|
104 | + |
|
105 | + |
|
106 | + /** |
|
107 | + * Get count of attendees. |
|
108 | + * |
|
109 | + * @return int |
|
110 | + * @throws EE_Error |
|
111 | + * @throws InvalidArgumentException |
|
112 | + * @throws InvalidDataTypeException |
|
113 | + * @throws InvalidInterfaceException |
|
114 | + */ |
|
115 | + protected function _get_attendees_count() |
|
116 | + { |
|
117 | + return EEM_Attendee::instance()->count(); |
|
118 | + } |
|
119 | + |
|
120 | + |
|
121 | + /** |
|
122 | + * Checkbox column |
|
123 | + * |
|
124 | + * @param EE_Attendee $attendee Unable to typehint this method because overrides parent. |
|
125 | + * @return string |
|
126 | + * @throws EE_Error |
|
127 | + */ |
|
128 | + public function column_cb($attendee) |
|
129 | + { |
|
130 | + if (! $attendee instanceof EE_Attendee) { |
|
131 | + return ''; |
|
132 | + } |
|
133 | + return sprintf( |
|
134 | + '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', |
|
135 | + $attendee->ID() |
|
136 | + ); |
|
137 | + } |
|
138 | + |
|
139 | + |
|
140 | + /** |
|
141 | + * ATT_ID column |
|
142 | + * |
|
143 | + * @param EE_Attendee $attendee |
|
144 | + * @return string |
|
145 | + * @throws EE_Error |
|
146 | + */ |
|
147 | + public function column_ATT_ID(EE_Attendee $attendee) |
|
148 | + { |
|
149 | + $content = $attendee->ID(); |
|
150 | + $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : ''; |
|
151 | + $content .= ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>'; |
|
152 | + return $content; |
|
153 | + } |
|
154 | + |
|
155 | + |
|
156 | + /** |
|
157 | + * ATT_lname column |
|
158 | + * |
|
159 | + * @param EE_Attendee $attendee |
|
160 | + * @return string |
|
161 | + * @throws InvalidArgumentException |
|
162 | + * @throws InvalidDataTypeException |
|
163 | + * @throws InvalidInterfaceException |
|
164 | + * @throws EE_Error |
|
165 | + */ |
|
166 | + public function column_ATT_lname(EE_Attendee $attendee) |
|
167 | + { |
|
168 | + // edit attendee link |
|
169 | + $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
170 | + array( |
|
171 | + 'action' => 'edit_attendee', |
|
172 | + 'post' => $attendee->ID(), |
|
173 | + ), |
|
174 | + REG_ADMIN_URL |
|
175 | + ); |
|
176 | + $name_link = EE_Registry::instance()->CAP->current_user_can( |
|
177 | + 'ee_edit_contacts', |
|
178 | + 'espresso_registrations_edit_attendee' |
|
179 | + ) |
|
180 | + ? '<a href="' . $edit_lnk_url . '" title="' |
|
181 | + . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
182 | + . $attendee->lname() . '</a>' |
|
183 | + : $attendee->lname(); |
|
184 | + return $name_link; |
|
185 | + } |
|
186 | + |
|
187 | + |
|
188 | + /** |
|
189 | + * ATT_fname column |
|
190 | + * |
|
191 | + * @param EE_Attendee $attendee |
|
192 | + * @return string |
|
193 | + * @throws InvalidArgumentException |
|
194 | + * @throws InvalidDataTypeException |
|
195 | + * @throws InvalidInterfaceException |
|
196 | + * @throws EE_Error |
|
197 | + */ |
|
198 | + public function column_ATT_fname(EE_Attendee $attendee) |
|
199 | + { |
|
200 | + // Build row actions |
|
201 | + $actions = array(); |
|
202 | + // edit attendee link |
|
203 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
204 | + 'ee_edit_contacts', |
|
205 | + 'espresso_registrations_edit_attendee' |
|
206 | + )) { |
|
207 | + $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
208 | + array( |
|
209 | + 'action' => 'edit_attendee', |
|
210 | + 'post' => $attendee->ID(), |
|
211 | + ), |
|
212 | + REG_ADMIN_URL |
|
213 | + ); |
|
214 | + $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="' |
|
215 | + . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
216 | + . esc_html__('Edit', 'event_espresso') . '</a>'; |
|
217 | + } |
|
218 | + |
|
219 | + if ($this->_view === 'in_use') { |
|
220 | + // trash attendee link |
|
221 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
222 | + 'ee_delete_contacts', |
|
223 | + 'espresso_registrations_trash_attendees' |
|
224 | + )) { |
|
225 | + $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
226 | + array( |
|
227 | + 'action' => 'trash_attendee', |
|
228 | + 'ATT_ID' => $attendee->ID(), |
|
229 | + ), |
|
230 | + REG_ADMIN_URL |
|
231 | + ); |
|
232 | + $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="' |
|
233 | + . esc_attr__('Move Contact to Trash', 'event_espresso') |
|
234 | + . '">' . esc_html__('Trash', 'event_espresso') . '</a>'; |
|
235 | + } |
|
236 | + } else { |
|
237 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
238 | + 'ee_delete_contacts', |
|
239 | + 'espresso_registrations_restore_attendees' |
|
240 | + )) { |
|
241 | + // restore attendee link |
|
242 | + $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
243 | + array( |
|
244 | + 'action' => 'restore_attendees', |
|
245 | + 'ATT_ID' => $attendee->ID(), |
|
246 | + ), |
|
247 | + REG_ADMIN_URL |
|
248 | + ); |
|
249 | + $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="' |
|
250 | + . esc_attr__('Restore Contact', 'event_espresso') . '">' |
|
251 | + . esc_html__('Restore', 'event_espresso') . '</a>'; |
|
252 | + } |
|
253 | + } |
|
254 | + |
|
255 | + $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
256 | + array( |
|
257 | + 'action' => 'edit_attendee', |
|
258 | + 'post' => $attendee->ID(), |
|
259 | + ), |
|
260 | + REG_ADMIN_URL |
|
261 | + ); |
|
262 | + $name_link = EE_Registry::instance()->CAP->current_user_can( |
|
263 | + 'ee_edit_contacts', |
|
264 | + 'espresso_registrations_edit_attendee' |
|
265 | + ) |
|
266 | + ? '<a href="' . $edit_lnk_url . '" title="' |
|
267 | + . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>' |
|
268 | + : $attendee->fname(); |
|
269 | + |
|
270 | + // Return the name contents |
|
271 | + return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions)); |
|
272 | + } |
|
273 | + |
|
274 | + |
|
275 | + /** |
|
276 | + * Email Column |
|
277 | + * |
|
278 | + * @param EE_Attendee $attendee |
|
279 | + * @return string |
|
280 | + * @throws EE_Error |
|
281 | + */ |
|
282 | + public function column_ATT_email(EE_Attendee $attendee) |
|
283 | + { |
|
284 | + return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>'; |
|
285 | + } |
|
286 | + |
|
287 | + |
|
288 | + /** |
|
289 | + * Column displaying count of registrations attached to Attendee. |
|
290 | + * |
|
291 | + * @param EE_Attendee $attendee |
|
292 | + * @return string |
|
293 | + * @throws EE_Error |
|
294 | + */ |
|
295 | + public function column_Registration_Count(EE_Attendee $attendee) |
|
296 | + { |
|
297 | + $link = EEH_URL::add_query_args_and_nonce( |
|
298 | + array( |
|
299 | + 'action' => 'default', |
|
300 | + 'ATT_ID' => $attendee->ID(), |
|
301 | + ), |
|
302 | + REG_ADMIN_URL |
|
303 | + ); |
|
304 | + return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>'; |
|
305 | + } |
|
306 | + |
|
307 | + |
|
308 | + /** |
|
309 | + * ATT_address column |
|
310 | + * |
|
311 | + * @param EE_Attendee $attendee |
|
312 | + * @return mixed |
|
313 | + * @throws EE_Error |
|
314 | + */ |
|
315 | + public function column_ATT_address(EE_Attendee $attendee) |
|
316 | + { |
|
317 | + return $attendee->address(); |
|
318 | + } |
|
319 | + |
|
320 | + |
|
321 | + /** |
|
322 | + * ATT_city column |
|
323 | + * |
|
324 | + * @param EE_Attendee $attendee |
|
325 | + * @return mixed |
|
326 | + * @throws EE_Error |
|
327 | + */ |
|
328 | + public function column_ATT_city(EE_Attendee $attendee) |
|
329 | + { |
|
330 | + return $attendee->city(); |
|
331 | + } |
|
332 | + |
|
333 | + |
|
334 | + /** |
|
335 | + * State Column |
|
336 | + * |
|
337 | + * @param EE_Attendee $attendee |
|
338 | + * @return string |
|
339 | + * @throws EE_Error |
|
340 | + * @throws InvalidArgumentException |
|
341 | + * @throws InvalidDataTypeException |
|
342 | + * @throws InvalidInterfaceException |
|
343 | + */ |
|
344 | + public function column_STA_ID(EE_Attendee $attendee) |
|
345 | + { |
|
346 | + $states = EEM_State::instance()->get_all_states(); |
|
347 | + $state = isset($states[ $attendee->state_ID() ]) |
|
348 | + ? $states[ $attendee->state_ID() ]->get('STA_name') |
|
349 | + : $attendee->state_ID(); |
|
350 | + return ! is_numeric($state) ? $state : ''; |
|
351 | + } |
|
352 | + |
|
353 | + |
|
354 | + /** |
|
355 | + * Country Column |
|
356 | + * |
|
357 | + * @param EE_Attendee $attendee |
|
358 | + * @return string |
|
359 | + * @throws EE_Error |
|
360 | + * @throws InvalidArgumentException |
|
361 | + * @throws InvalidDataTypeException |
|
362 | + * @throws InvalidInterfaceException |
|
363 | + */ |
|
364 | + public function column_CNT_ISO(EE_Attendee $attendee) |
|
365 | + { |
|
366 | + $countries = EEM_Country::instance()->get_all_countries(); |
|
367 | + $country = isset($countries[ $attendee->country_ID() ]) |
|
368 | + ? $countries[ $attendee->country_ID() ]->get('CNT_name') |
|
369 | + : $attendee->country_ID(); |
|
370 | + return ! is_numeric($country) ? $country : ''; |
|
371 | + } |
|
372 | + |
|
373 | + |
|
374 | + /** |
|
375 | + * Phone Number column |
|
376 | + * |
|
377 | + * @param EE_Attendee $attendee |
|
378 | + * @return mixed |
|
379 | + * @throws EE_Error |
|
380 | + */ |
|
381 | + public function column_ATT_phone(EE_Attendee $attendee) |
|
382 | + { |
|
383 | + return $attendee->phone(); |
|
384 | + } |
|
385 | 385 | } |
@@ -127,7 +127,7 @@ discard block |
||
127 | 127 | */ |
128 | 128 | public function column_cb($attendee) |
129 | 129 | { |
130 | - if (! $attendee instanceof EE_Attendee) { |
|
130 | + if ( ! $attendee instanceof EE_Attendee) { |
|
131 | 131 | return ''; |
132 | 132 | } |
133 | 133 | return sprintf( |
@@ -148,7 +148,7 @@ discard block |
||
148 | 148 | { |
149 | 149 | $content = $attendee->ID(); |
150 | 150 | $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : ''; |
151 | - $content .= ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>'; |
|
151 | + $content .= ' <span class="show-on-mobile-view-only">'.$attendee_name.'</span>'; |
|
152 | 152 | return $content; |
153 | 153 | } |
154 | 154 | |
@@ -177,9 +177,9 @@ discard block |
||
177 | 177 | 'ee_edit_contacts', |
178 | 178 | 'espresso_registrations_edit_attendee' |
179 | 179 | ) |
180 | - ? '<a href="' . $edit_lnk_url . '" title="' |
|
181 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
182 | - . $attendee->lname() . '</a>' |
|
180 | + ? '<a href="'.$edit_lnk_url.'" title="' |
|
181 | + . esc_attr__('Edit Contact', 'event_espresso').'">' |
|
182 | + . $attendee->lname().'</a>' |
|
183 | 183 | : $attendee->lname(); |
184 | 184 | return $name_link; |
185 | 185 | } |
@@ -211,9 +211,9 @@ discard block |
||
211 | 211 | ), |
212 | 212 | REG_ADMIN_URL |
213 | 213 | ); |
214 | - $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="' |
|
215 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
216 | - . esc_html__('Edit', 'event_espresso') . '</a>'; |
|
214 | + $actions['edit'] = '<a href="'.$edit_lnk_url.'" title="' |
|
215 | + . esc_attr__('Edit Contact', 'event_espresso').'">' |
|
216 | + . esc_html__('Edit', 'event_espresso').'</a>'; |
|
217 | 217 | } |
218 | 218 | |
219 | 219 | if ($this->_view === 'in_use') { |
@@ -229,9 +229,9 @@ discard block |
||
229 | 229 | ), |
230 | 230 | REG_ADMIN_URL |
231 | 231 | ); |
232 | - $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="' |
|
232 | + $actions['trash'] = '<a href="'.$trash_lnk_url.'" title="' |
|
233 | 233 | . esc_attr__('Move Contact to Trash', 'event_espresso') |
234 | - . '">' . esc_html__('Trash', 'event_espresso') . '</a>'; |
|
234 | + . '">'.esc_html__('Trash', 'event_espresso').'</a>'; |
|
235 | 235 | } |
236 | 236 | } else { |
237 | 237 | if (EE_Registry::instance()->CAP->current_user_can( |
@@ -246,9 +246,9 @@ discard block |
||
246 | 246 | ), |
247 | 247 | REG_ADMIN_URL |
248 | 248 | ); |
249 | - $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="' |
|
250 | - . esc_attr__('Restore Contact', 'event_espresso') . '">' |
|
251 | - . esc_html__('Restore', 'event_espresso') . '</a>'; |
|
249 | + $actions['restore'] = '<a href="'.$restore_lnk_url.'" title="' |
|
250 | + . esc_attr__('Restore Contact', 'event_espresso').'">' |
|
251 | + . esc_html__('Restore', 'event_espresso').'</a>'; |
|
252 | 252 | } |
253 | 253 | } |
254 | 254 | |
@@ -263,8 +263,8 @@ discard block |
||
263 | 263 | 'ee_edit_contacts', |
264 | 264 | 'espresso_registrations_edit_attendee' |
265 | 265 | ) |
266 | - ? '<a href="' . $edit_lnk_url . '" title="' |
|
267 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>' |
|
266 | + ? '<a href="'.$edit_lnk_url.'" title="' |
|
267 | + . esc_attr__('Edit Contact', 'event_espresso').'">'.$attendee->fname().'</a>' |
|
268 | 268 | : $attendee->fname(); |
269 | 269 | |
270 | 270 | // Return the name contents |
@@ -281,7 +281,7 @@ discard block |
||
281 | 281 | */ |
282 | 282 | public function column_ATT_email(EE_Attendee $attendee) |
283 | 283 | { |
284 | - return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>'; |
|
284 | + return '<a href="mailto:'.$attendee->email().'">'.$attendee->email().'</a>'; |
|
285 | 285 | } |
286 | 286 | |
287 | 287 | |
@@ -301,7 +301,7 @@ discard block |
||
301 | 301 | ), |
302 | 302 | REG_ADMIN_URL |
303 | 303 | ); |
304 | - return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>'; |
|
304 | + return '<a href="'.$link.'">'.$attendee->getCustomSelect('Registration_Count').'</a>'; |
|
305 | 305 | } |
306 | 306 | |
307 | 307 | |
@@ -344,8 +344,8 @@ discard block |
||
344 | 344 | public function column_STA_ID(EE_Attendee $attendee) |
345 | 345 | { |
346 | 346 | $states = EEM_State::instance()->get_all_states(); |
347 | - $state = isset($states[ $attendee->state_ID() ]) |
|
348 | - ? $states[ $attendee->state_ID() ]->get('STA_name') |
|
347 | + $state = isset($states[$attendee->state_ID()]) |
|
348 | + ? $states[$attendee->state_ID()]->get('STA_name') |
|
349 | 349 | : $attendee->state_ID(); |
350 | 350 | return ! is_numeric($state) ? $state : ''; |
351 | 351 | } |
@@ -364,8 +364,8 @@ discard block |
||
364 | 364 | public function column_CNT_ISO(EE_Attendee $attendee) |
365 | 365 | { |
366 | 366 | $countries = EEM_Country::instance()->get_all_countries(); |
367 | - $country = isset($countries[ $attendee->country_ID() ]) |
|
368 | - ? $countries[ $attendee->country_ID() ]->get('CNT_name') |
|
367 | + $country = isset($countries[$attendee->country_ID()]) |
|
368 | + ? $countries[$attendee->country_ID()]->get('CNT_name') |
|
369 | 369 | : $attendee->country_ID(); |
370 | 370 | return ! is_numeric($country) ? $country : ''; |
371 | 371 | } |
@@ -25,17 +25,17 @@ |
||
25 | 25 | class ModelFactory |
26 | 26 | { |
27 | 27 | |
28 | - /** |
|
29 | - * @param string $model_name |
|
30 | - * @return bool|EEM_Base |
|
31 | - * @throws EE_Error |
|
32 | - * @throws InvalidDataTypeException |
|
33 | - * @throws InvalidInterfaceException |
|
34 | - * @throws InvalidArgumentException |
|
35 | - * @throws ReflectionException |
|
36 | - */ |
|
37 | - public static function getModel($model_name) |
|
38 | - { |
|
39 | - return EE_Registry::instance()->load_model($model_name); |
|
40 | - } |
|
28 | + /** |
|
29 | + * @param string $model_name |
|
30 | + * @return bool|EEM_Base |
|
31 | + * @throws EE_Error |
|
32 | + * @throws InvalidDataTypeException |
|
33 | + * @throws InvalidInterfaceException |
|
34 | + * @throws InvalidArgumentException |
|
35 | + * @throws ReflectionException |
|
36 | + */ |
|
37 | + public static function getModel($model_name) |
|
38 | + { |
|
39 | + return EE_Registry::instance()->load_model($model_name); |
|
40 | + } |
|
41 | 41 | } |
@@ -66,24 +66,24 @@ discard block |
||
66 | 66 | public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false) |
67 | 67 | { |
68 | 68 | // if the $_available_spaces array has not been set up yet... |
69 | - if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
69 | + if ( ! isset($this->available_spaces['tickets'][$ticket->ID()])) { |
|
70 | 70 | $this->setInitialTicketDatetimeAvailability($ticket); |
71 | 71 | } |
72 | 72 | $available_spaces = $ticket->qty() - $ticket->sold(); |
73 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
73 | + if (isset($this->available_spaces['tickets'][$ticket->ID()])) { |
|
74 | 74 | // loop thru tickets, which will ALSO include individual ticket records AND a total |
75 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
75 | + foreach ($this->available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) { |
|
76 | 76 | // if we want the original datetime availability BEFORE we started subtracting tickets ? |
77 | 77 | if ($get_original_ticket_spaces) { |
78 | 78 | // then grab the available spaces from the "tickets" array |
79 | 79 | // and compare with the above to get the lowest number |
80 | 80 | $available_spaces = min( |
81 | 81 | $available_spaces, |
82 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ] |
|
82 | + $this->available_spaces['tickets'][$ticket->ID()][$DTD_ID] |
|
83 | 83 | ); |
84 | 84 | } else { |
85 | 85 | // we want the updated ticket availability as stored in the "datetimes" array |
86 | - $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]); |
|
86 | + $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][$DTD_ID]); |
|
87 | 87 | } |
88 | 88 | } |
89 | 89 | } |
@@ -114,7 +114,7 @@ discard block |
||
114 | 114 | 'order_by' => array('DTT_EVT_start' => 'ASC'), |
115 | 115 | ) |
116 | 116 | ); |
117 | - if (! empty($datetimes)) { |
|
117 | + if ( ! empty($datetimes)) { |
|
118 | 118 | // now loop thru all of the datetimes |
119 | 119 | foreach ($datetimes as $datetime) { |
120 | 120 | if ($datetime instanceof EE_Datetime) { |
@@ -122,17 +122,17 @@ discard block |
||
122 | 122 | $spaces_remaining = $datetime->spaces_remaining(); |
123 | 123 | // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
124 | 124 | // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
125 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min( |
|
125 | + $this->available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min( |
|
126 | 126 | $ticket->qty() - $ticket->sold(), |
127 | 127 | $spaces_remaining |
128 | 128 | ); |
129 | 129 | // if the remaining spaces for this datetime is already set, |
130 | 130 | // then compare that against the datetime spaces remaining, and take the lowest number, |
131 | 131 | // else just take the datetime spaces remaining, and assign to the datetimes array |
132 | - $this->available_spaces['datetimes'][ $datetime->ID() ] = isset( |
|
133 | - $this->available_spaces['datetimes'][ $datetime->ID() ] |
|
132 | + $this->available_spaces['datetimes'][$datetime->ID()] = isset( |
|
133 | + $this->available_spaces['datetimes'][$datetime->ID()] |
|
134 | 134 | ) |
135 | - ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining) |
|
135 | + ? min($this->available_spaces['datetimes'][$datetime->ID()], $spaces_remaining) |
|
136 | 136 | : $spaces_remaining; |
137 | 137 | } |
138 | 138 | } |
@@ -148,11 +148,11 @@ discard block |
||
148 | 148 | */ |
149 | 149 | public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0) |
150 | 150 | { |
151 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
151 | + if (isset($this->available_spaces['tickets'][$ticket->ID()])) { |
|
152 | 152 | // loop thru tickets, which will ALSO include individual ticket records AND a total |
153 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
153 | + foreach ($this->available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) { |
|
154 | 154 | // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
155 | - $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty; |
|
155 | + $this->available_spaces['datetimes'][$DTD_ID] -= $qty; |
|
156 | 156 | } |
157 | 157 | } |
158 | 158 | } |
@@ -22,215 +22,215 @@ |
||
22 | 22 | class TicketDatetimeAvailabilityTracker |
23 | 23 | { |
24 | 24 | |
25 | - /** |
|
26 | - * array of datetimes and the spaces available for them |
|
27 | - * |
|
28 | - * @var array[][] |
|
29 | - */ |
|
30 | - private $available_spaces = array(); |
|
31 | - |
|
32 | - /** |
|
33 | - * @var EEM_Datetime $datetime_model |
|
34 | - */ |
|
35 | - private $datetime_model; |
|
36 | - |
|
37 | - |
|
38 | - /** |
|
39 | - * TicketDatetimeAvailabilityTracker constructor. |
|
40 | - * |
|
41 | - * @param EEM_Datetime $datetime_model |
|
42 | - */ |
|
43 | - public function __construct(EEM_Datetime $datetime_model) |
|
44 | - { |
|
45 | - $this->datetime_model = $datetime_model; |
|
46 | - } |
|
47 | - |
|
48 | - |
|
49 | - /** |
|
50 | - * ticketDatetimeAvailability |
|
51 | - * creates an array of tickets plus all of the datetimes available to each ticket |
|
52 | - * and tracks the spaces remaining for each of those datetimes |
|
53 | - * |
|
54 | - * @param EE_Ticket $ticket - selected ticket |
|
55 | - * @param bool $get_original_ticket_spaces |
|
56 | - * @return int |
|
57 | - * @throws EE_Error |
|
58 | - * @throws InvalidArgumentException |
|
59 | - * @throws InvalidDataTypeException |
|
60 | - * @throws InvalidInterfaceException |
|
61 | - */ |
|
62 | - public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false) |
|
63 | - { |
|
64 | - // if the $_available_spaces array has not been set up yet... |
|
65 | - if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
66 | - $this->setInitialTicketDatetimeAvailability($ticket); |
|
67 | - } |
|
68 | - $available_spaces = $ticket->qty() - $ticket->sold(); |
|
69 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
70 | - // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
71 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
72 | - // if we want the original datetime availability BEFORE we started subtracting tickets ? |
|
73 | - if ($get_original_ticket_spaces) { |
|
74 | - // then grab the available spaces from the "tickets" array |
|
75 | - // and compare with the above to get the lowest number |
|
76 | - $available_spaces = min( |
|
77 | - $available_spaces, |
|
78 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ] |
|
79 | - ); |
|
80 | - } else { |
|
81 | - // we want the updated ticket availability as stored in the "datetimes" array |
|
82 | - $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]); |
|
83 | - } |
|
84 | - } |
|
85 | - } |
|
86 | - return $available_spaces; |
|
87 | - } |
|
88 | - |
|
89 | - |
|
90 | - /** |
|
91 | - * @param EE_Ticket $ticket |
|
92 | - * @return void |
|
93 | - * @throws InvalidArgumentException |
|
94 | - * @throws InvalidInterfaceException |
|
95 | - * @throws InvalidDataTypeException |
|
96 | - * @throws EE_Error |
|
97 | - */ |
|
98 | - private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket) |
|
99 | - { |
|
100 | - // first, get all of the datetimes that are available to this ticket |
|
101 | - $datetimes = $ticket->get_many_related( |
|
102 | - 'Datetime', |
|
103 | - array( |
|
104 | - array( |
|
105 | - 'DTT_EVT_end' => array( |
|
106 | - '>=', |
|
107 | - $this->datetime_model->current_time_for_query('DTT_EVT_end'), |
|
108 | - ), |
|
109 | - ), |
|
110 | - 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
111 | - ) |
|
112 | - ); |
|
113 | - if (! empty($datetimes)) { |
|
114 | - // now loop thru all of the datetimes |
|
115 | - foreach ($datetimes as $datetime) { |
|
116 | - if ($datetime instanceof EE_Datetime) { |
|
117 | - // the number of spaces available for the datetime without considering individual ticket quantities |
|
118 | - $spaces_remaining = $datetime->spaces_remaining(); |
|
119 | - // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
|
120 | - // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
|
121 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min( |
|
122 | - $ticket->qty() - $ticket->sold(), |
|
123 | - $spaces_remaining |
|
124 | - ); |
|
125 | - // if the remaining spaces for this datetime is already set, |
|
126 | - // then compare that against the datetime spaces remaining, and take the lowest number, |
|
127 | - // else just take the datetime spaces remaining, and assign to the datetimes array |
|
128 | - $this->available_spaces['datetimes'][ $datetime->ID() ] = isset( |
|
129 | - $this->available_spaces['datetimes'][ $datetime->ID() ] |
|
130 | - ) |
|
131 | - ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining) |
|
132 | - : $spaces_remaining; |
|
133 | - } |
|
134 | - } |
|
135 | - } |
|
136 | - } |
|
137 | - |
|
138 | - |
|
139 | - /** |
|
140 | - * @param EE_Ticket $ticket |
|
141 | - * @param int $qty |
|
142 | - * @return void |
|
143 | - * @throws EE_Error |
|
144 | - */ |
|
145 | - public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0) |
|
146 | - { |
|
147 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
148 | - // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
149 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
150 | - // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
|
151 | - $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty; |
|
152 | - } |
|
153 | - } |
|
154 | - } |
|
155 | - |
|
156 | - |
|
157 | - /** |
|
158 | - * @param EE_Ticket $ticket |
|
159 | - * @param $qty |
|
160 | - * @param int $total_ticket_count |
|
161 | - * @throws EE_Error |
|
162 | - * @throws InvalidArgumentException |
|
163 | - * @throws InvalidDataTypeException |
|
164 | - * @throws InvalidInterfaceException |
|
165 | - */ |
|
166 | - public function processAvailabilityError(EE_Ticket $ticket, $qty, $total_ticket_count = 1) |
|
167 | - { |
|
168 | - // tickets can not be purchased but let's find the exact number left |
|
169 | - // for the last ticket selected PRIOR to subtracting tickets |
|
170 | - $available_spaces = $this->ticketDatetimeAvailability($ticket, true); |
|
171 | - // greedy greedy greedy eh? |
|
172 | - if ($available_spaces > 0) { |
|
173 | - if (apply_filters( |
|
174 | - 'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error', |
|
175 | - true, |
|
176 | - $ticket, |
|
177 | - $qty, |
|
178 | - $available_spaces |
|
179 | - )) { |
|
180 | - $this->availabilityError( |
|
181 | - $available_spaces, |
|
182 | - $total_ticket_count |
|
183 | - ); |
|
184 | - } |
|
185 | - } else { |
|
186 | - EE_Error::add_error( |
|
187 | - esc_html__( |
|
188 | - 'We\'re sorry, but there are no available spaces left for this event at this particular date and time.', |
|
189 | - 'event_espresso' |
|
190 | - ), |
|
191 | - __FILE__, |
|
192 | - __FUNCTION__, |
|
193 | - __LINE__ |
|
194 | - ); |
|
195 | - } |
|
196 | - } |
|
197 | - |
|
198 | - |
|
199 | - /** |
|
200 | - * @param int $available_spaces |
|
201 | - * @param int $total_ticket_count |
|
202 | - */ |
|
203 | - private function availabilityError($available_spaces = 1, $total_ticket_count = 1) |
|
204 | - { |
|
205 | - // add error messaging - we're using the _n function that will generate |
|
206 | - // the appropriate singular or plural message based on the number of $available_spaces |
|
207 | - if ($total_ticket_count) { |
|
208 | - $msg = sprintf( |
|
209 | - esc_html( |
|
210 | - _n( |
|
211 | - 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
212 | - 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
213 | - $available_spaces, |
|
214 | - 'event_espresso' |
|
215 | - ) |
|
216 | - ), |
|
217 | - $available_spaces, |
|
218 | - '<br />' |
|
219 | - ); |
|
220 | - } else { |
|
221 | - $msg = sprintf( |
|
222 | - esc_html( |
|
223 | - _n( |
|
224 | - 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
225 | - 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
226 | - $available_spaces, |
|
227 | - 'event_espresso' |
|
228 | - ) |
|
229 | - ), |
|
230 | - $available_spaces, |
|
231 | - '<br />' |
|
232 | - ); |
|
233 | - } |
|
234 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
235 | - } |
|
25 | + /** |
|
26 | + * array of datetimes and the spaces available for them |
|
27 | + * |
|
28 | + * @var array[][] |
|
29 | + */ |
|
30 | + private $available_spaces = array(); |
|
31 | + |
|
32 | + /** |
|
33 | + * @var EEM_Datetime $datetime_model |
|
34 | + */ |
|
35 | + private $datetime_model; |
|
36 | + |
|
37 | + |
|
38 | + /** |
|
39 | + * TicketDatetimeAvailabilityTracker constructor. |
|
40 | + * |
|
41 | + * @param EEM_Datetime $datetime_model |
|
42 | + */ |
|
43 | + public function __construct(EEM_Datetime $datetime_model) |
|
44 | + { |
|
45 | + $this->datetime_model = $datetime_model; |
|
46 | + } |
|
47 | + |
|
48 | + |
|
49 | + /** |
|
50 | + * ticketDatetimeAvailability |
|
51 | + * creates an array of tickets plus all of the datetimes available to each ticket |
|
52 | + * and tracks the spaces remaining for each of those datetimes |
|
53 | + * |
|
54 | + * @param EE_Ticket $ticket - selected ticket |
|
55 | + * @param bool $get_original_ticket_spaces |
|
56 | + * @return int |
|
57 | + * @throws EE_Error |
|
58 | + * @throws InvalidArgumentException |
|
59 | + * @throws InvalidDataTypeException |
|
60 | + * @throws InvalidInterfaceException |
|
61 | + */ |
|
62 | + public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false) |
|
63 | + { |
|
64 | + // if the $_available_spaces array has not been set up yet... |
|
65 | + if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
66 | + $this->setInitialTicketDatetimeAvailability($ticket); |
|
67 | + } |
|
68 | + $available_spaces = $ticket->qty() - $ticket->sold(); |
|
69 | + if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
70 | + // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
71 | + foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
72 | + // if we want the original datetime availability BEFORE we started subtracting tickets ? |
|
73 | + if ($get_original_ticket_spaces) { |
|
74 | + // then grab the available spaces from the "tickets" array |
|
75 | + // and compare with the above to get the lowest number |
|
76 | + $available_spaces = min( |
|
77 | + $available_spaces, |
|
78 | + $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ] |
|
79 | + ); |
|
80 | + } else { |
|
81 | + // we want the updated ticket availability as stored in the "datetimes" array |
|
82 | + $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]); |
|
83 | + } |
|
84 | + } |
|
85 | + } |
|
86 | + return $available_spaces; |
|
87 | + } |
|
88 | + |
|
89 | + |
|
90 | + /** |
|
91 | + * @param EE_Ticket $ticket |
|
92 | + * @return void |
|
93 | + * @throws InvalidArgumentException |
|
94 | + * @throws InvalidInterfaceException |
|
95 | + * @throws InvalidDataTypeException |
|
96 | + * @throws EE_Error |
|
97 | + */ |
|
98 | + private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket) |
|
99 | + { |
|
100 | + // first, get all of the datetimes that are available to this ticket |
|
101 | + $datetimes = $ticket->get_many_related( |
|
102 | + 'Datetime', |
|
103 | + array( |
|
104 | + array( |
|
105 | + 'DTT_EVT_end' => array( |
|
106 | + '>=', |
|
107 | + $this->datetime_model->current_time_for_query('DTT_EVT_end'), |
|
108 | + ), |
|
109 | + ), |
|
110 | + 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
111 | + ) |
|
112 | + ); |
|
113 | + if (! empty($datetimes)) { |
|
114 | + // now loop thru all of the datetimes |
|
115 | + foreach ($datetimes as $datetime) { |
|
116 | + if ($datetime instanceof EE_Datetime) { |
|
117 | + // the number of spaces available for the datetime without considering individual ticket quantities |
|
118 | + $spaces_remaining = $datetime->spaces_remaining(); |
|
119 | + // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
|
120 | + // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
|
121 | + $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min( |
|
122 | + $ticket->qty() - $ticket->sold(), |
|
123 | + $spaces_remaining |
|
124 | + ); |
|
125 | + // if the remaining spaces for this datetime is already set, |
|
126 | + // then compare that against the datetime spaces remaining, and take the lowest number, |
|
127 | + // else just take the datetime spaces remaining, and assign to the datetimes array |
|
128 | + $this->available_spaces['datetimes'][ $datetime->ID() ] = isset( |
|
129 | + $this->available_spaces['datetimes'][ $datetime->ID() ] |
|
130 | + ) |
|
131 | + ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining) |
|
132 | + : $spaces_remaining; |
|
133 | + } |
|
134 | + } |
|
135 | + } |
|
136 | + } |
|
137 | + |
|
138 | + |
|
139 | + /** |
|
140 | + * @param EE_Ticket $ticket |
|
141 | + * @param int $qty |
|
142 | + * @return void |
|
143 | + * @throws EE_Error |
|
144 | + */ |
|
145 | + public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0) |
|
146 | + { |
|
147 | + if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
148 | + // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
149 | + foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
150 | + // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
|
151 | + $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty; |
|
152 | + } |
|
153 | + } |
|
154 | + } |
|
155 | + |
|
156 | + |
|
157 | + /** |
|
158 | + * @param EE_Ticket $ticket |
|
159 | + * @param $qty |
|
160 | + * @param int $total_ticket_count |
|
161 | + * @throws EE_Error |
|
162 | + * @throws InvalidArgumentException |
|
163 | + * @throws InvalidDataTypeException |
|
164 | + * @throws InvalidInterfaceException |
|
165 | + */ |
|
166 | + public function processAvailabilityError(EE_Ticket $ticket, $qty, $total_ticket_count = 1) |
|
167 | + { |
|
168 | + // tickets can not be purchased but let's find the exact number left |
|
169 | + // for the last ticket selected PRIOR to subtracting tickets |
|
170 | + $available_spaces = $this->ticketDatetimeAvailability($ticket, true); |
|
171 | + // greedy greedy greedy eh? |
|
172 | + if ($available_spaces > 0) { |
|
173 | + if (apply_filters( |
|
174 | + 'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error', |
|
175 | + true, |
|
176 | + $ticket, |
|
177 | + $qty, |
|
178 | + $available_spaces |
|
179 | + )) { |
|
180 | + $this->availabilityError( |
|
181 | + $available_spaces, |
|
182 | + $total_ticket_count |
|
183 | + ); |
|
184 | + } |
|
185 | + } else { |
|
186 | + EE_Error::add_error( |
|
187 | + esc_html__( |
|
188 | + 'We\'re sorry, but there are no available spaces left for this event at this particular date and time.', |
|
189 | + 'event_espresso' |
|
190 | + ), |
|
191 | + __FILE__, |
|
192 | + __FUNCTION__, |
|
193 | + __LINE__ |
|
194 | + ); |
|
195 | + } |
|
196 | + } |
|
197 | + |
|
198 | + |
|
199 | + /** |
|
200 | + * @param int $available_spaces |
|
201 | + * @param int $total_ticket_count |
|
202 | + */ |
|
203 | + private function availabilityError($available_spaces = 1, $total_ticket_count = 1) |
|
204 | + { |
|
205 | + // add error messaging - we're using the _n function that will generate |
|
206 | + // the appropriate singular or plural message based on the number of $available_spaces |
|
207 | + if ($total_ticket_count) { |
|
208 | + $msg = sprintf( |
|
209 | + esc_html( |
|
210 | + _n( |
|
211 | + 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
212 | + 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
213 | + $available_spaces, |
|
214 | + 'event_espresso' |
|
215 | + ) |
|
216 | + ), |
|
217 | + $available_spaces, |
|
218 | + '<br />' |
|
219 | + ); |
|
220 | + } else { |
|
221 | + $msg = sprintf( |
|
222 | + esc_html( |
|
223 | + _n( |
|
224 | + 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
225 | + 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
226 | + $available_spaces, |
|
227 | + 'event_espresso' |
|
228 | + ) |
|
229 | + ), |
|
230 | + $available_spaces, |
|
231 | + '<br />' |
|
232 | + ); |
|
233 | + } |
|
234 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
235 | + } |
|
236 | 236 | } |
@@ -130,7 +130,7 @@ discard block |
||
130 | 130 | */ |
131 | 131 | private function setName($name) |
132 | 132 | { |
133 | - if (! is_string($name)) { |
|
133 | + if ( ! is_string($name)) { |
|
134 | 134 | throw new InvalidDataTypeException('$name', $name, 'string'); |
135 | 135 | } |
136 | 136 | $this->name = sanitize_key($name); |
@@ -154,7 +154,7 @@ discard block |
||
154 | 154 | */ |
155 | 155 | private function setMessage($message) |
156 | 156 | { |
157 | - if (! is_string($message)) { |
|
157 | + if ( ! is_string($message)) { |
|
158 | 158 | throw new InvalidDataTypeException('$message', $message, 'string'); |
159 | 159 | } |
160 | 160 | global $allowedtags; |
@@ -200,7 +200,7 @@ discard block |
||
200 | 200 | */ |
201 | 201 | private function setCapability($capability) |
202 | 202 | { |
203 | - if (! is_string($capability)) { |
|
203 | + if ( ! is_string($capability)) { |
|
204 | 204 | throw new InvalidDataTypeException('$capability', $capability, 'string'); |
205 | 205 | } |
206 | 206 | $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
@@ -224,7 +224,7 @@ discard block |
||
224 | 224 | */ |
225 | 225 | private function setCapContext($cap_context) |
226 | 226 | { |
227 | - if (! is_string($cap_context)) { |
|
227 | + if ( ! is_string($cap_context)) { |
|
228 | 228 | throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
229 | 229 | } |
230 | 230 | $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
@@ -258,7 +258,7 @@ discard block |
||
258 | 258 | */ |
259 | 259 | public function getCapCheck() |
260 | 260 | { |
261 | - if (! $this->cap_check instanceof CapCheckInterface) { |
|
261 | + if ( ! $this->cap_check instanceof CapCheckInterface) { |
|
262 | 262 | $this->setCapCheck( |
263 | 263 | new CapCheck( |
264 | 264 | $this->capability, |
@@ -343,10 +343,10 @@ discard block |
||
343 | 343 | */ |
344 | 344 | public function confirmRegistered() |
345 | 345 | { |
346 | - if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
346 | + if ( ! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
347 | 347 | PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
348 | 348 | } |
349 | - if (! $this->registered && WP_DEBUG) { |
|
349 | + if ( ! $this->registered && WP_DEBUG) { |
|
350 | 350 | throw new DomainException( |
351 | 351 | sprintf( |
352 | 352 | esc_html__( |
@@ -24,315 +24,315 @@ |
||
24 | 24 | class PersistentAdminNotice implements RequiresCapCheckInterface |
25 | 25 | { |
26 | 26 | |
27 | - /** |
|
28 | - * @var string $name |
|
29 | - */ |
|
30 | - protected $name = ''; |
|
31 | - |
|
32 | - /** |
|
33 | - * @var string $message |
|
34 | - */ |
|
35 | - protected $message = ''; |
|
36 | - |
|
37 | - /** |
|
38 | - * @var boolean $force_update |
|
39 | - */ |
|
40 | - protected $force_update = false; |
|
41 | - |
|
42 | - /** |
|
43 | - * @var string $capability |
|
44 | - */ |
|
45 | - protected $capability = 'manage_options'; |
|
46 | - |
|
47 | - /** |
|
48 | - * @var string $cap_context |
|
49 | - */ |
|
50 | - protected $cap_context = 'view persistent admin notice'; |
|
51 | - |
|
52 | - /** |
|
53 | - * @var boolean $dismissed |
|
54 | - */ |
|
55 | - protected $dismissed = false; |
|
56 | - |
|
57 | - /** |
|
58 | - * @var CapCheckInterface $cap_check |
|
59 | - */ |
|
60 | - protected $cap_check; |
|
61 | - |
|
62 | - /** |
|
63 | - * if true, then this notice will be deleted from the database |
|
64 | - * |
|
65 | - * @var boolean $purge |
|
66 | - */ |
|
67 | - protected $purge = false; |
|
68 | - |
|
69 | - /** |
|
70 | - * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager |
|
71 | - * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer |
|
72 | - * |
|
73 | - * @var boolean $registered |
|
74 | - */ |
|
75 | - private $registered = false; |
|
76 | - |
|
77 | - |
|
78 | - /** |
|
79 | - * PersistentAdminNotice constructor |
|
80 | - * |
|
81 | - * @param string $name [required] the name, or key of the Persistent Admin Notice to be stored |
|
82 | - * @param string $message [required] the message to be stored persistently until dismissed |
|
83 | - * @param bool $force_update enforce the reappearance of a persistent message |
|
84 | - * @param string $capability user capability required to view this notice |
|
85 | - * @param string $cap_context description for why the cap check is being performed |
|
86 | - * @param bool $dismissed whether or not the user has already dismissed/viewed this notice |
|
87 | - * @throws InvalidDataTypeException |
|
88 | - */ |
|
89 | - public function __construct( |
|
90 | - $name, |
|
91 | - $message, |
|
92 | - $force_update = false, |
|
93 | - $capability = 'manage_options', |
|
94 | - $cap_context = 'view persistent admin notice', |
|
95 | - $dismissed = false |
|
96 | - ) { |
|
97 | - $this->setName($name); |
|
98 | - $this->setMessage($message); |
|
99 | - $this->setForceUpdate($force_update); |
|
100 | - $this->setCapability($capability); |
|
101 | - $this->setCapContext($cap_context); |
|
102 | - $this->setDismissed($dismissed); |
|
103 | - add_action( |
|
104 | - 'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices', |
|
105 | - array($this, 'registerPersistentAdminNotice') |
|
106 | - ); |
|
107 | - add_action('shutdown', array($this, 'confirmRegistered'), 999); |
|
108 | - } |
|
109 | - |
|
110 | - |
|
111 | - /** |
|
112 | - * @return string |
|
113 | - */ |
|
114 | - public function getName() |
|
115 | - { |
|
116 | - return $this->name; |
|
117 | - } |
|
118 | - |
|
119 | - |
|
120 | - /** |
|
121 | - * @param string $name |
|
122 | - * @throws InvalidDataTypeException |
|
123 | - */ |
|
124 | - private function setName($name) |
|
125 | - { |
|
126 | - if (! is_string($name)) { |
|
127 | - throw new InvalidDataTypeException('$name', $name, 'string'); |
|
128 | - } |
|
129 | - $this->name = sanitize_key($name); |
|
130 | - } |
|
131 | - |
|
132 | - |
|
133 | - /** |
|
134 | - * @return string |
|
135 | - */ |
|
136 | - public function getMessage() |
|
137 | - { |
|
138 | - return $this->message; |
|
139 | - } |
|
140 | - |
|
141 | - |
|
142 | - /** |
|
143 | - * @param string $message |
|
144 | - * @throws InvalidDataTypeException |
|
145 | - */ |
|
146 | - private function setMessage($message) |
|
147 | - { |
|
148 | - if (! is_string($message)) { |
|
149 | - throw new InvalidDataTypeException('$message', $message, 'string'); |
|
150 | - } |
|
151 | - global $allowedtags; |
|
152 | - $allowedtags['br'] = array(); |
|
153 | - $this->message = wp_kses($message, $allowedtags); |
|
154 | - } |
|
155 | - |
|
156 | - |
|
157 | - /** |
|
158 | - * @return bool |
|
159 | - */ |
|
160 | - public function getForceUpdate() |
|
161 | - { |
|
162 | - return $this->force_update; |
|
163 | - } |
|
164 | - |
|
165 | - |
|
166 | - /** |
|
167 | - * @param bool $force_update |
|
168 | - */ |
|
169 | - private function setForceUpdate($force_update) |
|
170 | - { |
|
171 | - $this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN); |
|
172 | - } |
|
173 | - |
|
174 | - |
|
175 | - /** |
|
176 | - * @return string |
|
177 | - */ |
|
178 | - public function getCapability() |
|
179 | - { |
|
180 | - return $this->capability; |
|
181 | - } |
|
182 | - |
|
183 | - |
|
184 | - /** |
|
185 | - * @param string $capability |
|
186 | - * @throws InvalidDataTypeException |
|
187 | - */ |
|
188 | - private function setCapability($capability) |
|
189 | - { |
|
190 | - if (! is_string($capability)) { |
|
191 | - throw new InvalidDataTypeException('$capability', $capability, 'string'); |
|
192 | - } |
|
193 | - $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
|
194 | - } |
|
195 | - |
|
196 | - |
|
197 | - /** |
|
198 | - * @return string |
|
199 | - */ |
|
200 | - public function getCapContext() |
|
201 | - { |
|
202 | - return $this->cap_context; |
|
203 | - } |
|
204 | - |
|
205 | - |
|
206 | - /** |
|
207 | - * @param string $cap_context |
|
208 | - * @throws InvalidDataTypeException |
|
209 | - */ |
|
210 | - private function setCapContext($cap_context) |
|
211 | - { |
|
212 | - if (! is_string($cap_context)) { |
|
213 | - throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
|
214 | - } |
|
215 | - $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
|
216 | - } |
|
217 | - |
|
218 | - |
|
219 | - /** |
|
220 | - * @return bool |
|
221 | - */ |
|
222 | - public function getDismissed() |
|
223 | - { |
|
224 | - return $this->dismissed; |
|
225 | - } |
|
226 | - |
|
227 | - |
|
228 | - /** |
|
229 | - * @param bool $dismissed |
|
230 | - */ |
|
231 | - public function setDismissed($dismissed) |
|
232 | - { |
|
233 | - $this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN); |
|
234 | - } |
|
235 | - |
|
236 | - |
|
237 | - /** |
|
238 | - * @return CapCheckInterface |
|
239 | - * @throws InvalidDataTypeException |
|
240 | - */ |
|
241 | - public function getCapCheck() |
|
242 | - { |
|
243 | - if (! $this->cap_check instanceof CapCheckInterface) { |
|
244 | - $this->setCapCheck( |
|
245 | - new CapCheck( |
|
246 | - $this->capability, |
|
247 | - $this->cap_context |
|
248 | - ) |
|
249 | - ); |
|
250 | - } |
|
251 | - return $this->cap_check; |
|
252 | - } |
|
253 | - |
|
254 | - |
|
255 | - /** |
|
256 | - * @param CapCheckInterface $cap_check |
|
257 | - */ |
|
258 | - private function setCapCheck(CapCheckInterface $cap_check) |
|
259 | - { |
|
260 | - $this->cap_check = $cap_check; |
|
261 | - } |
|
262 | - |
|
263 | - |
|
264 | - /** |
|
265 | - * @return bool |
|
266 | - */ |
|
267 | - public function getPurge() |
|
268 | - { |
|
269 | - return $this->purge; |
|
270 | - } |
|
271 | - |
|
272 | - |
|
273 | - /** |
|
274 | - * @param bool $purge |
|
275 | - */ |
|
276 | - public function setPurge($purge) |
|
277 | - { |
|
278 | - $this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN); |
|
279 | - } |
|
280 | - |
|
281 | - |
|
282 | - /** |
|
283 | - * given a valid PersistentAdminNotice Collection, |
|
284 | - * this notice will be added if it is not already found in the collection (using its name as the identifier) |
|
285 | - * if an existing notice is found that has already been dismissed, |
|
286 | - * but we are overriding with a forced update, then we will toggle its dismissed state, |
|
287 | - * so that the notice is displayed again |
|
288 | - * |
|
289 | - * @param Collection $persistent_admin_notice_collection |
|
290 | - * @throws InvalidEntityException |
|
291 | - * @throws InvalidDataTypeException |
|
292 | - */ |
|
293 | - public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection) |
|
294 | - { |
|
295 | - if ($this->registered) { |
|
296 | - return; |
|
297 | - } |
|
298 | - // first check if this notice has already been added to the collection |
|
299 | - if ($persistent_admin_notice_collection->has($this->name)) { |
|
300 | - /** @var PersistentAdminNotice $existing */ |
|
301 | - $existing = $persistent_admin_notice_collection->get($this->name); |
|
302 | - // we don't need to add it again (we can't actually) |
|
303 | - // but if it has already been dismissed, and we are overriding with a forced update |
|
304 | - if ($existing->getDismissed() && $this->getForceUpdate()) { |
|
305 | - // then toggle the notice's dismissed state to true |
|
306 | - // so that it gets displayed again |
|
307 | - $existing->setDismissed(false); |
|
308 | - // and make sure the message is set |
|
309 | - $existing->setMessage($this->message); |
|
310 | - } |
|
311 | - } else { |
|
312 | - $persistent_admin_notice_collection->add($this, $this->name); |
|
313 | - } |
|
314 | - $this->registered = true; |
|
315 | - } |
|
316 | - |
|
317 | - |
|
318 | - /** |
|
319 | - * @throws Exception |
|
320 | - */ |
|
321 | - public function confirmRegistered() |
|
322 | - { |
|
323 | - if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
324 | - PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
|
325 | - } |
|
326 | - if (! $this->registered && WP_DEBUG) { |
|
327 | - throw new DomainException( |
|
328 | - sprintf( |
|
329 | - esc_html__( |
|
330 | - 'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.', |
|
331 | - 'event_espresso' |
|
332 | - ), |
|
333 | - $this->name |
|
334 | - ) |
|
335 | - ); |
|
336 | - } |
|
337 | - } |
|
27 | + /** |
|
28 | + * @var string $name |
|
29 | + */ |
|
30 | + protected $name = ''; |
|
31 | + |
|
32 | + /** |
|
33 | + * @var string $message |
|
34 | + */ |
|
35 | + protected $message = ''; |
|
36 | + |
|
37 | + /** |
|
38 | + * @var boolean $force_update |
|
39 | + */ |
|
40 | + protected $force_update = false; |
|
41 | + |
|
42 | + /** |
|
43 | + * @var string $capability |
|
44 | + */ |
|
45 | + protected $capability = 'manage_options'; |
|
46 | + |
|
47 | + /** |
|
48 | + * @var string $cap_context |
|
49 | + */ |
|
50 | + protected $cap_context = 'view persistent admin notice'; |
|
51 | + |
|
52 | + /** |
|
53 | + * @var boolean $dismissed |
|
54 | + */ |
|
55 | + protected $dismissed = false; |
|
56 | + |
|
57 | + /** |
|
58 | + * @var CapCheckInterface $cap_check |
|
59 | + */ |
|
60 | + protected $cap_check; |
|
61 | + |
|
62 | + /** |
|
63 | + * if true, then this notice will be deleted from the database |
|
64 | + * |
|
65 | + * @var boolean $purge |
|
66 | + */ |
|
67 | + protected $purge = false; |
|
68 | + |
|
69 | + /** |
|
70 | + * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager |
|
71 | + * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer |
|
72 | + * |
|
73 | + * @var boolean $registered |
|
74 | + */ |
|
75 | + private $registered = false; |
|
76 | + |
|
77 | + |
|
78 | + /** |
|
79 | + * PersistentAdminNotice constructor |
|
80 | + * |
|
81 | + * @param string $name [required] the name, or key of the Persistent Admin Notice to be stored |
|
82 | + * @param string $message [required] the message to be stored persistently until dismissed |
|
83 | + * @param bool $force_update enforce the reappearance of a persistent message |
|
84 | + * @param string $capability user capability required to view this notice |
|
85 | + * @param string $cap_context description for why the cap check is being performed |
|
86 | + * @param bool $dismissed whether or not the user has already dismissed/viewed this notice |
|
87 | + * @throws InvalidDataTypeException |
|
88 | + */ |
|
89 | + public function __construct( |
|
90 | + $name, |
|
91 | + $message, |
|
92 | + $force_update = false, |
|
93 | + $capability = 'manage_options', |
|
94 | + $cap_context = 'view persistent admin notice', |
|
95 | + $dismissed = false |
|
96 | + ) { |
|
97 | + $this->setName($name); |
|
98 | + $this->setMessage($message); |
|
99 | + $this->setForceUpdate($force_update); |
|
100 | + $this->setCapability($capability); |
|
101 | + $this->setCapContext($cap_context); |
|
102 | + $this->setDismissed($dismissed); |
|
103 | + add_action( |
|
104 | + 'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices', |
|
105 | + array($this, 'registerPersistentAdminNotice') |
|
106 | + ); |
|
107 | + add_action('shutdown', array($this, 'confirmRegistered'), 999); |
|
108 | + } |
|
109 | + |
|
110 | + |
|
111 | + /** |
|
112 | + * @return string |
|
113 | + */ |
|
114 | + public function getName() |
|
115 | + { |
|
116 | + return $this->name; |
|
117 | + } |
|
118 | + |
|
119 | + |
|
120 | + /** |
|
121 | + * @param string $name |
|
122 | + * @throws InvalidDataTypeException |
|
123 | + */ |
|
124 | + private function setName($name) |
|
125 | + { |
|
126 | + if (! is_string($name)) { |
|
127 | + throw new InvalidDataTypeException('$name', $name, 'string'); |
|
128 | + } |
|
129 | + $this->name = sanitize_key($name); |
|
130 | + } |
|
131 | + |
|
132 | + |
|
133 | + /** |
|
134 | + * @return string |
|
135 | + */ |
|
136 | + public function getMessage() |
|
137 | + { |
|
138 | + return $this->message; |
|
139 | + } |
|
140 | + |
|
141 | + |
|
142 | + /** |
|
143 | + * @param string $message |
|
144 | + * @throws InvalidDataTypeException |
|
145 | + */ |
|
146 | + private function setMessage($message) |
|
147 | + { |
|
148 | + if (! is_string($message)) { |
|
149 | + throw new InvalidDataTypeException('$message', $message, 'string'); |
|
150 | + } |
|
151 | + global $allowedtags; |
|
152 | + $allowedtags['br'] = array(); |
|
153 | + $this->message = wp_kses($message, $allowedtags); |
|
154 | + } |
|
155 | + |
|
156 | + |
|
157 | + /** |
|
158 | + * @return bool |
|
159 | + */ |
|
160 | + public function getForceUpdate() |
|
161 | + { |
|
162 | + return $this->force_update; |
|
163 | + } |
|
164 | + |
|
165 | + |
|
166 | + /** |
|
167 | + * @param bool $force_update |
|
168 | + */ |
|
169 | + private function setForceUpdate($force_update) |
|
170 | + { |
|
171 | + $this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN); |
|
172 | + } |
|
173 | + |
|
174 | + |
|
175 | + /** |
|
176 | + * @return string |
|
177 | + */ |
|
178 | + public function getCapability() |
|
179 | + { |
|
180 | + return $this->capability; |
|
181 | + } |
|
182 | + |
|
183 | + |
|
184 | + /** |
|
185 | + * @param string $capability |
|
186 | + * @throws InvalidDataTypeException |
|
187 | + */ |
|
188 | + private function setCapability($capability) |
|
189 | + { |
|
190 | + if (! is_string($capability)) { |
|
191 | + throw new InvalidDataTypeException('$capability', $capability, 'string'); |
|
192 | + } |
|
193 | + $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
|
194 | + } |
|
195 | + |
|
196 | + |
|
197 | + /** |
|
198 | + * @return string |
|
199 | + */ |
|
200 | + public function getCapContext() |
|
201 | + { |
|
202 | + return $this->cap_context; |
|
203 | + } |
|
204 | + |
|
205 | + |
|
206 | + /** |
|
207 | + * @param string $cap_context |
|
208 | + * @throws InvalidDataTypeException |
|
209 | + */ |
|
210 | + private function setCapContext($cap_context) |
|
211 | + { |
|
212 | + if (! is_string($cap_context)) { |
|
213 | + throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
|
214 | + } |
|
215 | + $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
|
216 | + } |
|
217 | + |
|
218 | + |
|
219 | + /** |
|
220 | + * @return bool |
|
221 | + */ |
|
222 | + public function getDismissed() |
|
223 | + { |
|
224 | + return $this->dismissed; |
|
225 | + } |
|
226 | + |
|
227 | + |
|
228 | + /** |
|
229 | + * @param bool $dismissed |
|
230 | + */ |
|
231 | + public function setDismissed($dismissed) |
|
232 | + { |
|
233 | + $this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN); |
|
234 | + } |
|
235 | + |
|
236 | + |
|
237 | + /** |
|
238 | + * @return CapCheckInterface |
|
239 | + * @throws InvalidDataTypeException |
|
240 | + */ |
|
241 | + public function getCapCheck() |
|
242 | + { |
|
243 | + if (! $this->cap_check instanceof CapCheckInterface) { |
|
244 | + $this->setCapCheck( |
|
245 | + new CapCheck( |
|
246 | + $this->capability, |
|
247 | + $this->cap_context |
|
248 | + ) |
|
249 | + ); |
|
250 | + } |
|
251 | + return $this->cap_check; |
|
252 | + } |
|
253 | + |
|
254 | + |
|
255 | + /** |
|
256 | + * @param CapCheckInterface $cap_check |
|
257 | + */ |
|
258 | + private function setCapCheck(CapCheckInterface $cap_check) |
|
259 | + { |
|
260 | + $this->cap_check = $cap_check; |
|
261 | + } |
|
262 | + |
|
263 | + |
|
264 | + /** |
|
265 | + * @return bool |
|
266 | + */ |
|
267 | + public function getPurge() |
|
268 | + { |
|
269 | + return $this->purge; |
|
270 | + } |
|
271 | + |
|
272 | + |
|
273 | + /** |
|
274 | + * @param bool $purge |
|
275 | + */ |
|
276 | + public function setPurge($purge) |
|
277 | + { |
|
278 | + $this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN); |
|
279 | + } |
|
280 | + |
|
281 | + |
|
282 | + /** |
|
283 | + * given a valid PersistentAdminNotice Collection, |
|
284 | + * this notice will be added if it is not already found in the collection (using its name as the identifier) |
|
285 | + * if an existing notice is found that has already been dismissed, |
|
286 | + * but we are overriding with a forced update, then we will toggle its dismissed state, |
|
287 | + * so that the notice is displayed again |
|
288 | + * |
|
289 | + * @param Collection $persistent_admin_notice_collection |
|
290 | + * @throws InvalidEntityException |
|
291 | + * @throws InvalidDataTypeException |
|
292 | + */ |
|
293 | + public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection) |
|
294 | + { |
|
295 | + if ($this->registered) { |
|
296 | + return; |
|
297 | + } |
|
298 | + // first check if this notice has already been added to the collection |
|
299 | + if ($persistent_admin_notice_collection->has($this->name)) { |
|
300 | + /** @var PersistentAdminNotice $existing */ |
|
301 | + $existing = $persistent_admin_notice_collection->get($this->name); |
|
302 | + // we don't need to add it again (we can't actually) |
|
303 | + // but if it has already been dismissed, and we are overriding with a forced update |
|
304 | + if ($existing->getDismissed() && $this->getForceUpdate()) { |
|
305 | + // then toggle the notice's dismissed state to true |
|
306 | + // so that it gets displayed again |
|
307 | + $existing->setDismissed(false); |
|
308 | + // and make sure the message is set |
|
309 | + $existing->setMessage($this->message); |
|
310 | + } |
|
311 | + } else { |
|
312 | + $persistent_admin_notice_collection->add($this, $this->name); |
|
313 | + } |
|
314 | + $this->registered = true; |
|
315 | + } |
|
316 | + |
|
317 | + |
|
318 | + /** |
|
319 | + * @throws Exception |
|
320 | + */ |
|
321 | + public function confirmRegistered() |
|
322 | + { |
|
323 | + if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
324 | + PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
|
325 | + } |
|
326 | + if (! $this->registered && WP_DEBUG) { |
|
327 | + throw new DomainException( |
|
328 | + sprintf( |
|
329 | + esc_html__( |
|
330 | + 'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.', |
|
331 | + 'event_espresso' |
|
332 | + ), |
|
333 | + $this->name |
|
334 | + ) |
|
335 | + ); |
|
336 | + } |
|
337 | + } |
|
338 | 338 | } |
@@ -14,133 +14,133 @@ |
||
14 | 14 | trait EventsAdmin |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * @param string $additional_params |
|
19 | - */ |
|
20 | - public function amOnDefaultEventsListTablePage($additional_params = '') |
|
21 | - { |
|
22 | - $this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params)); |
|
23 | - } |
|
24 | - |
|
25 | - |
|
26 | - /** |
|
27 | - * Triggers the publishing of the Event. |
|
28 | - */ |
|
29 | - public function publishEvent() |
|
30 | - { |
|
31 | - $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR); |
|
32 | - $this->actor()->wait(3); |
|
33 | - $this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR); |
|
34 | - $this->actor()->waitForText('Event published.', 30); |
|
35 | - } |
|
36 | - |
|
37 | - |
|
38 | - /** |
|
39 | - * Triggers saving the Event. |
|
40 | - */ |
|
41 | - public function saveEvent() |
|
42 | - { |
|
43 | - $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR); |
|
44 | - $this->actor()->wait(2); |
|
45 | - $this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR); |
|
46 | - } |
|
47 | - |
|
48 | - |
|
49 | - /** |
|
50 | - * Navigates the actor to the event list table page and will attempt to edit the event for the given title. |
|
51 | - * First this will search using the given title and then attempt to edit from the results of the search. |
|
52 | - * |
|
53 | - * Assumes actor is already logged in. |
|
54 | - * @param $event_title |
|
55 | - */ |
|
56 | - public function amEditingTheEventWithTitle($event_title) |
|
57 | - { |
|
58 | - $this->amOnDefaultEventsListTablePage(); |
|
59 | - $this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title); |
|
60 | - $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR); |
|
61 | - $this->actor()->waitForText($event_title, 15); |
|
62 | - $this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
63 | - } |
|
64 | - |
|
65 | - |
|
66 | - /** |
|
67 | - * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View" |
|
68 | - * link for the event in the event list table. |
|
69 | - * Assumes the actor is already logged in and on the Event list table page. |
|
70 | - * |
|
71 | - * @param string $event_title |
|
72 | - */ |
|
73 | - public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title) |
|
74 | - { |
|
75 | - $this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
76 | - $this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title)); |
|
77 | - } |
|
78 | - |
|
79 | - |
|
80 | - /** |
|
81 | - * Used to retrieve the event id for the event via the list table and for the given event. |
|
82 | - * @param string $event_title |
|
83 | - */ |
|
84 | - public function observeEventIdInListTableForEvent($event_title) |
|
85 | - { |
|
86 | - return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title)); |
|
87 | - } |
|
88 | - |
|
89 | - |
|
90 | - /** |
|
91 | - * This performs the click action on the gear icon that triggers the advanced settings view state. |
|
92 | - * Assumes the actor is already logged in and editing an event. |
|
93 | - * |
|
94 | - * @param int $row_number What ticket row to toggle open/close. |
|
95 | - */ |
|
96 | - public function toggleAdvancedSettingsViewForTicketRow($row_number = 1) |
|
97 | - { |
|
98 | - $this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number)); |
|
99 | - } |
|
100 | - |
|
101 | - |
|
102 | - /** |
|
103 | - * Toggles the TKT_is_taxable checkbox for the ticket in the given row. |
|
104 | - * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that |
|
105 | - * ticket is "open". |
|
106 | - * |
|
107 | - * @param int $row_number What ticket row to toggle the checkbox for. |
|
108 | - */ |
|
109 | - public function toggleTicketIsTaxableForTicketRow($row_number = 1) |
|
110 | - { |
|
111 | - $this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number)); |
|
112 | - } |
|
113 | - |
|
114 | - |
|
115 | - /** |
|
116 | - * Use to change the default registration status for the event. |
|
117 | - * Assumes the view is already on the event editor. |
|
118 | - * @param $registration_status |
|
119 | - */ |
|
120 | - public function changeDefaultRegistrationStatusTo($registration_status) |
|
121 | - { |
|
122 | - $this->actor()->selectOption( |
|
123 | - EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR, |
|
124 | - $registration_status |
|
125 | - ); |
|
126 | - } |
|
127 | - |
|
128 | - |
|
129 | - /** |
|
130 | - * Use this from the context of the event editor to select the given custom template for a given message type and |
|
131 | - * messenger. |
|
132 | - * |
|
133 | - * @param string $message_type_label The visible label for the message type (eg Registration Approved) |
|
134 | - * @param string $messenger_slug The slug for the messenger (eg 'email') |
|
135 | - * @param string $custom_template_label The visible label in the select input for the custom template you want |
|
136 | - * selected. |
|
137 | - */ |
|
138 | - public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label) |
|
139 | - { |
|
140 | - $this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)); |
|
141 | - $this->actor()->selectOption( |
|
142 | - EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label), |
|
143 | - $custom_template_label |
|
144 | - ); |
|
145 | - } |
|
17 | + /** |
|
18 | + * @param string $additional_params |
|
19 | + */ |
|
20 | + public function amOnDefaultEventsListTablePage($additional_params = '') |
|
21 | + { |
|
22 | + $this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params)); |
|
23 | + } |
|
24 | + |
|
25 | + |
|
26 | + /** |
|
27 | + * Triggers the publishing of the Event. |
|
28 | + */ |
|
29 | + public function publishEvent() |
|
30 | + { |
|
31 | + $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR); |
|
32 | + $this->actor()->wait(3); |
|
33 | + $this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR); |
|
34 | + $this->actor()->waitForText('Event published.', 30); |
|
35 | + } |
|
36 | + |
|
37 | + |
|
38 | + /** |
|
39 | + * Triggers saving the Event. |
|
40 | + */ |
|
41 | + public function saveEvent() |
|
42 | + { |
|
43 | + $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR); |
|
44 | + $this->actor()->wait(2); |
|
45 | + $this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR); |
|
46 | + } |
|
47 | + |
|
48 | + |
|
49 | + /** |
|
50 | + * Navigates the actor to the event list table page and will attempt to edit the event for the given title. |
|
51 | + * First this will search using the given title and then attempt to edit from the results of the search. |
|
52 | + * |
|
53 | + * Assumes actor is already logged in. |
|
54 | + * @param $event_title |
|
55 | + */ |
|
56 | + public function amEditingTheEventWithTitle($event_title) |
|
57 | + { |
|
58 | + $this->amOnDefaultEventsListTablePage(); |
|
59 | + $this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title); |
|
60 | + $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR); |
|
61 | + $this->actor()->waitForText($event_title, 15); |
|
62 | + $this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
63 | + } |
|
64 | + |
|
65 | + |
|
66 | + /** |
|
67 | + * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View" |
|
68 | + * link for the event in the event list table. |
|
69 | + * Assumes the actor is already logged in and on the Event list table page. |
|
70 | + * |
|
71 | + * @param string $event_title |
|
72 | + */ |
|
73 | + public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title) |
|
74 | + { |
|
75 | + $this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
76 | + $this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title)); |
|
77 | + } |
|
78 | + |
|
79 | + |
|
80 | + /** |
|
81 | + * Used to retrieve the event id for the event via the list table and for the given event. |
|
82 | + * @param string $event_title |
|
83 | + */ |
|
84 | + public function observeEventIdInListTableForEvent($event_title) |
|
85 | + { |
|
86 | + return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title)); |
|
87 | + } |
|
88 | + |
|
89 | + |
|
90 | + /** |
|
91 | + * This performs the click action on the gear icon that triggers the advanced settings view state. |
|
92 | + * Assumes the actor is already logged in and editing an event. |
|
93 | + * |
|
94 | + * @param int $row_number What ticket row to toggle open/close. |
|
95 | + */ |
|
96 | + public function toggleAdvancedSettingsViewForTicketRow($row_number = 1) |
|
97 | + { |
|
98 | + $this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number)); |
|
99 | + } |
|
100 | + |
|
101 | + |
|
102 | + /** |
|
103 | + * Toggles the TKT_is_taxable checkbox for the ticket in the given row. |
|
104 | + * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that |
|
105 | + * ticket is "open". |
|
106 | + * |
|
107 | + * @param int $row_number What ticket row to toggle the checkbox for. |
|
108 | + */ |
|
109 | + public function toggleTicketIsTaxableForTicketRow($row_number = 1) |
|
110 | + { |
|
111 | + $this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number)); |
|
112 | + } |
|
113 | + |
|
114 | + |
|
115 | + /** |
|
116 | + * Use to change the default registration status for the event. |
|
117 | + * Assumes the view is already on the event editor. |
|
118 | + * @param $registration_status |
|
119 | + */ |
|
120 | + public function changeDefaultRegistrationStatusTo($registration_status) |
|
121 | + { |
|
122 | + $this->actor()->selectOption( |
|
123 | + EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR, |
|
124 | + $registration_status |
|
125 | + ); |
|
126 | + } |
|
127 | + |
|
128 | + |
|
129 | + /** |
|
130 | + * Use this from the context of the event editor to select the given custom template for a given message type and |
|
131 | + * messenger. |
|
132 | + * |
|
133 | + * @param string $message_type_label The visible label for the message type (eg Registration Approved) |
|
134 | + * @param string $messenger_slug The slug for the messenger (eg 'email') |
|
135 | + * @param string $custom_template_label The visible label in the select input for the custom template you want |
|
136 | + * selected. |
|
137 | + */ |
|
138 | + public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label) |
|
139 | + { |
|
140 | + $this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)); |
|
141 | + $this->actor()->selectOption( |
|
142 | + EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label), |
|
143 | + $custom_template_label |
|
144 | + ); |
|
145 | + } |
|
146 | 146 | } |
147 | 147 | \ No newline at end of file |
@@ -101,7 +101,7 @@ |
||
101 | 101 | /** |
102 | 102 | * _get_table_filters |
103 | 103 | * |
104 | - * @return array |
|
104 | + * @return string[] |
|
105 | 105 | */ |
106 | 106 | protected function _get_table_filters() |
107 | 107 | { |
@@ -56,7 +56,7 @@ |
||
56 | 56 | . __( |
57 | 57 | 'Download Results', |
58 | 58 | 'event_espresso' |
59 | - ) . "'>"; |
|
59 | + )."'>"; |
|
60 | 60 | } |
61 | 61 | |
62 | 62 |
@@ -13,111 +13,111 @@ discard block |
||
13 | 13 | class Payment_Log_Admin_List_Table extends EE_Admin_List_Table |
14 | 14 | { |
15 | 15 | |
16 | - /** |
|
17 | - * @param \EE_Admin_Page $admin_page |
|
18 | - * @return Payment_Log_Admin_List_Table |
|
19 | - */ |
|
20 | - public function __construct($admin_page) |
|
21 | - { |
|
22 | - parent::__construct($admin_page); |
|
23 | - } |
|
24 | - |
|
25 | - |
|
26 | - /** |
|
27 | - * _setup_data |
|
28 | - * |
|
29 | - * @return void |
|
30 | - */ |
|
31 | - protected function _setup_data() |
|
32 | - { |
|
33 | - $this->_data = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page); |
|
34 | - // if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'trash') { |
|
35 | - // $this->_data = $this->_admin_page->get_trashed_questions($this->_per_page, $this->_current_page, false); |
|
36 | - // } else { |
|
37 | - // $this->_data = $this->_admin_page->get_questions($this->_per_page, $this->_current_page, false); |
|
38 | - // } |
|
39 | - $this->_all_data_count = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page, true); |
|
40 | - add_action( |
|
41 | - 'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', |
|
42 | - array($this, 'add_download_logs_checkbox') |
|
43 | - ); |
|
44 | - } |
|
45 | - |
|
46 | - |
|
47 | - /** |
|
48 | - * add_download_logs_checkbox |
|
49 | - * adds a checkbox to the bottom of the list table, instead of at the top with the rest of the filters |
|
50 | - * |
|
51 | - * @return void |
|
52 | - */ |
|
53 | - public function add_download_logs_checkbox() |
|
54 | - { |
|
55 | - echo "<input type='submit' class='button-primary' id='download_results' name='download_results' value='" |
|
56 | - . __( |
|
57 | - 'Download Results', |
|
58 | - 'event_espresso' |
|
59 | - ) . "'>"; |
|
60 | - } |
|
61 | - |
|
62 | - |
|
63 | - /** |
|
64 | - * _set_properties |
|
65 | - * |
|
66 | - * @return void |
|
67 | - */ |
|
68 | - protected function _set_properties() |
|
69 | - { |
|
70 | - $this->_wp_list_args = array( |
|
71 | - 'singular' => __('payment log', 'event_espresso'), |
|
72 | - 'plural' => __('payment logs', 'event_espresso'), |
|
73 | - 'ajax' => true, // for now, |
|
74 | - 'screen' => $this->_admin_page->get_current_screen()->id, |
|
75 | - ); |
|
76 | - $this->_columns = array( |
|
77 | - 'cb' => '<input type="checkbox" />', |
|
78 | - 'id' => __('ID', 'event_espresso'), |
|
79 | - 'LOG_time' => __('Time', 'event_espresso'), |
|
80 | - 'PMD_ID' => __('Payment Method', 'event_espresso'), |
|
81 | - 'TXN_ID' => __('Transaction ID', 'event_espresso'), |
|
82 | - ); |
|
83 | - $this->_sortable_columns = array( |
|
84 | - 'LOG_time' => array('LOG_time' => true), |
|
85 | - ); |
|
86 | - $this->_hidden_columns = array(); |
|
87 | - } |
|
88 | - |
|
89 | - |
|
90 | - /** |
|
91 | - * _get_table_filters |
|
92 | - * |
|
93 | - * @return array |
|
94 | - */ |
|
95 | - protected function _get_table_filters() |
|
96 | - { |
|
97 | - $filters = array(); |
|
98 | - // todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as methods. |
|
99 | - $payment_methods = EEM_Payment_Method::instance()->get_all(); |
|
100 | - $payment_method_names = array( |
|
101 | - array('id' => 'all', 'text' => __("All", 'event_espresso')), |
|
102 | - array('id' => '0', 'text' => __("Unknown Payment Method", 'event_espresso')), |
|
103 | - ); |
|
104 | - foreach ($payment_methods as $payment_method) { |
|
105 | - $payment_method_names[] = array('id' => $payment_method->ID(), 'text' => $payment_method->admin_name()); |
|
106 | - } |
|
107 | - $filters[] = EEH_Form_Fields::select_input( |
|
108 | - '_payment_method', |
|
109 | - $payment_method_names, |
|
110 | - isset($this->_req_data['_payment_method']) |
|
111 | - ? $this->_req_data['_payment_method'] : 'all' |
|
112 | - ); |
|
113 | - $start_date = isset($this->_req_data['payment-filter-start-date']) ? wp_strip_all_tags( |
|
114 | - $this->_req_data['payment-filter-start-date'] |
|
115 | - ) : date('m/d/Y', strtotime('-6 months')); |
|
116 | - $end_date = isset($this->_req_data['payment-filter-end-date']) ? wp_strip_all_tags( |
|
117 | - $this->_req_data['payment-filter-end-date'] |
|
118 | - ) : date('m/d/Y'); |
|
119 | - ob_start(); |
|
120 | - ?> |
|
16 | + /** |
|
17 | + * @param \EE_Admin_Page $admin_page |
|
18 | + * @return Payment_Log_Admin_List_Table |
|
19 | + */ |
|
20 | + public function __construct($admin_page) |
|
21 | + { |
|
22 | + parent::__construct($admin_page); |
|
23 | + } |
|
24 | + |
|
25 | + |
|
26 | + /** |
|
27 | + * _setup_data |
|
28 | + * |
|
29 | + * @return void |
|
30 | + */ |
|
31 | + protected function _setup_data() |
|
32 | + { |
|
33 | + $this->_data = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page); |
|
34 | + // if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'trash') { |
|
35 | + // $this->_data = $this->_admin_page->get_trashed_questions($this->_per_page, $this->_current_page, false); |
|
36 | + // } else { |
|
37 | + // $this->_data = $this->_admin_page->get_questions($this->_per_page, $this->_current_page, false); |
|
38 | + // } |
|
39 | + $this->_all_data_count = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page, true); |
|
40 | + add_action( |
|
41 | + 'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', |
|
42 | + array($this, 'add_download_logs_checkbox') |
|
43 | + ); |
|
44 | + } |
|
45 | + |
|
46 | + |
|
47 | + /** |
|
48 | + * add_download_logs_checkbox |
|
49 | + * adds a checkbox to the bottom of the list table, instead of at the top with the rest of the filters |
|
50 | + * |
|
51 | + * @return void |
|
52 | + */ |
|
53 | + public function add_download_logs_checkbox() |
|
54 | + { |
|
55 | + echo "<input type='submit' class='button-primary' id='download_results' name='download_results' value='" |
|
56 | + . __( |
|
57 | + 'Download Results', |
|
58 | + 'event_espresso' |
|
59 | + ) . "'>"; |
|
60 | + } |
|
61 | + |
|
62 | + |
|
63 | + /** |
|
64 | + * _set_properties |
|
65 | + * |
|
66 | + * @return void |
|
67 | + */ |
|
68 | + protected function _set_properties() |
|
69 | + { |
|
70 | + $this->_wp_list_args = array( |
|
71 | + 'singular' => __('payment log', 'event_espresso'), |
|
72 | + 'plural' => __('payment logs', 'event_espresso'), |
|
73 | + 'ajax' => true, // for now, |
|
74 | + 'screen' => $this->_admin_page->get_current_screen()->id, |
|
75 | + ); |
|
76 | + $this->_columns = array( |
|
77 | + 'cb' => '<input type="checkbox" />', |
|
78 | + 'id' => __('ID', 'event_espresso'), |
|
79 | + 'LOG_time' => __('Time', 'event_espresso'), |
|
80 | + 'PMD_ID' => __('Payment Method', 'event_espresso'), |
|
81 | + 'TXN_ID' => __('Transaction ID', 'event_espresso'), |
|
82 | + ); |
|
83 | + $this->_sortable_columns = array( |
|
84 | + 'LOG_time' => array('LOG_time' => true), |
|
85 | + ); |
|
86 | + $this->_hidden_columns = array(); |
|
87 | + } |
|
88 | + |
|
89 | + |
|
90 | + /** |
|
91 | + * _get_table_filters |
|
92 | + * |
|
93 | + * @return array |
|
94 | + */ |
|
95 | + protected function _get_table_filters() |
|
96 | + { |
|
97 | + $filters = array(); |
|
98 | + // todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as methods. |
|
99 | + $payment_methods = EEM_Payment_Method::instance()->get_all(); |
|
100 | + $payment_method_names = array( |
|
101 | + array('id' => 'all', 'text' => __("All", 'event_espresso')), |
|
102 | + array('id' => '0', 'text' => __("Unknown Payment Method", 'event_espresso')), |
|
103 | + ); |
|
104 | + foreach ($payment_methods as $payment_method) { |
|
105 | + $payment_method_names[] = array('id' => $payment_method->ID(), 'text' => $payment_method->admin_name()); |
|
106 | + } |
|
107 | + $filters[] = EEH_Form_Fields::select_input( |
|
108 | + '_payment_method', |
|
109 | + $payment_method_names, |
|
110 | + isset($this->_req_data['_payment_method']) |
|
111 | + ? $this->_req_data['_payment_method'] : 'all' |
|
112 | + ); |
|
113 | + $start_date = isset($this->_req_data['payment-filter-start-date']) ? wp_strip_all_tags( |
|
114 | + $this->_req_data['payment-filter-start-date'] |
|
115 | + ) : date('m/d/Y', strtotime('-6 months')); |
|
116 | + $end_date = isset($this->_req_data['payment-filter-end-date']) ? wp_strip_all_tags( |
|
117 | + $this->_req_data['payment-filter-end-date'] |
|
118 | + ) : date('m/d/Y'); |
|
119 | + ob_start(); |
|
120 | + ?> |
|
121 | 121 | <label for="txn-filter-start-date"><?php _e('Display Transactions from ', 'event_espresso'); ?></label> |
122 | 122 | <input id="payment-filter-start-date" class="datepicker" type="text" value="<?php echo $start_date; ?>" |
123 | 123 | name="payment-filter-start-date" size="15"/> |
@@ -125,124 +125,124 @@ discard block |
||
125 | 125 | <input id="payment-filter-end-date" class="datepicker" type="text" value="<?php echo $end_date; ?>" |
126 | 126 | name="payment-filter-end-date" size="15"/> |
127 | 127 | <?php |
128 | - $filters[] = ob_get_clean(); |
|
129 | - return $filters; |
|
130 | - } |
|
131 | - |
|
132 | - |
|
133 | - /** |
|
134 | - * _add_view_counts |
|
135 | - * |
|
136 | - * @return void |
|
137 | - */ |
|
138 | - protected function _add_view_counts() |
|
139 | - { |
|
140 | - $this->_views['all']['count'] = $this->_admin_page->get_payment_logs( |
|
141 | - $this->_per_page, |
|
142 | - $this->_current_page, |
|
143 | - true |
|
144 | - ); |
|
145 | - } |
|
146 | - |
|
147 | - |
|
148 | - /** |
|
149 | - * column_cb |
|
150 | - * |
|
151 | - * @param \EE_Change_Log $item |
|
152 | - * @return string |
|
153 | - */ |
|
154 | - public function column_cb($item) |
|
155 | - { |
|
156 | - return sprintf('<input type="checkbox" class="option_id" name="checkbox[%1$d]" value="%1$d" />', $item->ID()); |
|
157 | - } |
|
158 | - |
|
159 | - |
|
160 | - /** |
|
161 | - * column_id |
|
162 | - * |
|
163 | - * @param \EE_Change_Log $item |
|
164 | - * @return string |
|
165 | - */ |
|
166 | - public function column_id(EE_Change_Log $item) |
|
167 | - { |
|
168 | - $details_query_args = array( |
|
169 | - 'action' => 'payment_log_details', |
|
170 | - 'ID' => $item->ID(), |
|
171 | - ); |
|
172 | - $url = EE_Admin_Page::add_query_args_and_nonce($details_query_args, EE_PAYMENTS_ADMIN_URL); |
|
173 | - return "<a href='$url'>{$item->ID()}</a>"; |
|
174 | - } |
|
175 | - |
|
176 | - |
|
177 | - /** |
|
178 | - * column_LOG_time |
|
179 | - * |
|
180 | - * @param \EE_Change_Log $item |
|
181 | - * @return string |
|
182 | - */ |
|
183 | - public function column_LOG_time(EE_Change_Log $item) |
|
184 | - { |
|
185 | - return $item->get_datetime('LOG_time'); |
|
186 | - } |
|
187 | - |
|
188 | - |
|
189 | - /** |
|
190 | - * column_PMD_ID |
|
191 | - * |
|
192 | - * @param \EE_Change_Log $item |
|
193 | - * @return string |
|
194 | - */ |
|
195 | - public function column_PMD_ID(EE_Change_Log $item) |
|
196 | - { |
|
197 | - if ($item->object() instanceof EE_Payment_Method) { |
|
198 | - return $item->object()->admin_name(); |
|
199 | - } elseif ($item->object() instanceof EE_Payment && $item->object()->payment_method()) { |
|
200 | - return $item->object()->payment_method()->admin_name(); |
|
201 | - } elseif ($item->object() instanceof EE_Transaction) { |
|
202 | - return esc_html__('Unknown', 'event_espresso'); |
|
203 | - } else { |
|
204 | - return esc_html__("No longer exists", 'event_espresso'); |
|
205 | - } |
|
206 | - } |
|
207 | - |
|
208 | - |
|
209 | - /** |
|
210 | - * column_TXN_ID |
|
211 | - * |
|
212 | - * @param \EE_Change_Log $item |
|
213 | - * @return string |
|
214 | - */ |
|
215 | - public function column_TXN_ID(EE_Change_Log $item) |
|
216 | - { |
|
217 | - if ($item->object() instanceof EE_Payment) { |
|
218 | - $transaction_id = $item->object()->TXN_ID(); |
|
219 | - } elseif ($item->object() instanceof EE_Transaction) { |
|
220 | - $transaction_id = $item->object()->ID(); |
|
221 | - } else { |
|
222 | - $transaction_id = null; |
|
223 | - } |
|
224 | - if ($transaction_id |
|
225 | - && EE_Registry::instance()->CAP->current_user_can( |
|
226 | - 'ee_read_transaction', |
|
227 | - 'espresso_transactions_view_transaction', |
|
228 | - $transaction_id |
|
229 | - )) { |
|
230 | - $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
231 | - array('action' => 'view_transaction', 'TXN_ID' => $transaction_id), |
|
232 | - TXN_ADMIN_URL |
|
233 | - ); |
|
234 | - return '<a href="' |
|
235 | - . $view_txn_lnk_url |
|
236 | - . '" title="' |
|
237 | - . sprintf( |
|
238 | - esc_attr__('click to view transaction #%s', 'event_espresso'), |
|
239 | - $transaction_id |
|
240 | - ) |
|
241 | - . '">' |
|
242 | - . sprintf(esc_html__('view txn %s', 'event_espresso'), $transaction_id) |
|
243 | - . '</a>'; |
|
244 | - } |
|
245 | - // No transaction id or use can not view the transaction. |
|
246 | - return __("Unable to find transaction", 'event_espresso'); |
|
247 | - } |
|
128 | + $filters[] = ob_get_clean(); |
|
129 | + return $filters; |
|
130 | + } |
|
131 | + |
|
132 | + |
|
133 | + /** |
|
134 | + * _add_view_counts |
|
135 | + * |
|
136 | + * @return void |
|
137 | + */ |
|
138 | + protected function _add_view_counts() |
|
139 | + { |
|
140 | + $this->_views['all']['count'] = $this->_admin_page->get_payment_logs( |
|
141 | + $this->_per_page, |
|
142 | + $this->_current_page, |
|
143 | + true |
|
144 | + ); |
|
145 | + } |
|
146 | + |
|
147 | + |
|
148 | + /** |
|
149 | + * column_cb |
|
150 | + * |
|
151 | + * @param \EE_Change_Log $item |
|
152 | + * @return string |
|
153 | + */ |
|
154 | + public function column_cb($item) |
|
155 | + { |
|
156 | + return sprintf('<input type="checkbox" class="option_id" name="checkbox[%1$d]" value="%1$d" />', $item->ID()); |
|
157 | + } |
|
158 | + |
|
159 | + |
|
160 | + /** |
|
161 | + * column_id |
|
162 | + * |
|
163 | + * @param \EE_Change_Log $item |
|
164 | + * @return string |
|
165 | + */ |
|
166 | + public function column_id(EE_Change_Log $item) |
|
167 | + { |
|
168 | + $details_query_args = array( |
|
169 | + 'action' => 'payment_log_details', |
|
170 | + 'ID' => $item->ID(), |
|
171 | + ); |
|
172 | + $url = EE_Admin_Page::add_query_args_and_nonce($details_query_args, EE_PAYMENTS_ADMIN_URL); |
|
173 | + return "<a href='$url'>{$item->ID()}</a>"; |
|
174 | + } |
|
175 | + |
|
176 | + |
|
177 | + /** |
|
178 | + * column_LOG_time |
|
179 | + * |
|
180 | + * @param \EE_Change_Log $item |
|
181 | + * @return string |
|
182 | + */ |
|
183 | + public function column_LOG_time(EE_Change_Log $item) |
|
184 | + { |
|
185 | + return $item->get_datetime('LOG_time'); |
|
186 | + } |
|
187 | + |
|
188 | + |
|
189 | + /** |
|
190 | + * column_PMD_ID |
|
191 | + * |
|
192 | + * @param \EE_Change_Log $item |
|
193 | + * @return string |
|
194 | + */ |
|
195 | + public function column_PMD_ID(EE_Change_Log $item) |
|
196 | + { |
|
197 | + if ($item->object() instanceof EE_Payment_Method) { |
|
198 | + return $item->object()->admin_name(); |
|
199 | + } elseif ($item->object() instanceof EE_Payment && $item->object()->payment_method()) { |
|
200 | + return $item->object()->payment_method()->admin_name(); |
|
201 | + } elseif ($item->object() instanceof EE_Transaction) { |
|
202 | + return esc_html__('Unknown', 'event_espresso'); |
|
203 | + } else { |
|
204 | + return esc_html__("No longer exists", 'event_espresso'); |
|
205 | + } |
|
206 | + } |
|
207 | + |
|
208 | + |
|
209 | + /** |
|
210 | + * column_TXN_ID |
|
211 | + * |
|
212 | + * @param \EE_Change_Log $item |
|
213 | + * @return string |
|
214 | + */ |
|
215 | + public function column_TXN_ID(EE_Change_Log $item) |
|
216 | + { |
|
217 | + if ($item->object() instanceof EE_Payment) { |
|
218 | + $transaction_id = $item->object()->TXN_ID(); |
|
219 | + } elseif ($item->object() instanceof EE_Transaction) { |
|
220 | + $transaction_id = $item->object()->ID(); |
|
221 | + } else { |
|
222 | + $transaction_id = null; |
|
223 | + } |
|
224 | + if ($transaction_id |
|
225 | + && EE_Registry::instance()->CAP->current_user_can( |
|
226 | + 'ee_read_transaction', |
|
227 | + 'espresso_transactions_view_transaction', |
|
228 | + $transaction_id |
|
229 | + )) { |
|
230 | + $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
231 | + array('action' => 'view_transaction', 'TXN_ID' => $transaction_id), |
|
232 | + TXN_ADMIN_URL |
|
233 | + ); |
|
234 | + return '<a href="' |
|
235 | + . $view_txn_lnk_url |
|
236 | + . '" title="' |
|
237 | + . sprintf( |
|
238 | + esc_attr__('click to view transaction #%s', 'event_espresso'), |
|
239 | + $transaction_id |
|
240 | + ) |
|
241 | + . '">' |
|
242 | + . sprintf(esc_html__('view txn %s', 'event_espresso'), $transaction_id) |
|
243 | + . '</a>'; |
|
244 | + } |
|
245 | + // No transaction id or use can not view the transaction. |
|
246 | + return __("Unable to find transaction", 'event_espresso'); |
|
247 | + } |
|
248 | 248 | } |
@@ -2,11 +2,9 @@ |
||
2 | 2 | namespace EventEspresso\core\libraries\rest_api; |
3 | 3 | |
4 | 4 | use DomainException; |
5 | -use EE_Capabilities; |
|
6 | 5 | use EE_Datetime_Field; |
7 | 6 | use EE_Error; |
8 | 7 | use EE_Infinite_Integer_Field; |
9 | -use EE_Maybe_Serialized_Simple_HTML_Field; |
|
10 | 8 | use EE_Model_Field_Base; |
11 | 9 | use EE_Serialized_Text_Field; |
12 | 10 | use EEM_Base; |
@@ -60,7 +60,7 @@ discard block |
||
60 | 60 | ) { |
61 | 61 | $new_value_maybe_array = array(); |
62 | 62 | foreach ($original_value_maybe_array as $array_key => $array_item) { |
63 | - $new_value_maybe_array[ $array_key ] = ModelDataTranslator::prepareFieldValueFromJson( |
|
63 | + $new_value_maybe_array[$array_key] = ModelDataTranslator::prepareFieldValueFromJson( |
|
64 | 64 | $field_obj, |
65 | 65 | $array_item, |
66 | 66 | $requested_version, |
@@ -92,7 +92,7 @@ discard block |
||
92 | 92 | if (is_array($original_value_maybe_array)) { |
93 | 93 | $new_value = array(); |
94 | 94 | foreach ($original_value_maybe_array as $key => $value) { |
95 | - $new_value[ $key ] = ModelDataTranslator::prepareFieldValuesForJson( |
|
95 | + $new_value[$key] = ModelDataTranslator::prepareFieldValuesForJson( |
|
96 | 96 | $field_obj, |
97 | 97 | $value, |
98 | 98 | $request_version |
@@ -225,7 +225,7 @@ discard block |
||
225 | 225 | '0', |
226 | 226 | STR_PAD_LEFT |
227 | 227 | ); |
228 | - return $original_timestamp . $offset_sign . $offset_string; |
|
228 | + return $original_timestamp.$offset_sign.$offset_string; |
|
229 | 229 | } |
230 | 230 | |
231 | 231 | |
@@ -302,7 +302,7 @@ discard block |
||
302 | 302 | // first, check if its a MySQL timestamp in GMT |
303 | 303 | $datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value); |
304 | 304 | } |
305 | - if (! $datetime_obj instanceof \DateTime) { |
|
305 | + if ( ! $datetime_obj instanceof \DateTime) { |
|
306 | 306 | // so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format? |
307 | 307 | $datetime_obj = $field_obj->prepare_for_set($original_value); |
308 | 308 | } |
@@ -328,7 +328,7 @@ discard block |
||
328 | 328 | $original_value, |
329 | 329 | $field_obj->get_name(), |
330 | 330 | $field_obj->get_model_name(), |
331 | - $field_obj->get_time_format() . ' ' . $field_obj->get_time_format() |
|
331 | + $field_obj->get_time_format().' '.$field_obj->get_time_format() |
|
332 | 332 | ) |
333 | 333 | ); |
334 | 334 | } |
@@ -338,7 +338,7 @@ discard block |
||
338 | 338 | } |
339 | 339 | // are we about to send an object? just don't. We have no good way to represent it in JSON. |
340 | 340 | // can't just check using is_object() because that missed PHP incomplete objects |
341 | - if (! ModelDataTranslator::isRepresentableInJson($new_value)) { |
|
341 | + if ( ! ModelDataTranslator::isRepresentableInJson($new_value)) { |
|
342 | 342 | $new_value = array( |
343 | 343 | 'error_code' => 'php_object_not_return', |
344 | 344 | 'error_message' => esc_html__( |
@@ -391,7 +391,7 @@ discard block |
||
391 | 391 | $model |
392 | 392 | ); |
393 | 393 | // double-check is it a *_gmt field? |
394 | - if (! $field instanceof EE_Model_Field_Base |
|
394 | + if ( ! $field instanceof EE_Model_Field_Base |
|
395 | 395 | && ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars) |
396 | 396 | ) { |
397 | 397 | // yep, take off '_gmt', and find the field |
@@ -410,8 +410,8 @@ discard block |
||
410 | 410 | $timezone = $model->get_timezone(); |
411 | 411 | } |
412 | 412 | if ($field instanceof EE_Model_Field_Base) { |
413 | - if (! $writing && is_array($query_param_value)) { |
|
414 | - if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) { |
|
413 | + if ( ! $writing && is_array($query_param_value)) { |
|
414 | + if ( ! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) { |
|
415 | 415 | if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) { |
416 | 416 | throw new RestException( |
417 | 417 | 'numerically_indexed_array_of_values_only', |
@@ -430,7 +430,7 @@ discard block |
||
430 | 430 | } |
431 | 431 | // did they specify an operator? |
432 | 432 | if (isset($query_param_value[0]) |
433 | - && isset($valid_operators[ $query_param_value[0] ]) |
|
433 | + && isset($valid_operators[$query_param_value[0]]) |
|
434 | 434 | ) { |
435 | 435 | $op = $query_param_value[0]; |
436 | 436 | $translated_value = array($op); |
@@ -539,7 +539,7 @@ discard block |
||
539 | 539 | $timezone |
540 | 540 | ); |
541 | 541 | } |
542 | - if ((isset($query_param_for_models[ $query_param_key ]) && $is_gmt_datetime_field) |
|
542 | + if ((isset($query_param_for_models[$query_param_key]) && $is_gmt_datetime_field) |
|
543 | 543 | || $translated_value === null |
544 | 544 | ) { |
545 | 545 | // they have already provided a non-gmt field, ignore the gmt one. That's what WP core |
@@ -547,7 +547,7 @@ discard block |
||
547 | 547 | // OR we couldn't create a translated value from their input |
548 | 548 | continue; |
549 | 549 | } |
550 | - $query_param_for_models[ $query_param_key ] = $translated_value; |
|
550 | + $query_param_for_models[$query_param_key] = $translated_value; |
|
551 | 551 | } else { |
552 | 552 | // so this param doesn't correspond to a field eh? |
553 | 553 | if ($writing) { |
@@ -566,7 +566,7 @@ discard block |
||
566 | 566 | $query_param_sans_stars, |
567 | 567 | $model->logic_query_param_keys() |
568 | 568 | )) { |
569 | - $query_param_for_models[ $query_param_key ] = ModelDataTranslator::prepareConditionsQueryParamsForModels( |
|
569 | + $query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForModels( |
|
570 | 570 | $query_param_value, |
571 | 571 | $model, |
572 | 572 | $requested_version |
@@ -620,7 +620,7 @@ discard block |
||
620 | 620 | */ |
621 | 621 | public static function removeGmtFromFieldName($field_name) |
622 | 622 | { |
623 | - if (! ModelDataTranslator::isGmtDateFieldName($field_name)) { |
|
623 | + if ( ! ModelDataTranslator::isGmtDateFieldName($field_name)) { |
|
624 | 624 | return $field_name; |
625 | 625 | } |
626 | 626 | $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey( |
@@ -663,7 +663,7 @@ discard block |
||
663 | 663 | { |
664 | 664 | $new_array = array(); |
665 | 665 | foreach ($field_names as $key => $field_name) { |
666 | - $new_array[ $key ] = ModelDataTranslator::prepareFieldNameFromJson($field_name); |
|
666 | + $new_array[$key] = ModelDataTranslator::prepareFieldNameFromJson($field_name); |
|
667 | 667 | } |
668 | 668 | return $new_array; |
669 | 669 | } |
@@ -680,7 +680,7 @@ discard block |
||
680 | 680 | { |
681 | 681 | $new_array = array(); |
682 | 682 | foreach ($field_names_as_keys as $field_name => $value) { |
683 | - $new_array[ ModelDataTranslator::prepareFieldNameFromJson($field_name) ] = $value; |
|
683 | + $new_array[ModelDataTranslator::prepareFieldNameFromJson($field_name)] = $value; |
|
684 | 684 | } |
685 | 685 | return $new_array; |
686 | 686 | } |
@@ -773,10 +773,10 @@ discard block |
||
773 | 773 | $requested_version |
774 | 774 | ); |
775 | 775 | } |
776 | - $query_param_for_models[ $query_param_key ] = $translated_value; |
|
776 | + $query_param_for_models[$query_param_key] = $translated_value; |
|
777 | 777 | } else { |
778 | 778 | // so it's not for a field, assume it's a logic query param key |
779 | - $query_param_for_models[ $query_param_key ] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi( |
|
779 | + $query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi( |
|
780 | 780 | $query_param_value, |
781 | 781 | $model, |
782 | 782 | $requested_version |
@@ -828,13 +828,13 @@ discard block |
||
828 | 828 | ); |
829 | 829 | } |
830 | 830 | $number_of_parts = count($query_param_parts); |
831 | - $last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ]; |
|
831 | + $last_query_param_part = $query_param_parts[count($query_param_parts) - 1]; |
|
832 | 832 | if ($number_of_parts === 1) { |
833 | 833 | $field_name = $last_query_param_part; |
834 | 834 | } else {// $number_of_parts >= 2 |
835 | 835 | // the last part is the column name, and there are only 2parts. therefore... |
836 | 836 | $field_name = $last_query_param_part; |
837 | - $model = \EE_Registry::instance()->load_model($query_param_parts[ $number_of_parts - 2 ]); |
|
837 | + $model = \EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]); |
|
838 | 838 | } |
839 | 839 | try { |
840 | 840 | return $model->field_settings_for($field_name, false); |
@@ -32,834 +32,834 @@ |
||
32 | 32 | class ModelDataTranslator |
33 | 33 | { |
34 | 34 | |
35 | - /** |
|
36 | - * We used to use -1 for infinity in the rest api, but that's ambiguous for |
|
37 | - * fields that COULD contain -1; so we use null |
|
38 | - */ |
|
39 | - const EE_INF_IN_REST = null; |
|
40 | - |
|
41 | - |
|
42 | - /** |
|
43 | - * Prepares a possible array of input values from JSON for use by the models |
|
44 | - * |
|
45 | - * @param EE_Model_Field_Base $field_obj |
|
46 | - * @param mixed $original_value_maybe_array |
|
47 | - * @param string $requested_version |
|
48 | - * @param string $timezone_string treat values as being in this timezone |
|
49 | - * @return mixed |
|
50 | - * @throws RestException |
|
51 | - */ |
|
52 | - public static function prepareFieldValuesFromJson( |
|
53 | - $field_obj, |
|
54 | - $original_value_maybe_array, |
|
55 | - $requested_version, |
|
56 | - $timezone_string = 'UTC' |
|
57 | - ) { |
|
58 | - if (is_array($original_value_maybe_array) |
|
59 | - && ! $field_obj instanceof EE_Serialized_Text_Field |
|
60 | - ) { |
|
61 | - $new_value_maybe_array = array(); |
|
62 | - foreach ($original_value_maybe_array as $array_key => $array_item) { |
|
63 | - $new_value_maybe_array[ $array_key ] = ModelDataTranslator::prepareFieldValueFromJson( |
|
64 | - $field_obj, |
|
65 | - $array_item, |
|
66 | - $requested_version, |
|
67 | - $timezone_string |
|
68 | - ); |
|
69 | - } |
|
70 | - } else { |
|
71 | - $new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson( |
|
72 | - $field_obj, |
|
73 | - $original_value_maybe_array, |
|
74 | - $requested_version, |
|
75 | - $timezone_string |
|
76 | - ); |
|
77 | - } |
|
78 | - return $new_value_maybe_array; |
|
79 | - } |
|
80 | - |
|
81 | - |
|
82 | - /** |
|
83 | - * Prepares an array of field values FOR use in JSON/REST API |
|
84 | - * |
|
85 | - * @param EE_Model_Field_Base $field_obj |
|
86 | - * @param mixed $original_value_maybe_array |
|
87 | - * @param string $request_version (eg 4.8.36) |
|
88 | - * @return array |
|
89 | - */ |
|
90 | - public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version) |
|
91 | - { |
|
92 | - if (is_array($original_value_maybe_array)) { |
|
93 | - $new_value = array(); |
|
94 | - foreach ($original_value_maybe_array as $key => $value) { |
|
95 | - $new_value[ $key ] = ModelDataTranslator::prepareFieldValuesForJson( |
|
96 | - $field_obj, |
|
97 | - $value, |
|
98 | - $request_version |
|
99 | - ); |
|
100 | - } |
|
101 | - } else { |
|
102 | - $new_value = ModelDataTranslator::prepareFieldValueForJson( |
|
103 | - $field_obj, |
|
104 | - $original_value_maybe_array, |
|
105 | - $request_version |
|
106 | - ); |
|
107 | - } |
|
108 | - return $new_value; |
|
109 | - } |
|
110 | - |
|
111 | - |
|
112 | - /** |
|
113 | - * Prepares incoming data from the json or $_REQUEST parameters for the models' |
|
114 | - * "$query_params". |
|
115 | - * |
|
116 | - * @param EE_Model_Field_Base $field_obj |
|
117 | - * @param mixed $original_value |
|
118 | - * @param string $requested_version |
|
119 | - * @param string $timezone_string treat values as being in this timezone |
|
120 | - * @return mixed |
|
121 | - * @throws RestException |
|
122 | - * @throws DomainException |
|
123 | - * @throws EE_Error |
|
124 | - */ |
|
125 | - public static function prepareFieldValueFromJson( |
|
126 | - $field_obj, |
|
127 | - $original_value, |
|
128 | - $requested_version, |
|
129 | - $timezone_string = 'UTC' // UTC |
|
130 | - ) { |
|
131 | - // check if they accidentally submitted an error value. If so throw an exception |
|
132 | - if (is_array($original_value) |
|
133 | - && isset($original_value['error_code'], $original_value['error_message'])) { |
|
134 | - throw new RestException( |
|
135 | - 'rest_submitted_error_value', |
|
136 | - sprintf( |
|
137 | - esc_html__( |
|
138 | - 'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.', |
|
139 | - 'event_espresso' |
|
140 | - ), |
|
141 | - $field_obj->get_name() |
|
142 | - ), |
|
143 | - array( |
|
144 | - 'status' => 400, |
|
145 | - ) |
|
146 | - ); |
|
147 | - } |
|
148 | - // double-check for serialized PHP. We never accept serialized PHP. No way Jose. |
|
149 | - ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value); |
|
150 | - $timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', ''); |
|
151 | - $new_value = null; |
|
152 | - // walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No |
|
153 | - // way Jose. |
|
154 | - ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value); |
|
155 | - if ($field_obj instanceof EE_Infinite_Integer_Field |
|
156 | - && in_array($original_value, array(null, ''), true) |
|
157 | - ) { |
|
158 | - $new_value = EE_INF; |
|
159 | - } elseif ($field_obj instanceof EE_Datetime_Field) { |
|
160 | - $new_value = rest_parse_date( |
|
161 | - self::getTimestampWithTimezoneOffset($original_value, $field_obj, $timezone_string) |
|
162 | - ); |
|
163 | - if ($new_value === false) { |
|
164 | - throw new RestException( |
|
165 | - 'invalid_format_for_timestamp', |
|
166 | - sprintf( |
|
167 | - esc_html__( |
|
168 | - 'Timestamps received on a request as the value for Date and Time fields must be in %1$s/%2$s format. The timestamp provided (%3$s) is not that format.', |
|
169 | - 'event_espresso' |
|
170 | - ), |
|
171 | - 'RFC3339', |
|
172 | - 'ISO8601', |
|
173 | - $original_value |
|
174 | - ), |
|
175 | - array( |
|
176 | - 'status' => 400, |
|
177 | - ) |
|
178 | - ); |
|
179 | - } |
|
180 | - } else { |
|
181 | - $new_value = $original_value; |
|
182 | - } |
|
183 | - return $new_value; |
|
184 | - } |
|
185 | - |
|
186 | - |
|
187 | - /** |
|
188 | - * This checks if the incoming timestamp has timezone information already on it and if it doesn't then adds timezone |
|
189 | - * information via details obtained from the host site. |
|
190 | - * |
|
191 | - * @param string $original_timestamp |
|
192 | - * @param EE_Datetime_Field $datetime_field |
|
193 | - * @param $timezone_string |
|
194 | - * @return string |
|
195 | - * @throws DomainException |
|
196 | - */ |
|
197 | - private static function getTimestampWithTimezoneOffset( |
|
198 | - $original_timestamp, |
|
199 | - EE_Datetime_Field $datetime_field, |
|
200 | - $timezone_string |
|
201 | - ) { |
|
202 | - // already have timezone information? |
|
203 | - if (preg_match('/Z|(\+|\-)(\d{2}:\d{2})/', $original_timestamp)) { |
|
204 | - // yes, we're ignoring the timezone. |
|
205 | - return $original_timestamp; |
|
206 | - } |
|
207 | - // need to append timezone |
|
208 | - list($offset_sign, $offset_secs) = self::parseTimezoneOffset( |
|
209 | - $datetime_field->get_timezone_offset( |
|
210 | - new \DateTimeZone($timezone_string), |
|
211 | - $original_timestamp |
|
212 | - ) |
|
213 | - ); |
|
214 | - $offset_string = |
|
215 | - str_pad( |
|
216 | - floor($offset_secs / HOUR_IN_SECONDS), |
|
217 | - 2, |
|
218 | - '0', |
|
219 | - STR_PAD_LEFT |
|
220 | - ) |
|
221 | - . ':' |
|
222 | - . str_pad( |
|
223 | - ($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS, |
|
224 | - 2, |
|
225 | - '0', |
|
226 | - STR_PAD_LEFT |
|
227 | - ); |
|
228 | - return $original_timestamp . $offset_sign . $offset_string; |
|
229 | - } |
|
230 | - |
|
231 | - |
|
232 | - /** |
|
233 | - * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't |
|
234 | - * think that can happen). If $data is an array, recurses into its keys and values |
|
235 | - * |
|
236 | - * @param mixed $data |
|
237 | - * @throws RestException |
|
238 | - * @return void |
|
239 | - */ |
|
240 | - public static function throwExceptionIfContainsSerializedData($data) |
|
241 | - { |
|
242 | - if (is_array($data)) { |
|
243 | - foreach ($data as $key => $value) { |
|
244 | - ModelDataTranslator::throwExceptionIfContainsSerializedData($key); |
|
245 | - ModelDataTranslator::throwExceptionIfContainsSerializedData($value); |
|
246 | - } |
|
247 | - } else { |
|
248 | - if (is_serialized($data) || is_object($data)) { |
|
249 | - throw new RestException( |
|
250 | - 'serialized_data_submission_prohibited', |
|
251 | - esc_html__( |
|
252 | - // @codingStandardsIgnoreStart |
|
253 | - 'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.', |
|
254 | - // @codingStandardsIgnoreEnd |
|
255 | - 'event_espresso' |
|
256 | - ) |
|
257 | - ); |
|
258 | - } |
|
259 | - } |
|
260 | - } |
|
261 | - |
|
262 | - |
|
263 | - /** |
|
264 | - * determines what's going on with them timezone strings |
|
265 | - * |
|
266 | - * @param int $timezone_offset |
|
267 | - * @return array |
|
268 | - */ |
|
269 | - private static function parseTimezoneOffset($timezone_offset) |
|
270 | - { |
|
271 | - $first_char = substr((string) $timezone_offset, 0, 1); |
|
272 | - if ($first_char === '+' || $first_char === '-') { |
|
273 | - $offset_sign = $first_char; |
|
274 | - $offset_secs = substr((string) $timezone_offset, 1); |
|
275 | - } else { |
|
276 | - $offset_sign = '+'; |
|
277 | - $offset_secs = $timezone_offset; |
|
278 | - } |
|
279 | - return array($offset_sign, $offset_secs); |
|
280 | - } |
|
281 | - |
|
282 | - |
|
283 | - /** |
|
284 | - * Prepares a field's value for display in the API |
|
285 | - * |
|
286 | - * @param EE_Model_Field_Base $field_obj |
|
287 | - * @param mixed $original_value |
|
288 | - * @param string $requested_version |
|
289 | - * @return mixed |
|
290 | - */ |
|
291 | - public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version) |
|
292 | - { |
|
293 | - if ($original_value === EE_INF) { |
|
294 | - $new_value = ModelDataTranslator::EE_INF_IN_REST; |
|
295 | - } elseif ($field_obj instanceof EE_Datetime_Field) { |
|
296 | - if (is_string($original_value)) { |
|
297 | - // did they submit a string of a unix timestamp? |
|
298 | - if (is_numeric($original_value)) { |
|
299 | - $datetime_obj = new \DateTime(); |
|
300 | - $datetime_obj->setTimestamp((int) $original_value); |
|
301 | - } else { |
|
302 | - // first, check if its a MySQL timestamp in GMT |
|
303 | - $datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value); |
|
304 | - } |
|
305 | - if (! $datetime_obj instanceof \DateTime) { |
|
306 | - // so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format? |
|
307 | - $datetime_obj = $field_obj->prepare_for_set($original_value); |
|
308 | - } |
|
309 | - $original_value = $datetime_obj; |
|
310 | - } |
|
311 | - if ($original_value instanceof \DateTime) { |
|
312 | - $new_value = $original_value->format('Y-m-d H:i:s'); |
|
313 | - } elseif (is_int($original_value) || is_float($original_value)) { |
|
314 | - $new_value = date('Y-m-d H:i:s', $original_value); |
|
315 | - } elseif ($original_value === null || $original_value === '') { |
|
316 | - $new_value = null; |
|
317 | - } else { |
|
318 | - // so it's not a datetime object, unix timestamp (as string or int), |
|
319 | - // MySQL timestamp, or even a string in the field object's format. So no idea what it is |
|
320 | - throw new \EE_Error( |
|
321 | - sprintf( |
|
322 | - esc_html__( |
|
323 | - // @codingStandardsIgnoreStart |
|
324 | - 'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".', |
|
325 | - // @codingStandardsIgnoreEnd |
|
326 | - 'event_espresso' |
|
327 | - ), |
|
328 | - $original_value, |
|
329 | - $field_obj->get_name(), |
|
330 | - $field_obj->get_model_name(), |
|
331 | - $field_obj->get_time_format() . ' ' . $field_obj->get_time_format() |
|
332 | - ) |
|
333 | - ); |
|
334 | - } |
|
335 | - $new_value = mysql_to_rfc3339($new_value); |
|
336 | - } else { |
|
337 | - $new_value = $original_value; |
|
338 | - } |
|
339 | - // are we about to send an object? just don't. We have no good way to represent it in JSON. |
|
340 | - // can't just check using is_object() because that missed PHP incomplete objects |
|
341 | - if (! ModelDataTranslator::isRepresentableInJson($new_value)) { |
|
342 | - $new_value = array( |
|
343 | - 'error_code' => 'php_object_not_return', |
|
344 | - 'error_message' => esc_html__( |
|
345 | - 'The value of this field in the database is a PHP object, which can\'t be represented in JSON.', |
|
346 | - 'event_espresso' |
|
347 | - ), |
|
348 | - ); |
|
349 | - } |
|
350 | - return apply_filters( |
|
351 | - 'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api', |
|
352 | - $new_value, |
|
353 | - $field_obj, |
|
354 | - $original_value, |
|
355 | - $requested_version |
|
356 | - ); |
|
357 | - } |
|
358 | - |
|
359 | - |
|
360 | - /** |
|
361 | - * Prepares condition-query-parameters (like what's in where and having) from |
|
362 | - * the format expected in the API to use in the models |
|
363 | - * |
|
364 | - * @param array $inputted_query_params_of_this_type |
|
365 | - * @param EEM_Base $model |
|
366 | - * @param string $requested_version |
|
367 | - * @param boolean $writing whether this data will be written to the DB, or if we're just building a query. |
|
368 | - * If we're writing to the DB, we don't expect any operators, or any logic query |
|
369 | - * parameters, and we also won't accept serialized data unless the current user has |
|
370 | - * unfiltered_html. |
|
371 | - * @return array |
|
372 | - * @throws DomainException |
|
373 | - * @throws RestException |
|
374 | - * @throws EE_Error |
|
375 | - */ |
|
376 | - public static function prepareConditionsQueryParamsForModels( |
|
377 | - $inputted_query_params_of_this_type, |
|
378 | - EEM_Base $model, |
|
379 | - $requested_version, |
|
380 | - $writing = false |
|
381 | - ) { |
|
382 | - $query_param_for_models = array(); |
|
383 | - $valid_operators = $model->valid_operators(); |
|
384 | - foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) { |
|
385 | - $is_gmt_datetime_field = false; |
|
386 | - $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey( |
|
387 | - $query_param_key |
|
388 | - ); |
|
389 | - $field = ModelDataTranslator::deduceFieldFromQueryParam( |
|
390 | - $query_param_sans_stars, |
|
391 | - $model |
|
392 | - ); |
|
393 | - // double-check is it a *_gmt field? |
|
394 | - if (! $field instanceof EE_Model_Field_Base |
|
395 | - && ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars) |
|
396 | - ) { |
|
397 | - // yep, take off '_gmt', and find the field |
|
398 | - $query_param_key = ModelDataTranslator::removeGmtFromFieldName($query_param_sans_stars); |
|
399 | - $field = ModelDataTranslator::deduceFieldFromQueryParam( |
|
400 | - $query_param_key, |
|
401 | - $model |
|
402 | - ); |
|
403 | - $timezone = 'UTC'; |
|
404 | - $is_gmt_datetime_field = true; |
|
405 | - } elseif ($field instanceof EE_Datetime_Field) { |
|
406 | - // so it's not a GMT field. Set the timezone on the model to the default |
|
407 | - $timezone = \EEH_DTT_Helper::get_valid_timezone_string(); |
|
408 | - } else { |
|
409 | - // just keep using what's already set for the timezone |
|
410 | - $timezone = $model->get_timezone(); |
|
411 | - } |
|
412 | - if ($field instanceof EE_Model_Field_Base) { |
|
413 | - if (! $writing && is_array($query_param_value)) { |
|
414 | - if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) { |
|
415 | - if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) { |
|
416 | - throw new RestException( |
|
417 | - 'numerically_indexed_array_of_values_only', |
|
418 | - sprintf( |
|
419 | - esc_html__( |
|
420 | - 'The array provided for the parameter "%1$s" should be numerically indexed.', |
|
421 | - 'event_espresso' |
|
422 | - ), |
|
423 | - $query_param_key |
|
424 | - ), |
|
425 | - array( |
|
426 | - 'status' => 400, |
|
427 | - ) |
|
428 | - ); |
|
429 | - } |
|
430 | - } |
|
431 | - // did they specify an operator? |
|
432 | - if (isset($query_param_value[0]) |
|
433 | - && isset($valid_operators[ $query_param_value[0] ]) |
|
434 | - ) { |
|
435 | - $op = $query_param_value[0]; |
|
436 | - $translated_value = array($op); |
|
437 | - if (array_key_exists($op, $model->valid_in_style_operators()) |
|
438 | - && isset($query_param_value[1]) |
|
439 | - && ! isset($query_param_value[2]) |
|
440 | - ) { |
|
441 | - $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson( |
|
442 | - $field, |
|
443 | - $query_param_value[1], |
|
444 | - $requested_version, |
|
445 | - $timezone |
|
446 | - ); |
|
447 | - } elseif (array_key_exists($op, $model->valid_between_style_operators()) |
|
448 | - && isset($query_param_value[1]) |
|
449 | - && is_array($query_param_value[1]) |
|
450 | - && isset($query_param_key[1][0], $query_param_value[1][1]) |
|
451 | - && ! isset($query_param_value[1][2]) |
|
452 | - && ! isset($query_param_value[2]) |
|
453 | - ) { |
|
454 | - $translated_value[] = array( |
|
455 | - ModelDataTranslator::prepareFieldValuesFromJson( |
|
456 | - $field, |
|
457 | - $query_param_value[1][0], |
|
458 | - $requested_version, |
|
459 | - $timezone |
|
460 | - ), |
|
461 | - ModelDataTranslator::prepareFieldValuesFromJson( |
|
462 | - $field, |
|
463 | - $query_param_value[1][1], |
|
464 | - $requested_version, |
|
465 | - $timezone |
|
466 | - ) |
|
467 | - ); |
|
468 | - } elseif (array_key_exists($op, $model->valid_like_style_operators()) |
|
469 | - && isset($query_param_value[1]) |
|
470 | - && ! isset($query_param_value[2]) |
|
471 | - ) { |
|
472 | - // we want to leave this value mostly-as-is (eg don't force it to be a float |
|
473 | - // or a boolean or an enum value. Leave it as-is with wildcards etc) |
|
474 | - // but do verify it at least doesn't have any serialized data |
|
475 | - ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]); |
|
476 | - $translated_value[] = $query_param_value[1]; |
|
477 | - } elseif (array_key_exists($op, $model->valid_null_style_operators()) |
|
478 | - && ! isset($query_param_value[1])) { |
|
479 | - // no arguments should have been provided, so don't look for any |
|
480 | - } elseif (isset($query_param_value[1]) |
|
481 | - && ! isset($query_param_value[2]) |
|
482 | - && ! array_key_exists( |
|
483 | - $op, |
|
484 | - array_merge( |
|
485 | - $model->valid_in_style_operators(), |
|
486 | - $model->valid_null_style_operators(), |
|
487 | - $model->valid_like_style_operators(), |
|
488 | - $model->valid_between_style_operators() |
|
489 | - ) |
|
490 | - ) |
|
491 | - ) { |
|
492 | - // it's a valid operator, but none of the exceptions. Treat it normally. |
|
493 | - $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson( |
|
494 | - $field, |
|
495 | - $query_param_value[1], |
|
496 | - $requested_version, |
|
497 | - $timezone |
|
498 | - ); |
|
499 | - } else { |
|
500 | - // so they provided a valid operator, but wrong number of arguments |
|
501 | - if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) { |
|
502 | - throw new RestException( |
|
503 | - 'wrong_number_of_arguments', |
|
504 | - sprintf( |
|
505 | - esc_html__( |
|
506 | - 'The operator you provided, "%1$s" had the wrong number of arguments', |
|
507 | - 'event_espresso' |
|
508 | - ), |
|
509 | - $op |
|
510 | - ), |
|
511 | - array( |
|
512 | - 'status' => 400, |
|
513 | - ) |
|
514 | - ); |
|
515 | - } |
|
516 | - $translated_value = null; |
|
517 | - } |
|
518 | - } else { |
|
519 | - // so they didn't provide a valid operator |
|
520 | - if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) { |
|
521 | - throw new RestException( |
|
522 | - 'invalid_operator', |
|
523 | - sprintf( |
|
524 | - esc_html__( |
|
525 | - 'You provided an invalid parameter, with key "%1$s" and value "%2$s"', |
|
526 | - 'event_espresso' |
|
527 | - ), |
|
528 | - $query_param_key, |
|
529 | - $query_param_value |
|
530 | - ), |
|
531 | - array( |
|
532 | - 'status' => 400, |
|
533 | - ) |
|
534 | - ); |
|
535 | - } |
|
536 | - // if we aren't in debug mode, then just try our best to fulfill the user's request |
|
537 | - $translated_value = null; |
|
538 | - } |
|
539 | - } else { |
|
540 | - $translated_value = ModelDataTranslator::prepareFieldValueFromJson( |
|
541 | - $field, |
|
542 | - $query_param_value, |
|
543 | - $requested_version, |
|
544 | - $timezone |
|
545 | - ); |
|
546 | - } |
|
547 | - if ((isset($query_param_for_models[ $query_param_key ]) && $is_gmt_datetime_field) |
|
548 | - || $translated_value === null |
|
549 | - ) { |
|
550 | - // they have already provided a non-gmt field, ignore the gmt one. That's what WP core |
|
551 | - // currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954 |
|
552 | - // OR we couldn't create a translated value from their input |
|
553 | - continue; |
|
554 | - } |
|
555 | - $query_param_for_models[ $query_param_key ] = $translated_value; |
|
556 | - } else { |
|
557 | - // so this param doesn't correspond to a field eh? |
|
558 | - if ($writing) { |
|
559 | - // always tell API clients about invalid parameters when they're creating data. Otherwise, |
|
560 | - // they are probably going to create invalid data |
|
561 | - throw new RestException( |
|
562 | - 'invalid_field', |
|
563 | - sprintf( |
|
564 | - esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'), |
|
565 | - $query_param_key |
|
566 | - ) |
|
567 | - ); |
|
568 | - } else { |
|
569 | - // so it's not for a field, is it a logic query param key? |
|
570 | - if (in_array( |
|
571 | - $query_param_sans_stars, |
|
572 | - $model->logic_query_param_keys() |
|
573 | - )) { |
|
574 | - $query_param_for_models[ $query_param_key ] = ModelDataTranslator::prepareConditionsQueryParamsForModels( |
|
575 | - $query_param_value, |
|
576 | - $model, |
|
577 | - $requested_version |
|
578 | - ); |
|
579 | - } elseif (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) { |
|
580 | - // only tell API clients they got it wrong if we're in debug mode |
|
581 | - // otherwise try our best ot fulfill their request by ignoring this invalid data |
|
582 | - throw new RestException( |
|
583 | - 'invalid_parameter', |
|
584 | - sprintf( |
|
585 | - esc_html__( |
|
586 | - 'You provided an invalid parameter, with key "%1$s"', |
|
587 | - 'event_espresso' |
|
588 | - ), |
|
589 | - $query_param_sans_stars |
|
590 | - ), |
|
591 | - array( |
|
592 | - 'status' => 400, |
|
593 | - ) |
|
594 | - ); |
|
595 | - } |
|
596 | - } |
|
597 | - } |
|
598 | - } |
|
599 | - return $query_param_for_models; |
|
600 | - } |
|
601 | - |
|
602 | - |
|
603 | - /** |
|
604 | - * Mostly checks if the last 4 characters are "_gmt", indicating its a |
|
605 | - * gmt date field name |
|
606 | - * |
|
607 | - * @param string $field_name |
|
608 | - * @return boolean |
|
609 | - */ |
|
610 | - public static function isGmtDateFieldName($field_name) |
|
611 | - { |
|
612 | - return substr( |
|
613 | - ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name), |
|
614 | - -4, |
|
615 | - 4 |
|
616 | - ) === '_gmt'; |
|
617 | - } |
|
618 | - |
|
619 | - |
|
620 | - /** |
|
621 | - * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone) |
|
622 | - * |
|
623 | - * @param string $field_name |
|
624 | - * @return string |
|
625 | - */ |
|
626 | - public static function removeGmtFromFieldName($field_name) |
|
627 | - { |
|
628 | - if (! ModelDataTranslator::isGmtDateFieldName($field_name)) { |
|
629 | - return $field_name; |
|
630 | - } |
|
631 | - $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey( |
|
632 | - $field_name |
|
633 | - ); |
|
634 | - $query_param_sans_gmt_and_sans_stars = substr( |
|
635 | - $query_param_sans_stars, |
|
636 | - 0, |
|
637 | - strrpos( |
|
638 | - $field_name, |
|
639 | - '_gmt' |
|
640 | - ) |
|
641 | - ); |
|
642 | - return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name); |
|
643 | - } |
|
644 | - |
|
645 | - |
|
646 | - /** |
|
647 | - * Takes a field name from the REST API and prepares it for the model querying |
|
648 | - * |
|
649 | - * @param string $field_name |
|
650 | - * @return string |
|
651 | - */ |
|
652 | - public static function prepareFieldNameFromJson($field_name) |
|
653 | - { |
|
654 | - if (ModelDataTranslator::isGmtDateFieldName($field_name)) { |
|
655 | - return ModelDataTranslator::removeGmtFromFieldName($field_name); |
|
656 | - } |
|
657 | - return $field_name; |
|
658 | - } |
|
659 | - |
|
660 | - |
|
661 | - /** |
|
662 | - * Takes array of field names from REST API and prepares for models |
|
663 | - * |
|
664 | - * @param array $field_names |
|
665 | - * @return array of field names (possibly include model prefixes) |
|
666 | - */ |
|
667 | - public static function prepareFieldNamesFromJson(array $field_names) |
|
668 | - { |
|
669 | - $new_array = array(); |
|
670 | - foreach ($field_names as $key => $field_name) { |
|
671 | - $new_array[ $key ] = ModelDataTranslator::prepareFieldNameFromJson($field_name); |
|
672 | - } |
|
673 | - return $new_array; |
|
674 | - } |
|
675 | - |
|
676 | - |
|
677 | - /** |
|
678 | - * Takes array where array keys are field names (possibly with model path prefixes) |
|
679 | - * from the REST API and prepares them for model querying |
|
680 | - * |
|
681 | - * @param array $field_names_as_keys |
|
682 | - * @return array |
|
683 | - */ |
|
684 | - public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys) |
|
685 | - { |
|
686 | - $new_array = array(); |
|
687 | - foreach ($field_names_as_keys as $field_name => $value) { |
|
688 | - $new_array[ ModelDataTranslator::prepareFieldNameFromJson($field_name) ] = $value; |
|
689 | - } |
|
690 | - return $new_array; |
|
691 | - } |
|
692 | - |
|
693 | - |
|
694 | - /** |
|
695 | - * Prepares an array of model query params for use in the REST API |
|
696 | - * |
|
697 | - * @param array $model_query_params |
|
698 | - * @param EEM_Base $model |
|
699 | - * @param string $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4 |
|
700 | - * REST API |
|
701 | - * @return array which can be passed into the EE4 REST API when querying a model resource |
|
702 | - * @throws EE_Error |
|
703 | - */ |
|
704 | - public static function prepareQueryParamsForRestApi( |
|
705 | - array $model_query_params, |
|
706 | - EEM_Base $model, |
|
707 | - $requested_version = null |
|
708 | - ) { |
|
709 | - if ($requested_version === null) { |
|
710 | - $requested_version = \EED_Core_Rest_Api::latest_rest_api_version(); |
|
711 | - } |
|
712 | - $rest_query_params = $model_query_params; |
|
713 | - if (isset($model_query_params[0])) { |
|
714 | - $rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi( |
|
715 | - $model_query_params[0], |
|
716 | - $model, |
|
717 | - $requested_version |
|
718 | - ); |
|
719 | - unset($rest_query_params[0]); |
|
720 | - } |
|
721 | - if (isset($model_query_params['having'])) { |
|
722 | - $rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi( |
|
723 | - $model_query_params['having'], |
|
724 | - $model, |
|
725 | - $requested_version |
|
726 | - ); |
|
727 | - } |
|
728 | - return apply_filters( |
|
729 | - 'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api', |
|
730 | - $rest_query_params, |
|
731 | - $model_query_params, |
|
732 | - $model, |
|
733 | - $requested_version |
|
734 | - ); |
|
735 | - } |
|
736 | - |
|
737 | - |
|
738 | - /** |
|
739 | - * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api |
|
740 | - * |
|
741 | - * @param array $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params |
|
742 | - * passed into EEM_Base::get_all() |
|
743 | - * @param EEM_Base $model |
|
744 | - * @param string $requested_version eg "4.8.36" |
|
745 | - * @return array ready for use in the rest api query params |
|
746 | - * @throws EE_Error |
|
747 | - * @throws ObjectDetectedException if somehow a PHP object were in the query params' values, |
|
748 | - * (which would be really unusual) |
|
749 | - */ |
|
750 | - public static function prepareConditionsQueryParamsForRestApi( |
|
751 | - $inputted_query_params_of_this_type, |
|
752 | - EEM_Base $model, |
|
753 | - $requested_version |
|
754 | - ) { |
|
755 | - $query_param_for_models = array(); |
|
756 | - foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) { |
|
757 | - $field = ModelDataTranslator::deduceFieldFromQueryParam( |
|
758 | - ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key), |
|
759 | - $model |
|
760 | - ); |
|
761 | - if ($field instanceof EE_Model_Field_Base) { |
|
762 | - // did they specify an operator? |
|
763 | - if (is_array($query_param_value)) { |
|
764 | - $op = $query_param_value[0]; |
|
765 | - $translated_value = array($op); |
|
766 | - if (isset($query_param_value[1])) { |
|
767 | - $value = $query_param_value[1]; |
|
768 | - $translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson( |
|
769 | - $field, |
|
770 | - $value, |
|
771 | - $requested_version |
|
772 | - ); |
|
773 | - } |
|
774 | - } else { |
|
775 | - $translated_value = ModelDataTranslator::prepareFieldValueForJson( |
|
776 | - $field, |
|
777 | - $query_param_value, |
|
778 | - $requested_version |
|
779 | - ); |
|
780 | - } |
|
781 | - $query_param_for_models[ $query_param_key ] = $translated_value; |
|
782 | - } else { |
|
783 | - // so it's not for a field, assume it's a logic query param key |
|
784 | - $query_param_for_models[ $query_param_key ] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi( |
|
785 | - $query_param_value, |
|
786 | - $model, |
|
787 | - $requested_version |
|
788 | - ); |
|
789 | - } |
|
790 | - } |
|
791 | - return $query_param_for_models; |
|
792 | - } |
|
793 | - |
|
794 | - |
|
795 | - /** |
|
796 | - * @param $condition_query_param_key |
|
797 | - * @return string |
|
798 | - */ |
|
799 | - public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key) |
|
800 | - { |
|
801 | - $pos_of_star = strpos($condition_query_param_key, '*'); |
|
802 | - if ($pos_of_star === false) { |
|
803 | - return $condition_query_param_key; |
|
804 | - } else { |
|
805 | - $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star); |
|
806 | - return $condition_query_param_sans_star; |
|
807 | - } |
|
808 | - } |
|
809 | - |
|
810 | - |
|
811 | - /** |
|
812 | - * Takes the input parameter and finds the model field that it indicates. |
|
813 | - * |
|
814 | - * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID |
|
815 | - * @param EEM_Base $model |
|
816 | - * @return EE_Model_Field_Base |
|
817 | - * @throws EE_Error |
|
818 | - */ |
|
819 | - public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model) |
|
820 | - { |
|
821 | - // ok, now proceed with deducing which part is the model's name, and which is the field's name |
|
822 | - // which will help us find the database table and column |
|
823 | - $query_param_parts = explode('.', $query_param_name); |
|
824 | - if (empty($query_param_parts)) { |
|
825 | - throw new EE_Error( |
|
826 | - sprintf( |
|
827 | - __( |
|
828 | - '_extract_column_name is empty when trying to extract column and table name from %s', |
|
829 | - 'event_espresso' |
|
830 | - ), |
|
831 | - $query_param_name |
|
832 | - ) |
|
833 | - ); |
|
834 | - } |
|
835 | - $number_of_parts = count($query_param_parts); |
|
836 | - $last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ]; |
|
837 | - if ($number_of_parts === 1) { |
|
838 | - $field_name = $last_query_param_part; |
|
839 | - } else {// $number_of_parts >= 2 |
|
840 | - // the last part is the column name, and there are only 2parts. therefore... |
|
841 | - $field_name = $last_query_param_part; |
|
842 | - $model = \EE_Registry::instance()->load_model($query_param_parts[ $number_of_parts - 2 ]); |
|
843 | - } |
|
844 | - try { |
|
845 | - return $model->field_settings_for($field_name, false); |
|
846 | - } catch (EE_Error $e) { |
|
847 | - return null; |
|
848 | - } |
|
849 | - } |
|
850 | - |
|
851 | - |
|
852 | - /** |
|
853 | - * Returns true if $data can be easily represented in JSON. |
|
854 | - * Basically, objects and resources can't be represented in JSON easily. |
|
855 | - * |
|
856 | - * @param mixed $data |
|
857 | - * @return bool |
|
858 | - */ |
|
859 | - protected static function isRepresentableInJson($data) |
|
860 | - { |
|
861 | - return is_scalar($data) |
|
862 | - || is_array($data) |
|
863 | - || is_null($data); |
|
864 | - } |
|
35 | + /** |
|
36 | + * We used to use -1 for infinity in the rest api, but that's ambiguous for |
|
37 | + * fields that COULD contain -1; so we use null |
|
38 | + */ |
|
39 | + const EE_INF_IN_REST = null; |
|
40 | + |
|
41 | + |
|
42 | + /** |
|
43 | + * Prepares a possible array of input values from JSON for use by the models |
|
44 | + * |
|
45 | + * @param EE_Model_Field_Base $field_obj |
|
46 | + * @param mixed $original_value_maybe_array |
|
47 | + * @param string $requested_version |
|
48 | + * @param string $timezone_string treat values as being in this timezone |
|
49 | + * @return mixed |
|
50 | + * @throws RestException |
|
51 | + */ |
|
52 | + public static function prepareFieldValuesFromJson( |
|
53 | + $field_obj, |
|
54 | + $original_value_maybe_array, |
|
55 | + $requested_version, |
|
56 | + $timezone_string = 'UTC' |
|
57 | + ) { |
|
58 | + if (is_array($original_value_maybe_array) |
|
59 | + && ! $field_obj instanceof EE_Serialized_Text_Field |
|
60 | + ) { |
|
61 | + $new_value_maybe_array = array(); |
|
62 | + foreach ($original_value_maybe_array as $array_key => $array_item) { |
|
63 | + $new_value_maybe_array[ $array_key ] = ModelDataTranslator::prepareFieldValueFromJson( |
|
64 | + $field_obj, |
|
65 | + $array_item, |
|
66 | + $requested_version, |
|
67 | + $timezone_string |
|
68 | + ); |
|
69 | + } |
|
70 | + } else { |
|
71 | + $new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson( |
|
72 | + $field_obj, |
|
73 | + $original_value_maybe_array, |
|
74 | + $requested_version, |
|
75 | + $timezone_string |
|
76 | + ); |
|
77 | + } |
|
78 | + return $new_value_maybe_array; |
|
79 | + } |
|
80 | + |
|
81 | + |
|
82 | + /** |
|
83 | + * Prepares an array of field values FOR use in JSON/REST API |
|
84 | + * |
|
85 | + * @param EE_Model_Field_Base $field_obj |
|
86 | + * @param mixed $original_value_maybe_array |
|
87 | + * @param string $request_version (eg 4.8.36) |
|
88 | + * @return array |
|
89 | + */ |
|
90 | + public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version) |
|
91 | + { |
|
92 | + if (is_array($original_value_maybe_array)) { |
|
93 | + $new_value = array(); |
|
94 | + foreach ($original_value_maybe_array as $key => $value) { |
|
95 | + $new_value[ $key ] = ModelDataTranslator::prepareFieldValuesForJson( |
|
96 | + $field_obj, |
|
97 | + $value, |
|
98 | + $request_version |
|
99 | + ); |
|
100 | + } |
|
101 | + } else { |
|
102 | + $new_value = ModelDataTranslator::prepareFieldValueForJson( |
|
103 | + $field_obj, |
|
104 | + $original_value_maybe_array, |
|
105 | + $request_version |
|
106 | + ); |
|
107 | + } |
|
108 | + return $new_value; |
|
109 | + } |
|
110 | + |
|
111 | + |
|
112 | + /** |
|
113 | + * Prepares incoming data from the json or $_REQUEST parameters for the models' |
|
114 | + * "$query_params". |
|
115 | + * |
|
116 | + * @param EE_Model_Field_Base $field_obj |
|
117 | + * @param mixed $original_value |
|
118 | + * @param string $requested_version |
|
119 | + * @param string $timezone_string treat values as being in this timezone |
|
120 | + * @return mixed |
|
121 | + * @throws RestException |
|
122 | + * @throws DomainException |
|
123 | + * @throws EE_Error |
|
124 | + */ |
|
125 | + public static function prepareFieldValueFromJson( |
|
126 | + $field_obj, |
|
127 | + $original_value, |
|
128 | + $requested_version, |
|
129 | + $timezone_string = 'UTC' // UTC |
|
130 | + ) { |
|
131 | + // check if they accidentally submitted an error value. If so throw an exception |
|
132 | + if (is_array($original_value) |
|
133 | + && isset($original_value['error_code'], $original_value['error_message'])) { |
|
134 | + throw new RestException( |
|
135 | + 'rest_submitted_error_value', |
|
136 | + sprintf( |
|
137 | + esc_html__( |
|
138 | + 'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.', |
|
139 | + 'event_espresso' |
|
140 | + ), |
|
141 | + $field_obj->get_name() |
|
142 | + ), |
|
143 | + array( |
|
144 | + 'status' => 400, |
|
145 | + ) |
|
146 | + ); |
|
147 | + } |
|
148 | + // double-check for serialized PHP. We never accept serialized PHP. No way Jose. |
|
149 | + ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value); |
|
150 | + $timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', ''); |
|
151 | + $new_value = null; |
|
152 | + // walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No |
|
153 | + // way Jose. |
|
154 | + ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value); |
|
155 | + if ($field_obj instanceof EE_Infinite_Integer_Field |
|
156 | + && in_array($original_value, array(null, ''), true) |
|
157 | + ) { |
|
158 | + $new_value = EE_INF; |
|
159 | + } elseif ($field_obj instanceof EE_Datetime_Field) { |
|
160 | + $new_value = rest_parse_date( |
|
161 | + self::getTimestampWithTimezoneOffset($original_value, $field_obj, $timezone_string) |
|
162 | + ); |
|
163 | + if ($new_value === false) { |
|
164 | + throw new RestException( |
|
165 | + 'invalid_format_for_timestamp', |
|
166 | + sprintf( |
|
167 | + esc_html__( |
|
168 | + 'Timestamps received on a request as the value for Date and Time fields must be in %1$s/%2$s format. The timestamp provided (%3$s) is not that format.', |
|
169 | + 'event_espresso' |
|
170 | + ), |
|
171 | + 'RFC3339', |
|
172 | + 'ISO8601', |
|
173 | + $original_value |
|
174 | + ), |
|
175 | + array( |
|
176 | + 'status' => 400, |
|
177 | + ) |
|
178 | + ); |
|
179 | + } |
|
180 | + } else { |
|
181 | + $new_value = $original_value; |
|
182 | + } |
|
183 | + return $new_value; |
|
184 | + } |
|
185 | + |
|
186 | + |
|
187 | + /** |
|
188 | + * This checks if the incoming timestamp has timezone information already on it and if it doesn't then adds timezone |
|
189 | + * information via details obtained from the host site. |
|
190 | + * |
|
191 | + * @param string $original_timestamp |
|
192 | + * @param EE_Datetime_Field $datetime_field |
|
193 | + * @param $timezone_string |
|
194 | + * @return string |
|
195 | + * @throws DomainException |
|
196 | + */ |
|
197 | + private static function getTimestampWithTimezoneOffset( |
|
198 | + $original_timestamp, |
|
199 | + EE_Datetime_Field $datetime_field, |
|
200 | + $timezone_string |
|
201 | + ) { |
|
202 | + // already have timezone information? |
|
203 | + if (preg_match('/Z|(\+|\-)(\d{2}:\d{2})/', $original_timestamp)) { |
|
204 | + // yes, we're ignoring the timezone. |
|
205 | + return $original_timestamp; |
|
206 | + } |
|
207 | + // need to append timezone |
|
208 | + list($offset_sign, $offset_secs) = self::parseTimezoneOffset( |
|
209 | + $datetime_field->get_timezone_offset( |
|
210 | + new \DateTimeZone($timezone_string), |
|
211 | + $original_timestamp |
|
212 | + ) |
|
213 | + ); |
|
214 | + $offset_string = |
|
215 | + str_pad( |
|
216 | + floor($offset_secs / HOUR_IN_SECONDS), |
|
217 | + 2, |
|
218 | + '0', |
|
219 | + STR_PAD_LEFT |
|
220 | + ) |
|
221 | + . ':' |
|
222 | + . str_pad( |
|
223 | + ($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS, |
|
224 | + 2, |
|
225 | + '0', |
|
226 | + STR_PAD_LEFT |
|
227 | + ); |
|
228 | + return $original_timestamp . $offset_sign . $offset_string; |
|
229 | + } |
|
230 | + |
|
231 | + |
|
232 | + /** |
|
233 | + * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't |
|
234 | + * think that can happen). If $data is an array, recurses into its keys and values |
|
235 | + * |
|
236 | + * @param mixed $data |
|
237 | + * @throws RestException |
|
238 | + * @return void |
|
239 | + */ |
|
240 | + public static function throwExceptionIfContainsSerializedData($data) |
|
241 | + { |
|
242 | + if (is_array($data)) { |
|
243 | + foreach ($data as $key => $value) { |
|
244 | + ModelDataTranslator::throwExceptionIfContainsSerializedData($key); |
|
245 | + ModelDataTranslator::throwExceptionIfContainsSerializedData($value); |
|
246 | + } |
|
247 | + } else { |
|
248 | + if (is_serialized($data) || is_object($data)) { |
|
249 | + throw new RestException( |
|
250 | + 'serialized_data_submission_prohibited', |
|
251 | + esc_html__( |
|
252 | + // @codingStandardsIgnoreStart |
|
253 | + 'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.', |
|
254 | + // @codingStandardsIgnoreEnd |
|
255 | + 'event_espresso' |
|
256 | + ) |
|
257 | + ); |
|
258 | + } |
|
259 | + } |
|
260 | + } |
|
261 | + |
|
262 | + |
|
263 | + /** |
|
264 | + * determines what's going on with them timezone strings |
|
265 | + * |
|
266 | + * @param int $timezone_offset |
|
267 | + * @return array |
|
268 | + */ |
|
269 | + private static function parseTimezoneOffset($timezone_offset) |
|
270 | + { |
|
271 | + $first_char = substr((string) $timezone_offset, 0, 1); |
|
272 | + if ($first_char === '+' || $first_char === '-') { |
|
273 | + $offset_sign = $first_char; |
|
274 | + $offset_secs = substr((string) $timezone_offset, 1); |
|
275 | + } else { |
|
276 | + $offset_sign = '+'; |
|
277 | + $offset_secs = $timezone_offset; |
|
278 | + } |
|
279 | + return array($offset_sign, $offset_secs); |
|
280 | + } |
|
281 | + |
|
282 | + |
|
283 | + /** |
|
284 | + * Prepares a field's value for display in the API |
|
285 | + * |
|
286 | + * @param EE_Model_Field_Base $field_obj |
|
287 | + * @param mixed $original_value |
|
288 | + * @param string $requested_version |
|
289 | + * @return mixed |
|
290 | + */ |
|
291 | + public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version) |
|
292 | + { |
|
293 | + if ($original_value === EE_INF) { |
|
294 | + $new_value = ModelDataTranslator::EE_INF_IN_REST; |
|
295 | + } elseif ($field_obj instanceof EE_Datetime_Field) { |
|
296 | + if (is_string($original_value)) { |
|
297 | + // did they submit a string of a unix timestamp? |
|
298 | + if (is_numeric($original_value)) { |
|
299 | + $datetime_obj = new \DateTime(); |
|
300 | + $datetime_obj->setTimestamp((int) $original_value); |
|
301 | + } else { |
|
302 | + // first, check if its a MySQL timestamp in GMT |
|
303 | + $datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value); |
|
304 | + } |
|
305 | + if (! $datetime_obj instanceof \DateTime) { |
|
306 | + // so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format? |
|
307 | + $datetime_obj = $field_obj->prepare_for_set($original_value); |
|
308 | + } |
|
309 | + $original_value = $datetime_obj; |
|
310 | + } |
|
311 | + if ($original_value instanceof \DateTime) { |
|
312 | + $new_value = $original_value->format('Y-m-d H:i:s'); |
|
313 | + } elseif (is_int($original_value) || is_float($original_value)) { |
|
314 | + $new_value = date('Y-m-d H:i:s', $original_value); |
|
315 | + } elseif ($original_value === null || $original_value === '') { |
|
316 | + $new_value = null; |
|
317 | + } else { |
|
318 | + // so it's not a datetime object, unix timestamp (as string or int), |
|
319 | + // MySQL timestamp, or even a string in the field object's format. So no idea what it is |
|
320 | + throw new \EE_Error( |
|
321 | + sprintf( |
|
322 | + esc_html__( |
|
323 | + // @codingStandardsIgnoreStart |
|
324 | + 'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".', |
|
325 | + // @codingStandardsIgnoreEnd |
|
326 | + 'event_espresso' |
|
327 | + ), |
|
328 | + $original_value, |
|
329 | + $field_obj->get_name(), |
|
330 | + $field_obj->get_model_name(), |
|
331 | + $field_obj->get_time_format() . ' ' . $field_obj->get_time_format() |
|
332 | + ) |
|
333 | + ); |
|
334 | + } |
|
335 | + $new_value = mysql_to_rfc3339($new_value); |
|
336 | + } else { |
|
337 | + $new_value = $original_value; |
|
338 | + } |
|
339 | + // are we about to send an object? just don't. We have no good way to represent it in JSON. |
|
340 | + // can't just check using is_object() because that missed PHP incomplete objects |
|
341 | + if (! ModelDataTranslator::isRepresentableInJson($new_value)) { |
|
342 | + $new_value = array( |
|
343 | + 'error_code' => 'php_object_not_return', |
|
344 | + 'error_message' => esc_html__( |
|
345 | + 'The value of this field in the database is a PHP object, which can\'t be represented in JSON.', |
|
346 | + 'event_espresso' |
|
347 | + ), |
|
348 | + ); |
|
349 | + } |
|
350 | + return apply_filters( |
|
351 | + 'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api', |
|
352 | + $new_value, |
|
353 | + $field_obj, |
|
354 | + $original_value, |
|
355 | + $requested_version |
|
356 | + ); |
|
357 | + } |
|
358 | + |
|
359 | + |
|
360 | + /** |
|
361 | + * Prepares condition-query-parameters (like what's in where and having) from |
|
362 | + * the format expected in the API to use in the models |
|
363 | + * |
|
364 | + * @param array $inputted_query_params_of_this_type |
|
365 | + * @param EEM_Base $model |
|
366 | + * @param string $requested_version |
|
367 | + * @param boolean $writing whether this data will be written to the DB, or if we're just building a query. |
|
368 | + * If we're writing to the DB, we don't expect any operators, or any logic query |
|
369 | + * parameters, and we also won't accept serialized data unless the current user has |
|
370 | + * unfiltered_html. |
|
371 | + * @return array |
|
372 | + * @throws DomainException |
|
373 | + * @throws RestException |
|
374 | + * @throws EE_Error |
|
375 | + */ |
|
376 | + public static function prepareConditionsQueryParamsForModels( |
|
377 | + $inputted_query_params_of_this_type, |
|
378 | + EEM_Base $model, |
|
379 | + $requested_version, |
|
380 | + $writing = false |
|
381 | + ) { |
|
382 | + $query_param_for_models = array(); |
|
383 | + $valid_operators = $model->valid_operators(); |
|
384 | + foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) { |
|
385 | + $is_gmt_datetime_field = false; |
|
386 | + $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey( |
|
387 | + $query_param_key |
|
388 | + ); |
|
389 | + $field = ModelDataTranslator::deduceFieldFromQueryParam( |
|
390 | + $query_param_sans_stars, |
|
391 | + $model |
|
392 | + ); |
|
393 | + // double-check is it a *_gmt field? |
|
394 | + if (! $field instanceof EE_Model_Field_Base |
|
395 | + && ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars) |
|
396 | + ) { |
|
397 | + // yep, take off '_gmt', and find the field |
|
398 | + $query_param_key = ModelDataTranslator::removeGmtFromFieldName($query_param_sans_stars); |
|
399 | + $field = ModelDataTranslator::deduceFieldFromQueryParam( |
|
400 | + $query_param_key, |
|
401 | + $model |
|
402 | + ); |
|
403 | + $timezone = 'UTC'; |
|
404 | + $is_gmt_datetime_field = true; |
|
405 | + } elseif ($field instanceof EE_Datetime_Field) { |
|
406 | + // so it's not a GMT field. Set the timezone on the model to the default |
|
407 | + $timezone = \EEH_DTT_Helper::get_valid_timezone_string(); |
|
408 | + } else { |
|
409 | + // just keep using what's already set for the timezone |
|
410 | + $timezone = $model->get_timezone(); |
|
411 | + } |
|
412 | + if ($field instanceof EE_Model_Field_Base) { |
|
413 | + if (! $writing && is_array($query_param_value)) { |
|
414 | + if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) { |
|
415 | + if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) { |
|
416 | + throw new RestException( |
|
417 | + 'numerically_indexed_array_of_values_only', |
|
418 | + sprintf( |
|
419 | + esc_html__( |
|
420 | + 'The array provided for the parameter "%1$s" should be numerically indexed.', |
|
421 | + 'event_espresso' |
|
422 | + ), |
|
423 | + $query_param_key |
|
424 | + ), |
|
425 | + array( |
|
426 | + 'status' => 400, |
|
427 | + ) |
|
428 | + ); |
|
429 | + } |
|
430 | + } |
|
431 | + // did they specify an operator? |
|
432 | + if (isset($query_param_value[0]) |
|
433 | + && isset($valid_operators[ $query_param_value[0] ]) |
|
434 | + ) { |
|
435 | + $op = $query_param_value[0]; |
|
436 | + $translated_value = array($op); |
|
437 | + if (array_key_exists($op, $model->valid_in_style_operators()) |
|
438 | + && isset($query_param_value[1]) |
|
439 | + && ! isset($query_param_value[2]) |
|
440 | + ) { |
|
441 | + $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson( |
|
442 | + $field, |
|
443 | + $query_param_value[1], |
|
444 | + $requested_version, |
|
445 | + $timezone |
|
446 | + ); |
|
447 | + } elseif (array_key_exists($op, $model->valid_between_style_operators()) |
|
448 | + && isset($query_param_value[1]) |
|
449 | + && is_array($query_param_value[1]) |
|
450 | + && isset($query_param_key[1][0], $query_param_value[1][1]) |
|
451 | + && ! isset($query_param_value[1][2]) |
|
452 | + && ! isset($query_param_value[2]) |
|
453 | + ) { |
|
454 | + $translated_value[] = array( |
|
455 | + ModelDataTranslator::prepareFieldValuesFromJson( |
|
456 | + $field, |
|
457 | + $query_param_value[1][0], |
|
458 | + $requested_version, |
|
459 | + $timezone |
|
460 | + ), |
|
461 | + ModelDataTranslator::prepareFieldValuesFromJson( |
|
462 | + $field, |
|
463 | + $query_param_value[1][1], |
|
464 | + $requested_version, |
|
465 | + $timezone |
|
466 | + ) |
|
467 | + ); |
|
468 | + } elseif (array_key_exists($op, $model->valid_like_style_operators()) |
|
469 | + && isset($query_param_value[1]) |
|
470 | + && ! isset($query_param_value[2]) |
|
471 | + ) { |
|
472 | + // we want to leave this value mostly-as-is (eg don't force it to be a float |
|
473 | + // or a boolean or an enum value. Leave it as-is with wildcards etc) |
|
474 | + // but do verify it at least doesn't have any serialized data |
|
475 | + ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]); |
|
476 | + $translated_value[] = $query_param_value[1]; |
|
477 | + } elseif (array_key_exists($op, $model->valid_null_style_operators()) |
|
478 | + && ! isset($query_param_value[1])) { |
|
479 | + // no arguments should have been provided, so don't look for any |
|
480 | + } elseif (isset($query_param_value[1]) |
|
481 | + && ! isset($query_param_value[2]) |
|
482 | + && ! array_key_exists( |
|
483 | + $op, |
|
484 | + array_merge( |
|
485 | + $model->valid_in_style_operators(), |
|
486 | + $model->valid_null_style_operators(), |
|
487 | + $model->valid_like_style_operators(), |
|
488 | + $model->valid_between_style_operators() |
|
489 | + ) |
|
490 | + ) |
|
491 | + ) { |
|
492 | + // it's a valid operator, but none of the exceptions. Treat it normally. |
|
493 | + $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson( |
|
494 | + $field, |
|
495 | + $query_param_value[1], |
|
496 | + $requested_version, |
|
497 | + $timezone |
|
498 | + ); |
|
499 | + } else { |
|
500 | + // so they provided a valid operator, but wrong number of arguments |
|
501 | + if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) { |
|
502 | + throw new RestException( |
|
503 | + 'wrong_number_of_arguments', |
|
504 | + sprintf( |
|
505 | + esc_html__( |
|
506 | + 'The operator you provided, "%1$s" had the wrong number of arguments', |
|
507 | + 'event_espresso' |
|
508 | + ), |
|
509 | + $op |
|
510 | + ), |
|
511 | + array( |
|
512 | + 'status' => 400, |
|
513 | + ) |
|
514 | + ); |
|
515 | + } |
|
516 | + $translated_value = null; |
|
517 | + } |
|
518 | + } else { |
|
519 | + // so they didn't provide a valid operator |
|
520 | + if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) { |
|
521 | + throw new RestException( |
|
522 | + 'invalid_operator', |
|
523 | + sprintf( |
|
524 | + esc_html__( |
|
525 | + 'You provided an invalid parameter, with key "%1$s" and value "%2$s"', |
|
526 | + 'event_espresso' |
|
527 | + ), |
|
528 | + $query_param_key, |
|
529 | + $query_param_value |
|
530 | + ), |
|
531 | + array( |
|
532 | + 'status' => 400, |
|
533 | + ) |
|
534 | + ); |
|
535 | + } |
|
536 | + // if we aren't in debug mode, then just try our best to fulfill the user's request |
|
537 | + $translated_value = null; |
|
538 | + } |
|
539 | + } else { |
|
540 | + $translated_value = ModelDataTranslator::prepareFieldValueFromJson( |
|
541 | + $field, |
|
542 | + $query_param_value, |
|
543 | + $requested_version, |
|
544 | + $timezone |
|
545 | + ); |
|
546 | + } |
|
547 | + if ((isset($query_param_for_models[ $query_param_key ]) && $is_gmt_datetime_field) |
|
548 | + || $translated_value === null |
|
549 | + ) { |
|
550 | + // they have already provided a non-gmt field, ignore the gmt one. That's what WP core |
|
551 | + // currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954 |
|
552 | + // OR we couldn't create a translated value from their input |
|
553 | + continue; |
|
554 | + } |
|
555 | + $query_param_for_models[ $query_param_key ] = $translated_value; |
|
556 | + } else { |
|
557 | + // so this param doesn't correspond to a field eh? |
|
558 | + if ($writing) { |
|
559 | + // always tell API clients about invalid parameters when they're creating data. Otherwise, |
|
560 | + // they are probably going to create invalid data |
|
561 | + throw new RestException( |
|
562 | + 'invalid_field', |
|
563 | + sprintf( |
|
564 | + esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'), |
|
565 | + $query_param_key |
|
566 | + ) |
|
567 | + ); |
|
568 | + } else { |
|
569 | + // so it's not for a field, is it a logic query param key? |
|
570 | + if (in_array( |
|
571 | + $query_param_sans_stars, |
|
572 | + $model->logic_query_param_keys() |
|
573 | + )) { |
|
574 | + $query_param_for_models[ $query_param_key ] = ModelDataTranslator::prepareConditionsQueryParamsForModels( |
|
575 | + $query_param_value, |
|
576 | + $model, |
|
577 | + $requested_version |
|
578 | + ); |
|
579 | + } elseif (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) { |
|
580 | + // only tell API clients they got it wrong if we're in debug mode |
|
581 | + // otherwise try our best ot fulfill their request by ignoring this invalid data |
|
582 | + throw new RestException( |
|
583 | + 'invalid_parameter', |
|
584 | + sprintf( |
|
585 | + esc_html__( |
|
586 | + 'You provided an invalid parameter, with key "%1$s"', |
|
587 | + 'event_espresso' |
|
588 | + ), |
|
589 | + $query_param_sans_stars |
|
590 | + ), |
|
591 | + array( |
|
592 | + 'status' => 400, |
|
593 | + ) |
|
594 | + ); |
|
595 | + } |
|
596 | + } |
|
597 | + } |
|
598 | + } |
|
599 | + return $query_param_for_models; |
|
600 | + } |
|
601 | + |
|
602 | + |
|
603 | + /** |
|
604 | + * Mostly checks if the last 4 characters are "_gmt", indicating its a |
|
605 | + * gmt date field name |
|
606 | + * |
|
607 | + * @param string $field_name |
|
608 | + * @return boolean |
|
609 | + */ |
|
610 | + public static function isGmtDateFieldName($field_name) |
|
611 | + { |
|
612 | + return substr( |
|
613 | + ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name), |
|
614 | + -4, |
|
615 | + 4 |
|
616 | + ) === '_gmt'; |
|
617 | + } |
|
618 | + |
|
619 | + |
|
620 | + /** |
|
621 | + * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone) |
|
622 | + * |
|
623 | + * @param string $field_name |
|
624 | + * @return string |
|
625 | + */ |
|
626 | + public static function removeGmtFromFieldName($field_name) |
|
627 | + { |
|
628 | + if (! ModelDataTranslator::isGmtDateFieldName($field_name)) { |
|
629 | + return $field_name; |
|
630 | + } |
|
631 | + $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey( |
|
632 | + $field_name |
|
633 | + ); |
|
634 | + $query_param_sans_gmt_and_sans_stars = substr( |
|
635 | + $query_param_sans_stars, |
|
636 | + 0, |
|
637 | + strrpos( |
|
638 | + $field_name, |
|
639 | + '_gmt' |
|
640 | + ) |
|
641 | + ); |
|
642 | + return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name); |
|
643 | + } |
|
644 | + |
|
645 | + |
|
646 | + /** |
|
647 | + * Takes a field name from the REST API and prepares it for the model querying |
|
648 | + * |
|
649 | + * @param string $field_name |
|
650 | + * @return string |
|
651 | + */ |
|
652 | + public static function prepareFieldNameFromJson($field_name) |
|
653 | + { |
|
654 | + if (ModelDataTranslator::isGmtDateFieldName($field_name)) { |
|
655 | + return ModelDataTranslator::removeGmtFromFieldName($field_name); |
|
656 | + } |
|
657 | + return $field_name; |
|
658 | + } |
|
659 | + |
|
660 | + |
|
661 | + /** |
|
662 | + * Takes array of field names from REST API and prepares for models |
|
663 | + * |
|
664 | + * @param array $field_names |
|
665 | + * @return array of field names (possibly include model prefixes) |
|
666 | + */ |
|
667 | + public static function prepareFieldNamesFromJson(array $field_names) |
|
668 | + { |
|
669 | + $new_array = array(); |
|
670 | + foreach ($field_names as $key => $field_name) { |
|
671 | + $new_array[ $key ] = ModelDataTranslator::prepareFieldNameFromJson($field_name); |
|
672 | + } |
|
673 | + return $new_array; |
|
674 | + } |
|
675 | + |
|
676 | + |
|
677 | + /** |
|
678 | + * Takes array where array keys are field names (possibly with model path prefixes) |
|
679 | + * from the REST API and prepares them for model querying |
|
680 | + * |
|
681 | + * @param array $field_names_as_keys |
|
682 | + * @return array |
|
683 | + */ |
|
684 | + public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys) |
|
685 | + { |
|
686 | + $new_array = array(); |
|
687 | + foreach ($field_names_as_keys as $field_name => $value) { |
|
688 | + $new_array[ ModelDataTranslator::prepareFieldNameFromJson($field_name) ] = $value; |
|
689 | + } |
|
690 | + return $new_array; |
|
691 | + } |
|
692 | + |
|
693 | + |
|
694 | + /** |
|
695 | + * Prepares an array of model query params for use in the REST API |
|
696 | + * |
|
697 | + * @param array $model_query_params |
|
698 | + * @param EEM_Base $model |
|
699 | + * @param string $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4 |
|
700 | + * REST API |
|
701 | + * @return array which can be passed into the EE4 REST API when querying a model resource |
|
702 | + * @throws EE_Error |
|
703 | + */ |
|
704 | + public static function prepareQueryParamsForRestApi( |
|
705 | + array $model_query_params, |
|
706 | + EEM_Base $model, |
|
707 | + $requested_version = null |
|
708 | + ) { |
|
709 | + if ($requested_version === null) { |
|
710 | + $requested_version = \EED_Core_Rest_Api::latest_rest_api_version(); |
|
711 | + } |
|
712 | + $rest_query_params = $model_query_params; |
|
713 | + if (isset($model_query_params[0])) { |
|
714 | + $rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi( |
|
715 | + $model_query_params[0], |
|
716 | + $model, |
|
717 | + $requested_version |
|
718 | + ); |
|
719 | + unset($rest_query_params[0]); |
|
720 | + } |
|
721 | + if (isset($model_query_params['having'])) { |
|
722 | + $rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi( |
|
723 | + $model_query_params['having'], |
|
724 | + $model, |
|
725 | + $requested_version |
|
726 | + ); |
|
727 | + } |
|
728 | + return apply_filters( |
|
729 | + 'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api', |
|
730 | + $rest_query_params, |
|
731 | + $model_query_params, |
|
732 | + $model, |
|
733 | + $requested_version |
|
734 | + ); |
|
735 | + } |
|
736 | + |
|
737 | + |
|
738 | + /** |
|
739 | + * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api |
|
740 | + * |
|
741 | + * @param array $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params |
|
742 | + * passed into EEM_Base::get_all() |
|
743 | + * @param EEM_Base $model |
|
744 | + * @param string $requested_version eg "4.8.36" |
|
745 | + * @return array ready for use in the rest api query params |
|
746 | + * @throws EE_Error |
|
747 | + * @throws ObjectDetectedException if somehow a PHP object were in the query params' values, |
|
748 | + * (which would be really unusual) |
|
749 | + */ |
|
750 | + public static function prepareConditionsQueryParamsForRestApi( |
|
751 | + $inputted_query_params_of_this_type, |
|
752 | + EEM_Base $model, |
|
753 | + $requested_version |
|
754 | + ) { |
|
755 | + $query_param_for_models = array(); |
|
756 | + foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) { |
|
757 | + $field = ModelDataTranslator::deduceFieldFromQueryParam( |
|
758 | + ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key), |
|
759 | + $model |
|
760 | + ); |
|
761 | + if ($field instanceof EE_Model_Field_Base) { |
|
762 | + // did they specify an operator? |
|
763 | + if (is_array($query_param_value)) { |
|
764 | + $op = $query_param_value[0]; |
|
765 | + $translated_value = array($op); |
|
766 | + if (isset($query_param_value[1])) { |
|
767 | + $value = $query_param_value[1]; |
|
768 | + $translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson( |
|
769 | + $field, |
|
770 | + $value, |
|
771 | + $requested_version |
|
772 | + ); |
|
773 | + } |
|
774 | + } else { |
|
775 | + $translated_value = ModelDataTranslator::prepareFieldValueForJson( |
|
776 | + $field, |
|
777 | + $query_param_value, |
|
778 | + $requested_version |
|
779 | + ); |
|
780 | + } |
|
781 | + $query_param_for_models[ $query_param_key ] = $translated_value; |
|
782 | + } else { |
|
783 | + // so it's not for a field, assume it's a logic query param key |
|
784 | + $query_param_for_models[ $query_param_key ] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi( |
|
785 | + $query_param_value, |
|
786 | + $model, |
|
787 | + $requested_version |
|
788 | + ); |
|
789 | + } |
|
790 | + } |
|
791 | + return $query_param_for_models; |
|
792 | + } |
|
793 | + |
|
794 | + |
|
795 | + /** |
|
796 | + * @param $condition_query_param_key |
|
797 | + * @return string |
|
798 | + */ |
|
799 | + public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key) |
|
800 | + { |
|
801 | + $pos_of_star = strpos($condition_query_param_key, '*'); |
|
802 | + if ($pos_of_star === false) { |
|
803 | + return $condition_query_param_key; |
|
804 | + } else { |
|
805 | + $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star); |
|
806 | + return $condition_query_param_sans_star; |
|
807 | + } |
|
808 | + } |
|
809 | + |
|
810 | + |
|
811 | + /** |
|
812 | + * Takes the input parameter and finds the model field that it indicates. |
|
813 | + * |
|
814 | + * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID |
|
815 | + * @param EEM_Base $model |
|
816 | + * @return EE_Model_Field_Base |
|
817 | + * @throws EE_Error |
|
818 | + */ |
|
819 | + public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model) |
|
820 | + { |
|
821 | + // ok, now proceed with deducing which part is the model's name, and which is the field's name |
|
822 | + // which will help us find the database table and column |
|
823 | + $query_param_parts = explode('.', $query_param_name); |
|
824 | + if (empty($query_param_parts)) { |
|
825 | + throw new EE_Error( |
|
826 | + sprintf( |
|
827 | + __( |
|
828 | + '_extract_column_name is empty when trying to extract column and table name from %s', |
|
829 | + 'event_espresso' |
|
830 | + ), |
|
831 | + $query_param_name |
|
832 | + ) |
|
833 | + ); |
|
834 | + } |
|
835 | + $number_of_parts = count($query_param_parts); |
|
836 | + $last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ]; |
|
837 | + if ($number_of_parts === 1) { |
|
838 | + $field_name = $last_query_param_part; |
|
839 | + } else {// $number_of_parts >= 2 |
|
840 | + // the last part is the column name, and there are only 2parts. therefore... |
|
841 | + $field_name = $last_query_param_part; |
|
842 | + $model = \EE_Registry::instance()->load_model($query_param_parts[ $number_of_parts - 2 ]); |
|
843 | + } |
|
844 | + try { |
|
845 | + return $model->field_settings_for($field_name, false); |
|
846 | + } catch (EE_Error $e) { |
|
847 | + return null; |
|
848 | + } |
|
849 | + } |
|
850 | + |
|
851 | + |
|
852 | + /** |
|
853 | + * Returns true if $data can be easily represented in JSON. |
|
854 | + * Basically, objects and resources can't be represented in JSON easily. |
|
855 | + * |
|
856 | + * @param mixed $data |
|
857 | + * @return bool |
|
858 | + */ |
|
859 | + protected static function isRepresentableInJson($data) |
|
860 | + { |
|
861 | + return is_scalar($data) |
|
862 | + || is_array($data) |
|
863 | + || is_null($data); |
|
864 | + } |
|
865 | 865 | } |
@@ -3,7 +3,6 @@ |
||
3 | 3 | use EventEspresso\core\exceptions\InvalidDataTypeException; |
4 | 4 | use EventEspresso\core\exceptions\InvalidInterfaceException; |
5 | 5 | use EventEspresso\core\interfaces\ResettableInterface; |
6 | - |
|
7 | 6 | use EventEspresso\core\services\database\TableManager; |
8 | 7 | use EventEspresso\core\services\database\TableAnalysis; |
9 | 8 |
@@ -32,1238 +32,1238 @@ |
||
32 | 32 | class EE_Data_Migration_Manager implements ResettableInterface |
33 | 33 | { |
34 | 34 | |
35 | - /** |
|
36 | - * |
|
37 | - * @var EE_Registry |
|
38 | - */ |
|
39 | - // protected $EE; |
|
40 | - /** |
|
41 | - * name of the wordpress option which stores an array of data about |
|
42 | - */ |
|
43 | - const data_migrations_option_name = 'ee_data_migration'; |
|
44 | - |
|
45 | - |
|
46 | - const data_migration_script_option_prefix = 'ee_data_migration_script_'; |
|
47 | - |
|
48 | - const data_migration_script_mapping_option_prefix = 'ee_dms_map_'; |
|
49 | - |
|
50 | - /** |
|
51 | - * name of the wordpress option which stores the database' current version. IE, the code may be at version 4.2.0, |
|
52 | - * but as migrations are performed the database will progress from 3.1.35 to 4.1.0 etc. |
|
53 | - */ |
|
54 | - const current_database_state = 'ee_data_migration_current_db_state'; |
|
55 | - |
|
56 | - /** |
|
57 | - * Special status string returned when we're positive there are no more data migration |
|
58 | - * scripts that can be run. |
|
59 | - */ |
|
60 | - const status_no_more_migration_scripts = 'no_more_migration_scripts'; |
|
61 | - /** |
|
62 | - * string indicating the migration should continue |
|
63 | - */ |
|
64 | - const status_continue = 'status_continue'; |
|
65 | - /** |
|
66 | - * string indicating the migration has completed and should be ended |
|
67 | - */ |
|
68 | - const status_completed = 'status_completed'; |
|
69 | - /** |
|
70 | - * string indicating a fatal error occurred and the data migration should be completely aborted |
|
71 | - */ |
|
72 | - const status_fatal_error = 'status_fatal_error'; |
|
73 | - |
|
74 | - /** |
|
75 | - * the number of 'items' (usually DB rows) to migrate on each 'step' (ajax request sent |
|
76 | - * during migration) |
|
77 | - */ |
|
78 | - const step_size = 50; |
|
79 | - |
|
80 | - /** |
|
81 | - * option name that stores the queue of ee plugins needing to have |
|
82 | - * their data initialized (or re-initialized) once we are done migrations |
|
83 | - */ |
|
84 | - const db_init_queue_option_name = 'ee_db_init_queue'; |
|
85 | - /** |
|
86 | - * Array of information concerning data migrations that have ran in the history |
|
87 | - * of this EE installation. Keys should be the name of the version the script upgraded to |
|
88 | - * |
|
89 | - * @var EE_Data_Migration_Script_Base[] |
|
90 | - */ |
|
91 | - private $_data_migrations_ran = null; |
|
92 | - /** |
|
93 | - * The last ran script. It's nice to store this somewhere accessible, as its easiest |
|
94 | - * to know which was the last run by which is the newest wp option; but in most of the code |
|
95 | - * we just use the local $_data_migration_ran array, which organized the scripts differently |
|
96 | - * |
|
97 | - * @var EE_Data_Migration_Script_Base |
|
98 | - */ |
|
99 | - private $_last_ran_script = null; |
|
100 | - |
|
101 | - /** |
|
102 | - * Similarly to _last_ran_script, but this is the last INCOMPLETE migration script. |
|
103 | - * |
|
104 | - * @var EE_Data_Migration_Script_Base |
|
105 | - */ |
|
106 | - private $_last_ran_incomplete_script = null; |
|
107 | - /** |
|
108 | - * array where keys are classnames, and values are filepaths of all the known migration scripts |
|
109 | - * |
|
110 | - * @var array |
|
111 | - */ |
|
112 | - private $_data_migration_class_to_filepath_map; |
|
113 | - |
|
114 | - /** |
|
115 | - * the following 4 properties are fully set on construction. |
|
116 | - * Note: the first two apply to whether to continue running ALL migration scripts (ie, even though we're finished |
|
117 | - * one, we may want to start the next one); whereas the last two indicate whether to continue running a single |
|
118 | - * data migration script |
|
119 | - * |
|
120 | - * @var array |
|
121 | - */ |
|
122 | - public $stati_that_indicate_to_continue_migrations = array(); |
|
123 | - |
|
124 | - public $stati_that_indicate_to_stop_migrations = array(); |
|
125 | - |
|
126 | - public $stati_that_indicate_to_continue_single_migration_script = array(); |
|
127 | - |
|
128 | - public $stati_that_indicate_to_stop_single_migration_script = array(); |
|
129 | - |
|
130 | - /** |
|
131 | - * @var \EventEspresso\core\services\database\TableManager $table_manager |
|
132 | - */ |
|
133 | - protected $_table_manager; |
|
134 | - |
|
135 | - /** |
|
136 | - * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis |
|
137 | - */ |
|
138 | - protected $_table_analysis; |
|
139 | - |
|
140 | - /** |
|
141 | - * @var array $script_migration_versions |
|
142 | - */ |
|
143 | - protected $script_migration_versions; |
|
144 | - |
|
145 | - /** |
|
146 | - * @var EE_Data_Migration_Manager $_instance |
|
147 | - * @access private |
|
148 | - */ |
|
149 | - private static $_instance = null; |
|
150 | - |
|
151 | - |
|
152 | - /** |
|
153 | - * @singleton method used to instantiate class object |
|
154 | - * @access public |
|
155 | - * @return EE_Data_Migration_Manager instance |
|
156 | - */ |
|
157 | - public static function instance() |
|
158 | - { |
|
159 | - // check if class object is instantiated |
|
160 | - if (! self::$_instance instanceof EE_Data_Migration_Manager) { |
|
161 | - self::$_instance = new self(); |
|
162 | - } |
|
163 | - return self::$_instance; |
|
164 | - } |
|
165 | - |
|
166 | - /** |
|
167 | - * resets the singleton to its brand-new state (but does NOT delete old references to the old singleton. Meaning, |
|
168 | - * all new usages of the singleton should be made with Classname::instance()) and returns it |
|
169 | - * |
|
170 | - * @return EE_Data_Migration_Manager |
|
171 | - */ |
|
172 | - public static function reset() |
|
173 | - { |
|
174 | - self::$_instance = null; |
|
175 | - return self::instance(); |
|
176 | - } |
|
177 | - |
|
178 | - |
|
179 | - /** |
|
180 | - * constructor |
|
181 | - */ |
|
182 | - private function __construct() |
|
183 | - { |
|
184 | - $this->stati_that_indicate_to_continue_migrations = array( |
|
185 | - self::status_continue, |
|
186 | - self::status_completed, |
|
187 | - ); |
|
188 | - $this->stati_that_indicate_to_stop_migrations = array( |
|
189 | - self::status_fatal_error, |
|
190 | - self::status_no_more_migration_scripts, |
|
191 | - ); |
|
192 | - $this->stati_that_indicate_to_continue_single_migration_script = array( |
|
193 | - self::status_continue, |
|
194 | - ); |
|
195 | - $this->stati_that_indicate_to_stop_single_migration_script = array( |
|
196 | - self::status_completed, |
|
197 | - self::status_fatal_error |
|
198 | - // note: status_no_more_migration_scripts doesn't apply |
|
199 | - ); |
|
200 | - // make sure we've included the base migration script, because we may need the EE_DMS_Unknown_1_0_0 class |
|
201 | - // to be defined, because right now it doesn't get autoloaded on its own |
|
202 | - EE_Registry::instance()->load_core('Data_Migration_Class_Base', array(), true); |
|
203 | - EE_Registry::instance()->load_core('Data_Migration_Script_Base', array(), true); |
|
204 | - EE_Registry::instance()->load_core('DMS_Unknown_1_0_0', array(), true); |
|
205 | - EE_Registry::instance()->load_core('Data_Migration_Script_Stage', array(), true); |
|
206 | - EE_Registry::instance()->load_core('Data_Migration_Script_Stage_Table', array(), true); |
|
207 | - $this->_table_manager = EE_Registry::instance()->create('TableManager', array(), true); |
|
208 | - $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true); |
|
209 | - } |
|
210 | - |
|
211 | - |
|
212 | - /** |
|
213 | - * Deciphers, from an option's name, what plugin and version it relates to (see _save_migrations_ran to see what |
|
214 | - * the option names are like, but generally they're like |
|
215 | - * 'ee_data_migration_script_Core.4.1.0' in 4.2 or 'ee_data_migration_script_4.1.0' before that). |
|
216 | - * The option name shouldn't ever be like 'ee_data_migration_script_Core.4.1.0.reg' because it's derived, |
|
217 | - * indirectly, from the data migration's classname, which should always be like EE_DMS_%s_%d_%d_%d.dms.php (eg |
|
218 | - * EE_DMS_Core_4_1_0.dms.php) |
|
219 | - * |
|
220 | - * @param string $option_name (see EE_Data_Migration_Manage::_save_migrations_ran() where the option name is set) |
|
221 | - * @return array where the first item is the plugin slug (eg 'Core','Calendar',etc) and the 2nd is the version of |
|
222 | - * that plugin (eg '4.1.0') |
|
223 | - */ |
|
224 | - private function _get_plugin_slug_and_version_string_from_dms_option_name($option_name) |
|
225 | - { |
|
226 | - $plugin_slug_and_version_string = str_replace( |
|
227 | - EE_Data_Migration_Manager::data_migration_script_option_prefix, |
|
228 | - "", |
|
229 | - $option_name |
|
230 | - ); |
|
231 | - // check if $plugin_slug_and_version_string is like '4.1.0' (4.1-style) or 'Core.4.1.0' (4.2-style) |
|
232 | - $parts = explode(".", $plugin_slug_and_version_string); |
|
233 | - |
|
234 | - if (count($parts) == 4) { |
|
235 | - // it's 4.2-style.eg Core.4.1.0 |
|
236 | - $plugin_slug = $parts[0];// eg Core |
|
237 | - $version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0 |
|
238 | - } else { |
|
239 | - // it's 4.1-style: eg 4.1.0 |
|
240 | - $plugin_slug = 'Core'; |
|
241 | - $version_string = $plugin_slug_and_version_string;// eg 4.1.0 |
|
242 | - } |
|
243 | - return array($plugin_slug, $version_string); |
|
244 | - } |
|
245 | - |
|
246 | - /** |
|
247 | - * Gets the DMS class from the wordpress option, otherwise throws an EE_Error if it's not |
|
248 | - * for a known DMS class. |
|
249 | - * |
|
250 | - * @param string $dms_option_name |
|
251 | - * @param string $dms_option_value (serialized) |
|
252 | - * @return EE_Data_Migration_Script_Base |
|
253 | - * @throws EE_Error |
|
254 | - */ |
|
255 | - private function _get_dms_class_from_wp_option($dms_option_name, $dms_option_value) |
|
256 | - { |
|
257 | - $data_migration_data = maybe_unserialize($dms_option_value); |
|
258 | - if (isset($data_migration_data['class']) && class_exists($data_migration_data['class'])) { |
|
259 | - $class = new $data_migration_data['class']; |
|
260 | - if ($class instanceof EE_Data_Migration_Script_Base) { |
|
261 | - $class->instantiate_from_array_of_properties($data_migration_data); |
|
262 | - return $class; |
|
263 | - } else { |
|
264 | - // huh, so its an object but not a data migration script?? that shouldn't happen |
|
265 | - // just leave it as an array (which will probably just get ignored) |
|
266 | - throw new EE_Error( |
|
267 | - sprintf( |
|
268 | - __( |
|
269 | - "Trying to retrieve DMS class from wp option. No DMS by the name '%s' exists", |
|
270 | - 'event_espresso' |
|
271 | - ), |
|
272 | - $data_migration_data['class'] |
|
273 | - ) |
|
274 | - ); |
|
275 | - } |
|
276 | - } else { |
|
277 | - // so the data doesn't specify a class. So it must either be a legacy array of info or some array (which we'll probably just ignore), or a class that no longer exists |
|
278 | - throw new EE_Error( |
|
279 | - sprintf(__("The wp option with key '%s' does not represent a DMS", 'event_espresso'), $dms_option_name) |
|
280 | - ); |
|
281 | - } |
|
282 | - } |
|
283 | - |
|
284 | - /** |
|
285 | - * Gets the array describing what data migrations have run. Also has a side-effect of recording which was the last |
|
286 | - * ran, and which was the last ran which hasn't finished yet |
|
287 | - * |
|
288 | - * @return array where each element should be an array of EE_Data_Migration_Script_Base (but also has a few legacy |
|
289 | - * arrays in there - which should probably be ignored) |
|
290 | - */ |
|
291 | - public function get_data_migrations_ran() |
|
292 | - { |
|
293 | - if (! $this->_data_migrations_ran) { |
|
294 | - // setup autoloaders for each of the scripts in there |
|
295 | - $this->get_all_data_migration_scripts_available(); |
|
296 | - $data_migrations_options = $this->get_all_migration_script_options( |
|
297 | - );// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array())); |
|
298 | - |
|
299 | - $data_migrations_ran = array(); |
|
300 | - // convert into data migration script classes where possible |
|
301 | - foreach ($data_migrations_options as $data_migration_option) { |
|
302 | - list($plugin_slug, $version_string) = $this->_get_plugin_slug_and_version_string_from_dms_option_name( |
|
303 | - $data_migration_option['option_name'] |
|
304 | - ); |
|
305 | - |
|
306 | - try { |
|
307 | - $class = $this->_get_dms_class_from_wp_option( |
|
308 | - $data_migration_option['option_name'], |
|
309 | - $data_migration_option['option_value'] |
|
310 | - ); |
|
311 | - $data_migrations_ran[ $plugin_slug ][ $version_string ] = $class; |
|
312 | - // ok so far THIS is the 'last-ran-script'... unless we find another on next iteration |
|
313 | - $this->_last_ran_script = $class; |
|
314 | - if (! $class->is_completed()) { |
|
315 | - // sometimes we also like to know which was the last incomplete script (or if there are any at all) |
|
316 | - $this->_last_ran_incomplete_script = $class; |
|
317 | - } |
|
318 | - } catch (EE_Error $e) { |
|
319 | - // ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs |
|
320 | - $data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize( |
|
321 | - $data_migration_option['option_value'] |
|
322 | - ); |
|
323 | - } |
|
324 | - } |
|
325 | - // so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays |
|
326 | - $this->_data_migrations_ran = $data_migrations_ran; |
|
327 | - if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) { |
|
328 | - $this->_data_migrations_ran = array(); |
|
329 | - } |
|
330 | - } |
|
331 | - return $this->_data_migrations_ran; |
|
332 | - } |
|
333 | - |
|
334 | - |
|
335 | - /** |
|
336 | - * |
|
337 | - * @param string $script_name eg 'DMS_Core_4_1_0' |
|
338 | - * @param string $old_table eg 'wp_events_detail' |
|
339 | - * @param string $old_pk eg 'wp_esp_posts' |
|
340 | - * @param $new_table |
|
341 | - * @return mixed string or int |
|
342 | - */ |
|
343 | - public function get_mapping_new_pk($script_name, $old_table, $old_pk, $new_table) |
|
344 | - { |
|
345 | - $script = EE_Registry::instance()->load_dms($script_name); |
|
346 | - $mapping = $script->get_mapping_new_pk($old_table, $old_pk, $new_table); |
|
347 | - return $mapping; |
|
348 | - } |
|
349 | - |
|
350 | - /** |
|
351 | - * Gets all the options containing migration scripts that have been run. Ordering is important: it's assumed that |
|
352 | - * the last option returned in this array is the most-recently ran DMS option |
|
353 | - * |
|
354 | - * @return array |
|
355 | - */ |
|
356 | - public function get_all_migration_script_options() |
|
357 | - { |
|
358 | - global $wpdb; |
|
359 | - return $wpdb->get_results( |
|
360 | - "SELECT * FROM {$wpdb->options} WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id ASC", |
|
361 | - ARRAY_A |
|
362 | - ); |
|
363 | - } |
|
364 | - |
|
365 | - /** |
|
366 | - * Gets the array of folders which contain data migration scripts. Also adds them to be auto-loaded |
|
367 | - * |
|
368 | - * @return array where each value is the full folder path of a folder containing data migration scripts, WITH |
|
369 | - * slashes at the end of the folder name. |
|
370 | - */ |
|
371 | - public function get_data_migration_script_folders() |
|
372 | - { |
|
373 | - return apply_filters( |
|
374 | - 'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders', |
|
375 | - array('Core' => EE_CORE . 'data_migration_scripts') |
|
376 | - ); |
|
377 | - } |
|
378 | - |
|
379 | - /** |
|
380 | - * Gets the version the migration script upgrades to |
|
381 | - * |
|
382 | - * @param string $migration_script_name eg 'EE_DMS_Core_4_1_0' |
|
383 | - * @return array { |
|
384 | - * @type string $slug like 'Core','Calendar',etc |
|
385 | - * @type string $version like 4.3.0 |
|
386 | - * } |
|
387 | - * @throws EE_Error |
|
388 | - */ |
|
389 | - public function script_migrates_to_version($migration_script_name, $eeAddonClass = '') |
|
390 | - { |
|
391 | - if (isset($this->script_migration_versions[ $migration_script_name ])) { |
|
392 | - return $this->script_migration_versions[ $migration_script_name ]; |
|
393 | - } |
|
394 | - $dms_info = $this->parse_dms_classname($migration_script_name); |
|
395 | - $this->script_migration_versions[ $migration_script_name ] = array( |
|
396 | - 'slug' => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'], |
|
397 | - 'version' => $dms_info['major_version'] . "." . $dms_info['minor_version'] . "." . $dms_info['micro_version'], |
|
398 | - ); |
|
399 | - return $this->script_migration_versions[ $migration_script_name ]; |
|
400 | - } |
|
401 | - |
|
402 | - /** |
|
403 | - * Gets the juicy details out of a dms filename like 'EE_DMS_Core_4_1_0' |
|
404 | - * |
|
405 | - * @param string $classname |
|
406 | - * @return array with keys 'slug','major_version','minor_version', and 'micro_version' (the last 3 are ints) |
|
407 | - * @throws EE_Error |
|
408 | - */ |
|
409 | - public function parse_dms_classname($classname) |
|
410 | - { |
|
411 | - $matches = array(); |
|
412 | - preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches); |
|
413 | - if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) { |
|
414 | - throw new EE_Error( |
|
415 | - sprintf( |
|
416 | - __( |
|
417 | - "%s is not a valid Data Migration Script. The classname should be like EE_DMS_w_x_y_z, where w is either 'Core' or the slug of an addon and x, y and z are numbers, ", |
|
418 | - "event_espresso" |
|
419 | - ), |
|
420 | - $classname |
|
421 | - ) |
|
422 | - ); |
|
423 | - } |
|
424 | - return array( |
|
425 | - 'slug' => $matches[1], |
|
426 | - 'major_version' => intval($matches[2]), |
|
427 | - 'minor_version' => intval($matches[3]), |
|
428 | - 'micro_version' => intval($matches[4]), |
|
429 | - ); |
|
430 | - } |
|
431 | - |
|
432 | - /** |
|
433 | - * Ensures that the option indicating the current DB version is set. This should only be |
|
434 | - * a concern when activating EE for the first time, THEORETICALLY. |
|
435 | - * If we detect that we're activating EE4 over top of EE3.1, then we set the current db state to 3.1.x, otherwise |
|
436 | - * to 4.1.x. |
|
437 | - * |
|
438 | - * @return string of current db state |
|
439 | - */ |
|
440 | - public function ensure_current_database_state_is_set() |
|
441 | - { |
|
442 | - $espresso_db_core_updates = get_option('espresso_db_update', array()); |
|
443 | - $db_state = get_option(EE_Data_Migration_Manager::current_database_state); |
|
444 | - if (! $db_state) { |
|
445 | - // mark the DB as being in the state as the last version in there. |
|
446 | - // this is done to trigger maintenance mode and do data migration scripts |
|
447 | - // if the admin installed this version of EE over 3.1.x or 4.0.x |
|
448 | - // otherwise, the normal maintenance mode code is fine |
|
449 | - $previous_versions_installed = array_keys($espresso_db_core_updates); |
|
450 | - $previous_version_installed = end($previous_versions_installed); |
|
451 | - if (version_compare('4.1.0', $previous_version_installed)) { |
|
452 | - // last installed version was less than 4.1 |
|
453 | - // so we want the data migrations to happen. SO, we're going to say the DB is at that state |
|
454 | - $db_state = array('Core' => $previous_version_installed); |
|
455 | - } else { |
|
456 | - $db_state = array('Core' => EVENT_ESPRESSO_VERSION); |
|
457 | - } |
|
458 | - update_option(EE_Data_Migration_Manager::current_database_state, $db_state); |
|
459 | - } |
|
460 | - // in 4.1, $db_state would have only been a simple string like '4.1.0', |
|
461 | - // but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's |
|
462 | - // db, and possibly other keys for other addons like 'Calendar','Permissions',etc |
|
463 | - if (! is_array($db_state)) { |
|
464 | - $db_state = array('Core' => $db_state); |
|
465 | - update_option(EE_Data_Migration_Manager::current_database_state, $db_state); |
|
466 | - } |
|
467 | - return $db_state; |
|
468 | - } |
|
469 | - |
|
470 | - /** |
|
471 | - * Checks if there are any data migration scripts that ought to be run. If found, |
|
472 | - * returns the instantiated classes. If none are found (ie, they've all already been run |
|
473 | - * or they don't apply), returns an empty array |
|
474 | - * |
|
475 | - * @return EE_Data_Migration_Script_Base[] |
|
476 | - */ |
|
477 | - public function check_for_applicable_data_migration_scripts() |
|
478 | - { |
|
479 | - // get the option describing what options have already run |
|
480 | - $scripts_ran = $this->get_data_migrations_ran(); |
|
481 | - // $scripts_ran = array('4.1.0.core'=>array('monkey'=>null)); |
|
482 | - $script_class_and_filepaths_available = $this->get_all_data_migration_scripts_available(); |
|
483 | - |
|
484 | - |
|
485 | - $current_database_state = $this->ensure_current_database_state_is_set(); |
|
486 | - // determine which have already been run |
|
487 | - $script_classes_that_should_run_per_iteration = array(); |
|
488 | - $iteration = 0; |
|
489 | - $next_database_state_to_consider = $current_database_state; |
|
490 | - $theoretical_database_state = null; |
|
491 | - do { |
|
492 | - // the next state after the currently-considered one will start off looking the same as the current, but we may make additions... |
|
493 | - $theoretical_database_state = $next_database_state_to_consider; |
|
494 | - // the next db state to consider is "what would the DB be like had we run all the scripts we found that applied last time?) |
|
495 | - foreach ($script_class_and_filepaths_available as $classname => $filepath) { |
|
496 | - $migrates_to_version = $this->script_migrates_to_version($classname); |
|
497 | - $script_converts_plugin_slug = $migrates_to_version['slug']; |
|
498 | - $script_converts_to_version = $migrates_to_version['version']; |
|
499 | - // check if this version script is DONE or not; or if it's never been ran |
|
500 | - if (! $scripts_ran || |
|
501 | - ! isset($scripts_ran[ $script_converts_plugin_slug ]) || |
|
502 | - ! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])) { |
|
503 | - // we haven't ran this conversion script before |
|
504 | - // now check if it applies... note that we've added an autoloader for it on get_all_data_migration_scripts_available |
|
505 | - $script = new $classname($this->_get_table_manager(), $this->_get_table_analysis()); |
|
506 | - /* @var $script EE_Data_Migration_Script_Base */ |
|
507 | - $can_migrate = $script->can_migrate_from_version($theoretical_database_state); |
|
508 | - if ($can_migrate) { |
|
509 | - $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script; |
|
510 | - $migrates_to_version = $script->migrates_to_version(); |
|
511 | - $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version']; |
|
512 | - unset($script_class_and_filepaths_available[ $classname ]); |
|
513 | - } |
|
514 | - } elseif ($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ] instanceof EE_Data_Migration_Script_Base) { |
|
515 | - // this script has been ran, or at least started |
|
516 | - $script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ]; |
|
517 | - if ($script->get_status() != self::status_completed) { |
|
518 | - // this script is already underway... keep going with it |
|
519 | - $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script; |
|
520 | - $migrates_to_version = $script->migrates_to_version(); |
|
521 | - $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version']; |
|
522 | - unset($script_class_and_filepaths_available[ $classname ]); |
|
523 | - } else { |
|
524 | - // it must have a status that indicates it has finished, so we don't want to try and run it again |
|
525 | - } |
|
526 | - } else { |
|
527 | - // it exists but it's not a proper data migration script |
|
528 | - // maybe the script got renamed? or was simply removed from EE? |
|
529 | - // either way, its certainly not runnable! |
|
530 | - } |
|
531 | - } |
|
532 | - $iteration++; |
|
533 | - } while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6); |
|
534 | - // ok we have all the scripts that should run, now let's make them into flat array |
|
535 | - $scripts_that_should_run = array(); |
|
536 | - foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) { |
|
537 | - ksort($scripts_at_priority); |
|
538 | - foreach ($scripts_at_priority as $scripts) { |
|
539 | - foreach ($scripts as $script) { |
|
540 | - $scripts_that_should_run[ get_class($script) ] = $script; |
|
541 | - } |
|
542 | - } |
|
543 | - } |
|
544 | - |
|
545 | - do_action( |
|
546 | - 'AHEE__EE_Data_Migration_Manager__check_for_applicable_data_migration_scripts__scripts_that_should_run', |
|
547 | - $scripts_that_should_run |
|
548 | - ); |
|
549 | - return $scripts_that_should_run; |
|
550 | - } |
|
551 | - |
|
552 | - |
|
553 | - /** |
|
554 | - * Gets the script which is currently being ran, if there is one. If $include_completed_scripts is set to TRUE |
|
555 | - * it will return the last ran script even if its complete. |
|
556 | - * This means: if you want to find the currently-executing script, leave it as FALSE. |
|
557 | - * If you really just want to find the script which ran most recently, regardless of status, leave it as TRUE. |
|
558 | - * |
|
559 | - * @param bool $include_completed_scripts |
|
560 | - * @return EE_Data_Migration_Script_Base |
|
561 | - */ |
|
562 | - public function get_last_ran_script($include_completed_scripts = false) |
|
563 | - { |
|
564 | - // make sure we've setup the class properties _last_ran_script and _last_ran_incomplete_script |
|
565 | - if (! $this->_data_migrations_ran) { |
|
566 | - $this->get_data_migrations_ran(); |
|
567 | - } |
|
568 | - if ($include_completed_scripts) { |
|
569 | - return $this->_last_ran_script; |
|
570 | - } else { |
|
571 | - return $this->_last_ran_incomplete_script; |
|
572 | - } |
|
573 | - } |
|
574 | - |
|
575 | - |
|
576 | - /** |
|
577 | - * Runs the data migration scripts (well, each request to this method calls one of the |
|
578 | - * data migration scripts' migration_step() functions). |
|
579 | - * |
|
580 | - * @param int $step_size |
|
581 | - * @throws EE_Error |
|
582 | - * @return array { |
|
583 | - * // where the first item is one EE_Data_Migration_Script_Base's stati, |
|
584 | - * //and the second item is a string describing what was done |
|
585 | - * @type int $records_to_migrate from the current migration script |
|
586 | - * @type int $records_migrated |
|
587 | - * @type string $status one of EE_Data_Migration_Manager::status_* |
|
588 | - * @type string $script verbose name of the current DMS |
|
589 | - * @type string $message string describing what was done during this step |
|
590 | - * } |
|
591 | - */ |
|
592 | - public function migration_step($step_size = 0) |
|
593 | - { |
|
594 | - |
|
595 | - // bandaid fix for issue https://events.codebasehq.com/projects/event-espresso/tickets/7535 |
|
596 | - if (class_exists('EE_CPT_Strategy')) { |
|
597 | - remove_action('pre_get_posts', array(EE_CPT_Strategy::instance(), 'pre_get_posts'), 5); |
|
598 | - } |
|
599 | - |
|
600 | - try { |
|
601 | - $currently_executing_script = $this->get_last_ran_script(); |
|
602 | - if (! $currently_executing_script) { |
|
603 | - // Find the next script that needs to execute |
|
604 | - $scripts = $this->check_for_applicable_data_migration_scripts(); |
|
605 | - if (! $scripts) { |
|
606 | - // huh, no more scripts to run... apparently we're done! |
|
607 | - // but dont forget to make sure initial data is there |
|
608 | - // we should be good to allow them to exit maintenance mode now |
|
609 | - EE_Maintenance_Mode::instance()->set_maintenance_level( |
|
610 | - intval(EE_Maintenance_Mode::level_0_not_in_maintenance) |
|
611 | - ); |
|
612 | - // saving migrations ran should actually be unnecessary, but leaving in place just in case |
|
613 | - // remember this migration was finished (even if we timeout initing db for core and plugins) |
|
614 | - $this->_save_migrations_ran(); |
|
615 | - // make sure DB was updated AFTER we've recorded the migration was done |
|
616 | - $this->initialize_db_for_enqueued_ee_plugins(); |
|
617 | - return array( |
|
618 | - 'records_to_migrate' => 1, |
|
619 | - 'records_migrated' => 1, |
|
620 | - 'status' => self::status_no_more_migration_scripts, |
|
621 | - 'script' => __("Data Migration Completed Successfully", "event_espresso"), |
|
622 | - 'message' => __("All done!", "event_espresso"), |
|
623 | - ); |
|
624 | - } |
|
625 | - $currently_executing_script = array_shift($scripts); |
|
626 | - // and add to the array/wp option showing the scripts ran |
|
627 | - |
|
628 | - $migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script)); |
|
629 | - $plugin_slug = $migrates_to['slug']; |
|
630 | - $version = $migrates_to['version']; |
|
631 | - $this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script; |
|
632 | - } |
|
633 | - $current_script_name = get_class($currently_executing_script); |
|
634 | - } catch (Exception $e) { |
|
635 | - // an exception occurred while trying to get migration scripts |
|
636 | - |
|
637 | - $message = sprintf( |
|
638 | - __("Error Message: %sStack Trace:%s", "event_espresso"), |
|
639 | - $e->getMessage() . '<br>', |
|
640 | - $e->getTraceAsString() |
|
641 | - ); |
|
642 | - // record it on the array of data migration scripts ran. This will be overwritten next time we try and try to run data migrations |
|
643 | - // but that's ok-- it's just an FYI to support that we couldn't even run any data migrations |
|
644 | - $this->add_error_to_migrations_ran( |
|
645 | - sprintf(__("Could not run data migrations because: %s", "event_espresso"), $message) |
|
646 | - ); |
|
647 | - return array( |
|
648 | - 'records_to_migrate' => 1, |
|
649 | - 'records_migrated' => 0, |
|
650 | - 'status' => self::status_fatal_error, |
|
651 | - 'script' => __("Error loading data migration scripts", "event_espresso"), |
|
652 | - 'message' => $message, |
|
653 | - ); |
|
654 | - } |
|
655 | - // ok so we definitely have a data migration script |
|
656 | - try { |
|
657 | - // how big of a bite do we want to take? Allow users to easily override via their wp-config |
|
658 | - if (! absint($step_size) > 0) { |
|
659 | - $step_size = defined('EE_MIGRATION_STEP_SIZE') && absint(EE_MIGRATION_STEP_SIZE) |
|
660 | - ? EE_MIGRATION_STEP_SIZE : EE_Data_Migration_Manager::step_size; |
|
661 | - } |
|
662 | - // do what we came to do! |
|
663 | - $currently_executing_script->migration_step($step_size); |
|
664 | - // can we wrap it up and verify default data? |
|
665 | - $init_dbs = false; |
|
666 | - switch ($currently_executing_script->get_status()) { |
|
667 | - case EE_Data_Migration_Manager::status_continue: |
|
668 | - $response_array = array( |
|
669 | - 'records_to_migrate' => $currently_executing_script->count_records_to_migrate(), |
|
670 | - 'records_migrated' => $currently_executing_script->count_records_migrated(), |
|
671 | - 'status' => EE_Data_Migration_Manager::status_continue, |
|
672 | - 'message' => $currently_executing_script->get_feedback_message(), |
|
673 | - 'script' => $currently_executing_script->pretty_name(), |
|
674 | - ); |
|
675 | - break; |
|
676 | - case EE_Data_Migration_Manager::status_completed: |
|
677 | - // ok so THAT script has completed |
|
678 | - $this->update_current_database_state_to($this->script_migrates_to_version($current_script_name)); |
|
679 | - $response_array = array( |
|
680 | - 'records_to_migrate' => $currently_executing_script->count_records_to_migrate(), |
|
681 | - 'records_migrated' => $currently_executing_script->count_records_migrated(), |
|
682 | - 'status' => EE_Data_Migration_Manager::status_completed, |
|
683 | - 'message' => $currently_executing_script->get_feedback_message(), |
|
684 | - 'script' => sprintf( |
|
685 | - __("%s Completed", 'event_espresso'), |
|
686 | - $currently_executing_script->pretty_name() |
|
687 | - ), |
|
688 | - ); |
|
689 | - // check if there are any more after this one. |
|
690 | - $scripts_remaining = $this->check_for_applicable_data_migration_scripts(); |
|
691 | - if (! $scripts_remaining) { |
|
692 | - // we should be good to allow them to exit maintenance mode now |
|
693 | - EE_Maintenance_Mode::instance()->set_maintenance_level( |
|
694 | - intval(EE_Maintenance_Mode::level_0_not_in_maintenance) |
|
695 | - ); |
|
696 | - // huh, no more scripts to run... apparently we're done! |
|
697 | - // but dont forget to make sure initial data is there |
|
698 | - $init_dbs = true; |
|
699 | - $response_array['status'] = self::status_no_more_migration_scripts; |
|
700 | - } |
|
701 | - break; |
|
702 | - default: |
|
703 | - $response_array = array( |
|
704 | - 'records_to_migrate' => $currently_executing_script->count_records_to_migrate(), |
|
705 | - 'records_migrated' => $currently_executing_script->count_records_migrated(), |
|
706 | - 'status' => $currently_executing_script->get_status(), |
|
707 | - 'message' => sprintf( |
|
708 | - __("Minor errors occurred during %s: %s", "event_espresso"), |
|
709 | - $currently_executing_script->pretty_name(), |
|
710 | - implode(", ", $currently_executing_script->get_errors()) |
|
711 | - ), |
|
712 | - 'script' => $currently_executing_script->pretty_name(), |
|
713 | - ); |
|
714 | - break; |
|
715 | - } |
|
716 | - } catch (Exception $e) { |
|
717 | - // ok so some exception was thrown which killed the data migration script |
|
718 | - // double-check we have a real script |
|
719 | - if ($currently_executing_script instanceof EE_Data_Migration_Script_Base) { |
|
720 | - $script_name = $currently_executing_script->pretty_name(); |
|
721 | - $currently_executing_script->set_broken(); |
|
722 | - $currently_executing_script->add_error($e->getMessage()); |
|
723 | - } else { |
|
724 | - $script_name = __("Error getting Migration Script", "event_espresso"); |
|
725 | - } |
|
726 | - $response_array = array( |
|
727 | - 'records_to_migrate' => 1, |
|
728 | - 'records_migrated' => 0, |
|
729 | - 'status' => self::status_fatal_error, |
|
730 | - 'message' => sprintf( |
|
731 | - __("A fatal error occurred during the migration: %s", "event_espresso"), |
|
732 | - $e->getMessage() |
|
733 | - ), |
|
734 | - 'script' => $script_name, |
|
735 | - ); |
|
736 | - } |
|
737 | - $successful_save = $this->_save_migrations_ran(); |
|
738 | - if ($successful_save !== true) { |
|
739 | - // ok so the current wp option didn't save. that's tricky, because we'd like to update it |
|
740 | - // and mark it as having a fatal error, but remember- WE CAN'T SAVE THIS WP OPTION! |
|
741 | - // however, if we throw an exception, and return that, then the next request |
|
742 | - // won't have as much info in it, and it may be able to save |
|
743 | - throw new EE_Error( |
|
744 | - sprintf( |
|
745 | - __( |
|
746 | - "The error '%s' occurred updating the status of the migration. This is a FATAL ERROR, but the error is preventing the system from remembering that. Please contact event espresso support.", |
|
747 | - "event_espresso" |
|
748 | - ), |
|
749 | - $successful_save |
|
750 | - ) |
|
751 | - ); |
|
752 | - } |
|
753 | - // if we're all done, initialize EE plugins' default data etc. |
|
754 | - if ($init_dbs) { |
|
755 | - $this->initialize_db_for_enqueued_ee_plugins(); |
|
756 | - } |
|
757 | - return $response_array; |
|
758 | - } |
|
759 | - |
|
760 | - |
|
761 | - /** |
|
762 | - * Echo out JSON response to migration script AJAX requests. Takes precautions |
|
763 | - * to buffer output so that we don't throw junk into our json. |
|
764 | - * |
|
765 | - * @return array with keys: |
|
766 | - * 'records_to_migrate' which counts ALL the records for the current migration, and should remain constant. (ie, |
|
767 | - * it's NOT the count of hwo many remain) |
|
768 | - * 'records_migrated' which also counts ALL the records which have been migrated (ie, percent_complete = |
|
769 | - * records_migrated/records_to_migrate) |
|
770 | - * 'status'=>a string, one of EE_Data_migration_Manager::status_* |
|
771 | - * 'message'=>a string, containing any message you want to show to the user. We may decide to split this up into |
|
772 | - * errors, notifications, and successes |
|
773 | - * 'script'=>a pretty name of the script currently running |
|
774 | - */ |
|
775 | - public function response_to_migration_ajax_request() |
|
776 | - { |
|
777 | - ob_start(); |
|
778 | - try { |
|
779 | - $response = $this->migration_step(); |
|
780 | - } catch (Exception $e) { |
|
781 | - $response = array( |
|
782 | - 'records_to_migrate' => 0, |
|
783 | - 'records_migrated' => 0, |
|
784 | - 'status' => EE_Data_Migration_Manager::status_fatal_error, |
|
785 | - 'message' => sprintf( |
|
786 | - __("Unknown fatal error occurred: %s", "event_espresso"), |
|
787 | - $e->getMessage() |
|
788 | - ), |
|
789 | - 'script' => 'Unknown', |
|
790 | - ); |
|
791 | - $this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString()); |
|
792 | - } |
|
793 | - $warnings_etc = @ob_get_contents(); |
|
794 | - ob_end_clean(); |
|
795 | - $response['message'] .= $warnings_etc; |
|
796 | - return $response; |
|
797 | - } |
|
798 | - |
|
799 | - /** |
|
800 | - * Updates the wordpress option that keeps track of which which EE version the database |
|
801 | - * is at (ie, the code may be at 4.1.0, but the database is still at 3.1.35) |
|
802 | - * |
|
803 | - * @param array $slug_and_version { |
|
804 | - * @type string $slug like 'Core' or 'Calendar', |
|
805 | - * @type string $version like '4.1.0' |
|
806 | - * } |
|
807 | - * @return void |
|
808 | - */ |
|
809 | - public function update_current_database_state_to($slug_and_version = null) |
|
810 | - { |
|
811 | - if (! $slug_and_version) { |
|
812 | - // no version was provided, assume it should be at the current code version |
|
813 | - $slug_and_version = array('slug' => 'Core', 'version' => espresso_version()); |
|
814 | - } |
|
815 | - $current_database_state = get_option(self::current_database_state); |
|
816 | - $current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version']; |
|
817 | - update_option(self::current_database_state, $current_database_state); |
|
818 | - } |
|
819 | - |
|
820 | - /** |
|
821 | - * Determines if the database is currently at a state matching what's indicated in $slug and $version. |
|
822 | - * |
|
823 | - * @param array $slug_and_version { |
|
824 | - * @type string $slug like 'Core' or 'Calendar', |
|
825 | - * @type string $version like '4.1.0' |
|
826 | - * } |
|
827 | - * @return boolean |
|
828 | - */ |
|
829 | - public function database_needs_updating_to($slug_and_version) |
|
830 | - { |
|
831 | - |
|
832 | - $slug = $slug_and_version['slug']; |
|
833 | - $version = $slug_and_version['version']; |
|
834 | - $current_database_state = get_option(self::current_database_state); |
|
835 | - if (! isset($current_database_state[ $slug ])) { |
|
836 | - return true; |
|
837 | - } else { |
|
838 | - // just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes |
|
839 | - $version_parts_current_db_state = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3); |
|
840 | - $version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3); |
|
841 | - $needs_updating = false; |
|
842 | - foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) { |
|
843 | - if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) { |
|
844 | - $needs_updating = true; |
|
845 | - break; |
|
846 | - } |
|
847 | - } |
|
848 | - return $needs_updating; |
|
849 | - } |
|
850 | - } |
|
851 | - |
|
852 | - |
|
853 | - /** |
|
854 | - * Gets all the data migration scripts available in the core folder and folders |
|
855 | - * in addons. Has the side effect of adding them for autoloading |
|
856 | - * |
|
857 | - * @return array keys are expected classnames, values are their filepaths |
|
858 | - * @throws InvalidInterfaceException |
|
859 | - * @throws InvalidDataTypeException |
|
860 | - * @throws EE_Error |
|
861 | - * @throws InvalidArgumentException |
|
862 | - */ |
|
863 | - public function get_all_data_migration_scripts_available() |
|
864 | - { |
|
865 | - if (! $this->_data_migration_class_to_filepath_map) { |
|
866 | - $this->_data_migration_class_to_filepath_map = array(); |
|
867 | - foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) { |
|
868 | - // strip any placeholders added to classname to make it a unique array key |
|
869 | - $eeAddonClass = trim($eeAddonClass, '*'); |
|
870 | - $eeAddonClass = $eeAddonClass === 'Core' || class_exists($eeAddonClass) |
|
871 | - ? $eeAddonClass |
|
872 | - : ''; |
|
873 | - $folder_path = EEH_File::end_with_directory_separator($folder_path); |
|
874 | - $files = glob($folder_path . '*.dms.php'); |
|
875 | - if (empty($files)) { |
|
876 | - continue; |
|
877 | - } |
|
878 | - foreach ($files as $file) { |
|
879 | - $pos_of_last_slash = strrpos($file, DS); |
|
880 | - $classname = str_replace('.dms.php', '', substr($file, $pos_of_last_slash + 1)); |
|
881 | - $migrates_to = $this->script_migrates_to_version($classname, $eeAddonClass); |
|
882 | - $slug = $migrates_to['slug']; |
|
883 | - // check that the slug as contained in the DMS is associated with |
|
884 | - // the slug of an addon or core |
|
885 | - if ($slug !== 'Core' && EE_Registry::instance()->get_addon_by_name($slug) === null) { |
|
886 | - EE_Error::doing_it_wrong( |
|
887 | - __FUNCTION__, |
|
888 | - sprintf( |
|
889 | - esc_html__( |
|
890 | - 'The data migration script "%s" migrates the "%s" data, but there is no EE addon with that name. There is only: %s. ', |
|
891 | - 'event_espresso' |
|
892 | - ), |
|
893 | - $classname, |
|
894 | - $slug, |
|
895 | - implode(', ', array_keys(EE_Registry::instance()->get_addons_by_name())) |
|
896 | - ), |
|
897 | - '4.3.0.alpha.019' |
|
898 | - ); |
|
899 | - } |
|
900 | - $this->_data_migration_class_to_filepath_map[ $classname ] = $file; |
|
901 | - } |
|
902 | - } |
|
903 | - EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map); |
|
904 | - } |
|
905 | - return $this->_data_migration_class_to_filepath_map; |
|
906 | - } |
|
907 | - |
|
908 | - |
|
909 | - /** |
|
910 | - * Once we have an addon that works with EE4.1, we will actually want to fetch the PUE slugs |
|
911 | - * from each addon, and check if they need updating, |
|
912 | - * |
|
913 | - * @return boolean |
|
914 | - */ |
|
915 | - public function addons_need_updating() |
|
916 | - { |
|
917 | - return false; |
|
918 | - } |
|
919 | - |
|
920 | - /** |
|
921 | - * Adds this error string to the data_migrations_ran array, but we dont necessarily know |
|
922 | - * where to put it, so we just throw it in there... better than nothing... |
|
923 | - * |
|
924 | - * @param string $error_message |
|
925 | - * @throws EE_Error |
|
926 | - */ |
|
927 | - public function add_error_to_migrations_ran($error_message) |
|
928 | - { |
|
929 | - // get last-ran migration script |
|
930 | - global $wpdb; |
|
931 | - $last_migration_script_option = $wpdb->get_row( |
|
932 | - "SELECT * FROM $wpdb->options WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id DESC LIMIT 1", |
|
933 | - ARRAY_A |
|
934 | - ); |
|
935 | - |
|
936 | - $last_ran_migration_script_properties = isset($last_migration_script_option['option_value']) |
|
937 | - ? maybe_unserialize($last_migration_script_option['option_value']) : null; |
|
938 | - // now, tread lightly because we're here because a FATAL non-catchable error |
|
939 | - // was thrown last time when we were trying to run a data migration script |
|
940 | - // so the fatal error could have happened while getting the migration script |
|
941 | - // or doing running it... |
|
942 | - $versions_migrated_to = isset($last_migration_script_option['option_name']) ? str_replace( |
|
943 | - EE_Data_Migration_Manager::data_migration_script_option_prefix, |
|
944 | - "", |
|
945 | - $last_migration_script_option['option_name'] |
|
946 | - ) : null; |
|
947 | - |
|
948 | - // check if it THINKS its a data migration script and especially if it's one that HASN'T finished yet |
|
949 | - // because if it has finished, then it obviously couldn't be the cause of this error, right? (because its all done) |
|
950 | - if (isset($last_ran_migration_script_properties['class']) && isset($last_ran_migration_script_properties['_status']) && $last_ran_migration_script_properties['_status'] != self::status_completed) { |
|
951 | - // ok then just add this error to its list of errors |
|
952 | - $last_ran_migration_script_properties['_errors'][] = $error_message; |
|
953 | - $last_ran_migration_script_properties['_status'] = self::status_fatal_error; |
|
954 | - } else { |
|
955 | - // so we don't even know which script was last running |
|
956 | - // use the data migration error stub, which is designed specifically for this type of thing |
|
957 | - $general_migration_error = new EE_DMS_Unknown_1_0_0(); |
|
958 | - $general_migration_error->add_error($error_message); |
|
959 | - $general_migration_error->set_broken(); |
|
960 | - $last_ran_migration_script_properties = $general_migration_error->properties_as_array(); |
|
961 | - $versions_migrated_to = 'Unknown.1.0.0'; |
|
962 | - // now just to make sure appears as last (in case the were previously a fatal error like this) |
|
963 | - // delete the old one |
|
964 | - delete_option(self::data_migration_script_option_prefix . $versions_migrated_to); |
|
965 | - } |
|
966 | - update_option( |
|
967 | - self::data_migration_script_option_prefix . $versions_migrated_to, |
|
968 | - $last_ran_migration_script_properties |
|
969 | - ); |
|
970 | - } |
|
971 | - |
|
972 | - /** |
|
973 | - * saves what data migrations have ran to the database |
|
974 | - * |
|
975 | - * @return mixed TRUE if successfully saved migrations ran, string if an error occurred |
|
976 | - */ |
|
977 | - protected function _save_migrations_ran() |
|
978 | - { |
|
979 | - if ($this->_data_migrations_ran == null) { |
|
980 | - $this->get_data_migrations_ran(); |
|
981 | - } |
|
982 | - // now, we don't want to save actual classes to the DB because that's messy |
|
983 | - $successful_updates = true; |
|
984 | - foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) { |
|
985 | - foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) { |
|
986 | - $plugin_slug_for_use_in_option_name = $plugin_slug . "."; |
|
987 | - $option_name = self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string; |
|
988 | - $old_option_value = get_option($option_name); |
|
989 | - if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) { |
|
990 | - $script_array_for_saving = $array_or_migration_obj->properties_as_array(); |
|
991 | - if ($old_option_value != $script_array_for_saving) { |
|
992 | - $successful_updates = update_option($option_name, $script_array_for_saving); |
|
993 | - } |
|
994 | - } else {// we don't know what this array-thing is. So just save it as-is |
|
995 | - if ($old_option_value != $array_or_migration_obj) { |
|
996 | - $successful_updates = update_option($option_name, $array_or_migration_obj); |
|
997 | - } |
|
998 | - } |
|
999 | - if (! $successful_updates) { |
|
1000 | - global $wpdb; |
|
1001 | - return $wpdb->last_error; |
|
1002 | - } |
|
1003 | - } |
|
1004 | - } |
|
1005 | - return true; |
|
1006 | - // $updated = update_option(self::data_migrations_option_name, $array_of_migrations); |
|
1007 | - // if ($updated !== true) { |
|
1008 | - // global $wpdb; |
|
1009 | - // return $wpdb->last_error; |
|
1010 | - // } else { |
|
1011 | - // return true; |
|
1012 | - // } |
|
1013 | - // wp_mail( |
|
1014 | - // "[email protected]", |
|
1015 | - // time() . " price debug info", |
|
1016 | - // "updated: $updated, last error: $last_error, byte length of option: " . strlen( |
|
1017 | - // serialize($array_of_migrations) |
|
1018 | - // ) |
|
1019 | - // ); |
|
1020 | - } |
|
1021 | - |
|
1022 | - /** |
|
1023 | - * Takes an array of data migration script properties and re-creates the class from |
|
1024 | - * them. The argument $properties_array is assumed to have been made by |
|
1025 | - * EE_Data_Migration_Script_Base::properties_as_array() |
|
1026 | - * |
|
1027 | - * @param array $properties_array |
|
1028 | - * @return EE_Data_Migration_Script_Base |
|
1029 | - * @throws EE_Error |
|
1030 | - */ |
|
1031 | - public function _instantiate_script_from_properties_array($properties_array) |
|
1032 | - { |
|
1033 | - if (! isset($properties_array['class'])) { |
|
1034 | - throw new EE_Error( |
|
1035 | - sprintf( |
|
1036 | - __("Properties array has no 'class' properties. Here's what it has: %s", "event_espresso"), |
|
1037 | - implode(",", $properties_array) |
|
1038 | - ) |
|
1039 | - ); |
|
1040 | - } |
|
1041 | - $class_name = $properties_array['class']; |
|
1042 | - if (! class_exists($class_name)) { |
|
1043 | - throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"), $class_name)); |
|
1044 | - } |
|
1045 | - $class = new $class_name; |
|
1046 | - if (! $class instanceof EE_Data_Migration_Script_Base) { |
|
1047 | - throw new EE_Error( |
|
1048 | - sprintf( |
|
1049 | - __("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"), |
|
1050 | - $class_name, |
|
1051 | - get_class($class) |
|
1052 | - ) |
|
1053 | - ); |
|
1054 | - } |
|
1055 | - $class->instantiate_from_array_of_properties($properties_array); |
|
1056 | - return $class; |
|
1057 | - } |
|
1058 | - |
|
1059 | - /** |
|
1060 | - * Gets the classname for the most up-to-date DMS (ie, the one that will finally |
|
1061 | - * leave the DB in a state usable by the current plugin code). |
|
1062 | - * |
|
1063 | - * @param string $plugin_slug the slug for the ee plugin we are searching for. Default is 'Core' |
|
1064 | - * @return string |
|
1065 | - */ |
|
1066 | - public function get_most_up_to_date_dms($plugin_slug = 'Core') |
|
1067 | - { |
|
1068 | - $class_to_filepath_map = $this->get_all_data_migration_scripts_available(); |
|
1069 | - $most_up_to_date_dms_classname = null; |
|
1070 | - foreach ($class_to_filepath_map as $classname => $filepath) { |
|
1071 | - if ($most_up_to_date_dms_classname === null) { |
|
1072 | - $migrates_to = $this->script_migrates_to_version($classname); |
|
1073 | - $this_plugin_slug = $migrates_to['slug']; |
|
1074 | - if ($this_plugin_slug == $plugin_slug) { |
|
1075 | - // if it's for core, it wins |
|
1076 | - $most_up_to_date_dms_classname = $classname; |
|
1077 | - } |
|
1078 | - // if it wasn't for core, we must keep searching for one that is! |
|
1079 | - continue; |
|
1080 | - } else { |
|
1081 | - $champion_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms_classname); |
|
1082 | - $contender_migrates_to = $this->script_migrates_to_version($classname); |
|
1083 | - if ($contender_migrates_to['slug'] == $plugin_slug |
|
1084 | - && version_compare( |
|
1085 | - $champion_migrates_to['version'], |
|
1086 | - $contender_migrates_to['version'], |
|
1087 | - '<' |
|
1088 | - )) { |
|
1089 | - // so the contenders version is higher and its for Core |
|
1090 | - $most_up_to_date_dms_classname = $classname; |
|
1091 | - } |
|
1092 | - } |
|
1093 | - } |
|
1094 | - return $most_up_to_date_dms_classname; |
|
1095 | - } |
|
1096 | - |
|
1097 | - /** |
|
1098 | - * Gets the migration script specified but ONLY if it has already ran. |
|
1099 | - * |
|
1100 | - * Eg, if you wanted to see if 'EE_DMS_Core_4_1_0' has ran, you would run the following code: |
|
1101 | - * <code> $core_4_1_0_dms_ran = EE_Data_Migration_Manager::instance()->get_migration_ran( '4.1.0', 'Core' ) !== |
|
1102 | - * NULL;</code> This is especially useful in addons' data migration scripts, this way they can tell if a core (or |
|
1103 | - * other addon) DMS has ran, in case the current DMS depends on it. |
|
1104 | - * |
|
1105 | - * @param string $version the version the DMS searched for migrates to. Usually just the content before the 3rd |
|
1106 | - * period. Eg '4.1.0' |
|
1107 | - * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc |
|
1108 | - * @return EE_Data_Migration_Script_Base |
|
1109 | - */ |
|
1110 | - public function get_migration_ran($version, $plugin_slug = 'Core') |
|
1111 | - { |
|
1112 | - $migrations_ran = $this->get_data_migrations_ran(); |
|
1113 | - if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) { |
|
1114 | - return $migrations_ran[ $plugin_slug ][ $version ]; |
|
1115 | - } else { |
|
1116 | - return null; |
|
1117 | - } |
|
1118 | - } |
|
1119 | - |
|
1120 | - /** |
|
1121 | - * Resets the borked data migration scripts so they're no longer borked |
|
1122 | - * so we can again attempt to migrate |
|
1123 | - * |
|
1124 | - * @return bool |
|
1125 | - * @throws EE_Error |
|
1126 | - */ |
|
1127 | - public function reattempt() |
|
1128 | - { |
|
1129 | - // find if the last-ran script was borked |
|
1130 | - // set it as being non-borked (we shouldn't ever get DMSs that we don't recognize) |
|
1131 | - // add an 'error' saying that we attempted to reset |
|
1132 | - // does it have a stage that was borked too? if so make it no longer borked |
|
1133 | - // add an 'error' saying we attempted to reset |
|
1134 | - $last_ran_script = $this->get_last_ran_script(); |
|
1135 | - if ($last_ran_script instanceof EE_DMS_Unknown_1_0_0) { |
|
1136 | - // if it was an error DMS, just mark it as complete (if another error occurs it will overwrite it) |
|
1137 | - $last_ran_script->set_completed(); |
|
1138 | - } elseif ($last_ran_script instanceof EE_Data_Migration_Script_Base) { |
|
1139 | - $last_ran_script->reattempt(); |
|
1140 | - } else { |
|
1141 | - throw new EE_Error( |
|
1142 | - sprintf( |
|
1143 | - __( |
|
1144 | - 'Unable to reattempt the last ran migration script because it was not a valid migration script. || It was %s', |
|
1145 | - 'event_espresso' |
|
1146 | - ), |
|
1147 | - print_r($last_ran_script, true) |
|
1148 | - ) |
|
1149 | - ); |
|
1150 | - } |
|
1151 | - return $this->_save_migrations_ran(); |
|
1152 | - } |
|
1153 | - |
|
1154 | - /** |
|
1155 | - * Gets whether or not this particular migration has run or not |
|
1156 | - * |
|
1157 | - * @param string $version the version the DMS searched for migrates to. Usually just the content before the 3rd |
|
1158 | - * period. Eg '4.1.0' |
|
1159 | - * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc |
|
1160 | - * @return boolean |
|
1161 | - */ |
|
1162 | - public function migration_has_ran($version, $plugin_slug = 'Core') |
|
1163 | - { |
|
1164 | - return $this->get_migration_ran($version, $plugin_slug) !== null; |
|
1165 | - } |
|
1166 | - |
|
1167 | - /** |
|
1168 | - * Enqueues this ee plugin to have its data initialized |
|
1169 | - * |
|
1170 | - * @param string $plugin_slug either 'Core' or EE_Addon::name()'s return value |
|
1171 | - */ |
|
1172 | - public function enqueue_db_initialization_for($plugin_slug) |
|
1173 | - { |
|
1174 | - $queue = $this->get_db_initialization_queue(); |
|
1175 | - if (! in_array($plugin_slug, $queue)) { |
|
1176 | - $queue[] = $plugin_slug; |
|
1177 | - } |
|
1178 | - update_option(self::db_init_queue_option_name, $queue); |
|
1179 | - } |
|
1180 | - |
|
1181 | - /** |
|
1182 | - * Calls EE_Addon::initialize_db_if_no_migrations_required() on each addon |
|
1183 | - * specified in EE_Data_Migration_Manager::get_db_init_queue(), and if 'Core' is |
|
1184 | - * in the queue, calls EE_System::initialize_db_if_no_migrations_required(). |
|
1185 | - */ |
|
1186 | - public function initialize_db_for_enqueued_ee_plugins() |
|
1187 | - { |
|
1188 | - $queue = $this->get_db_initialization_queue(); |
|
1189 | - foreach ($queue as $plugin_slug) { |
|
1190 | - $most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug); |
|
1191 | - if (! $most_up_to_date_dms) { |
|
1192 | - // if there is NO DMS for this plugin, obviously there's no schema to verify anyways |
|
1193 | - $verify_db = false; |
|
1194 | - } else { |
|
1195 | - $most_up_to_date_dms_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms); |
|
1196 | - $verify_db = $this->database_needs_updating_to($most_up_to_date_dms_migrates_to); |
|
1197 | - } |
|
1198 | - if ($plugin_slug == 'Core') { |
|
1199 | - EE_System::instance()->initialize_db_if_no_migrations_required( |
|
1200 | - false, |
|
1201 | - $verify_db |
|
1202 | - ); |
|
1203 | - } else { |
|
1204 | - // just loop through the addons to make sure their database is setup |
|
1205 | - foreach (EE_Registry::instance()->addons as $addon) { |
|
1206 | - if ($addon->name() == $plugin_slug) { |
|
1207 | - $addon->initialize_db_if_no_migrations_required($verify_db); |
|
1208 | - break; |
|
1209 | - } |
|
1210 | - } |
|
1211 | - } |
|
1212 | - } |
|
1213 | - // because we just initialized the DBs for the enqueued ee plugins |
|
1214 | - // we don't need to keep remembering which ones needed to be initialized |
|
1215 | - delete_option(self::db_init_queue_option_name); |
|
1216 | - } |
|
1217 | - |
|
1218 | - /** |
|
1219 | - * Gets a numerically-indexed array of plugin slugs that need to have their databases |
|
1220 | - * (re-)initialized after migrations are complete. ie, each element should be either |
|
1221 | - * 'Core', or the return value of EE_Addon::name() for an addon |
|
1222 | - * |
|
1223 | - * @return array |
|
1224 | - */ |
|
1225 | - public function get_db_initialization_queue() |
|
1226 | - { |
|
1227 | - return get_option(self::db_init_queue_option_name, array()); |
|
1228 | - } |
|
1229 | - |
|
1230 | - /** |
|
1231 | - * Gets the injected table analyzer, or throws an exception |
|
1232 | - * |
|
1233 | - * @return TableAnalysis |
|
1234 | - * @throws EE_Error |
|
1235 | - */ |
|
1236 | - protected function _get_table_analysis() |
|
1237 | - { |
|
1238 | - if ($this->_table_analysis instanceof TableAnalysis) { |
|
1239 | - return $this->_table_analysis; |
|
1240 | - } else { |
|
1241 | - throw new EE_Error( |
|
1242 | - sprintf( |
|
1243 | - __('Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
1244 | - get_class($this) |
|
1245 | - ) |
|
1246 | - ); |
|
1247 | - } |
|
1248 | - } |
|
1249 | - |
|
1250 | - /** |
|
1251 | - * Gets the injected table manager, or throws an exception |
|
1252 | - * |
|
1253 | - * @return TableManager |
|
1254 | - * @throws EE_Error |
|
1255 | - */ |
|
1256 | - protected function _get_table_manager() |
|
1257 | - { |
|
1258 | - if ($this->_table_manager instanceof TableManager) { |
|
1259 | - return $this->_table_manager; |
|
1260 | - } else { |
|
1261 | - throw new EE_Error( |
|
1262 | - sprintf( |
|
1263 | - __('Table manager class on class %1$s is not set properly.', 'event_espresso'), |
|
1264 | - get_class($this) |
|
1265 | - ) |
|
1266 | - ); |
|
1267 | - } |
|
1268 | - } |
|
35 | + /** |
|
36 | + * |
|
37 | + * @var EE_Registry |
|
38 | + */ |
|
39 | + // protected $EE; |
|
40 | + /** |
|
41 | + * name of the wordpress option which stores an array of data about |
|
42 | + */ |
|
43 | + const data_migrations_option_name = 'ee_data_migration'; |
|
44 | + |
|
45 | + |
|
46 | + const data_migration_script_option_prefix = 'ee_data_migration_script_'; |
|
47 | + |
|
48 | + const data_migration_script_mapping_option_prefix = 'ee_dms_map_'; |
|
49 | + |
|
50 | + /** |
|
51 | + * name of the wordpress option which stores the database' current version. IE, the code may be at version 4.2.0, |
|
52 | + * but as migrations are performed the database will progress from 3.1.35 to 4.1.0 etc. |
|
53 | + */ |
|
54 | + const current_database_state = 'ee_data_migration_current_db_state'; |
|
55 | + |
|
56 | + /** |
|
57 | + * Special status string returned when we're positive there are no more data migration |
|
58 | + * scripts that can be run. |
|
59 | + */ |
|
60 | + const status_no_more_migration_scripts = 'no_more_migration_scripts'; |
|
61 | + /** |
|
62 | + * string indicating the migration should continue |
|
63 | + */ |
|
64 | + const status_continue = 'status_continue'; |
|
65 | + /** |
|
66 | + * string indicating the migration has completed and should be ended |
|
67 | + */ |
|
68 | + const status_completed = 'status_completed'; |
|
69 | + /** |
|
70 | + * string indicating a fatal error occurred and the data migration should be completely aborted |
|
71 | + */ |
|
72 | + const status_fatal_error = 'status_fatal_error'; |
|
73 | + |
|
74 | + /** |
|
75 | + * the number of 'items' (usually DB rows) to migrate on each 'step' (ajax request sent |
|
76 | + * during migration) |
|
77 | + */ |
|
78 | + const step_size = 50; |
|
79 | + |
|
80 | + /** |
|
81 | + * option name that stores the queue of ee plugins needing to have |
|
82 | + * their data initialized (or re-initialized) once we are done migrations |
|
83 | + */ |
|
84 | + const db_init_queue_option_name = 'ee_db_init_queue'; |
|
85 | + /** |
|
86 | + * Array of information concerning data migrations that have ran in the history |
|
87 | + * of this EE installation. Keys should be the name of the version the script upgraded to |
|
88 | + * |
|
89 | + * @var EE_Data_Migration_Script_Base[] |
|
90 | + */ |
|
91 | + private $_data_migrations_ran = null; |
|
92 | + /** |
|
93 | + * The last ran script. It's nice to store this somewhere accessible, as its easiest |
|
94 | + * to know which was the last run by which is the newest wp option; but in most of the code |
|
95 | + * we just use the local $_data_migration_ran array, which organized the scripts differently |
|
96 | + * |
|
97 | + * @var EE_Data_Migration_Script_Base |
|
98 | + */ |
|
99 | + private $_last_ran_script = null; |
|
100 | + |
|
101 | + /** |
|
102 | + * Similarly to _last_ran_script, but this is the last INCOMPLETE migration script. |
|
103 | + * |
|
104 | + * @var EE_Data_Migration_Script_Base |
|
105 | + */ |
|
106 | + private $_last_ran_incomplete_script = null; |
|
107 | + /** |
|
108 | + * array where keys are classnames, and values are filepaths of all the known migration scripts |
|
109 | + * |
|
110 | + * @var array |
|
111 | + */ |
|
112 | + private $_data_migration_class_to_filepath_map; |
|
113 | + |
|
114 | + /** |
|
115 | + * the following 4 properties are fully set on construction. |
|
116 | + * Note: the first two apply to whether to continue running ALL migration scripts (ie, even though we're finished |
|
117 | + * one, we may want to start the next one); whereas the last two indicate whether to continue running a single |
|
118 | + * data migration script |
|
119 | + * |
|
120 | + * @var array |
|
121 | + */ |
|
122 | + public $stati_that_indicate_to_continue_migrations = array(); |
|
123 | + |
|
124 | + public $stati_that_indicate_to_stop_migrations = array(); |
|
125 | + |
|
126 | + public $stati_that_indicate_to_continue_single_migration_script = array(); |
|
127 | + |
|
128 | + public $stati_that_indicate_to_stop_single_migration_script = array(); |
|
129 | + |
|
130 | + /** |
|
131 | + * @var \EventEspresso\core\services\database\TableManager $table_manager |
|
132 | + */ |
|
133 | + protected $_table_manager; |
|
134 | + |
|
135 | + /** |
|
136 | + * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis |
|
137 | + */ |
|
138 | + protected $_table_analysis; |
|
139 | + |
|
140 | + /** |
|
141 | + * @var array $script_migration_versions |
|
142 | + */ |
|
143 | + protected $script_migration_versions; |
|
144 | + |
|
145 | + /** |
|
146 | + * @var EE_Data_Migration_Manager $_instance |
|
147 | + * @access private |
|
148 | + */ |
|
149 | + private static $_instance = null; |
|
150 | + |
|
151 | + |
|
152 | + /** |
|
153 | + * @singleton method used to instantiate class object |
|
154 | + * @access public |
|
155 | + * @return EE_Data_Migration_Manager instance |
|
156 | + */ |
|
157 | + public static function instance() |
|
158 | + { |
|
159 | + // check if class object is instantiated |
|
160 | + if (! self::$_instance instanceof EE_Data_Migration_Manager) { |
|
161 | + self::$_instance = new self(); |
|
162 | + } |
|
163 | + return self::$_instance; |
|
164 | + } |
|
165 | + |
|
166 | + /** |
|
167 | + * resets the singleton to its brand-new state (but does NOT delete old references to the old singleton. Meaning, |
|
168 | + * all new usages of the singleton should be made with Classname::instance()) and returns it |
|
169 | + * |
|
170 | + * @return EE_Data_Migration_Manager |
|
171 | + */ |
|
172 | + public static function reset() |
|
173 | + { |
|
174 | + self::$_instance = null; |
|
175 | + return self::instance(); |
|
176 | + } |
|
177 | + |
|
178 | + |
|
179 | + /** |
|
180 | + * constructor |
|
181 | + */ |
|
182 | + private function __construct() |
|
183 | + { |
|
184 | + $this->stati_that_indicate_to_continue_migrations = array( |
|
185 | + self::status_continue, |
|
186 | + self::status_completed, |
|
187 | + ); |
|
188 | + $this->stati_that_indicate_to_stop_migrations = array( |
|
189 | + self::status_fatal_error, |
|
190 | + self::status_no_more_migration_scripts, |
|
191 | + ); |
|
192 | + $this->stati_that_indicate_to_continue_single_migration_script = array( |
|
193 | + self::status_continue, |
|
194 | + ); |
|
195 | + $this->stati_that_indicate_to_stop_single_migration_script = array( |
|
196 | + self::status_completed, |
|
197 | + self::status_fatal_error |
|
198 | + // note: status_no_more_migration_scripts doesn't apply |
|
199 | + ); |
|
200 | + // make sure we've included the base migration script, because we may need the EE_DMS_Unknown_1_0_0 class |
|
201 | + // to be defined, because right now it doesn't get autoloaded on its own |
|
202 | + EE_Registry::instance()->load_core('Data_Migration_Class_Base', array(), true); |
|
203 | + EE_Registry::instance()->load_core('Data_Migration_Script_Base', array(), true); |
|
204 | + EE_Registry::instance()->load_core('DMS_Unknown_1_0_0', array(), true); |
|
205 | + EE_Registry::instance()->load_core('Data_Migration_Script_Stage', array(), true); |
|
206 | + EE_Registry::instance()->load_core('Data_Migration_Script_Stage_Table', array(), true); |
|
207 | + $this->_table_manager = EE_Registry::instance()->create('TableManager', array(), true); |
|
208 | + $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true); |
|
209 | + } |
|
210 | + |
|
211 | + |
|
212 | + /** |
|
213 | + * Deciphers, from an option's name, what plugin and version it relates to (see _save_migrations_ran to see what |
|
214 | + * the option names are like, but generally they're like |
|
215 | + * 'ee_data_migration_script_Core.4.1.0' in 4.2 or 'ee_data_migration_script_4.1.0' before that). |
|
216 | + * The option name shouldn't ever be like 'ee_data_migration_script_Core.4.1.0.reg' because it's derived, |
|
217 | + * indirectly, from the data migration's classname, which should always be like EE_DMS_%s_%d_%d_%d.dms.php (eg |
|
218 | + * EE_DMS_Core_4_1_0.dms.php) |
|
219 | + * |
|
220 | + * @param string $option_name (see EE_Data_Migration_Manage::_save_migrations_ran() where the option name is set) |
|
221 | + * @return array where the first item is the plugin slug (eg 'Core','Calendar',etc) and the 2nd is the version of |
|
222 | + * that plugin (eg '4.1.0') |
|
223 | + */ |
|
224 | + private function _get_plugin_slug_and_version_string_from_dms_option_name($option_name) |
|
225 | + { |
|
226 | + $plugin_slug_and_version_string = str_replace( |
|
227 | + EE_Data_Migration_Manager::data_migration_script_option_prefix, |
|
228 | + "", |
|
229 | + $option_name |
|
230 | + ); |
|
231 | + // check if $plugin_slug_and_version_string is like '4.1.0' (4.1-style) or 'Core.4.1.0' (4.2-style) |
|
232 | + $parts = explode(".", $plugin_slug_and_version_string); |
|
233 | + |
|
234 | + if (count($parts) == 4) { |
|
235 | + // it's 4.2-style.eg Core.4.1.0 |
|
236 | + $plugin_slug = $parts[0];// eg Core |
|
237 | + $version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0 |
|
238 | + } else { |
|
239 | + // it's 4.1-style: eg 4.1.0 |
|
240 | + $plugin_slug = 'Core'; |
|
241 | + $version_string = $plugin_slug_and_version_string;// eg 4.1.0 |
|
242 | + } |
|
243 | + return array($plugin_slug, $version_string); |
|
244 | + } |
|
245 | + |
|
246 | + /** |
|
247 | + * Gets the DMS class from the wordpress option, otherwise throws an EE_Error if it's not |
|
248 | + * for a known DMS class. |
|
249 | + * |
|
250 | + * @param string $dms_option_name |
|
251 | + * @param string $dms_option_value (serialized) |
|
252 | + * @return EE_Data_Migration_Script_Base |
|
253 | + * @throws EE_Error |
|
254 | + */ |
|
255 | + private function _get_dms_class_from_wp_option($dms_option_name, $dms_option_value) |
|
256 | + { |
|
257 | + $data_migration_data = maybe_unserialize($dms_option_value); |
|
258 | + if (isset($data_migration_data['class']) && class_exists($data_migration_data['class'])) { |
|
259 | + $class = new $data_migration_data['class']; |
|
260 | + if ($class instanceof EE_Data_Migration_Script_Base) { |
|
261 | + $class->instantiate_from_array_of_properties($data_migration_data); |
|
262 | + return $class; |
|
263 | + } else { |
|
264 | + // huh, so its an object but not a data migration script?? that shouldn't happen |
|
265 | + // just leave it as an array (which will probably just get ignored) |
|
266 | + throw new EE_Error( |
|
267 | + sprintf( |
|
268 | + __( |
|
269 | + "Trying to retrieve DMS class from wp option. No DMS by the name '%s' exists", |
|
270 | + 'event_espresso' |
|
271 | + ), |
|
272 | + $data_migration_data['class'] |
|
273 | + ) |
|
274 | + ); |
|
275 | + } |
|
276 | + } else { |
|
277 | + // so the data doesn't specify a class. So it must either be a legacy array of info or some array (which we'll probably just ignore), or a class that no longer exists |
|
278 | + throw new EE_Error( |
|
279 | + sprintf(__("The wp option with key '%s' does not represent a DMS", 'event_espresso'), $dms_option_name) |
|
280 | + ); |
|
281 | + } |
|
282 | + } |
|
283 | + |
|
284 | + /** |
|
285 | + * Gets the array describing what data migrations have run. Also has a side-effect of recording which was the last |
|
286 | + * ran, and which was the last ran which hasn't finished yet |
|
287 | + * |
|
288 | + * @return array where each element should be an array of EE_Data_Migration_Script_Base (but also has a few legacy |
|
289 | + * arrays in there - which should probably be ignored) |
|
290 | + */ |
|
291 | + public function get_data_migrations_ran() |
|
292 | + { |
|
293 | + if (! $this->_data_migrations_ran) { |
|
294 | + // setup autoloaders for each of the scripts in there |
|
295 | + $this->get_all_data_migration_scripts_available(); |
|
296 | + $data_migrations_options = $this->get_all_migration_script_options( |
|
297 | + );// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array())); |
|
298 | + |
|
299 | + $data_migrations_ran = array(); |
|
300 | + // convert into data migration script classes where possible |
|
301 | + foreach ($data_migrations_options as $data_migration_option) { |
|
302 | + list($plugin_slug, $version_string) = $this->_get_plugin_slug_and_version_string_from_dms_option_name( |
|
303 | + $data_migration_option['option_name'] |
|
304 | + ); |
|
305 | + |
|
306 | + try { |
|
307 | + $class = $this->_get_dms_class_from_wp_option( |
|
308 | + $data_migration_option['option_name'], |
|
309 | + $data_migration_option['option_value'] |
|
310 | + ); |
|
311 | + $data_migrations_ran[ $plugin_slug ][ $version_string ] = $class; |
|
312 | + // ok so far THIS is the 'last-ran-script'... unless we find another on next iteration |
|
313 | + $this->_last_ran_script = $class; |
|
314 | + if (! $class->is_completed()) { |
|
315 | + // sometimes we also like to know which was the last incomplete script (or if there are any at all) |
|
316 | + $this->_last_ran_incomplete_script = $class; |
|
317 | + } |
|
318 | + } catch (EE_Error $e) { |
|
319 | + // ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs |
|
320 | + $data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize( |
|
321 | + $data_migration_option['option_value'] |
|
322 | + ); |
|
323 | + } |
|
324 | + } |
|
325 | + // so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays |
|
326 | + $this->_data_migrations_ran = $data_migrations_ran; |
|
327 | + if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) { |
|
328 | + $this->_data_migrations_ran = array(); |
|
329 | + } |
|
330 | + } |
|
331 | + return $this->_data_migrations_ran; |
|
332 | + } |
|
333 | + |
|
334 | + |
|
335 | + /** |
|
336 | + * |
|
337 | + * @param string $script_name eg 'DMS_Core_4_1_0' |
|
338 | + * @param string $old_table eg 'wp_events_detail' |
|
339 | + * @param string $old_pk eg 'wp_esp_posts' |
|
340 | + * @param $new_table |
|
341 | + * @return mixed string or int |
|
342 | + */ |
|
343 | + public function get_mapping_new_pk($script_name, $old_table, $old_pk, $new_table) |
|
344 | + { |
|
345 | + $script = EE_Registry::instance()->load_dms($script_name); |
|
346 | + $mapping = $script->get_mapping_new_pk($old_table, $old_pk, $new_table); |
|
347 | + return $mapping; |
|
348 | + } |
|
349 | + |
|
350 | + /** |
|
351 | + * Gets all the options containing migration scripts that have been run. Ordering is important: it's assumed that |
|
352 | + * the last option returned in this array is the most-recently ran DMS option |
|
353 | + * |
|
354 | + * @return array |
|
355 | + */ |
|
356 | + public function get_all_migration_script_options() |
|
357 | + { |
|
358 | + global $wpdb; |
|
359 | + return $wpdb->get_results( |
|
360 | + "SELECT * FROM {$wpdb->options} WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id ASC", |
|
361 | + ARRAY_A |
|
362 | + ); |
|
363 | + } |
|
364 | + |
|
365 | + /** |
|
366 | + * Gets the array of folders which contain data migration scripts. Also adds them to be auto-loaded |
|
367 | + * |
|
368 | + * @return array where each value is the full folder path of a folder containing data migration scripts, WITH |
|
369 | + * slashes at the end of the folder name. |
|
370 | + */ |
|
371 | + public function get_data_migration_script_folders() |
|
372 | + { |
|
373 | + return apply_filters( |
|
374 | + 'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders', |
|
375 | + array('Core' => EE_CORE . 'data_migration_scripts') |
|
376 | + ); |
|
377 | + } |
|
378 | + |
|
379 | + /** |
|
380 | + * Gets the version the migration script upgrades to |
|
381 | + * |
|
382 | + * @param string $migration_script_name eg 'EE_DMS_Core_4_1_0' |
|
383 | + * @return array { |
|
384 | + * @type string $slug like 'Core','Calendar',etc |
|
385 | + * @type string $version like 4.3.0 |
|
386 | + * } |
|
387 | + * @throws EE_Error |
|
388 | + */ |
|
389 | + public function script_migrates_to_version($migration_script_name, $eeAddonClass = '') |
|
390 | + { |
|
391 | + if (isset($this->script_migration_versions[ $migration_script_name ])) { |
|
392 | + return $this->script_migration_versions[ $migration_script_name ]; |
|
393 | + } |
|
394 | + $dms_info = $this->parse_dms_classname($migration_script_name); |
|
395 | + $this->script_migration_versions[ $migration_script_name ] = array( |
|
396 | + 'slug' => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'], |
|
397 | + 'version' => $dms_info['major_version'] . "." . $dms_info['minor_version'] . "." . $dms_info['micro_version'], |
|
398 | + ); |
|
399 | + return $this->script_migration_versions[ $migration_script_name ]; |
|
400 | + } |
|
401 | + |
|
402 | + /** |
|
403 | + * Gets the juicy details out of a dms filename like 'EE_DMS_Core_4_1_0' |
|
404 | + * |
|
405 | + * @param string $classname |
|
406 | + * @return array with keys 'slug','major_version','minor_version', and 'micro_version' (the last 3 are ints) |
|
407 | + * @throws EE_Error |
|
408 | + */ |
|
409 | + public function parse_dms_classname($classname) |
|
410 | + { |
|
411 | + $matches = array(); |
|
412 | + preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches); |
|
413 | + if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) { |
|
414 | + throw new EE_Error( |
|
415 | + sprintf( |
|
416 | + __( |
|
417 | + "%s is not a valid Data Migration Script. The classname should be like EE_DMS_w_x_y_z, where w is either 'Core' or the slug of an addon and x, y and z are numbers, ", |
|
418 | + "event_espresso" |
|
419 | + ), |
|
420 | + $classname |
|
421 | + ) |
|
422 | + ); |
|
423 | + } |
|
424 | + return array( |
|
425 | + 'slug' => $matches[1], |
|
426 | + 'major_version' => intval($matches[2]), |
|
427 | + 'minor_version' => intval($matches[3]), |
|
428 | + 'micro_version' => intval($matches[4]), |
|
429 | + ); |
|
430 | + } |
|
431 | + |
|
432 | + /** |
|
433 | + * Ensures that the option indicating the current DB version is set. This should only be |
|
434 | + * a concern when activating EE for the first time, THEORETICALLY. |
|
435 | + * If we detect that we're activating EE4 over top of EE3.1, then we set the current db state to 3.1.x, otherwise |
|
436 | + * to 4.1.x. |
|
437 | + * |
|
438 | + * @return string of current db state |
|
439 | + */ |
|
440 | + public function ensure_current_database_state_is_set() |
|
441 | + { |
|
442 | + $espresso_db_core_updates = get_option('espresso_db_update', array()); |
|
443 | + $db_state = get_option(EE_Data_Migration_Manager::current_database_state); |
|
444 | + if (! $db_state) { |
|
445 | + // mark the DB as being in the state as the last version in there. |
|
446 | + // this is done to trigger maintenance mode and do data migration scripts |
|
447 | + // if the admin installed this version of EE over 3.1.x or 4.0.x |
|
448 | + // otherwise, the normal maintenance mode code is fine |
|
449 | + $previous_versions_installed = array_keys($espresso_db_core_updates); |
|
450 | + $previous_version_installed = end($previous_versions_installed); |
|
451 | + if (version_compare('4.1.0', $previous_version_installed)) { |
|
452 | + // last installed version was less than 4.1 |
|
453 | + // so we want the data migrations to happen. SO, we're going to say the DB is at that state |
|
454 | + $db_state = array('Core' => $previous_version_installed); |
|
455 | + } else { |
|
456 | + $db_state = array('Core' => EVENT_ESPRESSO_VERSION); |
|
457 | + } |
|
458 | + update_option(EE_Data_Migration_Manager::current_database_state, $db_state); |
|
459 | + } |
|
460 | + // in 4.1, $db_state would have only been a simple string like '4.1.0', |
|
461 | + // but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's |
|
462 | + // db, and possibly other keys for other addons like 'Calendar','Permissions',etc |
|
463 | + if (! is_array($db_state)) { |
|
464 | + $db_state = array('Core' => $db_state); |
|
465 | + update_option(EE_Data_Migration_Manager::current_database_state, $db_state); |
|
466 | + } |
|
467 | + return $db_state; |
|
468 | + } |
|
469 | + |
|
470 | + /** |
|
471 | + * Checks if there are any data migration scripts that ought to be run. If found, |
|
472 | + * returns the instantiated classes. If none are found (ie, they've all already been run |
|
473 | + * or they don't apply), returns an empty array |
|
474 | + * |
|
475 | + * @return EE_Data_Migration_Script_Base[] |
|
476 | + */ |
|
477 | + public function check_for_applicable_data_migration_scripts() |
|
478 | + { |
|
479 | + // get the option describing what options have already run |
|
480 | + $scripts_ran = $this->get_data_migrations_ran(); |
|
481 | + // $scripts_ran = array('4.1.0.core'=>array('monkey'=>null)); |
|
482 | + $script_class_and_filepaths_available = $this->get_all_data_migration_scripts_available(); |
|
483 | + |
|
484 | + |
|
485 | + $current_database_state = $this->ensure_current_database_state_is_set(); |
|
486 | + // determine which have already been run |
|
487 | + $script_classes_that_should_run_per_iteration = array(); |
|
488 | + $iteration = 0; |
|
489 | + $next_database_state_to_consider = $current_database_state; |
|
490 | + $theoretical_database_state = null; |
|
491 | + do { |
|
492 | + // the next state after the currently-considered one will start off looking the same as the current, but we may make additions... |
|
493 | + $theoretical_database_state = $next_database_state_to_consider; |
|
494 | + // the next db state to consider is "what would the DB be like had we run all the scripts we found that applied last time?) |
|
495 | + foreach ($script_class_and_filepaths_available as $classname => $filepath) { |
|
496 | + $migrates_to_version = $this->script_migrates_to_version($classname); |
|
497 | + $script_converts_plugin_slug = $migrates_to_version['slug']; |
|
498 | + $script_converts_to_version = $migrates_to_version['version']; |
|
499 | + // check if this version script is DONE or not; or if it's never been ran |
|
500 | + if (! $scripts_ran || |
|
501 | + ! isset($scripts_ran[ $script_converts_plugin_slug ]) || |
|
502 | + ! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])) { |
|
503 | + // we haven't ran this conversion script before |
|
504 | + // now check if it applies... note that we've added an autoloader for it on get_all_data_migration_scripts_available |
|
505 | + $script = new $classname($this->_get_table_manager(), $this->_get_table_analysis()); |
|
506 | + /* @var $script EE_Data_Migration_Script_Base */ |
|
507 | + $can_migrate = $script->can_migrate_from_version($theoretical_database_state); |
|
508 | + if ($can_migrate) { |
|
509 | + $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script; |
|
510 | + $migrates_to_version = $script->migrates_to_version(); |
|
511 | + $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version']; |
|
512 | + unset($script_class_and_filepaths_available[ $classname ]); |
|
513 | + } |
|
514 | + } elseif ($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ] instanceof EE_Data_Migration_Script_Base) { |
|
515 | + // this script has been ran, or at least started |
|
516 | + $script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ]; |
|
517 | + if ($script->get_status() != self::status_completed) { |
|
518 | + // this script is already underway... keep going with it |
|
519 | + $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script; |
|
520 | + $migrates_to_version = $script->migrates_to_version(); |
|
521 | + $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version']; |
|
522 | + unset($script_class_and_filepaths_available[ $classname ]); |
|
523 | + } else { |
|
524 | + // it must have a status that indicates it has finished, so we don't want to try and run it again |
|
525 | + } |
|
526 | + } else { |
|
527 | + // it exists but it's not a proper data migration script |
|
528 | + // maybe the script got renamed? or was simply removed from EE? |
|
529 | + // either way, its certainly not runnable! |
|
530 | + } |
|
531 | + } |
|
532 | + $iteration++; |
|
533 | + } while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6); |
|
534 | + // ok we have all the scripts that should run, now let's make them into flat array |
|
535 | + $scripts_that_should_run = array(); |
|
536 | + foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) { |
|
537 | + ksort($scripts_at_priority); |
|
538 | + foreach ($scripts_at_priority as $scripts) { |
|
539 | + foreach ($scripts as $script) { |
|
540 | + $scripts_that_should_run[ get_class($script) ] = $script; |
|
541 | + } |
|
542 | + } |
|
543 | + } |
|
544 | + |
|
545 | + do_action( |
|
546 | + 'AHEE__EE_Data_Migration_Manager__check_for_applicable_data_migration_scripts__scripts_that_should_run', |
|
547 | + $scripts_that_should_run |
|
548 | + ); |
|
549 | + return $scripts_that_should_run; |
|
550 | + } |
|
551 | + |
|
552 | + |
|
553 | + /** |
|
554 | + * Gets the script which is currently being ran, if there is one. If $include_completed_scripts is set to TRUE |
|
555 | + * it will return the last ran script even if its complete. |
|
556 | + * This means: if you want to find the currently-executing script, leave it as FALSE. |
|
557 | + * If you really just want to find the script which ran most recently, regardless of status, leave it as TRUE. |
|
558 | + * |
|
559 | + * @param bool $include_completed_scripts |
|
560 | + * @return EE_Data_Migration_Script_Base |
|
561 | + */ |
|
562 | + public function get_last_ran_script($include_completed_scripts = false) |
|
563 | + { |
|
564 | + // make sure we've setup the class properties _last_ran_script and _last_ran_incomplete_script |
|
565 | + if (! $this->_data_migrations_ran) { |
|
566 | + $this->get_data_migrations_ran(); |
|
567 | + } |
|
568 | + if ($include_completed_scripts) { |
|
569 | + return $this->_last_ran_script; |
|
570 | + } else { |
|
571 | + return $this->_last_ran_incomplete_script; |
|
572 | + } |
|
573 | + } |
|
574 | + |
|
575 | + |
|
576 | + /** |
|
577 | + * Runs the data migration scripts (well, each request to this method calls one of the |
|
578 | + * data migration scripts' migration_step() functions). |
|
579 | + * |
|
580 | + * @param int $step_size |
|
581 | + * @throws EE_Error |
|
582 | + * @return array { |
|
583 | + * // where the first item is one EE_Data_Migration_Script_Base's stati, |
|
584 | + * //and the second item is a string describing what was done |
|
585 | + * @type int $records_to_migrate from the current migration script |
|
586 | + * @type int $records_migrated |
|
587 | + * @type string $status one of EE_Data_Migration_Manager::status_* |
|
588 | + * @type string $script verbose name of the current DMS |
|
589 | + * @type string $message string describing what was done during this step |
|
590 | + * } |
|
591 | + */ |
|
592 | + public function migration_step($step_size = 0) |
|
593 | + { |
|
594 | + |
|
595 | + // bandaid fix for issue https://events.codebasehq.com/projects/event-espresso/tickets/7535 |
|
596 | + if (class_exists('EE_CPT_Strategy')) { |
|
597 | + remove_action('pre_get_posts', array(EE_CPT_Strategy::instance(), 'pre_get_posts'), 5); |
|
598 | + } |
|
599 | + |
|
600 | + try { |
|
601 | + $currently_executing_script = $this->get_last_ran_script(); |
|
602 | + if (! $currently_executing_script) { |
|
603 | + // Find the next script that needs to execute |
|
604 | + $scripts = $this->check_for_applicable_data_migration_scripts(); |
|
605 | + if (! $scripts) { |
|
606 | + // huh, no more scripts to run... apparently we're done! |
|
607 | + // but dont forget to make sure initial data is there |
|
608 | + // we should be good to allow them to exit maintenance mode now |
|
609 | + EE_Maintenance_Mode::instance()->set_maintenance_level( |
|
610 | + intval(EE_Maintenance_Mode::level_0_not_in_maintenance) |
|
611 | + ); |
|
612 | + // saving migrations ran should actually be unnecessary, but leaving in place just in case |
|
613 | + // remember this migration was finished (even if we timeout initing db for core and plugins) |
|
614 | + $this->_save_migrations_ran(); |
|
615 | + // make sure DB was updated AFTER we've recorded the migration was done |
|
616 | + $this->initialize_db_for_enqueued_ee_plugins(); |
|
617 | + return array( |
|
618 | + 'records_to_migrate' => 1, |
|
619 | + 'records_migrated' => 1, |
|
620 | + 'status' => self::status_no_more_migration_scripts, |
|
621 | + 'script' => __("Data Migration Completed Successfully", "event_espresso"), |
|
622 | + 'message' => __("All done!", "event_espresso"), |
|
623 | + ); |
|
624 | + } |
|
625 | + $currently_executing_script = array_shift($scripts); |
|
626 | + // and add to the array/wp option showing the scripts ran |
|
627 | + |
|
628 | + $migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script)); |
|
629 | + $plugin_slug = $migrates_to['slug']; |
|
630 | + $version = $migrates_to['version']; |
|
631 | + $this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script; |
|
632 | + } |
|
633 | + $current_script_name = get_class($currently_executing_script); |
|
634 | + } catch (Exception $e) { |
|
635 | + // an exception occurred while trying to get migration scripts |
|
636 | + |
|
637 | + $message = sprintf( |
|
638 | + __("Error Message: %sStack Trace:%s", "event_espresso"), |
|
639 | + $e->getMessage() . '<br>', |
|
640 | + $e->getTraceAsString() |
|
641 | + ); |
|
642 | + // record it on the array of data migration scripts ran. This will be overwritten next time we try and try to run data migrations |
|
643 | + // but that's ok-- it's just an FYI to support that we couldn't even run any data migrations |
|
644 | + $this->add_error_to_migrations_ran( |
|
645 | + sprintf(__("Could not run data migrations because: %s", "event_espresso"), $message) |
|
646 | + ); |
|
647 | + return array( |
|
648 | + 'records_to_migrate' => 1, |
|
649 | + 'records_migrated' => 0, |
|
650 | + 'status' => self::status_fatal_error, |
|
651 | + 'script' => __("Error loading data migration scripts", "event_espresso"), |
|
652 | + 'message' => $message, |
|
653 | + ); |
|
654 | + } |
|
655 | + // ok so we definitely have a data migration script |
|
656 | + try { |
|
657 | + // how big of a bite do we want to take? Allow users to easily override via their wp-config |
|
658 | + if (! absint($step_size) > 0) { |
|
659 | + $step_size = defined('EE_MIGRATION_STEP_SIZE') && absint(EE_MIGRATION_STEP_SIZE) |
|
660 | + ? EE_MIGRATION_STEP_SIZE : EE_Data_Migration_Manager::step_size; |
|
661 | + } |
|
662 | + // do what we came to do! |
|
663 | + $currently_executing_script->migration_step($step_size); |
|
664 | + // can we wrap it up and verify default data? |
|
665 | + $init_dbs = false; |
|
666 | + switch ($currently_executing_script->get_status()) { |
|
667 | + case EE_Data_Migration_Manager::status_continue: |
|
668 | + $response_array = array( |
|
669 | + 'records_to_migrate' => $currently_executing_script->count_records_to_migrate(), |
|
670 | + 'records_migrated' => $currently_executing_script->count_records_migrated(), |
|
671 | + 'status' => EE_Data_Migration_Manager::status_continue, |
|
672 | + 'message' => $currently_executing_script->get_feedback_message(), |
|
673 | + 'script' => $currently_executing_script->pretty_name(), |
|
674 | + ); |
|
675 | + break; |
|
676 | + case EE_Data_Migration_Manager::status_completed: |
|
677 | + // ok so THAT script has completed |
|
678 | + $this->update_current_database_state_to($this->script_migrates_to_version($current_script_name)); |
|
679 | + $response_array = array( |
|
680 | + 'records_to_migrate' => $currently_executing_script->count_records_to_migrate(), |
|
681 | + 'records_migrated' => $currently_executing_script->count_records_migrated(), |
|
682 | + 'status' => EE_Data_Migration_Manager::status_completed, |
|
683 | + 'message' => $currently_executing_script->get_feedback_message(), |
|
684 | + 'script' => sprintf( |
|
685 | + __("%s Completed", 'event_espresso'), |
|
686 | + $currently_executing_script->pretty_name() |
|
687 | + ), |
|
688 | + ); |
|
689 | + // check if there are any more after this one. |
|
690 | + $scripts_remaining = $this->check_for_applicable_data_migration_scripts(); |
|
691 | + if (! $scripts_remaining) { |
|
692 | + // we should be good to allow them to exit maintenance mode now |
|
693 | + EE_Maintenance_Mode::instance()->set_maintenance_level( |
|
694 | + intval(EE_Maintenance_Mode::level_0_not_in_maintenance) |
|
695 | + ); |
|
696 | + // huh, no more scripts to run... apparently we're done! |
|
697 | + // but dont forget to make sure initial data is there |
|
698 | + $init_dbs = true; |
|
699 | + $response_array['status'] = self::status_no_more_migration_scripts; |
|
700 | + } |
|
701 | + break; |
|
702 | + default: |
|
703 | + $response_array = array( |
|
704 | + 'records_to_migrate' => $currently_executing_script->count_records_to_migrate(), |
|
705 | + 'records_migrated' => $currently_executing_script->count_records_migrated(), |
|
706 | + 'status' => $currently_executing_script->get_status(), |
|
707 | + 'message' => sprintf( |
|
708 | + __("Minor errors occurred during %s: %s", "event_espresso"), |
|
709 | + $currently_executing_script->pretty_name(), |
|
710 | + implode(", ", $currently_executing_script->get_errors()) |
|
711 | + ), |
|
712 | + 'script' => $currently_executing_script->pretty_name(), |
|
713 | + ); |
|
714 | + break; |
|
715 | + } |
|
716 | + } catch (Exception $e) { |
|
717 | + // ok so some exception was thrown which killed the data migration script |
|
718 | + // double-check we have a real script |
|
719 | + if ($currently_executing_script instanceof EE_Data_Migration_Script_Base) { |
|
720 | + $script_name = $currently_executing_script->pretty_name(); |
|
721 | + $currently_executing_script->set_broken(); |
|
722 | + $currently_executing_script->add_error($e->getMessage()); |
|
723 | + } else { |
|
724 | + $script_name = __("Error getting Migration Script", "event_espresso"); |
|
725 | + } |
|
726 | + $response_array = array( |
|
727 | + 'records_to_migrate' => 1, |
|
728 | + 'records_migrated' => 0, |
|
729 | + 'status' => self::status_fatal_error, |
|
730 | + 'message' => sprintf( |
|
731 | + __("A fatal error occurred during the migration: %s", "event_espresso"), |
|
732 | + $e->getMessage() |
|
733 | + ), |
|
734 | + 'script' => $script_name, |
|
735 | + ); |
|
736 | + } |
|
737 | + $successful_save = $this->_save_migrations_ran(); |
|
738 | + if ($successful_save !== true) { |
|
739 | + // ok so the current wp option didn't save. that's tricky, because we'd like to update it |
|
740 | + // and mark it as having a fatal error, but remember- WE CAN'T SAVE THIS WP OPTION! |
|
741 | + // however, if we throw an exception, and return that, then the next request |
|
742 | + // won't have as much info in it, and it may be able to save |
|
743 | + throw new EE_Error( |
|
744 | + sprintf( |
|
745 | + __( |
|
746 | + "The error '%s' occurred updating the status of the migration. This is a FATAL ERROR, but the error is preventing the system from remembering that. Please contact event espresso support.", |
|
747 | + "event_espresso" |
|
748 | + ), |
|
749 | + $successful_save |
|
750 | + ) |
|
751 | + ); |
|
752 | + } |
|
753 | + // if we're all done, initialize EE plugins' default data etc. |
|
754 | + if ($init_dbs) { |
|
755 | + $this->initialize_db_for_enqueued_ee_plugins(); |
|
756 | + } |
|
757 | + return $response_array; |
|
758 | + } |
|
759 | + |
|
760 | + |
|
761 | + /** |
|
762 | + * Echo out JSON response to migration script AJAX requests. Takes precautions |
|
763 | + * to buffer output so that we don't throw junk into our json. |
|
764 | + * |
|
765 | + * @return array with keys: |
|
766 | + * 'records_to_migrate' which counts ALL the records for the current migration, and should remain constant. (ie, |
|
767 | + * it's NOT the count of hwo many remain) |
|
768 | + * 'records_migrated' which also counts ALL the records which have been migrated (ie, percent_complete = |
|
769 | + * records_migrated/records_to_migrate) |
|
770 | + * 'status'=>a string, one of EE_Data_migration_Manager::status_* |
|
771 | + * 'message'=>a string, containing any message you want to show to the user. We may decide to split this up into |
|
772 | + * errors, notifications, and successes |
|
773 | + * 'script'=>a pretty name of the script currently running |
|
774 | + */ |
|
775 | + public function response_to_migration_ajax_request() |
|
776 | + { |
|
777 | + ob_start(); |
|
778 | + try { |
|
779 | + $response = $this->migration_step(); |
|
780 | + } catch (Exception $e) { |
|
781 | + $response = array( |
|
782 | + 'records_to_migrate' => 0, |
|
783 | + 'records_migrated' => 0, |
|
784 | + 'status' => EE_Data_Migration_Manager::status_fatal_error, |
|
785 | + 'message' => sprintf( |
|
786 | + __("Unknown fatal error occurred: %s", "event_espresso"), |
|
787 | + $e->getMessage() |
|
788 | + ), |
|
789 | + 'script' => 'Unknown', |
|
790 | + ); |
|
791 | + $this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString()); |
|
792 | + } |
|
793 | + $warnings_etc = @ob_get_contents(); |
|
794 | + ob_end_clean(); |
|
795 | + $response['message'] .= $warnings_etc; |
|
796 | + return $response; |
|
797 | + } |
|
798 | + |
|
799 | + /** |
|
800 | + * Updates the wordpress option that keeps track of which which EE version the database |
|
801 | + * is at (ie, the code may be at 4.1.0, but the database is still at 3.1.35) |
|
802 | + * |
|
803 | + * @param array $slug_and_version { |
|
804 | + * @type string $slug like 'Core' or 'Calendar', |
|
805 | + * @type string $version like '4.1.0' |
|
806 | + * } |
|
807 | + * @return void |
|
808 | + */ |
|
809 | + public function update_current_database_state_to($slug_and_version = null) |
|
810 | + { |
|
811 | + if (! $slug_and_version) { |
|
812 | + // no version was provided, assume it should be at the current code version |
|
813 | + $slug_and_version = array('slug' => 'Core', 'version' => espresso_version()); |
|
814 | + } |
|
815 | + $current_database_state = get_option(self::current_database_state); |
|
816 | + $current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version']; |
|
817 | + update_option(self::current_database_state, $current_database_state); |
|
818 | + } |
|
819 | + |
|
820 | + /** |
|
821 | + * Determines if the database is currently at a state matching what's indicated in $slug and $version. |
|
822 | + * |
|
823 | + * @param array $slug_and_version { |
|
824 | + * @type string $slug like 'Core' or 'Calendar', |
|
825 | + * @type string $version like '4.1.0' |
|
826 | + * } |
|
827 | + * @return boolean |
|
828 | + */ |
|
829 | + public function database_needs_updating_to($slug_and_version) |
|
830 | + { |
|
831 | + |
|
832 | + $slug = $slug_and_version['slug']; |
|
833 | + $version = $slug_and_version['version']; |
|
834 | + $current_database_state = get_option(self::current_database_state); |
|
835 | + if (! isset($current_database_state[ $slug ])) { |
|
836 | + return true; |
|
837 | + } else { |
|
838 | + // just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes |
|
839 | + $version_parts_current_db_state = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3); |
|
840 | + $version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3); |
|
841 | + $needs_updating = false; |
|
842 | + foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) { |
|
843 | + if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) { |
|
844 | + $needs_updating = true; |
|
845 | + break; |
|
846 | + } |
|
847 | + } |
|
848 | + return $needs_updating; |
|
849 | + } |
|
850 | + } |
|
851 | + |
|
852 | + |
|
853 | + /** |
|
854 | + * Gets all the data migration scripts available in the core folder and folders |
|
855 | + * in addons. Has the side effect of adding them for autoloading |
|
856 | + * |
|
857 | + * @return array keys are expected classnames, values are their filepaths |
|
858 | + * @throws InvalidInterfaceException |
|
859 | + * @throws InvalidDataTypeException |
|
860 | + * @throws EE_Error |
|
861 | + * @throws InvalidArgumentException |
|
862 | + */ |
|
863 | + public function get_all_data_migration_scripts_available() |
|
864 | + { |
|
865 | + if (! $this->_data_migration_class_to_filepath_map) { |
|
866 | + $this->_data_migration_class_to_filepath_map = array(); |
|
867 | + foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) { |
|
868 | + // strip any placeholders added to classname to make it a unique array key |
|
869 | + $eeAddonClass = trim($eeAddonClass, '*'); |
|
870 | + $eeAddonClass = $eeAddonClass === 'Core' || class_exists($eeAddonClass) |
|
871 | + ? $eeAddonClass |
|
872 | + : ''; |
|
873 | + $folder_path = EEH_File::end_with_directory_separator($folder_path); |
|
874 | + $files = glob($folder_path . '*.dms.php'); |
|
875 | + if (empty($files)) { |
|
876 | + continue; |
|
877 | + } |
|
878 | + foreach ($files as $file) { |
|
879 | + $pos_of_last_slash = strrpos($file, DS); |
|
880 | + $classname = str_replace('.dms.php', '', substr($file, $pos_of_last_slash + 1)); |
|
881 | + $migrates_to = $this->script_migrates_to_version($classname, $eeAddonClass); |
|
882 | + $slug = $migrates_to['slug']; |
|
883 | + // check that the slug as contained in the DMS is associated with |
|
884 | + // the slug of an addon or core |
|
885 | + if ($slug !== 'Core' && EE_Registry::instance()->get_addon_by_name($slug) === null) { |
|
886 | + EE_Error::doing_it_wrong( |
|
887 | + __FUNCTION__, |
|
888 | + sprintf( |
|
889 | + esc_html__( |
|
890 | + 'The data migration script "%s" migrates the "%s" data, but there is no EE addon with that name. There is only: %s. ', |
|
891 | + 'event_espresso' |
|
892 | + ), |
|
893 | + $classname, |
|
894 | + $slug, |
|
895 | + implode(', ', array_keys(EE_Registry::instance()->get_addons_by_name())) |
|
896 | + ), |
|
897 | + '4.3.0.alpha.019' |
|
898 | + ); |
|
899 | + } |
|
900 | + $this->_data_migration_class_to_filepath_map[ $classname ] = $file; |
|
901 | + } |
|
902 | + } |
|
903 | + EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map); |
|
904 | + } |
|
905 | + return $this->_data_migration_class_to_filepath_map; |
|
906 | + } |
|
907 | + |
|
908 | + |
|
909 | + /** |
|
910 | + * Once we have an addon that works with EE4.1, we will actually want to fetch the PUE slugs |
|
911 | + * from each addon, and check if they need updating, |
|
912 | + * |
|
913 | + * @return boolean |
|
914 | + */ |
|
915 | + public function addons_need_updating() |
|
916 | + { |
|
917 | + return false; |
|
918 | + } |
|
919 | + |
|
920 | + /** |
|
921 | + * Adds this error string to the data_migrations_ran array, but we dont necessarily know |
|
922 | + * where to put it, so we just throw it in there... better than nothing... |
|
923 | + * |
|
924 | + * @param string $error_message |
|
925 | + * @throws EE_Error |
|
926 | + */ |
|
927 | + public function add_error_to_migrations_ran($error_message) |
|
928 | + { |
|
929 | + // get last-ran migration script |
|
930 | + global $wpdb; |
|
931 | + $last_migration_script_option = $wpdb->get_row( |
|
932 | + "SELECT * FROM $wpdb->options WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id DESC LIMIT 1", |
|
933 | + ARRAY_A |
|
934 | + ); |
|
935 | + |
|
936 | + $last_ran_migration_script_properties = isset($last_migration_script_option['option_value']) |
|
937 | + ? maybe_unserialize($last_migration_script_option['option_value']) : null; |
|
938 | + // now, tread lightly because we're here because a FATAL non-catchable error |
|
939 | + // was thrown last time when we were trying to run a data migration script |
|
940 | + // so the fatal error could have happened while getting the migration script |
|
941 | + // or doing running it... |
|
942 | + $versions_migrated_to = isset($last_migration_script_option['option_name']) ? str_replace( |
|
943 | + EE_Data_Migration_Manager::data_migration_script_option_prefix, |
|
944 | + "", |
|
945 | + $last_migration_script_option['option_name'] |
|
946 | + ) : null; |
|
947 | + |
|
948 | + // check if it THINKS its a data migration script and especially if it's one that HASN'T finished yet |
|
949 | + // because if it has finished, then it obviously couldn't be the cause of this error, right? (because its all done) |
|
950 | + if (isset($last_ran_migration_script_properties['class']) && isset($last_ran_migration_script_properties['_status']) && $last_ran_migration_script_properties['_status'] != self::status_completed) { |
|
951 | + // ok then just add this error to its list of errors |
|
952 | + $last_ran_migration_script_properties['_errors'][] = $error_message; |
|
953 | + $last_ran_migration_script_properties['_status'] = self::status_fatal_error; |
|
954 | + } else { |
|
955 | + // so we don't even know which script was last running |
|
956 | + // use the data migration error stub, which is designed specifically for this type of thing |
|
957 | + $general_migration_error = new EE_DMS_Unknown_1_0_0(); |
|
958 | + $general_migration_error->add_error($error_message); |
|
959 | + $general_migration_error->set_broken(); |
|
960 | + $last_ran_migration_script_properties = $general_migration_error->properties_as_array(); |
|
961 | + $versions_migrated_to = 'Unknown.1.0.0'; |
|
962 | + // now just to make sure appears as last (in case the were previously a fatal error like this) |
|
963 | + // delete the old one |
|
964 | + delete_option(self::data_migration_script_option_prefix . $versions_migrated_to); |
|
965 | + } |
|
966 | + update_option( |
|
967 | + self::data_migration_script_option_prefix . $versions_migrated_to, |
|
968 | + $last_ran_migration_script_properties |
|
969 | + ); |
|
970 | + } |
|
971 | + |
|
972 | + /** |
|
973 | + * saves what data migrations have ran to the database |
|
974 | + * |
|
975 | + * @return mixed TRUE if successfully saved migrations ran, string if an error occurred |
|
976 | + */ |
|
977 | + protected function _save_migrations_ran() |
|
978 | + { |
|
979 | + if ($this->_data_migrations_ran == null) { |
|
980 | + $this->get_data_migrations_ran(); |
|
981 | + } |
|
982 | + // now, we don't want to save actual classes to the DB because that's messy |
|
983 | + $successful_updates = true; |
|
984 | + foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) { |
|
985 | + foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) { |
|
986 | + $plugin_slug_for_use_in_option_name = $plugin_slug . "."; |
|
987 | + $option_name = self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string; |
|
988 | + $old_option_value = get_option($option_name); |
|
989 | + if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) { |
|
990 | + $script_array_for_saving = $array_or_migration_obj->properties_as_array(); |
|
991 | + if ($old_option_value != $script_array_for_saving) { |
|
992 | + $successful_updates = update_option($option_name, $script_array_for_saving); |
|
993 | + } |
|
994 | + } else {// we don't know what this array-thing is. So just save it as-is |
|
995 | + if ($old_option_value != $array_or_migration_obj) { |
|
996 | + $successful_updates = update_option($option_name, $array_or_migration_obj); |
|
997 | + } |
|
998 | + } |
|
999 | + if (! $successful_updates) { |
|
1000 | + global $wpdb; |
|
1001 | + return $wpdb->last_error; |
|
1002 | + } |
|
1003 | + } |
|
1004 | + } |
|
1005 | + return true; |
|
1006 | + // $updated = update_option(self::data_migrations_option_name, $array_of_migrations); |
|
1007 | + // if ($updated !== true) { |
|
1008 | + // global $wpdb; |
|
1009 | + // return $wpdb->last_error; |
|
1010 | + // } else { |
|
1011 | + // return true; |
|
1012 | + // } |
|
1013 | + // wp_mail( |
|
1014 | + // "[email protected]", |
|
1015 | + // time() . " price debug info", |
|
1016 | + // "updated: $updated, last error: $last_error, byte length of option: " . strlen( |
|
1017 | + // serialize($array_of_migrations) |
|
1018 | + // ) |
|
1019 | + // ); |
|
1020 | + } |
|
1021 | + |
|
1022 | + /** |
|
1023 | + * Takes an array of data migration script properties and re-creates the class from |
|
1024 | + * them. The argument $properties_array is assumed to have been made by |
|
1025 | + * EE_Data_Migration_Script_Base::properties_as_array() |
|
1026 | + * |
|
1027 | + * @param array $properties_array |
|
1028 | + * @return EE_Data_Migration_Script_Base |
|
1029 | + * @throws EE_Error |
|
1030 | + */ |
|
1031 | + public function _instantiate_script_from_properties_array($properties_array) |
|
1032 | + { |
|
1033 | + if (! isset($properties_array['class'])) { |
|
1034 | + throw new EE_Error( |
|
1035 | + sprintf( |
|
1036 | + __("Properties array has no 'class' properties. Here's what it has: %s", "event_espresso"), |
|
1037 | + implode(",", $properties_array) |
|
1038 | + ) |
|
1039 | + ); |
|
1040 | + } |
|
1041 | + $class_name = $properties_array['class']; |
|
1042 | + if (! class_exists($class_name)) { |
|
1043 | + throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"), $class_name)); |
|
1044 | + } |
|
1045 | + $class = new $class_name; |
|
1046 | + if (! $class instanceof EE_Data_Migration_Script_Base) { |
|
1047 | + throw new EE_Error( |
|
1048 | + sprintf( |
|
1049 | + __("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"), |
|
1050 | + $class_name, |
|
1051 | + get_class($class) |
|
1052 | + ) |
|
1053 | + ); |
|
1054 | + } |
|
1055 | + $class->instantiate_from_array_of_properties($properties_array); |
|
1056 | + return $class; |
|
1057 | + } |
|
1058 | + |
|
1059 | + /** |
|
1060 | + * Gets the classname for the most up-to-date DMS (ie, the one that will finally |
|
1061 | + * leave the DB in a state usable by the current plugin code). |
|
1062 | + * |
|
1063 | + * @param string $plugin_slug the slug for the ee plugin we are searching for. Default is 'Core' |
|
1064 | + * @return string |
|
1065 | + */ |
|
1066 | + public function get_most_up_to_date_dms($plugin_slug = 'Core') |
|
1067 | + { |
|
1068 | + $class_to_filepath_map = $this->get_all_data_migration_scripts_available(); |
|
1069 | + $most_up_to_date_dms_classname = null; |
|
1070 | + foreach ($class_to_filepath_map as $classname => $filepath) { |
|
1071 | + if ($most_up_to_date_dms_classname === null) { |
|
1072 | + $migrates_to = $this->script_migrates_to_version($classname); |
|
1073 | + $this_plugin_slug = $migrates_to['slug']; |
|
1074 | + if ($this_plugin_slug == $plugin_slug) { |
|
1075 | + // if it's for core, it wins |
|
1076 | + $most_up_to_date_dms_classname = $classname; |
|
1077 | + } |
|
1078 | + // if it wasn't for core, we must keep searching for one that is! |
|
1079 | + continue; |
|
1080 | + } else { |
|
1081 | + $champion_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms_classname); |
|
1082 | + $contender_migrates_to = $this->script_migrates_to_version($classname); |
|
1083 | + if ($contender_migrates_to['slug'] == $plugin_slug |
|
1084 | + && version_compare( |
|
1085 | + $champion_migrates_to['version'], |
|
1086 | + $contender_migrates_to['version'], |
|
1087 | + '<' |
|
1088 | + )) { |
|
1089 | + // so the contenders version is higher and its for Core |
|
1090 | + $most_up_to_date_dms_classname = $classname; |
|
1091 | + } |
|
1092 | + } |
|
1093 | + } |
|
1094 | + return $most_up_to_date_dms_classname; |
|
1095 | + } |
|
1096 | + |
|
1097 | + /** |
|
1098 | + * Gets the migration script specified but ONLY if it has already ran. |
|
1099 | + * |
|
1100 | + * Eg, if you wanted to see if 'EE_DMS_Core_4_1_0' has ran, you would run the following code: |
|
1101 | + * <code> $core_4_1_0_dms_ran = EE_Data_Migration_Manager::instance()->get_migration_ran( '4.1.0', 'Core' ) !== |
|
1102 | + * NULL;</code> This is especially useful in addons' data migration scripts, this way they can tell if a core (or |
|
1103 | + * other addon) DMS has ran, in case the current DMS depends on it. |
|
1104 | + * |
|
1105 | + * @param string $version the version the DMS searched for migrates to. Usually just the content before the 3rd |
|
1106 | + * period. Eg '4.1.0' |
|
1107 | + * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc |
|
1108 | + * @return EE_Data_Migration_Script_Base |
|
1109 | + */ |
|
1110 | + public function get_migration_ran($version, $plugin_slug = 'Core') |
|
1111 | + { |
|
1112 | + $migrations_ran = $this->get_data_migrations_ran(); |
|
1113 | + if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) { |
|
1114 | + return $migrations_ran[ $plugin_slug ][ $version ]; |
|
1115 | + } else { |
|
1116 | + return null; |
|
1117 | + } |
|
1118 | + } |
|
1119 | + |
|
1120 | + /** |
|
1121 | + * Resets the borked data migration scripts so they're no longer borked |
|
1122 | + * so we can again attempt to migrate |
|
1123 | + * |
|
1124 | + * @return bool |
|
1125 | + * @throws EE_Error |
|
1126 | + */ |
|
1127 | + public function reattempt() |
|
1128 | + { |
|
1129 | + // find if the last-ran script was borked |
|
1130 | + // set it as being non-borked (we shouldn't ever get DMSs that we don't recognize) |
|
1131 | + // add an 'error' saying that we attempted to reset |
|
1132 | + // does it have a stage that was borked too? if so make it no longer borked |
|
1133 | + // add an 'error' saying we attempted to reset |
|
1134 | + $last_ran_script = $this->get_last_ran_script(); |
|
1135 | + if ($last_ran_script instanceof EE_DMS_Unknown_1_0_0) { |
|
1136 | + // if it was an error DMS, just mark it as complete (if another error occurs it will overwrite it) |
|
1137 | + $last_ran_script->set_completed(); |
|
1138 | + } elseif ($last_ran_script instanceof EE_Data_Migration_Script_Base) { |
|
1139 | + $last_ran_script->reattempt(); |
|
1140 | + } else { |
|
1141 | + throw new EE_Error( |
|
1142 | + sprintf( |
|
1143 | + __( |
|
1144 | + 'Unable to reattempt the last ran migration script because it was not a valid migration script. || It was %s', |
|
1145 | + 'event_espresso' |
|
1146 | + ), |
|
1147 | + print_r($last_ran_script, true) |
|
1148 | + ) |
|
1149 | + ); |
|
1150 | + } |
|
1151 | + return $this->_save_migrations_ran(); |
|
1152 | + } |
|
1153 | + |
|
1154 | + /** |
|
1155 | + * Gets whether or not this particular migration has run or not |
|
1156 | + * |
|
1157 | + * @param string $version the version the DMS searched for migrates to. Usually just the content before the 3rd |
|
1158 | + * period. Eg '4.1.0' |
|
1159 | + * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc |
|
1160 | + * @return boolean |
|
1161 | + */ |
|
1162 | + public function migration_has_ran($version, $plugin_slug = 'Core') |
|
1163 | + { |
|
1164 | + return $this->get_migration_ran($version, $plugin_slug) !== null; |
|
1165 | + } |
|
1166 | + |
|
1167 | + /** |
|
1168 | + * Enqueues this ee plugin to have its data initialized |
|
1169 | + * |
|
1170 | + * @param string $plugin_slug either 'Core' or EE_Addon::name()'s return value |
|
1171 | + */ |
|
1172 | + public function enqueue_db_initialization_for($plugin_slug) |
|
1173 | + { |
|
1174 | + $queue = $this->get_db_initialization_queue(); |
|
1175 | + if (! in_array($plugin_slug, $queue)) { |
|
1176 | + $queue[] = $plugin_slug; |
|
1177 | + } |
|
1178 | + update_option(self::db_init_queue_option_name, $queue); |
|
1179 | + } |
|
1180 | + |
|
1181 | + /** |
|
1182 | + * Calls EE_Addon::initialize_db_if_no_migrations_required() on each addon |
|
1183 | + * specified in EE_Data_Migration_Manager::get_db_init_queue(), and if 'Core' is |
|
1184 | + * in the queue, calls EE_System::initialize_db_if_no_migrations_required(). |
|
1185 | + */ |
|
1186 | + public function initialize_db_for_enqueued_ee_plugins() |
|
1187 | + { |
|
1188 | + $queue = $this->get_db_initialization_queue(); |
|
1189 | + foreach ($queue as $plugin_slug) { |
|
1190 | + $most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug); |
|
1191 | + if (! $most_up_to_date_dms) { |
|
1192 | + // if there is NO DMS for this plugin, obviously there's no schema to verify anyways |
|
1193 | + $verify_db = false; |
|
1194 | + } else { |
|
1195 | + $most_up_to_date_dms_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms); |
|
1196 | + $verify_db = $this->database_needs_updating_to($most_up_to_date_dms_migrates_to); |
|
1197 | + } |
|
1198 | + if ($plugin_slug == 'Core') { |
|
1199 | + EE_System::instance()->initialize_db_if_no_migrations_required( |
|
1200 | + false, |
|
1201 | + $verify_db |
|
1202 | + ); |
|
1203 | + } else { |
|
1204 | + // just loop through the addons to make sure their database is setup |
|
1205 | + foreach (EE_Registry::instance()->addons as $addon) { |
|
1206 | + if ($addon->name() == $plugin_slug) { |
|
1207 | + $addon->initialize_db_if_no_migrations_required($verify_db); |
|
1208 | + break; |
|
1209 | + } |
|
1210 | + } |
|
1211 | + } |
|
1212 | + } |
|
1213 | + // because we just initialized the DBs for the enqueued ee plugins |
|
1214 | + // we don't need to keep remembering which ones needed to be initialized |
|
1215 | + delete_option(self::db_init_queue_option_name); |
|
1216 | + } |
|
1217 | + |
|
1218 | + /** |
|
1219 | + * Gets a numerically-indexed array of plugin slugs that need to have their databases |
|
1220 | + * (re-)initialized after migrations are complete. ie, each element should be either |
|
1221 | + * 'Core', or the return value of EE_Addon::name() for an addon |
|
1222 | + * |
|
1223 | + * @return array |
|
1224 | + */ |
|
1225 | + public function get_db_initialization_queue() |
|
1226 | + { |
|
1227 | + return get_option(self::db_init_queue_option_name, array()); |
|
1228 | + } |
|
1229 | + |
|
1230 | + /** |
|
1231 | + * Gets the injected table analyzer, or throws an exception |
|
1232 | + * |
|
1233 | + * @return TableAnalysis |
|
1234 | + * @throws EE_Error |
|
1235 | + */ |
|
1236 | + protected function _get_table_analysis() |
|
1237 | + { |
|
1238 | + if ($this->_table_analysis instanceof TableAnalysis) { |
|
1239 | + return $this->_table_analysis; |
|
1240 | + } else { |
|
1241 | + throw new EE_Error( |
|
1242 | + sprintf( |
|
1243 | + __('Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
1244 | + get_class($this) |
|
1245 | + ) |
|
1246 | + ); |
|
1247 | + } |
|
1248 | + } |
|
1249 | + |
|
1250 | + /** |
|
1251 | + * Gets the injected table manager, or throws an exception |
|
1252 | + * |
|
1253 | + * @return TableManager |
|
1254 | + * @throws EE_Error |
|
1255 | + */ |
|
1256 | + protected function _get_table_manager() |
|
1257 | + { |
|
1258 | + if ($this->_table_manager instanceof TableManager) { |
|
1259 | + return $this->_table_manager; |
|
1260 | + } else { |
|
1261 | + throw new EE_Error( |
|
1262 | + sprintf( |
|
1263 | + __('Table manager class on class %1$s is not set properly.', 'event_espresso'), |
|
1264 | + get_class($this) |
|
1265 | + ) |
|
1266 | + ); |
|
1267 | + } |
|
1268 | + } |
|
1269 | 1269 | } |
@@ -157,7 +157,7 @@ discard block |
||
157 | 157 | public static function instance() |
158 | 158 | { |
159 | 159 | // check if class object is instantiated |
160 | - if (! self::$_instance instanceof EE_Data_Migration_Manager) { |
|
160 | + if ( ! self::$_instance instanceof EE_Data_Migration_Manager) { |
|
161 | 161 | self::$_instance = new self(); |
162 | 162 | } |
163 | 163 | return self::$_instance; |
@@ -233,12 +233,12 @@ discard block |
||
233 | 233 | |
234 | 234 | if (count($parts) == 4) { |
235 | 235 | // it's 4.2-style.eg Core.4.1.0 |
236 | - $plugin_slug = $parts[0];// eg Core |
|
237 | - $version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0 |
|
236 | + $plugin_slug = $parts[0]; // eg Core |
|
237 | + $version_string = $parts[1].".".$parts[2].".".$parts[3]; // eg 4.1.0 |
|
238 | 238 | } else { |
239 | 239 | // it's 4.1-style: eg 4.1.0 |
240 | 240 | $plugin_slug = 'Core'; |
241 | - $version_string = $plugin_slug_and_version_string;// eg 4.1.0 |
|
241 | + $version_string = $plugin_slug_and_version_string; // eg 4.1.0 |
|
242 | 242 | } |
243 | 243 | return array($plugin_slug, $version_string); |
244 | 244 | } |
@@ -290,11 +290,11 @@ discard block |
||
290 | 290 | */ |
291 | 291 | public function get_data_migrations_ran() |
292 | 292 | { |
293 | - if (! $this->_data_migrations_ran) { |
|
293 | + if ( ! $this->_data_migrations_ran) { |
|
294 | 294 | // setup autoloaders for each of the scripts in there |
295 | 295 | $this->get_all_data_migration_scripts_available(); |
296 | 296 | $data_migrations_options = $this->get_all_migration_script_options( |
297 | - );// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array())); |
|
297 | + ); // get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array())); |
|
298 | 298 | |
299 | 299 | $data_migrations_ran = array(); |
300 | 300 | // convert into data migration script classes where possible |
@@ -308,23 +308,23 @@ discard block |
||
308 | 308 | $data_migration_option['option_name'], |
309 | 309 | $data_migration_option['option_value'] |
310 | 310 | ); |
311 | - $data_migrations_ran[ $plugin_slug ][ $version_string ] = $class; |
|
311 | + $data_migrations_ran[$plugin_slug][$version_string] = $class; |
|
312 | 312 | // ok so far THIS is the 'last-ran-script'... unless we find another on next iteration |
313 | 313 | $this->_last_ran_script = $class; |
314 | - if (! $class->is_completed()) { |
|
314 | + if ( ! $class->is_completed()) { |
|
315 | 315 | // sometimes we also like to know which was the last incomplete script (or if there are any at all) |
316 | 316 | $this->_last_ran_incomplete_script = $class; |
317 | 317 | } |
318 | 318 | } catch (EE_Error $e) { |
319 | 319 | // ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs |
320 | - $data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize( |
|
320 | + $data_migrations_ran[$plugin_slug][$version_string] = maybe_unserialize( |
|
321 | 321 | $data_migration_option['option_value'] |
322 | 322 | ); |
323 | 323 | } |
324 | 324 | } |
325 | 325 | // so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays |
326 | 326 | $this->_data_migrations_ran = $data_migrations_ran; |
327 | - if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) { |
|
327 | + if ( ! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) { |
|
328 | 328 | $this->_data_migrations_ran = array(); |
329 | 329 | } |
330 | 330 | } |
@@ -357,7 +357,7 @@ discard block |
||
357 | 357 | { |
358 | 358 | global $wpdb; |
359 | 359 | return $wpdb->get_results( |
360 | - "SELECT * FROM {$wpdb->options} WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id ASC", |
|
360 | + "SELECT * FROM {$wpdb->options} WHERE option_name like '".EE_Data_Migration_Manager::data_migration_script_option_prefix."%' ORDER BY option_id ASC", |
|
361 | 361 | ARRAY_A |
362 | 362 | ); |
363 | 363 | } |
@@ -372,7 +372,7 @@ discard block |
||
372 | 372 | { |
373 | 373 | return apply_filters( |
374 | 374 | 'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders', |
375 | - array('Core' => EE_CORE . 'data_migration_scripts') |
|
375 | + array('Core' => EE_CORE.'data_migration_scripts') |
|
376 | 376 | ); |
377 | 377 | } |
378 | 378 | |
@@ -388,15 +388,15 @@ discard block |
||
388 | 388 | */ |
389 | 389 | public function script_migrates_to_version($migration_script_name, $eeAddonClass = '') |
390 | 390 | { |
391 | - if (isset($this->script_migration_versions[ $migration_script_name ])) { |
|
392 | - return $this->script_migration_versions[ $migration_script_name ]; |
|
391 | + if (isset($this->script_migration_versions[$migration_script_name])) { |
|
392 | + return $this->script_migration_versions[$migration_script_name]; |
|
393 | 393 | } |
394 | 394 | $dms_info = $this->parse_dms_classname($migration_script_name); |
395 | - $this->script_migration_versions[ $migration_script_name ] = array( |
|
395 | + $this->script_migration_versions[$migration_script_name] = array( |
|
396 | 396 | 'slug' => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'], |
397 | - 'version' => $dms_info['major_version'] . "." . $dms_info['minor_version'] . "." . $dms_info['micro_version'], |
|
397 | + 'version' => $dms_info['major_version'].".".$dms_info['minor_version'].".".$dms_info['micro_version'], |
|
398 | 398 | ); |
399 | - return $this->script_migration_versions[ $migration_script_name ]; |
|
399 | + return $this->script_migration_versions[$migration_script_name]; |
|
400 | 400 | } |
401 | 401 | |
402 | 402 | /** |
@@ -410,7 +410,7 @@ discard block |
||
410 | 410 | { |
411 | 411 | $matches = array(); |
412 | 412 | preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches); |
413 | - if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) { |
|
413 | + if ( ! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) { |
|
414 | 414 | throw new EE_Error( |
415 | 415 | sprintf( |
416 | 416 | __( |
@@ -441,7 +441,7 @@ discard block |
||
441 | 441 | { |
442 | 442 | $espresso_db_core_updates = get_option('espresso_db_update', array()); |
443 | 443 | $db_state = get_option(EE_Data_Migration_Manager::current_database_state); |
444 | - if (! $db_state) { |
|
444 | + if ( ! $db_state) { |
|
445 | 445 | // mark the DB as being in the state as the last version in there. |
446 | 446 | // this is done to trigger maintenance mode and do data migration scripts |
447 | 447 | // if the admin installed this version of EE over 3.1.x or 4.0.x |
@@ -460,7 +460,7 @@ discard block |
||
460 | 460 | // in 4.1, $db_state would have only been a simple string like '4.1.0', |
461 | 461 | // but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's |
462 | 462 | // db, and possibly other keys for other addons like 'Calendar','Permissions',etc |
463 | - if (! is_array($db_state)) { |
|
463 | + if ( ! is_array($db_state)) { |
|
464 | 464 | $db_state = array('Core' => $db_state); |
465 | 465 | update_option(EE_Data_Migration_Manager::current_database_state, $db_state); |
466 | 466 | } |
@@ -497,29 +497,29 @@ discard block |
||
497 | 497 | $script_converts_plugin_slug = $migrates_to_version['slug']; |
498 | 498 | $script_converts_to_version = $migrates_to_version['version']; |
499 | 499 | // check if this version script is DONE or not; or if it's never been ran |
500 | - if (! $scripts_ran || |
|
501 | - ! isset($scripts_ran[ $script_converts_plugin_slug ]) || |
|
502 | - ! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])) { |
|
500 | + if ( ! $scripts_ran || |
|
501 | + ! isset($scripts_ran[$script_converts_plugin_slug]) || |
|
502 | + ! isset($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version])) { |
|
503 | 503 | // we haven't ran this conversion script before |
504 | 504 | // now check if it applies... note that we've added an autoloader for it on get_all_data_migration_scripts_available |
505 | 505 | $script = new $classname($this->_get_table_manager(), $this->_get_table_analysis()); |
506 | 506 | /* @var $script EE_Data_Migration_Script_Base */ |
507 | 507 | $can_migrate = $script->can_migrate_from_version($theoretical_database_state); |
508 | 508 | if ($can_migrate) { |
509 | - $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script; |
|
509 | + $script_classes_that_should_run_per_iteration[$iteration][$script->priority()][] = $script; |
|
510 | 510 | $migrates_to_version = $script->migrates_to_version(); |
511 | - $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version']; |
|
512 | - unset($script_class_and_filepaths_available[ $classname ]); |
|
511 | + $next_database_state_to_consider[$migrates_to_version['slug']] = $migrates_to_version['version']; |
|
512 | + unset($script_class_and_filepaths_available[$classname]); |
|
513 | 513 | } |
514 | - } elseif ($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ] instanceof EE_Data_Migration_Script_Base) { |
|
514 | + } elseif ($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version] instanceof EE_Data_Migration_Script_Base) { |
|
515 | 515 | // this script has been ran, or at least started |
516 | - $script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ]; |
|
516 | + $script = $scripts_ran[$script_converts_plugin_slug][$script_converts_to_version]; |
|
517 | 517 | if ($script->get_status() != self::status_completed) { |
518 | 518 | // this script is already underway... keep going with it |
519 | - $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script; |
|
519 | + $script_classes_that_should_run_per_iteration[$iteration][$script->priority()][] = $script; |
|
520 | 520 | $migrates_to_version = $script->migrates_to_version(); |
521 | - $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version']; |
|
522 | - unset($script_class_and_filepaths_available[ $classname ]); |
|
521 | + $next_database_state_to_consider[$migrates_to_version['slug']] = $migrates_to_version['version']; |
|
522 | + unset($script_class_and_filepaths_available[$classname]); |
|
523 | 523 | } else { |
524 | 524 | // it must have a status that indicates it has finished, so we don't want to try and run it again |
525 | 525 | } |
@@ -530,14 +530,14 @@ discard block |
||
530 | 530 | } |
531 | 531 | } |
532 | 532 | $iteration++; |
533 | - } while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6); |
|
533 | + }while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6); |
|
534 | 534 | // ok we have all the scripts that should run, now let's make them into flat array |
535 | 535 | $scripts_that_should_run = array(); |
536 | 536 | foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) { |
537 | 537 | ksort($scripts_at_priority); |
538 | 538 | foreach ($scripts_at_priority as $scripts) { |
539 | 539 | foreach ($scripts as $script) { |
540 | - $scripts_that_should_run[ get_class($script) ] = $script; |
|
540 | + $scripts_that_should_run[get_class($script)] = $script; |
|
541 | 541 | } |
542 | 542 | } |
543 | 543 | } |
@@ -562,7 +562,7 @@ discard block |
||
562 | 562 | public function get_last_ran_script($include_completed_scripts = false) |
563 | 563 | { |
564 | 564 | // make sure we've setup the class properties _last_ran_script and _last_ran_incomplete_script |
565 | - if (! $this->_data_migrations_ran) { |
|
565 | + if ( ! $this->_data_migrations_ran) { |
|
566 | 566 | $this->get_data_migrations_ran(); |
567 | 567 | } |
568 | 568 | if ($include_completed_scripts) { |
@@ -599,10 +599,10 @@ discard block |
||
599 | 599 | |
600 | 600 | try { |
601 | 601 | $currently_executing_script = $this->get_last_ran_script(); |
602 | - if (! $currently_executing_script) { |
|
602 | + if ( ! $currently_executing_script) { |
|
603 | 603 | // Find the next script that needs to execute |
604 | 604 | $scripts = $this->check_for_applicable_data_migration_scripts(); |
605 | - if (! $scripts) { |
|
605 | + if ( ! $scripts) { |
|
606 | 606 | // huh, no more scripts to run... apparently we're done! |
607 | 607 | // but dont forget to make sure initial data is there |
608 | 608 | // we should be good to allow them to exit maintenance mode now |
@@ -628,7 +628,7 @@ discard block |
||
628 | 628 | $migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script)); |
629 | 629 | $plugin_slug = $migrates_to['slug']; |
630 | 630 | $version = $migrates_to['version']; |
631 | - $this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script; |
|
631 | + $this->_data_migrations_ran[$plugin_slug][$version] = $currently_executing_script; |
|
632 | 632 | } |
633 | 633 | $current_script_name = get_class($currently_executing_script); |
634 | 634 | } catch (Exception $e) { |
@@ -636,7 +636,7 @@ discard block |
||
636 | 636 | |
637 | 637 | $message = sprintf( |
638 | 638 | __("Error Message: %sStack Trace:%s", "event_espresso"), |
639 | - $e->getMessage() . '<br>', |
|
639 | + $e->getMessage().'<br>', |
|
640 | 640 | $e->getTraceAsString() |
641 | 641 | ); |
642 | 642 | // record it on the array of data migration scripts ran. This will be overwritten next time we try and try to run data migrations |
@@ -655,7 +655,7 @@ discard block |
||
655 | 655 | // ok so we definitely have a data migration script |
656 | 656 | try { |
657 | 657 | // how big of a bite do we want to take? Allow users to easily override via their wp-config |
658 | - if (! absint($step_size) > 0) { |
|
658 | + if ( ! absint($step_size) > 0) { |
|
659 | 659 | $step_size = defined('EE_MIGRATION_STEP_SIZE') && absint(EE_MIGRATION_STEP_SIZE) |
660 | 660 | ? EE_MIGRATION_STEP_SIZE : EE_Data_Migration_Manager::step_size; |
661 | 661 | } |
@@ -688,7 +688,7 @@ discard block |
||
688 | 688 | ); |
689 | 689 | // check if there are any more after this one. |
690 | 690 | $scripts_remaining = $this->check_for_applicable_data_migration_scripts(); |
691 | - if (! $scripts_remaining) { |
|
691 | + if ( ! $scripts_remaining) { |
|
692 | 692 | // we should be good to allow them to exit maintenance mode now |
693 | 693 | EE_Maintenance_Mode::instance()->set_maintenance_level( |
694 | 694 | intval(EE_Maintenance_Mode::level_0_not_in_maintenance) |
@@ -788,7 +788,7 @@ discard block |
||
788 | 788 | ), |
789 | 789 | 'script' => 'Unknown', |
790 | 790 | ); |
791 | - $this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString()); |
|
791 | + $this->add_error_to_migrations_ran($e->getMessage()."; Stack trace:".$e->getTraceAsString()); |
|
792 | 792 | } |
793 | 793 | $warnings_etc = @ob_get_contents(); |
794 | 794 | ob_end_clean(); |
@@ -808,12 +808,12 @@ discard block |
||
808 | 808 | */ |
809 | 809 | public function update_current_database_state_to($slug_and_version = null) |
810 | 810 | { |
811 | - if (! $slug_and_version) { |
|
811 | + if ( ! $slug_and_version) { |
|
812 | 812 | // no version was provided, assume it should be at the current code version |
813 | 813 | $slug_and_version = array('slug' => 'Core', 'version' => espresso_version()); |
814 | 814 | } |
815 | 815 | $current_database_state = get_option(self::current_database_state); |
816 | - $current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version']; |
|
816 | + $current_database_state[$slug_and_version['slug']] = $slug_and_version['version']; |
|
817 | 817 | update_option(self::current_database_state, $current_database_state); |
818 | 818 | } |
819 | 819 | |
@@ -832,15 +832,15 @@ discard block |
||
832 | 832 | $slug = $slug_and_version['slug']; |
833 | 833 | $version = $slug_and_version['version']; |
834 | 834 | $current_database_state = get_option(self::current_database_state); |
835 | - if (! isset($current_database_state[ $slug ])) { |
|
835 | + if ( ! isset($current_database_state[$slug])) { |
|
836 | 836 | return true; |
837 | 837 | } else { |
838 | 838 | // just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes |
839 | - $version_parts_current_db_state = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3); |
|
839 | + $version_parts_current_db_state = array_slice(explode('.', $current_database_state[$slug]), 0, 3); |
|
840 | 840 | $version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3); |
841 | 841 | $needs_updating = false; |
842 | 842 | foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) { |
843 | - if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) { |
|
843 | + if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[$offset]) { |
|
844 | 844 | $needs_updating = true; |
845 | 845 | break; |
846 | 846 | } |
@@ -862,7 +862,7 @@ discard block |
||
862 | 862 | */ |
863 | 863 | public function get_all_data_migration_scripts_available() |
864 | 864 | { |
865 | - if (! $this->_data_migration_class_to_filepath_map) { |
|
865 | + if ( ! $this->_data_migration_class_to_filepath_map) { |
|
866 | 866 | $this->_data_migration_class_to_filepath_map = array(); |
867 | 867 | foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) { |
868 | 868 | // strip any placeholders added to classname to make it a unique array key |
@@ -871,7 +871,7 @@ discard block |
||
871 | 871 | ? $eeAddonClass |
872 | 872 | : ''; |
873 | 873 | $folder_path = EEH_File::end_with_directory_separator($folder_path); |
874 | - $files = glob($folder_path . '*.dms.php'); |
|
874 | + $files = glob($folder_path.'*.dms.php'); |
|
875 | 875 | if (empty($files)) { |
876 | 876 | continue; |
877 | 877 | } |
@@ -897,7 +897,7 @@ discard block |
||
897 | 897 | '4.3.0.alpha.019' |
898 | 898 | ); |
899 | 899 | } |
900 | - $this->_data_migration_class_to_filepath_map[ $classname ] = $file; |
|
900 | + $this->_data_migration_class_to_filepath_map[$classname] = $file; |
|
901 | 901 | } |
902 | 902 | } |
903 | 903 | EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map); |
@@ -929,7 +929,7 @@ discard block |
||
929 | 929 | // get last-ran migration script |
930 | 930 | global $wpdb; |
931 | 931 | $last_migration_script_option = $wpdb->get_row( |
932 | - "SELECT * FROM $wpdb->options WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id DESC LIMIT 1", |
|
932 | + "SELECT * FROM $wpdb->options WHERE option_name like '".EE_Data_Migration_Manager::data_migration_script_option_prefix."%' ORDER BY option_id DESC LIMIT 1", |
|
933 | 933 | ARRAY_A |
934 | 934 | ); |
935 | 935 | |
@@ -961,10 +961,10 @@ discard block |
||
961 | 961 | $versions_migrated_to = 'Unknown.1.0.0'; |
962 | 962 | // now just to make sure appears as last (in case the were previously a fatal error like this) |
963 | 963 | // delete the old one |
964 | - delete_option(self::data_migration_script_option_prefix . $versions_migrated_to); |
|
964 | + delete_option(self::data_migration_script_option_prefix.$versions_migrated_to); |
|
965 | 965 | } |
966 | 966 | update_option( |
967 | - self::data_migration_script_option_prefix . $versions_migrated_to, |
|
967 | + self::data_migration_script_option_prefix.$versions_migrated_to, |
|
968 | 968 | $last_ran_migration_script_properties |
969 | 969 | ); |
970 | 970 | } |
@@ -983,8 +983,8 @@ discard block |
||
983 | 983 | $successful_updates = true; |
984 | 984 | foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) { |
985 | 985 | foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) { |
986 | - $plugin_slug_for_use_in_option_name = $plugin_slug . "."; |
|
987 | - $option_name = self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string; |
|
986 | + $plugin_slug_for_use_in_option_name = $plugin_slug."."; |
|
987 | + $option_name = self::data_migration_script_option_prefix.$plugin_slug_for_use_in_option_name.$version_string; |
|
988 | 988 | $old_option_value = get_option($option_name); |
989 | 989 | if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) { |
990 | 990 | $script_array_for_saving = $array_or_migration_obj->properties_as_array(); |
@@ -996,7 +996,7 @@ discard block |
||
996 | 996 | $successful_updates = update_option($option_name, $array_or_migration_obj); |
997 | 997 | } |
998 | 998 | } |
999 | - if (! $successful_updates) { |
|
999 | + if ( ! $successful_updates) { |
|
1000 | 1000 | global $wpdb; |
1001 | 1001 | return $wpdb->last_error; |
1002 | 1002 | } |
@@ -1030,7 +1030,7 @@ discard block |
||
1030 | 1030 | */ |
1031 | 1031 | public function _instantiate_script_from_properties_array($properties_array) |
1032 | 1032 | { |
1033 | - if (! isset($properties_array['class'])) { |
|
1033 | + if ( ! isset($properties_array['class'])) { |
|
1034 | 1034 | throw new EE_Error( |
1035 | 1035 | sprintf( |
1036 | 1036 | __("Properties array has no 'class' properties. Here's what it has: %s", "event_espresso"), |
@@ -1039,11 +1039,11 @@ discard block |
||
1039 | 1039 | ); |
1040 | 1040 | } |
1041 | 1041 | $class_name = $properties_array['class']; |
1042 | - if (! class_exists($class_name)) { |
|
1042 | + if ( ! class_exists($class_name)) { |
|
1043 | 1043 | throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"), $class_name)); |
1044 | 1044 | } |
1045 | 1045 | $class = new $class_name; |
1046 | - if (! $class instanceof EE_Data_Migration_Script_Base) { |
|
1046 | + if ( ! $class instanceof EE_Data_Migration_Script_Base) { |
|
1047 | 1047 | throw new EE_Error( |
1048 | 1048 | sprintf( |
1049 | 1049 | __("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"), |
@@ -1110,8 +1110,8 @@ discard block |
||
1110 | 1110 | public function get_migration_ran($version, $plugin_slug = 'Core') |
1111 | 1111 | { |
1112 | 1112 | $migrations_ran = $this->get_data_migrations_ran(); |
1113 | - if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) { |
|
1114 | - return $migrations_ran[ $plugin_slug ][ $version ]; |
|
1113 | + if (isset($migrations_ran[$plugin_slug]) && isset($migrations_ran[$plugin_slug][$version])) { |
|
1114 | + return $migrations_ran[$plugin_slug][$version]; |
|
1115 | 1115 | } else { |
1116 | 1116 | return null; |
1117 | 1117 | } |
@@ -1172,7 +1172,7 @@ discard block |
||
1172 | 1172 | public function enqueue_db_initialization_for($plugin_slug) |
1173 | 1173 | { |
1174 | 1174 | $queue = $this->get_db_initialization_queue(); |
1175 | - if (! in_array($plugin_slug, $queue)) { |
|
1175 | + if ( ! in_array($plugin_slug, $queue)) { |
|
1176 | 1176 | $queue[] = $plugin_slug; |
1177 | 1177 | } |
1178 | 1178 | update_option(self::db_init_queue_option_name, $queue); |
@@ -1188,7 +1188,7 @@ discard block |
||
1188 | 1188 | $queue = $this->get_db_initialization_queue(); |
1189 | 1189 | foreach ($queue as $plugin_slug) { |
1190 | 1190 | $most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug); |
1191 | - if (! $most_up_to_date_dms) { |
|
1191 | + if ( ! $most_up_to_date_dms) { |
|
1192 | 1192 | // if there is NO DMS for this plugin, obviously there's no schema to verify anyways |
1193 | 1193 | $verify_db = false; |
1194 | 1194 | } else { |
@@ -1163,8 +1163,8 @@ discard block |
||
1163 | 1163 | * @param array $datetime_tickets |
1164 | 1164 | * @param array $all_tickets |
1165 | 1165 | * @param bool $default |
1166 | - * @param array $all_datetimes |
|
1167 | - * @return mixed |
|
1166 | + * @param EE_Datetime[] $all_datetimes |
|
1167 | + * @return string |
|
1168 | 1168 | * @throws DomainException |
1169 | 1169 | * @throws EE_Error |
1170 | 1170 | */ |
@@ -1275,7 +1275,7 @@ discard block |
||
1275 | 1275 | * @param array $datetime_tickets |
1276 | 1276 | * @param array $all_tickets |
1277 | 1277 | * @param bool $default |
1278 | - * @return mixed |
|
1278 | + * @return string |
|
1279 | 1279 | * @throws DomainException |
1280 | 1280 | * @throws EE_Error |
1281 | 1281 | */ |
@@ -1343,7 +1343,7 @@ discard block |
||
1343 | 1343 | * @param EE_Ticket $ticket |
1344 | 1344 | * @param array $datetime_tickets |
1345 | 1345 | * @param bool $default |
1346 | - * @return mixed |
|
1346 | + * @return string |
|
1347 | 1347 | * @throws DomainException |
1348 | 1348 | * @throws EE_Error |
1349 | 1349 | */ |
@@ -1413,7 +1413,7 @@ discard block |
||
1413 | 1413 | * @param bool $default Whether default row being generated or not. |
1414 | 1414 | * @param EE_Ticket[] $all_tickets This is an array of all tickets attached to the event |
1415 | 1415 | * (or empty in the case of defaults) |
1416 | - * @return mixed |
|
1416 | + * @return string |
|
1417 | 1417 | * @throws InvalidArgumentException |
1418 | 1418 | * @throws InvalidInterfaceException |
1419 | 1419 | * @throws InvalidDataTypeException |
@@ -1737,7 +1737,7 @@ discard block |
||
1737 | 1737 | * @param EE_Ticket|null $ticket |
1738 | 1738 | * @param bool $show_trash |
1739 | 1739 | * @param bool $show_create |
1740 | - * @return mixed |
|
1740 | + * @return string |
|
1741 | 1741 | * @throws InvalidArgumentException |
1742 | 1742 | * @throws InvalidInterfaceException |
1743 | 1743 | * @throws InvalidDataTypeException |
@@ -1840,7 +1840,7 @@ discard block |
||
1840 | 1840 | * @param EE_Price $price |
1841 | 1841 | * @param bool $default |
1842 | 1842 | * @param bool $disabled |
1843 | - * @return mixed |
|
1843 | + * @return string |
|
1844 | 1844 | * @throws ReflectionException |
1845 | 1845 | * @throws InvalidArgumentException |
1846 | 1846 | * @throws InvalidInterfaceException |
@@ -1873,7 +1873,7 @@ discard block |
||
1873 | 1873 | * @param int $price_row |
1874 | 1874 | * @param EE_Price $price |
1875 | 1875 | * @param bool $default |
1876 | - * @return mixed |
|
1876 | + * @return string |
|
1877 | 1877 | * @throws DomainException |
1878 | 1878 | * @throws EE_Error |
1879 | 1879 | */ |
@@ -1910,7 +1910,7 @@ discard block |
||
1910 | 1910 | * @param EE_Price $price |
1911 | 1911 | * @param bool $default |
1912 | 1912 | * @param bool $disabled |
1913 | - * @return mixed |
|
1913 | + * @return string |
|
1914 | 1914 | * @throws ReflectionException |
1915 | 1915 | * @throws InvalidArgumentException |
1916 | 1916 | * @throws InvalidInterfaceException |
@@ -2012,7 +2012,7 @@ discard block |
||
2012 | 2012 | * @param EE_Ticket|null $ticket |
2013 | 2013 | * @param array $ticket_datetimes |
2014 | 2014 | * @param bool $default |
2015 | - * @return mixed |
|
2015 | + * @return string |
|
2016 | 2016 | * @throws DomainException |
2017 | 2017 | * @throws EE_Error |
2018 | 2018 | */ |
@@ -2065,9 +2065,9 @@ discard block |
||
2065 | 2065 | |
2066 | 2066 | |
2067 | 2067 | /** |
2068 | - * @param array $all_datetimes |
|
2068 | + * @param EE_Datetime[] $all_datetimes |
|
2069 | 2069 | * @param array $all_tickets |
2070 | - * @return mixed |
|
2070 | + * @return string |
|
2071 | 2071 | * @throws ReflectionException |
2072 | 2072 | * @throws InvalidArgumentException |
2073 | 2073 | * @throws InvalidInterfaceException |
@@ -15,2196 +15,2196 @@ |
||
15 | 15 | class espresso_events_Pricing_Hooks extends EE_Admin_Hooks |
16 | 16 | { |
17 | 17 | |
18 | - /** |
|
19 | - * This property is just used to hold the status of whether an event is currently being |
|
20 | - * created (true) or edited (false) |
|
21 | - * |
|
22 | - * @access protected |
|
23 | - * @var bool |
|
24 | - */ |
|
25 | - protected $_is_creating_event; |
|
18 | + /** |
|
19 | + * This property is just used to hold the status of whether an event is currently being |
|
20 | + * created (true) or edited (false) |
|
21 | + * |
|
22 | + * @access protected |
|
23 | + * @var bool |
|
24 | + */ |
|
25 | + protected $_is_creating_event; |
|
26 | 26 | |
27 | - /** |
|
28 | - * Used to contain the format strings for date and time that will be used for php date and |
|
29 | - * time. |
|
30 | - * Is set in the _set_hooks_properties() method. |
|
31 | - * |
|
32 | - * @var array |
|
33 | - */ |
|
34 | - protected $_date_format_strings; |
|
27 | + /** |
|
28 | + * Used to contain the format strings for date and time that will be used for php date and |
|
29 | + * time. |
|
30 | + * Is set in the _set_hooks_properties() method. |
|
31 | + * |
|
32 | + * @var array |
|
33 | + */ |
|
34 | + protected $_date_format_strings; |
|
35 | 35 | |
36 | - /** |
|
37 | - * @var string $_date_time_format |
|
38 | - */ |
|
39 | - protected $_date_time_format; |
|
36 | + /** |
|
37 | + * @var string $_date_time_format |
|
38 | + */ |
|
39 | + protected $_date_time_format; |
|
40 | 40 | |
41 | 41 | |
42 | - /** |
|
43 | - * @throws InvalidArgumentException |
|
44 | - * @throws InvalidInterfaceException |
|
45 | - * @throws InvalidDataTypeException |
|
46 | - */ |
|
47 | - protected function _set_hooks_properties() |
|
48 | - { |
|
49 | - $this->_name = 'pricing'; |
|
50 | - // capability check |
|
51 | - if (! EE_Registry::instance()->CAP->current_user_can( |
|
52 | - 'ee_read_default_prices', |
|
53 | - 'advanced_ticket_datetime_metabox' |
|
54 | - )) { |
|
55 | - return; |
|
56 | - } |
|
57 | - $this->_setup_metaboxes(); |
|
58 | - $this->_set_date_time_formats(); |
|
59 | - $this->_validate_format_strings(); |
|
60 | - $this->_set_scripts_styles(); |
|
61 | - // commented out temporarily until logic is implemented in callback |
|
62 | - // add_action( |
|
63 | - // 'AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_Extend_Events_Admin_Page', |
|
64 | - // array($this, 'autosave_handling') |
|
65 | - // ); |
|
66 | - add_filter( |
|
67 | - 'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks', |
|
68 | - array($this, 'caf_updates') |
|
69 | - ); |
|
70 | - } |
|
42 | + /** |
|
43 | + * @throws InvalidArgumentException |
|
44 | + * @throws InvalidInterfaceException |
|
45 | + * @throws InvalidDataTypeException |
|
46 | + */ |
|
47 | + protected function _set_hooks_properties() |
|
48 | + { |
|
49 | + $this->_name = 'pricing'; |
|
50 | + // capability check |
|
51 | + if (! EE_Registry::instance()->CAP->current_user_can( |
|
52 | + 'ee_read_default_prices', |
|
53 | + 'advanced_ticket_datetime_metabox' |
|
54 | + )) { |
|
55 | + return; |
|
56 | + } |
|
57 | + $this->_setup_metaboxes(); |
|
58 | + $this->_set_date_time_formats(); |
|
59 | + $this->_validate_format_strings(); |
|
60 | + $this->_set_scripts_styles(); |
|
61 | + // commented out temporarily until logic is implemented in callback |
|
62 | + // add_action( |
|
63 | + // 'AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_Extend_Events_Admin_Page', |
|
64 | + // array($this, 'autosave_handling') |
|
65 | + // ); |
|
66 | + add_filter( |
|
67 | + 'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks', |
|
68 | + array($this, 'caf_updates') |
|
69 | + ); |
|
70 | + } |
|
71 | 71 | |
72 | 72 | |
73 | - /** |
|
74 | - * @return void |
|
75 | - */ |
|
76 | - protected function _setup_metaboxes() |
|
77 | - { |
|
78 | - // if we were going to add our own metaboxes we'd use the below. |
|
79 | - $this->_metaboxes = array( |
|
80 | - 0 => array( |
|
81 | - 'page_route' => array('edit', 'create_new'), |
|
82 | - 'func' => 'pricing_metabox', |
|
83 | - 'label' => esc_html__('Event Tickets & Datetimes', 'event_espresso'), |
|
84 | - 'priority' => 'high', |
|
85 | - 'context' => 'normal', |
|
86 | - ), |
|
87 | - ); |
|
88 | - $this->_remove_metaboxes = array( |
|
89 | - 0 => array( |
|
90 | - 'page_route' => array('edit', 'create_new'), |
|
91 | - 'id' => 'espresso_event_editor_tickets', |
|
92 | - 'context' => 'normal', |
|
93 | - ), |
|
94 | - ); |
|
95 | - } |
|
73 | + /** |
|
74 | + * @return void |
|
75 | + */ |
|
76 | + protected function _setup_metaboxes() |
|
77 | + { |
|
78 | + // if we were going to add our own metaboxes we'd use the below. |
|
79 | + $this->_metaboxes = array( |
|
80 | + 0 => array( |
|
81 | + 'page_route' => array('edit', 'create_new'), |
|
82 | + 'func' => 'pricing_metabox', |
|
83 | + 'label' => esc_html__('Event Tickets & Datetimes', 'event_espresso'), |
|
84 | + 'priority' => 'high', |
|
85 | + 'context' => 'normal', |
|
86 | + ), |
|
87 | + ); |
|
88 | + $this->_remove_metaboxes = array( |
|
89 | + 0 => array( |
|
90 | + 'page_route' => array('edit', 'create_new'), |
|
91 | + 'id' => 'espresso_event_editor_tickets', |
|
92 | + 'context' => 'normal', |
|
93 | + ), |
|
94 | + ); |
|
95 | + } |
|
96 | 96 | |
97 | 97 | |
98 | - /** |
|
99 | - * @return void |
|
100 | - */ |
|
101 | - protected function _set_date_time_formats() |
|
102 | - { |
|
103 | - /** |
|
104 | - * Format strings for date and time. Defaults are existing behaviour from 4.1. |
|
105 | - * Note, that if you return null as the value for 'date', and 'time' in the array, then |
|
106 | - * EE will automatically use the set wp_options, 'date_format', and 'time_format'. |
|
107 | - * |
|
108 | - * @since 4.6.7 |
|
109 | - * @var array Expected an array returned with 'date' and 'time' keys. |
|
110 | - */ |
|
111 | - $this->_date_format_strings = apply_filters( |
|
112 | - 'FHEE__espresso_events_Pricing_Hooks___set_hooks_properties__date_format_strings', |
|
113 | - array( |
|
114 | - 'date' => 'Y-m-d', |
|
115 | - 'time' => 'h:i a', |
|
116 | - ) |
|
117 | - ); |
|
118 | - // validate |
|
119 | - $this->_date_format_strings['date'] = isset($this->_date_format_strings['date']) |
|
120 | - ? $this->_date_format_strings['date'] |
|
121 | - : null; |
|
122 | - $this->_date_format_strings['time'] = isset($this->_date_format_strings['time']) |
|
123 | - ? $this->_date_format_strings['time'] |
|
124 | - : null; |
|
125 | - $this->_date_time_format = $this->_date_format_strings['date'] |
|
126 | - . ' ' |
|
127 | - . $this->_date_format_strings['time']; |
|
128 | - } |
|
98 | + /** |
|
99 | + * @return void |
|
100 | + */ |
|
101 | + protected function _set_date_time_formats() |
|
102 | + { |
|
103 | + /** |
|
104 | + * Format strings for date and time. Defaults are existing behaviour from 4.1. |
|
105 | + * Note, that if you return null as the value for 'date', and 'time' in the array, then |
|
106 | + * EE will automatically use the set wp_options, 'date_format', and 'time_format'. |
|
107 | + * |
|
108 | + * @since 4.6.7 |
|
109 | + * @var array Expected an array returned with 'date' and 'time' keys. |
|
110 | + */ |
|
111 | + $this->_date_format_strings = apply_filters( |
|
112 | + 'FHEE__espresso_events_Pricing_Hooks___set_hooks_properties__date_format_strings', |
|
113 | + array( |
|
114 | + 'date' => 'Y-m-d', |
|
115 | + 'time' => 'h:i a', |
|
116 | + ) |
|
117 | + ); |
|
118 | + // validate |
|
119 | + $this->_date_format_strings['date'] = isset($this->_date_format_strings['date']) |
|
120 | + ? $this->_date_format_strings['date'] |
|
121 | + : null; |
|
122 | + $this->_date_format_strings['time'] = isset($this->_date_format_strings['time']) |
|
123 | + ? $this->_date_format_strings['time'] |
|
124 | + : null; |
|
125 | + $this->_date_time_format = $this->_date_format_strings['date'] |
|
126 | + . ' ' |
|
127 | + . $this->_date_format_strings['time']; |
|
128 | + } |
|
129 | 129 | |
130 | 130 | |
131 | - /** |
|
132 | - * @return void |
|
133 | - */ |
|
134 | - protected function _validate_format_strings() |
|
135 | - { |
|
136 | - // validate format strings |
|
137 | - $format_validation = EEH_DTT_Helper::validate_format_string( |
|
138 | - $this->_date_time_format |
|
139 | - ); |
|
140 | - if (is_array($format_validation)) { |
|
141 | - $msg = '<p>'; |
|
142 | - $msg .= sprintf( |
|
143 | - esc_html__( |
|
144 | - 'The format "%s" was likely added via a filter and is invalid for the following reasons:', |
|
145 | - 'event_espresso' |
|
146 | - ), |
|
147 | - $this->_date_time_format |
|
148 | - ); |
|
149 | - $msg .= '</p><ul>'; |
|
150 | - foreach ($format_validation as $error) { |
|
151 | - $msg .= '<li>' . $error . '</li>'; |
|
152 | - } |
|
153 | - $msg .= '</ul><p>'; |
|
154 | - $msg .= sprintf( |
|
155 | - esc_html__( |
|
156 | - '%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s', |
|
157 | - 'event_espresso' |
|
158 | - ), |
|
159 | - '<span style="color:#D54E21;">', |
|
160 | - '</span>' |
|
161 | - ); |
|
162 | - $msg .= '</p>'; |
|
163 | - EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__); |
|
164 | - $this->_date_format_strings = array( |
|
165 | - 'date' => 'Y-m-d', |
|
166 | - 'time' => 'h:i a', |
|
167 | - ); |
|
168 | - } |
|
169 | - } |
|
131 | + /** |
|
132 | + * @return void |
|
133 | + */ |
|
134 | + protected function _validate_format_strings() |
|
135 | + { |
|
136 | + // validate format strings |
|
137 | + $format_validation = EEH_DTT_Helper::validate_format_string( |
|
138 | + $this->_date_time_format |
|
139 | + ); |
|
140 | + if (is_array($format_validation)) { |
|
141 | + $msg = '<p>'; |
|
142 | + $msg .= sprintf( |
|
143 | + esc_html__( |
|
144 | + 'The format "%s" was likely added via a filter and is invalid for the following reasons:', |
|
145 | + 'event_espresso' |
|
146 | + ), |
|
147 | + $this->_date_time_format |
|
148 | + ); |
|
149 | + $msg .= '</p><ul>'; |
|
150 | + foreach ($format_validation as $error) { |
|
151 | + $msg .= '<li>' . $error . '</li>'; |
|
152 | + } |
|
153 | + $msg .= '</ul><p>'; |
|
154 | + $msg .= sprintf( |
|
155 | + esc_html__( |
|
156 | + '%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s', |
|
157 | + 'event_espresso' |
|
158 | + ), |
|
159 | + '<span style="color:#D54E21;">', |
|
160 | + '</span>' |
|
161 | + ); |
|
162 | + $msg .= '</p>'; |
|
163 | + EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__); |
|
164 | + $this->_date_format_strings = array( |
|
165 | + 'date' => 'Y-m-d', |
|
166 | + 'time' => 'h:i a', |
|
167 | + ); |
|
168 | + } |
|
169 | + } |
|
170 | 170 | |
171 | 171 | |
172 | - /** |
|
173 | - * @return void |
|
174 | - */ |
|
175 | - protected function _set_scripts_styles() |
|
176 | - { |
|
177 | - $this->_scripts_styles = array( |
|
178 | - 'registers' => array( |
|
179 | - 'ee-tickets-datetimes-css' => array( |
|
180 | - 'url' => PRICING_ASSETS_URL . 'event-tickets-datetimes.css', |
|
181 | - 'type' => 'css', |
|
182 | - ), |
|
183 | - 'ee-dtt-ticket-metabox' => array( |
|
184 | - 'url' => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js', |
|
185 | - 'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'), |
|
186 | - ), |
|
187 | - ), |
|
188 | - 'deregisters' => array( |
|
189 | - 'event-editor-css' => array('type' => 'css'), |
|
190 | - 'event-datetime-metabox' => array('type' => 'js'), |
|
191 | - ), |
|
192 | - 'enqueues' => array( |
|
193 | - 'ee-tickets-datetimes-css' => array('edit', 'create_new'), |
|
194 | - 'ee-dtt-ticket-metabox' => array('edit', 'create_new'), |
|
195 | - ), |
|
196 | - 'localize' => array( |
|
197 | - 'ee-dtt-ticket-metabox' => array( |
|
198 | - 'DTT_TRASH_BLOCK' => array( |
|
199 | - 'main_warning' => esc_html__( |
|
200 | - 'The Datetime you are attempting to trash is the only datetime selected for the following ticket(s):', |
|
201 | - 'event_espresso' |
|
202 | - ), |
|
203 | - 'after_warning' => esc_html__( |
|
204 | - 'In order to trash this datetime you must first make sure the above ticket(s) are assigned to other datetimes.', |
|
205 | - 'event_espresso' |
|
206 | - ), |
|
207 | - 'cancel_button' => '<button class="button-secondary ee-modal-cancel">' |
|
208 | - . esc_html__('Cancel', 'event_espresso') . '</button>', |
|
209 | - 'close_button' => '<button class="button-secondary ee-modal-cancel">' |
|
210 | - . esc_html__('Close', 'event_espresso') . '</button>', |
|
211 | - 'single_warning_from_tkt' => esc_html__( |
|
212 | - 'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.', |
|
213 | - 'event_espresso' |
|
214 | - ), |
|
215 | - 'single_warning_from_dtt' => esc_html__( |
|
216 | - 'The ticket you are attempting to unassign from this datetime cannot be unassigned because the datetime is the only remaining datetime for the ticket. Tickets must always have at least one datetime assigned to them.', |
|
217 | - 'event_espresso' |
|
218 | - ), |
|
219 | - 'dismiss_button' => '<button class="button-secondary ee-modal-cancel">' |
|
220 | - . esc_html__('Dismiss', 'event_espresso') . '</button>', |
|
221 | - ), |
|
222 | - 'DTT_ERROR_MSG' => array( |
|
223 | - 'no_ticket_name' => esc_html__('General Admission', 'event_espresso'), |
|
224 | - 'dismiss_button' => '<div class="save-cancel-button-container">' |
|
225 | - . '<button class="button-secondary ee-modal-cancel">' |
|
226 | - . esc_html__('Dismiss', 'event_espresso') |
|
227 | - . '</button></div>', |
|
228 | - ), |
|
229 | - 'DTT_OVERSELL_WARNING' => array( |
|
230 | - 'datetime_ticket' => esc_html__( |
|
231 | - 'You cannot add this ticket to this datetime because it has a sold amount that is greater than the amount of spots remaining for this datetime.', |
|
232 | - 'event_espresso' |
|
233 | - ), |
|
234 | - 'ticket_datetime' => esc_html__( |
|
235 | - 'You cannot add this datetime to this ticket because the ticket has a sold amount that is greater than the amount of spots remaining on the datetime.', |
|
236 | - 'event_espresso' |
|
237 | - ), |
|
238 | - ), |
|
239 | - 'DTT_CONVERTED_FORMATS' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats( |
|
240 | - $this->_date_format_strings['date'], |
|
241 | - $this->_date_format_strings['time'] |
|
242 | - ), |
|
243 | - 'DTT_START_OF_WEEK' => array('dayValue' => (int) get_option('start_of_week')), |
|
244 | - ), |
|
245 | - ), |
|
246 | - ); |
|
247 | - } |
|
172 | + /** |
|
173 | + * @return void |
|
174 | + */ |
|
175 | + protected function _set_scripts_styles() |
|
176 | + { |
|
177 | + $this->_scripts_styles = array( |
|
178 | + 'registers' => array( |
|
179 | + 'ee-tickets-datetimes-css' => array( |
|
180 | + 'url' => PRICING_ASSETS_URL . 'event-tickets-datetimes.css', |
|
181 | + 'type' => 'css', |
|
182 | + ), |
|
183 | + 'ee-dtt-ticket-metabox' => array( |
|
184 | + 'url' => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js', |
|
185 | + 'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'), |
|
186 | + ), |
|
187 | + ), |
|
188 | + 'deregisters' => array( |
|
189 | + 'event-editor-css' => array('type' => 'css'), |
|
190 | + 'event-datetime-metabox' => array('type' => 'js'), |
|
191 | + ), |
|
192 | + 'enqueues' => array( |
|
193 | + 'ee-tickets-datetimes-css' => array('edit', 'create_new'), |
|
194 | + 'ee-dtt-ticket-metabox' => array('edit', 'create_new'), |
|
195 | + ), |
|
196 | + 'localize' => array( |
|
197 | + 'ee-dtt-ticket-metabox' => array( |
|
198 | + 'DTT_TRASH_BLOCK' => array( |
|
199 | + 'main_warning' => esc_html__( |
|
200 | + 'The Datetime you are attempting to trash is the only datetime selected for the following ticket(s):', |
|
201 | + 'event_espresso' |
|
202 | + ), |
|
203 | + 'after_warning' => esc_html__( |
|
204 | + 'In order to trash this datetime you must first make sure the above ticket(s) are assigned to other datetimes.', |
|
205 | + 'event_espresso' |
|
206 | + ), |
|
207 | + 'cancel_button' => '<button class="button-secondary ee-modal-cancel">' |
|
208 | + . esc_html__('Cancel', 'event_espresso') . '</button>', |
|
209 | + 'close_button' => '<button class="button-secondary ee-modal-cancel">' |
|
210 | + . esc_html__('Close', 'event_espresso') . '</button>', |
|
211 | + 'single_warning_from_tkt' => esc_html__( |
|
212 | + 'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.', |
|
213 | + 'event_espresso' |
|
214 | + ), |
|
215 | + 'single_warning_from_dtt' => esc_html__( |
|
216 | + 'The ticket you are attempting to unassign from this datetime cannot be unassigned because the datetime is the only remaining datetime for the ticket. Tickets must always have at least one datetime assigned to them.', |
|
217 | + 'event_espresso' |
|
218 | + ), |
|
219 | + 'dismiss_button' => '<button class="button-secondary ee-modal-cancel">' |
|
220 | + . esc_html__('Dismiss', 'event_espresso') . '</button>', |
|
221 | + ), |
|
222 | + 'DTT_ERROR_MSG' => array( |
|
223 | + 'no_ticket_name' => esc_html__('General Admission', 'event_espresso'), |
|
224 | + 'dismiss_button' => '<div class="save-cancel-button-container">' |
|
225 | + . '<button class="button-secondary ee-modal-cancel">' |
|
226 | + . esc_html__('Dismiss', 'event_espresso') |
|
227 | + . '</button></div>', |
|
228 | + ), |
|
229 | + 'DTT_OVERSELL_WARNING' => array( |
|
230 | + 'datetime_ticket' => esc_html__( |
|
231 | + 'You cannot add this ticket to this datetime because it has a sold amount that is greater than the amount of spots remaining for this datetime.', |
|
232 | + 'event_espresso' |
|
233 | + ), |
|
234 | + 'ticket_datetime' => esc_html__( |
|
235 | + 'You cannot add this datetime to this ticket because the ticket has a sold amount that is greater than the amount of spots remaining on the datetime.', |
|
236 | + 'event_espresso' |
|
237 | + ), |
|
238 | + ), |
|
239 | + 'DTT_CONVERTED_FORMATS' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats( |
|
240 | + $this->_date_format_strings['date'], |
|
241 | + $this->_date_format_strings['time'] |
|
242 | + ), |
|
243 | + 'DTT_START_OF_WEEK' => array('dayValue' => (int) get_option('start_of_week')), |
|
244 | + ), |
|
245 | + ), |
|
246 | + ); |
|
247 | + } |
|
248 | 248 | |
249 | 249 | |
250 | - /** |
|
251 | - * @param array $update_callbacks |
|
252 | - * @return array |
|
253 | - */ |
|
254 | - public function caf_updates(array $update_callbacks) |
|
255 | - { |
|
256 | - foreach ($update_callbacks as $key => $callback) { |
|
257 | - if ($callback[1] === '_default_tickets_update') { |
|
258 | - unset($update_callbacks[ $key ]); |
|
259 | - } |
|
260 | - } |
|
261 | - $update_callbacks[] = array($this, 'datetime_and_tickets_caf_update'); |
|
262 | - return $update_callbacks; |
|
263 | - } |
|
250 | + /** |
|
251 | + * @param array $update_callbacks |
|
252 | + * @return array |
|
253 | + */ |
|
254 | + public function caf_updates(array $update_callbacks) |
|
255 | + { |
|
256 | + foreach ($update_callbacks as $key => $callback) { |
|
257 | + if ($callback[1] === '_default_tickets_update') { |
|
258 | + unset($update_callbacks[ $key ]); |
|
259 | + } |
|
260 | + } |
|
261 | + $update_callbacks[] = array($this, 'datetime_and_tickets_caf_update'); |
|
262 | + return $update_callbacks; |
|
263 | + } |
|
264 | 264 | |
265 | 265 | |
266 | - /** |
|
267 | - * Handles saving everything related to Tickets (datetimes, tickets, prices) |
|
268 | - * |
|
269 | - * @param EE_Event $event The Event object we're attaching data to |
|
270 | - * @param array $data The request data from the form |
|
271 | - * @throws ReflectionException |
|
272 | - * @throws Exception |
|
273 | - * @throws InvalidInterfaceException |
|
274 | - * @throws InvalidDataTypeException |
|
275 | - * @throws EE_Error |
|
276 | - * @throws InvalidArgumentException |
|
277 | - */ |
|
278 | - public function datetime_and_tickets_caf_update($event, $data) |
|
279 | - { |
|
280 | - // first we need to start with datetimes cause they are the "root" items attached to events. |
|
281 | - $saved_datetimes = $this->_update_datetimes($event, $data); |
|
282 | - // next tackle the tickets (and prices?) |
|
283 | - $this->_update_tickets($event, $saved_datetimes, $data); |
|
284 | - } |
|
266 | + /** |
|
267 | + * Handles saving everything related to Tickets (datetimes, tickets, prices) |
|
268 | + * |
|
269 | + * @param EE_Event $event The Event object we're attaching data to |
|
270 | + * @param array $data The request data from the form |
|
271 | + * @throws ReflectionException |
|
272 | + * @throws Exception |
|
273 | + * @throws InvalidInterfaceException |
|
274 | + * @throws InvalidDataTypeException |
|
275 | + * @throws EE_Error |
|
276 | + * @throws InvalidArgumentException |
|
277 | + */ |
|
278 | + public function datetime_and_tickets_caf_update($event, $data) |
|
279 | + { |
|
280 | + // first we need to start with datetimes cause they are the "root" items attached to events. |
|
281 | + $saved_datetimes = $this->_update_datetimes($event, $data); |
|
282 | + // next tackle the tickets (and prices?) |
|
283 | + $this->_update_tickets($event, $saved_datetimes, $data); |
|
284 | + } |
|
285 | 285 | |
286 | 286 | |
287 | - /** |
|
288 | - * update event_datetimes |
|
289 | - * |
|
290 | - * @param EE_Event $event Event being updated |
|
291 | - * @param array $data the request data from the form |
|
292 | - * @return EE_Datetime[] |
|
293 | - * @throws Exception |
|
294 | - * @throws ReflectionException |
|
295 | - * @throws InvalidInterfaceException |
|
296 | - * @throws InvalidDataTypeException |
|
297 | - * @throws InvalidArgumentException |
|
298 | - * @throws EE_Error |
|
299 | - */ |
|
300 | - protected function _update_datetimes($event, $data) |
|
301 | - { |
|
302 | - $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
|
303 | - $saved_dtt_ids = array(); |
|
304 | - $saved_dtt_objs = array(); |
|
305 | - if (empty($data['edit_event_datetimes']) || ! is_array($data['edit_event_datetimes'])) { |
|
306 | - throw new InvalidArgumentException( |
|
307 | - esc_html__( |
|
308 | - 'The "edit_event_datetimes" array is invalid therefore the event can not be updated.', |
|
309 | - 'event_espresso' |
|
310 | - ) |
|
311 | - ); |
|
312 | - } |
|
313 | - foreach ($data['edit_event_datetimes'] as $row => $datetime_data) { |
|
314 | - // trim all values to ensure any excess whitespace is removed. |
|
315 | - $datetime_data = array_map( |
|
316 | - function ($datetime_data) { |
|
317 | - return is_array($datetime_data) ? $datetime_data : trim($datetime_data); |
|
318 | - }, |
|
319 | - $datetime_data |
|
320 | - ); |
|
321 | - $datetime_data['DTT_EVT_end'] = isset($datetime_data['DTT_EVT_end']) |
|
322 | - && ! empty($datetime_data['DTT_EVT_end']) |
|
323 | - ? $datetime_data['DTT_EVT_end'] |
|
324 | - : $datetime_data['DTT_EVT_start']; |
|
325 | - $datetime_values = array( |
|
326 | - 'DTT_ID' => ! empty($datetime_data['DTT_ID']) |
|
327 | - ? $datetime_data['DTT_ID'] |
|
328 | - : null, |
|
329 | - 'DTT_name' => ! empty($datetime_data['DTT_name']) |
|
330 | - ? $datetime_data['DTT_name'] |
|
331 | - : '', |
|
332 | - 'DTT_description' => ! empty($datetime_data['DTT_description']) |
|
333 | - ? $datetime_data['DTT_description'] |
|
334 | - : '', |
|
335 | - 'DTT_EVT_start' => $datetime_data['DTT_EVT_start'], |
|
336 | - 'DTT_EVT_end' => $datetime_data['DTT_EVT_end'], |
|
337 | - 'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) |
|
338 | - ? EE_INF |
|
339 | - : $datetime_data['DTT_reg_limit'], |
|
340 | - 'DTT_order' => ! isset($datetime_data['DTT_order']) |
|
341 | - ? $row |
|
342 | - : $datetime_data['DTT_order'], |
|
343 | - ); |
|
344 | - // if we have an id then let's get existing object first and then set the new values. |
|
345 | - // Otherwise we instantiate a new object for save. |
|
346 | - if (! empty($datetime_data['DTT_ID'])) { |
|
347 | - $datetime = EE_Registry::instance() |
|
348 | - ->load_model('Datetime', array($timezone)) |
|
349 | - ->get_one_by_ID($datetime_data['DTT_ID']); |
|
350 | - // set date and time format according to what is set in this class. |
|
351 | - $datetime->set_date_format($this->_date_format_strings['date']); |
|
352 | - $datetime->set_time_format($this->_date_format_strings['time']); |
|
353 | - foreach ($datetime_values as $field => $value) { |
|
354 | - $datetime->set($field, $value); |
|
355 | - } |
|
356 | - // make sure the $dtt_id here is saved just in case |
|
357 | - // after the add_relation_to() the autosave replaces it. |
|
358 | - // We need to do this so we dont' TRASH the parent DTT. |
|
359 | - // (save the ID for both key and value to avoid duplications) |
|
360 | - $saved_dtt_ids[ $datetime->ID() ] = $datetime->ID(); |
|
361 | - } else { |
|
362 | - $datetime = EE_Registry::instance()->load_class( |
|
363 | - 'Datetime', |
|
364 | - array( |
|
365 | - $datetime_values, |
|
366 | - $timezone, |
|
367 | - array($this->_date_format_strings['date'], $this->_date_format_strings['time']), |
|
368 | - ), |
|
369 | - false, |
|
370 | - false |
|
371 | - ); |
|
372 | - foreach ($datetime_values as $field => $value) { |
|
373 | - $datetime->set($field, $value); |
|
374 | - } |
|
375 | - } |
|
376 | - $datetime->save(); |
|
377 | - $datetime = $event->_add_relation_to($datetime, 'Datetime'); |
|
378 | - // before going any further make sure our dates are setup correctly |
|
379 | - // so that the end date is always equal or greater than the start date. |
|
380 | - if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) { |
|
381 | - $datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start')); |
|
382 | - $datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days'); |
|
383 | - $datetime->save(); |
|
384 | - } |
|
385 | - // now we have to make sure we add the new DTT_ID to the $saved_dtt_ids array |
|
386 | - // because it is possible there was a new one created for the autosave. |
|
387 | - // (save the ID for both key and value to avoid duplications) |
|
388 | - $DTT_ID = $datetime->ID(); |
|
389 | - $saved_dtt_ids[ $DTT_ID ] = $DTT_ID; |
|
390 | - $saved_dtt_objs[ $row ] = $datetime; |
|
391 | - // @todo if ANY of these updates fail then we want the appropriate global error message. |
|
392 | - } |
|
393 | - $event->save(); |
|
394 | - // now we need to REMOVE any datetimes that got deleted. |
|
395 | - // Keep in mind that this process will only kick in for datetimes that don't have any DTT_sold on them. |
|
396 | - // So its safe to permanently delete at this point. |
|
397 | - $old_datetimes = explode(',', $data['datetime_IDs']); |
|
398 | - $old_datetimes = $old_datetimes[0] === '' ? array() : $old_datetimes; |
|
399 | - if (is_array($old_datetimes)) { |
|
400 | - $datetimes_to_delete = array_diff($old_datetimes, $saved_dtt_ids); |
|
401 | - foreach ($datetimes_to_delete as $id) { |
|
402 | - $id = absint($id); |
|
403 | - if (empty($id)) { |
|
404 | - continue; |
|
405 | - } |
|
406 | - $dtt_to_remove = EE_Registry::instance()->load_model('Datetime')->get_one_by_ID($id); |
|
407 | - // remove tkt relationships. |
|
408 | - $related_tickets = $dtt_to_remove->get_many_related('Ticket'); |
|
409 | - foreach ($related_tickets as $tkt) { |
|
410 | - $dtt_to_remove->_remove_relation_to($tkt, 'Ticket'); |
|
411 | - } |
|
412 | - $event->_remove_relation_to($id, 'Datetime'); |
|
413 | - $dtt_to_remove->refresh_cache_of_related_objects(); |
|
414 | - } |
|
415 | - } |
|
416 | - return $saved_dtt_objs; |
|
417 | - } |
|
287 | + /** |
|
288 | + * update event_datetimes |
|
289 | + * |
|
290 | + * @param EE_Event $event Event being updated |
|
291 | + * @param array $data the request data from the form |
|
292 | + * @return EE_Datetime[] |
|
293 | + * @throws Exception |
|
294 | + * @throws ReflectionException |
|
295 | + * @throws InvalidInterfaceException |
|
296 | + * @throws InvalidDataTypeException |
|
297 | + * @throws InvalidArgumentException |
|
298 | + * @throws EE_Error |
|
299 | + */ |
|
300 | + protected function _update_datetimes($event, $data) |
|
301 | + { |
|
302 | + $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
|
303 | + $saved_dtt_ids = array(); |
|
304 | + $saved_dtt_objs = array(); |
|
305 | + if (empty($data['edit_event_datetimes']) || ! is_array($data['edit_event_datetimes'])) { |
|
306 | + throw new InvalidArgumentException( |
|
307 | + esc_html__( |
|
308 | + 'The "edit_event_datetimes" array is invalid therefore the event can not be updated.', |
|
309 | + 'event_espresso' |
|
310 | + ) |
|
311 | + ); |
|
312 | + } |
|
313 | + foreach ($data['edit_event_datetimes'] as $row => $datetime_data) { |
|
314 | + // trim all values to ensure any excess whitespace is removed. |
|
315 | + $datetime_data = array_map( |
|
316 | + function ($datetime_data) { |
|
317 | + return is_array($datetime_data) ? $datetime_data : trim($datetime_data); |
|
318 | + }, |
|
319 | + $datetime_data |
|
320 | + ); |
|
321 | + $datetime_data['DTT_EVT_end'] = isset($datetime_data['DTT_EVT_end']) |
|
322 | + && ! empty($datetime_data['DTT_EVT_end']) |
|
323 | + ? $datetime_data['DTT_EVT_end'] |
|
324 | + : $datetime_data['DTT_EVT_start']; |
|
325 | + $datetime_values = array( |
|
326 | + 'DTT_ID' => ! empty($datetime_data['DTT_ID']) |
|
327 | + ? $datetime_data['DTT_ID'] |
|
328 | + : null, |
|
329 | + 'DTT_name' => ! empty($datetime_data['DTT_name']) |
|
330 | + ? $datetime_data['DTT_name'] |
|
331 | + : '', |
|
332 | + 'DTT_description' => ! empty($datetime_data['DTT_description']) |
|
333 | + ? $datetime_data['DTT_description'] |
|
334 | + : '', |
|
335 | + 'DTT_EVT_start' => $datetime_data['DTT_EVT_start'], |
|
336 | + 'DTT_EVT_end' => $datetime_data['DTT_EVT_end'], |
|
337 | + 'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) |
|
338 | + ? EE_INF |
|
339 | + : $datetime_data['DTT_reg_limit'], |
|
340 | + 'DTT_order' => ! isset($datetime_data['DTT_order']) |
|
341 | + ? $row |
|
342 | + : $datetime_data['DTT_order'], |
|
343 | + ); |
|
344 | + // if we have an id then let's get existing object first and then set the new values. |
|
345 | + // Otherwise we instantiate a new object for save. |
|
346 | + if (! empty($datetime_data['DTT_ID'])) { |
|
347 | + $datetime = EE_Registry::instance() |
|
348 | + ->load_model('Datetime', array($timezone)) |
|
349 | + ->get_one_by_ID($datetime_data['DTT_ID']); |
|
350 | + // set date and time format according to what is set in this class. |
|
351 | + $datetime->set_date_format($this->_date_format_strings['date']); |
|
352 | + $datetime->set_time_format($this->_date_format_strings['time']); |
|
353 | + foreach ($datetime_values as $field => $value) { |
|
354 | + $datetime->set($field, $value); |
|
355 | + } |
|
356 | + // make sure the $dtt_id here is saved just in case |
|
357 | + // after the add_relation_to() the autosave replaces it. |
|
358 | + // We need to do this so we dont' TRASH the parent DTT. |
|
359 | + // (save the ID for both key and value to avoid duplications) |
|
360 | + $saved_dtt_ids[ $datetime->ID() ] = $datetime->ID(); |
|
361 | + } else { |
|
362 | + $datetime = EE_Registry::instance()->load_class( |
|
363 | + 'Datetime', |
|
364 | + array( |
|
365 | + $datetime_values, |
|
366 | + $timezone, |
|
367 | + array($this->_date_format_strings['date'], $this->_date_format_strings['time']), |
|
368 | + ), |
|
369 | + false, |
|
370 | + false |
|
371 | + ); |
|
372 | + foreach ($datetime_values as $field => $value) { |
|
373 | + $datetime->set($field, $value); |
|
374 | + } |
|
375 | + } |
|
376 | + $datetime->save(); |
|
377 | + $datetime = $event->_add_relation_to($datetime, 'Datetime'); |
|
378 | + // before going any further make sure our dates are setup correctly |
|
379 | + // so that the end date is always equal or greater than the start date. |
|
380 | + if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) { |
|
381 | + $datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start')); |
|
382 | + $datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days'); |
|
383 | + $datetime->save(); |
|
384 | + } |
|
385 | + // now we have to make sure we add the new DTT_ID to the $saved_dtt_ids array |
|
386 | + // because it is possible there was a new one created for the autosave. |
|
387 | + // (save the ID for both key and value to avoid duplications) |
|
388 | + $DTT_ID = $datetime->ID(); |
|
389 | + $saved_dtt_ids[ $DTT_ID ] = $DTT_ID; |
|
390 | + $saved_dtt_objs[ $row ] = $datetime; |
|
391 | + // @todo if ANY of these updates fail then we want the appropriate global error message. |
|
392 | + } |
|
393 | + $event->save(); |
|
394 | + // now we need to REMOVE any datetimes that got deleted. |
|
395 | + // Keep in mind that this process will only kick in for datetimes that don't have any DTT_sold on them. |
|
396 | + // So its safe to permanently delete at this point. |
|
397 | + $old_datetimes = explode(',', $data['datetime_IDs']); |
|
398 | + $old_datetimes = $old_datetimes[0] === '' ? array() : $old_datetimes; |
|
399 | + if (is_array($old_datetimes)) { |
|
400 | + $datetimes_to_delete = array_diff($old_datetimes, $saved_dtt_ids); |
|
401 | + foreach ($datetimes_to_delete as $id) { |
|
402 | + $id = absint($id); |
|
403 | + if (empty($id)) { |
|
404 | + continue; |
|
405 | + } |
|
406 | + $dtt_to_remove = EE_Registry::instance()->load_model('Datetime')->get_one_by_ID($id); |
|
407 | + // remove tkt relationships. |
|
408 | + $related_tickets = $dtt_to_remove->get_many_related('Ticket'); |
|
409 | + foreach ($related_tickets as $tkt) { |
|
410 | + $dtt_to_remove->_remove_relation_to($tkt, 'Ticket'); |
|
411 | + } |
|
412 | + $event->_remove_relation_to($id, 'Datetime'); |
|
413 | + $dtt_to_remove->refresh_cache_of_related_objects(); |
|
414 | + } |
|
415 | + } |
|
416 | + return $saved_dtt_objs; |
|
417 | + } |
|
418 | 418 | |
419 | 419 | |
420 | - /** |
|
421 | - * update tickets |
|
422 | - * |
|
423 | - * @param EE_Event $event Event object being updated |
|
424 | - * @param EE_Datetime[] $saved_datetimes an array of datetime ids being updated |
|
425 | - * @param array $data incoming request data |
|
426 | - * @return EE_Ticket[] |
|
427 | - * @throws Exception |
|
428 | - * @throws ReflectionException |
|
429 | - * @throws InvalidInterfaceException |
|
430 | - * @throws InvalidDataTypeException |
|
431 | - * @throws InvalidArgumentException |
|
432 | - * @throws EE_Error |
|
433 | - */ |
|
434 | - protected function _update_tickets($event, $saved_datetimes, $data) |
|
435 | - { |
|
436 | - $new_tkt = null; |
|
437 | - $new_default = null; |
|
438 | - // stripslashes because WP filtered the $_POST ($data) array to add slashes |
|
439 | - $data = stripslashes_deep($data); |
|
440 | - $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
|
441 | - $saved_tickets = $datetimes_on_existing = array(); |
|
442 | - $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array(); |
|
443 | - if (empty($data['edit_tickets']) || ! is_array($data['edit_tickets'])) { |
|
444 | - throw new InvalidArgumentException( |
|
445 | - esc_html__( |
|
446 | - 'The "edit_tickets" array is invalid therefore the event can not be updated.', |
|
447 | - 'event_espresso' |
|
448 | - ) |
|
449 | - ); |
|
450 | - } |
|
451 | - foreach ($data['edit_tickets'] as $row => $tkt) { |
|
452 | - $update_prices = $create_new_TKT = false; |
|
453 | - // figure out what datetimes were added to the ticket |
|
454 | - // and what datetimes were removed from the ticket in the session. |
|
455 | - $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][ $row ]); |
|
456 | - $tkt_dtt_rows = explode(',', $data['ticket_datetime_rows'][ $row ]); |
|
457 | - $datetimes_added = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows); |
|
458 | - $datetimes_removed = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows); |
|
459 | - // trim inputs to ensure any excess whitespace is removed. |
|
460 | - $tkt = array_map( |
|
461 | - function ($ticket_data) { |
|
462 | - return is_array($ticket_data) ? $ticket_data : trim($ticket_data); |
|
463 | - }, |
|
464 | - $tkt |
|
465 | - ); |
|
466 | - // note we are doing conversions to floats here instead of allowing EE_Money_Field to handle |
|
467 | - // because we're doing calculations prior to using the models. |
|
468 | - // note incoming ['TKT_price'] value is already in standard notation (via js). |
|
469 | - $ticket_price = isset($tkt['TKT_price']) |
|
470 | - ? round((float) $tkt['TKT_price'], 3) |
|
471 | - : 0; |
|
472 | - // note incoming base price needs converted from localized value. |
|
473 | - $base_price = isset($tkt['TKT_base_price']) |
|
474 | - ? EEH_Money::convert_to_float_from_localized_money($tkt['TKT_base_price']) |
|
475 | - : 0; |
|
476 | - // if ticket price == 0 and $base_price != 0 then ticket price == base_price |
|
477 | - $ticket_price = $ticket_price === 0 && $base_price !== 0 |
|
478 | - ? $base_price |
|
479 | - : $ticket_price; |
|
480 | - $base_price_id = isset($tkt['TKT_base_price_ID']) |
|
481 | - ? $tkt['TKT_base_price_ID'] |
|
482 | - : 0; |
|
483 | - $price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][ $row ]) |
|
484 | - ? $data['edit_prices'][ $row ] |
|
485 | - : array(); |
|
486 | - $now = null; |
|
487 | - if (empty($tkt['TKT_start_date'])) { |
|
488 | - // lets' use now in the set timezone. |
|
489 | - $now = new DateTime('now', new DateTimeZone($event->get_timezone())); |
|
490 | - $tkt['TKT_start_date'] = $now->format($this->_date_time_format); |
|
491 | - } |
|
492 | - if (empty($tkt['TKT_end_date'])) { |
|
493 | - /** |
|
494 | - * set the TKT_end_date to the first datetime attached to the ticket. |
|
495 | - */ |
|
496 | - $first_dtt = $saved_datetimes[ reset($tkt_dtt_rows) ]; |
|
497 | - $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_time_format); |
|
498 | - } |
|
499 | - $TKT_values = array( |
|
500 | - 'TKT_ID' => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null, |
|
501 | - 'TTM_ID' => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0, |
|
502 | - 'TKT_name' => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '', |
|
503 | - 'TKT_description' => ! empty($tkt['TKT_description']) |
|
504 | - && $tkt['TKT_description'] !== esc_html__( |
|
505 | - 'You can modify this description', |
|
506 | - 'event_espresso' |
|
507 | - ) |
|
508 | - ? $tkt['TKT_description'] |
|
509 | - : '', |
|
510 | - 'TKT_start_date' => $tkt['TKT_start_date'], |
|
511 | - 'TKT_end_date' => $tkt['TKT_end_date'], |
|
512 | - 'TKT_qty' => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' |
|
513 | - ? EE_INF |
|
514 | - : $tkt['TKT_qty'], |
|
515 | - 'TKT_uses' => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' |
|
516 | - ? EE_INF |
|
517 | - : $tkt['TKT_uses'], |
|
518 | - 'TKT_min' => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'], |
|
519 | - 'TKT_max' => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'], |
|
520 | - 'TKT_row' => $row, |
|
521 | - 'TKT_order' => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : 0, |
|
522 | - 'TKT_taxable' => ! empty($tkt['TKT_taxable']) ? 1 : 0, |
|
523 | - 'TKT_required' => ! empty($tkt['TKT_required']) ? 1 : 0, |
|
524 | - 'TKT_price' => $ticket_price, |
|
525 | - ); |
|
526 | - // if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, |
|
527 | - // which means in turn that the prices will become new prices as well. |
|
528 | - if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) { |
|
529 | - $TKT_values['TKT_ID'] = 0; |
|
530 | - $TKT_values['TKT_is_default'] = 0; |
|
531 | - $update_prices = true; |
|
532 | - } |
|
533 | - // if we have a TKT_ID then we need to get that existing TKT_obj and update it |
|
534 | - // we actually do our saves ahead of doing any add_relations to |
|
535 | - // because its entirely possible that this ticket wasn't removed or added to any datetime in the session |
|
536 | - // but DID have it's items modified. |
|
537 | - // keep in mind that if the TKT has been sold (and we have changed pricing information), |
|
538 | - // then we won't be updating the tkt but instead a new tkt will be created and the old one archived. |
|
539 | - if (absint($TKT_values['TKT_ID'])) { |
|
540 | - $ticket = EE_Registry::instance() |
|
541 | - ->load_model('Ticket', array($timezone)) |
|
542 | - ->get_one_by_ID($tkt['TKT_ID']); |
|
543 | - if ($ticket instanceof EE_Ticket) { |
|
544 | - $ticket = $this->_update_ticket_datetimes( |
|
545 | - $ticket, |
|
546 | - $saved_datetimes, |
|
547 | - $datetimes_added, |
|
548 | - $datetimes_removed |
|
549 | - ); |
|
550 | - // are there any registrations using this ticket ? |
|
551 | - $tickets_sold = $ticket->count_related( |
|
552 | - 'Registration', |
|
553 | - array( |
|
554 | - array( |
|
555 | - 'STS_ID' => array('NOT IN', array(EEM_Registration::status_id_incomplete)), |
|
556 | - ), |
|
557 | - ) |
|
558 | - ); |
|
559 | - // set ticket formats |
|
560 | - $ticket->set_date_format($this->_date_format_strings['date']); |
|
561 | - $ticket->set_time_format($this->_date_format_strings['time']); |
|
562 | - // let's just check the total price for the existing ticket |
|
563 | - // and determine if it matches the new total price. |
|
564 | - // if they are different then we create a new ticket (if tickets sold) |
|
565 | - // if they aren't different then we go ahead and modify existing ticket. |
|
566 | - $create_new_TKT = $tickets_sold > 0 && $ticket_price !== $ticket->price() && ! $ticket->deleted(); |
|
567 | - // set new values |
|
568 | - foreach ($TKT_values as $field => $value) { |
|
569 | - if ($field === 'TKT_qty') { |
|
570 | - $ticket->set_qty($value); |
|
571 | - } else { |
|
572 | - $ticket->set($field, $value); |
|
573 | - } |
|
574 | - } |
|
575 | - // if $create_new_TKT is false then we can safely update the existing ticket. |
|
576 | - // Otherwise we have to create a new ticket. |
|
577 | - if ($create_new_TKT) { |
|
578 | - $new_tkt = $this->_duplicate_ticket( |
|
579 | - $ticket, |
|
580 | - $price_rows, |
|
581 | - $ticket_price, |
|
582 | - $base_price, |
|
583 | - $base_price_id |
|
584 | - ); |
|
585 | - } |
|
586 | - } |
|
587 | - } else { |
|
588 | - // no TKT_id so a new TKT |
|
589 | - $ticket = EE_Ticket::new_instance( |
|
590 | - $TKT_values, |
|
591 | - $timezone, |
|
592 | - array($this->_date_format_strings['date'], $this->_date_format_strings['time']) |
|
593 | - ); |
|
594 | - if ($ticket instanceof EE_Ticket) { |
|
595 | - // make sure ticket has an ID of setting relations won't work |
|
596 | - $ticket->save(); |
|
597 | - $ticket = $this->_update_ticket_datetimes( |
|
598 | - $ticket, |
|
599 | - $saved_datetimes, |
|
600 | - $datetimes_added, |
|
601 | - $datetimes_removed |
|
602 | - ); |
|
603 | - $update_prices = true; |
|
604 | - } |
|
605 | - } |
|
606 | - // make sure any current values have been saved. |
|
607 | - // $ticket->save(); |
|
608 | - // before going any further make sure our dates are setup correctly |
|
609 | - // so that the end date is always equal or greater than the start date. |
|
610 | - if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) { |
|
611 | - $ticket->set('TKT_end_date', $ticket->get('TKT_start_date')); |
|
612 | - $ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days'); |
|
613 | - } |
|
614 | - // let's make sure the base price is handled |
|
615 | - $ticket = ! $create_new_TKT |
|
616 | - ? $this->_add_prices_to_ticket( |
|
617 | - array(), |
|
618 | - $ticket, |
|
619 | - $update_prices, |
|
620 | - $base_price, |
|
621 | - $base_price_id |
|
622 | - ) |
|
623 | - : $ticket; |
|
624 | - // add/update price_modifiers |
|
625 | - $ticket = ! $create_new_TKT |
|
626 | - ? $this->_add_prices_to_ticket($price_rows, $ticket, $update_prices) |
|
627 | - : $ticket; |
|
628 | - // need to make sue that the TKT_price is accurate after saving the prices. |
|
629 | - $ticket->ensure_TKT_Price_correct(); |
|
630 | - // handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave. |
|
631 | - if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) { |
|
632 | - $update_prices = true; |
|
633 | - $new_default = clone $ticket; |
|
634 | - $new_default->set('TKT_ID', 0); |
|
635 | - $new_default->set('TKT_is_default', 1); |
|
636 | - $new_default->set('TKT_row', 1); |
|
637 | - $new_default->set('TKT_price', $ticket_price); |
|
638 | - // remove any dtt relations cause we DON'T want dtt relations attached |
|
639 | - // (note this is just removing the cached relations in the object) |
|
640 | - $new_default->_remove_relations('Datetime'); |
|
641 | - // @todo we need to add the current attached prices as new prices to the new default ticket. |
|
642 | - $new_default = $this->_add_prices_to_ticket( |
|
643 | - $price_rows, |
|
644 | - $new_default, |
|
645 | - $update_prices |
|
646 | - ); |
|
647 | - // don't forget the base price! |
|
648 | - $new_default = $this->_add_prices_to_ticket( |
|
649 | - array(), |
|
650 | - $new_default, |
|
651 | - $update_prices, |
|
652 | - $base_price, |
|
653 | - $base_price_id |
|
654 | - ); |
|
655 | - $new_default->save(); |
|
656 | - do_action( |
|
657 | - 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_default_ticket', |
|
658 | - $new_default, |
|
659 | - $row, |
|
660 | - $ticket, |
|
661 | - $data |
|
662 | - ); |
|
663 | - } |
|
664 | - // DO ALL dtt relationships for both current tickets and any archived tickets |
|
665 | - // for the given dtt that are related to the current ticket. |
|
666 | - // TODO... not sure exactly how we're going to do this considering we don't know |
|
667 | - // what current ticket the archived tickets are related to |
|
668 | - // (and TKT_parent is used for autosaves so that's not a field we can reliably use). |
|
669 | - // let's assign any tickets that have been setup to the saved_tickets tracker |
|
670 | - // save existing TKT |
|
671 | - $ticket->save(); |
|
672 | - if ($create_new_TKT && $new_tkt instanceof EE_Ticket) { |
|
673 | - // save new TKT |
|
674 | - $new_tkt->save(); |
|
675 | - // add new ticket to array |
|
676 | - $saved_tickets[ $new_tkt->ID() ] = $new_tkt; |
|
677 | - do_action( |
|
678 | - 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket', |
|
679 | - $new_tkt, |
|
680 | - $row, |
|
681 | - $tkt, |
|
682 | - $data |
|
683 | - ); |
|
684 | - } else { |
|
685 | - // add tkt to saved tkts |
|
686 | - $saved_tickets[ $ticket->ID() ] = $ticket; |
|
687 | - do_action( |
|
688 | - 'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket', |
|
689 | - $ticket, |
|
690 | - $row, |
|
691 | - $tkt, |
|
692 | - $data |
|
693 | - ); |
|
694 | - } |
|
695 | - } |
|
696 | - // now we need to handle tickets actually "deleted permanently". |
|
697 | - // There are cases where we'd want this to happen |
|
698 | - // (i.e. autosaves are happening and then in between autosaves the user trashes a ticket). |
|
699 | - // Or a draft event was saved and in the process of editing a ticket is trashed. |
|
700 | - // No sense in keeping all the related data in the db! |
|
701 | - $old_tickets = isset($old_tickets[0]) && $old_tickets[0] === '' ? array() : $old_tickets; |
|
702 | - $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets)); |
|
703 | - foreach ($tickets_removed as $id) { |
|
704 | - $id = absint($id); |
|
705 | - // get the ticket for this id |
|
706 | - $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id); |
|
707 | - // if this tkt is a default tkt we leave it alone cause it won't be attached to the datetime |
|
708 | - if ($tkt_to_remove->get('TKT_is_default')) { |
|
709 | - continue; |
|
710 | - } |
|
711 | - // if this tkt has any registrations attached so then we just ARCHIVE |
|
712 | - // because we don't actually permanently delete these tickets. |
|
713 | - if ($tkt_to_remove->count_related('Registration') > 0) { |
|
714 | - $tkt_to_remove->delete(); |
|
715 | - continue; |
|
716 | - } |
|
717 | - // need to get all the related datetimes on this ticket and remove from every single one of them |
|
718 | - // (remember this process can ONLY kick off if there are NO tkts_sold) |
|
719 | - $datetimes = $tkt_to_remove->get_many_related('Datetime'); |
|
720 | - foreach ($datetimes as $datetime) { |
|
721 | - $tkt_to_remove->_remove_relation_to($datetime, 'Datetime'); |
|
722 | - } |
|
723 | - // need to do the same for prices (except these prices can also be deleted because again, |
|
724 | - // tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived)) |
|
725 | - $tkt_to_remove->delete_related_permanently('Price'); |
|
726 | - do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_delete_ticket', $tkt_to_remove); |
|
727 | - // finally let's delete this ticket |
|
728 | - // (which should not be blocked at this point b/c we've removed all our relationships) |
|
729 | - $tkt_to_remove->delete_permanently(); |
|
730 | - } |
|
731 | - return $saved_tickets; |
|
732 | - } |
|
420 | + /** |
|
421 | + * update tickets |
|
422 | + * |
|
423 | + * @param EE_Event $event Event object being updated |
|
424 | + * @param EE_Datetime[] $saved_datetimes an array of datetime ids being updated |
|
425 | + * @param array $data incoming request data |
|
426 | + * @return EE_Ticket[] |
|
427 | + * @throws Exception |
|
428 | + * @throws ReflectionException |
|
429 | + * @throws InvalidInterfaceException |
|
430 | + * @throws InvalidDataTypeException |
|
431 | + * @throws InvalidArgumentException |
|
432 | + * @throws EE_Error |
|
433 | + */ |
|
434 | + protected function _update_tickets($event, $saved_datetimes, $data) |
|
435 | + { |
|
436 | + $new_tkt = null; |
|
437 | + $new_default = null; |
|
438 | + // stripslashes because WP filtered the $_POST ($data) array to add slashes |
|
439 | + $data = stripslashes_deep($data); |
|
440 | + $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
|
441 | + $saved_tickets = $datetimes_on_existing = array(); |
|
442 | + $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array(); |
|
443 | + if (empty($data['edit_tickets']) || ! is_array($data['edit_tickets'])) { |
|
444 | + throw new InvalidArgumentException( |
|
445 | + esc_html__( |
|
446 | + 'The "edit_tickets" array is invalid therefore the event can not be updated.', |
|
447 | + 'event_espresso' |
|
448 | + ) |
|
449 | + ); |
|
450 | + } |
|
451 | + foreach ($data['edit_tickets'] as $row => $tkt) { |
|
452 | + $update_prices = $create_new_TKT = false; |
|
453 | + // figure out what datetimes were added to the ticket |
|
454 | + // and what datetimes were removed from the ticket in the session. |
|
455 | + $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][ $row ]); |
|
456 | + $tkt_dtt_rows = explode(',', $data['ticket_datetime_rows'][ $row ]); |
|
457 | + $datetimes_added = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows); |
|
458 | + $datetimes_removed = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows); |
|
459 | + // trim inputs to ensure any excess whitespace is removed. |
|
460 | + $tkt = array_map( |
|
461 | + function ($ticket_data) { |
|
462 | + return is_array($ticket_data) ? $ticket_data : trim($ticket_data); |
|
463 | + }, |
|
464 | + $tkt |
|
465 | + ); |
|
466 | + // note we are doing conversions to floats here instead of allowing EE_Money_Field to handle |
|
467 | + // because we're doing calculations prior to using the models. |
|
468 | + // note incoming ['TKT_price'] value is already in standard notation (via js). |
|
469 | + $ticket_price = isset($tkt['TKT_price']) |
|
470 | + ? round((float) $tkt['TKT_price'], 3) |
|
471 | + : 0; |
|
472 | + // note incoming base price needs converted from localized value. |
|
473 | + $base_price = isset($tkt['TKT_base_price']) |
|
474 | + ? EEH_Money::convert_to_float_from_localized_money($tkt['TKT_base_price']) |
|
475 | + : 0; |
|
476 | + // if ticket price == 0 and $base_price != 0 then ticket price == base_price |
|
477 | + $ticket_price = $ticket_price === 0 && $base_price !== 0 |
|
478 | + ? $base_price |
|
479 | + : $ticket_price; |
|
480 | + $base_price_id = isset($tkt['TKT_base_price_ID']) |
|
481 | + ? $tkt['TKT_base_price_ID'] |
|
482 | + : 0; |
|
483 | + $price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][ $row ]) |
|
484 | + ? $data['edit_prices'][ $row ] |
|
485 | + : array(); |
|
486 | + $now = null; |
|
487 | + if (empty($tkt['TKT_start_date'])) { |
|
488 | + // lets' use now in the set timezone. |
|
489 | + $now = new DateTime('now', new DateTimeZone($event->get_timezone())); |
|
490 | + $tkt['TKT_start_date'] = $now->format($this->_date_time_format); |
|
491 | + } |
|
492 | + if (empty($tkt['TKT_end_date'])) { |
|
493 | + /** |
|
494 | + * set the TKT_end_date to the first datetime attached to the ticket. |
|
495 | + */ |
|
496 | + $first_dtt = $saved_datetimes[ reset($tkt_dtt_rows) ]; |
|
497 | + $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_time_format); |
|
498 | + } |
|
499 | + $TKT_values = array( |
|
500 | + 'TKT_ID' => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null, |
|
501 | + 'TTM_ID' => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0, |
|
502 | + 'TKT_name' => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '', |
|
503 | + 'TKT_description' => ! empty($tkt['TKT_description']) |
|
504 | + && $tkt['TKT_description'] !== esc_html__( |
|
505 | + 'You can modify this description', |
|
506 | + 'event_espresso' |
|
507 | + ) |
|
508 | + ? $tkt['TKT_description'] |
|
509 | + : '', |
|
510 | + 'TKT_start_date' => $tkt['TKT_start_date'], |
|
511 | + 'TKT_end_date' => $tkt['TKT_end_date'], |
|
512 | + 'TKT_qty' => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' |
|
513 | + ? EE_INF |
|
514 | + : $tkt['TKT_qty'], |
|
515 | + 'TKT_uses' => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' |
|
516 | + ? EE_INF |
|
517 | + : $tkt['TKT_uses'], |
|
518 | + 'TKT_min' => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'], |
|
519 | + 'TKT_max' => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'], |
|
520 | + 'TKT_row' => $row, |
|
521 | + 'TKT_order' => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : 0, |
|
522 | + 'TKT_taxable' => ! empty($tkt['TKT_taxable']) ? 1 : 0, |
|
523 | + 'TKT_required' => ! empty($tkt['TKT_required']) ? 1 : 0, |
|
524 | + 'TKT_price' => $ticket_price, |
|
525 | + ); |
|
526 | + // if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, |
|
527 | + // which means in turn that the prices will become new prices as well. |
|
528 | + if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) { |
|
529 | + $TKT_values['TKT_ID'] = 0; |
|
530 | + $TKT_values['TKT_is_default'] = 0; |
|
531 | + $update_prices = true; |
|
532 | + } |
|
533 | + // if we have a TKT_ID then we need to get that existing TKT_obj and update it |
|
534 | + // we actually do our saves ahead of doing any add_relations to |
|
535 | + // because its entirely possible that this ticket wasn't removed or added to any datetime in the session |
|
536 | + // but DID have it's items modified. |
|
537 | + // keep in mind that if the TKT has been sold (and we have changed pricing information), |
|
538 | + // then we won't be updating the tkt but instead a new tkt will be created and the old one archived. |
|
539 | + if (absint($TKT_values['TKT_ID'])) { |
|
540 | + $ticket = EE_Registry::instance() |
|
541 | + ->load_model('Ticket', array($timezone)) |
|
542 | + ->get_one_by_ID($tkt['TKT_ID']); |
|
543 | + if ($ticket instanceof EE_Ticket) { |
|
544 | + $ticket = $this->_update_ticket_datetimes( |
|
545 | + $ticket, |
|
546 | + $saved_datetimes, |
|
547 | + $datetimes_added, |
|
548 | + $datetimes_removed |
|
549 | + ); |
|
550 | + // are there any registrations using this ticket ? |
|
551 | + $tickets_sold = $ticket->count_related( |
|
552 | + 'Registration', |
|
553 | + array( |
|
554 | + array( |
|
555 | + 'STS_ID' => array('NOT IN', array(EEM_Registration::status_id_incomplete)), |
|
556 | + ), |
|
557 | + ) |
|
558 | + ); |
|
559 | + // set ticket formats |
|
560 | + $ticket->set_date_format($this->_date_format_strings['date']); |
|
561 | + $ticket->set_time_format($this->_date_format_strings['time']); |
|
562 | + // let's just check the total price for the existing ticket |
|
563 | + // and determine if it matches the new total price. |
|
564 | + // if they are different then we create a new ticket (if tickets sold) |
|
565 | + // if they aren't different then we go ahead and modify existing ticket. |
|
566 | + $create_new_TKT = $tickets_sold > 0 && $ticket_price !== $ticket->price() && ! $ticket->deleted(); |
|
567 | + // set new values |
|
568 | + foreach ($TKT_values as $field => $value) { |
|
569 | + if ($field === 'TKT_qty') { |
|
570 | + $ticket->set_qty($value); |
|
571 | + } else { |
|
572 | + $ticket->set($field, $value); |
|
573 | + } |
|
574 | + } |
|
575 | + // if $create_new_TKT is false then we can safely update the existing ticket. |
|
576 | + // Otherwise we have to create a new ticket. |
|
577 | + if ($create_new_TKT) { |
|
578 | + $new_tkt = $this->_duplicate_ticket( |
|
579 | + $ticket, |
|
580 | + $price_rows, |
|
581 | + $ticket_price, |
|
582 | + $base_price, |
|
583 | + $base_price_id |
|
584 | + ); |
|
585 | + } |
|
586 | + } |
|
587 | + } else { |
|
588 | + // no TKT_id so a new TKT |
|
589 | + $ticket = EE_Ticket::new_instance( |
|
590 | + $TKT_values, |
|
591 | + $timezone, |
|
592 | + array($this->_date_format_strings['date'], $this->_date_format_strings['time']) |
|
593 | + ); |
|
594 | + if ($ticket instanceof EE_Ticket) { |
|
595 | + // make sure ticket has an ID of setting relations won't work |
|
596 | + $ticket->save(); |
|
597 | + $ticket = $this->_update_ticket_datetimes( |
|
598 | + $ticket, |
|
599 | + $saved_datetimes, |
|
600 | + $datetimes_added, |
|
601 | + $datetimes_removed |
|
602 | + ); |
|
603 | + $update_prices = true; |
|
604 | + } |
|
605 | + } |
|
606 | + // make sure any current values have been saved. |
|
607 | + // $ticket->save(); |
|
608 | + // before going any further make sure our dates are setup correctly |
|
609 | + // so that the end date is always equal or greater than the start date. |
|
610 | + if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) { |
|
611 | + $ticket->set('TKT_end_date', $ticket->get('TKT_start_date')); |
|
612 | + $ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days'); |
|
613 | + } |
|
614 | + // let's make sure the base price is handled |
|
615 | + $ticket = ! $create_new_TKT |
|
616 | + ? $this->_add_prices_to_ticket( |
|
617 | + array(), |
|
618 | + $ticket, |
|
619 | + $update_prices, |
|
620 | + $base_price, |
|
621 | + $base_price_id |
|
622 | + ) |
|
623 | + : $ticket; |
|
624 | + // add/update price_modifiers |
|
625 | + $ticket = ! $create_new_TKT |
|
626 | + ? $this->_add_prices_to_ticket($price_rows, $ticket, $update_prices) |
|
627 | + : $ticket; |
|
628 | + // need to make sue that the TKT_price is accurate after saving the prices. |
|
629 | + $ticket->ensure_TKT_Price_correct(); |
|
630 | + // handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave. |
|
631 | + if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) { |
|
632 | + $update_prices = true; |
|
633 | + $new_default = clone $ticket; |
|
634 | + $new_default->set('TKT_ID', 0); |
|
635 | + $new_default->set('TKT_is_default', 1); |
|
636 | + $new_default->set('TKT_row', 1); |
|
637 | + $new_default->set('TKT_price', $ticket_price); |
|
638 | + // remove any dtt relations cause we DON'T want dtt relations attached |
|
639 | + // (note this is just removing the cached relations in the object) |
|
640 | + $new_default->_remove_relations('Datetime'); |
|
641 | + // @todo we need to add the current attached prices as new prices to the new default ticket. |
|
642 | + $new_default = $this->_add_prices_to_ticket( |
|
643 | + $price_rows, |
|
644 | + $new_default, |
|
645 | + $update_prices |
|
646 | + ); |
|
647 | + // don't forget the base price! |
|
648 | + $new_default = $this->_add_prices_to_ticket( |
|
649 | + array(), |
|
650 | + $new_default, |
|
651 | + $update_prices, |
|
652 | + $base_price, |
|
653 | + $base_price_id |
|
654 | + ); |
|
655 | + $new_default->save(); |
|
656 | + do_action( |
|
657 | + 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_default_ticket', |
|
658 | + $new_default, |
|
659 | + $row, |
|
660 | + $ticket, |
|
661 | + $data |
|
662 | + ); |
|
663 | + } |
|
664 | + // DO ALL dtt relationships for both current tickets and any archived tickets |
|
665 | + // for the given dtt that are related to the current ticket. |
|
666 | + // TODO... not sure exactly how we're going to do this considering we don't know |
|
667 | + // what current ticket the archived tickets are related to |
|
668 | + // (and TKT_parent is used for autosaves so that's not a field we can reliably use). |
|
669 | + // let's assign any tickets that have been setup to the saved_tickets tracker |
|
670 | + // save existing TKT |
|
671 | + $ticket->save(); |
|
672 | + if ($create_new_TKT && $new_tkt instanceof EE_Ticket) { |
|
673 | + // save new TKT |
|
674 | + $new_tkt->save(); |
|
675 | + // add new ticket to array |
|
676 | + $saved_tickets[ $new_tkt->ID() ] = $new_tkt; |
|
677 | + do_action( |
|
678 | + 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket', |
|
679 | + $new_tkt, |
|
680 | + $row, |
|
681 | + $tkt, |
|
682 | + $data |
|
683 | + ); |
|
684 | + } else { |
|
685 | + // add tkt to saved tkts |
|
686 | + $saved_tickets[ $ticket->ID() ] = $ticket; |
|
687 | + do_action( |
|
688 | + 'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket', |
|
689 | + $ticket, |
|
690 | + $row, |
|
691 | + $tkt, |
|
692 | + $data |
|
693 | + ); |
|
694 | + } |
|
695 | + } |
|
696 | + // now we need to handle tickets actually "deleted permanently". |
|
697 | + // There are cases where we'd want this to happen |
|
698 | + // (i.e. autosaves are happening and then in between autosaves the user trashes a ticket). |
|
699 | + // Or a draft event was saved and in the process of editing a ticket is trashed. |
|
700 | + // No sense in keeping all the related data in the db! |
|
701 | + $old_tickets = isset($old_tickets[0]) && $old_tickets[0] === '' ? array() : $old_tickets; |
|
702 | + $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets)); |
|
703 | + foreach ($tickets_removed as $id) { |
|
704 | + $id = absint($id); |
|
705 | + // get the ticket for this id |
|
706 | + $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id); |
|
707 | + // if this tkt is a default tkt we leave it alone cause it won't be attached to the datetime |
|
708 | + if ($tkt_to_remove->get('TKT_is_default')) { |
|
709 | + continue; |
|
710 | + } |
|
711 | + // if this tkt has any registrations attached so then we just ARCHIVE |
|
712 | + // because we don't actually permanently delete these tickets. |
|
713 | + if ($tkt_to_remove->count_related('Registration') > 0) { |
|
714 | + $tkt_to_remove->delete(); |
|
715 | + continue; |
|
716 | + } |
|
717 | + // need to get all the related datetimes on this ticket and remove from every single one of them |
|
718 | + // (remember this process can ONLY kick off if there are NO tkts_sold) |
|
719 | + $datetimes = $tkt_to_remove->get_many_related('Datetime'); |
|
720 | + foreach ($datetimes as $datetime) { |
|
721 | + $tkt_to_remove->_remove_relation_to($datetime, 'Datetime'); |
|
722 | + } |
|
723 | + // need to do the same for prices (except these prices can also be deleted because again, |
|
724 | + // tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived)) |
|
725 | + $tkt_to_remove->delete_related_permanently('Price'); |
|
726 | + do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_delete_ticket', $tkt_to_remove); |
|
727 | + // finally let's delete this ticket |
|
728 | + // (which should not be blocked at this point b/c we've removed all our relationships) |
|
729 | + $tkt_to_remove->delete_permanently(); |
|
730 | + } |
|
731 | + return $saved_tickets; |
|
732 | + } |
|
733 | 733 | |
734 | 734 | |
735 | - /** |
|
736 | - * @access protected |
|
737 | - * @param EE_Ticket $ticket |
|
738 | - * @param \EE_Datetime[] $saved_datetimes |
|
739 | - * @param \EE_Datetime[] $added_datetimes |
|
740 | - * @param \EE_Datetime[] $removed_datetimes |
|
741 | - * @return EE_Ticket |
|
742 | - * @throws EE_Error |
|
743 | - */ |
|
744 | - protected function _update_ticket_datetimes( |
|
745 | - EE_Ticket $ticket, |
|
746 | - $saved_datetimes = array(), |
|
747 | - $added_datetimes = array(), |
|
748 | - $removed_datetimes = array() |
|
749 | - ) { |
|
750 | - // to start we have to add the ticket to all the datetimes its supposed to be with, |
|
751 | - // and removing the ticket from datetimes it got removed from. |
|
752 | - // first let's add datetimes |
|
753 | - if (! empty($added_datetimes) && is_array($added_datetimes)) { |
|
754 | - foreach ($added_datetimes as $row_id) { |
|
755 | - $row_id = (int) $row_id; |
|
756 | - if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
757 | - $ticket->_add_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
758 | - // Is this an existing ticket (has an ID) and does it have any sold? |
|
759 | - // If so, then we need to add that to the DTT sold because this DTT is getting added. |
|
760 | - if ($ticket->ID() && $ticket->sold() > 0) { |
|
761 | - $saved_datetimes[ $row_id ]->increase_sold($ticket->sold()); |
|
762 | - $saved_datetimes[ $row_id ]->save(); |
|
763 | - } |
|
764 | - } |
|
765 | - } |
|
766 | - } |
|
767 | - // then remove datetimes |
|
768 | - if (! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
769 | - foreach ($removed_datetimes as $row_id) { |
|
770 | - $row_id = (int) $row_id; |
|
771 | - // its entirely possible that a datetime got deleted (instead of just removed from relationship. |
|
772 | - // So make sure we skip over this if the dtt isn't in the $saved_datetimes array) |
|
773 | - if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
774 | - $ticket->_remove_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
775 | - // Is this an existing ticket (has an ID) and does it have any sold? |
|
776 | - // If so, then we need to remove it's sold from the DTT_sold. |
|
777 | - if ($ticket->ID() && $ticket->sold() > 0) { |
|
778 | - $saved_datetimes[ $row_id ]->decrease_sold($ticket->sold()); |
|
779 | - $saved_datetimes[ $row_id ]->save(); |
|
780 | - } |
|
781 | - } |
|
782 | - } |
|
783 | - } |
|
784 | - // cap ticket qty by datetime reg limits |
|
785 | - $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit'))); |
|
786 | - return $ticket; |
|
787 | - } |
|
735 | + /** |
|
736 | + * @access protected |
|
737 | + * @param EE_Ticket $ticket |
|
738 | + * @param \EE_Datetime[] $saved_datetimes |
|
739 | + * @param \EE_Datetime[] $added_datetimes |
|
740 | + * @param \EE_Datetime[] $removed_datetimes |
|
741 | + * @return EE_Ticket |
|
742 | + * @throws EE_Error |
|
743 | + */ |
|
744 | + protected function _update_ticket_datetimes( |
|
745 | + EE_Ticket $ticket, |
|
746 | + $saved_datetimes = array(), |
|
747 | + $added_datetimes = array(), |
|
748 | + $removed_datetimes = array() |
|
749 | + ) { |
|
750 | + // to start we have to add the ticket to all the datetimes its supposed to be with, |
|
751 | + // and removing the ticket from datetimes it got removed from. |
|
752 | + // first let's add datetimes |
|
753 | + if (! empty($added_datetimes) && is_array($added_datetimes)) { |
|
754 | + foreach ($added_datetimes as $row_id) { |
|
755 | + $row_id = (int) $row_id; |
|
756 | + if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
757 | + $ticket->_add_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
758 | + // Is this an existing ticket (has an ID) and does it have any sold? |
|
759 | + // If so, then we need to add that to the DTT sold because this DTT is getting added. |
|
760 | + if ($ticket->ID() && $ticket->sold() > 0) { |
|
761 | + $saved_datetimes[ $row_id ]->increase_sold($ticket->sold()); |
|
762 | + $saved_datetimes[ $row_id ]->save(); |
|
763 | + } |
|
764 | + } |
|
765 | + } |
|
766 | + } |
|
767 | + // then remove datetimes |
|
768 | + if (! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
769 | + foreach ($removed_datetimes as $row_id) { |
|
770 | + $row_id = (int) $row_id; |
|
771 | + // its entirely possible that a datetime got deleted (instead of just removed from relationship. |
|
772 | + // So make sure we skip over this if the dtt isn't in the $saved_datetimes array) |
|
773 | + if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
774 | + $ticket->_remove_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
775 | + // Is this an existing ticket (has an ID) and does it have any sold? |
|
776 | + // If so, then we need to remove it's sold from the DTT_sold. |
|
777 | + if ($ticket->ID() && $ticket->sold() > 0) { |
|
778 | + $saved_datetimes[ $row_id ]->decrease_sold($ticket->sold()); |
|
779 | + $saved_datetimes[ $row_id ]->save(); |
|
780 | + } |
|
781 | + } |
|
782 | + } |
|
783 | + } |
|
784 | + // cap ticket qty by datetime reg limits |
|
785 | + $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit'))); |
|
786 | + return $ticket; |
|
787 | + } |
|
788 | 788 | |
789 | 789 | |
790 | - /** |
|
791 | - * @access protected |
|
792 | - * @param EE_Ticket $ticket |
|
793 | - * @param array $price_rows |
|
794 | - * @param int $ticket_price |
|
795 | - * @param int $base_price |
|
796 | - * @param int $base_price_id |
|
797 | - * @return EE_Ticket |
|
798 | - * @throws ReflectionException |
|
799 | - * @throws InvalidArgumentException |
|
800 | - * @throws InvalidInterfaceException |
|
801 | - * @throws InvalidDataTypeException |
|
802 | - * @throws EE_Error |
|
803 | - */ |
|
804 | - protected function _duplicate_ticket( |
|
805 | - EE_Ticket $ticket, |
|
806 | - $price_rows = array(), |
|
807 | - $ticket_price = 0, |
|
808 | - $base_price = 0, |
|
809 | - $base_price_id = 0 |
|
810 | - ) { |
|
811 | - // create new ticket that's a copy of the existing |
|
812 | - // except a new id of course (and not archived) |
|
813 | - // AND has the new TKT_price associated with it. |
|
814 | - $new_ticket = clone $ticket; |
|
815 | - $new_ticket->set('TKT_ID', 0); |
|
816 | - $new_ticket->set_deleted(0); |
|
817 | - $new_ticket->set_price($ticket_price); |
|
818 | - $new_ticket->set_sold(0); |
|
819 | - // let's get a new ID for this ticket |
|
820 | - $new_ticket->save(); |
|
821 | - // we also need to make sure this new ticket gets the same datetime attachments as the archived ticket |
|
822 | - $datetimes_on_existing = $ticket->datetimes(); |
|
823 | - $new_ticket = $this->_update_ticket_datetimes( |
|
824 | - $new_ticket, |
|
825 | - $datetimes_on_existing, |
|
826 | - array_keys($datetimes_on_existing) |
|
827 | - ); |
|
828 | - // $ticket will get archived later b/c we are NOT adding it to the saved_tickets array. |
|
829 | - // if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining |
|
830 | - // available. |
|
831 | - if ($ticket->sold() > 0) { |
|
832 | - $new_qty = $ticket->qty() - $ticket->sold(); |
|
833 | - $new_ticket->set_qty($new_qty); |
|
834 | - } |
|
835 | - // now we update the prices just for this ticket |
|
836 | - $new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true); |
|
837 | - // and we update the base price |
|
838 | - $new_ticket = $this->_add_prices_to_ticket( |
|
839 | - array(), |
|
840 | - $new_ticket, |
|
841 | - true, |
|
842 | - $base_price, |
|
843 | - $base_price_id |
|
844 | - ); |
|
845 | - return $new_ticket; |
|
846 | - } |
|
790 | + /** |
|
791 | + * @access protected |
|
792 | + * @param EE_Ticket $ticket |
|
793 | + * @param array $price_rows |
|
794 | + * @param int $ticket_price |
|
795 | + * @param int $base_price |
|
796 | + * @param int $base_price_id |
|
797 | + * @return EE_Ticket |
|
798 | + * @throws ReflectionException |
|
799 | + * @throws InvalidArgumentException |
|
800 | + * @throws InvalidInterfaceException |
|
801 | + * @throws InvalidDataTypeException |
|
802 | + * @throws EE_Error |
|
803 | + */ |
|
804 | + protected function _duplicate_ticket( |
|
805 | + EE_Ticket $ticket, |
|
806 | + $price_rows = array(), |
|
807 | + $ticket_price = 0, |
|
808 | + $base_price = 0, |
|
809 | + $base_price_id = 0 |
|
810 | + ) { |
|
811 | + // create new ticket that's a copy of the existing |
|
812 | + // except a new id of course (and not archived) |
|
813 | + // AND has the new TKT_price associated with it. |
|
814 | + $new_ticket = clone $ticket; |
|
815 | + $new_ticket->set('TKT_ID', 0); |
|
816 | + $new_ticket->set_deleted(0); |
|
817 | + $new_ticket->set_price($ticket_price); |
|
818 | + $new_ticket->set_sold(0); |
|
819 | + // let's get a new ID for this ticket |
|
820 | + $new_ticket->save(); |
|
821 | + // we also need to make sure this new ticket gets the same datetime attachments as the archived ticket |
|
822 | + $datetimes_on_existing = $ticket->datetimes(); |
|
823 | + $new_ticket = $this->_update_ticket_datetimes( |
|
824 | + $new_ticket, |
|
825 | + $datetimes_on_existing, |
|
826 | + array_keys($datetimes_on_existing) |
|
827 | + ); |
|
828 | + // $ticket will get archived later b/c we are NOT adding it to the saved_tickets array. |
|
829 | + // if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining |
|
830 | + // available. |
|
831 | + if ($ticket->sold() > 0) { |
|
832 | + $new_qty = $ticket->qty() - $ticket->sold(); |
|
833 | + $new_ticket->set_qty($new_qty); |
|
834 | + } |
|
835 | + // now we update the prices just for this ticket |
|
836 | + $new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true); |
|
837 | + // and we update the base price |
|
838 | + $new_ticket = $this->_add_prices_to_ticket( |
|
839 | + array(), |
|
840 | + $new_ticket, |
|
841 | + true, |
|
842 | + $base_price, |
|
843 | + $base_price_id |
|
844 | + ); |
|
845 | + return $new_ticket; |
|
846 | + } |
|
847 | 847 | |
848 | 848 | |
849 | - /** |
|
850 | - * This attaches a list of given prices to a ticket. |
|
851 | - * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change |
|
852 | - * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old |
|
853 | - * price info and prices are automatically "archived" via the ticket. |
|
854 | - * |
|
855 | - * @access private |
|
856 | - * @param array $prices Array of prices from the form. |
|
857 | - * @param EE_Ticket $ticket EE_Ticket object that prices are being attached to. |
|
858 | - * @param bool $new_prices Whether attach existing incoming prices or create new ones. |
|
859 | - * @param int|bool $base_price if FALSE then NOT doing a base price add. |
|
860 | - * @param int|bool $base_price_id if present then this is the base_price_id being updated. |
|
861 | - * @return EE_Ticket |
|
862 | - * @throws ReflectionException |
|
863 | - * @throws InvalidArgumentException |
|
864 | - * @throws InvalidInterfaceException |
|
865 | - * @throws InvalidDataTypeException |
|
866 | - * @throws EE_Error |
|
867 | - */ |
|
868 | - protected function _add_prices_to_ticket( |
|
869 | - $prices = array(), |
|
870 | - EE_Ticket $ticket, |
|
871 | - $new_prices = false, |
|
872 | - $base_price = false, |
|
873 | - $base_price_id = false |
|
874 | - ) { |
|
875 | - // let's just get any current prices that may exist on the given ticket |
|
876 | - // so we can remove any prices that got trashed in this session. |
|
877 | - $current_prices_on_ticket = $base_price !== false |
|
878 | - ? $ticket->base_price(true) |
|
879 | - : $ticket->price_modifiers(); |
|
880 | - $updated_prices = array(); |
|
881 | - // if $base_price ! FALSE then updating a base price. |
|
882 | - if ($base_price !== false) { |
|
883 | - $prices[1] = array( |
|
884 | - 'PRC_ID' => $new_prices || $base_price_id === 1 ? null : $base_price_id, |
|
885 | - 'PRT_ID' => 1, |
|
886 | - 'PRC_amount' => $base_price, |
|
887 | - 'PRC_name' => $ticket->get('TKT_name'), |
|
888 | - 'PRC_desc' => $ticket->get('TKT_description'), |
|
889 | - ); |
|
890 | - } |
|
891 | - // possibly need to save tkt |
|
892 | - if (! $ticket->ID()) { |
|
893 | - $ticket->save(); |
|
894 | - } |
|
895 | - foreach ($prices as $row => $prc) { |
|
896 | - $prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null; |
|
897 | - if (empty($prt_id)) { |
|
898 | - continue; |
|
899 | - } //prices MUST have a price type id. |
|
900 | - $PRC_values = array( |
|
901 | - 'PRC_ID' => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null, |
|
902 | - 'PRT_ID' => $prt_id, |
|
903 | - 'PRC_amount' => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0, |
|
904 | - 'PRC_name' => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '', |
|
905 | - 'PRC_desc' => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '', |
|
906 | - 'PRC_is_default' => false, |
|
907 | - // make sure we set PRC_is_default to false for all ticket saves from event_editor |
|
908 | - 'PRC_order' => $row, |
|
909 | - ); |
|
910 | - if ($new_prices || empty($PRC_values['PRC_ID'])) { |
|
911 | - $PRC_values['PRC_ID'] = 0; |
|
912 | - $price = EE_Registry::instance()->load_class( |
|
913 | - 'Price', |
|
914 | - array($PRC_values), |
|
915 | - false, |
|
916 | - false |
|
917 | - ); |
|
918 | - } else { |
|
919 | - $price = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']); |
|
920 | - // update this price with new values |
|
921 | - foreach ($PRC_values as $field => $value) { |
|
922 | - $price->set($field, $value); |
|
923 | - } |
|
924 | - } |
|
925 | - $price->save(); |
|
926 | - $updated_prices[ $price->ID() ] = $price; |
|
927 | - $ticket->_add_relation_to($price, 'Price'); |
|
928 | - } |
|
929 | - // now let's remove any prices that got removed from the ticket |
|
930 | - if (! empty($current_prices_on_ticket)) { |
|
931 | - $current = array_keys($current_prices_on_ticket); |
|
932 | - $updated = array_keys($updated_prices); |
|
933 | - $prices_to_remove = array_diff($current, $updated); |
|
934 | - if (! empty($prices_to_remove)) { |
|
935 | - foreach ($prices_to_remove as $prc_id) { |
|
936 | - $p = $current_prices_on_ticket[ $prc_id ]; |
|
937 | - $ticket->_remove_relation_to($p, 'Price'); |
|
938 | - // delete permanently the price |
|
939 | - $p->delete_permanently(); |
|
940 | - } |
|
941 | - } |
|
942 | - } |
|
943 | - return $ticket; |
|
944 | - } |
|
849 | + /** |
|
850 | + * This attaches a list of given prices to a ticket. |
|
851 | + * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change |
|
852 | + * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old |
|
853 | + * price info and prices are automatically "archived" via the ticket. |
|
854 | + * |
|
855 | + * @access private |
|
856 | + * @param array $prices Array of prices from the form. |
|
857 | + * @param EE_Ticket $ticket EE_Ticket object that prices are being attached to. |
|
858 | + * @param bool $new_prices Whether attach existing incoming prices or create new ones. |
|
859 | + * @param int|bool $base_price if FALSE then NOT doing a base price add. |
|
860 | + * @param int|bool $base_price_id if present then this is the base_price_id being updated. |
|
861 | + * @return EE_Ticket |
|
862 | + * @throws ReflectionException |
|
863 | + * @throws InvalidArgumentException |
|
864 | + * @throws InvalidInterfaceException |
|
865 | + * @throws InvalidDataTypeException |
|
866 | + * @throws EE_Error |
|
867 | + */ |
|
868 | + protected function _add_prices_to_ticket( |
|
869 | + $prices = array(), |
|
870 | + EE_Ticket $ticket, |
|
871 | + $new_prices = false, |
|
872 | + $base_price = false, |
|
873 | + $base_price_id = false |
|
874 | + ) { |
|
875 | + // let's just get any current prices that may exist on the given ticket |
|
876 | + // so we can remove any prices that got trashed in this session. |
|
877 | + $current_prices_on_ticket = $base_price !== false |
|
878 | + ? $ticket->base_price(true) |
|
879 | + : $ticket->price_modifiers(); |
|
880 | + $updated_prices = array(); |
|
881 | + // if $base_price ! FALSE then updating a base price. |
|
882 | + if ($base_price !== false) { |
|
883 | + $prices[1] = array( |
|
884 | + 'PRC_ID' => $new_prices || $base_price_id === 1 ? null : $base_price_id, |
|
885 | + 'PRT_ID' => 1, |
|
886 | + 'PRC_amount' => $base_price, |
|
887 | + 'PRC_name' => $ticket->get('TKT_name'), |
|
888 | + 'PRC_desc' => $ticket->get('TKT_description'), |
|
889 | + ); |
|
890 | + } |
|
891 | + // possibly need to save tkt |
|
892 | + if (! $ticket->ID()) { |
|
893 | + $ticket->save(); |
|
894 | + } |
|
895 | + foreach ($prices as $row => $prc) { |
|
896 | + $prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null; |
|
897 | + if (empty($prt_id)) { |
|
898 | + continue; |
|
899 | + } //prices MUST have a price type id. |
|
900 | + $PRC_values = array( |
|
901 | + 'PRC_ID' => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null, |
|
902 | + 'PRT_ID' => $prt_id, |
|
903 | + 'PRC_amount' => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0, |
|
904 | + 'PRC_name' => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '', |
|
905 | + 'PRC_desc' => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '', |
|
906 | + 'PRC_is_default' => false, |
|
907 | + // make sure we set PRC_is_default to false for all ticket saves from event_editor |
|
908 | + 'PRC_order' => $row, |
|
909 | + ); |
|
910 | + if ($new_prices || empty($PRC_values['PRC_ID'])) { |
|
911 | + $PRC_values['PRC_ID'] = 0; |
|
912 | + $price = EE_Registry::instance()->load_class( |
|
913 | + 'Price', |
|
914 | + array($PRC_values), |
|
915 | + false, |
|
916 | + false |
|
917 | + ); |
|
918 | + } else { |
|
919 | + $price = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']); |
|
920 | + // update this price with new values |
|
921 | + foreach ($PRC_values as $field => $value) { |
|
922 | + $price->set($field, $value); |
|
923 | + } |
|
924 | + } |
|
925 | + $price->save(); |
|
926 | + $updated_prices[ $price->ID() ] = $price; |
|
927 | + $ticket->_add_relation_to($price, 'Price'); |
|
928 | + } |
|
929 | + // now let's remove any prices that got removed from the ticket |
|
930 | + if (! empty($current_prices_on_ticket)) { |
|
931 | + $current = array_keys($current_prices_on_ticket); |
|
932 | + $updated = array_keys($updated_prices); |
|
933 | + $prices_to_remove = array_diff($current, $updated); |
|
934 | + if (! empty($prices_to_remove)) { |
|
935 | + foreach ($prices_to_remove as $prc_id) { |
|
936 | + $p = $current_prices_on_ticket[ $prc_id ]; |
|
937 | + $ticket->_remove_relation_to($p, 'Price'); |
|
938 | + // delete permanently the price |
|
939 | + $p->delete_permanently(); |
|
940 | + } |
|
941 | + } |
|
942 | + } |
|
943 | + return $ticket; |
|
944 | + } |
|
945 | 945 | |
946 | 946 | |
947 | - /** |
|
948 | - * @param Events_Admin_Page $event_admin_obj |
|
949 | - * @return Events_Admin_Page |
|
950 | - */ |
|
951 | - public function autosave_handling(Events_Admin_Page $event_admin_obj) |
|
952 | - { |
|
953 | - return $event_admin_obj; |
|
954 | - // doing nothing for the moment. |
|
955 | - // todo when I get to this remember that I need to set the template args on the $event_admin_obj |
|
956 | - // (use the set_template_args() method) |
|
957 | - /** |
|
958 | - * need to remember to handle TICKET DEFAULT saves correctly: I've got two input fields in the dom: |
|
959 | - * 1. TKT_is_default_selector (visible) |
|
960 | - * 2. TKT_is_default (hidden) |
|
961 | - * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket |
|
962 | - * (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want |
|
963 | - * this ticket to be saved as a default. |
|
964 | - * The tricky part is, on an initial display on create or edit (or after manually updating), |
|
965 | - * the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true |
|
966 | - * if this is a create. However, after an autosave, users will want some sort of indicator that |
|
967 | - * the TKT HAS been saved as a default.. |
|
968 | - * in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking. |
|
969 | - * On Autosave: |
|
970 | - * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements, |
|
971 | - * then set the TKT_is_default to false. |
|
972 | - * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well). |
|
973 | - * We do NOT create a new default ticket. The checkbox stays selected after autosave. |
|
974 | - * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket. |
|
975 | - */ |
|
976 | - } |
|
947 | + /** |
|
948 | + * @param Events_Admin_Page $event_admin_obj |
|
949 | + * @return Events_Admin_Page |
|
950 | + */ |
|
951 | + public function autosave_handling(Events_Admin_Page $event_admin_obj) |
|
952 | + { |
|
953 | + return $event_admin_obj; |
|
954 | + // doing nothing for the moment. |
|
955 | + // todo when I get to this remember that I need to set the template args on the $event_admin_obj |
|
956 | + // (use the set_template_args() method) |
|
957 | + /** |
|
958 | + * need to remember to handle TICKET DEFAULT saves correctly: I've got two input fields in the dom: |
|
959 | + * 1. TKT_is_default_selector (visible) |
|
960 | + * 2. TKT_is_default (hidden) |
|
961 | + * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket |
|
962 | + * (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want |
|
963 | + * this ticket to be saved as a default. |
|
964 | + * The tricky part is, on an initial display on create or edit (or after manually updating), |
|
965 | + * the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true |
|
966 | + * if this is a create. However, after an autosave, users will want some sort of indicator that |
|
967 | + * the TKT HAS been saved as a default.. |
|
968 | + * in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking. |
|
969 | + * On Autosave: |
|
970 | + * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements, |
|
971 | + * then set the TKT_is_default to false. |
|
972 | + * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well). |
|
973 | + * We do NOT create a new default ticket. The checkbox stays selected after autosave. |
|
974 | + * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket. |
|
975 | + */ |
|
976 | + } |
|
977 | 977 | |
978 | 978 | |
979 | - /** |
|
980 | - * @throws ReflectionException |
|
981 | - * @throws InvalidArgumentException |
|
982 | - * @throws InvalidInterfaceException |
|
983 | - * @throws InvalidDataTypeException |
|
984 | - * @throws DomainException |
|
985 | - * @throws EE_Error |
|
986 | - */ |
|
987 | - public function pricing_metabox() |
|
988 | - { |
|
989 | - $existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array(); |
|
990 | - $event = $this->_adminpage_obj->get_cpt_model_obj(); |
|
991 | - // set is_creating_event property. |
|
992 | - $EVT_ID = $event->ID(); |
|
993 | - $this->_is_creating_event = empty($this->_req_data['post']); |
|
994 | - // default main template args |
|
995 | - $main_template_args = array( |
|
996 | - 'event_datetime_help_link' => EEH_Template::get_help_tab_link( |
|
997 | - 'event_editor_event_datetimes_help_tab', |
|
998 | - $this->_adminpage_obj->page_slug, |
|
999 | - $this->_adminpage_obj->get_req_action(), |
|
1000 | - false, |
|
1001 | - false |
|
1002 | - ), |
|
1003 | - // todo need to add a filter to the template for the help text |
|
1004 | - // in the Events_Admin_Page core file so we can add further help |
|
1005 | - 'existing_datetime_ids' => '', |
|
1006 | - 'total_dtt_rows' => 1, |
|
1007 | - 'add_new_dtt_help_link' => EEH_Template::get_help_tab_link( |
|
1008 | - 'add_new_dtt_info', |
|
1009 | - $this->_adminpage_obj->page_slug, |
|
1010 | - $this->_adminpage_obj->get_req_action(), |
|
1011 | - false, |
|
1012 | - false |
|
1013 | - ), |
|
1014 | - // todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
1015 | - 'datetime_rows' => '', |
|
1016 | - 'show_tickets_container' => '', |
|
1017 | - // $this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '', |
|
1018 | - 'ticket_rows' => '', |
|
1019 | - 'existing_ticket_ids' => '', |
|
1020 | - 'total_ticket_rows' => 1, |
|
1021 | - 'ticket_js_structure' => '', |
|
1022 | - 'ee_collapsible_status' => ' ee-collapsible-open' |
|
1023 | - // $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open' |
|
1024 | - ); |
|
1025 | - $timezone = $event instanceof EE_Event ? $event->timezone_string() : null; |
|
1026 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
1027 | - /** |
|
1028 | - * 1. Start with retrieving Datetimes |
|
1029 | - * 2. For each datetime get related tickets |
|
1030 | - * 3. For each ticket get related prices |
|
1031 | - */ |
|
1032 | - /** @var EEM_Datetime $datetime_model */ |
|
1033 | - $datetime_model = EE_Registry::instance()->load_model('Datetime', array($timezone)); |
|
1034 | - $datetimes = $datetime_model->get_all_event_dates($EVT_ID); |
|
1035 | - $main_template_args['total_dtt_rows'] = count($datetimes); |
|
1036 | - /** |
|
1037 | - * @see https://events.codebasehq.com/projects/event-espresso/tickets/9486 |
|
1038 | - * for why we are counting $datetime_row and then setting that on the Datetime object |
|
1039 | - */ |
|
1040 | - $datetime_row = 1; |
|
1041 | - foreach ($datetimes as $datetime) { |
|
1042 | - $DTT_ID = $datetime->get('DTT_ID'); |
|
1043 | - $datetime->set('DTT_order', $datetime_row); |
|
1044 | - $existing_datetime_ids[] = $DTT_ID; |
|
1045 | - // tickets attached |
|
1046 | - $related_tickets = $datetime->ID() > 0 |
|
1047 | - ? $datetime->get_many_related( |
|
1048 | - 'Ticket', |
|
1049 | - array( |
|
1050 | - array( |
|
1051 | - 'OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0), |
|
1052 | - ), |
|
1053 | - 'default_where_conditions' => 'none', |
|
1054 | - 'order_by' => array('TKT_order' => 'ASC'), |
|
1055 | - ) |
|
1056 | - ) |
|
1057 | - : array(); |
|
1058 | - // if there are no related tickets this is likely a new event OR autodraft |
|
1059 | - // event so we need to generate the default tickets because datetimes |
|
1060 | - // ALWAYS have at least one related ticket!!. EXCEPT, we dont' do this if there is already more than one |
|
1061 | - // datetime on the event. |
|
1062 | - if (empty($related_tickets) && count($datetimes) < 2) { |
|
1063 | - /** @var EEM_Ticket $ticket_model */ |
|
1064 | - $ticket_model = EE_Registry::instance()->load_model('Ticket'); |
|
1065 | - $related_tickets = $ticket_model->get_all_default_tickets(); |
|
1066 | - // this should be ordered by TKT_ID, so let's grab the first default ticket |
|
1067 | - // (which will be the main default) and ensure it has any default prices added to it (but do NOT save). |
|
1068 | - $default_prices = EEM_Price::instance()->get_all_default_prices(); |
|
1069 | - $main_default_ticket = reset($related_tickets); |
|
1070 | - if ($main_default_ticket instanceof EE_Ticket) { |
|
1071 | - foreach ($default_prices as $default_price) { |
|
1072 | - if ($default_price instanceof EE_Price && $default_price->is_base_price()) { |
|
1073 | - continue; |
|
1074 | - } |
|
1075 | - $main_default_ticket->cache('Price', $default_price); |
|
1076 | - } |
|
1077 | - } |
|
1078 | - } |
|
1079 | - // we can't actually setup rows in this loop yet cause we don't know all |
|
1080 | - // the unique tickets for this event yet (tickets are linked through all datetimes). |
|
1081 | - // So we're going to temporarily cache some of that information. |
|
1082 | - // loop through and setup the ticket rows and make sure the order is set. |
|
1083 | - foreach ($related_tickets as $ticket) { |
|
1084 | - $TKT_ID = $ticket->get('TKT_ID'); |
|
1085 | - $ticket_row = $ticket->get('TKT_row'); |
|
1086 | - // we only want unique tickets in our final display!! |
|
1087 | - if (! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
1088 | - $existing_ticket_ids[] = $TKT_ID; |
|
1089 | - $all_tickets[] = $ticket; |
|
1090 | - } |
|
1091 | - // temporary cache of this ticket info for this datetime for later processing of datetime rows. |
|
1092 | - $datetime_tickets[ $DTT_ID ][] = $ticket_row; |
|
1093 | - // temporary cache of this datetime info for this ticket for later processing of ticket rows. |
|
1094 | - if (! isset($ticket_datetimes[ $TKT_ID ]) |
|
1095 | - || ! in_array($datetime_row, $ticket_datetimes[ $TKT_ID ], true) |
|
1096 | - ) { |
|
1097 | - $ticket_datetimes[ $TKT_ID ][] = $datetime_row; |
|
1098 | - } |
|
1099 | - } |
|
1100 | - $datetime_row++; |
|
1101 | - } |
|
1102 | - $main_template_args['total_ticket_rows'] = count($existing_ticket_ids); |
|
1103 | - $main_template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids); |
|
1104 | - $main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids); |
|
1105 | - // sort $all_tickets by order |
|
1106 | - usort( |
|
1107 | - $all_tickets, |
|
1108 | - function (EE_Ticket $a, EE_Ticket $b) { |
|
1109 | - $a_order = (int) $a->get('TKT_order'); |
|
1110 | - $b_order = (int) $b->get('TKT_order'); |
|
1111 | - if ($a_order === $b_order) { |
|
1112 | - return 0; |
|
1113 | - } |
|
1114 | - return ($a_order < $b_order) ? -1 : 1; |
|
1115 | - } |
|
1116 | - ); |
|
1117 | - // k NOW we have all the data we need for setting up the dtt rows |
|
1118 | - // and ticket rows so we start our dtt loop again. |
|
1119 | - $datetime_row = 1; |
|
1120 | - foreach ($datetimes as $datetime) { |
|
1121 | - $main_template_args['datetime_rows'] .= $this->_get_datetime_row( |
|
1122 | - $datetime_row, |
|
1123 | - $datetime, |
|
1124 | - $datetime_tickets, |
|
1125 | - $all_tickets, |
|
1126 | - false, |
|
1127 | - $datetimes |
|
1128 | - ); |
|
1129 | - $datetime_row++; |
|
1130 | - } |
|
1131 | - // then loop through all tickets for the ticket rows. |
|
1132 | - $ticket_row = 1; |
|
1133 | - foreach ($all_tickets as $ticket) { |
|
1134 | - $main_template_args['ticket_rows'] .= $this->_get_ticket_row( |
|
1135 | - $ticket_row, |
|
1136 | - $ticket, |
|
1137 | - $ticket_datetimes, |
|
1138 | - $datetimes, |
|
1139 | - false, |
|
1140 | - $all_tickets |
|
1141 | - ); |
|
1142 | - $ticket_row++; |
|
1143 | - } |
|
1144 | - $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets); |
|
1145 | - EEH_Template::display_template( |
|
1146 | - PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php', |
|
1147 | - $main_template_args |
|
1148 | - ); |
|
1149 | - } |
|
979 | + /** |
|
980 | + * @throws ReflectionException |
|
981 | + * @throws InvalidArgumentException |
|
982 | + * @throws InvalidInterfaceException |
|
983 | + * @throws InvalidDataTypeException |
|
984 | + * @throws DomainException |
|
985 | + * @throws EE_Error |
|
986 | + */ |
|
987 | + public function pricing_metabox() |
|
988 | + { |
|
989 | + $existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array(); |
|
990 | + $event = $this->_adminpage_obj->get_cpt_model_obj(); |
|
991 | + // set is_creating_event property. |
|
992 | + $EVT_ID = $event->ID(); |
|
993 | + $this->_is_creating_event = empty($this->_req_data['post']); |
|
994 | + // default main template args |
|
995 | + $main_template_args = array( |
|
996 | + 'event_datetime_help_link' => EEH_Template::get_help_tab_link( |
|
997 | + 'event_editor_event_datetimes_help_tab', |
|
998 | + $this->_adminpage_obj->page_slug, |
|
999 | + $this->_adminpage_obj->get_req_action(), |
|
1000 | + false, |
|
1001 | + false |
|
1002 | + ), |
|
1003 | + // todo need to add a filter to the template for the help text |
|
1004 | + // in the Events_Admin_Page core file so we can add further help |
|
1005 | + 'existing_datetime_ids' => '', |
|
1006 | + 'total_dtt_rows' => 1, |
|
1007 | + 'add_new_dtt_help_link' => EEH_Template::get_help_tab_link( |
|
1008 | + 'add_new_dtt_info', |
|
1009 | + $this->_adminpage_obj->page_slug, |
|
1010 | + $this->_adminpage_obj->get_req_action(), |
|
1011 | + false, |
|
1012 | + false |
|
1013 | + ), |
|
1014 | + // todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
1015 | + 'datetime_rows' => '', |
|
1016 | + 'show_tickets_container' => '', |
|
1017 | + // $this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '', |
|
1018 | + 'ticket_rows' => '', |
|
1019 | + 'existing_ticket_ids' => '', |
|
1020 | + 'total_ticket_rows' => 1, |
|
1021 | + 'ticket_js_structure' => '', |
|
1022 | + 'ee_collapsible_status' => ' ee-collapsible-open' |
|
1023 | + // $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open' |
|
1024 | + ); |
|
1025 | + $timezone = $event instanceof EE_Event ? $event->timezone_string() : null; |
|
1026 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
1027 | + /** |
|
1028 | + * 1. Start with retrieving Datetimes |
|
1029 | + * 2. For each datetime get related tickets |
|
1030 | + * 3. For each ticket get related prices |
|
1031 | + */ |
|
1032 | + /** @var EEM_Datetime $datetime_model */ |
|
1033 | + $datetime_model = EE_Registry::instance()->load_model('Datetime', array($timezone)); |
|
1034 | + $datetimes = $datetime_model->get_all_event_dates($EVT_ID); |
|
1035 | + $main_template_args['total_dtt_rows'] = count($datetimes); |
|
1036 | + /** |
|
1037 | + * @see https://events.codebasehq.com/projects/event-espresso/tickets/9486 |
|
1038 | + * for why we are counting $datetime_row and then setting that on the Datetime object |
|
1039 | + */ |
|
1040 | + $datetime_row = 1; |
|
1041 | + foreach ($datetimes as $datetime) { |
|
1042 | + $DTT_ID = $datetime->get('DTT_ID'); |
|
1043 | + $datetime->set('DTT_order', $datetime_row); |
|
1044 | + $existing_datetime_ids[] = $DTT_ID; |
|
1045 | + // tickets attached |
|
1046 | + $related_tickets = $datetime->ID() > 0 |
|
1047 | + ? $datetime->get_many_related( |
|
1048 | + 'Ticket', |
|
1049 | + array( |
|
1050 | + array( |
|
1051 | + 'OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0), |
|
1052 | + ), |
|
1053 | + 'default_where_conditions' => 'none', |
|
1054 | + 'order_by' => array('TKT_order' => 'ASC'), |
|
1055 | + ) |
|
1056 | + ) |
|
1057 | + : array(); |
|
1058 | + // if there are no related tickets this is likely a new event OR autodraft |
|
1059 | + // event so we need to generate the default tickets because datetimes |
|
1060 | + // ALWAYS have at least one related ticket!!. EXCEPT, we dont' do this if there is already more than one |
|
1061 | + // datetime on the event. |
|
1062 | + if (empty($related_tickets) && count($datetimes) < 2) { |
|
1063 | + /** @var EEM_Ticket $ticket_model */ |
|
1064 | + $ticket_model = EE_Registry::instance()->load_model('Ticket'); |
|
1065 | + $related_tickets = $ticket_model->get_all_default_tickets(); |
|
1066 | + // this should be ordered by TKT_ID, so let's grab the first default ticket |
|
1067 | + // (which will be the main default) and ensure it has any default prices added to it (but do NOT save). |
|
1068 | + $default_prices = EEM_Price::instance()->get_all_default_prices(); |
|
1069 | + $main_default_ticket = reset($related_tickets); |
|
1070 | + if ($main_default_ticket instanceof EE_Ticket) { |
|
1071 | + foreach ($default_prices as $default_price) { |
|
1072 | + if ($default_price instanceof EE_Price && $default_price->is_base_price()) { |
|
1073 | + continue; |
|
1074 | + } |
|
1075 | + $main_default_ticket->cache('Price', $default_price); |
|
1076 | + } |
|
1077 | + } |
|
1078 | + } |
|
1079 | + // we can't actually setup rows in this loop yet cause we don't know all |
|
1080 | + // the unique tickets for this event yet (tickets are linked through all datetimes). |
|
1081 | + // So we're going to temporarily cache some of that information. |
|
1082 | + // loop through and setup the ticket rows and make sure the order is set. |
|
1083 | + foreach ($related_tickets as $ticket) { |
|
1084 | + $TKT_ID = $ticket->get('TKT_ID'); |
|
1085 | + $ticket_row = $ticket->get('TKT_row'); |
|
1086 | + // we only want unique tickets in our final display!! |
|
1087 | + if (! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
1088 | + $existing_ticket_ids[] = $TKT_ID; |
|
1089 | + $all_tickets[] = $ticket; |
|
1090 | + } |
|
1091 | + // temporary cache of this ticket info for this datetime for later processing of datetime rows. |
|
1092 | + $datetime_tickets[ $DTT_ID ][] = $ticket_row; |
|
1093 | + // temporary cache of this datetime info for this ticket for later processing of ticket rows. |
|
1094 | + if (! isset($ticket_datetimes[ $TKT_ID ]) |
|
1095 | + || ! in_array($datetime_row, $ticket_datetimes[ $TKT_ID ], true) |
|
1096 | + ) { |
|
1097 | + $ticket_datetimes[ $TKT_ID ][] = $datetime_row; |
|
1098 | + } |
|
1099 | + } |
|
1100 | + $datetime_row++; |
|
1101 | + } |
|
1102 | + $main_template_args['total_ticket_rows'] = count($existing_ticket_ids); |
|
1103 | + $main_template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids); |
|
1104 | + $main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids); |
|
1105 | + // sort $all_tickets by order |
|
1106 | + usort( |
|
1107 | + $all_tickets, |
|
1108 | + function (EE_Ticket $a, EE_Ticket $b) { |
|
1109 | + $a_order = (int) $a->get('TKT_order'); |
|
1110 | + $b_order = (int) $b->get('TKT_order'); |
|
1111 | + if ($a_order === $b_order) { |
|
1112 | + return 0; |
|
1113 | + } |
|
1114 | + return ($a_order < $b_order) ? -1 : 1; |
|
1115 | + } |
|
1116 | + ); |
|
1117 | + // k NOW we have all the data we need for setting up the dtt rows |
|
1118 | + // and ticket rows so we start our dtt loop again. |
|
1119 | + $datetime_row = 1; |
|
1120 | + foreach ($datetimes as $datetime) { |
|
1121 | + $main_template_args['datetime_rows'] .= $this->_get_datetime_row( |
|
1122 | + $datetime_row, |
|
1123 | + $datetime, |
|
1124 | + $datetime_tickets, |
|
1125 | + $all_tickets, |
|
1126 | + false, |
|
1127 | + $datetimes |
|
1128 | + ); |
|
1129 | + $datetime_row++; |
|
1130 | + } |
|
1131 | + // then loop through all tickets for the ticket rows. |
|
1132 | + $ticket_row = 1; |
|
1133 | + foreach ($all_tickets as $ticket) { |
|
1134 | + $main_template_args['ticket_rows'] .= $this->_get_ticket_row( |
|
1135 | + $ticket_row, |
|
1136 | + $ticket, |
|
1137 | + $ticket_datetimes, |
|
1138 | + $datetimes, |
|
1139 | + false, |
|
1140 | + $all_tickets |
|
1141 | + ); |
|
1142 | + $ticket_row++; |
|
1143 | + } |
|
1144 | + $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets); |
|
1145 | + EEH_Template::display_template( |
|
1146 | + PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php', |
|
1147 | + $main_template_args |
|
1148 | + ); |
|
1149 | + } |
|
1150 | 1150 | |
1151 | 1151 | |
1152 | - /** |
|
1153 | - * @param int $datetime_row |
|
1154 | - * @param EE_Datetime $datetime |
|
1155 | - * @param array $datetime_tickets |
|
1156 | - * @param array $all_tickets |
|
1157 | - * @param bool $default |
|
1158 | - * @param array $all_datetimes |
|
1159 | - * @return mixed |
|
1160 | - * @throws DomainException |
|
1161 | - * @throws EE_Error |
|
1162 | - */ |
|
1163 | - protected function _get_datetime_row( |
|
1164 | - $datetime_row, |
|
1165 | - EE_Datetime $datetime, |
|
1166 | - $datetime_tickets = array(), |
|
1167 | - $all_tickets = array(), |
|
1168 | - $default = false, |
|
1169 | - $all_datetimes = array() |
|
1170 | - ) { |
|
1171 | - $dtt_display_template_args = array( |
|
1172 | - 'dtt_edit_row' => $this->_get_dtt_edit_row( |
|
1173 | - $datetime_row, |
|
1174 | - $datetime, |
|
1175 | - $default, |
|
1176 | - $all_datetimes |
|
1177 | - ), |
|
1178 | - 'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row( |
|
1179 | - $datetime_row, |
|
1180 | - $datetime, |
|
1181 | - $datetime_tickets, |
|
1182 | - $all_tickets, |
|
1183 | - $default |
|
1184 | - ), |
|
1185 | - 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
1186 | - ); |
|
1187 | - return EEH_Template::display_template( |
|
1188 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php', |
|
1189 | - $dtt_display_template_args, |
|
1190 | - true |
|
1191 | - ); |
|
1192 | - } |
|
1152 | + /** |
|
1153 | + * @param int $datetime_row |
|
1154 | + * @param EE_Datetime $datetime |
|
1155 | + * @param array $datetime_tickets |
|
1156 | + * @param array $all_tickets |
|
1157 | + * @param bool $default |
|
1158 | + * @param array $all_datetimes |
|
1159 | + * @return mixed |
|
1160 | + * @throws DomainException |
|
1161 | + * @throws EE_Error |
|
1162 | + */ |
|
1163 | + protected function _get_datetime_row( |
|
1164 | + $datetime_row, |
|
1165 | + EE_Datetime $datetime, |
|
1166 | + $datetime_tickets = array(), |
|
1167 | + $all_tickets = array(), |
|
1168 | + $default = false, |
|
1169 | + $all_datetimes = array() |
|
1170 | + ) { |
|
1171 | + $dtt_display_template_args = array( |
|
1172 | + 'dtt_edit_row' => $this->_get_dtt_edit_row( |
|
1173 | + $datetime_row, |
|
1174 | + $datetime, |
|
1175 | + $default, |
|
1176 | + $all_datetimes |
|
1177 | + ), |
|
1178 | + 'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row( |
|
1179 | + $datetime_row, |
|
1180 | + $datetime, |
|
1181 | + $datetime_tickets, |
|
1182 | + $all_tickets, |
|
1183 | + $default |
|
1184 | + ), |
|
1185 | + 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
1186 | + ); |
|
1187 | + return EEH_Template::display_template( |
|
1188 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php', |
|
1189 | + $dtt_display_template_args, |
|
1190 | + true |
|
1191 | + ); |
|
1192 | + } |
|
1193 | 1193 | |
1194 | 1194 | |
1195 | - /** |
|
1196 | - * This method is used to generate a dtt fields edit row. |
|
1197 | - * The same row is used to generate a row with valid DTT objects |
|
1198 | - * and the default row that is used as the skeleton by the js. |
|
1199 | - * |
|
1200 | - * @param int $datetime_row The row number for the row being generated. |
|
1201 | - * @param EE_Datetime $datetime |
|
1202 | - * @param bool $default Whether a default row is being generated or not. |
|
1203 | - * @param EE_Datetime[] $all_datetimes This is the array of all datetimes used in the editor. |
|
1204 | - * @return string |
|
1205 | - * @throws DomainException |
|
1206 | - * @throws EE_Error |
|
1207 | - */ |
|
1208 | - protected function _get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes) |
|
1209 | - { |
|
1210 | - // if the incoming $datetime object is NOT an instance of EE_Datetime then force default to true. |
|
1211 | - $default = ! $datetime instanceof EE_Datetime ? true : $default; |
|
1212 | - $template_args = array( |
|
1213 | - 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
1214 | - 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
1215 | - 'edit_dtt_expanded' => '', |
|
1216 | - 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
1217 | - 'DTT_name' => $default ? '' : $datetime->get_f('DTT_name'), |
|
1218 | - 'DTT_description' => $default ? '' : $datetime->get_f('DTT_description'), |
|
1219 | - 'DTT_EVT_start' => $default ? '' : $datetime->start_date($this->_date_time_format), |
|
1220 | - 'DTT_EVT_end' => $default ? '' : $datetime->end_date($this->_date_time_format), |
|
1221 | - 'DTT_reg_limit' => $default |
|
1222 | - ? '' |
|
1223 | - : $datetime->get_pretty( |
|
1224 | - 'DTT_reg_limit', |
|
1225 | - 'input' |
|
1226 | - ), |
|
1227 | - 'DTT_order' => $default ? 'DTTNUM' : $datetime_row, |
|
1228 | - 'dtt_sold' => $default ? '0' : $datetime->get('DTT_sold'), |
|
1229 | - 'dtt_reserved' => $default ? '0' : $datetime->reserved(), |
|
1230 | - 'clone_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
1231 | - ? '' |
|
1232 | - : 'clone-icon ee-icon ee-icon-clone clickable', |
|
1233 | - 'trash_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
1234 | - ? 'ee-lock-icon' |
|
1235 | - : 'trash-icon dashicons dashicons-post-trash clickable', |
|
1236 | - 'reg_list_url' => $default || ! $datetime->event() instanceof \EE_Event |
|
1237 | - ? '' |
|
1238 | - : EE_Admin_Page::add_query_args_and_nonce( |
|
1239 | - array('event_id' => $datetime->event()->ID(), 'datetime_id' => $datetime->ID()), |
|
1240 | - REG_ADMIN_URL |
|
1241 | - ), |
|
1242 | - ); |
|
1243 | - $template_args['show_trash'] = count($all_datetimes) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
1244 | - ? ' style="display:none"' |
|
1245 | - : ''; |
|
1246 | - // allow filtering of template args at this point. |
|
1247 | - $template_args = apply_filters( |
|
1248 | - 'FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args', |
|
1249 | - $template_args, |
|
1250 | - $datetime_row, |
|
1251 | - $datetime, |
|
1252 | - $default, |
|
1253 | - $all_datetimes, |
|
1254 | - $this->_is_creating_event |
|
1255 | - ); |
|
1256 | - return EEH_Template::display_template( |
|
1257 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php', |
|
1258 | - $template_args, |
|
1259 | - true |
|
1260 | - ); |
|
1261 | - } |
|
1195 | + /** |
|
1196 | + * This method is used to generate a dtt fields edit row. |
|
1197 | + * The same row is used to generate a row with valid DTT objects |
|
1198 | + * and the default row that is used as the skeleton by the js. |
|
1199 | + * |
|
1200 | + * @param int $datetime_row The row number for the row being generated. |
|
1201 | + * @param EE_Datetime $datetime |
|
1202 | + * @param bool $default Whether a default row is being generated or not. |
|
1203 | + * @param EE_Datetime[] $all_datetimes This is the array of all datetimes used in the editor. |
|
1204 | + * @return string |
|
1205 | + * @throws DomainException |
|
1206 | + * @throws EE_Error |
|
1207 | + */ |
|
1208 | + protected function _get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes) |
|
1209 | + { |
|
1210 | + // if the incoming $datetime object is NOT an instance of EE_Datetime then force default to true. |
|
1211 | + $default = ! $datetime instanceof EE_Datetime ? true : $default; |
|
1212 | + $template_args = array( |
|
1213 | + 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
1214 | + 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
1215 | + 'edit_dtt_expanded' => '', |
|
1216 | + 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
1217 | + 'DTT_name' => $default ? '' : $datetime->get_f('DTT_name'), |
|
1218 | + 'DTT_description' => $default ? '' : $datetime->get_f('DTT_description'), |
|
1219 | + 'DTT_EVT_start' => $default ? '' : $datetime->start_date($this->_date_time_format), |
|
1220 | + 'DTT_EVT_end' => $default ? '' : $datetime->end_date($this->_date_time_format), |
|
1221 | + 'DTT_reg_limit' => $default |
|
1222 | + ? '' |
|
1223 | + : $datetime->get_pretty( |
|
1224 | + 'DTT_reg_limit', |
|
1225 | + 'input' |
|
1226 | + ), |
|
1227 | + 'DTT_order' => $default ? 'DTTNUM' : $datetime_row, |
|
1228 | + 'dtt_sold' => $default ? '0' : $datetime->get('DTT_sold'), |
|
1229 | + 'dtt_reserved' => $default ? '0' : $datetime->reserved(), |
|
1230 | + 'clone_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
1231 | + ? '' |
|
1232 | + : 'clone-icon ee-icon ee-icon-clone clickable', |
|
1233 | + 'trash_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
1234 | + ? 'ee-lock-icon' |
|
1235 | + : 'trash-icon dashicons dashicons-post-trash clickable', |
|
1236 | + 'reg_list_url' => $default || ! $datetime->event() instanceof \EE_Event |
|
1237 | + ? '' |
|
1238 | + : EE_Admin_Page::add_query_args_and_nonce( |
|
1239 | + array('event_id' => $datetime->event()->ID(), 'datetime_id' => $datetime->ID()), |
|
1240 | + REG_ADMIN_URL |
|
1241 | + ), |
|
1242 | + ); |
|
1243 | + $template_args['show_trash'] = count($all_datetimes) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
1244 | + ? ' style="display:none"' |
|
1245 | + : ''; |
|
1246 | + // allow filtering of template args at this point. |
|
1247 | + $template_args = apply_filters( |
|
1248 | + 'FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args', |
|
1249 | + $template_args, |
|
1250 | + $datetime_row, |
|
1251 | + $datetime, |
|
1252 | + $default, |
|
1253 | + $all_datetimes, |
|
1254 | + $this->_is_creating_event |
|
1255 | + ); |
|
1256 | + return EEH_Template::display_template( |
|
1257 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php', |
|
1258 | + $template_args, |
|
1259 | + true |
|
1260 | + ); |
|
1261 | + } |
|
1262 | 1262 | |
1263 | 1263 | |
1264 | - /** |
|
1265 | - * @param int $datetime_row |
|
1266 | - * @param EE_Datetime $datetime |
|
1267 | - * @param array $datetime_tickets |
|
1268 | - * @param array $all_tickets |
|
1269 | - * @param bool $default |
|
1270 | - * @return mixed |
|
1271 | - * @throws DomainException |
|
1272 | - * @throws EE_Error |
|
1273 | - */ |
|
1274 | - protected function _get_dtt_attached_tickets_row( |
|
1275 | - $datetime_row, |
|
1276 | - $datetime, |
|
1277 | - $datetime_tickets = array(), |
|
1278 | - $all_tickets = array(), |
|
1279 | - $default |
|
1280 | - ) { |
|
1281 | - $template_args = array( |
|
1282 | - 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
1283 | - 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
1284 | - 'DTT_description' => $default ? '' : $datetime->get_f('DTT_description'), |
|
1285 | - 'datetime_tickets_list' => $default ? '<li class="hidden"></li>' : '', |
|
1286 | - 'show_tickets_row' => ' style="display:none;"', |
|
1287 | - 'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link( |
|
1288 | - 'add_new_ticket_via_datetime', |
|
1289 | - $this->_adminpage_obj->page_slug, |
|
1290 | - $this->_adminpage_obj->get_req_action(), |
|
1291 | - false, |
|
1292 | - false |
|
1293 | - ), |
|
1294 | - // todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
1295 | - 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
1296 | - ); |
|
1297 | - // need to setup the list items (but only if this isn't a default skeleton setup) |
|
1298 | - if (! $default) { |
|
1299 | - $ticket_row = 1; |
|
1300 | - foreach ($all_tickets as $ticket) { |
|
1301 | - $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
1302 | - $datetime_row, |
|
1303 | - $ticket_row, |
|
1304 | - $datetime, |
|
1305 | - $ticket, |
|
1306 | - $datetime_tickets, |
|
1307 | - $default |
|
1308 | - ); |
|
1309 | - $ticket_row++; |
|
1310 | - } |
|
1311 | - } |
|
1312 | - // filter template args at this point |
|
1313 | - $template_args = apply_filters( |
|
1314 | - 'FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args', |
|
1315 | - $template_args, |
|
1316 | - $datetime_row, |
|
1317 | - $datetime, |
|
1318 | - $datetime_tickets, |
|
1319 | - $all_tickets, |
|
1320 | - $default, |
|
1321 | - $this->_is_creating_event |
|
1322 | - ); |
|
1323 | - return EEH_Template::display_template( |
|
1324 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php', |
|
1325 | - $template_args, |
|
1326 | - true |
|
1327 | - ); |
|
1328 | - } |
|
1264 | + /** |
|
1265 | + * @param int $datetime_row |
|
1266 | + * @param EE_Datetime $datetime |
|
1267 | + * @param array $datetime_tickets |
|
1268 | + * @param array $all_tickets |
|
1269 | + * @param bool $default |
|
1270 | + * @return mixed |
|
1271 | + * @throws DomainException |
|
1272 | + * @throws EE_Error |
|
1273 | + */ |
|
1274 | + protected function _get_dtt_attached_tickets_row( |
|
1275 | + $datetime_row, |
|
1276 | + $datetime, |
|
1277 | + $datetime_tickets = array(), |
|
1278 | + $all_tickets = array(), |
|
1279 | + $default |
|
1280 | + ) { |
|
1281 | + $template_args = array( |
|
1282 | + 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
1283 | + 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
1284 | + 'DTT_description' => $default ? '' : $datetime->get_f('DTT_description'), |
|
1285 | + 'datetime_tickets_list' => $default ? '<li class="hidden"></li>' : '', |
|
1286 | + 'show_tickets_row' => ' style="display:none;"', |
|
1287 | + 'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link( |
|
1288 | + 'add_new_ticket_via_datetime', |
|
1289 | + $this->_adminpage_obj->page_slug, |
|
1290 | + $this->_adminpage_obj->get_req_action(), |
|
1291 | + false, |
|
1292 | + false |
|
1293 | + ), |
|
1294 | + // todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
1295 | + 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
1296 | + ); |
|
1297 | + // need to setup the list items (but only if this isn't a default skeleton setup) |
|
1298 | + if (! $default) { |
|
1299 | + $ticket_row = 1; |
|
1300 | + foreach ($all_tickets as $ticket) { |
|
1301 | + $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
1302 | + $datetime_row, |
|
1303 | + $ticket_row, |
|
1304 | + $datetime, |
|
1305 | + $ticket, |
|
1306 | + $datetime_tickets, |
|
1307 | + $default |
|
1308 | + ); |
|
1309 | + $ticket_row++; |
|
1310 | + } |
|
1311 | + } |
|
1312 | + // filter template args at this point |
|
1313 | + $template_args = apply_filters( |
|
1314 | + 'FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args', |
|
1315 | + $template_args, |
|
1316 | + $datetime_row, |
|
1317 | + $datetime, |
|
1318 | + $datetime_tickets, |
|
1319 | + $all_tickets, |
|
1320 | + $default, |
|
1321 | + $this->_is_creating_event |
|
1322 | + ); |
|
1323 | + return EEH_Template::display_template( |
|
1324 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php', |
|
1325 | + $template_args, |
|
1326 | + true |
|
1327 | + ); |
|
1328 | + } |
|
1329 | 1329 | |
1330 | 1330 | |
1331 | - /** |
|
1332 | - * @param int $datetime_row |
|
1333 | - * @param int $ticket_row |
|
1334 | - * @param EE_Datetime $datetime |
|
1335 | - * @param EE_Ticket $ticket |
|
1336 | - * @param array $datetime_tickets |
|
1337 | - * @param bool $default |
|
1338 | - * @return mixed |
|
1339 | - * @throws DomainException |
|
1340 | - * @throws EE_Error |
|
1341 | - */ |
|
1342 | - protected function _get_datetime_tickets_list_item( |
|
1343 | - $datetime_row, |
|
1344 | - $ticket_row, |
|
1345 | - $datetime, |
|
1346 | - $ticket, |
|
1347 | - $datetime_tickets = array(), |
|
1348 | - $default |
|
1349 | - ) { |
|
1350 | - $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[ $datetime->ID() ]) |
|
1351 | - ? $datetime_tickets[ $datetime->ID() ] |
|
1352 | - : array(); |
|
1353 | - $display_row = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0; |
|
1354 | - $no_ticket = $default && empty($ticket); |
|
1355 | - $template_args = array( |
|
1356 | - 'dtt_row' => $default |
|
1357 | - ? 'DTTNUM' |
|
1358 | - : $datetime_row, |
|
1359 | - 'tkt_row' => $no_ticket |
|
1360 | - ? 'TICKETNUM' |
|
1361 | - : $ticket_row, |
|
1362 | - 'datetime_ticket_checked' => in_array($display_row, $dtt_tkts, true) |
|
1363 | - ? ' checked="checked"' |
|
1364 | - : '', |
|
1365 | - 'ticket_selected' => in_array($display_row, $dtt_tkts, true) |
|
1366 | - ? ' ticket-selected' |
|
1367 | - : '', |
|
1368 | - 'TKT_name' => $no_ticket |
|
1369 | - ? 'TKTNAME' |
|
1370 | - : $ticket->get('TKT_name'), |
|
1371 | - 'tkt_status_class' => $no_ticket || $this->_is_creating_event |
|
1372 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
1373 | - : ' tkt-status-' . $ticket->ticket_status(), |
|
1374 | - ); |
|
1375 | - // filter template args |
|
1376 | - $template_args = apply_filters( |
|
1377 | - 'FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args', |
|
1378 | - $template_args, |
|
1379 | - $datetime_row, |
|
1380 | - $ticket_row, |
|
1381 | - $datetime, |
|
1382 | - $ticket, |
|
1383 | - $datetime_tickets, |
|
1384 | - $default, |
|
1385 | - $this->_is_creating_event |
|
1386 | - ); |
|
1387 | - return EEH_Template::display_template( |
|
1388 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php', |
|
1389 | - $template_args, |
|
1390 | - true |
|
1391 | - ); |
|
1392 | - } |
|
1331 | + /** |
|
1332 | + * @param int $datetime_row |
|
1333 | + * @param int $ticket_row |
|
1334 | + * @param EE_Datetime $datetime |
|
1335 | + * @param EE_Ticket $ticket |
|
1336 | + * @param array $datetime_tickets |
|
1337 | + * @param bool $default |
|
1338 | + * @return mixed |
|
1339 | + * @throws DomainException |
|
1340 | + * @throws EE_Error |
|
1341 | + */ |
|
1342 | + protected function _get_datetime_tickets_list_item( |
|
1343 | + $datetime_row, |
|
1344 | + $ticket_row, |
|
1345 | + $datetime, |
|
1346 | + $ticket, |
|
1347 | + $datetime_tickets = array(), |
|
1348 | + $default |
|
1349 | + ) { |
|
1350 | + $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[ $datetime->ID() ]) |
|
1351 | + ? $datetime_tickets[ $datetime->ID() ] |
|
1352 | + : array(); |
|
1353 | + $display_row = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0; |
|
1354 | + $no_ticket = $default && empty($ticket); |
|
1355 | + $template_args = array( |
|
1356 | + 'dtt_row' => $default |
|
1357 | + ? 'DTTNUM' |
|
1358 | + : $datetime_row, |
|
1359 | + 'tkt_row' => $no_ticket |
|
1360 | + ? 'TICKETNUM' |
|
1361 | + : $ticket_row, |
|
1362 | + 'datetime_ticket_checked' => in_array($display_row, $dtt_tkts, true) |
|
1363 | + ? ' checked="checked"' |
|
1364 | + : '', |
|
1365 | + 'ticket_selected' => in_array($display_row, $dtt_tkts, true) |
|
1366 | + ? ' ticket-selected' |
|
1367 | + : '', |
|
1368 | + 'TKT_name' => $no_ticket |
|
1369 | + ? 'TKTNAME' |
|
1370 | + : $ticket->get('TKT_name'), |
|
1371 | + 'tkt_status_class' => $no_ticket || $this->_is_creating_event |
|
1372 | + ? ' tkt-status-' . EE_Ticket::onsale |
|
1373 | + : ' tkt-status-' . $ticket->ticket_status(), |
|
1374 | + ); |
|
1375 | + // filter template args |
|
1376 | + $template_args = apply_filters( |
|
1377 | + 'FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args', |
|
1378 | + $template_args, |
|
1379 | + $datetime_row, |
|
1380 | + $ticket_row, |
|
1381 | + $datetime, |
|
1382 | + $ticket, |
|
1383 | + $datetime_tickets, |
|
1384 | + $default, |
|
1385 | + $this->_is_creating_event |
|
1386 | + ); |
|
1387 | + return EEH_Template::display_template( |
|
1388 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php', |
|
1389 | + $template_args, |
|
1390 | + true |
|
1391 | + ); |
|
1392 | + } |
|
1393 | 1393 | |
1394 | 1394 | |
1395 | - /** |
|
1396 | - * This generates the ticket row for tickets. |
|
1397 | - * This same method is used to generate both the actual rows and the js skeleton row |
|
1398 | - * (when default === true) |
|
1399 | - * |
|
1400 | - * @param int $ticket_row Represents the row number being generated. |
|
1401 | - * @param $ticket |
|
1402 | - * @param EE_Datetime[] $ticket_datetimes Either an array of all datetimes on all tickets indexed by each ticket |
|
1403 | - * or empty for default |
|
1404 | - * @param EE_Datetime[] $all_datetimes All Datetimes on the event or empty for default. |
|
1405 | - * @param bool $default Whether default row being generated or not. |
|
1406 | - * @param EE_Ticket[] $all_tickets This is an array of all tickets attached to the event |
|
1407 | - * (or empty in the case of defaults) |
|
1408 | - * @return mixed |
|
1409 | - * @throws InvalidArgumentException |
|
1410 | - * @throws InvalidInterfaceException |
|
1411 | - * @throws InvalidDataTypeException |
|
1412 | - * @throws DomainException |
|
1413 | - * @throws EE_Error |
|
1414 | - * @throws ReflectionException |
|
1415 | - */ |
|
1416 | - protected function _get_ticket_row( |
|
1417 | - $ticket_row, |
|
1418 | - $ticket, |
|
1419 | - $ticket_datetimes, |
|
1420 | - $all_datetimes, |
|
1421 | - $default = false, |
|
1422 | - $all_tickets = array() |
|
1423 | - ) { |
|
1424 | - // if $ticket is not an instance of EE_Ticket then force default to true. |
|
1425 | - $default = ! $ticket instanceof EE_Ticket ? true : $default; |
|
1426 | - $prices = ! empty($ticket) && ! $default |
|
1427 | - ? $ticket->get_many_related( |
|
1428 | - 'Price', |
|
1429 | - array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC')) |
|
1430 | - ) |
|
1431 | - : array(); |
|
1432 | - // if there is only one price (which would be the base price) |
|
1433 | - // or NO prices and this ticket is a default ticket, |
|
1434 | - // let's just make sure there are no cached default prices on the object. |
|
1435 | - // This is done by not including any query_params. |
|
1436 | - if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) { |
|
1437 | - $prices = $ticket->prices(); |
|
1438 | - } |
|
1439 | - // check if we're dealing with a default ticket in which case |
|
1440 | - // we don't want any starting_ticket_datetime_row values set |
|
1441 | - // (otherwise there won't be any new relationships created for tickets based off of the default ticket). |
|
1442 | - // This will future proof in case there is ever any behaviour change between what the primary_key defaults to. |
|
1443 | - $default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->is_default()); |
|
1444 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
1445 | - ? $ticket_datetimes[ $ticket->ID() ] |
|
1446 | - : array(); |
|
1447 | - $ticket_subtotal = $default ? 0 : $ticket->get_ticket_subtotal(); |
|
1448 | - $base_price = $default ? null : $ticket->base_price(); |
|
1449 | - $count_price_mods = EEM_Price::instance()->get_all_default_prices(true); |
|
1450 | - // breaking out complicated condition for ticket_status |
|
1451 | - if ($default) { |
|
1452 | - $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale; |
|
1453 | - } else { |
|
1454 | - $ticket_status_class = $ticket->is_default() |
|
1455 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
1456 | - : ' tkt-status-' . $ticket->ticket_status(); |
|
1457 | - } |
|
1458 | - // breaking out complicated condition for TKT_taxable |
|
1459 | - if ($default) { |
|
1460 | - $TKT_taxable = ''; |
|
1461 | - } else { |
|
1462 | - $TKT_taxable = $ticket->taxable() |
|
1463 | - ? ' checked="checked"' |
|
1464 | - : ''; |
|
1465 | - } |
|
1466 | - if ($default) { |
|
1467 | - $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
1468 | - } elseif ($ticket->is_default()) { |
|
1469 | - $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
1470 | - } else { |
|
1471 | - $TKT_status = $ticket->ticket_status(true); |
|
1472 | - } |
|
1473 | - if ($default) { |
|
1474 | - $TKT_min = ''; |
|
1475 | - } else { |
|
1476 | - $TKT_min = $ticket->min(); |
|
1477 | - if ($TKT_min === -1 || $TKT_min === 0) { |
|
1478 | - $TKT_min = ''; |
|
1479 | - } |
|
1480 | - } |
|
1481 | - $template_args = array( |
|
1482 | - 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
1483 | - 'TKT_order' => $default ? 'TICKETNUM' : $ticket_row, |
|
1484 | - // on initial page load this will always be the correct order. |
|
1485 | - 'tkt_status_class' => $ticket_status_class, |
|
1486 | - 'display_edit_tkt_row' => ' style="display:none;"', |
|
1487 | - 'edit_tkt_expanded' => '', |
|
1488 | - 'edit_tickets_name' => $default ? 'TICKETNAMEATTR' : 'edit_tickets', |
|
1489 | - 'TKT_name' => $default ? '' : $ticket->get_f('TKT_name'), |
|
1490 | - 'TKT_start_date' => $default |
|
1491 | - ? '' |
|
1492 | - : $ticket->get_date('TKT_start_date', $this->_date_time_format), |
|
1493 | - 'TKT_end_date' => $default |
|
1494 | - ? '' |
|
1495 | - : $ticket->get_date('TKT_end_date', $this->_date_time_format), |
|
1496 | - 'TKT_status' => $TKT_status, |
|
1497 | - 'TKT_price' => $default |
|
1498 | - ? '' |
|
1499 | - : EEH_Template::format_currency( |
|
1500 | - $ticket->get_ticket_total_with_taxes(), |
|
1501 | - false, |
|
1502 | - false |
|
1503 | - ), |
|
1504 | - 'TKT_price_code' => EE_Registry::instance()->CFG->currency->code, |
|
1505 | - 'TKT_price_amount' => $default ? 0 : $ticket_subtotal, |
|
1506 | - 'TKT_qty' => $default |
|
1507 | - ? '' |
|
1508 | - : $ticket->get_pretty('TKT_qty', 'symbol'), |
|
1509 | - 'TKT_qty_for_input' => $default |
|
1510 | - ? '' |
|
1511 | - : $ticket->get_pretty('TKT_qty', 'input'), |
|
1512 | - 'TKT_uses' => $default |
|
1513 | - ? '' |
|
1514 | - : $ticket->get_pretty('TKT_uses', 'input'), |
|
1515 | - 'TKT_min' => $TKT_min, |
|
1516 | - 'TKT_max' => $default |
|
1517 | - ? '' |
|
1518 | - : $ticket->get_pretty('TKT_max', 'input'), |
|
1519 | - 'TKT_sold' => $default ? 0 : $ticket->tickets_sold('ticket'), |
|
1520 | - 'TKT_reserved' => $default ? 0 : $ticket->reserved(), |
|
1521 | - 'TKT_registrations' => $default |
|
1522 | - ? 0 |
|
1523 | - : $ticket->count_registrations( |
|
1524 | - array( |
|
1525 | - array( |
|
1526 | - 'STS_ID' => array( |
|
1527 | - '!=', |
|
1528 | - EEM_Registration::status_id_incomplete, |
|
1529 | - ), |
|
1530 | - ), |
|
1531 | - ) |
|
1532 | - ), |
|
1533 | - 'TKT_ID' => $default ? 0 : $ticket->ID(), |
|
1534 | - 'TKT_description' => $default ? '' : $ticket->get_f('TKT_description'), |
|
1535 | - 'TKT_is_default' => $default ? 0 : $ticket->is_default(), |
|
1536 | - 'TKT_required' => $default ? 0 : $ticket->required(), |
|
1537 | - 'TKT_is_default_selector' => '', |
|
1538 | - 'ticket_price_rows' => '', |
|
1539 | - 'TKT_base_price' => $default || ! $base_price instanceof EE_Price |
|
1540 | - ? '' |
|
1541 | - : $base_price->get_pretty('PRC_amount', 'localized_float'), |
|
1542 | - 'TKT_base_price_ID' => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(), |
|
1543 | - 'show_price_modifier' => count($prices) > 1 || ($default && $count_price_mods > 0) |
|
1544 | - ? '' |
|
1545 | - : ' style="display:none;"', |
|
1546 | - 'show_price_mod_button' => count($prices) > 1 |
|
1547 | - || ($default && $count_price_mods > 0) |
|
1548 | - || (! $default && $ticket->deleted()) |
|
1549 | - ? ' style="display:none;"' |
|
1550 | - : '', |
|
1551 | - 'total_price_rows' => count($prices) > 1 ? count($prices) : 1, |
|
1552 | - 'ticket_datetimes_list' => $default ? '<li class="hidden"></li>' : '', |
|
1553 | - 'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_datetimes), |
|
1554 | - 'ticket_datetime_rows' => $default ? '' : implode(',', $tkt_datetimes), |
|
1555 | - 'existing_ticket_price_ids' => $default ? '' : implode(',', array_keys($prices)), |
|
1556 | - 'ticket_template_id' => $default ? 0 : $ticket->get('TTM_ID'), |
|
1557 | - 'TKT_taxable' => $TKT_taxable, |
|
1558 | - 'display_subtotal' => $ticket instanceof EE_Ticket && $ticket->taxable() |
|
1559 | - ? '' |
|
1560 | - : ' style="display:none"', |
|
1561 | - 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
1562 | - 'TKT_subtotal_amount_display' => EEH_Template::format_currency( |
|
1563 | - $ticket_subtotal, |
|
1564 | - false, |
|
1565 | - false |
|
1566 | - ), |
|
1567 | - 'TKT_subtotal_amount' => $ticket_subtotal, |
|
1568 | - 'tax_rows' => $this->_get_tax_rows($ticket_row, $ticket), |
|
1569 | - 'disabled' => $ticket instanceof EE_Ticket && $ticket->deleted(), |
|
1570 | - 'ticket_archive_class' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
1571 | - ? ' ticket-archived' |
|
1572 | - : '', |
|
1573 | - 'trash_icon' => $ticket instanceof EE_Ticket |
|
1574 | - && $ticket->deleted() |
|
1575 | - && ! $ticket->is_permanently_deleteable() |
|
1576 | - ? 'ee-lock-icon ' |
|
1577 | - : 'trash-icon dashicons dashicons-post-trash clickable', |
|
1578 | - 'clone_icon' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
1579 | - ? '' |
|
1580 | - : 'clone-icon ee-icon ee-icon-clone clickable', |
|
1581 | - ); |
|
1582 | - $template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
1583 | - ? ' style="display:none"' |
|
1584 | - : ''; |
|
1585 | - // handle rows that should NOT be empty |
|
1586 | - if (empty($template_args['TKT_start_date'])) { |
|
1587 | - // if empty then the start date will be now. |
|
1588 | - $template_args['TKT_start_date'] = date( |
|
1589 | - $this->_date_time_format, |
|
1590 | - current_time('timestamp') |
|
1591 | - ); |
|
1592 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
1593 | - } |
|
1594 | - if (empty($template_args['TKT_end_date'])) { |
|
1595 | - // get the earliest datetime (if present); |
|
1596 | - $earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 |
|
1597 | - ? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related( |
|
1598 | - 'Datetime', |
|
1599 | - array('order_by' => array('DTT_EVT_start' => 'ASC')) |
|
1600 | - ) |
|
1601 | - : null; |
|
1602 | - if (! empty($earliest_dtt)) { |
|
1603 | - $template_args['TKT_end_date'] = $earliest_dtt->get_datetime( |
|
1604 | - 'DTT_EVT_start', |
|
1605 | - $this->_date_time_format |
|
1606 | - ); |
|
1607 | - } else { |
|
1608 | - // default so let's just use what's been set for the default date-time which is 30 days from now. |
|
1609 | - $template_args['TKT_end_date'] = date( |
|
1610 | - $this->_date_time_format, |
|
1611 | - mktime( |
|
1612 | - 24, |
|
1613 | - 0, |
|
1614 | - 0, |
|
1615 | - date('m'), |
|
1616 | - date('d') + 29, |
|
1617 | - date('Y') |
|
1618 | - ) |
|
1619 | - ); |
|
1620 | - } |
|
1621 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
1622 | - } |
|
1623 | - // generate ticket_datetime items |
|
1624 | - if (! $default) { |
|
1625 | - $datetime_row = 1; |
|
1626 | - foreach ($all_datetimes as $datetime) { |
|
1627 | - $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
1628 | - $datetime_row, |
|
1629 | - $ticket_row, |
|
1630 | - $datetime, |
|
1631 | - $ticket, |
|
1632 | - $ticket_datetimes, |
|
1633 | - $default |
|
1634 | - ); |
|
1635 | - $datetime_row++; |
|
1636 | - } |
|
1637 | - } |
|
1638 | - $price_row = 1; |
|
1639 | - foreach ($prices as $price) { |
|
1640 | - if (! $price instanceof EE_Price) { |
|
1641 | - continue; |
|
1642 | - } |
|
1643 | - if ($price->is_base_price()) { |
|
1644 | - $price_row++; |
|
1645 | - continue; |
|
1646 | - } |
|
1647 | - $show_trash = ! ((count($prices) > 1 && $price_row === 1) || count($prices) === 1); |
|
1648 | - $show_create = ! (count($prices) > 1 && count($prices) !== $price_row); |
|
1649 | - $template_args['ticket_price_rows'] .= $this->_get_ticket_price_row( |
|
1650 | - $ticket_row, |
|
1651 | - $price_row, |
|
1652 | - $price, |
|
1653 | - $default, |
|
1654 | - $ticket, |
|
1655 | - $show_trash, |
|
1656 | - $show_create |
|
1657 | - ); |
|
1658 | - $price_row++; |
|
1659 | - } |
|
1660 | - // filter $template_args |
|
1661 | - $template_args = apply_filters( |
|
1662 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args', |
|
1663 | - $template_args, |
|
1664 | - $ticket_row, |
|
1665 | - $ticket, |
|
1666 | - $ticket_datetimes, |
|
1667 | - $all_datetimes, |
|
1668 | - $default, |
|
1669 | - $all_tickets, |
|
1670 | - $this->_is_creating_event |
|
1671 | - ); |
|
1672 | - return EEH_Template::display_template( |
|
1673 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php', |
|
1674 | - $template_args, |
|
1675 | - true |
|
1676 | - ); |
|
1677 | - } |
|
1395 | + /** |
|
1396 | + * This generates the ticket row for tickets. |
|
1397 | + * This same method is used to generate both the actual rows and the js skeleton row |
|
1398 | + * (when default === true) |
|
1399 | + * |
|
1400 | + * @param int $ticket_row Represents the row number being generated. |
|
1401 | + * @param $ticket |
|
1402 | + * @param EE_Datetime[] $ticket_datetimes Either an array of all datetimes on all tickets indexed by each ticket |
|
1403 | + * or empty for default |
|
1404 | + * @param EE_Datetime[] $all_datetimes All Datetimes on the event or empty for default. |
|
1405 | + * @param bool $default Whether default row being generated or not. |
|
1406 | + * @param EE_Ticket[] $all_tickets This is an array of all tickets attached to the event |
|
1407 | + * (or empty in the case of defaults) |
|
1408 | + * @return mixed |
|
1409 | + * @throws InvalidArgumentException |
|
1410 | + * @throws InvalidInterfaceException |
|
1411 | + * @throws InvalidDataTypeException |
|
1412 | + * @throws DomainException |
|
1413 | + * @throws EE_Error |
|
1414 | + * @throws ReflectionException |
|
1415 | + */ |
|
1416 | + protected function _get_ticket_row( |
|
1417 | + $ticket_row, |
|
1418 | + $ticket, |
|
1419 | + $ticket_datetimes, |
|
1420 | + $all_datetimes, |
|
1421 | + $default = false, |
|
1422 | + $all_tickets = array() |
|
1423 | + ) { |
|
1424 | + // if $ticket is not an instance of EE_Ticket then force default to true. |
|
1425 | + $default = ! $ticket instanceof EE_Ticket ? true : $default; |
|
1426 | + $prices = ! empty($ticket) && ! $default |
|
1427 | + ? $ticket->get_many_related( |
|
1428 | + 'Price', |
|
1429 | + array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC')) |
|
1430 | + ) |
|
1431 | + : array(); |
|
1432 | + // if there is only one price (which would be the base price) |
|
1433 | + // or NO prices and this ticket is a default ticket, |
|
1434 | + // let's just make sure there are no cached default prices on the object. |
|
1435 | + // This is done by not including any query_params. |
|
1436 | + if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) { |
|
1437 | + $prices = $ticket->prices(); |
|
1438 | + } |
|
1439 | + // check if we're dealing with a default ticket in which case |
|
1440 | + // we don't want any starting_ticket_datetime_row values set |
|
1441 | + // (otherwise there won't be any new relationships created for tickets based off of the default ticket). |
|
1442 | + // This will future proof in case there is ever any behaviour change between what the primary_key defaults to. |
|
1443 | + $default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->is_default()); |
|
1444 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
1445 | + ? $ticket_datetimes[ $ticket->ID() ] |
|
1446 | + : array(); |
|
1447 | + $ticket_subtotal = $default ? 0 : $ticket->get_ticket_subtotal(); |
|
1448 | + $base_price = $default ? null : $ticket->base_price(); |
|
1449 | + $count_price_mods = EEM_Price::instance()->get_all_default_prices(true); |
|
1450 | + // breaking out complicated condition for ticket_status |
|
1451 | + if ($default) { |
|
1452 | + $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale; |
|
1453 | + } else { |
|
1454 | + $ticket_status_class = $ticket->is_default() |
|
1455 | + ? ' tkt-status-' . EE_Ticket::onsale |
|
1456 | + : ' tkt-status-' . $ticket->ticket_status(); |
|
1457 | + } |
|
1458 | + // breaking out complicated condition for TKT_taxable |
|
1459 | + if ($default) { |
|
1460 | + $TKT_taxable = ''; |
|
1461 | + } else { |
|
1462 | + $TKT_taxable = $ticket->taxable() |
|
1463 | + ? ' checked="checked"' |
|
1464 | + : ''; |
|
1465 | + } |
|
1466 | + if ($default) { |
|
1467 | + $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
1468 | + } elseif ($ticket->is_default()) { |
|
1469 | + $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
1470 | + } else { |
|
1471 | + $TKT_status = $ticket->ticket_status(true); |
|
1472 | + } |
|
1473 | + if ($default) { |
|
1474 | + $TKT_min = ''; |
|
1475 | + } else { |
|
1476 | + $TKT_min = $ticket->min(); |
|
1477 | + if ($TKT_min === -1 || $TKT_min === 0) { |
|
1478 | + $TKT_min = ''; |
|
1479 | + } |
|
1480 | + } |
|
1481 | + $template_args = array( |
|
1482 | + 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
1483 | + 'TKT_order' => $default ? 'TICKETNUM' : $ticket_row, |
|
1484 | + // on initial page load this will always be the correct order. |
|
1485 | + 'tkt_status_class' => $ticket_status_class, |
|
1486 | + 'display_edit_tkt_row' => ' style="display:none;"', |
|
1487 | + 'edit_tkt_expanded' => '', |
|
1488 | + 'edit_tickets_name' => $default ? 'TICKETNAMEATTR' : 'edit_tickets', |
|
1489 | + 'TKT_name' => $default ? '' : $ticket->get_f('TKT_name'), |
|
1490 | + 'TKT_start_date' => $default |
|
1491 | + ? '' |
|
1492 | + : $ticket->get_date('TKT_start_date', $this->_date_time_format), |
|
1493 | + 'TKT_end_date' => $default |
|
1494 | + ? '' |
|
1495 | + : $ticket->get_date('TKT_end_date', $this->_date_time_format), |
|
1496 | + 'TKT_status' => $TKT_status, |
|
1497 | + 'TKT_price' => $default |
|
1498 | + ? '' |
|
1499 | + : EEH_Template::format_currency( |
|
1500 | + $ticket->get_ticket_total_with_taxes(), |
|
1501 | + false, |
|
1502 | + false |
|
1503 | + ), |
|
1504 | + 'TKT_price_code' => EE_Registry::instance()->CFG->currency->code, |
|
1505 | + 'TKT_price_amount' => $default ? 0 : $ticket_subtotal, |
|
1506 | + 'TKT_qty' => $default |
|
1507 | + ? '' |
|
1508 | + : $ticket->get_pretty('TKT_qty', 'symbol'), |
|
1509 | + 'TKT_qty_for_input' => $default |
|
1510 | + ? '' |
|
1511 | + : $ticket->get_pretty('TKT_qty', 'input'), |
|
1512 | + 'TKT_uses' => $default |
|
1513 | + ? '' |
|
1514 | + : $ticket->get_pretty('TKT_uses', 'input'), |
|
1515 | + 'TKT_min' => $TKT_min, |
|
1516 | + 'TKT_max' => $default |
|
1517 | + ? '' |
|
1518 | + : $ticket->get_pretty('TKT_max', 'input'), |
|
1519 | + 'TKT_sold' => $default ? 0 : $ticket->tickets_sold('ticket'), |
|
1520 | + 'TKT_reserved' => $default ? 0 : $ticket->reserved(), |
|
1521 | + 'TKT_registrations' => $default |
|
1522 | + ? 0 |
|
1523 | + : $ticket->count_registrations( |
|
1524 | + array( |
|
1525 | + array( |
|
1526 | + 'STS_ID' => array( |
|
1527 | + '!=', |
|
1528 | + EEM_Registration::status_id_incomplete, |
|
1529 | + ), |
|
1530 | + ), |
|
1531 | + ) |
|
1532 | + ), |
|
1533 | + 'TKT_ID' => $default ? 0 : $ticket->ID(), |
|
1534 | + 'TKT_description' => $default ? '' : $ticket->get_f('TKT_description'), |
|
1535 | + 'TKT_is_default' => $default ? 0 : $ticket->is_default(), |
|
1536 | + 'TKT_required' => $default ? 0 : $ticket->required(), |
|
1537 | + 'TKT_is_default_selector' => '', |
|
1538 | + 'ticket_price_rows' => '', |
|
1539 | + 'TKT_base_price' => $default || ! $base_price instanceof EE_Price |
|
1540 | + ? '' |
|
1541 | + : $base_price->get_pretty('PRC_amount', 'localized_float'), |
|
1542 | + 'TKT_base_price_ID' => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(), |
|
1543 | + 'show_price_modifier' => count($prices) > 1 || ($default && $count_price_mods > 0) |
|
1544 | + ? '' |
|
1545 | + : ' style="display:none;"', |
|
1546 | + 'show_price_mod_button' => count($prices) > 1 |
|
1547 | + || ($default && $count_price_mods > 0) |
|
1548 | + || (! $default && $ticket->deleted()) |
|
1549 | + ? ' style="display:none;"' |
|
1550 | + : '', |
|
1551 | + 'total_price_rows' => count($prices) > 1 ? count($prices) : 1, |
|
1552 | + 'ticket_datetimes_list' => $default ? '<li class="hidden"></li>' : '', |
|
1553 | + 'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_datetimes), |
|
1554 | + 'ticket_datetime_rows' => $default ? '' : implode(',', $tkt_datetimes), |
|
1555 | + 'existing_ticket_price_ids' => $default ? '' : implode(',', array_keys($prices)), |
|
1556 | + 'ticket_template_id' => $default ? 0 : $ticket->get('TTM_ID'), |
|
1557 | + 'TKT_taxable' => $TKT_taxable, |
|
1558 | + 'display_subtotal' => $ticket instanceof EE_Ticket && $ticket->taxable() |
|
1559 | + ? '' |
|
1560 | + : ' style="display:none"', |
|
1561 | + 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
1562 | + 'TKT_subtotal_amount_display' => EEH_Template::format_currency( |
|
1563 | + $ticket_subtotal, |
|
1564 | + false, |
|
1565 | + false |
|
1566 | + ), |
|
1567 | + 'TKT_subtotal_amount' => $ticket_subtotal, |
|
1568 | + 'tax_rows' => $this->_get_tax_rows($ticket_row, $ticket), |
|
1569 | + 'disabled' => $ticket instanceof EE_Ticket && $ticket->deleted(), |
|
1570 | + 'ticket_archive_class' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
1571 | + ? ' ticket-archived' |
|
1572 | + : '', |
|
1573 | + 'trash_icon' => $ticket instanceof EE_Ticket |
|
1574 | + && $ticket->deleted() |
|
1575 | + && ! $ticket->is_permanently_deleteable() |
|
1576 | + ? 'ee-lock-icon ' |
|
1577 | + : 'trash-icon dashicons dashicons-post-trash clickable', |
|
1578 | + 'clone_icon' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
1579 | + ? '' |
|
1580 | + : 'clone-icon ee-icon ee-icon-clone clickable', |
|
1581 | + ); |
|
1582 | + $template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
1583 | + ? ' style="display:none"' |
|
1584 | + : ''; |
|
1585 | + // handle rows that should NOT be empty |
|
1586 | + if (empty($template_args['TKT_start_date'])) { |
|
1587 | + // if empty then the start date will be now. |
|
1588 | + $template_args['TKT_start_date'] = date( |
|
1589 | + $this->_date_time_format, |
|
1590 | + current_time('timestamp') |
|
1591 | + ); |
|
1592 | + $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
1593 | + } |
|
1594 | + if (empty($template_args['TKT_end_date'])) { |
|
1595 | + // get the earliest datetime (if present); |
|
1596 | + $earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 |
|
1597 | + ? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related( |
|
1598 | + 'Datetime', |
|
1599 | + array('order_by' => array('DTT_EVT_start' => 'ASC')) |
|
1600 | + ) |
|
1601 | + : null; |
|
1602 | + if (! empty($earliest_dtt)) { |
|
1603 | + $template_args['TKT_end_date'] = $earliest_dtt->get_datetime( |
|
1604 | + 'DTT_EVT_start', |
|
1605 | + $this->_date_time_format |
|
1606 | + ); |
|
1607 | + } else { |
|
1608 | + // default so let's just use what's been set for the default date-time which is 30 days from now. |
|
1609 | + $template_args['TKT_end_date'] = date( |
|
1610 | + $this->_date_time_format, |
|
1611 | + mktime( |
|
1612 | + 24, |
|
1613 | + 0, |
|
1614 | + 0, |
|
1615 | + date('m'), |
|
1616 | + date('d') + 29, |
|
1617 | + date('Y') |
|
1618 | + ) |
|
1619 | + ); |
|
1620 | + } |
|
1621 | + $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
1622 | + } |
|
1623 | + // generate ticket_datetime items |
|
1624 | + if (! $default) { |
|
1625 | + $datetime_row = 1; |
|
1626 | + foreach ($all_datetimes as $datetime) { |
|
1627 | + $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
1628 | + $datetime_row, |
|
1629 | + $ticket_row, |
|
1630 | + $datetime, |
|
1631 | + $ticket, |
|
1632 | + $ticket_datetimes, |
|
1633 | + $default |
|
1634 | + ); |
|
1635 | + $datetime_row++; |
|
1636 | + } |
|
1637 | + } |
|
1638 | + $price_row = 1; |
|
1639 | + foreach ($prices as $price) { |
|
1640 | + if (! $price instanceof EE_Price) { |
|
1641 | + continue; |
|
1642 | + } |
|
1643 | + if ($price->is_base_price()) { |
|
1644 | + $price_row++; |
|
1645 | + continue; |
|
1646 | + } |
|
1647 | + $show_trash = ! ((count($prices) > 1 && $price_row === 1) || count($prices) === 1); |
|
1648 | + $show_create = ! (count($prices) > 1 && count($prices) !== $price_row); |
|
1649 | + $template_args['ticket_price_rows'] .= $this->_get_ticket_price_row( |
|
1650 | + $ticket_row, |
|
1651 | + $price_row, |
|
1652 | + $price, |
|
1653 | + $default, |
|
1654 | + $ticket, |
|
1655 | + $show_trash, |
|
1656 | + $show_create |
|
1657 | + ); |
|
1658 | + $price_row++; |
|
1659 | + } |
|
1660 | + // filter $template_args |
|
1661 | + $template_args = apply_filters( |
|
1662 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args', |
|
1663 | + $template_args, |
|
1664 | + $ticket_row, |
|
1665 | + $ticket, |
|
1666 | + $ticket_datetimes, |
|
1667 | + $all_datetimes, |
|
1668 | + $default, |
|
1669 | + $all_tickets, |
|
1670 | + $this->_is_creating_event |
|
1671 | + ); |
|
1672 | + return EEH_Template::display_template( |
|
1673 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php', |
|
1674 | + $template_args, |
|
1675 | + true |
|
1676 | + ); |
|
1677 | + } |
|
1678 | 1678 | |
1679 | 1679 | |
1680 | - /** |
|
1681 | - * @param int $ticket_row |
|
1682 | - * @param EE_Ticket|null $ticket |
|
1683 | - * @return string |
|
1684 | - * @throws DomainException |
|
1685 | - * @throws EE_Error |
|
1686 | - */ |
|
1687 | - protected function _get_tax_rows($ticket_row, $ticket) |
|
1688 | - { |
|
1689 | - $tax_rows = ''; |
|
1690 | - /** @var EE_Price[] $taxes */ |
|
1691 | - $taxes = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin(); |
|
1692 | - foreach ($taxes as $tax) { |
|
1693 | - $tax_added = $this->_get_tax_added($tax, $ticket); |
|
1694 | - $template_args = array( |
|
1695 | - 'display_tax' => ! empty($ticket) && $ticket->get('TKT_taxable') |
|
1696 | - ? '' |
|
1697 | - : ' style="display:none;"', |
|
1698 | - 'tax_id' => $tax->ID(), |
|
1699 | - 'tkt_row' => $ticket_row, |
|
1700 | - 'tax_label' => $tax->get('PRC_name'), |
|
1701 | - 'tax_added' => $tax_added, |
|
1702 | - 'tax_added_display' => EEH_Template::format_currency($tax_added, false, false), |
|
1703 | - 'tax_amount' => $tax->get('PRC_amount'), |
|
1704 | - ); |
|
1705 | - $template_args = apply_filters( |
|
1706 | - 'FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args', |
|
1707 | - $template_args, |
|
1708 | - $ticket_row, |
|
1709 | - $ticket, |
|
1710 | - $this->_is_creating_event |
|
1711 | - ); |
|
1712 | - $tax_rows .= EEH_Template::display_template( |
|
1713 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php', |
|
1714 | - $template_args, |
|
1715 | - true |
|
1716 | - ); |
|
1717 | - } |
|
1718 | - return $tax_rows; |
|
1719 | - } |
|
1680 | + /** |
|
1681 | + * @param int $ticket_row |
|
1682 | + * @param EE_Ticket|null $ticket |
|
1683 | + * @return string |
|
1684 | + * @throws DomainException |
|
1685 | + * @throws EE_Error |
|
1686 | + */ |
|
1687 | + protected function _get_tax_rows($ticket_row, $ticket) |
|
1688 | + { |
|
1689 | + $tax_rows = ''; |
|
1690 | + /** @var EE_Price[] $taxes */ |
|
1691 | + $taxes = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin(); |
|
1692 | + foreach ($taxes as $tax) { |
|
1693 | + $tax_added = $this->_get_tax_added($tax, $ticket); |
|
1694 | + $template_args = array( |
|
1695 | + 'display_tax' => ! empty($ticket) && $ticket->get('TKT_taxable') |
|
1696 | + ? '' |
|
1697 | + : ' style="display:none;"', |
|
1698 | + 'tax_id' => $tax->ID(), |
|
1699 | + 'tkt_row' => $ticket_row, |
|
1700 | + 'tax_label' => $tax->get('PRC_name'), |
|
1701 | + 'tax_added' => $tax_added, |
|
1702 | + 'tax_added_display' => EEH_Template::format_currency($tax_added, false, false), |
|
1703 | + 'tax_amount' => $tax->get('PRC_amount'), |
|
1704 | + ); |
|
1705 | + $template_args = apply_filters( |
|
1706 | + 'FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args', |
|
1707 | + $template_args, |
|
1708 | + $ticket_row, |
|
1709 | + $ticket, |
|
1710 | + $this->_is_creating_event |
|
1711 | + ); |
|
1712 | + $tax_rows .= EEH_Template::display_template( |
|
1713 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php', |
|
1714 | + $template_args, |
|
1715 | + true |
|
1716 | + ); |
|
1717 | + } |
|
1718 | + return $tax_rows; |
|
1719 | + } |
|
1720 | 1720 | |
1721 | 1721 | |
1722 | - /** |
|
1723 | - * @param EE_Price $tax |
|
1724 | - * @param EE_Ticket|null $ticket |
|
1725 | - * @return float|int |
|
1726 | - * @throws EE_Error |
|
1727 | - */ |
|
1728 | - protected function _get_tax_added(EE_Price $tax, $ticket) |
|
1729 | - { |
|
1730 | - $subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal(); |
|
1731 | - return $subtotal * $tax->get('PRC_amount') / 100; |
|
1732 | - } |
|
1722 | + /** |
|
1723 | + * @param EE_Price $tax |
|
1724 | + * @param EE_Ticket|null $ticket |
|
1725 | + * @return float|int |
|
1726 | + * @throws EE_Error |
|
1727 | + */ |
|
1728 | + protected function _get_tax_added(EE_Price $tax, $ticket) |
|
1729 | + { |
|
1730 | + $subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal(); |
|
1731 | + return $subtotal * $tax->get('PRC_amount') / 100; |
|
1732 | + } |
|
1733 | 1733 | |
1734 | 1734 | |
1735 | - /** |
|
1736 | - * @param int $ticket_row |
|
1737 | - * @param int $price_row |
|
1738 | - * @param EE_Price|null $price |
|
1739 | - * @param bool $default |
|
1740 | - * @param EE_Ticket|null $ticket |
|
1741 | - * @param bool $show_trash |
|
1742 | - * @param bool $show_create |
|
1743 | - * @return mixed |
|
1744 | - * @throws InvalidArgumentException |
|
1745 | - * @throws InvalidInterfaceException |
|
1746 | - * @throws InvalidDataTypeException |
|
1747 | - * @throws DomainException |
|
1748 | - * @throws EE_Error |
|
1749 | - * @throws ReflectionException |
|
1750 | - */ |
|
1751 | - protected function _get_ticket_price_row( |
|
1752 | - $ticket_row, |
|
1753 | - $price_row, |
|
1754 | - $price, |
|
1755 | - $default, |
|
1756 | - $ticket, |
|
1757 | - $show_trash = true, |
|
1758 | - $show_create = true |
|
1759 | - ) { |
|
1760 | - $send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted'); |
|
1761 | - $template_args = array( |
|
1762 | - 'tkt_row' => $default && empty($ticket) |
|
1763 | - ? 'TICKETNUM' |
|
1764 | - : $ticket_row, |
|
1765 | - 'PRC_order' => $default && empty($price) |
|
1766 | - ? 'PRICENUM' |
|
1767 | - : $price_row, |
|
1768 | - 'edit_prices_name' => $default && empty($price) |
|
1769 | - ? 'PRICENAMEATTR' |
|
1770 | - : 'edit_prices', |
|
1771 | - 'price_type_selector' => $default && empty($price) |
|
1772 | - ? $this->_get_base_price_template($ticket_row, $price_row, $price, $default) |
|
1773 | - : $this->_get_price_type_selector( |
|
1774 | - $ticket_row, |
|
1775 | - $price_row, |
|
1776 | - $price, |
|
1777 | - $default, |
|
1778 | - $send_disabled |
|
1779 | - ), |
|
1780 | - 'PRC_ID' => $default && empty($price) |
|
1781 | - ? 0 |
|
1782 | - : $price->ID(), |
|
1783 | - 'PRC_is_default' => $default && empty($price) |
|
1784 | - ? 0 |
|
1785 | - : $price->get('PRC_is_default'), |
|
1786 | - 'PRC_name' => $default && empty($price) |
|
1787 | - ? '' |
|
1788 | - : $price->get('PRC_name'), |
|
1789 | - 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
1790 | - 'show_plus_or_minus' => $default && empty($price) |
|
1791 | - ? '' |
|
1792 | - : ' style="display:none;"', |
|
1793 | - 'show_plus' => ($default && empty($price)) || ($price->is_discount() || $price->is_base_price()) |
|
1794 | - ? ' style="display:none;"' |
|
1795 | - : '', |
|
1796 | - 'show_minus' => ($default && empty($price)) || ! $price->is_discount() |
|
1797 | - ? ' style="display:none;"' |
|
1798 | - : '', |
|
1799 | - 'show_currency_symbol' => ($default && empty($price)) || $price->is_percent() |
|
1800 | - ? ' style="display:none"' |
|
1801 | - : '', |
|
1802 | - 'PRC_amount' => $default && empty($price) |
|
1803 | - ? 0 |
|
1804 | - : $price->get_pretty('PRC_amount', 'localized_float'), |
|
1805 | - 'show_percentage' => ($default && empty($price)) || ! $price->is_percent() |
|
1806 | - ? ' style="display:none;"' |
|
1807 | - : '', |
|
1808 | - 'show_trash_icon' => $show_trash |
|
1809 | - ? '' |
|
1810 | - : ' style="display:none;"', |
|
1811 | - 'show_create_button' => $show_create |
|
1812 | - ? '' |
|
1813 | - : ' style="display:none;"', |
|
1814 | - 'PRC_desc' => $default && empty($price) |
|
1815 | - ? '' |
|
1816 | - : $price->get('PRC_desc'), |
|
1817 | - 'disabled' => ! empty($ticket) && $ticket->get('TKT_deleted'), |
|
1818 | - ); |
|
1819 | - $template_args = apply_filters( |
|
1820 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args', |
|
1821 | - $template_args, |
|
1822 | - $ticket_row, |
|
1823 | - $price_row, |
|
1824 | - $price, |
|
1825 | - $default, |
|
1826 | - $ticket, |
|
1827 | - $show_trash, |
|
1828 | - $show_create, |
|
1829 | - $this->_is_creating_event |
|
1830 | - ); |
|
1831 | - return EEH_Template::display_template( |
|
1832 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php', |
|
1833 | - $template_args, |
|
1834 | - true |
|
1835 | - ); |
|
1836 | - } |
|
1735 | + /** |
|
1736 | + * @param int $ticket_row |
|
1737 | + * @param int $price_row |
|
1738 | + * @param EE_Price|null $price |
|
1739 | + * @param bool $default |
|
1740 | + * @param EE_Ticket|null $ticket |
|
1741 | + * @param bool $show_trash |
|
1742 | + * @param bool $show_create |
|
1743 | + * @return mixed |
|
1744 | + * @throws InvalidArgumentException |
|
1745 | + * @throws InvalidInterfaceException |
|
1746 | + * @throws InvalidDataTypeException |
|
1747 | + * @throws DomainException |
|
1748 | + * @throws EE_Error |
|
1749 | + * @throws ReflectionException |
|
1750 | + */ |
|
1751 | + protected function _get_ticket_price_row( |
|
1752 | + $ticket_row, |
|
1753 | + $price_row, |
|
1754 | + $price, |
|
1755 | + $default, |
|
1756 | + $ticket, |
|
1757 | + $show_trash = true, |
|
1758 | + $show_create = true |
|
1759 | + ) { |
|
1760 | + $send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted'); |
|
1761 | + $template_args = array( |
|
1762 | + 'tkt_row' => $default && empty($ticket) |
|
1763 | + ? 'TICKETNUM' |
|
1764 | + : $ticket_row, |
|
1765 | + 'PRC_order' => $default && empty($price) |
|
1766 | + ? 'PRICENUM' |
|
1767 | + : $price_row, |
|
1768 | + 'edit_prices_name' => $default && empty($price) |
|
1769 | + ? 'PRICENAMEATTR' |
|
1770 | + : 'edit_prices', |
|
1771 | + 'price_type_selector' => $default && empty($price) |
|
1772 | + ? $this->_get_base_price_template($ticket_row, $price_row, $price, $default) |
|
1773 | + : $this->_get_price_type_selector( |
|
1774 | + $ticket_row, |
|
1775 | + $price_row, |
|
1776 | + $price, |
|
1777 | + $default, |
|
1778 | + $send_disabled |
|
1779 | + ), |
|
1780 | + 'PRC_ID' => $default && empty($price) |
|
1781 | + ? 0 |
|
1782 | + : $price->ID(), |
|
1783 | + 'PRC_is_default' => $default && empty($price) |
|
1784 | + ? 0 |
|
1785 | + : $price->get('PRC_is_default'), |
|
1786 | + 'PRC_name' => $default && empty($price) |
|
1787 | + ? '' |
|
1788 | + : $price->get('PRC_name'), |
|
1789 | + 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
1790 | + 'show_plus_or_minus' => $default && empty($price) |
|
1791 | + ? '' |
|
1792 | + : ' style="display:none;"', |
|
1793 | + 'show_plus' => ($default && empty($price)) || ($price->is_discount() || $price->is_base_price()) |
|
1794 | + ? ' style="display:none;"' |
|
1795 | + : '', |
|
1796 | + 'show_minus' => ($default && empty($price)) || ! $price->is_discount() |
|
1797 | + ? ' style="display:none;"' |
|
1798 | + : '', |
|
1799 | + 'show_currency_symbol' => ($default && empty($price)) || $price->is_percent() |
|
1800 | + ? ' style="display:none"' |
|
1801 | + : '', |
|
1802 | + 'PRC_amount' => $default && empty($price) |
|
1803 | + ? 0 |
|
1804 | + : $price->get_pretty('PRC_amount', 'localized_float'), |
|
1805 | + 'show_percentage' => ($default && empty($price)) || ! $price->is_percent() |
|
1806 | + ? ' style="display:none;"' |
|
1807 | + : '', |
|
1808 | + 'show_trash_icon' => $show_trash |
|
1809 | + ? '' |
|
1810 | + : ' style="display:none;"', |
|
1811 | + 'show_create_button' => $show_create |
|
1812 | + ? '' |
|
1813 | + : ' style="display:none;"', |
|
1814 | + 'PRC_desc' => $default && empty($price) |
|
1815 | + ? '' |
|
1816 | + : $price->get('PRC_desc'), |
|
1817 | + 'disabled' => ! empty($ticket) && $ticket->get('TKT_deleted'), |
|
1818 | + ); |
|
1819 | + $template_args = apply_filters( |
|
1820 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args', |
|
1821 | + $template_args, |
|
1822 | + $ticket_row, |
|
1823 | + $price_row, |
|
1824 | + $price, |
|
1825 | + $default, |
|
1826 | + $ticket, |
|
1827 | + $show_trash, |
|
1828 | + $show_create, |
|
1829 | + $this->_is_creating_event |
|
1830 | + ); |
|
1831 | + return EEH_Template::display_template( |
|
1832 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php', |
|
1833 | + $template_args, |
|
1834 | + true |
|
1835 | + ); |
|
1836 | + } |
|
1837 | 1837 | |
1838 | 1838 | |
1839 | - /** |
|
1840 | - * @param int $ticket_row |
|
1841 | - * @param int $price_row |
|
1842 | - * @param EE_Price $price |
|
1843 | - * @param bool $default |
|
1844 | - * @param bool $disabled |
|
1845 | - * @return mixed |
|
1846 | - * @throws ReflectionException |
|
1847 | - * @throws InvalidArgumentException |
|
1848 | - * @throws InvalidInterfaceException |
|
1849 | - * @throws InvalidDataTypeException |
|
1850 | - * @throws DomainException |
|
1851 | - * @throws EE_Error |
|
1852 | - */ |
|
1853 | - protected function _get_price_type_selector($ticket_row, $price_row, $price, $default, $disabled = false) |
|
1854 | - { |
|
1855 | - if ($price->is_base_price()) { |
|
1856 | - return $this->_get_base_price_template( |
|
1857 | - $ticket_row, |
|
1858 | - $price_row, |
|
1859 | - $price, |
|
1860 | - $default |
|
1861 | - ); |
|
1862 | - } |
|
1863 | - return $this->_get_price_modifier_template( |
|
1864 | - $ticket_row, |
|
1865 | - $price_row, |
|
1866 | - $price, |
|
1867 | - $default, |
|
1868 | - $disabled |
|
1869 | - ); |
|
1870 | - } |
|
1839 | + /** |
|
1840 | + * @param int $ticket_row |
|
1841 | + * @param int $price_row |
|
1842 | + * @param EE_Price $price |
|
1843 | + * @param bool $default |
|
1844 | + * @param bool $disabled |
|
1845 | + * @return mixed |
|
1846 | + * @throws ReflectionException |
|
1847 | + * @throws InvalidArgumentException |
|
1848 | + * @throws InvalidInterfaceException |
|
1849 | + * @throws InvalidDataTypeException |
|
1850 | + * @throws DomainException |
|
1851 | + * @throws EE_Error |
|
1852 | + */ |
|
1853 | + protected function _get_price_type_selector($ticket_row, $price_row, $price, $default, $disabled = false) |
|
1854 | + { |
|
1855 | + if ($price->is_base_price()) { |
|
1856 | + return $this->_get_base_price_template( |
|
1857 | + $ticket_row, |
|
1858 | + $price_row, |
|
1859 | + $price, |
|
1860 | + $default |
|
1861 | + ); |
|
1862 | + } |
|
1863 | + return $this->_get_price_modifier_template( |
|
1864 | + $ticket_row, |
|
1865 | + $price_row, |
|
1866 | + $price, |
|
1867 | + $default, |
|
1868 | + $disabled |
|
1869 | + ); |
|
1870 | + } |
|
1871 | 1871 | |
1872 | 1872 | |
1873 | - /** |
|
1874 | - * @param int $ticket_row |
|
1875 | - * @param int $price_row |
|
1876 | - * @param EE_Price $price |
|
1877 | - * @param bool $default |
|
1878 | - * @return mixed |
|
1879 | - * @throws DomainException |
|
1880 | - * @throws EE_Error |
|
1881 | - */ |
|
1882 | - protected function _get_base_price_template($ticket_row, $price_row, $price, $default) |
|
1883 | - { |
|
1884 | - $template_args = array( |
|
1885 | - 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
1886 | - 'PRC_order' => $default && empty($price) ? 'PRICENUM' : $price_row, |
|
1887 | - 'PRT_ID' => $default && empty($price) ? 1 : $price->get('PRT_ID'), |
|
1888 | - 'PRT_name' => esc_html__('Price', 'event_espresso'), |
|
1889 | - 'price_selected_operator' => '+', |
|
1890 | - 'price_selected_is_percent' => 0, |
|
1891 | - ); |
|
1892 | - $template_args = apply_filters( |
|
1893 | - 'FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args', |
|
1894 | - $template_args, |
|
1895 | - $ticket_row, |
|
1896 | - $price_row, |
|
1897 | - $price, |
|
1898 | - $default, |
|
1899 | - $this->_is_creating_event |
|
1900 | - ); |
|
1901 | - return EEH_Template::display_template( |
|
1902 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php', |
|
1903 | - $template_args, |
|
1904 | - true |
|
1905 | - ); |
|
1906 | - } |
|
1873 | + /** |
|
1874 | + * @param int $ticket_row |
|
1875 | + * @param int $price_row |
|
1876 | + * @param EE_Price $price |
|
1877 | + * @param bool $default |
|
1878 | + * @return mixed |
|
1879 | + * @throws DomainException |
|
1880 | + * @throws EE_Error |
|
1881 | + */ |
|
1882 | + protected function _get_base_price_template($ticket_row, $price_row, $price, $default) |
|
1883 | + { |
|
1884 | + $template_args = array( |
|
1885 | + 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
1886 | + 'PRC_order' => $default && empty($price) ? 'PRICENUM' : $price_row, |
|
1887 | + 'PRT_ID' => $default && empty($price) ? 1 : $price->get('PRT_ID'), |
|
1888 | + 'PRT_name' => esc_html__('Price', 'event_espresso'), |
|
1889 | + 'price_selected_operator' => '+', |
|
1890 | + 'price_selected_is_percent' => 0, |
|
1891 | + ); |
|
1892 | + $template_args = apply_filters( |
|
1893 | + 'FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args', |
|
1894 | + $template_args, |
|
1895 | + $ticket_row, |
|
1896 | + $price_row, |
|
1897 | + $price, |
|
1898 | + $default, |
|
1899 | + $this->_is_creating_event |
|
1900 | + ); |
|
1901 | + return EEH_Template::display_template( |
|
1902 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php', |
|
1903 | + $template_args, |
|
1904 | + true |
|
1905 | + ); |
|
1906 | + } |
|
1907 | 1907 | |
1908 | 1908 | |
1909 | - /** |
|
1910 | - * @param int $ticket_row |
|
1911 | - * @param int $price_row |
|
1912 | - * @param EE_Price $price |
|
1913 | - * @param bool $default |
|
1914 | - * @param bool $disabled |
|
1915 | - * @return mixed |
|
1916 | - * @throws ReflectionException |
|
1917 | - * @throws InvalidArgumentException |
|
1918 | - * @throws InvalidInterfaceException |
|
1919 | - * @throws InvalidDataTypeException |
|
1920 | - * @throws DomainException |
|
1921 | - * @throws EE_Error |
|
1922 | - */ |
|
1923 | - protected function _get_price_modifier_template( |
|
1924 | - $ticket_row, |
|
1925 | - $price_row, |
|
1926 | - $price, |
|
1927 | - $default, |
|
1928 | - $disabled = false |
|
1929 | - ) { |
|
1930 | - $select_name = $default && ! $price instanceof EE_Price |
|
1931 | - ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' |
|
1932 | - : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]'; |
|
1933 | - /** @var EEM_Price_Type $price_type_model */ |
|
1934 | - $price_type_model = EE_Registry::instance()->load_model('Price_Type'); |
|
1935 | - $price_types = $price_type_model->get_all(array( |
|
1936 | - array( |
|
1937 | - 'OR' => array( |
|
1938 | - 'PBT_ID' => '2', |
|
1939 | - 'PBT_ID*' => '3', |
|
1940 | - ), |
|
1941 | - ), |
|
1942 | - )); |
|
1943 | - $all_price_types = $default && ! $price instanceof EE_Price |
|
1944 | - ? array(esc_html__('Select Modifier', 'event_espresso')) |
|
1945 | - : array(); |
|
1946 | - $selected_price_type_id = $default && ! $price instanceof EE_Price ? 0 : $price->type(); |
|
1947 | - $price_option_spans = ''; |
|
1948 | - // setup price types for selector |
|
1949 | - foreach ($price_types as $price_type) { |
|
1950 | - if (! $price_type instanceof EE_Price_Type) { |
|
1951 | - continue; |
|
1952 | - } |
|
1953 | - $all_price_types[ $price_type->ID() ] = $price_type->get('PRT_name'); |
|
1954 | - // while we're in the loop let's setup the option spans used by js |
|
1955 | - $span_args = array( |
|
1956 | - 'PRT_ID' => $price_type->ID(), |
|
1957 | - 'PRT_operator' => $price_type->is_discount() ? '-' : '+', |
|
1958 | - 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0, |
|
1959 | - ); |
|
1960 | - $price_option_spans .= EEH_Template::display_template( |
|
1961 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php', |
|
1962 | - $span_args, |
|
1963 | - true |
|
1964 | - ); |
|
1965 | - } |
|
1966 | - $select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' |
|
1967 | - : $select_name; |
|
1968 | - $select_input = new EE_Select_Input( |
|
1969 | - $all_price_types, |
|
1970 | - array( |
|
1971 | - 'default' => $selected_price_type_id, |
|
1972 | - 'html_name' => $select_name, |
|
1973 | - 'html_class' => 'edit-price-PRT_ID', |
|
1974 | - 'html_other_attributes' => $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"', |
|
1975 | - ) |
|
1976 | - ); |
|
1977 | - $price_selected_operator = $price instanceof EE_Price && $price->is_discount() ? '-' : '+'; |
|
1978 | - $price_selected_operator = $default && ! $price instanceof EE_Price ? '' : $price_selected_operator; |
|
1979 | - $price_selected_is_percent = $price instanceof EE_Price && $price->is_percent() ? 1 : 0; |
|
1980 | - $price_selected_is_percent = $default && ! $price instanceof EE_Price ? '' : $price_selected_is_percent; |
|
1981 | - $template_args = array( |
|
1982 | - 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
1983 | - 'PRC_order' => $default && ! $price instanceof EE_Price ? 'PRICENUM' : $price_row, |
|
1984 | - 'price_modifier_selector' => $select_input->get_html_for_input(), |
|
1985 | - 'main_name' => $select_name, |
|
1986 | - 'selected_price_type_id' => $selected_price_type_id, |
|
1987 | - 'price_option_spans' => $price_option_spans, |
|
1988 | - 'price_selected_operator' => $price_selected_operator, |
|
1989 | - 'price_selected_is_percent' => $price_selected_is_percent, |
|
1990 | - 'disabled' => $disabled, |
|
1991 | - ); |
|
1992 | - $template_args = apply_filters( |
|
1993 | - 'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args', |
|
1994 | - $template_args, |
|
1995 | - $ticket_row, |
|
1996 | - $price_row, |
|
1997 | - $price, |
|
1998 | - $default, |
|
1999 | - $disabled, |
|
2000 | - $this->_is_creating_event |
|
2001 | - ); |
|
2002 | - return EEH_Template::display_template( |
|
2003 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php', |
|
2004 | - $template_args, |
|
2005 | - true |
|
2006 | - ); |
|
2007 | - } |
|
1909 | + /** |
|
1910 | + * @param int $ticket_row |
|
1911 | + * @param int $price_row |
|
1912 | + * @param EE_Price $price |
|
1913 | + * @param bool $default |
|
1914 | + * @param bool $disabled |
|
1915 | + * @return mixed |
|
1916 | + * @throws ReflectionException |
|
1917 | + * @throws InvalidArgumentException |
|
1918 | + * @throws InvalidInterfaceException |
|
1919 | + * @throws InvalidDataTypeException |
|
1920 | + * @throws DomainException |
|
1921 | + * @throws EE_Error |
|
1922 | + */ |
|
1923 | + protected function _get_price_modifier_template( |
|
1924 | + $ticket_row, |
|
1925 | + $price_row, |
|
1926 | + $price, |
|
1927 | + $default, |
|
1928 | + $disabled = false |
|
1929 | + ) { |
|
1930 | + $select_name = $default && ! $price instanceof EE_Price |
|
1931 | + ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' |
|
1932 | + : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]'; |
|
1933 | + /** @var EEM_Price_Type $price_type_model */ |
|
1934 | + $price_type_model = EE_Registry::instance()->load_model('Price_Type'); |
|
1935 | + $price_types = $price_type_model->get_all(array( |
|
1936 | + array( |
|
1937 | + 'OR' => array( |
|
1938 | + 'PBT_ID' => '2', |
|
1939 | + 'PBT_ID*' => '3', |
|
1940 | + ), |
|
1941 | + ), |
|
1942 | + )); |
|
1943 | + $all_price_types = $default && ! $price instanceof EE_Price |
|
1944 | + ? array(esc_html__('Select Modifier', 'event_espresso')) |
|
1945 | + : array(); |
|
1946 | + $selected_price_type_id = $default && ! $price instanceof EE_Price ? 0 : $price->type(); |
|
1947 | + $price_option_spans = ''; |
|
1948 | + // setup price types for selector |
|
1949 | + foreach ($price_types as $price_type) { |
|
1950 | + if (! $price_type instanceof EE_Price_Type) { |
|
1951 | + continue; |
|
1952 | + } |
|
1953 | + $all_price_types[ $price_type->ID() ] = $price_type->get('PRT_name'); |
|
1954 | + // while we're in the loop let's setup the option spans used by js |
|
1955 | + $span_args = array( |
|
1956 | + 'PRT_ID' => $price_type->ID(), |
|
1957 | + 'PRT_operator' => $price_type->is_discount() ? '-' : '+', |
|
1958 | + 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0, |
|
1959 | + ); |
|
1960 | + $price_option_spans .= EEH_Template::display_template( |
|
1961 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php', |
|
1962 | + $span_args, |
|
1963 | + true |
|
1964 | + ); |
|
1965 | + } |
|
1966 | + $select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' |
|
1967 | + : $select_name; |
|
1968 | + $select_input = new EE_Select_Input( |
|
1969 | + $all_price_types, |
|
1970 | + array( |
|
1971 | + 'default' => $selected_price_type_id, |
|
1972 | + 'html_name' => $select_name, |
|
1973 | + 'html_class' => 'edit-price-PRT_ID', |
|
1974 | + 'html_other_attributes' => $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"', |
|
1975 | + ) |
|
1976 | + ); |
|
1977 | + $price_selected_operator = $price instanceof EE_Price && $price->is_discount() ? '-' : '+'; |
|
1978 | + $price_selected_operator = $default && ! $price instanceof EE_Price ? '' : $price_selected_operator; |
|
1979 | + $price_selected_is_percent = $price instanceof EE_Price && $price->is_percent() ? 1 : 0; |
|
1980 | + $price_selected_is_percent = $default && ! $price instanceof EE_Price ? '' : $price_selected_is_percent; |
|
1981 | + $template_args = array( |
|
1982 | + 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
1983 | + 'PRC_order' => $default && ! $price instanceof EE_Price ? 'PRICENUM' : $price_row, |
|
1984 | + 'price_modifier_selector' => $select_input->get_html_for_input(), |
|
1985 | + 'main_name' => $select_name, |
|
1986 | + 'selected_price_type_id' => $selected_price_type_id, |
|
1987 | + 'price_option_spans' => $price_option_spans, |
|
1988 | + 'price_selected_operator' => $price_selected_operator, |
|
1989 | + 'price_selected_is_percent' => $price_selected_is_percent, |
|
1990 | + 'disabled' => $disabled, |
|
1991 | + ); |
|
1992 | + $template_args = apply_filters( |
|
1993 | + 'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args', |
|
1994 | + $template_args, |
|
1995 | + $ticket_row, |
|
1996 | + $price_row, |
|
1997 | + $price, |
|
1998 | + $default, |
|
1999 | + $disabled, |
|
2000 | + $this->_is_creating_event |
|
2001 | + ); |
|
2002 | + return EEH_Template::display_template( |
|
2003 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php', |
|
2004 | + $template_args, |
|
2005 | + true |
|
2006 | + ); |
|
2007 | + } |
|
2008 | 2008 | |
2009 | 2009 | |
2010 | - /** |
|
2011 | - * @param int $datetime_row |
|
2012 | - * @param int $ticket_row |
|
2013 | - * @param EE_Datetime|null $datetime |
|
2014 | - * @param EE_Ticket|null $ticket |
|
2015 | - * @param array $ticket_datetimes |
|
2016 | - * @param bool $default |
|
2017 | - * @return mixed |
|
2018 | - * @throws DomainException |
|
2019 | - * @throws EE_Error |
|
2020 | - */ |
|
2021 | - protected function _get_ticket_datetime_list_item( |
|
2022 | - $datetime_row, |
|
2023 | - $ticket_row, |
|
2024 | - $datetime, |
|
2025 | - $ticket, |
|
2026 | - $ticket_datetimes = array(), |
|
2027 | - $default |
|
2028 | - ) { |
|
2029 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
2030 | - ? $ticket_datetimes[ $ticket->ID() ] |
|
2031 | - : array(); |
|
2032 | - $template_args = array( |
|
2033 | - 'dtt_row' => $default && ! $datetime instanceof EE_Datetime |
|
2034 | - ? 'DTTNUM' |
|
2035 | - : $datetime_row, |
|
2036 | - 'tkt_row' => $default |
|
2037 | - ? 'TICKETNUM' |
|
2038 | - : $ticket_row, |
|
2039 | - 'ticket_datetime_selected' => in_array($datetime_row, $tkt_datetimes, true) |
|
2040 | - ? ' ticket-selected' |
|
2041 | - : '', |
|
2042 | - 'ticket_datetime_checked' => in_array($datetime_row, $tkt_datetimes, true) |
|
2043 | - ? ' checked="checked"' |
|
2044 | - : '', |
|
2045 | - 'DTT_name' => $default && empty($datetime) |
|
2046 | - ? 'DTTNAME' |
|
2047 | - : $datetime->get_dtt_display_name(true), |
|
2048 | - 'tkt_status_class' => '', |
|
2049 | - ); |
|
2050 | - $template_args = apply_filters( |
|
2051 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args', |
|
2052 | - $template_args, |
|
2053 | - $datetime_row, |
|
2054 | - $ticket_row, |
|
2055 | - $datetime, |
|
2056 | - $ticket, |
|
2057 | - $ticket_datetimes, |
|
2058 | - $default, |
|
2059 | - $this->_is_creating_event |
|
2060 | - ); |
|
2061 | - return EEH_Template::display_template( |
|
2062 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
2063 | - $template_args, |
|
2064 | - true |
|
2065 | - ); |
|
2066 | - } |
|
2010 | + /** |
|
2011 | + * @param int $datetime_row |
|
2012 | + * @param int $ticket_row |
|
2013 | + * @param EE_Datetime|null $datetime |
|
2014 | + * @param EE_Ticket|null $ticket |
|
2015 | + * @param array $ticket_datetimes |
|
2016 | + * @param bool $default |
|
2017 | + * @return mixed |
|
2018 | + * @throws DomainException |
|
2019 | + * @throws EE_Error |
|
2020 | + */ |
|
2021 | + protected function _get_ticket_datetime_list_item( |
|
2022 | + $datetime_row, |
|
2023 | + $ticket_row, |
|
2024 | + $datetime, |
|
2025 | + $ticket, |
|
2026 | + $ticket_datetimes = array(), |
|
2027 | + $default |
|
2028 | + ) { |
|
2029 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
2030 | + ? $ticket_datetimes[ $ticket->ID() ] |
|
2031 | + : array(); |
|
2032 | + $template_args = array( |
|
2033 | + 'dtt_row' => $default && ! $datetime instanceof EE_Datetime |
|
2034 | + ? 'DTTNUM' |
|
2035 | + : $datetime_row, |
|
2036 | + 'tkt_row' => $default |
|
2037 | + ? 'TICKETNUM' |
|
2038 | + : $ticket_row, |
|
2039 | + 'ticket_datetime_selected' => in_array($datetime_row, $tkt_datetimes, true) |
|
2040 | + ? ' ticket-selected' |
|
2041 | + : '', |
|
2042 | + 'ticket_datetime_checked' => in_array($datetime_row, $tkt_datetimes, true) |
|
2043 | + ? ' checked="checked"' |
|
2044 | + : '', |
|
2045 | + 'DTT_name' => $default && empty($datetime) |
|
2046 | + ? 'DTTNAME' |
|
2047 | + : $datetime->get_dtt_display_name(true), |
|
2048 | + 'tkt_status_class' => '', |
|
2049 | + ); |
|
2050 | + $template_args = apply_filters( |
|
2051 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args', |
|
2052 | + $template_args, |
|
2053 | + $datetime_row, |
|
2054 | + $ticket_row, |
|
2055 | + $datetime, |
|
2056 | + $ticket, |
|
2057 | + $ticket_datetimes, |
|
2058 | + $default, |
|
2059 | + $this->_is_creating_event |
|
2060 | + ); |
|
2061 | + return EEH_Template::display_template( |
|
2062 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
2063 | + $template_args, |
|
2064 | + true |
|
2065 | + ); |
|
2066 | + } |
|
2067 | 2067 | |
2068 | 2068 | |
2069 | - /** |
|
2070 | - * @param array $all_datetimes |
|
2071 | - * @param array $all_tickets |
|
2072 | - * @return mixed |
|
2073 | - * @throws ReflectionException |
|
2074 | - * @throws InvalidArgumentException |
|
2075 | - * @throws InvalidInterfaceException |
|
2076 | - * @throws InvalidDataTypeException |
|
2077 | - * @throws DomainException |
|
2078 | - * @throws EE_Error |
|
2079 | - */ |
|
2080 | - protected function _get_ticket_js_structure($all_datetimes = array(), $all_tickets = array()) |
|
2081 | - { |
|
2082 | - $template_args = array( |
|
2083 | - 'default_datetime_edit_row' => $this->_get_dtt_edit_row( |
|
2084 | - 'DTTNUM', |
|
2085 | - null, |
|
2086 | - true, |
|
2087 | - $all_datetimes |
|
2088 | - ), |
|
2089 | - 'default_ticket_row' => $this->_get_ticket_row( |
|
2090 | - 'TICKETNUM', |
|
2091 | - null, |
|
2092 | - array(), |
|
2093 | - array(), |
|
2094 | - true |
|
2095 | - ), |
|
2096 | - 'default_price_row' => $this->_get_ticket_price_row( |
|
2097 | - 'TICKETNUM', |
|
2098 | - 'PRICENUM', |
|
2099 | - null, |
|
2100 | - true, |
|
2101 | - null |
|
2102 | - ), |
|
2103 | - 'default_price_rows' => '', |
|
2104 | - 'default_base_price_amount' => 0, |
|
2105 | - 'default_base_price_name' => '', |
|
2106 | - 'default_base_price_description' => '', |
|
2107 | - 'default_price_modifier_selector_row' => $this->_get_price_modifier_template( |
|
2108 | - 'TICKETNUM', |
|
2109 | - 'PRICENUM', |
|
2110 | - null, |
|
2111 | - true |
|
2112 | - ), |
|
2113 | - 'default_available_tickets_for_datetime' => $this->_get_dtt_attached_tickets_row( |
|
2114 | - 'DTTNUM', |
|
2115 | - null, |
|
2116 | - array(), |
|
2117 | - array(), |
|
2118 | - true |
|
2119 | - ), |
|
2120 | - 'existing_available_datetime_tickets_list' => '', |
|
2121 | - 'existing_available_ticket_datetimes_list' => '', |
|
2122 | - 'new_available_datetime_ticket_list_item' => $this->_get_datetime_tickets_list_item( |
|
2123 | - 'DTTNUM', |
|
2124 | - 'TICKETNUM', |
|
2125 | - null, |
|
2126 | - null, |
|
2127 | - array(), |
|
2128 | - true |
|
2129 | - ), |
|
2130 | - 'new_available_ticket_datetime_list_item' => $this->_get_ticket_datetime_list_item( |
|
2131 | - 'DTTNUM', |
|
2132 | - 'TICKETNUM', |
|
2133 | - null, |
|
2134 | - null, |
|
2135 | - array(), |
|
2136 | - true |
|
2137 | - ), |
|
2138 | - ); |
|
2139 | - $ticket_row = 1; |
|
2140 | - foreach ($all_tickets as $ticket) { |
|
2141 | - $template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
2142 | - 'DTTNUM', |
|
2143 | - $ticket_row, |
|
2144 | - null, |
|
2145 | - $ticket, |
|
2146 | - array(), |
|
2147 | - true |
|
2148 | - ); |
|
2149 | - $ticket_row++; |
|
2150 | - } |
|
2151 | - $datetime_row = 1; |
|
2152 | - foreach ($all_datetimes as $datetime) { |
|
2153 | - $template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
2154 | - $datetime_row, |
|
2155 | - 'TICKETNUM', |
|
2156 | - $datetime, |
|
2157 | - null, |
|
2158 | - array(), |
|
2159 | - true |
|
2160 | - ); |
|
2161 | - $datetime_row++; |
|
2162 | - } |
|
2163 | - /** @var EEM_Price $price_model */ |
|
2164 | - $price_model = EE_Registry::instance()->load_model('Price'); |
|
2165 | - $default_prices = $price_model->get_all_default_prices(); |
|
2166 | - $price_row = 1; |
|
2167 | - foreach ($default_prices as $price) { |
|
2168 | - if (! $price instanceof EE_Price) { |
|
2169 | - continue; |
|
2170 | - } |
|
2171 | - if ($price->is_base_price()) { |
|
2172 | - $template_args['default_base_price_amount'] = $price->get_pretty( |
|
2173 | - 'PRC_amount', |
|
2174 | - 'localized_float' |
|
2175 | - ); |
|
2176 | - $template_args['default_base_price_name'] = $price->get('PRC_name'); |
|
2177 | - $template_args['default_base_price_description'] = $price->get('PRC_desc'); |
|
2178 | - $price_row++; |
|
2179 | - continue; |
|
2180 | - } |
|
2181 | - $show_trash = ! ((count($default_prices) > 1 && $price_row === 1) |
|
2182 | - || count($default_prices) === 1); |
|
2183 | - $show_create = ! (count($default_prices) > 1 |
|
2184 | - && count($default_prices) |
|
2185 | - !== $price_row); |
|
2186 | - $template_args['default_price_rows'] .= $this->_get_ticket_price_row( |
|
2187 | - 'TICKETNUM', |
|
2188 | - $price_row, |
|
2189 | - $price, |
|
2190 | - true, |
|
2191 | - null, |
|
2192 | - $show_trash, |
|
2193 | - $show_create |
|
2194 | - ); |
|
2195 | - $price_row++; |
|
2196 | - } |
|
2197 | - $template_args = apply_filters( |
|
2198 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args', |
|
2199 | - $template_args, |
|
2200 | - $all_datetimes, |
|
2201 | - $all_tickets, |
|
2202 | - $this->_is_creating_event |
|
2203 | - ); |
|
2204 | - return EEH_Template::display_template( |
|
2205 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php', |
|
2206 | - $template_args, |
|
2207 | - true |
|
2208 | - ); |
|
2209 | - } |
|
2069 | + /** |
|
2070 | + * @param array $all_datetimes |
|
2071 | + * @param array $all_tickets |
|
2072 | + * @return mixed |
|
2073 | + * @throws ReflectionException |
|
2074 | + * @throws InvalidArgumentException |
|
2075 | + * @throws InvalidInterfaceException |
|
2076 | + * @throws InvalidDataTypeException |
|
2077 | + * @throws DomainException |
|
2078 | + * @throws EE_Error |
|
2079 | + */ |
|
2080 | + protected function _get_ticket_js_structure($all_datetimes = array(), $all_tickets = array()) |
|
2081 | + { |
|
2082 | + $template_args = array( |
|
2083 | + 'default_datetime_edit_row' => $this->_get_dtt_edit_row( |
|
2084 | + 'DTTNUM', |
|
2085 | + null, |
|
2086 | + true, |
|
2087 | + $all_datetimes |
|
2088 | + ), |
|
2089 | + 'default_ticket_row' => $this->_get_ticket_row( |
|
2090 | + 'TICKETNUM', |
|
2091 | + null, |
|
2092 | + array(), |
|
2093 | + array(), |
|
2094 | + true |
|
2095 | + ), |
|
2096 | + 'default_price_row' => $this->_get_ticket_price_row( |
|
2097 | + 'TICKETNUM', |
|
2098 | + 'PRICENUM', |
|
2099 | + null, |
|
2100 | + true, |
|
2101 | + null |
|
2102 | + ), |
|
2103 | + 'default_price_rows' => '', |
|
2104 | + 'default_base_price_amount' => 0, |
|
2105 | + 'default_base_price_name' => '', |
|
2106 | + 'default_base_price_description' => '', |
|
2107 | + 'default_price_modifier_selector_row' => $this->_get_price_modifier_template( |
|
2108 | + 'TICKETNUM', |
|
2109 | + 'PRICENUM', |
|
2110 | + null, |
|
2111 | + true |
|
2112 | + ), |
|
2113 | + 'default_available_tickets_for_datetime' => $this->_get_dtt_attached_tickets_row( |
|
2114 | + 'DTTNUM', |
|
2115 | + null, |
|
2116 | + array(), |
|
2117 | + array(), |
|
2118 | + true |
|
2119 | + ), |
|
2120 | + 'existing_available_datetime_tickets_list' => '', |
|
2121 | + 'existing_available_ticket_datetimes_list' => '', |
|
2122 | + 'new_available_datetime_ticket_list_item' => $this->_get_datetime_tickets_list_item( |
|
2123 | + 'DTTNUM', |
|
2124 | + 'TICKETNUM', |
|
2125 | + null, |
|
2126 | + null, |
|
2127 | + array(), |
|
2128 | + true |
|
2129 | + ), |
|
2130 | + 'new_available_ticket_datetime_list_item' => $this->_get_ticket_datetime_list_item( |
|
2131 | + 'DTTNUM', |
|
2132 | + 'TICKETNUM', |
|
2133 | + null, |
|
2134 | + null, |
|
2135 | + array(), |
|
2136 | + true |
|
2137 | + ), |
|
2138 | + ); |
|
2139 | + $ticket_row = 1; |
|
2140 | + foreach ($all_tickets as $ticket) { |
|
2141 | + $template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
2142 | + 'DTTNUM', |
|
2143 | + $ticket_row, |
|
2144 | + null, |
|
2145 | + $ticket, |
|
2146 | + array(), |
|
2147 | + true |
|
2148 | + ); |
|
2149 | + $ticket_row++; |
|
2150 | + } |
|
2151 | + $datetime_row = 1; |
|
2152 | + foreach ($all_datetimes as $datetime) { |
|
2153 | + $template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
2154 | + $datetime_row, |
|
2155 | + 'TICKETNUM', |
|
2156 | + $datetime, |
|
2157 | + null, |
|
2158 | + array(), |
|
2159 | + true |
|
2160 | + ); |
|
2161 | + $datetime_row++; |
|
2162 | + } |
|
2163 | + /** @var EEM_Price $price_model */ |
|
2164 | + $price_model = EE_Registry::instance()->load_model('Price'); |
|
2165 | + $default_prices = $price_model->get_all_default_prices(); |
|
2166 | + $price_row = 1; |
|
2167 | + foreach ($default_prices as $price) { |
|
2168 | + if (! $price instanceof EE_Price) { |
|
2169 | + continue; |
|
2170 | + } |
|
2171 | + if ($price->is_base_price()) { |
|
2172 | + $template_args['default_base_price_amount'] = $price->get_pretty( |
|
2173 | + 'PRC_amount', |
|
2174 | + 'localized_float' |
|
2175 | + ); |
|
2176 | + $template_args['default_base_price_name'] = $price->get('PRC_name'); |
|
2177 | + $template_args['default_base_price_description'] = $price->get('PRC_desc'); |
|
2178 | + $price_row++; |
|
2179 | + continue; |
|
2180 | + } |
|
2181 | + $show_trash = ! ((count($default_prices) > 1 && $price_row === 1) |
|
2182 | + || count($default_prices) === 1); |
|
2183 | + $show_create = ! (count($default_prices) > 1 |
|
2184 | + && count($default_prices) |
|
2185 | + !== $price_row); |
|
2186 | + $template_args['default_price_rows'] .= $this->_get_ticket_price_row( |
|
2187 | + 'TICKETNUM', |
|
2188 | + $price_row, |
|
2189 | + $price, |
|
2190 | + true, |
|
2191 | + null, |
|
2192 | + $show_trash, |
|
2193 | + $show_create |
|
2194 | + ); |
|
2195 | + $price_row++; |
|
2196 | + } |
|
2197 | + $template_args = apply_filters( |
|
2198 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args', |
|
2199 | + $template_args, |
|
2200 | + $all_datetimes, |
|
2201 | + $all_tickets, |
|
2202 | + $this->_is_creating_event |
|
2203 | + ); |
|
2204 | + return EEH_Template::display_template( |
|
2205 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php', |
|
2206 | + $template_args, |
|
2207 | + true |
|
2208 | + ); |
|
2209 | + } |
|
2210 | 2210 | } |
@@ -48,7 +48,7 @@ discard block |
||
48 | 48 | { |
49 | 49 | $this->_name = 'pricing'; |
50 | 50 | // capability check |
51 | - if (! EE_Registry::instance()->CAP->current_user_can( |
|
51 | + if ( ! EE_Registry::instance()->CAP->current_user_can( |
|
52 | 52 | 'ee_read_default_prices', |
53 | 53 | 'advanced_ticket_datetime_metabox' |
54 | 54 | )) { |
@@ -148,7 +148,7 @@ discard block |
||
148 | 148 | ); |
149 | 149 | $msg .= '</p><ul>'; |
150 | 150 | foreach ($format_validation as $error) { |
151 | - $msg .= '<li>' . $error . '</li>'; |
|
151 | + $msg .= '<li>'.$error.'</li>'; |
|
152 | 152 | } |
153 | 153 | $msg .= '</ul><p>'; |
154 | 154 | $msg .= sprintf( |
@@ -177,11 +177,11 @@ discard block |
||
177 | 177 | $this->_scripts_styles = array( |
178 | 178 | 'registers' => array( |
179 | 179 | 'ee-tickets-datetimes-css' => array( |
180 | - 'url' => PRICING_ASSETS_URL . 'event-tickets-datetimes.css', |
|
180 | + 'url' => PRICING_ASSETS_URL.'event-tickets-datetimes.css', |
|
181 | 181 | 'type' => 'css', |
182 | 182 | ), |
183 | 183 | 'ee-dtt-ticket-metabox' => array( |
184 | - 'url' => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js', |
|
184 | + 'url' => PRICING_ASSETS_URL.'ee-datetime-ticket-metabox.js', |
|
185 | 185 | 'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'), |
186 | 186 | ), |
187 | 187 | ), |
@@ -205,9 +205,9 @@ discard block |
||
205 | 205 | 'event_espresso' |
206 | 206 | ), |
207 | 207 | 'cancel_button' => '<button class="button-secondary ee-modal-cancel">' |
208 | - . esc_html__('Cancel', 'event_espresso') . '</button>', |
|
208 | + . esc_html__('Cancel', 'event_espresso').'</button>', |
|
209 | 209 | 'close_button' => '<button class="button-secondary ee-modal-cancel">' |
210 | - . esc_html__('Close', 'event_espresso') . '</button>', |
|
210 | + . esc_html__('Close', 'event_espresso').'</button>', |
|
211 | 211 | 'single_warning_from_tkt' => esc_html__( |
212 | 212 | 'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.', |
213 | 213 | 'event_espresso' |
@@ -217,7 +217,7 @@ discard block |
||
217 | 217 | 'event_espresso' |
218 | 218 | ), |
219 | 219 | 'dismiss_button' => '<button class="button-secondary ee-modal-cancel">' |
220 | - . esc_html__('Dismiss', 'event_espresso') . '</button>', |
|
220 | + . esc_html__('Dismiss', 'event_espresso').'</button>', |
|
221 | 221 | ), |
222 | 222 | 'DTT_ERROR_MSG' => array( |
223 | 223 | 'no_ticket_name' => esc_html__('General Admission', 'event_espresso'), |
@@ -255,7 +255,7 @@ discard block |
||
255 | 255 | { |
256 | 256 | foreach ($update_callbacks as $key => $callback) { |
257 | 257 | if ($callback[1] === '_default_tickets_update') { |
258 | - unset($update_callbacks[ $key ]); |
|
258 | + unset($update_callbacks[$key]); |
|
259 | 259 | } |
260 | 260 | } |
261 | 261 | $update_callbacks[] = array($this, 'datetime_and_tickets_caf_update'); |
@@ -313,7 +313,7 @@ discard block |
||
313 | 313 | foreach ($data['edit_event_datetimes'] as $row => $datetime_data) { |
314 | 314 | // trim all values to ensure any excess whitespace is removed. |
315 | 315 | $datetime_data = array_map( |
316 | - function ($datetime_data) { |
|
316 | + function($datetime_data) { |
|
317 | 317 | return is_array($datetime_data) ? $datetime_data : trim($datetime_data); |
318 | 318 | }, |
319 | 319 | $datetime_data |
@@ -343,7 +343,7 @@ discard block |
||
343 | 343 | ); |
344 | 344 | // if we have an id then let's get existing object first and then set the new values. |
345 | 345 | // Otherwise we instantiate a new object for save. |
346 | - if (! empty($datetime_data['DTT_ID'])) { |
|
346 | + if ( ! empty($datetime_data['DTT_ID'])) { |
|
347 | 347 | $datetime = EE_Registry::instance() |
348 | 348 | ->load_model('Datetime', array($timezone)) |
349 | 349 | ->get_one_by_ID($datetime_data['DTT_ID']); |
@@ -357,7 +357,7 @@ discard block |
||
357 | 357 | // after the add_relation_to() the autosave replaces it. |
358 | 358 | // We need to do this so we dont' TRASH the parent DTT. |
359 | 359 | // (save the ID for both key and value to avoid duplications) |
360 | - $saved_dtt_ids[ $datetime->ID() ] = $datetime->ID(); |
|
360 | + $saved_dtt_ids[$datetime->ID()] = $datetime->ID(); |
|
361 | 361 | } else { |
362 | 362 | $datetime = EE_Registry::instance()->load_class( |
363 | 363 | 'Datetime', |
@@ -386,8 +386,8 @@ discard block |
||
386 | 386 | // because it is possible there was a new one created for the autosave. |
387 | 387 | // (save the ID for both key and value to avoid duplications) |
388 | 388 | $DTT_ID = $datetime->ID(); |
389 | - $saved_dtt_ids[ $DTT_ID ] = $DTT_ID; |
|
390 | - $saved_dtt_objs[ $row ] = $datetime; |
|
389 | + $saved_dtt_ids[$DTT_ID] = $DTT_ID; |
|
390 | + $saved_dtt_objs[$row] = $datetime; |
|
391 | 391 | // @todo if ANY of these updates fail then we want the appropriate global error message. |
392 | 392 | } |
393 | 393 | $event->save(); |
@@ -452,13 +452,13 @@ discard block |
||
452 | 452 | $update_prices = $create_new_TKT = false; |
453 | 453 | // figure out what datetimes were added to the ticket |
454 | 454 | // and what datetimes were removed from the ticket in the session. |
455 | - $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][ $row ]); |
|
456 | - $tkt_dtt_rows = explode(',', $data['ticket_datetime_rows'][ $row ]); |
|
455 | + $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][$row]); |
|
456 | + $tkt_dtt_rows = explode(',', $data['ticket_datetime_rows'][$row]); |
|
457 | 457 | $datetimes_added = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows); |
458 | 458 | $datetimes_removed = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows); |
459 | 459 | // trim inputs to ensure any excess whitespace is removed. |
460 | 460 | $tkt = array_map( |
461 | - function ($ticket_data) { |
|
461 | + function($ticket_data) { |
|
462 | 462 | return is_array($ticket_data) ? $ticket_data : trim($ticket_data); |
463 | 463 | }, |
464 | 464 | $tkt |
@@ -480,8 +480,8 @@ discard block |
||
480 | 480 | $base_price_id = isset($tkt['TKT_base_price_ID']) |
481 | 481 | ? $tkt['TKT_base_price_ID'] |
482 | 482 | : 0; |
483 | - $price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][ $row ]) |
|
484 | - ? $data['edit_prices'][ $row ] |
|
483 | + $price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][$row]) |
|
484 | + ? $data['edit_prices'][$row] |
|
485 | 485 | : array(); |
486 | 486 | $now = null; |
487 | 487 | if (empty($tkt['TKT_start_date'])) { |
@@ -493,7 +493,7 @@ discard block |
||
493 | 493 | /** |
494 | 494 | * set the TKT_end_date to the first datetime attached to the ticket. |
495 | 495 | */ |
496 | - $first_dtt = $saved_datetimes[ reset($tkt_dtt_rows) ]; |
|
496 | + $first_dtt = $saved_datetimes[reset($tkt_dtt_rows)]; |
|
497 | 497 | $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_time_format); |
498 | 498 | } |
499 | 499 | $TKT_values = array( |
@@ -628,7 +628,7 @@ discard block |
||
628 | 628 | // need to make sue that the TKT_price is accurate after saving the prices. |
629 | 629 | $ticket->ensure_TKT_Price_correct(); |
630 | 630 | // handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave. |
631 | - if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) { |
|
631 | + if ( ! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) { |
|
632 | 632 | $update_prices = true; |
633 | 633 | $new_default = clone $ticket; |
634 | 634 | $new_default->set('TKT_ID', 0); |
@@ -673,7 +673,7 @@ discard block |
||
673 | 673 | // save new TKT |
674 | 674 | $new_tkt->save(); |
675 | 675 | // add new ticket to array |
676 | - $saved_tickets[ $new_tkt->ID() ] = $new_tkt; |
|
676 | + $saved_tickets[$new_tkt->ID()] = $new_tkt; |
|
677 | 677 | do_action( |
678 | 678 | 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket', |
679 | 679 | $new_tkt, |
@@ -683,7 +683,7 @@ discard block |
||
683 | 683 | ); |
684 | 684 | } else { |
685 | 685 | // add tkt to saved tkts |
686 | - $saved_tickets[ $ticket->ID() ] = $ticket; |
|
686 | + $saved_tickets[$ticket->ID()] = $ticket; |
|
687 | 687 | do_action( |
688 | 688 | 'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket', |
689 | 689 | $ticket, |
@@ -750,33 +750,33 @@ discard block |
||
750 | 750 | // to start we have to add the ticket to all the datetimes its supposed to be with, |
751 | 751 | // and removing the ticket from datetimes it got removed from. |
752 | 752 | // first let's add datetimes |
753 | - if (! empty($added_datetimes) && is_array($added_datetimes)) { |
|
753 | + if ( ! empty($added_datetimes) && is_array($added_datetimes)) { |
|
754 | 754 | foreach ($added_datetimes as $row_id) { |
755 | 755 | $row_id = (int) $row_id; |
756 | - if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
757 | - $ticket->_add_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
756 | + if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) { |
|
757 | + $ticket->_add_relation_to($saved_datetimes[$row_id], 'Datetime'); |
|
758 | 758 | // Is this an existing ticket (has an ID) and does it have any sold? |
759 | 759 | // If so, then we need to add that to the DTT sold because this DTT is getting added. |
760 | 760 | if ($ticket->ID() && $ticket->sold() > 0) { |
761 | - $saved_datetimes[ $row_id ]->increase_sold($ticket->sold()); |
|
762 | - $saved_datetimes[ $row_id ]->save(); |
|
761 | + $saved_datetimes[$row_id]->increase_sold($ticket->sold()); |
|
762 | + $saved_datetimes[$row_id]->save(); |
|
763 | 763 | } |
764 | 764 | } |
765 | 765 | } |
766 | 766 | } |
767 | 767 | // then remove datetimes |
768 | - if (! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
768 | + if ( ! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
769 | 769 | foreach ($removed_datetimes as $row_id) { |
770 | 770 | $row_id = (int) $row_id; |
771 | 771 | // its entirely possible that a datetime got deleted (instead of just removed from relationship. |
772 | 772 | // So make sure we skip over this if the dtt isn't in the $saved_datetimes array) |
773 | - if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
774 | - $ticket->_remove_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
773 | + if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) { |
|
774 | + $ticket->_remove_relation_to($saved_datetimes[$row_id], 'Datetime'); |
|
775 | 775 | // Is this an existing ticket (has an ID) and does it have any sold? |
776 | 776 | // If so, then we need to remove it's sold from the DTT_sold. |
777 | 777 | if ($ticket->ID() && $ticket->sold() > 0) { |
778 | - $saved_datetimes[ $row_id ]->decrease_sold($ticket->sold()); |
|
779 | - $saved_datetimes[ $row_id ]->save(); |
|
778 | + $saved_datetimes[$row_id]->decrease_sold($ticket->sold()); |
|
779 | + $saved_datetimes[$row_id]->save(); |
|
780 | 780 | } |
781 | 781 | } |
782 | 782 | } |
@@ -889,7 +889,7 @@ discard block |
||
889 | 889 | ); |
890 | 890 | } |
891 | 891 | // possibly need to save tkt |
892 | - if (! $ticket->ID()) { |
|
892 | + if ( ! $ticket->ID()) { |
|
893 | 893 | $ticket->save(); |
894 | 894 | } |
895 | 895 | foreach ($prices as $row => $prc) { |
@@ -923,17 +923,17 @@ discard block |
||
923 | 923 | } |
924 | 924 | } |
925 | 925 | $price->save(); |
926 | - $updated_prices[ $price->ID() ] = $price; |
|
926 | + $updated_prices[$price->ID()] = $price; |
|
927 | 927 | $ticket->_add_relation_to($price, 'Price'); |
928 | 928 | } |
929 | 929 | // now let's remove any prices that got removed from the ticket |
930 | - if (! empty($current_prices_on_ticket)) { |
|
930 | + if ( ! empty($current_prices_on_ticket)) { |
|
931 | 931 | $current = array_keys($current_prices_on_ticket); |
932 | 932 | $updated = array_keys($updated_prices); |
933 | 933 | $prices_to_remove = array_diff($current, $updated); |
934 | - if (! empty($prices_to_remove)) { |
|
934 | + if ( ! empty($prices_to_remove)) { |
|
935 | 935 | foreach ($prices_to_remove as $prc_id) { |
936 | - $p = $current_prices_on_ticket[ $prc_id ]; |
|
936 | + $p = $current_prices_on_ticket[$prc_id]; |
|
937 | 937 | $ticket->_remove_relation_to($p, 'Price'); |
938 | 938 | // delete permanently the price |
939 | 939 | $p->delete_permanently(); |
@@ -1084,17 +1084,17 @@ discard block |
||
1084 | 1084 | $TKT_ID = $ticket->get('TKT_ID'); |
1085 | 1085 | $ticket_row = $ticket->get('TKT_row'); |
1086 | 1086 | // we only want unique tickets in our final display!! |
1087 | - if (! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
1087 | + if ( ! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
1088 | 1088 | $existing_ticket_ids[] = $TKT_ID; |
1089 | 1089 | $all_tickets[] = $ticket; |
1090 | 1090 | } |
1091 | 1091 | // temporary cache of this ticket info for this datetime for later processing of datetime rows. |
1092 | - $datetime_tickets[ $DTT_ID ][] = $ticket_row; |
|
1092 | + $datetime_tickets[$DTT_ID][] = $ticket_row; |
|
1093 | 1093 | // temporary cache of this datetime info for this ticket for later processing of ticket rows. |
1094 | - if (! isset($ticket_datetimes[ $TKT_ID ]) |
|
1095 | - || ! in_array($datetime_row, $ticket_datetimes[ $TKT_ID ], true) |
|
1094 | + if ( ! isset($ticket_datetimes[$TKT_ID]) |
|
1095 | + || ! in_array($datetime_row, $ticket_datetimes[$TKT_ID], true) |
|
1096 | 1096 | ) { |
1097 | - $ticket_datetimes[ $TKT_ID ][] = $datetime_row; |
|
1097 | + $ticket_datetimes[$TKT_ID][] = $datetime_row; |
|
1098 | 1098 | } |
1099 | 1099 | } |
1100 | 1100 | $datetime_row++; |
@@ -1105,7 +1105,7 @@ discard block |
||
1105 | 1105 | // sort $all_tickets by order |
1106 | 1106 | usort( |
1107 | 1107 | $all_tickets, |
1108 | - function (EE_Ticket $a, EE_Ticket $b) { |
|
1108 | + function(EE_Ticket $a, EE_Ticket $b) { |
|
1109 | 1109 | $a_order = (int) $a->get('TKT_order'); |
1110 | 1110 | $b_order = (int) $b->get('TKT_order'); |
1111 | 1111 | if ($a_order === $b_order) { |
@@ -1143,7 +1143,7 @@ discard block |
||
1143 | 1143 | } |
1144 | 1144 | $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets); |
1145 | 1145 | EEH_Template::display_template( |
1146 | - PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php', |
|
1146 | + PRICING_TEMPLATE_PATH.'event_tickets_metabox_main.template.php', |
|
1147 | 1147 | $main_template_args |
1148 | 1148 | ); |
1149 | 1149 | } |
@@ -1185,7 +1185,7 @@ discard block |
||
1185 | 1185 | 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
1186 | 1186 | ); |
1187 | 1187 | return EEH_Template::display_template( |
1188 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php', |
|
1188 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_row_wrapper.template.php', |
|
1189 | 1189 | $dtt_display_template_args, |
1190 | 1190 | true |
1191 | 1191 | ); |
@@ -1254,7 +1254,7 @@ discard block |
||
1254 | 1254 | $this->_is_creating_event |
1255 | 1255 | ); |
1256 | 1256 | return EEH_Template::display_template( |
1257 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php', |
|
1257 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_edit_row.template.php', |
|
1258 | 1258 | $template_args, |
1259 | 1259 | true |
1260 | 1260 | ); |
@@ -1295,7 +1295,7 @@ discard block |
||
1295 | 1295 | 'DTT_ID' => $default ? '' : $datetime->ID(), |
1296 | 1296 | ); |
1297 | 1297 | // need to setup the list items (but only if this isn't a default skeleton setup) |
1298 | - if (! $default) { |
|
1298 | + if ( ! $default) { |
|
1299 | 1299 | $ticket_row = 1; |
1300 | 1300 | foreach ($all_tickets as $ticket) { |
1301 | 1301 | $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
@@ -1321,7 +1321,7 @@ discard block |
||
1321 | 1321 | $this->_is_creating_event |
1322 | 1322 | ); |
1323 | 1323 | return EEH_Template::display_template( |
1324 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php', |
|
1324 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_attached_tickets_row.template.php', |
|
1325 | 1325 | $template_args, |
1326 | 1326 | true |
1327 | 1327 | ); |
@@ -1347,8 +1347,8 @@ discard block |
||
1347 | 1347 | $datetime_tickets = array(), |
1348 | 1348 | $default |
1349 | 1349 | ) { |
1350 | - $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[ $datetime->ID() ]) |
|
1351 | - ? $datetime_tickets[ $datetime->ID() ] |
|
1350 | + $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[$datetime->ID()]) |
|
1351 | + ? $datetime_tickets[$datetime->ID()] |
|
1352 | 1352 | : array(); |
1353 | 1353 | $display_row = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0; |
1354 | 1354 | $no_ticket = $default && empty($ticket); |
@@ -1369,8 +1369,8 @@ discard block |
||
1369 | 1369 | ? 'TKTNAME' |
1370 | 1370 | : $ticket->get('TKT_name'), |
1371 | 1371 | 'tkt_status_class' => $no_ticket || $this->_is_creating_event |
1372 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
1373 | - : ' tkt-status-' . $ticket->ticket_status(), |
|
1372 | + ? ' tkt-status-'.EE_Ticket::onsale |
|
1373 | + : ' tkt-status-'.$ticket->ticket_status(), |
|
1374 | 1374 | ); |
1375 | 1375 | // filter template args |
1376 | 1376 | $template_args = apply_filters( |
@@ -1385,7 +1385,7 @@ discard block |
||
1385 | 1385 | $this->_is_creating_event |
1386 | 1386 | ); |
1387 | 1387 | return EEH_Template::display_template( |
1388 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php', |
|
1388 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_dtt_tickets_list.template.php', |
|
1389 | 1389 | $template_args, |
1390 | 1390 | true |
1391 | 1391 | ); |
@@ -1441,19 +1441,19 @@ discard block |
||
1441 | 1441 | // (otherwise there won't be any new relationships created for tickets based off of the default ticket). |
1442 | 1442 | // This will future proof in case there is ever any behaviour change between what the primary_key defaults to. |
1443 | 1443 | $default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->is_default()); |
1444 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
1445 | - ? $ticket_datetimes[ $ticket->ID() ] |
|
1444 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) |
|
1445 | + ? $ticket_datetimes[$ticket->ID()] |
|
1446 | 1446 | : array(); |
1447 | 1447 | $ticket_subtotal = $default ? 0 : $ticket->get_ticket_subtotal(); |
1448 | 1448 | $base_price = $default ? null : $ticket->base_price(); |
1449 | 1449 | $count_price_mods = EEM_Price::instance()->get_all_default_prices(true); |
1450 | 1450 | // breaking out complicated condition for ticket_status |
1451 | 1451 | if ($default) { |
1452 | - $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale; |
|
1452 | + $ticket_status_class = ' tkt-status-'.EE_Ticket::onsale; |
|
1453 | 1453 | } else { |
1454 | 1454 | $ticket_status_class = $ticket->is_default() |
1455 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
1456 | - : ' tkt-status-' . $ticket->ticket_status(); |
|
1455 | + ? ' tkt-status-'.EE_Ticket::onsale |
|
1456 | + : ' tkt-status-'.$ticket->ticket_status(); |
|
1457 | 1457 | } |
1458 | 1458 | // breaking out complicated condition for TKT_taxable |
1459 | 1459 | if ($default) { |
@@ -1545,7 +1545,7 @@ discard block |
||
1545 | 1545 | : ' style="display:none;"', |
1546 | 1546 | 'show_price_mod_button' => count($prices) > 1 |
1547 | 1547 | || ($default && $count_price_mods > 0) |
1548 | - || (! $default && $ticket->deleted()) |
|
1548 | + || ( ! $default && $ticket->deleted()) |
|
1549 | 1549 | ? ' style="display:none;"' |
1550 | 1550 | : '', |
1551 | 1551 | 'total_price_rows' => count($prices) > 1 ? count($prices) : 1, |
@@ -1589,7 +1589,7 @@ discard block |
||
1589 | 1589 | $this->_date_time_format, |
1590 | 1590 | current_time('timestamp') |
1591 | 1591 | ); |
1592 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
1592 | + $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale; |
|
1593 | 1593 | } |
1594 | 1594 | if (empty($template_args['TKT_end_date'])) { |
1595 | 1595 | // get the earliest datetime (if present); |
@@ -1599,7 +1599,7 @@ discard block |
||
1599 | 1599 | array('order_by' => array('DTT_EVT_start' => 'ASC')) |
1600 | 1600 | ) |
1601 | 1601 | : null; |
1602 | - if (! empty($earliest_dtt)) { |
|
1602 | + if ( ! empty($earliest_dtt)) { |
|
1603 | 1603 | $template_args['TKT_end_date'] = $earliest_dtt->get_datetime( |
1604 | 1604 | 'DTT_EVT_start', |
1605 | 1605 | $this->_date_time_format |
@@ -1618,10 +1618,10 @@ discard block |
||
1618 | 1618 | ) |
1619 | 1619 | ); |
1620 | 1620 | } |
1621 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
1621 | + $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale; |
|
1622 | 1622 | } |
1623 | 1623 | // generate ticket_datetime items |
1624 | - if (! $default) { |
|
1624 | + if ( ! $default) { |
|
1625 | 1625 | $datetime_row = 1; |
1626 | 1626 | foreach ($all_datetimes as $datetime) { |
1627 | 1627 | $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
@@ -1637,7 +1637,7 @@ discard block |
||
1637 | 1637 | } |
1638 | 1638 | $price_row = 1; |
1639 | 1639 | foreach ($prices as $price) { |
1640 | - if (! $price instanceof EE_Price) { |
|
1640 | + if ( ! $price instanceof EE_Price) { |
|
1641 | 1641 | continue; |
1642 | 1642 | } |
1643 | 1643 | if ($price->is_base_price()) { |
@@ -1670,7 +1670,7 @@ discard block |
||
1670 | 1670 | $this->_is_creating_event |
1671 | 1671 | ); |
1672 | 1672 | return EEH_Template::display_template( |
1673 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php', |
|
1673 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_row.template.php', |
|
1674 | 1674 | $template_args, |
1675 | 1675 | true |
1676 | 1676 | ); |
@@ -1710,7 +1710,7 @@ discard block |
||
1710 | 1710 | $this->_is_creating_event |
1711 | 1711 | ); |
1712 | 1712 | $tax_rows .= EEH_Template::display_template( |
1713 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php', |
|
1713 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_tax_row.template.php', |
|
1714 | 1714 | $template_args, |
1715 | 1715 | true |
1716 | 1716 | ); |
@@ -1829,7 +1829,7 @@ discard block |
||
1829 | 1829 | $this->_is_creating_event |
1830 | 1830 | ); |
1831 | 1831 | return EEH_Template::display_template( |
1832 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php', |
|
1832 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_price_row.template.php', |
|
1833 | 1833 | $template_args, |
1834 | 1834 | true |
1835 | 1835 | ); |
@@ -1899,7 +1899,7 @@ discard block |
||
1899 | 1899 | $this->_is_creating_event |
1900 | 1900 | ); |
1901 | 1901 | return EEH_Template::display_template( |
1902 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php', |
|
1902 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_type_base.template.php', |
|
1903 | 1903 | $template_args, |
1904 | 1904 | true |
1905 | 1905 | ); |
@@ -1929,7 +1929,7 @@ discard block |
||
1929 | 1929 | ) { |
1930 | 1930 | $select_name = $default && ! $price instanceof EE_Price |
1931 | 1931 | ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' |
1932 | - : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]'; |
|
1932 | + : 'edit_prices['.$ticket_row.']['.$price_row.'][PRT_ID]'; |
|
1933 | 1933 | /** @var EEM_Price_Type $price_type_model */ |
1934 | 1934 | $price_type_model = EE_Registry::instance()->load_model('Price_Type'); |
1935 | 1935 | $price_types = $price_type_model->get_all(array( |
@@ -1947,10 +1947,10 @@ discard block |
||
1947 | 1947 | $price_option_spans = ''; |
1948 | 1948 | // setup price types for selector |
1949 | 1949 | foreach ($price_types as $price_type) { |
1950 | - if (! $price_type instanceof EE_Price_Type) { |
|
1950 | + if ( ! $price_type instanceof EE_Price_Type) { |
|
1951 | 1951 | continue; |
1952 | 1952 | } |
1953 | - $all_price_types[ $price_type->ID() ] = $price_type->get('PRT_name'); |
|
1953 | + $all_price_types[$price_type->ID()] = $price_type->get('PRT_name'); |
|
1954 | 1954 | // while we're in the loop let's setup the option spans used by js |
1955 | 1955 | $span_args = array( |
1956 | 1956 | 'PRT_ID' => $price_type->ID(), |
@@ -1958,12 +1958,12 @@ discard block |
||
1958 | 1958 | 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0, |
1959 | 1959 | ); |
1960 | 1960 | $price_option_spans .= EEH_Template::display_template( |
1961 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php', |
|
1961 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_option_span.template.php', |
|
1962 | 1962 | $span_args, |
1963 | 1963 | true |
1964 | 1964 | ); |
1965 | 1965 | } |
1966 | - $select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' |
|
1966 | + $select_name = $disabled ? 'archive_price['.$ticket_row.']['.$price_row.'][PRT_ID]' |
|
1967 | 1967 | : $select_name; |
1968 | 1968 | $select_input = new EE_Select_Input( |
1969 | 1969 | $all_price_types, |
@@ -2000,7 +2000,7 @@ discard block |
||
2000 | 2000 | $this->_is_creating_event |
2001 | 2001 | ); |
2002 | 2002 | return EEH_Template::display_template( |
2003 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php', |
|
2003 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_modifier_selector.template.php', |
|
2004 | 2004 | $template_args, |
2005 | 2005 | true |
2006 | 2006 | ); |
@@ -2026,8 +2026,8 @@ discard block |
||
2026 | 2026 | $ticket_datetimes = array(), |
2027 | 2027 | $default |
2028 | 2028 | ) { |
2029 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
2030 | - ? $ticket_datetimes[ $ticket->ID() ] |
|
2029 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) |
|
2030 | + ? $ticket_datetimes[$ticket->ID()] |
|
2031 | 2031 | : array(); |
2032 | 2032 | $template_args = array( |
2033 | 2033 | 'dtt_row' => $default && ! $datetime instanceof EE_Datetime |
@@ -2059,7 +2059,7 @@ discard block |
||
2059 | 2059 | $this->_is_creating_event |
2060 | 2060 | ); |
2061 | 2061 | return EEH_Template::display_template( |
2062 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
2062 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
2063 | 2063 | $template_args, |
2064 | 2064 | true |
2065 | 2065 | ); |
@@ -2165,7 +2165,7 @@ discard block |
||
2165 | 2165 | $default_prices = $price_model->get_all_default_prices(); |
2166 | 2166 | $price_row = 1; |
2167 | 2167 | foreach ($default_prices as $price) { |
2168 | - if (! $price instanceof EE_Price) { |
|
2168 | + if ( ! $price instanceof EE_Price) { |
|
2169 | 2169 | continue; |
2170 | 2170 | } |
2171 | 2171 | if ($price->is_base_price()) { |
@@ -2202,7 +2202,7 @@ discard block |
||
2202 | 2202 | $this->_is_creating_event |
2203 | 2203 | ); |
2204 | 2204 | return EEH_Template::display_template( |
2205 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php', |
|
2205 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_js_structure.template.php', |
|
2206 | 2206 | $template_args, |
2207 | 2207 | true |
2208 | 2208 | ); |