eventespresso /
event-espresso-core
@@ -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 | |
@@ -23,1844 +23,1844 @@ discard block |
||
| 23 | 23 | class Registrations_Admin_Page extends EE_Admin_Page_CPT |
| 24 | 24 | { |
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * @var EE_Registration |
|
| 28 | - */ |
|
| 29 | - private $_registration; |
|
| 30 | - |
|
| 31 | - /** |
|
| 32 | - * @var EE_Event |
|
| 33 | - */ |
|
| 34 | - private $_reg_event; |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * @var EE_Session |
|
| 38 | - */ |
|
| 39 | - private $_session; |
|
| 40 | - |
|
| 41 | - private static $_reg_status; |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * Form for displaying the custom questions for this registration. |
|
| 45 | - * This gets used a few times throughout the request so its best to cache it |
|
| 46 | - * |
|
| 47 | - * @var EE_Registration_Custom_Questions_Form |
|
| 48 | - */ |
|
| 49 | - protected $_reg_custom_questions_form = null; |
|
| 50 | - |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * constructor |
|
| 54 | - * |
|
| 55 | - * @Constructor |
|
| 56 | - * @access public |
|
| 57 | - * @param bool $routing |
|
| 58 | - * @return Registrations_Admin_Page |
|
| 59 | - */ |
|
| 60 | - public function __construct($routing = true) |
|
| 61 | - { |
|
| 62 | - parent::__construct($routing); |
|
| 63 | - add_action('wp_loaded', array($this, 'wp_loaded')); |
|
| 64 | - } |
|
| 65 | - |
|
| 66 | - |
|
| 67 | - public function wp_loaded() |
|
| 68 | - { |
|
| 69 | - // when adding a new registration... |
|
| 70 | - if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') { |
|
| 71 | - EE_System::do_not_cache(); |
|
| 72 | - if ( ! isset($this->_req_data['processing_registration']) |
|
| 73 | - || absint($this->_req_data['processing_registration']) !== 1 |
|
| 74 | - ) { |
|
| 75 | - // and it's NOT the attendee information reg step |
|
| 76 | - // force cookie expiration by setting time to last week |
|
| 77 | - setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/'); |
|
| 78 | - // and update the global |
|
| 79 | - $_COOKIE['ee_registration_added'] = 0; |
|
| 80 | - } |
|
| 81 | - } |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - |
|
| 85 | - protected function _init_page_props() |
|
| 86 | - { |
|
| 87 | - $this->page_slug = REG_PG_SLUG; |
|
| 88 | - $this->_admin_base_url = REG_ADMIN_URL; |
|
| 89 | - $this->_admin_base_path = REG_ADMIN; |
|
| 90 | - $this->page_label = __('Registrations', 'event_espresso'); |
|
| 91 | - $this->_cpt_routes = array( |
|
| 92 | - 'add_new_attendee' => 'espresso_attendees', |
|
| 93 | - 'edit_attendee' => 'espresso_attendees', |
|
| 94 | - 'insert_attendee' => 'espresso_attendees', |
|
| 95 | - 'update_attendee' => 'espresso_attendees', |
|
| 96 | - ); |
|
| 97 | - $this->_cpt_model_names = array( |
|
| 98 | - 'add_new_attendee' => 'EEM_Attendee', |
|
| 99 | - 'edit_attendee' => 'EEM_Attendee', |
|
| 100 | - ); |
|
| 101 | - $this->_cpt_edit_routes = array( |
|
| 102 | - 'espresso_attendees' => 'edit_attendee', |
|
| 103 | - ); |
|
| 104 | - $this->_pagenow_map = array( |
|
| 105 | - 'add_new_attendee' => 'post-new.php', |
|
| 106 | - 'edit_attendee' => 'post.php', |
|
| 107 | - 'trash' => 'post.php', |
|
| 108 | - ); |
|
| 109 | - add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10); |
|
| 110 | - //add filters so that the comment urls don't take users to a confusing 404 page |
|
| 111 | - add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3); |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - |
|
| 115 | - public function clear_comment_link($link, $comment, $args) |
|
| 116 | - { |
|
| 117 | - //gotta make sure this only happens on this route |
|
| 118 | - $post_type = get_post_type($comment->comment_post_ID); |
|
| 119 | - if ($post_type === 'espresso_attendees') { |
|
| 120 | - return '#commentsdiv'; |
|
| 121 | - } |
|
| 122 | - return $link; |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - |
|
| 126 | - protected function _ajax_hooks() |
|
| 127 | - { |
|
| 128 | - //todo: all hooks for registrations ajax goes in here |
|
| 129 | - add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status')); |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - |
|
| 133 | - protected function _define_page_props() |
|
| 134 | - { |
|
| 135 | - $this->_admin_page_title = $this->page_label; |
|
| 136 | - $this->_labels = array( |
|
| 137 | - 'buttons' => array( |
|
| 138 | - 'add-registrant' => __('Add New Registration', 'event_espresso'), |
|
| 139 | - 'add-attendee' => __('Add Contact', 'event_espresso'), |
|
| 140 | - 'edit' => __('Edit Contact', 'event_espresso'), |
|
| 141 | - 'report' => __("Event Registrations CSV Report", "event_espresso"), |
|
| 142 | - 'report_all' => __('All Registrations CSV Report', 'event_espresso'), |
|
| 143 | - 'report_filtered' => __('Filtered CSV Report', 'event_espresso'), |
|
| 144 | - 'contact_list_report' => __('Contact List Report', 'event_espresso'), |
|
| 145 | - 'contact_list_export' => __("Export Data", "event_espresso"), |
|
| 146 | - ), |
|
| 147 | - 'publishbox' => array( |
|
| 148 | - 'add_new_attendee' => __("Add Contact Record", 'event_espresso'), |
|
| 149 | - 'edit_attendee' => __("Update Contact Record", 'event_espresso'), |
|
| 150 | - ), |
|
| 151 | - 'hide_add_button_on_cpt_route' => array( |
|
| 152 | - 'edit_attendee' => true, |
|
| 153 | - ), |
|
| 154 | - ); |
|
| 155 | - } |
|
| 156 | - |
|
| 157 | - |
|
| 158 | - /** |
|
| 159 | - * grab url requests and route them |
|
| 160 | - * |
|
| 161 | - * @access private |
|
| 162 | - * @return void |
|
| 163 | - */ |
|
| 164 | - public function _set_page_routes() |
|
| 165 | - { |
|
| 166 | - $this->_get_registration_status_array(); |
|
| 167 | - $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID']) |
|
| 168 | - ? $this->_req_data['_REG_ID'] : 0; |
|
| 169 | - $att_id = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID']) |
|
| 170 | - ? $this->_req_data['ATT_ID'] : 0; |
|
| 171 | - $att_id = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post']) ? $this->_req_data['post'] |
|
| 172 | - : $att_id; |
|
| 173 | - $this->_page_routes = array( |
|
| 174 | - 'default' => array( |
|
| 175 | - 'func' => '_registrations_overview_list_table', |
|
| 176 | - 'capability' => 'ee_read_registrations', |
|
| 177 | - ), |
|
| 178 | - 'view_registration' => array( |
|
| 179 | - 'func' => '_registration_details', |
|
| 180 | - 'capability' => 'ee_read_registration', |
|
| 181 | - 'obj_id' => $reg_id, |
|
| 182 | - ), |
|
| 183 | - 'edit_registration' => array( |
|
| 184 | - 'func' => '_update_attendee_registration_form', |
|
| 185 | - 'noheader' => true, |
|
| 186 | - 'headers_sent_route' => 'view_registration', |
|
| 187 | - 'capability' => 'ee_edit_registration', |
|
| 188 | - 'obj_id' => $reg_id, |
|
| 189 | - '_REG_ID' => $reg_id, |
|
| 190 | - ), |
|
| 191 | - 'trash_registrations' => array( |
|
| 192 | - 'func' => '_trash_or_restore_registrations', |
|
| 193 | - 'args' => array('trash' => true), |
|
| 194 | - 'noheader' => true, |
|
| 195 | - 'capability' => 'ee_delete_registrations', |
|
| 196 | - ), |
|
| 197 | - 'restore_registrations' => array( |
|
| 198 | - 'func' => '_trash_or_restore_registrations', |
|
| 199 | - 'args' => array('trash' => false), |
|
| 200 | - 'noheader' => true, |
|
| 201 | - 'capability' => 'ee_delete_registrations', |
|
| 202 | - ), |
|
| 203 | - 'delete_registrations' => array( |
|
| 204 | - 'func' => '_delete_registrations', |
|
| 205 | - 'noheader' => true, |
|
| 206 | - 'capability' => 'ee_delete_registrations', |
|
| 207 | - ), |
|
| 208 | - 'new_registration' => array( |
|
| 209 | - 'func' => 'new_registration', |
|
| 210 | - 'capability' => 'ee_edit_registrations', |
|
| 211 | - ), |
|
| 212 | - 'process_reg_step' => array( |
|
| 213 | - 'func' => 'process_reg_step', |
|
| 214 | - 'noheader' => true, |
|
| 215 | - 'capability' => 'ee_edit_registrations', |
|
| 216 | - ), |
|
| 217 | - 'redirect_to_txn' => array( |
|
| 218 | - 'func' => 'redirect_to_txn', |
|
| 219 | - 'noheader' => true, |
|
| 220 | - 'capability' => 'ee_edit_registrations', |
|
| 221 | - ), |
|
| 222 | - 'change_reg_status' => array( |
|
| 223 | - 'func' => '_change_reg_status', |
|
| 224 | - 'noheader' => true, |
|
| 225 | - 'capability' => 'ee_edit_registration', |
|
| 226 | - 'obj_id' => $reg_id, |
|
| 227 | - ), |
|
| 228 | - 'approve_registration' => array( |
|
| 229 | - 'func' => 'approve_registration', |
|
| 230 | - 'noheader' => true, |
|
| 231 | - 'capability' => 'ee_edit_registration', |
|
| 232 | - 'obj_id' => $reg_id, |
|
| 233 | - ), |
|
| 234 | - 'approve_and_notify_registration' => array( |
|
| 235 | - 'func' => 'approve_registration', |
|
| 236 | - 'noheader' => true, |
|
| 237 | - 'args' => array(true), |
|
| 238 | - 'capability' => 'ee_edit_registration', |
|
| 239 | - 'obj_id' => $reg_id, |
|
| 240 | - ), |
|
| 241 | - 'decline_registration' => array( |
|
| 242 | - 'func' => 'decline_registration', |
|
| 243 | - 'noheader' => true, |
|
| 244 | - 'capability' => 'ee_edit_registration', |
|
| 245 | - 'obj_id' => $reg_id, |
|
| 246 | - ), |
|
| 247 | - 'decline_and_notify_registration' => array( |
|
| 248 | - 'func' => 'decline_registration', |
|
| 249 | - 'noheader' => true, |
|
| 250 | - 'args' => array(true), |
|
| 251 | - 'capability' => 'ee_edit_registration', |
|
| 252 | - 'obj_id' => $reg_id, |
|
| 253 | - ), |
|
| 254 | - 'pending_registration' => array( |
|
| 255 | - 'func' => 'pending_registration', |
|
| 256 | - 'noheader' => true, |
|
| 257 | - 'capability' => 'ee_edit_registration', |
|
| 258 | - 'obj_id' => $reg_id, |
|
| 259 | - ), |
|
| 260 | - 'pending_and_notify_registration' => array( |
|
| 261 | - 'func' => 'pending_registration', |
|
| 262 | - 'noheader' => true, |
|
| 263 | - 'args' => array(true), |
|
| 264 | - 'capability' => 'ee_edit_registration', |
|
| 265 | - 'obj_id' => $reg_id, |
|
| 266 | - ), |
|
| 267 | - 'no_approve_registration' => array( |
|
| 268 | - 'func' => 'not_approve_registration', |
|
| 269 | - 'noheader' => true, |
|
| 270 | - 'capability' => 'ee_edit_registration', |
|
| 271 | - 'obj_id' => $reg_id, |
|
| 272 | - ), |
|
| 273 | - 'no_approve_and_notify_registration' => array( |
|
| 274 | - 'func' => 'not_approve_registration', |
|
| 275 | - 'noheader' => true, |
|
| 276 | - 'args' => array(true), |
|
| 277 | - 'capability' => 'ee_edit_registration', |
|
| 278 | - 'obj_id' => $reg_id, |
|
| 279 | - ), |
|
| 280 | - 'cancel_registration' => array( |
|
| 281 | - 'func' => 'cancel_registration', |
|
| 282 | - 'noheader' => true, |
|
| 283 | - 'capability' => 'ee_edit_registration', |
|
| 284 | - 'obj_id' => $reg_id, |
|
| 285 | - ), |
|
| 286 | - 'cancel_and_notify_registration' => array( |
|
| 287 | - 'func' => 'cancel_registration', |
|
| 288 | - 'noheader' => true, |
|
| 289 | - 'args' => array(true), |
|
| 290 | - 'capability' => 'ee_edit_registration', |
|
| 291 | - 'obj_id' => $reg_id, |
|
| 292 | - ), |
|
| 293 | - 'contact_list' => array( |
|
| 294 | - 'func' => '_attendee_contact_list_table', |
|
| 295 | - 'capability' => 'ee_read_contacts', |
|
| 296 | - ), |
|
| 297 | - 'add_new_attendee' => array( |
|
| 298 | - 'func' => '_create_new_cpt_item', |
|
| 299 | - 'args' => array( |
|
| 300 | - 'new_attendee' => true, |
|
| 301 | - 'capability' => 'ee_edit_contacts', |
|
| 302 | - ), |
|
| 303 | - ), |
|
| 304 | - 'edit_attendee' => array( |
|
| 305 | - 'func' => '_edit_cpt_item', |
|
| 306 | - 'capability' => 'ee_edit_contacts', |
|
| 307 | - 'obj_id' => $att_id, |
|
| 308 | - ), |
|
| 309 | - 'duplicate_attendee' => array( |
|
| 310 | - 'func' => '_duplicate_attendee', |
|
| 311 | - 'noheader' => true, |
|
| 312 | - 'capability' => 'ee_edit_contacts', |
|
| 313 | - 'obj_id' => $att_id, |
|
| 314 | - ), |
|
| 315 | - 'insert_attendee' => array( |
|
| 316 | - 'func' => '_insert_or_update_attendee', |
|
| 317 | - 'args' => array( |
|
| 318 | - 'new_attendee' => true, |
|
| 319 | - ), |
|
| 320 | - 'noheader' => true, |
|
| 321 | - 'capability' => 'ee_edit_contacts', |
|
| 322 | - ), |
|
| 323 | - 'update_attendee' => array( |
|
| 324 | - 'func' => '_insert_or_update_attendee', |
|
| 325 | - 'args' => array( |
|
| 326 | - 'new_attendee' => false, |
|
| 327 | - ), |
|
| 328 | - 'noheader' => true, |
|
| 329 | - 'capability' => 'ee_edit_contacts', |
|
| 330 | - 'obj_id' => $att_id, |
|
| 331 | - ), |
|
| 332 | - 'trash_attendee' => array( |
|
| 333 | - 'func' => '_trash_or_restore_attendees', |
|
| 334 | - 'args' => array( |
|
| 335 | - 'trash' => true, |
|
| 336 | - ), |
|
| 337 | - 'noheader' => true, |
|
| 338 | - 'capability' => 'ee_delete_contacts', |
|
| 339 | - 'obj_id' => $att_id, |
|
| 340 | - ), |
|
| 341 | - 'restore_attendees' => array( |
|
| 342 | - 'func' => '_trash_or_restore_attendees', |
|
| 343 | - 'args' => array( |
|
| 344 | - 'trash' => false, |
|
| 345 | - ), |
|
| 346 | - 'noheader' => true, |
|
| 347 | - 'capability' => 'ee_delete_contacts', |
|
| 348 | - 'obj_id' => $att_id, |
|
| 349 | - ), |
|
| 350 | - 'resend_registration' => array( |
|
| 351 | - 'func' => '_resend_registration', |
|
| 352 | - 'noheader' => true, |
|
| 353 | - 'capability' => 'ee_send_message', |
|
| 354 | - ), |
|
| 355 | - 'registrations_report' => array( |
|
| 356 | - 'func' => '_registrations_report', |
|
| 357 | - 'noheader' => true, |
|
| 358 | - 'capability' => 'ee_read_registrations', |
|
| 359 | - ), |
|
| 360 | - 'contact_list_export' => array( |
|
| 361 | - 'func' => '_contact_list_export', |
|
| 362 | - 'noheader' => true, |
|
| 363 | - 'capability' => 'export', |
|
| 364 | - ), |
|
| 365 | - 'contact_list_report' => array( |
|
| 366 | - 'func' => '_contact_list_report', |
|
| 367 | - 'noheader' => true, |
|
| 368 | - 'capability' => 'ee_read_contacts', |
|
| 369 | - ), |
|
| 370 | - ); |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - |
|
| 374 | - protected function _set_page_config() |
|
| 375 | - { |
|
| 376 | - $this->_page_config = array( |
|
| 377 | - 'default' => array( |
|
| 378 | - 'nav' => array( |
|
| 379 | - 'label' => __('Overview', 'event_espresso'), |
|
| 380 | - 'order' => 5, |
|
| 381 | - ), |
|
| 382 | - 'help_tabs' => array( |
|
| 383 | - 'registrations_overview_help_tab' => array( |
|
| 384 | - 'title' => __('Registrations Overview', 'event_espresso'), |
|
| 385 | - 'filename' => 'registrations_overview', |
|
| 386 | - ), |
|
| 387 | - 'registrations_overview_table_column_headings_help_tab' => array( |
|
| 388 | - 'title' => __('Registrations Table Column Headings', 'event_espresso'), |
|
| 389 | - 'filename' => 'registrations_overview_table_column_headings', |
|
| 390 | - ), |
|
| 391 | - 'registrations_overview_filters_help_tab' => array( |
|
| 392 | - 'title' => __('Registration Filters', 'event_espresso'), |
|
| 393 | - 'filename' => 'registrations_overview_filters', |
|
| 394 | - ), |
|
| 395 | - 'registrations_overview_views_help_tab' => array( |
|
| 396 | - 'title' => __('Registration Views', 'event_espresso'), |
|
| 397 | - 'filename' => 'registrations_overview_views', |
|
| 398 | - ), |
|
| 399 | - 'registrations_regoverview_other_help_tab' => array( |
|
| 400 | - 'title' => __('Registrations Other', 'event_espresso'), |
|
| 401 | - 'filename' => 'registrations_overview_other', |
|
| 402 | - ), |
|
| 403 | - ), |
|
| 404 | - 'help_tour' => array('Registration_Overview_Help_Tour'), |
|
| 405 | - 'qtips' => array('Registration_List_Table_Tips'), |
|
| 406 | - 'list_table' => 'EE_Registrations_List_Table', |
|
| 407 | - 'require_nonce' => false, |
|
| 408 | - ), |
|
| 409 | - 'view_registration' => array( |
|
| 410 | - 'nav' => array( |
|
| 411 | - 'label' => __('REG Details', 'event_espresso'), |
|
| 412 | - 'order' => 15, |
|
| 413 | - 'url' => isset($this->_req_data['_REG_ID']) |
|
| 414 | - ? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url) |
|
| 415 | - : $this->_admin_base_url, |
|
| 416 | - 'persistent' => false, |
|
| 417 | - ), |
|
| 418 | - 'help_tabs' => array( |
|
| 419 | - 'registrations_details_help_tab' => array( |
|
| 420 | - 'title' => __('Registration Details', 'event_espresso'), |
|
| 421 | - 'filename' => 'registrations_details', |
|
| 422 | - ), |
|
| 423 | - 'registrations_details_table_help_tab' => array( |
|
| 424 | - 'title' => __('Registration Details Table', 'event_espresso'), |
|
| 425 | - 'filename' => 'registrations_details_table', |
|
| 426 | - ), |
|
| 427 | - 'registrations_details_form_answers_help_tab' => array( |
|
| 428 | - 'title' => __('Registration Form Answers', 'event_espresso'), |
|
| 429 | - 'filename' => 'registrations_details_form_answers', |
|
| 430 | - ), |
|
| 431 | - 'registrations_details_registrant_details_help_tab' => array( |
|
| 432 | - 'title' => __('Contact Details', 'event_espresso'), |
|
| 433 | - 'filename' => 'registrations_details_registrant_details', |
|
| 434 | - ), |
|
| 435 | - ), |
|
| 436 | - 'help_tour' => array('Registration_Details_Help_Tour'), |
|
| 437 | - 'metaboxes' => array_merge($this->_default_espresso_metaboxes, |
|
| 438 | - array('_registration_details_metaboxes')), |
|
| 439 | - 'require_nonce' => false, |
|
| 440 | - ), |
|
| 441 | - 'new_registration' => array( |
|
| 442 | - 'nav' => array( |
|
| 443 | - 'label' => __('Add New Registration', 'event_espresso'), |
|
| 444 | - 'url' => '#', |
|
| 445 | - 'order' => 15, |
|
| 446 | - 'persistent' => false, |
|
| 447 | - ), |
|
| 448 | - 'metaboxes' => $this->_default_espresso_metaboxes, |
|
| 449 | - 'labels' => array( |
|
| 450 | - 'publishbox' => __('Save Registration', 'event_espresso'), |
|
| 451 | - ), |
|
| 452 | - 'require_nonce' => false, |
|
| 453 | - ), |
|
| 454 | - 'add_new_attendee' => array( |
|
| 455 | - 'nav' => array( |
|
| 456 | - 'label' => __('Add Contact', 'event_espresso'), |
|
| 457 | - 'order' => 15, |
|
| 458 | - 'persistent' => false, |
|
| 459 | - ), |
|
| 460 | - 'metaboxes' => array_merge($this->_default_espresso_metaboxes, |
|
| 461 | - array('_publish_post_box', 'attendee_editor_metaboxes')), |
|
| 462 | - 'require_nonce' => false, |
|
| 463 | - ), |
|
| 464 | - 'edit_attendee' => array( |
|
| 465 | - 'nav' => array( |
|
| 466 | - 'label' => __('Edit Contact', 'event_espresso'), |
|
| 467 | - 'order' => 15, |
|
| 468 | - 'persistent' => false, |
|
| 469 | - 'url' => isset($this->_req_data['ATT_ID']) |
|
| 470 | - ? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url) |
|
| 471 | - : $this->_admin_base_url, |
|
| 472 | - ), |
|
| 473 | - 'metaboxes' => array('attendee_editor_metaboxes'), |
|
| 474 | - 'require_nonce' => false, |
|
| 475 | - ), |
|
| 476 | - 'contact_list' => array( |
|
| 477 | - 'nav' => array( |
|
| 478 | - 'label' => __('Contact List', 'event_espresso'), |
|
| 479 | - 'order' => 20, |
|
| 480 | - ), |
|
| 481 | - 'list_table' => 'EE_Attendee_Contact_List_Table', |
|
| 482 | - 'help_tabs' => array( |
|
| 483 | - 'registrations_contact_list_help_tab' => array( |
|
| 484 | - 'title' => __('Registrations Contact List', 'event_espresso'), |
|
| 485 | - 'filename' => 'registrations_contact_list', |
|
| 486 | - ), |
|
| 487 | - 'registrations_contact-list_table_column_headings_help_tab' => array( |
|
| 488 | - 'title' => __('Contact List Table Column Headings', 'event_espresso'), |
|
| 489 | - 'filename' => 'registrations_contact_list_table_column_headings', |
|
| 490 | - ), |
|
| 491 | - 'registrations_contact_list_views_help_tab' => array( |
|
| 492 | - 'title' => __('Contact List Views', 'event_espresso'), |
|
| 493 | - 'filename' => 'registrations_contact_list_views', |
|
| 494 | - ), |
|
| 495 | - 'registrations_contact_list_other_help_tab' => array( |
|
| 496 | - 'title' => __('Contact List Other', 'event_espresso'), |
|
| 497 | - 'filename' => 'registrations_contact_list_other', |
|
| 498 | - ), |
|
| 499 | - ), |
|
| 500 | - 'help_tour' => array('Contact_List_Help_Tour'), |
|
| 501 | - 'metaboxes' => array(), |
|
| 502 | - 'require_nonce' => false, |
|
| 503 | - ), |
|
| 504 | - //override default cpt routes |
|
| 505 | - 'create_new' => '', |
|
| 506 | - 'edit' => '', |
|
| 507 | - ); |
|
| 508 | - } |
|
| 509 | - |
|
| 510 | - |
|
| 511 | - /** |
|
| 512 | - * The below methods aren't used by this class currently |
|
| 513 | - */ |
|
| 514 | - protected function _add_screen_options() |
|
| 515 | - { |
|
| 516 | - } |
|
| 517 | - |
|
| 518 | - |
|
| 519 | - protected function _add_feature_pointers() |
|
| 520 | - { |
|
| 521 | - } |
|
| 522 | - |
|
| 523 | - |
|
| 524 | - public function admin_init() |
|
| 525 | - { |
|
| 526 | - EE_Registry::$i18n_js_strings['update_att_qstns'] = __('click "Update Registration Questions" to save your changes', |
|
| 527 | - 'event_espresso'); |
|
| 528 | - } |
|
| 529 | - |
|
| 530 | - |
|
| 531 | - public function admin_notices() |
|
| 532 | - { |
|
| 533 | - } |
|
| 534 | - |
|
| 535 | - |
|
| 536 | - public function admin_footer_scripts() |
|
| 537 | - { |
|
| 538 | - } |
|
| 539 | - |
|
| 540 | - |
|
| 541 | - /** |
|
| 542 | - * get list of registration statuses |
|
| 543 | - * |
|
| 544 | - * @access private |
|
| 545 | - * @return void |
|
| 546 | - */ |
|
| 547 | - private function _get_registration_status_array() |
|
| 548 | - { |
|
| 549 | - self::$_reg_status = EEM_Registration::reg_status_array(array(), true); |
|
| 550 | - } |
|
| 551 | - |
|
| 552 | - |
|
| 553 | - protected function _add_screen_options_default() |
|
| 554 | - { |
|
| 555 | - $this->_per_page_screen_option(); |
|
| 556 | - } |
|
| 557 | - |
|
| 558 | - |
|
| 559 | - protected function _add_screen_options_contact_list() |
|
| 560 | - { |
|
| 561 | - $page_title = $this->_admin_page_title; |
|
| 562 | - $this->_admin_page_title = __("Contacts", 'event_espresso'); |
|
| 563 | - $this->_per_page_screen_option(); |
|
| 564 | - $this->_admin_page_title = $page_title; |
|
| 565 | - } |
|
| 566 | - |
|
| 567 | - |
|
| 568 | - public function load_scripts_styles() |
|
| 569 | - { |
|
| 570 | - //style |
|
| 571 | - //wp_register_style('espresso_attendees', ATT_ASSETS_URL . 'espresso_attendees_admin.css', array(), EVENT_ESPRESSO_VERSION ); |
|
| 572 | - wp_register_style('espresso_reg', REG_ASSETS_URL . 'espresso_registrations_admin.css', array('ee-admin-css'), |
|
| 573 | - EVENT_ESPRESSO_VERSION); |
|
| 574 | - wp_enqueue_style('espresso_reg'); |
|
| 575 | - //script |
|
| 576 | - wp_register_script('espresso_reg', REG_ASSETS_URL . 'espresso_registrations_admin.js', |
|
| 577 | - array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'), EVENT_ESPRESSO_VERSION, true); |
|
| 578 | - wp_enqueue_script('espresso_reg'); |
|
| 579 | - } |
|
| 580 | - |
|
| 581 | - |
|
| 582 | - public function load_scripts_styles_edit_attendee() |
|
| 583 | - { |
|
| 584 | - //stuff to only show up on our attendee edit details page. |
|
| 585 | - $attendee_details_translations = array( |
|
| 586 | - 'att_publish_text' => sprintf(__('Created on: <b>%1$s</b>', 'event_espresso'), |
|
| 587 | - $this->_cpt_model_obj->get_datetime('ATT_created')), |
|
| 588 | - ); |
|
| 589 | - wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations); |
|
| 590 | - wp_enqueue_script('jquery-validate'); |
|
| 591 | - } |
|
| 592 | - |
|
| 593 | - |
|
| 594 | - public function load_scripts_styles_view_registration() |
|
| 595 | - { |
|
| 596 | - //styles |
|
| 597 | - wp_enqueue_style('espresso-ui-theme'); |
|
| 598 | - //scripts |
|
| 599 | - $this->_get_reg_custom_questions_form($this->_registration->ID()); |
|
| 600 | - $this->_reg_custom_questions_form->wp_enqueue_scripts(true); |
|
| 601 | - } |
|
| 602 | - |
|
| 603 | - |
|
| 604 | - public function load_scripts_styles_contact_list() |
|
| 605 | - { |
|
| 606 | - wp_deregister_style('espresso_reg'); |
|
| 607 | - wp_register_style('espresso_att', REG_ASSETS_URL . 'espresso_attendees_admin.css', array('ee-admin-css'), |
|
| 608 | - EVENT_ESPRESSO_VERSION); |
|
| 609 | - wp_enqueue_style('espresso_att'); |
|
| 610 | - } |
|
| 611 | - |
|
| 612 | - |
|
| 613 | - public function load_scripts_styles_new_registration() |
|
| 614 | - { |
|
| 615 | - wp_register_script('ee-spco-for-admin', REG_ASSETS_URL . 'spco_for_admin.js', array('underscore', 'jquery'), |
|
| 616 | - EVENT_ESPRESSO_VERSION, true); |
|
| 617 | - wp_enqueue_script('ee-spco-for-admin'); |
|
| 618 | - add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true'); |
|
| 619 | - EE_Form_Section_Proper::wp_enqueue_scripts(); |
|
| 620 | - EED_Ticket_Selector::load_tckt_slctr_assets(); |
|
| 621 | - EE_Datepicker_Input::enqueue_styles_and_scripts(); |
|
| 622 | - } |
|
| 623 | - |
|
| 624 | - |
|
| 625 | - public function AHEE__EE_Admin_Page__route_admin_request_resend_registration() |
|
| 626 | - { |
|
| 627 | - add_filter('FHEE_load_EE_messages', '__return_true'); |
|
| 628 | - } |
|
| 629 | - |
|
| 630 | - |
|
| 631 | - public function AHEE__EE_Admin_Page__route_admin_request_approve_registration() |
|
| 632 | - { |
|
| 633 | - add_filter('FHEE_load_EE_messages', '__return_true'); |
|
| 634 | - } |
|
| 635 | - |
|
| 636 | - |
|
| 637 | - protected function _set_list_table_views_default() |
|
| 638 | - { |
|
| 639 | - //for notification related bulk actions we need to make sure only active messengers have an option. |
|
| 640 | - EED_Messages::set_autoloaders(); |
|
| 641 | - /** @type EE_Message_Resource_Manager $message_resource_manager */ |
|
| 642 | - $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 643 | - $active_mts = $message_resource_manager->list_of_active_message_types(); |
|
| 644 | - //key= bulk_action_slug, value= message type. |
|
| 645 | - $match_array = array( |
|
| 646 | - 'approve_registration' => 'registration', |
|
| 647 | - 'decline_registration' => 'declined_registration', |
|
| 648 | - 'pending_registration' => 'pending_approval', |
|
| 649 | - 'no_approve_registration' => 'not_approved_registration', |
|
| 650 | - 'cancel_registration' => 'cancelled_registration', |
|
| 651 | - ); |
|
| 652 | - /** setup reg status bulk actions **/ |
|
| 653 | - $def_reg_status_actions['approve_registration'] = __('Approve Registrations', 'event_espresso'); |
|
| 654 | - if (in_array($match_array['approve_registration'], $active_mts) |
|
| 655 | - && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages') |
|
| 656 | - ) { |
|
| 657 | - $def_reg_status_actions['approve_and_notify_registration'] = __('Approve and Notify Registrations', |
|
| 658 | - 'event_espresso'); |
|
| 659 | - } |
|
| 660 | - $def_reg_status_actions['decline_registration'] = __('Decline Registrations', 'event_espresso'); |
|
| 661 | - if (in_array($match_array['decline_registration'], $active_mts) |
|
| 662 | - && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages') |
|
| 663 | - ) { |
|
| 664 | - $def_reg_status_actions['decline_and_notify_registration'] = __('Decline and Notify Registrations', |
|
| 665 | - 'event_espresso'); |
|
| 666 | - } |
|
| 667 | - $def_reg_status_actions['pending_registration'] = __('Set Registrations to Pending Payment', 'event_espresso'); |
|
| 668 | - if (in_array($match_array['pending_registration'], $active_mts) |
|
| 669 | - && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages') |
|
| 670 | - ) { |
|
| 671 | - $def_reg_status_actions['pending_and_notify_registration'] = __('Set Registrations to Pending Payment and Notify', |
|
| 672 | - 'event_espresso'); |
|
| 673 | - } |
|
| 674 | - $def_reg_status_actions['no_approve_registration'] = __('Set Registrations to Not Approved', 'event_espresso'); |
|
| 675 | - if (in_array($match_array['no_approve_registration'], $active_mts) |
|
| 676 | - && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages') |
|
| 677 | - ) { |
|
| 678 | - $def_reg_status_actions['no_approve_and_notify_registration'] = __('Set Registrations to Not Approved and Notify', |
|
| 679 | - 'event_espresso'); |
|
| 680 | - } |
|
| 681 | - $def_reg_status_actions['cancel_registration'] = __('Cancel Registrations', 'event_espresso'); |
|
| 682 | - if (in_array($match_array['cancel_registration'], $active_mts) |
|
| 683 | - && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages') |
|
| 684 | - ) { |
|
| 685 | - $def_reg_status_actions['cancel_and_notify_registration'] = __('Cancel Registrations and Notify', |
|
| 686 | - 'event_espresso'); |
|
| 687 | - } |
|
| 688 | - $this->_views = array( |
|
| 689 | - 'all' => array( |
|
| 690 | - 'slug' => 'all', |
|
| 691 | - 'label' => __('View All Registrations', 'event_espresso'), |
|
| 692 | - 'count' => 0, |
|
| 693 | - 'bulk_action' => array_merge($def_reg_status_actions, array( |
|
| 694 | - 'trash_registrations' => __('Trash Registrations', 'event_espresso'), |
|
| 695 | - )), |
|
| 696 | - ), |
|
| 697 | - 'month' => array( |
|
| 698 | - 'slug' => 'month', |
|
| 699 | - 'label' => __('This Month', 'event_espresso'), |
|
| 700 | - 'count' => 0, |
|
| 701 | - 'bulk_action' => array_merge($def_reg_status_actions, array( |
|
| 702 | - 'trash_registrations' => __('Trash Registrations', 'event_espresso'), |
|
| 703 | - )), |
|
| 704 | - ), |
|
| 705 | - 'today' => array( |
|
| 706 | - 'slug' => 'today', |
|
| 707 | - 'label' => sprintf(__('Today - %s', 'event_espresso'), date('M d, Y', current_time('timestamp'))), |
|
| 708 | - 'count' => 0, |
|
| 709 | - 'bulk_action' => array_merge($def_reg_status_actions, array( |
|
| 710 | - 'trash_registrations' => __('Trash Registrations', 'event_espresso'), |
|
| 711 | - )), |
|
| 712 | - ), |
|
| 713 | - ); |
|
| 714 | - if (EE_Registry::instance()->CAP->current_user_can('ee_delete_registrations', |
|
| 715 | - 'espresso_registrations_delete_registration') |
|
| 716 | - ) { |
|
| 717 | - $this->_views['incomplete'] = array( |
|
| 718 | - 'slug' => 'incomplete', |
|
| 719 | - 'label' => __('Incomplete', 'event_espresso'), |
|
| 720 | - 'count' => 0, |
|
| 721 | - 'bulk_action' => array( |
|
| 722 | - 'trash_registrations' => __('Trash Registrations', 'event_espresso'), |
|
| 723 | - ), |
|
| 724 | - ); |
|
| 725 | - $this->_views['trash'] = array( |
|
| 726 | - 'slug' => 'trash', |
|
| 727 | - 'label' => __('Trash', 'event_espresso'), |
|
| 728 | - 'count' => 0, |
|
| 729 | - 'bulk_action' => array( |
|
| 730 | - 'restore_registrations' => __('Restore Registrations', 'event_espresso'), |
|
| 731 | - 'delete_registrations' => __('Delete Registrations Permanently', 'event_espresso'), |
|
| 732 | - ), |
|
| 733 | - ); |
|
| 734 | - } |
|
| 735 | - } |
|
| 736 | - |
|
| 737 | - |
|
| 738 | - protected function _set_list_table_views_contact_list() |
|
| 739 | - { |
|
| 740 | - $this->_views = array( |
|
| 741 | - 'in_use' => array( |
|
| 742 | - 'slug' => 'in_use', |
|
| 743 | - 'label' => __('In Use', 'event_espresso'), |
|
| 744 | - 'count' => 0, |
|
| 745 | - 'bulk_action' => array( |
|
| 746 | - 'trash_attendee' => __('Move to Trash', 'event_espresso'), |
|
| 747 | - ), |
|
| 748 | - ), |
|
| 749 | - ); |
|
| 750 | - if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts', |
|
| 751 | - 'espresso_registrations_trash_attendees') |
|
| 752 | - ) { |
|
| 753 | - $this->_views['trash'] = array( |
|
| 754 | - 'slug' => 'trash', |
|
| 755 | - 'label' => __('Trash', 'event_espresso'), |
|
| 756 | - 'count' => 0, |
|
| 757 | - 'bulk_action' => array( |
|
| 758 | - 'restore_attendees' => __('Restore from Trash', 'event_espresso'), |
|
| 759 | - ), |
|
| 760 | - ); |
|
| 761 | - } |
|
| 762 | - } |
|
| 763 | - |
|
| 764 | - |
|
| 765 | - protected function _registration_legend_items() |
|
| 766 | - { |
|
| 767 | - $fc_items = array( |
|
| 768 | - 'star-icon' => array( |
|
| 769 | - 'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8', |
|
| 770 | - 'desc' => __('This is the Primary Registrant', 'event_espresso'), |
|
| 771 | - ), |
|
| 772 | - 'view_details' => array( |
|
| 773 | - 'class' => 'dashicons dashicons-clipboard', |
|
| 774 | - 'desc' => __('View Registration Details', 'event_espresso'), |
|
| 775 | - ), |
|
| 776 | - 'edit_attendee' => array( |
|
| 777 | - 'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16', |
|
| 778 | - 'desc' => __('Edit Contact Details', 'event_espresso'), |
|
| 779 | - ), |
|
| 780 | - 'view_transaction' => array( |
|
| 781 | - 'class' => 'dashicons dashicons-cart', |
|
| 782 | - 'desc' => __('View Transaction Details', 'event_espresso'), |
|
| 783 | - ), |
|
| 784 | - 'view_invoice' => array( |
|
| 785 | - 'class' => 'dashicons dashicons-media-spreadsheet', |
|
| 786 | - 'desc' => __('View Transaction Invoice', 'event_espresso'), |
|
| 787 | - ), |
|
| 788 | - ); |
|
| 789 | - if (EE_Registry::instance()->CAP->current_user_can('ee_send_message', |
|
| 790 | - 'espresso_registrations_resend_registration') |
|
| 791 | - ) { |
|
| 792 | - $fc_items['resend_registration'] = array( |
|
| 793 | - 'class' => 'dashicons dashicons-email-alt', |
|
| 794 | - 'desc' => __('Resend Registration Details', 'event_espresso'), |
|
| 795 | - ); |
|
| 796 | - } else { |
|
| 797 | - $fc_items['blank'] = array('class' => 'blank', 'desc' => ''); |
|
| 798 | - } |
|
| 799 | - if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) { |
|
| 800 | - $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for'); |
|
| 801 | - if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) { |
|
| 802 | - $fc_items['view_related_messages'] = array( |
|
| 803 | - 'class' => $related_for_icon['css_class'], |
|
| 804 | - 'desc' => $related_for_icon['label'], |
|
| 805 | - ); |
|
| 806 | - } |
|
| 807 | - } |
|
| 808 | - $sc_items = array( |
|
| 809 | - 'approved_status' => array( |
|
| 810 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved, |
|
| 811 | - 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'), |
|
| 812 | - ), |
|
| 813 | - 'pending_status' => array( |
|
| 814 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment, |
|
| 815 | - 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'), |
|
| 816 | - ), |
|
| 817 | - 'wait_list' => array( |
|
| 818 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list, |
|
| 819 | - 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'), |
|
| 820 | - ), |
|
| 821 | - 'incomplete_status' => array( |
|
| 822 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete, |
|
| 823 | - 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_incomplete, false, 'sentence'), |
|
| 824 | - ), |
|
| 825 | - 'not_approved' => array( |
|
| 826 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved, |
|
| 827 | - 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'), |
|
| 828 | - ), |
|
| 829 | - 'declined_status' => array( |
|
| 830 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined, |
|
| 831 | - 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'), |
|
| 832 | - ), |
|
| 833 | - 'cancelled_status' => array( |
|
| 834 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled, |
|
| 835 | - 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'), |
|
| 836 | - ), |
|
| 837 | - ); |
|
| 838 | - return array_merge($fc_items, $sc_items); |
|
| 839 | - } |
|
| 840 | - |
|
| 841 | - |
|
| 842 | - |
|
| 843 | - /*************************************** REGISTRATION OVERVIEW **************************************/ |
|
| 844 | - /** |
|
| 845 | - * @throws \EE_Error |
|
| 846 | - */ |
|
| 847 | - protected function _registrations_overview_list_table() |
|
| 848 | - { |
|
| 849 | - $this->_template_args['admin_page_header'] = ''; |
|
| 850 | - $EVT_ID = ! empty($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : 0; |
|
| 851 | - if ($EVT_ID) { |
|
| 852 | - if (EE_Registry::instance()->CAP->current_user_can('ee_edit_registrations', |
|
| 853 | - 'espresso_registrations_new_registration', $EVT_ID) |
|
| 854 | - ) { |
|
| 855 | - $this->_admin_page_title .= ' ' . $this->get_action_link_or_button('new_registration', 'add-registrant', |
|
| 856 | - array('event_id' => $EVT_ID), 'add-new-h2'); |
|
| 857 | - } |
|
| 858 | - $event = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
| 859 | - if ($event instanceof EE_Event) { |
|
| 860 | - $this->_template_args['admin_page_header'] = sprintf(__('%s Viewing registrations for the event: %s%s', |
|
| 861 | - 'event_espresso'), '<h3 style="line-height:1.5em;">', |
|
| 862 | - '<br /><a href="' . EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 863 | - 'action' => 'edit', |
|
| 864 | - 'post' => $event->ID(), |
|
| 865 | - ), EVENTS_ADMIN_URL) . '"> ' . $event->get('EVT_name') . ' </a> ', '</h3>'); |
|
| 866 | - } |
|
| 867 | - $DTT_ID = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0; |
|
| 868 | - $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID); |
|
| 869 | - if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') { |
|
| 870 | - $this->_template_args['admin_page_header'] = substr($this->_template_args['admin_page_header'], 0, -5); |
|
| 871 | - $this->_template_args['admin_page_header'] .= ' <span class="drk-grey-text">'; |
|
| 872 | - $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>'; |
|
| 873 | - $this->_template_args['admin_page_header'] .= $datetime->name(); |
|
| 874 | - $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )'; |
|
| 875 | - $this->_template_args['admin_page_header'] .= '</span></h3>'; |
|
| 876 | - } |
|
| 877 | - } |
|
| 878 | - $this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items()); |
|
| 879 | - $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 880 | - } |
|
| 881 | - |
|
| 882 | - |
|
| 883 | - /** |
|
| 884 | - * This sets the _registration property for the registration details screen |
|
| 885 | - * |
|
| 886 | - * @access private |
|
| 887 | - * @return bool |
|
| 888 | - */ |
|
| 889 | - private function _set_registration_object() |
|
| 890 | - { |
|
| 891 | - //get out if we've already set the object |
|
| 892 | - if (is_object($this->_registration)) { |
|
| 893 | - return true; |
|
| 894 | - } |
|
| 895 | - $REG = EEM_Registration::instance(); |
|
| 896 | - $REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false; |
|
| 897 | - if ($this->_registration = $REG->get_one_by_ID($REG_ID)) { |
|
| 898 | - return true; |
|
| 899 | - } else { |
|
| 900 | - $error_msg = sprintf(__('An error occurred and the details for Registration ID #%s could not be retrieved.', |
|
| 901 | - 'event_espresso'), $REG_ID); |
|
| 902 | - EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 903 | - $this->_registration = null; |
|
| 904 | - return false; |
|
| 905 | - } |
|
| 906 | - } |
|
| 907 | - |
|
| 908 | - |
|
| 909 | - /** |
|
| 910 | - * Used to retrieve registrations for the list table. |
|
| 911 | - * |
|
| 912 | - * @param int $per_page |
|
| 913 | - * @param bool $count |
|
| 914 | - * @param bool $this_month |
|
| 915 | - * @param bool $today |
|
| 916 | - * @return \EE_Registration[]|int |
|
| 917 | - */ |
|
| 918 | - public function get_registrations( |
|
| 919 | - $per_page = 10, |
|
| 920 | - $count = false, |
|
| 921 | - $this_month = false, |
|
| 922 | - $today = false |
|
| 923 | - ) { |
|
| 924 | - if( $this_month ) { |
|
| 925 | - $this->_req_data['status'] = 'month'; |
|
| 926 | - } |
|
| 927 | - if( $today ) { |
|
| 928 | - $this->_req_data['status'] = 'today'; |
|
| 929 | - } |
|
| 930 | - $query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count); |
|
| 931 | - /** |
|
| 932 | - * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected |
|
| 933 | - * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093 |
|
| 934 | - * @see EEM_Base::get_all() |
|
| 935 | - */ |
|
| 936 | - $query_params['group_by'] = ''; |
|
| 937 | - |
|
| 938 | - return $count |
|
| 939 | - ? EEM_Registration::instance()->count($query_params) |
|
| 940 | - /** @type EE_Registration[] */ |
|
| 941 | - : EEM_Registration::instance()->get_all($query_params); |
|
| 942 | - } |
|
| 943 | - |
|
| 944 | - |
|
| 945 | - |
|
| 946 | - /** |
|
| 947 | - * Retrieves the query parameters to be used by the Registration model for getting registrations. |
|
| 948 | - * Note: this listens to values on the request for some of the query parameters. |
|
| 949 | - * |
|
| 950 | - * @param array $request |
|
| 951 | - * @param int $per_page |
|
| 952 | - * @param bool $count |
|
| 953 | - * @return array |
|
| 954 | - */ |
|
| 955 | - protected function _get_registration_query_parameters( |
|
| 956 | - $request = array(), |
|
| 957 | - $per_page = 10, |
|
| 958 | - $count = false |
|
| 959 | - ) { |
|
| 960 | - |
|
| 961 | - $query_params = array( |
|
| 962 | - 0 => $this->_get_where_conditions_for_registrations_query( |
|
| 963 | - $request |
|
| 964 | - ), |
|
| 965 | - 'caps' => EEM_Registration::caps_read_admin, |
|
| 966 | - 'default_where_conditions' => 'this_model_only', |
|
| 967 | - ); |
|
| 968 | - if ( ! $count) { |
|
| 969 | - $query_params = array_merge( |
|
| 970 | - $query_params, |
|
| 971 | - $this->_get_orderby_for_registrations_query(), |
|
| 972 | - $this->_get_limit($per_page) |
|
| 973 | - ); |
|
| 974 | - } |
|
| 975 | - |
|
| 976 | - return $query_params; |
|
| 977 | - } |
|
| 978 | - |
|
| 979 | - |
|
| 980 | - /** |
|
| 981 | - * This will add EVT_ID to the provided $where array for EE model query parameters. |
|
| 982 | - * |
|
| 983 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 984 | - * @return array |
|
| 985 | - */ |
|
| 986 | - protected function _add_event_id_to_where_conditions(array $request) |
|
| 987 | - { |
|
| 988 | - $where = array(); |
|
| 989 | - if ( ! empty($request['event_id'])) { |
|
| 990 | - $where['EVT_ID'] = absint($request['event_id']); |
|
| 991 | - } |
|
| 992 | - return $where; |
|
| 993 | - } |
|
| 994 | - |
|
| 995 | - |
|
| 996 | - /** |
|
| 997 | - * Adds category ID if it exists in the request to the where conditions for the registrations query. |
|
| 998 | - * |
|
| 999 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1000 | - * @return array |
|
| 1001 | - */ |
|
| 1002 | - protected function _add_category_id_to_where_conditions(array $request) |
|
| 1003 | - { |
|
| 1004 | - $where = array(); |
|
| 1005 | - if ( ! empty($request['EVT_CAT']) && (int)$request['EVT_CAT'] !== -1) { |
|
| 1006 | - $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']); |
|
| 1007 | - } |
|
| 1008 | - return $where; |
|
| 1009 | - } |
|
| 1010 | - |
|
| 1011 | - |
|
| 1012 | - /** |
|
| 1013 | - * Adds the datetime ID if it exists in the request to the where conditions for the registrations query. |
|
| 1014 | - * |
|
| 1015 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1016 | - * @return array |
|
| 1017 | - */ |
|
| 1018 | - protected function _add_datetime_id_to_where_conditions(array $request) |
|
| 1019 | - { |
|
| 1020 | - $where = array(); |
|
| 1021 | - if ( ! empty($request['datetime_id'])) { |
|
| 1022 | - $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']); |
|
| 1023 | - } |
|
| 1024 | - if( ! empty($request['DTT_ID'])){ |
|
| 1025 | - $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']); |
|
| 1026 | - } |
|
| 1027 | - return $where; |
|
| 1028 | - } |
|
| 1029 | - |
|
| 1030 | - |
|
| 1031 | - /** |
|
| 1032 | - * Adds the correct registration status to the where conditions for the registrations query. |
|
| 1033 | - * |
|
| 1034 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1035 | - * @return array |
|
| 1036 | - */ |
|
| 1037 | - protected function _add_registration_status_to_where_conditions(array $request) |
|
| 1038 | - { |
|
| 1039 | - $where = array(); |
|
| 1040 | - $view = EEH_Array::is_set( $request, 'status', '' ); |
|
| 1041 | - $registration_status = ! empty($request['_reg_status']) |
|
| 1042 | - ? sanitize_text_field($request['_reg_status']) |
|
| 1043 | - : ''; |
|
| 1044 | - |
|
| 1045 | - /* |
|
| 26 | + /** |
|
| 27 | + * @var EE_Registration |
|
| 28 | + */ |
|
| 29 | + private $_registration; |
|
| 30 | + |
|
| 31 | + /** |
|
| 32 | + * @var EE_Event |
|
| 33 | + */ |
|
| 34 | + private $_reg_event; |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * @var EE_Session |
|
| 38 | + */ |
|
| 39 | + private $_session; |
|
| 40 | + |
|
| 41 | + private static $_reg_status; |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * Form for displaying the custom questions for this registration. |
|
| 45 | + * This gets used a few times throughout the request so its best to cache it |
|
| 46 | + * |
|
| 47 | + * @var EE_Registration_Custom_Questions_Form |
|
| 48 | + */ |
|
| 49 | + protected $_reg_custom_questions_form = null; |
|
| 50 | + |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * constructor |
|
| 54 | + * |
|
| 55 | + * @Constructor |
|
| 56 | + * @access public |
|
| 57 | + * @param bool $routing |
|
| 58 | + * @return Registrations_Admin_Page |
|
| 59 | + */ |
|
| 60 | + public function __construct($routing = true) |
|
| 61 | + { |
|
| 62 | + parent::__construct($routing); |
|
| 63 | + add_action('wp_loaded', array($this, 'wp_loaded')); |
|
| 64 | + } |
|
| 65 | + |
|
| 66 | + |
|
| 67 | + public function wp_loaded() |
|
| 68 | + { |
|
| 69 | + // when adding a new registration... |
|
| 70 | + if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') { |
|
| 71 | + EE_System::do_not_cache(); |
|
| 72 | + if ( ! isset($this->_req_data['processing_registration']) |
|
| 73 | + || absint($this->_req_data['processing_registration']) !== 1 |
|
| 74 | + ) { |
|
| 75 | + // and it's NOT the attendee information reg step |
|
| 76 | + // force cookie expiration by setting time to last week |
|
| 77 | + setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/'); |
|
| 78 | + // and update the global |
|
| 79 | + $_COOKIE['ee_registration_added'] = 0; |
|
| 80 | + } |
|
| 81 | + } |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + |
|
| 85 | + protected function _init_page_props() |
|
| 86 | + { |
|
| 87 | + $this->page_slug = REG_PG_SLUG; |
|
| 88 | + $this->_admin_base_url = REG_ADMIN_URL; |
|
| 89 | + $this->_admin_base_path = REG_ADMIN; |
|
| 90 | + $this->page_label = __('Registrations', 'event_espresso'); |
|
| 91 | + $this->_cpt_routes = array( |
|
| 92 | + 'add_new_attendee' => 'espresso_attendees', |
|
| 93 | + 'edit_attendee' => 'espresso_attendees', |
|
| 94 | + 'insert_attendee' => 'espresso_attendees', |
|
| 95 | + 'update_attendee' => 'espresso_attendees', |
|
| 96 | + ); |
|
| 97 | + $this->_cpt_model_names = array( |
|
| 98 | + 'add_new_attendee' => 'EEM_Attendee', |
|
| 99 | + 'edit_attendee' => 'EEM_Attendee', |
|
| 100 | + ); |
|
| 101 | + $this->_cpt_edit_routes = array( |
|
| 102 | + 'espresso_attendees' => 'edit_attendee', |
|
| 103 | + ); |
|
| 104 | + $this->_pagenow_map = array( |
|
| 105 | + 'add_new_attendee' => 'post-new.php', |
|
| 106 | + 'edit_attendee' => 'post.php', |
|
| 107 | + 'trash' => 'post.php', |
|
| 108 | + ); |
|
| 109 | + add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10); |
|
| 110 | + //add filters so that the comment urls don't take users to a confusing 404 page |
|
| 111 | + add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3); |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + |
|
| 115 | + public function clear_comment_link($link, $comment, $args) |
|
| 116 | + { |
|
| 117 | + //gotta make sure this only happens on this route |
|
| 118 | + $post_type = get_post_type($comment->comment_post_ID); |
|
| 119 | + if ($post_type === 'espresso_attendees') { |
|
| 120 | + return '#commentsdiv'; |
|
| 121 | + } |
|
| 122 | + return $link; |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + |
|
| 126 | + protected function _ajax_hooks() |
|
| 127 | + { |
|
| 128 | + //todo: all hooks for registrations ajax goes in here |
|
| 129 | + add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status')); |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + |
|
| 133 | + protected function _define_page_props() |
|
| 134 | + { |
|
| 135 | + $this->_admin_page_title = $this->page_label; |
|
| 136 | + $this->_labels = array( |
|
| 137 | + 'buttons' => array( |
|
| 138 | + 'add-registrant' => __('Add New Registration', 'event_espresso'), |
|
| 139 | + 'add-attendee' => __('Add Contact', 'event_espresso'), |
|
| 140 | + 'edit' => __('Edit Contact', 'event_espresso'), |
|
| 141 | + 'report' => __("Event Registrations CSV Report", "event_espresso"), |
|
| 142 | + 'report_all' => __('All Registrations CSV Report', 'event_espresso'), |
|
| 143 | + 'report_filtered' => __('Filtered CSV Report', 'event_espresso'), |
|
| 144 | + 'contact_list_report' => __('Contact List Report', 'event_espresso'), |
|
| 145 | + 'contact_list_export' => __("Export Data", "event_espresso"), |
|
| 146 | + ), |
|
| 147 | + 'publishbox' => array( |
|
| 148 | + 'add_new_attendee' => __("Add Contact Record", 'event_espresso'), |
|
| 149 | + 'edit_attendee' => __("Update Contact Record", 'event_espresso'), |
|
| 150 | + ), |
|
| 151 | + 'hide_add_button_on_cpt_route' => array( |
|
| 152 | + 'edit_attendee' => true, |
|
| 153 | + ), |
|
| 154 | + ); |
|
| 155 | + } |
|
| 156 | + |
|
| 157 | + |
|
| 158 | + /** |
|
| 159 | + * grab url requests and route them |
|
| 160 | + * |
|
| 161 | + * @access private |
|
| 162 | + * @return void |
|
| 163 | + */ |
|
| 164 | + public function _set_page_routes() |
|
| 165 | + { |
|
| 166 | + $this->_get_registration_status_array(); |
|
| 167 | + $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID']) |
|
| 168 | + ? $this->_req_data['_REG_ID'] : 0; |
|
| 169 | + $att_id = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID']) |
|
| 170 | + ? $this->_req_data['ATT_ID'] : 0; |
|
| 171 | + $att_id = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post']) ? $this->_req_data['post'] |
|
| 172 | + : $att_id; |
|
| 173 | + $this->_page_routes = array( |
|
| 174 | + 'default' => array( |
|
| 175 | + 'func' => '_registrations_overview_list_table', |
|
| 176 | + 'capability' => 'ee_read_registrations', |
|
| 177 | + ), |
|
| 178 | + 'view_registration' => array( |
|
| 179 | + 'func' => '_registration_details', |
|
| 180 | + 'capability' => 'ee_read_registration', |
|
| 181 | + 'obj_id' => $reg_id, |
|
| 182 | + ), |
|
| 183 | + 'edit_registration' => array( |
|
| 184 | + 'func' => '_update_attendee_registration_form', |
|
| 185 | + 'noheader' => true, |
|
| 186 | + 'headers_sent_route' => 'view_registration', |
|
| 187 | + 'capability' => 'ee_edit_registration', |
|
| 188 | + 'obj_id' => $reg_id, |
|
| 189 | + '_REG_ID' => $reg_id, |
|
| 190 | + ), |
|
| 191 | + 'trash_registrations' => array( |
|
| 192 | + 'func' => '_trash_or_restore_registrations', |
|
| 193 | + 'args' => array('trash' => true), |
|
| 194 | + 'noheader' => true, |
|
| 195 | + 'capability' => 'ee_delete_registrations', |
|
| 196 | + ), |
|
| 197 | + 'restore_registrations' => array( |
|
| 198 | + 'func' => '_trash_or_restore_registrations', |
|
| 199 | + 'args' => array('trash' => false), |
|
| 200 | + 'noheader' => true, |
|
| 201 | + 'capability' => 'ee_delete_registrations', |
|
| 202 | + ), |
|
| 203 | + 'delete_registrations' => array( |
|
| 204 | + 'func' => '_delete_registrations', |
|
| 205 | + 'noheader' => true, |
|
| 206 | + 'capability' => 'ee_delete_registrations', |
|
| 207 | + ), |
|
| 208 | + 'new_registration' => array( |
|
| 209 | + 'func' => 'new_registration', |
|
| 210 | + 'capability' => 'ee_edit_registrations', |
|
| 211 | + ), |
|
| 212 | + 'process_reg_step' => array( |
|
| 213 | + 'func' => 'process_reg_step', |
|
| 214 | + 'noheader' => true, |
|
| 215 | + 'capability' => 'ee_edit_registrations', |
|
| 216 | + ), |
|
| 217 | + 'redirect_to_txn' => array( |
|
| 218 | + 'func' => 'redirect_to_txn', |
|
| 219 | + 'noheader' => true, |
|
| 220 | + 'capability' => 'ee_edit_registrations', |
|
| 221 | + ), |
|
| 222 | + 'change_reg_status' => array( |
|
| 223 | + 'func' => '_change_reg_status', |
|
| 224 | + 'noheader' => true, |
|
| 225 | + 'capability' => 'ee_edit_registration', |
|
| 226 | + 'obj_id' => $reg_id, |
|
| 227 | + ), |
|
| 228 | + 'approve_registration' => array( |
|
| 229 | + 'func' => 'approve_registration', |
|
| 230 | + 'noheader' => true, |
|
| 231 | + 'capability' => 'ee_edit_registration', |
|
| 232 | + 'obj_id' => $reg_id, |
|
| 233 | + ), |
|
| 234 | + 'approve_and_notify_registration' => array( |
|
| 235 | + 'func' => 'approve_registration', |
|
| 236 | + 'noheader' => true, |
|
| 237 | + 'args' => array(true), |
|
| 238 | + 'capability' => 'ee_edit_registration', |
|
| 239 | + 'obj_id' => $reg_id, |
|
| 240 | + ), |
|
| 241 | + 'decline_registration' => array( |
|
| 242 | + 'func' => 'decline_registration', |
|
| 243 | + 'noheader' => true, |
|
| 244 | + 'capability' => 'ee_edit_registration', |
|
| 245 | + 'obj_id' => $reg_id, |
|
| 246 | + ), |
|
| 247 | + 'decline_and_notify_registration' => array( |
|
| 248 | + 'func' => 'decline_registration', |
|
| 249 | + 'noheader' => true, |
|
| 250 | + 'args' => array(true), |
|
| 251 | + 'capability' => 'ee_edit_registration', |
|
| 252 | + 'obj_id' => $reg_id, |
|
| 253 | + ), |
|
| 254 | + 'pending_registration' => array( |
|
| 255 | + 'func' => 'pending_registration', |
|
| 256 | + 'noheader' => true, |
|
| 257 | + 'capability' => 'ee_edit_registration', |
|
| 258 | + 'obj_id' => $reg_id, |
|
| 259 | + ), |
|
| 260 | + 'pending_and_notify_registration' => array( |
|
| 261 | + 'func' => 'pending_registration', |
|
| 262 | + 'noheader' => true, |
|
| 263 | + 'args' => array(true), |
|
| 264 | + 'capability' => 'ee_edit_registration', |
|
| 265 | + 'obj_id' => $reg_id, |
|
| 266 | + ), |
|
| 267 | + 'no_approve_registration' => array( |
|
| 268 | + 'func' => 'not_approve_registration', |
|
| 269 | + 'noheader' => true, |
|
| 270 | + 'capability' => 'ee_edit_registration', |
|
| 271 | + 'obj_id' => $reg_id, |
|
| 272 | + ), |
|
| 273 | + 'no_approve_and_notify_registration' => array( |
|
| 274 | + 'func' => 'not_approve_registration', |
|
| 275 | + 'noheader' => true, |
|
| 276 | + 'args' => array(true), |
|
| 277 | + 'capability' => 'ee_edit_registration', |
|
| 278 | + 'obj_id' => $reg_id, |
|
| 279 | + ), |
|
| 280 | + 'cancel_registration' => array( |
|
| 281 | + 'func' => 'cancel_registration', |
|
| 282 | + 'noheader' => true, |
|
| 283 | + 'capability' => 'ee_edit_registration', |
|
| 284 | + 'obj_id' => $reg_id, |
|
| 285 | + ), |
|
| 286 | + 'cancel_and_notify_registration' => array( |
|
| 287 | + 'func' => 'cancel_registration', |
|
| 288 | + 'noheader' => true, |
|
| 289 | + 'args' => array(true), |
|
| 290 | + 'capability' => 'ee_edit_registration', |
|
| 291 | + 'obj_id' => $reg_id, |
|
| 292 | + ), |
|
| 293 | + 'contact_list' => array( |
|
| 294 | + 'func' => '_attendee_contact_list_table', |
|
| 295 | + 'capability' => 'ee_read_contacts', |
|
| 296 | + ), |
|
| 297 | + 'add_new_attendee' => array( |
|
| 298 | + 'func' => '_create_new_cpt_item', |
|
| 299 | + 'args' => array( |
|
| 300 | + 'new_attendee' => true, |
|
| 301 | + 'capability' => 'ee_edit_contacts', |
|
| 302 | + ), |
|
| 303 | + ), |
|
| 304 | + 'edit_attendee' => array( |
|
| 305 | + 'func' => '_edit_cpt_item', |
|
| 306 | + 'capability' => 'ee_edit_contacts', |
|
| 307 | + 'obj_id' => $att_id, |
|
| 308 | + ), |
|
| 309 | + 'duplicate_attendee' => array( |
|
| 310 | + 'func' => '_duplicate_attendee', |
|
| 311 | + 'noheader' => true, |
|
| 312 | + 'capability' => 'ee_edit_contacts', |
|
| 313 | + 'obj_id' => $att_id, |
|
| 314 | + ), |
|
| 315 | + 'insert_attendee' => array( |
|
| 316 | + 'func' => '_insert_or_update_attendee', |
|
| 317 | + 'args' => array( |
|
| 318 | + 'new_attendee' => true, |
|
| 319 | + ), |
|
| 320 | + 'noheader' => true, |
|
| 321 | + 'capability' => 'ee_edit_contacts', |
|
| 322 | + ), |
|
| 323 | + 'update_attendee' => array( |
|
| 324 | + 'func' => '_insert_or_update_attendee', |
|
| 325 | + 'args' => array( |
|
| 326 | + 'new_attendee' => false, |
|
| 327 | + ), |
|
| 328 | + 'noheader' => true, |
|
| 329 | + 'capability' => 'ee_edit_contacts', |
|
| 330 | + 'obj_id' => $att_id, |
|
| 331 | + ), |
|
| 332 | + 'trash_attendee' => array( |
|
| 333 | + 'func' => '_trash_or_restore_attendees', |
|
| 334 | + 'args' => array( |
|
| 335 | + 'trash' => true, |
|
| 336 | + ), |
|
| 337 | + 'noheader' => true, |
|
| 338 | + 'capability' => 'ee_delete_contacts', |
|
| 339 | + 'obj_id' => $att_id, |
|
| 340 | + ), |
|
| 341 | + 'restore_attendees' => array( |
|
| 342 | + 'func' => '_trash_or_restore_attendees', |
|
| 343 | + 'args' => array( |
|
| 344 | + 'trash' => false, |
|
| 345 | + ), |
|
| 346 | + 'noheader' => true, |
|
| 347 | + 'capability' => 'ee_delete_contacts', |
|
| 348 | + 'obj_id' => $att_id, |
|
| 349 | + ), |
|
| 350 | + 'resend_registration' => array( |
|
| 351 | + 'func' => '_resend_registration', |
|
| 352 | + 'noheader' => true, |
|
| 353 | + 'capability' => 'ee_send_message', |
|
| 354 | + ), |
|
| 355 | + 'registrations_report' => array( |
|
| 356 | + 'func' => '_registrations_report', |
|
| 357 | + 'noheader' => true, |
|
| 358 | + 'capability' => 'ee_read_registrations', |
|
| 359 | + ), |
|
| 360 | + 'contact_list_export' => array( |
|
| 361 | + 'func' => '_contact_list_export', |
|
| 362 | + 'noheader' => true, |
|
| 363 | + 'capability' => 'export', |
|
| 364 | + ), |
|
| 365 | + 'contact_list_report' => array( |
|
| 366 | + 'func' => '_contact_list_report', |
|
| 367 | + 'noheader' => true, |
|
| 368 | + 'capability' => 'ee_read_contacts', |
|
| 369 | + ), |
|
| 370 | + ); |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + |
|
| 374 | + protected function _set_page_config() |
|
| 375 | + { |
|
| 376 | + $this->_page_config = array( |
|
| 377 | + 'default' => array( |
|
| 378 | + 'nav' => array( |
|
| 379 | + 'label' => __('Overview', 'event_espresso'), |
|
| 380 | + 'order' => 5, |
|
| 381 | + ), |
|
| 382 | + 'help_tabs' => array( |
|
| 383 | + 'registrations_overview_help_tab' => array( |
|
| 384 | + 'title' => __('Registrations Overview', 'event_espresso'), |
|
| 385 | + 'filename' => 'registrations_overview', |
|
| 386 | + ), |
|
| 387 | + 'registrations_overview_table_column_headings_help_tab' => array( |
|
| 388 | + 'title' => __('Registrations Table Column Headings', 'event_espresso'), |
|
| 389 | + 'filename' => 'registrations_overview_table_column_headings', |
|
| 390 | + ), |
|
| 391 | + 'registrations_overview_filters_help_tab' => array( |
|
| 392 | + 'title' => __('Registration Filters', 'event_espresso'), |
|
| 393 | + 'filename' => 'registrations_overview_filters', |
|
| 394 | + ), |
|
| 395 | + 'registrations_overview_views_help_tab' => array( |
|
| 396 | + 'title' => __('Registration Views', 'event_espresso'), |
|
| 397 | + 'filename' => 'registrations_overview_views', |
|
| 398 | + ), |
|
| 399 | + 'registrations_regoverview_other_help_tab' => array( |
|
| 400 | + 'title' => __('Registrations Other', 'event_espresso'), |
|
| 401 | + 'filename' => 'registrations_overview_other', |
|
| 402 | + ), |
|
| 403 | + ), |
|
| 404 | + 'help_tour' => array('Registration_Overview_Help_Tour'), |
|
| 405 | + 'qtips' => array('Registration_List_Table_Tips'), |
|
| 406 | + 'list_table' => 'EE_Registrations_List_Table', |
|
| 407 | + 'require_nonce' => false, |
|
| 408 | + ), |
|
| 409 | + 'view_registration' => array( |
|
| 410 | + 'nav' => array( |
|
| 411 | + 'label' => __('REG Details', 'event_espresso'), |
|
| 412 | + 'order' => 15, |
|
| 413 | + 'url' => isset($this->_req_data['_REG_ID']) |
|
| 414 | + ? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url) |
|
| 415 | + : $this->_admin_base_url, |
|
| 416 | + 'persistent' => false, |
|
| 417 | + ), |
|
| 418 | + 'help_tabs' => array( |
|
| 419 | + 'registrations_details_help_tab' => array( |
|
| 420 | + 'title' => __('Registration Details', 'event_espresso'), |
|
| 421 | + 'filename' => 'registrations_details', |
|
| 422 | + ), |
|
| 423 | + 'registrations_details_table_help_tab' => array( |
|
| 424 | + 'title' => __('Registration Details Table', 'event_espresso'), |
|
| 425 | + 'filename' => 'registrations_details_table', |
|
| 426 | + ), |
|
| 427 | + 'registrations_details_form_answers_help_tab' => array( |
|
| 428 | + 'title' => __('Registration Form Answers', 'event_espresso'), |
|
| 429 | + 'filename' => 'registrations_details_form_answers', |
|
| 430 | + ), |
|
| 431 | + 'registrations_details_registrant_details_help_tab' => array( |
|
| 432 | + 'title' => __('Contact Details', 'event_espresso'), |
|
| 433 | + 'filename' => 'registrations_details_registrant_details', |
|
| 434 | + ), |
|
| 435 | + ), |
|
| 436 | + 'help_tour' => array('Registration_Details_Help_Tour'), |
|
| 437 | + 'metaboxes' => array_merge($this->_default_espresso_metaboxes, |
|
| 438 | + array('_registration_details_metaboxes')), |
|
| 439 | + 'require_nonce' => false, |
|
| 440 | + ), |
|
| 441 | + 'new_registration' => array( |
|
| 442 | + 'nav' => array( |
|
| 443 | + 'label' => __('Add New Registration', 'event_espresso'), |
|
| 444 | + 'url' => '#', |
|
| 445 | + 'order' => 15, |
|
| 446 | + 'persistent' => false, |
|
| 447 | + ), |
|
| 448 | + 'metaboxes' => $this->_default_espresso_metaboxes, |
|
| 449 | + 'labels' => array( |
|
| 450 | + 'publishbox' => __('Save Registration', 'event_espresso'), |
|
| 451 | + ), |
|
| 452 | + 'require_nonce' => false, |
|
| 453 | + ), |
|
| 454 | + 'add_new_attendee' => array( |
|
| 455 | + 'nav' => array( |
|
| 456 | + 'label' => __('Add Contact', 'event_espresso'), |
|
| 457 | + 'order' => 15, |
|
| 458 | + 'persistent' => false, |
|
| 459 | + ), |
|
| 460 | + 'metaboxes' => array_merge($this->_default_espresso_metaboxes, |
|
| 461 | + array('_publish_post_box', 'attendee_editor_metaboxes')), |
|
| 462 | + 'require_nonce' => false, |
|
| 463 | + ), |
|
| 464 | + 'edit_attendee' => array( |
|
| 465 | + 'nav' => array( |
|
| 466 | + 'label' => __('Edit Contact', 'event_espresso'), |
|
| 467 | + 'order' => 15, |
|
| 468 | + 'persistent' => false, |
|
| 469 | + 'url' => isset($this->_req_data['ATT_ID']) |
|
| 470 | + ? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url) |
|
| 471 | + : $this->_admin_base_url, |
|
| 472 | + ), |
|
| 473 | + 'metaboxes' => array('attendee_editor_metaboxes'), |
|
| 474 | + 'require_nonce' => false, |
|
| 475 | + ), |
|
| 476 | + 'contact_list' => array( |
|
| 477 | + 'nav' => array( |
|
| 478 | + 'label' => __('Contact List', 'event_espresso'), |
|
| 479 | + 'order' => 20, |
|
| 480 | + ), |
|
| 481 | + 'list_table' => 'EE_Attendee_Contact_List_Table', |
|
| 482 | + 'help_tabs' => array( |
|
| 483 | + 'registrations_contact_list_help_tab' => array( |
|
| 484 | + 'title' => __('Registrations Contact List', 'event_espresso'), |
|
| 485 | + 'filename' => 'registrations_contact_list', |
|
| 486 | + ), |
|
| 487 | + 'registrations_contact-list_table_column_headings_help_tab' => array( |
|
| 488 | + 'title' => __('Contact List Table Column Headings', 'event_espresso'), |
|
| 489 | + 'filename' => 'registrations_contact_list_table_column_headings', |
|
| 490 | + ), |
|
| 491 | + 'registrations_contact_list_views_help_tab' => array( |
|
| 492 | + 'title' => __('Contact List Views', 'event_espresso'), |
|
| 493 | + 'filename' => 'registrations_contact_list_views', |
|
| 494 | + ), |
|
| 495 | + 'registrations_contact_list_other_help_tab' => array( |
|
| 496 | + 'title' => __('Contact List Other', 'event_espresso'), |
|
| 497 | + 'filename' => 'registrations_contact_list_other', |
|
| 498 | + ), |
|
| 499 | + ), |
|
| 500 | + 'help_tour' => array('Contact_List_Help_Tour'), |
|
| 501 | + 'metaboxes' => array(), |
|
| 502 | + 'require_nonce' => false, |
|
| 503 | + ), |
|
| 504 | + //override default cpt routes |
|
| 505 | + 'create_new' => '', |
|
| 506 | + 'edit' => '', |
|
| 507 | + ); |
|
| 508 | + } |
|
| 509 | + |
|
| 510 | + |
|
| 511 | + /** |
|
| 512 | + * The below methods aren't used by this class currently |
|
| 513 | + */ |
|
| 514 | + protected function _add_screen_options() |
|
| 515 | + { |
|
| 516 | + } |
|
| 517 | + |
|
| 518 | + |
|
| 519 | + protected function _add_feature_pointers() |
|
| 520 | + { |
|
| 521 | + } |
|
| 522 | + |
|
| 523 | + |
|
| 524 | + public function admin_init() |
|
| 525 | + { |
|
| 526 | + EE_Registry::$i18n_js_strings['update_att_qstns'] = __('click "Update Registration Questions" to save your changes', |
|
| 527 | + 'event_espresso'); |
|
| 528 | + } |
|
| 529 | + |
|
| 530 | + |
|
| 531 | + public function admin_notices() |
|
| 532 | + { |
|
| 533 | + } |
|
| 534 | + |
|
| 535 | + |
|
| 536 | + public function admin_footer_scripts() |
|
| 537 | + { |
|
| 538 | + } |
|
| 539 | + |
|
| 540 | + |
|
| 541 | + /** |
|
| 542 | + * get list of registration statuses |
|
| 543 | + * |
|
| 544 | + * @access private |
|
| 545 | + * @return void |
|
| 546 | + */ |
|
| 547 | + private function _get_registration_status_array() |
|
| 548 | + { |
|
| 549 | + self::$_reg_status = EEM_Registration::reg_status_array(array(), true); |
|
| 550 | + } |
|
| 551 | + |
|
| 552 | + |
|
| 553 | + protected function _add_screen_options_default() |
|
| 554 | + { |
|
| 555 | + $this->_per_page_screen_option(); |
|
| 556 | + } |
|
| 557 | + |
|
| 558 | + |
|
| 559 | + protected function _add_screen_options_contact_list() |
|
| 560 | + { |
|
| 561 | + $page_title = $this->_admin_page_title; |
|
| 562 | + $this->_admin_page_title = __("Contacts", 'event_espresso'); |
|
| 563 | + $this->_per_page_screen_option(); |
|
| 564 | + $this->_admin_page_title = $page_title; |
|
| 565 | + } |
|
| 566 | + |
|
| 567 | + |
|
| 568 | + public function load_scripts_styles() |
|
| 569 | + { |
|
| 570 | + //style |
|
| 571 | + //wp_register_style('espresso_attendees', ATT_ASSETS_URL . 'espresso_attendees_admin.css', array(), EVENT_ESPRESSO_VERSION ); |
|
| 572 | + wp_register_style('espresso_reg', REG_ASSETS_URL . 'espresso_registrations_admin.css', array('ee-admin-css'), |
|
| 573 | + EVENT_ESPRESSO_VERSION); |
|
| 574 | + wp_enqueue_style('espresso_reg'); |
|
| 575 | + //script |
|
| 576 | + wp_register_script('espresso_reg', REG_ASSETS_URL . 'espresso_registrations_admin.js', |
|
| 577 | + array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'), EVENT_ESPRESSO_VERSION, true); |
|
| 578 | + wp_enqueue_script('espresso_reg'); |
|
| 579 | + } |
|
| 580 | + |
|
| 581 | + |
|
| 582 | + public function load_scripts_styles_edit_attendee() |
|
| 583 | + { |
|
| 584 | + //stuff to only show up on our attendee edit details page. |
|
| 585 | + $attendee_details_translations = array( |
|
| 586 | + 'att_publish_text' => sprintf(__('Created on: <b>%1$s</b>', 'event_espresso'), |
|
| 587 | + $this->_cpt_model_obj->get_datetime('ATT_created')), |
|
| 588 | + ); |
|
| 589 | + wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations); |
|
| 590 | + wp_enqueue_script('jquery-validate'); |
|
| 591 | + } |
|
| 592 | + |
|
| 593 | + |
|
| 594 | + public function load_scripts_styles_view_registration() |
|
| 595 | + { |
|
| 596 | + //styles |
|
| 597 | + wp_enqueue_style('espresso-ui-theme'); |
|
| 598 | + //scripts |
|
| 599 | + $this->_get_reg_custom_questions_form($this->_registration->ID()); |
|
| 600 | + $this->_reg_custom_questions_form->wp_enqueue_scripts(true); |
|
| 601 | + } |
|
| 602 | + |
|
| 603 | + |
|
| 604 | + public function load_scripts_styles_contact_list() |
|
| 605 | + { |
|
| 606 | + wp_deregister_style('espresso_reg'); |
|
| 607 | + wp_register_style('espresso_att', REG_ASSETS_URL . 'espresso_attendees_admin.css', array('ee-admin-css'), |
|
| 608 | + EVENT_ESPRESSO_VERSION); |
|
| 609 | + wp_enqueue_style('espresso_att'); |
|
| 610 | + } |
|
| 611 | + |
|
| 612 | + |
|
| 613 | + public function load_scripts_styles_new_registration() |
|
| 614 | + { |
|
| 615 | + wp_register_script('ee-spco-for-admin', REG_ASSETS_URL . 'spco_for_admin.js', array('underscore', 'jquery'), |
|
| 616 | + EVENT_ESPRESSO_VERSION, true); |
|
| 617 | + wp_enqueue_script('ee-spco-for-admin'); |
|
| 618 | + add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true'); |
|
| 619 | + EE_Form_Section_Proper::wp_enqueue_scripts(); |
|
| 620 | + EED_Ticket_Selector::load_tckt_slctr_assets(); |
|
| 621 | + EE_Datepicker_Input::enqueue_styles_and_scripts(); |
|
| 622 | + } |
|
| 623 | + |
|
| 624 | + |
|
| 625 | + public function AHEE__EE_Admin_Page__route_admin_request_resend_registration() |
|
| 626 | + { |
|
| 627 | + add_filter('FHEE_load_EE_messages', '__return_true'); |
|
| 628 | + } |
|
| 629 | + |
|
| 630 | + |
|
| 631 | + public function AHEE__EE_Admin_Page__route_admin_request_approve_registration() |
|
| 632 | + { |
|
| 633 | + add_filter('FHEE_load_EE_messages', '__return_true'); |
|
| 634 | + } |
|
| 635 | + |
|
| 636 | + |
|
| 637 | + protected function _set_list_table_views_default() |
|
| 638 | + { |
|
| 639 | + //for notification related bulk actions we need to make sure only active messengers have an option. |
|
| 640 | + EED_Messages::set_autoloaders(); |
|
| 641 | + /** @type EE_Message_Resource_Manager $message_resource_manager */ |
|
| 642 | + $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 643 | + $active_mts = $message_resource_manager->list_of_active_message_types(); |
|
| 644 | + //key= bulk_action_slug, value= message type. |
|
| 645 | + $match_array = array( |
|
| 646 | + 'approve_registration' => 'registration', |
|
| 647 | + 'decline_registration' => 'declined_registration', |
|
| 648 | + 'pending_registration' => 'pending_approval', |
|
| 649 | + 'no_approve_registration' => 'not_approved_registration', |
|
| 650 | + 'cancel_registration' => 'cancelled_registration', |
|
| 651 | + ); |
|
| 652 | + /** setup reg status bulk actions **/ |
|
| 653 | + $def_reg_status_actions['approve_registration'] = __('Approve Registrations', 'event_espresso'); |
|
| 654 | + if (in_array($match_array['approve_registration'], $active_mts) |
|
| 655 | + && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages') |
|
| 656 | + ) { |
|
| 657 | + $def_reg_status_actions['approve_and_notify_registration'] = __('Approve and Notify Registrations', |
|
| 658 | + 'event_espresso'); |
|
| 659 | + } |
|
| 660 | + $def_reg_status_actions['decline_registration'] = __('Decline Registrations', 'event_espresso'); |
|
| 661 | + if (in_array($match_array['decline_registration'], $active_mts) |
|
| 662 | + && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages') |
|
| 663 | + ) { |
|
| 664 | + $def_reg_status_actions['decline_and_notify_registration'] = __('Decline and Notify Registrations', |
|
| 665 | + 'event_espresso'); |
|
| 666 | + } |
|
| 667 | + $def_reg_status_actions['pending_registration'] = __('Set Registrations to Pending Payment', 'event_espresso'); |
|
| 668 | + if (in_array($match_array['pending_registration'], $active_mts) |
|
| 669 | + && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages') |
|
| 670 | + ) { |
|
| 671 | + $def_reg_status_actions['pending_and_notify_registration'] = __('Set Registrations to Pending Payment and Notify', |
|
| 672 | + 'event_espresso'); |
|
| 673 | + } |
|
| 674 | + $def_reg_status_actions['no_approve_registration'] = __('Set Registrations to Not Approved', 'event_espresso'); |
|
| 675 | + if (in_array($match_array['no_approve_registration'], $active_mts) |
|
| 676 | + && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages') |
|
| 677 | + ) { |
|
| 678 | + $def_reg_status_actions['no_approve_and_notify_registration'] = __('Set Registrations to Not Approved and Notify', |
|
| 679 | + 'event_espresso'); |
|
| 680 | + } |
|
| 681 | + $def_reg_status_actions['cancel_registration'] = __('Cancel Registrations', 'event_espresso'); |
|
| 682 | + if (in_array($match_array['cancel_registration'], $active_mts) |
|
| 683 | + && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages') |
|
| 684 | + ) { |
|
| 685 | + $def_reg_status_actions['cancel_and_notify_registration'] = __('Cancel Registrations and Notify', |
|
| 686 | + 'event_espresso'); |
|
| 687 | + } |
|
| 688 | + $this->_views = array( |
|
| 689 | + 'all' => array( |
|
| 690 | + 'slug' => 'all', |
|
| 691 | + 'label' => __('View All Registrations', 'event_espresso'), |
|
| 692 | + 'count' => 0, |
|
| 693 | + 'bulk_action' => array_merge($def_reg_status_actions, array( |
|
| 694 | + 'trash_registrations' => __('Trash Registrations', 'event_espresso'), |
|
| 695 | + )), |
|
| 696 | + ), |
|
| 697 | + 'month' => array( |
|
| 698 | + 'slug' => 'month', |
|
| 699 | + 'label' => __('This Month', 'event_espresso'), |
|
| 700 | + 'count' => 0, |
|
| 701 | + 'bulk_action' => array_merge($def_reg_status_actions, array( |
|
| 702 | + 'trash_registrations' => __('Trash Registrations', 'event_espresso'), |
|
| 703 | + )), |
|
| 704 | + ), |
|
| 705 | + 'today' => array( |
|
| 706 | + 'slug' => 'today', |
|
| 707 | + 'label' => sprintf(__('Today - %s', 'event_espresso'), date('M d, Y', current_time('timestamp'))), |
|
| 708 | + 'count' => 0, |
|
| 709 | + 'bulk_action' => array_merge($def_reg_status_actions, array( |
|
| 710 | + 'trash_registrations' => __('Trash Registrations', 'event_espresso'), |
|
| 711 | + )), |
|
| 712 | + ), |
|
| 713 | + ); |
|
| 714 | + if (EE_Registry::instance()->CAP->current_user_can('ee_delete_registrations', |
|
| 715 | + 'espresso_registrations_delete_registration') |
|
| 716 | + ) { |
|
| 717 | + $this->_views['incomplete'] = array( |
|
| 718 | + 'slug' => 'incomplete', |
|
| 719 | + 'label' => __('Incomplete', 'event_espresso'), |
|
| 720 | + 'count' => 0, |
|
| 721 | + 'bulk_action' => array( |
|
| 722 | + 'trash_registrations' => __('Trash Registrations', 'event_espresso'), |
|
| 723 | + ), |
|
| 724 | + ); |
|
| 725 | + $this->_views['trash'] = array( |
|
| 726 | + 'slug' => 'trash', |
|
| 727 | + 'label' => __('Trash', 'event_espresso'), |
|
| 728 | + 'count' => 0, |
|
| 729 | + 'bulk_action' => array( |
|
| 730 | + 'restore_registrations' => __('Restore Registrations', 'event_espresso'), |
|
| 731 | + 'delete_registrations' => __('Delete Registrations Permanently', 'event_espresso'), |
|
| 732 | + ), |
|
| 733 | + ); |
|
| 734 | + } |
|
| 735 | + } |
|
| 736 | + |
|
| 737 | + |
|
| 738 | + protected function _set_list_table_views_contact_list() |
|
| 739 | + { |
|
| 740 | + $this->_views = array( |
|
| 741 | + 'in_use' => array( |
|
| 742 | + 'slug' => 'in_use', |
|
| 743 | + 'label' => __('In Use', 'event_espresso'), |
|
| 744 | + 'count' => 0, |
|
| 745 | + 'bulk_action' => array( |
|
| 746 | + 'trash_attendee' => __('Move to Trash', 'event_espresso'), |
|
| 747 | + ), |
|
| 748 | + ), |
|
| 749 | + ); |
|
| 750 | + if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts', |
|
| 751 | + 'espresso_registrations_trash_attendees') |
|
| 752 | + ) { |
|
| 753 | + $this->_views['trash'] = array( |
|
| 754 | + 'slug' => 'trash', |
|
| 755 | + 'label' => __('Trash', 'event_espresso'), |
|
| 756 | + 'count' => 0, |
|
| 757 | + 'bulk_action' => array( |
|
| 758 | + 'restore_attendees' => __('Restore from Trash', 'event_espresso'), |
|
| 759 | + ), |
|
| 760 | + ); |
|
| 761 | + } |
|
| 762 | + } |
|
| 763 | + |
|
| 764 | + |
|
| 765 | + protected function _registration_legend_items() |
|
| 766 | + { |
|
| 767 | + $fc_items = array( |
|
| 768 | + 'star-icon' => array( |
|
| 769 | + 'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8', |
|
| 770 | + 'desc' => __('This is the Primary Registrant', 'event_espresso'), |
|
| 771 | + ), |
|
| 772 | + 'view_details' => array( |
|
| 773 | + 'class' => 'dashicons dashicons-clipboard', |
|
| 774 | + 'desc' => __('View Registration Details', 'event_espresso'), |
|
| 775 | + ), |
|
| 776 | + 'edit_attendee' => array( |
|
| 777 | + 'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16', |
|
| 778 | + 'desc' => __('Edit Contact Details', 'event_espresso'), |
|
| 779 | + ), |
|
| 780 | + 'view_transaction' => array( |
|
| 781 | + 'class' => 'dashicons dashicons-cart', |
|
| 782 | + 'desc' => __('View Transaction Details', 'event_espresso'), |
|
| 783 | + ), |
|
| 784 | + 'view_invoice' => array( |
|
| 785 | + 'class' => 'dashicons dashicons-media-spreadsheet', |
|
| 786 | + 'desc' => __('View Transaction Invoice', 'event_espresso'), |
|
| 787 | + ), |
|
| 788 | + ); |
|
| 789 | + if (EE_Registry::instance()->CAP->current_user_can('ee_send_message', |
|
| 790 | + 'espresso_registrations_resend_registration') |
|
| 791 | + ) { |
|
| 792 | + $fc_items['resend_registration'] = array( |
|
| 793 | + 'class' => 'dashicons dashicons-email-alt', |
|
| 794 | + 'desc' => __('Resend Registration Details', 'event_espresso'), |
|
| 795 | + ); |
|
| 796 | + } else { |
|
| 797 | + $fc_items['blank'] = array('class' => 'blank', 'desc' => ''); |
|
| 798 | + } |
|
| 799 | + if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) { |
|
| 800 | + $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for'); |
|
| 801 | + if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) { |
|
| 802 | + $fc_items['view_related_messages'] = array( |
|
| 803 | + 'class' => $related_for_icon['css_class'], |
|
| 804 | + 'desc' => $related_for_icon['label'], |
|
| 805 | + ); |
|
| 806 | + } |
|
| 807 | + } |
|
| 808 | + $sc_items = array( |
|
| 809 | + 'approved_status' => array( |
|
| 810 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved, |
|
| 811 | + 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'), |
|
| 812 | + ), |
|
| 813 | + 'pending_status' => array( |
|
| 814 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment, |
|
| 815 | + 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'), |
|
| 816 | + ), |
|
| 817 | + 'wait_list' => array( |
|
| 818 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list, |
|
| 819 | + 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'), |
|
| 820 | + ), |
|
| 821 | + 'incomplete_status' => array( |
|
| 822 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete, |
|
| 823 | + 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_incomplete, false, 'sentence'), |
|
| 824 | + ), |
|
| 825 | + 'not_approved' => array( |
|
| 826 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved, |
|
| 827 | + 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'), |
|
| 828 | + ), |
|
| 829 | + 'declined_status' => array( |
|
| 830 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined, |
|
| 831 | + 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'), |
|
| 832 | + ), |
|
| 833 | + 'cancelled_status' => array( |
|
| 834 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled, |
|
| 835 | + 'desc' => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'), |
|
| 836 | + ), |
|
| 837 | + ); |
|
| 838 | + return array_merge($fc_items, $sc_items); |
|
| 839 | + } |
|
| 840 | + |
|
| 841 | + |
|
| 842 | + |
|
| 843 | + /*************************************** REGISTRATION OVERVIEW **************************************/ |
|
| 844 | + /** |
|
| 845 | + * @throws \EE_Error |
|
| 846 | + */ |
|
| 847 | + protected function _registrations_overview_list_table() |
|
| 848 | + { |
|
| 849 | + $this->_template_args['admin_page_header'] = ''; |
|
| 850 | + $EVT_ID = ! empty($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : 0; |
|
| 851 | + if ($EVT_ID) { |
|
| 852 | + if (EE_Registry::instance()->CAP->current_user_can('ee_edit_registrations', |
|
| 853 | + 'espresso_registrations_new_registration', $EVT_ID) |
|
| 854 | + ) { |
|
| 855 | + $this->_admin_page_title .= ' ' . $this->get_action_link_or_button('new_registration', 'add-registrant', |
|
| 856 | + array('event_id' => $EVT_ID), 'add-new-h2'); |
|
| 857 | + } |
|
| 858 | + $event = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
| 859 | + if ($event instanceof EE_Event) { |
|
| 860 | + $this->_template_args['admin_page_header'] = sprintf(__('%s Viewing registrations for the event: %s%s', |
|
| 861 | + 'event_espresso'), '<h3 style="line-height:1.5em;">', |
|
| 862 | + '<br /><a href="' . EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 863 | + 'action' => 'edit', |
|
| 864 | + 'post' => $event->ID(), |
|
| 865 | + ), EVENTS_ADMIN_URL) . '"> ' . $event->get('EVT_name') . ' </a> ', '</h3>'); |
|
| 866 | + } |
|
| 867 | + $DTT_ID = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0; |
|
| 868 | + $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID); |
|
| 869 | + if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') { |
|
| 870 | + $this->_template_args['admin_page_header'] = substr($this->_template_args['admin_page_header'], 0, -5); |
|
| 871 | + $this->_template_args['admin_page_header'] .= ' <span class="drk-grey-text">'; |
|
| 872 | + $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>'; |
|
| 873 | + $this->_template_args['admin_page_header'] .= $datetime->name(); |
|
| 874 | + $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )'; |
|
| 875 | + $this->_template_args['admin_page_header'] .= '</span></h3>'; |
|
| 876 | + } |
|
| 877 | + } |
|
| 878 | + $this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items()); |
|
| 879 | + $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 880 | + } |
|
| 881 | + |
|
| 882 | + |
|
| 883 | + /** |
|
| 884 | + * This sets the _registration property for the registration details screen |
|
| 885 | + * |
|
| 886 | + * @access private |
|
| 887 | + * @return bool |
|
| 888 | + */ |
|
| 889 | + private function _set_registration_object() |
|
| 890 | + { |
|
| 891 | + //get out if we've already set the object |
|
| 892 | + if (is_object($this->_registration)) { |
|
| 893 | + return true; |
|
| 894 | + } |
|
| 895 | + $REG = EEM_Registration::instance(); |
|
| 896 | + $REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false; |
|
| 897 | + if ($this->_registration = $REG->get_one_by_ID($REG_ID)) { |
|
| 898 | + return true; |
|
| 899 | + } else { |
|
| 900 | + $error_msg = sprintf(__('An error occurred and the details for Registration ID #%s could not be retrieved.', |
|
| 901 | + 'event_espresso'), $REG_ID); |
|
| 902 | + EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 903 | + $this->_registration = null; |
|
| 904 | + return false; |
|
| 905 | + } |
|
| 906 | + } |
|
| 907 | + |
|
| 908 | + |
|
| 909 | + /** |
|
| 910 | + * Used to retrieve registrations for the list table. |
|
| 911 | + * |
|
| 912 | + * @param int $per_page |
|
| 913 | + * @param bool $count |
|
| 914 | + * @param bool $this_month |
|
| 915 | + * @param bool $today |
|
| 916 | + * @return \EE_Registration[]|int |
|
| 917 | + */ |
|
| 918 | + public function get_registrations( |
|
| 919 | + $per_page = 10, |
|
| 920 | + $count = false, |
|
| 921 | + $this_month = false, |
|
| 922 | + $today = false |
|
| 923 | + ) { |
|
| 924 | + if( $this_month ) { |
|
| 925 | + $this->_req_data['status'] = 'month'; |
|
| 926 | + } |
|
| 927 | + if( $today ) { |
|
| 928 | + $this->_req_data['status'] = 'today'; |
|
| 929 | + } |
|
| 930 | + $query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count); |
|
| 931 | + /** |
|
| 932 | + * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected |
|
| 933 | + * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093 |
|
| 934 | + * @see EEM_Base::get_all() |
|
| 935 | + */ |
|
| 936 | + $query_params['group_by'] = ''; |
|
| 937 | + |
|
| 938 | + return $count |
|
| 939 | + ? EEM_Registration::instance()->count($query_params) |
|
| 940 | + /** @type EE_Registration[] */ |
|
| 941 | + : EEM_Registration::instance()->get_all($query_params); |
|
| 942 | + } |
|
| 943 | + |
|
| 944 | + |
|
| 945 | + |
|
| 946 | + /** |
|
| 947 | + * Retrieves the query parameters to be used by the Registration model for getting registrations. |
|
| 948 | + * Note: this listens to values on the request for some of the query parameters. |
|
| 949 | + * |
|
| 950 | + * @param array $request |
|
| 951 | + * @param int $per_page |
|
| 952 | + * @param bool $count |
|
| 953 | + * @return array |
|
| 954 | + */ |
|
| 955 | + protected function _get_registration_query_parameters( |
|
| 956 | + $request = array(), |
|
| 957 | + $per_page = 10, |
|
| 958 | + $count = false |
|
| 959 | + ) { |
|
| 960 | + |
|
| 961 | + $query_params = array( |
|
| 962 | + 0 => $this->_get_where_conditions_for_registrations_query( |
|
| 963 | + $request |
|
| 964 | + ), |
|
| 965 | + 'caps' => EEM_Registration::caps_read_admin, |
|
| 966 | + 'default_where_conditions' => 'this_model_only', |
|
| 967 | + ); |
|
| 968 | + if ( ! $count) { |
|
| 969 | + $query_params = array_merge( |
|
| 970 | + $query_params, |
|
| 971 | + $this->_get_orderby_for_registrations_query(), |
|
| 972 | + $this->_get_limit($per_page) |
|
| 973 | + ); |
|
| 974 | + } |
|
| 975 | + |
|
| 976 | + return $query_params; |
|
| 977 | + } |
|
| 978 | + |
|
| 979 | + |
|
| 980 | + /** |
|
| 981 | + * This will add EVT_ID to the provided $where array for EE model query parameters. |
|
| 982 | + * |
|
| 983 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 984 | + * @return array |
|
| 985 | + */ |
|
| 986 | + protected function _add_event_id_to_where_conditions(array $request) |
|
| 987 | + { |
|
| 988 | + $where = array(); |
|
| 989 | + if ( ! empty($request['event_id'])) { |
|
| 990 | + $where['EVT_ID'] = absint($request['event_id']); |
|
| 991 | + } |
|
| 992 | + return $where; |
|
| 993 | + } |
|
| 994 | + |
|
| 995 | + |
|
| 996 | + /** |
|
| 997 | + * Adds category ID if it exists in the request to the where conditions for the registrations query. |
|
| 998 | + * |
|
| 999 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1000 | + * @return array |
|
| 1001 | + */ |
|
| 1002 | + protected function _add_category_id_to_where_conditions(array $request) |
|
| 1003 | + { |
|
| 1004 | + $where = array(); |
|
| 1005 | + if ( ! empty($request['EVT_CAT']) && (int)$request['EVT_CAT'] !== -1) { |
|
| 1006 | + $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']); |
|
| 1007 | + } |
|
| 1008 | + return $where; |
|
| 1009 | + } |
|
| 1010 | + |
|
| 1011 | + |
|
| 1012 | + /** |
|
| 1013 | + * Adds the datetime ID if it exists in the request to the where conditions for the registrations query. |
|
| 1014 | + * |
|
| 1015 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1016 | + * @return array |
|
| 1017 | + */ |
|
| 1018 | + protected function _add_datetime_id_to_where_conditions(array $request) |
|
| 1019 | + { |
|
| 1020 | + $where = array(); |
|
| 1021 | + if ( ! empty($request['datetime_id'])) { |
|
| 1022 | + $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']); |
|
| 1023 | + } |
|
| 1024 | + if( ! empty($request['DTT_ID'])){ |
|
| 1025 | + $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']); |
|
| 1026 | + } |
|
| 1027 | + return $where; |
|
| 1028 | + } |
|
| 1029 | + |
|
| 1030 | + |
|
| 1031 | + /** |
|
| 1032 | + * Adds the correct registration status to the where conditions for the registrations query. |
|
| 1033 | + * |
|
| 1034 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1035 | + * @return array |
|
| 1036 | + */ |
|
| 1037 | + protected function _add_registration_status_to_where_conditions(array $request) |
|
| 1038 | + { |
|
| 1039 | + $where = array(); |
|
| 1040 | + $view = EEH_Array::is_set( $request, 'status', '' ); |
|
| 1041 | + $registration_status = ! empty($request['_reg_status']) |
|
| 1042 | + ? sanitize_text_field($request['_reg_status']) |
|
| 1043 | + : ''; |
|
| 1044 | + |
|
| 1045 | + /* |
|
| 1046 | 1046 | * If filtering by registration status, then we show registrations matching that status. |
| 1047 | 1047 | * If not filtering by specified status, then we show all registrations excluding incomplete registrations UNLESS |
| 1048 | 1048 | * viewing trashed registrations. |
| 1049 | 1049 | */ |
| 1050 | - if ( ! empty($registration_status)) { |
|
| 1051 | - $where['STS_ID'] = $registration_status; |
|
| 1052 | - } else { |
|
| 1053 | - //make sure we exclude incomplete registrations, but only if not trashed. |
|
| 1054 | - if ($view === 'trash') { |
|
| 1055 | - $where['REG_deleted'] = true; |
|
| 1056 | - } else if ($view === 'incomplete') { |
|
| 1057 | - $where['STS_ID'] = EEM_Registration::status_id_incomplete; |
|
| 1058 | - } else { |
|
| 1059 | - $where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete); |
|
| 1060 | - } |
|
| 1061 | - } |
|
| 1062 | - return $where; |
|
| 1063 | - } |
|
| 1064 | - |
|
| 1065 | - |
|
| 1066 | - /** |
|
| 1067 | - * Adds any provided date restraints to the where conditions for the registrations query. |
|
| 1068 | - * |
|
| 1069 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1070 | - * @return array |
|
| 1071 | - */ |
|
| 1072 | - protected function _add_date_to_where_conditions(array $request) |
|
| 1073 | - { |
|
| 1074 | - $where = array(); |
|
| 1075 | - $view = EEH_Array::is_set( $request, 'status', '' ); |
|
| 1076 | - $month_range = ! empty($request['month_range']) |
|
| 1077 | - ? sanitize_text_field($request['month_range']) |
|
| 1078 | - : ''; |
|
| 1079 | - $retrieve_for_today = $view === 'today'; |
|
| 1080 | - $retrieve_for_this_month = $view === 'month'; |
|
| 1081 | - |
|
| 1082 | - if ($retrieve_for_today) { |
|
| 1083 | - $now = date('Y-m-d', current_time('timestamp')); |
|
| 1084 | - $where['REG_date'] = array( |
|
| 1085 | - 'BETWEEN', |
|
| 1086 | - array( |
|
| 1087 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1088 | - 'REG_date', |
|
| 1089 | - $now . ' 00:00:00', |
|
| 1090 | - 'Y-m-d H:i:s' |
|
| 1091 | - ), |
|
| 1092 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1093 | - 'REG_date', |
|
| 1094 | - $now . ' 23:59:59', |
|
| 1095 | - 'Y-m-d H:i:s' |
|
| 1096 | - ), |
|
| 1097 | - ), |
|
| 1098 | - ); |
|
| 1099 | - } elseif ($retrieve_for_this_month) { |
|
| 1100 | - $current_year_and_month = date('Y-m', current_time('timestamp')); |
|
| 1101 | - $days_this_month = date('t', current_time('timestamp')); |
|
| 1102 | - $where['REG_date'] = array( |
|
| 1103 | - 'BETWEEN', |
|
| 1104 | - array( |
|
| 1105 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1106 | - 'REG_date', |
|
| 1107 | - $current_year_and_month . '-01 00:00:00', |
|
| 1108 | - 'Y-m-d H:i:s' |
|
| 1109 | - ), |
|
| 1110 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1111 | - 'REG_date', |
|
| 1112 | - $current_year_and_month . '-' . $days_this_month . ' 23:59:59', |
|
| 1113 | - 'Y-m-d H:i:s' |
|
| 1114 | - ), |
|
| 1115 | - ), |
|
| 1116 | - ); |
|
| 1117 | - } elseif ($month_range) { |
|
| 1118 | - $pieces = explode(' ', $month_range, 3); |
|
| 1119 | - $month_requested = ! empty($pieces[0]) |
|
| 1120 | - ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) |
|
| 1121 | - : ''; |
|
| 1122 | - $year_requested = ! empty($pieces[1]) |
|
| 1123 | - ? $pieces[1] |
|
| 1124 | - : ''; |
|
| 1125 | - //if there is not a month or year then we can't go further |
|
| 1126 | - if ($month_requested && $year_requested) { |
|
| 1127 | - $days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01')); |
|
| 1128 | - $where['REG_date'] = array( |
|
| 1129 | - 'BETWEEN', |
|
| 1130 | - array( |
|
| 1131 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1132 | - 'REG_date', |
|
| 1133 | - $year_requested . '-' . $month_requested . '-01 00:00:00', |
|
| 1134 | - 'Y-m-d H:i:s' |
|
| 1135 | - ), |
|
| 1136 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1137 | - 'REG_date', |
|
| 1138 | - $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59', |
|
| 1139 | - 'Y-m-d H:i:s' |
|
| 1140 | - ), |
|
| 1141 | - ), |
|
| 1142 | - ); |
|
| 1143 | - } |
|
| 1144 | - } |
|
| 1145 | - return $where; |
|
| 1146 | - } |
|
| 1147 | - |
|
| 1148 | - |
|
| 1149 | - /** |
|
| 1150 | - * Adds any provided search restraints to the where conditions for the registrations query |
|
| 1151 | - * |
|
| 1152 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1153 | - * @return array |
|
| 1154 | - */ |
|
| 1155 | - protected function _add_search_to_where_conditions(array $request) |
|
| 1156 | - { |
|
| 1157 | - $where = array(); |
|
| 1158 | - if ( ! empty($request['s'])) { |
|
| 1159 | - $search_string = '%' . sanitize_text_field($request['s']) . '%'; |
|
| 1160 | - $where['OR'] = array( |
|
| 1161 | - 'Event.EVT_name' => array('LIKE', $search_string), |
|
| 1162 | - 'Event.EVT_desc' => array('LIKE', $search_string), |
|
| 1163 | - 'Event.EVT_short_desc' => array('LIKE', $search_string), |
|
| 1164 | - 'Attendee.ATT_full_name' => array('LIKE', $search_string), |
|
| 1165 | - 'Attendee.ATT_fname' => array('LIKE', $search_string), |
|
| 1166 | - 'Attendee.ATT_lname' => array('LIKE', $search_string), |
|
| 1167 | - 'Attendee.ATT_short_bio' => array('LIKE', $search_string), |
|
| 1168 | - 'Attendee.ATT_email' => array('LIKE', $search_string), |
|
| 1169 | - 'Attendee.ATT_address' => array('LIKE', $search_string), |
|
| 1170 | - 'Attendee.ATT_address2' => array('LIKE', $search_string), |
|
| 1171 | - 'Attendee.ATT_city' => array('LIKE', $search_string), |
|
| 1172 | - 'REG_final_price' => array('LIKE', $search_string), |
|
| 1173 | - 'REG_code' => array('LIKE', $search_string), |
|
| 1174 | - 'REG_count' => array('LIKE', $search_string), |
|
| 1175 | - 'REG_group_size' => array('LIKE', $search_string), |
|
| 1176 | - 'Ticket.TKT_name' => array('LIKE', $search_string), |
|
| 1177 | - 'Ticket.TKT_description' => array('LIKE', $search_string), |
|
| 1178 | - 'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string), |
|
| 1179 | - ); |
|
| 1180 | - } |
|
| 1181 | - return $where; |
|
| 1182 | - } |
|
| 1183 | - |
|
| 1184 | - |
|
| 1185 | - /** |
|
| 1186 | - * Sets up the where conditions for the registrations query. |
|
| 1187 | - * |
|
| 1188 | - * @param array $request |
|
| 1189 | - * @return array |
|
| 1190 | - */ |
|
| 1191 | - protected function _get_where_conditions_for_registrations_query($request) |
|
| 1192 | - { |
|
| 1193 | - return array_merge( |
|
| 1194 | - $this->_add_event_id_to_where_conditions($request), |
|
| 1195 | - $this->_add_category_id_to_where_conditions($request), |
|
| 1196 | - $this->_add_datetime_id_to_where_conditions($request), |
|
| 1197 | - $this->_add_registration_status_to_where_conditions($request), |
|
| 1198 | - $this->_add_date_to_where_conditions($request), |
|
| 1199 | - $this->_add_search_to_where_conditions($request) |
|
| 1200 | - ); |
|
| 1201 | - } |
|
| 1202 | - |
|
| 1203 | - |
|
| 1204 | - /** |
|
| 1205 | - * Sets up the orderby for the registrations query. |
|
| 1206 | - * |
|
| 1207 | - * @return array |
|
| 1208 | - */ |
|
| 1209 | - protected function _get_orderby_for_registrations_query() |
|
| 1210 | - { |
|
| 1211 | - $orderby_field = ! empty($this->_req_data['orderby']) |
|
| 1212 | - ? sanitize_text_field($this->_req_data['orderby']) |
|
| 1213 | - : ''; |
|
| 1214 | - switch ($orderby_field) { |
|
| 1215 | - case '_REG_ID': |
|
| 1216 | - $orderby_field = 'REG_ID'; |
|
| 1217 | - break; |
|
| 1218 | - case '_Reg_status': |
|
| 1219 | - $orderby_field = 'STS_ID'; |
|
| 1220 | - break; |
|
| 1221 | - case 'ATT_fname': |
|
| 1222 | - $orderby_field = array('Attendee.ATT_fname', 'Attendee.ATT_lname'); |
|
| 1223 | - break; |
|
| 1224 | - case 'ATT_lname' : |
|
| 1225 | - $orderby_field = array('Attendee.ATT_lname', 'Attendee.ATT_fname'); |
|
| 1226 | - break; |
|
| 1227 | - case 'event_name': |
|
| 1228 | - $orderby_field = 'Event.EVT_name'; |
|
| 1229 | - break; |
|
| 1230 | - case 'DTT_EVT_start': |
|
| 1231 | - $orderby_field = 'Event.Datetime.DTT_EVT_start'; |
|
| 1232 | - break; |
|
| 1233 | - default: //'REG_date' |
|
| 1234 | - $orderby_field = 'REG_date'; |
|
| 1235 | - } |
|
| 1236 | - |
|
| 1237 | - //order |
|
| 1238 | - $order = ! empty($this->_req_data['order']) |
|
| 1239 | - ? sanitize_text_field($this->_req_data['order']) |
|
| 1240 | - : 'DESC'; |
|
| 1241 | - |
|
| 1242 | - //mutate orderby_field |
|
| 1243 | - $orderby_field = array_combine( |
|
| 1244 | - (array) $orderby_field, |
|
| 1245 | - array_fill(0, count($orderby_field), $order) |
|
| 1246 | - ); |
|
| 1247 | - return array('order_by' => $orderby_field); |
|
| 1248 | - } |
|
| 1249 | - |
|
| 1250 | - |
|
| 1251 | - /** |
|
| 1252 | - * Sets up the limit for the registrations query. |
|
| 1253 | - * |
|
| 1254 | - * @param $per_page |
|
| 1255 | - * @return array |
|
| 1256 | - */ |
|
| 1257 | - protected function _get_limit($per_page) |
|
| 1258 | - { |
|
| 1259 | - $current_page = ! empty($this->_req_data['paged']) |
|
| 1260 | - ? absint($this->_req_data['paged']) |
|
| 1261 | - : 1; |
|
| 1262 | - $per_page = ! empty($this->_req_data['perpage']) |
|
| 1263 | - ? $this->_req_data['perpage'] |
|
| 1264 | - : $per_page; |
|
| 1265 | - |
|
| 1266 | - //-1 means return all results so get out if that's set. |
|
| 1267 | - if ((int)$per_page === -1) { |
|
| 1268 | - return array(); |
|
| 1269 | - } |
|
| 1270 | - $per_page = absint($per_page); |
|
| 1271 | - $offset = ($current_page - 1) * $per_page; |
|
| 1272 | - return array('limit' => array($offset, $per_page)); |
|
| 1273 | - } |
|
| 1274 | - |
|
| 1275 | - |
|
| 1276 | - public function get_registration_status_array() |
|
| 1277 | - { |
|
| 1278 | - return self::$_reg_status; |
|
| 1279 | - } |
|
| 1280 | - |
|
| 1281 | - |
|
| 1282 | - |
|
| 1283 | - |
|
| 1284 | - /*************************************** REGISTRATION DETAILS ***************************************/ |
|
| 1285 | - /** |
|
| 1286 | - * generates HTML for the View Registration Details Admin page |
|
| 1287 | - * |
|
| 1288 | - * @access protected |
|
| 1289 | - * @return void |
|
| 1290 | - */ |
|
| 1291 | - protected function _registration_details() |
|
| 1292 | - { |
|
| 1293 | - $this->_template_args = array(); |
|
| 1294 | - $this->_set_registration_object(); |
|
| 1295 | - if (is_object($this->_registration)) { |
|
| 1296 | - $transaction = $this->_registration->transaction() ? $this->_registration->transaction() |
|
| 1297 | - : EE_Transaction::new_instance(); |
|
| 1298 | - $this->_session = $transaction->session_data(); |
|
| 1299 | - $event_id = $this->_registration->event_ID(); |
|
| 1300 | - $this->_template_args['reg_nmbr']['value'] = $this->_registration->ID(); |
|
| 1301 | - $this->_template_args['reg_nmbr']['label'] = __('Registration Number', 'event_espresso'); |
|
| 1302 | - $this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date'); |
|
| 1303 | - $this->_template_args['reg_datetime']['label'] = __('Date', 'event_espresso'); |
|
| 1304 | - $this->_template_args['grand_total'] = $transaction->total(); |
|
| 1305 | - $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 1306 | - // link back to overview |
|
| 1307 | - $this->_template_args['reg_overview_url'] = REG_ADMIN_URL; |
|
| 1308 | - $this->_template_args['registration'] = $this->_registration; |
|
| 1309 | - $this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1310 | - 'action' => 'default', |
|
| 1311 | - 'event_id' => $event_id, |
|
| 1312 | - ), REG_ADMIN_URL); |
|
| 1313 | - $this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1314 | - 'action' => 'default', |
|
| 1315 | - 'EVT_ID' => $event_id, |
|
| 1316 | - 'page' => 'espresso_transactions', |
|
| 1317 | - ), admin_url('admin.php')); |
|
| 1318 | - $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1319 | - 'page' => 'espresso_events', |
|
| 1320 | - 'action' => 'edit', |
|
| 1321 | - 'post' => $event_id, |
|
| 1322 | - ), admin_url('admin.php')); |
|
| 1323 | - //next and previous links |
|
| 1324 | - $next_reg = $this->_registration->next(null, array(), 'REG_ID'); |
|
| 1325 | - $this->_template_args['next_registration'] = $next_reg |
|
| 1326 | - ? $this->_next_link(EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1327 | - 'action' => 'view_registration', |
|
| 1328 | - '_REG_ID' => $next_reg['REG_ID'], |
|
| 1329 | - ), REG_ADMIN_URL), 'dashicons dashicons-arrow-right ee-icon-size-22') : ''; |
|
| 1330 | - $previous_reg = $this->_registration->previous(null, array(), 'REG_ID'); |
|
| 1331 | - $this->_template_args['previous_registration'] = $previous_reg |
|
| 1332 | - ? $this->_previous_link(EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1333 | - 'action' => 'view_registration', |
|
| 1334 | - '_REG_ID' => $previous_reg['REG_ID'], |
|
| 1335 | - ), REG_ADMIN_URL), 'dashicons dashicons-arrow-left ee-icon-size-22') : ''; |
|
| 1336 | - // grab header |
|
| 1337 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php'; |
|
| 1338 | - $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
| 1339 | - $this->_template_args['admin_page_header'] = EEH_Template::display_template($template_path, |
|
| 1340 | - $this->_template_args, true); |
|
| 1341 | - } else { |
|
| 1342 | - $this->_template_args['admin_page_header'] = $this->display_espresso_notices(); |
|
| 1343 | - } |
|
| 1344 | - // the details template wrapper |
|
| 1345 | - $this->display_admin_page_with_sidebar(); |
|
| 1346 | - } |
|
| 1347 | - |
|
| 1348 | - |
|
| 1349 | - protected function _registration_details_metaboxes() |
|
| 1350 | - { |
|
| 1351 | - do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this); |
|
| 1352 | - $this->_set_registration_object(); |
|
| 1353 | - $attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null; |
|
| 1354 | - add_meta_box('edit-reg-status-mbox', __('Registration Status', 'event_espresso'), |
|
| 1355 | - array($this, 'set_reg_status_buttons_metabox'), $this->wp_page_slug, 'normal', 'high'); |
|
| 1356 | - add_meta_box('edit-reg-details-mbox', __('Registration Details', 'event_espresso'), |
|
| 1357 | - array($this, '_reg_details_meta_box'), $this->wp_page_slug, 'normal', 'high'); |
|
| 1358 | - if ($attendee instanceof EE_Attendee |
|
| 1359 | - && EE_Registry::instance()->CAP->current_user_can('ee_edit_registration', 'edit-reg-questions-mbox') |
|
| 1360 | - ) { |
|
| 1361 | - add_meta_box('edit-reg-questions-mbox', __('Registration Form Answers', 'event_espresso'), |
|
| 1362 | - array($this, '_reg_questions_meta_box'), $this->wp_page_slug, 'normal', 'high'); |
|
| 1363 | - } |
|
| 1364 | - add_meta_box('edit-reg-registrant-mbox', __('Contact Details', 'event_espresso'), |
|
| 1365 | - array($this, '_reg_registrant_side_meta_box'), $this->wp_page_slug, 'side', 'high'); |
|
| 1366 | - if ($this->_registration->group_size() > 1) { |
|
| 1367 | - add_meta_box('edit-reg-attendees-mbox', __('Other Registrations in this Transaction', 'event_espresso'), |
|
| 1368 | - array($this, '_reg_attendees_meta_box'), $this->wp_page_slug, 'normal', 'high'); |
|
| 1369 | - } |
|
| 1370 | - } |
|
| 1371 | - |
|
| 1372 | - |
|
| 1373 | - /** |
|
| 1374 | - * set_reg_status_buttons_metabox |
|
| 1375 | - * |
|
| 1376 | - * @access protected |
|
| 1377 | - * @return string |
|
| 1378 | - * @throws \EE_Error |
|
| 1379 | - */ |
|
| 1380 | - public function set_reg_status_buttons_metabox() |
|
| 1381 | - { |
|
| 1382 | - $this->_set_registration_object(); |
|
| 1383 | - $change_reg_status_form = $this->_generate_reg_status_change_form(); |
|
| 1384 | - echo $change_reg_status_form->form_open(self::add_query_args_and_nonce(array( |
|
| 1385 | - 'action' => 'change_reg_status', |
|
| 1386 | - ), REG_ADMIN_URL)); |
|
| 1387 | - echo $change_reg_status_form->get_html(); |
|
| 1388 | - echo $change_reg_status_form->form_close(); |
|
| 1389 | - } |
|
| 1390 | - |
|
| 1391 | - |
|
| 1392 | - /** |
|
| 1393 | - * @return EE_Form_Section_Proper |
|
| 1394 | - */ |
|
| 1395 | - protected function _generate_reg_status_change_form() |
|
| 1396 | - { |
|
| 1397 | - return new EE_Form_Section_Proper(array( |
|
| 1398 | - 'name' => 'reg_status_change_form', |
|
| 1399 | - 'html_id' => 'reg-status-change-form', |
|
| 1400 | - 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
| 1401 | - 'subsections' => array( |
|
| 1402 | - 'return' => new EE_Hidden_Input(array( |
|
| 1403 | - 'name' => 'return', |
|
| 1404 | - 'default' => 'view_registration', |
|
| 1405 | - )), |
|
| 1406 | - 'REG_ID' => new EE_Hidden_Input(array( |
|
| 1407 | - 'name' => 'REG_ID', |
|
| 1408 | - 'default' => $this->_registration->ID(), |
|
| 1409 | - )), |
|
| 1410 | - 'current_status' => new EE_Form_Section_HTML(EEH_HTML::tr(EEH_HTML::th(EEH_HTML::label(EEH_HTML::strong(__('Current Registration Status', |
|
| 1411 | - 'event_espresso')))) . EEH_HTML::td(EEH_HTML::strong($this->_registration->pretty_status(), |
|
| 1412 | - '', 'status-' . $this->_registration->status_ID(), |
|
| 1413 | - 'line-height: 1em; font-size: 1.5em; font-weight: bold;')))), |
|
| 1414 | - 'reg_status' => new EE_Select_Input($this->_get_reg_statuses(), array( |
|
| 1415 | - 'html_label_text' => __('Change Registration Status to', 'event_espresso'), |
|
| 1416 | - 'default' => $this->_registration->status_ID(), |
|
| 1417 | - )), |
|
| 1418 | - 'send_notifications' => new EE_Yes_No_Input(array( |
|
| 1419 | - 'html_label_text' => __('Send Related Messages', 'event_espresso'), |
|
| 1420 | - 'default' => false, |
|
| 1421 | - 'html_help_text' => __('If set to "Yes", then the related messages will be sent to the registrant.', |
|
| 1422 | - 'event_espresso'), |
|
| 1423 | - )), |
|
| 1424 | - 'submit' => new EE_Submit_Input(array( |
|
| 1425 | - 'html_class' => 'button-primary', |
|
| 1426 | - 'html_label_text' => ' ', |
|
| 1427 | - 'default' => __('Update Registration Status', 'event_espresso'), |
|
| 1428 | - )), |
|
| 1429 | - ), |
|
| 1430 | - )); |
|
| 1431 | - } |
|
| 1432 | - |
|
| 1433 | - |
|
| 1434 | - |
|
| 1435 | - /** |
|
| 1436 | - * Returns an array of all the buttons for the various statuses and switch status actions |
|
| 1437 | - * |
|
| 1438 | - * @return array |
|
| 1439 | - */ |
|
| 1440 | - protected function _get_reg_statuses() |
|
| 1441 | - { |
|
| 1442 | - $reg_status_array = EEM_Registration::instance()->reg_status_array(); |
|
| 1443 | - unset ($reg_status_array[EEM_Registration::status_id_incomplete]); |
|
| 1444 | - // get current reg status |
|
| 1445 | - $current_status = $this->_registration->status_ID(); |
|
| 1446 | - // is registration for free event? This will determine whether to display the pending payment option |
|
| 1447 | - if ($current_status != EEM_Registration::status_id_pending_payment |
|
| 1448 | - && $this->_registration->transaction() |
|
| 1449 | - ->is_free() |
|
| 1450 | - ) { |
|
| 1451 | - unset($reg_status_array[EEM_Registration::status_id_pending_payment]); |
|
| 1452 | - } |
|
| 1453 | - return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence'); |
|
| 1454 | - } |
|
| 1455 | - |
|
| 1456 | - |
|
| 1457 | - /** |
|
| 1458 | - * This method is used when using _REG_ID from request which may or may not be an array of reg_ids. |
|
| 1459 | - * |
|
| 1460 | - * @param bool $status REG status given for changing registrations to. |
|
| 1461 | - * @param bool $notify Whether to send messages notifications or not. |
|
| 1462 | - * @return array (array with reg_id(s) updated and whether update was successful. |
|
| 1463 | - */ |
|
| 1464 | - protected function _set_registration_status_from_request($status = false, $notify = false) |
|
| 1465 | - { |
|
| 1466 | - if (isset($this->_req_data['reg_status_change_form'])) { |
|
| 1467 | - $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID']) |
|
| 1468 | - ? (array)$this->_req_data['reg_status_change_form']['REG_ID'] : array(); |
|
| 1469 | - } else { |
|
| 1470 | - $REG_IDs = isset($this->_req_data['_REG_ID']) ? (array)$this->_req_data['_REG_ID'] : array(); |
|
| 1471 | - } |
|
| 1472 | - $success = $this->_set_registration_status($REG_IDs, $status); |
|
| 1473 | - //notify? |
|
| 1474 | - if ($success |
|
| 1475 | - && $notify |
|
| 1476 | - && EE_Registry::instance()->CAP->current_user_can('ee_send_message', |
|
| 1477 | - 'espresso_registrations_resend_registration') |
|
| 1478 | - ) { |
|
| 1479 | - $this->_process_resend_registration(); |
|
| 1480 | - } |
|
| 1481 | - return $success; |
|
| 1482 | - } |
|
| 1483 | - |
|
| 1484 | - |
|
| 1485 | - /** |
|
| 1486 | - * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an |
|
| 1487 | - * array). Note, this method does NOT take care of possible notifications. That is required by calling code. |
|
| 1488 | - * |
|
| 1489 | - * @param array $REG_IDs |
|
| 1490 | - * @param bool $status |
|
| 1491 | - * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as |
|
| 1492 | - * the array of updated registrations). |
|
| 1493 | - */ |
|
| 1494 | - protected function _set_registration_status($REG_IDs = array(), $status = false) |
|
| 1495 | - { |
|
| 1496 | - $success = false; |
|
| 1497 | - // typecast $REG_IDs |
|
| 1498 | - $REG_IDs = (array)$REG_IDs; |
|
| 1499 | - if ( ! empty($REG_IDs)) { |
|
| 1500 | - $success = true; |
|
| 1501 | - // set default status if none is passed |
|
| 1502 | - $status = $status ? $status : EEM_Registration::status_id_pending_payment; |
|
| 1503 | - // sanitize $REG_IDs |
|
| 1504 | - $REG_IDs = array_filter($REG_IDs, 'absint'); |
|
| 1505 | - //loop through REG_ID's and change status |
|
| 1506 | - foreach ($REG_IDs as $REG_ID) { |
|
| 1507 | - $registration = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
| 1508 | - if ($registration instanceof EE_Registration) { |
|
| 1509 | - $registration->set_status($status); |
|
| 1510 | - $result = $registration->save(); |
|
| 1511 | - // verifying explicit fails because update *may* just return 0 for 0 rows affected |
|
| 1512 | - $success = $result !== false ? $success : false; |
|
| 1513 | - } |
|
| 1514 | - } |
|
| 1515 | - } |
|
| 1516 | - //reset _req_data['_REG_ID'] for any potential future messages notifications |
|
| 1517 | - $this->_req_data['_REG_ID'] = $REG_IDs; |
|
| 1518 | - //return $success and processed registrations |
|
| 1519 | - return array('REG_ID' => $REG_IDs, 'success' => $success); |
|
| 1520 | - } |
|
| 1521 | - |
|
| 1522 | - |
|
| 1523 | - /** |
|
| 1524 | - * Common logic for setting up success message and redirecting to appropriate route |
|
| 1525 | - * |
|
| 1526 | - * @param string $STS_ID status id for the registration changed to |
|
| 1527 | - * @param bool $notify indicates whether the _set_registration_status_from_request does notifications or not. |
|
| 1528 | - * @return void |
|
| 1529 | - */ |
|
| 1530 | - protected function _reg_status_change_return($STS_ID, $notify = false) |
|
| 1531 | - { |
|
| 1532 | - $result = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify) |
|
| 1533 | - : array('success' => false); |
|
| 1534 | - $success = isset($result['success']) && $result['success']; |
|
| 1535 | - //setup success message |
|
| 1536 | - if ($success) { |
|
| 1537 | - if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) { |
|
| 1538 | - $msg = sprintf(__('Registration status has been set to %s', 'event_espresso'), |
|
| 1539 | - EEH_Template::pretty_status($STS_ID, false, 'lower')); |
|
| 1540 | - } else { |
|
| 1541 | - $msg = sprintf(__('Registrations have been set to %s.', 'event_espresso'), |
|
| 1542 | - EEH_Template::pretty_status($STS_ID, false, 'lower')); |
|
| 1543 | - } |
|
| 1544 | - EE_Error::add_success($msg); |
|
| 1545 | - } else { |
|
| 1546 | - EE_Error::add_error(__('Something went wrong, and the status was not changed', 'event_espresso'), __FILE__, |
|
| 1547 | - __LINE__, __FUNCTION__); |
|
| 1548 | - } |
|
| 1549 | - if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') { |
|
| 1550 | - $route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID'])); |
|
| 1551 | - } else { |
|
| 1552 | - $route = array('action' => 'default'); |
|
| 1553 | - } |
|
| 1554 | - //unset nonces |
|
| 1555 | - foreach ($this->_req_data as $ref => $value) { |
|
| 1556 | - if (strpos($ref, 'nonce') !== false) { |
|
| 1557 | - unset($this->_req_data[$ref]); |
|
| 1558 | - continue; |
|
| 1559 | - } |
|
| 1560 | - $value = is_array($value) ? array_map('urlencode', $value) : urlencode($value); |
|
| 1561 | - $this->_req_data[$ref] = $value; |
|
| 1562 | - } |
|
| 1563 | - //merge request vars so that the reloaded list table contains any existing filter query params |
|
| 1564 | - $route = array_merge($this->_req_data, $route); |
|
| 1565 | - $this->_redirect_after_action($success, '', '', $route, true); |
|
| 1566 | - } |
|
| 1567 | - |
|
| 1568 | - |
|
| 1569 | - /** |
|
| 1570 | - * incoming reg status change from reg details page. |
|
| 1571 | - * |
|
| 1572 | - * @return void |
|
| 1573 | - */ |
|
| 1574 | - protected function _change_reg_status() |
|
| 1575 | - { |
|
| 1576 | - $this->_req_data['return'] = 'view_registration'; |
|
| 1577 | - //set notify based on whether the send notifications toggle is set or not |
|
| 1578 | - $notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']); |
|
| 1579 | - //$notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] ); |
|
| 1580 | - $this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status']) |
|
| 1581 | - ? $this->_req_data['reg_status_change_form']['reg_status'] : ''; |
|
| 1582 | - switch ($this->_req_data['reg_status_change_form']['reg_status']) { |
|
| 1583 | - case EEM_Registration::status_id_approved : |
|
| 1584 | - case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence') : |
|
| 1585 | - $this->approve_registration($notify); |
|
| 1586 | - break; |
|
| 1587 | - case EEM_Registration::status_id_pending_payment : |
|
| 1588 | - case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence') : |
|
| 1589 | - $this->pending_registration($notify); |
|
| 1590 | - break; |
|
| 1591 | - case EEM_Registration::status_id_not_approved : |
|
| 1592 | - case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence') : |
|
| 1593 | - $this->not_approve_registration($notify); |
|
| 1594 | - break; |
|
| 1595 | - case EEM_Registration::status_id_declined : |
|
| 1596 | - case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence') : |
|
| 1597 | - $this->decline_registration($notify); |
|
| 1598 | - break; |
|
| 1599 | - case EEM_Registration::status_id_cancelled : |
|
| 1600 | - case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence') : |
|
| 1601 | - $this->cancel_registration($notify); |
|
| 1602 | - break; |
|
| 1603 | - case EEM_Registration::status_id_wait_list : |
|
| 1604 | - case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence') : |
|
| 1605 | - $this->waitlist_registration($notify); |
|
| 1606 | - break; |
|
| 1607 | - case EEM_Registration::status_id_incomplete : |
|
| 1608 | - default : |
|
| 1609 | - $result['success'] = false; |
|
| 1610 | - unset($this->_req_data['return']); |
|
| 1611 | - $this->_reg_status_change_return('', false); |
|
| 1612 | - break; |
|
| 1613 | - } |
|
| 1614 | - } |
|
| 1615 | - |
|
| 1616 | - |
|
| 1617 | - /** |
|
| 1618 | - * approve_registration |
|
| 1619 | - * |
|
| 1620 | - * @access protected |
|
| 1621 | - * @param bool $notify whether or not to notify the registrant about their approval. |
|
| 1622 | - * @return void |
|
| 1623 | - */ |
|
| 1624 | - protected function approve_registration($notify = false) |
|
| 1625 | - { |
|
| 1626 | - $this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify); |
|
| 1627 | - } |
|
| 1628 | - |
|
| 1629 | - |
|
| 1630 | - /** |
|
| 1631 | - * decline_registration |
|
| 1632 | - * |
|
| 1633 | - * @access protected |
|
| 1634 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 1635 | - * @return void |
|
| 1636 | - */ |
|
| 1637 | - protected function decline_registration($notify = false) |
|
| 1638 | - { |
|
| 1639 | - $this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify); |
|
| 1640 | - } |
|
| 1641 | - |
|
| 1642 | - |
|
| 1643 | - /** |
|
| 1644 | - * cancel_registration |
|
| 1645 | - * |
|
| 1646 | - * @access protected |
|
| 1647 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 1648 | - * @return void |
|
| 1649 | - */ |
|
| 1650 | - protected function cancel_registration($notify = false) |
|
| 1651 | - { |
|
| 1652 | - $this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify); |
|
| 1653 | - } |
|
| 1654 | - |
|
| 1655 | - |
|
| 1656 | - /** |
|
| 1657 | - * not_approve_registration |
|
| 1658 | - * |
|
| 1659 | - * @access protected |
|
| 1660 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 1661 | - * @return void |
|
| 1662 | - */ |
|
| 1663 | - protected function not_approve_registration($notify = false) |
|
| 1664 | - { |
|
| 1665 | - $this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify); |
|
| 1666 | - } |
|
| 1667 | - |
|
| 1668 | - |
|
| 1669 | - /** |
|
| 1670 | - * decline_registration |
|
| 1671 | - * |
|
| 1672 | - * @access protected |
|
| 1673 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 1674 | - * @return void |
|
| 1675 | - */ |
|
| 1676 | - protected function pending_registration($notify = false) |
|
| 1677 | - { |
|
| 1678 | - $this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify); |
|
| 1679 | - } |
|
| 1680 | - |
|
| 1681 | - |
|
| 1682 | - /** |
|
| 1683 | - * waitlist_registration |
|
| 1684 | - * |
|
| 1685 | - * @access protected |
|
| 1686 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 1687 | - * @return void |
|
| 1688 | - */ |
|
| 1689 | - protected function waitlist_registration($notify = false) |
|
| 1690 | - { |
|
| 1691 | - $this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify); |
|
| 1692 | - } |
|
| 1693 | - |
|
| 1694 | - |
|
| 1695 | - /** |
|
| 1696 | - * generates HTML for the Registration main meta box |
|
| 1697 | - * |
|
| 1698 | - * @access public |
|
| 1699 | - * @return void |
|
| 1700 | - */ |
|
| 1701 | - public function _reg_details_meta_box() |
|
| 1702 | - { |
|
| 1703 | - EEH_Autoloader::register_line_item_display_autoloaders(); |
|
| 1704 | - EEH_Autoloader::register_line_item_filter_autoloaders(); |
|
| 1705 | - EE_Registry::instance()->load_helper('Line_Item'); |
|
| 1706 | - $transaction = $this->_registration->transaction() ? $this->_registration->transaction() |
|
| 1707 | - : EE_Transaction::new_instance(); |
|
| 1708 | - $this->_session = $transaction->session_data(); |
|
| 1709 | - $filters = new EE_Line_Item_Filter_Collection(); |
|
| 1710 | - //$filters->add( new EE_Non_Zero_Line_Item_Filter() ); |
|
| 1711 | - $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration)); |
|
| 1712 | - $line_item_filter_processor = new EE_Line_Item_Filter_Processor($filters, |
|
| 1713 | - $transaction->total_line_item()); |
|
| 1714 | - $filtered_line_item_tree = $line_item_filter_processor->process(); |
|
| 1715 | - $line_item_display = new EE_Line_Item_Display('reg_admin_table', |
|
| 1716 | - 'EE_Admin_Table_Registration_Line_Item_Display_Strategy'); |
|
| 1717 | - $this->_template_args['line_item_table'] = $line_item_display->display_line_item($filtered_line_item_tree, |
|
| 1718 | - array('EE_Registration' => $this->_registration)); |
|
| 1719 | - $attendee = $this->_registration->attendee(); |
|
| 1720 | - if (EE_Registry::instance()->CAP->current_user_can('ee_read_transaction', |
|
| 1721 | - 'espresso_transactions_view_transaction') |
|
| 1722 | - ) { |
|
| 1723 | - $this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1724 | - 'action' => 'view_transaction', |
|
| 1725 | - 'TXN_ID' => $transaction->ID(), |
|
| 1726 | - ), TXN_ADMIN_URL), esc_html__(' View Transaction'), 'button secondary-button right', |
|
| 1727 | - 'dashicons dashicons-cart'); |
|
| 1728 | - } else { |
|
| 1729 | - $this->_template_args['view_transaction_button'] = ''; |
|
| 1730 | - } |
|
| 1731 | - if ($attendee instanceof EE_Attendee |
|
| 1732 | - && EE_Registry::instance()->CAP->current_user_can('ee_send_message', |
|
| 1733 | - 'espresso_registrations_resend_registration') |
|
| 1734 | - ) { |
|
| 1735 | - $this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1736 | - 'action' => 'resend_registration', |
|
| 1737 | - '_REG_ID' => $this->_registration->ID(), |
|
| 1738 | - 'redirect_to' => 'view_registration', |
|
| 1739 | - ), REG_ADMIN_URL), esc_html__(' Resend Registration'), 'button secondary-button right', |
|
| 1740 | - 'dashicons dashicons-email-alt'); |
|
| 1741 | - } else { |
|
| 1742 | - $this->_template_args['resend_registration_button'] = ''; |
|
| 1743 | - } |
|
| 1744 | - $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 1745 | - $payment = $transaction->get_first_related('Payment'); |
|
| 1746 | - $payment = ! $payment instanceof EE_Payment ? EE_Payment::new_instance() : $payment; |
|
| 1747 | - $payment_method = $payment->get_first_related('Payment_Method'); |
|
| 1748 | - $payment_method = ! $payment_method instanceof EE_Payment_Method ? EE_Payment_Method::new_instance() |
|
| 1749 | - : $payment_method; |
|
| 1750 | - $reg_details = array( |
|
| 1751 | - 'payment_method' => $payment_method->name(), |
|
| 1752 | - 'response_msg' => $payment->gateway_response(), |
|
| 1753 | - 'registration_id' => $this->_registration->get('REG_code'), |
|
| 1754 | - 'registration_session' => $this->_registration->session_ID(), |
|
| 1755 | - 'ip_address' => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '', |
|
| 1756 | - 'user_agent' => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '', |
|
| 1757 | - ); |
|
| 1758 | - if (isset($reg_details['registration_id'])) { |
|
| 1759 | - $this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id']; |
|
| 1760 | - $this->_template_args['reg_details']['registration_id']['label'] = __('Registration ID', 'event_espresso'); |
|
| 1761 | - $this->_template_args['reg_details']['registration_id']['class'] = 'regular-text'; |
|
| 1762 | - } |
|
| 1763 | - if (isset($reg_details['payment_method'])) { |
|
| 1764 | - $this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method']; |
|
| 1765 | - $this->_template_args['reg_details']['payment_method']['label'] = __('Most Recent Payment Method', |
|
| 1766 | - 'event_espresso'); |
|
| 1767 | - $this->_template_args['reg_details']['payment_method']['class'] = 'regular-text'; |
|
| 1768 | - $this->_template_args['reg_details']['response_msg']['value'] = $reg_details['response_msg']; |
|
| 1769 | - $this->_template_args['reg_details']['response_msg']['label'] = __('Payment method response', |
|
| 1770 | - 'event_espresso'); |
|
| 1771 | - $this->_template_args['reg_details']['response_msg']['class'] = 'regular-text'; |
|
| 1772 | - } |
|
| 1773 | - $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session']; |
|
| 1774 | - $this->_template_args['reg_details']['registration_session']['label'] = __('Registration Session', |
|
| 1775 | - 'event_espresso'); |
|
| 1776 | - $this->_template_args['reg_details']['registration_session']['class'] = 'regular-text'; |
|
| 1777 | - $this->_template_args['reg_details']['ip_address']['value'] = $reg_details['ip_address']; |
|
| 1778 | - $this->_template_args['reg_details']['ip_address']['label'] = __('Registration placed from IP', |
|
| 1779 | - 'event_espresso'); |
|
| 1780 | - $this->_template_args['reg_details']['ip_address']['class'] = 'regular-text'; |
|
| 1781 | - $this->_template_args['reg_details']['user_agent']['value'] = $reg_details['user_agent']; |
|
| 1782 | - $this->_template_args['reg_details']['user_agent']['label'] = __('Registrant User Agent', |
|
| 1783 | - 'event_espresso'); |
|
| 1784 | - $this->_template_args['reg_details']['user_agent']['class'] = 'large-text'; |
|
| 1785 | - $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1786 | - 'action' => 'default', |
|
| 1787 | - 'event_id' => $this->_registration->event_ID(), |
|
| 1788 | - ), REG_ADMIN_URL); |
|
| 1789 | - $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
| 1790 | - $this->_template_args['event_id'] = $this->_registration->event_ID(); |
|
| 1791 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php'; |
|
| 1792 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 1793 | - } |
|
| 1794 | - |
|
| 1795 | - |
|
| 1796 | - /** |
|
| 1797 | - * generates HTML for the Registration Questions meta box. |
|
| 1798 | - * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters), |
|
| 1799 | - * otherwise uses new forms system |
|
| 1800 | - * |
|
| 1801 | - * @access public |
|
| 1802 | - * @return void |
|
| 1803 | - */ |
|
| 1804 | - public function _reg_questions_meta_box() |
|
| 1805 | - { |
|
| 1806 | - //allow someone to override this method entirely |
|
| 1807 | - if (apply_filters('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', true, $this, |
|
| 1808 | - $this->_registration)) { |
|
| 1809 | - $form = $this->_get_reg_custom_questions_form($this->_registration->ID()); |
|
| 1810 | - $this->_template_args['att_questions'] = count($form->subforms()) > 0 ? $form->get_html_and_js() : ''; |
|
| 1811 | - $this->_template_args['reg_questions_form_action'] = 'edit_registration'; |
|
| 1812 | - $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
| 1813 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
| 1814 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 1815 | - } |
|
| 1816 | - } |
|
| 1817 | - |
|
| 1818 | - |
|
| 1819 | - /** |
|
| 1820 | - * form_before_question_group |
|
| 1821 | - * |
|
| 1822 | - * @deprecated as of 4.8.32.rc.000 |
|
| 1823 | - * @access public |
|
| 1824 | - * @param string $output |
|
| 1825 | - * @return string |
|
| 1826 | - */ |
|
| 1827 | - public function form_before_question_group($output) |
|
| 1828 | - { |
|
| 1829 | - EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__, |
|
| 1830 | - __('This method would have been protected but was used on a filter callback' |
|
| 1831 | - . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'), |
|
| 1832 | - '4.8.32.rc.000'); |
|
| 1833 | - return ' |
|
| 1050 | + if ( ! empty($registration_status)) { |
|
| 1051 | + $where['STS_ID'] = $registration_status; |
|
| 1052 | + } else { |
|
| 1053 | + //make sure we exclude incomplete registrations, but only if not trashed. |
|
| 1054 | + if ($view === 'trash') { |
|
| 1055 | + $where['REG_deleted'] = true; |
|
| 1056 | + } else if ($view === 'incomplete') { |
|
| 1057 | + $where['STS_ID'] = EEM_Registration::status_id_incomplete; |
|
| 1058 | + } else { |
|
| 1059 | + $where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete); |
|
| 1060 | + } |
|
| 1061 | + } |
|
| 1062 | + return $where; |
|
| 1063 | + } |
|
| 1064 | + |
|
| 1065 | + |
|
| 1066 | + /** |
|
| 1067 | + * Adds any provided date restraints to the where conditions for the registrations query. |
|
| 1068 | + * |
|
| 1069 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1070 | + * @return array |
|
| 1071 | + */ |
|
| 1072 | + protected function _add_date_to_where_conditions(array $request) |
|
| 1073 | + { |
|
| 1074 | + $where = array(); |
|
| 1075 | + $view = EEH_Array::is_set( $request, 'status', '' ); |
|
| 1076 | + $month_range = ! empty($request['month_range']) |
|
| 1077 | + ? sanitize_text_field($request['month_range']) |
|
| 1078 | + : ''; |
|
| 1079 | + $retrieve_for_today = $view === 'today'; |
|
| 1080 | + $retrieve_for_this_month = $view === 'month'; |
|
| 1081 | + |
|
| 1082 | + if ($retrieve_for_today) { |
|
| 1083 | + $now = date('Y-m-d', current_time('timestamp')); |
|
| 1084 | + $where['REG_date'] = array( |
|
| 1085 | + 'BETWEEN', |
|
| 1086 | + array( |
|
| 1087 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1088 | + 'REG_date', |
|
| 1089 | + $now . ' 00:00:00', |
|
| 1090 | + 'Y-m-d H:i:s' |
|
| 1091 | + ), |
|
| 1092 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1093 | + 'REG_date', |
|
| 1094 | + $now . ' 23:59:59', |
|
| 1095 | + 'Y-m-d H:i:s' |
|
| 1096 | + ), |
|
| 1097 | + ), |
|
| 1098 | + ); |
|
| 1099 | + } elseif ($retrieve_for_this_month) { |
|
| 1100 | + $current_year_and_month = date('Y-m', current_time('timestamp')); |
|
| 1101 | + $days_this_month = date('t', current_time('timestamp')); |
|
| 1102 | + $where['REG_date'] = array( |
|
| 1103 | + 'BETWEEN', |
|
| 1104 | + array( |
|
| 1105 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1106 | + 'REG_date', |
|
| 1107 | + $current_year_and_month . '-01 00:00:00', |
|
| 1108 | + 'Y-m-d H:i:s' |
|
| 1109 | + ), |
|
| 1110 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1111 | + 'REG_date', |
|
| 1112 | + $current_year_and_month . '-' . $days_this_month . ' 23:59:59', |
|
| 1113 | + 'Y-m-d H:i:s' |
|
| 1114 | + ), |
|
| 1115 | + ), |
|
| 1116 | + ); |
|
| 1117 | + } elseif ($month_range) { |
|
| 1118 | + $pieces = explode(' ', $month_range, 3); |
|
| 1119 | + $month_requested = ! empty($pieces[0]) |
|
| 1120 | + ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) |
|
| 1121 | + : ''; |
|
| 1122 | + $year_requested = ! empty($pieces[1]) |
|
| 1123 | + ? $pieces[1] |
|
| 1124 | + : ''; |
|
| 1125 | + //if there is not a month or year then we can't go further |
|
| 1126 | + if ($month_requested && $year_requested) { |
|
| 1127 | + $days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01')); |
|
| 1128 | + $where['REG_date'] = array( |
|
| 1129 | + 'BETWEEN', |
|
| 1130 | + array( |
|
| 1131 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1132 | + 'REG_date', |
|
| 1133 | + $year_requested . '-' . $month_requested . '-01 00:00:00', |
|
| 1134 | + 'Y-m-d H:i:s' |
|
| 1135 | + ), |
|
| 1136 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
| 1137 | + 'REG_date', |
|
| 1138 | + $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59', |
|
| 1139 | + 'Y-m-d H:i:s' |
|
| 1140 | + ), |
|
| 1141 | + ), |
|
| 1142 | + ); |
|
| 1143 | + } |
|
| 1144 | + } |
|
| 1145 | + return $where; |
|
| 1146 | + } |
|
| 1147 | + |
|
| 1148 | + |
|
| 1149 | + /** |
|
| 1150 | + * Adds any provided search restraints to the where conditions for the registrations query |
|
| 1151 | + * |
|
| 1152 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
| 1153 | + * @return array |
|
| 1154 | + */ |
|
| 1155 | + protected function _add_search_to_where_conditions(array $request) |
|
| 1156 | + { |
|
| 1157 | + $where = array(); |
|
| 1158 | + if ( ! empty($request['s'])) { |
|
| 1159 | + $search_string = '%' . sanitize_text_field($request['s']) . '%'; |
|
| 1160 | + $where['OR'] = array( |
|
| 1161 | + 'Event.EVT_name' => array('LIKE', $search_string), |
|
| 1162 | + 'Event.EVT_desc' => array('LIKE', $search_string), |
|
| 1163 | + 'Event.EVT_short_desc' => array('LIKE', $search_string), |
|
| 1164 | + 'Attendee.ATT_full_name' => array('LIKE', $search_string), |
|
| 1165 | + 'Attendee.ATT_fname' => array('LIKE', $search_string), |
|
| 1166 | + 'Attendee.ATT_lname' => array('LIKE', $search_string), |
|
| 1167 | + 'Attendee.ATT_short_bio' => array('LIKE', $search_string), |
|
| 1168 | + 'Attendee.ATT_email' => array('LIKE', $search_string), |
|
| 1169 | + 'Attendee.ATT_address' => array('LIKE', $search_string), |
|
| 1170 | + 'Attendee.ATT_address2' => array('LIKE', $search_string), |
|
| 1171 | + 'Attendee.ATT_city' => array('LIKE', $search_string), |
|
| 1172 | + 'REG_final_price' => array('LIKE', $search_string), |
|
| 1173 | + 'REG_code' => array('LIKE', $search_string), |
|
| 1174 | + 'REG_count' => array('LIKE', $search_string), |
|
| 1175 | + 'REG_group_size' => array('LIKE', $search_string), |
|
| 1176 | + 'Ticket.TKT_name' => array('LIKE', $search_string), |
|
| 1177 | + 'Ticket.TKT_description' => array('LIKE', $search_string), |
|
| 1178 | + 'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string), |
|
| 1179 | + ); |
|
| 1180 | + } |
|
| 1181 | + return $where; |
|
| 1182 | + } |
|
| 1183 | + |
|
| 1184 | + |
|
| 1185 | + /** |
|
| 1186 | + * Sets up the where conditions for the registrations query. |
|
| 1187 | + * |
|
| 1188 | + * @param array $request |
|
| 1189 | + * @return array |
|
| 1190 | + */ |
|
| 1191 | + protected function _get_where_conditions_for_registrations_query($request) |
|
| 1192 | + { |
|
| 1193 | + return array_merge( |
|
| 1194 | + $this->_add_event_id_to_where_conditions($request), |
|
| 1195 | + $this->_add_category_id_to_where_conditions($request), |
|
| 1196 | + $this->_add_datetime_id_to_where_conditions($request), |
|
| 1197 | + $this->_add_registration_status_to_where_conditions($request), |
|
| 1198 | + $this->_add_date_to_where_conditions($request), |
|
| 1199 | + $this->_add_search_to_where_conditions($request) |
|
| 1200 | + ); |
|
| 1201 | + } |
|
| 1202 | + |
|
| 1203 | + |
|
| 1204 | + /** |
|
| 1205 | + * Sets up the orderby for the registrations query. |
|
| 1206 | + * |
|
| 1207 | + * @return array |
|
| 1208 | + */ |
|
| 1209 | + protected function _get_orderby_for_registrations_query() |
|
| 1210 | + { |
|
| 1211 | + $orderby_field = ! empty($this->_req_data['orderby']) |
|
| 1212 | + ? sanitize_text_field($this->_req_data['orderby']) |
|
| 1213 | + : ''; |
|
| 1214 | + switch ($orderby_field) { |
|
| 1215 | + case '_REG_ID': |
|
| 1216 | + $orderby_field = 'REG_ID'; |
|
| 1217 | + break; |
|
| 1218 | + case '_Reg_status': |
|
| 1219 | + $orderby_field = 'STS_ID'; |
|
| 1220 | + break; |
|
| 1221 | + case 'ATT_fname': |
|
| 1222 | + $orderby_field = array('Attendee.ATT_fname', 'Attendee.ATT_lname'); |
|
| 1223 | + break; |
|
| 1224 | + case 'ATT_lname' : |
|
| 1225 | + $orderby_field = array('Attendee.ATT_lname', 'Attendee.ATT_fname'); |
|
| 1226 | + break; |
|
| 1227 | + case 'event_name': |
|
| 1228 | + $orderby_field = 'Event.EVT_name'; |
|
| 1229 | + break; |
|
| 1230 | + case 'DTT_EVT_start': |
|
| 1231 | + $orderby_field = 'Event.Datetime.DTT_EVT_start'; |
|
| 1232 | + break; |
|
| 1233 | + default: //'REG_date' |
|
| 1234 | + $orderby_field = 'REG_date'; |
|
| 1235 | + } |
|
| 1236 | + |
|
| 1237 | + //order |
|
| 1238 | + $order = ! empty($this->_req_data['order']) |
|
| 1239 | + ? sanitize_text_field($this->_req_data['order']) |
|
| 1240 | + : 'DESC'; |
|
| 1241 | + |
|
| 1242 | + //mutate orderby_field |
|
| 1243 | + $orderby_field = array_combine( |
|
| 1244 | + (array) $orderby_field, |
|
| 1245 | + array_fill(0, count($orderby_field), $order) |
|
| 1246 | + ); |
|
| 1247 | + return array('order_by' => $orderby_field); |
|
| 1248 | + } |
|
| 1249 | + |
|
| 1250 | + |
|
| 1251 | + /** |
|
| 1252 | + * Sets up the limit for the registrations query. |
|
| 1253 | + * |
|
| 1254 | + * @param $per_page |
|
| 1255 | + * @return array |
|
| 1256 | + */ |
|
| 1257 | + protected function _get_limit($per_page) |
|
| 1258 | + { |
|
| 1259 | + $current_page = ! empty($this->_req_data['paged']) |
|
| 1260 | + ? absint($this->_req_data['paged']) |
|
| 1261 | + : 1; |
|
| 1262 | + $per_page = ! empty($this->_req_data['perpage']) |
|
| 1263 | + ? $this->_req_data['perpage'] |
|
| 1264 | + : $per_page; |
|
| 1265 | + |
|
| 1266 | + //-1 means return all results so get out if that's set. |
|
| 1267 | + if ((int)$per_page === -1) { |
|
| 1268 | + return array(); |
|
| 1269 | + } |
|
| 1270 | + $per_page = absint($per_page); |
|
| 1271 | + $offset = ($current_page - 1) * $per_page; |
|
| 1272 | + return array('limit' => array($offset, $per_page)); |
|
| 1273 | + } |
|
| 1274 | + |
|
| 1275 | + |
|
| 1276 | + public function get_registration_status_array() |
|
| 1277 | + { |
|
| 1278 | + return self::$_reg_status; |
|
| 1279 | + } |
|
| 1280 | + |
|
| 1281 | + |
|
| 1282 | + |
|
| 1283 | + |
|
| 1284 | + /*************************************** REGISTRATION DETAILS ***************************************/ |
|
| 1285 | + /** |
|
| 1286 | + * generates HTML for the View Registration Details Admin page |
|
| 1287 | + * |
|
| 1288 | + * @access protected |
|
| 1289 | + * @return void |
|
| 1290 | + */ |
|
| 1291 | + protected function _registration_details() |
|
| 1292 | + { |
|
| 1293 | + $this->_template_args = array(); |
|
| 1294 | + $this->_set_registration_object(); |
|
| 1295 | + if (is_object($this->_registration)) { |
|
| 1296 | + $transaction = $this->_registration->transaction() ? $this->_registration->transaction() |
|
| 1297 | + : EE_Transaction::new_instance(); |
|
| 1298 | + $this->_session = $transaction->session_data(); |
|
| 1299 | + $event_id = $this->_registration->event_ID(); |
|
| 1300 | + $this->_template_args['reg_nmbr']['value'] = $this->_registration->ID(); |
|
| 1301 | + $this->_template_args['reg_nmbr']['label'] = __('Registration Number', 'event_espresso'); |
|
| 1302 | + $this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date'); |
|
| 1303 | + $this->_template_args['reg_datetime']['label'] = __('Date', 'event_espresso'); |
|
| 1304 | + $this->_template_args['grand_total'] = $transaction->total(); |
|
| 1305 | + $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 1306 | + // link back to overview |
|
| 1307 | + $this->_template_args['reg_overview_url'] = REG_ADMIN_URL; |
|
| 1308 | + $this->_template_args['registration'] = $this->_registration; |
|
| 1309 | + $this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1310 | + 'action' => 'default', |
|
| 1311 | + 'event_id' => $event_id, |
|
| 1312 | + ), REG_ADMIN_URL); |
|
| 1313 | + $this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1314 | + 'action' => 'default', |
|
| 1315 | + 'EVT_ID' => $event_id, |
|
| 1316 | + 'page' => 'espresso_transactions', |
|
| 1317 | + ), admin_url('admin.php')); |
|
| 1318 | + $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1319 | + 'page' => 'espresso_events', |
|
| 1320 | + 'action' => 'edit', |
|
| 1321 | + 'post' => $event_id, |
|
| 1322 | + ), admin_url('admin.php')); |
|
| 1323 | + //next and previous links |
|
| 1324 | + $next_reg = $this->_registration->next(null, array(), 'REG_ID'); |
|
| 1325 | + $this->_template_args['next_registration'] = $next_reg |
|
| 1326 | + ? $this->_next_link(EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1327 | + 'action' => 'view_registration', |
|
| 1328 | + '_REG_ID' => $next_reg['REG_ID'], |
|
| 1329 | + ), REG_ADMIN_URL), 'dashicons dashicons-arrow-right ee-icon-size-22') : ''; |
|
| 1330 | + $previous_reg = $this->_registration->previous(null, array(), 'REG_ID'); |
|
| 1331 | + $this->_template_args['previous_registration'] = $previous_reg |
|
| 1332 | + ? $this->_previous_link(EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1333 | + 'action' => 'view_registration', |
|
| 1334 | + '_REG_ID' => $previous_reg['REG_ID'], |
|
| 1335 | + ), REG_ADMIN_URL), 'dashicons dashicons-arrow-left ee-icon-size-22') : ''; |
|
| 1336 | + // grab header |
|
| 1337 | + $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php'; |
|
| 1338 | + $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
| 1339 | + $this->_template_args['admin_page_header'] = EEH_Template::display_template($template_path, |
|
| 1340 | + $this->_template_args, true); |
|
| 1341 | + } else { |
|
| 1342 | + $this->_template_args['admin_page_header'] = $this->display_espresso_notices(); |
|
| 1343 | + } |
|
| 1344 | + // the details template wrapper |
|
| 1345 | + $this->display_admin_page_with_sidebar(); |
|
| 1346 | + } |
|
| 1347 | + |
|
| 1348 | + |
|
| 1349 | + protected function _registration_details_metaboxes() |
|
| 1350 | + { |
|
| 1351 | + do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this); |
|
| 1352 | + $this->_set_registration_object(); |
|
| 1353 | + $attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null; |
|
| 1354 | + add_meta_box('edit-reg-status-mbox', __('Registration Status', 'event_espresso'), |
|
| 1355 | + array($this, 'set_reg_status_buttons_metabox'), $this->wp_page_slug, 'normal', 'high'); |
|
| 1356 | + add_meta_box('edit-reg-details-mbox', __('Registration Details', 'event_espresso'), |
|
| 1357 | + array($this, '_reg_details_meta_box'), $this->wp_page_slug, 'normal', 'high'); |
|
| 1358 | + if ($attendee instanceof EE_Attendee |
|
| 1359 | + && EE_Registry::instance()->CAP->current_user_can('ee_edit_registration', 'edit-reg-questions-mbox') |
|
| 1360 | + ) { |
|
| 1361 | + add_meta_box('edit-reg-questions-mbox', __('Registration Form Answers', 'event_espresso'), |
|
| 1362 | + array($this, '_reg_questions_meta_box'), $this->wp_page_slug, 'normal', 'high'); |
|
| 1363 | + } |
|
| 1364 | + add_meta_box('edit-reg-registrant-mbox', __('Contact Details', 'event_espresso'), |
|
| 1365 | + array($this, '_reg_registrant_side_meta_box'), $this->wp_page_slug, 'side', 'high'); |
|
| 1366 | + if ($this->_registration->group_size() > 1) { |
|
| 1367 | + add_meta_box('edit-reg-attendees-mbox', __('Other Registrations in this Transaction', 'event_espresso'), |
|
| 1368 | + array($this, '_reg_attendees_meta_box'), $this->wp_page_slug, 'normal', 'high'); |
|
| 1369 | + } |
|
| 1370 | + } |
|
| 1371 | + |
|
| 1372 | + |
|
| 1373 | + /** |
|
| 1374 | + * set_reg_status_buttons_metabox |
|
| 1375 | + * |
|
| 1376 | + * @access protected |
|
| 1377 | + * @return string |
|
| 1378 | + * @throws \EE_Error |
|
| 1379 | + */ |
|
| 1380 | + public function set_reg_status_buttons_metabox() |
|
| 1381 | + { |
|
| 1382 | + $this->_set_registration_object(); |
|
| 1383 | + $change_reg_status_form = $this->_generate_reg_status_change_form(); |
|
| 1384 | + echo $change_reg_status_form->form_open(self::add_query_args_and_nonce(array( |
|
| 1385 | + 'action' => 'change_reg_status', |
|
| 1386 | + ), REG_ADMIN_URL)); |
|
| 1387 | + echo $change_reg_status_form->get_html(); |
|
| 1388 | + echo $change_reg_status_form->form_close(); |
|
| 1389 | + } |
|
| 1390 | + |
|
| 1391 | + |
|
| 1392 | + /** |
|
| 1393 | + * @return EE_Form_Section_Proper |
|
| 1394 | + */ |
|
| 1395 | + protected function _generate_reg_status_change_form() |
|
| 1396 | + { |
|
| 1397 | + return new EE_Form_Section_Proper(array( |
|
| 1398 | + 'name' => 'reg_status_change_form', |
|
| 1399 | + 'html_id' => 'reg-status-change-form', |
|
| 1400 | + 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
| 1401 | + 'subsections' => array( |
|
| 1402 | + 'return' => new EE_Hidden_Input(array( |
|
| 1403 | + 'name' => 'return', |
|
| 1404 | + 'default' => 'view_registration', |
|
| 1405 | + )), |
|
| 1406 | + 'REG_ID' => new EE_Hidden_Input(array( |
|
| 1407 | + 'name' => 'REG_ID', |
|
| 1408 | + 'default' => $this->_registration->ID(), |
|
| 1409 | + )), |
|
| 1410 | + 'current_status' => new EE_Form_Section_HTML(EEH_HTML::tr(EEH_HTML::th(EEH_HTML::label(EEH_HTML::strong(__('Current Registration Status', |
|
| 1411 | + 'event_espresso')))) . EEH_HTML::td(EEH_HTML::strong($this->_registration->pretty_status(), |
|
| 1412 | + '', 'status-' . $this->_registration->status_ID(), |
|
| 1413 | + 'line-height: 1em; font-size: 1.5em; font-weight: bold;')))), |
|
| 1414 | + 'reg_status' => new EE_Select_Input($this->_get_reg_statuses(), array( |
|
| 1415 | + 'html_label_text' => __('Change Registration Status to', 'event_espresso'), |
|
| 1416 | + 'default' => $this->_registration->status_ID(), |
|
| 1417 | + )), |
|
| 1418 | + 'send_notifications' => new EE_Yes_No_Input(array( |
|
| 1419 | + 'html_label_text' => __('Send Related Messages', 'event_espresso'), |
|
| 1420 | + 'default' => false, |
|
| 1421 | + 'html_help_text' => __('If set to "Yes", then the related messages will be sent to the registrant.', |
|
| 1422 | + 'event_espresso'), |
|
| 1423 | + )), |
|
| 1424 | + 'submit' => new EE_Submit_Input(array( |
|
| 1425 | + 'html_class' => 'button-primary', |
|
| 1426 | + 'html_label_text' => ' ', |
|
| 1427 | + 'default' => __('Update Registration Status', 'event_espresso'), |
|
| 1428 | + )), |
|
| 1429 | + ), |
|
| 1430 | + )); |
|
| 1431 | + } |
|
| 1432 | + |
|
| 1433 | + |
|
| 1434 | + |
|
| 1435 | + /** |
|
| 1436 | + * Returns an array of all the buttons for the various statuses and switch status actions |
|
| 1437 | + * |
|
| 1438 | + * @return array |
|
| 1439 | + */ |
|
| 1440 | + protected function _get_reg_statuses() |
|
| 1441 | + { |
|
| 1442 | + $reg_status_array = EEM_Registration::instance()->reg_status_array(); |
|
| 1443 | + unset ($reg_status_array[EEM_Registration::status_id_incomplete]); |
|
| 1444 | + // get current reg status |
|
| 1445 | + $current_status = $this->_registration->status_ID(); |
|
| 1446 | + // is registration for free event? This will determine whether to display the pending payment option |
|
| 1447 | + if ($current_status != EEM_Registration::status_id_pending_payment |
|
| 1448 | + && $this->_registration->transaction() |
|
| 1449 | + ->is_free() |
|
| 1450 | + ) { |
|
| 1451 | + unset($reg_status_array[EEM_Registration::status_id_pending_payment]); |
|
| 1452 | + } |
|
| 1453 | + return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence'); |
|
| 1454 | + } |
|
| 1455 | + |
|
| 1456 | + |
|
| 1457 | + /** |
|
| 1458 | + * This method is used when using _REG_ID from request which may or may not be an array of reg_ids. |
|
| 1459 | + * |
|
| 1460 | + * @param bool $status REG status given for changing registrations to. |
|
| 1461 | + * @param bool $notify Whether to send messages notifications or not. |
|
| 1462 | + * @return array (array with reg_id(s) updated and whether update was successful. |
|
| 1463 | + */ |
|
| 1464 | + protected function _set_registration_status_from_request($status = false, $notify = false) |
|
| 1465 | + { |
|
| 1466 | + if (isset($this->_req_data['reg_status_change_form'])) { |
|
| 1467 | + $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID']) |
|
| 1468 | + ? (array)$this->_req_data['reg_status_change_form']['REG_ID'] : array(); |
|
| 1469 | + } else { |
|
| 1470 | + $REG_IDs = isset($this->_req_data['_REG_ID']) ? (array)$this->_req_data['_REG_ID'] : array(); |
|
| 1471 | + } |
|
| 1472 | + $success = $this->_set_registration_status($REG_IDs, $status); |
|
| 1473 | + //notify? |
|
| 1474 | + if ($success |
|
| 1475 | + && $notify |
|
| 1476 | + && EE_Registry::instance()->CAP->current_user_can('ee_send_message', |
|
| 1477 | + 'espresso_registrations_resend_registration') |
|
| 1478 | + ) { |
|
| 1479 | + $this->_process_resend_registration(); |
|
| 1480 | + } |
|
| 1481 | + return $success; |
|
| 1482 | + } |
|
| 1483 | + |
|
| 1484 | + |
|
| 1485 | + /** |
|
| 1486 | + * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an |
|
| 1487 | + * array). Note, this method does NOT take care of possible notifications. That is required by calling code. |
|
| 1488 | + * |
|
| 1489 | + * @param array $REG_IDs |
|
| 1490 | + * @param bool $status |
|
| 1491 | + * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as |
|
| 1492 | + * the array of updated registrations). |
|
| 1493 | + */ |
|
| 1494 | + protected function _set_registration_status($REG_IDs = array(), $status = false) |
|
| 1495 | + { |
|
| 1496 | + $success = false; |
|
| 1497 | + // typecast $REG_IDs |
|
| 1498 | + $REG_IDs = (array)$REG_IDs; |
|
| 1499 | + if ( ! empty($REG_IDs)) { |
|
| 1500 | + $success = true; |
|
| 1501 | + // set default status if none is passed |
|
| 1502 | + $status = $status ? $status : EEM_Registration::status_id_pending_payment; |
|
| 1503 | + // sanitize $REG_IDs |
|
| 1504 | + $REG_IDs = array_filter($REG_IDs, 'absint'); |
|
| 1505 | + //loop through REG_ID's and change status |
|
| 1506 | + foreach ($REG_IDs as $REG_ID) { |
|
| 1507 | + $registration = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
| 1508 | + if ($registration instanceof EE_Registration) { |
|
| 1509 | + $registration->set_status($status); |
|
| 1510 | + $result = $registration->save(); |
|
| 1511 | + // verifying explicit fails because update *may* just return 0 for 0 rows affected |
|
| 1512 | + $success = $result !== false ? $success : false; |
|
| 1513 | + } |
|
| 1514 | + } |
|
| 1515 | + } |
|
| 1516 | + //reset _req_data['_REG_ID'] for any potential future messages notifications |
|
| 1517 | + $this->_req_data['_REG_ID'] = $REG_IDs; |
|
| 1518 | + //return $success and processed registrations |
|
| 1519 | + return array('REG_ID' => $REG_IDs, 'success' => $success); |
|
| 1520 | + } |
|
| 1521 | + |
|
| 1522 | + |
|
| 1523 | + /** |
|
| 1524 | + * Common logic for setting up success message and redirecting to appropriate route |
|
| 1525 | + * |
|
| 1526 | + * @param string $STS_ID status id for the registration changed to |
|
| 1527 | + * @param bool $notify indicates whether the _set_registration_status_from_request does notifications or not. |
|
| 1528 | + * @return void |
|
| 1529 | + */ |
|
| 1530 | + protected function _reg_status_change_return($STS_ID, $notify = false) |
|
| 1531 | + { |
|
| 1532 | + $result = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify) |
|
| 1533 | + : array('success' => false); |
|
| 1534 | + $success = isset($result['success']) && $result['success']; |
|
| 1535 | + //setup success message |
|
| 1536 | + if ($success) { |
|
| 1537 | + if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) { |
|
| 1538 | + $msg = sprintf(__('Registration status has been set to %s', 'event_espresso'), |
|
| 1539 | + EEH_Template::pretty_status($STS_ID, false, 'lower')); |
|
| 1540 | + } else { |
|
| 1541 | + $msg = sprintf(__('Registrations have been set to %s.', 'event_espresso'), |
|
| 1542 | + EEH_Template::pretty_status($STS_ID, false, 'lower')); |
|
| 1543 | + } |
|
| 1544 | + EE_Error::add_success($msg); |
|
| 1545 | + } else { |
|
| 1546 | + EE_Error::add_error(__('Something went wrong, and the status was not changed', 'event_espresso'), __FILE__, |
|
| 1547 | + __LINE__, __FUNCTION__); |
|
| 1548 | + } |
|
| 1549 | + if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') { |
|
| 1550 | + $route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID'])); |
|
| 1551 | + } else { |
|
| 1552 | + $route = array('action' => 'default'); |
|
| 1553 | + } |
|
| 1554 | + //unset nonces |
|
| 1555 | + foreach ($this->_req_data as $ref => $value) { |
|
| 1556 | + if (strpos($ref, 'nonce') !== false) { |
|
| 1557 | + unset($this->_req_data[$ref]); |
|
| 1558 | + continue; |
|
| 1559 | + } |
|
| 1560 | + $value = is_array($value) ? array_map('urlencode', $value) : urlencode($value); |
|
| 1561 | + $this->_req_data[$ref] = $value; |
|
| 1562 | + } |
|
| 1563 | + //merge request vars so that the reloaded list table contains any existing filter query params |
|
| 1564 | + $route = array_merge($this->_req_data, $route); |
|
| 1565 | + $this->_redirect_after_action($success, '', '', $route, true); |
|
| 1566 | + } |
|
| 1567 | + |
|
| 1568 | + |
|
| 1569 | + /** |
|
| 1570 | + * incoming reg status change from reg details page. |
|
| 1571 | + * |
|
| 1572 | + * @return void |
|
| 1573 | + */ |
|
| 1574 | + protected function _change_reg_status() |
|
| 1575 | + { |
|
| 1576 | + $this->_req_data['return'] = 'view_registration'; |
|
| 1577 | + //set notify based on whether the send notifications toggle is set or not |
|
| 1578 | + $notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']); |
|
| 1579 | + //$notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] ); |
|
| 1580 | + $this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status']) |
|
| 1581 | + ? $this->_req_data['reg_status_change_form']['reg_status'] : ''; |
|
| 1582 | + switch ($this->_req_data['reg_status_change_form']['reg_status']) { |
|
| 1583 | + case EEM_Registration::status_id_approved : |
|
| 1584 | + case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence') : |
|
| 1585 | + $this->approve_registration($notify); |
|
| 1586 | + break; |
|
| 1587 | + case EEM_Registration::status_id_pending_payment : |
|
| 1588 | + case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence') : |
|
| 1589 | + $this->pending_registration($notify); |
|
| 1590 | + break; |
|
| 1591 | + case EEM_Registration::status_id_not_approved : |
|
| 1592 | + case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence') : |
|
| 1593 | + $this->not_approve_registration($notify); |
|
| 1594 | + break; |
|
| 1595 | + case EEM_Registration::status_id_declined : |
|
| 1596 | + case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence') : |
|
| 1597 | + $this->decline_registration($notify); |
|
| 1598 | + break; |
|
| 1599 | + case EEM_Registration::status_id_cancelled : |
|
| 1600 | + case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence') : |
|
| 1601 | + $this->cancel_registration($notify); |
|
| 1602 | + break; |
|
| 1603 | + case EEM_Registration::status_id_wait_list : |
|
| 1604 | + case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence') : |
|
| 1605 | + $this->waitlist_registration($notify); |
|
| 1606 | + break; |
|
| 1607 | + case EEM_Registration::status_id_incomplete : |
|
| 1608 | + default : |
|
| 1609 | + $result['success'] = false; |
|
| 1610 | + unset($this->_req_data['return']); |
|
| 1611 | + $this->_reg_status_change_return('', false); |
|
| 1612 | + break; |
|
| 1613 | + } |
|
| 1614 | + } |
|
| 1615 | + |
|
| 1616 | + |
|
| 1617 | + /** |
|
| 1618 | + * approve_registration |
|
| 1619 | + * |
|
| 1620 | + * @access protected |
|
| 1621 | + * @param bool $notify whether or not to notify the registrant about their approval. |
|
| 1622 | + * @return void |
|
| 1623 | + */ |
|
| 1624 | + protected function approve_registration($notify = false) |
|
| 1625 | + { |
|
| 1626 | + $this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify); |
|
| 1627 | + } |
|
| 1628 | + |
|
| 1629 | + |
|
| 1630 | + /** |
|
| 1631 | + * decline_registration |
|
| 1632 | + * |
|
| 1633 | + * @access protected |
|
| 1634 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 1635 | + * @return void |
|
| 1636 | + */ |
|
| 1637 | + protected function decline_registration($notify = false) |
|
| 1638 | + { |
|
| 1639 | + $this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify); |
|
| 1640 | + } |
|
| 1641 | + |
|
| 1642 | + |
|
| 1643 | + /** |
|
| 1644 | + * cancel_registration |
|
| 1645 | + * |
|
| 1646 | + * @access protected |
|
| 1647 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 1648 | + * @return void |
|
| 1649 | + */ |
|
| 1650 | + protected function cancel_registration($notify = false) |
|
| 1651 | + { |
|
| 1652 | + $this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify); |
|
| 1653 | + } |
|
| 1654 | + |
|
| 1655 | + |
|
| 1656 | + /** |
|
| 1657 | + * not_approve_registration |
|
| 1658 | + * |
|
| 1659 | + * @access protected |
|
| 1660 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 1661 | + * @return void |
|
| 1662 | + */ |
|
| 1663 | + protected function not_approve_registration($notify = false) |
|
| 1664 | + { |
|
| 1665 | + $this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify); |
|
| 1666 | + } |
|
| 1667 | + |
|
| 1668 | + |
|
| 1669 | + /** |
|
| 1670 | + * decline_registration |
|
| 1671 | + * |
|
| 1672 | + * @access protected |
|
| 1673 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 1674 | + * @return void |
|
| 1675 | + */ |
|
| 1676 | + protected function pending_registration($notify = false) |
|
| 1677 | + { |
|
| 1678 | + $this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify); |
|
| 1679 | + } |
|
| 1680 | + |
|
| 1681 | + |
|
| 1682 | + /** |
|
| 1683 | + * waitlist_registration |
|
| 1684 | + * |
|
| 1685 | + * @access protected |
|
| 1686 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
| 1687 | + * @return void |
|
| 1688 | + */ |
|
| 1689 | + protected function waitlist_registration($notify = false) |
|
| 1690 | + { |
|
| 1691 | + $this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify); |
|
| 1692 | + } |
|
| 1693 | + |
|
| 1694 | + |
|
| 1695 | + /** |
|
| 1696 | + * generates HTML for the Registration main meta box |
|
| 1697 | + * |
|
| 1698 | + * @access public |
|
| 1699 | + * @return void |
|
| 1700 | + */ |
|
| 1701 | + public function _reg_details_meta_box() |
|
| 1702 | + { |
|
| 1703 | + EEH_Autoloader::register_line_item_display_autoloaders(); |
|
| 1704 | + EEH_Autoloader::register_line_item_filter_autoloaders(); |
|
| 1705 | + EE_Registry::instance()->load_helper('Line_Item'); |
|
| 1706 | + $transaction = $this->_registration->transaction() ? $this->_registration->transaction() |
|
| 1707 | + : EE_Transaction::new_instance(); |
|
| 1708 | + $this->_session = $transaction->session_data(); |
|
| 1709 | + $filters = new EE_Line_Item_Filter_Collection(); |
|
| 1710 | + //$filters->add( new EE_Non_Zero_Line_Item_Filter() ); |
|
| 1711 | + $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration)); |
|
| 1712 | + $line_item_filter_processor = new EE_Line_Item_Filter_Processor($filters, |
|
| 1713 | + $transaction->total_line_item()); |
|
| 1714 | + $filtered_line_item_tree = $line_item_filter_processor->process(); |
|
| 1715 | + $line_item_display = new EE_Line_Item_Display('reg_admin_table', |
|
| 1716 | + 'EE_Admin_Table_Registration_Line_Item_Display_Strategy'); |
|
| 1717 | + $this->_template_args['line_item_table'] = $line_item_display->display_line_item($filtered_line_item_tree, |
|
| 1718 | + array('EE_Registration' => $this->_registration)); |
|
| 1719 | + $attendee = $this->_registration->attendee(); |
|
| 1720 | + if (EE_Registry::instance()->CAP->current_user_can('ee_read_transaction', |
|
| 1721 | + 'espresso_transactions_view_transaction') |
|
| 1722 | + ) { |
|
| 1723 | + $this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1724 | + 'action' => 'view_transaction', |
|
| 1725 | + 'TXN_ID' => $transaction->ID(), |
|
| 1726 | + ), TXN_ADMIN_URL), esc_html__(' View Transaction'), 'button secondary-button right', |
|
| 1727 | + 'dashicons dashicons-cart'); |
|
| 1728 | + } else { |
|
| 1729 | + $this->_template_args['view_transaction_button'] = ''; |
|
| 1730 | + } |
|
| 1731 | + if ($attendee instanceof EE_Attendee |
|
| 1732 | + && EE_Registry::instance()->CAP->current_user_can('ee_send_message', |
|
| 1733 | + 'espresso_registrations_resend_registration') |
|
| 1734 | + ) { |
|
| 1735 | + $this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1736 | + 'action' => 'resend_registration', |
|
| 1737 | + '_REG_ID' => $this->_registration->ID(), |
|
| 1738 | + 'redirect_to' => 'view_registration', |
|
| 1739 | + ), REG_ADMIN_URL), esc_html__(' Resend Registration'), 'button secondary-button right', |
|
| 1740 | + 'dashicons dashicons-email-alt'); |
|
| 1741 | + } else { |
|
| 1742 | + $this->_template_args['resend_registration_button'] = ''; |
|
| 1743 | + } |
|
| 1744 | + $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 1745 | + $payment = $transaction->get_first_related('Payment'); |
|
| 1746 | + $payment = ! $payment instanceof EE_Payment ? EE_Payment::new_instance() : $payment; |
|
| 1747 | + $payment_method = $payment->get_first_related('Payment_Method'); |
|
| 1748 | + $payment_method = ! $payment_method instanceof EE_Payment_Method ? EE_Payment_Method::new_instance() |
|
| 1749 | + : $payment_method; |
|
| 1750 | + $reg_details = array( |
|
| 1751 | + 'payment_method' => $payment_method->name(), |
|
| 1752 | + 'response_msg' => $payment->gateway_response(), |
|
| 1753 | + 'registration_id' => $this->_registration->get('REG_code'), |
|
| 1754 | + 'registration_session' => $this->_registration->session_ID(), |
|
| 1755 | + 'ip_address' => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '', |
|
| 1756 | + 'user_agent' => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '', |
|
| 1757 | + ); |
|
| 1758 | + if (isset($reg_details['registration_id'])) { |
|
| 1759 | + $this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id']; |
|
| 1760 | + $this->_template_args['reg_details']['registration_id']['label'] = __('Registration ID', 'event_espresso'); |
|
| 1761 | + $this->_template_args['reg_details']['registration_id']['class'] = 'regular-text'; |
|
| 1762 | + } |
|
| 1763 | + if (isset($reg_details['payment_method'])) { |
|
| 1764 | + $this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method']; |
|
| 1765 | + $this->_template_args['reg_details']['payment_method']['label'] = __('Most Recent Payment Method', |
|
| 1766 | + 'event_espresso'); |
|
| 1767 | + $this->_template_args['reg_details']['payment_method']['class'] = 'regular-text'; |
|
| 1768 | + $this->_template_args['reg_details']['response_msg']['value'] = $reg_details['response_msg']; |
|
| 1769 | + $this->_template_args['reg_details']['response_msg']['label'] = __('Payment method response', |
|
| 1770 | + 'event_espresso'); |
|
| 1771 | + $this->_template_args['reg_details']['response_msg']['class'] = 'regular-text'; |
|
| 1772 | + } |
|
| 1773 | + $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session']; |
|
| 1774 | + $this->_template_args['reg_details']['registration_session']['label'] = __('Registration Session', |
|
| 1775 | + 'event_espresso'); |
|
| 1776 | + $this->_template_args['reg_details']['registration_session']['class'] = 'regular-text'; |
|
| 1777 | + $this->_template_args['reg_details']['ip_address']['value'] = $reg_details['ip_address']; |
|
| 1778 | + $this->_template_args['reg_details']['ip_address']['label'] = __('Registration placed from IP', |
|
| 1779 | + 'event_espresso'); |
|
| 1780 | + $this->_template_args['reg_details']['ip_address']['class'] = 'regular-text'; |
|
| 1781 | + $this->_template_args['reg_details']['user_agent']['value'] = $reg_details['user_agent']; |
|
| 1782 | + $this->_template_args['reg_details']['user_agent']['label'] = __('Registrant User Agent', |
|
| 1783 | + 'event_espresso'); |
|
| 1784 | + $this->_template_args['reg_details']['user_agent']['class'] = 'large-text'; |
|
| 1785 | + $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1786 | + 'action' => 'default', |
|
| 1787 | + 'event_id' => $this->_registration->event_ID(), |
|
| 1788 | + ), REG_ADMIN_URL); |
|
| 1789 | + $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
| 1790 | + $this->_template_args['event_id'] = $this->_registration->event_ID(); |
|
| 1791 | + $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php'; |
|
| 1792 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 1793 | + } |
|
| 1794 | + |
|
| 1795 | + |
|
| 1796 | + /** |
|
| 1797 | + * generates HTML for the Registration Questions meta box. |
|
| 1798 | + * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters), |
|
| 1799 | + * otherwise uses new forms system |
|
| 1800 | + * |
|
| 1801 | + * @access public |
|
| 1802 | + * @return void |
|
| 1803 | + */ |
|
| 1804 | + public function _reg_questions_meta_box() |
|
| 1805 | + { |
|
| 1806 | + //allow someone to override this method entirely |
|
| 1807 | + if (apply_filters('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', true, $this, |
|
| 1808 | + $this->_registration)) { |
|
| 1809 | + $form = $this->_get_reg_custom_questions_form($this->_registration->ID()); |
|
| 1810 | + $this->_template_args['att_questions'] = count($form->subforms()) > 0 ? $form->get_html_and_js() : ''; |
|
| 1811 | + $this->_template_args['reg_questions_form_action'] = 'edit_registration'; |
|
| 1812 | + $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
| 1813 | + $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
| 1814 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 1815 | + } |
|
| 1816 | + } |
|
| 1817 | + |
|
| 1818 | + |
|
| 1819 | + /** |
|
| 1820 | + * form_before_question_group |
|
| 1821 | + * |
|
| 1822 | + * @deprecated as of 4.8.32.rc.000 |
|
| 1823 | + * @access public |
|
| 1824 | + * @param string $output |
|
| 1825 | + * @return string |
|
| 1826 | + */ |
|
| 1827 | + public function form_before_question_group($output) |
|
| 1828 | + { |
|
| 1829 | + EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__, |
|
| 1830 | + __('This method would have been protected but was used on a filter callback' |
|
| 1831 | + . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'), |
|
| 1832 | + '4.8.32.rc.000'); |
|
| 1833 | + return ' |
|
| 1834 | 1834 | <table class="form-table ee-width-100"> |
| 1835 | 1835 | <tbody> |
| 1836 | 1836 | '; |
| 1837 | - } |
|
| 1838 | - |
|
| 1839 | - |
|
| 1840 | - /** |
|
| 1841 | - * form_after_question_group |
|
| 1842 | - * |
|
| 1843 | - * @deprecated as of 4.8.32.rc.000 |
|
| 1844 | - * @access public |
|
| 1845 | - * @param string $output |
|
| 1846 | - * @return string |
|
| 1847 | - */ |
|
| 1848 | - public function form_after_question_group($output) |
|
| 1849 | - { |
|
| 1850 | - EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__, |
|
| 1851 | - __('This method would have been protected but was used on a filter callback' |
|
| 1852 | - . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'), |
|
| 1853 | - '4.8.32.rc.000'); |
|
| 1854 | - return ' |
|
| 1837 | + } |
|
| 1838 | + |
|
| 1839 | + |
|
| 1840 | + /** |
|
| 1841 | + * form_after_question_group |
|
| 1842 | + * |
|
| 1843 | + * @deprecated as of 4.8.32.rc.000 |
|
| 1844 | + * @access public |
|
| 1845 | + * @param string $output |
|
| 1846 | + * @return string |
|
| 1847 | + */ |
|
| 1848 | + public function form_after_question_group($output) |
|
| 1849 | + { |
|
| 1850 | + EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__, |
|
| 1851 | + __('This method would have been protected but was used on a filter callback' |
|
| 1852 | + . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'), |
|
| 1853 | + '4.8.32.rc.000'); |
|
| 1854 | + return ' |
|
| 1855 | 1855 | <tr class="hide-if-no-js"> |
| 1856 | 1856 | <th> </th> |
| 1857 | 1857 | <td class="reg-admin-edit-attendee-question-td"> |
| 1858 | 1858 | <a class="reg-admin-edit-attendee-question-lnk" href="#" title="' |
| 1859 | - . esc_attr__('click to edit question', 'event_espresso') |
|
| 1860 | - . '"> |
|
| 1859 | + . esc_attr__('click to edit question', 'event_espresso') |
|
| 1860 | + . '"> |
|
| 1861 | 1861 | <span class="reg-admin-edit-question-group-spn lt-grey-txt">' |
| 1862 | - . __('edit the above question group', 'event_espresso') |
|
| 1863 | - . '</span> |
|
| 1862 | + . __('edit the above question group', 'event_espresso') |
|
| 1863 | + . '</span> |
|
| 1864 | 1864 | <div class="dashicons dashicons-edit"></div> |
| 1865 | 1865 | </a> |
| 1866 | 1866 | </td> |
@@ -1868,490 +1868,490 @@ discard block |
||
| 1868 | 1868 | </tbody> |
| 1869 | 1869 | </table> |
| 1870 | 1870 | '; |
| 1871 | - } |
|
| 1872 | - |
|
| 1873 | - |
|
| 1874 | - /** |
|
| 1875 | - * form_form_field_label_wrap |
|
| 1876 | - * |
|
| 1877 | - * @deprecated as of 4.8.32.rc.000 |
|
| 1878 | - * @access public |
|
| 1879 | - * @param string $label |
|
| 1880 | - * @return string |
|
| 1881 | - */ |
|
| 1882 | - public function form_form_field_label_wrap($label) |
|
| 1883 | - { |
|
| 1884 | - EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__, |
|
| 1885 | - __('This method would have been protected but was used on a filter callback' |
|
| 1886 | - . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'), |
|
| 1887 | - '4.8.32.rc.000'); |
|
| 1888 | - return ' |
|
| 1871 | + } |
|
| 1872 | + |
|
| 1873 | + |
|
| 1874 | + /** |
|
| 1875 | + * form_form_field_label_wrap |
|
| 1876 | + * |
|
| 1877 | + * @deprecated as of 4.8.32.rc.000 |
|
| 1878 | + * @access public |
|
| 1879 | + * @param string $label |
|
| 1880 | + * @return string |
|
| 1881 | + */ |
|
| 1882 | + public function form_form_field_label_wrap($label) |
|
| 1883 | + { |
|
| 1884 | + EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__, |
|
| 1885 | + __('This method would have been protected but was used on a filter callback' |
|
| 1886 | + . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'), |
|
| 1887 | + '4.8.32.rc.000'); |
|
| 1888 | + return ' |
|
| 1889 | 1889 | <tr> |
| 1890 | 1890 | <th> |
| 1891 | 1891 | ' . $label . ' |
| 1892 | 1892 | </th>'; |
| 1893 | - } |
|
| 1894 | - |
|
| 1895 | - |
|
| 1896 | - /** |
|
| 1897 | - * form_form_field_input__wrap |
|
| 1898 | - * |
|
| 1899 | - * @deprecated as of 4.8.32.rc.000 |
|
| 1900 | - * @access public |
|
| 1901 | - * @param string $input |
|
| 1902 | - * @return string |
|
| 1903 | - */ |
|
| 1904 | - public function form_form_field_input__wrap($input) |
|
| 1905 | - { |
|
| 1906 | - EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__, |
|
| 1907 | - __('This method would have been protected but was used on a filter callback' |
|
| 1908 | - . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'), |
|
| 1909 | - '4.8.32.rc.000'); |
|
| 1910 | - return ' |
|
| 1893 | + } |
|
| 1894 | + |
|
| 1895 | + |
|
| 1896 | + /** |
|
| 1897 | + * form_form_field_input__wrap |
|
| 1898 | + * |
|
| 1899 | + * @deprecated as of 4.8.32.rc.000 |
|
| 1900 | + * @access public |
|
| 1901 | + * @param string $input |
|
| 1902 | + * @return string |
|
| 1903 | + */ |
|
| 1904 | + public function form_form_field_input__wrap($input) |
|
| 1905 | + { |
|
| 1906 | + EE_Error::doing_it_wrong(__CLASS__ . '::' . __FUNCTION__, |
|
| 1907 | + __('This method would have been protected but was used on a filter callback' |
|
| 1908 | + . 'so needed to be public. Please discontinue usage as it will be removed soon.', 'event_espresso'), |
|
| 1909 | + '4.8.32.rc.000'); |
|
| 1910 | + return ' |
|
| 1911 | 1911 | <td class="reg-admin-attendee-questions-input-td disabled-input"> |
| 1912 | 1912 | ' . $input . ' |
| 1913 | 1913 | </td> |
| 1914 | 1914 | </tr>'; |
| 1915 | - } |
|
| 1916 | - |
|
| 1917 | - |
|
| 1918 | - /** |
|
| 1919 | - * Updates the registration's custom questions according to the form info, if the form is submitted. |
|
| 1920 | - * If it's not a post, the "view_registrations" route will be called next on the SAME request |
|
| 1921 | - * to display the page |
|
| 1922 | - * |
|
| 1923 | - * @access protected |
|
| 1924 | - * @return void |
|
| 1925 | - */ |
|
| 1926 | - protected function _update_attendee_registration_form() |
|
| 1927 | - { |
|
| 1928 | - do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this); |
|
| 1929 | - if ($_SERVER['REQUEST_METHOD'] == 'POST') { |
|
| 1930 | - $REG_ID = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false; |
|
| 1931 | - $success = $this->_save_reg_custom_questions_form($REG_ID); |
|
| 1932 | - if ($success) { |
|
| 1933 | - $what = __('Registration Form', 'event_espresso'); |
|
| 1934 | - $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) |
|
| 1935 | - : array('action' => 'default'); |
|
| 1936 | - $this->_redirect_after_action($success, $what, __('updated', 'event_espresso'), $route); |
|
| 1937 | - } |
|
| 1938 | - } |
|
| 1939 | - } |
|
| 1940 | - |
|
| 1941 | - |
|
| 1942 | - /** |
|
| 1943 | - * Gets the form for saving registrations custom questions (if done |
|
| 1944 | - * previously retrieves the cached form object, which may have validation errors in it) |
|
| 1945 | - * |
|
| 1946 | - * @param int $REG_ID |
|
| 1947 | - * @return EE_Registration_Custom_Questions_Form |
|
| 1948 | - */ |
|
| 1949 | - protected function _get_reg_custom_questions_form($REG_ID) |
|
| 1950 | - { |
|
| 1951 | - if ( ! $this->_reg_custom_questions_form) { |
|
| 1952 | - require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php'); |
|
| 1953 | - $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form( |
|
| 1954 | - EEM_Registration::instance()->get_one_by_ID($REG_ID) |
|
| 1955 | - ); |
|
| 1956 | - $this->_reg_custom_questions_form->_construct_finalize(null, null); |
|
| 1957 | - } |
|
| 1958 | - return $this->_reg_custom_questions_form; |
|
| 1959 | - } |
|
| 1960 | - |
|
| 1961 | - |
|
| 1962 | - /** |
|
| 1963 | - * Saves |
|
| 1964 | - * |
|
| 1965 | - * @access private |
|
| 1966 | - * @param bool $REG_ID |
|
| 1967 | - * @return bool |
|
| 1968 | - */ |
|
| 1969 | - private function _save_reg_custom_questions_form($REG_ID = false) |
|
| 1970 | - { |
|
| 1971 | - if ( ! $REG_ID) { |
|
| 1972 | - EE_Error::add_error(__('An error occurred. No registration ID was received.', 'event_espresso'), __FILE__, |
|
| 1973 | - __FUNCTION__, __LINE__); |
|
| 1974 | - } |
|
| 1975 | - $form = $this->_get_reg_custom_questions_form($REG_ID); |
|
| 1976 | - $form->receive_form_submission($this->_req_data); |
|
| 1977 | - $success = false; |
|
| 1978 | - if ($form->is_valid()) { |
|
| 1979 | - foreach ($form->subforms() as $question_group_id => $question_group_form) { |
|
| 1980 | - foreach ($question_group_form->inputs() as $question_id => $input) { |
|
| 1981 | - $where_conditions = array( |
|
| 1982 | - 'QST_ID' => $question_id, |
|
| 1983 | - 'REG_ID' => $REG_ID, |
|
| 1984 | - ); |
|
| 1985 | - $possibly_new_values = array( |
|
| 1986 | - 'ANS_value' => $input->normalized_value(), |
|
| 1987 | - ); |
|
| 1988 | - $answer = EEM_Answer::instance()->get_one(array($where_conditions)); |
|
| 1989 | - if ($answer instanceof EE_Answer) { |
|
| 1990 | - $success = $answer->save($possibly_new_values); |
|
| 1991 | - } else { |
|
| 1992 | - //insert it then |
|
| 1993 | - $cols_n_vals = array_merge($where_conditions, $possibly_new_values); |
|
| 1994 | - $answer = EE_Answer::new_instance($cols_n_vals); |
|
| 1995 | - $success = $answer->save(); |
|
| 1996 | - } |
|
| 1997 | - } |
|
| 1998 | - } |
|
| 1999 | - } else { |
|
| 2000 | - EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__); |
|
| 2001 | - } |
|
| 2002 | - return $success; |
|
| 2003 | - } |
|
| 2004 | - |
|
| 2005 | - |
|
| 2006 | - /** |
|
| 2007 | - * generates HTML for the Registration main meta box |
|
| 2008 | - * |
|
| 2009 | - * @access public |
|
| 2010 | - * @return void |
|
| 2011 | - */ |
|
| 2012 | - public function _reg_attendees_meta_box() |
|
| 2013 | - { |
|
| 2014 | - $REG = EEM_Registration::instance(); |
|
| 2015 | - //get all other registrations on this transaction, and cache |
|
| 2016 | - //the attendees for them so we don't have to run another query using force_join |
|
| 2017 | - $registrations = $REG->get_all(array( |
|
| 2018 | - array( |
|
| 2019 | - 'TXN_ID' => $this->_registration->transaction_ID(), |
|
| 2020 | - 'REG_ID' => array('!=', $this->_registration->ID()), |
|
| 2021 | - ), |
|
| 2022 | - 'force_join' => array('Attendee'), |
|
| 2023 | - )); |
|
| 2024 | - $this->_template_args['attendees'] = array(); |
|
| 2025 | - $this->_template_args['attendee_notice'] = ''; |
|
| 2026 | - if (empty($registrations) |
|
| 2027 | - || (is_array($registrations) |
|
| 2028 | - && ! EEH_Array::get_one_item_from_array($registrations)) |
|
| 2029 | - ) { |
|
| 2030 | - EE_Error::add_error(__('There are no records attached to this registration. Something may have gone wrong with the registration', |
|
| 2031 | - 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 2032 | - $this->_template_args['attendee_notice'] = EE_Error::get_notices(); |
|
| 2033 | - } else { |
|
| 2034 | - $att_nmbr = 1; |
|
| 2035 | - foreach ($registrations as $registration) { |
|
| 2036 | - /* @var $registration EE_Registration */ |
|
| 2037 | - $attendee = $registration->attendee() |
|
| 2038 | - ? $registration->attendee() |
|
| 2039 | - : EEM_Attendee::instance() |
|
| 2040 | - ->create_default_object(); |
|
| 2041 | - $this->_template_args['attendees'][$att_nmbr]['STS_ID'] = $registration->status_ID(); |
|
| 2042 | - $this->_template_args['attendees'][$att_nmbr]['fname'] = $attendee->fname();//( isset( $registration->ATT_fname ) & ! empty( $registration->ATT_fname ) ) ? $registration->ATT_fname : ''; |
|
| 2043 | - $this->_template_args['attendees'][$att_nmbr]['lname'] = $attendee->lname();//( isset( $registration->ATT_lname ) & ! empty( $registration->ATT_lname ) ) ? $registration->ATT_lname : ''; |
|
| 2044 | - $this->_template_args['attendees'][$att_nmbr]['email'] = $attendee->email();//( isset( $registration->ATT_email ) & ! empty( $registration->ATT_email ) ) ? $registration->ATT_email : ''; |
|
| 2045 | - $this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();//( isset( $registration->REG_final_price ) & ! empty( $registration->REG_final_price ) ) ? $registration->REG_final_price : ''; |
|
| 2046 | - $this->_template_args['attendees'][$att_nmbr]['address'] = implode(', ', |
|
| 2047 | - $attendee->full_address_as_array()); |
|
| 2048 | - $this->_template_args['attendees'][$att_nmbr]['att_link'] = self::add_query_args_and_nonce(array( |
|
| 2049 | - 'action' => 'edit_attendee', |
|
| 2050 | - 'post' => $attendee->ID(), |
|
| 2051 | - ), REG_ADMIN_URL); |
|
| 2052 | - $this->_template_args['attendees'][$att_nmbr]['event_name'] = $registration->event_obj()->name(); |
|
| 2053 | - $att_nmbr++; |
|
| 2054 | - } |
|
| 2055 | - //EEH_Debug_Tools::printr( $attendees, '$attendees <br /><span style="font-size:10px;font-weight:normal;">( file: '. __FILE__ . ' - line no: ' . __LINE__ . ' )</span>', 'auto' ); |
|
| 2056 | - $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 2057 | - // $this->_template_args['registration_form_url'] = add_query_arg( array( 'action' => 'edit_registration', 'process' => 'attendees' ), REG_ADMIN_URL ); |
|
| 2058 | - } |
|
| 2059 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php'; |
|
| 2060 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 2061 | - } |
|
| 2062 | - |
|
| 2063 | - |
|
| 2064 | - /** |
|
| 2065 | - * generates HTML for the Edit Registration side meta box |
|
| 2066 | - * |
|
| 2067 | - * @access public |
|
| 2068 | - * @return void |
|
| 2069 | - */ |
|
| 2070 | - public function _reg_registrant_side_meta_box() |
|
| 2071 | - { |
|
| 2072 | - /*@var $attendee EE_Attendee */ |
|
| 2073 | - $att_check = $this->_registration->attendee(); |
|
| 2074 | - $attendee = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object(); |
|
| 2075 | - //now let's determine if this is not the primary registration. If it isn't then we set the primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the primary registration object (that way we know if we need to show create button or not) |
|
| 2076 | - if ( ! $this->_registration->is_primary_registrant()) { |
|
| 2077 | - $primary_registration = $this->_registration->get_primary_registration(); |
|
| 2078 | - $primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee() |
|
| 2079 | - : null; |
|
| 2080 | - if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) { |
|
| 2081 | - //in here? This means the displayed registration is not the primary registrant but ALREADY HAS its own custom attendee object so let's not worry about the primary reg. |
|
| 2082 | - $primary_registration = null; |
|
| 2083 | - } |
|
| 2084 | - } else { |
|
| 2085 | - $primary_registration = null; |
|
| 2086 | - } |
|
| 2087 | - $this->_template_args['ATT_ID'] = $attendee->ID(); |
|
| 2088 | - $this->_template_args['fname'] = $attendee->fname();//$this->_registration->ATT_fname; |
|
| 2089 | - $this->_template_args['lname'] = $attendee->lname();//$this->_registration->ATT_lname; |
|
| 2090 | - $this->_template_args['email'] = $attendee->email();//$this->_registration->ATT_email; |
|
| 2091 | - $this->_template_args['phone'] = $attendee->phone(); |
|
| 2092 | - $this->_template_args['formatted_address'] = EEH_Address::format($attendee); |
|
| 2093 | - //edit link |
|
| 2094 | - $this->_template_args['att_edit_link'] = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 2095 | - 'action' => 'edit_attendee', |
|
| 2096 | - 'post' => $attendee->ID(), |
|
| 2097 | - ), REG_ADMIN_URL); |
|
| 2098 | - $this->_template_args['att_edit_label'] = __('View/Edit Contact', 'event_espresso'); |
|
| 2099 | - //create link |
|
| 2100 | - $this->_template_args['create_link'] = $primary_registration instanceof EE_Registration |
|
| 2101 | - ? EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 2102 | - 'action' => 'duplicate_attendee', |
|
| 2103 | - '_REG_ID' => $this->_registration->ID(), |
|
| 2104 | - ), REG_ADMIN_URL) : ''; |
|
| 2105 | - $this->_template_args['create_label'] = __('Create Contact', 'event_espresso'); |
|
| 2106 | - $this->_template_args['att_check'] = $att_check; |
|
| 2107 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php'; |
|
| 2108 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 2109 | - } |
|
| 2110 | - |
|
| 2111 | - |
|
| 2112 | - |
|
| 2113 | - /** |
|
| 2114 | - * trash or restore registrations |
|
| 2115 | - * |
|
| 2116 | - * @param boolean $trash whether to archive or restore |
|
| 2117 | - * @access protected |
|
| 2118 | - * @return void |
|
| 2119 | - * @throws \EE_Error |
|
| 2120 | - */ |
|
| 2121 | - protected function _trash_or_restore_registrations($trash = true) |
|
| 2122 | - { |
|
| 2123 | - //if empty _REG_ID then get out because there's nothing to do |
|
| 2124 | - if (empty($this->_req_data['_REG_ID'])) { |
|
| 2125 | - EE_Error::add_error( |
|
| 2126 | - sprintf( |
|
| 2127 | - esc_html__( |
|
| 2128 | - 'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.', |
|
| 2129 | - 'event_espresso' |
|
| 2130 | - ), |
|
| 2131 | - $trash ? 'trash' : 'restore' |
|
| 2132 | - ), |
|
| 2133 | - __FILE__, __LINE__, __FUNCTION__ |
|
| 2134 | - ); |
|
| 2135 | - $this->_redirect_after_action(false, '', '', array(), true); |
|
| 2136 | - } |
|
| 2137 | - $success = 0; |
|
| 2138 | - $overwrite_msgs = false; |
|
| 2139 | - //Checkboxes |
|
| 2140 | - if ( ! is_array($this->_req_data['_REG_ID'])) { |
|
| 2141 | - $this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']); |
|
| 2142 | - } |
|
| 2143 | - $reg_count = count($this->_req_data['_REG_ID']); |
|
| 2144 | - // cycle thru checkboxes |
|
| 2145 | - foreach ($this->_req_data['_REG_ID'] as $REG_ID) { |
|
| 2146 | - /** @var EE_Registration $REG */ |
|
| 2147 | - $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
| 2148 | - $payments = $REG->registration_payments(); |
|
| 2149 | - if (! empty($payments)) { |
|
| 2150 | - $name = $REG->attendee() instanceof EE_Attendee |
|
| 2151 | - ? $REG->attendee()->full_name() |
|
| 2152 | - : __('Unknown Attendee', 'event_espresso'); |
|
| 2153 | - $overwrite_msgs = true; |
|
| 2154 | - EE_Error::add_error( |
|
| 2155 | - sprintf( |
|
| 2156 | - __( |
|
| 2157 | - 'The registration for %s could not be trashed because it has payments attached to the related transaction. If you wish to trash this registration you must first delete the payments on the related transaction.', |
|
| 2158 | - 'event_espresso' |
|
| 2159 | - ), |
|
| 2160 | - $name |
|
| 2161 | - ), |
|
| 2162 | - __FILE__, __FUNCTION__, __LINE__ |
|
| 2163 | - ); |
|
| 2164 | - //can't trash this registration because it has payments. |
|
| 2165 | - continue; |
|
| 2166 | - } |
|
| 2167 | - $updated = $trash ? $REG->delete() : $REG->restore(); |
|
| 2168 | - if ($updated) { |
|
| 2169 | - $success++; |
|
| 2170 | - } |
|
| 2171 | - } |
|
| 2172 | - $this->_redirect_after_action( |
|
| 2173 | - $success === $reg_count, // were ALL registrations affected? |
|
| 2174 | - $success > 1 ? __('Registrations', 'event_espresso') : __('Registration', 'event_espresso'), |
|
| 2175 | - $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso'), |
|
| 2176 | - array('action' => 'default'), |
|
| 2177 | - $overwrite_msgs |
|
| 2178 | - ); |
|
| 2179 | - } |
|
| 2180 | - |
|
| 2181 | - |
|
| 2182 | - /** |
|
| 2183 | - * This is used to permanently delete registrations. Note, this will handle not only deleting permanently the |
|
| 2184 | - * registration but also. |
|
| 2185 | - * 1. Removing relations to EE_Attendee |
|
| 2186 | - * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are |
|
| 2187 | - * ALSO trashed. |
|
| 2188 | - * 3. Deleting permanently any related Line items but only if the above conditions are met. |
|
| 2189 | - * 4. Removing relationships between all tickets and the related registrations |
|
| 2190 | - * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.) |
|
| 2191 | - * 6. Deleting permanently any related Checkins. |
|
| 2192 | - * |
|
| 2193 | - * @return void |
|
| 2194 | - */ |
|
| 2195 | - protected function _delete_registrations() |
|
| 2196 | - { |
|
| 2197 | - $REG_MDL = EEM_Registration::instance(); |
|
| 2198 | - $success = 1; |
|
| 2199 | - //Checkboxes |
|
| 2200 | - if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) { |
|
| 2201 | - // if array has more than one element than success message should be plural |
|
| 2202 | - $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1; |
|
| 2203 | - // cycle thru checkboxes |
|
| 2204 | - while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) { |
|
| 2205 | - $REG = $REG_MDL->get_one_by_ID($REG_ID); |
|
| 2206 | - if ( ! $REG instanceof EE_Registration) { |
|
| 2207 | - continue; |
|
| 2208 | - } |
|
| 2209 | - $deleted = $this->_delete_registration($REG); |
|
| 2210 | - if ( ! $deleted) { |
|
| 2211 | - $success = 0; |
|
| 2212 | - } |
|
| 2213 | - } |
|
| 2214 | - } else { |
|
| 2215 | - // grab single id and delete |
|
| 2216 | - $REG_ID = $this->_req_data['_REG_ID']; |
|
| 2217 | - $REG = $REG_MDL->get_one_by_ID($REG_ID); |
|
| 2218 | - $deleted = $this->_delete_registration($REG); |
|
| 2219 | - if ( ! $deleted) { |
|
| 2220 | - $success = 0; |
|
| 2221 | - } |
|
| 2222 | - } |
|
| 2223 | - $what = $success > 1 ? __('Registrations', 'event_espresso') : __('Registration', 'event_espresso'); |
|
| 2224 | - $action_desc = __('permanently deleted.', 'event_espresso'); |
|
| 2225 | - $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'default'), true); |
|
| 2226 | - } |
|
| 2227 | - |
|
| 2228 | - |
|
| 2229 | - /** |
|
| 2230 | - * handles the permanent deletion of a registration. See comments with _delete_registrations() for details on what |
|
| 2231 | - * models get affected. |
|
| 2232 | - * |
|
| 2233 | - * @param EE_Registration $REG registration to be deleted permenantly |
|
| 2234 | - * @return boolean true = successful deletion, false = fail. |
|
| 2235 | - */ |
|
| 2236 | - protected function _delete_registration(EE_Registration $REG) |
|
| 2237 | - { |
|
| 2238 | - //first we start with the transaction... ultimately, we WILL not delete permanently if there are any related registrations on the transaction that are NOT trashed. |
|
| 2239 | - $TXN = $REG->get_first_related('Transaction'); |
|
| 2240 | - $REGS = $TXN->get_many_related('Registration'); |
|
| 2241 | - $all_trashed = true; |
|
| 2242 | - foreach ($REGS as $registration) { |
|
| 2243 | - if ( ! $registration->get('REG_deleted')) { |
|
| 2244 | - $all_trashed = false; |
|
| 2245 | - } |
|
| 2246 | - } |
|
| 2247 | - if ( ! $all_trashed) { |
|
| 2248 | - EE_Error::add_error(__('Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well. These registrations will be permanently deleted in the same action.', |
|
| 2249 | - 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 2250 | - return false; |
|
| 2251 | - } |
|
| 2252 | - //k made it here so that means we can delete all the related transactions and their answers (but let's do them separately from THIS one). |
|
| 2253 | - foreach ($REGS as $registration) { |
|
| 2254 | - //delete related answers |
|
| 2255 | - $registration->delete_related_permanently('Answer'); |
|
| 2256 | - //remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact) |
|
| 2257 | - $attendee = $registration->get_first_related('Attendee'); |
|
| 2258 | - if ($attendee instanceof EE_Attendee) { |
|
| 2259 | - $registration->_remove_relation_to($attendee, 'Attendee'); |
|
| 2260 | - } |
|
| 2261 | - //now remove relationships to tickets on this registration. |
|
| 2262 | - $registration->_remove_relations('Ticket'); |
|
| 2263 | - //now delete permanently the checkins related to this registration. |
|
| 2264 | - $registration->delete_related_permanently('Checkin'); |
|
| 2265 | - if ($registration->ID() === $REG->ID()) { |
|
| 2266 | - continue; |
|
| 2267 | - } //we don't want to delete permanently the existing registration just yet. |
|
| 2268 | - //remove relation to transaction for these registrations if NOT the existing registrations |
|
| 2269 | - $registration->_remove_relations('Transaction'); |
|
| 2270 | - //delete permanently any related messages. |
|
| 2271 | - $registration->delete_related_permanently('Message'); |
|
| 2272 | - //now delete this registration permanently |
|
| 2273 | - $registration->delete_permanently(); |
|
| 2274 | - } |
|
| 2275 | - //now all related registrations on the transaction are handled. So let's just handle this registration itself (the transaction and line items should be all that's left). |
|
| 2276 | - //delete the line items related to the transaction for this registration. |
|
| 2277 | - $TXN->delete_related_permanently('Line_Item'); |
|
| 2278 | - //we need to remove all the relationships on the transaction |
|
| 2279 | - $TXN->delete_related_permanently('Payment'); |
|
| 2280 | - $TXN->delete_related_permanently('Extra_Meta'); |
|
| 2281 | - $TXN->delete_related_permanently('Message'); |
|
| 2282 | - //now we can delete this REG permanently (and the transaction of course) |
|
| 2283 | - $REG->delete_related_permanently('Transaction'); |
|
| 2284 | - return $REG->delete_permanently(); |
|
| 2285 | - } |
|
| 2286 | - |
|
| 2287 | - |
|
| 2288 | - /** |
|
| 2289 | - * generates HTML for the Register New Attendee Admin page |
|
| 2290 | - * |
|
| 2291 | - * @access private |
|
| 2292 | - * @throws \EE_Error |
|
| 2293 | - * @return void |
|
| 2294 | - */ |
|
| 2295 | - public function new_registration() |
|
| 2296 | - { |
|
| 2297 | - if ( ! $this->_set_reg_event()) { |
|
| 2298 | - throw new EE_Error(__('Unable to continue with registering because there is no Event ID in the request', |
|
| 2299 | - 'event_espresso')); |
|
| 2300 | - } |
|
| 2301 | - EE_Registry::instance()->REQ->set_espresso_page(true); |
|
| 2302 | - // gotta start with a clean slate if we're not coming here via ajax |
|
| 2303 | - if ( ! defined('DOING_AJAX') |
|
| 2304 | - && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error'])) |
|
| 2305 | - ) { |
|
| 2306 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 2307 | - } |
|
| 2308 | - $this->_template_args['event_name'] = ''; |
|
| 2309 | - // event name |
|
| 2310 | - if ($this->_reg_event) { |
|
| 2311 | - $this->_template_args['event_name'] = $this->_reg_event->name(); |
|
| 2312 | - $edit_event_url = self::add_query_args_and_nonce(array( |
|
| 2313 | - 'action' => 'edit', |
|
| 2314 | - 'post' => $this->_reg_event->ID(), |
|
| 2315 | - ), EVENTS_ADMIN_URL); |
|
| 2316 | - $edit_event_lnk = '<a href="' |
|
| 2317 | - . $edit_event_url |
|
| 2318 | - . '" title="' |
|
| 2319 | - . esc_attr__('Edit ', 'event_espresso') |
|
| 2320 | - . $this->_reg_event->name() |
|
| 2321 | - . '">' |
|
| 2322 | - . __('Edit Event', 'event_espresso') |
|
| 2323 | - . '</a>'; |
|
| 2324 | - $this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">' |
|
| 2325 | - . $edit_event_lnk |
|
| 2326 | - . '</span>'; |
|
| 2327 | - } |
|
| 2328 | - $this->_template_args['step_content'] = $this->_get_registration_step_content(); |
|
| 2329 | - if (defined('DOING_AJAX')) { |
|
| 2330 | - $this->_return_json(); |
|
| 2331 | - } |
|
| 2332 | - // grab header |
|
| 2333 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php'; |
|
| 2334 | - $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, |
|
| 2335 | - $this->_template_args, true); |
|
| 2336 | - //$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE ); |
|
| 2337 | - // the details template wrapper |
|
| 2338 | - $this->display_admin_page_with_sidebar(); |
|
| 2339 | - } |
|
| 2340 | - |
|
| 2341 | - |
|
| 2342 | - /** |
|
| 2343 | - * This returns the content for a registration step |
|
| 2344 | - * |
|
| 2345 | - * @access protected |
|
| 2346 | - * @return string html |
|
| 2347 | - */ |
|
| 2348 | - protected function _get_registration_step_content() |
|
| 2349 | - { |
|
| 2350 | - if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) { |
|
| 2351 | - $warning_msg = sprintf(__('%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s', |
|
| 2352 | - 'event_espresso'), '<br />', '<h3 class="important-notice">', '</h3>', '<div class="float-right">', |
|
| 2353 | - '<span id="redirect_timer" class="important-notice">30</span>', '</div>', '<b>', '</b>'); |
|
| 2354 | - return ' |
|
| 1915 | + } |
|
| 1916 | + |
|
| 1917 | + |
|
| 1918 | + /** |
|
| 1919 | + * Updates the registration's custom questions according to the form info, if the form is submitted. |
|
| 1920 | + * If it's not a post, the "view_registrations" route will be called next on the SAME request |
|
| 1921 | + * to display the page |
|
| 1922 | + * |
|
| 1923 | + * @access protected |
|
| 1924 | + * @return void |
|
| 1925 | + */ |
|
| 1926 | + protected function _update_attendee_registration_form() |
|
| 1927 | + { |
|
| 1928 | + do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this); |
|
| 1929 | + if ($_SERVER['REQUEST_METHOD'] == 'POST') { |
|
| 1930 | + $REG_ID = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false; |
|
| 1931 | + $success = $this->_save_reg_custom_questions_form($REG_ID); |
|
| 1932 | + if ($success) { |
|
| 1933 | + $what = __('Registration Form', 'event_espresso'); |
|
| 1934 | + $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) |
|
| 1935 | + : array('action' => 'default'); |
|
| 1936 | + $this->_redirect_after_action($success, $what, __('updated', 'event_espresso'), $route); |
|
| 1937 | + } |
|
| 1938 | + } |
|
| 1939 | + } |
|
| 1940 | + |
|
| 1941 | + |
|
| 1942 | + /** |
|
| 1943 | + * Gets the form for saving registrations custom questions (if done |
|
| 1944 | + * previously retrieves the cached form object, which may have validation errors in it) |
|
| 1945 | + * |
|
| 1946 | + * @param int $REG_ID |
|
| 1947 | + * @return EE_Registration_Custom_Questions_Form |
|
| 1948 | + */ |
|
| 1949 | + protected function _get_reg_custom_questions_form($REG_ID) |
|
| 1950 | + { |
|
| 1951 | + if ( ! $this->_reg_custom_questions_form) { |
|
| 1952 | + require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php'); |
|
| 1953 | + $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form( |
|
| 1954 | + EEM_Registration::instance()->get_one_by_ID($REG_ID) |
|
| 1955 | + ); |
|
| 1956 | + $this->_reg_custom_questions_form->_construct_finalize(null, null); |
|
| 1957 | + } |
|
| 1958 | + return $this->_reg_custom_questions_form; |
|
| 1959 | + } |
|
| 1960 | + |
|
| 1961 | + |
|
| 1962 | + /** |
|
| 1963 | + * Saves |
|
| 1964 | + * |
|
| 1965 | + * @access private |
|
| 1966 | + * @param bool $REG_ID |
|
| 1967 | + * @return bool |
|
| 1968 | + */ |
|
| 1969 | + private function _save_reg_custom_questions_form($REG_ID = false) |
|
| 1970 | + { |
|
| 1971 | + if ( ! $REG_ID) { |
|
| 1972 | + EE_Error::add_error(__('An error occurred. No registration ID was received.', 'event_espresso'), __FILE__, |
|
| 1973 | + __FUNCTION__, __LINE__); |
|
| 1974 | + } |
|
| 1975 | + $form = $this->_get_reg_custom_questions_form($REG_ID); |
|
| 1976 | + $form->receive_form_submission($this->_req_data); |
|
| 1977 | + $success = false; |
|
| 1978 | + if ($form->is_valid()) { |
|
| 1979 | + foreach ($form->subforms() as $question_group_id => $question_group_form) { |
|
| 1980 | + foreach ($question_group_form->inputs() as $question_id => $input) { |
|
| 1981 | + $where_conditions = array( |
|
| 1982 | + 'QST_ID' => $question_id, |
|
| 1983 | + 'REG_ID' => $REG_ID, |
|
| 1984 | + ); |
|
| 1985 | + $possibly_new_values = array( |
|
| 1986 | + 'ANS_value' => $input->normalized_value(), |
|
| 1987 | + ); |
|
| 1988 | + $answer = EEM_Answer::instance()->get_one(array($where_conditions)); |
|
| 1989 | + if ($answer instanceof EE_Answer) { |
|
| 1990 | + $success = $answer->save($possibly_new_values); |
|
| 1991 | + } else { |
|
| 1992 | + //insert it then |
|
| 1993 | + $cols_n_vals = array_merge($where_conditions, $possibly_new_values); |
|
| 1994 | + $answer = EE_Answer::new_instance($cols_n_vals); |
|
| 1995 | + $success = $answer->save(); |
|
| 1996 | + } |
|
| 1997 | + } |
|
| 1998 | + } |
|
| 1999 | + } else { |
|
| 2000 | + EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__); |
|
| 2001 | + } |
|
| 2002 | + return $success; |
|
| 2003 | + } |
|
| 2004 | + |
|
| 2005 | + |
|
| 2006 | + /** |
|
| 2007 | + * generates HTML for the Registration main meta box |
|
| 2008 | + * |
|
| 2009 | + * @access public |
|
| 2010 | + * @return void |
|
| 2011 | + */ |
|
| 2012 | + public function _reg_attendees_meta_box() |
|
| 2013 | + { |
|
| 2014 | + $REG = EEM_Registration::instance(); |
|
| 2015 | + //get all other registrations on this transaction, and cache |
|
| 2016 | + //the attendees for them so we don't have to run another query using force_join |
|
| 2017 | + $registrations = $REG->get_all(array( |
|
| 2018 | + array( |
|
| 2019 | + 'TXN_ID' => $this->_registration->transaction_ID(), |
|
| 2020 | + 'REG_ID' => array('!=', $this->_registration->ID()), |
|
| 2021 | + ), |
|
| 2022 | + 'force_join' => array('Attendee'), |
|
| 2023 | + )); |
|
| 2024 | + $this->_template_args['attendees'] = array(); |
|
| 2025 | + $this->_template_args['attendee_notice'] = ''; |
|
| 2026 | + if (empty($registrations) |
|
| 2027 | + || (is_array($registrations) |
|
| 2028 | + && ! EEH_Array::get_one_item_from_array($registrations)) |
|
| 2029 | + ) { |
|
| 2030 | + EE_Error::add_error(__('There are no records attached to this registration. Something may have gone wrong with the registration', |
|
| 2031 | + 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 2032 | + $this->_template_args['attendee_notice'] = EE_Error::get_notices(); |
|
| 2033 | + } else { |
|
| 2034 | + $att_nmbr = 1; |
|
| 2035 | + foreach ($registrations as $registration) { |
|
| 2036 | + /* @var $registration EE_Registration */ |
|
| 2037 | + $attendee = $registration->attendee() |
|
| 2038 | + ? $registration->attendee() |
|
| 2039 | + : EEM_Attendee::instance() |
|
| 2040 | + ->create_default_object(); |
|
| 2041 | + $this->_template_args['attendees'][$att_nmbr]['STS_ID'] = $registration->status_ID(); |
|
| 2042 | + $this->_template_args['attendees'][$att_nmbr]['fname'] = $attendee->fname();//( isset( $registration->ATT_fname ) & ! empty( $registration->ATT_fname ) ) ? $registration->ATT_fname : ''; |
|
| 2043 | + $this->_template_args['attendees'][$att_nmbr]['lname'] = $attendee->lname();//( isset( $registration->ATT_lname ) & ! empty( $registration->ATT_lname ) ) ? $registration->ATT_lname : ''; |
|
| 2044 | + $this->_template_args['attendees'][$att_nmbr]['email'] = $attendee->email();//( isset( $registration->ATT_email ) & ! empty( $registration->ATT_email ) ) ? $registration->ATT_email : ''; |
|
| 2045 | + $this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();//( isset( $registration->REG_final_price ) & ! empty( $registration->REG_final_price ) ) ? $registration->REG_final_price : ''; |
|
| 2046 | + $this->_template_args['attendees'][$att_nmbr]['address'] = implode(', ', |
|
| 2047 | + $attendee->full_address_as_array()); |
|
| 2048 | + $this->_template_args['attendees'][$att_nmbr]['att_link'] = self::add_query_args_and_nonce(array( |
|
| 2049 | + 'action' => 'edit_attendee', |
|
| 2050 | + 'post' => $attendee->ID(), |
|
| 2051 | + ), REG_ADMIN_URL); |
|
| 2052 | + $this->_template_args['attendees'][$att_nmbr]['event_name'] = $registration->event_obj()->name(); |
|
| 2053 | + $att_nmbr++; |
|
| 2054 | + } |
|
| 2055 | + //EEH_Debug_Tools::printr( $attendees, '$attendees <br /><span style="font-size:10px;font-weight:normal;">( file: '. __FILE__ . ' - line no: ' . __LINE__ . ' )</span>', 'auto' ); |
|
| 2056 | + $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
| 2057 | + // $this->_template_args['registration_form_url'] = add_query_arg( array( 'action' => 'edit_registration', 'process' => 'attendees' ), REG_ADMIN_URL ); |
|
| 2058 | + } |
|
| 2059 | + $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php'; |
|
| 2060 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 2061 | + } |
|
| 2062 | + |
|
| 2063 | + |
|
| 2064 | + /** |
|
| 2065 | + * generates HTML for the Edit Registration side meta box |
|
| 2066 | + * |
|
| 2067 | + * @access public |
|
| 2068 | + * @return void |
|
| 2069 | + */ |
|
| 2070 | + public function _reg_registrant_side_meta_box() |
|
| 2071 | + { |
|
| 2072 | + /*@var $attendee EE_Attendee */ |
|
| 2073 | + $att_check = $this->_registration->attendee(); |
|
| 2074 | + $attendee = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object(); |
|
| 2075 | + //now let's determine if this is not the primary registration. If it isn't then we set the primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the primary registration object (that way we know if we need to show create button or not) |
|
| 2076 | + if ( ! $this->_registration->is_primary_registrant()) { |
|
| 2077 | + $primary_registration = $this->_registration->get_primary_registration(); |
|
| 2078 | + $primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee() |
|
| 2079 | + : null; |
|
| 2080 | + if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) { |
|
| 2081 | + //in here? This means the displayed registration is not the primary registrant but ALREADY HAS its own custom attendee object so let's not worry about the primary reg. |
|
| 2082 | + $primary_registration = null; |
|
| 2083 | + } |
|
| 2084 | + } else { |
|
| 2085 | + $primary_registration = null; |
|
| 2086 | + } |
|
| 2087 | + $this->_template_args['ATT_ID'] = $attendee->ID(); |
|
| 2088 | + $this->_template_args['fname'] = $attendee->fname();//$this->_registration->ATT_fname; |
|
| 2089 | + $this->_template_args['lname'] = $attendee->lname();//$this->_registration->ATT_lname; |
|
| 2090 | + $this->_template_args['email'] = $attendee->email();//$this->_registration->ATT_email; |
|
| 2091 | + $this->_template_args['phone'] = $attendee->phone(); |
|
| 2092 | + $this->_template_args['formatted_address'] = EEH_Address::format($attendee); |
|
| 2093 | + //edit link |
|
| 2094 | + $this->_template_args['att_edit_link'] = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 2095 | + 'action' => 'edit_attendee', |
|
| 2096 | + 'post' => $attendee->ID(), |
|
| 2097 | + ), REG_ADMIN_URL); |
|
| 2098 | + $this->_template_args['att_edit_label'] = __('View/Edit Contact', 'event_espresso'); |
|
| 2099 | + //create link |
|
| 2100 | + $this->_template_args['create_link'] = $primary_registration instanceof EE_Registration |
|
| 2101 | + ? EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 2102 | + 'action' => 'duplicate_attendee', |
|
| 2103 | + '_REG_ID' => $this->_registration->ID(), |
|
| 2104 | + ), REG_ADMIN_URL) : ''; |
|
| 2105 | + $this->_template_args['create_label'] = __('Create Contact', 'event_espresso'); |
|
| 2106 | + $this->_template_args['att_check'] = $att_check; |
|
| 2107 | + $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php'; |
|
| 2108 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
| 2109 | + } |
|
| 2110 | + |
|
| 2111 | + |
|
| 2112 | + |
|
| 2113 | + /** |
|
| 2114 | + * trash or restore registrations |
|
| 2115 | + * |
|
| 2116 | + * @param boolean $trash whether to archive or restore |
|
| 2117 | + * @access protected |
|
| 2118 | + * @return void |
|
| 2119 | + * @throws \EE_Error |
|
| 2120 | + */ |
|
| 2121 | + protected function _trash_or_restore_registrations($trash = true) |
|
| 2122 | + { |
|
| 2123 | + //if empty _REG_ID then get out because there's nothing to do |
|
| 2124 | + if (empty($this->_req_data['_REG_ID'])) { |
|
| 2125 | + EE_Error::add_error( |
|
| 2126 | + sprintf( |
|
| 2127 | + esc_html__( |
|
| 2128 | + 'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.', |
|
| 2129 | + 'event_espresso' |
|
| 2130 | + ), |
|
| 2131 | + $trash ? 'trash' : 'restore' |
|
| 2132 | + ), |
|
| 2133 | + __FILE__, __LINE__, __FUNCTION__ |
|
| 2134 | + ); |
|
| 2135 | + $this->_redirect_after_action(false, '', '', array(), true); |
|
| 2136 | + } |
|
| 2137 | + $success = 0; |
|
| 2138 | + $overwrite_msgs = false; |
|
| 2139 | + //Checkboxes |
|
| 2140 | + if ( ! is_array($this->_req_data['_REG_ID'])) { |
|
| 2141 | + $this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']); |
|
| 2142 | + } |
|
| 2143 | + $reg_count = count($this->_req_data['_REG_ID']); |
|
| 2144 | + // cycle thru checkboxes |
|
| 2145 | + foreach ($this->_req_data['_REG_ID'] as $REG_ID) { |
|
| 2146 | + /** @var EE_Registration $REG */ |
|
| 2147 | + $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
| 2148 | + $payments = $REG->registration_payments(); |
|
| 2149 | + if (! empty($payments)) { |
|
| 2150 | + $name = $REG->attendee() instanceof EE_Attendee |
|
| 2151 | + ? $REG->attendee()->full_name() |
|
| 2152 | + : __('Unknown Attendee', 'event_espresso'); |
|
| 2153 | + $overwrite_msgs = true; |
|
| 2154 | + EE_Error::add_error( |
|
| 2155 | + sprintf( |
|
| 2156 | + __( |
|
| 2157 | + 'The registration for %s could not be trashed because it has payments attached to the related transaction. If you wish to trash this registration you must first delete the payments on the related transaction.', |
|
| 2158 | + 'event_espresso' |
|
| 2159 | + ), |
|
| 2160 | + $name |
|
| 2161 | + ), |
|
| 2162 | + __FILE__, __FUNCTION__, __LINE__ |
|
| 2163 | + ); |
|
| 2164 | + //can't trash this registration because it has payments. |
|
| 2165 | + continue; |
|
| 2166 | + } |
|
| 2167 | + $updated = $trash ? $REG->delete() : $REG->restore(); |
|
| 2168 | + if ($updated) { |
|
| 2169 | + $success++; |
|
| 2170 | + } |
|
| 2171 | + } |
|
| 2172 | + $this->_redirect_after_action( |
|
| 2173 | + $success === $reg_count, // were ALL registrations affected? |
|
| 2174 | + $success > 1 ? __('Registrations', 'event_espresso') : __('Registration', 'event_espresso'), |
|
| 2175 | + $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso'), |
|
| 2176 | + array('action' => 'default'), |
|
| 2177 | + $overwrite_msgs |
|
| 2178 | + ); |
|
| 2179 | + } |
|
| 2180 | + |
|
| 2181 | + |
|
| 2182 | + /** |
|
| 2183 | + * This is used to permanently delete registrations. Note, this will handle not only deleting permanently the |
|
| 2184 | + * registration but also. |
|
| 2185 | + * 1. Removing relations to EE_Attendee |
|
| 2186 | + * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are |
|
| 2187 | + * ALSO trashed. |
|
| 2188 | + * 3. Deleting permanently any related Line items but only if the above conditions are met. |
|
| 2189 | + * 4. Removing relationships between all tickets and the related registrations |
|
| 2190 | + * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.) |
|
| 2191 | + * 6. Deleting permanently any related Checkins. |
|
| 2192 | + * |
|
| 2193 | + * @return void |
|
| 2194 | + */ |
|
| 2195 | + protected function _delete_registrations() |
|
| 2196 | + { |
|
| 2197 | + $REG_MDL = EEM_Registration::instance(); |
|
| 2198 | + $success = 1; |
|
| 2199 | + //Checkboxes |
|
| 2200 | + if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) { |
|
| 2201 | + // if array has more than one element than success message should be plural |
|
| 2202 | + $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1; |
|
| 2203 | + // cycle thru checkboxes |
|
| 2204 | + while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) { |
|
| 2205 | + $REG = $REG_MDL->get_one_by_ID($REG_ID); |
|
| 2206 | + if ( ! $REG instanceof EE_Registration) { |
|
| 2207 | + continue; |
|
| 2208 | + } |
|
| 2209 | + $deleted = $this->_delete_registration($REG); |
|
| 2210 | + if ( ! $deleted) { |
|
| 2211 | + $success = 0; |
|
| 2212 | + } |
|
| 2213 | + } |
|
| 2214 | + } else { |
|
| 2215 | + // grab single id and delete |
|
| 2216 | + $REG_ID = $this->_req_data['_REG_ID']; |
|
| 2217 | + $REG = $REG_MDL->get_one_by_ID($REG_ID); |
|
| 2218 | + $deleted = $this->_delete_registration($REG); |
|
| 2219 | + if ( ! $deleted) { |
|
| 2220 | + $success = 0; |
|
| 2221 | + } |
|
| 2222 | + } |
|
| 2223 | + $what = $success > 1 ? __('Registrations', 'event_espresso') : __('Registration', 'event_espresso'); |
|
| 2224 | + $action_desc = __('permanently deleted.', 'event_espresso'); |
|
| 2225 | + $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'default'), true); |
|
| 2226 | + } |
|
| 2227 | + |
|
| 2228 | + |
|
| 2229 | + /** |
|
| 2230 | + * handles the permanent deletion of a registration. See comments with _delete_registrations() for details on what |
|
| 2231 | + * models get affected. |
|
| 2232 | + * |
|
| 2233 | + * @param EE_Registration $REG registration to be deleted permenantly |
|
| 2234 | + * @return boolean true = successful deletion, false = fail. |
|
| 2235 | + */ |
|
| 2236 | + protected function _delete_registration(EE_Registration $REG) |
|
| 2237 | + { |
|
| 2238 | + //first we start with the transaction... ultimately, we WILL not delete permanently if there are any related registrations on the transaction that are NOT trashed. |
|
| 2239 | + $TXN = $REG->get_first_related('Transaction'); |
|
| 2240 | + $REGS = $TXN->get_many_related('Registration'); |
|
| 2241 | + $all_trashed = true; |
|
| 2242 | + foreach ($REGS as $registration) { |
|
| 2243 | + if ( ! $registration->get('REG_deleted')) { |
|
| 2244 | + $all_trashed = false; |
|
| 2245 | + } |
|
| 2246 | + } |
|
| 2247 | + if ( ! $all_trashed) { |
|
| 2248 | + EE_Error::add_error(__('Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well. These registrations will be permanently deleted in the same action.', |
|
| 2249 | + 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 2250 | + return false; |
|
| 2251 | + } |
|
| 2252 | + //k made it here so that means we can delete all the related transactions and their answers (but let's do them separately from THIS one). |
|
| 2253 | + foreach ($REGS as $registration) { |
|
| 2254 | + //delete related answers |
|
| 2255 | + $registration->delete_related_permanently('Answer'); |
|
| 2256 | + //remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact) |
|
| 2257 | + $attendee = $registration->get_first_related('Attendee'); |
|
| 2258 | + if ($attendee instanceof EE_Attendee) { |
|
| 2259 | + $registration->_remove_relation_to($attendee, 'Attendee'); |
|
| 2260 | + } |
|
| 2261 | + //now remove relationships to tickets on this registration. |
|
| 2262 | + $registration->_remove_relations('Ticket'); |
|
| 2263 | + //now delete permanently the checkins related to this registration. |
|
| 2264 | + $registration->delete_related_permanently('Checkin'); |
|
| 2265 | + if ($registration->ID() === $REG->ID()) { |
|
| 2266 | + continue; |
|
| 2267 | + } //we don't want to delete permanently the existing registration just yet. |
|
| 2268 | + //remove relation to transaction for these registrations if NOT the existing registrations |
|
| 2269 | + $registration->_remove_relations('Transaction'); |
|
| 2270 | + //delete permanently any related messages. |
|
| 2271 | + $registration->delete_related_permanently('Message'); |
|
| 2272 | + //now delete this registration permanently |
|
| 2273 | + $registration->delete_permanently(); |
|
| 2274 | + } |
|
| 2275 | + //now all related registrations on the transaction are handled. So let's just handle this registration itself (the transaction and line items should be all that's left). |
|
| 2276 | + //delete the line items related to the transaction for this registration. |
|
| 2277 | + $TXN->delete_related_permanently('Line_Item'); |
|
| 2278 | + //we need to remove all the relationships on the transaction |
|
| 2279 | + $TXN->delete_related_permanently('Payment'); |
|
| 2280 | + $TXN->delete_related_permanently('Extra_Meta'); |
|
| 2281 | + $TXN->delete_related_permanently('Message'); |
|
| 2282 | + //now we can delete this REG permanently (and the transaction of course) |
|
| 2283 | + $REG->delete_related_permanently('Transaction'); |
|
| 2284 | + return $REG->delete_permanently(); |
|
| 2285 | + } |
|
| 2286 | + |
|
| 2287 | + |
|
| 2288 | + /** |
|
| 2289 | + * generates HTML for the Register New Attendee Admin page |
|
| 2290 | + * |
|
| 2291 | + * @access private |
|
| 2292 | + * @throws \EE_Error |
|
| 2293 | + * @return void |
|
| 2294 | + */ |
|
| 2295 | + public function new_registration() |
|
| 2296 | + { |
|
| 2297 | + if ( ! $this->_set_reg_event()) { |
|
| 2298 | + throw new EE_Error(__('Unable to continue with registering because there is no Event ID in the request', |
|
| 2299 | + 'event_espresso')); |
|
| 2300 | + } |
|
| 2301 | + EE_Registry::instance()->REQ->set_espresso_page(true); |
|
| 2302 | + // gotta start with a clean slate if we're not coming here via ajax |
|
| 2303 | + if ( ! defined('DOING_AJAX') |
|
| 2304 | + && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error'])) |
|
| 2305 | + ) { |
|
| 2306 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 2307 | + } |
|
| 2308 | + $this->_template_args['event_name'] = ''; |
|
| 2309 | + // event name |
|
| 2310 | + if ($this->_reg_event) { |
|
| 2311 | + $this->_template_args['event_name'] = $this->_reg_event->name(); |
|
| 2312 | + $edit_event_url = self::add_query_args_and_nonce(array( |
|
| 2313 | + 'action' => 'edit', |
|
| 2314 | + 'post' => $this->_reg_event->ID(), |
|
| 2315 | + ), EVENTS_ADMIN_URL); |
|
| 2316 | + $edit_event_lnk = '<a href="' |
|
| 2317 | + . $edit_event_url |
|
| 2318 | + . '" title="' |
|
| 2319 | + . esc_attr__('Edit ', 'event_espresso') |
|
| 2320 | + . $this->_reg_event->name() |
|
| 2321 | + . '">' |
|
| 2322 | + . __('Edit Event', 'event_espresso') |
|
| 2323 | + . '</a>'; |
|
| 2324 | + $this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">' |
|
| 2325 | + . $edit_event_lnk |
|
| 2326 | + . '</span>'; |
|
| 2327 | + } |
|
| 2328 | + $this->_template_args['step_content'] = $this->_get_registration_step_content(); |
|
| 2329 | + if (defined('DOING_AJAX')) { |
|
| 2330 | + $this->_return_json(); |
|
| 2331 | + } |
|
| 2332 | + // grab header |
|
| 2333 | + $template_path = REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php'; |
|
| 2334 | + $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, |
|
| 2335 | + $this->_template_args, true); |
|
| 2336 | + //$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE ); |
|
| 2337 | + // the details template wrapper |
|
| 2338 | + $this->display_admin_page_with_sidebar(); |
|
| 2339 | + } |
|
| 2340 | + |
|
| 2341 | + |
|
| 2342 | + /** |
|
| 2343 | + * This returns the content for a registration step |
|
| 2344 | + * |
|
| 2345 | + * @access protected |
|
| 2346 | + * @return string html |
|
| 2347 | + */ |
|
| 2348 | + protected function _get_registration_step_content() |
|
| 2349 | + { |
|
| 2350 | + if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) { |
|
| 2351 | + $warning_msg = sprintf(__('%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s', |
|
| 2352 | + 'event_espresso'), '<br />', '<h3 class="important-notice">', '</h3>', '<div class="float-right">', |
|
| 2353 | + '<span id="redirect_timer" class="important-notice">30</span>', '</div>', '<b>', '</b>'); |
|
| 2354 | + return ' |
|
| 2355 | 2355 | <div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div> |
| 2356 | 2356 | <script > |
| 2357 | 2357 | // WHOAH !!! it appears that someone is using the back button from the Transaction admin page |
@@ -2364,658 +2364,658 @@ discard block |
||
| 2364 | 2364 | } |
| 2365 | 2365 | }, 800 ); |
| 2366 | 2366 | </script >'; |
| 2367 | - } |
|
| 2368 | - $template_args = array( |
|
| 2369 | - 'title' => '', |
|
| 2370 | - 'content' => '', |
|
| 2371 | - 'step_button_text' => '', |
|
| 2372 | - 'show_notification_toggle' => false, |
|
| 2373 | - ); |
|
| 2374 | - //to indicate we're processing a new registration |
|
| 2375 | - $hidden_fields = array( |
|
| 2376 | - 'processing_registration' => array( |
|
| 2377 | - 'type' => 'hidden', |
|
| 2378 | - 'value' => 0, |
|
| 2379 | - ), |
|
| 2380 | - 'event_id' => array( |
|
| 2381 | - 'type' => 'hidden', |
|
| 2382 | - 'value' => $this->_reg_event->ID(), |
|
| 2383 | - ), |
|
| 2384 | - ); |
|
| 2385 | - //if the cart is empty then we know we're at step one so we'll display ticket selector |
|
| 2386 | - $cart = EE_Registry::instance()->SSN->cart(); |
|
| 2387 | - $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions'; |
|
| 2388 | - switch ($step) { |
|
| 2389 | - case 'ticket' : |
|
| 2390 | - $hidden_fields['processing_registration']['value'] = 1; |
|
| 2391 | - $template_args['title'] = __('Step One: Select the Ticket for this registration', |
|
| 2392 | - 'event_espresso'); |
|
| 2393 | - $template_args['content'] = EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event); |
|
| 2394 | - $template_args['step_button_text'] = __('Add Tickets and Continue to Registrant Details', |
|
| 2395 | - 'event_espresso'); |
|
| 2396 | - $template_args['show_notification_toggle'] = false; |
|
| 2397 | - break; |
|
| 2398 | - case 'questions' : |
|
| 2399 | - $hidden_fields['processing_registration']['value'] = 2; |
|
| 2400 | - $template_args['title'] = __('Step Two: Add Registrant Details for this Registration', |
|
| 2401 | - 'event_espresso'); |
|
| 2402 | - //in theory we should be able to run EED_SPCO at this point because the cart should have been setup properly by the first process_reg_step run. |
|
| 2403 | - $template_args['content'] = EED_Single_Page_Checkout::registration_checkout_for_admin(); |
|
| 2404 | - $template_args['step_button_text'] = __('Save Registration and Continue to Details', |
|
| 2405 | - 'event_espresso'); |
|
| 2406 | - $template_args['show_notification_toggle'] = true; |
|
| 2407 | - break; |
|
| 2408 | - } |
|
| 2409 | - $this->_set_add_edit_form_tags('process_reg_step', |
|
| 2410 | - $hidden_fields); //we come back to the process_registration_step route. |
|
| 2411 | - return EEH_Template::display_template(REG_TEMPLATE_PATH |
|
| 2412 | - . 'reg_admin_register_new_attendee_step_content.template.php', |
|
| 2413 | - $template_args, true); |
|
| 2414 | - } |
|
| 2415 | - |
|
| 2416 | - |
|
| 2417 | - /** |
|
| 2418 | - * set_reg_event |
|
| 2419 | - * |
|
| 2420 | - * @access private |
|
| 2421 | - * @return boolean |
|
| 2422 | - */ |
|
| 2423 | - private function _set_reg_event() |
|
| 2424 | - { |
|
| 2425 | - if (is_object($this->_reg_event)) { |
|
| 2426 | - return true; |
|
| 2427 | - } |
|
| 2428 | - $EVT_ID = ( ! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false; |
|
| 2429 | - if ( ! $EVT_ID) { |
|
| 2430 | - return false; |
|
| 2431 | - } |
|
| 2432 | - $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
| 2433 | - return true; |
|
| 2434 | - } |
|
| 2435 | - |
|
| 2436 | - |
|
| 2437 | - /** |
|
| 2438 | - * process_reg_step |
|
| 2439 | - * |
|
| 2440 | - * @access public |
|
| 2441 | - * @return string |
|
| 2442 | - * @throws \RuntimeException |
|
| 2443 | - * @throws \EE_Error |
|
| 2444 | - */ |
|
| 2445 | - public function process_reg_step() |
|
| 2446 | - { |
|
| 2447 | - EE_System::do_not_cache(); |
|
| 2448 | - $this->_set_reg_event(); |
|
| 2449 | - EE_Registry::instance()->REQ->set_espresso_page(true); |
|
| 2450 | - EE_Registry::instance()->REQ->set('uts', time()); |
|
| 2451 | - //what step are we on? |
|
| 2452 | - $cart = EE_Registry::instance()->SSN->cart(); |
|
| 2453 | - $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions'; |
|
| 2454 | - //if doing ajax then we need to verify the nonce |
|
| 2455 | - if (defined('DOING_AJAX')) { |
|
| 2456 | - $nonce = isset($this->_req_data[$this->_req_nonce]) |
|
| 2457 | - ? sanitize_text_field($this->_req_data[$this->_req_nonce]) : ''; |
|
| 2458 | - $this->_verify_nonce($nonce, $this->_req_nonce); |
|
| 2459 | - } |
|
| 2460 | - switch ($step) { |
|
| 2461 | - case 'ticket' : |
|
| 2462 | - //process ticket selection |
|
| 2463 | - $success = EED_Ticket_Selector::instance()->process_ticket_selections(); |
|
| 2464 | - if ($success) { |
|
| 2465 | - EE_Error::add_success(esc_html__('Tickets Selected. Now complete the registration.', |
|
| 2466 | - 'event_espresso')); |
|
| 2467 | - } else { |
|
| 2468 | - $query_args['step_error'] = $this->_req_data['step_error'] = true; |
|
| 2469 | - } |
|
| 2470 | - if (defined('DOING_AJAX')) { |
|
| 2471 | - $this->new_registration(); //display next step |
|
| 2472 | - } else { |
|
| 2473 | - $query_args = array( |
|
| 2474 | - 'action' => 'new_registration', |
|
| 2475 | - 'processing_registration' => 1, |
|
| 2476 | - 'event_id' => $this->_reg_event->ID(), |
|
| 2477 | - 'uts' => time(), |
|
| 2478 | - ); |
|
| 2479 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 2480 | - } |
|
| 2481 | - break; |
|
| 2482 | - case 'questions' : |
|
| 2483 | - if ( ! isset($this->_req_data['txn_reg_status_change'], $this->_req_data['txn_reg_status_change']['send_notifications'])) { |
|
| 2484 | - add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15); |
|
| 2485 | - } |
|
| 2486 | - //process registration |
|
| 2487 | - $transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin(); |
|
| 2488 | - if ($cart instanceof EE_Cart) { |
|
| 2489 | - $grand_total = $cart->get_cart_grand_total(); |
|
| 2490 | - if ($grand_total instanceof EE_Line_Item) { |
|
| 2491 | - $grand_total->save_this_and_descendants_to_txn(); |
|
| 2492 | - } |
|
| 2493 | - } |
|
| 2494 | - if ( ! $transaction instanceof EE_Transaction) { |
|
| 2495 | - $query_args = array( |
|
| 2496 | - 'action' => 'new_registration', |
|
| 2497 | - 'processing_registration' => 2, |
|
| 2498 | - 'event_id' => $this->_reg_event->ID(), |
|
| 2499 | - 'uts' => time(), |
|
| 2500 | - ); |
|
| 2501 | - if (defined('DOING_AJAX')) { |
|
| 2502 | - //display registration form again because there are errors (maybe validation?) |
|
| 2503 | - $this->new_registration(); |
|
| 2504 | - return; |
|
| 2505 | - } else { |
|
| 2506 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 2507 | - return; |
|
| 2508 | - } |
|
| 2509 | - } |
|
| 2510 | - // maybe update status, and make sure to save transaction if not done already |
|
| 2511 | - if ( ! $transaction->update_status_based_on_total_paid()) { |
|
| 2512 | - $transaction->save(); |
|
| 2513 | - } |
|
| 2514 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 2515 | - $this->_req_data = array(); |
|
| 2516 | - $query_args = array( |
|
| 2517 | - 'action' => 'redirect_to_txn', |
|
| 2518 | - 'TXN_ID' => $transaction->ID(), |
|
| 2519 | - 'EVT_ID' => $this->_reg_event->ID(), |
|
| 2520 | - 'event_name' => urlencode($this->_reg_event->name()), |
|
| 2521 | - 'redirect_from' => 'new_registration', |
|
| 2522 | - ); |
|
| 2523 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 2524 | - break; |
|
| 2525 | - } |
|
| 2526 | - //what are you looking here for? Should be nothing to do at this point. |
|
| 2527 | - } |
|
| 2528 | - |
|
| 2529 | - |
|
| 2530 | - /** |
|
| 2531 | - * redirect_to_txn |
|
| 2532 | - * |
|
| 2533 | - * @access public |
|
| 2534 | - * @return void |
|
| 2535 | - */ |
|
| 2536 | - public function redirect_to_txn() |
|
| 2537 | - { |
|
| 2538 | - EE_System::do_not_cache(); |
|
| 2539 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 2540 | - $query_args = array( |
|
| 2541 | - 'action' => 'view_transaction', |
|
| 2542 | - 'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0, |
|
| 2543 | - 'page' => 'espresso_transactions', |
|
| 2544 | - ); |
|
| 2545 | - if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) { |
|
| 2546 | - $query_args['EVT_ID'] = $this->_req_data['EVT_ID']; |
|
| 2547 | - $query_args['event_name'] = urlencode($this->_req_data['event_name']); |
|
| 2548 | - $query_args['redirect_from'] = $this->_req_data['redirect_from']; |
|
| 2549 | - } |
|
| 2550 | - EE_Error::add_success(__('Registration Created. Please review the transaction and add any payments as necessary', |
|
| 2551 | - 'event_espresso')); |
|
| 2552 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 2553 | - } |
|
| 2554 | - |
|
| 2555 | - |
|
| 2556 | - /** |
|
| 2557 | - * generates HTML for the Attendee Contact List |
|
| 2558 | - * |
|
| 2559 | - * @access protected |
|
| 2560 | - * @return void |
|
| 2561 | - */ |
|
| 2562 | - protected function _attendee_contact_list_table() |
|
| 2563 | - { |
|
| 2564 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 2565 | - $this->_search_btn_label = __('Contacts', 'event_espresso'); |
|
| 2566 | - $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 2567 | - } |
|
| 2568 | - |
|
| 2569 | - |
|
| 2570 | - /** |
|
| 2571 | - * get_attendees |
|
| 2572 | - * |
|
| 2573 | - * @param bool $count whether to return count or data. |
|
| 2574 | - * @access public |
|
| 2575 | - * @return array |
|
| 2576 | - */ |
|
| 2577 | - public function get_attendees($per_page, $count = false, $trash = false) |
|
| 2578 | - { |
|
| 2579 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 2580 | - require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php'); |
|
| 2581 | - $ATT_MDL = EEM_Attendee::instance(); |
|
| 2582 | - $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : ''; |
|
| 2583 | - switch ($this->_req_data['orderby']) { |
|
| 2584 | - case 'ATT_ID': |
|
| 2585 | - $orderby = 'ATT_ID'; |
|
| 2586 | - break; |
|
| 2587 | - case 'ATT_fname': |
|
| 2588 | - $orderby = 'ATT_fname'; |
|
| 2589 | - break; |
|
| 2590 | - case 'ATT_email': |
|
| 2591 | - $orderby = 'ATT_email'; |
|
| 2592 | - break; |
|
| 2593 | - case 'ATT_city': |
|
| 2594 | - $orderby = 'ATT_city'; |
|
| 2595 | - break; |
|
| 2596 | - case 'STA_ID': |
|
| 2597 | - $orderby = 'STA_ID'; |
|
| 2598 | - break; |
|
| 2599 | - case 'CNT_ID': |
|
| 2600 | - $orderby = 'CNT_ID'; |
|
| 2601 | - break; |
|
| 2602 | - default: |
|
| 2603 | - $orderby = 'ATT_lname'; |
|
| 2604 | - } |
|
| 2605 | - $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] |
|
| 2606 | - : 'ASC'; |
|
| 2607 | - $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) |
|
| 2608 | - ? $this->_req_data['paged'] : 1; |
|
| 2609 | - $per_page = isset($per_page) && ! empty($per_page) ? $per_page : 10; |
|
| 2610 | - $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) |
|
| 2611 | - ? $this->_req_data['perpage'] : $per_page; |
|
| 2612 | - $_where = array(); |
|
| 2613 | - if ( ! empty($this->_req_data['s'])) { |
|
| 2614 | - $sstr = '%' . $this->_req_data['s'] . '%'; |
|
| 2615 | - $_where['OR'] = array( |
|
| 2616 | - 'Registration.Event.EVT_name' => array('LIKE', $sstr), |
|
| 2617 | - 'Registration.Event.EVT_desc' => array('LIKE', $sstr), |
|
| 2618 | - 'Registration.Event.EVT_short_desc' => array('LIKE', $sstr), |
|
| 2619 | - 'ATT_fname' => array('LIKE', $sstr), |
|
| 2620 | - 'ATT_lname' => array('LIKE', $sstr), |
|
| 2621 | - 'ATT_short_bio' => array('LIKE', $sstr), |
|
| 2622 | - 'ATT_email' => array('LIKE', $sstr), |
|
| 2623 | - 'ATT_address' => array('LIKE', $sstr), |
|
| 2624 | - 'ATT_address2' => array('LIKE', $sstr), |
|
| 2625 | - 'ATT_city' => array('LIKE', $sstr), |
|
| 2626 | - 'Country.CNT_name' => array('LIKE', $sstr), |
|
| 2627 | - 'State.STA_name' => array('LIKE', $sstr), |
|
| 2628 | - 'ATT_phone' => array('LIKE', $sstr), |
|
| 2629 | - 'Registration.REG_final_price' => array('LIKE', $sstr), |
|
| 2630 | - 'Registration.REG_code' => array('LIKE', $sstr), |
|
| 2631 | - 'Registration.REG_count' => array('LIKE', $sstr), |
|
| 2632 | - 'Registration.REG_group_size' => array('LIKE', $sstr), |
|
| 2633 | - ); |
|
| 2634 | - } |
|
| 2635 | - $offset = ($current_page - 1) * $per_page; |
|
| 2636 | - $limit = $count ? null : array($offset, $per_page); |
|
| 2637 | - if ($trash) { |
|
| 2638 | - $_where['status'] = array('!=', 'publish'); |
|
| 2639 | - $all_attendees = $count |
|
| 2640 | - ? $ATT_MDL->count(array( |
|
| 2641 | - $_where, |
|
| 2642 | - 'order_by' => array($orderby => $sort), |
|
| 2643 | - 'limit' => $limit, |
|
| 2644 | - ), 'ATT_ID', true) |
|
| 2645 | - : $ATT_MDL->get_all(array( |
|
| 2646 | - $_where, |
|
| 2647 | - 'order_by' => array($orderby => $sort), |
|
| 2648 | - 'limit' => $limit, |
|
| 2649 | - )); |
|
| 2650 | - } else { |
|
| 2651 | - $_where['status'] = array('IN', array('publish')); |
|
| 2652 | - $all_attendees = $count |
|
| 2653 | - ? $ATT_MDL->count(array( |
|
| 2654 | - $_where, |
|
| 2655 | - 'order_by' => array($orderby => $sort), |
|
| 2656 | - 'limit' => $limit, |
|
| 2657 | - ), 'ATT_ID', true) |
|
| 2658 | - : $ATT_MDL->get_all(array( |
|
| 2659 | - $_where, |
|
| 2660 | - 'order_by' => array($orderby => $sort), |
|
| 2661 | - 'limit' => $limit, |
|
| 2662 | - )); |
|
| 2663 | - } |
|
| 2664 | - return $all_attendees; |
|
| 2665 | - } |
|
| 2666 | - |
|
| 2667 | - |
|
| 2668 | - /** |
|
| 2669 | - * This is just taking care of resending the registration confirmation |
|
| 2670 | - * |
|
| 2671 | - * @access protected |
|
| 2672 | - * @return void |
|
| 2673 | - */ |
|
| 2674 | - protected function _resend_registration() |
|
| 2675 | - { |
|
| 2676 | - $this->_process_resend_registration(); |
|
| 2677 | - $query_args = isset($this->_req_data['redirect_to']) |
|
| 2678 | - ? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID']) |
|
| 2679 | - : array( |
|
| 2680 | - 'action' => 'default', |
|
| 2681 | - ); |
|
| 2682 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 2683 | - } |
|
| 2684 | - |
|
| 2685 | - /** |
|
| 2686 | - * Creates a registration report, but accepts the name of a method to use for preparing the query parameters |
|
| 2687 | - * to use when selecting registrations |
|
| 2688 | - * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing |
|
| 2689 | - * the query parameters from the request |
|
| 2690 | - * @return void ends the request with a redirect or download |
|
| 2691 | - */ |
|
| 2692 | - public function _registrations_report_base( $method_name_for_getting_query_params ) |
|
| 2693 | - { |
|
| 2694 | - if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
| 2695 | - wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 2696 | - 'page' => 'espresso_batch', |
|
| 2697 | - 'batch' => 'file', |
|
| 2698 | - 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null, |
|
| 2699 | - 'filters' => urlencode( |
|
| 2700 | - serialize( |
|
| 2701 | - call_user_func( |
|
| 2702 | - array( $this, $method_name_for_getting_query_params ), |
|
| 2703 | - EEH_Array::is_set( |
|
| 2704 | - $this->_req_data, |
|
| 2705 | - 'filters', |
|
| 2706 | - array() |
|
| 2707 | - ) |
|
| 2708 | - ) |
|
| 2709 | - ) |
|
| 2710 | - ), |
|
| 2711 | - 'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false), |
|
| 2712 | - 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'), |
|
| 2713 | - 'return_url' => urlencode($this->_req_data['return_url']), |
|
| 2714 | - ))); |
|
| 2715 | - } else { |
|
| 2716 | - $new_request_args = array( |
|
| 2717 | - 'export' => 'report', |
|
| 2718 | - 'action' => 'registrations_report_for_event', |
|
| 2719 | - 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null, |
|
| 2720 | - ); |
|
| 2721 | - $this->_req_data = array_merge($this->_req_data, $new_request_args); |
|
| 2722 | - if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 2723 | - require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 2724 | - $EE_Export = EE_Export::instance($this->_req_data); |
|
| 2725 | - $EE_Export->export(); |
|
| 2726 | - } |
|
| 2727 | - } |
|
| 2728 | - } |
|
| 2729 | - |
|
| 2730 | - |
|
| 2731 | - |
|
| 2732 | - /** |
|
| 2733 | - * Creates a registration report using only query parameters in the request |
|
| 2734 | - * @return void |
|
| 2735 | - */ |
|
| 2736 | - public function _registrations_report() |
|
| 2737 | - { |
|
| 2738 | - $this->_registrations_report_base( '_get_registration_query_parameters' ); |
|
| 2739 | - } |
|
| 2740 | - |
|
| 2741 | - |
|
| 2742 | - public function _contact_list_export() |
|
| 2743 | - { |
|
| 2744 | - if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 2745 | - require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 2746 | - $EE_Export = EE_Export::instance($this->_req_data); |
|
| 2747 | - $EE_Export->export_attendees(); |
|
| 2748 | - } |
|
| 2749 | - } |
|
| 2750 | - |
|
| 2751 | - |
|
| 2752 | - public function _contact_list_report() |
|
| 2753 | - { |
|
| 2754 | - if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
| 2755 | - wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 2756 | - 'page' => 'espresso_batch', |
|
| 2757 | - 'batch' => 'file', |
|
| 2758 | - 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'), |
|
| 2759 | - 'return_url' => urlencode($this->_req_data['return_url']), |
|
| 2760 | - ))); |
|
| 2761 | - } else { |
|
| 2762 | - if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 2763 | - require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 2764 | - $EE_Export = EE_Export::instance($this->_req_data); |
|
| 2765 | - $EE_Export->report_attendees(); |
|
| 2766 | - } |
|
| 2767 | - } |
|
| 2768 | - } |
|
| 2769 | - |
|
| 2770 | - |
|
| 2771 | - |
|
| 2772 | - |
|
| 2773 | - |
|
| 2774 | - /*************************************** ATTENDEE DETAILS ***************************************/ |
|
| 2775 | - /** |
|
| 2776 | - * This duplicates the attendee object for the given incoming registration id and attendee_id. |
|
| 2777 | - * |
|
| 2778 | - * @return void |
|
| 2779 | - */ |
|
| 2780 | - protected function _duplicate_attendee() |
|
| 2781 | - { |
|
| 2782 | - $action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default'; |
|
| 2783 | - //verify we have necessary info |
|
| 2784 | - if (empty($this->_req_data['_REG_ID'])) { |
|
| 2785 | - EE_Error::add_error(__('Unable to create the contact for the registration because the required parameters are not present (_REG_ID )', |
|
| 2786 | - 'event_espresso'), __FILE__, __LINE__, __FUNCTION__); |
|
| 2787 | - $query_args = array('action' => $action); |
|
| 2788 | - $this->_redirect_after_action('', '', '', $query_args, true); |
|
| 2789 | - } |
|
| 2790 | - //okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration. |
|
| 2791 | - $registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']); |
|
| 2792 | - $attendee = $registration->attendee(); |
|
| 2793 | - //remove relation of existing attendee on registration |
|
| 2794 | - $registration->_remove_relation_to($attendee, 'Attendee'); |
|
| 2795 | - //new attendee |
|
| 2796 | - $new_attendee = clone $attendee; |
|
| 2797 | - $new_attendee->set('ATT_ID', 0); |
|
| 2798 | - $new_attendee->save(); |
|
| 2799 | - //add new attendee to reg |
|
| 2800 | - $registration->_add_relation_to($new_attendee, 'Attendee'); |
|
| 2801 | - EE_Error::add_success(__('New Contact record created. Now make any edits you wish to make for this contact.', |
|
| 2802 | - 'event_espresso')); |
|
| 2803 | - //redirect to edit page for attendee |
|
| 2804 | - $query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee'); |
|
| 2805 | - $this->_redirect_after_action('', '', '', $query_args, true); |
|
| 2806 | - } |
|
| 2807 | - |
|
| 2808 | - |
|
| 2809 | - //related to cpt routes |
|
| 2810 | - protected function _insert_update_cpt_item($post_id, $post) |
|
| 2811 | - { |
|
| 2812 | - $success = true; |
|
| 2813 | - $attendee = EEM_Attendee::instance()->get_one_by_ID($post_id); |
|
| 2814 | - //for attendee updates |
|
| 2815 | - if ($post->post_type = 'espresso_attendees' && ! empty($attendee)) { |
|
| 2816 | - //note we should only be UPDATING attendees at this point. |
|
| 2817 | - $updated_fields = array( |
|
| 2818 | - 'ATT_fname' => $this->_req_data['ATT_fname'], |
|
| 2819 | - 'ATT_lname' => $this->_req_data['ATT_lname'], |
|
| 2820 | - 'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'], |
|
| 2821 | - 'ATT_address' => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '', |
|
| 2822 | - 'ATT_address2' => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '', |
|
| 2823 | - 'ATT_city' => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '', |
|
| 2824 | - 'STA_ID' => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '', |
|
| 2825 | - 'CNT_ISO' => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '', |
|
| 2826 | - 'ATT_zip' => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '', |
|
| 2827 | - 'ATT_email' => isset($this->_req_data['ATT_email']) ? $this->_req_data['ATT_email'] : '', |
|
| 2828 | - 'ATT_phone' => isset($this->_req_data['ATT_phone']) ? $this->_req_data['ATT_phone'] : '', |
|
| 2829 | - ); |
|
| 2830 | - foreach ($updated_fields as $field => $value) { |
|
| 2831 | - $attendee->set($field, $value); |
|
| 2832 | - } |
|
| 2833 | - $success = $attendee->save(); |
|
| 2834 | - $attendee_update_callbacks = apply_filters('FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update', |
|
| 2835 | - array()); |
|
| 2836 | - foreach ($attendee_update_callbacks as $a_callback) { |
|
| 2837 | - if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) { |
|
| 2838 | - throw new EE_Error(sprintf(__('The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback. Please check the spelling.', |
|
| 2839 | - 'event_espresso'), $a_callback)); |
|
| 2840 | - } |
|
| 2841 | - } |
|
| 2842 | - } |
|
| 2843 | - if ($success === false) { |
|
| 2844 | - EE_Error::add_error(__('Something went wrong with updating the meta table data for the registration.', |
|
| 2845 | - 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 2846 | - } |
|
| 2847 | - } |
|
| 2848 | - |
|
| 2849 | - |
|
| 2850 | - public function trash_cpt_item($post_id) |
|
| 2851 | - { |
|
| 2852 | - } |
|
| 2853 | - |
|
| 2854 | - |
|
| 2855 | - public function delete_cpt_item($post_id) |
|
| 2856 | - { |
|
| 2857 | - } |
|
| 2858 | - |
|
| 2859 | - |
|
| 2860 | - public function restore_cpt_item($post_id) |
|
| 2861 | - { |
|
| 2862 | - } |
|
| 2863 | - |
|
| 2864 | - |
|
| 2865 | - protected function _restore_cpt_item($post_id, $revision_id) |
|
| 2866 | - { |
|
| 2867 | - } |
|
| 2868 | - |
|
| 2869 | - |
|
| 2870 | - public function attendee_editor_metaboxes() |
|
| 2871 | - { |
|
| 2872 | - $this->verify_cpt_object(); |
|
| 2873 | - remove_meta_box('postexcerpt', __('Excerpt'), 'post_excerpt_meta_box', $this->_cpt_routes[$this->_req_action], |
|
| 2874 | - 'normal', 'core'); |
|
| 2875 | - remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core'); |
|
| 2876 | - if (post_type_supports('espresso_attendees', 'excerpt')) { |
|
| 2877 | - add_meta_box('postexcerpt', __('Short Biography', 'event_espresso'), 'post_excerpt_meta_box', |
|
| 2878 | - $this->_cpt_routes[$this->_req_action], 'normal'); |
|
| 2879 | - } |
|
| 2880 | - if (post_type_supports('espresso_attendees', 'comments')) { |
|
| 2881 | - add_meta_box('commentsdiv', __('Notes on the Contact', 'event_espresso'), 'post_comment_meta_box', |
|
| 2882 | - $this->_cpt_routes[$this->_req_action], 'normal', 'core'); |
|
| 2883 | - } |
|
| 2884 | - add_meta_box('attendee_contact_info', __('Contact Info', 'event_espresso'), |
|
| 2885 | - array($this, 'attendee_contact_info'), $this->_cpt_routes[$this->_req_action], 'side', 'core'); |
|
| 2886 | - add_meta_box('attendee_details_address', __('Address Details', 'event_espresso'), |
|
| 2887 | - array($this, 'attendee_address_details'), $this->_cpt_routes[$this->_req_action], 'normal', 'core'); |
|
| 2888 | - add_meta_box('attendee_registrations', __('Registrations for this Contact', 'event_espresso'), |
|
| 2889 | - array($this, 'attendee_registrations_meta_box'), $this->_cpt_routes[$this->_req_action], 'normal', 'high'); |
|
| 2890 | - } |
|
| 2891 | - |
|
| 2892 | - |
|
| 2893 | - /** |
|
| 2894 | - * Metabox for attendee contact info |
|
| 2895 | - * |
|
| 2896 | - * @param WP_Post $post wp post object |
|
| 2897 | - * @return string attendee contact info ( and form ) |
|
| 2898 | - */ |
|
| 2899 | - public function attendee_contact_info($post) |
|
| 2900 | - { |
|
| 2901 | - //get attendee object ( should already have it ) |
|
| 2902 | - $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
| 2903 | - $template = REG_TEMPLATE_PATH . 'attendee_contact_info_metabox_content.template.php'; |
|
| 2904 | - EEH_Template::display_template($template, $this->_template_args); |
|
| 2905 | - } |
|
| 2906 | - |
|
| 2907 | - |
|
| 2908 | - /** |
|
| 2909 | - * Metabox for attendee details |
|
| 2910 | - * |
|
| 2911 | - * @param WP_Post $post wp post object |
|
| 2912 | - * @return string attendee address details (and form) |
|
| 2913 | - */ |
|
| 2914 | - public function attendee_address_details($post) |
|
| 2915 | - { |
|
| 2916 | - //get attendee object (should already have it) |
|
| 2917 | - $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
| 2918 | - $this->_template_args['state_html'] = EEH_Form_Fields::generate_form_input(new EE_Question_Form_Input(EE_Question::new_instance(array( |
|
| 2919 | - 'QST_ID' => 0, |
|
| 2920 | - 'QST_display_text' => __('State/Province', 'event_espresso'), |
|
| 2921 | - 'QST_system' => 'admin-state', |
|
| 2922 | - )), EE_Answer::new_instance(array( |
|
| 2923 | - 'ANS_ID' => 0, |
|
| 2924 | - 'ANS_value' => $this->_cpt_model_obj->state_ID(), |
|
| 2925 | - )), array( |
|
| 2926 | - 'input_id' => 'STA_ID', |
|
| 2927 | - 'input_name' => 'STA_ID', |
|
| 2928 | - 'input_prefix' => '', |
|
| 2929 | - 'append_qstn_id' => false, |
|
| 2930 | - ))); |
|
| 2931 | - $this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(new EE_Question_Form_Input(EE_Question::new_instance(array( |
|
| 2932 | - 'QST_ID' => 0, |
|
| 2933 | - 'QST_display_text' => __('Country', 'event_espresso'), |
|
| 2934 | - 'QST_system' => 'admin-country', |
|
| 2935 | - )), EE_Answer::new_instance(array( |
|
| 2936 | - 'ANS_ID' => 0, |
|
| 2937 | - 'ANS_value' => $this->_cpt_model_obj->country_ID(), |
|
| 2938 | - )), array( |
|
| 2939 | - 'input_id' => 'CNT_ISO', |
|
| 2940 | - 'input_name' => 'CNT_ISO', |
|
| 2941 | - 'input_prefix' => '', |
|
| 2942 | - 'append_qstn_id' => false, |
|
| 2943 | - ))); |
|
| 2944 | - $template = REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php'; |
|
| 2945 | - EEH_Template::display_template($template, $this->_template_args); |
|
| 2946 | - } |
|
| 2947 | - |
|
| 2948 | - |
|
| 2949 | - /** |
|
| 2950 | - * _attendee_details |
|
| 2951 | - * |
|
| 2952 | - * @access protected |
|
| 2953 | - * @return void |
|
| 2954 | - */ |
|
| 2955 | - public function attendee_registrations_meta_box($post) |
|
| 2956 | - { |
|
| 2957 | - $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
| 2958 | - $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration'); |
|
| 2959 | - $template = REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php'; |
|
| 2960 | - EEH_Template::display_template($template, $this->_template_args); |
|
| 2961 | - } |
|
| 2962 | - |
|
| 2963 | - |
|
| 2964 | - /** |
|
| 2965 | - * add in the form fields for the attendee edit |
|
| 2966 | - * |
|
| 2967 | - * @param WP_Post $post wp post object |
|
| 2968 | - * @return string html for new form. |
|
| 2969 | - */ |
|
| 2970 | - public function after_title_form_fields($post) |
|
| 2971 | - { |
|
| 2972 | - if ($post->post_type == 'espresso_attendees') { |
|
| 2973 | - $template = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php'; |
|
| 2974 | - $template_args['attendee'] = $this->_cpt_model_obj; |
|
| 2975 | - EEH_Template::display_template($template, $template_args); |
|
| 2976 | - } |
|
| 2977 | - } |
|
| 2978 | - |
|
| 2979 | - |
|
| 2980 | - /** |
|
| 2981 | - * _trash_or_restore_attendee |
|
| 2982 | - * |
|
| 2983 | - * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE) |
|
| 2984 | - * @access protected |
|
| 2985 | - * @return void |
|
| 2986 | - */ |
|
| 2987 | - protected function _trash_or_restore_attendees($trash = true) |
|
| 2988 | - { |
|
| 2989 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 2990 | - $ATT_MDL = EEM_Attendee::instance(); |
|
| 2991 | - $success = 1; |
|
| 2992 | - //Checkboxes |
|
| 2993 | - if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 2994 | - // if array has more than one element than success message should be plural |
|
| 2995 | - $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1; |
|
| 2996 | - // cycle thru checkboxes |
|
| 2997 | - while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) { |
|
| 2998 | - $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID) |
|
| 2999 | - : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID); |
|
| 3000 | - if ( ! $updated) { |
|
| 3001 | - $success = 0; |
|
| 3002 | - } |
|
| 3003 | - } |
|
| 3004 | - } else { |
|
| 3005 | - // grab single id and delete |
|
| 3006 | - $ATT_ID = absint($this->_req_data['ATT_ID']); |
|
| 3007 | - //get attendee |
|
| 3008 | - $att = $ATT_MDL->get_one_by_ID($ATT_ID); |
|
| 3009 | - $updated = $trash ? $att->set_status('trash') : $att->set_status('publish'); |
|
| 3010 | - $updated = $att->save(); |
|
| 3011 | - if ( ! $updated) { |
|
| 3012 | - $success = 0; |
|
| 3013 | - } |
|
| 3014 | - } |
|
| 3015 | - $what = $success > 1 ? __('Contacts', 'event_espresso') : __('Contact', 'event_espresso'); |
|
| 3016 | - $action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso'); |
|
| 3017 | - $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list')); |
|
| 3018 | - } |
|
| 2367 | + } |
|
| 2368 | + $template_args = array( |
|
| 2369 | + 'title' => '', |
|
| 2370 | + 'content' => '', |
|
| 2371 | + 'step_button_text' => '', |
|
| 2372 | + 'show_notification_toggle' => false, |
|
| 2373 | + ); |
|
| 2374 | + //to indicate we're processing a new registration |
|
| 2375 | + $hidden_fields = array( |
|
| 2376 | + 'processing_registration' => array( |
|
| 2377 | + 'type' => 'hidden', |
|
| 2378 | + 'value' => 0, |
|
| 2379 | + ), |
|
| 2380 | + 'event_id' => array( |
|
| 2381 | + 'type' => 'hidden', |
|
| 2382 | + 'value' => $this->_reg_event->ID(), |
|
| 2383 | + ), |
|
| 2384 | + ); |
|
| 2385 | + //if the cart is empty then we know we're at step one so we'll display ticket selector |
|
| 2386 | + $cart = EE_Registry::instance()->SSN->cart(); |
|
| 2387 | + $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions'; |
|
| 2388 | + switch ($step) { |
|
| 2389 | + case 'ticket' : |
|
| 2390 | + $hidden_fields['processing_registration']['value'] = 1; |
|
| 2391 | + $template_args['title'] = __('Step One: Select the Ticket for this registration', |
|
| 2392 | + 'event_espresso'); |
|
| 2393 | + $template_args['content'] = EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event); |
|
| 2394 | + $template_args['step_button_text'] = __('Add Tickets and Continue to Registrant Details', |
|
| 2395 | + 'event_espresso'); |
|
| 2396 | + $template_args['show_notification_toggle'] = false; |
|
| 2397 | + break; |
|
| 2398 | + case 'questions' : |
|
| 2399 | + $hidden_fields['processing_registration']['value'] = 2; |
|
| 2400 | + $template_args['title'] = __('Step Two: Add Registrant Details for this Registration', |
|
| 2401 | + 'event_espresso'); |
|
| 2402 | + //in theory we should be able to run EED_SPCO at this point because the cart should have been setup properly by the first process_reg_step run. |
|
| 2403 | + $template_args['content'] = EED_Single_Page_Checkout::registration_checkout_for_admin(); |
|
| 2404 | + $template_args['step_button_text'] = __('Save Registration and Continue to Details', |
|
| 2405 | + 'event_espresso'); |
|
| 2406 | + $template_args['show_notification_toggle'] = true; |
|
| 2407 | + break; |
|
| 2408 | + } |
|
| 2409 | + $this->_set_add_edit_form_tags('process_reg_step', |
|
| 2410 | + $hidden_fields); //we come back to the process_registration_step route. |
|
| 2411 | + return EEH_Template::display_template(REG_TEMPLATE_PATH |
|
| 2412 | + . 'reg_admin_register_new_attendee_step_content.template.php', |
|
| 2413 | + $template_args, true); |
|
| 2414 | + } |
|
| 2415 | + |
|
| 2416 | + |
|
| 2417 | + /** |
|
| 2418 | + * set_reg_event |
|
| 2419 | + * |
|
| 2420 | + * @access private |
|
| 2421 | + * @return boolean |
|
| 2422 | + */ |
|
| 2423 | + private function _set_reg_event() |
|
| 2424 | + { |
|
| 2425 | + if (is_object($this->_reg_event)) { |
|
| 2426 | + return true; |
|
| 2427 | + } |
|
| 2428 | + $EVT_ID = ( ! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false; |
|
| 2429 | + if ( ! $EVT_ID) { |
|
| 2430 | + return false; |
|
| 2431 | + } |
|
| 2432 | + $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
| 2433 | + return true; |
|
| 2434 | + } |
|
| 2435 | + |
|
| 2436 | + |
|
| 2437 | + /** |
|
| 2438 | + * process_reg_step |
|
| 2439 | + * |
|
| 2440 | + * @access public |
|
| 2441 | + * @return string |
|
| 2442 | + * @throws \RuntimeException |
|
| 2443 | + * @throws \EE_Error |
|
| 2444 | + */ |
|
| 2445 | + public function process_reg_step() |
|
| 2446 | + { |
|
| 2447 | + EE_System::do_not_cache(); |
|
| 2448 | + $this->_set_reg_event(); |
|
| 2449 | + EE_Registry::instance()->REQ->set_espresso_page(true); |
|
| 2450 | + EE_Registry::instance()->REQ->set('uts', time()); |
|
| 2451 | + //what step are we on? |
|
| 2452 | + $cart = EE_Registry::instance()->SSN->cart(); |
|
| 2453 | + $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions'; |
|
| 2454 | + //if doing ajax then we need to verify the nonce |
|
| 2455 | + if (defined('DOING_AJAX')) { |
|
| 2456 | + $nonce = isset($this->_req_data[$this->_req_nonce]) |
|
| 2457 | + ? sanitize_text_field($this->_req_data[$this->_req_nonce]) : ''; |
|
| 2458 | + $this->_verify_nonce($nonce, $this->_req_nonce); |
|
| 2459 | + } |
|
| 2460 | + switch ($step) { |
|
| 2461 | + case 'ticket' : |
|
| 2462 | + //process ticket selection |
|
| 2463 | + $success = EED_Ticket_Selector::instance()->process_ticket_selections(); |
|
| 2464 | + if ($success) { |
|
| 2465 | + EE_Error::add_success(esc_html__('Tickets Selected. Now complete the registration.', |
|
| 2466 | + 'event_espresso')); |
|
| 2467 | + } else { |
|
| 2468 | + $query_args['step_error'] = $this->_req_data['step_error'] = true; |
|
| 2469 | + } |
|
| 2470 | + if (defined('DOING_AJAX')) { |
|
| 2471 | + $this->new_registration(); //display next step |
|
| 2472 | + } else { |
|
| 2473 | + $query_args = array( |
|
| 2474 | + 'action' => 'new_registration', |
|
| 2475 | + 'processing_registration' => 1, |
|
| 2476 | + 'event_id' => $this->_reg_event->ID(), |
|
| 2477 | + 'uts' => time(), |
|
| 2478 | + ); |
|
| 2479 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 2480 | + } |
|
| 2481 | + break; |
|
| 2482 | + case 'questions' : |
|
| 2483 | + if ( ! isset($this->_req_data['txn_reg_status_change'], $this->_req_data['txn_reg_status_change']['send_notifications'])) { |
|
| 2484 | + add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15); |
|
| 2485 | + } |
|
| 2486 | + //process registration |
|
| 2487 | + $transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin(); |
|
| 2488 | + if ($cart instanceof EE_Cart) { |
|
| 2489 | + $grand_total = $cart->get_cart_grand_total(); |
|
| 2490 | + if ($grand_total instanceof EE_Line_Item) { |
|
| 2491 | + $grand_total->save_this_and_descendants_to_txn(); |
|
| 2492 | + } |
|
| 2493 | + } |
|
| 2494 | + if ( ! $transaction instanceof EE_Transaction) { |
|
| 2495 | + $query_args = array( |
|
| 2496 | + 'action' => 'new_registration', |
|
| 2497 | + 'processing_registration' => 2, |
|
| 2498 | + 'event_id' => $this->_reg_event->ID(), |
|
| 2499 | + 'uts' => time(), |
|
| 2500 | + ); |
|
| 2501 | + if (defined('DOING_AJAX')) { |
|
| 2502 | + //display registration form again because there are errors (maybe validation?) |
|
| 2503 | + $this->new_registration(); |
|
| 2504 | + return; |
|
| 2505 | + } else { |
|
| 2506 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 2507 | + return; |
|
| 2508 | + } |
|
| 2509 | + } |
|
| 2510 | + // maybe update status, and make sure to save transaction if not done already |
|
| 2511 | + if ( ! $transaction->update_status_based_on_total_paid()) { |
|
| 2512 | + $transaction->save(); |
|
| 2513 | + } |
|
| 2514 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 2515 | + $this->_req_data = array(); |
|
| 2516 | + $query_args = array( |
|
| 2517 | + 'action' => 'redirect_to_txn', |
|
| 2518 | + 'TXN_ID' => $transaction->ID(), |
|
| 2519 | + 'EVT_ID' => $this->_reg_event->ID(), |
|
| 2520 | + 'event_name' => urlencode($this->_reg_event->name()), |
|
| 2521 | + 'redirect_from' => 'new_registration', |
|
| 2522 | + ); |
|
| 2523 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 2524 | + break; |
|
| 2525 | + } |
|
| 2526 | + //what are you looking here for? Should be nothing to do at this point. |
|
| 2527 | + } |
|
| 2528 | + |
|
| 2529 | + |
|
| 2530 | + /** |
|
| 2531 | + * redirect_to_txn |
|
| 2532 | + * |
|
| 2533 | + * @access public |
|
| 2534 | + * @return void |
|
| 2535 | + */ |
|
| 2536 | + public function redirect_to_txn() |
|
| 2537 | + { |
|
| 2538 | + EE_System::do_not_cache(); |
|
| 2539 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 2540 | + $query_args = array( |
|
| 2541 | + 'action' => 'view_transaction', |
|
| 2542 | + 'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0, |
|
| 2543 | + 'page' => 'espresso_transactions', |
|
| 2544 | + ); |
|
| 2545 | + if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) { |
|
| 2546 | + $query_args['EVT_ID'] = $this->_req_data['EVT_ID']; |
|
| 2547 | + $query_args['event_name'] = urlencode($this->_req_data['event_name']); |
|
| 2548 | + $query_args['redirect_from'] = $this->_req_data['redirect_from']; |
|
| 2549 | + } |
|
| 2550 | + EE_Error::add_success(__('Registration Created. Please review the transaction and add any payments as necessary', |
|
| 2551 | + 'event_espresso')); |
|
| 2552 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 2553 | + } |
|
| 2554 | + |
|
| 2555 | + |
|
| 2556 | + /** |
|
| 2557 | + * generates HTML for the Attendee Contact List |
|
| 2558 | + * |
|
| 2559 | + * @access protected |
|
| 2560 | + * @return void |
|
| 2561 | + */ |
|
| 2562 | + protected function _attendee_contact_list_table() |
|
| 2563 | + { |
|
| 2564 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 2565 | + $this->_search_btn_label = __('Contacts', 'event_espresso'); |
|
| 2566 | + $this->display_admin_list_table_page_with_no_sidebar(); |
|
| 2567 | + } |
|
| 2568 | + |
|
| 2569 | + |
|
| 2570 | + /** |
|
| 2571 | + * get_attendees |
|
| 2572 | + * |
|
| 2573 | + * @param bool $count whether to return count or data. |
|
| 2574 | + * @access public |
|
| 2575 | + * @return array |
|
| 2576 | + */ |
|
| 2577 | + public function get_attendees($per_page, $count = false, $trash = false) |
|
| 2578 | + { |
|
| 2579 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 2580 | + require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php'); |
|
| 2581 | + $ATT_MDL = EEM_Attendee::instance(); |
|
| 2582 | + $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : ''; |
|
| 2583 | + switch ($this->_req_data['orderby']) { |
|
| 2584 | + case 'ATT_ID': |
|
| 2585 | + $orderby = 'ATT_ID'; |
|
| 2586 | + break; |
|
| 2587 | + case 'ATT_fname': |
|
| 2588 | + $orderby = 'ATT_fname'; |
|
| 2589 | + break; |
|
| 2590 | + case 'ATT_email': |
|
| 2591 | + $orderby = 'ATT_email'; |
|
| 2592 | + break; |
|
| 2593 | + case 'ATT_city': |
|
| 2594 | + $orderby = 'ATT_city'; |
|
| 2595 | + break; |
|
| 2596 | + case 'STA_ID': |
|
| 2597 | + $orderby = 'STA_ID'; |
|
| 2598 | + break; |
|
| 2599 | + case 'CNT_ID': |
|
| 2600 | + $orderby = 'CNT_ID'; |
|
| 2601 | + break; |
|
| 2602 | + default: |
|
| 2603 | + $orderby = 'ATT_lname'; |
|
| 2604 | + } |
|
| 2605 | + $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] |
|
| 2606 | + : 'ASC'; |
|
| 2607 | + $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) |
|
| 2608 | + ? $this->_req_data['paged'] : 1; |
|
| 2609 | + $per_page = isset($per_page) && ! empty($per_page) ? $per_page : 10; |
|
| 2610 | + $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) |
|
| 2611 | + ? $this->_req_data['perpage'] : $per_page; |
|
| 2612 | + $_where = array(); |
|
| 2613 | + if ( ! empty($this->_req_data['s'])) { |
|
| 2614 | + $sstr = '%' . $this->_req_data['s'] . '%'; |
|
| 2615 | + $_where['OR'] = array( |
|
| 2616 | + 'Registration.Event.EVT_name' => array('LIKE', $sstr), |
|
| 2617 | + 'Registration.Event.EVT_desc' => array('LIKE', $sstr), |
|
| 2618 | + 'Registration.Event.EVT_short_desc' => array('LIKE', $sstr), |
|
| 2619 | + 'ATT_fname' => array('LIKE', $sstr), |
|
| 2620 | + 'ATT_lname' => array('LIKE', $sstr), |
|
| 2621 | + 'ATT_short_bio' => array('LIKE', $sstr), |
|
| 2622 | + 'ATT_email' => array('LIKE', $sstr), |
|
| 2623 | + 'ATT_address' => array('LIKE', $sstr), |
|
| 2624 | + 'ATT_address2' => array('LIKE', $sstr), |
|
| 2625 | + 'ATT_city' => array('LIKE', $sstr), |
|
| 2626 | + 'Country.CNT_name' => array('LIKE', $sstr), |
|
| 2627 | + 'State.STA_name' => array('LIKE', $sstr), |
|
| 2628 | + 'ATT_phone' => array('LIKE', $sstr), |
|
| 2629 | + 'Registration.REG_final_price' => array('LIKE', $sstr), |
|
| 2630 | + 'Registration.REG_code' => array('LIKE', $sstr), |
|
| 2631 | + 'Registration.REG_count' => array('LIKE', $sstr), |
|
| 2632 | + 'Registration.REG_group_size' => array('LIKE', $sstr), |
|
| 2633 | + ); |
|
| 2634 | + } |
|
| 2635 | + $offset = ($current_page - 1) * $per_page; |
|
| 2636 | + $limit = $count ? null : array($offset, $per_page); |
|
| 2637 | + if ($trash) { |
|
| 2638 | + $_where['status'] = array('!=', 'publish'); |
|
| 2639 | + $all_attendees = $count |
|
| 2640 | + ? $ATT_MDL->count(array( |
|
| 2641 | + $_where, |
|
| 2642 | + 'order_by' => array($orderby => $sort), |
|
| 2643 | + 'limit' => $limit, |
|
| 2644 | + ), 'ATT_ID', true) |
|
| 2645 | + : $ATT_MDL->get_all(array( |
|
| 2646 | + $_where, |
|
| 2647 | + 'order_by' => array($orderby => $sort), |
|
| 2648 | + 'limit' => $limit, |
|
| 2649 | + )); |
|
| 2650 | + } else { |
|
| 2651 | + $_where['status'] = array('IN', array('publish')); |
|
| 2652 | + $all_attendees = $count |
|
| 2653 | + ? $ATT_MDL->count(array( |
|
| 2654 | + $_where, |
|
| 2655 | + 'order_by' => array($orderby => $sort), |
|
| 2656 | + 'limit' => $limit, |
|
| 2657 | + ), 'ATT_ID', true) |
|
| 2658 | + : $ATT_MDL->get_all(array( |
|
| 2659 | + $_where, |
|
| 2660 | + 'order_by' => array($orderby => $sort), |
|
| 2661 | + 'limit' => $limit, |
|
| 2662 | + )); |
|
| 2663 | + } |
|
| 2664 | + return $all_attendees; |
|
| 2665 | + } |
|
| 2666 | + |
|
| 2667 | + |
|
| 2668 | + /** |
|
| 2669 | + * This is just taking care of resending the registration confirmation |
|
| 2670 | + * |
|
| 2671 | + * @access protected |
|
| 2672 | + * @return void |
|
| 2673 | + */ |
|
| 2674 | + protected function _resend_registration() |
|
| 2675 | + { |
|
| 2676 | + $this->_process_resend_registration(); |
|
| 2677 | + $query_args = isset($this->_req_data['redirect_to']) |
|
| 2678 | + ? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID']) |
|
| 2679 | + : array( |
|
| 2680 | + 'action' => 'default', |
|
| 2681 | + ); |
|
| 2682 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
| 2683 | + } |
|
| 2684 | + |
|
| 2685 | + /** |
|
| 2686 | + * Creates a registration report, but accepts the name of a method to use for preparing the query parameters |
|
| 2687 | + * to use when selecting registrations |
|
| 2688 | + * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing |
|
| 2689 | + * the query parameters from the request |
|
| 2690 | + * @return void ends the request with a redirect or download |
|
| 2691 | + */ |
|
| 2692 | + public function _registrations_report_base( $method_name_for_getting_query_params ) |
|
| 2693 | + { |
|
| 2694 | + if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
| 2695 | + wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 2696 | + 'page' => 'espresso_batch', |
|
| 2697 | + 'batch' => 'file', |
|
| 2698 | + 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null, |
|
| 2699 | + 'filters' => urlencode( |
|
| 2700 | + serialize( |
|
| 2701 | + call_user_func( |
|
| 2702 | + array( $this, $method_name_for_getting_query_params ), |
|
| 2703 | + EEH_Array::is_set( |
|
| 2704 | + $this->_req_data, |
|
| 2705 | + 'filters', |
|
| 2706 | + array() |
|
| 2707 | + ) |
|
| 2708 | + ) |
|
| 2709 | + ) |
|
| 2710 | + ), |
|
| 2711 | + 'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false), |
|
| 2712 | + 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'), |
|
| 2713 | + 'return_url' => urlencode($this->_req_data['return_url']), |
|
| 2714 | + ))); |
|
| 2715 | + } else { |
|
| 2716 | + $new_request_args = array( |
|
| 2717 | + 'export' => 'report', |
|
| 2718 | + 'action' => 'registrations_report_for_event', |
|
| 2719 | + 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null, |
|
| 2720 | + ); |
|
| 2721 | + $this->_req_data = array_merge($this->_req_data, $new_request_args); |
|
| 2722 | + if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 2723 | + require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 2724 | + $EE_Export = EE_Export::instance($this->_req_data); |
|
| 2725 | + $EE_Export->export(); |
|
| 2726 | + } |
|
| 2727 | + } |
|
| 2728 | + } |
|
| 2729 | + |
|
| 2730 | + |
|
| 2731 | + |
|
| 2732 | + /** |
|
| 2733 | + * Creates a registration report using only query parameters in the request |
|
| 2734 | + * @return void |
|
| 2735 | + */ |
|
| 2736 | + public function _registrations_report() |
|
| 2737 | + { |
|
| 2738 | + $this->_registrations_report_base( '_get_registration_query_parameters' ); |
|
| 2739 | + } |
|
| 2740 | + |
|
| 2741 | + |
|
| 2742 | + public function _contact_list_export() |
|
| 2743 | + { |
|
| 2744 | + if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 2745 | + require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 2746 | + $EE_Export = EE_Export::instance($this->_req_data); |
|
| 2747 | + $EE_Export->export_attendees(); |
|
| 2748 | + } |
|
| 2749 | + } |
|
| 2750 | + |
|
| 2751 | + |
|
| 2752 | + public function _contact_list_report() |
|
| 2753 | + { |
|
| 2754 | + if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
| 2755 | + wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 2756 | + 'page' => 'espresso_batch', |
|
| 2757 | + 'batch' => 'file', |
|
| 2758 | + 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'), |
|
| 2759 | + 'return_url' => urlencode($this->_req_data['return_url']), |
|
| 2760 | + ))); |
|
| 2761 | + } else { |
|
| 2762 | + if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
| 2763 | + require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
| 2764 | + $EE_Export = EE_Export::instance($this->_req_data); |
|
| 2765 | + $EE_Export->report_attendees(); |
|
| 2766 | + } |
|
| 2767 | + } |
|
| 2768 | + } |
|
| 2769 | + |
|
| 2770 | + |
|
| 2771 | + |
|
| 2772 | + |
|
| 2773 | + |
|
| 2774 | + /*************************************** ATTENDEE DETAILS ***************************************/ |
|
| 2775 | + /** |
|
| 2776 | + * This duplicates the attendee object for the given incoming registration id and attendee_id. |
|
| 2777 | + * |
|
| 2778 | + * @return void |
|
| 2779 | + */ |
|
| 2780 | + protected function _duplicate_attendee() |
|
| 2781 | + { |
|
| 2782 | + $action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default'; |
|
| 2783 | + //verify we have necessary info |
|
| 2784 | + if (empty($this->_req_data['_REG_ID'])) { |
|
| 2785 | + EE_Error::add_error(__('Unable to create the contact for the registration because the required parameters are not present (_REG_ID )', |
|
| 2786 | + 'event_espresso'), __FILE__, __LINE__, __FUNCTION__); |
|
| 2787 | + $query_args = array('action' => $action); |
|
| 2788 | + $this->_redirect_after_action('', '', '', $query_args, true); |
|
| 2789 | + } |
|
| 2790 | + //okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration. |
|
| 2791 | + $registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']); |
|
| 2792 | + $attendee = $registration->attendee(); |
|
| 2793 | + //remove relation of existing attendee on registration |
|
| 2794 | + $registration->_remove_relation_to($attendee, 'Attendee'); |
|
| 2795 | + //new attendee |
|
| 2796 | + $new_attendee = clone $attendee; |
|
| 2797 | + $new_attendee->set('ATT_ID', 0); |
|
| 2798 | + $new_attendee->save(); |
|
| 2799 | + //add new attendee to reg |
|
| 2800 | + $registration->_add_relation_to($new_attendee, 'Attendee'); |
|
| 2801 | + EE_Error::add_success(__('New Contact record created. Now make any edits you wish to make for this contact.', |
|
| 2802 | + 'event_espresso')); |
|
| 2803 | + //redirect to edit page for attendee |
|
| 2804 | + $query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee'); |
|
| 2805 | + $this->_redirect_after_action('', '', '', $query_args, true); |
|
| 2806 | + } |
|
| 2807 | + |
|
| 2808 | + |
|
| 2809 | + //related to cpt routes |
|
| 2810 | + protected function _insert_update_cpt_item($post_id, $post) |
|
| 2811 | + { |
|
| 2812 | + $success = true; |
|
| 2813 | + $attendee = EEM_Attendee::instance()->get_one_by_ID($post_id); |
|
| 2814 | + //for attendee updates |
|
| 2815 | + if ($post->post_type = 'espresso_attendees' && ! empty($attendee)) { |
|
| 2816 | + //note we should only be UPDATING attendees at this point. |
|
| 2817 | + $updated_fields = array( |
|
| 2818 | + 'ATT_fname' => $this->_req_data['ATT_fname'], |
|
| 2819 | + 'ATT_lname' => $this->_req_data['ATT_lname'], |
|
| 2820 | + 'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'], |
|
| 2821 | + 'ATT_address' => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '', |
|
| 2822 | + 'ATT_address2' => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '', |
|
| 2823 | + 'ATT_city' => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '', |
|
| 2824 | + 'STA_ID' => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '', |
|
| 2825 | + 'CNT_ISO' => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '', |
|
| 2826 | + 'ATT_zip' => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '', |
|
| 2827 | + 'ATT_email' => isset($this->_req_data['ATT_email']) ? $this->_req_data['ATT_email'] : '', |
|
| 2828 | + 'ATT_phone' => isset($this->_req_data['ATT_phone']) ? $this->_req_data['ATT_phone'] : '', |
|
| 2829 | + ); |
|
| 2830 | + foreach ($updated_fields as $field => $value) { |
|
| 2831 | + $attendee->set($field, $value); |
|
| 2832 | + } |
|
| 2833 | + $success = $attendee->save(); |
|
| 2834 | + $attendee_update_callbacks = apply_filters('FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update', |
|
| 2835 | + array()); |
|
| 2836 | + foreach ($attendee_update_callbacks as $a_callback) { |
|
| 2837 | + if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) { |
|
| 2838 | + throw new EE_Error(sprintf(__('The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback. Please check the spelling.', |
|
| 2839 | + 'event_espresso'), $a_callback)); |
|
| 2840 | + } |
|
| 2841 | + } |
|
| 2842 | + } |
|
| 2843 | + if ($success === false) { |
|
| 2844 | + EE_Error::add_error(__('Something went wrong with updating the meta table data for the registration.', |
|
| 2845 | + 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 2846 | + } |
|
| 2847 | + } |
|
| 2848 | + |
|
| 2849 | + |
|
| 2850 | + public function trash_cpt_item($post_id) |
|
| 2851 | + { |
|
| 2852 | + } |
|
| 2853 | + |
|
| 2854 | + |
|
| 2855 | + public function delete_cpt_item($post_id) |
|
| 2856 | + { |
|
| 2857 | + } |
|
| 2858 | + |
|
| 2859 | + |
|
| 2860 | + public function restore_cpt_item($post_id) |
|
| 2861 | + { |
|
| 2862 | + } |
|
| 2863 | + |
|
| 2864 | + |
|
| 2865 | + protected function _restore_cpt_item($post_id, $revision_id) |
|
| 2866 | + { |
|
| 2867 | + } |
|
| 2868 | + |
|
| 2869 | + |
|
| 2870 | + public function attendee_editor_metaboxes() |
|
| 2871 | + { |
|
| 2872 | + $this->verify_cpt_object(); |
|
| 2873 | + remove_meta_box('postexcerpt', __('Excerpt'), 'post_excerpt_meta_box', $this->_cpt_routes[$this->_req_action], |
|
| 2874 | + 'normal', 'core'); |
|
| 2875 | + remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core'); |
|
| 2876 | + if (post_type_supports('espresso_attendees', 'excerpt')) { |
|
| 2877 | + add_meta_box('postexcerpt', __('Short Biography', 'event_espresso'), 'post_excerpt_meta_box', |
|
| 2878 | + $this->_cpt_routes[$this->_req_action], 'normal'); |
|
| 2879 | + } |
|
| 2880 | + if (post_type_supports('espresso_attendees', 'comments')) { |
|
| 2881 | + add_meta_box('commentsdiv', __('Notes on the Contact', 'event_espresso'), 'post_comment_meta_box', |
|
| 2882 | + $this->_cpt_routes[$this->_req_action], 'normal', 'core'); |
|
| 2883 | + } |
|
| 2884 | + add_meta_box('attendee_contact_info', __('Contact Info', 'event_espresso'), |
|
| 2885 | + array($this, 'attendee_contact_info'), $this->_cpt_routes[$this->_req_action], 'side', 'core'); |
|
| 2886 | + add_meta_box('attendee_details_address', __('Address Details', 'event_espresso'), |
|
| 2887 | + array($this, 'attendee_address_details'), $this->_cpt_routes[$this->_req_action], 'normal', 'core'); |
|
| 2888 | + add_meta_box('attendee_registrations', __('Registrations for this Contact', 'event_espresso'), |
|
| 2889 | + array($this, 'attendee_registrations_meta_box'), $this->_cpt_routes[$this->_req_action], 'normal', 'high'); |
|
| 2890 | + } |
|
| 2891 | + |
|
| 2892 | + |
|
| 2893 | + /** |
|
| 2894 | + * Metabox for attendee contact info |
|
| 2895 | + * |
|
| 2896 | + * @param WP_Post $post wp post object |
|
| 2897 | + * @return string attendee contact info ( and form ) |
|
| 2898 | + */ |
|
| 2899 | + public function attendee_contact_info($post) |
|
| 2900 | + { |
|
| 2901 | + //get attendee object ( should already have it ) |
|
| 2902 | + $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
| 2903 | + $template = REG_TEMPLATE_PATH . 'attendee_contact_info_metabox_content.template.php'; |
|
| 2904 | + EEH_Template::display_template($template, $this->_template_args); |
|
| 2905 | + } |
|
| 2906 | + |
|
| 2907 | + |
|
| 2908 | + /** |
|
| 2909 | + * Metabox for attendee details |
|
| 2910 | + * |
|
| 2911 | + * @param WP_Post $post wp post object |
|
| 2912 | + * @return string attendee address details (and form) |
|
| 2913 | + */ |
|
| 2914 | + public function attendee_address_details($post) |
|
| 2915 | + { |
|
| 2916 | + //get attendee object (should already have it) |
|
| 2917 | + $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
| 2918 | + $this->_template_args['state_html'] = EEH_Form_Fields::generate_form_input(new EE_Question_Form_Input(EE_Question::new_instance(array( |
|
| 2919 | + 'QST_ID' => 0, |
|
| 2920 | + 'QST_display_text' => __('State/Province', 'event_espresso'), |
|
| 2921 | + 'QST_system' => 'admin-state', |
|
| 2922 | + )), EE_Answer::new_instance(array( |
|
| 2923 | + 'ANS_ID' => 0, |
|
| 2924 | + 'ANS_value' => $this->_cpt_model_obj->state_ID(), |
|
| 2925 | + )), array( |
|
| 2926 | + 'input_id' => 'STA_ID', |
|
| 2927 | + 'input_name' => 'STA_ID', |
|
| 2928 | + 'input_prefix' => '', |
|
| 2929 | + 'append_qstn_id' => false, |
|
| 2930 | + ))); |
|
| 2931 | + $this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(new EE_Question_Form_Input(EE_Question::new_instance(array( |
|
| 2932 | + 'QST_ID' => 0, |
|
| 2933 | + 'QST_display_text' => __('Country', 'event_espresso'), |
|
| 2934 | + 'QST_system' => 'admin-country', |
|
| 2935 | + )), EE_Answer::new_instance(array( |
|
| 2936 | + 'ANS_ID' => 0, |
|
| 2937 | + 'ANS_value' => $this->_cpt_model_obj->country_ID(), |
|
| 2938 | + )), array( |
|
| 2939 | + 'input_id' => 'CNT_ISO', |
|
| 2940 | + 'input_name' => 'CNT_ISO', |
|
| 2941 | + 'input_prefix' => '', |
|
| 2942 | + 'append_qstn_id' => false, |
|
| 2943 | + ))); |
|
| 2944 | + $template = REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php'; |
|
| 2945 | + EEH_Template::display_template($template, $this->_template_args); |
|
| 2946 | + } |
|
| 2947 | + |
|
| 2948 | + |
|
| 2949 | + /** |
|
| 2950 | + * _attendee_details |
|
| 2951 | + * |
|
| 2952 | + * @access protected |
|
| 2953 | + * @return void |
|
| 2954 | + */ |
|
| 2955 | + public function attendee_registrations_meta_box($post) |
|
| 2956 | + { |
|
| 2957 | + $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
| 2958 | + $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration'); |
|
| 2959 | + $template = REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php'; |
|
| 2960 | + EEH_Template::display_template($template, $this->_template_args); |
|
| 2961 | + } |
|
| 2962 | + |
|
| 2963 | + |
|
| 2964 | + /** |
|
| 2965 | + * add in the form fields for the attendee edit |
|
| 2966 | + * |
|
| 2967 | + * @param WP_Post $post wp post object |
|
| 2968 | + * @return string html for new form. |
|
| 2969 | + */ |
|
| 2970 | + public function after_title_form_fields($post) |
|
| 2971 | + { |
|
| 2972 | + if ($post->post_type == 'espresso_attendees') { |
|
| 2973 | + $template = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php'; |
|
| 2974 | + $template_args['attendee'] = $this->_cpt_model_obj; |
|
| 2975 | + EEH_Template::display_template($template, $template_args); |
|
| 2976 | + } |
|
| 2977 | + } |
|
| 2978 | + |
|
| 2979 | + |
|
| 2980 | + /** |
|
| 2981 | + * _trash_or_restore_attendee |
|
| 2982 | + * |
|
| 2983 | + * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE) |
|
| 2984 | + * @access protected |
|
| 2985 | + * @return void |
|
| 2986 | + */ |
|
| 2987 | + protected function _trash_or_restore_attendees($trash = true) |
|
| 2988 | + { |
|
| 2989 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 2990 | + $ATT_MDL = EEM_Attendee::instance(); |
|
| 2991 | + $success = 1; |
|
| 2992 | + //Checkboxes |
|
| 2993 | + if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
| 2994 | + // if array has more than one element than success message should be plural |
|
| 2995 | + $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1; |
|
| 2996 | + // cycle thru checkboxes |
|
| 2997 | + while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) { |
|
| 2998 | + $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID) |
|
| 2999 | + : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID); |
|
| 3000 | + if ( ! $updated) { |
|
| 3001 | + $success = 0; |
|
| 3002 | + } |
|
| 3003 | + } |
|
| 3004 | + } else { |
|
| 3005 | + // grab single id and delete |
|
| 3006 | + $ATT_ID = absint($this->_req_data['ATT_ID']); |
|
| 3007 | + //get attendee |
|
| 3008 | + $att = $ATT_MDL->get_one_by_ID($ATT_ID); |
|
| 3009 | + $updated = $trash ? $att->set_status('trash') : $att->set_status('publish'); |
|
| 3010 | + $updated = $att->save(); |
|
| 3011 | + if ( ! $updated) { |
|
| 3012 | + $success = 0; |
|
| 3013 | + } |
|
| 3014 | + } |
|
| 3015 | + $what = $success > 1 ? __('Contacts', 'event_espresso') : __('Contact', 'event_espresso'); |
|
| 3016 | + $action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso'); |
|
| 3017 | + $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list')); |
|
| 3018 | + } |
|
| 3019 | 3019 | |
| 3020 | 3020 | } |
| 3021 | 3021 | |
@@ -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 | /** |
@@ -24,445 +24,445 @@ discard block |
||
| 24 | 24 | { |
| 25 | 25 | |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * This gets set in _setup_cpt |
|
| 29 | - * It will contain the object for the custom post type. |
|
| 30 | - * |
|
| 31 | - * @var object |
|
| 32 | - */ |
|
| 33 | - protected $_cpt_object; |
|
| 34 | - |
|
| 35 | - |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * a boolean flag to set whether the current route is a cpt route or not. |
|
| 39 | - * |
|
| 40 | - * @var bool |
|
| 41 | - */ |
|
| 42 | - protected $_cpt_route = false; |
|
| 43 | - |
|
| 44 | - |
|
| 45 | - |
|
| 46 | - /** |
|
| 47 | - * This property allows cpt classes to define multiple routes as cpt routes. |
|
| 48 | - * //in this array we define what the custom post type for this route is. |
|
| 49 | - * array( |
|
| 50 | - * 'route_name' => 'custom_post_type_slug' |
|
| 51 | - * ) |
|
| 52 | - * |
|
| 53 | - * @var array |
|
| 54 | - */ |
|
| 55 | - protected $_cpt_routes = array(); |
|
| 56 | - |
|
| 27 | + /** |
|
| 28 | + * This gets set in _setup_cpt |
|
| 29 | + * It will contain the object for the custom post type. |
|
| 30 | + * |
|
| 31 | + * @var object |
|
| 32 | + */ |
|
| 33 | + protected $_cpt_object; |
|
| 34 | + |
|
| 35 | + |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * a boolean flag to set whether the current route is a cpt route or not. |
|
| 39 | + * |
|
| 40 | + * @var bool |
|
| 41 | + */ |
|
| 42 | + protected $_cpt_route = false; |
|
| 43 | + |
|
| 44 | + |
|
| 45 | + |
|
| 46 | + /** |
|
| 47 | + * This property allows cpt classes to define multiple routes as cpt routes. |
|
| 48 | + * //in this array we define what the custom post type for this route is. |
|
| 49 | + * array( |
|
| 50 | + * 'route_name' => 'custom_post_type_slug' |
|
| 51 | + * ) |
|
| 52 | + * |
|
| 53 | + * @var array |
|
| 54 | + */ |
|
| 55 | + protected $_cpt_routes = array(); |
|
| 56 | + |
|
| 57 | 57 | |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update. |
|
| 61 | - * in this format: |
|
| 62 | - * array( |
|
| 63 | - * 'post_type_slug' => 'edit_route' |
|
| 64 | - * ) |
|
| 65 | - * |
|
| 66 | - * @var array |
|
| 67 | - */ |
|
| 68 | - protected $_cpt_edit_routes = array(); |
|
| 69 | - |
|
| 70 | - |
|
| 71 | - |
|
| 72 | - /** |
|
| 73 | - * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will |
|
| 74 | - * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the |
|
| 75 | - * _cpt_model_names property should be in the following format: array( |
|
| 76 | - * 'route_defined_by_action_param' => 'Model_Name') |
|
| 77 | - * |
|
| 78 | - * @var array $_cpt_model_names |
|
| 79 | - */ |
|
| 80 | - protected $_cpt_model_names = array(); |
|
| 81 | - |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * @var EE_CPT_Base |
|
| 85 | - */ |
|
| 86 | - protected $_cpt_model_obj = false; |
|
| 87 | - |
|
| 88 | - |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP |
|
| 92 | - * autosave so we can save our inputs on the save_post hook! Children classes should add to this array by using |
|
| 93 | - * the _register_autosave_containers() method so that we don't override any other containers already registered. |
|
| 94 | - * Registration of containers should be done before load_page_dependencies() is run. |
|
| 95 | - * |
|
| 96 | - * @var array() |
|
| 97 | - */ |
|
| 98 | - protected $_autosave_containers = array(); |
|
| 99 | - protected $_autosave_fields = array(); |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits |
|
| 103 | - * a page for an action, it will appear as if they were visiting the wp core page for that custom post type |
|
| 104 | - * |
|
| 105 | - * @var array |
|
| 106 | - */ |
|
| 107 | - protected $_pagenow_map = null; |
|
| 108 | - |
|
| 109 | - |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been |
|
| 113 | - * saved. Child classes are required to declare this method. Typically you would use this to save any additional |
|
| 114 | - * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important. When a |
|
| 115 | - * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data |
|
| 116 | - * containing any extra info you may have from other meta saves. So MAKE sure that you handle this accordingly. |
|
| 117 | - * |
|
| 118 | - * @access protected |
|
| 119 | - * @abstract |
|
| 120 | - * @param string $post_id The ID of the cpt that was saved (so you can link relationally) |
|
| 121 | - * @param object $post The post object of the cpt that was saved. |
|
| 122 | - * @return void |
|
| 123 | - */ |
|
| 124 | - abstract protected function _insert_update_cpt_item($post_id, $post); |
|
| 125 | - |
|
| 126 | - |
|
| 127 | - |
|
| 128 | - /** |
|
| 129 | - * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed. |
|
| 130 | - * |
|
| 131 | - * @abstract |
|
| 132 | - * @access public |
|
| 133 | - * @param string $post_id The ID of the cpt that was trashed |
|
| 134 | - * @return void |
|
| 135 | - */ |
|
| 136 | - abstract public function trash_cpt_item($post_id); |
|
| 137 | - |
|
| 138 | - |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed |
|
| 142 | - * |
|
| 143 | - * @param string $post_id theID of the cpt that was untrashed |
|
| 144 | - * @return void |
|
| 145 | - */ |
|
| 146 | - abstract public function restore_cpt_item($post_id); |
|
| 147 | - |
|
| 148 | - |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted |
|
| 152 | - * from the db |
|
| 153 | - * |
|
| 154 | - * @param string $post_id the ID of the cpt that was deleted |
|
| 155 | - * @return void |
|
| 156 | - */ |
|
| 157 | - abstract public function delete_cpt_item($post_id); |
|
| 158 | - |
|
| 159 | - |
|
| 160 | - |
|
| 161 | - /** |
|
| 162 | - * Just utilizing the method EE_Admin exposes for doing things before page setup. |
|
| 163 | - * |
|
| 164 | - * @access protected |
|
| 165 | - * @return void |
|
| 166 | - */ |
|
| 167 | - protected function _before_page_setup() |
|
| 168 | - { |
|
| 169 | - $page = isset($this->_req_data['page']) ? $this->_req_data['page'] : $this->page_slug; |
|
| 170 | - $this->_cpt_routes = array_merge(array( |
|
| 171 | - 'create_new' => $this->page_slug, |
|
| 172 | - 'edit' => $this->page_slug, |
|
| 173 | - 'trash' => $this->page_slug, |
|
| 174 | - ), $this->_cpt_routes); |
|
| 175 | - //let's see if the current route has a value for cpt_object_slug if it does we use that instead of the page |
|
| 176 | - $this->_cpt_object = isset($this->_req_data['action']) && isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 177 | - ? get_post_type_object($this->_cpt_routes[$this->_req_data['action']]) |
|
| 178 | - : get_post_type_object($page); |
|
| 179 | - //tweak pagenow for page loading. |
|
| 180 | - if ( ! $this->_pagenow_map) { |
|
| 181 | - $this->_pagenow_map = array( |
|
| 182 | - 'create_new' => 'post-new.php', |
|
| 183 | - 'edit' => 'post.php', |
|
| 184 | - 'trash' => 'post.php', |
|
| 185 | - ); |
|
| 186 | - } |
|
| 187 | - add_action('current_screen', array($this, 'modify_pagenow')); |
|
| 188 | - //TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param. |
|
| 189 | - //get current page from autosave |
|
| 190 | - $current_page = isset($this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page']) |
|
| 191 | - ? $this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page'] |
|
| 192 | - : null; |
|
| 193 | - $this->_current_page = isset($this->_req_data['current_page']) |
|
| 194 | - ? $this->_req_data['current_page'] |
|
| 195 | - : $current_page; |
|
| 196 | - //autosave... make sure its only for the correct page |
|
| 197 | - if ( ! empty($this->_current_page) && $this->_current_page == $this->page_slug) { |
|
| 198 | - //setup autosave ajax hook |
|
| 199 | - //add_action('wp_ajax_ee-autosave', array( $this, 'do_extra_autosave_stuff' ), 10 ); //TODO reactivate when 4.2 autosave is implemented |
|
| 200 | - } |
|
| 201 | - } |
|
| 202 | - |
|
| 203 | - |
|
| 204 | - |
|
| 205 | - /** |
|
| 206 | - * Simply ensure that we simulate the correct post route for cpt screens |
|
| 207 | - * |
|
| 208 | - * @param WP_Screen $current_screen |
|
| 209 | - * @return void |
|
| 210 | - */ |
|
| 211 | - public function modify_pagenow($current_screen) |
|
| 212 | - { |
|
| 213 | - global $pagenow, $hook_suffix; |
|
| 214 | - //possibly reset pagenow. |
|
| 215 | - if ( ! empty($this->_req_data['page']) |
|
| 216 | - && $this->_req_data['page'] == $this->page_slug |
|
| 217 | - && ! empty($this->_req_data['action']) |
|
| 218 | - && isset($this->_pagenow_map[$this->_req_data['action']]) |
|
| 219 | - ) { |
|
| 220 | - $pagenow = $this->_pagenow_map[$this->_req_data['action']]; |
|
| 221 | - $hook_suffix = $pagenow; |
|
| 222 | - } |
|
| 223 | - } |
|
| 224 | - |
|
| 225 | - |
|
| 226 | - |
|
| 227 | - /** |
|
| 228 | - * This method is used to register additional autosave containers to the _autosave_containers property. |
|
| 229 | - * |
|
| 230 | - * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we |
|
| 231 | - * automatically register the id for the post metabox as a container. |
|
| 232 | - * @param array $ids an array of ids for containers that hold form inputs we want autosave to pickup. Typically |
|
| 233 | - * you would send along the id of a metabox container. |
|
| 234 | - * @return void |
|
| 235 | - */ |
|
| 236 | - protected function _register_autosave_containers($ids) |
|
| 237 | - { |
|
| 238 | - $this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids); |
|
| 239 | - } |
|
| 240 | - |
|
| 241 | - |
|
| 242 | - |
|
| 243 | - /** |
|
| 244 | - * Something nifty. We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of |
|
| 245 | - * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array. |
|
| 246 | - */ |
|
| 247 | - protected function _set_autosave_containers() |
|
| 248 | - { |
|
| 249 | - global $wp_meta_boxes; |
|
| 250 | - $containers = array(); |
|
| 251 | - if (empty($wp_meta_boxes)) { |
|
| 252 | - return; |
|
| 253 | - } |
|
| 254 | - $current_metaboxes = isset($wp_meta_boxes[$this->page_slug]) ? $wp_meta_boxes[$this->page_slug] : array(); |
|
| 255 | - foreach ($current_metaboxes as $box_context) { |
|
| 256 | - foreach ($box_context as $box_details) { |
|
| 257 | - foreach ($box_details as $box) { |
|
| 258 | - if (is_array($box['callback']) |
|
| 259 | - && ($box['callback'][0] instanceof EE_Admin_Page |
|
| 260 | - || $box['callback'][0] instanceof EE_Admin_Hooks) |
|
| 261 | - ) { |
|
| 262 | - $containers[] = $box['id']; |
|
| 263 | - } |
|
| 264 | - } |
|
| 265 | - } |
|
| 266 | - } |
|
| 267 | - $this->_autosave_containers = array_merge($this->_autosave_containers, $containers); |
|
| 268 | - //add hidden inputs container |
|
| 269 | - $this->_autosave_containers[] = 'ee-cpt-hidden-inputs'; |
|
| 270 | - } |
|
| 271 | - |
|
| 272 | - |
|
| 273 | - |
|
| 274 | - protected function _load_autosave_scripts_styles() |
|
| 275 | - { |
|
| 276 | - /*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE ); |
|
| 59 | + /** |
|
| 60 | + * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update. |
|
| 61 | + * in this format: |
|
| 62 | + * array( |
|
| 63 | + * 'post_type_slug' => 'edit_route' |
|
| 64 | + * ) |
|
| 65 | + * |
|
| 66 | + * @var array |
|
| 67 | + */ |
|
| 68 | + protected $_cpt_edit_routes = array(); |
|
| 69 | + |
|
| 70 | + |
|
| 71 | + |
|
| 72 | + /** |
|
| 73 | + * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will |
|
| 74 | + * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the |
|
| 75 | + * _cpt_model_names property should be in the following format: array( |
|
| 76 | + * 'route_defined_by_action_param' => 'Model_Name') |
|
| 77 | + * |
|
| 78 | + * @var array $_cpt_model_names |
|
| 79 | + */ |
|
| 80 | + protected $_cpt_model_names = array(); |
|
| 81 | + |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * @var EE_CPT_Base |
|
| 85 | + */ |
|
| 86 | + protected $_cpt_model_obj = false; |
|
| 87 | + |
|
| 88 | + |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP |
|
| 92 | + * autosave so we can save our inputs on the save_post hook! Children classes should add to this array by using |
|
| 93 | + * the _register_autosave_containers() method so that we don't override any other containers already registered. |
|
| 94 | + * Registration of containers should be done before load_page_dependencies() is run. |
|
| 95 | + * |
|
| 96 | + * @var array() |
|
| 97 | + */ |
|
| 98 | + protected $_autosave_containers = array(); |
|
| 99 | + protected $_autosave_fields = array(); |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits |
|
| 103 | + * a page for an action, it will appear as if they were visiting the wp core page for that custom post type |
|
| 104 | + * |
|
| 105 | + * @var array |
|
| 106 | + */ |
|
| 107 | + protected $_pagenow_map = null; |
|
| 108 | + |
|
| 109 | + |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been |
|
| 113 | + * saved. Child classes are required to declare this method. Typically you would use this to save any additional |
|
| 114 | + * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important. When a |
|
| 115 | + * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data |
|
| 116 | + * containing any extra info you may have from other meta saves. So MAKE sure that you handle this accordingly. |
|
| 117 | + * |
|
| 118 | + * @access protected |
|
| 119 | + * @abstract |
|
| 120 | + * @param string $post_id The ID of the cpt that was saved (so you can link relationally) |
|
| 121 | + * @param object $post The post object of the cpt that was saved. |
|
| 122 | + * @return void |
|
| 123 | + */ |
|
| 124 | + abstract protected function _insert_update_cpt_item($post_id, $post); |
|
| 125 | + |
|
| 126 | + |
|
| 127 | + |
|
| 128 | + /** |
|
| 129 | + * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed. |
|
| 130 | + * |
|
| 131 | + * @abstract |
|
| 132 | + * @access public |
|
| 133 | + * @param string $post_id The ID of the cpt that was trashed |
|
| 134 | + * @return void |
|
| 135 | + */ |
|
| 136 | + abstract public function trash_cpt_item($post_id); |
|
| 137 | + |
|
| 138 | + |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed |
|
| 142 | + * |
|
| 143 | + * @param string $post_id theID of the cpt that was untrashed |
|
| 144 | + * @return void |
|
| 145 | + */ |
|
| 146 | + abstract public function restore_cpt_item($post_id); |
|
| 147 | + |
|
| 148 | + |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted |
|
| 152 | + * from the db |
|
| 153 | + * |
|
| 154 | + * @param string $post_id the ID of the cpt that was deleted |
|
| 155 | + * @return void |
|
| 156 | + */ |
|
| 157 | + abstract public function delete_cpt_item($post_id); |
|
| 158 | + |
|
| 159 | + |
|
| 160 | + |
|
| 161 | + /** |
|
| 162 | + * Just utilizing the method EE_Admin exposes for doing things before page setup. |
|
| 163 | + * |
|
| 164 | + * @access protected |
|
| 165 | + * @return void |
|
| 166 | + */ |
|
| 167 | + protected function _before_page_setup() |
|
| 168 | + { |
|
| 169 | + $page = isset($this->_req_data['page']) ? $this->_req_data['page'] : $this->page_slug; |
|
| 170 | + $this->_cpt_routes = array_merge(array( |
|
| 171 | + 'create_new' => $this->page_slug, |
|
| 172 | + 'edit' => $this->page_slug, |
|
| 173 | + 'trash' => $this->page_slug, |
|
| 174 | + ), $this->_cpt_routes); |
|
| 175 | + //let's see if the current route has a value for cpt_object_slug if it does we use that instead of the page |
|
| 176 | + $this->_cpt_object = isset($this->_req_data['action']) && isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 177 | + ? get_post_type_object($this->_cpt_routes[$this->_req_data['action']]) |
|
| 178 | + : get_post_type_object($page); |
|
| 179 | + //tweak pagenow for page loading. |
|
| 180 | + if ( ! $this->_pagenow_map) { |
|
| 181 | + $this->_pagenow_map = array( |
|
| 182 | + 'create_new' => 'post-new.php', |
|
| 183 | + 'edit' => 'post.php', |
|
| 184 | + 'trash' => 'post.php', |
|
| 185 | + ); |
|
| 186 | + } |
|
| 187 | + add_action('current_screen', array($this, 'modify_pagenow')); |
|
| 188 | + //TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param. |
|
| 189 | + //get current page from autosave |
|
| 190 | + $current_page = isset($this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page']) |
|
| 191 | + ? $this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page'] |
|
| 192 | + : null; |
|
| 193 | + $this->_current_page = isset($this->_req_data['current_page']) |
|
| 194 | + ? $this->_req_data['current_page'] |
|
| 195 | + : $current_page; |
|
| 196 | + //autosave... make sure its only for the correct page |
|
| 197 | + if ( ! empty($this->_current_page) && $this->_current_page == $this->page_slug) { |
|
| 198 | + //setup autosave ajax hook |
|
| 199 | + //add_action('wp_ajax_ee-autosave', array( $this, 'do_extra_autosave_stuff' ), 10 ); //TODO reactivate when 4.2 autosave is implemented |
|
| 200 | + } |
|
| 201 | + } |
|
| 202 | + |
|
| 203 | + |
|
| 204 | + |
|
| 205 | + /** |
|
| 206 | + * Simply ensure that we simulate the correct post route for cpt screens |
|
| 207 | + * |
|
| 208 | + * @param WP_Screen $current_screen |
|
| 209 | + * @return void |
|
| 210 | + */ |
|
| 211 | + public function modify_pagenow($current_screen) |
|
| 212 | + { |
|
| 213 | + global $pagenow, $hook_suffix; |
|
| 214 | + //possibly reset pagenow. |
|
| 215 | + if ( ! empty($this->_req_data['page']) |
|
| 216 | + && $this->_req_data['page'] == $this->page_slug |
|
| 217 | + && ! empty($this->_req_data['action']) |
|
| 218 | + && isset($this->_pagenow_map[$this->_req_data['action']]) |
|
| 219 | + ) { |
|
| 220 | + $pagenow = $this->_pagenow_map[$this->_req_data['action']]; |
|
| 221 | + $hook_suffix = $pagenow; |
|
| 222 | + } |
|
| 223 | + } |
|
| 224 | + |
|
| 225 | + |
|
| 226 | + |
|
| 227 | + /** |
|
| 228 | + * This method is used to register additional autosave containers to the _autosave_containers property. |
|
| 229 | + * |
|
| 230 | + * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we |
|
| 231 | + * automatically register the id for the post metabox as a container. |
|
| 232 | + * @param array $ids an array of ids for containers that hold form inputs we want autosave to pickup. Typically |
|
| 233 | + * you would send along the id of a metabox container. |
|
| 234 | + * @return void |
|
| 235 | + */ |
|
| 236 | + protected function _register_autosave_containers($ids) |
|
| 237 | + { |
|
| 238 | + $this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids); |
|
| 239 | + } |
|
| 240 | + |
|
| 241 | + |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * Something nifty. We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of |
|
| 245 | + * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array. |
|
| 246 | + */ |
|
| 247 | + protected function _set_autosave_containers() |
|
| 248 | + { |
|
| 249 | + global $wp_meta_boxes; |
|
| 250 | + $containers = array(); |
|
| 251 | + if (empty($wp_meta_boxes)) { |
|
| 252 | + return; |
|
| 253 | + } |
|
| 254 | + $current_metaboxes = isset($wp_meta_boxes[$this->page_slug]) ? $wp_meta_boxes[$this->page_slug] : array(); |
|
| 255 | + foreach ($current_metaboxes as $box_context) { |
|
| 256 | + foreach ($box_context as $box_details) { |
|
| 257 | + foreach ($box_details as $box) { |
|
| 258 | + if (is_array($box['callback']) |
|
| 259 | + && ($box['callback'][0] instanceof EE_Admin_Page |
|
| 260 | + || $box['callback'][0] instanceof EE_Admin_Hooks) |
|
| 261 | + ) { |
|
| 262 | + $containers[] = $box['id']; |
|
| 263 | + } |
|
| 264 | + } |
|
| 265 | + } |
|
| 266 | + } |
|
| 267 | + $this->_autosave_containers = array_merge($this->_autosave_containers, $containers); |
|
| 268 | + //add hidden inputs container |
|
| 269 | + $this->_autosave_containers[] = 'ee-cpt-hidden-inputs'; |
|
| 270 | + } |
|
| 271 | + |
|
| 272 | + |
|
| 273 | + |
|
| 274 | + protected function _load_autosave_scripts_styles() |
|
| 275 | + { |
|
| 276 | + /*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE ); |
|
| 277 | 277 | wp_enqueue_script('cpt-autosave');/**/ //todo re-enable when we start doing autosave again in 4.2 |
| 278 | 278 | |
| 279 | - //filter _autosave_containers |
|
| 280 | - $containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers', |
|
| 281 | - $this->_autosave_containers, $this); |
|
| 282 | - $containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers', |
|
| 283 | - $containers, $this); |
|
| 284 | - |
|
| 285 | - wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS', |
|
| 286 | - $containers); //todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave" |
|
| 287 | - |
|
| 288 | - $unsaved_data_msg = array( |
|
| 289 | - 'eventmsg' => sprintf(__("The changes you made to this %s will be lost if you navigate away from this page.", |
|
| 290 | - 'event_espresso'), $this->_cpt_object->labels->singular_name), |
|
| 291 | - 'inputChanged' => 0, |
|
| 292 | - ); |
|
| 293 | - wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg); |
|
| 294 | - } |
|
| 295 | - |
|
| 296 | - |
|
| 297 | - |
|
| 298 | - public function load_page_dependencies() |
|
| 299 | - { |
|
| 300 | - try { |
|
| 301 | - $this->_load_page_dependencies(); |
|
| 302 | - } catch (EE_Error $e) { |
|
| 303 | - $e->get_error(); |
|
| 304 | - } |
|
| 305 | - } |
|
| 306 | - |
|
| 307 | - |
|
| 308 | - |
|
| 309 | - /** |
|
| 310 | - * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately |
|
| 311 | - * |
|
| 312 | - * @access protected |
|
| 313 | - * @return void |
|
| 314 | - */ |
|
| 315 | - protected function _load_page_dependencies() |
|
| 316 | - { |
|
| 317 | - //we only add stuff if this is a cpt_route! |
|
| 318 | - if ( ! $this->_cpt_route) { |
|
| 319 | - parent::_load_page_dependencies(); |
|
| 320 | - return; |
|
| 321 | - } |
|
| 322 | - //now let's do some automatic filters into the wp_system and we'll check to make sure the CHILD class automatically has the required methods in place. |
|
| 323 | - //the following filters are for setting all the redirects on DEFAULT WP custom post type actions |
|
| 324 | - //let's add a hidden input to the post-edit form so we know when we have to trigger our custom redirects! Otherwise the redirects will happen on ALL post saves which wouldn't be good of course! |
|
| 325 | - add_action('edit_form_after_title', array($this, 'cpt_post_form_hidden_input')); |
|
| 326 | - //inject our Admin page nav tabs... |
|
| 327 | - //let's make sure the nav tabs are set if they aren't already |
|
| 328 | - //if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs(); |
|
| 329 | - add_action('post_edit_form_tag', array($this, 'inject_nav_tabs')); |
|
| 330 | - //modify the post_updated messages array |
|
| 331 | - add_action('post_updated_messages', array($this, 'post_update_messages'), 10); |
|
| 332 | - //add shortlink button to cpt edit screens. We can do this as a universal thing BECAUSE, cpts use the same format for shortlinks as posts! |
|
| 333 | - add_filter('pre_get_shortlink', array($this, 'add_shortlink_button_to_editor'), 10, 4); |
|
| 334 | - //This basically allows us to change the title of the "publish" metabox area on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class. |
|
| 335 | - if ( ! empty($this->_labels['publishbox'])) { |
|
| 336 | - $box_label = is_array($this->_labels['publishbox']) |
|
| 337 | - && isset($this->_labels['publishbox'][$this->_req_action]) |
|
| 338 | - ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox']; |
|
| 339 | - remove_meta_box('submitdiv', __('Publish'), 'post_submit_meta_box', $this->_cpt_routes[$this->_req_action], |
|
| 340 | - 'side', 'core'); |
|
| 341 | - add_meta_box('submitdiv', $box_label, 'post_submit_meta_box', $this->_cpt_routes[$this->_req_action], |
|
| 342 | - 'side', 'core'); |
|
| 343 | - } |
|
| 344 | - //let's add page_templates metabox if this cpt added support for it. |
|
| 345 | - if ($this->_supports_page_templates($this->_cpt_object->name)) { |
|
| 346 | - add_meta_box('page_templates', __('Page Template', 'event_espresso'), |
|
| 347 | - array($this, 'page_template_meta_box'), $this->_cpt_routes[$this->_req_action], 'side', 'default'); |
|
| 348 | - } |
|
| 349 | - //this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form |
|
| 350 | - if (method_exists($this, 'extra_permalink_field_buttons')) { |
|
| 351 | - add_filter('get_sample_permalink_html', array($this, 'extra_permalink_field_buttons'), 10, 4); |
|
| 352 | - } |
|
| 353 | - //add preview button |
|
| 354 | - add_filter('get_sample_permalink_html', array($this, 'preview_button_html'), 5, 4); |
|
| 355 | - //insert our own post_stati dropdown |
|
| 356 | - add_action('post_submitbox_misc_actions', array($this, 'custom_post_stati_dropdown'), 10); |
|
| 357 | - //This allows adding additional information to the publish post submitbox on the wp post edit form |
|
| 358 | - if (method_exists($this, 'extra_misc_actions_publish_box')) { |
|
| 359 | - add_action('post_submitbox_misc_actions', array($this, 'extra_misc_actions_publish_box'), 10); |
|
| 360 | - } |
|
| 361 | - //This allows for adding additional stuff after the title field on the wp post edit form. This is also before the wp_editor for post description field. |
|
| 362 | - if (method_exists($this, 'edit_form_after_title')) { |
|
| 363 | - add_action('edit_form_after_title', array($this, 'edit_form_after_title'), 10); |
|
| 364 | - } |
|
| 365 | - /** |
|
| 366 | - * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route. |
|
| 367 | - */ |
|
| 368 | - add_filter('clean_url', array($this, 'switch_core_wp_urls_with_ours'), 10, 3); |
|
| 369 | - parent::_load_page_dependencies(); |
|
| 370 | - //notice we are ALSO going to load the pagenow hook set for this route (see _before_page_setup for the reset of the pagenow global ). This is for any plugins that are doing things properly and hooking into the load page hook for core wp cpt routes. |
|
| 371 | - global $pagenow; |
|
| 372 | - do_action('load-' . $pagenow); |
|
| 373 | - $this->modify_current_screen(); |
|
| 374 | - add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30); |
|
| 375 | - //we route REALLY early. |
|
| 376 | - try { |
|
| 377 | - $this->_route_admin_request(); |
|
| 378 | - } catch (EE_Error $e) { |
|
| 379 | - $e->get_error(); |
|
| 380 | - } |
|
| 381 | - } |
|
| 382 | - |
|
| 383 | - |
|
| 384 | - |
|
| 385 | - /** |
|
| 386 | - * Since we don't want users going to default core wp routes, this will check any wp urls run through the |
|
| 387 | - * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR |
|
| 388 | - * route instead. |
|
| 389 | - * |
|
| 390 | - * @param string $good_protocol_url The escaped url. |
|
| 391 | - * @param string $original_url The original url. |
|
| 392 | - * @param string $_context The context sendt to the esc_url method. |
|
| 393 | - * @return string possibly a new url for our route. |
|
| 394 | - */ |
|
| 395 | - public function switch_core_wp_urls_with_ours($good_protocol_url, $original_url, $_context) |
|
| 396 | - { |
|
| 397 | - $routes_to_match = array( |
|
| 398 | - 0 => array( |
|
| 399 | - 'edit.php?post_type=espresso_attendees', |
|
| 400 | - 'admin.php?page=espresso_registrations&action=contact_list', |
|
| 401 | - ), |
|
| 402 | - 1 => array( |
|
| 403 | - 'edit.php?post_type=' . $this->_cpt_object->name, |
|
| 404 | - 'admin.php?page=' . $this->_cpt_object->name, |
|
| 405 | - ), |
|
| 406 | - ); |
|
| 407 | - foreach ($routes_to_match as $route_matches) { |
|
| 408 | - if (strpos($good_protocol_url, $route_matches[0]) !== false) { |
|
| 409 | - return str_replace($route_matches[0], $route_matches[1], $good_protocol_url); |
|
| 410 | - } |
|
| 411 | - } |
|
| 412 | - return $good_protocol_url; |
|
| 413 | - } |
|
| 414 | - |
|
| 415 | - |
|
| 416 | - |
|
| 417 | - /** |
|
| 418 | - * Determine whether the current cpt supports page templates or not. |
|
| 419 | - * |
|
| 420 | - * @since %VER% |
|
| 421 | - * @param string $cpt_name The cpt slug we're checking on. |
|
| 422 | - * @return bool True supported, false not. |
|
| 423 | - */ |
|
| 424 | - private function _supports_page_templates($cpt_name) |
|
| 425 | - { |
|
| 426 | - |
|
| 427 | - $cpt_args = EE_Register_CPTs::get_CPTs(); |
|
| 428 | - $cpt_args = isset($cpt_args[$cpt_name]) ? $cpt_args[$cpt_name]['args'] : array(); |
|
| 429 | - $cpt_has_support = ! empty($cpt_args['page_templates']); |
|
| 430 | - |
|
| 431 | - //if the installed version of WP is > 4.7 we do some additional checks. |
|
| 432 | - if (EE_Recommended_Versions::check_wp_version('4.7','>=')) { |
|
| 433 | - $post_templates = wp_get_theme()->get_post_templates(); |
|
| 434 | - //if there are $post_templates for this cpt, then we return false for this method because |
|
| 435 | - //that means we aren't going to load our page template manager and leave that up to the native |
|
| 436 | - //cpt template manager. |
|
| 437 | - $cpt_has_support = ! isset($post_templates[$cpt_name]) ? $cpt_has_support : false; |
|
| 438 | - } |
|
| 439 | - |
|
| 440 | - return $cpt_has_support; |
|
| 441 | - } |
|
| 442 | - |
|
| 443 | - |
|
| 444 | - /** |
|
| 445 | - * Callback for the page_templates metabox selector. |
|
| 446 | - * |
|
| 447 | - * @since %VER% |
|
| 448 | - * @return string html |
|
| 449 | - */ |
|
| 450 | - public function page_template_meta_box() |
|
| 451 | - { |
|
| 452 | - global $post; |
|
| 453 | - $template = ''; |
|
| 454 | - |
|
| 455 | - if (EE_Recommended_Versions::check_wp_version('4.7','>=')) { |
|
| 456 | - $page_template_count = count(get_page_templates()); |
|
| 457 | - } else { |
|
| 458 | - $page_template_count = count(get_page_templates($post)); |
|
| 459 | - }; |
|
| 460 | - |
|
| 461 | - if ($page_template_count) { |
|
| 462 | - $page_template = get_post_meta($post->ID, '_wp_page_template', true); |
|
| 463 | - $template = ! empty($page_template) ? $page_template : ''; |
|
| 464 | - } |
|
| 465 | - ?> |
|
| 279 | + //filter _autosave_containers |
|
| 280 | + $containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers', |
|
| 281 | + $this->_autosave_containers, $this); |
|
| 282 | + $containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers', |
|
| 283 | + $containers, $this); |
|
| 284 | + |
|
| 285 | + wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS', |
|
| 286 | + $containers); //todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave" |
|
| 287 | + |
|
| 288 | + $unsaved_data_msg = array( |
|
| 289 | + 'eventmsg' => sprintf(__("The changes you made to this %s will be lost if you navigate away from this page.", |
|
| 290 | + 'event_espresso'), $this->_cpt_object->labels->singular_name), |
|
| 291 | + 'inputChanged' => 0, |
|
| 292 | + ); |
|
| 293 | + wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg); |
|
| 294 | + } |
|
| 295 | + |
|
| 296 | + |
|
| 297 | + |
|
| 298 | + public function load_page_dependencies() |
|
| 299 | + { |
|
| 300 | + try { |
|
| 301 | + $this->_load_page_dependencies(); |
|
| 302 | + } catch (EE_Error $e) { |
|
| 303 | + $e->get_error(); |
|
| 304 | + } |
|
| 305 | + } |
|
| 306 | + |
|
| 307 | + |
|
| 308 | + |
|
| 309 | + /** |
|
| 310 | + * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately |
|
| 311 | + * |
|
| 312 | + * @access protected |
|
| 313 | + * @return void |
|
| 314 | + */ |
|
| 315 | + protected function _load_page_dependencies() |
|
| 316 | + { |
|
| 317 | + //we only add stuff if this is a cpt_route! |
|
| 318 | + if ( ! $this->_cpt_route) { |
|
| 319 | + parent::_load_page_dependencies(); |
|
| 320 | + return; |
|
| 321 | + } |
|
| 322 | + //now let's do some automatic filters into the wp_system and we'll check to make sure the CHILD class automatically has the required methods in place. |
|
| 323 | + //the following filters are for setting all the redirects on DEFAULT WP custom post type actions |
|
| 324 | + //let's add a hidden input to the post-edit form so we know when we have to trigger our custom redirects! Otherwise the redirects will happen on ALL post saves which wouldn't be good of course! |
|
| 325 | + add_action('edit_form_after_title', array($this, 'cpt_post_form_hidden_input')); |
|
| 326 | + //inject our Admin page nav tabs... |
|
| 327 | + //let's make sure the nav tabs are set if they aren't already |
|
| 328 | + //if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs(); |
|
| 329 | + add_action('post_edit_form_tag', array($this, 'inject_nav_tabs')); |
|
| 330 | + //modify the post_updated messages array |
|
| 331 | + add_action('post_updated_messages', array($this, 'post_update_messages'), 10); |
|
| 332 | + //add shortlink button to cpt edit screens. We can do this as a universal thing BECAUSE, cpts use the same format for shortlinks as posts! |
|
| 333 | + add_filter('pre_get_shortlink', array($this, 'add_shortlink_button_to_editor'), 10, 4); |
|
| 334 | + //This basically allows us to change the title of the "publish" metabox area on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class. |
|
| 335 | + if ( ! empty($this->_labels['publishbox'])) { |
|
| 336 | + $box_label = is_array($this->_labels['publishbox']) |
|
| 337 | + && isset($this->_labels['publishbox'][$this->_req_action]) |
|
| 338 | + ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox']; |
|
| 339 | + remove_meta_box('submitdiv', __('Publish'), 'post_submit_meta_box', $this->_cpt_routes[$this->_req_action], |
|
| 340 | + 'side', 'core'); |
|
| 341 | + add_meta_box('submitdiv', $box_label, 'post_submit_meta_box', $this->_cpt_routes[$this->_req_action], |
|
| 342 | + 'side', 'core'); |
|
| 343 | + } |
|
| 344 | + //let's add page_templates metabox if this cpt added support for it. |
|
| 345 | + if ($this->_supports_page_templates($this->_cpt_object->name)) { |
|
| 346 | + add_meta_box('page_templates', __('Page Template', 'event_espresso'), |
|
| 347 | + array($this, 'page_template_meta_box'), $this->_cpt_routes[$this->_req_action], 'side', 'default'); |
|
| 348 | + } |
|
| 349 | + //this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form |
|
| 350 | + if (method_exists($this, 'extra_permalink_field_buttons')) { |
|
| 351 | + add_filter('get_sample_permalink_html', array($this, 'extra_permalink_field_buttons'), 10, 4); |
|
| 352 | + } |
|
| 353 | + //add preview button |
|
| 354 | + add_filter('get_sample_permalink_html', array($this, 'preview_button_html'), 5, 4); |
|
| 355 | + //insert our own post_stati dropdown |
|
| 356 | + add_action('post_submitbox_misc_actions', array($this, 'custom_post_stati_dropdown'), 10); |
|
| 357 | + //This allows adding additional information to the publish post submitbox on the wp post edit form |
|
| 358 | + if (method_exists($this, 'extra_misc_actions_publish_box')) { |
|
| 359 | + add_action('post_submitbox_misc_actions', array($this, 'extra_misc_actions_publish_box'), 10); |
|
| 360 | + } |
|
| 361 | + //This allows for adding additional stuff after the title field on the wp post edit form. This is also before the wp_editor for post description field. |
|
| 362 | + if (method_exists($this, 'edit_form_after_title')) { |
|
| 363 | + add_action('edit_form_after_title', array($this, 'edit_form_after_title'), 10); |
|
| 364 | + } |
|
| 365 | + /** |
|
| 366 | + * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route. |
|
| 367 | + */ |
|
| 368 | + add_filter('clean_url', array($this, 'switch_core_wp_urls_with_ours'), 10, 3); |
|
| 369 | + parent::_load_page_dependencies(); |
|
| 370 | + //notice we are ALSO going to load the pagenow hook set for this route (see _before_page_setup for the reset of the pagenow global ). This is for any plugins that are doing things properly and hooking into the load page hook for core wp cpt routes. |
|
| 371 | + global $pagenow; |
|
| 372 | + do_action('load-' . $pagenow); |
|
| 373 | + $this->modify_current_screen(); |
|
| 374 | + add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30); |
|
| 375 | + //we route REALLY early. |
|
| 376 | + try { |
|
| 377 | + $this->_route_admin_request(); |
|
| 378 | + } catch (EE_Error $e) { |
|
| 379 | + $e->get_error(); |
|
| 380 | + } |
|
| 381 | + } |
|
| 382 | + |
|
| 383 | + |
|
| 384 | + |
|
| 385 | + /** |
|
| 386 | + * Since we don't want users going to default core wp routes, this will check any wp urls run through the |
|
| 387 | + * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR |
|
| 388 | + * route instead. |
|
| 389 | + * |
|
| 390 | + * @param string $good_protocol_url The escaped url. |
|
| 391 | + * @param string $original_url The original url. |
|
| 392 | + * @param string $_context The context sendt to the esc_url method. |
|
| 393 | + * @return string possibly a new url for our route. |
|
| 394 | + */ |
|
| 395 | + public function switch_core_wp_urls_with_ours($good_protocol_url, $original_url, $_context) |
|
| 396 | + { |
|
| 397 | + $routes_to_match = array( |
|
| 398 | + 0 => array( |
|
| 399 | + 'edit.php?post_type=espresso_attendees', |
|
| 400 | + 'admin.php?page=espresso_registrations&action=contact_list', |
|
| 401 | + ), |
|
| 402 | + 1 => array( |
|
| 403 | + 'edit.php?post_type=' . $this->_cpt_object->name, |
|
| 404 | + 'admin.php?page=' . $this->_cpt_object->name, |
|
| 405 | + ), |
|
| 406 | + ); |
|
| 407 | + foreach ($routes_to_match as $route_matches) { |
|
| 408 | + if (strpos($good_protocol_url, $route_matches[0]) !== false) { |
|
| 409 | + return str_replace($route_matches[0], $route_matches[1], $good_protocol_url); |
|
| 410 | + } |
|
| 411 | + } |
|
| 412 | + return $good_protocol_url; |
|
| 413 | + } |
|
| 414 | + |
|
| 415 | + |
|
| 416 | + |
|
| 417 | + /** |
|
| 418 | + * Determine whether the current cpt supports page templates or not. |
|
| 419 | + * |
|
| 420 | + * @since %VER% |
|
| 421 | + * @param string $cpt_name The cpt slug we're checking on. |
|
| 422 | + * @return bool True supported, false not. |
|
| 423 | + */ |
|
| 424 | + private function _supports_page_templates($cpt_name) |
|
| 425 | + { |
|
| 426 | + |
|
| 427 | + $cpt_args = EE_Register_CPTs::get_CPTs(); |
|
| 428 | + $cpt_args = isset($cpt_args[$cpt_name]) ? $cpt_args[$cpt_name]['args'] : array(); |
|
| 429 | + $cpt_has_support = ! empty($cpt_args['page_templates']); |
|
| 430 | + |
|
| 431 | + //if the installed version of WP is > 4.7 we do some additional checks. |
|
| 432 | + if (EE_Recommended_Versions::check_wp_version('4.7','>=')) { |
|
| 433 | + $post_templates = wp_get_theme()->get_post_templates(); |
|
| 434 | + //if there are $post_templates for this cpt, then we return false for this method because |
|
| 435 | + //that means we aren't going to load our page template manager and leave that up to the native |
|
| 436 | + //cpt template manager. |
|
| 437 | + $cpt_has_support = ! isset($post_templates[$cpt_name]) ? $cpt_has_support : false; |
|
| 438 | + } |
|
| 439 | + |
|
| 440 | + return $cpt_has_support; |
|
| 441 | + } |
|
| 442 | + |
|
| 443 | + |
|
| 444 | + /** |
|
| 445 | + * Callback for the page_templates metabox selector. |
|
| 446 | + * |
|
| 447 | + * @since %VER% |
|
| 448 | + * @return string html |
|
| 449 | + */ |
|
| 450 | + public function page_template_meta_box() |
|
| 451 | + { |
|
| 452 | + global $post; |
|
| 453 | + $template = ''; |
|
| 454 | + |
|
| 455 | + if (EE_Recommended_Versions::check_wp_version('4.7','>=')) { |
|
| 456 | + $page_template_count = count(get_page_templates()); |
|
| 457 | + } else { |
|
| 458 | + $page_template_count = count(get_page_templates($post)); |
|
| 459 | + }; |
|
| 460 | + |
|
| 461 | + if ($page_template_count) { |
|
| 462 | + $page_template = get_post_meta($post->ID, '_wp_page_template', true); |
|
| 463 | + $template = ! empty($page_template) ? $page_template : ''; |
|
| 464 | + } |
|
| 465 | + ?> |
|
| 466 | 466 | <p><strong><?php _e('Template') ?></strong></p> |
| 467 | 467 | <label class="screen-reader-text" for="page_template"><?php _e('Page Template') ?></label><select |
| 468 | 468 | name="page_template" id="page_template"> |
@@ -470,435 +470,435 @@ discard block |
||
| 470 | 470 | <?php page_template_dropdown($template); ?> |
| 471 | 471 | </select> |
| 472 | 472 | <?php |
| 473 | - } |
|
| 474 | - |
|
| 475 | - |
|
| 476 | - |
|
| 477 | - /** |
|
| 478 | - * if this post is a draft or scheduled post then we provide a preview button for user to click |
|
| 479 | - * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter. |
|
| 480 | - * |
|
| 481 | - * @param string $return the current html |
|
| 482 | - * @param int $id the post id for the page |
|
| 483 | - * @param string $new_title What the title is |
|
| 484 | - * @param string $new_slug what the slug is |
|
| 485 | - * @return string The new html string for the permalink area |
|
| 486 | - */ |
|
| 487 | - public function preview_button_html($return, $id, $new_title, $new_slug) |
|
| 488 | - { |
|
| 489 | - $post = get_post($id); |
|
| 490 | - if ('publish' != get_post_status($post)) { |
|
| 491 | - //include shims for the `get_preview_post_link` function |
|
| 492 | - require_once( EE_CORE . 'wordpress-shims.php' ); |
|
| 493 | - $return .= '<span_id="view-post-btn"><a target="_blank" href="' |
|
| 494 | - . get_preview_post_link($id) |
|
| 495 | - . '" class="button button-small">' |
|
| 496 | - . __('Preview', 'event_espresso') |
|
| 497 | - . '</a></span>' |
|
| 498 | - . "\n"; |
|
| 499 | - } |
|
| 500 | - return $return; |
|
| 501 | - } |
|
| 502 | - |
|
| 503 | - |
|
| 504 | - |
|
| 505 | - /** |
|
| 506 | - * add our custom post stati dropdown on the wp post page for this cpt |
|
| 507 | - * |
|
| 508 | - * @return string html for dropdown |
|
| 509 | - */ |
|
| 510 | - public function custom_post_stati_dropdown() |
|
| 511 | - { |
|
| 512 | - |
|
| 513 | - $statuses = $this->_cpt_model_obj->get_custom_post_statuses(); |
|
| 514 | - $cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses) |
|
| 515 | - ? $statuses[$this->_cpt_model_obj->status()] |
|
| 516 | - : ''; |
|
| 517 | - $template_args = array( |
|
| 518 | - 'cur_status' => $this->_cpt_model_obj->status(), |
|
| 519 | - 'statuses' => $statuses, |
|
| 520 | - 'cur_status_label' => $cur_status_label, |
|
| 521 | - 'localized_status_save' => sprintf(__('Save %s', 'event_espresso'), $cur_status_label), |
|
| 522 | - ); |
|
| 523 | - //we'll add a trash post status (WP doesn't add one for some reason) |
|
| 524 | - if ($this->_cpt_model_obj->status() == 'trash') { |
|
| 525 | - $template_args['cur_status_label'] = __('Trashed', 'event_espresso'); |
|
| 526 | - $statuses['trash'] = __('Trashed', 'event_espresso'); |
|
| 527 | - $template_args['statuses'] = $statuses; |
|
| 528 | - } |
|
| 529 | - |
|
| 530 | - $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php'; |
|
| 531 | - EEH_Template::display_template($template, $template_args); |
|
| 532 | - } |
|
| 533 | - |
|
| 534 | - |
|
| 535 | - |
|
| 536 | - public function setup_autosave_hooks() |
|
| 537 | - { |
|
| 538 | - $this->_set_autosave_containers(); |
|
| 539 | - $this->_load_autosave_scripts_styles(); |
|
| 540 | - } |
|
| 541 | - |
|
| 542 | - |
|
| 543 | - |
|
| 544 | - /** |
|
| 545 | - * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a $_POST object (available |
|
| 546 | - * in $this->_req_data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check |
|
| 547 | - * for the nonce in here, but then this method looks for two things: |
|
| 548 | - * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR |
|
| 549 | - * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an |
|
| 550 | - * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the |
|
| 551 | - * $_template_args property should be used to hold the $data array. We're expecting the following things set in |
|
| 552 | - * template args. |
|
| 553 | - * 1. $template_args['error'] = IF there is an error you can add the message in here. |
|
| 554 | - * 2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go' |
|
| 555 | - * => 'values_to_add'. In other words, for the datetime metabox we'll have something like |
|
| 556 | - * $this->_template_args['data']['items'] = array( |
|
| 557 | - * 'event-datetime-ids' => '1,2,3'; |
|
| 558 | - * ); |
|
| 559 | - * Keep in mind the following things: |
|
| 560 | - * - "where" index is for the input with the id as that string. |
|
| 561 | - * - "what" index is what will be used for the value of that input. |
|
| 562 | - * |
|
| 563 | - * @return void |
|
| 564 | - */ |
|
| 565 | - public function do_extra_autosave_stuff() |
|
| 566 | - { |
|
| 567 | - //next let's check for the autosave nonce (we'll use _verify_nonce ) |
|
| 568 | - $nonce = isset($this->_req_data['autosavenonce']) ? $this->_req_data['autosavenonce'] : null; |
|
| 569 | - $this->_verify_nonce($nonce, 'autosave'); |
|
| 570 | - //make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it) |
|
| 571 | - if ( ! defined('DOING_AUTOSAVE')) { |
|
| 572 | - define('DOING_AUTOSAVE', true); |
|
| 573 | - } |
|
| 574 | - //if we made it here then the nonce checked out. Let's run our methods and actions |
|
| 575 | - if (method_exists($this, '_ee_autosave_' . $this->_current_view)) { |
|
| 576 | - call_user_func(array($this, '_ee_autosave_' . $this->_current_view)); |
|
| 577 | - } else { |
|
| 578 | - $this->_template_args['success'] = true; |
|
| 579 | - } |
|
| 580 | - do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this); |
|
| 581 | - do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this); |
|
| 582 | - //now let's return json |
|
| 583 | - $this->_return_json(); |
|
| 584 | - } |
|
| 585 | - |
|
| 586 | - |
|
| 587 | - |
|
| 588 | - /** |
|
| 589 | - * This takes care of setting up default routes and pages that utilize the core WP admin pages. |
|
| 590 | - * Child classes can override the defaults (in cases for adding metaboxes etc.) |
|
| 591 | - * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work! |
|
| 592 | - * |
|
| 593 | - * @access protected |
|
| 594 | - * @throws EE_Error |
|
| 595 | - * @return void |
|
| 596 | - */ |
|
| 597 | - protected function _extend_page_config_for_cpt() |
|
| 598 | - { |
|
| 599 | - //before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug |
|
| 600 | - if ((isset($this->_req_data['page']) && $this->_req_data['page'] != $this->page_slug)) { |
|
| 601 | - return; |
|
| 602 | - } |
|
| 603 | - //set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes |
|
| 604 | - if ( ! empty($this->_cpt_object)) { |
|
| 605 | - $this->_page_routes = array_merge(array( |
|
| 606 | - 'create_new' => '_create_new_cpt_item', |
|
| 607 | - 'edit' => '_edit_cpt_item', |
|
| 608 | - ), $this->_page_routes); |
|
| 609 | - $this->_page_config = array_merge(array( |
|
| 610 | - 'create_new' => array( |
|
| 611 | - 'nav' => array( |
|
| 612 | - 'label' => $this->_cpt_object->labels->add_new_item, |
|
| 613 | - 'order' => 5, |
|
| 614 | - ), |
|
| 615 | - 'require_nonce' => false, |
|
| 616 | - ), |
|
| 617 | - 'edit' => array( |
|
| 618 | - 'nav' => array( |
|
| 619 | - 'label' => $this->_cpt_object->labels->edit_item, |
|
| 620 | - 'order' => 5, |
|
| 621 | - 'persistent' => false, |
|
| 622 | - 'url' => '', |
|
| 623 | - ), |
|
| 624 | - 'require_nonce' => false, |
|
| 625 | - ), |
|
| 626 | - ), |
|
| 627 | - $this->_page_config |
|
| 628 | - ); |
|
| 629 | - } |
|
| 630 | - //load the next section only if this is a matching cpt route as set in the cpt routes array. |
|
| 631 | - if ( ! isset($this->_cpt_routes[$this->_req_action])) { |
|
| 632 | - return; |
|
| 633 | - } |
|
| 634 | - $this->_cpt_route = isset($this->_cpt_routes[$this->_req_action]) ? true : false; |
|
| 635 | - //add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') ); |
|
| 636 | - if (empty($this->_cpt_object)) { |
|
| 637 | - $msg = sprintf(__('This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this: 1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).'), |
|
| 638 | - $this->page_slug, $this->_req_action, get_class($this)); |
|
| 639 | - throw new EE_Error($msg); |
|
| 640 | - } |
|
| 641 | - if ($this->_cpt_route) { |
|
| 642 | - $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null; |
|
| 643 | - $this->_set_model_object($id); |
|
| 644 | - } |
|
| 645 | - } |
|
| 646 | - |
|
| 647 | - |
|
| 648 | - |
|
| 649 | - /** |
|
| 650 | - * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id. |
|
| 651 | - * |
|
| 652 | - * @access protected |
|
| 653 | - * @param int $id The id to retrieve the model object for. If empty we set a default object. |
|
| 654 | - * @param bool $ignore_route_check |
|
| 655 | - */ |
|
| 656 | - protected function _set_model_object($id = null, $ignore_route_check = false) |
|
| 657 | - { |
|
| 658 | - $model = null; |
|
| 659 | - if ( |
|
| 660 | - empty($this->_cpt_model_names) |
|
| 661 | - || ( |
|
| 662 | - ! $ignore_route_check |
|
| 663 | - && ! isset($this->_cpt_routes[$this->_req_action]) |
|
| 664 | - ) || ( |
|
| 665 | - $this->_cpt_model_obj instanceof EE_CPT_Base |
|
| 666 | - && $this->_cpt_model_obj->ID() === $id |
|
| 667 | - ) |
|
| 668 | - ) { |
|
| 669 | - //get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent. |
|
| 670 | - return; |
|
| 671 | - } |
|
| 672 | - //if ignore_route_check is true, then get the model name via EE_Register_CPTs |
|
| 673 | - if ($ignore_route_check) { |
|
| 674 | - $model_names = EE_Register_CPTs::get_cpt_model_names(); |
|
| 675 | - $post_type = get_post_type($id); |
|
| 676 | - if (isset($model_names[$post_type])) { |
|
| 677 | - $model = EE_Registry::instance()->load_model($model_names[$post_type]); |
|
| 678 | - } |
|
| 679 | - } else { |
|
| 680 | - $model = EE_Registry::instance()->load_model($this->_cpt_model_names[$this->_req_action]); |
|
| 681 | - } |
|
| 682 | - if ($model instanceof EEM_Base) { |
|
| 683 | - $this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object(); |
|
| 684 | - } |
|
| 685 | - do_action('AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object'); |
|
| 686 | - } |
|
| 687 | - |
|
| 688 | - |
|
| 689 | - |
|
| 690 | - /** |
|
| 691 | - * admin_init_global |
|
| 692 | - * This runs all the code that we want executed within the WP admin_init hook. |
|
| 693 | - * This method executes for ALL EE Admin pages. |
|
| 694 | - * |
|
| 695 | - * @access public |
|
| 696 | - * @return void |
|
| 697 | - */ |
|
| 698 | - public function admin_init_global() |
|
| 699 | - { |
|
| 700 | - $post = isset($this->_req_data['post']) ? get_post($this->_req_data['post']) : null; |
|
| 701 | - //its possible this is a new save so let's catch that instead |
|
| 702 | - $post = isset($this->_req_data['post_ID']) ? get_post($this->_req_data['post_ID']) : $post; |
|
| 703 | - $post_type = $post ? $post->post_type : false; |
|
| 704 | - $current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route'] |
|
| 705 | - : 'shouldneverwork'; |
|
| 706 | - $route_to_check = $post_type && isset($this->_cpt_routes[$current_route]) ? $this->_cpt_routes[$current_route] |
|
| 707 | - : ''; |
|
| 708 | - add_filter('get_delete_post_link', array($this, 'modify_delete_post_link'), 10, 3); |
|
| 709 | - add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 3); |
|
| 710 | - if ($post_type === $route_to_check) { |
|
| 711 | - add_filter('redirect_post_location', array($this, 'cpt_post_location_redirect'), 10, 2); |
|
| 712 | - } |
|
| 713 | - //now let's filter redirect if we're on a revision page and the revision is for an event CPT. |
|
| 714 | - $revision = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null; |
|
| 715 | - if ( ! empty($revision)) { |
|
| 716 | - $action = isset($this->_req_data['action']) ? $this->_req_data['action'] : null; |
|
| 717 | - //doing a restore? |
|
| 718 | - if ( ! empty($action) && $action == 'restore') { |
|
| 719 | - //get post for revision |
|
| 720 | - $rev_post = get_post($revision); |
|
| 721 | - $rev_parent = get_post($rev_post->post_parent); |
|
| 722 | - //only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts. |
|
| 723 | - if ($rev_parent && $rev_parent->post_type == $this->page_slug) { |
|
| 724 | - add_filter('wp_redirect', array($this, 'revision_redirect'), 10, 2); |
|
| 725 | - //restores of revisions |
|
| 726 | - add_action('wp_restore_post_revision', array($this, 'restore_revision'), 10, 2); |
|
| 727 | - } |
|
| 728 | - } |
|
| 729 | - } |
|
| 730 | - //NOTE we ONLY want to run these hooks if we're on the right class for the given post type. Otherwise we could see some really freaky things happen! |
|
| 731 | - if ($post_type && $post_type === $route_to_check) { |
|
| 732 | - //$post_id, $post |
|
| 733 | - add_action('save_post', array($this, 'insert_update'), 10, 3); |
|
| 734 | - //$post_id |
|
| 735 | - add_action('trashed_post', array($this, 'before_trash_cpt_item'), 10); |
|
| 736 | - add_action('trashed_post', array($this, 'dont_permanently_delete_ee_cpts'), 10); |
|
| 737 | - add_action('untrashed_post', array($this, 'before_restore_cpt_item'), 10); |
|
| 738 | - add_action('after_delete_post', array($this, 'before_delete_cpt_item'), 10); |
|
| 739 | - } |
|
| 740 | - } |
|
| 741 | - |
|
| 742 | - |
|
| 743 | - |
|
| 744 | - /** |
|
| 745 | - * Callback for the WordPress trashed_post hook. |
|
| 746 | - * Execute some basic checks before calling the trash_cpt_item declared in the child class. |
|
| 747 | - * |
|
| 748 | - * @param int $post_id |
|
| 749 | - */ |
|
| 750 | - public function before_trash_cpt_item($post_id) |
|
| 751 | - { |
|
| 752 | - $this->_set_model_object($post_id, true); |
|
| 753 | - //if our cpt object isn't existent then get out immediately. |
|
| 754 | - if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) { |
|
| 755 | - return; |
|
| 756 | - } |
|
| 757 | - $this->trash_cpt_item($post_id); |
|
| 758 | - } |
|
| 759 | - |
|
| 760 | - |
|
| 761 | - |
|
| 762 | - /** |
|
| 763 | - * Callback for the WordPress untrashed_post hook. |
|
| 764 | - * Execute some basic checks before calling the restore_cpt_method in the child class. |
|
| 765 | - * |
|
| 766 | - * @param $post_id |
|
| 767 | - */ |
|
| 768 | - public function before_restore_cpt_item($post_id) |
|
| 769 | - { |
|
| 770 | - $this->_set_model_object($post_id, true); |
|
| 771 | - //if our cpt object isn't existent then get out immediately. |
|
| 772 | - if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) { |
|
| 773 | - return; |
|
| 774 | - } |
|
| 775 | - $this->restore_cpt_item($post_id); |
|
| 776 | - } |
|
| 777 | - |
|
| 778 | - |
|
| 779 | - |
|
| 780 | - /** |
|
| 781 | - * Callback for the WordPress after_delete_post hook. |
|
| 782 | - * Execute some basic checks before calling the delete_cpt_item method in the child class. |
|
| 783 | - * |
|
| 784 | - * @param $post_id |
|
| 785 | - */ |
|
| 786 | - public function before_delete_cpt_item($post_id) |
|
| 787 | - { |
|
| 788 | - $this->_set_model_object($post_id, true); |
|
| 789 | - //if our cpt object isn't existent then get out immediately. |
|
| 790 | - if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) { |
|
| 791 | - return; |
|
| 792 | - } |
|
| 793 | - $this->delete_cpt_item($post_id); |
|
| 794 | - } |
|
| 795 | - |
|
| 796 | - |
|
| 797 | - |
|
| 798 | - /** |
|
| 799 | - * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message |
|
| 800 | - * accordingly. |
|
| 801 | - * |
|
| 802 | - * @access public |
|
| 803 | - * @throws EE_Error |
|
| 804 | - * @return void |
|
| 805 | - */ |
|
| 806 | - public function verify_cpt_object() |
|
| 807 | - { |
|
| 808 | - $label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label; |
|
| 809 | - // verify event object |
|
| 810 | - if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) { |
|
| 811 | - throw new EE_Error(sprintf(__('Something has gone wrong with the page load because we are unable to set up the object for the %1$s. This usually happens when the given id for the page route is NOT for the correct custom post type for this page', |
|
| 812 | - 'event_espresso'), $label)); |
|
| 813 | - } |
|
| 814 | - //if auto-draft then throw an error |
|
| 815 | - if ($this->_cpt_model_obj->get('status') == 'auto-draft') { |
|
| 816 | - EE_Error::overwrite_errors(); |
|
| 817 | - EE_Error::add_error(sprintf(__('This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly. All autodrafts will show up in the "draft" view of your event list table. You can delete them from there. Please click the "Add %1$s" button to refresh and restart.'), |
|
| 818 | - $label), __FILE__, __FUNCTION__, __LINE__); |
|
| 819 | - } |
|
| 820 | - } |
|
| 821 | - |
|
| 822 | - |
|
| 823 | - |
|
| 824 | - /** |
|
| 825 | - * admin_footer_scripts_global |
|
| 826 | - * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method |
|
| 827 | - * will apply on ALL EE_Admin pages. |
|
| 828 | - * |
|
| 829 | - * @access public |
|
| 830 | - * @return void |
|
| 831 | - */ |
|
| 832 | - public function admin_footer_scripts_global() |
|
| 833 | - { |
|
| 834 | - $this->_add_admin_page_ajax_loading_img(); |
|
| 835 | - $this->_add_admin_page_overlay(); |
|
| 836 | - } |
|
| 837 | - |
|
| 838 | - |
|
| 839 | - |
|
| 840 | - /** |
|
| 841 | - * add in any global scripts for cpt routes |
|
| 842 | - * |
|
| 843 | - * @return void |
|
| 844 | - */ |
|
| 845 | - public function load_global_scripts_styles() |
|
| 846 | - { |
|
| 847 | - parent::load_global_scripts_styles(); |
|
| 848 | - if ($this->_cpt_model_obj instanceof EE_CPT_Base) { |
|
| 849 | - //setup custom post status object for localize script but only if we've got a cpt object |
|
| 850 | - $statuses = $this->_cpt_model_obj->get_custom_post_statuses(); |
|
| 851 | - if ( ! empty($statuses)) { |
|
| 852 | - //get ALL statuses! |
|
| 853 | - $statuses = $this->_cpt_model_obj->get_all_post_statuses(); |
|
| 854 | - //setup object |
|
| 855 | - $ee_cpt_statuses = array(); |
|
| 856 | - foreach ($statuses as $status => $label) { |
|
| 857 | - $ee_cpt_statuses[$status] = array( |
|
| 858 | - 'label' => $label, |
|
| 859 | - 'save_label' => sprintf(__('Save as %s', 'event_espresso'), $label), |
|
| 860 | - ); |
|
| 861 | - } |
|
| 862 | - wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses); |
|
| 863 | - } |
|
| 864 | - } |
|
| 865 | - } |
|
| 866 | - |
|
| 867 | - |
|
| 868 | - |
|
| 869 | - /** |
|
| 870 | - * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL |
|
| 871 | - * insert/updates |
|
| 872 | - * |
|
| 873 | - * @param int $post_id ID of post being updated |
|
| 874 | - * @param WP_Post $post Post object from WP |
|
| 875 | - * @param bool $update Whether this is an update or a new save. |
|
| 876 | - * @return void |
|
| 877 | - */ |
|
| 878 | - public function insert_update($post_id, $post, $update) |
|
| 879 | - { |
|
| 880 | - //make sure that if this is a revision OR trash action that we don't do any updates! |
|
| 881 | - if ( |
|
| 882 | - isset($this->_req_data['action']) |
|
| 883 | - && ( |
|
| 884 | - $this->_req_data['action'] == 'restore' |
|
| 885 | - || $this->_req_data['action'] == 'trash' |
|
| 886 | - ) |
|
| 887 | - ) { |
|
| 888 | - return; |
|
| 889 | - } |
|
| 890 | - $this->_set_model_object($post_id, true); |
|
| 891 | - //if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit. |
|
| 892 | - if ($update |
|
| 893 | - && ( |
|
| 894 | - ! $this->_cpt_model_obj instanceof EE_CPT_Base |
|
| 895 | - || $this->_cpt_model_obj->ID() !== $post_id |
|
| 896 | - ) |
|
| 897 | - ) { |
|
| 898 | - return; |
|
| 899 | - } |
|
| 900 | - //check for autosave and update our req_data property accordingly. |
|
| 901 | - /*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) { |
|
| 473 | + } |
|
| 474 | + |
|
| 475 | + |
|
| 476 | + |
|
| 477 | + /** |
|
| 478 | + * if this post is a draft or scheduled post then we provide a preview button for user to click |
|
| 479 | + * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter. |
|
| 480 | + * |
|
| 481 | + * @param string $return the current html |
|
| 482 | + * @param int $id the post id for the page |
|
| 483 | + * @param string $new_title What the title is |
|
| 484 | + * @param string $new_slug what the slug is |
|
| 485 | + * @return string The new html string for the permalink area |
|
| 486 | + */ |
|
| 487 | + public function preview_button_html($return, $id, $new_title, $new_slug) |
|
| 488 | + { |
|
| 489 | + $post = get_post($id); |
|
| 490 | + if ('publish' != get_post_status($post)) { |
|
| 491 | + //include shims for the `get_preview_post_link` function |
|
| 492 | + require_once( EE_CORE . 'wordpress-shims.php' ); |
|
| 493 | + $return .= '<span_id="view-post-btn"><a target="_blank" href="' |
|
| 494 | + . get_preview_post_link($id) |
|
| 495 | + . '" class="button button-small">' |
|
| 496 | + . __('Preview', 'event_espresso') |
|
| 497 | + . '</a></span>' |
|
| 498 | + . "\n"; |
|
| 499 | + } |
|
| 500 | + return $return; |
|
| 501 | + } |
|
| 502 | + |
|
| 503 | + |
|
| 504 | + |
|
| 505 | + /** |
|
| 506 | + * add our custom post stati dropdown on the wp post page for this cpt |
|
| 507 | + * |
|
| 508 | + * @return string html for dropdown |
|
| 509 | + */ |
|
| 510 | + public function custom_post_stati_dropdown() |
|
| 511 | + { |
|
| 512 | + |
|
| 513 | + $statuses = $this->_cpt_model_obj->get_custom_post_statuses(); |
|
| 514 | + $cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses) |
|
| 515 | + ? $statuses[$this->_cpt_model_obj->status()] |
|
| 516 | + : ''; |
|
| 517 | + $template_args = array( |
|
| 518 | + 'cur_status' => $this->_cpt_model_obj->status(), |
|
| 519 | + 'statuses' => $statuses, |
|
| 520 | + 'cur_status_label' => $cur_status_label, |
|
| 521 | + 'localized_status_save' => sprintf(__('Save %s', 'event_espresso'), $cur_status_label), |
|
| 522 | + ); |
|
| 523 | + //we'll add a trash post status (WP doesn't add one for some reason) |
|
| 524 | + if ($this->_cpt_model_obj->status() == 'trash') { |
|
| 525 | + $template_args['cur_status_label'] = __('Trashed', 'event_espresso'); |
|
| 526 | + $statuses['trash'] = __('Trashed', 'event_espresso'); |
|
| 527 | + $template_args['statuses'] = $statuses; |
|
| 528 | + } |
|
| 529 | + |
|
| 530 | + $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php'; |
|
| 531 | + EEH_Template::display_template($template, $template_args); |
|
| 532 | + } |
|
| 533 | + |
|
| 534 | + |
|
| 535 | + |
|
| 536 | + public function setup_autosave_hooks() |
|
| 537 | + { |
|
| 538 | + $this->_set_autosave_containers(); |
|
| 539 | + $this->_load_autosave_scripts_styles(); |
|
| 540 | + } |
|
| 541 | + |
|
| 542 | + |
|
| 543 | + |
|
| 544 | + /** |
|
| 545 | + * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a $_POST object (available |
|
| 546 | + * in $this->_req_data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check |
|
| 547 | + * for the nonce in here, but then this method looks for two things: |
|
| 548 | + * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR |
|
| 549 | + * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an |
|
| 550 | + * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the |
|
| 551 | + * $_template_args property should be used to hold the $data array. We're expecting the following things set in |
|
| 552 | + * template args. |
|
| 553 | + * 1. $template_args['error'] = IF there is an error you can add the message in here. |
|
| 554 | + * 2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go' |
|
| 555 | + * => 'values_to_add'. In other words, for the datetime metabox we'll have something like |
|
| 556 | + * $this->_template_args['data']['items'] = array( |
|
| 557 | + * 'event-datetime-ids' => '1,2,3'; |
|
| 558 | + * ); |
|
| 559 | + * Keep in mind the following things: |
|
| 560 | + * - "where" index is for the input with the id as that string. |
|
| 561 | + * - "what" index is what will be used for the value of that input. |
|
| 562 | + * |
|
| 563 | + * @return void |
|
| 564 | + */ |
|
| 565 | + public function do_extra_autosave_stuff() |
|
| 566 | + { |
|
| 567 | + //next let's check for the autosave nonce (we'll use _verify_nonce ) |
|
| 568 | + $nonce = isset($this->_req_data['autosavenonce']) ? $this->_req_data['autosavenonce'] : null; |
|
| 569 | + $this->_verify_nonce($nonce, 'autosave'); |
|
| 570 | + //make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it) |
|
| 571 | + if ( ! defined('DOING_AUTOSAVE')) { |
|
| 572 | + define('DOING_AUTOSAVE', true); |
|
| 573 | + } |
|
| 574 | + //if we made it here then the nonce checked out. Let's run our methods and actions |
|
| 575 | + if (method_exists($this, '_ee_autosave_' . $this->_current_view)) { |
|
| 576 | + call_user_func(array($this, '_ee_autosave_' . $this->_current_view)); |
|
| 577 | + } else { |
|
| 578 | + $this->_template_args['success'] = true; |
|
| 579 | + } |
|
| 580 | + do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this); |
|
| 581 | + do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this); |
|
| 582 | + //now let's return json |
|
| 583 | + $this->_return_json(); |
|
| 584 | + } |
|
| 585 | + |
|
| 586 | + |
|
| 587 | + |
|
| 588 | + /** |
|
| 589 | + * This takes care of setting up default routes and pages that utilize the core WP admin pages. |
|
| 590 | + * Child classes can override the defaults (in cases for adding metaboxes etc.) |
|
| 591 | + * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work! |
|
| 592 | + * |
|
| 593 | + * @access protected |
|
| 594 | + * @throws EE_Error |
|
| 595 | + * @return void |
|
| 596 | + */ |
|
| 597 | + protected function _extend_page_config_for_cpt() |
|
| 598 | + { |
|
| 599 | + //before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug |
|
| 600 | + if ((isset($this->_req_data['page']) && $this->_req_data['page'] != $this->page_slug)) { |
|
| 601 | + return; |
|
| 602 | + } |
|
| 603 | + //set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes |
|
| 604 | + if ( ! empty($this->_cpt_object)) { |
|
| 605 | + $this->_page_routes = array_merge(array( |
|
| 606 | + 'create_new' => '_create_new_cpt_item', |
|
| 607 | + 'edit' => '_edit_cpt_item', |
|
| 608 | + ), $this->_page_routes); |
|
| 609 | + $this->_page_config = array_merge(array( |
|
| 610 | + 'create_new' => array( |
|
| 611 | + 'nav' => array( |
|
| 612 | + 'label' => $this->_cpt_object->labels->add_new_item, |
|
| 613 | + 'order' => 5, |
|
| 614 | + ), |
|
| 615 | + 'require_nonce' => false, |
|
| 616 | + ), |
|
| 617 | + 'edit' => array( |
|
| 618 | + 'nav' => array( |
|
| 619 | + 'label' => $this->_cpt_object->labels->edit_item, |
|
| 620 | + 'order' => 5, |
|
| 621 | + 'persistent' => false, |
|
| 622 | + 'url' => '', |
|
| 623 | + ), |
|
| 624 | + 'require_nonce' => false, |
|
| 625 | + ), |
|
| 626 | + ), |
|
| 627 | + $this->_page_config |
|
| 628 | + ); |
|
| 629 | + } |
|
| 630 | + //load the next section only if this is a matching cpt route as set in the cpt routes array. |
|
| 631 | + if ( ! isset($this->_cpt_routes[$this->_req_action])) { |
|
| 632 | + return; |
|
| 633 | + } |
|
| 634 | + $this->_cpt_route = isset($this->_cpt_routes[$this->_req_action]) ? true : false; |
|
| 635 | + //add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') ); |
|
| 636 | + if (empty($this->_cpt_object)) { |
|
| 637 | + $msg = sprintf(__('This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this: 1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).'), |
|
| 638 | + $this->page_slug, $this->_req_action, get_class($this)); |
|
| 639 | + throw new EE_Error($msg); |
|
| 640 | + } |
|
| 641 | + if ($this->_cpt_route) { |
|
| 642 | + $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null; |
|
| 643 | + $this->_set_model_object($id); |
|
| 644 | + } |
|
| 645 | + } |
|
| 646 | + |
|
| 647 | + |
|
| 648 | + |
|
| 649 | + /** |
|
| 650 | + * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id. |
|
| 651 | + * |
|
| 652 | + * @access protected |
|
| 653 | + * @param int $id The id to retrieve the model object for. If empty we set a default object. |
|
| 654 | + * @param bool $ignore_route_check |
|
| 655 | + */ |
|
| 656 | + protected function _set_model_object($id = null, $ignore_route_check = false) |
|
| 657 | + { |
|
| 658 | + $model = null; |
|
| 659 | + if ( |
|
| 660 | + empty($this->_cpt_model_names) |
|
| 661 | + || ( |
|
| 662 | + ! $ignore_route_check |
|
| 663 | + && ! isset($this->_cpt_routes[$this->_req_action]) |
|
| 664 | + ) || ( |
|
| 665 | + $this->_cpt_model_obj instanceof EE_CPT_Base |
|
| 666 | + && $this->_cpt_model_obj->ID() === $id |
|
| 667 | + ) |
|
| 668 | + ) { |
|
| 669 | + //get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent. |
|
| 670 | + return; |
|
| 671 | + } |
|
| 672 | + //if ignore_route_check is true, then get the model name via EE_Register_CPTs |
|
| 673 | + if ($ignore_route_check) { |
|
| 674 | + $model_names = EE_Register_CPTs::get_cpt_model_names(); |
|
| 675 | + $post_type = get_post_type($id); |
|
| 676 | + if (isset($model_names[$post_type])) { |
|
| 677 | + $model = EE_Registry::instance()->load_model($model_names[$post_type]); |
|
| 678 | + } |
|
| 679 | + } else { |
|
| 680 | + $model = EE_Registry::instance()->load_model($this->_cpt_model_names[$this->_req_action]); |
|
| 681 | + } |
|
| 682 | + if ($model instanceof EEM_Base) { |
|
| 683 | + $this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object(); |
|
| 684 | + } |
|
| 685 | + do_action('AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object'); |
|
| 686 | + } |
|
| 687 | + |
|
| 688 | + |
|
| 689 | + |
|
| 690 | + /** |
|
| 691 | + * admin_init_global |
|
| 692 | + * This runs all the code that we want executed within the WP admin_init hook. |
|
| 693 | + * This method executes for ALL EE Admin pages. |
|
| 694 | + * |
|
| 695 | + * @access public |
|
| 696 | + * @return void |
|
| 697 | + */ |
|
| 698 | + public function admin_init_global() |
|
| 699 | + { |
|
| 700 | + $post = isset($this->_req_data['post']) ? get_post($this->_req_data['post']) : null; |
|
| 701 | + //its possible this is a new save so let's catch that instead |
|
| 702 | + $post = isset($this->_req_data['post_ID']) ? get_post($this->_req_data['post_ID']) : $post; |
|
| 703 | + $post_type = $post ? $post->post_type : false; |
|
| 704 | + $current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route'] |
|
| 705 | + : 'shouldneverwork'; |
|
| 706 | + $route_to_check = $post_type && isset($this->_cpt_routes[$current_route]) ? $this->_cpt_routes[$current_route] |
|
| 707 | + : ''; |
|
| 708 | + add_filter('get_delete_post_link', array($this, 'modify_delete_post_link'), 10, 3); |
|
| 709 | + add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 3); |
|
| 710 | + if ($post_type === $route_to_check) { |
|
| 711 | + add_filter('redirect_post_location', array($this, 'cpt_post_location_redirect'), 10, 2); |
|
| 712 | + } |
|
| 713 | + //now let's filter redirect if we're on a revision page and the revision is for an event CPT. |
|
| 714 | + $revision = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null; |
|
| 715 | + if ( ! empty($revision)) { |
|
| 716 | + $action = isset($this->_req_data['action']) ? $this->_req_data['action'] : null; |
|
| 717 | + //doing a restore? |
|
| 718 | + if ( ! empty($action) && $action == 'restore') { |
|
| 719 | + //get post for revision |
|
| 720 | + $rev_post = get_post($revision); |
|
| 721 | + $rev_parent = get_post($rev_post->post_parent); |
|
| 722 | + //only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts. |
|
| 723 | + if ($rev_parent && $rev_parent->post_type == $this->page_slug) { |
|
| 724 | + add_filter('wp_redirect', array($this, 'revision_redirect'), 10, 2); |
|
| 725 | + //restores of revisions |
|
| 726 | + add_action('wp_restore_post_revision', array($this, 'restore_revision'), 10, 2); |
|
| 727 | + } |
|
| 728 | + } |
|
| 729 | + } |
|
| 730 | + //NOTE we ONLY want to run these hooks if we're on the right class for the given post type. Otherwise we could see some really freaky things happen! |
|
| 731 | + if ($post_type && $post_type === $route_to_check) { |
|
| 732 | + //$post_id, $post |
|
| 733 | + add_action('save_post', array($this, 'insert_update'), 10, 3); |
|
| 734 | + //$post_id |
|
| 735 | + add_action('trashed_post', array($this, 'before_trash_cpt_item'), 10); |
|
| 736 | + add_action('trashed_post', array($this, 'dont_permanently_delete_ee_cpts'), 10); |
|
| 737 | + add_action('untrashed_post', array($this, 'before_restore_cpt_item'), 10); |
|
| 738 | + add_action('after_delete_post', array($this, 'before_delete_cpt_item'), 10); |
|
| 739 | + } |
|
| 740 | + } |
|
| 741 | + |
|
| 742 | + |
|
| 743 | + |
|
| 744 | + /** |
|
| 745 | + * Callback for the WordPress trashed_post hook. |
|
| 746 | + * Execute some basic checks before calling the trash_cpt_item declared in the child class. |
|
| 747 | + * |
|
| 748 | + * @param int $post_id |
|
| 749 | + */ |
|
| 750 | + public function before_trash_cpt_item($post_id) |
|
| 751 | + { |
|
| 752 | + $this->_set_model_object($post_id, true); |
|
| 753 | + //if our cpt object isn't existent then get out immediately. |
|
| 754 | + if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) { |
|
| 755 | + return; |
|
| 756 | + } |
|
| 757 | + $this->trash_cpt_item($post_id); |
|
| 758 | + } |
|
| 759 | + |
|
| 760 | + |
|
| 761 | + |
|
| 762 | + /** |
|
| 763 | + * Callback for the WordPress untrashed_post hook. |
|
| 764 | + * Execute some basic checks before calling the restore_cpt_method in the child class. |
|
| 765 | + * |
|
| 766 | + * @param $post_id |
|
| 767 | + */ |
|
| 768 | + public function before_restore_cpt_item($post_id) |
|
| 769 | + { |
|
| 770 | + $this->_set_model_object($post_id, true); |
|
| 771 | + //if our cpt object isn't existent then get out immediately. |
|
| 772 | + if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) { |
|
| 773 | + return; |
|
| 774 | + } |
|
| 775 | + $this->restore_cpt_item($post_id); |
|
| 776 | + } |
|
| 777 | + |
|
| 778 | + |
|
| 779 | + |
|
| 780 | + /** |
|
| 781 | + * Callback for the WordPress after_delete_post hook. |
|
| 782 | + * Execute some basic checks before calling the delete_cpt_item method in the child class. |
|
| 783 | + * |
|
| 784 | + * @param $post_id |
|
| 785 | + */ |
|
| 786 | + public function before_delete_cpt_item($post_id) |
|
| 787 | + { |
|
| 788 | + $this->_set_model_object($post_id, true); |
|
| 789 | + //if our cpt object isn't existent then get out immediately. |
|
| 790 | + if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) { |
|
| 791 | + return; |
|
| 792 | + } |
|
| 793 | + $this->delete_cpt_item($post_id); |
|
| 794 | + } |
|
| 795 | + |
|
| 796 | + |
|
| 797 | + |
|
| 798 | + /** |
|
| 799 | + * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message |
|
| 800 | + * accordingly. |
|
| 801 | + * |
|
| 802 | + * @access public |
|
| 803 | + * @throws EE_Error |
|
| 804 | + * @return void |
|
| 805 | + */ |
|
| 806 | + public function verify_cpt_object() |
|
| 807 | + { |
|
| 808 | + $label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label; |
|
| 809 | + // verify event object |
|
| 810 | + if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) { |
|
| 811 | + throw new EE_Error(sprintf(__('Something has gone wrong with the page load because we are unable to set up the object for the %1$s. This usually happens when the given id for the page route is NOT for the correct custom post type for this page', |
|
| 812 | + 'event_espresso'), $label)); |
|
| 813 | + } |
|
| 814 | + //if auto-draft then throw an error |
|
| 815 | + if ($this->_cpt_model_obj->get('status') == 'auto-draft') { |
|
| 816 | + EE_Error::overwrite_errors(); |
|
| 817 | + EE_Error::add_error(sprintf(__('This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly. All autodrafts will show up in the "draft" view of your event list table. You can delete them from there. Please click the "Add %1$s" button to refresh and restart.'), |
|
| 818 | + $label), __FILE__, __FUNCTION__, __LINE__); |
|
| 819 | + } |
|
| 820 | + } |
|
| 821 | + |
|
| 822 | + |
|
| 823 | + |
|
| 824 | + /** |
|
| 825 | + * admin_footer_scripts_global |
|
| 826 | + * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method |
|
| 827 | + * will apply on ALL EE_Admin pages. |
|
| 828 | + * |
|
| 829 | + * @access public |
|
| 830 | + * @return void |
|
| 831 | + */ |
|
| 832 | + public function admin_footer_scripts_global() |
|
| 833 | + { |
|
| 834 | + $this->_add_admin_page_ajax_loading_img(); |
|
| 835 | + $this->_add_admin_page_overlay(); |
|
| 836 | + } |
|
| 837 | + |
|
| 838 | + |
|
| 839 | + |
|
| 840 | + /** |
|
| 841 | + * add in any global scripts for cpt routes |
|
| 842 | + * |
|
| 843 | + * @return void |
|
| 844 | + */ |
|
| 845 | + public function load_global_scripts_styles() |
|
| 846 | + { |
|
| 847 | + parent::load_global_scripts_styles(); |
|
| 848 | + if ($this->_cpt_model_obj instanceof EE_CPT_Base) { |
|
| 849 | + //setup custom post status object for localize script but only if we've got a cpt object |
|
| 850 | + $statuses = $this->_cpt_model_obj->get_custom_post_statuses(); |
|
| 851 | + if ( ! empty($statuses)) { |
|
| 852 | + //get ALL statuses! |
|
| 853 | + $statuses = $this->_cpt_model_obj->get_all_post_statuses(); |
|
| 854 | + //setup object |
|
| 855 | + $ee_cpt_statuses = array(); |
|
| 856 | + foreach ($statuses as $status => $label) { |
|
| 857 | + $ee_cpt_statuses[$status] = array( |
|
| 858 | + 'label' => $label, |
|
| 859 | + 'save_label' => sprintf(__('Save as %s', 'event_espresso'), $label), |
|
| 860 | + ); |
|
| 861 | + } |
|
| 862 | + wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses); |
|
| 863 | + } |
|
| 864 | + } |
|
| 865 | + } |
|
| 866 | + |
|
| 867 | + |
|
| 868 | + |
|
| 869 | + /** |
|
| 870 | + * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL |
|
| 871 | + * insert/updates |
|
| 872 | + * |
|
| 873 | + * @param int $post_id ID of post being updated |
|
| 874 | + * @param WP_Post $post Post object from WP |
|
| 875 | + * @param bool $update Whether this is an update or a new save. |
|
| 876 | + * @return void |
|
| 877 | + */ |
|
| 878 | + public function insert_update($post_id, $post, $update) |
|
| 879 | + { |
|
| 880 | + //make sure that if this is a revision OR trash action that we don't do any updates! |
|
| 881 | + if ( |
|
| 882 | + isset($this->_req_data['action']) |
|
| 883 | + && ( |
|
| 884 | + $this->_req_data['action'] == 'restore' |
|
| 885 | + || $this->_req_data['action'] == 'trash' |
|
| 886 | + ) |
|
| 887 | + ) { |
|
| 888 | + return; |
|
| 889 | + } |
|
| 890 | + $this->_set_model_object($post_id, true); |
|
| 891 | + //if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit. |
|
| 892 | + if ($update |
|
| 893 | + && ( |
|
| 894 | + ! $this->_cpt_model_obj instanceof EE_CPT_Base |
|
| 895 | + || $this->_cpt_model_obj->ID() !== $post_id |
|
| 896 | + ) |
|
| 897 | + ) { |
|
| 898 | + return; |
|
| 899 | + } |
|
| 900 | + //check for autosave and update our req_data property accordingly. |
|
| 901 | + /*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) { |
|
| 902 | 902 | foreach( (array) $this->_req_data['ee_autosave_data'] as $id => $values ) { |
| 903 | 903 | |
| 904 | 904 | foreach ( (array) $values as $key => $value ) { |
@@ -908,524 +908,524 @@ discard block |
||
| 908 | 908 | |
| 909 | 909 | }/**/ //TODO reactivate after autosave is implemented in 4.2 |
| 910 | 910 | |
| 911 | - //take care of updating any selected page_template IF this cpt supports it. |
|
| 912 | - if ($this->_supports_page_templates($post->post_type) && ! empty($this->_req_data['page_template'])) { |
|
| 913 | - //wp version aware. |
|
| 914 | - if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) { |
|
| 915 | - $page_templates = wp_get_theme()->get_page_templates(); |
|
| 916 | - } else { |
|
| 917 | - $post->page_template = $this->_req_data['page_template']; |
|
| 918 | - $page_templates = wp_get_theme()->get_page_templates($post); |
|
| 919 | - } |
|
| 920 | - if ('default' != $this->_req_data['page_template'] && ! isset($page_templates[$this->_req_data['page_template']])) { |
|
| 921 | - EE_Error::add_error(__('Invalid Page Template.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 922 | - } else { |
|
| 923 | - update_post_meta($post_id, '_wp_page_template', $this->_req_data['page_template']); |
|
| 924 | - } |
|
| 925 | - } |
|
| 926 | - if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) { |
|
| 927 | - return; |
|
| 928 | - } //TODO we'll remove this after reimplementing autosave in 4.2 |
|
| 929 | - $this->_insert_update_cpt_item($post_id, $post); |
|
| 930 | - } |
|
| 931 | - |
|
| 932 | - |
|
| 933 | - |
|
| 934 | - /** |
|
| 935 | - * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time` |
|
| 936 | - * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes |
|
| 937 | - * so we don't have to check for our CPT. |
|
| 938 | - * |
|
| 939 | - * @param int $post_id ID of the post |
|
| 940 | - * @return void |
|
| 941 | - */ |
|
| 942 | - public function dont_permanently_delete_ee_cpts($post_id) |
|
| 943 | - { |
|
| 944 | - //only do this if we're actually processing one of our CPTs |
|
| 945 | - //if our cpt object isn't existent then get out immediately. |
|
| 946 | - if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) { |
|
| 947 | - return; |
|
| 948 | - } |
|
| 949 | - delete_post_meta($post_id, '_wp_trash_meta_status'); |
|
| 950 | - delete_post_meta($post_id, '_wp_trash_meta_time'); |
|
| 951 | - //our cpts may have comments so let's take care of that too |
|
| 952 | - delete_post_meta($post_id, '_wp_trash_meta_comments_status'); |
|
| 953 | - } |
|
| 954 | - |
|
| 955 | - |
|
| 956 | - |
|
| 957 | - /** |
|
| 958 | - * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is |
|
| 959 | - * triggered that we restore related items. In order to work cpt classes MUST have a restore_cpt_revision method |
|
| 960 | - * in them. We also have our OWN action in here so addons can hook into the restore process easily. |
|
| 961 | - * |
|
| 962 | - * @param int $post_id ID of cpt item |
|
| 963 | - * @param int $revision_id ID of revision being restored |
|
| 964 | - * @return void |
|
| 965 | - */ |
|
| 966 | - public function restore_revision($post_id, $revision_id) |
|
| 967 | - { |
|
| 968 | - $this->_restore_cpt_item($post_id, $revision_id); |
|
| 969 | - //global action |
|
| 970 | - do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id); |
|
| 971 | - //class specific action so you can limit hooking into a specific page. |
|
| 972 | - do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id); |
|
| 973 | - } |
|
| 974 | - |
|
| 975 | - |
|
| 976 | - |
|
| 977 | - /** |
|
| 978 | - * @see restore_revision() for details |
|
| 979 | - * @param int $post_id ID of cpt item |
|
| 980 | - * @param int $revision_id ID of revision for item |
|
| 981 | - * @return void |
|
| 982 | - */ |
|
| 983 | - abstract protected function _restore_cpt_item($post_id, $revision_id); |
|
| 984 | - |
|
| 985 | - |
|
| 986 | - |
|
| 987 | - /** |
|
| 988 | - * Execution of this method is added to the end of the load_page_dependencies method in the parent |
|
| 989 | - * so that we can fix a bug where default core metaboxes were not being called in the sidebar. |
|
| 990 | - * To fix we have to reset the current_screen using the page_slug |
|
| 991 | - * (which is identical - or should be - to our registered_post_type id.) |
|
| 992 | - * Also, since the core WP file loads the admin_header.php for WP |
|
| 993 | - * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early) |
|
| 994 | - * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set). |
|
| 995 | - * |
|
| 996 | - * @return void |
|
| 997 | - */ |
|
| 998 | - public function modify_current_screen() |
|
| 999 | - { |
|
| 1000 | - //ONLY do this if the current page_route IS a cpt route |
|
| 1001 | - if ( ! $this->_cpt_route) { |
|
| 1002 | - return; |
|
| 1003 | - } |
|
| 1004 | - //routing things REALLY early b/c this is a cpt admin page |
|
| 1005 | - set_current_screen($this->_cpt_routes[$this->_req_action]); |
|
| 1006 | - $this->_current_screen = get_current_screen(); |
|
| 1007 | - $this->_current_screen->base = 'event-espresso'; |
|
| 1008 | - $this->_add_help_tabs(); //we make sure we add any help tabs back in! |
|
| 1009 | - /*try { |
|
| 911 | + //take care of updating any selected page_template IF this cpt supports it. |
|
| 912 | + if ($this->_supports_page_templates($post->post_type) && ! empty($this->_req_data['page_template'])) { |
|
| 913 | + //wp version aware. |
|
| 914 | + if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) { |
|
| 915 | + $page_templates = wp_get_theme()->get_page_templates(); |
|
| 916 | + } else { |
|
| 917 | + $post->page_template = $this->_req_data['page_template']; |
|
| 918 | + $page_templates = wp_get_theme()->get_page_templates($post); |
|
| 919 | + } |
|
| 920 | + if ('default' != $this->_req_data['page_template'] && ! isset($page_templates[$this->_req_data['page_template']])) { |
|
| 921 | + EE_Error::add_error(__('Invalid Page Template.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 922 | + } else { |
|
| 923 | + update_post_meta($post_id, '_wp_page_template', $this->_req_data['page_template']); |
|
| 924 | + } |
|
| 925 | + } |
|
| 926 | + if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) { |
|
| 927 | + return; |
|
| 928 | + } //TODO we'll remove this after reimplementing autosave in 4.2 |
|
| 929 | + $this->_insert_update_cpt_item($post_id, $post); |
|
| 930 | + } |
|
| 931 | + |
|
| 932 | + |
|
| 933 | + |
|
| 934 | + /** |
|
| 935 | + * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time` |
|
| 936 | + * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes |
|
| 937 | + * so we don't have to check for our CPT. |
|
| 938 | + * |
|
| 939 | + * @param int $post_id ID of the post |
|
| 940 | + * @return void |
|
| 941 | + */ |
|
| 942 | + public function dont_permanently_delete_ee_cpts($post_id) |
|
| 943 | + { |
|
| 944 | + //only do this if we're actually processing one of our CPTs |
|
| 945 | + //if our cpt object isn't existent then get out immediately. |
|
| 946 | + if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) { |
|
| 947 | + return; |
|
| 948 | + } |
|
| 949 | + delete_post_meta($post_id, '_wp_trash_meta_status'); |
|
| 950 | + delete_post_meta($post_id, '_wp_trash_meta_time'); |
|
| 951 | + //our cpts may have comments so let's take care of that too |
|
| 952 | + delete_post_meta($post_id, '_wp_trash_meta_comments_status'); |
|
| 953 | + } |
|
| 954 | + |
|
| 955 | + |
|
| 956 | + |
|
| 957 | + /** |
|
| 958 | + * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is |
|
| 959 | + * triggered that we restore related items. In order to work cpt classes MUST have a restore_cpt_revision method |
|
| 960 | + * in them. We also have our OWN action in here so addons can hook into the restore process easily. |
|
| 961 | + * |
|
| 962 | + * @param int $post_id ID of cpt item |
|
| 963 | + * @param int $revision_id ID of revision being restored |
|
| 964 | + * @return void |
|
| 965 | + */ |
|
| 966 | + public function restore_revision($post_id, $revision_id) |
|
| 967 | + { |
|
| 968 | + $this->_restore_cpt_item($post_id, $revision_id); |
|
| 969 | + //global action |
|
| 970 | + do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id); |
|
| 971 | + //class specific action so you can limit hooking into a specific page. |
|
| 972 | + do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id); |
|
| 973 | + } |
|
| 974 | + |
|
| 975 | + |
|
| 976 | + |
|
| 977 | + /** |
|
| 978 | + * @see restore_revision() for details |
|
| 979 | + * @param int $post_id ID of cpt item |
|
| 980 | + * @param int $revision_id ID of revision for item |
|
| 981 | + * @return void |
|
| 982 | + */ |
|
| 983 | + abstract protected function _restore_cpt_item($post_id, $revision_id); |
|
| 984 | + |
|
| 985 | + |
|
| 986 | + |
|
| 987 | + /** |
|
| 988 | + * Execution of this method is added to the end of the load_page_dependencies method in the parent |
|
| 989 | + * so that we can fix a bug where default core metaboxes were not being called in the sidebar. |
|
| 990 | + * To fix we have to reset the current_screen using the page_slug |
|
| 991 | + * (which is identical - or should be - to our registered_post_type id.) |
|
| 992 | + * Also, since the core WP file loads the admin_header.php for WP |
|
| 993 | + * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early) |
|
| 994 | + * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set). |
|
| 995 | + * |
|
| 996 | + * @return void |
|
| 997 | + */ |
|
| 998 | + public function modify_current_screen() |
|
| 999 | + { |
|
| 1000 | + //ONLY do this if the current page_route IS a cpt route |
|
| 1001 | + if ( ! $this->_cpt_route) { |
|
| 1002 | + return; |
|
| 1003 | + } |
|
| 1004 | + //routing things REALLY early b/c this is a cpt admin page |
|
| 1005 | + set_current_screen($this->_cpt_routes[$this->_req_action]); |
|
| 1006 | + $this->_current_screen = get_current_screen(); |
|
| 1007 | + $this->_current_screen->base = 'event-espresso'; |
|
| 1008 | + $this->_add_help_tabs(); //we make sure we add any help tabs back in! |
|
| 1009 | + /*try { |
|
| 1010 | 1010 | $this->_route_admin_request(); |
| 1011 | 1011 | } catch ( EE_Error $e ) { |
| 1012 | 1012 | $e->get_error(); |
| 1013 | 1013 | }/**/ |
| 1014 | - } |
|
| 1015 | - |
|
| 1016 | - |
|
| 1017 | - |
|
| 1018 | - /** |
|
| 1019 | - * This allows child classes to modify the default editor title that appears when people add a new or edit an |
|
| 1020 | - * existing CPT item. * This uses the _labels property set by the child class via _define_page_props. Just make |
|
| 1021 | - * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the |
|
| 1022 | - * default to be. |
|
| 1023 | - * |
|
| 1024 | - * @param string $title The new title (or existing if there is no editor_title defined) |
|
| 1025 | - * @return string |
|
| 1026 | - */ |
|
| 1027 | - public function add_custom_editor_default_title($title) |
|
| 1028 | - { |
|
| 1029 | - return isset($this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]]) |
|
| 1030 | - ? $this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]] |
|
| 1031 | - : $title; |
|
| 1032 | - } |
|
| 1033 | - |
|
| 1034 | - |
|
| 1035 | - |
|
| 1036 | - /** |
|
| 1037 | - * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated |
|
| 1038 | - * |
|
| 1039 | - * @param string $shortlink The already generated shortlink |
|
| 1040 | - * @param int $id Post ID for this item |
|
| 1041 | - * @param string $context The context for the link |
|
| 1042 | - * @param bool $allow_slugs Whether to allow post slugs in the shortlink. |
|
| 1043 | - * @return string |
|
| 1044 | - */ |
|
| 1045 | - public function add_shortlink_button_to_editor($shortlink, $id, $context, $allow_slugs) |
|
| 1046 | - { |
|
| 1047 | - if ( ! empty($id) && '' != get_option('permalink_structure')) { |
|
| 1048 | - $post = get_post($id); |
|
| 1049 | - if (isset($post->post_type) && $this->page_slug == $post->post_type) { |
|
| 1050 | - $shortlink = home_url('?p=' . $post->ID); |
|
| 1051 | - } |
|
| 1052 | - } |
|
| 1053 | - return $shortlink; |
|
| 1054 | - } |
|
| 1055 | - |
|
| 1056 | - |
|
| 1057 | - |
|
| 1058 | - /** |
|
| 1059 | - * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's |
|
| 1060 | - * already run in modify_current_screen()) |
|
| 1061 | - * |
|
| 1062 | - * @return void |
|
| 1063 | - */ |
|
| 1064 | - public function route_admin_request() |
|
| 1065 | - { |
|
| 1066 | - if ($this->_cpt_route) { |
|
| 1067 | - return; |
|
| 1068 | - } |
|
| 1069 | - try { |
|
| 1070 | - $this->_route_admin_request(); |
|
| 1071 | - } catch (EE_Error $e) { |
|
| 1072 | - $e->get_error(); |
|
| 1073 | - } |
|
| 1074 | - } |
|
| 1075 | - |
|
| 1076 | - |
|
| 1077 | - |
|
| 1078 | - /** |
|
| 1079 | - * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves |
|
| 1080 | - * |
|
| 1081 | - * @return string html |
|
| 1082 | - */ |
|
| 1083 | - public function cpt_post_form_hidden_input() |
|
| 1084 | - { |
|
| 1085 | - echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />'; |
|
| 1086 | - //we're also going to add the route value and the current page so we can direct autosave parsing correctly |
|
| 1087 | - echo '<div id="ee-cpt-hidden-inputs">'; |
|
| 1088 | - echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />'; |
|
| 1089 | - echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />'; |
|
| 1090 | - echo '</div>'; |
|
| 1091 | - } |
|
| 1092 | - |
|
| 1093 | - |
|
| 1094 | - |
|
| 1095 | - /** |
|
| 1096 | - * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes. |
|
| 1097 | - * |
|
| 1098 | - * @param string $location Original location url |
|
| 1099 | - * @param int $status Status for http header |
|
| 1100 | - * @return string new (or original) url to redirect to. |
|
| 1101 | - */ |
|
| 1102 | - public function revision_redirect($location, $status) |
|
| 1103 | - { |
|
| 1104 | - //get revision |
|
| 1105 | - $rev_id = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null; |
|
| 1106 | - //can't do anything without revision so let's get out if not present |
|
| 1107 | - if (empty($rev_id)) { |
|
| 1108 | - return $location; |
|
| 1109 | - } |
|
| 1110 | - //get rev_post_data |
|
| 1111 | - $rev = get_post($rev_id); |
|
| 1112 | - $admin_url = $this->_admin_base_url; |
|
| 1113 | - $query_args = array( |
|
| 1114 | - 'action' => 'edit', |
|
| 1115 | - 'post' => $rev->post_parent, |
|
| 1116 | - 'revision' => $rev_id, |
|
| 1117 | - 'message' => 5, |
|
| 1118 | - ); |
|
| 1119 | - $this->_process_notices($query_args, true); |
|
| 1120 | - return self::add_query_args_and_nonce($query_args, $admin_url); |
|
| 1121 | - } |
|
| 1122 | - |
|
| 1123 | - |
|
| 1124 | - |
|
| 1125 | - /** |
|
| 1126 | - * Modify the edit post link generated by wp core function so that EE CPTs get setup differently. |
|
| 1127 | - * |
|
| 1128 | - * @param string $link the original generated link |
|
| 1129 | - * @param int $id post id |
|
| 1130 | - * @param string $context optional, defaults to display. How to write the '&' |
|
| 1131 | - * @return string the link |
|
| 1132 | - */ |
|
| 1133 | - public function modify_edit_post_link($link, $id, $context) |
|
| 1134 | - { |
|
| 1135 | - $post = get_post($id); |
|
| 1136 | - if ( ! isset($this->_req_data['action']) |
|
| 1137 | - || ! isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 1138 | - || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']] |
|
| 1139 | - ) { |
|
| 1140 | - return $link; |
|
| 1141 | - } |
|
| 1142 | - $query_args = array( |
|
| 1143 | - 'action' => isset($this->_cpt_edit_routes[$post->post_type]) |
|
| 1144 | - ? $this->_cpt_edit_routes[$post->post_type] |
|
| 1145 | - : 'edit', |
|
| 1146 | - 'post' => $id, |
|
| 1147 | - ); |
|
| 1148 | - return self::add_query_args_and_nonce($query_args, $this->_admin_base_url); |
|
| 1149 | - } |
|
| 1150 | - |
|
| 1151 | - |
|
| 1152 | - /** |
|
| 1153 | - * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on |
|
| 1154 | - * our routes. |
|
| 1155 | - * |
|
| 1156 | - * @param string $delete_link original delete link |
|
| 1157 | - * @param int $post_id id of cpt object |
|
| 1158 | - * @param bool $force_delete whether this is forcing a hard delete instead of trash |
|
| 1159 | - * @return string new delete link |
|
| 1160 | - * @throws EE_Error |
|
| 1161 | - */ |
|
| 1162 | - public function modify_delete_post_link($delete_link, $post_id, $force_delete) |
|
| 1163 | - { |
|
| 1164 | - $post = get_post($post_id); |
|
| 1165 | - if ( ! isset($this->_req_data['action']) |
|
| 1166 | - || (isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 1167 | - && $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]) |
|
| 1168 | - ) { |
|
| 1169 | - return $delete_link; |
|
| 1170 | - } |
|
| 1171 | - $this->_set_model_object($this->_req_data['post'], true); |
|
| 1172 | - //returns something like `trash_event` or `trash_attendee` or `trash_venue` |
|
| 1173 | - $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj))); |
|
| 1174 | - |
|
| 1175 | - return EE_Admin_Page::add_query_args_and_nonce( |
|
| 1176 | - array( |
|
| 1177 | - 'page' => $this->_req_data['page'], |
|
| 1178 | - 'action' => $action, |
|
| 1179 | - $this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name() |
|
| 1180 | - => $this->_req_data['post'] |
|
| 1181 | - ), |
|
| 1182 | - admin_url() |
|
| 1183 | - ); |
|
| 1184 | - } |
|
| 1185 | - |
|
| 1186 | - |
|
| 1187 | - |
|
| 1188 | - /** |
|
| 1189 | - * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php |
|
| 1190 | - * so that we can hijack the default redirect locations for wp custom post types |
|
| 1191 | - * that WE'RE using and send back to OUR routes. This should only be hooked in on the right route. |
|
| 1192 | - * |
|
| 1193 | - * @param string $location This is the incoming currently set redirect location |
|
| 1194 | - * @param string $post_id This is the 'ID' value of the wp_posts table |
|
| 1195 | - * @return string the new location to redirect to |
|
| 1196 | - */ |
|
| 1197 | - public function cpt_post_location_redirect($location, $post_id) |
|
| 1198 | - { |
|
| 1199 | - //we DO have a match so let's setup the url |
|
| 1200 | - //we have to get the post to determine our route |
|
| 1201 | - $post = get_post($post_id); |
|
| 1202 | - $edit_route = $this->_cpt_edit_routes[$post->post_type]; |
|
| 1203 | - //shared query_args |
|
| 1204 | - $query_args = array('action' => $edit_route, 'post' => $post_id); |
|
| 1205 | - $admin_url = $this->_admin_base_url; |
|
| 1206 | - if (isset($this->_req_data['save']) || isset($this->_req_data['publish'])) { |
|
| 1207 | - $status = get_post_status($post_id); |
|
| 1208 | - if (isset($this->_req_data['publish'])) { |
|
| 1209 | - switch ($status) { |
|
| 1210 | - case 'pending': |
|
| 1211 | - $message = 8; |
|
| 1212 | - break; |
|
| 1213 | - case 'future': |
|
| 1214 | - $message = 9; |
|
| 1215 | - break; |
|
| 1216 | - default: |
|
| 1217 | - $message = 6; |
|
| 1218 | - } |
|
| 1219 | - } else { |
|
| 1220 | - $message = 'draft' == $status ? 10 : 1; |
|
| 1221 | - } |
|
| 1222 | - } else if (isset($this->_req_data['addmeta']) && $this->_req_data['addmeta']) { |
|
| 1223 | - $message = 2; |
|
| 1224 | - // $append = '#postcustom'; |
|
| 1225 | - } else if (isset($this->_req_data['deletemeta']) && $this->_req_data['deletemeta']) { |
|
| 1226 | - $message = 3; |
|
| 1227 | - // $append = '#postcustom'; |
|
| 1228 | - } elseif ($this->_req_data['action'] == 'post-quickpress-save-cont') { |
|
| 1229 | - $message = 7; |
|
| 1230 | - } else { |
|
| 1231 | - $message = 4; |
|
| 1232 | - } |
|
| 1233 | - //change the message if the post type is not viewable on the frontend |
|
| 1234 | - $this->_cpt_object = get_post_type_object($post->post_type); |
|
| 1235 | - $message = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message; |
|
| 1236 | - $query_args = array_merge(array('message' => $message), $query_args); |
|
| 1237 | - $this->_process_notices($query_args, true); |
|
| 1238 | - return self::add_query_args_and_nonce($query_args, $admin_url); |
|
| 1239 | - } |
|
| 1240 | - |
|
| 1241 | - |
|
| 1242 | - |
|
| 1243 | - /** |
|
| 1244 | - * This method is called to inject nav tabs on core WP cpt pages |
|
| 1245 | - * |
|
| 1246 | - * @access public |
|
| 1247 | - * @return string html |
|
| 1248 | - */ |
|
| 1249 | - public function inject_nav_tabs() |
|
| 1250 | - { |
|
| 1251 | - //can we hijack and insert the nav_tabs? |
|
| 1252 | - $nav_tabs = $this->_get_main_nav_tabs(); |
|
| 1253 | - //first close off existing form tag |
|
| 1254 | - $html = '>'; |
|
| 1255 | - $html .= $nav_tabs; |
|
| 1256 | - //now let's handle the remaining tag ( missing ">" is CORRECT ) |
|
| 1257 | - $html .= '<span></span'; |
|
| 1258 | - echo $html; |
|
| 1259 | - } |
|
| 1260 | - |
|
| 1261 | - |
|
| 1262 | - |
|
| 1263 | - /** |
|
| 1264 | - * This just sets up the post update messages when an update form is loaded |
|
| 1265 | - * |
|
| 1266 | - * @access public |
|
| 1267 | - * @param array $messages the original messages array |
|
| 1268 | - * @return array the new messages array |
|
| 1269 | - */ |
|
| 1270 | - public function post_update_messages($messages) |
|
| 1271 | - { |
|
| 1272 | - global $post; |
|
| 1273 | - $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null; |
|
| 1274 | - $id = empty($id) && is_object($post) ? $post->ID : null; |
|
| 1275 | - // $post_type = $post ? $post->post_type : false; |
|
| 1276 | - /*$current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route'] : 'shouldneverwork'; |
|
| 1014 | + } |
|
| 1015 | + |
|
| 1016 | + |
|
| 1017 | + |
|
| 1018 | + /** |
|
| 1019 | + * This allows child classes to modify the default editor title that appears when people add a new or edit an |
|
| 1020 | + * existing CPT item. * This uses the _labels property set by the child class via _define_page_props. Just make |
|
| 1021 | + * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the |
|
| 1022 | + * default to be. |
|
| 1023 | + * |
|
| 1024 | + * @param string $title The new title (or existing if there is no editor_title defined) |
|
| 1025 | + * @return string |
|
| 1026 | + */ |
|
| 1027 | + public function add_custom_editor_default_title($title) |
|
| 1028 | + { |
|
| 1029 | + return isset($this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]]) |
|
| 1030 | + ? $this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]] |
|
| 1031 | + : $title; |
|
| 1032 | + } |
|
| 1033 | + |
|
| 1034 | + |
|
| 1035 | + |
|
| 1036 | + /** |
|
| 1037 | + * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated |
|
| 1038 | + * |
|
| 1039 | + * @param string $shortlink The already generated shortlink |
|
| 1040 | + * @param int $id Post ID for this item |
|
| 1041 | + * @param string $context The context for the link |
|
| 1042 | + * @param bool $allow_slugs Whether to allow post slugs in the shortlink. |
|
| 1043 | + * @return string |
|
| 1044 | + */ |
|
| 1045 | + public function add_shortlink_button_to_editor($shortlink, $id, $context, $allow_slugs) |
|
| 1046 | + { |
|
| 1047 | + if ( ! empty($id) && '' != get_option('permalink_structure')) { |
|
| 1048 | + $post = get_post($id); |
|
| 1049 | + if (isset($post->post_type) && $this->page_slug == $post->post_type) { |
|
| 1050 | + $shortlink = home_url('?p=' . $post->ID); |
|
| 1051 | + } |
|
| 1052 | + } |
|
| 1053 | + return $shortlink; |
|
| 1054 | + } |
|
| 1055 | + |
|
| 1056 | + |
|
| 1057 | + |
|
| 1058 | + /** |
|
| 1059 | + * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's |
|
| 1060 | + * already run in modify_current_screen()) |
|
| 1061 | + * |
|
| 1062 | + * @return void |
|
| 1063 | + */ |
|
| 1064 | + public function route_admin_request() |
|
| 1065 | + { |
|
| 1066 | + if ($this->_cpt_route) { |
|
| 1067 | + return; |
|
| 1068 | + } |
|
| 1069 | + try { |
|
| 1070 | + $this->_route_admin_request(); |
|
| 1071 | + } catch (EE_Error $e) { |
|
| 1072 | + $e->get_error(); |
|
| 1073 | + } |
|
| 1074 | + } |
|
| 1075 | + |
|
| 1076 | + |
|
| 1077 | + |
|
| 1078 | + /** |
|
| 1079 | + * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves |
|
| 1080 | + * |
|
| 1081 | + * @return string html |
|
| 1082 | + */ |
|
| 1083 | + public function cpt_post_form_hidden_input() |
|
| 1084 | + { |
|
| 1085 | + echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />'; |
|
| 1086 | + //we're also going to add the route value and the current page so we can direct autosave parsing correctly |
|
| 1087 | + echo '<div id="ee-cpt-hidden-inputs">'; |
|
| 1088 | + echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />'; |
|
| 1089 | + echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />'; |
|
| 1090 | + echo '</div>'; |
|
| 1091 | + } |
|
| 1092 | + |
|
| 1093 | + |
|
| 1094 | + |
|
| 1095 | + /** |
|
| 1096 | + * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes. |
|
| 1097 | + * |
|
| 1098 | + * @param string $location Original location url |
|
| 1099 | + * @param int $status Status for http header |
|
| 1100 | + * @return string new (or original) url to redirect to. |
|
| 1101 | + */ |
|
| 1102 | + public function revision_redirect($location, $status) |
|
| 1103 | + { |
|
| 1104 | + //get revision |
|
| 1105 | + $rev_id = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null; |
|
| 1106 | + //can't do anything without revision so let's get out if not present |
|
| 1107 | + if (empty($rev_id)) { |
|
| 1108 | + return $location; |
|
| 1109 | + } |
|
| 1110 | + //get rev_post_data |
|
| 1111 | + $rev = get_post($rev_id); |
|
| 1112 | + $admin_url = $this->_admin_base_url; |
|
| 1113 | + $query_args = array( |
|
| 1114 | + 'action' => 'edit', |
|
| 1115 | + 'post' => $rev->post_parent, |
|
| 1116 | + 'revision' => $rev_id, |
|
| 1117 | + 'message' => 5, |
|
| 1118 | + ); |
|
| 1119 | + $this->_process_notices($query_args, true); |
|
| 1120 | + return self::add_query_args_and_nonce($query_args, $admin_url); |
|
| 1121 | + } |
|
| 1122 | + |
|
| 1123 | + |
|
| 1124 | + |
|
| 1125 | + /** |
|
| 1126 | + * Modify the edit post link generated by wp core function so that EE CPTs get setup differently. |
|
| 1127 | + * |
|
| 1128 | + * @param string $link the original generated link |
|
| 1129 | + * @param int $id post id |
|
| 1130 | + * @param string $context optional, defaults to display. How to write the '&' |
|
| 1131 | + * @return string the link |
|
| 1132 | + */ |
|
| 1133 | + public function modify_edit_post_link($link, $id, $context) |
|
| 1134 | + { |
|
| 1135 | + $post = get_post($id); |
|
| 1136 | + if ( ! isset($this->_req_data['action']) |
|
| 1137 | + || ! isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 1138 | + || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']] |
|
| 1139 | + ) { |
|
| 1140 | + return $link; |
|
| 1141 | + } |
|
| 1142 | + $query_args = array( |
|
| 1143 | + 'action' => isset($this->_cpt_edit_routes[$post->post_type]) |
|
| 1144 | + ? $this->_cpt_edit_routes[$post->post_type] |
|
| 1145 | + : 'edit', |
|
| 1146 | + 'post' => $id, |
|
| 1147 | + ); |
|
| 1148 | + return self::add_query_args_and_nonce($query_args, $this->_admin_base_url); |
|
| 1149 | + } |
|
| 1150 | + |
|
| 1151 | + |
|
| 1152 | + /** |
|
| 1153 | + * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on |
|
| 1154 | + * our routes. |
|
| 1155 | + * |
|
| 1156 | + * @param string $delete_link original delete link |
|
| 1157 | + * @param int $post_id id of cpt object |
|
| 1158 | + * @param bool $force_delete whether this is forcing a hard delete instead of trash |
|
| 1159 | + * @return string new delete link |
|
| 1160 | + * @throws EE_Error |
|
| 1161 | + */ |
|
| 1162 | + public function modify_delete_post_link($delete_link, $post_id, $force_delete) |
|
| 1163 | + { |
|
| 1164 | + $post = get_post($post_id); |
|
| 1165 | + if ( ! isset($this->_req_data['action']) |
|
| 1166 | + || (isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 1167 | + && $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]) |
|
| 1168 | + ) { |
|
| 1169 | + return $delete_link; |
|
| 1170 | + } |
|
| 1171 | + $this->_set_model_object($this->_req_data['post'], true); |
|
| 1172 | + //returns something like `trash_event` or `trash_attendee` or `trash_venue` |
|
| 1173 | + $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj))); |
|
| 1174 | + |
|
| 1175 | + return EE_Admin_Page::add_query_args_and_nonce( |
|
| 1176 | + array( |
|
| 1177 | + 'page' => $this->_req_data['page'], |
|
| 1178 | + 'action' => $action, |
|
| 1179 | + $this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name() |
|
| 1180 | + => $this->_req_data['post'] |
|
| 1181 | + ), |
|
| 1182 | + admin_url() |
|
| 1183 | + ); |
|
| 1184 | + } |
|
| 1185 | + |
|
| 1186 | + |
|
| 1187 | + |
|
| 1188 | + /** |
|
| 1189 | + * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php |
|
| 1190 | + * so that we can hijack the default redirect locations for wp custom post types |
|
| 1191 | + * that WE'RE using and send back to OUR routes. This should only be hooked in on the right route. |
|
| 1192 | + * |
|
| 1193 | + * @param string $location This is the incoming currently set redirect location |
|
| 1194 | + * @param string $post_id This is the 'ID' value of the wp_posts table |
|
| 1195 | + * @return string the new location to redirect to |
|
| 1196 | + */ |
|
| 1197 | + public function cpt_post_location_redirect($location, $post_id) |
|
| 1198 | + { |
|
| 1199 | + //we DO have a match so let's setup the url |
|
| 1200 | + //we have to get the post to determine our route |
|
| 1201 | + $post = get_post($post_id); |
|
| 1202 | + $edit_route = $this->_cpt_edit_routes[$post->post_type]; |
|
| 1203 | + //shared query_args |
|
| 1204 | + $query_args = array('action' => $edit_route, 'post' => $post_id); |
|
| 1205 | + $admin_url = $this->_admin_base_url; |
|
| 1206 | + if (isset($this->_req_data['save']) || isset($this->_req_data['publish'])) { |
|
| 1207 | + $status = get_post_status($post_id); |
|
| 1208 | + if (isset($this->_req_data['publish'])) { |
|
| 1209 | + switch ($status) { |
|
| 1210 | + case 'pending': |
|
| 1211 | + $message = 8; |
|
| 1212 | + break; |
|
| 1213 | + case 'future': |
|
| 1214 | + $message = 9; |
|
| 1215 | + break; |
|
| 1216 | + default: |
|
| 1217 | + $message = 6; |
|
| 1218 | + } |
|
| 1219 | + } else { |
|
| 1220 | + $message = 'draft' == $status ? 10 : 1; |
|
| 1221 | + } |
|
| 1222 | + } else if (isset($this->_req_data['addmeta']) && $this->_req_data['addmeta']) { |
|
| 1223 | + $message = 2; |
|
| 1224 | + // $append = '#postcustom'; |
|
| 1225 | + } else if (isset($this->_req_data['deletemeta']) && $this->_req_data['deletemeta']) { |
|
| 1226 | + $message = 3; |
|
| 1227 | + // $append = '#postcustom'; |
|
| 1228 | + } elseif ($this->_req_data['action'] == 'post-quickpress-save-cont') { |
|
| 1229 | + $message = 7; |
|
| 1230 | + } else { |
|
| 1231 | + $message = 4; |
|
| 1232 | + } |
|
| 1233 | + //change the message if the post type is not viewable on the frontend |
|
| 1234 | + $this->_cpt_object = get_post_type_object($post->post_type); |
|
| 1235 | + $message = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message; |
|
| 1236 | + $query_args = array_merge(array('message' => $message), $query_args); |
|
| 1237 | + $this->_process_notices($query_args, true); |
|
| 1238 | + return self::add_query_args_and_nonce($query_args, $admin_url); |
|
| 1239 | + } |
|
| 1240 | + |
|
| 1241 | + |
|
| 1242 | + |
|
| 1243 | + /** |
|
| 1244 | + * This method is called to inject nav tabs on core WP cpt pages |
|
| 1245 | + * |
|
| 1246 | + * @access public |
|
| 1247 | + * @return string html |
|
| 1248 | + */ |
|
| 1249 | + public function inject_nav_tabs() |
|
| 1250 | + { |
|
| 1251 | + //can we hijack and insert the nav_tabs? |
|
| 1252 | + $nav_tabs = $this->_get_main_nav_tabs(); |
|
| 1253 | + //first close off existing form tag |
|
| 1254 | + $html = '>'; |
|
| 1255 | + $html .= $nav_tabs; |
|
| 1256 | + //now let's handle the remaining tag ( missing ">" is CORRECT ) |
|
| 1257 | + $html .= '<span></span'; |
|
| 1258 | + echo $html; |
|
| 1259 | + } |
|
| 1260 | + |
|
| 1261 | + |
|
| 1262 | + |
|
| 1263 | + /** |
|
| 1264 | + * This just sets up the post update messages when an update form is loaded |
|
| 1265 | + * |
|
| 1266 | + * @access public |
|
| 1267 | + * @param array $messages the original messages array |
|
| 1268 | + * @return array the new messages array |
|
| 1269 | + */ |
|
| 1270 | + public function post_update_messages($messages) |
|
| 1271 | + { |
|
| 1272 | + global $post; |
|
| 1273 | + $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null; |
|
| 1274 | + $id = empty($id) && is_object($post) ? $post->ID : null; |
|
| 1275 | + // $post_type = $post ? $post->post_type : false; |
|
| 1276 | + /*$current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route'] : 'shouldneverwork'; |
|
| 1277 | 1277 | |
| 1278 | 1278 | $route_to_check = $post_type && isset( $this->_cpt_routes[$current_route]) ? $this->_cpt_routes[$current_route] : '';/**/ |
| 1279 | - $messages[$post->post_type] = array( |
|
| 1280 | - 0 => '', //Unused. Messages start at index 1. |
|
| 1281 | - 1 => sprintf( |
|
| 1282 | - __('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'), |
|
| 1283 | - $this->_cpt_object->labels->singular_name, |
|
| 1284 | - '<a href="' . esc_url(get_permalink($id)) . '">', |
|
| 1285 | - '</a>' |
|
| 1286 | - ), |
|
| 1287 | - 2 => __('Custom field updated'), |
|
| 1288 | - 3 => __('Custom field deleted.'), |
|
| 1289 | - 4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name), |
|
| 1290 | - 5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'), |
|
| 1291 | - $this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false)) |
|
| 1292 | - : false, |
|
| 1293 | - 6 => sprintf( |
|
| 1294 | - __('%1$s published. %2$sView %1$s%3$s', 'event_espresso'), |
|
| 1295 | - $this->_cpt_object->labels->singular_name, |
|
| 1296 | - '<a href="' . esc_url(get_permalink($id)) . '">', |
|
| 1297 | - '</a>' |
|
| 1298 | - ), |
|
| 1299 | - 7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name), |
|
| 1300 | - 8 => sprintf( |
|
| 1301 | - __('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'), |
|
| 1302 | - $this->_cpt_object->labels->singular_name, |
|
| 1303 | - '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">', |
|
| 1304 | - '</a>' |
|
| 1305 | - ), |
|
| 1306 | - 9 => sprintf( |
|
| 1307 | - __('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'), |
|
| 1308 | - $this->_cpt_object->labels->singular_name, |
|
| 1309 | - '<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>', |
|
| 1310 | - '<a target="_blank" href="' . esc_url(get_permalink($id)), |
|
| 1311 | - '</a>' |
|
| 1312 | - ), |
|
| 1313 | - 10 => sprintf( |
|
| 1314 | - __('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'), |
|
| 1315 | - $this->_cpt_object->labels->singular_name, |
|
| 1316 | - '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))), |
|
| 1317 | - '</a>' |
|
| 1318 | - ), |
|
| 1319 | - ); |
|
| 1320 | - return $messages; |
|
| 1321 | - } |
|
| 1322 | - |
|
| 1323 | - |
|
| 1324 | - |
|
| 1325 | - /** |
|
| 1326 | - * default method for the 'create_new' route for cpt admin pages. |
|
| 1327 | - * For reference what to include in here, see wp-admin/post-new.php |
|
| 1328 | - * |
|
| 1329 | - * @access protected |
|
| 1330 | - * @return string template for add new cpt form |
|
| 1331 | - */ |
|
| 1332 | - protected function _create_new_cpt_item() |
|
| 1333 | - { |
|
| 1334 | - global $post, $title, $is_IE, $post_type, $post_type_object; |
|
| 1335 | - $post_type = $this->_cpt_routes[$this->_req_action]; |
|
| 1336 | - $post_type_object = $this->_cpt_object; |
|
| 1337 | - $title = $post_type_object->labels->add_new_item; |
|
| 1338 | - $editing = true; |
|
| 1339 | - wp_enqueue_script('autosave'); |
|
| 1340 | - $post = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true); |
|
| 1341 | - $post_ID = $post->ID; |
|
| 1342 | - $is_IE = $is_IE; |
|
| 1343 | - add_action('admin_print_styles', array($this, 'add_new_admin_page_global')); |
|
| 1344 | - //modify the default editor title field with default title. |
|
| 1345 | - add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10); |
|
| 1346 | - include_once WP_ADMIN_PATH . 'edit-form-advanced.php'; |
|
| 1347 | - } |
|
| 1348 | - |
|
| 1349 | - |
|
| 1350 | - |
|
| 1351 | - public function add_new_admin_page_global() |
|
| 1352 | - { |
|
| 1353 | - $admin_page = ! empty($this->_req_data['post']) ? 'post-php' : 'post-new-php'; |
|
| 1354 | - ?> |
|
| 1279 | + $messages[$post->post_type] = array( |
|
| 1280 | + 0 => '', //Unused. Messages start at index 1. |
|
| 1281 | + 1 => sprintf( |
|
| 1282 | + __('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'), |
|
| 1283 | + $this->_cpt_object->labels->singular_name, |
|
| 1284 | + '<a href="' . esc_url(get_permalink($id)) . '">', |
|
| 1285 | + '</a>' |
|
| 1286 | + ), |
|
| 1287 | + 2 => __('Custom field updated'), |
|
| 1288 | + 3 => __('Custom field deleted.'), |
|
| 1289 | + 4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name), |
|
| 1290 | + 5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'), |
|
| 1291 | + $this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false)) |
|
| 1292 | + : false, |
|
| 1293 | + 6 => sprintf( |
|
| 1294 | + __('%1$s published. %2$sView %1$s%3$s', 'event_espresso'), |
|
| 1295 | + $this->_cpt_object->labels->singular_name, |
|
| 1296 | + '<a href="' . esc_url(get_permalink($id)) . '">', |
|
| 1297 | + '</a>' |
|
| 1298 | + ), |
|
| 1299 | + 7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name), |
|
| 1300 | + 8 => sprintf( |
|
| 1301 | + __('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'), |
|
| 1302 | + $this->_cpt_object->labels->singular_name, |
|
| 1303 | + '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">', |
|
| 1304 | + '</a>' |
|
| 1305 | + ), |
|
| 1306 | + 9 => sprintf( |
|
| 1307 | + __('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'), |
|
| 1308 | + $this->_cpt_object->labels->singular_name, |
|
| 1309 | + '<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>', |
|
| 1310 | + '<a target="_blank" href="' . esc_url(get_permalink($id)), |
|
| 1311 | + '</a>' |
|
| 1312 | + ), |
|
| 1313 | + 10 => sprintf( |
|
| 1314 | + __('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'), |
|
| 1315 | + $this->_cpt_object->labels->singular_name, |
|
| 1316 | + '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))), |
|
| 1317 | + '</a>' |
|
| 1318 | + ), |
|
| 1319 | + ); |
|
| 1320 | + return $messages; |
|
| 1321 | + } |
|
| 1322 | + |
|
| 1323 | + |
|
| 1324 | + |
|
| 1325 | + /** |
|
| 1326 | + * default method for the 'create_new' route for cpt admin pages. |
|
| 1327 | + * For reference what to include in here, see wp-admin/post-new.php |
|
| 1328 | + * |
|
| 1329 | + * @access protected |
|
| 1330 | + * @return string template for add new cpt form |
|
| 1331 | + */ |
|
| 1332 | + protected function _create_new_cpt_item() |
|
| 1333 | + { |
|
| 1334 | + global $post, $title, $is_IE, $post_type, $post_type_object; |
|
| 1335 | + $post_type = $this->_cpt_routes[$this->_req_action]; |
|
| 1336 | + $post_type_object = $this->_cpt_object; |
|
| 1337 | + $title = $post_type_object->labels->add_new_item; |
|
| 1338 | + $editing = true; |
|
| 1339 | + wp_enqueue_script('autosave'); |
|
| 1340 | + $post = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true); |
|
| 1341 | + $post_ID = $post->ID; |
|
| 1342 | + $is_IE = $is_IE; |
|
| 1343 | + add_action('admin_print_styles', array($this, 'add_new_admin_page_global')); |
|
| 1344 | + //modify the default editor title field with default title. |
|
| 1345 | + add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10); |
|
| 1346 | + include_once WP_ADMIN_PATH . 'edit-form-advanced.php'; |
|
| 1347 | + } |
|
| 1348 | + |
|
| 1349 | + |
|
| 1350 | + |
|
| 1351 | + public function add_new_admin_page_global() |
|
| 1352 | + { |
|
| 1353 | + $admin_page = ! empty($this->_req_data['post']) ? 'post-php' : 'post-new-php'; |
|
| 1354 | + ?> |
|
| 1355 | 1355 | <script type="text/javascript"> |
| 1356 | 1356 | adminpage = '<?php echo $admin_page; ?>'; |
| 1357 | 1357 | </script> |
| 1358 | 1358 | <?php |
| 1359 | - } |
|
| 1360 | - |
|
| 1361 | - |
|
| 1362 | - |
|
| 1363 | - /** |
|
| 1364 | - * default method for the 'edit' route for cpt admin pages |
|
| 1365 | - * For reference on what to put in here, refer to wp-admin/post.php |
|
| 1366 | - * |
|
| 1367 | - * @access protected |
|
| 1368 | - * @return string template for edit cpt form |
|
| 1369 | - */ |
|
| 1370 | - protected function _edit_cpt_item() |
|
| 1371 | - { |
|
| 1372 | - global $post, $title, $is_IE, $post_type, $post_type_object; |
|
| 1373 | - $post_id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null; |
|
| 1374 | - $post = ! empty($post_id) ? get_post($post_id, OBJECT, 'edit') : null; |
|
| 1375 | - if (empty ($post)) { |
|
| 1376 | - wp_die(__('You attempted to edit an item that doesn’t exist. Perhaps it was deleted?')); |
|
| 1377 | - } |
|
| 1378 | - if ( ! empty($_GET['get-post-lock'])) { |
|
| 1379 | - wp_set_post_lock($post_id); |
|
| 1380 | - wp_redirect(get_edit_post_link($post_id, 'url')); |
|
| 1381 | - exit(); |
|
| 1382 | - } |
|
| 1383 | - |
|
| 1384 | - // template vars |
|
| 1385 | - $editing = true; |
|
| 1386 | - $post_ID = $post_id; |
|
| 1387 | - $post_type = $this->_cpt_routes[$this->_req_action]; |
|
| 1388 | - $post_type_object = $this->_cpt_object; |
|
| 1389 | - |
|
| 1390 | - if ( ! wp_check_post_lock($post->ID)) { |
|
| 1391 | - $active_post_lock = wp_set_post_lock($post->ID); |
|
| 1392 | - //wp_enqueue_script('autosave'); |
|
| 1393 | - } |
|
| 1394 | - $title = $this->_cpt_object->labels->edit_item; |
|
| 1395 | - add_action('admin_footer', '_admin_notice_post_locked'); |
|
| 1396 | - if (isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 1397 | - && ! isset($this->_labels['hide_add_button_on_cpt_route'][$this->_req_data['action']]) |
|
| 1398 | - ) { |
|
| 1399 | - $create_new_action = apply_filters('FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action', |
|
| 1400 | - 'create_new', $this); |
|
| 1401 | - $post_new_file = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1402 | - 'action' => $create_new_action, |
|
| 1403 | - 'page' => $this->page_slug, |
|
| 1404 | - ), 'admin.php'); |
|
| 1405 | - } |
|
| 1406 | - if (post_type_supports($this->_cpt_routes[$this->_req_action], 'comments')) { |
|
| 1407 | - wp_enqueue_script('admin-comments'); |
|
| 1408 | - enqueue_comment_hotkeys_js(); |
|
| 1409 | - } |
|
| 1410 | - add_action('admin_print_styles', array($this, 'add_new_admin_page_global')); |
|
| 1411 | - //modify the default editor title field with default title. |
|
| 1412 | - add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10); |
|
| 1413 | - include_once WP_ADMIN_PATH . 'edit-form-advanced.php'; |
|
| 1414 | - } |
|
| 1415 | - |
|
| 1416 | - |
|
| 1417 | - |
|
| 1418 | - /** |
|
| 1419 | - * some getters |
|
| 1420 | - */ |
|
| 1421 | - /** |
|
| 1422 | - * This returns the protected _cpt_model_obj property |
|
| 1423 | - * |
|
| 1424 | - * @return EE_CPT_Base |
|
| 1425 | - */ |
|
| 1426 | - public function get_cpt_model_obj() |
|
| 1427 | - { |
|
| 1428 | - return $this->_cpt_model_obj; |
|
| 1429 | - } |
|
| 1359 | + } |
|
| 1360 | + |
|
| 1361 | + |
|
| 1362 | + |
|
| 1363 | + /** |
|
| 1364 | + * default method for the 'edit' route for cpt admin pages |
|
| 1365 | + * For reference on what to put in here, refer to wp-admin/post.php |
|
| 1366 | + * |
|
| 1367 | + * @access protected |
|
| 1368 | + * @return string template for edit cpt form |
|
| 1369 | + */ |
|
| 1370 | + protected function _edit_cpt_item() |
|
| 1371 | + { |
|
| 1372 | + global $post, $title, $is_IE, $post_type, $post_type_object; |
|
| 1373 | + $post_id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null; |
|
| 1374 | + $post = ! empty($post_id) ? get_post($post_id, OBJECT, 'edit') : null; |
|
| 1375 | + if (empty ($post)) { |
|
| 1376 | + wp_die(__('You attempted to edit an item that doesn’t exist. Perhaps it was deleted?')); |
|
| 1377 | + } |
|
| 1378 | + if ( ! empty($_GET['get-post-lock'])) { |
|
| 1379 | + wp_set_post_lock($post_id); |
|
| 1380 | + wp_redirect(get_edit_post_link($post_id, 'url')); |
|
| 1381 | + exit(); |
|
| 1382 | + } |
|
| 1383 | + |
|
| 1384 | + // template vars |
|
| 1385 | + $editing = true; |
|
| 1386 | + $post_ID = $post_id; |
|
| 1387 | + $post_type = $this->_cpt_routes[$this->_req_action]; |
|
| 1388 | + $post_type_object = $this->_cpt_object; |
|
| 1389 | + |
|
| 1390 | + if ( ! wp_check_post_lock($post->ID)) { |
|
| 1391 | + $active_post_lock = wp_set_post_lock($post->ID); |
|
| 1392 | + //wp_enqueue_script('autosave'); |
|
| 1393 | + } |
|
| 1394 | + $title = $this->_cpt_object->labels->edit_item; |
|
| 1395 | + add_action('admin_footer', '_admin_notice_post_locked'); |
|
| 1396 | + if (isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 1397 | + && ! isset($this->_labels['hide_add_button_on_cpt_route'][$this->_req_data['action']]) |
|
| 1398 | + ) { |
|
| 1399 | + $create_new_action = apply_filters('FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action', |
|
| 1400 | + 'create_new', $this); |
|
| 1401 | + $post_new_file = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1402 | + 'action' => $create_new_action, |
|
| 1403 | + 'page' => $this->page_slug, |
|
| 1404 | + ), 'admin.php'); |
|
| 1405 | + } |
|
| 1406 | + if (post_type_supports($this->_cpt_routes[$this->_req_action], 'comments')) { |
|
| 1407 | + wp_enqueue_script('admin-comments'); |
|
| 1408 | + enqueue_comment_hotkeys_js(); |
|
| 1409 | + } |
|
| 1410 | + add_action('admin_print_styles', array($this, 'add_new_admin_page_global')); |
|
| 1411 | + //modify the default editor title field with default title. |
|
| 1412 | + add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10); |
|
| 1413 | + include_once WP_ADMIN_PATH . 'edit-form-advanced.php'; |
|
| 1414 | + } |
|
| 1415 | + |
|
| 1416 | + |
|
| 1417 | + |
|
| 1418 | + /** |
|
| 1419 | + * some getters |
|
| 1420 | + */ |
|
| 1421 | + /** |
|
| 1422 | + * This returns the protected _cpt_model_obj property |
|
| 1423 | + * |
|
| 1424 | + * @return EE_CPT_Base |
|
| 1425 | + */ |
|
| 1426 | + public function get_cpt_model_obj() |
|
| 1427 | + { |
|
| 1428 | + return $this->_cpt_model_obj; |
|
| 1429 | + } |
|
| 1430 | 1430 | |
| 1431 | 1431 | } |
@@ -235,7 +235,7 @@ discard block |
||
| 235 | 235 | */ |
| 236 | 236 | protected function _register_autosave_containers($ids) |
| 237 | 237 | { |
| 238 | - $this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids); |
|
| 238 | + $this->_autosave_containers = array_merge($this->_autosave_fields, (array) $ids); |
|
| 239 | 239 | } |
| 240 | 240 | |
| 241 | 241 | |
@@ -279,7 +279,7 @@ discard block |
||
| 279 | 279 | //filter _autosave_containers |
| 280 | 280 | $containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers', |
| 281 | 281 | $this->_autosave_containers, $this); |
| 282 | - $containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers', |
|
| 282 | + $containers = apply_filters('FHEE__EE_Admin_Page_CPT__'.get_class($this).'___load_autosave_scripts_styles__containers', |
|
| 283 | 283 | $containers, $this); |
| 284 | 284 | |
| 285 | 285 | wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS', |
@@ -369,7 +369,7 @@ discard block |
||
| 369 | 369 | parent::_load_page_dependencies(); |
| 370 | 370 | //notice we are ALSO going to load the pagenow hook set for this route (see _before_page_setup for the reset of the pagenow global ). This is for any plugins that are doing things properly and hooking into the load page hook for core wp cpt routes. |
| 371 | 371 | global $pagenow; |
| 372 | - do_action('load-' . $pagenow); |
|
| 372 | + do_action('load-'.$pagenow); |
|
| 373 | 373 | $this->modify_current_screen(); |
| 374 | 374 | add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30); |
| 375 | 375 | //we route REALLY early. |
@@ -400,8 +400,8 @@ discard block |
||
| 400 | 400 | 'admin.php?page=espresso_registrations&action=contact_list', |
| 401 | 401 | ), |
| 402 | 402 | 1 => array( |
| 403 | - 'edit.php?post_type=' . $this->_cpt_object->name, |
|
| 404 | - 'admin.php?page=' . $this->_cpt_object->name, |
|
| 403 | + 'edit.php?post_type='.$this->_cpt_object->name, |
|
| 404 | + 'admin.php?page='.$this->_cpt_object->name, |
|
| 405 | 405 | ), |
| 406 | 406 | ); |
| 407 | 407 | foreach ($routes_to_match as $route_matches) { |
@@ -429,7 +429,7 @@ discard block |
||
| 429 | 429 | $cpt_has_support = ! empty($cpt_args['page_templates']); |
| 430 | 430 | |
| 431 | 431 | //if the installed version of WP is > 4.7 we do some additional checks. |
| 432 | - if (EE_Recommended_Versions::check_wp_version('4.7','>=')) { |
|
| 432 | + if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) { |
|
| 433 | 433 | $post_templates = wp_get_theme()->get_post_templates(); |
| 434 | 434 | //if there are $post_templates for this cpt, then we return false for this method because |
| 435 | 435 | //that means we aren't going to load our page template manager and leave that up to the native |
@@ -452,7 +452,7 @@ discard block |
||
| 452 | 452 | global $post; |
| 453 | 453 | $template = ''; |
| 454 | 454 | |
| 455 | - if (EE_Recommended_Versions::check_wp_version('4.7','>=')) { |
|
| 455 | + if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) { |
|
| 456 | 456 | $page_template_count = count(get_page_templates()); |
| 457 | 457 | } else { |
| 458 | 458 | $page_template_count = count(get_page_templates($post)); |
@@ -489,7 +489,7 @@ discard block |
||
| 489 | 489 | $post = get_post($id); |
| 490 | 490 | if ('publish' != get_post_status($post)) { |
| 491 | 491 | //include shims for the `get_preview_post_link` function |
| 492 | - require_once( EE_CORE . 'wordpress-shims.php' ); |
|
| 492 | + require_once(EE_CORE.'wordpress-shims.php'); |
|
| 493 | 493 | $return .= '<span_id="view-post-btn"><a target="_blank" href="' |
| 494 | 494 | . get_preview_post_link($id) |
| 495 | 495 | . '" class="button button-small">' |
@@ -527,7 +527,7 @@ discard block |
||
| 527 | 527 | $template_args['statuses'] = $statuses; |
| 528 | 528 | } |
| 529 | 529 | |
| 530 | - $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php'; |
|
| 530 | + $template = EE_ADMIN_TEMPLATE.'status_dropdown.template.php'; |
|
| 531 | 531 | EEH_Template::display_template($template, $template_args); |
| 532 | 532 | } |
| 533 | 533 | |
@@ -572,13 +572,13 @@ discard block |
||
| 572 | 572 | define('DOING_AUTOSAVE', true); |
| 573 | 573 | } |
| 574 | 574 | //if we made it here then the nonce checked out. Let's run our methods and actions |
| 575 | - if (method_exists($this, '_ee_autosave_' . $this->_current_view)) { |
|
| 576 | - call_user_func(array($this, '_ee_autosave_' . $this->_current_view)); |
|
| 575 | + if (method_exists($this, '_ee_autosave_'.$this->_current_view)) { |
|
| 576 | + call_user_func(array($this, '_ee_autosave_'.$this->_current_view)); |
|
| 577 | 577 | } else { |
| 578 | 578 | $this->_template_args['success'] = true; |
| 579 | 579 | } |
| 580 | 580 | do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this); |
| 581 | - do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this); |
|
| 581 | + do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_'.get_class($this), $this); |
|
| 582 | 582 | //now let's return json |
| 583 | 583 | $this->_return_json(); |
| 584 | 584 | } |
@@ -969,7 +969,7 @@ discard block |
||
| 969 | 969 | //global action |
| 970 | 970 | do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id); |
| 971 | 971 | //class specific action so you can limit hooking into a specific page. |
| 972 | - do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id); |
|
| 972 | + do_action('AHEE_EE_Admin_Page_CPT_'.get_class($this).'__restore_revision', $post_id, $revision_id); |
|
| 973 | 973 | } |
| 974 | 974 | |
| 975 | 975 | |
@@ -1047,7 +1047,7 @@ discard block |
||
| 1047 | 1047 | if ( ! empty($id) && '' != get_option('permalink_structure')) { |
| 1048 | 1048 | $post = get_post($id); |
| 1049 | 1049 | if (isset($post->post_type) && $this->page_slug == $post->post_type) { |
| 1050 | - $shortlink = home_url('?p=' . $post->ID); |
|
| 1050 | + $shortlink = home_url('?p='.$post->ID); |
|
| 1051 | 1051 | } |
| 1052 | 1052 | } |
| 1053 | 1053 | return $shortlink; |
@@ -1082,11 +1082,11 @@ discard block |
||
| 1082 | 1082 | */ |
| 1083 | 1083 | public function cpt_post_form_hidden_input() |
| 1084 | 1084 | { |
| 1085 | - echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />'; |
|
| 1085 | + echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="'.$this->_admin_base_url.'" />'; |
|
| 1086 | 1086 | //we're also going to add the route value and the current page so we can direct autosave parsing correctly |
| 1087 | 1087 | echo '<div id="ee-cpt-hidden-inputs">'; |
| 1088 | - echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />'; |
|
| 1089 | - echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />'; |
|
| 1088 | + echo '<input type="hidden" id="current_route" name="current_route" value="'.$this->_current_view.'" />'; |
|
| 1089 | + echo '<input type="hidden" id="current_page" name="current_page" value="'.$this->page_slug.'" />'; |
|
| 1090 | 1090 | echo '</div>'; |
| 1091 | 1091 | } |
| 1092 | 1092 | |
@@ -1170,7 +1170,7 @@ discard block |
||
| 1170 | 1170 | } |
| 1171 | 1171 | $this->_set_model_object($this->_req_data['post'], true); |
| 1172 | 1172 | //returns something like `trash_event` or `trash_attendee` or `trash_venue` |
| 1173 | - $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj))); |
|
| 1173 | + $action = 'trash_'.str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj))); |
|
| 1174 | 1174 | |
| 1175 | 1175 | return EE_Admin_Page::add_query_args_and_nonce( |
| 1176 | 1176 | array( |
@@ -1281,39 +1281,39 @@ discard block |
||
| 1281 | 1281 | 1 => sprintf( |
| 1282 | 1282 | __('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'), |
| 1283 | 1283 | $this->_cpt_object->labels->singular_name, |
| 1284 | - '<a href="' . esc_url(get_permalink($id)) . '">', |
|
| 1284 | + '<a href="'.esc_url(get_permalink($id)).'">', |
|
| 1285 | 1285 | '</a>' |
| 1286 | 1286 | ), |
| 1287 | 1287 | 2 => __('Custom field updated'), |
| 1288 | 1288 | 3 => __('Custom field deleted.'), |
| 1289 | 1289 | 4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name), |
| 1290 | 1290 | 5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'), |
| 1291 | - $this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false)) |
|
| 1291 | + $this->_cpt_object->labels->singular_name, wp_post_revision_title((int) $_GET['revision'], false)) |
|
| 1292 | 1292 | : false, |
| 1293 | 1293 | 6 => sprintf( |
| 1294 | 1294 | __('%1$s published. %2$sView %1$s%3$s', 'event_espresso'), |
| 1295 | 1295 | $this->_cpt_object->labels->singular_name, |
| 1296 | - '<a href="' . esc_url(get_permalink($id)) . '">', |
|
| 1296 | + '<a href="'.esc_url(get_permalink($id)).'">', |
|
| 1297 | 1297 | '</a>' |
| 1298 | 1298 | ), |
| 1299 | 1299 | 7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name), |
| 1300 | 1300 | 8 => sprintf( |
| 1301 | 1301 | __('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'), |
| 1302 | 1302 | $this->_cpt_object->labels->singular_name, |
| 1303 | - '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">', |
|
| 1303 | + '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))).'">', |
|
| 1304 | 1304 | '</a>' |
| 1305 | 1305 | ), |
| 1306 | 1306 | 9 => sprintf( |
| 1307 | 1307 | __('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'), |
| 1308 | 1308 | $this->_cpt_object->labels->singular_name, |
| 1309 | - '<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>', |
|
| 1310 | - '<a target="_blank" href="' . esc_url(get_permalink($id)), |
|
| 1309 | + '<strong>'.date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)).'</strong>', |
|
| 1310 | + '<a target="_blank" href="'.esc_url(get_permalink($id)), |
|
| 1311 | 1311 | '</a>' |
| 1312 | 1312 | ), |
| 1313 | 1313 | 10 => sprintf( |
| 1314 | 1314 | __('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'), |
| 1315 | 1315 | $this->_cpt_object->labels->singular_name, |
| 1316 | - '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))), |
|
| 1316 | + '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))), |
|
| 1317 | 1317 | '</a>' |
| 1318 | 1318 | ), |
| 1319 | 1319 | ); |
@@ -1343,7 +1343,7 @@ discard block |
||
| 1343 | 1343 | add_action('admin_print_styles', array($this, 'add_new_admin_page_global')); |
| 1344 | 1344 | //modify the default editor title field with default title. |
| 1345 | 1345 | add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10); |
| 1346 | - include_once WP_ADMIN_PATH . 'edit-form-advanced.php'; |
|
| 1346 | + include_once WP_ADMIN_PATH.'edit-form-advanced.php'; |
|
| 1347 | 1347 | } |
| 1348 | 1348 | |
| 1349 | 1349 | |
@@ -1410,7 +1410,7 @@ discard block |
||
| 1410 | 1410 | add_action('admin_print_styles', array($this, 'add_new_admin_page_global')); |
| 1411 | 1411 | //modify the default editor title field with default title. |
| 1412 | 1412 | add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10); |
| 1413 | - include_once WP_ADMIN_PATH . 'edit-form-advanced.php'; |
|
| 1413 | + include_once WP_ADMIN_PATH.'edit-form-advanced.php'; |
|
| 1414 | 1414 | } |
| 1415 | 1415 | |
| 1416 | 1416 | |
@@ -1042,88 +1042,88 @@ |
||
| 1042 | 1042 | class EE_Event_List_Query extends WP_Query |
| 1043 | 1043 | { |
| 1044 | 1044 | |
| 1045 | - private $title; |
|
| 1046 | - |
|
| 1047 | - private $css_class; |
|
| 1048 | - |
|
| 1049 | - private $category_slug; |
|
| 1050 | - |
|
| 1051 | - /** |
|
| 1052 | - * EE_Event_List_Query constructor. |
|
| 1053 | - * |
|
| 1054 | - * @param array $args |
|
| 1055 | - */ |
|
| 1056 | - public function __construct($args = array()) |
|
| 1057 | - { |
|
| 1058 | - \EE_Error::doing_it_wrong( |
|
| 1059 | - __METHOD__, |
|
| 1060 | - __( |
|
| 1061 | - 'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.', |
|
| 1062 | - 'event_espresso' |
|
| 1063 | - ), |
|
| 1064 | - '4.9.27', |
|
| 1065 | - '5.0.0' |
|
| 1066 | - ); |
|
| 1067 | - $this->title = isset($args['title']) ? $args['title'] : ''; |
|
| 1068 | - $this->css_class = isset($args['css_class']) ? $args['css_class'] : ''; |
|
| 1069 | - $this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : ''; |
|
| 1070 | - $limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10; |
|
| 1071 | - // the current "page" we are viewing |
|
| 1072 | - $paged = max(1, get_query_var('paged')); |
|
| 1073 | - // Force these args |
|
| 1074 | - $args = array_merge( |
|
| 1075 | - $args, array( |
|
| 1076 | - 'post_type' => 'espresso_events', |
|
| 1077 | - 'posts_per_page' => $limit, |
|
| 1078 | - 'update_post_term_cache' => false, |
|
| 1079 | - 'update_post_meta_cache' => false, |
|
| 1080 | - 'paged' => $paged, |
|
| 1081 | - 'offset' => ($paged - 1) * $limit |
|
| 1082 | - ) |
|
| 1083 | - ); |
|
| 1084 | - // run the query |
|
| 1085 | - parent::__construct($args); |
|
| 1086 | - } |
|
| 1087 | - |
|
| 1088 | - |
|
| 1089 | - |
|
| 1090 | - /** |
|
| 1091 | - * event_list_title |
|
| 1092 | - * |
|
| 1093 | - * @param string $event_list_title |
|
| 1094 | - * @return string |
|
| 1095 | - */ |
|
| 1096 | - public function event_list_title($event_list_title = '') |
|
| 1097 | - { |
|
| 1098 | - if (! empty($this->title)) { |
|
| 1099 | - return $this->title; |
|
| 1100 | - } |
|
| 1101 | - return $event_list_title; |
|
| 1102 | - } |
|
| 1103 | - |
|
| 1104 | - |
|
| 1105 | - |
|
| 1106 | - /** |
|
| 1107 | - * event_list_css |
|
| 1108 | - * |
|
| 1109 | - * @param string $event_list_css |
|
| 1110 | - * @return string |
|
| 1111 | - */ |
|
| 1112 | - public function event_list_css($event_list_css = '') |
|
| 1113 | - { |
|
| 1114 | - $event_list_css .= ! empty($event_list_css) |
|
| 1115 | - ? ' ' |
|
| 1116 | - : ''; |
|
| 1117 | - $event_list_css .= ! empty($this->css_class) |
|
| 1118 | - ? $this->css_class |
|
| 1119 | - : ''; |
|
| 1120 | - $event_list_css .= ! empty($event_list_css) |
|
| 1121 | - ? ' ' |
|
| 1122 | - : ''; |
|
| 1123 | - $event_list_css .= ! empty($this->category_slug) |
|
| 1124 | - ? $this->category_slug |
|
| 1125 | - : ''; |
|
| 1126 | - return $event_list_css; |
|
| 1127 | - } |
|
| 1045 | + private $title; |
|
| 1046 | + |
|
| 1047 | + private $css_class; |
|
| 1048 | + |
|
| 1049 | + private $category_slug; |
|
| 1050 | + |
|
| 1051 | + /** |
|
| 1052 | + * EE_Event_List_Query constructor. |
|
| 1053 | + * |
|
| 1054 | + * @param array $args |
|
| 1055 | + */ |
|
| 1056 | + public function __construct($args = array()) |
|
| 1057 | + { |
|
| 1058 | + \EE_Error::doing_it_wrong( |
|
| 1059 | + __METHOD__, |
|
| 1060 | + __( |
|
| 1061 | + 'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.', |
|
| 1062 | + 'event_espresso' |
|
| 1063 | + ), |
|
| 1064 | + '4.9.27', |
|
| 1065 | + '5.0.0' |
|
| 1066 | + ); |
|
| 1067 | + $this->title = isset($args['title']) ? $args['title'] : ''; |
|
| 1068 | + $this->css_class = isset($args['css_class']) ? $args['css_class'] : ''; |
|
| 1069 | + $this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : ''; |
|
| 1070 | + $limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10; |
|
| 1071 | + // the current "page" we are viewing |
|
| 1072 | + $paged = max(1, get_query_var('paged')); |
|
| 1073 | + // Force these args |
|
| 1074 | + $args = array_merge( |
|
| 1075 | + $args, array( |
|
| 1076 | + 'post_type' => 'espresso_events', |
|
| 1077 | + 'posts_per_page' => $limit, |
|
| 1078 | + 'update_post_term_cache' => false, |
|
| 1079 | + 'update_post_meta_cache' => false, |
|
| 1080 | + 'paged' => $paged, |
|
| 1081 | + 'offset' => ($paged - 1) * $limit |
|
| 1082 | + ) |
|
| 1083 | + ); |
|
| 1084 | + // run the query |
|
| 1085 | + parent::__construct($args); |
|
| 1086 | + } |
|
| 1087 | + |
|
| 1088 | + |
|
| 1089 | + |
|
| 1090 | + /** |
|
| 1091 | + * event_list_title |
|
| 1092 | + * |
|
| 1093 | + * @param string $event_list_title |
|
| 1094 | + * @return string |
|
| 1095 | + */ |
|
| 1096 | + public function event_list_title($event_list_title = '') |
|
| 1097 | + { |
|
| 1098 | + if (! empty($this->title)) { |
|
| 1099 | + return $this->title; |
|
| 1100 | + } |
|
| 1101 | + return $event_list_title; |
|
| 1102 | + } |
|
| 1103 | + |
|
| 1104 | + |
|
| 1105 | + |
|
| 1106 | + /** |
|
| 1107 | + * event_list_css |
|
| 1108 | + * |
|
| 1109 | + * @param string $event_list_css |
|
| 1110 | + * @return string |
|
| 1111 | + */ |
|
| 1112 | + public function event_list_css($event_list_css = '') |
|
| 1113 | + { |
|
| 1114 | + $event_list_css .= ! empty($event_list_css) |
|
| 1115 | + ? ' ' |
|
| 1116 | + : ''; |
|
| 1117 | + $event_list_css .= ! empty($this->css_class) |
|
| 1118 | + ? $this->css_class |
|
| 1119 | + : ''; |
|
| 1120 | + $event_list_css .= ! empty($event_list_css) |
|
| 1121 | + ? ' ' |
|
| 1122 | + : ''; |
|
| 1123 | + $event_list_css .= ! empty($this->category_slug) |
|
| 1124 | + ? $this->category_slug |
|
| 1125 | + : ''; |
|
| 1126 | + return $event_list_css; |
|
| 1127 | + } |
|
| 1128 | 1128 | |
| 1129 | 1129 | } |
@@ -1,6 +1,6 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | -if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) { |
|
| 3 | - exit( 'No direct script access allowed' ); |
|
| 2 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
| 3 | + exit('No direct script access allowed'); |
|
| 4 | 4 | } |
| 5 | 5 | /** |
| 6 | 6 | * ************************************************************************ |
@@ -43,8 +43,8 @@ discard block |
||
| 43 | 43 | $action_or_filter = 'action' |
| 44 | 44 | ) { |
| 45 | 45 | $action_or_filter = $action_or_filter === 'action' |
| 46 | - ? esc_html__( 'action', 'event_espresso' ) |
|
| 47 | - : esc_html__( 'filter', 'event_espresso' ); |
|
| 46 | + ? esc_html__('action', 'event_espresso') |
|
| 47 | + : esc_html__('filter', 'event_espresso'); |
|
| 48 | 48 | EE_Error::doing_it_wrong( |
| 49 | 49 | $deprecated_filter, |
| 50 | 50 | sprintf( |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | * @param \EE_Checkout $checkout |
| 69 | 69 | * @return string |
| 70 | 70 | */ |
| 71 | -function ee_deprecated__registration_checkout__button_text( $submit_button_text, EE_Checkout $checkout ) { |
|
| 71 | +function ee_deprecated__registration_checkout__button_text($submit_button_text, EE_Checkout $checkout) { |
|
| 72 | 72 | // list of old filters |
| 73 | 73 | $deprecated_filters = array( |
| 74 | 74 | 'update_registration_details' => true, |
@@ -78,16 +78,16 @@ discard block |
||
| 78 | 78 | 'proceed_to' => true, |
| 79 | 79 | ); |
| 80 | 80 | // loop thru and call doing_it_wrong() or remove any that aren't being used |
| 81 | - foreach ( $deprecated_filters as $deprecated_filter => $on ) { |
|
| 81 | + foreach ($deprecated_filters as $deprecated_filter => $on) { |
|
| 82 | 82 | // was this filter called ? |
| 83 | - if ( has_action( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter )) { |
|
| 83 | + if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter)) { |
|
| 84 | 84 | // only display doing_it_wrong() notice to Event Admins during non-AJAX requests |
| 85 | - if ( EE_Registry::instance()->CAP->current_user_can( 'ee_read_ee', 'hide_doing_it_wrong_for_deprecated_SPCO_filter' ) && ! defined( 'DOING_AJAX' ) ) { |
|
| 85 | + if (EE_Registry::instance()->CAP->current_user_can('ee_read_ee', 'hide_doing_it_wrong_for_deprecated_SPCO_filter') && ! defined('DOING_AJAX')) { |
|
| 86 | 86 | EE_Error::doing_it_wrong( |
| 87 | - 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter, |
|
| 87 | + 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter, |
|
| 88 | 88 | sprintf( |
| 89 | - __( 'The %1$s filter is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"', 'event_espresso' ), |
|
| 90 | - 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter, |
|
| 89 | + __('The %1$s filter is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"', 'event_espresso'), |
|
| 90 | + 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter, |
|
| 91 | 91 | '<br />', |
| 92 | 92 | 'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', |
| 93 | 93 | '/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php' |
@@ -96,24 +96,24 @@ discard block |
||
| 96 | 96 | ); |
| 97 | 97 | } |
| 98 | 98 | } else { |
| 99 | - unset( $deprecated_filters[ $deprecated_filter ] ); |
|
| 99 | + unset($deprecated_filters[$deprecated_filter]); |
|
| 100 | 100 | } |
| 101 | 101 | } |
| 102 | - if ( ! empty( $deprecated_filters )) { |
|
| 103 | - |
|
| 104 | - if ( $checkout->current_step->slug() == 'attendee_information' && $checkout->revisit && isset( $deprecated_filters[ 'update_registration_details' ] )) { |
|
| 105 | - $submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details', $submit_button_text ); |
|
| 106 | - } else if ( $checkout->current_step->slug() == 'payment_options' && $checkout->revisit && isset( $deprecated_filters[ 'process_payment' ] ) ) { |
|
| 107 | - $submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment', $submit_button_text ); |
|
| 108 | - } else if ( $checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug() == 'finalize_registration' && isset( $deprecated_filters[ 'finalize_registration' ] ) ) { |
|
| 109 | - $submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration', $submit_button_text ); |
|
| 102 | + if ( ! empty($deprecated_filters)) { |
|
| 103 | + |
|
| 104 | + if ($checkout->current_step->slug() == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) { |
|
| 105 | + $submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details', $submit_button_text); |
|
| 106 | + } else if ($checkout->current_step->slug() == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) { |
|
| 107 | + $submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment', $submit_button_text); |
|
| 108 | + } else if ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug() == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) { |
|
| 109 | + $submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration', $submit_button_text); |
|
| 110 | 110 | } |
| 111 | - if ( $checkout->next_step instanceof EE_SPCO_Reg_Step ) { |
|
| 112 | - if ( $checkout->payment_required() && $checkout->next_step->slug() == 'payment_options' && isset( $deprecated_filters[ 'and_proceed_to_payment' ] ) ) { |
|
| 113 | - $submit_button_text .= apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment', $submit_button_text ); |
|
| 111 | + if ($checkout->next_step instanceof EE_SPCO_Reg_Step) { |
|
| 112 | + if ($checkout->payment_required() && $checkout->next_step->slug() == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) { |
|
| 113 | + $submit_button_text .= apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment', $submit_button_text); |
|
| 114 | 114 | } |
| 115 | - if ( $checkout->next_step->slug() != 'finalize_registration' && ! $checkout->revisit && isset( $deprecated_filters[ 'proceed_to' ] ) ) { |
|
| 116 | - $submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to', $submit_button_text ) . $checkout->next_step->name(); |
|
| 115 | + if ($checkout->next_step->slug() != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) { |
|
| 116 | + $submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to', $submit_button_text).$checkout->next_step->name(); |
|
| 117 | 117 | } |
| 118 | 118 | } |
| 119 | 119 | |
@@ -121,7 +121,7 @@ discard block |
||
| 121 | 121 | return $submit_button_text; |
| 122 | 122 | |
| 123 | 123 | } |
| 124 | -add_filter( 'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', 'ee_deprecated__registration_checkout__button_text', 10, 2 ); |
|
| 124 | +add_filter('FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', 'ee_deprecated__registration_checkout__button_text', 10, 2); |
|
| 125 | 125 | |
| 126 | 126 | |
| 127 | 127 | |
@@ -132,16 +132,16 @@ discard block |
||
| 132 | 132 | * @param \EE_Checkout $checkout |
| 133 | 133 | * @param boolean $status_updates |
| 134 | 134 | */ |
| 135 | -function ee_deprecated_finalize_transaction( EE_Checkout $checkout, $status_updates ) { |
|
| 135 | +function ee_deprecated_finalize_transaction(EE_Checkout $checkout, $status_updates) { |
|
| 136 | 136 | $action_ref = NULL; |
| 137 | - $action_ref = has_action( 'AHEE__EE_Transaction__finalize__new_transaction' ) ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref; |
|
| 138 | - $action_ref = has_action( 'AHEE__EE_Transaction__finalize__all_transaction' ) ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref; |
|
| 139 | - if ( $action_ref ) { |
|
| 137 | + $action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction') ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref; |
|
| 138 | + $action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction') ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref; |
|
| 139 | + if ($action_ref) { |
|
| 140 | 140 | |
| 141 | 141 | EE_Error::doing_it_wrong( |
| 142 | 142 | $action_ref, |
| 143 | 143 | sprintf( |
| 144 | - __( 'This action is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"', 'event_espresso' ), |
|
| 144 | + __('This action is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"', 'event_espresso'), |
|
| 145 | 145 | '<br />', |
| 146 | 146 | '/core/business/EE_Transaction_Processor.class.php', |
| 147 | 147 | 'AHEE__EE_Transaction_Processor__finalize', |
@@ -151,39 +151,39 @@ discard block |
||
| 151 | 151 | ), |
| 152 | 152 | '4.6.0' |
| 153 | 153 | ); |
| 154 | - switch ( $action_ref ) { |
|
| 154 | + switch ($action_ref) { |
|
| 155 | 155 | case 'AHEE__EE_Transaction__finalize__new_transaction' : |
| 156 | - do_action( 'AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, $checkout->admin_request ); |
|
| 156 | + do_action('AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, $checkout->admin_request); |
|
| 157 | 157 | break; |
| 158 | 158 | case 'AHEE__EE_Transaction__finalize__all_transaction' : |
| 159 | - do_action( 'AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, array( 'new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates ), $checkout->admin_request ); |
|
| 159 | + do_action('AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates), $checkout->admin_request); |
|
| 160 | 160 | break; |
| 161 | 161 | } |
| 162 | 162 | } |
| 163 | 163 | } |
| 164 | -add_action( 'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed', 'ee_deprecated_finalize_transaction', 10, 2 ); |
|
| 164 | +add_action('AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed', 'ee_deprecated_finalize_transaction', 10, 2); |
|
| 165 | 165 | /** |
| 166 | 166 | * ee_deprecated_finalize_registration |
| 167 | 167 | * |
| 168 | 168 | * @param EE_Registration $registration |
| 169 | 169 | */ |
| 170 | -function ee_deprecated_finalize_registration( EE_Registration $registration ) { |
|
| 171 | - $action_ref = has_action( 'AHEE__EE_Registration__finalize__update_and_new_reg' ) ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : NULL; |
|
| 172 | - if ( $action_ref ) { |
|
| 170 | +function ee_deprecated_finalize_registration(EE_Registration $registration) { |
|
| 171 | + $action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg') ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : NULL; |
|
| 172 | + if ($action_ref) { |
|
| 173 | 173 | EE_Error::doing_it_wrong( |
| 174 | 174 | $action_ref, |
| 175 | 175 | sprintf( |
| 176 | - __( 'This action is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"', 'event_espresso' ), |
|
| 176 | + __('This action is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"', 'event_espresso'), |
|
| 177 | 177 | '<br />', |
| 178 | 178 | '/core/business/EE_Registration_Processor.class.php', |
| 179 | 179 | 'AHEE__EE_Registration_Processor__trigger_registration_status_changed_hook' |
| 180 | 180 | ), |
| 181 | 181 | '4.6.0' |
| 182 | 182 | ); |
| 183 | - do_action( 'AHEE__EE_Registration__finalize__update_and_new_reg', $registration, ( is_admin() && ! ( defined( 'DOING_AJAX' ) && DOING_AJAX ))); |
|
| 183 | + do_action('AHEE__EE_Registration__finalize__update_and_new_reg', $registration, (is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX))); |
|
| 184 | 184 | } |
| 185 | 185 | } |
| 186 | -add_action( 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications', 'ee_deprecated_finalize_registration', 10, 1 ); |
|
| 186 | +add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications', 'ee_deprecated_finalize_registration', 10, 1); |
|
| 187 | 187 | |
| 188 | 188 | |
| 189 | 189 | |
@@ -191,7 +191,7 @@ discard block |
||
| 191 | 191 | * Called after EED_Module::set_hooks() and EED_Module::set_admin_hooks() was called. |
| 192 | 192 | * Checks if any deprecated hooks were hooked-into and provide doing_it_wrong messages appropriately. |
| 193 | 193 | */ |
| 194 | -function ee_deprecated_hooks(){ |
|
| 194 | +function ee_deprecated_hooks() { |
|
| 195 | 195 | /** |
| 196 | 196 | * @var $hooks array where keys are hook names, and their values are array{ |
| 197 | 197 | * @type string $version when deprecated |
@@ -202,25 +202,25 @@ discard block |
||
| 202 | 202 | $hooks = array( |
| 203 | 203 | 'AHEE__EE_System___do_setup_validations' => array( |
| 204 | 204 | 'version' => '4.6.0', |
| 205 | - 'alternative' => __( 'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)', 'event_espresso' ), |
|
| 205 | + 'alternative' => __('Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)', 'event_espresso'), |
|
| 206 | 206 | 'still_works' => FALSE |
| 207 | 207 | ) |
| 208 | 208 | ); |
| 209 | - foreach( $hooks as $name => $deprecation_info ){ |
|
| 210 | - if( has_action( $name ) ){ |
|
| 209 | + foreach ($hooks as $name => $deprecation_info) { |
|
| 210 | + if (has_action($name)) { |
|
| 211 | 211 | EE_Error::doing_it_wrong( |
| 212 | 212 | $name, |
| 213 | 213 | sprintf( |
| 214 | - __('This filter is deprecated. %1$s%2$s','event_espresso'), |
|
| 215 | - $deprecation_info[ 'still_works' ] ? __('It *may* work as an attempt to build in backwards compatibility.', 'event_espresso') : __( 'It has been completely removed.', 'event_espresso' ), |
|
| 216 | - isset( $deprecation_info[ 'alternative' ] ) ? $deprecation_info[ 'alternative' ] : __( 'Please read the current EE4 documentation further or contact Support.', 'event_espresso' ) |
|
| 214 | + __('This filter is deprecated. %1$s%2$s', 'event_espresso'), |
|
| 215 | + $deprecation_info['still_works'] ? __('It *may* work as an attempt to build in backwards compatibility.', 'event_espresso') : __('It has been completely removed.', 'event_espresso'), |
|
| 216 | + isset($deprecation_info['alternative']) ? $deprecation_info['alternative'] : __('Please read the current EE4 documentation further or contact Support.', 'event_espresso') |
|
| 217 | 217 | ), |
| 218 | - isset( $deprecation_info[ 'version' ] ) ? $deprecation_info[ 'version' ] : __( 'recently', 'event_espresso' ) |
|
| 218 | + isset($deprecation_info['version']) ? $deprecation_info['version'] : __('recently', 'event_espresso') |
|
| 219 | 219 | ); |
| 220 | 220 | } |
| 221 | 221 | } |
| 222 | 222 | } |
| 223 | -add_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', 'ee_deprecated_hooks' ); |
|
| 223 | +add_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', 'ee_deprecated_hooks'); |
|
| 224 | 224 | |
| 225 | 225 | |
| 226 | 226 | |
@@ -231,9 +231,9 @@ discard block |
||
| 231 | 231 | * @return boolean |
| 232 | 232 | */ |
| 233 | 233 | function ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() { |
| 234 | - $in_use = has_filter( 'FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns' ) |
|
| 235 | - || has_action( 'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save' ); |
|
| 236 | - if( $in_use ) { |
|
| 234 | + $in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns') |
|
| 235 | + || has_action('AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save'); |
|
| 236 | + if ($in_use) { |
|
| 237 | 237 | $msg = __( |
| 238 | 238 | 'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.' |
| 239 | 239 | . 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,' |
@@ -242,18 +242,18 @@ discard block |
||
| 242 | 242 | 'event_espresso' ) |
| 243 | 243 | ; |
| 244 | 244 | EE_Error::doing_it_wrong( |
| 245 | - __CLASS__ . '::' . __FUNCTION__, |
|
| 245 | + __CLASS__.'::'.__FUNCTION__, |
|
| 246 | 246 | $msg, |
| 247 | 247 | '4.8.32.rc.000' |
| 248 | 248 | ); |
| 249 | 249 | //it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed |
| 250 | - if ( is_admin() && ! defined( 'DOING_AJAX' ) ) { |
|
| 251 | - EE_Error::add_error( $msg, __FILE__, __FUNCTION__, __LINE__ ); |
|
| 250 | + if (is_admin() && ! defined('DOING_AJAX')) { |
|
| 251 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 252 | 252 | } |
| 253 | 253 | } |
| 254 | 254 | return $in_use; |
| 255 | 255 | } |
| 256 | -add_action( 'AHEE__Registrations_Admin_Page___registration_details_metabox__start', 'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks' ); |
|
| 256 | +add_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', 'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks'); |
|
| 257 | 257 | |
| 258 | 258 | /** |
| 259 | 259 | * @deprecated since 4.8.32.rc.000 because it has issues on https://events.codebasehq.com/projects/event-espresso/tickets/9165 |
@@ -262,34 +262,34 @@ discard block |
||
| 262 | 262 | * @param EE_Admin_Page $admin_page |
| 263 | 263 | * @return void |
| 264 | 264 | */ |
| 265 | -function ee_deprecated_update_attendee_registration_form_old( $admin_page ) { |
|
| 265 | +function ee_deprecated_update_attendee_registration_form_old($admin_page) { |
|
| 266 | 266 | //check if the old hooks are in use. If not, do the default |
| 267 | - if( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
| 268 | - || ! $admin_page instanceof EE_Admin_Page ) { |
|
| 267 | + if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
| 268 | + || ! $admin_page instanceof EE_Admin_Page) { |
|
| 269 | 269 | return; |
| 270 | 270 | } |
| 271 | 271 | $req_data = $admin_page->get_request_data(); |
| 272 | - $qstns = isset( $req_data['qstn'] ) ? $req_data['qstn'] : FALSE; |
|
| 273 | - $REG_ID = isset( $req_data['_REG_ID'] ) ? absint( $req_data['_REG_ID'] ) : FALSE; |
|
| 274 | - $qstns = apply_filters( 'FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns ); |
|
| 275 | - if ( ! $REG_ID || ! $qstns ) { |
|
| 276 | - EE_Error::add_error( __('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__ ); |
|
| 272 | + $qstns = isset($req_data['qstn']) ? $req_data['qstn'] : FALSE; |
|
| 273 | + $REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : FALSE; |
|
| 274 | + $qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns); |
|
| 275 | + if ( ! $REG_ID || ! $qstns) { |
|
| 276 | + EE_Error::add_error(__('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 277 | 277 | } |
| 278 | 278 | $success = TRUE; |
| 279 | 279 | |
| 280 | 280 | // allow others to get in on this awesome fun :D |
| 281 | - do_action( 'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save', $REG_ID, $qstns ); |
|
| 281 | + do_action('AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save', $REG_ID, $qstns); |
|
| 282 | 282 | // loop thru questions... FINALLY!!! |
| 283 | 283 | |
| 284 | - foreach ( $qstns as $QST_ID => $qstn ) { |
|
| 284 | + foreach ($qstns as $QST_ID => $qstn) { |
|
| 285 | 285 | //if $qstn isn't an array then it doesn't already have an answer, so let's create the answer |
| 286 | - if ( !is_array($qstn) ) { |
|
| 287 | - $success = $this->_save_new_answer( $REG_ID, $QST_ID, $qstn); |
|
| 286 | + if ( ! is_array($qstn)) { |
|
| 287 | + $success = $this->_save_new_answer($REG_ID, $QST_ID, $qstn); |
|
| 288 | 288 | continue; |
| 289 | 289 | } |
| 290 | 290 | |
| 291 | 291 | |
| 292 | - foreach ( $qstn as $ANS_ID => $ANS_value ) { |
|
| 292 | + foreach ($qstn as $ANS_ID => $ANS_value) { |
|
| 293 | 293 | //get answer |
| 294 | 294 | $query_params = array( |
| 295 | 295 | 0 => array( |
@@ -300,7 +300,7 @@ discard block |
||
| 300 | 300 | ); |
| 301 | 301 | $answer = EEM_Answer::instance()->get_one($query_params); |
| 302 | 302 | //this MAY be an array but NOT have an answer because its multi select. If so then we need to create the answer |
| 303 | - if ( ! $answer instanceof EE_Answer ) { |
|
| 303 | + if ( ! $answer instanceof EE_Answer) { |
|
| 304 | 304 | $set_values = array( |
| 305 | 305 | 'QST_ID' => $QST_ID, |
| 306 | 306 | 'REG_ID' => $REG_ID, |
@@ -315,11 +315,11 @@ discard block |
||
| 315 | 315 | } |
| 316 | 316 | } |
| 317 | 317 | $what = __('Registration Form', 'event_espresso'); |
| 318 | - $route = $REG_ID ? array( 'action' => 'view_registration', '_REG_ID' => $REG_ID ) : array( 'action' => 'default' ); |
|
| 319 | - $admin_page->redirect_after_action( $success, $what, __('updated', 'event_espresso'), $route ); |
|
| 318 | + $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default'); |
|
| 319 | + $admin_page->redirect_after_action($success, $what, __('updated', 'event_espresso'), $route); |
|
| 320 | 320 | exit; |
| 321 | 321 | } |
| 322 | -add_action( 'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', 'ee_deprecated_update_attendee_registration_form_old', 10, 1 ); |
|
| 322 | +add_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', 'ee_deprecated_update_attendee_registration_form_old', 10, 1); |
|
| 323 | 323 | /** |
| 324 | 324 | * Render the registration admin page's custom questions area in the old fashion |
| 325 | 325 | * and firing the old hooks. When this method is removed, we can probably also |
@@ -332,31 +332,31 @@ discard block |
||
| 332 | 332 | * @return bool |
| 333 | 333 | * @throws \EE_Error |
| 334 | 334 | */ |
| 335 | -function ee_deprecated_reg_questions_meta_box_old( $do_default_action, $admin_page, $registration ) { |
|
| 335 | +function ee_deprecated_reg_questions_meta_box_old($do_default_action, $admin_page, $registration) { |
|
| 336 | 336 | //check if the old hooks are in use. If not, do the default |
| 337 | - if( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
| 338 | - || ! $admin_page instanceof EE_Admin_Page ) { |
|
| 337 | + if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
| 338 | + || ! $admin_page instanceof EE_Admin_Page) { |
|
| 339 | 339 | return $do_default_action; |
| 340 | 340 | } |
| 341 | - add_filter( 'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', array( $admin_page, 'form_before_question_group' ), 10, 1 ); |
|
| 342 | - add_filter( 'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', array( $admin_page, 'form_after_question_group' ), 10, 1 ); |
|
| 343 | - add_filter( 'FHEE__EEH_Form_Fields__label_html', array( $admin_page, 'form_form_field_label_wrap' ), 10, 1 ); |
|
| 344 | - add_filter( 'FHEE__EEH_Form_Fields__input_html', array( $admin_page, 'form_form_field_input__wrap' ), 10, 1 ); |
|
| 341 | + add_filter('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', array($admin_page, 'form_before_question_group'), 10, 1); |
|
| 342 | + add_filter('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', array($admin_page, 'form_after_question_group'), 10, 1); |
|
| 343 | + add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1); |
|
| 344 | + add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1); |
|
| 345 | 345 | |
| 346 | - $question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options( $registration, $registration->get('EVT_ID') ); |
|
| 346 | + $question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options($registration, $registration->get('EVT_ID')); |
|
| 347 | 347 | |
| 348 | - EE_Registry::instance()->load_helper( 'Form_Fields' ); |
|
| 348 | + EE_Registry::instance()->load_helper('Form_Fields'); |
|
| 349 | 349 | $template_args = array( |
| 350 | - 'att_questions' => EEH_Form_Fields::generate_question_groups_html( $question_groups ), |
|
| 350 | + 'att_questions' => EEH_Form_Fields::generate_question_groups_html($question_groups), |
|
| 351 | 351 | 'reg_questions_form_action' => 'edit_registration', |
| 352 | 352 | 'REG_ID' => $registration->ID() |
| 353 | 353 | ); |
| 354 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
| 355 | - echo EEH_Template::display_template( $template_path, $template_args, TRUE ); |
|
| 354 | + $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
| 355 | + echo EEH_Template::display_template($template_path, $template_args, TRUE); |
|
| 356 | 356 | //indicate that we should not do the default admin page code |
| 357 | 357 | return false; |
| 358 | 358 | } |
| 359 | -add_action( 'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', 'ee_deprecated_reg_questions_meta_box_old', 10, 3 ); |
|
| 359 | +add_action('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', 'ee_deprecated_reg_questions_meta_box_old', 10, 3); |
|
| 360 | 360 | |
| 361 | 361 | |
| 362 | 362 | |
@@ -397,9 +397,9 @@ discard block |
||
| 397 | 397 | '4.9.0' |
| 398 | 398 | ); |
| 399 | 399 | /** @var EE_Message_Resource_Manager $message_resource_manager */ |
| 400 | - $message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' ); |
|
| 401 | - $messenger = $message_resource_manager->get_messenger( $messenger_name ); |
|
| 402 | - $message_type = $message_resource_manager->get_message_type( $message_type_name ); |
|
| 400 | + $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 401 | + $messenger = $message_resource_manager->get_messenger($messenger_name); |
|
| 402 | + $message_type = $message_resource_manager->get_message_type($message_type_name); |
|
| 403 | 403 | return EE_Registry::instance()->load_lib( |
| 404 | 404 | 'Messages_Template_Defaults', |
| 405 | 405 | array( |
@@ -464,15 +464,15 @@ discard block |
||
| 464 | 464 | /** |
| 465 | 465 | * @param string $method |
| 466 | 466 | */ |
| 467 | - public function _class_is_deprecated( $method ) { |
|
| 467 | + public function _class_is_deprecated($method) { |
|
| 468 | 468 | EE_Error::doing_it_wrong( |
| 469 | - 'EE_messages::' . $method, |
|
| 470 | - __( 'EE_messages has been deprecated. Please use EE_Message_Resource_Manager instead.' ), |
|
| 469 | + 'EE_messages::'.$method, |
|
| 470 | + __('EE_messages has been deprecated. Please use EE_Message_Resource_Manager instead.'), |
|
| 471 | 471 | '4.9.0', |
| 472 | 472 | '4.10.0.p' |
| 473 | 473 | ); |
| 474 | 474 | // Please use EE_Message_Resource_Manager instead |
| 475 | - $this->_message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' ); |
|
| 475 | + $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 476 | 476 | } |
| 477 | 477 | |
| 478 | 478 | |
@@ -482,10 +482,10 @@ discard block |
||
| 482 | 482 | * @param string $messenger_name |
| 483 | 483 | * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive |
| 484 | 484 | */ |
| 485 | - public function ensure_messenger_is_active( $messenger_name ) { |
|
| 485 | + public function ensure_messenger_is_active($messenger_name) { |
|
| 486 | 486 | // EE_messages has been deprecated |
| 487 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 488 | - return $this->_message_resource_manager->ensure_messenger_is_active( $messenger_name ); |
|
| 487 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 488 | + return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name); |
|
| 489 | 489 | } |
| 490 | 490 | |
| 491 | 491 | |
@@ -497,10 +497,10 @@ discard block |
||
| 497 | 497 | * @return bool true if it got activated (or was active) and false if not. |
| 498 | 498 | * @throws \EE_Error |
| 499 | 499 | */ |
| 500 | - public function ensure_message_type_is_active( $message_type, $messenger ) { |
|
| 500 | + public function ensure_message_type_is_active($message_type, $messenger) { |
|
| 501 | 501 | // EE_messages has been deprecated |
| 502 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 503 | - return $this->_message_resource_manager->ensure_message_type_is_active( $message_type, $messenger ); |
|
| 502 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 503 | + return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger); |
|
| 504 | 504 | } |
| 505 | 505 | |
| 506 | 506 | |
@@ -513,10 +513,10 @@ discard block |
||
| 513 | 513 | * they are already setup.) |
| 514 | 514 | * @return boolean an array of generated templates or false if nothing generated/activated. |
| 515 | 515 | */ |
| 516 | - public function activate_messenger( $messenger_name, $mts_to_activate = array() ) { |
|
| 516 | + public function activate_messenger($messenger_name, $mts_to_activate = array()) { |
|
| 517 | 517 | // EE_messages has been deprecated |
| 518 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 519 | - return $this->_message_resource_manager->activate_messenger( $messenger_name, $mts_to_activate ); |
|
| 518 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 519 | + return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate); |
|
| 520 | 520 | } |
| 521 | 521 | |
| 522 | 522 | |
@@ -528,10 +528,10 @@ discard block |
||
| 528 | 528 | * |
| 529 | 529 | * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send. |
| 530 | 530 | */ |
| 531 | - public function is_generating_messenger_and_active( EE_messenger $messenger, EE_message_type $message_type ) { |
|
| 531 | + public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type) { |
|
| 532 | 532 | // EE_messages has been deprecated |
| 533 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 534 | - return $this->_message_resource_manager->is_generating_messenger_and_active( $messenger, $message_type ); |
|
| 533 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 534 | + return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type); |
|
| 535 | 535 | } |
| 536 | 536 | |
| 537 | 537 | |
@@ -541,10 +541,10 @@ discard block |
||
| 541 | 541 | * @param string $messenger |
| 542 | 542 | * @return EE_messenger | null |
| 543 | 543 | */ |
| 544 | - public function get_messenger_if_active( $messenger ) { |
|
| 544 | + public function get_messenger_if_active($messenger) { |
|
| 545 | 545 | // EE_messages has been deprecated |
| 546 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 547 | - return $this->_message_resource_manager->get_active_messenger( $messenger ); |
|
| 546 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 547 | + return $this->_message_resource_manager->get_active_messenger($messenger); |
|
| 548 | 548 | } |
| 549 | 549 | |
| 550 | 550 | |
@@ -565,9 +565,9 @@ discard block |
||
| 565 | 565 | * 'message_type' => null |
| 566 | 566 | * ) |
| 567 | 567 | */ |
| 568 | - public function validate_for_use( EE_Message $message ) { |
|
| 568 | + public function validate_for_use(EE_Message $message) { |
|
| 569 | 569 | // EE_messages has been deprecated |
| 570 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 570 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 571 | 571 | return array( |
| 572 | 572 | 'messenger' => $message->messenger_object(), |
| 573 | 573 | 'message_type' => $message->message_type_object(), |
@@ -595,41 +595,41 @@ discard block |
||
| 595 | 595 | $send = true |
| 596 | 596 | ) { |
| 597 | 597 | // EE_messages has been deprecated |
| 598 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 598 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 599 | 599 | /** @type EE_Messages_Processor $processor */ |
| 600 | - $processor = EE_Registry::instance()->load_lib( 'Messages_Processor' ); |
|
| 600 | + $processor = EE_Registry::instance()->load_lib('Messages_Processor'); |
|
| 601 | 601 | $error = false; |
| 602 | 602 | //try to intelligently determine what method we'll call based on the incoming data. |
| 603 | 603 | //if generating and sending are different then generate and send immediately. |
| 604 | - if ( ! empty( $sending_messenger ) && $sending_messenger != $generating_messenger && $send ) { |
|
| 604 | + if ( ! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) { |
|
| 605 | 605 | //in the legacy system, when generating and sending were different, that means all the |
| 606 | 606 | //vars are already in the request object. So let's just use that. |
| 607 | 607 | try { |
| 608 | 608 | /** @type EE_Message_To_Generate_From_Request $mtg */ |
| 609 | - $mtg = EE_Registry::instance()->load_lib( 'Message_To_Generate_From_Request' ); |
|
| 610 | - $processor->generate_and_send_now( $mtg ); |
|
| 611 | - } catch ( EE_Error $e ) { |
|
| 609 | + $mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request'); |
|
| 610 | + $processor->generate_and_send_now($mtg); |
|
| 611 | + } catch (EE_Error $e) { |
|
| 612 | 612 | $error_msg = __( |
| 613 | 613 | 'Please note that a system message failed to send due to a technical issue.', |
| 614 | 614 | 'event_espresso' |
| 615 | 615 | ); |
| 616 | 616 | // add specific message for developers if WP_DEBUG in on |
| 617 | - $error_msg .= '||' . $e->getMessage(); |
|
| 618 | - EE_Error::add_error( $error_msg, __FILE__, __FUNCTION__, __LINE__ ); |
|
| 617 | + $error_msg .= '||'.$e->getMessage(); |
|
| 618 | + EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 619 | 619 | $error = true; |
| 620 | 620 | } |
| 621 | 621 | } else { |
| 622 | - $processor->generate_for_all_active_messengers( $type, $vars, $send ); |
|
| 622 | + $processor->generate_for_all_active_messengers($type, $vars, $send); |
|
| 623 | 623 | //let's find out if there were any errors and how many successfully were queued. |
| 624 | 624 | $count_errors = $processor->get_queue()->count_STS_in_queue( |
| 625 | - array( EEM_Message::status_failed, EEM_Message::status_debug_only ) |
|
| 625 | + array(EEM_Message::status_failed, EEM_Message::status_debug_only) |
|
| 626 | 626 | ); |
| 627 | - $count_queued = $processor->get_queue()->count_STS_in_queue( EEM_Message::status_incomplete ); |
|
| 628 | - $count_retry = $processor->get_queue()->count_STS_in_queue( EEM_Message::status_retry ); |
|
| 627 | + $count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete); |
|
| 628 | + $count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry); |
|
| 629 | 629 | $count_errors = $count_errors + $count_retry; |
| 630 | - if ( $count_errors > 0 ) { |
|
| 630 | + if ($count_errors > 0) { |
|
| 631 | 631 | $error = true; |
| 632 | - if ( $count_errors > 1 && $count_retry > 1 && $count_queued > 1 ) { |
|
| 632 | + if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) { |
|
| 633 | 633 | $message = sprintf( |
| 634 | 634 | __( |
| 635 | 635 | 'There were %d errors and %d messages successfully queued for generation and sending', |
@@ -638,7 +638,7 @@ discard block |
||
| 638 | 638 | $count_errors, |
| 639 | 639 | $count_queued |
| 640 | 640 | ); |
| 641 | - } elseif ( $count_errors > 1 && $count_queued === 1 ) { |
|
| 641 | + } elseif ($count_errors > 1 && $count_queued === 1) { |
|
| 642 | 642 | $message = sprintf( |
| 643 | 643 | __( |
| 644 | 644 | 'There were %d errors and %d message successfully queued for generation.', |
@@ -647,7 +647,7 @@ discard block |
||
| 647 | 647 | $count_errors, |
| 648 | 648 | $count_queued |
| 649 | 649 | ); |
| 650 | - } elseif ( $count_errors === 1 && $count_queued > 1 ) { |
|
| 650 | + } elseif ($count_errors === 1 && $count_queued > 1) { |
|
| 651 | 651 | $message = sprintf( |
| 652 | 652 | __( |
| 653 | 653 | 'There was %d error and %d messages successfully queued for generation.', |
@@ -665,9 +665,9 @@ discard block |
||
| 665 | 665 | $count_errors |
| 666 | 666 | ); |
| 667 | 667 | } |
| 668 | - EE_Error::add_error( $message, __FILE__, __FUNCTION__, __LINE__ ); |
|
| 668 | + EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__); |
|
| 669 | 669 | } else { |
| 670 | - if ( $count_queued === 1 ) { |
|
| 670 | + if ($count_queued === 1) { |
|
| 671 | 671 | $message = sprintf( |
| 672 | 672 | __( |
| 673 | 673 | '%d message successfully queued for generation.', |
@@ -684,18 +684,18 @@ discard block |
||
| 684 | 684 | $count_queued |
| 685 | 685 | ); |
| 686 | 686 | } |
| 687 | - EE_Error::add_success( $message ); |
|
| 687 | + EE_Error::add_success($message); |
|
| 688 | 688 | } |
| 689 | 689 | } |
| 690 | 690 | //if no error then return the generated message(s). |
| 691 | - if ( ! $error && ! $send ) { |
|
| 692 | - $generated_queue = $processor->generate_queue( false ); |
|
| 691 | + if ( ! $error && ! $send) { |
|
| 692 | + $generated_queue = $processor->generate_queue(false); |
|
| 693 | 693 | //get message and return. |
| 694 | 694 | $generated_queue->get_message_repository()->rewind(); |
| 695 | 695 | $messages = array(); |
| 696 | - while ( $generated_queue->get_message_repository()->valid() ) { |
|
| 696 | + while ($generated_queue->get_message_repository()->valid()) { |
|
| 697 | 697 | $message = $generated_queue->get_message_repository()->current(); |
| 698 | - if ( $message instanceof EE_Message ) { |
|
| 698 | + if ($message instanceof EE_Message) { |
|
| 699 | 699 | //set properties that might be expected by add-ons (backward compat) |
| 700 | 700 | $message->content = $message->content(); |
| 701 | 701 | $message->template_pack = $message->get_template_pack(); |
@@ -720,10 +720,10 @@ discard block |
||
| 720 | 720 | * @param bool $send true we will do a test send using the messenger delivery, false we just do a regular preview |
| 721 | 721 | * @return string The body of the message. |
| 722 | 722 | */ |
| 723 | - public function preview_message( $type, $context, $messenger, $send = false ) { |
|
| 723 | + public function preview_message($type, $context, $messenger, $send = false) { |
|
| 724 | 724 | // EE_messages has been deprecated |
| 725 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 726 | - return EED_Messages::preview_message( $type, $context, $messenger, $send ); |
|
| 725 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 726 | + return EED_Messages::preview_message($type, $context, $messenger, $send); |
|
| 727 | 727 | } |
| 728 | 728 | |
| 729 | 729 | |
@@ -737,14 +737,14 @@ discard block |
||
| 737 | 737 | * |
| 738 | 738 | * @return bool success or fail. |
| 739 | 739 | */ |
| 740 | - public function send_message_with_messenger_only( $messenger, $message_type, $message ) { |
|
| 740 | + public function send_message_with_messenger_only($messenger, $message_type, $message) { |
|
| 741 | 741 | // EE_messages has been deprecated |
| 742 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 742 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 743 | 743 | //setup for sending to new method. |
| 744 | 744 | /** @type EE_Messages_Queue $queue */ |
| 745 | - $queue = EE_Registry::instance()->load_lib( 'Messages_Queue' ); |
|
| 745 | + $queue = EE_Registry::instance()->load_lib('Messages_Queue'); |
|
| 746 | 746 | //make sure we have a proper message object |
| 747 | - if ( ! $message instanceof EE_Message && is_object( $message ) && isset( $message->content ) ) { |
|
| 747 | + if ( ! $message instanceof EE_Message && is_object($message) && isset($message->content)) { |
|
| 748 | 748 | $msg = EE_Message_Factory::create( |
| 749 | 749 | array( |
| 750 | 750 | 'MSG_messenger' => $messenger, |
@@ -756,15 +756,15 @@ discard block |
||
| 756 | 756 | } else { |
| 757 | 757 | $msg = $message; |
| 758 | 758 | } |
| 759 | - if ( ! $msg instanceof EE_Message ) { |
|
| 759 | + if ( ! $msg instanceof EE_Message) { |
|
| 760 | 760 | return false; |
| 761 | 761 | } |
| 762 | 762 | //make sure any content in a content property (if not empty) is set on the MSG_content. |
| 763 | - if ( ! empty( $msg->content ) ) { |
|
| 764 | - $msg->set( 'MSG_content', $msg->content ); |
|
| 763 | + if ( ! empty($msg->content)) { |
|
| 764 | + $msg->set('MSG_content', $msg->content); |
|
| 765 | 765 | } |
| 766 | - $queue->add( $msg ); |
|
| 767 | - return EED_Messages::send_message_with_messenger_only( $messenger, $message_type, $queue ); |
|
| 766 | + $queue->add($msg); |
|
| 767 | + return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue); |
|
| 768 | 768 | } |
| 769 | 769 | |
| 770 | 770 | |
@@ -778,11 +778,11 @@ discard block |
||
| 778 | 778 | * @return array|object if creation is successful then we return an array of info, otherwise an error_object is returned. |
| 779 | 779 | * @throws \EE_Error |
| 780 | 780 | */ |
| 781 | - public function create_new_templates( $messenger, $message_type, $GRP_ID = 0, $is_global = false ) { |
|
| 781 | + public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false) { |
|
| 782 | 782 | // EE_messages has been deprecated |
| 783 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 784 | - EE_Registry::instance()->load_helper( 'MSG_Template' ); |
|
| 785 | - return EEH_MSG_Template::create_new_templates( $messenger, $message_type, $GRP_ID, $is_global ); |
|
| 783 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 784 | + EE_Registry::instance()->load_helper('MSG_Template'); |
|
| 785 | + return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global); |
|
| 786 | 786 | } |
| 787 | 787 | |
| 788 | 788 | |
@@ -793,11 +793,11 @@ discard block |
||
| 793 | 793 | * @param string $message_type_name name of EE_message_type |
| 794 | 794 | * @return array |
| 795 | 795 | */ |
| 796 | - public function get_fields( $messenger_name, $message_type_name ) { |
|
| 796 | + public function get_fields($messenger_name, $message_type_name) { |
|
| 797 | 797 | // EE_messages has been deprecated |
| 798 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 799 | - EE_Registry::instance()->load_helper( 'MSG_Template' ); |
|
| 800 | - return EEH_MSG_Template::get_fields( $messenger_name, $message_type_name ); |
|
| 798 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 799 | + EE_Registry::instance()->load_helper('MSG_Template'); |
|
| 800 | + return EEH_MSG_Template::get_fields($messenger_name, $message_type_name); |
|
| 801 | 801 | } |
| 802 | 802 | |
| 803 | 803 | |
@@ -811,13 +811,13 @@ discard block |
||
| 811 | 811 | * @return array multidimensional array of messenger and message_type objects |
| 812 | 812 | * (messengers index, and message_type index); |
| 813 | 813 | */ |
| 814 | - public function get_installed( $type = 'all', $skip_cache = false ) { |
|
| 814 | + public function get_installed($type = 'all', $skip_cache = false) { |
|
| 815 | 815 | // EE_messages has been deprecated |
| 816 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 817 | - if ( $skip_cache ) { |
|
| 816 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 817 | + if ($skip_cache) { |
|
| 818 | 818 | $this->_message_resource_manager->reset_active_messengers_and_message_types(); |
| 819 | 819 | } |
| 820 | - switch ( $type ) { |
|
| 820 | + switch ($type) { |
|
| 821 | 821 | case 'messengers' : |
| 822 | 822 | return array( |
| 823 | 823 | 'messenger' => $this->_message_resource_manager->installed_messengers(), |
@@ -846,7 +846,7 @@ discard block |
||
| 846 | 846 | */ |
| 847 | 847 | public function get_active_messengers() { |
| 848 | 848 | // EE_messages has been deprecated |
| 849 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 849 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 850 | 850 | return $this->_message_resource_manager->active_messengers(); |
| 851 | 851 | } |
| 852 | 852 | |
@@ -858,7 +858,7 @@ discard block |
||
| 858 | 858 | */ |
| 859 | 859 | public function get_active_message_types() { |
| 860 | 860 | // EE_messages has been deprecated |
| 861 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 861 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 862 | 862 | return $this->_message_resource_manager->list_of_active_message_types(); |
| 863 | 863 | } |
| 864 | 864 | |
@@ -870,7 +870,7 @@ discard block |
||
| 870 | 870 | */ |
| 871 | 871 | public function get_active_message_type_objects() { |
| 872 | 872 | // EE_messages has been deprecated |
| 873 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 873 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 874 | 874 | return $this->_message_resource_manager->get_active_message_type_objects(); |
| 875 | 875 | } |
| 876 | 876 | |
@@ -882,10 +882,10 @@ discard block |
||
| 882 | 882 | * @param string $messenger The messenger being checked |
| 883 | 883 | * @return EE_message_type[] (or empty array if none present) |
| 884 | 884 | */ |
| 885 | - public function get_active_message_types_per_messenger( $messenger ) { |
|
| 885 | + public function get_active_message_types_per_messenger($messenger) { |
|
| 886 | 886 | // EE_messages has been deprecated |
| 887 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 888 | - return $this->_message_resource_manager->get_active_message_types_for_messenger( $messenger ); |
|
| 887 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 888 | + return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger); |
|
| 889 | 889 | } |
| 890 | 890 | |
| 891 | 891 | |
@@ -896,10 +896,10 @@ discard block |
||
| 896 | 896 | * @param string $message_type The string should correspond to a message type. |
| 897 | 897 | * @return EE_message_type|null |
| 898 | 898 | */ |
| 899 | - public function get_active_message_type( $messenger, $message_type ) { |
|
| 899 | + public function get_active_message_type($messenger, $message_type) { |
|
| 900 | 900 | // EE_messages has been deprecated |
| 901 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 902 | - return $this->_message_resource_manager->get_active_message_type_for_messenger( $messenger, $message_type ); |
|
| 901 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 902 | + return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type); |
|
| 903 | 903 | } |
| 904 | 904 | |
| 905 | 905 | |
@@ -910,7 +910,7 @@ discard block |
||
| 910 | 910 | */ |
| 911 | 911 | public function get_installed_message_types() { |
| 912 | 912 | // EE_messages has been deprecated |
| 913 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 913 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 914 | 914 | return $this->_message_resource_manager->installed_message_types(); |
| 915 | 915 | } |
| 916 | 916 | |
@@ -922,7 +922,7 @@ discard block |
||
| 922 | 922 | */ |
| 923 | 923 | public function get_installed_messengers() { |
| 924 | 924 | // EE_messages has been deprecated |
| 925 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 925 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 926 | 926 | return $this->_message_resource_manager->installed_messengers(); |
| 927 | 927 | } |
| 928 | 928 | |
@@ -933,10 +933,10 @@ discard block |
||
| 933 | 933 | * @param bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by message type. |
| 934 | 934 | * @return array |
| 935 | 935 | */ |
| 936 | - public function get_all_contexts( $slugs_only = true ) { |
|
| 936 | + public function get_all_contexts($slugs_only = true) { |
|
| 937 | 937 | // EE_messages has been deprecated |
| 938 | - $this->_class_is_deprecated( __FUNCTION__ ); |
|
| 939 | - return $this->_message_resource_manager->get_all_contexts( $slugs_only ); |
|
| 938 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 939 | + return $this->_message_resource_manager->get_all_contexts($slugs_only); |
|
| 940 | 940 | } |
| 941 | 941 | |
| 942 | 942 | |
@@ -995,7 +995,7 @@ discard block |
||
| 995 | 995 | add_filter( |
| 996 | 996 | 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css', |
| 997 | 997 | function($event_list_iframe_css) { |
| 998 | - if ( ! has_filter( 'FHEE__EventsArchiveIframe__event_list_iframe__css' )) { |
|
| 998 | + if ( ! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) { |
|
| 999 | 999 | return $event_list_iframe_css; |
| 1000 | 1000 | } |
| 1001 | 1001 | deprecated_espresso_action_or_filter_doing_it_wrong( |
@@ -1015,7 +1015,7 @@ discard block |
||
| 1015 | 1015 | add_filter( |
| 1016 | 1016 | 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js', |
| 1017 | 1017 | function($event_list_iframe_js) { |
| 1018 | - if ( ! has_filter( 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js' )) { |
|
| 1018 | + if ( ! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) { |
|
| 1019 | 1019 | return $event_list_iframe_js; |
| 1020 | 1020 | } |
| 1021 | 1021 | deprecated_espresso_action_or_filter_doing_it_wrong( |
@@ -1095,7 +1095,7 @@ discard block |
||
| 1095 | 1095 | */ |
| 1096 | 1096 | public function event_list_title($event_list_title = '') |
| 1097 | 1097 | { |
| 1098 | - if (! empty($this->title)) { |
|
| 1098 | + if ( ! empty($this->title)) { |
|
| 1099 | 1099 | return $this->title; |
| 1100 | 1100 | } |
| 1101 | 1101 | return $event_list_title; |
@@ -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'), |
@@ -32,211 +32,211 @@ |
||
| 32 | 32 | class ShortcodesManager |
| 33 | 33 | { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var LegacyShortcodesManager $legacy_shortcodes_manager |
|
| 37 | - */ |
|
| 38 | - private $legacy_shortcodes_manager; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * @var ShortcodeInterface[] $shortcodes |
|
| 42 | - */ |
|
| 43 | - private $shortcodes; |
|
| 44 | - |
|
| 45 | - |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * ShortcodesManager constructor |
|
| 49 | - * |
|
| 50 | - * @param LegacyShortcodesManager $legacy_shortcodes_manager |
|
| 51 | - */ |
|
| 52 | - public function __construct(LegacyShortcodesManager $legacy_shortcodes_manager) { |
|
| 53 | - $this->legacy_shortcodes_manager = $legacy_shortcodes_manager; |
|
| 54 | - // assemble a list of installed and active shortcodes |
|
| 55 | - add_action( |
|
| 56 | - 'AHEE__EE_System__register_shortcodes_modules_and_widgets', |
|
| 57 | - array($this, 'registerShortcodes'), |
|
| 58 | - 999 |
|
| 59 | - ); |
|
| 60 | - // call add_shortcode() for all installed shortcodes |
|
| 61 | - add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'addShortcodes')); |
|
| 62 | - // check content for shortcodes the old way |
|
| 63 | - add_action('parse_query', array($this->legacy_shortcodes_manager, 'initializeShortcodes'), 5); |
|
| 64 | - // check content for shortcodes the NEW more efficient way |
|
| 65 | - add_action('template_redirect', array($this, 'templateRedirect'), 999); |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - |
|
| 69 | - |
|
| 70 | - /** |
|
| 71 | - * @return CollectionInterface|ShortcodeInterface[] |
|
| 72 | - * @throws InvalidIdentifierException |
|
| 73 | - * @throws InvalidInterfaceException |
|
| 74 | - * @throws InvalidFilePathException |
|
| 75 | - * @throws InvalidEntityException |
|
| 76 | - * @throws InvalidDataTypeException |
|
| 77 | - * @throws InvalidClassException |
|
| 78 | - */ |
|
| 79 | - public function getShortcodes() |
|
| 80 | - { |
|
| 81 | - if ( ! $this->shortcodes instanceof CollectionInterface) { |
|
| 82 | - $this->shortcodes = $this->loadShortcodesCollection(); |
|
| 83 | - } |
|
| 84 | - return $this->shortcodes; |
|
| 85 | - } |
|
| 86 | - |
|
| 87 | - |
|
| 88 | - |
|
| 89 | - /** |
|
| 90 | - * @return CollectionInterface|ShortcodeInterface[] |
|
| 91 | - * @throws InvalidIdentifierException |
|
| 92 | - * @throws InvalidInterfaceException |
|
| 93 | - * @throws InvalidFilePathException |
|
| 94 | - * @throws InvalidEntityException |
|
| 95 | - * @throws InvalidDataTypeException |
|
| 96 | - * @throws InvalidClassException |
|
| 97 | - */ |
|
| 98 | - protected function loadShortcodesCollection() |
|
| 99 | - { |
|
| 100 | - $loader = new CollectionLoader( |
|
| 101 | - new CollectionDetails( |
|
| 102 | - // collection name |
|
| 103 | - 'shortcodes', |
|
| 104 | - // collection interface |
|
| 105 | - 'EventEspresso\core\services\shortcodes\ShortcodeInterface', |
|
| 106 | - // FQCNs for classes to add (all classes within that namespace will be loaded) |
|
| 107 | - array('EventEspresso\core\domain\entities\shortcodes'), |
|
| 108 | - // filepaths to classes to add |
|
| 109 | - array(), |
|
| 110 | - // file mask to use if parsing folder for files to add |
|
| 111 | - '', |
|
| 112 | - // what to use as identifier for collection entities |
|
| 113 | - // using CLASS NAME prevents duplicates (works like a singleton) |
|
| 114 | - CollectionDetails::ID_CLASS_NAME |
|
| 115 | - ) |
|
| 116 | - ); |
|
| 117 | - return $loader->getCollection(); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * @return void |
|
| 124 | - * @throws DomainException |
|
| 125 | - * @throws InvalidInterfaceException |
|
| 126 | - * @throws InvalidIdentifierException |
|
| 127 | - * @throws InvalidFilePathException |
|
| 128 | - * @throws InvalidEntityException |
|
| 129 | - * @throws InvalidDataTypeException |
|
| 130 | - * @throws InvalidClassException |
|
| 131 | - */ |
|
| 132 | - public function registerShortcodes() |
|
| 133 | - { |
|
| 134 | - try { |
|
| 135 | - $this->shortcodes = apply_filters( |
|
| 136 | - 'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection', |
|
| 137 | - $this->getShortcodes() |
|
| 138 | - ); |
|
| 139 | - if (! $this->shortcodes instanceof CollectionInterface) { |
|
| 140 | - throw new InvalidEntityException( |
|
| 141 | - $this->shortcodes, |
|
| 142 | - 'CollectionInterface', |
|
| 143 | - sprintf( |
|
| 144 | - esc_html__( |
|
| 145 | - 'The "FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection" filter must return a Collection of EspressoShortcode objects. "%1$s" was received instead.', |
|
| 146 | - 'event_espresso' |
|
| 147 | - ), |
|
| 148 | - is_object($this->shortcodes) ? get_class($this->shortcodes) : gettype($this->shortcodes) |
|
| 149 | - ) |
|
| 150 | - ); |
|
| 151 | - } |
|
| 152 | - $this->legacy_shortcodes_manager->registerShortcodes(); |
|
| 153 | - } catch (Exception $exception) { |
|
| 154 | - new ExceptionStackTraceDisplay($exception); |
|
| 155 | - } |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - |
|
| 159 | - |
|
| 160 | - /** |
|
| 161 | - * @return void |
|
| 162 | - */ |
|
| 163 | - public function addShortcodes() |
|
| 164 | - { |
|
| 165 | - try { |
|
| 166 | - // cycle thru shortcode folders |
|
| 167 | - foreach ($this->shortcodes as $shortcode) { |
|
| 168 | - /** @var ShortcodeInterface $shortcode */ |
|
| 169 | - if ( $shortcode instanceof EnqueueAssetsInterface) { |
|
| 170 | - add_action('wp_enqueue_scripts', array($shortcode, 'registerScriptsAndStylesheets'), 10); |
|
| 171 | - add_action('wp_enqueue_scripts', array($shortcode, 'enqueueStylesheets'), 11); |
|
| 172 | - } |
|
| 173 | - // add_shortcode() if it has not already been added |
|
| 174 | - if ( ! shortcode_exists($shortcode->getTag())) { |
|
| 175 | - add_shortcode($shortcode->getTag(), array($shortcode, 'processShortcodeCallback')); |
|
| 176 | - } |
|
| 177 | - } |
|
| 178 | - $this->legacy_shortcodes_manager->addShortcodes(); |
|
| 179 | - } catch (Exception $exception) { |
|
| 180 | - new ExceptionStackTraceDisplay($exception); |
|
| 181 | - } |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - |
|
| 185 | - |
|
| 186 | - /** |
|
| 187 | - * callback for the "template_redirect" hook point |
|
| 188 | - * checks posts for EE shortcodes, and initializes them, |
|
| 189 | - * then toggles filter switch that loads core default assets |
|
| 190 | - * |
|
| 191 | - * @return void |
|
| 192 | - */ |
|
| 193 | - public function templateRedirect() |
|
| 194 | - { |
|
| 195 | - global $wp_query; |
|
| 196 | - if (empty($wp_query->posts)) { |
|
| 197 | - return; |
|
| 198 | - } |
|
| 199 | - $load_assets = false; |
|
| 200 | - // array of posts displayed in current request |
|
| 201 | - $posts = is_array($wp_query->posts) ? $wp_query->posts : array($wp_query->posts); |
|
| 202 | - foreach ($posts as $post) { |
|
| 203 | - // now check post content and excerpt for EE shortcodes |
|
| 204 | - $load_assets = $this->parseContentForShortcodes($post->post_content) |
|
| 205 | - ? true |
|
| 206 | - : $load_assets; |
|
| 207 | - } |
|
| 208 | - if ($load_assets) { |
|
| 209 | - $this->legacy_shortcodes_manager->registry()->REQ->set_espresso_page(true); |
|
| 210 | - add_filter('FHEE_load_css', '__return_true'); |
|
| 211 | - add_filter('FHEE_load_js', '__return_true'); |
|
| 212 | - } |
|
| 213 | - } |
|
| 214 | - |
|
| 215 | - |
|
| 216 | - |
|
| 217 | - /** |
|
| 218 | - * checks supplied content against list of shortcodes, |
|
| 219 | - * then initializes any found shortcodes, and returns true. |
|
| 220 | - * returns false if no shortcodes found. |
|
| 221 | - * |
|
| 222 | - * @param string $content |
|
| 223 | - * @return bool |
|
| 224 | - */ |
|
| 225 | - public function parseContentForShortcodes($content) |
|
| 226 | - { |
|
| 227 | - $has_shortcode = false; |
|
| 228 | - if(empty($this->shortcodes)){ |
|
| 229 | - return $has_shortcode; |
|
| 230 | - } |
|
| 231 | - foreach ($this->shortcodes as $shortcode) { |
|
| 232 | - /** @var ShortcodeInterface $shortcode */ |
|
| 233 | - if (has_shortcode($content, $shortcode->getTag())) { |
|
| 234 | - $shortcode->initializeShortcode(); |
|
| 235 | - $has_shortcode = true; |
|
| 236 | - } |
|
| 237 | - } |
|
| 238 | - return $has_shortcode; |
|
| 239 | - } |
|
| 35 | + /** |
|
| 36 | + * @var LegacyShortcodesManager $legacy_shortcodes_manager |
|
| 37 | + */ |
|
| 38 | + private $legacy_shortcodes_manager; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * @var ShortcodeInterface[] $shortcodes |
|
| 42 | + */ |
|
| 43 | + private $shortcodes; |
|
| 44 | + |
|
| 45 | + |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * ShortcodesManager constructor |
|
| 49 | + * |
|
| 50 | + * @param LegacyShortcodesManager $legacy_shortcodes_manager |
|
| 51 | + */ |
|
| 52 | + public function __construct(LegacyShortcodesManager $legacy_shortcodes_manager) { |
|
| 53 | + $this->legacy_shortcodes_manager = $legacy_shortcodes_manager; |
|
| 54 | + // assemble a list of installed and active shortcodes |
|
| 55 | + add_action( |
|
| 56 | + 'AHEE__EE_System__register_shortcodes_modules_and_widgets', |
|
| 57 | + array($this, 'registerShortcodes'), |
|
| 58 | + 999 |
|
| 59 | + ); |
|
| 60 | + // call add_shortcode() for all installed shortcodes |
|
| 61 | + add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'addShortcodes')); |
|
| 62 | + // check content for shortcodes the old way |
|
| 63 | + add_action('parse_query', array($this->legacy_shortcodes_manager, 'initializeShortcodes'), 5); |
|
| 64 | + // check content for shortcodes the NEW more efficient way |
|
| 65 | + add_action('template_redirect', array($this, 'templateRedirect'), 999); |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + |
|
| 69 | + |
|
| 70 | + /** |
|
| 71 | + * @return CollectionInterface|ShortcodeInterface[] |
|
| 72 | + * @throws InvalidIdentifierException |
|
| 73 | + * @throws InvalidInterfaceException |
|
| 74 | + * @throws InvalidFilePathException |
|
| 75 | + * @throws InvalidEntityException |
|
| 76 | + * @throws InvalidDataTypeException |
|
| 77 | + * @throws InvalidClassException |
|
| 78 | + */ |
|
| 79 | + public function getShortcodes() |
|
| 80 | + { |
|
| 81 | + if ( ! $this->shortcodes instanceof CollectionInterface) { |
|
| 82 | + $this->shortcodes = $this->loadShortcodesCollection(); |
|
| 83 | + } |
|
| 84 | + return $this->shortcodes; |
|
| 85 | + } |
|
| 86 | + |
|
| 87 | + |
|
| 88 | + |
|
| 89 | + /** |
|
| 90 | + * @return CollectionInterface|ShortcodeInterface[] |
|
| 91 | + * @throws InvalidIdentifierException |
|
| 92 | + * @throws InvalidInterfaceException |
|
| 93 | + * @throws InvalidFilePathException |
|
| 94 | + * @throws InvalidEntityException |
|
| 95 | + * @throws InvalidDataTypeException |
|
| 96 | + * @throws InvalidClassException |
|
| 97 | + */ |
|
| 98 | + protected function loadShortcodesCollection() |
|
| 99 | + { |
|
| 100 | + $loader = new CollectionLoader( |
|
| 101 | + new CollectionDetails( |
|
| 102 | + // collection name |
|
| 103 | + 'shortcodes', |
|
| 104 | + // collection interface |
|
| 105 | + 'EventEspresso\core\services\shortcodes\ShortcodeInterface', |
|
| 106 | + // FQCNs for classes to add (all classes within that namespace will be loaded) |
|
| 107 | + array('EventEspresso\core\domain\entities\shortcodes'), |
|
| 108 | + // filepaths to classes to add |
|
| 109 | + array(), |
|
| 110 | + // file mask to use if parsing folder for files to add |
|
| 111 | + '', |
|
| 112 | + // what to use as identifier for collection entities |
|
| 113 | + // using CLASS NAME prevents duplicates (works like a singleton) |
|
| 114 | + CollectionDetails::ID_CLASS_NAME |
|
| 115 | + ) |
|
| 116 | + ); |
|
| 117 | + return $loader->getCollection(); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * @return void |
|
| 124 | + * @throws DomainException |
|
| 125 | + * @throws InvalidInterfaceException |
|
| 126 | + * @throws InvalidIdentifierException |
|
| 127 | + * @throws InvalidFilePathException |
|
| 128 | + * @throws InvalidEntityException |
|
| 129 | + * @throws InvalidDataTypeException |
|
| 130 | + * @throws InvalidClassException |
|
| 131 | + */ |
|
| 132 | + public function registerShortcodes() |
|
| 133 | + { |
|
| 134 | + try { |
|
| 135 | + $this->shortcodes = apply_filters( |
|
| 136 | + 'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection', |
|
| 137 | + $this->getShortcodes() |
|
| 138 | + ); |
|
| 139 | + if (! $this->shortcodes instanceof CollectionInterface) { |
|
| 140 | + throw new InvalidEntityException( |
|
| 141 | + $this->shortcodes, |
|
| 142 | + 'CollectionInterface', |
|
| 143 | + sprintf( |
|
| 144 | + esc_html__( |
|
| 145 | + 'The "FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection" filter must return a Collection of EspressoShortcode objects. "%1$s" was received instead.', |
|
| 146 | + 'event_espresso' |
|
| 147 | + ), |
|
| 148 | + is_object($this->shortcodes) ? get_class($this->shortcodes) : gettype($this->shortcodes) |
|
| 149 | + ) |
|
| 150 | + ); |
|
| 151 | + } |
|
| 152 | + $this->legacy_shortcodes_manager->registerShortcodes(); |
|
| 153 | + } catch (Exception $exception) { |
|
| 154 | + new ExceptionStackTraceDisplay($exception); |
|
| 155 | + } |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + |
|
| 159 | + |
|
| 160 | + /** |
|
| 161 | + * @return void |
|
| 162 | + */ |
|
| 163 | + public function addShortcodes() |
|
| 164 | + { |
|
| 165 | + try { |
|
| 166 | + // cycle thru shortcode folders |
|
| 167 | + foreach ($this->shortcodes as $shortcode) { |
|
| 168 | + /** @var ShortcodeInterface $shortcode */ |
|
| 169 | + if ( $shortcode instanceof EnqueueAssetsInterface) { |
|
| 170 | + add_action('wp_enqueue_scripts', array($shortcode, 'registerScriptsAndStylesheets'), 10); |
|
| 171 | + add_action('wp_enqueue_scripts', array($shortcode, 'enqueueStylesheets'), 11); |
|
| 172 | + } |
|
| 173 | + // add_shortcode() if it has not already been added |
|
| 174 | + if ( ! shortcode_exists($shortcode->getTag())) { |
|
| 175 | + add_shortcode($shortcode->getTag(), array($shortcode, 'processShortcodeCallback')); |
|
| 176 | + } |
|
| 177 | + } |
|
| 178 | + $this->legacy_shortcodes_manager->addShortcodes(); |
|
| 179 | + } catch (Exception $exception) { |
|
| 180 | + new ExceptionStackTraceDisplay($exception); |
|
| 181 | + } |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + |
|
| 185 | + |
|
| 186 | + /** |
|
| 187 | + * callback for the "template_redirect" hook point |
|
| 188 | + * checks posts for EE shortcodes, and initializes them, |
|
| 189 | + * then toggles filter switch that loads core default assets |
|
| 190 | + * |
|
| 191 | + * @return void |
|
| 192 | + */ |
|
| 193 | + public function templateRedirect() |
|
| 194 | + { |
|
| 195 | + global $wp_query; |
|
| 196 | + if (empty($wp_query->posts)) { |
|
| 197 | + return; |
|
| 198 | + } |
|
| 199 | + $load_assets = false; |
|
| 200 | + // array of posts displayed in current request |
|
| 201 | + $posts = is_array($wp_query->posts) ? $wp_query->posts : array($wp_query->posts); |
|
| 202 | + foreach ($posts as $post) { |
|
| 203 | + // now check post content and excerpt for EE shortcodes |
|
| 204 | + $load_assets = $this->parseContentForShortcodes($post->post_content) |
|
| 205 | + ? true |
|
| 206 | + : $load_assets; |
|
| 207 | + } |
|
| 208 | + if ($load_assets) { |
|
| 209 | + $this->legacy_shortcodes_manager->registry()->REQ->set_espresso_page(true); |
|
| 210 | + add_filter('FHEE_load_css', '__return_true'); |
|
| 211 | + add_filter('FHEE_load_js', '__return_true'); |
|
| 212 | + } |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + |
|
| 216 | + |
|
| 217 | + /** |
|
| 218 | + * checks supplied content against list of shortcodes, |
|
| 219 | + * then initializes any found shortcodes, and returns true. |
|
| 220 | + * returns false if no shortcodes found. |
|
| 221 | + * |
|
| 222 | + * @param string $content |
|
| 223 | + * @return bool |
|
| 224 | + */ |
|
| 225 | + public function parseContentForShortcodes($content) |
|
| 226 | + { |
|
| 227 | + $has_shortcode = false; |
|
| 228 | + if(empty($this->shortcodes)){ |
|
| 229 | + return $has_shortcode; |
|
| 230 | + } |
|
| 231 | + foreach ($this->shortcodes as $shortcode) { |
|
| 232 | + /** @var ShortcodeInterface $shortcode */ |
|
| 233 | + if (has_shortcode($content, $shortcode->getTag())) { |
|
| 234 | + $shortcode->initializeShortcode(); |
|
| 235 | + $has_shortcode = true; |
|
| 236 | + } |
|
| 237 | + } |
|
| 238 | + return $has_shortcode; |
|
| 239 | + } |
|
| 240 | 240 | |
| 241 | 241 | } |
| 242 | 242 | // End of file ShortcodesManager.php |
@@ -3,7 +3,7 @@ discard block |
||
| 3 | 3 | use EventEspresso\widgets\EspressoWidget; |
| 4 | 4 | |
| 5 | 5 | if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
| 6 | - exit('No direct script access allowed'); |
|
| 6 | + exit('No direct script access allowed'); |
|
| 7 | 7 | } |
| 8 | 8 | |
| 9 | 9 | /** |
@@ -26,378 +26,378 @@ discard block |
||
| 26 | 26 | final class EE_Front_Controller |
| 27 | 27 | { |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * @var string $_template_path |
|
| 31 | - */ |
|
| 32 | - private $_template_path; |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * @var string $_template |
|
| 36 | - */ |
|
| 37 | - private $_template; |
|
| 38 | - |
|
| 39 | - /** |
|
| 40 | - * @type EE_Registry $Registry |
|
| 41 | - */ |
|
| 42 | - protected $Registry; |
|
| 43 | - |
|
| 44 | - /** |
|
| 45 | - * @type EE_Request_Handler $Request_Handler |
|
| 46 | - */ |
|
| 47 | - protected $Request_Handler; |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * @type EE_Module_Request_Router $Module_Request_Router |
|
| 51 | - */ |
|
| 52 | - protected $Module_Request_Router; |
|
| 53 | - |
|
| 54 | - |
|
| 55 | - /** |
|
| 56 | - * class constructor |
|
| 57 | - * should fire after shortcode, module, addon, or other plugin's default priority init phases have run |
|
| 58 | - * |
|
| 59 | - * @access public |
|
| 60 | - * @param \EE_Registry $Registry |
|
| 61 | - * @param \EE_Request_Handler $Request_Handler |
|
| 62 | - * @param \EE_Module_Request_Router $Module_Request_Router |
|
| 63 | - */ |
|
| 64 | - public function __construct( |
|
| 65 | - EE_Registry $Registry, |
|
| 66 | - EE_Request_Handler $Request_Handler, |
|
| 67 | - EE_Module_Request_Router $Module_Request_Router |
|
| 68 | - ) { |
|
| 69 | - $this->Registry = $Registry; |
|
| 70 | - $this->Request_Handler = $Request_Handler; |
|
| 71 | - $this->Module_Request_Router = $Module_Request_Router; |
|
| 72 | - // determine how to integrate WP_Query with the EE models |
|
| 73 | - add_action('AHEE__EE_System__initialize', array($this, 'employ_CPT_Strategy')); |
|
| 74 | - // load other resources and begin to actually run shortcodes and modules |
|
| 75 | - add_action('wp_loaded', array($this, 'wp_loaded'), 5); |
|
| 76 | - // analyse the incoming WP request |
|
| 77 | - add_action('parse_request', array($this, 'get_request'), 1, 1); |
|
| 78 | - // process request with module factory |
|
| 79 | - add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1); |
|
| 80 | - // before headers sent |
|
| 81 | - add_action('wp', array($this, 'wp'), 5); |
|
| 82 | - // primarily used to process any content shortcodes |
|
| 83 | - add_action('template_redirect', array($this, 'templateRedirect'), 999); |
|
| 84 | - // header |
|
| 85 | - add_action('wp_head', array($this, 'header_meta_tag'), 5); |
|
| 86 | - add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10); |
|
| 87 | - add_filter('template_include', array($this, 'template_include'), 1); |
|
| 88 | - // display errors |
|
| 89 | - add_action('loop_start', array($this, 'display_errors'), 2); |
|
| 90 | - // the content |
|
| 91 | - // add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 ); |
|
| 92 | - //exclude our private cpt comments |
|
| 93 | - add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1); |
|
| 94 | - //make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://) |
|
| 95 | - add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1); |
|
| 96 | - // action hook EE |
|
| 97 | - do_action('AHEE__EE_Front_Controller__construct__done', $this); |
|
| 98 | - // for checking that browser cookies are enabled |
|
| 99 | - if (apply_filters('FHEE__EE_Front_Controller____construct__set_test_cookie', true)) { |
|
| 100 | - setcookie('ee_cookie_test', uniqid('ect',true), time() + DAY_IN_SECONDS, '/'); |
|
| 101 | - } |
|
| 102 | - } |
|
| 103 | - |
|
| 104 | - |
|
| 105 | - /** |
|
| 106 | - * @return EE_Request_Handler |
|
| 107 | - */ |
|
| 108 | - public function Request_Handler() |
|
| 109 | - { |
|
| 110 | - return $this->Request_Handler; |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * @return EE_Module_Request_Router |
|
| 116 | - */ |
|
| 117 | - public function Module_Request_Router() |
|
| 118 | - { |
|
| 119 | - return $this->Module_Request_Router; |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - |
|
| 123 | - |
|
| 124 | - /** |
|
| 125 | - * @return LegacyShortcodesManager |
|
| 126 | - */ |
|
| 127 | - public function getLegacyShortcodesManager() |
|
| 128 | - { |
|
| 129 | - return EE_Config::getLegacyShortcodesManager(); |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - |
|
| 133 | - |
|
| 134 | - |
|
| 135 | - |
|
| 136 | - /*********************************************** INIT ACTION HOOK ***********************************************/ |
|
| 137 | - |
|
| 138 | - |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * filter_wp_comments |
|
| 142 | - * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment |
|
| 143 | - * widgets/queries done on frontend |
|
| 144 | - * |
|
| 145 | - * @param array $clauses array of comment clauses setup by WP_Comment_Query |
|
| 146 | - * @return array array of comment clauses with modifications. |
|
| 147 | - */ |
|
| 148 | - public function filter_wp_comments($clauses) |
|
| 149 | - { |
|
| 150 | - global $wpdb; |
|
| 151 | - if (strpos($clauses['join'], $wpdb->posts) !== false) { |
|
| 152 | - $cpts = EE_Register_CPTs::get_private_CPTs(); |
|
| 153 | - foreach ($cpts as $cpt => $details) { |
|
| 154 | - $clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt); |
|
| 155 | - } |
|
| 156 | - } |
|
| 157 | - return $clauses; |
|
| 158 | - } |
|
| 159 | - |
|
| 160 | - |
|
| 161 | - /** |
|
| 162 | - * employ_CPT_Strategy |
|
| 163 | - * |
|
| 164 | - * @access public |
|
| 165 | - * @return void |
|
| 166 | - */ |
|
| 167 | - public function employ_CPT_Strategy() |
|
| 168 | - { |
|
| 169 | - if (apply_filters('FHEE__EE_Front_Controller__employ_CPT_Strategy', true)) { |
|
| 170 | - $this->Registry->load_core('CPT_Strategy'); |
|
| 171 | - } |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - |
|
| 175 | - /** |
|
| 176 | - * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend |
|
| 177 | - * |
|
| 178 | - * @param string $url incoming url |
|
| 179 | - * @return string final assembled url |
|
| 180 | - */ |
|
| 181 | - public function maybe_force_admin_ajax_ssl($url) |
|
| 182 | - { |
|
| 183 | - if (is_ssl() && preg_match('/admin-ajax.php/', $url)) { |
|
| 184 | - $url = str_replace('http://', 'https://', $url); |
|
| 185 | - } |
|
| 186 | - return $url; |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - |
|
| 190 | - |
|
| 191 | - |
|
| 192 | - |
|
| 193 | - |
|
| 194 | - /*********************************************** WP_LOADED ACTION HOOK ***********************************************/ |
|
| 195 | - |
|
| 196 | - |
|
| 197 | - /** |
|
| 198 | - * wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their |
|
| 199 | - * default priority init phases have run |
|
| 200 | - * |
|
| 201 | - * @access public |
|
| 202 | - * @return void |
|
| 203 | - */ |
|
| 204 | - public function wp_loaded() |
|
| 205 | - { |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - |
|
| 209 | - |
|
| 210 | - |
|
| 211 | - |
|
| 212 | - /*********************************************** PARSE_REQUEST HOOK ***********************************************/ |
|
| 213 | - /** |
|
| 214 | - * _get_request |
|
| 215 | - * |
|
| 216 | - * @access public |
|
| 217 | - * @param WP $WP |
|
| 218 | - * @return void |
|
| 219 | - */ |
|
| 220 | - public function get_request(WP $WP) |
|
| 221 | - { |
|
| 222 | - do_action('AHEE__EE_Front_Controller__get_request__start'); |
|
| 223 | - $this->Request_Handler->parse_request($WP); |
|
| 224 | - do_action('AHEE__EE_Front_Controller__get_request__complete'); |
|
| 225 | - } |
|
| 226 | - |
|
| 227 | - |
|
| 228 | - |
|
| 229 | - /** |
|
| 230 | - * pre_get_posts - basically a module factory for instantiating modules and selecting the final view template |
|
| 231 | - * |
|
| 232 | - * @access public |
|
| 233 | - * @param WP_Query $WP_Query |
|
| 234 | - * @return void |
|
| 235 | - */ |
|
| 236 | - public function pre_get_posts($WP_Query) |
|
| 237 | - { |
|
| 238 | - // only load Module_Request_Router if this is the main query |
|
| 239 | - if ( |
|
| 240 | - $this->Module_Request_Router instanceof EE_Module_Request_Router |
|
| 241 | - && $WP_Query->is_main_query() |
|
| 242 | - ) { |
|
| 243 | - // cycle thru module routes |
|
| 244 | - while ($route = $this->Module_Request_Router->get_route($WP_Query)) { |
|
| 245 | - // determine module and method for route |
|
| 246 | - $module = $this->Module_Request_Router->resolve_route($route[0], $route[1]); |
|
| 247 | - if ($module instanceof EED_Module) { |
|
| 248 | - // get registered view for route |
|
| 249 | - $this->_template_path = $this->Module_Request_Router->get_view($route); |
|
| 250 | - // grab module name |
|
| 251 | - $module_name = $module->module_name(); |
|
| 252 | - // map the module to the module objects |
|
| 253 | - $this->Registry->modules->{$module_name} = $module; |
|
| 254 | - } |
|
| 255 | - } |
|
| 256 | - } |
|
| 257 | - } |
|
| 258 | - |
|
| 259 | - |
|
| 260 | - |
|
| 261 | - |
|
| 262 | - |
|
| 263 | - /*********************************************** WP HOOK ***********************************************/ |
|
| 264 | - |
|
| 265 | - |
|
| 266 | - /** |
|
| 267 | - * wp - basically last chance to do stuff before headers sent |
|
| 268 | - * |
|
| 269 | - * @access public |
|
| 270 | - * @return void |
|
| 271 | - */ |
|
| 272 | - public function wp() |
|
| 273 | - { |
|
| 274 | - } |
|
| 275 | - |
|
| 276 | - |
|
| 277 | - |
|
| 278 | - /*********************** GET_HEADER && WP_HEAD HOOK ***********************/ |
|
| 279 | - |
|
| 280 | - |
|
| 281 | - |
|
| 282 | - /** |
|
| 283 | - * callback for the "template_redirect" hook point |
|
| 284 | - * checks sidebars for EE widgets |
|
| 285 | - * loads resources and assets accordingly |
|
| 286 | - * |
|
| 287 | - * @return void |
|
| 288 | - */ |
|
| 289 | - public function templateRedirect() |
|
| 290 | - { |
|
| 291 | - global $wp_query; |
|
| 292 | - if (empty($wp_query->posts)){ |
|
| 293 | - return; |
|
| 294 | - } |
|
| 295 | - // if we already know this is an espresso page, then load assets |
|
| 296 | - $load_assets = $this->Request_Handler->is_espresso_page(); |
|
| 297 | - // if we are already loading assets then just move along, otherwise check for widgets |
|
| 298 | - $load_assets = $load_assets ? $load_assets : $this->espresso_widgets_in_active_sidebars(); |
|
| 299 | - if ( $load_assets){ |
|
| 300 | - wp_enqueue_style('espresso_default'); |
|
| 301 | - wp_enqueue_style('espresso_custom_css'); |
|
| 302 | - wp_enqueue_script('espresso_core'); |
|
| 303 | - } |
|
| 304 | - } |
|
| 305 | - |
|
| 306 | - |
|
| 307 | - |
|
| 308 | - /** |
|
| 309 | - * builds list of active widgets then scans active sidebars looking for them |
|
| 310 | - * returns true is an EE widget is found in an active sidebar |
|
| 311 | - * Please Note: this does NOT mean that the sidebar or widget |
|
| 312 | - * is actually in use in a given template, as that is unfortunately not known |
|
| 313 | - * until a sidebar and it's widgets are actually loaded |
|
| 314 | - * |
|
| 315 | - * @return boolean |
|
| 316 | - */ |
|
| 317 | - private function espresso_widgets_in_active_sidebars() |
|
| 318 | - { |
|
| 319 | - $espresso_widgets = array(); |
|
| 320 | - foreach ($this->Registry->widgets as $widget_class => $widget) { |
|
| 321 | - $id_base = EspressoWidget::getIdBase($widget_class); |
|
| 322 | - if (is_active_widget(false, false, $id_base)) { |
|
| 323 | - $espresso_widgets[] = $id_base; |
|
| 324 | - } |
|
| 325 | - } |
|
| 326 | - $all_sidebar_widgets = wp_get_sidebars_widgets(); |
|
| 327 | - foreach ($all_sidebar_widgets as $sidebar_name => $sidebar_widgets) { |
|
| 328 | - if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) { |
|
| 329 | - foreach ($sidebar_widgets as $sidebar_widget) { |
|
| 330 | - foreach ($espresso_widgets as $espresso_widget) { |
|
| 331 | - if (strpos($sidebar_widget, $espresso_widget) !== false) { |
|
| 332 | - return true; |
|
| 333 | - } |
|
| 334 | - } |
|
| 335 | - } |
|
| 336 | - } |
|
| 337 | - } |
|
| 338 | - return false; |
|
| 339 | - } |
|
| 340 | - |
|
| 341 | - |
|
| 342 | - |
|
| 343 | - |
|
| 344 | - /** |
|
| 345 | - * header_meta_tag |
|
| 346 | - * |
|
| 347 | - * @access public |
|
| 348 | - * @return void |
|
| 349 | - */ |
|
| 350 | - public function header_meta_tag() |
|
| 351 | - { |
|
| 352 | - print( |
|
| 353 | - apply_filters( |
|
| 354 | - 'FHEE__EE_Front_Controller__header_meta_tag', |
|
| 355 | - '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n") |
|
| 356 | - ); |
|
| 357 | - |
|
| 358 | - //let's exclude all event type taxonomy term archive pages from search engine indexing |
|
| 359 | - //@see https://events.codebasehq.com/projects/event-espresso/tickets/10249 |
|
| 360 | - //also exclude all critical pages from indexing |
|
| 361 | - if ( |
|
| 362 | - ( |
|
| 363 | - is_tax('espresso_event_type') |
|
| 364 | - && get_option( 'blog_public' ) !== '0' |
|
| 365 | - ) |
|
| 366 | - || is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array()) |
|
| 367 | - ) { |
|
| 368 | - print( |
|
| 369 | - apply_filters( |
|
| 370 | - 'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type', |
|
| 371 | - '<meta name="robots" content="noindex,follow" />' . "\n" |
|
| 372 | - ) |
|
| 373 | - ); |
|
| 374 | - } |
|
| 375 | - } |
|
| 376 | - |
|
| 377 | - |
|
| 378 | - |
|
| 379 | - /** |
|
| 380 | - * wp_print_scripts |
|
| 381 | - * |
|
| 382 | - * @return void |
|
| 383 | - */ |
|
| 384 | - public function wp_print_scripts() |
|
| 385 | - { |
|
| 386 | - global $post; |
|
| 387 | - if ( |
|
| 388 | - isset($post->EE_Event) |
|
| 389 | - && $post->EE_Event instanceof EE_Event |
|
| 390 | - && get_post_type() === 'espresso_events' |
|
| 391 | - && is_singular() |
|
| 392 | - ) { |
|
| 393 | - \EEH_Schema::add_json_linked_data_for_event($post->EE_Event); |
|
| 394 | - } |
|
| 395 | - } |
|
| 396 | - |
|
| 397 | - |
|
| 398 | - |
|
| 399 | - |
|
| 400 | - /*********************************************** THE_CONTENT FILTER HOOK ********************************************** |
|
| 29 | + /** |
|
| 30 | + * @var string $_template_path |
|
| 31 | + */ |
|
| 32 | + private $_template_path; |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * @var string $_template |
|
| 36 | + */ |
|
| 37 | + private $_template; |
|
| 38 | + |
|
| 39 | + /** |
|
| 40 | + * @type EE_Registry $Registry |
|
| 41 | + */ |
|
| 42 | + protected $Registry; |
|
| 43 | + |
|
| 44 | + /** |
|
| 45 | + * @type EE_Request_Handler $Request_Handler |
|
| 46 | + */ |
|
| 47 | + protected $Request_Handler; |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * @type EE_Module_Request_Router $Module_Request_Router |
|
| 51 | + */ |
|
| 52 | + protected $Module_Request_Router; |
|
| 53 | + |
|
| 54 | + |
|
| 55 | + /** |
|
| 56 | + * class constructor |
|
| 57 | + * should fire after shortcode, module, addon, or other plugin's default priority init phases have run |
|
| 58 | + * |
|
| 59 | + * @access public |
|
| 60 | + * @param \EE_Registry $Registry |
|
| 61 | + * @param \EE_Request_Handler $Request_Handler |
|
| 62 | + * @param \EE_Module_Request_Router $Module_Request_Router |
|
| 63 | + */ |
|
| 64 | + public function __construct( |
|
| 65 | + EE_Registry $Registry, |
|
| 66 | + EE_Request_Handler $Request_Handler, |
|
| 67 | + EE_Module_Request_Router $Module_Request_Router |
|
| 68 | + ) { |
|
| 69 | + $this->Registry = $Registry; |
|
| 70 | + $this->Request_Handler = $Request_Handler; |
|
| 71 | + $this->Module_Request_Router = $Module_Request_Router; |
|
| 72 | + // determine how to integrate WP_Query with the EE models |
|
| 73 | + add_action('AHEE__EE_System__initialize', array($this, 'employ_CPT_Strategy')); |
|
| 74 | + // load other resources and begin to actually run shortcodes and modules |
|
| 75 | + add_action('wp_loaded', array($this, 'wp_loaded'), 5); |
|
| 76 | + // analyse the incoming WP request |
|
| 77 | + add_action('parse_request', array($this, 'get_request'), 1, 1); |
|
| 78 | + // process request with module factory |
|
| 79 | + add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1); |
|
| 80 | + // before headers sent |
|
| 81 | + add_action('wp', array($this, 'wp'), 5); |
|
| 82 | + // primarily used to process any content shortcodes |
|
| 83 | + add_action('template_redirect', array($this, 'templateRedirect'), 999); |
|
| 84 | + // header |
|
| 85 | + add_action('wp_head', array($this, 'header_meta_tag'), 5); |
|
| 86 | + add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10); |
|
| 87 | + add_filter('template_include', array($this, 'template_include'), 1); |
|
| 88 | + // display errors |
|
| 89 | + add_action('loop_start', array($this, 'display_errors'), 2); |
|
| 90 | + // the content |
|
| 91 | + // add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 ); |
|
| 92 | + //exclude our private cpt comments |
|
| 93 | + add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1); |
|
| 94 | + //make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://) |
|
| 95 | + add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1); |
|
| 96 | + // action hook EE |
|
| 97 | + do_action('AHEE__EE_Front_Controller__construct__done', $this); |
|
| 98 | + // for checking that browser cookies are enabled |
|
| 99 | + if (apply_filters('FHEE__EE_Front_Controller____construct__set_test_cookie', true)) { |
|
| 100 | + setcookie('ee_cookie_test', uniqid('ect',true), time() + DAY_IN_SECONDS, '/'); |
|
| 101 | + } |
|
| 102 | + } |
|
| 103 | + |
|
| 104 | + |
|
| 105 | + /** |
|
| 106 | + * @return EE_Request_Handler |
|
| 107 | + */ |
|
| 108 | + public function Request_Handler() |
|
| 109 | + { |
|
| 110 | + return $this->Request_Handler; |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * @return EE_Module_Request_Router |
|
| 116 | + */ |
|
| 117 | + public function Module_Request_Router() |
|
| 118 | + { |
|
| 119 | + return $this->Module_Request_Router; |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + |
|
| 123 | + |
|
| 124 | + /** |
|
| 125 | + * @return LegacyShortcodesManager |
|
| 126 | + */ |
|
| 127 | + public function getLegacyShortcodesManager() |
|
| 128 | + { |
|
| 129 | + return EE_Config::getLegacyShortcodesManager(); |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + |
|
| 133 | + |
|
| 134 | + |
|
| 135 | + |
|
| 136 | + /*********************************************** INIT ACTION HOOK ***********************************************/ |
|
| 137 | + |
|
| 138 | + |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * filter_wp_comments |
|
| 142 | + * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment |
|
| 143 | + * widgets/queries done on frontend |
|
| 144 | + * |
|
| 145 | + * @param array $clauses array of comment clauses setup by WP_Comment_Query |
|
| 146 | + * @return array array of comment clauses with modifications. |
|
| 147 | + */ |
|
| 148 | + public function filter_wp_comments($clauses) |
|
| 149 | + { |
|
| 150 | + global $wpdb; |
|
| 151 | + if (strpos($clauses['join'], $wpdb->posts) !== false) { |
|
| 152 | + $cpts = EE_Register_CPTs::get_private_CPTs(); |
|
| 153 | + foreach ($cpts as $cpt => $details) { |
|
| 154 | + $clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt); |
|
| 155 | + } |
|
| 156 | + } |
|
| 157 | + return $clauses; |
|
| 158 | + } |
|
| 159 | + |
|
| 160 | + |
|
| 161 | + /** |
|
| 162 | + * employ_CPT_Strategy |
|
| 163 | + * |
|
| 164 | + * @access public |
|
| 165 | + * @return void |
|
| 166 | + */ |
|
| 167 | + public function employ_CPT_Strategy() |
|
| 168 | + { |
|
| 169 | + if (apply_filters('FHEE__EE_Front_Controller__employ_CPT_Strategy', true)) { |
|
| 170 | + $this->Registry->load_core('CPT_Strategy'); |
|
| 171 | + } |
|
| 172 | + } |
|
| 173 | + |
|
| 174 | + |
|
| 175 | + /** |
|
| 176 | + * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend |
|
| 177 | + * |
|
| 178 | + * @param string $url incoming url |
|
| 179 | + * @return string final assembled url |
|
| 180 | + */ |
|
| 181 | + public function maybe_force_admin_ajax_ssl($url) |
|
| 182 | + { |
|
| 183 | + if (is_ssl() && preg_match('/admin-ajax.php/', $url)) { |
|
| 184 | + $url = str_replace('http://', 'https://', $url); |
|
| 185 | + } |
|
| 186 | + return $url; |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + |
|
| 190 | + |
|
| 191 | + |
|
| 192 | + |
|
| 193 | + |
|
| 194 | + /*********************************************** WP_LOADED ACTION HOOK ***********************************************/ |
|
| 195 | + |
|
| 196 | + |
|
| 197 | + /** |
|
| 198 | + * wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their |
|
| 199 | + * default priority init phases have run |
|
| 200 | + * |
|
| 201 | + * @access public |
|
| 202 | + * @return void |
|
| 203 | + */ |
|
| 204 | + public function wp_loaded() |
|
| 205 | + { |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + |
|
| 209 | + |
|
| 210 | + |
|
| 211 | + |
|
| 212 | + /*********************************************** PARSE_REQUEST HOOK ***********************************************/ |
|
| 213 | + /** |
|
| 214 | + * _get_request |
|
| 215 | + * |
|
| 216 | + * @access public |
|
| 217 | + * @param WP $WP |
|
| 218 | + * @return void |
|
| 219 | + */ |
|
| 220 | + public function get_request(WP $WP) |
|
| 221 | + { |
|
| 222 | + do_action('AHEE__EE_Front_Controller__get_request__start'); |
|
| 223 | + $this->Request_Handler->parse_request($WP); |
|
| 224 | + do_action('AHEE__EE_Front_Controller__get_request__complete'); |
|
| 225 | + } |
|
| 226 | + |
|
| 227 | + |
|
| 228 | + |
|
| 229 | + /** |
|
| 230 | + * pre_get_posts - basically a module factory for instantiating modules and selecting the final view template |
|
| 231 | + * |
|
| 232 | + * @access public |
|
| 233 | + * @param WP_Query $WP_Query |
|
| 234 | + * @return void |
|
| 235 | + */ |
|
| 236 | + public function pre_get_posts($WP_Query) |
|
| 237 | + { |
|
| 238 | + // only load Module_Request_Router if this is the main query |
|
| 239 | + if ( |
|
| 240 | + $this->Module_Request_Router instanceof EE_Module_Request_Router |
|
| 241 | + && $WP_Query->is_main_query() |
|
| 242 | + ) { |
|
| 243 | + // cycle thru module routes |
|
| 244 | + while ($route = $this->Module_Request_Router->get_route($WP_Query)) { |
|
| 245 | + // determine module and method for route |
|
| 246 | + $module = $this->Module_Request_Router->resolve_route($route[0], $route[1]); |
|
| 247 | + if ($module instanceof EED_Module) { |
|
| 248 | + // get registered view for route |
|
| 249 | + $this->_template_path = $this->Module_Request_Router->get_view($route); |
|
| 250 | + // grab module name |
|
| 251 | + $module_name = $module->module_name(); |
|
| 252 | + // map the module to the module objects |
|
| 253 | + $this->Registry->modules->{$module_name} = $module; |
|
| 254 | + } |
|
| 255 | + } |
|
| 256 | + } |
|
| 257 | + } |
|
| 258 | + |
|
| 259 | + |
|
| 260 | + |
|
| 261 | + |
|
| 262 | + |
|
| 263 | + /*********************************************** WP HOOK ***********************************************/ |
|
| 264 | + |
|
| 265 | + |
|
| 266 | + /** |
|
| 267 | + * wp - basically last chance to do stuff before headers sent |
|
| 268 | + * |
|
| 269 | + * @access public |
|
| 270 | + * @return void |
|
| 271 | + */ |
|
| 272 | + public function wp() |
|
| 273 | + { |
|
| 274 | + } |
|
| 275 | + |
|
| 276 | + |
|
| 277 | + |
|
| 278 | + /*********************** GET_HEADER && WP_HEAD HOOK ***********************/ |
|
| 279 | + |
|
| 280 | + |
|
| 281 | + |
|
| 282 | + /** |
|
| 283 | + * callback for the "template_redirect" hook point |
|
| 284 | + * checks sidebars for EE widgets |
|
| 285 | + * loads resources and assets accordingly |
|
| 286 | + * |
|
| 287 | + * @return void |
|
| 288 | + */ |
|
| 289 | + public function templateRedirect() |
|
| 290 | + { |
|
| 291 | + global $wp_query; |
|
| 292 | + if (empty($wp_query->posts)){ |
|
| 293 | + return; |
|
| 294 | + } |
|
| 295 | + // if we already know this is an espresso page, then load assets |
|
| 296 | + $load_assets = $this->Request_Handler->is_espresso_page(); |
|
| 297 | + // if we are already loading assets then just move along, otherwise check for widgets |
|
| 298 | + $load_assets = $load_assets ? $load_assets : $this->espresso_widgets_in_active_sidebars(); |
|
| 299 | + if ( $load_assets){ |
|
| 300 | + wp_enqueue_style('espresso_default'); |
|
| 301 | + wp_enqueue_style('espresso_custom_css'); |
|
| 302 | + wp_enqueue_script('espresso_core'); |
|
| 303 | + } |
|
| 304 | + } |
|
| 305 | + |
|
| 306 | + |
|
| 307 | + |
|
| 308 | + /** |
|
| 309 | + * builds list of active widgets then scans active sidebars looking for them |
|
| 310 | + * returns true is an EE widget is found in an active sidebar |
|
| 311 | + * Please Note: this does NOT mean that the sidebar or widget |
|
| 312 | + * is actually in use in a given template, as that is unfortunately not known |
|
| 313 | + * until a sidebar and it's widgets are actually loaded |
|
| 314 | + * |
|
| 315 | + * @return boolean |
|
| 316 | + */ |
|
| 317 | + private function espresso_widgets_in_active_sidebars() |
|
| 318 | + { |
|
| 319 | + $espresso_widgets = array(); |
|
| 320 | + foreach ($this->Registry->widgets as $widget_class => $widget) { |
|
| 321 | + $id_base = EspressoWidget::getIdBase($widget_class); |
|
| 322 | + if (is_active_widget(false, false, $id_base)) { |
|
| 323 | + $espresso_widgets[] = $id_base; |
|
| 324 | + } |
|
| 325 | + } |
|
| 326 | + $all_sidebar_widgets = wp_get_sidebars_widgets(); |
|
| 327 | + foreach ($all_sidebar_widgets as $sidebar_name => $sidebar_widgets) { |
|
| 328 | + if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) { |
|
| 329 | + foreach ($sidebar_widgets as $sidebar_widget) { |
|
| 330 | + foreach ($espresso_widgets as $espresso_widget) { |
|
| 331 | + if (strpos($sidebar_widget, $espresso_widget) !== false) { |
|
| 332 | + return true; |
|
| 333 | + } |
|
| 334 | + } |
|
| 335 | + } |
|
| 336 | + } |
|
| 337 | + } |
|
| 338 | + return false; |
|
| 339 | + } |
|
| 340 | + |
|
| 341 | + |
|
| 342 | + |
|
| 343 | + |
|
| 344 | + /** |
|
| 345 | + * header_meta_tag |
|
| 346 | + * |
|
| 347 | + * @access public |
|
| 348 | + * @return void |
|
| 349 | + */ |
|
| 350 | + public function header_meta_tag() |
|
| 351 | + { |
|
| 352 | + print( |
|
| 353 | + apply_filters( |
|
| 354 | + 'FHEE__EE_Front_Controller__header_meta_tag', |
|
| 355 | + '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n") |
|
| 356 | + ); |
|
| 357 | + |
|
| 358 | + //let's exclude all event type taxonomy term archive pages from search engine indexing |
|
| 359 | + //@see https://events.codebasehq.com/projects/event-espresso/tickets/10249 |
|
| 360 | + //also exclude all critical pages from indexing |
|
| 361 | + if ( |
|
| 362 | + ( |
|
| 363 | + is_tax('espresso_event_type') |
|
| 364 | + && get_option( 'blog_public' ) !== '0' |
|
| 365 | + ) |
|
| 366 | + || is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array()) |
|
| 367 | + ) { |
|
| 368 | + print( |
|
| 369 | + apply_filters( |
|
| 370 | + 'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type', |
|
| 371 | + '<meta name="robots" content="noindex,follow" />' . "\n" |
|
| 372 | + ) |
|
| 373 | + ); |
|
| 374 | + } |
|
| 375 | + } |
|
| 376 | + |
|
| 377 | + |
|
| 378 | + |
|
| 379 | + /** |
|
| 380 | + * wp_print_scripts |
|
| 381 | + * |
|
| 382 | + * @return void |
|
| 383 | + */ |
|
| 384 | + public function wp_print_scripts() |
|
| 385 | + { |
|
| 386 | + global $post; |
|
| 387 | + if ( |
|
| 388 | + isset($post->EE_Event) |
|
| 389 | + && $post->EE_Event instanceof EE_Event |
|
| 390 | + && get_post_type() === 'espresso_events' |
|
| 391 | + && is_singular() |
|
| 392 | + ) { |
|
| 393 | + \EEH_Schema::add_json_linked_data_for_event($post->EE_Event); |
|
| 394 | + } |
|
| 395 | + } |
|
| 396 | + |
|
| 397 | + |
|
| 398 | + |
|
| 399 | + |
|
| 400 | + /*********************************************** THE_CONTENT FILTER HOOK ********************************************** |
|
| 401 | 401 | |
| 402 | 402 | |
| 403 | 403 | |
@@ -408,99 +408,99 @@ discard block |
||
| 408 | 408 | // * @param $the_content |
| 409 | 409 | // * @return string |
| 410 | 410 | // */ |
| 411 | - // public function the_content( $the_content ) { |
|
| 412 | - // // nothing gets loaded at this point unless other systems turn this hookpoint on by using: add_filter( 'FHEE_run_EE_the_content', '__return_true' ); |
|
| 413 | - // if ( apply_filters( 'FHEE_run_EE_the_content', FALSE ) ) { |
|
| 414 | - // } |
|
| 415 | - // return $the_content; |
|
| 416 | - // } |
|
| 417 | - |
|
| 418 | - |
|
| 419 | - |
|
| 420 | - /*********************************************** WP_FOOTER ***********************************************/ |
|
| 421 | - |
|
| 422 | - |
|
| 423 | - /** |
|
| 424 | - * display_errors |
|
| 425 | - * |
|
| 426 | - * @access public |
|
| 427 | - * @return void |
|
| 428 | - */ |
|
| 429 | - public function display_errors() |
|
| 430 | - { |
|
| 431 | - static $shown_already = false; |
|
| 432 | - do_action('AHEE__EE_Front_Controller__display_errors__begin'); |
|
| 433 | - if ( |
|
| 434 | - ! $shown_already |
|
| 435 | - && apply_filters('FHEE__EE_Front_Controller__display_errors', true) |
|
| 436 | - && is_main_query() |
|
| 437 | - && ! is_feed() |
|
| 438 | - && in_the_loop() |
|
| 439 | - && $this->Request_Handler->is_espresso_page() |
|
| 440 | - ) { |
|
| 441 | - echo EE_Error::get_notices(); |
|
| 442 | - $shown_already = true; |
|
| 443 | - EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php'); |
|
| 444 | - } |
|
| 445 | - do_action('AHEE__EE_Front_Controller__display_errors__end'); |
|
| 446 | - } |
|
| 447 | - |
|
| 448 | - |
|
| 449 | - |
|
| 450 | - |
|
| 451 | - |
|
| 452 | - /*********************************************** UTILITIES ***********************************************/ |
|
| 453 | - /** |
|
| 454 | - * template_include |
|
| 455 | - * |
|
| 456 | - * @access public |
|
| 457 | - * @param string $template_include_path |
|
| 458 | - * @return string |
|
| 459 | - */ |
|
| 460 | - public function template_include($template_include_path = null) |
|
| 461 | - { |
|
| 462 | - if ($this->Request_Handler->is_espresso_page()) { |
|
| 463 | - $this->_template_path = ! empty($this->_template_path) ? basename($this->_template_path) : basename($template_include_path); |
|
| 464 | - $template_path = EEH_Template::locate_template($this->_template_path, array(), false); |
|
| 465 | - $this->_template_path = ! empty($template_path) ? $template_path : $template_include_path; |
|
| 466 | - $this->_template = basename($this->_template_path); |
|
| 467 | - return $this->_template_path; |
|
| 468 | - } |
|
| 469 | - return $template_include_path; |
|
| 470 | - } |
|
| 471 | - |
|
| 472 | - |
|
| 473 | - /** |
|
| 474 | - * get_selected_template |
|
| 475 | - * |
|
| 476 | - * @access public |
|
| 477 | - * @param bool $with_path |
|
| 478 | - * @return string |
|
| 479 | - */ |
|
| 480 | - public function get_selected_template($with_path = false) |
|
| 481 | - { |
|
| 482 | - return $with_path ? $this->_template_path : $this->_template; |
|
| 483 | - } |
|
| 484 | - |
|
| 485 | - |
|
| 486 | - |
|
| 487 | - /** |
|
| 488 | - * @deprecated 4.9.26 |
|
| 489 | - * @param string $shortcode_class |
|
| 490 | - * @param \WP $wp |
|
| 491 | - */ |
|
| 492 | - public function initialize_shortcode($shortcode_class = '', WP $wp = null) |
|
| 493 | - { |
|
| 494 | - \EE_Error::doing_it_wrong( |
|
| 495 | - __METHOD__, |
|
| 496 | - __( |
|
| 497 | - 'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.', |
|
| 498 | - 'event_espresso' |
|
| 499 | - ), |
|
| 500 | - '4.9.26' |
|
| 501 | - ); |
|
| 502 | - $this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp); |
|
| 503 | - } |
|
| 411 | + // public function the_content( $the_content ) { |
|
| 412 | + // // nothing gets loaded at this point unless other systems turn this hookpoint on by using: add_filter( 'FHEE_run_EE_the_content', '__return_true' ); |
|
| 413 | + // if ( apply_filters( 'FHEE_run_EE_the_content', FALSE ) ) { |
|
| 414 | + // } |
|
| 415 | + // return $the_content; |
|
| 416 | + // } |
|
| 417 | + |
|
| 418 | + |
|
| 419 | + |
|
| 420 | + /*********************************************** WP_FOOTER ***********************************************/ |
|
| 421 | + |
|
| 422 | + |
|
| 423 | + /** |
|
| 424 | + * display_errors |
|
| 425 | + * |
|
| 426 | + * @access public |
|
| 427 | + * @return void |
|
| 428 | + */ |
|
| 429 | + public function display_errors() |
|
| 430 | + { |
|
| 431 | + static $shown_already = false; |
|
| 432 | + do_action('AHEE__EE_Front_Controller__display_errors__begin'); |
|
| 433 | + if ( |
|
| 434 | + ! $shown_already |
|
| 435 | + && apply_filters('FHEE__EE_Front_Controller__display_errors', true) |
|
| 436 | + && is_main_query() |
|
| 437 | + && ! is_feed() |
|
| 438 | + && in_the_loop() |
|
| 439 | + && $this->Request_Handler->is_espresso_page() |
|
| 440 | + ) { |
|
| 441 | + echo EE_Error::get_notices(); |
|
| 442 | + $shown_already = true; |
|
| 443 | + EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php'); |
|
| 444 | + } |
|
| 445 | + do_action('AHEE__EE_Front_Controller__display_errors__end'); |
|
| 446 | + } |
|
| 447 | + |
|
| 448 | + |
|
| 449 | + |
|
| 450 | + |
|
| 451 | + |
|
| 452 | + /*********************************************** UTILITIES ***********************************************/ |
|
| 453 | + /** |
|
| 454 | + * template_include |
|
| 455 | + * |
|
| 456 | + * @access public |
|
| 457 | + * @param string $template_include_path |
|
| 458 | + * @return string |
|
| 459 | + */ |
|
| 460 | + public function template_include($template_include_path = null) |
|
| 461 | + { |
|
| 462 | + if ($this->Request_Handler->is_espresso_page()) { |
|
| 463 | + $this->_template_path = ! empty($this->_template_path) ? basename($this->_template_path) : basename($template_include_path); |
|
| 464 | + $template_path = EEH_Template::locate_template($this->_template_path, array(), false); |
|
| 465 | + $this->_template_path = ! empty($template_path) ? $template_path : $template_include_path; |
|
| 466 | + $this->_template = basename($this->_template_path); |
|
| 467 | + return $this->_template_path; |
|
| 468 | + } |
|
| 469 | + return $template_include_path; |
|
| 470 | + } |
|
| 471 | + |
|
| 472 | + |
|
| 473 | + /** |
|
| 474 | + * get_selected_template |
|
| 475 | + * |
|
| 476 | + * @access public |
|
| 477 | + * @param bool $with_path |
|
| 478 | + * @return string |
|
| 479 | + */ |
|
| 480 | + public function get_selected_template($with_path = false) |
|
| 481 | + { |
|
| 482 | + return $with_path ? $this->_template_path : $this->_template; |
|
| 483 | + } |
|
| 484 | + |
|
| 485 | + |
|
| 486 | + |
|
| 487 | + /** |
|
| 488 | + * @deprecated 4.9.26 |
|
| 489 | + * @param string $shortcode_class |
|
| 490 | + * @param \WP $wp |
|
| 491 | + */ |
|
| 492 | + public function initialize_shortcode($shortcode_class = '', WP $wp = null) |
|
| 493 | + { |
|
| 494 | + \EE_Error::doing_it_wrong( |
|
| 495 | + __METHOD__, |
|
| 496 | + __( |
|
| 497 | + 'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.', |
|
| 498 | + 'event_espresso' |
|
| 499 | + ), |
|
| 500 | + '4.9.26' |
|
| 501 | + ); |
|
| 502 | + $this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp); |
|
| 503 | + } |
|
| 504 | 504 | |
| 505 | 505 | } |
| 506 | 506 | // End of file EE_Front_Controller.core.php |
@@ -97,7 +97,7 @@ discard block |
||
| 97 | 97 | do_action('AHEE__EE_Front_Controller__construct__done', $this); |
| 98 | 98 | // for checking that browser cookies are enabled |
| 99 | 99 | if (apply_filters('FHEE__EE_Front_Controller____construct__set_test_cookie', true)) { |
| 100 | - setcookie('ee_cookie_test', uniqid('ect',true), time() + DAY_IN_SECONDS, '/'); |
|
| 100 | + setcookie('ee_cookie_test', uniqid('ect', true), time() + DAY_IN_SECONDS, '/'); |
|
| 101 | 101 | } |
| 102 | 102 | } |
| 103 | 103 | |
@@ -289,14 +289,14 @@ discard block |
||
| 289 | 289 | public function templateRedirect() |
| 290 | 290 | { |
| 291 | 291 | global $wp_query; |
| 292 | - if (empty($wp_query->posts)){ |
|
| 292 | + if (empty($wp_query->posts)) { |
|
| 293 | 293 | return; |
| 294 | 294 | } |
| 295 | 295 | // if we already know this is an espresso page, then load assets |
| 296 | 296 | $load_assets = $this->Request_Handler->is_espresso_page(); |
| 297 | 297 | // if we are already loading assets then just move along, otherwise check for widgets |
| 298 | 298 | $load_assets = $load_assets ? $load_assets : $this->espresso_widgets_in_active_sidebars(); |
| 299 | - if ( $load_assets){ |
|
| 299 | + if ($load_assets) { |
|
| 300 | 300 | wp_enqueue_style('espresso_default'); |
| 301 | 301 | wp_enqueue_style('espresso_custom_css'); |
| 302 | 302 | wp_enqueue_script('espresso_core'); |
@@ -352,7 +352,7 @@ discard block |
||
| 352 | 352 | print( |
| 353 | 353 | apply_filters( |
| 354 | 354 | 'FHEE__EE_Front_Controller__header_meta_tag', |
| 355 | - '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n") |
|
| 355 | + '<meta name="generator" content="Event Espresso Version '.EVENT_ESPRESSO_VERSION."\" />\n") |
|
| 356 | 356 | ); |
| 357 | 357 | |
| 358 | 358 | //let's exclude all event type taxonomy term archive pages from search engine indexing |
@@ -361,14 +361,14 @@ discard block |
||
| 361 | 361 | if ( |
| 362 | 362 | ( |
| 363 | 363 | is_tax('espresso_event_type') |
| 364 | - && get_option( 'blog_public' ) !== '0' |
|
| 364 | + && get_option('blog_public') !== '0' |
|
| 365 | 365 | ) |
| 366 | 366 | || is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array()) |
| 367 | 367 | ) { |
| 368 | 368 | print( |
| 369 | 369 | apply_filters( |
| 370 | 370 | 'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type', |
| 371 | - '<meta name="robots" content="noindex,follow" />' . "\n" |
|
| 371 | + '<meta name="robots" content="noindex,follow" />'."\n" |
|
| 372 | 372 | ) |
| 373 | 373 | ); |
| 374 | 374 | } |
@@ -440,7 +440,7 @@ discard block |
||
| 440 | 440 | ) { |
| 441 | 441 | echo EE_Error::get_notices(); |
| 442 | 442 | $shown_already = true; |
| 443 | - EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php'); |
|
| 443 | + EEH_Template::display_template(EE_TEMPLATES.'espresso-ajax-notices.template.php'); |
|
| 444 | 444 | } |
| 445 | 445 | do_action('AHEE__EE_Front_Controller__display_errors__end'); |
| 446 | 446 | } |
@@ -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,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,1691 +15,1691 @@ 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); |
|
| 164 | - return true; |
|
| 165 | - } else { |
|
| 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 | - /** |
|
| 175 | - * update REGs and TXN when cancelled or declined registrations involved |
|
| 176 | - * |
|
| 177 | - * @param string $new_STS_ID |
|
| 178 | - * @param string $old_STS_ID |
|
| 179 | - * @throws \EE_Error |
|
| 180 | - */ |
|
| 181 | - private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID) |
|
| 182 | - { |
|
| 183 | - // these reg statuses should not be considered in any calculations involving monies owing |
|
| 184 | - $closed_reg_statuses = EEM_Registration::closed_reg_statuses(); |
|
| 185 | - // true if registration has been cancelled or declined |
|
| 186 | - if ( |
|
| 187 | - in_array($new_STS_ID, $closed_reg_statuses, true) |
|
| 188 | - && ! in_array($old_STS_ID, $closed_reg_statuses, true) |
|
| 189 | - ) { |
|
| 190 | - /** @type EE_Registration_Processor $registration_processor */ |
|
| 191 | - $registration_processor = EE_Registry::instance()->load_class('Registration_Processor'); |
|
| 192 | - /** @type EE_Transaction_Processor $transaction_processor */ |
|
| 193 | - $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
| 194 | - // cancelled or declined registration |
|
| 195 | - $registration_processor->update_registration_after_being_canceled_or_declined( |
|
| 196 | - $this, |
|
| 197 | - $closed_reg_statuses |
|
| 198 | - ); |
|
| 199 | - $transaction_processor->update_transaction_after_canceled_or_declined_registration( |
|
| 200 | - $this, |
|
| 201 | - $closed_reg_statuses, |
|
| 202 | - false |
|
| 203 | - ); |
|
| 204 | - do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID); |
|
| 205 | - return; |
|
| 206 | - } |
|
| 207 | - // true if reinstating cancelled or declined registration |
|
| 208 | - if ( |
|
| 209 | - in_array($old_STS_ID, $closed_reg_statuses, true) |
|
| 210 | - && ! in_array($new_STS_ID, $closed_reg_statuses, true) |
|
| 211 | - ) { |
|
| 212 | - /** @type EE_Registration_Processor $registration_processor */ |
|
| 213 | - $registration_processor = EE_Registry::instance()->load_class('Registration_Processor'); |
|
| 214 | - /** @type EE_Transaction_Processor $transaction_processor */ |
|
| 215 | - $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
| 216 | - // reinstating cancelled or declined registration |
|
| 217 | - $registration_processor->update_canceled_or_declined_registration_after_being_reinstated( |
|
| 218 | - $this, |
|
| 219 | - $closed_reg_statuses |
|
| 220 | - ); |
|
| 221 | - $transaction_processor->update_transaction_after_reinstating_canceled_registration( |
|
| 222 | - $this, |
|
| 223 | - $closed_reg_statuses, |
|
| 224 | - false |
|
| 225 | - ); |
|
| 226 | - do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID); |
|
| 227 | - } |
|
| 228 | - } |
|
| 229 | - |
|
| 230 | - |
|
| 231 | - /** |
|
| 232 | - * get Status ID |
|
| 233 | - */ |
|
| 234 | - public function status_ID() |
|
| 235 | - { |
|
| 236 | - return $this->get('STS_ID'); |
|
| 237 | - } |
|
| 238 | - |
|
| 239 | - |
|
| 240 | - /** |
|
| 241 | - * increments this registration's related ticket sold and corresponding datetime sold values |
|
| 242 | - * |
|
| 243 | - * @return void |
|
| 244 | - * @throws \EE_Error |
|
| 245 | - */ |
|
| 246 | - private function _reserve_registration_space() |
|
| 247 | - { |
|
| 248 | - // reserved ticket and datetime counts will be decremented as sold counts are incremented |
|
| 249 | - // so stop tracking that this reg has a ticket reserved |
|
| 250 | - $this->release_reserved_ticket(); |
|
| 251 | - $ticket = $this->ticket(); |
|
| 252 | - $ticket->increase_sold(); |
|
| 253 | - $ticket->save(); |
|
| 254 | - // possibly set event status to sold out |
|
| 255 | - $this->event()->perform_sold_out_status_check(); |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - |
|
| 259 | - /** |
|
| 260 | - * Gets the ticket this registration is for |
|
| 261 | - * |
|
| 262 | - * @param boolean $include_archived whether to include archived tickets or not. |
|
| 263 | - * @return EE_Ticket|EE_Base_Class |
|
| 264 | - * @throws \EE_Error |
|
| 265 | - */ |
|
| 266 | - public function ticket($include_archived = true) |
|
| 267 | - { |
|
| 268 | - $query_params = array(); |
|
| 269 | - if ($include_archived) { |
|
| 270 | - $query_params['default_where_conditions'] = 'none'; |
|
| 271 | - } |
|
| 272 | - return $this->get_first_related('Ticket', $query_params); |
|
| 273 | - } |
|
| 274 | - |
|
| 275 | - |
|
| 276 | - /** |
|
| 277 | - * Gets the event this registration is for |
|
| 278 | - * |
|
| 279 | - * @return EE_Event |
|
| 280 | - */ |
|
| 281 | - public function event() |
|
| 282 | - { |
|
| 283 | - $event = $this->get_first_related('Event'); |
|
| 284 | - if (! $event instanceof \EE_Event) { |
|
| 285 | - throw new EntityNotFoundException('Event ID', $this->event_ID()); |
|
| 286 | - } |
|
| 287 | - return $event; |
|
| 288 | - } |
|
| 289 | - |
|
| 290 | - |
|
| 291 | - /** |
|
| 292 | - * Gets the "author" of the registration. Note that for the purposes of registrations, the author will correspond |
|
| 293 | - * with the author of the event this registration is for. |
|
| 294 | - * |
|
| 295 | - * @since 4.5.0 |
|
| 296 | - * @return int |
|
| 297 | - */ |
|
| 298 | - public function wp_user() |
|
| 299 | - { |
|
| 300 | - $event = $this->event(); |
|
| 301 | - if ($event instanceof EE_Event) { |
|
| 302 | - return $event->wp_user(); |
|
| 303 | - } |
|
| 304 | - return 0; |
|
| 305 | - } |
|
| 306 | - |
|
| 307 | - |
|
| 308 | - /** |
|
| 309 | - * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values |
|
| 310 | - * |
|
| 311 | - * @return void |
|
| 312 | - * @throws \EE_Error |
|
| 313 | - */ |
|
| 314 | - private function _release_registration_space() |
|
| 315 | - { |
|
| 316 | - $ticket = $this->ticket(); |
|
| 317 | - $ticket->decrease_sold(); |
|
| 318 | - $ticket->save(); |
|
| 319 | - } |
|
| 320 | - |
|
| 321 | - |
|
| 322 | - /** |
|
| 323 | - * tracks this registration's ticket reservation in extra meta |
|
| 324 | - * and can increment related ticket reserved and corresponding datetime reserved values |
|
| 325 | - * |
|
| 326 | - * @param bool $update_ticket if true, will increment ticket and datetime reserved count |
|
| 327 | - * @return void |
|
| 328 | - * @throws \EE_Error |
|
| 329 | - */ |
|
| 330 | - public function reserve_ticket($update_ticket = false) |
|
| 331 | - { |
|
| 332 | - if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) { |
|
| 333 | - // PLZ NOTE: although checking $update_ticket first would be more efficient, |
|
| 334 | - // we NEED to ALWAYS call update_extra_meta(), which is why that is done first |
|
| 335 | - if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) { |
|
| 336 | - $ticket = $this->ticket(); |
|
| 337 | - $ticket->increase_reserved(); |
|
| 338 | - $ticket->save(); |
|
| 339 | - } |
|
| 340 | - } |
|
| 341 | - } |
|
| 342 | - |
|
| 343 | - |
|
| 344 | - /** |
|
| 345 | - * stops tracking this registration's ticket reservation in extra meta |
|
| 346 | - * decrements (subtracts) related ticket reserved and corresponding datetime reserved values |
|
| 347 | - * |
|
| 348 | - * @param bool $update_ticket if true, will decrement ticket and datetime reserved count |
|
| 349 | - * @return void |
|
| 350 | - * @throws \EE_Error |
|
| 351 | - */ |
|
| 352 | - public function release_reserved_ticket($update_ticket = false) |
|
| 353 | - { |
|
| 354 | - if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) { |
|
| 355 | - // PLZ NOTE: although checking $update_ticket first would be more efficient, |
|
| 356 | - // we NEED to ALWAYS call delete_extra_meta(), which is why that is done first |
|
| 357 | - if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) { |
|
| 358 | - $ticket = $this->ticket(); |
|
| 359 | - $ticket->decrease_reserved(); |
|
| 360 | - $ticket->save(); |
|
| 361 | - } |
|
| 362 | - } |
|
| 363 | - } |
|
| 364 | - |
|
| 365 | - |
|
| 366 | - /** |
|
| 367 | - * Set Attendee ID |
|
| 368 | - * |
|
| 369 | - * @param int $ATT_ID Attendee ID |
|
| 370 | - */ |
|
| 371 | - public function set_attendee_id($ATT_ID = 0) |
|
| 372 | - { |
|
| 373 | - $this->set('ATT_ID', $ATT_ID); |
|
| 374 | - } |
|
| 375 | - |
|
| 376 | - |
|
| 377 | - /** |
|
| 378 | - * Set Transaction ID |
|
| 379 | - * |
|
| 380 | - * @param int $TXN_ID Transaction ID |
|
| 381 | - */ |
|
| 382 | - public function set_transaction_id($TXN_ID = 0) |
|
| 383 | - { |
|
| 384 | - $this->set('TXN_ID', $TXN_ID); |
|
| 385 | - } |
|
| 386 | - |
|
| 387 | - |
|
| 388 | - /** |
|
| 389 | - * Set Session |
|
| 390 | - * |
|
| 391 | - * @param string $REG_session PHP Session ID |
|
| 392 | - */ |
|
| 393 | - public function set_session($REG_session = '') |
|
| 394 | - { |
|
| 395 | - $this->set('REG_session', $REG_session); |
|
| 396 | - } |
|
| 397 | - |
|
| 398 | - |
|
| 399 | - /** |
|
| 400 | - * Set Registration URL Link |
|
| 401 | - * |
|
| 402 | - * @param string $REG_url_link Registration URL Link |
|
| 403 | - */ |
|
| 404 | - public function set_reg_url_link($REG_url_link = '') |
|
| 405 | - { |
|
| 406 | - $this->set('REG_url_link', $REG_url_link); |
|
| 407 | - } |
|
| 408 | - |
|
| 409 | - |
|
| 410 | - /** |
|
| 411 | - * Set Attendee Counter |
|
| 412 | - * |
|
| 413 | - * @param int $REG_count Primary Attendee |
|
| 414 | - */ |
|
| 415 | - public function set_count($REG_count = 1) |
|
| 416 | - { |
|
| 417 | - $this->set('REG_count', $REG_count); |
|
| 418 | - } |
|
| 419 | - |
|
| 420 | - |
|
| 421 | - /** |
|
| 422 | - * Set Group Size |
|
| 423 | - * |
|
| 424 | - * @param boolean $REG_group_size Group Registration |
|
| 425 | - */ |
|
| 426 | - public function set_group_size($REG_group_size = false) |
|
| 427 | - { |
|
| 428 | - $this->set('REG_group_size', $REG_group_size); |
|
| 429 | - } |
|
| 430 | - |
|
| 431 | - |
|
| 432 | - /** |
|
| 433 | - * is_not_approved - convenience method that returns TRUE if REG status ID == |
|
| 434 | - * EEM_Registration::status_id_not_approved |
|
| 435 | - * |
|
| 436 | - * @return boolean |
|
| 437 | - */ |
|
| 438 | - public function is_not_approved() |
|
| 439 | - { |
|
| 440 | - return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false; |
|
| 441 | - } |
|
| 442 | - |
|
| 443 | - |
|
| 444 | - /** |
|
| 445 | - * is_pending_payment - convenience method that returns TRUE if REG status ID == |
|
| 446 | - * EEM_Registration::status_id_pending_payment |
|
| 447 | - * |
|
| 448 | - * @return boolean |
|
| 449 | - */ |
|
| 450 | - public function is_pending_payment() |
|
| 451 | - { |
|
| 452 | - return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false; |
|
| 453 | - } |
|
| 454 | - |
|
| 455 | - |
|
| 456 | - /** |
|
| 457 | - * is_approved - convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved |
|
| 458 | - * |
|
| 459 | - * @return boolean |
|
| 460 | - */ |
|
| 461 | - public function is_approved() |
|
| 462 | - { |
|
| 463 | - return $this->status_ID() == EEM_Registration::status_id_approved ? true : false; |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - |
|
| 467 | - /** |
|
| 468 | - * is_cancelled - convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled |
|
| 469 | - * |
|
| 470 | - * @return boolean |
|
| 471 | - */ |
|
| 472 | - public function is_cancelled() |
|
| 473 | - { |
|
| 474 | - return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false; |
|
| 475 | - } |
|
| 476 | - |
|
| 477 | - |
|
| 478 | - /** |
|
| 479 | - * is_declined - convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined |
|
| 480 | - * |
|
| 481 | - * @return boolean |
|
| 482 | - */ |
|
| 483 | - public function is_declined() |
|
| 484 | - { |
|
| 485 | - return $this->status_ID() == EEM_Registration::status_id_declined ? true : false; |
|
| 486 | - } |
|
| 487 | - |
|
| 488 | - |
|
| 489 | - /** |
|
| 490 | - * is_incomplete - convenience method that returns TRUE if REG status ID == |
|
| 491 | - * EEM_Registration::status_id_incomplete |
|
| 492 | - * |
|
| 493 | - * @return boolean |
|
| 494 | - */ |
|
| 495 | - public function is_incomplete() |
|
| 496 | - { |
|
| 497 | - return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false; |
|
| 498 | - } |
|
| 499 | - |
|
| 500 | - |
|
| 501 | - /** |
|
| 502 | - * Set Registration Date |
|
| 503 | - * |
|
| 504 | - * @param mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of |
|
| 505 | - * Date |
|
| 506 | - */ |
|
| 507 | - public function set_reg_date($REG_date = false) |
|
| 508 | - { |
|
| 509 | - $this->set('REG_date', $REG_date); |
|
| 510 | - } |
|
| 511 | - |
|
| 512 | - |
|
| 513 | - /** |
|
| 514 | - * Set final price owing for this registration after all ticket/price modifications |
|
| 515 | - * |
|
| 516 | - * @access public |
|
| 517 | - * @param float $REG_final_price |
|
| 518 | - */ |
|
| 519 | - public function set_final_price($REG_final_price = 0.00) |
|
| 520 | - { |
|
| 521 | - $this->set('REG_final_price', $REG_final_price); |
|
| 522 | - } |
|
| 523 | - |
|
| 524 | - |
|
| 525 | - /** |
|
| 526 | - * Set amount paid towards this registration's final price |
|
| 527 | - * |
|
| 528 | - * @access public |
|
| 529 | - * @param float $REG_paid |
|
| 530 | - */ |
|
| 531 | - public function set_paid($REG_paid = 0.00) |
|
| 532 | - { |
|
| 533 | - $this->set('REG_paid', $REG_paid); |
|
| 534 | - } |
|
| 535 | - |
|
| 536 | - |
|
| 537 | - /** |
|
| 538 | - * Attendee Is Going |
|
| 539 | - * |
|
| 540 | - * @param boolean $REG_att_is_going Attendee Is Going |
|
| 541 | - */ |
|
| 542 | - public function set_att_is_going($REG_att_is_going = false) |
|
| 543 | - { |
|
| 544 | - $this->set('REG_att_is_going', $REG_att_is_going); |
|
| 545 | - } |
|
| 546 | - |
|
| 547 | - |
|
| 548 | - /** |
|
| 549 | - * Gets the related attendee |
|
| 550 | - * |
|
| 551 | - * @return EE_Attendee |
|
| 552 | - */ |
|
| 553 | - public function attendee() |
|
| 554 | - { |
|
| 555 | - return $this->get_first_related('Attendee'); |
|
| 556 | - } |
|
| 557 | - |
|
| 558 | - |
|
| 559 | - /** |
|
| 560 | - * get Event ID |
|
| 561 | - */ |
|
| 562 | - public function event_ID() |
|
| 563 | - { |
|
| 564 | - return $this->get('EVT_ID'); |
|
| 565 | - } |
|
| 566 | - |
|
| 567 | - |
|
| 568 | - /** |
|
| 569 | - * get Event ID |
|
| 570 | - */ |
|
| 571 | - public function event_name() |
|
| 572 | - { |
|
| 573 | - $event = $this->event_obj(); |
|
| 574 | - if ($event) { |
|
| 575 | - return $event->name(); |
|
| 576 | - } else { |
|
| 577 | - return null; |
|
| 578 | - } |
|
| 579 | - } |
|
| 580 | - |
|
| 581 | - |
|
| 582 | - /** |
|
| 583 | - * Fetches the event this registration is for |
|
| 584 | - * |
|
| 585 | - * @return EE_Event |
|
| 586 | - */ |
|
| 587 | - public function event_obj() |
|
| 588 | - { |
|
| 589 | - return $this->get_first_related('Event'); |
|
| 590 | - } |
|
| 591 | - |
|
| 592 | - |
|
| 593 | - /** |
|
| 594 | - * get Attendee ID |
|
| 595 | - */ |
|
| 596 | - public function attendee_ID() |
|
| 597 | - { |
|
| 598 | - return $this->get('ATT_ID'); |
|
| 599 | - } |
|
| 600 | - |
|
| 601 | - |
|
| 602 | - /** |
|
| 603 | - * get PHP Session ID |
|
| 604 | - */ |
|
| 605 | - public function session_ID() |
|
| 606 | - { |
|
| 607 | - return $this->get('REG_session'); |
|
| 608 | - } |
|
| 609 | - |
|
| 610 | - |
|
| 611 | - /** |
|
| 612 | - * Gets the string which represents the URL trigger for the receipt template in the message template system. |
|
| 613 | - * |
|
| 614 | - * @param string $messenger 'pdf' or 'html'. Default 'html'. |
|
| 615 | - * @return string |
|
| 616 | - */ |
|
| 617 | - public function receipt_url($messenger = 'html') |
|
| 618 | - { |
|
| 619 | - |
|
| 620 | - /** |
|
| 621 | - * 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. |
|
| 622 | - * |
|
| 623 | - * @since 4.5.0 |
|
| 624 | - */ |
|
| 625 | - $template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php'; |
|
| 626 | - $has_custom = EEH_Template::locate_template($template_relative_path, array(), true, true, true); |
|
| 627 | - |
|
| 628 | - if ($has_custom) { |
|
| 629 | - return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch')); |
|
| 630 | - } |
|
| 631 | - return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt'); |
|
| 632 | - } |
|
| 633 | - |
|
| 634 | - |
|
| 635 | - /** |
|
| 636 | - * Gets the string which represents the URL trigger for the invoice template in the message template system. |
|
| 637 | - * |
|
| 638 | - * @param string $messenger 'pdf' or 'html'. Default 'html'. |
|
| 639 | - * @return string |
|
| 640 | - */ |
|
| 641 | - public function invoice_url($messenger = 'html') |
|
| 642 | - { |
|
| 643 | - /** |
|
| 644 | - * 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. |
|
| 645 | - * |
|
| 646 | - * @since 4.5.0 |
|
| 647 | - */ |
|
| 648 | - $template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php'; |
|
| 649 | - $has_custom = EEH_Template::locate_template($template_relative_path, array(), true, true, true); |
|
| 650 | - |
|
| 651 | - if ($has_custom) { |
|
| 652 | - if ($messenger == 'html') { |
|
| 653 | - return $this->invoice_url('launch'); |
|
| 654 | - } |
|
| 655 | - $route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice'; |
|
| 656 | - |
|
| 657 | - $query_args = array('ee' => $route, 'id' => $this->reg_url_link()); |
|
| 658 | - if ($messenger == 'html') { |
|
| 659 | - $query_args['html'] = true; |
|
| 660 | - } |
|
| 661 | - return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id)); |
|
| 662 | - } |
|
| 663 | - return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice'); |
|
| 664 | - } |
|
| 665 | - |
|
| 666 | - |
|
| 667 | - /** |
|
| 668 | - * get Registration URL Link |
|
| 669 | - * |
|
| 670 | - * @access public |
|
| 671 | - * @return string |
|
| 672 | - * @throws \EE_Error |
|
| 673 | - */ |
|
| 674 | - public function reg_url_link() |
|
| 675 | - { |
|
| 676 | - return (string)$this->get('REG_url_link'); |
|
| 677 | - } |
|
| 678 | - |
|
| 679 | - |
|
| 680 | - /** |
|
| 681 | - * Echoes out invoice_url() |
|
| 682 | - * |
|
| 683 | - * @param string $type 'download','launch', or 'html' (default is 'launch') |
|
| 684 | - * @return void |
|
| 685 | - */ |
|
| 686 | - public function e_invoice_url($type = 'launch') |
|
| 687 | - { |
|
| 688 | - echo $this->invoice_url($type); |
|
| 689 | - } |
|
| 690 | - |
|
| 691 | - |
|
| 692 | - /** |
|
| 693 | - * Echoes out payment_overview_url |
|
| 694 | - */ |
|
| 695 | - public function e_payment_overview_url() |
|
| 696 | - { |
|
| 697 | - echo $this->payment_overview_url(); |
|
| 698 | - } |
|
| 699 | - |
|
| 700 | - |
|
| 701 | - /** |
|
| 702 | - * Gets the URL of the thank you page with this registration REG_url_link added as |
|
| 703 | - * a query parameter |
|
| 704 | - * |
|
| 705 | - * @return string |
|
| 706 | - */ |
|
| 707 | - public function payment_overview_url() |
|
| 708 | - { |
|
| 709 | - return add_query_arg(array( |
|
| 710 | - 'e_reg_url_link' => $this->reg_url_link(), |
|
| 711 | - 'step' => 'payment_options', |
|
| 712 | - 'revisit' => true, |
|
| 713 | - ), EE_Registry::instance()->CFG->core->reg_page_url()); |
|
| 714 | - } |
|
| 715 | - |
|
| 716 | - |
|
| 717 | - /** |
|
| 718 | - * Gets the URL of the thank you page with this registration REG_url_link added as |
|
| 719 | - * a query parameter |
|
| 720 | - * |
|
| 721 | - * @return string |
|
| 722 | - */ |
|
| 723 | - public function edit_attendee_information_url() |
|
| 724 | - { |
|
| 725 | - return add_query_arg(array( |
|
| 726 | - 'e_reg_url_link' => $this->reg_url_link(), |
|
| 727 | - 'step' => 'attendee_information', |
|
| 728 | - 'revisit' => true, |
|
| 729 | - ), EE_Registry::instance()->CFG->core->reg_page_url()); |
|
| 730 | - } |
|
| 731 | - |
|
| 732 | - |
|
| 733 | - /** |
|
| 734 | - * Simply generates and returns the appropriate admin_url link to edit this registration |
|
| 735 | - * |
|
| 736 | - * @return string |
|
| 737 | - */ |
|
| 738 | - public function get_admin_edit_url() |
|
| 739 | - { |
|
| 740 | - return EEH_URL::add_query_args_and_nonce(array( |
|
| 741 | - 'page' => 'espresso_registrations', |
|
| 742 | - 'action' => 'view_registration', |
|
| 743 | - '_REG_ID' => $this->ID(), |
|
| 744 | - ), admin_url('admin.php')); |
|
| 745 | - } |
|
| 746 | - |
|
| 747 | - |
|
| 748 | - /** |
|
| 749 | - * is_primary_registrant? |
|
| 750 | - */ |
|
| 751 | - public function is_primary_registrant() |
|
| 752 | - { |
|
| 753 | - return $this->get('REG_count') == 1 ? true : false; |
|
| 754 | - } |
|
| 755 | - |
|
| 756 | - |
|
| 757 | - /** |
|
| 758 | - * This returns the primary registration object for this registration group (which may be this object). |
|
| 759 | - * |
|
| 760 | - * @return EE_Registration |
|
| 761 | - */ |
|
| 762 | - public function get_primary_registration() |
|
| 763 | - { |
|
| 764 | - if ($this->is_primary_registrant()) { |
|
| 765 | - return $this; |
|
| 766 | - } |
|
| 767 | - |
|
| 768 | - //k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1 |
|
| 769 | - $primary_registrant = EEM_Registration::instance()->get_one(array( |
|
| 770 | - array( |
|
| 771 | - 'TXN_ID' => $this->transaction_ID(), |
|
| 772 | - 'REG_count' => 1, |
|
| 773 | - ), |
|
| 774 | - )); |
|
| 775 | - return $primary_registrant; |
|
| 776 | - } |
|
| 777 | - |
|
| 778 | - |
|
| 779 | - /** |
|
| 780 | - * get Attendee Number |
|
| 781 | - * |
|
| 782 | - * @access public |
|
| 783 | - */ |
|
| 784 | - public function count() |
|
| 785 | - { |
|
| 786 | - return $this->get('REG_count'); |
|
| 787 | - } |
|
| 788 | - |
|
| 789 | - |
|
| 790 | - /** |
|
| 791 | - * get Group Size |
|
| 792 | - */ |
|
| 793 | - public function group_size() |
|
| 794 | - { |
|
| 795 | - return $this->get('REG_group_size'); |
|
| 796 | - } |
|
| 797 | - |
|
| 798 | - |
|
| 799 | - /** |
|
| 800 | - * get Registration Date |
|
| 801 | - */ |
|
| 802 | - public function date() |
|
| 803 | - { |
|
| 804 | - return $this->get('REG_date'); |
|
| 805 | - } |
|
| 806 | - |
|
| 807 | - |
|
| 808 | - /** |
|
| 809 | - * gets a pretty date |
|
| 810 | - * |
|
| 811 | - * @param string $date_format |
|
| 812 | - * @param string $time_format |
|
| 813 | - * @return string |
|
| 814 | - */ |
|
| 815 | - public function pretty_date($date_format = null, $time_format = null) |
|
| 816 | - { |
|
| 817 | - return $this->get_datetime('REG_date', $date_format, $time_format); |
|
| 818 | - } |
|
| 819 | - |
|
| 820 | - |
|
| 821 | - /** |
|
| 822 | - * final_price |
|
| 823 | - * the registration's share of the transaction total, so that the |
|
| 824 | - * sum of all the transaction's REG_final_prices equal the transaction's total |
|
| 825 | - * |
|
| 826 | - * @return float |
|
| 827 | - */ |
|
| 828 | - public function final_price() |
|
| 829 | - { |
|
| 830 | - return $this->get('REG_final_price'); |
|
| 831 | - } |
|
| 832 | - |
|
| 833 | - |
|
| 834 | - /** |
|
| 835 | - * pretty_final_price |
|
| 836 | - * final price as formatted string, with correct decimal places and currency symbol |
|
| 837 | - * |
|
| 838 | - * @return string |
|
| 839 | - */ |
|
| 840 | - public function pretty_final_price() |
|
| 841 | - { |
|
| 842 | - return $this->get_pretty('REG_final_price'); |
|
| 843 | - } |
|
| 844 | - |
|
| 845 | - |
|
| 846 | - /** |
|
| 847 | - * get paid (yeah) |
|
| 848 | - * |
|
| 849 | - * @return float |
|
| 850 | - */ |
|
| 851 | - public function paid() |
|
| 852 | - { |
|
| 853 | - return $this->get('REG_paid'); |
|
| 854 | - } |
|
| 855 | - |
|
| 856 | - |
|
| 857 | - /** |
|
| 858 | - * pretty_paid |
|
| 859 | - * |
|
| 860 | - * @return float |
|
| 861 | - */ |
|
| 862 | - public function pretty_paid() |
|
| 863 | - { |
|
| 864 | - return $this->get_pretty('REG_paid'); |
|
| 865 | - } |
|
| 866 | - |
|
| 867 | - |
|
| 868 | - /** |
|
| 869 | - * owes_monies_and_can_pay |
|
| 870 | - * whether or not this registration has monies owing and it's' status allows payment |
|
| 871 | - * |
|
| 872 | - * @param array $requires_payment |
|
| 873 | - * @return bool |
|
| 874 | - */ |
|
| 875 | - public function owes_monies_and_can_pay($requires_payment = array()) |
|
| 876 | - { |
|
| 877 | - // these reg statuses require payment (if event is not free) |
|
| 878 | - $requires_payment = ! empty($requires_payment) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment(); |
|
| 879 | - if ( |
|
| 880 | - in_array($this->status_ID(), $requires_payment) && |
|
| 881 | - $this->final_price() != 0 && |
|
| 882 | - $this->final_price() != $this->paid() |
|
| 883 | - ) { |
|
| 884 | - return true; |
|
| 885 | - } else { |
|
| 886 | - return false; |
|
| 887 | - } |
|
| 888 | - } |
|
| 889 | - |
|
| 890 | - |
|
| 891 | - /** |
|
| 892 | - * Prints out the return value of $this->pretty_status() |
|
| 893 | - * |
|
| 894 | - * @param bool $show_icons |
|
| 895 | - * @return void |
|
| 896 | - */ |
|
| 897 | - public function e_pretty_status($show_icons = false) |
|
| 898 | - { |
|
| 899 | - echo $this->pretty_status($show_icons); |
|
| 900 | - } |
|
| 901 | - |
|
| 902 | - |
|
| 903 | - /** |
|
| 904 | - * Returns a nice version of the status for displaying to customers |
|
| 905 | - * |
|
| 906 | - * @param bool $show_icons |
|
| 907 | - * @return string |
|
| 908 | - */ |
|
| 909 | - public function pretty_status($show_icons = false) |
|
| 910 | - { |
|
| 911 | - $status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')), |
|
| 912 | - false, 'sentence'); |
|
| 913 | - $icon = ''; |
|
| 914 | - switch ($this->status_ID()) { |
|
| 915 | - case EEM_Registration::status_id_approved: |
|
| 916 | - $icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : ''; |
|
| 917 | - break; |
|
| 918 | - case EEM_Registration::status_id_pending_payment: |
|
| 919 | - $icon = $show_icons ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>' : ''; |
|
| 920 | - break; |
|
| 921 | - case EEM_Registration::status_id_not_approved: |
|
| 922 | - $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>' : ''; |
|
| 923 | - break; |
|
| 924 | - case EEM_Registration::status_id_cancelled: |
|
| 925 | - $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>' : ''; |
|
| 926 | - break; |
|
| 927 | - case EEM_Registration::status_id_incomplete: |
|
| 928 | - $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>' : ''; |
|
| 929 | - break; |
|
| 930 | - case EEM_Registration::status_id_declined: |
|
| 931 | - $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : ''; |
|
| 932 | - break; |
|
| 933 | - case EEM_Registration::status_id_wait_list: |
|
| 934 | - $icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : ''; |
|
| 935 | - break; |
|
| 936 | - } |
|
| 937 | - return $icon . $status[$this->status_ID()]; |
|
| 938 | - } |
|
| 939 | - |
|
| 940 | - |
|
| 941 | - /** |
|
| 942 | - * get Attendee Is Going |
|
| 943 | - */ |
|
| 944 | - public function att_is_going() |
|
| 945 | - { |
|
| 946 | - return $this->get('REG_att_is_going'); |
|
| 947 | - } |
|
| 948 | - |
|
| 949 | - |
|
| 950 | - /** |
|
| 951 | - * Gets related answers |
|
| 952 | - * |
|
| 953 | - * @param array $query_params like EEM_Base::get_all |
|
| 954 | - * @return EE_Answer[] |
|
| 955 | - */ |
|
| 956 | - public function answers($query_params = null) |
|
| 957 | - { |
|
| 958 | - return $this->get_many_related('Answer', $query_params); |
|
| 959 | - } |
|
| 960 | - |
|
| 961 | - |
|
| 962 | - /** |
|
| 963 | - * Gets the registration's answer value to the specified question |
|
| 964 | - * (either the question's ID or a question object) |
|
| 965 | - * |
|
| 966 | - * @param EE_Question|int $question |
|
| 967 | - * @param bool $pretty_value |
|
| 968 | - * @return array|string if pretty_value= true, the result will always be a string |
|
| 969 | - * (because the answer might be an array of answer values, so passing pretty_value=true |
|
| 970 | - * will convert it into some kind of string) |
|
| 971 | - */ |
|
| 972 | - public function answer_value_to_question($question, $pretty_value = true) |
|
| 973 | - { |
|
| 974 | - $question_id = EEM_Question::instance()->ensure_is_ID($question); |
|
| 975 | - return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value); |
|
| 976 | - } |
|
| 977 | - |
|
| 978 | - |
|
| 979 | - /** |
|
| 980 | - * question_groups |
|
| 981 | - * returns an array of EE_Question_Group objects for this registration |
|
| 982 | - * |
|
| 983 | - * @return EE_Question_Group[] |
|
| 984 | - */ |
|
| 985 | - public function question_groups() |
|
| 986 | - { |
|
| 987 | - $question_groups = array(); |
|
| 988 | - if ($this->event() instanceof EE_Event) { |
|
| 989 | - $question_groups = $this->event()->question_groups( |
|
| 990 | - array( |
|
| 991 | - array( |
|
| 992 | - 'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false, |
|
| 993 | - ), |
|
| 994 | - 'order_by' => array('QSG_order' => 'ASC'), |
|
| 995 | - ) |
|
| 996 | - ); |
|
| 997 | - } |
|
| 998 | - return $question_groups; |
|
| 999 | - } |
|
| 1000 | - |
|
| 1001 | - |
|
| 1002 | - /** |
|
| 1003 | - * count_question_groups |
|
| 1004 | - * returns a count of the number of EE_Question_Group objects for this registration |
|
| 1005 | - * |
|
| 1006 | - * @return int |
|
| 1007 | - */ |
|
| 1008 | - public function count_question_groups() |
|
| 1009 | - { |
|
| 1010 | - $qg_count = 0; |
|
| 1011 | - if ($this->event() instanceof EE_Event) { |
|
| 1012 | - $qg_count = $this->event()->count_related( |
|
| 1013 | - 'Question_Group', |
|
| 1014 | - array( |
|
| 1015 | - array( |
|
| 1016 | - 'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false, |
|
| 1017 | - ), |
|
| 1018 | - ) |
|
| 1019 | - ); |
|
| 1020 | - } |
|
| 1021 | - return $qg_count; |
|
| 1022 | - } |
|
| 1023 | - |
|
| 1024 | - |
|
| 1025 | - /** |
|
| 1026 | - * Returns the registration date in the 'standard' string format |
|
| 1027 | - * (function may be improved in the future to allow for different formats and timezones) |
|
| 1028 | - * |
|
| 1029 | - * @return string |
|
| 1030 | - */ |
|
| 1031 | - public function reg_date() |
|
| 1032 | - { |
|
| 1033 | - return $this->get_datetime('REG_date'); |
|
| 1034 | - } |
|
| 1035 | - |
|
| 1036 | - |
|
| 1037 | - /** |
|
| 1038 | - * Gets the datetime-ticket for this registration (ie, it can be used to isolate |
|
| 1039 | - * the ticket this registration purchased, or the datetime they have registered |
|
| 1040 | - * to attend) |
|
| 1041 | - * |
|
| 1042 | - * @return EE_Datetime_Ticket |
|
| 1043 | - */ |
|
| 1044 | - public function datetime_ticket() |
|
| 1045 | - { |
|
| 1046 | - return $this->get_first_related('Datetime_Ticket'); |
|
| 1047 | - } |
|
| 1048 | - |
|
| 1049 | - |
|
| 1050 | - /** |
|
| 1051 | - * Sets the registration's datetime_ticket. |
|
| 1052 | - * |
|
| 1053 | - * @param EE_Datetime_Ticket $datetime_ticket |
|
| 1054 | - * @return EE_Datetime_Ticket |
|
| 1055 | - */ |
|
| 1056 | - public function set_datetime_ticket($datetime_ticket) |
|
| 1057 | - { |
|
| 1058 | - return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket'); |
|
| 1059 | - } |
|
| 1060 | - |
|
| 1061 | - /** |
|
| 1062 | - * Gets deleted |
|
| 1063 | - * |
|
| 1064 | - * @return boolean |
|
| 1065 | - */ |
|
| 1066 | - public function deleted() |
|
| 1067 | - { |
|
| 1068 | - return $this->get('REG_deleted'); |
|
| 1069 | - } |
|
| 1070 | - |
|
| 1071 | - /** |
|
| 1072 | - * Sets deleted |
|
| 1073 | - * |
|
| 1074 | - * @param boolean $deleted |
|
| 1075 | - * @return boolean |
|
| 1076 | - */ |
|
| 1077 | - public function set_deleted($deleted) |
|
| 1078 | - { |
|
| 1079 | - if ($deleted) { |
|
| 1080 | - $this->delete(); |
|
| 1081 | - } else { |
|
| 1082 | - $this->restore(); |
|
| 1083 | - } |
|
| 1084 | - } |
|
| 1085 | - |
|
| 1086 | - |
|
| 1087 | - /** |
|
| 1088 | - * Get the status object of this object |
|
| 1089 | - * |
|
| 1090 | - * @return EE_Status |
|
| 1091 | - */ |
|
| 1092 | - public function status_obj() |
|
| 1093 | - { |
|
| 1094 | - return $this->get_first_related('Status'); |
|
| 1095 | - } |
|
| 1096 | - |
|
| 1097 | - |
|
| 1098 | - /** |
|
| 1099 | - * Returns the number of times this registration has checked into any of the datetimes |
|
| 1100 | - * its available for |
|
| 1101 | - * |
|
| 1102 | - * @return int |
|
| 1103 | - */ |
|
| 1104 | - public function count_checkins() |
|
| 1105 | - { |
|
| 1106 | - return $this->get_model()->count_related($this, 'Checkin'); |
|
| 1107 | - } |
|
| 1108 | - |
|
| 1109 | - |
|
| 1110 | - /** |
|
| 1111 | - * Returns the number of current Check-ins this registration is checked into for any of the datetimes the |
|
| 1112 | - * registration is for. Note, this is ONLY checked in (does not include checkedout) |
|
| 1113 | - * |
|
| 1114 | - * @return int |
|
| 1115 | - */ |
|
| 1116 | - public function count_checkins_not_checkedout() |
|
| 1117 | - { |
|
| 1118 | - return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1))); |
|
| 1119 | - } |
|
| 1120 | - |
|
| 1121 | - |
|
| 1122 | - /** |
|
| 1123 | - * The purpose of this method is simply to check whether this registration can checkin to the given datetime. |
|
| 1124 | - * |
|
| 1125 | - * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against |
|
| 1126 | - * @param bool $check_approved This is used to indicate whether the caller wants can_checkin to also |
|
| 1127 | - * consider registration status as well as datetime access. |
|
| 1128 | - * @return bool |
|
| 1129 | - */ |
|
| 1130 | - public function can_checkin($DTT_OR_ID, $check_approved = true) |
|
| 1131 | - { |
|
| 1132 | - $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID); |
|
| 1133 | - |
|
| 1134 | - //first check registration status |
|
| 1135 | - if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) { |
|
| 1136 | - return false; |
|
| 1137 | - } |
|
| 1138 | - //is there a datetime ticket that matches this dtt_ID? |
|
| 1139 | - if (! (EEM_Datetime_Ticket::instance()->exists(array( |
|
| 1140 | - array( |
|
| 1141 | - 'TKT_ID' => $this->get('TKT_ID'), |
|
| 1142 | - 'DTT_ID' => $DTT_ID, |
|
| 1143 | - ), |
|
| 1144 | - ))) |
|
| 1145 | - ) { |
|
| 1146 | - return false; |
|
| 1147 | - } |
|
| 1148 | - |
|
| 1149 | - //final check is against TKT_uses |
|
| 1150 | - return $this->verify_can_checkin_against_TKT_uses($DTT_ID); |
|
| 1151 | - } |
|
| 1152 | - |
|
| 1153 | - |
|
| 1154 | - /** |
|
| 1155 | - * This method verifies whether the user can checkin for the given datetime considering the max uses value set on |
|
| 1156 | - * the ticket. To do this, a query is done to get the count of the datetime records already checked into. If the |
|
| 1157 | - * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses, |
|
| 1158 | - * then return false. Otherwise return true. |
|
| 1159 | - * |
|
| 1160 | - * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against |
|
| 1161 | - * @return bool true means can checkin. false means cannot checkin. |
|
| 1162 | - */ |
|
| 1163 | - public function verify_can_checkin_against_TKT_uses($DTT_OR_ID) |
|
| 1164 | - { |
|
| 1165 | - $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID); |
|
| 1166 | - |
|
| 1167 | - if (! $DTT_ID) { |
|
| 1168 | - return false; |
|
| 1169 | - } |
|
| 1170 | - |
|
| 1171 | - $max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF; |
|
| 1172 | - |
|
| 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 | - // or not. |
|
| 1175 | - if (! $max_uses || $max_uses === EE_INF) { |
|
| 1176 | - return true; |
|
| 1177 | - } |
|
| 1178 | - |
|
| 1179 | - //does this datetime have a checkin record? If so, then the dtt count has already been verified so we can just |
|
| 1180 | - //go ahead and toggle. |
|
| 1181 | - if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) { |
|
| 1182 | - return true; |
|
| 1183 | - } |
|
| 1184 | - |
|
| 1185 | - //made it here so the last check is whether the number of checkins per unique datetime on this registration |
|
| 1186 | - //disallows further check-ins. |
|
| 1187 | - $count_unique_dtt_checkins = EEM_Checkin::instance()->count(array( |
|
| 1188 | - array( |
|
| 1189 | - 'REG_ID' => $this->ID(), |
|
| 1190 | - 'CHK_in' => true, |
|
| 1191 | - ), |
|
| 1192 | - ), 'DTT_ID', true); |
|
| 1193 | - // checkins have already reached their max number of uses |
|
| 1194 | - // so registrant can NOT checkin |
|
| 1195 | - if ($count_unique_dtt_checkins >= $max_uses) { |
|
| 1196 | - EE_Error::add_error(__('Check-in denied because number of datetime uses for the ticket has been reached or exceeded.', |
|
| 1197 | - 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 1198 | - return false; |
|
| 1199 | - } |
|
| 1200 | - return true; |
|
| 1201 | - } |
|
| 1202 | - |
|
| 1203 | - |
|
| 1204 | - /** |
|
| 1205 | - * toggle Check-in status for this registration |
|
| 1206 | - * Check-ins are toggled in the following order: |
|
| 1207 | - * never checked in -> checked in |
|
| 1208 | - * checked in -> checked out |
|
| 1209 | - * checked out -> checked in |
|
| 1210 | - * |
|
| 1211 | - * @param int $DTT_ID include specific datetime to toggle Check-in for. |
|
| 1212 | - * If not included or null, then it is assumed latest datetime is being toggled. |
|
| 1213 | - * @param bool $verify If true then can_checkin() is used to verify whether the person |
|
| 1214 | - * can be checked in or not. Otherwise this forces change in checkin status. |
|
| 1215 | - * @return bool|int the chk_in status toggled to OR false if nothing got changed. |
|
| 1216 | - * @throws EE_Error |
|
| 1217 | - */ |
|
| 1218 | - public function toggle_checkin_status($DTT_ID = null, $verify = false) |
|
| 1219 | - { |
|
| 1220 | - if (empty($DTT_ID)) { |
|
| 1221 | - $datetime = $this->get_latest_related_datetime(); |
|
| 1222 | - $DTT_ID = $datetime instanceof EE_Datetime ? $datetime->ID() : 0; |
|
| 1223 | - // verify the registration can checkin for the given DTT_ID |
|
| 1224 | - } elseif (! $this->can_checkin($DTT_ID, $verify)) { |
|
| 1225 | - EE_Error::add_error( |
|
| 1226 | - sprintf( |
|
| 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', |
|
| 1228 | - 'event_espresso'), |
|
| 1229 | - $this->ID(), |
|
| 1230 | - $DTT_ID |
|
| 1231 | - ), |
|
| 1232 | - __FILE__, __FUNCTION__, __LINE__ |
|
| 1233 | - ); |
|
| 1234 | - return false; |
|
| 1235 | - } |
|
| 1236 | - $status_paths = array( |
|
| 1237 | - EE_Registration::checkin_status_never => EE_Registration::checkin_status_in, |
|
| 1238 | - EE_Registration::checkin_status_in => EE_Registration::checkin_status_out, |
|
| 1239 | - EE_Registration::checkin_status_out => EE_Registration::checkin_status_in, |
|
| 1240 | - ); |
|
| 1241 | - //start by getting the current status so we know what status we'll be changing to. |
|
| 1242 | - $cur_status = $this->check_in_status_for_datetime($DTT_ID, null); |
|
| 1243 | - $status_to = $status_paths[$cur_status]; |
|
| 1244 | - // database only records true for checked IN or false for checked OUT |
|
| 1245 | - // no record ( null ) means checked in NEVER, but we obviously don't save that |
|
| 1246 | - $new_status = $status_to === EE_Registration::checkin_status_in ? true : false; |
|
| 1247 | - // add relation - note Check-ins are always creating new rows |
|
| 1248 | - // because we are keeping track of Check-ins over time. |
|
| 1249 | - // Eventually we'll probably want to show a list table |
|
| 1250 | - // for the individual Check-ins so that they can be managed. |
|
| 1251 | - $checkin = EE_Checkin::new_instance(array( |
|
| 1252 | - 'REG_ID' => $this->ID(), |
|
| 1253 | - 'DTT_ID' => $DTT_ID, |
|
| 1254 | - 'CHK_in' => $new_status, |
|
| 1255 | - )); |
|
| 1256 | - // if the record could not be saved then return false |
|
| 1257 | - if ($checkin->save() === 0) { |
|
| 1258 | - if (WP_DEBUG) { |
|
| 1259 | - global $wpdb; |
|
| 1260 | - $error = sprintf( |
|
| 1261 | - __('Registration check in update failed because of the following database error: %1$s%2$s', |
|
| 1262 | - 'event_espresso'), |
|
| 1263 | - '<br />', |
|
| 1264 | - $wpdb->last_error |
|
| 1265 | - ); |
|
| 1266 | - } else { |
|
| 1267 | - $error = __('Registration check in update failed because of an unknown database error', |
|
| 1268 | - 'event_espresso'); |
|
| 1269 | - } |
|
| 1270 | - EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__); |
|
| 1271 | - return false; |
|
| 1272 | - } |
|
| 1273 | - return $status_to; |
|
| 1274 | - } |
|
| 1275 | - |
|
| 1276 | - |
|
| 1277 | - /** |
|
| 1278 | - * Returns the latest datetime related to this registration (via the ticket attached to the registration). |
|
| 1279 | - * "Latest" is defined by the `DTT_EVT_start` column. |
|
| 1280 | - * |
|
| 1281 | - * @return EE_Datetime|null |
|
| 1282 | - * @throws \EE_Error |
|
| 1283 | - */ |
|
| 1284 | - public function get_latest_related_datetime() |
|
| 1285 | - { |
|
| 1286 | - return EEM_Datetime::instance()->get_one( |
|
| 1287 | - array( |
|
| 1288 | - array( |
|
| 1289 | - 'Ticket.Registration.REG_ID' => $this->ID(), |
|
| 1290 | - ), |
|
| 1291 | - 'order_by' => array('DTT_EVT_start' => 'DESC'), |
|
| 1292 | - ) |
|
| 1293 | - ); |
|
| 1294 | - } |
|
| 1295 | - |
|
| 1296 | - |
|
| 1297 | - /** |
|
| 1298 | - * Returns the earliest datetime related to this registration (via the ticket attached to the registration). |
|
| 1299 | - * "Earliest" is defined by the `DTT_EVT_start` column. |
|
| 1300 | - * |
|
| 1301 | - * @throws \EE_Error |
|
| 1302 | - */ |
|
| 1303 | - public function get_earliest_related_datetime() |
|
| 1304 | - { |
|
| 1305 | - return EEM_Datetime::instance()->get_one( |
|
| 1306 | - array( |
|
| 1307 | - array( |
|
| 1308 | - 'Ticket.Registration.REG_ID' => $this->ID(), |
|
| 1309 | - ), |
|
| 1310 | - 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
| 1311 | - ) |
|
| 1312 | - ); |
|
| 1313 | - } |
|
| 1314 | - |
|
| 1315 | - |
|
| 1316 | - /** |
|
| 1317 | - * This method simply returns the check-in status for this registration and the given datetime. |
|
| 1318 | - * If neither the datetime nor the checkin values are provided as arguments, |
|
| 1319 | - * then this will return the LATEST check-in status for the registration across all datetimes it belongs to. |
|
| 1320 | - * |
|
| 1321 | - * @param int $DTT_ID The ID of the datetime we're checking against |
|
| 1322 | - * (if empty we'll get the primary datetime for |
|
| 1323 | - * this registration (via event) and use it's ID); |
|
| 1324 | - * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id. |
|
| 1325 | - * @return int Integer representing Check-in status. |
|
| 1326 | - * @throws \EE_Error |
|
| 1327 | - */ |
|
| 1328 | - public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null) |
|
| 1329 | - { |
|
| 1330 | - $checkin_query_params = array( |
|
| 1331 | - 'order_by' => array('CHK_timestamp' => 'DESC'), |
|
| 1332 | - ); |
|
| 1333 | - |
|
| 1334 | - if ($DTT_ID > 0) { |
|
| 1335 | - $checkin_query_params[0] = array('DTT_ID' => $DTT_ID); |
|
| 1336 | - } |
|
| 1337 | - |
|
| 1338 | - //get checkin object (if exists) |
|
| 1339 | - $checkin = $checkin instanceof EE_Checkin |
|
| 1340 | - ? $checkin |
|
| 1341 | - : $this->get_first_related('Checkin', $checkin_query_params); |
|
| 1342 | - if ($checkin instanceof EE_Checkin) { |
|
| 1343 | - if ($checkin->get('CHK_in')) { |
|
| 1344 | - return EE_Registration::checkin_status_in; //checked in |
|
| 1345 | - } |
|
| 1346 | - return EE_Registration::checkin_status_out; //had checked in but is now checked out. |
|
| 1347 | - } |
|
| 1348 | - return EE_Registration::checkin_status_never; //never been checked in |
|
| 1349 | - } |
|
| 1350 | - |
|
| 1351 | - |
|
| 1352 | - /** |
|
| 1353 | - * This method returns a localized message for the toggled Check-in message. |
|
| 1354 | - * |
|
| 1355 | - * @param int $DTT_ID include specific datetime to get the correct Check-in message. If not included or null, |
|
| 1356 | - * then it is assumed Check-in for primary datetime was toggled. |
|
| 1357 | - * @param bool $error This just flags that you want an error message returned. This is put in so that the error |
|
| 1358 | - * message can be customized with the attendee name. |
|
| 1359 | - * @return string internationalized message |
|
| 1360 | - */ |
|
| 1361 | - public function get_checkin_msg($DTT_ID, $error = false) |
|
| 1362 | - { |
|
| 1363 | - //let's get the attendee first so we can include the name of the attendee |
|
| 1364 | - $attendee = $this->get_first_related('Attendee'); |
|
| 1365 | - if ($attendee instanceof EE_Attendee) { |
|
| 1366 | - if ($error) { |
|
| 1367 | - return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name()); |
|
| 1368 | - } |
|
| 1369 | - $cur_status = $this->check_in_status_for_datetime($DTT_ID); |
|
| 1370 | - //what is the status message going to be? |
|
| 1371 | - switch ($cur_status) { |
|
| 1372 | - case EE_Registration::checkin_status_never : |
|
| 1373 | - return sprintf(__("%s has been removed from Check-in records", "event_espresso"), |
|
| 1374 | - $attendee->full_name()); |
|
| 1375 | - break; |
|
| 1376 | - case EE_Registration::checkin_status_in : |
|
| 1377 | - return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name()); |
|
| 1378 | - break; |
|
| 1379 | - case EE_Registration::checkin_status_out : |
|
| 1380 | - return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name()); |
|
| 1381 | - break; |
|
| 1382 | - } |
|
| 1383 | - } |
|
| 1384 | - return __("The check-in status could not be determined.", "event_espresso"); |
|
| 1385 | - } |
|
| 1386 | - |
|
| 1387 | - |
|
| 1388 | - /** |
|
| 1389 | - * Returns the related EE_Transaction to this registration |
|
| 1390 | - * |
|
| 1391 | - * @return EE_Transaction |
|
| 1392 | - */ |
|
| 1393 | - public function transaction() |
|
| 1394 | - { |
|
| 1395 | - $transaction = $this->get_first_related('Transaction'); |
|
| 1396 | - if (! $transaction instanceof \EE_Transaction) { |
|
| 1397 | - throw new EntityNotFoundException('Transaction ID', $this->transaction_ID()); |
|
| 1398 | - } |
|
| 1399 | - return $transaction; |
|
| 1400 | - } |
|
| 1401 | - |
|
| 1402 | - |
|
| 1403 | - /** |
|
| 1404 | - * get Registration Code |
|
| 1405 | - */ |
|
| 1406 | - public function reg_code() |
|
| 1407 | - { |
|
| 1408 | - return $this->get('REG_code'); |
|
| 1409 | - } |
|
| 1410 | - |
|
| 1411 | - |
|
| 1412 | - /** |
|
| 1413 | - * get Transaction ID |
|
| 1414 | - */ |
|
| 1415 | - public function transaction_ID() |
|
| 1416 | - { |
|
| 1417 | - return $this->get('TXN_ID'); |
|
| 1418 | - } |
|
| 1419 | - |
|
| 1420 | - |
|
| 1421 | - /** |
|
| 1422 | - * @return int |
|
| 1423 | - */ |
|
| 1424 | - public function ticket_ID() |
|
| 1425 | - { |
|
| 1426 | - return $this->get('TKT_ID'); |
|
| 1427 | - } |
|
| 1428 | - |
|
| 1429 | - |
|
| 1430 | - /** |
|
| 1431 | - * Set Registration Code |
|
| 1432 | - * |
|
| 1433 | - * @access public |
|
| 1434 | - * @param string $REG_code Registration Code |
|
| 1435 | - * @param boolean $use_default |
|
| 1436 | - */ |
|
| 1437 | - public function set_reg_code($REG_code, $use_default = false) |
|
| 1438 | - { |
|
| 1439 | - if (empty($REG_code)) { |
|
| 1440 | - EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 1441 | - return; |
|
| 1442 | - } |
|
| 1443 | - if (! $this->reg_code()) { |
|
| 1444 | - parent::set('REG_code', $REG_code, $use_default); |
|
| 1445 | - } else { |
|
| 1446 | - EE_Error::doing_it_wrong( |
|
| 1447 | - __CLASS__ . '::' . __FUNCTION__, |
|
| 1448 | - __('Can not change a registration REG_code once it has been set.', 'event_espresso'), |
|
| 1449 | - '4.6.0' |
|
| 1450 | - ); |
|
| 1451 | - } |
|
| 1452 | - } |
|
| 1453 | - |
|
| 1454 | - |
|
| 1455 | - /** |
|
| 1456 | - * Returns all other registrations in the same group as this registrant who have the same ticket option. |
|
| 1457 | - * Note, if you want to just get all registrations in the same transaction (group), use: |
|
| 1458 | - * $registration->transaction()->registrations(); |
|
| 1459 | - * |
|
| 1460 | - * @since 4.5.0 |
|
| 1461 | - * @return EE_Registration[] or empty array if this isn't a group registration. |
|
| 1462 | - */ |
|
| 1463 | - public function get_all_other_registrations_in_group() |
|
| 1464 | - { |
|
| 1465 | - if ($this->group_size() < 2) { |
|
| 1466 | - return array(); |
|
| 1467 | - } |
|
| 1468 | - |
|
| 1469 | - $query[0] = array( |
|
| 1470 | - 'TXN_ID' => $this->transaction_ID(), |
|
| 1471 | - 'REG_ID' => array('!=', $this->ID()), |
|
| 1472 | - 'TKT_ID' => $this->ticket_ID(), |
|
| 1473 | - ); |
|
| 1474 | - |
|
| 1475 | - $registrations = $this->get_model()->get_all($query); |
|
| 1476 | - return $registrations; |
|
| 1477 | - } |
|
| 1478 | - |
|
| 1479 | - /** |
|
| 1480 | - * Return the link to the admin details for the object. |
|
| 1481 | - * |
|
| 1482 | - * @return string |
|
| 1483 | - */ |
|
| 1484 | - public function get_admin_details_link() |
|
| 1485 | - { |
|
| 1486 | - EE_Registry::instance()->load_helper('URL'); |
|
| 1487 | - return EEH_URL::add_query_args_and_nonce( |
|
| 1488 | - array( |
|
| 1489 | - 'page' => 'espresso_registrations', |
|
| 1490 | - 'action' => 'view_registration', |
|
| 1491 | - '_REG_ID' => $this->ID(), |
|
| 1492 | - ), |
|
| 1493 | - admin_url('admin.php') |
|
| 1494 | - ); |
|
| 1495 | - } |
|
| 1496 | - |
|
| 1497 | - /** |
|
| 1498 | - * Returns the link to the editor for the object. Sometimes this is the same as the details. |
|
| 1499 | - * |
|
| 1500 | - * @return string |
|
| 1501 | - */ |
|
| 1502 | - public function get_admin_edit_link() |
|
| 1503 | - { |
|
| 1504 | - return $this->get_admin_details_link(); |
|
| 1505 | - } |
|
| 1506 | - |
|
| 1507 | - /** |
|
| 1508 | - * Returns the link to a settings page for the object. |
|
| 1509 | - * |
|
| 1510 | - * @return string |
|
| 1511 | - */ |
|
| 1512 | - public function get_admin_settings_link() |
|
| 1513 | - { |
|
| 1514 | - return $this->get_admin_details_link(); |
|
| 1515 | - } |
|
| 1516 | - |
|
| 1517 | - /** |
|
| 1518 | - * Returns the link to the "overview" for the object (typically the "list table" view). |
|
| 1519 | - * |
|
| 1520 | - * @return string |
|
| 1521 | - */ |
|
| 1522 | - public function get_admin_overview_link() |
|
| 1523 | - { |
|
| 1524 | - EE_Registry::instance()->load_helper('URL'); |
|
| 1525 | - return EEH_URL::add_query_args_and_nonce( |
|
| 1526 | - array( |
|
| 1527 | - 'page' => 'espresso_registrations', |
|
| 1528 | - ), |
|
| 1529 | - admin_url('admin.php') |
|
| 1530 | - ); |
|
| 1531 | - } |
|
| 1532 | - |
|
| 1533 | - |
|
| 1534 | - /** |
|
| 1535 | - * @param array $query_params |
|
| 1536 | - * @return \EE_Registration[] |
|
| 1537 | - * @throws \EE_Error |
|
| 1538 | - */ |
|
| 1539 | - public function payments($query_params = array()) |
|
| 1540 | - { |
|
| 1541 | - return $this->get_many_related('Payment', $query_params); |
|
| 1542 | - } |
|
| 1543 | - |
|
| 1544 | - |
|
| 1545 | - /** |
|
| 1546 | - * @param array $query_params |
|
| 1547 | - * @return \EE_Registration_Payment[] |
|
| 1548 | - * @throws \EE_Error |
|
| 1549 | - */ |
|
| 1550 | - public function registration_payments($query_params = array()) |
|
| 1551 | - { |
|
| 1552 | - return $this->get_many_related('Registration_Payment', $query_params); |
|
| 1553 | - } |
|
| 1554 | - |
|
| 1555 | - |
|
| 1556 | - /** |
|
| 1557 | - * This grabs the payment method corresponding to the last payment made for the amount owing on the registration. |
|
| 1558 | - * Note: if there are no payments on the registration there will be no payment method returned. |
|
| 1559 | - * |
|
| 1560 | - * @return EE_Payment_Method|null |
|
| 1561 | - */ |
|
| 1562 | - public function payment_method() |
|
| 1563 | - { |
|
| 1564 | - return EEM_Payment_Method::instance()->get_last_used_for_registration($this); |
|
| 1565 | - } |
|
| 1566 | - |
|
| 1567 | - |
|
| 1568 | - /** |
|
| 1569 | - * @return \EE_Line_Item |
|
| 1570 | - * @throws EntityNotFoundException |
|
| 1571 | - * @throws \EE_Error |
|
| 1572 | - */ |
|
| 1573 | - public function ticket_line_item() |
|
| 1574 | - { |
|
| 1575 | - $ticket = $this->ticket(); |
|
| 1576 | - $transaction = $this->transaction(); |
|
| 1577 | - $line_item = null; |
|
| 1578 | - $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs( |
|
| 1579 | - $transaction->total_line_item(), |
|
| 1580 | - 'Ticket', |
|
| 1581 | - array($ticket->ID()) |
|
| 1582 | - ); |
|
| 1583 | - foreach ($ticket_line_items as $ticket_line_item) { |
|
| 1584 | - if ( |
|
| 1585 | - $ticket_line_item instanceof \EE_Line_Item |
|
| 1586 | - && $ticket_line_item->OBJ_type() === 'Ticket' |
|
| 1587 | - && $ticket_line_item->OBJ_ID() === $ticket->ID() |
|
| 1588 | - ) { |
|
| 1589 | - $line_item = $ticket_line_item; |
|
| 1590 | - break; |
|
| 1591 | - } |
|
| 1592 | - } |
|
| 1593 | - if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) { |
|
| 1594 | - throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID()); |
|
| 1595 | - } |
|
| 1596 | - return $line_item; |
|
| 1597 | - } |
|
| 1598 | - |
|
| 1599 | - |
|
| 1600 | - /** |
|
| 1601 | - * Soft Deletes this model object. |
|
| 1602 | - * |
|
| 1603 | - * @return boolean | int |
|
| 1604 | - * @throws \RuntimeException |
|
| 1605 | - * @throws \EE_Error |
|
| 1606 | - */ |
|
| 1607 | - public function delete() |
|
| 1608 | - { |
|
| 1609 | - if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) { |
|
| 1610 | - $this->set_status(EEM_Registration::status_id_cancelled); |
|
| 1611 | - } |
|
| 1612 | - return parent::delete(); |
|
| 1613 | - } |
|
| 1614 | - |
|
| 1615 | - |
|
| 1616 | - /** |
|
| 1617 | - * Restores whatever the previous status was on a registration before it was trashed (if possible) |
|
| 1618 | - * |
|
| 1619 | - * @throws \EE_Error |
|
| 1620 | - * @throws \RuntimeException |
|
| 1621 | - */ |
|
| 1622 | - public function restore() |
|
| 1623 | - { |
|
| 1624 | - $previous_status = $this->get_extra_meta( |
|
| 1625 | - EE_Registration::PRE_TRASH_REG_STATUS_KEY, |
|
| 1626 | - true, |
|
| 1627 | - EEM_Registration::status_id_cancelled |
|
| 1628 | - ); |
|
| 1629 | - if ($previous_status) { |
|
| 1630 | - $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY); |
|
| 1631 | - $this->set_status($previous_status); |
|
| 1632 | - } |
|
| 1633 | - return parent::restore(); |
|
| 1634 | - } |
|
| 1635 | - |
|
| 1636 | - |
|
| 1637 | - |
|
| 1638 | - /*************************** DEPRECATED ***************************/ |
|
| 1639 | - |
|
| 1640 | - |
|
| 1641 | - /** |
|
| 1642 | - * @deprecated |
|
| 1643 | - * @since 4.7.0 |
|
| 1644 | - * @access public |
|
| 1645 | - */ |
|
| 1646 | - public function price_paid() |
|
| 1647 | - { |
|
| 1648 | - EE_Error::doing_it_wrong('EE_Registration::price_paid()', |
|
| 1649 | - __('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'), |
|
| 1650 | - '4.7.0'); |
|
| 1651 | - return $this->final_price(); |
|
| 1652 | - } |
|
| 1653 | - |
|
| 1654 | - |
|
| 1655 | - /** |
|
| 1656 | - * @deprecated |
|
| 1657 | - * @since 4.7.0 |
|
| 1658 | - * @access public |
|
| 1659 | - * @param float $REG_final_price |
|
| 1660 | - */ |
|
| 1661 | - public function set_price_paid($REG_final_price = 0.00) |
|
| 1662 | - { |
|
| 1663 | - EE_Error::doing_it_wrong('EE_Registration::set_price_paid()', |
|
| 1664 | - __('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'), |
|
| 1665 | - '4.7.0'); |
|
| 1666 | - $this->set_final_price($REG_final_price); |
|
| 1667 | - } |
|
| 1668 | - |
|
| 1669 | - |
|
| 1670 | - /** |
|
| 1671 | - * @deprecated |
|
| 1672 | - * @since 4.7.0 |
|
| 1673 | - * @return string |
|
| 1674 | - */ |
|
| 1675 | - public function pretty_price_paid() |
|
| 1676 | - { |
|
| 1677 | - EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()', |
|
| 1678 | - __('This method is deprecated, please use EE_Registration::pretty_final_price() instead.', |
|
| 1679 | - 'event_espresso'), '4.7.0'); |
|
| 1680 | - return $this->pretty_final_price(); |
|
| 1681 | - } |
|
| 1682 | - |
|
| 1683 | - |
|
| 1684 | - /** |
|
| 1685 | - * Gets the primary datetime related to this registration via the related Event to this registration |
|
| 1686 | - * |
|
| 1687 | - * @deprecated 4.9.17 |
|
| 1688 | - * @return EE_Datetime |
|
| 1689 | - */ |
|
| 1690 | - public function get_related_primary_datetime() |
|
| 1691 | - { |
|
| 1692 | - EE_Error::doing_it_wrong( |
|
| 1693 | - __METHOD__, |
|
| 1694 | - esc_html__( |
|
| 1695 | - 'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()', |
|
| 1696 | - 'event_espresso' |
|
| 1697 | - ), |
|
| 1698 | - '4.9.17', |
|
| 1699 | - '5.0.0' |
|
| 1700 | - ); |
|
| 1701 | - return $this->event()->primary_datetime(); |
|
| 1702 | - } |
|
| 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); |
|
| 164 | + return true; |
|
| 165 | + } else { |
|
| 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 | + /** |
|
| 175 | + * update REGs and TXN when cancelled or declined registrations involved |
|
| 176 | + * |
|
| 177 | + * @param string $new_STS_ID |
|
| 178 | + * @param string $old_STS_ID |
|
| 179 | + * @throws \EE_Error |
|
| 180 | + */ |
|
| 181 | + private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID) |
|
| 182 | + { |
|
| 183 | + // these reg statuses should not be considered in any calculations involving monies owing |
|
| 184 | + $closed_reg_statuses = EEM_Registration::closed_reg_statuses(); |
|
| 185 | + // true if registration has been cancelled or declined |
|
| 186 | + if ( |
|
| 187 | + in_array($new_STS_ID, $closed_reg_statuses, true) |
|
| 188 | + && ! in_array($old_STS_ID, $closed_reg_statuses, true) |
|
| 189 | + ) { |
|
| 190 | + /** @type EE_Registration_Processor $registration_processor */ |
|
| 191 | + $registration_processor = EE_Registry::instance()->load_class('Registration_Processor'); |
|
| 192 | + /** @type EE_Transaction_Processor $transaction_processor */ |
|
| 193 | + $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
| 194 | + // cancelled or declined registration |
|
| 195 | + $registration_processor->update_registration_after_being_canceled_or_declined( |
|
| 196 | + $this, |
|
| 197 | + $closed_reg_statuses |
|
| 198 | + ); |
|
| 199 | + $transaction_processor->update_transaction_after_canceled_or_declined_registration( |
|
| 200 | + $this, |
|
| 201 | + $closed_reg_statuses, |
|
| 202 | + false |
|
| 203 | + ); |
|
| 204 | + do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID); |
|
| 205 | + return; |
|
| 206 | + } |
|
| 207 | + // true if reinstating cancelled or declined registration |
|
| 208 | + if ( |
|
| 209 | + in_array($old_STS_ID, $closed_reg_statuses, true) |
|
| 210 | + && ! in_array($new_STS_ID, $closed_reg_statuses, true) |
|
| 211 | + ) { |
|
| 212 | + /** @type EE_Registration_Processor $registration_processor */ |
|
| 213 | + $registration_processor = EE_Registry::instance()->load_class('Registration_Processor'); |
|
| 214 | + /** @type EE_Transaction_Processor $transaction_processor */ |
|
| 215 | + $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
| 216 | + // reinstating cancelled or declined registration |
|
| 217 | + $registration_processor->update_canceled_or_declined_registration_after_being_reinstated( |
|
| 218 | + $this, |
|
| 219 | + $closed_reg_statuses |
|
| 220 | + ); |
|
| 221 | + $transaction_processor->update_transaction_after_reinstating_canceled_registration( |
|
| 222 | + $this, |
|
| 223 | + $closed_reg_statuses, |
|
| 224 | + false |
|
| 225 | + ); |
|
| 226 | + do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID); |
|
| 227 | + } |
|
| 228 | + } |
|
| 229 | + |
|
| 230 | + |
|
| 231 | + /** |
|
| 232 | + * get Status ID |
|
| 233 | + */ |
|
| 234 | + public function status_ID() |
|
| 235 | + { |
|
| 236 | + return $this->get('STS_ID'); |
|
| 237 | + } |
|
| 238 | + |
|
| 239 | + |
|
| 240 | + /** |
|
| 241 | + * increments this registration's related ticket sold and corresponding datetime sold values |
|
| 242 | + * |
|
| 243 | + * @return void |
|
| 244 | + * @throws \EE_Error |
|
| 245 | + */ |
|
| 246 | + private function _reserve_registration_space() |
|
| 247 | + { |
|
| 248 | + // reserved ticket and datetime counts will be decremented as sold counts are incremented |
|
| 249 | + // so stop tracking that this reg has a ticket reserved |
|
| 250 | + $this->release_reserved_ticket(); |
|
| 251 | + $ticket = $this->ticket(); |
|
| 252 | + $ticket->increase_sold(); |
|
| 253 | + $ticket->save(); |
|
| 254 | + // possibly set event status to sold out |
|
| 255 | + $this->event()->perform_sold_out_status_check(); |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + |
|
| 259 | + /** |
|
| 260 | + * Gets the ticket this registration is for |
|
| 261 | + * |
|
| 262 | + * @param boolean $include_archived whether to include archived tickets or not. |
|
| 263 | + * @return EE_Ticket|EE_Base_Class |
|
| 264 | + * @throws \EE_Error |
|
| 265 | + */ |
|
| 266 | + public function ticket($include_archived = true) |
|
| 267 | + { |
|
| 268 | + $query_params = array(); |
|
| 269 | + if ($include_archived) { |
|
| 270 | + $query_params['default_where_conditions'] = 'none'; |
|
| 271 | + } |
|
| 272 | + return $this->get_first_related('Ticket', $query_params); |
|
| 273 | + } |
|
| 274 | + |
|
| 275 | + |
|
| 276 | + /** |
|
| 277 | + * Gets the event this registration is for |
|
| 278 | + * |
|
| 279 | + * @return EE_Event |
|
| 280 | + */ |
|
| 281 | + public function event() |
|
| 282 | + { |
|
| 283 | + $event = $this->get_first_related('Event'); |
|
| 284 | + if (! $event instanceof \EE_Event) { |
|
| 285 | + throw new EntityNotFoundException('Event ID', $this->event_ID()); |
|
| 286 | + } |
|
| 287 | + return $event; |
|
| 288 | + } |
|
| 289 | + |
|
| 290 | + |
|
| 291 | + /** |
|
| 292 | + * Gets the "author" of the registration. Note that for the purposes of registrations, the author will correspond |
|
| 293 | + * with the author of the event this registration is for. |
|
| 294 | + * |
|
| 295 | + * @since 4.5.0 |
|
| 296 | + * @return int |
|
| 297 | + */ |
|
| 298 | + public function wp_user() |
|
| 299 | + { |
|
| 300 | + $event = $this->event(); |
|
| 301 | + if ($event instanceof EE_Event) { |
|
| 302 | + return $event->wp_user(); |
|
| 303 | + } |
|
| 304 | + return 0; |
|
| 305 | + } |
|
| 306 | + |
|
| 307 | + |
|
| 308 | + /** |
|
| 309 | + * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values |
|
| 310 | + * |
|
| 311 | + * @return void |
|
| 312 | + * @throws \EE_Error |
|
| 313 | + */ |
|
| 314 | + private function _release_registration_space() |
|
| 315 | + { |
|
| 316 | + $ticket = $this->ticket(); |
|
| 317 | + $ticket->decrease_sold(); |
|
| 318 | + $ticket->save(); |
|
| 319 | + } |
|
| 320 | + |
|
| 321 | + |
|
| 322 | + /** |
|
| 323 | + * tracks this registration's ticket reservation in extra meta |
|
| 324 | + * and can increment related ticket reserved and corresponding datetime reserved values |
|
| 325 | + * |
|
| 326 | + * @param bool $update_ticket if true, will increment ticket and datetime reserved count |
|
| 327 | + * @return void |
|
| 328 | + * @throws \EE_Error |
|
| 329 | + */ |
|
| 330 | + public function reserve_ticket($update_ticket = false) |
|
| 331 | + { |
|
| 332 | + if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) { |
|
| 333 | + // PLZ NOTE: although checking $update_ticket first would be more efficient, |
|
| 334 | + // we NEED to ALWAYS call update_extra_meta(), which is why that is done first |
|
| 335 | + if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) { |
|
| 336 | + $ticket = $this->ticket(); |
|
| 337 | + $ticket->increase_reserved(); |
|
| 338 | + $ticket->save(); |
|
| 339 | + } |
|
| 340 | + } |
|
| 341 | + } |
|
| 342 | + |
|
| 343 | + |
|
| 344 | + /** |
|
| 345 | + * stops tracking this registration's ticket reservation in extra meta |
|
| 346 | + * decrements (subtracts) related ticket reserved and corresponding datetime reserved values |
|
| 347 | + * |
|
| 348 | + * @param bool $update_ticket if true, will decrement ticket and datetime reserved count |
|
| 349 | + * @return void |
|
| 350 | + * @throws \EE_Error |
|
| 351 | + */ |
|
| 352 | + public function release_reserved_ticket($update_ticket = false) |
|
| 353 | + { |
|
| 354 | + if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) { |
|
| 355 | + // PLZ NOTE: although checking $update_ticket first would be more efficient, |
|
| 356 | + // we NEED to ALWAYS call delete_extra_meta(), which is why that is done first |
|
| 357 | + if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) { |
|
| 358 | + $ticket = $this->ticket(); |
|
| 359 | + $ticket->decrease_reserved(); |
|
| 360 | + $ticket->save(); |
|
| 361 | + } |
|
| 362 | + } |
|
| 363 | + } |
|
| 364 | + |
|
| 365 | + |
|
| 366 | + /** |
|
| 367 | + * Set Attendee ID |
|
| 368 | + * |
|
| 369 | + * @param int $ATT_ID Attendee ID |
|
| 370 | + */ |
|
| 371 | + public function set_attendee_id($ATT_ID = 0) |
|
| 372 | + { |
|
| 373 | + $this->set('ATT_ID', $ATT_ID); |
|
| 374 | + } |
|
| 375 | + |
|
| 376 | + |
|
| 377 | + /** |
|
| 378 | + * Set Transaction ID |
|
| 379 | + * |
|
| 380 | + * @param int $TXN_ID Transaction ID |
|
| 381 | + */ |
|
| 382 | + public function set_transaction_id($TXN_ID = 0) |
|
| 383 | + { |
|
| 384 | + $this->set('TXN_ID', $TXN_ID); |
|
| 385 | + } |
|
| 386 | + |
|
| 387 | + |
|
| 388 | + /** |
|
| 389 | + * Set Session |
|
| 390 | + * |
|
| 391 | + * @param string $REG_session PHP Session ID |
|
| 392 | + */ |
|
| 393 | + public function set_session($REG_session = '') |
|
| 394 | + { |
|
| 395 | + $this->set('REG_session', $REG_session); |
|
| 396 | + } |
|
| 397 | + |
|
| 398 | + |
|
| 399 | + /** |
|
| 400 | + * Set Registration URL Link |
|
| 401 | + * |
|
| 402 | + * @param string $REG_url_link Registration URL Link |
|
| 403 | + */ |
|
| 404 | + public function set_reg_url_link($REG_url_link = '') |
|
| 405 | + { |
|
| 406 | + $this->set('REG_url_link', $REG_url_link); |
|
| 407 | + } |
|
| 408 | + |
|
| 409 | + |
|
| 410 | + /** |
|
| 411 | + * Set Attendee Counter |
|
| 412 | + * |
|
| 413 | + * @param int $REG_count Primary Attendee |
|
| 414 | + */ |
|
| 415 | + public function set_count($REG_count = 1) |
|
| 416 | + { |
|
| 417 | + $this->set('REG_count', $REG_count); |
|
| 418 | + } |
|
| 419 | + |
|
| 420 | + |
|
| 421 | + /** |
|
| 422 | + * Set Group Size |
|
| 423 | + * |
|
| 424 | + * @param boolean $REG_group_size Group Registration |
|
| 425 | + */ |
|
| 426 | + public function set_group_size($REG_group_size = false) |
|
| 427 | + { |
|
| 428 | + $this->set('REG_group_size', $REG_group_size); |
|
| 429 | + } |
|
| 430 | + |
|
| 431 | + |
|
| 432 | + /** |
|
| 433 | + * is_not_approved - convenience method that returns TRUE if REG status ID == |
|
| 434 | + * EEM_Registration::status_id_not_approved |
|
| 435 | + * |
|
| 436 | + * @return boolean |
|
| 437 | + */ |
|
| 438 | + public function is_not_approved() |
|
| 439 | + { |
|
| 440 | + return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false; |
|
| 441 | + } |
|
| 442 | + |
|
| 443 | + |
|
| 444 | + /** |
|
| 445 | + * is_pending_payment - convenience method that returns TRUE if REG status ID == |
|
| 446 | + * EEM_Registration::status_id_pending_payment |
|
| 447 | + * |
|
| 448 | + * @return boolean |
|
| 449 | + */ |
|
| 450 | + public function is_pending_payment() |
|
| 451 | + { |
|
| 452 | + return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false; |
|
| 453 | + } |
|
| 454 | + |
|
| 455 | + |
|
| 456 | + /** |
|
| 457 | + * is_approved - convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved |
|
| 458 | + * |
|
| 459 | + * @return boolean |
|
| 460 | + */ |
|
| 461 | + public function is_approved() |
|
| 462 | + { |
|
| 463 | + return $this->status_ID() == EEM_Registration::status_id_approved ? true : false; |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + |
|
| 467 | + /** |
|
| 468 | + * is_cancelled - convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled |
|
| 469 | + * |
|
| 470 | + * @return boolean |
|
| 471 | + */ |
|
| 472 | + public function is_cancelled() |
|
| 473 | + { |
|
| 474 | + return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false; |
|
| 475 | + } |
|
| 476 | + |
|
| 477 | + |
|
| 478 | + /** |
|
| 479 | + * is_declined - convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined |
|
| 480 | + * |
|
| 481 | + * @return boolean |
|
| 482 | + */ |
|
| 483 | + public function is_declined() |
|
| 484 | + { |
|
| 485 | + return $this->status_ID() == EEM_Registration::status_id_declined ? true : false; |
|
| 486 | + } |
|
| 487 | + |
|
| 488 | + |
|
| 489 | + /** |
|
| 490 | + * is_incomplete - convenience method that returns TRUE if REG status ID == |
|
| 491 | + * EEM_Registration::status_id_incomplete |
|
| 492 | + * |
|
| 493 | + * @return boolean |
|
| 494 | + */ |
|
| 495 | + public function is_incomplete() |
|
| 496 | + { |
|
| 497 | + return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false; |
|
| 498 | + } |
|
| 499 | + |
|
| 500 | + |
|
| 501 | + /** |
|
| 502 | + * Set Registration Date |
|
| 503 | + * |
|
| 504 | + * @param mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of |
|
| 505 | + * Date |
|
| 506 | + */ |
|
| 507 | + public function set_reg_date($REG_date = false) |
|
| 508 | + { |
|
| 509 | + $this->set('REG_date', $REG_date); |
|
| 510 | + } |
|
| 511 | + |
|
| 512 | + |
|
| 513 | + /** |
|
| 514 | + * Set final price owing for this registration after all ticket/price modifications |
|
| 515 | + * |
|
| 516 | + * @access public |
|
| 517 | + * @param float $REG_final_price |
|
| 518 | + */ |
|
| 519 | + public function set_final_price($REG_final_price = 0.00) |
|
| 520 | + { |
|
| 521 | + $this->set('REG_final_price', $REG_final_price); |
|
| 522 | + } |
|
| 523 | + |
|
| 524 | + |
|
| 525 | + /** |
|
| 526 | + * Set amount paid towards this registration's final price |
|
| 527 | + * |
|
| 528 | + * @access public |
|
| 529 | + * @param float $REG_paid |
|
| 530 | + */ |
|
| 531 | + public function set_paid($REG_paid = 0.00) |
|
| 532 | + { |
|
| 533 | + $this->set('REG_paid', $REG_paid); |
|
| 534 | + } |
|
| 535 | + |
|
| 536 | + |
|
| 537 | + /** |
|
| 538 | + * Attendee Is Going |
|
| 539 | + * |
|
| 540 | + * @param boolean $REG_att_is_going Attendee Is Going |
|
| 541 | + */ |
|
| 542 | + public function set_att_is_going($REG_att_is_going = false) |
|
| 543 | + { |
|
| 544 | + $this->set('REG_att_is_going', $REG_att_is_going); |
|
| 545 | + } |
|
| 546 | + |
|
| 547 | + |
|
| 548 | + /** |
|
| 549 | + * Gets the related attendee |
|
| 550 | + * |
|
| 551 | + * @return EE_Attendee |
|
| 552 | + */ |
|
| 553 | + public function attendee() |
|
| 554 | + { |
|
| 555 | + return $this->get_first_related('Attendee'); |
|
| 556 | + } |
|
| 557 | + |
|
| 558 | + |
|
| 559 | + /** |
|
| 560 | + * get Event ID |
|
| 561 | + */ |
|
| 562 | + public function event_ID() |
|
| 563 | + { |
|
| 564 | + return $this->get('EVT_ID'); |
|
| 565 | + } |
|
| 566 | + |
|
| 567 | + |
|
| 568 | + /** |
|
| 569 | + * get Event ID |
|
| 570 | + */ |
|
| 571 | + public function event_name() |
|
| 572 | + { |
|
| 573 | + $event = $this->event_obj(); |
|
| 574 | + if ($event) { |
|
| 575 | + return $event->name(); |
|
| 576 | + } else { |
|
| 577 | + return null; |
|
| 578 | + } |
|
| 579 | + } |
|
| 580 | + |
|
| 581 | + |
|
| 582 | + /** |
|
| 583 | + * Fetches the event this registration is for |
|
| 584 | + * |
|
| 585 | + * @return EE_Event |
|
| 586 | + */ |
|
| 587 | + public function event_obj() |
|
| 588 | + { |
|
| 589 | + return $this->get_first_related('Event'); |
|
| 590 | + } |
|
| 591 | + |
|
| 592 | + |
|
| 593 | + /** |
|
| 594 | + * get Attendee ID |
|
| 595 | + */ |
|
| 596 | + public function attendee_ID() |
|
| 597 | + { |
|
| 598 | + return $this->get('ATT_ID'); |
|
| 599 | + } |
|
| 600 | + |
|
| 601 | + |
|
| 602 | + /** |
|
| 603 | + * get PHP Session ID |
|
| 604 | + */ |
|
| 605 | + public function session_ID() |
|
| 606 | + { |
|
| 607 | + return $this->get('REG_session'); |
|
| 608 | + } |
|
| 609 | + |
|
| 610 | + |
|
| 611 | + /** |
|
| 612 | + * Gets the string which represents the URL trigger for the receipt template in the message template system. |
|
| 613 | + * |
|
| 614 | + * @param string $messenger 'pdf' or 'html'. Default 'html'. |
|
| 615 | + * @return string |
|
| 616 | + */ |
|
| 617 | + public function receipt_url($messenger = 'html') |
|
| 618 | + { |
|
| 619 | + |
|
| 620 | + /** |
|
| 621 | + * 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. |
|
| 622 | + * |
|
| 623 | + * @since 4.5.0 |
|
| 624 | + */ |
|
| 625 | + $template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php'; |
|
| 626 | + $has_custom = EEH_Template::locate_template($template_relative_path, array(), true, true, true); |
|
| 627 | + |
|
| 628 | + if ($has_custom) { |
|
| 629 | + return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch')); |
|
| 630 | + } |
|
| 631 | + return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt'); |
|
| 632 | + } |
|
| 633 | + |
|
| 634 | + |
|
| 635 | + /** |
|
| 636 | + * Gets the string which represents the URL trigger for the invoice template in the message template system. |
|
| 637 | + * |
|
| 638 | + * @param string $messenger 'pdf' or 'html'. Default 'html'. |
|
| 639 | + * @return string |
|
| 640 | + */ |
|
| 641 | + public function invoice_url($messenger = 'html') |
|
| 642 | + { |
|
| 643 | + /** |
|
| 644 | + * 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. |
|
| 645 | + * |
|
| 646 | + * @since 4.5.0 |
|
| 647 | + */ |
|
| 648 | + $template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php'; |
|
| 649 | + $has_custom = EEH_Template::locate_template($template_relative_path, array(), true, true, true); |
|
| 650 | + |
|
| 651 | + if ($has_custom) { |
|
| 652 | + if ($messenger == 'html') { |
|
| 653 | + return $this->invoice_url('launch'); |
|
| 654 | + } |
|
| 655 | + $route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice'; |
|
| 656 | + |
|
| 657 | + $query_args = array('ee' => $route, 'id' => $this->reg_url_link()); |
|
| 658 | + if ($messenger == 'html') { |
|
| 659 | + $query_args['html'] = true; |
|
| 660 | + } |
|
| 661 | + return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id)); |
|
| 662 | + } |
|
| 663 | + return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice'); |
|
| 664 | + } |
|
| 665 | + |
|
| 666 | + |
|
| 667 | + /** |
|
| 668 | + * get Registration URL Link |
|
| 669 | + * |
|
| 670 | + * @access public |
|
| 671 | + * @return string |
|
| 672 | + * @throws \EE_Error |
|
| 673 | + */ |
|
| 674 | + public function reg_url_link() |
|
| 675 | + { |
|
| 676 | + return (string)$this->get('REG_url_link'); |
|
| 677 | + } |
|
| 678 | + |
|
| 679 | + |
|
| 680 | + /** |
|
| 681 | + * Echoes out invoice_url() |
|
| 682 | + * |
|
| 683 | + * @param string $type 'download','launch', or 'html' (default is 'launch') |
|
| 684 | + * @return void |
|
| 685 | + */ |
|
| 686 | + public function e_invoice_url($type = 'launch') |
|
| 687 | + { |
|
| 688 | + echo $this->invoice_url($type); |
|
| 689 | + } |
|
| 690 | + |
|
| 691 | + |
|
| 692 | + /** |
|
| 693 | + * Echoes out payment_overview_url |
|
| 694 | + */ |
|
| 695 | + public function e_payment_overview_url() |
|
| 696 | + { |
|
| 697 | + echo $this->payment_overview_url(); |
|
| 698 | + } |
|
| 699 | + |
|
| 700 | + |
|
| 701 | + /** |
|
| 702 | + * Gets the URL of the thank you page with this registration REG_url_link added as |
|
| 703 | + * a query parameter |
|
| 704 | + * |
|
| 705 | + * @return string |
|
| 706 | + */ |
|
| 707 | + public function payment_overview_url() |
|
| 708 | + { |
|
| 709 | + return add_query_arg(array( |
|
| 710 | + 'e_reg_url_link' => $this->reg_url_link(), |
|
| 711 | + 'step' => 'payment_options', |
|
| 712 | + 'revisit' => true, |
|
| 713 | + ), EE_Registry::instance()->CFG->core->reg_page_url()); |
|
| 714 | + } |
|
| 715 | + |
|
| 716 | + |
|
| 717 | + /** |
|
| 718 | + * Gets the URL of the thank you page with this registration REG_url_link added as |
|
| 719 | + * a query parameter |
|
| 720 | + * |
|
| 721 | + * @return string |
|
| 722 | + */ |
|
| 723 | + public function edit_attendee_information_url() |
|
| 724 | + { |
|
| 725 | + return add_query_arg(array( |
|
| 726 | + 'e_reg_url_link' => $this->reg_url_link(), |
|
| 727 | + 'step' => 'attendee_information', |
|
| 728 | + 'revisit' => true, |
|
| 729 | + ), EE_Registry::instance()->CFG->core->reg_page_url()); |
|
| 730 | + } |
|
| 731 | + |
|
| 732 | + |
|
| 733 | + /** |
|
| 734 | + * Simply generates and returns the appropriate admin_url link to edit this registration |
|
| 735 | + * |
|
| 736 | + * @return string |
|
| 737 | + */ |
|
| 738 | + public function get_admin_edit_url() |
|
| 739 | + { |
|
| 740 | + return EEH_URL::add_query_args_and_nonce(array( |
|
| 741 | + 'page' => 'espresso_registrations', |
|
| 742 | + 'action' => 'view_registration', |
|
| 743 | + '_REG_ID' => $this->ID(), |
|
| 744 | + ), admin_url('admin.php')); |
|
| 745 | + } |
|
| 746 | + |
|
| 747 | + |
|
| 748 | + /** |
|
| 749 | + * is_primary_registrant? |
|
| 750 | + */ |
|
| 751 | + public function is_primary_registrant() |
|
| 752 | + { |
|
| 753 | + return $this->get('REG_count') == 1 ? true : false; |
|
| 754 | + } |
|
| 755 | + |
|
| 756 | + |
|
| 757 | + /** |
|
| 758 | + * This returns the primary registration object for this registration group (which may be this object). |
|
| 759 | + * |
|
| 760 | + * @return EE_Registration |
|
| 761 | + */ |
|
| 762 | + public function get_primary_registration() |
|
| 763 | + { |
|
| 764 | + if ($this->is_primary_registrant()) { |
|
| 765 | + return $this; |
|
| 766 | + } |
|
| 767 | + |
|
| 768 | + //k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1 |
|
| 769 | + $primary_registrant = EEM_Registration::instance()->get_one(array( |
|
| 770 | + array( |
|
| 771 | + 'TXN_ID' => $this->transaction_ID(), |
|
| 772 | + 'REG_count' => 1, |
|
| 773 | + ), |
|
| 774 | + )); |
|
| 775 | + return $primary_registrant; |
|
| 776 | + } |
|
| 777 | + |
|
| 778 | + |
|
| 779 | + /** |
|
| 780 | + * get Attendee Number |
|
| 781 | + * |
|
| 782 | + * @access public |
|
| 783 | + */ |
|
| 784 | + public function count() |
|
| 785 | + { |
|
| 786 | + return $this->get('REG_count'); |
|
| 787 | + } |
|
| 788 | + |
|
| 789 | + |
|
| 790 | + /** |
|
| 791 | + * get Group Size |
|
| 792 | + */ |
|
| 793 | + public function group_size() |
|
| 794 | + { |
|
| 795 | + return $this->get('REG_group_size'); |
|
| 796 | + } |
|
| 797 | + |
|
| 798 | + |
|
| 799 | + /** |
|
| 800 | + * get Registration Date |
|
| 801 | + */ |
|
| 802 | + public function date() |
|
| 803 | + { |
|
| 804 | + return $this->get('REG_date'); |
|
| 805 | + } |
|
| 806 | + |
|
| 807 | + |
|
| 808 | + /** |
|
| 809 | + * gets a pretty date |
|
| 810 | + * |
|
| 811 | + * @param string $date_format |
|
| 812 | + * @param string $time_format |
|
| 813 | + * @return string |
|
| 814 | + */ |
|
| 815 | + public function pretty_date($date_format = null, $time_format = null) |
|
| 816 | + { |
|
| 817 | + return $this->get_datetime('REG_date', $date_format, $time_format); |
|
| 818 | + } |
|
| 819 | + |
|
| 820 | + |
|
| 821 | + /** |
|
| 822 | + * final_price |
|
| 823 | + * the registration's share of the transaction total, so that the |
|
| 824 | + * sum of all the transaction's REG_final_prices equal the transaction's total |
|
| 825 | + * |
|
| 826 | + * @return float |
|
| 827 | + */ |
|
| 828 | + public function final_price() |
|
| 829 | + { |
|
| 830 | + return $this->get('REG_final_price'); |
|
| 831 | + } |
|
| 832 | + |
|
| 833 | + |
|
| 834 | + /** |
|
| 835 | + * pretty_final_price |
|
| 836 | + * final price as formatted string, with correct decimal places and currency symbol |
|
| 837 | + * |
|
| 838 | + * @return string |
|
| 839 | + */ |
|
| 840 | + public function pretty_final_price() |
|
| 841 | + { |
|
| 842 | + return $this->get_pretty('REG_final_price'); |
|
| 843 | + } |
|
| 844 | + |
|
| 845 | + |
|
| 846 | + /** |
|
| 847 | + * get paid (yeah) |
|
| 848 | + * |
|
| 849 | + * @return float |
|
| 850 | + */ |
|
| 851 | + public function paid() |
|
| 852 | + { |
|
| 853 | + return $this->get('REG_paid'); |
|
| 854 | + } |
|
| 855 | + |
|
| 856 | + |
|
| 857 | + /** |
|
| 858 | + * pretty_paid |
|
| 859 | + * |
|
| 860 | + * @return float |
|
| 861 | + */ |
|
| 862 | + public function pretty_paid() |
|
| 863 | + { |
|
| 864 | + return $this->get_pretty('REG_paid'); |
|
| 865 | + } |
|
| 866 | + |
|
| 867 | + |
|
| 868 | + /** |
|
| 869 | + * owes_monies_and_can_pay |
|
| 870 | + * whether or not this registration has monies owing and it's' status allows payment |
|
| 871 | + * |
|
| 872 | + * @param array $requires_payment |
|
| 873 | + * @return bool |
|
| 874 | + */ |
|
| 875 | + public function owes_monies_and_can_pay($requires_payment = array()) |
|
| 876 | + { |
|
| 877 | + // these reg statuses require payment (if event is not free) |
|
| 878 | + $requires_payment = ! empty($requires_payment) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment(); |
|
| 879 | + if ( |
|
| 880 | + in_array($this->status_ID(), $requires_payment) && |
|
| 881 | + $this->final_price() != 0 && |
|
| 882 | + $this->final_price() != $this->paid() |
|
| 883 | + ) { |
|
| 884 | + return true; |
|
| 885 | + } else { |
|
| 886 | + return false; |
|
| 887 | + } |
|
| 888 | + } |
|
| 889 | + |
|
| 890 | + |
|
| 891 | + /** |
|
| 892 | + * Prints out the return value of $this->pretty_status() |
|
| 893 | + * |
|
| 894 | + * @param bool $show_icons |
|
| 895 | + * @return void |
|
| 896 | + */ |
|
| 897 | + public function e_pretty_status($show_icons = false) |
|
| 898 | + { |
|
| 899 | + echo $this->pretty_status($show_icons); |
|
| 900 | + } |
|
| 901 | + |
|
| 902 | + |
|
| 903 | + /** |
|
| 904 | + * Returns a nice version of the status for displaying to customers |
|
| 905 | + * |
|
| 906 | + * @param bool $show_icons |
|
| 907 | + * @return string |
|
| 908 | + */ |
|
| 909 | + public function pretty_status($show_icons = false) |
|
| 910 | + { |
|
| 911 | + $status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')), |
|
| 912 | + false, 'sentence'); |
|
| 913 | + $icon = ''; |
|
| 914 | + switch ($this->status_ID()) { |
|
| 915 | + case EEM_Registration::status_id_approved: |
|
| 916 | + $icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : ''; |
|
| 917 | + break; |
|
| 918 | + case EEM_Registration::status_id_pending_payment: |
|
| 919 | + $icon = $show_icons ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>' : ''; |
|
| 920 | + break; |
|
| 921 | + case EEM_Registration::status_id_not_approved: |
|
| 922 | + $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>' : ''; |
|
| 923 | + break; |
|
| 924 | + case EEM_Registration::status_id_cancelled: |
|
| 925 | + $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>' : ''; |
|
| 926 | + break; |
|
| 927 | + case EEM_Registration::status_id_incomplete: |
|
| 928 | + $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>' : ''; |
|
| 929 | + break; |
|
| 930 | + case EEM_Registration::status_id_declined: |
|
| 931 | + $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : ''; |
|
| 932 | + break; |
|
| 933 | + case EEM_Registration::status_id_wait_list: |
|
| 934 | + $icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : ''; |
|
| 935 | + break; |
|
| 936 | + } |
|
| 937 | + return $icon . $status[$this->status_ID()]; |
|
| 938 | + } |
|
| 939 | + |
|
| 940 | + |
|
| 941 | + /** |
|
| 942 | + * get Attendee Is Going |
|
| 943 | + */ |
|
| 944 | + public function att_is_going() |
|
| 945 | + { |
|
| 946 | + return $this->get('REG_att_is_going'); |
|
| 947 | + } |
|
| 948 | + |
|
| 949 | + |
|
| 950 | + /** |
|
| 951 | + * Gets related answers |
|
| 952 | + * |
|
| 953 | + * @param array $query_params like EEM_Base::get_all |
|
| 954 | + * @return EE_Answer[] |
|
| 955 | + */ |
|
| 956 | + public function answers($query_params = null) |
|
| 957 | + { |
|
| 958 | + return $this->get_many_related('Answer', $query_params); |
|
| 959 | + } |
|
| 960 | + |
|
| 961 | + |
|
| 962 | + /** |
|
| 963 | + * Gets the registration's answer value to the specified question |
|
| 964 | + * (either the question's ID or a question object) |
|
| 965 | + * |
|
| 966 | + * @param EE_Question|int $question |
|
| 967 | + * @param bool $pretty_value |
|
| 968 | + * @return array|string if pretty_value= true, the result will always be a string |
|
| 969 | + * (because the answer might be an array of answer values, so passing pretty_value=true |
|
| 970 | + * will convert it into some kind of string) |
|
| 971 | + */ |
|
| 972 | + public function answer_value_to_question($question, $pretty_value = true) |
|
| 973 | + { |
|
| 974 | + $question_id = EEM_Question::instance()->ensure_is_ID($question); |
|
| 975 | + return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value); |
|
| 976 | + } |
|
| 977 | + |
|
| 978 | + |
|
| 979 | + /** |
|
| 980 | + * question_groups |
|
| 981 | + * returns an array of EE_Question_Group objects for this registration |
|
| 982 | + * |
|
| 983 | + * @return EE_Question_Group[] |
|
| 984 | + */ |
|
| 985 | + public function question_groups() |
|
| 986 | + { |
|
| 987 | + $question_groups = array(); |
|
| 988 | + if ($this->event() instanceof EE_Event) { |
|
| 989 | + $question_groups = $this->event()->question_groups( |
|
| 990 | + array( |
|
| 991 | + array( |
|
| 992 | + 'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false, |
|
| 993 | + ), |
|
| 994 | + 'order_by' => array('QSG_order' => 'ASC'), |
|
| 995 | + ) |
|
| 996 | + ); |
|
| 997 | + } |
|
| 998 | + return $question_groups; |
|
| 999 | + } |
|
| 1000 | + |
|
| 1001 | + |
|
| 1002 | + /** |
|
| 1003 | + * count_question_groups |
|
| 1004 | + * returns a count of the number of EE_Question_Group objects for this registration |
|
| 1005 | + * |
|
| 1006 | + * @return int |
|
| 1007 | + */ |
|
| 1008 | + public function count_question_groups() |
|
| 1009 | + { |
|
| 1010 | + $qg_count = 0; |
|
| 1011 | + if ($this->event() instanceof EE_Event) { |
|
| 1012 | + $qg_count = $this->event()->count_related( |
|
| 1013 | + 'Question_Group', |
|
| 1014 | + array( |
|
| 1015 | + array( |
|
| 1016 | + 'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false, |
|
| 1017 | + ), |
|
| 1018 | + ) |
|
| 1019 | + ); |
|
| 1020 | + } |
|
| 1021 | + return $qg_count; |
|
| 1022 | + } |
|
| 1023 | + |
|
| 1024 | + |
|
| 1025 | + /** |
|
| 1026 | + * Returns the registration date in the 'standard' string format |
|
| 1027 | + * (function may be improved in the future to allow for different formats and timezones) |
|
| 1028 | + * |
|
| 1029 | + * @return string |
|
| 1030 | + */ |
|
| 1031 | + public function reg_date() |
|
| 1032 | + { |
|
| 1033 | + return $this->get_datetime('REG_date'); |
|
| 1034 | + } |
|
| 1035 | + |
|
| 1036 | + |
|
| 1037 | + /** |
|
| 1038 | + * Gets the datetime-ticket for this registration (ie, it can be used to isolate |
|
| 1039 | + * the ticket this registration purchased, or the datetime they have registered |
|
| 1040 | + * to attend) |
|
| 1041 | + * |
|
| 1042 | + * @return EE_Datetime_Ticket |
|
| 1043 | + */ |
|
| 1044 | + public function datetime_ticket() |
|
| 1045 | + { |
|
| 1046 | + return $this->get_first_related('Datetime_Ticket'); |
|
| 1047 | + } |
|
| 1048 | + |
|
| 1049 | + |
|
| 1050 | + /** |
|
| 1051 | + * Sets the registration's datetime_ticket. |
|
| 1052 | + * |
|
| 1053 | + * @param EE_Datetime_Ticket $datetime_ticket |
|
| 1054 | + * @return EE_Datetime_Ticket |
|
| 1055 | + */ |
|
| 1056 | + public function set_datetime_ticket($datetime_ticket) |
|
| 1057 | + { |
|
| 1058 | + return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket'); |
|
| 1059 | + } |
|
| 1060 | + |
|
| 1061 | + /** |
|
| 1062 | + * Gets deleted |
|
| 1063 | + * |
|
| 1064 | + * @return boolean |
|
| 1065 | + */ |
|
| 1066 | + public function deleted() |
|
| 1067 | + { |
|
| 1068 | + return $this->get('REG_deleted'); |
|
| 1069 | + } |
|
| 1070 | + |
|
| 1071 | + /** |
|
| 1072 | + * Sets deleted |
|
| 1073 | + * |
|
| 1074 | + * @param boolean $deleted |
|
| 1075 | + * @return boolean |
|
| 1076 | + */ |
|
| 1077 | + public function set_deleted($deleted) |
|
| 1078 | + { |
|
| 1079 | + if ($deleted) { |
|
| 1080 | + $this->delete(); |
|
| 1081 | + } else { |
|
| 1082 | + $this->restore(); |
|
| 1083 | + } |
|
| 1084 | + } |
|
| 1085 | + |
|
| 1086 | + |
|
| 1087 | + /** |
|
| 1088 | + * Get the status object of this object |
|
| 1089 | + * |
|
| 1090 | + * @return EE_Status |
|
| 1091 | + */ |
|
| 1092 | + public function status_obj() |
|
| 1093 | + { |
|
| 1094 | + return $this->get_first_related('Status'); |
|
| 1095 | + } |
|
| 1096 | + |
|
| 1097 | + |
|
| 1098 | + /** |
|
| 1099 | + * Returns the number of times this registration has checked into any of the datetimes |
|
| 1100 | + * its available for |
|
| 1101 | + * |
|
| 1102 | + * @return int |
|
| 1103 | + */ |
|
| 1104 | + public function count_checkins() |
|
| 1105 | + { |
|
| 1106 | + return $this->get_model()->count_related($this, 'Checkin'); |
|
| 1107 | + } |
|
| 1108 | + |
|
| 1109 | + |
|
| 1110 | + /** |
|
| 1111 | + * Returns the number of current Check-ins this registration is checked into for any of the datetimes the |
|
| 1112 | + * registration is for. Note, this is ONLY checked in (does not include checkedout) |
|
| 1113 | + * |
|
| 1114 | + * @return int |
|
| 1115 | + */ |
|
| 1116 | + public function count_checkins_not_checkedout() |
|
| 1117 | + { |
|
| 1118 | + return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1))); |
|
| 1119 | + } |
|
| 1120 | + |
|
| 1121 | + |
|
| 1122 | + /** |
|
| 1123 | + * The purpose of this method is simply to check whether this registration can checkin to the given datetime. |
|
| 1124 | + * |
|
| 1125 | + * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against |
|
| 1126 | + * @param bool $check_approved This is used to indicate whether the caller wants can_checkin to also |
|
| 1127 | + * consider registration status as well as datetime access. |
|
| 1128 | + * @return bool |
|
| 1129 | + */ |
|
| 1130 | + public function can_checkin($DTT_OR_ID, $check_approved = true) |
|
| 1131 | + { |
|
| 1132 | + $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID); |
|
| 1133 | + |
|
| 1134 | + //first check registration status |
|
| 1135 | + if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) { |
|
| 1136 | + return false; |
|
| 1137 | + } |
|
| 1138 | + //is there a datetime ticket that matches this dtt_ID? |
|
| 1139 | + if (! (EEM_Datetime_Ticket::instance()->exists(array( |
|
| 1140 | + array( |
|
| 1141 | + 'TKT_ID' => $this->get('TKT_ID'), |
|
| 1142 | + 'DTT_ID' => $DTT_ID, |
|
| 1143 | + ), |
|
| 1144 | + ))) |
|
| 1145 | + ) { |
|
| 1146 | + return false; |
|
| 1147 | + } |
|
| 1148 | + |
|
| 1149 | + //final check is against TKT_uses |
|
| 1150 | + return $this->verify_can_checkin_against_TKT_uses($DTT_ID); |
|
| 1151 | + } |
|
| 1152 | + |
|
| 1153 | + |
|
| 1154 | + /** |
|
| 1155 | + * This method verifies whether the user can checkin for the given datetime considering the max uses value set on |
|
| 1156 | + * the ticket. To do this, a query is done to get the count of the datetime records already checked into. If the |
|
| 1157 | + * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses, |
|
| 1158 | + * then return false. Otherwise return true. |
|
| 1159 | + * |
|
| 1160 | + * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against |
|
| 1161 | + * @return bool true means can checkin. false means cannot checkin. |
|
| 1162 | + */ |
|
| 1163 | + public function verify_can_checkin_against_TKT_uses($DTT_OR_ID) |
|
| 1164 | + { |
|
| 1165 | + $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID); |
|
| 1166 | + |
|
| 1167 | + if (! $DTT_ID) { |
|
| 1168 | + return false; |
|
| 1169 | + } |
|
| 1170 | + |
|
| 1171 | + $max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF; |
|
| 1172 | + |
|
| 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 | + // or not. |
|
| 1175 | + if (! $max_uses || $max_uses === EE_INF) { |
|
| 1176 | + return true; |
|
| 1177 | + } |
|
| 1178 | + |
|
| 1179 | + //does this datetime have a checkin record? If so, then the dtt count has already been verified so we can just |
|
| 1180 | + //go ahead and toggle. |
|
| 1181 | + if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) { |
|
| 1182 | + return true; |
|
| 1183 | + } |
|
| 1184 | + |
|
| 1185 | + //made it here so the last check is whether the number of checkins per unique datetime on this registration |
|
| 1186 | + //disallows further check-ins. |
|
| 1187 | + $count_unique_dtt_checkins = EEM_Checkin::instance()->count(array( |
|
| 1188 | + array( |
|
| 1189 | + 'REG_ID' => $this->ID(), |
|
| 1190 | + 'CHK_in' => true, |
|
| 1191 | + ), |
|
| 1192 | + ), 'DTT_ID', true); |
|
| 1193 | + // checkins have already reached their max number of uses |
|
| 1194 | + // so registrant can NOT checkin |
|
| 1195 | + if ($count_unique_dtt_checkins >= $max_uses) { |
|
| 1196 | + EE_Error::add_error(__('Check-in denied because number of datetime uses for the ticket has been reached or exceeded.', |
|
| 1197 | + 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 1198 | + return false; |
|
| 1199 | + } |
|
| 1200 | + return true; |
|
| 1201 | + } |
|
| 1202 | + |
|
| 1203 | + |
|
| 1204 | + /** |
|
| 1205 | + * toggle Check-in status for this registration |
|
| 1206 | + * Check-ins are toggled in the following order: |
|
| 1207 | + * never checked in -> checked in |
|
| 1208 | + * checked in -> checked out |
|
| 1209 | + * checked out -> checked in |
|
| 1210 | + * |
|
| 1211 | + * @param int $DTT_ID include specific datetime to toggle Check-in for. |
|
| 1212 | + * If not included or null, then it is assumed latest datetime is being toggled. |
|
| 1213 | + * @param bool $verify If true then can_checkin() is used to verify whether the person |
|
| 1214 | + * can be checked in or not. Otherwise this forces change in checkin status. |
|
| 1215 | + * @return bool|int the chk_in status toggled to OR false if nothing got changed. |
|
| 1216 | + * @throws EE_Error |
|
| 1217 | + */ |
|
| 1218 | + public function toggle_checkin_status($DTT_ID = null, $verify = false) |
|
| 1219 | + { |
|
| 1220 | + if (empty($DTT_ID)) { |
|
| 1221 | + $datetime = $this->get_latest_related_datetime(); |
|
| 1222 | + $DTT_ID = $datetime instanceof EE_Datetime ? $datetime->ID() : 0; |
|
| 1223 | + // verify the registration can checkin for the given DTT_ID |
|
| 1224 | + } elseif (! $this->can_checkin($DTT_ID, $verify)) { |
|
| 1225 | + EE_Error::add_error( |
|
| 1226 | + sprintf( |
|
| 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', |
|
| 1228 | + 'event_espresso'), |
|
| 1229 | + $this->ID(), |
|
| 1230 | + $DTT_ID |
|
| 1231 | + ), |
|
| 1232 | + __FILE__, __FUNCTION__, __LINE__ |
|
| 1233 | + ); |
|
| 1234 | + return false; |
|
| 1235 | + } |
|
| 1236 | + $status_paths = array( |
|
| 1237 | + EE_Registration::checkin_status_never => EE_Registration::checkin_status_in, |
|
| 1238 | + EE_Registration::checkin_status_in => EE_Registration::checkin_status_out, |
|
| 1239 | + EE_Registration::checkin_status_out => EE_Registration::checkin_status_in, |
|
| 1240 | + ); |
|
| 1241 | + //start by getting the current status so we know what status we'll be changing to. |
|
| 1242 | + $cur_status = $this->check_in_status_for_datetime($DTT_ID, null); |
|
| 1243 | + $status_to = $status_paths[$cur_status]; |
|
| 1244 | + // database only records true for checked IN or false for checked OUT |
|
| 1245 | + // no record ( null ) means checked in NEVER, but we obviously don't save that |
|
| 1246 | + $new_status = $status_to === EE_Registration::checkin_status_in ? true : false; |
|
| 1247 | + // add relation - note Check-ins are always creating new rows |
|
| 1248 | + // because we are keeping track of Check-ins over time. |
|
| 1249 | + // Eventually we'll probably want to show a list table |
|
| 1250 | + // for the individual Check-ins so that they can be managed. |
|
| 1251 | + $checkin = EE_Checkin::new_instance(array( |
|
| 1252 | + 'REG_ID' => $this->ID(), |
|
| 1253 | + 'DTT_ID' => $DTT_ID, |
|
| 1254 | + 'CHK_in' => $new_status, |
|
| 1255 | + )); |
|
| 1256 | + // if the record could not be saved then return false |
|
| 1257 | + if ($checkin->save() === 0) { |
|
| 1258 | + if (WP_DEBUG) { |
|
| 1259 | + global $wpdb; |
|
| 1260 | + $error = sprintf( |
|
| 1261 | + __('Registration check in update failed because of the following database error: %1$s%2$s', |
|
| 1262 | + 'event_espresso'), |
|
| 1263 | + '<br />', |
|
| 1264 | + $wpdb->last_error |
|
| 1265 | + ); |
|
| 1266 | + } else { |
|
| 1267 | + $error = __('Registration check in update failed because of an unknown database error', |
|
| 1268 | + 'event_espresso'); |
|
| 1269 | + } |
|
| 1270 | + EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__); |
|
| 1271 | + return false; |
|
| 1272 | + } |
|
| 1273 | + return $status_to; |
|
| 1274 | + } |
|
| 1275 | + |
|
| 1276 | + |
|
| 1277 | + /** |
|
| 1278 | + * Returns the latest datetime related to this registration (via the ticket attached to the registration). |
|
| 1279 | + * "Latest" is defined by the `DTT_EVT_start` column. |
|
| 1280 | + * |
|
| 1281 | + * @return EE_Datetime|null |
|
| 1282 | + * @throws \EE_Error |
|
| 1283 | + */ |
|
| 1284 | + public function get_latest_related_datetime() |
|
| 1285 | + { |
|
| 1286 | + return EEM_Datetime::instance()->get_one( |
|
| 1287 | + array( |
|
| 1288 | + array( |
|
| 1289 | + 'Ticket.Registration.REG_ID' => $this->ID(), |
|
| 1290 | + ), |
|
| 1291 | + 'order_by' => array('DTT_EVT_start' => 'DESC'), |
|
| 1292 | + ) |
|
| 1293 | + ); |
|
| 1294 | + } |
|
| 1295 | + |
|
| 1296 | + |
|
| 1297 | + /** |
|
| 1298 | + * Returns the earliest datetime related to this registration (via the ticket attached to the registration). |
|
| 1299 | + * "Earliest" is defined by the `DTT_EVT_start` column. |
|
| 1300 | + * |
|
| 1301 | + * @throws \EE_Error |
|
| 1302 | + */ |
|
| 1303 | + public function get_earliest_related_datetime() |
|
| 1304 | + { |
|
| 1305 | + return EEM_Datetime::instance()->get_one( |
|
| 1306 | + array( |
|
| 1307 | + array( |
|
| 1308 | + 'Ticket.Registration.REG_ID' => $this->ID(), |
|
| 1309 | + ), |
|
| 1310 | + 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
| 1311 | + ) |
|
| 1312 | + ); |
|
| 1313 | + } |
|
| 1314 | + |
|
| 1315 | + |
|
| 1316 | + /** |
|
| 1317 | + * This method simply returns the check-in status for this registration and the given datetime. |
|
| 1318 | + * If neither the datetime nor the checkin values are provided as arguments, |
|
| 1319 | + * then this will return the LATEST check-in status for the registration across all datetimes it belongs to. |
|
| 1320 | + * |
|
| 1321 | + * @param int $DTT_ID The ID of the datetime we're checking against |
|
| 1322 | + * (if empty we'll get the primary datetime for |
|
| 1323 | + * this registration (via event) and use it's ID); |
|
| 1324 | + * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id. |
|
| 1325 | + * @return int Integer representing Check-in status. |
|
| 1326 | + * @throws \EE_Error |
|
| 1327 | + */ |
|
| 1328 | + public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null) |
|
| 1329 | + { |
|
| 1330 | + $checkin_query_params = array( |
|
| 1331 | + 'order_by' => array('CHK_timestamp' => 'DESC'), |
|
| 1332 | + ); |
|
| 1333 | + |
|
| 1334 | + if ($DTT_ID > 0) { |
|
| 1335 | + $checkin_query_params[0] = array('DTT_ID' => $DTT_ID); |
|
| 1336 | + } |
|
| 1337 | + |
|
| 1338 | + //get checkin object (if exists) |
|
| 1339 | + $checkin = $checkin instanceof EE_Checkin |
|
| 1340 | + ? $checkin |
|
| 1341 | + : $this->get_first_related('Checkin', $checkin_query_params); |
|
| 1342 | + if ($checkin instanceof EE_Checkin) { |
|
| 1343 | + if ($checkin->get('CHK_in')) { |
|
| 1344 | + return EE_Registration::checkin_status_in; //checked in |
|
| 1345 | + } |
|
| 1346 | + return EE_Registration::checkin_status_out; //had checked in but is now checked out. |
|
| 1347 | + } |
|
| 1348 | + return EE_Registration::checkin_status_never; //never been checked in |
|
| 1349 | + } |
|
| 1350 | + |
|
| 1351 | + |
|
| 1352 | + /** |
|
| 1353 | + * This method returns a localized message for the toggled Check-in message. |
|
| 1354 | + * |
|
| 1355 | + * @param int $DTT_ID include specific datetime to get the correct Check-in message. If not included or null, |
|
| 1356 | + * then it is assumed Check-in for primary datetime was toggled. |
|
| 1357 | + * @param bool $error This just flags that you want an error message returned. This is put in so that the error |
|
| 1358 | + * message can be customized with the attendee name. |
|
| 1359 | + * @return string internationalized message |
|
| 1360 | + */ |
|
| 1361 | + public function get_checkin_msg($DTT_ID, $error = false) |
|
| 1362 | + { |
|
| 1363 | + //let's get the attendee first so we can include the name of the attendee |
|
| 1364 | + $attendee = $this->get_first_related('Attendee'); |
|
| 1365 | + if ($attendee instanceof EE_Attendee) { |
|
| 1366 | + if ($error) { |
|
| 1367 | + return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name()); |
|
| 1368 | + } |
|
| 1369 | + $cur_status = $this->check_in_status_for_datetime($DTT_ID); |
|
| 1370 | + //what is the status message going to be? |
|
| 1371 | + switch ($cur_status) { |
|
| 1372 | + case EE_Registration::checkin_status_never : |
|
| 1373 | + return sprintf(__("%s has been removed from Check-in records", "event_espresso"), |
|
| 1374 | + $attendee->full_name()); |
|
| 1375 | + break; |
|
| 1376 | + case EE_Registration::checkin_status_in : |
|
| 1377 | + return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name()); |
|
| 1378 | + break; |
|
| 1379 | + case EE_Registration::checkin_status_out : |
|
| 1380 | + return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name()); |
|
| 1381 | + break; |
|
| 1382 | + } |
|
| 1383 | + } |
|
| 1384 | + return __("The check-in status could not be determined.", "event_espresso"); |
|
| 1385 | + } |
|
| 1386 | + |
|
| 1387 | + |
|
| 1388 | + /** |
|
| 1389 | + * Returns the related EE_Transaction to this registration |
|
| 1390 | + * |
|
| 1391 | + * @return EE_Transaction |
|
| 1392 | + */ |
|
| 1393 | + public function transaction() |
|
| 1394 | + { |
|
| 1395 | + $transaction = $this->get_first_related('Transaction'); |
|
| 1396 | + if (! $transaction instanceof \EE_Transaction) { |
|
| 1397 | + throw new EntityNotFoundException('Transaction ID', $this->transaction_ID()); |
|
| 1398 | + } |
|
| 1399 | + return $transaction; |
|
| 1400 | + } |
|
| 1401 | + |
|
| 1402 | + |
|
| 1403 | + /** |
|
| 1404 | + * get Registration Code |
|
| 1405 | + */ |
|
| 1406 | + public function reg_code() |
|
| 1407 | + { |
|
| 1408 | + return $this->get('REG_code'); |
|
| 1409 | + } |
|
| 1410 | + |
|
| 1411 | + |
|
| 1412 | + /** |
|
| 1413 | + * get Transaction ID |
|
| 1414 | + */ |
|
| 1415 | + public function transaction_ID() |
|
| 1416 | + { |
|
| 1417 | + return $this->get('TXN_ID'); |
|
| 1418 | + } |
|
| 1419 | + |
|
| 1420 | + |
|
| 1421 | + /** |
|
| 1422 | + * @return int |
|
| 1423 | + */ |
|
| 1424 | + public function ticket_ID() |
|
| 1425 | + { |
|
| 1426 | + return $this->get('TKT_ID'); |
|
| 1427 | + } |
|
| 1428 | + |
|
| 1429 | + |
|
| 1430 | + /** |
|
| 1431 | + * Set Registration Code |
|
| 1432 | + * |
|
| 1433 | + * @access public |
|
| 1434 | + * @param string $REG_code Registration Code |
|
| 1435 | + * @param boolean $use_default |
|
| 1436 | + */ |
|
| 1437 | + public function set_reg_code($REG_code, $use_default = false) |
|
| 1438 | + { |
|
| 1439 | + if (empty($REG_code)) { |
|
| 1440 | + EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 1441 | + return; |
|
| 1442 | + } |
|
| 1443 | + if (! $this->reg_code()) { |
|
| 1444 | + parent::set('REG_code', $REG_code, $use_default); |
|
| 1445 | + } else { |
|
| 1446 | + EE_Error::doing_it_wrong( |
|
| 1447 | + __CLASS__ . '::' . __FUNCTION__, |
|
| 1448 | + __('Can not change a registration REG_code once it has been set.', 'event_espresso'), |
|
| 1449 | + '4.6.0' |
|
| 1450 | + ); |
|
| 1451 | + } |
|
| 1452 | + } |
|
| 1453 | + |
|
| 1454 | + |
|
| 1455 | + /** |
|
| 1456 | + * Returns all other registrations in the same group as this registrant who have the same ticket option. |
|
| 1457 | + * Note, if you want to just get all registrations in the same transaction (group), use: |
|
| 1458 | + * $registration->transaction()->registrations(); |
|
| 1459 | + * |
|
| 1460 | + * @since 4.5.0 |
|
| 1461 | + * @return EE_Registration[] or empty array if this isn't a group registration. |
|
| 1462 | + */ |
|
| 1463 | + public function get_all_other_registrations_in_group() |
|
| 1464 | + { |
|
| 1465 | + if ($this->group_size() < 2) { |
|
| 1466 | + return array(); |
|
| 1467 | + } |
|
| 1468 | + |
|
| 1469 | + $query[0] = array( |
|
| 1470 | + 'TXN_ID' => $this->transaction_ID(), |
|
| 1471 | + 'REG_ID' => array('!=', $this->ID()), |
|
| 1472 | + 'TKT_ID' => $this->ticket_ID(), |
|
| 1473 | + ); |
|
| 1474 | + |
|
| 1475 | + $registrations = $this->get_model()->get_all($query); |
|
| 1476 | + return $registrations; |
|
| 1477 | + } |
|
| 1478 | + |
|
| 1479 | + /** |
|
| 1480 | + * Return the link to the admin details for the object. |
|
| 1481 | + * |
|
| 1482 | + * @return string |
|
| 1483 | + */ |
|
| 1484 | + public function get_admin_details_link() |
|
| 1485 | + { |
|
| 1486 | + EE_Registry::instance()->load_helper('URL'); |
|
| 1487 | + return EEH_URL::add_query_args_and_nonce( |
|
| 1488 | + array( |
|
| 1489 | + 'page' => 'espresso_registrations', |
|
| 1490 | + 'action' => 'view_registration', |
|
| 1491 | + '_REG_ID' => $this->ID(), |
|
| 1492 | + ), |
|
| 1493 | + admin_url('admin.php') |
|
| 1494 | + ); |
|
| 1495 | + } |
|
| 1496 | + |
|
| 1497 | + /** |
|
| 1498 | + * Returns the link to the editor for the object. Sometimes this is the same as the details. |
|
| 1499 | + * |
|
| 1500 | + * @return string |
|
| 1501 | + */ |
|
| 1502 | + public function get_admin_edit_link() |
|
| 1503 | + { |
|
| 1504 | + return $this->get_admin_details_link(); |
|
| 1505 | + } |
|
| 1506 | + |
|
| 1507 | + /** |
|
| 1508 | + * Returns the link to a settings page for the object. |
|
| 1509 | + * |
|
| 1510 | + * @return string |
|
| 1511 | + */ |
|
| 1512 | + public function get_admin_settings_link() |
|
| 1513 | + { |
|
| 1514 | + return $this->get_admin_details_link(); |
|
| 1515 | + } |
|
| 1516 | + |
|
| 1517 | + /** |
|
| 1518 | + * Returns the link to the "overview" for the object (typically the "list table" view). |
|
| 1519 | + * |
|
| 1520 | + * @return string |
|
| 1521 | + */ |
|
| 1522 | + public function get_admin_overview_link() |
|
| 1523 | + { |
|
| 1524 | + EE_Registry::instance()->load_helper('URL'); |
|
| 1525 | + return EEH_URL::add_query_args_and_nonce( |
|
| 1526 | + array( |
|
| 1527 | + 'page' => 'espresso_registrations', |
|
| 1528 | + ), |
|
| 1529 | + admin_url('admin.php') |
|
| 1530 | + ); |
|
| 1531 | + } |
|
| 1532 | + |
|
| 1533 | + |
|
| 1534 | + /** |
|
| 1535 | + * @param array $query_params |
|
| 1536 | + * @return \EE_Registration[] |
|
| 1537 | + * @throws \EE_Error |
|
| 1538 | + */ |
|
| 1539 | + public function payments($query_params = array()) |
|
| 1540 | + { |
|
| 1541 | + return $this->get_many_related('Payment', $query_params); |
|
| 1542 | + } |
|
| 1543 | + |
|
| 1544 | + |
|
| 1545 | + /** |
|
| 1546 | + * @param array $query_params |
|
| 1547 | + * @return \EE_Registration_Payment[] |
|
| 1548 | + * @throws \EE_Error |
|
| 1549 | + */ |
|
| 1550 | + public function registration_payments($query_params = array()) |
|
| 1551 | + { |
|
| 1552 | + return $this->get_many_related('Registration_Payment', $query_params); |
|
| 1553 | + } |
|
| 1554 | + |
|
| 1555 | + |
|
| 1556 | + /** |
|
| 1557 | + * This grabs the payment method corresponding to the last payment made for the amount owing on the registration. |
|
| 1558 | + * Note: if there are no payments on the registration there will be no payment method returned. |
|
| 1559 | + * |
|
| 1560 | + * @return EE_Payment_Method|null |
|
| 1561 | + */ |
|
| 1562 | + public function payment_method() |
|
| 1563 | + { |
|
| 1564 | + return EEM_Payment_Method::instance()->get_last_used_for_registration($this); |
|
| 1565 | + } |
|
| 1566 | + |
|
| 1567 | + |
|
| 1568 | + /** |
|
| 1569 | + * @return \EE_Line_Item |
|
| 1570 | + * @throws EntityNotFoundException |
|
| 1571 | + * @throws \EE_Error |
|
| 1572 | + */ |
|
| 1573 | + public function ticket_line_item() |
|
| 1574 | + { |
|
| 1575 | + $ticket = $this->ticket(); |
|
| 1576 | + $transaction = $this->transaction(); |
|
| 1577 | + $line_item = null; |
|
| 1578 | + $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs( |
|
| 1579 | + $transaction->total_line_item(), |
|
| 1580 | + 'Ticket', |
|
| 1581 | + array($ticket->ID()) |
|
| 1582 | + ); |
|
| 1583 | + foreach ($ticket_line_items as $ticket_line_item) { |
|
| 1584 | + if ( |
|
| 1585 | + $ticket_line_item instanceof \EE_Line_Item |
|
| 1586 | + && $ticket_line_item->OBJ_type() === 'Ticket' |
|
| 1587 | + && $ticket_line_item->OBJ_ID() === $ticket->ID() |
|
| 1588 | + ) { |
|
| 1589 | + $line_item = $ticket_line_item; |
|
| 1590 | + break; |
|
| 1591 | + } |
|
| 1592 | + } |
|
| 1593 | + if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) { |
|
| 1594 | + throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID()); |
|
| 1595 | + } |
|
| 1596 | + return $line_item; |
|
| 1597 | + } |
|
| 1598 | + |
|
| 1599 | + |
|
| 1600 | + /** |
|
| 1601 | + * Soft Deletes this model object. |
|
| 1602 | + * |
|
| 1603 | + * @return boolean | int |
|
| 1604 | + * @throws \RuntimeException |
|
| 1605 | + * @throws \EE_Error |
|
| 1606 | + */ |
|
| 1607 | + public function delete() |
|
| 1608 | + { |
|
| 1609 | + if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) { |
|
| 1610 | + $this->set_status(EEM_Registration::status_id_cancelled); |
|
| 1611 | + } |
|
| 1612 | + return parent::delete(); |
|
| 1613 | + } |
|
| 1614 | + |
|
| 1615 | + |
|
| 1616 | + /** |
|
| 1617 | + * Restores whatever the previous status was on a registration before it was trashed (if possible) |
|
| 1618 | + * |
|
| 1619 | + * @throws \EE_Error |
|
| 1620 | + * @throws \RuntimeException |
|
| 1621 | + */ |
|
| 1622 | + public function restore() |
|
| 1623 | + { |
|
| 1624 | + $previous_status = $this->get_extra_meta( |
|
| 1625 | + EE_Registration::PRE_TRASH_REG_STATUS_KEY, |
|
| 1626 | + true, |
|
| 1627 | + EEM_Registration::status_id_cancelled |
|
| 1628 | + ); |
|
| 1629 | + if ($previous_status) { |
|
| 1630 | + $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY); |
|
| 1631 | + $this->set_status($previous_status); |
|
| 1632 | + } |
|
| 1633 | + return parent::restore(); |
|
| 1634 | + } |
|
| 1635 | + |
|
| 1636 | + |
|
| 1637 | + |
|
| 1638 | + /*************************** DEPRECATED ***************************/ |
|
| 1639 | + |
|
| 1640 | + |
|
| 1641 | + /** |
|
| 1642 | + * @deprecated |
|
| 1643 | + * @since 4.7.0 |
|
| 1644 | + * @access public |
|
| 1645 | + */ |
|
| 1646 | + public function price_paid() |
|
| 1647 | + { |
|
| 1648 | + EE_Error::doing_it_wrong('EE_Registration::price_paid()', |
|
| 1649 | + __('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'), |
|
| 1650 | + '4.7.0'); |
|
| 1651 | + return $this->final_price(); |
|
| 1652 | + } |
|
| 1653 | + |
|
| 1654 | + |
|
| 1655 | + /** |
|
| 1656 | + * @deprecated |
|
| 1657 | + * @since 4.7.0 |
|
| 1658 | + * @access public |
|
| 1659 | + * @param float $REG_final_price |
|
| 1660 | + */ |
|
| 1661 | + public function set_price_paid($REG_final_price = 0.00) |
|
| 1662 | + { |
|
| 1663 | + EE_Error::doing_it_wrong('EE_Registration::set_price_paid()', |
|
| 1664 | + __('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'), |
|
| 1665 | + '4.7.0'); |
|
| 1666 | + $this->set_final_price($REG_final_price); |
|
| 1667 | + } |
|
| 1668 | + |
|
| 1669 | + |
|
| 1670 | + /** |
|
| 1671 | + * @deprecated |
|
| 1672 | + * @since 4.7.0 |
|
| 1673 | + * @return string |
|
| 1674 | + */ |
|
| 1675 | + public function pretty_price_paid() |
|
| 1676 | + { |
|
| 1677 | + EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()', |
|
| 1678 | + __('This method is deprecated, please use EE_Registration::pretty_final_price() instead.', |
|
| 1679 | + 'event_espresso'), '4.7.0'); |
|
| 1680 | + return $this->pretty_final_price(); |
|
| 1681 | + } |
|
| 1682 | + |
|
| 1683 | + |
|
| 1684 | + /** |
|
| 1685 | + * Gets the primary datetime related to this registration via the related Event to this registration |
|
| 1686 | + * |
|
| 1687 | + * @deprecated 4.9.17 |
|
| 1688 | + * @return EE_Datetime |
|
| 1689 | + */ |
|
| 1690 | + public function get_related_primary_datetime() |
|
| 1691 | + { |
|
| 1692 | + EE_Error::doing_it_wrong( |
|
| 1693 | + __METHOD__, |
|
| 1694 | + esc_html__( |
|
| 1695 | + 'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()', |
|
| 1696 | + 'event_espresso' |
|
| 1697 | + ), |
|
| 1698 | + '4.9.17', |
|
| 1699 | + '5.0.0' |
|
| 1700 | + ); |
|
| 1701 | + return $this->event()->primary_datetime(); |
|
| 1702 | + } |
|
| 1703 | 1703 | |
| 1704 | 1704 | |
| 1705 | 1705 | } |
@@ -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; |
@@ -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; |
