@@ -32,20 +32,20 @@ |
||
32 | 32 | |
33 | 33 | |
34 | 34 | |
35 | - /** |
|
35 | + /** |
|
36 | 36 | * set_hooks - for hooking into EE Core, other modules, etc |
37 | 37 | * |
38 | 38 | * @access public |
39 | 39 | * @return void |
40 | 40 | */ |
41 | 41 | public static function set_hooks() { |
42 | - $custom_post_types = EE_Register_CPTs::get_CPTs(); |
|
43 | - EE_Config::register_route( |
|
44 | - $custom_post_types['espresso_venues']['singular_slug'], |
|
45 | - 'Venue_Single', |
|
46 | - 'run' |
|
47 | - ); |
|
48 | - } |
|
42 | + $custom_post_types = EE_Register_CPTs::get_CPTs(); |
|
43 | + EE_Config::register_route( |
|
44 | + $custom_post_types['espresso_venues']['singular_slug'], |
|
45 | + 'Venue_Single', |
|
46 | + 'run' |
|
47 | + ); |
|
48 | + } |
|
49 | 49 | |
50 | 50 | /** |
51 | 51 | * set_hooks_admin - for hooking into EE Admin Core, other modules, etc |
@@ -27,7 +27,7 @@ discard block |
||
27 | 27 | * @return EED_Venue_Single |
28 | 28 | */ |
29 | 29 | public static function instance() { |
30 | - return parent::get_instance( __CLASS__ ); |
|
30 | + return parent::get_instance(__CLASS__); |
|
31 | 31 | } |
32 | 32 | |
33 | 33 | |
@@ -64,10 +64,10 @@ discard block |
||
64 | 64 | * @access public |
65 | 65 | * @param \WP $WP |
66 | 66 | */ |
67 | - public function run( $WP ) { |
|
67 | + public function run($WP) { |
|
68 | 68 | // check what template is loaded |
69 | - add_filter( 'template_include', array( $this, 'template_include' ), 999, 1 ); |
|
70 | - add_action('wp_enqueue_scripts', array( $this, 'wp_enqueue_scripts' ), 10 ); |
|
69 | + add_filter('template_include', array($this, 'template_include'), 999, 1); |
|
70 | + add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10); |
|
71 | 71 | } |
72 | 72 | |
73 | 73 | |
@@ -79,15 +79,15 @@ discard block |
||
79 | 79 | * @param string $template |
80 | 80 | * @return string |
81 | 81 | */ |
82 | - public function template_include( $template ) { |
|
82 | + public function template_include($template) { |
|
83 | 83 | // not a custom template? |
84 | - if ( EE_Registry::instance()->load_core( 'Front_Controller', array(), false, true )->get_selected_template() != 'single-espresso_venues.php' ) { |
|
84 | + if (EE_Registry::instance()->load_core('Front_Controller', array(), false, true)->get_selected_template() != 'single-espresso_venues.php') { |
|
85 | 85 | EEH_Template::load_espresso_theme_functions(); |
86 | 86 | // then add extra event data via hooks |
87 | - add_filter( 'the_title', array( $this, 'the_title' ), 100, 1 ); |
|
88 | - add_filter( 'the_content', array( $this, 'venue_details' ), 100 ); |
|
87 | + add_filter('the_title', array($this, 'the_title'), 100, 1); |
|
88 | + add_filter('the_content', array($this, 'venue_details'), 100); |
|
89 | 89 | // don't display entry meta because the existing theme will take car of that |
90 | - add_filter( 'FHEE__content_espresso_venues_details_template__display_entry_meta', '__return_false' ); |
|
90 | + add_filter('FHEE__content_espresso_venues_details_template__display_entry_meta', '__return_false'); |
|
91 | 91 | } |
92 | 92 | return $template; |
93 | 93 | } |
@@ -101,7 +101,7 @@ discard block |
||
101 | 101 | * @param string $title |
102 | 102 | * @return string |
103 | 103 | */ |
104 | - public function the_title( $title = '' ) { |
|
104 | + public function the_title($title = '') { |
|
105 | 105 | return $title; |
106 | 106 | } |
107 | 107 | |
@@ -113,7 +113,7 @@ discard block |
||
113 | 113 | * @param string $content |
114 | 114 | * @return string |
115 | 115 | */ |
116 | - public function venue_details( $content ) { |
|
116 | + public function venue_details($content) { |
|
117 | 117 | global $post; |
118 | 118 | if ( |
119 | 119 | $post->post_type == 'espresso_venues' |
@@ -123,16 +123,16 @@ discard block |
||
123 | 123 | // it uses the_content() for displaying the $post->post_content |
124 | 124 | // so in order to load a template that uses the_content() from within a callback being used to filter the_content(), |
125 | 125 | // we need to first remove this callback from being applied to the_content() (otherwise it will recurse and blow up the interweb) |
126 | - remove_filter( 'the_content', array( $this, 'venue_details' ), 100 ); |
|
126 | + remove_filter('the_content', array($this, 'venue_details'), 100); |
|
127 | 127 | // add filters we want |
128 | - add_filter( 'the_content', array( $this, 'venue_location' ), 110 ); |
|
128 | + add_filter('the_content', array($this, 'venue_location'), 110); |
|
129 | 129 | // now load our template |
130 | - $template = EEH_Template::locate_template( 'content-espresso_venues-details.php' ); |
|
130 | + $template = EEH_Template::locate_template('content-espresso_venues-details.php'); |
|
131 | 131 | // remove other filters we added so they won't get applied to the next post |
132 | - remove_filter( 'the_content', array( $this, 'venue_location' ), 110 ); |
|
132 | + remove_filter('the_content', array($this, 'venue_location'), 110); |
|
133 | 133 | } |
134 | 134 | // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt) |
135 | - return ! empty( $template ) ? $template : $content; |
|
135 | + return ! empty($template) ? $template : $content; |
|
136 | 136 | } |
137 | 137 | |
138 | 138 | |
@@ -144,8 +144,8 @@ discard block |
||
144 | 144 | * @param string $content |
145 | 145 | * @return string |
146 | 146 | */ |
147 | - public function venue_location( $content ) { |
|
148 | - return $content . EEH_Template::locate_template( 'content-espresso_venues-location.php' ); |
|
147 | + public function venue_location($content) { |
|
148 | + return $content.EEH_Template::locate_template('content-espresso_venues-location.php'); |
|
149 | 149 | } |
150 | 150 | |
151 | 151 | |
@@ -158,16 +158,16 @@ discard block |
||
158 | 158 | */ |
159 | 159 | public function wp_enqueue_scripts() { |
160 | 160 | // get some style |
161 | - if ( apply_filters( 'FHEE_enable_default_espresso_css', TRUE ) && is_single() ) { |
|
161 | + if (apply_filters('FHEE_enable_default_espresso_css', TRUE) && is_single()) { |
|
162 | 162 | // first check theme folder |
163 | - if ( is_readable( get_stylesheet_directory() . $this->theme . DS . 'style.css' )) { |
|
164 | - wp_register_style( $this->theme, get_stylesheet_directory_uri() . $this->theme . DS . 'style.css', array( 'dashicons', 'espresso_default' ) ); |
|
165 | - } else if ( is_readable( EE_TEMPLATES . $this->theme . DS . 'style.css' )) { |
|
166 | - wp_register_style( $this->theme, EE_TEMPLATES_URL . $this->theme . DS . 'style.css', array( 'dashicons', 'espresso_default' ) ); |
|
163 | + if (is_readable(get_stylesheet_directory().$this->theme.DS.'style.css')) { |
|
164 | + wp_register_style($this->theme, get_stylesheet_directory_uri().$this->theme.DS.'style.css', array('dashicons', 'espresso_default')); |
|
165 | + } else if (is_readable(EE_TEMPLATES.$this->theme.DS.'style.css')) { |
|
166 | + wp_register_style($this->theme, EE_TEMPLATES_URL.$this->theme.DS.'style.css', array('dashicons', 'espresso_default')); |
|
167 | 167 | } |
168 | - wp_enqueue_style( $this->theme ); |
|
169 | - if ( EE_Registry::instance()->CFG->map_settings->use_google_maps ) { |
|
170 | - add_action('wp_enqueue_scripts', array( 'EEH_Maps', 'espresso_google_map_js' ), 11 ); |
|
168 | + wp_enqueue_style($this->theme); |
|
169 | + if (EE_Registry::instance()->CFG->map_settings->use_google_maps) { |
|
170 | + add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11); |
|
171 | 171 | } |
172 | 172 | } |
173 | 173 | } |
@@ -13,467 +13,467 @@ discard block |
||
13 | 13 | class EED_Event_Single extends EED_Module |
14 | 14 | { |
15 | 15 | |
16 | - const EVENT_DETAILS_PRIORITY = 100; |
|
17 | - const EVENT_DATETIMES_PRIORITY = 110; |
|
18 | - const EVENT_TICKETS_PRIORITY = 120; |
|
19 | - const EVENT_VENUES_PRIORITY = 130; |
|
20 | - |
|
21 | - /** |
|
22 | - * @type bool $using_get_the_excerpt |
|
23 | - */ |
|
24 | - protected static $using_get_the_excerpt = false; |
|
25 | - |
|
26 | - |
|
27 | - /** |
|
28 | - * @type EE_Template_Part_Manager $template_parts |
|
29 | - */ |
|
30 | - protected $template_parts; |
|
31 | - |
|
32 | - |
|
33 | - /** |
|
34 | - * @return EED_Module|EED_Event_Single |
|
35 | - */ |
|
36 | - public static function instance() |
|
37 | - { |
|
38 | - return parent::get_instance(__CLASS__); |
|
39 | - } |
|
40 | - |
|
41 | - |
|
42 | - /** |
|
43 | - * set_hooks - for hooking into EE Core, other modules, etc |
|
44 | - * |
|
45 | - * @return void |
|
46 | - */ |
|
47 | - public static function set_hooks() |
|
48 | - { |
|
49 | - add_filter('FHEE_run_EE_wp', '__return_true'); |
|
50 | - add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2); |
|
51 | - $custom_post_types = EE_Register_CPTs::get_CPTs(); |
|
52 | - EE_Config::register_route( |
|
53 | - $custom_post_types['espresso_events']['singular_slug'], |
|
54 | - 'Event_Single', |
|
55 | - 'run' |
|
56 | - ); |
|
57 | - } |
|
58 | - |
|
59 | - /** |
|
60 | - * set_hooks_admin - for hooking into EE Admin Core, other modules, etc |
|
61 | - * |
|
62 | - * @return void |
|
63 | - */ |
|
64 | - public static function set_hooks_admin() |
|
65 | - { |
|
66 | - add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2); |
|
67 | - } |
|
68 | - |
|
69 | - |
|
70 | - /** |
|
71 | - * set_definitions |
|
72 | - * |
|
73 | - * @static |
|
74 | - * @return void |
|
75 | - */ |
|
76 | - public static function set_definitions() |
|
77 | - { |
|
78 | - define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS); |
|
79 | - define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates' . DS); |
|
80 | - } |
|
81 | - |
|
82 | - |
|
83 | - /** |
|
84 | - * set_config |
|
85 | - * |
|
86 | - * @void |
|
87 | - */ |
|
88 | - protected function set_config() |
|
89 | - { |
|
90 | - $this->set_config_section('template_settings'); |
|
91 | - $this->set_config_class('EE_Event_Single_Config'); |
|
92 | - $this->set_config_name('EED_Event_Single'); |
|
93 | - } |
|
94 | - |
|
95 | - |
|
96 | - /** |
|
97 | - * initialize_template_parts |
|
98 | - * |
|
99 | - * @param EE_Config_Base|EE_Event_Single_Config $config |
|
100 | - * @return EE_Template_Part_Manager |
|
101 | - */ |
|
102 | - public function initialize_template_parts(EE_Event_Single_Config $config = null) |
|
103 | - { |
|
104 | - /** @type EE_Event_Single_Config $config */ |
|
105 | - $config = $config instanceof EE_Event_Single_Config ? $config : $this->config(); |
|
106 | - EEH_Autoloader::instance()->register_template_part_autoloaders(); |
|
107 | - $template_parts = new EE_Template_Part_Manager(); |
|
108 | - $template_parts->add_template_part( |
|
109 | - 'tickets', |
|
110 | - __('Ticket Selector', 'event_espresso'), |
|
111 | - 'content-espresso_events-tickets.php', |
|
112 | - $config->display_order_tickets |
|
113 | - ); |
|
114 | - $template_parts->add_template_part( |
|
115 | - 'datetimes', |
|
116 | - __('Dates and Times', 'event_espresso'), |
|
117 | - 'content-espresso_events-datetimes.php', |
|
118 | - $config->display_order_datetimes |
|
119 | - ); |
|
120 | - $template_parts->add_template_part( |
|
121 | - 'event', |
|
122 | - __('Event Description', 'event_espresso'), |
|
123 | - 'content-espresso_events-details.php', |
|
124 | - $config->display_order_event |
|
125 | - ); |
|
126 | - $template_parts->add_template_part( |
|
127 | - 'venue', |
|
128 | - __('Venue Information', 'event_espresso'), |
|
129 | - 'content-espresso_events-venues.php', |
|
130 | - $config->display_order_venue |
|
131 | - ); |
|
132 | - do_action('AHEE__EED_Event_Single__initialize_template_parts', $template_parts); |
|
133 | - return $template_parts; |
|
134 | - } |
|
135 | - |
|
136 | - |
|
137 | - /** |
|
138 | - * run - initial module setup |
|
139 | - * |
|
140 | - * @param WP $WP |
|
141 | - * @return void |
|
142 | - */ |
|
143 | - public function run($WP) |
|
144 | - { |
|
145 | - // ensure valid EE_Events_Single_Config() object exists |
|
146 | - $this->set_config(); |
|
147 | - // check what template is loaded |
|
148 | - add_filter('template_include', array($this, 'template_include'), 999, 1); |
|
149 | - add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true'); |
|
150 | - // load css |
|
151 | - add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10); |
|
152 | - } |
|
153 | - |
|
154 | - |
|
155 | - /** |
|
156 | - * template_include |
|
157 | - * |
|
158 | - * @param string $template |
|
159 | - * @return string |
|
160 | - */ |
|
161 | - public function template_include($template) |
|
162 | - { |
|
163 | - global $post; |
|
164 | - /** @type EE_Event_Single_Config $config */ |
|
165 | - $config = $this->config(); |
|
166 | - if ($config->display_status_banner_single) { |
|
167 | - add_filter('the_title', array('EED_Event_Single', 'the_title'), 100, 2); |
|
168 | - } |
|
169 | - // not a custom template? |
|
170 | - if ( |
|
171 | - !post_password_required($post) |
|
172 | - && ( |
|
173 | - apply_filters('FHEE__EED_Event_Single__template_include__allow_custom_selected_template', false) |
|
174 | - || EE_Registry::instance() |
|
175 | - ->load_core('Front_Controller') |
|
176 | - ->get_selected_template() !== 'single-espresso_events.php' |
|
177 | - ) |
|
178 | - |
|
179 | - ) { |
|
180 | - EEH_Template::load_espresso_theme_functions(); |
|
181 | - // then add extra event data via hooks |
|
182 | - add_action('loop_start', array('EED_Event_Single', 'loop_start')); |
|
183 | - add_filter('get_the_excerpt', array('EED_Event_Single', 'get_the_excerpt'), 1, 1); |
|
184 | - add_filter( |
|
185 | - 'the_content', |
|
186 | - array('EED_Event_Single', 'event_details'), |
|
187 | - EED_Event_Single::EVENT_DETAILS_PRIORITY |
|
188 | - ); |
|
189 | - add_action('loop_end', array('EED_Event_Single', 'loop_end')); |
|
190 | - // don't display entry meta because the existing theme will take car of that |
|
191 | - add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false'); |
|
192 | - } |
|
193 | - return $template; |
|
194 | - } |
|
195 | - |
|
196 | - |
|
197 | - /** |
|
198 | - * loop_start |
|
199 | - * |
|
200 | - * @param array $wp_query_array an array containing the WP_Query object |
|
201 | - * @return void |
|
202 | - */ |
|
203 | - public static function loop_start($wp_query_array) |
|
204 | - { |
|
205 | - global $post; |
|
206 | - do_action('AHEE_event_details_before_post', $post, $wp_query_array); |
|
207 | - } |
|
208 | - |
|
209 | - |
|
210 | - /** |
|
211 | - * the_title |
|
212 | - * |
|
213 | - * @param string $title |
|
214 | - * @param int $id |
|
215 | - * @return string |
|
216 | - */ |
|
217 | - public static function the_title($title = '', $id = 0) |
|
218 | - { |
|
219 | - global $post; |
|
220 | - return in_the_loop() && $post->ID === (int)$id |
|
221 | - ? espresso_event_status_banner($post->ID) . $title |
|
222 | - : $title; |
|
223 | - } |
|
224 | - |
|
225 | - |
|
226 | - /** |
|
227 | - * get_the_excerpt |
|
228 | - * kinda hacky, but if a theme is using get_the_excerpt(), |
|
229 | - * then we need to remove our filters on the_content() |
|
230 | - * |
|
231 | - * @param string $excerpt |
|
232 | - * @return string |
|
233 | - */ |
|
234 | - public static function get_the_excerpt($excerpt = '') |
|
235 | - { |
|
236 | - EED_Event_Single::$using_get_the_excerpt = true; |
|
237 | - add_filter('wp_trim_excerpt', array('EED_Event_Single', 'end_get_the_excerpt'), 999, 1); |
|
238 | - return $excerpt; |
|
239 | - } |
|
240 | - |
|
241 | - |
|
242 | - /** |
|
243 | - * end_get_the_excerpt |
|
244 | - * |
|
245 | - * @param string $text |
|
246 | - * @return string |
|
247 | - */ |
|
248 | - public static function end_get_the_excerpt($text = '') |
|
249 | - { |
|
250 | - EED_Event_Single::$using_get_the_excerpt = false; |
|
251 | - return $text; |
|
252 | - } |
|
253 | - |
|
254 | - |
|
255 | - /** |
|
256 | - * event_details |
|
257 | - * |
|
258 | - * @param string $content |
|
259 | - * @return string |
|
260 | - */ |
|
261 | - public static function event_details($content) |
|
262 | - { |
|
263 | - global $post; |
|
264 | - static $current_post_ID = 0; |
|
265 | - if ( |
|
266 | - $current_post_ID !== $post->ID |
|
267 | - && $post->post_type === 'espresso_events' |
|
268 | - && !EED_Event_Single::$using_get_the_excerpt |
|
269 | - && !post_password_required() |
|
270 | - ) { |
|
271 | - // Set current post ID to prevent showing content twice, but only if headers have definitely been sent. |
|
272 | - // Reason being is that some plugins, like Yoast, need to run through a copy of the loop early |
|
273 | - // BEFORE headers are sent in order to examine the post content and generate content for the HTML header. |
|
274 | - // We want to allow those plugins to still do their thing and have access to our content, but depending on |
|
275 | - // how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice, |
|
276 | - // so the following allows this filter to be applied multiple times, but only once for real |
|
277 | - $current_post_ID = did_action('loop_start') ? $post->ID : 0; |
|
278 | - if (EE_Registry::instance()->CFG->template_settings->EED_Event_Single->use_sortable_display_order) { |
|
279 | - // we need to first remove this callback from being applied to the_content() |
|
280 | - // (otherwise it will recurse and blow up the interweb) |
|
281 | - remove_filter( |
|
282 | - 'the_content', |
|
283 | - array('EED_Event_Single', 'event_details'), |
|
284 | - EED_Event_Single::EVENT_DETAILS_PRIORITY |
|
285 | - ); |
|
286 | - EED_Event_Single::instance()->template_parts = EED_Event_Single::instance()->initialize_template_parts(); |
|
287 | - $content = EEH_Template::locate_template('content-espresso_events-details.php'); |
|
288 | - $content = EED_Event_Single::instance()->template_parts->apply_template_part_filters($content); |
|
289 | - add_filter( |
|
290 | - 'the_content', |
|
291 | - array('EED_Event_Single', 'event_details'), |
|
292 | - EED_Event_Single::EVENT_DETAILS_PRIORITY |
|
293 | - ); |
|
294 | - } else { |
|
295 | - $content = EED_Event_Single::use_filterable_display_order(); |
|
296 | - } |
|
297 | - } |
|
298 | - return $content; |
|
299 | - } |
|
300 | - |
|
301 | - |
|
302 | - /** |
|
303 | - * use_filterable_display_order |
|
304 | - * |
|
305 | - * @return string |
|
306 | - */ |
|
307 | - protected static function use_filterable_display_order() |
|
308 | - { |
|
309 | - // since the 'content-espresso_events-details.php' template might be used directly from within a theme, |
|
310 | - // it uses the_content() for displaying the $post->post_content |
|
311 | - // so in order to load a template that uses the_content() |
|
312 | - // from within a callback being used to filter the_content(), |
|
313 | - // we need to first remove this callback from being applied to the_content() |
|
314 | - // (otherwise it will recurse and blow up the interweb) |
|
315 | - remove_filter( |
|
316 | - 'the_content', |
|
317 | - array('EED_Event_Single', 'event_details'), |
|
318 | - EED_Event_Single::EVENT_DETAILS_PRIORITY |
|
319 | - ); |
|
320 | - //now add additional content |
|
321 | - add_filter( |
|
322 | - 'the_content', |
|
323 | - array('EED_Event_Single', 'event_datetimes'), |
|
324 | - EED_Event_Single::EVENT_DATETIMES_PRIORITY, |
|
325 | - 1 |
|
326 | - ); |
|
327 | - add_filter( |
|
328 | - 'the_content', |
|
329 | - array('EED_Event_Single', 'event_tickets'), |
|
330 | - EED_Event_Single::EVENT_TICKETS_PRIORITY, |
|
331 | - 1 |
|
332 | - ); |
|
333 | - add_filter( |
|
334 | - 'the_content', |
|
335 | - array('EED_Event_Single', 'event_venues'), |
|
336 | - EED_Event_Single::EVENT_VENUES_PRIORITY, |
|
337 | - 1 |
|
338 | - ); |
|
339 | - do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_add_filters'); |
|
340 | - // now load our template |
|
341 | - $content = EEH_Template::locate_template('content-espresso_events-details.php'); |
|
342 | - //now add our filter back in, plus some others |
|
343 | - add_filter( |
|
344 | - 'the_content', |
|
345 | - array('EED_Event_Single', 'event_details'), |
|
346 | - EED_Event_Single::EVENT_DETAILS_PRIORITY |
|
347 | - ); |
|
348 | - remove_filter( |
|
349 | - 'the_content', |
|
350 | - array('EED_Event_Single', 'event_datetimes'), |
|
351 | - EED_Event_Single::EVENT_DATETIMES_PRIORITY |
|
352 | - ); |
|
353 | - remove_filter( |
|
354 | - 'the_content', |
|
355 | - array('EED_Event_Single', 'event_tickets'), |
|
356 | - EED_Event_Single::EVENT_TICKETS_PRIORITY |
|
357 | - ); |
|
358 | - remove_filter( |
|
359 | - 'the_content', |
|
360 | - array('EED_Event_Single', 'event_venues'), |
|
361 | - EED_Event_Single::EVENT_VENUES_PRIORITY |
|
362 | - ); |
|
363 | - do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_remove_filters'); |
|
364 | - // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt) |
|
365 | - return $content; |
|
366 | - } |
|
367 | - |
|
368 | - |
|
369 | - /** |
|
370 | - * event_datetimes - adds datetimes ABOVE content |
|
371 | - * |
|
372 | - * @param string $content |
|
373 | - * @return string |
|
374 | - */ |
|
375 | - public static function event_datetimes($content) |
|
376 | - { |
|
377 | - return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content; |
|
378 | - } |
|
379 | - |
|
380 | - |
|
381 | - /** |
|
382 | - * event_tickets - adds tickets ABOVE content (which includes datetimes) |
|
383 | - * |
|
384 | - * @param string $content |
|
385 | - * @return string |
|
386 | - */ |
|
387 | - public static function event_tickets($content) |
|
388 | - { |
|
389 | - return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content; |
|
390 | - } |
|
391 | - |
|
392 | - |
|
393 | - /** |
|
394 | - * event_venues |
|
395 | - * |
|
396 | - * @param string $content |
|
397 | - * @return string |
|
398 | - */ |
|
399 | - public static function event_venue($content) |
|
400 | - { |
|
401 | - return EED_Event_Single::event_venues($content); |
|
402 | - } |
|
403 | - |
|
404 | - |
|
405 | - /** |
|
406 | - * event_venues - adds venues BELOW content |
|
407 | - * |
|
408 | - * @param string $content |
|
409 | - * @return string |
|
410 | - */ |
|
411 | - public static function event_venues($content) |
|
412 | - { |
|
413 | - return $content . EEH_Template::locate_template('content-espresso_events-venues.php'); |
|
414 | - } |
|
415 | - |
|
416 | - |
|
417 | - /** |
|
418 | - * loop_end |
|
419 | - * |
|
420 | - * @param array $wp_query_array an array containing the WP_Query object |
|
421 | - * @return void |
|
422 | - */ |
|
423 | - public static function loop_end($wp_query_array) |
|
424 | - { |
|
425 | - global $post; |
|
426 | - do_action('AHEE_event_details_after_post', $post, $wp_query_array); |
|
427 | - } |
|
428 | - |
|
429 | - |
|
430 | - /** |
|
431 | - * wp_enqueue_scripts |
|
432 | - * |
|
433 | - * @return void |
|
434 | - */ |
|
435 | - public function wp_enqueue_scripts() |
|
436 | - { |
|
437 | - // get some style |
|
438 | - if ( |
|
439 | - apply_filters('FHEE_enable_default_espresso_css', TRUE) |
|
440 | - && apply_filters('FHEE__EED_Event_Single__wp_enqueue_scripts__enable_css', TRUE) |
|
441 | - ) { |
|
442 | - // first check uploads folder |
|
443 | - if (is_readable(get_stylesheet_directory() . $this->theme . DS . 'style.css')) { |
|
444 | - wp_register_style( |
|
445 | - $this->theme, |
|
446 | - get_stylesheet_directory_uri() . $this->theme . DS . 'style.css', |
|
447 | - array('dashicons', 'espresso_default') |
|
448 | - ); |
|
449 | - } else { |
|
450 | - wp_register_style( |
|
451 | - $this->theme, |
|
452 | - EE_TEMPLATES_URL . $this->theme . DS . 'style.css', |
|
453 | - array('dashicons', 'espresso_default') |
|
454 | - ); |
|
455 | - } |
|
456 | - wp_enqueue_script($this->theme); |
|
457 | - if (EE_Registry::instance()->CFG->map_settings->use_google_maps) { |
|
458 | - add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11); |
|
459 | - } |
|
460 | - } |
|
461 | - } |
|
462 | - |
|
463 | - |
|
464 | - /** |
|
465 | - * display_venue |
|
466 | - * |
|
467 | - * @return bool |
|
468 | - */ |
|
469 | - public static function display_venue() |
|
470 | - { |
|
471 | - /** @type EE_Event_Single_Config $config */ |
|
472 | - $config = EED_Event_Single::instance()->config(); |
|
473 | - $display_venue = $config->display_venue === null ? true : $config->display_venue; |
|
474 | - $venue_name = EEH_Venue_View::venue_name(); |
|
475 | - return $display_venue && !empty($venue_name); |
|
476 | - } |
|
16 | + const EVENT_DETAILS_PRIORITY = 100; |
|
17 | + const EVENT_DATETIMES_PRIORITY = 110; |
|
18 | + const EVENT_TICKETS_PRIORITY = 120; |
|
19 | + const EVENT_VENUES_PRIORITY = 130; |
|
20 | + |
|
21 | + /** |
|
22 | + * @type bool $using_get_the_excerpt |
|
23 | + */ |
|
24 | + protected static $using_get_the_excerpt = false; |
|
25 | + |
|
26 | + |
|
27 | + /** |
|
28 | + * @type EE_Template_Part_Manager $template_parts |
|
29 | + */ |
|
30 | + protected $template_parts; |
|
31 | + |
|
32 | + |
|
33 | + /** |
|
34 | + * @return EED_Module|EED_Event_Single |
|
35 | + */ |
|
36 | + public static function instance() |
|
37 | + { |
|
38 | + return parent::get_instance(__CLASS__); |
|
39 | + } |
|
40 | + |
|
41 | + |
|
42 | + /** |
|
43 | + * set_hooks - for hooking into EE Core, other modules, etc |
|
44 | + * |
|
45 | + * @return void |
|
46 | + */ |
|
47 | + public static function set_hooks() |
|
48 | + { |
|
49 | + add_filter('FHEE_run_EE_wp', '__return_true'); |
|
50 | + add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2); |
|
51 | + $custom_post_types = EE_Register_CPTs::get_CPTs(); |
|
52 | + EE_Config::register_route( |
|
53 | + $custom_post_types['espresso_events']['singular_slug'], |
|
54 | + 'Event_Single', |
|
55 | + 'run' |
|
56 | + ); |
|
57 | + } |
|
58 | + |
|
59 | + /** |
|
60 | + * set_hooks_admin - for hooking into EE Admin Core, other modules, etc |
|
61 | + * |
|
62 | + * @return void |
|
63 | + */ |
|
64 | + public static function set_hooks_admin() |
|
65 | + { |
|
66 | + add_action('wp_loaded', array('EED_Event_Single', 'set_definitions'), 2); |
|
67 | + } |
|
68 | + |
|
69 | + |
|
70 | + /** |
|
71 | + * set_definitions |
|
72 | + * |
|
73 | + * @static |
|
74 | + * @return void |
|
75 | + */ |
|
76 | + public static function set_definitions() |
|
77 | + { |
|
78 | + define('EVENT_SINGLE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS); |
|
79 | + define('EVENT_SINGLE_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates' . DS); |
|
80 | + } |
|
81 | + |
|
82 | + |
|
83 | + /** |
|
84 | + * set_config |
|
85 | + * |
|
86 | + * @void |
|
87 | + */ |
|
88 | + protected function set_config() |
|
89 | + { |
|
90 | + $this->set_config_section('template_settings'); |
|
91 | + $this->set_config_class('EE_Event_Single_Config'); |
|
92 | + $this->set_config_name('EED_Event_Single'); |
|
93 | + } |
|
94 | + |
|
95 | + |
|
96 | + /** |
|
97 | + * initialize_template_parts |
|
98 | + * |
|
99 | + * @param EE_Config_Base|EE_Event_Single_Config $config |
|
100 | + * @return EE_Template_Part_Manager |
|
101 | + */ |
|
102 | + public function initialize_template_parts(EE_Event_Single_Config $config = null) |
|
103 | + { |
|
104 | + /** @type EE_Event_Single_Config $config */ |
|
105 | + $config = $config instanceof EE_Event_Single_Config ? $config : $this->config(); |
|
106 | + EEH_Autoloader::instance()->register_template_part_autoloaders(); |
|
107 | + $template_parts = new EE_Template_Part_Manager(); |
|
108 | + $template_parts->add_template_part( |
|
109 | + 'tickets', |
|
110 | + __('Ticket Selector', 'event_espresso'), |
|
111 | + 'content-espresso_events-tickets.php', |
|
112 | + $config->display_order_tickets |
|
113 | + ); |
|
114 | + $template_parts->add_template_part( |
|
115 | + 'datetimes', |
|
116 | + __('Dates and Times', 'event_espresso'), |
|
117 | + 'content-espresso_events-datetimes.php', |
|
118 | + $config->display_order_datetimes |
|
119 | + ); |
|
120 | + $template_parts->add_template_part( |
|
121 | + 'event', |
|
122 | + __('Event Description', 'event_espresso'), |
|
123 | + 'content-espresso_events-details.php', |
|
124 | + $config->display_order_event |
|
125 | + ); |
|
126 | + $template_parts->add_template_part( |
|
127 | + 'venue', |
|
128 | + __('Venue Information', 'event_espresso'), |
|
129 | + 'content-espresso_events-venues.php', |
|
130 | + $config->display_order_venue |
|
131 | + ); |
|
132 | + do_action('AHEE__EED_Event_Single__initialize_template_parts', $template_parts); |
|
133 | + return $template_parts; |
|
134 | + } |
|
135 | + |
|
136 | + |
|
137 | + /** |
|
138 | + * run - initial module setup |
|
139 | + * |
|
140 | + * @param WP $WP |
|
141 | + * @return void |
|
142 | + */ |
|
143 | + public function run($WP) |
|
144 | + { |
|
145 | + // ensure valid EE_Events_Single_Config() object exists |
|
146 | + $this->set_config(); |
|
147 | + // check what template is loaded |
|
148 | + add_filter('template_include', array($this, 'template_include'), 999, 1); |
|
149 | + add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true'); |
|
150 | + // load css |
|
151 | + add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10); |
|
152 | + } |
|
153 | + |
|
154 | + |
|
155 | + /** |
|
156 | + * template_include |
|
157 | + * |
|
158 | + * @param string $template |
|
159 | + * @return string |
|
160 | + */ |
|
161 | + public function template_include($template) |
|
162 | + { |
|
163 | + global $post; |
|
164 | + /** @type EE_Event_Single_Config $config */ |
|
165 | + $config = $this->config(); |
|
166 | + if ($config->display_status_banner_single) { |
|
167 | + add_filter('the_title', array('EED_Event_Single', 'the_title'), 100, 2); |
|
168 | + } |
|
169 | + // not a custom template? |
|
170 | + if ( |
|
171 | + !post_password_required($post) |
|
172 | + && ( |
|
173 | + apply_filters('FHEE__EED_Event_Single__template_include__allow_custom_selected_template', false) |
|
174 | + || EE_Registry::instance() |
|
175 | + ->load_core('Front_Controller') |
|
176 | + ->get_selected_template() !== 'single-espresso_events.php' |
|
177 | + ) |
|
178 | + |
|
179 | + ) { |
|
180 | + EEH_Template::load_espresso_theme_functions(); |
|
181 | + // then add extra event data via hooks |
|
182 | + add_action('loop_start', array('EED_Event_Single', 'loop_start')); |
|
183 | + add_filter('get_the_excerpt', array('EED_Event_Single', 'get_the_excerpt'), 1, 1); |
|
184 | + add_filter( |
|
185 | + 'the_content', |
|
186 | + array('EED_Event_Single', 'event_details'), |
|
187 | + EED_Event_Single::EVENT_DETAILS_PRIORITY |
|
188 | + ); |
|
189 | + add_action('loop_end', array('EED_Event_Single', 'loop_end')); |
|
190 | + // don't display entry meta because the existing theme will take car of that |
|
191 | + add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false'); |
|
192 | + } |
|
193 | + return $template; |
|
194 | + } |
|
195 | + |
|
196 | + |
|
197 | + /** |
|
198 | + * loop_start |
|
199 | + * |
|
200 | + * @param array $wp_query_array an array containing the WP_Query object |
|
201 | + * @return void |
|
202 | + */ |
|
203 | + public static function loop_start($wp_query_array) |
|
204 | + { |
|
205 | + global $post; |
|
206 | + do_action('AHEE_event_details_before_post', $post, $wp_query_array); |
|
207 | + } |
|
208 | + |
|
209 | + |
|
210 | + /** |
|
211 | + * the_title |
|
212 | + * |
|
213 | + * @param string $title |
|
214 | + * @param int $id |
|
215 | + * @return string |
|
216 | + */ |
|
217 | + public static function the_title($title = '', $id = 0) |
|
218 | + { |
|
219 | + global $post; |
|
220 | + return in_the_loop() && $post->ID === (int)$id |
|
221 | + ? espresso_event_status_banner($post->ID) . $title |
|
222 | + : $title; |
|
223 | + } |
|
224 | + |
|
225 | + |
|
226 | + /** |
|
227 | + * get_the_excerpt |
|
228 | + * kinda hacky, but if a theme is using get_the_excerpt(), |
|
229 | + * then we need to remove our filters on the_content() |
|
230 | + * |
|
231 | + * @param string $excerpt |
|
232 | + * @return string |
|
233 | + */ |
|
234 | + public static function get_the_excerpt($excerpt = '') |
|
235 | + { |
|
236 | + EED_Event_Single::$using_get_the_excerpt = true; |
|
237 | + add_filter('wp_trim_excerpt', array('EED_Event_Single', 'end_get_the_excerpt'), 999, 1); |
|
238 | + return $excerpt; |
|
239 | + } |
|
240 | + |
|
241 | + |
|
242 | + /** |
|
243 | + * end_get_the_excerpt |
|
244 | + * |
|
245 | + * @param string $text |
|
246 | + * @return string |
|
247 | + */ |
|
248 | + public static function end_get_the_excerpt($text = '') |
|
249 | + { |
|
250 | + EED_Event_Single::$using_get_the_excerpt = false; |
|
251 | + return $text; |
|
252 | + } |
|
253 | + |
|
254 | + |
|
255 | + /** |
|
256 | + * event_details |
|
257 | + * |
|
258 | + * @param string $content |
|
259 | + * @return string |
|
260 | + */ |
|
261 | + public static function event_details($content) |
|
262 | + { |
|
263 | + global $post; |
|
264 | + static $current_post_ID = 0; |
|
265 | + if ( |
|
266 | + $current_post_ID !== $post->ID |
|
267 | + && $post->post_type === 'espresso_events' |
|
268 | + && !EED_Event_Single::$using_get_the_excerpt |
|
269 | + && !post_password_required() |
|
270 | + ) { |
|
271 | + // Set current post ID to prevent showing content twice, but only if headers have definitely been sent. |
|
272 | + // Reason being is that some plugins, like Yoast, need to run through a copy of the loop early |
|
273 | + // BEFORE headers are sent in order to examine the post content and generate content for the HTML header. |
|
274 | + // We want to allow those plugins to still do their thing and have access to our content, but depending on |
|
275 | + // how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice, |
|
276 | + // so the following allows this filter to be applied multiple times, but only once for real |
|
277 | + $current_post_ID = did_action('loop_start') ? $post->ID : 0; |
|
278 | + if (EE_Registry::instance()->CFG->template_settings->EED_Event_Single->use_sortable_display_order) { |
|
279 | + // we need to first remove this callback from being applied to the_content() |
|
280 | + // (otherwise it will recurse and blow up the interweb) |
|
281 | + remove_filter( |
|
282 | + 'the_content', |
|
283 | + array('EED_Event_Single', 'event_details'), |
|
284 | + EED_Event_Single::EVENT_DETAILS_PRIORITY |
|
285 | + ); |
|
286 | + EED_Event_Single::instance()->template_parts = EED_Event_Single::instance()->initialize_template_parts(); |
|
287 | + $content = EEH_Template::locate_template('content-espresso_events-details.php'); |
|
288 | + $content = EED_Event_Single::instance()->template_parts->apply_template_part_filters($content); |
|
289 | + add_filter( |
|
290 | + 'the_content', |
|
291 | + array('EED_Event_Single', 'event_details'), |
|
292 | + EED_Event_Single::EVENT_DETAILS_PRIORITY |
|
293 | + ); |
|
294 | + } else { |
|
295 | + $content = EED_Event_Single::use_filterable_display_order(); |
|
296 | + } |
|
297 | + } |
|
298 | + return $content; |
|
299 | + } |
|
300 | + |
|
301 | + |
|
302 | + /** |
|
303 | + * use_filterable_display_order |
|
304 | + * |
|
305 | + * @return string |
|
306 | + */ |
|
307 | + protected static function use_filterable_display_order() |
|
308 | + { |
|
309 | + // since the 'content-espresso_events-details.php' template might be used directly from within a theme, |
|
310 | + // it uses the_content() for displaying the $post->post_content |
|
311 | + // so in order to load a template that uses the_content() |
|
312 | + // from within a callback being used to filter the_content(), |
|
313 | + // we need to first remove this callback from being applied to the_content() |
|
314 | + // (otherwise it will recurse and blow up the interweb) |
|
315 | + remove_filter( |
|
316 | + 'the_content', |
|
317 | + array('EED_Event_Single', 'event_details'), |
|
318 | + EED_Event_Single::EVENT_DETAILS_PRIORITY |
|
319 | + ); |
|
320 | + //now add additional content |
|
321 | + add_filter( |
|
322 | + 'the_content', |
|
323 | + array('EED_Event_Single', 'event_datetimes'), |
|
324 | + EED_Event_Single::EVENT_DATETIMES_PRIORITY, |
|
325 | + 1 |
|
326 | + ); |
|
327 | + add_filter( |
|
328 | + 'the_content', |
|
329 | + array('EED_Event_Single', 'event_tickets'), |
|
330 | + EED_Event_Single::EVENT_TICKETS_PRIORITY, |
|
331 | + 1 |
|
332 | + ); |
|
333 | + add_filter( |
|
334 | + 'the_content', |
|
335 | + array('EED_Event_Single', 'event_venues'), |
|
336 | + EED_Event_Single::EVENT_VENUES_PRIORITY, |
|
337 | + 1 |
|
338 | + ); |
|
339 | + do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_add_filters'); |
|
340 | + // now load our template |
|
341 | + $content = EEH_Template::locate_template('content-espresso_events-details.php'); |
|
342 | + //now add our filter back in, plus some others |
|
343 | + add_filter( |
|
344 | + 'the_content', |
|
345 | + array('EED_Event_Single', 'event_details'), |
|
346 | + EED_Event_Single::EVENT_DETAILS_PRIORITY |
|
347 | + ); |
|
348 | + remove_filter( |
|
349 | + 'the_content', |
|
350 | + array('EED_Event_Single', 'event_datetimes'), |
|
351 | + EED_Event_Single::EVENT_DATETIMES_PRIORITY |
|
352 | + ); |
|
353 | + remove_filter( |
|
354 | + 'the_content', |
|
355 | + array('EED_Event_Single', 'event_tickets'), |
|
356 | + EED_Event_Single::EVENT_TICKETS_PRIORITY |
|
357 | + ); |
|
358 | + remove_filter( |
|
359 | + 'the_content', |
|
360 | + array('EED_Event_Single', 'event_venues'), |
|
361 | + EED_Event_Single::EVENT_VENUES_PRIORITY |
|
362 | + ); |
|
363 | + do_action('AHEE__EED_Event_Single__use_filterable_display_order__after_remove_filters'); |
|
364 | + // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt) |
|
365 | + return $content; |
|
366 | + } |
|
367 | + |
|
368 | + |
|
369 | + /** |
|
370 | + * event_datetimes - adds datetimes ABOVE content |
|
371 | + * |
|
372 | + * @param string $content |
|
373 | + * @return string |
|
374 | + */ |
|
375 | + public static function event_datetimes($content) |
|
376 | + { |
|
377 | + return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content; |
|
378 | + } |
|
379 | + |
|
380 | + |
|
381 | + /** |
|
382 | + * event_tickets - adds tickets ABOVE content (which includes datetimes) |
|
383 | + * |
|
384 | + * @param string $content |
|
385 | + * @return string |
|
386 | + */ |
|
387 | + public static function event_tickets($content) |
|
388 | + { |
|
389 | + return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content; |
|
390 | + } |
|
391 | + |
|
392 | + |
|
393 | + /** |
|
394 | + * event_venues |
|
395 | + * |
|
396 | + * @param string $content |
|
397 | + * @return string |
|
398 | + */ |
|
399 | + public static function event_venue($content) |
|
400 | + { |
|
401 | + return EED_Event_Single::event_venues($content); |
|
402 | + } |
|
403 | + |
|
404 | + |
|
405 | + /** |
|
406 | + * event_venues - adds venues BELOW content |
|
407 | + * |
|
408 | + * @param string $content |
|
409 | + * @return string |
|
410 | + */ |
|
411 | + public static function event_venues($content) |
|
412 | + { |
|
413 | + return $content . EEH_Template::locate_template('content-espresso_events-venues.php'); |
|
414 | + } |
|
415 | + |
|
416 | + |
|
417 | + /** |
|
418 | + * loop_end |
|
419 | + * |
|
420 | + * @param array $wp_query_array an array containing the WP_Query object |
|
421 | + * @return void |
|
422 | + */ |
|
423 | + public static function loop_end($wp_query_array) |
|
424 | + { |
|
425 | + global $post; |
|
426 | + do_action('AHEE_event_details_after_post', $post, $wp_query_array); |
|
427 | + } |
|
428 | + |
|
429 | + |
|
430 | + /** |
|
431 | + * wp_enqueue_scripts |
|
432 | + * |
|
433 | + * @return void |
|
434 | + */ |
|
435 | + public function wp_enqueue_scripts() |
|
436 | + { |
|
437 | + // get some style |
|
438 | + if ( |
|
439 | + apply_filters('FHEE_enable_default_espresso_css', TRUE) |
|
440 | + && apply_filters('FHEE__EED_Event_Single__wp_enqueue_scripts__enable_css', TRUE) |
|
441 | + ) { |
|
442 | + // first check uploads folder |
|
443 | + if (is_readable(get_stylesheet_directory() . $this->theme . DS . 'style.css')) { |
|
444 | + wp_register_style( |
|
445 | + $this->theme, |
|
446 | + get_stylesheet_directory_uri() . $this->theme . DS . 'style.css', |
|
447 | + array('dashicons', 'espresso_default') |
|
448 | + ); |
|
449 | + } else { |
|
450 | + wp_register_style( |
|
451 | + $this->theme, |
|
452 | + EE_TEMPLATES_URL . $this->theme . DS . 'style.css', |
|
453 | + array('dashicons', 'espresso_default') |
|
454 | + ); |
|
455 | + } |
|
456 | + wp_enqueue_script($this->theme); |
|
457 | + if (EE_Registry::instance()->CFG->map_settings->use_google_maps) { |
|
458 | + add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11); |
|
459 | + } |
|
460 | + } |
|
461 | + } |
|
462 | + |
|
463 | + |
|
464 | + /** |
|
465 | + * display_venue |
|
466 | + * |
|
467 | + * @return bool |
|
468 | + */ |
|
469 | + public static function display_venue() |
|
470 | + { |
|
471 | + /** @type EE_Event_Single_Config $config */ |
|
472 | + $config = EED_Event_Single::instance()->config(); |
|
473 | + $display_venue = $config->display_venue === null ? true : $config->display_venue; |
|
474 | + $venue_name = EEH_Venue_View::venue_name(); |
|
475 | + return $display_venue && !empty($venue_name); |
|
476 | + } |
|
477 | 477 | |
478 | 478 | |
479 | 479 | } |
@@ -487,7 +487,7 @@ discard block |
||
487 | 487 | */ |
488 | 488 | function espresso_display_venue_in_event_details() |
489 | 489 | { |
490 | - return EED_Event_Single::display_venue(); |
|
490 | + return EED_Event_Single::display_venue(); |
|
491 | 491 | } |
492 | 492 | |
493 | 493 |
@@ -14,13 +14,13 @@ discard block |
||
14 | 14 | */ |
15 | 15 | class EED_Events_Archive extends EED_Module { |
16 | 16 | |
17 | - const EVENT_DETAILS_PRIORITY = 100; |
|
18 | - const EVENT_DATETIMES_PRIORITY = 110; |
|
19 | - const EVENT_TICKETS_PRIORITY = 120; |
|
20 | - const EVENT_VENUES_PRIORITY = 130; |
|
17 | + const EVENT_DETAILS_PRIORITY = 100; |
|
18 | + const EVENT_DATETIMES_PRIORITY = 110; |
|
19 | + const EVENT_TICKETS_PRIORITY = 120; |
|
20 | + const EVENT_VENUES_PRIORITY = 130; |
|
21 | 21 | |
22 | 22 | |
23 | - public static $espresso_event_list_ID = 0; |
|
23 | + public static $espresso_event_list_ID = 0; |
|
24 | 24 | public static $espresso_grid_event_lists = array(); |
25 | 25 | |
26 | 26 | /** |
@@ -28,19 +28,19 @@ discard block |
||
28 | 28 | */ |
29 | 29 | protected static $using_get_the_excerpt = false; |
30 | 30 | |
31 | - /** |
|
32 | - * Used to flag when the event list is being called from an external iframe. |
|
33 | - * |
|
34 | - * @var bool $iframe |
|
35 | - */ |
|
36 | - protected static $iframe = false; |
|
31 | + /** |
|
32 | + * Used to flag when the event list is being called from an external iframe. |
|
33 | + * |
|
34 | + * @var bool $iframe |
|
35 | + */ |
|
36 | + protected static $iframe = false; |
|
37 | 37 | |
38 | - /** |
|
38 | + /** |
|
39 | 39 | * @var \EventEspresso\core\libraries\iframe_display\EventListIframeEmbedButton $_iframe_embed_button |
40 | 40 | */ |
41 | 41 | private static $_iframe_embed_button; |
42 | 42 | |
43 | - /** |
|
43 | + /** |
|
44 | 44 | * @type EE_Template_Part_Manager $template_parts |
45 | 45 | */ |
46 | 46 | protected $template_parts; |
@@ -63,24 +63,24 @@ discard block |
||
63 | 63 | * @return void |
64 | 64 | */ |
65 | 65 | public static function set_hooks() { |
66 | - $custom_post_types = EE_Register_CPTs::get_CPTs(); |
|
67 | - EE_Config::register_route( |
|
68 | - $custom_post_types['espresso_events']['plural_slug'], |
|
69 | - 'Events_Archive', |
|
70 | - 'run' |
|
71 | - ); |
|
72 | - EE_Config::register_route( |
|
73 | - 'event_list', |
|
74 | - 'Events_Archive', |
|
75 | - 'event_list' |
|
76 | - ); |
|
77 | - EE_Config::register_route( |
|
78 | - 'iframe', |
|
79 | - 'Events_Archive', |
|
80 | - 'event_list_iframe', |
|
81 | - 'event_list' |
|
82 | - ); |
|
83 | - add_action( 'wp_loaded', array( 'EED_Events_Archive', 'set_definitions' ), 2 ); |
|
66 | + $custom_post_types = EE_Register_CPTs::get_CPTs(); |
|
67 | + EE_Config::register_route( |
|
68 | + $custom_post_types['espresso_events']['plural_slug'], |
|
69 | + 'Events_Archive', |
|
70 | + 'run' |
|
71 | + ); |
|
72 | + EE_Config::register_route( |
|
73 | + 'event_list', |
|
74 | + 'Events_Archive', |
|
75 | + 'event_list' |
|
76 | + ); |
|
77 | + EE_Config::register_route( |
|
78 | + 'iframe', |
|
79 | + 'Events_Archive', |
|
80 | + 'event_list_iframe', |
|
81 | + 'event_list' |
|
82 | + ); |
|
83 | + add_action( 'wp_loaded', array( 'EED_Events_Archive', 'set_definitions' ), 2 ); |
|
84 | 84 | } |
85 | 85 | |
86 | 86 | /** |
@@ -224,9 +224,9 @@ discard block |
||
224 | 224 | |
225 | 225 | |
226 | 226 | /** |
227 | - * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting |
|
228 | - * |
|
229 | - * @return void |
|
227 | + * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting |
|
228 | + * |
|
229 | + * @return void |
|
230 | 230 | */ |
231 | 231 | public function event_list() { |
232 | 232 | // ensure valid EE_Events_Archive_Config() object exists |
@@ -237,36 +237,36 @@ discard block |
||
237 | 237 | |
238 | 238 | |
239 | 239 | |
240 | - /** |
|
241 | - * @access public |
|
242 | - * @return void |
|
243 | - * @throws \EE_Error |
|
244 | - * @throws \DomainException |
|
245 | - */ |
|
240 | + /** |
|
241 | + * @access public |
|
242 | + * @return void |
|
243 | + * @throws \EE_Error |
|
244 | + * @throws \DomainException |
|
245 | + */ |
|
246 | 246 | public function event_list_iframe() { |
247 | - \EED_Events_Archive::$iframe = true; |
|
247 | + \EED_Events_Archive::$iframe = true; |
|
248 | 248 | $event_list_iframe = new EventsArchiveIframe( $this ); |
249 | 249 | $event_list_iframe->display(); |
250 | 250 | } |
251 | 251 | |
252 | 252 | |
253 | 253 | |
254 | - /** |
|
255 | - * @access public |
|
256 | - * @return string |
|
257 | - */ |
|
254 | + /** |
|
255 | + * @access public |
|
256 | + * @return string |
|
257 | + */ |
|
258 | 258 | public static function is_iframe() { |
259 | - return \EED_Events_Archive::$iframe; |
|
259 | + return \EED_Events_Archive::$iframe; |
|
260 | 260 | } |
261 | 261 | |
262 | 262 | |
263 | 263 | |
264 | - /** |
|
265 | - * @access public |
|
266 | - * @return string |
|
267 | - */ |
|
264 | + /** |
|
265 | + * @access public |
|
266 | + * @return string |
|
267 | + */ |
|
268 | 268 | public static function link_target() { |
269 | - return \EED_Events_Archive::$iframe ? ' target="_blank"' : ''; |
|
269 | + return \EED_Events_Archive::$iframe ? ' target="_blank"' : ''; |
|
270 | 270 | } |
271 | 271 | |
272 | 272 | |
@@ -294,10 +294,10 @@ discard block |
||
294 | 294 | } |
295 | 295 | // if NOT a custom template |
296 | 296 | if ( |
297 | - apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false) |
|
297 | + apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false) |
|
298 | 298 | || EE_Registry::instance() |
299 | - ->load_core( 'Front_Controller' ) |
|
300 | - ->get_selected_template() !== 'archive-espresso_events.php' |
|
299 | + ->load_core( 'Front_Controller' ) |
|
300 | + ->get_selected_template() !== 'archive-espresso_events.php' |
|
301 | 301 | ) { |
302 | 302 | // don't display entry meta because the existing theme will take care of that |
303 | 303 | add_filter( 'FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true' ); |
@@ -305,16 +305,16 @@ discard block |
||
305 | 305 | EEH_Template::load_espresso_theme_functions(); |
306 | 306 | // because we don't know if the theme is using the_excerpt() |
307 | 307 | add_filter( |
308 | - 'the_excerpt', |
|
309 | - array( 'EED_Events_Archive', 'event_details' ), |
|
310 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
311 | - ); |
|
308 | + 'the_excerpt', |
|
309 | + array( 'EED_Events_Archive', 'event_details' ), |
|
310 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
311 | + ); |
|
312 | 312 | // or the_content |
313 | 313 | add_filter( |
314 | - 'the_content', |
|
315 | - array( 'EED_Events_Archive', 'event_details' ), |
|
316 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
317 | - ); |
|
314 | + 'the_content', |
|
315 | + array( 'EED_Events_Archive', 'event_details' ), |
|
316 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
317 | + ); |
|
318 | 318 | // and just in case they are running get_the_excerpt() which DESTROYS things |
319 | 319 | add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 ); |
320 | 320 | // don't display entry meta because the existing theme will take care of that |
@@ -339,15 +339,15 @@ discard block |
||
339 | 339 | } |
340 | 340 | if ( apply_filters( 'FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false ) ) { |
341 | 341 | remove_filter( |
342 | - 'the_excerpt', |
|
343 | - array( 'EED_Events_Archive', 'event_details' ), |
|
344 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
345 | - ); |
|
342 | + 'the_excerpt', |
|
343 | + array( 'EED_Events_Archive', 'event_details' ), |
|
344 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
345 | + ); |
|
346 | 346 | remove_filter( |
347 | - 'the_content', |
|
348 | - array( 'EED_Events_Archive', 'event_details' ), |
|
349 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
350 | - ); |
|
347 | + 'the_content', |
|
348 | + array( 'EED_Events_Archive', 'event_details' ), |
|
349 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
350 | + ); |
|
351 | 351 | $excerpt = EED_Events_Archive::event_details( $excerpt ); |
352 | 352 | } else { |
353 | 353 | EED_Events_Archive::$using_get_the_excerpt = true; |
@@ -438,17 +438,17 @@ discard block |
||
438 | 438 | // no further password checks required atm |
439 | 439 | add_filter( 'FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true' ); |
440 | 440 | // we need to first remove this callback from being applied to the_content() or the_excerpt() |
441 | - // (otherwise it will recurse and blow up the interweb) |
|
441 | + // (otherwise it will recurse and blow up the interweb) |
|
442 | 442 | remove_filter( |
443 | - 'the_excerpt', |
|
444 | - array( 'EED_Events_Archive', 'event_details' ), |
|
445 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
446 | - ); |
|
443 | + 'the_excerpt', |
|
444 | + array( 'EED_Events_Archive', 'event_details' ), |
|
445 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
446 | + ); |
|
447 | 447 | remove_filter( |
448 | - 'the_content', |
|
449 | - array( 'EED_Events_Archive', 'event_details' ), |
|
450 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
451 | - ); |
|
448 | + 'the_content', |
|
449 | + array( 'EED_Events_Archive', 'event_details' ), |
|
450 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
451 | + ); |
|
452 | 452 | remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 ); |
453 | 453 | // now add additional content depending on whether event is using the_excerpt() or the_content() |
454 | 454 | EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts(); |
@@ -456,20 +456,20 @@ discard block |
||
456 | 456 | $content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters( $content ); |
457 | 457 | // re-add our main filters (or else the next event won't have them) |
458 | 458 | add_filter( |
459 | - 'the_excerpt', |
|
460 | - array( 'EED_Events_Archive', 'event_details' ), |
|
461 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
462 | - ); |
|
459 | + 'the_excerpt', |
|
460 | + array( 'EED_Events_Archive', 'event_details' ), |
|
461 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
462 | + ); |
|
463 | 463 | add_filter( |
464 | - 'the_content', |
|
465 | - array( 'EED_Events_Archive', 'event_details' ), |
|
466 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
467 | - ); |
|
464 | + 'the_content', |
|
465 | + array( 'EED_Events_Archive', 'event_details' ), |
|
466 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
467 | + ); |
|
468 | 468 | add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 ); |
469 | 469 | remove_filter( |
470 | - 'FHEE__EED_Events_Archive__event_details__no_post_password_required', |
|
471 | - '__return_true' |
|
472 | - ); |
|
470 | + 'FHEE__EED_Events_Archive__event_details__no_post_password_required', |
|
471 | + '__return_true' |
|
472 | + ); |
|
473 | 473 | return $content; |
474 | 474 | } |
475 | 475 | |
@@ -485,15 +485,15 @@ discard block |
||
485 | 485 | // we need to first remove this callback from being applied to the_content() |
486 | 486 | // (otherwise it will recurse and blow up the interweb) |
487 | 487 | remove_filter( |
488 | - 'the_excerpt', |
|
489 | - array( 'EED_Events_Archive', 'event_details' ), |
|
490 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
491 | - ); |
|
488 | + 'the_excerpt', |
|
489 | + array( 'EED_Events_Archive', 'event_details' ), |
|
490 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
491 | + ); |
|
492 | 492 | remove_filter( |
493 | - 'the_content', |
|
494 | - array( 'EED_Events_Archive', 'event_details' ), |
|
495 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
496 | - ); |
|
493 | + 'the_content', |
|
494 | + array( 'EED_Events_Archive', 'event_details' ), |
|
495 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
496 | + ); |
|
497 | 497 | remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 ); |
498 | 498 | //now add additional content depending on whether event is using the_excerpt() or the_content() |
499 | 499 | EED_Events_Archive::_add_additional_excerpt_filters(); |
@@ -503,15 +503,15 @@ discard block |
||
503 | 503 | $content = EEH_Template::locate_template( 'content-espresso_events-details.php' ); |
504 | 504 | // re-add our main filters (or else the next event won't have them) |
505 | 505 | add_filter( |
506 | - 'the_excerpt', |
|
507 | - array( 'EED_Events_Archive', 'event_details' ), |
|
508 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
509 | - ); |
|
506 | + 'the_excerpt', |
|
507 | + array( 'EED_Events_Archive', 'event_details' ), |
|
508 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
509 | + ); |
|
510 | 510 | add_filter( |
511 | - 'the_content', |
|
512 | - array( 'EED_Events_Archive', 'event_details' ), |
|
513 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
514 | - ); |
|
511 | + 'the_content', |
|
512 | + array( 'EED_Events_Archive', 'event_details' ), |
|
513 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
514 | + ); |
|
515 | 515 | add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 ); |
516 | 516 | // but remove the other filters so that they don't get applied to the next post |
517 | 517 | EED_Events_Archive::_remove_additional_events_archive_filters(); |
@@ -588,20 +588,20 @@ discard block |
||
588 | 588 | */ |
589 | 589 | private static function _add_additional_excerpt_filters() { |
590 | 590 | add_filter( |
591 | - 'the_excerpt', |
|
592 | - array( 'EED_Events_Archive', 'event_datetimes' ), |
|
593 | - EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
|
594 | - ); |
|
591 | + 'the_excerpt', |
|
592 | + array( 'EED_Events_Archive', 'event_datetimes' ), |
|
593 | + EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
|
594 | + ); |
|
595 | 595 | add_filter( |
596 | - 'the_excerpt', |
|
597 | - array( 'EED_Events_Archive', 'event_tickets' ), |
|
598 | - EED_Events_Archive::EVENT_TICKETS_PRIORITY |
|
599 | - ); |
|
596 | + 'the_excerpt', |
|
597 | + array( 'EED_Events_Archive', 'event_tickets' ), |
|
598 | + EED_Events_Archive::EVENT_TICKETS_PRIORITY |
|
599 | + ); |
|
600 | 600 | add_filter( |
601 | - 'the_excerpt', |
|
602 | - array( 'EED_Events_Archive', 'event_venues' ), |
|
603 | - EED_Events_Archive::EVENT_VENUES_PRIORITY |
|
604 | - ); |
|
601 | + 'the_excerpt', |
|
602 | + array( 'EED_Events_Archive', 'event_venues' ), |
|
603 | + EED_Events_Archive::EVENT_VENUES_PRIORITY |
|
604 | + ); |
|
605 | 605 | } |
606 | 606 | |
607 | 607 | |
@@ -614,20 +614,20 @@ discard block |
||
614 | 614 | */ |
615 | 615 | private static function _add_additional_content_filters() { |
616 | 616 | add_filter( |
617 | - 'the_content', |
|
618 | - array( 'EED_Events_Archive', 'event_datetimes' ), |
|
619 | - EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
|
620 | - ); |
|
617 | + 'the_content', |
|
618 | + array( 'EED_Events_Archive', 'event_datetimes' ), |
|
619 | + EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
|
620 | + ); |
|
621 | 621 | add_filter( |
622 | - 'the_content', |
|
623 | - array( 'EED_Events_Archive', 'event_tickets' ), |
|
624 | - EED_Events_Archive::EVENT_TICKETS_PRIORITY |
|
625 | - ); |
|
622 | + 'the_content', |
|
623 | + array( 'EED_Events_Archive', 'event_tickets' ), |
|
624 | + EED_Events_Archive::EVENT_TICKETS_PRIORITY |
|
625 | + ); |
|
626 | 626 | add_filter( |
627 | - 'the_content', |
|
628 | - array( 'EED_Events_Archive', 'event_venues' ), |
|
629 | - EED_Events_Archive::EVENT_VENUES_PRIORITY |
|
630 | - ); |
|
627 | + 'the_content', |
|
628 | + array( 'EED_Events_Archive', 'event_venues' ), |
|
629 | + EED_Events_Archive::EVENT_VENUES_PRIORITY |
|
630 | + ); |
|
631 | 631 | } |
632 | 632 | |
633 | 633 | |
@@ -640,35 +640,35 @@ discard block |
||
640 | 640 | */ |
641 | 641 | private static function _remove_additional_events_archive_filters() { |
642 | 642 | remove_filter( |
643 | - 'the_excerpt', |
|
644 | - array( 'EED_Events_Archive', 'event_datetimes' ), |
|
645 | - EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
|
646 | - ); |
|
643 | + 'the_excerpt', |
|
644 | + array( 'EED_Events_Archive', 'event_datetimes' ), |
|
645 | + EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
|
646 | + ); |
|
647 | 647 | remove_filter( |
648 | - 'the_excerpt', |
|
649 | - array( 'EED_Events_Archive', 'event_tickets' ), |
|
650 | - EED_Events_Archive::EVENT_TICKETS_PRIORITY |
|
651 | - ); |
|
648 | + 'the_excerpt', |
|
649 | + array( 'EED_Events_Archive', 'event_tickets' ), |
|
650 | + EED_Events_Archive::EVENT_TICKETS_PRIORITY |
|
651 | + ); |
|
652 | 652 | remove_filter( |
653 | - 'the_excerpt', |
|
654 | - array( 'EED_Events_Archive', 'event_venues' ), |
|
655 | - EED_Events_Archive::EVENT_VENUES_PRIORITY |
|
656 | - ); |
|
653 | + 'the_excerpt', |
|
654 | + array( 'EED_Events_Archive', 'event_venues' ), |
|
655 | + EED_Events_Archive::EVENT_VENUES_PRIORITY |
|
656 | + ); |
|
657 | 657 | remove_filter( |
658 | - 'the_content', |
|
659 | - array( 'EED_Events_Archive', 'event_datetimes' ), |
|
660 | - EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
|
661 | - ); |
|
658 | + 'the_content', |
|
659 | + array( 'EED_Events_Archive', 'event_datetimes' ), |
|
660 | + EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
|
661 | + ); |
|
662 | 662 | remove_filter( |
663 | - 'the_content', |
|
664 | - array( 'EED_Events_Archive', 'event_tickets' ), |
|
665 | - EED_Events_Archive::EVENT_TICKETS_PRIORITY |
|
666 | - ); |
|
663 | + 'the_content', |
|
664 | + array( 'EED_Events_Archive', 'event_tickets' ), |
|
665 | + EED_Events_Archive::EVENT_TICKETS_PRIORITY |
|
666 | + ); |
|
667 | 667 | remove_filter( |
668 | - 'the_content', |
|
669 | - array( 'EED_Events_Archive', 'event_venues' ), |
|
670 | - EED_Events_Archive::EVENT_VENUES_PRIORITY |
|
671 | - ); |
|
668 | + 'the_content', |
|
669 | + array( 'EED_Events_Archive', 'event_venues' ), |
|
670 | + EED_Events_Archive::EVENT_VENUES_PRIORITY |
|
671 | + ); |
|
672 | 672 | } |
673 | 673 | |
674 | 674 | |
@@ -683,50 +683,50 @@ discard block |
||
683 | 683 | //remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 ); |
684 | 684 | remove_filter( 'the_title', array( 'EED_Events_Archive', 'the_title' ), 1 ); |
685 | 685 | remove_filter( |
686 | - 'the_excerpt', |
|
687 | - array( 'EED_Events_Archive', 'event_details' ), |
|
688 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
689 | - ); |
|
686 | + 'the_excerpt', |
|
687 | + array( 'EED_Events_Archive', 'event_details' ), |
|
688 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
689 | + ); |
|
690 | 690 | remove_filter( |
691 | - 'the_excerpt', |
|
692 | - array( 'EED_Events_Archive', 'event_datetimes' ), |
|
693 | - EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
|
694 | - ); |
|
691 | + 'the_excerpt', |
|
692 | + array( 'EED_Events_Archive', 'event_datetimes' ), |
|
693 | + EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
|
694 | + ); |
|
695 | 695 | remove_filter( |
696 | - 'the_excerpt', |
|
697 | - array( 'EED_Events_Archive', 'event_tickets' ), |
|
698 | - EED_Events_Archive::EVENT_TICKETS_PRIORITY |
|
699 | - ); |
|
696 | + 'the_excerpt', |
|
697 | + array( 'EED_Events_Archive', 'event_tickets' ), |
|
698 | + EED_Events_Archive::EVENT_TICKETS_PRIORITY |
|
699 | + ); |
|
700 | 700 | remove_filter( |
701 | - 'the_excerpt', |
|
702 | - array( 'EED_Events_Archive', 'event_venues' ), |
|
703 | - EED_Events_Archive::EVENT_VENUES_PRIORITY |
|
704 | - ); |
|
701 | + 'the_excerpt', |
|
702 | + array( 'EED_Events_Archive', 'event_venues' ), |
|
703 | + EED_Events_Archive::EVENT_VENUES_PRIORITY |
|
704 | + ); |
|
705 | 705 | remove_filter( |
706 | - 'the_content', |
|
707 | - array( 'EED_Events_Archive', 'event_details' ), |
|
708 | - EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
709 | - ); |
|
706 | + 'the_content', |
|
707 | + array( 'EED_Events_Archive', 'event_details' ), |
|
708 | + EED_Events_Archive::EVENT_DETAILS_PRIORITY |
|
709 | + ); |
|
710 | 710 | remove_filter( |
711 | - 'the_content', |
|
712 | - array( 'EED_Events_Archive', 'event_datetimes' ), |
|
713 | - EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
|
714 | - ); |
|
711 | + 'the_content', |
|
712 | + array( 'EED_Events_Archive', 'event_datetimes' ), |
|
713 | + EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
|
714 | + ); |
|
715 | 715 | remove_filter( |
716 | - 'the_content', |
|
717 | - array( 'EED_Events_Archive', 'event_tickets' ), |
|
718 | - EED_Events_Archive::EVENT_TICKETS_PRIORITY |
|
719 | - ); |
|
716 | + 'the_content', |
|
717 | + array( 'EED_Events_Archive', 'event_tickets' ), |
|
718 | + EED_Events_Archive::EVENT_TICKETS_PRIORITY |
|
719 | + ); |
|
720 | 720 | remove_filter( |
721 | - 'the_content', |
|
722 | - array( 'EED_Events_Archive', 'event_venues' ), |
|
723 | - EED_Events_Archive::EVENT_VENUES_PRIORITY |
|
724 | - ); |
|
721 | + 'the_content', |
|
722 | + array( 'EED_Events_Archive', 'event_venues' ), |
|
723 | + EED_Events_Archive::EVENT_VENUES_PRIORITY |
|
724 | + ); |
|
725 | 725 | // don't display entry meta because the existing theme will take care of that |
726 | 726 | remove_filter( |
727 | - 'FHEE__content_espresso_events_details_template__display_entry_meta', |
|
728 | - '__return_false' |
|
729 | - ); |
|
727 | + 'FHEE__content_espresso_events_details_template__display_entry_meta', |
|
728 | + '__return_false' |
|
729 | + ); |
|
730 | 730 | } |
731 | 731 | |
732 | 732 | |
@@ -741,7 +741,7 @@ discard block |
||
741 | 741 | * @return void |
742 | 742 | */ |
743 | 743 | public function load_event_list_assets() { |
744 | - do_action( 'AHEE__EED_Events_Archive__before_load_assets' ); |
|
744 | + do_action( 'AHEE__EED_Events_Archive__before_load_assets' ); |
|
745 | 745 | add_filter( 'FHEE_load_EE_Session', '__return_true' ); |
746 | 746 | add_filter( 'FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true' ); |
747 | 747 | add_action('wp_enqueue_scripts', array( $this, 'wp_enqueue_scripts' ), 10 ); |
@@ -3,7 +3,7 @@ discard block |
||
3 | 3 | use EventEspresso\core\libraries\iframe_display\EventListIframeEmbedButton; |
4 | 4 | use EventEspresso\modules\events_archive\EventsArchiveIframe; |
5 | 5 | |
6 | -defined( 'EVENT_ESPRESSO_VERSION') || exit('No direct script access allowed'); |
|
6 | +defined('EVENT_ESPRESSO_VERSION') || exit('No direct script access allowed'); |
|
7 | 7 | |
8 | 8 | /** |
9 | 9 | * Event List |
@@ -51,7 +51,7 @@ discard block |
||
51 | 51 | * @return EED_Events_Archive |
52 | 52 | */ |
53 | 53 | public static function instance() { |
54 | - return parent::get_instance( __CLASS__ ); |
|
54 | + return parent::get_instance(__CLASS__); |
|
55 | 55 | } |
56 | 56 | |
57 | 57 | |
@@ -80,7 +80,7 @@ discard block |
||
80 | 80 | 'event_list_iframe', |
81 | 81 | 'event_list' |
82 | 82 | ); |
83 | - add_action( 'wp_loaded', array( 'EED_Events_Archive', 'set_definitions' ), 2 ); |
|
83 | + add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2); |
|
84 | 84 | } |
85 | 85 | |
86 | 86 | /** |
@@ -90,12 +90,12 @@ discard block |
||
90 | 90 | * @return void |
91 | 91 | */ |
92 | 92 | public static function set_hooks_admin() { |
93 | - add_action( 'wp_loaded', array( 'EED_Events_Archive', 'set_definitions' ), 2 ); |
|
93 | + add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2); |
|
94 | 94 | // hook into the end of the \EE_Admin_Page::_load_page_dependencies() |
95 | 95 | // to load assets for "espresso_events" page on the "default" route (action) |
96 | 96 | add_action( |
97 | 97 | 'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__default', |
98 | - array( 'EED_Events_Archive', 'event_list_iframe_embed_button' ), |
|
98 | + array('EED_Events_Archive', 'event_list_iframe_embed_button'), |
|
99 | 99 | 10 |
100 | 100 | ); |
101 | 101 | } |
@@ -110,8 +110,8 @@ discard block |
||
110 | 110 | * @return void |
111 | 111 | */ |
112 | 112 | public static function set_definitions() { |
113 | - define( 'EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url( __FILE__ ) . 'assets' . DS ); |
|
114 | - define( 'EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace( '\\', DS, plugin_dir_path( __FILE__ )) . 'templates' . DS ); |
|
113 | + define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__).'assets'.DS); |
|
114 | + define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)).'templates'.DS); |
|
115 | 115 | } |
116 | 116 | |
117 | 117 | |
@@ -119,10 +119,10 @@ discard block |
||
119 | 119 | /** |
120 | 120 | * set up EE_Events_Archive_Config |
121 | 121 | */ |
122 | - protected function set_config(){ |
|
123 | - $this->set_config_section( 'template_settings' ); |
|
124 | - $this->set_config_class( 'EE_Events_Archive_Config' ); |
|
125 | - $this->set_config_name( 'EED_Events_Archive' ); |
|
122 | + protected function set_config() { |
|
123 | + $this->set_config_section('template_settings'); |
|
124 | + $this->set_config_class('EE_Events_Archive_Config'); |
|
125 | + $this->set_config_name('EED_Events_Archive'); |
|
126 | 126 | } |
127 | 127 | |
128 | 128 | |
@@ -131,7 +131,7 @@ discard block |
||
131 | 131 | * @return EventListIframeEmbedButton |
132 | 132 | */ |
133 | 133 | public static function get_iframe_embed_button() { |
134 | - if ( ! self::$_iframe_embed_button instanceof EventListIframeEmbedButton ) { |
|
134 | + if ( ! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) { |
|
135 | 135 | self::$_iframe_embed_button = new EventListIframeEmbedButton(); |
136 | 136 | } |
137 | 137 | return self::$_iframe_embed_button; |
@@ -157,35 +157,35 @@ discard block |
||
157 | 157 | * @param \EE_Events_Archive_Config $config |
158 | 158 | * @return \EE_Template_Part_Manager |
159 | 159 | */ |
160 | - public function initialize_template_parts( EE_Events_Archive_Config $config = null ) { |
|
160 | + public function initialize_template_parts(EE_Events_Archive_Config $config = null) { |
|
161 | 161 | $config = $config instanceof EE_Events_Archive_Config ? $config : $this->config(); |
162 | 162 | EEH_Autoloader::instance()->register_template_part_autoloaders(); |
163 | 163 | $template_parts = new EE_Template_Part_Manager(); |
164 | 164 | $template_parts->add_template_part( |
165 | 165 | 'tickets', |
166 | - __( 'Ticket Selector', 'event_espresso' ), |
|
166 | + __('Ticket Selector', 'event_espresso'), |
|
167 | 167 | 'content-espresso_events-tickets.php', |
168 | 168 | $config->display_order_tickets |
169 | 169 | ); |
170 | 170 | $template_parts->add_template_part( |
171 | 171 | 'datetimes', |
172 | - __( 'Dates and Times', 'event_espresso' ), |
|
172 | + __('Dates and Times', 'event_espresso'), |
|
173 | 173 | 'content-espresso_events-datetimes.php', |
174 | 174 | $config->display_order_datetimes |
175 | 175 | ); |
176 | 176 | $template_parts->add_template_part( |
177 | 177 | 'event', |
178 | - __( 'Event Description', 'event_espresso' ), |
|
178 | + __('Event Description', 'event_espresso'), |
|
179 | 179 | 'content-espresso_events-details.php', |
180 | 180 | $config->display_order_event |
181 | 181 | ); |
182 | 182 | $template_parts->add_template_part( |
183 | 183 | 'venue', |
184 | - __( 'Venue Information', 'event_espresso' ), |
|
184 | + __('Venue Information', 'event_espresso'), |
|
185 | 185 | 'content-espresso_events-venues.php', |
186 | 186 | $config->display_order_venue |
187 | 187 | ); |
188 | - do_action( 'AHEE__EED_Event_Archive__initialize_template_parts', $template_parts ); |
|
188 | + do_action('AHEE__EED_Event_Archive__initialize_template_parts', $template_parts); |
|
189 | 189 | return $template_parts; |
190 | 190 | } |
191 | 191 | |
@@ -198,8 +198,8 @@ discard block |
||
198 | 198 | * @param WP $WP |
199 | 199 | * @return void |
200 | 200 | */ |
201 | - public function run( $WP ) { |
|
202 | - do_action( 'AHEE__EED_Events_Archive__before_run' ); |
|
201 | + public function run($WP) { |
|
202 | + do_action('AHEE__EED_Events_Archive__before_run'); |
|
203 | 203 | // ensure valid EE_Events_Archive_Config() object exists |
204 | 204 | $this->set_config(); |
205 | 205 | /** @type EE_Events_Archive_Config $config */ |
@@ -211,14 +211,14 @@ discard block |
||
211 | 211 | EEH_Event_Query::add_query_filters(); |
212 | 212 | // set params that will get used by the filters |
213 | 213 | EEH_Event_Query::set_query_params( |
214 | - '', // month |
|
215 | - '', // category |
|
216 | - $config->display_expired_events, // show_expired |
|
217 | - 'start_date', // orderby |
|
214 | + '', // month |
|
215 | + '', // category |
|
216 | + $config->display_expired_events, // show_expired |
|
217 | + 'start_date', // orderby |
|
218 | 218 | 'ASC' // sort |
219 | 219 | ); |
220 | 220 | // check what template is loaded |
221 | - add_filter( 'template_include', array( $this, 'template_include' ), 999, 1 ); |
|
221 | + add_filter('template_include', array($this, 'template_include'), 999, 1); |
|
222 | 222 | } |
223 | 223 | |
224 | 224 | |
@@ -245,7 +245,7 @@ discard block |
||
245 | 245 | */ |
246 | 246 | public function event_list_iframe() { |
247 | 247 | \EED_Events_Archive::$iframe = true; |
248 | - $event_list_iframe = new EventsArchiveIframe( $this ); |
|
248 | + $event_list_iframe = new EventsArchiveIframe($this); |
|
249 | 249 | $event_list_iframe->display(); |
250 | 250 | } |
251 | 251 | |
@@ -283,42 +283,42 @@ discard block |
||
283 | 283 | * @param string $template |
284 | 284 | * @return string |
285 | 285 | */ |
286 | - public function template_include( $template = '' ) { |
|
286 | + public function template_include($template = '') { |
|
287 | 287 | // don't add content filter for dedicated EE child themes or private posts |
288 | - if ( ! EEH_Template::is_espresso_theme() ) { |
|
288 | + if ( ! EEH_Template::is_espresso_theme()) { |
|
289 | 289 | /** @type EE_Events_Archive_Config $config */ |
290 | 290 | $config = $this->config(); |
291 | 291 | // add status banner ? |
292 | - if ( $config->display_status_banner ) { |
|
293 | - add_filter( 'the_title', array( 'EED_Events_Archive', 'the_title' ), 100, 2 ); |
|
292 | + if ($config->display_status_banner) { |
|
293 | + add_filter('the_title', array('EED_Events_Archive', 'the_title'), 100, 2); |
|
294 | 294 | } |
295 | 295 | // if NOT a custom template |
296 | 296 | if ( |
297 | 297 | apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false) |
298 | 298 | || EE_Registry::instance() |
299 | - ->load_core( 'Front_Controller' ) |
|
299 | + ->load_core('Front_Controller') |
|
300 | 300 | ->get_selected_template() !== 'archive-espresso_events.php' |
301 | 301 | ) { |
302 | 302 | // don't display entry meta because the existing theme will take care of that |
303 | - add_filter( 'FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true' ); |
|
303 | + add_filter('FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true'); |
|
304 | 304 | // load functions.php file for the theme (loaded by WP if using child theme) |
305 | 305 | EEH_Template::load_espresso_theme_functions(); |
306 | 306 | // because we don't know if the theme is using the_excerpt() |
307 | 307 | add_filter( |
308 | 308 | 'the_excerpt', |
309 | - array( 'EED_Events_Archive', 'event_details' ), |
|
309 | + array('EED_Events_Archive', 'event_details'), |
|
310 | 310 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
311 | 311 | ); |
312 | 312 | // or the_content |
313 | 313 | add_filter( |
314 | 314 | 'the_content', |
315 | - array( 'EED_Events_Archive', 'event_details' ), |
|
315 | + array('EED_Events_Archive', 'event_details'), |
|
316 | 316 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
317 | 317 | ); |
318 | 318 | // and just in case they are running get_the_excerpt() which DESTROYS things |
319 | - add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 ); |
|
319 | + add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1); |
|
320 | 320 | // don't display entry meta because the existing theme will take care of that |
321 | - add_filter( 'FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false' ); |
|
321 | + add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false'); |
|
322 | 322 | } |
323 | 323 | } |
324 | 324 | return $template; |
@@ -333,25 +333,25 @@ discard block |
||
333 | 333 | * @param string $excerpt |
334 | 334 | * @return string |
335 | 335 | */ |
336 | - public static function get_the_excerpt( $excerpt = '' ) { |
|
337 | - if ( post_password_required() ) { |
|
336 | + public static function get_the_excerpt($excerpt = '') { |
|
337 | + if (post_password_required()) { |
|
338 | 338 | return $excerpt; |
339 | 339 | } |
340 | - if ( apply_filters( 'FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false ) ) { |
|
340 | + if (apply_filters('FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false)) { |
|
341 | 341 | remove_filter( |
342 | 342 | 'the_excerpt', |
343 | - array( 'EED_Events_Archive', 'event_details' ), |
|
343 | + array('EED_Events_Archive', 'event_details'), |
|
344 | 344 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
345 | 345 | ); |
346 | 346 | remove_filter( |
347 | 347 | 'the_content', |
348 | - array( 'EED_Events_Archive', 'event_details' ), |
|
348 | + array('EED_Events_Archive', 'event_details'), |
|
349 | 349 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
350 | 350 | ); |
351 | - $excerpt = EED_Events_Archive::event_details( $excerpt ); |
|
351 | + $excerpt = EED_Events_Archive::event_details($excerpt); |
|
352 | 352 | } else { |
353 | 353 | EED_Events_Archive::$using_get_the_excerpt = true; |
354 | - add_filter( 'wp_trim_excerpt', array( 'EED_Events_Archive', 'end_get_the_excerpt' ), 999, 1 ); |
|
354 | + add_filter('wp_trim_excerpt', array('EED_Events_Archive', 'end_get_the_excerpt'), 999, 1); |
|
355 | 355 | } |
356 | 356 | return $excerpt; |
357 | 357 | } |
@@ -365,7 +365,7 @@ discard block |
||
365 | 365 | * @param string $text |
366 | 366 | * @return string |
367 | 367 | */ |
368 | - public static function end_get_the_excerpt( $text = '' ) { |
|
368 | + public static function end_get_the_excerpt($text = '') { |
|
369 | 369 | EED_Events_Archive::$using_get_the_excerpt = false; |
370 | 370 | return $text; |
371 | 371 | } |
@@ -380,10 +380,10 @@ discard block |
||
380 | 380 | * @param string $id |
381 | 381 | * @return string |
382 | 382 | */ |
383 | - public static function the_title( $title = '', $id = '' ) { |
|
383 | + public static function the_title($title = '', $id = '') { |
|
384 | 384 | global $post; |
385 | - if ( $post instanceof WP_Post ) { |
|
386 | - return in_the_loop() && $post->ID == $id ? espresso_event_status_banner( $post->ID ) . $title : $title; |
|
385 | + if ($post instanceof WP_Post) { |
|
386 | + return in_the_loop() && $post->ID == $id ? espresso_event_status_banner($post->ID).$title : $title; |
|
387 | 387 | } |
388 | 388 | return $title; |
389 | 389 | } |
@@ -397,7 +397,7 @@ discard block |
||
397 | 397 | * @param string $content |
398 | 398 | * @return string |
399 | 399 | */ |
400 | - public static function event_details( $content ) { |
|
400 | + public static function event_details($content) { |
|
401 | 401 | global $post; |
402 | 402 | static $current_post_ID = 0; |
403 | 403 | if ( |
@@ -406,8 +406,8 @@ discard block |
||
406 | 406 | && ! EED_Events_Archive::$using_get_the_excerpt |
407 | 407 | && ! post_password_required() |
408 | 408 | && ( |
409 | - apply_filters( 'FHEE__EES_Espresso_Events__process_shortcode__true', false ) |
|
410 | - || ! apply_filters( 'FHEE__content_espresso_events__template_loaded', false ) |
|
409 | + apply_filters('FHEE__EES_Espresso_Events__process_shortcode__true', false) |
|
410 | + || ! apply_filters('FHEE__content_espresso_events__template_loaded', false) |
|
411 | 411 | ) |
412 | 412 | ) { |
413 | 413 | // Set current post ID to prevent showing content twice, but only if headers have definitely been sent. |
@@ -416,8 +416,8 @@ discard block |
||
416 | 416 | // We want to allow those plugins to still do their thing and have access to our content, but depending on |
417 | 417 | // how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice, |
418 | 418 | // so the following allows this filter to be applied multiple times, but only once for real |
419 | - $current_post_ID = did_action( 'loop_start' ) ? $post->ID : 0; |
|
420 | - if ( EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order ) { |
|
419 | + $current_post_ID = did_action('loop_start') ? $post->ID : 0; |
|
420 | + if (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order) { |
|
421 | 421 | $content = \EED_Events_Archive::use_sortable_display_order(); |
422 | 422 | } else { |
423 | 423 | $content = \EED_Events_Archive::use_filterable_display_order(); |
@@ -436,36 +436,36 @@ discard block |
||
436 | 436 | */ |
437 | 437 | protected static function use_sortable_display_order() { |
438 | 438 | // no further password checks required atm |
439 | - add_filter( 'FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true' ); |
|
439 | + add_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true'); |
|
440 | 440 | // we need to first remove this callback from being applied to the_content() or the_excerpt() |
441 | 441 | // (otherwise it will recurse and blow up the interweb) |
442 | 442 | remove_filter( |
443 | 443 | 'the_excerpt', |
444 | - array( 'EED_Events_Archive', 'event_details' ), |
|
444 | + array('EED_Events_Archive', 'event_details'), |
|
445 | 445 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
446 | 446 | ); |
447 | 447 | remove_filter( |
448 | 448 | 'the_content', |
449 | - array( 'EED_Events_Archive', 'event_details' ), |
|
449 | + array('EED_Events_Archive', 'event_details'), |
|
450 | 450 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
451 | 451 | ); |
452 | - remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 ); |
|
452 | + remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1); |
|
453 | 453 | // now add additional content depending on whether event is using the_excerpt() or the_content() |
454 | 454 | EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts(); |
455 | - $content = EEH_Template::locate_template( 'content-espresso_events-details.php' ); |
|
456 | - $content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters( $content ); |
|
455 | + $content = EEH_Template::locate_template('content-espresso_events-details.php'); |
|
456 | + $content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters($content); |
|
457 | 457 | // re-add our main filters (or else the next event won't have them) |
458 | 458 | add_filter( |
459 | 459 | 'the_excerpt', |
460 | - array( 'EED_Events_Archive', 'event_details' ), |
|
460 | + array('EED_Events_Archive', 'event_details'), |
|
461 | 461 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
462 | 462 | ); |
463 | 463 | add_filter( |
464 | 464 | 'the_content', |
465 | - array( 'EED_Events_Archive', 'event_details' ), |
|
465 | + array('EED_Events_Archive', 'event_details'), |
|
466 | 466 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
467 | 467 | ); |
468 | - add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 ); |
|
468 | + add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1); |
|
469 | 469 | remove_filter( |
470 | 470 | 'FHEE__EED_Events_Archive__event_details__no_post_password_required', |
471 | 471 | '__return_true' |
@@ -486,36 +486,36 @@ discard block |
||
486 | 486 | // (otherwise it will recurse and blow up the interweb) |
487 | 487 | remove_filter( |
488 | 488 | 'the_excerpt', |
489 | - array( 'EED_Events_Archive', 'event_details' ), |
|
489 | + array('EED_Events_Archive', 'event_details'), |
|
490 | 490 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
491 | 491 | ); |
492 | 492 | remove_filter( |
493 | 493 | 'the_content', |
494 | - array( 'EED_Events_Archive', 'event_details' ), |
|
494 | + array('EED_Events_Archive', 'event_details'), |
|
495 | 495 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
496 | 496 | ); |
497 | - remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 ); |
|
497 | + remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1); |
|
498 | 498 | //now add additional content depending on whether event is using the_excerpt() or the_content() |
499 | 499 | EED_Events_Archive::_add_additional_excerpt_filters(); |
500 | 500 | EED_Events_Archive::_add_additional_content_filters(); |
501 | - do_action( 'AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters' ); |
|
501 | + do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters'); |
|
502 | 502 | // now load our template |
503 | - $content = EEH_Template::locate_template( 'content-espresso_events-details.php' ); |
|
503 | + $content = EEH_Template::locate_template('content-espresso_events-details.php'); |
|
504 | 504 | // re-add our main filters (or else the next event won't have them) |
505 | 505 | add_filter( |
506 | 506 | 'the_excerpt', |
507 | - array( 'EED_Events_Archive', 'event_details' ), |
|
507 | + array('EED_Events_Archive', 'event_details'), |
|
508 | 508 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
509 | 509 | ); |
510 | 510 | add_filter( |
511 | 511 | 'the_content', |
512 | - array( 'EED_Events_Archive', 'event_details' ), |
|
512 | + array('EED_Events_Archive', 'event_details'), |
|
513 | 513 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
514 | 514 | ); |
515 | - add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 ); |
|
515 | + add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1); |
|
516 | 516 | // but remove the other filters so that they don't get applied to the next post |
517 | 517 | EED_Events_Archive::_remove_additional_events_archive_filters(); |
518 | - do_action( 'AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters' ); |
|
518 | + do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters'); |
|
519 | 519 | // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt) |
520 | 520 | //return ! empty( $template ) ? $template : $content; |
521 | 521 | return $content; |
@@ -530,11 +530,11 @@ discard block |
||
530 | 530 | * @param string $content |
531 | 531 | * @return string |
532 | 532 | */ |
533 | - public static function event_datetimes( $content ) { |
|
534 | - if ( post_password_required() ) { |
|
533 | + public static function event_datetimes($content) { |
|
534 | + if (post_password_required()) { |
|
535 | 535 | return $content; |
536 | 536 | } |
537 | - return EEH_Template::locate_template( 'content-espresso_events-datetimes.php' ) . $content; |
|
537 | + return EEH_Template::locate_template('content-espresso_events-datetimes.php').$content; |
|
538 | 538 | } |
539 | 539 | |
540 | 540 | /** |
@@ -544,11 +544,11 @@ discard block |
||
544 | 544 | * @param string $content |
545 | 545 | * @return string |
546 | 546 | */ |
547 | - public static function event_tickets( $content ) { |
|
548 | - if ( post_password_required() ) { |
|
547 | + public static function event_tickets($content) { |
|
548 | + if (post_password_required()) { |
|
549 | 549 | return $content; |
550 | 550 | } |
551 | - return EEH_Template::locate_template( 'content-espresso_events-tickets.php' ) . $content; |
|
551 | + return EEH_Template::locate_template('content-espresso_events-tickets.php').$content; |
|
552 | 552 | } |
553 | 553 | |
554 | 554 | |
@@ -560,8 +560,8 @@ discard block |
||
560 | 560 | * @param string $content |
561 | 561 | * @return string |
562 | 562 | */ |
563 | - public static function event_venue( $content ) { |
|
564 | - return EED_Events_Archive::event_venues( $content ); |
|
563 | + public static function event_venue($content) { |
|
564 | + return EED_Events_Archive::event_venues($content); |
|
565 | 565 | } |
566 | 566 | |
567 | 567 | /** |
@@ -571,11 +571,11 @@ discard block |
||
571 | 571 | * @param string $content |
572 | 572 | * @return string |
573 | 573 | */ |
574 | - public static function event_venues( $content ) { |
|
575 | - if ( post_password_required() ) { |
|
574 | + public static function event_venues($content) { |
|
575 | + if (post_password_required()) { |
|
576 | 576 | return $content; |
577 | 577 | } |
578 | - return $content . EEH_Template::locate_template( 'content-espresso_events-venues.php' ); |
|
578 | + return $content.EEH_Template::locate_template('content-espresso_events-venues.php'); |
|
579 | 579 | } |
580 | 580 | |
581 | 581 | |
@@ -589,17 +589,17 @@ discard block |
||
589 | 589 | private static function _add_additional_excerpt_filters() { |
590 | 590 | add_filter( |
591 | 591 | 'the_excerpt', |
592 | - array( 'EED_Events_Archive', 'event_datetimes' ), |
|
592 | + array('EED_Events_Archive', 'event_datetimes'), |
|
593 | 593 | EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
594 | 594 | ); |
595 | 595 | add_filter( |
596 | 596 | 'the_excerpt', |
597 | - array( 'EED_Events_Archive', 'event_tickets' ), |
|
597 | + array('EED_Events_Archive', 'event_tickets'), |
|
598 | 598 | EED_Events_Archive::EVENT_TICKETS_PRIORITY |
599 | 599 | ); |
600 | 600 | add_filter( |
601 | 601 | 'the_excerpt', |
602 | - array( 'EED_Events_Archive', 'event_venues' ), |
|
602 | + array('EED_Events_Archive', 'event_venues'), |
|
603 | 603 | EED_Events_Archive::EVENT_VENUES_PRIORITY |
604 | 604 | ); |
605 | 605 | } |
@@ -615,17 +615,17 @@ discard block |
||
615 | 615 | private static function _add_additional_content_filters() { |
616 | 616 | add_filter( |
617 | 617 | 'the_content', |
618 | - array( 'EED_Events_Archive', 'event_datetimes' ), |
|
618 | + array('EED_Events_Archive', 'event_datetimes'), |
|
619 | 619 | EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
620 | 620 | ); |
621 | 621 | add_filter( |
622 | 622 | 'the_content', |
623 | - array( 'EED_Events_Archive', 'event_tickets' ), |
|
623 | + array('EED_Events_Archive', 'event_tickets'), |
|
624 | 624 | EED_Events_Archive::EVENT_TICKETS_PRIORITY |
625 | 625 | ); |
626 | 626 | add_filter( |
627 | 627 | 'the_content', |
628 | - array( 'EED_Events_Archive', 'event_venues' ), |
|
628 | + array('EED_Events_Archive', 'event_venues'), |
|
629 | 629 | EED_Events_Archive::EVENT_VENUES_PRIORITY |
630 | 630 | ); |
631 | 631 | } |
@@ -641,32 +641,32 @@ discard block |
||
641 | 641 | private static function _remove_additional_events_archive_filters() { |
642 | 642 | remove_filter( |
643 | 643 | 'the_excerpt', |
644 | - array( 'EED_Events_Archive', 'event_datetimes' ), |
|
644 | + array('EED_Events_Archive', 'event_datetimes'), |
|
645 | 645 | EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
646 | 646 | ); |
647 | 647 | remove_filter( |
648 | 648 | 'the_excerpt', |
649 | - array( 'EED_Events_Archive', 'event_tickets' ), |
|
649 | + array('EED_Events_Archive', 'event_tickets'), |
|
650 | 650 | EED_Events_Archive::EVENT_TICKETS_PRIORITY |
651 | 651 | ); |
652 | 652 | remove_filter( |
653 | 653 | 'the_excerpt', |
654 | - array( 'EED_Events_Archive', 'event_venues' ), |
|
654 | + array('EED_Events_Archive', 'event_venues'), |
|
655 | 655 | EED_Events_Archive::EVENT_VENUES_PRIORITY |
656 | 656 | ); |
657 | 657 | remove_filter( |
658 | 658 | 'the_content', |
659 | - array( 'EED_Events_Archive', 'event_datetimes' ), |
|
659 | + array('EED_Events_Archive', 'event_datetimes'), |
|
660 | 660 | EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
661 | 661 | ); |
662 | 662 | remove_filter( |
663 | 663 | 'the_content', |
664 | - array( 'EED_Events_Archive', 'event_tickets' ), |
|
664 | + array('EED_Events_Archive', 'event_tickets'), |
|
665 | 665 | EED_Events_Archive::EVENT_TICKETS_PRIORITY |
666 | 666 | ); |
667 | 667 | remove_filter( |
668 | 668 | 'the_content', |
669 | - array( 'EED_Events_Archive', 'event_venues' ), |
|
669 | + array('EED_Events_Archive', 'event_venues'), |
|
670 | 670 | EED_Events_Archive::EVENT_VENUES_PRIORITY |
671 | 671 | ); |
672 | 672 | } |
@@ -681,45 +681,45 @@ discard block |
||
681 | 681 | */ |
682 | 682 | public static function remove_all_events_archive_filters() { |
683 | 683 | //remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 ); |
684 | - remove_filter( 'the_title', array( 'EED_Events_Archive', 'the_title' ), 1 ); |
|
684 | + remove_filter('the_title', array('EED_Events_Archive', 'the_title'), 1); |
|
685 | 685 | remove_filter( |
686 | 686 | 'the_excerpt', |
687 | - array( 'EED_Events_Archive', 'event_details' ), |
|
687 | + array('EED_Events_Archive', 'event_details'), |
|
688 | 688 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
689 | 689 | ); |
690 | 690 | remove_filter( |
691 | 691 | 'the_excerpt', |
692 | - array( 'EED_Events_Archive', 'event_datetimes' ), |
|
692 | + array('EED_Events_Archive', 'event_datetimes'), |
|
693 | 693 | EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
694 | 694 | ); |
695 | 695 | remove_filter( |
696 | 696 | 'the_excerpt', |
697 | - array( 'EED_Events_Archive', 'event_tickets' ), |
|
697 | + array('EED_Events_Archive', 'event_tickets'), |
|
698 | 698 | EED_Events_Archive::EVENT_TICKETS_PRIORITY |
699 | 699 | ); |
700 | 700 | remove_filter( |
701 | 701 | 'the_excerpt', |
702 | - array( 'EED_Events_Archive', 'event_venues' ), |
|
702 | + array('EED_Events_Archive', 'event_venues'), |
|
703 | 703 | EED_Events_Archive::EVENT_VENUES_PRIORITY |
704 | 704 | ); |
705 | 705 | remove_filter( |
706 | 706 | 'the_content', |
707 | - array( 'EED_Events_Archive', 'event_details' ), |
|
707 | + array('EED_Events_Archive', 'event_details'), |
|
708 | 708 | EED_Events_Archive::EVENT_DETAILS_PRIORITY |
709 | 709 | ); |
710 | 710 | remove_filter( |
711 | 711 | 'the_content', |
712 | - array( 'EED_Events_Archive', 'event_datetimes' ), |
|
712 | + array('EED_Events_Archive', 'event_datetimes'), |
|
713 | 713 | EED_Events_Archive::EVENT_DATETIMES_PRIORITY |
714 | 714 | ); |
715 | 715 | remove_filter( |
716 | 716 | 'the_content', |
717 | - array( 'EED_Events_Archive', 'event_tickets' ), |
|
717 | + array('EED_Events_Archive', 'event_tickets'), |
|
718 | 718 | EED_Events_Archive::EVENT_TICKETS_PRIORITY |
719 | 719 | ); |
720 | 720 | remove_filter( |
721 | 721 | 'the_content', |
722 | - array( 'EED_Events_Archive', 'event_venues' ), |
|
722 | + array('EED_Events_Archive', 'event_venues'), |
|
723 | 723 | EED_Events_Archive::EVENT_VENUES_PRIORITY |
724 | 724 | ); |
725 | 725 | // don't display entry meta because the existing theme will take care of that |
@@ -741,12 +741,12 @@ discard block |
||
741 | 741 | * @return void |
742 | 742 | */ |
743 | 743 | public function load_event_list_assets() { |
744 | - do_action( 'AHEE__EED_Events_Archive__before_load_assets' ); |
|
745 | - add_filter( 'FHEE_load_EE_Session', '__return_true' ); |
|
746 | - add_filter( 'FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true' ); |
|
747 | - add_action('wp_enqueue_scripts', array( $this, 'wp_enqueue_scripts' ), 10 ); |
|
748 | - if ( EE_Registry::instance()->CFG->map_settings->use_google_maps ) { |
|
749 | - add_action('wp_enqueue_scripts', array( 'EEH_Maps', 'espresso_google_map_js' ), 11 ); |
|
744 | + do_action('AHEE__EED_Events_Archive__before_load_assets'); |
|
745 | + add_filter('FHEE_load_EE_Session', '__return_true'); |
|
746 | + add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true'); |
|
747 | + add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10); |
|
748 | + if (EE_Registry::instance()->CFG->map_settings->use_google_maps) { |
|
749 | + add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11); |
|
750 | 750 | } |
751 | 751 | } |
752 | 752 | |
@@ -763,13 +763,13 @@ discard block |
||
763 | 763 | */ |
764 | 764 | public function wp_enqueue_scripts() { |
765 | 765 | // get some style |
766 | - if ( apply_filters( 'FHEE_enable_default_espresso_css', FALSE ) ) { |
|
766 | + if (apply_filters('FHEE_enable_default_espresso_css', FALSE)) { |
|
767 | 767 | // first check uploads folder |
768 | - if ( EEH_File::is_readable( get_stylesheet_directory() . $this->theme . DS . 'style.css' )) { |
|
769 | - wp_register_style( $this->theme, get_stylesheet_directory_uri() . $this->theme . DS . 'style.css', array( 'dashicons', 'espresso_default' )); |
|
768 | + if (EEH_File::is_readable(get_stylesheet_directory().$this->theme.DS.'style.css')) { |
|
769 | + wp_register_style($this->theme, get_stylesheet_directory_uri().$this->theme.DS.'style.css', array('dashicons', 'espresso_default')); |
|
770 | 770 | } else { |
771 | 771 | } |
772 | - wp_enqueue_style( $this->theme ); |
|
772 | + wp_enqueue_style($this->theme); |
|
773 | 773 | |
774 | 774 | } |
775 | 775 | } |
@@ -787,8 +787,8 @@ discard block |
||
787 | 787 | */ |
788 | 788 | public static function template_settings_form() { |
789 | 789 | $template_settings = EE_Registry::instance()->CFG->template_settings; |
790 | - $template_settings->EED_Events_Archive = isset( $template_settings->EED_Events_Archive ) ? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config(); |
|
791 | - $template_settings->EED_Events_Archive = apply_filters( 'FHEE__EED_Events_Archive__template_settings_form__event_list_config', $template_settings->EED_Events_Archive ); |
|
790 | + $template_settings->EED_Events_Archive = isset($template_settings->EED_Events_Archive) ? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config(); |
|
791 | + $template_settings->EED_Events_Archive = apply_filters('FHEE__EED_Events_Archive__template_settings_form__event_list_config', $template_settings->EED_Events_Archive); |
|
792 | 792 | $events_archive_settings = array( |
793 | 793 | 'display_status_banner' => 0, |
794 | 794 | 'display_description' => 1, |
@@ -797,8 +797,8 @@ discard block |
||
797 | 797 | 'display_venue' => 0, |
798 | 798 | 'display_expired_events' => 0 |
799 | 799 | ); |
800 | - $events_archive_settings = array_merge( $events_archive_settings, (array)$template_settings->EED_Events_Archive ); |
|
801 | - EEH_Template::display_template( EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php', $events_archive_settings ); |
|
800 | + $events_archive_settings = array_merge($events_archive_settings, (array) $template_settings->EED_Events_Archive); |
|
801 | + EEH_Template::display_template(EVENTS_ARCHIVE_TEMPLATES_PATH.'admin-event-list-settings.template.php', $events_archive_settings); |
|
802 | 802 | } |
803 | 803 | |
804 | 804 | |
@@ -814,16 +814,16 @@ discard block |
||
814 | 814 | * @param EE_Request_Handler $REQ |
815 | 815 | * @return EE_Template_Config |
816 | 816 | */ |
817 | - public static function update_template_settings( $CFG, $REQ ) { |
|
817 | + public static function update_template_settings($CFG, $REQ) { |
|
818 | 818 | $CFG->EED_Events_Archive = new EE_Events_Archive_Config(); |
819 | 819 | // unless we are resetting the config... |
820 | - if ( ! isset( $REQ['EED_Events_Archive_reset_event_list_settings'] ) || absint( $REQ['EED_Events_Archive_reset_event_list_settings'] ) !== 1 ) { |
|
821 | - $CFG->EED_Events_Archive->display_status_banner = isset( $REQ['EED_Events_Archive_display_status_banner'] ) ? absint( $REQ['EED_Events_Archive_display_status_banner'] ) : 0; |
|
822 | - $CFG->EED_Events_Archive->display_description = isset( $REQ['EED_Events_Archive_display_description'] ) ? absint( $REQ['EED_Events_Archive_display_description'] ) : 1; |
|
823 | - $CFG->EED_Events_Archive->display_ticket_selector = isset( $REQ['EED_Events_Archive_display_ticket_selector'] ) ? absint( $REQ['EED_Events_Archive_display_ticket_selector'] ) : 0; |
|
824 | - $CFG->EED_Events_Archive->display_datetimes = isset( $REQ['EED_Events_Archive_display_datetimes'] ) ? absint( $REQ['EED_Events_Archive_display_datetimes'] ) : 1; |
|
825 | - $CFG->EED_Events_Archive->display_venue = isset( $REQ['EED_Events_Archive_display_venue'] ) ? absint( $REQ['EED_Events_Archive_display_venue'] ) : 0; |
|
826 | - $CFG->EED_Events_Archive->display_expired_events = isset( $REQ['EED_Events_Archive_display_expired_events'] ) ? absint( $REQ['EED_Events_Archive_display_expired_events'] ) : 0; } |
|
820 | + if ( ! isset($REQ['EED_Events_Archive_reset_event_list_settings']) || absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1) { |
|
821 | + $CFG->EED_Events_Archive->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner']) ? absint($REQ['EED_Events_Archive_display_status_banner']) : 0; |
|
822 | + $CFG->EED_Events_Archive->display_description = isset($REQ['EED_Events_Archive_display_description']) ? absint($REQ['EED_Events_Archive_display_description']) : 1; |
|
823 | + $CFG->EED_Events_Archive->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector']) ? absint($REQ['EED_Events_Archive_display_ticket_selector']) : 0; |
|
824 | + $CFG->EED_Events_Archive->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes']) ? absint($REQ['EED_Events_Archive_display_datetimes']) : 1; |
|
825 | + $CFG->EED_Events_Archive->display_venue = isset($REQ['EED_Events_Archive_display_venue']) ? absint($REQ['EED_Events_Archive_display_venue']) : 0; |
|
826 | + $CFG->EED_Events_Archive->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events']) ? absint($REQ['EED_Events_Archive_display_expired_events']) : 0; } |
|
827 | 827 | return $CFG; |
828 | 828 | } |
829 | 829 | |
@@ -836,10 +836,10 @@ discard block |
||
836 | 836 | * @param string $extra_class |
837 | 837 | * @return string |
838 | 838 | */ |
839 | - public static function event_list_css( $extra_class = '' ) { |
|
840 | - $event_list_css = ! empty( $extra_class ) ? array( $extra_class ) : array(); |
|
839 | + public static function event_list_css($extra_class = '') { |
|
840 | + $event_list_css = ! empty($extra_class) ? array($extra_class) : array(); |
|
841 | 841 | $event_list_css[] = 'espresso-event-list-event'; |
842 | - return implode( ' ', $event_list_css ); |
|
842 | + return implode(' ', $event_list_css); |
|
843 | 843 | } |
844 | 844 | |
845 | 845 | |
@@ -866,9 +866,9 @@ discard block |
||
866 | 866 | * @param $value |
867 | 867 | * @return bool |
868 | 868 | */ |
869 | - public static function display_description( $value ) { |
|
869 | + public static function display_description($value) { |
|
870 | 870 | $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive; |
871 | - $display_description= isset( $config->display_description ) ? $config->display_description : 1; |
|
871 | + $display_description = isset($config->display_description) ? $config->display_description : 1; |
|
872 | 872 | return $display_description === $value ? TRUE : FALSE; |
873 | 873 | } |
874 | 874 | |
@@ -881,7 +881,7 @@ discard block |
||
881 | 881 | */ |
882 | 882 | public static function display_ticket_selector() { |
883 | 883 | $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive; |
884 | - return isset( $config->display_ticket_selector ) && $config->display_ticket_selector ? TRUE : FALSE; |
|
884 | + return isset($config->display_ticket_selector) && $config->display_ticket_selector ? TRUE : FALSE; |
|
885 | 885 | } |
886 | 886 | |
887 | 887 | |
@@ -894,7 +894,7 @@ discard block |
||
894 | 894 | */ |
895 | 895 | public static function display_venue() { |
896 | 896 | $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive; |
897 | - return isset( $config->display_venue ) && $config->display_venue && EEH_Venue_View::venue_name() ? TRUE : FALSE; |
|
897 | + return isset($config->display_venue) && $config->display_venue && EEH_Venue_View::venue_name() ? TRUE : FALSE; |
|
898 | 898 | } |
899 | 899 | |
900 | 900 | |
@@ -906,7 +906,7 @@ discard block |
||
906 | 906 | */ |
907 | 907 | public static function display_datetimes() { |
908 | 908 | $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive; |
909 | - return isset( $config->display_datetimes ) && $config->display_datetimes ? TRUE : FALSE; |
|
909 | + return isset($config->display_datetimes) && $config->display_datetimes ? TRUE : FALSE; |
|
910 | 910 | } |
911 | 911 | |
912 | 912 | |
@@ -921,7 +921,7 @@ discard block |
||
921 | 921 | * @return string |
922 | 922 | */ |
923 | 923 | public static function event_list_title() { |
924 | - return apply_filters( 'FHEE__archive_espresso_events_template__upcoming_events_h1', __( 'Upcoming Events', 'event_espresso' )); |
|
924 | + return apply_filters('FHEE__archive_espresso_events_template__upcoming_events_h1', __('Upcoming Events', 'event_espresso')); |
|
925 | 925 | } |
926 | 926 | |
927 | 927 | |
@@ -930,11 +930,11 @@ discard block |
||
930 | 930 | /** |
931 | 931 | * @since 4.4.0 |
932 | 932 | */ |
933 | - public static function _doing_it_wrong_notice( $function = '' ) { |
|
933 | + public static function _doing_it_wrong_notice($function = '') { |
|
934 | 934 | EE_Error::doing_it_wrong( |
935 | 935 | __FUNCTION__, |
936 | 936 | sprintf( |
937 | - __( 'EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s', 'event_espresso' ), |
|
937 | + __('EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s', 'event_espresso'), |
|
938 | 938 | $function, |
939 | 939 | '<br />', |
940 | 940 | '4.6.0' |
@@ -956,89 +956,89 @@ discard block |
||
956 | 956 | * @deprecated |
957 | 957 | * @since 4.4.0 |
958 | 958 | */ |
959 | - public function posts_fields( $SQL, WP_Query $wp_query ) { |
|
960 | - EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ ); |
|
961 | - return EEH_Event_Query::posts_fields( $SQL, $wp_query ); |
|
959 | + public function posts_fields($SQL, WP_Query $wp_query) { |
|
960 | + EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__); |
|
961 | + return EEH_Event_Query::posts_fields($SQL, $wp_query); |
|
962 | 962 | } |
963 | 963 | /** |
964 | 964 | * @deprecated |
965 | 965 | * @since 4.4.0 |
966 | 966 | */ |
967 | - public static function posts_fields_sql_for_orderby( $orderby_params = array() ) { |
|
968 | - EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ ); |
|
969 | - return EEH_Event_Query::posts_fields_sql_for_orderby( $orderby_params ); |
|
967 | + public static function posts_fields_sql_for_orderby($orderby_params = array()) { |
|
968 | + EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__); |
|
969 | + return EEH_Event_Query::posts_fields_sql_for_orderby($orderby_params); |
|
970 | 970 | } |
971 | 971 | /** |
972 | 972 | * @deprecated |
973 | 973 | * @since 4.4.0 |
974 | 974 | */ |
975 | - public function posts_join( $SQL, WP_Query $wp_query ) { |
|
976 | - EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ ); |
|
977 | - return EEH_Event_Query::posts_join( $SQL, $wp_query ); |
|
975 | + public function posts_join($SQL, WP_Query $wp_query) { |
|
976 | + EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__); |
|
977 | + return EEH_Event_Query::posts_join($SQL, $wp_query); |
|
978 | 978 | } |
979 | 979 | /** |
980 | 980 | * @deprecated |
981 | 981 | * @since 4.4.0 |
982 | 982 | */ |
983 | - public static function posts_join_sql_for_terms( $join_terms = NULL ) { |
|
984 | - EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ ); |
|
985 | - return EEH_Event_Query::posts_join_sql_for_terms( $join_terms ); |
|
983 | + public static function posts_join_sql_for_terms($join_terms = NULL) { |
|
984 | + EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__); |
|
985 | + return EEH_Event_Query::posts_join_sql_for_terms($join_terms); |
|
986 | 986 | } |
987 | 987 | /** |
988 | 988 | * @deprecated |
989 | 989 | * @since 4.4.0 |
990 | 990 | */ |
991 | - public static function posts_join_for_orderby( $orderby_params = array() ) { |
|
992 | - EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ ); |
|
993 | - return EEH_Event_Query::posts_join_for_orderby( $orderby_params ); |
|
991 | + public static function posts_join_for_orderby($orderby_params = array()) { |
|
992 | + EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__); |
|
993 | + return EEH_Event_Query::posts_join_for_orderby($orderby_params); |
|
994 | 994 | } |
995 | 995 | /** |
996 | 996 | * @deprecated |
997 | 997 | * @since 4.4.0 |
998 | 998 | */ |
999 | - public function posts_where( $SQL, WP_Query $wp_query ) { |
|
1000 | - EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ ); |
|
1001 | - return EEH_Event_Query::posts_where( $SQL, $wp_query ); |
|
999 | + public function posts_where($SQL, WP_Query $wp_query) { |
|
1000 | + EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__); |
|
1001 | + return EEH_Event_Query::posts_where($SQL, $wp_query); |
|
1002 | 1002 | } |
1003 | 1003 | /** |
1004 | 1004 | * @deprecated |
1005 | 1005 | * @since 4.4.0 |
1006 | 1006 | */ |
1007 | - public static function posts_where_sql_for_show_expired( $show_expired = FALSE ) { |
|
1008 | - EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ ); |
|
1009 | - return EEH_Event_Query::posts_where_sql_for_show_expired( $show_expired ); |
|
1007 | + public static function posts_where_sql_for_show_expired($show_expired = FALSE) { |
|
1008 | + EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__); |
|
1009 | + return EEH_Event_Query::posts_where_sql_for_show_expired($show_expired); |
|
1010 | 1010 | } |
1011 | 1011 | /** |
1012 | 1012 | * @deprecated |
1013 | 1013 | * @since 4.4.0 |
1014 | 1014 | */ |
1015 | - public static function posts_where_sql_for_event_category_slug( $event_category_slug = NULL ) { |
|
1016 | - EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ ); |
|
1017 | - return EEH_Event_Query::posts_where_sql_for_event_category_slug( $event_category_slug ); |
|
1015 | + public static function posts_where_sql_for_event_category_slug($event_category_slug = NULL) { |
|
1016 | + EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__); |
|
1017 | + return EEH_Event_Query::posts_where_sql_for_event_category_slug($event_category_slug); |
|
1018 | 1018 | } |
1019 | 1019 | /** |
1020 | 1020 | * @deprecated |
1021 | 1021 | * @since 4.4.0 |
1022 | 1022 | */ |
1023 | - public static function posts_where_sql_for_event_list_month( $month = NULL ) { |
|
1024 | - EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ ); |
|
1025 | - return EEH_Event_Query::posts_where_sql_for_event_list_month( $month ); |
|
1023 | + public static function posts_where_sql_for_event_list_month($month = NULL) { |
|
1024 | + EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__); |
|
1025 | + return EEH_Event_Query::posts_where_sql_for_event_list_month($month); |
|
1026 | 1026 | } |
1027 | 1027 | /** |
1028 | 1028 | * @deprecated |
1029 | 1029 | * @since 4.4.0 |
1030 | 1030 | */ |
1031 | - public function posts_orderby( $SQL, WP_Query $wp_query ) { |
|
1032 | - EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ ); |
|
1033 | - return EEH_Event_Query::posts_orderby( $SQL, $wp_query ); |
|
1031 | + public function posts_orderby($SQL, WP_Query $wp_query) { |
|
1032 | + EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__); |
|
1033 | + return EEH_Event_Query::posts_orderby($SQL, $wp_query); |
|
1034 | 1034 | } |
1035 | 1035 | /** |
1036 | 1036 | * @deprecated |
1037 | 1037 | * @since 4.4.0 |
1038 | 1038 | */ |
1039 | - public static function posts_orderby_sql( $orderby_params = array(), $sort = 'ASC' ) { |
|
1040 | - EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ ); |
|
1041 | - return EEH_Event_Query::posts_orderby_sql( $orderby_params, $sort ); |
|
1039 | + public static function posts_orderby_sql($orderby_params = array(), $sort = 'ASC') { |
|
1040 | + EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__); |
|
1041 | + return EEH_Event_Query::posts_orderby_sql($orderby_params, $sort); |
|
1042 | 1042 | } |
1043 | 1043 | |
1044 | 1044 | |
@@ -1069,8 +1069,8 @@ discard block |
||
1069 | 1069 | * @param string $extra_class |
1070 | 1070 | * @return string |
1071 | 1071 | */ |
1072 | -function espresso_event_list_css( $extra_class = '' ) { |
|
1073 | - return EED_Events_Archive::event_list_css( $extra_class ); |
|
1072 | +function espresso_event_list_css($extra_class = '') { |
|
1073 | + return EED_Events_Archive::event_list_css($extra_class); |
|
1074 | 1074 | } |
1075 | 1075 | |
1076 | 1076 | /** |
@@ -1084,14 +1084,14 @@ discard block |
||
1084 | 1084 | * @return bool |
1085 | 1085 | */ |
1086 | 1086 | function espresso_display_full_description_in_event_list() { |
1087 | - return EED_Events_Archive::display_description( 2 ); |
|
1087 | + return EED_Events_Archive::display_description(2); |
|
1088 | 1088 | } |
1089 | 1089 | |
1090 | 1090 | /** |
1091 | 1091 | * @return bool |
1092 | 1092 | */ |
1093 | 1093 | function espresso_display_excerpt_in_event_list() { |
1094 | - return EED_Events_Archive::display_description( 1 ); |
|
1094 | + return EED_Events_Archive::display_description(1); |
|
1095 | 1095 | } |
1096 | 1096 | |
1097 | 1097 | /** |
@@ -1,5 +1,5 @@ discard block |
||
1 | 1 | <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
2 | - exit('No direct script access allowed'); |
|
2 | + exit('No direct script access allowed'); |
|
3 | 3 | } |
4 | 4 | |
5 | 5 | |
@@ -14,604 +14,604 @@ discard block |
||
14 | 14 | class EE_Register_CPTs |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * This property is used to hold an array of EE_default_term objects assigned to a custom post type when the post |
|
19 | - * for that post type is published with no terms set for the taxonomy. |
|
20 | - * |
|
21 | - * @var array of EE_Default_Term objects |
|
22 | - */ |
|
23 | - protected $_default_terms = array(); |
|
24 | - |
|
25 | - |
|
26 | - |
|
27 | - /** |
|
28 | - * constructor |
|
29 | - * instantiated at init priority 5 |
|
30 | - */ |
|
31 | - public function __construct() |
|
32 | - { |
|
33 | - // register taxonomies |
|
34 | - $taxonomies = self::get_taxonomies(); |
|
35 | - foreach ($taxonomies as $taxonomy => $tax) { |
|
36 | - $this->register_taxonomy($taxonomy, $tax['singular_name'], $tax['plural_name'], $tax['args']); |
|
37 | - } |
|
38 | - // register CPTs |
|
39 | - $CPTs = self::get_CPTs(); |
|
40 | - foreach ($CPTs as $CPT_name => $CPT) { |
|
41 | - $this->register_CPT($CPT_name, $CPT['singular_name'], $CPT['plural_name'], $CPT['args'], |
|
42 | - $CPT['singular_slug'], $CPT['plural_slug']); |
|
43 | - } |
|
44 | - // setup default terms in any of our taxonomies (but only if we're in admin). |
|
45 | - // Why not added via register_activation_hook? |
|
46 | - // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies |
|
47 | - // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin. |
|
48 | - // Keep in mind that this will READ these terms if they are deleted by the user. Hence MUST use terms. |
|
49 | - // if ( is_admin() ) { |
|
50 | - // $this->set_must_use_event_types(); |
|
51 | - // } |
|
52 | - //set default terms |
|
53 | - $this->set_default_term('espresso_event_type', 'single-event', array('espresso_events')); |
|
54 | - add_action('AHEE__EE_System__initialize_last', array(__CLASS__, 'maybe_flush_rewrite_rules'), 10); |
|
55 | - // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts |
|
56 | - // IF they don't have a term for that taxonomy set. |
|
57 | - add_action('save_post', array($this, 'save_default_term'), 100, 2); |
|
58 | - // remove no html restrictions from core wp saving of term descriptions. |
|
59 | - // Note. this will affect only registered EE taxonomies. |
|
60 | - $this->_allow_html_descriptions_for_ee_taxonomies(); |
|
61 | - do_action('AHEE__EE_Register_CPTs__construct_end', $this); |
|
62 | - } |
|
63 | - |
|
64 | - |
|
65 | - |
|
66 | - /** |
|
67 | - * This will flush rewrite rules on demand. This actually gets called around wp init priority level 100. |
|
68 | - * |
|
69 | - * @since 4.5.0 |
|
70 | - * @return void |
|
71 | - */ |
|
72 | - public static function maybe_flush_rewrite_rules() |
|
73 | - { |
|
74 | - if (get_option('ee_flush_rewrite_rules', true)) { |
|
75 | - flush_rewrite_rules(); |
|
76 | - update_option('ee_flush_rewrite_rules', false); |
|
77 | - } |
|
78 | - } |
|
79 | - |
|
80 | - |
|
81 | - |
|
82 | - /** |
|
83 | - * By default, WordPress strips all html from term taxonomy description content. The purpose of this method is to |
|
84 | - * remove that restriction and ensure that we still run ee term taxonomy descriptions through some full html |
|
85 | - * sanitization equivalent to the post content field. |
|
86 | - * |
|
87 | - * @since 4.7.8 |
|
88 | - */ |
|
89 | - protected function _allow_html_descriptions_for_ee_taxonomies() |
|
90 | - { |
|
91 | - // first remove default filter for term description but we have to do this earlier |
|
92 | - // before wp sets their own filter |
|
93 | - // because they just set a global filter on all term descriptions before the custom term description filter. |
|
94 | - // Really sux. |
|
95 | - add_filter('pre_term_description', array($this, 'ee_filter_ee_term_description_not_wp'), 1, 2); |
|
96 | - } |
|
97 | - |
|
98 | - |
|
99 | - |
|
100 | - /** |
|
101 | - * Callback for pre_term_description hook. |
|
102 | - * |
|
103 | - * @param string $description The description content. |
|
104 | - * @param string $taxonomy The taxonomy name for the taxonomy being filtered. |
|
105 | - * @return string |
|
106 | - */ |
|
107 | - public function ee_filter_ee_term_description_not_wp($description, $taxonomy) |
|
108 | - { |
|
109 | - //get a list of EE taxonomies |
|
110 | - $ee_taxonomies = array_keys(self::get_taxonomies()); |
|
111 | - //only do our own thing if the taxonomy listed is an ee taxonomy. |
|
112 | - if (in_array($taxonomy, $ee_taxonomies, true)) { |
|
113 | - //remove default wp filter |
|
114 | - remove_filter('pre_term_description', 'wp_filter_kses'); |
|
115 | - //sanitize THIS content. |
|
116 | - $description = wp_kses($description, wp_kses_allowed_html('post')); |
|
117 | - } |
|
118 | - return $description; |
|
119 | - } |
|
120 | - |
|
121 | - |
|
122 | - |
|
123 | - /** |
|
124 | - * get_taxonomies |
|
125 | - * |
|
126 | - * @access public |
|
127 | - * @return array |
|
128 | - */ |
|
129 | - public static function get_taxonomies() |
|
130 | - { |
|
131 | - // define taxonomies |
|
132 | - return apply_filters('FHEE__EE_Register_CPTs__get_taxonomies__taxonomies', array( |
|
133 | - 'espresso_event_categories' => array( |
|
134 | - 'singular_name' => __("Event Category", "event_espresso"), |
|
135 | - 'plural_name' => __("Event Categories", "event_espresso"), |
|
136 | - 'args' => array( |
|
137 | - 'public' => true, |
|
138 | - 'show_in_nav_menus' => true, |
|
139 | - 'show_in_rest' => true, |
|
140 | - 'capabilities' => array( |
|
141 | - 'manage_terms' => 'ee_manage_event_categories', |
|
142 | - 'edit_terms' => 'ee_edit_event_category', |
|
143 | - 'delete_terms' => 'ee_delete_event_category', |
|
144 | - 'assign_terms' => 'ee_assign_event_category', |
|
145 | - ), |
|
146 | - 'rewrite' => array('slug' => __('event-category', 'event_espresso')), |
|
147 | - ), |
|
148 | - ), |
|
149 | - 'espresso_venue_categories' => array( |
|
150 | - 'singular_name' => __("Venue Category", "event_espresso"), |
|
151 | - 'plural_name' => __("Venue Categories", "event_espresso"), |
|
152 | - 'args' => array( |
|
153 | - 'public' => true, |
|
154 | - 'show_in_nav_menus' => false, //by default this doesn't show for decaf |
|
155 | - 'show_in_rest' => true, |
|
156 | - 'capabilities' => array( |
|
157 | - 'manage_terms' => 'ee_manage_venue_categories', |
|
158 | - 'edit_terms' => 'ee_edit_venue_category', |
|
159 | - 'delete_terms' => 'ee_delete_venue_category', |
|
160 | - 'assign_terms' => 'ee_assign_venue_category', |
|
161 | - ), |
|
162 | - 'rewrite' => array('slug' => __('venue-category', 'event_espresso')), |
|
163 | - ), |
|
164 | - ), |
|
165 | - 'espresso_event_type' => array( |
|
166 | - 'singular_name' => __("Event Type", "event_espresso"), |
|
167 | - 'plural_name' => __("Event Types", "event_espresso"), |
|
168 | - 'args' => array( |
|
169 | - 'public' => true, |
|
170 | - 'show_ui' => false, |
|
171 | - 'show_in_rest' => true, |
|
172 | - 'capabilities' => array( |
|
173 | - 'manage_terms' => 'ee_read_event_type', |
|
174 | - 'edit_terms' => 'ee_edit_event_type', |
|
175 | - 'delete_terms' => 'ee_delete_event_type', |
|
176 | - 'assign_terms' => 'ee_assign_event_type', |
|
177 | - ), |
|
178 | - 'rewrite' => array('slug' => __('event-type', 'event_espresso')), |
|
179 | - 'hierarchical' => true, |
|
180 | - ), |
|
181 | - ), |
|
182 | - )); |
|
183 | - } |
|
184 | - |
|
185 | - |
|
186 | - |
|
187 | - /** |
|
188 | - * This returns the corresponding model name for cpts registered by EE. |
|
189 | - * |
|
190 | - * @since 4.6.16.rc.000 |
|
191 | - * @param string $post_type_slug If a slug is included, then attempt to retrieve the model name for |
|
192 | - * the given cpt slug. Otherwise if empty, then we'll return all cpt |
|
193 | - * model names for cpts registered in EE. |
|
194 | - * @return array Empty array if no matching model names for the given slug or an array of model |
|
195 | - * names indexed by post type slug. |
|
196 | - */ |
|
197 | - public static function get_cpt_model_names($post_type_slug = '') |
|
198 | - { |
|
199 | - $cpts = self::get_CPTs(); |
|
200 | - //first if slug passed in... |
|
201 | - if ( ! empty($post_type_slug)) { |
|
202 | - //match? |
|
203 | - if ( |
|
204 | - ! isset($cpts[$post_type_slug]) |
|
205 | - || (isset($cpts[$post_type_slug]) && empty($cpts[$post_type_slug]['class_name'])) |
|
206 | - ) { |
|
207 | - return array(); |
|
208 | - } |
|
209 | - //k let's get the model name for this cpt. |
|
210 | - return array($post_type_slug => str_replace('EE', 'EEM', $cpts[$post_type_slug]['class_name'])); |
|
211 | - } |
|
212 | - //if we made it here then we're returning an array of cpt model names indexed by post_type_slug. |
|
213 | - $cpt_models = array(); |
|
214 | - foreach ($cpts as $slug => $args) { |
|
215 | - if ( ! empty($args['class_name'])) { |
|
216 | - $cpt_models[$slug] = str_replace('EE', 'EEM', $args['class_name']); |
|
217 | - } |
|
218 | - } |
|
219 | - return $cpt_models; |
|
220 | - } |
|
221 | - |
|
222 | - |
|
223 | - |
|
224 | - /** |
|
225 | - * This instantiates cpt models related to the cpts registered via EE. |
|
226 | - * |
|
227 | - * @since 4.6.16.rc.000 |
|
228 | - * @param string $post_type_slug If valid slug is provided, then will instantiate the model only for |
|
229 | - * the cpt matching the given slug. Otherwise all cpt models will be |
|
230 | - * instantiated (if possible). |
|
231 | - * @return EEM_CPT_Base[] successful instantiation will return an array of successfully instantiated |
|
232 | - * EEM models indexed by post slug. |
|
233 | - */ |
|
234 | - public static function instantiate_cpt_models($post_type_slug = '') |
|
235 | - { |
|
236 | - $cpt_model_names = self::get_cpt_model_names($post_type_slug); |
|
237 | - $instantiated = array(); |
|
238 | - foreach ($cpt_model_names as $slug => $model_name) { |
|
239 | - $instance = EE_Registry::instance()->load_model(str_replace('EEM_', '', $model_name)); |
|
240 | - if ($instance instanceof EEM_CPT_Base) { |
|
241 | - $instantiated[$slug] = $instance; |
|
242 | - } |
|
243 | - } |
|
244 | - return $instantiated; |
|
245 | - } |
|
246 | - |
|
247 | - |
|
248 | - |
|
249 | - /** |
|
250 | - * get_CPTs |
|
251 | - * |
|
252 | - * @access public |
|
253 | - * @return array |
|
254 | - */ |
|
255 | - public static function get_CPTs() |
|
256 | - { |
|
257 | - // define CPTs |
|
258 | - // NOTE the ['args']['page_templates'] array index is something specific to our CPTs |
|
259 | - // and not part of the WP custom post type api. |
|
260 | - return apply_filters('FHEE__EE_Register_CPTs__get_CPTs__cpts', array( |
|
261 | - 'espresso_events' => array( |
|
262 | - 'singular_name' => __("Event", "event_espresso"), |
|
263 | - 'plural_name' => __("Events", "event_espresso"), |
|
264 | - 'singular_slug' => __("event", "event_espresso"), |
|
265 | - 'plural_slug' => EE_Registry::instance()->CFG->core->event_cpt_slug, |
|
266 | - 'class_name' => 'EE_Event', |
|
267 | - 'args' => array( |
|
268 | - 'public' => true, |
|
269 | - 'show_in_nav_menus' => true, |
|
270 | - 'capability_type' => 'event', |
|
271 | - 'capabilities' => array( |
|
272 | - 'edit_post' => 'ee_edit_event', |
|
273 | - 'read_post' => 'ee_read_event', |
|
274 | - 'delete_post' => 'ee_delete_event', |
|
275 | - 'edit_posts' => 'ee_edit_events', |
|
276 | - 'edit_others_posts' => 'ee_edit_others_events', |
|
277 | - 'publish_posts' => 'ee_publish_events', |
|
278 | - 'read_private_posts' => 'ee_read_private_events', |
|
279 | - 'delete_posts' => 'ee_delete_events', |
|
280 | - 'delete_private_posts' => 'ee_delete_private_events', |
|
281 | - 'delete_published_posts' => 'ee_delete_published_events', |
|
282 | - 'delete_others_posts' => 'ee_delete_others_events', |
|
283 | - 'edit_private_posts' => 'ee_edit_private_events', |
|
284 | - 'edit_published_posts' => 'ee_edit_published_events', |
|
285 | - ), |
|
286 | - 'taxonomies' => array( |
|
287 | - 'espresso_event_categories', |
|
288 | - 'espresso_event_type', |
|
289 | - 'post_tag', |
|
290 | - ), |
|
291 | - 'page_templates' => true, |
|
292 | - ), |
|
293 | - ), |
|
294 | - 'espresso_venues' => array( |
|
295 | - 'singular_name' => __("Venue", "event_espresso"), |
|
296 | - 'plural_name' => __("Venues", "event_espresso"), |
|
297 | - 'singular_slug' => __("venue", "event_espresso"), |
|
298 | - 'plural_slug' => __("venues", "event_espresso"), |
|
299 | - 'class_name' => 'EE_Venue', |
|
300 | - 'args' => array( |
|
301 | - 'public' => true, |
|
302 | - 'show_in_nav_menus' => false, //by default this doesn't show for decaf, |
|
303 | - 'capability_type' => 'venue', |
|
304 | - 'capabilities' => array( |
|
305 | - 'edit_post' => 'ee_edit_venue', |
|
306 | - 'read_post' => 'ee_read_venue', |
|
307 | - 'delete_post' => 'ee_delete_venue', |
|
308 | - 'edit_posts' => 'ee_edit_venues', |
|
309 | - 'edit_others_posts' => 'ee_edit_others_venues', |
|
310 | - 'publish_posts' => 'ee_publish_venues', |
|
311 | - 'read_private_posts' => 'ee_read_private_venues', |
|
312 | - 'delete_posts' => 'ee_delete_venues', |
|
313 | - 'delete_private_posts' => 'ee_delete_private_venues', |
|
314 | - 'delete_published_posts' => 'ee_delete_published_venues', |
|
315 | - 'delete_others_posts' => 'ee_edit_others_venues', |
|
316 | - 'edit_private_posts' => 'ee_edit_private_venues', |
|
317 | - 'edit_published_posts' => 'ee_edit_published_venues', |
|
318 | - ), |
|
319 | - 'taxonomies' => array( |
|
320 | - 'espresso_venue_categories', |
|
321 | - 'post_tag', |
|
322 | - ), |
|
323 | - 'page_templates' => true, |
|
324 | - ), |
|
325 | - ), |
|
326 | - 'espresso_attendees' => array( |
|
327 | - 'singular_name' => __("Contact", "event_espresso"), |
|
328 | - 'plural_name' => __("Contacts", "event_espresso"), |
|
329 | - 'singular_slug' => __("contact", "event_espresso"), |
|
330 | - 'plural_slug' => __("contacts", "event_espresso"), |
|
331 | - 'class_name' => 'EE_Attendee', |
|
332 | - 'args' => array( |
|
333 | - 'public' => false, |
|
334 | - 'publicly_queryable' => false, |
|
335 | - 'hierarchical' => false, |
|
336 | - 'has_archive' => false, |
|
337 | - 'taxonomies' => array('post_tag'), |
|
338 | - 'capability_type' => 'contact', |
|
339 | - 'capabilities' => array( |
|
340 | - 'edit_post' => 'ee_edit_contact', |
|
341 | - 'read_post' => 'ee_read_contact', |
|
342 | - 'delete_post' => 'ee_delete_contact', |
|
343 | - 'edit_posts' => 'ee_edit_contacts', |
|
344 | - 'edit_others_posts' => 'ee_edit_contacts', |
|
345 | - 'publish_posts' => 'ee_edit_contacts', |
|
346 | - 'read_private_posts' => 'ee_edit_contacts', |
|
347 | - 'delete_posts' => 'ee_delete_contacts', |
|
348 | - 'delete_private_posts' => 'ee_delete_contacts', |
|
349 | - 'delete_published_posts' => 'ee_delete_contacts', |
|
350 | - 'delete_others_posts' => 'ee_delete_contacts', |
|
351 | - 'edit_private_posts' => 'ee_edit_contacts', |
|
352 | - 'edit_published_posts' => 'ee_edit_contacts', |
|
353 | - ), |
|
354 | - 'supports' => array('editor', 'thumbnail', 'excerpt', 'custom-fields', 'comments'), |
|
355 | - ), |
|
356 | - ), |
|
357 | - )); |
|
358 | - } |
|
359 | - |
|
360 | - |
|
361 | - |
|
362 | - /** |
|
363 | - * This basically goes through the CPT array and returns only CPT's |
|
364 | - * that have the ['args']['public'] option set as false |
|
365 | - * |
|
366 | - * @return array |
|
367 | - */ |
|
368 | - public static function get_private_CPTs() |
|
369 | - { |
|
370 | - $CPTs = self::get_CPTs(); |
|
371 | - $private_CPTs = array(); |
|
372 | - foreach ($CPTs as $CPT => $details) { |
|
373 | - if (empty($details['args']['public'])) { |
|
374 | - $private_CPTs[$CPT] = $details; |
|
375 | - } |
|
376 | - } |
|
377 | - return $private_CPTs; |
|
378 | - } |
|
379 | - |
|
380 | - |
|
381 | - |
|
382 | - /** |
|
383 | - * Registers a custom taxonomy. Should be called before registering custom post types, |
|
384 | - * otherwise you should link the taxonomy to the custom post type using 'register_taxonomy_for_object_type'. |
|
385 | - * |
|
386 | - * @param string $taxonomy_name , eg 'books' |
|
387 | - * @param string $singular_name internationalized singular name |
|
388 | - * @param string $plural_name internationalized plural name |
|
389 | - * @param array $override_args like $args on http://codex.wordpress.org/Function_Reference/register_taxonomy |
|
390 | - */ |
|
391 | - public function register_taxonomy($taxonomy_name, $singular_name, $plural_name, $override_args = array()) |
|
392 | - { |
|
393 | - $args = array( |
|
394 | - 'hierarchical' => true, |
|
395 | - 'labels' => array( |
|
396 | - 'name' => $plural_name, |
|
397 | - 'singular_name' => $singular_name, |
|
398 | - ), |
|
399 | - 'show_ui' => true, |
|
400 | - 'show_ee_ui' => true, |
|
401 | - 'show_admin_column' => true, |
|
402 | - 'query_var' => true, |
|
403 | - 'show_in_nav_menus' => false, |
|
404 | - 'map_meta_cap' => true |
|
405 | - //'rewrite' => array( 'slug' => 'genre' ), |
|
406 | - ); |
|
407 | - if ($override_args) { |
|
408 | - if (isset($override_args['labels'])) { |
|
409 | - $labels = array_merge($args['labels'], $override_args['labels']); |
|
410 | - $args['labels'] = $labels; |
|
411 | - } |
|
412 | - $args = array_merge($args, $override_args); |
|
413 | - } |
|
414 | - register_taxonomy($taxonomy_name, null, $args); |
|
415 | - } |
|
416 | - |
|
417 | - |
|
418 | - |
|
419 | - /** |
|
420 | - * Registers a new custom post type. Sets default settings given only the following params. |
|
421 | - * |
|
422 | - * @param string $post_type the actual post type name |
|
423 | - * (VERY IMPORTANT: this much match what the slug is for admin pages related to this |
|
424 | - * cpt Also any models must use this slug as well) |
|
425 | - * @param string $singular_name a pre-internationalized string for the singular name of the objects |
|
426 | - * @param string $plural_name a pre-internalized string for the plural name of the objects |
|
427 | - * @param array $override_args exactly like $args as described in |
|
428 | - * http://codex.wordpress.org/Function_Reference/register_post_type The default values |
|
429 | - * set in this function will be overridden by whatever you set in $override_args |
|
430 | - * @param string $singular_slug |
|
431 | - * @param string $plural_slug |
|
432 | - * @return void , but registers the custom post type |
|
433 | - */ |
|
434 | - public function register_CPT( |
|
435 | - $post_type, |
|
436 | - $singular_name, |
|
437 | - $plural_name, |
|
438 | - $override_args = array(), |
|
439 | - $singular_slug = '', |
|
440 | - $plural_slug = '' |
|
441 | - ) { |
|
442 | - $labels = array( |
|
443 | - 'name' => $plural_name, |
|
444 | - 'singular_name' => $singular_name, |
|
445 | - 'singular_slug' => $singular_slug, |
|
446 | - 'plural_slug' => $plural_slug, |
|
447 | - 'add_new' => sprintf(__("Add %s", "event_espresso"), $singular_name), |
|
448 | - 'add_new_item' => sprintf(__("Add New %s", "event_espresso"), $singular_name), |
|
449 | - 'edit_item' => sprintf(__("Edit %s", "event_espresso"), $singular_name), |
|
450 | - 'new_item' => sprintf(__("New %s", "event_espresso"), $singular_name), |
|
451 | - 'all_items' => sprintf(__("All %s", "event_espresso"), $plural_name), |
|
452 | - 'view_item' => sprintf(__("View %s", "event_espresso"), $singular_name), |
|
453 | - 'search_items' => sprintf(__("Search %s", "event_espresso"), $plural_name), |
|
454 | - 'not_found' => sprintf(__("No %s found", "event_espresso"), $plural_name), |
|
455 | - 'not_found_in_trash' => sprintf(__("No %s found in Trash", "event_espresso"), $plural_name), |
|
456 | - 'parent_item_colon' => '', |
|
457 | - 'menu_name' => sprintf(__("%s", "event_espresso"), $plural_name), |
|
458 | - ); |
|
459 | - //verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name |
|
460 | - // $singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name; |
|
461 | - $plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name; |
|
462 | - //note the page_templates arg in the supports index is something specific to EE. |
|
463 | - // WordPress doesn't actually have that in their register_post_type api. |
|
464 | - $args = array( |
|
465 | - 'labels' => $labels, |
|
466 | - 'public' => true, |
|
467 | - 'publicly_queryable' => true, |
|
468 | - 'show_ui' => false, |
|
469 | - 'show_ee_ui' => true, |
|
470 | - 'show_in_menu' => false, |
|
471 | - 'show_in_nav_menus' => false, |
|
472 | - 'query_var' => true, |
|
473 | - 'rewrite' => apply_filters( |
|
474 | - 'FHEE__EE_Register_CPTs__register_CPT__rewrite', |
|
475 | - array('slug' => $plural_slug), |
|
476 | - $post_type |
|
477 | - ), |
|
478 | - 'capability_type' => 'post', |
|
479 | - 'map_meta_cap' => true, |
|
480 | - 'has_archive' => true, |
|
481 | - 'hierarchical' => false, |
|
482 | - 'menu_position' => null, |
|
483 | - 'supports' => array( |
|
484 | - 'title', |
|
485 | - 'editor', |
|
486 | - 'author', |
|
487 | - 'thumbnail', |
|
488 | - 'excerpt', |
|
489 | - 'custom-fields', |
|
490 | - 'comments', |
|
491 | - ), |
|
492 | - ); |
|
493 | - if ($override_args) { |
|
494 | - if (isset($override_args['labels'])) { |
|
495 | - $labels = array_merge($args['labels'], $override_args['labels']); |
|
496 | - } |
|
497 | - $args = array_merge($args, $override_args); |
|
498 | - $args['labels'] = $labels; |
|
499 | - } |
|
500 | - register_post_type($post_type, $args); |
|
501 | - } |
|
502 | - |
|
503 | - |
|
504 | - |
|
505 | - public function set_must_use_event_types() |
|
506 | - { |
|
507 | - $term_details = array( |
|
508 | - //Attendee's register for the first date-time only |
|
509 | - 'single-event' => array( |
|
510 | - __('Single Event', 'event_espresso'), |
|
511 | - __('A single event that spans one or more consecutive days.', 'event_espresso'), |
|
512 | - ), |
|
513 | - //example: a party or two-day long workshop |
|
514 | - //Attendee's can register for any of the date-times |
|
515 | - 'multi-event' => array( |
|
516 | - __('Multi Event', 'event_espresso'), |
|
517 | - __('Multiple, separate, but related events that occur on consecutive days.', 'event_espresso'), |
|
518 | - ), |
|
519 | - //example: a three day music festival or week long conference |
|
520 | - //Attendee's register for the first date-time only |
|
521 | - 'event-series' => array( |
|
522 | - __('Event Series', 'event_espresso'), |
|
523 | - __(' Multiple events that occur over multiple non-consecutive days.', 'event_espresso'), |
|
524 | - ), |
|
525 | - //example: an 8 week introduction to basket weaving course |
|
526 | - //Attendee's can register for any of the date-times. |
|
527 | - 'recurring-event' => array( |
|
528 | - __('Recurring Event', 'event_espresso'), |
|
529 | - __('Multiple events that occur over multiple non-consecutive days.', 'event_espresso'), |
|
530 | - ), |
|
531 | - //example: a yoga class |
|
532 | - 'ongoing' => array( |
|
533 | - __('Ongoing Event', 'event_espresso'), |
|
534 | - __('An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event', |
|
535 | - 'event_espresso'), |
|
536 | - ) |
|
537 | - //example: access to a museum |
|
538 | - //'walk-in' => array( __('Walk In', 'event_espresso'), __('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ), |
|
539 | - //'reservation' => array( __('Reservation', 'event_espresso'), __('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 |
|
540 | - // 'multiple-session' => array( __('Multiple Session', 'event_espresso'), __('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 |
|
541 | - //'appointment' => array( __('Appointments', 'event_espresso'), __('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') ) |
|
542 | - ); |
|
543 | - $this->set_must_use_terms('espresso_event_type', $term_details); |
|
544 | - } |
|
545 | - |
|
546 | - |
|
547 | - |
|
548 | - /** |
|
549 | - * wrapper method for handling the setting up of initial terms in the db (if they don't already exist). |
|
550 | - * Note this should ONLY be used for terms that always must be present. Be aware that if an initial term is |
|
551 | - * deleted then it WILL be recreated. |
|
552 | - * |
|
553 | - * @param string $taxonomy The name of the taxonomy |
|
554 | - * @param array $term_details An array of term details indexed by slug and containing Name of term, and |
|
555 | - * description as the elements in the array |
|
556 | - * @return void |
|
557 | - */ |
|
558 | - public function set_must_use_terms($taxonomy, $term_details) |
|
559 | - { |
|
560 | - $term_details = (array)$term_details; |
|
561 | - foreach ($term_details as $slug => $details) { |
|
562 | - if ( ! term_exists($slug, $taxonomy)) { |
|
563 | - $insert_arr = array( |
|
564 | - 'slug' => $slug, |
|
565 | - 'description' => $details[1], |
|
566 | - ); |
|
567 | - wp_insert_term($details[0], $taxonomy, $insert_arr); |
|
568 | - } |
|
569 | - } |
|
570 | - } |
|
571 | - |
|
572 | - |
|
573 | - |
|
574 | - /** |
|
575 | - * Allows us to set what the default will be for terms when a cpt is PUBLISHED. |
|
576 | - * |
|
577 | - * @param string $taxonomy The taxonomy we're using for the default term |
|
578 | - * @param string $term_slug The slug of the term that will be the default. |
|
579 | - * @param array $cpt_slugs An array of custom post types we want the default assigned to |
|
580 | - */ |
|
581 | - public function set_default_term($taxonomy, $term_slug, $cpt_slugs = array()) |
|
582 | - { |
|
583 | - $this->_default_terms[][$term_slug] = new EE_Default_Term($taxonomy, $term_slug, $cpt_slugs); |
|
584 | - } |
|
585 | - |
|
586 | - |
|
587 | - |
|
588 | - /** |
|
589 | - * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property |
|
590 | - * |
|
591 | - * @param int $post_id ID of CPT being saved |
|
592 | - * @param object $post Post object |
|
593 | - * @return void |
|
594 | - */ |
|
595 | - public function save_default_term($post_id, $post) |
|
596 | - { |
|
597 | - if (empty($this->_default_terms)) { |
|
598 | - return; |
|
599 | - } //no default terms set so lets just exit. |
|
600 | - foreach ($this->_default_terms as $defaults) { |
|
601 | - foreach ($defaults as $default_obj) { |
|
602 | - if ($post->post_status === 'publish' && in_array($post->post_type, $default_obj->cpt_slugs, true)) { |
|
603 | - //note some error proofing going on here to save unnecessary db queries |
|
604 | - $taxonomies = get_object_taxonomies($post->post_type); |
|
605 | - foreach ((array)$taxonomies as $taxonomy) { |
|
606 | - $terms = wp_get_post_terms($post_id, $taxonomy); |
|
607 | - if (empty($terms) && $taxonomy === $default_obj->taxonomy) { |
|
608 | - wp_set_object_terms($post_id, array($default_obj->term_slug), $taxonomy); |
|
609 | - } |
|
610 | - } |
|
611 | - } |
|
612 | - } |
|
613 | - } |
|
614 | - } |
|
17 | + /** |
|
18 | + * This property is used to hold an array of EE_default_term objects assigned to a custom post type when the post |
|
19 | + * for that post type is published with no terms set for the taxonomy. |
|
20 | + * |
|
21 | + * @var array of EE_Default_Term objects |
|
22 | + */ |
|
23 | + protected $_default_terms = array(); |
|
24 | + |
|
25 | + |
|
26 | + |
|
27 | + /** |
|
28 | + * constructor |
|
29 | + * instantiated at init priority 5 |
|
30 | + */ |
|
31 | + public function __construct() |
|
32 | + { |
|
33 | + // register taxonomies |
|
34 | + $taxonomies = self::get_taxonomies(); |
|
35 | + foreach ($taxonomies as $taxonomy => $tax) { |
|
36 | + $this->register_taxonomy($taxonomy, $tax['singular_name'], $tax['plural_name'], $tax['args']); |
|
37 | + } |
|
38 | + // register CPTs |
|
39 | + $CPTs = self::get_CPTs(); |
|
40 | + foreach ($CPTs as $CPT_name => $CPT) { |
|
41 | + $this->register_CPT($CPT_name, $CPT['singular_name'], $CPT['plural_name'], $CPT['args'], |
|
42 | + $CPT['singular_slug'], $CPT['plural_slug']); |
|
43 | + } |
|
44 | + // setup default terms in any of our taxonomies (but only if we're in admin). |
|
45 | + // Why not added via register_activation_hook? |
|
46 | + // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies |
|
47 | + // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin. |
|
48 | + // Keep in mind that this will READ these terms if they are deleted by the user. Hence MUST use terms. |
|
49 | + // if ( is_admin() ) { |
|
50 | + // $this->set_must_use_event_types(); |
|
51 | + // } |
|
52 | + //set default terms |
|
53 | + $this->set_default_term('espresso_event_type', 'single-event', array('espresso_events')); |
|
54 | + add_action('AHEE__EE_System__initialize_last', array(__CLASS__, 'maybe_flush_rewrite_rules'), 10); |
|
55 | + // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts |
|
56 | + // IF they don't have a term for that taxonomy set. |
|
57 | + add_action('save_post', array($this, 'save_default_term'), 100, 2); |
|
58 | + // remove no html restrictions from core wp saving of term descriptions. |
|
59 | + // Note. this will affect only registered EE taxonomies. |
|
60 | + $this->_allow_html_descriptions_for_ee_taxonomies(); |
|
61 | + do_action('AHEE__EE_Register_CPTs__construct_end', $this); |
|
62 | + } |
|
63 | + |
|
64 | + |
|
65 | + |
|
66 | + /** |
|
67 | + * This will flush rewrite rules on demand. This actually gets called around wp init priority level 100. |
|
68 | + * |
|
69 | + * @since 4.5.0 |
|
70 | + * @return void |
|
71 | + */ |
|
72 | + public static function maybe_flush_rewrite_rules() |
|
73 | + { |
|
74 | + if (get_option('ee_flush_rewrite_rules', true)) { |
|
75 | + flush_rewrite_rules(); |
|
76 | + update_option('ee_flush_rewrite_rules', false); |
|
77 | + } |
|
78 | + } |
|
79 | + |
|
80 | + |
|
81 | + |
|
82 | + /** |
|
83 | + * By default, WordPress strips all html from term taxonomy description content. The purpose of this method is to |
|
84 | + * remove that restriction and ensure that we still run ee term taxonomy descriptions through some full html |
|
85 | + * sanitization equivalent to the post content field. |
|
86 | + * |
|
87 | + * @since 4.7.8 |
|
88 | + */ |
|
89 | + protected function _allow_html_descriptions_for_ee_taxonomies() |
|
90 | + { |
|
91 | + // first remove default filter for term description but we have to do this earlier |
|
92 | + // before wp sets their own filter |
|
93 | + // because they just set a global filter on all term descriptions before the custom term description filter. |
|
94 | + // Really sux. |
|
95 | + add_filter('pre_term_description', array($this, 'ee_filter_ee_term_description_not_wp'), 1, 2); |
|
96 | + } |
|
97 | + |
|
98 | + |
|
99 | + |
|
100 | + /** |
|
101 | + * Callback for pre_term_description hook. |
|
102 | + * |
|
103 | + * @param string $description The description content. |
|
104 | + * @param string $taxonomy The taxonomy name for the taxonomy being filtered. |
|
105 | + * @return string |
|
106 | + */ |
|
107 | + public function ee_filter_ee_term_description_not_wp($description, $taxonomy) |
|
108 | + { |
|
109 | + //get a list of EE taxonomies |
|
110 | + $ee_taxonomies = array_keys(self::get_taxonomies()); |
|
111 | + //only do our own thing if the taxonomy listed is an ee taxonomy. |
|
112 | + if (in_array($taxonomy, $ee_taxonomies, true)) { |
|
113 | + //remove default wp filter |
|
114 | + remove_filter('pre_term_description', 'wp_filter_kses'); |
|
115 | + //sanitize THIS content. |
|
116 | + $description = wp_kses($description, wp_kses_allowed_html('post')); |
|
117 | + } |
|
118 | + return $description; |
|
119 | + } |
|
120 | + |
|
121 | + |
|
122 | + |
|
123 | + /** |
|
124 | + * get_taxonomies |
|
125 | + * |
|
126 | + * @access public |
|
127 | + * @return array |
|
128 | + */ |
|
129 | + public static function get_taxonomies() |
|
130 | + { |
|
131 | + // define taxonomies |
|
132 | + return apply_filters('FHEE__EE_Register_CPTs__get_taxonomies__taxonomies', array( |
|
133 | + 'espresso_event_categories' => array( |
|
134 | + 'singular_name' => __("Event Category", "event_espresso"), |
|
135 | + 'plural_name' => __("Event Categories", "event_espresso"), |
|
136 | + 'args' => array( |
|
137 | + 'public' => true, |
|
138 | + 'show_in_nav_menus' => true, |
|
139 | + 'show_in_rest' => true, |
|
140 | + 'capabilities' => array( |
|
141 | + 'manage_terms' => 'ee_manage_event_categories', |
|
142 | + 'edit_terms' => 'ee_edit_event_category', |
|
143 | + 'delete_terms' => 'ee_delete_event_category', |
|
144 | + 'assign_terms' => 'ee_assign_event_category', |
|
145 | + ), |
|
146 | + 'rewrite' => array('slug' => __('event-category', 'event_espresso')), |
|
147 | + ), |
|
148 | + ), |
|
149 | + 'espresso_venue_categories' => array( |
|
150 | + 'singular_name' => __("Venue Category", "event_espresso"), |
|
151 | + 'plural_name' => __("Venue Categories", "event_espresso"), |
|
152 | + 'args' => array( |
|
153 | + 'public' => true, |
|
154 | + 'show_in_nav_menus' => false, //by default this doesn't show for decaf |
|
155 | + 'show_in_rest' => true, |
|
156 | + 'capabilities' => array( |
|
157 | + 'manage_terms' => 'ee_manage_venue_categories', |
|
158 | + 'edit_terms' => 'ee_edit_venue_category', |
|
159 | + 'delete_terms' => 'ee_delete_venue_category', |
|
160 | + 'assign_terms' => 'ee_assign_venue_category', |
|
161 | + ), |
|
162 | + 'rewrite' => array('slug' => __('venue-category', 'event_espresso')), |
|
163 | + ), |
|
164 | + ), |
|
165 | + 'espresso_event_type' => array( |
|
166 | + 'singular_name' => __("Event Type", "event_espresso"), |
|
167 | + 'plural_name' => __("Event Types", "event_espresso"), |
|
168 | + 'args' => array( |
|
169 | + 'public' => true, |
|
170 | + 'show_ui' => false, |
|
171 | + 'show_in_rest' => true, |
|
172 | + 'capabilities' => array( |
|
173 | + 'manage_terms' => 'ee_read_event_type', |
|
174 | + 'edit_terms' => 'ee_edit_event_type', |
|
175 | + 'delete_terms' => 'ee_delete_event_type', |
|
176 | + 'assign_terms' => 'ee_assign_event_type', |
|
177 | + ), |
|
178 | + 'rewrite' => array('slug' => __('event-type', 'event_espresso')), |
|
179 | + 'hierarchical' => true, |
|
180 | + ), |
|
181 | + ), |
|
182 | + )); |
|
183 | + } |
|
184 | + |
|
185 | + |
|
186 | + |
|
187 | + /** |
|
188 | + * This returns the corresponding model name for cpts registered by EE. |
|
189 | + * |
|
190 | + * @since 4.6.16.rc.000 |
|
191 | + * @param string $post_type_slug If a slug is included, then attempt to retrieve the model name for |
|
192 | + * the given cpt slug. Otherwise if empty, then we'll return all cpt |
|
193 | + * model names for cpts registered in EE. |
|
194 | + * @return array Empty array if no matching model names for the given slug or an array of model |
|
195 | + * names indexed by post type slug. |
|
196 | + */ |
|
197 | + public static function get_cpt_model_names($post_type_slug = '') |
|
198 | + { |
|
199 | + $cpts = self::get_CPTs(); |
|
200 | + //first if slug passed in... |
|
201 | + if ( ! empty($post_type_slug)) { |
|
202 | + //match? |
|
203 | + if ( |
|
204 | + ! isset($cpts[$post_type_slug]) |
|
205 | + || (isset($cpts[$post_type_slug]) && empty($cpts[$post_type_slug]['class_name'])) |
|
206 | + ) { |
|
207 | + return array(); |
|
208 | + } |
|
209 | + //k let's get the model name for this cpt. |
|
210 | + return array($post_type_slug => str_replace('EE', 'EEM', $cpts[$post_type_slug]['class_name'])); |
|
211 | + } |
|
212 | + //if we made it here then we're returning an array of cpt model names indexed by post_type_slug. |
|
213 | + $cpt_models = array(); |
|
214 | + foreach ($cpts as $slug => $args) { |
|
215 | + if ( ! empty($args['class_name'])) { |
|
216 | + $cpt_models[$slug] = str_replace('EE', 'EEM', $args['class_name']); |
|
217 | + } |
|
218 | + } |
|
219 | + return $cpt_models; |
|
220 | + } |
|
221 | + |
|
222 | + |
|
223 | + |
|
224 | + /** |
|
225 | + * This instantiates cpt models related to the cpts registered via EE. |
|
226 | + * |
|
227 | + * @since 4.6.16.rc.000 |
|
228 | + * @param string $post_type_slug If valid slug is provided, then will instantiate the model only for |
|
229 | + * the cpt matching the given slug. Otherwise all cpt models will be |
|
230 | + * instantiated (if possible). |
|
231 | + * @return EEM_CPT_Base[] successful instantiation will return an array of successfully instantiated |
|
232 | + * EEM models indexed by post slug. |
|
233 | + */ |
|
234 | + public static function instantiate_cpt_models($post_type_slug = '') |
|
235 | + { |
|
236 | + $cpt_model_names = self::get_cpt_model_names($post_type_slug); |
|
237 | + $instantiated = array(); |
|
238 | + foreach ($cpt_model_names as $slug => $model_name) { |
|
239 | + $instance = EE_Registry::instance()->load_model(str_replace('EEM_', '', $model_name)); |
|
240 | + if ($instance instanceof EEM_CPT_Base) { |
|
241 | + $instantiated[$slug] = $instance; |
|
242 | + } |
|
243 | + } |
|
244 | + return $instantiated; |
|
245 | + } |
|
246 | + |
|
247 | + |
|
248 | + |
|
249 | + /** |
|
250 | + * get_CPTs |
|
251 | + * |
|
252 | + * @access public |
|
253 | + * @return array |
|
254 | + */ |
|
255 | + public static function get_CPTs() |
|
256 | + { |
|
257 | + // define CPTs |
|
258 | + // NOTE the ['args']['page_templates'] array index is something specific to our CPTs |
|
259 | + // and not part of the WP custom post type api. |
|
260 | + return apply_filters('FHEE__EE_Register_CPTs__get_CPTs__cpts', array( |
|
261 | + 'espresso_events' => array( |
|
262 | + 'singular_name' => __("Event", "event_espresso"), |
|
263 | + 'plural_name' => __("Events", "event_espresso"), |
|
264 | + 'singular_slug' => __("event", "event_espresso"), |
|
265 | + 'plural_slug' => EE_Registry::instance()->CFG->core->event_cpt_slug, |
|
266 | + 'class_name' => 'EE_Event', |
|
267 | + 'args' => array( |
|
268 | + 'public' => true, |
|
269 | + 'show_in_nav_menus' => true, |
|
270 | + 'capability_type' => 'event', |
|
271 | + 'capabilities' => array( |
|
272 | + 'edit_post' => 'ee_edit_event', |
|
273 | + 'read_post' => 'ee_read_event', |
|
274 | + 'delete_post' => 'ee_delete_event', |
|
275 | + 'edit_posts' => 'ee_edit_events', |
|
276 | + 'edit_others_posts' => 'ee_edit_others_events', |
|
277 | + 'publish_posts' => 'ee_publish_events', |
|
278 | + 'read_private_posts' => 'ee_read_private_events', |
|
279 | + 'delete_posts' => 'ee_delete_events', |
|
280 | + 'delete_private_posts' => 'ee_delete_private_events', |
|
281 | + 'delete_published_posts' => 'ee_delete_published_events', |
|
282 | + 'delete_others_posts' => 'ee_delete_others_events', |
|
283 | + 'edit_private_posts' => 'ee_edit_private_events', |
|
284 | + 'edit_published_posts' => 'ee_edit_published_events', |
|
285 | + ), |
|
286 | + 'taxonomies' => array( |
|
287 | + 'espresso_event_categories', |
|
288 | + 'espresso_event_type', |
|
289 | + 'post_tag', |
|
290 | + ), |
|
291 | + 'page_templates' => true, |
|
292 | + ), |
|
293 | + ), |
|
294 | + 'espresso_venues' => array( |
|
295 | + 'singular_name' => __("Venue", "event_espresso"), |
|
296 | + 'plural_name' => __("Venues", "event_espresso"), |
|
297 | + 'singular_slug' => __("venue", "event_espresso"), |
|
298 | + 'plural_slug' => __("venues", "event_espresso"), |
|
299 | + 'class_name' => 'EE_Venue', |
|
300 | + 'args' => array( |
|
301 | + 'public' => true, |
|
302 | + 'show_in_nav_menus' => false, //by default this doesn't show for decaf, |
|
303 | + 'capability_type' => 'venue', |
|
304 | + 'capabilities' => array( |
|
305 | + 'edit_post' => 'ee_edit_venue', |
|
306 | + 'read_post' => 'ee_read_venue', |
|
307 | + 'delete_post' => 'ee_delete_venue', |
|
308 | + 'edit_posts' => 'ee_edit_venues', |
|
309 | + 'edit_others_posts' => 'ee_edit_others_venues', |
|
310 | + 'publish_posts' => 'ee_publish_venues', |
|
311 | + 'read_private_posts' => 'ee_read_private_venues', |
|
312 | + 'delete_posts' => 'ee_delete_venues', |
|
313 | + 'delete_private_posts' => 'ee_delete_private_venues', |
|
314 | + 'delete_published_posts' => 'ee_delete_published_venues', |
|
315 | + 'delete_others_posts' => 'ee_edit_others_venues', |
|
316 | + 'edit_private_posts' => 'ee_edit_private_venues', |
|
317 | + 'edit_published_posts' => 'ee_edit_published_venues', |
|
318 | + ), |
|
319 | + 'taxonomies' => array( |
|
320 | + 'espresso_venue_categories', |
|
321 | + 'post_tag', |
|
322 | + ), |
|
323 | + 'page_templates' => true, |
|
324 | + ), |
|
325 | + ), |
|
326 | + 'espresso_attendees' => array( |
|
327 | + 'singular_name' => __("Contact", "event_espresso"), |
|
328 | + 'plural_name' => __("Contacts", "event_espresso"), |
|
329 | + 'singular_slug' => __("contact", "event_espresso"), |
|
330 | + 'plural_slug' => __("contacts", "event_espresso"), |
|
331 | + 'class_name' => 'EE_Attendee', |
|
332 | + 'args' => array( |
|
333 | + 'public' => false, |
|
334 | + 'publicly_queryable' => false, |
|
335 | + 'hierarchical' => false, |
|
336 | + 'has_archive' => false, |
|
337 | + 'taxonomies' => array('post_tag'), |
|
338 | + 'capability_type' => 'contact', |
|
339 | + 'capabilities' => array( |
|
340 | + 'edit_post' => 'ee_edit_contact', |
|
341 | + 'read_post' => 'ee_read_contact', |
|
342 | + 'delete_post' => 'ee_delete_contact', |
|
343 | + 'edit_posts' => 'ee_edit_contacts', |
|
344 | + 'edit_others_posts' => 'ee_edit_contacts', |
|
345 | + 'publish_posts' => 'ee_edit_contacts', |
|
346 | + 'read_private_posts' => 'ee_edit_contacts', |
|
347 | + 'delete_posts' => 'ee_delete_contacts', |
|
348 | + 'delete_private_posts' => 'ee_delete_contacts', |
|
349 | + 'delete_published_posts' => 'ee_delete_contacts', |
|
350 | + 'delete_others_posts' => 'ee_delete_contacts', |
|
351 | + 'edit_private_posts' => 'ee_edit_contacts', |
|
352 | + 'edit_published_posts' => 'ee_edit_contacts', |
|
353 | + ), |
|
354 | + 'supports' => array('editor', 'thumbnail', 'excerpt', 'custom-fields', 'comments'), |
|
355 | + ), |
|
356 | + ), |
|
357 | + )); |
|
358 | + } |
|
359 | + |
|
360 | + |
|
361 | + |
|
362 | + /** |
|
363 | + * This basically goes through the CPT array and returns only CPT's |
|
364 | + * that have the ['args']['public'] option set as false |
|
365 | + * |
|
366 | + * @return array |
|
367 | + */ |
|
368 | + public static function get_private_CPTs() |
|
369 | + { |
|
370 | + $CPTs = self::get_CPTs(); |
|
371 | + $private_CPTs = array(); |
|
372 | + foreach ($CPTs as $CPT => $details) { |
|
373 | + if (empty($details['args']['public'])) { |
|
374 | + $private_CPTs[$CPT] = $details; |
|
375 | + } |
|
376 | + } |
|
377 | + return $private_CPTs; |
|
378 | + } |
|
379 | + |
|
380 | + |
|
381 | + |
|
382 | + /** |
|
383 | + * Registers a custom taxonomy. Should be called before registering custom post types, |
|
384 | + * otherwise you should link the taxonomy to the custom post type using 'register_taxonomy_for_object_type'. |
|
385 | + * |
|
386 | + * @param string $taxonomy_name , eg 'books' |
|
387 | + * @param string $singular_name internationalized singular name |
|
388 | + * @param string $plural_name internationalized plural name |
|
389 | + * @param array $override_args like $args on http://codex.wordpress.org/Function_Reference/register_taxonomy |
|
390 | + */ |
|
391 | + public function register_taxonomy($taxonomy_name, $singular_name, $plural_name, $override_args = array()) |
|
392 | + { |
|
393 | + $args = array( |
|
394 | + 'hierarchical' => true, |
|
395 | + 'labels' => array( |
|
396 | + 'name' => $plural_name, |
|
397 | + 'singular_name' => $singular_name, |
|
398 | + ), |
|
399 | + 'show_ui' => true, |
|
400 | + 'show_ee_ui' => true, |
|
401 | + 'show_admin_column' => true, |
|
402 | + 'query_var' => true, |
|
403 | + 'show_in_nav_menus' => false, |
|
404 | + 'map_meta_cap' => true |
|
405 | + //'rewrite' => array( 'slug' => 'genre' ), |
|
406 | + ); |
|
407 | + if ($override_args) { |
|
408 | + if (isset($override_args['labels'])) { |
|
409 | + $labels = array_merge($args['labels'], $override_args['labels']); |
|
410 | + $args['labels'] = $labels; |
|
411 | + } |
|
412 | + $args = array_merge($args, $override_args); |
|
413 | + } |
|
414 | + register_taxonomy($taxonomy_name, null, $args); |
|
415 | + } |
|
416 | + |
|
417 | + |
|
418 | + |
|
419 | + /** |
|
420 | + * Registers a new custom post type. Sets default settings given only the following params. |
|
421 | + * |
|
422 | + * @param string $post_type the actual post type name |
|
423 | + * (VERY IMPORTANT: this much match what the slug is for admin pages related to this |
|
424 | + * cpt Also any models must use this slug as well) |
|
425 | + * @param string $singular_name a pre-internationalized string for the singular name of the objects |
|
426 | + * @param string $plural_name a pre-internalized string for the plural name of the objects |
|
427 | + * @param array $override_args exactly like $args as described in |
|
428 | + * http://codex.wordpress.org/Function_Reference/register_post_type The default values |
|
429 | + * set in this function will be overridden by whatever you set in $override_args |
|
430 | + * @param string $singular_slug |
|
431 | + * @param string $plural_slug |
|
432 | + * @return void , but registers the custom post type |
|
433 | + */ |
|
434 | + public function register_CPT( |
|
435 | + $post_type, |
|
436 | + $singular_name, |
|
437 | + $plural_name, |
|
438 | + $override_args = array(), |
|
439 | + $singular_slug = '', |
|
440 | + $plural_slug = '' |
|
441 | + ) { |
|
442 | + $labels = array( |
|
443 | + 'name' => $plural_name, |
|
444 | + 'singular_name' => $singular_name, |
|
445 | + 'singular_slug' => $singular_slug, |
|
446 | + 'plural_slug' => $plural_slug, |
|
447 | + 'add_new' => sprintf(__("Add %s", "event_espresso"), $singular_name), |
|
448 | + 'add_new_item' => sprintf(__("Add New %s", "event_espresso"), $singular_name), |
|
449 | + 'edit_item' => sprintf(__("Edit %s", "event_espresso"), $singular_name), |
|
450 | + 'new_item' => sprintf(__("New %s", "event_espresso"), $singular_name), |
|
451 | + 'all_items' => sprintf(__("All %s", "event_espresso"), $plural_name), |
|
452 | + 'view_item' => sprintf(__("View %s", "event_espresso"), $singular_name), |
|
453 | + 'search_items' => sprintf(__("Search %s", "event_espresso"), $plural_name), |
|
454 | + 'not_found' => sprintf(__("No %s found", "event_espresso"), $plural_name), |
|
455 | + 'not_found_in_trash' => sprintf(__("No %s found in Trash", "event_espresso"), $plural_name), |
|
456 | + 'parent_item_colon' => '', |
|
457 | + 'menu_name' => sprintf(__("%s", "event_espresso"), $plural_name), |
|
458 | + ); |
|
459 | + //verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name |
|
460 | + // $singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name; |
|
461 | + $plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name; |
|
462 | + //note the page_templates arg in the supports index is something specific to EE. |
|
463 | + // WordPress doesn't actually have that in their register_post_type api. |
|
464 | + $args = array( |
|
465 | + 'labels' => $labels, |
|
466 | + 'public' => true, |
|
467 | + 'publicly_queryable' => true, |
|
468 | + 'show_ui' => false, |
|
469 | + 'show_ee_ui' => true, |
|
470 | + 'show_in_menu' => false, |
|
471 | + 'show_in_nav_menus' => false, |
|
472 | + 'query_var' => true, |
|
473 | + 'rewrite' => apply_filters( |
|
474 | + 'FHEE__EE_Register_CPTs__register_CPT__rewrite', |
|
475 | + array('slug' => $plural_slug), |
|
476 | + $post_type |
|
477 | + ), |
|
478 | + 'capability_type' => 'post', |
|
479 | + 'map_meta_cap' => true, |
|
480 | + 'has_archive' => true, |
|
481 | + 'hierarchical' => false, |
|
482 | + 'menu_position' => null, |
|
483 | + 'supports' => array( |
|
484 | + 'title', |
|
485 | + 'editor', |
|
486 | + 'author', |
|
487 | + 'thumbnail', |
|
488 | + 'excerpt', |
|
489 | + 'custom-fields', |
|
490 | + 'comments', |
|
491 | + ), |
|
492 | + ); |
|
493 | + if ($override_args) { |
|
494 | + if (isset($override_args['labels'])) { |
|
495 | + $labels = array_merge($args['labels'], $override_args['labels']); |
|
496 | + } |
|
497 | + $args = array_merge($args, $override_args); |
|
498 | + $args['labels'] = $labels; |
|
499 | + } |
|
500 | + register_post_type($post_type, $args); |
|
501 | + } |
|
502 | + |
|
503 | + |
|
504 | + |
|
505 | + public function set_must_use_event_types() |
|
506 | + { |
|
507 | + $term_details = array( |
|
508 | + //Attendee's register for the first date-time only |
|
509 | + 'single-event' => array( |
|
510 | + __('Single Event', 'event_espresso'), |
|
511 | + __('A single event that spans one or more consecutive days.', 'event_espresso'), |
|
512 | + ), |
|
513 | + //example: a party or two-day long workshop |
|
514 | + //Attendee's can register for any of the date-times |
|
515 | + 'multi-event' => array( |
|
516 | + __('Multi Event', 'event_espresso'), |
|
517 | + __('Multiple, separate, but related events that occur on consecutive days.', 'event_espresso'), |
|
518 | + ), |
|
519 | + //example: a three day music festival or week long conference |
|
520 | + //Attendee's register for the first date-time only |
|
521 | + 'event-series' => array( |
|
522 | + __('Event Series', 'event_espresso'), |
|
523 | + __(' Multiple events that occur over multiple non-consecutive days.', 'event_espresso'), |
|
524 | + ), |
|
525 | + //example: an 8 week introduction to basket weaving course |
|
526 | + //Attendee's can register for any of the date-times. |
|
527 | + 'recurring-event' => array( |
|
528 | + __('Recurring Event', 'event_espresso'), |
|
529 | + __('Multiple events that occur over multiple non-consecutive days.', 'event_espresso'), |
|
530 | + ), |
|
531 | + //example: a yoga class |
|
532 | + 'ongoing' => array( |
|
533 | + __('Ongoing Event', 'event_espresso'), |
|
534 | + __('An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event', |
|
535 | + 'event_espresso'), |
|
536 | + ) |
|
537 | + //example: access to a museum |
|
538 | + //'walk-in' => array( __('Walk In', 'event_espresso'), __('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ), |
|
539 | + //'reservation' => array( __('Reservation', 'event_espresso'), __('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 |
|
540 | + // 'multiple-session' => array( __('Multiple Session', 'event_espresso'), __('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 |
|
541 | + //'appointment' => array( __('Appointments', 'event_espresso'), __('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') ) |
|
542 | + ); |
|
543 | + $this->set_must_use_terms('espresso_event_type', $term_details); |
|
544 | + } |
|
545 | + |
|
546 | + |
|
547 | + |
|
548 | + /** |
|
549 | + * wrapper method for handling the setting up of initial terms in the db (if they don't already exist). |
|
550 | + * Note this should ONLY be used for terms that always must be present. Be aware that if an initial term is |
|
551 | + * deleted then it WILL be recreated. |
|
552 | + * |
|
553 | + * @param string $taxonomy The name of the taxonomy |
|
554 | + * @param array $term_details An array of term details indexed by slug and containing Name of term, and |
|
555 | + * description as the elements in the array |
|
556 | + * @return void |
|
557 | + */ |
|
558 | + public function set_must_use_terms($taxonomy, $term_details) |
|
559 | + { |
|
560 | + $term_details = (array)$term_details; |
|
561 | + foreach ($term_details as $slug => $details) { |
|
562 | + if ( ! term_exists($slug, $taxonomy)) { |
|
563 | + $insert_arr = array( |
|
564 | + 'slug' => $slug, |
|
565 | + 'description' => $details[1], |
|
566 | + ); |
|
567 | + wp_insert_term($details[0], $taxonomy, $insert_arr); |
|
568 | + } |
|
569 | + } |
|
570 | + } |
|
571 | + |
|
572 | + |
|
573 | + |
|
574 | + /** |
|
575 | + * Allows us to set what the default will be for terms when a cpt is PUBLISHED. |
|
576 | + * |
|
577 | + * @param string $taxonomy The taxonomy we're using for the default term |
|
578 | + * @param string $term_slug The slug of the term that will be the default. |
|
579 | + * @param array $cpt_slugs An array of custom post types we want the default assigned to |
|
580 | + */ |
|
581 | + public function set_default_term($taxonomy, $term_slug, $cpt_slugs = array()) |
|
582 | + { |
|
583 | + $this->_default_terms[][$term_slug] = new EE_Default_Term($taxonomy, $term_slug, $cpt_slugs); |
|
584 | + } |
|
585 | + |
|
586 | + |
|
587 | + |
|
588 | + /** |
|
589 | + * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property |
|
590 | + * |
|
591 | + * @param int $post_id ID of CPT being saved |
|
592 | + * @param object $post Post object |
|
593 | + * @return void |
|
594 | + */ |
|
595 | + public function save_default_term($post_id, $post) |
|
596 | + { |
|
597 | + if (empty($this->_default_terms)) { |
|
598 | + return; |
|
599 | + } //no default terms set so lets just exit. |
|
600 | + foreach ($this->_default_terms as $defaults) { |
|
601 | + foreach ($defaults as $default_obj) { |
|
602 | + if ($post->post_status === 'publish' && in_array($post->post_type, $default_obj->cpt_slugs, true)) { |
|
603 | + //note some error proofing going on here to save unnecessary db queries |
|
604 | + $taxonomies = get_object_taxonomies($post->post_type); |
|
605 | + foreach ((array)$taxonomies as $taxonomy) { |
|
606 | + $terms = wp_get_post_terms($post_id, $taxonomy); |
|
607 | + if (empty($terms) && $taxonomy === $default_obj->taxonomy) { |
|
608 | + wp_set_object_terms($post_id, array($default_obj->term_slug), $taxonomy); |
|
609 | + } |
|
610 | + } |
|
611 | + } |
|
612 | + } |
|
613 | + } |
|
614 | + } |
|
615 | 615 | |
616 | 616 | } |
617 | 617 | |
@@ -625,27 +625,27 @@ discard block |
||
625 | 625 | { |
626 | 626 | |
627 | 627 | |
628 | - //props holding the items |
|
629 | - public $taxonomy = ''; |
|
628 | + //props holding the items |
|
629 | + public $taxonomy = ''; |
|
630 | 630 | |
631 | - public $cpt_slugs = array(); |
|
631 | + public $cpt_slugs = array(); |
|
632 | 632 | |
633 | - public $term_slug = ''; |
|
633 | + public $term_slug = ''; |
|
634 | 634 | |
635 | 635 | |
636 | 636 | |
637 | - /** |
|
638 | - * constructor |
|
639 | - * |
|
640 | - * @param string $taxonomy The taxonomy the default term belongs to |
|
641 | - * @param string $term_slug The slug of the term that will be the default. |
|
642 | - * @param array $cpt_slugs The custom post type the default term gets saved with |
|
643 | - */ |
|
644 | - public function __construct($taxonomy, $term_slug, $cpt_slugs = array()) |
|
645 | - { |
|
646 | - $this->taxonomy = $taxonomy; |
|
647 | - $this->cpt_slugs = (array)$cpt_slugs; |
|
648 | - $this->term_slug = $term_slug; |
|
649 | - } |
|
637 | + /** |
|
638 | + * constructor |
|
639 | + * |
|
640 | + * @param string $taxonomy The taxonomy the default term belongs to |
|
641 | + * @param string $term_slug The slug of the term that will be the default. |
|
642 | + * @param array $cpt_slugs The custom post type the default term gets saved with |
|
643 | + */ |
|
644 | + public function __construct($taxonomy, $term_slug, $cpt_slugs = array()) |
|
645 | + { |
|
646 | + $this->taxonomy = $taxonomy; |
|
647 | + $this->cpt_slugs = (array)$cpt_slugs; |
|
648 | + $this->term_slug = $term_slug; |
|
649 | + } |
|
650 | 650 | |
651 | 651 | } |
@@ -118,40 +118,40 @@ |
||
118 | 118 | * @return EE_Template_Config |
119 | 119 | */ |
120 | 120 | public static function update_template_settings(EE_Template_Config $CFG, $REQ ) { |
121 | - if(! $CFG->EED_Event_Single instanceof EE_Event_Single_Config){ |
|
122 | - $CFG->EED_Event_Single = new EE_Event_Single_Config(); |
|
123 | - } |
|
124 | - $display_order_event = $CFG->EED_Event_Single->display_order_event !== null |
|
125 | - ? $CFG->EED_Event_Single->display_order_event |
|
126 | - : EED_Event_Single::EVENT_DETAILS_PRIORITY; |
|
121 | + if(! $CFG->EED_Event_Single instanceof EE_Event_Single_Config){ |
|
122 | + $CFG->EED_Event_Single = new EE_Event_Single_Config(); |
|
123 | + } |
|
124 | + $display_order_event = $CFG->EED_Event_Single->display_order_event !== null |
|
125 | + ? $CFG->EED_Event_Single->display_order_event |
|
126 | + : EED_Event_Single::EVENT_DETAILS_PRIORITY; |
|
127 | 127 | $display_order_datetimes = $CFG->EED_Event_Single->display_order_datetimes !== null |
128 | - ? $CFG->EED_Event_Single->display_order_datetimes |
|
129 | - : EED_Event_Single::EVENT_DATETIMES_PRIORITY; |
|
130 | - $display_order_tickets = $CFG->EED_Event_Single->display_order_tickets !== null |
|
131 | - ? $CFG->EED_Event_Single->display_order_tickets |
|
132 | - : EED_Event_Single::EVENT_TICKETS_PRIORITY; |
|
128 | + ? $CFG->EED_Event_Single->display_order_datetimes |
|
129 | + : EED_Event_Single::EVENT_DATETIMES_PRIORITY; |
|
130 | + $display_order_tickets = $CFG->EED_Event_Single->display_order_tickets !== null |
|
131 | + ? $CFG->EED_Event_Single->display_order_tickets |
|
132 | + : EED_Event_Single::EVENT_TICKETS_PRIORITY; |
|
133 | 133 | $display_order_venue = $CFG->EED_Event_Single->display_order_venue !== null |
134 | - ? $CFG->EED_Event_Single->display_order_venue |
|
135 | - : EED_Event_Single::EVENT_VENUES_PRIORITY; |
|
134 | + ? $CFG->EED_Event_Single->display_order_venue |
|
135 | + : EED_Event_Single::EVENT_VENUES_PRIORITY; |
|
136 | 136 | $CFG->EED_Event_Single = new EE_Event_Single_Config(); |
137 | 137 | $CFG->EED_Event_Single->display_status_banner_single = ! empty( $REQ['display_status_banner_single'] ) |
138 | - && $REQ['display_status_banner_single']; |
|
138 | + && $REQ['display_status_banner_single']; |
|
139 | 139 | $CFG->EED_Event_Single->display_venue = ! empty( $REQ['display_venue'] ) && $REQ['display_venue']; |
140 | 140 | $CFG->EED_Event_Single->use_sortable_display_order = ! empty( $REQ[ 'EED_Events_Single_use_sortable_display_order' ] ) |
141 | - ? absint( $REQ[ 'EED_Events_Single_use_sortable_display_order' ] ) |
|
142 | - : 0; |
|
141 | + ? absint( $REQ[ 'EED_Events_Single_use_sortable_display_order' ] ) |
|
142 | + : 0; |
|
143 | 143 | $CFG->EED_Event_Single->display_order_event = $CFG->EED_Event_Single->use_sortable_display_order |
144 | - ? $display_order_event |
|
145 | - : EED_Event_Single::EVENT_DETAILS_PRIORITY; |
|
144 | + ? $display_order_event |
|
145 | + : EED_Event_Single::EVENT_DETAILS_PRIORITY; |
|
146 | 146 | $CFG->EED_Event_Single->display_order_datetimes = $CFG->EED_Event_Single->use_sortable_display_order |
147 | - ? $display_order_datetimes |
|
148 | - : EED_Event_Single::EVENT_DATETIMES_PRIORITY; |
|
147 | + ? $display_order_datetimes |
|
148 | + : EED_Event_Single::EVENT_DATETIMES_PRIORITY; |
|
149 | 149 | $CFG->EED_Event_Single->display_order_tickets = $CFG->EED_Event_Single->use_sortable_display_order |
150 | - ? $display_order_tickets |
|
151 | - : EED_Event_Single::EVENT_TICKETS_PRIORITY; |
|
150 | + ? $display_order_tickets |
|
151 | + : EED_Event_Single::EVENT_TICKETS_PRIORITY; |
|
152 | 152 | $CFG->EED_Event_Single->display_order_venue = $CFG->EED_Event_Single->use_sortable_display_order |
153 | - ? $display_order_venue |
|
154 | - : EED_Event_Single::EVENT_VENUES_PRIORITY; |
|
153 | + ? $display_order_venue |
|
154 | + : EED_Event_Single::EVENT_VENUES_PRIORITY; |
|
155 | 155 | do_action( 'AHEE__EED_Event_Single__update_template_settings__after_update', $CFG, $REQ ); |
156 | 156 | return $CFG; |
157 | 157 | } |
@@ -29,7 +29,7 @@ discard block |
||
29 | 29 | * @return EED_Event_Single_Caff |
30 | 30 | */ |
31 | 31 | public static function instance() { |
32 | - return parent::get_instance( __CLASS__ ); |
|
32 | + return parent::get_instance(__CLASS__); |
|
33 | 33 | } |
34 | 34 | |
35 | 35 | |
@@ -50,34 +50,34 @@ discard block |
||
50 | 50 | * @return void |
51 | 51 | */ |
52 | 52 | public static function set_hooks_admin() { |
53 | - define( 'EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path( __FILE__ ) . 'templates' . DS ); |
|
54 | - define( 'EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url( __FILE__ ) . 'assets' . DS ); |
|
53 | + define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__).'templates'.DS); |
|
54 | + define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__).'assets'.DS); |
|
55 | 55 | add_action( |
56 | 56 | 'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__template_settings', |
57 | - array( 'EED_Event_Single_Caff', 'load_scripts_styles' ), |
|
57 | + array('EED_Event_Single_Caff', 'load_scripts_styles'), |
|
58 | 58 | 10 |
59 | 59 | ); |
60 | - add_action( 'AHEE__template_settings__template__before_settings_form', array( 'EED_Event_Single_Caff', 'template_settings_form' ), 10 ); |
|
61 | - add_filter( 'FHEE__General_Settings_Admin_Page__update_template_settings__data', array( 'EED_Event_Single_Caff', 'update_template_settings' ), 10, 2 ); |
|
60 | + add_action('AHEE__template_settings__template__before_settings_form', array('EED_Event_Single_Caff', 'template_settings_form'), 10); |
|
61 | + add_filter('FHEE__General_Settings_Admin_Page__update_template_settings__data', array('EED_Event_Single_Caff', 'update_template_settings'), 10, 2); |
|
62 | 62 | // AJAX |
63 | - add_action( 'wp_ajax_espresso_update_event_single_order', array( 'EED_Event_Single_Caff', 'update_event_single_order' ) ); |
|
64 | - add_action( 'wp_ajax_nopriv_espresso_update_event_single_order', array( 'EED_Event_Single_Caff', 'update_event_single_order' ) ); |
|
63 | + add_action('wp_ajax_espresso_update_event_single_order', array('EED_Event_Single_Caff', 'update_event_single_order')); |
|
64 | + add_action('wp_ajax_nopriv_espresso_update_event_single_order', array('EED_Event_Single_Caff', 'update_event_single_order')); |
|
65 | 65 | |
66 | 66 | } |
67 | 67 | |
68 | 68 | |
69 | 69 | |
70 | 70 | public static function load_scripts_styles() { |
71 | - add_action( 'admin_enqueue_scripts', array( 'EED_Event_Single_Caff', 'enqueue_scripts_styles' ), 10 ); |
|
71 | + add_action('admin_enqueue_scripts', array('EED_Event_Single_Caff', 'enqueue_scripts_styles'), 10); |
|
72 | 72 | } |
73 | 73 | |
74 | 74 | |
75 | 75 | |
76 | 76 | public static function enqueue_scripts_styles() { |
77 | - wp_register_style( 'eed-event-single-sortable', EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.css', array(), EVENT_ESPRESSO_VERSION ); |
|
78 | - wp_enqueue_style( 'eed-event-single-sortable' ); |
|
79 | - wp_register_script( 'eed-event-single-sortable', EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.js', array( 'jquery-ui-sortable' ), EVENT_ESPRESSO_VERSION, true ); |
|
80 | - wp_enqueue_script( 'eed-event-single-sortable' ); |
|
77 | + wp_register_style('eed-event-single-sortable', EVENT_SINGLE_CAFF_ASSETS_URL.'eed_event_single_sortable.css', array(), EVENT_ESPRESSO_VERSION); |
|
78 | + wp_enqueue_style('eed-event-single-sortable'); |
|
79 | + wp_register_script('eed-event-single-sortable', EVENT_SINGLE_CAFF_ASSETS_URL.'eed_event_single_sortable.js', array('jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true); |
|
80 | + wp_enqueue_script('eed-event-single-sortable'); |
|
81 | 81 | } |
82 | 82 | |
83 | 83 | |
@@ -91,21 +91,21 @@ discard block |
||
91 | 91 | */ |
92 | 92 | public static function template_settings_form() { |
93 | 93 | $config = EE_Registry::instance()->CFG->template_settings; |
94 | - $config = isset( $config->EED_Event_Single ) && $config->EED_Event_Single instanceof EE_Event_Single_Config ? $config->EED_Event_Single : new EE_Event_Single_Config(); |
|
95 | - $config->use_sortable_display_order = isset( $config->use_sortable_display_order ) ? $config->use_sortable_display_order : false; |
|
96 | - $config = apply_filters( 'FHEE__EED_Event_Single__template_settings_form__event_list_config', $config ); |
|
94 | + $config = isset($config->EED_Event_Single) && $config->EED_Event_Single instanceof EE_Event_Single_Config ? $config->EED_Event_Single : new EE_Event_Single_Config(); |
|
95 | + $config->use_sortable_display_order = isset($config->use_sortable_display_order) ? $config->use_sortable_display_order : false; |
|
96 | + $config = apply_filters('FHEE__EED_Event_Single__template_settings_form__event_list_config', $config); |
|
97 | 97 | |
98 | 98 | $event_single_order_array = array(); |
99 | - $event_single_order_array[ $config->display_order_tickets ] = 'tickets'; |
|
100 | - $event_single_order_array[ $config->display_order_datetimes ] = 'datetimes'; |
|
101 | - $event_single_order_array[ $config->display_order_event ] = 'event'; |
|
102 | - $event_single_order_array[ $config->display_order_venue ] = 'venue'; |
|
99 | + $event_single_order_array[$config->display_order_tickets] = 'tickets'; |
|
100 | + $event_single_order_array[$config->display_order_datetimes] = 'datetimes'; |
|
101 | + $event_single_order_array[$config->display_order_event] = 'event'; |
|
102 | + $event_single_order_array[$config->display_order_venue] = 'venue'; |
|
103 | 103 | // get template parts |
104 | - $template_parts = EED_Event_Single::instance()->initialize_template_parts( $config ); |
|
104 | + $template_parts = EED_Event_Single::instance()->initialize_template_parts($config); |
|
105 | 105 | // convert to array so that we can add more properties |
106 | - $config = get_object_vars( $config ); |
|
107 | - $config[ 'event_single_display_order' ] = $template_parts->generate_sortable_list_of_template_parts( 'event-single-sortable-js', '', 'single-sortable-li single-sortable-js' ); |
|
108 | - EEH_Template::display_template( EVENT_SINGLE_CAFF_TEMPLATES_PATH . 'admin-event-single-settings.template.php', $config ); |
|
106 | + $config = get_object_vars($config); |
|
107 | + $config['event_single_display_order'] = $template_parts->generate_sortable_list_of_template_parts('event-single-sortable-js', '', 'single-sortable-li single-sortable-js'); |
|
108 | + EEH_Template::display_template(EVENT_SINGLE_CAFF_TEMPLATES_PATH.'admin-event-single-settings.template.php', $config); |
|
109 | 109 | } |
110 | 110 | |
111 | 111 | |
@@ -117,8 +117,8 @@ discard block |
||
117 | 117 | * @param array $REQ |
118 | 118 | * @return EE_Template_Config |
119 | 119 | */ |
120 | - public static function update_template_settings(EE_Template_Config $CFG, $REQ ) { |
|
121 | - if(! $CFG->EED_Event_Single instanceof EE_Event_Single_Config){ |
|
120 | + public static function update_template_settings(EE_Template_Config $CFG, $REQ) { |
|
121 | + if ( ! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) { |
|
122 | 122 | $CFG->EED_Event_Single = new EE_Event_Single_Config(); |
123 | 123 | } |
124 | 124 | $display_order_event = $CFG->EED_Event_Single->display_order_event !== null |
@@ -134,11 +134,11 @@ discard block |
||
134 | 134 | ? $CFG->EED_Event_Single->display_order_venue |
135 | 135 | : EED_Event_Single::EVENT_VENUES_PRIORITY; |
136 | 136 | $CFG->EED_Event_Single = new EE_Event_Single_Config(); |
137 | - $CFG->EED_Event_Single->display_status_banner_single = ! empty( $REQ['display_status_banner_single'] ) |
|
137 | + $CFG->EED_Event_Single->display_status_banner_single = ! empty($REQ['display_status_banner_single']) |
|
138 | 138 | && $REQ['display_status_banner_single']; |
139 | - $CFG->EED_Event_Single->display_venue = ! empty( $REQ['display_venue'] ) && $REQ['display_venue']; |
|
140 | - $CFG->EED_Event_Single->use_sortable_display_order = ! empty( $REQ[ 'EED_Events_Single_use_sortable_display_order' ] ) |
|
141 | - ? absint( $REQ[ 'EED_Events_Single_use_sortable_display_order' ] ) |
|
139 | + $CFG->EED_Event_Single->display_venue = ! empty($REQ['display_venue']) && $REQ['display_venue']; |
|
140 | + $CFG->EED_Event_Single->use_sortable_display_order = ! empty($REQ['EED_Events_Single_use_sortable_display_order']) |
|
141 | + ? absint($REQ['EED_Events_Single_use_sortable_display_order']) |
|
142 | 142 | : 0; |
143 | 143 | $CFG->EED_Event_Single->display_order_event = $CFG->EED_Event_Single->use_sortable_display_order |
144 | 144 | ? $display_order_event |
@@ -152,7 +152,7 @@ discard block |
||
152 | 152 | $CFG->EED_Event_Single->display_order_venue = $CFG->EED_Event_Single->use_sortable_display_order |
153 | 153 | ? $display_order_venue |
154 | 154 | : EED_Event_Single::EVENT_VENUES_PRIORITY; |
155 | - do_action( 'AHEE__EED_Event_Single__update_template_settings__after_update', $CFG, $REQ ); |
|
155 | + do_action('AHEE__EED_Event_Single__update_template_settings__after_update', $CFG, $REQ); |
|
156 | 156 | return $CFG; |
157 | 157 | } |
158 | 158 | |
@@ -166,23 +166,23 @@ discard block |
||
166 | 166 | */ |
167 | 167 | public static function update_event_single_order() { |
168 | 168 | $config_saved = false; |
169 | - $template_parts = sanitize_text_field( $_POST[ 'elements' ] ); |
|
170 | - if ( ! empty( $template_parts ) ) { |
|
171 | - $template_parts = explode( ',', trim( $template_parts, ',' ) ); |
|
172 | - foreach ( $template_parts as $key => $template_part ) { |
|
169 | + $template_parts = sanitize_text_field($_POST['elements']); |
|
170 | + if ( ! empty($template_parts)) { |
|
171 | + $template_parts = explode(',', trim($template_parts, ',')); |
|
172 | + foreach ($template_parts as $key => $template_part) { |
|
173 | 173 | $template_part = "display_order_$template_part"; |
174 | - $priority = ( $key * 10 ) + EED_Event_Single::EVENT_DETAILS_PRIORITY; |
|
174 | + $priority = ($key * 10) + EED_Event_Single::EVENT_DETAILS_PRIORITY; |
|
175 | 175 | EE_Registry::instance()->CFG->template_settings->EED_Event_Single->{$template_part} = $priority; |
176 | - do_action( "AHEE__EED_Event_Single__update_event_single_order__$template_part", $priority ); |
|
176 | + do_action("AHEE__EED_Event_Single__update_event_single_order__$template_part", $priority); |
|
177 | 177 | } |
178 | - $config_saved = EE_Registry::instance()->CFG->update_espresso_config( false, false ); |
|
178 | + $config_saved = EE_Registry::instance()->CFG->update_espresso_config(false, false); |
|
179 | 179 | } |
180 | - if ( $config_saved ) { |
|
181 | - EE_Error::add_success( __( 'Display Order has been successfully updated.', 'event_espresso' ) ); |
|
180 | + if ($config_saved) { |
|
181 | + EE_Error::add_success(__('Display Order has been successfully updated.', 'event_espresso')); |
|
182 | 182 | } else { |
183 | - EE_Error::add_error( __( 'Display Order was not updated.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ ); |
|
183 | + EE_Error::add_error(__('Display Order was not updated.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
184 | 184 | } |
185 | - echo wp_json_encode( EE_Error::get_notices( false )); |
|
185 | + echo wp_json_encode(EE_Error::get_notices(false)); |
|
186 | 186 | exit(); |
187 | 187 | } |
188 | 188 | |
@@ -195,7 +195,7 @@ discard block |
||
195 | 195 | * @param WP $WP |
196 | 196 | * @return void |
197 | 197 | */ |
198 | - public function run( $WP ) { |
|
198 | + public function run($WP) { |
|
199 | 199 | } |
200 | 200 | |
201 | 201 |
@@ -19,206 +19,206 @@ |
||
19 | 19 | class EventListQuery extends WP_Query |
20 | 20 | { |
21 | 21 | |
22 | - /** |
|
23 | - * @var string $title |
|
24 | - */ |
|
25 | - private $title; |
|
26 | - |
|
27 | - /** |
|
28 | - * @var integer $limit |
|
29 | - */ |
|
30 | - private $limit = 10; |
|
31 | - |
|
32 | - /** |
|
33 | - * @var string $css_class |
|
34 | - */ |
|
35 | - private $css_class; |
|
36 | - |
|
37 | - /** |
|
38 | - * @var boolean $show_expired |
|
39 | - */ |
|
40 | - private $show_expired = false; |
|
41 | - |
|
42 | - /** |
|
43 | - * @var string $month |
|
44 | - */ |
|
45 | - private $month; |
|
46 | - |
|
47 | - /** |
|
48 | - * @var string $category_slug |
|
49 | - */ |
|
50 | - private $category_slug; |
|
51 | - |
|
52 | - /** |
|
53 | - * @var string $order_by |
|
54 | - */ |
|
55 | - private $order_by; |
|
56 | - |
|
57 | - /** |
|
58 | - * @var string $sort |
|
59 | - */ |
|
60 | - private $sort; |
|
61 | - |
|
62 | - /** |
|
63 | - * @var boolean $show_title |
|
64 | - */ |
|
65 | - private $show_title = true; |
|
66 | - |
|
67 | - |
|
68 | - |
|
69 | - /** |
|
70 | - * EE_Event_List_Query Constructor * |
|
71 | - * |
|
72 | - * @param array $args |
|
73 | - */ |
|
74 | - public function __construct($args = array()) |
|
75 | - { |
|
76 | - $args = $this->parseArgs((array)$args); |
|
77 | - $this->setupEventQueryHelper(); |
|
78 | - $this->setupFilters(); |
|
79 | - $args = $this->getQueryArgs($args); |
|
80 | - // run the query |
|
81 | - parent::__construct($args); |
|
82 | - } |
|
83 | - |
|
84 | - |
|
85 | - |
|
86 | - /** |
|
87 | - * @param array $args |
|
88 | - * @return array |
|
89 | - */ |
|
90 | - private function parseArgs(array $args) |
|
91 | - { |
|
92 | - // incoming args could be a mix of WP query args + EE shortcode args |
|
93 | - foreach ($args as $property => $value) { |
|
94 | - // if the arg is a property of this class, then it's an EE shortcode arg |
|
95 | - if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) { |
|
96 | - // set the property value |
|
97 | - $this->{$property} = $value; |
|
98 | - // then remove it from the array of args that will later be passed to WP_Query() |
|
99 | - unset($args[$property]); |
|
100 | - } |
|
101 | - } |
|
102 | - return $args; |
|
103 | - } |
|
104 | - |
|
105 | - |
|
106 | - |
|
107 | - private function setupEventQueryHelper() |
|
108 | - { |
|
109 | - //add query filters |
|
110 | - EEH_Event_Query::add_query_filters(); |
|
111 | - // set params that will get used by the filters |
|
112 | - EEH_Event_Query::set_query_params( |
|
113 | - $this->month, |
|
114 | - $this->category_slug, |
|
115 | - $this->show_expired, |
|
116 | - $this->order_by, |
|
117 | - $this->sort |
|
118 | - ); |
|
119 | - } |
|
120 | - |
|
121 | - |
|
122 | - |
|
123 | - private function setupFilters() |
|
124 | - { |
|
125 | - // first off, let's remove any filters from previous queries |
|
126 | - remove_filter( |
|
127 | - 'FHEE__archive_espresso_events_template__show_header', |
|
128 | - array($this, 'show_event_list_title') |
|
129 | - ); |
|
130 | - remove_filter( |
|
131 | - 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
132 | - array($this, 'event_list_title') |
|
133 | - ); |
|
134 | - remove_all_filters('FHEE__content_espresso_events__event_class'); |
|
135 | - // Event List Title ? |
|
136 | - add_filter( |
|
137 | - 'FHEE__archive_espresso_events_template__show_header', |
|
138 | - array($this, 'show_event_list_title') |
|
139 | - ); |
|
140 | - add_filter( |
|
141 | - 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
142 | - array($this, 'event_list_title'), |
|
143 | - 10, |
|
144 | - 1 |
|
145 | - ); |
|
146 | - // add the css class |
|
147 | - add_filter( |
|
148 | - 'FHEE__content_espresso_events__event_class', |
|
149 | - array($this, 'event_list_css'), |
|
150 | - 10, |
|
151 | - 1 |
|
152 | - ); |
|
153 | - } |
|
154 | - |
|
155 | - |
|
156 | - |
|
157 | - private function getQueryArgs(array $args) |
|
158 | - { |
|
159 | - // the current "page" we are viewing |
|
160 | - $paged = max(1, get_query_var('paged')); |
|
161 | - // Force these args |
|
162 | - return array_merge( |
|
163 | - $args, |
|
164 | - array( |
|
165 | - 'post_type' => 'espresso_events', |
|
166 | - 'posts_per_page' => $this->limit, |
|
167 | - 'update_post_term_cache' => false, |
|
168 | - 'update_post_meta_cache' => false, |
|
169 | - 'paged' => $paged, |
|
170 | - 'offset' => ($paged - 1) * $this->limit, |
|
171 | - ) |
|
172 | - ); |
|
173 | - } |
|
174 | - |
|
175 | - |
|
176 | - |
|
177 | - /** |
|
178 | - * show_event_list_title |
|
179 | - * |
|
180 | - * @return boolean |
|
181 | - */ |
|
182 | - public function show_event_list_title() |
|
183 | - { |
|
184 | - return filter_var( |
|
185 | - $this->show_title, |
|
186 | - FILTER_VALIDATE_BOOLEAN |
|
187 | - ); |
|
188 | - } |
|
189 | - |
|
190 | - |
|
191 | - |
|
192 | - /** |
|
193 | - * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter |
|
194 | - * |
|
195 | - * @param string $event_list_title |
|
196 | - * @return string |
|
197 | - */ |
|
198 | - public function event_list_title($event_list_title = '') |
|
199 | - { |
|
200 | - if ( ! empty($this->title)) { |
|
201 | - return $this->title; |
|
202 | - } |
|
203 | - return $event_list_title; |
|
204 | - } |
|
205 | - |
|
206 | - |
|
207 | - |
|
208 | - /** |
|
209 | - * callback for FHEE__content_espresso_events__event_class filter |
|
210 | - * |
|
211 | - * @param string $event_list_css |
|
212 | - * @return string |
|
213 | - */ |
|
214 | - public function event_list_css($event_list_css = '') |
|
215 | - { |
|
216 | - $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
217 | - $event_list_css .= ! empty($this->css_class) ? $this->css_class : ''; |
|
218 | - $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
219 | - $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : ''; |
|
220 | - return $event_list_css; |
|
221 | - } |
|
22 | + /** |
|
23 | + * @var string $title |
|
24 | + */ |
|
25 | + private $title; |
|
26 | + |
|
27 | + /** |
|
28 | + * @var integer $limit |
|
29 | + */ |
|
30 | + private $limit = 10; |
|
31 | + |
|
32 | + /** |
|
33 | + * @var string $css_class |
|
34 | + */ |
|
35 | + private $css_class; |
|
36 | + |
|
37 | + /** |
|
38 | + * @var boolean $show_expired |
|
39 | + */ |
|
40 | + private $show_expired = false; |
|
41 | + |
|
42 | + /** |
|
43 | + * @var string $month |
|
44 | + */ |
|
45 | + private $month; |
|
46 | + |
|
47 | + /** |
|
48 | + * @var string $category_slug |
|
49 | + */ |
|
50 | + private $category_slug; |
|
51 | + |
|
52 | + /** |
|
53 | + * @var string $order_by |
|
54 | + */ |
|
55 | + private $order_by; |
|
56 | + |
|
57 | + /** |
|
58 | + * @var string $sort |
|
59 | + */ |
|
60 | + private $sort; |
|
61 | + |
|
62 | + /** |
|
63 | + * @var boolean $show_title |
|
64 | + */ |
|
65 | + private $show_title = true; |
|
66 | + |
|
67 | + |
|
68 | + |
|
69 | + /** |
|
70 | + * EE_Event_List_Query Constructor * |
|
71 | + * |
|
72 | + * @param array $args |
|
73 | + */ |
|
74 | + public function __construct($args = array()) |
|
75 | + { |
|
76 | + $args = $this->parseArgs((array)$args); |
|
77 | + $this->setupEventQueryHelper(); |
|
78 | + $this->setupFilters(); |
|
79 | + $args = $this->getQueryArgs($args); |
|
80 | + // run the query |
|
81 | + parent::__construct($args); |
|
82 | + } |
|
83 | + |
|
84 | + |
|
85 | + |
|
86 | + /** |
|
87 | + * @param array $args |
|
88 | + * @return array |
|
89 | + */ |
|
90 | + private function parseArgs(array $args) |
|
91 | + { |
|
92 | + // incoming args could be a mix of WP query args + EE shortcode args |
|
93 | + foreach ($args as $property => $value) { |
|
94 | + // if the arg is a property of this class, then it's an EE shortcode arg |
|
95 | + if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) { |
|
96 | + // set the property value |
|
97 | + $this->{$property} = $value; |
|
98 | + // then remove it from the array of args that will later be passed to WP_Query() |
|
99 | + unset($args[$property]); |
|
100 | + } |
|
101 | + } |
|
102 | + return $args; |
|
103 | + } |
|
104 | + |
|
105 | + |
|
106 | + |
|
107 | + private function setupEventQueryHelper() |
|
108 | + { |
|
109 | + //add query filters |
|
110 | + EEH_Event_Query::add_query_filters(); |
|
111 | + // set params that will get used by the filters |
|
112 | + EEH_Event_Query::set_query_params( |
|
113 | + $this->month, |
|
114 | + $this->category_slug, |
|
115 | + $this->show_expired, |
|
116 | + $this->order_by, |
|
117 | + $this->sort |
|
118 | + ); |
|
119 | + } |
|
120 | + |
|
121 | + |
|
122 | + |
|
123 | + private function setupFilters() |
|
124 | + { |
|
125 | + // first off, let's remove any filters from previous queries |
|
126 | + remove_filter( |
|
127 | + 'FHEE__archive_espresso_events_template__show_header', |
|
128 | + array($this, 'show_event_list_title') |
|
129 | + ); |
|
130 | + remove_filter( |
|
131 | + 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
132 | + array($this, 'event_list_title') |
|
133 | + ); |
|
134 | + remove_all_filters('FHEE__content_espresso_events__event_class'); |
|
135 | + // Event List Title ? |
|
136 | + add_filter( |
|
137 | + 'FHEE__archive_espresso_events_template__show_header', |
|
138 | + array($this, 'show_event_list_title') |
|
139 | + ); |
|
140 | + add_filter( |
|
141 | + 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
142 | + array($this, 'event_list_title'), |
|
143 | + 10, |
|
144 | + 1 |
|
145 | + ); |
|
146 | + // add the css class |
|
147 | + add_filter( |
|
148 | + 'FHEE__content_espresso_events__event_class', |
|
149 | + array($this, 'event_list_css'), |
|
150 | + 10, |
|
151 | + 1 |
|
152 | + ); |
|
153 | + } |
|
154 | + |
|
155 | + |
|
156 | + |
|
157 | + private function getQueryArgs(array $args) |
|
158 | + { |
|
159 | + // the current "page" we are viewing |
|
160 | + $paged = max(1, get_query_var('paged')); |
|
161 | + // Force these args |
|
162 | + return array_merge( |
|
163 | + $args, |
|
164 | + array( |
|
165 | + 'post_type' => 'espresso_events', |
|
166 | + 'posts_per_page' => $this->limit, |
|
167 | + 'update_post_term_cache' => false, |
|
168 | + 'update_post_meta_cache' => false, |
|
169 | + 'paged' => $paged, |
|
170 | + 'offset' => ($paged - 1) * $this->limit, |
|
171 | + ) |
|
172 | + ); |
|
173 | + } |
|
174 | + |
|
175 | + |
|
176 | + |
|
177 | + /** |
|
178 | + * show_event_list_title |
|
179 | + * |
|
180 | + * @return boolean |
|
181 | + */ |
|
182 | + public function show_event_list_title() |
|
183 | + { |
|
184 | + return filter_var( |
|
185 | + $this->show_title, |
|
186 | + FILTER_VALIDATE_BOOLEAN |
|
187 | + ); |
|
188 | + } |
|
189 | + |
|
190 | + |
|
191 | + |
|
192 | + /** |
|
193 | + * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter |
|
194 | + * |
|
195 | + * @param string $event_list_title |
|
196 | + * @return string |
|
197 | + */ |
|
198 | + public function event_list_title($event_list_title = '') |
|
199 | + { |
|
200 | + if ( ! empty($this->title)) { |
|
201 | + return $this->title; |
|
202 | + } |
|
203 | + return $event_list_title; |
|
204 | + } |
|
205 | + |
|
206 | + |
|
207 | + |
|
208 | + /** |
|
209 | + * callback for FHEE__content_espresso_events__event_class filter |
|
210 | + * |
|
211 | + * @param string $event_list_css |
|
212 | + * @return string |
|
213 | + */ |
|
214 | + public function event_list_css($event_list_css = '') |
|
215 | + { |
|
216 | + $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
217 | + $event_list_css .= ! empty($this->css_class) ? $this->css_class : ''; |
|
218 | + $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
219 | + $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : ''; |
|
220 | + return $event_list_css; |
|
221 | + } |
|
222 | 222 | |
223 | 223 | } |
224 | 224 | // End of file EventListQuery.php |
@@ -14,132 +14,132 @@ |
||
14 | 14 | class EE_Div_Per_Section_Layout extends EE_Form_Section_Layout_Base |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * opening div tag for a form |
|
19 | - * |
|
20 | - * @return string |
|
21 | - */ |
|
22 | - public function layout_form_begin() |
|
23 | - { |
|
24 | - return EEH_HTML::div( |
|
25 | - '', |
|
26 | - $this->_form_section->html_id(), |
|
27 | - $this->_form_section->html_class(), |
|
28 | - $this->_form_section->html_style() |
|
29 | - ); |
|
30 | - } |
|
31 | - |
|
32 | - |
|
33 | - |
|
34 | - /** |
|
35 | - * Lays out the row for the input, including label and errors |
|
36 | - * |
|
37 | - * @param EE_Form_Input_Base $input |
|
38 | - * @return string |
|
39 | - * @throws \EE_Error |
|
40 | - */ |
|
41 | - public function layout_input($input) |
|
42 | - { |
|
43 | - $html = ''; |
|
44 | - // set something unique for the id |
|
45 | - $html_id = (string)$input->html_id() !== '' |
|
46 | - ? (string)$input->html_id() |
|
47 | - : spl_object_hash($input); |
|
48 | - // and add a generic class |
|
49 | - $html_class = sanitize_key(str_replace('_', '-', get_class($input))) . '-dv'; |
|
50 | - if ($input instanceof EE_Hidden_Input) { |
|
51 | - $html .= EEH_HTML::nl() . $input->get_html_for_input(); |
|
52 | - } else if ($input instanceof EE_Submit_Input) { |
|
53 | - $html .= EEH_HTML::div( |
|
54 | - $input->get_html_for_input(), |
|
55 | - $html_id . '-submit-dv', |
|
56 | - $html_class |
|
57 | - ); |
|
58 | - } else if ($input instanceof EE_Select_Input) { |
|
59 | - $html .= EEH_HTML::div( |
|
60 | - EEH_HTML::nl(1) . $input->get_html_for_label() . |
|
61 | - EEH_HTML::nl() . $input->get_html_for_errors() . |
|
62 | - EEH_HTML::nl() . $input->get_html_for_input() . |
|
63 | - EEH_HTML::nl() . $input->get_html_for_help(), |
|
64 | - $html_id . '-input-dv', |
|
65 | - $html_class |
|
66 | - ); |
|
67 | - } else if ($input instanceof EE_Form_Input_With_Options_Base) { |
|
68 | - $html .= EEH_HTML::div( |
|
69 | - EEH_HTML::nl() . $this->_display_label_for_option_type_question($input) . |
|
70 | - EEH_HTML::nl() . $input->get_html_for_errors() . |
|
71 | - EEH_HTML::nl() . $input->get_html_for_input() . |
|
72 | - EEH_HTML::nl() . $input->get_html_for_help(), |
|
73 | - $html_id . '-input-dv', |
|
74 | - $html_class |
|
75 | - ); |
|
76 | - } else { |
|
77 | - $html .= EEH_HTML::div( |
|
78 | - EEH_HTML::nl(1) . $input->get_html_for_label() . |
|
79 | - EEH_HTML::nl() . $input->get_html_for_errors() . |
|
80 | - EEH_HTML::nl() . $input->get_html_for_input() . |
|
81 | - EEH_HTML::nl() . $input->get_html_for_help(), |
|
82 | - $html_id . '-input-dv', |
|
83 | - $html_class |
|
84 | - ); |
|
85 | - } |
|
86 | - return $html; |
|
87 | - } |
|
88 | - |
|
89 | - |
|
90 | - |
|
91 | - /** |
|
92 | - * |
|
93 | - * _display_label_for_option_type_question |
|
94 | - * Gets the HTML for the 'label', which is just text for this (because labels |
|
95 | - * should be for each input) |
|
96 | - * |
|
97 | - * @param EE_Form_Input_With_Options_Base $input |
|
98 | - * @return string |
|
99 | - */ |
|
100 | - protected function _display_label_for_option_type_question(EE_Form_Input_With_Options_Base $input) |
|
101 | - { |
|
102 | - if ($input->display_html_label_text() !== '') { |
|
103 | - return EEH_HTML::div( |
|
104 | - $input->required() |
|
105 | - ? $input->html_label_text() . EEH_HTML::span('*', '', 'ee-asterisk') |
|
106 | - : $input->html_label_text(), |
|
107 | - $input->html_label_id(), |
|
108 | - $input->required() |
|
109 | - ? 'ee-required-label ' . $input->html_label_class() |
|
110 | - : $input->html_label_class(), |
|
111 | - $input->html_label_style(), |
|
112 | - $input->html_other_attributes() |
|
113 | - ); |
|
114 | - } |
|
115 | - return ''; |
|
116 | - } |
|
117 | - |
|
118 | - |
|
119 | - |
|
120 | - /** |
|
121 | - * Lays out a row for the subsection |
|
122 | - * |
|
123 | - * @param EE_Form_Section_Proper $form_section |
|
124 | - * @return string |
|
125 | - */ |
|
126 | - public function layout_subsection($form_section) |
|
127 | - { |
|
128 | - // d( $form_section ); |
|
129 | - return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1); |
|
130 | - } |
|
131 | - |
|
132 | - |
|
133 | - |
|
134 | - /** |
|
135 | - * closing div tag for a form |
|
136 | - * |
|
137 | - * @return string |
|
138 | - */ |
|
139 | - public function layout_form_end() |
|
140 | - { |
|
141 | - return EEH_HTML::divx($this->_form_section->html_id(), $this->_form_section->html_class()); |
|
142 | - } |
|
17 | + /** |
|
18 | + * opening div tag for a form |
|
19 | + * |
|
20 | + * @return string |
|
21 | + */ |
|
22 | + public function layout_form_begin() |
|
23 | + { |
|
24 | + return EEH_HTML::div( |
|
25 | + '', |
|
26 | + $this->_form_section->html_id(), |
|
27 | + $this->_form_section->html_class(), |
|
28 | + $this->_form_section->html_style() |
|
29 | + ); |
|
30 | + } |
|
31 | + |
|
32 | + |
|
33 | + |
|
34 | + /** |
|
35 | + * Lays out the row for the input, including label and errors |
|
36 | + * |
|
37 | + * @param EE_Form_Input_Base $input |
|
38 | + * @return string |
|
39 | + * @throws \EE_Error |
|
40 | + */ |
|
41 | + public function layout_input($input) |
|
42 | + { |
|
43 | + $html = ''; |
|
44 | + // set something unique for the id |
|
45 | + $html_id = (string)$input->html_id() !== '' |
|
46 | + ? (string)$input->html_id() |
|
47 | + : spl_object_hash($input); |
|
48 | + // and add a generic class |
|
49 | + $html_class = sanitize_key(str_replace('_', '-', get_class($input))) . '-dv'; |
|
50 | + if ($input instanceof EE_Hidden_Input) { |
|
51 | + $html .= EEH_HTML::nl() . $input->get_html_for_input(); |
|
52 | + } else if ($input instanceof EE_Submit_Input) { |
|
53 | + $html .= EEH_HTML::div( |
|
54 | + $input->get_html_for_input(), |
|
55 | + $html_id . '-submit-dv', |
|
56 | + $html_class |
|
57 | + ); |
|
58 | + } else if ($input instanceof EE_Select_Input) { |
|
59 | + $html .= EEH_HTML::div( |
|
60 | + EEH_HTML::nl(1) . $input->get_html_for_label() . |
|
61 | + EEH_HTML::nl() . $input->get_html_for_errors() . |
|
62 | + EEH_HTML::nl() . $input->get_html_for_input() . |
|
63 | + EEH_HTML::nl() . $input->get_html_for_help(), |
|
64 | + $html_id . '-input-dv', |
|
65 | + $html_class |
|
66 | + ); |
|
67 | + } else if ($input instanceof EE_Form_Input_With_Options_Base) { |
|
68 | + $html .= EEH_HTML::div( |
|
69 | + EEH_HTML::nl() . $this->_display_label_for_option_type_question($input) . |
|
70 | + EEH_HTML::nl() . $input->get_html_for_errors() . |
|
71 | + EEH_HTML::nl() . $input->get_html_for_input() . |
|
72 | + EEH_HTML::nl() . $input->get_html_for_help(), |
|
73 | + $html_id . '-input-dv', |
|
74 | + $html_class |
|
75 | + ); |
|
76 | + } else { |
|
77 | + $html .= EEH_HTML::div( |
|
78 | + EEH_HTML::nl(1) . $input->get_html_for_label() . |
|
79 | + EEH_HTML::nl() . $input->get_html_for_errors() . |
|
80 | + EEH_HTML::nl() . $input->get_html_for_input() . |
|
81 | + EEH_HTML::nl() . $input->get_html_for_help(), |
|
82 | + $html_id . '-input-dv', |
|
83 | + $html_class |
|
84 | + ); |
|
85 | + } |
|
86 | + return $html; |
|
87 | + } |
|
88 | + |
|
89 | + |
|
90 | + |
|
91 | + /** |
|
92 | + * |
|
93 | + * _display_label_for_option_type_question |
|
94 | + * Gets the HTML for the 'label', which is just text for this (because labels |
|
95 | + * should be for each input) |
|
96 | + * |
|
97 | + * @param EE_Form_Input_With_Options_Base $input |
|
98 | + * @return string |
|
99 | + */ |
|
100 | + protected function _display_label_for_option_type_question(EE_Form_Input_With_Options_Base $input) |
|
101 | + { |
|
102 | + if ($input->display_html_label_text() !== '') { |
|
103 | + return EEH_HTML::div( |
|
104 | + $input->required() |
|
105 | + ? $input->html_label_text() . EEH_HTML::span('*', '', 'ee-asterisk') |
|
106 | + : $input->html_label_text(), |
|
107 | + $input->html_label_id(), |
|
108 | + $input->required() |
|
109 | + ? 'ee-required-label ' . $input->html_label_class() |
|
110 | + : $input->html_label_class(), |
|
111 | + $input->html_label_style(), |
|
112 | + $input->html_other_attributes() |
|
113 | + ); |
|
114 | + } |
|
115 | + return ''; |
|
116 | + } |
|
117 | + |
|
118 | + |
|
119 | + |
|
120 | + /** |
|
121 | + * Lays out a row for the subsection |
|
122 | + * |
|
123 | + * @param EE_Form_Section_Proper $form_section |
|
124 | + * @return string |
|
125 | + */ |
|
126 | + public function layout_subsection($form_section) |
|
127 | + { |
|
128 | + // d( $form_section ); |
|
129 | + return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1); |
|
130 | + } |
|
131 | + |
|
132 | + |
|
133 | + |
|
134 | + /** |
|
135 | + * closing div tag for a form |
|
136 | + * |
|
137 | + * @return string |
|
138 | + */ |
|
139 | + public function layout_form_end() |
|
140 | + { |
|
141 | + return EEH_HTML::divx($this->_form_section->html_id(), $this->_form_section->html_class()); |
|
142 | + } |
|
143 | 143 | |
144 | 144 | |
145 | 145 |
@@ -42,44 +42,44 @@ discard block |
||
42 | 42 | { |
43 | 43 | $html = ''; |
44 | 44 | // set something unique for the id |
45 | - $html_id = (string)$input->html_id() !== '' |
|
46 | - ? (string)$input->html_id() |
|
45 | + $html_id = (string) $input->html_id() !== '' |
|
46 | + ? (string) $input->html_id() |
|
47 | 47 | : spl_object_hash($input); |
48 | 48 | // and add a generic class |
49 | - $html_class = sanitize_key(str_replace('_', '-', get_class($input))) . '-dv'; |
|
49 | + $html_class = sanitize_key(str_replace('_', '-', get_class($input))).'-dv'; |
|
50 | 50 | if ($input instanceof EE_Hidden_Input) { |
51 | - $html .= EEH_HTML::nl() . $input->get_html_for_input(); |
|
51 | + $html .= EEH_HTML::nl().$input->get_html_for_input(); |
|
52 | 52 | } else if ($input instanceof EE_Submit_Input) { |
53 | 53 | $html .= EEH_HTML::div( |
54 | 54 | $input->get_html_for_input(), |
55 | - $html_id . '-submit-dv', |
|
55 | + $html_id.'-submit-dv', |
|
56 | 56 | $html_class |
57 | 57 | ); |
58 | 58 | } else if ($input instanceof EE_Select_Input) { |
59 | 59 | $html .= EEH_HTML::div( |
60 | - EEH_HTML::nl(1) . $input->get_html_for_label() . |
|
61 | - EEH_HTML::nl() . $input->get_html_for_errors() . |
|
62 | - EEH_HTML::nl() . $input->get_html_for_input() . |
|
63 | - EEH_HTML::nl() . $input->get_html_for_help(), |
|
64 | - $html_id . '-input-dv', |
|
60 | + EEH_HTML::nl(1).$input->get_html_for_label(). |
|
61 | + EEH_HTML::nl().$input->get_html_for_errors(). |
|
62 | + EEH_HTML::nl().$input->get_html_for_input(). |
|
63 | + EEH_HTML::nl().$input->get_html_for_help(), |
|
64 | + $html_id.'-input-dv', |
|
65 | 65 | $html_class |
66 | 66 | ); |
67 | 67 | } else if ($input instanceof EE_Form_Input_With_Options_Base) { |
68 | 68 | $html .= EEH_HTML::div( |
69 | - EEH_HTML::nl() . $this->_display_label_for_option_type_question($input) . |
|
70 | - EEH_HTML::nl() . $input->get_html_for_errors() . |
|
71 | - EEH_HTML::nl() . $input->get_html_for_input() . |
|
72 | - EEH_HTML::nl() . $input->get_html_for_help(), |
|
73 | - $html_id . '-input-dv', |
|
69 | + EEH_HTML::nl().$this->_display_label_for_option_type_question($input). |
|
70 | + EEH_HTML::nl().$input->get_html_for_errors(). |
|
71 | + EEH_HTML::nl().$input->get_html_for_input(). |
|
72 | + EEH_HTML::nl().$input->get_html_for_help(), |
|
73 | + $html_id.'-input-dv', |
|
74 | 74 | $html_class |
75 | 75 | ); |
76 | 76 | } else { |
77 | 77 | $html .= EEH_HTML::div( |
78 | - EEH_HTML::nl(1) . $input->get_html_for_label() . |
|
79 | - EEH_HTML::nl() . $input->get_html_for_errors() . |
|
80 | - EEH_HTML::nl() . $input->get_html_for_input() . |
|
81 | - EEH_HTML::nl() . $input->get_html_for_help(), |
|
82 | - $html_id . '-input-dv', |
|
78 | + EEH_HTML::nl(1).$input->get_html_for_label(). |
|
79 | + EEH_HTML::nl().$input->get_html_for_errors(). |
|
80 | + EEH_HTML::nl().$input->get_html_for_input(). |
|
81 | + EEH_HTML::nl().$input->get_html_for_help(), |
|
82 | + $html_id.'-input-dv', |
|
83 | 83 | $html_class |
84 | 84 | ); |
85 | 85 | } |
@@ -102,11 +102,11 @@ discard block |
||
102 | 102 | if ($input->display_html_label_text() !== '') { |
103 | 103 | return EEH_HTML::div( |
104 | 104 | $input->required() |
105 | - ? $input->html_label_text() . EEH_HTML::span('*', '', 'ee-asterisk') |
|
105 | + ? $input->html_label_text().EEH_HTML::span('*', '', 'ee-asterisk') |
|
106 | 106 | : $input->html_label_text(), |
107 | 107 | $input->html_label_id(), |
108 | 108 | $input->required() |
109 | - ? 'ee-required-label ' . $input->html_label_class() |
|
109 | + ? 'ee-required-label '.$input->html_label_class() |
|
110 | 110 | : $input->html_label_class(), |
111 | 111 | $input->html_label_style(), |
112 | 112 | $input->html_other_attributes() |
@@ -126,7 +126,7 @@ discard block |
||
126 | 126 | public function layout_subsection($form_section) |
127 | 127 | { |
128 | 128 | // d( $form_section ); |
129 | - return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1); |
|
129 | + return EEH_HTML::nl(1).$form_section->get_html().EEH_HTML::nl(-1); |
|
130 | 130 | } |
131 | 131 | |
132 | 132 |
@@ -1047,11 +1047,11 @@ discard block |
||
1047 | 1047 | 'filter' |
1048 | 1048 | ); |
1049 | 1049 | return apply_filters( |
1050 | - 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee', |
|
1051 | - $existing_attendee, $registration, $attendee_data |
|
1052 | - ); |
|
1050 | + 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee', |
|
1051 | + $existing_attendee, $registration, $attendee_data |
|
1052 | + ); |
|
1053 | 1053 | }, |
1054 | - 10,3 |
|
1054 | + 10,3 |
|
1055 | 1055 | ); |
1056 | 1056 | |
1057 | 1057 | |
@@ -1064,88 +1064,88 @@ discard block |
||
1064 | 1064 | class EE_Event_List_Query extends WP_Query |
1065 | 1065 | { |
1066 | 1066 | |
1067 | - private $title; |
|
1068 | - |
|
1069 | - private $css_class; |
|
1070 | - |
|
1071 | - private $category_slug; |
|
1072 | - |
|
1073 | - /** |
|
1074 | - * EE_Event_List_Query constructor. |
|
1075 | - * |
|
1076 | - * @param array $args |
|
1077 | - */ |
|
1078 | - public function __construct($args = array()) |
|
1079 | - { |
|
1080 | - \EE_Error::doing_it_wrong( |
|
1081 | - __METHOD__, |
|
1082 | - __( |
|
1083 | - 'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.', |
|
1084 | - 'event_espresso' |
|
1085 | - ), |
|
1086 | - '4.9.27', |
|
1087 | - '5.0.0' |
|
1088 | - ); |
|
1089 | - $this->title = isset($args['title']) ? $args['title'] : ''; |
|
1090 | - $this->css_class = isset($args['css_class']) ? $args['css_class'] : ''; |
|
1091 | - $this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : ''; |
|
1092 | - $limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10; |
|
1093 | - // the current "page" we are viewing |
|
1094 | - $paged = max(1, get_query_var('paged')); |
|
1095 | - // Force these args |
|
1096 | - $args = array_merge( |
|
1097 | - $args, array( |
|
1098 | - 'post_type' => 'espresso_events', |
|
1099 | - 'posts_per_page' => $limit, |
|
1100 | - 'update_post_term_cache' => false, |
|
1101 | - 'update_post_meta_cache' => false, |
|
1102 | - 'paged' => $paged, |
|
1103 | - 'offset' => ($paged - 1) * $limit |
|
1104 | - ) |
|
1105 | - ); |
|
1106 | - // run the query |
|
1107 | - parent::__construct($args); |
|
1108 | - } |
|
1109 | - |
|
1110 | - |
|
1111 | - |
|
1112 | - /** |
|
1113 | - * event_list_title |
|
1114 | - * |
|
1115 | - * @param string $event_list_title |
|
1116 | - * @return string |
|
1117 | - */ |
|
1118 | - public function event_list_title($event_list_title = '') |
|
1119 | - { |
|
1120 | - if (! empty($this->title)) { |
|
1121 | - return $this->title; |
|
1122 | - } |
|
1123 | - return $event_list_title; |
|
1124 | - } |
|
1125 | - |
|
1126 | - |
|
1127 | - |
|
1128 | - /** |
|
1129 | - * event_list_css |
|
1130 | - * |
|
1131 | - * @param string $event_list_css |
|
1132 | - * @return string |
|
1133 | - */ |
|
1134 | - public function event_list_css($event_list_css = '') |
|
1135 | - { |
|
1136 | - $event_list_css .= ! empty($event_list_css) |
|
1137 | - ? ' ' |
|
1138 | - : ''; |
|
1139 | - $event_list_css .= ! empty($this->css_class) |
|
1140 | - ? $this->css_class |
|
1141 | - : ''; |
|
1142 | - $event_list_css .= ! empty($event_list_css) |
|
1143 | - ? ' ' |
|
1144 | - : ''; |
|
1145 | - $event_list_css .= ! empty($this->category_slug) |
|
1146 | - ? $this->category_slug |
|
1147 | - : ''; |
|
1148 | - return $event_list_css; |
|
1149 | - } |
|
1067 | + private $title; |
|
1068 | + |
|
1069 | + private $css_class; |
|
1070 | + |
|
1071 | + private $category_slug; |
|
1072 | + |
|
1073 | + /** |
|
1074 | + * EE_Event_List_Query constructor. |
|
1075 | + * |
|
1076 | + * @param array $args |
|
1077 | + */ |
|
1078 | + public function __construct($args = array()) |
|
1079 | + { |
|
1080 | + \EE_Error::doing_it_wrong( |
|
1081 | + __METHOD__, |
|
1082 | + __( |
|
1083 | + 'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.', |
|
1084 | + 'event_espresso' |
|
1085 | + ), |
|
1086 | + '4.9.27', |
|
1087 | + '5.0.0' |
|
1088 | + ); |
|
1089 | + $this->title = isset($args['title']) ? $args['title'] : ''; |
|
1090 | + $this->css_class = isset($args['css_class']) ? $args['css_class'] : ''; |
|
1091 | + $this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : ''; |
|
1092 | + $limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10; |
|
1093 | + // the current "page" we are viewing |
|
1094 | + $paged = max(1, get_query_var('paged')); |
|
1095 | + // Force these args |
|
1096 | + $args = array_merge( |
|
1097 | + $args, array( |
|
1098 | + 'post_type' => 'espresso_events', |
|
1099 | + 'posts_per_page' => $limit, |
|
1100 | + 'update_post_term_cache' => false, |
|
1101 | + 'update_post_meta_cache' => false, |
|
1102 | + 'paged' => $paged, |
|
1103 | + 'offset' => ($paged - 1) * $limit |
|
1104 | + ) |
|
1105 | + ); |
|
1106 | + // run the query |
|
1107 | + parent::__construct($args); |
|
1108 | + } |
|
1109 | + |
|
1110 | + |
|
1111 | + |
|
1112 | + /** |
|
1113 | + * event_list_title |
|
1114 | + * |
|
1115 | + * @param string $event_list_title |
|
1116 | + * @return string |
|
1117 | + */ |
|
1118 | + public function event_list_title($event_list_title = '') |
|
1119 | + { |
|
1120 | + if (! empty($this->title)) { |
|
1121 | + return $this->title; |
|
1122 | + } |
|
1123 | + return $event_list_title; |
|
1124 | + } |
|
1125 | + |
|
1126 | + |
|
1127 | + |
|
1128 | + /** |
|
1129 | + * event_list_css |
|
1130 | + * |
|
1131 | + * @param string $event_list_css |
|
1132 | + * @return string |
|
1133 | + */ |
|
1134 | + public function event_list_css($event_list_css = '') |
|
1135 | + { |
|
1136 | + $event_list_css .= ! empty($event_list_css) |
|
1137 | + ? ' ' |
|
1138 | + : ''; |
|
1139 | + $event_list_css .= ! empty($this->css_class) |
|
1140 | + ? $this->css_class |
|
1141 | + : ''; |
|
1142 | + $event_list_css .= ! empty($event_list_css) |
|
1143 | + ? ' ' |
|
1144 | + : ''; |
|
1145 | + $event_list_css .= ! empty($this->category_slug) |
|
1146 | + ? $this->category_slug |
|
1147 | + : ''; |
|
1148 | + return $event_list_css; |
|
1149 | + } |
|
1150 | 1150 | |
1151 | 1151 | } |
@@ -1,6 +1,6 @@ discard block |
||
1 | 1 | <?php |
2 | -if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) { |
|
3 | - exit( 'No direct script access allowed' ); |
|
2 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
3 | + exit('No direct script access allowed'); |
|
4 | 4 | } |
5 | 5 | /** |
6 | 6 | * ************************************************************************ |
@@ -43,8 +43,8 @@ discard block |
||
43 | 43 | $action_or_filter = 'action' |
44 | 44 | ) { |
45 | 45 | $action_or_filter = $action_or_filter === 'action' |
46 | - ? esc_html__( 'action', 'event_espresso' ) |
|
47 | - : esc_html__( 'filter', 'event_espresso' ); |
|
46 | + ? esc_html__('action', 'event_espresso') |
|
47 | + : esc_html__('filter', 'event_espresso'); |
|
48 | 48 | EE_Error::doing_it_wrong( |
49 | 49 | $deprecated_filter, |
50 | 50 | sprintf( |
@@ -68,7 +68,7 @@ discard block |
||
68 | 68 | * @param \EE_Checkout $checkout |
69 | 69 | * @return string |
70 | 70 | */ |
71 | -function ee_deprecated__registration_checkout__button_text( $submit_button_text, EE_Checkout $checkout ) { |
|
71 | +function ee_deprecated__registration_checkout__button_text($submit_button_text, EE_Checkout $checkout) { |
|
72 | 72 | // list of old filters |
73 | 73 | $deprecated_filters = array( |
74 | 74 | 'update_registration_details' => true, |
@@ -78,16 +78,16 @@ discard block |
||
78 | 78 | 'proceed_to' => true, |
79 | 79 | ); |
80 | 80 | // loop thru and call doing_it_wrong() or remove any that aren't being used |
81 | - foreach ( $deprecated_filters as $deprecated_filter => $on ) { |
|
81 | + foreach ($deprecated_filters as $deprecated_filter => $on) { |
|
82 | 82 | // was this filter called ? |
83 | - if ( has_action( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter )) { |
|
83 | + if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter)) { |
|
84 | 84 | // only display doing_it_wrong() notice to Event Admins during non-AJAX requests |
85 | - if ( EE_Registry::instance()->CAP->current_user_can( 'ee_read_ee', 'hide_doing_it_wrong_for_deprecated_SPCO_filter' ) && ! defined( 'DOING_AJAX' ) ) { |
|
85 | + if (EE_Registry::instance()->CAP->current_user_can('ee_read_ee', 'hide_doing_it_wrong_for_deprecated_SPCO_filter') && ! defined('DOING_AJAX')) { |
|
86 | 86 | EE_Error::doing_it_wrong( |
87 | - 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter, |
|
87 | + 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter, |
|
88 | 88 | sprintf( |
89 | - __( 'The %1$s filter is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"', 'event_espresso' ), |
|
90 | - 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter, |
|
89 | + __('The %1$s filter is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"', 'event_espresso'), |
|
90 | + 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter, |
|
91 | 91 | '<br />', |
92 | 92 | 'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', |
93 | 93 | '/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php' |
@@ -96,24 +96,24 @@ discard block |
||
96 | 96 | ); |
97 | 97 | } |
98 | 98 | } else { |
99 | - unset( $deprecated_filters[ $deprecated_filter ] ); |
|
99 | + unset($deprecated_filters[$deprecated_filter]); |
|
100 | 100 | } |
101 | 101 | } |
102 | - if ( ! empty( $deprecated_filters )) { |
|
103 | - |
|
104 | - if ( $checkout->current_step->slug() == 'attendee_information' && $checkout->revisit && isset( $deprecated_filters[ 'update_registration_details' ] )) { |
|
105 | - $submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details', $submit_button_text ); |
|
106 | - } else if ( $checkout->current_step->slug() == 'payment_options' && $checkout->revisit && isset( $deprecated_filters[ 'process_payment' ] ) ) { |
|
107 | - $submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment', $submit_button_text ); |
|
108 | - } else if ( $checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug() == 'finalize_registration' && isset( $deprecated_filters[ 'finalize_registration' ] ) ) { |
|
109 | - $submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration', $submit_button_text ); |
|
102 | + if ( ! empty($deprecated_filters)) { |
|
103 | + |
|
104 | + if ($checkout->current_step->slug() == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) { |
|
105 | + $submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details', $submit_button_text); |
|
106 | + } else if ($checkout->current_step->slug() == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) { |
|
107 | + $submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment', $submit_button_text); |
|
108 | + } else if ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug() == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) { |
|
109 | + $submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration', $submit_button_text); |
|
110 | 110 | } |
111 | - if ( $checkout->next_step instanceof EE_SPCO_Reg_Step ) { |
|
112 | - if ( $checkout->payment_required() && $checkout->next_step->slug() == 'payment_options' && isset( $deprecated_filters[ 'and_proceed_to_payment' ] ) ) { |
|
113 | - $submit_button_text .= apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment', $submit_button_text ); |
|
111 | + if ($checkout->next_step instanceof EE_SPCO_Reg_Step) { |
|
112 | + if ($checkout->payment_required() && $checkout->next_step->slug() == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) { |
|
113 | + $submit_button_text .= apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment', $submit_button_text); |
|
114 | 114 | } |
115 | - if ( $checkout->next_step->slug() != 'finalize_registration' && ! $checkout->revisit && isset( $deprecated_filters[ 'proceed_to' ] ) ) { |
|
116 | - $submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to', $submit_button_text ) . $checkout->next_step->name(); |
|
115 | + if ($checkout->next_step->slug() != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) { |
|
116 | + $submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to', $submit_button_text).$checkout->next_step->name(); |
|
117 | 117 | } |
118 | 118 | } |
119 | 119 | |
@@ -121,7 +121,7 @@ discard block |
||
121 | 121 | return $submit_button_text; |
122 | 122 | |
123 | 123 | } |
124 | -add_filter( 'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', 'ee_deprecated__registration_checkout__button_text', 10, 2 ); |
|
124 | +add_filter('FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', 'ee_deprecated__registration_checkout__button_text', 10, 2); |
|
125 | 125 | |
126 | 126 | |
127 | 127 | |
@@ -132,16 +132,16 @@ discard block |
||
132 | 132 | * @param \EE_Checkout $checkout |
133 | 133 | * @param boolean $status_updates |
134 | 134 | */ |
135 | -function ee_deprecated_finalize_transaction( EE_Checkout $checkout, $status_updates ) { |
|
135 | +function ee_deprecated_finalize_transaction(EE_Checkout $checkout, $status_updates) { |
|
136 | 136 | $action_ref = NULL; |
137 | - $action_ref = has_action( 'AHEE__EE_Transaction__finalize__new_transaction' ) ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref; |
|
138 | - $action_ref = has_action( 'AHEE__EE_Transaction__finalize__all_transaction' ) ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref; |
|
139 | - if ( $action_ref ) { |
|
137 | + $action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction') ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref; |
|
138 | + $action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction') ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref; |
|
139 | + if ($action_ref) { |
|
140 | 140 | |
141 | 141 | EE_Error::doing_it_wrong( |
142 | 142 | $action_ref, |
143 | 143 | sprintf( |
144 | - __( 'This action is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"', 'event_espresso' ), |
|
144 | + __('This action is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"', 'event_espresso'), |
|
145 | 145 | '<br />', |
146 | 146 | '/core/business/EE_Transaction_Processor.class.php', |
147 | 147 | 'AHEE__EE_Transaction_Processor__finalize', |
@@ -151,39 +151,39 @@ discard block |
||
151 | 151 | ), |
152 | 152 | '4.6.0' |
153 | 153 | ); |
154 | - switch ( $action_ref ) { |
|
154 | + switch ($action_ref) { |
|
155 | 155 | case 'AHEE__EE_Transaction__finalize__new_transaction' : |
156 | - do_action( 'AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, $checkout->admin_request ); |
|
156 | + do_action('AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, $checkout->admin_request); |
|
157 | 157 | break; |
158 | 158 | case 'AHEE__EE_Transaction__finalize__all_transaction' : |
159 | - do_action( 'AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, array( 'new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates ), $checkout->admin_request ); |
|
159 | + do_action('AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates), $checkout->admin_request); |
|
160 | 160 | break; |
161 | 161 | } |
162 | 162 | } |
163 | 163 | } |
164 | -add_action( 'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed', 'ee_deprecated_finalize_transaction', 10, 2 ); |
|
164 | +add_action('AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed', 'ee_deprecated_finalize_transaction', 10, 2); |
|
165 | 165 | /** |
166 | 166 | * ee_deprecated_finalize_registration |
167 | 167 | * |
168 | 168 | * @param EE_Registration $registration |
169 | 169 | */ |
170 | -function ee_deprecated_finalize_registration( EE_Registration $registration ) { |
|
171 | - $action_ref = has_action( 'AHEE__EE_Registration__finalize__update_and_new_reg' ) ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : NULL; |
|
172 | - if ( $action_ref ) { |
|
170 | +function ee_deprecated_finalize_registration(EE_Registration $registration) { |
|
171 | + $action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg') ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : NULL; |
|
172 | + if ($action_ref) { |
|
173 | 173 | EE_Error::doing_it_wrong( |
174 | 174 | $action_ref, |
175 | 175 | sprintf( |
176 | - __( 'This action is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"', 'event_espresso' ), |
|
176 | + __('This action is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"', 'event_espresso'), |
|
177 | 177 | '<br />', |
178 | 178 | '/core/business/EE_Registration_Processor.class.php', |
179 | 179 | 'AHEE__EE_Registration_Processor__trigger_registration_status_changed_hook' |
180 | 180 | ), |
181 | 181 | '4.6.0' |
182 | 182 | ); |
183 | - do_action( 'AHEE__EE_Registration__finalize__update_and_new_reg', $registration, ( is_admin() && ! ( defined( 'DOING_AJAX' ) && DOING_AJAX ))); |
|
183 | + do_action('AHEE__EE_Registration__finalize__update_and_new_reg', $registration, (is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX))); |
|
184 | 184 | } |
185 | 185 | } |
186 | -add_action( 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications', 'ee_deprecated_finalize_registration', 10, 1 ); |
|
186 | +add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications', 'ee_deprecated_finalize_registration', 10, 1); |
|
187 | 187 | |
188 | 188 | |
189 | 189 | |
@@ -191,7 +191,7 @@ discard block |
||
191 | 191 | * Called after EED_Module::set_hooks() and EED_Module::set_admin_hooks() was called. |
192 | 192 | * Checks if any deprecated hooks were hooked-into and provide doing_it_wrong messages appropriately. |
193 | 193 | */ |
194 | -function ee_deprecated_hooks(){ |
|
194 | +function ee_deprecated_hooks() { |
|
195 | 195 | /** |
196 | 196 | * @var $hooks array where keys are hook names, and their values are array{ |
197 | 197 | * @type string $version when deprecated |
@@ -202,25 +202,25 @@ discard block |
||
202 | 202 | $hooks = array( |
203 | 203 | 'AHEE__EE_System___do_setup_validations' => array( |
204 | 204 | 'version' => '4.6.0', |
205 | - 'alternative' => __( 'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)', 'event_espresso' ), |
|
205 | + 'alternative' => __('Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)', 'event_espresso'), |
|
206 | 206 | 'still_works' => FALSE |
207 | 207 | ) |
208 | 208 | ); |
209 | - foreach( $hooks as $name => $deprecation_info ){ |
|
210 | - if( has_action( $name ) ){ |
|
209 | + foreach ($hooks as $name => $deprecation_info) { |
|
210 | + if (has_action($name)) { |
|
211 | 211 | EE_Error::doing_it_wrong( |
212 | 212 | $name, |
213 | 213 | sprintf( |
214 | - __('This filter is deprecated. %1$s%2$s','event_espresso'), |
|
215 | - $deprecation_info[ 'still_works' ] ? __('It *may* work as an attempt to build in backwards compatibility.', 'event_espresso') : __( 'It has been completely removed.', 'event_espresso' ), |
|
216 | - isset( $deprecation_info[ 'alternative' ] ) ? $deprecation_info[ 'alternative' ] : __( 'Please read the current EE4 documentation further or contact Support.', 'event_espresso' ) |
|
214 | + __('This filter is deprecated. %1$s%2$s', 'event_espresso'), |
|
215 | + $deprecation_info['still_works'] ? __('It *may* work as an attempt to build in backwards compatibility.', 'event_espresso') : __('It has been completely removed.', 'event_espresso'), |
|
216 | + isset($deprecation_info['alternative']) ? $deprecation_info['alternative'] : __('Please read the current EE4 documentation further or contact Support.', 'event_espresso') |
|
217 | 217 | ), |
218 | - isset( $deprecation_info[ 'version' ] ) ? $deprecation_info[ 'version' ] : __( 'recently', 'event_espresso' ) |
|
218 | + isset($deprecation_info['version']) ? $deprecation_info['version'] : __('recently', 'event_espresso') |
|
219 | 219 | ); |
220 | 220 | } |
221 | 221 | } |
222 | 222 | } |
223 | -add_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', 'ee_deprecated_hooks' ); |
|
223 | +add_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', 'ee_deprecated_hooks'); |
|
224 | 224 | |
225 | 225 | |
226 | 226 | |
@@ -231,9 +231,9 @@ discard block |
||
231 | 231 | * @return boolean |
232 | 232 | */ |
233 | 233 | function ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() { |
234 | - $in_use = has_filter( 'FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns' ) |
|
235 | - || has_action( 'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save' ); |
|
236 | - if( $in_use ) { |
|
234 | + $in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns') |
|
235 | + || has_action('AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save'); |
|
236 | + if ($in_use) { |
|
237 | 237 | $msg = __( |
238 | 238 | 'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.' |
239 | 239 | . 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,' |
@@ -242,18 +242,18 @@ discard block |
||
242 | 242 | 'event_espresso' ) |
243 | 243 | ; |
244 | 244 | EE_Error::doing_it_wrong( |
245 | - __CLASS__ . '::' . __FUNCTION__, |
|
245 | + __CLASS__.'::'.__FUNCTION__, |
|
246 | 246 | $msg, |
247 | 247 | '4.8.32.rc.000' |
248 | 248 | ); |
249 | 249 | //it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed |
250 | - if ( is_admin() && ! defined( 'DOING_AJAX' ) ) { |
|
251 | - EE_Error::add_error( $msg, __FILE__, __FUNCTION__, __LINE__ ); |
|
250 | + if (is_admin() && ! defined('DOING_AJAX')) { |
|
251 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
252 | 252 | } |
253 | 253 | } |
254 | 254 | return $in_use; |
255 | 255 | } |
256 | -add_action( 'AHEE__Registrations_Admin_Page___registration_details_metabox__start', 'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks' ); |
|
256 | +add_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', 'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks'); |
|
257 | 257 | |
258 | 258 | /** |
259 | 259 | * @deprecated since 4.8.32.rc.000 because it has issues on https://events.codebasehq.com/projects/event-espresso/tickets/9165 |
@@ -262,34 +262,34 @@ discard block |
||
262 | 262 | * @param EE_Admin_Page $admin_page |
263 | 263 | * @return void |
264 | 264 | */ |
265 | -function ee_deprecated_update_attendee_registration_form_old( $admin_page ) { |
|
265 | +function ee_deprecated_update_attendee_registration_form_old($admin_page) { |
|
266 | 266 | //check if the old hooks are in use. If not, do the default |
267 | - if( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
268 | - || ! $admin_page instanceof EE_Admin_Page ) { |
|
267 | + if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
268 | + || ! $admin_page instanceof EE_Admin_Page) { |
|
269 | 269 | return; |
270 | 270 | } |
271 | 271 | $req_data = $admin_page->get_request_data(); |
272 | - $qstns = isset( $req_data['qstn'] ) ? $req_data['qstn'] : FALSE; |
|
273 | - $REG_ID = isset( $req_data['_REG_ID'] ) ? absint( $req_data['_REG_ID'] ) : FALSE; |
|
274 | - $qstns = apply_filters( 'FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns ); |
|
275 | - if ( ! $REG_ID || ! $qstns ) { |
|
276 | - EE_Error::add_error( __('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__ ); |
|
272 | + $qstns = isset($req_data['qstn']) ? $req_data['qstn'] : FALSE; |
|
273 | + $REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : FALSE; |
|
274 | + $qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns); |
|
275 | + if ( ! $REG_ID || ! $qstns) { |
|
276 | + EE_Error::add_error(__('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
277 | 277 | } |
278 | 278 | $success = TRUE; |
279 | 279 | |
280 | 280 | // allow others to get in on this awesome fun :D |
281 | - do_action( 'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save', $REG_ID, $qstns ); |
|
281 | + do_action('AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save', $REG_ID, $qstns); |
|
282 | 282 | // loop thru questions... FINALLY!!! |
283 | 283 | |
284 | - foreach ( $qstns as $QST_ID => $qstn ) { |
|
284 | + foreach ($qstns as $QST_ID => $qstn) { |
|
285 | 285 | //if $qstn isn't an array then it doesn't already have an answer, so let's create the answer |
286 | - if ( !is_array($qstn) ) { |
|
287 | - $success = $this->_save_new_answer( $REG_ID, $QST_ID, $qstn); |
|
286 | + if ( ! is_array($qstn)) { |
|
287 | + $success = $this->_save_new_answer($REG_ID, $QST_ID, $qstn); |
|
288 | 288 | continue; |
289 | 289 | } |
290 | 290 | |
291 | 291 | |
292 | - foreach ( $qstn as $ANS_ID => $ANS_value ) { |
|
292 | + foreach ($qstn as $ANS_ID => $ANS_value) { |
|
293 | 293 | //get answer |
294 | 294 | $query_params = array( |
295 | 295 | 0 => array( |
@@ -300,7 +300,7 @@ discard block |
||
300 | 300 | ); |
301 | 301 | $answer = EEM_Answer::instance()->get_one($query_params); |
302 | 302 | //this MAY be an array but NOT have an answer because its multi select. If so then we need to create the answer |
303 | - if ( ! $answer instanceof EE_Answer ) { |
|
303 | + if ( ! $answer instanceof EE_Answer) { |
|
304 | 304 | $set_values = array( |
305 | 305 | 'QST_ID' => $QST_ID, |
306 | 306 | 'REG_ID' => $REG_ID, |
@@ -315,11 +315,11 @@ discard block |
||
315 | 315 | } |
316 | 316 | } |
317 | 317 | $what = __('Registration Form', 'event_espresso'); |
318 | - $route = $REG_ID ? array( 'action' => 'view_registration', '_REG_ID' => $REG_ID ) : array( 'action' => 'default' ); |
|
319 | - $admin_page->redirect_after_action( $success, $what, __('updated', 'event_espresso'), $route ); |
|
318 | + $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default'); |
|
319 | + $admin_page->redirect_after_action($success, $what, __('updated', 'event_espresso'), $route); |
|
320 | 320 | exit; |
321 | 321 | } |
322 | -add_action( 'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', 'ee_deprecated_update_attendee_registration_form_old', 10, 1 ); |
|
322 | +add_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', 'ee_deprecated_update_attendee_registration_form_old', 10, 1); |
|
323 | 323 | /** |
324 | 324 | * Render the registration admin page's custom questions area in the old fashion |
325 | 325 | * and firing the old hooks. When this method is removed, we can probably also |
@@ -332,31 +332,31 @@ discard block |
||
332 | 332 | * @return bool |
333 | 333 | * @throws \EE_Error |
334 | 334 | */ |
335 | -function ee_deprecated_reg_questions_meta_box_old( $do_default_action, $admin_page, $registration ) { |
|
335 | +function ee_deprecated_reg_questions_meta_box_old($do_default_action, $admin_page, $registration) { |
|
336 | 336 | //check if the old hooks are in use. If not, do the default |
337 | - if( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
338 | - || ! $admin_page instanceof EE_Admin_Page ) { |
|
337 | + if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
338 | + || ! $admin_page instanceof EE_Admin_Page) { |
|
339 | 339 | return $do_default_action; |
340 | 340 | } |
341 | - add_filter( 'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', array( $admin_page, 'form_before_question_group' ), 10, 1 ); |
|
342 | - add_filter( 'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', array( $admin_page, 'form_after_question_group' ), 10, 1 ); |
|
343 | - add_filter( 'FHEE__EEH_Form_Fields__label_html', array( $admin_page, 'form_form_field_label_wrap' ), 10, 1 ); |
|
344 | - add_filter( 'FHEE__EEH_Form_Fields__input_html', array( $admin_page, 'form_form_field_input__wrap' ), 10, 1 ); |
|
341 | + add_filter('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', array($admin_page, 'form_before_question_group'), 10, 1); |
|
342 | + add_filter('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', array($admin_page, 'form_after_question_group'), 10, 1); |
|
343 | + add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1); |
|
344 | + add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1); |
|
345 | 345 | |
346 | - $question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options( $registration, $registration->get('EVT_ID') ); |
|
346 | + $question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options($registration, $registration->get('EVT_ID')); |
|
347 | 347 | |
348 | - EE_Registry::instance()->load_helper( 'Form_Fields' ); |
|
348 | + EE_Registry::instance()->load_helper('Form_Fields'); |
|
349 | 349 | $template_args = array( |
350 | - 'att_questions' => EEH_Form_Fields::generate_question_groups_html( $question_groups ), |
|
350 | + 'att_questions' => EEH_Form_Fields::generate_question_groups_html($question_groups), |
|
351 | 351 | 'reg_questions_form_action' => 'edit_registration', |
352 | 352 | 'REG_ID' => $registration->ID() |
353 | 353 | ); |
354 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
355 | - echo EEH_Template::display_template( $template_path, $template_args, TRUE ); |
|
354 | + $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
355 | + echo EEH_Template::display_template($template_path, $template_args, TRUE); |
|
356 | 356 | //indicate that we should not do the default admin page code |
357 | 357 | return false; |
358 | 358 | } |
359 | -add_action( 'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', 'ee_deprecated_reg_questions_meta_box_old', 10, 3 ); |
|
359 | +add_action('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', 'ee_deprecated_reg_questions_meta_box_old', 10, 3); |
|
360 | 360 | |
361 | 361 | |
362 | 362 | |
@@ -397,9 +397,9 @@ discard block |
||
397 | 397 | '4.9.0' |
398 | 398 | ); |
399 | 399 | /** @var EE_Message_Resource_Manager $message_resource_manager */ |
400 | - $message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' ); |
|
401 | - $messenger = $message_resource_manager->get_messenger( $messenger_name ); |
|
402 | - $message_type = $message_resource_manager->get_message_type( $message_type_name ); |
|
400 | + $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
401 | + $messenger = $message_resource_manager->get_messenger($messenger_name); |
|
402 | + $message_type = $message_resource_manager->get_message_type($message_type_name); |
|
403 | 403 | return EE_Registry::instance()->load_lib( |
404 | 404 | 'Messages_Template_Defaults', |
405 | 405 | array( |
@@ -464,15 +464,15 @@ discard block |
||
464 | 464 | /** |
465 | 465 | * @param string $method |
466 | 466 | */ |
467 | - public function _class_is_deprecated( $method ) { |
|
467 | + public function _class_is_deprecated($method) { |
|
468 | 468 | EE_Error::doing_it_wrong( |
469 | - 'EE_messages::' . $method, |
|
470 | - __( 'EE_messages has been deprecated. Please use EE_Message_Resource_Manager instead.' ), |
|
469 | + 'EE_messages::'.$method, |
|
470 | + __('EE_messages has been deprecated. Please use EE_Message_Resource_Manager instead.'), |
|
471 | 471 | '4.9.0', |
472 | 472 | '4.10.0.p' |
473 | 473 | ); |
474 | 474 | // Please use EE_Message_Resource_Manager instead |
475 | - $this->_message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' ); |
|
475 | + $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
476 | 476 | } |
477 | 477 | |
478 | 478 | |
@@ -482,10 +482,10 @@ discard block |
||
482 | 482 | * @param string $messenger_name |
483 | 483 | * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive |
484 | 484 | */ |
485 | - public function ensure_messenger_is_active( $messenger_name ) { |
|
485 | + public function ensure_messenger_is_active($messenger_name) { |
|
486 | 486 | // EE_messages has been deprecated |
487 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
488 | - return $this->_message_resource_manager->ensure_messenger_is_active( $messenger_name ); |
|
487 | + $this->_class_is_deprecated(__FUNCTION__); |
|
488 | + return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name); |
|
489 | 489 | } |
490 | 490 | |
491 | 491 | |
@@ -497,10 +497,10 @@ discard block |
||
497 | 497 | * @return bool true if it got activated (or was active) and false if not. |
498 | 498 | * @throws \EE_Error |
499 | 499 | */ |
500 | - public function ensure_message_type_is_active( $message_type, $messenger ) { |
|
500 | + public function ensure_message_type_is_active($message_type, $messenger) { |
|
501 | 501 | // EE_messages has been deprecated |
502 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
503 | - return $this->_message_resource_manager->ensure_message_type_is_active( $message_type, $messenger ); |
|
502 | + $this->_class_is_deprecated(__FUNCTION__); |
|
503 | + return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger); |
|
504 | 504 | } |
505 | 505 | |
506 | 506 | |
@@ -513,10 +513,10 @@ discard block |
||
513 | 513 | * they are already setup.) |
514 | 514 | * @return boolean an array of generated templates or false if nothing generated/activated. |
515 | 515 | */ |
516 | - public function activate_messenger( $messenger_name, $mts_to_activate = array() ) { |
|
516 | + public function activate_messenger($messenger_name, $mts_to_activate = array()) { |
|
517 | 517 | // EE_messages has been deprecated |
518 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
519 | - return $this->_message_resource_manager->activate_messenger( $messenger_name, $mts_to_activate ); |
|
518 | + $this->_class_is_deprecated(__FUNCTION__); |
|
519 | + return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate); |
|
520 | 520 | } |
521 | 521 | |
522 | 522 | |
@@ -528,10 +528,10 @@ discard block |
||
528 | 528 | * |
529 | 529 | * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send. |
530 | 530 | */ |
531 | - public function is_generating_messenger_and_active( EE_messenger $messenger, EE_message_type $message_type ) { |
|
531 | + public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type) { |
|
532 | 532 | // EE_messages has been deprecated |
533 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
534 | - return $this->_message_resource_manager->is_generating_messenger_and_active( $messenger, $message_type ); |
|
533 | + $this->_class_is_deprecated(__FUNCTION__); |
|
534 | + return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type); |
|
535 | 535 | } |
536 | 536 | |
537 | 537 | |
@@ -541,10 +541,10 @@ discard block |
||
541 | 541 | * @param string $messenger |
542 | 542 | * @return EE_messenger | null |
543 | 543 | */ |
544 | - public function get_messenger_if_active( $messenger ) { |
|
544 | + public function get_messenger_if_active($messenger) { |
|
545 | 545 | // EE_messages has been deprecated |
546 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
547 | - return $this->_message_resource_manager->get_active_messenger( $messenger ); |
|
546 | + $this->_class_is_deprecated(__FUNCTION__); |
|
547 | + return $this->_message_resource_manager->get_active_messenger($messenger); |
|
548 | 548 | } |
549 | 549 | |
550 | 550 | |
@@ -565,9 +565,9 @@ discard block |
||
565 | 565 | * 'message_type' => null |
566 | 566 | * ) |
567 | 567 | */ |
568 | - public function validate_for_use( EE_Message $message ) { |
|
568 | + public function validate_for_use(EE_Message $message) { |
|
569 | 569 | // EE_messages has been deprecated |
570 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
570 | + $this->_class_is_deprecated(__FUNCTION__); |
|
571 | 571 | return array( |
572 | 572 | 'messenger' => $message->messenger_object(), |
573 | 573 | 'message_type' => $message->message_type_object(), |
@@ -595,41 +595,41 @@ discard block |
||
595 | 595 | $send = true |
596 | 596 | ) { |
597 | 597 | // EE_messages has been deprecated |
598 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
598 | + $this->_class_is_deprecated(__FUNCTION__); |
|
599 | 599 | /** @type EE_Messages_Processor $processor */ |
600 | - $processor = EE_Registry::instance()->load_lib( 'Messages_Processor' ); |
|
600 | + $processor = EE_Registry::instance()->load_lib('Messages_Processor'); |
|
601 | 601 | $error = false; |
602 | 602 | //try to intelligently determine what method we'll call based on the incoming data. |
603 | 603 | //if generating and sending are different then generate and send immediately. |
604 | - if ( ! empty( $sending_messenger ) && $sending_messenger != $generating_messenger && $send ) { |
|
604 | + if ( ! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) { |
|
605 | 605 | //in the legacy system, when generating and sending were different, that means all the |
606 | 606 | //vars are already in the request object. So let's just use that. |
607 | 607 | try { |
608 | 608 | /** @type EE_Message_To_Generate_From_Request $mtg */ |
609 | - $mtg = EE_Registry::instance()->load_lib( 'Message_To_Generate_From_Request' ); |
|
610 | - $processor->generate_and_send_now( $mtg ); |
|
611 | - } catch ( EE_Error $e ) { |
|
609 | + $mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request'); |
|
610 | + $processor->generate_and_send_now($mtg); |
|
611 | + } catch (EE_Error $e) { |
|
612 | 612 | $error_msg = __( |
613 | 613 | 'Please note that a system message failed to send due to a technical issue.', |
614 | 614 | 'event_espresso' |
615 | 615 | ); |
616 | 616 | // add specific message for developers if WP_DEBUG in on |
617 | - $error_msg .= '||' . $e->getMessage(); |
|
618 | - EE_Error::add_error( $error_msg, __FILE__, __FUNCTION__, __LINE__ ); |
|
617 | + $error_msg .= '||'.$e->getMessage(); |
|
618 | + EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
619 | 619 | $error = true; |
620 | 620 | } |
621 | 621 | } else { |
622 | - $processor->generate_for_all_active_messengers( $type, $vars, $send ); |
|
622 | + $processor->generate_for_all_active_messengers($type, $vars, $send); |
|
623 | 623 | //let's find out if there were any errors and how many successfully were queued. |
624 | 624 | $count_errors = $processor->get_queue()->count_STS_in_queue( |
625 | - array( EEM_Message::status_failed, EEM_Message::status_debug_only ) |
|
625 | + array(EEM_Message::status_failed, EEM_Message::status_debug_only) |
|
626 | 626 | ); |
627 | - $count_queued = $processor->get_queue()->count_STS_in_queue( EEM_Message::status_incomplete ); |
|
628 | - $count_retry = $processor->get_queue()->count_STS_in_queue( EEM_Message::status_retry ); |
|
627 | + $count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete); |
|
628 | + $count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry); |
|
629 | 629 | $count_errors = $count_errors + $count_retry; |
630 | - if ( $count_errors > 0 ) { |
|
630 | + if ($count_errors > 0) { |
|
631 | 631 | $error = true; |
632 | - if ( $count_errors > 1 && $count_retry > 1 && $count_queued > 1 ) { |
|
632 | + if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) { |
|
633 | 633 | $message = sprintf( |
634 | 634 | __( |
635 | 635 | 'There were %d errors and %d messages successfully queued for generation and sending', |
@@ -638,7 +638,7 @@ discard block |
||
638 | 638 | $count_errors, |
639 | 639 | $count_queued |
640 | 640 | ); |
641 | - } elseif ( $count_errors > 1 && $count_queued === 1 ) { |
|
641 | + } elseif ($count_errors > 1 && $count_queued === 1) { |
|
642 | 642 | $message = sprintf( |
643 | 643 | __( |
644 | 644 | 'There were %d errors and %d message successfully queued for generation.', |
@@ -647,7 +647,7 @@ discard block |
||
647 | 647 | $count_errors, |
648 | 648 | $count_queued |
649 | 649 | ); |
650 | - } elseif ( $count_errors === 1 && $count_queued > 1 ) { |
|
650 | + } elseif ($count_errors === 1 && $count_queued > 1) { |
|
651 | 651 | $message = sprintf( |
652 | 652 | __( |
653 | 653 | 'There was %d error and %d messages successfully queued for generation.', |
@@ -665,9 +665,9 @@ discard block |
||
665 | 665 | $count_errors |
666 | 666 | ); |
667 | 667 | } |
668 | - EE_Error::add_error( $message, __FILE__, __FUNCTION__, __LINE__ ); |
|
668 | + EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__); |
|
669 | 669 | } else { |
670 | - if ( $count_queued === 1 ) { |
|
670 | + if ($count_queued === 1) { |
|
671 | 671 | $message = sprintf( |
672 | 672 | __( |
673 | 673 | '%d message successfully queued for generation.', |
@@ -684,18 +684,18 @@ discard block |
||
684 | 684 | $count_queued |
685 | 685 | ); |
686 | 686 | } |
687 | - EE_Error::add_success( $message ); |
|
687 | + EE_Error::add_success($message); |
|
688 | 688 | } |
689 | 689 | } |
690 | 690 | //if no error then return the generated message(s). |
691 | - if ( ! $error && ! $send ) { |
|
692 | - $generated_queue = $processor->generate_queue( false ); |
|
691 | + if ( ! $error && ! $send) { |
|
692 | + $generated_queue = $processor->generate_queue(false); |
|
693 | 693 | //get message and return. |
694 | 694 | $generated_queue->get_message_repository()->rewind(); |
695 | 695 | $messages = array(); |
696 | - while ( $generated_queue->get_message_repository()->valid() ) { |
|
696 | + while ($generated_queue->get_message_repository()->valid()) { |
|
697 | 697 | $message = $generated_queue->get_message_repository()->current(); |
698 | - if ( $message instanceof EE_Message ) { |
|
698 | + if ($message instanceof EE_Message) { |
|
699 | 699 | //set properties that might be expected by add-ons (backward compat) |
700 | 700 | $message->content = $message->content(); |
701 | 701 | $message->template_pack = $message->get_template_pack(); |
@@ -720,10 +720,10 @@ discard block |
||
720 | 720 | * @param bool $send true we will do a test send using the messenger delivery, false we just do a regular preview |
721 | 721 | * @return string The body of the message. |
722 | 722 | */ |
723 | - public function preview_message( $type, $context, $messenger, $send = false ) { |
|
723 | + public function preview_message($type, $context, $messenger, $send = false) { |
|
724 | 724 | // EE_messages has been deprecated |
725 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
726 | - return EED_Messages::preview_message( $type, $context, $messenger, $send ); |
|
725 | + $this->_class_is_deprecated(__FUNCTION__); |
|
726 | + return EED_Messages::preview_message($type, $context, $messenger, $send); |
|
727 | 727 | } |
728 | 728 | |
729 | 729 | |
@@ -737,14 +737,14 @@ discard block |
||
737 | 737 | * |
738 | 738 | * @return bool success or fail. |
739 | 739 | */ |
740 | - public function send_message_with_messenger_only( $messenger, $message_type, $message ) { |
|
740 | + public function send_message_with_messenger_only($messenger, $message_type, $message) { |
|
741 | 741 | // EE_messages has been deprecated |
742 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
742 | + $this->_class_is_deprecated(__FUNCTION__); |
|
743 | 743 | //setup for sending to new method. |
744 | 744 | /** @type EE_Messages_Queue $queue */ |
745 | - $queue = EE_Registry::instance()->load_lib( 'Messages_Queue' ); |
|
745 | + $queue = EE_Registry::instance()->load_lib('Messages_Queue'); |
|
746 | 746 | //make sure we have a proper message object |
747 | - if ( ! $message instanceof EE_Message && is_object( $message ) && isset( $message->content ) ) { |
|
747 | + if ( ! $message instanceof EE_Message && is_object($message) && isset($message->content)) { |
|
748 | 748 | $msg = EE_Message_Factory::create( |
749 | 749 | array( |
750 | 750 | 'MSG_messenger' => $messenger, |
@@ -756,15 +756,15 @@ discard block |
||
756 | 756 | } else { |
757 | 757 | $msg = $message; |
758 | 758 | } |
759 | - if ( ! $msg instanceof EE_Message ) { |
|
759 | + if ( ! $msg instanceof EE_Message) { |
|
760 | 760 | return false; |
761 | 761 | } |
762 | 762 | //make sure any content in a content property (if not empty) is set on the MSG_content. |
763 | - if ( ! empty( $msg->content ) ) { |
|
764 | - $msg->set( 'MSG_content', $msg->content ); |
|
763 | + if ( ! empty($msg->content)) { |
|
764 | + $msg->set('MSG_content', $msg->content); |
|
765 | 765 | } |
766 | - $queue->add( $msg ); |
|
767 | - return EED_Messages::send_message_with_messenger_only( $messenger, $message_type, $queue ); |
|
766 | + $queue->add($msg); |
|
767 | + return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue); |
|
768 | 768 | } |
769 | 769 | |
770 | 770 | |
@@ -778,11 +778,11 @@ discard block |
||
778 | 778 | * @return array|object if creation is successful then we return an array of info, otherwise an error_object is returned. |
779 | 779 | * @throws \EE_Error |
780 | 780 | */ |
781 | - public function create_new_templates( $messenger, $message_type, $GRP_ID = 0, $is_global = false ) { |
|
781 | + public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false) { |
|
782 | 782 | // EE_messages has been deprecated |
783 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
784 | - EE_Registry::instance()->load_helper( 'MSG_Template' ); |
|
785 | - return EEH_MSG_Template::create_new_templates( $messenger, $message_type, $GRP_ID, $is_global ); |
|
783 | + $this->_class_is_deprecated(__FUNCTION__); |
|
784 | + EE_Registry::instance()->load_helper('MSG_Template'); |
|
785 | + return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global); |
|
786 | 786 | } |
787 | 787 | |
788 | 788 | |
@@ -793,11 +793,11 @@ discard block |
||
793 | 793 | * @param string $message_type_name name of EE_message_type |
794 | 794 | * @return array |
795 | 795 | */ |
796 | - public function get_fields( $messenger_name, $message_type_name ) { |
|
796 | + public function get_fields($messenger_name, $message_type_name) { |
|
797 | 797 | // EE_messages has been deprecated |
798 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
799 | - EE_Registry::instance()->load_helper( 'MSG_Template' ); |
|
800 | - return EEH_MSG_Template::get_fields( $messenger_name, $message_type_name ); |
|
798 | + $this->_class_is_deprecated(__FUNCTION__); |
|
799 | + EE_Registry::instance()->load_helper('MSG_Template'); |
|
800 | + return EEH_MSG_Template::get_fields($messenger_name, $message_type_name); |
|
801 | 801 | } |
802 | 802 | |
803 | 803 | |
@@ -811,13 +811,13 @@ discard block |
||
811 | 811 | * @return array multidimensional array of messenger and message_type objects |
812 | 812 | * (messengers index, and message_type index); |
813 | 813 | */ |
814 | - public function get_installed( $type = 'all', $skip_cache = false ) { |
|
814 | + public function get_installed($type = 'all', $skip_cache = false) { |
|
815 | 815 | // EE_messages has been deprecated |
816 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
817 | - if ( $skip_cache ) { |
|
816 | + $this->_class_is_deprecated(__FUNCTION__); |
|
817 | + if ($skip_cache) { |
|
818 | 818 | $this->_message_resource_manager->reset_active_messengers_and_message_types(); |
819 | 819 | } |
820 | - switch ( $type ) { |
|
820 | + switch ($type) { |
|
821 | 821 | case 'messengers' : |
822 | 822 | return array( |
823 | 823 | 'messenger' => $this->_message_resource_manager->installed_messengers(), |
@@ -846,7 +846,7 @@ discard block |
||
846 | 846 | */ |
847 | 847 | public function get_active_messengers() { |
848 | 848 | // EE_messages has been deprecated |
849 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
849 | + $this->_class_is_deprecated(__FUNCTION__); |
|
850 | 850 | return $this->_message_resource_manager->active_messengers(); |
851 | 851 | } |
852 | 852 | |
@@ -858,7 +858,7 @@ discard block |
||
858 | 858 | */ |
859 | 859 | public function get_active_message_types() { |
860 | 860 | // EE_messages has been deprecated |
861 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
861 | + $this->_class_is_deprecated(__FUNCTION__); |
|
862 | 862 | return $this->_message_resource_manager->list_of_active_message_types(); |
863 | 863 | } |
864 | 864 | |
@@ -870,7 +870,7 @@ discard block |
||
870 | 870 | */ |
871 | 871 | public function get_active_message_type_objects() { |
872 | 872 | // EE_messages has been deprecated |
873 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
873 | + $this->_class_is_deprecated(__FUNCTION__); |
|
874 | 874 | return $this->_message_resource_manager->get_active_message_type_objects(); |
875 | 875 | } |
876 | 876 | |
@@ -882,10 +882,10 @@ discard block |
||
882 | 882 | * @param string $messenger The messenger being checked |
883 | 883 | * @return EE_message_type[] (or empty array if none present) |
884 | 884 | */ |
885 | - public function get_active_message_types_per_messenger( $messenger ) { |
|
885 | + public function get_active_message_types_per_messenger($messenger) { |
|
886 | 886 | // EE_messages has been deprecated |
887 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
888 | - return $this->_message_resource_manager->get_active_message_types_for_messenger( $messenger ); |
|
887 | + $this->_class_is_deprecated(__FUNCTION__); |
|
888 | + return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger); |
|
889 | 889 | } |
890 | 890 | |
891 | 891 | |
@@ -896,10 +896,10 @@ discard block |
||
896 | 896 | * @param string $message_type The string should correspond to a message type. |
897 | 897 | * @return EE_message_type|null |
898 | 898 | */ |
899 | - public function get_active_message_type( $messenger, $message_type ) { |
|
899 | + public function get_active_message_type($messenger, $message_type) { |
|
900 | 900 | // EE_messages has been deprecated |
901 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
902 | - return $this->_message_resource_manager->get_active_message_type_for_messenger( $messenger, $message_type ); |
|
901 | + $this->_class_is_deprecated(__FUNCTION__); |
|
902 | + return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type); |
|
903 | 903 | } |
904 | 904 | |
905 | 905 | |
@@ -910,7 +910,7 @@ discard block |
||
910 | 910 | */ |
911 | 911 | public function get_installed_message_types() { |
912 | 912 | // EE_messages has been deprecated |
913 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
913 | + $this->_class_is_deprecated(__FUNCTION__); |
|
914 | 914 | return $this->_message_resource_manager->installed_message_types(); |
915 | 915 | } |
916 | 916 | |
@@ -922,7 +922,7 @@ discard block |
||
922 | 922 | */ |
923 | 923 | public function get_installed_messengers() { |
924 | 924 | // EE_messages has been deprecated |
925 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
925 | + $this->_class_is_deprecated(__FUNCTION__); |
|
926 | 926 | return $this->_message_resource_manager->installed_messengers(); |
927 | 927 | } |
928 | 928 | |
@@ -933,10 +933,10 @@ discard block |
||
933 | 933 | * @param bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by message type. |
934 | 934 | * @return array |
935 | 935 | */ |
936 | - public function get_all_contexts( $slugs_only = true ) { |
|
936 | + public function get_all_contexts($slugs_only = true) { |
|
937 | 937 | // EE_messages has been deprecated |
938 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
939 | - return $this->_message_resource_manager->get_all_contexts( $slugs_only ); |
|
938 | + $this->_class_is_deprecated(__FUNCTION__); |
|
939 | + return $this->_message_resource_manager->get_all_contexts($slugs_only); |
|
940 | 940 | } |
941 | 941 | |
942 | 942 | |
@@ -995,7 +995,7 @@ discard block |
||
995 | 995 | add_filter( |
996 | 996 | 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css', |
997 | 997 | function($event_list_iframe_css) { |
998 | - if ( ! has_filter( 'FHEE__EventsArchiveIframe__event_list_iframe__css' )) { |
|
998 | + if ( ! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) { |
|
999 | 999 | return $event_list_iframe_css; |
1000 | 1000 | } |
1001 | 1001 | deprecated_espresso_action_or_filter_doing_it_wrong( |
@@ -1015,7 +1015,7 @@ discard block |
||
1015 | 1015 | add_filter( |
1016 | 1016 | 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js', |
1017 | 1017 | function($event_list_iframe_js) { |
1018 | - if ( ! has_filter( 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js' )) { |
|
1018 | + if ( ! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) { |
|
1019 | 1019 | return $event_list_iframe_js; |
1020 | 1020 | } |
1021 | 1021 | deprecated_espresso_action_or_filter_doing_it_wrong( |
@@ -1035,7 +1035,7 @@ discard block |
||
1035 | 1035 | add_filter( |
1036 | 1036 | 'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee', |
1037 | 1037 | function($existing_attendee, $registration, $attendee_data) { |
1038 | - if ( ! has_filter( 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee' )) { |
|
1038 | + if ( ! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) { |
|
1039 | 1039 | return $existing_attendee; |
1040 | 1040 | } |
1041 | 1041 | deprecated_espresso_action_or_filter_doing_it_wrong( |
@@ -1051,7 +1051,7 @@ discard block |
||
1051 | 1051 | $existing_attendee, $registration, $attendee_data |
1052 | 1052 | ); |
1053 | 1053 | }, |
1054 | - 10,3 |
|
1054 | + 10, 3 |
|
1055 | 1055 | ); |
1056 | 1056 | |
1057 | 1057 | |
@@ -1117,7 +1117,7 @@ discard block |
||
1117 | 1117 | */ |
1118 | 1118 | public function event_list_title($event_list_title = '') |
1119 | 1119 | { |
1120 | - if (! empty($this->title)) { |
|
1120 | + if ( ! empty($this->title)) { |
|
1121 | 1121 | return $this->title; |
1122 | 1122 | } |
1123 | 1123 | return $event_list_title; |
@@ -1,7 +1,7 @@ discard block |
||
1 | 1 | <?php use EventEspresso\core\exceptions\EntityNotFoundException; |
2 | 2 | |
3 | 3 | if (! defined('EVENT_ESPRESSO_VERSION')) { |
4 | - exit('No direct script access allowed'); |
|
4 | + exit('No direct script access allowed'); |
|
5 | 5 | } |
6 | 6 | |
7 | 7 | /** |
@@ -15,1690 +15,1690 @@ discard block |
||
15 | 15 | { |
16 | 16 | |
17 | 17 | |
18 | - /** |
|
19 | - * Used to reference when a registration has never been checked in. |
|
20 | - * |
|
21 | - * @type int |
|
22 | - */ |
|
23 | - const checkin_status_never = 2; |
|
24 | - |
|
25 | - /** |
|
26 | - * Used to reference when a registration has been checked in. |
|
27 | - * |
|
28 | - * @type int |
|
29 | - */ |
|
30 | - const checkin_status_in = 1; |
|
31 | - |
|
32 | - |
|
33 | - /** |
|
34 | - * Used to reference when a registration has been checked out. |
|
35 | - * |
|
36 | - * @type int |
|
37 | - */ |
|
38 | - const checkin_status_out = 0; |
|
39 | - |
|
40 | - |
|
41 | - /** |
|
42 | - * extra meta key for tracking reg status os trashed registrations |
|
43 | - * |
|
44 | - * @type string |
|
45 | - */ |
|
46 | - const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status'; |
|
47 | - |
|
48 | - |
|
49 | - /** |
|
50 | - * extra meta key for tracking if registration has reserved ticket |
|
51 | - * |
|
52 | - * @type string |
|
53 | - */ |
|
54 | - const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket'; |
|
55 | - |
|
56 | - |
|
57 | - /** |
|
58 | - * @param array $props_n_values incoming values |
|
59 | - * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
60 | - * used.) |
|
61 | - * @param array $date_formats incoming date_formats in an array where the first value is the |
|
62 | - * date_format and the second value is the time format |
|
63 | - * @return EE_Registration |
|
64 | - */ |
|
65 | - public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
66 | - { |
|
67 | - $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
68 | - return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats); |
|
69 | - } |
|
70 | - |
|
71 | - |
|
72 | - /** |
|
73 | - * @param array $props_n_values incoming values from the database |
|
74 | - * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
75 | - * the website will be used. |
|
76 | - * @return EE_Registration |
|
77 | - */ |
|
78 | - public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
79 | - { |
|
80 | - return new self($props_n_values, true, $timezone); |
|
81 | - } |
|
82 | - |
|
83 | - |
|
84 | - /** |
|
85 | - * Set Event ID |
|
86 | - * |
|
87 | - * @param int $EVT_ID Event ID |
|
88 | - */ |
|
89 | - public function set_event($EVT_ID = 0) |
|
90 | - { |
|
91 | - $this->set('EVT_ID', $EVT_ID); |
|
92 | - } |
|
93 | - |
|
94 | - |
|
95 | - /** |
|
96 | - * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can |
|
97 | - * be routed to internal methods |
|
98 | - * |
|
99 | - * @param string $field_name |
|
100 | - * @param mixed $field_value |
|
101 | - * @param bool $use_default |
|
102 | - * @throws \EE_Error |
|
103 | - * @throws \RuntimeException |
|
104 | - */ |
|
105 | - public function set($field_name, $field_value, $use_default = false) |
|
106 | - { |
|
107 | - switch ($field_name) { |
|
108 | - case 'REG_code' : |
|
109 | - if (! empty($field_value) && $this->reg_code() === null) { |
|
110 | - $this->set_reg_code($field_value, $use_default); |
|
111 | - } |
|
112 | - break; |
|
113 | - case 'STS_ID' : |
|
114 | - $this->set_status($field_value, $use_default); |
|
115 | - break; |
|
116 | - default : |
|
117 | - parent::set($field_name, $field_value, $use_default); |
|
118 | - } |
|
119 | - } |
|
120 | - |
|
121 | - |
|
122 | - /** |
|
123 | - * Set Status ID |
|
124 | - * updates the registration status and ALSO... |
|
125 | - * calls reserve_registration_space() if the reg status changes TO approved from any other reg status |
|
126 | - * calls release_registration_space() if the reg status changes FROM approved to any other reg status |
|
127 | - * |
|
128 | - * @param string $new_STS_ID |
|
129 | - * @param boolean $use_default |
|
130 | - * @return bool |
|
131 | - * @throws \RuntimeException |
|
132 | - * @throws \EE_Error |
|
133 | - */ |
|
134 | - public function set_status($new_STS_ID = null, $use_default = false) |
|
135 | - { |
|
136 | - // get current REG_Status |
|
137 | - $old_STS_ID = $this->status_ID(); |
|
138 | - // if status has changed |
|
139 | - if ( |
|
140 | - $old_STS_ID !== $new_STS_ID // and that status has actually changed |
|
141 | - && ! empty($old_STS_ID) // and that old status is actually set |
|
142 | - && ! empty($new_STS_ID) // as well as the new status |
|
143 | - && $this->ID() // ensure registration is in the db |
|
144 | - ) { |
|
145 | - // TO approved |
|
146 | - if ($new_STS_ID === EEM_Registration::status_id_approved) { |
|
147 | - // reserve a space by incrementing ticket and datetime sold values |
|
148 | - $this->_reserve_registration_space(); |
|
149 | - do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID); |
|
150 | - // OR FROM approved |
|
151 | - } else if ($old_STS_ID === EEM_Registration::status_id_approved) { |
|
152 | - // release a space by decrementing ticket and datetime sold values |
|
153 | - $this->_release_registration_space(); |
|
154 | - do_action('AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID); |
|
155 | - } |
|
156 | - // update status |
|
157 | - parent::set('STS_ID', $new_STS_ID, $use_default); |
|
158 | - $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID); |
|
159 | - /** @type EE_Transaction_Payments $transaction_payments */ |
|
160 | - $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
161 | - $transaction_payments->recalculate_transaction_total($this->transaction(), false); |
|
162 | - $this->transaction()->update_status_based_on_total_paid(true); |
|
163 | - do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID); |
|
164 | - return true; |
|
165 | - } |
|
166 | - //even though the old value matches the new value, it's still good to |
|
167 | - //allow the parent set method to have a say |
|
168 | - parent::set('STS_ID', $new_STS_ID, $use_default); |
|
169 | - return true; |
|
170 | - } |
|
171 | - |
|
172 | - |
|
173 | - /** |
|
174 | - * update REGs and TXN when cancelled or declined registrations involved |
|
175 | - * |
|
176 | - * @param string $new_STS_ID |
|
177 | - * @param string $old_STS_ID |
|
178 | - * @throws \EE_Error |
|
179 | - */ |
|
180 | - private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID) |
|
181 | - { |
|
182 | - // these reg statuses should not be considered in any calculations involving monies owing |
|
183 | - $closed_reg_statuses = EEM_Registration::closed_reg_statuses(); |
|
184 | - // true if registration has been cancelled or declined |
|
185 | - if ( |
|
186 | - in_array($new_STS_ID, $closed_reg_statuses, true) |
|
187 | - && ! in_array($old_STS_ID, $closed_reg_statuses, true) |
|
188 | - ) { |
|
189 | - /** @type EE_Registration_Processor $registration_processor */ |
|
190 | - $registration_processor = EE_Registry::instance()->load_class('Registration_Processor'); |
|
191 | - /** @type EE_Transaction_Processor $transaction_processor */ |
|
192 | - $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
193 | - // cancelled or declined registration |
|
194 | - $registration_processor->update_registration_after_being_canceled_or_declined( |
|
195 | - $this, |
|
196 | - $closed_reg_statuses |
|
197 | - ); |
|
198 | - $transaction_processor->update_transaction_after_canceled_or_declined_registration( |
|
199 | - $this, |
|
200 | - $closed_reg_statuses, |
|
201 | - false |
|
202 | - ); |
|
203 | - do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID); |
|
204 | - return; |
|
205 | - } |
|
206 | - // true if reinstating cancelled or declined registration |
|
207 | - if ( |
|
208 | - in_array($old_STS_ID, $closed_reg_statuses, true) |
|
209 | - && ! in_array($new_STS_ID, $closed_reg_statuses, true) |
|
210 | - ) { |
|
211 | - /** @type EE_Registration_Processor $registration_processor */ |
|
212 | - $registration_processor = EE_Registry::instance()->load_class('Registration_Processor'); |
|
213 | - /** @type EE_Transaction_Processor $transaction_processor */ |
|
214 | - $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
215 | - // reinstating cancelled or declined registration |
|
216 | - $registration_processor->update_canceled_or_declined_registration_after_being_reinstated( |
|
217 | - $this, |
|
218 | - $closed_reg_statuses |
|
219 | - ); |
|
220 | - $transaction_processor->update_transaction_after_reinstating_canceled_registration( |
|
221 | - $this, |
|
222 | - $closed_reg_statuses, |
|
223 | - false |
|
224 | - ); |
|
225 | - do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID); |
|
226 | - } |
|
227 | - } |
|
228 | - |
|
229 | - |
|
230 | - /** |
|
231 | - * get Status ID |
|
232 | - */ |
|
233 | - public function status_ID() |
|
234 | - { |
|
235 | - return $this->get('STS_ID'); |
|
236 | - } |
|
237 | - |
|
238 | - |
|
239 | - /** |
|
240 | - * increments this registration's related ticket sold and corresponding datetime sold values |
|
241 | - * |
|
242 | - * @return void |
|
243 | - * @throws \EE_Error |
|
244 | - */ |
|
245 | - private function _reserve_registration_space() |
|
246 | - { |
|
247 | - // reserved ticket and datetime counts will be decremented as sold counts are incremented |
|
248 | - // so stop tracking that this reg has a ticket reserved |
|
249 | - $this->release_reserved_ticket(); |
|
250 | - $ticket = $this->ticket(); |
|
251 | - $ticket->increase_sold(); |
|
252 | - $ticket->save(); |
|
253 | - // possibly set event status to sold out |
|
254 | - $this->event()->perform_sold_out_status_check(); |
|
255 | - } |
|
256 | - |
|
257 | - |
|
258 | - /** |
|
259 | - * Gets the ticket this registration is for |
|
260 | - * |
|
261 | - * @param boolean $include_archived whether to include archived tickets or not. |
|
262 | - * @return EE_Ticket|EE_Base_Class |
|
263 | - * @throws \EE_Error |
|
264 | - */ |
|
265 | - public function ticket($include_archived = true) |
|
266 | - { |
|
267 | - $query_params = array(); |
|
268 | - if ($include_archived) { |
|
269 | - $query_params['default_where_conditions'] = 'none'; |
|
270 | - } |
|
271 | - return $this->get_first_related('Ticket', $query_params); |
|
272 | - } |
|
273 | - |
|
274 | - |
|
275 | - /** |
|
276 | - * Gets the event this registration is for |
|
277 | - * |
|
278 | - * @return EE_Event |
|
279 | - */ |
|
280 | - public function event() |
|
281 | - { |
|
282 | - $event = $this->get_first_related('Event'); |
|
283 | - if (! $event instanceof \EE_Event) { |
|
284 | - throw new EntityNotFoundException('Event ID', $this->event_ID()); |
|
285 | - } |
|
286 | - return $event; |
|
287 | - } |
|
288 | - |
|
289 | - |
|
290 | - /** |
|
291 | - * Gets the "author" of the registration. Note that for the purposes of registrations, the author will correspond |
|
292 | - * with the author of the event this registration is for. |
|
293 | - * |
|
294 | - * @since 4.5.0 |
|
295 | - * @return int |
|
296 | - */ |
|
297 | - public function wp_user() |
|
298 | - { |
|
299 | - $event = $this->event(); |
|
300 | - if ($event instanceof EE_Event) { |
|
301 | - return $event->wp_user(); |
|
302 | - } |
|
303 | - return 0; |
|
304 | - } |
|
305 | - |
|
306 | - |
|
307 | - /** |
|
308 | - * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values |
|
309 | - * |
|
310 | - * @return void |
|
311 | - * @throws \EE_Error |
|
312 | - */ |
|
313 | - private function _release_registration_space() |
|
314 | - { |
|
315 | - $ticket = $this->ticket(); |
|
316 | - $ticket->decrease_sold(); |
|
317 | - $ticket->save(); |
|
318 | - } |
|
319 | - |
|
320 | - |
|
321 | - /** |
|
322 | - * tracks this registration's ticket reservation in extra meta |
|
323 | - * and can increment related ticket reserved and corresponding datetime reserved values |
|
324 | - * |
|
325 | - * @param bool $update_ticket if true, will increment ticket and datetime reserved count |
|
326 | - * @return void |
|
327 | - * @throws \EE_Error |
|
328 | - */ |
|
329 | - public function reserve_ticket($update_ticket = false) |
|
330 | - { |
|
331 | - if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) { |
|
332 | - // PLZ NOTE: although checking $update_ticket first would be more efficient, |
|
333 | - // we NEED to ALWAYS call update_extra_meta(), which is why that is done first |
|
334 | - if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) { |
|
335 | - $ticket = $this->ticket(); |
|
336 | - $ticket->increase_reserved(); |
|
337 | - $ticket->save(); |
|
338 | - } |
|
339 | - } |
|
340 | - } |
|
341 | - |
|
342 | - |
|
343 | - /** |
|
344 | - * stops tracking this registration's ticket reservation in extra meta |
|
345 | - * decrements (subtracts) related ticket reserved and corresponding datetime reserved values |
|
346 | - * |
|
347 | - * @param bool $update_ticket if true, will decrement ticket and datetime reserved count |
|
348 | - * @return void |
|
349 | - * @throws \EE_Error |
|
350 | - */ |
|
351 | - public function release_reserved_ticket($update_ticket = false) |
|
352 | - { |
|
353 | - if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) { |
|
354 | - // PLZ NOTE: although checking $update_ticket first would be more efficient, |
|
355 | - // we NEED to ALWAYS call delete_extra_meta(), which is why that is done first |
|
356 | - if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) { |
|
357 | - $ticket = $this->ticket(); |
|
358 | - $ticket->decrease_reserved(); |
|
359 | - $ticket->save(); |
|
360 | - } |
|
361 | - } |
|
362 | - } |
|
363 | - |
|
364 | - |
|
365 | - /** |
|
366 | - * Set Attendee ID |
|
367 | - * |
|
368 | - * @param int $ATT_ID Attendee ID |
|
369 | - */ |
|
370 | - public function set_attendee_id($ATT_ID = 0) |
|
371 | - { |
|
372 | - $this->set('ATT_ID', $ATT_ID); |
|
373 | - } |
|
374 | - |
|
375 | - |
|
376 | - /** |
|
377 | - * Set Transaction ID |
|
378 | - * |
|
379 | - * @param int $TXN_ID Transaction ID |
|
380 | - */ |
|
381 | - public function set_transaction_id($TXN_ID = 0) |
|
382 | - { |
|
383 | - $this->set('TXN_ID', $TXN_ID); |
|
384 | - } |
|
385 | - |
|
386 | - |
|
387 | - /** |
|
388 | - * Set Session |
|
389 | - * |
|
390 | - * @param string $REG_session PHP Session ID |
|
391 | - */ |
|
392 | - public function set_session($REG_session = '') |
|
393 | - { |
|
394 | - $this->set('REG_session', $REG_session); |
|
395 | - } |
|
396 | - |
|
397 | - |
|
398 | - /** |
|
399 | - * Set Registration URL Link |
|
400 | - * |
|
401 | - * @param string $REG_url_link Registration URL Link |
|
402 | - */ |
|
403 | - public function set_reg_url_link($REG_url_link = '') |
|
404 | - { |
|
405 | - $this->set('REG_url_link', $REG_url_link); |
|
406 | - } |
|
407 | - |
|
408 | - |
|
409 | - /** |
|
410 | - * Set Attendee Counter |
|
411 | - * |
|
412 | - * @param int $REG_count Primary Attendee |
|
413 | - */ |
|
414 | - public function set_count($REG_count = 1) |
|
415 | - { |
|
416 | - $this->set('REG_count', $REG_count); |
|
417 | - } |
|
418 | - |
|
419 | - |
|
420 | - /** |
|
421 | - * Set Group Size |
|
422 | - * |
|
423 | - * @param boolean $REG_group_size Group Registration |
|
424 | - */ |
|
425 | - public function set_group_size($REG_group_size = false) |
|
426 | - { |
|
427 | - $this->set('REG_group_size', $REG_group_size); |
|
428 | - } |
|
429 | - |
|
430 | - |
|
431 | - /** |
|
432 | - * is_not_approved - convenience method that returns TRUE if REG status ID == |
|
433 | - * EEM_Registration::status_id_not_approved |
|
434 | - * |
|
435 | - * @return boolean |
|
436 | - */ |
|
437 | - public function is_not_approved() |
|
438 | - { |
|
439 | - return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false; |
|
440 | - } |
|
441 | - |
|
442 | - |
|
443 | - /** |
|
444 | - * is_pending_payment - convenience method that returns TRUE if REG status ID == |
|
445 | - * EEM_Registration::status_id_pending_payment |
|
446 | - * |
|
447 | - * @return boolean |
|
448 | - */ |
|
449 | - public function is_pending_payment() |
|
450 | - { |
|
451 | - return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false; |
|
452 | - } |
|
453 | - |
|
454 | - |
|
455 | - /** |
|
456 | - * is_approved - convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved |
|
457 | - * |
|
458 | - * @return boolean |
|
459 | - */ |
|
460 | - public function is_approved() |
|
461 | - { |
|
462 | - return $this->status_ID() == EEM_Registration::status_id_approved ? true : false; |
|
463 | - } |
|
464 | - |
|
465 | - |
|
466 | - /** |
|
467 | - * is_cancelled - convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled |
|
468 | - * |
|
469 | - * @return boolean |
|
470 | - */ |
|
471 | - public function is_cancelled() |
|
472 | - { |
|
473 | - return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false; |
|
474 | - } |
|
475 | - |
|
476 | - |
|
477 | - /** |
|
478 | - * is_declined - convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined |
|
479 | - * |
|
480 | - * @return boolean |
|
481 | - */ |
|
482 | - public function is_declined() |
|
483 | - { |
|
484 | - return $this->status_ID() == EEM_Registration::status_id_declined ? true : false; |
|
485 | - } |
|
486 | - |
|
487 | - |
|
488 | - /** |
|
489 | - * is_incomplete - convenience method that returns TRUE if REG status ID == |
|
490 | - * EEM_Registration::status_id_incomplete |
|
491 | - * |
|
492 | - * @return boolean |
|
493 | - */ |
|
494 | - public function is_incomplete() |
|
495 | - { |
|
496 | - return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false; |
|
497 | - } |
|
498 | - |
|
499 | - |
|
500 | - /** |
|
501 | - * Set Registration Date |
|
502 | - * |
|
503 | - * @param mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of |
|
504 | - * Date |
|
505 | - */ |
|
506 | - public function set_reg_date($REG_date = false) |
|
507 | - { |
|
508 | - $this->set('REG_date', $REG_date); |
|
509 | - } |
|
510 | - |
|
511 | - |
|
512 | - /** |
|
513 | - * Set final price owing for this registration after all ticket/price modifications |
|
514 | - * |
|
515 | - * @access public |
|
516 | - * @param float $REG_final_price |
|
517 | - */ |
|
518 | - public function set_final_price($REG_final_price = 0.00) |
|
519 | - { |
|
520 | - $this->set('REG_final_price', $REG_final_price); |
|
521 | - } |
|
522 | - |
|
523 | - |
|
524 | - /** |
|
525 | - * Set amount paid towards this registration's final price |
|
526 | - * |
|
527 | - * @access public |
|
528 | - * @param float $REG_paid |
|
529 | - */ |
|
530 | - public function set_paid($REG_paid = 0.00) |
|
531 | - { |
|
532 | - $this->set('REG_paid', $REG_paid); |
|
533 | - } |
|
534 | - |
|
535 | - |
|
536 | - /** |
|
537 | - * Attendee Is Going |
|
538 | - * |
|
539 | - * @param boolean $REG_att_is_going Attendee Is Going |
|
540 | - */ |
|
541 | - public function set_att_is_going($REG_att_is_going = false) |
|
542 | - { |
|
543 | - $this->set('REG_att_is_going', $REG_att_is_going); |
|
544 | - } |
|
545 | - |
|
546 | - |
|
547 | - /** |
|
548 | - * Gets the related attendee |
|
549 | - * |
|
550 | - * @return EE_Attendee |
|
551 | - */ |
|
552 | - public function attendee() |
|
553 | - { |
|
554 | - return $this->get_first_related('Attendee'); |
|
555 | - } |
|
556 | - |
|
557 | - |
|
558 | - /** |
|
559 | - * get Event ID |
|
560 | - */ |
|
561 | - public function event_ID() |
|
562 | - { |
|
563 | - return $this->get('EVT_ID'); |
|
564 | - } |
|
565 | - |
|
566 | - |
|
567 | - /** |
|
568 | - * get Event ID |
|
569 | - */ |
|
570 | - public function event_name() |
|
571 | - { |
|
572 | - $event = $this->event_obj(); |
|
573 | - if ($event) { |
|
574 | - return $event->name(); |
|
575 | - } else { |
|
576 | - return null; |
|
577 | - } |
|
578 | - } |
|
579 | - |
|
580 | - |
|
581 | - /** |
|
582 | - * Fetches the event this registration is for |
|
583 | - * |
|
584 | - * @return EE_Event |
|
585 | - */ |
|
586 | - public function event_obj() |
|
587 | - { |
|
588 | - return $this->get_first_related('Event'); |
|
589 | - } |
|
590 | - |
|
591 | - |
|
592 | - /** |
|
593 | - * get Attendee ID |
|
594 | - */ |
|
595 | - public function attendee_ID() |
|
596 | - { |
|
597 | - return $this->get('ATT_ID'); |
|
598 | - } |
|
599 | - |
|
600 | - |
|
601 | - /** |
|
602 | - * get PHP Session ID |
|
603 | - */ |
|
604 | - public function session_ID() |
|
605 | - { |
|
606 | - return $this->get('REG_session'); |
|
607 | - } |
|
608 | - |
|
609 | - |
|
610 | - /** |
|
611 | - * Gets the string which represents the URL trigger for the receipt template in the message template system. |
|
612 | - * |
|
613 | - * @param string $messenger 'pdf' or 'html'. Default 'html'. |
|
614 | - * @return string |
|
615 | - */ |
|
616 | - public function receipt_url($messenger = 'html') |
|
617 | - { |
|
618 | - |
|
619 | - /** |
|
620 | - * The below will be deprecated one version after this. We check first if there is a custom receipt template already in use on old system. If there is then we just return the standard url for it. |
|
621 | - * |
|
622 | - * @since 4.5.0 |
|
623 | - */ |
|
624 | - $template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php'; |
|
625 | - $has_custom = EEH_Template::locate_template($template_relative_path, array(), true, true, true); |
|
626 | - |
|
627 | - if ($has_custom) { |
|
628 | - return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch')); |
|
629 | - } |
|
630 | - return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt'); |
|
631 | - } |
|
632 | - |
|
633 | - |
|
634 | - /** |
|
635 | - * Gets the string which represents the URL trigger for the invoice template in the message template system. |
|
636 | - * |
|
637 | - * @param string $messenger 'pdf' or 'html'. Default 'html'. |
|
638 | - * @return string |
|
639 | - */ |
|
640 | - public function invoice_url($messenger = 'html') |
|
641 | - { |
|
642 | - /** |
|
643 | - * The below will be deprecated one version after this. We check first if there is a custom invoice template already in use on old system. If there is then we just return the standard url for it. |
|
644 | - * |
|
645 | - * @since 4.5.0 |
|
646 | - */ |
|
647 | - $template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php'; |
|
648 | - $has_custom = EEH_Template::locate_template($template_relative_path, array(), true, true, true); |
|
649 | - |
|
650 | - if ($has_custom) { |
|
651 | - if ($messenger == 'html') { |
|
652 | - return $this->invoice_url('launch'); |
|
653 | - } |
|
654 | - $route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice'; |
|
655 | - |
|
656 | - $query_args = array('ee' => $route, 'id' => $this->reg_url_link()); |
|
657 | - if ($messenger == 'html') { |
|
658 | - $query_args['html'] = true; |
|
659 | - } |
|
660 | - return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id)); |
|
661 | - } |
|
662 | - return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice'); |
|
663 | - } |
|
664 | - |
|
665 | - |
|
666 | - /** |
|
667 | - * get Registration URL Link |
|
668 | - * |
|
669 | - * @access public |
|
670 | - * @return string |
|
671 | - * @throws \EE_Error |
|
672 | - */ |
|
673 | - public function reg_url_link() |
|
674 | - { |
|
675 | - return (string)$this->get('REG_url_link'); |
|
676 | - } |
|
677 | - |
|
678 | - |
|
679 | - /** |
|
680 | - * Echoes out invoice_url() |
|
681 | - * |
|
682 | - * @param string $type 'download','launch', or 'html' (default is 'launch') |
|
683 | - * @return void |
|
684 | - */ |
|
685 | - public function e_invoice_url($type = 'launch') |
|
686 | - { |
|
687 | - echo $this->invoice_url($type); |
|
688 | - } |
|
689 | - |
|
690 | - |
|
691 | - /** |
|
692 | - * Echoes out payment_overview_url |
|
693 | - */ |
|
694 | - public function e_payment_overview_url() |
|
695 | - { |
|
696 | - echo $this->payment_overview_url(); |
|
697 | - } |
|
698 | - |
|
699 | - |
|
700 | - /** |
|
701 | - * Gets the URL of the thank you page with this registration REG_url_link added as |
|
702 | - * a query parameter |
|
703 | - * |
|
704 | - * @return string |
|
705 | - */ |
|
706 | - public function payment_overview_url() |
|
707 | - { |
|
708 | - return add_query_arg(array( |
|
709 | - 'e_reg_url_link' => $this->reg_url_link(), |
|
710 | - 'step' => 'payment_options', |
|
711 | - 'revisit' => true, |
|
712 | - ), EE_Registry::instance()->CFG->core->reg_page_url()); |
|
713 | - } |
|
714 | - |
|
715 | - |
|
716 | - /** |
|
717 | - * Gets the URL of the thank you page with this registration REG_url_link added as |
|
718 | - * a query parameter |
|
719 | - * |
|
720 | - * @return string |
|
721 | - */ |
|
722 | - public function edit_attendee_information_url() |
|
723 | - { |
|
724 | - return add_query_arg(array( |
|
725 | - 'e_reg_url_link' => $this->reg_url_link(), |
|
726 | - 'step' => 'attendee_information', |
|
727 | - 'revisit' => true, |
|
728 | - ), EE_Registry::instance()->CFG->core->reg_page_url()); |
|
729 | - } |
|
730 | - |
|
731 | - |
|
732 | - /** |
|
733 | - * Simply generates and returns the appropriate admin_url link to edit this registration |
|
734 | - * |
|
735 | - * @return string |
|
736 | - */ |
|
737 | - public function get_admin_edit_url() |
|
738 | - { |
|
739 | - return EEH_URL::add_query_args_and_nonce(array( |
|
740 | - 'page' => 'espresso_registrations', |
|
741 | - 'action' => 'view_registration', |
|
742 | - '_REG_ID' => $this->ID(), |
|
743 | - ), admin_url('admin.php')); |
|
744 | - } |
|
745 | - |
|
746 | - |
|
747 | - /** |
|
748 | - * is_primary_registrant? |
|
749 | - */ |
|
750 | - public function is_primary_registrant() |
|
751 | - { |
|
752 | - return $this->get('REG_count') == 1 ? true : false; |
|
753 | - } |
|
754 | - |
|
755 | - |
|
756 | - /** |
|
757 | - * This returns the primary registration object for this registration group (which may be this object). |
|
758 | - * |
|
759 | - * @return EE_Registration |
|
760 | - */ |
|
761 | - public function get_primary_registration() |
|
762 | - { |
|
763 | - if ($this->is_primary_registrant()) { |
|
764 | - return $this; |
|
765 | - } |
|
766 | - |
|
767 | - //k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1 |
|
768 | - $primary_registrant = EEM_Registration::instance()->get_one(array( |
|
769 | - array( |
|
770 | - 'TXN_ID' => $this->transaction_ID(), |
|
771 | - 'REG_count' => 1, |
|
772 | - ), |
|
773 | - )); |
|
774 | - return $primary_registrant; |
|
775 | - } |
|
776 | - |
|
777 | - |
|
778 | - /** |
|
779 | - * get Attendee Number |
|
780 | - * |
|
781 | - * @access public |
|
782 | - */ |
|
783 | - public function count() |
|
784 | - { |
|
785 | - return $this->get('REG_count'); |
|
786 | - } |
|
787 | - |
|
788 | - |
|
789 | - /** |
|
790 | - * get Group Size |
|
791 | - */ |
|
792 | - public function group_size() |
|
793 | - { |
|
794 | - return $this->get('REG_group_size'); |
|
795 | - } |
|
796 | - |
|
797 | - |
|
798 | - /** |
|
799 | - * get Registration Date |
|
800 | - */ |
|
801 | - public function date() |
|
802 | - { |
|
803 | - return $this->get('REG_date'); |
|
804 | - } |
|
805 | - |
|
806 | - |
|
807 | - /** |
|
808 | - * gets a pretty date |
|
809 | - * |
|
810 | - * @param string $date_format |
|
811 | - * @param string $time_format |
|
812 | - * @return string |
|
813 | - */ |
|
814 | - public function pretty_date($date_format = null, $time_format = null) |
|
815 | - { |
|
816 | - return $this->get_datetime('REG_date', $date_format, $time_format); |
|
817 | - } |
|
818 | - |
|
819 | - |
|
820 | - /** |
|
821 | - * final_price |
|
822 | - * the registration's share of the transaction total, so that the |
|
823 | - * sum of all the transaction's REG_final_prices equal the transaction's total |
|
824 | - * |
|
825 | - * @return float |
|
826 | - */ |
|
827 | - public function final_price() |
|
828 | - { |
|
829 | - return $this->get('REG_final_price'); |
|
830 | - } |
|
831 | - |
|
832 | - |
|
833 | - /** |
|
834 | - * pretty_final_price |
|
835 | - * final price as formatted string, with correct decimal places and currency symbol |
|
836 | - * |
|
837 | - * @return string |
|
838 | - */ |
|
839 | - public function pretty_final_price() |
|
840 | - { |
|
841 | - return $this->get_pretty('REG_final_price'); |
|
842 | - } |
|
843 | - |
|
844 | - |
|
845 | - /** |
|
846 | - * get paid (yeah) |
|
847 | - * |
|
848 | - * @return float |
|
849 | - */ |
|
850 | - public function paid() |
|
851 | - { |
|
852 | - return $this->get('REG_paid'); |
|
853 | - } |
|
854 | - |
|
855 | - |
|
856 | - /** |
|
857 | - * pretty_paid |
|
858 | - * |
|
859 | - * @return float |
|
860 | - */ |
|
861 | - public function pretty_paid() |
|
862 | - { |
|
863 | - return $this->get_pretty('REG_paid'); |
|
864 | - } |
|
865 | - |
|
866 | - |
|
867 | - /** |
|
868 | - * owes_monies_and_can_pay |
|
869 | - * whether or not this registration has monies owing and it's' status allows payment |
|
870 | - * |
|
871 | - * @param array $requires_payment |
|
872 | - * @return bool |
|
873 | - */ |
|
874 | - public function owes_monies_and_can_pay($requires_payment = array()) |
|
875 | - { |
|
876 | - // these reg statuses require payment (if event is not free) |
|
877 | - $requires_payment = ! empty($requires_payment) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment(); |
|
878 | - if ( |
|
879 | - in_array($this->status_ID(), $requires_payment) && |
|
880 | - $this->final_price() != 0 && |
|
881 | - $this->final_price() != $this->paid() |
|
882 | - ) { |
|
883 | - return true; |
|
884 | - } else { |
|
885 | - return false; |
|
886 | - } |
|
887 | - } |
|
888 | - |
|
889 | - |
|
890 | - /** |
|
891 | - * Prints out the return value of $this->pretty_status() |
|
892 | - * |
|
893 | - * @param bool $show_icons |
|
894 | - * @return void |
|
895 | - */ |
|
896 | - public function e_pretty_status($show_icons = false) |
|
897 | - { |
|
898 | - echo $this->pretty_status($show_icons); |
|
899 | - } |
|
900 | - |
|
901 | - |
|
902 | - /** |
|
903 | - * Returns a nice version of the status for displaying to customers |
|
904 | - * |
|
905 | - * @param bool $show_icons |
|
906 | - * @return string |
|
907 | - */ |
|
908 | - public function pretty_status($show_icons = false) |
|
909 | - { |
|
910 | - $status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')), |
|
911 | - false, 'sentence'); |
|
912 | - $icon = ''; |
|
913 | - switch ($this->status_ID()) { |
|
914 | - case EEM_Registration::status_id_approved: |
|
915 | - $icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : ''; |
|
916 | - break; |
|
917 | - case EEM_Registration::status_id_pending_payment: |
|
918 | - $icon = $show_icons ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>' : ''; |
|
919 | - break; |
|
920 | - case EEM_Registration::status_id_not_approved: |
|
921 | - $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>' : ''; |
|
922 | - break; |
|
923 | - case EEM_Registration::status_id_cancelled: |
|
924 | - $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>' : ''; |
|
925 | - break; |
|
926 | - case EEM_Registration::status_id_incomplete: |
|
927 | - $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>' : ''; |
|
928 | - break; |
|
929 | - case EEM_Registration::status_id_declined: |
|
930 | - $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : ''; |
|
931 | - break; |
|
932 | - case EEM_Registration::status_id_wait_list: |
|
933 | - $icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : ''; |
|
934 | - break; |
|
935 | - } |
|
936 | - return $icon . $status[$this->status_ID()]; |
|
937 | - } |
|
938 | - |
|
939 | - |
|
940 | - /** |
|
941 | - * get Attendee Is Going |
|
942 | - */ |
|
943 | - public function att_is_going() |
|
944 | - { |
|
945 | - return $this->get('REG_att_is_going'); |
|
946 | - } |
|
947 | - |
|
948 | - |
|
949 | - /** |
|
950 | - * Gets related answers |
|
951 | - * |
|
952 | - * @param array $query_params like EEM_Base::get_all |
|
953 | - * @return EE_Answer[] |
|
954 | - */ |
|
955 | - public function answers($query_params = null) |
|
956 | - { |
|
957 | - return $this->get_many_related('Answer', $query_params); |
|
958 | - } |
|
959 | - |
|
960 | - |
|
961 | - /** |
|
962 | - * Gets the registration's answer value to the specified question |
|
963 | - * (either the question's ID or a question object) |
|
964 | - * |
|
965 | - * @param EE_Question|int $question |
|
966 | - * @param bool $pretty_value |
|
967 | - * @return array|string if pretty_value= true, the result will always be a string |
|
968 | - * (because the answer might be an array of answer values, so passing pretty_value=true |
|
969 | - * will convert it into some kind of string) |
|
970 | - */ |
|
971 | - public function answer_value_to_question($question, $pretty_value = true) |
|
972 | - { |
|
973 | - $question_id = EEM_Question::instance()->ensure_is_ID($question); |
|
974 | - return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value); |
|
975 | - } |
|
976 | - |
|
977 | - |
|
978 | - /** |
|
979 | - * question_groups |
|
980 | - * returns an array of EE_Question_Group objects for this registration |
|
981 | - * |
|
982 | - * @return EE_Question_Group[] |
|
983 | - */ |
|
984 | - public function question_groups() |
|
985 | - { |
|
986 | - $question_groups = array(); |
|
987 | - if ($this->event() instanceof EE_Event) { |
|
988 | - $question_groups = $this->event()->question_groups( |
|
989 | - array( |
|
990 | - array( |
|
991 | - 'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false, |
|
992 | - ), |
|
993 | - 'order_by' => array('QSG_order' => 'ASC'), |
|
994 | - ) |
|
995 | - ); |
|
996 | - } |
|
997 | - return $question_groups; |
|
998 | - } |
|
999 | - |
|
1000 | - |
|
1001 | - /** |
|
1002 | - * count_question_groups |
|
1003 | - * returns a count of the number of EE_Question_Group objects for this registration |
|
1004 | - * |
|
1005 | - * @return int |
|
1006 | - */ |
|
1007 | - public function count_question_groups() |
|
1008 | - { |
|
1009 | - $qg_count = 0; |
|
1010 | - if ($this->event() instanceof EE_Event) { |
|
1011 | - $qg_count = $this->event()->count_related( |
|
1012 | - 'Question_Group', |
|
1013 | - array( |
|
1014 | - array( |
|
1015 | - 'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false, |
|
1016 | - ), |
|
1017 | - ) |
|
1018 | - ); |
|
1019 | - } |
|
1020 | - return $qg_count; |
|
1021 | - } |
|
1022 | - |
|
1023 | - |
|
1024 | - /** |
|
1025 | - * Returns the registration date in the 'standard' string format |
|
1026 | - * (function may be improved in the future to allow for different formats and timezones) |
|
1027 | - * |
|
1028 | - * @return string |
|
1029 | - */ |
|
1030 | - public function reg_date() |
|
1031 | - { |
|
1032 | - return $this->get_datetime('REG_date'); |
|
1033 | - } |
|
1034 | - |
|
1035 | - |
|
1036 | - /** |
|
1037 | - * Gets the datetime-ticket for this registration (ie, it can be used to isolate |
|
1038 | - * the ticket this registration purchased, or the datetime they have registered |
|
1039 | - * to attend) |
|
1040 | - * |
|
1041 | - * @return EE_Datetime_Ticket |
|
1042 | - */ |
|
1043 | - public function datetime_ticket() |
|
1044 | - { |
|
1045 | - return $this->get_first_related('Datetime_Ticket'); |
|
1046 | - } |
|
1047 | - |
|
1048 | - |
|
1049 | - /** |
|
1050 | - * Sets the registration's datetime_ticket. |
|
1051 | - * |
|
1052 | - * @param EE_Datetime_Ticket $datetime_ticket |
|
1053 | - * @return EE_Datetime_Ticket |
|
1054 | - */ |
|
1055 | - public function set_datetime_ticket($datetime_ticket) |
|
1056 | - { |
|
1057 | - return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket'); |
|
1058 | - } |
|
1059 | - |
|
1060 | - /** |
|
1061 | - * Gets deleted |
|
1062 | - * |
|
1063 | - * @return boolean |
|
1064 | - */ |
|
1065 | - public function deleted() |
|
1066 | - { |
|
1067 | - return $this->get('REG_deleted'); |
|
1068 | - } |
|
1069 | - |
|
1070 | - /** |
|
1071 | - * Sets deleted |
|
1072 | - * |
|
1073 | - * @param boolean $deleted |
|
1074 | - * @return boolean |
|
1075 | - */ |
|
1076 | - public function set_deleted($deleted) |
|
1077 | - { |
|
1078 | - if ($deleted) { |
|
1079 | - $this->delete(); |
|
1080 | - } else { |
|
1081 | - $this->restore(); |
|
1082 | - } |
|
1083 | - } |
|
1084 | - |
|
1085 | - |
|
1086 | - /** |
|
1087 | - * Get the status object of this object |
|
1088 | - * |
|
1089 | - * @return EE_Status |
|
1090 | - */ |
|
1091 | - public function status_obj() |
|
1092 | - { |
|
1093 | - return $this->get_first_related('Status'); |
|
1094 | - } |
|
1095 | - |
|
1096 | - |
|
1097 | - /** |
|
1098 | - * Returns the number of times this registration has checked into any of the datetimes |
|
1099 | - * its available for |
|
1100 | - * |
|
1101 | - * @return int |
|
1102 | - */ |
|
1103 | - public function count_checkins() |
|
1104 | - { |
|
1105 | - return $this->get_model()->count_related($this, 'Checkin'); |
|
1106 | - } |
|
1107 | - |
|
1108 | - |
|
1109 | - /** |
|
1110 | - * Returns the number of current Check-ins this registration is checked into for any of the datetimes the |
|
1111 | - * registration is for. Note, this is ONLY checked in (does not include checkedout) |
|
1112 | - * |
|
1113 | - * @return int |
|
1114 | - */ |
|
1115 | - public function count_checkins_not_checkedout() |
|
1116 | - { |
|
1117 | - return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1))); |
|
1118 | - } |
|
1119 | - |
|
1120 | - |
|
1121 | - /** |
|
1122 | - * The purpose of this method is simply to check whether this registration can checkin to the given datetime. |
|
1123 | - * |
|
1124 | - * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against |
|
1125 | - * @param bool $check_approved This is used to indicate whether the caller wants can_checkin to also |
|
1126 | - * consider registration status as well as datetime access. |
|
1127 | - * @return bool |
|
1128 | - */ |
|
1129 | - public function can_checkin($DTT_OR_ID, $check_approved = true) |
|
1130 | - { |
|
1131 | - $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID); |
|
1132 | - |
|
1133 | - //first check registration status |
|
1134 | - if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) { |
|
1135 | - return false; |
|
1136 | - } |
|
1137 | - //is there a datetime ticket that matches this dtt_ID? |
|
1138 | - if (! (EEM_Datetime_Ticket::instance()->exists(array( |
|
1139 | - array( |
|
1140 | - 'TKT_ID' => $this->get('TKT_ID'), |
|
1141 | - 'DTT_ID' => $DTT_ID, |
|
1142 | - ), |
|
1143 | - ))) |
|
1144 | - ) { |
|
1145 | - return false; |
|
1146 | - } |
|
1147 | - |
|
1148 | - //final check is against TKT_uses |
|
1149 | - return $this->verify_can_checkin_against_TKT_uses($DTT_ID); |
|
1150 | - } |
|
1151 | - |
|
1152 | - |
|
1153 | - /** |
|
1154 | - * This method verifies whether the user can checkin for the given datetime considering the max uses value set on |
|
1155 | - * the ticket. To do this, a query is done to get the count of the datetime records already checked into. If the |
|
1156 | - * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses, |
|
1157 | - * then return false. Otherwise return true. |
|
1158 | - * |
|
1159 | - * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against |
|
1160 | - * @return bool true means can checkin. false means cannot checkin. |
|
1161 | - */ |
|
1162 | - public function verify_can_checkin_against_TKT_uses($DTT_OR_ID) |
|
1163 | - { |
|
1164 | - $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID); |
|
1165 | - |
|
1166 | - if (! $DTT_ID) { |
|
1167 | - return false; |
|
1168 | - } |
|
1169 | - |
|
1170 | - $max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF; |
|
1171 | - |
|
1172 | - // if max uses is not set or equals infinity then return true cause its not a factor for whether user can check-in |
|
1173 | - // or not. |
|
1174 | - if (! $max_uses || $max_uses === EE_INF) { |
|
1175 | - return true; |
|
1176 | - } |
|
1177 | - |
|
1178 | - //does this datetime have a checkin record? If so, then the dtt count has already been verified so we can just |
|
1179 | - //go ahead and toggle. |
|
1180 | - if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) { |
|
1181 | - return true; |
|
1182 | - } |
|
1183 | - |
|
1184 | - //made it here so the last check is whether the number of checkins per unique datetime on this registration |
|
1185 | - //disallows further check-ins. |
|
1186 | - $count_unique_dtt_checkins = EEM_Checkin::instance()->count(array( |
|
1187 | - array( |
|
1188 | - 'REG_ID' => $this->ID(), |
|
1189 | - 'CHK_in' => true, |
|
1190 | - ), |
|
1191 | - ), 'DTT_ID', true); |
|
1192 | - // checkins have already reached their max number of uses |
|
1193 | - // so registrant can NOT checkin |
|
1194 | - if ($count_unique_dtt_checkins >= $max_uses) { |
|
1195 | - EE_Error::add_error(__('Check-in denied because number of datetime uses for the ticket has been reached or exceeded.', |
|
1196 | - 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
1197 | - return false; |
|
1198 | - } |
|
1199 | - return true; |
|
1200 | - } |
|
1201 | - |
|
1202 | - |
|
1203 | - /** |
|
1204 | - * toggle Check-in status for this registration |
|
1205 | - * Check-ins are toggled in the following order: |
|
1206 | - * never checked in -> checked in |
|
1207 | - * checked in -> checked out |
|
1208 | - * checked out -> checked in |
|
1209 | - * |
|
1210 | - * @param int $DTT_ID include specific datetime to toggle Check-in for. |
|
1211 | - * If not included or null, then it is assumed latest datetime is being toggled. |
|
1212 | - * @param bool $verify If true then can_checkin() is used to verify whether the person |
|
1213 | - * can be checked in or not. Otherwise this forces change in checkin status. |
|
1214 | - * @return bool|int the chk_in status toggled to OR false if nothing got changed. |
|
1215 | - * @throws EE_Error |
|
1216 | - */ |
|
1217 | - public function toggle_checkin_status($DTT_ID = null, $verify = false) |
|
1218 | - { |
|
1219 | - if (empty($DTT_ID)) { |
|
1220 | - $datetime = $this->get_latest_related_datetime(); |
|
1221 | - $DTT_ID = $datetime instanceof EE_Datetime ? $datetime->ID() : 0; |
|
1222 | - // verify the registration can checkin for the given DTT_ID |
|
1223 | - } elseif (! $this->can_checkin($DTT_ID, $verify)) { |
|
1224 | - EE_Error::add_error( |
|
1225 | - sprintf( |
|
1226 | - __('The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access', |
|
1227 | - 'event_espresso'), |
|
1228 | - $this->ID(), |
|
1229 | - $DTT_ID |
|
1230 | - ), |
|
1231 | - __FILE__, __FUNCTION__, __LINE__ |
|
1232 | - ); |
|
1233 | - return false; |
|
1234 | - } |
|
1235 | - $status_paths = array( |
|
1236 | - EE_Registration::checkin_status_never => EE_Registration::checkin_status_in, |
|
1237 | - EE_Registration::checkin_status_in => EE_Registration::checkin_status_out, |
|
1238 | - EE_Registration::checkin_status_out => EE_Registration::checkin_status_in, |
|
1239 | - ); |
|
1240 | - //start by getting the current status so we know what status we'll be changing to. |
|
1241 | - $cur_status = $this->check_in_status_for_datetime($DTT_ID, null); |
|
1242 | - $status_to = $status_paths[$cur_status]; |
|
1243 | - // database only records true for checked IN or false for checked OUT |
|
1244 | - // no record ( null ) means checked in NEVER, but we obviously don't save that |
|
1245 | - $new_status = $status_to === EE_Registration::checkin_status_in ? true : false; |
|
1246 | - // add relation - note Check-ins are always creating new rows |
|
1247 | - // because we are keeping track of Check-ins over time. |
|
1248 | - // Eventually we'll probably want to show a list table |
|
1249 | - // for the individual Check-ins so that they can be managed. |
|
1250 | - $checkin = EE_Checkin::new_instance(array( |
|
1251 | - 'REG_ID' => $this->ID(), |
|
1252 | - 'DTT_ID' => $DTT_ID, |
|
1253 | - 'CHK_in' => $new_status, |
|
1254 | - )); |
|
1255 | - // if the record could not be saved then return false |
|
1256 | - if ($checkin->save() === 0) { |
|
1257 | - if (WP_DEBUG) { |
|
1258 | - global $wpdb; |
|
1259 | - $error = sprintf( |
|
1260 | - __('Registration check in update failed because of the following database error: %1$s%2$s', |
|
1261 | - 'event_espresso'), |
|
1262 | - '<br />', |
|
1263 | - $wpdb->last_error |
|
1264 | - ); |
|
1265 | - } else { |
|
1266 | - $error = __('Registration check in update failed because of an unknown database error', |
|
1267 | - 'event_espresso'); |
|
1268 | - } |
|
1269 | - EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__); |
|
1270 | - return false; |
|
1271 | - } |
|
1272 | - return $status_to; |
|
1273 | - } |
|
1274 | - |
|
1275 | - |
|
1276 | - /** |
|
1277 | - * Returns the latest datetime related to this registration (via the ticket attached to the registration). |
|
1278 | - * "Latest" is defined by the `DTT_EVT_start` column. |
|
1279 | - * |
|
1280 | - * @return EE_Datetime|null |
|
1281 | - * @throws \EE_Error |
|
1282 | - */ |
|
1283 | - public function get_latest_related_datetime() |
|
1284 | - { |
|
1285 | - return EEM_Datetime::instance()->get_one( |
|
1286 | - array( |
|
1287 | - array( |
|
1288 | - 'Ticket.Registration.REG_ID' => $this->ID(), |
|
1289 | - ), |
|
1290 | - 'order_by' => array('DTT_EVT_start' => 'DESC'), |
|
1291 | - ) |
|
1292 | - ); |
|
1293 | - } |
|
1294 | - |
|
1295 | - |
|
1296 | - /** |
|
1297 | - * Returns the earliest datetime related to this registration (via the ticket attached to the registration). |
|
1298 | - * "Earliest" is defined by the `DTT_EVT_start` column. |
|
1299 | - * |
|
1300 | - * @throws \EE_Error |
|
1301 | - */ |
|
1302 | - public function get_earliest_related_datetime() |
|
1303 | - { |
|
1304 | - return EEM_Datetime::instance()->get_one( |
|
1305 | - array( |
|
1306 | - array( |
|
1307 | - 'Ticket.Registration.REG_ID' => $this->ID(), |
|
1308 | - ), |
|
1309 | - 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
1310 | - ) |
|
1311 | - ); |
|
1312 | - } |
|
1313 | - |
|
1314 | - |
|
1315 | - /** |
|
1316 | - * This method simply returns the check-in status for this registration and the given datetime. |
|
1317 | - * If neither the datetime nor the checkin values are provided as arguments, |
|
1318 | - * then this will return the LATEST check-in status for the registration across all datetimes it belongs to. |
|
1319 | - * |
|
1320 | - * @param int $DTT_ID The ID of the datetime we're checking against |
|
1321 | - * (if empty we'll get the primary datetime for |
|
1322 | - * this registration (via event) and use it's ID); |
|
1323 | - * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id. |
|
1324 | - * @return int Integer representing Check-in status. |
|
1325 | - * @throws \EE_Error |
|
1326 | - */ |
|
1327 | - public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null) |
|
1328 | - { |
|
1329 | - $checkin_query_params = array( |
|
1330 | - 'order_by' => array('CHK_timestamp' => 'DESC'), |
|
1331 | - ); |
|
1332 | - |
|
1333 | - if ($DTT_ID > 0) { |
|
1334 | - $checkin_query_params[0] = array('DTT_ID' => $DTT_ID); |
|
1335 | - } |
|
1336 | - |
|
1337 | - //get checkin object (if exists) |
|
1338 | - $checkin = $checkin instanceof EE_Checkin |
|
1339 | - ? $checkin |
|
1340 | - : $this->get_first_related('Checkin', $checkin_query_params); |
|
1341 | - if ($checkin instanceof EE_Checkin) { |
|
1342 | - if ($checkin->get('CHK_in')) { |
|
1343 | - return EE_Registration::checkin_status_in; //checked in |
|
1344 | - } |
|
1345 | - return EE_Registration::checkin_status_out; //had checked in but is now checked out. |
|
1346 | - } |
|
1347 | - return EE_Registration::checkin_status_never; //never been checked in |
|
1348 | - } |
|
1349 | - |
|
1350 | - |
|
1351 | - /** |
|
1352 | - * This method returns a localized message for the toggled Check-in message. |
|
1353 | - * |
|
1354 | - * @param int $DTT_ID include specific datetime to get the correct Check-in message. If not included or null, |
|
1355 | - * then it is assumed Check-in for primary datetime was toggled. |
|
1356 | - * @param bool $error This just flags that you want an error message returned. This is put in so that the error |
|
1357 | - * message can be customized with the attendee name. |
|
1358 | - * @return string internationalized message |
|
1359 | - */ |
|
1360 | - public function get_checkin_msg($DTT_ID, $error = false) |
|
1361 | - { |
|
1362 | - //let's get the attendee first so we can include the name of the attendee |
|
1363 | - $attendee = $this->get_first_related('Attendee'); |
|
1364 | - if ($attendee instanceof EE_Attendee) { |
|
1365 | - if ($error) { |
|
1366 | - return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name()); |
|
1367 | - } |
|
1368 | - $cur_status = $this->check_in_status_for_datetime($DTT_ID); |
|
1369 | - //what is the status message going to be? |
|
1370 | - switch ($cur_status) { |
|
1371 | - case EE_Registration::checkin_status_never : |
|
1372 | - return sprintf(__("%s has been removed from Check-in records", "event_espresso"), |
|
1373 | - $attendee->full_name()); |
|
1374 | - break; |
|
1375 | - case EE_Registration::checkin_status_in : |
|
1376 | - return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name()); |
|
1377 | - break; |
|
1378 | - case EE_Registration::checkin_status_out : |
|
1379 | - return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name()); |
|
1380 | - break; |
|
1381 | - } |
|
1382 | - } |
|
1383 | - return __("The check-in status could not be determined.", "event_espresso"); |
|
1384 | - } |
|
1385 | - |
|
1386 | - |
|
1387 | - /** |
|
1388 | - * Returns the related EE_Transaction to this registration |
|
1389 | - * |
|
1390 | - * @return EE_Transaction |
|
1391 | - */ |
|
1392 | - public function transaction() |
|
1393 | - { |
|
1394 | - $transaction = $this->get_first_related('Transaction'); |
|
1395 | - if (! $transaction instanceof \EE_Transaction) { |
|
1396 | - throw new EntityNotFoundException('Transaction ID', $this->transaction_ID()); |
|
1397 | - } |
|
1398 | - return $transaction; |
|
1399 | - } |
|
1400 | - |
|
1401 | - |
|
1402 | - /** |
|
1403 | - * get Registration Code |
|
1404 | - */ |
|
1405 | - public function reg_code() |
|
1406 | - { |
|
1407 | - return $this->get('REG_code'); |
|
1408 | - } |
|
1409 | - |
|
1410 | - |
|
1411 | - /** |
|
1412 | - * get Transaction ID |
|
1413 | - */ |
|
1414 | - public function transaction_ID() |
|
1415 | - { |
|
1416 | - return $this->get('TXN_ID'); |
|
1417 | - } |
|
1418 | - |
|
1419 | - |
|
1420 | - /** |
|
1421 | - * @return int |
|
1422 | - */ |
|
1423 | - public function ticket_ID() |
|
1424 | - { |
|
1425 | - return $this->get('TKT_ID'); |
|
1426 | - } |
|
1427 | - |
|
1428 | - |
|
1429 | - /** |
|
1430 | - * Set Registration Code |
|
1431 | - * |
|
1432 | - * @access public |
|
1433 | - * @param string $REG_code Registration Code |
|
1434 | - * @param boolean $use_default |
|
1435 | - */ |
|
1436 | - public function set_reg_code($REG_code, $use_default = false) |
|
1437 | - { |
|
1438 | - if (empty($REG_code)) { |
|
1439 | - EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
1440 | - return; |
|
1441 | - } |
|
1442 | - if (! $this->reg_code()) { |
|
1443 | - parent::set('REG_code', $REG_code, $use_default); |
|
1444 | - } else { |
|
1445 | - EE_Error::doing_it_wrong( |
|
1446 | - __CLASS__ . '::' . __FUNCTION__, |
|
1447 | - __('Can not change a registration REG_code once it has been set.', 'event_espresso'), |
|
1448 | - '4.6.0' |
|
1449 | - ); |
|
1450 | - } |
|
1451 | - } |
|
1452 | - |
|
1453 | - |
|
1454 | - /** |
|
1455 | - * Returns all other registrations in the same group as this registrant who have the same ticket option. |
|
1456 | - * Note, if you want to just get all registrations in the same transaction (group), use: |
|
1457 | - * $registration->transaction()->registrations(); |
|
1458 | - * |
|
1459 | - * @since 4.5.0 |
|
1460 | - * @return EE_Registration[] or empty array if this isn't a group registration. |
|
1461 | - */ |
|
1462 | - public function get_all_other_registrations_in_group() |
|
1463 | - { |
|
1464 | - if ($this->group_size() < 2) { |
|
1465 | - return array(); |
|
1466 | - } |
|
1467 | - |
|
1468 | - $query[0] = array( |
|
1469 | - 'TXN_ID' => $this->transaction_ID(), |
|
1470 | - 'REG_ID' => array('!=', $this->ID()), |
|
1471 | - 'TKT_ID' => $this->ticket_ID(), |
|
1472 | - ); |
|
1473 | - |
|
1474 | - $registrations = $this->get_model()->get_all($query); |
|
1475 | - return $registrations; |
|
1476 | - } |
|
1477 | - |
|
1478 | - /** |
|
1479 | - * Return the link to the admin details for the object. |
|
1480 | - * |
|
1481 | - * @return string |
|
1482 | - */ |
|
1483 | - public function get_admin_details_link() |
|
1484 | - { |
|
1485 | - EE_Registry::instance()->load_helper('URL'); |
|
1486 | - return EEH_URL::add_query_args_and_nonce( |
|
1487 | - array( |
|
1488 | - 'page' => 'espresso_registrations', |
|
1489 | - 'action' => 'view_registration', |
|
1490 | - '_REG_ID' => $this->ID(), |
|
1491 | - ), |
|
1492 | - admin_url('admin.php') |
|
1493 | - ); |
|
1494 | - } |
|
1495 | - |
|
1496 | - /** |
|
1497 | - * Returns the link to the editor for the object. Sometimes this is the same as the details. |
|
1498 | - * |
|
1499 | - * @return string |
|
1500 | - */ |
|
1501 | - public function get_admin_edit_link() |
|
1502 | - { |
|
1503 | - return $this->get_admin_details_link(); |
|
1504 | - } |
|
1505 | - |
|
1506 | - /** |
|
1507 | - * Returns the link to a settings page for the object. |
|
1508 | - * |
|
1509 | - * @return string |
|
1510 | - */ |
|
1511 | - public function get_admin_settings_link() |
|
1512 | - { |
|
1513 | - return $this->get_admin_details_link(); |
|
1514 | - } |
|
1515 | - |
|
1516 | - /** |
|
1517 | - * Returns the link to the "overview" for the object (typically the "list table" view). |
|
1518 | - * |
|
1519 | - * @return string |
|
1520 | - */ |
|
1521 | - public function get_admin_overview_link() |
|
1522 | - { |
|
1523 | - EE_Registry::instance()->load_helper('URL'); |
|
1524 | - return EEH_URL::add_query_args_and_nonce( |
|
1525 | - array( |
|
1526 | - 'page' => 'espresso_registrations', |
|
1527 | - ), |
|
1528 | - admin_url('admin.php') |
|
1529 | - ); |
|
1530 | - } |
|
1531 | - |
|
1532 | - |
|
1533 | - /** |
|
1534 | - * @param array $query_params |
|
1535 | - * @return \EE_Registration[] |
|
1536 | - * @throws \EE_Error |
|
1537 | - */ |
|
1538 | - public function payments($query_params = array()) |
|
1539 | - { |
|
1540 | - return $this->get_many_related('Payment', $query_params); |
|
1541 | - } |
|
1542 | - |
|
1543 | - |
|
1544 | - /** |
|
1545 | - * @param array $query_params |
|
1546 | - * @return \EE_Registration_Payment[] |
|
1547 | - * @throws \EE_Error |
|
1548 | - */ |
|
1549 | - public function registration_payments($query_params = array()) |
|
1550 | - { |
|
1551 | - return $this->get_many_related('Registration_Payment', $query_params); |
|
1552 | - } |
|
1553 | - |
|
1554 | - |
|
1555 | - /** |
|
1556 | - * This grabs the payment method corresponding to the last payment made for the amount owing on the registration. |
|
1557 | - * Note: if there are no payments on the registration there will be no payment method returned. |
|
1558 | - * |
|
1559 | - * @return EE_Payment_Method|null |
|
1560 | - */ |
|
1561 | - public function payment_method() |
|
1562 | - { |
|
1563 | - return EEM_Payment_Method::instance()->get_last_used_for_registration($this); |
|
1564 | - } |
|
1565 | - |
|
1566 | - |
|
1567 | - /** |
|
1568 | - * @return \EE_Line_Item |
|
1569 | - * @throws EntityNotFoundException |
|
1570 | - * @throws \EE_Error |
|
1571 | - */ |
|
1572 | - public function ticket_line_item() |
|
1573 | - { |
|
1574 | - $ticket = $this->ticket(); |
|
1575 | - $transaction = $this->transaction(); |
|
1576 | - $line_item = null; |
|
1577 | - $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs( |
|
1578 | - $transaction->total_line_item(), |
|
1579 | - 'Ticket', |
|
1580 | - array($ticket->ID()) |
|
1581 | - ); |
|
1582 | - foreach ($ticket_line_items as $ticket_line_item) { |
|
1583 | - if ( |
|
1584 | - $ticket_line_item instanceof \EE_Line_Item |
|
1585 | - && $ticket_line_item->OBJ_type() === 'Ticket' |
|
1586 | - && $ticket_line_item->OBJ_ID() === $ticket->ID() |
|
1587 | - ) { |
|
1588 | - $line_item = $ticket_line_item; |
|
1589 | - break; |
|
1590 | - } |
|
1591 | - } |
|
1592 | - if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) { |
|
1593 | - throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID()); |
|
1594 | - } |
|
1595 | - return $line_item; |
|
1596 | - } |
|
1597 | - |
|
1598 | - |
|
1599 | - /** |
|
1600 | - * Soft Deletes this model object. |
|
1601 | - * |
|
1602 | - * @return boolean | int |
|
1603 | - * @throws \RuntimeException |
|
1604 | - * @throws \EE_Error |
|
1605 | - */ |
|
1606 | - public function delete() |
|
1607 | - { |
|
1608 | - if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) { |
|
1609 | - $this->set_status(EEM_Registration::status_id_cancelled); |
|
1610 | - } |
|
1611 | - return parent::delete(); |
|
1612 | - } |
|
1613 | - |
|
1614 | - |
|
1615 | - /** |
|
1616 | - * Restores whatever the previous status was on a registration before it was trashed (if possible) |
|
1617 | - * |
|
1618 | - * @throws \EE_Error |
|
1619 | - * @throws \RuntimeException |
|
1620 | - */ |
|
1621 | - public function restore() |
|
1622 | - { |
|
1623 | - $previous_status = $this->get_extra_meta( |
|
1624 | - EE_Registration::PRE_TRASH_REG_STATUS_KEY, |
|
1625 | - true, |
|
1626 | - EEM_Registration::status_id_cancelled |
|
1627 | - ); |
|
1628 | - if ($previous_status) { |
|
1629 | - $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY); |
|
1630 | - $this->set_status($previous_status); |
|
1631 | - } |
|
1632 | - return parent::restore(); |
|
1633 | - } |
|
1634 | - |
|
1635 | - |
|
1636 | - |
|
1637 | - /*************************** DEPRECATED ***************************/ |
|
1638 | - |
|
1639 | - |
|
1640 | - /** |
|
1641 | - * @deprecated |
|
1642 | - * @since 4.7.0 |
|
1643 | - * @access public |
|
1644 | - */ |
|
1645 | - public function price_paid() |
|
1646 | - { |
|
1647 | - EE_Error::doing_it_wrong('EE_Registration::price_paid()', |
|
1648 | - __('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'), |
|
1649 | - '4.7.0'); |
|
1650 | - return $this->final_price(); |
|
1651 | - } |
|
1652 | - |
|
1653 | - |
|
1654 | - /** |
|
1655 | - * @deprecated |
|
1656 | - * @since 4.7.0 |
|
1657 | - * @access public |
|
1658 | - * @param float $REG_final_price |
|
1659 | - */ |
|
1660 | - public function set_price_paid($REG_final_price = 0.00) |
|
1661 | - { |
|
1662 | - EE_Error::doing_it_wrong('EE_Registration::set_price_paid()', |
|
1663 | - __('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'), |
|
1664 | - '4.7.0'); |
|
1665 | - $this->set_final_price($REG_final_price); |
|
1666 | - } |
|
1667 | - |
|
1668 | - |
|
1669 | - /** |
|
1670 | - * @deprecated |
|
1671 | - * @since 4.7.0 |
|
1672 | - * @return string |
|
1673 | - */ |
|
1674 | - public function pretty_price_paid() |
|
1675 | - { |
|
1676 | - EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()', |
|
1677 | - __('This method is deprecated, please use EE_Registration::pretty_final_price() instead.', |
|
1678 | - 'event_espresso'), '4.7.0'); |
|
1679 | - return $this->pretty_final_price(); |
|
1680 | - } |
|
1681 | - |
|
1682 | - |
|
1683 | - /** |
|
1684 | - * Gets the primary datetime related to this registration via the related Event to this registration |
|
1685 | - * |
|
1686 | - * @deprecated 4.9.17 |
|
1687 | - * @return EE_Datetime |
|
1688 | - */ |
|
1689 | - public function get_related_primary_datetime() |
|
1690 | - { |
|
1691 | - EE_Error::doing_it_wrong( |
|
1692 | - __METHOD__, |
|
1693 | - esc_html__( |
|
1694 | - 'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()', |
|
1695 | - 'event_espresso' |
|
1696 | - ), |
|
1697 | - '4.9.17', |
|
1698 | - '5.0.0' |
|
1699 | - ); |
|
1700 | - return $this->event()->primary_datetime(); |
|
1701 | - } |
|
18 | + /** |
|
19 | + * Used to reference when a registration has never been checked in. |
|
20 | + * |
|
21 | + * @type int |
|
22 | + */ |
|
23 | + const checkin_status_never = 2; |
|
24 | + |
|
25 | + /** |
|
26 | + * Used to reference when a registration has been checked in. |
|
27 | + * |
|
28 | + * @type int |
|
29 | + */ |
|
30 | + const checkin_status_in = 1; |
|
31 | + |
|
32 | + |
|
33 | + /** |
|
34 | + * Used to reference when a registration has been checked out. |
|
35 | + * |
|
36 | + * @type int |
|
37 | + */ |
|
38 | + const checkin_status_out = 0; |
|
39 | + |
|
40 | + |
|
41 | + /** |
|
42 | + * extra meta key for tracking reg status os trashed registrations |
|
43 | + * |
|
44 | + * @type string |
|
45 | + */ |
|
46 | + const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status'; |
|
47 | + |
|
48 | + |
|
49 | + /** |
|
50 | + * extra meta key for tracking if registration has reserved ticket |
|
51 | + * |
|
52 | + * @type string |
|
53 | + */ |
|
54 | + const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket'; |
|
55 | + |
|
56 | + |
|
57 | + /** |
|
58 | + * @param array $props_n_values incoming values |
|
59 | + * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
60 | + * used.) |
|
61 | + * @param array $date_formats incoming date_formats in an array where the first value is the |
|
62 | + * date_format and the second value is the time format |
|
63 | + * @return EE_Registration |
|
64 | + */ |
|
65 | + public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
66 | + { |
|
67 | + $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
68 | + return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats); |
|
69 | + } |
|
70 | + |
|
71 | + |
|
72 | + /** |
|
73 | + * @param array $props_n_values incoming values from the database |
|
74 | + * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
75 | + * the website will be used. |
|
76 | + * @return EE_Registration |
|
77 | + */ |
|
78 | + public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
79 | + { |
|
80 | + return new self($props_n_values, true, $timezone); |
|
81 | + } |
|
82 | + |
|
83 | + |
|
84 | + /** |
|
85 | + * Set Event ID |
|
86 | + * |
|
87 | + * @param int $EVT_ID Event ID |
|
88 | + */ |
|
89 | + public function set_event($EVT_ID = 0) |
|
90 | + { |
|
91 | + $this->set('EVT_ID', $EVT_ID); |
|
92 | + } |
|
93 | + |
|
94 | + |
|
95 | + /** |
|
96 | + * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can |
|
97 | + * be routed to internal methods |
|
98 | + * |
|
99 | + * @param string $field_name |
|
100 | + * @param mixed $field_value |
|
101 | + * @param bool $use_default |
|
102 | + * @throws \EE_Error |
|
103 | + * @throws \RuntimeException |
|
104 | + */ |
|
105 | + public function set($field_name, $field_value, $use_default = false) |
|
106 | + { |
|
107 | + switch ($field_name) { |
|
108 | + case 'REG_code' : |
|
109 | + if (! empty($field_value) && $this->reg_code() === null) { |
|
110 | + $this->set_reg_code($field_value, $use_default); |
|
111 | + } |
|
112 | + break; |
|
113 | + case 'STS_ID' : |
|
114 | + $this->set_status($field_value, $use_default); |
|
115 | + break; |
|
116 | + default : |
|
117 | + parent::set($field_name, $field_value, $use_default); |
|
118 | + } |
|
119 | + } |
|
120 | + |
|
121 | + |
|
122 | + /** |
|
123 | + * Set Status ID |
|
124 | + * updates the registration status and ALSO... |
|
125 | + * calls reserve_registration_space() if the reg status changes TO approved from any other reg status |
|
126 | + * calls release_registration_space() if the reg status changes FROM approved to any other reg status |
|
127 | + * |
|
128 | + * @param string $new_STS_ID |
|
129 | + * @param boolean $use_default |
|
130 | + * @return bool |
|
131 | + * @throws \RuntimeException |
|
132 | + * @throws \EE_Error |
|
133 | + */ |
|
134 | + public function set_status($new_STS_ID = null, $use_default = false) |
|
135 | + { |
|
136 | + // get current REG_Status |
|
137 | + $old_STS_ID = $this->status_ID(); |
|
138 | + // if status has changed |
|
139 | + if ( |
|
140 | + $old_STS_ID !== $new_STS_ID // and that status has actually changed |
|
141 | + && ! empty($old_STS_ID) // and that old status is actually set |
|
142 | + && ! empty($new_STS_ID) // as well as the new status |
|
143 | + && $this->ID() // ensure registration is in the db |
|
144 | + ) { |
|
145 | + // TO approved |
|
146 | + if ($new_STS_ID === EEM_Registration::status_id_approved) { |
|
147 | + // reserve a space by incrementing ticket and datetime sold values |
|
148 | + $this->_reserve_registration_space(); |
|
149 | + do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID); |
|
150 | + // OR FROM approved |
|
151 | + } else if ($old_STS_ID === EEM_Registration::status_id_approved) { |
|
152 | + // release a space by decrementing ticket and datetime sold values |
|
153 | + $this->_release_registration_space(); |
|
154 | + do_action('AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID); |
|
155 | + } |
|
156 | + // update status |
|
157 | + parent::set('STS_ID', $new_STS_ID, $use_default); |
|
158 | + $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID); |
|
159 | + /** @type EE_Transaction_Payments $transaction_payments */ |
|
160 | + $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
161 | + $transaction_payments->recalculate_transaction_total($this->transaction(), false); |
|
162 | + $this->transaction()->update_status_based_on_total_paid(true); |
|
163 | + do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID); |
|
164 | + return true; |
|
165 | + } |
|
166 | + //even though the old value matches the new value, it's still good to |
|
167 | + //allow the parent set method to have a say |
|
168 | + parent::set('STS_ID', $new_STS_ID, $use_default); |
|
169 | + return true; |
|
170 | + } |
|
171 | + |
|
172 | + |
|
173 | + /** |
|
174 | + * update REGs and TXN when cancelled or declined registrations involved |
|
175 | + * |
|
176 | + * @param string $new_STS_ID |
|
177 | + * @param string $old_STS_ID |
|
178 | + * @throws \EE_Error |
|
179 | + */ |
|
180 | + private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID) |
|
181 | + { |
|
182 | + // these reg statuses should not be considered in any calculations involving monies owing |
|
183 | + $closed_reg_statuses = EEM_Registration::closed_reg_statuses(); |
|
184 | + // true if registration has been cancelled or declined |
|
185 | + if ( |
|
186 | + in_array($new_STS_ID, $closed_reg_statuses, true) |
|
187 | + && ! in_array($old_STS_ID, $closed_reg_statuses, true) |
|
188 | + ) { |
|
189 | + /** @type EE_Registration_Processor $registration_processor */ |
|
190 | + $registration_processor = EE_Registry::instance()->load_class('Registration_Processor'); |
|
191 | + /** @type EE_Transaction_Processor $transaction_processor */ |
|
192 | + $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
193 | + // cancelled or declined registration |
|
194 | + $registration_processor->update_registration_after_being_canceled_or_declined( |
|
195 | + $this, |
|
196 | + $closed_reg_statuses |
|
197 | + ); |
|
198 | + $transaction_processor->update_transaction_after_canceled_or_declined_registration( |
|
199 | + $this, |
|
200 | + $closed_reg_statuses, |
|
201 | + false |
|
202 | + ); |
|
203 | + do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID); |
|
204 | + return; |
|
205 | + } |
|
206 | + // true if reinstating cancelled or declined registration |
|
207 | + if ( |
|
208 | + in_array($old_STS_ID, $closed_reg_statuses, true) |
|
209 | + && ! in_array($new_STS_ID, $closed_reg_statuses, true) |
|
210 | + ) { |
|
211 | + /** @type EE_Registration_Processor $registration_processor */ |
|
212 | + $registration_processor = EE_Registry::instance()->load_class('Registration_Processor'); |
|
213 | + /** @type EE_Transaction_Processor $transaction_processor */ |
|
214 | + $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
215 | + // reinstating cancelled or declined registration |
|
216 | + $registration_processor->update_canceled_or_declined_registration_after_being_reinstated( |
|
217 | + $this, |
|
218 | + $closed_reg_statuses |
|
219 | + ); |
|
220 | + $transaction_processor->update_transaction_after_reinstating_canceled_registration( |
|
221 | + $this, |
|
222 | + $closed_reg_statuses, |
|
223 | + false |
|
224 | + ); |
|
225 | + do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID); |
|
226 | + } |
|
227 | + } |
|
228 | + |
|
229 | + |
|
230 | + /** |
|
231 | + * get Status ID |
|
232 | + */ |
|
233 | + public function status_ID() |
|
234 | + { |
|
235 | + return $this->get('STS_ID'); |
|
236 | + } |
|
237 | + |
|
238 | + |
|
239 | + /** |
|
240 | + * increments this registration's related ticket sold and corresponding datetime sold values |
|
241 | + * |
|
242 | + * @return void |
|
243 | + * @throws \EE_Error |
|
244 | + */ |
|
245 | + private function _reserve_registration_space() |
|
246 | + { |
|
247 | + // reserved ticket and datetime counts will be decremented as sold counts are incremented |
|
248 | + // so stop tracking that this reg has a ticket reserved |
|
249 | + $this->release_reserved_ticket(); |
|
250 | + $ticket = $this->ticket(); |
|
251 | + $ticket->increase_sold(); |
|
252 | + $ticket->save(); |
|
253 | + // possibly set event status to sold out |
|
254 | + $this->event()->perform_sold_out_status_check(); |
|
255 | + } |
|
256 | + |
|
257 | + |
|
258 | + /** |
|
259 | + * Gets the ticket this registration is for |
|
260 | + * |
|
261 | + * @param boolean $include_archived whether to include archived tickets or not. |
|
262 | + * @return EE_Ticket|EE_Base_Class |
|
263 | + * @throws \EE_Error |
|
264 | + */ |
|
265 | + public function ticket($include_archived = true) |
|
266 | + { |
|
267 | + $query_params = array(); |
|
268 | + if ($include_archived) { |
|
269 | + $query_params['default_where_conditions'] = 'none'; |
|
270 | + } |
|
271 | + return $this->get_first_related('Ticket', $query_params); |
|
272 | + } |
|
273 | + |
|
274 | + |
|
275 | + /** |
|
276 | + * Gets the event this registration is for |
|
277 | + * |
|
278 | + * @return EE_Event |
|
279 | + */ |
|
280 | + public function event() |
|
281 | + { |
|
282 | + $event = $this->get_first_related('Event'); |
|
283 | + if (! $event instanceof \EE_Event) { |
|
284 | + throw new EntityNotFoundException('Event ID', $this->event_ID()); |
|
285 | + } |
|
286 | + return $event; |
|
287 | + } |
|
288 | + |
|
289 | + |
|
290 | + /** |
|
291 | + * Gets the "author" of the registration. Note that for the purposes of registrations, the author will correspond |
|
292 | + * with the author of the event this registration is for. |
|
293 | + * |
|
294 | + * @since 4.5.0 |
|
295 | + * @return int |
|
296 | + */ |
|
297 | + public function wp_user() |
|
298 | + { |
|
299 | + $event = $this->event(); |
|
300 | + if ($event instanceof EE_Event) { |
|
301 | + return $event->wp_user(); |
|
302 | + } |
|
303 | + return 0; |
|
304 | + } |
|
305 | + |
|
306 | + |
|
307 | + /** |
|
308 | + * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values |
|
309 | + * |
|
310 | + * @return void |
|
311 | + * @throws \EE_Error |
|
312 | + */ |
|
313 | + private function _release_registration_space() |
|
314 | + { |
|
315 | + $ticket = $this->ticket(); |
|
316 | + $ticket->decrease_sold(); |
|
317 | + $ticket->save(); |
|
318 | + } |
|
319 | + |
|
320 | + |
|
321 | + /** |
|
322 | + * tracks this registration's ticket reservation in extra meta |
|
323 | + * and can increment related ticket reserved and corresponding datetime reserved values |
|
324 | + * |
|
325 | + * @param bool $update_ticket if true, will increment ticket and datetime reserved count |
|
326 | + * @return void |
|
327 | + * @throws \EE_Error |
|
328 | + */ |
|
329 | + public function reserve_ticket($update_ticket = false) |
|
330 | + { |
|
331 | + if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) { |
|
332 | + // PLZ NOTE: although checking $update_ticket first would be more efficient, |
|
333 | + // we NEED to ALWAYS call update_extra_meta(), which is why that is done first |
|
334 | + if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) { |
|
335 | + $ticket = $this->ticket(); |
|
336 | + $ticket->increase_reserved(); |
|
337 | + $ticket->save(); |
|
338 | + } |
|
339 | + } |
|
340 | + } |
|
341 | + |
|
342 | + |
|
343 | + /** |
|
344 | + * stops tracking this registration's ticket reservation in extra meta |
|
345 | + * decrements (subtracts) related ticket reserved and corresponding datetime reserved values |
|
346 | + * |
|
347 | + * @param bool $update_ticket if true, will decrement ticket and datetime reserved count |
|
348 | + * @return void |
|
349 | + * @throws \EE_Error |
|
350 | + */ |
|
351 | + public function release_reserved_ticket($update_ticket = false) |
|
352 | + { |
|
353 | + if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) { |
|
354 | + // PLZ NOTE: although checking $update_ticket first would be more efficient, |
|
355 | + // we NEED to ALWAYS call delete_extra_meta(), which is why that is done first |
|
356 | + if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) { |
|
357 | + $ticket = $this->ticket(); |
|
358 | + $ticket->decrease_reserved(); |
|
359 | + $ticket->save(); |
|
360 | + } |
|
361 | + } |
|
362 | + } |
|
363 | + |
|
364 | + |
|
365 | + /** |
|
366 | + * Set Attendee ID |
|
367 | + * |
|
368 | + * @param int $ATT_ID Attendee ID |
|
369 | + */ |
|
370 | + public function set_attendee_id($ATT_ID = 0) |
|
371 | + { |
|
372 | + $this->set('ATT_ID', $ATT_ID); |
|
373 | + } |
|
374 | + |
|
375 | + |
|
376 | + /** |
|
377 | + * Set Transaction ID |
|
378 | + * |
|
379 | + * @param int $TXN_ID Transaction ID |
|
380 | + */ |
|
381 | + public function set_transaction_id($TXN_ID = 0) |
|
382 | + { |
|
383 | + $this->set('TXN_ID', $TXN_ID); |
|
384 | + } |
|
385 | + |
|
386 | + |
|
387 | + /** |
|
388 | + * Set Session |
|
389 | + * |
|
390 | + * @param string $REG_session PHP Session ID |
|
391 | + */ |
|
392 | + public function set_session($REG_session = '') |
|
393 | + { |
|
394 | + $this->set('REG_session', $REG_session); |
|
395 | + } |
|
396 | + |
|
397 | + |
|
398 | + /** |
|
399 | + * Set Registration URL Link |
|
400 | + * |
|
401 | + * @param string $REG_url_link Registration URL Link |
|
402 | + */ |
|
403 | + public function set_reg_url_link($REG_url_link = '') |
|
404 | + { |
|
405 | + $this->set('REG_url_link', $REG_url_link); |
|
406 | + } |
|
407 | + |
|
408 | + |
|
409 | + /** |
|
410 | + * Set Attendee Counter |
|
411 | + * |
|
412 | + * @param int $REG_count Primary Attendee |
|
413 | + */ |
|
414 | + public function set_count($REG_count = 1) |
|
415 | + { |
|
416 | + $this->set('REG_count', $REG_count); |
|
417 | + } |
|
418 | + |
|
419 | + |
|
420 | + /** |
|
421 | + * Set Group Size |
|
422 | + * |
|
423 | + * @param boolean $REG_group_size Group Registration |
|
424 | + */ |
|
425 | + public function set_group_size($REG_group_size = false) |
|
426 | + { |
|
427 | + $this->set('REG_group_size', $REG_group_size); |
|
428 | + } |
|
429 | + |
|
430 | + |
|
431 | + /** |
|
432 | + * is_not_approved - convenience method that returns TRUE if REG status ID == |
|
433 | + * EEM_Registration::status_id_not_approved |
|
434 | + * |
|
435 | + * @return boolean |
|
436 | + */ |
|
437 | + public function is_not_approved() |
|
438 | + { |
|
439 | + return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false; |
|
440 | + } |
|
441 | + |
|
442 | + |
|
443 | + /** |
|
444 | + * is_pending_payment - convenience method that returns TRUE if REG status ID == |
|
445 | + * EEM_Registration::status_id_pending_payment |
|
446 | + * |
|
447 | + * @return boolean |
|
448 | + */ |
|
449 | + public function is_pending_payment() |
|
450 | + { |
|
451 | + return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false; |
|
452 | + } |
|
453 | + |
|
454 | + |
|
455 | + /** |
|
456 | + * is_approved - convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved |
|
457 | + * |
|
458 | + * @return boolean |
|
459 | + */ |
|
460 | + public function is_approved() |
|
461 | + { |
|
462 | + return $this->status_ID() == EEM_Registration::status_id_approved ? true : false; |
|
463 | + } |
|
464 | + |
|
465 | + |
|
466 | + /** |
|
467 | + * is_cancelled - convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled |
|
468 | + * |
|
469 | + * @return boolean |
|
470 | + */ |
|
471 | + public function is_cancelled() |
|
472 | + { |
|
473 | + return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false; |
|
474 | + } |
|
475 | + |
|
476 | + |
|
477 | + /** |
|
478 | + * is_declined - convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined |
|
479 | + * |
|
480 | + * @return boolean |
|
481 | + */ |
|
482 | + public function is_declined() |
|
483 | + { |
|
484 | + return $this->status_ID() == EEM_Registration::status_id_declined ? true : false; |
|
485 | + } |
|
486 | + |
|
487 | + |
|
488 | + /** |
|
489 | + * is_incomplete - convenience method that returns TRUE if REG status ID == |
|
490 | + * EEM_Registration::status_id_incomplete |
|
491 | + * |
|
492 | + * @return boolean |
|
493 | + */ |
|
494 | + public function is_incomplete() |
|
495 | + { |
|
496 | + return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false; |
|
497 | + } |
|
498 | + |
|
499 | + |
|
500 | + /** |
|
501 | + * Set Registration Date |
|
502 | + * |
|
503 | + * @param mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of |
|
504 | + * Date |
|
505 | + */ |
|
506 | + public function set_reg_date($REG_date = false) |
|
507 | + { |
|
508 | + $this->set('REG_date', $REG_date); |
|
509 | + } |
|
510 | + |
|
511 | + |
|
512 | + /** |
|
513 | + * Set final price owing for this registration after all ticket/price modifications |
|
514 | + * |
|
515 | + * @access public |
|
516 | + * @param float $REG_final_price |
|
517 | + */ |
|
518 | + public function set_final_price($REG_final_price = 0.00) |
|
519 | + { |
|
520 | + $this->set('REG_final_price', $REG_final_price); |
|
521 | + } |
|
522 | + |
|
523 | + |
|
524 | + /** |
|
525 | + * Set amount paid towards this registration's final price |
|
526 | + * |
|
527 | + * @access public |
|
528 | + * @param float $REG_paid |
|
529 | + */ |
|
530 | + public function set_paid($REG_paid = 0.00) |
|
531 | + { |
|
532 | + $this->set('REG_paid', $REG_paid); |
|
533 | + } |
|
534 | + |
|
535 | + |
|
536 | + /** |
|
537 | + * Attendee Is Going |
|
538 | + * |
|
539 | + * @param boolean $REG_att_is_going Attendee Is Going |
|
540 | + */ |
|
541 | + public function set_att_is_going($REG_att_is_going = false) |
|
542 | + { |
|
543 | + $this->set('REG_att_is_going', $REG_att_is_going); |
|
544 | + } |
|
545 | + |
|
546 | + |
|
547 | + /** |
|
548 | + * Gets the related attendee |
|
549 | + * |
|
550 | + * @return EE_Attendee |
|
551 | + */ |
|
552 | + public function attendee() |
|
553 | + { |
|
554 | + return $this->get_first_related('Attendee'); |
|
555 | + } |
|
556 | + |
|
557 | + |
|
558 | + /** |
|
559 | + * get Event ID |
|
560 | + */ |
|
561 | + public function event_ID() |
|
562 | + { |
|
563 | + return $this->get('EVT_ID'); |
|
564 | + } |
|
565 | + |
|
566 | + |
|
567 | + /** |
|
568 | + * get Event ID |
|
569 | + */ |
|
570 | + public function event_name() |
|
571 | + { |
|
572 | + $event = $this->event_obj(); |
|
573 | + if ($event) { |
|
574 | + return $event->name(); |
|
575 | + } else { |
|
576 | + return null; |
|
577 | + } |
|
578 | + } |
|
579 | + |
|
580 | + |
|
581 | + /** |
|
582 | + * Fetches the event this registration is for |
|
583 | + * |
|
584 | + * @return EE_Event |
|
585 | + */ |
|
586 | + public function event_obj() |
|
587 | + { |
|
588 | + return $this->get_first_related('Event'); |
|
589 | + } |
|
590 | + |
|
591 | + |
|
592 | + /** |
|
593 | + * get Attendee ID |
|
594 | + */ |
|
595 | + public function attendee_ID() |
|
596 | + { |
|
597 | + return $this->get('ATT_ID'); |
|
598 | + } |
|
599 | + |
|
600 | + |
|
601 | + /** |
|
602 | + * get PHP Session ID |
|
603 | + */ |
|
604 | + public function session_ID() |
|
605 | + { |
|
606 | + return $this->get('REG_session'); |
|
607 | + } |
|
608 | + |
|
609 | + |
|
610 | + /** |
|
611 | + * Gets the string which represents the URL trigger for the receipt template in the message template system. |
|
612 | + * |
|
613 | + * @param string $messenger 'pdf' or 'html'. Default 'html'. |
|
614 | + * @return string |
|
615 | + */ |
|
616 | + public function receipt_url($messenger = 'html') |
|
617 | + { |
|
618 | + |
|
619 | + /** |
|
620 | + * The below will be deprecated one version after this. We check first if there is a custom receipt template already in use on old system. If there is then we just return the standard url for it. |
|
621 | + * |
|
622 | + * @since 4.5.0 |
|
623 | + */ |
|
624 | + $template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php'; |
|
625 | + $has_custom = EEH_Template::locate_template($template_relative_path, array(), true, true, true); |
|
626 | + |
|
627 | + if ($has_custom) { |
|
628 | + return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch')); |
|
629 | + } |
|
630 | + return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt'); |
|
631 | + } |
|
632 | + |
|
633 | + |
|
634 | + /** |
|
635 | + * Gets the string which represents the URL trigger for the invoice template in the message template system. |
|
636 | + * |
|
637 | + * @param string $messenger 'pdf' or 'html'. Default 'html'. |
|
638 | + * @return string |
|
639 | + */ |
|
640 | + public function invoice_url($messenger = 'html') |
|
641 | + { |
|
642 | + /** |
|
643 | + * The below will be deprecated one version after this. We check first if there is a custom invoice template already in use on old system. If there is then we just return the standard url for it. |
|
644 | + * |
|
645 | + * @since 4.5.0 |
|
646 | + */ |
|
647 | + $template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php'; |
|
648 | + $has_custom = EEH_Template::locate_template($template_relative_path, array(), true, true, true); |
|
649 | + |
|
650 | + if ($has_custom) { |
|
651 | + if ($messenger == 'html') { |
|
652 | + return $this->invoice_url('launch'); |
|
653 | + } |
|
654 | + $route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice'; |
|
655 | + |
|
656 | + $query_args = array('ee' => $route, 'id' => $this->reg_url_link()); |
|
657 | + if ($messenger == 'html') { |
|
658 | + $query_args['html'] = true; |
|
659 | + } |
|
660 | + return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id)); |
|
661 | + } |
|
662 | + return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice'); |
|
663 | + } |
|
664 | + |
|
665 | + |
|
666 | + /** |
|
667 | + * get Registration URL Link |
|
668 | + * |
|
669 | + * @access public |
|
670 | + * @return string |
|
671 | + * @throws \EE_Error |
|
672 | + */ |
|
673 | + public function reg_url_link() |
|
674 | + { |
|
675 | + return (string)$this->get('REG_url_link'); |
|
676 | + } |
|
677 | + |
|
678 | + |
|
679 | + /** |
|
680 | + * Echoes out invoice_url() |
|
681 | + * |
|
682 | + * @param string $type 'download','launch', or 'html' (default is 'launch') |
|
683 | + * @return void |
|
684 | + */ |
|
685 | + public function e_invoice_url($type = 'launch') |
|
686 | + { |
|
687 | + echo $this->invoice_url($type); |
|
688 | + } |
|
689 | + |
|
690 | + |
|
691 | + /** |
|
692 | + * Echoes out payment_overview_url |
|
693 | + */ |
|
694 | + public function e_payment_overview_url() |
|
695 | + { |
|
696 | + echo $this->payment_overview_url(); |
|
697 | + } |
|
698 | + |
|
699 | + |
|
700 | + /** |
|
701 | + * Gets the URL of the thank you page with this registration REG_url_link added as |
|
702 | + * a query parameter |
|
703 | + * |
|
704 | + * @return string |
|
705 | + */ |
|
706 | + public function payment_overview_url() |
|
707 | + { |
|
708 | + return add_query_arg(array( |
|
709 | + 'e_reg_url_link' => $this->reg_url_link(), |
|
710 | + 'step' => 'payment_options', |
|
711 | + 'revisit' => true, |
|
712 | + ), EE_Registry::instance()->CFG->core->reg_page_url()); |
|
713 | + } |
|
714 | + |
|
715 | + |
|
716 | + /** |
|
717 | + * Gets the URL of the thank you page with this registration REG_url_link added as |
|
718 | + * a query parameter |
|
719 | + * |
|
720 | + * @return string |
|
721 | + */ |
|
722 | + public function edit_attendee_information_url() |
|
723 | + { |
|
724 | + return add_query_arg(array( |
|
725 | + 'e_reg_url_link' => $this->reg_url_link(), |
|
726 | + 'step' => 'attendee_information', |
|
727 | + 'revisit' => true, |
|
728 | + ), EE_Registry::instance()->CFG->core->reg_page_url()); |
|
729 | + } |
|
730 | + |
|
731 | + |
|
732 | + /** |
|
733 | + * Simply generates and returns the appropriate admin_url link to edit this registration |
|
734 | + * |
|
735 | + * @return string |
|
736 | + */ |
|
737 | + public function get_admin_edit_url() |
|
738 | + { |
|
739 | + return EEH_URL::add_query_args_and_nonce(array( |
|
740 | + 'page' => 'espresso_registrations', |
|
741 | + 'action' => 'view_registration', |
|
742 | + '_REG_ID' => $this->ID(), |
|
743 | + ), admin_url('admin.php')); |
|
744 | + } |
|
745 | + |
|
746 | + |
|
747 | + /** |
|
748 | + * is_primary_registrant? |
|
749 | + */ |
|
750 | + public function is_primary_registrant() |
|
751 | + { |
|
752 | + return $this->get('REG_count') == 1 ? true : false; |
|
753 | + } |
|
754 | + |
|
755 | + |
|
756 | + /** |
|
757 | + * This returns the primary registration object for this registration group (which may be this object). |
|
758 | + * |
|
759 | + * @return EE_Registration |
|
760 | + */ |
|
761 | + public function get_primary_registration() |
|
762 | + { |
|
763 | + if ($this->is_primary_registrant()) { |
|
764 | + return $this; |
|
765 | + } |
|
766 | + |
|
767 | + //k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1 |
|
768 | + $primary_registrant = EEM_Registration::instance()->get_one(array( |
|
769 | + array( |
|
770 | + 'TXN_ID' => $this->transaction_ID(), |
|
771 | + 'REG_count' => 1, |
|
772 | + ), |
|
773 | + )); |
|
774 | + return $primary_registrant; |
|
775 | + } |
|
776 | + |
|
777 | + |
|
778 | + /** |
|
779 | + * get Attendee Number |
|
780 | + * |
|
781 | + * @access public |
|
782 | + */ |
|
783 | + public function count() |
|
784 | + { |
|
785 | + return $this->get('REG_count'); |
|
786 | + } |
|
787 | + |
|
788 | + |
|
789 | + /** |
|
790 | + * get Group Size |
|
791 | + */ |
|
792 | + public function group_size() |
|
793 | + { |
|
794 | + return $this->get('REG_group_size'); |
|
795 | + } |
|
796 | + |
|
797 | + |
|
798 | + /** |
|
799 | + * get Registration Date |
|
800 | + */ |
|
801 | + public function date() |
|
802 | + { |
|
803 | + return $this->get('REG_date'); |
|
804 | + } |
|
805 | + |
|
806 | + |
|
807 | + /** |
|
808 | + * gets a pretty date |
|
809 | + * |
|
810 | + * @param string $date_format |
|
811 | + * @param string $time_format |
|
812 | + * @return string |
|
813 | + */ |
|
814 | + public function pretty_date($date_format = null, $time_format = null) |
|
815 | + { |
|
816 | + return $this->get_datetime('REG_date', $date_format, $time_format); |
|
817 | + } |
|
818 | + |
|
819 | + |
|
820 | + /** |
|
821 | + * final_price |
|
822 | + * the registration's share of the transaction total, so that the |
|
823 | + * sum of all the transaction's REG_final_prices equal the transaction's total |
|
824 | + * |
|
825 | + * @return float |
|
826 | + */ |
|
827 | + public function final_price() |
|
828 | + { |
|
829 | + return $this->get('REG_final_price'); |
|
830 | + } |
|
831 | + |
|
832 | + |
|
833 | + /** |
|
834 | + * pretty_final_price |
|
835 | + * final price as formatted string, with correct decimal places and currency symbol |
|
836 | + * |
|
837 | + * @return string |
|
838 | + */ |
|
839 | + public function pretty_final_price() |
|
840 | + { |
|
841 | + return $this->get_pretty('REG_final_price'); |
|
842 | + } |
|
843 | + |
|
844 | + |
|
845 | + /** |
|
846 | + * get paid (yeah) |
|
847 | + * |
|
848 | + * @return float |
|
849 | + */ |
|
850 | + public function paid() |
|
851 | + { |
|
852 | + return $this->get('REG_paid'); |
|
853 | + } |
|
854 | + |
|
855 | + |
|
856 | + /** |
|
857 | + * pretty_paid |
|
858 | + * |
|
859 | + * @return float |
|
860 | + */ |
|
861 | + public function pretty_paid() |
|
862 | + { |
|
863 | + return $this->get_pretty('REG_paid'); |
|
864 | + } |
|
865 | + |
|
866 | + |
|
867 | + /** |
|
868 | + * owes_monies_and_can_pay |
|
869 | + * whether or not this registration has monies owing and it's' status allows payment |
|
870 | + * |
|
871 | + * @param array $requires_payment |
|
872 | + * @return bool |
|
873 | + */ |
|
874 | + public function owes_monies_and_can_pay($requires_payment = array()) |
|
875 | + { |
|
876 | + // these reg statuses require payment (if event is not free) |
|
877 | + $requires_payment = ! empty($requires_payment) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment(); |
|
878 | + if ( |
|
879 | + in_array($this->status_ID(), $requires_payment) && |
|
880 | + $this->final_price() != 0 && |
|
881 | + $this->final_price() != $this->paid() |
|
882 | + ) { |
|
883 | + return true; |
|
884 | + } else { |
|
885 | + return false; |
|
886 | + } |
|
887 | + } |
|
888 | + |
|
889 | + |
|
890 | + /** |
|
891 | + * Prints out the return value of $this->pretty_status() |
|
892 | + * |
|
893 | + * @param bool $show_icons |
|
894 | + * @return void |
|
895 | + */ |
|
896 | + public function e_pretty_status($show_icons = false) |
|
897 | + { |
|
898 | + echo $this->pretty_status($show_icons); |
|
899 | + } |
|
900 | + |
|
901 | + |
|
902 | + /** |
|
903 | + * Returns a nice version of the status for displaying to customers |
|
904 | + * |
|
905 | + * @param bool $show_icons |
|
906 | + * @return string |
|
907 | + */ |
|
908 | + public function pretty_status($show_icons = false) |
|
909 | + { |
|
910 | + $status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')), |
|
911 | + false, 'sentence'); |
|
912 | + $icon = ''; |
|
913 | + switch ($this->status_ID()) { |
|
914 | + case EEM_Registration::status_id_approved: |
|
915 | + $icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : ''; |
|
916 | + break; |
|
917 | + case EEM_Registration::status_id_pending_payment: |
|
918 | + $icon = $show_icons ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>' : ''; |
|
919 | + break; |
|
920 | + case EEM_Registration::status_id_not_approved: |
|
921 | + $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>' : ''; |
|
922 | + break; |
|
923 | + case EEM_Registration::status_id_cancelled: |
|
924 | + $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>' : ''; |
|
925 | + break; |
|
926 | + case EEM_Registration::status_id_incomplete: |
|
927 | + $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>' : ''; |
|
928 | + break; |
|
929 | + case EEM_Registration::status_id_declined: |
|
930 | + $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : ''; |
|
931 | + break; |
|
932 | + case EEM_Registration::status_id_wait_list: |
|
933 | + $icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : ''; |
|
934 | + break; |
|
935 | + } |
|
936 | + return $icon . $status[$this->status_ID()]; |
|
937 | + } |
|
938 | + |
|
939 | + |
|
940 | + /** |
|
941 | + * get Attendee Is Going |
|
942 | + */ |
|
943 | + public function att_is_going() |
|
944 | + { |
|
945 | + return $this->get('REG_att_is_going'); |
|
946 | + } |
|
947 | + |
|
948 | + |
|
949 | + /** |
|
950 | + * Gets related answers |
|
951 | + * |
|
952 | + * @param array $query_params like EEM_Base::get_all |
|
953 | + * @return EE_Answer[] |
|
954 | + */ |
|
955 | + public function answers($query_params = null) |
|
956 | + { |
|
957 | + return $this->get_many_related('Answer', $query_params); |
|
958 | + } |
|
959 | + |
|
960 | + |
|
961 | + /** |
|
962 | + * Gets the registration's answer value to the specified question |
|
963 | + * (either the question's ID or a question object) |
|
964 | + * |
|
965 | + * @param EE_Question|int $question |
|
966 | + * @param bool $pretty_value |
|
967 | + * @return array|string if pretty_value= true, the result will always be a string |
|
968 | + * (because the answer might be an array of answer values, so passing pretty_value=true |
|
969 | + * will convert it into some kind of string) |
|
970 | + */ |
|
971 | + public function answer_value_to_question($question, $pretty_value = true) |
|
972 | + { |
|
973 | + $question_id = EEM_Question::instance()->ensure_is_ID($question); |
|
974 | + return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value); |
|
975 | + } |
|
976 | + |
|
977 | + |
|
978 | + /** |
|
979 | + * question_groups |
|
980 | + * returns an array of EE_Question_Group objects for this registration |
|
981 | + * |
|
982 | + * @return EE_Question_Group[] |
|
983 | + */ |
|
984 | + public function question_groups() |
|
985 | + { |
|
986 | + $question_groups = array(); |
|
987 | + if ($this->event() instanceof EE_Event) { |
|
988 | + $question_groups = $this->event()->question_groups( |
|
989 | + array( |
|
990 | + array( |
|
991 | + 'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false, |
|
992 | + ), |
|
993 | + 'order_by' => array('QSG_order' => 'ASC'), |
|
994 | + ) |
|
995 | + ); |
|
996 | + } |
|
997 | + return $question_groups; |
|
998 | + } |
|
999 | + |
|
1000 | + |
|
1001 | + /** |
|
1002 | + * count_question_groups |
|
1003 | + * returns a count of the number of EE_Question_Group objects for this registration |
|
1004 | + * |
|
1005 | + * @return int |
|
1006 | + */ |
|
1007 | + public function count_question_groups() |
|
1008 | + { |
|
1009 | + $qg_count = 0; |
|
1010 | + if ($this->event() instanceof EE_Event) { |
|
1011 | + $qg_count = $this->event()->count_related( |
|
1012 | + 'Question_Group', |
|
1013 | + array( |
|
1014 | + array( |
|
1015 | + 'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false, |
|
1016 | + ), |
|
1017 | + ) |
|
1018 | + ); |
|
1019 | + } |
|
1020 | + return $qg_count; |
|
1021 | + } |
|
1022 | + |
|
1023 | + |
|
1024 | + /** |
|
1025 | + * Returns the registration date in the 'standard' string format |
|
1026 | + * (function may be improved in the future to allow for different formats and timezones) |
|
1027 | + * |
|
1028 | + * @return string |
|
1029 | + */ |
|
1030 | + public function reg_date() |
|
1031 | + { |
|
1032 | + return $this->get_datetime('REG_date'); |
|
1033 | + } |
|
1034 | + |
|
1035 | + |
|
1036 | + /** |
|
1037 | + * Gets the datetime-ticket for this registration (ie, it can be used to isolate |
|
1038 | + * the ticket this registration purchased, or the datetime they have registered |
|
1039 | + * to attend) |
|
1040 | + * |
|
1041 | + * @return EE_Datetime_Ticket |
|
1042 | + */ |
|
1043 | + public function datetime_ticket() |
|
1044 | + { |
|
1045 | + return $this->get_first_related('Datetime_Ticket'); |
|
1046 | + } |
|
1047 | + |
|
1048 | + |
|
1049 | + /** |
|
1050 | + * Sets the registration's datetime_ticket. |
|
1051 | + * |
|
1052 | + * @param EE_Datetime_Ticket $datetime_ticket |
|
1053 | + * @return EE_Datetime_Ticket |
|
1054 | + */ |
|
1055 | + public function set_datetime_ticket($datetime_ticket) |
|
1056 | + { |
|
1057 | + return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket'); |
|
1058 | + } |
|
1059 | + |
|
1060 | + /** |
|
1061 | + * Gets deleted |
|
1062 | + * |
|
1063 | + * @return boolean |
|
1064 | + */ |
|
1065 | + public function deleted() |
|
1066 | + { |
|
1067 | + return $this->get('REG_deleted'); |
|
1068 | + } |
|
1069 | + |
|
1070 | + /** |
|
1071 | + * Sets deleted |
|
1072 | + * |
|
1073 | + * @param boolean $deleted |
|
1074 | + * @return boolean |
|
1075 | + */ |
|
1076 | + public function set_deleted($deleted) |
|
1077 | + { |
|
1078 | + if ($deleted) { |
|
1079 | + $this->delete(); |
|
1080 | + } else { |
|
1081 | + $this->restore(); |
|
1082 | + } |
|
1083 | + } |
|
1084 | + |
|
1085 | + |
|
1086 | + /** |
|
1087 | + * Get the status object of this object |
|
1088 | + * |
|
1089 | + * @return EE_Status |
|
1090 | + */ |
|
1091 | + public function status_obj() |
|
1092 | + { |
|
1093 | + return $this->get_first_related('Status'); |
|
1094 | + } |
|
1095 | + |
|
1096 | + |
|
1097 | + /** |
|
1098 | + * Returns the number of times this registration has checked into any of the datetimes |
|
1099 | + * its available for |
|
1100 | + * |
|
1101 | + * @return int |
|
1102 | + */ |
|
1103 | + public function count_checkins() |
|
1104 | + { |
|
1105 | + return $this->get_model()->count_related($this, 'Checkin'); |
|
1106 | + } |
|
1107 | + |
|
1108 | + |
|
1109 | + /** |
|
1110 | + * Returns the number of current Check-ins this registration is checked into for any of the datetimes the |
|
1111 | + * registration is for. Note, this is ONLY checked in (does not include checkedout) |
|
1112 | + * |
|
1113 | + * @return int |
|
1114 | + */ |
|
1115 | + public function count_checkins_not_checkedout() |
|
1116 | + { |
|
1117 | + return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1))); |
|
1118 | + } |
|
1119 | + |
|
1120 | + |
|
1121 | + /** |
|
1122 | + * The purpose of this method is simply to check whether this registration can checkin to the given datetime. |
|
1123 | + * |
|
1124 | + * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against |
|
1125 | + * @param bool $check_approved This is used to indicate whether the caller wants can_checkin to also |
|
1126 | + * consider registration status as well as datetime access. |
|
1127 | + * @return bool |
|
1128 | + */ |
|
1129 | + public function can_checkin($DTT_OR_ID, $check_approved = true) |
|
1130 | + { |
|
1131 | + $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID); |
|
1132 | + |
|
1133 | + //first check registration status |
|
1134 | + if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) { |
|
1135 | + return false; |
|
1136 | + } |
|
1137 | + //is there a datetime ticket that matches this dtt_ID? |
|
1138 | + if (! (EEM_Datetime_Ticket::instance()->exists(array( |
|
1139 | + array( |
|
1140 | + 'TKT_ID' => $this->get('TKT_ID'), |
|
1141 | + 'DTT_ID' => $DTT_ID, |
|
1142 | + ), |
|
1143 | + ))) |
|
1144 | + ) { |
|
1145 | + return false; |
|
1146 | + } |
|
1147 | + |
|
1148 | + //final check is against TKT_uses |
|
1149 | + return $this->verify_can_checkin_against_TKT_uses($DTT_ID); |
|
1150 | + } |
|
1151 | + |
|
1152 | + |
|
1153 | + /** |
|
1154 | + * This method verifies whether the user can checkin for the given datetime considering the max uses value set on |
|
1155 | + * the ticket. To do this, a query is done to get the count of the datetime records already checked into. If the |
|
1156 | + * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses, |
|
1157 | + * then return false. Otherwise return true. |
|
1158 | + * |
|
1159 | + * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against |
|
1160 | + * @return bool true means can checkin. false means cannot checkin. |
|
1161 | + */ |
|
1162 | + public function verify_can_checkin_against_TKT_uses($DTT_OR_ID) |
|
1163 | + { |
|
1164 | + $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID); |
|
1165 | + |
|
1166 | + if (! $DTT_ID) { |
|
1167 | + return false; |
|
1168 | + } |
|
1169 | + |
|
1170 | + $max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF; |
|
1171 | + |
|
1172 | + // if max uses is not set or equals infinity then return true cause its not a factor for whether user can check-in |
|
1173 | + // or not. |
|
1174 | + if (! $max_uses || $max_uses === EE_INF) { |
|
1175 | + return true; |
|
1176 | + } |
|
1177 | + |
|
1178 | + //does this datetime have a checkin record? If so, then the dtt count has already been verified so we can just |
|
1179 | + //go ahead and toggle. |
|
1180 | + if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) { |
|
1181 | + return true; |
|
1182 | + } |
|
1183 | + |
|
1184 | + //made it here so the last check is whether the number of checkins per unique datetime on this registration |
|
1185 | + //disallows further check-ins. |
|
1186 | + $count_unique_dtt_checkins = EEM_Checkin::instance()->count(array( |
|
1187 | + array( |
|
1188 | + 'REG_ID' => $this->ID(), |
|
1189 | + 'CHK_in' => true, |
|
1190 | + ), |
|
1191 | + ), 'DTT_ID', true); |
|
1192 | + // checkins have already reached their max number of uses |
|
1193 | + // so registrant can NOT checkin |
|
1194 | + if ($count_unique_dtt_checkins >= $max_uses) { |
|
1195 | + EE_Error::add_error(__('Check-in denied because number of datetime uses for the ticket has been reached or exceeded.', |
|
1196 | + 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
1197 | + return false; |
|
1198 | + } |
|
1199 | + return true; |
|
1200 | + } |
|
1201 | + |
|
1202 | + |
|
1203 | + /** |
|
1204 | + * toggle Check-in status for this registration |
|
1205 | + * Check-ins are toggled in the following order: |
|
1206 | + * never checked in -> checked in |
|
1207 | + * checked in -> checked out |
|
1208 | + * checked out -> checked in |
|
1209 | + * |
|
1210 | + * @param int $DTT_ID include specific datetime to toggle Check-in for. |
|
1211 | + * If not included or null, then it is assumed latest datetime is being toggled. |
|
1212 | + * @param bool $verify If true then can_checkin() is used to verify whether the person |
|
1213 | + * can be checked in or not. Otherwise this forces change in checkin status. |
|
1214 | + * @return bool|int the chk_in status toggled to OR false if nothing got changed. |
|
1215 | + * @throws EE_Error |
|
1216 | + */ |
|
1217 | + public function toggle_checkin_status($DTT_ID = null, $verify = false) |
|
1218 | + { |
|
1219 | + if (empty($DTT_ID)) { |
|
1220 | + $datetime = $this->get_latest_related_datetime(); |
|
1221 | + $DTT_ID = $datetime instanceof EE_Datetime ? $datetime->ID() : 0; |
|
1222 | + // verify the registration can checkin for the given DTT_ID |
|
1223 | + } elseif (! $this->can_checkin($DTT_ID, $verify)) { |
|
1224 | + EE_Error::add_error( |
|
1225 | + sprintf( |
|
1226 | + __('The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access', |
|
1227 | + 'event_espresso'), |
|
1228 | + $this->ID(), |
|
1229 | + $DTT_ID |
|
1230 | + ), |
|
1231 | + __FILE__, __FUNCTION__, __LINE__ |
|
1232 | + ); |
|
1233 | + return false; |
|
1234 | + } |
|
1235 | + $status_paths = array( |
|
1236 | + EE_Registration::checkin_status_never => EE_Registration::checkin_status_in, |
|
1237 | + EE_Registration::checkin_status_in => EE_Registration::checkin_status_out, |
|
1238 | + EE_Registration::checkin_status_out => EE_Registration::checkin_status_in, |
|
1239 | + ); |
|
1240 | + //start by getting the current status so we know what status we'll be changing to. |
|
1241 | + $cur_status = $this->check_in_status_for_datetime($DTT_ID, null); |
|
1242 | + $status_to = $status_paths[$cur_status]; |
|
1243 | + // database only records true for checked IN or false for checked OUT |
|
1244 | + // no record ( null ) means checked in NEVER, but we obviously don't save that |
|
1245 | + $new_status = $status_to === EE_Registration::checkin_status_in ? true : false; |
|
1246 | + // add relation - note Check-ins are always creating new rows |
|
1247 | + // because we are keeping track of Check-ins over time. |
|
1248 | + // Eventually we'll probably want to show a list table |
|
1249 | + // for the individual Check-ins so that they can be managed. |
|
1250 | + $checkin = EE_Checkin::new_instance(array( |
|
1251 | + 'REG_ID' => $this->ID(), |
|
1252 | + 'DTT_ID' => $DTT_ID, |
|
1253 | + 'CHK_in' => $new_status, |
|
1254 | + )); |
|
1255 | + // if the record could not be saved then return false |
|
1256 | + if ($checkin->save() === 0) { |
|
1257 | + if (WP_DEBUG) { |
|
1258 | + global $wpdb; |
|
1259 | + $error = sprintf( |
|
1260 | + __('Registration check in update failed because of the following database error: %1$s%2$s', |
|
1261 | + 'event_espresso'), |
|
1262 | + '<br />', |
|
1263 | + $wpdb->last_error |
|
1264 | + ); |
|
1265 | + } else { |
|
1266 | + $error = __('Registration check in update failed because of an unknown database error', |
|
1267 | + 'event_espresso'); |
|
1268 | + } |
|
1269 | + EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__); |
|
1270 | + return false; |
|
1271 | + } |
|
1272 | + return $status_to; |
|
1273 | + } |
|
1274 | + |
|
1275 | + |
|
1276 | + /** |
|
1277 | + * Returns the latest datetime related to this registration (via the ticket attached to the registration). |
|
1278 | + * "Latest" is defined by the `DTT_EVT_start` column. |
|
1279 | + * |
|
1280 | + * @return EE_Datetime|null |
|
1281 | + * @throws \EE_Error |
|
1282 | + */ |
|
1283 | + public function get_latest_related_datetime() |
|
1284 | + { |
|
1285 | + return EEM_Datetime::instance()->get_one( |
|
1286 | + array( |
|
1287 | + array( |
|
1288 | + 'Ticket.Registration.REG_ID' => $this->ID(), |
|
1289 | + ), |
|
1290 | + 'order_by' => array('DTT_EVT_start' => 'DESC'), |
|
1291 | + ) |
|
1292 | + ); |
|
1293 | + } |
|
1294 | + |
|
1295 | + |
|
1296 | + /** |
|
1297 | + * Returns the earliest datetime related to this registration (via the ticket attached to the registration). |
|
1298 | + * "Earliest" is defined by the `DTT_EVT_start` column. |
|
1299 | + * |
|
1300 | + * @throws \EE_Error |
|
1301 | + */ |
|
1302 | + public function get_earliest_related_datetime() |
|
1303 | + { |
|
1304 | + return EEM_Datetime::instance()->get_one( |
|
1305 | + array( |
|
1306 | + array( |
|
1307 | + 'Ticket.Registration.REG_ID' => $this->ID(), |
|
1308 | + ), |
|
1309 | + 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
1310 | + ) |
|
1311 | + ); |
|
1312 | + } |
|
1313 | + |
|
1314 | + |
|
1315 | + /** |
|
1316 | + * This method simply returns the check-in status for this registration and the given datetime. |
|
1317 | + * If neither the datetime nor the checkin values are provided as arguments, |
|
1318 | + * then this will return the LATEST check-in status for the registration across all datetimes it belongs to. |
|
1319 | + * |
|
1320 | + * @param int $DTT_ID The ID of the datetime we're checking against |
|
1321 | + * (if empty we'll get the primary datetime for |
|
1322 | + * this registration (via event) and use it's ID); |
|
1323 | + * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id. |
|
1324 | + * @return int Integer representing Check-in status. |
|
1325 | + * @throws \EE_Error |
|
1326 | + */ |
|
1327 | + public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null) |
|
1328 | + { |
|
1329 | + $checkin_query_params = array( |
|
1330 | + 'order_by' => array('CHK_timestamp' => 'DESC'), |
|
1331 | + ); |
|
1332 | + |
|
1333 | + if ($DTT_ID > 0) { |
|
1334 | + $checkin_query_params[0] = array('DTT_ID' => $DTT_ID); |
|
1335 | + } |
|
1336 | + |
|
1337 | + //get checkin object (if exists) |
|
1338 | + $checkin = $checkin instanceof EE_Checkin |
|
1339 | + ? $checkin |
|
1340 | + : $this->get_first_related('Checkin', $checkin_query_params); |
|
1341 | + if ($checkin instanceof EE_Checkin) { |
|
1342 | + if ($checkin->get('CHK_in')) { |
|
1343 | + return EE_Registration::checkin_status_in; //checked in |
|
1344 | + } |
|
1345 | + return EE_Registration::checkin_status_out; //had checked in but is now checked out. |
|
1346 | + } |
|
1347 | + return EE_Registration::checkin_status_never; //never been checked in |
|
1348 | + } |
|
1349 | + |
|
1350 | + |
|
1351 | + /** |
|
1352 | + * This method returns a localized message for the toggled Check-in message. |
|
1353 | + * |
|
1354 | + * @param int $DTT_ID include specific datetime to get the correct Check-in message. If not included or null, |
|
1355 | + * then it is assumed Check-in for primary datetime was toggled. |
|
1356 | + * @param bool $error This just flags that you want an error message returned. This is put in so that the error |
|
1357 | + * message can be customized with the attendee name. |
|
1358 | + * @return string internationalized message |
|
1359 | + */ |
|
1360 | + public function get_checkin_msg($DTT_ID, $error = false) |
|
1361 | + { |
|
1362 | + //let's get the attendee first so we can include the name of the attendee |
|
1363 | + $attendee = $this->get_first_related('Attendee'); |
|
1364 | + if ($attendee instanceof EE_Attendee) { |
|
1365 | + if ($error) { |
|
1366 | + return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name()); |
|
1367 | + } |
|
1368 | + $cur_status = $this->check_in_status_for_datetime($DTT_ID); |
|
1369 | + //what is the status message going to be? |
|
1370 | + switch ($cur_status) { |
|
1371 | + case EE_Registration::checkin_status_never : |
|
1372 | + return sprintf(__("%s has been removed from Check-in records", "event_espresso"), |
|
1373 | + $attendee->full_name()); |
|
1374 | + break; |
|
1375 | + case EE_Registration::checkin_status_in : |
|
1376 | + return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name()); |
|
1377 | + break; |
|
1378 | + case EE_Registration::checkin_status_out : |
|
1379 | + return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name()); |
|
1380 | + break; |
|
1381 | + } |
|
1382 | + } |
|
1383 | + return __("The check-in status could not be determined.", "event_espresso"); |
|
1384 | + } |
|
1385 | + |
|
1386 | + |
|
1387 | + /** |
|
1388 | + * Returns the related EE_Transaction to this registration |
|
1389 | + * |
|
1390 | + * @return EE_Transaction |
|
1391 | + */ |
|
1392 | + public function transaction() |
|
1393 | + { |
|
1394 | + $transaction = $this->get_first_related('Transaction'); |
|
1395 | + if (! $transaction instanceof \EE_Transaction) { |
|
1396 | + throw new EntityNotFoundException('Transaction ID', $this->transaction_ID()); |
|
1397 | + } |
|
1398 | + return $transaction; |
|
1399 | + } |
|
1400 | + |
|
1401 | + |
|
1402 | + /** |
|
1403 | + * get Registration Code |
|
1404 | + */ |
|
1405 | + public function reg_code() |
|
1406 | + { |
|
1407 | + return $this->get('REG_code'); |
|
1408 | + } |
|
1409 | + |
|
1410 | + |
|
1411 | + /** |
|
1412 | + * get Transaction ID |
|
1413 | + */ |
|
1414 | + public function transaction_ID() |
|
1415 | + { |
|
1416 | + return $this->get('TXN_ID'); |
|
1417 | + } |
|
1418 | + |
|
1419 | + |
|
1420 | + /** |
|
1421 | + * @return int |
|
1422 | + */ |
|
1423 | + public function ticket_ID() |
|
1424 | + { |
|
1425 | + return $this->get('TKT_ID'); |
|
1426 | + } |
|
1427 | + |
|
1428 | + |
|
1429 | + /** |
|
1430 | + * Set Registration Code |
|
1431 | + * |
|
1432 | + * @access public |
|
1433 | + * @param string $REG_code Registration Code |
|
1434 | + * @param boolean $use_default |
|
1435 | + */ |
|
1436 | + public function set_reg_code($REG_code, $use_default = false) |
|
1437 | + { |
|
1438 | + if (empty($REG_code)) { |
|
1439 | + EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
1440 | + return; |
|
1441 | + } |
|
1442 | + if (! $this->reg_code()) { |
|
1443 | + parent::set('REG_code', $REG_code, $use_default); |
|
1444 | + } else { |
|
1445 | + EE_Error::doing_it_wrong( |
|
1446 | + __CLASS__ . '::' . __FUNCTION__, |
|
1447 | + __('Can not change a registration REG_code once it has been set.', 'event_espresso'), |
|
1448 | + '4.6.0' |
|
1449 | + ); |
|
1450 | + } |
|
1451 | + } |
|
1452 | + |
|
1453 | + |
|
1454 | + /** |
|
1455 | + * Returns all other registrations in the same group as this registrant who have the same ticket option. |
|
1456 | + * Note, if you want to just get all registrations in the same transaction (group), use: |
|
1457 | + * $registration->transaction()->registrations(); |
|
1458 | + * |
|
1459 | + * @since 4.5.0 |
|
1460 | + * @return EE_Registration[] or empty array if this isn't a group registration. |
|
1461 | + */ |
|
1462 | + public function get_all_other_registrations_in_group() |
|
1463 | + { |
|
1464 | + if ($this->group_size() < 2) { |
|
1465 | + return array(); |
|
1466 | + } |
|
1467 | + |
|
1468 | + $query[0] = array( |
|
1469 | + 'TXN_ID' => $this->transaction_ID(), |
|
1470 | + 'REG_ID' => array('!=', $this->ID()), |
|
1471 | + 'TKT_ID' => $this->ticket_ID(), |
|
1472 | + ); |
|
1473 | + |
|
1474 | + $registrations = $this->get_model()->get_all($query); |
|
1475 | + return $registrations; |
|
1476 | + } |
|
1477 | + |
|
1478 | + /** |
|
1479 | + * Return the link to the admin details for the object. |
|
1480 | + * |
|
1481 | + * @return string |
|
1482 | + */ |
|
1483 | + public function get_admin_details_link() |
|
1484 | + { |
|
1485 | + EE_Registry::instance()->load_helper('URL'); |
|
1486 | + return EEH_URL::add_query_args_and_nonce( |
|
1487 | + array( |
|
1488 | + 'page' => 'espresso_registrations', |
|
1489 | + 'action' => 'view_registration', |
|
1490 | + '_REG_ID' => $this->ID(), |
|
1491 | + ), |
|
1492 | + admin_url('admin.php') |
|
1493 | + ); |
|
1494 | + } |
|
1495 | + |
|
1496 | + /** |
|
1497 | + * Returns the link to the editor for the object. Sometimes this is the same as the details. |
|
1498 | + * |
|
1499 | + * @return string |
|
1500 | + */ |
|
1501 | + public function get_admin_edit_link() |
|
1502 | + { |
|
1503 | + return $this->get_admin_details_link(); |
|
1504 | + } |
|
1505 | + |
|
1506 | + /** |
|
1507 | + * Returns the link to a settings page for the object. |
|
1508 | + * |
|
1509 | + * @return string |
|
1510 | + */ |
|
1511 | + public function get_admin_settings_link() |
|
1512 | + { |
|
1513 | + return $this->get_admin_details_link(); |
|
1514 | + } |
|
1515 | + |
|
1516 | + /** |
|
1517 | + * Returns the link to the "overview" for the object (typically the "list table" view). |
|
1518 | + * |
|
1519 | + * @return string |
|
1520 | + */ |
|
1521 | + public function get_admin_overview_link() |
|
1522 | + { |
|
1523 | + EE_Registry::instance()->load_helper('URL'); |
|
1524 | + return EEH_URL::add_query_args_and_nonce( |
|
1525 | + array( |
|
1526 | + 'page' => 'espresso_registrations', |
|
1527 | + ), |
|
1528 | + admin_url('admin.php') |
|
1529 | + ); |
|
1530 | + } |
|
1531 | + |
|
1532 | + |
|
1533 | + /** |
|
1534 | + * @param array $query_params |
|
1535 | + * @return \EE_Registration[] |
|
1536 | + * @throws \EE_Error |
|
1537 | + */ |
|
1538 | + public function payments($query_params = array()) |
|
1539 | + { |
|
1540 | + return $this->get_many_related('Payment', $query_params); |
|
1541 | + } |
|
1542 | + |
|
1543 | + |
|
1544 | + /** |
|
1545 | + * @param array $query_params |
|
1546 | + * @return \EE_Registration_Payment[] |
|
1547 | + * @throws \EE_Error |
|
1548 | + */ |
|
1549 | + public function registration_payments($query_params = array()) |
|
1550 | + { |
|
1551 | + return $this->get_many_related('Registration_Payment', $query_params); |
|
1552 | + } |
|
1553 | + |
|
1554 | + |
|
1555 | + /** |
|
1556 | + * This grabs the payment method corresponding to the last payment made for the amount owing on the registration. |
|
1557 | + * Note: if there are no payments on the registration there will be no payment method returned. |
|
1558 | + * |
|
1559 | + * @return EE_Payment_Method|null |
|
1560 | + */ |
|
1561 | + public function payment_method() |
|
1562 | + { |
|
1563 | + return EEM_Payment_Method::instance()->get_last_used_for_registration($this); |
|
1564 | + } |
|
1565 | + |
|
1566 | + |
|
1567 | + /** |
|
1568 | + * @return \EE_Line_Item |
|
1569 | + * @throws EntityNotFoundException |
|
1570 | + * @throws \EE_Error |
|
1571 | + */ |
|
1572 | + public function ticket_line_item() |
|
1573 | + { |
|
1574 | + $ticket = $this->ticket(); |
|
1575 | + $transaction = $this->transaction(); |
|
1576 | + $line_item = null; |
|
1577 | + $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs( |
|
1578 | + $transaction->total_line_item(), |
|
1579 | + 'Ticket', |
|
1580 | + array($ticket->ID()) |
|
1581 | + ); |
|
1582 | + foreach ($ticket_line_items as $ticket_line_item) { |
|
1583 | + if ( |
|
1584 | + $ticket_line_item instanceof \EE_Line_Item |
|
1585 | + && $ticket_line_item->OBJ_type() === 'Ticket' |
|
1586 | + && $ticket_line_item->OBJ_ID() === $ticket->ID() |
|
1587 | + ) { |
|
1588 | + $line_item = $ticket_line_item; |
|
1589 | + break; |
|
1590 | + } |
|
1591 | + } |
|
1592 | + if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) { |
|
1593 | + throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID()); |
|
1594 | + } |
|
1595 | + return $line_item; |
|
1596 | + } |
|
1597 | + |
|
1598 | + |
|
1599 | + /** |
|
1600 | + * Soft Deletes this model object. |
|
1601 | + * |
|
1602 | + * @return boolean | int |
|
1603 | + * @throws \RuntimeException |
|
1604 | + * @throws \EE_Error |
|
1605 | + */ |
|
1606 | + public function delete() |
|
1607 | + { |
|
1608 | + if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) { |
|
1609 | + $this->set_status(EEM_Registration::status_id_cancelled); |
|
1610 | + } |
|
1611 | + return parent::delete(); |
|
1612 | + } |
|
1613 | + |
|
1614 | + |
|
1615 | + /** |
|
1616 | + * Restores whatever the previous status was on a registration before it was trashed (if possible) |
|
1617 | + * |
|
1618 | + * @throws \EE_Error |
|
1619 | + * @throws \RuntimeException |
|
1620 | + */ |
|
1621 | + public function restore() |
|
1622 | + { |
|
1623 | + $previous_status = $this->get_extra_meta( |
|
1624 | + EE_Registration::PRE_TRASH_REG_STATUS_KEY, |
|
1625 | + true, |
|
1626 | + EEM_Registration::status_id_cancelled |
|
1627 | + ); |
|
1628 | + if ($previous_status) { |
|
1629 | + $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY); |
|
1630 | + $this->set_status($previous_status); |
|
1631 | + } |
|
1632 | + return parent::restore(); |
|
1633 | + } |
|
1634 | + |
|
1635 | + |
|
1636 | + |
|
1637 | + /*************************** DEPRECATED ***************************/ |
|
1638 | + |
|
1639 | + |
|
1640 | + /** |
|
1641 | + * @deprecated |
|
1642 | + * @since 4.7.0 |
|
1643 | + * @access public |
|
1644 | + */ |
|
1645 | + public function price_paid() |
|
1646 | + { |
|
1647 | + EE_Error::doing_it_wrong('EE_Registration::price_paid()', |
|
1648 | + __('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'), |
|
1649 | + '4.7.0'); |
|
1650 | + return $this->final_price(); |
|
1651 | + } |
|
1652 | + |
|
1653 | + |
|
1654 | + /** |
|
1655 | + * @deprecated |
|
1656 | + * @since 4.7.0 |
|
1657 | + * @access public |
|
1658 | + * @param float $REG_final_price |
|
1659 | + */ |
|
1660 | + public function set_price_paid($REG_final_price = 0.00) |
|
1661 | + { |
|
1662 | + EE_Error::doing_it_wrong('EE_Registration::set_price_paid()', |
|
1663 | + __('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'), |
|
1664 | + '4.7.0'); |
|
1665 | + $this->set_final_price($REG_final_price); |
|
1666 | + } |
|
1667 | + |
|
1668 | + |
|
1669 | + /** |
|
1670 | + * @deprecated |
|
1671 | + * @since 4.7.0 |
|
1672 | + * @return string |
|
1673 | + */ |
|
1674 | + public function pretty_price_paid() |
|
1675 | + { |
|
1676 | + EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()', |
|
1677 | + __('This method is deprecated, please use EE_Registration::pretty_final_price() instead.', |
|
1678 | + 'event_espresso'), '4.7.0'); |
|
1679 | + return $this->pretty_final_price(); |
|
1680 | + } |
|
1681 | + |
|
1682 | + |
|
1683 | + /** |
|
1684 | + * Gets the primary datetime related to this registration via the related Event to this registration |
|
1685 | + * |
|
1686 | + * @deprecated 4.9.17 |
|
1687 | + * @return EE_Datetime |
|
1688 | + */ |
|
1689 | + public function get_related_primary_datetime() |
|
1690 | + { |
|
1691 | + EE_Error::doing_it_wrong( |
|
1692 | + __METHOD__, |
|
1693 | + esc_html__( |
|
1694 | + 'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()', |
|
1695 | + 'event_espresso' |
|
1696 | + ), |
|
1697 | + '4.9.17', |
|
1698 | + '5.0.0' |
|
1699 | + ); |
|
1700 | + return $this->event()->primary_datetime(); |
|
1701 | + } |
|
1702 | 1702 | |
1703 | 1703 | |
1704 | 1704 | } |