@@ -241,7 +241,7 @@ |
||
241 | 241 | |
242 | 242 | |
243 | 243 | /** |
244 | - * @return string |
|
244 | + * @return boolean |
|
245 | 245 | * @throws InvalidArgumentException |
246 | 246 | * @throws InvalidInterfaceException |
247 | 247 | * @throws InvalidDataTypeException |
@@ -17,442 +17,442 @@ |
||
17 | 17 | class EED_Ticket_Selector extends EED_Module |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * @var DisplayTicketSelector $ticket_selector |
|
22 | - */ |
|
23 | - private static $ticket_selector; |
|
24 | - |
|
25 | - /** |
|
26 | - * @var TicketSelectorIframeEmbedButton $iframe_embed_button |
|
27 | - */ |
|
28 | - private static $iframe_embed_button; |
|
29 | - |
|
30 | - |
|
31 | - /** |
|
32 | - * @return EED_Module|EED_Ticket_Selector |
|
33 | - */ |
|
34 | - public static function instance() |
|
35 | - { |
|
36 | - return parent::get_instance(__CLASS__); |
|
37 | - } |
|
38 | - |
|
39 | - |
|
40 | - /** |
|
41 | - * @return void |
|
42 | - */ |
|
43 | - protected function set_config() |
|
44 | - { |
|
45 | - $this->set_config_section('template_settings'); |
|
46 | - $this->set_config_class('EE_Ticket_Selector_Config'); |
|
47 | - $this->set_config_name('EED_Ticket_Selector'); |
|
48 | - } |
|
49 | - |
|
50 | - |
|
51 | - /** |
|
52 | - * set_hooks - for hooking into EE Core, other modules, etc |
|
53 | - * |
|
54 | - * @return void |
|
55 | - */ |
|
56 | - public static function set_hooks() |
|
57 | - { |
|
58 | - // routing |
|
59 | - EE_Config::register_route( |
|
60 | - 'iframe', |
|
61 | - 'EED_Ticket_Selector', |
|
62 | - 'ticket_selector_iframe', |
|
63 | - 'ticket_selector' |
|
64 | - ); |
|
65 | - EE_Config::register_route( |
|
66 | - 'process_ticket_selections', |
|
67 | - 'EED_Ticket_Selector', |
|
68 | - 'process_ticket_selections' |
|
69 | - ); |
|
70 | - EE_Config::register_route( |
|
71 | - 'cancel_ticket_selections', |
|
72 | - 'EED_Ticket_Selector', |
|
73 | - 'cancel_ticket_selections' |
|
74 | - ); |
|
75 | - add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2); |
|
76 | - add_action('AHEE_event_details_header_bottom', array('EED_Ticket_Selector', 'display_ticket_selector'), 10, 1); |
|
77 | - add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'translate_js_strings'), 0); |
|
78 | - add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets'), 10); |
|
79 | - EED_Ticket_Selector::loadIframeAssets(); |
|
80 | - } |
|
81 | - |
|
82 | - |
|
83 | - /** |
|
84 | - * set_hooks_admin - for hooking into EE Admin Core, other modules, etc |
|
85 | - * |
|
86 | - * @return void |
|
87 | - */ |
|
88 | - public static function set_hooks_admin() |
|
89 | - { |
|
90 | - // hook into the end of the \EE_Admin_Page::_load_page_dependencies() |
|
91 | - // to load assets for "espresso_events" page on the "edit" route (action) |
|
92 | - add_action( |
|
93 | - 'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__edit', |
|
94 | - array('EED_Ticket_Selector', 'ticket_selector_iframe_embed_button'), |
|
95 | - 10 |
|
96 | - ); |
|
97 | - /** |
|
98 | - * Make sure assets for the ticket selector are loaded on the espresso registrations route so admin side |
|
99 | - * registrations work. |
|
100 | - */ |
|
101 | - add_action( |
|
102 | - 'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration', |
|
103 | - array('EED_Ticket_Selector', 'set_definitions'), |
|
104 | - 10 |
|
105 | - ); |
|
106 | - } |
|
107 | - |
|
108 | - |
|
109 | - /** |
|
110 | - * set_definitions |
|
111 | - * |
|
112 | - * @return void |
|
113 | - * @throws InvalidArgumentException |
|
114 | - * @throws InvalidDataTypeException |
|
115 | - * @throws InvalidInterfaceException |
|
116 | - */ |
|
117 | - public static function set_definitions() |
|
118 | - { |
|
119 | - // don't do this twice |
|
120 | - if (defined('TICKET_SELECTOR_ASSETS_URL')) { |
|
121 | - return; |
|
122 | - } |
|
123 | - define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/'); |
|
124 | - define( |
|
125 | - 'TICKET_SELECTOR_TEMPLATES_PATH', |
|
126 | - str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/' |
|
127 | - ); |
|
128 | - // if config is not set, initialize |
|
129 | - if (! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config |
|
130 | - ) { |
|
131 | - EED_Ticket_Selector::instance()->set_config(); |
|
132 | - EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = EED_Ticket_Selector::instance( |
|
133 | - )->config(); |
|
134 | - } |
|
135 | - } |
|
136 | - |
|
137 | - |
|
138 | - /** |
|
139 | - * @return DisplayTicketSelector |
|
140 | - */ |
|
141 | - public static function ticketSelector() |
|
142 | - { |
|
143 | - if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) { |
|
144 | - EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(EED_Events_Archive::is_iframe()); |
|
145 | - } |
|
146 | - return EED_Ticket_Selector::$ticket_selector; |
|
147 | - } |
|
148 | - |
|
149 | - |
|
150 | - /** |
|
151 | - * gets the ball rolling |
|
152 | - * |
|
153 | - * @param WP $WP |
|
154 | - * @return void |
|
155 | - */ |
|
156 | - public function run($WP) |
|
157 | - { |
|
158 | - } |
|
159 | - |
|
160 | - |
|
161 | - /** |
|
162 | - * @return TicketSelectorIframeEmbedButton |
|
163 | - */ |
|
164 | - public static function getIframeEmbedButton() |
|
165 | - { |
|
166 | - if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) { |
|
167 | - self::$iframe_embed_button = new TicketSelectorIframeEmbedButton(); |
|
168 | - } |
|
169 | - return self::$iframe_embed_button; |
|
170 | - } |
|
171 | - |
|
172 | - |
|
173 | - /** |
|
174 | - * ticket_selector_iframe_embed_button |
|
175 | - * |
|
176 | - * @return void |
|
177 | - * @throws EE_Error |
|
178 | - */ |
|
179 | - public static function ticket_selector_iframe_embed_button() |
|
180 | - { |
|
181 | - $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton(); |
|
182 | - $iframe_embed_button->addEventEditorIframeEmbedButton(); |
|
183 | - } |
|
184 | - |
|
185 | - |
|
186 | - /** |
|
187 | - * ticket_selector_iframe |
|
188 | - * |
|
189 | - * @return void |
|
190 | - * @throws DomainException |
|
191 | - * @throws EE_Error |
|
192 | - */ |
|
193 | - public function ticket_selector_iframe() |
|
194 | - { |
|
195 | - $ticket_selector_iframe = new TicketSelectorIframe(); |
|
196 | - $ticket_selector_iframe->display(); |
|
197 | - } |
|
198 | - |
|
199 | - |
|
200 | - /** |
|
201 | - * creates buttons for selecting number of attendees for an event |
|
202 | - * |
|
203 | - * @param WP_Post|int $event |
|
204 | - * @param bool $view_details |
|
205 | - * @return string |
|
206 | - * @throws EE_Error |
|
207 | - */ |
|
208 | - public static function display_ticket_selector($event = null, $view_details = false) |
|
209 | - { |
|
210 | - return EED_Ticket_Selector::ticketSelector()->display($event, $view_details); |
|
211 | - } |
|
212 | - |
|
213 | - |
|
214 | - /** |
|
215 | - * @return array or FALSE |
|
216 | - * @throws \ReflectionException |
|
217 | - * @throws \EE_Error |
|
218 | - * @throws InvalidArgumentException |
|
219 | - * @throws InvalidInterfaceException |
|
220 | - * @throws InvalidDataTypeException |
|
221 | - */ |
|
222 | - public function process_ticket_selections() |
|
223 | - { |
|
224 | - /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */ |
|
225 | - $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector'); |
|
226 | - return $form->processTicketSelections(); |
|
227 | - } |
|
228 | - |
|
229 | - |
|
230 | - /** |
|
231 | - * @return string |
|
232 | - * @throws InvalidArgumentException |
|
233 | - * @throws InvalidInterfaceException |
|
234 | - * @throws InvalidDataTypeException |
|
235 | - * @throws EE_Error |
|
236 | - */ |
|
237 | - public static function cancel_ticket_selections() |
|
238 | - { |
|
239 | - /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */ |
|
240 | - $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector'); |
|
241 | - return $form->cancelTicketSelections(); |
|
242 | - } |
|
243 | - |
|
244 | - |
|
245 | - /** |
|
246 | - * @return void |
|
247 | - */ |
|
248 | - public static function translate_js_strings() |
|
249 | - { |
|
250 | - EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__( |
|
251 | - 'please select a datetime', |
|
252 | - 'event_espresso' |
|
253 | - ); |
|
254 | - } |
|
255 | - |
|
256 | - |
|
257 | - /** |
|
258 | - * @return void |
|
259 | - */ |
|
260 | - public static function load_tckt_slctr_assets() |
|
261 | - { |
|
262 | - if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', false)) { |
|
263 | - // add some style |
|
264 | - wp_register_style( |
|
265 | - 'ticket_selector', |
|
266 | - TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css', |
|
267 | - array(), |
|
268 | - EVENT_ESPRESSO_VERSION |
|
269 | - ); |
|
270 | - wp_enqueue_style('ticket_selector'); |
|
271 | - // make it dance |
|
272 | - wp_register_script( |
|
273 | - 'ticket_selector', |
|
274 | - TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', |
|
275 | - array('espresso_core'), |
|
276 | - EVENT_ESPRESSO_VERSION, |
|
277 | - true |
|
278 | - ); |
|
279 | - wp_enqueue_script('ticket_selector'); |
|
280 | - require_once EE_LIBRARIES |
|
281 | - . 'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php'; |
|
282 | - \EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts(); |
|
283 | - } |
|
284 | - } |
|
285 | - |
|
286 | - |
|
287 | - /** |
|
288 | - * @return void |
|
289 | - */ |
|
290 | - public static function loadIframeAssets() |
|
291 | - { |
|
292 | - // for event lists |
|
293 | - add_filter( |
|
294 | - 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css', |
|
295 | - array('EED_Ticket_Selector', 'iframeCss') |
|
296 | - ); |
|
297 | - add_filter( |
|
298 | - 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js', |
|
299 | - array('EED_Ticket_Selector', 'iframeJs') |
|
300 | - ); |
|
301 | - // for ticket selectors |
|
302 | - add_filter( |
|
303 | - 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css', |
|
304 | - array('EED_Ticket_Selector', 'iframeCss') |
|
305 | - ); |
|
306 | - add_filter( |
|
307 | - 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js', |
|
308 | - array('EED_Ticket_Selector', 'iframeJs') |
|
309 | - ); |
|
310 | - } |
|
311 | - |
|
312 | - |
|
313 | - /** |
|
314 | - * Informs the rest of the forms system what CSS and JS is needed to display the input |
|
315 | - * |
|
316 | - * @param array $iframe_css |
|
317 | - * @return array |
|
318 | - */ |
|
319 | - public static function iframeCss(array $iframe_css) |
|
320 | - { |
|
321 | - $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css'; |
|
322 | - return $iframe_css; |
|
323 | - } |
|
324 | - |
|
325 | - |
|
326 | - /** |
|
327 | - * Informs the rest of the forms system what CSS and JS is needed to display the input |
|
328 | - * |
|
329 | - * @param array $iframe_js |
|
330 | - * @return array |
|
331 | - */ |
|
332 | - public static function iframeJs(array $iframe_js) |
|
333 | - { |
|
334 | - $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js'; |
|
335 | - return $iframe_js; |
|
336 | - } |
|
337 | - |
|
338 | - |
|
339 | - /****************************** DEPRECATED ******************************/ |
|
340 | - |
|
341 | - |
|
342 | - /** |
|
343 | - * @deprecated |
|
344 | - * @return string |
|
345 | - * @throws EE_Error |
|
346 | - */ |
|
347 | - public static function display_view_details_btn() |
|
348 | - { |
|
349 | - // todo add doing_it_wrong() notice during next major version |
|
350 | - return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton(); |
|
351 | - } |
|
352 | - |
|
353 | - |
|
354 | - /** |
|
355 | - * @deprecated |
|
356 | - * @return string |
|
357 | - * @throws EE_Error |
|
358 | - */ |
|
359 | - public static function display_ticket_selector_submit() |
|
360 | - { |
|
361 | - // todo add doing_it_wrong() notice during next major version |
|
362 | - return EED_Ticket_Selector::ticketSelector()->displaySubmitButton(); |
|
363 | - } |
|
364 | - |
|
365 | - |
|
366 | - /** |
|
367 | - * @deprecated |
|
368 | - * @param string $permalink_string |
|
369 | - * @param int $id |
|
370 | - * @param string $new_title |
|
371 | - * @param string $new_slug |
|
372 | - * @return string |
|
373 | - * @throws InvalidArgumentException |
|
374 | - * @throws InvalidDataTypeException |
|
375 | - * @throws InvalidInterfaceException |
|
376 | - */ |
|
377 | - public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '') |
|
378 | - { |
|
379 | - // todo add doing_it_wrong() notice during next major version |
|
380 | - if (EE_Registry::instance()->REQ->get('page') === 'espresso_events' |
|
381 | - && EE_Registry::instance()->REQ->get('action') === 'edit' |
|
382 | - ) { |
|
383 | - $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton(); |
|
384 | - $iframe_embed_button->addEventEditorIframeEmbedButton(); |
|
385 | - } |
|
386 | - return ''; |
|
387 | - } |
|
388 | - |
|
389 | - |
|
390 | - /** |
|
391 | - * @deprecated |
|
392 | - * @param int $ID |
|
393 | - * @param string $external_url |
|
394 | - * @return string |
|
395 | - */ |
|
396 | - public static function ticket_selector_form_open($ID = 0, $external_url = '') |
|
397 | - { |
|
398 | - // todo add doing_it_wrong() notice during next major version |
|
399 | - return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url); |
|
400 | - } |
|
401 | - |
|
402 | - |
|
403 | - /** |
|
404 | - * @deprecated |
|
405 | - * @return string |
|
406 | - */ |
|
407 | - public static function ticket_selector_form_close() |
|
408 | - { |
|
409 | - // todo add doing_it_wrong() notice during next major version |
|
410 | - return EED_Ticket_Selector::ticketSelector()->formClose(); |
|
411 | - } |
|
412 | - |
|
413 | - |
|
414 | - /** |
|
415 | - * @deprecated |
|
416 | - * @return string |
|
417 | - */ |
|
418 | - public static function no_tkt_slctr_end_dv() |
|
419 | - { |
|
420 | - // todo add doing_it_wrong() notice during next major version |
|
421 | - return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv(); |
|
422 | - } |
|
423 | - |
|
424 | - |
|
425 | - /** |
|
426 | - * @deprecated 4.9.13 |
|
427 | - * @return string |
|
428 | - */ |
|
429 | - public static function tkt_slctr_end_dv() |
|
430 | - { |
|
431 | - return EED_Ticket_Selector::ticketSelector()->clearTicketSelector(); |
|
432 | - } |
|
433 | - |
|
434 | - |
|
435 | - /** |
|
436 | - * @deprecated |
|
437 | - * @return string |
|
438 | - */ |
|
439 | - public static function clear_tkt_slctr() |
|
440 | - { |
|
441 | - return EED_Ticket_Selector::ticketSelector()->clearTicketSelector(); |
|
442 | - } |
|
443 | - |
|
444 | - |
|
445 | - /** |
|
446 | - * @deprecated |
|
447 | - */ |
|
448 | - public static function load_tckt_slctr_assets_admin() |
|
449 | - { |
|
450 | - // todo add doing_it_wrong() notice during next major version |
|
451 | - if (EE_Registry::instance()->REQ->get('page') === 'espresso_events' |
|
452 | - && EE_Registry::instance()->REQ->get('action') === 'edit' |
|
453 | - ) { |
|
454 | - $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton(); |
|
455 | - $iframe_embed_button->embedButtonAssets(); |
|
456 | - } |
|
457 | - } |
|
20 | + /** |
|
21 | + * @var DisplayTicketSelector $ticket_selector |
|
22 | + */ |
|
23 | + private static $ticket_selector; |
|
24 | + |
|
25 | + /** |
|
26 | + * @var TicketSelectorIframeEmbedButton $iframe_embed_button |
|
27 | + */ |
|
28 | + private static $iframe_embed_button; |
|
29 | + |
|
30 | + |
|
31 | + /** |
|
32 | + * @return EED_Module|EED_Ticket_Selector |
|
33 | + */ |
|
34 | + public static function instance() |
|
35 | + { |
|
36 | + return parent::get_instance(__CLASS__); |
|
37 | + } |
|
38 | + |
|
39 | + |
|
40 | + /** |
|
41 | + * @return void |
|
42 | + */ |
|
43 | + protected function set_config() |
|
44 | + { |
|
45 | + $this->set_config_section('template_settings'); |
|
46 | + $this->set_config_class('EE_Ticket_Selector_Config'); |
|
47 | + $this->set_config_name('EED_Ticket_Selector'); |
|
48 | + } |
|
49 | + |
|
50 | + |
|
51 | + /** |
|
52 | + * set_hooks - for hooking into EE Core, other modules, etc |
|
53 | + * |
|
54 | + * @return void |
|
55 | + */ |
|
56 | + public static function set_hooks() |
|
57 | + { |
|
58 | + // routing |
|
59 | + EE_Config::register_route( |
|
60 | + 'iframe', |
|
61 | + 'EED_Ticket_Selector', |
|
62 | + 'ticket_selector_iframe', |
|
63 | + 'ticket_selector' |
|
64 | + ); |
|
65 | + EE_Config::register_route( |
|
66 | + 'process_ticket_selections', |
|
67 | + 'EED_Ticket_Selector', |
|
68 | + 'process_ticket_selections' |
|
69 | + ); |
|
70 | + EE_Config::register_route( |
|
71 | + 'cancel_ticket_selections', |
|
72 | + 'EED_Ticket_Selector', |
|
73 | + 'cancel_ticket_selections' |
|
74 | + ); |
|
75 | + add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2); |
|
76 | + add_action('AHEE_event_details_header_bottom', array('EED_Ticket_Selector', 'display_ticket_selector'), 10, 1); |
|
77 | + add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'translate_js_strings'), 0); |
|
78 | + add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets'), 10); |
|
79 | + EED_Ticket_Selector::loadIframeAssets(); |
|
80 | + } |
|
81 | + |
|
82 | + |
|
83 | + /** |
|
84 | + * set_hooks_admin - for hooking into EE Admin Core, other modules, etc |
|
85 | + * |
|
86 | + * @return void |
|
87 | + */ |
|
88 | + public static function set_hooks_admin() |
|
89 | + { |
|
90 | + // hook into the end of the \EE_Admin_Page::_load_page_dependencies() |
|
91 | + // to load assets for "espresso_events" page on the "edit" route (action) |
|
92 | + add_action( |
|
93 | + 'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__edit', |
|
94 | + array('EED_Ticket_Selector', 'ticket_selector_iframe_embed_button'), |
|
95 | + 10 |
|
96 | + ); |
|
97 | + /** |
|
98 | + * Make sure assets for the ticket selector are loaded on the espresso registrations route so admin side |
|
99 | + * registrations work. |
|
100 | + */ |
|
101 | + add_action( |
|
102 | + 'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration', |
|
103 | + array('EED_Ticket_Selector', 'set_definitions'), |
|
104 | + 10 |
|
105 | + ); |
|
106 | + } |
|
107 | + |
|
108 | + |
|
109 | + /** |
|
110 | + * set_definitions |
|
111 | + * |
|
112 | + * @return void |
|
113 | + * @throws InvalidArgumentException |
|
114 | + * @throws InvalidDataTypeException |
|
115 | + * @throws InvalidInterfaceException |
|
116 | + */ |
|
117 | + public static function set_definitions() |
|
118 | + { |
|
119 | + // don't do this twice |
|
120 | + if (defined('TICKET_SELECTOR_ASSETS_URL')) { |
|
121 | + return; |
|
122 | + } |
|
123 | + define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/'); |
|
124 | + define( |
|
125 | + 'TICKET_SELECTOR_TEMPLATES_PATH', |
|
126 | + str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/' |
|
127 | + ); |
|
128 | + // if config is not set, initialize |
|
129 | + if (! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config |
|
130 | + ) { |
|
131 | + EED_Ticket_Selector::instance()->set_config(); |
|
132 | + EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = EED_Ticket_Selector::instance( |
|
133 | + )->config(); |
|
134 | + } |
|
135 | + } |
|
136 | + |
|
137 | + |
|
138 | + /** |
|
139 | + * @return DisplayTicketSelector |
|
140 | + */ |
|
141 | + public static function ticketSelector() |
|
142 | + { |
|
143 | + if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) { |
|
144 | + EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(EED_Events_Archive::is_iframe()); |
|
145 | + } |
|
146 | + return EED_Ticket_Selector::$ticket_selector; |
|
147 | + } |
|
148 | + |
|
149 | + |
|
150 | + /** |
|
151 | + * gets the ball rolling |
|
152 | + * |
|
153 | + * @param WP $WP |
|
154 | + * @return void |
|
155 | + */ |
|
156 | + public function run($WP) |
|
157 | + { |
|
158 | + } |
|
159 | + |
|
160 | + |
|
161 | + /** |
|
162 | + * @return TicketSelectorIframeEmbedButton |
|
163 | + */ |
|
164 | + public static function getIframeEmbedButton() |
|
165 | + { |
|
166 | + if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) { |
|
167 | + self::$iframe_embed_button = new TicketSelectorIframeEmbedButton(); |
|
168 | + } |
|
169 | + return self::$iframe_embed_button; |
|
170 | + } |
|
171 | + |
|
172 | + |
|
173 | + /** |
|
174 | + * ticket_selector_iframe_embed_button |
|
175 | + * |
|
176 | + * @return void |
|
177 | + * @throws EE_Error |
|
178 | + */ |
|
179 | + public static function ticket_selector_iframe_embed_button() |
|
180 | + { |
|
181 | + $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton(); |
|
182 | + $iframe_embed_button->addEventEditorIframeEmbedButton(); |
|
183 | + } |
|
184 | + |
|
185 | + |
|
186 | + /** |
|
187 | + * ticket_selector_iframe |
|
188 | + * |
|
189 | + * @return void |
|
190 | + * @throws DomainException |
|
191 | + * @throws EE_Error |
|
192 | + */ |
|
193 | + public function ticket_selector_iframe() |
|
194 | + { |
|
195 | + $ticket_selector_iframe = new TicketSelectorIframe(); |
|
196 | + $ticket_selector_iframe->display(); |
|
197 | + } |
|
198 | + |
|
199 | + |
|
200 | + /** |
|
201 | + * creates buttons for selecting number of attendees for an event |
|
202 | + * |
|
203 | + * @param WP_Post|int $event |
|
204 | + * @param bool $view_details |
|
205 | + * @return string |
|
206 | + * @throws EE_Error |
|
207 | + */ |
|
208 | + public static function display_ticket_selector($event = null, $view_details = false) |
|
209 | + { |
|
210 | + return EED_Ticket_Selector::ticketSelector()->display($event, $view_details); |
|
211 | + } |
|
212 | + |
|
213 | + |
|
214 | + /** |
|
215 | + * @return array or FALSE |
|
216 | + * @throws \ReflectionException |
|
217 | + * @throws \EE_Error |
|
218 | + * @throws InvalidArgumentException |
|
219 | + * @throws InvalidInterfaceException |
|
220 | + * @throws InvalidDataTypeException |
|
221 | + */ |
|
222 | + public function process_ticket_selections() |
|
223 | + { |
|
224 | + /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */ |
|
225 | + $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector'); |
|
226 | + return $form->processTicketSelections(); |
|
227 | + } |
|
228 | + |
|
229 | + |
|
230 | + /** |
|
231 | + * @return string |
|
232 | + * @throws InvalidArgumentException |
|
233 | + * @throws InvalidInterfaceException |
|
234 | + * @throws InvalidDataTypeException |
|
235 | + * @throws EE_Error |
|
236 | + */ |
|
237 | + public static function cancel_ticket_selections() |
|
238 | + { |
|
239 | + /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */ |
|
240 | + $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector'); |
|
241 | + return $form->cancelTicketSelections(); |
|
242 | + } |
|
243 | + |
|
244 | + |
|
245 | + /** |
|
246 | + * @return void |
|
247 | + */ |
|
248 | + public static function translate_js_strings() |
|
249 | + { |
|
250 | + EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__( |
|
251 | + 'please select a datetime', |
|
252 | + 'event_espresso' |
|
253 | + ); |
|
254 | + } |
|
255 | + |
|
256 | + |
|
257 | + /** |
|
258 | + * @return void |
|
259 | + */ |
|
260 | + public static function load_tckt_slctr_assets() |
|
261 | + { |
|
262 | + if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', false)) { |
|
263 | + // add some style |
|
264 | + wp_register_style( |
|
265 | + 'ticket_selector', |
|
266 | + TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css', |
|
267 | + array(), |
|
268 | + EVENT_ESPRESSO_VERSION |
|
269 | + ); |
|
270 | + wp_enqueue_style('ticket_selector'); |
|
271 | + // make it dance |
|
272 | + wp_register_script( |
|
273 | + 'ticket_selector', |
|
274 | + TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', |
|
275 | + array('espresso_core'), |
|
276 | + EVENT_ESPRESSO_VERSION, |
|
277 | + true |
|
278 | + ); |
|
279 | + wp_enqueue_script('ticket_selector'); |
|
280 | + require_once EE_LIBRARIES |
|
281 | + . 'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php'; |
|
282 | + \EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts(); |
|
283 | + } |
|
284 | + } |
|
285 | + |
|
286 | + |
|
287 | + /** |
|
288 | + * @return void |
|
289 | + */ |
|
290 | + public static function loadIframeAssets() |
|
291 | + { |
|
292 | + // for event lists |
|
293 | + add_filter( |
|
294 | + 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css', |
|
295 | + array('EED_Ticket_Selector', 'iframeCss') |
|
296 | + ); |
|
297 | + add_filter( |
|
298 | + 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js', |
|
299 | + array('EED_Ticket_Selector', 'iframeJs') |
|
300 | + ); |
|
301 | + // for ticket selectors |
|
302 | + add_filter( |
|
303 | + 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css', |
|
304 | + array('EED_Ticket_Selector', 'iframeCss') |
|
305 | + ); |
|
306 | + add_filter( |
|
307 | + 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js', |
|
308 | + array('EED_Ticket_Selector', 'iframeJs') |
|
309 | + ); |
|
310 | + } |
|
311 | + |
|
312 | + |
|
313 | + /** |
|
314 | + * Informs the rest of the forms system what CSS and JS is needed to display the input |
|
315 | + * |
|
316 | + * @param array $iframe_css |
|
317 | + * @return array |
|
318 | + */ |
|
319 | + public static function iframeCss(array $iframe_css) |
|
320 | + { |
|
321 | + $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css'; |
|
322 | + return $iframe_css; |
|
323 | + } |
|
324 | + |
|
325 | + |
|
326 | + /** |
|
327 | + * Informs the rest of the forms system what CSS and JS is needed to display the input |
|
328 | + * |
|
329 | + * @param array $iframe_js |
|
330 | + * @return array |
|
331 | + */ |
|
332 | + public static function iframeJs(array $iframe_js) |
|
333 | + { |
|
334 | + $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js'; |
|
335 | + return $iframe_js; |
|
336 | + } |
|
337 | + |
|
338 | + |
|
339 | + /****************************** DEPRECATED ******************************/ |
|
340 | + |
|
341 | + |
|
342 | + /** |
|
343 | + * @deprecated |
|
344 | + * @return string |
|
345 | + * @throws EE_Error |
|
346 | + */ |
|
347 | + public static function display_view_details_btn() |
|
348 | + { |
|
349 | + // todo add doing_it_wrong() notice during next major version |
|
350 | + return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton(); |
|
351 | + } |
|
352 | + |
|
353 | + |
|
354 | + /** |
|
355 | + * @deprecated |
|
356 | + * @return string |
|
357 | + * @throws EE_Error |
|
358 | + */ |
|
359 | + public static function display_ticket_selector_submit() |
|
360 | + { |
|
361 | + // todo add doing_it_wrong() notice during next major version |
|
362 | + return EED_Ticket_Selector::ticketSelector()->displaySubmitButton(); |
|
363 | + } |
|
364 | + |
|
365 | + |
|
366 | + /** |
|
367 | + * @deprecated |
|
368 | + * @param string $permalink_string |
|
369 | + * @param int $id |
|
370 | + * @param string $new_title |
|
371 | + * @param string $new_slug |
|
372 | + * @return string |
|
373 | + * @throws InvalidArgumentException |
|
374 | + * @throws InvalidDataTypeException |
|
375 | + * @throws InvalidInterfaceException |
|
376 | + */ |
|
377 | + public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '') |
|
378 | + { |
|
379 | + // todo add doing_it_wrong() notice during next major version |
|
380 | + if (EE_Registry::instance()->REQ->get('page') === 'espresso_events' |
|
381 | + && EE_Registry::instance()->REQ->get('action') === 'edit' |
|
382 | + ) { |
|
383 | + $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton(); |
|
384 | + $iframe_embed_button->addEventEditorIframeEmbedButton(); |
|
385 | + } |
|
386 | + return ''; |
|
387 | + } |
|
388 | + |
|
389 | + |
|
390 | + /** |
|
391 | + * @deprecated |
|
392 | + * @param int $ID |
|
393 | + * @param string $external_url |
|
394 | + * @return string |
|
395 | + */ |
|
396 | + public static function ticket_selector_form_open($ID = 0, $external_url = '') |
|
397 | + { |
|
398 | + // todo add doing_it_wrong() notice during next major version |
|
399 | + return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url); |
|
400 | + } |
|
401 | + |
|
402 | + |
|
403 | + /** |
|
404 | + * @deprecated |
|
405 | + * @return string |
|
406 | + */ |
|
407 | + public static function ticket_selector_form_close() |
|
408 | + { |
|
409 | + // todo add doing_it_wrong() notice during next major version |
|
410 | + return EED_Ticket_Selector::ticketSelector()->formClose(); |
|
411 | + } |
|
412 | + |
|
413 | + |
|
414 | + /** |
|
415 | + * @deprecated |
|
416 | + * @return string |
|
417 | + */ |
|
418 | + public static function no_tkt_slctr_end_dv() |
|
419 | + { |
|
420 | + // todo add doing_it_wrong() notice during next major version |
|
421 | + return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv(); |
|
422 | + } |
|
423 | + |
|
424 | + |
|
425 | + /** |
|
426 | + * @deprecated 4.9.13 |
|
427 | + * @return string |
|
428 | + */ |
|
429 | + public static function tkt_slctr_end_dv() |
|
430 | + { |
|
431 | + return EED_Ticket_Selector::ticketSelector()->clearTicketSelector(); |
|
432 | + } |
|
433 | + |
|
434 | + |
|
435 | + /** |
|
436 | + * @deprecated |
|
437 | + * @return string |
|
438 | + */ |
|
439 | + public static function clear_tkt_slctr() |
|
440 | + { |
|
441 | + return EED_Ticket_Selector::ticketSelector()->clearTicketSelector(); |
|
442 | + } |
|
443 | + |
|
444 | + |
|
445 | + /** |
|
446 | + * @deprecated |
|
447 | + */ |
|
448 | + public static function load_tckt_slctr_assets_admin() |
|
449 | + { |
|
450 | + // todo add doing_it_wrong() notice during next major version |
|
451 | + if (EE_Registry::instance()->REQ->get('page') === 'espresso_events' |
|
452 | + && EE_Registry::instance()->REQ->get('action') === 'edit' |
|
453 | + ) { |
|
454 | + $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton(); |
|
455 | + $iframe_embed_button->embedButtonAssets(); |
|
456 | + } |
|
457 | + } |
|
458 | 458 | } |
@@ -120,13 +120,13 @@ discard block |
||
120 | 120 | if (defined('TICKET_SELECTOR_ASSETS_URL')) { |
121 | 121 | return; |
122 | 122 | } |
123 | - define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/'); |
|
123 | + define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__).'assets/'); |
|
124 | 124 | define( |
125 | 125 | 'TICKET_SELECTOR_TEMPLATES_PATH', |
126 | - str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/' |
|
126 | + str_replace('\\', '/', plugin_dir_path(__FILE__)).'templates/' |
|
127 | 127 | ); |
128 | 128 | // if config is not set, initialize |
129 | - if (! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config |
|
129 | + if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config |
|
130 | 130 | ) { |
131 | 131 | EED_Ticket_Selector::instance()->set_config(); |
132 | 132 | EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = EED_Ticket_Selector::instance( |
@@ -140,7 +140,7 @@ discard block |
||
140 | 140 | */ |
141 | 141 | public static function ticketSelector() |
142 | 142 | { |
143 | - if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) { |
|
143 | + if ( ! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) { |
|
144 | 144 | EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(EED_Events_Archive::is_iframe()); |
145 | 145 | } |
146 | 146 | return EED_Ticket_Selector::$ticket_selector; |
@@ -163,7 +163,7 @@ discard block |
||
163 | 163 | */ |
164 | 164 | public static function getIframeEmbedButton() |
165 | 165 | { |
166 | - if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) { |
|
166 | + if ( ! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) { |
|
167 | 167 | self::$iframe_embed_button = new TicketSelectorIframeEmbedButton(); |
168 | 168 | } |
169 | 169 | return self::$iframe_embed_button; |
@@ -263,7 +263,7 @@ discard block |
||
263 | 263 | // add some style |
264 | 264 | wp_register_style( |
265 | 265 | 'ticket_selector', |
266 | - TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css', |
|
266 | + TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css', |
|
267 | 267 | array(), |
268 | 268 | EVENT_ESPRESSO_VERSION |
269 | 269 | ); |
@@ -271,7 +271,7 @@ discard block |
||
271 | 271 | // make it dance |
272 | 272 | wp_register_script( |
273 | 273 | 'ticket_selector', |
274 | - TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', |
|
274 | + TICKET_SELECTOR_ASSETS_URL.'ticket_selector.js', |
|
275 | 275 | array('espresso_core'), |
276 | 276 | EVENT_ESPRESSO_VERSION, |
277 | 277 | true |
@@ -318,7 +318,7 @@ discard block |
||
318 | 318 | */ |
319 | 319 | public static function iframeCss(array $iframe_css) |
320 | 320 | { |
321 | - $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css'; |
|
321 | + $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css'; |
|
322 | 322 | return $iframe_css; |
323 | 323 | } |
324 | 324 | |
@@ -331,7 +331,7 @@ discard block |
||
331 | 331 | */ |
332 | 332 | public static function iframeJs(array $iframe_js) |
333 | 333 | { |
334 | - $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js'; |
|
334 | + $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL.'ticket_selector.js'; |
|
335 | 335 | return $iframe_js; |
336 | 336 | } |
337 | 337 |
@@ -65,7 +65,7 @@ |
||
65 | 65 | */ |
66 | 66 | public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array()) |
67 | 67 | { |
68 | - $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm( |
|
68 | + $this->custom_taxonomy_terms[][$term_slug] = new CustomTaxonomyTerm( |
|
69 | 69 | $taxonomy, |
70 | 70 | $term_slug, |
71 | 71 | $cpt_slugs |
@@ -16,180 +16,180 @@ |
||
16 | 16 | class RegisterCustomTaxonomyTerms |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * @var array[] $custom_taxonomy_terms |
|
21 | - */ |
|
22 | - public $custom_taxonomy_terms = array(); |
|
23 | - |
|
24 | - |
|
25 | - /** |
|
26 | - * RegisterCustomTaxonomyTerms constructor. |
|
27 | - */ |
|
28 | - public function __construct() |
|
29 | - { |
|
30 | - // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts |
|
31 | - // IF they don't have a term for that taxonomy set. |
|
32 | - add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2); |
|
33 | - do_action( |
|
34 | - 'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end', |
|
35 | - $this |
|
36 | - ); |
|
37 | - } |
|
38 | - |
|
39 | - |
|
40 | - public function registerCustomTaxonomyTerms() |
|
41 | - { |
|
42 | - // setup default terms in any of our taxonomies (but only if we're in admin). |
|
43 | - // Why not added via register_activation_hook? |
|
44 | - // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies |
|
45 | - // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin. |
|
46 | - // Keep in mind that this will READ these terms if they are deleted by the user. Hence MUST use terms. |
|
47 | - // if ( is_admin() ) { |
|
48 | - // $this->set_must_use_event_types(); |
|
49 | - // } |
|
50 | - // set default terms |
|
51 | - $this->registerCustomTaxonomyTerm( |
|
52 | - 'espresso_event_type', |
|
53 | - 'single-event', |
|
54 | - array('espresso_events') |
|
55 | - ); |
|
56 | - } |
|
57 | - |
|
58 | - |
|
59 | - /** |
|
60 | - * Allows us to set what the default will be for terms when a cpt is PUBLISHED. |
|
61 | - * |
|
62 | - * @param string $taxonomy The taxonomy we're using for the default term |
|
63 | - * @param string $term_slug The slug of the term that will be the default. |
|
64 | - * @param array $cpt_slugs An array of custom post types we want the default assigned to |
|
65 | - */ |
|
66 | - public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array()) |
|
67 | - { |
|
68 | - $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm( |
|
69 | - $taxonomy, |
|
70 | - $term_slug, |
|
71 | - $cpt_slugs |
|
72 | - ); |
|
73 | - } |
|
74 | - |
|
75 | - |
|
76 | - /** |
|
77 | - * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property |
|
78 | - * |
|
79 | - * @param int $post_id ID of CPT being saved |
|
80 | - * @param WP_Post $post Post object |
|
81 | - * @return void |
|
82 | - */ |
|
83 | - public function saveDefaultTerm($post_id, WP_Post $post) |
|
84 | - { |
|
85 | - if (empty($this->custom_taxonomy_terms)) { |
|
86 | - return; |
|
87 | - } |
|
88 | - // no default terms set so lets just exit. |
|
89 | - foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) { |
|
90 | - foreach ($custom_taxonomy_terms as $custom_taxonomy_term) { |
|
91 | - if ($post->post_status === 'publish' |
|
92 | - && $custom_taxonomy_term instanceof CustomTaxonomyTerm |
|
93 | - && in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true) |
|
94 | - ) { |
|
95 | - // note some error proofing going on here to save unnecessary db queries |
|
96 | - $taxonomies = get_object_taxonomies($post->post_type); |
|
97 | - foreach ($taxonomies as $taxonomy) { |
|
98 | - $terms = wp_get_post_terms($post_id, $taxonomy); |
|
99 | - if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) { |
|
100 | - wp_set_object_terms( |
|
101 | - $post_id, |
|
102 | - array($custom_taxonomy_term->termSlug()), |
|
103 | - $taxonomy |
|
104 | - ); |
|
105 | - } |
|
106 | - } |
|
107 | - } |
|
108 | - } |
|
109 | - } |
|
110 | - } |
|
111 | - |
|
112 | - |
|
113 | - /** |
|
114 | - * @return void |
|
115 | - */ |
|
116 | - public function setMustUseEventTypes() |
|
117 | - { |
|
118 | - $term_details = array( |
|
119 | - // Attendee's register for the first date-time only |
|
120 | - 'single-event' => array( |
|
121 | - 'term' => esc_html__('Single Event', 'event_espresso'), |
|
122 | - 'desc' => esc_html__( |
|
123 | - 'A single event that spans one or more consecutive days.', |
|
124 | - 'event_espresso' |
|
125 | - ), |
|
126 | - ), |
|
127 | - // example: a party or two-day long workshop |
|
128 | - // Attendee's can register for any of the date-times |
|
129 | - 'multi-event' => array( |
|
130 | - 'term' => esc_html__('Multi Event', 'event_espresso'), |
|
131 | - 'desc' => esc_html__( |
|
132 | - 'Multiple, separate, but related events that occur on consecutive days.', |
|
133 | - 'event_espresso' |
|
134 | - ), |
|
135 | - ), |
|
136 | - // example: a three day music festival or week long conference |
|
137 | - // Attendee's register for the first date-time only |
|
138 | - 'event-series' => array( |
|
139 | - 'term' => esc_html__('Event Series', 'event_espresso'), |
|
140 | - 'desc' => esc_html__( |
|
141 | - ' Multiple events that occur over multiple non-consecutive days.', |
|
142 | - 'event_espresso' |
|
143 | - ), |
|
144 | - ), |
|
145 | - // example: an 8 week introduction to basket weaving course |
|
146 | - // Attendee's can register for any of the date-times. |
|
147 | - 'recurring-event' => array( |
|
148 | - 'term' => esc_html__('Recurring Event', 'event_espresso'), |
|
149 | - 'desc' => esc_html__( |
|
150 | - 'Multiple events that occur over multiple non-consecutive days.', |
|
151 | - 'event_espresso' |
|
152 | - ), |
|
153 | - ), |
|
154 | - // example: a yoga class |
|
155 | - 'ongoing' => array( |
|
156 | - 'term' => esc_html__('Ongoing Event', 'event_espresso'), |
|
157 | - 'desc' => esc_html__( |
|
158 | - 'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event', |
|
159 | - 'event_espresso' |
|
160 | - ), |
|
161 | - ) |
|
162 | - // example: access to a museum |
|
163 | - // 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ), |
|
164 | - // 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
165 | - // 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
166 | - // 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') ) |
|
167 | - ); |
|
168 | - $this->setMustUseTerms('espresso_event_type', $term_details); |
|
169 | - } |
|
170 | - |
|
171 | - |
|
172 | - /** |
|
173 | - * wrapper method for handling the setting up of initial terms in the db (if they don't already exist). |
|
174 | - * Note this should ONLY be used for terms that always must be present. Be aware that if an initial term is |
|
175 | - * deleted then it WILL be recreated. |
|
176 | - * |
|
177 | - * @param string $taxonomy The name of the taxonomy |
|
178 | - * @param array $term_details An array of term details indexed by slug and containing Name of term, and |
|
179 | - * description as the elements in the array |
|
180 | - * @return void |
|
181 | - */ |
|
182 | - public function setMustUseTerms($taxonomy, $term_details) |
|
183 | - { |
|
184 | - $term_details = (array) $term_details; |
|
185 | - foreach ($term_details as $slug => $details) { |
|
186 | - if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) { |
|
187 | - $insert_arr = array( |
|
188 | - 'slug' => $slug, |
|
189 | - 'description' => $details['desc'], |
|
190 | - ); |
|
191 | - wp_insert_term($details['term'], $taxonomy, $insert_arr); |
|
192 | - } |
|
193 | - } |
|
194 | - } |
|
19 | + /** |
|
20 | + * @var array[] $custom_taxonomy_terms |
|
21 | + */ |
|
22 | + public $custom_taxonomy_terms = array(); |
|
23 | + |
|
24 | + |
|
25 | + /** |
|
26 | + * RegisterCustomTaxonomyTerms constructor. |
|
27 | + */ |
|
28 | + public function __construct() |
|
29 | + { |
|
30 | + // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts |
|
31 | + // IF they don't have a term for that taxonomy set. |
|
32 | + add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2); |
|
33 | + do_action( |
|
34 | + 'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end', |
|
35 | + $this |
|
36 | + ); |
|
37 | + } |
|
38 | + |
|
39 | + |
|
40 | + public function registerCustomTaxonomyTerms() |
|
41 | + { |
|
42 | + // setup default terms in any of our taxonomies (but only if we're in admin). |
|
43 | + // Why not added via register_activation_hook? |
|
44 | + // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies |
|
45 | + // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin. |
|
46 | + // Keep in mind that this will READ these terms if they are deleted by the user. Hence MUST use terms. |
|
47 | + // if ( is_admin() ) { |
|
48 | + // $this->set_must_use_event_types(); |
|
49 | + // } |
|
50 | + // set default terms |
|
51 | + $this->registerCustomTaxonomyTerm( |
|
52 | + 'espresso_event_type', |
|
53 | + 'single-event', |
|
54 | + array('espresso_events') |
|
55 | + ); |
|
56 | + } |
|
57 | + |
|
58 | + |
|
59 | + /** |
|
60 | + * Allows us to set what the default will be for terms when a cpt is PUBLISHED. |
|
61 | + * |
|
62 | + * @param string $taxonomy The taxonomy we're using for the default term |
|
63 | + * @param string $term_slug The slug of the term that will be the default. |
|
64 | + * @param array $cpt_slugs An array of custom post types we want the default assigned to |
|
65 | + */ |
|
66 | + public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array()) |
|
67 | + { |
|
68 | + $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm( |
|
69 | + $taxonomy, |
|
70 | + $term_slug, |
|
71 | + $cpt_slugs |
|
72 | + ); |
|
73 | + } |
|
74 | + |
|
75 | + |
|
76 | + /** |
|
77 | + * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property |
|
78 | + * |
|
79 | + * @param int $post_id ID of CPT being saved |
|
80 | + * @param WP_Post $post Post object |
|
81 | + * @return void |
|
82 | + */ |
|
83 | + public function saveDefaultTerm($post_id, WP_Post $post) |
|
84 | + { |
|
85 | + if (empty($this->custom_taxonomy_terms)) { |
|
86 | + return; |
|
87 | + } |
|
88 | + // no default terms set so lets just exit. |
|
89 | + foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) { |
|
90 | + foreach ($custom_taxonomy_terms as $custom_taxonomy_term) { |
|
91 | + if ($post->post_status === 'publish' |
|
92 | + && $custom_taxonomy_term instanceof CustomTaxonomyTerm |
|
93 | + && in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true) |
|
94 | + ) { |
|
95 | + // note some error proofing going on here to save unnecessary db queries |
|
96 | + $taxonomies = get_object_taxonomies($post->post_type); |
|
97 | + foreach ($taxonomies as $taxonomy) { |
|
98 | + $terms = wp_get_post_terms($post_id, $taxonomy); |
|
99 | + if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) { |
|
100 | + wp_set_object_terms( |
|
101 | + $post_id, |
|
102 | + array($custom_taxonomy_term->termSlug()), |
|
103 | + $taxonomy |
|
104 | + ); |
|
105 | + } |
|
106 | + } |
|
107 | + } |
|
108 | + } |
|
109 | + } |
|
110 | + } |
|
111 | + |
|
112 | + |
|
113 | + /** |
|
114 | + * @return void |
|
115 | + */ |
|
116 | + public function setMustUseEventTypes() |
|
117 | + { |
|
118 | + $term_details = array( |
|
119 | + // Attendee's register for the first date-time only |
|
120 | + 'single-event' => array( |
|
121 | + 'term' => esc_html__('Single Event', 'event_espresso'), |
|
122 | + 'desc' => esc_html__( |
|
123 | + 'A single event that spans one or more consecutive days.', |
|
124 | + 'event_espresso' |
|
125 | + ), |
|
126 | + ), |
|
127 | + // example: a party or two-day long workshop |
|
128 | + // Attendee's can register for any of the date-times |
|
129 | + 'multi-event' => array( |
|
130 | + 'term' => esc_html__('Multi Event', 'event_espresso'), |
|
131 | + 'desc' => esc_html__( |
|
132 | + 'Multiple, separate, but related events that occur on consecutive days.', |
|
133 | + 'event_espresso' |
|
134 | + ), |
|
135 | + ), |
|
136 | + // example: a three day music festival or week long conference |
|
137 | + // Attendee's register for the first date-time only |
|
138 | + 'event-series' => array( |
|
139 | + 'term' => esc_html__('Event Series', 'event_espresso'), |
|
140 | + 'desc' => esc_html__( |
|
141 | + ' Multiple events that occur over multiple non-consecutive days.', |
|
142 | + 'event_espresso' |
|
143 | + ), |
|
144 | + ), |
|
145 | + // example: an 8 week introduction to basket weaving course |
|
146 | + // Attendee's can register for any of the date-times. |
|
147 | + 'recurring-event' => array( |
|
148 | + 'term' => esc_html__('Recurring Event', 'event_espresso'), |
|
149 | + 'desc' => esc_html__( |
|
150 | + 'Multiple events that occur over multiple non-consecutive days.', |
|
151 | + 'event_espresso' |
|
152 | + ), |
|
153 | + ), |
|
154 | + // example: a yoga class |
|
155 | + 'ongoing' => array( |
|
156 | + 'term' => esc_html__('Ongoing Event', 'event_espresso'), |
|
157 | + 'desc' => esc_html__( |
|
158 | + 'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event', |
|
159 | + 'event_espresso' |
|
160 | + ), |
|
161 | + ) |
|
162 | + // example: access to a museum |
|
163 | + // 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ), |
|
164 | + // 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
165 | + // 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
166 | + // 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') ) |
|
167 | + ); |
|
168 | + $this->setMustUseTerms('espresso_event_type', $term_details); |
|
169 | + } |
|
170 | + |
|
171 | + |
|
172 | + /** |
|
173 | + * wrapper method for handling the setting up of initial terms in the db (if they don't already exist). |
|
174 | + * Note this should ONLY be used for terms that always must be present. Be aware that if an initial term is |
|
175 | + * deleted then it WILL be recreated. |
|
176 | + * |
|
177 | + * @param string $taxonomy The name of the taxonomy |
|
178 | + * @param array $term_details An array of term details indexed by slug and containing Name of term, and |
|
179 | + * description as the elements in the array |
|
180 | + * @return void |
|
181 | + */ |
|
182 | + public function setMustUseTerms($taxonomy, $term_details) |
|
183 | + { |
|
184 | + $term_details = (array) $term_details; |
|
185 | + foreach ($term_details as $slug => $details) { |
|
186 | + if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) { |
|
187 | + $insert_arr = array( |
|
188 | + 'slug' => $slug, |
|
189 | + 'description' => $details['desc'], |
|
190 | + ); |
|
191 | + wp_insert_term($details['term'], $taxonomy, $insert_arr); |
|
192 | + } |
|
193 | + } |
|
194 | + } |
|
195 | 195 | } |
@@ -47,7 +47,7 @@ |
||
47 | 47 | */ |
48 | 48 | public function __construct($generator) |
49 | 49 | { |
50 | - if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
50 | + if ( ! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
51 | 51 | throw new InvalidArgumentException( |
52 | 52 | esc_html__( |
53 | 53 | 'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.', |
@@ -29,108 +29,108 @@ |
||
29 | 29 | class CoreLoader implements LoaderDecoratorInterface |
30 | 30 | { |
31 | 31 | |
32 | - /** |
|
33 | - * @var EE_Registry|CoffeeShop $generator |
|
34 | - */ |
|
35 | - private $generator; |
|
32 | + /** |
|
33 | + * @var EE_Registry|CoffeeShop $generator |
|
34 | + */ |
|
35 | + private $generator; |
|
36 | 36 | |
37 | 37 | |
38 | - /** |
|
39 | - * CoreLoader constructor. |
|
40 | - * |
|
41 | - * @param EE_Registry|CoffeeShop $generator |
|
42 | - * @throws InvalidArgumentException |
|
43 | - */ |
|
44 | - public function __construct($generator) |
|
45 | - { |
|
46 | - if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
47 | - throw new InvalidArgumentException( |
|
48 | - esc_html__( |
|
49 | - 'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.', |
|
50 | - 'event_espresso' |
|
51 | - ) |
|
52 | - ); |
|
53 | - } |
|
54 | - $this->generator = $generator; |
|
55 | - } |
|
38 | + /** |
|
39 | + * CoreLoader constructor. |
|
40 | + * |
|
41 | + * @param EE_Registry|CoffeeShop $generator |
|
42 | + * @throws InvalidArgumentException |
|
43 | + */ |
|
44 | + public function __construct($generator) |
|
45 | + { |
|
46 | + if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
47 | + throw new InvalidArgumentException( |
|
48 | + esc_html__( |
|
49 | + 'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.', |
|
50 | + 'event_espresso' |
|
51 | + ) |
|
52 | + ); |
|
53 | + } |
|
54 | + $this->generator = $generator; |
|
55 | + } |
|
56 | 56 | |
57 | 57 | |
58 | - /** |
|
59 | - * Calls the appropriate loading method from the installed generator; |
|
60 | - * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method |
|
61 | - * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(), |
|
62 | - * but NOT to the class being instantiated. |
|
63 | - * This is done by adding the parameters to the $arguments array as follows: |
|
64 | - * array( |
|
65 | - * 'EE_Registry::create(from_db)' => true, // boolean value, default = false |
|
66 | - * 'EE_Registry::create(load_only)' => true, // boolean value, default = false |
|
67 | - * 'EE_Registry::create(addon)' => true, // boolean value, default = false |
|
68 | - * ) |
|
69 | - * |
|
70 | - * @param string $fqcn |
|
71 | - * @param array $arguments |
|
72 | - * @param bool $shared |
|
73 | - * @return mixed |
|
74 | - * @throws OutOfBoundsException |
|
75 | - * @throws ServiceExistsException |
|
76 | - * @throws InstantiationException |
|
77 | - * @throws InvalidIdentifierException |
|
78 | - * @throws InvalidDataTypeException |
|
79 | - * @throws InvalidClassException |
|
80 | - * @throws EE_Error |
|
81 | - * @throws ServiceNotFoundException |
|
82 | - * @throws ReflectionException |
|
83 | - * @throws InvalidInterfaceException |
|
84 | - * @throws InvalidArgumentException |
|
85 | - */ |
|
86 | - public function load($fqcn, $arguments = array(), $shared = true) |
|
87 | - { |
|
88 | - $shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN); |
|
89 | - if ($this->generator instanceof EE_Registry) { |
|
90 | - // check if additional EE_Registry::create() arguments have been passed |
|
91 | - // from_db |
|
92 | - $from_db = isset($arguments['EE_Registry::create(from_db)']) |
|
93 | - ? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN) |
|
94 | - : false; |
|
95 | - // load_only |
|
96 | - $load_only = isset($arguments['EE_Registry::create(load_only)']) |
|
97 | - ? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN) |
|
98 | - : false; |
|
99 | - // addon |
|
100 | - $addon = isset($arguments['EE_Registry::create(addon)']) |
|
101 | - ? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN) |
|
102 | - : false; |
|
103 | - unset( |
|
104 | - $arguments['EE_Registry::create(from_db)'], |
|
105 | - $arguments['EE_Registry::create(load_only)'], |
|
106 | - $arguments['EE_Registry::create(addon)'] |
|
107 | - ); |
|
108 | - // addons need to be cached on EE_Registry |
|
109 | - $shared = $addon ? true : $shared; |
|
110 | - return $this->generator->create( |
|
111 | - $fqcn, |
|
112 | - $arguments, |
|
113 | - $shared, |
|
114 | - $from_db, |
|
115 | - $load_only, |
|
116 | - $addon |
|
117 | - ); |
|
118 | - } |
|
119 | - return $this->generator->brew( |
|
120 | - $fqcn, |
|
121 | - $arguments, |
|
122 | - $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW |
|
123 | - ); |
|
124 | - } |
|
58 | + /** |
|
59 | + * Calls the appropriate loading method from the installed generator; |
|
60 | + * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method |
|
61 | + * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(), |
|
62 | + * but NOT to the class being instantiated. |
|
63 | + * This is done by adding the parameters to the $arguments array as follows: |
|
64 | + * array( |
|
65 | + * 'EE_Registry::create(from_db)' => true, // boolean value, default = false |
|
66 | + * 'EE_Registry::create(load_only)' => true, // boolean value, default = false |
|
67 | + * 'EE_Registry::create(addon)' => true, // boolean value, default = false |
|
68 | + * ) |
|
69 | + * |
|
70 | + * @param string $fqcn |
|
71 | + * @param array $arguments |
|
72 | + * @param bool $shared |
|
73 | + * @return mixed |
|
74 | + * @throws OutOfBoundsException |
|
75 | + * @throws ServiceExistsException |
|
76 | + * @throws InstantiationException |
|
77 | + * @throws InvalidIdentifierException |
|
78 | + * @throws InvalidDataTypeException |
|
79 | + * @throws InvalidClassException |
|
80 | + * @throws EE_Error |
|
81 | + * @throws ServiceNotFoundException |
|
82 | + * @throws ReflectionException |
|
83 | + * @throws InvalidInterfaceException |
|
84 | + * @throws InvalidArgumentException |
|
85 | + */ |
|
86 | + public function load($fqcn, $arguments = array(), $shared = true) |
|
87 | + { |
|
88 | + $shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN); |
|
89 | + if ($this->generator instanceof EE_Registry) { |
|
90 | + // check if additional EE_Registry::create() arguments have been passed |
|
91 | + // from_db |
|
92 | + $from_db = isset($arguments['EE_Registry::create(from_db)']) |
|
93 | + ? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN) |
|
94 | + : false; |
|
95 | + // load_only |
|
96 | + $load_only = isset($arguments['EE_Registry::create(load_only)']) |
|
97 | + ? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN) |
|
98 | + : false; |
|
99 | + // addon |
|
100 | + $addon = isset($arguments['EE_Registry::create(addon)']) |
|
101 | + ? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN) |
|
102 | + : false; |
|
103 | + unset( |
|
104 | + $arguments['EE_Registry::create(from_db)'], |
|
105 | + $arguments['EE_Registry::create(load_only)'], |
|
106 | + $arguments['EE_Registry::create(addon)'] |
|
107 | + ); |
|
108 | + // addons need to be cached on EE_Registry |
|
109 | + $shared = $addon ? true : $shared; |
|
110 | + return $this->generator->create( |
|
111 | + $fqcn, |
|
112 | + $arguments, |
|
113 | + $shared, |
|
114 | + $from_db, |
|
115 | + $load_only, |
|
116 | + $addon |
|
117 | + ); |
|
118 | + } |
|
119 | + return $this->generator->brew( |
|
120 | + $fqcn, |
|
121 | + $arguments, |
|
122 | + $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW |
|
123 | + ); |
|
124 | + } |
|
125 | 125 | |
126 | 126 | |
127 | - /** |
|
128 | - * calls reset() on generator if method exists |
|
129 | - */ |
|
130 | - public function reset() |
|
131 | - { |
|
132 | - if ($this->generator instanceof ResettableInterface) { |
|
133 | - $this->generator->reset(); |
|
134 | - } |
|
135 | - } |
|
127 | + /** |
|
128 | + * calls reset() on generator if method exists |
|
129 | + */ |
|
130 | + public function reset() |
|
131 | + { |
|
132 | + if ($this->generator instanceof ResettableInterface) { |
|
133 | + $this->generator->reset(); |
|
134 | + } |
|
135 | + } |
|
136 | 136 | } |
@@ -53,7 +53,7 @@ discard block |
||
53 | 53 | $identifier = '' |
54 | 54 | ) { |
55 | 55 | parent::__construct($loader); |
56 | - $this->cache = $cache; |
|
56 | + $this->cache = $cache; |
|
57 | 57 | $this->object_identifier = $object_identifier; |
58 | 58 | $this->setIdentifier($identifier); |
59 | 59 | if ($this->identifier !== '') { |
@@ -89,7 +89,7 @@ discard block |
||
89 | 89 | */ |
90 | 90 | private function setIdentifier($identifier) |
91 | 91 | { |
92 | - if (! is_string($identifier)) { |
|
92 | + if ( ! is_string($identifier)) { |
|
93 | 93 | throw new InvalidDataTypeException('$identifier', $identifier, 'string'); |
94 | 94 | } |
95 | 95 | $this->identifier = $identifier; |
@@ -17,158 +17,158 @@ |
||
17 | 17 | class CachingLoader extends CachingLoaderDecorator |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * @var string $identifier |
|
22 | - */ |
|
23 | - protected $identifier; |
|
24 | - |
|
25 | - /** |
|
26 | - * @var CollectionInterface $cache |
|
27 | - */ |
|
28 | - protected $cache; |
|
29 | - |
|
30 | - /** |
|
31 | - * @var ObjectIdentifier |
|
32 | - */ |
|
33 | - private $object_identifier; |
|
34 | - |
|
35 | - |
|
36 | - /** |
|
37 | - * CachingLoader constructor. |
|
38 | - * |
|
39 | - * @param LoaderDecoratorInterface $loader |
|
40 | - * @param CollectionInterface $cache |
|
41 | - * @param ObjectIdentifier $object_identifier |
|
42 | - * @param string $identifier |
|
43 | - * @throws InvalidDataTypeException |
|
44 | - */ |
|
45 | - public function __construct( |
|
46 | - LoaderDecoratorInterface $loader, |
|
47 | - CollectionInterface $cache, |
|
48 | - ObjectIdentifier $object_identifier, |
|
49 | - $identifier = '' |
|
50 | - ) { |
|
51 | - parent::__construct($loader); |
|
52 | - $this->cache = $cache; |
|
53 | - $this->object_identifier = $object_identifier; |
|
54 | - $this->setIdentifier($identifier); |
|
55 | - if ($this->identifier !== '') { |
|
56 | - // to only clear this cache, and assuming an identifier has been set, simply do the following: |
|
57 | - // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER'); |
|
58 | - // where "IDENTIFIER" = the string that was set during construction |
|
59 | - add_action( |
|
60 | - "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}", |
|
61 | - array($this, 'reset') |
|
62 | - ); |
|
63 | - } |
|
64 | - // to clear ALL caches, simply do the following: |
|
65 | - // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache'); |
|
66 | - add_action( |
|
67 | - 'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache', |
|
68 | - array($this, 'reset') |
|
69 | - ); |
|
70 | - } |
|
71 | - |
|
72 | - |
|
73 | - /** |
|
74 | - * @return string |
|
75 | - */ |
|
76 | - public function identifier() |
|
77 | - { |
|
78 | - return $this->identifier; |
|
79 | - } |
|
80 | - |
|
81 | - |
|
82 | - /** |
|
83 | - * @param string $identifier |
|
84 | - * @throws InvalidDataTypeException |
|
85 | - */ |
|
86 | - private function setIdentifier($identifier) |
|
87 | - { |
|
88 | - if (! is_string($identifier)) { |
|
89 | - throw new InvalidDataTypeException('$identifier', $identifier, 'string'); |
|
90 | - } |
|
91 | - $this->identifier = $identifier; |
|
92 | - } |
|
93 | - |
|
94 | - |
|
95 | - /** |
|
96 | - * @param FullyQualifiedName|string $fqcn |
|
97 | - * @param mixed $object |
|
98 | - * @param array $arguments |
|
99 | - * @return bool |
|
100 | - * @throws InvalidArgumentException |
|
101 | - */ |
|
102 | - public function share($fqcn, $object, array $arguments = array()) |
|
103 | - { |
|
104 | - if ($object instanceof $fqcn) { |
|
105 | - return $this->cache->add( |
|
106 | - $object, |
|
107 | - $this->object_identifier->getIdentifier($fqcn, $arguments) |
|
108 | - ); |
|
109 | - } |
|
110 | - throw new InvalidArgumentException( |
|
111 | - sprintf( |
|
112 | - esc_html__( |
|
113 | - 'The supplied class name "%1$s" must match the class of the supplied object.', |
|
114 | - 'event_espresso' |
|
115 | - ), |
|
116 | - $fqcn |
|
117 | - ) |
|
118 | - ); |
|
119 | - } |
|
120 | - |
|
121 | - |
|
122 | - /** |
|
123 | - * @param FullyQualifiedName|string $fqcn |
|
124 | - * @param array $arguments |
|
125 | - * @param bool $shared |
|
126 | - * @param array $interfaces |
|
127 | - * @return mixed |
|
128 | - */ |
|
129 | - public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array()) |
|
130 | - { |
|
131 | - $fqcn = ltrim($fqcn, '\\'); |
|
132 | - // caching can be turned off via the following code: |
|
133 | - // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true'); |
|
134 | - if (apply_filters( |
|
135 | - 'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', |
|
136 | - false, |
|
137 | - $this |
|
138 | - )) { |
|
139 | - // even though $shared might be true, caching could be bypassed for whatever reason, |
|
140 | - // so we don't want the core loader to cache anything, therefore caching is turned off |
|
141 | - return $this->loader->load($fqcn, $arguments, false); |
|
142 | - } |
|
143 | - $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments); |
|
144 | - if ($this->cache->has($object_identifier)) { |
|
145 | - return $this->cache->get($object_identifier); |
|
146 | - } |
|
147 | - $object = $this->loader->load($fqcn, $arguments, $shared); |
|
148 | - if ($object instanceof $fqcn) { |
|
149 | - $this->cache->add($object, $object_identifier); |
|
150 | - } |
|
151 | - return $object; |
|
152 | - } |
|
153 | - |
|
154 | - |
|
155 | - /** |
|
156 | - * empties cache and calls reset() on loader if method exists |
|
157 | - */ |
|
158 | - public function reset() |
|
159 | - { |
|
160 | - $this->clearCache(); |
|
161 | - $this->loader->reset(); |
|
162 | - } |
|
163 | - |
|
164 | - |
|
165 | - /** |
|
166 | - * unsets and detaches ALL objects from the cache |
|
167 | - * |
|
168 | - * @since 4.9.62.p |
|
169 | - */ |
|
170 | - public function clearCache() |
|
171 | - { |
|
172 | - $this->cache->trashAndDetachAll(); |
|
173 | - } |
|
20 | + /** |
|
21 | + * @var string $identifier |
|
22 | + */ |
|
23 | + protected $identifier; |
|
24 | + |
|
25 | + /** |
|
26 | + * @var CollectionInterface $cache |
|
27 | + */ |
|
28 | + protected $cache; |
|
29 | + |
|
30 | + /** |
|
31 | + * @var ObjectIdentifier |
|
32 | + */ |
|
33 | + private $object_identifier; |
|
34 | + |
|
35 | + |
|
36 | + /** |
|
37 | + * CachingLoader constructor. |
|
38 | + * |
|
39 | + * @param LoaderDecoratorInterface $loader |
|
40 | + * @param CollectionInterface $cache |
|
41 | + * @param ObjectIdentifier $object_identifier |
|
42 | + * @param string $identifier |
|
43 | + * @throws InvalidDataTypeException |
|
44 | + */ |
|
45 | + public function __construct( |
|
46 | + LoaderDecoratorInterface $loader, |
|
47 | + CollectionInterface $cache, |
|
48 | + ObjectIdentifier $object_identifier, |
|
49 | + $identifier = '' |
|
50 | + ) { |
|
51 | + parent::__construct($loader); |
|
52 | + $this->cache = $cache; |
|
53 | + $this->object_identifier = $object_identifier; |
|
54 | + $this->setIdentifier($identifier); |
|
55 | + if ($this->identifier !== '') { |
|
56 | + // to only clear this cache, and assuming an identifier has been set, simply do the following: |
|
57 | + // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER'); |
|
58 | + // where "IDENTIFIER" = the string that was set during construction |
|
59 | + add_action( |
|
60 | + "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}", |
|
61 | + array($this, 'reset') |
|
62 | + ); |
|
63 | + } |
|
64 | + // to clear ALL caches, simply do the following: |
|
65 | + // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache'); |
|
66 | + add_action( |
|
67 | + 'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache', |
|
68 | + array($this, 'reset') |
|
69 | + ); |
|
70 | + } |
|
71 | + |
|
72 | + |
|
73 | + /** |
|
74 | + * @return string |
|
75 | + */ |
|
76 | + public function identifier() |
|
77 | + { |
|
78 | + return $this->identifier; |
|
79 | + } |
|
80 | + |
|
81 | + |
|
82 | + /** |
|
83 | + * @param string $identifier |
|
84 | + * @throws InvalidDataTypeException |
|
85 | + */ |
|
86 | + private function setIdentifier($identifier) |
|
87 | + { |
|
88 | + if (! is_string($identifier)) { |
|
89 | + throw new InvalidDataTypeException('$identifier', $identifier, 'string'); |
|
90 | + } |
|
91 | + $this->identifier = $identifier; |
|
92 | + } |
|
93 | + |
|
94 | + |
|
95 | + /** |
|
96 | + * @param FullyQualifiedName|string $fqcn |
|
97 | + * @param mixed $object |
|
98 | + * @param array $arguments |
|
99 | + * @return bool |
|
100 | + * @throws InvalidArgumentException |
|
101 | + */ |
|
102 | + public function share($fqcn, $object, array $arguments = array()) |
|
103 | + { |
|
104 | + if ($object instanceof $fqcn) { |
|
105 | + return $this->cache->add( |
|
106 | + $object, |
|
107 | + $this->object_identifier->getIdentifier($fqcn, $arguments) |
|
108 | + ); |
|
109 | + } |
|
110 | + throw new InvalidArgumentException( |
|
111 | + sprintf( |
|
112 | + esc_html__( |
|
113 | + 'The supplied class name "%1$s" must match the class of the supplied object.', |
|
114 | + 'event_espresso' |
|
115 | + ), |
|
116 | + $fqcn |
|
117 | + ) |
|
118 | + ); |
|
119 | + } |
|
120 | + |
|
121 | + |
|
122 | + /** |
|
123 | + * @param FullyQualifiedName|string $fqcn |
|
124 | + * @param array $arguments |
|
125 | + * @param bool $shared |
|
126 | + * @param array $interfaces |
|
127 | + * @return mixed |
|
128 | + */ |
|
129 | + public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array()) |
|
130 | + { |
|
131 | + $fqcn = ltrim($fqcn, '\\'); |
|
132 | + // caching can be turned off via the following code: |
|
133 | + // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true'); |
|
134 | + if (apply_filters( |
|
135 | + 'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', |
|
136 | + false, |
|
137 | + $this |
|
138 | + )) { |
|
139 | + // even though $shared might be true, caching could be bypassed for whatever reason, |
|
140 | + // so we don't want the core loader to cache anything, therefore caching is turned off |
|
141 | + return $this->loader->load($fqcn, $arguments, false); |
|
142 | + } |
|
143 | + $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments); |
|
144 | + if ($this->cache->has($object_identifier)) { |
|
145 | + return $this->cache->get($object_identifier); |
|
146 | + } |
|
147 | + $object = $this->loader->load($fqcn, $arguments, $shared); |
|
148 | + if ($object instanceof $fqcn) { |
|
149 | + $this->cache->add($object, $object_identifier); |
|
150 | + } |
|
151 | + return $object; |
|
152 | + } |
|
153 | + |
|
154 | + |
|
155 | + /** |
|
156 | + * empties cache and calls reset() on loader if method exists |
|
157 | + */ |
|
158 | + public function reset() |
|
159 | + { |
|
160 | + $this->clearCache(); |
|
161 | + $this->loader->reset(); |
|
162 | + } |
|
163 | + |
|
164 | + |
|
165 | + /** |
|
166 | + * unsets and detaches ALL objects from the cache |
|
167 | + * |
|
168 | + * @since 4.9.62.p |
|
169 | + */ |
|
170 | + public function clearCache() |
|
171 | + { |
|
172 | + $this->cache->trashAndDetachAll(); |
|
173 | + } |
|
174 | 174 | } |
@@ -20,55 +20,55 @@ |
||
20 | 20 | class BlockCollection extends Collection |
21 | 21 | { |
22 | 22 | |
23 | - /** |
|
24 | - * Collection constructor |
|
25 | - * |
|
26 | - * @throws InvalidInterfaceException |
|
27 | - */ |
|
28 | - public function __construct() |
|
29 | - { |
|
30 | - parent::__construct('EventEspresso\core\domain\entities\editor\BlockInterface'); |
|
31 | - } |
|
23 | + /** |
|
24 | + * Collection constructor |
|
25 | + * |
|
26 | + * @throws InvalidInterfaceException |
|
27 | + */ |
|
28 | + public function __construct() |
|
29 | + { |
|
30 | + parent::__construct('EventEspresso\core\domain\entities\editor\BlockInterface'); |
|
31 | + } |
|
32 | 32 | |
33 | 33 | |
34 | - /** |
|
35 | - * unRegisterBlock |
|
36 | - * finds block in the Collection based on the identifier that was set using addObject() |
|
37 | - * and calls unRegisterBlock() on it. Returns block if successful and false if block was not found. |
|
38 | - * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards |
|
39 | - * |
|
40 | - * @param mixed $identifier |
|
41 | - * @return boolean |
|
42 | - */ |
|
43 | - public function unRegisterBlock($identifier) |
|
44 | - { |
|
45 | - $this->rewind(); |
|
46 | - while ($this->valid()) { |
|
47 | - if ($identifier === $this->getInfo()) { |
|
48 | - $object = $this->current(); |
|
49 | - $this->rewind(); |
|
50 | - return $object->unRegisterBlock(); |
|
51 | - } |
|
52 | - $this->next(); |
|
53 | - } |
|
54 | - return false; |
|
55 | - } |
|
34 | + /** |
|
35 | + * unRegisterBlock |
|
36 | + * finds block in the Collection based on the identifier that was set using addObject() |
|
37 | + * and calls unRegisterBlock() on it. Returns block if successful and false if block was not found. |
|
38 | + * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards |
|
39 | + * |
|
40 | + * @param mixed $identifier |
|
41 | + * @return boolean |
|
42 | + */ |
|
43 | + public function unRegisterBlock($identifier) |
|
44 | + { |
|
45 | + $this->rewind(); |
|
46 | + while ($this->valid()) { |
|
47 | + if ($identifier === $this->getInfo()) { |
|
48 | + $object = $this->current(); |
|
49 | + $this->rewind(); |
|
50 | + return $object->unRegisterBlock(); |
|
51 | + } |
|
52 | + $this->next(); |
|
53 | + } |
|
54 | + return false; |
|
55 | + } |
|
56 | 56 | |
57 | 57 | |
58 | - /** |
|
59 | - * unRegisterAllBlocks |
|
60 | - * calls unRegisterBlock() on all blocks in Collection. |
|
61 | - * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards |
|
62 | - * |
|
63 | - * @return void |
|
64 | - */ |
|
65 | - public function unRegisterAllBlocks() |
|
66 | - { |
|
67 | - $this->rewind(); |
|
68 | - while ($this->valid()) { |
|
69 | - $this->current()->unRegisterBlock(); |
|
70 | - $this->next(); |
|
71 | - } |
|
72 | - $this->rewind(); |
|
73 | - } |
|
58 | + /** |
|
59 | + * unRegisterAllBlocks |
|
60 | + * calls unRegisterBlock() on all blocks in Collection. |
|
61 | + * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards |
|
62 | + * |
|
63 | + * @return void |
|
64 | + */ |
|
65 | + public function unRegisterAllBlocks() |
|
66 | + { |
|
67 | + $this->rewind(); |
|
68 | + while ($this->valid()) { |
|
69 | + $this->current()->unRegisterBlock(); |
|
70 | + $this->next(); |
|
71 | + } |
|
72 | + $this->rewind(); |
|
73 | + } |
|
74 | 74 | } |
@@ -51,16 +51,16 @@ discard block |
||
51 | 51 | { |
52 | 52 | $fqn = $this->getFqn($fqn); |
53 | 53 | // have we already seen this FQCN ? |
54 | - if (! array_key_exists($fqn, $this->interfaces)) { |
|
55 | - $this->interfaces[ $fqn ] = array(); |
|
54 | + if ( ! array_key_exists($fqn, $this->interfaces)) { |
|
55 | + $this->interfaces[$fqn] = array(); |
|
56 | 56 | if (class_exists($fqn)) { |
57 | - $this->interfaces[ $fqn ] = class_implements($fqn, false); |
|
58 | - $this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false |
|
59 | - ? $this->interfaces[ $fqn ] |
|
57 | + $this->interfaces[$fqn] = class_implements($fqn, false); |
|
58 | + $this->interfaces[$fqn] = $this->interfaces[$fqn] !== false |
|
59 | + ? $this->interfaces[$fqn] |
|
60 | 60 | : array(); |
61 | 61 | } |
62 | 62 | } |
63 | - return $this->interfaces[ $fqn ]; |
|
63 | + return $this->interfaces[$fqn]; |
|
64 | 64 | } |
65 | 65 | |
66 | 66 | |
@@ -91,13 +91,13 @@ discard block |
||
91 | 91 | // are we adding an alias for a specific class? |
92 | 92 | if ($for_class !== '') { |
93 | 93 | // make sure it's set up as an array |
94 | - if (! isset($this->aliases[ $for_class ])) { |
|
95 | - $this->aliases[ $for_class ] = array(); |
|
94 | + if ( ! isset($this->aliases[$for_class])) { |
|
95 | + $this->aliases[$for_class] = array(); |
|
96 | 96 | } |
97 | - $this->aliases[ $for_class ][ $alias ] = $fqn; |
|
97 | + $this->aliases[$for_class][$alias] = $fqn; |
|
98 | 98 | return; |
99 | 99 | } |
100 | - $this->aliases[ $alias ] = $fqn; |
|
100 | + $this->aliases[$alias] = $fqn; |
|
101 | 101 | } |
102 | 102 | |
103 | 103 | |
@@ -129,7 +129,7 @@ discard block |
||
129 | 129 | */ |
130 | 130 | protected function isDirectAlias($fqn = '') |
131 | 131 | { |
132 | - return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]); |
|
132 | + return isset($this->aliases[(string) $fqn]) && ! is_array($this->aliases[(string) $fqn]); |
|
133 | 133 | } |
134 | 134 | |
135 | 135 | |
@@ -144,7 +144,7 @@ discard block |
||
144 | 144 | { |
145 | 145 | return ( |
146 | 146 | $for_class !== '' |
147 | - && isset($this->aliases[ (string) $for_class ][ (string) $fqn ]) |
|
147 | + && isset($this->aliases[(string) $for_class][(string) $fqn]) |
|
148 | 148 | ); |
149 | 149 | } |
150 | 150 | |
@@ -169,10 +169,10 @@ discard block |
||
169 | 169 | { |
170 | 170 | $alias = $this->getFqn($alias); |
171 | 171 | if ($this->isAliasForClass($alias, $for_class)) { |
172 | - return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class); |
|
172 | + return $this->getFqnForAlias($this->aliases[(string) $for_class][(string) $alias], $for_class); |
|
173 | 173 | } |
174 | 174 | if ($this->isDirectAlias($alias)) { |
175 | - return $this->getFqnForAlias($this->aliases[ (string) $alias ], ''); |
|
175 | + return $this->getFqnForAlias($this->aliases[(string) $alias], ''); |
|
176 | 176 | } |
177 | 177 | return $alias; |
178 | 178 | } |
@@ -17,173 +17,173 @@ |
||
17 | 17 | class ClassInterfaceCache |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * array of interfaces indexed by FQCNs where values are arrays of interface FQNs |
|
22 | - * |
|
23 | - * @var string[][] $interfaces |
|
24 | - */ |
|
25 | - private $interfaces = array(); |
|
26 | - |
|
27 | - /** |
|
28 | - * @type string[][] $aliases |
|
29 | - */ |
|
30 | - protected $aliases = array(); |
|
31 | - |
|
32 | - |
|
33 | - /** |
|
34 | - * @return string[][] |
|
35 | - */ |
|
36 | - public function getAliases() |
|
37 | - { |
|
38 | - return $this->aliases; |
|
39 | - } |
|
40 | - |
|
41 | - /** |
|
42 | - * @param string $fqn |
|
43 | - * @return string |
|
44 | - */ |
|
45 | - public function getFqn($fqn) |
|
46 | - { |
|
47 | - $fqn = $fqn instanceof FullyQualifiedName ? $fqn->string() : $fqn; |
|
48 | - return ltrim($fqn, '\\'); |
|
49 | - } |
|
50 | - |
|
51 | - |
|
52 | - /** |
|
53 | - * @param string $fqn |
|
54 | - * @return array |
|
55 | - */ |
|
56 | - public function getInterfaces($fqn) |
|
57 | - { |
|
58 | - $fqn = $this->getFqn($fqn); |
|
59 | - // have we already seen this FQCN ? |
|
60 | - if (! array_key_exists($fqn, $this->interfaces)) { |
|
61 | - $this->interfaces[ $fqn ] = array(); |
|
62 | - if (class_exists($fqn)) { |
|
63 | - $this->interfaces[ $fqn ] = class_implements($fqn, false); |
|
64 | - $this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false |
|
65 | - ? $this->interfaces[ $fqn ] |
|
66 | - : array(); |
|
67 | - } |
|
68 | - } |
|
69 | - return $this->interfaces[ $fqn ]; |
|
70 | - } |
|
71 | - |
|
72 | - |
|
73 | - /** |
|
74 | - * @param string $fqn |
|
75 | - * @param string $interface |
|
76 | - * @return bool |
|
77 | - */ |
|
78 | - public function hasInterface($fqn, $interface) |
|
79 | - { |
|
80 | - $fqn = $this->getFqn($fqn); |
|
81 | - $interfaces = $this->getInterfaces($fqn); |
|
82 | - return in_array($interface, $interfaces, true); |
|
83 | - } |
|
84 | - |
|
85 | - |
|
86 | - /** |
|
87 | - * adds an alias for a classname |
|
88 | - * |
|
89 | - * @param string $fqn the class name that should be used (concrete class to replace interface) |
|
90 | - * @param string $alias the class name that would be type hinted for (abstract parent or interface) |
|
91 | - * @param string $for_class the class that has the dependency (is type hinting for the interface) |
|
92 | - * @throws InvalidAliasException |
|
93 | - */ |
|
94 | - public function addAlias($fqn, $alias, $for_class = '') |
|
95 | - { |
|
96 | - $fqn = $this->getFqn($fqn); |
|
97 | - $alias = $this->getFqn($alias); |
|
98 | - if (strpos($alias, '\\') !== false && ! is_subclass_of($fqn, $alias)) { |
|
99 | - throw new InvalidAliasException($fqn, $alias); |
|
100 | - } |
|
101 | - // are we adding an alias for a specific class? |
|
102 | - if ($for_class !== '') { |
|
103 | - // make sure it's set up as an array |
|
104 | - if (! isset($this->aliases[ $for_class ])) { |
|
105 | - $this->aliases[ $for_class ] = array(); |
|
106 | - } |
|
107 | - $this->aliases[ $for_class ][ $alias ] = $fqn; |
|
108 | - return; |
|
109 | - } |
|
110 | - $this->aliases[ $alias ] = $fqn; |
|
111 | - } |
|
112 | - |
|
113 | - |
|
114 | - /** |
|
115 | - * returns TRUE if the provided FQN is an alias |
|
116 | - * |
|
117 | - * @param string $fqn |
|
118 | - * @param string $for_class |
|
119 | - * @return bool |
|
120 | - */ |
|
121 | - public function isAlias($fqn = '', $for_class = '') |
|
122 | - { |
|
123 | - $fqn = $this->getFqn($fqn); |
|
124 | - if ($this->isAliasForClass($fqn, $for_class)) { |
|
125 | - return true; |
|
126 | - } |
|
127 | - if ($this->isDirectAlias($fqn)) { |
|
128 | - return true; |
|
129 | - } |
|
130 | - return false; |
|
131 | - } |
|
132 | - |
|
133 | - |
|
134 | - /** |
|
135 | - * returns TRUE if the provided FQN is an alias |
|
136 | - * |
|
137 | - * @param string $fqn |
|
138 | - * @return bool |
|
139 | - */ |
|
140 | - protected function isDirectAlias($fqn = '') |
|
141 | - { |
|
142 | - return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]); |
|
143 | - } |
|
144 | - |
|
145 | - |
|
146 | - /** |
|
147 | - * returns TRUE if the provided FQN is an alias for the specified class |
|
148 | - * |
|
149 | - * @param string $fqn |
|
150 | - * @param string $for_class |
|
151 | - * @return bool |
|
152 | - */ |
|
153 | - protected function isAliasForClass($fqn = '', $for_class = '') |
|
154 | - { |
|
155 | - return ( |
|
156 | - $for_class !== '' |
|
157 | - && isset($this->aliases[ (string) $for_class ][ (string) $fqn ]) |
|
158 | - ); |
|
159 | - } |
|
160 | - |
|
161 | - |
|
162 | - /** |
|
163 | - * returns FQN for provided alias if one exists, otherwise returns the original FQN |
|
164 | - * functions recursively, so that multiple aliases can be used to drill down to a FQN |
|
165 | - * for example: |
|
166 | - * if the following two entries were added to the aliases array: |
|
167 | - * array( |
|
168 | - * 'interface_alias' => 'some\namespace\interface' |
|
169 | - * 'some\namespace\interface' => 'some\namespace\classname' |
|
170 | - * ) |
|
171 | - * then one could use Loader::getNew( 'interface_alias' ) |
|
172 | - * to load an instance of 'some\namespace\classname' |
|
173 | - * |
|
174 | - * @param string $alias |
|
175 | - * @param string $for_class |
|
176 | - * @return string |
|
177 | - */ |
|
178 | - public function getFqnForAlias($alias = '', $for_class = '') |
|
179 | - { |
|
180 | - $alias = $this->getFqn($alias); |
|
181 | - if ($this->isAliasForClass($alias, $for_class)) { |
|
182 | - return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class); |
|
183 | - } |
|
184 | - if ($this->isDirectAlias($alias)) { |
|
185 | - return $this->getFqnForAlias($this->aliases[ (string) $alias ], ''); |
|
186 | - } |
|
187 | - return $alias; |
|
188 | - } |
|
20 | + /** |
|
21 | + * array of interfaces indexed by FQCNs where values are arrays of interface FQNs |
|
22 | + * |
|
23 | + * @var string[][] $interfaces |
|
24 | + */ |
|
25 | + private $interfaces = array(); |
|
26 | + |
|
27 | + /** |
|
28 | + * @type string[][] $aliases |
|
29 | + */ |
|
30 | + protected $aliases = array(); |
|
31 | + |
|
32 | + |
|
33 | + /** |
|
34 | + * @return string[][] |
|
35 | + */ |
|
36 | + public function getAliases() |
|
37 | + { |
|
38 | + return $this->aliases; |
|
39 | + } |
|
40 | + |
|
41 | + /** |
|
42 | + * @param string $fqn |
|
43 | + * @return string |
|
44 | + */ |
|
45 | + public function getFqn($fqn) |
|
46 | + { |
|
47 | + $fqn = $fqn instanceof FullyQualifiedName ? $fqn->string() : $fqn; |
|
48 | + return ltrim($fqn, '\\'); |
|
49 | + } |
|
50 | + |
|
51 | + |
|
52 | + /** |
|
53 | + * @param string $fqn |
|
54 | + * @return array |
|
55 | + */ |
|
56 | + public function getInterfaces($fqn) |
|
57 | + { |
|
58 | + $fqn = $this->getFqn($fqn); |
|
59 | + // have we already seen this FQCN ? |
|
60 | + if (! array_key_exists($fqn, $this->interfaces)) { |
|
61 | + $this->interfaces[ $fqn ] = array(); |
|
62 | + if (class_exists($fqn)) { |
|
63 | + $this->interfaces[ $fqn ] = class_implements($fqn, false); |
|
64 | + $this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false |
|
65 | + ? $this->interfaces[ $fqn ] |
|
66 | + : array(); |
|
67 | + } |
|
68 | + } |
|
69 | + return $this->interfaces[ $fqn ]; |
|
70 | + } |
|
71 | + |
|
72 | + |
|
73 | + /** |
|
74 | + * @param string $fqn |
|
75 | + * @param string $interface |
|
76 | + * @return bool |
|
77 | + */ |
|
78 | + public function hasInterface($fqn, $interface) |
|
79 | + { |
|
80 | + $fqn = $this->getFqn($fqn); |
|
81 | + $interfaces = $this->getInterfaces($fqn); |
|
82 | + return in_array($interface, $interfaces, true); |
|
83 | + } |
|
84 | + |
|
85 | + |
|
86 | + /** |
|
87 | + * adds an alias for a classname |
|
88 | + * |
|
89 | + * @param string $fqn the class name that should be used (concrete class to replace interface) |
|
90 | + * @param string $alias the class name that would be type hinted for (abstract parent or interface) |
|
91 | + * @param string $for_class the class that has the dependency (is type hinting for the interface) |
|
92 | + * @throws InvalidAliasException |
|
93 | + */ |
|
94 | + public function addAlias($fqn, $alias, $for_class = '') |
|
95 | + { |
|
96 | + $fqn = $this->getFqn($fqn); |
|
97 | + $alias = $this->getFqn($alias); |
|
98 | + if (strpos($alias, '\\') !== false && ! is_subclass_of($fqn, $alias)) { |
|
99 | + throw new InvalidAliasException($fqn, $alias); |
|
100 | + } |
|
101 | + // are we adding an alias for a specific class? |
|
102 | + if ($for_class !== '') { |
|
103 | + // make sure it's set up as an array |
|
104 | + if (! isset($this->aliases[ $for_class ])) { |
|
105 | + $this->aliases[ $for_class ] = array(); |
|
106 | + } |
|
107 | + $this->aliases[ $for_class ][ $alias ] = $fqn; |
|
108 | + return; |
|
109 | + } |
|
110 | + $this->aliases[ $alias ] = $fqn; |
|
111 | + } |
|
112 | + |
|
113 | + |
|
114 | + /** |
|
115 | + * returns TRUE if the provided FQN is an alias |
|
116 | + * |
|
117 | + * @param string $fqn |
|
118 | + * @param string $for_class |
|
119 | + * @return bool |
|
120 | + */ |
|
121 | + public function isAlias($fqn = '', $for_class = '') |
|
122 | + { |
|
123 | + $fqn = $this->getFqn($fqn); |
|
124 | + if ($this->isAliasForClass($fqn, $for_class)) { |
|
125 | + return true; |
|
126 | + } |
|
127 | + if ($this->isDirectAlias($fqn)) { |
|
128 | + return true; |
|
129 | + } |
|
130 | + return false; |
|
131 | + } |
|
132 | + |
|
133 | + |
|
134 | + /** |
|
135 | + * returns TRUE if the provided FQN is an alias |
|
136 | + * |
|
137 | + * @param string $fqn |
|
138 | + * @return bool |
|
139 | + */ |
|
140 | + protected function isDirectAlias($fqn = '') |
|
141 | + { |
|
142 | + return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]); |
|
143 | + } |
|
144 | + |
|
145 | + |
|
146 | + /** |
|
147 | + * returns TRUE if the provided FQN is an alias for the specified class |
|
148 | + * |
|
149 | + * @param string $fqn |
|
150 | + * @param string $for_class |
|
151 | + * @return bool |
|
152 | + */ |
|
153 | + protected function isAliasForClass($fqn = '', $for_class = '') |
|
154 | + { |
|
155 | + return ( |
|
156 | + $for_class !== '' |
|
157 | + && isset($this->aliases[ (string) $for_class ][ (string) $fqn ]) |
|
158 | + ); |
|
159 | + } |
|
160 | + |
|
161 | + |
|
162 | + /** |
|
163 | + * returns FQN for provided alias if one exists, otherwise returns the original FQN |
|
164 | + * functions recursively, so that multiple aliases can be used to drill down to a FQN |
|
165 | + * for example: |
|
166 | + * if the following two entries were added to the aliases array: |
|
167 | + * array( |
|
168 | + * 'interface_alias' => 'some\namespace\interface' |
|
169 | + * 'some\namespace\interface' => 'some\namespace\classname' |
|
170 | + * ) |
|
171 | + * then one could use Loader::getNew( 'interface_alias' ) |
|
172 | + * to load an instance of 'some\namespace\classname' |
|
173 | + * |
|
174 | + * @param string $alias |
|
175 | + * @param string $for_class |
|
176 | + * @return string |
|
177 | + */ |
|
178 | + public function getFqnForAlias($alias = '', $for_class = '') |
|
179 | + { |
|
180 | + $alias = $this->getFqn($alias); |
|
181 | + if ($this->isAliasForClass($alias, $for_class)) { |
|
182 | + return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class); |
|
183 | + } |
|
184 | + if ($this->isDirectAlias($alias)) { |
|
185 | + return $this->getFqnForAlias($this->aliases[ (string) $alias ], ''); |
|
186 | + } |
|
187 | + return $alias; |
|
188 | + } |
|
189 | 189 | } |
@@ -61,7 +61,7 @@ |
||
61 | 61 | { |
62 | 62 | $custom_post_types = $this->custom_post_types->getDefinitions(); |
63 | 63 | foreach ($custom_post_types as $custom_post_type => $CPT) { |
64 | - $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType( |
|
64 | + $this->wp_post_types[$custom_post_type] = $this->registerCustomPostType( |
|
65 | 65 | $custom_post_type, |
66 | 66 | $CPT['singular_name'], |
67 | 67 | $CPT['plural_name'], |
@@ -18,314 +18,314 @@ |
||
18 | 18 | class RegisterCustomPostTypes |
19 | 19 | { |
20 | 20 | |
21 | - /** |
|
22 | - * @var CustomPostTypeDefinitions $custom_post_types |
|
23 | - */ |
|
24 | - public $custom_post_types; |
|
21 | + /** |
|
22 | + * @var CustomPostTypeDefinitions $custom_post_types |
|
23 | + */ |
|
24 | + public $custom_post_types; |
|
25 | 25 | |
26 | - /** |
|
27 | - * @var WP_Post_Type[] $wp_post_types |
|
28 | - */ |
|
29 | - public $wp_post_types = array(); |
|
26 | + /** |
|
27 | + * @var WP_Post_Type[] $wp_post_types |
|
28 | + */ |
|
29 | + public $wp_post_types = array(); |
|
30 | 30 | |
31 | 31 | |
32 | - /** |
|
33 | - * RegisterCustomPostTypes constructor. |
|
34 | - * |
|
35 | - * @param CustomPostTypeDefinitions $custom_post_types |
|
36 | - */ |
|
37 | - public function __construct(CustomPostTypeDefinitions $custom_post_types) |
|
38 | - { |
|
39 | - $this->custom_post_types = $custom_post_types; |
|
40 | - } |
|
32 | + /** |
|
33 | + * RegisterCustomPostTypes constructor. |
|
34 | + * |
|
35 | + * @param CustomPostTypeDefinitions $custom_post_types |
|
36 | + */ |
|
37 | + public function __construct(CustomPostTypeDefinitions $custom_post_types) |
|
38 | + { |
|
39 | + $this->custom_post_types = $custom_post_types; |
|
40 | + } |
|
41 | 41 | |
42 | 42 | |
43 | - /** |
|
44 | - * @return WP_Post_Type[] |
|
45 | - */ |
|
46 | - public function getRegisteredCustomPostTypes() |
|
47 | - { |
|
48 | - return $this->wp_post_types; |
|
49 | - } |
|
43 | + /** |
|
44 | + * @return WP_Post_Type[] |
|
45 | + */ |
|
46 | + public function getRegisteredCustomPostTypes() |
|
47 | + { |
|
48 | + return $this->wp_post_types; |
|
49 | + } |
|
50 | 50 | |
51 | 51 | |
52 | - /** |
|
53 | - * @return void |
|
54 | - * @throws DomainException |
|
55 | - */ |
|
56 | - public function registerCustomPostTypes() |
|
57 | - { |
|
58 | - $custom_post_types = $this->custom_post_types->getDefinitions(); |
|
59 | - foreach ($custom_post_types as $custom_post_type => $CPT) { |
|
60 | - $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType( |
|
61 | - $custom_post_type, |
|
62 | - $CPT['singular_name'], |
|
63 | - $CPT['plural_name'], |
|
64 | - $CPT['singular_slug'], |
|
65 | - $CPT['plural_slug'], |
|
66 | - $CPT['args'] |
|
67 | - ); |
|
68 | - } |
|
69 | - } |
|
52 | + /** |
|
53 | + * @return void |
|
54 | + * @throws DomainException |
|
55 | + */ |
|
56 | + public function registerCustomPostTypes() |
|
57 | + { |
|
58 | + $custom_post_types = $this->custom_post_types->getDefinitions(); |
|
59 | + foreach ($custom_post_types as $custom_post_type => $CPT) { |
|
60 | + $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType( |
|
61 | + $custom_post_type, |
|
62 | + $CPT['singular_name'], |
|
63 | + $CPT['plural_name'], |
|
64 | + $CPT['singular_slug'], |
|
65 | + $CPT['plural_slug'], |
|
66 | + $CPT['args'] |
|
67 | + ); |
|
68 | + } |
|
69 | + } |
|
70 | 70 | |
71 | 71 | |
72 | - /** |
|
73 | - * Registers a new custom post type. Sets default settings given only the following params. |
|
74 | - * Returns the registered post type object, or an error object. |
|
75 | - * |
|
76 | - * @param string $post_type the actual post type name |
|
77 | - * IMPORTANT: |
|
78 | - * this must match what the slug is for admin pages related to this CPT |
|
79 | - * Also any models must use this slug as well |
|
80 | - * @param string $singular_name a pre-internationalized string for the singular name of the objects |
|
81 | - * @param string $plural_name a pre-internationalized string for the plural name of the objects |
|
82 | - * @param string $singular_slug |
|
83 | - * @param string $plural_slug |
|
84 | - * @param array $override_arguments exactly like $args as described in |
|
85 | - * http://codex.wordpress.org/Function_Reference/register_post_type |
|
86 | - * @return WP_Post_Type|WP_Error |
|
87 | - * @throws DomainException |
|
88 | - */ |
|
89 | - public function registerCustomPostType( |
|
90 | - $post_type, |
|
91 | - $singular_name, |
|
92 | - $plural_name, |
|
93 | - $singular_slug = '', |
|
94 | - $plural_slug = '', |
|
95 | - array $override_arguments = array() |
|
96 | - ) { |
|
97 | - $wp_post_type = register_post_type( |
|
98 | - $post_type, |
|
99 | - $this->prepareArguments( |
|
100 | - $post_type, |
|
101 | - $singular_name, |
|
102 | - $plural_name, |
|
103 | - $singular_slug, |
|
104 | - $plural_slug, |
|
105 | - $override_arguments |
|
106 | - ) |
|
107 | - ); |
|
108 | - if ($wp_post_type instanceof WP_Error) { |
|
109 | - throw new DomainException($wp_post_type->get_error_message()); |
|
110 | - } |
|
111 | - return $wp_post_type; |
|
112 | - } |
|
72 | + /** |
|
73 | + * Registers a new custom post type. Sets default settings given only the following params. |
|
74 | + * Returns the registered post type object, or an error object. |
|
75 | + * |
|
76 | + * @param string $post_type the actual post type name |
|
77 | + * IMPORTANT: |
|
78 | + * this must match what the slug is for admin pages related to this CPT |
|
79 | + * Also any models must use this slug as well |
|
80 | + * @param string $singular_name a pre-internationalized string for the singular name of the objects |
|
81 | + * @param string $plural_name a pre-internationalized string for the plural name of the objects |
|
82 | + * @param string $singular_slug |
|
83 | + * @param string $plural_slug |
|
84 | + * @param array $override_arguments exactly like $args as described in |
|
85 | + * http://codex.wordpress.org/Function_Reference/register_post_type |
|
86 | + * @return WP_Post_Type|WP_Error |
|
87 | + * @throws DomainException |
|
88 | + */ |
|
89 | + public function registerCustomPostType( |
|
90 | + $post_type, |
|
91 | + $singular_name, |
|
92 | + $plural_name, |
|
93 | + $singular_slug = '', |
|
94 | + $plural_slug = '', |
|
95 | + array $override_arguments = array() |
|
96 | + ) { |
|
97 | + $wp_post_type = register_post_type( |
|
98 | + $post_type, |
|
99 | + $this->prepareArguments( |
|
100 | + $post_type, |
|
101 | + $singular_name, |
|
102 | + $plural_name, |
|
103 | + $singular_slug, |
|
104 | + $plural_slug, |
|
105 | + $override_arguments |
|
106 | + ) |
|
107 | + ); |
|
108 | + if ($wp_post_type instanceof WP_Error) { |
|
109 | + throw new DomainException($wp_post_type->get_error_message()); |
|
110 | + } |
|
111 | + return $wp_post_type; |
|
112 | + } |
|
113 | 113 | |
114 | 114 | |
115 | - /** |
|
116 | - * @param string $post_type the actual post type name |
|
117 | - * @param string $singular_name a pre-internationalized string for the singular name of the objects |
|
118 | - * @param string $plural_name a pre-internationalized string for the plural name of the objects |
|
119 | - * @param string $singular_slug |
|
120 | - * @param string $plural_slug |
|
121 | - * @param array $override_arguments The default values set in this function will be overridden |
|
122 | - * by whatever you set in $override_arguments |
|
123 | - * @return array |
|
124 | - */ |
|
125 | - protected function prepareArguments( |
|
126 | - $post_type, |
|
127 | - $singular_name, |
|
128 | - $plural_name, |
|
129 | - $singular_slug, |
|
130 | - $plural_slug, |
|
131 | - array $override_arguments = array() |
|
132 | - ) { |
|
133 | - // verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name |
|
134 | - $singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name; |
|
135 | - $plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name; |
|
136 | - $labels = $this->getLabels( |
|
137 | - $singular_name, |
|
138 | - $plural_name, |
|
139 | - $singular_slug, |
|
140 | - $plural_slug |
|
141 | - ); |
|
142 | - // note the page_templates arg in the supports index is something specific to EE. |
|
143 | - // WordPress doesn't actually have that in their register_post_type api. |
|
144 | - $arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug); |
|
145 | - if ($override_arguments) { |
|
146 | - if (isset($override_arguments['labels'])) { |
|
147 | - $labels = array_merge($arguments['labels'], $override_arguments['labels']); |
|
148 | - } |
|
149 | - $arguments = array_merge($arguments, $override_arguments); |
|
150 | - $arguments['labels'] = $labels; |
|
151 | - } |
|
152 | - return $arguments; |
|
153 | - } |
|
115 | + /** |
|
116 | + * @param string $post_type the actual post type name |
|
117 | + * @param string $singular_name a pre-internationalized string for the singular name of the objects |
|
118 | + * @param string $plural_name a pre-internationalized string for the plural name of the objects |
|
119 | + * @param string $singular_slug |
|
120 | + * @param string $plural_slug |
|
121 | + * @param array $override_arguments The default values set in this function will be overridden |
|
122 | + * by whatever you set in $override_arguments |
|
123 | + * @return array |
|
124 | + */ |
|
125 | + protected function prepareArguments( |
|
126 | + $post_type, |
|
127 | + $singular_name, |
|
128 | + $plural_name, |
|
129 | + $singular_slug, |
|
130 | + $plural_slug, |
|
131 | + array $override_arguments = array() |
|
132 | + ) { |
|
133 | + // verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name |
|
134 | + $singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name; |
|
135 | + $plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name; |
|
136 | + $labels = $this->getLabels( |
|
137 | + $singular_name, |
|
138 | + $plural_name, |
|
139 | + $singular_slug, |
|
140 | + $plural_slug |
|
141 | + ); |
|
142 | + // note the page_templates arg in the supports index is something specific to EE. |
|
143 | + // WordPress doesn't actually have that in their register_post_type api. |
|
144 | + $arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug); |
|
145 | + if ($override_arguments) { |
|
146 | + if (isset($override_arguments['labels'])) { |
|
147 | + $labels = array_merge($arguments['labels'], $override_arguments['labels']); |
|
148 | + } |
|
149 | + $arguments = array_merge($arguments, $override_arguments); |
|
150 | + $arguments['labels'] = $labels; |
|
151 | + } |
|
152 | + return $arguments; |
|
153 | + } |
|
154 | 154 | |
155 | 155 | |
156 | - /** |
|
157 | - * @param string $singular_name |
|
158 | - * @param string $plural_name |
|
159 | - * @param string $singular_slug |
|
160 | - * @param string $plural_slug |
|
161 | - * @return array |
|
162 | - */ |
|
163 | - private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug) |
|
164 | - { |
|
165 | - return array( |
|
166 | - 'name' => $plural_name, |
|
167 | - 'singular_name' => $singular_name, |
|
168 | - 'singular_slug' => $singular_slug, |
|
169 | - 'plural_slug' => $plural_slug, |
|
170 | - 'add_new' => sprintf( |
|
171 | - /* Translators: Post Type Label */ |
|
172 | - esc_html_x('Add %s', 'Add Event', 'event_espresso'), |
|
173 | - $singular_name |
|
174 | - ), |
|
175 | - 'add_new_item' => sprintf( |
|
176 | - /* Translators: Post Type Label */ |
|
177 | - esc_html_x('Add New %s', 'Add New Event', 'event_espresso'), |
|
178 | - $singular_name |
|
179 | - ), |
|
180 | - 'edit_item' => sprintf( |
|
181 | - /* Translators: Post Type Label */ |
|
182 | - esc_html_x('Edit %s', 'Edit Event', 'event_espresso'), |
|
183 | - $singular_name |
|
184 | - ), |
|
185 | - 'new_item' => sprintf( |
|
186 | - /* Translators: Post Type Label */ |
|
187 | - esc_html_x('New %s', 'New Event', 'event_espresso'), |
|
188 | - $singular_name |
|
189 | - ), |
|
190 | - 'all_items' => sprintf( |
|
191 | - /* Translators: Post Type Label */ |
|
192 | - esc_html_x('All %s', 'All Events', 'event_espresso'), |
|
193 | - $plural_name |
|
194 | - ), |
|
195 | - 'view_item' => sprintf( |
|
196 | - /* Translators: Post Type Label */ |
|
197 | - esc_html_x('View %s', 'View Event', 'event_espresso'), |
|
198 | - $singular_name |
|
199 | - ), |
|
200 | - 'view_items' => sprintf( |
|
201 | - /* Translators: Post Type Label */ |
|
202 | - esc_html_x('View %s', 'View Events', 'event_espresso'), |
|
203 | - $plural_name |
|
204 | - ), |
|
205 | - 'archives' => sprintf( |
|
206 | - /* Translators: Post Type Label */ |
|
207 | - esc_html_x('%s Archives', 'Event Archives', 'event_espresso'), |
|
208 | - $singular_name |
|
209 | - ), |
|
210 | - 'attributes' => sprintf( |
|
211 | - /* Translators: Post Type Label */ |
|
212 | - esc_html_x('%s Attributes', 'Event Attributes', 'event_espresso'), |
|
213 | - $singular_name |
|
214 | - ), |
|
215 | - 'insert_into_item' => sprintf( |
|
216 | - /* Translators: Post Type Label */ |
|
217 | - esc_html_x('Insert into this %s', 'Insert into this Event', 'event_espresso'), |
|
218 | - $singular_name |
|
219 | - ), |
|
220 | - 'uploaded_to_this_item' => sprintf( |
|
221 | - /* Translators: Post Type Label */ |
|
222 | - esc_html_x('Uploaded to this %s', 'Uploaded to this Event', 'event_espresso'), |
|
223 | - $singular_name |
|
224 | - ), |
|
225 | - 'filter_items_list' => sprintf( |
|
226 | - /* Translators: Post Type Label */ |
|
227 | - esc_html_x('Filter %s list', 'Filter Events list', 'event_espresso'), |
|
228 | - $plural_name |
|
229 | - ), |
|
230 | - 'items_list_navigation' => sprintf( |
|
231 | - /* Translators: Post Type Label */ |
|
232 | - esc_html_x('%s list navigation', 'Events list navigation', 'event_espresso'), |
|
233 | - $plural_name |
|
234 | - ), |
|
235 | - 'items_list' => sprintf( |
|
236 | - /* Translators: Post Type Label */ |
|
237 | - esc_html_x('%s list', 'Events list', 'event_espresso'), |
|
238 | - $plural_name |
|
239 | - ), |
|
240 | - 'item_published' => sprintf( |
|
241 | - /* Translators: Post Type Label */ |
|
242 | - esc_html_x('%s published', 'Event published', 'event_espresso'), |
|
243 | - $singular_name |
|
244 | - ), |
|
245 | - 'item_published_privately' => sprintf( |
|
246 | - /* Translators: Post Type Label */ |
|
247 | - esc_html_x('%s published privately', 'Event published privately', 'event_espresso'), |
|
248 | - $singular_name |
|
249 | - ), |
|
250 | - 'item_reverted_to_draft' => sprintf( |
|
251 | - /* Translators: Post Type Label */ |
|
252 | - esc_html_x('%s reverted to draft', 'Event reverted to draft', 'event_espresso'), |
|
253 | - $singular_name |
|
254 | - ), |
|
255 | - 'item_scheduled' => sprintf( |
|
256 | - /* Translators: Post Type Label */ |
|
257 | - esc_html_x('%s scheduled', 'Event scheduled', 'event_espresso'), |
|
258 | - $singular_name |
|
259 | - ), |
|
260 | - 'item_updated' => sprintf( |
|
261 | - /* Translators: Post Type Label */ |
|
262 | - esc_html_x('%s updated', 'Event updated', 'event_espresso'), |
|
263 | - $singular_name |
|
264 | - ), |
|
265 | - 'search_items' => sprintf( |
|
266 | - /* Translators: Post Type Label */ |
|
267 | - esc_html_x('Search %s', 'Search Events', 'event_espresso'), |
|
268 | - $plural_name |
|
269 | - ), |
|
270 | - 'not_found' => sprintf( |
|
271 | - /* Translators: Post Type Label */ |
|
272 | - esc_html_x('No %s found', 'No Events found', 'event_espresso'), |
|
273 | - $plural_name |
|
274 | - ), |
|
275 | - 'not_found_in_trash' => sprintf( |
|
276 | - /* Translators: Post Type Label */ |
|
277 | - esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'), |
|
278 | - $plural_name |
|
279 | - ), |
|
280 | - 'parent_item_colon' => '', |
|
281 | - 'menu_name' => $plural_name, |
|
282 | - ); |
|
283 | - } |
|
156 | + /** |
|
157 | + * @param string $singular_name |
|
158 | + * @param string $plural_name |
|
159 | + * @param string $singular_slug |
|
160 | + * @param string $plural_slug |
|
161 | + * @return array |
|
162 | + */ |
|
163 | + private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug) |
|
164 | + { |
|
165 | + return array( |
|
166 | + 'name' => $plural_name, |
|
167 | + 'singular_name' => $singular_name, |
|
168 | + 'singular_slug' => $singular_slug, |
|
169 | + 'plural_slug' => $plural_slug, |
|
170 | + 'add_new' => sprintf( |
|
171 | + /* Translators: Post Type Label */ |
|
172 | + esc_html_x('Add %s', 'Add Event', 'event_espresso'), |
|
173 | + $singular_name |
|
174 | + ), |
|
175 | + 'add_new_item' => sprintf( |
|
176 | + /* Translators: Post Type Label */ |
|
177 | + esc_html_x('Add New %s', 'Add New Event', 'event_espresso'), |
|
178 | + $singular_name |
|
179 | + ), |
|
180 | + 'edit_item' => sprintf( |
|
181 | + /* Translators: Post Type Label */ |
|
182 | + esc_html_x('Edit %s', 'Edit Event', 'event_espresso'), |
|
183 | + $singular_name |
|
184 | + ), |
|
185 | + 'new_item' => sprintf( |
|
186 | + /* Translators: Post Type Label */ |
|
187 | + esc_html_x('New %s', 'New Event', 'event_espresso'), |
|
188 | + $singular_name |
|
189 | + ), |
|
190 | + 'all_items' => sprintf( |
|
191 | + /* Translators: Post Type Label */ |
|
192 | + esc_html_x('All %s', 'All Events', 'event_espresso'), |
|
193 | + $plural_name |
|
194 | + ), |
|
195 | + 'view_item' => sprintf( |
|
196 | + /* Translators: Post Type Label */ |
|
197 | + esc_html_x('View %s', 'View Event', 'event_espresso'), |
|
198 | + $singular_name |
|
199 | + ), |
|
200 | + 'view_items' => sprintf( |
|
201 | + /* Translators: Post Type Label */ |
|
202 | + esc_html_x('View %s', 'View Events', 'event_espresso'), |
|
203 | + $plural_name |
|
204 | + ), |
|
205 | + 'archives' => sprintf( |
|
206 | + /* Translators: Post Type Label */ |
|
207 | + esc_html_x('%s Archives', 'Event Archives', 'event_espresso'), |
|
208 | + $singular_name |
|
209 | + ), |
|
210 | + 'attributes' => sprintf( |
|
211 | + /* Translators: Post Type Label */ |
|
212 | + esc_html_x('%s Attributes', 'Event Attributes', 'event_espresso'), |
|
213 | + $singular_name |
|
214 | + ), |
|
215 | + 'insert_into_item' => sprintf( |
|
216 | + /* Translators: Post Type Label */ |
|
217 | + esc_html_x('Insert into this %s', 'Insert into this Event', 'event_espresso'), |
|
218 | + $singular_name |
|
219 | + ), |
|
220 | + 'uploaded_to_this_item' => sprintf( |
|
221 | + /* Translators: Post Type Label */ |
|
222 | + esc_html_x('Uploaded to this %s', 'Uploaded to this Event', 'event_espresso'), |
|
223 | + $singular_name |
|
224 | + ), |
|
225 | + 'filter_items_list' => sprintf( |
|
226 | + /* Translators: Post Type Label */ |
|
227 | + esc_html_x('Filter %s list', 'Filter Events list', 'event_espresso'), |
|
228 | + $plural_name |
|
229 | + ), |
|
230 | + 'items_list_navigation' => sprintf( |
|
231 | + /* Translators: Post Type Label */ |
|
232 | + esc_html_x('%s list navigation', 'Events list navigation', 'event_espresso'), |
|
233 | + $plural_name |
|
234 | + ), |
|
235 | + 'items_list' => sprintf( |
|
236 | + /* Translators: Post Type Label */ |
|
237 | + esc_html_x('%s list', 'Events list', 'event_espresso'), |
|
238 | + $plural_name |
|
239 | + ), |
|
240 | + 'item_published' => sprintf( |
|
241 | + /* Translators: Post Type Label */ |
|
242 | + esc_html_x('%s published', 'Event published', 'event_espresso'), |
|
243 | + $singular_name |
|
244 | + ), |
|
245 | + 'item_published_privately' => sprintf( |
|
246 | + /* Translators: Post Type Label */ |
|
247 | + esc_html_x('%s published privately', 'Event published privately', 'event_espresso'), |
|
248 | + $singular_name |
|
249 | + ), |
|
250 | + 'item_reverted_to_draft' => sprintf( |
|
251 | + /* Translators: Post Type Label */ |
|
252 | + esc_html_x('%s reverted to draft', 'Event reverted to draft', 'event_espresso'), |
|
253 | + $singular_name |
|
254 | + ), |
|
255 | + 'item_scheduled' => sprintf( |
|
256 | + /* Translators: Post Type Label */ |
|
257 | + esc_html_x('%s scheduled', 'Event scheduled', 'event_espresso'), |
|
258 | + $singular_name |
|
259 | + ), |
|
260 | + 'item_updated' => sprintf( |
|
261 | + /* Translators: Post Type Label */ |
|
262 | + esc_html_x('%s updated', 'Event updated', 'event_espresso'), |
|
263 | + $singular_name |
|
264 | + ), |
|
265 | + 'search_items' => sprintf( |
|
266 | + /* Translators: Post Type Label */ |
|
267 | + esc_html_x('Search %s', 'Search Events', 'event_espresso'), |
|
268 | + $plural_name |
|
269 | + ), |
|
270 | + 'not_found' => sprintf( |
|
271 | + /* Translators: Post Type Label */ |
|
272 | + esc_html_x('No %s found', 'No Events found', 'event_espresso'), |
|
273 | + $plural_name |
|
274 | + ), |
|
275 | + 'not_found_in_trash' => sprintf( |
|
276 | + /* Translators: Post Type Label */ |
|
277 | + esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'), |
|
278 | + $plural_name |
|
279 | + ), |
|
280 | + 'parent_item_colon' => '', |
|
281 | + 'menu_name' => $plural_name, |
|
282 | + ); |
|
283 | + } |
|
284 | 284 | |
285 | 285 | |
286 | - /** |
|
287 | - * @param array $labels |
|
288 | - * @param string $post_type |
|
289 | - * @param string $plural_slug |
|
290 | - * @return array |
|
291 | - */ |
|
292 | - private function getDefaultArguments(array $labels, $post_type, $plural_slug) |
|
293 | - { |
|
294 | - return array( |
|
295 | - 'labels' => $labels, |
|
296 | - 'public' => true, |
|
297 | - 'publicly_queryable' => true, |
|
298 | - 'show_ui' => false, |
|
299 | - 'show_ee_ui' => true, |
|
300 | - 'show_in_menu' => false, |
|
301 | - 'show_in_nav_menus' => false, |
|
302 | - 'query_var' => true, |
|
303 | - 'rewrite' => apply_filters( |
|
304 | - 'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite', |
|
305 | - // legacy filter applied for now, |
|
306 | - // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice |
|
307 | - apply_filters( |
|
308 | - 'FHEE__EE_Register_CPTs__register_CPT__rewrite', |
|
309 | - array('slug' => $plural_slug), |
|
310 | - $post_type |
|
311 | - ), |
|
312 | - $post_type, |
|
313 | - $plural_slug |
|
314 | - ), |
|
315 | - 'capability_type' => 'post', |
|
316 | - 'map_meta_cap' => true, |
|
317 | - 'has_archive' => true, |
|
318 | - 'hierarchical' => false, |
|
319 | - 'menu_position' => null, |
|
320 | - 'supports' => array( |
|
321 | - 'title', |
|
322 | - 'editor', |
|
323 | - 'author', |
|
324 | - 'thumbnail', |
|
325 | - 'excerpt', |
|
326 | - 'custom-fields', |
|
327 | - 'comments', |
|
328 | - ), |
|
329 | - ); |
|
330 | - } |
|
286 | + /** |
|
287 | + * @param array $labels |
|
288 | + * @param string $post_type |
|
289 | + * @param string $plural_slug |
|
290 | + * @return array |
|
291 | + */ |
|
292 | + private function getDefaultArguments(array $labels, $post_type, $plural_slug) |
|
293 | + { |
|
294 | + return array( |
|
295 | + 'labels' => $labels, |
|
296 | + 'public' => true, |
|
297 | + 'publicly_queryable' => true, |
|
298 | + 'show_ui' => false, |
|
299 | + 'show_ee_ui' => true, |
|
300 | + 'show_in_menu' => false, |
|
301 | + 'show_in_nav_menus' => false, |
|
302 | + 'query_var' => true, |
|
303 | + 'rewrite' => apply_filters( |
|
304 | + 'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite', |
|
305 | + // legacy filter applied for now, |
|
306 | + // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice |
|
307 | + apply_filters( |
|
308 | + 'FHEE__EE_Register_CPTs__register_CPT__rewrite', |
|
309 | + array('slug' => $plural_slug), |
|
310 | + $post_type |
|
311 | + ), |
|
312 | + $post_type, |
|
313 | + $plural_slug |
|
314 | + ), |
|
315 | + 'capability_type' => 'post', |
|
316 | + 'map_meta_cap' => true, |
|
317 | + 'has_archive' => true, |
|
318 | + 'hierarchical' => false, |
|
319 | + 'menu_position' => null, |
|
320 | + 'supports' => array( |
|
321 | + 'title', |
|
322 | + 'editor', |
|
323 | + 'author', |
|
324 | + 'thumbnail', |
|
325 | + 'excerpt', |
|
326 | + 'custom-fields', |
|
327 | + 'comments', |
|
328 | + ), |
|
329 | + ); |
|
330 | + } |
|
331 | 331 | } |
@@ -16,26 +16,26 @@ |
||
16 | 16 | class InvalidCollectionIdentifierException extends OutOfBoundsException |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * InvalidCollectionIdentifierException constructor. |
|
21 | - * |
|
22 | - * @param $identifier |
|
23 | - * @param string $message |
|
24 | - * @param int $code |
|
25 | - * @param Exception|null $previous |
|
26 | - */ |
|
27 | - public function __construct($identifier, $message = '', $code = 0, Exception $previous = null) |
|
28 | - { |
|
29 | - if (empty($message)) { |
|
30 | - $message = sprintf( |
|
31 | - __( |
|
32 | - 'The supplied identifier "%1$s" does not exist within this collection. |
|
19 | + /** |
|
20 | + * InvalidCollectionIdentifierException constructor. |
|
21 | + * |
|
22 | + * @param $identifier |
|
23 | + * @param string $message |
|
24 | + * @param int $code |
|
25 | + * @param Exception|null $previous |
|
26 | + */ |
|
27 | + public function __construct($identifier, $message = '', $code = 0, Exception $previous = null) |
|
28 | + { |
|
29 | + if (empty($message)) { |
|
30 | + $message = sprintf( |
|
31 | + __( |
|
32 | + 'The supplied identifier "%1$s" does not exist within this collection. |
|
33 | 33 | You may need to delay adding this asset until the required dependency has been added.', |
34 | - 'event_espresso' |
|
35 | - ), |
|
36 | - $identifier |
|
37 | - ); |
|
38 | - } |
|
39 | - parent::__construct($message, $code, $previous); |
|
40 | - } |
|
34 | + 'event_espresso' |
|
35 | + ), |
|
36 | + $identifier |
|
37 | + ); |
|
38 | + } |
|
39 | + parent::__construct($message, $code, $previous); |
|
40 | + } |
|
41 | 41 | } |
@@ -16,25 +16,25 @@ |
||
16 | 16 | class DuplicateCollectionIdentifierException extends OutOfRangeException |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * DuplicateCollectionIdentifierException constructor. |
|
21 | - * |
|
22 | - * @param $identifier |
|
23 | - * @param string $message |
|
24 | - * @param int $code |
|
25 | - * @param Exception|null $previous |
|
26 | - */ |
|
27 | - public function __construct($identifier, $message = '', $code = 0, Exception $previous = null) |
|
28 | - { |
|
29 | - if (empty($message)) { |
|
30 | - $message = sprintf( |
|
31 | - __( |
|
32 | - 'The supplied identifier "%1$s" already exists within this collection.', |
|
33 | - 'event_espresso' |
|
34 | - ), |
|
35 | - $identifier |
|
36 | - ); |
|
37 | - } |
|
38 | - parent::__construct($message, $code, $previous); |
|
39 | - } |
|
19 | + /** |
|
20 | + * DuplicateCollectionIdentifierException constructor. |
|
21 | + * |
|
22 | + * @param $identifier |
|
23 | + * @param string $message |
|
24 | + * @param int $code |
|
25 | + * @param Exception|null $previous |
|
26 | + */ |
|
27 | + public function __construct($identifier, $message = '', $code = 0, Exception $previous = null) |
|
28 | + { |
|
29 | + if (empty($message)) { |
|
30 | + $message = sprintf( |
|
31 | + __( |
|
32 | + 'The supplied identifier "%1$s" already exists within this collection.', |
|
33 | + 'event_espresso' |
|
34 | + ), |
|
35 | + $identifier |
|
36 | + ); |
|
37 | + } |
|
38 | + parent::__construct($message, $code, $previous); |
|
39 | + } |
|
40 | 40 | } |