@@ -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__( |
@@ -25,316 +25,316 @@ |
||
25 | 25 | class PersistentAdminNotice implements RequiresCapCheckInterface |
26 | 26 | { |
27 | 27 | |
28 | - /** |
|
29 | - * @var string $name |
|
30 | - */ |
|
31 | - protected $name = ''; |
|
32 | - |
|
33 | - /** |
|
34 | - * @var string $message |
|
35 | - */ |
|
36 | - protected $message = ''; |
|
37 | - |
|
38 | - /** |
|
39 | - * @var boolean $force_update |
|
40 | - */ |
|
41 | - protected $force_update = false; |
|
42 | - |
|
43 | - /** |
|
44 | - * @var string $capability |
|
45 | - */ |
|
46 | - protected $capability = 'manage_options'; |
|
47 | - |
|
48 | - /** |
|
49 | - * @var string $cap_context |
|
50 | - */ |
|
51 | - protected $cap_context = 'view persistent admin notice'; |
|
52 | - |
|
53 | - /** |
|
54 | - * @var boolean $dismissed |
|
55 | - */ |
|
56 | - protected $dismissed = false; |
|
57 | - |
|
58 | - /** |
|
59 | - * @var CapCheckInterface $cap_check |
|
60 | - */ |
|
61 | - protected $cap_check; |
|
62 | - |
|
63 | - /** |
|
64 | - * if true, then this notice will be deleted from the database |
|
65 | - * |
|
66 | - * @var boolean $purge |
|
67 | - */ |
|
68 | - protected $purge = false; |
|
69 | - |
|
70 | - /** |
|
71 | - * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager |
|
72 | - * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer |
|
73 | - * |
|
74 | - * @var boolean $registered |
|
75 | - */ |
|
76 | - private $registered = false; |
|
77 | - |
|
78 | - |
|
79 | - /** |
|
80 | - * PersistentAdminNotice constructor |
|
81 | - * |
|
82 | - * @param string $name [required] the name, or key of the Persistent Admin Notice to be stored |
|
83 | - * @param string $message [required] the message to be stored persistently until dismissed |
|
84 | - * @param bool $force_update enforce the reappearance of a persistent message |
|
85 | - * @param string $capability user capability required to view this notice |
|
86 | - * @param string $cap_context description for why the cap check is being performed |
|
87 | - * @param bool $dismissed whether or not the user has already dismissed/viewed this notice |
|
88 | - * @throws InvalidDataTypeException |
|
89 | - */ |
|
90 | - public function __construct( |
|
91 | - $name, |
|
92 | - $message, |
|
93 | - $force_update = false, |
|
94 | - $capability = 'manage_options', |
|
95 | - $cap_context = 'view persistent admin notice', |
|
96 | - $dismissed = false |
|
97 | - ) { |
|
98 | - $this->setName($name); |
|
99 | - $this->setMessage($message); |
|
100 | - $this->setForceUpdate($force_update); |
|
101 | - $this->setCapability($capability); |
|
102 | - $this->setCapContext($cap_context); |
|
103 | - $this->setDismissed($dismissed); |
|
104 | - add_action( |
|
105 | - 'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices', |
|
106 | - array($this, 'registerPersistentAdminNotice') |
|
107 | - ); |
|
108 | - add_action('shutdown', array($this, 'confirmRegistered'), 999); |
|
109 | - } |
|
110 | - |
|
111 | - |
|
112 | - /** |
|
113 | - * @return string |
|
114 | - */ |
|
115 | - public function getName() |
|
116 | - { |
|
117 | - return $this->name; |
|
118 | - } |
|
119 | - |
|
120 | - |
|
121 | - /** |
|
122 | - * @param string $name |
|
123 | - * @throws InvalidDataTypeException |
|
124 | - */ |
|
125 | - private function setName($name) |
|
126 | - { |
|
127 | - if (! is_string($name)) { |
|
128 | - throw new InvalidDataTypeException('$name', $name, 'string'); |
|
129 | - } |
|
130 | - $this->name = sanitize_key($name); |
|
131 | - } |
|
132 | - |
|
133 | - |
|
134 | - /** |
|
135 | - * @return string |
|
136 | - */ |
|
137 | - public function getMessage() |
|
138 | - { |
|
139 | - return $this->message; |
|
140 | - } |
|
141 | - |
|
142 | - |
|
143 | - /** |
|
144 | - * @param string $message |
|
145 | - * @throws InvalidDataTypeException |
|
146 | - */ |
|
147 | - private function setMessage($message) |
|
148 | - { |
|
149 | - if (! is_string($message)) { |
|
150 | - throw new InvalidDataTypeException('$message', $message, 'string'); |
|
151 | - } |
|
152 | - global $allowedtags; |
|
153 | - $allowedtags['br'] = array(); |
|
154 | - $this->message = wp_kses($message, $allowedtags); |
|
155 | - } |
|
156 | - |
|
157 | - |
|
158 | - /** |
|
159 | - * @return bool |
|
160 | - */ |
|
161 | - public function getForceUpdate() |
|
162 | - { |
|
163 | - return $this->force_update; |
|
164 | - } |
|
165 | - |
|
166 | - |
|
167 | - /** |
|
168 | - * @param bool $force_update |
|
169 | - */ |
|
170 | - private function setForceUpdate($force_update) |
|
171 | - { |
|
172 | - $this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN); |
|
173 | - } |
|
174 | - |
|
175 | - |
|
176 | - /** |
|
177 | - * @return string |
|
178 | - */ |
|
179 | - public function getCapability() |
|
180 | - { |
|
181 | - return $this->capability; |
|
182 | - } |
|
183 | - |
|
184 | - |
|
185 | - /** |
|
186 | - * @param string $capability |
|
187 | - * @throws InvalidDataTypeException |
|
188 | - */ |
|
189 | - private function setCapability($capability) |
|
190 | - { |
|
191 | - if (! is_string($capability)) { |
|
192 | - throw new InvalidDataTypeException('$capability', $capability, 'string'); |
|
193 | - } |
|
194 | - $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
|
195 | - } |
|
196 | - |
|
197 | - |
|
198 | - /** |
|
199 | - * @return string |
|
200 | - */ |
|
201 | - public function getCapContext() |
|
202 | - { |
|
203 | - return $this->cap_context; |
|
204 | - } |
|
205 | - |
|
206 | - |
|
207 | - /** |
|
208 | - * @param string $cap_context |
|
209 | - * @throws InvalidDataTypeException |
|
210 | - */ |
|
211 | - private function setCapContext($cap_context) |
|
212 | - { |
|
213 | - if (! is_string($cap_context)) { |
|
214 | - throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
|
215 | - } |
|
216 | - $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
|
217 | - } |
|
218 | - |
|
219 | - |
|
220 | - /** |
|
221 | - * @return bool |
|
222 | - */ |
|
223 | - public function getDismissed() |
|
224 | - { |
|
225 | - return $this->dismissed; |
|
226 | - } |
|
227 | - |
|
228 | - |
|
229 | - /** |
|
230 | - * @param bool $dismissed |
|
231 | - */ |
|
232 | - public function setDismissed($dismissed) |
|
233 | - { |
|
234 | - $this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN); |
|
235 | - } |
|
236 | - |
|
237 | - |
|
238 | - /** |
|
239 | - * @return CapCheckInterface |
|
240 | - * @throws InvalidDataTypeException |
|
241 | - */ |
|
242 | - public function getCapCheck() |
|
243 | - { |
|
244 | - if (! $this->cap_check instanceof CapCheckInterface) { |
|
245 | - $this->setCapCheck( |
|
246 | - new CapCheck( |
|
247 | - $this->capability, |
|
248 | - $this->cap_context |
|
249 | - ) |
|
250 | - ); |
|
251 | - } |
|
252 | - return $this->cap_check; |
|
253 | - } |
|
254 | - |
|
255 | - |
|
256 | - /** |
|
257 | - * @param CapCheckInterface $cap_check |
|
258 | - */ |
|
259 | - private function setCapCheck(CapCheckInterface $cap_check) |
|
260 | - { |
|
261 | - $this->cap_check = $cap_check; |
|
262 | - } |
|
263 | - |
|
264 | - |
|
265 | - /** |
|
266 | - * @return bool |
|
267 | - */ |
|
268 | - public function getPurge() |
|
269 | - { |
|
270 | - return $this->purge; |
|
271 | - } |
|
272 | - |
|
273 | - |
|
274 | - /** |
|
275 | - * @param bool $purge |
|
276 | - */ |
|
277 | - public function setPurge($purge) |
|
278 | - { |
|
279 | - $this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN); |
|
280 | - } |
|
281 | - |
|
282 | - |
|
283 | - /** |
|
284 | - * given a valid PersistentAdminNotice Collection, |
|
285 | - * this notice will be added if it is not already found in the collection (using its name as the identifier) |
|
286 | - * if an existing notice is found that has already been dismissed, |
|
287 | - * but we are overriding with a forced update, then we will toggle its dismissed state, |
|
288 | - * so that the notice is displayed again |
|
289 | - * |
|
290 | - * @param Collection $persistent_admin_notice_collection |
|
291 | - * @throws InvalidEntityException |
|
292 | - * @throws InvalidDataTypeException |
|
293 | - * @throws DuplicateCollectionIdentifierException |
|
294 | - */ |
|
295 | - public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection) |
|
296 | - { |
|
297 | - if ($this->registered) { |
|
298 | - return; |
|
299 | - } |
|
300 | - // first check if this notice has already been added to the collection |
|
301 | - if ($persistent_admin_notice_collection->has($this->name)) { |
|
302 | - /** @var PersistentAdminNotice $existing */ |
|
303 | - $existing = $persistent_admin_notice_collection->get($this->name); |
|
304 | - // we don't need to add it again (we can't actually) |
|
305 | - // but if it has already been dismissed, and we are overriding with a forced update |
|
306 | - if ($existing->getDismissed() && $this->getForceUpdate()) { |
|
307 | - // then toggle the notice's dismissed state to true |
|
308 | - // so that it gets displayed again |
|
309 | - $existing->setDismissed(false); |
|
310 | - // and make sure the message is set |
|
311 | - $existing->setMessage($this->message); |
|
312 | - } |
|
313 | - } else { |
|
314 | - $persistent_admin_notice_collection->add($this, $this->name); |
|
315 | - } |
|
316 | - $this->registered = true; |
|
317 | - } |
|
318 | - |
|
319 | - |
|
320 | - /** |
|
321 | - * @throws Exception |
|
322 | - */ |
|
323 | - public function confirmRegistered() |
|
324 | - { |
|
325 | - if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
326 | - PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
|
327 | - } |
|
328 | - if (! $this->registered && WP_DEBUG) { |
|
329 | - throw new DomainException( |
|
330 | - sprintf( |
|
331 | - esc_html__( |
|
332 | - '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.', |
|
333 | - 'event_espresso' |
|
334 | - ), |
|
335 | - $this->name |
|
336 | - ) |
|
337 | - ); |
|
338 | - } |
|
339 | - } |
|
28 | + /** |
|
29 | + * @var string $name |
|
30 | + */ |
|
31 | + protected $name = ''; |
|
32 | + |
|
33 | + /** |
|
34 | + * @var string $message |
|
35 | + */ |
|
36 | + protected $message = ''; |
|
37 | + |
|
38 | + /** |
|
39 | + * @var boolean $force_update |
|
40 | + */ |
|
41 | + protected $force_update = false; |
|
42 | + |
|
43 | + /** |
|
44 | + * @var string $capability |
|
45 | + */ |
|
46 | + protected $capability = 'manage_options'; |
|
47 | + |
|
48 | + /** |
|
49 | + * @var string $cap_context |
|
50 | + */ |
|
51 | + protected $cap_context = 'view persistent admin notice'; |
|
52 | + |
|
53 | + /** |
|
54 | + * @var boolean $dismissed |
|
55 | + */ |
|
56 | + protected $dismissed = false; |
|
57 | + |
|
58 | + /** |
|
59 | + * @var CapCheckInterface $cap_check |
|
60 | + */ |
|
61 | + protected $cap_check; |
|
62 | + |
|
63 | + /** |
|
64 | + * if true, then this notice will be deleted from the database |
|
65 | + * |
|
66 | + * @var boolean $purge |
|
67 | + */ |
|
68 | + protected $purge = false; |
|
69 | + |
|
70 | + /** |
|
71 | + * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager |
|
72 | + * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer |
|
73 | + * |
|
74 | + * @var boolean $registered |
|
75 | + */ |
|
76 | + private $registered = false; |
|
77 | + |
|
78 | + |
|
79 | + /** |
|
80 | + * PersistentAdminNotice constructor |
|
81 | + * |
|
82 | + * @param string $name [required] the name, or key of the Persistent Admin Notice to be stored |
|
83 | + * @param string $message [required] the message to be stored persistently until dismissed |
|
84 | + * @param bool $force_update enforce the reappearance of a persistent message |
|
85 | + * @param string $capability user capability required to view this notice |
|
86 | + * @param string $cap_context description for why the cap check is being performed |
|
87 | + * @param bool $dismissed whether or not the user has already dismissed/viewed this notice |
|
88 | + * @throws InvalidDataTypeException |
|
89 | + */ |
|
90 | + public function __construct( |
|
91 | + $name, |
|
92 | + $message, |
|
93 | + $force_update = false, |
|
94 | + $capability = 'manage_options', |
|
95 | + $cap_context = 'view persistent admin notice', |
|
96 | + $dismissed = false |
|
97 | + ) { |
|
98 | + $this->setName($name); |
|
99 | + $this->setMessage($message); |
|
100 | + $this->setForceUpdate($force_update); |
|
101 | + $this->setCapability($capability); |
|
102 | + $this->setCapContext($cap_context); |
|
103 | + $this->setDismissed($dismissed); |
|
104 | + add_action( |
|
105 | + 'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices', |
|
106 | + array($this, 'registerPersistentAdminNotice') |
|
107 | + ); |
|
108 | + add_action('shutdown', array($this, 'confirmRegistered'), 999); |
|
109 | + } |
|
110 | + |
|
111 | + |
|
112 | + /** |
|
113 | + * @return string |
|
114 | + */ |
|
115 | + public function getName() |
|
116 | + { |
|
117 | + return $this->name; |
|
118 | + } |
|
119 | + |
|
120 | + |
|
121 | + /** |
|
122 | + * @param string $name |
|
123 | + * @throws InvalidDataTypeException |
|
124 | + */ |
|
125 | + private function setName($name) |
|
126 | + { |
|
127 | + if (! is_string($name)) { |
|
128 | + throw new InvalidDataTypeException('$name', $name, 'string'); |
|
129 | + } |
|
130 | + $this->name = sanitize_key($name); |
|
131 | + } |
|
132 | + |
|
133 | + |
|
134 | + /** |
|
135 | + * @return string |
|
136 | + */ |
|
137 | + public function getMessage() |
|
138 | + { |
|
139 | + return $this->message; |
|
140 | + } |
|
141 | + |
|
142 | + |
|
143 | + /** |
|
144 | + * @param string $message |
|
145 | + * @throws InvalidDataTypeException |
|
146 | + */ |
|
147 | + private function setMessage($message) |
|
148 | + { |
|
149 | + if (! is_string($message)) { |
|
150 | + throw new InvalidDataTypeException('$message', $message, 'string'); |
|
151 | + } |
|
152 | + global $allowedtags; |
|
153 | + $allowedtags['br'] = array(); |
|
154 | + $this->message = wp_kses($message, $allowedtags); |
|
155 | + } |
|
156 | + |
|
157 | + |
|
158 | + /** |
|
159 | + * @return bool |
|
160 | + */ |
|
161 | + public function getForceUpdate() |
|
162 | + { |
|
163 | + return $this->force_update; |
|
164 | + } |
|
165 | + |
|
166 | + |
|
167 | + /** |
|
168 | + * @param bool $force_update |
|
169 | + */ |
|
170 | + private function setForceUpdate($force_update) |
|
171 | + { |
|
172 | + $this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN); |
|
173 | + } |
|
174 | + |
|
175 | + |
|
176 | + /** |
|
177 | + * @return string |
|
178 | + */ |
|
179 | + public function getCapability() |
|
180 | + { |
|
181 | + return $this->capability; |
|
182 | + } |
|
183 | + |
|
184 | + |
|
185 | + /** |
|
186 | + * @param string $capability |
|
187 | + * @throws InvalidDataTypeException |
|
188 | + */ |
|
189 | + private function setCapability($capability) |
|
190 | + { |
|
191 | + if (! is_string($capability)) { |
|
192 | + throw new InvalidDataTypeException('$capability', $capability, 'string'); |
|
193 | + } |
|
194 | + $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
|
195 | + } |
|
196 | + |
|
197 | + |
|
198 | + /** |
|
199 | + * @return string |
|
200 | + */ |
|
201 | + public function getCapContext() |
|
202 | + { |
|
203 | + return $this->cap_context; |
|
204 | + } |
|
205 | + |
|
206 | + |
|
207 | + /** |
|
208 | + * @param string $cap_context |
|
209 | + * @throws InvalidDataTypeException |
|
210 | + */ |
|
211 | + private function setCapContext($cap_context) |
|
212 | + { |
|
213 | + if (! is_string($cap_context)) { |
|
214 | + throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
|
215 | + } |
|
216 | + $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
|
217 | + } |
|
218 | + |
|
219 | + |
|
220 | + /** |
|
221 | + * @return bool |
|
222 | + */ |
|
223 | + public function getDismissed() |
|
224 | + { |
|
225 | + return $this->dismissed; |
|
226 | + } |
|
227 | + |
|
228 | + |
|
229 | + /** |
|
230 | + * @param bool $dismissed |
|
231 | + */ |
|
232 | + public function setDismissed($dismissed) |
|
233 | + { |
|
234 | + $this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN); |
|
235 | + } |
|
236 | + |
|
237 | + |
|
238 | + /** |
|
239 | + * @return CapCheckInterface |
|
240 | + * @throws InvalidDataTypeException |
|
241 | + */ |
|
242 | + public function getCapCheck() |
|
243 | + { |
|
244 | + if (! $this->cap_check instanceof CapCheckInterface) { |
|
245 | + $this->setCapCheck( |
|
246 | + new CapCheck( |
|
247 | + $this->capability, |
|
248 | + $this->cap_context |
|
249 | + ) |
|
250 | + ); |
|
251 | + } |
|
252 | + return $this->cap_check; |
|
253 | + } |
|
254 | + |
|
255 | + |
|
256 | + /** |
|
257 | + * @param CapCheckInterface $cap_check |
|
258 | + */ |
|
259 | + private function setCapCheck(CapCheckInterface $cap_check) |
|
260 | + { |
|
261 | + $this->cap_check = $cap_check; |
|
262 | + } |
|
263 | + |
|
264 | + |
|
265 | + /** |
|
266 | + * @return bool |
|
267 | + */ |
|
268 | + public function getPurge() |
|
269 | + { |
|
270 | + return $this->purge; |
|
271 | + } |
|
272 | + |
|
273 | + |
|
274 | + /** |
|
275 | + * @param bool $purge |
|
276 | + */ |
|
277 | + public function setPurge($purge) |
|
278 | + { |
|
279 | + $this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN); |
|
280 | + } |
|
281 | + |
|
282 | + |
|
283 | + /** |
|
284 | + * given a valid PersistentAdminNotice Collection, |
|
285 | + * this notice will be added if it is not already found in the collection (using its name as the identifier) |
|
286 | + * if an existing notice is found that has already been dismissed, |
|
287 | + * but we are overriding with a forced update, then we will toggle its dismissed state, |
|
288 | + * so that the notice is displayed again |
|
289 | + * |
|
290 | + * @param Collection $persistent_admin_notice_collection |
|
291 | + * @throws InvalidEntityException |
|
292 | + * @throws InvalidDataTypeException |
|
293 | + * @throws DuplicateCollectionIdentifierException |
|
294 | + */ |
|
295 | + public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection) |
|
296 | + { |
|
297 | + if ($this->registered) { |
|
298 | + return; |
|
299 | + } |
|
300 | + // first check if this notice has already been added to the collection |
|
301 | + if ($persistent_admin_notice_collection->has($this->name)) { |
|
302 | + /** @var PersistentAdminNotice $existing */ |
|
303 | + $existing = $persistent_admin_notice_collection->get($this->name); |
|
304 | + // we don't need to add it again (we can't actually) |
|
305 | + // but if it has already been dismissed, and we are overriding with a forced update |
|
306 | + if ($existing->getDismissed() && $this->getForceUpdate()) { |
|
307 | + // then toggle the notice's dismissed state to true |
|
308 | + // so that it gets displayed again |
|
309 | + $existing->setDismissed(false); |
|
310 | + // and make sure the message is set |
|
311 | + $existing->setMessage($this->message); |
|
312 | + } |
|
313 | + } else { |
|
314 | + $persistent_admin_notice_collection->add($this, $this->name); |
|
315 | + } |
|
316 | + $this->registered = true; |
|
317 | + } |
|
318 | + |
|
319 | + |
|
320 | + /** |
|
321 | + * @throws Exception |
|
322 | + */ |
|
323 | + public function confirmRegistered() |
|
324 | + { |
|
325 | + if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
326 | + PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
|
327 | + } |
|
328 | + if (! $this->registered && WP_DEBUG) { |
|
329 | + throw new DomainException( |
|
330 | + sprintf( |
|
331 | + esc_html__( |
|
332 | + '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.', |
|
333 | + 'event_espresso' |
|
334 | + ), |
|
335 | + $this->name |
|
336 | + ) |
|
337 | + ); |
|
338 | + } |
|
339 | + } |
|
340 | 340 | } |
@@ -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 | } |
@@ -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,2194 +15,2194 @@ |
||
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 ]->increaseSold($ticket->sold(), false); |
|
762 | - } |
|
763 | - } |
|
764 | - } |
|
765 | - } |
|
766 | - // then remove datetimes |
|
767 | - if (! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
768 | - foreach ($removed_datetimes as $row_id) { |
|
769 | - $row_id = (int) $row_id; |
|
770 | - // its entirely possible that a datetime got deleted (instead of just removed from relationship. |
|
771 | - // So make sure we skip over this if the dtt isn't in the $saved_datetimes array) |
|
772 | - if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
773 | - $ticket->_remove_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
774 | - // Is this an existing ticket (has an ID) and does it have any sold? |
|
775 | - // If so, then we need to remove it's sold from the DTT_sold. |
|
776 | - if ($ticket->ID() && $ticket->sold() > 0) { |
|
777 | - $saved_datetimes[ $row_id ]->decreaseSold($ticket->sold()); |
|
778 | - } |
|
779 | - } |
|
780 | - } |
|
781 | - } |
|
782 | - // cap ticket qty by datetime reg limits |
|
783 | - $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit'))); |
|
784 | - return $ticket; |
|
785 | - } |
|
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 ]->increaseSold($ticket->sold(), false); |
|
762 | + } |
|
763 | + } |
|
764 | + } |
|
765 | + } |
|
766 | + // then remove datetimes |
|
767 | + if (! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
768 | + foreach ($removed_datetimes as $row_id) { |
|
769 | + $row_id = (int) $row_id; |
|
770 | + // its entirely possible that a datetime got deleted (instead of just removed from relationship. |
|
771 | + // So make sure we skip over this if the dtt isn't in the $saved_datetimes array) |
|
772 | + if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
773 | + $ticket->_remove_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
774 | + // Is this an existing ticket (has an ID) and does it have any sold? |
|
775 | + // If so, then we need to remove it's sold from the DTT_sold. |
|
776 | + if ($ticket->ID() && $ticket->sold() > 0) { |
|
777 | + $saved_datetimes[ $row_id ]->decreaseSold($ticket->sold()); |
|
778 | + } |
|
779 | + } |
|
780 | + } |
|
781 | + } |
|
782 | + // cap ticket qty by datetime reg limits |
|
783 | + $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit'))); |
|
784 | + return $ticket; |
|
785 | + } |
|
786 | 786 | |
787 | 787 | |
788 | - /** |
|
789 | - * @access protected |
|
790 | - * @param EE_Ticket $ticket |
|
791 | - * @param array $price_rows |
|
792 | - * @param int $ticket_price |
|
793 | - * @param int $base_price |
|
794 | - * @param int $base_price_id |
|
795 | - * @return EE_Ticket |
|
796 | - * @throws ReflectionException |
|
797 | - * @throws InvalidArgumentException |
|
798 | - * @throws InvalidInterfaceException |
|
799 | - * @throws InvalidDataTypeException |
|
800 | - * @throws EE_Error |
|
801 | - */ |
|
802 | - protected function _duplicate_ticket( |
|
803 | - EE_Ticket $ticket, |
|
804 | - $price_rows = array(), |
|
805 | - $ticket_price = 0, |
|
806 | - $base_price = 0, |
|
807 | - $base_price_id = 0 |
|
808 | - ) { |
|
809 | - // create new ticket that's a copy of the existing |
|
810 | - // except a new id of course (and not archived) |
|
811 | - // AND has the new TKT_price associated with it. |
|
812 | - $new_ticket = clone $ticket; |
|
813 | - $new_ticket->set('TKT_ID', 0); |
|
814 | - $new_ticket->set_deleted(0); |
|
815 | - $new_ticket->set_price($ticket_price); |
|
816 | - $new_ticket->set_sold(0); |
|
817 | - // let's get a new ID for this ticket |
|
818 | - $new_ticket->save(); |
|
819 | - // we also need to make sure this new ticket gets the same datetime attachments as the archived ticket |
|
820 | - $datetimes_on_existing = $ticket->datetimes(); |
|
821 | - $new_ticket = $this->_update_ticket_datetimes( |
|
822 | - $new_ticket, |
|
823 | - $datetimes_on_existing, |
|
824 | - array_keys($datetimes_on_existing) |
|
825 | - ); |
|
826 | - // $ticket will get archived later b/c we are NOT adding it to the saved_tickets array. |
|
827 | - // if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining |
|
828 | - // available. |
|
829 | - if ($ticket->sold() > 0) { |
|
830 | - $new_qty = $ticket->qty() - $ticket->sold(); |
|
831 | - $new_ticket->set_qty($new_qty); |
|
832 | - } |
|
833 | - // now we update the prices just for this ticket |
|
834 | - $new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true); |
|
835 | - // and we update the base price |
|
836 | - $new_ticket = $this->_add_prices_to_ticket( |
|
837 | - array(), |
|
838 | - $new_ticket, |
|
839 | - true, |
|
840 | - $base_price, |
|
841 | - $base_price_id |
|
842 | - ); |
|
843 | - return $new_ticket; |
|
844 | - } |
|
788 | + /** |
|
789 | + * @access protected |
|
790 | + * @param EE_Ticket $ticket |
|
791 | + * @param array $price_rows |
|
792 | + * @param int $ticket_price |
|
793 | + * @param int $base_price |
|
794 | + * @param int $base_price_id |
|
795 | + * @return EE_Ticket |
|
796 | + * @throws ReflectionException |
|
797 | + * @throws InvalidArgumentException |
|
798 | + * @throws InvalidInterfaceException |
|
799 | + * @throws InvalidDataTypeException |
|
800 | + * @throws EE_Error |
|
801 | + */ |
|
802 | + protected function _duplicate_ticket( |
|
803 | + EE_Ticket $ticket, |
|
804 | + $price_rows = array(), |
|
805 | + $ticket_price = 0, |
|
806 | + $base_price = 0, |
|
807 | + $base_price_id = 0 |
|
808 | + ) { |
|
809 | + // create new ticket that's a copy of the existing |
|
810 | + // except a new id of course (and not archived) |
|
811 | + // AND has the new TKT_price associated with it. |
|
812 | + $new_ticket = clone $ticket; |
|
813 | + $new_ticket->set('TKT_ID', 0); |
|
814 | + $new_ticket->set_deleted(0); |
|
815 | + $new_ticket->set_price($ticket_price); |
|
816 | + $new_ticket->set_sold(0); |
|
817 | + // let's get a new ID for this ticket |
|
818 | + $new_ticket->save(); |
|
819 | + // we also need to make sure this new ticket gets the same datetime attachments as the archived ticket |
|
820 | + $datetimes_on_existing = $ticket->datetimes(); |
|
821 | + $new_ticket = $this->_update_ticket_datetimes( |
|
822 | + $new_ticket, |
|
823 | + $datetimes_on_existing, |
|
824 | + array_keys($datetimes_on_existing) |
|
825 | + ); |
|
826 | + // $ticket will get archived later b/c we are NOT adding it to the saved_tickets array. |
|
827 | + // if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining |
|
828 | + // available. |
|
829 | + if ($ticket->sold() > 0) { |
|
830 | + $new_qty = $ticket->qty() - $ticket->sold(); |
|
831 | + $new_ticket->set_qty($new_qty); |
|
832 | + } |
|
833 | + // now we update the prices just for this ticket |
|
834 | + $new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true); |
|
835 | + // and we update the base price |
|
836 | + $new_ticket = $this->_add_prices_to_ticket( |
|
837 | + array(), |
|
838 | + $new_ticket, |
|
839 | + true, |
|
840 | + $base_price, |
|
841 | + $base_price_id |
|
842 | + ); |
|
843 | + return $new_ticket; |
|
844 | + } |
|
845 | 845 | |
846 | 846 | |
847 | - /** |
|
848 | - * This attaches a list of given prices to a ticket. |
|
849 | - * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change |
|
850 | - * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old |
|
851 | - * price info and prices are automatically "archived" via the ticket. |
|
852 | - * |
|
853 | - * @access private |
|
854 | - * @param array $prices Array of prices from the form. |
|
855 | - * @param EE_Ticket $ticket EE_Ticket object that prices are being attached to. |
|
856 | - * @param bool $new_prices Whether attach existing incoming prices or create new ones. |
|
857 | - * @param int|bool $base_price if FALSE then NOT doing a base price add. |
|
858 | - * @param int|bool $base_price_id if present then this is the base_price_id being updated. |
|
859 | - * @return EE_Ticket |
|
860 | - * @throws ReflectionException |
|
861 | - * @throws InvalidArgumentException |
|
862 | - * @throws InvalidInterfaceException |
|
863 | - * @throws InvalidDataTypeException |
|
864 | - * @throws EE_Error |
|
865 | - */ |
|
866 | - protected function _add_prices_to_ticket( |
|
867 | - $prices = array(), |
|
868 | - EE_Ticket $ticket, |
|
869 | - $new_prices = false, |
|
870 | - $base_price = false, |
|
871 | - $base_price_id = false |
|
872 | - ) { |
|
873 | - // let's just get any current prices that may exist on the given ticket |
|
874 | - // so we can remove any prices that got trashed in this session. |
|
875 | - $current_prices_on_ticket = $base_price !== false |
|
876 | - ? $ticket->base_price(true) |
|
877 | - : $ticket->price_modifiers(); |
|
878 | - $updated_prices = array(); |
|
879 | - // if $base_price ! FALSE then updating a base price. |
|
880 | - if ($base_price !== false) { |
|
881 | - $prices[1] = array( |
|
882 | - 'PRC_ID' => $new_prices || $base_price_id === 1 ? null : $base_price_id, |
|
883 | - 'PRT_ID' => 1, |
|
884 | - 'PRC_amount' => $base_price, |
|
885 | - 'PRC_name' => $ticket->get('TKT_name'), |
|
886 | - 'PRC_desc' => $ticket->get('TKT_description'), |
|
887 | - ); |
|
888 | - } |
|
889 | - // possibly need to save tkt |
|
890 | - if (! $ticket->ID()) { |
|
891 | - $ticket->save(); |
|
892 | - } |
|
893 | - foreach ($prices as $row => $prc) { |
|
894 | - $prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null; |
|
895 | - if (empty($prt_id)) { |
|
896 | - continue; |
|
897 | - } //prices MUST have a price type id. |
|
898 | - $PRC_values = array( |
|
899 | - 'PRC_ID' => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null, |
|
900 | - 'PRT_ID' => $prt_id, |
|
901 | - 'PRC_amount' => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0, |
|
902 | - 'PRC_name' => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '', |
|
903 | - 'PRC_desc' => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '', |
|
904 | - 'PRC_is_default' => false, |
|
905 | - // make sure we set PRC_is_default to false for all ticket saves from event_editor |
|
906 | - 'PRC_order' => $row, |
|
907 | - ); |
|
908 | - if ($new_prices || empty($PRC_values['PRC_ID'])) { |
|
909 | - $PRC_values['PRC_ID'] = 0; |
|
910 | - $price = EE_Registry::instance()->load_class( |
|
911 | - 'Price', |
|
912 | - array($PRC_values), |
|
913 | - false, |
|
914 | - false |
|
915 | - ); |
|
916 | - } else { |
|
917 | - $price = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']); |
|
918 | - // update this price with new values |
|
919 | - foreach ($PRC_values as $field => $value) { |
|
920 | - $price->set($field, $value); |
|
921 | - } |
|
922 | - } |
|
923 | - $price->save(); |
|
924 | - $updated_prices[ $price->ID() ] = $price; |
|
925 | - $ticket->_add_relation_to($price, 'Price'); |
|
926 | - } |
|
927 | - // now let's remove any prices that got removed from the ticket |
|
928 | - if (! empty($current_prices_on_ticket)) { |
|
929 | - $current = array_keys($current_prices_on_ticket); |
|
930 | - $updated = array_keys($updated_prices); |
|
931 | - $prices_to_remove = array_diff($current, $updated); |
|
932 | - if (! empty($prices_to_remove)) { |
|
933 | - foreach ($prices_to_remove as $prc_id) { |
|
934 | - $p = $current_prices_on_ticket[ $prc_id ]; |
|
935 | - $ticket->_remove_relation_to($p, 'Price'); |
|
936 | - // delete permanently the price |
|
937 | - $p->delete_permanently(); |
|
938 | - } |
|
939 | - } |
|
940 | - } |
|
941 | - return $ticket; |
|
942 | - } |
|
847 | + /** |
|
848 | + * This attaches a list of given prices to a ticket. |
|
849 | + * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change |
|
850 | + * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old |
|
851 | + * price info and prices are automatically "archived" via the ticket. |
|
852 | + * |
|
853 | + * @access private |
|
854 | + * @param array $prices Array of prices from the form. |
|
855 | + * @param EE_Ticket $ticket EE_Ticket object that prices are being attached to. |
|
856 | + * @param bool $new_prices Whether attach existing incoming prices or create new ones. |
|
857 | + * @param int|bool $base_price if FALSE then NOT doing a base price add. |
|
858 | + * @param int|bool $base_price_id if present then this is the base_price_id being updated. |
|
859 | + * @return EE_Ticket |
|
860 | + * @throws ReflectionException |
|
861 | + * @throws InvalidArgumentException |
|
862 | + * @throws InvalidInterfaceException |
|
863 | + * @throws InvalidDataTypeException |
|
864 | + * @throws EE_Error |
|
865 | + */ |
|
866 | + protected function _add_prices_to_ticket( |
|
867 | + $prices = array(), |
|
868 | + EE_Ticket $ticket, |
|
869 | + $new_prices = false, |
|
870 | + $base_price = false, |
|
871 | + $base_price_id = false |
|
872 | + ) { |
|
873 | + // let's just get any current prices that may exist on the given ticket |
|
874 | + // so we can remove any prices that got trashed in this session. |
|
875 | + $current_prices_on_ticket = $base_price !== false |
|
876 | + ? $ticket->base_price(true) |
|
877 | + : $ticket->price_modifiers(); |
|
878 | + $updated_prices = array(); |
|
879 | + // if $base_price ! FALSE then updating a base price. |
|
880 | + if ($base_price !== false) { |
|
881 | + $prices[1] = array( |
|
882 | + 'PRC_ID' => $new_prices || $base_price_id === 1 ? null : $base_price_id, |
|
883 | + 'PRT_ID' => 1, |
|
884 | + 'PRC_amount' => $base_price, |
|
885 | + 'PRC_name' => $ticket->get('TKT_name'), |
|
886 | + 'PRC_desc' => $ticket->get('TKT_description'), |
|
887 | + ); |
|
888 | + } |
|
889 | + // possibly need to save tkt |
|
890 | + if (! $ticket->ID()) { |
|
891 | + $ticket->save(); |
|
892 | + } |
|
893 | + foreach ($prices as $row => $prc) { |
|
894 | + $prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null; |
|
895 | + if (empty($prt_id)) { |
|
896 | + continue; |
|
897 | + } //prices MUST have a price type id. |
|
898 | + $PRC_values = array( |
|
899 | + 'PRC_ID' => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null, |
|
900 | + 'PRT_ID' => $prt_id, |
|
901 | + 'PRC_amount' => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0, |
|
902 | + 'PRC_name' => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '', |
|
903 | + 'PRC_desc' => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '', |
|
904 | + 'PRC_is_default' => false, |
|
905 | + // make sure we set PRC_is_default to false for all ticket saves from event_editor |
|
906 | + 'PRC_order' => $row, |
|
907 | + ); |
|
908 | + if ($new_prices || empty($PRC_values['PRC_ID'])) { |
|
909 | + $PRC_values['PRC_ID'] = 0; |
|
910 | + $price = EE_Registry::instance()->load_class( |
|
911 | + 'Price', |
|
912 | + array($PRC_values), |
|
913 | + false, |
|
914 | + false |
|
915 | + ); |
|
916 | + } else { |
|
917 | + $price = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']); |
|
918 | + // update this price with new values |
|
919 | + foreach ($PRC_values as $field => $value) { |
|
920 | + $price->set($field, $value); |
|
921 | + } |
|
922 | + } |
|
923 | + $price->save(); |
|
924 | + $updated_prices[ $price->ID() ] = $price; |
|
925 | + $ticket->_add_relation_to($price, 'Price'); |
|
926 | + } |
|
927 | + // now let's remove any prices that got removed from the ticket |
|
928 | + if (! empty($current_prices_on_ticket)) { |
|
929 | + $current = array_keys($current_prices_on_ticket); |
|
930 | + $updated = array_keys($updated_prices); |
|
931 | + $prices_to_remove = array_diff($current, $updated); |
|
932 | + if (! empty($prices_to_remove)) { |
|
933 | + foreach ($prices_to_remove as $prc_id) { |
|
934 | + $p = $current_prices_on_ticket[ $prc_id ]; |
|
935 | + $ticket->_remove_relation_to($p, 'Price'); |
|
936 | + // delete permanently the price |
|
937 | + $p->delete_permanently(); |
|
938 | + } |
|
939 | + } |
|
940 | + } |
|
941 | + return $ticket; |
|
942 | + } |
|
943 | 943 | |
944 | 944 | |
945 | - /** |
|
946 | - * @param Events_Admin_Page $event_admin_obj |
|
947 | - * @return Events_Admin_Page |
|
948 | - */ |
|
949 | - public function autosave_handling(Events_Admin_Page $event_admin_obj) |
|
950 | - { |
|
951 | - return $event_admin_obj; |
|
952 | - // doing nothing for the moment. |
|
953 | - // todo when I get to this remember that I need to set the template args on the $event_admin_obj |
|
954 | - // (use the set_template_args() method) |
|
955 | - /** |
|
956 | - * need to remember to handle TICKET DEFAULT saves correctly: I've got two input fields in the dom: |
|
957 | - * 1. TKT_is_default_selector (visible) |
|
958 | - * 2. TKT_is_default (hidden) |
|
959 | - * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket |
|
960 | - * (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want |
|
961 | - * this ticket to be saved as a default. |
|
962 | - * The tricky part is, on an initial display on create or edit (or after manually updating), |
|
963 | - * the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true |
|
964 | - * if this is a create. However, after an autosave, users will want some sort of indicator that |
|
965 | - * the TKT HAS been saved as a default.. |
|
966 | - * in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking. |
|
967 | - * On Autosave: |
|
968 | - * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements, |
|
969 | - * then set the TKT_is_default to false. |
|
970 | - * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well). |
|
971 | - * We do NOT create a new default ticket. The checkbox stays selected after autosave. |
|
972 | - * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket. |
|
973 | - */ |
|
974 | - } |
|
945 | + /** |
|
946 | + * @param Events_Admin_Page $event_admin_obj |
|
947 | + * @return Events_Admin_Page |
|
948 | + */ |
|
949 | + public function autosave_handling(Events_Admin_Page $event_admin_obj) |
|
950 | + { |
|
951 | + return $event_admin_obj; |
|
952 | + // doing nothing for the moment. |
|
953 | + // todo when I get to this remember that I need to set the template args on the $event_admin_obj |
|
954 | + // (use the set_template_args() method) |
|
955 | + /** |
|
956 | + * need to remember to handle TICKET DEFAULT saves correctly: I've got two input fields in the dom: |
|
957 | + * 1. TKT_is_default_selector (visible) |
|
958 | + * 2. TKT_is_default (hidden) |
|
959 | + * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket |
|
960 | + * (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want |
|
961 | + * this ticket to be saved as a default. |
|
962 | + * The tricky part is, on an initial display on create or edit (or after manually updating), |
|
963 | + * the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true |
|
964 | + * if this is a create. However, after an autosave, users will want some sort of indicator that |
|
965 | + * the TKT HAS been saved as a default.. |
|
966 | + * in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking. |
|
967 | + * On Autosave: |
|
968 | + * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements, |
|
969 | + * then set the TKT_is_default to false. |
|
970 | + * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well). |
|
971 | + * We do NOT create a new default ticket. The checkbox stays selected after autosave. |
|
972 | + * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket. |
|
973 | + */ |
|
974 | + } |
|
975 | 975 | |
976 | 976 | |
977 | - /** |
|
978 | - * @throws ReflectionException |
|
979 | - * @throws InvalidArgumentException |
|
980 | - * @throws InvalidInterfaceException |
|
981 | - * @throws InvalidDataTypeException |
|
982 | - * @throws DomainException |
|
983 | - * @throws EE_Error |
|
984 | - */ |
|
985 | - public function pricing_metabox() |
|
986 | - { |
|
987 | - $existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array(); |
|
988 | - $event = $this->_adminpage_obj->get_cpt_model_obj(); |
|
989 | - // set is_creating_event property. |
|
990 | - $EVT_ID = $event->ID(); |
|
991 | - $this->_is_creating_event = empty($this->_req_data['post']); |
|
992 | - // default main template args |
|
993 | - $main_template_args = array( |
|
994 | - 'event_datetime_help_link' => EEH_Template::get_help_tab_link( |
|
995 | - 'event_editor_event_datetimes_help_tab', |
|
996 | - $this->_adminpage_obj->page_slug, |
|
997 | - $this->_adminpage_obj->get_req_action(), |
|
998 | - false, |
|
999 | - false |
|
1000 | - ), |
|
1001 | - // todo need to add a filter to the template for the help text |
|
1002 | - // in the Events_Admin_Page core file so we can add further help |
|
1003 | - 'existing_datetime_ids' => '', |
|
1004 | - 'total_dtt_rows' => 1, |
|
1005 | - 'add_new_dtt_help_link' => EEH_Template::get_help_tab_link( |
|
1006 | - 'add_new_dtt_info', |
|
1007 | - $this->_adminpage_obj->page_slug, |
|
1008 | - $this->_adminpage_obj->get_req_action(), |
|
1009 | - false, |
|
1010 | - false |
|
1011 | - ), |
|
1012 | - // todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
1013 | - 'datetime_rows' => '', |
|
1014 | - 'show_tickets_container' => '', |
|
1015 | - // $this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '', |
|
1016 | - 'ticket_rows' => '', |
|
1017 | - 'existing_ticket_ids' => '', |
|
1018 | - 'total_ticket_rows' => 1, |
|
1019 | - 'ticket_js_structure' => '', |
|
1020 | - 'ee_collapsible_status' => ' ee-collapsible-open' |
|
1021 | - // $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open' |
|
1022 | - ); |
|
1023 | - $timezone = $event instanceof EE_Event ? $event->timezone_string() : null; |
|
1024 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
1025 | - /** |
|
1026 | - * 1. Start with retrieving Datetimes |
|
1027 | - * 2. For each datetime get related tickets |
|
1028 | - * 3. For each ticket get related prices |
|
1029 | - */ |
|
1030 | - /** @var EEM_Datetime $datetime_model */ |
|
1031 | - $datetime_model = EE_Registry::instance()->load_model('Datetime', array($timezone)); |
|
1032 | - $datetimes = $datetime_model->get_all_event_dates($EVT_ID); |
|
1033 | - $main_template_args['total_dtt_rows'] = count($datetimes); |
|
1034 | - /** |
|
1035 | - * @see https://events.codebasehq.com/projects/event-espresso/tickets/9486 |
|
1036 | - * for why we are counting $datetime_row and then setting that on the Datetime object |
|
1037 | - */ |
|
1038 | - $datetime_row = 1; |
|
1039 | - foreach ($datetimes as $datetime) { |
|
1040 | - $DTT_ID = $datetime->get('DTT_ID'); |
|
1041 | - $datetime->set('DTT_order', $datetime_row); |
|
1042 | - $existing_datetime_ids[] = $DTT_ID; |
|
1043 | - // tickets attached |
|
1044 | - $related_tickets = $datetime->ID() > 0 |
|
1045 | - ? $datetime->get_many_related( |
|
1046 | - 'Ticket', |
|
1047 | - array( |
|
1048 | - array( |
|
1049 | - 'OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0), |
|
1050 | - ), |
|
1051 | - 'default_where_conditions' => 'none', |
|
1052 | - 'order_by' => array('TKT_order' => 'ASC'), |
|
1053 | - ) |
|
1054 | - ) |
|
1055 | - : array(); |
|
1056 | - // if there are no related tickets this is likely a new event OR autodraft |
|
1057 | - // event so we need to generate the default tickets because datetimes |
|
1058 | - // ALWAYS have at least one related ticket!!. EXCEPT, we dont' do this if there is already more than one |
|
1059 | - // datetime on the event. |
|
1060 | - if (empty($related_tickets) && count($datetimes) < 2) { |
|
1061 | - /** @var EEM_Ticket $ticket_model */ |
|
1062 | - $ticket_model = EE_Registry::instance()->load_model('Ticket'); |
|
1063 | - $related_tickets = $ticket_model->get_all_default_tickets(); |
|
1064 | - // this should be ordered by TKT_ID, so let's grab the first default ticket |
|
1065 | - // (which will be the main default) and ensure it has any default prices added to it (but do NOT save). |
|
1066 | - $default_prices = EEM_Price::instance()->get_all_default_prices(); |
|
1067 | - $main_default_ticket = reset($related_tickets); |
|
1068 | - if ($main_default_ticket instanceof EE_Ticket) { |
|
1069 | - foreach ($default_prices as $default_price) { |
|
1070 | - if ($default_price instanceof EE_Price && $default_price->is_base_price()) { |
|
1071 | - continue; |
|
1072 | - } |
|
1073 | - $main_default_ticket->cache('Price', $default_price); |
|
1074 | - } |
|
1075 | - } |
|
1076 | - } |
|
1077 | - // we can't actually setup rows in this loop yet cause we don't know all |
|
1078 | - // the unique tickets for this event yet (tickets are linked through all datetimes). |
|
1079 | - // So we're going to temporarily cache some of that information. |
|
1080 | - // loop through and setup the ticket rows and make sure the order is set. |
|
1081 | - foreach ($related_tickets as $ticket) { |
|
1082 | - $TKT_ID = $ticket->get('TKT_ID'); |
|
1083 | - $ticket_row = $ticket->get('TKT_row'); |
|
1084 | - // we only want unique tickets in our final display!! |
|
1085 | - if (! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
1086 | - $existing_ticket_ids[] = $TKT_ID; |
|
1087 | - $all_tickets[] = $ticket; |
|
1088 | - } |
|
1089 | - // temporary cache of this ticket info for this datetime for later processing of datetime rows. |
|
1090 | - $datetime_tickets[ $DTT_ID ][] = $ticket_row; |
|
1091 | - // temporary cache of this datetime info for this ticket for later processing of ticket rows. |
|
1092 | - if (! isset($ticket_datetimes[ $TKT_ID ]) |
|
1093 | - || ! in_array($datetime_row, $ticket_datetimes[ $TKT_ID ], true) |
|
1094 | - ) { |
|
1095 | - $ticket_datetimes[ $TKT_ID ][] = $datetime_row; |
|
1096 | - } |
|
1097 | - } |
|
1098 | - $datetime_row++; |
|
1099 | - } |
|
1100 | - $main_template_args['total_ticket_rows'] = count($existing_ticket_ids); |
|
1101 | - $main_template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids); |
|
1102 | - $main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids); |
|
1103 | - // sort $all_tickets by order |
|
1104 | - usort( |
|
1105 | - $all_tickets, |
|
1106 | - function (EE_Ticket $a, EE_Ticket $b) { |
|
1107 | - $a_order = (int) $a->get('TKT_order'); |
|
1108 | - $b_order = (int) $b->get('TKT_order'); |
|
1109 | - if ($a_order === $b_order) { |
|
1110 | - return 0; |
|
1111 | - } |
|
1112 | - return ($a_order < $b_order) ? -1 : 1; |
|
1113 | - } |
|
1114 | - ); |
|
1115 | - // k NOW we have all the data we need for setting up the dtt rows |
|
1116 | - // and ticket rows so we start our dtt loop again. |
|
1117 | - $datetime_row = 1; |
|
1118 | - foreach ($datetimes as $datetime) { |
|
1119 | - $main_template_args['datetime_rows'] .= $this->_get_datetime_row( |
|
1120 | - $datetime_row, |
|
1121 | - $datetime, |
|
1122 | - $datetime_tickets, |
|
1123 | - $all_tickets, |
|
1124 | - false, |
|
1125 | - $datetimes |
|
1126 | - ); |
|
1127 | - $datetime_row++; |
|
1128 | - } |
|
1129 | - // then loop through all tickets for the ticket rows. |
|
1130 | - $ticket_row = 1; |
|
1131 | - foreach ($all_tickets as $ticket) { |
|
1132 | - $main_template_args['ticket_rows'] .= $this->_get_ticket_row( |
|
1133 | - $ticket_row, |
|
1134 | - $ticket, |
|
1135 | - $ticket_datetimes, |
|
1136 | - $datetimes, |
|
1137 | - false, |
|
1138 | - $all_tickets |
|
1139 | - ); |
|
1140 | - $ticket_row++; |
|
1141 | - } |
|
1142 | - $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets); |
|
1143 | - EEH_Template::display_template( |
|
1144 | - PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php', |
|
1145 | - $main_template_args |
|
1146 | - ); |
|
1147 | - } |
|
977 | + /** |
|
978 | + * @throws ReflectionException |
|
979 | + * @throws InvalidArgumentException |
|
980 | + * @throws InvalidInterfaceException |
|
981 | + * @throws InvalidDataTypeException |
|
982 | + * @throws DomainException |
|
983 | + * @throws EE_Error |
|
984 | + */ |
|
985 | + public function pricing_metabox() |
|
986 | + { |
|
987 | + $existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array(); |
|
988 | + $event = $this->_adminpage_obj->get_cpt_model_obj(); |
|
989 | + // set is_creating_event property. |
|
990 | + $EVT_ID = $event->ID(); |
|
991 | + $this->_is_creating_event = empty($this->_req_data['post']); |
|
992 | + // default main template args |
|
993 | + $main_template_args = array( |
|
994 | + 'event_datetime_help_link' => EEH_Template::get_help_tab_link( |
|
995 | + 'event_editor_event_datetimes_help_tab', |
|
996 | + $this->_adminpage_obj->page_slug, |
|
997 | + $this->_adminpage_obj->get_req_action(), |
|
998 | + false, |
|
999 | + false |
|
1000 | + ), |
|
1001 | + // todo need to add a filter to the template for the help text |
|
1002 | + // in the Events_Admin_Page core file so we can add further help |
|
1003 | + 'existing_datetime_ids' => '', |
|
1004 | + 'total_dtt_rows' => 1, |
|
1005 | + 'add_new_dtt_help_link' => EEH_Template::get_help_tab_link( |
|
1006 | + 'add_new_dtt_info', |
|
1007 | + $this->_adminpage_obj->page_slug, |
|
1008 | + $this->_adminpage_obj->get_req_action(), |
|
1009 | + false, |
|
1010 | + false |
|
1011 | + ), |
|
1012 | + // todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
1013 | + 'datetime_rows' => '', |
|
1014 | + 'show_tickets_container' => '', |
|
1015 | + // $this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '', |
|
1016 | + 'ticket_rows' => '', |
|
1017 | + 'existing_ticket_ids' => '', |
|
1018 | + 'total_ticket_rows' => 1, |
|
1019 | + 'ticket_js_structure' => '', |
|
1020 | + 'ee_collapsible_status' => ' ee-collapsible-open' |
|
1021 | + // $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open' |
|
1022 | + ); |
|
1023 | + $timezone = $event instanceof EE_Event ? $event->timezone_string() : null; |
|
1024 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
1025 | + /** |
|
1026 | + * 1. Start with retrieving Datetimes |
|
1027 | + * 2. For each datetime get related tickets |
|
1028 | + * 3. For each ticket get related prices |
|
1029 | + */ |
|
1030 | + /** @var EEM_Datetime $datetime_model */ |
|
1031 | + $datetime_model = EE_Registry::instance()->load_model('Datetime', array($timezone)); |
|
1032 | + $datetimes = $datetime_model->get_all_event_dates($EVT_ID); |
|
1033 | + $main_template_args['total_dtt_rows'] = count($datetimes); |
|
1034 | + /** |
|
1035 | + * @see https://events.codebasehq.com/projects/event-espresso/tickets/9486 |
|
1036 | + * for why we are counting $datetime_row and then setting that on the Datetime object |
|
1037 | + */ |
|
1038 | + $datetime_row = 1; |
|
1039 | + foreach ($datetimes as $datetime) { |
|
1040 | + $DTT_ID = $datetime->get('DTT_ID'); |
|
1041 | + $datetime->set('DTT_order', $datetime_row); |
|
1042 | + $existing_datetime_ids[] = $DTT_ID; |
|
1043 | + // tickets attached |
|
1044 | + $related_tickets = $datetime->ID() > 0 |
|
1045 | + ? $datetime->get_many_related( |
|
1046 | + 'Ticket', |
|
1047 | + array( |
|
1048 | + array( |
|
1049 | + 'OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0), |
|
1050 | + ), |
|
1051 | + 'default_where_conditions' => 'none', |
|
1052 | + 'order_by' => array('TKT_order' => 'ASC'), |
|
1053 | + ) |
|
1054 | + ) |
|
1055 | + : array(); |
|
1056 | + // if there are no related tickets this is likely a new event OR autodraft |
|
1057 | + // event so we need to generate the default tickets because datetimes |
|
1058 | + // ALWAYS have at least one related ticket!!. EXCEPT, we dont' do this if there is already more than one |
|
1059 | + // datetime on the event. |
|
1060 | + if (empty($related_tickets) && count($datetimes) < 2) { |
|
1061 | + /** @var EEM_Ticket $ticket_model */ |
|
1062 | + $ticket_model = EE_Registry::instance()->load_model('Ticket'); |
|
1063 | + $related_tickets = $ticket_model->get_all_default_tickets(); |
|
1064 | + // this should be ordered by TKT_ID, so let's grab the first default ticket |
|
1065 | + // (which will be the main default) and ensure it has any default prices added to it (but do NOT save). |
|
1066 | + $default_prices = EEM_Price::instance()->get_all_default_prices(); |
|
1067 | + $main_default_ticket = reset($related_tickets); |
|
1068 | + if ($main_default_ticket instanceof EE_Ticket) { |
|
1069 | + foreach ($default_prices as $default_price) { |
|
1070 | + if ($default_price instanceof EE_Price && $default_price->is_base_price()) { |
|
1071 | + continue; |
|
1072 | + } |
|
1073 | + $main_default_ticket->cache('Price', $default_price); |
|
1074 | + } |
|
1075 | + } |
|
1076 | + } |
|
1077 | + // we can't actually setup rows in this loop yet cause we don't know all |
|
1078 | + // the unique tickets for this event yet (tickets are linked through all datetimes). |
|
1079 | + // So we're going to temporarily cache some of that information. |
|
1080 | + // loop through and setup the ticket rows and make sure the order is set. |
|
1081 | + foreach ($related_tickets as $ticket) { |
|
1082 | + $TKT_ID = $ticket->get('TKT_ID'); |
|
1083 | + $ticket_row = $ticket->get('TKT_row'); |
|
1084 | + // we only want unique tickets in our final display!! |
|
1085 | + if (! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
1086 | + $existing_ticket_ids[] = $TKT_ID; |
|
1087 | + $all_tickets[] = $ticket; |
|
1088 | + } |
|
1089 | + // temporary cache of this ticket info for this datetime for later processing of datetime rows. |
|
1090 | + $datetime_tickets[ $DTT_ID ][] = $ticket_row; |
|
1091 | + // temporary cache of this datetime info for this ticket for later processing of ticket rows. |
|
1092 | + if (! isset($ticket_datetimes[ $TKT_ID ]) |
|
1093 | + || ! in_array($datetime_row, $ticket_datetimes[ $TKT_ID ], true) |
|
1094 | + ) { |
|
1095 | + $ticket_datetimes[ $TKT_ID ][] = $datetime_row; |
|
1096 | + } |
|
1097 | + } |
|
1098 | + $datetime_row++; |
|
1099 | + } |
|
1100 | + $main_template_args['total_ticket_rows'] = count($existing_ticket_ids); |
|
1101 | + $main_template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids); |
|
1102 | + $main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids); |
|
1103 | + // sort $all_tickets by order |
|
1104 | + usort( |
|
1105 | + $all_tickets, |
|
1106 | + function (EE_Ticket $a, EE_Ticket $b) { |
|
1107 | + $a_order = (int) $a->get('TKT_order'); |
|
1108 | + $b_order = (int) $b->get('TKT_order'); |
|
1109 | + if ($a_order === $b_order) { |
|
1110 | + return 0; |
|
1111 | + } |
|
1112 | + return ($a_order < $b_order) ? -1 : 1; |
|
1113 | + } |
|
1114 | + ); |
|
1115 | + // k NOW we have all the data we need for setting up the dtt rows |
|
1116 | + // and ticket rows so we start our dtt loop again. |
|
1117 | + $datetime_row = 1; |
|
1118 | + foreach ($datetimes as $datetime) { |
|
1119 | + $main_template_args['datetime_rows'] .= $this->_get_datetime_row( |
|
1120 | + $datetime_row, |
|
1121 | + $datetime, |
|
1122 | + $datetime_tickets, |
|
1123 | + $all_tickets, |
|
1124 | + false, |
|
1125 | + $datetimes |
|
1126 | + ); |
|
1127 | + $datetime_row++; |
|
1128 | + } |
|
1129 | + // then loop through all tickets for the ticket rows. |
|
1130 | + $ticket_row = 1; |
|
1131 | + foreach ($all_tickets as $ticket) { |
|
1132 | + $main_template_args['ticket_rows'] .= $this->_get_ticket_row( |
|
1133 | + $ticket_row, |
|
1134 | + $ticket, |
|
1135 | + $ticket_datetimes, |
|
1136 | + $datetimes, |
|
1137 | + false, |
|
1138 | + $all_tickets |
|
1139 | + ); |
|
1140 | + $ticket_row++; |
|
1141 | + } |
|
1142 | + $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets); |
|
1143 | + EEH_Template::display_template( |
|
1144 | + PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php', |
|
1145 | + $main_template_args |
|
1146 | + ); |
|
1147 | + } |
|
1148 | 1148 | |
1149 | 1149 | |
1150 | - /** |
|
1151 | - * @param int $datetime_row |
|
1152 | - * @param EE_Datetime $datetime |
|
1153 | - * @param array $datetime_tickets |
|
1154 | - * @param array $all_tickets |
|
1155 | - * @param bool $default |
|
1156 | - * @param array $all_datetimes |
|
1157 | - * @return mixed |
|
1158 | - * @throws DomainException |
|
1159 | - * @throws EE_Error |
|
1160 | - */ |
|
1161 | - protected function _get_datetime_row( |
|
1162 | - $datetime_row, |
|
1163 | - EE_Datetime $datetime, |
|
1164 | - $datetime_tickets = array(), |
|
1165 | - $all_tickets = array(), |
|
1166 | - $default = false, |
|
1167 | - $all_datetimes = array() |
|
1168 | - ) { |
|
1169 | - $dtt_display_template_args = array( |
|
1170 | - 'dtt_edit_row' => $this->_get_dtt_edit_row( |
|
1171 | - $datetime_row, |
|
1172 | - $datetime, |
|
1173 | - $default, |
|
1174 | - $all_datetimes |
|
1175 | - ), |
|
1176 | - 'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row( |
|
1177 | - $datetime_row, |
|
1178 | - $datetime, |
|
1179 | - $datetime_tickets, |
|
1180 | - $all_tickets, |
|
1181 | - $default |
|
1182 | - ), |
|
1183 | - 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
1184 | - ); |
|
1185 | - return EEH_Template::display_template( |
|
1186 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php', |
|
1187 | - $dtt_display_template_args, |
|
1188 | - true |
|
1189 | - ); |
|
1190 | - } |
|
1150 | + /** |
|
1151 | + * @param int $datetime_row |
|
1152 | + * @param EE_Datetime $datetime |
|
1153 | + * @param array $datetime_tickets |
|
1154 | + * @param array $all_tickets |
|
1155 | + * @param bool $default |
|
1156 | + * @param array $all_datetimes |
|
1157 | + * @return mixed |
|
1158 | + * @throws DomainException |
|
1159 | + * @throws EE_Error |
|
1160 | + */ |
|
1161 | + protected function _get_datetime_row( |
|
1162 | + $datetime_row, |
|
1163 | + EE_Datetime $datetime, |
|
1164 | + $datetime_tickets = array(), |
|
1165 | + $all_tickets = array(), |
|
1166 | + $default = false, |
|
1167 | + $all_datetimes = array() |
|
1168 | + ) { |
|
1169 | + $dtt_display_template_args = array( |
|
1170 | + 'dtt_edit_row' => $this->_get_dtt_edit_row( |
|
1171 | + $datetime_row, |
|
1172 | + $datetime, |
|
1173 | + $default, |
|
1174 | + $all_datetimes |
|
1175 | + ), |
|
1176 | + 'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row( |
|
1177 | + $datetime_row, |
|
1178 | + $datetime, |
|
1179 | + $datetime_tickets, |
|
1180 | + $all_tickets, |
|
1181 | + $default |
|
1182 | + ), |
|
1183 | + 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
1184 | + ); |
|
1185 | + return EEH_Template::display_template( |
|
1186 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php', |
|
1187 | + $dtt_display_template_args, |
|
1188 | + true |
|
1189 | + ); |
|
1190 | + } |
|
1191 | 1191 | |
1192 | 1192 | |
1193 | - /** |
|
1194 | - * This method is used to generate a dtt fields edit row. |
|
1195 | - * The same row is used to generate a row with valid DTT objects |
|
1196 | - * and the default row that is used as the skeleton by the js. |
|
1197 | - * |
|
1198 | - * @param int $datetime_row The row number for the row being generated. |
|
1199 | - * @param EE_Datetime $datetime |
|
1200 | - * @param bool $default Whether a default row is being generated or not. |
|
1201 | - * @param EE_Datetime[] $all_datetimes This is the array of all datetimes used in the editor. |
|
1202 | - * @return string |
|
1203 | - * @throws DomainException |
|
1204 | - * @throws EE_Error |
|
1205 | - */ |
|
1206 | - protected function _get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes) |
|
1207 | - { |
|
1208 | - // if the incoming $datetime object is NOT an instance of EE_Datetime then force default to true. |
|
1209 | - $default = ! $datetime instanceof EE_Datetime ? true : $default; |
|
1210 | - $template_args = array( |
|
1211 | - 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
1212 | - 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
1213 | - 'edit_dtt_expanded' => '', |
|
1214 | - 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
1215 | - 'DTT_name' => $default ? '' : $datetime->get_f('DTT_name'), |
|
1216 | - 'DTT_description' => $default ? '' : $datetime->get_f('DTT_description'), |
|
1217 | - 'DTT_EVT_start' => $default ? '' : $datetime->start_date($this->_date_time_format), |
|
1218 | - 'DTT_EVT_end' => $default ? '' : $datetime->end_date($this->_date_time_format), |
|
1219 | - 'DTT_reg_limit' => $default |
|
1220 | - ? '' |
|
1221 | - : $datetime->get_pretty( |
|
1222 | - 'DTT_reg_limit', |
|
1223 | - 'input' |
|
1224 | - ), |
|
1225 | - 'DTT_order' => $default ? 'DTTNUM' : $datetime_row, |
|
1226 | - 'dtt_sold' => $default ? '0' : $datetime->get('DTT_sold'), |
|
1227 | - 'dtt_reserved' => $default ? '0' : $datetime->reserved(), |
|
1228 | - 'clone_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
1229 | - ? '' |
|
1230 | - : 'clone-icon ee-icon ee-icon-clone clickable', |
|
1231 | - 'trash_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
1232 | - ? 'ee-lock-icon' |
|
1233 | - : 'trash-icon dashicons dashicons-post-trash clickable', |
|
1234 | - 'reg_list_url' => $default || ! $datetime->event() instanceof \EE_Event |
|
1235 | - ? '' |
|
1236 | - : EE_Admin_Page::add_query_args_and_nonce( |
|
1237 | - array('event_id' => $datetime->event()->ID(), 'datetime_id' => $datetime->ID()), |
|
1238 | - REG_ADMIN_URL |
|
1239 | - ), |
|
1240 | - ); |
|
1241 | - $template_args['show_trash'] = count($all_datetimes) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
1242 | - ? ' style="display:none"' |
|
1243 | - : ''; |
|
1244 | - // allow filtering of template args at this point. |
|
1245 | - $template_args = apply_filters( |
|
1246 | - 'FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args', |
|
1247 | - $template_args, |
|
1248 | - $datetime_row, |
|
1249 | - $datetime, |
|
1250 | - $default, |
|
1251 | - $all_datetimes, |
|
1252 | - $this->_is_creating_event |
|
1253 | - ); |
|
1254 | - return EEH_Template::display_template( |
|
1255 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php', |
|
1256 | - $template_args, |
|
1257 | - true |
|
1258 | - ); |
|
1259 | - } |
|
1193 | + /** |
|
1194 | + * This method is used to generate a dtt fields edit row. |
|
1195 | + * The same row is used to generate a row with valid DTT objects |
|
1196 | + * and the default row that is used as the skeleton by the js. |
|
1197 | + * |
|
1198 | + * @param int $datetime_row The row number for the row being generated. |
|
1199 | + * @param EE_Datetime $datetime |
|
1200 | + * @param bool $default Whether a default row is being generated or not. |
|
1201 | + * @param EE_Datetime[] $all_datetimes This is the array of all datetimes used in the editor. |
|
1202 | + * @return string |
|
1203 | + * @throws DomainException |
|
1204 | + * @throws EE_Error |
|
1205 | + */ |
|
1206 | + protected function _get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes) |
|
1207 | + { |
|
1208 | + // if the incoming $datetime object is NOT an instance of EE_Datetime then force default to true. |
|
1209 | + $default = ! $datetime instanceof EE_Datetime ? true : $default; |
|
1210 | + $template_args = array( |
|
1211 | + 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
1212 | + 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
1213 | + 'edit_dtt_expanded' => '', |
|
1214 | + 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
1215 | + 'DTT_name' => $default ? '' : $datetime->get_f('DTT_name'), |
|
1216 | + 'DTT_description' => $default ? '' : $datetime->get_f('DTT_description'), |
|
1217 | + 'DTT_EVT_start' => $default ? '' : $datetime->start_date($this->_date_time_format), |
|
1218 | + 'DTT_EVT_end' => $default ? '' : $datetime->end_date($this->_date_time_format), |
|
1219 | + 'DTT_reg_limit' => $default |
|
1220 | + ? '' |
|
1221 | + : $datetime->get_pretty( |
|
1222 | + 'DTT_reg_limit', |
|
1223 | + 'input' |
|
1224 | + ), |
|
1225 | + 'DTT_order' => $default ? 'DTTNUM' : $datetime_row, |
|
1226 | + 'dtt_sold' => $default ? '0' : $datetime->get('DTT_sold'), |
|
1227 | + 'dtt_reserved' => $default ? '0' : $datetime->reserved(), |
|
1228 | + 'clone_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
1229 | + ? '' |
|
1230 | + : 'clone-icon ee-icon ee-icon-clone clickable', |
|
1231 | + 'trash_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
1232 | + ? 'ee-lock-icon' |
|
1233 | + : 'trash-icon dashicons dashicons-post-trash clickable', |
|
1234 | + 'reg_list_url' => $default || ! $datetime->event() instanceof \EE_Event |
|
1235 | + ? '' |
|
1236 | + : EE_Admin_Page::add_query_args_and_nonce( |
|
1237 | + array('event_id' => $datetime->event()->ID(), 'datetime_id' => $datetime->ID()), |
|
1238 | + REG_ADMIN_URL |
|
1239 | + ), |
|
1240 | + ); |
|
1241 | + $template_args['show_trash'] = count($all_datetimes) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
1242 | + ? ' style="display:none"' |
|
1243 | + : ''; |
|
1244 | + // allow filtering of template args at this point. |
|
1245 | + $template_args = apply_filters( |
|
1246 | + 'FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args', |
|
1247 | + $template_args, |
|
1248 | + $datetime_row, |
|
1249 | + $datetime, |
|
1250 | + $default, |
|
1251 | + $all_datetimes, |
|
1252 | + $this->_is_creating_event |
|
1253 | + ); |
|
1254 | + return EEH_Template::display_template( |
|
1255 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php', |
|
1256 | + $template_args, |
|
1257 | + true |
|
1258 | + ); |
|
1259 | + } |
|
1260 | 1260 | |
1261 | 1261 | |
1262 | - /** |
|
1263 | - * @param int $datetime_row |
|
1264 | - * @param EE_Datetime $datetime |
|
1265 | - * @param array $datetime_tickets |
|
1266 | - * @param array $all_tickets |
|
1267 | - * @param bool $default |
|
1268 | - * @return mixed |
|
1269 | - * @throws DomainException |
|
1270 | - * @throws EE_Error |
|
1271 | - */ |
|
1272 | - protected function _get_dtt_attached_tickets_row( |
|
1273 | - $datetime_row, |
|
1274 | - $datetime, |
|
1275 | - $datetime_tickets = array(), |
|
1276 | - $all_tickets = array(), |
|
1277 | - $default |
|
1278 | - ) { |
|
1279 | - $template_args = array( |
|
1280 | - 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
1281 | - 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
1282 | - 'DTT_description' => $default ? '' : $datetime->get_f('DTT_description'), |
|
1283 | - 'datetime_tickets_list' => $default ? '<li class="hidden"></li>' : '', |
|
1284 | - 'show_tickets_row' => ' style="display:none;"', |
|
1285 | - 'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link( |
|
1286 | - 'add_new_ticket_via_datetime', |
|
1287 | - $this->_adminpage_obj->page_slug, |
|
1288 | - $this->_adminpage_obj->get_req_action(), |
|
1289 | - false, |
|
1290 | - false |
|
1291 | - ), |
|
1292 | - // todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
1293 | - 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
1294 | - ); |
|
1295 | - // need to setup the list items (but only if this isn't a default skeleton setup) |
|
1296 | - if (! $default) { |
|
1297 | - $ticket_row = 1; |
|
1298 | - foreach ($all_tickets as $ticket) { |
|
1299 | - $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
1300 | - $datetime_row, |
|
1301 | - $ticket_row, |
|
1302 | - $datetime, |
|
1303 | - $ticket, |
|
1304 | - $datetime_tickets, |
|
1305 | - $default |
|
1306 | - ); |
|
1307 | - $ticket_row++; |
|
1308 | - } |
|
1309 | - } |
|
1310 | - // filter template args at this point |
|
1311 | - $template_args = apply_filters( |
|
1312 | - 'FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args', |
|
1313 | - $template_args, |
|
1314 | - $datetime_row, |
|
1315 | - $datetime, |
|
1316 | - $datetime_tickets, |
|
1317 | - $all_tickets, |
|
1318 | - $default, |
|
1319 | - $this->_is_creating_event |
|
1320 | - ); |
|
1321 | - return EEH_Template::display_template( |
|
1322 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php', |
|
1323 | - $template_args, |
|
1324 | - true |
|
1325 | - ); |
|
1326 | - } |
|
1262 | + /** |
|
1263 | + * @param int $datetime_row |
|
1264 | + * @param EE_Datetime $datetime |
|
1265 | + * @param array $datetime_tickets |
|
1266 | + * @param array $all_tickets |
|
1267 | + * @param bool $default |
|
1268 | + * @return mixed |
|
1269 | + * @throws DomainException |
|
1270 | + * @throws EE_Error |
|
1271 | + */ |
|
1272 | + protected function _get_dtt_attached_tickets_row( |
|
1273 | + $datetime_row, |
|
1274 | + $datetime, |
|
1275 | + $datetime_tickets = array(), |
|
1276 | + $all_tickets = array(), |
|
1277 | + $default |
|
1278 | + ) { |
|
1279 | + $template_args = array( |
|
1280 | + 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
1281 | + 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
1282 | + 'DTT_description' => $default ? '' : $datetime->get_f('DTT_description'), |
|
1283 | + 'datetime_tickets_list' => $default ? '<li class="hidden"></li>' : '', |
|
1284 | + 'show_tickets_row' => ' style="display:none;"', |
|
1285 | + 'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link( |
|
1286 | + 'add_new_ticket_via_datetime', |
|
1287 | + $this->_adminpage_obj->page_slug, |
|
1288 | + $this->_adminpage_obj->get_req_action(), |
|
1289 | + false, |
|
1290 | + false |
|
1291 | + ), |
|
1292 | + // todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
1293 | + 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
1294 | + ); |
|
1295 | + // need to setup the list items (but only if this isn't a default skeleton setup) |
|
1296 | + if (! $default) { |
|
1297 | + $ticket_row = 1; |
|
1298 | + foreach ($all_tickets as $ticket) { |
|
1299 | + $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
1300 | + $datetime_row, |
|
1301 | + $ticket_row, |
|
1302 | + $datetime, |
|
1303 | + $ticket, |
|
1304 | + $datetime_tickets, |
|
1305 | + $default |
|
1306 | + ); |
|
1307 | + $ticket_row++; |
|
1308 | + } |
|
1309 | + } |
|
1310 | + // filter template args at this point |
|
1311 | + $template_args = apply_filters( |
|
1312 | + 'FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args', |
|
1313 | + $template_args, |
|
1314 | + $datetime_row, |
|
1315 | + $datetime, |
|
1316 | + $datetime_tickets, |
|
1317 | + $all_tickets, |
|
1318 | + $default, |
|
1319 | + $this->_is_creating_event |
|
1320 | + ); |
|
1321 | + return EEH_Template::display_template( |
|
1322 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php', |
|
1323 | + $template_args, |
|
1324 | + true |
|
1325 | + ); |
|
1326 | + } |
|
1327 | 1327 | |
1328 | 1328 | |
1329 | - /** |
|
1330 | - * @param int $datetime_row |
|
1331 | - * @param int $ticket_row |
|
1332 | - * @param EE_Datetime $datetime |
|
1333 | - * @param EE_Ticket $ticket |
|
1334 | - * @param array $datetime_tickets |
|
1335 | - * @param bool $default |
|
1336 | - * @return mixed |
|
1337 | - * @throws DomainException |
|
1338 | - * @throws EE_Error |
|
1339 | - */ |
|
1340 | - protected function _get_datetime_tickets_list_item( |
|
1341 | - $datetime_row, |
|
1342 | - $ticket_row, |
|
1343 | - $datetime, |
|
1344 | - $ticket, |
|
1345 | - $datetime_tickets = array(), |
|
1346 | - $default |
|
1347 | - ) { |
|
1348 | - $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[ $datetime->ID() ]) |
|
1349 | - ? $datetime_tickets[ $datetime->ID() ] |
|
1350 | - : array(); |
|
1351 | - $display_row = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0; |
|
1352 | - $no_ticket = $default && empty($ticket); |
|
1353 | - $template_args = array( |
|
1354 | - 'dtt_row' => $default |
|
1355 | - ? 'DTTNUM' |
|
1356 | - : $datetime_row, |
|
1357 | - 'tkt_row' => $no_ticket |
|
1358 | - ? 'TICKETNUM' |
|
1359 | - : $ticket_row, |
|
1360 | - 'datetime_ticket_checked' => in_array($display_row, $dtt_tkts, true) |
|
1361 | - ? ' checked="checked"' |
|
1362 | - : '', |
|
1363 | - 'ticket_selected' => in_array($display_row, $dtt_tkts, true) |
|
1364 | - ? ' ticket-selected' |
|
1365 | - : '', |
|
1366 | - 'TKT_name' => $no_ticket |
|
1367 | - ? 'TKTNAME' |
|
1368 | - : $ticket->get('TKT_name'), |
|
1369 | - 'tkt_status_class' => $no_ticket || $this->_is_creating_event |
|
1370 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
1371 | - : ' tkt-status-' . $ticket->ticket_status(), |
|
1372 | - ); |
|
1373 | - // filter template args |
|
1374 | - $template_args = apply_filters( |
|
1375 | - 'FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args', |
|
1376 | - $template_args, |
|
1377 | - $datetime_row, |
|
1378 | - $ticket_row, |
|
1379 | - $datetime, |
|
1380 | - $ticket, |
|
1381 | - $datetime_tickets, |
|
1382 | - $default, |
|
1383 | - $this->_is_creating_event |
|
1384 | - ); |
|
1385 | - return EEH_Template::display_template( |
|
1386 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php', |
|
1387 | - $template_args, |
|
1388 | - true |
|
1389 | - ); |
|
1390 | - } |
|
1329 | + /** |
|
1330 | + * @param int $datetime_row |
|
1331 | + * @param int $ticket_row |
|
1332 | + * @param EE_Datetime $datetime |
|
1333 | + * @param EE_Ticket $ticket |
|
1334 | + * @param array $datetime_tickets |
|
1335 | + * @param bool $default |
|
1336 | + * @return mixed |
|
1337 | + * @throws DomainException |
|
1338 | + * @throws EE_Error |
|
1339 | + */ |
|
1340 | + protected function _get_datetime_tickets_list_item( |
|
1341 | + $datetime_row, |
|
1342 | + $ticket_row, |
|
1343 | + $datetime, |
|
1344 | + $ticket, |
|
1345 | + $datetime_tickets = array(), |
|
1346 | + $default |
|
1347 | + ) { |
|
1348 | + $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[ $datetime->ID() ]) |
|
1349 | + ? $datetime_tickets[ $datetime->ID() ] |
|
1350 | + : array(); |
|
1351 | + $display_row = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0; |
|
1352 | + $no_ticket = $default && empty($ticket); |
|
1353 | + $template_args = array( |
|
1354 | + 'dtt_row' => $default |
|
1355 | + ? 'DTTNUM' |
|
1356 | + : $datetime_row, |
|
1357 | + 'tkt_row' => $no_ticket |
|
1358 | + ? 'TICKETNUM' |
|
1359 | + : $ticket_row, |
|
1360 | + 'datetime_ticket_checked' => in_array($display_row, $dtt_tkts, true) |
|
1361 | + ? ' checked="checked"' |
|
1362 | + : '', |
|
1363 | + 'ticket_selected' => in_array($display_row, $dtt_tkts, true) |
|
1364 | + ? ' ticket-selected' |
|
1365 | + : '', |
|
1366 | + 'TKT_name' => $no_ticket |
|
1367 | + ? 'TKTNAME' |
|
1368 | + : $ticket->get('TKT_name'), |
|
1369 | + 'tkt_status_class' => $no_ticket || $this->_is_creating_event |
|
1370 | + ? ' tkt-status-' . EE_Ticket::onsale |
|
1371 | + : ' tkt-status-' . $ticket->ticket_status(), |
|
1372 | + ); |
|
1373 | + // filter template args |
|
1374 | + $template_args = apply_filters( |
|
1375 | + 'FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args', |
|
1376 | + $template_args, |
|
1377 | + $datetime_row, |
|
1378 | + $ticket_row, |
|
1379 | + $datetime, |
|
1380 | + $ticket, |
|
1381 | + $datetime_tickets, |
|
1382 | + $default, |
|
1383 | + $this->_is_creating_event |
|
1384 | + ); |
|
1385 | + return EEH_Template::display_template( |
|
1386 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php', |
|
1387 | + $template_args, |
|
1388 | + true |
|
1389 | + ); |
|
1390 | + } |
|
1391 | 1391 | |
1392 | 1392 | |
1393 | - /** |
|
1394 | - * This generates the ticket row for tickets. |
|
1395 | - * This same method is used to generate both the actual rows and the js skeleton row |
|
1396 | - * (when default === true) |
|
1397 | - * |
|
1398 | - * @param int $ticket_row Represents the row number being generated. |
|
1399 | - * @param $ticket |
|
1400 | - * @param EE_Datetime[] $ticket_datetimes Either an array of all datetimes on all tickets indexed by each ticket |
|
1401 | - * or empty for default |
|
1402 | - * @param EE_Datetime[] $all_datetimes All Datetimes on the event or empty for default. |
|
1403 | - * @param bool $default Whether default row being generated or not. |
|
1404 | - * @param EE_Ticket[] $all_tickets This is an array of all tickets attached to the event |
|
1405 | - * (or empty in the case of defaults) |
|
1406 | - * @return mixed |
|
1407 | - * @throws InvalidArgumentException |
|
1408 | - * @throws InvalidInterfaceException |
|
1409 | - * @throws InvalidDataTypeException |
|
1410 | - * @throws DomainException |
|
1411 | - * @throws EE_Error |
|
1412 | - * @throws ReflectionException |
|
1413 | - */ |
|
1414 | - protected function _get_ticket_row( |
|
1415 | - $ticket_row, |
|
1416 | - $ticket, |
|
1417 | - $ticket_datetimes, |
|
1418 | - $all_datetimes, |
|
1419 | - $default = false, |
|
1420 | - $all_tickets = array() |
|
1421 | - ) { |
|
1422 | - // if $ticket is not an instance of EE_Ticket then force default to true. |
|
1423 | - $default = ! $ticket instanceof EE_Ticket ? true : $default; |
|
1424 | - $prices = ! empty($ticket) && ! $default |
|
1425 | - ? $ticket->get_many_related( |
|
1426 | - 'Price', |
|
1427 | - array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC')) |
|
1428 | - ) |
|
1429 | - : array(); |
|
1430 | - // if there is only one price (which would be the base price) |
|
1431 | - // or NO prices and this ticket is a default ticket, |
|
1432 | - // let's just make sure there are no cached default prices on the object. |
|
1433 | - // This is done by not including any query_params. |
|
1434 | - if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) { |
|
1435 | - $prices = $ticket->prices(); |
|
1436 | - } |
|
1437 | - // check if we're dealing with a default ticket in which case |
|
1438 | - // we don't want any starting_ticket_datetime_row values set |
|
1439 | - // (otherwise there won't be any new relationships created for tickets based off of the default ticket). |
|
1440 | - // This will future proof in case there is ever any behaviour change between what the primary_key defaults to. |
|
1441 | - $default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->is_default()); |
|
1442 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
1443 | - ? $ticket_datetimes[ $ticket->ID() ] |
|
1444 | - : array(); |
|
1445 | - $ticket_subtotal = $default ? 0 : $ticket->get_ticket_subtotal(); |
|
1446 | - $base_price = $default ? null : $ticket->base_price(); |
|
1447 | - $count_price_mods = EEM_Price::instance()->get_all_default_prices(true); |
|
1448 | - // breaking out complicated condition for ticket_status |
|
1449 | - if ($default) { |
|
1450 | - $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale; |
|
1451 | - } else { |
|
1452 | - $ticket_status_class = $ticket->is_default() |
|
1453 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
1454 | - : ' tkt-status-' . $ticket->ticket_status(); |
|
1455 | - } |
|
1456 | - // breaking out complicated condition for TKT_taxable |
|
1457 | - if ($default) { |
|
1458 | - $TKT_taxable = ''; |
|
1459 | - } else { |
|
1460 | - $TKT_taxable = $ticket->taxable() |
|
1461 | - ? ' checked="checked"' |
|
1462 | - : ''; |
|
1463 | - } |
|
1464 | - if ($default) { |
|
1465 | - $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
1466 | - } elseif ($ticket->is_default()) { |
|
1467 | - $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
1468 | - } else { |
|
1469 | - $TKT_status = $ticket->ticket_status(true); |
|
1470 | - } |
|
1471 | - if ($default) { |
|
1472 | - $TKT_min = ''; |
|
1473 | - } else { |
|
1474 | - $TKT_min = $ticket->min(); |
|
1475 | - if ($TKT_min === -1 || $TKT_min === 0) { |
|
1476 | - $TKT_min = ''; |
|
1477 | - } |
|
1478 | - } |
|
1479 | - $template_args = array( |
|
1480 | - 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
1481 | - 'TKT_order' => $default ? 'TICKETNUM' : $ticket_row, |
|
1482 | - // on initial page load this will always be the correct order. |
|
1483 | - 'tkt_status_class' => $ticket_status_class, |
|
1484 | - 'display_edit_tkt_row' => ' style="display:none;"', |
|
1485 | - 'edit_tkt_expanded' => '', |
|
1486 | - 'edit_tickets_name' => $default ? 'TICKETNAMEATTR' : 'edit_tickets', |
|
1487 | - 'TKT_name' => $default ? '' : $ticket->get_f('TKT_name'), |
|
1488 | - 'TKT_start_date' => $default |
|
1489 | - ? '' |
|
1490 | - : $ticket->get_date('TKT_start_date', $this->_date_time_format), |
|
1491 | - 'TKT_end_date' => $default |
|
1492 | - ? '' |
|
1493 | - : $ticket->get_date('TKT_end_date', $this->_date_time_format), |
|
1494 | - 'TKT_status' => $TKT_status, |
|
1495 | - 'TKT_price' => $default |
|
1496 | - ? '' |
|
1497 | - : EEH_Template::format_currency( |
|
1498 | - $ticket->get_ticket_total_with_taxes(), |
|
1499 | - false, |
|
1500 | - false |
|
1501 | - ), |
|
1502 | - 'TKT_price_code' => EE_Registry::instance()->CFG->currency->code, |
|
1503 | - 'TKT_price_amount' => $default ? 0 : $ticket_subtotal, |
|
1504 | - 'TKT_qty' => $default |
|
1505 | - ? '' |
|
1506 | - : $ticket->get_pretty('TKT_qty', 'symbol'), |
|
1507 | - 'TKT_qty_for_input' => $default |
|
1508 | - ? '' |
|
1509 | - : $ticket->get_pretty('TKT_qty', 'input'), |
|
1510 | - 'TKT_uses' => $default |
|
1511 | - ? '' |
|
1512 | - : $ticket->get_pretty('TKT_uses', 'input'), |
|
1513 | - 'TKT_min' => $TKT_min, |
|
1514 | - 'TKT_max' => $default |
|
1515 | - ? '' |
|
1516 | - : $ticket->get_pretty('TKT_max', 'input'), |
|
1517 | - 'TKT_sold' => $default ? 0 : $ticket->tickets_sold('ticket'), |
|
1518 | - 'TKT_reserved' => $default ? 0 : $ticket->reserved(), |
|
1519 | - 'TKT_registrations' => $default |
|
1520 | - ? 0 |
|
1521 | - : $ticket->count_registrations( |
|
1522 | - array( |
|
1523 | - array( |
|
1524 | - 'STS_ID' => array( |
|
1525 | - '!=', |
|
1526 | - EEM_Registration::status_id_incomplete, |
|
1527 | - ), |
|
1528 | - ), |
|
1529 | - ) |
|
1530 | - ), |
|
1531 | - 'TKT_ID' => $default ? 0 : $ticket->ID(), |
|
1532 | - 'TKT_description' => $default ? '' : $ticket->get_f('TKT_description'), |
|
1533 | - 'TKT_is_default' => $default ? 0 : $ticket->is_default(), |
|
1534 | - 'TKT_required' => $default ? 0 : $ticket->required(), |
|
1535 | - 'TKT_is_default_selector' => '', |
|
1536 | - 'ticket_price_rows' => '', |
|
1537 | - 'TKT_base_price' => $default || ! $base_price instanceof EE_Price |
|
1538 | - ? '' |
|
1539 | - : $base_price->get_pretty('PRC_amount', 'localized_float'), |
|
1540 | - 'TKT_base_price_ID' => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(), |
|
1541 | - 'show_price_modifier' => count($prices) > 1 || ($default && $count_price_mods > 0) |
|
1542 | - ? '' |
|
1543 | - : ' style="display:none;"', |
|
1544 | - 'show_price_mod_button' => count($prices) > 1 |
|
1545 | - || ($default && $count_price_mods > 0) |
|
1546 | - || (! $default && $ticket->deleted()) |
|
1547 | - ? ' style="display:none;"' |
|
1548 | - : '', |
|
1549 | - 'total_price_rows' => count($prices) > 1 ? count($prices) : 1, |
|
1550 | - 'ticket_datetimes_list' => $default ? '<li class="hidden"></li>' : '', |
|
1551 | - 'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_datetimes), |
|
1552 | - 'ticket_datetime_rows' => $default ? '' : implode(',', $tkt_datetimes), |
|
1553 | - 'existing_ticket_price_ids' => $default ? '' : implode(',', array_keys($prices)), |
|
1554 | - 'ticket_template_id' => $default ? 0 : $ticket->get('TTM_ID'), |
|
1555 | - 'TKT_taxable' => $TKT_taxable, |
|
1556 | - 'display_subtotal' => $ticket instanceof EE_Ticket && $ticket->taxable() |
|
1557 | - ? '' |
|
1558 | - : ' style="display:none"', |
|
1559 | - 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
1560 | - 'TKT_subtotal_amount_display' => EEH_Template::format_currency( |
|
1561 | - $ticket_subtotal, |
|
1562 | - false, |
|
1563 | - false |
|
1564 | - ), |
|
1565 | - 'TKT_subtotal_amount' => $ticket_subtotal, |
|
1566 | - 'tax_rows' => $this->_get_tax_rows($ticket_row, $ticket), |
|
1567 | - 'disabled' => $ticket instanceof EE_Ticket && $ticket->deleted(), |
|
1568 | - 'ticket_archive_class' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
1569 | - ? ' ticket-archived' |
|
1570 | - : '', |
|
1571 | - 'trash_icon' => $ticket instanceof EE_Ticket |
|
1572 | - && $ticket->deleted() |
|
1573 | - && ! $ticket->is_permanently_deleteable() |
|
1574 | - ? 'ee-lock-icon ' |
|
1575 | - : 'trash-icon dashicons dashicons-post-trash clickable', |
|
1576 | - 'clone_icon' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
1577 | - ? '' |
|
1578 | - : 'clone-icon ee-icon ee-icon-clone clickable', |
|
1579 | - ); |
|
1580 | - $template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
1581 | - ? ' style="display:none"' |
|
1582 | - : ''; |
|
1583 | - // handle rows that should NOT be empty |
|
1584 | - if (empty($template_args['TKT_start_date'])) { |
|
1585 | - // if empty then the start date will be now. |
|
1586 | - $template_args['TKT_start_date'] = date( |
|
1587 | - $this->_date_time_format, |
|
1588 | - current_time('timestamp') |
|
1589 | - ); |
|
1590 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
1591 | - } |
|
1592 | - if (empty($template_args['TKT_end_date'])) { |
|
1593 | - // get the earliest datetime (if present); |
|
1594 | - $earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 |
|
1595 | - ? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related( |
|
1596 | - 'Datetime', |
|
1597 | - array('order_by' => array('DTT_EVT_start' => 'ASC')) |
|
1598 | - ) |
|
1599 | - : null; |
|
1600 | - if (! empty($earliest_dtt)) { |
|
1601 | - $template_args['TKT_end_date'] = $earliest_dtt->get_datetime( |
|
1602 | - 'DTT_EVT_start', |
|
1603 | - $this->_date_time_format |
|
1604 | - ); |
|
1605 | - } else { |
|
1606 | - // default so let's just use what's been set for the default date-time which is 30 days from now. |
|
1607 | - $template_args['TKT_end_date'] = date( |
|
1608 | - $this->_date_time_format, |
|
1609 | - mktime( |
|
1610 | - 24, |
|
1611 | - 0, |
|
1612 | - 0, |
|
1613 | - date('m'), |
|
1614 | - date('d') + 29, |
|
1615 | - date('Y') |
|
1616 | - ) |
|
1617 | - ); |
|
1618 | - } |
|
1619 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
1620 | - } |
|
1621 | - // generate ticket_datetime items |
|
1622 | - if (! $default) { |
|
1623 | - $datetime_row = 1; |
|
1624 | - foreach ($all_datetimes as $datetime) { |
|
1625 | - $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
1626 | - $datetime_row, |
|
1627 | - $ticket_row, |
|
1628 | - $datetime, |
|
1629 | - $ticket, |
|
1630 | - $ticket_datetimes, |
|
1631 | - $default |
|
1632 | - ); |
|
1633 | - $datetime_row++; |
|
1634 | - } |
|
1635 | - } |
|
1636 | - $price_row = 1; |
|
1637 | - foreach ($prices as $price) { |
|
1638 | - if (! $price instanceof EE_Price) { |
|
1639 | - continue; |
|
1640 | - } |
|
1641 | - if ($price->is_base_price()) { |
|
1642 | - $price_row++; |
|
1643 | - continue; |
|
1644 | - } |
|
1645 | - $show_trash = ! ((count($prices) > 1 && $price_row === 1) || count($prices) === 1); |
|
1646 | - $show_create = ! (count($prices) > 1 && count($prices) !== $price_row); |
|
1647 | - $template_args['ticket_price_rows'] .= $this->_get_ticket_price_row( |
|
1648 | - $ticket_row, |
|
1649 | - $price_row, |
|
1650 | - $price, |
|
1651 | - $default, |
|
1652 | - $ticket, |
|
1653 | - $show_trash, |
|
1654 | - $show_create |
|
1655 | - ); |
|
1656 | - $price_row++; |
|
1657 | - } |
|
1658 | - // filter $template_args |
|
1659 | - $template_args = apply_filters( |
|
1660 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args', |
|
1661 | - $template_args, |
|
1662 | - $ticket_row, |
|
1663 | - $ticket, |
|
1664 | - $ticket_datetimes, |
|
1665 | - $all_datetimes, |
|
1666 | - $default, |
|
1667 | - $all_tickets, |
|
1668 | - $this->_is_creating_event |
|
1669 | - ); |
|
1670 | - return EEH_Template::display_template( |
|
1671 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php', |
|
1672 | - $template_args, |
|
1673 | - true |
|
1674 | - ); |
|
1675 | - } |
|
1393 | + /** |
|
1394 | + * This generates the ticket row for tickets. |
|
1395 | + * This same method is used to generate both the actual rows and the js skeleton row |
|
1396 | + * (when default === true) |
|
1397 | + * |
|
1398 | + * @param int $ticket_row Represents the row number being generated. |
|
1399 | + * @param $ticket |
|
1400 | + * @param EE_Datetime[] $ticket_datetimes Either an array of all datetimes on all tickets indexed by each ticket |
|
1401 | + * or empty for default |
|
1402 | + * @param EE_Datetime[] $all_datetimes All Datetimes on the event or empty for default. |
|
1403 | + * @param bool $default Whether default row being generated or not. |
|
1404 | + * @param EE_Ticket[] $all_tickets This is an array of all tickets attached to the event |
|
1405 | + * (or empty in the case of defaults) |
|
1406 | + * @return mixed |
|
1407 | + * @throws InvalidArgumentException |
|
1408 | + * @throws InvalidInterfaceException |
|
1409 | + * @throws InvalidDataTypeException |
|
1410 | + * @throws DomainException |
|
1411 | + * @throws EE_Error |
|
1412 | + * @throws ReflectionException |
|
1413 | + */ |
|
1414 | + protected function _get_ticket_row( |
|
1415 | + $ticket_row, |
|
1416 | + $ticket, |
|
1417 | + $ticket_datetimes, |
|
1418 | + $all_datetimes, |
|
1419 | + $default = false, |
|
1420 | + $all_tickets = array() |
|
1421 | + ) { |
|
1422 | + // if $ticket is not an instance of EE_Ticket then force default to true. |
|
1423 | + $default = ! $ticket instanceof EE_Ticket ? true : $default; |
|
1424 | + $prices = ! empty($ticket) && ! $default |
|
1425 | + ? $ticket->get_many_related( |
|
1426 | + 'Price', |
|
1427 | + array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC')) |
|
1428 | + ) |
|
1429 | + : array(); |
|
1430 | + // if there is only one price (which would be the base price) |
|
1431 | + // or NO prices and this ticket is a default ticket, |
|
1432 | + // let's just make sure there are no cached default prices on the object. |
|
1433 | + // This is done by not including any query_params. |
|
1434 | + if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) { |
|
1435 | + $prices = $ticket->prices(); |
|
1436 | + } |
|
1437 | + // check if we're dealing with a default ticket in which case |
|
1438 | + // we don't want any starting_ticket_datetime_row values set |
|
1439 | + // (otherwise there won't be any new relationships created for tickets based off of the default ticket). |
|
1440 | + // This will future proof in case there is ever any behaviour change between what the primary_key defaults to. |
|
1441 | + $default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->is_default()); |
|
1442 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
1443 | + ? $ticket_datetimes[ $ticket->ID() ] |
|
1444 | + : array(); |
|
1445 | + $ticket_subtotal = $default ? 0 : $ticket->get_ticket_subtotal(); |
|
1446 | + $base_price = $default ? null : $ticket->base_price(); |
|
1447 | + $count_price_mods = EEM_Price::instance()->get_all_default_prices(true); |
|
1448 | + // breaking out complicated condition for ticket_status |
|
1449 | + if ($default) { |
|
1450 | + $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale; |
|
1451 | + } else { |
|
1452 | + $ticket_status_class = $ticket->is_default() |
|
1453 | + ? ' tkt-status-' . EE_Ticket::onsale |
|
1454 | + : ' tkt-status-' . $ticket->ticket_status(); |
|
1455 | + } |
|
1456 | + // breaking out complicated condition for TKT_taxable |
|
1457 | + if ($default) { |
|
1458 | + $TKT_taxable = ''; |
|
1459 | + } else { |
|
1460 | + $TKT_taxable = $ticket->taxable() |
|
1461 | + ? ' checked="checked"' |
|
1462 | + : ''; |
|
1463 | + } |
|
1464 | + if ($default) { |
|
1465 | + $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
1466 | + } elseif ($ticket->is_default()) { |
|
1467 | + $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
1468 | + } else { |
|
1469 | + $TKT_status = $ticket->ticket_status(true); |
|
1470 | + } |
|
1471 | + if ($default) { |
|
1472 | + $TKT_min = ''; |
|
1473 | + } else { |
|
1474 | + $TKT_min = $ticket->min(); |
|
1475 | + if ($TKT_min === -1 || $TKT_min === 0) { |
|
1476 | + $TKT_min = ''; |
|
1477 | + } |
|
1478 | + } |
|
1479 | + $template_args = array( |
|
1480 | + 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
1481 | + 'TKT_order' => $default ? 'TICKETNUM' : $ticket_row, |
|
1482 | + // on initial page load this will always be the correct order. |
|
1483 | + 'tkt_status_class' => $ticket_status_class, |
|
1484 | + 'display_edit_tkt_row' => ' style="display:none;"', |
|
1485 | + 'edit_tkt_expanded' => '', |
|
1486 | + 'edit_tickets_name' => $default ? 'TICKETNAMEATTR' : 'edit_tickets', |
|
1487 | + 'TKT_name' => $default ? '' : $ticket->get_f('TKT_name'), |
|
1488 | + 'TKT_start_date' => $default |
|
1489 | + ? '' |
|
1490 | + : $ticket->get_date('TKT_start_date', $this->_date_time_format), |
|
1491 | + 'TKT_end_date' => $default |
|
1492 | + ? '' |
|
1493 | + : $ticket->get_date('TKT_end_date', $this->_date_time_format), |
|
1494 | + 'TKT_status' => $TKT_status, |
|
1495 | + 'TKT_price' => $default |
|
1496 | + ? '' |
|
1497 | + : EEH_Template::format_currency( |
|
1498 | + $ticket->get_ticket_total_with_taxes(), |
|
1499 | + false, |
|
1500 | + false |
|
1501 | + ), |
|
1502 | + 'TKT_price_code' => EE_Registry::instance()->CFG->currency->code, |
|
1503 | + 'TKT_price_amount' => $default ? 0 : $ticket_subtotal, |
|
1504 | + 'TKT_qty' => $default |
|
1505 | + ? '' |
|
1506 | + : $ticket->get_pretty('TKT_qty', 'symbol'), |
|
1507 | + 'TKT_qty_for_input' => $default |
|
1508 | + ? '' |
|
1509 | + : $ticket->get_pretty('TKT_qty', 'input'), |
|
1510 | + 'TKT_uses' => $default |
|
1511 | + ? '' |
|
1512 | + : $ticket->get_pretty('TKT_uses', 'input'), |
|
1513 | + 'TKT_min' => $TKT_min, |
|
1514 | + 'TKT_max' => $default |
|
1515 | + ? '' |
|
1516 | + : $ticket->get_pretty('TKT_max', 'input'), |
|
1517 | + 'TKT_sold' => $default ? 0 : $ticket->tickets_sold('ticket'), |
|
1518 | + 'TKT_reserved' => $default ? 0 : $ticket->reserved(), |
|
1519 | + 'TKT_registrations' => $default |
|
1520 | + ? 0 |
|
1521 | + : $ticket->count_registrations( |
|
1522 | + array( |
|
1523 | + array( |
|
1524 | + 'STS_ID' => array( |
|
1525 | + '!=', |
|
1526 | + EEM_Registration::status_id_incomplete, |
|
1527 | + ), |
|
1528 | + ), |
|
1529 | + ) |
|
1530 | + ), |
|
1531 | + 'TKT_ID' => $default ? 0 : $ticket->ID(), |
|
1532 | + 'TKT_description' => $default ? '' : $ticket->get_f('TKT_description'), |
|
1533 | + 'TKT_is_default' => $default ? 0 : $ticket->is_default(), |
|
1534 | + 'TKT_required' => $default ? 0 : $ticket->required(), |
|
1535 | + 'TKT_is_default_selector' => '', |
|
1536 | + 'ticket_price_rows' => '', |
|
1537 | + 'TKT_base_price' => $default || ! $base_price instanceof EE_Price |
|
1538 | + ? '' |
|
1539 | + : $base_price->get_pretty('PRC_amount', 'localized_float'), |
|
1540 | + 'TKT_base_price_ID' => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(), |
|
1541 | + 'show_price_modifier' => count($prices) > 1 || ($default && $count_price_mods > 0) |
|
1542 | + ? '' |
|
1543 | + : ' style="display:none;"', |
|
1544 | + 'show_price_mod_button' => count($prices) > 1 |
|
1545 | + || ($default && $count_price_mods > 0) |
|
1546 | + || (! $default && $ticket->deleted()) |
|
1547 | + ? ' style="display:none;"' |
|
1548 | + : '', |
|
1549 | + 'total_price_rows' => count($prices) > 1 ? count($prices) : 1, |
|
1550 | + 'ticket_datetimes_list' => $default ? '<li class="hidden"></li>' : '', |
|
1551 | + 'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_datetimes), |
|
1552 | + 'ticket_datetime_rows' => $default ? '' : implode(',', $tkt_datetimes), |
|
1553 | + 'existing_ticket_price_ids' => $default ? '' : implode(',', array_keys($prices)), |
|
1554 | + 'ticket_template_id' => $default ? 0 : $ticket->get('TTM_ID'), |
|
1555 | + 'TKT_taxable' => $TKT_taxable, |
|
1556 | + 'display_subtotal' => $ticket instanceof EE_Ticket && $ticket->taxable() |
|
1557 | + ? '' |
|
1558 | + : ' style="display:none"', |
|
1559 | + 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
1560 | + 'TKT_subtotal_amount_display' => EEH_Template::format_currency( |
|
1561 | + $ticket_subtotal, |
|
1562 | + false, |
|
1563 | + false |
|
1564 | + ), |
|
1565 | + 'TKT_subtotal_amount' => $ticket_subtotal, |
|
1566 | + 'tax_rows' => $this->_get_tax_rows($ticket_row, $ticket), |
|
1567 | + 'disabled' => $ticket instanceof EE_Ticket && $ticket->deleted(), |
|
1568 | + 'ticket_archive_class' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
1569 | + ? ' ticket-archived' |
|
1570 | + : '', |
|
1571 | + 'trash_icon' => $ticket instanceof EE_Ticket |
|
1572 | + && $ticket->deleted() |
|
1573 | + && ! $ticket->is_permanently_deleteable() |
|
1574 | + ? 'ee-lock-icon ' |
|
1575 | + : 'trash-icon dashicons dashicons-post-trash clickable', |
|
1576 | + 'clone_icon' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
1577 | + ? '' |
|
1578 | + : 'clone-icon ee-icon ee-icon-clone clickable', |
|
1579 | + ); |
|
1580 | + $template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
1581 | + ? ' style="display:none"' |
|
1582 | + : ''; |
|
1583 | + // handle rows that should NOT be empty |
|
1584 | + if (empty($template_args['TKT_start_date'])) { |
|
1585 | + // if empty then the start date will be now. |
|
1586 | + $template_args['TKT_start_date'] = date( |
|
1587 | + $this->_date_time_format, |
|
1588 | + current_time('timestamp') |
|
1589 | + ); |
|
1590 | + $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
1591 | + } |
|
1592 | + if (empty($template_args['TKT_end_date'])) { |
|
1593 | + // get the earliest datetime (if present); |
|
1594 | + $earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 |
|
1595 | + ? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related( |
|
1596 | + 'Datetime', |
|
1597 | + array('order_by' => array('DTT_EVT_start' => 'ASC')) |
|
1598 | + ) |
|
1599 | + : null; |
|
1600 | + if (! empty($earliest_dtt)) { |
|
1601 | + $template_args['TKT_end_date'] = $earliest_dtt->get_datetime( |
|
1602 | + 'DTT_EVT_start', |
|
1603 | + $this->_date_time_format |
|
1604 | + ); |
|
1605 | + } else { |
|
1606 | + // default so let's just use what's been set for the default date-time which is 30 days from now. |
|
1607 | + $template_args['TKT_end_date'] = date( |
|
1608 | + $this->_date_time_format, |
|
1609 | + mktime( |
|
1610 | + 24, |
|
1611 | + 0, |
|
1612 | + 0, |
|
1613 | + date('m'), |
|
1614 | + date('d') + 29, |
|
1615 | + date('Y') |
|
1616 | + ) |
|
1617 | + ); |
|
1618 | + } |
|
1619 | + $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
1620 | + } |
|
1621 | + // generate ticket_datetime items |
|
1622 | + if (! $default) { |
|
1623 | + $datetime_row = 1; |
|
1624 | + foreach ($all_datetimes as $datetime) { |
|
1625 | + $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
1626 | + $datetime_row, |
|
1627 | + $ticket_row, |
|
1628 | + $datetime, |
|
1629 | + $ticket, |
|
1630 | + $ticket_datetimes, |
|
1631 | + $default |
|
1632 | + ); |
|
1633 | + $datetime_row++; |
|
1634 | + } |
|
1635 | + } |
|
1636 | + $price_row = 1; |
|
1637 | + foreach ($prices as $price) { |
|
1638 | + if (! $price instanceof EE_Price) { |
|
1639 | + continue; |
|
1640 | + } |
|
1641 | + if ($price->is_base_price()) { |
|
1642 | + $price_row++; |
|
1643 | + continue; |
|
1644 | + } |
|
1645 | + $show_trash = ! ((count($prices) > 1 && $price_row === 1) || count($prices) === 1); |
|
1646 | + $show_create = ! (count($prices) > 1 && count($prices) !== $price_row); |
|
1647 | + $template_args['ticket_price_rows'] .= $this->_get_ticket_price_row( |
|
1648 | + $ticket_row, |
|
1649 | + $price_row, |
|
1650 | + $price, |
|
1651 | + $default, |
|
1652 | + $ticket, |
|
1653 | + $show_trash, |
|
1654 | + $show_create |
|
1655 | + ); |
|
1656 | + $price_row++; |
|
1657 | + } |
|
1658 | + // filter $template_args |
|
1659 | + $template_args = apply_filters( |
|
1660 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args', |
|
1661 | + $template_args, |
|
1662 | + $ticket_row, |
|
1663 | + $ticket, |
|
1664 | + $ticket_datetimes, |
|
1665 | + $all_datetimes, |
|
1666 | + $default, |
|
1667 | + $all_tickets, |
|
1668 | + $this->_is_creating_event |
|
1669 | + ); |
|
1670 | + return EEH_Template::display_template( |
|
1671 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php', |
|
1672 | + $template_args, |
|
1673 | + true |
|
1674 | + ); |
|
1675 | + } |
|
1676 | 1676 | |
1677 | 1677 | |
1678 | - /** |
|
1679 | - * @param int $ticket_row |
|
1680 | - * @param EE_Ticket|null $ticket |
|
1681 | - * @return string |
|
1682 | - * @throws DomainException |
|
1683 | - * @throws EE_Error |
|
1684 | - */ |
|
1685 | - protected function _get_tax_rows($ticket_row, $ticket) |
|
1686 | - { |
|
1687 | - $tax_rows = ''; |
|
1688 | - /** @var EE_Price[] $taxes */ |
|
1689 | - $taxes = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin(); |
|
1690 | - foreach ($taxes as $tax) { |
|
1691 | - $tax_added = $this->_get_tax_added($tax, $ticket); |
|
1692 | - $template_args = array( |
|
1693 | - 'display_tax' => ! empty($ticket) && $ticket->get('TKT_taxable') |
|
1694 | - ? '' |
|
1695 | - : ' style="display:none;"', |
|
1696 | - 'tax_id' => $tax->ID(), |
|
1697 | - 'tkt_row' => $ticket_row, |
|
1698 | - 'tax_label' => $tax->get('PRC_name'), |
|
1699 | - 'tax_added' => $tax_added, |
|
1700 | - 'tax_added_display' => EEH_Template::format_currency($tax_added, false, false), |
|
1701 | - 'tax_amount' => $tax->get('PRC_amount'), |
|
1702 | - ); |
|
1703 | - $template_args = apply_filters( |
|
1704 | - 'FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args', |
|
1705 | - $template_args, |
|
1706 | - $ticket_row, |
|
1707 | - $ticket, |
|
1708 | - $this->_is_creating_event |
|
1709 | - ); |
|
1710 | - $tax_rows .= EEH_Template::display_template( |
|
1711 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php', |
|
1712 | - $template_args, |
|
1713 | - true |
|
1714 | - ); |
|
1715 | - } |
|
1716 | - return $tax_rows; |
|
1717 | - } |
|
1678 | + /** |
|
1679 | + * @param int $ticket_row |
|
1680 | + * @param EE_Ticket|null $ticket |
|
1681 | + * @return string |
|
1682 | + * @throws DomainException |
|
1683 | + * @throws EE_Error |
|
1684 | + */ |
|
1685 | + protected function _get_tax_rows($ticket_row, $ticket) |
|
1686 | + { |
|
1687 | + $tax_rows = ''; |
|
1688 | + /** @var EE_Price[] $taxes */ |
|
1689 | + $taxes = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin(); |
|
1690 | + foreach ($taxes as $tax) { |
|
1691 | + $tax_added = $this->_get_tax_added($tax, $ticket); |
|
1692 | + $template_args = array( |
|
1693 | + 'display_tax' => ! empty($ticket) && $ticket->get('TKT_taxable') |
|
1694 | + ? '' |
|
1695 | + : ' style="display:none;"', |
|
1696 | + 'tax_id' => $tax->ID(), |
|
1697 | + 'tkt_row' => $ticket_row, |
|
1698 | + 'tax_label' => $tax->get('PRC_name'), |
|
1699 | + 'tax_added' => $tax_added, |
|
1700 | + 'tax_added_display' => EEH_Template::format_currency($tax_added, false, false), |
|
1701 | + 'tax_amount' => $tax->get('PRC_amount'), |
|
1702 | + ); |
|
1703 | + $template_args = apply_filters( |
|
1704 | + 'FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args', |
|
1705 | + $template_args, |
|
1706 | + $ticket_row, |
|
1707 | + $ticket, |
|
1708 | + $this->_is_creating_event |
|
1709 | + ); |
|
1710 | + $tax_rows .= EEH_Template::display_template( |
|
1711 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php', |
|
1712 | + $template_args, |
|
1713 | + true |
|
1714 | + ); |
|
1715 | + } |
|
1716 | + return $tax_rows; |
|
1717 | + } |
|
1718 | 1718 | |
1719 | 1719 | |
1720 | - /** |
|
1721 | - * @param EE_Price $tax |
|
1722 | - * @param EE_Ticket|null $ticket |
|
1723 | - * @return float|int |
|
1724 | - * @throws EE_Error |
|
1725 | - */ |
|
1726 | - protected function _get_tax_added(EE_Price $tax, $ticket) |
|
1727 | - { |
|
1728 | - $subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal(); |
|
1729 | - return $subtotal * $tax->get('PRC_amount') / 100; |
|
1730 | - } |
|
1720 | + /** |
|
1721 | + * @param EE_Price $tax |
|
1722 | + * @param EE_Ticket|null $ticket |
|
1723 | + * @return float|int |
|
1724 | + * @throws EE_Error |
|
1725 | + */ |
|
1726 | + protected function _get_tax_added(EE_Price $tax, $ticket) |
|
1727 | + { |
|
1728 | + $subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal(); |
|
1729 | + return $subtotal * $tax->get('PRC_amount') / 100; |
|
1730 | + } |
|
1731 | 1731 | |
1732 | 1732 | |
1733 | - /** |
|
1734 | - * @param int $ticket_row |
|
1735 | - * @param int $price_row |
|
1736 | - * @param EE_Price|null $price |
|
1737 | - * @param bool $default |
|
1738 | - * @param EE_Ticket|null $ticket |
|
1739 | - * @param bool $show_trash |
|
1740 | - * @param bool $show_create |
|
1741 | - * @return mixed |
|
1742 | - * @throws InvalidArgumentException |
|
1743 | - * @throws InvalidInterfaceException |
|
1744 | - * @throws InvalidDataTypeException |
|
1745 | - * @throws DomainException |
|
1746 | - * @throws EE_Error |
|
1747 | - * @throws ReflectionException |
|
1748 | - */ |
|
1749 | - protected function _get_ticket_price_row( |
|
1750 | - $ticket_row, |
|
1751 | - $price_row, |
|
1752 | - $price, |
|
1753 | - $default, |
|
1754 | - $ticket, |
|
1755 | - $show_trash = true, |
|
1756 | - $show_create = true |
|
1757 | - ) { |
|
1758 | - $send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted'); |
|
1759 | - $template_args = array( |
|
1760 | - 'tkt_row' => $default && empty($ticket) |
|
1761 | - ? 'TICKETNUM' |
|
1762 | - : $ticket_row, |
|
1763 | - 'PRC_order' => $default && empty($price) |
|
1764 | - ? 'PRICENUM' |
|
1765 | - : $price_row, |
|
1766 | - 'edit_prices_name' => $default && empty($price) |
|
1767 | - ? 'PRICENAMEATTR' |
|
1768 | - : 'edit_prices', |
|
1769 | - 'price_type_selector' => $default && empty($price) |
|
1770 | - ? $this->_get_base_price_template($ticket_row, $price_row, $price, $default) |
|
1771 | - : $this->_get_price_type_selector( |
|
1772 | - $ticket_row, |
|
1773 | - $price_row, |
|
1774 | - $price, |
|
1775 | - $default, |
|
1776 | - $send_disabled |
|
1777 | - ), |
|
1778 | - 'PRC_ID' => $default && empty($price) |
|
1779 | - ? 0 |
|
1780 | - : $price->ID(), |
|
1781 | - 'PRC_is_default' => $default && empty($price) |
|
1782 | - ? 0 |
|
1783 | - : $price->get('PRC_is_default'), |
|
1784 | - 'PRC_name' => $default && empty($price) |
|
1785 | - ? '' |
|
1786 | - : $price->get('PRC_name'), |
|
1787 | - 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
1788 | - 'show_plus_or_minus' => $default && empty($price) |
|
1789 | - ? '' |
|
1790 | - : ' style="display:none;"', |
|
1791 | - 'show_plus' => ($default && empty($price)) || ($price->is_discount() || $price->is_base_price()) |
|
1792 | - ? ' style="display:none;"' |
|
1793 | - : '', |
|
1794 | - 'show_minus' => ($default && empty($price)) || ! $price->is_discount() |
|
1795 | - ? ' style="display:none;"' |
|
1796 | - : '', |
|
1797 | - 'show_currency_symbol' => ($default && empty($price)) || $price->is_percent() |
|
1798 | - ? ' style="display:none"' |
|
1799 | - : '', |
|
1800 | - 'PRC_amount' => $default && empty($price) |
|
1801 | - ? 0 |
|
1802 | - : $price->get_pretty('PRC_amount', 'localized_float'), |
|
1803 | - 'show_percentage' => ($default && empty($price)) || ! $price->is_percent() |
|
1804 | - ? ' style="display:none;"' |
|
1805 | - : '', |
|
1806 | - 'show_trash_icon' => $show_trash |
|
1807 | - ? '' |
|
1808 | - : ' style="display:none;"', |
|
1809 | - 'show_create_button' => $show_create |
|
1810 | - ? '' |
|
1811 | - : ' style="display:none;"', |
|
1812 | - 'PRC_desc' => $default && empty($price) |
|
1813 | - ? '' |
|
1814 | - : $price->get('PRC_desc'), |
|
1815 | - 'disabled' => ! empty($ticket) && $ticket->get('TKT_deleted'), |
|
1816 | - ); |
|
1817 | - $template_args = apply_filters( |
|
1818 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args', |
|
1819 | - $template_args, |
|
1820 | - $ticket_row, |
|
1821 | - $price_row, |
|
1822 | - $price, |
|
1823 | - $default, |
|
1824 | - $ticket, |
|
1825 | - $show_trash, |
|
1826 | - $show_create, |
|
1827 | - $this->_is_creating_event |
|
1828 | - ); |
|
1829 | - return EEH_Template::display_template( |
|
1830 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php', |
|
1831 | - $template_args, |
|
1832 | - true |
|
1833 | - ); |
|
1834 | - } |
|
1733 | + /** |
|
1734 | + * @param int $ticket_row |
|
1735 | + * @param int $price_row |
|
1736 | + * @param EE_Price|null $price |
|
1737 | + * @param bool $default |
|
1738 | + * @param EE_Ticket|null $ticket |
|
1739 | + * @param bool $show_trash |
|
1740 | + * @param bool $show_create |
|
1741 | + * @return mixed |
|
1742 | + * @throws InvalidArgumentException |
|
1743 | + * @throws InvalidInterfaceException |
|
1744 | + * @throws InvalidDataTypeException |
|
1745 | + * @throws DomainException |
|
1746 | + * @throws EE_Error |
|
1747 | + * @throws ReflectionException |
|
1748 | + */ |
|
1749 | + protected function _get_ticket_price_row( |
|
1750 | + $ticket_row, |
|
1751 | + $price_row, |
|
1752 | + $price, |
|
1753 | + $default, |
|
1754 | + $ticket, |
|
1755 | + $show_trash = true, |
|
1756 | + $show_create = true |
|
1757 | + ) { |
|
1758 | + $send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted'); |
|
1759 | + $template_args = array( |
|
1760 | + 'tkt_row' => $default && empty($ticket) |
|
1761 | + ? 'TICKETNUM' |
|
1762 | + : $ticket_row, |
|
1763 | + 'PRC_order' => $default && empty($price) |
|
1764 | + ? 'PRICENUM' |
|
1765 | + : $price_row, |
|
1766 | + 'edit_prices_name' => $default && empty($price) |
|
1767 | + ? 'PRICENAMEATTR' |
|
1768 | + : 'edit_prices', |
|
1769 | + 'price_type_selector' => $default && empty($price) |
|
1770 | + ? $this->_get_base_price_template($ticket_row, $price_row, $price, $default) |
|
1771 | + : $this->_get_price_type_selector( |
|
1772 | + $ticket_row, |
|
1773 | + $price_row, |
|
1774 | + $price, |
|
1775 | + $default, |
|
1776 | + $send_disabled |
|
1777 | + ), |
|
1778 | + 'PRC_ID' => $default && empty($price) |
|
1779 | + ? 0 |
|
1780 | + : $price->ID(), |
|
1781 | + 'PRC_is_default' => $default && empty($price) |
|
1782 | + ? 0 |
|
1783 | + : $price->get('PRC_is_default'), |
|
1784 | + 'PRC_name' => $default && empty($price) |
|
1785 | + ? '' |
|
1786 | + : $price->get('PRC_name'), |
|
1787 | + 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
1788 | + 'show_plus_or_minus' => $default && empty($price) |
|
1789 | + ? '' |
|
1790 | + : ' style="display:none;"', |
|
1791 | + 'show_plus' => ($default && empty($price)) || ($price->is_discount() || $price->is_base_price()) |
|
1792 | + ? ' style="display:none;"' |
|
1793 | + : '', |
|
1794 | + 'show_minus' => ($default && empty($price)) || ! $price->is_discount() |
|
1795 | + ? ' style="display:none;"' |
|
1796 | + : '', |
|
1797 | + 'show_currency_symbol' => ($default && empty($price)) || $price->is_percent() |
|
1798 | + ? ' style="display:none"' |
|
1799 | + : '', |
|
1800 | + 'PRC_amount' => $default && empty($price) |
|
1801 | + ? 0 |
|
1802 | + : $price->get_pretty('PRC_amount', 'localized_float'), |
|
1803 | + 'show_percentage' => ($default && empty($price)) || ! $price->is_percent() |
|
1804 | + ? ' style="display:none;"' |
|
1805 | + : '', |
|
1806 | + 'show_trash_icon' => $show_trash |
|
1807 | + ? '' |
|
1808 | + : ' style="display:none;"', |
|
1809 | + 'show_create_button' => $show_create |
|
1810 | + ? '' |
|
1811 | + : ' style="display:none;"', |
|
1812 | + 'PRC_desc' => $default && empty($price) |
|
1813 | + ? '' |
|
1814 | + : $price->get('PRC_desc'), |
|
1815 | + 'disabled' => ! empty($ticket) && $ticket->get('TKT_deleted'), |
|
1816 | + ); |
|
1817 | + $template_args = apply_filters( |
|
1818 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args', |
|
1819 | + $template_args, |
|
1820 | + $ticket_row, |
|
1821 | + $price_row, |
|
1822 | + $price, |
|
1823 | + $default, |
|
1824 | + $ticket, |
|
1825 | + $show_trash, |
|
1826 | + $show_create, |
|
1827 | + $this->_is_creating_event |
|
1828 | + ); |
|
1829 | + return EEH_Template::display_template( |
|
1830 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php', |
|
1831 | + $template_args, |
|
1832 | + true |
|
1833 | + ); |
|
1834 | + } |
|
1835 | 1835 | |
1836 | 1836 | |
1837 | - /** |
|
1838 | - * @param int $ticket_row |
|
1839 | - * @param int $price_row |
|
1840 | - * @param EE_Price $price |
|
1841 | - * @param bool $default |
|
1842 | - * @param bool $disabled |
|
1843 | - * @return mixed |
|
1844 | - * @throws ReflectionException |
|
1845 | - * @throws InvalidArgumentException |
|
1846 | - * @throws InvalidInterfaceException |
|
1847 | - * @throws InvalidDataTypeException |
|
1848 | - * @throws DomainException |
|
1849 | - * @throws EE_Error |
|
1850 | - */ |
|
1851 | - protected function _get_price_type_selector($ticket_row, $price_row, $price, $default, $disabled = false) |
|
1852 | - { |
|
1853 | - if ($price->is_base_price()) { |
|
1854 | - return $this->_get_base_price_template( |
|
1855 | - $ticket_row, |
|
1856 | - $price_row, |
|
1857 | - $price, |
|
1858 | - $default |
|
1859 | - ); |
|
1860 | - } |
|
1861 | - return $this->_get_price_modifier_template( |
|
1862 | - $ticket_row, |
|
1863 | - $price_row, |
|
1864 | - $price, |
|
1865 | - $default, |
|
1866 | - $disabled |
|
1867 | - ); |
|
1868 | - } |
|
1837 | + /** |
|
1838 | + * @param int $ticket_row |
|
1839 | + * @param int $price_row |
|
1840 | + * @param EE_Price $price |
|
1841 | + * @param bool $default |
|
1842 | + * @param bool $disabled |
|
1843 | + * @return mixed |
|
1844 | + * @throws ReflectionException |
|
1845 | + * @throws InvalidArgumentException |
|
1846 | + * @throws InvalidInterfaceException |
|
1847 | + * @throws InvalidDataTypeException |
|
1848 | + * @throws DomainException |
|
1849 | + * @throws EE_Error |
|
1850 | + */ |
|
1851 | + protected function _get_price_type_selector($ticket_row, $price_row, $price, $default, $disabled = false) |
|
1852 | + { |
|
1853 | + if ($price->is_base_price()) { |
|
1854 | + return $this->_get_base_price_template( |
|
1855 | + $ticket_row, |
|
1856 | + $price_row, |
|
1857 | + $price, |
|
1858 | + $default |
|
1859 | + ); |
|
1860 | + } |
|
1861 | + return $this->_get_price_modifier_template( |
|
1862 | + $ticket_row, |
|
1863 | + $price_row, |
|
1864 | + $price, |
|
1865 | + $default, |
|
1866 | + $disabled |
|
1867 | + ); |
|
1868 | + } |
|
1869 | 1869 | |
1870 | 1870 | |
1871 | - /** |
|
1872 | - * @param int $ticket_row |
|
1873 | - * @param int $price_row |
|
1874 | - * @param EE_Price $price |
|
1875 | - * @param bool $default |
|
1876 | - * @return mixed |
|
1877 | - * @throws DomainException |
|
1878 | - * @throws EE_Error |
|
1879 | - */ |
|
1880 | - protected function _get_base_price_template($ticket_row, $price_row, $price, $default) |
|
1881 | - { |
|
1882 | - $template_args = array( |
|
1883 | - 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
1884 | - 'PRC_order' => $default && empty($price) ? 'PRICENUM' : $price_row, |
|
1885 | - 'PRT_ID' => $default && empty($price) ? 1 : $price->get('PRT_ID'), |
|
1886 | - 'PRT_name' => esc_html__('Price', 'event_espresso'), |
|
1887 | - 'price_selected_operator' => '+', |
|
1888 | - 'price_selected_is_percent' => 0, |
|
1889 | - ); |
|
1890 | - $template_args = apply_filters( |
|
1891 | - 'FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args', |
|
1892 | - $template_args, |
|
1893 | - $ticket_row, |
|
1894 | - $price_row, |
|
1895 | - $price, |
|
1896 | - $default, |
|
1897 | - $this->_is_creating_event |
|
1898 | - ); |
|
1899 | - return EEH_Template::display_template( |
|
1900 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php', |
|
1901 | - $template_args, |
|
1902 | - true |
|
1903 | - ); |
|
1904 | - } |
|
1871 | + /** |
|
1872 | + * @param int $ticket_row |
|
1873 | + * @param int $price_row |
|
1874 | + * @param EE_Price $price |
|
1875 | + * @param bool $default |
|
1876 | + * @return mixed |
|
1877 | + * @throws DomainException |
|
1878 | + * @throws EE_Error |
|
1879 | + */ |
|
1880 | + protected function _get_base_price_template($ticket_row, $price_row, $price, $default) |
|
1881 | + { |
|
1882 | + $template_args = array( |
|
1883 | + 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
1884 | + 'PRC_order' => $default && empty($price) ? 'PRICENUM' : $price_row, |
|
1885 | + 'PRT_ID' => $default && empty($price) ? 1 : $price->get('PRT_ID'), |
|
1886 | + 'PRT_name' => esc_html__('Price', 'event_espresso'), |
|
1887 | + 'price_selected_operator' => '+', |
|
1888 | + 'price_selected_is_percent' => 0, |
|
1889 | + ); |
|
1890 | + $template_args = apply_filters( |
|
1891 | + 'FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args', |
|
1892 | + $template_args, |
|
1893 | + $ticket_row, |
|
1894 | + $price_row, |
|
1895 | + $price, |
|
1896 | + $default, |
|
1897 | + $this->_is_creating_event |
|
1898 | + ); |
|
1899 | + return EEH_Template::display_template( |
|
1900 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php', |
|
1901 | + $template_args, |
|
1902 | + true |
|
1903 | + ); |
|
1904 | + } |
|
1905 | 1905 | |
1906 | 1906 | |
1907 | - /** |
|
1908 | - * @param int $ticket_row |
|
1909 | - * @param int $price_row |
|
1910 | - * @param EE_Price $price |
|
1911 | - * @param bool $default |
|
1912 | - * @param bool $disabled |
|
1913 | - * @return mixed |
|
1914 | - * @throws ReflectionException |
|
1915 | - * @throws InvalidArgumentException |
|
1916 | - * @throws InvalidInterfaceException |
|
1917 | - * @throws InvalidDataTypeException |
|
1918 | - * @throws DomainException |
|
1919 | - * @throws EE_Error |
|
1920 | - */ |
|
1921 | - protected function _get_price_modifier_template( |
|
1922 | - $ticket_row, |
|
1923 | - $price_row, |
|
1924 | - $price, |
|
1925 | - $default, |
|
1926 | - $disabled = false |
|
1927 | - ) { |
|
1928 | - $select_name = $default && ! $price instanceof EE_Price |
|
1929 | - ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' |
|
1930 | - : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]'; |
|
1931 | - /** @var EEM_Price_Type $price_type_model */ |
|
1932 | - $price_type_model = EE_Registry::instance()->load_model('Price_Type'); |
|
1933 | - $price_types = $price_type_model->get_all(array( |
|
1934 | - array( |
|
1935 | - 'OR' => array( |
|
1936 | - 'PBT_ID' => '2', |
|
1937 | - 'PBT_ID*' => '3', |
|
1938 | - ), |
|
1939 | - ), |
|
1940 | - )); |
|
1941 | - $all_price_types = $default && ! $price instanceof EE_Price |
|
1942 | - ? array(esc_html__('Select Modifier', 'event_espresso')) |
|
1943 | - : array(); |
|
1944 | - $selected_price_type_id = $default && ! $price instanceof EE_Price ? 0 : $price->type(); |
|
1945 | - $price_option_spans = ''; |
|
1946 | - // setup price types for selector |
|
1947 | - foreach ($price_types as $price_type) { |
|
1948 | - if (! $price_type instanceof EE_Price_Type) { |
|
1949 | - continue; |
|
1950 | - } |
|
1951 | - $all_price_types[ $price_type->ID() ] = $price_type->get('PRT_name'); |
|
1952 | - // while we're in the loop let's setup the option spans used by js |
|
1953 | - $span_args = array( |
|
1954 | - 'PRT_ID' => $price_type->ID(), |
|
1955 | - 'PRT_operator' => $price_type->is_discount() ? '-' : '+', |
|
1956 | - 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0, |
|
1957 | - ); |
|
1958 | - $price_option_spans .= EEH_Template::display_template( |
|
1959 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php', |
|
1960 | - $span_args, |
|
1961 | - true |
|
1962 | - ); |
|
1963 | - } |
|
1964 | - $select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' |
|
1965 | - : $select_name; |
|
1966 | - $select_input = new EE_Select_Input( |
|
1967 | - $all_price_types, |
|
1968 | - array( |
|
1969 | - 'default' => $selected_price_type_id, |
|
1970 | - 'html_name' => $select_name, |
|
1971 | - 'html_class' => 'edit-price-PRT_ID', |
|
1972 | - 'html_other_attributes' => $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"', |
|
1973 | - ) |
|
1974 | - ); |
|
1975 | - $price_selected_operator = $price instanceof EE_Price && $price->is_discount() ? '-' : '+'; |
|
1976 | - $price_selected_operator = $default && ! $price instanceof EE_Price ? '' : $price_selected_operator; |
|
1977 | - $price_selected_is_percent = $price instanceof EE_Price && $price->is_percent() ? 1 : 0; |
|
1978 | - $price_selected_is_percent = $default && ! $price instanceof EE_Price ? '' : $price_selected_is_percent; |
|
1979 | - $template_args = array( |
|
1980 | - 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
1981 | - 'PRC_order' => $default && ! $price instanceof EE_Price ? 'PRICENUM' : $price_row, |
|
1982 | - 'price_modifier_selector' => $select_input->get_html_for_input(), |
|
1983 | - 'main_name' => $select_name, |
|
1984 | - 'selected_price_type_id' => $selected_price_type_id, |
|
1985 | - 'price_option_spans' => $price_option_spans, |
|
1986 | - 'price_selected_operator' => $price_selected_operator, |
|
1987 | - 'price_selected_is_percent' => $price_selected_is_percent, |
|
1988 | - 'disabled' => $disabled, |
|
1989 | - ); |
|
1990 | - $template_args = apply_filters( |
|
1991 | - 'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args', |
|
1992 | - $template_args, |
|
1993 | - $ticket_row, |
|
1994 | - $price_row, |
|
1995 | - $price, |
|
1996 | - $default, |
|
1997 | - $disabled, |
|
1998 | - $this->_is_creating_event |
|
1999 | - ); |
|
2000 | - return EEH_Template::display_template( |
|
2001 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php', |
|
2002 | - $template_args, |
|
2003 | - true |
|
2004 | - ); |
|
2005 | - } |
|
1907 | + /** |
|
1908 | + * @param int $ticket_row |
|
1909 | + * @param int $price_row |
|
1910 | + * @param EE_Price $price |
|
1911 | + * @param bool $default |
|
1912 | + * @param bool $disabled |
|
1913 | + * @return mixed |
|
1914 | + * @throws ReflectionException |
|
1915 | + * @throws InvalidArgumentException |
|
1916 | + * @throws InvalidInterfaceException |
|
1917 | + * @throws InvalidDataTypeException |
|
1918 | + * @throws DomainException |
|
1919 | + * @throws EE_Error |
|
1920 | + */ |
|
1921 | + protected function _get_price_modifier_template( |
|
1922 | + $ticket_row, |
|
1923 | + $price_row, |
|
1924 | + $price, |
|
1925 | + $default, |
|
1926 | + $disabled = false |
|
1927 | + ) { |
|
1928 | + $select_name = $default && ! $price instanceof EE_Price |
|
1929 | + ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' |
|
1930 | + : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]'; |
|
1931 | + /** @var EEM_Price_Type $price_type_model */ |
|
1932 | + $price_type_model = EE_Registry::instance()->load_model('Price_Type'); |
|
1933 | + $price_types = $price_type_model->get_all(array( |
|
1934 | + array( |
|
1935 | + 'OR' => array( |
|
1936 | + 'PBT_ID' => '2', |
|
1937 | + 'PBT_ID*' => '3', |
|
1938 | + ), |
|
1939 | + ), |
|
1940 | + )); |
|
1941 | + $all_price_types = $default && ! $price instanceof EE_Price |
|
1942 | + ? array(esc_html__('Select Modifier', 'event_espresso')) |
|
1943 | + : array(); |
|
1944 | + $selected_price_type_id = $default && ! $price instanceof EE_Price ? 0 : $price->type(); |
|
1945 | + $price_option_spans = ''; |
|
1946 | + // setup price types for selector |
|
1947 | + foreach ($price_types as $price_type) { |
|
1948 | + if (! $price_type instanceof EE_Price_Type) { |
|
1949 | + continue; |
|
1950 | + } |
|
1951 | + $all_price_types[ $price_type->ID() ] = $price_type->get('PRT_name'); |
|
1952 | + // while we're in the loop let's setup the option spans used by js |
|
1953 | + $span_args = array( |
|
1954 | + 'PRT_ID' => $price_type->ID(), |
|
1955 | + 'PRT_operator' => $price_type->is_discount() ? '-' : '+', |
|
1956 | + 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0, |
|
1957 | + ); |
|
1958 | + $price_option_spans .= EEH_Template::display_template( |
|
1959 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php', |
|
1960 | + $span_args, |
|
1961 | + true |
|
1962 | + ); |
|
1963 | + } |
|
1964 | + $select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' |
|
1965 | + : $select_name; |
|
1966 | + $select_input = new EE_Select_Input( |
|
1967 | + $all_price_types, |
|
1968 | + array( |
|
1969 | + 'default' => $selected_price_type_id, |
|
1970 | + 'html_name' => $select_name, |
|
1971 | + 'html_class' => 'edit-price-PRT_ID', |
|
1972 | + 'html_other_attributes' => $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"', |
|
1973 | + ) |
|
1974 | + ); |
|
1975 | + $price_selected_operator = $price instanceof EE_Price && $price->is_discount() ? '-' : '+'; |
|
1976 | + $price_selected_operator = $default && ! $price instanceof EE_Price ? '' : $price_selected_operator; |
|
1977 | + $price_selected_is_percent = $price instanceof EE_Price && $price->is_percent() ? 1 : 0; |
|
1978 | + $price_selected_is_percent = $default && ! $price instanceof EE_Price ? '' : $price_selected_is_percent; |
|
1979 | + $template_args = array( |
|
1980 | + 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
1981 | + 'PRC_order' => $default && ! $price instanceof EE_Price ? 'PRICENUM' : $price_row, |
|
1982 | + 'price_modifier_selector' => $select_input->get_html_for_input(), |
|
1983 | + 'main_name' => $select_name, |
|
1984 | + 'selected_price_type_id' => $selected_price_type_id, |
|
1985 | + 'price_option_spans' => $price_option_spans, |
|
1986 | + 'price_selected_operator' => $price_selected_operator, |
|
1987 | + 'price_selected_is_percent' => $price_selected_is_percent, |
|
1988 | + 'disabled' => $disabled, |
|
1989 | + ); |
|
1990 | + $template_args = apply_filters( |
|
1991 | + 'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args', |
|
1992 | + $template_args, |
|
1993 | + $ticket_row, |
|
1994 | + $price_row, |
|
1995 | + $price, |
|
1996 | + $default, |
|
1997 | + $disabled, |
|
1998 | + $this->_is_creating_event |
|
1999 | + ); |
|
2000 | + return EEH_Template::display_template( |
|
2001 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php', |
|
2002 | + $template_args, |
|
2003 | + true |
|
2004 | + ); |
|
2005 | + } |
|
2006 | 2006 | |
2007 | 2007 | |
2008 | - /** |
|
2009 | - * @param int $datetime_row |
|
2010 | - * @param int $ticket_row |
|
2011 | - * @param EE_Datetime|null $datetime |
|
2012 | - * @param EE_Ticket|null $ticket |
|
2013 | - * @param array $ticket_datetimes |
|
2014 | - * @param bool $default |
|
2015 | - * @return mixed |
|
2016 | - * @throws DomainException |
|
2017 | - * @throws EE_Error |
|
2018 | - */ |
|
2019 | - protected function _get_ticket_datetime_list_item( |
|
2020 | - $datetime_row, |
|
2021 | - $ticket_row, |
|
2022 | - $datetime, |
|
2023 | - $ticket, |
|
2024 | - $ticket_datetimes = array(), |
|
2025 | - $default |
|
2026 | - ) { |
|
2027 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
2028 | - ? $ticket_datetimes[ $ticket->ID() ] |
|
2029 | - : array(); |
|
2030 | - $template_args = array( |
|
2031 | - 'dtt_row' => $default && ! $datetime instanceof EE_Datetime |
|
2032 | - ? 'DTTNUM' |
|
2033 | - : $datetime_row, |
|
2034 | - 'tkt_row' => $default |
|
2035 | - ? 'TICKETNUM' |
|
2036 | - : $ticket_row, |
|
2037 | - 'ticket_datetime_selected' => in_array($datetime_row, $tkt_datetimes, true) |
|
2038 | - ? ' ticket-selected' |
|
2039 | - : '', |
|
2040 | - 'ticket_datetime_checked' => in_array($datetime_row, $tkt_datetimes, true) |
|
2041 | - ? ' checked="checked"' |
|
2042 | - : '', |
|
2043 | - 'DTT_name' => $default && empty($datetime) |
|
2044 | - ? 'DTTNAME' |
|
2045 | - : $datetime->get_dtt_display_name(true), |
|
2046 | - 'tkt_status_class' => '', |
|
2047 | - ); |
|
2048 | - $template_args = apply_filters( |
|
2049 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args', |
|
2050 | - $template_args, |
|
2051 | - $datetime_row, |
|
2052 | - $ticket_row, |
|
2053 | - $datetime, |
|
2054 | - $ticket, |
|
2055 | - $ticket_datetimes, |
|
2056 | - $default, |
|
2057 | - $this->_is_creating_event |
|
2058 | - ); |
|
2059 | - return EEH_Template::display_template( |
|
2060 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
2061 | - $template_args, |
|
2062 | - true |
|
2063 | - ); |
|
2064 | - } |
|
2008 | + /** |
|
2009 | + * @param int $datetime_row |
|
2010 | + * @param int $ticket_row |
|
2011 | + * @param EE_Datetime|null $datetime |
|
2012 | + * @param EE_Ticket|null $ticket |
|
2013 | + * @param array $ticket_datetimes |
|
2014 | + * @param bool $default |
|
2015 | + * @return mixed |
|
2016 | + * @throws DomainException |
|
2017 | + * @throws EE_Error |
|
2018 | + */ |
|
2019 | + protected function _get_ticket_datetime_list_item( |
|
2020 | + $datetime_row, |
|
2021 | + $ticket_row, |
|
2022 | + $datetime, |
|
2023 | + $ticket, |
|
2024 | + $ticket_datetimes = array(), |
|
2025 | + $default |
|
2026 | + ) { |
|
2027 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
2028 | + ? $ticket_datetimes[ $ticket->ID() ] |
|
2029 | + : array(); |
|
2030 | + $template_args = array( |
|
2031 | + 'dtt_row' => $default && ! $datetime instanceof EE_Datetime |
|
2032 | + ? 'DTTNUM' |
|
2033 | + : $datetime_row, |
|
2034 | + 'tkt_row' => $default |
|
2035 | + ? 'TICKETNUM' |
|
2036 | + : $ticket_row, |
|
2037 | + 'ticket_datetime_selected' => in_array($datetime_row, $tkt_datetimes, true) |
|
2038 | + ? ' ticket-selected' |
|
2039 | + : '', |
|
2040 | + 'ticket_datetime_checked' => in_array($datetime_row, $tkt_datetimes, true) |
|
2041 | + ? ' checked="checked"' |
|
2042 | + : '', |
|
2043 | + 'DTT_name' => $default && empty($datetime) |
|
2044 | + ? 'DTTNAME' |
|
2045 | + : $datetime->get_dtt_display_name(true), |
|
2046 | + 'tkt_status_class' => '', |
|
2047 | + ); |
|
2048 | + $template_args = apply_filters( |
|
2049 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args', |
|
2050 | + $template_args, |
|
2051 | + $datetime_row, |
|
2052 | + $ticket_row, |
|
2053 | + $datetime, |
|
2054 | + $ticket, |
|
2055 | + $ticket_datetimes, |
|
2056 | + $default, |
|
2057 | + $this->_is_creating_event |
|
2058 | + ); |
|
2059 | + return EEH_Template::display_template( |
|
2060 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
2061 | + $template_args, |
|
2062 | + true |
|
2063 | + ); |
|
2064 | + } |
|
2065 | 2065 | |
2066 | 2066 | |
2067 | - /** |
|
2068 | - * @param array $all_datetimes |
|
2069 | - * @param array $all_tickets |
|
2070 | - * @return mixed |
|
2071 | - * @throws ReflectionException |
|
2072 | - * @throws InvalidArgumentException |
|
2073 | - * @throws InvalidInterfaceException |
|
2074 | - * @throws InvalidDataTypeException |
|
2075 | - * @throws DomainException |
|
2076 | - * @throws EE_Error |
|
2077 | - */ |
|
2078 | - protected function _get_ticket_js_structure($all_datetimes = array(), $all_tickets = array()) |
|
2079 | - { |
|
2080 | - $template_args = array( |
|
2081 | - 'default_datetime_edit_row' => $this->_get_dtt_edit_row( |
|
2082 | - 'DTTNUM', |
|
2083 | - null, |
|
2084 | - true, |
|
2085 | - $all_datetimes |
|
2086 | - ), |
|
2087 | - 'default_ticket_row' => $this->_get_ticket_row( |
|
2088 | - 'TICKETNUM', |
|
2089 | - null, |
|
2090 | - array(), |
|
2091 | - array(), |
|
2092 | - true |
|
2093 | - ), |
|
2094 | - 'default_price_row' => $this->_get_ticket_price_row( |
|
2095 | - 'TICKETNUM', |
|
2096 | - 'PRICENUM', |
|
2097 | - null, |
|
2098 | - true, |
|
2099 | - null |
|
2100 | - ), |
|
2101 | - 'default_price_rows' => '', |
|
2102 | - 'default_base_price_amount' => 0, |
|
2103 | - 'default_base_price_name' => '', |
|
2104 | - 'default_base_price_description' => '', |
|
2105 | - 'default_price_modifier_selector_row' => $this->_get_price_modifier_template( |
|
2106 | - 'TICKETNUM', |
|
2107 | - 'PRICENUM', |
|
2108 | - null, |
|
2109 | - true |
|
2110 | - ), |
|
2111 | - 'default_available_tickets_for_datetime' => $this->_get_dtt_attached_tickets_row( |
|
2112 | - 'DTTNUM', |
|
2113 | - null, |
|
2114 | - array(), |
|
2115 | - array(), |
|
2116 | - true |
|
2117 | - ), |
|
2118 | - 'existing_available_datetime_tickets_list' => '', |
|
2119 | - 'existing_available_ticket_datetimes_list' => '', |
|
2120 | - 'new_available_datetime_ticket_list_item' => $this->_get_datetime_tickets_list_item( |
|
2121 | - 'DTTNUM', |
|
2122 | - 'TICKETNUM', |
|
2123 | - null, |
|
2124 | - null, |
|
2125 | - array(), |
|
2126 | - true |
|
2127 | - ), |
|
2128 | - 'new_available_ticket_datetime_list_item' => $this->_get_ticket_datetime_list_item( |
|
2129 | - 'DTTNUM', |
|
2130 | - 'TICKETNUM', |
|
2131 | - null, |
|
2132 | - null, |
|
2133 | - array(), |
|
2134 | - true |
|
2135 | - ), |
|
2136 | - ); |
|
2137 | - $ticket_row = 1; |
|
2138 | - foreach ($all_tickets as $ticket) { |
|
2139 | - $template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
2140 | - 'DTTNUM', |
|
2141 | - $ticket_row, |
|
2142 | - null, |
|
2143 | - $ticket, |
|
2144 | - array(), |
|
2145 | - true |
|
2146 | - ); |
|
2147 | - $ticket_row++; |
|
2148 | - } |
|
2149 | - $datetime_row = 1; |
|
2150 | - foreach ($all_datetimes as $datetime) { |
|
2151 | - $template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
2152 | - $datetime_row, |
|
2153 | - 'TICKETNUM', |
|
2154 | - $datetime, |
|
2155 | - null, |
|
2156 | - array(), |
|
2157 | - true |
|
2158 | - ); |
|
2159 | - $datetime_row++; |
|
2160 | - } |
|
2161 | - /** @var EEM_Price $price_model */ |
|
2162 | - $price_model = EE_Registry::instance()->load_model('Price'); |
|
2163 | - $default_prices = $price_model->get_all_default_prices(); |
|
2164 | - $price_row = 1; |
|
2165 | - foreach ($default_prices as $price) { |
|
2166 | - if (! $price instanceof EE_Price) { |
|
2167 | - continue; |
|
2168 | - } |
|
2169 | - if ($price->is_base_price()) { |
|
2170 | - $template_args['default_base_price_amount'] = $price->get_pretty( |
|
2171 | - 'PRC_amount', |
|
2172 | - 'localized_float' |
|
2173 | - ); |
|
2174 | - $template_args['default_base_price_name'] = $price->get('PRC_name'); |
|
2175 | - $template_args['default_base_price_description'] = $price->get('PRC_desc'); |
|
2176 | - $price_row++; |
|
2177 | - continue; |
|
2178 | - } |
|
2179 | - $show_trash = ! ((count($default_prices) > 1 && $price_row === 1) |
|
2180 | - || count($default_prices) === 1); |
|
2181 | - $show_create = ! (count($default_prices) > 1 |
|
2182 | - && count($default_prices) |
|
2183 | - !== $price_row); |
|
2184 | - $template_args['default_price_rows'] .= $this->_get_ticket_price_row( |
|
2185 | - 'TICKETNUM', |
|
2186 | - $price_row, |
|
2187 | - $price, |
|
2188 | - true, |
|
2189 | - null, |
|
2190 | - $show_trash, |
|
2191 | - $show_create |
|
2192 | - ); |
|
2193 | - $price_row++; |
|
2194 | - } |
|
2195 | - $template_args = apply_filters( |
|
2196 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args', |
|
2197 | - $template_args, |
|
2198 | - $all_datetimes, |
|
2199 | - $all_tickets, |
|
2200 | - $this->_is_creating_event |
|
2201 | - ); |
|
2202 | - return EEH_Template::display_template( |
|
2203 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php', |
|
2204 | - $template_args, |
|
2205 | - true |
|
2206 | - ); |
|
2207 | - } |
|
2067 | + /** |
|
2068 | + * @param array $all_datetimes |
|
2069 | + * @param array $all_tickets |
|
2070 | + * @return mixed |
|
2071 | + * @throws ReflectionException |
|
2072 | + * @throws InvalidArgumentException |
|
2073 | + * @throws InvalidInterfaceException |
|
2074 | + * @throws InvalidDataTypeException |
|
2075 | + * @throws DomainException |
|
2076 | + * @throws EE_Error |
|
2077 | + */ |
|
2078 | + protected function _get_ticket_js_structure($all_datetimes = array(), $all_tickets = array()) |
|
2079 | + { |
|
2080 | + $template_args = array( |
|
2081 | + 'default_datetime_edit_row' => $this->_get_dtt_edit_row( |
|
2082 | + 'DTTNUM', |
|
2083 | + null, |
|
2084 | + true, |
|
2085 | + $all_datetimes |
|
2086 | + ), |
|
2087 | + 'default_ticket_row' => $this->_get_ticket_row( |
|
2088 | + 'TICKETNUM', |
|
2089 | + null, |
|
2090 | + array(), |
|
2091 | + array(), |
|
2092 | + true |
|
2093 | + ), |
|
2094 | + 'default_price_row' => $this->_get_ticket_price_row( |
|
2095 | + 'TICKETNUM', |
|
2096 | + 'PRICENUM', |
|
2097 | + null, |
|
2098 | + true, |
|
2099 | + null |
|
2100 | + ), |
|
2101 | + 'default_price_rows' => '', |
|
2102 | + 'default_base_price_amount' => 0, |
|
2103 | + 'default_base_price_name' => '', |
|
2104 | + 'default_base_price_description' => '', |
|
2105 | + 'default_price_modifier_selector_row' => $this->_get_price_modifier_template( |
|
2106 | + 'TICKETNUM', |
|
2107 | + 'PRICENUM', |
|
2108 | + null, |
|
2109 | + true |
|
2110 | + ), |
|
2111 | + 'default_available_tickets_for_datetime' => $this->_get_dtt_attached_tickets_row( |
|
2112 | + 'DTTNUM', |
|
2113 | + null, |
|
2114 | + array(), |
|
2115 | + array(), |
|
2116 | + true |
|
2117 | + ), |
|
2118 | + 'existing_available_datetime_tickets_list' => '', |
|
2119 | + 'existing_available_ticket_datetimes_list' => '', |
|
2120 | + 'new_available_datetime_ticket_list_item' => $this->_get_datetime_tickets_list_item( |
|
2121 | + 'DTTNUM', |
|
2122 | + 'TICKETNUM', |
|
2123 | + null, |
|
2124 | + null, |
|
2125 | + array(), |
|
2126 | + true |
|
2127 | + ), |
|
2128 | + 'new_available_ticket_datetime_list_item' => $this->_get_ticket_datetime_list_item( |
|
2129 | + 'DTTNUM', |
|
2130 | + 'TICKETNUM', |
|
2131 | + null, |
|
2132 | + null, |
|
2133 | + array(), |
|
2134 | + true |
|
2135 | + ), |
|
2136 | + ); |
|
2137 | + $ticket_row = 1; |
|
2138 | + foreach ($all_tickets as $ticket) { |
|
2139 | + $template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
2140 | + 'DTTNUM', |
|
2141 | + $ticket_row, |
|
2142 | + null, |
|
2143 | + $ticket, |
|
2144 | + array(), |
|
2145 | + true |
|
2146 | + ); |
|
2147 | + $ticket_row++; |
|
2148 | + } |
|
2149 | + $datetime_row = 1; |
|
2150 | + foreach ($all_datetimes as $datetime) { |
|
2151 | + $template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
2152 | + $datetime_row, |
|
2153 | + 'TICKETNUM', |
|
2154 | + $datetime, |
|
2155 | + null, |
|
2156 | + array(), |
|
2157 | + true |
|
2158 | + ); |
|
2159 | + $datetime_row++; |
|
2160 | + } |
|
2161 | + /** @var EEM_Price $price_model */ |
|
2162 | + $price_model = EE_Registry::instance()->load_model('Price'); |
|
2163 | + $default_prices = $price_model->get_all_default_prices(); |
|
2164 | + $price_row = 1; |
|
2165 | + foreach ($default_prices as $price) { |
|
2166 | + if (! $price instanceof EE_Price) { |
|
2167 | + continue; |
|
2168 | + } |
|
2169 | + if ($price->is_base_price()) { |
|
2170 | + $template_args['default_base_price_amount'] = $price->get_pretty( |
|
2171 | + 'PRC_amount', |
|
2172 | + 'localized_float' |
|
2173 | + ); |
|
2174 | + $template_args['default_base_price_name'] = $price->get('PRC_name'); |
|
2175 | + $template_args['default_base_price_description'] = $price->get('PRC_desc'); |
|
2176 | + $price_row++; |
|
2177 | + continue; |
|
2178 | + } |
|
2179 | + $show_trash = ! ((count($default_prices) > 1 && $price_row === 1) |
|
2180 | + || count($default_prices) === 1); |
|
2181 | + $show_create = ! (count($default_prices) > 1 |
|
2182 | + && count($default_prices) |
|
2183 | + !== $price_row); |
|
2184 | + $template_args['default_price_rows'] .= $this->_get_ticket_price_row( |
|
2185 | + 'TICKETNUM', |
|
2186 | + $price_row, |
|
2187 | + $price, |
|
2188 | + true, |
|
2189 | + null, |
|
2190 | + $show_trash, |
|
2191 | + $show_create |
|
2192 | + ); |
|
2193 | + $price_row++; |
|
2194 | + } |
|
2195 | + $template_args = apply_filters( |
|
2196 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args', |
|
2197 | + $template_args, |
|
2198 | + $all_datetimes, |
|
2199 | + $all_tickets, |
|
2200 | + $this->_is_creating_event |
|
2201 | + ); |
|
2202 | + return EEH_Template::display_template( |
|
2203 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php', |
|
2204 | + $template_args, |
|
2205 | + true |
|
2206 | + ); |
|
2207 | + } |
|
2208 | 2208 | } |
@@ -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,31 +750,31 @@ 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 ]->increaseSold($ticket->sold(), false); |
|
761 | + $saved_datetimes[$row_id]->increaseSold($ticket->sold(), false); |
|
762 | 762 | } |
763 | 763 | } |
764 | 764 | } |
765 | 765 | } |
766 | 766 | // then remove datetimes |
767 | - if (! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
767 | + if ( ! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
768 | 768 | foreach ($removed_datetimes as $row_id) { |
769 | 769 | $row_id = (int) $row_id; |
770 | 770 | // its entirely possible that a datetime got deleted (instead of just removed from relationship. |
771 | 771 | // So make sure we skip over this if the dtt isn't in the $saved_datetimes array) |
772 | - if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
773 | - $ticket->_remove_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
772 | + if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) { |
|
773 | + $ticket->_remove_relation_to($saved_datetimes[$row_id], 'Datetime'); |
|
774 | 774 | // Is this an existing ticket (has an ID) and does it have any sold? |
775 | 775 | // If so, then we need to remove it's sold from the DTT_sold. |
776 | 776 | if ($ticket->ID() && $ticket->sold() > 0) { |
777 | - $saved_datetimes[ $row_id ]->decreaseSold($ticket->sold()); |
|
777 | + $saved_datetimes[$row_id]->decreaseSold($ticket->sold()); |
|
778 | 778 | } |
779 | 779 | } |
780 | 780 | } |
@@ -887,7 +887,7 @@ discard block |
||
887 | 887 | ); |
888 | 888 | } |
889 | 889 | // possibly need to save tkt |
890 | - if (! $ticket->ID()) { |
|
890 | + if ( ! $ticket->ID()) { |
|
891 | 891 | $ticket->save(); |
892 | 892 | } |
893 | 893 | foreach ($prices as $row => $prc) { |
@@ -921,17 +921,17 @@ discard block |
||
921 | 921 | } |
922 | 922 | } |
923 | 923 | $price->save(); |
924 | - $updated_prices[ $price->ID() ] = $price; |
|
924 | + $updated_prices[$price->ID()] = $price; |
|
925 | 925 | $ticket->_add_relation_to($price, 'Price'); |
926 | 926 | } |
927 | 927 | // now let's remove any prices that got removed from the ticket |
928 | - if (! empty($current_prices_on_ticket)) { |
|
928 | + if ( ! empty($current_prices_on_ticket)) { |
|
929 | 929 | $current = array_keys($current_prices_on_ticket); |
930 | 930 | $updated = array_keys($updated_prices); |
931 | 931 | $prices_to_remove = array_diff($current, $updated); |
932 | - if (! empty($prices_to_remove)) { |
|
932 | + if ( ! empty($prices_to_remove)) { |
|
933 | 933 | foreach ($prices_to_remove as $prc_id) { |
934 | - $p = $current_prices_on_ticket[ $prc_id ]; |
|
934 | + $p = $current_prices_on_ticket[$prc_id]; |
|
935 | 935 | $ticket->_remove_relation_to($p, 'Price'); |
936 | 936 | // delete permanently the price |
937 | 937 | $p->delete_permanently(); |
@@ -1082,17 +1082,17 @@ discard block |
||
1082 | 1082 | $TKT_ID = $ticket->get('TKT_ID'); |
1083 | 1083 | $ticket_row = $ticket->get('TKT_row'); |
1084 | 1084 | // we only want unique tickets in our final display!! |
1085 | - if (! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
1085 | + if ( ! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
1086 | 1086 | $existing_ticket_ids[] = $TKT_ID; |
1087 | 1087 | $all_tickets[] = $ticket; |
1088 | 1088 | } |
1089 | 1089 | // temporary cache of this ticket info for this datetime for later processing of datetime rows. |
1090 | - $datetime_tickets[ $DTT_ID ][] = $ticket_row; |
|
1090 | + $datetime_tickets[$DTT_ID][] = $ticket_row; |
|
1091 | 1091 | // temporary cache of this datetime info for this ticket for later processing of ticket rows. |
1092 | - if (! isset($ticket_datetimes[ $TKT_ID ]) |
|
1093 | - || ! in_array($datetime_row, $ticket_datetimes[ $TKT_ID ], true) |
|
1092 | + if ( ! isset($ticket_datetimes[$TKT_ID]) |
|
1093 | + || ! in_array($datetime_row, $ticket_datetimes[$TKT_ID], true) |
|
1094 | 1094 | ) { |
1095 | - $ticket_datetimes[ $TKT_ID ][] = $datetime_row; |
|
1095 | + $ticket_datetimes[$TKT_ID][] = $datetime_row; |
|
1096 | 1096 | } |
1097 | 1097 | } |
1098 | 1098 | $datetime_row++; |
@@ -1103,7 +1103,7 @@ discard block |
||
1103 | 1103 | // sort $all_tickets by order |
1104 | 1104 | usort( |
1105 | 1105 | $all_tickets, |
1106 | - function (EE_Ticket $a, EE_Ticket $b) { |
|
1106 | + function(EE_Ticket $a, EE_Ticket $b) { |
|
1107 | 1107 | $a_order = (int) $a->get('TKT_order'); |
1108 | 1108 | $b_order = (int) $b->get('TKT_order'); |
1109 | 1109 | if ($a_order === $b_order) { |
@@ -1141,7 +1141,7 @@ discard block |
||
1141 | 1141 | } |
1142 | 1142 | $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets); |
1143 | 1143 | EEH_Template::display_template( |
1144 | - PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php', |
|
1144 | + PRICING_TEMPLATE_PATH.'event_tickets_metabox_main.template.php', |
|
1145 | 1145 | $main_template_args |
1146 | 1146 | ); |
1147 | 1147 | } |
@@ -1183,7 +1183,7 @@ discard block |
||
1183 | 1183 | 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
1184 | 1184 | ); |
1185 | 1185 | return EEH_Template::display_template( |
1186 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php', |
|
1186 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_row_wrapper.template.php', |
|
1187 | 1187 | $dtt_display_template_args, |
1188 | 1188 | true |
1189 | 1189 | ); |
@@ -1252,7 +1252,7 @@ discard block |
||
1252 | 1252 | $this->_is_creating_event |
1253 | 1253 | ); |
1254 | 1254 | return EEH_Template::display_template( |
1255 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php', |
|
1255 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_edit_row.template.php', |
|
1256 | 1256 | $template_args, |
1257 | 1257 | true |
1258 | 1258 | ); |
@@ -1293,7 +1293,7 @@ discard block |
||
1293 | 1293 | 'DTT_ID' => $default ? '' : $datetime->ID(), |
1294 | 1294 | ); |
1295 | 1295 | // need to setup the list items (but only if this isn't a default skeleton setup) |
1296 | - if (! $default) { |
|
1296 | + if ( ! $default) { |
|
1297 | 1297 | $ticket_row = 1; |
1298 | 1298 | foreach ($all_tickets as $ticket) { |
1299 | 1299 | $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
@@ -1319,7 +1319,7 @@ discard block |
||
1319 | 1319 | $this->_is_creating_event |
1320 | 1320 | ); |
1321 | 1321 | return EEH_Template::display_template( |
1322 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php', |
|
1322 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_attached_tickets_row.template.php', |
|
1323 | 1323 | $template_args, |
1324 | 1324 | true |
1325 | 1325 | ); |
@@ -1345,8 +1345,8 @@ discard block |
||
1345 | 1345 | $datetime_tickets = array(), |
1346 | 1346 | $default |
1347 | 1347 | ) { |
1348 | - $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[ $datetime->ID() ]) |
|
1349 | - ? $datetime_tickets[ $datetime->ID() ] |
|
1348 | + $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[$datetime->ID()]) |
|
1349 | + ? $datetime_tickets[$datetime->ID()] |
|
1350 | 1350 | : array(); |
1351 | 1351 | $display_row = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0; |
1352 | 1352 | $no_ticket = $default && empty($ticket); |
@@ -1367,8 +1367,8 @@ discard block |
||
1367 | 1367 | ? 'TKTNAME' |
1368 | 1368 | : $ticket->get('TKT_name'), |
1369 | 1369 | 'tkt_status_class' => $no_ticket || $this->_is_creating_event |
1370 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
1371 | - : ' tkt-status-' . $ticket->ticket_status(), |
|
1370 | + ? ' tkt-status-'.EE_Ticket::onsale |
|
1371 | + : ' tkt-status-'.$ticket->ticket_status(), |
|
1372 | 1372 | ); |
1373 | 1373 | // filter template args |
1374 | 1374 | $template_args = apply_filters( |
@@ -1383,7 +1383,7 @@ discard block |
||
1383 | 1383 | $this->_is_creating_event |
1384 | 1384 | ); |
1385 | 1385 | return EEH_Template::display_template( |
1386 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php', |
|
1386 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_dtt_tickets_list.template.php', |
|
1387 | 1387 | $template_args, |
1388 | 1388 | true |
1389 | 1389 | ); |
@@ -1439,19 +1439,19 @@ discard block |
||
1439 | 1439 | // (otherwise there won't be any new relationships created for tickets based off of the default ticket). |
1440 | 1440 | // This will future proof in case there is ever any behaviour change between what the primary_key defaults to. |
1441 | 1441 | $default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->is_default()); |
1442 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
1443 | - ? $ticket_datetimes[ $ticket->ID() ] |
|
1442 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) |
|
1443 | + ? $ticket_datetimes[$ticket->ID()] |
|
1444 | 1444 | : array(); |
1445 | 1445 | $ticket_subtotal = $default ? 0 : $ticket->get_ticket_subtotal(); |
1446 | 1446 | $base_price = $default ? null : $ticket->base_price(); |
1447 | 1447 | $count_price_mods = EEM_Price::instance()->get_all_default_prices(true); |
1448 | 1448 | // breaking out complicated condition for ticket_status |
1449 | 1449 | if ($default) { |
1450 | - $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale; |
|
1450 | + $ticket_status_class = ' tkt-status-'.EE_Ticket::onsale; |
|
1451 | 1451 | } else { |
1452 | 1452 | $ticket_status_class = $ticket->is_default() |
1453 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
1454 | - : ' tkt-status-' . $ticket->ticket_status(); |
|
1453 | + ? ' tkt-status-'.EE_Ticket::onsale |
|
1454 | + : ' tkt-status-'.$ticket->ticket_status(); |
|
1455 | 1455 | } |
1456 | 1456 | // breaking out complicated condition for TKT_taxable |
1457 | 1457 | if ($default) { |
@@ -1543,7 +1543,7 @@ discard block |
||
1543 | 1543 | : ' style="display:none;"', |
1544 | 1544 | 'show_price_mod_button' => count($prices) > 1 |
1545 | 1545 | || ($default && $count_price_mods > 0) |
1546 | - || (! $default && $ticket->deleted()) |
|
1546 | + || ( ! $default && $ticket->deleted()) |
|
1547 | 1547 | ? ' style="display:none;"' |
1548 | 1548 | : '', |
1549 | 1549 | 'total_price_rows' => count($prices) > 1 ? count($prices) : 1, |
@@ -1587,7 +1587,7 @@ discard block |
||
1587 | 1587 | $this->_date_time_format, |
1588 | 1588 | current_time('timestamp') |
1589 | 1589 | ); |
1590 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
1590 | + $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale; |
|
1591 | 1591 | } |
1592 | 1592 | if (empty($template_args['TKT_end_date'])) { |
1593 | 1593 | // get the earliest datetime (if present); |
@@ -1597,7 +1597,7 @@ discard block |
||
1597 | 1597 | array('order_by' => array('DTT_EVT_start' => 'ASC')) |
1598 | 1598 | ) |
1599 | 1599 | : null; |
1600 | - if (! empty($earliest_dtt)) { |
|
1600 | + if ( ! empty($earliest_dtt)) { |
|
1601 | 1601 | $template_args['TKT_end_date'] = $earliest_dtt->get_datetime( |
1602 | 1602 | 'DTT_EVT_start', |
1603 | 1603 | $this->_date_time_format |
@@ -1616,10 +1616,10 @@ discard block |
||
1616 | 1616 | ) |
1617 | 1617 | ); |
1618 | 1618 | } |
1619 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
1619 | + $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale; |
|
1620 | 1620 | } |
1621 | 1621 | // generate ticket_datetime items |
1622 | - if (! $default) { |
|
1622 | + if ( ! $default) { |
|
1623 | 1623 | $datetime_row = 1; |
1624 | 1624 | foreach ($all_datetimes as $datetime) { |
1625 | 1625 | $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
@@ -1635,7 +1635,7 @@ discard block |
||
1635 | 1635 | } |
1636 | 1636 | $price_row = 1; |
1637 | 1637 | foreach ($prices as $price) { |
1638 | - if (! $price instanceof EE_Price) { |
|
1638 | + if ( ! $price instanceof EE_Price) { |
|
1639 | 1639 | continue; |
1640 | 1640 | } |
1641 | 1641 | if ($price->is_base_price()) { |
@@ -1668,7 +1668,7 @@ discard block |
||
1668 | 1668 | $this->_is_creating_event |
1669 | 1669 | ); |
1670 | 1670 | return EEH_Template::display_template( |
1671 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php', |
|
1671 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_row.template.php', |
|
1672 | 1672 | $template_args, |
1673 | 1673 | true |
1674 | 1674 | ); |
@@ -1708,7 +1708,7 @@ discard block |
||
1708 | 1708 | $this->_is_creating_event |
1709 | 1709 | ); |
1710 | 1710 | $tax_rows .= EEH_Template::display_template( |
1711 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php', |
|
1711 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_tax_row.template.php', |
|
1712 | 1712 | $template_args, |
1713 | 1713 | true |
1714 | 1714 | ); |
@@ -1827,7 +1827,7 @@ discard block |
||
1827 | 1827 | $this->_is_creating_event |
1828 | 1828 | ); |
1829 | 1829 | return EEH_Template::display_template( |
1830 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php', |
|
1830 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_price_row.template.php', |
|
1831 | 1831 | $template_args, |
1832 | 1832 | true |
1833 | 1833 | ); |
@@ -1897,7 +1897,7 @@ discard block |
||
1897 | 1897 | $this->_is_creating_event |
1898 | 1898 | ); |
1899 | 1899 | return EEH_Template::display_template( |
1900 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php', |
|
1900 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_type_base.template.php', |
|
1901 | 1901 | $template_args, |
1902 | 1902 | true |
1903 | 1903 | ); |
@@ -1927,7 +1927,7 @@ discard block |
||
1927 | 1927 | ) { |
1928 | 1928 | $select_name = $default && ! $price instanceof EE_Price |
1929 | 1929 | ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' |
1930 | - : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]'; |
|
1930 | + : 'edit_prices['.$ticket_row.']['.$price_row.'][PRT_ID]'; |
|
1931 | 1931 | /** @var EEM_Price_Type $price_type_model */ |
1932 | 1932 | $price_type_model = EE_Registry::instance()->load_model('Price_Type'); |
1933 | 1933 | $price_types = $price_type_model->get_all(array( |
@@ -1945,10 +1945,10 @@ discard block |
||
1945 | 1945 | $price_option_spans = ''; |
1946 | 1946 | // setup price types for selector |
1947 | 1947 | foreach ($price_types as $price_type) { |
1948 | - if (! $price_type instanceof EE_Price_Type) { |
|
1948 | + if ( ! $price_type instanceof EE_Price_Type) { |
|
1949 | 1949 | continue; |
1950 | 1950 | } |
1951 | - $all_price_types[ $price_type->ID() ] = $price_type->get('PRT_name'); |
|
1951 | + $all_price_types[$price_type->ID()] = $price_type->get('PRT_name'); |
|
1952 | 1952 | // while we're in the loop let's setup the option spans used by js |
1953 | 1953 | $span_args = array( |
1954 | 1954 | 'PRT_ID' => $price_type->ID(), |
@@ -1956,12 +1956,12 @@ discard block |
||
1956 | 1956 | 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0, |
1957 | 1957 | ); |
1958 | 1958 | $price_option_spans .= EEH_Template::display_template( |
1959 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php', |
|
1959 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_option_span.template.php', |
|
1960 | 1960 | $span_args, |
1961 | 1961 | true |
1962 | 1962 | ); |
1963 | 1963 | } |
1964 | - $select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' |
|
1964 | + $select_name = $disabled ? 'archive_price['.$ticket_row.']['.$price_row.'][PRT_ID]' |
|
1965 | 1965 | : $select_name; |
1966 | 1966 | $select_input = new EE_Select_Input( |
1967 | 1967 | $all_price_types, |
@@ -1998,7 +1998,7 @@ discard block |
||
1998 | 1998 | $this->_is_creating_event |
1999 | 1999 | ); |
2000 | 2000 | return EEH_Template::display_template( |
2001 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php', |
|
2001 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_modifier_selector.template.php', |
|
2002 | 2002 | $template_args, |
2003 | 2003 | true |
2004 | 2004 | ); |
@@ -2024,8 +2024,8 @@ discard block |
||
2024 | 2024 | $ticket_datetimes = array(), |
2025 | 2025 | $default |
2026 | 2026 | ) { |
2027 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
2028 | - ? $ticket_datetimes[ $ticket->ID() ] |
|
2027 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) |
|
2028 | + ? $ticket_datetimes[$ticket->ID()] |
|
2029 | 2029 | : array(); |
2030 | 2030 | $template_args = array( |
2031 | 2031 | 'dtt_row' => $default && ! $datetime instanceof EE_Datetime |
@@ -2057,7 +2057,7 @@ discard block |
||
2057 | 2057 | $this->_is_creating_event |
2058 | 2058 | ); |
2059 | 2059 | return EEH_Template::display_template( |
2060 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
2060 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
2061 | 2061 | $template_args, |
2062 | 2062 | true |
2063 | 2063 | ); |
@@ -2163,7 +2163,7 @@ discard block |
||
2163 | 2163 | $default_prices = $price_model->get_all_default_prices(); |
2164 | 2164 | $price_row = 1; |
2165 | 2165 | foreach ($default_prices as $price) { |
2166 | - if (! $price instanceof EE_Price) { |
|
2166 | + if ( ! $price instanceof EE_Price) { |
|
2167 | 2167 | continue; |
2168 | 2168 | } |
2169 | 2169 | if ($price->is_base_price()) { |
@@ -2200,7 +2200,7 @@ discard block |
||
2200 | 2200 | $this->_is_creating_event |
2201 | 2201 | ); |
2202 | 2202 | return EEH_Template::display_template( |
2203 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php', |
|
2203 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_js_structure.template.php', |
|
2204 | 2204 | $template_args, |
2205 | 2205 | true |
2206 | 2206 | ); |
@@ -578,7 +578,7 @@ discard block |
||
578 | 578 | * @param string $dt_frmt string representation of date format defaults to WP settings |
579 | 579 | * @param string $conjunction conjunction junction what's your function ? |
580 | 580 | * this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
581 | - * @return mixed string on success, FALSE on fail |
|
581 | + * @return string string on success, FALSE on fail |
|
582 | 582 | * @throws ReflectionException |
583 | 583 | * @throws InvalidArgumentException |
584 | 584 | * @throws InvalidInterfaceException |
@@ -686,7 +686,7 @@ discard block |
||
686 | 686 | * @param string $tm_format string representation of time format defaults to 'g:i a' |
687 | 687 | * @param string $conjunction conjunction junction what's your function ? |
688 | 688 | * this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
689 | - * @return mixed string on success, FALSE on fail |
|
689 | + * @return string string on success, FALSE on fail |
|
690 | 690 | * @throws ReflectionException |
691 | 691 | * @throws InvalidArgumentException |
692 | 692 | * @throws InvalidInterfaceException |
@@ -495,7 +495,7 @@ discard block |
||
495 | 495 | $date_or_time, |
496 | 496 | $echo |
497 | 497 | ); |
498 | - if (! $echo) { |
|
498 | + if ( ! $echo) { |
|
499 | 499 | return $dtt; |
500 | 500 | } |
501 | 501 | return ''; |
@@ -597,7 +597,7 @@ discard block |
||
597 | 597 | ' ', |
598 | 598 | $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt) |
599 | 599 | ); |
600 | - return $start !== $end ? $start . $conjunction . $end : $start; |
|
600 | + return $start !== $end ? $start.$conjunction.$end : $start; |
|
601 | 601 | } |
602 | 602 | |
603 | 603 | |
@@ -705,7 +705,7 @@ discard block |
||
705 | 705 | ' ', |
706 | 706 | $this->get_i18n_datetime('DTT_EVT_end', $tm_format) |
707 | 707 | ); |
708 | - return $start !== $end ? $start . $conjunction . $end : $start; |
|
708 | + return $start !== $end ? $start.$conjunction.$end : $start; |
|
709 | 709 | } |
710 | 710 | |
711 | 711 | |
@@ -750,7 +750,7 @@ discard block |
||
750 | 750 | ) { |
751 | 751 | $dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt; |
752 | 752 | $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt; |
753 | - $full_format = $dt_format . $separator . $tm_format; |
|
753 | + $full_format = $dt_format.$separator.$tm_format; |
|
754 | 754 | // the range output depends on various conditions |
755 | 755 | switch (true) { |
756 | 756 | // start date timestamp and end date timestamp are the same. |
@@ -991,7 +991,7 @@ discard block |
||
991 | 991 | // tickets remaining available for purchase |
992 | 992 | // no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF |
993 | 993 | $dtt_remaining = $this->reg_limit() - $this->sold_and_reserved(); |
994 | - if (! $consider_tickets) { |
|
994 | + if ( ! $consider_tickets) { |
|
995 | 995 | return $dtt_remaining; |
996 | 996 | } |
997 | 997 | $tickets_remaining = $this->tickets_remaining(); |
@@ -1015,7 +1015,7 @@ discard block |
||
1015 | 1015 | { |
1016 | 1016 | $sum = 0; |
1017 | 1017 | $tickets = $this->tickets($query_params); |
1018 | - if (! empty($tickets)) { |
|
1018 | + if ( ! empty($tickets)) { |
|
1019 | 1019 | foreach ($tickets as $ticket) { |
1020 | 1020 | if ($ticket instanceof EE_Ticket) { |
1021 | 1021 | // get the actual amount of tickets that can be sold |
@@ -1166,20 +1166,20 @@ discard block |
||
1166 | 1166 | { |
1167 | 1167 | if ($use_dtt_name) { |
1168 | 1168 | $dtt_name = $this->name(); |
1169 | - if (! empty($dtt_name)) { |
|
1169 | + if ( ! empty($dtt_name)) { |
|
1170 | 1170 | return $dtt_name; |
1171 | 1171 | } |
1172 | 1172 | } |
1173 | 1173 | // first condition is to see if the months are different |
1174 | 1174 | if (date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end')) |
1175 | 1175 | ) { |
1176 | - $display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a'); |
|
1176 | + $display_date = $this->start_date('M j\, Y g:i a').' - '.$this->end_date('M j\, Y g:i a'); |
|
1177 | 1177 | // next condition is if its the same month but different day |
1178 | 1178 | } else { |
1179 | 1179 | if (date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end')) |
1180 | 1180 | && date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end')) |
1181 | 1181 | ) { |
1182 | - $display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y'); |
|
1182 | + $display_date = $this->start_date('M j\, g:i a').' - '.$this->end_date('M j\, g:i a Y'); |
|
1183 | 1183 | } else { |
1184 | 1184 | $display_date = $this->start_date('F j\, Y') |
1185 | 1185 | . ' @ ' |
@@ -13,1410 +13,1410 @@ |
||
13 | 13 | class EE_Datetime extends EE_Soft_Delete_Base_Class |
14 | 14 | { |
15 | 15 | |
16 | - /** |
|
17 | - * constant used by get_active_status, indicates datetime has no more available spaces |
|
18 | - */ |
|
19 | - const sold_out = 'DTS'; |
|
20 | - |
|
21 | - /** |
|
22 | - * constant used by get_active_status, indicating datetime is still active (even is not over, can be registered-for) |
|
23 | - */ |
|
24 | - const active = 'DTA'; |
|
25 | - |
|
26 | - /** |
|
27 | - * constant used by get_active_status, indicating the datetime cannot be used for registrations yet, but has not |
|
28 | - * expired |
|
29 | - */ |
|
30 | - const upcoming = 'DTU'; |
|
31 | - |
|
32 | - /** |
|
33 | - * Datetime is postponed |
|
34 | - */ |
|
35 | - const postponed = 'DTP'; |
|
36 | - |
|
37 | - /** |
|
38 | - * Datetime is cancelled |
|
39 | - */ |
|
40 | - const cancelled = 'DTC'; |
|
41 | - |
|
42 | - /** |
|
43 | - * constant used by get_active_status, indicates datetime has expired (event is over) |
|
44 | - */ |
|
45 | - const expired = 'DTE'; |
|
46 | - |
|
47 | - /** |
|
48 | - * constant used in various places indicating that an event is INACTIVE (not yet ready to be published) |
|
49 | - */ |
|
50 | - const inactive = 'DTI'; |
|
51 | - |
|
52 | - |
|
53 | - /** |
|
54 | - * @param array $props_n_values incoming values |
|
55 | - * @param string $timezone incoming timezone (if not set the timezone set for the website will be used.) |
|
56 | - * @param array $date_formats incoming date_formats in an array where the first value is the date_format |
|
57 | - * and the second value is the time format |
|
58 | - * @return EE_Datetime |
|
59 | - * @throws ReflectionException |
|
60 | - * @throws InvalidArgumentException |
|
61 | - * @throws InvalidInterfaceException |
|
62 | - * @throws InvalidDataTypeException |
|
63 | - * @throws EE_Error |
|
64 | - */ |
|
65 | - public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
66 | - { |
|
67 | - $has_object = parent::_check_for_object( |
|
68 | - $props_n_values, |
|
69 | - __CLASS__, |
|
70 | - $timezone, |
|
71 | - $date_formats |
|
72 | - ); |
|
73 | - return $has_object |
|
74 | - ? $has_object |
|
75 | - : new self($props_n_values, false, $timezone, $date_formats); |
|
76 | - } |
|
77 | - |
|
78 | - |
|
79 | - /** |
|
80 | - * @param array $props_n_values incoming values from the database |
|
81 | - * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
82 | - * the website will be used. |
|
83 | - * @return EE_Datetime |
|
84 | - * @throws ReflectionException |
|
85 | - * @throws InvalidArgumentException |
|
86 | - * @throws InvalidInterfaceException |
|
87 | - * @throws InvalidDataTypeException |
|
88 | - * @throws EE_Error |
|
89 | - */ |
|
90 | - public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
91 | - { |
|
92 | - return new self($props_n_values, true, $timezone); |
|
93 | - } |
|
94 | - |
|
95 | - |
|
96 | - /** |
|
97 | - * @param $name |
|
98 | - * @throws ReflectionException |
|
99 | - * @throws InvalidArgumentException |
|
100 | - * @throws InvalidInterfaceException |
|
101 | - * @throws InvalidDataTypeException |
|
102 | - * @throws EE_Error |
|
103 | - */ |
|
104 | - public function set_name($name) |
|
105 | - { |
|
106 | - $this->set('DTT_name', $name); |
|
107 | - } |
|
108 | - |
|
109 | - |
|
110 | - /** |
|
111 | - * @param $description |
|
112 | - * @throws ReflectionException |
|
113 | - * @throws InvalidArgumentException |
|
114 | - * @throws InvalidInterfaceException |
|
115 | - * @throws InvalidDataTypeException |
|
116 | - * @throws EE_Error |
|
117 | - */ |
|
118 | - public function set_description($description) |
|
119 | - { |
|
120 | - $this->set('DTT_description', $description); |
|
121 | - } |
|
122 | - |
|
123 | - |
|
124 | - /** |
|
125 | - * Set event start date |
|
126 | - * set the start date for an event |
|
127 | - * |
|
128 | - * @param string $date a string representation of the event's date ex: Dec. 25, 2025 or 12-25-2025 |
|
129 | - * @throws ReflectionException |
|
130 | - * @throws InvalidArgumentException |
|
131 | - * @throws InvalidInterfaceException |
|
132 | - * @throws InvalidDataTypeException |
|
133 | - * @throws EE_Error |
|
134 | - */ |
|
135 | - public function set_start_date($date) |
|
136 | - { |
|
137 | - $this->_set_date_for($date, 'DTT_EVT_start'); |
|
138 | - } |
|
139 | - |
|
140 | - |
|
141 | - /** |
|
142 | - * Set event start time |
|
143 | - * set the start time for an event |
|
144 | - * |
|
145 | - * @param string $time a string representation of the event time ex: 9am or 7:30 PM |
|
146 | - * @throws ReflectionException |
|
147 | - * @throws InvalidArgumentException |
|
148 | - * @throws InvalidInterfaceException |
|
149 | - * @throws InvalidDataTypeException |
|
150 | - * @throws EE_Error |
|
151 | - */ |
|
152 | - public function set_start_time($time) |
|
153 | - { |
|
154 | - $this->_set_time_for($time, 'DTT_EVT_start'); |
|
155 | - } |
|
156 | - |
|
157 | - |
|
158 | - /** |
|
159 | - * Set event end date |
|
160 | - * set the end date for an event |
|
161 | - * |
|
162 | - * @param string $date a string representation of the event's date ex: Dec. 25, 2025 or 12-25-2025 |
|
163 | - * @throws ReflectionException |
|
164 | - * @throws InvalidArgumentException |
|
165 | - * @throws InvalidInterfaceException |
|
166 | - * @throws InvalidDataTypeException |
|
167 | - * @throws EE_Error |
|
168 | - */ |
|
169 | - public function set_end_date($date) |
|
170 | - { |
|
171 | - $this->_set_date_for($date, 'DTT_EVT_end'); |
|
172 | - } |
|
173 | - |
|
174 | - |
|
175 | - /** |
|
176 | - * Set event end time |
|
177 | - * set the end time for an event |
|
178 | - * |
|
179 | - * @param string $time a string representation of the event time ex: 9am or 7:30 PM |
|
180 | - * @throws ReflectionException |
|
181 | - * @throws InvalidArgumentException |
|
182 | - * @throws InvalidInterfaceException |
|
183 | - * @throws InvalidDataTypeException |
|
184 | - * @throws EE_Error |
|
185 | - */ |
|
186 | - public function set_end_time($time) |
|
187 | - { |
|
188 | - $this->_set_time_for($time, 'DTT_EVT_end'); |
|
189 | - } |
|
190 | - |
|
191 | - |
|
192 | - /** |
|
193 | - * Set registration limit |
|
194 | - * set the maximum number of attendees that can be registered for this datetime slot |
|
195 | - * |
|
196 | - * @param int $reg_limit |
|
197 | - * @throws ReflectionException |
|
198 | - * @throws InvalidArgumentException |
|
199 | - * @throws InvalidInterfaceException |
|
200 | - * @throws InvalidDataTypeException |
|
201 | - * @throws EE_Error |
|
202 | - */ |
|
203 | - public function set_reg_limit($reg_limit) |
|
204 | - { |
|
205 | - $this->set('DTT_reg_limit', $reg_limit); |
|
206 | - } |
|
207 | - |
|
208 | - |
|
209 | - /** |
|
210 | - * get the number of tickets sold for this datetime slot |
|
211 | - * |
|
212 | - * @return mixed int on success, FALSE on fail |
|
213 | - * @throws ReflectionException |
|
214 | - * @throws InvalidArgumentException |
|
215 | - * @throws InvalidInterfaceException |
|
216 | - * @throws InvalidDataTypeException |
|
217 | - * @throws EE_Error |
|
218 | - */ |
|
219 | - public function sold() |
|
220 | - { |
|
221 | - return $this->get_raw('DTT_sold'); |
|
222 | - } |
|
223 | - |
|
224 | - |
|
225 | - /** |
|
226 | - * @param int $sold |
|
227 | - * @throws ReflectionException |
|
228 | - * @throws InvalidArgumentException |
|
229 | - * @throws InvalidInterfaceException |
|
230 | - * @throws InvalidDataTypeException |
|
231 | - * @throws EE_Error |
|
232 | - */ |
|
233 | - public function set_sold($sold) |
|
234 | - { |
|
235 | - // sold can not go below zero |
|
236 | - $sold = max(0, $sold); |
|
237 | - $this->set('DTT_sold', $sold); |
|
238 | - } |
|
239 | - |
|
240 | - |
|
241 | - /** |
|
242 | - * Increments sold by amount passed by $qty, and persists it immediately to the database. |
|
243 | - * Simultaneously decreases the reserved count, unless $also_decrease_reserved is false. |
|
244 | - * |
|
245 | - * @param int $qty |
|
246 | - * @param boolean $also_decrease_reserved |
|
247 | - * @return boolean indicating success |
|
248 | - * @throws ReflectionException |
|
249 | - * @throws InvalidArgumentException |
|
250 | - * @throws InvalidInterfaceException |
|
251 | - * @throws InvalidDataTypeException |
|
252 | - * @throws EE_Error |
|
253 | - */ |
|
254 | - public function increaseSold($qty = 1, $also_decrease_reserved = true) |
|
255 | - { |
|
256 | - $qty = absint($qty); |
|
257 | - if ($also_decrease_reserved) { |
|
258 | - $success = $this->adjustNumericFieldsInDb( |
|
259 | - [ |
|
260 | - 'DTT_reserved' => $qty * -1, |
|
261 | - 'DTT_sold' => $qty |
|
262 | - ] |
|
263 | - ); |
|
264 | - } else { |
|
265 | - $success = $this->adjustNumericFieldsInDb( |
|
266 | - [ |
|
267 | - 'DTT_sold' => $qty |
|
268 | - ] |
|
269 | - ); |
|
270 | - } |
|
271 | - |
|
272 | - do_action( |
|
273 | - 'AHEE__EE_Datetime__increase_sold', |
|
274 | - $this, |
|
275 | - $qty, |
|
276 | - $this->sold(), |
|
277 | - $success |
|
278 | - ); |
|
279 | - return $success; |
|
280 | - } |
|
281 | - |
|
282 | - |
|
283 | - /** |
|
284 | - * Decrements (subtracts) sold amount passed by $qty directly in the DB and on the model object. (Ie, no need |
|
285 | - * to save afterwards.) |
|
286 | - * |
|
287 | - * @param int $qty |
|
288 | - * @return boolean indicating success |
|
289 | - * @throws ReflectionException |
|
290 | - * @throws InvalidArgumentException |
|
291 | - * @throws InvalidInterfaceException |
|
292 | - * @throws InvalidDataTypeException |
|
293 | - * @throws EE_Error |
|
294 | - */ |
|
295 | - public function decreaseSold($qty = 1) |
|
296 | - { |
|
297 | - $qty = absint($qty); |
|
298 | - $success = $this->adjustNumericFieldsInDb( |
|
299 | - [ |
|
300 | - 'DTT_sold' => $qty * -1 |
|
301 | - ] |
|
302 | - ); |
|
303 | - do_action( |
|
304 | - 'AHEE__EE_Datetime__decrease_sold', |
|
305 | - $this, |
|
306 | - $qty, |
|
307 | - $this->sold(), |
|
308 | - $success |
|
309 | - ); |
|
310 | - return $success; |
|
311 | - } |
|
312 | - |
|
313 | - |
|
314 | - /** |
|
315 | - * Gets qty of reserved tickets for this datetime |
|
316 | - * |
|
317 | - * @return int |
|
318 | - * @throws ReflectionException |
|
319 | - * @throws InvalidArgumentException |
|
320 | - * @throws InvalidInterfaceException |
|
321 | - * @throws InvalidDataTypeException |
|
322 | - * @throws EE_Error |
|
323 | - */ |
|
324 | - public function reserved() |
|
325 | - { |
|
326 | - return $this->get_raw('DTT_reserved'); |
|
327 | - } |
|
328 | - |
|
329 | - |
|
330 | - /** |
|
331 | - * Sets qty of reserved tickets for this datetime |
|
332 | - * |
|
333 | - * @param int $reserved |
|
334 | - * @throws ReflectionException |
|
335 | - * @throws InvalidArgumentException |
|
336 | - * @throws InvalidInterfaceException |
|
337 | - * @throws InvalidDataTypeException |
|
338 | - * @throws EE_Error |
|
339 | - */ |
|
340 | - public function set_reserved($reserved) |
|
341 | - { |
|
342 | - // reserved can not go below zero |
|
343 | - $reserved = max(0, (int) $reserved); |
|
344 | - $this->set('DTT_reserved', $reserved); |
|
345 | - } |
|
346 | - |
|
347 | - |
|
348 | - /** |
|
349 | - * Increments reserved by amount passed by $qty, and persists it immediately to the database. |
|
350 | - * |
|
351 | - * @param int $qty |
|
352 | - * @return boolean indicating success |
|
353 | - * @throws ReflectionException |
|
354 | - * @throws InvalidArgumentException |
|
355 | - * @throws InvalidInterfaceException |
|
356 | - * @throws InvalidDataTypeException |
|
357 | - * @throws EE_Error |
|
358 | - */ |
|
359 | - public function increaseReserved($qty = 1) |
|
360 | - { |
|
361 | - $qty = absint($qty); |
|
362 | - $success = $this->incrementFieldConditionallyInDb( |
|
363 | - 'DTT_reserved', |
|
364 | - 'DTT_sold', |
|
365 | - 'DTT_reg_limit', |
|
366 | - $qty |
|
367 | - ); |
|
368 | - do_action( |
|
369 | - 'AHEE__EE_Datetime__increase_reserved', |
|
370 | - $this, |
|
371 | - $qty, |
|
372 | - $this->reserved(), |
|
373 | - $success |
|
374 | - ); |
|
375 | - return $success; |
|
376 | - } |
|
377 | - |
|
378 | - |
|
379 | - /** |
|
380 | - * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database. |
|
381 | - * |
|
382 | - * @param int $qty |
|
383 | - * @return boolean indicating success |
|
384 | - * @throws ReflectionException |
|
385 | - * @throws InvalidArgumentException |
|
386 | - * @throws InvalidInterfaceException |
|
387 | - * @throws InvalidDataTypeException |
|
388 | - * @throws EE_Error |
|
389 | - */ |
|
390 | - public function decreaseReserved($qty = 1) |
|
391 | - { |
|
392 | - $qty = absint($qty); |
|
393 | - $success = $this->adjustNumericFieldsInDb( |
|
394 | - [ |
|
395 | - 'DTT_reserved' => $qty * -1 |
|
396 | - ] |
|
397 | - ); |
|
398 | - do_action( |
|
399 | - 'AHEE__EE_Datetime__decrease_reserved', |
|
400 | - $this, |
|
401 | - $qty, |
|
402 | - $this->reserved(), |
|
403 | - $success |
|
404 | - ); |
|
405 | - return $success; |
|
406 | - } |
|
407 | - |
|
408 | - |
|
409 | - /** |
|
410 | - * total sold and reserved tickets |
|
411 | - * |
|
412 | - * @return int |
|
413 | - * @throws ReflectionException |
|
414 | - * @throws InvalidArgumentException |
|
415 | - * @throws InvalidInterfaceException |
|
416 | - * @throws InvalidDataTypeException |
|
417 | - * @throws EE_Error |
|
418 | - */ |
|
419 | - public function sold_and_reserved() |
|
420 | - { |
|
421 | - return $this->sold() + $this->reserved(); |
|
422 | - } |
|
423 | - |
|
424 | - |
|
425 | - /** |
|
426 | - * returns the datetime name |
|
427 | - * |
|
428 | - * @return string |
|
429 | - * @throws ReflectionException |
|
430 | - * @throws InvalidArgumentException |
|
431 | - * @throws InvalidInterfaceException |
|
432 | - * @throws InvalidDataTypeException |
|
433 | - * @throws EE_Error |
|
434 | - */ |
|
435 | - public function name() |
|
436 | - { |
|
437 | - return $this->get('DTT_name'); |
|
438 | - } |
|
439 | - |
|
440 | - |
|
441 | - /** |
|
442 | - * returns the datetime description |
|
443 | - * |
|
444 | - * @return string |
|
445 | - * @throws ReflectionException |
|
446 | - * @throws InvalidArgumentException |
|
447 | - * @throws InvalidInterfaceException |
|
448 | - * @throws InvalidDataTypeException |
|
449 | - * @throws EE_Error |
|
450 | - */ |
|
451 | - public function description() |
|
452 | - { |
|
453 | - return $this->get('DTT_description'); |
|
454 | - } |
|
455 | - |
|
456 | - |
|
457 | - /** |
|
458 | - * This helper simply returns whether the event_datetime for the current datetime is a primary datetime |
|
459 | - * |
|
460 | - * @return boolean TRUE if is primary, FALSE if not. |
|
461 | - * @throws ReflectionException |
|
462 | - * @throws InvalidArgumentException |
|
463 | - * @throws InvalidInterfaceException |
|
464 | - * @throws InvalidDataTypeException |
|
465 | - * @throws EE_Error |
|
466 | - */ |
|
467 | - public function is_primary() |
|
468 | - { |
|
469 | - return $this->get('DTT_is_primary'); |
|
470 | - } |
|
471 | - |
|
472 | - |
|
473 | - /** |
|
474 | - * This helper simply returns the order for the datetime |
|
475 | - * |
|
476 | - * @return int The order of the datetime for this event. |
|
477 | - * @throws ReflectionException |
|
478 | - * @throws InvalidArgumentException |
|
479 | - * @throws InvalidInterfaceException |
|
480 | - * @throws InvalidDataTypeException |
|
481 | - * @throws EE_Error |
|
482 | - */ |
|
483 | - public function order() |
|
484 | - { |
|
485 | - return $this->get('DTT_order'); |
|
486 | - } |
|
487 | - |
|
488 | - |
|
489 | - /** |
|
490 | - * This helper simply returns the parent id for the datetime |
|
491 | - * |
|
492 | - * @return int |
|
493 | - * @throws ReflectionException |
|
494 | - * @throws InvalidArgumentException |
|
495 | - * @throws InvalidInterfaceException |
|
496 | - * @throws InvalidDataTypeException |
|
497 | - * @throws EE_Error |
|
498 | - */ |
|
499 | - public function parent() |
|
500 | - { |
|
501 | - return $this->get('DTT_parent'); |
|
502 | - } |
|
503 | - |
|
504 | - |
|
505 | - /** |
|
506 | - * show date and/or time |
|
507 | - * |
|
508 | - * @param string $date_or_time whether to display a date or time or both |
|
509 | - * @param string $start_or_end whether to display start or end datetimes |
|
510 | - * @param string $dt_frmt |
|
511 | - * @param string $tm_frmt |
|
512 | - * @param bool $echo whether we echo or return (note echoing uses "pretty" formats, |
|
513 | - * otherwise we use the standard formats) |
|
514 | - * @return string|bool string on success, FALSE on fail |
|
515 | - * @throws ReflectionException |
|
516 | - * @throws InvalidArgumentException |
|
517 | - * @throws InvalidInterfaceException |
|
518 | - * @throws InvalidDataTypeException |
|
519 | - * @throws EE_Error |
|
520 | - */ |
|
521 | - private function _show_datetime( |
|
522 | - $date_or_time = null, |
|
523 | - $start_or_end = 'start', |
|
524 | - $dt_frmt = '', |
|
525 | - $tm_frmt = '', |
|
526 | - $echo = false |
|
527 | - ) { |
|
528 | - $field_name = "DTT_EVT_{$start_or_end}"; |
|
529 | - $dtt = $this->_get_datetime( |
|
530 | - $field_name, |
|
531 | - $dt_frmt, |
|
532 | - $tm_frmt, |
|
533 | - $date_or_time, |
|
534 | - $echo |
|
535 | - ); |
|
536 | - if (! $echo) { |
|
537 | - return $dtt; |
|
538 | - } |
|
539 | - return ''; |
|
540 | - } |
|
541 | - |
|
542 | - |
|
543 | - /** |
|
544 | - * get event start date. Provide either the date format, or NULL to re-use the |
|
545 | - * last-used format, or '' to use the default date format |
|
546 | - * |
|
547 | - * @param string $dt_frmt string representation of date format defaults to 'F j, Y' |
|
548 | - * @return mixed string on success, FALSE on fail |
|
549 | - * @throws ReflectionException |
|
550 | - * @throws InvalidArgumentException |
|
551 | - * @throws InvalidInterfaceException |
|
552 | - * @throws InvalidDataTypeException |
|
553 | - * @throws EE_Error |
|
554 | - */ |
|
555 | - public function start_date($dt_frmt = '') |
|
556 | - { |
|
557 | - return $this->_show_datetime('D', 'start', $dt_frmt); |
|
558 | - } |
|
559 | - |
|
560 | - |
|
561 | - /** |
|
562 | - * Echoes start_date() |
|
563 | - * |
|
564 | - * @param string $dt_frmt |
|
565 | - * @throws ReflectionException |
|
566 | - * @throws InvalidArgumentException |
|
567 | - * @throws InvalidInterfaceException |
|
568 | - * @throws InvalidDataTypeException |
|
569 | - * @throws EE_Error |
|
570 | - */ |
|
571 | - public function e_start_date($dt_frmt = '') |
|
572 | - { |
|
573 | - $this->_show_datetime('D', 'start', $dt_frmt, null, true); |
|
574 | - } |
|
575 | - |
|
576 | - |
|
577 | - /** |
|
578 | - * get end date. Provide either the date format, or NULL to re-use the |
|
579 | - * last-used format, or '' to use the default date format |
|
580 | - * |
|
581 | - * @param string $dt_frmt string representation of date format defaults to 'F j, Y' |
|
582 | - * @return mixed string on success, FALSE on fail |
|
583 | - * @throws ReflectionException |
|
584 | - * @throws InvalidArgumentException |
|
585 | - * @throws InvalidInterfaceException |
|
586 | - * @throws InvalidDataTypeException |
|
587 | - * @throws EE_Error |
|
588 | - */ |
|
589 | - public function end_date($dt_frmt = '') |
|
590 | - { |
|
591 | - return $this->_show_datetime('D', 'end', $dt_frmt); |
|
592 | - } |
|
593 | - |
|
594 | - |
|
595 | - /** |
|
596 | - * Echoes the end date. See end_date() |
|
597 | - * |
|
598 | - * @param string $dt_frmt |
|
599 | - * @throws ReflectionException |
|
600 | - * @throws InvalidArgumentException |
|
601 | - * @throws InvalidInterfaceException |
|
602 | - * @throws InvalidDataTypeException |
|
603 | - * @throws EE_Error |
|
604 | - */ |
|
605 | - public function e_end_date($dt_frmt = '') |
|
606 | - { |
|
607 | - $this->_show_datetime('D', 'end', $dt_frmt, null, true); |
|
608 | - } |
|
609 | - |
|
610 | - |
|
611 | - /** |
|
612 | - * get date_range - meaning the start AND end date |
|
613 | - * |
|
614 | - * @access public |
|
615 | - * @param string $dt_frmt string representation of date format defaults to WP settings |
|
616 | - * @param string $conjunction conjunction junction what's your function ? |
|
617 | - * this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
|
618 | - * @return mixed string on success, FALSE on fail |
|
619 | - * @throws ReflectionException |
|
620 | - * @throws InvalidArgumentException |
|
621 | - * @throws InvalidInterfaceException |
|
622 | - * @throws InvalidDataTypeException |
|
623 | - * @throws EE_Error |
|
624 | - */ |
|
625 | - public function date_range($dt_frmt = '', $conjunction = ' - ') |
|
626 | - { |
|
627 | - $dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt; |
|
628 | - $start = str_replace( |
|
629 | - ' ', |
|
630 | - ' ', |
|
631 | - $this->get_i18n_datetime('DTT_EVT_start', $dt_frmt) |
|
632 | - ); |
|
633 | - $end = str_replace( |
|
634 | - ' ', |
|
635 | - ' ', |
|
636 | - $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt) |
|
637 | - ); |
|
638 | - return $start !== $end ? $start . $conjunction . $end : $start; |
|
639 | - } |
|
640 | - |
|
641 | - |
|
642 | - /** |
|
643 | - * @param string $dt_frmt |
|
644 | - * @param string $conjunction |
|
645 | - * @throws ReflectionException |
|
646 | - * @throws InvalidArgumentException |
|
647 | - * @throws InvalidInterfaceException |
|
648 | - * @throws InvalidDataTypeException |
|
649 | - * @throws EE_Error |
|
650 | - */ |
|
651 | - public function e_date_range($dt_frmt = '', $conjunction = ' - ') |
|
652 | - { |
|
653 | - echo $this->date_range($dt_frmt, $conjunction); |
|
654 | - } |
|
655 | - |
|
656 | - |
|
657 | - /** |
|
658 | - * get start time |
|
659 | - * |
|
660 | - * @param string $tm_format - string representation of time format defaults to 'g:i a' |
|
661 | - * @return mixed string on success, FALSE on fail |
|
662 | - * @throws ReflectionException |
|
663 | - * @throws InvalidArgumentException |
|
664 | - * @throws InvalidInterfaceException |
|
665 | - * @throws InvalidDataTypeException |
|
666 | - * @throws EE_Error |
|
667 | - */ |
|
668 | - public function start_time($tm_format = '') |
|
669 | - { |
|
670 | - return $this->_show_datetime('T', 'start', null, $tm_format); |
|
671 | - } |
|
672 | - |
|
673 | - |
|
674 | - /** |
|
675 | - * @param string $tm_format |
|
676 | - * @throws ReflectionException |
|
677 | - * @throws InvalidArgumentException |
|
678 | - * @throws InvalidInterfaceException |
|
679 | - * @throws InvalidDataTypeException |
|
680 | - * @throws EE_Error |
|
681 | - */ |
|
682 | - public function e_start_time($tm_format = '') |
|
683 | - { |
|
684 | - $this->_show_datetime('T', 'start', null, $tm_format, true); |
|
685 | - } |
|
686 | - |
|
687 | - |
|
688 | - /** |
|
689 | - * get end time |
|
690 | - * |
|
691 | - * @param string $tm_format string representation of time format defaults to 'g:i a' |
|
692 | - * @return mixed string on success, FALSE on fail |
|
693 | - * @throws ReflectionException |
|
694 | - * @throws InvalidArgumentException |
|
695 | - * @throws InvalidInterfaceException |
|
696 | - * @throws InvalidDataTypeException |
|
697 | - * @throws EE_Error |
|
698 | - */ |
|
699 | - public function end_time($tm_format = '') |
|
700 | - { |
|
701 | - return $this->_show_datetime('T', 'end', null, $tm_format); |
|
702 | - } |
|
703 | - |
|
704 | - |
|
705 | - /** |
|
706 | - * @param string $tm_format |
|
707 | - * @throws ReflectionException |
|
708 | - * @throws InvalidArgumentException |
|
709 | - * @throws InvalidInterfaceException |
|
710 | - * @throws InvalidDataTypeException |
|
711 | - * @throws EE_Error |
|
712 | - */ |
|
713 | - public function e_end_time($tm_format = '') |
|
714 | - { |
|
715 | - $this->_show_datetime('T', 'end', null, $tm_format, true); |
|
716 | - } |
|
717 | - |
|
718 | - |
|
719 | - /** |
|
720 | - * get time_range |
|
721 | - * |
|
722 | - * @access public |
|
723 | - * @param string $tm_format string representation of time format defaults to 'g:i a' |
|
724 | - * @param string $conjunction conjunction junction what's your function ? |
|
725 | - * this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
|
726 | - * @return mixed string on success, FALSE on fail |
|
727 | - * @throws ReflectionException |
|
728 | - * @throws InvalidArgumentException |
|
729 | - * @throws InvalidInterfaceException |
|
730 | - * @throws InvalidDataTypeException |
|
731 | - * @throws EE_Error |
|
732 | - */ |
|
733 | - public function time_range($tm_format = '', $conjunction = ' - ') |
|
734 | - { |
|
735 | - $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt; |
|
736 | - $start = str_replace( |
|
737 | - ' ', |
|
738 | - ' ', |
|
739 | - $this->get_i18n_datetime('DTT_EVT_start', $tm_format) |
|
740 | - ); |
|
741 | - $end = str_replace( |
|
742 | - ' ', |
|
743 | - ' ', |
|
744 | - $this->get_i18n_datetime('DTT_EVT_end', $tm_format) |
|
745 | - ); |
|
746 | - return $start !== $end ? $start . $conjunction . $end : $start; |
|
747 | - } |
|
748 | - |
|
749 | - |
|
750 | - /** |
|
751 | - * @param string $tm_format |
|
752 | - * @param string $conjunction |
|
753 | - * @throws ReflectionException |
|
754 | - * @throws InvalidArgumentException |
|
755 | - * @throws InvalidInterfaceException |
|
756 | - * @throws InvalidDataTypeException |
|
757 | - * @throws EE_Error |
|
758 | - */ |
|
759 | - public function e_time_range($tm_format = '', $conjunction = ' - ') |
|
760 | - { |
|
761 | - echo $this->time_range($tm_format, $conjunction); |
|
762 | - } |
|
763 | - |
|
764 | - |
|
765 | - /** |
|
766 | - * This returns a range representation of the date and times. |
|
767 | - * Output is dependent on the difference (or similarity) between DTT_EVT_start and DTT_EVT_end. |
|
768 | - * Also, the return value is localized. |
|
769 | - * |
|
770 | - * @param string $dt_format |
|
771 | - * @param string $tm_format |
|
772 | - * @param string $conjunction used between two different dates or times. |
|
773 | - * ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm |
|
774 | - * @param string $separator used between the date and time formats. |
|
775 | - * ex: Dec 1, 2016{$separator}2pm |
|
776 | - * @return string |
|
777 | - * @throws ReflectionException |
|
778 | - * @throws InvalidArgumentException |
|
779 | - * @throws InvalidInterfaceException |
|
780 | - * @throws InvalidDataTypeException |
|
781 | - * @throws EE_Error |
|
782 | - */ |
|
783 | - public function date_and_time_range( |
|
784 | - $dt_format = '', |
|
785 | - $tm_format = '', |
|
786 | - $conjunction = ' - ', |
|
787 | - $separator = ' ' |
|
788 | - ) { |
|
789 | - $dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt; |
|
790 | - $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt; |
|
791 | - $full_format = $dt_format . $separator . $tm_format; |
|
792 | - // the range output depends on various conditions |
|
793 | - switch (true) { |
|
794 | - // start date timestamp and end date timestamp are the same. |
|
795 | - case ($this->get_raw('DTT_EVT_start') === $this->get_raw('DTT_EVT_end')): |
|
796 | - $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format); |
|
797 | - break; |
|
798 | - // start and end date are the same but times are different |
|
799 | - case ($this->start_date() === $this->end_date()): |
|
800 | - $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format) |
|
801 | - . $conjunction |
|
802 | - . $this->get_i18n_datetime('DTT_EVT_end', $tm_format); |
|
803 | - break; |
|
804 | - // all other conditions |
|
805 | - default: |
|
806 | - $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format) |
|
807 | - . $conjunction |
|
808 | - . $this->get_i18n_datetime('DTT_EVT_end', $full_format); |
|
809 | - break; |
|
810 | - } |
|
811 | - return $output; |
|
812 | - } |
|
813 | - |
|
814 | - |
|
815 | - /** |
|
816 | - * This echos the results of date and time range. |
|
817 | - * |
|
818 | - * @see date_and_time_range() for more details on purpose. |
|
819 | - * @param string $dt_format |
|
820 | - * @param string $tm_format |
|
821 | - * @param string $conjunction |
|
822 | - * @return void |
|
823 | - * @throws ReflectionException |
|
824 | - * @throws InvalidArgumentException |
|
825 | - * @throws InvalidInterfaceException |
|
826 | - * @throws InvalidDataTypeException |
|
827 | - * @throws EE_Error |
|
828 | - */ |
|
829 | - public function e_date_and_time_range($dt_format = '', $tm_format = '', $conjunction = ' - ') |
|
830 | - { |
|
831 | - echo $this->date_and_time_range($dt_format, $tm_format, $conjunction); |
|
832 | - } |
|
833 | - |
|
834 | - |
|
835 | - /** |
|
836 | - * get start date and start time |
|
837 | - * |
|
838 | - * @param string $dt_format - string representation of date format defaults to 'F j, Y' |
|
839 | - * @param string $tm_format - string representation of time format defaults to 'g:i a' |
|
840 | - * @return mixed string on success, FALSE on fail |
|
841 | - * @throws ReflectionException |
|
842 | - * @throws InvalidArgumentException |
|
843 | - * @throws InvalidInterfaceException |
|
844 | - * @throws InvalidDataTypeException |
|
845 | - * @throws EE_Error |
|
846 | - */ |
|
847 | - public function start_date_and_time($dt_format = '', $tm_format = '') |
|
848 | - { |
|
849 | - return $this->_show_datetime('', 'start', $dt_format, $tm_format); |
|
850 | - } |
|
851 | - |
|
852 | - |
|
853 | - /** |
|
854 | - * @param string $dt_frmt |
|
855 | - * @param string $tm_format |
|
856 | - * @throws ReflectionException |
|
857 | - * @throws InvalidArgumentException |
|
858 | - * @throws InvalidInterfaceException |
|
859 | - * @throws InvalidDataTypeException |
|
860 | - * @throws EE_Error |
|
861 | - */ |
|
862 | - public function e_start_date_and_time($dt_frmt = '', $tm_format = '') |
|
863 | - { |
|
864 | - $this->_show_datetime('', 'start', $dt_frmt, $tm_format, true); |
|
865 | - } |
|
866 | - |
|
867 | - |
|
868 | - /** |
|
869 | - * Shows the length of the event (start to end time). |
|
870 | - * Can be shown in 'seconds','minutes','hours', or 'days'. |
|
871 | - * By default, rounds up. (So if you use 'days', and then event |
|
872 | - * only occurs for 1 hour, it will return 1 day). |
|
873 | - * |
|
874 | - * @param string $units 'seconds','minutes','hours','days' |
|
875 | - * @param bool $round_up |
|
876 | - * @return float|int|mixed |
|
877 | - * @throws ReflectionException |
|
878 | - * @throws InvalidArgumentException |
|
879 | - * @throws InvalidInterfaceException |
|
880 | - * @throws InvalidDataTypeException |
|
881 | - * @throws EE_Error |
|
882 | - */ |
|
883 | - public function length($units = 'seconds', $round_up = false) |
|
884 | - { |
|
885 | - $start = $this->get_raw('DTT_EVT_start'); |
|
886 | - $end = $this->get_raw('DTT_EVT_end'); |
|
887 | - $length_in_units = $end - $start; |
|
888 | - switch ($units) { |
|
889 | - // NOTE: We purposefully don't use "break;" in order to chain the divisions |
|
890 | - /** @noinspection PhpMissingBreakStatementInspection */ |
|
891 | - // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment |
|
892 | - case 'days': |
|
893 | - $length_in_units /= 24; |
|
894 | - /** @noinspection PhpMissingBreakStatementInspection */ |
|
895 | - case 'hours': |
|
896 | - // fall through is intentional |
|
897 | - $length_in_units /= 60; |
|
898 | - /** @noinspection PhpMissingBreakStatementInspection */ |
|
899 | - case 'minutes': |
|
900 | - // fall through is intentional |
|
901 | - $length_in_units /= 60; |
|
902 | - case 'seconds': |
|
903 | - default: |
|
904 | - $length_in_units = ceil($length_in_units); |
|
905 | - } |
|
906 | - // phpcs:enable |
|
907 | - if ($round_up) { |
|
908 | - $length_in_units = max($length_in_units, 1); |
|
909 | - } |
|
910 | - return $length_in_units; |
|
911 | - } |
|
912 | - |
|
913 | - |
|
914 | - /** |
|
915 | - * get end date and time |
|
916 | - * |
|
917 | - * @param string $dt_frmt - string representation of date format defaults to 'F j, Y' |
|
918 | - * @param string $tm_format - string representation of time format defaults to 'g:i a' |
|
919 | - * @return mixed string on success, FALSE on fail |
|
920 | - * @throws ReflectionException |
|
921 | - * @throws InvalidArgumentException |
|
922 | - * @throws InvalidInterfaceException |
|
923 | - * @throws InvalidDataTypeException |
|
924 | - * @throws EE_Error |
|
925 | - */ |
|
926 | - public function end_date_and_time($dt_frmt = '', $tm_format = '') |
|
927 | - { |
|
928 | - return $this->_show_datetime('', 'end', $dt_frmt, $tm_format); |
|
929 | - } |
|
930 | - |
|
931 | - |
|
932 | - /** |
|
933 | - * @param string $dt_frmt |
|
934 | - * @param string $tm_format |
|
935 | - * @throws ReflectionException |
|
936 | - * @throws InvalidArgumentException |
|
937 | - * @throws InvalidInterfaceException |
|
938 | - * @throws InvalidDataTypeException |
|
939 | - * @throws EE_Error |
|
940 | - */ |
|
941 | - public function e_end_date_and_time($dt_frmt = '', $tm_format = '') |
|
942 | - { |
|
943 | - $this->_show_datetime('', 'end', $dt_frmt, $tm_format, true); |
|
944 | - } |
|
945 | - |
|
946 | - |
|
947 | - /** |
|
948 | - * get start timestamp |
|
949 | - * |
|
950 | - * @return int |
|
951 | - * @throws ReflectionException |
|
952 | - * @throws InvalidArgumentException |
|
953 | - * @throws InvalidInterfaceException |
|
954 | - * @throws InvalidDataTypeException |
|
955 | - * @throws EE_Error |
|
956 | - */ |
|
957 | - public function start() |
|
958 | - { |
|
959 | - return $this->get_raw('DTT_EVT_start'); |
|
960 | - } |
|
961 | - |
|
962 | - |
|
963 | - /** |
|
964 | - * get end timestamp |
|
965 | - * |
|
966 | - * @return int |
|
967 | - * @throws ReflectionException |
|
968 | - * @throws InvalidArgumentException |
|
969 | - * @throws InvalidInterfaceException |
|
970 | - * @throws InvalidDataTypeException |
|
971 | - * @throws EE_Error |
|
972 | - */ |
|
973 | - public function end() |
|
974 | - { |
|
975 | - return $this->get_raw('DTT_EVT_end'); |
|
976 | - } |
|
977 | - |
|
978 | - |
|
979 | - /** |
|
980 | - * get the registration limit for this datetime slot |
|
981 | - * |
|
982 | - * @return mixed int on success, FALSE on fail |
|
983 | - * @throws ReflectionException |
|
984 | - * @throws InvalidArgumentException |
|
985 | - * @throws InvalidInterfaceException |
|
986 | - * @throws InvalidDataTypeException |
|
987 | - * @throws EE_Error |
|
988 | - */ |
|
989 | - public function reg_limit() |
|
990 | - { |
|
991 | - return $this->get_raw('DTT_reg_limit'); |
|
992 | - } |
|
993 | - |
|
994 | - |
|
995 | - /** |
|
996 | - * have the tickets sold for this datetime, met or exceed the registration limit ? |
|
997 | - * |
|
998 | - * @return boolean |
|
999 | - * @throws ReflectionException |
|
1000 | - * @throws InvalidArgumentException |
|
1001 | - * @throws InvalidInterfaceException |
|
1002 | - * @throws InvalidDataTypeException |
|
1003 | - * @throws EE_Error |
|
1004 | - */ |
|
1005 | - public function sold_out() |
|
1006 | - { |
|
1007 | - return $this->reg_limit() > 0 && $this->sold() >= $this->reg_limit(); |
|
1008 | - } |
|
1009 | - |
|
1010 | - |
|
1011 | - /** |
|
1012 | - * return the total number of spaces remaining at this venue. |
|
1013 | - * This only takes the venue's capacity into account, NOT the tickets available for sale |
|
1014 | - * |
|
1015 | - * @param bool $consider_tickets Whether to consider tickets remaining when determining if there are any spaces left |
|
1016 | - * Because if all tickets attached to this datetime have no spaces left, |
|
1017 | - * then this datetime IS effectively sold out. |
|
1018 | - * However, there are cases where we just want to know the spaces |
|
1019 | - * remaining for this particular datetime, hence the flag. |
|
1020 | - * @return int |
|
1021 | - * @throws ReflectionException |
|
1022 | - * @throws InvalidArgumentException |
|
1023 | - * @throws InvalidInterfaceException |
|
1024 | - * @throws InvalidDataTypeException |
|
1025 | - * @throws EE_Error |
|
1026 | - */ |
|
1027 | - public function spaces_remaining($consider_tickets = false) |
|
1028 | - { |
|
1029 | - // tickets remaining available for purchase |
|
1030 | - // no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF |
|
1031 | - $dtt_remaining = $this->reg_limit() - $this->sold_and_reserved(); |
|
1032 | - if (! $consider_tickets) { |
|
1033 | - return $dtt_remaining; |
|
1034 | - } |
|
1035 | - $tickets_remaining = $this->tickets_remaining(); |
|
1036 | - return min($dtt_remaining, $tickets_remaining); |
|
1037 | - } |
|
1038 | - |
|
1039 | - |
|
1040 | - /** |
|
1041 | - * Counts the total tickets available |
|
1042 | - * (from all the different types of tickets which are available for this datetime). |
|
1043 | - * |
|
1044 | - * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
1045 | - * @return int |
|
1046 | - * @throws ReflectionException |
|
1047 | - * @throws InvalidArgumentException |
|
1048 | - * @throws InvalidInterfaceException |
|
1049 | - * @throws InvalidDataTypeException |
|
1050 | - * @throws EE_Error |
|
1051 | - */ |
|
1052 | - public function tickets_remaining($query_params = array()) |
|
1053 | - { |
|
1054 | - $sum = 0; |
|
1055 | - $tickets = $this->tickets($query_params); |
|
1056 | - if (! empty($tickets)) { |
|
1057 | - foreach ($tickets as $ticket) { |
|
1058 | - if ($ticket instanceof EE_Ticket) { |
|
1059 | - // get the actual amount of tickets that can be sold |
|
1060 | - $qty = $ticket->qty('saleable'); |
|
1061 | - if ($qty === EE_INF) { |
|
1062 | - return EE_INF; |
|
1063 | - } |
|
1064 | - // no negative ticket quantities plz |
|
1065 | - if ($qty > 0) { |
|
1066 | - $sum += $qty; |
|
1067 | - } |
|
1068 | - } |
|
1069 | - } |
|
1070 | - } |
|
1071 | - return $sum; |
|
1072 | - } |
|
1073 | - |
|
1074 | - |
|
1075 | - /** |
|
1076 | - * Gets the count of all the tickets available at this datetime (not ticket types) |
|
1077 | - * before any were sold |
|
1078 | - * |
|
1079 | - * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
1080 | - * @return int |
|
1081 | - * @throws ReflectionException |
|
1082 | - * @throws InvalidArgumentException |
|
1083 | - * @throws InvalidInterfaceException |
|
1084 | - * @throws InvalidDataTypeException |
|
1085 | - * @throws EE_Error |
|
1086 | - */ |
|
1087 | - public function sum_tickets_initially_available($query_params = array()) |
|
1088 | - { |
|
1089 | - return $this->sum_related('Ticket', $query_params, 'TKT_qty'); |
|
1090 | - } |
|
1091 | - |
|
1092 | - |
|
1093 | - /** |
|
1094 | - * Returns the lesser-of-the two: spaces remaining at this datetime, or |
|
1095 | - * the total tickets remaining (a sum of the tickets remaining for each ticket type |
|
1096 | - * that is available for this datetime). |
|
1097 | - * |
|
1098 | - * @return int |
|
1099 | - * @throws ReflectionException |
|
1100 | - * @throws InvalidArgumentException |
|
1101 | - * @throws InvalidInterfaceException |
|
1102 | - * @throws InvalidDataTypeException |
|
1103 | - * @throws EE_Error |
|
1104 | - */ |
|
1105 | - public function total_tickets_available_at_this_datetime() |
|
1106 | - { |
|
1107 | - return $this->spaces_remaining(true); |
|
1108 | - } |
|
1109 | - |
|
1110 | - |
|
1111 | - /** |
|
1112 | - * This simply compares the internal dtt for the given string with NOW |
|
1113 | - * and determines if the date is upcoming or not. |
|
1114 | - * |
|
1115 | - * @access public |
|
1116 | - * @return boolean |
|
1117 | - * @throws ReflectionException |
|
1118 | - * @throws InvalidArgumentException |
|
1119 | - * @throws InvalidInterfaceException |
|
1120 | - * @throws InvalidDataTypeException |
|
1121 | - * @throws EE_Error |
|
1122 | - */ |
|
1123 | - public function is_upcoming() |
|
1124 | - { |
|
1125 | - return ($this->get_raw('DTT_EVT_start') > time()); |
|
1126 | - } |
|
1127 | - |
|
1128 | - |
|
1129 | - /** |
|
1130 | - * This simply compares the internal datetime for the given string with NOW |
|
1131 | - * and returns if the date is active (i.e. start and end time) |
|
1132 | - * |
|
1133 | - * @return boolean |
|
1134 | - * @throws ReflectionException |
|
1135 | - * @throws InvalidArgumentException |
|
1136 | - * @throws InvalidInterfaceException |
|
1137 | - * @throws InvalidDataTypeException |
|
1138 | - * @throws EE_Error |
|
1139 | - */ |
|
1140 | - public function is_active() |
|
1141 | - { |
|
1142 | - return ($this->get_raw('DTT_EVT_start') < time() && $this->get_raw('DTT_EVT_end') > time()); |
|
1143 | - } |
|
1144 | - |
|
1145 | - |
|
1146 | - /** |
|
1147 | - * This simply compares the internal dtt for the given string with NOW |
|
1148 | - * and determines if the date is expired or not. |
|
1149 | - * |
|
1150 | - * @return boolean |
|
1151 | - * @throws ReflectionException |
|
1152 | - * @throws InvalidArgumentException |
|
1153 | - * @throws InvalidInterfaceException |
|
1154 | - * @throws InvalidDataTypeException |
|
1155 | - * @throws EE_Error |
|
1156 | - */ |
|
1157 | - public function is_expired() |
|
1158 | - { |
|
1159 | - return ($this->get_raw('DTT_EVT_end') < time()); |
|
1160 | - } |
|
1161 | - |
|
1162 | - |
|
1163 | - /** |
|
1164 | - * This returns the active status for whether an event is active, upcoming, or expired |
|
1165 | - * |
|
1166 | - * @return int return value will be one of the EE_Datetime status constants. |
|
1167 | - * @throws ReflectionException |
|
1168 | - * @throws InvalidArgumentException |
|
1169 | - * @throws InvalidInterfaceException |
|
1170 | - * @throws InvalidDataTypeException |
|
1171 | - * @throws EE_Error |
|
1172 | - */ |
|
1173 | - public function get_active_status() |
|
1174 | - { |
|
1175 | - $total_tickets_for_this_dtt = $this->total_tickets_available_at_this_datetime(); |
|
1176 | - if ($total_tickets_for_this_dtt !== false && $total_tickets_for_this_dtt < 1) { |
|
1177 | - return EE_Datetime::sold_out; |
|
1178 | - } |
|
1179 | - if ($this->is_expired()) { |
|
1180 | - return EE_Datetime::expired; |
|
1181 | - } |
|
1182 | - if ($this->is_upcoming()) { |
|
1183 | - return EE_Datetime::upcoming; |
|
1184 | - } |
|
1185 | - if ($this->is_active()) { |
|
1186 | - return EE_Datetime::active; |
|
1187 | - } |
|
1188 | - return null; |
|
1189 | - } |
|
1190 | - |
|
1191 | - |
|
1192 | - /** |
|
1193 | - * This returns a nice display name for the datetime that is contingent on the span between the dates and times. |
|
1194 | - * |
|
1195 | - * @param boolean $use_dtt_name if TRUE then we'll use DTT->name() if its not empty. |
|
1196 | - * @return string |
|
1197 | - * @throws ReflectionException |
|
1198 | - * @throws InvalidArgumentException |
|
1199 | - * @throws InvalidInterfaceException |
|
1200 | - * @throws InvalidDataTypeException |
|
1201 | - * @throws EE_Error |
|
1202 | - */ |
|
1203 | - public function get_dtt_display_name($use_dtt_name = false) |
|
1204 | - { |
|
1205 | - if ($use_dtt_name) { |
|
1206 | - $dtt_name = $this->name(); |
|
1207 | - if (! empty($dtt_name)) { |
|
1208 | - return $dtt_name; |
|
1209 | - } |
|
1210 | - } |
|
1211 | - // first condition is to see if the months are different |
|
1212 | - if (date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end')) |
|
1213 | - ) { |
|
1214 | - $display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a'); |
|
1215 | - // next condition is if its the same month but different day |
|
1216 | - } else { |
|
1217 | - if (date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end')) |
|
1218 | - && date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end')) |
|
1219 | - ) { |
|
1220 | - $display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y'); |
|
1221 | - } else { |
|
1222 | - $display_date = $this->start_date('F j\, Y') |
|
1223 | - . ' @ ' |
|
1224 | - . $this->start_date('g:i a') |
|
1225 | - . ' - ' |
|
1226 | - . $this->end_date('g:i a'); |
|
1227 | - } |
|
1228 | - } |
|
1229 | - return $display_date; |
|
1230 | - } |
|
1231 | - |
|
1232 | - |
|
1233 | - /** |
|
1234 | - * Gets all the tickets for this datetime |
|
1235 | - * |
|
1236 | - * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
1237 | - * @return EE_Base_Class[]|EE_Ticket[] |
|
1238 | - * @throws ReflectionException |
|
1239 | - * @throws InvalidArgumentException |
|
1240 | - * @throws InvalidInterfaceException |
|
1241 | - * @throws InvalidDataTypeException |
|
1242 | - * @throws EE_Error |
|
1243 | - */ |
|
1244 | - public function tickets($query_params = array()) |
|
1245 | - { |
|
1246 | - return $this->get_many_related('Ticket', $query_params); |
|
1247 | - } |
|
1248 | - |
|
1249 | - |
|
1250 | - /** |
|
1251 | - * Gets all the ticket types currently available for purchase |
|
1252 | - * |
|
1253 | - * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
1254 | - * @return EE_Ticket[] |
|
1255 | - * @throws ReflectionException |
|
1256 | - * @throws InvalidArgumentException |
|
1257 | - * @throws InvalidInterfaceException |
|
1258 | - * @throws InvalidDataTypeException |
|
1259 | - * @throws EE_Error |
|
1260 | - */ |
|
1261 | - public function ticket_types_available_for_purchase($query_params = array()) |
|
1262 | - { |
|
1263 | - // first check if datetime is valid |
|
1264 | - if ($this->sold_out() || ! ($this->is_upcoming() || $this->is_active())) { |
|
1265 | - return array(); |
|
1266 | - } |
|
1267 | - if (empty($query_params)) { |
|
1268 | - $query_params = array( |
|
1269 | - array( |
|
1270 | - 'TKT_start_date' => array('<=', EEM_Ticket::instance()->current_time_for_query('TKT_start_date')), |
|
1271 | - 'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')), |
|
1272 | - 'TKT_deleted' => false, |
|
1273 | - ), |
|
1274 | - ); |
|
1275 | - } |
|
1276 | - return $this->tickets($query_params); |
|
1277 | - } |
|
1278 | - |
|
1279 | - |
|
1280 | - /** |
|
1281 | - * @return EE_Base_Class|EE_Event |
|
1282 | - * @throws ReflectionException |
|
1283 | - * @throws InvalidArgumentException |
|
1284 | - * @throws InvalidInterfaceException |
|
1285 | - * @throws InvalidDataTypeException |
|
1286 | - * @throws EE_Error |
|
1287 | - */ |
|
1288 | - public function event() |
|
1289 | - { |
|
1290 | - return $this->get_first_related('Event'); |
|
1291 | - } |
|
1292 | - |
|
1293 | - |
|
1294 | - /** |
|
1295 | - * Updates the DTT_sold attribute (and saves) based on the number of registrations for this datetime |
|
1296 | - * (via the tickets). |
|
1297 | - * |
|
1298 | - * @return int |
|
1299 | - * @throws ReflectionException |
|
1300 | - * @throws InvalidArgumentException |
|
1301 | - * @throws InvalidInterfaceException |
|
1302 | - * @throws InvalidDataTypeException |
|
1303 | - * @throws EE_Error |
|
1304 | - */ |
|
1305 | - public function update_sold() |
|
1306 | - { |
|
1307 | - $count_regs_for_this_datetime = EEM_Registration::instance()->count( |
|
1308 | - array( |
|
1309 | - array( |
|
1310 | - 'STS_ID' => EEM_Registration::status_id_approved, |
|
1311 | - 'REG_deleted' => 0, |
|
1312 | - 'Ticket.Datetime.DTT_ID' => $this->ID(), |
|
1313 | - ), |
|
1314 | - ) |
|
1315 | - ); |
|
1316 | - $this->set_sold($count_regs_for_this_datetime); |
|
1317 | - $this->save(); |
|
1318 | - return $count_regs_for_this_datetime; |
|
1319 | - } |
|
1320 | - |
|
1321 | - |
|
1322 | - /******************************************************************* |
|
16 | + /** |
|
17 | + * constant used by get_active_status, indicates datetime has no more available spaces |
|
18 | + */ |
|
19 | + const sold_out = 'DTS'; |
|
20 | + |
|
21 | + /** |
|
22 | + * constant used by get_active_status, indicating datetime is still active (even is not over, can be registered-for) |
|
23 | + */ |
|
24 | + const active = 'DTA'; |
|
25 | + |
|
26 | + /** |
|
27 | + * constant used by get_active_status, indicating the datetime cannot be used for registrations yet, but has not |
|
28 | + * expired |
|
29 | + */ |
|
30 | + const upcoming = 'DTU'; |
|
31 | + |
|
32 | + /** |
|
33 | + * Datetime is postponed |
|
34 | + */ |
|
35 | + const postponed = 'DTP'; |
|
36 | + |
|
37 | + /** |
|
38 | + * Datetime is cancelled |
|
39 | + */ |
|
40 | + const cancelled = 'DTC'; |
|
41 | + |
|
42 | + /** |
|
43 | + * constant used by get_active_status, indicates datetime has expired (event is over) |
|
44 | + */ |
|
45 | + const expired = 'DTE'; |
|
46 | + |
|
47 | + /** |
|
48 | + * constant used in various places indicating that an event is INACTIVE (not yet ready to be published) |
|
49 | + */ |
|
50 | + const inactive = 'DTI'; |
|
51 | + |
|
52 | + |
|
53 | + /** |
|
54 | + * @param array $props_n_values incoming values |
|
55 | + * @param string $timezone incoming timezone (if not set the timezone set for the website will be used.) |
|
56 | + * @param array $date_formats incoming date_formats in an array where the first value is the date_format |
|
57 | + * and the second value is the time format |
|
58 | + * @return EE_Datetime |
|
59 | + * @throws ReflectionException |
|
60 | + * @throws InvalidArgumentException |
|
61 | + * @throws InvalidInterfaceException |
|
62 | + * @throws InvalidDataTypeException |
|
63 | + * @throws EE_Error |
|
64 | + */ |
|
65 | + public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
66 | + { |
|
67 | + $has_object = parent::_check_for_object( |
|
68 | + $props_n_values, |
|
69 | + __CLASS__, |
|
70 | + $timezone, |
|
71 | + $date_formats |
|
72 | + ); |
|
73 | + return $has_object |
|
74 | + ? $has_object |
|
75 | + : new self($props_n_values, false, $timezone, $date_formats); |
|
76 | + } |
|
77 | + |
|
78 | + |
|
79 | + /** |
|
80 | + * @param array $props_n_values incoming values from the database |
|
81 | + * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
82 | + * the website will be used. |
|
83 | + * @return EE_Datetime |
|
84 | + * @throws ReflectionException |
|
85 | + * @throws InvalidArgumentException |
|
86 | + * @throws InvalidInterfaceException |
|
87 | + * @throws InvalidDataTypeException |
|
88 | + * @throws EE_Error |
|
89 | + */ |
|
90 | + public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
91 | + { |
|
92 | + return new self($props_n_values, true, $timezone); |
|
93 | + } |
|
94 | + |
|
95 | + |
|
96 | + /** |
|
97 | + * @param $name |
|
98 | + * @throws ReflectionException |
|
99 | + * @throws InvalidArgumentException |
|
100 | + * @throws InvalidInterfaceException |
|
101 | + * @throws InvalidDataTypeException |
|
102 | + * @throws EE_Error |
|
103 | + */ |
|
104 | + public function set_name($name) |
|
105 | + { |
|
106 | + $this->set('DTT_name', $name); |
|
107 | + } |
|
108 | + |
|
109 | + |
|
110 | + /** |
|
111 | + * @param $description |
|
112 | + * @throws ReflectionException |
|
113 | + * @throws InvalidArgumentException |
|
114 | + * @throws InvalidInterfaceException |
|
115 | + * @throws InvalidDataTypeException |
|
116 | + * @throws EE_Error |
|
117 | + */ |
|
118 | + public function set_description($description) |
|
119 | + { |
|
120 | + $this->set('DTT_description', $description); |
|
121 | + } |
|
122 | + |
|
123 | + |
|
124 | + /** |
|
125 | + * Set event start date |
|
126 | + * set the start date for an event |
|
127 | + * |
|
128 | + * @param string $date a string representation of the event's date ex: Dec. 25, 2025 or 12-25-2025 |
|
129 | + * @throws ReflectionException |
|
130 | + * @throws InvalidArgumentException |
|
131 | + * @throws InvalidInterfaceException |
|
132 | + * @throws InvalidDataTypeException |
|
133 | + * @throws EE_Error |
|
134 | + */ |
|
135 | + public function set_start_date($date) |
|
136 | + { |
|
137 | + $this->_set_date_for($date, 'DTT_EVT_start'); |
|
138 | + } |
|
139 | + |
|
140 | + |
|
141 | + /** |
|
142 | + * Set event start time |
|
143 | + * set the start time for an event |
|
144 | + * |
|
145 | + * @param string $time a string representation of the event time ex: 9am or 7:30 PM |
|
146 | + * @throws ReflectionException |
|
147 | + * @throws InvalidArgumentException |
|
148 | + * @throws InvalidInterfaceException |
|
149 | + * @throws InvalidDataTypeException |
|
150 | + * @throws EE_Error |
|
151 | + */ |
|
152 | + public function set_start_time($time) |
|
153 | + { |
|
154 | + $this->_set_time_for($time, 'DTT_EVT_start'); |
|
155 | + } |
|
156 | + |
|
157 | + |
|
158 | + /** |
|
159 | + * Set event end date |
|
160 | + * set the end date for an event |
|
161 | + * |
|
162 | + * @param string $date a string representation of the event's date ex: Dec. 25, 2025 or 12-25-2025 |
|
163 | + * @throws ReflectionException |
|
164 | + * @throws InvalidArgumentException |
|
165 | + * @throws InvalidInterfaceException |
|
166 | + * @throws InvalidDataTypeException |
|
167 | + * @throws EE_Error |
|
168 | + */ |
|
169 | + public function set_end_date($date) |
|
170 | + { |
|
171 | + $this->_set_date_for($date, 'DTT_EVT_end'); |
|
172 | + } |
|
173 | + |
|
174 | + |
|
175 | + /** |
|
176 | + * Set event end time |
|
177 | + * set the end time for an event |
|
178 | + * |
|
179 | + * @param string $time a string representation of the event time ex: 9am or 7:30 PM |
|
180 | + * @throws ReflectionException |
|
181 | + * @throws InvalidArgumentException |
|
182 | + * @throws InvalidInterfaceException |
|
183 | + * @throws InvalidDataTypeException |
|
184 | + * @throws EE_Error |
|
185 | + */ |
|
186 | + public function set_end_time($time) |
|
187 | + { |
|
188 | + $this->_set_time_for($time, 'DTT_EVT_end'); |
|
189 | + } |
|
190 | + |
|
191 | + |
|
192 | + /** |
|
193 | + * Set registration limit |
|
194 | + * set the maximum number of attendees that can be registered for this datetime slot |
|
195 | + * |
|
196 | + * @param int $reg_limit |
|
197 | + * @throws ReflectionException |
|
198 | + * @throws InvalidArgumentException |
|
199 | + * @throws InvalidInterfaceException |
|
200 | + * @throws InvalidDataTypeException |
|
201 | + * @throws EE_Error |
|
202 | + */ |
|
203 | + public function set_reg_limit($reg_limit) |
|
204 | + { |
|
205 | + $this->set('DTT_reg_limit', $reg_limit); |
|
206 | + } |
|
207 | + |
|
208 | + |
|
209 | + /** |
|
210 | + * get the number of tickets sold for this datetime slot |
|
211 | + * |
|
212 | + * @return mixed int on success, FALSE on fail |
|
213 | + * @throws ReflectionException |
|
214 | + * @throws InvalidArgumentException |
|
215 | + * @throws InvalidInterfaceException |
|
216 | + * @throws InvalidDataTypeException |
|
217 | + * @throws EE_Error |
|
218 | + */ |
|
219 | + public function sold() |
|
220 | + { |
|
221 | + return $this->get_raw('DTT_sold'); |
|
222 | + } |
|
223 | + |
|
224 | + |
|
225 | + /** |
|
226 | + * @param int $sold |
|
227 | + * @throws ReflectionException |
|
228 | + * @throws InvalidArgumentException |
|
229 | + * @throws InvalidInterfaceException |
|
230 | + * @throws InvalidDataTypeException |
|
231 | + * @throws EE_Error |
|
232 | + */ |
|
233 | + public function set_sold($sold) |
|
234 | + { |
|
235 | + // sold can not go below zero |
|
236 | + $sold = max(0, $sold); |
|
237 | + $this->set('DTT_sold', $sold); |
|
238 | + } |
|
239 | + |
|
240 | + |
|
241 | + /** |
|
242 | + * Increments sold by amount passed by $qty, and persists it immediately to the database. |
|
243 | + * Simultaneously decreases the reserved count, unless $also_decrease_reserved is false. |
|
244 | + * |
|
245 | + * @param int $qty |
|
246 | + * @param boolean $also_decrease_reserved |
|
247 | + * @return boolean indicating success |
|
248 | + * @throws ReflectionException |
|
249 | + * @throws InvalidArgumentException |
|
250 | + * @throws InvalidInterfaceException |
|
251 | + * @throws InvalidDataTypeException |
|
252 | + * @throws EE_Error |
|
253 | + */ |
|
254 | + public function increaseSold($qty = 1, $also_decrease_reserved = true) |
|
255 | + { |
|
256 | + $qty = absint($qty); |
|
257 | + if ($also_decrease_reserved) { |
|
258 | + $success = $this->adjustNumericFieldsInDb( |
|
259 | + [ |
|
260 | + 'DTT_reserved' => $qty * -1, |
|
261 | + 'DTT_sold' => $qty |
|
262 | + ] |
|
263 | + ); |
|
264 | + } else { |
|
265 | + $success = $this->adjustNumericFieldsInDb( |
|
266 | + [ |
|
267 | + 'DTT_sold' => $qty |
|
268 | + ] |
|
269 | + ); |
|
270 | + } |
|
271 | + |
|
272 | + do_action( |
|
273 | + 'AHEE__EE_Datetime__increase_sold', |
|
274 | + $this, |
|
275 | + $qty, |
|
276 | + $this->sold(), |
|
277 | + $success |
|
278 | + ); |
|
279 | + return $success; |
|
280 | + } |
|
281 | + |
|
282 | + |
|
283 | + /** |
|
284 | + * Decrements (subtracts) sold amount passed by $qty directly in the DB and on the model object. (Ie, no need |
|
285 | + * to save afterwards.) |
|
286 | + * |
|
287 | + * @param int $qty |
|
288 | + * @return boolean indicating success |
|
289 | + * @throws ReflectionException |
|
290 | + * @throws InvalidArgumentException |
|
291 | + * @throws InvalidInterfaceException |
|
292 | + * @throws InvalidDataTypeException |
|
293 | + * @throws EE_Error |
|
294 | + */ |
|
295 | + public function decreaseSold($qty = 1) |
|
296 | + { |
|
297 | + $qty = absint($qty); |
|
298 | + $success = $this->adjustNumericFieldsInDb( |
|
299 | + [ |
|
300 | + 'DTT_sold' => $qty * -1 |
|
301 | + ] |
|
302 | + ); |
|
303 | + do_action( |
|
304 | + 'AHEE__EE_Datetime__decrease_sold', |
|
305 | + $this, |
|
306 | + $qty, |
|
307 | + $this->sold(), |
|
308 | + $success |
|
309 | + ); |
|
310 | + return $success; |
|
311 | + } |
|
312 | + |
|
313 | + |
|
314 | + /** |
|
315 | + * Gets qty of reserved tickets for this datetime |
|
316 | + * |
|
317 | + * @return int |
|
318 | + * @throws ReflectionException |
|
319 | + * @throws InvalidArgumentException |
|
320 | + * @throws InvalidInterfaceException |
|
321 | + * @throws InvalidDataTypeException |
|
322 | + * @throws EE_Error |
|
323 | + */ |
|
324 | + public function reserved() |
|
325 | + { |
|
326 | + return $this->get_raw('DTT_reserved'); |
|
327 | + } |
|
328 | + |
|
329 | + |
|
330 | + /** |
|
331 | + * Sets qty of reserved tickets for this datetime |
|
332 | + * |
|
333 | + * @param int $reserved |
|
334 | + * @throws ReflectionException |
|
335 | + * @throws InvalidArgumentException |
|
336 | + * @throws InvalidInterfaceException |
|
337 | + * @throws InvalidDataTypeException |
|
338 | + * @throws EE_Error |
|
339 | + */ |
|
340 | + public function set_reserved($reserved) |
|
341 | + { |
|
342 | + // reserved can not go below zero |
|
343 | + $reserved = max(0, (int) $reserved); |
|
344 | + $this->set('DTT_reserved', $reserved); |
|
345 | + } |
|
346 | + |
|
347 | + |
|
348 | + /** |
|
349 | + * Increments reserved by amount passed by $qty, and persists it immediately to the database. |
|
350 | + * |
|
351 | + * @param int $qty |
|
352 | + * @return boolean indicating success |
|
353 | + * @throws ReflectionException |
|
354 | + * @throws InvalidArgumentException |
|
355 | + * @throws InvalidInterfaceException |
|
356 | + * @throws InvalidDataTypeException |
|
357 | + * @throws EE_Error |
|
358 | + */ |
|
359 | + public function increaseReserved($qty = 1) |
|
360 | + { |
|
361 | + $qty = absint($qty); |
|
362 | + $success = $this->incrementFieldConditionallyInDb( |
|
363 | + 'DTT_reserved', |
|
364 | + 'DTT_sold', |
|
365 | + 'DTT_reg_limit', |
|
366 | + $qty |
|
367 | + ); |
|
368 | + do_action( |
|
369 | + 'AHEE__EE_Datetime__increase_reserved', |
|
370 | + $this, |
|
371 | + $qty, |
|
372 | + $this->reserved(), |
|
373 | + $success |
|
374 | + ); |
|
375 | + return $success; |
|
376 | + } |
|
377 | + |
|
378 | + |
|
379 | + /** |
|
380 | + * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database. |
|
381 | + * |
|
382 | + * @param int $qty |
|
383 | + * @return boolean indicating success |
|
384 | + * @throws ReflectionException |
|
385 | + * @throws InvalidArgumentException |
|
386 | + * @throws InvalidInterfaceException |
|
387 | + * @throws InvalidDataTypeException |
|
388 | + * @throws EE_Error |
|
389 | + */ |
|
390 | + public function decreaseReserved($qty = 1) |
|
391 | + { |
|
392 | + $qty = absint($qty); |
|
393 | + $success = $this->adjustNumericFieldsInDb( |
|
394 | + [ |
|
395 | + 'DTT_reserved' => $qty * -1 |
|
396 | + ] |
|
397 | + ); |
|
398 | + do_action( |
|
399 | + 'AHEE__EE_Datetime__decrease_reserved', |
|
400 | + $this, |
|
401 | + $qty, |
|
402 | + $this->reserved(), |
|
403 | + $success |
|
404 | + ); |
|
405 | + return $success; |
|
406 | + } |
|
407 | + |
|
408 | + |
|
409 | + /** |
|
410 | + * total sold and reserved tickets |
|
411 | + * |
|
412 | + * @return int |
|
413 | + * @throws ReflectionException |
|
414 | + * @throws InvalidArgumentException |
|
415 | + * @throws InvalidInterfaceException |
|
416 | + * @throws InvalidDataTypeException |
|
417 | + * @throws EE_Error |
|
418 | + */ |
|
419 | + public function sold_and_reserved() |
|
420 | + { |
|
421 | + return $this->sold() + $this->reserved(); |
|
422 | + } |
|
423 | + |
|
424 | + |
|
425 | + /** |
|
426 | + * returns the datetime name |
|
427 | + * |
|
428 | + * @return string |
|
429 | + * @throws ReflectionException |
|
430 | + * @throws InvalidArgumentException |
|
431 | + * @throws InvalidInterfaceException |
|
432 | + * @throws InvalidDataTypeException |
|
433 | + * @throws EE_Error |
|
434 | + */ |
|
435 | + public function name() |
|
436 | + { |
|
437 | + return $this->get('DTT_name'); |
|
438 | + } |
|
439 | + |
|
440 | + |
|
441 | + /** |
|
442 | + * returns the datetime description |
|
443 | + * |
|
444 | + * @return string |
|
445 | + * @throws ReflectionException |
|
446 | + * @throws InvalidArgumentException |
|
447 | + * @throws InvalidInterfaceException |
|
448 | + * @throws InvalidDataTypeException |
|
449 | + * @throws EE_Error |
|
450 | + */ |
|
451 | + public function description() |
|
452 | + { |
|
453 | + return $this->get('DTT_description'); |
|
454 | + } |
|
455 | + |
|
456 | + |
|
457 | + /** |
|
458 | + * This helper simply returns whether the event_datetime for the current datetime is a primary datetime |
|
459 | + * |
|
460 | + * @return boolean TRUE if is primary, FALSE if not. |
|
461 | + * @throws ReflectionException |
|
462 | + * @throws InvalidArgumentException |
|
463 | + * @throws InvalidInterfaceException |
|
464 | + * @throws InvalidDataTypeException |
|
465 | + * @throws EE_Error |
|
466 | + */ |
|
467 | + public function is_primary() |
|
468 | + { |
|
469 | + return $this->get('DTT_is_primary'); |
|
470 | + } |
|
471 | + |
|
472 | + |
|
473 | + /** |
|
474 | + * This helper simply returns the order for the datetime |
|
475 | + * |
|
476 | + * @return int The order of the datetime for this event. |
|
477 | + * @throws ReflectionException |
|
478 | + * @throws InvalidArgumentException |
|
479 | + * @throws InvalidInterfaceException |
|
480 | + * @throws InvalidDataTypeException |
|
481 | + * @throws EE_Error |
|
482 | + */ |
|
483 | + public function order() |
|
484 | + { |
|
485 | + return $this->get('DTT_order'); |
|
486 | + } |
|
487 | + |
|
488 | + |
|
489 | + /** |
|
490 | + * This helper simply returns the parent id for the datetime |
|
491 | + * |
|
492 | + * @return int |
|
493 | + * @throws ReflectionException |
|
494 | + * @throws InvalidArgumentException |
|
495 | + * @throws InvalidInterfaceException |
|
496 | + * @throws InvalidDataTypeException |
|
497 | + * @throws EE_Error |
|
498 | + */ |
|
499 | + public function parent() |
|
500 | + { |
|
501 | + return $this->get('DTT_parent'); |
|
502 | + } |
|
503 | + |
|
504 | + |
|
505 | + /** |
|
506 | + * show date and/or time |
|
507 | + * |
|
508 | + * @param string $date_or_time whether to display a date or time or both |
|
509 | + * @param string $start_or_end whether to display start or end datetimes |
|
510 | + * @param string $dt_frmt |
|
511 | + * @param string $tm_frmt |
|
512 | + * @param bool $echo whether we echo or return (note echoing uses "pretty" formats, |
|
513 | + * otherwise we use the standard formats) |
|
514 | + * @return string|bool string on success, FALSE on fail |
|
515 | + * @throws ReflectionException |
|
516 | + * @throws InvalidArgumentException |
|
517 | + * @throws InvalidInterfaceException |
|
518 | + * @throws InvalidDataTypeException |
|
519 | + * @throws EE_Error |
|
520 | + */ |
|
521 | + private function _show_datetime( |
|
522 | + $date_or_time = null, |
|
523 | + $start_or_end = 'start', |
|
524 | + $dt_frmt = '', |
|
525 | + $tm_frmt = '', |
|
526 | + $echo = false |
|
527 | + ) { |
|
528 | + $field_name = "DTT_EVT_{$start_or_end}"; |
|
529 | + $dtt = $this->_get_datetime( |
|
530 | + $field_name, |
|
531 | + $dt_frmt, |
|
532 | + $tm_frmt, |
|
533 | + $date_or_time, |
|
534 | + $echo |
|
535 | + ); |
|
536 | + if (! $echo) { |
|
537 | + return $dtt; |
|
538 | + } |
|
539 | + return ''; |
|
540 | + } |
|
541 | + |
|
542 | + |
|
543 | + /** |
|
544 | + * get event start date. Provide either the date format, or NULL to re-use the |
|
545 | + * last-used format, or '' to use the default date format |
|
546 | + * |
|
547 | + * @param string $dt_frmt string representation of date format defaults to 'F j, Y' |
|
548 | + * @return mixed string on success, FALSE on fail |
|
549 | + * @throws ReflectionException |
|
550 | + * @throws InvalidArgumentException |
|
551 | + * @throws InvalidInterfaceException |
|
552 | + * @throws InvalidDataTypeException |
|
553 | + * @throws EE_Error |
|
554 | + */ |
|
555 | + public function start_date($dt_frmt = '') |
|
556 | + { |
|
557 | + return $this->_show_datetime('D', 'start', $dt_frmt); |
|
558 | + } |
|
559 | + |
|
560 | + |
|
561 | + /** |
|
562 | + * Echoes start_date() |
|
563 | + * |
|
564 | + * @param string $dt_frmt |
|
565 | + * @throws ReflectionException |
|
566 | + * @throws InvalidArgumentException |
|
567 | + * @throws InvalidInterfaceException |
|
568 | + * @throws InvalidDataTypeException |
|
569 | + * @throws EE_Error |
|
570 | + */ |
|
571 | + public function e_start_date($dt_frmt = '') |
|
572 | + { |
|
573 | + $this->_show_datetime('D', 'start', $dt_frmt, null, true); |
|
574 | + } |
|
575 | + |
|
576 | + |
|
577 | + /** |
|
578 | + * get end date. Provide either the date format, or NULL to re-use the |
|
579 | + * last-used format, or '' to use the default date format |
|
580 | + * |
|
581 | + * @param string $dt_frmt string representation of date format defaults to 'F j, Y' |
|
582 | + * @return mixed string on success, FALSE on fail |
|
583 | + * @throws ReflectionException |
|
584 | + * @throws InvalidArgumentException |
|
585 | + * @throws InvalidInterfaceException |
|
586 | + * @throws InvalidDataTypeException |
|
587 | + * @throws EE_Error |
|
588 | + */ |
|
589 | + public function end_date($dt_frmt = '') |
|
590 | + { |
|
591 | + return $this->_show_datetime('D', 'end', $dt_frmt); |
|
592 | + } |
|
593 | + |
|
594 | + |
|
595 | + /** |
|
596 | + * Echoes the end date. See end_date() |
|
597 | + * |
|
598 | + * @param string $dt_frmt |
|
599 | + * @throws ReflectionException |
|
600 | + * @throws InvalidArgumentException |
|
601 | + * @throws InvalidInterfaceException |
|
602 | + * @throws InvalidDataTypeException |
|
603 | + * @throws EE_Error |
|
604 | + */ |
|
605 | + public function e_end_date($dt_frmt = '') |
|
606 | + { |
|
607 | + $this->_show_datetime('D', 'end', $dt_frmt, null, true); |
|
608 | + } |
|
609 | + |
|
610 | + |
|
611 | + /** |
|
612 | + * get date_range - meaning the start AND end date |
|
613 | + * |
|
614 | + * @access public |
|
615 | + * @param string $dt_frmt string representation of date format defaults to WP settings |
|
616 | + * @param string $conjunction conjunction junction what's your function ? |
|
617 | + * this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
|
618 | + * @return mixed string on success, FALSE on fail |
|
619 | + * @throws ReflectionException |
|
620 | + * @throws InvalidArgumentException |
|
621 | + * @throws InvalidInterfaceException |
|
622 | + * @throws InvalidDataTypeException |
|
623 | + * @throws EE_Error |
|
624 | + */ |
|
625 | + public function date_range($dt_frmt = '', $conjunction = ' - ') |
|
626 | + { |
|
627 | + $dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt; |
|
628 | + $start = str_replace( |
|
629 | + ' ', |
|
630 | + ' ', |
|
631 | + $this->get_i18n_datetime('DTT_EVT_start', $dt_frmt) |
|
632 | + ); |
|
633 | + $end = str_replace( |
|
634 | + ' ', |
|
635 | + ' ', |
|
636 | + $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt) |
|
637 | + ); |
|
638 | + return $start !== $end ? $start . $conjunction . $end : $start; |
|
639 | + } |
|
640 | + |
|
641 | + |
|
642 | + /** |
|
643 | + * @param string $dt_frmt |
|
644 | + * @param string $conjunction |
|
645 | + * @throws ReflectionException |
|
646 | + * @throws InvalidArgumentException |
|
647 | + * @throws InvalidInterfaceException |
|
648 | + * @throws InvalidDataTypeException |
|
649 | + * @throws EE_Error |
|
650 | + */ |
|
651 | + public function e_date_range($dt_frmt = '', $conjunction = ' - ') |
|
652 | + { |
|
653 | + echo $this->date_range($dt_frmt, $conjunction); |
|
654 | + } |
|
655 | + |
|
656 | + |
|
657 | + /** |
|
658 | + * get start time |
|
659 | + * |
|
660 | + * @param string $tm_format - string representation of time format defaults to 'g:i a' |
|
661 | + * @return mixed string on success, FALSE on fail |
|
662 | + * @throws ReflectionException |
|
663 | + * @throws InvalidArgumentException |
|
664 | + * @throws InvalidInterfaceException |
|
665 | + * @throws InvalidDataTypeException |
|
666 | + * @throws EE_Error |
|
667 | + */ |
|
668 | + public function start_time($tm_format = '') |
|
669 | + { |
|
670 | + return $this->_show_datetime('T', 'start', null, $tm_format); |
|
671 | + } |
|
672 | + |
|
673 | + |
|
674 | + /** |
|
675 | + * @param string $tm_format |
|
676 | + * @throws ReflectionException |
|
677 | + * @throws InvalidArgumentException |
|
678 | + * @throws InvalidInterfaceException |
|
679 | + * @throws InvalidDataTypeException |
|
680 | + * @throws EE_Error |
|
681 | + */ |
|
682 | + public function e_start_time($tm_format = '') |
|
683 | + { |
|
684 | + $this->_show_datetime('T', 'start', null, $tm_format, true); |
|
685 | + } |
|
686 | + |
|
687 | + |
|
688 | + /** |
|
689 | + * get end time |
|
690 | + * |
|
691 | + * @param string $tm_format string representation of time format defaults to 'g:i a' |
|
692 | + * @return mixed string on success, FALSE on fail |
|
693 | + * @throws ReflectionException |
|
694 | + * @throws InvalidArgumentException |
|
695 | + * @throws InvalidInterfaceException |
|
696 | + * @throws InvalidDataTypeException |
|
697 | + * @throws EE_Error |
|
698 | + */ |
|
699 | + public function end_time($tm_format = '') |
|
700 | + { |
|
701 | + return $this->_show_datetime('T', 'end', null, $tm_format); |
|
702 | + } |
|
703 | + |
|
704 | + |
|
705 | + /** |
|
706 | + * @param string $tm_format |
|
707 | + * @throws ReflectionException |
|
708 | + * @throws InvalidArgumentException |
|
709 | + * @throws InvalidInterfaceException |
|
710 | + * @throws InvalidDataTypeException |
|
711 | + * @throws EE_Error |
|
712 | + */ |
|
713 | + public function e_end_time($tm_format = '') |
|
714 | + { |
|
715 | + $this->_show_datetime('T', 'end', null, $tm_format, true); |
|
716 | + } |
|
717 | + |
|
718 | + |
|
719 | + /** |
|
720 | + * get time_range |
|
721 | + * |
|
722 | + * @access public |
|
723 | + * @param string $tm_format string representation of time format defaults to 'g:i a' |
|
724 | + * @param string $conjunction conjunction junction what's your function ? |
|
725 | + * this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
|
726 | + * @return mixed string on success, FALSE on fail |
|
727 | + * @throws ReflectionException |
|
728 | + * @throws InvalidArgumentException |
|
729 | + * @throws InvalidInterfaceException |
|
730 | + * @throws InvalidDataTypeException |
|
731 | + * @throws EE_Error |
|
732 | + */ |
|
733 | + public function time_range($tm_format = '', $conjunction = ' - ') |
|
734 | + { |
|
735 | + $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt; |
|
736 | + $start = str_replace( |
|
737 | + ' ', |
|
738 | + ' ', |
|
739 | + $this->get_i18n_datetime('DTT_EVT_start', $tm_format) |
|
740 | + ); |
|
741 | + $end = str_replace( |
|
742 | + ' ', |
|
743 | + ' ', |
|
744 | + $this->get_i18n_datetime('DTT_EVT_end', $tm_format) |
|
745 | + ); |
|
746 | + return $start !== $end ? $start . $conjunction . $end : $start; |
|
747 | + } |
|
748 | + |
|
749 | + |
|
750 | + /** |
|
751 | + * @param string $tm_format |
|
752 | + * @param string $conjunction |
|
753 | + * @throws ReflectionException |
|
754 | + * @throws InvalidArgumentException |
|
755 | + * @throws InvalidInterfaceException |
|
756 | + * @throws InvalidDataTypeException |
|
757 | + * @throws EE_Error |
|
758 | + */ |
|
759 | + public function e_time_range($tm_format = '', $conjunction = ' - ') |
|
760 | + { |
|
761 | + echo $this->time_range($tm_format, $conjunction); |
|
762 | + } |
|
763 | + |
|
764 | + |
|
765 | + /** |
|
766 | + * This returns a range representation of the date and times. |
|
767 | + * Output is dependent on the difference (or similarity) between DTT_EVT_start and DTT_EVT_end. |
|
768 | + * Also, the return value is localized. |
|
769 | + * |
|
770 | + * @param string $dt_format |
|
771 | + * @param string $tm_format |
|
772 | + * @param string $conjunction used between two different dates or times. |
|
773 | + * ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm |
|
774 | + * @param string $separator used between the date and time formats. |
|
775 | + * ex: Dec 1, 2016{$separator}2pm |
|
776 | + * @return string |
|
777 | + * @throws ReflectionException |
|
778 | + * @throws InvalidArgumentException |
|
779 | + * @throws InvalidInterfaceException |
|
780 | + * @throws InvalidDataTypeException |
|
781 | + * @throws EE_Error |
|
782 | + */ |
|
783 | + public function date_and_time_range( |
|
784 | + $dt_format = '', |
|
785 | + $tm_format = '', |
|
786 | + $conjunction = ' - ', |
|
787 | + $separator = ' ' |
|
788 | + ) { |
|
789 | + $dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt; |
|
790 | + $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt; |
|
791 | + $full_format = $dt_format . $separator . $tm_format; |
|
792 | + // the range output depends on various conditions |
|
793 | + switch (true) { |
|
794 | + // start date timestamp and end date timestamp are the same. |
|
795 | + case ($this->get_raw('DTT_EVT_start') === $this->get_raw('DTT_EVT_end')): |
|
796 | + $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format); |
|
797 | + break; |
|
798 | + // start and end date are the same but times are different |
|
799 | + case ($this->start_date() === $this->end_date()): |
|
800 | + $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format) |
|
801 | + . $conjunction |
|
802 | + . $this->get_i18n_datetime('DTT_EVT_end', $tm_format); |
|
803 | + break; |
|
804 | + // all other conditions |
|
805 | + default: |
|
806 | + $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format) |
|
807 | + . $conjunction |
|
808 | + . $this->get_i18n_datetime('DTT_EVT_end', $full_format); |
|
809 | + break; |
|
810 | + } |
|
811 | + return $output; |
|
812 | + } |
|
813 | + |
|
814 | + |
|
815 | + /** |
|
816 | + * This echos the results of date and time range. |
|
817 | + * |
|
818 | + * @see date_and_time_range() for more details on purpose. |
|
819 | + * @param string $dt_format |
|
820 | + * @param string $tm_format |
|
821 | + * @param string $conjunction |
|
822 | + * @return void |
|
823 | + * @throws ReflectionException |
|
824 | + * @throws InvalidArgumentException |
|
825 | + * @throws InvalidInterfaceException |
|
826 | + * @throws InvalidDataTypeException |
|
827 | + * @throws EE_Error |
|
828 | + */ |
|
829 | + public function e_date_and_time_range($dt_format = '', $tm_format = '', $conjunction = ' - ') |
|
830 | + { |
|
831 | + echo $this->date_and_time_range($dt_format, $tm_format, $conjunction); |
|
832 | + } |
|
833 | + |
|
834 | + |
|
835 | + /** |
|
836 | + * get start date and start time |
|
837 | + * |
|
838 | + * @param string $dt_format - string representation of date format defaults to 'F j, Y' |
|
839 | + * @param string $tm_format - string representation of time format defaults to 'g:i a' |
|
840 | + * @return mixed string on success, FALSE on fail |
|
841 | + * @throws ReflectionException |
|
842 | + * @throws InvalidArgumentException |
|
843 | + * @throws InvalidInterfaceException |
|
844 | + * @throws InvalidDataTypeException |
|
845 | + * @throws EE_Error |
|
846 | + */ |
|
847 | + public function start_date_and_time($dt_format = '', $tm_format = '') |
|
848 | + { |
|
849 | + return $this->_show_datetime('', 'start', $dt_format, $tm_format); |
|
850 | + } |
|
851 | + |
|
852 | + |
|
853 | + /** |
|
854 | + * @param string $dt_frmt |
|
855 | + * @param string $tm_format |
|
856 | + * @throws ReflectionException |
|
857 | + * @throws InvalidArgumentException |
|
858 | + * @throws InvalidInterfaceException |
|
859 | + * @throws InvalidDataTypeException |
|
860 | + * @throws EE_Error |
|
861 | + */ |
|
862 | + public function e_start_date_and_time($dt_frmt = '', $tm_format = '') |
|
863 | + { |
|
864 | + $this->_show_datetime('', 'start', $dt_frmt, $tm_format, true); |
|
865 | + } |
|
866 | + |
|
867 | + |
|
868 | + /** |
|
869 | + * Shows the length of the event (start to end time). |
|
870 | + * Can be shown in 'seconds','minutes','hours', or 'days'. |
|
871 | + * By default, rounds up. (So if you use 'days', and then event |
|
872 | + * only occurs for 1 hour, it will return 1 day). |
|
873 | + * |
|
874 | + * @param string $units 'seconds','minutes','hours','days' |
|
875 | + * @param bool $round_up |
|
876 | + * @return float|int|mixed |
|
877 | + * @throws ReflectionException |
|
878 | + * @throws InvalidArgumentException |
|
879 | + * @throws InvalidInterfaceException |
|
880 | + * @throws InvalidDataTypeException |
|
881 | + * @throws EE_Error |
|
882 | + */ |
|
883 | + public function length($units = 'seconds', $round_up = false) |
|
884 | + { |
|
885 | + $start = $this->get_raw('DTT_EVT_start'); |
|
886 | + $end = $this->get_raw('DTT_EVT_end'); |
|
887 | + $length_in_units = $end - $start; |
|
888 | + switch ($units) { |
|
889 | + // NOTE: We purposefully don't use "break;" in order to chain the divisions |
|
890 | + /** @noinspection PhpMissingBreakStatementInspection */ |
|
891 | + // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment |
|
892 | + case 'days': |
|
893 | + $length_in_units /= 24; |
|
894 | + /** @noinspection PhpMissingBreakStatementInspection */ |
|
895 | + case 'hours': |
|
896 | + // fall through is intentional |
|
897 | + $length_in_units /= 60; |
|
898 | + /** @noinspection PhpMissingBreakStatementInspection */ |
|
899 | + case 'minutes': |
|
900 | + // fall through is intentional |
|
901 | + $length_in_units /= 60; |
|
902 | + case 'seconds': |
|
903 | + default: |
|
904 | + $length_in_units = ceil($length_in_units); |
|
905 | + } |
|
906 | + // phpcs:enable |
|
907 | + if ($round_up) { |
|
908 | + $length_in_units = max($length_in_units, 1); |
|
909 | + } |
|
910 | + return $length_in_units; |
|
911 | + } |
|
912 | + |
|
913 | + |
|
914 | + /** |
|
915 | + * get end date and time |
|
916 | + * |
|
917 | + * @param string $dt_frmt - string representation of date format defaults to 'F j, Y' |
|
918 | + * @param string $tm_format - string representation of time format defaults to 'g:i a' |
|
919 | + * @return mixed string on success, FALSE on fail |
|
920 | + * @throws ReflectionException |
|
921 | + * @throws InvalidArgumentException |
|
922 | + * @throws InvalidInterfaceException |
|
923 | + * @throws InvalidDataTypeException |
|
924 | + * @throws EE_Error |
|
925 | + */ |
|
926 | + public function end_date_and_time($dt_frmt = '', $tm_format = '') |
|
927 | + { |
|
928 | + return $this->_show_datetime('', 'end', $dt_frmt, $tm_format); |
|
929 | + } |
|
930 | + |
|
931 | + |
|
932 | + /** |
|
933 | + * @param string $dt_frmt |
|
934 | + * @param string $tm_format |
|
935 | + * @throws ReflectionException |
|
936 | + * @throws InvalidArgumentException |
|
937 | + * @throws InvalidInterfaceException |
|
938 | + * @throws InvalidDataTypeException |
|
939 | + * @throws EE_Error |
|
940 | + */ |
|
941 | + public function e_end_date_and_time($dt_frmt = '', $tm_format = '') |
|
942 | + { |
|
943 | + $this->_show_datetime('', 'end', $dt_frmt, $tm_format, true); |
|
944 | + } |
|
945 | + |
|
946 | + |
|
947 | + /** |
|
948 | + * get start timestamp |
|
949 | + * |
|
950 | + * @return int |
|
951 | + * @throws ReflectionException |
|
952 | + * @throws InvalidArgumentException |
|
953 | + * @throws InvalidInterfaceException |
|
954 | + * @throws InvalidDataTypeException |
|
955 | + * @throws EE_Error |
|
956 | + */ |
|
957 | + public function start() |
|
958 | + { |
|
959 | + return $this->get_raw('DTT_EVT_start'); |
|
960 | + } |
|
961 | + |
|
962 | + |
|
963 | + /** |
|
964 | + * get end timestamp |
|
965 | + * |
|
966 | + * @return int |
|
967 | + * @throws ReflectionException |
|
968 | + * @throws InvalidArgumentException |
|
969 | + * @throws InvalidInterfaceException |
|
970 | + * @throws InvalidDataTypeException |
|
971 | + * @throws EE_Error |
|
972 | + */ |
|
973 | + public function end() |
|
974 | + { |
|
975 | + return $this->get_raw('DTT_EVT_end'); |
|
976 | + } |
|
977 | + |
|
978 | + |
|
979 | + /** |
|
980 | + * get the registration limit for this datetime slot |
|
981 | + * |
|
982 | + * @return mixed int on success, FALSE on fail |
|
983 | + * @throws ReflectionException |
|
984 | + * @throws InvalidArgumentException |
|
985 | + * @throws InvalidInterfaceException |
|
986 | + * @throws InvalidDataTypeException |
|
987 | + * @throws EE_Error |
|
988 | + */ |
|
989 | + public function reg_limit() |
|
990 | + { |
|
991 | + return $this->get_raw('DTT_reg_limit'); |
|
992 | + } |
|
993 | + |
|
994 | + |
|
995 | + /** |
|
996 | + * have the tickets sold for this datetime, met or exceed the registration limit ? |
|
997 | + * |
|
998 | + * @return boolean |
|
999 | + * @throws ReflectionException |
|
1000 | + * @throws InvalidArgumentException |
|
1001 | + * @throws InvalidInterfaceException |
|
1002 | + * @throws InvalidDataTypeException |
|
1003 | + * @throws EE_Error |
|
1004 | + */ |
|
1005 | + public function sold_out() |
|
1006 | + { |
|
1007 | + return $this->reg_limit() > 0 && $this->sold() >= $this->reg_limit(); |
|
1008 | + } |
|
1009 | + |
|
1010 | + |
|
1011 | + /** |
|
1012 | + * return the total number of spaces remaining at this venue. |
|
1013 | + * This only takes the venue's capacity into account, NOT the tickets available for sale |
|
1014 | + * |
|
1015 | + * @param bool $consider_tickets Whether to consider tickets remaining when determining if there are any spaces left |
|
1016 | + * Because if all tickets attached to this datetime have no spaces left, |
|
1017 | + * then this datetime IS effectively sold out. |
|
1018 | + * However, there are cases where we just want to know the spaces |
|
1019 | + * remaining for this particular datetime, hence the flag. |
|
1020 | + * @return int |
|
1021 | + * @throws ReflectionException |
|
1022 | + * @throws InvalidArgumentException |
|
1023 | + * @throws InvalidInterfaceException |
|
1024 | + * @throws InvalidDataTypeException |
|
1025 | + * @throws EE_Error |
|
1026 | + */ |
|
1027 | + public function spaces_remaining($consider_tickets = false) |
|
1028 | + { |
|
1029 | + // tickets remaining available for purchase |
|
1030 | + // no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF |
|
1031 | + $dtt_remaining = $this->reg_limit() - $this->sold_and_reserved(); |
|
1032 | + if (! $consider_tickets) { |
|
1033 | + return $dtt_remaining; |
|
1034 | + } |
|
1035 | + $tickets_remaining = $this->tickets_remaining(); |
|
1036 | + return min($dtt_remaining, $tickets_remaining); |
|
1037 | + } |
|
1038 | + |
|
1039 | + |
|
1040 | + /** |
|
1041 | + * Counts the total tickets available |
|
1042 | + * (from all the different types of tickets which are available for this datetime). |
|
1043 | + * |
|
1044 | + * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
1045 | + * @return int |
|
1046 | + * @throws ReflectionException |
|
1047 | + * @throws InvalidArgumentException |
|
1048 | + * @throws InvalidInterfaceException |
|
1049 | + * @throws InvalidDataTypeException |
|
1050 | + * @throws EE_Error |
|
1051 | + */ |
|
1052 | + public function tickets_remaining($query_params = array()) |
|
1053 | + { |
|
1054 | + $sum = 0; |
|
1055 | + $tickets = $this->tickets($query_params); |
|
1056 | + if (! empty($tickets)) { |
|
1057 | + foreach ($tickets as $ticket) { |
|
1058 | + if ($ticket instanceof EE_Ticket) { |
|
1059 | + // get the actual amount of tickets that can be sold |
|
1060 | + $qty = $ticket->qty('saleable'); |
|
1061 | + if ($qty === EE_INF) { |
|
1062 | + return EE_INF; |
|
1063 | + } |
|
1064 | + // no negative ticket quantities plz |
|
1065 | + if ($qty > 0) { |
|
1066 | + $sum += $qty; |
|
1067 | + } |
|
1068 | + } |
|
1069 | + } |
|
1070 | + } |
|
1071 | + return $sum; |
|
1072 | + } |
|
1073 | + |
|
1074 | + |
|
1075 | + /** |
|
1076 | + * Gets the count of all the tickets available at this datetime (not ticket types) |
|
1077 | + * before any were sold |
|
1078 | + * |
|
1079 | + * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
1080 | + * @return int |
|
1081 | + * @throws ReflectionException |
|
1082 | + * @throws InvalidArgumentException |
|
1083 | + * @throws InvalidInterfaceException |
|
1084 | + * @throws InvalidDataTypeException |
|
1085 | + * @throws EE_Error |
|
1086 | + */ |
|
1087 | + public function sum_tickets_initially_available($query_params = array()) |
|
1088 | + { |
|
1089 | + return $this->sum_related('Ticket', $query_params, 'TKT_qty'); |
|
1090 | + } |
|
1091 | + |
|
1092 | + |
|
1093 | + /** |
|
1094 | + * Returns the lesser-of-the two: spaces remaining at this datetime, or |
|
1095 | + * the total tickets remaining (a sum of the tickets remaining for each ticket type |
|
1096 | + * that is available for this datetime). |
|
1097 | + * |
|
1098 | + * @return int |
|
1099 | + * @throws ReflectionException |
|
1100 | + * @throws InvalidArgumentException |
|
1101 | + * @throws InvalidInterfaceException |
|
1102 | + * @throws InvalidDataTypeException |
|
1103 | + * @throws EE_Error |
|
1104 | + */ |
|
1105 | + public function total_tickets_available_at_this_datetime() |
|
1106 | + { |
|
1107 | + return $this->spaces_remaining(true); |
|
1108 | + } |
|
1109 | + |
|
1110 | + |
|
1111 | + /** |
|
1112 | + * This simply compares the internal dtt for the given string with NOW |
|
1113 | + * and determines if the date is upcoming or not. |
|
1114 | + * |
|
1115 | + * @access public |
|
1116 | + * @return boolean |
|
1117 | + * @throws ReflectionException |
|
1118 | + * @throws InvalidArgumentException |
|
1119 | + * @throws InvalidInterfaceException |
|
1120 | + * @throws InvalidDataTypeException |
|
1121 | + * @throws EE_Error |
|
1122 | + */ |
|
1123 | + public function is_upcoming() |
|
1124 | + { |
|
1125 | + return ($this->get_raw('DTT_EVT_start') > time()); |
|
1126 | + } |
|
1127 | + |
|
1128 | + |
|
1129 | + /** |
|
1130 | + * This simply compares the internal datetime for the given string with NOW |
|
1131 | + * and returns if the date is active (i.e. start and end time) |
|
1132 | + * |
|
1133 | + * @return boolean |
|
1134 | + * @throws ReflectionException |
|
1135 | + * @throws InvalidArgumentException |
|
1136 | + * @throws InvalidInterfaceException |
|
1137 | + * @throws InvalidDataTypeException |
|
1138 | + * @throws EE_Error |
|
1139 | + */ |
|
1140 | + public function is_active() |
|
1141 | + { |
|
1142 | + return ($this->get_raw('DTT_EVT_start') < time() && $this->get_raw('DTT_EVT_end') > time()); |
|
1143 | + } |
|
1144 | + |
|
1145 | + |
|
1146 | + /** |
|
1147 | + * This simply compares the internal dtt for the given string with NOW |
|
1148 | + * and determines if the date is expired or not. |
|
1149 | + * |
|
1150 | + * @return boolean |
|
1151 | + * @throws ReflectionException |
|
1152 | + * @throws InvalidArgumentException |
|
1153 | + * @throws InvalidInterfaceException |
|
1154 | + * @throws InvalidDataTypeException |
|
1155 | + * @throws EE_Error |
|
1156 | + */ |
|
1157 | + public function is_expired() |
|
1158 | + { |
|
1159 | + return ($this->get_raw('DTT_EVT_end') < time()); |
|
1160 | + } |
|
1161 | + |
|
1162 | + |
|
1163 | + /** |
|
1164 | + * This returns the active status for whether an event is active, upcoming, or expired |
|
1165 | + * |
|
1166 | + * @return int return value will be one of the EE_Datetime status constants. |
|
1167 | + * @throws ReflectionException |
|
1168 | + * @throws InvalidArgumentException |
|
1169 | + * @throws InvalidInterfaceException |
|
1170 | + * @throws InvalidDataTypeException |
|
1171 | + * @throws EE_Error |
|
1172 | + */ |
|
1173 | + public function get_active_status() |
|
1174 | + { |
|
1175 | + $total_tickets_for_this_dtt = $this->total_tickets_available_at_this_datetime(); |
|
1176 | + if ($total_tickets_for_this_dtt !== false && $total_tickets_for_this_dtt < 1) { |
|
1177 | + return EE_Datetime::sold_out; |
|
1178 | + } |
|
1179 | + if ($this->is_expired()) { |
|
1180 | + return EE_Datetime::expired; |
|
1181 | + } |
|
1182 | + if ($this->is_upcoming()) { |
|
1183 | + return EE_Datetime::upcoming; |
|
1184 | + } |
|
1185 | + if ($this->is_active()) { |
|
1186 | + return EE_Datetime::active; |
|
1187 | + } |
|
1188 | + return null; |
|
1189 | + } |
|
1190 | + |
|
1191 | + |
|
1192 | + /** |
|
1193 | + * This returns a nice display name for the datetime that is contingent on the span between the dates and times. |
|
1194 | + * |
|
1195 | + * @param boolean $use_dtt_name if TRUE then we'll use DTT->name() if its not empty. |
|
1196 | + * @return string |
|
1197 | + * @throws ReflectionException |
|
1198 | + * @throws InvalidArgumentException |
|
1199 | + * @throws InvalidInterfaceException |
|
1200 | + * @throws InvalidDataTypeException |
|
1201 | + * @throws EE_Error |
|
1202 | + */ |
|
1203 | + public function get_dtt_display_name($use_dtt_name = false) |
|
1204 | + { |
|
1205 | + if ($use_dtt_name) { |
|
1206 | + $dtt_name = $this->name(); |
|
1207 | + if (! empty($dtt_name)) { |
|
1208 | + return $dtt_name; |
|
1209 | + } |
|
1210 | + } |
|
1211 | + // first condition is to see if the months are different |
|
1212 | + if (date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end')) |
|
1213 | + ) { |
|
1214 | + $display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a'); |
|
1215 | + // next condition is if its the same month but different day |
|
1216 | + } else { |
|
1217 | + if (date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end')) |
|
1218 | + && date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end')) |
|
1219 | + ) { |
|
1220 | + $display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y'); |
|
1221 | + } else { |
|
1222 | + $display_date = $this->start_date('F j\, Y') |
|
1223 | + . ' @ ' |
|
1224 | + . $this->start_date('g:i a') |
|
1225 | + . ' - ' |
|
1226 | + . $this->end_date('g:i a'); |
|
1227 | + } |
|
1228 | + } |
|
1229 | + return $display_date; |
|
1230 | + } |
|
1231 | + |
|
1232 | + |
|
1233 | + /** |
|
1234 | + * Gets all the tickets for this datetime |
|
1235 | + * |
|
1236 | + * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
1237 | + * @return EE_Base_Class[]|EE_Ticket[] |
|
1238 | + * @throws ReflectionException |
|
1239 | + * @throws InvalidArgumentException |
|
1240 | + * @throws InvalidInterfaceException |
|
1241 | + * @throws InvalidDataTypeException |
|
1242 | + * @throws EE_Error |
|
1243 | + */ |
|
1244 | + public function tickets($query_params = array()) |
|
1245 | + { |
|
1246 | + return $this->get_many_related('Ticket', $query_params); |
|
1247 | + } |
|
1248 | + |
|
1249 | + |
|
1250 | + /** |
|
1251 | + * Gets all the ticket types currently available for purchase |
|
1252 | + * |
|
1253 | + * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
1254 | + * @return EE_Ticket[] |
|
1255 | + * @throws ReflectionException |
|
1256 | + * @throws InvalidArgumentException |
|
1257 | + * @throws InvalidInterfaceException |
|
1258 | + * @throws InvalidDataTypeException |
|
1259 | + * @throws EE_Error |
|
1260 | + */ |
|
1261 | + public function ticket_types_available_for_purchase($query_params = array()) |
|
1262 | + { |
|
1263 | + // first check if datetime is valid |
|
1264 | + if ($this->sold_out() || ! ($this->is_upcoming() || $this->is_active())) { |
|
1265 | + return array(); |
|
1266 | + } |
|
1267 | + if (empty($query_params)) { |
|
1268 | + $query_params = array( |
|
1269 | + array( |
|
1270 | + 'TKT_start_date' => array('<=', EEM_Ticket::instance()->current_time_for_query('TKT_start_date')), |
|
1271 | + 'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')), |
|
1272 | + 'TKT_deleted' => false, |
|
1273 | + ), |
|
1274 | + ); |
|
1275 | + } |
|
1276 | + return $this->tickets($query_params); |
|
1277 | + } |
|
1278 | + |
|
1279 | + |
|
1280 | + /** |
|
1281 | + * @return EE_Base_Class|EE_Event |
|
1282 | + * @throws ReflectionException |
|
1283 | + * @throws InvalidArgumentException |
|
1284 | + * @throws InvalidInterfaceException |
|
1285 | + * @throws InvalidDataTypeException |
|
1286 | + * @throws EE_Error |
|
1287 | + */ |
|
1288 | + public function event() |
|
1289 | + { |
|
1290 | + return $this->get_first_related('Event'); |
|
1291 | + } |
|
1292 | + |
|
1293 | + |
|
1294 | + /** |
|
1295 | + * Updates the DTT_sold attribute (and saves) based on the number of registrations for this datetime |
|
1296 | + * (via the tickets). |
|
1297 | + * |
|
1298 | + * @return int |
|
1299 | + * @throws ReflectionException |
|
1300 | + * @throws InvalidArgumentException |
|
1301 | + * @throws InvalidInterfaceException |
|
1302 | + * @throws InvalidDataTypeException |
|
1303 | + * @throws EE_Error |
|
1304 | + */ |
|
1305 | + public function update_sold() |
|
1306 | + { |
|
1307 | + $count_regs_for_this_datetime = EEM_Registration::instance()->count( |
|
1308 | + array( |
|
1309 | + array( |
|
1310 | + 'STS_ID' => EEM_Registration::status_id_approved, |
|
1311 | + 'REG_deleted' => 0, |
|
1312 | + 'Ticket.Datetime.DTT_ID' => $this->ID(), |
|
1313 | + ), |
|
1314 | + ) |
|
1315 | + ); |
|
1316 | + $this->set_sold($count_regs_for_this_datetime); |
|
1317 | + $this->save(); |
|
1318 | + return $count_regs_for_this_datetime; |
|
1319 | + } |
|
1320 | + |
|
1321 | + |
|
1322 | + /******************************************************************* |
|
1323 | 1323 | *********************** DEPRECATED METHODS ********************** |
1324 | 1324 | *******************************************************************/ |
1325 | 1325 | |
1326 | 1326 | |
1327 | - /** |
|
1328 | - * Increments sold by amount passed by $qty, and persists it immediately to the database. |
|
1329 | - * |
|
1330 | - * @deprecated 4.9.80.p |
|
1331 | - * @param int $qty |
|
1332 | - * @return boolean |
|
1333 | - * @throws ReflectionException |
|
1334 | - * @throws InvalidArgumentException |
|
1335 | - * @throws InvalidInterfaceException |
|
1336 | - * @throws InvalidDataTypeException |
|
1337 | - * @throws EE_Error |
|
1338 | - */ |
|
1339 | - public function increase_sold($qty = 1) |
|
1340 | - { |
|
1341 | - EE_Error::doing_it_wrong( |
|
1342 | - __FUNCTION__, |
|
1343 | - esc_html__('Please use EE_Datetime::increaseSold() instead', 'event_espresso'), |
|
1344 | - '4.9.80.p', |
|
1345 | - '5.0.0.p' |
|
1346 | - ); |
|
1347 | - return $this->increaseSold($qty); |
|
1348 | - } |
|
1349 | - |
|
1350 | - |
|
1351 | - /** |
|
1352 | - * Decrements (subtracts) sold amount passed by $qty directly in the DB and on the model object. (Ie, no need |
|
1353 | - * to save afterwards.) |
|
1354 | - * |
|
1355 | - * @deprecated 4.9.80.p |
|
1356 | - * @param int $qty |
|
1357 | - * @return boolean |
|
1358 | - * @throws ReflectionException |
|
1359 | - * @throws InvalidArgumentException |
|
1360 | - * @throws InvalidInterfaceException |
|
1361 | - * @throws InvalidDataTypeException |
|
1362 | - * @throws EE_Error |
|
1363 | - */ |
|
1364 | - public function decrease_sold($qty = 1) |
|
1365 | - { |
|
1366 | - EE_Error::doing_it_wrong( |
|
1367 | - __FUNCTION__, |
|
1368 | - esc_html__('Please use EE_Datetime::decreaseSold() instead', 'event_espresso'), |
|
1369 | - '4.9.80.p', |
|
1370 | - '5.0.0.p' |
|
1371 | - ); |
|
1372 | - return $this->decreaseSold($qty); |
|
1373 | - } |
|
1374 | - |
|
1375 | - |
|
1376 | - /** |
|
1377 | - * Increments reserved by amount passed by $qty, and persists it immediately to the database. |
|
1378 | - * |
|
1379 | - * @deprecated 4.9.80.p |
|
1380 | - * @param int $qty |
|
1381 | - * @return boolean indicating success |
|
1382 | - * @throws ReflectionException |
|
1383 | - * @throws InvalidArgumentException |
|
1384 | - * @throws InvalidInterfaceException |
|
1385 | - * @throws InvalidDataTypeException |
|
1386 | - * @throws EE_Error |
|
1387 | - */ |
|
1388 | - public function increase_reserved($qty = 1) |
|
1389 | - { |
|
1390 | - EE_Error::doing_it_wrong( |
|
1391 | - __FUNCTION__, |
|
1392 | - esc_html__('Please use EE_Datetime::increaseReserved() instead', 'event_espresso'), |
|
1393 | - '4.9.80.p', |
|
1394 | - '5.0.0.p' |
|
1395 | - ); |
|
1396 | - return $this->increaseReserved($qty); |
|
1397 | - } |
|
1398 | - |
|
1399 | - |
|
1400 | - /** |
|
1401 | - * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database. |
|
1402 | - * |
|
1403 | - * @deprecated 4.9.80.p |
|
1404 | - * @param int $qty |
|
1405 | - * @return boolean |
|
1406 | - * @throws ReflectionException |
|
1407 | - * @throws InvalidArgumentException |
|
1408 | - * @throws InvalidInterfaceException |
|
1409 | - * @throws InvalidDataTypeException |
|
1410 | - * @throws EE_Error |
|
1411 | - */ |
|
1412 | - public function decrease_reserved($qty = 1) |
|
1413 | - { |
|
1414 | - EE_Error::doing_it_wrong( |
|
1415 | - __FUNCTION__, |
|
1416 | - esc_html__('Please use EE_Datetime::decreaseReserved() instead', 'event_espresso'), |
|
1417 | - '4.9.80.p', |
|
1418 | - '5.0.0.p' |
|
1419 | - ); |
|
1420 | - return $this->decreaseReserved($qty); |
|
1421 | - } |
|
1327 | + /** |
|
1328 | + * Increments sold by amount passed by $qty, and persists it immediately to the database. |
|
1329 | + * |
|
1330 | + * @deprecated 4.9.80.p |
|
1331 | + * @param int $qty |
|
1332 | + * @return boolean |
|
1333 | + * @throws ReflectionException |
|
1334 | + * @throws InvalidArgumentException |
|
1335 | + * @throws InvalidInterfaceException |
|
1336 | + * @throws InvalidDataTypeException |
|
1337 | + * @throws EE_Error |
|
1338 | + */ |
|
1339 | + public function increase_sold($qty = 1) |
|
1340 | + { |
|
1341 | + EE_Error::doing_it_wrong( |
|
1342 | + __FUNCTION__, |
|
1343 | + esc_html__('Please use EE_Datetime::increaseSold() instead', 'event_espresso'), |
|
1344 | + '4.9.80.p', |
|
1345 | + '5.0.0.p' |
|
1346 | + ); |
|
1347 | + return $this->increaseSold($qty); |
|
1348 | + } |
|
1349 | + |
|
1350 | + |
|
1351 | + /** |
|
1352 | + * Decrements (subtracts) sold amount passed by $qty directly in the DB and on the model object. (Ie, no need |
|
1353 | + * to save afterwards.) |
|
1354 | + * |
|
1355 | + * @deprecated 4.9.80.p |
|
1356 | + * @param int $qty |
|
1357 | + * @return boolean |
|
1358 | + * @throws ReflectionException |
|
1359 | + * @throws InvalidArgumentException |
|
1360 | + * @throws InvalidInterfaceException |
|
1361 | + * @throws InvalidDataTypeException |
|
1362 | + * @throws EE_Error |
|
1363 | + */ |
|
1364 | + public function decrease_sold($qty = 1) |
|
1365 | + { |
|
1366 | + EE_Error::doing_it_wrong( |
|
1367 | + __FUNCTION__, |
|
1368 | + esc_html__('Please use EE_Datetime::decreaseSold() instead', 'event_espresso'), |
|
1369 | + '4.9.80.p', |
|
1370 | + '5.0.0.p' |
|
1371 | + ); |
|
1372 | + return $this->decreaseSold($qty); |
|
1373 | + } |
|
1374 | + |
|
1375 | + |
|
1376 | + /** |
|
1377 | + * Increments reserved by amount passed by $qty, and persists it immediately to the database. |
|
1378 | + * |
|
1379 | + * @deprecated 4.9.80.p |
|
1380 | + * @param int $qty |
|
1381 | + * @return boolean indicating success |
|
1382 | + * @throws ReflectionException |
|
1383 | + * @throws InvalidArgumentException |
|
1384 | + * @throws InvalidInterfaceException |
|
1385 | + * @throws InvalidDataTypeException |
|
1386 | + * @throws EE_Error |
|
1387 | + */ |
|
1388 | + public function increase_reserved($qty = 1) |
|
1389 | + { |
|
1390 | + EE_Error::doing_it_wrong( |
|
1391 | + __FUNCTION__, |
|
1392 | + esc_html__('Please use EE_Datetime::increaseReserved() instead', 'event_espresso'), |
|
1393 | + '4.9.80.p', |
|
1394 | + '5.0.0.p' |
|
1395 | + ); |
|
1396 | + return $this->increaseReserved($qty); |
|
1397 | + } |
|
1398 | + |
|
1399 | + |
|
1400 | + /** |
|
1401 | + * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database. |
|
1402 | + * |
|
1403 | + * @deprecated 4.9.80.p |
|
1404 | + * @param int $qty |
|
1405 | + * @return boolean |
|
1406 | + * @throws ReflectionException |
|
1407 | + * @throws InvalidArgumentException |
|
1408 | + * @throws InvalidInterfaceException |
|
1409 | + * @throws InvalidDataTypeException |
|
1410 | + * @throws EE_Error |
|
1411 | + */ |
|
1412 | + public function decrease_reserved($qty = 1) |
|
1413 | + { |
|
1414 | + EE_Error::doing_it_wrong( |
|
1415 | + __FUNCTION__, |
|
1416 | + esc_html__('Please use EE_Datetime::decreaseReserved() instead', 'event_espresso'), |
|
1417 | + '4.9.80.p', |
|
1418 | + '5.0.0.p' |
|
1419 | + ); |
|
1420 | + return $this->decreaseReserved($qty); |
|
1421 | + } |
|
1422 | 1422 | } |
@@ -459,7 +459,7 @@ discard block |
||
459 | 459 | * with construction finalize being called later |
460 | 460 | * (realizing that the subsections' html names |
461 | 461 | * might not be set yet, etc.) |
462 | - * @return EE_Form_Section_Base |
|
462 | + * @return EE_Form_Section_Validatable|null |
|
463 | 463 | * @throws EE_Error |
464 | 464 | */ |
465 | 465 | public function get_subsection($name, $require_construction_to_be_finalized = true) |
@@ -1289,7 +1289,6 @@ discard block |
||
1289 | 1289 | /** |
1290 | 1290 | * Sets the submission error message (aka validation error message for this form section and all sub-sections) |
1291 | 1291 | * @param string $form_submission_error_message |
1292 | - * @param EE_Form_Section_Validatable $form_section unused |
|
1293 | 1292 | * @throws EE_Error |
1294 | 1293 | */ |
1295 | 1294 | public function set_submission_error_message( |
@@ -14,1528 +14,1528 @@ |
||
14 | 14 | class EE_Form_Section_Proper extends EE_Form_Section_Validatable |
15 | 15 | { |
16 | 16 | |
17 | - const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data'; |
|
18 | - |
|
19 | - /** |
|
20 | - * Subsections |
|
21 | - * |
|
22 | - * @var EE_Form_Section_Validatable[] |
|
23 | - */ |
|
24 | - protected $_subsections = array(); |
|
25 | - |
|
26 | - /** |
|
27 | - * Strategy for laying out the form |
|
28 | - * |
|
29 | - * @var EE_Form_Section_Layout_Base |
|
30 | - */ |
|
31 | - protected $_layout_strategy; |
|
32 | - |
|
33 | - /** |
|
34 | - * Whether or not this form has received and validated a form submission yet |
|
35 | - * |
|
36 | - * @var boolean |
|
37 | - */ |
|
38 | - protected $_received_submission = false; |
|
39 | - |
|
40 | - /** |
|
41 | - * message displayed to users upon successful form submission |
|
42 | - * |
|
43 | - * @var string |
|
44 | - */ |
|
45 | - protected $_form_submission_success_message = ''; |
|
46 | - |
|
47 | - /** |
|
48 | - * message displayed to users upon unsuccessful form submission |
|
49 | - * |
|
50 | - * @var string |
|
51 | - */ |
|
52 | - protected $_form_submission_error_message = ''; |
|
53 | - |
|
54 | - /** |
|
55 | - * @var array like $_REQUEST |
|
56 | - */ |
|
57 | - protected $cached_request_data; |
|
58 | - |
|
59 | - /** |
|
60 | - * Stores whether this form (and its sub-sections) were found to be valid or not. |
|
61 | - * Starts off as null, but once the form is validated, it set to either true or false |
|
62 | - * @var boolean|null |
|
63 | - */ |
|
64 | - protected $is_valid; |
|
65 | - |
|
66 | - /** |
|
67 | - * Stores all the data that will localized for form validation |
|
68 | - * |
|
69 | - * @var array |
|
70 | - */ |
|
71 | - static protected $_js_localization = array(); |
|
72 | - |
|
73 | - /** |
|
74 | - * whether or not the form's localized validation JS vars have been set |
|
75 | - * |
|
76 | - * @type boolean |
|
77 | - */ |
|
78 | - static protected $_scripts_localized = false; |
|
79 | - |
|
80 | - |
|
81 | - /** |
|
82 | - * when constructing a proper form section, calls _construct_finalize on children |
|
83 | - * so that they know who their parent is, and what name they've been given. |
|
84 | - * |
|
85 | - * @param array[] $options_array { |
|
86 | - * @type $subsections EE_Form_Section_Validatable[] where keys are the section's name |
|
87 | - * @type $include string[] numerically-indexed where values are section names to be included, |
|
88 | - * and in that order. This is handy if you want |
|
89 | - * the subsections to be ordered differently than the default, and if you override |
|
90 | - * which fields are shown |
|
91 | - * @type $exclude string[] values are subsections to be excluded. This is handy if you want |
|
92 | - * to remove certain default subsections (note: if you specify BOTH 'include' AND |
|
93 | - * 'exclude', the inclusions will be applied first, and the exclusions will exclude |
|
94 | - * items from that list of inclusions) |
|
95 | - * @type $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form |
|
96 | - * } @see EE_Form_Section_Validatable::__construct() |
|
97 | - * @throws EE_Error |
|
98 | - */ |
|
99 | - public function __construct($options_array = array()) |
|
100 | - { |
|
101 | - $options_array = (array) apply_filters( |
|
102 | - 'FHEE__EE_Form_Section_Proper___construct__options_array', |
|
103 | - $options_array, |
|
104 | - $this |
|
105 | - ); |
|
106 | - // call parent first, as it may be setting the name |
|
107 | - parent::__construct($options_array); |
|
108 | - // if they've included subsections in the constructor, add them now |
|
109 | - if (isset($options_array['include'])) { |
|
110 | - // we are going to make sure we ONLY have those subsections to include |
|
111 | - // AND we are going to make sure they're in that specified order |
|
112 | - $reordered_subsections = array(); |
|
113 | - foreach ($options_array['include'] as $input_name) { |
|
114 | - if (isset($this->_subsections[ $input_name ])) { |
|
115 | - $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ]; |
|
116 | - } |
|
117 | - } |
|
118 | - $this->_subsections = $reordered_subsections; |
|
119 | - } |
|
120 | - if (isset($options_array['exclude'])) { |
|
121 | - $exclude = $options_array['exclude']; |
|
122 | - $this->_subsections = array_diff_key($this->_subsections, array_flip($exclude)); |
|
123 | - } |
|
124 | - if (isset($options_array['layout_strategy'])) { |
|
125 | - $this->_layout_strategy = $options_array['layout_strategy']; |
|
126 | - } |
|
127 | - if (! $this->_layout_strategy) { |
|
128 | - $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout(); |
|
129 | - } |
|
130 | - $this->_layout_strategy->_construct_finalize($this); |
|
131 | - // ok so we are definitely going to want the forms JS, |
|
132 | - // so enqueue it or remember to enqueue it during wp_enqueue_scripts |
|
133 | - if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) { |
|
134 | - // ok so they've constructed this object after when they should have. |
|
135 | - // just enqueue the generic form scripts and initialize the form immediately in the JS |
|
136 | - EE_Form_Section_Proper::wp_enqueue_scripts(true); |
|
137 | - } else { |
|
138 | - add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts')); |
|
139 | - add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts')); |
|
140 | - } |
|
141 | - add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1); |
|
142 | - /** |
|
143 | - * Gives other plugins a chance to hook in before construct finalize is called. |
|
144 | - * The form probably doesn't yet have a parent form section. |
|
145 | - * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form, |
|
146 | - * assuming you don't care what the form section's name, HTML ID, or HTML name etc are. |
|
147 | - * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end |
|
148 | - * |
|
149 | - * @since 4.9.32 |
|
150 | - * @param EE_Form_Section_Proper $this before __construct is done, but all of its logic, |
|
151 | - * except maybe calling _construct_finalize has been done |
|
152 | - * @param array $options_array options passed into the constructor |
|
153 | - */ |
|
154 | - do_action( |
|
155 | - 'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called', |
|
156 | - $this, |
|
157 | - $options_array |
|
158 | - ); |
|
159 | - if (isset($options_array['name'])) { |
|
160 | - $this->_construct_finalize(null, $options_array['name']); |
|
161 | - } |
|
162 | - } |
|
163 | - |
|
164 | - |
|
165 | - /** |
|
166 | - * Finishes construction given the parent form section and this form section's name |
|
167 | - * |
|
168 | - * @param EE_Form_Section_Proper $parent_form_section |
|
169 | - * @param string $name |
|
170 | - * @throws EE_Error |
|
171 | - */ |
|
172 | - public function _construct_finalize($parent_form_section, $name) |
|
173 | - { |
|
174 | - parent::_construct_finalize($parent_form_section, $name); |
|
175 | - $this->_set_default_name_if_empty(); |
|
176 | - $this->_set_default_html_id_if_empty(); |
|
177 | - foreach ($this->_subsections as $subsection_name => $subsection) { |
|
178 | - if ($subsection instanceof EE_Form_Section_Base) { |
|
179 | - $subsection->_construct_finalize($this, $subsection_name); |
|
180 | - } else { |
|
181 | - throw new EE_Error( |
|
182 | - sprintf( |
|
183 | - esc_html__( |
|
184 | - 'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"', |
|
185 | - 'event_espresso' |
|
186 | - ), |
|
187 | - $subsection_name, |
|
188 | - get_class($this), |
|
189 | - $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso') |
|
190 | - ) |
|
191 | - ); |
|
192 | - } |
|
193 | - } |
|
194 | - /** |
|
195 | - * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed. |
|
196 | - * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID |
|
197 | - * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done. |
|
198 | - * This might only happen just before displaying the form, or just before it receives form submission data. |
|
199 | - * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've |
|
200 | - * ensured it has a name, HTML IDs, etc |
|
201 | - * |
|
202 | - * @param EE_Form_Section_Proper $this |
|
203 | - * @param EE_Form_Section_Proper|null $parent_form_section |
|
204 | - * @param string $name |
|
205 | - */ |
|
206 | - do_action( |
|
207 | - 'AHEE__EE_Form_Section_Proper___construct_finalize__end', |
|
208 | - $this, |
|
209 | - $parent_form_section, |
|
210 | - $name |
|
211 | - ); |
|
212 | - } |
|
213 | - |
|
214 | - |
|
215 | - /** |
|
216 | - * Gets the layout strategy for this form section |
|
217 | - * |
|
218 | - * @return EE_Form_Section_Layout_Base |
|
219 | - */ |
|
220 | - public function get_layout_strategy() |
|
221 | - { |
|
222 | - return $this->_layout_strategy; |
|
223 | - } |
|
224 | - |
|
225 | - |
|
226 | - /** |
|
227 | - * Gets the HTML for a single input for this form section according |
|
228 | - * to the layout strategy |
|
229 | - * |
|
230 | - * @param EE_Form_Input_Base $input |
|
231 | - * @return string |
|
232 | - */ |
|
233 | - public function get_html_for_input($input) |
|
234 | - { |
|
235 | - return $this->_layout_strategy->layout_input($input); |
|
236 | - } |
|
237 | - |
|
238 | - |
|
239 | - /** |
|
240 | - * was_submitted - checks if form inputs are present in request data |
|
241 | - * Basically an alias for form_data_present_in() (which is used by both |
|
242 | - * proper form sections and form inputs) |
|
243 | - * |
|
244 | - * @param null $form_data |
|
245 | - * @return boolean |
|
246 | - * @throws EE_Error |
|
247 | - */ |
|
248 | - public function was_submitted($form_data = null) |
|
249 | - { |
|
250 | - return $this->form_data_present_in($form_data); |
|
251 | - } |
|
252 | - |
|
253 | - /** |
|
254 | - * Gets the cached request data; but if there is none, or $req_data was set with |
|
255 | - * something different, refresh the cache, and then return it |
|
256 | - * @param null $req_data |
|
257 | - * @return array |
|
258 | - */ |
|
259 | - protected function getCachedRequest($req_data = null) |
|
260 | - { |
|
261 | - if ($this->cached_request_data === null |
|
262 | - || ( |
|
263 | - $req_data !== null && |
|
264 | - $req_data !== $this->cached_request_data |
|
265 | - ) |
|
266 | - ) { |
|
267 | - $req_data = apply_filters( |
|
268 | - 'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', |
|
269 | - $req_data, |
|
270 | - $this |
|
271 | - ); |
|
272 | - if ($req_data === null) { |
|
273 | - $req_data = array_merge($_GET, $_POST); |
|
274 | - } |
|
275 | - $req_data = apply_filters( |
|
276 | - 'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data', |
|
277 | - $req_data, |
|
278 | - $this |
|
279 | - ); |
|
280 | - $this->cached_request_data = (array) $req_data; |
|
281 | - } |
|
282 | - return $this->cached_request_data; |
|
283 | - } |
|
284 | - |
|
285 | - |
|
286 | - /** |
|
287 | - * After the form section is initially created, call this to sanitize the data in the submission |
|
288 | - * which relates to this form section, validate it, and set it as properties on the form. |
|
289 | - * |
|
290 | - * @param array|null $req_data should usually be $_POST (the default). |
|
291 | - * However, you CAN supply a different array. |
|
292 | - * Consider using set_defaults() instead however. |
|
293 | - * (If you rendered the form in the page using echo $form_x->get_html() |
|
294 | - * the inputs will have the correct name in the request data for this function |
|
295 | - * to find them and populate the form with them. |
|
296 | - * If you have a flat form (with only input subsections), |
|
297 | - * you can supply a flat array where keys |
|
298 | - * are the form input names and values are their values) |
|
299 | - * @param boolean $validate whether or not to perform validation on this data. Default is, |
|
300 | - * of course, to validate that data, and set errors on the invalid values. |
|
301 | - * But if the data has already been validated |
|
302 | - * (eg you validated the data then stored it in the DB) |
|
303 | - * you may want to skip this step. |
|
304 | - * @throws InvalidArgumentException |
|
305 | - * @throws InvalidInterfaceException |
|
306 | - * @throws InvalidDataTypeException |
|
307 | - * @throws EE_Error |
|
308 | - */ |
|
309 | - public function receive_form_submission($req_data = null, $validate = true) |
|
310 | - { |
|
311 | - $req_data = $this->getCachedRequest($req_data); |
|
312 | - $this->_normalize($req_data); |
|
313 | - if ($validate) { |
|
314 | - $this->_validate(); |
|
315 | - // if it's invalid, we're going to want to re-display so remember what they submitted |
|
316 | - if (! $this->is_valid()) { |
|
317 | - $this->store_submitted_form_data_in_session(); |
|
318 | - } |
|
319 | - } |
|
320 | - if ($this->submission_error_message() === '' && ! $this->is_valid()) { |
|
321 | - $this->set_submission_error_message(); |
|
322 | - } |
|
323 | - do_action( |
|
324 | - 'AHEE__EE_Form_Section_Proper__receive_form_submission__end', |
|
325 | - $req_data, |
|
326 | - $this, |
|
327 | - $validate |
|
328 | - ); |
|
329 | - } |
|
330 | - |
|
331 | - |
|
332 | - /** |
|
333 | - * caches the originally submitted input values in the session |
|
334 | - * so that they can be used to repopulate the form if it failed validation |
|
335 | - * |
|
336 | - * @return boolean whether or not the data was successfully stored in the session |
|
337 | - * @throws InvalidArgumentException |
|
338 | - * @throws InvalidInterfaceException |
|
339 | - * @throws InvalidDataTypeException |
|
340 | - * @throws EE_Error |
|
341 | - */ |
|
342 | - protected function store_submitted_form_data_in_session() |
|
343 | - { |
|
344 | - return EE_Registry::instance()->SSN->set_session_data( |
|
345 | - array( |
|
346 | - EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true), |
|
347 | - ) |
|
348 | - ); |
|
349 | - } |
|
350 | - |
|
351 | - |
|
352 | - /** |
|
353 | - * retrieves the originally submitted input values in the session |
|
354 | - * so that they can be used to repopulate the form if it failed validation |
|
355 | - * |
|
356 | - * @return array |
|
357 | - * @throws InvalidArgumentException |
|
358 | - * @throws InvalidInterfaceException |
|
359 | - * @throws InvalidDataTypeException |
|
360 | - */ |
|
361 | - protected function get_submitted_form_data_from_session() |
|
362 | - { |
|
363 | - $session = EE_Registry::instance()->SSN; |
|
364 | - if ($session instanceof EE_Session) { |
|
365 | - return $session->get_session_data( |
|
366 | - EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY |
|
367 | - ); |
|
368 | - } |
|
369 | - return array(); |
|
370 | - } |
|
371 | - |
|
372 | - |
|
373 | - /** |
|
374 | - * flushed the originally submitted input values from the session |
|
375 | - * |
|
376 | - * @return boolean whether or not the data was successfully removed from the session |
|
377 | - * @throws InvalidArgumentException |
|
378 | - * @throws InvalidInterfaceException |
|
379 | - * @throws InvalidDataTypeException |
|
380 | - */ |
|
381 | - public static function flush_submitted_form_data_from_session() |
|
382 | - { |
|
383 | - return EE_Registry::instance()->SSN->reset_data( |
|
384 | - array(EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY) |
|
385 | - ); |
|
386 | - } |
|
387 | - |
|
388 | - |
|
389 | - /** |
|
390 | - * Populates this form and its subsections with data from the session. |
|
391 | - * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows |
|
392 | - * validation errors when displaying too) |
|
393 | - * Returns true if the form was populated from the session, false otherwise |
|
394 | - * |
|
395 | - * @return boolean |
|
396 | - * @throws InvalidArgumentException |
|
397 | - * @throws InvalidInterfaceException |
|
398 | - * @throws InvalidDataTypeException |
|
399 | - * @throws EE_Error |
|
400 | - */ |
|
401 | - public function populate_from_session() |
|
402 | - { |
|
403 | - $form_data_in_session = $this->get_submitted_form_data_from_session(); |
|
404 | - if (empty($form_data_in_session)) { |
|
405 | - return false; |
|
406 | - } |
|
407 | - $this->receive_form_submission($form_data_in_session); |
|
408 | - add_action('shutdown', array('EE_Form_Section_Proper', 'flush_submitted_form_data_from_session')); |
|
409 | - if ($this->form_data_present_in($form_data_in_session)) { |
|
410 | - return true; |
|
411 | - } |
|
412 | - return false; |
|
413 | - } |
|
414 | - |
|
415 | - |
|
416 | - /** |
|
417 | - * Populates the default data for the form, given an array where keys are |
|
418 | - * the input names, and values are their values (preferably normalized to be their |
|
419 | - * proper PHP types, not all strings... although that should be ok too). |
|
420 | - * Proper subsections are sub-arrays, the key being the subsection's name, and |
|
421 | - * the value being an array formatted in teh same way |
|
422 | - * |
|
423 | - * @param array $default_data |
|
424 | - * @throws EE_Error |
|
425 | - */ |
|
426 | - public function populate_defaults($default_data) |
|
427 | - { |
|
428 | - foreach ($this->subsections(false) as $subsection_name => $subsection) { |
|
429 | - if (isset($default_data[ $subsection_name ])) { |
|
430 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
431 | - $subsection->set_default($default_data[ $subsection_name ]); |
|
432 | - } elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
433 | - $subsection->populate_defaults($default_data[ $subsection_name ]); |
|
434 | - } |
|
435 | - } |
|
436 | - } |
|
437 | - } |
|
438 | - |
|
439 | - |
|
440 | - /** |
|
441 | - * returns true if subsection exists |
|
442 | - * |
|
443 | - * @param string $name |
|
444 | - * @return boolean |
|
445 | - */ |
|
446 | - public function subsection_exists($name) |
|
447 | - { |
|
448 | - return isset($this->_subsections[ $name ]) ? true : false; |
|
449 | - } |
|
450 | - |
|
451 | - |
|
452 | - /** |
|
453 | - * Gets the subsection specified by its name |
|
454 | - * |
|
455 | - * @param string $name |
|
456 | - * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE |
|
457 | - * so that the inputs will be properly configured. |
|
458 | - * However, some client code may be ok |
|
459 | - * with construction finalize being called later |
|
460 | - * (realizing that the subsections' html names |
|
461 | - * might not be set yet, etc.) |
|
462 | - * @return EE_Form_Section_Base |
|
463 | - * @throws EE_Error |
|
464 | - */ |
|
465 | - public function get_subsection($name, $require_construction_to_be_finalized = true) |
|
466 | - { |
|
467 | - if ($require_construction_to_be_finalized) { |
|
468 | - $this->ensure_construct_finalized_called(); |
|
469 | - } |
|
470 | - return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null; |
|
471 | - } |
|
472 | - |
|
473 | - |
|
474 | - /** |
|
475 | - * Gets all the validatable subsections of this form section |
|
476 | - * |
|
477 | - * @return EE_Form_Section_Validatable[] |
|
478 | - * @throws EE_Error |
|
479 | - */ |
|
480 | - public function get_validatable_subsections() |
|
481 | - { |
|
482 | - $validatable_subsections = array(); |
|
483 | - foreach ($this->subsections() as $name => $obj) { |
|
484 | - if ($obj instanceof EE_Form_Section_Validatable) { |
|
485 | - $validatable_subsections[ $name ] = $obj; |
|
486 | - } |
|
487 | - } |
|
488 | - return $validatable_subsections; |
|
489 | - } |
|
490 | - |
|
491 | - |
|
492 | - /** |
|
493 | - * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child, |
|
494 | - * throw an EE_Error. |
|
495 | - * |
|
496 | - * @param string $name |
|
497 | - * @param boolean $require_construction_to_be_finalized most client code should |
|
498 | - * leave this as TRUE so that the inputs will be properly |
|
499 | - * configured. However, some client code may be ok with |
|
500 | - * construction finalize being called later |
|
501 | - * (realizing that the subsections' html names might not be |
|
502 | - * set yet, etc.) |
|
503 | - * @return EE_Form_Input_Base |
|
504 | - * @throws EE_Error |
|
505 | - */ |
|
506 | - public function get_input($name, $require_construction_to_be_finalized = true) |
|
507 | - { |
|
508 | - $subsection = $this->get_subsection( |
|
509 | - $name, |
|
510 | - $require_construction_to_be_finalized |
|
511 | - ); |
|
512 | - if (! $subsection instanceof EE_Form_Input_Base) { |
|
513 | - throw new EE_Error( |
|
514 | - sprintf( |
|
515 | - esc_html__( |
|
516 | - "Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'", |
|
517 | - 'event_espresso' |
|
518 | - ), |
|
519 | - $name, |
|
520 | - get_class($this), |
|
521 | - $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso') |
|
522 | - ) |
|
523 | - ); |
|
524 | - } |
|
525 | - return $subsection; |
|
526 | - } |
|
527 | - |
|
528 | - |
|
529 | - /** |
|
530 | - * Like get_input(), gets the proper subsection of the form given the name, |
|
531 | - * otherwise throws an EE_Error |
|
532 | - * |
|
533 | - * @param string $name |
|
534 | - * @param boolean $require_construction_to_be_finalized most client code should |
|
535 | - * leave this as TRUE so that the inputs will be properly |
|
536 | - * configured. However, some client code may be ok with |
|
537 | - * construction finalize being called later |
|
538 | - * (realizing that the subsections' html names might not be |
|
539 | - * set yet, etc.) |
|
540 | - * @return EE_Form_Section_Proper |
|
541 | - * @throws EE_Error |
|
542 | - */ |
|
543 | - public function get_proper_subsection($name, $require_construction_to_be_finalized = true) |
|
544 | - { |
|
545 | - $subsection = $this->get_subsection( |
|
546 | - $name, |
|
547 | - $require_construction_to_be_finalized |
|
548 | - ); |
|
549 | - if (! $subsection instanceof EE_Form_Section_Proper) { |
|
550 | - throw new EE_Error( |
|
551 | - sprintf( |
|
552 | - esc_html__( |
|
553 | - "Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'", |
|
554 | - 'event_espresso' |
|
555 | - ), |
|
556 | - $name, |
|
557 | - get_class($this) |
|
558 | - ) |
|
559 | - ); |
|
560 | - } |
|
561 | - return $subsection; |
|
562 | - } |
|
563 | - |
|
564 | - |
|
565 | - /** |
|
566 | - * Gets the value of the specified input. Should be called after receive_form_submission() |
|
567 | - * or populate_defaults() on the form, where the normalized value on the input is set. |
|
568 | - * |
|
569 | - * @param string $name |
|
570 | - * @return mixed depending on the input's type and its normalization strategy |
|
571 | - * @throws EE_Error |
|
572 | - */ |
|
573 | - public function get_input_value($name) |
|
574 | - { |
|
575 | - $input = $this->get_input($name); |
|
576 | - return $input->normalized_value(); |
|
577 | - } |
|
578 | - |
|
579 | - |
|
580 | - /** |
|
581 | - * Checks if this form section itself is valid, and then checks its subsections |
|
582 | - * |
|
583 | - * @throws EE_Error |
|
584 | - * @return boolean |
|
585 | - */ |
|
586 | - public function is_valid() |
|
587 | - { |
|
588 | - if ($this->is_valid === null) { |
|
589 | - if (! $this->has_received_submission()) { |
|
590 | - throw new EE_Error( |
|
591 | - sprintf( |
|
592 | - esc_html__( |
|
593 | - 'You cannot check if a form is valid before receiving the form submission using receive_form_submission', |
|
594 | - 'event_espresso' |
|
595 | - ) |
|
596 | - ) |
|
597 | - ); |
|
598 | - } |
|
599 | - if (! parent::is_valid()) { |
|
600 | - $this->is_valid = false; |
|
601 | - } else { |
|
602 | - // ok so no general errors to this entire form section. |
|
603 | - // so let's check the subsections, but only set errors if that hasn't been done yet |
|
604 | - $this->is_valid = true; |
|
605 | - foreach ($this->get_validatable_subsections() as $subsection) { |
|
606 | - if (! $subsection->is_valid()) { |
|
607 | - $this->is_valid = false; |
|
608 | - } |
|
609 | - } |
|
610 | - } |
|
611 | - } |
|
612 | - return $this->is_valid; |
|
613 | - } |
|
614 | - |
|
615 | - |
|
616 | - /** |
|
617 | - * gets the default name of this form section if none is specified |
|
618 | - * |
|
619 | - * @return void |
|
620 | - */ |
|
621 | - protected function _set_default_name_if_empty() |
|
622 | - { |
|
623 | - if (! $this->_name) { |
|
624 | - $classname = get_class($this); |
|
625 | - $default_name = str_replace('EE_', '', $classname); |
|
626 | - $this->_name = $default_name; |
|
627 | - } |
|
628 | - } |
|
629 | - |
|
630 | - |
|
631 | - /** |
|
632 | - * Returns the HTML for the form, except for the form opening and closing tags |
|
633 | - * (as the form section doesn't know where you necessarily want to send the information to), |
|
634 | - * and except for a submit button. Enqueues JS and CSS; if called early enough we will |
|
635 | - * try to enqueue them in the header, otherwise they'll be enqueued in the footer. |
|
636 | - * Not doing_it_wrong because theoretically this CAN be used properly, |
|
637 | - * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue |
|
638 | - * any CSS. |
|
639 | - * |
|
640 | - * @throws InvalidArgumentException |
|
641 | - * @throws InvalidInterfaceException |
|
642 | - * @throws InvalidDataTypeException |
|
643 | - * @throws EE_Error |
|
644 | - */ |
|
645 | - public function get_html_and_js() |
|
646 | - { |
|
647 | - $this->enqueue_js(); |
|
648 | - return $this->get_html(); |
|
649 | - } |
|
650 | - |
|
651 | - |
|
652 | - /** |
|
653 | - * returns HTML for displaying this form section. recursively calls display_section() on all subsections |
|
654 | - * |
|
655 | - * @param bool $display_previously_submitted_data |
|
656 | - * @return string |
|
657 | - * @throws InvalidArgumentException |
|
658 | - * @throws InvalidInterfaceException |
|
659 | - * @throws InvalidDataTypeException |
|
660 | - * @throws EE_Error |
|
661 | - * @throws EE_Error |
|
662 | - * @throws EE_Error |
|
663 | - */ |
|
664 | - public function get_html($display_previously_submitted_data = true) |
|
665 | - { |
|
666 | - $this->ensure_construct_finalized_called(); |
|
667 | - if ($display_previously_submitted_data) { |
|
668 | - $this->populate_from_session(); |
|
669 | - } |
|
670 | - return $this->_form_html_filter |
|
671 | - ? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this) |
|
672 | - : $this->_layout_strategy->layout_form(); |
|
673 | - } |
|
674 | - |
|
675 | - |
|
676 | - /** |
|
677 | - * enqueues JS and CSS for the form. |
|
678 | - * It is preferred to call this before wp_enqueue_scripts so the |
|
679 | - * scripts and styles can be put in the header, but if called later |
|
680 | - * they will be put in the footer (which is OK for JS, but in HTML4 CSS should |
|
681 | - * only be in the header; but in HTML5 its ok in the body. |
|
682 | - * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag. |
|
683 | - * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.) |
|
684 | - * |
|
685 | - * @return void |
|
686 | - * @throws EE_Error |
|
687 | - */ |
|
688 | - public function enqueue_js() |
|
689 | - { |
|
690 | - $this->_enqueue_and_localize_form_js(); |
|
691 | - foreach ($this->subsections() as $subsection) { |
|
692 | - $subsection->enqueue_js(); |
|
693 | - } |
|
694 | - } |
|
695 | - |
|
696 | - |
|
697 | - /** |
|
698 | - * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts(). |
|
699 | - * This must be done BEFORE wp_enqueue_scripts() gets called, which is on |
|
700 | - * the wp_enqueue_scripts hook. |
|
701 | - * However, registering the form js and localizing it can happen when we |
|
702 | - * actually output the form (which is preferred, seeing how teh form's fields |
|
703 | - * could change until it's actually outputted) |
|
704 | - * |
|
705 | - * @param boolean $init_form_validation_automatically whether or not we want the form validation |
|
706 | - * to be triggered automatically or not |
|
707 | - * @return void |
|
708 | - */ |
|
709 | - public static function wp_enqueue_scripts($init_form_validation_automatically = true) |
|
710 | - { |
|
711 | - wp_register_script( |
|
712 | - 'ee_form_section_validation', |
|
713 | - EE_GLOBAL_ASSETS_URL . 'scripts' . '/form_section_validation.js', |
|
714 | - array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'), |
|
715 | - EVENT_ESPRESSO_VERSION, |
|
716 | - true |
|
717 | - ); |
|
718 | - wp_localize_script( |
|
719 | - 'ee_form_section_validation', |
|
720 | - 'ee_form_section_validation_init', |
|
721 | - array('init' => $init_form_validation_automatically ? '1' : '0') |
|
722 | - ); |
|
723 | - } |
|
724 | - |
|
725 | - |
|
726 | - /** |
|
727 | - * gets the variables used by form_section_validation.js. |
|
728 | - * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script, |
|
729 | - * but before the wordpress hook wp_loaded |
|
730 | - * |
|
731 | - * @throws EE_Error |
|
732 | - */ |
|
733 | - public function _enqueue_and_localize_form_js() |
|
734 | - { |
|
735 | - $this->ensure_construct_finalized_called(); |
|
736 | - // actually, we don't want to localize just yet. There may be other forms on the page. |
|
737 | - // so we need to add our form section data to a static variable accessible by all form sections |
|
738 | - // and localize it just before the footer |
|
739 | - $this->localize_validation_rules(); |
|
740 | - add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2); |
|
741 | - add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms')); |
|
742 | - } |
|
743 | - |
|
744 | - |
|
745 | - /** |
|
746 | - * add our form section data to a static variable accessible by all form sections |
|
747 | - * |
|
748 | - * @param bool $return_for_subsection |
|
749 | - * @return void |
|
750 | - * @throws EE_Error |
|
751 | - */ |
|
752 | - public function localize_validation_rules($return_for_subsection = false) |
|
753 | - { |
|
754 | - // we only want to localize vars ONCE for the entire form, |
|
755 | - // so if the form section doesn't have a parent, then it must be the top dog |
|
756 | - if ($return_for_subsection || ! $this->parent_section()) { |
|
757 | - EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array( |
|
758 | - 'form_section_id' => $this->html_id(true), |
|
759 | - 'validation_rules' => $this->get_jquery_validation_rules(), |
|
760 | - 'other_data' => $this->get_other_js_data(), |
|
761 | - 'errors' => $this->subsection_validation_errors_by_html_name(), |
|
762 | - ); |
|
763 | - EE_Form_Section_Proper::$_scripts_localized = true; |
|
764 | - } |
|
765 | - } |
|
766 | - |
|
767 | - |
|
768 | - /** |
|
769 | - * Gets an array of extra data that will be useful for client-side javascript. |
|
770 | - * This is primarily data added by inputs and forms in addition to any |
|
771 | - * scripts they might enqueue |
|
772 | - * |
|
773 | - * @param array $form_other_js_data |
|
774 | - * @return array |
|
775 | - * @throws EE_Error |
|
776 | - */ |
|
777 | - public function get_other_js_data($form_other_js_data = array()) |
|
778 | - { |
|
779 | - foreach ($this->subsections() as $subsection) { |
|
780 | - $form_other_js_data = $subsection->get_other_js_data($form_other_js_data); |
|
781 | - } |
|
782 | - return $form_other_js_data; |
|
783 | - } |
|
784 | - |
|
785 | - |
|
786 | - /** |
|
787 | - * Gets a flat array of inputs for this form section and its subsections. |
|
788 | - * Keys are their form names, and values are the inputs themselves |
|
789 | - * |
|
790 | - * @return EE_Form_Input_Base |
|
791 | - * @throws EE_Error |
|
792 | - */ |
|
793 | - public function inputs_in_subsections() |
|
794 | - { |
|
795 | - $inputs = array(); |
|
796 | - foreach ($this->subsections() as $subsection) { |
|
797 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
798 | - $inputs[ $subsection->html_name() ] = $subsection; |
|
799 | - } elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
800 | - $inputs += $subsection->inputs_in_subsections(); |
|
801 | - } |
|
802 | - } |
|
803 | - return $inputs; |
|
804 | - } |
|
805 | - |
|
806 | - |
|
807 | - /** |
|
808 | - * Gets a flat array of all the validation errors. |
|
809 | - * Keys are html names (because those should be unique) |
|
810 | - * and values are a string of all their validation errors |
|
811 | - * |
|
812 | - * @return string[] |
|
813 | - * @throws EE_Error |
|
814 | - */ |
|
815 | - public function subsection_validation_errors_by_html_name() |
|
816 | - { |
|
817 | - $inputs = $this->inputs(); |
|
818 | - $errors = array(); |
|
819 | - foreach ($inputs as $form_input) { |
|
820 | - if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) { |
|
821 | - $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string(); |
|
822 | - } |
|
823 | - } |
|
824 | - return $errors; |
|
825 | - } |
|
826 | - |
|
827 | - |
|
828 | - /** |
|
829 | - * passes all the form data required by the JS to the JS, and enqueues the few required JS files. |
|
830 | - * Should be setup by each form during the _enqueues_and_localize_form_js |
|
831 | - * |
|
832 | - * @throws InvalidArgumentException |
|
833 | - * @throws InvalidInterfaceException |
|
834 | - * @throws InvalidDataTypeException |
|
835 | - */ |
|
836 | - public static function localize_script_for_all_forms() |
|
837 | - { |
|
838 | - // allow inputs and stuff to hook in their JS and stuff here |
|
839 | - do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin'); |
|
840 | - EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages(); |
|
841 | - $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level) |
|
842 | - ? EE_Registry::instance()->CFG->registration->email_validation_level |
|
843 | - : 'wp_default'; |
|
844 | - EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level; |
|
845 | - wp_enqueue_script('ee_form_section_validation'); |
|
846 | - wp_localize_script( |
|
847 | - 'ee_form_section_validation', |
|
848 | - 'ee_form_section_vars', |
|
849 | - EE_Form_Section_Proper::$_js_localization |
|
850 | - ); |
|
851 | - } |
|
852 | - |
|
853 | - |
|
854 | - /** |
|
855 | - * ensure_scripts_localized |
|
856 | - * |
|
857 | - * @throws EE_Error |
|
858 | - */ |
|
859 | - public function ensure_scripts_localized() |
|
860 | - { |
|
861 | - if (! EE_Form_Section_Proper::$_scripts_localized) { |
|
862 | - $this->_enqueue_and_localize_form_js(); |
|
863 | - } |
|
864 | - } |
|
865 | - |
|
866 | - |
|
867 | - /** |
|
868 | - * Gets the hard-coded validation error messages to be used in the JS. The convention |
|
869 | - * is that the key here should be the same as the custom validation rule put in the JS file |
|
870 | - * |
|
871 | - * @return array keys are custom validation rules, and values are internationalized strings |
|
872 | - */ |
|
873 | - private static function _get_localized_error_messages() |
|
874 | - { |
|
875 | - return array( |
|
876 | - 'validUrl' => esc_html__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso'), |
|
877 | - 'regex' => esc_html__('Please check your input', 'event_espresso'), |
|
878 | - ); |
|
879 | - } |
|
880 | - |
|
881 | - |
|
882 | - /** |
|
883 | - * @return array |
|
884 | - */ |
|
885 | - public static function js_localization() |
|
886 | - { |
|
887 | - return self::$_js_localization; |
|
888 | - } |
|
889 | - |
|
890 | - |
|
891 | - /** |
|
892 | - * @return void |
|
893 | - */ |
|
894 | - public static function reset_js_localization() |
|
895 | - { |
|
896 | - self::$_js_localization = array(); |
|
897 | - } |
|
898 | - |
|
899 | - |
|
900 | - /** |
|
901 | - * Gets the JS to put inside the jquery validation rules for subsection of this form section. |
|
902 | - * See parent function for more... |
|
903 | - * |
|
904 | - * @return array |
|
905 | - * @throws EE_Error |
|
906 | - */ |
|
907 | - public function get_jquery_validation_rules() |
|
908 | - { |
|
909 | - $jquery_validation_rules = array(); |
|
910 | - foreach ($this->get_validatable_subsections() as $subsection) { |
|
911 | - $jquery_validation_rules = array_merge( |
|
912 | - $jquery_validation_rules, |
|
913 | - $subsection->get_jquery_validation_rules() |
|
914 | - ); |
|
915 | - } |
|
916 | - return $jquery_validation_rules; |
|
917 | - } |
|
918 | - |
|
919 | - |
|
920 | - /** |
|
921 | - * Sanitizes all the data and sets the sanitized value of each field |
|
922 | - * |
|
923 | - * @param array $req_data like $_POST |
|
924 | - * @return void |
|
925 | - * @throws EE_Error |
|
926 | - */ |
|
927 | - protected function _normalize($req_data) |
|
928 | - { |
|
929 | - $this->_received_submission = true; |
|
930 | - $this->_validation_errors = array(); |
|
931 | - foreach ($this->get_validatable_subsections() as $subsection) { |
|
932 | - try { |
|
933 | - $subsection->_normalize($req_data); |
|
934 | - } catch (EE_Validation_Error $e) { |
|
935 | - $subsection->add_validation_error($e); |
|
936 | - } |
|
937 | - } |
|
938 | - } |
|
939 | - |
|
940 | - |
|
941 | - /** |
|
942 | - * Performs validation on this form section and its subsections. |
|
943 | - * For each subsection, |
|
944 | - * calls _validate_{subsection_name} on THIS form (if the function exists) |
|
945 | - * and passes it the subsection, then calls _validate on that subsection. |
|
946 | - * If you need to perform validation on the form as a whole (considering multiple) |
|
947 | - * you would be best to override this _validate method, |
|
948 | - * calling parent::_validate() first. |
|
949 | - * |
|
950 | - * @throws EE_Error |
|
951 | - */ |
|
952 | - protected function _validate() |
|
953 | - { |
|
954 | - // reset the cache of whether this form is valid or not- we're re-validating it now |
|
955 | - $this->is_valid = null; |
|
956 | - foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) { |
|
957 | - if (method_exists($this, '_validate_' . $subsection_name)) { |
|
958 | - call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection)); |
|
959 | - } |
|
960 | - $subsection->_validate(); |
|
961 | - } |
|
962 | - } |
|
963 | - |
|
964 | - |
|
965 | - /** |
|
966 | - * Gets all the validated inputs for the form section |
|
967 | - * |
|
968 | - * @return array |
|
969 | - * @throws EE_Error |
|
970 | - */ |
|
971 | - public function valid_data() |
|
972 | - { |
|
973 | - $inputs = array(); |
|
974 | - foreach ($this->subsections() as $subsection_name => $subsection) { |
|
975 | - if ($subsection instanceof EE_Form_Section_Proper) { |
|
976 | - $inputs[ $subsection_name ] = $subsection->valid_data(); |
|
977 | - } elseif ($subsection instanceof EE_Form_Input_Base) { |
|
978 | - $inputs[ $subsection_name ] = $subsection->normalized_value(); |
|
979 | - } |
|
980 | - } |
|
981 | - return $inputs; |
|
982 | - } |
|
983 | - |
|
984 | - |
|
985 | - /** |
|
986 | - * Gets all the inputs on this form section |
|
987 | - * |
|
988 | - * @return EE_Form_Input_Base[] |
|
989 | - * @throws EE_Error |
|
990 | - */ |
|
991 | - public function inputs() |
|
992 | - { |
|
993 | - $inputs = array(); |
|
994 | - foreach ($this->subsections() as $subsection_name => $subsection) { |
|
995 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
996 | - $inputs[ $subsection_name ] = $subsection; |
|
997 | - } |
|
998 | - } |
|
999 | - return $inputs; |
|
1000 | - } |
|
1001 | - |
|
1002 | - |
|
1003 | - /** |
|
1004 | - * Gets all the subsections which are a proper form |
|
1005 | - * |
|
1006 | - * @return EE_Form_Section_Proper[] |
|
1007 | - * @throws EE_Error |
|
1008 | - */ |
|
1009 | - public function subforms() |
|
1010 | - { |
|
1011 | - $form_sections = array(); |
|
1012 | - foreach ($this->subsections() as $name => $obj) { |
|
1013 | - if ($obj instanceof EE_Form_Section_Proper) { |
|
1014 | - $form_sections[ $name ] = $obj; |
|
1015 | - } |
|
1016 | - } |
|
1017 | - return $form_sections; |
|
1018 | - } |
|
1019 | - |
|
1020 | - |
|
1021 | - /** |
|
1022 | - * Gets all the subsections (inputs, proper subsections, or html-only sections). |
|
1023 | - * Consider using inputs() or subforms() |
|
1024 | - * if you only want form inputs or proper form sections. |
|
1025 | - * |
|
1026 | - * @param boolean $require_construction_to_be_finalized most client code should |
|
1027 | - * leave this as TRUE so that the inputs will be properly |
|
1028 | - * configured. However, some client code may be ok with |
|
1029 | - * construction finalize being called later |
|
1030 | - * (realizing that the subsections' html names might not be |
|
1031 | - * set yet, etc.) |
|
1032 | - * @return EE_Form_Section_Proper[] |
|
1033 | - * @throws EE_Error |
|
1034 | - */ |
|
1035 | - public function subsections($require_construction_to_be_finalized = true) |
|
1036 | - { |
|
1037 | - if ($require_construction_to_be_finalized) { |
|
1038 | - $this->ensure_construct_finalized_called(); |
|
1039 | - } |
|
1040 | - return $this->_subsections; |
|
1041 | - } |
|
1042 | - |
|
1043 | - |
|
1044 | - /** |
|
1045 | - * Returns whether this form has any subforms or inputs |
|
1046 | - * @return bool |
|
1047 | - */ |
|
1048 | - public function hasSubsections() |
|
1049 | - { |
|
1050 | - return ! empty($this->_subsections); |
|
1051 | - } |
|
1052 | - |
|
1053 | - |
|
1054 | - /** |
|
1055 | - * Returns a simple array where keys are input names, and values are their normalized |
|
1056 | - * values. (Similar to calling get_input_value on inputs) |
|
1057 | - * |
|
1058 | - * @param boolean $include_subform_inputs Whether to include inputs from subforms, |
|
1059 | - * or just this forms' direct children inputs |
|
1060 | - * @param boolean $flatten Whether to force the results into 1-dimensional array, |
|
1061 | - * or allow multidimensional array |
|
1062 | - * @return array if $flatten is TRUE it will always be a 1-dimensional array |
|
1063 | - * with array keys being input names |
|
1064 | - * (regardless of whether they are from a subsection or not), |
|
1065 | - * and if $flatten is FALSE it can be a multidimensional array |
|
1066 | - * where keys are always subsection names and values are either |
|
1067 | - * the input's normalized value, or an array like the top-level array |
|
1068 | - * @throws EE_Error |
|
1069 | - */ |
|
1070 | - public function input_values($include_subform_inputs = false, $flatten = false) |
|
1071 | - { |
|
1072 | - return $this->_input_values(false, $include_subform_inputs, $flatten); |
|
1073 | - } |
|
1074 | - |
|
1075 | - |
|
1076 | - /** |
|
1077 | - * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value' |
|
1078 | - * of each input. On some inputs (especially radio boxes or checkboxes), the value stored |
|
1079 | - * is not necessarily the value we want to display to users. This creates an array |
|
1080 | - * where keys are the input names, and values are their display values |
|
1081 | - * |
|
1082 | - * @param boolean $include_subform_inputs Whether to include inputs from subforms, |
|
1083 | - * or just this forms' direct children inputs |
|
1084 | - * @param boolean $flatten Whether to force the results into 1-dimensional array, |
|
1085 | - * or allow multidimensional array |
|
1086 | - * @return array if $flatten is TRUE it will always be a 1-dimensional array |
|
1087 | - * with array keys being input names |
|
1088 | - * (regardless of whether they are from a subsection or not), |
|
1089 | - * and if $flatten is FALSE it can be a multidimensional array |
|
1090 | - * where keys are always subsection names and values are either |
|
1091 | - * the input's normalized value, or an array like the top-level array |
|
1092 | - * @throws EE_Error |
|
1093 | - */ |
|
1094 | - public function input_pretty_values($include_subform_inputs = false, $flatten = false) |
|
1095 | - { |
|
1096 | - return $this->_input_values(true, $include_subform_inputs, $flatten); |
|
1097 | - } |
|
1098 | - |
|
1099 | - |
|
1100 | - /** |
|
1101 | - * Gets the input values from the form |
|
1102 | - * |
|
1103 | - * @param boolean $pretty Whether to retrieve the pretty value, |
|
1104 | - * or just the normalized value |
|
1105 | - * @param boolean $include_subform_inputs Whether to include inputs from subforms, |
|
1106 | - * or just this forms' direct children inputs |
|
1107 | - * @param boolean $flatten Whether to force the results into 1-dimensional array, |
|
1108 | - * or allow multidimensional array |
|
1109 | - * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being |
|
1110 | - * input names (regardless of whether they are from a subsection or not), |
|
1111 | - * and if $flatten is FALSE it can be a multidimensional array |
|
1112 | - * where keys are always subsection names and values are either |
|
1113 | - * the input's normalized value, or an array like the top-level array |
|
1114 | - * @throws EE_Error |
|
1115 | - */ |
|
1116 | - public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false) |
|
1117 | - { |
|
1118 | - $input_values = array(); |
|
1119 | - foreach ($this->subsections() as $subsection_name => $subsection) { |
|
1120 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
1121 | - $input_values[ $subsection_name ] = $pretty |
|
1122 | - ? $subsection->pretty_value() |
|
1123 | - : $subsection->normalized_value(); |
|
1124 | - } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) { |
|
1125 | - $subform_input_values = $subsection->_input_values( |
|
1126 | - $pretty, |
|
1127 | - $include_subform_inputs, |
|
1128 | - $flatten |
|
1129 | - ); |
|
1130 | - if ($flatten) { |
|
1131 | - $input_values = array_merge($input_values, $subform_input_values); |
|
1132 | - } else { |
|
1133 | - $input_values[ $subsection_name ] = $subform_input_values; |
|
1134 | - } |
|
1135 | - } |
|
1136 | - } |
|
1137 | - return $input_values; |
|
1138 | - } |
|
1139 | - |
|
1140 | - |
|
1141 | - /** |
|
1142 | - * Gets the originally submitted input values from the form |
|
1143 | - * |
|
1144 | - * @param boolean $include_subforms Whether to include inputs from subforms, |
|
1145 | - * or just this forms' direct children inputs |
|
1146 | - * @return array if $flatten is TRUE it will always be a 1-dimensional array |
|
1147 | - * with array keys being input names |
|
1148 | - * (regardless of whether they are from a subsection or not), |
|
1149 | - * and if $flatten is FALSE it can be a multidimensional array |
|
1150 | - * where keys are always subsection names and values are either |
|
1151 | - * the input's normalized value, or an array like the top-level array |
|
1152 | - * @throws EE_Error |
|
1153 | - */ |
|
1154 | - public function submitted_values($include_subforms = false) |
|
1155 | - { |
|
1156 | - $submitted_values = array(); |
|
1157 | - foreach ($this->subsections() as $subsection) { |
|
1158 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
1159 | - // is this input part of an array of inputs? |
|
1160 | - if (strpos($subsection->html_name(), '[') !== false) { |
|
1161 | - $full_input_name = EEH_Array::convert_array_values_to_keys( |
|
1162 | - explode( |
|
1163 | - '[', |
|
1164 | - str_replace(']', '', $subsection->html_name()) |
|
1165 | - ), |
|
1166 | - $subsection->raw_value() |
|
1167 | - ); |
|
1168 | - $submitted_values = array_replace_recursive($submitted_values, $full_input_name); |
|
1169 | - } else { |
|
1170 | - $submitted_values[ $subsection->html_name() ] = $subsection->raw_value(); |
|
1171 | - } |
|
1172 | - } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) { |
|
1173 | - $subform_input_values = $subsection->submitted_values($include_subforms); |
|
1174 | - $submitted_values = array_replace_recursive($submitted_values, $subform_input_values); |
|
1175 | - } |
|
1176 | - } |
|
1177 | - return $submitted_values; |
|
1178 | - } |
|
1179 | - |
|
1180 | - |
|
1181 | - /** |
|
1182 | - * Indicates whether or not this form has received a submission yet |
|
1183 | - * (ie, had receive_form_submission called on it yet) |
|
1184 | - * |
|
1185 | - * @return boolean |
|
1186 | - * @throws EE_Error |
|
1187 | - */ |
|
1188 | - public function has_received_submission() |
|
1189 | - { |
|
1190 | - $this->ensure_construct_finalized_called(); |
|
1191 | - return $this->_received_submission; |
|
1192 | - } |
|
1193 | - |
|
1194 | - |
|
1195 | - /** |
|
1196 | - * Equivalent to passing 'exclude' in the constructor's options array. |
|
1197 | - * Removes the listed inputs from the form |
|
1198 | - * |
|
1199 | - * @param array $inputs_to_exclude values are the input names |
|
1200 | - * @return void |
|
1201 | - */ |
|
1202 | - public function exclude(array $inputs_to_exclude = array()) |
|
1203 | - { |
|
1204 | - foreach ($inputs_to_exclude as $input_to_exclude_name) { |
|
1205 | - unset($this->_subsections[ $input_to_exclude_name ]); |
|
1206 | - } |
|
1207 | - } |
|
1208 | - |
|
1209 | - |
|
1210 | - /** |
|
1211 | - * Changes these inputs' display strategy to be EE_Hidden_Display_Strategy. |
|
1212 | - * @param array $inputs_to_hide |
|
1213 | - * @throws EE_Error |
|
1214 | - */ |
|
1215 | - public function hide(array $inputs_to_hide = array()) |
|
1216 | - { |
|
1217 | - foreach ($inputs_to_hide as $input_to_hide) { |
|
1218 | - $input = $this->get_input($input_to_hide); |
|
1219 | - $input->set_display_strategy(new EE_Hidden_Display_Strategy()); |
|
1220 | - } |
|
1221 | - } |
|
1222 | - |
|
1223 | - |
|
1224 | - /** |
|
1225 | - * add_subsections |
|
1226 | - * Adds the listed subsections to the form section. |
|
1227 | - * If $subsection_name_to_target is provided, |
|
1228 | - * then new subsections are added before or after that subsection, |
|
1229 | - * otherwise to the start or end of the entire subsections array. |
|
1230 | - * |
|
1231 | - * @param EE_Form_Section_Base[] $new_subsections array of new form subsections |
|
1232 | - * where keys are their names |
|
1233 | - * @param string $subsection_name_to_target an existing for section that $new_subsections |
|
1234 | - * should be added before or after |
|
1235 | - * IF $subsection_name_to_target is null, |
|
1236 | - * then $new_subsections will be added to |
|
1237 | - * the beginning or end of the entire subsections array |
|
1238 | - * @param boolean $add_before whether to add $new_subsections, before or after |
|
1239 | - * $subsection_name_to_target, |
|
1240 | - * or if $subsection_name_to_target is null, |
|
1241 | - * before or after entire subsections array |
|
1242 | - * @return void |
|
1243 | - * @throws EE_Error |
|
1244 | - */ |
|
1245 | - public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true) |
|
1246 | - { |
|
1247 | - foreach ($new_subsections as $subsection_name => $subsection) { |
|
1248 | - if (! $subsection instanceof EE_Form_Section_Base) { |
|
1249 | - EE_Error::add_error( |
|
1250 | - sprintf( |
|
1251 | - esc_html__( |
|
1252 | - "Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.", |
|
1253 | - 'event_espresso' |
|
1254 | - ), |
|
1255 | - get_class($subsection), |
|
1256 | - $subsection_name, |
|
1257 | - $this->name() |
|
1258 | - ) |
|
1259 | - ); |
|
1260 | - unset($new_subsections[ $subsection_name ]); |
|
1261 | - } |
|
1262 | - } |
|
1263 | - $this->_subsections = EEH_Array::insert_into_array( |
|
1264 | - $this->_subsections, |
|
1265 | - $new_subsections, |
|
1266 | - $subsection_name_to_target, |
|
1267 | - $add_before |
|
1268 | - ); |
|
1269 | - if ($this->_construction_finalized) { |
|
1270 | - foreach ($this->_subsections as $name => $subsection) { |
|
1271 | - $subsection->_construct_finalize($this, $name); |
|
1272 | - } |
|
1273 | - } |
|
1274 | - } |
|
1275 | - |
|
1276 | - |
|
1277 | - /** |
|
1278 | - * @param string $subsection_name |
|
1279 | - * @param bool $recursive |
|
1280 | - * @return bool |
|
1281 | - */ |
|
1282 | - public function has_subsection($subsection_name, $recursive = false) |
|
1283 | - { |
|
1284 | - foreach ($this->_subsections as $name => $subsection) { |
|
1285 | - if ($name === $subsection_name |
|
1286 | - || ( |
|
1287 | - $recursive |
|
1288 | - && $subsection instanceof EE_Form_Section_Proper |
|
1289 | - && $subsection->has_subsection($subsection_name, $recursive) |
|
1290 | - ) |
|
1291 | - ) { |
|
1292 | - return true; |
|
1293 | - } |
|
1294 | - } |
|
1295 | - return false; |
|
1296 | - } |
|
1297 | - |
|
1298 | - |
|
1299 | - |
|
1300 | - /** |
|
1301 | - * Just gets all validatable subsections to clean their sensitive data |
|
1302 | - * |
|
1303 | - * @throws EE_Error |
|
1304 | - */ |
|
1305 | - public function clean_sensitive_data() |
|
1306 | - { |
|
1307 | - foreach ($this->get_validatable_subsections() as $subsection) { |
|
1308 | - $subsection->clean_sensitive_data(); |
|
1309 | - } |
|
1310 | - } |
|
1311 | - |
|
1312 | - |
|
1313 | - /** |
|
1314 | - * Sets the submission error message (aka validation error message for this form section and all sub-sections) |
|
1315 | - * @param string $form_submission_error_message |
|
1316 | - * @param EE_Form_Section_Validatable $form_section unused |
|
1317 | - * @throws EE_Error |
|
1318 | - */ |
|
1319 | - public function set_submission_error_message( |
|
1320 | - $form_submission_error_message = '' |
|
1321 | - ) { |
|
1322 | - $this->_form_submission_error_message = ! empty($form_submission_error_message) |
|
1323 | - ? $form_submission_error_message |
|
1324 | - : $this->getAllValidationErrorsString(); |
|
1325 | - } |
|
1326 | - |
|
1327 | - |
|
1328 | - /** |
|
1329 | - * Returns the cached error message. A default value is set for this during _validate(), |
|
1330 | - * (called during receive_form_submission) but it can be explicitly set using |
|
1331 | - * set_submission_error_message |
|
1332 | - * |
|
1333 | - * @return string |
|
1334 | - */ |
|
1335 | - public function submission_error_message() |
|
1336 | - { |
|
1337 | - return $this->_form_submission_error_message; |
|
1338 | - } |
|
1339 | - |
|
1340 | - |
|
1341 | - /** |
|
1342 | - * Sets a message to display if the data submitted to the form was valid. |
|
1343 | - * @param string $form_submission_success_message |
|
1344 | - */ |
|
1345 | - public function set_submission_success_message($form_submission_success_message = '') |
|
1346 | - { |
|
1347 | - $this->_form_submission_success_message = ! empty($form_submission_success_message) |
|
1348 | - ? $form_submission_success_message |
|
1349 | - : esc_html__('Form submitted successfully', 'event_espresso'); |
|
1350 | - } |
|
1351 | - |
|
1352 | - |
|
1353 | - /** |
|
1354 | - * Gets a message appropriate for display when the form is correctly submitted |
|
1355 | - * @return string |
|
1356 | - */ |
|
1357 | - public function submission_success_message() |
|
1358 | - { |
|
1359 | - return $this->_form_submission_success_message; |
|
1360 | - } |
|
1361 | - |
|
1362 | - |
|
1363 | - /** |
|
1364 | - * Returns the prefix that should be used on child of this form section for |
|
1365 | - * their html names. If this form section itself has a parent, prepends ITS |
|
1366 | - * prefix onto this form section's prefix. Used primarily by |
|
1367 | - * EE_Form_Input_Base::_set_default_html_name_if_empty |
|
1368 | - * |
|
1369 | - * @return string |
|
1370 | - * @throws EE_Error |
|
1371 | - */ |
|
1372 | - public function html_name_prefix() |
|
1373 | - { |
|
1374 | - if ($this->parent_section() instanceof EE_Form_Section_Proper) { |
|
1375 | - return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']'; |
|
1376 | - } |
|
1377 | - return $this->name(); |
|
1378 | - } |
|
1379 | - |
|
1380 | - |
|
1381 | - /** |
|
1382 | - * Gets the name, but first checks _construct_finalize has been called. If not, |
|
1383 | - * calls it (assumes there is no parent and that we want the name to be whatever |
|
1384 | - * was set, which is probably nothing, or the classname) |
|
1385 | - * |
|
1386 | - * @return string |
|
1387 | - * @throws EE_Error |
|
1388 | - */ |
|
1389 | - public function name() |
|
1390 | - { |
|
1391 | - $this->ensure_construct_finalized_called(); |
|
1392 | - return parent::name(); |
|
1393 | - } |
|
1394 | - |
|
1395 | - |
|
1396 | - /** |
|
1397 | - * @return EE_Form_Section_Proper |
|
1398 | - * @throws EE_Error |
|
1399 | - */ |
|
1400 | - public function parent_section() |
|
1401 | - { |
|
1402 | - $this->ensure_construct_finalized_called(); |
|
1403 | - return parent::parent_section(); |
|
1404 | - } |
|
1405 | - |
|
1406 | - |
|
1407 | - /** |
|
1408 | - * make sure construction finalized was called, otherwise children might not be ready |
|
1409 | - * |
|
1410 | - * @return void |
|
1411 | - * @throws EE_Error |
|
1412 | - */ |
|
1413 | - public function ensure_construct_finalized_called() |
|
1414 | - { |
|
1415 | - if (! $this->_construction_finalized) { |
|
1416 | - $this->_construct_finalize($this->_parent_section, $this->_name); |
|
1417 | - } |
|
1418 | - } |
|
1419 | - |
|
1420 | - |
|
1421 | - /** |
|
1422 | - * Checks if any of this form section's inputs, or any of its children's inputs, |
|
1423 | - * are in teh form data. If any are found, returns true. Else false |
|
1424 | - * |
|
1425 | - * @param array $req_data |
|
1426 | - * @return boolean |
|
1427 | - * @throws EE_Error |
|
1428 | - */ |
|
1429 | - public function form_data_present_in($req_data = null) |
|
1430 | - { |
|
1431 | - $req_data = $this->getCachedRequest($req_data); |
|
1432 | - foreach ($this->subsections() as $subsection) { |
|
1433 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
1434 | - if ($subsection->form_data_present_in($req_data)) { |
|
1435 | - return true; |
|
1436 | - } |
|
1437 | - } elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
1438 | - if ($subsection->form_data_present_in($req_data)) { |
|
1439 | - return true; |
|
1440 | - } |
|
1441 | - } |
|
1442 | - } |
|
1443 | - return false; |
|
1444 | - } |
|
1445 | - |
|
1446 | - |
|
1447 | - /** |
|
1448 | - * Gets validation errors for this form section and subsections |
|
1449 | - * Similar to EE_Form_Section_Validatable::get_validation_errors() except this |
|
1450 | - * gets the validation errors for ALL subsection |
|
1451 | - * |
|
1452 | - * @return EE_Validation_Error[] |
|
1453 | - * @throws EE_Error |
|
1454 | - */ |
|
1455 | - public function get_validation_errors_accumulated() |
|
1456 | - { |
|
1457 | - $validation_errors = $this->get_validation_errors(); |
|
1458 | - foreach ($this->get_validatable_subsections() as $subsection) { |
|
1459 | - if ($subsection instanceof EE_Form_Section_Proper) { |
|
1460 | - $validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated(); |
|
1461 | - } else { |
|
1462 | - $validation_errors_on_this_subsection = $subsection->get_validation_errors(); |
|
1463 | - } |
|
1464 | - if ($validation_errors_on_this_subsection) { |
|
1465 | - $validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection); |
|
1466 | - } |
|
1467 | - } |
|
1468 | - return $validation_errors; |
|
1469 | - } |
|
1470 | - |
|
1471 | - /** |
|
1472 | - * Fetch validation errors from children and grandchildren and puts them in a single string. |
|
1473 | - * This traverses the form section tree to generate this, but you probably want to instead use |
|
1474 | - * get_form_submission_error_message() which is usually this message cached (or a custom validation error message) |
|
1475 | - * |
|
1476 | - * @return string |
|
1477 | - * @since 4.9.59.p |
|
1478 | - */ |
|
1479 | - protected function getAllValidationErrorsString() |
|
1480 | - { |
|
1481 | - $submission_error_messages = array(); |
|
1482 | - // bad, bad, bad registrant |
|
1483 | - foreach ($this->get_validation_errors_accumulated() as $validation_error) { |
|
1484 | - if ($validation_error instanceof EE_Validation_Error) { |
|
1485 | - $form_section = $validation_error->get_form_section(); |
|
1486 | - if ($form_section instanceof EE_Form_Input_Base) { |
|
1487 | - $label = $validation_error->get_form_section()->html_label_text(); |
|
1488 | - } elseif ($form_section instanceof EE_Form_Section_Validatable) { |
|
1489 | - $label = $validation_error->get_form_section()->name(); |
|
1490 | - } else { |
|
1491 | - $label = esc_html__('Unknown', 'event_espresso'); |
|
1492 | - } |
|
1493 | - $submission_error_messages[] = sprintf( |
|
1494 | - __('%s : %s', 'event_espresso'), |
|
1495 | - $label, |
|
1496 | - $validation_error->getMessage() |
|
1497 | - ); |
|
1498 | - } |
|
1499 | - } |
|
1500 | - return implode('<br', $submission_error_messages); |
|
1501 | - } |
|
1502 | - |
|
1503 | - |
|
1504 | - /** |
|
1505 | - * This isn't just the name of an input, it's a path pointing to an input. The |
|
1506 | - * path is similar to a folder path: slash (/) means to descend into a subsection, |
|
1507 | - * dot-dot-slash (../) means to ascend into the parent section. |
|
1508 | - * After a series of slashes and dot-dot-slashes, there should be the name of an input, |
|
1509 | - * which will be returned. |
|
1510 | - * Eg, if you want the related input to be conditional on a sibling input name 'foobar' |
|
1511 | - * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name |
|
1512 | - * 'baz', use '../baz'. If you want it to be conditional on a cousin input, |
|
1513 | - * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'. |
|
1514 | - * Etc |
|
1515 | - * |
|
1516 | - * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false |
|
1517 | - * @return EE_Form_Section_Base |
|
1518 | - * @throws EE_Error |
|
1519 | - */ |
|
1520 | - public function find_section_from_path($form_section_path) |
|
1521 | - { |
|
1522 | - // check if we can find the input from purely going straight up the tree |
|
1523 | - $input = parent::find_section_from_path($form_section_path); |
|
1524 | - if ($input instanceof EE_Form_Section_Base) { |
|
1525 | - return $input; |
|
1526 | - } |
|
1527 | - $next_slash_pos = strpos($form_section_path, '/'); |
|
1528 | - if ($next_slash_pos !== false) { |
|
1529 | - $child_section_name = substr($form_section_path, 0, $next_slash_pos); |
|
1530 | - $subpath = substr($form_section_path, $next_slash_pos + 1); |
|
1531 | - } else { |
|
1532 | - $child_section_name = $form_section_path; |
|
1533 | - $subpath = ''; |
|
1534 | - } |
|
1535 | - $child_section = $this->get_subsection($child_section_name); |
|
1536 | - if ($child_section instanceof EE_Form_Section_Base) { |
|
1537 | - return $child_section->find_section_from_path($subpath); |
|
1538 | - } |
|
1539 | - return null; |
|
1540 | - } |
|
17 | + const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data'; |
|
18 | + |
|
19 | + /** |
|
20 | + * Subsections |
|
21 | + * |
|
22 | + * @var EE_Form_Section_Validatable[] |
|
23 | + */ |
|
24 | + protected $_subsections = array(); |
|
25 | + |
|
26 | + /** |
|
27 | + * Strategy for laying out the form |
|
28 | + * |
|
29 | + * @var EE_Form_Section_Layout_Base |
|
30 | + */ |
|
31 | + protected $_layout_strategy; |
|
32 | + |
|
33 | + /** |
|
34 | + * Whether or not this form has received and validated a form submission yet |
|
35 | + * |
|
36 | + * @var boolean |
|
37 | + */ |
|
38 | + protected $_received_submission = false; |
|
39 | + |
|
40 | + /** |
|
41 | + * message displayed to users upon successful form submission |
|
42 | + * |
|
43 | + * @var string |
|
44 | + */ |
|
45 | + protected $_form_submission_success_message = ''; |
|
46 | + |
|
47 | + /** |
|
48 | + * message displayed to users upon unsuccessful form submission |
|
49 | + * |
|
50 | + * @var string |
|
51 | + */ |
|
52 | + protected $_form_submission_error_message = ''; |
|
53 | + |
|
54 | + /** |
|
55 | + * @var array like $_REQUEST |
|
56 | + */ |
|
57 | + protected $cached_request_data; |
|
58 | + |
|
59 | + /** |
|
60 | + * Stores whether this form (and its sub-sections) were found to be valid or not. |
|
61 | + * Starts off as null, but once the form is validated, it set to either true or false |
|
62 | + * @var boolean|null |
|
63 | + */ |
|
64 | + protected $is_valid; |
|
65 | + |
|
66 | + /** |
|
67 | + * Stores all the data that will localized for form validation |
|
68 | + * |
|
69 | + * @var array |
|
70 | + */ |
|
71 | + static protected $_js_localization = array(); |
|
72 | + |
|
73 | + /** |
|
74 | + * whether or not the form's localized validation JS vars have been set |
|
75 | + * |
|
76 | + * @type boolean |
|
77 | + */ |
|
78 | + static protected $_scripts_localized = false; |
|
79 | + |
|
80 | + |
|
81 | + /** |
|
82 | + * when constructing a proper form section, calls _construct_finalize on children |
|
83 | + * so that they know who their parent is, and what name they've been given. |
|
84 | + * |
|
85 | + * @param array[] $options_array { |
|
86 | + * @type $subsections EE_Form_Section_Validatable[] where keys are the section's name |
|
87 | + * @type $include string[] numerically-indexed where values are section names to be included, |
|
88 | + * and in that order. This is handy if you want |
|
89 | + * the subsections to be ordered differently than the default, and if you override |
|
90 | + * which fields are shown |
|
91 | + * @type $exclude string[] values are subsections to be excluded. This is handy if you want |
|
92 | + * to remove certain default subsections (note: if you specify BOTH 'include' AND |
|
93 | + * 'exclude', the inclusions will be applied first, and the exclusions will exclude |
|
94 | + * items from that list of inclusions) |
|
95 | + * @type $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form |
|
96 | + * } @see EE_Form_Section_Validatable::__construct() |
|
97 | + * @throws EE_Error |
|
98 | + */ |
|
99 | + public function __construct($options_array = array()) |
|
100 | + { |
|
101 | + $options_array = (array) apply_filters( |
|
102 | + 'FHEE__EE_Form_Section_Proper___construct__options_array', |
|
103 | + $options_array, |
|
104 | + $this |
|
105 | + ); |
|
106 | + // call parent first, as it may be setting the name |
|
107 | + parent::__construct($options_array); |
|
108 | + // if they've included subsections in the constructor, add them now |
|
109 | + if (isset($options_array['include'])) { |
|
110 | + // we are going to make sure we ONLY have those subsections to include |
|
111 | + // AND we are going to make sure they're in that specified order |
|
112 | + $reordered_subsections = array(); |
|
113 | + foreach ($options_array['include'] as $input_name) { |
|
114 | + if (isset($this->_subsections[ $input_name ])) { |
|
115 | + $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ]; |
|
116 | + } |
|
117 | + } |
|
118 | + $this->_subsections = $reordered_subsections; |
|
119 | + } |
|
120 | + if (isset($options_array['exclude'])) { |
|
121 | + $exclude = $options_array['exclude']; |
|
122 | + $this->_subsections = array_diff_key($this->_subsections, array_flip($exclude)); |
|
123 | + } |
|
124 | + if (isset($options_array['layout_strategy'])) { |
|
125 | + $this->_layout_strategy = $options_array['layout_strategy']; |
|
126 | + } |
|
127 | + if (! $this->_layout_strategy) { |
|
128 | + $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout(); |
|
129 | + } |
|
130 | + $this->_layout_strategy->_construct_finalize($this); |
|
131 | + // ok so we are definitely going to want the forms JS, |
|
132 | + // so enqueue it or remember to enqueue it during wp_enqueue_scripts |
|
133 | + if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) { |
|
134 | + // ok so they've constructed this object after when they should have. |
|
135 | + // just enqueue the generic form scripts and initialize the form immediately in the JS |
|
136 | + EE_Form_Section_Proper::wp_enqueue_scripts(true); |
|
137 | + } else { |
|
138 | + add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts')); |
|
139 | + add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts')); |
|
140 | + } |
|
141 | + add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1); |
|
142 | + /** |
|
143 | + * Gives other plugins a chance to hook in before construct finalize is called. |
|
144 | + * The form probably doesn't yet have a parent form section. |
|
145 | + * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form, |
|
146 | + * assuming you don't care what the form section's name, HTML ID, or HTML name etc are. |
|
147 | + * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end |
|
148 | + * |
|
149 | + * @since 4.9.32 |
|
150 | + * @param EE_Form_Section_Proper $this before __construct is done, but all of its logic, |
|
151 | + * except maybe calling _construct_finalize has been done |
|
152 | + * @param array $options_array options passed into the constructor |
|
153 | + */ |
|
154 | + do_action( |
|
155 | + 'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called', |
|
156 | + $this, |
|
157 | + $options_array |
|
158 | + ); |
|
159 | + if (isset($options_array['name'])) { |
|
160 | + $this->_construct_finalize(null, $options_array['name']); |
|
161 | + } |
|
162 | + } |
|
163 | + |
|
164 | + |
|
165 | + /** |
|
166 | + * Finishes construction given the parent form section and this form section's name |
|
167 | + * |
|
168 | + * @param EE_Form_Section_Proper $parent_form_section |
|
169 | + * @param string $name |
|
170 | + * @throws EE_Error |
|
171 | + */ |
|
172 | + public function _construct_finalize($parent_form_section, $name) |
|
173 | + { |
|
174 | + parent::_construct_finalize($parent_form_section, $name); |
|
175 | + $this->_set_default_name_if_empty(); |
|
176 | + $this->_set_default_html_id_if_empty(); |
|
177 | + foreach ($this->_subsections as $subsection_name => $subsection) { |
|
178 | + if ($subsection instanceof EE_Form_Section_Base) { |
|
179 | + $subsection->_construct_finalize($this, $subsection_name); |
|
180 | + } else { |
|
181 | + throw new EE_Error( |
|
182 | + sprintf( |
|
183 | + esc_html__( |
|
184 | + 'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"', |
|
185 | + 'event_espresso' |
|
186 | + ), |
|
187 | + $subsection_name, |
|
188 | + get_class($this), |
|
189 | + $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso') |
|
190 | + ) |
|
191 | + ); |
|
192 | + } |
|
193 | + } |
|
194 | + /** |
|
195 | + * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed. |
|
196 | + * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID |
|
197 | + * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done. |
|
198 | + * This might only happen just before displaying the form, or just before it receives form submission data. |
|
199 | + * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've |
|
200 | + * ensured it has a name, HTML IDs, etc |
|
201 | + * |
|
202 | + * @param EE_Form_Section_Proper $this |
|
203 | + * @param EE_Form_Section_Proper|null $parent_form_section |
|
204 | + * @param string $name |
|
205 | + */ |
|
206 | + do_action( |
|
207 | + 'AHEE__EE_Form_Section_Proper___construct_finalize__end', |
|
208 | + $this, |
|
209 | + $parent_form_section, |
|
210 | + $name |
|
211 | + ); |
|
212 | + } |
|
213 | + |
|
214 | + |
|
215 | + /** |
|
216 | + * Gets the layout strategy for this form section |
|
217 | + * |
|
218 | + * @return EE_Form_Section_Layout_Base |
|
219 | + */ |
|
220 | + public function get_layout_strategy() |
|
221 | + { |
|
222 | + return $this->_layout_strategy; |
|
223 | + } |
|
224 | + |
|
225 | + |
|
226 | + /** |
|
227 | + * Gets the HTML for a single input for this form section according |
|
228 | + * to the layout strategy |
|
229 | + * |
|
230 | + * @param EE_Form_Input_Base $input |
|
231 | + * @return string |
|
232 | + */ |
|
233 | + public function get_html_for_input($input) |
|
234 | + { |
|
235 | + return $this->_layout_strategy->layout_input($input); |
|
236 | + } |
|
237 | + |
|
238 | + |
|
239 | + /** |
|
240 | + * was_submitted - checks if form inputs are present in request data |
|
241 | + * Basically an alias for form_data_present_in() (which is used by both |
|
242 | + * proper form sections and form inputs) |
|
243 | + * |
|
244 | + * @param null $form_data |
|
245 | + * @return boolean |
|
246 | + * @throws EE_Error |
|
247 | + */ |
|
248 | + public function was_submitted($form_data = null) |
|
249 | + { |
|
250 | + return $this->form_data_present_in($form_data); |
|
251 | + } |
|
252 | + |
|
253 | + /** |
|
254 | + * Gets the cached request data; but if there is none, or $req_data was set with |
|
255 | + * something different, refresh the cache, and then return it |
|
256 | + * @param null $req_data |
|
257 | + * @return array |
|
258 | + */ |
|
259 | + protected function getCachedRequest($req_data = null) |
|
260 | + { |
|
261 | + if ($this->cached_request_data === null |
|
262 | + || ( |
|
263 | + $req_data !== null && |
|
264 | + $req_data !== $this->cached_request_data |
|
265 | + ) |
|
266 | + ) { |
|
267 | + $req_data = apply_filters( |
|
268 | + 'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', |
|
269 | + $req_data, |
|
270 | + $this |
|
271 | + ); |
|
272 | + if ($req_data === null) { |
|
273 | + $req_data = array_merge($_GET, $_POST); |
|
274 | + } |
|
275 | + $req_data = apply_filters( |
|
276 | + 'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data', |
|
277 | + $req_data, |
|
278 | + $this |
|
279 | + ); |
|
280 | + $this->cached_request_data = (array) $req_data; |
|
281 | + } |
|
282 | + return $this->cached_request_data; |
|
283 | + } |
|
284 | + |
|
285 | + |
|
286 | + /** |
|
287 | + * After the form section is initially created, call this to sanitize the data in the submission |
|
288 | + * which relates to this form section, validate it, and set it as properties on the form. |
|
289 | + * |
|
290 | + * @param array|null $req_data should usually be $_POST (the default). |
|
291 | + * However, you CAN supply a different array. |
|
292 | + * Consider using set_defaults() instead however. |
|
293 | + * (If you rendered the form in the page using echo $form_x->get_html() |
|
294 | + * the inputs will have the correct name in the request data for this function |
|
295 | + * to find them and populate the form with them. |
|
296 | + * If you have a flat form (with only input subsections), |
|
297 | + * you can supply a flat array where keys |
|
298 | + * are the form input names and values are their values) |
|
299 | + * @param boolean $validate whether or not to perform validation on this data. Default is, |
|
300 | + * of course, to validate that data, and set errors on the invalid values. |
|
301 | + * But if the data has already been validated |
|
302 | + * (eg you validated the data then stored it in the DB) |
|
303 | + * you may want to skip this step. |
|
304 | + * @throws InvalidArgumentException |
|
305 | + * @throws InvalidInterfaceException |
|
306 | + * @throws InvalidDataTypeException |
|
307 | + * @throws EE_Error |
|
308 | + */ |
|
309 | + public function receive_form_submission($req_data = null, $validate = true) |
|
310 | + { |
|
311 | + $req_data = $this->getCachedRequest($req_data); |
|
312 | + $this->_normalize($req_data); |
|
313 | + if ($validate) { |
|
314 | + $this->_validate(); |
|
315 | + // if it's invalid, we're going to want to re-display so remember what they submitted |
|
316 | + if (! $this->is_valid()) { |
|
317 | + $this->store_submitted_form_data_in_session(); |
|
318 | + } |
|
319 | + } |
|
320 | + if ($this->submission_error_message() === '' && ! $this->is_valid()) { |
|
321 | + $this->set_submission_error_message(); |
|
322 | + } |
|
323 | + do_action( |
|
324 | + 'AHEE__EE_Form_Section_Proper__receive_form_submission__end', |
|
325 | + $req_data, |
|
326 | + $this, |
|
327 | + $validate |
|
328 | + ); |
|
329 | + } |
|
330 | + |
|
331 | + |
|
332 | + /** |
|
333 | + * caches the originally submitted input values in the session |
|
334 | + * so that they can be used to repopulate the form if it failed validation |
|
335 | + * |
|
336 | + * @return boolean whether or not the data was successfully stored in the session |
|
337 | + * @throws InvalidArgumentException |
|
338 | + * @throws InvalidInterfaceException |
|
339 | + * @throws InvalidDataTypeException |
|
340 | + * @throws EE_Error |
|
341 | + */ |
|
342 | + protected function store_submitted_form_data_in_session() |
|
343 | + { |
|
344 | + return EE_Registry::instance()->SSN->set_session_data( |
|
345 | + array( |
|
346 | + EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true), |
|
347 | + ) |
|
348 | + ); |
|
349 | + } |
|
350 | + |
|
351 | + |
|
352 | + /** |
|
353 | + * retrieves the originally submitted input values in the session |
|
354 | + * so that they can be used to repopulate the form if it failed validation |
|
355 | + * |
|
356 | + * @return array |
|
357 | + * @throws InvalidArgumentException |
|
358 | + * @throws InvalidInterfaceException |
|
359 | + * @throws InvalidDataTypeException |
|
360 | + */ |
|
361 | + protected function get_submitted_form_data_from_session() |
|
362 | + { |
|
363 | + $session = EE_Registry::instance()->SSN; |
|
364 | + if ($session instanceof EE_Session) { |
|
365 | + return $session->get_session_data( |
|
366 | + EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY |
|
367 | + ); |
|
368 | + } |
|
369 | + return array(); |
|
370 | + } |
|
371 | + |
|
372 | + |
|
373 | + /** |
|
374 | + * flushed the originally submitted input values from the session |
|
375 | + * |
|
376 | + * @return boolean whether or not the data was successfully removed from the session |
|
377 | + * @throws InvalidArgumentException |
|
378 | + * @throws InvalidInterfaceException |
|
379 | + * @throws InvalidDataTypeException |
|
380 | + */ |
|
381 | + public static function flush_submitted_form_data_from_session() |
|
382 | + { |
|
383 | + return EE_Registry::instance()->SSN->reset_data( |
|
384 | + array(EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY) |
|
385 | + ); |
|
386 | + } |
|
387 | + |
|
388 | + |
|
389 | + /** |
|
390 | + * Populates this form and its subsections with data from the session. |
|
391 | + * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows |
|
392 | + * validation errors when displaying too) |
|
393 | + * Returns true if the form was populated from the session, false otherwise |
|
394 | + * |
|
395 | + * @return boolean |
|
396 | + * @throws InvalidArgumentException |
|
397 | + * @throws InvalidInterfaceException |
|
398 | + * @throws InvalidDataTypeException |
|
399 | + * @throws EE_Error |
|
400 | + */ |
|
401 | + public function populate_from_session() |
|
402 | + { |
|
403 | + $form_data_in_session = $this->get_submitted_form_data_from_session(); |
|
404 | + if (empty($form_data_in_session)) { |
|
405 | + return false; |
|
406 | + } |
|
407 | + $this->receive_form_submission($form_data_in_session); |
|
408 | + add_action('shutdown', array('EE_Form_Section_Proper', 'flush_submitted_form_data_from_session')); |
|
409 | + if ($this->form_data_present_in($form_data_in_session)) { |
|
410 | + return true; |
|
411 | + } |
|
412 | + return false; |
|
413 | + } |
|
414 | + |
|
415 | + |
|
416 | + /** |
|
417 | + * Populates the default data for the form, given an array where keys are |
|
418 | + * the input names, and values are their values (preferably normalized to be their |
|
419 | + * proper PHP types, not all strings... although that should be ok too). |
|
420 | + * Proper subsections are sub-arrays, the key being the subsection's name, and |
|
421 | + * the value being an array formatted in teh same way |
|
422 | + * |
|
423 | + * @param array $default_data |
|
424 | + * @throws EE_Error |
|
425 | + */ |
|
426 | + public function populate_defaults($default_data) |
|
427 | + { |
|
428 | + foreach ($this->subsections(false) as $subsection_name => $subsection) { |
|
429 | + if (isset($default_data[ $subsection_name ])) { |
|
430 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
431 | + $subsection->set_default($default_data[ $subsection_name ]); |
|
432 | + } elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
433 | + $subsection->populate_defaults($default_data[ $subsection_name ]); |
|
434 | + } |
|
435 | + } |
|
436 | + } |
|
437 | + } |
|
438 | + |
|
439 | + |
|
440 | + /** |
|
441 | + * returns true if subsection exists |
|
442 | + * |
|
443 | + * @param string $name |
|
444 | + * @return boolean |
|
445 | + */ |
|
446 | + public function subsection_exists($name) |
|
447 | + { |
|
448 | + return isset($this->_subsections[ $name ]) ? true : false; |
|
449 | + } |
|
450 | + |
|
451 | + |
|
452 | + /** |
|
453 | + * Gets the subsection specified by its name |
|
454 | + * |
|
455 | + * @param string $name |
|
456 | + * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE |
|
457 | + * so that the inputs will be properly configured. |
|
458 | + * However, some client code may be ok |
|
459 | + * with construction finalize being called later |
|
460 | + * (realizing that the subsections' html names |
|
461 | + * might not be set yet, etc.) |
|
462 | + * @return EE_Form_Section_Base |
|
463 | + * @throws EE_Error |
|
464 | + */ |
|
465 | + public function get_subsection($name, $require_construction_to_be_finalized = true) |
|
466 | + { |
|
467 | + if ($require_construction_to_be_finalized) { |
|
468 | + $this->ensure_construct_finalized_called(); |
|
469 | + } |
|
470 | + return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null; |
|
471 | + } |
|
472 | + |
|
473 | + |
|
474 | + /** |
|
475 | + * Gets all the validatable subsections of this form section |
|
476 | + * |
|
477 | + * @return EE_Form_Section_Validatable[] |
|
478 | + * @throws EE_Error |
|
479 | + */ |
|
480 | + public function get_validatable_subsections() |
|
481 | + { |
|
482 | + $validatable_subsections = array(); |
|
483 | + foreach ($this->subsections() as $name => $obj) { |
|
484 | + if ($obj instanceof EE_Form_Section_Validatable) { |
|
485 | + $validatable_subsections[ $name ] = $obj; |
|
486 | + } |
|
487 | + } |
|
488 | + return $validatable_subsections; |
|
489 | + } |
|
490 | + |
|
491 | + |
|
492 | + /** |
|
493 | + * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child, |
|
494 | + * throw an EE_Error. |
|
495 | + * |
|
496 | + * @param string $name |
|
497 | + * @param boolean $require_construction_to_be_finalized most client code should |
|
498 | + * leave this as TRUE so that the inputs will be properly |
|
499 | + * configured. However, some client code may be ok with |
|
500 | + * construction finalize being called later |
|
501 | + * (realizing that the subsections' html names might not be |
|
502 | + * set yet, etc.) |
|
503 | + * @return EE_Form_Input_Base |
|
504 | + * @throws EE_Error |
|
505 | + */ |
|
506 | + public function get_input($name, $require_construction_to_be_finalized = true) |
|
507 | + { |
|
508 | + $subsection = $this->get_subsection( |
|
509 | + $name, |
|
510 | + $require_construction_to_be_finalized |
|
511 | + ); |
|
512 | + if (! $subsection instanceof EE_Form_Input_Base) { |
|
513 | + throw new EE_Error( |
|
514 | + sprintf( |
|
515 | + esc_html__( |
|
516 | + "Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'", |
|
517 | + 'event_espresso' |
|
518 | + ), |
|
519 | + $name, |
|
520 | + get_class($this), |
|
521 | + $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso') |
|
522 | + ) |
|
523 | + ); |
|
524 | + } |
|
525 | + return $subsection; |
|
526 | + } |
|
527 | + |
|
528 | + |
|
529 | + /** |
|
530 | + * Like get_input(), gets the proper subsection of the form given the name, |
|
531 | + * otherwise throws an EE_Error |
|
532 | + * |
|
533 | + * @param string $name |
|
534 | + * @param boolean $require_construction_to_be_finalized most client code should |
|
535 | + * leave this as TRUE so that the inputs will be properly |
|
536 | + * configured. However, some client code may be ok with |
|
537 | + * construction finalize being called later |
|
538 | + * (realizing that the subsections' html names might not be |
|
539 | + * set yet, etc.) |
|
540 | + * @return EE_Form_Section_Proper |
|
541 | + * @throws EE_Error |
|
542 | + */ |
|
543 | + public function get_proper_subsection($name, $require_construction_to_be_finalized = true) |
|
544 | + { |
|
545 | + $subsection = $this->get_subsection( |
|
546 | + $name, |
|
547 | + $require_construction_to_be_finalized |
|
548 | + ); |
|
549 | + if (! $subsection instanceof EE_Form_Section_Proper) { |
|
550 | + throw new EE_Error( |
|
551 | + sprintf( |
|
552 | + esc_html__( |
|
553 | + "Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'", |
|
554 | + 'event_espresso' |
|
555 | + ), |
|
556 | + $name, |
|
557 | + get_class($this) |
|
558 | + ) |
|
559 | + ); |
|
560 | + } |
|
561 | + return $subsection; |
|
562 | + } |
|
563 | + |
|
564 | + |
|
565 | + /** |
|
566 | + * Gets the value of the specified input. Should be called after receive_form_submission() |
|
567 | + * or populate_defaults() on the form, where the normalized value on the input is set. |
|
568 | + * |
|
569 | + * @param string $name |
|
570 | + * @return mixed depending on the input's type and its normalization strategy |
|
571 | + * @throws EE_Error |
|
572 | + */ |
|
573 | + public function get_input_value($name) |
|
574 | + { |
|
575 | + $input = $this->get_input($name); |
|
576 | + return $input->normalized_value(); |
|
577 | + } |
|
578 | + |
|
579 | + |
|
580 | + /** |
|
581 | + * Checks if this form section itself is valid, and then checks its subsections |
|
582 | + * |
|
583 | + * @throws EE_Error |
|
584 | + * @return boolean |
|
585 | + */ |
|
586 | + public function is_valid() |
|
587 | + { |
|
588 | + if ($this->is_valid === null) { |
|
589 | + if (! $this->has_received_submission()) { |
|
590 | + throw new EE_Error( |
|
591 | + sprintf( |
|
592 | + esc_html__( |
|
593 | + 'You cannot check if a form is valid before receiving the form submission using receive_form_submission', |
|
594 | + 'event_espresso' |
|
595 | + ) |
|
596 | + ) |
|
597 | + ); |
|
598 | + } |
|
599 | + if (! parent::is_valid()) { |
|
600 | + $this->is_valid = false; |
|
601 | + } else { |
|
602 | + // ok so no general errors to this entire form section. |
|
603 | + // so let's check the subsections, but only set errors if that hasn't been done yet |
|
604 | + $this->is_valid = true; |
|
605 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
606 | + if (! $subsection->is_valid()) { |
|
607 | + $this->is_valid = false; |
|
608 | + } |
|
609 | + } |
|
610 | + } |
|
611 | + } |
|
612 | + return $this->is_valid; |
|
613 | + } |
|
614 | + |
|
615 | + |
|
616 | + /** |
|
617 | + * gets the default name of this form section if none is specified |
|
618 | + * |
|
619 | + * @return void |
|
620 | + */ |
|
621 | + protected function _set_default_name_if_empty() |
|
622 | + { |
|
623 | + if (! $this->_name) { |
|
624 | + $classname = get_class($this); |
|
625 | + $default_name = str_replace('EE_', '', $classname); |
|
626 | + $this->_name = $default_name; |
|
627 | + } |
|
628 | + } |
|
629 | + |
|
630 | + |
|
631 | + /** |
|
632 | + * Returns the HTML for the form, except for the form opening and closing tags |
|
633 | + * (as the form section doesn't know where you necessarily want to send the information to), |
|
634 | + * and except for a submit button. Enqueues JS and CSS; if called early enough we will |
|
635 | + * try to enqueue them in the header, otherwise they'll be enqueued in the footer. |
|
636 | + * Not doing_it_wrong because theoretically this CAN be used properly, |
|
637 | + * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue |
|
638 | + * any CSS. |
|
639 | + * |
|
640 | + * @throws InvalidArgumentException |
|
641 | + * @throws InvalidInterfaceException |
|
642 | + * @throws InvalidDataTypeException |
|
643 | + * @throws EE_Error |
|
644 | + */ |
|
645 | + public function get_html_and_js() |
|
646 | + { |
|
647 | + $this->enqueue_js(); |
|
648 | + return $this->get_html(); |
|
649 | + } |
|
650 | + |
|
651 | + |
|
652 | + /** |
|
653 | + * returns HTML for displaying this form section. recursively calls display_section() on all subsections |
|
654 | + * |
|
655 | + * @param bool $display_previously_submitted_data |
|
656 | + * @return string |
|
657 | + * @throws InvalidArgumentException |
|
658 | + * @throws InvalidInterfaceException |
|
659 | + * @throws InvalidDataTypeException |
|
660 | + * @throws EE_Error |
|
661 | + * @throws EE_Error |
|
662 | + * @throws EE_Error |
|
663 | + */ |
|
664 | + public function get_html($display_previously_submitted_data = true) |
|
665 | + { |
|
666 | + $this->ensure_construct_finalized_called(); |
|
667 | + if ($display_previously_submitted_data) { |
|
668 | + $this->populate_from_session(); |
|
669 | + } |
|
670 | + return $this->_form_html_filter |
|
671 | + ? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this) |
|
672 | + : $this->_layout_strategy->layout_form(); |
|
673 | + } |
|
674 | + |
|
675 | + |
|
676 | + /** |
|
677 | + * enqueues JS and CSS for the form. |
|
678 | + * It is preferred to call this before wp_enqueue_scripts so the |
|
679 | + * scripts and styles can be put in the header, but if called later |
|
680 | + * they will be put in the footer (which is OK for JS, but in HTML4 CSS should |
|
681 | + * only be in the header; but in HTML5 its ok in the body. |
|
682 | + * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag. |
|
683 | + * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.) |
|
684 | + * |
|
685 | + * @return void |
|
686 | + * @throws EE_Error |
|
687 | + */ |
|
688 | + public function enqueue_js() |
|
689 | + { |
|
690 | + $this->_enqueue_and_localize_form_js(); |
|
691 | + foreach ($this->subsections() as $subsection) { |
|
692 | + $subsection->enqueue_js(); |
|
693 | + } |
|
694 | + } |
|
695 | + |
|
696 | + |
|
697 | + /** |
|
698 | + * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts(). |
|
699 | + * This must be done BEFORE wp_enqueue_scripts() gets called, which is on |
|
700 | + * the wp_enqueue_scripts hook. |
|
701 | + * However, registering the form js and localizing it can happen when we |
|
702 | + * actually output the form (which is preferred, seeing how teh form's fields |
|
703 | + * could change until it's actually outputted) |
|
704 | + * |
|
705 | + * @param boolean $init_form_validation_automatically whether or not we want the form validation |
|
706 | + * to be triggered automatically or not |
|
707 | + * @return void |
|
708 | + */ |
|
709 | + public static function wp_enqueue_scripts($init_form_validation_automatically = true) |
|
710 | + { |
|
711 | + wp_register_script( |
|
712 | + 'ee_form_section_validation', |
|
713 | + EE_GLOBAL_ASSETS_URL . 'scripts' . '/form_section_validation.js', |
|
714 | + array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'), |
|
715 | + EVENT_ESPRESSO_VERSION, |
|
716 | + true |
|
717 | + ); |
|
718 | + wp_localize_script( |
|
719 | + 'ee_form_section_validation', |
|
720 | + 'ee_form_section_validation_init', |
|
721 | + array('init' => $init_form_validation_automatically ? '1' : '0') |
|
722 | + ); |
|
723 | + } |
|
724 | + |
|
725 | + |
|
726 | + /** |
|
727 | + * gets the variables used by form_section_validation.js. |
|
728 | + * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script, |
|
729 | + * but before the wordpress hook wp_loaded |
|
730 | + * |
|
731 | + * @throws EE_Error |
|
732 | + */ |
|
733 | + public function _enqueue_and_localize_form_js() |
|
734 | + { |
|
735 | + $this->ensure_construct_finalized_called(); |
|
736 | + // actually, we don't want to localize just yet. There may be other forms on the page. |
|
737 | + // so we need to add our form section data to a static variable accessible by all form sections |
|
738 | + // and localize it just before the footer |
|
739 | + $this->localize_validation_rules(); |
|
740 | + add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2); |
|
741 | + add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms')); |
|
742 | + } |
|
743 | + |
|
744 | + |
|
745 | + /** |
|
746 | + * add our form section data to a static variable accessible by all form sections |
|
747 | + * |
|
748 | + * @param bool $return_for_subsection |
|
749 | + * @return void |
|
750 | + * @throws EE_Error |
|
751 | + */ |
|
752 | + public function localize_validation_rules($return_for_subsection = false) |
|
753 | + { |
|
754 | + // we only want to localize vars ONCE for the entire form, |
|
755 | + // so if the form section doesn't have a parent, then it must be the top dog |
|
756 | + if ($return_for_subsection || ! $this->parent_section()) { |
|
757 | + EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array( |
|
758 | + 'form_section_id' => $this->html_id(true), |
|
759 | + 'validation_rules' => $this->get_jquery_validation_rules(), |
|
760 | + 'other_data' => $this->get_other_js_data(), |
|
761 | + 'errors' => $this->subsection_validation_errors_by_html_name(), |
|
762 | + ); |
|
763 | + EE_Form_Section_Proper::$_scripts_localized = true; |
|
764 | + } |
|
765 | + } |
|
766 | + |
|
767 | + |
|
768 | + /** |
|
769 | + * Gets an array of extra data that will be useful for client-side javascript. |
|
770 | + * This is primarily data added by inputs and forms in addition to any |
|
771 | + * scripts they might enqueue |
|
772 | + * |
|
773 | + * @param array $form_other_js_data |
|
774 | + * @return array |
|
775 | + * @throws EE_Error |
|
776 | + */ |
|
777 | + public function get_other_js_data($form_other_js_data = array()) |
|
778 | + { |
|
779 | + foreach ($this->subsections() as $subsection) { |
|
780 | + $form_other_js_data = $subsection->get_other_js_data($form_other_js_data); |
|
781 | + } |
|
782 | + return $form_other_js_data; |
|
783 | + } |
|
784 | + |
|
785 | + |
|
786 | + /** |
|
787 | + * Gets a flat array of inputs for this form section and its subsections. |
|
788 | + * Keys are their form names, and values are the inputs themselves |
|
789 | + * |
|
790 | + * @return EE_Form_Input_Base |
|
791 | + * @throws EE_Error |
|
792 | + */ |
|
793 | + public function inputs_in_subsections() |
|
794 | + { |
|
795 | + $inputs = array(); |
|
796 | + foreach ($this->subsections() as $subsection) { |
|
797 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
798 | + $inputs[ $subsection->html_name() ] = $subsection; |
|
799 | + } elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
800 | + $inputs += $subsection->inputs_in_subsections(); |
|
801 | + } |
|
802 | + } |
|
803 | + return $inputs; |
|
804 | + } |
|
805 | + |
|
806 | + |
|
807 | + /** |
|
808 | + * Gets a flat array of all the validation errors. |
|
809 | + * Keys are html names (because those should be unique) |
|
810 | + * and values are a string of all their validation errors |
|
811 | + * |
|
812 | + * @return string[] |
|
813 | + * @throws EE_Error |
|
814 | + */ |
|
815 | + public function subsection_validation_errors_by_html_name() |
|
816 | + { |
|
817 | + $inputs = $this->inputs(); |
|
818 | + $errors = array(); |
|
819 | + foreach ($inputs as $form_input) { |
|
820 | + if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) { |
|
821 | + $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string(); |
|
822 | + } |
|
823 | + } |
|
824 | + return $errors; |
|
825 | + } |
|
826 | + |
|
827 | + |
|
828 | + /** |
|
829 | + * passes all the form data required by the JS to the JS, and enqueues the few required JS files. |
|
830 | + * Should be setup by each form during the _enqueues_and_localize_form_js |
|
831 | + * |
|
832 | + * @throws InvalidArgumentException |
|
833 | + * @throws InvalidInterfaceException |
|
834 | + * @throws InvalidDataTypeException |
|
835 | + */ |
|
836 | + public static function localize_script_for_all_forms() |
|
837 | + { |
|
838 | + // allow inputs and stuff to hook in their JS and stuff here |
|
839 | + do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin'); |
|
840 | + EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages(); |
|
841 | + $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level) |
|
842 | + ? EE_Registry::instance()->CFG->registration->email_validation_level |
|
843 | + : 'wp_default'; |
|
844 | + EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level; |
|
845 | + wp_enqueue_script('ee_form_section_validation'); |
|
846 | + wp_localize_script( |
|
847 | + 'ee_form_section_validation', |
|
848 | + 'ee_form_section_vars', |
|
849 | + EE_Form_Section_Proper::$_js_localization |
|
850 | + ); |
|
851 | + } |
|
852 | + |
|
853 | + |
|
854 | + /** |
|
855 | + * ensure_scripts_localized |
|
856 | + * |
|
857 | + * @throws EE_Error |
|
858 | + */ |
|
859 | + public function ensure_scripts_localized() |
|
860 | + { |
|
861 | + if (! EE_Form_Section_Proper::$_scripts_localized) { |
|
862 | + $this->_enqueue_and_localize_form_js(); |
|
863 | + } |
|
864 | + } |
|
865 | + |
|
866 | + |
|
867 | + /** |
|
868 | + * Gets the hard-coded validation error messages to be used in the JS. The convention |
|
869 | + * is that the key here should be the same as the custom validation rule put in the JS file |
|
870 | + * |
|
871 | + * @return array keys are custom validation rules, and values are internationalized strings |
|
872 | + */ |
|
873 | + private static function _get_localized_error_messages() |
|
874 | + { |
|
875 | + return array( |
|
876 | + 'validUrl' => esc_html__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso'), |
|
877 | + 'regex' => esc_html__('Please check your input', 'event_espresso'), |
|
878 | + ); |
|
879 | + } |
|
880 | + |
|
881 | + |
|
882 | + /** |
|
883 | + * @return array |
|
884 | + */ |
|
885 | + public static function js_localization() |
|
886 | + { |
|
887 | + return self::$_js_localization; |
|
888 | + } |
|
889 | + |
|
890 | + |
|
891 | + /** |
|
892 | + * @return void |
|
893 | + */ |
|
894 | + public static function reset_js_localization() |
|
895 | + { |
|
896 | + self::$_js_localization = array(); |
|
897 | + } |
|
898 | + |
|
899 | + |
|
900 | + /** |
|
901 | + * Gets the JS to put inside the jquery validation rules for subsection of this form section. |
|
902 | + * See parent function for more... |
|
903 | + * |
|
904 | + * @return array |
|
905 | + * @throws EE_Error |
|
906 | + */ |
|
907 | + public function get_jquery_validation_rules() |
|
908 | + { |
|
909 | + $jquery_validation_rules = array(); |
|
910 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
911 | + $jquery_validation_rules = array_merge( |
|
912 | + $jquery_validation_rules, |
|
913 | + $subsection->get_jquery_validation_rules() |
|
914 | + ); |
|
915 | + } |
|
916 | + return $jquery_validation_rules; |
|
917 | + } |
|
918 | + |
|
919 | + |
|
920 | + /** |
|
921 | + * Sanitizes all the data and sets the sanitized value of each field |
|
922 | + * |
|
923 | + * @param array $req_data like $_POST |
|
924 | + * @return void |
|
925 | + * @throws EE_Error |
|
926 | + */ |
|
927 | + protected function _normalize($req_data) |
|
928 | + { |
|
929 | + $this->_received_submission = true; |
|
930 | + $this->_validation_errors = array(); |
|
931 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
932 | + try { |
|
933 | + $subsection->_normalize($req_data); |
|
934 | + } catch (EE_Validation_Error $e) { |
|
935 | + $subsection->add_validation_error($e); |
|
936 | + } |
|
937 | + } |
|
938 | + } |
|
939 | + |
|
940 | + |
|
941 | + /** |
|
942 | + * Performs validation on this form section and its subsections. |
|
943 | + * For each subsection, |
|
944 | + * calls _validate_{subsection_name} on THIS form (if the function exists) |
|
945 | + * and passes it the subsection, then calls _validate on that subsection. |
|
946 | + * If you need to perform validation on the form as a whole (considering multiple) |
|
947 | + * you would be best to override this _validate method, |
|
948 | + * calling parent::_validate() first. |
|
949 | + * |
|
950 | + * @throws EE_Error |
|
951 | + */ |
|
952 | + protected function _validate() |
|
953 | + { |
|
954 | + // reset the cache of whether this form is valid or not- we're re-validating it now |
|
955 | + $this->is_valid = null; |
|
956 | + foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) { |
|
957 | + if (method_exists($this, '_validate_' . $subsection_name)) { |
|
958 | + call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection)); |
|
959 | + } |
|
960 | + $subsection->_validate(); |
|
961 | + } |
|
962 | + } |
|
963 | + |
|
964 | + |
|
965 | + /** |
|
966 | + * Gets all the validated inputs for the form section |
|
967 | + * |
|
968 | + * @return array |
|
969 | + * @throws EE_Error |
|
970 | + */ |
|
971 | + public function valid_data() |
|
972 | + { |
|
973 | + $inputs = array(); |
|
974 | + foreach ($this->subsections() as $subsection_name => $subsection) { |
|
975 | + if ($subsection instanceof EE_Form_Section_Proper) { |
|
976 | + $inputs[ $subsection_name ] = $subsection->valid_data(); |
|
977 | + } elseif ($subsection instanceof EE_Form_Input_Base) { |
|
978 | + $inputs[ $subsection_name ] = $subsection->normalized_value(); |
|
979 | + } |
|
980 | + } |
|
981 | + return $inputs; |
|
982 | + } |
|
983 | + |
|
984 | + |
|
985 | + /** |
|
986 | + * Gets all the inputs on this form section |
|
987 | + * |
|
988 | + * @return EE_Form_Input_Base[] |
|
989 | + * @throws EE_Error |
|
990 | + */ |
|
991 | + public function inputs() |
|
992 | + { |
|
993 | + $inputs = array(); |
|
994 | + foreach ($this->subsections() as $subsection_name => $subsection) { |
|
995 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
996 | + $inputs[ $subsection_name ] = $subsection; |
|
997 | + } |
|
998 | + } |
|
999 | + return $inputs; |
|
1000 | + } |
|
1001 | + |
|
1002 | + |
|
1003 | + /** |
|
1004 | + * Gets all the subsections which are a proper form |
|
1005 | + * |
|
1006 | + * @return EE_Form_Section_Proper[] |
|
1007 | + * @throws EE_Error |
|
1008 | + */ |
|
1009 | + public function subforms() |
|
1010 | + { |
|
1011 | + $form_sections = array(); |
|
1012 | + foreach ($this->subsections() as $name => $obj) { |
|
1013 | + if ($obj instanceof EE_Form_Section_Proper) { |
|
1014 | + $form_sections[ $name ] = $obj; |
|
1015 | + } |
|
1016 | + } |
|
1017 | + return $form_sections; |
|
1018 | + } |
|
1019 | + |
|
1020 | + |
|
1021 | + /** |
|
1022 | + * Gets all the subsections (inputs, proper subsections, or html-only sections). |
|
1023 | + * Consider using inputs() or subforms() |
|
1024 | + * if you only want form inputs or proper form sections. |
|
1025 | + * |
|
1026 | + * @param boolean $require_construction_to_be_finalized most client code should |
|
1027 | + * leave this as TRUE so that the inputs will be properly |
|
1028 | + * configured. However, some client code may be ok with |
|
1029 | + * construction finalize being called later |
|
1030 | + * (realizing that the subsections' html names might not be |
|
1031 | + * set yet, etc.) |
|
1032 | + * @return EE_Form_Section_Proper[] |
|
1033 | + * @throws EE_Error |
|
1034 | + */ |
|
1035 | + public function subsections($require_construction_to_be_finalized = true) |
|
1036 | + { |
|
1037 | + if ($require_construction_to_be_finalized) { |
|
1038 | + $this->ensure_construct_finalized_called(); |
|
1039 | + } |
|
1040 | + return $this->_subsections; |
|
1041 | + } |
|
1042 | + |
|
1043 | + |
|
1044 | + /** |
|
1045 | + * Returns whether this form has any subforms or inputs |
|
1046 | + * @return bool |
|
1047 | + */ |
|
1048 | + public function hasSubsections() |
|
1049 | + { |
|
1050 | + return ! empty($this->_subsections); |
|
1051 | + } |
|
1052 | + |
|
1053 | + |
|
1054 | + /** |
|
1055 | + * Returns a simple array where keys are input names, and values are their normalized |
|
1056 | + * values. (Similar to calling get_input_value on inputs) |
|
1057 | + * |
|
1058 | + * @param boolean $include_subform_inputs Whether to include inputs from subforms, |
|
1059 | + * or just this forms' direct children inputs |
|
1060 | + * @param boolean $flatten Whether to force the results into 1-dimensional array, |
|
1061 | + * or allow multidimensional array |
|
1062 | + * @return array if $flatten is TRUE it will always be a 1-dimensional array |
|
1063 | + * with array keys being input names |
|
1064 | + * (regardless of whether they are from a subsection or not), |
|
1065 | + * and if $flatten is FALSE it can be a multidimensional array |
|
1066 | + * where keys are always subsection names and values are either |
|
1067 | + * the input's normalized value, or an array like the top-level array |
|
1068 | + * @throws EE_Error |
|
1069 | + */ |
|
1070 | + public function input_values($include_subform_inputs = false, $flatten = false) |
|
1071 | + { |
|
1072 | + return $this->_input_values(false, $include_subform_inputs, $flatten); |
|
1073 | + } |
|
1074 | + |
|
1075 | + |
|
1076 | + /** |
|
1077 | + * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value' |
|
1078 | + * of each input. On some inputs (especially radio boxes or checkboxes), the value stored |
|
1079 | + * is not necessarily the value we want to display to users. This creates an array |
|
1080 | + * where keys are the input names, and values are their display values |
|
1081 | + * |
|
1082 | + * @param boolean $include_subform_inputs Whether to include inputs from subforms, |
|
1083 | + * or just this forms' direct children inputs |
|
1084 | + * @param boolean $flatten Whether to force the results into 1-dimensional array, |
|
1085 | + * or allow multidimensional array |
|
1086 | + * @return array if $flatten is TRUE it will always be a 1-dimensional array |
|
1087 | + * with array keys being input names |
|
1088 | + * (regardless of whether they are from a subsection or not), |
|
1089 | + * and if $flatten is FALSE it can be a multidimensional array |
|
1090 | + * where keys are always subsection names and values are either |
|
1091 | + * the input's normalized value, or an array like the top-level array |
|
1092 | + * @throws EE_Error |
|
1093 | + */ |
|
1094 | + public function input_pretty_values($include_subform_inputs = false, $flatten = false) |
|
1095 | + { |
|
1096 | + return $this->_input_values(true, $include_subform_inputs, $flatten); |
|
1097 | + } |
|
1098 | + |
|
1099 | + |
|
1100 | + /** |
|
1101 | + * Gets the input values from the form |
|
1102 | + * |
|
1103 | + * @param boolean $pretty Whether to retrieve the pretty value, |
|
1104 | + * or just the normalized value |
|
1105 | + * @param boolean $include_subform_inputs Whether to include inputs from subforms, |
|
1106 | + * or just this forms' direct children inputs |
|
1107 | + * @param boolean $flatten Whether to force the results into 1-dimensional array, |
|
1108 | + * or allow multidimensional array |
|
1109 | + * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being |
|
1110 | + * input names (regardless of whether they are from a subsection or not), |
|
1111 | + * and if $flatten is FALSE it can be a multidimensional array |
|
1112 | + * where keys are always subsection names and values are either |
|
1113 | + * the input's normalized value, or an array like the top-level array |
|
1114 | + * @throws EE_Error |
|
1115 | + */ |
|
1116 | + public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false) |
|
1117 | + { |
|
1118 | + $input_values = array(); |
|
1119 | + foreach ($this->subsections() as $subsection_name => $subsection) { |
|
1120 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
1121 | + $input_values[ $subsection_name ] = $pretty |
|
1122 | + ? $subsection->pretty_value() |
|
1123 | + : $subsection->normalized_value(); |
|
1124 | + } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) { |
|
1125 | + $subform_input_values = $subsection->_input_values( |
|
1126 | + $pretty, |
|
1127 | + $include_subform_inputs, |
|
1128 | + $flatten |
|
1129 | + ); |
|
1130 | + if ($flatten) { |
|
1131 | + $input_values = array_merge($input_values, $subform_input_values); |
|
1132 | + } else { |
|
1133 | + $input_values[ $subsection_name ] = $subform_input_values; |
|
1134 | + } |
|
1135 | + } |
|
1136 | + } |
|
1137 | + return $input_values; |
|
1138 | + } |
|
1139 | + |
|
1140 | + |
|
1141 | + /** |
|
1142 | + * Gets the originally submitted input values from the form |
|
1143 | + * |
|
1144 | + * @param boolean $include_subforms Whether to include inputs from subforms, |
|
1145 | + * or just this forms' direct children inputs |
|
1146 | + * @return array if $flatten is TRUE it will always be a 1-dimensional array |
|
1147 | + * with array keys being input names |
|
1148 | + * (regardless of whether they are from a subsection or not), |
|
1149 | + * and if $flatten is FALSE it can be a multidimensional array |
|
1150 | + * where keys are always subsection names and values are either |
|
1151 | + * the input's normalized value, or an array like the top-level array |
|
1152 | + * @throws EE_Error |
|
1153 | + */ |
|
1154 | + public function submitted_values($include_subforms = false) |
|
1155 | + { |
|
1156 | + $submitted_values = array(); |
|
1157 | + foreach ($this->subsections() as $subsection) { |
|
1158 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
1159 | + // is this input part of an array of inputs? |
|
1160 | + if (strpos($subsection->html_name(), '[') !== false) { |
|
1161 | + $full_input_name = EEH_Array::convert_array_values_to_keys( |
|
1162 | + explode( |
|
1163 | + '[', |
|
1164 | + str_replace(']', '', $subsection->html_name()) |
|
1165 | + ), |
|
1166 | + $subsection->raw_value() |
|
1167 | + ); |
|
1168 | + $submitted_values = array_replace_recursive($submitted_values, $full_input_name); |
|
1169 | + } else { |
|
1170 | + $submitted_values[ $subsection->html_name() ] = $subsection->raw_value(); |
|
1171 | + } |
|
1172 | + } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) { |
|
1173 | + $subform_input_values = $subsection->submitted_values($include_subforms); |
|
1174 | + $submitted_values = array_replace_recursive($submitted_values, $subform_input_values); |
|
1175 | + } |
|
1176 | + } |
|
1177 | + return $submitted_values; |
|
1178 | + } |
|
1179 | + |
|
1180 | + |
|
1181 | + /** |
|
1182 | + * Indicates whether or not this form has received a submission yet |
|
1183 | + * (ie, had receive_form_submission called on it yet) |
|
1184 | + * |
|
1185 | + * @return boolean |
|
1186 | + * @throws EE_Error |
|
1187 | + */ |
|
1188 | + public function has_received_submission() |
|
1189 | + { |
|
1190 | + $this->ensure_construct_finalized_called(); |
|
1191 | + return $this->_received_submission; |
|
1192 | + } |
|
1193 | + |
|
1194 | + |
|
1195 | + /** |
|
1196 | + * Equivalent to passing 'exclude' in the constructor's options array. |
|
1197 | + * Removes the listed inputs from the form |
|
1198 | + * |
|
1199 | + * @param array $inputs_to_exclude values are the input names |
|
1200 | + * @return void |
|
1201 | + */ |
|
1202 | + public function exclude(array $inputs_to_exclude = array()) |
|
1203 | + { |
|
1204 | + foreach ($inputs_to_exclude as $input_to_exclude_name) { |
|
1205 | + unset($this->_subsections[ $input_to_exclude_name ]); |
|
1206 | + } |
|
1207 | + } |
|
1208 | + |
|
1209 | + |
|
1210 | + /** |
|
1211 | + * Changes these inputs' display strategy to be EE_Hidden_Display_Strategy. |
|
1212 | + * @param array $inputs_to_hide |
|
1213 | + * @throws EE_Error |
|
1214 | + */ |
|
1215 | + public function hide(array $inputs_to_hide = array()) |
|
1216 | + { |
|
1217 | + foreach ($inputs_to_hide as $input_to_hide) { |
|
1218 | + $input = $this->get_input($input_to_hide); |
|
1219 | + $input->set_display_strategy(new EE_Hidden_Display_Strategy()); |
|
1220 | + } |
|
1221 | + } |
|
1222 | + |
|
1223 | + |
|
1224 | + /** |
|
1225 | + * add_subsections |
|
1226 | + * Adds the listed subsections to the form section. |
|
1227 | + * If $subsection_name_to_target is provided, |
|
1228 | + * then new subsections are added before or after that subsection, |
|
1229 | + * otherwise to the start or end of the entire subsections array. |
|
1230 | + * |
|
1231 | + * @param EE_Form_Section_Base[] $new_subsections array of new form subsections |
|
1232 | + * where keys are their names |
|
1233 | + * @param string $subsection_name_to_target an existing for section that $new_subsections |
|
1234 | + * should be added before or after |
|
1235 | + * IF $subsection_name_to_target is null, |
|
1236 | + * then $new_subsections will be added to |
|
1237 | + * the beginning or end of the entire subsections array |
|
1238 | + * @param boolean $add_before whether to add $new_subsections, before or after |
|
1239 | + * $subsection_name_to_target, |
|
1240 | + * or if $subsection_name_to_target is null, |
|
1241 | + * before or after entire subsections array |
|
1242 | + * @return void |
|
1243 | + * @throws EE_Error |
|
1244 | + */ |
|
1245 | + public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true) |
|
1246 | + { |
|
1247 | + foreach ($new_subsections as $subsection_name => $subsection) { |
|
1248 | + if (! $subsection instanceof EE_Form_Section_Base) { |
|
1249 | + EE_Error::add_error( |
|
1250 | + sprintf( |
|
1251 | + esc_html__( |
|
1252 | + "Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.", |
|
1253 | + 'event_espresso' |
|
1254 | + ), |
|
1255 | + get_class($subsection), |
|
1256 | + $subsection_name, |
|
1257 | + $this->name() |
|
1258 | + ) |
|
1259 | + ); |
|
1260 | + unset($new_subsections[ $subsection_name ]); |
|
1261 | + } |
|
1262 | + } |
|
1263 | + $this->_subsections = EEH_Array::insert_into_array( |
|
1264 | + $this->_subsections, |
|
1265 | + $new_subsections, |
|
1266 | + $subsection_name_to_target, |
|
1267 | + $add_before |
|
1268 | + ); |
|
1269 | + if ($this->_construction_finalized) { |
|
1270 | + foreach ($this->_subsections as $name => $subsection) { |
|
1271 | + $subsection->_construct_finalize($this, $name); |
|
1272 | + } |
|
1273 | + } |
|
1274 | + } |
|
1275 | + |
|
1276 | + |
|
1277 | + /** |
|
1278 | + * @param string $subsection_name |
|
1279 | + * @param bool $recursive |
|
1280 | + * @return bool |
|
1281 | + */ |
|
1282 | + public function has_subsection($subsection_name, $recursive = false) |
|
1283 | + { |
|
1284 | + foreach ($this->_subsections as $name => $subsection) { |
|
1285 | + if ($name === $subsection_name |
|
1286 | + || ( |
|
1287 | + $recursive |
|
1288 | + && $subsection instanceof EE_Form_Section_Proper |
|
1289 | + && $subsection->has_subsection($subsection_name, $recursive) |
|
1290 | + ) |
|
1291 | + ) { |
|
1292 | + return true; |
|
1293 | + } |
|
1294 | + } |
|
1295 | + return false; |
|
1296 | + } |
|
1297 | + |
|
1298 | + |
|
1299 | + |
|
1300 | + /** |
|
1301 | + * Just gets all validatable subsections to clean their sensitive data |
|
1302 | + * |
|
1303 | + * @throws EE_Error |
|
1304 | + */ |
|
1305 | + public function clean_sensitive_data() |
|
1306 | + { |
|
1307 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
1308 | + $subsection->clean_sensitive_data(); |
|
1309 | + } |
|
1310 | + } |
|
1311 | + |
|
1312 | + |
|
1313 | + /** |
|
1314 | + * Sets the submission error message (aka validation error message for this form section and all sub-sections) |
|
1315 | + * @param string $form_submission_error_message |
|
1316 | + * @param EE_Form_Section_Validatable $form_section unused |
|
1317 | + * @throws EE_Error |
|
1318 | + */ |
|
1319 | + public function set_submission_error_message( |
|
1320 | + $form_submission_error_message = '' |
|
1321 | + ) { |
|
1322 | + $this->_form_submission_error_message = ! empty($form_submission_error_message) |
|
1323 | + ? $form_submission_error_message |
|
1324 | + : $this->getAllValidationErrorsString(); |
|
1325 | + } |
|
1326 | + |
|
1327 | + |
|
1328 | + /** |
|
1329 | + * Returns the cached error message. A default value is set for this during _validate(), |
|
1330 | + * (called during receive_form_submission) but it can be explicitly set using |
|
1331 | + * set_submission_error_message |
|
1332 | + * |
|
1333 | + * @return string |
|
1334 | + */ |
|
1335 | + public function submission_error_message() |
|
1336 | + { |
|
1337 | + return $this->_form_submission_error_message; |
|
1338 | + } |
|
1339 | + |
|
1340 | + |
|
1341 | + /** |
|
1342 | + * Sets a message to display if the data submitted to the form was valid. |
|
1343 | + * @param string $form_submission_success_message |
|
1344 | + */ |
|
1345 | + public function set_submission_success_message($form_submission_success_message = '') |
|
1346 | + { |
|
1347 | + $this->_form_submission_success_message = ! empty($form_submission_success_message) |
|
1348 | + ? $form_submission_success_message |
|
1349 | + : esc_html__('Form submitted successfully', 'event_espresso'); |
|
1350 | + } |
|
1351 | + |
|
1352 | + |
|
1353 | + /** |
|
1354 | + * Gets a message appropriate for display when the form is correctly submitted |
|
1355 | + * @return string |
|
1356 | + */ |
|
1357 | + public function submission_success_message() |
|
1358 | + { |
|
1359 | + return $this->_form_submission_success_message; |
|
1360 | + } |
|
1361 | + |
|
1362 | + |
|
1363 | + /** |
|
1364 | + * Returns the prefix that should be used on child of this form section for |
|
1365 | + * their html names. If this form section itself has a parent, prepends ITS |
|
1366 | + * prefix onto this form section's prefix. Used primarily by |
|
1367 | + * EE_Form_Input_Base::_set_default_html_name_if_empty |
|
1368 | + * |
|
1369 | + * @return string |
|
1370 | + * @throws EE_Error |
|
1371 | + */ |
|
1372 | + public function html_name_prefix() |
|
1373 | + { |
|
1374 | + if ($this->parent_section() instanceof EE_Form_Section_Proper) { |
|
1375 | + return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']'; |
|
1376 | + } |
|
1377 | + return $this->name(); |
|
1378 | + } |
|
1379 | + |
|
1380 | + |
|
1381 | + /** |
|
1382 | + * Gets the name, but first checks _construct_finalize has been called. If not, |
|
1383 | + * calls it (assumes there is no parent and that we want the name to be whatever |
|
1384 | + * was set, which is probably nothing, or the classname) |
|
1385 | + * |
|
1386 | + * @return string |
|
1387 | + * @throws EE_Error |
|
1388 | + */ |
|
1389 | + public function name() |
|
1390 | + { |
|
1391 | + $this->ensure_construct_finalized_called(); |
|
1392 | + return parent::name(); |
|
1393 | + } |
|
1394 | + |
|
1395 | + |
|
1396 | + /** |
|
1397 | + * @return EE_Form_Section_Proper |
|
1398 | + * @throws EE_Error |
|
1399 | + */ |
|
1400 | + public function parent_section() |
|
1401 | + { |
|
1402 | + $this->ensure_construct_finalized_called(); |
|
1403 | + return parent::parent_section(); |
|
1404 | + } |
|
1405 | + |
|
1406 | + |
|
1407 | + /** |
|
1408 | + * make sure construction finalized was called, otherwise children might not be ready |
|
1409 | + * |
|
1410 | + * @return void |
|
1411 | + * @throws EE_Error |
|
1412 | + */ |
|
1413 | + public function ensure_construct_finalized_called() |
|
1414 | + { |
|
1415 | + if (! $this->_construction_finalized) { |
|
1416 | + $this->_construct_finalize($this->_parent_section, $this->_name); |
|
1417 | + } |
|
1418 | + } |
|
1419 | + |
|
1420 | + |
|
1421 | + /** |
|
1422 | + * Checks if any of this form section's inputs, or any of its children's inputs, |
|
1423 | + * are in teh form data. If any are found, returns true. Else false |
|
1424 | + * |
|
1425 | + * @param array $req_data |
|
1426 | + * @return boolean |
|
1427 | + * @throws EE_Error |
|
1428 | + */ |
|
1429 | + public function form_data_present_in($req_data = null) |
|
1430 | + { |
|
1431 | + $req_data = $this->getCachedRequest($req_data); |
|
1432 | + foreach ($this->subsections() as $subsection) { |
|
1433 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
1434 | + if ($subsection->form_data_present_in($req_data)) { |
|
1435 | + return true; |
|
1436 | + } |
|
1437 | + } elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
1438 | + if ($subsection->form_data_present_in($req_data)) { |
|
1439 | + return true; |
|
1440 | + } |
|
1441 | + } |
|
1442 | + } |
|
1443 | + return false; |
|
1444 | + } |
|
1445 | + |
|
1446 | + |
|
1447 | + /** |
|
1448 | + * Gets validation errors for this form section and subsections |
|
1449 | + * Similar to EE_Form_Section_Validatable::get_validation_errors() except this |
|
1450 | + * gets the validation errors for ALL subsection |
|
1451 | + * |
|
1452 | + * @return EE_Validation_Error[] |
|
1453 | + * @throws EE_Error |
|
1454 | + */ |
|
1455 | + public function get_validation_errors_accumulated() |
|
1456 | + { |
|
1457 | + $validation_errors = $this->get_validation_errors(); |
|
1458 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
1459 | + if ($subsection instanceof EE_Form_Section_Proper) { |
|
1460 | + $validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated(); |
|
1461 | + } else { |
|
1462 | + $validation_errors_on_this_subsection = $subsection->get_validation_errors(); |
|
1463 | + } |
|
1464 | + if ($validation_errors_on_this_subsection) { |
|
1465 | + $validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection); |
|
1466 | + } |
|
1467 | + } |
|
1468 | + return $validation_errors; |
|
1469 | + } |
|
1470 | + |
|
1471 | + /** |
|
1472 | + * Fetch validation errors from children and grandchildren and puts them in a single string. |
|
1473 | + * This traverses the form section tree to generate this, but you probably want to instead use |
|
1474 | + * get_form_submission_error_message() which is usually this message cached (or a custom validation error message) |
|
1475 | + * |
|
1476 | + * @return string |
|
1477 | + * @since 4.9.59.p |
|
1478 | + */ |
|
1479 | + protected function getAllValidationErrorsString() |
|
1480 | + { |
|
1481 | + $submission_error_messages = array(); |
|
1482 | + // bad, bad, bad registrant |
|
1483 | + foreach ($this->get_validation_errors_accumulated() as $validation_error) { |
|
1484 | + if ($validation_error instanceof EE_Validation_Error) { |
|
1485 | + $form_section = $validation_error->get_form_section(); |
|
1486 | + if ($form_section instanceof EE_Form_Input_Base) { |
|
1487 | + $label = $validation_error->get_form_section()->html_label_text(); |
|
1488 | + } elseif ($form_section instanceof EE_Form_Section_Validatable) { |
|
1489 | + $label = $validation_error->get_form_section()->name(); |
|
1490 | + } else { |
|
1491 | + $label = esc_html__('Unknown', 'event_espresso'); |
|
1492 | + } |
|
1493 | + $submission_error_messages[] = sprintf( |
|
1494 | + __('%s : %s', 'event_espresso'), |
|
1495 | + $label, |
|
1496 | + $validation_error->getMessage() |
|
1497 | + ); |
|
1498 | + } |
|
1499 | + } |
|
1500 | + return implode('<br', $submission_error_messages); |
|
1501 | + } |
|
1502 | + |
|
1503 | + |
|
1504 | + /** |
|
1505 | + * This isn't just the name of an input, it's a path pointing to an input. The |
|
1506 | + * path is similar to a folder path: slash (/) means to descend into a subsection, |
|
1507 | + * dot-dot-slash (../) means to ascend into the parent section. |
|
1508 | + * After a series of slashes and dot-dot-slashes, there should be the name of an input, |
|
1509 | + * which will be returned. |
|
1510 | + * Eg, if you want the related input to be conditional on a sibling input name 'foobar' |
|
1511 | + * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name |
|
1512 | + * 'baz', use '../baz'. If you want it to be conditional on a cousin input, |
|
1513 | + * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'. |
|
1514 | + * Etc |
|
1515 | + * |
|
1516 | + * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false |
|
1517 | + * @return EE_Form_Section_Base |
|
1518 | + * @throws EE_Error |
|
1519 | + */ |
|
1520 | + public function find_section_from_path($form_section_path) |
|
1521 | + { |
|
1522 | + // check if we can find the input from purely going straight up the tree |
|
1523 | + $input = parent::find_section_from_path($form_section_path); |
|
1524 | + if ($input instanceof EE_Form_Section_Base) { |
|
1525 | + return $input; |
|
1526 | + } |
|
1527 | + $next_slash_pos = strpos($form_section_path, '/'); |
|
1528 | + if ($next_slash_pos !== false) { |
|
1529 | + $child_section_name = substr($form_section_path, 0, $next_slash_pos); |
|
1530 | + $subpath = substr($form_section_path, $next_slash_pos + 1); |
|
1531 | + } else { |
|
1532 | + $child_section_name = $form_section_path; |
|
1533 | + $subpath = ''; |
|
1534 | + } |
|
1535 | + $child_section = $this->get_subsection($child_section_name); |
|
1536 | + if ($child_section instanceof EE_Form_Section_Base) { |
|
1537 | + return $child_section->find_section_from_path($subpath); |
|
1538 | + } |
|
1539 | + return null; |
|
1540 | + } |
|
1541 | 1541 | } |
@@ -111,8 +111,8 @@ discard block |
||
111 | 111 | // AND we are going to make sure they're in that specified order |
112 | 112 | $reordered_subsections = array(); |
113 | 113 | foreach ($options_array['include'] as $input_name) { |
114 | - if (isset($this->_subsections[ $input_name ])) { |
|
115 | - $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ]; |
|
114 | + if (isset($this->_subsections[$input_name])) { |
|
115 | + $reordered_subsections[$input_name] = $this->_subsections[$input_name]; |
|
116 | 116 | } |
117 | 117 | } |
118 | 118 | $this->_subsections = $reordered_subsections; |
@@ -124,7 +124,7 @@ discard block |
||
124 | 124 | if (isset($options_array['layout_strategy'])) { |
125 | 125 | $this->_layout_strategy = $options_array['layout_strategy']; |
126 | 126 | } |
127 | - if (! $this->_layout_strategy) { |
|
127 | + if ( ! $this->_layout_strategy) { |
|
128 | 128 | $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout(); |
129 | 129 | } |
130 | 130 | $this->_layout_strategy->_construct_finalize($this); |
@@ -313,7 +313,7 @@ discard block |
||
313 | 313 | if ($validate) { |
314 | 314 | $this->_validate(); |
315 | 315 | // if it's invalid, we're going to want to re-display so remember what they submitted |
316 | - if (! $this->is_valid()) { |
|
316 | + if ( ! $this->is_valid()) { |
|
317 | 317 | $this->store_submitted_form_data_in_session(); |
318 | 318 | } |
319 | 319 | } |
@@ -426,11 +426,11 @@ discard block |
||
426 | 426 | public function populate_defaults($default_data) |
427 | 427 | { |
428 | 428 | foreach ($this->subsections(false) as $subsection_name => $subsection) { |
429 | - if (isset($default_data[ $subsection_name ])) { |
|
429 | + if (isset($default_data[$subsection_name])) { |
|
430 | 430 | if ($subsection instanceof EE_Form_Input_Base) { |
431 | - $subsection->set_default($default_data[ $subsection_name ]); |
|
431 | + $subsection->set_default($default_data[$subsection_name]); |
|
432 | 432 | } elseif ($subsection instanceof EE_Form_Section_Proper) { |
433 | - $subsection->populate_defaults($default_data[ $subsection_name ]); |
|
433 | + $subsection->populate_defaults($default_data[$subsection_name]); |
|
434 | 434 | } |
435 | 435 | } |
436 | 436 | } |
@@ -445,7 +445,7 @@ discard block |
||
445 | 445 | */ |
446 | 446 | public function subsection_exists($name) |
447 | 447 | { |
448 | - return isset($this->_subsections[ $name ]) ? true : false; |
|
448 | + return isset($this->_subsections[$name]) ? true : false; |
|
449 | 449 | } |
450 | 450 | |
451 | 451 | |
@@ -467,7 +467,7 @@ discard block |
||
467 | 467 | if ($require_construction_to_be_finalized) { |
468 | 468 | $this->ensure_construct_finalized_called(); |
469 | 469 | } |
470 | - return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null; |
|
470 | + return $this->subsection_exists($name) ? $this->_subsections[$name] : null; |
|
471 | 471 | } |
472 | 472 | |
473 | 473 | |
@@ -482,7 +482,7 @@ discard block |
||
482 | 482 | $validatable_subsections = array(); |
483 | 483 | foreach ($this->subsections() as $name => $obj) { |
484 | 484 | if ($obj instanceof EE_Form_Section_Validatable) { |
485 | - $validatable_subsections[ $name ] = $obj; |
|
485 | + $validatable_subsections[$name] = $obj; |
|
486 | 486 | } |
487 | 487 | } |
488 | 488 | return $validatable_subsections; |
@@ -509,7 +509,7 @@ discard block |
||
509 | 509 | $name, |
510 | 510 | $require_construction_to_be_finalized |
511 | 511 | ); |
512 | - if (! $subsection instanceof EE_Form_Input_Base) { |
|
512 | + if ( ! $subsection instanceof EE_Form_Input_Base) { |
|
513 | 513 | throw new EE_Error( |
514 | 514 | sprintf( |
515 | 515 | esc_html__( |
@@ -546,7 +546,7 @@ discard block |
||
546 | 546 | $name, |
547 | 547 | $require_construction_to_be_finalized |
548 | 548 | ); |
549 | - if (! $subsection instanceof EE_Form_Section_Proper) { |
|
549 | + if ( ! $subsection instanceof EE_Form_Section_Proper) { |
|
550 | 550 | throw new EE_Error( |
551 | 551 | sprintf( |
552 | 552 | esc_html__( |
@@ -586,7 +586,7 @@ discard block |
||
586 | 586 | public function is_valid() |
587 | 587 | { |
588 | 588 | if ($this->is_valid === null) { |
589 | - if (! $this->has_received_submission()) { |
|
589 | + if ( ! $this->has_received_submission()) { |
|
590 | 590 | throw new EE_Error( |
591 | 591 | sprintf( |
592 | 592 | esc_html__( |
@@ -596,14 +596,14 @@ discard block |
||
596 | 596 | ) |
597 | 597 | ); |
598 | 598 | } |
599 | - if (! parent::is_valid()) { |
|
599 | + if ( ! parent::is_valid()) { |
|
600 | 600 | $this->is_valid = false; |
601 | 601 | } else { |
602 | 602 | // ok so no general errors to this entire form section. |
603 | 603 | // so let's check the subsections, but only set errors if that hasn't been done yet |
604 | 604 | $this->is_valid = true; |
605 | 605 | foreach ($this->get_validatable_subsections() as $subsection) { |
606 | - if (! $subsection->is_valid()) { |
|
606 | + if ( ! $subsection->is_valid()) { |
|
607 | 607 | $this->is_valid = false; |
608 | 608 | } |
609 | 609 | } |
@@ -620,7 +620,7 @@ discard block |
||
620 | 620 | */ |
621 | 621 | protected function _set_default_name_if_empty() |
622 | 622 | { |
623 | - if (! $this->_name) { |
|
623 | + if ( ! $this->_name) { |
|
624 | 624 | $classname = get_class($this); |
625 | 625 | $default_name = str_replace('EE_', '', $classname); |
626 | 626 | $this->_name = $default_name; |
@@ -710,7 +710,7 @@ discard block |
||
710 | 710 | { |
711 | 711 | wp_register_script( |
712 | 712 | 'ee_form_section_validation', |
713 | - EE_GLOBAL_ASSETS_URL . 'scripts' . '/form_section_validation.js', |
|
713 | + EE_GLOBAL_ASSETS_URL.'scripts'.'/form_section_validation.js', |
|
714 | 714 | array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'), |
715 | 715 | EVENT_ESPRESSO_VERSION, |
716 | 716 | true |
@@ -754,13 +754,13 @@ discard block |
||
754 | 754 | // we only want to localize vars ONCE for the entire form, |
755 | 755 | // so if the form section doesn't have a parent, then it must be the top dog |
756 | 756 | if ($return_for_subsection || ! $this->parent_section()) { |
757 | - EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array( |
|
757 | + EE_Form_Section_Proper::$_js_localization['form_data'][$this->html_id()] = array( |
|
758 | 758 | 'form_section_id' => $this->html_id(true), |
759 | 759 | 'validation_rules' => $this->get_jquery_validation_rules(), |
760 | 760 | 'other_data' => $this->get_other_js_data(), |
761 | 761 | 'errors' => $this->subsection_validation_errors_by_html_name(), |
762 | 762 | ); |
763 | - EE_Form_Section_Proper::$_scripts_localized = true; |
|
763 | + EE_Form_Section_Proper::$_scripts_localized = true; |
|
764 | 764 | } |
765 | 765 | } |
766 | 766 | |
@@ -795,7 +795,7 @@ discard block |
||
795 | 795 | $inputs = array(); |
796 | 796 | foreach ($this->subsections() as $subsection) { |
797 | 797 | if ($subsection instanceof EE_Form_Input_Base) { |
798 | - $inputs[ $subsection->html_name() ] = $subsection; |
|
798 | + $inputs[$subsection->html_name()] = $subsection; |
|
799 | 799 | } elseif ($subsection instanceof EE_Form_Section_Proper) { |
800 | 800 | $inputs += $subsection->inputs_in_subsections(); |
801 | 801 | } |
@@ -818,7 +818,7 @@ discard block |
||
818 | 818 | $errors = array(); |
819 | 819 | foreach ($inputs as $form_input) { |
820 | 820 | if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) { |
821 | - $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string(); |
|
821 | + $errors[$form_input->html_name()] = $form_input->get_validation_error_string(); |
|
822 | 822 | } |
823 | 823 | } |
824 | 824 | return $errors; |
@@ -841,7 +841,7 @@ discard block |
||
841 | 841 | $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level) |
842 | 842 | ? EE_Registry::instance()->CFG->registration->email_validation_level |
843 | 843 | : 'wp_default'; |
844 | - EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level; |
|
844 | + EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level; |
|
845 | 845 | wp_enqueue_script('ee_form_section_validation'); |
846 | 846 | wp_localize_script( |
847 | 847 | 'ee_form_section_validation', |
@@ -858,7 +858,7 @@ discard block |
||
858 | 858 | */ |
859 | 859 | public function ensure_scripts_localized() |
860 | 860 | { |
861 | - if (! EE_Form_Section_Proper::$_scripts_localized) { |
|
861 | + if ( ! EE_Form_Section_Proper::$_scripts_localized) { |
|
862 | 862 | $this->_enqueue_and_localize_form_js(); |
863 | 863 | } |
864 | 864 | } |
@@ -954,8 +954,8 @@ discard block |
||
954 | 954 | // reset the cache of whether this form is valid or not- we're re-validating it now |
955 | 955 | $this->is_valid = null; |
956 | 956 | foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) { |
957 | - if (method_exists($this, '_validate_' . $subsection_name)) { |
|
958 | - call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection)); |
|
957 | + if (method_exists($this, '_validate_'.$subsection_name)) { |
|
958 | + call_user_func_array(array($this, '_validate_'.$subsection_name), array($subsection)); |
|
959 | 959 | } |
960 | 960 | $subsection->_validate(); |
961 | 961 | } |
@@ -973,9 +973,9 @@ discard block |
||
973 | 973 | $inputs = array(); |
974 | 974 | foreach ($this->subsections() as $subsection_name => $subsection) { |
975 | 975 | if ($subsection instanceof EE_Form_Section_Proper) { |
976 | - $inputs[ $subsection_name ] = $subsection->valid_data(); |
|
976 | + $inputs[$subsection_name] = $subsection->valid_data(); |
|
977 | 977 | } elseif ($subsection instanceof EE_Form_Input_Base) { |
978 | - $inputs[ $subsection_name ] = $subsection->normalized_value(); |
|
978 | + $inputs[$subsection_name] = $subsection->normalized_value(); |
|
979 | 979 | } |
980 | 980 | } |
981 | 981 | return $inputs; |
@@ -993,7 +993,7 @@ discard block |
||
993 | 993 | $inputs = array(); |
994 | 994 | foreach ($this->subsections() as $subsection_name => $subsection) { |
995 | 995 | if ($subsection instanceof EE_Form_Input_Base) { |
996 | - $inputs[ $subsection_name ] = $subsection; |
|
996 | + $inputs[$subsection_name] = $subsection; |
|
997 | 997 | } |
998 | 998 | } |
999 | 999 | return $inputs; |
@@ -1011,7 +1011,7 @@ discard block |
||
1011 | 1011 | $form_sections = array(); |
1012 | 1012 | foreach ($this->subsections() as $name => $obj) { |
1013 | 1013 | if ($obj instanceof EE_Form_Section_Proper) { |
1014 | - $form_sections[ $name ] = $obj; |
|
1014 | + $form_sections[$name] = $obj; |
|
1015 | 1015 | } |
1016 | 1016 | } |
1017 | 1017 | return $form_sections; |
@@ -1118,7 +1118,7 @@ discard block |
||
1118 | 1118 | $input_values = array(); |
1119 | 1119 | foreach ($this->subsections() as $subsection_name => $subsection) { |
1120 | 1120 | if ($subsection instanceof EE_Form_Input_Base) { |
1121 | - $input_values[ $subsection_name ] = $pretty |
|
1121 | + $input_values[$subsection_name] = $pretty |
|
1122 | 1122 | ? $subsection->pretty_value() |
1123 | 1123 | : $subsection->normalized_value(); |
1124 | 1124 | } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) { |
@@ -1130,7 +1130,7 @@ discard block |
||
1130 | 1130 | if ($flatten) { |
1131 | 1131 | $input_values = array_merge($input_values, $subform_input_values); |
1132 | 1132 | } else { |
1133 | - $input_values[ $subsection_name ] = $subform_input_values; |
|
1133 | + $input_values[$subsection_name] = $subform_input_values; |
|
1134 | 1134 | } |
1135 | 1135 | } |
1136 | 1136 | } |
@@ -1158,7 +1158,7 @@ discard block |
||
1158 | 1158 | if ($subsection instanceof EE_Form_Input_Base) { |
1159 | 1159 | // is this input part of an array of inputs? |
1160 | 1160 | if (strpos($subsection->html_name(), '[') !== false) { |
1161 | - $full_input_name = EEH_Array::convert_array_values_to_keys( |
|
1161 | + $full_input_name = EEH_Array::convert_array_values_to_keys( |
|
1162 | 1162 | explode( |
1163 | 1163 | '[', |
1164 | 1164 | str_replace(']', '', $subsection->html_name()) |
@@ -1167,7 +1167,7 @@ discard block |
||
1167 | 1167 | ); |
1168 | 1168 | $submitted_values = array_replace_recursive($submitted_values, $full_input_name); |
1169 | 1169 | } else { |
1170 | - $submitted_values[ $subsection->html_name() ] = $subsection->raw_value(); |
|
1170 | + $submitted_values[$subsection->html_name()] = $subsection->raw_value(); |
|
1171 | 1171 | } |
1172 | 1172 | } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) { |
1173 | 1173 | $subform_input_values = $subsection->submitted_values($include_subforms); |
@@ -1202,7 +1202,7 @@ discard block |
||
1202 | 1202 | public function exclude(array $inputs_to_exclude = array()) |
1203 | 1203 | { |
1204 | 1204 | foreach ($inputs_to_exclude as $input_to_exclude_name) { |
1205 | - unset($this->_subsections[ $input_to_exclude_name ]); |
|
1205 | + unset($this->_subsections[$input_to_exclude_name]); |
|
1206 | 1206 | } |
1207 | 1207 | } |
1208 | 1208 | |
@@ -1245,7 +1245,7 @@ discard block |
||
1245 | 1245 | public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true) |
1246 | 1246 | { |
1247 | 1247 | foreach ($new_subsections as $subsection_name => $subsection) { |
1248 | - if (! $subsection instanceof EE_Form_Section_Base) { |
|
1248 | + if ( ! $subsection instanceof EE_Form_Section_Base) { |
|
1249 | 1249 | EE_Error::add_error( |
1250 | 1250 | sprintf( |
1251 | 1251 | esc_html__( |
@@ -1257,7 +1257,7 @@ discard block |
||
1257 | 1257 | $this->name() |
1258 | 1258 | ) |
1259 | 1259 | ); |
1260 | - unset($new_subsections[ $subsection_name ]); |
|
1260 | + unset($new_subsections[$subsection_name]); |
|
1261 | 1261 | } |
1262 | 1262 | } |
1263 | 1263 | $this->_subsections = EEH_Array::insert_into_array( |
@@ -1372,7 +1372,7 @@ discard block |
||
1372 | 1372 | public function html_name_prefix() |
1373 | 1373 | { |
1374 | 1374 | if ($this->parent_section() instanceof EE_Form_Section_Proper) { |
1375 | - return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']'; |
|
1375 | + return $this->parent_section()->html_name_prefix().'['.$this->name().']'; |
|
1376 | 1376 | } |
1377 | 1377 | return $this->name(); |
1378 | 1378 | } |
@@ -1412,7 +1412,7 @@ discard block |
||
1412 | 1412 | */ |
1413 | 1413 | public function ensure_construct_finalized_called() |
1414 | 1414 | { |
1415 | - if (! $this->_construction_finalized) { |
|
1415 | + if ( ! $this->_construction_finalized) { |
|
1416 | 1416 | $this->_construct_finalize($this->_parent_section, $this->_name); |
1417 | 1417 | } |
1418 | 1418 | } |