@@ -4,7 +4,7 @@ discard block |
||
4 | 4 | class EE_Attendee_Contact_List_Table extends EE_Admin_List_Table { |
5 | 5 | |
6 | 6 | |
7 | - public function __construct( $admin_page ) { |
|
7 | + public function __construct($admin_page) { |
|
8 | 8 | parent::__construct($admin_page); |
9 | 9 | } |
10 | 10 | |
@@ -12,8 +12,8 @@ discard block |
||
12 | 12 | |
13 | 13 | |
14 | 14 | protected function _setup_data() { |
15 | - $this->_data = $this->_view != 'trash' ? $this->_admin_page->get_attendees( $this->_per_page ) : $this->_admin_page->get_attendees( $this->_per_page, FALSE, TRUE ); |
|
16 | - $this->_all_data_count = $this->_view != 'trash' ? $this->_admin_page->get_attendees( $this->_per_page, TRUE ) : $this->_admin_page->get_attendees( $this->_per_page,TRUE, TRUE ); |
|
15 | + $this->_data = $this->_view != 'trash' ? $this->_admin_page->get_attendees($this->_per_page) : $this->_admin_page->get_attendees($this->_per_page, FALSE, TRUE); |
|
16 | + $this->_all_data_count = $this->_view != 'trash' ? $this->_admin_page->get_attendees($this->_per_page, TRUE) : $this->_admin_page->get_attendees($this->_per_page, TRUE, TRUE); |
|
17 | 17 | } |
18 | 18 | |
19 | 19 | |
@@ -41,13 +41,13 @@ discard block |
||
41 | 41 | ); |
42 | 42 | |
43 | 43 | $this->_sortable_columns = array( |
44 | - 'ATT_ID' => array( 'ATT_ID' => FALSE ), |
|
45 | - 'ATT_lname' => array( 'ATT_lname' => TRUE ), //true means its already sorted |
|
46 | - 'ATT_fname' => array( 'ATT_fname' => FALSE ), |
|
47 | - 'ATT_email' => array( 'ATT_email' => FALSE ), |
|
48 | - 'ATT_city' => array( 'ATT_city' => FALSE ), |
|
49 | - 'STA_ID' => array( 'STA_ID' => FALSE ), |
|
50 | - 'CNT_ISO' => array( 'CNT_ISO' => FALSE ) |
|
44 | + 'ATT_ID' => array('ATT_ID' => FALSE), |
|
45 | + 'ATT_lname' => array('ATT_lname' => TRUE), //true means its already sorted |
|
46 | + 'ATT_fname' => array('ATT_fname' => FALSE), |
|
47 | + 'ATT_email' => array('ATT_email' => FALSE), |
|
48 | + 'ATT_city' => array('ATT_city' => FALSE), |
|
49 | + 'STA_ID' => array('STA_ID' => FALSE), |
|
50 | + 'CNT_ISO' => array('CNT_ISO' => FALSE) |
|
51 | 51 | ); |
52 | 52 | |
53 | 53 | $this->_hidden_columns = array(); |
@@ -64,9 +64,9 @@ discard block |
||
64 | 64 | |
65 | 65 | |
66 | 66 | protected function _add_view_counts() { |
67 | - $this->_views['in_use']['count'] = $this->_admin_page->get_attendees( $this->_per_page, TRUE ); |
|
68 | - if ( EE_Registry::instance()->CAP->current_user_can( 'ee_delete_contacts', 'espresso_registrations_delete_registration' ) ) { |
|
69 | - $this->_views['trash']['count'] = $this->_admin_page->get_attendees( $this->_per_page,TRUE, TRUE ); |
|
67 | + $this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, TRUE); |
|
68 | + if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts', 'espresso_registrations_delete_registration')) { |
|
69 | + $this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, TRUE, TRUE); |
|
70 | 70 | } |
71 | 71 | } |
72 | 72 | |
@@ -89,7 +89,7 @@ discard block |
||
89 | 89 | |
90 | 90 | |
91 | 91 | function column_cb($item) { |
92 | - return sprintf( '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', /* $1%s */ $item->ID() ); |
|
92 | + return sprintf('<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', /* $1%s */ $item->ID()); |
|
93 | 93 | } |
94 | 94 | |
95 | 95 | |
@@ -97,9 +97,9 @@ discard block |
||
97 | 97 | |
98 | 98 | |
99 | 99 | function column_ATT_ID($item) { |
100 | - $content = $item->ID(); |
|
100 | + $content = $item->ID(); |
|
101 | 101 | $attendee_name = $item instanceof EE_Attendee ? $item->full_name() : ''; |
102 | - $content .= ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>'; |
|
102 | + $content .= ' <span class="show-on-mobile-view-only">'.$attendee_name.'</span>'; |
|
103 | 103 | return $content; |
104 | 104 | } |
105 | 105 | |
@@ -110,8 +110,8 @@ discard block |
||
110 | 110 | function column_ATT_lname($item) { |
111 | 111 | |
112 | 112 | // edit attendee link |
113 | - $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action'=>'edit_attendee', 'post'=>$item->ID() ), REG_ADMIN_URL ); |
|
114 | - $name_link = EE_Registry::instance()->CAP->current_user_can( 'ee_edit_contacts', 'espresso_registrations_edit_attendee' ) ? '<a href="'.$edit_lnk_url.'" title="' . esc_attr__( 'Edit Contact', 'event_espresso' ) . '">' . $item->lname() . '</a>' : $item->lname(); |
|
113 | + $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'edit_attendee', 'post'=>$item->ID()), REG_ADMIN_URL); |
|
114 | + $name_link = EE_Registry::instance()->CAP->current_user_can('ee_edit_contacts', 'espresso_registrations_edit_attendee') ? '<a href="'.$edit_lnk_url.'" title="'.esc_attr__('Edit Contact', 'event_espresso').'">'.$item->lname().'</a>' : $item->lname(); |
|
115 | 115 | return $name_link; |
116 | 116 | |
117 | 117 | } |
@@ -124,30 +124,30 @@ discard block |
||
124 | 124 | //Build row actions |
125 | 125 | $actions = array(); |
126 | 126 | // edit attendee link |
127 | - if ( EE_Registry::instance()->CAP->current_user_can( 'ee_edit_contacts', 'espresso_registrations_edit_attendee' ) ) { |
|
128 | - $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action'=>'edit_attendee', 'post'=>$item->ID() ), REG_ADMIN_URL ); |
|
129 | - $actions['edit'] = '<a href="'.$edit_lnk_url.'" title="' . esc_attr__( 'Edit Contact', 'event_espresso' ) . '">' . __( 'Edit', 'event_espresso' ) . '</a>'; |
|
127 | + if (EE_Registry::instance()->CAP->current_user_can('ee_edit_contacts', 'espresso_registrations_edit_attendee')) { |
|
128 | + $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'edit_attendee', 'post'=>$item->ID()), REG_ADMIN_URL); |
|
129 | + $actions['edit'] = '<a href="'.$edit_lnk_url.'" title="'.esc_attr__('Edit Contact', 'event_espresso').'">'.__('Edit', 'event_espresso').'</a>'; |
|
130 | 130 | } |
131 | 131 | |
132 | - if ( $this->_view == 'in_use' ) { |
|
132 | + if ($this->_view == 'in_use') { |
|
133 | 133 | // trash attendee link |
134 | - if ( EE_Registry::instance()->CAP->current_user_can( 'ee_delete_contacts', 'espresso_registrations_trash_attendees' ) ) { |
|
135 | - $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action'=>'trash_attendee', 'ATT_ID'=>$item->ID() ), REG_ADMIN_URL ); |
|
136 | - $actions['trash'] = '<a href="'.$trash_lnk_url.'" title="' . esc_attr__( 'Move Contact to Trash', 'event_espresso' ) . '">' . __( 'Trash', 'event_espresso' ) . '</a>'; |
|
134 | + if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts', 'espresso_registrations_trash_attendees')) { |
|
135 | + $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'trash_attendee', 'ATT_ID'=>$item->ID()), REG_ADMIN_URL); |
|
136 | + $actions['trash'] = '<a href="'.$trash_lnk_url.'" title="'.esc_attr__('Move Contact to Trash', 'event_espresso').'">'.__('Trash', 'event_espresso').'</a>'; |
|
137 | 137 | } |
138 | 138 | } else { |
139 | - if ( EE_Registry::instance()->CAP->current_user_can( 'ee_delete_contacts', 'espresso_registrations_restore_attendees' ) ) { |
|
139 | + if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts', 'espresso_registrations_restore_attendees')) { |
|
140 | 140 | // restore attendee link |
141 | - $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action'=>'restore_attendees', 'ATT_ID'=>$item->ID() ), REG_ADMIN_URL ); |
|
142 | - $actions['restore'] = '<a href="'.$restore_lnk_url.'" title="' . esc_attr__( 'Restore Contact', 'event_espresso' ) . '">' . __( 'Restore', 'event_espresso' ) . '</a>'; |
|
141 | + $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'restore_attendees', 'ATT_ID'=>$item->ID()), REG_ADMIN_URL); |
|
142 | + $actions['restore'] = '<a href="'.$restore_lnk_url.'" title="'.esc_attr__('Restore Contact', 'event_espresso').'">'.__('Restore', 'event_espresso').'</a>'; |
|
143 | 143 | } |
144 | 144 | } |
145 | 145 | |
146 | - $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action'=>'edit_attendee', 'post'=>$item->ID() ), REG_ADMIN_URL ); |
|
147 | - $name_link = EE_Registry::instance()->CAP->current_user_can( 'ee_edit_contacts', 'espresso_registrations_edit_attendee' ) ? '<a href="'.$edit_lnk_url.'" title="' . esc_attr__( 'Edit Contact', 'event_espresso' ) . '">' . $item->fname() . '</a>' : $item->fname(); |
|
146 | + $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'edit_attendee', 'post'=>$item->ID()), REG_ADMIN_URL); |
|
147 | + $name_link = EE_Registry::instance()->CAP->current_user_can('ee_edit_contacts', 'espresso_registrations_edit_attendee') ? '<a href="'.$edit_lnk_url.'" title="'.esc_attr__('Edit Contact', 'event_espresso').'">'.$item->fname().'</a>' : $item->fname(); |
|
148 | 148 | |
149 | 149 | //Return the name contents |
150 | - return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions) ); |
|
150 | + return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions)); |
|
151 | 151 | } |
152 | 152 | |
153 | 153 | |
@@ -155,7 +155,7 @@ discard block |
||
155 | 155 | |
156 | 156 | |
157 | 157 | function column_ATT_email($item) { |
158 | - return '<a href="mailto:' . $item->email() . '">' . $item->email() . '</a>'; |
|
158 | + return '<a href="mailto:'.$item->email().'">'.$item->email().'</a>'; |
|
159 | 159 | } |
160 | 160 | |
161 | 161 | |
@@ -175,8 +175,8 @@ discard block |
||
175 | 175 | |
176 | 176 | function column_STA_ID($item) { |
177 | 177 | $states = EEM_State::instance()->get_all_states(); |
178 | - $state = isset( $states[ $item->state_ID() ] ) ? $states[ $item->state_ID() ]->get( 'STA_name' ) : $item->state_ID(); |
|
179 | - return ! is_numeric( $state ) ? $state : ''; |
|
178 | + $state = isset($states[$item->state_ID()]) ? $states[$item->state_ID()]->get('STA_name') : $item->state_ID(); |
|
179 | + return ! is_numeric($state) ? $state : ''; |
|
180 | 180 | } |
181 | 181 | |
182 | 182 | |
@@ -184,8 +184,8 @@ discard block |
||
184 | 184 | function column_CNT_ISO($item) { |
185 | 185 | $countries = EEM_Country::instance()->get_all_countries(); |
186 | 186 | //EEH_Debug_Tools::printr( $countries, '$countries <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' ); |
187 | - $country = isset( $countries[ $item->country_ID() ] ) ? $countries[ $item->country_ID() ]->get( 'CNT_name' ) : $item->country_ID(); |
|
188 | - return ! is_numeric( $country ) ? $country : ''; |
|
187 | + $country = isset($countries[$item->country_ID()]) ? $countries[$item->country_ID()]->get('CNT_name') : $item->country_ID(); |
|
188 | + return ! is_numeric($country) ? $country : ''; |
|
189 | 189 | } |
190 | 190 | |
191 | 191 |
@@ -39,14 +39,14 @@ |
||
39 | 39 | * @return void |
40 | 40 | */ |
41 | 41 | public static function set_hooks() { |
42 | - $post_type = get_post_type_object('espresso_venues'); |
|
43 | - $custom_post_types = EE_Register_CPTs::get_CPTs(); |
|
44 | - EE_Config::register_route( |
|
45 | - $custom_post_types['espresso_venues']['plural_slug'], |
|
46 | - 'Venues_Archive', |
|
47 | - 'run' |
|
48 | - ); |
|
49 | - } |
|
42 | + $post_type = get_post_type_object('espresso_venues'); |
|
43 | + $custom_post_types = EE_Register_CPTs::get_CPTs(); |
|
44 | + EE_Config::register_route( |
|
45 | + $custom_post_types['espresso_venues']['plural_slug'], |
|
46 | + 'Venues_Archive', |
|
47 | + 'run' |
|
48 | + ); |
|
49 | + } |
|
50 | 50 | |
51 | 51 | /** |
52 | 52 | * set_hooks_admin - for hooking into EE Admin Core, other modules, etc |
@@ -27,7 +27,7 @@ discard block |
||
27 | 27 | * @return EED_Venues_Archive |
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 | |
@@ -65,10 +65,10 @@ discard block |
||
65 | 65 | * @access public |
66 | 66 | * @param \WP $WP |
67 | 67 | */ |
68 | - public function run( $WP ) { |
|
68 | + public function run($WP) { |
|
69 | 69 | // check what template is loaded |
70 | - add_filter( 'template_include', array( $this, 'template_include' ), 999, 1 ); |
|
71 | - add_action('wp_enqueue_scripts', array( $this, 'wp_enqueue_scripts' ), 10 ); |
|
70 | + add_filter('template_include', array($this, 'template_include'), 999, 1); |
|
71 | + add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10); |
|
72 | 72 | } |
73 | 73 | |
74 | 74 | |
@@ -80,18 +80,18 @@ discard block |
||
80 | 80 | * @param string $template |
81 | 81 | * @return string |
82 | 82 | */ |
83 | - public function template_include( $template ) { |
|
83 | + public function template_include($template) { |
|
84 | 84 | // not a custom template? |
85 | - if ( EE_Registry::instance()->load_core( 'Front_Controller', array(), false, true )->get_selected_template() != 'archive-espresso_venues.php' ) { |
|
85 | + if (EE_Registry::instance()->load_core('Front_Controller', array(), false, true)->get_selected_template() != 'archive-espresso_venues.php') { |
|
86 | 86 | EEH_Template::load_espresso_theme_functions(); |
87 | 87 | // then add extra event data via hooks |
88 | - add_filter( 'the_title', array( $this, 'the_title' ), 100, 1 ); |
|
88 | + add_filter('the_title', array($this, 'the_title'), 100, 1); |
|
89 | 89 | // don't know if theme uses the_excerpt |
90 | - add_filter( 'the_excerpt', array( $this, 'venue_details' ), 100 ); |
|
90 | + add_filter('the_excerpt', array($this, 'venue_details'), 100); |
|
91 | 91 | // or the_content |
92 | - add_filter( 'the_content', array( $this, 'venue_details' ), 100 ); |
|
92 | + add_filter('the_content', array($this, 'venue_details'), 100); |
|
93 | 93 | // don't display entry meta because the existing theme will take care of that |
94 | - add_filter( 'FHEE__content_espresso_venues_details_template__display_entry_meta', '__return_false' ); |
|
94 | + add_filter('FHEE__content_espresso_venues_details_template__display_entry_meta', '__return_false'); |
|
95 | 95 | } |
96 | 96 | return $template; |
97 | 97 | } |
@@ -105,7 +105,7 @@ discard block |
||
105 | 105 | * @param string $title |
106 | 106 | * @return string |
107 | 107 | */ |
108 | - public function the_title( $title = '' ) { |
|
108 | + public function the_title($title = '') { |
|
109 | 109 | return $title; |
110 | 110 | } |
111 | 111 | |
@@ -117,7 +117,7 @@ discard block |
||
117 | 117 | * @param string $content |
118 | 118 | * @return string |
119 | 119 | */ |
120 | - public function venue_details( $content ) { |
|
120 | + public function venue_details($content) { |
|
121 | 121 | global $post; |
122 | 122 | if ( |
123 | 123 | $post->post_type == 'espresso_venues' |
@@ -127,22 +127,22 @@ discard block |
||
127 | 127 | // it uses the_content() for displaying the $post->post_content |
128 | 128 | // so in order to load a template that uses the_content() from within a callback being used to filter the_content(), |
129 | 129 | // we need to first remove this callback from being applied to the_content() (otherwise it will recurse and blow up the interweb) |
130 | - remove_filter( 'the_excerpt', array( $this, 'venue_details' ), 100 ); |
|
131 | - remove_filter( 'the_content', array( $this, 'venue_details' ), 100 ); |
|
130 | + remove_filter('the_excerpt', array($this, 'venue_details'), 100); |
|
131 | + remove_filter('the_content', array($this, 'venue_details'), 100); |
|
132 | 132 | // add filters we want |
133 | - add_filter( 'the_content', array( $this, 'venue_location' ), 110 ); |
|
134 | - add_filter( 'the_excerpt', array( $this, 'venue_location' ), 110 ); |
|
133 | + add_filter('the_content', array($this, 'venue_location'), 110); |
|
134 | + add_filter('the_excerpt', array($this, 'venue_location'), 110); |
|
135 | 135 | // now load our template |
136 | - $template = EEH_Template::locate_template( 'content-espresso_venues-details.php' ); |
|
136 | + $template = EEH_Template::locate_template('content-espresso_venues-details.php'); |
|
137 | 137 | //now add our filter back in, plus some others |
138 | - add_filter( 'the_excerpt', array( $this, 'venue_details' ), 100 ); |
|
139 | - add_filter( 'the_content', array( $this, 'venue_details' ), 100 ); |
|
138 | + add_filter('the_excerpt', array($this, 'venue_details'), 100); |
|
139 | + add_filter('the_content', array($this, 'venue_details'), 100); |
|
140 | 140 | // remove other filters we added so they won't get applied to the next post |
141 | - remove_filter( 'the_content', array( $this, 'venue_location' ), 110 ); |
|
142 | - remove_filter( 'the_excerpt', array( $this, 'venue_location' ), 110 ); |
|
141 | + remove_filter('the_content', array($this, 'venue_location'), 110); |
|
142 | + remove_filter('the_excerpt', array($this, 'venue_location'), 110); |
|
143 | 143 | // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt) |
144 | 144 | } |
145 | - return ! empty( $template ) ? $template : $content; |
|
145 | + return ! empty($template) ? $template : $content; |
|
146 | 146 | } |
147 | 147 | |
148 | 148 | |
@@ -154,8 +154,8 @@ discard block |
||
154 | 154 | * @param string $content |
155 | 155 | * @return string |
156 | 156 | */ |
157 | - public function venue_location( $content ) { |
|
158 | - return $content . EEH_Template::locate_template( 'content-espresso_venues-location.php' ); |
|
157 | + public function venue_location($content) { |
|
158 | + return $content.EEH_Template::locate_template('content-espresso_venues-location.php'); |
|
159 | 159 | } |
160 | 160 | |
161 | 161 | |
@@ -169,14 +169,14 @@ discard block |
||
169 | 169 | */ |
170 | 170 | public function wp_enqueue_scripts() { |
171 | 171 | // get some style |
172 | - if ( apply_filters( 'FHEE_enable_default_espresso_css', TRUE ) && is_archive() ) { |
|
172 | + if (apply_filters('FHEE_enable_default_espresso_css', TRUE) && is_archive()) { |
|
173 | 173 | // first check theme folder |
174 | - if ( is_readable( get_stylesheet_directory() . $this->theme . DS . 'style.css' )) { |
|
175 | - wp_register_style( $this->theme, get_stylesheet_directory_uri() . $this->theme . DS . 'style.css', array( 'dashicons', 'espresso_default' ) ); |
|
176 | - } else if ( is_readable( EE_TEMPLATES . $this->theme . DS . 'style.css' )) { |
|
177 | - wp_register_style( $this->theme, EE_TEMPLATES_URL . $this->theme . DS . 'style.css', array( 'dashicons', 'espresso_default' ) ); |
|
174 | + if (is_readable(get_stylesheet_directory().$this->theme.DS.'style.css')) { |
|
175 | + wp_register_style($this->theme, get_stylesheet_directory_uri().$this->theme.DS.'style.css', array('dashicons', 'espresso_default')); |
|
176 | + } else if (is_readable(EE_TEMPLATES.$this->theme.DS.'style.css')) { |
|
177 | + wp_register_style($this->theme, EE_TEMPLATES_URL.$this->theme.DS.'style.css', array('dashicons', 'espresso_default')); |
|
178 | 178 | } |
179 | - wp_enqueue_style( $this->theme ); |
|
179 | + wp_enqueue_style($this->theme); |
|
180 | 180 | } |
181 | 181 | } |
182 | 182 |
@@ -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 | } |
@@ -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 | /** |
@@ -7,7 +7,7 @@ discard block |
||
7 | 7 | * @since 4.3.2 |
8 | 8 | */ |
9 | 9 | if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
10 | - exit('No direct script access allowed'); |
|
10 | + exit('No direct script access allowed'); |
|
11 | 11 | } |
12 | 12 | |
13 | 13 | /** |
@@ -22,735 +22,735 @@ discard block |
||
22 | 22 | { |
23 | 23 | |
24 | 24 | |
25 | - /** |
|
26 | - * constructor. |
|
27 | - */ |
|
28 | - public function __construct() |
|
29 | - { |
|
30 | - $this->_caf_hooks(); |
|
31 | - } |
|
32 | - |
|
33 | - |
|
34 | - /** |
|
35 | - * Contains all the hooks filters for setting up caffeinated messages functionality. |
|
36 | - * |
|
37 | - * @since 4.3.2 |
|
38 | - * |
|
39 | - * @return void |
|
40 | - */ |
|
41 | - private function _caf_hooks() |
|
42 | - { |
|
43 | - add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5); |
|
44 | - add_filter('FHEE__EE_Email_messenger__get_validator_config', array($this, 'email_messenger_validator_config'), |
|
45 | - 5, 2); |
|
46 | - add_filter('FHEE__EE_Email_messenger__get_template_fields', array($this, 'email_messenger_template_fields'), 5, |
|
47 | - 2); |
|
48 | - add_filter('FHEE__EE_Html_messenger__get_template_fields', array($this, 'html_messenger_template_fields'), 5, |
|
49 | - 2); |
|
50 | - add_filter('FHEE__EE_Html_messenger__get_validator_config', array($this, 'html_messenger_validator_config'), 5, |
|
51 | - 2); |
|
52 | - add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2); |
|
53 | - add_filter('FHEE__EE_Pdf_messenger__get_validator_config', array($this, 'pdf_messenger_validator_config'), 5, |
|
54 | - 2); |
|
55 | - add_filter('FHEE__EE_Messages_Template_Pack__get_specific_template__contents', |
|
56 | - array($this, 'new_default_templates'), 5, 7); |
|
57 | - add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', array($this, 'message_types_valid_shortcodes'), 5, |
|
58 | - 2); |
|
59 | - |
|
60 | - //shortcode parsers |
|
61 | - add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2); |
|
62 | - add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5); |
|
63 | - add_filter('FHEE__EE_Recipient_List_Shortcodes__shortcodes', |
|
64 | - array($this, 'additional_recipient_details_shortcodes'), 5, 2); |
|
65 | - add_filter('FHEE__EE_Recipient_List_Shortcodes__parser_after', |
|
66 | - array($this, 'additional_recipient_details_parser'), 5, 5); |
|
67 | - add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes', |
|
68 | - array($this, 'additional_primary_registration_details_shortcodes'), 5, 2); |
|
69 | - add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__parser_after', |
|
70 | - array($this, 'additional_primary_registration_details_parser'), 5, 5); |
|
71 | - |
|
72 | - /** |
|
73 | - * @since 4.2.0 |
|
74 | - */ |
|
75 | - add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2); |
|
76 | - add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5); |
|
77 | - |
|
78 | - /** |
|
79 | - * @since 4.3.0 |
|
80 | - */ |
|
81 | - //eat our own dog food! |
|
82 | - add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types')); |
|
83 | - add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes')); |
|
84 | - do_action('EE_Brewing_Regular___messages_caf'); |
|
85 | - } |
|
86 | - |
|
87 | - |
|
88 | - /** |
|
89 | - * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the |
|
90 | - * messages system. |
|
91 | - * |
|
92 | - * @param array $dir_ref original array of paths |
|
93 | - * |
|
94 | - * @return array appended paths |
|
95 | - */ |
|
96 | - public function messages_autoload_paths($dir_ref) |
|
97 | - { |
|
98 | - $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/'; |
|
99 | - |
|
100 | - return $dir_ref; |
|
101 | - } |
|
102 | - |
|
103 | - |
|
104 | - public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger) |
|
105 | - { |
|
106 | - $validator_config['attendee_list'] = array( |
|
107 | - 'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'), |
|
108 | - 'required' => array('[ATTENDEE_LIST]') |
|
109 | - ); |
|
110 | - $validator_config['question_list'] = array( |
|
111 | - 'shortcodes' => array('question'), |
|
112 | - 'required' => array('[QUESTION_LIST]') |
|
113 | - ); |
|
114 | - |
|
115 | - return $validator_config; |
|
116 | - } |
|
117 | - |
|
118 | - |
|
119 | - public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger) |
|
120 | - { |
|
121 | - $validator_config['attendee_list'] = array( |
|
122 | - 'shortcodes' => array('attendee', 'question_list'), |
|
123 | - 'required' => array('[ATTENDEE_LIST]') |
|
124 | - ); |
|
125 | - $validator_config['question_list'] = array( |
|
126 | - 'shortcodes' => array('question'), |
|
127 | - 'required' => array('[QUESTION_LIST]') |
|
128 | - ); |
|
129 | - |
|
130 | - return $validator_config; |
|
131 | - } |
|
132 | - |
|
133 | - |
|
134 | - public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger) |
|
135 | - { |
|
136 | - $validator_config['attendee_list'] = array( |
|
137 | - 'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'), |
|
138 | - 'required' => array('[ATTENDEE_LIST]') |
|
139 | - ); |
|
140 | - $validator_config['question_list'] = array( |
|
141 | - 'shortcodes' => array('question'), |
|
142 | - 'required' => array('[QUESTION_LIST]') |
|
143 | - ); |
|
144 | - |
|
145 | - return $validator_config; |
|
146 | - } |
|
147 | - |
|
148 | - |
|
149 | - public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger) |
|
150 | - { |
|
151 | - $template_fields['extra']['content']['question_list'] = array( |
|
152 | - 'input' => 'textarea', |
|
153 | - 'label' => '[QUESTION_LIST]', |
|
154 | - 'type' => 'string', |
|
155 | - 'required' => true, |
|
156 | - 'validation' => true, |
|
157 | - 'format' => '%s', |
|
158 | - 'css_class' => 'large-text', |
|
159 | - 'rows' => '5', |
|
160 | - 'shortcodes_required' => array('[QUESTION_LIST]') |
|
161 | - ); |
|
162 | - |
|
163 | - return $template_fields; |
|
164 | - } |
|
165 | - |
|
166 | - |
|
167 | - public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger) |
|
168 | - { |
|
169 | - $template_fields['extra']['content']['question_list'] = array( |
|
170 | - 'input' => 'textarea', |
|
171 | - 'label' => '[QUESTION_LIST]', |
|
172 | - 'type' => 'string', |
|
173 | - 'required' => true, |
|
174 | - 'validation' => true, |
|
175 | - 'format' => '%s', |
|
176 | - 'css_class' => 'large-text', |
|
177 | - 'rows' => '5', |
|
178 | - 'shortcodes_required' => array('[QUESTION_LIST]') |
|
179 | - ); |
|
180 | - |
|
181 | - return $template_fields; |
|
182 | - } |
|
183 | - |
|
184 | - |
|
185 | - public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger) |
|
186 | - { |
|
187 | - $template_fields['extra']['content']['question_list'] = array( |
|
188 | - 'input' => 'textarea', |
|
189 | - 'label' => '[QUESTION_LIST]', |
|
190 | - 'type' => 'string', |
|
191 | - 'required' => true, |
|
192 | - 'validation' => true, |
|
193 | - 'format' => '%s', |
|
194 | - 'css_class' => 'large-text', |
|
195 | - 'rows' => '5', |
|
196 | - 'shortcodes_required' => array('[QUESTION_LIST]') |
|
197 | - ); |
|
198 | - |
|
199 | - return $template_fields; |
|
200 | - } |
|
201 | - |
|
202 | - |
|
203 | - public function new_default_templates( |
|
204 | - $contents, |
|
205 | - $actual_path, |
|
206 | - EE_messenger $messenger, |
|
207 | - EE_message_type $message_type, |
|
208 | - $field, |
|
209 | - $context, |
|
210 | - EE_Messages_Template_Pack $template_pack |
|
211 | - ) { |
|
212 | - |
|
213 | - //we're only modifying templates for the default template pack |
|
214 | - if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) { |
|
215 | - return $contents; |
|
216 | - } |
|
217 | - |
|
218 | - //the template file name we're replacing contents for. |
|
219 | - $template_file_prefix = $field . '_' . $context; |
|
220 | - $msg_prefix = $messenger->name . '_' . $message_type->name . '_'; |
|
221 | - |
|
222 | - $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/'; |
|
223 | - |
|
224 | - if ($messenger->name == 'email' && $message_type->name == 'registration') { |
|
25 | + /** |
|
26 | + * constructor. |
|
27 | + */ |
|
28 | + public function __construct() |
|
29 | + { |
|
30 | + $this->_caf_hooks(); |
|
31 | + } |
|
32 | + |
|
33 | + |
|
34 | + /** |
|
35 | + * Contains all the hooks filters for setting up caffeinated messages functionality. |
|
36 | + * |
|
37 | + * @since 4.3.2 |
|
38 | + * |
|
39 | + * @return void |
|
40 | + */ |
|
41 | + private function _caf_hooks() |
|
42 | + { |
|
43 | + add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5); |
|
44 | + add_filter('FHEE__EE_Email_messenger__get_validator_config', array($this, 'email_messenger_validator_config'), |
|
45 | + 5, 2); |
|
46 | + add_filter('FHEE__EE_Email_messenger__get_template_fields', array($this, 'email_messenger_template_fields'), 5, |
|
47 | + 2); |
|
48 | + add_filter('FHEE__EE_Html_messenger__get_template_fields', array($this, 'html_messenger_template_fields'), 5, |
|
49 | + 2); |
|
50 | + add_filter('FHEE__EE_Html_messenger__get_validator_config', array($this, 'html_messenger_validator_config'), 5, |
|
51 | + 2); |
|
52 | + add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2); |
|
53 | + add_filter('FHEE__EE_Pdf_messenger__get_validator_config', array($this, 'pdf_messenger_validator_config'), 5, |
|
54 | + 2); |
|
55 | + add_filter('FHEE__EE_Messages_Template_Pack__get_specific_template__contents', |
|
56 | + array($this, 'new_default_templates'), 5, 7); |
|
57 | + add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', array($this, 'message_types_valid_shortcodes'), 5, |
|
58 | + 2); |
|
59 | + |
|
60 | + //shortcode parsers |
|
61 | + add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2); |
|
62 | + add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5); |
|
63 | + add_filter('FHEE__EE_Recipient_List_Shortcodes__shortcodes', |
|
64 | + array($this, 'additional_recipient_details_shortcodes'), 5, 2); |
|
65 | + add_filter('FHEE__EE_Recipient_List_Shortcodes__parser_after', |
|
66 | + array($this, 'additional_recipient_details_parser'), 5, 5); |
|
67 | + add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes', |
|
68 | + array($this, 'additional_primary_registration_details_shortcodes'), 5, 2); |
|
69 | + add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__parser_after', |
|
70 | + array($this, 'additional_primary_registration_details_parser'), 5, 5); |
|
71 | + |
|
72 | + /** |
|
73 | + * @since 4.2.0 |
|
74 | + */ |
|
75 | + add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2); |
|
76 | + add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5); |
|
77 | + |
|
78 | + /** |
|
79 | + * @since 4.3.0 |
|
80 | + */ |
|
81 | + //eat our own dog food! |
|
82 | + add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types')); |
|
83 | + add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes')); |
|
84 | + do_action('EE_Brewing_Regular___messages_caf'); |
|
85 | + } |
|
86 | + |
|
87 | + |
|
88 | + /** |
|
89 | + * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the |
|
90 | + * messages system. |
|
91 | + * |
|
92 | + * @param array $dir_ref original array of paths |
|
93 | + * |
|
94 | + * @return array appended paths |
|
95 | + */ |
|
96 | + public function messages_autoload_paths($dir_ref) |
|
97 | + { |
|
98 | + $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/'; |
|
99 | + |
|
100 | + return $dir_ref; |
|
101 | + } |
|
102 | + |
|
103 | + |
|
104 | + public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger) |
|
105 | + { |
|
106 | + $validator_config['attendee_list'] = array( |
|
107 | + 'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'), |
|
108 | + 'required' => array('[ATTENDEE_LIST]') |
|
109 | + ); |
|
110 | + $validator_config['question_list'] = array( |
|
111 | + 'shortcodes' => array('question'), |
|
112 | + 'required' => array('[QUESTION_LIST]') |
|
113 | + ); |
|
114 | + |
|
115 | + return $validator_config; |
|
116 | + } |
|
117 | + |
|
118 | + |
|
119 | + public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger) |
|
120 | + { |
|
121 | + $validator_config['attendee_list'] = array( |
|
122 | + 'shortcodes' => array('attendee', 'question_list'), |
|
123 | + 'required' => array('[ATTENDEE_LIST]') |
|
124 | + ); |
|
125 | + $validator_config['question_list'] = array( |
|
126 | + 'shortcodes' => array('question'), |
|
127 | + 'required' => array('[QUESTION_LIST]') |
|
128 | + ); |
|
129 | + |
|
130 | + return $validator_config; |
|
131 | + } |
|
132 | + |
|
133 | + |
|
134 | + public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger) |
|
135 | + { |
|
136 | + $validator_config['attendee_list'] = array( |
|
137 | + 'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'), |
|
138 | + 'required' => array('[ATTENDEE_LIST]') |
|
139 | + ); |
|
140 | + $validator_config['question_list'] = array( |
|
141 | + 'shortcodes' => array('question'), |
|
142 | + 'required' => array('[QUESTION_LIST]') |
|
143 | + ); |
|
144 | + |
|
145 | + return $validator_config; |
|
146 | + } |
|
147 | + |
|
148 | + |
|
149 | + public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger) |
|
150 | + { |
|
151 | + $template_fields['extra']['content']['question_list'] = array( |
|
152 | + 'input' => 'textarea', |
|
153 | + 'label' => '[QUESTION_LIST]', |
|
154 | + 'type' => 'string', |
|
155 | + 'required' => true, |
|
156 | + 'validation' => true, |
|
157 | + 'format' => '%s', |
|
158 | + 'css_class' => 'large-text', |
|
159 | + 'rows' => '5', |
|
160 | + 'shortcodes_required' => array('[QUESTION_LIST]') |
|
161 | + ); |
|
162 | + |
|
163 | + return $template_fields; |
|
164 | + } |
|
165 | + |
|
166 | + |
|
167 | + public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger) |
|
168 | + { |
|
169 | + $template_fields['extra']['content']['question_list'] = array( |
|
170 | + 'input' => 'textarea', |
|
171 | + 'label' => '[QUESTION_LIST]', |
|
172 | + 'type' => 'string', |
|
173 | + 'required' => true, |
|
174 | + 'validation' => true, |
|
175 | + 'format' => '%s', |
|
176 | + 'css_class' => 'large-text', |
|
177 | + 'rows' => '5', |
|
178 | + 'shortcodes_required' => array('[QUESTION_LIST]') |
|
179 | + ); |
|
180 | + |
|
181 | + return $template_fields; |
|
182 | + } |
|
183 | + |
|
184 | + |
|
185 | + public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger) |
|
186 | + { |
|
187 | + $template_fields['extra']['content']['question_list'] = array( |
|
188 | + 'input' => 'textarea', |
|
189 | + 'label' => '[QUESTION_LIST]', |
|
190 | + 'type' => 'string', |
|
191 | + 'required' => true, |
|
192 | + 'validation' => true, |
|
193 | + 'format' => '%s', |
|
194 | + 'css_class' => 'large-text', |
|
195 | + 'rows' => '5', |
|
196 | + 'shortcodes_required' => array('[QUESTION_LIST]') |
|
197 | + ); |
|
198 | + |
|
199 | + return $template_fields; |
|
200 | + } |
|
201 | + |
|
202 | + |
|
203 | + public function new_default_templates( |
|
204 | + $contents, |
|
205 | + $actual_path, |
|
206 | + EE_messenger $messenger, |
|
207 | + EE_message_type $message_type, |
|
208 | + $field, |
|
209 | + $context, |
|
210 | + EE_Messages_Template_Pack $template_pack |
|
211 | + ) { |
|
212 | + |
|
213 | + //we're only modifying templates for the default template pack |
|
214 | + if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) { |
|
215 | + return $contents; |
|
216 | + } |
|
217 | + |
|
218 | + //the template file name we're replacing contents for. |
|
219 | + $template_file_prefix = $field . '_' . $context; |
|
220 | + $msg_prefix = $messenger->name . '_' . $message_type->name . '_'; |
|
221 | + |
|
222 | + $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/'; |
|
223 | + |
|
224 | + if ($messenger->name == 'email' && $message_type->name == 'registration') { |
|
225 | 225 | |
226 | - switch ($template_file_prefix) { |
|
226 | + switch ($template_file_prefix) { |
|
227 | 227 | |
228 | - case 'question_list_admin' : |
|
229 | - case 'question_list_attendee' : |
|
230 | - case 'question_list_primary_attendee' : |
|
231 | - $path = $base_path . $msg_prefix . 'question_list.template.php'; |
|
232 | - $contents = EEH_Template::display_template($path, array(), true); |
|
233 | - break; |
|
228 | + case 'question_list_admin' : |
|
229 | + case 'question_list_attendee' : |
|
230 | + case 'question_list_primary_attendee' : |
|
231 | + $path = $base_path . $msg_prefix . 'question_list.template.php'; |
|
232 | + $contents = EEH_Template::display_template($path, array(), true); |
|
233 | + break; |
|
234 | 234 | |
235 | - case 'attendee_list_primary_attendee' : |
|
236 | - $path = $base_path . $msg_prefix . 'attendee_list.template.php'; |
|
237 | - $contents = EEH_Template::display_template($path, array(), true); |
|
238 | - break; |
|
235 | + case 'attendee_list_primary_attendee' : |
|
236 | + $path = $base_path . $msg_prefix . 'attendee_list.template.php'; |
|
237 | + $contents = EEH_Template::display_template($path, array(), true); |
|
238 | + break; |
|
239 | 239 | |
240 | - case 'attendee_list_admin' : |
|
241 | - $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php'; |
|
242 | - $contents = EEH_Template::display_template($path, |
|
243 | - array(), true); |
|
244 | - break; |
|
240 | + case 'attendee_list_admin' : |
|
241 | + $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php'; |
|
242 | + $contents = EEH_Template::display_template($path, |
|
243 | + array(), true); |
|
244 | + break; |
|
245 | 245 | |
246 | - case 'attendee_list_attendee' : |
|
247 | - $contents = ''; |
|
248 | - break; |
|
246 | + case 'attendee_list_attendee' : |
|
247 | + $contents = ''; |
|
248 | + break; |
|
249 | 249 | |
250 | - case 'event_list_attendee' : |
|
251 | - $path = $base_path . $msg_prefix . 'event_list_attendee.template.php'; |
|
252 | - $contents = EEH_Template::display_template($path, array(), true); |
|
253 | - break; |
|
254 | - } |
|
255 | - } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') { |
|
256 | - switch ($template_file_prefix) { |
|
250 | + case 'event_list_attendee' : |
|
251 | + $path = $base_path . $msg_prefix . 'event_list_attendee.template.php'; |
|
252 | + $contents = EEH_Template::display_template($path, array(), true); |
|
253 | + break; |
|
254 | + } |
|
255 | + } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') { |
|
256 | + switch ($template_file_prefix) { |
|
257 | 257 | |
258 | - case 'content_attendee' : |
|
259 | - $path = $base_path . $msg_prefix . 'content.template.php'; |
|
260 | - $contents = EEH_Template::display_template($path, array(), true); |
|
261 | - break; |
|
258 | + case 'content_attendee' : |
|
259 | + $path = $base_path . $msg_prefix . 'content.template.php'; |
|
260 | + $contents = EEH_Template::display_template($path, array(), true); |
|
261 | + break; |
|
262 | 262 | |
263 | - case 'newsletter_content_attendee' : |
|
264 | - $path = $base_path . $msg_prefix . 'newsletter_content.template.php'; |
|
265 | - $contents = EEH_Template::display_template($path, array(), true); |
|
266 | - break; |
|
263 | + case 'newsletter_content_attendee' : |
|
264 | + $path = $base_path . $msg_prefix . 'newsletter_content.template.php'; |
|
265 | + $contents = EEH_Template::display_template($path, array(), true); |
|
266 | + break; |
|
267 | 267 | |
268 | - case 'newsletter_subject_attendee' : |
|
269 | - $path = $base_path . $msg_prefix . 'subject.template.php'; |
|
270 | - $contents = EEH_Template::display_template($path, array(), true); |
|
271 | - break; |
|
272 | - } |
|
273 | - } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') { |
|
274 | - switch ($template_file_prefix) { |
|
275 | - case 'attendee_list_purchaser' : |
|
276 | - $path = $base_path . $msg_prefix . 'attendee_list.template.php'; |
|
277 | - $contents = EEH_Template::display_template($path, array(), true); |
|
278 | - break; |
|
279 | - } |
|
280 | - } |
|
281 | - |
|
282 | - return $contents; |
|
283 | - |
|
284 | - } |
|
285 | - |
|
286 | - |
|
287 | - public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg) |
|
288 | - { |
|
289 | - //make sure question_list and question are ONLY added for the core message types. Any other message types will have to explicitly set question_list as a valid shortcode. |
|
290 | - $include_with = array( |
|
291 | - 'registration', |
|
292 | - 'cancelled_registration', |
|
293 | - 'declined_registration', |
|
294 | - 'not_approved_registration', |
|
295 | - 'payment_declined', |
|
296 | - 'payment_failed', |
|
297 | - 'payment_cancelled', |
|
298 | - 'payment', |
|
299 | - 'payment_reminder', |
|
300 | - 'pending_approval', |
|
301 | - 'registration_summary', |
|
302 | - 'invoice', |
|
303 | - 'receipt' |
|
304 | - ); |
|
305 | - if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) { |
|
306 | - $contexts = array_keys($msg->get_contexts()); |
|
307 | - foreach ($contexts as $context) { |
|
308 | - $valid_shortcodes[$context][] = 'question_list'; |
|
309 | - $valid_shortcodes[$context][] = 'question'; |
|
310 | - } |
|
311 | - } |
|
312 | - |
|
313 | - return $valid_shortcodes; |
|
314 | - } |
|
315 | - |
|
316 | - |
|
317 | - public function additional_attendee_shortcodes($shortcodes, $shortcode_parser) |
|
318 | - { |
|
319 | - $shortcodes['[ANSWER_*]'] = __('This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.', |
|
320 | - 'event_espresso'); |
|
321 | - |
|
322 | - return $shortcodes; |
|
323 | - } |
|
324 | - |
|
325 | - |
|
326 | - public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser) |
|
327 | - { |
|
328 | - |
|
329 | - if (strpos($shortcode, |
|
330 | - '[ANSWER_*') === false || ! isset($extra_data['data']->questions) || ! isset($extra_data['data']->registrations) |
|
331 | - ) { |
|
332 | - return $parsed; |
|
333 | - } |
|
334 | - |
|
335 | - //let's get the question from the code. |
|
336 | - $shortcode = str_replace('[ANSWER_*', '', $shortcode); |
|
337 | - $shortcode = trim(str_replace(']', '', $shortcode)); |
|
338 | - |
|
339 | - $registration = $data instanceof EE_Registration ? $data : null; |
|
340 | - $registration = ! $registration instanceof EE_Registration && is_array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration; |
|
341 | - |
|
342 | - $aee = $data instanceof EE_Messages_Addressee ? $data : null; |
|
343 | - $aee = ! $aee instanceof EE_Messages_Addressee && is_array($extra_data) && isset($extra_data['data']) ? $extra_data['data'] : $aee; |
|
344 | - |
|
345 | - if ( ! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) { |
|
346 | - return $parsed; |
|
347 | - } |
|
348 | - |
|
349 | - //now let's figure out which question has this text. |
|
350 | - foreach ($aee->questions as $ansid => $question) { |
|
351 | - if ( |
|
352 | - $question instanceof EE_Question |
|
353 | - && trim($question->display_text()) == trim($shortcode) |
|
354 | - && isset($aee->registrations[$registration->ID()]['ans_objs'][$ansid]) |
|
355 | - ) { |
|
356 | - return $aee->registrations[$registration->ID()]['ans_objs'][$ansid]->get_pretty('ANS_value', |
|
357 | - 'no_wpautop'); |
|
358 | - } |
|
359 | - } |
|
360 | - |
|
361 | - //nothing! |
|
362 | - return $parsed; |
|
363 | - } |
|
364 | - |
|
365 | - |
|
366 | - /** |
|
367 | - * Callback for additional shortcodes filter for adding additional datetime shortcodes. |
|
368 | - * |
|
369 | - * @since 4.2 |
|
370 | - * |
|
371 | - * @param array $shortcodes array of shortcodes and |
|
372 | - * descriptions |
|
373 | - * @param EE_Datetime_Shortcodes $shortcode_parser EE_Shortcodes object |
|
374 | - * |
|
375 | - * @return array array of shortcodes and |
|
376 | - * descriptions |
|
377 | - */ |
|
378 | - public function additional_datetime_shortcodes($shortcodes, $shortcode_parser) |
|
379 | - { |
|
380 | - $shortcodes['[DTT_NAME]'] = __('This will be parsed to the Title given for a Datetime', |
|
381 | - 'event_espresso'); |
|
382 | - $shortcodes['[DTT_DESCRIPTION]'] = __('This will be parsed to the description for a Datetime', |
|
383 | - 'event_espresso'); |
|
384 | - $shortcodes['[DTT_NAME_OR_DATES]'] = __('When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.', |
|
385 | - 'event_espresso'); |
|
386 | - |
|
387 | - return $shortcodes; |
|
388 | - } |
|
389 | - |
|
390 | - |
|
391 | - /** |
|
392 | - * Callback for additional shortcodes parser filter used for adding parser for new |
|
393 | - * Datetime shortcodes |
|
394 | - * |
|
395 | - * @since 4.2 |
|
396 | - * |
|
397 | - * @param string $parsed The finished parsed string for the given shortcode. |
|
398 | - * @param string $shortcode The shortcode being parsed. |
|
399 | - * @param object $data The incoming data object for the Shortcode Parser. |
|
400 | - * @param object $extra_data The incoming extra date object for the Shortcode |
|
401 | - * Parser. |
|
402 | - * @param EE_Datetime_Shortcodes $shortcode_parser |
|
403 | - * |
|
404 | - * @return string The new parsed string. |
|
405 | - */ |
|
406 | - public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser) |
|
407 | - { |
|
408 | - |
|
409 | - if ( ! $data instanceof EE_Datetime) { |
|
410 | - return ''; //get out because we can only parse with the datetime object. |
|
411 | - } |
|
412 | - |
|
413 | - switch ($shortcode) { |
|
414 | - case '[DTT_NAME]' : |
|
415 | - return $data->name(); |
|
416 | - break; |
|
417 | - case '[DTT_DESCRIPTION]' : |
|
418 | - return $data->description(); |
|
419 | - break; |
|
420 | - case '[DTT_NAME_OR_DATES]' : |
|
421 | - return $data->get_dtt_display_name(true); |
|
422 | - break; |
|
423 | - default : |
|
424 | - return $parsed; |
|
425 | - break; |
|
426 | - } |
|
427 | - } |
|
428 | - |
|
429 | - |
|
430 | - public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser) |
|
431 | - { |
|
432 | - $shortcodes['[RECIPIENT_QUESTION_LIST]'] = __('This is used to indicate where you want the list of questions and answers to show for the person receiving the message.', |
|
433 | - 'event_espresso'); |
|
434 | - |
|
435 | - return $shortcodes; |
|
436 | - } |
|
437 | - |
|
438 | - |
|
439 | - /** |
|
440 | - * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter). |
|
441 | - * |
|
442 | - * @param string $parsed The original parsed content for the shortcode |
|
443 | - * @param string $shortcode The shortcode being parsed |
|
444 | - * @param array $data The shortcode parser data array |
|
445 | - * @param array $extra_data The shortcode parser extra data array |
|
446 | - * @param \EE_Shortcodes $shortcode_parser Shortcode parser. |
|
447 | - * |
|
448 | - * @return string |
|
449 | - */ |
|
450 | - public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser) |
|
451 | - { |
|
452 | - |
|
453 | - if (array($data) && ! isset($data['data'])) { |
|
454 | - return $parsed; |
|
455 | - } |
|
456 | - |
|
457 | - $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null; |
|
458 | - $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient; |
|
459 | - |
|
460 | - if ( ! $recipient instanceof EE_Messages_Addressee) { |
|
461 | - return $parsed; |
|
462 | - } |
|
463 | - |
|
464 | - switch ($shortcode) { |
|
465 | - case '[RECIPIENT_QUESTION_LIST]' : |
|
466 | - $att = $recipient->att_obj; |
|
467 | - $registrations_on_attendee = $att instanceof EE_Attendee ? $recipient->attendees[$att->ID()]['reg_objs'] : array(); |
|
468 | - $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee; |
|
469 | - $answers = array(); |
|
268 | + case 'newsletter_subject_attendee' : |
|
269 | + $path = $base_path . $msg_prefix . 'subject.template.php'; |
|
270 | + $contents = EEH_Template::display_template($path, array(), true); |
|
271 | + break; |
|
272 | + } |
|
273 | + } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') { |
|
274 | + switch ($template_file_prefix) { |
|
275 | + case 'attendee_list_purchaser' : |
|
276 | + $path = $base_path . $msg_prefix . 'attendee_list.template.php'; |
|
277 | + $contents = EEH_Template::display_template($path, array(), true); |
|
278 | + break; |
|
279 | + } |
|
280 | + } |
|
281 | + |
|
282 | + return $contents; |
|
283 | + |
|
284 | + } |
|
285 | + |
|
286 | + |
|
287 | + public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg) |
|
288 | + { |
|
289 | + //make sure question_list and question are ONLY added for the core message types. Any other message types will have to explicitly set question_list as a valid shortcode. |
|
290 | + $include_with = array( |
|
291 | + 'registration', |
|
292 | + 'cancelled_registration', |
|
293 | + 'declined_registration', |
|
294 | + 'not_approved_registration', |
|
295 | + 'payment_declined', |
|
296 | + 'payment_failed', |
|
297 | + 'payment_cancelled', |
|
298 | + 'payment', |
|
299 | + 'payment_reminder', |
|
300 | + 'pending_approval', |
|
301 | + 'registration_summary', |
|
302 | + 'invoice', |
|
303 | + 'receipt' |
|
304 | + ); |
|
305 | + if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) { |
|
306 | + $contexts = array_keys($msg->get_contexts()); |
|
307 | + foreach ($contexts as $context) { |
|
308 | + $valid_shortcodes[$context][] = 'question_list'; |
|
309 | + $valid_shortcodes[$context][] = 'question'; |
|
310 | + } |
|
311 | + } |
|
312 | + |
|
313 | + return $valid_shortcodes; |
|
314 | + } |
|
315 | + |
|
316 | + |
|
317 | + public function additional_attendee_shortcodes($shortcodes, $shortcode_parser) |
|
318 | + { |
|
319 | + $shortcodes['[ANSWER_*]'] = __('This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.', |
|
320 | + 'event_espresso'); |
|
321 | + |
|
322 | + return $shortcodes; |
|
323 | + } |
|
324 | + |
|
325 | + |
|
326 | + public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser) |
|
327 | + { |
|
328 | + |
|
329 | + if (strpos($shortcode, |
|
330 | + '[ANSWER_*') === false || ! isset($extra_data['data']->questions) || ! isset($extra_data['data']->registrations) |
|
331 | + ) { |
|
332 | + return $parsed; |
|
333 | + } |
|
334 | + |
|
335 | + //let's get the question from the code. |
|
336 | + $shortcode = str_replace('[ANSWER_*', '', $shortcode); |
|
337 | + $shortcode = trim(str_replace(']', '', $shortcode)); |
|
338 | + |
|
339 | + $registration = $data instanceof EE_Registration ? $data : null; |
|
340 | + $registration = ! $registration instanceof EE_Registration && is_array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration; |
|
341 | + |
|
342 | + $aee = $data instanceof EE_Messages_Addressee ? $data : null; |
|
343 | + $aee = ! $aee instanceof EE_Messages_Addressee && is_array($extra_data) && isset($extra_data['data']) ? $extra_data['data'] : $aee; |
|
344 | + |
|
345 | + if ( ! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) { |
|
346 | + return $parsed; |
|
347 | + } |
|
348 | + |
|
349 | + //now let's figure out which question has this text. |
|
350 | + foreach ($aee->questions as $ansid => $question) { |
|
351 | + if ( |
|
352 | + $question instanceof EE_Question |
|
353 | + && trim($question->display_text()) == trim($shortcode) |
|
354 | + && isset($aee->registrations[$registration->ID()]['ans_objs'][$ansid]) |
|
355 | + ) { |
|
356 | + return $aee->registrations[$registration->ID()]['ans_objs'][$ansid]->get_pretty('ANS_value', |
|
357 | + 'no_wpautop'); |
|
358 | + } |
|
359 | + } |
|
360 | + |
|
361 | + //nothing! |
|
362 | + return $parsed; |
|
363 | + } |
|
364 | + |
|
365 | + |
|
366 | + /** |
|
367 | + * Callback for additional shortcodes filter for adding additional datetime shortcodes. |
|
368 | + * |
|
369 | + * @since 4.2 |
|
370 | + * |
|
371 | + * @param array $shortcodes array of shortcodes and |
|
372 | + * descriptions |
|
373 | + * @param EE_Datetime_Shortcodes $shortcode_parser EE_Shortcodes object |
|
374 | + * |
|
375 | + * @return array array of shortcodes and |
|
376 | + * descriptions |
|
377 | + */ |
|
378 | + public function additional_datetime_shortcodes($shortcodes, $shortcode_parser) |
|
379 | + { |
|
380 | + $shortcodes['[DTT_NAME]'] = __('This will be parsed to the Title given for a Datetime', |
|
381 | + 'event_espresso'); |
|
382 | + $shortcodes['[DTT_DESCRIPTION]'] = __('This will be parsed to the description for a Datetime', |
|
383 | + 'event_espresso'); |
|
384 | + $shortcodes['[DTT_NAME_OR_DATES]'] = __('When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.', |
|
385 | + 'event_espresso'); |
|
386 | + |
|
387 | + return $shortcodes; |
|
388 | + } |
|
389 | + |
|
390 | + |
|
391 | + /** |
|
392 | + * Callback for additional shortcodes parser filter used for adding parser for new |
|
393 | + * Datetime shortcodes |
|
394 | + * |
|
395 | + * @since 4.2 |
|
396 | + * |
|
397 | + * @param string $parsed The finished parsed string for the given shortcode. |
|
398 | + * @param string $shortcode The shortcode being parsed. |
|
399 | + * @param object $data The incoming data object for the Shortcode Parser. |
|
400 | + * @param object $extra_data The incoming extra date object for the Shortcode |
|
401 | + * Parser. |
|
402 | + * @param EE_Datetime_Shortcodes $shortcode_parser |
|
403 | + * |
|
404 | + * @return string The new parsed string. |
|
405 | + */ |
|
406 | + public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser) |
|
407 | + { |
|
408 | + |
|
409 | + if ( ! $data instanceof EE_Datetime) { |
|
410 | + return ''; //get out because we can only parse with the datetime object. |
|
411 | + } |
|
412 | + |
|
413 | + switch ($shortcode) { |
|
414 | + case '[DTT_NAME]' : |
|
415 | + return $data->name(); |
|
416 | + break; |
|
417 | + case '[DTT_DESCRIPTION]' : |
|
418 | + return $data->description(); |
|
419 | + break; |
|
420 | + case '[DTT_NAME_OR_DATES]' : |
|
421 | + return $data->get_dtt_display_name(true); |
|
422 | + break; |
|
423 | + default : |
|
424 | + return $parsed; |
|
425 | + break; |
|
426 | + } |
|
427 | + } |
|
428 | + |
|
429 | + |
|
430 | + public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser) |
|
431 | + { |
|
432 | + $shortcodes['[RECIPIENT_QUESTION_LIST]'] = __('This is used to indicate where you want the list of questions and answers to show for the person receiving the message.', |
|
433 | + 'event_espresso'); |
|
434 | + |
|
435 | + return $shortcodes; |
|
436 | + } |
|
437 | + |
|
438 | + |
|
439 | + /** |
|
440 | + * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter). |
|
441 | + * |
|
442 | + * @param string $parsed The original parsed content for the shortcode |
|
443 | + * @param string $shortcode The shortcode being parsed |
|
444 | + * @param array $data The shortcode parser data array |
|
445 | + * @param array $extra_data The shortcode parser extra data array |
|
446 | + * @param \EE_Shortcodes $shortcode_parser Shortcode parser. |
|
447 | + * |
|
448 | + * @return string |
|
449 | + */ |
|
450 | + public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser) |
|
451 | + { |
|
452 | + |
|
453 | + if (array($data) && ! isset($data['data'])) { |
|
454 | + return $parsed; |
|
455 | + } |
|
456 | + |
|
457 | + $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null; |
|
458 | + $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient; |
|
459 | + |
|
460 | + if ( ! $recipient instanceof EE_Messages_Addressee) { |
|
461 | + return $parsed; |
|
462 | + } |
|
463 | + |
|
464 | + switch ($shortcode) { |
|
465 | + case '[RECIPIENT_QUESTION_LIST]' : |
|
466 | + $att = $recipient->att_obj; |
|
467 | + $registrations_on_attendee = $att instanceof EE_Attendee ? $recipient->attendees[$att->ID()]['reg_objs'] : array(); |
|
468 | + $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee; |
|
469 | + $answers = array(); |
|
470 | 470 | |
471 | - $template = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list']; |
|
472 | - $valid_shortcodes = array('question'); |
|
471 | + $template = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list']; |
|
472 | + $valid_shortcodes = array('question'); |
|
473 | 473 | |
474 | - //if the context is main_content then get all answers for all registrations on this attendee |
|
475 | - if ($data['data'] instanceof EE_Messages_Addressee) { |
|
474 | + //if the context is main_content then get all answers for all registrations on this attendee |
|
475 | + if ($data['data'] instanceof EE_Messages_Addressee) { |
|
476 | 476 | |
477 | - foreach ($registrations_on_attendee as $reg) { |
|
478 | - if ($reg instanceof EE_Registration) { |
|
479 | - $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array(); |
|
480 | - foreach ($anss as $ans) { |
|
481 | - if ($ans instanceof EE_Answer) { |
|
482 | - $answers[$ans->ID()] = $ans; |
|
483 | - } |
|
484 | - } |
|
485 | - } |
|
486 | - } |
|
487 | - } |
|
477 | + foreach ($registrations_on_attendee as $reg) { |
|
478 | + if ($reg instanceof EE_Registration) { |
|
479 | + $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array(); |
|
480 | + foreach ($anss as $ans) { |
|
481 | + if ($ans instanceof EE_Answer) { |
|
482 | + $answers[$ans->ID()] = $ans; |
|
483 | + } |
|
484 | + } |
|
485 | + } |
|
486 | + } |
|
487 | + } |
|
488 | 488 | |
489 | - //if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event. |
|
490 | - if ($data['data'] instanceof EE_Event) { |
|
491 | - $event = $data['data']; |
|
492 | - foreach ($registrations_on_attendee as $reg) { |
|
493 | - if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) { |
|
494 | - $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array(); |
|
495 | - foreach ($anss as $ans) { |
|
496 | - if ($ans instanceof EE_Answer) { |
|
497 | - $answers[$ans->ID()] = $ans; |
|
498 | - } |
|
499 | - } |
|
500 | - } |
|
501 | - } |
|
502 | - } |
|
489 | + //if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event. |
|
490 | + if ($data['data'] instanceof EE_Event) { |
|
491 | + $event = $data['data']; |
|
492 | + foreach ($registrations_on_attendee as $reg) { |
|
493 | + if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) { |
|
494 | + $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array(); |
|
495 | + foreach ($anss as $ans) { |
|
496 | + if ($ans instanceof EE_Answer) { |
|
497 | + $answers[$ans->ID()] = $ans; |
|
498 | + } |
|
499 | + } |
|
500 | + } |
|
501 | + } |
|
502 | + } |
|
503 | 503 | |
504 | - $questions = $questions = isset($recipient->questions) ? $recipient->questions : array(); |
|
504 | + $questions = $questions = isset($recipient->questions) ? $recipient->questions : array(); |
|
505 | 505 | |
506 | - //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee |
|
507 | - //object on it. |
|
508 | - if ( ! isset( $extra_data['data'] ) ) { |
|
509 | - $extra_data['data'] = $recipient; |
|
510 | - } |
|
506 | + //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee |
|
507 | + //object on it. |
|
508 | + if ( ! isset( $extra_data['data'] ) ) { |
|
509 | + $extra_data['data'] = $recipient; |
|
510 | + } |
|
511 | 511 | |
512 | - return $this->_parse_question_list_for_primary_or_recipient_registration( |
|
513 | - $shortcode_parser, |
|
514 | - $questions, |
|
515 | - $answers, |
|
516 | - $template, |
|
517 | - $valid_shortcodes, |
|
518 | - $extra_data |
|
519 | - ); |
|
520 | - break; |
|
512 | + return $this->_parse_question_list_for_primary_or_recipient_registration( |
|
513 | + $shortcode_parser, |
|
514 | + $questions, |
|
515 | + $answers, |
|
516 | + $template, |
|
517 | + $valid_shortcodes, |
|
518 | + $extra_data |
|
519 | + ); |
|
520 | + break; |
|
521 | 521 | |
522 | - default : |
|
523 | - return $parsed; |
|
524 | - break; |
|
525 | - } |
|
526 | - } |
|
527 | - |
|
528 | - |
|
529 | - public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser) |
|
530 | - { |
|
531 | - $shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __('This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field', |
|
532 | - 'event_espresso'); |
|
533 | - |
|
534 | - return $shortcodes; |
|
535 | - } |
|
536 | - |
|
537 | - |
|
538 | - /** |
|
539 | - * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter). |
|
540 | - * |
|
541 | - * @param string $parsed The original parsed content for the shortcode |
|
542 | - * @param string $shortcode The shortcode being parsed |
|
543 | - * @param array $data The shortcode parser data array |
|
544 | - * @param array $extra_data The shortcode parser extra data array |
|
545 | - * @param \EE_Shortcodes $shortcode_parser Shortcode parser. |
|
546 | - * |
|
547 | - * @return string |
|
548 | - */ |
|
549 | - public function additional_primary_registration_details_parser( |
|
550 | - $parsed, |
|
551 | - $shortcode, |
|
552 | - $data, |
|
553 | - $extra_data, |
|
554 | - $shortcode_parser |
|
555 | - ) { |
|
556 | - if (array($data) && ! isset($data['data'])) { |
|
557 | - return $parsed; |
|
558 | - } |
|
559 | - |
|
560 | - $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null; |
|
561 | - $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient; |
|
562 | - |
|
563 | - if ( ! $recipient instanceof EE_Messages_Addressee) { |
|
564 | - return $parsed; |
|
565 | - } |
|
566 | - |
|
567 | - switch ($shortcode) { |
|
568 | - case '[PRIMARY_REGISTRANT_QUESTION_LIST]' : |
|
569 | - if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) { |
|
570 | - return ''; |
|
571 | - } |
|
572 | - $registration = $recipient->primary_reg_obj; |
|
573 | - $answers = isset($recipient->registrations[$registration->ID()]['ans_objs']) |
|
574 | - ? $recipient->registrations[$registration->ID()]['ans_objs'] |
|
575 | - : array(); |
|
576 | - if (empty($answers)) { |
|
577 | - return ''; |
|
578 | - } |
|
579 | - $template = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list']; |
|
580 | - $valid_shortcodes = array('question'); |
|
581 | - $answers = $recipient->registrations[$registration->ID()]['ans_objs']; |
|
582 | - $questions = isset($recipient->questions) ? $recipient->questions : array(); |
|
583 | - //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee |
|
584 | - //object on it. |
|
585 | - if ( ! isset( $extra_data['data'] ) ){ |
|
586 | - $extra_data['data'] = $recipient; |
|
587 | - } |
|
588 | - return $this->_parse_question_list_for_primary_or_recipient_registration( |
|
589 | - $shortcode_parser, |
|
590 | - $questions, |
|
591 | - $answers, |
|
592 | - $template, |
|
593 | - $valid_shortcodes, |
|
594 | - $extra_data |
|
595 | - ); |
|
596 | - break; |
|
522 | + default : |
|
523 | + return $parsed; |
|
524 | + break; |
|
525 | + } |
|
526 | + } |
|
527 | + |
|
528 | + |
|
529 | + public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser) |
|
530 | + { |
|
531 | + $shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __('This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field', |
|
532 | + 'event_espresso'); |
|
533 | + |
|
534 | + return $shortcodes; |
|
535 | + } |
|
536 | + |
|
537 | + |
|
538 | + /** |
|
539 | + * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter). |
|
540 | + * |
|
541 | + * @param string $parsed The original parsed content for the shortcode |
|
542 | + * @param string $shortcode The shortcode being parsed |
|
543 | + * @param array $data The shortcode parser data array |
|
544 | + * @param array $extra_data The shortcode parser extra data array |
|
545 | + * @param \EE_Shortcodes $shortcode_parser Shortcode parser. |
|
546 | + * |
|
547 | + * @return string |
|
548 | + */ |
|
549 | + public function additional_primary_registration_details_parser( |
|
550 | + $parsed, |
|
551 | + $shortcode, |
|
552 | + $data, |
|
553 | + $extra_data, |
|
554 | + $shortcode_parser |
|
555 | + ) { |
|
556 | + if (array($data) && ! isset($data['data'])) { |
|
557 | + return $parsed; |
|
558 | + } |
|
559 | + |
|
560 | + $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null; |
|
561 | + $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient; |
|
562 | + |
|
563 | + if ( ! $recipient instanceof EE_Messages_Addressee) { |
|
564 | + return $parsed; |
|
565 | + } |
|
566 | + |
|
567 | + switch ($shortcode) { |
|
568 | + case '[PRIMARY_REGISTRANT_QUESTION_LIST]' : |
|
569 | + if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) { |
|
570 | + return ''; |
|
571 | + } |
|
572 | + $registration = $recipient->primary_reg_obj; |
|
573 | + $answers = isset($recipient->registrations[$registration->ID()]['ans_objs']) |
|
574 | + ? $recipient->registrations[$registration->ID()]['ans_objs'] |
|
575 | + : array(); |
|
576 | + if (empty($answers)) { |
|
577 | + return ''; |
|
578 | + } |
|
579 | + $template = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list']; |
|
580 | + $valid_shortcodes = array('question'); |
|
581 | + $answers = $recipient->registrations[$registration->ID()]['ans_objs']; |
|
582 | + $questions = isset($recipient->questions) ? $recipient->questions : array(); |
|
583 | + //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee |
|
584 | + //object on it. |
|
585 | + if ( ! isset( $extra_data['data'] ) ){ |
|
586 | + $extra_data['data'] = $recipient; |
|
587 | + } |
|
588 | + return $this->_parse_question_list_for_primary_or_recipient_registration( |
|
589 | + $shortcode_parser, |
|
590 | + $questions, |
|
591 | + $answers, |
|
592 | + $template, |
|
593 | + $valid_shortcodes, |
|
594 | + $extra_data |
|
595 | + ); |
|
596 | + break; |
|
597 | 597 | |
598 | - default : |
|
599 | - return $parsed; |
|
600 | - break; |
|
601 | - } |
|
602 | - } |
|
603 | - |
|
604 | - |
|
605 | - /** |
|
606 | - * Takes care of registering the message types that are only available in caffeinated EE. |
|
607 | - * |
|
608 | - * @since 4.3.2 |
|
609 | - * |
|
610 | - * @return void |
|
611 | - */ |
|
612 | - public function register_caf_message_types() |
|
613 | - { |
|
614 | - //register newsletter message type |
|
615 | - $setup_args = array( |
|
616 | - 'mtfilename' => 'EE_Newsletter_message_type.class.php', |
|
617 | - 'autoloadpaths' => array( |
|
618 | - EE_CAF_LIBRARIES . 'messages/message_type/newsletter/' |
|
619 | - ), |
|
620 | - 'messengers_to_activate_with' => array('email'), |
|
621 | - 'messengers_to_validate_with' => array('email'), |
|
622 | - 'messengers_supporting_default_template_pack_with' => array('email') |
|
623 | - ); |
|
624 | - EE_Register_Message_Type::register('newsletter', $setup_args); |
|
625 | - |
|
626 | - //register payment reminder message type |
|
627 | - $setup_args = array( |
|
628 | - 'mtfilename' => 'EE_Payment_Reminder_message_type.class.php', |
|
629 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'), |
|
630 | - 'messengers_to_activate_with' => array('email'), |
|
631 | - 'messengers_to_validate_with' => array('email'), |
|
632 | - 'messengers_supporting_default_template_pack_with' => array('email') |
|
633 | - ); |
|
634 | - EE_Register_Message_Type::register('payment_reminder', $setup_args); |
|
635 | - |
|
636 | - //register payment declined message type |
|
637 | - $setup_args = array( |
|
638 | - 'mtfilename' => 'EE_Payment_Declined_message_type.class.php', |
|
639 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'), |
|
640 | - 'messengers_to_activate_with' => array('email'), |
|
641 | - 'messengers_to_validate_with' => array('email'), |
|
642 | - 'messengers_supporting_default_template_pack_with' => array('email') |
|
643 | - ); |
|
644 | - EE_Register_Message_Type::register('payment_declined', $setup_args); |
|
645 | - |
|
646 | - //register registration declined message type |
|
647 | - $setup_args = array( |
|
648 | - 'mtfilename' => 'EE_Declined_Registration_message_type.class.php', |
|
649 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'), |
|
650 | - 'messengers_to_activate_with' => array('email'), |
|
651 | - 'messengers_to_validate_with' => array('email'), |
|
652 | - 'messengers_supporting_default_template_pack_with' => array('email') |
|
653 | - ); |
|
654 | - EE_Register_Message_Type::register('declined_registration', $setup_args); |
|
655 | - |
|
656 | - //register registration cancelled message type |
|
657 | - $setup_args = array( |
|
658 | - 'mtfilename' => 'EE_Cancelled_Registration_message_type.class.php', |
|
659 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'), |
|
660 | - 'messengers_to_activate_with' => array('email'), |
|
661 | - 'messengers_to_validate_with' => array('email'), |
|
662 | - 'messengers_supporting_default_template_pack_with' => array('email') |
|
663 | - ); |
|
664 | - EE_Register_Message_Type::register('cancelled_registration', $setup_args); |
|
665 | - |
|
666 | - |
|
667 | - //register payment failed message type |
|
668 | - $setup_args = array( |
|
669 | - 'mtfilename' => 'EE_Payment_Failed_message_type.class.php', |
|
670 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'), |
|
671 | - 'messengers_to_activate_with' => array('email'), |
|
672 | - 'messengers_to_validate_with' => array('email'), |
|
673 | - 'messengers_supporting_default_template_pack_with' => array('email') |
|
674 | - ); |
|
675 | - EE_Register_Message_Type::register('payment_failed', $setup_args); |
|
676 | - |
|
677 | - //register payment declined message type |
|
678 | - $setup_args = array( |
|
679 | - 'mtfilename' => 'EE_Payment_Cancelled_message_type.class.php', |
|
680 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'), |
|
681 | - 'messengers_to_activate_with' => array('email'), |
|
682 | - 'messengers_to_validate_with' => array('email'), |
|
683 | - 'messengers_supporting_default_template_pack_with' => array('email') |
|
684 | - ); |
|
685 | - EE_Register_Message_Type::register('payment_cancelled', $setup_args); |
|
686 | - } |
|
687 | - |
|
688 | - |
|
689 | - /** |
|
690 | - * Takes care of registering the shortcode libraries implemented with caffeinated EE and set up related items. |
|
691 | - * |
|
692 | - * @since 4.3.2 |
|
693 | - * |
|
694 | - * @return void |
|
695 | - */ |
|
696 | - public function register_caf_shortcodes() |
|
697 | - { |
|
698 | - $setup_args = array( |
|
699 | - 'autoloadpaths' => array( |
|
700 | - EE_CAF_LIBRARIES . 'shortcodes/' |
|
701 | - ), |
|
702 | - 'msgr_validator_callback' => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'), |
|
703 | - 'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'), |
|
704 | - 'list_type_shortcodes' => array('[NEWSLETTER_CONTENT]') |
|
705 | - ); |
|
706 | - EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args); |
|
707 | - } |
|
708 | - |
|
709 | - |
|
710 | - /** |
|
711 | - * Parses a question list shortcode using given data and template |
|
712 | - * |
|
713 | - * @param \EE_Shortcodes $shortcode_parser |
|
714 | - * @param EE_Question[] $questions An array of questions indexed by answer id. |
|
715 | - * @param EE_Answer[] $answers An array of answer objects |
|
716 | - * @param string $template Template content to be parsed. |
|
717 | - * @param array $valid_shortcodes Valid shortcodes for the template being parsed. |
|
718 | - * @param array $extra_data Extra data that might be used when parsing the template. |
|
719 | - */ |
|
720 | - protected function _parse_question_list_for_primary_or_recipient_registration( |
|
721 | - $shortcode_parser, |
|
722 | - $questions, |
|
723 | - $answers, |
|
724 | - $template, |
|
725 | - $valid_shortcodes, |
|
726 | - $extra_data |
|
727 | - ) { |
|
728 | - $question_list = ''; |
|
729 | - /** @var EEH_Parse_Shortcodes $shortcode_helper */ |
|
730 | - $shortcode_helper = $shortcode_parser->get_shortcode_helper(); |
|
731 | - foreach ($answers as $answer) { |
|
732 | - if ($answer instanceof EE_Answer) { |
|
733 | - //first see if the question is in our $questions array. If not then try to get from answer object. |
|
734 | - $question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null; |
|
735 | - $question = ! $question instanceof EE_Question ? $answer->question() : $question; |
|
736 | - if ( |
|
737 | - ! $question instanceof EE_Question |
|
738 | - || ( |
|
739 | - $question instanceof EE_Question |
|
740 | - && $question->admin_only() |
|
741 | - ) |
|
742 | - ) { |
|
743 | - continue; |
|
744 | - } |
|
745 | - $question_list .= $shortcode_helper->parse_question_list_template( |
|
746 | - $template, |
|
747 | - $answer, |
|
748 | - $valid_shortcodes, |
|
749 | - $extra_data |
|
750 | - ); |
|
751 | - } |
|
752 | - } |
|
753 | - |
|
754 | - return $question_list; |
|
755 | - } |
|
598 | + default : |
|
599 | + return $parsed; |
|
600 | + break; |
|
601 | + } |
|
602 | + } |
|
603 | + |
|
604 | + |
|
605 | + /** |
|
606 | + * Takes care of registering the message types that are only available in caffeinated EE. |
|
607 | + * |
|
608 | + * @since 4.3.2 |
|
609 | + * |
|
610 | + * @return void |
|
611 | + */ |
|
612 | + public function register_caf_message_types() |
|
613 | + { |
|
614 | + //register newsletter message type |
|
615 | + $setup_args = array( |
|
616 | + 'mtfilename' => 'EE_Newsletter_message_type.class.php', |
|
617 | + 'autoloadpaths' => array( |
|
618 | + EE_CAF_LIBRARIES . 'messages/message_type/newsletter/' |
|
619 | + ), |
|
620 | + 'messengers_to_activate_with' => array('email'), |
|
621 | + 'messengers_to_validate_with' => array('email'), |
|
622 | + 'messengers_supporting_default_template_pack_with' => array('email') |
|
623 | + ); |
|
624 | + EE_Register_Message_Type::register('newsletter', $setup_args); |
|
625 | + |
|
626 | + //register payment reminder message type |
|
627 | + $setup_args = array( |
|
628 | + 'mtfilename' => 'EE_Payment_Reminder_message_type.class.php', |
|
629 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'), |
|
630 | + 'messengers_to_activate_with' => array('email'), |
|
631 | + 'messengers_to_validate_with' => array('email'), |
|
632 | + 'messengers_supporting_default_template_pack_with' => array('email') |
|
633 | + ); |
|
634 | + EE_Register_Message_Type::register('payment_reminder', $setup_args); |
|
635 | + |
|
636 | + //register payment declined message type |
|
637 | + $setup_args = array( |
|
638 | + 'mtfilename' => 'EE_Payment_Declined_message_type.class.php', |
|
639 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'), |
|
640 | + 'messengers_to_activate_with' => array('email'), |
|
641 | + 'messengers_to_validate_with' => array('email'), |
|
642 | + 'messengers_supporting_default_template_pack_with' => array('email') |
|
643 | + ); |
|
644 | + EE_Register_Message_Type::register('payment_declined', $setup_args); |
|
645 | + |
|
646 | + //register registration declined message type |
|
647 | + $setup_args = array( |
|
648 | + 'mtfilename' => 'EE_Declined_Registration_message_type.class.php', |
|
649 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'), |
|
650 | + 'messengers_to_activate_with' => array('email'), |
|
651 | + 'messengers_to_validate_with' => array('email'), |
|
652 | + 'messengers_supporting_default_template_pack_with' => array('email') |
|
653 | + ); |
|
654 | + EE_Register_Message_Type::register('declined_registration', $setup_args); |
|
655 | + |
|
656 | + //register registration cancelled message type |
|
657 | + $setup_args = array( |
|
658 | + 'mtfilename' => 'EE_Cancelled_Registration_message_type.class.php', |
|
659 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'), |
|
660 | + 'messengers_to_activate_with' => array('email'), |
|
661 | + 'messengers_to_validate_with' => array('email'), |
|
662 | + 'messengers_supporting_default_template_pack_with' => array('email') |
|
663 | + ); |
|
664 | + EE_Register_Message_Type::register('cancelled_registration', $setup_args); |
|
665 | + |
|
666 | + |
|
667 | + //register payment failed message type |
|
668 | + $setup_args = array( |
|
669 | + 'mtfilename' => 'EE_Payment_Failed_message_type.class.php', |
|
670 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'), |
|
671 | + 'messengers_to_activate_with' => array('email'), |
|
672 | + 'messengers_to_validate_with' => array('email'), |
|
673 | + 'messengers_supporting_default_template_pack_with' => array('email') |
|
674 | + ); |
|
675 | + EE_Register_Message_Type::register('payment_failed', $setup_args); |
|
676 | + |
|
677 | + //register payment declined message type |
|
678 | + $setup_args = array( |
|
679 | + 'mtfilename' => 'EE_Payment_Cancelled_message_type.class.php', |
|
680 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'), |
|
681 | + 'messengers_to_activate_with' => array('email'), |
|
682 | + 'messengers_to_validate_with' => array('email'), |
|
683 | + 'messengers_supporting_default_template_pack_with' => array('email') |
|
684 | + ); |
|
685 | + EE_Register_Message_Type::register('payment_cancelled', $setup_args); |
|
686 | + } |
|
687 | + |
|
688 | + |
|
689 | + /** |
|
690 | + * Takes care of registering the shortcode libraries implemented with caffeinated EE and set up related items. |
|
691 | + * |
|
692 | + * @since 4.3.2 |
|
693 | + * |
|
694 | + * @return void |
|
695 | + */ |
|
696 | + public function register_caf_shortcodes() |
|
697 | + { |
|
698 | + $setup_args = array( |
|
699 | + 'autoloadpaths' => array( |
|
700 | + EE_CAF_LIBRARIES . 'shortcodes/' |
|
701 | + ), |
|
702 | + 'msgr_validator_callback' => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'), |
|
703 | + 'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'), |
|
704 | + 'list_type_shortcodes' => array('[NEWSLETTER_CONTENT]') |
|
705 | + ); |
|
706 | + EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args); |
|
707 | + } |
|
708 | + |
|
709 | + |
|
710 | + /** |
|
711 | + * Parses a question list shortcode using given data and template |
|
712 | + * |
|
713 | + * @param \EE_Shortcodes $shortcode_parser |
|
714 | + * @param EE_Question[] $questions An array of questions indexed by answer id. |
|
715 | + * @param EE_Answer[] $answers An array of answer objects |
|
716 | + * @param string $template Template content to be parsed. |
|
717 | + * @param array $valid_shortcodes Valid shortcodes for the template being parsed. |
|
718 | + * @param array $extra_data Extra data that might be used when parsing the template. |
|
719 | + */ |
|
720 | + protected function _parse_question_list_for_primary_or_recipient_registration( |
|
721 | + $shortcode_parser, |
|
722 | + $questions, |
|
723 | + $answers, |
|
724 | + $template, |
|
725 | + $valid_shortcodes, |
|
726 | + $extra_data |
|
727 | + ) { |
|
728 | + $question_list = ''; |
|
729 | + /** @var EEH_Parse_Shortcodes $shortcode_helper */ |
|
730 | + $shortcode_helper = $shortcode_parser->get_shortcode_helper(); |
|
731 | + foreach ($answers as $answer) { |
|
732 | + if ($answer instanceof EE_Answer) { |
|
733 | + //first see if the question is in our $questions array. If not then try to get from answer object. |
|
734 | + $question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null; |
|
735 | + $question = ! $question instanceof EE_Question ? $answer->question() : $question; |
|
736 | + if ( |
|
737 | + ! $question instanceof EE_Question |
|
738 | + || ( |
|
739 | + $question instanceof EE_Question |
|
740 | + && $question->admin_only() |
|
741 | + ) |
|
742 | + ) { |
|
743 | + continue; |
|
744 | + } |
|
745 | + $question_list .= $shortcode_helper->parse_question_list_template( |
|
746 | + $template, |
|
747 | + $answer, |
|
748 | + $valid_shortcodes, |
|
749 | + $extra_data |
|
750 | + ); |
|
751 | + } |
|
752 | + } |
|
753 | + |
|
754 | + return $question_list; |
|
755 | + } |
|
756 | 756 | } |
@@ -95,7 +95,7 @@ discard block |
||
95 | 95 | */ |
96 | 96 | public function messages_autoload_paths($dir_ref) |
97 | 97 | { |
98 | - $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/'; |
|
98 | + $dir_ref[] = EE_CAF_LIBRARIES.'shortcodes/'; |
|
99 | 99 | |
100 | 100 | return $dir_ref; |
101 | 101 | } |
@@ -216,10 +216,10 @@ discard block |
||
216 | 216 | } |
217 | 217 | |
218 | 218 | //the template file name we're replacing contents for. |
219 | - $template_file_prefix = $field . '_' . $context; |
|
220 | - $msg_prefix = $messenger->name . '_' . $message_type->name . '_'; |
|
219 | + $template_file_prefix = $field.'_'.$context; |
|
220 | + $msg_prefix = $messenger->name.'_'.$message_type->name.'_'; |
|
221 | 221 | |
222 | - $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/'; |
|
222 | + $base_path = EE_CAF_LIBRARIES.'messages/defaults/default/'; |
|
223 | 223 | |
224 | 224 | if ($messenger->name == 'email' && $message_type->name == 'registration') { |
225 | 225 | |
@@ -228,17 +228,17 @@ discard block |
||
228 | 228 | case 'question_list_admin' : |
229 | 229 | case 'question_list_attendee' : |
230 | 230 | case 'question_list_primary_attendee' : |
231 | - $path = $base_path . $msg_prefix . 'question_list.template.php'; |
|
231 | + $path = $base_path.$msg_prefix.'question_list.template.php'; |
|
232 | 232 | $contents = EEH_Template::display_template($path, array(), true); |
233 | 233 | break; |
234 | 234 | |
235 | 235 | case 'attendee_list_primary_attendee' : |
236 | - $path = $base_path . $msg_prefix . 'attendee_list.template.php'; |
|
236 | + $path = $base_path.$msg_prefix.'attendee_list.template.php'; |
|
237 | 237 | $contents = EEH_Template::display_template($path, array(), true); |
238 | 238 | break; |
239 | 239 | |
240 | 240 | case 'attendee_list_admin' : |
241 | - $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php'; |
|
241 | + $path = $base_path.$msg_prefix.'attendee_list_admin.template.php'; |
|
242 | 242 | $contents = EEH_Template::display_template($path, |
243 | 243 | array(), true); |
244 | 244 | break; |
@@ -248,7 +248,7 @@ discard block |
||
248 | 248 | break; |
249 | 249 | |
250 | 250 | case 'event_list_attendee' : |
251 | - $path = $base_path . $msg_prefix . 'event_list_attendee.template.php'; |
|
251 | + $path = $base_path.$msg_prefix.'event_list_attendee.template.php'; |
|
252 | 252 | $contents = EEH_Template::display_template($path, array(), true); |
253 | 253 | break; |
254 | 254 | } |
@@ -256,24 +256,24 @@ discard block |
||
256 | 256 | switch ($template_file_prefix) { |
257 | 257 | |
258 | 258 | case 'content_attendee' : |
259 | - $path = $base_path . $msg_prefix . 'content.template.php'; |
|
259 | + $path = $base_path.$msg_prefix.'content.template.php'; |
|
260 | 260 | $contents = EEH_Template::display_template($path, array(), true); |
261 | 261 | break; |
262 | 262 | |
263 | 263 | case 'newsletter_content_attendee' : |
264 | - $path = $base_path . $msg_prefix . 'newsletter_content.template.php'; |
|
264 | + $path = $base_path.$msg_prefix.'newsletter_content.template.php'; |
|
265 | 265 | $contents = EEH_Template::display_template($path, array(), true); |
266 | 266 | break; |
267 | 267 | |
268 | 268 | case 'newsletter_subject_attendee' : |
269 | - $path = $base_path . $msg_prefix . 'subject.template.php'; |
|
269 | + $path = $base_path.$msg_prefix.'subject.template.php'; |
|
270 | 270 | $contents = EEH_Template::display_template($path, array(), true); |
271 | 271 | break; |
272 | 272 | } |
273 | 273 | } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') { |
274 | 274 | switch ($template_file_prefix) { |
275 | 275 | case 'attendee_list_purchaser' : |
276 | - $path = $base_path . $msg_prefix . 'attendee_list.template.php'; |
|
276 | + $path = $base_path.$msg_prefix.'attendee_list.template.php'; |
|
277 | 277 | $contents = EEH_Template::display_template($path, array(), true); |
278 | 278 | break; |
279 | 279 | } |
@@ -505,7 +505,7 @@ discard block |
||
505 | 505 | |
506 | 506 | //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee |
507 | 507 | //object on it. |
508 | - if ( ! isset( $extra_data['data'] ) ) { |
|
508 | + if ( ! isset($extra_data['data'])) { |
|
509 | 509 | $extra_data['data'] = $recipient; |
510 | 510 | } |
511 | 511 | |
@@ -569,7 +569,7 @@ discard block |
||
569 | 569 | if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) { |
570 | 570 | return ''; |
571 | 571 | } |
572 | - $registration = $recipient->primary_reg_obj; |
|
572 | + $registration = $recipient->primary_reg_obj; |
|
573 | 573 | $answers = isset($recipient->registrations[$registration->ID()]['ans_objs']) |
574 | 574 | ? $recipient->registrations[$registration->ID()]['ans_objs'] |
575 | 575 | : array(); |
@@ -582,7 +582,7 @@ discard block |
||
582 | 582 | $questions = isset($recipient->questions) ? $recipient->questions : array(); |
583 | 583 | //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee |
584 | 584 | //object on it. |
585 | - if ( ! isset( $extra_data['data'] ) ){ |
|
585 | + if ( ! isset($extra_data['data'])) { |
|
586 | 586 | $extra_data['data'] = $recipient; |
587 | 587 | } |
588 | 588 | return $this->_parse_question_list_for_primary_or_recipient_registration( |
@@ -615,7 +615,7 @@ discard block |
||
615 | 615 | $setup_args = array( |
616 | 616 | 'mtfilename' => 'EE_Newsletter_message_type.class.php', |
617 | 617 | 'autoloadpaths' => array( |
618 | - EE_CAF_LIBRARIES . 'messages/message_type/newsletter/' |
|
618 | + EE_CAF_LIBRARIES.'messages/message_type/newsletter/' |
|
619 | 619 | ), |
620 | 620 | 'messengers_to_activate_with' => array('email'), |
621 | 621 | 'messengers_to_validate_with' => array('email'), |
@@ -626,7 +626,7 @@ discard block |
||
626 | 626 | //register payment reminder message type |
627 | 627 | $setup_args = array( |
628 | 628 | 'mtfilename' => 'EE_Payment_Reminder_message_type.class.php', |
629 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'), |
|
629 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES.'messages/message_type/payment_reminder/'), |
|
630 | 630 | 'messengers_to_activate_with' => array('email'), |
631 | 631 | 'messengers_to_validate_with' => array('email'), |
632 | 632 | 'messengers_supporting_default_template_pack_with' => array('email') |
@@ -636,7 +636,7 @@ discard block |
||
636 | 636 | //register payment declined message type |
637 | 637 | $setup_args = array( |
638 | 638 | 'mtfilename' => 'EE_Payment_Declined_message_type.class.php', |
639 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'), |
|
639 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES.'messages/message_type/payment_declined/'), |
|
640 | 640 | 'messengers_to_activate_with' => array('email'), |
641 | 641 | 'messengers_to_validate_with' => array('email'), |
642 | 642 | 'messengers_supporting_default_template_pack_with' => array('email') |
@@ -646,7 +646,7 @@ discard block |
||
646 | 646 | //register registration declined message type |
647 | 647 | $setup_args = array( |
648 | 648 | 'mtfilename' => 'EE_Declined_Registration_message_type.class.php', |
649 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'), |
|
649 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES.'messages/message_type/declined_registration/'), |
|
650 | 650 | 'messengers_to_activate_with' => array('email'), |
651 | 651 | 'messengers_to_validate_with' => array('email'), |
652 | 652 | 'messengers_supporting_default_template_pack_with' => array('email') |
@@ -656,7 +656,7 @@ discard block |
||
656 | 656 | //register registration cancelled message type |
657 | 657 | $setup_args = array( |
658 | 658 | 'mtfilename' => 'EE_Cancelled_Registration_message_type.class.php', |
659 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'), |
|
659 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES.'messages/message_type/cancelled_registration/'), |
|
660 | 660 | 'messengers_to_activate_with' => array('email'), |
661 | 661 | 'messengers_to_validate_with' => array('email'), |
662 | 662 | 'messengers_supporting_default_template_pack_with' => array('email') |
@@ -667,7 +667,7 @@ discard block |
||
667 | 667 | //register payment failed message type |
668 | 668 | $setup_args = array( |
669 | 669 | 'mtfilename' => 'EE_Payment_Failed_message_type.class.php', |
670 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'), |
|
670 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES.'messages/message_type/payment_failed/'), |
|
671 | 671 | 'messengers_to_activate_with' => array('email'), |
672 | 672 | 'messengers_to_validate_with' => array('email'), |
673 | 673 | 'messengers_supporting_default_template_pack_with' => array('email') |
@@ -677,7 +677,7 @@ discard block |
||
677 | 677 | //register payment declined message type |
678 | 678 | $setup_args = array( |
679 | 679 | 'mtfilename' => 'EE_Payment_Cancelled_message_type.class.php', |
680 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'), |
|
680 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES.'messages/message_type/payment_cancelled/'), |
|
681 | 681 | 'messengers_to_activate_with' => array('email'), |
682 | 682 | 'messengers_to_validate_with' => array('email'), |
683 | 683 | 'messengers_supporting_default_template_pack_with' => array('email') |
@@ -697,7 +697,7 @@ discard block |
||
697 | 697 | { |
698 | 698 | $setup_args = array( |
699 | 699 | 'autoloadpaths' => array( |
700 | - EE_CAF_LIBRARIES . 'shortcodes/' |
|
700 | + EE_CAF_LIBRARIES.'shortcodes/' |
|
701 | 701 | ), |
702 | 702 | 'msgr_validator_callback' => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'), |
703 | 703 | 'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'), |
@@ -1072,7 +1072,7 @@ discard block |
||
1072 | 1072 | * Sets deleted |
1073 | 1073 | * |
1074 | 1074 | * @param boolean $deleted |
1075 | - * @return boolean |
|
1075 | + * @return boolean|null |
|
1076 | 1076 | */ |
1077 | 1077 | public function set_deleted($deleted) |
1078 | 1078 | { |
@@ -1125,6 +1125,7 @@ discard block |
||
1125 | 1125 | * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against |
1126 | 1126 | * @param bool $check_approved This is used to indicate whether the caller wants can_checkin to also |
1127 | 1127 | * consider registration status as well as datetime access. |
1128 | + * @param integer $DTT_OR_ID |
|
1128 | 1129 | * @return bool |
1129 | 1130 | */ |
1130 | 1131 | public function can_checkin($DTT_OR_ID, $check_approved = true) |
@@ -1278,7 +1279,7 @@ discard block |
||
1278 | 1279 | * Returns the latest datetime related to this registration (via the ticket attached to the registration). |
1279 | 1280 | * "Latest" is defined by the `DTT_EVT_start` column. |
1280 | 1281 | * |
1281 | - * @return EE_Datetime|null |
|
1282 | + * @return null|EE_Base_Class |
|
1282 | 1283 | * @throws \EE_Error |
1283 | 1284 | */ |
1284 | 1285 | public function get_latest_related_datetime() |
@@ -1557,7 +1558,7 @@ discard block |
||
1557 | 1558 | * This grabs the payment method corresponding to the last payment made for the amount owing on the registration. |
1558 | 1559 | * Note: if there are no payments on the registration there will be no payment method returned. |
1559 | 1560 | * |
1560 | - * @return EE_Payment_Method|null |
|
1561 | + * @return null|EE_Base_Class |
|
1561 | 1562 | */ |
1562 | 1563 | public function payment_method() |
1563 | 1564 | { |
@@ -1,6 +1,6 @@ discard block |
||
1 | 1 | <?php use EventEspresso\core\exceptions\EntityNotFoundException; |
2 | 2 | |
3 | -if (! defined('EVENT_ESPRESSO_VERSION')) { |
|
3 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
4 | 4 | exit('No direct script access allowed'); |
5 | 5 | } |
6 | 6 | |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | { |
107 | 107 | switch ($field_name) { |
108 | 108 | case 'REG_code' : |
109 | - if (! empty($field_value) && $this->reg_code() === null) { |
|
109 | + if ( ! empty($field_value) && $this->reg_code() === null) { |
|
110 | 110 | $this->set_reg_code($field_value, $use_default); |
111 | 111 | } |
112 | 112 | break; |
@@ -281,7 +281,7 @@ discard block |
||
281 | 281 | public function event() |
282 | 282 | { |
283 | 283 | $event = $this->get_first_related('Event'); |
284 | - if (! $event instanceof \EE_Event) { |
|
284 | + if ( ! $event instanceof \EE_Event) { |
|
285 | 285 | throw new EntityNotFoundException('Event ID', $this->event_ID()); |
286 | 286 | } |
287 | 287 | return $event; |
@@ -673,7 +673,7 @@ discard block |
||
673 | 673 | */ |
674 | 674 | public function reg_url_link() |
675 | 675 | { |
676 | - return (string)$this->get('REG_url_link'); |
|
676 | + return (string) $this->get('REG_url_link'); |
|
677 | 677 | } |
678 | 678 | |
679 | 679 | |
@@ -934,7 +934,7 @@ discard block |
||
934 | 934 | $icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : ''; |
935 | 935 | break; |
936 | 936 | } |
937 | - return $icon . $status[$this->status_ID()]; |
|
937 | + return $icon.$status[$this->status_ID()]; |
|
938 | 938 | } |
939 | 939 | |
940 | 940 | |
@@ -1136,7 +1136,7 @@ discard block |
||
1136 | 1136 | return false; |
1137 | 1137 | } |
1138 | 1138 | //is there a datetime ticket that matches this dtt_ID? |
1139 | - if (! (EEM_Datetime_Ticket::instance()->exists(array( |
|
1139 | + if ( ! (EEM_Datetime_Ticket::instance()->exists(array( |
|
1140 | 1140 | array( |
1141 | 1141 | 'TKT_ID' => $this->get('TKT_ID'), |
1142 | 1142 | 'DTT_ID' => $DTT_ID, |
@@ -1164,7 +1164,7 @@ discard block |
||
1164 | 1164 | { |
1165 | 1165 | $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID); |
1166 | 1166 | |
1167 | - if (! $DTT_ID) { |
|
1167 | + if ( ! $DTT_ID) { |
|
1168 | 1168 | return false; |
1169 | 1169 | } |
1170 | 1170 | |
@@ -1172,7 +1172,7 @@ discard block |
||
1172 | 1172 | |
1173 | 1173 | // if max uses is not set or equals infinity then return true cause its not a factor for whether user can check-in |
1174 | 1174 | // or not. |
1175 | - if (! $max_uses || $max_uses === EE_INF) { |
|
1175 | + if ( ! $max_uses || $max_uses === EE_INF) { |
|
1176 | 1176 | return true; |
1177 | 1177 | } |
1178 | 1178 | |
@@ -1221,7 +1221,7 @@ discard block |
||
1221 | 1221 | $datetime = $this->get_latest_related_datetime(); |
1222 | 1222 | $DTT_ID = $datetime instanceof EE_Datetime ? $datetime->ID() : 0; |
1223 | 1223 | // verify the registration can checkin for the given DTT_ID |
1224 | - } elseif (! $this->can_checkin($DTT_ID, $verify)) { |
|
1224 | + } elseif ( ! $this->can_checkin($DTT_ID, $verify)) { |
|
1225 | 1225 | EE_Error::add_error( |
1226 | 1226 | sprintf( |
1227 | 1227 | __('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', |
@@ -1393,7 +1393,7 @@ discard block |
||
1393 | 1393 | public function transaction() |
1394 | 1394 | { |
1395 | 1395 | $transaction = $this->get_first_related('Transaction'); |
1396 | - if (! $transaction instanceof \EE_Transaction) { |
|
1396 | + if ( ! $transaction instanceof \EE_Transaction) { |
|
1397 | 1397 | throw new EntityNotFoundException('Transaction ID', $this->transaction_ID()); |
1398 | 1398 | } |
1399 | 1399 | return $transaction; |
@@ -1440,11 +1440,11 @@ discard block |
||
1440 | 1440 | EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
1441 | 1441 | return; |
1442 | 1442 | } |
1443 | - if (! $this->reg_code()) { |
|
1443 | + if ( ! $this->reg_code()) { |
|
1444 | 1444 | parent::set('REG_code', $REG_code, $use_default); |
1445 | 1445 | } else { |
1446 | 1446 | EE_Error::doing_it_wrong( |
1447 | - __CLASS__ . '::' . __FUNCTION__, |
|
1447 | + __CLASS__.'::'.__FUNCTION__, |
|
1448 | 1448 | __('Can not change a registration REG_code once it has been set.', 'event_espresso'), |
1449 | 1449 | '4.6.0' |
1450 | 1450 | ); |
@@ -1590,7 +1590,7 @@ discard block |
||
1590 | 1590 | break; |
1591 | 1591 | } |
1592 | 1592 | } |
1593 | - if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) { |
|
1593 | + if ( ! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) { |
|
1594 | 1594 | throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID()); |
1595 | 1595 | } |
1596 | 1596 | return $line_item; |
@@ -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 | } |
@@ -14,248 +14,248 @@ |
||
14 | 14 | abstract class EE_Form_Section_Layout_Base |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * Form form section to lay out |
|
19 | - * |
|
20 | - * @var EE_Form_Section_Proper |
|
21 | - */ |
|
22 | - protected $_form_section; |
|
23 | - |
|
24 | - |
|
25 | - |
|
26 | - /** |
|
27 | - * __construct |
|
28 | - */ |
|
29 | - function __construct() |
|
30 | - { |
|
31 | - } |
|
32 | - |
|
33 | - |
|
34 | - |
|
35 | - /** |
|
36 | - * The form section on which this strategy is to perform |
|
37 | - * |
|
38 | - * @param EE_Form_Section_Proper $form |
|
39 | - */ |
|
40 | - public function _construct_finalize(EE_Form_Section_Proper $form) |
|
41 | - { |
|
42 | - $this->_form_section = $form; |
|
43 | - } |
|
44 | - |
|
45 | - |
|
46 | - |
|
47 | - /** |
|
48 | - * @return \EE_Form_Section_Proper |
|
49 | - */ |
|
50 | - public function form_section() |
|
51 | - { |
|
52 | - return $this->_form_section; |
|
53 | - } |
|
54 | - |
|
55 | - |
|
56 | - |
|
57 | - /** |
|
58 | - * Also has teh side effect of enqueuing any needed JS and CSS for |
|
59 | - * this form. |
|
60 | - * Creates all the HTML necessary for displaying this form, its inputs, and |
|
61 | - * proper subsections. |
|
62 | - * Returns the HTML |
|
63 | - * |
|
64 | - * @return string HTML for displaying |
|
65 | - */ |
|
66 | - public function layout_form() |
|
67 | - { |
|
68 | - $html = ''; |
|
69 | - // layout_form_begin |
|
70 | - $html .= apply_filters( |
|
71 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(), |
|
72 | - $this->layout_form_begin(), |
|
73 | - $this->_form_section |
|
74 | - ); |
|
75 | - // layout_form_loop |
|
76 | - $html .= apply_filters( |
|
77 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(), |
|
78 | - $this->layout_form_loop(), |
|
79 | - $this->_form_section |
|
80 | - ); |
|
81 | - // layout_form_end |
|
82 | - $html .= apply_filters( |
|
83 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(), |
|
84 | - $this->layout_form_end(), |
|
85 | - $this->_form_section |
|
86 | - ); |
|
87 | - $html = $this->add_form_section_hooks_and_filters($html); |
|
88 | - return $html; |
|
89 | - } |
|
90 | - |
|
91 | - |
|
92 | - |
|
93 | - /** |
|
94 | - * @return string |
|
95 | - */ |
|
96 | - public function layout_form_loop() |
|
97 | - { |
|
98 | - $html = ''; |
|
99 | - foreach ($this->_form_section->subsections() as $name => $subsection) { |
|
100 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
101 | - $html .= apply_filters( |
|
102 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_' . $name . '__in_' . $this->_form_section->name(), |
|
103 | - $this->layout_input($subsection), |
|
104 | - $this->_form_section, |
|
105 | - $subsection |
|
106 | - ); |
|
107 | - } elseif ($subsection instanceof EE_Form_Section_Base) { |
|
108 | - $html .= apply_filters( |
|
109 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_' . $name . '__in_' . $this->_form_section->name(), |
|
110 | - $this->layout_subsection($subsection), |
|
111 | - $this->_form_section, |
|
112 | - $subsection |
|
113 | - ); |
|
114 | - } |
|
115 | - } |
|
116 | - return $html; |
|
117 | - } |
|
118 | - |
|
119 | - |
|
120 | - |
|
121 | - /** |
|
122 | - * Should be used to start teh form section (Eg a table tag, or a div tag, etc.) |
|
123 | - * |
|
124 | - * @return string |
|
125 | - */ |
|
126 | - abstract public function layout_form_begin(); |
|
127 | - |
|
128 | - |
|
129 | - |
|
130 | - /** |
|
131 | - * Should be used to end the form section (eg a /table tag, or a /div tag, etc) |
|
132 | - * |
|
133 | - * @return string |
|
134 | - */ |
|
135 | - abstract public function layout_form_end(); |
|
136 | - |
|
137 | - |
|
138 | - |
|
139 | - /** |
|
140 | - * Should be used internally by layout_form() to layout each input (eg, if this layout |
|
141 | - * is putting each input in a row of its own, this should probably be called by a |
|
142 | - * foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop. |
|
143 | - * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely |
|
144 | - * customize the form's layout, but would like to make use of it for laying out |
|
145 | - * 'easy-to-layout' inputs |
|
146 | - * |
|
147 | - * @param EE_Form_Input_Base $input |
|
148 | - * @return string html |
|
149 | - */ |
|
150 | - abstract public function layout_input($input); |
|
151 | - |
|
152 | - |
|
153 | - |
|
154 | - /** |
|
155 | - * Similar to layout_input(), should be used internally by layout_form() within a |
|
156 | - * loop to layout each proper subsection. Unlike layout_input(), however, it is assumed |
|
157 | - * that the proper subsection will layout its container, label, etc on its own. |
|
158 | - * |
|
159 | - * @param EE_Form_Section_Base $subsection |
|
160 | - * @return string html |
|
161 | - */ |
|
162 | - abstract public function layout_subsection($subsection); |
|
163 | - |
|
164 | - |
|
165 | - |
|
166 | - /** |
|
167 | - * Gets the HTML for the label tag and its contents for the input |
|
168 | - * |
|
169 | - * @param EE_Form_Input_Base $input |
|
170 | - * @return string |
|
171 | - */ |
|
172 | - public function display_label($input) |
|
173 | - { |
|
174 | - $class = $input->required() ? 'ee-required-label ' . $input->html_label_class() : $input->html_label_class(); |
|
175 | - $label_text = $input->required() |
|
176 | - ? $input->html_label_text() . '<span class="ee-asterisk">*</span>' |
|
177 | - : $input->html_label_text(); |
|
178 | - return '<label id="' |
|
179 | - . $input->html_label_id() |
|
180 | - . '" class="' |
|
181 | - . $class |
|
182 | - . '" style="' |
|
183 | - . $input->html_label_style() |
|
184 | - . '" for="' . $input->html_name() |
|
185 | - . '">' |
|
186 | - . $label_text |
|
187 | - . '</label>'; |
|
188 | - } |
|
189 | - |
|
190 | - |
|
191 | - |
|
192 | - /** |
|
193 | - * returns the HTML for the server-side validation errors for the specified input |
|
194 | - * Note that if JS is enabled, it should remove these and instead |
|
195 | - * populate the form's errors in the jquery validate fashion |
|
196 | - * using the localized data provided to the JS |
|
197 | - * |
|
198 | - * @param EE_Form_Input_Base $input |
|
199 | - * @return string |
|
200 | - */ |
|
201 | - public function display_errors($input) |
|
202 | - { |
|
203 | - if ($input->get_validation_errors()) { |
|
204 | - return "<label id='" |
|
205 | - . $input->html_id() |
|
206 | - . "-error' class='error' for='{$input->html_name()}'>" |
|
207 | - . $input->get_validation_error_string() |
|
208 | - . "</label>"; |
|
209 | - } else { |
|
210 | - return ''; |
|
211 | - } |
|
212 | - } |
|
213 | - |
|
214 | - |
|
215 | - |
|
216 | - /** |
|
217 | - * Displays the help span for the specified input |
|
218 | - * |
|
219 | - * @param EE_Form_Input_Base $input |
|
220 | - * @return string |
|
221 | - */ |
|
222 | - public function display_help_text($input) |
|
223 | - { |
|
224 | - if ($input->html_help_text() != '') { |
|
225 | - $tag = is_admin() ? 'p' : 'span'; |
|
226 | - return '<' |
|
227 | - . $tag |
|
228 | - . ' id="' |
|
229 | - . $input->html_id() |
|
230 | - . '-help" class="' |
|
231 | - . $input->html_help_class() |
|
232 | - . '" style="' |
|
233 | - . $input->html_help_style() |
|
234 | - . '">' |
|
235 | - . $input->html_help_text() |
|
236 | - . '</' |
|
237 | - . $tag |
|
238 | - . '>'; |
|
239 | - } |
|
240 | - return ''; |
|
241 | - } |
|
242 | - |
|
243 | - |
|
244 | - |
|
245 | - /** |
|
246 | - * Does an action and hook onto the end of teh form |
|
247 | - * |
|
248 | - * @param string $html |
|
249 | - * @return string |
|
250 | - */ |
|
251 | - public function add_form_section_hooks_and_filters($html) |
|
252 | - { |
|
253 | - // replace dashes and spaces with underscores |
|
254 | - $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id()); |
|
255 | - do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section); |
|
256 | - $html = apply_filters('AFEE__Form_Section_Layout__' . $hook_name . '__html', $html, $this->_form_section); |
|
257 | - $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->'; |
|
258 | - $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->'; |
|
259 | - return $html; |
|
260 | - } |
|
17 | + /** |
|
18 | + * Form form section to lay out |
|
19 | + * |
|
20 | + * @var EE_Form_Section_Proper |
|
21 | + */ |
|
22 | + protected $_form_section; |
|
23 | + |
|
24 | + |
|
25 | + |
|
26 | + /** |
|
27 | + * __construct |
|
28 | + */ |
|
29 | + function __construct() |
|
30 | + { |
|
31 | + } |
|
32 | + |
|
33 | + |
|
34 | + |
|
35 | + /** |
|
36 | + * The form section on which this strategy is to perform |
|
37 | + * |
|
38 | + * @param EE_Form_Section_Proper $form |
|
39 | + */ |
|
40 | + public function _construct_finalize(EE_Form_Section_Proper $form) |
|
41 | + { |
|
42 | + $this->_form_section = $form; |
|
43 | + } |
|
44 | + |
|
45 | + |
|
46 | + |
|
47 | + /** |
|
48 | + * @return \EE_Form_Section_Proper |
|
49 | + */ |
|
50 | + public function form_section() |
|
51 | + { |
|
52 | + return $this->_form_section; |
|
53 | + } |
|
54 | + |
|
55 | + |
|
56 | + |
|
57 | + /** |
|
58 | + * Also has teh side effect of enqueuing any needed JS and CSS for |
|
59 | + * this form. |
|
60 | + * Creates all the HTML necessary for displaying this form, its inputs, and |
|
61 | + * proper subsections. |
|
62 | + * Returns the HTML |
|
63 | + * |
|
64 | + * @return string HTML for displaying |
|
65 | + */ |
|
66 | + public function layout_form() |
|
67 | + { |
|
68 | + $html = ''; |
|
69 | + // layout_form_begin |
|
70 | + $html .= apply_filters( |
|
71 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(), |
|
72 | + $this->layout_form_begin(), |
|
73 | + $this->_form_section |
|
74 | + ); |
|
75 | + // layout_form_loop |
|
76 | + $html .= apply_filters( |
|
77 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(), |
|
78 | + $this->layout_form_loop(), |
|
79 | + $this->_form_section |
|
80 | + ); |
|
81 | + // layout_form_end |
|
82 | + $html .= apply_filters( |
|
83 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(), |
|
84 | + $this->layout_form_end(), |
|
85 | + $this->_form_section |
|
86 | + ); |
|
87 | + $html = $this->add_form_section_hooks_and_filters($html); |
|
88 | + return $html; |
|
89 | + } |
|
90 | + |
|
91 | + |
|
92 | + |
|
93 | + /** |
|
94 | + * @return string |
|
95 | + */ |
|
96 | + public function layout_form_loop() |
|
97 | + { |
|
98 | + $html = ''; |
|
99 | + foreach ($this->_form_section->subsections() as $name => $subsection) { |
|
100 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
101 | + $html .= apply_filters( |
|
102 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_' . $name . '__in_' . $this->_form_section->name(), |
|
103 | + $this->layout_input($subsection), |
|
104 | + $this->_form_section, |
|
105 | + $subsection |
|
106 | + ); |
|
107 | + } elseif ($subsection instanceof EE_Form_Section_Base) { |
|
108 | + $html .= apply_filters( |
|
109 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_' . $name . '__in_' . $this->_form_section->name(), |
|
110 | + $this->layout_subsection($subsection), |
|
111 | + $this->_form_section, |
|
112 | + $subsection |
|
113 | + ); |
|
114 | + } |
|
115 | + } |
|
116 | + return $html; |
|
117 | + } |
|
118 | + |
|
119 | + |
|
120 | + |
|
121 | + /** |
|
122 | + * Should be used to start teh form section (Eg a table tag, or a div tag, etc.) |
|
123 | + * |
|
124 | + * @return string |
|
125 | + */ |
|
126 | + abstract public function layout_form_begin(); |
|
127 | + |
|
128 | + |
|
129 | + |
|
130 | + /** |
|
131 | + * Should be used to end the form section (eg a /table tag, or a /div tag, etc) |
|
132 | + * |
|
133 | + * @return string |
|
134 | + */ |
|
135 | + abstract public function layout_form_end(); |
|
136 | + |
|
137 | + |
|
138 | + |
|
139 | + /** |
|
140 | + * Should be used internally by layout_form() to layout each input (eg, if this layout |
|
141 | + * is putting each input in a row of its own, this should probably be called by a |
|
142 | + * foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop. |
|
143 | + * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely |
|
144 | + * customize the form's layout, but would like to make use of it for laying out |
|
145 | + * 'easy-to-layout' inputs |
|
146 | + * |
|
147 | + * @param EE_Form_Input_Base $input |
|
148 | + * @return string html |
|
149 | + */ |
|
150 | + abstract public function layout_input($input); |
|
151 | + |
|
152 | + |
|
153 | + |
|
154 | + /** |
|
155 | + * Similar to layout_input(), should be used internally by layout_form() within a |
|
156 | + * loop to layout each proper subsection. Unlike layout_input(), however, it is assumed |
|
157 | + * that the proper subsection will layout its container, label, etc on its own. |
|
158 | + * |
|
159 | + * @param EE_Form_Section_Base $subsection |
|
160 | + * @return string html |
|
161 | + */ |
|
162 | + abstract public function layout_subsection($subsection); |
|
163 | + |
|
164 | + |
|
165 | + |
|
166 | + /** |
|
167 | + * Gets the HTML for the label tag and its contents for the input |
|
168 | + * |
|
169 | + * @param EE_Form_Input_Base $input |
|
170 | + * @return string |
|
171 | + */ |
|
172 | + public function display_label($input) |
|
173 | + { |
|
174 | + $class = $input->required() ? 'ee-required-label ' . $input->html_label_class() : $input->html_label_class(); |
|
175 | + $label_text = $input->required() |
|
176 | + ? $input->html_label_text() . '<span class="ee-asterisk">*</span>' |
|
177 | + : $input->html_label_text(); |
|
178 | + return '<label id="' |
|
179 | + . $input->html_label_id() |
|
180 | + . '" class="' |
|
181 | + . $class |
|
182 | + . '" style="' |
|
183 | + . $input->html_label_style() |
|
184 | + . '" for="' . $input->html_name() |
|
185 | + . '">' |
|
186 | + . $label_text |
|
187 | + . '</label>'; |
|
188 | + } |
|
189 | + |
|
190 | + |
|
191 | + |
|
192 | + /** |
|
193 | + * returns the HTML for the server-side validation errors for the specified input |
|
194 | + * Note that if JS is enabled, it should remove these and instead |
|
195 | + * populate the form's errors in the jquery validate fashion |
|
196 | + * using the localized data provided to the JS |
|
197 | + * |
|
198 | + * @param EE_Form_Input_Base $input |
|
199 | + * @return string |
|
200 | + */ |
|
201 | + public function display_errors($input) |
|
202 | + { |
|
203 | + if ($input->get_validation_errors()) { |
|
204 | + return "<label id='" |
|
205 | + . $input->html_id() |
|
206 | + . "-error' class='error' for='{$input->html_name()}'>" |
|
207 | + . $input->get_validation_error_string() |
|
208 | + . "</label>"; |
|
209 | + } else { |
|
210 | + return ''; |
|
211 | + } |
|
212 | + } |
|
213 | + |
|
214 | + |
|
215 | + |
|
216 | + /** |
|
217 | + * Displays the help span for the specified input |
|
218 | + * |
|
219 | + * @param EE_Form_Input_Base $input |
|
220 | + * @return string |
|
221 | + */ |
|
222 | + public function display_help_text($input) |
|
223 | + { |
|
224 | + if ($input->html_help_text() != '') { |
|
225 | + $tag = is_admin() ? 'p' : 'span'; |
|
226 | + return '<' |
|
227 | + . $tag |
|
228 | + . ' id="' |
|
229 | + . $input->html_id() |
|
230 | + . '-help" class="' |
|
231 | + . $input->html_help_class() |
|
232 | + . '" style="' |
|
233 | + . $input->html_help_style() |
|
234 | + . '">' |
|
235 | + . $input->html_help_text() |
|
236 | + . '</' |
|
237 | + . $tag |
|
238 | + . '>'; |
|
239 | + } |
|
240 | + return ''; |
|
241 | + } |
|
242 | + |
|
243 | + |
|
244 | + |
|
245 | + /** |
|
246 | + * Does an action and hook onto the end of teh form |
|
247 | + * |
|
248 | + * @param string $html |
|
249 | + * @return string |
|
250 | + */ |
|
251 | + public function add_form_section_hooks_and_filters($html) |
|
252 | + { |
|
253 | + // replace dashes and spaces with underscores |
|
254 | + $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id()); |
|
255 | + do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section); |
|
256 | + $html = apply_filters('AFEE__Form_Section_Layout__' . $hook_name . '__html', $html, $this->_form_section); |
|
257 | + $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->'; |
|
258 | + $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->'; |
|
259 | + return $html; |
|
260 | + } |
|
261 | 261 | } |
@@ -68,19 +68,19 @@ discard block |
||
68 | 68 | $html = ''; |
69 | 69 | // layout_form_begin |
70 | 70 | $html .= apply_filters( |
71 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(), |
|
71 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_'.$this->_form_section->name(), |
|
72 | 72 | $this->layout_form_begin(), |
73 | 73 | $this->_form_section |
74 | 74 | ); |
75 | 75 | // layout_form_loop |
76 | 76 | $html .= apply_filters( |
77 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(), |
|
77 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_'.$this->_form_section->name(), |
|
78 | 78 | $this->layout_form_loop(), |
79 | 79 | $this->_form_section |
80 | 80 | ); |
81 | 81 | // layout_form_end |
82 | 82 | $html .= apply_filters( |
83 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(), |
|
83 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_'.$this->_form_section->name(), |
|
84 | 84 | $this->layout_form_end(), |
85 | 85 | $this->_form_section |
86 | 86 | ); |
@@ -99,14 +99,14 @@ discard block |
||
99 | 99 | foreach ($this->_form_section->subsections() as $name => $subsection) { |
100 | 100 | if ($subsection instanceof EE_Form_Input_Base) { |
101 | 101 | $html .= apply_filters( |
102 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_' . $name . '__in_' . $this->_form_section->name(), |
|
102 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_'.$name.'__in_'.$this->_form_section->name(), |
|
103 | 103 | $this->layout_input($subsection), |
104 | 104 | $this->_form_section, |
105 | 105 | $subsection |
106 | 106 | ); |
107 | 107 | } elseif ($subsection instanceof EE_Form_Section_Base) { |
108 | 108 | $html .= apply_filters( |
109 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_' . $name . '__in_' . $this->_form_section->name(), |
|
109 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_'.$name.'__in_'.$this->_form_section->name(), |
|
110 | 110 | $this->layout_subsection($subsection), |
111 | 111 | $this->_form_section, |
112 | 112 | $subsection |
@@ -171,9 +171,9 @@ discard block |
||
171 | 171 | */ |
172 | 172 | public function display_label($input) |
173 | 173 | { |
174 | - $class = $input->required() ? 'ee-required-label ' . $input->html_label_class() : $input->html_label_class(); |
|
174 | + $class = $input->required() ? 'ee-required-label '.$input->html_label_class() : $input->html_label_class(); |
|
175 | 175 | $label_text = $input->required() |
176 | - ? $input->html_label_text() . '<span class="ee-asterisk">*</span>' |
|
176 | + ? $input->html_label_text().'<span class="ee-asterisk">*</span>' |
|
177 | 177 | : $input->html_label_text(); |
178 | 178 | return '<label id="' |
179 | 179 | . $input->html_label_id() |
@@ -181,7 +181,7 @@ discard block |
||
181 | 181 | . $class |
182 | 182 | . '" style="' |
183 | 183 | . $input->html_label_style() |
184 | - . '" for="' . $input->html_name() |
|
184 | + . '" for="'.$input->html_name() |
|
185 | 185 | . '">' |
186 | 186 | . $label_text |
187 | 187 | . '</label>'; |
@@ -252,10 +252,10 @@ discard block |
||
252 | 252 | { |
253 | 253 | // replace dashes and spaces with underscores |
254 | 254 | $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id()); |
255 | - do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section); |
|
256 | - $html = apply_filters('AFEE__Form_Section_Layout__' . $hook_name . '__html', $html, $this->_form_section); |
|
257 | - $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->'; |
|
258 | - $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->'; |
|
255 | + do_action('AHEE__Form_Section_Layout__'.$hook_name, $this->_form_section); |
|
256 | + $html = apply_filters('AFEE__Form_Section_Layout__'.$hook_name.'__html', $html, $this->_form_section); |
|
257 | + $html .= EEH_HTML::nl().'<!-- AHEE__Form_Section_Layout__'.$hook_name.'__html -->'; |
|
258 | + $html .= EEH_HTML::nl().'<!-- AFEE__Form_Section_Layout__'.$hook_name.' -->'; |
|
259 | 259 | return $html; |
260 | 260 | } |
261 | 261 | } |
@@ -9,69 +9,69 @@ |
||
9 | 9 | class EE_Admin_Two_Column_Layout extends EE_Two_Column_Layout |
10 | 10 | { |
11 | 11 | |
12 | - /** |
|
13 | - * Overriding the parent table layout to include <tbody> tags |
|
14 | - * |
|
15 | - * @param array $additional_args |
|
16 | - * @return string |
|
17 | - */ |
|
18 | - public function layout_form_begin($additional_args = array()) |
|
19 | - { |
|
20 | - $this->_form_section->set_html_class('form-table'); |
|
21 | - return parent::layout_form_begin($additional_args); |
|
22 | - } |
|
12 | + /** |
|
13 | + * Overriding the parent table layout to include <tbody> tags |
|
14 | + * |
|
15 | + * @param array $additional_args |
|
16 | + * @return string |
|
17 | + */ |
|
18 | + public function layout_form_begin($additional_args = array()) |
|
19 | + { |
|
20 | + $this->_form_section->set_html_class('form-table'); |
|
21 | + return parent::layout_form_begin($additional_args); |
|
22 | + } |
|
23 | 23 | |
24 | 24 | |
25 | 25 | |
26 | - /** |
|
27 | - * Lays out a row for the subsection |
|
28 | - * |
|
29 | - * @param EE_Form_Section_Proper $form_section |
|
30 | - * @return string |
|
31 | - */ |
|
32 | - public function layout_subsection($form_section) |
|
33 | - { |
|
34 | - if ($form_section instanceof EE_Form_Section_Proper) { |
|
35 | - return EEH_HTML::no_row($form_section->get_html(), 2); |
|
36 | - } elseif ($form_section instanceof EE_Form_Section_HTML) { |
|
37 | - return EEH_HTML::no_row($form_section->get_html(), 2); |
|
38 | - } |
|
39 | - return ''; |
|
40 | - } |
|
26 | + /** |
|
27 | + * Lays out a row for the subsection |
|
28 | + * |
|
29 | + * @param EE_Form_Section_Proper $form_section |
|
30 | + * @return string |
|
31 | + */ |
|
32 | + public function layout_subsection($form_section) |
|
33 | + { |
|
34 | + if ($form_section instanceof EE_Form_Section_Proper) { |
|
35 | + return EEH_HTML::no_row($form_section->get_html(), 2); |
|
36 | + } elseif ($form_section instanceof EE_Form_Section_HTML) { |
|
37 | + return EEH_HTML::no_row($form_section->get_html(), 2); |
|
38 | + } |
|
39 | + return ''; |
|
40 | + } |
|
41 | 41 | |
42 | 42 | |
43 | 43 | |
44 | - /** |
|
45 | - * Lays out the row for the input, including label and errors |
|
46 | - * |
|
47 | - * @param EE_Form_Input_Base $input |
|
48 | - * @return string |
|
49 | - */ |
|
50 | - public function layout_input($input) |
|
51 | - { |
|
52 | - if ($input->get_display_strategy() instanceof EE_Text_Area_Display_Strategy |
|
53 | - || $input->get_display_strategy() instanceof EE_Text_Input_Display_Strategy |
|
54 | - || $input->get_display_strategy() instanceof EE_Admin_File_Uploader_Display_Strategy |
|
55 | - ) { |
|
56 | - $input->set_html_class($input->html_class() . ' large-text'); |
|
57 | - } |
|
58 | - if ($input instanceof EE_Text_Area_Input) { |
|
59 | - $input->set_rows(4); |
|
60 | - $input->set_cols(60); |
|
61 | - } |
|
62 | - $input_html = $input->get_html_for_input(); |
|
63 | - // maybe add errors and help text ? |
|
64 | - $input_html .= $input->get_html_for_errors() != '' ? EEH_HTML::nl() . $input->get_html_for_errors() : ''; |
|
65 | - $input_html .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : ''; |
|
66 | - //overriding parent to add wp admin specific things. |
|
67 | - $html = ''; |
|
68 | - if ($input instanceof EE_Hidden_Input) { |
|
69 | - $html .= EEH_HTML::no_row($input->get_html_for_input(), 2); |
|
70 | - } else { |
|
71 | - $html .= EEH_HTML::tr( |
|
72 | - EEH_HTML::th($input->get_html_for_label(), '', '', '', 'scope="row"') . EEH_HTML::td($input_html) |
|
73 | - ); |
|
74 | - } |
|
75 | - return $html; |
|
76 | - } |
|
44 | + /** |
|
45 | + * Lays out the row for the input, including label and errors |
|
46 | + * |
|
47 | + * @param EE_Form_Input_Base $input |
|
48 | + * @return string |
|
49 | + */ |
|
50 | + public function layout_input($input) |
|
51 | + { |
|
52 | + if ($input->get_display_strategy() instanceof EE_Text_Area_Display_Strategy |
|
53 | + || $input->get_display_strategy() instanceof EE_Text_Input_Display_Strategy |
|
54 | + || $input->get_display_strategy() instanceof EE_Admin_File_Uploader_Display_Strategy |
|
55 | + ) { |
|
56 | + $input->set_html_class($input->html_class() . ' large-text'); |
|
57 | + } |
|
58 | + if ($input instanceof EE_Text_Area_Input) { |
|
59 | + $input->set_rows(4); |
|
60 | + $input->set_cols(60); |
|
61 | + } |
|
62 | + $input_html = $input->get_html_for_input(); |
|
63 | + // maybe add errors and help text ? |
|
64 | + $input_html .= $input->get_html_for_errors() != '' ? EEH_HTML::nl() . $input->get_html_for_errors() : ''; |
|
65 | + $input_html .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : ''; |
|
66 | + //overriding parent to add wp admin specific things. |
|
67 | + $html = ''; |
|
68 | + if ($input instanceof EE_Hidden_Input) { |
|
69 | + $html .= EEH_HTML::no_row($input->get_html_for_input(), 2); |
|
70 | + } else { |
|
71 | + $html .= EEH_HTML::tr( |
|
72 | + EEH_HTML::th($input->get_html_for_label(), '', '', '', 'scope="row"') . EEH_HTML::td($input_html) |
|
73 | + ); |
|
74 | + } |
|
75 | + return $html; |
|
76 | + } |
|
77 | 77 | } |
@@ -53,7 +53,7 @@ discard block |
||
53 | 53 | || $input->get_display_strategy() instanceof EE_Text_Input_Display_Strategy |
54 | 54 | || $input->get_display_strategy() instanceof EE_Admin_File_Uploader_Display_Strategy |
55 | 55 | ) { |
56 | - $input->set_html_class($input->html_class() . ' large-text'); |
|
56 | + $input->set_html_class($input->html_class().' large-text'); |
|
57 | 57 | } |
58 | 58 | if ($input instanceof EE_Text_Area_Input) { |
59 | 59 | $input->set_rows(4); |
@@ -61,15 +61,15 @@ discard block |
||
61 | 61 | } |
62 | 62 | $input_html = $input->get_html_for_input(); |
63 | 63 | // maybe add errors and help text ? |
64 | - $input_html .= $input->get_html_for_errors() != '' ? EEH_HTML::nl() . $input->get_html_for_errors() : ''; |
|
65 | - $input_html .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : ''; |
|
64 | + $input_html .= $input->get_html_for_errors() != '' ? EEH_HTML::nl().$input->get_html_for_errors() : ''; |
|
65 | + $input_html .= $input->get_html_for_help() != '' ? EEH_HTML::nl().$input->get_html_for_help() : ''; |
|
66 | 66 | //overriding parent to add wp admin specific things. |
67 | 67 | $html = ''; |
68 | 68 | if ($input instanceof EE_Hidden_Input) { |
69 | 69 | $html .= EEH_HTML::no_row($input->get_html_for_input(), 2); |
70 | 70 | } else { |
71 | 71 | $html .= EEH_HTML::tr( |
72 | - EEH_HTML::th($input->get_html_for_label(), '', '', '', 'scope="row"') . EEH_HTML::td($input_html) |
|
72 | + EEH_HTML::th($input->get_html_for_label(), '', '', '', 'scope="row"').EEH_HTML::td($input_html) |
|
73 | 73 | ); |
74 | 74 | } |
75 | 75 | return $html; |
@@ -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 | |
@@ -16,109 +16,109 @@ discard block |
||
16 | 16 | class EE_Fieldset_Section_Layout extends EE_Div_Per_Section_Layout |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * legend_class |
|
21 | - * |
|
22 | - * @var string |
|
23 | - */ |
|
24 | - protected $_legend_class; |
|
25 | - |
|
26 | - /** |
|
27 | - * legend_text |
|
28 | - * |
|
29 | - * @var string |
|
30 | - */ |
|
31 | - protected $_legend_text; |
|
32 | - |
|
33 | - |
|
34 | - |
|
35 | - /** |
|
36 | - * construct |
|
37 | - * |
|
38 | - * @param array $options |
|
39 | - */ |
|
40 | - public function __construct($options = array()) |
|
41 | - { |
|
42 | - foreach ($options as $key => $value) { |
|
43 | - $key = '_' . $key; |
|
44 | - if (property_exists($this, $key)) { |
|
45 | - $this->{$key} = $value; |
|
46 | - } |
|
47 | - } |
|
48 | - } |
|
49 | - |
|
50 | - |
|
51 | - |
|
52 | - /** |
|
53 | - * opening div tag for a form |
|
54 | - * |
|
55 | - * @return string |
|
56 | - */ |
|
57 | - public function layout_form_begin() |
|
58 | - { |
|
59 | - $html = EEH_HTML::nl(1) |
|
60 | - . '<fieldset id="' |
|
61 | - . $this->_form_section->html_id() |
|
62 | - . '" class="' |
|
63 | - . $this->_form_section->html_class() |
|
64 | - . '" style="' |
|
65 | - . $this->_form_section->html_style() |
|
66 | - . '">'; |
|
67 | - $html .= '<legend class="' . $this->legend_class() . '">' . $this->legend_text() . '</legend>'; |
|
68 | - return $html; |
|
69 | - } |
|
70 | - |
|
71 | - |
|
72 | - |
|
73 | - /** |
|
74 | - * closing div tag for a form |
|
75 | - * |
|
76 | - * @return string |
|
77 | - */ |
|
78 | - public function layout_form_end() |
|
79 | - { |
|
80 | - return EEH_HTML::nl(-1) . '</fieldset>'; |
|
81 | - } |
|
82 | - |
|
83 | - |
|
84 | - |
|
85 | - /** |
|
86 | - * @param string $legend_class |
|
87 | - */ |
|
88 | - public function set_legend_class($legend_class) |
|
89 | - { |
|
90 | - $this->_legend_class = $legend_class; |
|
91 | - } |
|
92 | - |
|
93 | - |
|
94 | - |
|
95 | - /** |
|
96 | - * @return string |
|
97 | - */ |
|
98 | - public function legend_class() |
|
99 | - { |
|
100 | - return $this->_legend_class; |
|
101 | - } |
|
102 | - |
|
103 | - |
|
104 | - |
|
105 | - /** |
|
106 | - * @param string $legend_text |
|
107 | - */ |
|
108 | - public function set_legend_text($legend_text) |
|
109 | - { |
|
110 | - $this->_legend_text = $legend_text; |
|
111 | - } |
|
112 | - |
|
113 | - |
|
114 | - |
|
115 | - /** |
|
116 | - * @return string |
|
117 | - */ |
|
118 | - public function legend_text() |
|
119 | - { |
|
120 | - return $this->_legend_text; |
|
121 | - } |
|
19 | + /** |
|
20 | + * legend_class |
|
21 | + * |
|
22 | + * @var string |
|
23 | + */ |
|
24 | + protected $_legend_class; |
|
25 | + |
|
26 | + /** |
|
27 | + * legend_text |
|
28 | + * |
|
29 | + * @var string |
|
30 | + */ |
|
31 | + protected $_legend_text; |
|
32 | + |
|
33 | + |
|
34 | + |
|
35 | + /** |
|
36 | + * construct |
|
37 | + * |
|
38 | + * @param array $options |
|
39 | + */ |
|
40 | + public function __construct($options = array()) |
|
41 | + { |
|
42 | + foreach ($options as $key => $value) { |
|
43 | + $key = '_' . $key; |
|
44 | + if (property_exists($this, $key)) { |
|
45 | + $this->{$key} = $value; |
|
46 | + } |
|
47 | + } |
|
48 | + } |
|
49 | + |
|
50 | + |
|
51 | + |
|
52 | + /** |
|
53 | + * opening div tag for a form |
|
54 | + * |
|
55 | + * @return string |
|
56 | + */ |
|
57 | + public function layout_form_begin() |
|
58 | + { |
|
59 | + $html = EEH_HTML::nl(1) |
|
60 | + . '<fieldset id="' |
|
61 | + . $this->_form_section->html_id() |
|
62 | + . '" class="' |
|
63 | + . $this->_form_section->html_class() |
|
64 | + . '" style="' |
|
65 | + . $this->_form_section->html_style() |
|
66 | + . '">'; |
|
67 | + $html .= '<legend class="' . $this->legend_class() . '">' . $this->legend_text() . '</legend>'; |
|
68 | + return $html; |
|
69 | + } |
|
70 | + |
|
71 | + |
|
72 | + |
|
73 | + /** |
|
74 | + * closing div tag for a form |
|
75 | + * |
|
76 | + * @return string |
|
77 | + */ |
|
78 | + public function layout_form_end() |
|
79 | + { |
|
80 | + return EEH_HTML::nl(-1) . '</fieldset>'; |
|
81 | + } |
|
82 | + |
|
83 | + |
|
84 | + |
|
85 | + /** |
|
86 | + * @param string $legend_class |
|
87 | + */ |
|
88 | + public function set_legend_class($legend_class) |
|
89 | + { |
|
90 | + $this->_legend_class = $legend_class; |
|
91 | + } |
|
92 | + |
|
93 | + |
|
94 | + |
|
95 | + /** |
|
96 | + * @return string |
|
97 | + */ |
|
98 | + public function legend_class() |
|
99 | + { |
|
100 | + return $this->_legend_class; |
|
101 | + } |
|
102 | + |
|
103 | + |
|
104 | + |
|
105 | + /** |
|
106 | + * @param string $legend_text |
|
107 | + */ |
|
108 | + public function set_legend_text($legend_text) |
|
109 | + { |
|
110 | + $this->_legend_text = $legend_text; |
|
111 | + } |
|
112 | + |
|
113 | + |
|
114 | + |
|
115 | + /** |
|
116 | + * @return string |
|
117 | + */ |
|
118 | + public function legend_text() |
|
119 | + { |
|
120 | + return $this->_legend_text; |
|
121 | + } |
|
122 | 122 | |
123 | 123 | |
124 | 124 |
@@ -1,4 +1,4 @@ discard block |
||
1 | -<?php if (! defined('EVENT_ESPRESSO_VERSION')) { |
|
1 | +<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
2 | 2 | exit('No direct script access allowed'); |
3 | 3 | } |
4 | 4 | |
@@ -40,7 +40,7 @@ discard block |
||
40 | 40 | public function __construct($options = array()) |
41 | 41 | { |
42 | 42 | foreach ($options as $key => $value) { |
43 | - $key = '_' . $key; |
|
43 | + $key = '_'.$key; |
|
44 | 44 | if (property_exists($this, $key)) { |
45 | 45 | $this->{$key} = $value; |
46 | 46 | } |
@@ -64,7 +64,7 @@ discard block |
||
64 | 64 | . '" style="' |
65 | 65 | . $this->_form_section->html_style() |
66 | 66 | . '">'; |
67 | - $html .= '<legend class="' . $this->legend_class() . '">' . $this->legend_text() . '</legend>'; |
|
67 | + $html .= '<legend class="'.$this->legend_class().'">'.$this->legend_text().'</legend>'; |
|
68 | 68 | return $html; |
69 | 69 | } |
70 | 70 | |
@@ -77,7 +77,7 @@ discard block |
||
77 | 77 | */ |
78 | 78 | public function layout_form_end() |
79 | 79 | { |
80 | - return EEH_HTML::nl(-1) . '</fieldset>'; |
|
80 | + return EEH_HTML::nl(-1).'</fieldset>'; |
|
81 | 81 | } |
82 | 82 | |
83 | 83 |