eventespresso / event-espresso-core

admin_pages/messages/Messages_Admin_Page.core.php

Doc Comments +2 added lines, -2 removed lines

@@ -2640,7 +2640,7 @@ 
      * @param  int  $GRP_ID        The group being deleted
      * @param  bool $include_group whether to delete the Message Template Group as well.
      *
-     * @return bool        boolean to indicate the success of the deletes or not.
+     * @return integer        boolean to indicate the success of the deletes or not.
      */
     private function _delete_mtp_permanently($GRP_ID, $include_group = true)
     {
@@ -2772,7 +2772,7 @@ 
      * This just prepares the content for the message type settings
      *
      * @param  object  $message_type The message type object
-     * @param  object  $messenger    The messenger object
+     * @param  EE_messenger|null  $messenger    The messenger object
      * @param  boolean $active       Whether the message type is active or not
      *
      * @return string                html output for the content

Spacing +119 added lines, -119 removed lines

@@ -87,7 +87,7 @@ 
         $this->_admin_base_url  = EE_MSG_ADMIN_URL;
         $this->_admin_base_path = EE_MSG_ADMIN;
         
-        $this->_activate_state = isset($this->_req_data['activate_state']) ? (array)$this->_req_data['activate_state'] : array();
+        $this->_activate_state = isset($this->_req_data['activate_state']) ? (array) $this->_req_data['activate_state'] : array();
         
         $this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null;
         $this->_load_message_resource_manager();
@@ -219,7 +219,7 @@ 
             array('none_selected' => __('Show All Messengers', 'event_espresso')),
             $messenger_options
         );
-        $input             = new EE_Select_Input(
+        $input = new EE_Select_Input(
             $messenger_options,
             array(
                 'html_name'  => 'ee_messenger_filter_by',
@@ -257,7 +257,7 @@ 
             array('none_selected' => __('Show All Message Types', 'event_espresso')),
             $message_type_options
         );
-        $input                = new EE_Select_Input(
+        $input = new EE_Select_Input(
             $message_type_options,
             array(
                 'html_name'  => 'ee_message_type_filter_by',
@@ -295,7 +295,7 @@ 
             array('none_selected' => __('Show all Contexts', 'event_espresso')),
             $context_options
         );
-        $input           = new EE_Select_Input(
+        $input = new EE_Select_Input(
             $context_options,
             array(
                 'html_name'  => 'ee_context_filter_by',
@@ -676,47 +676,47 @@ 
     
     public function messages_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messages_help_tab.template.php');
     }
     
     
     public function messengers_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messenger_help_tab.template.php');
     }
     
     
     public function message_types_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_message_type_help_tab.template.php');
     }
     
     
     public function messages_overview_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_overview_help_tab.template.php');
     }
     
     
     public function message_templates_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_message_templates_help_tab.template.php');
     }
     
     
     public function edit_message_template_help_tab()
     {
-        $args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="' . esc_attr__('Editor Title',
-                'event_espresso') . '" />';
-        $args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="' . esc_attr__('Context Switcher and Preview',
-                'event_espresso') . '" />';
-        $args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="' . esc_attr__('Message Template Form Fields',
-                'event_espresso') . '" />';
-        $args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="' . esc_attr__('Shortcodes Metabox',
-                'event_espresso') . '" />';
-        $args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="' . esc_attr__('Publish Metabox',
-                'event_espresso') . '" />';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
+        $args['img1'] = '<img src="'.EE_MSG_ASSETS_URL.'images/editor.png'.'" alt="'.esc_attr__('Editor Title',
+                'event_espresso').'" />';
+        $args['img2'] = '<img src="'.EE_MSG_ASSETS_URL.'images/switch-context.png'.'" alt="'.esc_attr__('Context Switcher and Preview',
+                'event_espresso').'" />';
+        $args['img3'] = '<img class="left" src="'.EE_MSG_ASSETS_URL.'images/form-fields.png'.'" alt="'.esc_attr__('Message Template Form Fields',
+                'event_espresso').'" />';
+        $args['img4'] = '<img class="right" src="'.EE_MSG_ASSETS_URL.'images/shortcodes-metabox.png'.'" alt="'.esc_attr__('Shortcodes Metabox',
+                'event_espresso').'" />';
+        $args['img5'] = '<img class="right" src="'.EE_MSG_ASSETS_URL.'images/publish-meta-box.png'.'" alt="'.esc_attr__('Publish Metabox',
+                'event_espresso').'" />';
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messages_templates_editor_help_tab.template.php',
             $args);
     }
     
@@ -725,37 +725,37 @@ 
     {
         $this->_set_shortcodes();
         $args['shortcodes'] = $this->_shortcodes;
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messages_shortcodes_help_tab.template.php',
             $args);
     }
     
     
     public function preview_message_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_preview_help_tab.template.php');
     }
     
     
     public function settings_help_tab()
     {
-        $args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '" alt="' . esc_attr__('Active Email Tab',
-                'event_espresso') . '" />';
-        $args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png' . '" alt="' . esc_attr__('Inactive Email Tab',
-                'event_espresso') . '" />';
+        $args['img1'] = '<img class="inline-text" src="'.EE_MSG_ASSETS_URL.'images/email-tab-active.png'.'" alt="'.esc_attr__('Active Email Tab',
+                'event_espresso').'" />';
+        $args['img2'] = '<img class="inline-text" src="'.EE_MSG_ASSETS_URL.'images/email-tab-inactive.png'.'" alt="'.esc_attr__('Inactive Email Tab',
+                'event_espresso').'" />';
         $args['img3'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked"><label for="ee-on-off-toggle-on"></label>';
         $args['img4'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox"><label for="ee-on-off-toggle-on"></label>';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messages_settings_help_tab.template.php', $args);
     }
     
     
     public function load_scripts_styles()
     {
-        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
+        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL.'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('espresso_ee_msg');
         
-        wp_register_script('ee-messages-settings', EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
+        wp_register_script('ee-messages-settings', EE_MSG_ASSETS_URL.'ee-messages-settings.js',
             array('jquery-ui-droppable', 'ee-serialize-full-array'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-msg-list-table-js', EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
+        wp_register_script('ee-msg-list-table-js', EE_MSG_ASSETS_URL.'ee_message_admin_list_table.js',
             array('ee-dialog'), EVENT_ESPRESSO_VERSION);
     }
     
@@ -787,7 +787,7 @@ 
         
         $this->_set_shortcodes();
         
-        EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
+        EE_Registry::$i18n_js_strings['confirm_default_reset'] = sprintf(
             __('Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
                 'event_espresso'),
             $this->_message_template_group->messenger_obj()->label['singular'],
@@ -796,7 +796,7 @@ 
         EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = __('Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
             'event_espresso');
         
-        wp_register_script('ee_msgs_edit_js', EE_MSG_ASSETS_URL . 'ee_message_editor.js', array('jquery'),
+        wp_register_script('ee_msgs_edit_js', EE_MSG_ASSETS_URL.'ee_message_editor.js', array('jquery'),
             EVENT_ESPRESSO_VERSION);
         
         wp_enqueue_script('ee_admin_js');
@@ -827,7 +827,7 @@ 
     
     public function load_scripts_styles_settings()
     {
-        wp_register_style('ee-message-settings', EE_MSG_ASSETS_URL . 'ee_message_settings.css', array(),
+        wp_register_style('ee-message-settings', EE_MSG_ASSETS_URL.'ee_message_settings.css', array(),
             EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('ee-text-links');
         wp_enqueue_style('ee-message-settings');
@@ -893,7 +893,7 @@ 
             }
             $status_bulk_actions = $common_bulk_actions;
             //unset bulk actions not applying to status
-            if (! empty($status_bulk_actions)) {
+            if ( ! empty($status_bulk_actions)) {
                 switch ($status) {
                     case EEM_Message::status_idle:
                     case EEM_Message::status_resend:
@@ -918,7 +918,7 @@ 
             }
 
             //skip adding messenger executing status to views because it will be included with the Failed view.
-            if ( $status === EEM_Message::status_messenger_executing ) {
+            if ($status === EEM_Message::status_messenger_executing) {
                 continue;
             }
             
@@ -944,7 +944,7 @@ 
         $this->_search_btn_label                   = __('Message Activity', 'event_espresso');
         $this->_template_args['per_column']        = 6;
         $this->_template_args['after_list_table']  = $this->_display_legend($this->_message_legend_items());
-        $this->_template_args['before_list_table'] = '<h3>' . EEM_Message::instance()->get_pretty_label_for_results() . '</h3>';
+        $this->_template_args['before_list_table'] = '<h3>'.EEM_Message::instance()->get_pretty_label_for_results().'</h3>';
         $this->display_admin_list_table_page_with_no_sidebar();
     }
     
@@ -968,37 +968,37 @@ 
         /** @type array $status_items status legend setup */
         $status_items = array(
             'sent_status'       => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_sent,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence')
             ),
             'idle_status'       => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_idle,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence')
             ),
             'failed_status'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_failed,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence')
             ),
             'messenger_executing_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_messenger_executing,
                 'desc' => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence')
             ),
             'resend_status'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_resend,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence')
             ),
             'incomplete_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_incomplete,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence')
             ),
             'retry_status'      => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_retry,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence')
             )
         );
         if (EEM_Message::debug()) {
             $status_items['debug_only_status'] = array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_debug_only,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence')
             );
         }
@@ -1010,10 +1010,10 @@ 
     protected function _custom_mtps_preview()
     {
         $this->_admin_page_title              = __('Custom Message Templates (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png" alt="' . esc_attr__('Preview Custom Message Templates screenshot',
-                'event_espresso') . '" />';
-        $this->_template_args['preview_text'] = '<strong>' . __('Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
-                'event_espresso') . '</strong>';
+        $this->_template_args['preview_img']  = '<img src="'.EE_MSG_ASSETS_URL.'images/custom_mtps_preview.png" alt="'.esc_attr__('Preview Custom Message Templates screenshot',
+                'event_espresso').'" />';
+        $this->_template_args['preview_text'] = '<strong>'.__('Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
+                'event_espresso').'</strong>';
         $this->display_admin_caf_preview_page('custom_message_types', false);
     }
     
@@ -1261,7 +1261,7 @@ 
                             //let's verify if we need this extra field via the shortcodes parameter.
                             $continue = false;
                             if (isset($extra_array['shortcodes_required'])) {
-                                foreach ((array)$extra_array['shortcodes_required'] as $shortcode) {
+                                foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
                                     if ( ! array_key_exists($shortcode, $this->_shortcodes)) {
                                         $continue = true;
                                     }
@@ -1271,9 +1271,9 @@ 
                                 }
                             }
                             
-                            $field_id                                = $reference_field . '-' . $extra_field . '-content';
+                            $field_id                                = $reference_field.'-'.$extra_field.'-content';
                             $template_form_fields[$field_id]         = $extra_array;
-                            $template_form_fields[$field_id]['name'] = 'MTP_template_fields[' . $reference_field . '][content][' . $extra_field . ']';
+                            $template_form_fields[$field_id]['name'] = 'MTP_template_fields['.$reference_field.'][content]['.$extra_field.']';
                             $css_class                               = isset($extra_array['css_class']) ? $extra_array['css_class'] : '';
                             
                             $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
@@ -1283,7 +1283,7 @@ 
                                                                                 is_array($validators[$extra_field])
                                                                                 && isset($validators[$extra_field]['msg'])
                                                                             )
-                                ? 'validate-error ' . $css_class
+                                ? 'validate-error '.$css_class
                                 : $css_class;
                             
                             $template_form_fields[$field_id]['value'] = ! empty($message_templates) && isset($content[$extra_field])
@@ -1311,11 +1311,11 @@ 
                                 
                             }/**/
                         }
-                        $templatefield_MTP_id          = $reference_field . '-MTP_ID';
-                        $templatefield_templatename_id = $reference_field . '-name';
+                        $templatefield_MTP_id          = $reference_field.'-MTP_ID';
+                        $templatefield_templatename_id = $reference_field.'-name';
                         
                         $template_form_fields[$templatefield_MTP_id] = array(
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
+                            'name'       => 'MTP_template_fields['.$reference_field.'][MTP_ID]',
                             'label'      => null,
                             'input'      => 'hidden',
                             'type'       => 'int',
@@ -1328,7 +1328,7 @@ 
                         );
                         
                         $template_form_fields[$templatefield_templatename_id] = array(
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
+                            'name'       => 'MTP_template_fields['.$reference_field.'][name]',
                             'label'      => null,
                             'input'      => 'hidden',
                             'type'       => 'string',
@@ -1342,9 +1342,9 @@ 
                     }
                     continue; //skip the next stuff, we got the necessary fields here for this dataset.
                 } else {
-                    $field_id                                 = $template_field . '-content';
+                    $field_id                                 = $template_field.'-content';
                     $template_form_fields[$field_id]          = $field_setup_array;
-                    $template_form_fields[$field_id]['name']  = 'MTP_template_fields[' . $template_field . '][content]';
+                    $template_form_fields[$field_id]['name']  = 'MTP_template_fields['.$template_field.'][content]';
                     $message_template                         = isset($message_templates[$context][$template_field])
                         ? $message_templates[$context][$template_field]
                         : null;
@@ -1365,7 +1365,7 @@ 
                     $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
                                                                     && in_array($template_field, $v_fields)
                                                                     && isset($validators[$template_field]['msg'])
-                        ? 'validate-error ' . $css_class
+                        ? 'validate-error '.$css_class
                         : $css_class;
                     
                     //shortcode selector
@@ -1376,12 +1376,12 @@ 
                 
                 //k took care of content field(s) now let's take care of others.
                 
-                $templatefield_MTP_id                = $template_field . '-MTP_ID';
-                $templatefield_field_templatename_id = $template_field . '-name';
+                $templatefield_MTP_id                = $template_field.'-MTP_ID';
+                $templatefield_field_templatename_id = $template_field.'-name';
                 
                 //foreach template field there are actually two form fields created
                 $template_form_fields[$templatefield_MTP_id] = array(
-                    'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
+                    'name'       => 'MTP_template_fields['.$template_field.'][MTP_ID]',
                     'label'      => null,
                     'input'      => 'hidden',
                     'type'       => 'int',
@@ -1394,7 +1394,7 @@ 
                 );
                 
                 $template_form_fields[$templatefield_field_templatename_id] = array(
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
+                    'name'       => 'MTP_template_fields['.$template_field.'][name]',
                     'label'      => null,
                     'input'      => 'hidden',
                     'type'       => 'string',
@@ -1512,7 +1512,7 @@ 
                 'format'     => '%d',
                 'db-col'     => 'MTP_deleted'
             );
-            $sidebar_form_fields['ee-msg-author']  = array(
+            $sidebar_form_fields['ee-msg-author'] = array(
                 'name'       => 'MTP_user_id',
                 'label'      => __('Author', 'event_espresso'),
                 'input'      => 'hidden',
@@ -1531,17 +1531,17 @@ 
                 'value' => $action
             );
             
-            $sidebar_form_fields['ee-msg-id']        = array(
+            $sidebar_form_fields['ee-msg-id'] = array(
                 'name'  => 'id',
                 'input' => 'hidden',
                 'type'  => 'int',
                 'value' => $GRP_ID
             );
             $sidebar_form_fields['ee-msg-evt-nonce'] = array(
-                'name'  => $action . '_nonce',
+                'name'  => $action.'_nonce',
                 'input' => 'hidden',
                 'type'  => 'string',
-                'value' => wp_create_nonce($action . '_nonce')
+                'value' => wp_create_nonce($action.'_nonce')
             );
             
             if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
@@ -1573,7 +1573,7 @@ 
         );
         
         //add preview button
-        $preview_url    = parent::add_query_args_and_nonce(
+        $preview_url = parent::add_query_args_and_nonce(
             array(
                 'message_type' => $message_template_group->message_type(),
                 'messenger'    => $message_template_group->messenger(),
@@ -1583,8 +1583,8 @@ 
             ),
             $this->_admin_base_url
         );
-        $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">' . __('Preview',
-                'event_espresso') . '</a>';
+        $preview_button = '<a href="'.$preview_url.'" class="button-secondary messages-preview-button">'.__('Preview',
+                'event_espresso').'</a>';
         
         
         //setup context switcher
@@ -1612,8 +1612,8 @@ 
         $this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
         
         $this->_template_path = $this->_template_args['GRP_ID']
-            ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
-            : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
+            ? EE_MSG_TEMPLATE_PATH.'ee_msg_details_main_edit_meta_box.template.php'
+            : EE_MSG_TEMPLATE_PATH.'ee_msg_details_main_add_meta_box.template.php';
         
         //send along EE_Message_Template_Group object for further template use.
         $this->_template_args['MTP'] = $message_template_group;
@@ -1648,7 +1648,7 @@ 
     
     public function _add_form_element_before()
     {
-        return '<form method="post" action="' . $this->_template_args["edit_message_template_form_url"] . '" id="ee-msg-edit-frm">';
+        return '<form method="post" action="'.$this->_template_args["edit_message_template_form_url"].'" id="ee-msg-edit-frm">';
     }
     
     public function _add_form_element_after()
@@ -1843,14 +1843,14 @@ 
         }
         
         //let's add a button to go back to the edit view
-        $query_args             = array(
+        $query_args = array(
             'id'      => $this->_req_data['GRP_ID'],
             'context' => $this->_req_data['context'],
             'action'  => 'edit_message_template'
         );
         $go_back_url            = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-        $preview_button         = '<a href="' . $go_back_url . '" class="button-secondary messages-preview-go-back-button">' . __('Go Back to Edit',
-                'event_espresso') . '</a>';
+        $preview_button         = '<a href="'.$go_back_url.'" class="button-secondary messages-preview-go-back-button">'.__('Go Back to Edit',
+                'event_espresso').'</a>';
         $message_types          = $this->get_installed_message_types();
         $active_messenger       = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
         $active_messenger_label = $active_messenger instanceof EE_messenger
@@ -1864,7 +1864,7 @@ 
         );
         //setup display of preview.
         $this->_admin_page_title                    = $preview_title;
-        $this->_template_args['admin_page_content'] = $preview_button . '<br />' . stripslashes($preview);
+        $this->_template_args['admin_page_content'] = $preview_button.'<br />'.stripslashes($preview);
         $this->_template_args['data']['force_json'] = true;
         
         return '';
@@ -1946,7 +1946,7 @@ 
         }
         
         //setup variation select values for the currently selected template.
-        $variations               = $this->_message_template_group->get_template_pack()->get_variations(
+        $variations = $this->_message_template_group->get_template_pack()->get_variations(
             $this->_message_template_group->messenger(),
             $this->_message_template_group->message_type()
         );
@@ -1960,12 +1960,12 @@ 
         
         $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
         
-        $template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
+        $template_args['template_packs_selector'] = EEH_Form_Fields::select_input(
             'MTP_template_pack',
             $tp_select_values,
             $this->_message_template_group->get_template_pack_name()
         );
-        $template_args['variations_selector']            = EEH_Form_Fields::select_input(
+        $template_args['variations_selector'] = EEH_Form_Fields::select_input(
             'MTP_template_variation',
             $variations_select_values,
             $this->_message_template_group->get_template_pack_variation()
@@ -1975,7 +1975,7 @@ 
         $template_args['template_pack_description']      = $template_pack_labels->template_pack_description;
         $template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
         
-        $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
+        $template = EE_MSG_TEMPLATE_PATH.'template_pack_and_variations_metabox.template.php';
         
         EEH_Template::display_template($template, $template_args);
     }
@@ -2004,7 +2004,7 @@ 
         if ( ! empty($fields)) {
             //yup there be fields
             foreach ($fields as $field => $config) {
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
+                $field_id = $this->_message_template_group->messenger().'_'.$field;
                 $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
                 $default  = isset($config['default']) ? $config['default'] : '';
                 $default  = isset($config['value']) ? $config['value'] : $default;
@@ -2019,7 +2019,7 @@ 
                     : $fix;
                 
                 $template_form_fields[$field_id] = array(
-                    'name'       => 'test_settings_fld[' . $field . ']',
+                    'name'       => 'test_settings_fld['.$field.']',
                     'label'      => $config['label'],
                     'input'      => $config['input'],
                     'type'       => $config['type'],
@@ -2049,7 +2049,7 @@ 
         }
         
         //and button
-        $test_settings_html .= '<p>' . __('Need to reset this message type and start over?', 'event_espresso') . '</p>';
+        $test_settings_html .= '<p>'.__('Need to reset this message type and start over?', 'event_espresso').'</p>';
         $test_settings_html .= '<div class="publishing-action alignright resetbutton">';
         $test_settings_html .= $this->get_action_link_or_button(
             'reset_to_default',
@@ -2080,7 +2080,7 @@ 
             'linked_input_id' => $linked_input_id
         );
         
-        return EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
+        return EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'shortcode_selector_skeleton.template.php',
             $template_args, true);
     }
     
@@ -2098,7 +2098,7 @@ 
         //$messenger = $this->_message_template_group->messenger_obj();
         //now let's set the content depending on the status of the shortcodes array
         if (empty($shortcodes)) {
-            $content = '<p>' . __('There are no valid shortcodes available', 'event_espresso') . '</p>';
+            $content = '<p>'.__('There are no valid shortcodes available', 'event_espresso').'</p>';
             echo $content;
         } else {
             //$alt = 0;
@@ -2215,7 +2215,7 @@ 
                     <?php
                 }
                 //setup nonce_url
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
+                wp_nonce_field($args['action'].'_nonce', $args['action'].'_nonce', false);
                 ?>
                 <select name="context">
                     <?php
@@ -2313,7 +2313,7 @@ 
             : '';
         $context      = ucwords(str_replace('_', ' ', $context_slug));
         
-        $item_desc = $messenger_label && $message_type_label ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' ' : '';
+        $item_desc = $messenger_label && $message_type_label ? $messenger_label.' '.$message_type_label.' '.$context.' ' : '';
         $item_desc .= 'Message Template';
         $query_args  = array();
         $edit_array  = array();
@@ -2682,8 +2682,8 @@ 
      */
     protected function _learn_more_about_message_templates_link()
     {
-        return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >' . __('learn more about how message templates works',
-            'event_espresso') . '</a>';
+        return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >'.__('learn more about how message templates works',
+            'event_espresso').'</a>';
     }
     
     
@@ -2759,10 +2759,10 @@ 
                 
                 $this->_m_mt_settings['message_type_tabs'][$messenger->name][$a_or_i][$message_type->name] = array(
                     'label'    => ucwords($message_type->label['singular']),
-                    'class'    => 'message-type-' . $a_or_i,
-                    'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
-                    'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
-                    'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
+                    'class'    => 'message-type-'.$a_or_i,
+                    'slug_id'  => $message_type->name.'-messagetype-'.$messenger->name,
+                    'mt_nonce' => wp_create_nonce($message_type->name.'_nonce'),
+                    'href'     => 'espresso_'.$message_type->name.'_message_type_settings',
                     'title'    => $a_or_i == 'active'
                         ? __('Drag this message type to the Inactive window to deactivate', 'event_espresso')
                         : __('Drag this message type to the messenger to activate', 'event_espresso'),
@@ -2798,9 +2798,9 @@ 
             $existing_settings = $message_type->get_existing_admin_settings($messenger->name);
             
             foreach ($fields as $fldname => $fldprops) {
-                $field_id                       = $messenger->name . '-' . $message_type->name . '-' . $fldname;
+                $field_id                       = $messenger->name.'-'.$message_type->name.'-'.$fldname;
                 $template_form_field[$field_id] = array(
-                    'name'       => 'message_type_settings[' . $fldname . ']',
+                    'name'       => 'message_type_settings['.$fldname.']',
                     'label'      => $fldprops['label'],
                     'input'      => $fldprops['field_type'],
                     'type'       => $fldprops['value_type'],
@@ -2841,7 +2841,7 @@ 
         $settings_template_args['show_form']     = empty($settings_template_args['template_form_fields']) ? ' hidden' : '';
         
         
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
+        $template = EE_MSG_TEMPLATE_PATH.'ee_msg_mt_settings_content.template.php';
         $content  = EEH_Template::display_template($template, $settings_template_args, true);
         
         return $content;
@@ -2871,11 +2871,11 @@ 
                 $active_mt_tabs                         = isset($this->_m_mt_settings['message_type_tabs'][$messenger]['active'])
                     ? $this->_m_mt_settings['message_type_tabs'][$messenger]['active']
                     : '';
-                $m_boxes[$messenger . '_a_box']         = sprintf(
+                $m_boxes[$messenger.'_a_box']         = sprintf(
                     __('%s Settings', 'event_espresso'),
                     $tab_array['label']
                 );
-                $m_template_args[$messenger . '_a_box'] = array(
+                $m_template_args[$messenger.'_a_box'] = array(
                     'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
                     'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
                         ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
@@ -2889,8 +2889,8 @@ 
                 // message type meta boxes
                 // (which is really just the inactive container for each messenger
                 // showing inactive message types for that messenger)
-                $mt_boxes[$messenger . '_i_box']         = __('Inactive Message Types', 'event_espresso');
-                $mt_template_args[$messenger . '_i_box'] = array(
+                $mt_boxes[$messenger.'_i_box']         = __('Inactive Message Types', 'event_espresso');
+                $mt_template_args[$messenger.'_i_box'] = array(
                     'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
                     'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
                         ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
@@ -2906,14 +2906,14 @@ 
         
         
         //register messenger metaboxes
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
+        $m_template_path = EE_MSG_TEMPLATE_PATH.'ee_msg_details_messenger_mt_meta_box.template.php';
         foreach ($m_boxes as $box => $label) {
             $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[$box]);
             $msgr          = str_replace('_a_box', '', $box);
             add_meta_box(
-                'espresso_' . $msgr . '_settings',
+                'espresso_'.$msgr.'_settings',
                 $label,
-                function ($post, $metabox) {
+                function($post, $metabox) {
                     echo EEH_Template::display_template($metabox["args"]["template_path"],
                         $metabox["args"]["template_args"], true);
                 },
@@ -2925,17 +2925,17 @@ 
         }
         
         //register message type metaboxes
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
+        $mt_template_path = EE_MSG_TEMPLATE_PATH.'ee_msg_details_messenger_meta_box.template.php';
         foreach ($mt_boxes as $box => $label) {
             $callback_args = array(
                 'template_path' => $mt_template_path,
                 'template_args' => $mt_template_args[$box]
             );
-            $mt            = str_replace('_i_box', '', $box);
+            $mt = str_replace('_i_box', '', $box);
             add_meta_box(
-                'espresso_' . $mt . '_inactive_mts',
+                'espresso_'.$mt.'_inactive_mts',
                 $label,
-                function ($post, $metabox) {
+                function($post, $metabox) {
                     echo EEH_Template::display_template($metabox["args"]["template_path"],
                         $metabox["args"]["template_args"], true);
                 },
@@ -3037,7 +3037,7 @@ 
             if ($form->is_valid()) {
                 $valid_data = $form->valid_data();
                 foreach ($valid_data as $property => $value) {
-                    $setter = 'set_' . $property;
+                    $setter = 'set_'.$property;
                     if (method_exists($network_config, $setter)) {
                         $network_config->{$setter}($value);
                     } else if (
@@ -3066,8 +3066,8 @@ 
      */
     protected function _get_mt_tabs($tab_array)
     {
-        $tab_array = (array)$tab_array;
-        $template  = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
+        $tab_array = (array) $tab_array;
+        $template  = EE_MSG_TEMPLATE_PATH.'ee_msg_details_mt_settings_tab_item.template.php';
         $tabs      = '';
         
         foreach ($tab_array as $tab) {
@@ -3100,9 +3100,9 @@ 
             $existing_settings = $messenger->get_existing_admin_settings();
             
             foreach ($fields as $fldname => $fldprops) {
-                $field_id                       = $messenger->name . '-' . $fldname;
+                $field_id                       = $messenger->name.'-'.$fldname;
                 $template_form_field[$field_id] = array(
-                    'name'       => 'messenger_settings[' . $field_id . ']',
+                    'name'       => 'messenger_settings['.$field_id.']',
                     'label'      => $fldprops['label'],
                     'input'      => $fldprops['field_type'],
                     'type'       => $fldprops['value_type'],
@@ -3137,7 +3137,7 @@ 
         //make sure any active message types that are existing are included in the hidden fields
         if (isset($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'])) {
             foreach ($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'] as $mt => $values) {
-                $settings_template_args['hidden_fields']['messenger_settings[message_types][' . $mt . ']'] = array(
+                $settings_template_args['hidden_fields']['messenger_settings[message_types]['.$mt.']'] = array(
                     'type'  => 'hidden',
                     'value' => $mt
                 );
@@ -3147,7 +3147,7 @@ 
             $settings_template_args['hidden_fields'],
             'array'
         );
-        $active                                  = $this->_message_resource_manager->is_messenger_active($messenger->name);
+        $active = $this->_message_resource_manager->is_messenger_active($messenger->name);
         
         $settings_template_args['messenger']           = $messenger->name;
         $settings_template_args['description']         = $messenger->description;
@@ -3164,9 +3164,9 @@ 
         
         
         $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
-        $settings_template_args['nonce']         = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
+        $settings_template_args['nonce']         = wp_create_nonce('activate_'.$messenger->name.'_toggle_nonce');
         $settings_template_args['on_off_status'] = $active ? true : false;
-        $template                                = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
+        $template                                = EE_MSG_TEMPLATE_PATH.'ee_msg_m_settings_content.template.php';
         $content                                 = EEH_Template::display_template($template, $settings_template_args,
             true);
         
@@ -3194,7 +3194,7 @@ 
         
         //do a nonce check here since we're not arriving via a normal route
         $nonce     = isset($this->_req_data['activate_nonce']) ? sanitize_text_field($this->_req_data['activate_nonce']) : '';
-        $nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
+        $nonce_ref = 'activate_'.$this->_req_data['messenger'].'_toggle_nonce';
         
         $this->_verify_nonce($nonce, $nonce_ref);
         
@@ -3296,7 +3296,7 @@ 
         
         //do a nonce check here since we're not arriving via a normal route
         $nonce     = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
-        $nonce_ref = $this->_req_data['message_type'] . '_nonce';
+        $nonce_ref = $this->_req_data['message_type'].'_nonce';
         
         $this->_verify_nonce($nonce, $nonce_ref);
         

Indentation +3643 added lines, -3643 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -17,2213 +17,2213 @@ 
 class Messages_Admin_Page extends EE_Admin_Page
 {
     
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
-    
-    /**
-     * @type string $_active_message_type_name
-     */
-    protected $_active_message_type_name = '';
-    
-    /**
-     * @type EE_messenger $_active_messenger
-     */
-    protected $_active_messenger;
-    protected $_activate_state;
-    protected $_activate_meta_box_type;
-    protected $_current_message_meta_box;
-    protected $_current_message_meta_box_object;
-    protected $_context_switcher;
-    protected $_shortcodes = array();
-    protected $_active_messengers = array();
-    protected $_active_message_types = array();
-    
-    /**
-     * @var EE_Message_Template_Group $_message_template_group
-     */
-    protected $_message_template_group;
-    protected $_m_mt_settings = array();
-    
-    
-    /**
-     * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
-     * IF there is no group then it gets automatically set to the Default template pack.
-     *
-     * @since 4.5.0
-     *
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_template_pack;
-    
-    
-    /**
-     * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
-     * group is.  If there is no group then it automatically gets set to default.
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    protected $_variation;
-    
-    
-    /**
-     * @param bool $routing
-     */
-    public function __construct($routing = true)
-    {
-        //make sure messages autoloader is running
-        EED_Messages::set_autoloaders();
-        parent::__construct($routing);
-    }
-    
-    
-    protected function _init_page_props()
-    {
-        $this->page_slug        = EE_MSG_PG_SLUG;
-        $this->page_label       = __('Messages Settings', 'event_espresso');
-        $this->_admin_base_url  = EE_MSG_ADMIN_URL;
-        $this->_admin_base_path = EE_MSG_ADMIN;
-        
-        $this->_activate_state = isset($this->_req_data['activate_state']) ? (array)$this->_req_data['activate_state'] : array();
-        
-        $this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null;
-        $this->_load_message_resource_manager();
-    }
-    
-    
-    /**
-     * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
-     *
-     *
-     * @throws EE_Error
-     */
-    protected function _load_message_resource_manager()
-    {
-        $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-    }
-    
-    
-    /**
-     * @deprecated 4.9.9.rc.014
-     * @return array
-     */
-    public function get_messengers_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
+    
+	/**
+	 * @type string $_active_message_type_name
+	 */
+	protected $_active_message_type_name = '';
+    
+	/**
+	 * @type EE_messenger $_active_messenger
+	 */
+	protected $_active_messenger;
+	protected $_activate_state;
+	protected $_activate_meta_box_type;
+	protected $_current_message_meta_box;
+	protected $_current_message_meta_box_object;
+	protected $_context_switcher;
+	protected $_shortcodes = array();
+	protected $_active_messengers = array();
+	protected $_active_message_types = array();
+    
+	/**
+	 * @var EE_Message_Template_Group $_message_template_group
+	 */
+	protected $_message_template_group;
+	protected $_m_mt_settings = array();
+    
+    
+	/**
+	 * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
+	 * IF there is no group then it gets automatically set to the Default template pack.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_template_pack;
+    
+    
+	/**
+	 * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
+	 * group is.  If there is no group then it automatically gets set to default.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_variation;
+    
+    
+	/**
+	 * @param bool $routing
+	 */
+	public function __construct($routing = true)
+	{
+		//make sure messages autoloader is running
+		EED_Messages::set_autoloaders();
+		parent::__construct($routing);
+	}
+    
+    
+	protected function _init_page_props()
+	{
+		$this->page_slug        = EE_MSG_PG_SLUG;
+		$this->page_label       = __('Messages Settings', 'event_espresso');
+		$this->_admin_base_url  = EE_MSG_ADMIN_URL;
+		$this->_admin_base_path = EE_MSG_ADMIN;
+        
+		$this->_activate_state = isset($this->_req_data['activate_state']) ? (array)$this->_req_data['activate_state'] : array();
+        
+		$this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null;
+		$this->_load_message_resource_manager();
+	}
+    
+    
+	/**
+	 * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
+	 *
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _load_message_resource_manager()
+	{
+		$this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	}
+    
+    
+	/**
+	 * @deprecated 4.9.9.rc.014
+	 * @return array
+	 */
+	public function get_messengers_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
 			values for use in creating a messenger filter dropdown which is now generated differently via
 			 Messages_Admin_Page::get_messengers_select_input', 'event_espresso'),
-            '4.9.9.rc.014'
-        );
-        
-        $m_values          = array();
-        $active_messengers = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
-        //setup messengers for selects
-        $i = 1;
-        foreach ($active_messengers as $active_messenger) {
-            if ($active_messenger instanceof EE_Message) {
-                $m_values[$i]['id']   = $active_messenger->messenger();
-                $m_values[$i]['text'] = ucwords($active_messenger->messenger_label());
-                $i++;
-            }
-        }
-        
-        return $m_values;
-    }
-    
-    
-    /**
-     * @deprecated 4.9.9.rc.014
-     * @return array
-     */
-    public function get_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
+			'4.9.9.rc.014'
+		);
+        
+		$m_values          = array();
+		$active_messengers = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
+		//setup messengers for selects
+		$i = 1;
+		foreach ($active_messengers as $active_messenger) {
+			if ($active_messenger instanceof EE_Message) {
+				$m_values[$i]['id']   = $active_messenger->messenger();
+				$m_values[$i]['text'] = ucwords($active_messenger->messenger_label());
+				$i++;
+			}
+		}
+        
+		return $m_values;
+	}
+    
+    
+	/**
+	 * @deprecated 4.9.9.rc.014
+	 * @return array
+	 */
+	public function get_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
 			values for use in creating a message type filter dropdown which is now generated differently via
 			 Messages_Admin_Page::get_message_types_select_input', 'event_espresso'),
-            '4.9.9.rc.014'
-        );
-        
-        $mt_values       = array();
-        $active_messages = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
-        $i               = 1;
-        foreach ($active_messages as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $mt_values[$i]['id']   = $active_message->message_type();
-                $mt_values[$i]['text'] = ucwords($active_message->message_type_label());
-                $i++;
-            }
-        }
-        
-        return $mt_values;
-    }
-    
-    
-    /**
-     * @deprecated 4.9.9.rc.014
-     * @return array
-     */
-    public function get_contexts_for_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
+			'4.9.9.rc.014'
+		);
+        
+		$mt_values       = array();
+		$active_messages = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
+		$i               = 1;
+		foreach ($active_messages as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$mt_values[$i]['id']   = $active_message->message_type();
+				$mt_values[$i]['text'] = ucwords($active_message->message_type_label());
+				$i++;
+			}
+		}
+        
+		return $mt_values;
+	}
+    
+    
+	/**
+	 * @deprecated 4.9.9.rc.014
+	 * @return array
+	 */
+	public function get_contexts_for_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
 			values for use in creating a message type context filter dropdown which is now generated differently via
 			 Messages_Admin_Page::get_contexts_for_message_types_select_input', 'event_espresso'),
-            '4.9.9.rc.014'
-        );
-        
-        $contexts                = array();
-        $active_message_contexts = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
-        foreach ($active_message_contexts as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type = $active_message->message_type_object();
-                if ($message_type instanceof EE_message_type) {
-                    $message_type_contexts = $message_type->get_contexts();
-                    foreach ($message_type_contexts as $context => $context_details) {
-                        $contexts[$context] = $context_details['label'];
-                    }
-                }
-            }
-        }
-        
-        return $contexts;
-    }
-    
-    
-    /**
-     * Generate select input with provided messenger options array.
-     *
-     * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
-     *                                 labels.
-     *
-     * @return string
-     */
-    public function get_messengers_select_input($messenger_options)
-    {
-        //if empty or just one value then just return an empty string
-        if (empty($messenger_options)
-            || ! is_array($messenger_options)
-            || count($messenger_options) === 1
-        ) {
-            return '';
-        }
-        //merge in default
-        $messenger_options = array_merge(
-            array('none_selected' => __('Show All Messengers', 'event_espresso')),
-            $messenger_options
-        );
-        $input             = new EE_Select_Input(
-            $messenger_options,
-            array(
-                'html_name'  => 'ee_messenger_filter_by',
-                'html_id'    => 'ee_messenger_filter_by',
-                'html_class' => 'wide',
-                'default'    => isset($this->_req_data['ee_messenger_filter_by'])
-                    ? sanitize_title($this->_req_data['ee_messenger_filter_by'])
-                    : 'none_selected'
-            )
-        );
-        
-        return $input->get_html_for_input();
-    }
-    
-    
-    /**
-     * Generate select input with provided message type options array.
-     *
-     * @param array $message_type_options Array of message types indexed by message type slug, and values are the
-     *                                    message type labels
-     *
-     * @return string
-     */
-    public function get_message_types_select_input($message_type_options)
-    {
-        //if empty or count of options is 1 then just return an empty string
-        if (empty($message_type_options)
-            || ! is_array($message_type_options)
-            || count($message_type_options) === 1
-        ) {
-            return '';
-        }
-        //merge in default
-        $message_type_options = array_merge(
-            array('none_selected' => __('Show All Message Types', 'event_espresso')),
-            $message_type_options
-        );
-        $input                = new EE_Select_Input(
-            $message_type_options,
-            array(
-                'html_name'  => 'ee_message_type_filter_by',
-                'html_id'    => 'ee_message_type_filter_by',
-                'html_class' => 'wide',
-                'default'    => isset($this->_req_data['ee_message_type_filter_by'])
-                    ? sanitize_title($this->_req_data['ee_message_type_filter_by'])
-                    : 'none_selected',
-            )
-        );
-        
-        return $input->get_html_for_input();
-    }
-    
-    
-    /**
-     * Generate select input with provide message type contexts array.
-     *
-     * @param array $context_options Array of message type contexts indexed by context slug, and values are the
-     *                               context label.
-     *
-     * @return string
-     */
-    public function get_contexts_for_message_types_select_input($context_options)
-    {
-        //if empty or count of options is one then just return empty string
-        if (empty($context_options)
-            || ! is_array($context_options)
-            || count($context_options) === 1
-        ) {
-            return '';
-        }
-        //merge in default
-        $context_options = array_merge(
-            array('none_selected' => __('Show all Contexts', 'event_espresso')),
-            $context_options
-        );
-        $input           = new EE_Select_Input(
-            $context_options,
-            array(
-                'html_name'  => 'ee_context_filter_by',
-                'html_id'    => 'ee_context_filter_by',
-                'html_class' => 'wide',
-                'default'    => isset($this->_req_data['ee_context_filter_by'])
-                    ? sanitize_title($this->_req_data['ee_context_filter_by'])
-                    : 'none_selected',
-            )
-        );
-        
-        return $input->get_html_for_input();
-    }
-    
-    
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_activate_messenger', array($this, 'activate_messenger_toggle'));
-        add_action('wp_ajax_activate_mt', array($this, 'activate_mt_toggle'));
-        add_action('wp_ajax_ee_msgs_save_settings', array($this, 'save_settings'));
-        add_action('wp_ajax_ee_msgs_update_mt_form', array($this, 'update_mt_form'));
-        add_action('wp_ajax_switch_template_pack', array($this, 'switch_template_pack'));
-    }
-    
-    
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = array(
-            'buttons'    => array(
-                'add'    => __('Add New Message Template', 'event_espresso'),
-                'edit'   => __('Edit Message Template', 'event_espresso'),
-                'delete' => __('Delete Message Template', 'event_espresso')
-            ),
-            'publishbox' => __('Update Actions', 'event_espresso')
-        );
-    }
-    
-    
-    /**
-     *        an array for storing key => value pairs of request actions and their corresponding methods
-     * @access protected
-     * @return void
-     */
-    protected function _set_page_routes()
-    {
-        $grp_id = ! empty($this->_req_data['GRP_ID']) && ! is_array($this->_req_data['GRP_ID'])
-            ? $this->_req_data['GRP_ID']
-            : 0;
-        $grp_id = empty($grp_id) && ! empty($this->_req_data['id'])
-            ? $this->_req_data['id']
-            : $grp_id;
-        $msg_id = ! empty($this->_req_data['MSG_ID']) && ! is_array($this->_req_data['MSG_ID'])
-            ? $this->_req_data['MSG_ID']
-            : 0;
-        
-        $this->_page_routes = array(
-            'default'                          => array(
-                'func'       => '_message_queue_list_table',
-                'capability' => 'ee_read_global_messages'
-            ),
-            'global_mtps'                      => array(
-                'func'       => '_ee_default_messages_overview_list_table',
-                'capability' => 'ee_read_global_messages'
-            ),
-            'custom_mtps'                      => array(
-                'func'       => '_custom_mtps_preview',
-                'capability' => 'ee_read_messages'
-            ),
-            'add_new_message_template'         => array(
-                'func'       => '_add_message_template',
-                'capability' => 'ee_edit_messages',
-                'noheader'   => true
-            ),
-            'edit_message_template'            => array(
-                'func'       => '_edit_message_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $grp_id
-            ),
-            'preview_message'                  => array(
-                'func'               => '_preview_message',
-                'capability'         => 'ee_read_message',
-                'obj_id'             => $grp_id,
-                'noheader'           => true,
-                'headers_sent_route' => 'display_preview_message'
-            ),
-            'display_preview_message'          => array(
-                'func'       => '_display_preview_message',
-                'capability' => 'ee_read_message',
-                'obj_id'     => $grp_id
-            ),
-            'insert_message_template'          => array(
-                'func'       => '_insert_or_update_message_template',
-                'capability' => 'ee_edit_messages',
-                'args'       => array('new_template' => true),
-                'noheader'   => true
-            ),
-            'update_message_template'          => array(
-                'func'       => '_insert_or_update_message_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('new_template' => false),
-                'noheader'   => true
-            ),
-            'trash_message_template'           => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => true, 'all' => true),
-                'noheader'   => true
-            ),
-            'trash_message_template_context'   => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => true),
-                'noheader'   => true
-            ),
-            'restore_message_template'         => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => false, 'all' => true),
-                'noheader'   => true
-            ),
-            'restore_message_template_context' => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => false),
-                'noheader'   => true
-            ),
-            'delete_message_template'          => array(
-                'func'       => '_delete_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'noheader'   => true
-            ),
-            'reset_to_default'                 => array(
-                'func'       => '_reset_to_default_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $grp_id,
-                'noheader'   => true
-            ),
-            'settings'                         => array(
-                'func'       => '_settings',
-                'capability' => 'manage_options'
-            ),
-            'update_global_settings'           => array(
-                'func'       => '_update_global_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true
-            ),
-            'generate_now'                     => array(
-                'func'       => '_generate_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true
-            ),
-            'generate_and_send_now'            => array(
-                'func'       => '_generate_and_send_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true
-            ),
-            'queue_for_resending'              => array(
-                'func'       => '_queue_for_resending',
-                'capability' => 'ee_send_message',
-                'noheader'   => true
-            ),
-            'send_now'                         => array(
-                'func'       => '_send_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true
-            ),
-            'delete_ee_message'                => array(
-                'func'       => '_delete_ee_messages',
-                'capability' => 'ee_delete_message',
-                'noheader'   => true
-            ),
-            'delete_ee_messages'               => array(
-                'func'       => '_delete_ee_messages',
-                'capability' => 'ee_delete_messages',
-                'noheader'   => true,
-                'obj_id'     => $msg_id
-            )
-        );
-    }
-    
-    
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'                  => array(
-                'nav'           => array(
-                    'label' => __('Message Activity', 'event_espresso'),
-                    'order' => 10
-                ),
-                'list_table'    => 'EE_Message_List_Table',
-                // 'qtips' => array( 'EE_Message_List_Table_Tips' ),
-                'require_nonce' => false
-            ),
-            'global_mtps'              => array(
-                'nav'           => array(
-                    'label' => __('Default Message Templates', 'event_espresso'),
-                    'order' => 20
-                ),
-                'list_table'    => 'Messages_Template_List_Table',
-                'help_tabs'     => array(
-                    'messages_overview_help_tab'                                => array(
-                        'title'    => __('Messages Overview', 'event_espresso'),
-                        'filename' => 'messages_overview'
-                    ),
-                    'messages_overview_messages_table_column_headings_help_tab' => array(
-                        'title'    => __('Messages Table Column Headings', 'event_espresso'),
-                        'filename' => 'messages_overview_table_column_headings'
-                    ),
-                    'messages_overview_messages_filters_help_tab'               => array(
-                        'title'    => __('Message Filters', 'event_espresso'),
-                        'filename' => 'messages_overview_filters'
-                    ),
-                    'messages_overview_messages_views_help_tab'                 => array(
-                        'title'    => __('Message Views', 'event_espresso'),
-                        'filename' => 'messages_overview_views'
-                    ),
-                    'message_overview_message_types_help_tab'                   => array(
-                        'title'    => __('Message Types', 'event_espresso'),
-                        'filename' => 'messages_overview_types'
-                    ),
-                    'messages_overview_messengers_help_tab'                     => array(
-                        'title'    => __('Messengers', 'event_espresso'),
-                        'filename' => 'messages_overview_messengers',
-                    ),
-                    'messages_overview_other_help_tab'                          => array(
-                        'title'    => __('Messages Other', 'event_espresso'),
-                        'filename' => 'messages_overview_other',
-                    ),
-                ),
-                'help_tour'     => array('Messages_Overview_Help_Tour'),
-                'require_nonce' => false
-            ),
-            'custom_mtps'              => array(
-                'nav'           => array(
-                    'label' => __('Custom Message Templates', 'event_espresso'),
-                    'order' => 30
-                ),
-                'help_tabs'     => array(),
-                'help_tour'     => array(),
-                'require_nonce' => false
-            ),
-            'add_new_message_template' => array(
-                'nav'           => array(
-                    'label'      => __('Add New Message Templates', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false
-                ),
-                'require_nonce' => false
-            ),
-            'edit_message_template'    => array(
-                'labels'        => array(
-                    'buttons'    => array(
-                        'reset' => __('Reset Templates'),
-                    ),
-                    'publishbox' => __('Update Actions', 'event_espresso')
-                ),
-                'nav'           => array(
-                    'label'      => __('Edit Message Templates', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => ''
-                ),
-                'metaboxes'     => array('_publish_post_box', '_register_edit_meta_boxes'),
-                'has_metaboxes' => true,
-                'help_tour'     => array('Message_Templates_Edit_Help_Tour'),
-                'help_tabs'     => array(
-                    'edit_message_template'       => array(
-                        'title'    => __('Message Template Editor', 'event_espresso'),
-                        'callback' => 'edit_message_template_help_tab'
-                    ),
-                    'message_templates_help_tab'  => array(
-                        'title'    => __('Message Templates', 'event_espresso'),
-                        'filename' => 'messages_templates'
-                    ),
-                    'message_template_shortcodes' => array(
-                        'title'    => __('Message Shortcodes', 'event_espresso'),
-                        'callback' => 'message_template_shortcodes_help_tab'
-                    ),
-                    'message_preview_help_tab'    => array(
-                        'title'    => __('Message Preview', 'event_espresso'),
-                        'filename' => 'messages_preview'
-                    ),
-                ),
-                'require_nonce' => false
-            ),
-            'display_preview_message'  => array(
-                'nav'           => array(
-                    'label'      => __('Message Preview', 'event_espresso'),
-                    'order'      => 5,
-                    'url'        => '',
-                    'persistent' => false
-                ),
-                'help_tabs'     => array(
-                    'preview_message' => array(
-                        'title'    => __('About Previews', 'event_espresso'),
-                        'callback' => 'preview_message_help_tab'
-                    )
-                ),
-                'require_nonce' => false
-            ),
-            'settings'                 => array(
-                'nav'           => array(
-                    'label' => __('Settings', 'event_espresso'),
-                    'order' => 40
-                ),
-                'metaboxes'     => array('_messages_settings_metaboxes'),
-                'help_tabs'     => array(
-                    'messages_settings_help_tab'               => array(
-                        'title'    => __('Messages Settings', 'event_espresso'),
-                        'filename' => 'messages_settings'
-                    ),
-                    'messages_settings_message_types_help_tab' => array(
-                        'title'    => __('Activating / Deactivating Message Types', 'event_espresso'),
-                        'filename' => 'messages_settings_message_types'
-                    ),
-                    'messages_settings_messengers_help_tab'    => array(
-                        'title'    => __('Activating / Deactivating Messengers', 'event_espresso'),
-                        'filename' => 'messages_settings_messengers'
-                    ),
-                ),
-                'help_tour'     => array('Messages_Settings_Help_Tour'),
-                'require_nonce' => false
-            )
-        );
-    }
-    
-    
-    protected function _add_screen_options()
-    {
-        //todo
-    }
-    
-    
-    protected function _add_screen_options_global_mtps()
-    {
-        /**
-         * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
-         * uses the $_admin_page_title property and we want different outputs in the different spots.
-         */
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = __('Global Message Templates', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-    
-    
-    protected function _add_screen_options_default()
-    {
-        $this->_admin_page_title = __('Message Activity', 'event_espresso');
-        $this->_per_page_screen_option();
-    }
-    
-    
-    //none of the below group are currently used for Messages
-    protected function _add_feature_pointers()
-    {
-    }
-    
-    public function admin_init()
-    {
-    }
-    
-    public function admin_notices()
-    {
-    }
-    
-    public function admin_footer_scripts()
-    {
-    }
-    
-    
-    public function messages_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
-    }
-    
-    
-    public function messengers_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
-    }
-    
-    
-    public function message_types_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
-    }
-    
-    
-    public function messages_overview_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
-    }
-    
-    
-    public function message_templates_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
-    }
-    
-    
-    public function edit_message_template_help_tab()
-    {
-        $args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="' . esc_attr__('Editor Title',
-                'event_espresso') . '" />';
-        $args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="' . esc_attr__('Context Switcher and Preview',
-                'event_espresso') . '" />';
-        $args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="' . esc_attr__('Message Template Form Fields',
-                'event_espresso') . '" />';
-        $args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="' . esc_attr__('Shortcodes Metabox',
-                'event_espresso') . '" />';
-        $args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="' . esc_attr__('Publish Metabox',
-                'event_espresso') . '" />';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
-            $args);
-    }
-    
-    
-    public function message_template_shortcodes_help_tab()
-    {
-        $this->_set_shortcodes();
-        $args['shortcodes'] = $this->_shortcodes;
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
-            $args);
-    }
+			'4.9.9.rc.014'
+		);
+        
+		$contexts                = array();
+		$active_message_contexts = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
+		foreach ($active_message_contexts as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type = $active_message->message_type_object();
+				if ($message_type instanceof EE_message_type) {
+					$message_type_contexts = $message_type->get_contexts();
+					foreach ($message_type_contexts as $context => $context_details) {
+						$contexts[$context] = $context_details['label'];
+					}
+				}
+			}
+		}
+        
+		return $contexts;
+	}
+    
+    
+	/**
+	 * Generate select input with provided messenger options array.
+	 *
+	 * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
+	 *                                 labels.
+	 *
+	 * @return string
+	 */
+	public function get_messengers_select_input($messenger_options)
+	{
+		//if empty or just one value then just return an empty string
+		if (empty($messenger_options)
+			|| ! is_array($messenger_options)
+			|| count($messenger_options) === 1
+		) {
+			return '';
+		}
+		//merge in default
+		$messenger_options = array_merge(
+			array('none_selected' => __('Show All Messengers', 'event_espresso')),
+			$messenger_options
+		);
+		$input             = new EE_Select_Input(
+			$messenger_options,
+			array(
+				'html_name'  => 'ee_messenger_filter_by',
+				'html_id'    => 'ee_messenger_filter_by',
+				'html_class' => 'wide',
+				'default'    => isset($this->_req_data['ee_messenger_filter_by'])
+					? sanitize_title($this->_req_data['ee_messenger_filter_by'])
+					: 'none_selected'
+			)
+		);
+        
+		return $input->get_html_for_input();
+	}
+    
+    
+	/**
+	 * Generate select input with provided message type options array.
+	 *
+	 * @param array $message_type_options Array of message types indexed by message type slug, and values are the
+	 *                                    message type labels
+	 *
+	 * @return string
+	 */
+	public function get_message_types_select_input($message_type_options)
+	{
+		//if empty or count of options is 1 then just return an empty string
+		if (empty($message_type_options)
+			|| ! is_array($message_type_options)
+			|| count($message_type_options) === 1
+		) {
+			return '';
+		}
+		//merge in default
+		$message_type_options = array_merge(
+			array('none_selected' => __('Show All Message Types', 'event_espresso')),
+			$message_type_options
+		);
+		$input                = new EE_Select_Input(
+			$message_type_options,
+			array(
+				'html_name'  => 'ee_message_type_filter_by',
+				'html_id'    => 'ee_message_type_filter_by',
+				'html_class' => 'wide',
+				'default'    => isset($this->_req_data['ee_message_type_filter_by'])
+					? sanitize_title($this->_req_data['ee_message_type_filter_by'])
+					: 'none_selected',
+			)
+		);
+        
+		return $input->get_html_for_input();
+	}
+    
+    
+	/**
+	 * Generate select input with provide message type contexts array.
+	 *
+	 * @param array $context_options Array of message type contexts indexed by context slug, and values are the
+	 *                               context label.
+	 *
+	 * @return string
+	 */
+	public function get_contexts_for_message_types_select_input($context_options)
+	{
+		//if empty or count of options is one then just return empty string
+		if (empty($context_options)
+			|| ! is_array($context_options)
+			|| count($context_options) === 1
+		) {
+			return '';
+		}
+		//merge in default
+		$context_options = array_merge(
+			array('none_selected' => __('Show all Contexts', 'event_espresso')),
+			$context_options
+		);
+		$input           = new EE_Select_Input(
+			$context_options,
+			array(
+				'html_name'  => 'ee_context_filter_by',
+				'html_id'    => 'ee_context_filter_by',
+				'html_class' => 'wide',
+				'default'    => isset($this->_req_data['ee_context_filter_by'])
+					? sanitize_title($this->_req_data['ee_context_filter_by'])
+					: 'none_selected',
+			)
+		);
+        
+		return $input->get_html_for_input();
+	}
+    
+    
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_activate_messenger', array($this, 'activate_messenger_toggle'));
+		add_action('wp_ajax_activate_mt', array($this, 'activate_mt_toggle'));
+		add_action('wp_ajax_ee_msgs_save_settings', array($this, 'save_settings'));
+		add_action('wp_ajax_ee_msgs_update_mt_form', array($this, 'update_mt_form'));
+		add_action('wp_ajax_switch_template_pack', array($this, 'switch_template_pack'));
+	}
+    
+    
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = array(
+			'buttons'    => array(
+				'add'    => __('Add New Message Template', 'event_espresso'),
+				'edit'   => __('Edit Message Template', 'event_espresso'),
+				'delete' => __('Delete Message Template', 'event_espresso')
+			),
+			'publishbox' => __('Update Actions', 'event_espresso')
+		);
+	}
+    
+    
+	/**
+	 *        an array for storing key => value pairs of request actions and their corresponding methods
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_page_routes()
+	{
+		$grp_id = ! empty($this->_req_data['GRP_ID']) && ! is_array($this->_req_data['GRP_ID'])
+			? $this->_req_data['GRP_ID']
+			: 0;
+		$grp_id = empty($grp_id) && ! empty($this->_req_data['id'])
+			? $this->_req_data['id']
+			: $grp_id;
+		$msg_id = ! empty($this->_req_data['MSG_ID']) && ! is_array($this->_req_data['MSG_ID'])
+			? $this->_req_data['MSG_ID']
+			: 0;
+        
+		$this->_page_routes = array(
+			'default'                          => array(
+				'func'       => '_message_queue_list_table',
+				'capability' => 'ee_read_global_messages'
+			),
+			'global_mtps'                      => array(
+				'func'       => '_ee_default_messages_overview_list_table',
+				'capability' => 'ee_read_global_messages'
+			),
+			'custom_mtps'                      => array(
+				'func'       => '_custom_mtps_preview',
+				'capability' => 'ee_read_messages'
+			),
+			'add_new_message_template'         => array(
+				'func'       => '_add_message_template',
+				'capability' => 'ee_edit_messages',
+				'noheader'   => true
+			),
+			'edit_message_template'            => array(
+				'func'       => '_edit_message_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $grp_id
+			),
+			'preview_message'                  => array(
+				'func'               => '_preview_message',
+				'capability'         => 'ee_read_message',
+				'obj_id'             => $grp_id,
+				'noheader'           => true,
+				'headers_sent_route' => 'display_preview_message'
+			),
+			'display_preview_message'          => array(
+				'func'       => '_display_preview_message',
+				'capability' => 'ee_read_message',
+				'obj_id'     => $grp_id
+			),
+			'insert_message_template'          => array(
+				'func'       => '_insert_or_update_message_template',
+				'capability' => 'ee_edit_messages',
+				'args'       => array('new_template' => true),
+				'noheader'   => true
+			),
+			'update_message_template'          => array(
+				'func'       => '_insert_or_update_message_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('new_template' => false),
+				'noheader'   => true
+			),
+			'trash_message_template'           => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => true, 'all' => true),
+				'noheader'   => true
+			),
+			'trash_message_template_context'   => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => true),
+				'noheader'   => true
+			),
+			'restore_message_template'         => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => false, 'all' => true),
+				'noheader'   => true
+			),
+			'restore_message_template_context' => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => false),
+				'noheader'   => true
+			),
+			'delete_message_template'          => array(
+				'func'       => '_delete_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'noheader'   => true
+			),
+			'reset_to_default'                 => array(
+				'func'       => '_reset_to_default_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $grp_id,
+				'noheader'   => true
+			),
+			'settings'                         => array(
+				'func'       => '_settings',
+				'capability' => 'manage_options'
+			),
+			'update_global_settings'           => array(
+				'func'       => '_update_global_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true
+			),
+			'generate_now'                     => array(
+				'func'       => '_generate_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true
+			),
+			'generate_and_send_now'            => array(
+				'func'       => '_generate_and_send_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true
+			),
+			'queue_for_resending'              => array(
+				'func'       => '_queue_for_resending',
+				'capability' => 'ee_send_message',
+				'noheader'   => true
+			),
+			'send_now'                         => array(
+				'func'       => '_send_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true
+			),
+			'delete_ee_message'                => array(
+				'func'       => '_delete_ee_messages',
+				'capability' => 'ee_delete_message',
+				'noheader'   => true
+			),
+			'delete_ee_messages'               => array(
+				'func'       => '_delete_ee_messages',
+				'capability' => 'ee_delete_messages',
+				'noheader'   => true,
+				'obj_id'     => $msg_id
+			)
+		);
+	}
+    
+    
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'                  => array(
+				'nav'           => array(
+					'label' => __('Message Activity', 'event_espresso'),
+					'order' => 10
+				),
+				'list_table'    => 'EE_Message_List_Table',
+				// 'qtips' => array( 'EE_Message_List_Table_Tips' ),
+				'require_nonce' => false
+			),
+			'global_mtps'              => array(
+				'nav'           => array(
+					'label' => __('Default Message Templates', 'event_espresso'),
+					'order' => 20
+				),
+				'list_table'    => 'Messages_Template_List_Table',
+				'help_tabs'     => array(
+					'messages_overview_help_tab'                                => array(
+						'title'    => __('Messages Overview', 'event_espresso'),
+						'filename' => 'messages_overview'
+					),
+					'messages_overview_messages_table_column_headings_help_tab' => array(
+						'title'    => __('Messages Table Column Headings', 'event_espresso'),
+						'filename' => 'messages_overview_table_column_headings'
+					),
+					'messages_overview_messages_filters_help_tab'               => array(
+						'title'    => __('Message Filters', 'event_espresso'),
+						'filename' => 'messages_overview_filters'
+					),
+					'messages_overview_messages_views_help_tab'                 => array(
+						'title'    => __('Message Views', 'event_espresso'),
+						'filename' => 'messages_overview_views'
+					),
+					'message_overview_message_types_help_tab'                   => array(
+						'title'    => __('Message Types', 'event_espresso'),
+						'filename' => 'messages_overview_types'
+					),
+					'messages_overview_messengers_help_tab'                     => array(
+						'title'    => __('Messengers', 'event_espresso'),
+						'filename' => 'messages_overview_messengers',
+					),
+					'messages_overview_other_help_tab'                          => array(
+						'title'    => __('Messages Other', 'event_espresso'),
+						'filename' => 'messages_overview_other',
+					),
+				),
+				'help_tour'     => array('Messages_Overview_Help_Tour'),
+				'require_nonce' => false
+			),
+			'custom_mtps'              => array(
+				'nav'           => array(
+					'label' => __('Custom Message Templates', 'event_espresso'),
+					'order' => 30
+				),
+				'help_tabs'     => array(),
+				'help_tour'     => array(),
+				'require_nonce' => false
+			),
+			'add_new_message_template' => array(
+				'nav'           => array(
+					'label'      => __('Add New Message Templates', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false
+				),
+				'require_nonce' => false
+			),
+			'edit_message_template'    => array(
+				'labels'        => array(
+					'buttons'    => array(
+						'reset' => __('Reset Templates'),
+					),
+					'publishbox' => __('Update Actions', 'event_espresso')
+				),
+				'nav'           => array(
+					'label'      => __('Edit Message Templates', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => ''
+				),
+				'metaboxes'     => array('_publish_post_box', '_register_edit_meta_boxes'),
+				'has_metaboxes' => true,
+				'help_tour'     => array('Message_Templates_Edit_Help_Tour'),
+				'help_tabs'     => array(
+					'edit_message_template'       => array(
+						'title'    => __('Message Template Editor', 'event_espresso'),
+						'callback' => 'edit_message_template_help_tab'
+					),
+					'message_templates_help_tab'  => array(
+						'title'    => __('Message Templates', 'event_espresso'),
+						'filename' => 'messages_templates'
+					),
+					'message_template_shortcodes' => array(
+						'title'    => __('Message Shortcodes', 'event_espresso'),
+						'callback' => 'message_template_shortcodes_help_tab'
+					),
+					'message_preview_help_tab'    => array(
+						'title'    => __('Message Preview', 'event_espresso'),
+						'filename' => 'messages_preview'
+					),
+				),
+				'require_nonce' => false
+			),
+			'display_preview_message'  => array(
+				'nav'           => array(
+					'label'      => __('Message Preview', 'event_espresso'),
+					'order'      => 5,
+					'url'        => '',
+					'persistent' => false
+				),
+				'help_tabs'     => array(
+					'preview_message' => array(
+						'title'    => __('About Previews', 'event_espresso'),
+						'callback' => 'preview_message_help_tab'
+					)
+				),
+				'require_nonce' => false
+			),
+			'settings'                 => array(
+				'nav'           => array(
+					'label' => __('Settings', 'event_espresso'),
+					'order' => 40
+				),
+				'metaboxes'     => array('_messages_settings_metaboxes'),
+				'help_tabs'     => array(
+					'messages_settings_help_tab'               => array(
+						'title'    => __('Messages Settings', 'event_espresso'),
+						'filename' => 'messages_settings'
+					),
+					'messages_settings_message_types_help_tab' => array(
+						'title'    => __('Activating / Deactivating Message Types', 'event_espresso'),
+						'filename' => 'messages_settings_message_types'
+					),
+					'messages_settings_messengers_help_tab'    => array(
+						'title'    => __('Activating / Deactivating Messengers', 'event_espresso'),
+						'filename' => 'messages_settings_messengers'
+					),
+				),
+				'help_tour'     => array('Messages_Settings_Help_Tour'),
+				'require_nonce' => false
+			)
+		);
+	}
+    
+    
+	protected function _add_screen_options()
+	{
+		//todo
+	}
+    
+    
+	protected function _add_screen_options_global_mtps()
+	{
+		/**
+		 * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
+		 * uses the $_admin_page_title property and we want different outputs in the different spots.
+		 */
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = __('Global Message Templates', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+    
+    
+	protected function _add_screen_options_default()
+	{
+		$this->_admin_page_title = __('Message Activity', 'event_espresso');
+		$this->_per_page_screen_option();
+	}
+    
+    
+	//none of the below group are currently used for Messages
+	protected function _add_feature_pointers()
+	{
+	}
+    
+	public function admin_init()
+	{
+	}
+    
+	public function admin_notices()
+	{
+	}
+    
+	public function admin_footer_scripts()
+	{
+	}
+    
+    
+	public function messages_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
+	}
+    
+    
+	public function messengers_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
+	}
+    
+    
+	public function message_types_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
+	}
+    
+    
+	public function messages_overview_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
+	}
+    
+    
+	public function message_templates_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
+	}
+    
+    
+	public function edit_message_template_help_tab()
+	{
+		$args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="' . esc_attr__('Editor Title',
+				'event_espresso') . '" />';
+		$args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="' . esc_attr__('Context Switcher and Preview',
+				'event_espresso') . '" />';
+		$args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="' . esc_attr__('Message Template Form Fields',
+				'event_espresso') . '" />';
+		$args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="' . esc_attr__('Shortcodes Metabox',
+				'event_espresso') . '" />';
+		$args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="' . esc_attr__('Publish Metabox',
+				'event_espresso') . '" />';
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
+			$args);
+	}
+    
+    
+	public function message_template_shortcodes_help_tab()
+	{
+		$this->_set_shortcodes();
+		$args['shortcodes'] = $this->_shortcodes;
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
+			$args);
+	}
     
     
-    public function preview_message_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
-    }
+	public function preview_message_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
+	}
     
-    
-    public function settings_help_tab()
-    {
-        $args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '" alt="' . esc_attr__('Active Email Tab',
-                'event_espresso') . '" />';
-        $args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png' . '" alt="' . esc_attr__('Inactive Email Tab',
-                'event_espresso') . '" />';
-        $args['img3'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked"><label for="ee-on-off-toggle-on"></label>';
-        $args['img4'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox"><label for="ee-on-off-toggle-on"></label>';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
-    }
+    
+	public function settings_help_tab()
+	{
+		$args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '" alt="' . esc_attr__('Active Email Tab',
+				'event_espresso') . '" />';
+		$args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png' . '" alt="' . esc_attr__('Inactive Email Tab',
+				'event_espresso') . '" />';
+		$args['img3'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked"><label for="ee-on-off-toggle-on"></label>';
+		$args['img4'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox"><label for="ee-on-off-toggle-on"></label>';
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
+	}
     
     
-    public function load_scripts_styles()
-    {
-        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso_ee_msg');
+	public function load_scripts_styles()
+	{
+		wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso_ee_msg');
         
-        wp_register_script('ee-messages-settings', EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
-            array('jquery-ui-droppable', 'ee-serialize-full-array'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-msg-list-table-js', EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
-            array('ee-dialog'), EVENT_ESPRESSO_VERSION);
-    }
+		wp_register_script('ee-messages-settings', EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
+			array('jquery-ui-droppable', 'ee-serialize-full-array'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee-msg-list-table-js', EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
+			array('ee-dialog'), EVENT_ESPRESSO_VERSION);
+	}
     
     
-    public function load_scripts_styles_default()
-    {
-        wp_enqueue_script('ee-msg-list-table-js');
-    }
+	public function load_scripts_styles_default()
+	{
+		wp_enqueue_script('ee-msg-list-table-js');
+	}
     
     
-    public function wp_editor_css($mce_css)
-    {
-        //if we're on the edit_message_template route
-        if ($this->_req_action == 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
-            $message_type_name = $this->_active_message_type_name;
+	public function wp_editor_css($mce_css)
+	{
+		//if we're on the edit_message_template route
+		if ($this->_req_action == 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
+			$message_type_name = $this->_active_message_type_name;
             
-            //we're going to REPLACE the existing mce css
-            //we need to get the css file location from the active messenger
-            $mce_css = $this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true,
-                'wpeditor', $this->_variation);
-        }
+			//we're going to REPLACE the existing mce css
+			//we need to get the css file location from the active messenger
+			$mce_css = $this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true,
+				'wpeditor', $this->_variation);
+		}
         
-        return $mce_css;
-    }
-    
-    
-    public function load_scripts_styles_edit_message_template()
-    {
-        
-        $this->_set_shortcodes();
+		return $mce_css;
+	}
+    
+    
+	public function load_scripts_styles_edit_message_template()
+	{
+        
+		$this->_set_shortcodes();
         
-        EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
-            __('Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
-                'event_espresso'),
-            $this->_message_template_group->messenger_obj()->label['singular'],
-            $this->_message_template_group->message_type_obj()->label['singular']
-        );
-        EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = __('Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
-            'event_espresso');
-        
-        wp_register_script('ee_msgs_edit_js', EE_MSG_ASSETS_URL . 'ee_message_editor.js', array('jquery'),
-            EVENT_ESPRESSO_VERSION);
-        
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee_msgs_edit_js');
-        
-        //add in special css for tiny_mce
-        add_filter('mce_css', array($this, 'wp_editor_css'));
-    }
-    
-    
-    public function load_scripts_styles_display_preview_message()
-    {
-        
-        $this->_set_message_template_group();
-        
-        if (isset($this->_req_data['messenger'])) {
-            $this->_active_messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
-        }
-        
-        $message_type_name = isset($this->_req_data['message_type']) ? $this->_req_data['message_type'] : '';
-        
-        
-        wp_enqueue_style('espresso_preview_css',
-            $this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true, 'preview',
-                $this->_variation));
-    }
-    
-    
-    public function load_scripts_styles_settings()
-    {
-        wp_register_style('ee-message-settings', EE_MSG_ASSETS_URL . 'ee_message_settings.css', array(),
-            EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('ee-text-links');
-        wp_enqueue_style('ee-message-settings');
-        
-        wp_enqueue_script('ee-messages-settings');
-    }
-    
-    
-    /**
-     * set views array for List Table
-     */
-    public function _set_list_table_views_global_mtps()
-    {
-        $this->_views = array(
-            'in_use' => array(
-                'slug'        => 'in_use',
-                'label'       => __('In Use', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_message_template' => __('Move to Trash', 'event_espresso')
-                )
-            )
-        );
-    }
-    
-    
-    /**
-     * set views array for message queue list table
-     */
-    public function _set_list_table_views_default()
-    {
-        EE_Registry::instance()->load_helper('Template');
-        
-        $common_bulk_actions = EE_Registry::instance()->CAP->current_user_can('ee_send_message',
-            'message_list_table_bulk_actions')
-            ? array(
-                'generate_now'          => __('Generate Now', 'event_espresso'),
-                'generate_and_send_now' => __('Generate and Send Now', 'event_espresso'),
-                'queue_for_resending'   => __('Queue for Resending', 'event_espresso'),
-                'send_now'              => __('Send Now', 'event_espresso')
-            )
-            : array();
-        
-        $delete_bulk_action = EE_Registry::instance()->CAP->current_user_can('ee_delete_messages',
-            'message_list_table_bulk_actions')
-            ? array('delete_ee_messages' => __('Delete Messages', 'event_espresso'))
-            : array();
-        
-        
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => __('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action)
-            )
-        );
-        
-        
-        foreach (EEM_Message::instance()->all_statuses() as $status) {
-            if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
-                continue;
-            }
-            $status_bulk_actions = $common_bulk_actions;
-            //unset bulk actions not applying to status
-            if (! empty($status_bulk_actions)) {
-                switch ($status) {
-                    case EEM_Message::status_idle:
-                    case EEM_Message::status_resend:
-                        $status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
-                        break;
+		EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
+			__('Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
+				'event_espresso'),
+			$this->_message_template_group->messenger_obj()->label['singular'],
+			$this->_message_template_group->message_type_obj()->label['singular']
+		);
+		EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = __('Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
+			'event_espresso');
+        
+		wp_register_script('ee_msgs_edit_js', EE_MSG_ASSETS_URL . 'ee_message_editor.js', array('jquery'),
+			EVENT_ESPRESSO_VERSION);
+        
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee_msgs_edit_js');
+        
+		//add in special css for tiny_mce
+		add_filter('mce_css', array($this, 'wp_editor_css'));
+	}
+    
+    
+	public function load_scripts_styles_display_preview_message()
+	{
+        
+		$this->_set_message_template_group();
+        
+		if (isset($this->_req_data['messenger'])) {
+			$this->_active_messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
+		}
+        
+		$message_type_name = isset($this->_req_data['message_type']) ? $this->_req_data['message_type'] : '';
+        
+        
+		wp_enqueue_style('espresso_preview_css',
+			$this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true, 'preview',
+				$this->_variation));
+	}
+    
+    
+	public function load_scripts_styles_settings()
+	{
+		wp_register_style('ee-message-settings', EE_MSG_ASSETS_URL . 'ee_message_settings.css', array(),
+			EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('ee-text-links');
+		wp_enqueue_style('ee-message-settings');
+        
+		wp_enqueue_script('ee-messages-settings');
+	}
+    
+    
+	/**
+	 * set views array for List Table
+	 */
+	public function _set_list_table_views_global_mtps()
+	{
+		$this->_views = array(
+			'in_use' => array(
+				'slug'        => 'in_use',
+				'label'       => __('In Use', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_message_template' => __('Move to Trash', 'event_espresso')
+				)
+			)
+		);
+	}
+    
+    
+	/**
+	 * set views array for message queue list table
+	 */
+	public function _set_list_table_views_default()
+	{
+		EE_Registry::instance()->load_helper('Template');
+        
+		$common_bulk_actions = EE_Registry::instance()->CAP->current_user_can('ee_send_message',
+			'message_list_table_bulk_actions')
+			? array(
+				'generate_now'          => __('Generate Now', 'event_espresso'),
+				'generate_and_send_now' => __('Generate and Send Now', 'event_espresso'),
+				'queue_for_resending'   => __('Queue for Resending', 'event_espresso'),
+				'send_now'              => __('Send Now', 'event_espresso')
+			)
+			: array();
+        
+		$delete_bulk_action = EE_Registry::instance()->CAP->current_user_can('ee_delete_messages',
+			'message_list_table_bulk_actions')
+			? array('delete_ee_messages' => __('Delete Messages', 'event_espresso'))
+			: array();
+        
+        
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => __('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action)
+			)
+		);
+        
+        
+		foreach (EEM_Message::instance()->all_statuses() as $status) {
+			if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
+				continue;
+			}
+			$status_bulk_actions = $common_bulk_actions;
+			//unset bulk actions not applying to status
+			if (! empty($status_bulk_actions)) {
+				switch ($status) {
+					case EEM_Message::status_idle:
+					case EEM_Message::status_resend:
+						$status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
+						break;
                     
-                    case EEM_Message::status_failed:
-                    case EEM_Message::status_debug_only:
-                    case EEM_Message::status_messenger_executing:
-                        $status_bulk_actions = array();
-                        break;
+					case EEM_Message::status_failed:
+					case EEM_Message::status_debug_only:
+					case EEM_Message::status_messenger_executing:
+						$status_bulk_actions = array();
+						break;
                     
-                    case EEM_Message::status_incomplete:
-                        unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
-                        break;
+					case EEM_Message::status_incomplete:
+						unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
+						break;
                     
-                    case EEM_Message::status_retry:
-                    case EEM_Message::status_sent:
-                        unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
-                        break;
-                }
-            }
+					case EEM_Message::status_retry:
+					case EEM_Message::status_sent:
+						unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
+						break;
+				}
+			}
 
-            //skip adding messenger executing status to views because it will be included with the Failed view.
-            if ( $status === EEM_Message::status_messenger_executing ) {
-                continue;
-            }
+			//skip adding messenger executing status to views because it will be included with the Failed view.
+			if ( $status === EEM_Message::status_messenger_executing ) {
+				continue;
+			}
             
-            $this->_views[strtolower($status)] = array(
-                'slug'        => strtolower($status),
-                'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
-                'count'       => 0,
-                'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action)
-            );
-        }
-    }
-    
-    
-    protected function _ee_default_messages_overview_list_table()
-    {
-        $this->_admin_page_title = __('Default Message Templates', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-    
-    
-    protected function _message_queue_list_table()
-    {
-        $this->_search_btn_label                   = __('Message Activity', 'event_espresso');
-        $this->_template_args['per_column']        = 6;
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_message_legend_items());
-        $this->_template_args['before_list_table'] = '<h3>' . EEM_Message::instance()->get_pretty_label_for_results() . '</h3>';
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-    
-    
-    protected function _message_legend_items()
-    {
-        
-        $action_css_classes = EEH_MSG_Template::get_message_action_icons();
-        $action_items       = array();
-        
-        foreach ($action_css_classes as $action_item => $action_details) {
-            if ($action_item === 'see_notifications_for') {
-                continue;
-            }
-            $action_items[$action_item] = array(
-                'class' => $action_details['css_class'],
-                'desc'  => $action_details['label']
-            );
-        }
-        
-        /** @type array $status_items status legend setup */
-        $status_items = array(
-            'sent_status'       => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence')
-            ),
-            'idle_status'       => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence')
-            ),
-            'failed_status'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence')
-            ),
-            'messenger_executing_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
-                'desc' => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence')
-            ),
-            'resend_status'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence')
-            ),
-            'incomplete_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence')
-            ),
-            'retry_status'      => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence')
-            )
-        );
-        if (EEM_Message::debug()) {
-            $status_items['debug_only_status'] = array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence')
-            );
-        }
-        
-        return array_merge($action_items, $status_items);
-    }
-    
-    
-    protected function _custom_mtps_preview()
-    {
-        $this->_admin_page_title              = __('Custom Message Templates (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png" alt="' . esc_attr__('Preview Custom Message Templates screenshot',
-                'event_espresso') . '" />';
-        $this->_template_args['preview_text'] = '<strong>' . __('Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
-                'event_espresso') . '</strong>';
-        $this->display_admin_caf_preview_page('custom_message_types', false);
-    }
-    
-    
-    /**
-     * get_message_templates
-     * This gets all the message templates for listing on the overview list.
-     *
-     * @access public
-     *
-     * @param int    $perpage the amount of templates groups to show per page
-     * @param string $type    the current _view we're getting templates for
-     * @param bool   $count   return count?
-     * @param bool   $all     disregard any paging info (get all data);
-     * @param bool   $global  whether to return just global (true) or custom templates (false)
-     *
-     * @return array
-     */
-    public function get_message_templates($perpage = 10, $type = 'in_use', $count = false, $all = false, $global = true)
-    {
-        
-        $MTP = EEM_Message_Template_Group::instance();
-        
-        $this->_req_data['orderby'] = empty($this->_req_data['orderby']) ? 'GRP_ID' : $this->_req_data['orderby'];
-        $orderby                    = $this->_req_data['orderby'];
-        
-        $order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'ASC';
-        
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1;
-        $per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $perpage;
-        
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = $all ? null : array($offset, $per_page);
-        
-        
-        //options will match what is in the _views array property
-        switch ($type) {
+			$this->_views[strtolower($status)] = array(
+				'slug'        => strtolower($status),
+				'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
+				'count'       => 0,
+				'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action)
+			);
+		}
+	}
+    
+    
+	protected function _ee_default_messages_overview_list_table()
+	{
+		$this->_admin_page_title = __('Default Message Templates', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+    
+    
+	protected function _message_queue_list_table()
+	{
+		$this->_search_btn_label                   = __('Message Activity', 'event_espresso');
+		$this->_template_args['per_column']        = 6;
+		$this->_template_args['after_list_table']  = $this->_display_legend($this->_message_legend_items());
+		$this->_template_args['before_list_table'] = '<h3>' . EEM_Message::instance()->get_pretty_label_for_results() . '</h3>';
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+    
+    
+	protected function _message_legend_items()
+	{
+        
+		$action_css_classes = EEH_MSG_Template::get_message_action_icons();
+		$action_items       = array();
+        
+		foreach ($action_css_classes as $action_item => $action_details) {
+			if ($action_item === 'see_notifications_for') {
+				continue;
+			}
+			$action_items[$action_item] = array(
+				'class' => $action_details['css_class'],
+				'desc'  => $action_details['label']
+			);
+		}
+        
+		/** @type array $status_items status legend setup */
+		$status_items = array(
+			'sent_status'       => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence')
+			),
+			'idle_status'       => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence')
+			),
+			'failed_status'     => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence')
+			),
+			'messenger_executing_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
+				'desc' => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence')
+			),
+			'resend_status'     => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence')
+			),
+			'incomplete_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence')
+			),
+			'retry_status'      => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence')
+			)
+		);
+		if (EEM_Message::debug()) {
+			$status_items['debug_only_status'] = array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence')
+			);
+		}
+        
+		return array_merge($action_items, $status_items);
+	}
+    
+    
+	protected function _custom_mtps_preview()
+	{
+		$this->_admin_page_title              = __('Custom Message Templates (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png" alt="' . esc_attr__('Preview Custom Message Templates screenshot',
+				'event_espresso') . '" />';
+		$this->_template_args['preview_text'] = '<strong>' . __('Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
+				'event_espresso') . '</strong>';
+		$this->display_admin_caf_preview_page('custom_message_types', false);
+	}
+    
+    
+	/**
+	 * get_message_templates
+	 * This gets all the message templates for listing on the overview list.
+	 *
+	 * @access public
+	 *
+	 * @param int    $perpage the amount of templates groups to show per page
+	 * @param string $type    the current _view we're getting templates for
+	 * @param bool   $count   return count?
+	 * @param bool   $all     disregard any paging info (get all data);
+	 * @param bool   $global  whether to return just global (true) or custom templates (false)
+	 *
+	 * @return array
+	 */
+	public function get_message_templates($perpage = 10, $type = 'in_use', $count = false, $all = false, $global = true)
+	{
+        
+		$MTP = EEM_Message_Template_Group::instance();
+        
+		$this->_req_data['orderby'] = empty($this->_req_data['orderby']) ? 'GRP_ID' : $this->_req_data['orderby'];
+		$orderby                    = $this->_req_data['orderby'];
+        
+		$order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'ASC';
+        
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1;
+		$per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $perpage;
+        
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = $all ? null : array($offset, $per_page);
+        
+        
+		//options will match what is in the _views array property
+		switch ($type) {
             
-            case 'in_use':
-                $templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true);
-                break;
+			case 'in_use':
+				$templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true);
+				break;
             
-            default:
-                $templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global);
+			default:
+				$templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global);
             
-        }
-        
-        return $templates;
-    }
-    
-    
-    /**
-     * filters etc might need a list of installed message_types
-     * @return array an array of message type objects
-     */
-    public function get_installed_message_types()
-    {
-        $installed_message_types = $this->_message_resource_manager->installed_message_types();
-        $installed               = array();
-        
-        foreach ($installed_message_types as $message_type) {
-            $installed[$message_type->name] = $message_type;
-        }
-        
-        return $installed;
-    }
-    
-    
-    /**
-     * _add_message_template
-     *
-     * This is used when creating a custom template. All Custom Templates start based off another template.
-     *
-     * @param string $message_type
-     * @param string $messenger
-     * @param string $GRP_ID
-     *
-     * @throws EE_error
-     */
-    protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
-    {
-        //set values override any request data
-        $message_type = ! empty($message_type) ? $message_type : '';
-        $message_type = empty($message_type) && ! empty($this->_req_data['message_type']) ? $this->_req_data['message_type'] : $message_type;
-        
-        $messenger = ! empty($messenger) ? $messenger : '';
-        $messenger = empty($messenger) && ! empty($this->_req_data['messenger']) ? $this->_req_data['messenger'] : $messenger;
-        
-        $GRP_ID = ! empty($GRP_ID) ? $GRP_ID : '';
-        $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : $GRP_ID;
-        
-        //we need messenger and message type.  They should be coming from the event editor. If not here then return error
-        if (empty($message_type) || empty($messenger)) {
-            throw new EE_error(__('Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
-                'event_espresso'));
-        }
-        
-        //we need the GRP_ID for the template being used as the base for the new template
-        if (empty($GRP_ID)) {
-            throw new EE_Error(__('In order to create a custom message template the GRP_ID of the template being used as a base is needed',
-                'event_espresso'));
-        }
-        
-        //let's just make sure the template gets generated!
-        
-        //we need to reassign some variables for what the insert is expecting
-        $this->_req_data['MTP_messenger']    = $messenger;
-        $this->_req_data['MTP_message_type'] = $message_type;
-        $this->_req_data['GRP_ID']           = $GRP_ID;
-        $this->_insert_or_update_message_template(true);
-    }
-    
-    
-    /**
-     * public wrapper for the _add_message_template method
-     *
-     * @param string $message_type     message type slug
-     * @param string $messenger        messenger slug
-     * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
-     *                                 off of.
-     */
-    public function add_message_template($message_type, $messenger, $GRP_ID)
-    {
-        $this->_add_message_template($message_type, $messenger, $GRP_ID);
-    }
-    
-    
-    /**
-     * _edit_message_template
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _edit_message_template()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $template_fields = '';
-        $sidebar_fields  = '';
-        //we filter the tinyMCE settings to remove the validation since message templates by their nature will not have valid html in the templates.
-        add_filter('tiny_mce_before_init', array($this, 'filter_tinymce_init'), 10, 2);
-        
-        $GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
-            ? absint($this->_req_data['id'])
-            : false;
-        
-        $this->_set_shortcodes(); //this also sets the _message_template property.
-        $message_template_group = $this->_message_template_group;
-        $c_label                = $message_template_group->context_label();
-        $c_config               = $message_template_group->contexts_config();
-        
-        reset($c_config);
-        $context = isset($this->_req_data['context']) && ! empty($this->_req_data['context'])
-            ? strtolower($this->_req_data['context'])
-            : key($c_config);
-        
-        
-        if (empty($GRP_ID)) {
-            $action = 'insert_message_template';
-            //$button_both = false;
-            //$button_text = array( __( 'Save','event_espresso') );
-            //$button_actions = array('something_different');
-            //$referrer = false;
-            $edit_message_template_form_url = add_query_arg(
-                array('action' => $action, 'noheader' => true),
-                EE_MSG_ADMIN_URL
-            );
-        } else {
-            $action = 'update_message_template';
-            //$button_both = true;
-            //$button_text = array();
-            //$button_actions = array();
-            //$referrer = $this->_admin_base_url;
-            $edit_message_template_form_url = add_query_arg(
-                array('action' => $action, 'noheader' => true),
-                EE_MSG_ADMIN_URL
-            );
-        }
-        
-        //set active messenger for this view
-        $this->_active_messenger         = $this->_message_resource_manager->get_active_messenger(
-            $message_template_group->messenger()
-        );
-        $this->_active_message_type_name = $message_template_group->message_type();
-        
-        
-        //Do we have any validation errors?
-        $validators = $this->_get_transient();
-        $v_fields   = ! empty($validators) ? array_keys($validators) : array();
-        
-        
-        //we need to assemble the title from Various details
-        $context_label = sprintf(
-            __('(%s %s)', 'event_espresso'),
-            $c_config[$context]['label'],
-            ucwords($c_label['label'])
-        );
-        
-        $title = sprintf(
-            __(' %s %s Template %s', 'event_espresso'),
-            ucwords($message_template_group->messenger_obj()->label['singular']),
-            ucwords($message_template_group->message_type_obj()->label['singular']),
-            $context_label
-        );
-        
-        $this->_template_args['GRP_ID']           = $GRP_ID;
-        $this->_template_args['message_template'] = $message_template_group;
-        $this->_template_args['is_extra_fields']  = false;
-        
-        
-        //let's get EEH_MSG_Template so we can get template form fields
-        $template_field_structure = EEH_MSG_Template::get_fields(
-            $message_template_group->messenger(),
-            $message_template_group->message_type()
-        );
-        
-        if ( ! $template_field_structure) {
-            $template_field_structure = false;
-            $template_fields          = __('There was an error in assembling the fields for this display (you should see an error message)',
-                'event_espresso');
-        }
-        
-        
-        $message_templates = $message_template_group->context_templates();
-        
-        
-        //if we have the extra key.. then we need to remove the content index from the template_field_structure as it will get handled in the "extra" array.
-        if (is_array($template_field_structure[$context]) && isset($template_field_structure[$context]['extra'])) {
-            foreach ($template_field_structure[$context]['extra'] as $reference_field => $new_fields) {
-                unset($template_field_structure[$context][$reference_field]);
-            }
-        }
-        
-        //let's loop through the template_field_structure and actually assemble the input fields!
-        if ( ! empty($template_field_structure)) {
-            foreach ($template_field_structure[$context] as $template_field => $field_setup_array) {
-                //if this is an 'extra' template field then we need to remove any existing fields that are keyed up in the extra array and reset them.
-                if ($template_field == 'extra') {
-                    $this->_template_args['is_extra_fields'] = true;
-                    foreach ($field_setup_array as $reference_field => $new_fields_array) {
-                        $message_template = $message_templates[$context][$reference_field];
-                        $content          = $message_template instanceof EE_Message_Template
-                            ? $message_template->get('MTP_content')
-                            : '';
-                        foreach ($new_fields_array as $extra_field => $extra_array) {
-                            //let's verify if we need this extra field via the shortcodes parameter.
-                            $continue = false;
-                            if (isset($extra_array['shortcodes_required'])) {
-                                foreach ((array)$extra_array['shortcodes_required'] as $shortcode) {
-                                    if ( ! array_key_exists($shortcode, $this->_shortcodes)) {
-                                        $continue = true;
-                                    }
-                                }
-                                if ($continue) {
-                                    continue;
-                                }
-                            }
+		}
+        
+		return $templates;
+	}
+    
+    
+	/**
+	 * filters etc might need a list of installed message_types
+	 * @return array an array of message type objects
+	 */
+	public function get_installed_message_types()
+	{
+		$installed_message_types = $this->_message_resource_manager->installed_message_types();
+		$installed               = array();
+        
+		foreach ($installed_message_types as $message_type) {
+			$installed[$message_type->name] = $message_type;
+		}
+        
+		return $installed;
+	}
+    
+    
+	/**
+	 * _add_message_template
+	 *
+	 * This is used when creating a custom template. All Custom Templates start based off another template.
+	 *
+	 * @param string $message_type
+	 * @param string $messenger
+	 * @param string $GRP_ID
+	 *
+	 * @throws EE_error
+	 */
+	protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
+	{
+		//set values override any request data
+		$message_type = ! empty($message_type) ? $message_type : '';
+		$message_type = empty($message_type) && ! empty($this->_req_data['message_type']) ? $this->_req_data['message_type'] : $message_type;
+        
+		$messenger = ! empty($messenger) ? $messenger : '';
+		$messenger = empty($messenger) && ! empty($this->_req_data['messenger']) ? $this->_req_data['messenger'] : $messenger;
+        
+		$GRP_ID = ! empty($GRP_ID) ? $GRP_ID : '';
+		$GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : $GRP_ID;
+        
+		//we need messenger and message type.  They should be coming from the event editor. If not here then return error
+		if (empty($message_type) || empty($messenger)) {
+			throw new EE_error(__('Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
+				'event_espresso'));
+		}
+        
+		//we need the GRP_ID for the template being used as the base for the new template
+		if (empty($GRP_ID)) {
+			throw new EE_Error(__('In order to create a custom message template the GRP_ID of the template being used as a base is needed',
+				'event_espresso'));
+		}
+        
+		//let's just make sure the template gets generated!
+        
+		//we need to reassign some variables for what the insert is expecting
+		$this->_req_data['MTP_messenger']    = $messenger;
+		$this->_req_data['MTP_message_type'] = $message_type;
+		$this->_req_data['GRP_ID']           = $GRP_ID;
+		$this->_insert_or_update_message_template(true);
+	}
+    
+    
+	/**
+	 * public wrapper for the _add_message_template method
+	 *
+	 * @param string $message_type     message type slug
+	 * @param string $messenger        messenger slug
+	 * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
+	 *                                 off of.
+	 */
+	public function add_message_template($message_type, $messenger, $GRP_ID)
+	{
+		$this->_add_message_template($message_type, $messenger, $GRP_ID);
+	}
+    
+    
+	/**
+	 * _edit_message_template
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _edit_message_template()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$template_fields = '';
+		$sidebar_fields  = '';
+		//we filter the tinyMCE settings to remove the validation since message templates by their nature will not have valid html in the templates.
+		add_filter('tiny_mce_before_init', array($this, 'filter_tinymce_init'), 10, 2);
+        
+		$GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
+			? absint($this->_req_data['id'])
+			: false;
+        
+		$this->_set_shortcodes(); //this also sets the _message_template property.
+		$message_template_group = $this->_message_template_group;
+		$c_label                = $message_template_group->context_label();
+		$c_config               = $message_template_group->contexts_config();
+        
+		reset($c_config);
+		$context = isset($this->_req_data['context']) && ! empty($this->_req_data['context'])
+			? strtolower($this->_req_data['context'])
+			: key($c_config);
+        
+        
+		if (empty($GRP_ID)) {
+			$action = 'insert_message_template';
+			//$button_both = false;
+			//$button_text = array( __( 'Save','event_espresso') );
+			//$button_actions = array('something_different');
+			//$referrer = false;
+			$edit_message_template_form_url = add_query_arg(
+				array('action' => $action, 'noheader' => true),
+				EE_MSG_ADMIN_URL
+			);
+		} else {
+			$action = 'update_message_template';
+			//$button_both = true;
+			//$button_text = array();
+			//$button_actions = array();
+			//$referrer = $this->_admin_base_url;
+			$edit_message_template_form_url = add_query_arg(
+				array('action' => $action, 'noheader' => true),
+				EE_MSG_ADMIN_URL
+			);
+		}
+        
+		//set active messenger for this view
+		$this->_active_messenger         = $this->_message_resource_manager->get_active_messenger(
+			$message_template_group->messenger()
+		);
+		$this->_active_message_type_name = $message_template_group->message_type();
+        
+        
+		//Do we have any validation errors?
+		$validators = $this->_get_transient();
+		$v_fields   = ! empty($validators) ? array_keys($validators) : array();
+        
+        
+		//we need to assemble the title from Various details
+		$context_label = sprintf(
+			__('(%s %s)', 'event_espresso'),
+			$c_config[$context]['label'],
+			ucwords($c_label['label'])
+		);
+        
+		$title = sprintf(
+			__(' %s %s Template %s', 'event_espresso'),
+			ucwords($message_template_group->messenger_obj()->label['singular']),
+			ucwords($message_template_group->message_type_obj()->label['singular']),
+			$context_label
+		);
+        
+		$this->_template_args['GRP_ID']           = $GRP_ID;
+		$this->_template_args['message_template'] = $message_template_group;
+		$this->_template_args['is_extra_fields']  = false;
+        
+        
+		//let's get EEH_MSG_Template so we can get template form fields
+		$template_field_structure = EEH_MSG_Template::get_fields(
+			$message_template_group->messenger(),
+			$message_template_group->message_type()
+		);
+        
+		if ( ! $template_field_structure) {
+			$template_field_structure = false;
+			$template_fields          = __('There was an error in assembling the fields for this display (you should see an error message)',
+				'event_espresso');
+		}
+        
+        
+		$message_templates = $message_template_group->context_templates();
+        
+        
+		//if we have the extra key.. then we need to remove the content index from the template_field_structure as it will get handled in the "extra" array.
+		if (is_array($template_field_structure[$context]) && isset($template_field_structure[$context]['extra'])) {
+			foreach ($template_field_structure[$context]['extra'] as $reference_field => $new_fields) {
+				unset($template_field_structure[$context][$reference_field]);
+			}
+		}
+        
+		//let's loop through the template_field_structure and actually assemble the input fields!
+		if ( ! empty($template_field_structure)) {
+			foreach ($template_field_structure[$context] as $template_field => $field_setup_array) {
+				//if this is an 'extra' template field then we need to remove any existing fields that are keyed up in the extra array and reset them.
+				if ($template_field == 'extra') {
+					$this->_template_args['is_extra_fields'] = true;
+					foreach ($field_setup_array as $reference_field => $new_fields_array) {
+						$message_template = $message_templates[$context][$reference_field];
+						$content          = $message_template instanceof EE_Message_Template
+							? $message_template->get('MTP_content')
+							: '';
+						foreach ($new_fields_array as $extra_field => $extra_array) {
+							//let's verify if we need this extra field via the shortcodes parameter.
+							$continue = false;
+							if (isset($extra_array['shortcodes_required'])) {
+								foreach ((array)$extra_array['shortcodes_required'] as $shortcode) {
+									if ( ! array_key_exists($shortcode, $this->_shortcodes)) {
+										$continue = true;
+									}
+								}
+								if ($continue) {
+									continue;
+								}
+							}
                             
-                            $field_id                                = $reference_field . '-' . $extra_field . '-content';
-                            $template_form_fields[$field_id]         = $extra_array;
-                            $template_form_fields[$field_id]['name'] = 'MTP_template_fields[' . $reference_field . '][content][' . $extra_field . ']';
-                            $css_class                               = isset($extra_array['css_class']) ? $extra_array['css_class'] : '';
+							$field_id                                = $reference_field . '-' . $extra_field . '-content';
+							$template_form_fields[$field_id]         = $extra_array;
+							$template_form_fields[$field_id]['name'] = 'MTP_template_fields[' . $reference_field . '][content][' . $extra_field . ']';
+							$css_class                               = isset($extra_array['css_class']) ? $extra_array['css_class'] : '';
                             
-                            $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
-                                                                            && in_array($extra_field, $v_fields)
-                                                                            &&
-                                                                            (
-                                                                                is_array($validators[$extra_field])
-                                                                                && isset($validators[$extra_field]['msg'])
-                                                                            )
-                                ? 'validate-error ' . $css_class
-                                : $css_class;
+							$template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
+																			&& in_array($extra_field, $v_fields)
+																			&&
+																			(
+																				is_array($validators[$extra_field])
+																				&& isset($validators[$extra_field]['msg'])
+																			)
+								? 'validate-error ' . $css_class
+								: $css_class;
                             
-                            $template_form_fields[$field_id]['value'] = ! empty($message_templates) && isset($content[$extra_field])
-                                ? stripslashes(html_entity_decode($content[$extra_field], ENT_QUOTES, "UTF-8"))
-                                : '';
+							$template_form_fields[$field_id]['value'] = ! empty($message_templates) && isset($content[$extra_field])
+								? stripslashes(html_entity_decode($content[$extra_field], ENT_QUOTES, "UTF-8"))
+								: '';
                             
-                            //do we have a validation error?  if we do then let's use that value instead
-                            $template_form_fields[$field_id]['value'] = isset($validators[$extra_field]) ? $validators[$extra_field]['value'] : $template_form_fields[$field_id]['value'];
+							//do we have a validation error?  if we do then let's use that value instead
+							$template_form_fields[$field_id]['value'] = isset($validators[$extra_field]) ? $validators[$extra_field]['value'] : $template_form_fields[$field_id]['value'];
                             
                             
-                            $template_form_fields[$field_id]['db-col'] = 'MTP_content';
+							$template_form_fields[$field_id]['db-col'] = 'MTP_content';
                             
-                            //shortcode selector
-                            $field_name_to_use                                 = $extra_field == 'main' ? 'content' : $extra_field;
-                            $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
-                                $field_name_to_use,
-                                $field_id
-                            );
+							//shortcode selector
+							$field_name_to_use                                 = $extra_field == 'main' ? 'content' : $extra_field;
+							$template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
+								$field_name_to_use,
+								$field_id
+							);
                             
-                            if (isset($extra_array['input']) && $extra_array['input'] == 'wp_editor') {
-                                //we want to decode the entities
-                                $template_form_fields[$field_id]['value'] = stripslashes(
-                                    html_entity_decode($template_form_fields[$field_id]['value'], ENT_QUOTES, "UTF-8")
-                                );
+							if (isset($extra_array['input']) && $extra_array['input'] == 'wp_editor') {
+								//we want to decode the entities
+								$template_form_fields[$field_id]['value'] = stripslashes(
+									html_entity_decode($template_form_fields[$field_id]['value'], ENT_QUOTES, "UTF-8")
+								);
                                 
-                            }/**/
-                        }
-                        $templatefield_MTP_id          = $reference_field . '-MTP_ID';
-                        $templatefield_templatename_id = $reference_field . '-name';
+							}/**/
+						}
+						$templatefield_MTP_id          = $reference_field . '-MTP_ID';
+						$templatefield_templatename_id = $reference_field . '-name';
                         
-                        $template_form_fields[$templatefield_MTP_id] = array(
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
-                            'label'      => null,
-                            'input'      => 'hidden',
-                            'type'       => 'int',
-                            'required'   => false,
-                            'validation' => false,
-                            'value'      => ! empty($message_templates) ? $message_template->ID() : '',
-                            'css_class'  => '',
-                            'format'     => '%d',
-                            'db-col'     => 'MTP_ID'
-                        );
+						$template_form_fields[$templatefield_MTP_id] = array(
+							'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
+							'label'      => null,
+							'input'      => 'hidden',
+							'type'       => 'int',
+							'required'   => false,
+							'validation' => false,
+							'value'      => ! empty($message_templates) ? $message_template->ID() : '',
+							'css_class'  => '',
+							'format'     => '%d',
+							'db-col'     => 'MTP_ID'
+						);
                         
-                        $template_form_fields[$templatefield_templatename_id] = array(
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
-                            'label'      => null,
-                            'input'      => 'hidden',
-                            'type'       => 'string',
-                            'required'   => false,
-                            'validation' => true,
-                            'value'      => $reference_field,
-                            'css_class'  => '',
-                            'format'     => '%s',
-                            'db-col'     => 'MTP_template_field'
-                        );
-                    }
-                    continue; //skip the next stuff, we got the necessary fields here for this dataset.
-                } else {
-                    $field_id                                 = $template_field . '-content';
-                    $template_form_fields[$field_id]          = $field_setup_array;
-                    $template_form_fields[$field_id]['name']  = 'MTP_template_fields[' . $template_field . '][content]';
-                    $message_template                         = isset($message_templates[$context][$template_field])
-                        ? $message_templates[$context][$template_field]
-                        : null;
-                    $template_form_fields[$field_id]['value'] = ! empty($message_templates)
-                                                                && is_array($message_templates[$context])
-                                                                && $message_template instanceof EE_Message_Template
-                        ? $message_template->get('MTP_content')
-                        : '';
+						$template_form_fields[$templatefield_templatename_id] = array(
+							'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
+							'label'      => null,
+							'input'      => 'hidden',
+							'type'       => 'string',
+							'required'   => false,
+							'validation' => true,
+							'value'      => $reference_field,
+							'css_class'  => '',
+							'format'     => '%s',
+							'db-col'     => 'MTP_template_field'
+						);
+					}
+					continue; //skip the next stuff, we got the necessary fields here for this dataset.
+				} else {
+					$field_id                                 = $template_field . '-content';
+					$template_form_fields[$field_id]          = $field_setup_array;
+					$template_form_fields[$field_id]['name']  = 'MTP_template_fields[' . $template_field . '][content]';
+					$message_template                         = isset($message_templates[$context][$template_field])
+						? $message_templates[$context][$template_field]
+						: null;
+					$template_form_fields[$field_id]['value'] = ! empty($message_templates)
+																&& is_array($message_templates[$context])
+																&& $message_template instanceof EE_Message_Template
+						? $message_template->get('MTP_content')
+						: '';
                     
-                    //do we have a validator error for this field?  if we do then we'll use that value instead
-                    $template_form_fields[$field_id]['value'] = isset($validators[$template_field])
-                        ? $validators[$template_field]['value']
-                        : $template_form_fields[$field_id]['value'];
+					//do we have a validator error for this field?  if we do then we'll use that value instead
+					$template_form_fields[$field_id]['value'] = isset($validators[$template_field])
+						? $validators[$template_field]['value']
+						: $template_form_fields[$field_id]['value'];
                     
                     
-                    $template_form_fields[$field_id]['db-col']    = 'MTP_content';
-                    $css_class                                    = isset($field_setup_array['css_class']) ? $field_setup_array['css_class'] : '';
-                    $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
-                                                                    && in_array($template_field, $v_fields)
-                                                                    && isset($validators[$template_field]['msg'])
-                        ? 'validate-error ' . $css_class
-                        : $css_class;
+					$template_form_fields[$field_id]['db-col']    = 'MTP_content';
+					$css_class                                    = isset($field_setup_array['css_class']) ? $field_setup_array['css_class'] : '';
+					$template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
+																	&& in_array($template_field, $v_fields)
+																	&& isset($validators[$template_field]['msg'])
+						? 'validate-error ' . $css_class
+						: $css_class;
                     
-                    //shortcode selector
-                    $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
-                        $template_field, $field_id
-                    );
-                }
+					//shortcode selector
+					$template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
+						$template_field, $field_id
+					);
+				}
                 
-                //k took care of content field(s) now let's take care of others.
+				//k took care of content field(s) now let's take care of others.
                 
-                $templatefield_MTP_id                = $template_field . '-MTP_ID';
-                $templatefield_field_templatename_id = $template_field . '-name';
+				$templatefield_MTP_id                = $template_field . '-MTP_ID';
+				$templatefield_field_templatename_id = $template_field . '-name';
                 
-                //foreach template field there are actually two form fields created
-                $template_form_fields[$templatefield_MTP_id] = array(
-                    'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
-                    'label'      => null,
-                    'input'      => 'hidden',
-                    'type'       => 'int',
-                    'required'   => false,
-                    'validation' => true,
-                    'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
-                    'css_class'  => '',
-                    'format'     => '%d',
-                    'db-col'     => 'MTP_ID'
-                );
+				//foreach template field there are actually two form fields created
+				$template_form_fields[$templatefield_MTP_id] = array(
+					'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
+					'label'      => null,
+					'input'      => 'hidden',
+					'type'       => 'int',
+					'required'   => false,
+					'validation' => true,
+					'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
+					'css_class'  => '',
+					'format'     => '%d',
+					'db-col'     => 'MTP_ID'
+				);
                 
-                $template_form_fields[$templatefield_field_templatename_id] = array(
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
-                    'label'      => null,
-                    'input'      => 'hidden',
-                    'type'       => 'string',
-                    'required'   => false,
-                    'validation' => true,
-                    'value'      => $template_field,
-                    'css_class'  => '',
-                    'format'     => '%s',
-                    'db-col'     => 'MTP_template_field'
-                );
+				$template_form_fields[$templatefield_field_templatename_id] = array(
+					'name'       => 'MTP_template_fields[' . $template_field . '][name]',
+					'label'      => null,
+					'input'      => 'hidden',
+					'type'       => 'string',
+					'required'   => false,
+					'validation' => true,
+					'value'      => $template_field,
+					'css_class'  => '',
+					'format'     => '%s',
+					'db-col'     => 'MTP_template_field'
+				);
                 
-            }
+			}
             
-            //add other fields
-            $template_form_fields['ee-msg-current-context'] = array(
-                'name'       => 'MTP_context',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $context,
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_context'
-            );
+			//add other fields
+			$template_form_fields['ee-msg-current-context'] = array(
+				'name'       => 'MTP_context',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $context,
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_context'
+			);
             
-            $template_form_fields['ee-msg-grp-id'] = array(
-                'name'       => 'GRP_ID',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $GRP_ID,
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'GRP_ID'
-            );
+			$template_form_fields['ee-msg-grp-id'] = array(
+				'name'       => 'GRP_ID',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $GRP_ID,
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'GRP_ID'
+			);
             
-            $template_form_fields['ee-msg-messenger'] = array(
-                'name'       => 'MTP_messenger',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->messenger(),
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_messenger'
-            );
+			$template_form_fields['ee-msg-messenger'] = array(
+				'name'       => 'MTP_messenger',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->messenger(),
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_messenger'
+			);
             
-            $template_form_fields['ee-msg-message-type'] = array(
-                'name'       => 'MTP_message_type',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->message_type(),
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_message_type'
-            );
+			$template_form_fields['ee-msg-message-type'] = array(
+				'name'       => 'MTP_message_type',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->message_type(),
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_message_type'
+			);
             
-            $sidebar_form_fields['ee-msg-is-global'] = array(
-                'name'       => 'MTP_is_global',
-                'label'      => __('Global Template', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_is_global'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_global'
-            );
+			$sidebar_form_fields['ee-msg-is-global'] = array(
+				'name'       => 'MTP_is_global',
+				'label'      => __('Global Template', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_is_global'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_global'
+			);
             
-            $sidebar_form_fields['ee-msg-is-override'] = array(
-                'name'       => 'MTP_is_override',
-                'label'      => __('Override all custom', 'event_espresso'),
-                'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_is_override'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_override'
-            );
+			$sidebar_form_fields['ee-msg-is-override'] = array(
+				'name'       => 'MTP_is_override',
+				'label'      => __('Override all custom', 'event_espresso'),
+				'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_is_override'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_override'
+			);
             
-            $sidebar_form_fields['ee-msg-is-active'] = array(
-                'name'       => 'MTP_is_active',
-                'label'      => __('Active Template', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->is_active(),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_active'
-            );
+			$sidebar_form_fields['ee-msg-is-active'] = array(
+				'name'       => 'MTP_is_active',
+				'label'      => __('Active Template', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->is_active(),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_active'
+			);
             
-            $sidebar_form_fields['ee-msg-deleted'] = array(
-                'name'       => 'MTP_deleted',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_deleted'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_deleted'
-            );
-            $sidebar_form_fields['ee-msg-author']  = array(
-                'name'       => 'MTP_user_id',
-                'label'      => __('Author', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => false,
-                'value'      => $message_template_group->user(),
-                'format'     => '%d',
-                'db-col'     => 'MTP_user_id'
-            );
+			$sidebar_form_fields['ee-msg-deleted'] = array(
+				'name'       => 'MTP_deleted',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_deleted'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_deleted'
+			);
+			$sidebar_form_fields['ee-msg-author']  = array(
+				'name'       => 'MTP_user_id',
+				'label'      => __('Author', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => false,
+				'value'      => $message_template_group->user(),
+				'format'     => '%d',
+				'db-col'     => 'MTP_user_id'
+			);
             
-            $sidebar_form_fields['ee-msg-route'] = array(
-                'name'  => 'action',
-                'input' => 'hidden',
-                'type'  => 'string',
-                'value' => $action
-            );
+			$sidebar_form_fields['ee-msg-route'] = array(
+				'name'  => 'action',
+				'input' => 'hidden',
+				'type'  => 'string',
+				'value' => $action
+			);
             
-            $sidebar_form_fields['ee-msg-id']        = array(
-                'name'  => 'id',
-                'input' => 'hidden',
-                'type'  => 'int',
-                'value' => $GRP_ID
-            );
-            $sidebar_form_fields['ee-msg-evt-nonce'] = array(
-                'name'  => $action . '_nonce',
-                'input' => 'hidden',
-                'type'  => 'string',
-                'value' => wp_create_nonce($action . '_nonce')
-            );
+			$sidebar_form_fields['ee-msg-id']        = array(
+				'name'  => 'id',
+				'input' => 'hidden',
+				'type'  => 'int',
+				'value' => $GRP_ID
+			);
+			$sidebar_form_fields['ee-msg-evt-nonce'] = array(
+				'name'  => $action . '_nonce',
+				'input' => 'hidden',
+				'type'  => 'string',
+				'value' => wp_create_nonce($action . '_nonce')
+			);
             
-            if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
-                $sidebar_form_fields['ee-msg-template-switch'] = array(
-                    'name'  => 'template_switch',
-                    'input' => 'hidden',
-                    'type'  => 'int',
-                    'value' => 1
-                );
-            }
+			if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
+				$sidebar_form_fields['ee-msg-template-switch'] = array(
+					'name'  => 'template_switch',
+					'input' => 'hidden',
+					'type'  => 'int',
+					'value' => 1
+				);
+			}
             
             
-            $template_fields = $this->_generate_admin_form_fields($template_form_fields);
-            $sidebar_fields  = $this->_generate_admin_form_fields($sidebar_form_fields);
+			$template_fields = $this->_generate_admin_form_fields($template_form_fields);
+			$sidebar_fields  = $this->_generate_admin_form_fields($sidebar_form_fields);
             
             
-        } //end if ( !empty($template_field_structure) )
+		} //end if ( !empty($template_field_structure) )
         
-        //set extra content for publish box
-        $this->_template_args['publish_box_extra_content'] = $sidebar_fields;
-        $this->_set_publish_post_box_vars(
-            'id',
-            $GRP_ID,
-            false,
-            add_query_arg(
-                array('action' => 'global_mtps'),
-                $this->_admin_base_url
-            )
-        );
-        
-        //add preview button
-        $preview_url    = parent::add_query_args_and_nonce(
-            array(
-                'message_type' => $message_template_group->message_type(),
-                'messenger'    => $message_template_group->messenger(),
-                'context'      => $context,
-                'GRP_ID'       => $GRP_ID,
-                'action'       => 'preview_message'
-            ),
-            $this->_admin_base_url
-        );
-        $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">' . __('Preview',
-                'event_espresso') . '</a>';
-        
-        
-        //setup context switcher
-        $context_switcher_args = array(
-            'page'    => 'espresso_messages',
-            'action'  => 'edit_message_template',
-            'id'      => $GRP_ID,
-            'context' => $context,
-            'extra'   => $preview_button
-        );
-        $this->_set_context_switcher($message_template_group, $context_switcher_args);
-        
-        
-        //main box
-        $this->_template_args['template_fields']                         = $template_fields;
-        $this->_template_args['sidebar_box_id']                          = 'details';
-        $this->_template_args['action']                                  = $action;
-        $this->_template_args['context']                                 = $context;
-        $this->_template_args['edit_message_template_form_url']          = $edit_message_template_form_url;
-        $this->_template_args['learn_more_about_message_templates_link'] = $this->_learn_more_about_message_templates_link();
-        
-        
-        $this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
-        $this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
-        $this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
-        
-        $this->_template_path = $this->_template_args['GRP_ID']
-            ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
-            : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
-        
-        //send along EE_Message_Template_Group object for further template use.
-        $this->_template_args['MTP'] = $message_template_group;
-        
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
-            $this->_template_args, true);
-        
-        
-        //finally, let's set the admin_page title
-        $this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title);
-        
-        
-        //we need to take care of setting the shortcodes property for use elsewhere.
-        $this->_set_shortcodes();
-        
-        
-        //final template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-    
-    
-    public function filter_tinymce_init($mceInit, $editor_id)
-    {
-        return $mceInit;
-    }
-    
-    
-    public function add_context_switcher()
-    {
-        return $this->_context_switcher;
-    }
-    
-    public function _add_form_element_before()
-    {
-        return '<form method="post" action="' . $this->_template_args["edit_message_template_form_url"] . '" id="ee-msg-edit-frm">';
-    }
-    
-    public function _add_form_element_after()
-    {
-        return '</form>';
-    }
-    
-    
-    /**
-     * This executes switching the template pack for a message template.
-     *
-     * @since 4.5.0
-     *
-     */
-    public function switch_template_pack()
-    {
-        $GRP_ID        = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
-        $template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : '';
-        
-        //verify we have needed values.
-        if (empty($GRP_ID) || empty($template_pack)) {
-            $this->_template_args['error'] = true;
-            EE_Error::add_error(__('The required date for switching templates is not available.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            //get template, set the new template_pack and then reset to default
-            /** @type EE_Message_Template_Group $message_template_group */
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+		//set extra content for publish box
+		$this->_template_args['publish_box_extra_content'] = $sidebar_fields;
+		$this->_set_publish_post_box_vars(
+			'id',
+			$GRP_ID,
+			false,
+			add_query_arg(
+				array('action' => 'global_mtps'),
+				$this->_admin_base_url
+			)
+		);
+        
+		//add preview button
+		$preview_url    = parent::add_query_args_and_nonce(
+			array(
+				'message_type' => $message_template_group->message_type(),
+				'messenger'    => $message_template_group->messenger(),
+				'context'      => $context,
+				'GRP_ID'       => $GRP_ID,
+				'action'       => 'preview_message'
+			),
+			$this->_admin_base_url
+		);
+		$preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">' . __('Preview',
+				'event_espresso') . '</a>';
+        
+        
+		//setup context switcher
+		$context_switcher_args = array(
+			'page'    => 'espresso_messages',
+			'action'  => 'edit_message_template',
+			'id'      => $GRP_ID,
+			'context' => $context,
+			'extra'   => $preview_button
+		);
+		$this->_set_context_switcher($message_template_group, $context_switcher_args);
+        
+        
+		//main box
+		$this->_template_args['template_fields']                         = $template_fields;
+		$this->_template_args['sidebar_box_id']                          = 'details';
+		$this->_template_args['action']                                  = $action;
+		$this->_template_args['context']                                 = $context;
+		$this->_template_args['edit_message_template_form_url']          = $edit_message_template_form_url;
+		$this->_template_args['learn_more_about_message_templates_link'] = $this->_learn_more_about_message_templates_link();
+        
+        
+		$this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
+		$this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
+		$this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
+        
+		$this->_template_path = $this->_template_args['GRP_ID']
+			? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
+			: EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
+        
+		//send along EE_Message_Template_Group object for further template use.
+		$this->_template_args['MTP'] = $message_template_group;
+        
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
+			$this->_template_args, true);
+        
+        
+		//finally, let's set the admin_page title
+		$this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title);
+        
+        
+		//we need to take care of setting the shortcodes property for use elsewhere.
+		$this->_set_shortcodes();
+        
+        
+		//final template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+    
+    
+	public function filter_tinymce_init($mceInit, $editor_id)
+	{
+		return $mceInit;
+	}
+    
+    
+	public function add_context_switcher()
+	{
+		return $this->_context_switcher;
+	}
+    
+	public function _add_form_element_before()
+	{
+		return '<form method="post" action="' . $this->_template_args["edit_message_template_form_url"] . '" id="ee-msg-edit-frm">';
+	}
+    
+	public function _add_form_element_after()
+	{
+		return '</form>';
+	}
+    
+    
+	/**
+	 * This executes switching the template pack for a message template.
+	 *
+	 * @since 4.5.0
+	 *
+	 */
+	public function switch_template_pack()
+	{
+		$GRP_ID        = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
+		$template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : '';
+        
+		//verify we have needed values.
+		if (empty($GRP_ID) || empty($template_pack)) {
+			$this->_template_args['error'] = true;
+			EE_Error::add_error(__('The required date for switching templates is not available.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__);
+		} else {
+			//get template, set the new template_pack and then reset to default
+			/** @type EE_Message_Template_Group $message_template_group */
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
             
-            $message_template_group->set_template_pack_name($template_pack);
-            $this->_req_data['msgr'] = $message_template_group->messenger();
-            $this->_req_data['mt']   = $message_template_group->message_type();
+			$message_template_group->set_template_pack_name($template_pack);
+			$this->_req_data['msgr'] = $message_template_group->messenger();
+			$this->_req_data['mt']   = $message_template_group->message_type();
             
-            $query_args = $this->_reset_to_default_template();
+			$query_args = $this->_reset_to_default_template();
             
-            if (empty($query_args['id'])) {
-                EE_Error::add_error(
-                    __(
-                        'Something went wrong with switching the template pack. Please try again or contact EE support',
-                        'event_espresso'
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                $this->_template_args['error'] = true;
-            } else {
-                $template_label       = $message_template_group->get_template_pack()->label;
-                $template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
-                EE_Error::add_success(
-                    sprintf(
-                        __(
-                            'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
-                            'event_espresso'
-                        ),
-                        $template_label,
-                        $template_pack_labels->template_pack
-                    )
-                );
-                //generate the redirect url for js.
-                $url                                          = self::add_query_args_and_nonce($query_args,
-                    $this->_admin_base_url);
-                $this->_template_args['data']['redirect_url'] = $url;
-                $this->_template_args['success']              = true;
-            }
+			if (empty($query_args['id'])) {
+				EE_Error::add_error(
+					__(
+						'Something went wrong with switching the template pack. Please try again or contact EE support',
+						'event_espresso'
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				$this->_template_args['error'] = true;
+			} else {
+				$template_label       = $message_template_group->get_template_pack()->label;
+				$template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
+				EE_Error::add_success(
+					sprintf(
+						__(
+							'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
+							'event_espresso'
+						),
+						$template_label,
+						$template_pack_labels->template_pack
+					)
+				);
+				//generate the redirect url for js.
+				$url                                          = self::add_query_args_and_nonce($query_args,
+					$this->_admin_base_url);
+				$this->_template_args['data']['redirect_url'] = $url;
+				$this->_template_args['success']              = true;
+			}
             
-            $this->_return_json();
+			$this->_return_json();
             
-        }
-    }
-    
-    
-    /**
-     * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
-     * they want.
-     *
-     * @access protected
-     * @return array|null
-     */
-    protected function _reset_to_default_template()
-    {
-        
-        $templates = array();
-        $GRP_ID    = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
-        //we need to make sure we've got the info we need.
-        if ( ! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
-            EE_Error::add_error(
-                __(
-                    'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        
-        // all templates will be reset to whatever the defaults are
-        // for the global template matching the messenger and message type.
-        $success = ! empty($GRP_ID) ? true : false;
-        
-        if ($success) {
+		}
+	}
+    
+    
+	/**
+	 * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
+	 * they want.
+	 *
+	 * @access protected
+	 * @return array|null
+	 */
+	protected function _reset_to_default_template()
+	{
+        
+		$templates = array();
+		$GRP_ID    = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
+		//we need to make sure we've got the info we need.
+		if ( ! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
+			EE_Error::add_error(
+				__(
+					'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+        
+		// all templates will be reset to whatever the defaults are
+		// for the global template matching the messenger and message type.
+		$success = ! empty($GRP_ID) ? true : false;
+        
+		if ($success) {
             
-            //let's first determine if the incoming template is a global template,
-            // if it isn't then we need to get the global template matching messenger and message type.
-            //$MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
+			//let's first determine if the incoming template is a global template,
+			// if it isn't then we need to get the global template matching messenger and message type.
+			//$MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
             
             
-            //note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
-            $success = $this->_delete_mtp_permanently($GRP_ID, false);
+			//note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
+			$success = $this->_delete_mtp_permanently($GRP_ID, false);
             
-            if ($success) {
-                // if successfully deleted, lets generate the new ones.
-                // Note. We set GLOBAL to true, because resets on ANY template
-                // will use the related global template defaults for regeneration.
-                // This means that if a custom template is reset it resets to whatever the related global template is.
-                // HOWEVER, we DO keep the template pack and template variation set
-                // for the current custom template when resetting.
-                $templates = $this->_generate_new_templates(
-                    $this->_req_data['msgr'],
-                    $this->_req_data['mt'],
-                    $GRP_ID,
-                    true
-                );
-            }
+			if ($success) {
+				// if successfully deleted, lets generate the new ones.
+				// Note. We set GLOBAL to true, because resets on ANY template
+				// will use the related global template defaults for regeneration.
+				// This means that if a custom template is reset it resets to whatever the related global template is.
+				// HOWEVER, we DO keep the template pack and template variation set
+				// for the current custom template when resetting.
+				$templates = $this->_generate_new_templates(
+					$this->_req_data['msgr'],
+					$this->_req_data['mt'],
+					$GRP_ID,
+					true
+				);
+			}
             
-        }
-        
-        //any error messages?
-        if ( ! $success) {
-            EE_Error::add_error(
-                __('Something went wrong with deleting existing templates. Unable to reset to default',
-                    'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        
-        //all good, let's add a success message!
-        if ($success && ! empty($templates)) {
-            $templates = $templates[0]; //the info for the template we generated is the first element in the returned array.
-            EE_Error::overwrite_success();
-            EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso'));
-        }
-        
-        
-        $query_args = array(
-            'id'      => isset($templates['GRP_ID']) ? $templates['GRP_ID'] : null,
-            'context' => isset($templates['MTP_context']) ? $templates['MTP_context'] : null,
-            'action'  => isset($templates['GRP_ID']) ? 'edit_message_template' : 'global_mtps'
-        );
-        
-        //if called via ajax then we return query args otherwise redirect
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            return $query_args;
-        } else {
-            $this->_redirect_after_action(false, '', '', $query_args, true);
+		}
+        
+		//any error messages?
+		if ( ! $success) {
+			EE_Error::add_error(
+				__('Something went wrong with deleting existing templates. Unable to reset to default',
+					'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+        
+		//all good, let's add a success message!
+		if ($success && ! empty($templates)) {
+			$templates = $templates[0]; //the info for the template we generated is the first element in the returned array.
+			EE_Error::overwrite_success();
+			EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso'));
+		}
+        
+        
+		$query_args = array(
+			'id'      => isset($templates['GRP_ID']) ? $templates['GRP_ID'] : null,
+			'context' => isset($templates['MTP_context']) ? $templates['MTP_context'] : null,
+			'action'  => isset($templates['GRP_ID']) ? 'edit_message_template' : 'global_mtps'
+		);
+        
+		//if called via ajax then we return query args otherwise redirect
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			return $query_args;
+		} else {
+			$this->_redirect_after_action(false, '', '', $query_args, true);
             
-            return null;
-        }
-    }
-    
-    
-    /**
-     * Retrieve and set the message preview for display.
-     *
-     * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
-     *
-     * @return string
-     */
-    public function _preview_message($send = false)
-    {
-        //first make sure we've got the necessary parameters
-        if (
-        ! isset(
-            $this->_req_data['message_type'],
-            $this->_req_data['messenger'],
-            $this->_req_data['messenger'],
-            $this->_req_data['GRP_ID']
-        )
-        ) {
-            EE_Error::add_error(
-                __('Missing necessary parameters for displaying preview', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        
-        EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']);
-        
-        
-        //get the preview!
-        $preview = EED_Messages::preview_message($this->_req_data['message_type'], $this->_req_data['context'],
-            $this->_req_data['messenger'], $send);
-        
-        if ($send) {
-            return $preview;
-        }
-        
-        //let's add a button to go back to the edit view
-        $query_args             = array(
-            'id'      => $this->_req_data['GRP_ID'],
-            'context' => $this->_req_data['context'],
-            'action'  => 'edit_message_template'
-        );
-        $go_back_url            = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-        $preview_button         = '<a href="' . $go_back_url . '" class="button-secondary messages-preview-go-back-button">' . __('Go Back to Edit',
-                'event_espresso') . '</a>';
-        $message_types          = $this->get_installed_message_types();
-        $active_messenger       = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
-        $active_messenger_label = $active_messenger instanceof EE_messenger
-            ? ucwords($active_messenger->label['singular'])
-            : esc_html__('Unknown Messenger', 'event_espresso');
-        //let's provide a helpful title for context
-        $preview_title = sprintf(
-            __('Viewing Preview for %s %s Message Template', 'event_espresso'),
-            $active_messenger_label,
-            ucwords($message_types[$this->_req_data['message_type']]->label['singular'])
-        );
-        //setup display of preview.
-        $this->_admin_page_title                    = $preview_title;
-        $this->_template_args['admin_page_content'] = $preview_button . '<br />' . stripslashes($preview);
-        $this->_template_args['data']['force_json'] = true;
-        
-        return '';
-    }
-    
-    
-    /**
-     * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
-     * gets called automatically.
-     *
-     * @since 4.5.0
-     *
-     * @return string
-     */
-    protected function _display_preview_message()
-    {
-        $this->display_admin_page_with_no_sidebar();
-    }
-    
-    
-    /**
-     * registers metaboxes that should show up on the "edit_message_template" page
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _register_edit_meta_boxes()
-    {
-        add_meta_box('mtp_valid_shortcodes', __('Valid Shortcodes', 'event_espresso'),
-            array($this, 'shortcode_meta_box'), $this->_current_screen->id, 'side', 'default');
-        add_meta_box('mtp_extra_actions', __('Extra Actions', 'event_espresso'), array($this, 'extra_actions_meta_box'),
-            $this->_current_screen->id, 'side', 'high');
-        add_meta_box('mtp_templates', __('Template Styles', 'event_espresso'), array($this, 'template_pack_meta_box'),
-            $this->_current_screen->id, 'side', 'high');
-    }
-    
-    
-    /**
-     * metabox content for all template pack and variation selection.
-     *
-     * @since 4.5.0
-     *
-     * @return string
-     */
-    public function template_pack_meta_box()
-    {
-        $this->_set_message_template_group();
-        
-        $tp_collection = EEH_MSG_Template::get_template_pack_collection();
-        
-        $tp_select_values = array();
-        
-        foreach ($tp_collection as $tp) {
-            //only include template packs that support this messenger and message type!
-            $supports = $tp->get_supports();
-            if (
-                ! isset($supports[$this->_message_template_group->messenger()])
-                || ! in_array(
-                    $this->_message_template_group->message_type(),
-                    $supports[$this->_message_template_group->messenger()]
-                )
-            ) {
-                //not supported
-                continue;
-            }
+			return null;
+		}
+	}
+    
+    
+	/**
+	 * Retrieve and set the message preview for display.
+	 *
+	 * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
+	 *
+	 * @return string
+	 */
+	public function _preview_message($send = false)
+	{
+		//first make sure we've got the necessary parameters
+		if (
+		! isset(
+			$this->_req_data['message_type'],
+			$this->_req_data['messenger'],
+			$this->_req_data['messenger'],
+			$this->_req_data['GRP_ID']
+		)
+		) {
+			EE_Error::add_error(
+				__('Missing necessary parameters for displaying preview', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+        
+		EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']);
+        
+        
+		//get the preview!
+		$preview = EED_Messages::preview_message($this->_req_data['message_type'], $this->_req_data['context'],
+			$this->_req_data['messenger'], $send);
+        
+		if ($send) {
+			return $preview;
+		}
+        
+		//let's add a button to go back to the edit view
+		$query_args             = array(
+			'id'      => $this->_req_data['GRP_ID'],
+			'context' => $this->_req_data['context'],
+			'action'  => 'edit_message_template'
+		);
+		$go_back_url            = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+		$preview_button         = '<a href="' . $go_back_url . '" class="button-secondary messages-preview-go-back-button">' . __('Go Back to Edit',
+				'event_espresso') . '</a>';
+		$message_types          = $this->get_installed_message_types();
+		$active_messenger       = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
+		$active_messenger_label = $active_messenger instanceof EE_messenger
+			? ucwords($active_messenger->label['singular'])
+			: esc_html__('Unknown Messenger', 'event_espresso');
+		//let's provide a helpful title for context
+		$preview_title = sprintf(
+			__('Viewing Preview for %s %s Message Template', 'event_espresso'),
+			$active_messenger_label,
+			ucwords($message_types[$this->_req_data['message_type']]->label['singular'])
+		);
+		//setup display of preview.
+		$this->_admin_page_title                    = $preview_title;
+		$this->_template_args['admin_page_content'] = $preview_button . '<br />' . stripslashes($preview);
+		$this->_template_args['data']['force_json'] = true;
+        
+		return '';
+	}
+    
+    
+	/**
+	 * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
+	 * gets called automatically.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string
+	 */
+	protected function _display_preview_message()
+	{
+		$this->display_admin_page_with_no_sidebar();
+	}
+    
+    
+	/**
+	 * registers metaboxes that should show up on the "edit_message_template" page
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _register_edit_meta_boxes()
+	{
+		add_meta_box('mtp_valid_shortcodes', __('Valid Shortcodes', 'event_espresso'),
+			array($this, 'shortcode_meta_box'), $this->_current_screen->id, 'side', 'default');
+		add_meta_box('mtp_extra_actions', __('Extra Actions', 'event_espresso'), array($this, 'extra_actions_meta_box'),
+			$this->_current_screen->id, 'side', 'high');
+		add_meta_box('mtp_templates', __('Template Styles', 'event_espresso'), array($this, 'template_pack_meta_box'),
+			$this->_current_screen->id, 'side', 'high');
+	}
+    
+    
+	/**
+	 * metabox content for all template pack and variation selection.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string
+	 */
+	public function template_pack_meta_box()
+	{
+		$this->_set_message_template_group();
+        
+		$tp_collection = EEH_MSG_Template::get_template_pack_collection();
+        
+		$tp_select_values = array();
+        
+		foreach ($tp_collection as $tp) {
+			//only include template packs that support this messenger and message type!
+			$supports = $tp->get_supports();
+			if (
+				! isset($supports[$this->_message_template_group->messenger()])
+				|| ! in_array(
+					$this->_message_template_group->message_type(),
+					$supports[$this->_message_template_group->messenger()]
+				)
+			) {
+				//not supported
+				continue;
+			}
             
-            $tp_select_values[] = array(
-                'text' => $tp->label,
-                'id'   => $tp->dbref
-            );
-        }
-        
-        //if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by the default template pack.  This still allows for the odd template pack to override.
-        if (empty($tp_select_values)) {
-            $tp_select_values[] = array(
-                'text' => __('Default', 'event_espresso'),
-                'id'   => 'default'
-            );
-        }
-        
-        //setup variation select values for the currently selected template.
-        $variations               = $this->_message_template_group->get_template_pack()->get_variations(
-            $this->_message_template_group->messenger(),
-            $this->_message_template_group->message_type()
-        );
-        $variations_select_values = array();
-        foreach ($variations as $variation => $label) {
-            $variations_select_values[] = array(
-                'text' => $label,
-                'id'   => $variation
-            );
-        }
-        
-        $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
-        
-        $template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
-            'MTP_template_pack',
-            $tp_select_values,
-            $this->_message_template_group->get_template_pack_name()
-        );
-        $template_args['variations_selector']            = EEH_Form_Fields::select_input(
-            'MTP_template_variation',
-            $variations_select_values,
-            $this->_message_template_group->get_template_pack_variation()
-        );
-        $template_args['template_pack_label']            = $template_pack_labels->template_pack;
-        $template_args['template_variation_label']       = $template_pack_labels->template_variation;
-        $template_args['template_pack_description']      = $template_pack_labels->template_pack_description;
-        $template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
-        
-        $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
-        
-        EEH_Template::display_template($template, $template_args);
-    }
-    
-    
-    /**
-     * This meta box holds any extra actions related to Message Templates
-     * For now, this includes Resetting templates to defaults and sending a test email.
-     *
-     * @access  public
-     * @return void
-     * @throws \EE_Error
-     */
-    public function extra_actions_meta_box()
-    {
-        $template_form_fields = array();
-        
-        $extra_args = array(
-            'msgr'   => $this->_message_template_group->messenger(),
-            'mt'     => $this->_message_template_group->message_type(),
-            'GRP_ID' => $this->_message_template_group->GRP_ID()
-        );
-        //first we need to see if there are any fields
-        $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
-        
-        if ( ! empty($fields)) {
-            //yup there be fields
-            foreach ($fields as $field => $config) {
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
-                $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
-                $default  = isset($config['default']) ? $config['default'] : '';
-                $default  = isset($config['value']) ? $config['value'] : $default;
+			$tp_select_values[] = array(
+				'text' => $tp->label,
+				'id'   => $tp->dbref
+			);
+		}
+        
+		//if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by the default template pack.  This still allows for the odd template pack to override.
+		if (empty($tp_select_values)) {
+			$tp_select_values[] = array(
+				'text' => __('Default', 'event_espresso'),
+				'id'   => 'default'
+			);
+		}
+        
+		//setup variation select values for the currently selected template.
+		$variations               = $this->_message_template_group->get_template_pack()->get_variations(
+			$this->_message_template_group->messenger(),
+			$this->_message_template_group->message_type()
+		);
+		$variations_select_values = array();
+		foreach ($variations as $variation => $label) {
+			$variations_select_values[] = array(
+				'text' => $label,
+				'id'   => $variation
+			);
+		}
+        
+		$template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
+        
+		$template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
+			'MTP_template_pack',
+			$tp_select_values,
+			$this->_message_template_group->get_template_pack_name()
+		);
+		$template_args['variations_selector']            = EEH_Form_Fields::select_input(
+			'MTP_template_variation',
+			$variations_select_values,
+			$this->_message_template_group->get_template_pack_variation()
+		);
+		$template_args['template_pack_label']            = $template_pack_labels->template_pack;
+		$template_args['template_variation_label']       = $template_pack_labels->template_variation;
+		$template_args['template_pack_description']      = $template_pack_labels->template_pack_description;
+		$template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
+        
+		$template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
+        
+		EEH_Template::display_template($template, $template_args);
+	}
+    
+    
+	/**
+	 * This meta box holds any extra actions related to Message Templates
+	 * For now, this includes Resetting templates to defaults and sending a test email.
+	 *
+	 * @access  public
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function extra_actions_meta_box()
+	{
+		$template_form_fields = array();
+        
+		$extra_args = array(
+			'msgr'   => $this->_message_template_group->messenger(),
+			'mt'     => $this->_message_template_group->message_type(),
+			'GRP_ID' => $this->_message_template_group->GRP_ID()
+		);
+		//first we need to see if there are any fields
+		$fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
+        
+		if ( ! empty($fields)) {
+			//yup there be fields
+			foreach ($fields as $field => $config) {
+				$field_id = $this->_message_template_group->messenger() . '_' . $field;
+				$existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
+				$default  = isset($config['default']) ? $config['default'] : '';
+				$default  = isset($config['value']) ? $config['value'] : $default;
                 
-                // if type is hidden and the value is empty
-                // something may have gone wrong so let's correct with the defaults
-                $fix              = $config['input'] === 'hidden' && isset($existing[$field]) && empty($existing[$field])
-                    ? $default
-                    : '';
-                $existing[$field] = isset($existing[$field]) && empty($fix)
-                    ? $existing[$field]
-                    : $fix;
+				// if type is hidden and the value is empty
+				// something may have gone wrong so let's correct with the defaults
+				$fix              = $config['input'] === 'hidden' && isset($existing[$field]) && empty($existing[$field])
+					? $default
+					: '';
+				$existing[$field] = isset($existing[$field]) && empty($fix)
+					? $existing[$field]
+					: $fix;
                 
-                $template_form_fields[$field_id] = array(
-                    'name'       => 'test_settings_fld[' . $field . ']',
-                    'label'      => $config['label'],
-                    'input'      => $config['input'],
-                    'type'       => $config['type'],
-                    'required'   => $config['required'],
-                    'validation' => $config['validation'],
-                    'value'      => isset($existing[$field]) ? $existing[$field] : $default,
-                    'css_class'  => $config['css_class'],
-                    'options'    => isset($config['options']) ? $config['options'] : array(),
-                    'default'    => $default,
-                    'format'     => $config['format']
-                );
-            }
-        }
-        
-        $test_settings_fields = ! empty($template_form_fields)
-            ? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
-            : '';
-        
-        $test_settings_html = '';
-        //print out $test_settings_fields
-        if ( ! empty($test_settings_fields)) {
-            echo $test_settings_fields;
-            $test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
-            $test_settings_html .= 'name="test_button" value="';
-            $test_settings_html .= __('Test Send', 'event_espresso');
-            $test_settings_html .= '" /><div style="clear:both"></div>';
-        }
-        
-        //and button
-        $test_settings_html .= '<p>' . __('Need to reset this message type and start over?', 'event_espresso') . '</p>';
-        $test_settings_html .= '<div class="publishing-action alignright resetbutton">';
-        $test_settings_html .= $this->get_action_link_or_button(
-            'reset_to_default',
-            'reset',
-            $extra_args,
-            'button-primary reset-default-button'
-        );
-        $test_settings_html .= '</div><div style="clear:both"></div>';
-        echo $test_settings_html;
-    }
-    
-    
-    /**
-     * This returns the shortcode selector skeleton for a given context and field.
-     *
-     * @since 4.9.rc.000
-     *
-     * @param string $field           The name of the field retrieving shortcodes for.
-     * @param string $linked_input_id The css id of the input that the shortcodes get added to.
-     *
-     * @return string
-     */
-    protected function _get_shortcode_selector($field, $linked_input_id)
-    {
-        $template_args = array(
-            'shortcodes'      => $this->_get_shortcodes(array($field), true),
-            'fieldname'       => $field,
-            'linked_input_id' => $linked_input_id
-        );
-        
-        return EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
-            $template_args, true);
-    }
-    
-    
-    /**
-     * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
-     * page)
-     *
-     * @access public
-     * @return void
-     */
-    public function shortcode_meta_box()
-    {
-        $shortcodes = $this->_get_shortcodes(array(), false); //just make sure shortcodes property is set
-        //$messenger = $this->_message_template_group->messenger_obj();
-        //now let's set the content depending on the status of the shortcodes array
-        if (empty($shortcodes)) {
-            $content = '<p>' . __('There are no valid shortcodes available', 'event_espresso') . '</p>';
-            echo $content;
-        } else {
-            //$alt = 0;
-            ?>
+				$template_form_fields[$field_id] = array(
+					'name'       => 'test_settings_fld[' . $field . ']',
+					'label'      => $config['label'],
+					'input'      => $config['input'],
+					'type'       => $config['type'],
+					'required'   => $config['required'],
+					'validation' => $config['validation'],
+					'value'      => isset($existing[$field]) ? $existing[$field] : $default,
+					'css_class'  => $config['css_class'],
+					'options'    => isset($config['options']) ? $config['options'] : array(),
+					'default'    => $default,
+					'format'     => $config['format']
+				);
+			}
+		}
+        
+		$test_settings_fields = ! empty($template_form_fields)
+			? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
+			: '';
+        
+		$test_settings_html = '';
+		//print out $test_settings_fields
+		if ( ! empty($test_settings_fields)) {
+			echo $test_settings_fields;
+			$test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
+			$test_settings_html .= 'name="test_button" value="';
+			$test_settings_html .= __('Test Send', 'event_espresso');
+			$test_settings_html .= '" /><div style="clear:both"></div>';
+		}
+        
+		//and button
+		$test_settings_html .= '<p>' . __('Need to reset this message type and start over?', 'event_espresso') . '</p>';
+		$test_settings_html .= '<div class="publishing-action alignright resetbutton">';
+		$test_settings_html .= $this->get_action_link_or_button(
+			'reset_to_default',
+			'reset',
+			$extra_args,
+			'button-primary reset-default-button'
+		);
+		$test_settings_html .= '</div><div style="clear:both"></div>';
+		echo $test_settings_html;
+	}
+    
+    
+	/**
+	 * This returns the shortcode selector skeleton for a given context and field.
+	 *
+	 * @since 4.9.rc.000
+	 *
+	 * @param string $field           The name of the field retrieving shortcodes for.
+	 * @param string $linked_input_id The css id of the input that the shortcodes get added to.
+	 *
+	 * @return string
+	 */
+	protected function _get_shortcode_selector($field, $linked_input_id)
+	{
+		$template_args = array(
+			'shortcodes'      => $this->_get_shortcodes(array($field), true),
+			'fieldname'       => $field,
+			'linked_input_id' => $linked_input_id
+		);
+        
+		return EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
+			$template_args, true);
+	}
+    
+    
+	/**
+	 * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
+	 * page)
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function shortcode_meta_box()
+	{
+		$shortcodes = $this->_get_shortcodes(array(), false); //just make sure shortcodes property is set
+		//$messenger = $this->_message_template_group->messenger_obj();
+		//now let's set the content depending on the status of the shortcodes array
+		if (empty($shortcodes)) {
+			$content = '<p>' . __('There are no valid shortcodes available', 'event_espresso') . '</p>';
+			echo $content;
+		} else {
+			//$alt = 0;
+			?>
             <div
                 style="float:right; margin-top:10px"><?php echo $this->_get_help_tab_link('message_template_shortcodes'); ?></div>
             <p class="small-text"><?php printf(__('You can view the shortcodes usable in your template by clicking the %s icon next to each field.',
-                    'event_espresso'), '<span class="dashicons dashicons-menu"></span>'); ?></p>
+					'event_espresso'), '<span class="dashicons dashicons-menu"></span>'); ?></p>
             <?php
-        }
-        
-        
-    }
-    
-    
-    /**
-     * used to set the $_shortcodes property for when its needed elsewhere.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_shortcodes()
-    {
-        
-        //no need to run this if the property is already set
-        if ( ! empty($this->_shortcodes)) {
-            return;
-        }
-        
-        $this->_shortcodes = $this->_get_shortcodes();
-    }
-    
-    
-    /**
-     * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
-     * property)
-     *
-     * @access  protected
-     *
-     * @param  array   $fields include an array of specific field names that you want to be used to get the shortcodes
-     *                         for. Defaults to all (for the given context)
-     * @param  boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes
-     *
-     * @return array          Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
-     *                        true just an array of shortcode/label pairs.
-     */
-    protected function _get_shortcodes($fields = array(), $merged = true)
-    {
-        $this->_set_message_template_group();
-        
-        //we need the messenger and message template to retrieve the valid shortcodes array.
-        $GRP_ID  = isset($this->_req_data['id']) && ! empty($this->_req_data['id']) ? absint($this->_req_data['id']) : false;
-        $context = isset($this->_req_data['context']) ? $this->_req_data['context'] : key($this->_message_template_group->contexts_config());
-        
-        return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array();
-    }
-    
-    
-    /**
-     * This sets the _message_template property (containing the called message_template object)
-     *
-     * @access protected
-     * @return  void
-     */
-    protected function _set_message_template_group()
-    {
-        
-        if ( ! empty($this->_message_template_group)) {
-            return;
-        } //get out if this is already set.
-        
-        $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false;
-        $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID;
-        
-        //let's get the message templates
-        $MTP = EEM_Message_Template_Group::instance();
-        
-        if (empty($GRP_ID)) {
-            $this->_message_template_group = $MTP->create_default_object();
-        } else {
-            $this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
-        }
-        
-        $this->_template_pack = $this->_message_template_group->get_template_pack();
-        $this->_variation     = $this->_message_template_group->get_template_pack_variation();
-        
-    }
-    
-    
-    /**
-     * sets up a context switcher for edit forms
-     *
-     * @access  protected
-     *
-     * @param  EE_Message_Template_Group $template_group_object the template group object being displayed on the form
-     * @param array                      $args                  various things the context switcher needs.
-     *
-     */
-    protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
-    {
-        $context_details = $template_group_object->contexts_config();
-        $context_label   = $template_group_object->context_label();
-        ob_start();
-        ?>
+		}
+        
+        
+	}
+    
+    
+	/**
+	 * used to set the $_shortcodes property for when its needed elsewhere.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_shortcodes()
+	{
+        
+		//no need to run this if the property is already set
+		if ( ! empty($this->_shortcodes)) {
+			return;
+		}
+        
+		$this->_shortcodes = $this->_get_shortcodes();
+	}
+    
+    
+	/**
+	 * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
+	 * property)
+	 *
+	 * @access  protected
+	 *
+	 * @param  array   $fields include an array of specific field names that you want to be used to get the shortcodes
+	 *                         for. Defaults to all (for the given context)
+	 * @param  boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes
+	 *
+	 * @return array          Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
+	 *                        true just an array of shortcode/label pairs.
+	 */
+	protected function _get_shortcodes($fields = array(), $merged = true)
+	{
+		$this->_set_message_template_group();
+        
+		//we need the messenger and message template to retrieve the valid shortcodes array.
+		$GRP_ID  = isset($this->_req_data['id']) && ! empty($this->_req_data['id']) ? absint($this->_req_data['id']) : false;
+		$context = isset($this->_req_data['context']) ? $this->_req_data['context'] : key($this->_message_template_group->contexts_config());
+        
+		return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array();
+	}
+    
+    
+	/**
+	 * This sets the _message_template property (containing the called message_template object)
+	 *
+	 * @access protected
+	 * @return  void
+	 */
+	protected function _set_message_template_group()
+	{
+        
+		if ( ! empty($this->_message_template_group)) {
+			return;
+		} //get out if this is already set.
+        
+		$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false;
+		$GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID;
+        
+		//let's get the message templates
+		$MTP = EEM_Message_Template_Group::instance();
+        
+		if (empty($GRP_ID)) {
+			$this->_message_template_group = $MTP->create_default_object();
+		} else {
+			$this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
+		}
+        
+		$this->_template_pack = $this->_message_template_group->get_template_pack();
+		$this->_variation     = $this->_message_template_group->get_template_pack_variation();
+        
+	}
+    
+    
+	/**
+	 * sets up a context switcher for edit forms
+	 *
+	 * @access  protected
+	 *
+	 * @param  EE_Message_Template_Group $template_group_object the template group object being displayed on the form
+	 * @param array                      $args                  various things the context switcher needs.
+	 *
+	 */
+	protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
+	{
+		$context_details = $template_group_object->contexts_config();
+		$context_label   = $template_group_object->context_label();
+		ob_start();
+		?>
         <div class="ee-msg-switcher-container">
             <form method="get" action="<?php echo EE_MSG_ADMIN_URL; ?>" id="ee-msg-context-switcher-frm">
                 <?php
-                foreach ($args as $name => $value) {
-                    if ($name == 'context' || empty($value) || $name == 'extra') {
-                        continue;
-                    }
-                    ?>
+				foreach ($args as $name => $value) {
+					if ($name == 'context' || empty($value) || $name == 'extra') {
+						continue;
+					}
+					?>
                     <input type="hidden" name="<?php echo $name; ?>" value="<?php echo $value; ?>"/>
                     <?php
-                }
-                //setup nonce_url
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
-                ?>
+				}
+				//setup nonce_url
+				wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
+				?>
                 <select name="context">
                     <?php
-                    $context_templates = $template_group_object->context_templates();
-                    if (is_array($context_templates)) :
-                        foreach ($context_templates as $context => $template_fields) :
-                            $checked = ($context == $args['context']) ? 'selected="selected"' : '';
-                            ?>
+					$context_templates = $template_group_object->context_templates();
+					if (is_array($context_templates)) :
+						foreach ($context_templates as $context => $template_fields) :
+							$checked = ($context == $args['context']) ? 'selected="selected"' : '';
+							?>
                             <option value="<?php echo $context; ?>" <?php echo $checked; ?>>
                                 <?php echo $context_details[$context]['label']; ?>
                             </option>
@@ -2236,1584 +2236,1584 @@ 
             <?php echo $args['extra']; ?>
         </div> <!-- end .ee-msg-switcher-container -->
         <?php
-        $output = ob_get_contents();
-        ob_clean();
-        $this->_context_switcher = $output;
-    }
-    
-    
-    /**
-     * utility for sanitizing new values coming in.
-     * Note: this is only used when updating a context.
-     *
-     * @access protected
-     *
-     * @param int $index This helps us know which template field to select from the request array.
-     *
-     * @return array
-     */
-    protected function _set_message_template_column_values($index)
-    {
-        if (is_array($this->_req_data['MTP_template_fields'][$index]['content'])) {
-            foreach ($this->_req_data['MTP_template_fields'][$index]['content'] as $field => $value) {
-                $this->_req_data['MTP_template_fields'][$index]['content'][$field] = $value;
-            }
-        } /*else {
+		$output = ob_get_contents();
+		ob_clean();
+		$this->_context_switcher = $output;
+	}
+    
+    
+	/**
+	 * utility for sanitizing new values coming in.
+	 * Note: this is only used when updating a context.
+	 *
+	 * @access protected
+	 *
+	 * @param int $index This helps us know which template field to select from the request array.
+	 *
+	 * @return array
+	 */
+	protected function _set_message_template_column_values($index)
+	{
+		if (is_array($this->_req_data['MTP_template_fields'][$index]['content'])) {
+			foreach ($this->_req_data['MTP_template_fields'][$index]['content'] as $field => $value) {
+				$this->_req_data['MTP_template_fields'][$index]['content'][$field] = $value;
+			}
+		} /*else {
 			$this->_req_data['MTP_template_fields'][$index]['content'] = $this->_req_data['MTP_template_fields'][$index]['content'];
 		}*/
         
         
-        $set_column_values = array(
-            'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][$index]['MTP_ID']),
-            'GRP_ID'             => absint($this->_req_data['GRP_ID']),
-            'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
-            'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
-            'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
-            'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][$index]['name']),
-            'MTP_context'        => strtolower($this->_req_data['MTP_context']),
-            'MTP_content'        => $this->_req_data['MTP_template_fields'][$index]['content'],
-            'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
-                ? absint($this->_req_data['MTP_is_global'])
-                : 0,
-            'MTP_is_override'    => isset($this->_req_data['MTP_is_override'])
-                ? absint($this->_req_data['MTP_is_override'])
-                : 0,
-            'MTP_deleted'        => absint($this->_req_data['MTP_deleted']),
-            'MTP_is_active'      => absint($this->_req_data['MTP_is_active'])
-        );
-        
-        
-        return $set_column_values;
-    }
-    
-    
-    protected function _insert_or_update_message_template($new = false)
-    {
-        
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $success  = 0;
-        $override = false;
-        
-        //setup notices description
-        $messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : '';
-        
-        //need the message type and messenger objects to be able to use the labels for the notices
-        $messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
-        $messenger_label  = $messenger_object instanceof EE_messenger ? ucwords($messenger_object->label['singular']) : '';
-        
-        $message_type_slug   = ! empty($this->_req_data['MTP_message_type']) ? $this->_req_data['MTP_message_type'] : '';
-        $message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
-        
-        $message_type_label = $message_type_object instanceof EE_message_type
-            ? ucwords($message_type_object->label['singular'])
-            : '';
-        
-        $context_slug = ! empty($this->_req_data['MTP_context'])
-            ? $this->_req_data['MTP_context']
-            : '';
-        $context      = ucwords(str_replace('_', ' ', $context_slug));
-        
-        $item_desc = $messenger_label && $message_type_label ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' ' : '';
-        $item_desc .= 'Message Template';
-        $query_args  = array();
-        $edit_array  = array();
-        $action_desc = '';
-        
-        //if this is "new" then we need to generate the default contexts for the selected messenger/message_type for user to edit.
-        if ($new) {
-            $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
-            if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
-                if (empty($edit_array)) {
-                    $success = 0;
-                } else {
-                    $success    = 1;
-                    $edit_array = $edit_array[0];
-                    $query_args = array(
-                        'id'      => $edit_array['GRP_ID'],
-                        'context' => $edit_array['MTP_context'],
-                        'action'  => 'edit_message_template'
-                    );
-                }
-            }
-            $action_desc = 'created';
-        } else {
-            $MTPG = EEM_Message_Template_Group::instance();
-            $MTP  = EEM_Message_Template::instance();
+		$set_column_values = array(
+			'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][$index]['MTP_ID']),
+			'GRP_ID'             => absint($this->_req_data['GRP_ID']),
+			'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
+			'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
+			'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
+			'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][$index]['name']),
+			'MTP_context'        => strtolower($this->_req_data['MTP_context']),
+			'MTP_content'        => $this->_req_data['MTP_template_fields'][$index]['content'],
+			'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
+				? absint($this->_req_data['MTP_is_global'])
+				: 0,
+			'MTP_is_override'    => isset($this->_req_data['MTP_is_override'])
+				? absint($this->_req_data['MTP_is_override'])
+				: 0,
+			'MTP_deleted'        => absint($this->_req_data['MTP_deleted']),
+			'MTP_is_active'      => absint($this->_req_data['MTP_is_active'])
+		);
+        
+        
+		return $set_column_values;
+	}
+    
+    
+	protected function _insert_or_update_message_template($new = false)
+	{
+        
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$success  = 0;
+		$override = false;
+        
+		//setup notices description
+		$messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : '';
+        
+		//need the message type and messenger objects to be able to use the labels for the notices
+		$messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
+		$messenger_label  = $messenger_object instanceof EE_messenger ? ucwords($messenger_object->label['singular']) : '';
+        
+		$message_type_slug   = ! empty($this->_req_data['MTP_message_type']) ? $this->_req_data['MTP_message_type'] : '';
+		$message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
+        
+		$message_type_label = $message_type_object instanceof EE_message_type
+			? ucwords($message_type_object->label['singular'])
+			: '';
+        
+		$context_slug = ! empty($this->_req_data['MTP_context'])
+			? $this->_req_data['MTP_context']
+			: '';
+		$context      = ucwords(str_replace('_', ' ', $context_slug));
+        
+		$item_desc = $messenger_label && $message_type_label ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' ' : '';
+		$item_desc .= 'Message Template';
+		$query_args  = array();
+		$edit_array  = array();
+		$action_desc = '';
+        
+		//if this is "new" then we need to generate the default contexts for the selected messenger/message_type for user to edit.
+		if ($new) {
+			$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
+			if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
+				if (empty($edit_array)) {
+					$success = 0;
+				} else {
+					$success    = 1;
+					$edit_array = $edit_array[0];
+					$query_args = array(
+						'id'      => $edit_array['GRP_ID'],
+						'context' => $edit_array['MTP_context'],
+						'action'  => 'edit_message_template'
+					);
+				}
+			}
+			$action_desc = 'created';
+		} else {
+			$MTPG = EEM_Message_Template_Group::instance();
+			$MTP  = EEM_Message_Template::instance();
             
             
-            //run update for each template field in displayed context
-            if ( ! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
-                EE_Error::add_error(
-                    __('There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
-                        'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                $success = 0;
+			//run update for each template field in displayed context
+			if ( ! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
+				EE_Error::add_error(
+					__('There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
+						'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				$success = 0;
                 
-            } else {
-                //first validate all fields!
-                $validates = $MTPG->validate($this->_req_data['MTP_template_fields'], $context_slug, $messenger_slug,
-                    $message_type_slug);
+			} else {
+				//first validate all fields!
+				$validates = $MTPG->validate($this->_req_data['MTP_template_fields'], $context_slug, $messenger_slug,
+					$message_type_slug);
                 
-                //if $validate returned error messages (i.e. is_array()) then we need to process them and setup an appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.  WE need to make sure there is no actual error messages in validates.
-                if (is_array($validates) && ! empty($validates)) {
-                    //add the transient so when the form loads we know which fields to highlight
-                    $this->_add_transient('edit_message_template', $validates);
+				//if $validate returned error messages (i.e. is_array()) then we need to process them and setup an appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.  WE need to make sure there is no actual error messages in validates.
+				if (is_array($validates) && ! empty($validates)) {
+					//add the transient so when the form loads we know which fields to highlight
+					$this->_add_transient('edit_message_template', $validates);
                     
-                    $success = 0;
+					$success = 0;
                     
-                    //setup notices
-                    foreach ($validates as $field => $error) {
-                        if (isset($error['msg'])) {
-                            EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
-                        }
-                    }
+					//setup notices
+					foreach ($validates as $field => $error) {
+						if (isset($error['msg'])) {
+							EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
+						}
+					}
                     
-                } else {
-                    $set_column_values = array();
-                    foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) {
-                        $set_column_values = $this->_set_message_template_column_values($template_field);
+				} else {
+					$set_column_values = array();
+					foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) {
+						$set_column_values = $this->_set_message_template_column_values($template_field);
                         
-                        $where_cols_n_values = array(
-                            'MTP_ID' => $this->_req_data['MTP_template_fields'][$template_field]['MTP_ID']
-                        );
+						$where_cols_n_values = array(
+							'MTP_ID' => $this->_req_data['MTP_template_fields'][$template_field]['MTP_ID']
+						);
                         
-                        $message_template_fields = array(
-                            'GRP_ID'             => $set_column_values['GRP_ID'],
-                            'MTP_template_field' => $set_column_values['MTP_template_field'],
-                            'MTP_context'        => $set_column_values['MTP_context'],
-                            'MTP_content'        => $set_column_values['MTP_content']
-                        );
-                        if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) {
-                            if ($updated === false) {
-                                EE_Error::add_error(
-                                    sprintf(
-                                        __('%s field was NOT updated for some reason', 'event_espresso'),
-                                        $template_field
-                                    ),
-                                    __FILE__, __FUNCTION__, __LINE__
-                                );
-                            } else {
-                                $success = 1;
-                            }
-                        }
-                        $action_desc = 'updated';
-                    }
+						$message_template_fields = array(
+							'GRP_ID'             => $set_column_values['GRP_ID'],
+							'MTP_template_field' => $set_column_values['MTP_template_field'],
+							'MTP_context'        => $set_column_values['MTP_context'],
+							'MTP_content'        => $set_column_values['MTP_content']
+						);
+						if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) {
+							if ($updated === false) {
+								EE_Error::add_error(
+									sprintf(
+										__('%s field was NOT updated for some reason', 'event_espresso'),
+										$template_field
+									),
+									__FILE__, __FUNCTION__, __LINE__
+								);
+							} else {
+								$success = 1;
+							}
+						}
+						$action_desc = 'updated';
+					}
                     
-                    //we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
-                    $mtpg_fields = array(
-                        'MTP_user_id'      => $set_column_values['MTP_user_id'],
-                        'MTP_messenger'    => $set_column_values['MTP_messenger'],
-                        'MTP_message_type' => $set_column_values['MTP_message_type'],
-                        'MTP_is_global'    => $set_column_values['MTP_is_global'],
-                        'MTP_is_override'  => $set_column_values['MTP_is_override'],
-                        'MTP_deleted'      => $set_column_values['MTP_deleted'],
-                        'MTP_is_active'    => $set_column_values['MTP_is_active'],
-                        'MTP_name'         => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name'])
-                            ? $this->_req_data['ee_msg_non_global_fields']['MTP_name']
-                            : '',
-                        'MTP_description'  => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description'])
-                            ? $this->_req_data['ee_msg_non_global_fields']['MTP_description']
-                            : ''
-                    );
+					//we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
+					$mtpg_fields = array(
+						'MTP_user_id'      => $set_column_values['MTP_user_id'],
+						'MTP_messenger'    => $set_column_values['MTP_messenger'],
+						'MTP_message_type' => $set_column_values['MTP_message_type'],
+						'MTP_is_global'    => $set_column_values['MTP_is_global'],
+						'MTP_is_override'  => $set_column_values['MTP_is_override'],
+						'MTP_deleted'      => $set_column_values['MTP_deleted'],
+						'MTP_is_active'    => $set_column_values['MTP_is_active'],
+						'MTP_name'         => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name'])
+							? $this->_req_data['ee_msg_non_global_fields']['MTP_name']
+							: '',
+						'MTP_description'  => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description'])
+							? $this->_req_data['ee_msg_non_global_fields']['MTP_description']
+							: ''
+					);
                     
-                    $mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']);
-                    $updated    = $MTPG->update($mtpg_fields, array($mtpg_where));
+					$mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']);
+					$updated    = $MTPG->update($mtpg_fields, array($mtpg_where));
                     
-                    if ($updated === false) {
-                        EE_Error::add_error(
-                            sprintf(
-                                __('The Message Template Group (%d) was NOT updated for some reason', 'event_espresso'),
-                                $set_column_values['GRP_ID']
-                            ),
-                            __FILE__, __FUNCTION__, __LINE__
-                        );
-                    } else {
-                        //k now we need to ensure the template_pack and template_variation fields are set.
-                        $template_pack = ! empty($this->_req_data['MTP_template_pack'])
-                            ? $this->_req_data['MTP_template_pack']
-                            : 'default';
+					if ($updated === false) {
+						EE_Error::add_error(
+							sprintf(
+								__('The Message Template Group (%d) was NOT updated for some reason', 'event_espresso'),
+								$set_column_values['GRP_ID']
+							),
+							__FILE__, __FUNCTION__, __LINE__
+						);
+					} else {
+						//k now we need to ensure the template_pack and template_variation fields are set.
+						$template_pack = ! empty($this->_req_data['MTP_template_pack'])
+							? $this->_req_data['MTP_template_pack']
+							: 'default';
                         
-                        $template_variation = ! empty($this->_req_data['MTP_template_variation'])
-                            ? $this->_req_data['MTP_template_variation']
-                            : 'default';
+						$template_variation = ! empty($this->_req_data['MTP_template_variation'])
+							? $this->_req_data['MTP_template_variation']
+							: 'default';
                         
-                        $mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
-                        if ($mtpg_obj instanceof EE_Message_Template_Group) {
-                            $mtpg_obj->set_template_pack_name($template_pack);
-                            $mtpg_obj->set_template_pack_variation($template_variation);
-                        }
-                        $success = 1;
-                    }
-                }
-            }
+						$mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
+						if ($mtpg_obj instanceof EE_Message_Template_Group) {
+							$mtpg_obj->set_template_pack_name($template_pack);
+							$mtpg_obj->set_template_pack_variation($template_variation);
+						}
+						$success = 1;
+					}
+				}
+			}
             
-        }
-        
-        //we return things differently if doing ajax
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $this->_template_args['success'] = $success;
-            $this->_template_args['error']   = ! $success ? true : false;
-            $this->_template_args['content'] = '';
-            $this->_template_args['data']    = array(
-                'grpID'        => $edit_array['GRP_ID'],
-                'templateName' => $edit_array['template_name']
-            );
-            if ($success) {
-                EE_Error::overwrite_success();
-                EE_Error::add_success(__('The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
-                    'event_espresso'));
-            }
+		}
+        
+		//we return things differently if doing ajax
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$this->_template_args['success'] = $success;
+			$this->_template_args['error']   = ! $success ? true : false;
+			$this->_template_args['content'] = '';
+			$this->_template_args['data']    = array(
+				'grpID'        => $edit_array['GRP_ID'],
+				'templateName' => $edit_array['template_name']
+			);
+			if ($success) {
+				EE_Error::overwrite_success();
+				EE_Error::add_success(__('The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
+					'event_espresso'));
+			}
             
-            $this->_return_json();
-        }
-        
-        
-        //was a test send triggered?
-        if (isset($this->_req_data['test_button'])) {
-            EE_Error::overwrite_success();
-            $this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
-            $override = true;
-        }
-        
-        if (empty($query_args)) {
-            $query_args = array(
-                'id'      => $this->_req_data['GRP_ID'],
-                'context' => $context_slug,
-                'action'  => 'edit_message_template'
-            );
-        }
-        
-        $this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
-    }
-    
-    
-    /**
-     * processes a test send request to do an actual messenger delivery test for the given message template being tested
-     *
-     * @param  string $context      what context being tested
-     * @param  string $messenger    messenger being tested
-     * @param  string $message_type message type being tested
-     *
-     */
-    protected function _do_test_send($context, $messenger, $message_type)
-    {
-        //set things up for preview
-        $this->_req_data['messenger']    = $messenger;
-        $this->_req_data['message_type'] = $message_type;
-        $this->_req_data['context']      = $context;
-        $this->_req_data['GRP_ID']       = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : '';
-        $active_messenger                = $this->_message_resource_manager->get_active_messenger($messenger);
-        
-        //let's save any existing fields that might be required by the messenger
-        if (
-            isset($this->_req_data['test_settings_fld'])
-            && $active_messenger instanceof EE_messenger
-            && apply_filters(
-                'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
-                true,
-                $this->_req_data['test_settings_fld'],
-                $active_messenger
-            )
-        ) {
-            $active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']);
-        }
-        
-        $success = $this->_preview_message(true);
-        
-        if ($success) {
-            EE_Error::add_success(__('Test message sent', 'event_espresso'));
-        } else {
-            EE_Error::add_error(__('The test message was not sent', 'event_espresso'), __FILE__, __FUNCTION__,
-                __LINE__);
-        }
-    }
-    
-    
-    /**
-     * _generate_new_templates
-     * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
-     * automatically create the defaults for the event.  The user would then be redirected to edit the default context
-     * for the event.
-     *
-     *
-     * @param  string $messenger     the messenger we are generating templates for
-     * @param array   $message_types array of message types that the templates are generated for.
-     * @param int     $GRP_ID        If this is a custom template being generated then a GRP_ID needs to be included to
-     *                               indicate the message_template_group being used as the base.
-     *
-     * @param bool    $global
-     *
-     * @return array|bool array of data required for the redirect to the correct edit page or bool if
-     *                               encountering problems.
-     * @throws \EE_Error
-     */
-    protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
-    {
-        
-        //if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we just don't generate any templates.
-        if (empty($message_types)) {
-            return true;
-        }
-        
-        return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
-    }
-    
-    
-    /**
-     * [_trash_or_restore_message_template]
-     *
-     * @param  boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE)
-     * @param boolean  $all   whether this is going to trash/restore all contexts within a template group (TRUE) OR just
-     *                        an individual context (FALSE).
-     *
-     * @return void
-     */
-    protected function _trash_or_restore_message_template($trash = true, $all = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $MTP = EEM_Message_Template_Group::instance();
-        
-        $success = 1;
-        
-        //incoming GRP_IDs
-        if ($all) {
-            //Checkboxes
-            if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-                //if array has more than one element then success message should be plural.
-                //todo: what about nonce?
-                $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			$this->_return_json();
+		}
+        
+        
+		//was a test send triggered?
+		if (isset($this->_req_data['test_button'])) {
+			EE_Error::overwrite_success();
+			$this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
+			$override = true;
+		}
+        
+		if (empty($query_args)) {
+			$query_args = array(
+				'id'      => $this->_req_data['GRP_ID'],
+				'context' => $context_slug,
+				'action'  => 'edit_message_template'
+			);
+		}
+        
+		$this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
+	}
+    
+    
+	/**
+	 * processes a test send request to do an actual messenger delivery test for the given message template being tested
+	 *
+	 * @param  string $context      what context being tested
+	 * @param  string $messenger    messenger being tested
+	 * @param  string $message_type message type being tested
+	 *
+	 */
+	protected function _do_test_send($context, $messenger, $message_type)
+	{
+		//set things up for preview
+		$this->_req_data['messenger']    = $messenger;
+		$this->_req_data['message_type'] = $message_type;
+		$this->_req_data['context']      = $context;
+		$this->_req_data['GRP_ID']       = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : '';
+		$active_messenger                = $this->_message_resource_manager->get_active_messenger($messenger);
+        
+		//let's save any existing fields that might be required by the messenger
+		if (
+			isset($this->_req_data['test_settings_fld'])
+			&& $active_messenger instanceof EE_messenger
+			&& apply_filters(
+				'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
+				true,
+				$this->_req_data['test_settings_fld'],
+				$active_messenger
+			)
+		) {
+			$active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']);
+		}
+        
+		$success = $this->_preview_message(true);
+        
+		if ($success) {
+			EE_Error::add_success(__('Test message sent', 'event_espresso'));
+		} else {
+			EE_Error::add_error(__('The test message was not sent', 'event_espresso'), __FILE__, __FUNCTION__,
+				__LINE__);
+		}
+	}
+    
+    
+	/**
+	 * _generate_new_templates
+	 * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
+	 * automatically create the defaults for the event.  The user would then be redirected to edit the default context
+	 * for the event.
+	 *
+	 *
+	 * @param  string $messenger     the messenger we are generating templates for
+	 * @param array   $message_types array of message types that the templates are generated for.
+	 * @param int     $GRP_ID        If this is a custom template being generated then a GRP_ID needs to be included to
+	 *                               indicate the message_template_group being used as the base.
+	 *
+	 * @param bool    $global
+	 *
+	 * @return array|bool array of data required for the redirect to the correct edit page or bool if
+	 *                               encountering problems.
+	 * @throws \EE_Error
+	 */
+	protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
+	{
+        
+		//if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we just don't generate any templates.
+		if (empty($message_types)) {
+			return true;
+		}
+        
+		return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
+	}
+    
+    
+	/**
+	 * [_trash_or_restore_message_template]
+	 *
+	 * @param  boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE)
+	 * @param boolean  $all   whether this is going to trash/restore all contexts within a template group (TRUE) OR just
+	 *                        an individual context (FALSE).
+	 *
+	 * @return void
+	 */
+	protected function _trash_or_restore_message_template($trash = true, $all = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$MTP = EEM_Message_Template_Group::instance();
+        
+		$success = 1;
+        
+		//incoming GRP_IDs
+		if ($all) {
+			//Checkboxes
+			if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+				//if array has more than one element then success message should be plural.
+				//todo: what about nonce?
+				$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
                 
-                //cycle through checkboxes
-                while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
-                    if ( ! $trashed_or_restored) {
-                        $success = 0;
-                    }
-                }
-            } else {
-                //grab single GRP_ID and handle
-                $GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
-                if ( ! empty($GRP_ID)) {
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
-                    if ( ! $trashed_or_restored) {
-                        $success = 0;
-                    }
-                } else {
-                    $success = 0;
-                }
-            }
+				//cycle through checkboxes
+				while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
+					if ( ! $trashed_or_restored) {
+						$success = 0;
+					}
+				}
+			} else {
+				//grab single GRP_ID and handle
+				$GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
+				if ( ! empty($GRP_ID)) {
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
+					if ( ! $trashed_or_restored) {
+						$success = 0;
+					}
+				} else {
+					$success = 0;
+				}
+			}
             
-        }
+		}
         
-        $action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso');
+		$action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso');
         
-        $action_desc = ! empty($this->_req_data['template_switch']) ? __('switched') : $action_desc;
+		$action_desc = ! empty($this->_req_data['template_switch']) ? __('switched') : $action_desc;
         
-        $item_desc = $all ? _n('Message Template Group', 'Message Template Groups', $success,
-            'event_espresso') : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
+		$item_desc = $all ? _n('Message Template Group', 'Message Template Groups', $success,
+			'event_espresso') : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
         
-        $item_desc = ! empty($this->_req_data['template_switch']) ? _n('template', 'templates', $success,
-            'event_espresso') : $item_desc;
+		$item_desc = ! empty($this->_req_data['template_switch']) ? _n('template', 'templates', $success,
+			'event_espresso') : $item_desc;
         
-        $this->_redirect_after_action($success, $item_desc, $action_desc, array());
+		$this->_redirect_after_action($success, $item_desc, $action_desc, array());
         
-    }
+	}
     
     
-    /**
-     * [_delete_message_template]
-     * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
-     * @return void
-     */
-    protected function _delete_message_template()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+	/**
+	 * [_delete_message_template]
+	 * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
+	 * @return void
+	 */
+	protected function _delete_message_template()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         
-        //checkboxes
-        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            //if array has more than one element then success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+		//checkboxes
+		if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			//if array has more than one element then success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
             
-            //cycle through bulk action checkboxes
-            while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
-                $success = $this->_delete_mtp_permanently($GRP_ID);
-            }
-        } else {
-            //grab single grp_id and delete
-            $GRP_ID  = absint($this->_req_data['id']);
-            $success = $this->_delete_mtp_permanently($GRP_ID);
-        }
-        
-        $this->_redirect_after_action($success, 'Message Templates', 'deleted', array());
-        
-    }
-    
-    
-    /**
-     * helper for permanently deleting a mtP group and all related message_templates
-     *
-     * @param  int  $GRP_ID        The group being deleted
-     * @param  bool $include_group whether to delete the Message Template Group as well.
-     *
-     * @return bool        boolean to indicate the success of the deletes or not.
-     */
-    private function _delete_mtp_permanently($GRP_ID, $include_group = true)
-    {
-        $success = 1;
-        $MTPG    = EEM_Message_Template_Group::instance();
-        //first let's GET this group
-        $MTG = $MTPG->get_one_by_ID($GRP_ID);
-        //then delete permanently all the related Message Templates
-        $deleted = $MTG->delete_related_permanently('Message_Template');
-        
-        if ($deleted === 0) {
-            $success = 0;
-        }
-        
-        //now delete permanently this particular group
-        
-        if ($include_group && ! $MTG->delete_permanently()) {
-            $success = 0;
-        }
-        
-        return $success;
-    }
-    
-    
-    /**
-     *    _learn_more_about_message_templates_link
-     * @access protected
-     * @return string
-     */
-    protected function _learn_more_about_message_templates_link()
-    {
-        return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >' . __('learn more about how message templates works',
-            'event_espresso') . '</a>';
-    }
-    
-    
-    /**
-     * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
-     * ajax and other routes.
-     * @return void
-     */
-    protected function _settings()
-    {
-        
-        
-        $this->_set_m_mt_settings();
-        
-        $selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email';
-        
-        //let's setup the messenger tabs
-        $this->_template_args['admin_page_header']         = EEH_Tabbed_Content::tab_text_links($this->_m_mt_settings['messenger_tabs'],
-            'messenger_links', '|', $selected_messenger);
-        $this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
-        $this->_template_args['after_admin_page_content']  = '</div><!-- end .ui-widget -->';
-        
-        $this->display_admin_page_with_sidebar();
-        
-    }
-    
-    
-    /**
-     * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_m_mt_settings()
-    {
-        //first if this is already set then lets get out no need to regenerate data.
-        if ( ! empty($this->_m_mt_settings)) {
-            return;
-        }
-        
-        //$selected_messenger = isset( $this->_req_data['selected_messenger'] ) ? $this->_req_data['selected_messenger'] : 'email';
-        
-        //get all installed messengers and message_types
-        /** @type EE_messenger[] $messengers */
-        $messengers = $this->_message_resource_manager->installed_messengers();
-        /** @type EE_message_type[] $message_types */
-        $message_types = $this->_message_resource_manager->installed_message_types();
-        
-        
-        //assemble the array for the _tab_text_links helper
-        
-        foreach ($messengers as $messenger) {
-            $this->_m_mt_settings['messenger_tabs'][$messenger->name] = array(
-                'label' => ucwords($messenger->label['singular']),
-                'class' => $this->_message_resource_manager->is_messenger_active($messenger->name) ? 'messenger-active' : '',
-                'href'  => $messenger->name,
-                'title' => __('Modify this Messenger', 'event_espresso'),
-                'slug'  => $messenger->name,
-                'obj'   => $messenger
-            );
+			//cycle through bulk action checkboxes
+			while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
+				$success = $this->_delete_mtp_permanently($GRP_ID);
+			}
+		} else {
+			//grab single grp_id and delete
+			$GRP_ID  = absint($this->_req_data['id']);
+			$success = $this->_delete_mtp_permanently($GRP_ID);
+		}
+        
+		$this->_redirect_after_action($success, 'Message Templates', 'deleted', array());
+        
+	}
+    
+    
+	/**
+	 * helper for permanently deleting a mtP group and all related message_templates
+	 *
+	 * @param  int  $GRP_ID        The group being deleted
+	 * @param  bool $include_group whether to delete the Message Template Group as well.
+	 *
+	 * @return bool        boolean to indicate the success of the deletes or not.
+	 */
+	private function _delete_mtp_permanently($GRP_ID, $include_group = true)
+	{
+		$success = 1;
+		$MTPG    = EEM_Message_Template_Group::instance();
+		//first let's GET this group
+		$MTG = $MTPG->get_one_by_ID($GRP_ID);
+		//then delete permanently all the related Message Templates
+		$deleted = $MTG->delete_related_permanently('Message_Template');
+        
+		if ($deleted === 0) {
+			$success = 0;
+		}
+        
+		//now delete permanently this particular group
+        
+		if ($include_group && ! $MTG->delete_permanently()) {
+			$success = 0;
+		}
+        
+		return $success;
+	}
+    
+    
+	/**
+	 *    _learn_more_about_message_templates_link
+	 * @access protected
+	 * @return string
+	 */
+	protected function _learn_more_about_message_templates_link()
+	{
+		return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >' . __('learn more about how message templates works',
+			'event_espresso') . '</a>';
+	}
+    
+    
+	/**
+	 * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
+	 * ajax and other routes.
+	 * @return void
+	 */
+	protected function _settings()
+	{
+        
+        
+		$this->_set_m_mt_settings();
+        
+		$selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email';
+        
+		//let's setup the messenger tabs
+		$this->_template_args['admin_page_header']         = EEH_Tabbed_Content::tab_text_links($this->_m_mt_settings['messenger_tabs'],
+			'messenger_links', '|', $selected_messenger);
+		$this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
+		$this->_template_args['after_admin_page_content']  = '</div><!-- end .ui-widget -->';
+        
+		$this->display_admin_page_with_sidebar();
+        
+	}
+    
+    
+	/**
+	 * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_m_mt_settings()
+	{
+		//first if this is already set then lets get out no need to regenerate data.
+		if ( ! empty($this->_m_mt_settings)) {
+			return;
+		}
+        
+		//$selected_messenger = isset( $this->_req_data['selected_messenger'] ) ? $this->_req_data['selected_messenger'] : 'email';
+        
+		//get all installed messengers and message_types
+		/** @type EE_messenger[] $messengers */
+		$messengers = $this->_message_resource_manager->installed_messengers();
+		/** @type EE_message_type[] $message_types */
+		$message_types = $this->_message_resource_manager->installed_message_types();
+        
+        
+		//assemble the array for the _tab_text_links helper
+        
+		foreach ($messengers as $messenger) {
+			$this->_m_mt_settings['messenger_tabs'][$messenger->name] = array(
+				'label' => ucwords($messenger->label['singular']),
+				'class' => $this->_message_resource_manager->is_messenger_active($messenger->name) ? 'messenger-active' : '',
+				'href'  => $messenger->name,
+				'title' => __('Modify this Messenger', 'event_espresso'),
+				'slug'  => $messenger->name,
+				'obj'   => $messenger
+			);
             
             
-            $message_types_for_messenger = $messenger->get_valid_message_types();
+			$message_types_for_messenger = $messenger->get_valid_message_types();
             
-            foreach ($message_types as $message_type) {
-                //first we need to verify that this message type is valid with this messenger. Cause if it isn't then it shouldn't show in either the inactive OR active metabox.
-                if ( ! in_array($message_type->name, $message_types_for_messenger)) {
-                    continue;
-                }
+			foreach ($message_types as $message_type) {
+				//first we need to verify that this message type is valid with this messenger. Cause if it isn't then it shouldn't show in either the inactive OR active metabox.
+				if ( ! in_array($message_type->name, $message_types_for_messenger)) {
+					continue;
+				}
                 
-                $a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger($messenger->name,
-                    $message_type->name) ? 'active' : 'inactive';
+				$a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger($messenger->name,
+					$message_type->name) ? 'active' : 'inactive';
                 
-                $this->_m_mt_settings['message_type_tabs'][$messenger->name][$a_or_i][$message_type->name] = array(
-                    'label'    => ucwords($message_type->label['singular']),
-                    'class'    => 'message-type-' . $a_or_i,
-                    'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
-                    'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
-                    'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
-                    'title'    => $a_or_i == 'active'
-                        ? __('Drag this message type to the Inactive window to deactivate', 'event_espresso')
-                        : __('Drag this message type to the messenger to activate', 'event_espresso'),
-                    'content'  => $a_or_i == 'active'
-                        ? $this->_message_type_settings_content($message_type, $messenger, true)
-                        : $this->_message_type_settings_content($message_type, $messenger),
-                    'slug'     => $message_type->name,
-                    'active'   => $a_or_i == 'active' ? true : false,
-                    'obj'      => $message_type
-                );
-            }
-        }
-    }
-    
-    
-    /**
-     * This just prepares the content for the message type settings
-     *
-     * @param  object  $message_type The message type object
-     * @param  object  $messenger    The messenger object
-     * @param  boolean $active       Whether the message type is active or not
-     *
-     * @return string                html output for the content
-     */
-    protected function _message_type_settings_content($message_type, $messenger, $active = false)
-    {
-        //get message type fields
-        $fields                                         = $message_type->get_admin_settings_fields();
-        $settings_template_args['template_form_fields'] = '';
-        
-        if ( ! empty($fields) && $active) {
+				$this->_m_mt_settings['message_type_tabs'][$messenger->name][$a_or_i][$message_type->name] = array(
+					'label'    => ucwords($message_type->label['singular']),
+					'class'    => 'message-type-' . $a_or_i,
+					'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
+					'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
+					'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
+					'title'    => $a_or_i == 'active'
+						? __('Drag this message type to the Inactive window to deactivate', 'event_espresso')
+						: __('Drag this message type to the messenger to activate', 'event_espresso'),
+					'content'  => $a_or_i == 'active'
+						? $this->_message_type_settings_content($message_type, $messenger, true)
+						: $this->_message_type_settings_content($message_type, $messenger),
+					'slug'     => $message_type->name,
+					'active'   => $a_or_i == 'active' ? true : false,
+					'obj'      => $message_type
+				);
+			}
+		}
+	}
+    
+    
+	/**
+	 * This just prepares the content for the message type settings
+	 *
+	 * @param  object  $message_type The message type object
+	 * @param  object  $messenger    The messenger object
+	 * @param  boolean $active       Whether the message type is active or not
+	 *
+	 * @return string                html output for the content
+	 */
+	protected function _message_type_settings_content($message_type, $messenger, $active = false)
+	{
+		//get message type fields
+		$fields                                         = $message_type->get_admin_settings_fields();
+		$settings_template_args['template_form_fields'] = '';
+        
+		if ( ! empty($fields) && $active) {
             
-            $existing_settings = $message_type->get_existing_admin_settings($messenger->name);
+			$existing_settings = $message_type->get_existing_admin_settings($messenger->name);
             
-            foreach ($fields as $fldname => $fldprops) {
-                $field_id                       = $messenger->name . '-' . $message_type->name . '-' . $fldname;
-                $template_form_field[$field_id] = array(
-                    'name'       => 'message_type_settings[' . $fldname . ']',
-                    'label'      => $fldprops['label'],
-                    'input'      => $fldprops['field_type'],
-                    'type'       => $fldprops['value_type'],
-                    'required'   => $fldprops['required'],
-                    'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'],
-                    'options'    => isset($fldprops['options']) ? $fldprops['options'] : array(),
-                    'default'    => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'],
-                    'css_class'  => 'no-drag',
-                    'format'     => $fldprops['format']
-                );
-            }
+			foreach ($fields as $fldname => $fldprops) {
+				$field_id                       = $messenger->name . '-' . $message_type->name . '-' . $fldname;
+				$template_form_field[$field_id] = array(
+					'name'       => 'message_type_settings[' . $fldname . ']',
+					'label'      => $fldprops['label'],
+					'input'      => $fldprops['field_type'],
+					'type'       => $fldprops['value_type'],
+					'required'   => $fldprops['required'],
+					'validation' => $fldprops['validation'],
+					'value'      => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'],
+					'options'    => isset($fldprops['options']) ? $fldprops['options'] : array(),
+					'default'    => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'],
+					'css_class'  => 'no-drag',
+					'format'     => $fldprops['format']
+				);
+			}
             
             
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field) ? $this->_generate_admin_form_fields($template_form_field,
-                'string', 'ee_mt_activate_form') : '';
-        }
-        
-        $settings_template_args['description'] = $message_type->description;
-        //we also need some hidden fields
-        $settings_template_args['hidden_fields'] = array(
-            'message_type_settings[messenger]'    => array(
-                'type'  => 'hidden',
-                'value' => $messenger->name
-            ),
-            'message_type_settings[message_type]' => array(
-                'type'  => 'hidden',
-                'value' => $message_type->name
-            ),
-            'type'                                => array(
-                'type'  => 'hidden',
-                'value' => 'message_type'
-            )
-        );
-        
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields($settings_template_args['hidden_fields'],
-            'array');
-        $settings_template_args['show_form']     = empty($settings_template_args['template_form_fields']) ? ' hidden' : '';
-        
-        
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
-        $content  = EEH_Template::display_template($template, $settings_template_args, true);
-        
-        return $content;
-    }
-    
-    
-    /**
-     * Generate all the metaboxes for the message types and register them for the messages settings page.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _messages_settings_metaboxes()
-    {
-        $this->_set_m_mt_settings();
-        $m_boxes         = $mt_boxes = array();
-        $m_template_args = $mt_template_args = array();
-        
-        $selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email';
-        
-        if (isset($this->_m_mt_settings['messenger_tabs'])) {
-            foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
-                $hide_on_message  = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden';
-                $hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : '';
-                //messenger meta boxes
-                $active                                 = $selected_messenger == $messenger ? true : false;
-                $active_mt_tabs                         = isset($this->_m_mt_settings['message_type_tabs'][$messenger]['active'])
-                    ? $this->_m_mt_settings['message_type_tabs'][$messenger]['active']
-                    : '';
-                $m_boxes[$messenger . '_a_box']         = sprintf(
-                    __('%s Settings', 'event_espresso'),
-                    $tab_array['label']
-                );
-                $m_template_args[$messenger . '_a_box'] = array(
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
-                    'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
-                        : '',
-                    'content'                => $this->_get_messenger_box_content($tab_array['obj']),
-                    'hidden'                 => $active ? '' : ' hidden',
-                    'hide_on_message'        => $hide_on_message,
-                    'messenger'              => $messenger,
-                    'active'                 => $active
-                );
-                // message type meta boxes
-                // (which is really just the inactive container for each messenger
-                // showing inactive message types for that messenger)
-                $mt_boxes[$messenger . '_i_box']         = __('Inactive Message Types', 'event_espresso');
-                $mt_template_args[$messenger . '_i_box'] = array(
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
-                    'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
-                        : '',
-                    'hidden'                 => $active ? '' : ' hidden',
-                    'hide_on_message'        => $hide_on_message,
-                    'hide_off_message'       => $hide_off_message,
-                    'messenger'              => $messenger,
-                    'active'                 => $active
-                );
-            }
-        }
-        
-        
-        //register messenger metaboxes
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
-        foreach ($m_boxes as $box => $label) {
-            $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[$box]);
-            $msgr          = str_replace('_a_box', '', $box);
-            add_meta_box(
-                'espresso_' . $msgr . '_settings',
-                $label,
-                function ($post, $metabox) {
-                    echo EEH_Template::display_template($metabox["args"]["template_path"],
-                        $metabox["args"]["template_args"], true);
-                },
-                $this->_current_screen->id,
-                'normal',
-                'high',
-                $callback_args
-            );
-        }
-        
-        //register message type metaboxes
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
-        foreach ($mt_boxes as $box => $label) {
-            $callback_args = array(
-                'template_path' => $mt_template_path,
-                'template_args' => $mt_template_args[$box]
-            );
-            $mt            = str_replace('_i_box', '', $box);
-            add_meta_box(
-                'espresso_' . $mt . '_inactive_mts',
-                $label,
-                function ($post, $metabox) {
-                    echo EEH_Template::display_template($metabox["args"]["template_path"],
-                        $metabox["args"]["template_args"], true);
-                },
-                $this->_current_screen->id,
-                'side',
-                'high',
-                $callback_args
-            );
-        }
-        
-        //register metabox for global messages settings but only when on the main site.  On single site installs this will
-        //always result in the metabox showing, on multisite installs the metabox will only show on the main site.
-        if (is_main_site()) {
-            add_meta_box(
-                'espresso_global_message_settings',
-                __('Global Message Settings', 'event_espresso'),
-                array($this, 'global_messages_settings_metabox_content'),
-                $this->_current_screen->id,
-                'normal',
-                'low',
-                array()
-            );
-        }
-        
-    }
-    
-    
-    /**
-     *  This generates the content for the global messages settings metabox.
-     * @return string
-     */
-    public function global_messages_settings_metabox_content()
-    {
-        $form = $this->_generate_global_settings_form();
-        echo $form->form_open(
-                $this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL),
-                'POST'
-            )
-             . $form->get_html()
-             . $form->form_close();
-    }
-    
-    
-    /**
-     * This generates and returns the form object for the global messages settings.
-     * @return EE_Form_Section_Proper
-     */
-    protected function _generate_global_settings_form()
-    {
-        EE_Registry::instance()->load_helper('HTML');
-        /** @var EE_Network_Core_Config $network_config */
-        $network_config = EE_Registry::instance()->NET_CFG->core;
-        
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'global_messages_settings',
-                'html_id'         => 'global_messages_settings',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
-                    array(
-                        'do_messages_on_same_request' => new EE_Select_Input(
-                            array(
-                                true  => esc_html__("On the same request", "event_espresso"),
-                                false => esc_html__("On a separate request", "event_espresso")
-                            ),
-                            array(
-                                'default'         => $network_config->do_messages_on_same_request,
-                                'html_label_text' => esc_html__('Generate and send all messages:', 'event_espresso'),
-                                'html_help_text'  => esc_html__('By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
-                                    'event_espresso'),
-                            )
-                        ),
-                        'delete_threshold' => new EE_Select_Input(
-                            array(
-                                0 => esc_html__('Forever', 'event_espresso'),
-                                3 => esc_html__('3 Months', 'event_espresso'),
-                                6 => esc_html__('6 Months', 'event_espresso'),
-                                9 => esc_html__('9 Months', 'event_espresso'),
-                                12 => esc_html__('12 Months', 'event_espresso'),
-                                24 => esc_html__('24 Months', 'event_espresso'),
-                                36 => esc_html__('36 Months', 'event_espresso')
-                            ),
-                            array(
-                                'default' => EE_Registry::instance()->CFG->messages->delete_threshold,
-                                'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
-                                'html_help_text' => esc_html__('You can control how long a record of processed messages is kept 
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field) ? $this->_generate_admin_form_fields($template_form_field,
+				'string', 'ee_mt_activate_form') : '';
+		}
+        
+		$settings_template_args['description'] = $message_type->description;
+		//we also need some hidden fields
+		$settings_template_args['hidden_fields'] = array(
+			'message_type_settings[messenger]'    => array(
+				'type'  => 'hidden',
+				'value' => $messenger->name
+			),
+			'message_type_settings[message_type]' => array(
+				'type'  => 'hidden',
+				'value' => $message_type->name
+			),
+			'type'                                => array(
+				'type'  => 'hidden',
+				'value' => 'message_type'
+			)
+		);
+        
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields($settings_template_args['hidden_fields'],
+			'array');
+		$settings_template_args['show_form']     = empty($settings_template_args['template_form_fields']) ? ' hidden' : '';
+        
+        
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
+		$content  = EEH_Template::display_template($template, $settings_template_args, true);
+        
+		return $content;
+	}
+    
+    
+	/**
+	 * Generate all the metaboxes for the message types and register them for the messages settings page.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _messages_settings_metaboxes()
+	{
+		$this->_set_m_mt_settings();
+		$m_boxes         = $mt_boxes = array();
+		$m_template_args = $mt_template_args = array();
+        
+		$selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email';
+        
+		if (isset($this->_m_mt_settings['messenger_tabs'])) {
+			foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
+				$hide_on_message  = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden';
+				$hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : '';
+				//messenger meta boxes
+				$active                                 = $selected_messenger == $messenger ? true : false;
+				$active_mt_tabs                         = isset($this->_m_mt_settings['message_type_tabs'][$messenger]['active'])
+					? $this->_m_mt_settings['message_type_tabs'][$messenger]['active']
+					: '';
+				$m_boxes[$messenger . '_a_box']         = sprintf(
+					__('%s Settings', 'event_espresso'),
+					$tab_array['label']
+				);
+				$m_template_args[$messenger . '_a_box'] = array(
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
+					'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
+						: '',
+					'content'                => $this->_get_messenger_box_content($tab_array['obj']),
+					'hidden'                 => $active ? '' : ' hidden',
+					'hide_on_message'        => $hide_on_message,
+					'messenger'              => $messenger,
+					'active'                 => $active
+				);
+				// message type meta boxes
+				// (which is really just the inactive container for each messenger
+				// showing inactive message types for that messenger)
+				$mt_boxes[$messenger . '_i_box']         = __('Inactive Message Types', 'event_espresso');
+				$mt_template_args[$messenger . '_i_box'] = array(
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
+					'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
+						: '',
+					'hidden'                 => $active ? '' : ' hidden',
+					'hide_on_message'        => $hide_on_message,
+					'hide_off_message'       => $hide_off_message,
+					'messenger'              => $messenger,
+					'active'                 => $active
+				);
+			}
+		}
+        
+        
+		//register messenger metaboxes
+		$m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
+		foreach ($m_boxes as $box => $label) {
+			$callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[$box]);
+			$msgr          = str_replace('_a_box', '', $box);
+			add_meta_box(
+				'espresso_' . $msgr . '_settings',
+				$label,
+				function ($post, $metabox) {
+					echo EEH_Template::display_template($metabox["args"]["template_path"],
+						$metabox["args"]["template_args"], true);
+				},
+				$this->_current_screen->id,
+				'normal',
+				'high',
+				$callback_args
+			);
+		}
+        
+		//register message type metaboxes
+		$mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
+		foreach ($mt_boxes as $box => $label) {
+			$callback_args = array(
+				'template_path' => $mt_template_path,
+				'template_args' => $mt_template_args[$box]
+			);
+			$mt            = str_replace('_i_box', '', $box);
+			add_meta_box(
+				'espresso_' . $mt . '_inactive_mts',
+				$label,
+				function ($post, $metabox) {
+					echo EEH_Template::display_template($metabox["args"]["template_path"],
+						$metabox["args"]["template_args"], true);
+				},
+				$this->_current_screen->id,
+				'side',
+				'high',
+				$callback_args
+			);
+		}
+        
+		//register metabox for global messages settings but only when on the main site.  On single site installs this will
+		//always result in the metabox showing, on multisite installs the metabox will only show on the main site.
+		if (is_main_site()) {
+			add_meta_box(
+				'espresso_global_message_settings',
+				__('Global Message Settings', 'event_espresso'),
+				array($this, 'global_messages_settings_metabox_content'),
+				$this->_current_screen->id,
+				'normal',
+				'low',
+				array()
+			);
+		}
+        
+	}
+    
+    
+	/**
+	 *  This generates the content for the global messages settings metabox.
+	 * @return string
+	 */
+	public function global_messages_settings_metabox_content()
+	{
+		$form = $this->_generate_global_settings_form();
+		echo $form->form_open(
+				$this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL),
+				'POST'
+			)
+			 . $form->get_html()
+			 . $form->form_close();
+	}
+    
+    
+	/**
+	 * This generates and returns the form object for the global messages settings.
+	 * @return EE_Form_Section_Proper
+	 */
+	protected function _generate_global_settings_form()
+	{
+		EE_Registry::instance()->load_helper('HTML');
+		/** @var EE_Network_Core_Config $network_config */
+		$network_config = EE_Registry::instance()->NET_CFG->core;
+        
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'global_messages_settings',
+				'html_id'         => 'global_messages_settings',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
+					array(
+						'do_messages_on_same_request' => new EE_Select_Input(
+							array(
+								true  => esc_html__("On the same request", "event_espresso"),
+								false => esc_html__("On a separate request", "event_espresso")
+							),
+							array(
+								'default'         => $network_config->do_messages_on_same_request,
+								'html_label_text' => esc_html__('Generate and send all messages:', 'event_espresso'),
+								'html_help_text'  => esc_html__('By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
+									'event_espresso'),
+							)
+						),
+						'delete_threshold' => new EE_Select_Input(
+							array(
+								0 => esc_html__('Forever', 'event_espresso'),
+								3 => esc_html__('3 Months', 'event_espresso'),
+								6 => esc_html__('6 Months', 'event_espresso'),
+								9 => esc_html__('9 Months', 'event_espresso'),
+								12 => esc_html__('12 Months', 'event_espresso'),
+								24 => esc_html__('24 Months', 'event_espresso'),
+								36 => esc_html__('36 Months', 'event_espresso')
+							),
+							array(
+								'default' => EE_Registry::instance()->CFG->messages->delete_threshold,
+								'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
+								'html_help_text' => esc_html__('You can control how long a record of processed messages is kept 
                                                     via this option.', 'event_espresso'),
-                            )
-                        ),
-                        'update_settings'             => new EE_Submit_Input(
-                            array(
-                                'default'         => esc_html__('Update', 'event_espresso'),
-                                'html_label_text' => '&nbsp'
-                            )
-                        )
-                    )
-                )
-            )
-        );
-    }
-    
-    
-    /**
-     * This handles updating the global settings set on the admin page.
-     * @throws \EE_Error
-     */
-    protected function _update_global_settings()
-    {
-        /** @var EE_Network_Core_Config $network_config */
-        $network_config = EE_Registry::instance()->NET_CFG->core;
-        $messages_config = EE_Registry::instance()->CFG->messages;
-        $form           = $this->_generate_global_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $valid_data = $form->valid_data();
-                foreach ($valid_data as $property => $value) {
-                    $setter = 'set_' . $property;
-                    if (method_exists($network_config, $setter)) {
-                        $network_config->{$setter}($value);
-                    } else if (
-                        property_exists($network_config, $property)
-                        && $network_config->{$property} !== $value
-                    ) {
-                        $network_config->{$property} = $value;
-                    } else if (
-                        property_exists($messages_config, $property)
-                        && $messages_config->{$property} !== $value
-                    ) {
-                        $messages_config->{$property} = $value;
-                    }
-                }
-                //only update if the form submission was valid!
-                EE_Registry::instance()->NET_CFG->update_config(true, false);
-                EE_Registry::instance()->CFG->update_espresso_config();
-                EE_Error::overwrite_success();
-                EE_Error::add_success(__('Global message settings were updated', 'event_espresso'));
-            }
-        }
-        $this->_redirect_after_action(0, '', '', array('action' => 'settings'), true);
-    }
-    
-    
-    /**
-     * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
-     *
-     * @param  array $tab_array This is an array of message type tab details used to generate the tabs
-     *
-     * @return string            html formatted tabs
-     */
-    protected function _get_mt_tabs($tab_array)
-    {
-        $tab_array = (array)$tab_array;
-        $template  = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
-        $tabs      = '';
-        
-        foreach ($tab_array as $tab) {
-            $tabs .= EEH_Template::display_template($template, $tab, true);
-        }
-        
-        return $tabs;
-    }
-    
-    
-    /**
-     * This prepares the content of the messenger meta box admin settings
-     *
-     * @param  EE_messenger $messenger The messenger we're setting up content for
-     *
-     * @return string            html formatted content
-     */
-    protected function _get_messenger_box_content(EE_messenger $messenger)
-    {
-        
-        $fields                                         = $messenger->get_admin_settings_fields();
-        $settings_template_args['template_form_fields'] = '';
-        
-        //is $messenger active?
-        $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
-        
-        
-        if ( ! empty($fields)) {
+							)
+						),
+						'update_settings'             => new EE_Submit_Input(
+							array(
+								'default'         => esc_html__('Update', 'event_espresso'),
+								'html_label_text' => '&nbsp'
+							)
+						)
+					)
+				)
+			)
+		);
+	}
+    
+    
+	/**
+	 * This handles updating the global settings set on the admin page.
+	 * @throws \EE_Error
+	 */
+	protected function _update_global_settings()
+	{
+		/** @var EE_Network_Core_Config $network_config */
+		$network_config = EE_Registry::instance()->NET_CFG->core;
+		$messages_config = EE_Registry::instance()->CFG->messages;
+		$form           = $this->_generate_global_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$valid_data = $form->valid_data();
+				foreach ($valid_data as $property => $value) {
+					$setter = 'set_' . $property;
+					if (method_exists($network_config, $setter)) {
+						$network_config->{$setter}($value);
+					} else if (
+						property_exists($network_config, $property)
+						&& $network_config->{$property} !== $value
+					) {
+						$network_config->{$property} = $value;
+					} else if (
+						property_exists($messages_config, $property)
+						&& $messages_config->{$property} !== $value
+					) {
+						$messages_config->{$property} = $value;
+					}
+				}
+				//only update if the form submission was valid!
+				EE_Registry::instance()->NET_CFG->update_config(true, false);
+				EE_Registry::instance()->CFG->update_espresso_config();
+				EE_Error::overwrite_success();
+				EE_Error::add_success(__('Global message settings were updated', 'event_espresso'));
+			}
+		}
+		$this->_redirect_after_action(0, '', '', array('action' => 'settings'), true);
+	}
+    
+    
+	/**
+	 * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
+	 *
+	 * @param  array $tab_array This is an array of message type tab details used to generate the tabs
+	 *
+	 * @return string            html formatted tabs
+	 */
+	protected function _get_mt_tabs($tab_array)
+	{
+		$tab_array = (array)$tab_array;
+		$template  = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
+		$tabs      = '';
+        
+		foreach ($tab_array as $tab) {
+			$tabs .= EEH_Template::display_template($template, $tab, true);
+		}
+        
+		return $tabs;
+	}
+    
+    
+	/**
+	 * This prepares the content of the messenger meta box admin settings
+	 *
+	 * @param  EE_messenger $messenger The messenger we're setting up content for
+	 *
+	 * @return string            html formatted content
+	 */
+	protected function _get_messenger_box_content(EE_messenger $messenger)
+	{
+        
+		$fields                                         = $messenger->get_admin_settings_fields();
+		$settings_template_args['template_form_fields'] = '';
+        
+		//is $messenger active?
+		$settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
+        
+        
+		if ( ! empty($fields)) {
             
-            $existing_settings = $messenger->get_existing_admin_settings();
+			$existing_settings = $messenger->get_existing_admin_settings();
             
-            foreach ($fields as $fldname => $fldprops) {
-                $field_id                       = $messenger->name . '-' . $fldname;
-                $template_form_field[$field_id] = array(
-                    'name'       => 'messenger_settings[' . $field_id . ']',
-                    'label'      => $fldprops['label'],
-                    'input'      => $fldprops['field_type'],
-                    'type'       => $fldprops['value_type'],
-                    'required'   => $fldprops['required'],
-                    'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[$field_id])
-                        ? $existing_settings[$field_id]
-                        : $fldprops['default'],
-                    'css_class'  => '',
-                    'format'     => $fldprops['format']
-                );
-            }
+			foreach ($fields as $fldname => $fldprops) {
+				$field_id                       = $messenger->name . '-' . $fldname;
+				$template_form_field[$field_id] = array(
+					'name'       => 'messenger_settings[' . $field_id . ']',
+					'label'      => $fldprops['label'],
+					'input'      => $fldprops['field_type'],
+					'type'       => $fldprops['value_type'],
+					'required'   => $fldprops['required'],
+					'validation' => $fldprops['validation'],
+					'value'      => isset($existing_settings[$field_id])
+						? $existing_settings[$field_id]
+						: $fldprops['default'],
+					'css_class'  => '',
+					'format'     => $fldprops['format']
+				);
+			}
             
             
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field)
-                ? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
-                : '';
-        }
-        
-        //we also need some hidden fields
-        $settings_template_args['hidden_fields'] = array(
-            'messenger_settings[messenger]' => array(
-                'type'  => 'hidden',
-                'value' => $messenger->name
-            ),
-            'type'                          => array(
-                'type'  => 'hidden',
-                'value' => 'messenger'
-            )
-        );
-        
-        //make sure any active message types that are existing are included in the hidden fields
-        if (isset($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'])) {
-            foreach ($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'] as $mt => $values) {
-                $settings_template_args['hidden_fields']['messenger_settings[message_types][' . $mt . ']'] = array(
-                    'type'  => 'hidden',
-                    'value' => $mt
-                );
-            }
-        }
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
-            $settings_template_args['hidden_fields'],
-            'array'
-        );
-        $active                                  = $this->_message_resource_manager->is_messenger_active($messenger->name);
-        
-        $settings_template_args['messenger']           = $messenger->name;
-        $settings_template_args['description']         = $messenger->description;
-        $settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
-        
-        
-        $settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active($messenger->name)
-            ? $settings_template_args['show_hide_edit_form']
-            : ' hidden';
-        
-        $settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
-            ? ' hidden'
-            : $settings_template_args['show_hide_edit_form'];
-        
-        
-        $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
-        $settings_template_args['nonce']         = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
-        $settings_template_args['on_off_status'] = $active ? true : false;
-        $template                                = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
-        $content                                 = EEH_Template::display_template($template, $settings_template_args,
-            true);
-        
-        return $content;
-    }
-    
-    
-    /**
-     * used by ajax on the messages settings page to activate|deactivate the messenger
-     */
-    public function activate_messenger_toggle()
-    {
-        $success = true;
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
-        //let's check that we have required data
-        if ( ! isset($this->_req_data['messenger'])) {
-            EE_Error::add_error(
-                __('Messenger name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        
-        //do a nonce check here since we're not arriving via a normal route
-        $nonce     = isset($this->_req_data['activate_nonce']) ? sanitize_text_field($this->_req_data['activate_nonce']) : '';
-        $nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
-        
-        $this->_verify_nonce($nonce, $nonce_ref);
-        
-        
-        if ( ! isset($this->_req_data['status'])) {
-            EE_Error::add_error(
-                __(
-                    'Messenger status needed to know whether activation or deactivation is happening. No status is given',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        
-        //do check to verify we have a valid status.
-        $status = $this->_req_data['status'];
-        
-        if ($status != 'off' && $status != 'on') {
-            EE_Error::add_error(
-                sprintf(
-                    __('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
-                    $this->_req_data['status']
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        
-        if ($success) {
-            //made it here?  Stop dawdling then!!
-            $success = $status == 'off'
-                ? $this->_deactivate_messenger($this->_req_data['messenger'])
-                : $this->_activate_messenger($this->_req_data['messenger']);
-        }
-        
-        $this->_template_args['success'] = $success;
-        
-        //no special instructions so let's just do the json return (which should automatically do all the special stuff).
-        $this->_return_json();
-        
-    }
-    
-    
-    /**
-     * used by ajax from the messages settings page to activate|deactivate a message type
-     *
-     */
-    public function activate_mt_toggle()
-    {
-        $success = true;
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
-        
-        //let's make sure we have the necessary data
-        if ( ! isset($this->_req_data['message_type'])) {
-            EE_Error::add_error(
-                __('Message Type name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $success = false;
-        }
-        
-        if ( ! isset($this->_req_data['messenger'])) {
-            EE_Error::add_error(
-                __('Messenger name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $success = false;
-        }
-        
-        if ( ! isset($this->_req_data['status'])) {
-            EE_Error::add_error(
-                __('Messenger status needed to know whether activation or deactivation is happening. No status is given',
-                    'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $success = false;
-        }
-        
-        
-        //do check to verify we have a valid status.
-        $status = $this->_req_data['status'];
-        
-        if ($status != 'activate' && $status != 'deactivate') {
-            EE_Error::add_error(
-                sprintf(
-                    __('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
-                    $this->_req_data['status']
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $success = false;
-        }
-        
-        
-        //do a nonce check here since we're not arriving via a normal route
-        $nonce     = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
-        $nonce_ref = $this->_req_data['message_type'] . '_nonce';
-        
-        $this->_verify_nonce($nonce, $nonce_ref);
-        
-        if ($success) {
-            //made it here? um, what are you waiting for then?
-            $success = $status == 'deactivate'
-                ? $this->_deactivate_message_type_for_messenger($this->_req_data['messenger'],
-                    $this->_req_data['message_type'])
-                : $this->_activate_message_type_for_messenger($this->_req_data['messenger'],
-                    $this->_req_data['message_type']);
-        }
-        
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-    
-    
-    /**
-     * Takes care of processing activating a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name The name of the messenger being activated
-     *
-     * @return bool
-     */
-    protected function _activate_messenger($messenger_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger          = $this->_message_resource_manager->get_messenger($messenger_name);
-        $message_types_to_activate = $active_messenger instanceof EE_Messenger ? $active_messenger->get_default_message_types() : array();
-        
-        //ensure is active
-        $this->_message_resource_manager->activate_messenger($messenger_name, $message_types_to_activate);
-        
-        //set response_data for reload
-        foreach ($message_types_to_activate as $message_type_name) {
-            /** @var EE_message_type $message_type */
-            $message_type = $this->_message_resource_manager->get_message_type($message_type_name);
-            if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name,
-                    $message_type_name)
-                && $message_type instanceof EE_message_type
-            ) {
-                $this->_template_args['data']['active_mts'][] = $message_type_name;
-                if ($message_type->get_admin_settings_fields()) {
-                    $this->_template_args['data']['mt_reload'][] = $message_type_name;
-                }
-            }
-        }
-        
-        //add success message for activating messenger
-        return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
-        
-    }
-    
-    
-    /**
-     * Takes care of processing deactivating a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name The name of the messenger being activated
-     *
-     * @return bool
-     */
-    protected function _deactivate_messenger($messenger_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        $this->_message_resource_manager->deactivate_messenger($messenger_name);
-        
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
-    }
-    
-    
-    /**
-     * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name    The name of the messenger the message type is being activated for.
-     * @param string $message_type_name The name of the message type being activated for the messenger
-     *
-     * @return bool
-     */
-    protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
-        $message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
-        
-        //ensure is active
-        $this->_message_resource_manager->activate_messenger($messenger_name, $message_type_name);
-        
-        //set response for load
-        if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name,
-            $message_type_name)
-        ) {
-            $this->_template_args['data']['active_mts'][] = $message_type_name;
-            if ($message_type_to_activate->get_admin_settings_fields()) {
-                $this->_template_args['data']['mt_reload'][] = $message_type_name;
-            }
-        }
-        
-        return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger,
-            $message_type_to_activate);
-    }
-    
-    
-    /**
-     * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
-     * @param string $message_type_name The name of the message type being deactivated for the messenger
-     *
-     * @return bool
-     */
-    protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
-        $message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
-        $this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
-        
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger,
-            $message_type_to_deactivate);
-    }
-    
-    
-    /**
-     * This just initializes the defaults for activating messenger and message type responses.
-     */
-    protected function _prep_default_response_for_messenger_or_message_type_toggle()
-    {
-        $this->_template_args['data']['active_mts'] = array();
-        $this->_template_args['data']['mt_reload']  = array();
-    }
-    
-    
-    /**
-     * Setup appropriate response for activating a messenger and/or message types
-     *
-     * @param EE_messenger         $messenger
-     * @param EE_message_type|null $message_type
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _setup_response_message_for_activating_messenger_with_message_types(
-        $messenger,
-        EE_Message_Type $message_type = null
-    ) {
-        //if $messenger isn't a valid messenger object then get out.
-        if ( ! $messenger instanceof EE_Messenger) {
-            EE_Error::add_error(
-                __('The messenger being activated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field)
+				? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
+				: '';
+		}
+        
+		//we also need some hidden fields
+		$settings_template_args['hidden_fields'] = array(
+			'messenger_settings[messenger]' => array(
+				'type'  => 'hidden',
+				'value' => $messenger->name
+			),
+			'type'                          => array(
+				'type'  => 'hidden',
+				'value' => 'messenger'
+			)
+		);
+        
+		//make sure any active message types that are existing are included in the hidden fields
+		if (isset($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'])) {
+			foreach ($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'] as $mt => $values) {
+				$settings_template_args['hidden_fields']['messenger_settings[message_types][' . $mt . ']'] = array(
+					'type'  => 'hidden',
+					'value' => $mt
+				);
+			}
+		}
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
+			$settings_template_args['hidden_fields'],
+			'array'
+		);
+		$active                                  = $this->_message_resource_manager->is_messenger_active($messenger->name);
+        
+		$settings_template_args['messenger']           = $messenger->name;
+		$settings_template_args['description']         = $messenger->description;
+		$settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
+        
+        
+		$settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active($messenger->name)
+			? $settings_template_args['show_hide_edit_form']
+			: ' hidden';
+        
+		$settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
+			? ' hidden'
+			: $settings_template_args['show_hide_edit_form'];
+        
+        
+		$settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
+		$settings_template_args['nonce']         = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
+		$settings_template_args['on_off_status'] = $active ? true : false;
+		$template                                = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
+		$content                                 = EEH_Template::display_template($template, $settings_template_args,
+			true);
+        
+		return $content;
+	}
+    
+    
+	/**
+	 * used by ajax on the messages settings page to activate|deactivate the messenger
+	 */
+	public function activate_messenger_toggle()
+	{
+		$success = true;
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
+		//let's check that we have required data
+		if ( ! isset($this->_req_data['messenger'])) {
+			EE_Error::add_error(
+				__('Messenger name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+        
+		//do a nonce check here since we're not arriving via a normal route
+		$nonce     = isset($this->_req_data['activate_nonce']) ? sanitize_text_field($this->_req_data['activate_nonce']) : '';
+		$nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
+        
+		$this->_verify_nonce($nonce, $nonce_ref);
+        
+        
+		if ( ! isset($this->_req_data['status'])) {
+			EE_Error::add_error(
+				__(
+					'Messenger status needed to know whether activation or deactivation is happening. No status is given',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+        
+		//do check to verify we have a valid status.
+		$status = $this->_req_data['status'];
+        
+		if ($status != 'off' && $status != 'on') {
+			EE_Error::add_error(
+				sprintf(
+					__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
+					$this->_req_data['status']
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+        
+		if ($success) {
+			//made it here?  Stop dawdling then!!
+			$success = $status == 'off'
+				? $this->_deactivate_messenger($this->_req_data['messenger'])
+				: $this->_activate_messenger($this->_req_data['messenger']);
+		}
+        
+		$this->_template_args['success'] = $success;
+        
+		//no special instructions so let's just do the json return (which should automatically do all the special stuff).
+		$this->_return_json();
+        
+	}
+    
+    
+	/**
+	 * used by ajax from the messages settings page to activate|deactivate a message type
+	 *
+	 */
+	public function activate_mt_toggle()
+	{
+		$success = true;
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
+        
+		//let's make sure we have the necessary data
+		if ( ! isset($this->_req_data['message_type'])) {
+			EE_Error::add_error(
+				__('Message Type name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$success = false;
+		}
+        
+		if ( ! isset($this->_req_data['messenger'])) {
+			EE_Error::add_error(
+				__('Messenger name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$success = false;
+		}
+        
+		if ( ! isset($this->_req_data['status'])) {
+			EE_Error::add_error(
+				__('Messenger status needed to know whether activation or deactivation is happening. No status is given',
+					'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$success = false;
+		}
+        
+        
+		//do check to verify we have a valid status.
+		$status = $this->_req_data['status'];
+        
+		if ($status != 'activate' && $status != 'deactivate') {
+			EE_Error::add_error(
+				sprintf(
+					__('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
+					$this->_req_data['status']
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$success = false;
+		}
+        
+        
+		//do a nonce check here since we're not arriving via a normal route
+		$nonce     = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
+		$nonce_ref = $this->_req_data['message_type'] . '_nonce';
+        
+		$this->_verify_nonce($nonce, $nonce_ref);
+        
+		if ($success) {
+			//made it here? um, what are you waiting for then?
+			$success = $status == 'deactivate'
+				? $this->_deactivate_message_type_for_messenger($this->_req_data['messenger'],
+					$this->_req_data['message_type'])
+				: $this->_activate_message_type_for_messenger($this->_req_data['messenger'],
+					$this->_req_data['message_type']);
+		}
+        
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+    
+    
+	/**
+	 * Takes care of processing activating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 *
+	 * @return bool
+	 */
+	protected function _activate_messenger($messenger_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger          = $this->_message_resource_manager->get_messenger($messenger_name);
+		$message_types_to_activate = $active_messenger instanceof EE_Messenger ? $active_messenger->get_default_message_types() : array();
+        
+		//ensure is active
+		$this->_message_resource_manager->activate_messenger($messenger_name, $message_types_to_activate);
+        
+		//set response_data for reload
+		foreach ($message_types_to_activate as $message_type_name) {
+			/** @var EE_message_type $message_type */
+			$message_type = $this->_message_resource_manager->get_message_type($message_type_name);
+			if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name,
+					$message_type_name)
+				&& $message_type instanceof EE_message_type
+			) {
+				$this->_template_args['data']['active_mts'][] = $message_type_name;
+				if ($message_type->get_admin_settings_fields()) {
+					$this->_template_args['data']['mt_reload'][] = $message_type_name;
+				}
+			}
+		}
+        
+		//add success message for activating messenger
+		return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
+        
+	}
+    
+    
+	/**
+	 * Takes care of processing deactivating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 *
+	 * @return bool
+	 */
+	protected function _deactivate_messenger($messenger_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		$this->_message_resource_manager->deactivate_messenger($messenger_name);
+        
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
+	}
+    
+    
+	/**
+	 * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name    The name of the messenger the message type is being activated for.
+	 * @param string $message_type_name The name of the message type being activated for the messenger
+	 *
+	 * @return bool
+	 */
+	protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
+		$message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
+        
+		//ensure is active
+		$this->_message_resource_manager->activate_messenger($messenger_name, $message_type_name);
+        
+		//set response for load
+		if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name,
+			$message_type_name)
+		) {
+			$this->_template_args['data']['active_mts'][] = $message_type_name;
+			if ($message_type_to_activate->get_admin_settings_fields()) {
+				$this->_template_args['data']['mt_reload'][] = $message_type_name;
+			}
+		}
+        
+		return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger,
+			$message_type_to_activate);
+	}
+    
+    
+	/**
+	 * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
+	 * @param string $message_type_name The name of the message type being deactivated for the messenger
+	 *
+	 * @return bool
+	 */
+	protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
+		$message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
+		$this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
+        
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger,
+			$message_type_to_deactivate);
+	}
+    
+    
+	/**
+	 * This just initializes the defaults for activating messenger and message type responses.
+	 */
+	protected function _prep_default_response_for_messenger_or_message_type_toggle()
+	{
+		$this->_template_args['data']['active_mts'] = array();
+		$this->_template_args['data']['mt_reload']  = array();
+	}
+    
+    
+	/**
+	 * Setup appropriate response for activating a messenger and/or message types
+	 *
+	 * @param EE_messenger         $messenger
+	 * @param EE_message_type|null $message_type
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _setup_response_message_for_activating_messenger_with_message_types(
+		$messenger,
+		EE_Message_Type $message_type = null
+	) {
+		//if $messenger isn't a valid messenger object then get out.
+		if ( ! $messenger instanceof EE_Messenger) {
+			EE_Error::add_error(
+				__('The messenger being activated is not a valid messenger', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
             
-            return false;
-        }
-        //activated
-        if ($this->_template_args['data']['active_mts']) {
-            EE_Error::overwrite_success();
-            //activated a message type with the messenger
-            if ($message_type instanceof EE_message_type) {
-                EE_Error::add_success(
-                    sprintf(
-                        __('%s message type has been successfully activated with the %s messenger', 'event_espresso'),
-                        ucwords($message_type->label['singular']),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
+			return false;
+		}
+		//activated
+		if ($this->_template_args['data']['active_mts']) {
+			EE_Error::overwrite_success();
+			//activated a message type with the messenger
+			if ($message_type instanceof EE_message_type) {
+				EE_Error::add_success(
+					sprintf(
+						__('%s message type has been successfully activated with the %s messenger', 'event_espresso'),
+						ucwords($message_type->label['singular']),
+						ucwords($messenger->label['singular'])
+					)
+				);
                 
-                //if message type was invoice then let's make sure we activate the invoice payment method.
-                if ($message_type->name == 'invoice') {
-                    EE_Registry::instance()->load_lib('Payment_Method_Manager');
-                    $pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
-                    if ($pm instanceof EE_Payment_Method) {
-                        EE_Error::add_attention(__('Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
-                            'event_espresso'));
-                    }
-                }
-                //just toggles the entire messenger
-            } else {
-                EE_Error::add_success(
-                    sprintf(
-                        __('%s messenger has been successfully activated', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
-            }
+				//if message type was invoice then let's make sure we activate the invoice payment method.
+				if ($message_type->name == 'invoice') {
+					EE_Registry::instance()->load_lib('Payment_Method_Manager');
+					$pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
+					if ($pm instanceof EE_Payment_Method) {
+						EE_Error::add_attention(__('Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
+							'event_espresso'));
+					}
+				}
+				//just toggles the entire messenger
+			} else {
+				EE_Error::add_success(
+					sprintf(
+						__('%s messenger has been successfully activated', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					)
+				);
+			}
             
-            return true;
+			return true;
             
-            //possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
-            //message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
-            //in which case we just give a success message for the messenger being successfully activated.
-        } else {
-            if ( ! $messenger->get_default_message_types()) {
-                //messenger doesn't have any default message types so still a success.
-                EE_Error::add_success(
-                    sprintf(
-                        __('%s messenger was successfully activated.', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
+			//possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
+			//message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
+			//in which case we just give a success message for the messenger being successfully activated.
+		} else {
+			if ( ! $messenger->get_default_message_types()) {
+				//messenger doesn't have any default message types so still a success.
+				EE_Error::add_success(
+					sprintf(
+						__('%s messenger was successfully activated.', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					)
+				);
                 
-                return true;
-            } else {
-                EE_Error::add_error(
-                    $message_type instanceof EE_message_type
-                        ? sprintf(
-                        __('%s message type was not successfully activated with the %s messenger', 'event_espresso'),
-                        ucwords($message_type->label['singular']),
-                        ucwords($messenger->label['singular'])
-                    )
-                        : sprintf(
-                        __('%s messenger was not successfully activated', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
+				return true;
+			} else {
+				EE_Error::add_error(
+					$message_type instanceof EE_message_type
+						? sprintf(
+						__('%s message type was not successfully activated with the %s messenger', 'event_espresso'),
+						ucwords($message_type->label['singular']),
+						ucwords($messenger->label['singular'])
+					)
+						: sprintf(
+						__('%s messenger was not successfully activated', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
                 
-                return false;
-            }
-        }
-    }
-    
-    
-    /**
-     * This sets up the appropriate response for deactivating a messenger and/or message type.
-     *
-     * @param EE_messenger         $messenger
-     * @param EE_message_type|null $message_type
-     *
-     * @return bool
-     */
-    protected function _setup_response_message_for_deactivating_messenger_with_message_types(
-        $messenger,
-        EE_message_type $message_type = null
-    ) {
-        EE_Error::overwrite_success();
-        
-        //if $messenger isn't a valid messenger object then get out.
-        if ( ! $messenger instanceof EE_Messenger) {
-            EE_Error::add_error(
-                __('The messenger being deactivated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
+				return false;
+			}
+		}
+	}
+    
+    
+	/**
+	 * This sets up the appropriate response for deactivating a messenger and/or message type.
+	 *
+	 * @param EE_messenger         $messenger
+	 * @param EE_message_type|null $message_type
+	 *
+	 * @return bool
+	 */
+	protected function _setup_response_message_for_deactivating_messenger_with_message_types(
+		$messenger,
+		EE_message_type $message_type = null
+	) {
+		EE_Error::overwrite_success();
+        
+		//if $messenger isn't a valid messenger object then get out.
+		if ( ! $messenger instanceof EE_Messenger) {
+			EE_Error::add_error(
+				__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
             
-            return false;
-        }
-        
-        if ($message_type instanceof EE_message_type) {
-            $message_type_name = $message_type->name;
-            EE_Error::add_success(
-                sprintf(
-                    __('%s message type has been successfully deactivated for the %s messenger.', 'event_espresso'),
-                    ucwords($message_type->label['singular']),
-                    ucwords($messenger->label['singular'])
-                )
-            );
-        } else {
-            $message_type_name = '';
-            EE_Error::add_success(
-                sprintf(
-                    __('%s messenger has been successfully deactivated.', 'event_espresso'),
-                    ucwords($messenger->label['singular'])
-                )
-            );
-        }
-        
-        //if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
-        if ($messenger->name == 'html' || $message_type_name == 'invoice') {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
-            if ($count_updated > 0) {
-                $msg = $message_type_name == 'invoice'
-                    ? __('Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
-                        'event_espresso')
-                    : __('Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
-                        'event_espresso');
-                EE_Error::add_attention($msg);
-            }
-        }
-        
-        return true;
-    }
-    
-    
-    /**
-     * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
-     */
-    public function update_mt_form()
-    {
-        if ( ! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
-            EE_Error::add_error(__('Require message type or messenger to send an updated form'), __FILE__, __FUNCTION__,
-                __LINE__);
-            $this->_return_json();
-        }
-        
-        $message_types = $this->get_installed_message_types();
-        
-        $message_type = $message_types[$this->_req_data['message_type']];
-        $messenger    = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
-        
-        $content                         = $this->_message_type_settings_content($message_type, $messenger, true);
-        $this->_template_args['success'] = true;
-        $this->_template_args['content'] = $content;
-        $this->_return_json();
-    }
-    
-    
-    /**
-     * this handles saving the settings for a messenger or message type
-     *
-     */
-    public function save_settings()
-    {
-        if ( ! isset($this->_req_data['type'])) {
-            EE_Error::add_error(__('Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-        
-        
-        if ($this->_req_data['type'] == 'messenger') {
-            $settings  = $this->_req_data['messenger_settings']; //this should be an array.
-            $messenger = $settings['messenger'];
-            //let's setup the settings data
-            foreach ($settings as $key => $value) {
-                switch ($key) {
-                    case 'messenger' :
-                        unset($settings['messenger']);
-                        break;
-                    case 'message_types' :
-                        unset($settings['message_types']);
-                        break;
-                    default :
-                        $settings[$key] = $value;
-                        break;
-                }
-            }
-            $this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
-        } else if ($this->_req_data['type'] == 'message_type') {
-            $settings     = $this->_req_data['message_type_settings'];
-            $messenger    = $settings['messenger'];
-            $message_type = $settings['message_type'];
+			return false;
+		}
+        
+		if ($message_type instanceof EE_message_type) {
+			$message_type_name = $message_type->name;
+			EE_Error::add_success(
+				sprintf(
+					__('%s message type has been successfully deactivated for the %s messenger.', 'event_espresso'),
+					ucwords($message_type->label['singular']),
+					ucwords($messenger->label['singular'])
+				)
+			);
+		} else {
+			$message_type_name = '';
+			EE_Error::add_success(
+				sprintf(
+					__('%s messenger has been successfully deactivated.', 'event_espresso'),
+					ucwords($messenger->label['singular'])
+				)
+			);
+		}
+        
+		//if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
+		if ($messenger->name == 'html' || $message_type_name == 'invoice') {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
+			if ($count_updated > 0) {
+				$msg = $message_type_name == 'invoice'
+					? __('Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
+						'event_espresso')
+					: __('Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
+						'event_espresso');
+				EE_Error::add_attention($msg);
+			}
+		}
+        
+		return true;
+	}
+    
+    
+	/**
+	 * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
+	 */
+	public function update_mt_form()
+	{
+		if ( ! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
+			EE_Error::add_error(__('Require message type or messenger to send an updated form'), __FILE__, __FUNCTION__,
+				__LINE__);
+			$this->_return_json();
+		}
+        
+		$message_types = $this->get_installed_message_types();
+        
+		$message_type = $message_types[$this->_req_data['message_type']];
+		$messenger    = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
+        
+		$content                         = $this->_message_type_settings_content($message_type, $messenger, true);
+		$this->_template_args['success'] = true;
+		$this->_template_args['content'] = $content;
+		$this->_return_json();
+	}
+    
+    
+	/**
+	 * this handles saving the settings for a messenger or message type
+	 *
+	 */
+	public function save_settings()
+	{
+		if ( ! isset($this->_req_data['type'])) {
+			EE_Error::add_error(__('Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+        
+        
+		if ($this->_req_data['type'] == 'messenger') {
+			$settings  = $this->_req_data['messenger_settings']; //this should be an array.
+			$messenger = $settings['messenger'];
+			//let's setup the settings data
+			foreach ($settings as $key => $value) {
+				switch ($key) {
+					case 'messenger' :
+						unset($settings['messenger']);
+						break;
+					case 'message_types' :
+						unset($settings['message_types']);
+						break;
+					default :
+						$settings[$key] = $value;
+						break;
+				}
+			}
+			$this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
+		} else if ($this->_req_data['type'] == 'message_type') {
+			$settings     = $this->_req_data['message_type_settings'];
+			$messenger    = $settings['messenger'];
+			$message_type = $settings['message_type'];
             
-            foreach ($settings as $key => $value) {
-                switch ($key) {
-                    case 'messenger' :
-                        unset($settings['messenger']);
-                        break;
-                    case 'message_type' :
-                        unset($settings['message_type']);
-                        break;
-                    default :
-                        $settings[$key] = $value;
-                        break;
-                }
-            }
+			foreach ($settings as $key => $value) {
+				switch ($key) {
+					case 'messenger' :
+						unset($settings['messenger']);
+						break;
+					case 'message_type' :
+						unset($settings['message_type']);
+						break;
+					default :
+						$settings[$key] = $value;
+						break;
+				}
+			}
             
-            $this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
-        }
-        
-        //okay we should have the data all setup.  Now we just update!
-        $success = $this->_message_resource_manager->update_active_messengers_option();
-        
-        if ($success) {
-            EE_Error::add_success(__('Settings updated', 'event_espresso'));
-        } else {
-            EE_Error::add_error(__('Settings did not get updated', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-        }
-        
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-    
-    
-    
-    
-    /**  EE MESSAGE PROCESSING ACTIONS **/
-    
-    
-    /**
-     * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
-     * However, this does not send immediately, it just queues for sending.
-     *
-     * @since 4.9.0
-     */
-    protected function _generate_now()
-    {
-        $msg_ids = $this->_get_msg_ids_from_request();
-        EED_Messages::generate_now($msg_ids);
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-    
-    
-    /**
-     * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
-     * are EEM_Message::status_resend or EEM_Message::status_idle
-     *
-     * @since 4.9.0
-     *
-     */
-    protected function _generate_and_send_now()
-    {
-        $this->_generate_now();
-        $this->_send_now();
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-    
-    
-    /**
-     * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
-     *
-     * @since 4.9.0
-     */
-    protected function _queue_for_resending()
-    {
-        $msg_ids = $this->_get_msg_ids_from_request();
-        EED_Messages::queue_for_resending($msg_ids);
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-    
-    
-    /**
-     *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
-     *
-     * @since 4.9.0
-     */
-    protected function _send_now()
-    {
-        $msg_ids = $this->_get_msg_ids_from_request();
-        EED_Messages::send_now($msg_ids);
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-    
-    
-    /**
-     * Deletes EE_messages for IDs in the request.
-     *
-     * @since 4.9.0
-     */
-    protected function _delete_ee_messages()
-    {
-        $msg_ids       = $this->_get_msg_ids_from_request();
-        $deleted_count = 0;
-        foreach ($msg_ids as $msg_id) {
-            if (EEM_Message::instance()->delete_by_ID($msg_id)) {
-                $deleted_count++;
-            }
-        }
-        if ($deleted_count) {
-            $this->_redirect_after_action(
-                true,
-                _n('message', 'messages', $deleted_count, 'event_espresso'),
-                __('deleted', 'event_espresso')
-            );
-        } else {
-            EE_Error::add_error(
-                _n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', array(), true);
-        }
-    }
-    
-    
-    /**
-     *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
-     * @since 4.9.0
-     * @return array
-     */
-    protected function _get_msg_ids_from_request()
-    {
-        if ( ! isset($this->_req_data['MSG_ID'])) {
-            return array();
-        }
-        
-        return is_array($this->_req_data['MSG_ID']) ? array_keys($this->_req_data['MSG_ID']) : array($this->_req_data['MSG_ID']);
-    }
+			$this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
+		}
+        
+		//okay we should have the data all setup.  Now we just update!
+		$success = $this->_message_resource_manager->update_active_messengers_option();
+        
+		if ($success) {
+			EE_Error::add_success(__('Settings updated', 'event_espresso'));
+		} else {
+			EE_Error::add_error(__('Settings did not get updated', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+		}
+        
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+    
+    
+    
+    
+	/**  EE MESSAGE PROCESSING ACTIONS **/
+    
+    
+	/**
+	 * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
+	 * However, this does not send immediately, it just queues for sending.
+	 *
+	 * @since 4.9.0
+	 */
+	protected function _generate_now()
+	{
+		$msg_ids = $this->_get_msg_ids_from_request();
+		EED_Messages::generate_now($msg_ids);
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+    
+    
+	/**
+	 * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
+	 * are EEM_Message::status_resend or EEM_Message::status_idle
+	 *
+	 * @since 4.9.0
+	 *
+	 */
+	protected function _generate_and_send_now()
+	{
+		$this->_generate_now();
+		$this->_send_now();
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+    
+    
+	/**
+	 * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
+	 *
+	 * @since 4.9.0
+	 */
+	protected function _queue_for_resending()
+	{
+		$msg_ids = $this->_get_msg_ids_from_request();
+		EED_Messages::queue_for_resending($msg_ids);
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+    
+    
+	/**
+	 *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
+	 *
+	 * @since 4.9.0
+	 */
+	protected function _send_now()
+	{
+		$msg_ids = $this->_get_msg_ids_from_request();
+		EED_Messages::send_now($msg_ids);
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+    
+    
+	/**
+	 * Deletes EE_messages for IDs in the request.
+	 *
+	 * @since 4.9.0
+	 */
+	protected function _delete_ee_messages()
+	{
+		$msg_ids       = $this->_get_msg_ids_from_request();
+		$deleted_count = 0;
+		foreach ($msg_ids as $msg_id) {
+			if (EEM_Message::instance()->delete_by_ID($msg_id)) {
+				$deleted_count++;
+			}
+		}
+		if ($deleted_count) {
+			$this->_redirect_after_action(
+				true,
+				_n('message', 'messages', $deleted_count, 'event_espresso'),
+				__('deleted', 'event_espresso')
+			);
+		} else {
+			EE_Error::add_error(
+				_n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$this->_redirect_after_action(false, '', '', array(), true);
+		}
+	}
+    
+    
+	/**
+	 *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
+	 * @since 4.9.0
+	 * @return array
+	 */
+	protected function _get_msg_ids_from_request()
+	{
+		if ( ! isset($this->_req_data['MSG_ID'])) {
+			return array();
+		}
+        
+		return is_array($this->_req_data['MSG_ID']) ? array_keys($this->_req_data['MSG_ID']) : array($this->_req_data['MSG_ID']);
+	}
     
     
 }

core/data_migration_scripts/EE_DMS_Core_4_1_0.dms.php

Doc Comments +2 added lines, -3 removed lines

@@ -1421,7 +1421,6 @@ 
      * Makes sure the 3.1's image url is converted to an image attachment post to the 4.1 CPT event
      * and sets it as the featured image on the CPT event
      *
-     * @param type                            $old_event
      * @param type                            $new_cpt_id
      * @param  EE_Data_Migration_Script_Stage $migration_stage the stage which called this, where errors should be added
      * @return boolean whether or not we had to do the big job of creating an image attachment
@@ -1483,7 +1482,7 @@ 
      * we download it to our uploads directory so that it can be properly processed (eg, creates different sizes of
      * thumbnails)
      *
-     * @param type                           $guid
+     * @param string                           $guid
      * @param EE_Data_Migration_Script_Stage $migration_stage
      * @return int
      */
@@ -1571,7 +1570,7 @@ 
      * Returns a mysql-formatted DATETIME in UTC time, given a $DATETIME_string
      * (and optionally a timezone; if none is given, the wp DEFAULT is used)
      *
-     * @param EE_Data_Migration_Script_base $stage
+     * @param EE_Data_Migration_Script_Stage $stage
      * @param array                         $row_of_data , the row from the DB (as an array) we're trying to find the
      *                                                   UTC time for
      * @param string                        $DATETIME_string

Indentation +1137 added lines, -1137 removed lines

@@ -12,11 +12,11 @@ 
 $stages = glob(EE_CORE . 'data_migration_scripts/4_1_0_stages/*');
 $class_to_filepath = array();
 if ( ! empty($stages)) {
-    foreach ($stages as $filepath) {
-        $matches = array();
-        preg_match('~4_1_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-        $class_to_filepath[$matches[1]] = $filepath;
-    }
+	foreach ($stages as $filepath) {
+		$matches = array();
+		preg_match('~4_1_0_stages/(.*).dmsstage.php~', $filepath, $matches);
+		$class_to_filepath[$matches[1]] = $filepath;
+	}
 }
 //give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_1_0__autoloaded_stages', $class_to_filepath);
@@ -44,91 +44,91 @@ 
 
 
 
-    /**
-     * EE_DMS_Core_4_1_0 constructor.
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_pretty_name = esc_html__("Data Migration from Event Espresso 3 to Event Espresso 4.1.0", "event_espresso");
-        $this->_priority = 10;
-        $this->_migration_stages = array(
-                new EE_DMS_4_1_0_org_options(),
-                new EE_DMS_4_1_0_shortcodes(),
-                new EE_DMS_4_1_0_gateways(),
-                new EE_DMS_4_1_0_events(),
-                new EE_DMS_4_1_0_prices(),
-                new EE_DMS_4_1_0_category_details(),
-                new EE_DMS_4_1_0_event_category(),
-                new EE_DMS_4_1_0_venues(),
-                new EE_DMS_4_1_0_event_venue(),
-                new EE_DMS_4_1_0_question_groups(),
-                new EE_DMS_4_1_0_questions(),
-                new EE_DMS_4_1_0_question_group_question(),
-                new EE_DMS_4_1_0_event_question_group(),
-                new EE_DMS_4_1_0_attendees(),
-                new EE_DMS_4_1_0_line_items(),
-                new EE_DMS_4_1_0_answers(),
-                new EE_DMS_4_1_0_checkins(),
-        );
-        parent::__construct($table_manager, $table_analysis);
-    }
-
-
-
-    /**
-     * Checks if this 3.1 Check-in table exists. If it doesn't we can't migrate Check-ins
-     *
-     * @global wpdb $wpdb
-     * @return boolean
-     */
-    private function _checkin_table_exists()
-    {
-        global $wpdb;
-        $results = $wpdb->get_results("SHOW TABLES LIKE '" . $wpdb->prefix . "events_attendee_checkin" . "'");
-        if ($results) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    public function can_migrate_from_version($version_array)
-    {
-        $version_string = $version_array['Core'];
-        if (version_compare($version_string, '4.0.0', '<=') && version_compare($version_string, '3.1.26', '>=')) {
+	/**
+	 * EE_DMS_Core_4_1_0 constructor.
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_pretty_name = esc_html__("Data Migration from Event Espresso 3 to Event Espresso 4.1.0", "event_espresso");
+		$this->_priority = 10;
+		$this->_migration_stages = array(
+				new EE_DMS_4_1_0_org_options(),
+				new EE_DMS_4_1_0_shortcodes(),
+				new EE_DMS_4_1_0_gateways(),
+				new EE_DMS_4_1_0_events(),
+				new EE_DMS_4_1_0_prices(),
+				new EE_DMS_4_1_0_category_details(),
+				new EE_DMS_4_1_0_event_category(),
+				new EE_DMS_4_1_0_venues(),
+				new EE_DMS_4_1_0_event_venue(),
+				new EE_DMS_4_1_0_question_groups(),
+				new EE_DMS_4_1_0_questions(),
+				new EE_DMS_4_1_0_question_group_question(),
+				new EE_DMS_4_1_0_event_question_group(),
+				new EE_DMS_4_1_0_attendees(),
+				new EE_DMS_4_1_0_line_items(),
+				new EE_DMS_4_1_0_answers(),
+				new EE_DMS_4_1_0_checkins(),
+		);
+		parent::__construct($table_manager, $table_analysis);
+	}
+
+
+
+	/**
+	 * Checks if this 3.1 Check-in table exists. If it doesn't we can't migrate Check-ins
+	 *
+	 * @global wpdb $wpdb
+	 * @return boolean
+	 */
+	private function _checkin_table_exists()
+	{
+		global $wpdb;
+		$results = $wpdb->get_results("SHOW TABLES LIKE '" . $wpdb->prefix . "events_attendee_checkin" . "'");
+		if ($results) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	public function can_migrate_from_version($version_array)
+	{
+		$version_string = $version_array['Core'];
+		if (version_compare($version_string, '4.0.0', '<=') && version_compare($version_string, '3.1.26', '>=')) {
 //			echo "$version_string can be migrated fro";
-            return true;
-        } elseif ( ! $version_string) {
+			return true;
+		} elseif ( ! $version_string) {
 //			echo "no version string provided: $version_string";
-            //no version string provided... this must be pre 4.1
-            //because since 4.1 we're
-            return false;//changed mind. dont want people thinking they should migrate yet because they cant
-        } else {
+			//no version string provided... this must be pre 4.1
+			//because since 4.1 we're
+			return false;//changed mind. dont want people thinking they should migrate yet because they cant
+		} else {
 //			echo "$version_string doesnt apply";
-            return false;
-        }
-    }
+			return false;
+		}
+	}
 
 
 
-    public function schema_changes_before_migration()
-    {
-        //relies on 4.1's EEH_Activation::create_table
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-        $table_name = 'esp_answer';
-        $sql = " ANS_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+	public function schema_changes_before_migration()
+	{
+		//relies on 4.1's EEH_Activation::create_table
+		require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+		$table_name = 'esp_answer';
+		$sql = " ANS_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					REG_ID INT UNSIGNED NOT NULL,
 					QST_ID INT UNSIGNED NOT NULL,
 					ANS_value TEXT NOT NULL,
 					PRIMARY KEY  (ANS_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_attendee_meta';
-        $sql = "ATTM_ID INT(10) UNSIGNED NOT	NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_attendee_meta';
+		$sql = "ATTM_ID INT(10) UNSIGNED NOT	NULL AUTO_INCREMENT,
 						ATT_ID BIGINT(20) UNSIGNED NOT NULL,
 						ATT_fname VARCHAR(45) NOT NULL,
 						ATT_lname VARCHAR(45) NOT	NULL,
@@ -144,9 +144,9 @@ 
 								KEY ATT_fname (ATT_fname),
 								KEY ATT_lname (ATT_lname),
 								KEY ATT_email (ATT_email)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_country';
-        $sql = "CNT_ISO VARCHAR(2) COLLATE utf8_bin NOT NULL,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_country';
+		$sql = "CNT_ISO VARCHAR(2) COLLATE utf8_bin NOT NULL,
 					  CNT_ISO3 VARCHAR(3) COLLATE utf8_bin NOT NULL,
 					  RGN_ID TINYINT(3) UNSIGNED DEFAULT NULL,
 					  CNT_name VARCHAR(45) COLLATE utf8_bin NOT NULL,
@@ -162,9 +162,9 @@ 
 					  CNT_is_EU TINYINT(1) DEFAULT '0',
 					  CNT_active TINYINT(1) DEFAULT '0',
 					  PRIMARY KEY  (CNT_ISO)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_datetime';
-        $sql = "DTT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_datetime';
+		$sql = "DTT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 				  EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 				  DTT_EVT_start DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
 				  DTT_EVT_end DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
@@ -177,9 +177,9 @@ 
 						PRIMARY KEY  (DTT_ID),
 						KEY EVT_ID (EVT_ID),
 						KEY DTT_is_primary (DTT_is_primary)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_meta';
-        $sql = "
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_meta';
+		$sql = "
 			EVTM_ID INT NOT NULL AUTO_INCREMENT,
 			EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 			EVT_display_desc TINYINT(1) UNSIGNED NOT NULL DEFAULT 1,
@@ -194,31 +194,31 @@ 
 			EVT_external_URL VARCHAR(200) NULL,
 			EVT_donations TINYINT(1) NULL,
 			PRIMARY KEY  (EVTM_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_question_group';
-        $sql = "EQG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_question_group';
+		$sql = "EQG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 					QSG_ID INT UNSIGNED NOT NULL,
 					EQG_primary TINYINT(1) UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (EQG_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_venue';
-        $sql = "EVV_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_venue';
+		$sql = "EVV_ID INT(11) NOT NULL AUTO_INCREMENT,
 				EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 				VNU_ID BIGINT(20) UNSIGNED NOT NULL,
 				EVV_primary TINYINT(1) UNSIGNED NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EVV_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_meta';
-        $sql = "EXM_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_meta';
+		$sql = "EXM_ID INT(11) NOT NULL AUTO_INCREMENT,
 				OBJ_ID INT(11) DEFAULT NULL,
 				EXM_type VARCHAR(45) DEFAULT NULL,
 				EXM_key VARCHAR(45) DEFAULT NULL,
 				EXM_value TEXT,
 				PRIMARY KEY  (EXM_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_line_item';
-        $sql = "LIN_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_line_item';
+		$sql = "LIN_ID INT(11) NOT NULL AUTO_INCREMENT,
 				LIN_code VARCHAR(245) NOT NULL DEFAULT '',
 				TXN_ID INT(11) DEFAULT NULL,
 				LIN_name VARCHAR(245) NOT NULL DEFAULT '',
@@ -234,18 +234,18 @@ 
 				OBJ_ID INT(11) DEFAULT NULL,
 				OBJ_type VARCHAR(45)DEFAULT NULL,
 				PRIMARY KEY  (LIN_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template';
-        $sql = "MTP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template';
+		$sql = "MTP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					GRP_ID INT(10) UNSIGNED NOT NULL,
 					MTP_context VARCHAR(50) NOT NULL,
 					MTP_template_field VARCHAR(30) NOT NULL,
 					MTP_content TEXT NOT NULL,
 					PRIMARY KEY  (MTP_ID),
 					KEY GRP_ID (GRP_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template_group';
-        $sql = "GRP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template_group';
+		$sql = "GRP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					EVT_ID BIGINT(20) UNSIGNED DEFAULT NULL,
 					MTP_user_id INT(10) NOT NULL DEFAULT '1',
 					MTP_messenger VARCHAR(30) NOT NULL,
@@ -257,9 +257,9 @@ 
 					PRIMARY KEY  (GRP_ID),
 					KEY EVT_ID (EVT_ID),
 					KEY MTP_user_id (MTP_user_id)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_payment';
-        $sql = "PAY_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_payment';
+		$sql = "PAY_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					TXN_ID INT(10) UNSIGNED DEFAULT NULL,
 					STS_ID VARCHAR(3) COLLATE utf8_bin DEFAULT NULL,
 					PAY_timestamp DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
@@ -275,9 +275,9 @@ 
 					PRIMARY KEY  (PAY_ID),
 					KEY TXN_ID (TXN_ID),
 					KEY PAY_timestamp (PAY_timestamp)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket";
-        $sql = "TKT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket";
+		$sql = "TKT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  TTM_ID INT(10) UNSIGNED NOT NULL,
 					  TKT_name VARCHAR(245) NOT NULL DEFAULT '',
 					  TKT_description TEXT NOT NULL,
@@ -296,28 +296,28 @@ 
 					  TKT_parent INT(10) UNSIGNED DEFAULT '0',
 					  TKT_deleted TINYINT(1) NOT NULL DEFAULT '0',
 					  PRIMARY KEY  (TKT_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_ticket_price";
-        $sql = "TKP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_ticket_price";
+		$sql = "TKP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  TKT_ID INT(10) UNSIGNED NOT NULL,
 					  PRC_ID INT(10) UNSIGNED NOT NULL,
 					  PRIMARY KEY  (TKP_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_datetime_ticket";
-        $sql = "DTK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_datetime_ticket";
+		$sql = "DTK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  DTT_ID INT(10) UNSIGNED NOT NULL,
 					  TKT_ID INT(10) UNSIGNED NOT NULL,
 					  PRIMARY KEY  (DTK_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_ticket_template";
-        $sql = "TTM_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_ticket_template";
+		$sql = "TTM_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  TTM_name VARCHAR(45) NOT NULL,
 					  TTM_description TEXT,
 					  TTM_file VARCHAR(45),
 					  PRIMARY KEY  (TTM_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_price";
-        $sql = "PRC_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_price";
+		$sql = "PRC_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  PRT_ID TINYINT(3) UNSIGNED NOT NULL,
 					  PRC_amount DECIMAL(10,3) NOT NULL DEFAULT '0.00',
 					  PRC_name VARCHAR(245) NOT NULL,
@@ -328,9 +328,9 @@ 
 					  PRC_order TINYINT(3) UNSIGNED NOT NULL DEFAULT '0',
 					  PRC_parent INT(10) UNSIGNED DEFAULT 0,
 					  PRIMARY KEY  (PRC_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_price_type";
-        $sql = "PRT_ID TINYINT(3) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_price_type";
+		$sql = "PRT_ID TINYINT(3) UNSIGNED NOT NULL AUTO_INCREMENT,
 				  PRT_name VARCHAR(45) NOT NULL,
 				  PBT_ID TINYINT(3) UNSIGNED NOT NULL DEFAULT '1',
 				  PRT_is_percent TINYINT(1) NOT NULL DEFAULT '0',
@@ -338,9 +338,9 @@ 
 				  PRT_deleted TINYINT(1) NOT NULL DEFAULT '0',
 				  UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				  PRIMARY KEY  (PRT_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question';
-        $sql = 'QST_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question';
+		$sql = 'QST_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QST_display_text TEXT NOT NULL,
 					QST_admin_label VARCHAR(255) NOT NULL,
 					QST_system VARCHAR(25) DEFAULT NULL,
@@ -352,10 +352,10 @@ 
 					QST_wp_user BIGINT UNSIGNED NULL,
 					QST_deleted TINYINT UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QST_ID)';
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_identifier_UNIQUE');
-        $table_name = 'esp_question_group';
-        $sql = 'QSG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_identifier_UNIQUE');
+		$table_name = 'esp_question_group';
+		$sql = 'QSG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QSG_name VARCHAR(255) NOT NULL,
 					QSG_identifier VARCHAR(100) NOT NULL,
 					QSG_desc TEXT NULL,
@@ -366,23 +366,23 @@ 
 					QSG_deleted TINYINT(1) UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QSG_ID),
 					UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier ASC)';
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group_question';
-        $sql = "QGQ_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group_question';
+		$sql = "QGQ_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QSG_ID INT UNSIGNED NOT NULL,
 					QST_ID INT UNSIGNED NOT NULL,
 					PRIMARY KEY  (QGQ_ID) ";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_option';
-        $sql = "QSO_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_option';
+		$sql = "QSO_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QSO_value VARCHAR(255) NOT NULL,
 					QSO_desc TEXT NOT NULL,
 					QST_ID INT UNSIGNED NOT NULL,
 					QSO_deleted TINYINT(1) UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QSO_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_registration';
-        $sql = "REG_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_registration';
+		$sql = "REG_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 					  ATT_ID BIGINT(20) UNSIGNED NOT NULL,
 					  TXN_ID INT(10) UNSIGNED NOT NULL,
@@ -405,25 +405,25 @@ 
 					  KEY STS_ID (STS_ID),
 					  KEY REG_url_link (REG_url_link),
 					  KEY REG_code (REG_code)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_checkin';
-        $sql = "CHK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_checkin';
+		$sql = "CHK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					REG_ID INT(10) UNSIGNED NOT NULL,
 					DTT_ID INT(10) UNSIGNED NOT NULL,
 					CHK_in TINYINT(1) UNSIGNED NOT NULL DEFAULT 1,
 					CHK_timestamp DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
 					PRIMARY KEY  (CHK_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_state';
-        $sql = "STA_ID smallint(5) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_state';
+		$sql = "STA_ID smallint(5) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  CNT_ISO VARCHAR(2) COLLATE utf8_bin NOT NULL,
 					  STA_abbrev VARCHAR(6) COLLATE utf8_bin NOT NULL,
 					  STA_name VARCHAR(100) COLLATE utf8_bin NOT NULL,
 					  STA_active TINYINT(1) DEFAULT '1',
 					  PRIMARY KEY  (STA_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_status';
-        $sql = "STS_ID VARCHAR(3) COLLATE utf8_bin NOT NULL,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_status';
+		$sql = "STS_ID VARCHAR(3) COLLATE utf8_bin NOT NULL,
 					  STS_code VARCHAR(45) COLLATE utf8_bin NOT NULL,
 					  STS_type set('event','registration','transaction','payment','email') COLLATE utf8_bin NOT NULL,
 					  STS_can_edit TINYINT(1) NOT NULL DEFAULT 0,
@@ -431,9 +431,9 @@ 
 					  STS_open TINYINT(1) NOT NULL DEFAULT 1,
 					  UNIQUE KEY STS_ID_UNIQUE (STS_ID),
 					  KEY STS_type (STS_type)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_transaction';
-        $sql = "TXN_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_transaction';
+		$sql = "TXN_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  TXN_timestamp DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
 					  TXN_total DECIMAL(10,3) DEFAULT '0.00',
 					  TXN_paid DECIMAL(10,3) NOT NULL DEFAULT '0.00',
@@ -443,9 +443,9 @@ 
 					  PRIMARY KEY  (TXN_ID),
 					  KEY TXN_timestamp (TXN_timestamp),
 					  KEY STS_ID (STS_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_venue_meta';
-        $sql = "VNUM_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_venue_meta';
+		$sql = "VNUM_ID INT(11) NOT NULL AUTO_INCREMENT,
 			VNU_ID BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 			VNU_address VARCHAR(255) DEFAULT NULL,
 			VNU_address2 VARCHAR(255) DEFAULT NULL,
@@ -463,52 +463,52 @@ 
 			PRIMARY KEY  (VNUM_ID),
 			KEY STA_ID (STA_ID),
 			KEY CNT_ISO (CNT_ISO)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        //setting up the DEFAULT stats and countries is also essential for the data migrations to run
-        //(because many need to convert old string states to foreign keys into the states table)
-        $this->insert_default_states();
-        $this->insert_default_countries();
-        //setting up DEFAULT prices, price types, and tickets is also essential for the price migrations
-        $this->insert_default_price_types();
-        $this->insert_default_prices();
-        $this->insert_default_tickets();
-        //setting up the config wp option pretty well counts as a 'schema change', or at least should happen ehre
-        EE_Config::instance()->update_espresso_config(false, true);
-        return true;
-    }
-
-
-
-    /**
-     * Yes we could have cleaned up the ee3 tables here. But just in case someone
-     * didn't backup their DB, and decides they want ot keep using EE3, we'll
-     * leave them for now. Mayeb remove them in 4.5 or something.
-     *
-     * @return boolean
-     */
-    public function schema_changes_after_migration()
-    {
-        return true;
-    }
-
-
-
-    /**
-     * insert_default_states
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public function insert_default_states()
-    {
-        global $wpdb;
-        $state_table = $wpdb->prefix . "esp_state";
-        if ($this->_get_table_analysis()->tableExists($state_table)) {
-            $SQL = "SELECT COUNT('STA_ID') FROM " . $state_table;
-            $states = $wpdb->get_var($SQL);
-            if ( ! $states) {
-                $SQL = "INSERT INTO " . $state_table . "
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		//setting up the DEFAULT stats and countries is also essential for the data migrations to run
+		//(because many need to convert old string states to foreign keys into the states table)
+		$this->insert_default_states();
+		$this->insert_default_countries();
+		//setting up DEFAULT prices, price types, and tickets is also essential for the price migrations
+		$this->insert_default_price_types();
+		$this->insert_default_prices();
+		$this->insert_default_tickets();
+		//setting up the config wp option pretty well counts as a 'schema change', or at least should happen ehre
+		EE_Config::instance()->update_espresso_config(false, true);
+		return true;
+	}
+
+
+
+	/**
+	 * Yes we could have cleaned up the ee3 tables here. But just in case someone
+	 * didn't backup their DB, and decides they want ot keep using EE3, we'll
+	 * leave them for now. Mayeb remove them in 4.5 or something.
+	 *
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration()
+	{
+		return true;
+	}
+
+
+
+	/**
+	 * insert_default_states
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public function insert_default_states()
+	{
+		global $wpdb;
+		$state_table = $wpdb->prefix . "esp_state";
+		if ($this->_get_table_analysis()->tableExists($state_table)) {
+			$SQL = "SELECT COUNT('STA_ID') FROM " . $state_table;
+			$states = $wpdb->get_var($SQL);
+			if ( ! $states) {
+				$SQL = "INSERT INTO " . $state_table . "
 				(STA_ID, CNT_ISO, STA_abbrev, STA_name, STA_active) VALUES
 				(1, 'US', 'AK', 'Alaska', 1),
 				(2, 'US', 'AL', 'Alabama', 1),
@@ -579,29 +579,29 @@ 
 				(67, 'CA', 'PE', 'Prince Edward Island', 1),
 				(68, 'CA', 'QC', 'Quebec', 1),
 				(69, 'CA', 'SK', 'Saskatchewan', 1);";
-                $wpdb->query($SQL);
-            }
-        }
-    }
-
-
-
-    /**
-     * insert_default_countries
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public function insert_default_countries()
-    {
-        global $wpdb;
-        $country_table = $wpdb->prefix . "esp_country";
-        if ($this->_get_table_analysis()->tableExists($country_table)) {
-            $SQL = "SELECT COUNT('CNT_ISO') FROM " . $country_table;
-            $countries = $wpdb->get_var($SQL);
-            if ( ! $countries) {
-                $SQL = "INSERT INTO " . $country_table . "
+				$wpdb->query($SQL);
+			}
+		}
+	}
+
+
+
+	/**
+	 * insert_default_countries
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public function insert_default_countries()
+	{
+		global $wpdb;
+		$country_table = $wpdb->prefix . "esp_country";
+		if ($this->_get_table_analysis()->tableExists($country_table)) {
+			$SQL = "SELECT COUNT('CNT_ISO') FROM " . $country_table;
+			$countries = $wpdb->get_var($SQL);
+			if ( ! $countries) {
+				$SQL = "INSERT INTO " . $country_table . "
 				(CNT_ISO, CNT_ISO3, RGN_ID, CNT_name, CNT_cur_code, CNT_cur_single, CNT_cur_plural, CNT_cur_sign, CNT_cur_sign_b4, CNT_cur_dec_plc, CNT_tel_code, CNT_is_EU, CNT_active) VALUES
 				('AD', 'AND', 0, 'Andorra', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+376', 0, 0),
 				('AE', 'ARE', 0, 'United Arab Emirates', 'AED', 'Dirham', 'Dirhams', 'د.إ', 1, 2, '+971', 0, 0),
@@ -829,941 +829,941 @@ 
 				('ZA', 'ZAF', 0, 'South Africa', 'ZAR', 'Rand', 'Rands', 'R', 1, 2, '+27', 0, 0),
 				('ZM', 'ZMB', 0, 'Zambia', 'ZMK', 'Kwacha', 'Kwachas', '', 1, 2, '+260', 0, 0),
 				('ZW', 'ZWE', 0, 'Zimbabwe', 'ZWD', 'Dollar', 'Dollars', 'Z$', 1, 2, '+263', 0, 0);";
-                $wpdb->query($SQL);
-            }
-        }
-    }
-
-
-
-    /**
-     * insert_default_price_types
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public function insert_default_price_types()
-    {
-        global $wpdb;
-        $price_type_table = $wpdb->prefix . "esp_price_type";
-        if ($this->_get_table_analysis()->tableExists($price_type_table)) {
-            $SQL = 'SELECT COUNT(PRT_ID) FROM ' . $price_type_table;
-            $price_types_exist = $wpdb->get_var($SQL);
-            if ( ! $price_types_exist) {
-                $SQL = "INSERT INTO $price_type_table ( PRT_ID, PRT_name, PBT_ID, PRT_is_percent, PRT_order, PRT_deleted ) VALUES
+				$wpdb->query($SQL);
+			}
+		}
+	}
+
+
+
+	/**
+	 * insert_default_price_types
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public function insert_default_price_types()
+	{
+		global $wpdb;
+		$price_type_table = $wpdb->prefix . "esp_price_type";
+		if ($this->_get_table_analysis()->tableExists($price_type_table)) {
+			$SQL = 'SELECT COUNT(PRT_ID) FROM ' . $price_type_table;
+			$price_types_exist = $wpdb->get_var($SQL);
+			if ( ! $price_types_exist) {
+				$SQL = "INSERT INTO $price_type_table ( PRT_ID, PRT_name, PBT_ID, PRT_is_percent, PRT_order, PRT_deleted ) VALUES
 							(1, '" . esc_html__('Base Price', 'event_espresso') . "', 1,  0, 0, 0),
 							(2, '" . esc_html__('Percent Discount', 'event_espresso') . "', 2,  1, 20, 0),
 							(3, '" . esc_html__('Fixed Discount', 'event_espresso') . "', 2,  0, 30, 0),
 							(4, '" . esc_html__('Percent Surcharge', 'event_espresso') . "', 3,  1, 40, 0),
 							(5, '" . esc_html__('Fixed Surcharge', 'event_espresso') . "', 3,  0, 50, 0);";
-                $SQL = apply_filters('FHEE__EE_DMS_4_1_0__insert_default_price_types__SQL', $SQL);
-                $wpdb->query($SQL);
-            }
-        }
-    }
-
-
-
-    /**
-     * insert_default_prices. We assume we're upgrading to regular here.
-     * If we're INSTALLING 4.1 CAF, then we add a few extra DEFAULT prices
-     * when EEH_Activaion's initialize_db_content is called via  ahook in
-     * EE_BRewing_regular
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public function insert_default_prices()
-    {
-        global $wpdb;
-        $price_table = $wpdb->prefix . "esp_price";
-        if ($this->_get_table_analysis()->tableExists($price_table)) {
-            $SQL = 'SELECT COUNT(PRC_ID) FROM ' . $price_table;
-            $prices_exist = $wpdb->get_var($SQL);
-            if ( ! $prices_exist) {
-                $SQL = "INSERT INTO $price_table
+				$SQL = apply_filters('FHEE__EE_DMS_4_1_0__insert_default_price_types__SQL', $SQL);
+				$wpdb->query($SQL);
+			}
+		}
+	}
+
+
+
+	/**
+	 * insert_default_prices. We assume we're upgrading to regular here.
+	 * If we're INSTALLING 4.1 CAF, then we add a few extra DEFAULT prices
+	 * when EEH_Activaion's initialize_db_content is called via  ahook in
+	 * EE_BRewing_regular
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public function insert_default_prices()
+	{
+		global $wpdb;
+		$price_table = $wpdb->prefix . "esp_price";
+		if ($this->_get_table_analysis()->tableExists($price_table)) {
+			$SQL = 'SELECT COUNT(PRC_ID) FROM ' . $price_table;
+			$prices_exist = $wpdb->get_var($SQL);
+			if ( ! $prices_exist) {
+				$SQL = "INSERT INTO $price_table
 							(PRC_ID, PRT_ID, PRC_amount, PRC_name, PRC_desc,  PRC_is_default, PRC_overrides, PRC_order, PRC_deleted, PRC_parent ) VALUES
 							(1, 1, '0.00', 'Free Admission', '', 1, NULL, 0, 0, 0);";
-                $SQL = apply_filters('FHEE__EE_DMS_4_1_0__insert_default_prices__SQL', $SQL);
-                $wpdb->query($SQL);
-            }
-        }
-    }
-
-
-
-    /**
-     * insert DEFAULT ticket
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public function insert_default_tickets()
-    {
-        global $wpdb;
-        $ticket_table = $wpdb->prefix . "esp_ticket";
-        if ($this->_get_table_analysis()->tableExists($ticket_table)) {
-            $SQL = 'SELECT COUNT(TKT_ID) FROM ' . $ticket_table;
-            $tickets_exist = $wpdb->get_var($SQL);
-            if ( ! $tickets_exist) {
-                $SQL = "INSERT INTO $ticket_table
+				$SQL = apply_filters('FHEE__EE_DMS_4_1_0__insert_default_prices__SQL', $SQL);
+				$wpdb->query($SQL);
+			}
+		}
+	}
+
+
+
+	/**
+	 * insert DEFAULT ticket
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public function insert_default_tickets()
+	{
+		global $wpdb;
+		$ticket_table = $wpdb->prefix . "esp_ticket";
+		if ($this->_get_table_analysis()->tableExists($ticket_table)) {
+			$SQL = 'SELECT COUNT(TKT_ID) FROM ' . $ticket_table;
+			$tickets_exist = $wpdb->get_var($SQL);
+			if ( ! $tickets_exist) {
+				$SQL = "INSERT INTO $ticket_table
 					( TKT_ID, TTM_ID, TKT_name, TKT_description, TKT_qty, TKT_sold, TKT_uses, TKT_min, TKT_max, TKT_price, TKT_start_date, TKT_end_date, TKT_taxable, TKT_order, TKT_row, TKT_is_default, TKT_parent, TKT_deleted ) VALUES
 					( 1, 0, '"
-                       . esc_html__("Free Ticket", "event_espresso")
-                       . "', '', 100, 0, -1, 0, -1, 0.00, '0000-00-00 00:00:00', '0000-00-00 00:00:00', 0, 0, 1, 1, 0, 0);";
-                $SQL = apply_filters('FHEE__EE_DMS_4_1_0__insert_default_tickets__SQL', $SQL);
-                $wpdb->query($SQL);
-            }
-        }
-        $ticket_price_table = $wpdb->prefix . "esp_ticket_price";
-        if ($this->_get_table_analysis()->tableExists($ticket_price_table)) {
-            $SQL = 'SELECT COUNT(TKP_ID) FROM ' . $ticket_price_table;
-            $ticket_prc_exist = $wpdb->get_var($SQL);
-            if ( ! $ticket_prc_exist) {
-                $SQL = "INSERT INTO $ticket_price_table
+					   . esc_html__("Free Ticket", "event_espresso")
+					   . "', '', 100, 0, -1, 0, -1, 0.00, '0000-00-00 00:00:00', '0000-00-00 00:00:00', 0, 0, 1, 1, 0, 0);";
+				$SQL = apply_filters('FHEE__EE_DMS_4_1_0__insert_default_tickets__SQL', $SQL);
+				$wpdb->query($SQL);
+			}
+		}
+		$ticket_price_table = $wpdb->prefix . "esp_ticket_price";
+		if ($this->_get_table_analysis()->tableExists($ticket_price_table)) {
+			$SQL = 'SELECT COUNT(TKP_ID) FROM ' . $ticket_price_table;
+			$ticket_prc_exist = $wpdb->get_var($SQL);
+			if ( ! $ticket_prc_exist) {
+				$SQL = "INSERT INTO $ticket_price_table
 				( TKP_ID, TKT_ID, PRC_ID ) VALUES
 				( 1, 1, 1 )
 				";
-                $SQL = apply_filters('FHEE__EE_DMS_4_1_0__insert_default_tickets__SQL__ticket_price', $SQL);
-                $wpdb->query($SQL);
-            }
-        }
-    }
-
-
-
-    /**
-     * Gets a country entry as an array, or creates one if none is found. Much like EEM_Country::instance()->get_one(),
-     * but is independent of outside code which can change in future versions of EE. Also, $country_name CAN be a 3.1
-     * country ID (int), a 2-letter ISO, 3-letter ISO, or name
-     *
-     * @global type  $wpdb
-     * @param string $country_name
-     * @return array where keys are columns, values are column values
-     */
-    public function get_or_create_country($country_name)
-    {
-        if ( ! $country_name) {
-            throw new EE_Error(esc_html__("Could not get a country because country name is blank", "event_espresso"));
-        }
-        global $wpdb;
-        $country_table = $wpdb->prefix . "esp_country";
-        if (is_int($country_name)) {
-            $country_name = $this->get_iso_from_3_1_country_id($country_name);
-        }
-        $country = $wpdb->get_row($wpdb->prepare("SELECT * FROM $country_table WHERE
+				$SQL = apply_filters('FHEE__EE_DMS_4_1_0__insert_default_tickets__SQL__ticket_price', $SQL);
+				$wpdb->query($SQL);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Gets a country entry as an array, or creates one if none is found. Much like EEM_Country::instance()->get_one(),
+	 * but is independent of outside code which can change in future versions of EE. Also, $country_name CAN be a 3.1
+	 * country ID (int), a 2-letter ISO, 3-letter ISO, or name
+	 *
+	 * @global type  $wpdb
+	 * @param string $country_name
+	 * @return array where keys are columns, values are column values
+	 */
+	public function get_or_create_country($country_name)
+	{
+		if ( ! $country_name) {
+			throw new EE_Error(esc_html__("Could not get a country because country name is blank", "event_espresso"));
+		}
+		global $wpdb;
+		$country_table = $wpdb->prefix . "esp_country";
+		if (is_int($country_name)) {
+			$country_name = $this->get_iso_from_3_1_country_id($country_name);
+		}
+		$country = $wpdb->get_row($wpdb->prepare("SELECT * FROM $country_table WHERE
 			CNT_ISO LIKE %s OR
 			CNT_ISO3 LIKE %s OR
 			CNT_name LIKE %s LIMIT 1", $country_name, $country_name, $country_name), ARRAY_A);
-        if ( ! $country) {
-            //insert a new one then
-            $cols_n_values = array(
-                    'CNT_ISO'         => $this->_find_available_country_iso(2),
-                    'CNT_ISO3'        => $this->_find_available_country_iso(3),
-                    'RGN_ID'          => 0,
-                    'CNT_name'        => $country_name,
-                    'CNT_cur_code'    => 'USD',
-                    'CNT_cur_single'  => 'Dollar',
-                    'CNT_cur_plural'  => 'Dollars',
-                    'CNT_cur_sign'    => '&#36;',
-                    'CNT_cur_sign_b4' => true,
-                    'CNT_cur_dec_plc' => 2,
-                    'CNT_cur_dec_mrk' => '.',
-                    'CNT_cur_thsnds'  => ',',
-                    'CNT_tel_code'    => '+1',
-                    'CNT_is_EU'       => false,
-                    'CNT_active'      => true,
-            );
-            $data_types = array(
-                    '%s',//CNT_ISO
-                    '%s',//CNT_ISO3
-                    '%d',//RGN_ID
-                    '%s',//CNT_name
-                    '%s',//CNT_cur_code
-                    '%s',//CNT_cur_single
-                    '%s',//CNT_cur_plural
-                    '%s',//CNT_cur_sign
-                    '%d',//CNT_cur_sign_b4
-                    '%d',//CNT_cur_dec_plc
-                    '%s',//CNT_cur_dec_mrk
-                    '%s',//CNT_cur_thsnds
-                    '%s',//CNT_tel_code
-                    '%d',//CNT_is_EU
-                    '%d',//CNT_active
-            );
-            $success = $wpdb->insert($country_table,
-                    $cols_n_values,
-                    $data_types);
-            if ( ! $success) {
-                throw new EE_Error($this->_create_error_message_for_db_insertion('N/A',
-                        array('country_id' => $country_name), $country_table, $cols_n_values, $data_types));
-            }
-            $country = $cols_n_values;
-        }
-        return $country;
-    }
-
-
-
-    /**
-     * finds a country iso which hasnt been used yet
-     *
-     * @global type $wpdb
-     * @return string
-     */
-    private function _find_available_country_iso($num_letters = 2)
-    {
-        global $wpdb;
-        $country_table = $wpdb->prefix . "esp_country";
-        $attempts = 0;
-        do {
-            $current_iso = strtoupper(wp_generate_password($num_letters, false));
-            $country_with_that_iso = $wpdb->get_var($wpdb->prepare("SELECT count(CNT_ISO) FROM "
-                                                                   . $country_table
-                                                                   . " WHERE CNT_ISO=%s", $current_iso));
-            $attempts++;
-            //keep going until we find an available country code, or we arbitrarily
-            //decide we've tried this enough. Somehow they have way too many countries
-            //(probably because they're mis-using the EE3 country_id like a custom question)
-        } while (intval($country_with_that_iso) && $attempts < 200);
-        return $current_iso;
-    }
-
-
-
-    /**
-     * Gets a state entry as an array, or creates one if none is found. Much like EEM_State::instance()->get_one(), but
-     * is independent of outside code which can change in future versions of EE
-     *
-     * @global type  $wpdb
-     * @param string $state_name
-     * @return array where keys are columns, values are column values
-     */
-    public function get_or_create_state($state_name, $country_name = '')
-    {
-        if ( ! $state_name) {
-            throw new EE_Error(esc_html__("Could not get-or-create state because no state name was provided",
-                    "event_espresso"));
-        }
-        try {
-            $country = $this->get_or_create_country($country_name);
-            $country_iso = $country['CNT_ISO'];
-        } catch (EE_Error $e) {
-            $country_iso = $this->get_default_country_iso();
-        }
-        global $wpdb;
-        $state_table = $wpdb->prefix . "esp_state";
-        $state = $wpdb->get_row($wpdb->prepare("SELECT * FROM $state_table WHERE
+		if ( ! $country) {
+			//insert a new one then
+			$cols_n_values = array(
+					'CNT_ISO'         => $this->_find_available_country_iso(2),
+					'CNT_ISO3'        => $this->_find_available_country_iso(3),
+					'RGN_ID'          => 0,
+					'CNT_name'        => $country_name,
+					'CNT_cur_code'    => 'USD',
+					'CNT_cur_single'  => 'Dollar',
+					'CNT_cur_plural'  => 'Dollars',
+					'CNT_cur_sign'    => '&#36;',
+					'CNT_cur_sign_b4' => true,
+					'CNT_cur_dec_plc' => 2,
+					'CNT_cur_dec_mrk' => '.',
+					'CNT_cur_thsnds'  => ',',
+					'CNT_tel_code'    => '+1',
+					'CNT_is_EU'       => false,
+					'CNT_active'      => true,
+			);
+			$data_types = array(
+					'%s',//CNT_ISO
+					'%s',//CNT_ISO3
+					'%d',//RGN_ID
+					'%s',//CNT_name
+					'%s',//CNT_cur_code
+					'%s',//CNT_cur_single
+					'%s',//CNT_cur_plural
+					'%s',//CNT_cur_sign
+					'%d',//CNT_cur_sign_b4
+					'%d',//CNT_cur_dec_plc
+					'%s',//CNT_cur_dec_mrk
+					'%s',//CNT_cur_thsnds
+					'%s',//CNT_tel_code
+					'%d',//CNT_is_EU
+					'%d',//CNT_active
+			);
+			$success = $wpdb->insert($country_table,
+					$cols_n_values,
+					$data_types);
+			if ( ! $success) {
+				throw new EE_Error($this->_create_error_message_for_db_insertion('N/A',
+						array('country_id' => $country_name), $country_table, $cols_n_values, $data_types));
+			}
+			$country = $cols_n_values;
+		}
+		return $country;
+	}
+
+
+
+	/**
+	 * finds a country iso which hasnt been used yet
+	 *
+	 * @global type $wpdb
+	 * @return string
+	 */
+	private function _find_available_country_iso($num_letters = 2)
+	{
+		global $wpdb;
+		$country_table = $wpdb->prefix . "esp_country";
+		$attempts = 0;
+		do {
+			$current_iso = strtoupper(wp_generate_password($num_letters, false));
+			$country_with_that_iso = $wpdb->get_var($wpdb->prepare("SELECT count(CNT_ISO) FROM "
+																   . $country_table
+																   . " WHERE CNT_ISO=%s", $current_iso));
+			$attempts++;
+			//keep going until we find an available country code, or we arbitrarily
+			//decide we've tried this enough. Somehow they have way too many countries
+			//(probably because they're mis-using the EE3 country_id like a custom question)
+		} while (intval($country_with_that_iso) && $attempts < 200);
+		return $current_iso;
+	}
+
+
+
+	/**
+	 * Gets a state entry as an array, or creates one if none is found. Much like EEM_State::instance()->get_one(), but
+	 * is independent of outside code which can change in future versions of EE
+	 *
+	 * @global type  $wpdb
+	 * @param string $state_name
+	 * @return array where keys are columns, values are column values
+	 */
+	public function get_or_create_state($state_name, $country_name = '')
+	{
+		if ( ! $state_name) {
+			throw new EE_Error(esc_html__("Could not get-or-create state because no state name was provided",
+					"event_espresso"));
+		}
+		try {
+			$country = $this->get_or_create_country($country_name);
+			$country_iso = $country['CNT_ISO'];
+		} catch (EE_Error $e) {
+			$country_iso = $this->get_default_country_iso();
+		}
+		global $wpdb;
+		$state_table = $wpdb->prefix . "esp_state";
+		$state = $wpdb->get_row($wpdb->prepare("SELECT * FROM $state_table WHERE
 			(STA_abbrev LIKE %s OR
 			STA_name LIKE %s) AND
 			CNT_ISO LIKE %s LIMIT 1", $state_name, $state_name, $country_iso), ARRAY_A);
-        if ( ! $state) {
-            //insert a new one then
-            $cols_n_values = array(
-                    'CNT_ISO'    => $country_iso,
-                    'STA_abbrev' => substr($state_name, 0, 6),
-                    'STA_name'   => $state_name,
-                    'STA_active' => true,
-            );
-            $data_types = array(
-                    '%s',//CNT_ISO
-                    '%s',//STA_abbrev
-                    '%s',//STA_name
-                    '%d',//STA_active
-            );
-            $success = $wpdb->insert($state_table, $cols_n_values, $data_types);
-            if ( ! $success) {
-                throw new EE_Error($this->_create_error_message_for_db_insertion('N/A',
-                        array('state' => $state_name, 'country_id' => $country_name), $state_table, $cols_n_values,
-                        $data_types));
-            }
-            $state = $cols_n_values;
-            $state['STA_ID'] = $wpdb->insert_id;
-        }
-        return $state;
-    }
-
-
-
-    /**
-     * Fixes times like "5:00 PM" into the expected 24-hour format "17:00".
-     * THis is actually just copied from the 3.1 JSON API because it needed to do the exact same thing
-     *
-     * @param type $timeString
-     * @return string in the php DATETIME format: "G:i" (24-hour format hour with leading zeros, a colon, and minutes
-     *                with leading zeros)
-     */
-    public function convertTimeFromAMPM($timeString)
-    {
-        $matches = array();
-        preg_match("~(\\d*):(\\d*)~", $timeString, $matches);
-        if ( ! $matches || count($matches) < 3) {
-            $hour = '00';
-            $minutes = '00';
-        } else {
-            $hour = intval($matches[1]);
-            $minutes = $matches[2];
-        }
-        if (strpos($timeString, 'PM') || strpos($timeString, 'pm')) {
-            $hour = intval($hour) + 12;
-        }
-        $hour = str_pad("$hour", 2, '0', STR_PAD_LEFT);
-        $minutes = str_pad("$minutes", 2, '0', STR_PAD_LEFT);
-        return "$hour:$minutes";
-    }
-
-
-
-    /**
-     * Gets the ISO3 fora country given its 3.1 country ID.
-     *
-     * @param int $country_id
-     * @return string the country's ISO3 code
-     */
-    public function get_iso_from_3_1_country_id($country_id)
-    {
-        $old_countries = array(
-                array(64, 'United States', 'US', 'USA', 1),
-                array(15, 'Australia', 'AU', 'AUS', 1),
-                array(39, 'Canada', 'CA', 'CAN', 1),
-                array(171, 'United Kingdom', 'GB', 'GBR', 1),
-                array(70, 'France', 'FR', 'FRA', 2),
-                array(111, 'Italy', 'IT', 'ITA', 2),
-                array(63, 'Spain', 'ES', 'ESP', 2),
-                array(1, 'Afghanistan', 'AF', 'AFG', 1),
-                array(2, 'Albania', 'AL', 'ALB', 1),
-                array(3, 'Germany', 'DE', 'DEU', 2),
-                array(198, 'Switzerland', 'CH', 'CHE', 1),
-                array(87, 'Netherlands', 'NL', 'NLD', 2),
-                array(197, 'Sweden', 'SE', 'SWE', 1),
-                array(230, 'Akrotiri and Dhekelia', 'CY', 'CYP', 2),
-                array(4, 'Andorra', 'AD', 'AND', 2),
-                array(5, 'Angola', 'AO', 'AGO', 1),
-                array(6, 'Anguilla', 'AI', 'AIA', 1),
-                array(7, 'Antarctica', 'AQ', 'ATA', 1),
-                array(8, 'Antigua and Barbuda', 'AG', 'ATG', 1),
-                array(10, 'Saudi Arabia', 'SA', 'SAU', 1),
-                array(11, 'Algeria', 'DZ', 'DZA', 1),
-                array(12, 'Argentina', 'AR', 'ARG', 1),
-                array(13, 'Armenia', 'AM', 'ARM', 1),
-                array(14, 'Aruba', 'AW', 'ABW', 1),
-                array(16, 'Austria', 'AT', 'AUT', 2),
-                array(17, 'Azerbaijan', 'AZ', 'AZE', 1),
-                array(18, 'Bahamas', 'BS', 'BHS', 1),
-                array(19, 'Bahrain', 'BH', 'BHR', 1),
-                array(20, 'Bangladesh', 'BD', 'BGD', 1),
-                array(21, 'Barbados', 'BB', 'BRB', 1),
-                array(22, 'Belgium ', 'BE', 'BEL', 2),
-                array(23, 'Belize', 'BZ', 'BLZ', 1),
-                array(24, 'Benin', 'BJ', 'BEN', 1),
-                array(25, 'Bermudas', 'BM', 'BMU', 1),
-                array(26, 'Belarus', 'BY', 'BLR', 1),
-                array(27, 'Bolivia', 'BO', 'BOL', 1),
-                array(28, 'Bosnia and Herzegovina', 'BA', 'BIH', 1),
-                array(29, 'Botswana', 'BW', 'BWA', 1),
-                array(96, 'Bouvet Island', 'BV', 'BVT', 1),
-                array(30, 'Brazil', 'BR', 'BRA', 1),
-                array(31, 'Brunei', 'BN', 'BRN', 1),
-                array(32, 'Bulgaria', 'BG', 'BGR', 1),
-                array(33, 'Burkina Faso', 'BF', 'BFA', 1),
-                array(34, 'Burundi', 'BI', 'BDI', 1),
-                array(35, 'Bhutan', 'BT', 'BTN', 1),
-                array(36, 'Cape Verde', 'CV', 'CPV', 1),
-                array(37, 'Cambodia', 'KH', 'KHM', 1),
-                array(38, 'Cameroon', 'CM', 'CMR', 1),
-                array(98, 'Cayman Islands', 'KY', 'CYM', 1),
-                array(172, 'Central African Republic', 'CF', 'CAF', 1),
-                array(40, 'Chad', 'TD', 'TCD', 1),
-                array(41, 'Chile', 'CL', 'CHL', 1),
-                array(42, 'China', 'CN', 'CHN', 1),
-                array(105, 'Christmas Island', 'CX', 'CXR', 1),
-                array(43, 'Cyprus', 'CY', 'CYP', 2),
-                array(99, 'Cocos Island', 'CC', 'CCK', 1),
-                array(100, 'Cook Islands', 'CK', 'COK', 1),
-                array(44, 'Colombia', 'CO', 'COL', 1),
-                array(45, 'Comoros', 'KM', 'COM', 1),
-                array(46, 'Congo', 'CG', 'COG', 1),
-                array(47, 'North Korea', 'KP', 'PRK', 1),
-                array(50, 'Costa Rica', 'CR', 'CRI', 1),
-                array(51, 'Croatia', 'HR', 'HRV', 1),
-                array(52, 'Cuba', 'CU', 'CUB', 1),
-                array(173, 'Czech Republic', 'CZ', 'CZE', 1),
-                array(53, 'Denmark', 'DK', 'DNK', 1),
-                array(54, 'Djibouti', 'DJ', 'DJI', 1),
-                array(55, 'Dominica', 'DM', 'DMA', 1),
-                array(174, 'Dominican Republic', 'DO', 'DOM', 1),
-                array(56, 'Ecuador', 'EC', 'ECU', 1),
-                array(57, 'Egypt', 'EG', 'EGY', 1),
-                array(58, 'El Salvador', 'SV', 'SLV', 1),
-                array(60, 'Eritrea', 'ER', 'ERI', 1),
-                array(61, 'Slovakia', 'SK', 'SVK', 2),
-                array(62, 'Slovenia', 'SI', 'SVN', 2),
-                array(65, 'Estonia', 'EE', 'EST', 2),
-                array(66, 'Ethiopia', 'ET', 'ETH', 1),
-                array(102, 'Faroe islands', 'FO', 'FRO', 1),
-                array(103, 'Falkland Islands', 'FK', 'FLK', 1),
-                array(67, 'Fiji', 'FJ', 'FJI', 1),
-                array(69, 'Finland', 'FI', 'FIN', 2),
-                array(71, 'Gabon', 'GA', 'GAB', 1),
-                array(72, 'Gambia', 'GM', 'GMB', 1),
-                array(73, 'Georgia', 'GE', 'GEO', 1),
-                array(74, 'Ghana', 'GH', 'GHA', 1),
-                array(75, 'Gibraltar', 'GI', 'GIB', 1),
-                array(76, 'Greece', 'GR', 'GRC', 2),
-                array(77, 'Grenada', 'GD', 'GRD', 1),
-                array(78, 'Greenland', 'GL', 'GRL', 1),
-                array(79, 'Guadeloupe', 'GP', 'GLP', 1),
-                array(80, 'Guam', 'GU', 'GUM', 1),
-                array(81, 'Guatemala', 'GT', 'GTM', 1),
-                array(82, 'Guinea', 'GN', 'GIN', 1),
-                array(83, 'Equatorial Guinea', 'GQ', 'GNQ', 1),
-                array(84, 'Guinea-Bissau', 'GW', 'GNB', 1),
-                array(85, 'Guyana', 'GY', 'GUY', 1),
-                array(86, 'Haiti', 'HT', 'HTI', 1),
-                array(88, 'Honduras', 'HN', 'HND', 1),
-                array(89, 'Hong Kong', 'HK', 'HKG', 1),
-                array(90, 'Hungary', 'HU', 'HUN', 1),
-                array(91, 'India', 'IN', 'IND', 1),
-                array(205, 'British Indian Ocean Territory', 'IO', 'IOT', 1),
-                array(92, 'Indonesia', 'ID', 'IDN', 1),
-                array(93, 'Iraq', 'IQ', 'IRQ', 1),
-                array(94, 'Iran', 'IR', 'IRN', 1),
-                array(95, 'Ireland', 'IE', 'IRL', 2),
-                array(97, 'Iceland', 'IS', 'ISL', 1),
-                array(110, 'Israel', 'IL', 'ISR', 1),
-                array(49, 'Ivory Coast ', 'CI', 'CIV', 1),
-                array(112, 'Jamaica', 'JM', 'JAM', 1),
-                array(113, 'Japan', 'JP', 'JPN', 1),
-                array(114, 'Jordan', 'JO', 'JOR', 1),
-                array(115, 'Kazakhstan', 'KZ', 'KAZ', 1),
-                array(116, 'Kenya', 'KE', 'KEN', 1),
-                array(117, 'Kyrgyzstan', 'KG', 'KGZ', 1),
-                array(118, 'Kiribati', 'KI', 'KIR', 1),
-                array(48, 'South Korea', 'KR', 'KOR', 1),
-                array(228, 'Kosovo', 'XK', 'XKV', 2),
-                // there is no official ISO code for Kosovo yet (http://geonames.wordpress.com/2010/03/08/xk-country-code-for-kosovo/) so using a temporary country code and a modified 3 character code for ISO code -- this should be updated if/when Kosovo gets its own ISO code
-                array(119, 'Kuwait', 'KW', 'KWT', 1),
-                array(120, 'Laos', 'LA', 'LAO', 1),
-                array(121, 'Latvia', 'LV', 'LVA', 2),
-                array(122, 'Lesotho', 'LS', 'LSO', 1),
-                array(123, 'Lebanon', 'LB', 'LBN', 1),
-                array(124, 'Liberia', 'LR', 'LBR', 1),
-                array(125, 'Libya', 'LY', 'LBY', 1),
-                array(126, 'Liechtenstein', 'LI', 'LIE', 1),
-                array(127, 'Lithuania', 'LT', 'LTU', 2),
-                array(128, 'Luxemburg', 'LU', 'LUX', 2),
-                array(129, 'Macao', 'MO', 'MAC', 1),
-                array(130, 'Macedonia', 'MK', 'MKD', 1),
-                array(131, 'Madagascar', 'MG', 'MDG', 1),
-                array(132, 'Malaysia', 'MY', 'MYS', 1),
-                array(133, 'Malawi', 'MW', 'MWI', 1),
-                array(134, 'Maldivas', 'MV', 'MDV', 1),
-                array(135, 'Mali', 'ML', 'MLI', 1),
-                array(136, 'Malta', 'MT', 'MLT', 2),
-                array(101, 'Northern Marianas', 'MP', 'MNP', 1),
-                array(137, 'Morocco', 'MA', 'MAR', 1),
-                array(104, 'Marshall islands', 'MH', 'MHL', 1),
-                array(138, 'Martinique', 'MQ', 'MTQ', 1),
-                array(139, 'Mauritius', 'MU', 'MUS', 1),
-                array(140, 'Mauritania', 'MR', 'MRT', 1),
-                array(141, 'Mayote', 'YT', 'MYT', 2),
-                array(142, 'Mexico', 'MX', 'MEX', 1),
-                array(143, 'Micronesia', 'FM', 'FSM', 1),
-                array(144, 'Moldova', 'MD', 'MDA', 1),
-                array(145, 'Monaco', 'MC', 'MCO', 2),
-                array(146, 'Mongolia', 'MN', 'MNG', 1),
-                array(147, 'Montserrat', 'MS', 'MSR', 1),
-                array(227, 'Montenegro', 'ME', 'MNE', 2),
-                array(148, 'Mozambique', 'MZ', 'MOZ', 1),
-                array(149, 'Myanmar', 'MM', 'MMR', 1),
-                array(150, 'Namibia', 'NA', 'NAM', 1),
-                array(151, 'Nauru', 'NR', 'NRU', 1),
-                array(152, 'Nepal', 'NP', 'NPL', 1),
-                array(9, 'Netherlands Antilles', 'AN', 'ANT', 1),
-                array(153, 'Nicaragua', 'NI', 'NIC', 1),
-                array(154, 'Niger', 'NE', 'NER', 1),
-                array(155, 'Nigeria', 'NG', 'NGA', 1),
-                array(156, 'Niue', 'NU', 'NIU', 1),
-                array(157, 'Norway', 'NO', 'NOR', 1),
-                array(158, 'New Caledonia', 'NC', 'NCL', 1),
-                array(159, 'New Zealand', 'NZ', 'NZL', 1),
-                array(160, 'Oman', 'OM', 'OMN', 1),
-                array(161, 'Pakistan', 'PK', 'PAK', 1),
-                array(162, 'Palau', 'PW', 'PLW', 1),
-                array(163, 'Panama', 'PA', 'PAN', 1),
-                array(164, 'Papua New Guinea', 'PG', 'PNG', 1),
-                array(165, 'Paraguay', 'PY', 'PRY', 1),
-                array(166, 'Peru', 'PE', 'PER', 1),
-                array(68, 'Philippines', 'PH', 'PHL', 1),
-                array(167, 'Poland', 'PL', 'POL', 1),
-                array(168, 'Portugal', 'PT', 'PRT', 2),
-                array(169, 'Puerto Rico', 'PR', 'PRI', 1),
-                array(170, 'Qatar', 'QA', 'QAT', 1),
-                array(176, 'Rwanda', 'RW', 'RWA', 1),
-                array(177, 'Romania', 'RO', 'ROM', 2),
-                array(178, 'Russia', 'RU', 'RUS', 1),
-                array(229, 'Saint Pierre and Miquelon', 'PM', 'SPM', 2),
-                array(180, 'Samoa', 'WS', 'WSM', 1),
-                array(181, 'American Samoa', 'AS', 'ASM', 1),
-                array(183, 'San Marino', 'SM', 'SMR', 2),
-                array(184, 'Saint Vincent and the Grenadines', 'VC', 'VCT', 1),
-                array(185, 'Saint Helena', 'SH', 'SHN', 1),
-                array(186, 'Saint Lucia', 'LC', 'LCA', 1),
-                array(188, 'Senegal', 'SN', 'SEN', 1),
-                array(189, 'Seychelles', 'SC', 'SYC', 1),
-                array(190, 'Sierra Leona', 'SL', 'SLE', 1),
-                array(191, 'Singapore', 'SG', 'SGP', 1),
-                array(192, 'Syria', 'SY', 'SYR', 1),
-                array(193, 'Somalia', 'SO', 'SOM', 1),
-                array(194, 'Sri Lanka', 'LK', 'LKA', 1),
-                array(195, 'South Africa', 'ZA', 'ZAF', 1),
-                array(196, 'Sudan', 'SD', 'SDN', 1),
-                array(199, 'Suriname', 'SR', 'SUR', 1),
-                array(200, 'Swaziland', 'SZ', 'SWZ', 1),
-                array(201, 'Thailand', 'TH', 'THA', 1),
-                array(202, 'Taiwan', 'TW', 'TWN', 1),
-                array(203, 'Tanzania', 'TZ', 'TZA', 1),
-                array(204, 'Tajikistan', 'TJ', 'TJK', 1),
-                array(206, 'Timor-Leste', 'TL', 'TLS', 1),
-                array(207, 'Togo', 'TG', 'TGO', 1),
-                array(208, 'Tokelau', 'TK', 'TKL', 1),
-                array(209, 'Tonga', 'TO', 'TON', 1),
-                array(210, 'Trinidad and Tobago', 'TT', 'TTO', 1),
-                array(211, 'Tunisia', 'TN', 'TUN', 1),
-                array(212, 'Turkmenistan', 'TM', 'TKM', 1),
-                array(213, 'Turkey', 'TR', 'TUR', 1),
-                array(214, 'Tuvalu', 'TV', 'TUV', 1),
-                array(215, 'Ukraine', 'UA', 'UKR', 1),
-                array(216, 'Uganda', 'UG', 'UGA', 1),
-                array(59, 'United Arab Emirates', 'AE', 'ARE', 1),
-                array(217, 'Uruguay', 'UY', 'URY', 1),
-                array(218, 'Uzbekistan', 'UZ', 'UZB', 1),
-                array(219, 'Vanuatu', 'VU', 'VUT', 1),
-                array(220, 'Vatican City', 'VA', 'VAT', 2),
-                array(221, 'Venezuela', 'VE', 'VEN', 1),
-                array(222, 'Vietnam', 'VN', 'VNM', 1),
-                array(108, 'Virgin Islands', 'VI', 'VIR', 1),
-                array(223, 'Yemen', 'YE', 'YEM', 1),
-                array(225, 'Zambia', 'ZM', 'ZMB', 1),
-                array(226, 'Zimbabwe', 'ZW', 'ZWE', 1),
-        );
-        $country_iso = 'US';
-        foreach ($old_countries as $country_array) {
-            //note: index 0 is the 3.1 country ID
-            if ($country_array[0] == $country_id) {
-                //note: index 2 is the ISO
-                $country_iso = $country_array[2];
-                break;
-            }
-        }
-        return $country_iso;
-    }
-
-
-
-    /**
-     * Gets the ISO3 for the
-     *
-     * @return string
-     */
-    public function get_default_country_iso()
-    {
-        $old_org_options = get_option('events_organization_settings');
-        $iso = $this->get_iso_from_3_1_country_id($old_org_options['organization_country']);
-        return $iso;
-    }
-
-
-
-    /**
-     * Converst a 3.1 payment status to its equivalent 4.1 regisration status
-     *
-     * @param string  $payment_status                   possible value for 3.1's evens_attendee.payment_status
-     * @param boolean $this_thing_required_pre_approval whether the thing we're considering (the general setting's
-     *                                                  DEFAULT payment status, the event's DEFAULT payment status, or
-     *                                                  the attendee's payment status) required pre-approval.
-     * @return string STS_ID for use in 4.1
-     */
-    public function convert_3_1_payment_status_to_4_1_STS_ID($payment_status, $this_thing_required_pre_approval = false)
-    {
-        //EE team can read the related discussion: https://app.asana.com/0/2400967562914/9418495544455
-        if ($this_thing_required_pre_approval) {
-            return 'RNA';
-        } else {
-            $mapping = $default_reg_stati_conversions = array(
-                    'Completed'        => 'RAP',
-                    ''                 => 'RPP',
-                    'Incomplete'       => 'RPP',
-                    'Pending'          => 'RAP',
-                    //stati that only occurred on 3.1 attendees:
-                    'Payment Declined' => 'RPP',
-                    'Not Completed'    => 'RPP',
-                    'Cancelled'        => 'RPP',
-                    'Declined'         => 'RPP',
-            );
-        }
-        return isset($mapping[$payment_status]) ? $mapping[$payment_status] : 'RNA';
-    }
-
-
-
-    /**
-     * Makes sure the 3.1's image url is converted to an image attachment post to the 4.1 CPT event
-     * and sets it as the featured image on the CPT event
-     *
-     * @param type                            $old_event
-     * @param type                            $new_cpt_id
-     * @param  EE_Data_Migration_Script_Stage $migration_stage the stage which called this, where errors should be added
-     * @return boolean whether or not we had to do the big job of creating an image attachment
-     */
-    public function convert_image_url_to_attachment_and_attach_to_post(
-            $guid,
-            $new_cpt_id,
-            EE_Data_Migration_Script_Stage $migration_stage
-    ) {
-        $created_attachment_post = false;
-        $guid = $this->_get_original_guid($guid);
-        if ($guid) {
-            //check for an existing attachment post with this guid
-            $attachment_post_id = $this->_get_image_attachment_id_by_GUID($guid);
-            if ( ! $attachment_post_id) {
-                //post thumbnail with that GUID doesn't exist, we should create one
-                $attachment_post_id = $this->_create_image_attachment_from_GUID($guid, $migration_stage);
-                $created_attachment_post = true;
-            }
-            //double-check we actually have an attachment post
-            if ($attachment_post_id) {
-                update_post_meta($new_cpt_id, '_thumbnail_id', $attachment_post_id);
-            } else {
-                $migration_stage->add_error(sprintf(esc_html__("Could not update event image %s for CPT with ID %d, but attachments post ID is %d",
-                        "event_espresso"), $guid, $new_cpt_id, $attachment_post_id));
-            }
-        }
-        return $created_attachment_post;
-    }
-
-
-
-    /**
-     * In 3.1, the event thumbnail image DOESN'T point to the orignal image, but instead
-     * to a large thumbnail (which has nearly the same GUID, except it adds "-{width}x{height}" before the filetype,
-     * or whatever dimensions it is. Eg 'http://mysite.com/image1-300x400.jpg' instead of
-     * 'http://mysite.com/image1.jpg' ). This function attempts to strip that off and get the original file, if it
-     * exists
-     *
-     * @param string $guid_in_old_event
-     * @return string either the original guid, or $guid_in_old_event if we couldn't figure out what the original was
-     */
-    private function _get_original_guid($guid_in_old_event)
-    {
-        $original_guid = preg_replace('~-\d*x\d*\.~', '.', $guid_in_old_event, 1);
-        //do a head request to verify the file exists
-        $head_response = wp_remote_head($original_guid);
-        if ( ! $head_response instanceof WP_Error && $head_response['response']['message'] == 'OK') {
-            return $original_guid;
-        } else {
-            return $guid_in_old_event;
-        }
-    }
-
-
-
-    /**
-     * Creates an image attachment post for the GUID. If the GUID points to a remote image,
-     * we download it to our uploads directory so that it can be properly processed (eg, creates different sizes of
-     * thumbnails)
-     *
-     * @param type                           $guid
-     * @param EE_Data_Migration_Script_Stage $migration_stage
-     * @return int
-     */
-    private function _create_image_attachment_from_GUID($guid, EE_Data_Migration_Script_Stage $migration_stage)
-    {
-        if ( ! $guid) {
-            $migration_stage->add_error(sprintf(esc_html__("Cannot create image attachment for a blank GUID!",
-                    "event_espresso")));
-            return 0;
-        }
-        $wp_filetype = wp_check_filetype(basename($guid), null);
-        $wp_upload_dir = wp_upload_dir();
-        //if the file is located remotely, download it to our uploads DIR, because wp_genereate_attachmnet_metadata needs the file to be local
-        if (strpos($guid, $wp_upload_dir['url']) === false) {
-            //image is located remotely. download it and place it in the uploads directory
-            if ( ! is_readable($guid)) {
-                $migration_stage->add_error(sprintf(esc_html__("Could not create image attachment from non-existent file: %s",
-                        "event_espresso"), $guid));
-                return 0;
-            }
-            $contents = file_get_contents($guid);
-            if ($contents === false) {
-                $migration_stage->add_error(sprintf(esc_html__("Could not read image at %s, and therefore couldnt create an attachment post for it.",
-                        "event_espresso"), $guid));
-                return false;
-            }
-            $local_filepath = $wp_upload_dir['path'] . DS . basename($guid);
-            $savefile = fopen($local_filepath, 'w');
-            fwrite($savefile, $contents);
-            fclose($savefile);
-            $guid = str_replace($wp_upload_dir['path'], $wp_upload_dir['url'], $local_filepath);
-        } else {
-            $local_filepath = str_replace($wp_upload_dir['url'], $wp_upload_dir['path'], $guid);
-        }
-        $attachment = array(
-                'guid'           => $guid,
-                'post_mime_type' => $wp_filetype['type'],
-                'post_title'     => preg_replace('/\.[^.]+$/', '', basename($guid)),
-                'post_content'   => '',
-                'post_status'    => 'inherit',
-        );
-        $attach_id = wp_insert_attachment($attachment, $guid);
-        if ( ! $attach_id) {
-            $migration_stage->add_error(sprintf(esc_html__("Could not create image attachment post from image '%s'. Attachment data was %s.",
-                    "event_espresso"), $guid, $this->_json_encode($attachment)));
-            return $attach_id;
-        }
-        // you must first include the image.php file
-        // for the function wp_generate_attachment_metadata() to work
-        require_once(ABSPATH . 'wp-admin/includes/image.php');
-        $attach_data = wp_generate_attachment_metadata($attach_id, $local_filepath);
-        if ( ! $attach_data) {
-            $migration_stage->add_error(sprintf(esc_html__("Coudl not genereate attachment metadata for attachment post %d with filepath %s and GUID %s. Please check the file was downloaded properly.",
-                    "event_espresso"), $attach_id, $local_filepath, $guid));
-            return $attach_id;
-        }
-        $metadata_save_result = wp_update_attachment_metadata($attach_id, $attach_data);
-        if ( ! $metadata_save_result) {
-            $migration_stage->add_error(sprintf(esc_html__("Could not update attachment metadata for attachment %d with data %s",
-                    "event_espresso"), $attach_id, $this->_json_encode($attach_data)));
-        }
-        return $attach_id;
-    }
-
-
-
-    /**
-     * Finds the attachment post containing info about an image attachment given the GUID (link to the image itself),
-     * and returns its ID.
-     *
-     * @global type  $wpdb
-     * @param string $guid
-     * @return int
-     */
-    private function _get_image_attachment_id_by_GUID($guid)
-    {
-        global $wpdb;
-        $attachment_id = $wpdb->get_var($wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE guid=%s LIMIT 1", $guid));
-        return $attachment_id;
-    }
-
-
-
-    /**
-     * Returns a mysql-formatted DATETIME in UTC time, given a $DATETIME_string
-     * (and optionally a timezone; if none is given, the wp DEFAULT is used)
-     *
-     * @param EE_Data_Migration_Script_base $stage
-     * @param array                         $row_of_data , the row from the DB (as an array) we're trying to find the
-     *                                                   UTC time for
-     * @param string                        $DATETIME_string
-     * @param string                        $timezone
-     * @return string
-     */
-    public function convert_date_string_to_utc(
-            EE_Data_Migration_Script_Stage $stage,
-            $row_of_data,
-            $DATETIME_string,
-            $timezone = null
-    ) {
-        $original_tz = $timezone;
-        if ( ! $timezone) {
-            $timezone = $this->_get_wp_timezone();
-        }
-        if ( ! $timezone) {
-            $stage->add_error(sprintf(esc_html__("Could not find timezone given %s for %s", "event_espresso"), $original_tz,
-                    $row_of_data));
-            $timezone = 'UTC';
-        }
-        try {
-            $date_obj = new DateTime($DATETIME_string, new DateTimeZone($timezone));
-            $date_obj->setTimezone(new DateTimeZone('UTC'));
-        } catch (Exception $e) {
-            $stage->add_error(sprintf(esc_html__("Could not convert time string '%s' using timezone '%s' into a proper DATETIME. Using current time instead.",
-                    "event_espresso"), $DATETIME_string, $timezone));
-            $date_obj = new DateTime();
-        }
-        return $date_obj->format('Y-m-d H:i:s');
-    }
-
-
-
-    /**
-     * Gets the DEFAULT timezone string from wordpress (even if they set a gmt offset)
-     *
-     * @return string
-     */
-    private function _get_wp_timezone()
-    {
-        $timezone = empty($timezone) ? get_option('timezone_string') : $timezone;
-        //if timezone is STILL empty then let's get the GMT offset and then set the timezone_string using our converter
-        if (empty($timezone)) {
-            //let's get a the WordPress UTC offset
-            $offset = get_option('gmt_offset');
-            $timezone = $this->timezone_convert_to_string_from_offset($offset);
-        }
-        return $timezone;
-    }
-
-
-
-    /**
-     * Gets the wordpress timezone string from a UTC offset
-     *
-     * @param int $offset
-     * @return boolean
-     */
-    private function timezone_convert_to_string_from_offset($offset)
-    {
-        //shamelessly taken from bottom comment at http://ca1.php.net/manual/en/function.timezone-name-from-abbr.php because timezone_name_from_abbr() did NOT work as expected - its not reliable
-        $offset *= 3600; // convert hour offset to seconds
-        $abbrarray = timezone_abbreviations_list();
-        foreach ($abbrarray as $abbr) {
-            foreach ($abbr as $city) {
-                if ($city['offset'] == $offset) {
-                    return $city['timezone_id'];
-                }
-            }
-        }
-        return false;
-    }
-
-
-
-    public function migration_page_hooks()
-    {
-        add_filter(
-                'FHEE__ee_migration_page__header',
-                array($this, '_migrate_page_hook_simplify_version_strings'),
-                10,
-                3
-        );
-        add_filter(
-                'FHEE__ee_migration_page__p_after_header',
-                array($this, '_migration_page_hook_simplify_next_db_state'),
-                10,
-                2
-        );
-        add_filter(
-                'FHEE__ee_migration_page__option_1_main',
-                array($this, '_migrate_page_hook_simplify_version_strings'),
-                10,
-                3
-        );
-        add_filter(
-                'FHEE__ee_migration_page__option_1_button_text',
-                array($this, '_migrate_page_hook_simplify_version_strings'),
-                10,
-                3
-        );
-        add_action(
-                'AHEE__ee_migration_page__option_1_extra_details',
-                array($this, '_migration_page_hook_option_1_extra_details'),
-                10,
-                3
-        );
-        add_filter(
-                'FHEE__ee_migration_page__option_2_main',
-                array($this, '_migrate_page_hook_simplify_version_strings'),
-                10,
-                4
-        );
-        add_filter(
-                'FHEE__ee_migration_page__option_2_button_text',
-                array($this, '_migration_page_hook_simplify_next_db_state'),
-                10,
-                2
-        );
-        add_filter(
-                'FHEE__ee_migration_page__option_2_details',
-                array($this, '_migration_page_hook_simplify_next_db_state'),
-                10,
-                2
-        );
-        add_action(
-                'AHEE__ee_migration_page__after_migration_options_table',
-                array($this, '_migration_page_hook_after_migration_options_table')
-        );
-        add_filter(
-                'FHEE__ee_migration_page__done_migration_header',
-                array($this, '_migration_page_hook_simplify_next_db_state'),
-                10,
-                2
-        );
-        add_filter(
-                'FHEE__ee_migration_page__p_after_done_migration_header',
-                array($this, '_migration_page_hook_simplify_next_db_state'),
-                10,
-                2
-        );
-        add_filter(
-                'FHEE__ee_migration_page__migration_options_template',
-                array($this,'use_migration_options_from_ee3_template')
-        );
-    }
-
-
-
-    public function _migrate_page_hook_simplify_version_strings(
-            $old_content,
-            $current_db_state,
-            $next_db_state,
-            $ultimate_db_state = null
-    ) {
-        return str_replace(array($current_db_state, $next_db_state, $ultimate_db_state),
-                array(esc_html__('EE3', 'event_espresso'), esc_html__('EE4', 'event_espresso'), esc_html__("EE4", 'event_espresso')),
-                $old_content);
-    }
-
-
-
-    public function _migration_page_hook_simplify_next_db_state($old_content, $next_db_state)
-    {
-        return str_replace($next_db_state, esc_html__("EE4", 'event_espresso'), $old_content);
-    }
-
-
-
-    public function _migration_page_hook_option_1_extra_details()
-    {
-        ?>
+		if ( ! $state) {
+			//insert a new one then
+			$cols_n_values = array(
+					'CNT_ISO'    => $country_iso,
+					'STA_abbrev' => substr($state_name, 0, 6),
+					'STA_name'   => $state_name,
+					'STA_active' => true,
+			);
+			$data_types = array(
+					'%s',//CNT_ISO
+					'%s',//STA_abbrev
+					'%s',//STA_name
+					'%d',//STA_active
+			);
+			$success = $wpdb->insert($state_table, $cols_n_values, $data_types);
+			if ( ! $success) {
+				throw new EE_Error($this->_create_error_message_for_db_insertion('N/A',
+						array('state' => $state_name, 'country_id' => $country_name), $state_table, $cols_n_values,
+						$data_types));
+			}
+			$state = $cols_n_values;
+			$state['STA_ID'] = $wpdb->insert_id;
+		}
+		return $state;
+	}
+
+
+
+	/**
+	 * Fixes times like "5:00 PM" into the expected 24-hour format "17:00".
+	 * THis is actually just copied from the 3.1 JSON API because it needed to do the exact same thing
+	 *
+	 * @param type $timeString
+	 * @return string in the php DATETIME format: "G:i" (24-hour format hour with leading zeros, a colon, and minutes
+	 *                with leading zeros)
+	 */
+	public function convertTimeFromAMPM($timeString)
+	{
+		$matches = array();
+		preg_match("~(\\d*):(\\d*)~", $timeString, $matches);
+		if ( ! $matches || count($matches) < 3) {
+			$hour = '00';
+			$minutes = '00';
+		} else {
+			$hour = intval($matches[1]);
+			$minutes = $matches[2];
+		}
+		if (strpos($timeString, 'PM') || strpos($timeString, 'pm')) {
+			$hour = intval($hour) + 12;
+		}
+		$hour = str_pad("$hour", 2, '0', STR_PAD_LEFT);
+		$minutes = str_pad("$minutes", 2, '0', STR_PAD_LEFT);
+		return "$hour:$minutes";
+	}
+
+
+
+	/**
+	 * Gets the ISO3 fora country given its 3.1 country ID.
+	 *
+	 * @param int $country_id
+	 * @return string the country's ISO3 code
+	 */
+	public function get_iso_from_3_1_country_id($country_id)
+	{
+		$old_countries = array(
+				array(64, 'United States', 'US', 'USA', 1),
+				array(15, 'Australia', 'AU', 'AUS', 1),
+				array(39, 'Canada', 'CA', 'CAN', 1),
+				array(171, 'United Kingdom', 'GB', 'GBR', 1),
+				array(70, 'France', 'FR', 'FRA', 2),
+				array(111, 'Italy', 'IT', 'ITA', 2),
+				array(63, 'Spain', 'ES', 'ESP', 2),
+				array(1, 'Afghanistan', 'AF', 'AFG', 1),
+				array(2, 'Albania', 'AL', 'ALB', 1),
+				array(3, 'Germany', 'DE', 'DEU', 2),
+				array(198, 'Switzerland', 'CH', 'CHE', 1),
+				array(87, 'Netherlands', 'NL', 'NLD', 2),
+				array(197, 'Sweden', 'SE', 'SWE', 1),
+				array(230, 'Akrotiri and Dhekelia', 'CY', 'CYP', 2),
+				array(4, 'Andorra', 'AD', 'AND', 2),
+				array(5, 'Angola', 'AO', 'AGO', 1),
+				array(6, 'Anguilla', 'AI', 'AIA', 1),
+				array(7, 'Antarctica', 'AQ', 'ATA', 1),
+				array(8, 'Antigua and Barbuda', 'AG', 'ATG', 1),
+				array(10, 'Saudi Arabia', 'SA', 'SAU', 1),
+				array(11, 'Algeria', 'DZ', 'DZA', 1),
+				array(12, 'Argentina', 'AR', 'ARG', 1),
+				array(13, 'Armenia', 'AM', 'ARM', 1),
+				array(14, 'Aruba', 'AW', 'ABW', 1),
+				array(16, 'Austria', 'AT', 'AUT', 2),
+				array(17, 'Azerbaijan', 'AZ', 'AZE', 1),
+				array(18, 'Bahamas', 'BS', 'BHS', 1),
+				array(19, 'Bahrain', 'BH', 'BHR', 1),
+				array(20, 'Bangladesh', 'BD', 'BGD', 1),
+				array(21, 'Barbados', 'BB', 'BRB', 1),
+				array(22, 'Belgium ', 'BE', 'BEL', 2),
+				array(23, 'Belize', 'BZ', 'BLZ', 1),
+				array(24, 'Benin', 'BJ', 'BEN', 1),
+				array(25, 'Bermudas', 'BM', 'BMU', 1),
+				array(26, 'Belarus', 'BY', 'BLR', 1),
+				array(27, 'Bolivia', 'BO', 'BOL', 1),
+				array(28, 'Bosnia and Herzegovina', 'BA', 'BIH', 1),
+				array(29, 'Botswana', 'BW', 'BWA', 1),
+				array(96, 'Bouvet Island', 'BV', 'BVT', 1),
+				array(30, 'Brazil', 'BR', 'BRA', 1),
+				array(31, 'Brunei', 'BN', 'BRN', 1),
+				array(32, 'Bulgaria', 'BG', 'BGR', 1),
+				array(33, 'Burkina Faso', 'BF', 'BFA', 1),
+				array(34, 'Burundi', 'BI', 'BDI', 1),
+				array(35, 'Bhutan', 'BT', 'BTN', 1),
+				array(36, 'Cape Verde', 'CV', 'CPV', 1),
+				array(37, 'Cambodia', 'KH', 'KHM', 1),
+				array(38, 'Cameroon', 'CM', 'CMR', 1),
+				array(98, 'Cayman Islands', 'KY', 'CYM', 1),
+				array(172, 'Central African Republic', 'CF', 'CAF', 1),
+				array(40, 'Chad', 'TD', 'TCD', 1),
+				array(41, 'Chile', 'CL', 'CHL', 1),
+				array(42, 'China', 'CN', 'CHN', 1),
+				array(105, 'Christmas Island', 'CX', 'CXR', 1),
+				array(43, 'Cyprus', 'CY', 'CYP', 2),
+				array(99, 'Cocos Island', 'CC', 'CCK', 1),
+				array(100, 'Cook Islands', 'CK', 'COK', 1),
+				array(44, 'Colombia', 'CO', 'COL', 1),
+				array(45, 'Comoros', 'KM', 'COM', 1),
+				array(46, 'Congo', 'CG', 'COG', 1),
+				array(47, 'North Korea', 'KP', 'PRK', 1),
+				array(50, 'Costa Rica', 'CR', 'CRI', 1),
+				array(51, 'Croatia', 'HR', 'HRV', 1),
+				array(52, 'Cuba', 'CU', 'CUB', 1),
+				array(173, 'Czech Republic', 'CZ', 'CZE', 1),
+				array(53, 'Denmark', 'DK', 'DNK', 1),
+				array(54, 'Djibouti', 'DJ', 'DJI', 1),
+				array(55, 'Dominica', 'DM', 'DMA', 1),
+				array(174, 'Dominican Republic', 'DO', 'DOM', 1),
+				array(56, 'Ecuador', 'EC', 'ECU', 1),
+				array(57, 'Egypt', 'EG', 'EGY', 1),
+				array(58, 'El Salvador', 'SV', 'SLV', 1),
+				array(60, 'Eritrea', 'ER', 'ERI', 1),
+				array(61, 'Slovakia', 'SK', 'SVK', 2),
+				array(62, 'Slovenia', 'SI', 'SVN', 2),
+				array(65, 'Estonia', 'EE', 'EST', 2),
+				array(66, 'Ethiopia', 'ET', 'ETH', 1),
+				array(102, 'Faroe islands', 'FO', 'FRO', 1),
+				array(103, 'Falkland Islands', 'FK', 'FLK', 1),
+				array(67, 'Fiji', 'FJ', 'FJI', 1),
+				array(69, 'Finland', 'FI', 'FIN', 2),
+				array(71, 'Gabon', 'GA', 'GAB', 1),
+				array(72, 'Gambia', 'GM', 'GMB', 1),
+				array(73, 'Georgia', 'GE', 'GEO', 1),
+				array(74, 'Ghana', 'GH', 'GHA', 1),
+				array(75, 'Gibraltar', 'GI', 'GIB', 1),
+				array(76, 'Greece', 'GR', 'GRC', 2),
+				array(77, 'Grenada', 'GD', 'GRD', 1),
+				array(78, 'Greenland', 'GL', 'GRL', 1),
+				array(79, 'Guadeloupe', 'GP', 'GLP', 1),
+				array(80, 'Guam', 'GU', 'GUM', 1),
+				array(81, 'Guatemala', 'GT', 'GTM', 1),
+				array(82, 'Guinea', 'GN', 'GIN', 1),
+				array(83, 'Equatorial Guinea', 'GQ', 'GNQ', 1),
+				array(84, 'Guinea-Bissau', 'GW', 'GNB', 1),
+				array(85, 'Guyana', 'GY', 'GUY', 1),
+				array(86, 'Haiti', 'HT', 'HTI', 1),
+				array(88, 'Honduras', 'HN', 'HND', 1),
+				array(89, 'Hong Kong', 'HK', 'HKG', 1),
+				array(90, 'Hungary', 'HU', 'HUN', 1),
+				array(91, 'India', 'IN', 'IND', 1),
+				array(205, 'British Indian Ocean Territory', 'IO', 'IOT', 1),
+				array(92, 'Indonesia', 'ID', 'IDN', 1),
+				array(93, 'Iraq', 'IQ', 'IRQ', 1),
+				array(94, 'Iran', 'IR', 'IRN', 1),
+				array(95, 'Ireland', 'IE', 'IRL', 2),
+				array(97, 'Iceland', 'IS', 'ISL', 1),
+				array(110, 'Israel', 'IL', 'ISR', 1),
+				array(49, 'Ivory Coast ', 'CI', 'CIV', 1),
+				array(112, 'Jamaica', 'JM', 'JAM', 1),
+				array(113, 'Japan', 'JP', 'JPN', 1),
+				array(114, 'Jordan', 'JO', 'JOR', 1),
+				array(115, 'Kazakhstan', 'KZ', 'KAZ', 1),
+				array(116, 'Kenya', 'KE', 'KEN', 1),
+				array(117, 'Kyrgyzstan', 'KG', 'KGZ', 1),
+				array(118, 'Kiribati', 'KI', 'KIR', 1),
+				array(48, 'South Korea', 'KR', 'KOR', 1),
+				array(228, 'Kosovo', 'XK', 'XKV', 2),
+				// there is no official ISO code for Kosovo yet (http://geonames.wordpress.com/2010/03/08/xk-country-code-for-kosovo/) so using a temporary country code and a modified 3 character code for ISO code -- this should be updated if/when Kosovo gets its own ISO code
+				array(119, 'Kuwait', 'KW', 'KWT', 1),
+				array(120, 'Laos', 'LA', 'LAO', 1),
+				array(121, 'Latvia', 'LV', 'LVA', 2),
+				array(122, 'Lesotho', 'LS', 'LSO', 1),
+				array(123, 'Lebanon', 'LB', 'LBN', 1),
+				array(124, 'Liberia', 'LR', 'LBR', 1),
+				array(125, 'Libya', 'LY', 'LBY', 1),
+				array(126, 'Liechtenstein', 'LI', 'LIE', 1),
+				array(127, 'Lithuania', 'LT', 'LTU', 2),
+				array(128, 'Luxemburg', 'LU', 'LUX', 2),
+				array(129, 'Macao', 'MO', 'MAC', 1),
+				array(130, 'Macedonia', 'MK', 'MKD', 1),
+				array(131, 'Madagascar', 'MG', 'MDG', 1),
+				array(132, 'Malaysia', 'MY', 'MYS', 1),
+				array(133, 'Malawi', 'MW', 'MWI', 1),
+				array(134, 'Maldivas', 'MV', 'MDV', 1),
+				array(135, 'Mali', 'ML', 'MLI', 1),
+				array(136, 'Malta', 'MT', 'MLT', 2),
+				array(101, 'Northern Marianas', 'MP', 'MNP', 1),
+				array(137, 'Morocco', 'MA', 'MAR', 1),
+				array(104, 'Marshall islands', 'MH', 'MHL', 1),
+				array(138, 'Martinique', 'MQ', 'MTQ', 1),
+				array(139, 'Mauritius', 'MU', 'MUS', 1),
+				array(140, 'Mauritania', 'MR', 'MRT', 1),
+				array(141, 'Mayote', 'YT', 'MYT', 2),
+				array(142, 'Mexico', 'MX', 'MEX', 1),
+				array(143, 'Micronesia', 'FM', 'FSM', 1),
+				array(144, 'Moldova', 'MD', 'MDA', 1),
+				array(145, 'Monaco', 'MC', 'MCO', 2),
+				array(146, 'Mongolia', 'MN', 'MNG', 1),
+				array(147, 'Montserrat', 'MS', 'MSR', 1),
+				array(227, 'Montenegro', 'ME', 'MNE', 2),
+				array(148, 'Mozambique', 'MZ', 'MOZ', 1),
+				array(149, 'Myanmar', 'MM', 'MMR', 1),
+				array(150, 'Namibia', 'NA', 'NAM', 1),
+				array(151, 'Nauru', 'NR', 'NRU', 1),
+				array(152, 'Nepal', 'NP', 'NPL', 1),
+				array(9, 'Netherlands Antilles', 'AN', 'ANT', 1),
+				array(153, 'Nicaragua', 'NI', 'NIC', 1),
+				array(154, 'Niger', 'NE', 'NER', 1),
+				array(155, 'Nigeria', 'NG', 'NGA', 1),
+				array(156, 'Niue', 'NU', 'NIU', 1),
+				array(157, 'Norway', 'NO', 'NOR', 1),
+				array(158, 'New Caledonia', 'NC', 'NCL', 1),
+				array(159, 'New Zealand', 'NZ', 'NZL', 1),
+				array(160, 'Oman', 'OM', 'OMN', 1),
+				array(161, 'Pakistan', 'PK', 'PAK', 1),
+				array(162, 'Palau', 'PW', 'PLW', 1),
+				array(163, 'Panama', 'PA', 'PAN', 1),
+				array(164, 'Papua New Guinea', 'PG', 'PNG', 1),
+				array(165, 'Paraguay', 'PY', 'PRY', 1),
+				array(166, 'Peru', 'PE', 'PER', 1),
+				array(68, 'Philippines', 'PH', 'PHL', 1),
+				array(167, 'Poland', 'PL', 'POL', 1),
+				array(168, 'Portugal', 'PT', 'PRT', 2),
+				array(169, 'Puerto Rico', 'PR', 'PRI', 1),
+				array(170, 'Qatar', 'QA', 'QAT', 1),
+				array(176, 'Rwanda', 'RW', 'RWA', 1),
+				array(177, 'Romania', 'RO', 'ROM', 2),
+				array(178, 'Russia', 'RU', 'RUS', 1),
+				array(229, 'Saint Pierre and Miquelon', 'PM', 'SPM', 2),
+				array(180, 'Samoa', 'WS', 'WSM', 1),
+				array(181, 'American Samoa', 'AS', 'ASM', 1),
+				array(183, 'San Marino', 'SM', 'SMR', 2),
+				array(184, 'Saint Vincent and the Grenadines', 'VC', 'VCT', 1),
+				array(185, 'Saint Helena', 'SH', 'SHN', 1),
+				array(186, 'Saint Lucia', 'LC', 'LCA', 1),
+				array(188, 'Senegal', 'SN', 'SEN', 1),
+				array(189, 'Seychelles', 'SC', 'SYC', 1),
+				array(190, 'Sierra Leona', 'SL', 'SLE', 1),
+				array(191, 'Singapore', 'SG', 'SGP', 1),
+				array(192, 'Syria', 'SY', 'SYR', 1),
+				array(193, 'Somalia', 'SO', 'SOM', 1),
+				array(194, 'Sri Lanka', 'LK', 'LKA', 1),
+				array(195, 'South Africa', 'ZA', 'ZAF', 1),
+				array(196, 'Sudan', 'SD', 'SDN', 1),
+				array(199, 'Suriname', 'SR', 'SUR', 1),
+				array(200, 'Swaziland', 'SZ', 'SWZ', 1),
+				array(201, 'Thailand', 'TH', 'THA', 1),
+				array(202, 'Taiwan', 'TW', 'TWN', 1),
+				array(203, 'Tanzania', 'TZ', 'TZA', 1),
+				array(204, 'Tajikistan', 'TJ', 'TJK', 1),
+				array(206, 'Timor-Leste', 'TL', 'TLS', 1),
+				array(207, 'Togo', 'TG', 'TGO', 1),
+				array(208, 'Tokelau', 'TK', 'TKL', 1),
+				array(209, 'Tonga', 'TO', 'TON', 1),
+				array(210, 'Trinidad and Tobago', 'TT', 'TTO', 1),
+				array(211, 'Tunisia', 'TN', 'TUN', 1),
+				array(212, 'Turkmenistan', 'TM', 'TKM', 1),
+				array(213, 'Turkey', 'TR', 'TUR', 1),
+				array(214, 'Tuvalu', 'TV', 'TUV', 1),
+				array(215, 'Ukraine', 'UA', 'UKR', 1),
+				array(216, 'Uganda', 'UG', 'UGA', 1),
+				array(59, 'United Arab Emirates', 'AE', 'ARE', 1),
+				array(217, 'Uruguay', 'UY', 'URY', 1),
+				array(218, 'Uzbekistan', 'UZ', 'UZB', 1),
+				array(219, 'Vanuatu', 'VU', 'VUT', 1),
+				array(220, 'Vatican City', 'VA', 'VAT', 2),
+				array(221, 'Venezuela', 'VE', 'VEN', 1),
+				array(222, 'Vietnam', 'VN', 'VNM', 1),
+				array(108, 'Virgin Islands', 'VI', 'VIR', 1),
+				array(223, 'Yemen', 'YE', 'YEM', 1),
+				array(225, 'Zambia', 'ZM', 'ZMB', 1),
+				array(226, 'Zimbabwe', 'ZW', 'ZWE', 1),
+		);
+		$country_iso = 'US';
+		foreach ($old_countries as $country_array) {
+			//note: index 0 is the 3.1 country ID
+			if ($country_array[0] == $country_id) {
+				//note: index 2 is the ISO
+				$country_iso = $country_array[2];
+				break;
+			}
+		}
+		return $country_iso;
+	}
+
+
+
+	/**
+	 * Gets the ISO3 for the
+	 *
+	 * @return string
+	 */
+	public function get_default_country_iso()
+	{
+		$old_org_options = get_option('events_organization_settings');
+		$iso = $this->get_iso_from_3_1_country_id($old_org_options['organization_country']);
+		return $iso;
+	}
+
+
+
+	/**
+	 * Converst a 3.1 payment status to its equivalent 4.1 regisration status
+	 *
+	 * @param string  $payment_status                   possible value for 3.1's evens_attendee.payment_status
+	 * @param boolean $this_thing_required_pre_approval whether the thing we're considering (the general setting's
+	 *                                                  DEFAULT payment status, the event's DEFAULT payment status, or
+	 *                                                  the attendee's payment status) required pre-approval.
+	 * @return string STS_ID for use in 4.1
+	 */
+	public function convert_3_1_payment_status_to_4_1_STS_ID($payment_status, $this_thing_required_pre_approval = false)
+	{
+		//EE team can read the related discussion: https://app.asana.com/0/2400967562914/9418495544455
+		if ($this_thing_required_pre_approval) {
+			return 'RNA';
+		} else {
+			$mapping = $default_reg_stati_conversions = array(
+					'Completed'        => 'RAP',
+					''                 => 'RPP',
+					'Incomplete'       => 'RPP',
+					'Pending'          => 'RAP',
+					//stati that only occurred on 3.1 attendees:
+					'Payment Declined' => 'RPP',
+					'Not Completed'    => 'RPP',
+					'Cancelled'        => 'RPP',
+					'Declined'         => 'RPP',
+			);
+		}
+		return isset($mapping[$payment_status]) ? $mapping[$payment_status] : 'RNA';
+	}
+
+
+
+	/**
+	 * Makes sure the 3.1's image url is converted to an image attachment post to the 4.1 CPT event
+	 * and sets it as the featured image on the CPT event
+	 *
+	 * @param type                            $old_event
+	 * @param type                            $new_cpt_id
+	 * @param  EE_Data_Migration_Script_Stage $migration_stage the stage which called this, where errors should be added
+	 * @return boolean whether or not we had to do the big job of creating an image attachment
+	 */
+	public function convert_image_url_to_attachment_and_attach_to_post(
+			$guid,
+			$new_cpt_id,
+			EE_Data_Migration_Script_Stage $migration_stage
+	) {
+		$created_attachment_post = false;
+		$guid = $this->_get_original_guid($guid);
+		if ($guid) {
+			//check for an existing attachment post with this guid
+			$attachment_post_id = $this->_get_image_attachment_id_by_GUID($guid);
+			if ( ! $attachment_post_id) {
+				//post thumbnail with that GUID doesn't exist, we should create one
+				$attachment_post_id = $this->_create_image_attachment_from_GUID($guid, $migration_stage);
+				$created_attachment_post = true;
+			}
+			//double-check we actually have an attachment post
+			if ($attachment_post_id) {
+				update_post_meta($new_cpt_id, '_thumbnail_id', $attachment_post_id);
+			} else {
+				$migration_stage->add_error(sprintf(esc_html__("Could not update event image %s for CPT with ID %d, but attachments post ID is %d",
+						"event_espresso"), $guid, $new_cpt_id, $attachment_post_id));
+			}
+		}
+		return $created_attachment_post;
+	}
+
+
+
+	/**
+	 * In 3.1, the event thumbnail image DOESN'T point to the orignal image, but instead
+	 * to a large thumbnail (which has nearly the same GUID, except it adds "-{width}x{height}" before the filetype,
+	 * or whatever dimensions it is. Eg 'http://mysite.com/image1-300x400.jpg' instead of
+	 * 'http://mysite.com/image1.jpg' ). This function attempts to strip that off and get the original file, if it
+	 * exists
+	 *
+	 * @param string $guid_in_old_event
+	 * @return string either the original guid, or $guid_in_old_event if we couldn't figure out what the original was
+	 */
+	private function _get_original_guid($guid_in_old_event)
+	{
+		$original_guid = preg_replace('~-\d*x\d*\.~', '.', $guid_in_old_event, 1);
+		//do a head request to verify the file exists
+		$head_response = wp_remote_head($original_guid);
+		if ( ! $head_response instanceof WP_Error && $head_response['response']['message'] == 'OK') {
+			return $original_guid;
+		} else {
+			return $guid_in_old_event;
+		}
+	}
+
+
+
+	/**
+	 * Creates an image attachment post for the GUID. If the GUID points to a remote image,
+	 * we download it to our uploads directory so that it can be properly processed (eg, creates different sizes of
+	 * thumbnails)
+	 *
+	 * @param type                           $guid
+	 * @param EE_Data_Migration_Script_Stage $migration_stage
+	 * @return int
+	 */
+	private function _create_image_attachment_from_GUID($guid, EE_Data_Migration_Script_Stage $migration_stage)
+	{
+		if ( ! $guid) {
+			$migration_stage->add_error(sprintf(esc_html__("Cannot create image attachment for a blank GUID!",
+					"event_espresso")));
+			return 0;
+		}
+		$wp_filetype = wp_check_filetype(basename($guid), null);
+		$wp_upload_dir = wp_upload_dir();
+		//if the file is located remotely, download it to our uploads DIR, because wp_genereate_attachmnet_metadata needs the file to be local
+		if (strpos($guid, $wp_upload_dir['url']) === false) {
+			//image is located remotely. download it and place it in the uploads directory
+			if ( ! is_readable($guid)) {
+				$migration_stage->add_error(sprintf(esc_html__("Could not create image attachment from non-existent file: %s",
+						"event_espresso"), $guid));
+				return 0;
+			}
+			$contents = file_get_contents($guid);
+			if ($contents === false) {
+				$migration_stage->add_error(sprintf(esc_html__("Could not read image at %s, and therefore couldnt create an attachment post for it.",
+						"event_espresso"), $guid));
+				return false;
+			}
+			$local_filepath = $wp_upload_dir['path'] . DS . basename($guid);
+			$savefile = fopen($local_filepath, 'w');
+			fwrite($savefile, $contents);
+			fclose($savefile);
+			$guid = str_replace($wp_upload_dir['path'], $wp_upload_dir['url'], $local_filepath);
+		} else {
+			$local_filepath = str_replace($wp_upload_dir['url'], $wp_upload_dir['path'], $guid);
+		}
+		$attachment = array(
+				'guid'           => $guid,
+				'post_mime_type' => $wp_filetype['type'],
+				'post_title'     => preg_replace('/\.[^.]+$/', '', basename($guid)),
+				'post_content'   => '',
+				'post_status'    => 'inherit',
+		);
+		$attach_id = wp_insert_attachment($attachment, $guid);
+		if ( ! $attach_id) {
+			$migration_stage->add_error(sprintf(esc_html__("Could not create image attachment post from image '%s'. Attachment data was %s.",
+					"event_espresso"), $guid, $this->_json_encode($attachment)));
+			return $attach_id;
+		}
+		// you must first include the image.php file
+		// for the function wp_generate_attachment_metadata() to work
+		require_once(ABSPATH . 'wp-admin/includes/image.php');
+		$attach_data = wp_generate_attachment_metadata($attach_id, $local_filepath);
+		if ( ! $attach_data) {
+			$migration_stage->add_error(sprintf(esc_html__("Coudl not genereate attachment metadata for attachment post %d with filepath %s and GUID %s. Please check the file was downloaded properly.",
+					"event_espresso"), $attach_id, $local_filepath, $guid));
+			return $attach_id;
+		}
+		$metadata_save_result = wp_update_attachment_metadata($attach_id, $attach_data);
+		if ( ! $metadata_save_result) {
+			$migration_stage->add_error(sprintf(esc_html__("Could not update attachment metadata for attachment %d with data %s",
+					"event_espresso"), $attach_id, $this->_json_encode($attach_data)));
+		}
+		return $attach_id;
+	}
+
+
+
+	/**
+	 * Finds the attachment post containing info about an image attachment given the GUID (link to the image itself),
+	 * and returns its ID.
+	 *
+	 * @global type  $wpdb
+	 * @param string $guid
+	 * @return int
+	 */
+	private function _get_image_attachment_id_by_GUID($guid)
+	{
+		global $wpdb;
+		$attachment_id = $wpdb->get_var($wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE guid=%s LIMIT 1", $guid));
+		return $attachment_id;
+	}
+
+
+
+	/**
+	 * Returns a mysql-formatted DATETIME in UTC time, given a $DATETIME_string
+	 * (and optionally a timezone; if none is given, the wp DEFAULT is used)
+	 *
+	 * @param EE_Data_Migration_Script_base $stage
+	 * @param array                         $row_of_data , the row from the DB (as an array) we're trying to find the
+	 *                                                   UTC time for
+	 * @param string                        $DATETIME_string
+	 * @param string                        $timezone
+	 * @return string
+	 */
+	public function convert_date_string_to_utc(
+			EE_Data_Migration_Script_Stage $stage,
+			$row_of_data,
+			$DATETIME_string,
+			$timezone = null
+	) {
+		$original_tz = $timezone;
+		if ( ! $timezone) {
+			$timezone = $this->_get_wp_timezone();
+		}
+		if ( ! $timezone) {
+			$stage->add_error(sprintf(esc_html__("Could not find timezone given %s for %s", "event_espresso"), $original_tz,
+					$row_of_data));
+			$timezone = 'UTC';
+		}
+		try {
+			$date_obj = new DateTime($DATETIME_string, new DateTimeZone($timezone));
+			$date_obj->setTimezone(new DateTimeZone('UTC'));
+		} catch (Exception $e) {
+			$stage->add_error(sprintf(esc_html__("Could not convert time string '%s' using timezone '%s' into a proper DATETIME. Using current time instead.",
+					"event_espresso"), $DATETIME_string, $timezone));
+			$date_obj = new DateTime();
+		}
+		return $date_obj->format('Y-m-d H:i:s');
+	}
+
+
+
+	/**
+	 * Gets the DEFAULT timezone string from wordpress (even if they set a gmt offset)
+	 *
+	 * @return string
+	 */
+	private function _get_wp_timezone()
+	{
+		$timezone = empty($timezone) ? get_option('timezone_string') : $timezone;
+		//if timezone is STILL empty then let's get the GMT offset and then set the timezone_string using our converter
+		if (empty($timezone)) {
+			//let's get a the WordPress UTC offset
+			$offset = get_option('gmt_offset');
+			$timezone = $this->timezone_convert_to_string_from_offset($offset);
+		}
+		return $timezone;
+	}
+
+
+
+	/**
+	 * Gets the wordpress timezone string from a UTC offset
+	 *
+	 * @param int $offset
+	 * @return boolean
+	 */
+	private function timezone_convert_to_string_from_offset($offset)
+	{
+		//shamelessly taken from bottom comment at http://ca1.php.net/manual/en/function.timezone-name-from-abbr.php because timezone_name_from_abbr() did NOT work as expected - its not reliable
+		$offset *= 3600; // convert hour offset to seconds
+		$abbrarray = timezone_abbreviations_list();
+		foreach ($abbrarray as $abbr) {
+			foreach ($abbr as $city) {
+				if ($city['offset'] == $offset) {
+					return $city['timezone_id'];
+				}
+			}
+		}
+		return false;
+	}
+
+
+
+	public function migration_page_hooks()
+	{
+		add_filter(
+				'FHEE__ee_migration_page__header',
+				array($this, '_migrate_page_hook_simplify_version_strings'),
+				10,
+				3
+		);
+		add_filter(
+				'FHEE__ee_migration_page__p_after_header',
+				array($this, '_migration_page_hook_simplify_next_db_state'),
+				10,
+				2
+		);
+		add_filter(
+				'FHEE__ee_migration_page__option_1_main',
+				array($this, '_migrate_page_hook_simplify_version_strings'),
+				10,
+				3
+		);
+		add_filter(
+				'FHEE__ee_migration_page__option_1_button_text',
+				array($this, '_migrate_page_hook_simplify_version_strings'),
+				10,
+				3
+		);
+		add_action(
+				'AHEE__ee_migration_page__option_1_extra_details',
+				array($this, '_migration_page_hook_option_1_extra_details'),
+				10,
+				3
+		);
+		add_filter(
+				'FHEE__ee_migration_page__option_2_main',
+				array($this, '_migrate_page_hook_simplify_version_strings'),
+				10,
+				4
+		);
+		add_filter(
+				'FHEE__ee_migration_page__option_2_button_text',
+				array($this, '_migration_page_hook_simplify_next_db_state'),
+				10,
+				2
+		);
+		add_filter(
+				'FHEE__ee_migration_page__option_2_details',
+				array($this, '_migration_page_hook_simplify_next_db_state'),
+				10,
+				2
+		);
+		add_action(
+				'AHEE__ee_migration_page__after_migration_options_table',
+				array($this, '_migration_page_hook_after_migration_options_table')
+		);
+		add_filter(
+				'FHEE__ee_migration_page__done_migration_header',
+				array($this, '_migration_page_hook_simplify_next_db_state'),
+				10,
+				2
+		);
+		add_filter(
+				'FHEE__ee_migration_page__p_after_done_migration_header',
+				array($this, '_migration_page_hook_simplify_next_db_state'),
+				10,
+				2
+		);
+		add_filter(
+				'FHEE__ee_migration_page__migration_options_template',
+				array($this,'use_migration_options_from_ee3_template')
+		);
+	}
+
+
+
+	public function _migrate_page_hook_simplify_version_strings(
+			$old_content,
+			$current_db_state,
+			$next_db_state,
+			$ultimate_db_state = null
+	) {
+		return str_replace(array($current_db_state, $next_db_state, $ultimate_db_state),
+				array(esc_html__('EE3', 'event_espresso'), esc_html__('EE4', 'event_espresso'), esc_html__("EE4", 'event_espresso')),
+				$old_content);
+	}
+
+
+
+	public function _migration_page_hook_simplify_next_db_state($old_content, $next_db_state)
+	{
+		return str_replace($next_db_state, esc_html__("EE4", 'event_espresso'), $old_content);
+	}
+
+
+
+	public function _migration_page_hook_option_1_extra_details()
+	{
+		?>
         <p><?php printf(esc_html__("Note: many of your EE3 shortcodes will be changed to EE4 shortcodes during this migration (among many other things). Should you revert to EE3, then you should restore to your backup or manually change the EE4 shortcodes back to their EE3 equivalents",
-            "event_espresso")); ?></p><?php
-    }
+			"event_espresso")); ?></p><?php
+	}
 
 
 
-    public function _migration_page_hook_after_migration_options_table()
-    {
-        ?><p class="ee-attention">
+	public function _migration_page_hook_after_migration_options_table()
+	{
+		?><p class="ee-attention">
         <strong><span class="reminder-spn"><?php _e("Important note to those using Event Espresso 3 addons: ",
-                        "event_espresso"); ?></span></strong>
+						"event_espresso"); ?></span></strong>
         <br/><?php _e("Unless an addon's description on our website explicitly states that it is compatible with EE4, you should consider it incompatible and know that it WILL NOT WORK correctly with this new version of Event Espresso 4 (EE4). As well, any data for incompatible addons will NOT BE MIGRATED until an updated EE4 compatible version of the addon is available. If you want, or need to keep using your EE3 addons, you should simply continue using EE3 until EE4 compatible versions of your addons become available. To continue using EE3 for now, just deactivate EE4 and reactivate EE3.",
-            "event_espresso"); ?>
+			"event_espresso"); ?>
         </p><?php
-    }
+	}
 
 
 
-    /**
-     * When showing the migration options, show more options and info than normal (ie, give folks the option
-     * to start using EE4 without migrating. From EE3 that's fine, because it doesn't actually remove any data, because
-     * EE4 doesn't have any yet. But when migrating from EE4 it would remove old data, so its not a great idea).
-     * @param $template_filepath
-     * @return string
-     */
-    public function use_migration_options_from_ee3_template( $template_filepath ) {
-        return EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee3.template.php';
-    }
+	/**
+	 * When showing the migration options, show more options and info than normal (ie, give folks the option
+	 * to start using EE4 without migrating. From EE3 that's fine, because it doesn't actually remove any data, because
+	 * EE4 doesn't have any yet. But when migrating from EE4 it would remove old data, so its not a great idea).
+	 * @param $template_filepath
+	 * @return string
+	 */
+	public function use_migration_options_from_ee3_template( $template_filepath ) {
+		return EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee3.template.php';
+	}
 }

Spacing +51 added lines, -51 removed lines

@@ -9,7 +9,7 @@ 
 //unfortunately, this needs to be done upon INCLUSION of this file,
 //instead of construction, because it only gets constructed on first page load
 //(all other times it gets resurrected from a wordpress option)
-$stages = glob(EE_CORE . 'data_migration_scripts/4_1_0_stages/*');
+$stages = glob(EE_CORE.'data_migration_scripts/4_1_0_stages/*');
 $class_to_filepath = array();
 if ( ! empty($stages)) {
     foreach ($stages as $filepath) {
@@ -87,7 +87,7 @@ 
     private function _checkin_table_exists()
     {
         global $wpdb;
-        $results = $wpdb->get_results("SHOW TABLES LIKE '" . $wpdb->prefix . "events_attendee_checkin" . "'");
+        $results = $wpdb->get_results("SHOW TABLES LIKE '".$wpdb->prefix."events_attendee_checkin"."'");
         if ($results) {
             return true;
         } else {
@@ -107,7 +107,7 @@ 
 //			echo "no version string provided: $version_string";
             //no version string provided... this must be pre 4.1
             //because since 4.1 we're
-            return false;//changed mind. dont want people thinking they should migrate yet because they cant
+            return false; //changed mind. dont want people thinking they should migrate yet because they cant
         } else {
 //			echo "$version_string doesnt apply";
             return false;
@@ -119,7 +119,7 @@ 
     public function schema_changes_before_migration()
     {
         //relies on 4.1's EEH_Activation::create_table
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+        require_once(EE_HELPERS.'EEH_Activation.helper.php');
         $table_name = 'esp_answer';
         $sql = " ANS_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					REG_ID INT UNSIGNED NOT NULL,
@@ -503,12 +503,12 @@ 
     public function insert_default_states()
     {
         global $wpdb;
-        $state_table = $wpdb->prefix . "esp_state";
+        $state_table = $wpdb->prefix."esp_state";
         if ($this->_get_table_analysis()->tableExists($state_table)) {
-            $SQL = "SELECT COUNT('STA_ID') FROM " . $state_table;
+            $SQL = "SELECT COUNT('STA_ID') FROM ".$state_table;
             $states = $wpdb->get_var($SQL);
             if ( ! $states) {
-                $SQL = "INSERT INTO " . $state_table . "
+                $SQL = "INSERT INTO ".$state_table."
 				(STA_ID, CNT_ISO, STA_abbrev, STA_name, STA_active) VALUES
 				(1, 'US', 'AK', 'Alaska', 1),
 				(2, 'US', 'AL', 'Alabama', 1),
@@ -596,12 +596,12 @@ 
     public function insert_default_countries()
     {
         global $wpdb;
-        $country_table = $wpdb->prefix . "esp_country";
+        $country_table = $wpdb->prefix."esp_country";
         if ($this->_get_table_analysis()->tableExists($country_table)) {
-            $SQL = "SELECT COUNT('CNT_ISO') FROM " . $country_table;
+            $SQL = "SELECT COUNT('CNT_ISO') FROM ".$country_table;
             $countries = $wpdb->get_var($SQL);
             if ( ! $countries) {
-                $SQL = "INSERT INTO " . $country_table . "
+                $SQL = "INSERT INTO ".$country_table."
 				(CNT_ISO, CNT_ISO3, RGN_ID, CNT_name, CNT_cur_code, CNT_cur_single, CNT_cur_plural, CNT_cur_sign, CNT_cur_sign_b4, CNT_cur_dec_plc, CNT_tel_code, CNT_is_EU, CNT_active) VALUES
 				('AD', 'AND', 0, 'Andorra', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+376', 0, 0),
 				('AE', 'ARE', 0, 'United Arab Emirates', 'AED', 'Dirham', 'Dirhams', 'د.إ', 1, 2, '+971', 0, 0),
@@ -846,17 +846,17 @@ 
     public function insert_default_price_types()
     {
         global $wpdb;
-        $price_type_table = $wpdb->prefix . "esp_price_type";
+        $price_type_table = $wpdb->prefix."esp_price_type";
         if ($this->_get_table_analysis()->tableExists($price_type_table)) {
-            $SQL = 'SELECT COUNT(PRT_ID) FROM ' . $price_type_table;
+            $SQL = 'SELECT COUNT(PRT_ID) FROM '.$price_type_table;
             $price_types_exist = $wpdb->get_var($SQL);
             if ( ! $price_types_exist) {
                 $SQL = "INSERT INTO $price_type_table ( PRT_ID, PRT_name, PBT_ID, PRT_is_percent, PRT_order, PRT_deleted ) VALUES
-							(1, '" . esc_html__('Base Price', 'event_espresso') . "', 1,  0, 0, 0),
-							(2, '" . esc_html__('Percent Discount', 'event_espresso') . "', 2,  1, 20, 0),
-							(3, '" . esc_html__('Fixed Discount', 'event_espresso') . "', 2,  0, 30, 0),
-							(4, '" . esc_html__('Percent Surcharge', 'event_espresso') . "', 3,  1, 40, 0),
-							(5, '" . esc_html__('Fixed Surcharge', 'event_espresso') . "', 3,  0, 50, 0);";
+							(1, '".esc_html__('Base Price', 'event_espresso')."', 1,  0, 0, 0),
+							(2, '" . esc_html__('Percent Discount', 'event_espresso')."', 2,  1, 20, 0),
+							(3, '" . esc_html__('Fixed Discount', 'event_espresso')."', 2,  0, 30, 0),
+							(4, '" . esc_html__('Percent Surcharge', 'event_espresso')."', 3,  1, 40, 0),
+							(5, '" . esc_html__('Fixed Surcharge', 'event_espresso')."', 3,  0, 50, 0);";
                 $SQL = apply_filters('FHEE__EE_DMS_4_1_0__insert_default_price_types__SQL', $SQL);
                 $wpdb->query($SQL);
             }
@@ -878,9 +878,9 @@ 
     public function insert_default_prices()
     {
         global $wpdb;
-        $price_table = $wpdb->prefix . "esp_price";
+        $price_table = $wpdb->prefix."esp_price";
         if ($this->_get_table_analysis()->tableExists($price_table)) {
-            $SQL = 'SELECT COUNT(PRC_ID) FROM ' . $price_table;
+            $SQL = 'SELECT COUNT(PRC_ID) FROM '.$price_table;
             $prices_exist = $wpdb->get_var($SQL);
             if ( ! $prices_exist) {
                 $SQL = "INSERT INTO $price_table
@@ -904,9 +904,9 @@ 
     public function insert_default_tickets()
     {
         global $wpdb;
-        $ticket_table = $wpdb->prefix . "esp_ticket";
+        $ticket_table = $wpdb->prefix."esp_ticket";
         if ($this->_get_table_analysis()->tableExists($ticket_table)) {
-            $SQL = 'SELECT COUNT(TKT_ID) FROM ' . $ticket_table;
+            $SQL = 'SELECT COUNT(TKT_ID) FROM '.$ticket_table;
             $tickets_exist = $wpdb->get_var($SQL);
             if ( ! $tickets_exist) {
                 $SQL = "INSERT INTO $ticket_table
@@ -918,9 +918,9 @@ 
                 $wpdb->query($SQL);
             }
         }
-        $ticket_price_table = $wpdb->prefix . "esp_ticket_price";
+        $ticket_price_table = $wpdb->prefix."esp_ticket_price";
         if ($this->_get_table_analysis()->tableExists($ticket_price_table)) {
-            $SQL = 'SELECT COUNT(TKP_ID) FROM ' . $ticket_price_table;
+            $SQL = 'SELECT COUNT(TKP_ID) FROM '.$ticket_price_table;
             $ticket_prc_exist = $wpdb->get_var($SQL);
             if ( ! $ticket_prc_exist) {
                 $SQL = "INSERT INTO $ticket_price_table
@@ -950,7 +950,7 @@ 
             throw new EE_Error(esc_html__("Could not get a country because country name is blank", "event_espresso"));
         }
         global $wpdb;
-        $country_table = $wpdb->prefix . "esp_country";
+        $country_table = $wpdb->prefix."esp_country";
         if (is_int($country_name)) {
             $country_name = $this->get_iso_from_3_1_country_id($country_name);
         }
@@ -978,21 +978,21 @@ 
                     'CNT_active'      => true,
             );
             $data_types = array(
-                    '%s',//CNT_ISO
-                    '%s',//CNT_ISO3
-                    '%d',//RGN_ID
-                    '%s',//CNT_name
-                    '%s',//CNT_cur_code
-                    '%s',//CNT_cur_single
-                    '%s',//CNT_cur_plural
-                    '%s',//CNT_cur_sign
-                    '%d',//CNT_cur_sign_b4
-                    '%d',//CNT_cur_dec_plc
-                    '%s',//CNT_cur_dec_mrk
-                    '%s',//CNT_cur_thsnds
-                    '%s',//CNT_tel_code
-                    '%d',//CNT_is_EU
-                    '%d',//CNT_active
+                    '%s', //CNT_ISO
+                    '%s', //CNT_ISO3
+                    '%d', //RGN_ID
+                    '%s', //CNT_name
+                    '%s', //CNT_cur_code
+                    '%s', //CNT_cur_single
+                    '%s', //CNT_cur_plural
+                    '%s', //CNT_cur_sign
+                    '%d', //CNT_cur_sign_b4
+                    '%d', //CNT_cur_dec_plc
+                    '%s', //CNT_cur_dec_mrk
+                    '%s', //CNT_cur_thsnds
+                    '%s', //CNT_tel_code
+                    '%d', //CNT_is_EU
+                    '%d', //CNT_active
             );
             $success = $wpdb->insert($country_table,
                     $cols_n_values,
@@ -1017,7 +1017,7 @@ 
     private function _find_available_country_iso($num_letters = 2)
     {
         global $wpdb;
-        $country_table = $wpdb->prefix . "esp_country";
+        $country_table = $wpdb->prefix."esp_country";
         $attempts = 0;
         do {
             $current_iso = strtoupper(wp_generate_password($num_letters, false));
@@ -1028,7 +1028,7 @@ 
             //keep going until we find an available country code, or we arbitrarily
             //decide we've tried this enough. Somehow they have way too many countries
             //(probably because they're mis-using the EE3 country_id like a custom question)
-        } while (intval($country_with_that_iso) && $attempts < 200);
+        }while (intval($country_with_that_iso) && $attempts < 200);
         return $current_iso;
     }
 
@@ -1055,7 +1055,7 @@ 
             $country_iso = $this->get_default_country_iso();
         }
         global $wpdb;
-        $state_table = $wpdb->prefix . "esp_state";
+        $state_table = $wpdb->prefix."esp_state";
         $state = $wpdb->get_row($wpdb->prepare("SELECT * FROM $state_table WHERE
 			(STA_abbrev LIKE %s OR
 			STA_name LIKE %s) AND
@@ -1069,10 +1069,10 @@ 
                     'STA_active' => true,
             );
             $data_types = array(
-                    '%s',//CNT_ISO
-                    '%s',//STA_abbrev
-                    '%s',//STA_name
-                    '%d',//STA_active
+                    '%s', //CNT_ISO
+                    '%s', //STA_abbrev
+                    '%s', //STA_name
+                    '%d', //STA_active
             );
             $success = $wpdb->insert($state_table, $cols_n_values, $data_types);
             if ( ! $success) {
@@ -1503,7 +1503,7 @@ 
                         "event_espresso"), $guid));
                 return false;
             }
-            $local_filepath = $wp_upload_dir['path'] . DS . basename($guid);
+            $local_filepath = $wp_upload_dir['path'].DS.basename($guid);
             $savefile = fopen($local_filepath, 'w');
             fwrite($savefile, $contents);
             fclose($savefile);
@@ -1526,7 +1526,7 @@ 
         }
         // you must first include the image.php file
         // for the function wp_generate_attachment_metadata() to work
-        require_once(ABSPATH . 'wp-admin/includes/image.php');
+        require_once(ABSPATH.'wp-admin/includes/image.php');
         $attach_data = wp_generate_attachment_metadata($attach_id, $local_filepath);
         if ( ! $attach_data) {
             $migration_stage->add_error(sprintf(esc_html__("Coudl not genereate attachment metadata for attachment post %d with filepath %s and GUID %s. Please check the file was downloaded properly.",
@@ -1709,7 +1709,7 @@ 
         );
         add_filter(
                 'FHEE__ee_migration_page__migration_options_template',
-                array($this,'use_migration_options_from_ee3_template')
+                array($this, 'use_migration_options_from_ee3_template')
         );
     }
 
@@ -1763,7 +1763,7 @@ 
      * @param $template_filepath
      * @return string
      */
-    public function use_migration_options_from_ee3_template( $template_filepath ) {
-        return EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee3.template.php';
+    public function use_migration_options_from_ee3_template($template_filepath) {
+        return EE_MAINTENANCE_TEMPLATE_PATH.'migration_options_from_ee3.template.php';
     }
 }

core/EE_Capabilities.core.php

Doc Comments +3 added lines, -3 removed lines

@@ -805,7 +805,7 @@ 
      * @since                        4.5.0
      *
      * @param string $meta_cap   What meta capability is this mapping.
-     * @param array  $map_values array {
+     * @param string[]  $map_values array {
      *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
      *                           capabilities that don't get mapped to.
      *
@@ -880,8 +880,8 @@ 
      * @since 4.6.x
      *
      * @param $caps
-     * @param $cap
-     * @param $user_id
+     * @param string $cap
+     * @param integer $user_id
      * @param $args
      *
      * @return array

Indentation +1175 added lines, -1175 removed lines

@@ -17,800 +17,800 @@ 
 final class EE_Capabilities extends EE_Base
 {
 
-    /**
-     * the name of the wp option used to store caps previously initialized
-     */
-    const option_name = 'ee_caps_initialized';
-
-    /**
-     * instance of EE_Capabilities object
-     *
-     * @var EE_Capabilities
-     */
-    private static $_instance;
-
-
-    /**
-     * This is a map of caps that correspond to a default WP_Role.
-     * Array is indexed by Role and values are ee capabilities.
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    private $_caps_map = array();
-
-
-    /**
-     * This used to hold an array of EE_Meta_Capability_Map objects that define the granular capabilities mapped to for
-     * a user depending on context.
-     *
-     * @var EE_Meta_Capability_Map[]
-     */
-    private $_meta_caps = array();
-
-
-    /**
-     * singleton method used to instantiate class object
-     *
-     * @since 4.5.0
-     *
-     * @return EE_Capabilities
-     */
-    public static function instance()
-    {
-        //check if instantiated, and if not do so.
-        if (! self::$_instance instanceof EE_Capabilities) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * private constructor
-     *
-     * @since 4.5.0
-     *
-     * @return \EE_Capabilities
-     */
-    private function __construct()
-    {
-    }
-
-
-    /**
-     * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
-     *
-     * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
-     *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
-     *                    ensures that they are up to date.
-     *
-     *
-     * @since 4.5.0
-     * @return void
-     */
-    public function init_caps($reset = false)
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $this->_caps_map = $this->_init_caps_map();
-            $this->init_role_caps($reset);
-            $this->_set_meta_caps();
-        }
-    }
-
-
-    /**
-     * This sets the meta caps property.
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    private function _set_meta_caps()
-    {
-        //make sure we're only ever initializing the default _meta_caps array once if it's empty.
-        $this->_meta_caps = $this->_get_default_meta_caps_array();
-        $this->_meta_caps = apply_filters('FHEE__EE_Capabilities___set_meta_caps__meta_caps', $this->_meta_caps);
-        //add filter for map_meta_caps but only if models can query.
-        if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
-            add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
-        }
-    }
-
-
-    /**
-     * This builds and returns the default meta_caps array only once.
-     *
-     * @since  4.8.28.rc.012
-     * @return array
-     * @throws \EE_Error
-     */
-    private function _get_default_meta_caps_array()
-    {
-        static $default_meta_caps = array();
-        if (empty($default_meta_caps)) {
-            $default_meta_caps = array(
-                //edits
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_event',
-                    array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_venue',
-                    array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_registration',
-                    array('Registration', '', 'ee_edit_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_checkin',
-                    array('Registration', '', 'ee_edit_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_edit_message',
-                    array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_default_ticket',
-                    array('Ticket', '', 'ee_edit_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question',
-                    array('Question', '', '', 'ee_edit_system_questions')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question_group',
-                    array('Question_Group', '', '', 'ee_edit_system_question_groups')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_payment_method',
-                    array('Payment_Method', '', 'ee_edit_others_payment_methods', '')
-                ),
-                //reads
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_event',
-                    array('Event', '', 'ee_read_others_events', 'ee_read_private_events')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_venue',
-                    array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_registration',
-                    array('Registration', '', '', 'ee_edit_others_registrations')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_checkin',
-                    array('Registration', '', '', 'ee_read_others_checkins')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_read_message',
-                    array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_default_ticket',
-                    array('Ticket', '', '', 'ee_read_others_default_tickets')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_payment_method',
-                    array('Payment_Method', '', '', 'ee_read_others_payment_methods')),
-
-                //deletes
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_event',
-                    array(
-                        'Event',
-                        'ee_delete_published_events',
-                        'ee_delete_others_events',
-                        'ee_delete_private_events',
-                    )
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_venue',
-                    array(
-                        'Venue',
-                        'ee_delete_published_venues',
-                        'ee_delete_others_venues',
-                        'ee_delete_private_venues',
-                    )
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_registration',
-                    array('Registration', '', 'ee_delete_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_checkin',
-                    array('Registration', '', 'ee_delete_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_delete_message',
-                    array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_default_ticket',
-                    array('Ticket', '', 'ee_delete_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question',
-                    array('Question', '', '', 'delete_system_questions')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question_group',
-                    array('Question_Group', '', '', 'delete_system_question_groups')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_payment_method',
-                    array('Payment_Method', '', 'ee_delete_others_payment_methods', '')
-                ),
-            );
-        }
-        return $default_meta_caps;
-    }
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array actual users capabilities
-     * @throws EE_Error
-     */
-    public function map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
-            //loop through our _meta_caps array
-            foreach ($this->_meta_caps as $meta_map) {
-                if (! $meta_map instanceof EE_Meta_Capability_Map) {
-                    continue;
-                }
-                // don't load models if there is no object ID in the args
-                if(!empty($args[0])){
-                    $meta_map->ensure_is_model();
-                }
-                $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
-            }
-        }
-        return $caps;
-    }
-
-
-    /**
-     * This sets up and returns the initial capabilities map for Event Espresso
-     *
-     * @since 4.5.0
-     *
-     * @return array
-     */
-    private function _init_caps_map()
-    {
-        $caps = array(
-            'administrator'           => array(
-                //basic access
-                'ee_read_ee',
-                //gateways
-                /**
-                 * note that with payment method capabilities, although we've implemented
-                 * capability mapping which will be used for accessing payment methods owned by
-                 * other users.  This is not fully implemented yet in the payment method ui.
-                 * Currently only the "plural" caps are in active use.
-                 * (Specific payment method caps are in use as well).
-                 **/
-                'ee_manage_gateways',
-                'ee_read_payment_method',
-                'ee_read_payment_methods',
-                'ee_read_others_payment_methods',
-                'ee_edit_payment_method',
-                'ee_edit_payment_methods',
-                'ee_edit_others_payment_methods',
-                'ee_delete_payment_method',
-                'ee_delete_payment_methods',
-                //events
-                'ee_publish_events',
-                'ee_read_private_events',
-                'ee_read_others_events',
-                'ee_read_event',
-                'ee_read_events',
-                'ee_edit_event',
-                'ee_edit_events',
-                'ee_edit_published_events',
-                'ee_edit_others_events',
-                'ee_edit_private_events',
-                'ee_delete_published_events',
-                'ee_delete_private_events',
-                'ee_delete_event',
-                'ee_delete_events',
-                'ee_delete_others_events',
-                //event categories
-                'ee_manage_event_categories',
-                'ee_edit_event_category',
-                'ee_delete_event_category',
-                'ee_assign_event_category',
-                //venues
-                'ee_publish_venues',
-                'ee_read_venue',
-                'ee_read_venues',
-                'ee_read_others_venues',
-                'ee_read_private_venues',
-                'ee_edit_venue',
-                'ee_edit_venues',
-                'ee_edit_others_venues',
-                'ee_edit_published_venues',
-                'ee_edit_private_venues',
-                'ee_delete_venue',
-                'ee_delete_venues',
-                'ee_delete_others_venues',
-                'ee_delete_private_venues',
-                'ee_delete_published_venues',
-                //venue categories
-                'ee_manage_venue_categories',
-                'ee_edit_venue_category',
-                'ee_delete_venue_category',
-                'ee_assign_venue_category',
-                //contacts
-                'ee_read_contact',
-                'ee_read_contacts',
-                'ee_edit_contact',
-                'ee_edit_contacts',
-                'ee_delete_contact',
-                'ee_delete_contacts',
-                //registrations
-                'ee_read_registration',
-                'ee_read_registrations',
-                'ee_read_others_registrations',
-                'ee_edit_registration',
-                'ee_edit_registrations',
-                'ee_edit_others_registrations',
-                'ee_delete_registration',
-                'ee_delete_registrations',
-                //checkins
-                'ee_read_checkin',
-                'ee_read_others_checkins',
-                'ee_read_checkins',
-                'ee_edit_checkin',
-                'ee_edit_checkins',
-                'ee_edit_others_checkins',
-                'ee_delete_checkin',
-                'ee_delete_checkins',
-                'ee_delete_others_checkins',
-                //transactions && payments
-                'ee_read_transaction',
-                'ee_read_transactions',
-                'ee_edit_payments',
-                'ee_delete_payments',
-                //messages
-                'ee_read_message',
-                'ee_read_messages',
-                'ee_read_others_messages',
-                'ee_read_global_messages',
-                'ee_edit_global_messages',
-                'ee_edit_message',
-                'ee_edit_messages',
-                'ee_edit_others_messages',
-                'ee_delete_message',
-                'ee_delete_messages',
-                'ee_delete_others_messages',
-                'ee_delete_global_messages',
-                'ee_send_message',
-                //tickets
-                'ee_read_default_ticket',
-                'ee_read_default_tickets',
-                'ee_read_others_default_tickets',
-                'ee_edit_default_ticket',
-                'ee_edit_default_tickets',
-                'ee_edit_others_default_tickets',
-                'ee_delete_default_ticket',
-                'ee_delete_default_tickets',
-                'ee_delete_others_default_tickets',
-                //prices
-                'ee_edit_default_price',
-                'ee_edit_default_prices',
-                'ee_delete_default_price',
-                'ee_delete_default_prices',
-                'ee_edit_default_price_type',
-                'ee_edit_default_price_types',
-                'ee_delete_default_price_type',
-                'ee_delete_default_price_types',
-                'ee_read_default_prices',
-                'ee_read_default_price_types',
-                //registration form
-                'ee_edit_question',
-                'ee_edit_questions',
-                'ee_edit_system_questions',
-                'ee_read_questions',
-                'ee_delete_question',
-                'ee_delete_questions',
-                'ee_edit_question_group',
-                'ee_edit_question_groups',
-                'ee_read_question_groups',
-                'ee_edit_system_question_groups',
-                'ee_delete_question_group',
-                'ee_delete_question_groups',
-                //event_type taxonomy
-                'ee_assign_event_type',
-                'ee_manage_event_types',
-                'ee_edit_event_type',
-                'ee_delete_event_type',
-            ),
-            'ee_events_administrator' => array(
-                //core wp caps
-                'read',
-                'read_private_pages',
-                'read_private_posts',
-                'edit_users',
-                'edit_posts',
-                'edit_pages',
-                'edit_published_posts',
-                'edit_published_pages',
-                'edit_private_pages',
-                'edit_private_posts',
-                'edit_others_posts',
-                'edit_others_pages',
-                'publish_posts',
-                'publish_pages',
-                'delete_posts',
-                'delete_pages',
-                'delete_private_pages',
-                'delete_private_posts',
-                'delete_published_pages',
-                'delete_published_posts',
-                'delete_others_posts',
-                'delete_others_pages',
-                'manage_categories',
-                'manage_links',
-                'moderate_comments',
-                'unfiltered_html',
-                'upload_files',
-                'export',
-                'import',
-                'list_users',
-                'level_1', //required if user with this role shows up in author dropdowns
-                //basic ee access
-                'ee_read_ee',
-                //events
-                'ee_publish_events',
-                'ee_read_private_events',
-                'ee_read_others_events',
-                'ee_read_event',
-                'ee_read_events',
-                'ee_edit_event',
-                'ee_edit_events',
-                'ee_edit_published_events',
-                'ee_edit_others_events',
-                'ee_edit_private_events',
-                'ee_delete_published_events',
-                'ee_delete_private_events',
-                'ee_delete_event',
-                'ee_delete_events',
-                'ee_delete_others_events',
-                //event categories
-                'ee_manage_event_categories',
-                'ee_edit_event_category',
-                'ee_delete_event_category',
-                'ee_assign_event_category',
-                //venues
-                'ee_publish_venues',
-                'ee_read_venue',
-                'ee_read_venues',
-                'ee_read_others_venues',
-                'ee_read_private_venues',
-                'ee_edit_venue',
-                'ee_edit_venues',
-                'ee_edit_others_venues',
-                'ee_edit_published_venues',
-                'ee_edit_private_venues',
-                'ee_delete_venue',
-                'ee_delete_venues',
-                'ee_delete_others_venues',
-                'ee_delete_private_venues',
-                'ee_delete_published_venues',
-                //venue categories
-                'ee_manage_venue_categories',
-                'ee_edit_venue_category',
-                'ee_delete_venue_category',
-                'ee_assign_venue_category',
-                //contacts
-                'ee_read_contact',
-                'ee_read_contacts',
-                'ee_edit_contact',
-                'ee_edit_contacts',
-                'ee_delete_contact',
-                'ee_delete_contacts',
-                //registrations
-                'ee_read_registration',
-                'ee_read_registrations',
-                'ee_read_others_registrations',
-                'ee_edit_registration',
-                'ee_edit_registrations',
-                'ee_edit_others_registrations',
-                'ee_delete_registration',
-                'ee_delete_registrations',
-                //checkins
-                'ee_read_checkin',
-                'ee_read_others_checkins',
-                'ee_read_checkins',
-                'ee_edit_checkin',
-                'ee_edit_checkins',
-                'ee_edit_others_checkins',
-                'ee_delete_checkin',
-                'ee_delete_checkins',
-                'ee_delete_others_checkins',
-                //transactions && payments
-                'ee_read_transaction',
-                'ee_read_transactions',
-                'ee_edit_payments',
-                'ee_delete_payments',
-                //messages
-                'ee_read_message',
-                'ee_read_messages',
-                'ee_read_others_messages',
-                'ee_read_global_messages',
-                'ee_edit_global_messages',
-                'ee_edit_message',
-                'ee_edit_messages',
-                'ee_edit_others_messages',
-                'ee_delete_message',
-                'ee_delete_messages',
-                'ee_delete_others_messages',
-                'ee_delete_global_messages',
-                'ee_send_message',
-                //tickets
-                'ee_read_default_ticket',
-                'ee_read_default_tickets',
-                'ee_read_others_default_tickets',
-                'ee_edit_default_ticket',
-                'ee_edit_default_tickets',
-                'ee_edit_others_default_tickets',
-                'ee_delete_default_ticket',
-                'ee_delete_default_tickets',
-                'ee_delete_others_default_tickets',
-                //prices
-                'ee_edit_default_price',
-                'ee_edit_default_prices',
-                'ee_delete_default_price',
-                'ee_delete_default_prices',
-                'ee_edit_default_price_type',
-                'ee_edit_default_price_types',
-                'ee_delete_default_price_type',
-                'ee_delete_default_price_types',
-                'ee_read_default_prices',
-                'ee_read_default_price_types',
-                //registration form
-                'ee_edit_question',
-                'ee_edit_questions',
-                'ee_edit_system_questions',
-                'ee_read_questions',
-                'ee_delete_question',
-                'ee_delete_questions',
-                'ee_edit_question_group',
-                'ee_edit_question_groups',
-                'ee_read_question_groups',
-                'ee_edit_system_question_groups',
-                'ee_delete_question_group',
-                'ee_delete_question_groups',
-                //event_type taxonomy
-                'ee_assign_event_type',
-                'ee_manage_event_types',
-                'ee_edit_event_type',
-                'ee_delete_event_type',
-            )
-        );
-        $caps = apply_filters('FHEE__EE_Capabilities__init_caps_map__caps', $caps);
-        return $caps;
-    }
-
-
-    /**
-     * This adds all the default caps to roles as registered in the _caps_map property.
-     *
-     * @since 4.5.0
-     *
-     * @param bool  $reset      allows for resetting the default capabilities saved on roles.  Note that this doesn't
-     *                          actually REMOVE any capabilities from existing roles, it just resaves defaults roles
-     *                          and ensures that they are up to date.
-     * @param array $custom_map Optional.  Can be used to send a custom map of roles and capabilities for setting them
-     *                          up.  Note that this should ONLY be called on activation hook or some other one-time
-     *                          task otherwise the caps will be added on every request.
-     *
-     * @return void
-     */
-    public function init_role_caps($reset = false, $custom_map = array())
-    {
-        $caps_map = empty($custom_map) ? $this->_caps_map : $custom_map;
-        //first let's determine if these caps have already been set.
-        $caps_set_before = get_option(self::option_name, array());
-        //if not reset, see what caps are new for each role. if they're new, add them.
-        foreach ($caps_map as $role => $caps_for_role) {
-            foreach ($caps_for_role as $cap) {
-                //first check we haven't already added this cap before, or it's a reset
-                if ($reset || ! isset($caps_set_before[ $role ]) || ! in_array($cap, $caps_set_before[ $role ])) {
-                    if ($this->add_cap_to_role($role, $cap)) {
-                        $caps_set_before[ $role ][] = $cap;
-                    }
-                }
-            }
-        }
-        //now let's just save the cap that has been set.
-        update_option(self::option_name, $caps_set_before);
-        do_action('AHEE__EE_Capabilities__init_role_caps__complete', $caps_set_before);
-    }
-
-
-    /**
-     * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
-     * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
-     * this is a wrapper for $wp_role->add_cap()
-     *
-     * @see   wp-includes/capabilities.php
-     *
-     * @since 4.5.0
-     *
-     * @param string $role  A WordPress role the capability is being added to
-     * @param string $cap   The capability being added to the role
-     * @param bool   $grant Whether to grant access to this cap on this role.
-     *
-     * @return bool
-     */
-    public function add_cap_to_role($role, $cap, $grant = true)
-    {
-        $role_object = get_role($role);
-        //if the role isn't available then we create it.
-        if (! $role_object instanceof WP_Role) {
-            //if a plugin wants to create a specific role name then they should create the role before
-            //EE_Capabilities does.  Otherwise this function will create the role name from the slug:
-            // - removes any `ee_` namespacing from the start of the slug.
-            // - replaces `_` with ` ` (empty space).
-            // - sentence case on the resulting string.
-            $role_label = ucwords(str_replace('_', ' ', str_replace('ee_', '', $role)));
-            $role_object = add_role($role, $role_label);
-        }
-        if ($role_object instanceof WP_Role) {
-            $role_object->add_cap($cap, $grant);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Functions similarly to add_cap_to_role except removes cap from given role.
-     * Wrapper for $wp_role->remove_cap()
-     *
-     * @see   wp-includes/capabilities.php
-     * @since 4.5.0
-     *
-     * @param string $role A WordPress role the capability is being removed from.
-     * @param string $cap  The capability being removed
-     *
-     * @return void
-     */
-    public function remove_cap_from_role($role, $cap)
-    {
-        $role = get_role($role);
-        if ($role instanceof WP_Role) {
-            $role->remove_cap($cap);
-        }
-    }
-
-
-    /**
-     * Wrapper for the native WP current_user_can() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @since 4.5.0
-     *
-     * @param string $cap     The cap being checked.
-     * @param string $context The context where the current_user_can is being called from.
-     * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
-     *                        filters.
-     *
-     * @return bool  Whether user can or not.
-     */
-    public function current_user_can($cap, $context, $id = 0)
-    {
-        //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap', $filtered_cap, $context, $cap,
-            $id);
-        return ! empty($id) ? current_user_can($filtered_cap, $id) : current_user_can($filtered_cap);
-    }
-
-
-    /**
-     * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
-     *
-     * @param int|WP_User $user    Either the user_id or a WP_User object
-     * @param string      $cap     The capability string being checked
-     * @param string      $context The context where the user_can is being called from (used in filters).
-     * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
-     *                             filters)
-     *
-     * @return bool Whether user can or not.
-     */
-    public function user_can($user, $cap, $context, $id = 0)
-    {
-        //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap', $filtered_cap, $context, $cap, $user,
-            $id);
-        return ! empty($id) ? user_can($user, $filtered_cap, $id) : user_can($user, $filtered_cap);
-    }
-
-
-    /**
-     * Wrapper for the native WP current_user_can_for_blog() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @since 4.5.0
-     *
-     * @param int    $blog_id The blog id that is being checked for.
-     * @param string $cap     The cap being checked.
-     * @param string $context The context where the current_user_can is being called from.
-     * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
-     *                        filters.
-     *
-     * @return bool  Whether user can or not.
-     */
-    public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0)
-    {
-        $user_can = ! empty($id)
-            ? current_user_can_for_blog($blog_id, $cap, $id)
-            : current_user_can($blog_id, $cap);
-        //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
-            $user_can,
-            $blog_id,
-            $cap,
-            $id
-        );
-        $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
-            $user_can,
-            $context,
-            $blog_id,
-            $cap,
-            $id
-        );
-        return $user_can;
-    }
-
-
-    /**
-     * This helper method just returns an array of registered EE capabilities.
-     * Note this array is filtered.  It is assumed that all available EE capabilities are assigned to the administrator
-     * role.
-     *
-     * @since 4.5.0
-     *
-     * @param string $role If empty then the entire role/capability map is returned.  Otherwise just the capabilities
-     *                     for the given role are returned.
-     *
-     * @return array
-     */
-    public function get_ee_capabilities($role = 'administrator')
-    {
-        $capabilities = $this->_init_caps_map();
-        if (empty($role)) {
-            return $capabilities;
-        }
-        return isset($capabilities[ $role ]) ? $capabilities[ $role ] : array();
-    }
+	/**
+	 * the name of the wp option used to store caps previously initialized
+	 */
+	const option_name = 'ee_caps_initialized';
+
+	/**
+	 * instance of EE_Capabilities object
+	 *
+	 * @var EE_Capabilities
+	 */
+	private static $_instance;
+
+
+	/**
+	 * This is a map of caps that correspond to a default WP_Role.
+	 * Array is indexed by Role and values are ee capabilities.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	private $_caps_map = array();
+
+
+	/**
+	 * This used to hold an array of EE_Meta_Capability_Map objects that define the granular capabilities mapped to for
+	 * a user depending on context.
+	 *
+	 * @var EE_Meta_Capability_Map[]
+	 */
+	private $_meta_caps = array();
+
+
+	/**
+	 * singleton method used to instantiate class object
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return EE_Capabilities
+	 */
+	public static function instance()
+	{
+		//check if instantiated, and if not do so.
+		if (! self::$_instance instanceof EE_Capabilities) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * private constructor
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return \EE_Capabilities
+	 */
+	private function __construct()
+	{
+	}
+
+
+	/**
+	 * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
+	 *
+	 * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
+	 *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
+	 *                    ensures that they are up to date.
+	 *
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 */
+	public function init_caps($reset = false)
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$this->_caps_map = $this->_init_caps_map();
+			$this->init_role_caps($reset);
+			$this->_set_meta_caps();
+		}
+	}
+
+
+	/**
+	 * This sets the meta caps property.
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	private function _set_meta_caps()
+	{
+		//make sure we're only ever initializing the default _meta_caps array once if it's empty.
+		$this->_meta_caps = $this->_get_default_meta_caps_array();
+		$this->_meta_caps = apply_filters('FHEE__EE_Capabilities___set_meta_caps__meta_caps', $this->_meta_caps);
+		//add filter for map_meta_caps but only if models can query.
+		if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
+			add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
+		}
+	}
+
+
+	/**
+	 * This builds and returns the default meta_caps array only once.
+	 *
+	 * @since  4.8.28.rc.012
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	private function _get_default_meta_caps_array()
+	{
+		static $default_meta_caps = array();
+		if (empty($default_meta_caps)) {
+			$default_meta_caps = array(
+				//edits
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_event',
+					array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_venue',
+					array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_registration',
+					array('Registration', '', 'ee_edit_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_checkin',
+					array('Registration', '', 'ee_edit_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_edit_message',
+					array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_default_ticket',
+					array('Ticket', '', 'ee_edit_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question',
+					array('Question', '', '', 'ee_edit_system_questions')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question_group',
+					array('Question_Group', '', '', 'ee_edit_system_question_groups')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_payment_method',
+					array('Payment_Method', '', 'ee_edit_others_payment_methods', '')
+				),
+				//reads
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_event',
+					array('Event', '', 'ee_read_others_events', 'ee_read_private_events')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_venue',
+					array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_registration',
+					array('Registration', '', '', 'ee_edit_others_registrations')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_checkin',
+					array('Registration', '', '', 'ee_read_others_checkins')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_read_message',
+					array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_default_ticket',
+					array('Ticket', '', '', 'ee_read_others_default_tickets')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_payment_method',
+					array('Payment_Method', '', '', 'ee_read_others_payment_methods')),
+
+				//deletes
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_event',
+					array(
+						'Event',
+						'ee_delete_published_events',
+						'ee_delete_others_events',
+						'ee_delete_private_events',
+					)
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_venue',
+					array(
+						'Venue',
+						'ee_delete_published_venues',
+						'ee_delete_others_venues',
+						'ee_delete_private_venues',
+					)
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_registration',
+					array('Registration', '', 'ee_delete_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_checkin',
+					array('Registration', '', 'ee_delete_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_delete_message',
+					array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_default_ticket',
+					array('Ticket', '', 'ee_delete_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question',
+					array('Question', '', '', 'delete_system_questions')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question_group',
+					array('Question_Group', '', '', 'delete_system_question_groups')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_payment_method',
+					array('Payment_Method', '', 'ee_delete_others_payment_methods', '')
+				),
+			);
+		}
+		return $default_meta_caps;
+	}
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array actual users capabilities
+	 * @throws EE_Error
+	 */
+	public function map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
+			//loop through our _meta_caps array
+			foreach ($this->_meta_caps as $meta_map) {
+				if (! $meta_map instanceof EE_Meta_Capability_Map) {
+					continue;
+				}
+				// don't load models if there is no object ID in the args
+				if(!empty($args[0])){
+					$meta_map->ensure_is_model();
+				}
+				$caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
+			}
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * This sets up and returns the initial capabilities map for Event Espresso
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return array
+	 */
+	private function _init_caps_map()
+	{
+		$caps = array(
+			'administrator'           => array(
+				//basic access
+				'ee_read_ee',
+				//gateways
+				/**
+				 * note that with payment method capabilities, although we've implemented
+				 * capability mapping which will be used for accessing payment methods owned by
+				 * other users.  This is not fully implemented yet in the payment method ui.
+				 * Currently only the "plural" caps are in active use.
+				 * (Specific payment method caps are in use as well).
+				 **/
+				'ee_manage_gateways',
+				'ee_read_payment_method',
+				'ee_read_payment_methods',
+				'ee_read_others_payment_methods',
+				'ee_edit_payment_method',
+				'ee_edit_payment_methods',
+				'ee_edit_others_payment_methods',
+				'ee_delete_payment_method',
+				'ee_delete_payment_methods',
+				//events
+				'ee_publish_events',
+				'ee_read_private_events',
+				'ee_read_others_events',
+				'ee_read_event',
+				'ee_read_events',
+				'ee_edit_event',
+				'ee_edit_events',
+				'ee_edit_published_events',
+				'ee_edit_others_events',
+				'ee_edit_private_events',
+				'ee_delete_published_events',
+				'ee_delete_private_events',
+				'ee_delete_event',
+				'ee_delete_events',
+				'ee_delete_others_events',
+				//event categories
+				'ee_manage_event_categories',
+				'ee_edit_event_category',
+				'ee_delete_event_category',
+				'ee_assign_event_category',
+				//venues
+				'ee_publish_venues',
+				'ee_read_venue',
+				'ee_read_venues',
+				'ee_read_others_venues',
+				'ee_read_private_venues',
+				'ee_edit_venue',
+				'ee_edit_venues',
+				'ee_edit_others_venues',
+				'ee_edit_published_venues',
+				'ee_edit_private_venues',
+				'ee_delete_venue',
+				'ee_delete_venues',
+				'ee_delete_others_venues',
+				'ee_delete_private_venues',
+				'ee_delete_published_venues',
+				//venue categories
+				'ee_manage_venue_categories',
+				'ee_edit_venue_category',
+				'ee_delete_venue_category',
+				'ee_assign_venue_category',
+				//contacts
+				'ee_read_contact',
+				'ee_read_contacts',
+				'ee_edit_contact',
+				'ee_edit_contacts',
+				'ee_delete_contact',
+				'ee_delete_contacts',
+				//registrations
+				'ee_read_registration',
+				'ee_read_registrations',
+				'ee_read_others_registrations',
+				'ee_edit_registration',
+				'ee_edit_registrations',
+				'ee_edit_others_registrations',
+				'ee_delete_registration',
+				'ee_delete_registrations',
+				//checkins
+				'ee_read_checkin',
+				'ee_read_others_checkins',
+				'ee_read_checkins',
+				'ee_edit_checkin',
+				'ee_edit_checkins',
+				'ee_edit_others_checkins',
+				'ee_delete_checkin',
+				'ee_delete_checkins',
+				'ee_delete_others_checkins',
+				//transactions && payments
+				'ee_read_transaction',
+				'ee_read_transactions',
+				'ee_edit_payments',
+				'ee_delete_payments',
+				//messages
+				'ee_read_message',
+				'ee_read_messages',
+				'ee_read_others_messages',
+				'ee_read_global_messages',
+				'ee_edit_global_messages',
+				'ee_edit_message',
+				'ee_edit_messages',
+				'ee_edit_others_messages',
+				'ee_delete_message',
+				'ee_delete_messages',
+				'ee_delete_others_messages',
+				'ee_delete_global_messages',
+				'ee_send_message',
+				//tickets
+				'ee_read_default_ticket',
+				'ee_read_default_tickets',
+				'ee_read_others_default_tickets',
+				'ee_edit_default_ticket',
+				'ee_edit_default_tickets',
+				'ee_edit_others_default_tickets',
+				'ee_delete_default_ticket',
+				'ee_delete_default_tickets',
+				'ee_delete_others_default_tickets',
+				//prices
+				'ee_edit_default_price',
+				'ee_edit_default_prices',
+				'ee_delete_default_price',
+				'ee_delete_default_prices',
+				'ee_edit_default_price_type',
+				'ee_edit_default_price_types',
+				'ee_delete_default_price_type',
+				'ee_delete_default_price_types',
+				'ee_read_default_prices',
+				'ee_read_default_price_types',
+				//registration form
+				'ee_edit_question',
+				'ee_edit_questions',
+				'ee_edit_system_questions',
+				'ee_read_questions',
+				'ee_delete_question',
+				'ee_delete_questions',
+				'ee_edit_question_group',
+				'ee_edit_question_groups',
+				'ee_read_question_groups',
+				'ee_edit_system_question_groups',
+				'ee_delete_question_group',
+				'ee_delete_question_groups',
+				//event_type taxonomy
+				'ee_assign_event_type',
+				'ee_manage_event_types',
+				'ee_edit_event_type',
+				'ee_delete_event_type',
+			),
+			'ee_events_administrator' => array(
+				//core wp caps
+				'read',
+				'read_private_pages',
+				'read_private_posts',
+				'edit_users',
+				'edit_posts',
+				'edit_pages',
+				'edit_published_posts',
+				'edit_published_pages',
+				'edit_private_pages',
+				'edit_private_posts',
+				'edit_others_posts',
+				'edit_others_pages',
+				'publish_posts',
+				'publish_pages',
+				'delete_posts',
+				'delete_pages',
+				'delete_private_pages',
+				'delete_private_posts',
+				'delete_published_pages',
+				'delete_published_posts',
+				'delete_others_posts',
+				'delete_others_pages',
+				'manage_categories',
+				'manage_links',
+				'moderate_comments',
+				'unfiltered_html',
+				'upload_files',
+				'export',
+				'import',
+				'list_users',
+				'level_1', //required if user with this role shows up in author dropdowns
+				//basic ee access
+				'ee_read_ee',
+				//events
+				'ee_publish_events',
+				'ee_read_private_events',
+				'ee_read_others_events',
+				'ee_read_event',
+				'ee_read_events',
+				'ee_edit_event',
+				'ee_edit_events',
+				'ee_edit_published_events',
+				'ee_edit_others_events',
+				'ee_edit_private_events',
+				'ee_delete_published_events',
+				'ee_delete_private_events',
+				'ee_delete_event',
+				'ee_delete_events',
+				'ee_delete_others_events',
+				//event categories
+				'ee_manage_event_categories',
+				'ee_edit_event_category',
+				'ee_delete_event_category',
+				'ee_assign_event_category',
+				//venues
+				'ee_publish_venues',
+				'ee_read_venue',
+				'ee_read_venues',
+				'ee_read_others_venues',
+				'ee_read_private_venues',
+				'ee_edit_venue',
+				'ee_edit_venues',
+				'ee_edit_others_venues',
+				'ee_edit_published_venues',
+				'ee_edit_private_venues',
+				'ee_delete_venue',
+				'ee_delete_venues',
+				'ee_delete_others_venues',
+				'ee_delete_private_venues',
+				'ee_delete_published_venues',
+				//venue categories
+				'ee_manage_venue_categories',
+				'ee_edit_venue_category',
+				'ee_delete_venue_category',
+				'ee_assign_venue_category',
+				//contacts
+				'ee_read_contact',
+				'ee_read_contacts',
+				'ee_edit_contact',
+				'ee_edit_contacts',
+				'ee_delete_contact',
+				'ee_delete_contacts',
+				//registrations
+				'ee_read_registration',
+				'ee_read_registrations',
+				'ee_read_others_registrations',
+				'ee_edit_registration',
+				'ee_edit_registrations',
+				'ee_edit_others_registrations',
+				'ee_delete_registration',
+				'ee_delete_registrations',
+				//checkins
+				'ee_read_checkin',
+				'ee_read_others_checkins',
+				'ee_read_checkins',
+				'ee_edit_checkin',
+				'ee_edit_checkins',
+				'ee_edit_others_checkins',
+				'ee_delete_checkin',
+				'ee_delete_checkins',
+				'ee_delete_others_checkins',
+				//transactions && payments
+				'ee_read_transaction',
+				'ee_read_transactions',
+				'ee_edit_payments',
+				'ee_delete_payments',
+				//messages
+				'ee_read_message',
+				'ee_read_messages',
+				'ee_read_others_messages',
+				'ee_read_global_messages',
+				'ee_edit_global_messages',
+				'ee_edit_message',
+				'ee_edit_messages',
+				'ee_edit_others_messages',
+				'ee_delete_message',
+				'ee_delete_messages',
+				'ee_delete_others_messages',
+				'ee_delete_global_messages',
+				'ee_send_message',
+				//tickets
+				'ee_read_default_ticket',
+				'ee_read_default_tickets',
+				'ee_read_others_default_tickets',
+				'ee_edit_default_ticket',
+				'ee_edit_default_tickets',
+				'ee_edit_others_default_tickets',
+				'ee_delete_default_ticket',
+				'ee_delete_default_tickets',
+				'ee_delete_others_default_tickets',
+				//prices
+				'ee_edit_default_price',
+				'ee_edit_default_prices',
+				'ee_delete_default_price',
+				'ee_delete_default_prices',
+				'ee_edit_default_price_type',
+				'ee_edit_default_price_types',
+				'ee_delete_default_price_type',
+				'ee_delete_default_price_types',
+				'ee_read_default_prices',
+				'ee_read_default_price_types',
+				//registration form
+				'ee_edit_question',
+				'ee_edit_questions',
+				'ee_edit_system_questions',
+				'ee_read_questions',
+				'ee_delete_question',
+				'ee_delete_questions',
+				'ee_edit_question_group',
+				'ee_edit_question_groups',
+				'ee_read_question_groups',
+				'ee_edit_system_question_groups',
+				'ee_delete_question_group',
+				'ee_delete_question_groups',
+				//event_type taxonomy
+				'ee_assign_event_type',
+				'ee_manage_event_types',
+				'ee_edit_event_type',
+				'ee_delete_event_type',
+			)
+		);
+		$caps = apply_filters('FHEE__EE_Capabilities__init_caps_map__caps', $caps);
+		return $caps;
+	}
+
+
+	/**
+	 * This adds all the default caps to roles as registered in the _caps_map property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param bool  $reset      allows for resetting the default capabilities saved on roles.  Note that this doesn't
+	 *                          actually REMOVE any capabilities from existing roles, it just resaves defaults roles
+	 *                          and ensures that they are up to date.
+	 * @param array $custom_map Optional.  Can be used to send a custom map of roles and capabilities for setting them
+	 *                          up.  Note that this should ONLY be called on activation hook or some other one-time
+	 *                          task otherwise the caps will be added on every request.
+	 *
+	 * @return void
+	 */
+	public function init_role_caps($reset = false, $custom_map = array())
+	{
+		$caps_map = empty($custom_map) ? $this->_caps_map : $custom_map;
+		//first let's determine if these caps have already been set.
+		$caps_set_before = get_option(self::option_name, array());
+		//if not reset, see what caps are new for each role. if they're new, add them.
+		foreach ($caps_map as $role => $caps_for_role) {
+			foreach ($caps_for_role as $cap) {
+				//first check we haven't already added this cap before, or it's a reset
+				if ($reset || ! isset($caps_set_before[ $role ]) || ! in_array($cap, $caps_set_before[ $role ])) {
+					if ($this->add_cap_to_role($role, $cap)) {
+						$caps_set_before[ $role ][] = $cap;
+					}
+				}
+			}
+		}
+		//now let's just save the cap that has been set.
+		update_option(self::option_name, $caps_set_before);
+		do_action('AHEE__EE_Capabilities__init_role_caps__complete', $caps_set_before);
+	}
+
+
+	/**
+	 * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
+	 * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
+	 * this is a wrapper for $wp_role->add_cap()
+	 *
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $role  A WordPress role the capability is being added to
+	 * @param string $cap   The capability being added to the role
+	 * @param bool   $grant Whether to grant access to this cap on this role.
+	 *
+	 * @return bool
+	 */
+	public function add_cap_to_role($role, $cap, $grant = true)
+	{
+		$role_object = get_role($role);
+		//if the role isn't available then we create it.
+		if (! $role_object instanceof WP_Role) {
+			//if a plugin wants to create a specific role name then they should create the role before
+			//EE_Capabilities does.  Otherwise this function will create the role name from the slug:
+			// - removes any `ee_` namespacing from the start of the slug.
+			// - replaces `_` with ` ` (empty space).
+			// - sentence case on the resulting string.
+			$role_label = ucwords(str_replace('_', ' ', str_replace('ee_', '', $role)));
+			$role_object = add_role($role, $role_label);
+		}
+		if ($role_object instanceof WP_Role) {
+			$role_object->add_cap($cap, $grant);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Functions similarly to add_cap_to_role except removes cap from given role.
+	 * Wrapper for $wp_role->remove_cap()
+	 *
+	 * @see   wp-includes/capabilities.php
+	 * @since 4.5.0
+	 *
+	 * @param string $role A WordPress role the capability is being removed from.
+	 * @param string $cap  The capability being removed
+	 *
+	 * @return void
+	 */
+	public function remove_cap_from_role($role, $cap)
+	{
+		$role = get_role($role);
+		if ($role instanceof WP_Role) {
+			$role->remove_cap($cap);
+		}
+	}
+
+
+	/**
+	 * Wrapper for the native WP current_user_can() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $cap     The cap being checked.
+	 * @param string $context The context where the current_user_can is being called from.
+	 * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
+	 *                        filters.
+	 *
+	 * @return bool  Whether user can or not.
+	 */
+	public function current_user_can($cap, $context, $id = 0)
+	{
+		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap', $filtered_cap, $context, $cap,
+			$id);
+		return ! empty($id) ? current_user_can($filtered_cap, $id) : current_user_can($filtered_cap);
+	}
+
+
+	/**
+	 * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
+	 *
+	 * @param int|WP_User $user    Either the user_id or a WP_User object
+	 * @param string      $cap     The capability string being checked
+	 * @param string      $context The context where the user_can is being called from (used in filters).
+	 * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
+	 *                             filters)
+	 *
+	 * @return bool Whether user can or not.
+	 */
+	public function user_can($user, $cap, $context, $id = 0)
+	{
+		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap', $filtered_cap, $context, $cap, $user,
+			$id);
+		return ! empty($id) ? user_can($user, $filtered_cap, $id) : user_can($user, $filtered_cap);
+	}
+
+
+	/**
+	 * Wrapper for the native WP current_user_can_for_blog() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param int    $blog_id The blog id that is being checked for.
+	 * @param string $cap     The cap being checked.
+	 * @param string $context The context where the current_user_can is being called from.
+	 * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
+	 *                        filters.
+	 *
+	 * @return bool  Whether user can or not.
+	 */
+	public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0)
+	{
+		$user_can = ! empty($id)
+			? current_user_can_for_blog($blog_id, $cap, $id)
+			: current_user_can($blog_id, $cap);
+		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$user_can = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
+			$user_can,
+			$blog_id,
+			$cap,
+			$id
+		);
+		$user_can = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
+			$user_can,
+			$context,
+			$blog_id,
+			$cap,
+			$id
+		);
+		return $user_can;
+	}
+
+
+	/**
+	 * This helper method just returns an array of registered EE capabilities.
+	 * Note this array is filtered.  It is assumed that all available EE capabilities are assigned to the administrator
+	 * role.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $role If empty then the entire role/capability map is returned.  Otherwise just the capabilities
+	 *                     for the given role are returned.
+	 *
+	 * @return array
+	 */
+	public function get_ee_capabilities($role = 'administrator')
+	{
+		$capabilities = $this->_init_caps_map();
+		if (empty($role)) {
+			return $capabilities;
+		}
+		return isset($capabilities[ $role ]) ? $capabilities[ $role ] : array();
+	}
 }
 
 
@@ -827,142 +827,142 @@ 
 abstract class EE_Meta_Capability_Map
 {
 
-    public $meta_cap;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $_model;
-
-    protected $_model_name;
-
-    public $published_cap = '';
-
-    public $others_cap = '';
-
-    public $private_cap = '';
-
-
-    /**
-     * constructor.
-     * Receives the setup arguments for the map.
-     *
-     * @since                        4.5.0
-     *
-     * @param string $meta_cap   What meta capability is this mapping.
-     * @param array  $map_values array {
-     *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
-     *                           capabilities that don't get mapped to.
-     *
-     * @type         $map_values [0] string A string representing the model name. Required.  String's
-     *                               should always be used when Menu Maps are registered via the
-     *                               plugin API as models are not allowed to be instantiated when
-     *                               in maintenance mode 2 (migrations).
-     * @type         $map_values [1] string represents the capability used for published. Optional.
-     * @type         $map_values [2] string represents the capability used for "others". Optional.
-     * @type         $map_values [3] string represents the capability used for private. Optional.
-     *                               }
-     * @throws EE_Error
-     */
-    public function __construct($meta_cap, $map_values)
-    {
-        $this->meta_cap = $meta_cap;
-        //verify there are four args in the $map_values array;
-        if (count($map_values) !== 4) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
-                        'event_espresso'
-                    ),
-                    '<br>' . print_r($map_values, true)
-                )
-            );
-        }
-        //set properties
-        $this->_model = null;
-        $this->_model_name = $map_values[0];
-        $this->published_cap = (string)$map_values[1];
-        $this->others_cap = (string)$map_values[2];
-        $this->private_cap = (string)$map_values[3];
-    }
-
-    /**
-     * Makes it so this object stops filtering caps
-     */
-    public function remove_filters()
-    {
-        remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
-    }
-
-
-    /**
-     * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
-     *
-     * @since 4.5.0
-     * @throws EE_Error
-     *
-     * @return void
-     */
-    public function ensure_is_model()
-    {
-        //is it already instantiated?
-        if ($this->_model instanceof EEM_Base) {
-            return;
-        }
-        //ensure model name is string
-        $this->_model_name = (string)$this->_model_name;
-        //error proof if the name has EEM in it
-        $this->_model_name = str_replace('EEM', '', $this->_model_name);
-        $this->_model = EE_Registry::instance()->load_model($this->_model_name);
-        if (! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    $this->_model
-                )
-            );
-        }
-    }
-
-
-    /**
-     *
-     * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
-     * @since 4.6.x
-     *
-     * @param $caps
-     * @param $cap
-     * @param $user_id
-     * @param $args
-     *
-     * @return array
-     */
-    public function map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        return $this->_map_meta_caps($caps, $cap, $user_id, $args);
-    }
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
+	public $meta_cap;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model;
+
+	protected $_model_name;
+
+	public $published_cap = '';
+
+	public $others_cap = '';
+
+	public $private_cap = '';
+
+
+	/**
+	 * constructor.
+	 * Receives the setup arguments for the map.
+	 *
+	 * @since                        4.5.0
+	 *
+	 * @param string $meta_cap   What meta capability is this mapping.
+	 * @param array  $map_values array {
+	 *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
+	 *                           capabilities that don't get mapped to.
+	 *
+	 * @type         $map_values [0] string A string representing the model name. Required.  String's
+	 *                               should always be used when Menu Maps are registered via the
+	 *                               plugin API as models are not allowed to be instantiated when
+	 *                               in maintenance mode 2 (migrations).
+	 * @type         $map_values [1] string represents the capability used for published. Optional.
+	 * @type         $map_values [2] string represents the capability used for "others". Optional.
+	 * @type         $map_values [3] string represents the capability used for private. Optional.
+	 *                               }
+	 * @throws EE_Error
+	 */
+	public function __construct($meta_cap, $map_values)
+	{
+		$this->meta_cap = $meta_cap;
+		//verify there are four args in the $map_values array;
+		if (count($map_values) !== 4) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
+						'event_espresso'
+					),
+					'<br>' . print_r($map_values, true)
+				)
+			);
+		}
+		//set properties
+		$this->_model = null;
+		$this->_model_name = $map_values[0];
+		$this->published_cap = (string)$map_values[1];
+		$this->others_cap = (string)$map_values[2];
+		$this->private_cap = (string)$map_values[3];
+	}
+
+	/**
+	 * Makes it so this object stops filtering caps
+	 */
+	public function remove_filters()
+	{
+		remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
+	}
+
+
+	/**
+	 * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
+	 *
+	 * @since 4.5.0
+	 * @throws EE_Error
+	 *
+	 * @return void
+	 */
+	public function ensure_is_model()
+	{
+		//is it already instantiated?
+		if ($this->_model instanceof EEM_Base) {
+			return;
+		}
+		//ensure model name is string
+		$this->_model_name = (string)$this->_model_name;
+		//error proof if the name has EEM in it
+		$this->_model_name = str_replace('EEM', '', $this->_model_name);
+		$this->_model = EE_Registry::instance()->load_model($this->_model_name);
+		if (! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
+						'event_espresso'
+					),
+					get_class($this),
+					$this->_model
+				)
+			);
+		}
+	}
+
+
+	/**
+	 *
+	 * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
+	 * @since 4.6.x
+	 *
+	 * @param $caps
+	 * @param $cap
+	 * @param $user_id
+	 * @param $args
+	 *
+	 * @return array
+	 */
+	public function map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		return $this->_map_meta_caps($caps, $cap, $user_id, $args);
+	}
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
 }
 
 
@@ -978,83 +978,83 @@ 
 class EE_Meta_Capability_Map_Edit extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        //cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        /** @var EE_Base_Class $obj */
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = $cap;
-            return $caps;
-        }
-        if ($obj instanceof EE_CPT_Base) {
-            //if the item author is set and the user is the author...
-            if ($obj->wp_user() && $user_id === $obj->wp_user()) {
-                if (empty($this->published_cap)) {
-                    $caps[] = $cap;
-                } else {
-                    //if obj is published...
-                    if ($obj->status() === 'publish') {
-                        $caps[] = $this->published_cap;
-                    } else {
-                        $caps[] = $cap;
-                    }
-                }
-            } else {
-                //the user is trying to edit someone else's obj
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-                if (! empty($this->published_cap) && $obj->status() === 'publish') {
-                    $caps[] = $this->published_cap;
-                } elseif (! empty($this->private_cap) && $obj->status() === 'private') {
-                    $caps[] = $this->private_cap;
-                }
-            }
-        } else {
-            //not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user')
-                    && $obj->wp_user()
-                    && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if ($has_cap) {
-                $caps[] = $cap;
-            } else {
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		//cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		/** @var EE_Base_Class $obj */
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = $cap;
+			return $caps;
+		}
+		if ($obj instanceof EE_CPT_Base) {
+			//if the item author is set and the user is the author...
+			if ($obj->wp_user() && $user_id === $obj->wp_user()) {
+				if (empty($this->published_cap)) {
+					$caps[] = $cap;
+				} else {
+					//if obj is published...
+					if ($obj->status() === 'publish') {
+						$caps[] = $this->published_cap;
+					} else {
+						$caps[] = $cap;
+					}
+				}
+			} else {
+				//the user is trying to edit someone else's obj
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+				if (! empty($this->published_cap) && $obj->status() === 'publish') {
+					$caps[] = $this->published_cap;
+				} elseif (! empty($this->private_cap) && $obj->status() === 'private') {
+					$caps[] = $this->private_cap;
+				}
+			}
+		} else {
+			//not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user')
+					&& $obj->wp_user()
+					&& $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if ($has_cap) {
+				$caps[] = $cap;
+			} else {
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1071,24 +1071,24 @@ 
 class EE_Meta_Capability_Map_Delete extends EE_Meta_Capability_Map_Edit
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        return parent::_map_meta_caps($caps, $cap, $user_id, $args);
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		return parent::_map_meta_caps($caps, $cap, $user_id, $args);
+	}
 }
 
 
@@ -1104,75 +1104,75 @@ 
 class EE_Meta_Capability_Map_Read extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped cap;
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        //cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = $cap;
-            return $caps;
-        }
-        if ($obj instanceof EE_CPT_Base) {
-            $status_obj = get_post_status_object($obj->status());
-            if ($status_obj->public) {
-                $caps[] = $cap;
-                return $caps;
-            }
-            //if the item author is set and the user is the author...
-            if ($obj->wp_user() && $obj->wp_user() === $user_id) {
-                $caps[] = $cap;
-            } elseif ($status_obj->private && ! empty($this->private_cap)) {
-                //the user is trying to view someone else's obj
-                $caps[] = $this->private_cap;
-            } elseif (! empty($this->others_cap)) {
-                $caps[] = $this->others_cap;
-            } else {
-                $caps[] = $cap;
-            }
-        } else {
-            //not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user') && $obj->wp_user() && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if ($has_cap) {
-                $caps[] = $cap;
-            } elseif (! empty($this->private_cap)) {
-                $caps[] = $this->private_cap;
-            } elseif (! empty($this->others_cap)) {
-                $caps[] = $this->others_cap;
-            } else {
-                $caps[] = $cap;
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped cap;
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		//cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = $cap;
+			return $caps;
+		}
+		if ($obj instanceof EE_CPT_Base) {
+			$status_obj = get_post_status_object($obj->status());
+			if ($status_obj->public) {
+				$caps[] = $cap;
+				return $caps;
+			}
+			//if the item author is set and the user is the author...
+			if ($obj->wp_user() && $obj->wp_user() === $user_id) {
+				$caps[] = $cap;
+			} elseif ($status_obj->private && ! empty($this->private_cap)) {
+				//the user is trying to view someone else's obj
+				$caps[] = $this->private_cap;
+			} elseif (! empty($this->others_cap)) {
+				$caps[] = $this->others_cap;
+			} else {
+				$caps[] = $cap;
+			}
+		} else {
+			//not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user') && $obj->wp_user() && $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if ($has_cap) {
+				$caps[] = $cap;
+			} elseif (! empty($this->private_cap)) {
+				$caps[] = $this->private_cap;
+			} elseif (! empty($this->others_cap)) {
+				$caps[] = $this->others_cap;
+			} else {
+				$caps[] = $cap;
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1189,52 +1189,52 @@ 
 class EE_Meta_Capability_Map_Messages_Cap extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        //cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Message_Template_Group) {
-            $caps[] = $cap;
-            return $caps;
-        }
-        $is_global = $obj->is_global();
-        if ($obj->wp_user() && $obj->wp_user() === $user_id) {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            } else {
-                $caps[] = $cap;
-            }
-        } else {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            } else {
-                $caps[] = $this->others_cap;
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		//cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Message_Template_Group) {
+			$caps[] = $cap;
+			return $caps;
+		}
+		$is_global = $obj->is_global();
+		if ($obj->wp_user() && $obj->wp_user() === $user_id) {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			} else {
+				$caps[] = $cap;
+			}
+		} else {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			} else {
+				$caps[] = $this->others_cap;
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1251,41 +1251,41 @@ 
 class EE_Meta_Capability_Map_Registration_Form_Cap extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = $cap;
-            return $caps;
-        }
-        $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
-        $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
-        if ($is_system) {
-            $caps[] = $this->private_cap;
-        } else {
-            $caps[] = $cap;
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = $cap;
+			return $caps;
+		}
+		$is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
+		$is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
+		if ($is_system) {
+			$caps[] = $this->private_cap;
+		} else {
+			$caps[] = $cap;
+		}
+		return $caps;
+	}
 
 
 }

Spacing +28 added lines, -28 removed lines

@@ -60,7 +60,7 @@ 
     public static function instance()
     {
         //check if instantiated, and if not do so.
-        if (! self::$_instance instanceof EE_Capabilities) {
+        if ( ! self::$_instance instanceof EE_Capabilities) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -112,7 +112,7 @@ 
         $this->_meta_caps = $this->_get_default_meta_caps_array();
         $this->_meta_caps = apply_filters('FHEE__EE_Capabilities___set_meta_caps__meta_caps', $this->_meta_caps);
         //add filter for map_meta_caps but only if models can query.
-        if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
+        if ( ! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
             add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
         }
     }
@@ -270,11 +270,11 @@ 
         if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
             //loop through our _meta_caps array
             foreach ($this->_meta_caps as $meta_map) {
-                if (! $meta_map instanceof EE_Meta_Capability_Map) {
+                if ( ! $meta_map instanceof EE_Meta_Capability_Map) {
                     continue;
                 }
                 // don't load models if there is no object ID in the args
-                if(!empty($args[0])){
+                if ( ! empty($args[0])) {
                     $meta_map->ensure_is_model();
                 }
                 $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
@@ -632,9 +632,9 @@ 
         foreach ($caps_map as $role => $caps_for_role) {
             foreach ($caps_for_role as $cap) {
                 //first check we haven't already added this cap before, or it's a reset
-                if ($reset || ! isset($caps_set_before[ $role ]) || ! in_array($cap, $caps_set_before[ $role ])) {
+                if ($reset || ! isset($caps_set_before[$role]) || ! in_array($cap, $caps_set_before[$role])) {
                     if ($this->add_cap_to_role($role, $cap)) {
-                        $caps_set_before[ $role ][] = $cap;
+                        $caps_set_before[$role][] = $cap;
                     }
                 }
             }
@@ -664,7 +664,7 @@ 
     {
         $role_object = get_role($role);
         //if the role isn't available then we create it.
-        if (! $role_object instanceof WP_Role) {
+        if ( ! $role_object instanceof WP_Role) {
             //if a plugin wants to create a specific role name then they should create the role before
             //EE_Capabilities does.  Otherwise this function will create the role name from the slug:
             // - removes any `ee_` namespacing from the start of the slug.
@@ -721,7 +721,7 @@ 
     public function current_user_can($cap, $context, $id = 0)
     {
         //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
+        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__'.$context, $cap, $id);
         $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap', $filtered_cap, $context, $cap,
             $id);
         return ! empty($id) ? current_user_can($filtered_cap, $id) : current_user_can($filtered_cap);
@@ -742,7 +742,7 @@ 
     public function user_can($user, $cap, $context, $id = 0)
     {
         //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
+        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__'.$context, $cap, $user, $id);
         $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap', $filtered_cap, $context, $cap, $user,
             $id);
         return ! empty($id) ? user_can($user, $filtered_cap, $id) : user_can($user, $filtered_cap);
@@ -773,7 +773,7 @@ 
             : current_user_can($blog_id, $cap);
         //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
         $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
+            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__'.$context,
             $user_can,
             $blog_id,
             $cap,
@@ -809,7 +809,7 @@ 
         if (empty($role)) {
             return $capabilities;
         }
-        return isset($capabilities[ $role ]) ? $capabilities[ $role ] : array();
+        return isset($capabilities[$role]) ? $capabilities[$role] : array();
     }
 }
 
@@ -875,16 +875,16 @@ 
                         'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
                         'event_espresso'
                     ),
-                    '<br>' . print_r($map_values, true)
+                    '<br>'.print_r($map_values, true)
                 )
             );
         }
         //set properties
         $this->_model = null;
         $this->_model_name = $map_values[0];
-        $this->published_cap = (string)$map_values[1];
-        $this->others_cap = (string)$map_values[2];
-        $this->private_cap = (string)$map_values[3];
+        $this->published_cap = (string) $map_values[1];
+        $this->others_cap = (string) $map_values[2];
+        $this->private_cap = (string) $map_values[3];
     }
 
     /**
@@ -911,11 +911,11 @@ 
             return;
         }
         //ensure model name is string
-        $this->_model_name = (string)$this->_model_name;
+        $this->_model_name = (string) $this->_model_name;
         //error proof if the name has EEM in it
         $this->_model_name = str_replace('EEM', '', $this->_model_name);
         $this->_model = EE_Registry::instance()->load_model($this->_model_name);
-        if (! $this->_model instanceof EEM_Base) {
+        if ( ! $this->_model instanceof EEM_Base) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -1005,7 +1005,7 @@ 
         /** @var EE_Base_Class $obj */
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = $cap;
             return $caps;
         }
@@ -1024,12 +1024,12 @@ 
                 }
             } else {
                 //the user is trying to edit someone else's obj
-                if (! empty($this->others_cap)) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
-                if (! empty($this->published_cap) && $obj->status() === 'publish') {
+                if ( ! empty($this->published_cap) && $obj->status() === 'publish') {
                     $caps[] = $this->published_cap;
-                } elseif (! empty($this->private_cap) && $obj->status() === 'private') {
+                } elseif ( ! empty($this->private_cap) && $obj->status() === 'private') {
                     $caps[] = $this->private_cap;
                 }
             }
@@ -1048,7 +1048,7 @@ 
             if ($has_cap) {
                 $caps[] = $cap;
             } else {
-                if (! empty($this->others_cap)) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
             }
@@ -1130,7 +1130,7 @@ 
 
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = $cap;
             return $caps;
         }
@@ -1146,7 +1146,7 @@ 
             } elseif ($status_obj->private && ! empty($this->private_cap)) {
                 //the user is trying to view someone else's obj
                 $caps[] = $this->private_cap;
-            } elseif (! empty($this->others_cap)) {
+            } elseif ( ! empty($this->others_cap)) {
                 $caps[] = $this->others_cap;
             } else {
                 $caps[] = $cap;
@@ -1163,9 +1163,9 @@ 
             }
             if ($has_cap) {
                 $caps[] = $cap;
-            } elseif (! empty($this->private_cap)) {
+            } elseif ( ! empty($this->private_cap)) {
                 $caps[] = $this->private_cap;
-            } elseif (! empty($this->others_cap)) {
+            } elseif ( ! empty($this->others_cap)) {
                 $caps[] = $this->others_cap;
             } else {
                 $caps[] = $cap;
@@ -1215,7 +1215,7 @@ 
 
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         //if no obj then let's just do cap
-        if (! $obj instanceof EE_Message_Template_Group) {
+        if ( ! $obj instanceof EE_Message_Template_Group) {
             $caps[] = $cap;
             return $caps;
         }
@@ -1273,7 +1273,7 @@ 
         }
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = $cap;
             return $caps;
         }

admin_pages/transactions/Transactions_Admin_Page.core.php

Doc Comments +2 added lines, -1 removed lines

@@ -1612,7 +1612,7 @@ 
      * @param \EE_Payment     $payment
      * @param array           $REG_IDs
      *
-     * @return bool
+     * @return boolean|null
      */
     protected function _update_registration_payments(
         EE_Transaction $transaction,
@@ -1821,6 +1821,7 @@ 
      * @access protected
      *
      * @param \EE_Payment | null $payment
+     * @param EE_Payment $payment
      */
     protected function _maybe_send_notifications($payment = null)
     {

Indentation +1963 added lines, -1963 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -27,1971 +27,1971 @@ 
 class Transactions_Admin_Page extends EE_Admin_Page
 {
 
-    /**
-     * @var EE_Transaction
-     */
-    private $_transaction;
-
-    /**
-     * @var EE_Session
-     */
-    private $_session;
-
-    /**
-     * @var array $_txn_status
-     */
-    private static $_txn_status;
-
-    /**
-     * @var array $_pay_status
-     */
-    private static $_pay_status;
-
-    /**
-     * @var array $_existing_reg_payment_REG_IDs
-     */
-    protected $_existing_reg_payment_REG_IDs = null;
-
-
-    /**
-     * @Constructor
-     * @access public
-     *
-     * @param bool $routing
-     *
-     * @return Transactions_Admin_Page
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-    }
-
-
-    /**
-     *    _init_page_props
-     * @return void
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug        = TXN_PG_SLUG;
-        $this->page_label       = esc_html__('Transactions', 'event_espresso');
-        $this->_admin_base_url  = TXN_ADMIN_URL;
-        $this->_admin_base_path = TXN_ADMIN;
-    }
-
-
-    /**
-     *    _ajax_hooks
-     * @return void
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_espresso_apply_payment', array($this, 'apply_payments_or_refunds'));
-        add_action('wp_ajax_espresso_apply_refund', array($this, 'apply_payments_or_refunds'));
-        add_action('wp_ajax_espresso_delete_payment', array($this, 'delete_payment'));
-    }
-
-
-    /**
-     *    _define_page_props
-     * @return void
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = array(
-            'buttons' => array(
-                'add'    => esc_html__('Add New Transaction', 'event_espresso'),
-                'edit'   => esc_html__('Edit Transaction', 'event_espresso'),
-                'delete' => esc_html__('Delete Transaction', 'event_espresso'),
-            )
-        );
-    }
-
-
-    /**
-     *        grab url requests and route them
-     * @access private
-     * @return void
-     */
-    public function _set_page_routes()
-    {
-
-        $this->_set_transaction_status_array();
-
-        $txn_id = ! empty($this->_req_data['TXN_ID']) && ! is_array($this->_req_data['TXN_ID']) ? $this->_req_data['TXN_ID'] : 0;
-
-        $this->_page_routes = array(
-
-            'default' => array(
-                'func'       => '_transactions_overview_list_table',
-                'capability' => 'ee_read_transactions'
-            ),
-
-            'view_transaction' => array(
-                'func'       => '_transaction_details',
-                'capability' => 'ee_read_transaction',
-                'obj_id'     => $txn_id
-            ),
-
-            'send_payment_reminder' => array(
-                'func'       => '_send_payment_reminder',
-                'noheader'   => true,
-                'capability' => 'ee_send_message'
-            ),
-
-            'espresso_apply_payment' => array(
-                'func'       => 'apply_payments_or_refunds',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payments'
-            ),
-
-            'espresso_apply_refund' => array(
-                'func'       => 'apply_payments_or_refunds',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payments'
-            ),
-
-            'espresso_delete_payment' => array(
-                'func'       => 'delete_payment',
-                'noheader'   => true,
-                'capability' => 'ee_delete_payments'
-            ),
-
-        );
-
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'          => array(
-                'nav'           => array(
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'order' => 10
-                ),
-                'list_table'    => 'EE_Admin_Transactions_List_Table',
-                'help_tabs'     => array(
-                    'transactions_overview_help_tab'                       => array(
-                        'title'    => esc_html__('Transactions Overview', 'event_espresso'),
-                        'filename' => 'transactions_overview'
-                    ),
-                    'transactions_overview_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Transactions Table Column Headings', 'event_espresso'),
-                        'filename' => 'transactions_overview_table_column_headings'
-                    ),
-                    'transactions_overview_views_filters_help_tab'         => array(
-                        'title'    => esc_html__('Transaction Views & Filters & Search', 'event_espresso'),
-                        'filename' => 'transactions_overview_views_filters_search'
-                    ),
-                ),
-                'help_tour'     => array('Transactions_Overview_Help_Tour'),
-                /**
-                 * commented out because currently we are not displaying tips for transaction list table status but this
-                 * may change in a later iteration so want to keep the code for then.
-                 */
-                //'qtips' => array( 'Transactions_List_Table_Tips' ),
-                'require_nonce' => false
-            ),
-            'view_transaction' => array(
-                'nav'       => array(
-                    'label'      => esc_html__('View Transaction', 'event_espresso'),
-                    'order'      => 5,
-                    'url'        => isset($this->_req_data['TXN_ID']) ? add_query_arg(array('TXN_ID' => $this->_req_data['TXN_ID']),
-                        $this->_current_page_view_url) : $this->_admin_base_url,
-                    'persistent' => false
-                ),
-                'help_tabs' => array(
-                    'transactions_view_transaction_help_tab'                                              => array(
-                        'title'    => esc_html__('View Transaction', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction'
-                    ),
-                    'transactions_view_transaction_transaction_details_table_help_tab'                    => array(
-                        'title'    => esc_html__('Transaction Details Table', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_transaction_details_table'
-                    ),
-                    'transactions_view_transaction_attendees_registered_help_tab'                         => array(
-                        'title'    => esc_html__('Attendees Registered', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_attendees_registered'
-                    ),
-                    'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => array(
-                        'title'    => esc_html__('Primary Registrant & Billing Information', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_primary_registrant_billing_information'
-                    ),
-                ),
-                'qtips'     => array('Transaction_Details_Tips'),
-                'help_tour' => array('Transaction_Details_Help_Tour'),
-                'metaboxes' => array('_transaction_details_metaboxes'),
-
-                'require_nonce' => false
-            )
-        );
-    }
-
-
-    /**
-     * The below methods aren't used by this class currently
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-    public function admin_init()
-    {
-        // IF a registration was JUST added via the admin...
-        if (
-        isset(
-            $this->_req_data['redirect_from'],
-            $this->_req_data['EVT_ID'],
-            $this->_req_data['event_name']
-        )
-        ) {
-            // then set a cookie so that we can block any attempts to use
-            // the back button as a way to enter another registration.
-            setcookie('ee_registration_added', $this->_req_data['EVT_ID'], time() + WEEK_IN_SECONDS, '/');
-            // and update the global
-            $_COOKIE['ee_registration_added'] = $this->_req_data['EVT_ID'];
-        }
-        EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__('An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
-            'event_espresso');
-        EE_Registry::$i18n_js_strings['error_occurred']          = esc_html__('An error occurred! Please refresh the page and try again.',
-            'event_espresso');
-        EE_Registry::$i18n_js_strings['txn_status_array']        = self::$_txn_status;
-        EE_Registry::$i18n_js_strings['pay_status_array']        = self::$_pay_status;
-        EE_Registry::$i18n_js_strings['payments_total']          = esc_html__('Payments Total', 'event_espresso');
-        EE_Registry::$i18n_js_strings['transaction_overpaid']    = esc_html__('This transaction has been overpaid ! Payments Total',
-            'event_espresso');
-    }
-
-    public function admin_notices()
-    {
-    }
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     * _set_transaction_status_array
-     * sets list of transaction statuses
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_transaction_status_array()
-    {
-        self::$_txn_status = EEM_Transaction::instance()->status_array(true);
-    }
-
-
-    /**
-     * get_transaction_status_array
-     * return the transaction status array for wp_list_table
-     *
-     * @access public
-     * @return array
-     */
-    public function get_transaction_status_array()
-    {
-        return self::$_txn_status;
-    }
-
-
-    /**
-     *    get list of payment statuses
-     *
-     * @access private
-     * @return void
-     */
-    private function _get_payment_status_array()
-    {
-        self::$_pay_status                      = EEM_Payment::instance()->status_array(true);
-        $this->_template_args['payment_status'] = self::$_pay_status;
-
-    }
-
-
-    /**
-     *    _add_screen_options_default
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * load_scripts_styles
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles()
-    {
-        //enqueue style
-        wp_register_style('espresso_txn', TXN_ASSETS_URL . 'espresso_transactions_admin.css', array(),
-            EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso_txn');
-        //scripts
-        wp_register_script('espresso_txn', TXN_ASSETS_URL . 'espresso_transactions_admin.js', array(
-            'ee_admin_js',
-            'ee-datepicker',
-            'jquery-ui-datepicker',
-            'jquery-ui-draggable',
-            'ee-dialog',
-            'ee-accounting',
-            'ee-serialize-full-array'
-        ), EVENT_ESPRESSO_VERSION, true);
-        wp_enqueue_script('espresso_txn');
-
-    }
-
-
-    /**
-     *    load_scripts_styles_view_transaction
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_view_transaction()
-    {
-        //styles
-        wp_enqueue_style('espresso-ui-theme');
-    }
-
-
-    /**
-     *    load_scripts_styles_default
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_default()
-    {
-        //styles
-        wp_enqueue_style('espresso-ui-theme');
-    }
-
-
-    /**
-     *    _set_list_table_views_default
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = array(
-            'all'       => array(
-                'slug'  => 'all',
-                'label' => esc_html__('View All Transactions', 'event_espresso'),
-                'count' => 0
-            ),
-            'abandoned' => array(
-                'slug'  => 'abandoned',
-                'label' => esc_html__('Abandoned Transactions', 'event_espresso'),
-                'count' => 0
-            ),
-            'failed'    => array(
-                'slug'  => 'failed',
-                'label' => esc_html__('Failed Transactions', 'event_espresso'),
-                'count' => 0
-            )
-        );
-    }
-
-
-    /**
-     * _set_transaction_object
-     * This sets the _transaction property for the transaction details screen
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_transaction_object()
-    {
-        if (is_object($this->_transaction)) {
-            return;
-        } //get out we've already set the object
-
-        $TXN = EEM_Transaction::instance();
-
-        $TXN_ID = ( ! empty($this->_req_data['TXN_ID'])) ? absint($this->_req_data['TXN_ID']) : false;
-
-        //get transaction object
-        $this->_transaction = $TXN->get_one_by_ID($TXN_ID);
-        $this->_session     = ! empty($this->_transaction) ? $this->_transaction->get('TXN_session_data') : null;
-        $this->_transaction->verify_abandoned_transaction_status();
-
-        if (empty($this->_transaction)) {
-            $error_msg = esc_html__('An error occurred and the details for Transaction ID #',
-                    'event_espresso') . $TXN_ID . esc_html__(' could not be retrieved.', 'event_espresso');
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     *    _transaction_legend_items
-     *
-     * @access protected
-     * @return array
-     */
-    protected function _transaction_legend_items()
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $items = array();
-
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
-            if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
-                $items['view_related_messages'] = array(
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                );
-            }
-        }
-
-        $items = apply_filters(
-            'FHEE__Transactions_Admin_Page___transaction_legend_items__items',
-            array_merge($items,
-                array(
-                    'view_details'      => array(
-                        'class' => 'dashicons dashicons-cart',
-                        'desc'  => esc_html__('View Transaction Details', 'event_espresso')
-                    ),
-                    'view_invoice'      => array(
-                        'class' => 'dashicons dashicons-media-spreadsheet',
-                        'desc'  => esc_html__('View Transaction Invoice', 'event_espresso')
-                    ),
-                    'view_receipt'      => array(
-                        'class' => 'dashicons dashicons-media-default',
-                        'desc'  => esc_html__('View Transaction Receipt', 'event_espresso')
-                    ),
-                    'view_registration' => array(
-                        'class' => 'dashicons dashicons-clipboard',
-                        'desc'  => esc_html__('View Registration Details', 'event_espresso')
-                    )
-                )
-            )
-        );
-
-        if (EE_Registry::instance()->CAP->current_user_can('ee_send_message',
-            'espresso_transactions_send_payment_reminder')
-        ) {
-            if (EEH_MSG_Template::is_mt_active('payment_reminder')) {
-                $items['send_payment_reminder'] = array(
-                    'class' => 'dashicons dashicons-email-alt',
-                    'desc'  => esc_html__('Send Payment Reminder', 'event_espresso')
-                );
-            } else {
-                $items['blank*'] = array(
-                    'class' => '',
-                    'desc'  => ''
-                );
-            }
-        } else {
-            $items['blank*'] = array(
-                'class' => '',
-                'desc'  => ''
-            );
-        }
-        $more_items = apply_filters(
-            'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
-            array(
-                'overpaid'   => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code,
-                    'desc'  => EEH_Template::pretty_status(EEM_Transaction::overpaid_status_code, false, 'sentence')
-                ),
-                'complete'   => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code,
-                    'desc'  => EEH_Template::pretty_status(EEM_Transaction::complete_status_code, false, 'sentence')
-                ),
-                'incomplete' => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code,
-                    'desc'  => EEH_Template::pretty_status(EEM_Transaction::incomplete_status_code, false, 'sentence')
-                ),
-                'abandoned'  => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code,
-                    'desc'  => EEH_Template::pretty_status(EEM_Transaction::abandoned_status_code, false, 'sentence')
-                ),
-                'failed'     => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code,
-                    'desc'  => EEH_Template::pretty_status(EEM_Transaction::failed_status_code, false, 'sentence')
-                )
-            )
-        );
-
-        return array_merge($items, $more_items);
-    }
-
-
-    /**
-     *    _transactions_overview_list_table
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _transactions_overview_list_table()
-    {
-        $this->_admin_page_title                   = esc_html__('Transactions', 'event_espresso');
-        $event                                     = isset($this->_req_data['EVT_ID']) ? EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']) : null;
-        $this->_template_args['admin_page_header'] = $event instanceof EE_Event ? sprintf(esc_html__('%sViewing Transactions for the Event: %s%s',
-            'event_espresso'), '<h3>',
-            '<a href="' . EE_Admin_Page::add_query_args_and_nonce(array('action' => 'edit', 'post' => $event->ID()),
-                EVENTS_ADMIN_URL) . '" title="' . esc_attr__('Click to Edit event',
-                'event_espresso') . '">' . $event->get('EVT_name') . '</a>', '</h3>') : '';
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_transaction_legend_items());
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     *    _transaction_details
-     * generates HTML for the View Transaction Details Admin page
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _transaction_details()
-    {
-        do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction);
-
-        $this->_set_transaction_status_array();
-
-        $this->_template_args                      = array();
-        $this->_template_args['transactions_page'] = $this->_wp_page_slug;
-
-        $this->_set_transaction_object();
-
-        $primary_registration = $this->_transaction->primary_registration();
-        $attendee             = $primary_registration instanceof EE_Registration ? $primary_registration->attendee() : null;
-
-        $this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID();
-        $this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso');
-
-        $this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp');
-        $this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso');
-
-        $this->_template_args['txn_status']['value'] = self::$_txn_status[$this->_transaction->get('STS_ID')];
-        $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
-        $this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->get('STS_ID');
-
-        $this->_template_args['grand_total'] = $this->_transaction->get('TXN_total');
-        $this->_template_args['total_paid']  = $this->_transaction->get('TXN_paid');
-
-        if (
-            $attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_transactions_send_payment_reminder'
-            )
-        ) {
-            $this->_template_args['send_payment_reminder_button'] =
-                EEH_MSG_Template::is_mt_active('payment_reminder')
-                && $this->_transaction->get('STS_ID') != EEM_Transaction::complete_status_code
-                && $this->_transaction->get('STS_ID') != EEM_Transaction::overpaid_status_code
-                    ? EEH_Template::get_button_or_link(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'send_payment_reminder',
-                            'TXN_ID'      => $this->_transaction->ID(),
-                            'redirect_to' => 'view_transaction'
-                        ),
-                        TXN_ADMIN_URL
-                    ),
-                    __(' Send Payment Reminder', 'event_espresso'),
-                    'button secondary-button right',
-                    'dashicons dashicons-email-alt'
-                )
-                    : '';
-        } else {
-            $this->_template_args['send_payment_reminder_button'] = '';
-        }
-
-        $amount_due                         = $this->_transaction->get('TXN_total') - $this->_transaction->get('TXN_paid');
-        $this->_template_args['amount_due'] = EEH_Template::format_currency($amount_due, true);
-        if (EE_Registry::instance()->CFG->currency->sign_b4) {
-            $this->_template_args['amount_due'] = EE_Registry::instance()->CFG->currency->sign . $this->_template_args['amount_due'];
-        } else {
-            $this->_template_args['amount_due'] = $this->_template_args['amount_due'] . EE_Registry::instance()->CFG->currency->sign;
-        }
-        $this->_template_args['amount_due_class'] = '';
-
-        if ($this->_transaction->get('TXN_paid') == $this->_transaction->get('TXN_total')) {
-            // paid in full
-            $this->_template_args['amount_due'] = false;
-        } elseif ($this->_transaction->get('TXN_paid') > $this->_transaction->get('TXN_total')) {
-            // overpaid
-            $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
-        } elseif (($this->_transaction->get('TXN_total') > 0) && ($this->_transaction->get('TXN_paid') > 0)) {
-            // monies owing
-            $this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn';
-        } elseif (($this->_transaction->get('TXN_total') > 0) && ($this->_transaction->get('TXN_paid') == 0)) {
-            // no payments made yet
-            $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
-        } elseif ($this->_transaction->get('TXN_total') == 0) {
-            // free event
-            $this->_template_args['amount_due'] = false;
-        }
-
-        $payment_method = $this->_transaction->payment_method();
-
-        $this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method
-            ? $payment_method->admin_name()
-            : esc_html__('Unknown', 'event_espresso');
-
-        $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        // link back to overview
-        $this->_template_args['txn_overview_url'] = ! empty ($_SERVER['HTTP_REFERER'])
-            ? $_SERVER['HTTP_REFERER']
-            : TXN_ADMIN_URL;
-
-
-        // next link
-        $next_txn                                 = $this->_transaction->next(
-            null,
-            array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
-            'TXN_ID'
-        );
-        $this->_template_args['next_transaction'] = $next_txn
-            ? $this->_next_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array('action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']),
-                    TXN_ADMIN_URL
-                ),
-                'dashicons dashicons-arrow-right ee-icon-size-22'
-            )
-            : '';
-        // previous link
-        $previous_txn                                 = $this->_transaction->previous(
-            null,
-            array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
-            'TXN_ID'
-        );
-        $this->_template_args['previous_transaction'] = $previous_txn
-            ? $this->_previous_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array('action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']),
-                    TXN_ADMIN_URL
-                ),
-                'dashicons dashicons-arrow-left ee-icon-size-22'
-            )
-            : '';
-
-        // were we just redirected here after adding a new registration ???
-        if (
-        isset(
-            $this->_req_data['redirect_from'],
-            $this->_req_data['EVT_ID'],
-            $this->_req_data['event_name']
-        )
-        ) {
-            if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registrations',
-                'espresso_registrations_new_registration',
-                $this->_req_data['EVT_ID']
-            )
-            ) {
-                $this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button-primary" href="';
-                $this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'page'     => 'espresso_registrations',
-                        'action'   => 'new_registration',
-                        'return'   => 'default',
-                        'TXN_ID'   => $this->_transaction->ID(),
-                        'event_id' => $this->_req_data['EVT_ID'],
-                    ),
-                    REG_ADMIN_URL
-                );
-                $this->_admin_page_title .= '">';
-
-                $this->_admin_page_title .= sprintf(
-                    esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'),
-                    htmlentities(urldecode($this->_req_data['event_name']), ENT_QUOTES, 'UTF-8')
-                );
-                $this->_admin_page_title .= '</a>';
-            }
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // grab messages at the last second
-        $this->_template_args['notices'] = EE_Error::get_notices();
-        // path to template
-        $template_path                             = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
-        $this->_template_args['admin_page_header'] = EEH_Template::display_template($template_path,
-            $this->_template_args, true);
-
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-
-    }
-
-
-    /**
-     *        _transaction_details_metaboxes
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _transaction_details_metaboxes()
-    {
-
-        $this->_set_transaction_object();
-
-        add_meta_box('edit-txn-details-mbox', esc_html__('Transaction Details', 'event_espresso'),
-            array($this, 'txn_details_meta_box'), $this->_wp_page_slug, 'normal', 'high');
-        add_meta_box(
-            'edit-txn-attendees-mbox',
-            esc_html__('Attendees Registered in this Transaction', 'event_espresso'),
-            array($this, 'txn_attendees_meta_box'),
-            $this->_wp_page_slug,
-            'normal',
-            'high',
-            array('TXN_ID' => $this->_transaction->ID())
-        );
-        add_meta_box('edit-txn-registrant-mbox', esc_html__('Primary Contact', 'event_espresso'),
-            array($this, 'txn_registrant_side_meta_box'), $this->_wp_page_slug, 'side', 'high');
-        add_meta_box('edit-txn-billing-info-mbox', esc_html__('Billing Information', 'event_espresso'),
-            array($this, 'txn_billing_info_side_meta_box'), $this->_wp_page_slug, 'side', 'high');
-
-    }
-
-
-    /**
-     * txn_details_meta_box
-     * generates HTML for the Transaction main meta box
-     *
-     * @access public
-     * @return void
-     */
-    public function txn_details_meta_box()
-    {
-
-        $this->_set_transaction_object();
-        $this->_template_args['TXN_ID']   = $this->_transaction->ID();
-        $this->_template_args['attendee'] = $this->_transaction->primary_registration() instanceof EE_Registration ? $this->_transaction->primary_registration()->attendee() : null;
-
-        //get line table
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display                       = new EE_Line_Item_Display('admin_table',
-            'EE_Admin_Table_Line_Item_Display_Strategy');
-        $this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item($this->_transaction->total_line_item());
-        $this->_template_args['REG_code']        = $this->_transaction->get_first_related('Registration')->get('REG_code');
-
-        // process taxes
-        $taxes                         = $this->_transaction->get_many_related('Line_Item',
-            array(array('LIN_type' => EEM_Line_Item::type_tax)));
-        $this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false;
-
-        $this->_template_args['grand_total']     = EEH_Template::format_currency($this->_transaction->get('TXN_total'),
-            false, false);
-        $this->_template_args['grand_raw_total'] = $this->_transaction->get('TXN_total');
-        $this->_template_args['TXN_status']      = $this->_transaction->get('STS_ID');
+	/**
+	 * @var EE_Transaction
+	 */
+	private $_transaction;
+
+	/**
+	 * @var EE_Session
+	 */
+	private $_session;
+
+	/**
+	 * @var array $_txn_status
+	 */
+	private static $_txn_status;
+
+	/**
+	 * @var array $_pay_status
+	 */
+	private static $_pay_status;
+
+	/**
+	 * @var array $_existing_reg_payment_REG_IDs
+	 */
+	protected $_existing_reg_payment_REG_IDs = null;
+
+
+	/**
+	 * @Constructor
+	 * @access public
+	 *
+	 * @param bool $routing
+	 *
+	 * @return Transactions_Admin_Page
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+	}
+
+
+	/**
+	 *    _init_page_props
+	 * @return void
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug        = TXN_PG_SLUG;
+		$this->page_label       = esc_html__('Transactions', 'event_espresso');
+		$this->_admin_base_url  = TXN_ADMIN_URL;
+		$this->_admin_base_path = TXN_ADMIN;
+	}
+
+
+	/**
+	 *    _ajax_hooks
+	 * @return void
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_espresso_apply_payment', array($this, 'apply_payments_or_refunds'));
+		add_action('wp_ajax_espresso_apply_refund', array($this, 'apply_payments_or_refunds'));
+		add_action('wp_ajax_espresso_delete_payment', array($this, 'delete_payment'));
+	}
+
+
+	/**
+	 *    _define_page_props
+	 * @return void
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = array(
+			'buttons' => array(
+				'add'    => esc_html__('Add New Transaction', 'event_espresso'),
+				'edit'   => esc_html__('Edit Transaction', 'event_espresso'),
+				'delete' => esc_html__('Delete Transaction', 'event_espresso'),
+			)
+		);
+	}
+
+
+	/**
+	 *        grab url requests and route them
+	 * @access private
+	 * @return void
+	 */
+	public function _set_page_routes()
+	{
+
+		$this->_set_transaction_status_array();
+
+		$txn_id = ! empty($this->_req_data['TXN_ID']) && ! is_array($this->_req_data['TXN_ID']) ? $this->_req_data['TXN_ID'] : 0;
+
+		$this->_page_routes = array(
+
+			'default' => array(
+				'func'       => '_transactions_overview_list_table',
+				'capability' => 'ee_read_transactions'
+			),
+
+			'view_transaction' => array(
+				'func'       => '_transaction_details',
+				'capability' => 'ee_read_transaction',
+				'obj_id'     => $txn_id
+			),
+
+			'send_payment_reminder' => array(
+				'func'       => '_send_payment_reminder',
+				'noheader'   => true,
+				'capability' => 'ee_send_message'
+			),
+
+			'espresso_apply_payment' => array(
+				'func'       => 'apply_payments_or_refunds',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payments'
+			),
+
+			'espresso_apply_refund' => array(
+				'func'       => 'apply_payments_or_refunds',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payments'
+			),
+
+			'espresso_delete_payment' => array(
+				'func'       => 'delete_payment',
+				'noheader'   => true,
+				'capability' => 'ee_delete_payments'
+			),
+
+		);
+
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'          => array(
+				'nav'           => array(
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'order' => 10
+				),
+				'list_table'    => 'EE_Admin_Transactions_List_Table',
+				'help_tabs'     => array(
+					'transactions_overview_help_tab'                       => array(
+						'title'    => esc_html__('Transactions Overview', 'event_espresso'),
+						'filename' => 'transactions_overview'
+					),
+					'transactions_overview_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Transactions Table Column Headings', 'event_espresso'),
+						'filename' => 'transactions_overview_table_column_headings'
+					),
+					'transactions_overview_views_filters_help_tab'         => array(
+						'title'    => esc_html__('Transaction Views & Filters & Search', 'event_espresso'),
+						'filename' => 'transactions_overview_views_filters_search'
+					),
+				),
+				'help_tour'     => array('Transactions_Overview_Help_Tour'),
+				/**
+				 * commented out because currently we are not displaying tips for transaction list table status but this
+				 * may change in a later iteration so want to keep the code for then.
+				 */
+				//'qtips' => array( 'Transactions_List_Table_Tips' ),
+				'require_nonce' => false
+			),
+			'view_transaction' => array(
+				'nav'       => array(
+					'label'      => esc_html__('View Transaction', 'event_espresso'),
+					'order'      => 5,
+					'url'        => isset($this->_req_data['TXN_ID']) ? add_query_arg(array('TXN_ID' => $this->_req_data['TXN_ID']),
+						$this->_current_page_view_url) : $this->_admin_base_url,
+					'persistent' => false
+				),
+				'help_tabs' => array(
+					'transactions_view_transaction_help_tab'                                              => array(
+						'title'    => esc_html__('View Transaction', 'event_espresso'),
+						'filename' => 'transactions_view_transaction'
+					),
+					'transactions_view_transaction_transaction_details_table_help_tab'                    => array(
+						'title'    => esc_html__('Transaction Details Table', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_transaction_details_table'
+					),
+					'transactions_view_transaction_attendees_registered_help_tab'                         => array(
+						'title'    => esc_html__('Attendees Registered', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_attendees_registered'
+					),
+					'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => array(
+						'title'    => esc_html__('Primary Registrant & Billing Information', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_primary_registrant_billing_information'
+					),
+				),
+				'qtips'     => array('Transaction_Details_Tips'),
+				'help_tour' => array('Transaction_Details_Help_Tour'),
+				'metaboxes' => array('_transaction_details_metaboxes'),
+
+				'require_nonce' => false
+			)
+		);
+	}
+
+
+	/**
+	 * The below methods aren't used by this class currently
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+	public function admin_init()
+	{
+		// IF a registration was JUST added via the admin...
+		if (
+		isset(
+			$this->_req_data['redirect_from'],
+			$this->_req_data['EVT_ID'],
+			$this->_req_data['event_name']
+		)
+		) {
+			// then set a cookie so that we can block any attempts to use
+			// the back button as a way to enter another registration.
+			setcookie('ee_registration_added', $this->_req_data['EVT_ID'], time() + WEEK_IN_SECONDS, '/');
+			// and update the global
+			$_COOKIE['ee_registration_added'] = $this->_req_data['EVT_ID'];
+		}
+		EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__('An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
+			'event_espresso');
+		EE_Registry::$i18n_js_strings['error_occurred']          = esc_html__('An error occurred! Please refresh the page and try again.',
+			'event_espresso');
+		EE_Registry::$i18n_js_strings['txn_status_array']        = self::$_txn_status;
+		EE_Registry::$i18n_js_strings['pay_status_array']        = self::$_pay_status;
+		EE_Registry::$i18n_js_strings['payments_total']          = esc_html__('Payments Total', 'event_espresso');
+		EE_Registry::$i18n_js_strings['transaction_overpaid']    = esc_html__('This transaction has been overpaid ! Payments Total',
+			'event_espresso');
+	}
+
+	public function admin_notices()
+	{
+	}
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 * _set_transaction_status_array
+	 * sets list of transaction statuses
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_transaction_status_array()
+	{
+		self::$_txn_status = EEM_Transaction::instance()->status_array(true);
+	}
+
+
+	/**
+	 * get_transaction_status_array
+	 * return the transaction status array for wp_list_table
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_transaction_status_array()
+	{
+		return self::$_txn_status;
+	}
+
+
+	/**
+	 *    get list of payment statuses
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _get_payment_status_array()
+	{
+		self::$_pay_status                      = EEM_Payment::instance()->status_array(true);
+		$this->_template_args['payment_status'] = self::$_pay_status;
+
+	}
+
+
+	/**
+	 *    _add_screen_options_default
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * load_scripts_styles
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles()
+	{
+		//enqueue style
+		wp_register_style('espresso_txn', TXN_ASSETS_URL . 'espresso_transactions_admin.css', array(),
+			EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso_txn');
+		//scripts
+		wp_register_script('espresso_txn', TXN_ASSETS_URL . 'espresso_transactions_admin.js', array(
+			'ee_admin_js',
+			'ee-datepicker',
+			'jquery-ui-datepicker',
+			'jquery-ui-draggable',
+			'ee-dialog',
+			'ee-accounting',
+			'ee-serialize-full-array'
+		), EVENT_ESPRESSO_VERSION, true);
+		wp_enqueue_script('espresso_txn');
+
+	}
+
+
+	/**
+	 *    load_scripts_styles_view_transaction
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_view_transaction()
+	{
+		//styles
+		wp_enqueue_style('espresso-ui-theme');
+	}
+
+
+	/**
+	 *    load_scripts_styles_default
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_default()
+	{
+		//styles
+		wp_enqueue_style('espresso-ui-theme');
+	}
+
+
+	/**
+	 *    _set_list_table_views_default
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = array(
+			'all'       => array(
+				'slug'  => 'all',
+				'label' => esc_html__('View All Transactions', 'event_espresso'),
+				'count' => 0
+			),
+			'abandoned' => array(
+				'slug'  => 'abandoned',
+				'label' => esc_html__('Abandoned Transactions', 'event_espresso'),
+				'count' => 0
+			),
+			'failed'    => array(
+				'slug'  => 'failed',
+				'label' => esc_html__('Failed Transactions', 'event_espresso'),
+				'count' => 0
+			)
+		);
+	}
+
+
+	/**
+	 * _set_transaction_object
+	 * This sets the _transaction property for the transaction details screen
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_transaction_object()
+	{
+		if (is_object($this->_transaction)) {
+			return;
+		} //get out we've already set the object
+
+		$TXN = EEM_Transaction::instance();
+
+		$TXN_ID = ( ! empty($this->_req_data['TXN_ID'])) ? absint($this->_req_data['TXN_ID']) : false;
+
+		//get transaction object
+		$this->_transaction = $TXN->get_one_by_ID($TXN_ID);
+		$this->_session     = ! empty($this->_transaction) ? $this->_transaction->get('TXN_session_data') : null;
+		$this->_transaction->verify_abandoned_transaction_status();
+
+		if (empty($this->_transaction)) {
+			$error_msg = esc_html__('An error occurred and the details for Transaction ID #',
+					'event_espresso') . $TXN_ID . esc_html__(' could not be retrieved.', 'event_espresso');
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 *    _transaction_legend_items
+	 *
+	 * @access protected
+	 * @return array
+	 */
+	protected function _transaction_legend_items()
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$items = array();
+
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
+			if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
+				$items['view_related_messages'] = array(
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				);
+			}
+		}
+
+		$items = apply_filters(
+			'FHEE__Transactions_Admin_Page___transaction_legend_items__items',
+			array_merge($items,
+				array(
+					'view_details'      => array(
+						'class' => 'dashicons dashicons-cart',
+						'desc'  => esc_html__('View Transaction Details', 'event_espresso')
+					),
+					'view_invoice'      => array(
+						'class' => 'dashicons dashicons-media-spreadsheet',
+						'desc'  => esc_html__('View Transaction Invoice', 'event_espresso')
+					),
+					'view_receipt'      => array(
+						'class' => 'dashicons dashicons-media-default',
+						'desc'  => esc_html__('View Transaction Receipt', 'event_espresso')
+					),
+					'view_registration' => array(
+						'class' => 'dashicons dashicons-clipboard',
+						'desc'  => esc_html__('View Registration Details', 'event_espresso')
+					)
+				)
+			)
+		);
+
+		if (EE_Registry::instance()->CAP->current_user_can('ee_send_message',
+			'espresso_transactions_send_payment_reminder')
+		) {
+			if (EEH_MSG_Template::is_mt_active('payment_reminder')) {
+				$items['send_payment_reminder'] = array(
+					'class' => 'dashicons dashicons-email-alt',
+					'desc'  => esc_html__('Send Payment Reminder', 'event_espresso')
+				);
+			} else {
+				$items['blank*'] = array(
+					'class' => '',
+					'desc'  => ''
+				);
+			}
+		} else {
+			$items['blank*'] = array(
+				'class' => '',
+				'desc'  => ''
+			);
+		}
+		$more_items = apply_filters(
+			'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
+			array(
+				'overpaid'   => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code,
+					'desc'  => EEH_Template::pretty_status(EEM_Transaction::overpaid_status_code, false, 'sentence')
+				),
+				'complete'   => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code,
+					'desc'  => EEH_Template::pretty_status(EEM_Transaction::complete_status_code, false, 'sentence')
+				),
+				'incomplete' => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code,
+					'desc'  => EEH_Template::pretty_status(EEM_Transaction::incomplete_status_code, false, 'sentence')
+				),
+				'abandoned'  => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code,
+					'desc'  => EEH_Template::pretty_status(EEM_Transaction::abandoned_status_code, false, 'sentence')
+				),
+				'failed'     => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code,
+					'desc'  => EEH_Template::pretty_status(EEM_Transaction::failed_status_code, false, 'sentence')
+				)
+			)
+		);
+
+		return array_merge($items, $more_items);
+	}
+
+
+	/**
+	 *    _transactions_overview_list_table
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _transactions_overview_list_table()
+	{
+		$this->_admin_page_title                   = esc_html__('Transactions', 'event_espresso');
+		$event                                     = isset($this->_req_data['EVT_ID']) ? EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']) : null;
+		$this->_template_args['admin_page_header'] = $event instanceof EE_Event ? sprintf(esc_html__('%sViewing Transactions for the Event: %s%s',
+			'event_espresso'), '<h3>',
+			'<a href="' . EE_Admin_Page::add_query_args_and_nonce(array('action' => 'edit', 'post' => $event->ID()),
+				EVENTS_ADMIN_URL) . '" title="' . esc_attr__('Click to Edit event',
+				'event_espresso') . '">' . $event->get('EVT_name') . '</a>', '</h3>') : '';
+		$this->_template_args['after_list_table']  = $this->_display_legend($this->_transaction_legend_items());
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 *    _transaction_details
+	 * generates HTML for the View Transaction Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _transaction_details()
+	{
+		do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction);
+
+		$this->_set_transaction_status_array();
+
+		$this->_template_args                      = array();
+		$this->_template_args['transactions_page'] = $this->_wp_page_slug;
+
+		$this->_set_transaction_object();
+
+		$primary_registration = $this->_transaction->primary_registration();
+		$attendee             = $primary_registration instanceof EE_Registration ? $primary_registration->attendee() : null;
+
+		$this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID();
+		$this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso');
+
+		$this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp');
+		$this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso');
+
+		$this->_template_args['txn_status']['value'] = self::$_txn_status[$this->_transaction->get('STS_ID')];
+		$this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
+		$this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->get('STS_ID');
+
+		$this->_template_args['grand_total'] = $this->_transaction->get('TXN_total');
+		$this->_template_args['total_paid']  = $this->_transaction->get('TXN_paid');
+
+		if (
+			$attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_transactions_send_payment_reminder'
+			)
+		) {
+			$this->_template_args['send_payment_reminder_button'] =
+				EEH_MSG_Template::is_mt_active('payment_reminder')
+				&& $this->_transaction->get('STS_ID') != EEM_Transaction::complete_status_code
+				&& $this->_transaction->get('STS_ID') != EEM_Transaction::overpaid_status_code
+					? EEH_Template::get_button_or_link(
+					EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action'      => 'send_payment_reminder',
+							'TXN_ID'      => $this->_transaction->ID(),
+							'redirect_to' => 'view_transaction'
+						),
+						TXN_ADMIN_URL
+					),
+					__(' Send Payment Reminder', 'event_espresso'),
+					'button secondary-button right',
+					'dashicons dashicons-email-alt'
+				)
+					: '';
+		} else {
+			$this->_template_args['send_payment_reminder_button'] = '';
+		}
+
+		$amount_due                         = $this->_transaction->get('TXN_total') - $this->_transaction->get('TXN_paid');
+		$this->_template_args['amount_due'] = EEH_Template::format_currency($amount_due, true);
+		if (EE_Registry::instance()->CFG->currency->sign_b4) {
+			$this->_template_args['amount_due'] = EE_Registry::instance()->CFG->currency->sign . $this->_template_args['amount_due'];
+		} else {
+			$this->_template_args['amount_due'] = $this->_template_args['amount_due'] . EE_Registry::instance()->CFG->currency->sign;
+		}
+		$this->_template_args['amount_due_class'] = '';
+
+		if ($this->_transaction->get('TXN_paid') == $this->_transaction->get('TXN_total')) {
+			// paid in full
+			$this->_template_args['amount_due'] = false;
+		} elseif ($this->_transaction->get('TXN_paid') > $this->_transaction->get('TXN_total')) {
+			// overpaid
+			$this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
+		} elseif (($this->_transaction->get('TXN_total') > 0) && ($this->_transaction->get('TXN_paid') > 0)) {
+			// monies owing
+			$this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn';
+		} elseif (($this->_transaction->get('TXN_total') > 0) && ($this->_transaction->get('TXN_paid') == 0)) {
+			// no payments made yet
+			$this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
+		} elseif ($this->_transaction->get('TXN_total') == 0) {
+			// free event
+			$this->_template_args['amount_due'] = false;
+		}
+
+		$payment_method = $this->_transaction->payment_method();
+
+		$this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method
+			? $payment_method->admin_name()
+			: esc_html__('Unknown', 'event_espresso');
+
+		$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		// link back to overview
+		$this->_template_args['txn_overview_url'] = ! empty ($_SERVER['HTTP_REFERER'])
+			? $_SERVER['HTTP_REFERER']
+			: TXN_ADMIN_URL;
+
+
+		// next link
+		$next_txn                                 = $this->_transaction->next(
+			null,
+			array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
+			'TXN_ID'
+		);
+		$this->_template_args['next_transaction'] = $next_txn
+			? $this->_next_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array('action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']),
+					TXN_ADMIN_URL
+				),
+				'dashicons dashicons-arrow-right ee-icon-size-22'
+			)
+			: '';
+		// previous link
+		$previous_txn                                 = $this->_transaction->previous(
+			null,
+			array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
+			'TXN_ID'
+		);
+		$this->_template_args['previous_transaction'] = $previous_txn
+			? $this->_previous_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array('action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']),
+					TXN_ADMIN_URL
+				),
+				'dashicons dashicons-arrow-left ee-icon-size-22'
+			)
+			: '';
+
+		// were we just redirected here after adding a new registration ???
+		if (
+		isset(
+			$this->_req_data['redirect_from'],
+			$this->_req_data['EVT_ID'],
+			$this->_req_data['event_name']
+		)
+		) {
+			if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registrations',
+				'espresso_registrations_new_registration',
+				$this->_req_data['EVT_ID']
+			)
+			) {
+				$this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button-primary" href="';
+				$this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'page'     => 'espresso_registrations',
+						'action'   => 'new_registration',
+						'return'   => 'default',
+						'TXN_ID'   => $this->_transaction->ID(),
+						'event_id' => $this->_req_data['EVT_ID'],
+					),
+					REG_ADMIN_URL
+				);
+				$this->_admin_page_title .= '">';
+
+				$this->_admin_page_title .= sprintf(
+					esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'),
+					htmlentities(urldecode($this->_req_data['event_name']), ENT_QUOTES, 'UTF-8')
+				);
+				$this->_admin_page_title .= '</a>';
+			}
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// grab messages at the last second
+		$this->_template_args['notices'] = EE_Error::get_notices();
+		// path to template
+		$template_path                             = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
+		$this->_template_args['admin_page_header'] = EEH_Template::display_template($template_path,
+			$this->_template_args, true);
+
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+
+	}
+
+
+	/**
+	 *        _transaction_details_metaboxes
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _transaction_details_metaboxes()
+	{
+
+		$this->_set_transaction_object();
+
+		add_meta_box('edit-txn-details-mbox', esc_html__('Transaction Details', 'event_espresso'),
+			array($this, 'txn_details_meta_box'), $this->_wp_page_slug, 'normal', 'high');
+		add_meta_box(
+			'edit-txn-attendees-mbox',
+			esc_html__('Attendees Registered in this Transaction', 'event_espresso'),
+			array($this, 'txn_attendees_meta_box'),
+			$this->_wp_page_slug,
+			'normal',
+			'high',
+			array('TXN_ID' => $this->_transaction->ID())
+		);
+		add_meta_box('edit-txn-registrant-mbox', esc_html__('Primary Contact', 'event_espresso'),
+			array($this, 'txn_registrant_side_meta_box'), $this->_wp_page_slug, 'side', 'high');
+		add_meta_box('edit-txn-billing-info-mbox', esc_html__('Billing Information', 'event_espresso'),
+			array($this, 'txn_billing_info_side_meta_box'), $this->_wp_page_slug, 'side', 'high');
+
+	}
+
+
+	/**
+	 * txn_details_meta_box
+	 * generates HTML for the Transaction main meta box
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function txn_details_meta_box()
+	{
+
+		$this->_set_transaction_object();
+		$this->_template_args['TXN_ID']   = $this->_transaction->ID();
+		$this->_template_args['attendee'] = $this->_transaction->primary_registration() instanceof EE_Registration ? $this->_transaction->primary_registration()->attendee() : null;
+
+		//get line table
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		$Line_Item_Display                       = new EE_Line_Item_Display('admin_table',
+			'EE_Admin_Table_Line_Item_Display_Strategy');
+		$this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item($this->_transaction->total_line_item());
+		$this->_template_args['REG_code']        = $this->_transaction->get_first_related('Registration')->get('REG_code');
+
+		// process taxes
+		$taxes                         = $this->_transaction->get_many_related('Line_Item',
+			array(array('LIN_type' => EEM_Line_Item::type_tax)));
+		$this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false;
+
+		$this->_template_args['grand_total']     = EEH_Template::format_currency($this->_transaction->get('TXN_total'),
+			false, false);
+		$this->_template_args['grand_raw_total'] = $this->_transaction->get('TXN_total');
+		$this->_template_args['TXN_status']      = $this->_transaction->get('STS_ID');
 
 //		$txn_status_class = 'status-' . $this->_transaction->get('STS_ID');
 
-        // process payment details
-        $payments = $this->_transaction->get_many_related('Payment');
-        if ( ! empty($payments)) {
-            $this->_template_args['payments']              = $payments;
-            $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments);
-        } else {
-            $this->_template_args['payments']              = false;
-            $this->_template_args['existing_reg_payments'] = array();
-        }
-
-        $this->_template_args['edit_payment_url']   = add_query_arg(array('action' => 'edit_payment'), TXN_ADMIN_URL);
-        $this->_template_args['delete_payment_url'] = add_query_arg(array('action' => 'espresso_delete_payment'),
-            TXN_ADMIN_URL);
-
-        if (isset($txn_details['invoice_number'])) {
-            $this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code'];
-            $this->_template_args['txn_details']['invoice_number']['label'] = esc_html__('Invoice Number',
-                'event_espresso');
-        }
-
-        $this->_template_args['txn_details']['registration_session']['value'] = $this->_transaction->get_first_related('Registration')->get('REG_session');
-        $this->_template_args['txn_details']['registration_session']['label'] = esc_html__('Registration Session',
-            'event_espresso');
-
-        $this->_template_args['txn_details']['ip_address']['value'] = isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '';
-        $this->_template_args['txn_details']['ip_address']['label'] = esc_html__('Transaction placed from IP',
-            'event_espresso');
-
-        $this->_template_args['txn_details']['user_agent']['value'] = isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '';
-        $this->_template_args['txn_details']['user_agent']['label'] = esc_html__('Registrant User Agent',
-            'event_espresso');
-
-        $reg_steps = '<ul>';
-        foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) {
-            if ($reg_step_status === true) {
-                $reg_steps .= '<li style="color:#70cc50">' . sprintf(esc_html__('%1$s : Completed', 'event_espresso'),
-                        ucwords(str_replace('_', ' ', $reg_step))) . '</li>';
-            } else if (is_numeric($reg_step_status) && $reg_step_status !== false) {
-                $reg_steps .= '<li style="color:#2EA2CC">' . sprintf(
-                        esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
-                        ucwords(str_replace('_', ' ', $reg_step)),
-                        date(get_option('date_format') . ' ' . get_option('time_format'),
-                            ($reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS)))
-                    ) . '</li>';
-            } else {
-                $reg_steps .= '<li style="color:#E76700">' . sprintf(esc_html__('%1$s : Never Initiated',
-                        'event_espresso'), ucwords(str_replace('_', ' ', $reg_step))) . '</li>';
-            }
-        }
-        $reg_steps .= '</ul>';
-        $this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps;
-        $this->_template_args['txn_details']['reg_steps']['label'] = esc_html__('Registration Step Progress',
-            'event_espresso');
-
-
-        $this->_get_registrations_to_apply_payment_to();
-        $this->_get_payment_methods($payments);
-        $this->_get_payment_status_array();
-        $this->_get_reg_status_selection(); //sets up the template args for the reg status array for the transaction.
-
-        $this->_template_args['transaction_form_url']    = add_query_arg(array(
-            'action'  => 'edit_transaction',
-            'process' => 'transaction'
-        ), TXN_ADMIN_URL);
-        $this->_template_args['apply_payment_form_url']  = add_query_arg(array(
-            'page'   => 'espresso_transactions',
-            'action' => 'espresso_apply_payment'
-        ), WP_AJAX_URL);
-        $this->_template_args['delete_payment_form_url'] = add_query_arg(array(
-            'page'   => 'espresso_transactions',
-            'action' => 'espresso_delete_payment'
-        ), WP_AJAX_URL);
-
-        // 'espresso_delete_payment_nonce'
-
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-
-    }
-
-
-    /**
-     * _get_registration_payment_IDs
-     *
-     *    generates an array of Payment IDs and their corresponding Registration IDs
-     *
-     * @access protected
-     *
-     * @param EE_Payment[] $payments
-     *
-     * @return array
-     */
-    protected function _get_registration_payment_IDs($payments = array())
-    {
-        $existing_reg_payments = array();
-        // get all reg payments for these payments
-        $reg_payments = EEM_Registration_Payment::instance()->get_all(array(
-            array(
-                'PAY_ID' => array(
-                    'IN',
-                    array_keys($payments)
-                )
-            )
-        ));
-        if ( ! empty($reg_payments)) {
-            foreach ($payments as $payment) {
-                if ( ! $payment instanceof EE_Payment) {
-                    continue;
-                } else if ( ! isset($existing_reg_payments[$payment->ID()])) {
-                    $existing_reg_payments[$payment->ID()] = array();
-                }
-                foreach ($reg_payments as $reg_payment) {
-                    if ($reg_payment instanceof EE_Registration_Payment && $reg_payment->payment_ID() === $payment->ID()) {
-                        $existing_reg_payments[$payment->ID()][] = $reg_payment->registration_ID();
-                    }
-                }
-            }
-        }
-
-        return $existing_reg_payments;
-    }
-
-
-    /**
-     * _get_registrations_to_apply_payment_to
-     *    generates HTML for displaying a series of checkboxes in the admin payment modal window
-     * which allows the admin to only apply the payment to the specific registrations
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _get_registrations_to_apply_payment_to()
-    {
-        // we want any registration with an active status (ie: not deleted or cancelled)
-        $query_params                      = array(
-            array(
-                'STS_ID' => array(
-                    'IN',
-                    array(
-                        EEM_Registration::status_id_approved,
-                        EEM_Registration::status_id_pending_payment,
-                        EEM_Registration::status_id_not_approved,
-                    )
-                )
-            )
-        );
-        $registrations_to_apply_payment_to = EEH_HTML::br() . EEH_HTML::div(
-                '', 'txn-admin-apply-payment-to-registrations-dv', '', 'clear: both; margin: 1.5em 0 0; display: none;'
-            );
-        $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
-        $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl');
-        $registrations_to_apply_payment_to .= EEH_HTML::thead(
-            EEH_HTML::tr(
-                EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
-            )
-        );
-        $registrations_to_apply_payment_to .= EEH_HTML::tbody();
-        // get registrations for TXN
-        $registrations = $this->_transaction->registrations($query_params);
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                $attendee_name = $registration->attendee() instanceof EE_Attendee
-                    ? $registration->attendee()->full_name()
-                    : esc_html__('Unknown Attendee', 'event_espresso');
-                $owing         = $registration->final_price() - $registration->paid();
-                $taxable       = $registration->ticket()->taxable()
-                    ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
-                    : '';
-                $checked       = empty($existing_reg_payments) || in_array($registration->ID(), $existing_reg_payments)
-                    ? ' checked="checked"'
-                    : '';
-                $disabled      = $registration->final_price() > 0 ? '' : ' disabled';
-                $registrations_to_apply_payment_to .= EEH_HTML::tr(
-                    EEH_HTML::td($registration->ID()) .
-                    EEH_HTML::td($attendee_name) .
-                    EEH_HTML::td(
-                        $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
-                    ) .
-                    EEH_HTML::td($registration->event_name()) .
-                    EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
-                    EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr') .
-                    EEH_HTML::td(
-                        '<input type="checkbox" value="' . $registration->ID()
-                        . '" name="txn_admin_payment[registrations]"'
-                        . $checked . $disabled . '>',
-                        '', 'jst-cntr'
-                    ),
-                    'apply-payment-registration-row-' . $registration->ID()
-                );
-            }
-        }
-        $registrations_to_apply_payment_to .= EEH_HTML::tbodyx();
-        $registrations_to_apply_payment_to .= EEH_HTML::tablex();
-        $registrations_to_apply_payment_to .= EEH_HTML::divx();
-        $registrations_to_apply_payment_to .= EEH_HTML::p(
-            esc_html__(
-                'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.',
-                'event_espresso'
-            ),
-            '', 'clear description'
-        );
-        $registrations_to_apply_payment_to .= EEH_HTML::divx();
-        $this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to;
-    }
-
-
-    /**
-     * _get_reg_status_selection
-     *
-     * @todo   this will need to be adjusted either once MER comes along OR we move default reg status to tickets
-     *         instead of events.
-     * @access protected
-     * @return void
-     */
-    protected function _get_reg_status_selection()
-    {
-        //first get all possible statuses
-        $statuses = EEM_Registration::reg_status_array(array(), true);
-        //let's add a "don't change" option.
-        $status_array['NAN']                                 = esc_html__('Leave the Same', 'event_espresso');
-        $status_array                                        = array_merge($status_array, $statuses);
-        $this->_template_args['status_change_select']        = EEH_Form_Fields::select_input('txn_reg_status_change[reg_status]',
-            $status_array, 'NAN', 'id="txn-admin-payment-reg-status-inp"', 'txn-reg-status-change-reg-status');
-        $this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input('delete_txn_reg_status_change[reg_status]',
-            $status_array, 'NAN', 'delete-txn-admin-payment-reg-status-inp', 'delete-txn-reg-status-change-reg-status');
-
-    }
-
-
-    /**
-     *    _get_payment_methods
-     * Gets all the payment methods available generally, or the ones that are already
-     * selected on these payments (in case their payment methods are no longer active).
-     * Has the side-effect of updating the template args' payment_methods item
-     * @access private
-     *
-     * @param EE_Payment[] to show on this page
-     *
-     * @return void
-     */
-    private function _get_payment_methods($payments = array())
-    {
-        $payment_methods_of_payments = array();
-        foreach ($payments as $payment) {
-            if ($payment instanceof EE_Payment) {
-                $payment_methods_of_payments[] = $payment->get('PMD_ID');
-            }
-        }
-        if ($payment_methods_of_payments) {
-            $query_args = array(
-                array(
-                    'OR*payment_method_for_payment' => array(
-                        'PMD_ID'    => array('IN', $payment_methods_of_payments),
-                        'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%')
-                    )
-                )
-            );
-        } else {
-            $query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%')));
-        }
-        $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
-    }
-
-
-    /**
-     * txn_attendees_meta_box
-     *    generates HTML for the Attendees Transaction main meta box
-     *
-     * @access public
-     *
-     * @param WP_Post $post
-     * @param array   $metabox
-     *
-     * @return void
-     */
-    public function txn_attendees_meta_box($post, $metabox = array('args' => array()))
-    {
-
-        extract($metabox['args']);
-        $this->_template_args['post']            = $post;
-        $this->_template_args['event_attendees'] = array();
-        // process items in cart
-        $line_items = $this->_transaction->get_many_related('Line_Item', array(array('LIN_type' => 'line-item')));
-        if ( ! empty($line_items)) {
-            foreach ($line_items as $item) {
-                if ($item instanceof EE_Line_Item) {
-                    switch ($item->OBJ_type()) {
-
-                        case 'Event' :
-                            break;
-
-                        case 'Ticket' :
-                            $ticket = $item->ticket();
-                            //right now we're only handling tickets here.  Cause its expected that only tickets will have attendees right?
-                            if ( ! $ticket instanceof EE_Ticket) {
-                                continue;
-                            }
-                            try {
-                                $event_name = $ticket->get_event_name();
-                            } catch (Exception $e) {
-                                EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                                $event_name = esc_html__('Unknown Event', 'event_espresso');
-                            }
-                            $event_name .= ' - ' . $item->get('LIN_name');
-                            $ticket_price = EEH_Template::format_currency($item->get('LIN_unit_price'));
-                            // now get all of the registrations for this transaction that use this ticket
-                            $registrations = $ticket->get_many_related('Registration',
-                                array(array('TXN_ID' => $this->_transaction->ID())));
-                            foreach ($registrations as $registration) {
-                                if ( ! $registration instanceof EE_Registration) {
-                                    continue;
-                                }
-                                $this->_template_args['event_attendees'][$registration->ID()]['STS_ID']            = $registration->status_ID();
-                                $this->_template_args['event_attendees'][$registration->ID()]['att_num']           = $registration->count();
-                                $this->_template_args['event_attendees'][$registration->ID()]['event_ticket_name'] = $event_name;
-                                $this->_template_args['event_attendees'][$registration->ID()]['ticket_price']      = $ticket_price;
-                                // attendee info
-                                $attendee = $registration->get_first_related('Attendee');
-                                if ($attendee instanceof EE_Attendee) {
-                                    $this->_template_args['event_attendees'][$registration->ID()]['att_id']   = $attendee->ID();
-                                    $this->_template_args['event_attendees'][$registration->ID()]['attendee'] = $attendee->full_name();
-                                    $this->_template_args['event_attendees'][$registration->ID()]['email']    = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name . esc_html__(' Event',
-                                            'event_espresso') . '">' . $attendee->email() . '</a>';
-                                    $this->_template_args['event_attendees'][$registration->ID()]['address']  = EEH_Address::format($attendee,
-                                        'inline', false, false);
-                                } else {
-                                    $this->_template_args['event_attendees'][$registration->ID()]['att_id']   = '';
-                                    $this->_template_args['event_attendees'][$registration->ID()]['attendee'] = '';
-                                    $this->_template_args['event_attendees'][$registration->ID()]['email']    = '';
-                                    $this->_template_args['event_attendees'][$registration->ID()]['address']  = '';
-                                }
-                            }
-                            break;
-
-                    }
-                }
-            }
-
-            $this->_template_args['transaction_form_url'] = add_query_arg(array(
-                'action'  => 'edit_transaction',
-                'process' => 'attendees'
-            ), TXN_ADMIN_URL);
-            echo EEH_Template::display_template(TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
-                $this->_template_args, true);
-
-        } else {
-            echo sprintf(
-                esc_html__('%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s',
-                    'event_espresso'),
-                '<p class="important-notice">',
-                '</p>'
-            );
-        }
-    }
-
-
-    /**
-     * txn_registrant_side_meta_box
-     * generates HTML for the Edit Transaction side meta box
-     *
-     * @access public
-     * @throws \EE_Error
-     * @return void
-     */
-    public function txn_registrant_side_meta_box()
-    {
-        $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration ? $this->_transaction->primary_registration()->get_first_related('Attendee') : null;
-        if ( ! $primary_att instanceof EE_Attendee) {
-            $this->_template_args['no_attendee_message'] = esc_html__('There is no attached contact for this transaction.  The transaction either failed due to an error or was abandoned.',
-                'event_espresso');
-            $primary_att                                 = EEM_Attendee::instance()->create_default_object();
-        }
-        $this->_template_args['ATT_ID']            = $primary_att->ID();
-        $this->_template_args['prime_reg_fname']   = $primary_att->fname();
-        $this->_template_args['prime_reg_lname']   = $primary_att->lname();
-        $this->_template_args['prime_reg_email']   = $primary_att->email();
-        $this->_template_args['prime_reg_phone']   = $primary_att->phone();
-        $this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action' => 'edit_attendee',
-            'post'   => $primary_att->ID()
-        ), REG_ADMIN_URL);
-        // get formatted address for registrant
-        $this->_template_args['formatted_address'] = EEH_Address::format($primary_att);
-        echo EEH_Template::display_template(TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
-            $this->_template_args, true);
-    }
-
-
-    /**
-     * txn_billing_info_side_meta_box
-     *    generates HTML for the Edit Transaction side meta box
-     *
-     * @access public
-     * @return void
-     */
-    public function txn_billing_info_side_meta_box()
-    {
-
-        $this->_template_args['billing_form']     = $this->_transaction->billing_info();
-        $this->_template_args['billing_form_url'] = add_query_arg(
-            array('action' => 'edit_transaction', 'process' => 'billing'),
-            TXN_ADMIN_URL
-        );
-
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);/**/
-    }
-
-
-    /**
-     * apply_payments_or_refunds
-     *    registers a payment or refund made towards a transaction
-     *
-     * @access public
-     * @return void
-     */
-    public function apply_payments_or_refunds()
-    {
-        $json_response_data = array('return_data' => false);
-        $valid_data         = $this->_validate_payment_request_data();
-        if ( ! empty($valid_data)) {
-            $PAY_ID = $valid_data['PAY_ID'];
-            //save  the new payment
-            $payment = $this->_create_payment_from_request_data($valid_data);
-            // get the TXN for this payment
-            $transaction = $payment->transaction();
-            // verify transaction
-            if ($transaction instanceof EE_Transaction) {
-                // calculate_total_payments_and_update_status
-                $this->_process_transaction_payments($transaction);
-                $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment);
-                $this->_remove_existing_registration_payments($payment, $PAY_ID);
-                // apply payment to registrations (if applicable)
-                if ( ! empty($REG_IDs)) {
-                    $this->_update_registration_payments($transaction, $payment, $REG_IDs);
-                    $this->_maybe_send_notifications();
-                    // now process status changes for the same registrations
-                    $this->_process_registration_status_change($transaction, $REG_IDs);
-                }
-                $this->_maybe_send_notifications($payment);
-                //prepare to render page
-                $json_response_data['return_data'] = $this->_build_payment_json_response($payment, $REG_IDs);
-                do_action('AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording', $transaction,
-                    $payment);
-            } else {
-                EE_Error::add_error(
-                    esc_html__('A valid Transaction for this payment could not be retrieved.', 'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-            }
-        } else {
-            EE_Error::add_error(esc_html__('The payment form data could not be processed. Please try again.',
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-        }
-
-        $notices              = EE_Error::get_notices(false, false, false);
-        $this->_template_args = array(
-            'data'    => $json_response_data,
-            'error'   => $notices['errors'],
-            'success' => $notices['success']
-        );
-        $this->_return_json();
-    }
-
-
-    /**
-     * _validate_payment_request_data
-     *
-     * @return array
-     */
-    protected function _validate_payment_request_data()
-    {
-        if ( ! isset($this->_req_data['txn_admin_payment'])) {
-            return false;
-        }
-        $payment_form = $this->_generate_payment_form_section();
-        try {
-            if ($payment_form->was_submitted()) {
-                $payment_form->receive_form_submission();
-                if ( ! $payment_form->is_valid()) {
-                    $submission_error_messages = array();
-                    foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) {
-                        if ($validation_error instanceof EE_Validation_Error) {
-                            $submission_error_messages[] = sprintf(
-                                _x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'),
-                                $validation_error->get_form_section()->html_label_text(),
-                                $validation_error->getMessage()
-                            );
-                        }
-                    }
-                    EE_Error::add_error(join('<br />', $submission_error_messages), __FILE__, __FUNCTION__, __LINE__);
-
-                    return array();
-                }
-            }
-        } catch (EE_Error $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-
-            return array();
-        }
-
-        return $payment_form->valid_data();
-    }
-
-
-    /**
-     * _generate_payment_form_section
-     *
-     * @return EE_Form_Section_Proper
-     */
-    protected function _generate_payment_form_section()
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'name'        => 'txn_admin_payment',
-                'subsections' => array(
-                    'PAY_ID'          => new EE_Text_Input(
-                        array(
-                            'default'               => 0,
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Payment ID', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Int_Normalization())
-                        )
-                    ),
-                    'TXN_ID'          => new EE_Text_Input(
-                        array(
-                            'default'               => 0,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Transaction ID', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Int_Normalization())
-                        )
-                    ),
-                    'type'            => new EE_Text_Input(
-                        array(
-                            'default'               => 1,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment or Refund', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Int_Normalization())
-                        )
-                    ),
-                    'amount'          => new EE_Text_Input(
-                        array(
-                            'default'               => 0,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment amount', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Float_Normalization())
-                        )
-                    ),
-                    'status'          => new EE_Text_Input(
-                        array(
-                            'default'         => EEM_Payment::status_id_approved,
-                            'required'        => true,
-                            'html_label_text' => esc_html__('Payment status', 'event_espresso'),
-                        )
-                    ),
-                    'PMD_ID'          => new EE_Text_Input(
-                        array(
-                            'default'               => 2,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment Method', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Int_Normalization())
-                        )
-                    ),
-                    'date'            => new EE_Text_Input(
-                        array(
-                            'default'         => time(),
-                            'required'        => true,
-                            'html_label_text' => esc_html__('Payment date', 'event_espresso'),
-                        )
-                    ),
-                    'txn_id_chq_nmbr' => new EE_Text_Input(
-                        array(
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Transaction or Cheque Number', 'event_espresso'),
-                            'validation_strategies' => array(
-                                new EE_Max_Length_Validation_Strategy(esc_html__('Input too long', 'event_espresso'),
-                                    100),
-                            )
-                        )
-                    ),
-                    'po_number'       => new EE_Text_Input(
-                        array(
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Purchase Order Number', 'event_espresso'),
-                            'validation_strategies' => array(
-                                new EE_Max_Length_Validation_Strategy(esc_html__('Input too long', 'event_espresso'),
-                                    100),
-                            )
-                        )
-                    ),
-                    'accounting'      => new EE_Text_Input(
-                        array(
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Extra Field for Accounting', 'event_espresso'),
-                            'validation_strategies' => array(
-                                new EE_Max_Length_Validation_Strategy(esc_html__('Input too long', 'event_espresso'),
-                                    100),
-                            )
-                        )
-                    ),
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _create_payment_from_request_data
-     *
-     * @param array $valid_data
-     *
-     * @return EE_Payment
-     */
-    protected function _create_payment_from_request_data($valid_data)
-    {
-        $PAY_ID = $valid_data['PAY_ID'];
-        // get payment amount
-        $amount = $valid_data['amount'] ? abs($valid_data['amount']) : 0;
-        // payments have a type value of 1 and refunds have a type value of -1
-        // so multiplying amount by type will give a positive value for payments, and negative values for refunds
-        $amount = $valid_data['type'] < 0 ? $amount * -1 : $amount;
-        // for some reason the date string coming in has extra spaces between the date and time.  This fixes that.
-        $date    = $valid_data['date'] ? preg_replace('/\s+/', ' ', $valid_data['date']) : date('Y-m-d g:i a',
-            current_time('timestamp'));
-        $payment = EE_Payment::new_instance(
-            array(
-                'TXN_ID'              => $valid_data['TXN_ID'],
-                'STS_ID'              => $valid_data['status'],
-                'PAY_timestamp'       => $date,
-                'PAY_source'          => EEM_Payment_Method::scope_admin,
-                'PMD_ID'              => $valid_data['PMD_ID'],
-                'PAY_amount'          => $amount,
-                'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'],
-                'PAY_po_number'       => $valid_data['po_number'],
-                'PAY_extra_accntng'   => $valid_data['accounting'],
-                'PAY_details'         => $valid_data,
-                'PAY_ID'              => $PAY_ID
-            ),
-            '',
-            array('Y-m-d', 'g:i a')
-        );
-
-        if ( ! $payment->save()) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'),
-                    $payment->ID()
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-
-        return $payment;
-    }
-
-
-    /**
-     * _process_transaction_payments
-     *
-     * @param \EE_Transaction $transaction
-     *
-     * @return array
-     */
-    protected function _process_transaction_payments(EE_Transaction $transaction)
-    {
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-        //update the transaction with this payment
-        if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) {
-            EE_Error::add_success(esc_html__('The payment has been processed successfully.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            EE_Error::add_error(
-                esc_html__('The payment was processed successfully but the amount paid for the transaction was not updated.',
-                    'event_espresso')
-                , __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * _get_REG_IDs_to_apply_payment_to
-     *
-     * returns a list of registration IDs that the payment will apply to
-     *
-     * @param \EE_Payment $payment
-     *
-     * @return array
-     */
-    protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment)
-    {
-        $REG_IDs = array();
-        // grab array of IDs for specific registrations to apply changes to
-        if (isset($this->_req_data['txn_admin_payment']['registrations'])) {
-            $REG_IDs = (array)$this->_req_data['txn_admin_payment']['registrations'];
-        }
-        //nothing specified ? then get all reg IDs
-        if (empty($REG_IDs)) {
-            $registrations = $payment->transaction()->registrations();
-            $REG_IDs       = ! empty($registrations) ? array_keys($registrations) : $this->_get_existing_reg_payment_REG_IDs($payment);
-        }
-
-        // ensure that REG_IDs are integers and NOT strings
-        return array_map('intval', $REG_IDs);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function existing_reg_payment_REG_IDs()
-    {
-        return $this->_existing_reg_payment_REG_IDs;
-    }
-
-
-    /**
-     * @param array $existing_reg_payment_REG_IDs
-     */
-    public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null)
-    {
-        $this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs;
-    }
-
-
-    /**
-     * _get_existing_reg_payment_REG_IDs
-     *
-     * returns a list of registration IDs that the payment is currently related to
-     * as recorded in the database
-     *
-     * @param \EE_Payment $payment
-     *
-     * @return array
-     */
-    protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment)
-    {
-        if ($this->existing_reg_payment_REG_IDs() === null) {
-            // let's get any existing reg payment records for this payment
-            $existing_reg_payment_REG_IDs = $payment->get_many_related('Registration');
-            // but we only want the REG IDs, so grab the array keys
-            $existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs) ? array_keys($existing_reg_payment_REG_IDs) : array();
-            $this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs);
-        }
-
-        return $this->existing_reg_payment_REG_IDs();
-    }
-
-
-    /**
-     * _remove_existing_registration_payments
-     *
-     * this calculates the difference between existing relations
-     * to the supplied payment and the new list registration IDs,
-     * removes any related registrations that no longer apply,
-     * and then updates the registration paid fields
-     *
-     * @param \EE_Payment $payment
-     * @param int         $PAY_ID
-     *
-     * @return bool;
-     */
-    protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0)
-    {
-        // newly created payments will have nothing recorded for $PAY_ID
-        if ($PAY_ID == 0) {
-            return false;
-        }
-        $existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
-        if (empty($existing_reg_payment_REG_IDs)) {
-            return false;
-        }
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-
-        return $transaction_payments->delete_registration_payments_and_update_registrations(
-            $payment,
-            array(
-                array(
-                    'PAY_ID' => $payment->ID(),
-                    'REG_ID' => array('IN', $existing_reg_payment_REG_IDs),
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _update_registration_payments
-     *
-     * this applies the payments to the selected registrations
-     * but only if they have not already been paid for
-     *
-     * @param  EE_Transaction $transaction
-     * @param \EE_Payment     $payment
-     * @param array           $REG_IDs
-     *
-     * @return bool
-     */
-    protected function _update_registration_payments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        $REG_IDs = array()
-    ) {
-        // we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments()
-        // so let's do that using our set of REG_IDs from the form
-        $registration_query_where_params = array(
-            'REG_ID' => array('IN', $REG_IDs)
-        );
-        // but add in some conditions regarding payment,
-        // so that we don't apply payments to registrations that are free or have already been paid for
-        // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative )
-        if ( ! $payment->is_a_refund()) {
-            $registration_query_where_params['REG_final_price']  = array('!=', 0);
-            $registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true);
-        }
-        //EEH_Debug_Tools::printr( $registration_query_where_params, '$registration_query_where_params', __FILE__, __LINE__ );
-        $registrations = $transaction->registrations(array($registration_query_where_params));
-        if ( ! empty($registrations)) {
-            /** @type EE_Payment_Processor $payment_processor */
-            $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-            $payment_processor->process_registration_payments($transaction, $payment, $registrations);
-        }
-    }
-
-
-    /**
-     * _process_registration_status_change
-     *
-     * This processes requested registration status changes for all the registrations
-     * on a given transaction and (optionally) sends out notifications for the changes.
-     *
-     * @param  EE_Transaction $transaction
-     * @param array           $REG_IDs
-     *
-     * @return bool
-     */
-    protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = array())
-    {
-        // first if there is no change in status then we get out.
-        if (
-            ! isset($this->_req_data['txn_reg_status_change'], $this->_req_data['txn_reg_status_change']['reg_status'])
-            || $this->_req_data['txn_reg_status_change']['reg_status'] == 'NAN'
-        ) {
-            //no error message, no change requested, just nothing to do man.
-            return false;
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-
-        // made it here dude?  Oh WOW.  K, let's take care of changing the statuses
-        return $transaction_processor->manually_update_registration_statuses(
-            $transaction,
-            sanitize_text_field($this->_req_data['txn_reg_status_change']['reg_status']),
-            array(array('REG_ID' => array('IN', $REG_IDs)))
-        );
-    }
-
-
-    /**
-     * _build_payment_json_response
-     *
-     * @access public
-     *
-     * @param \EE_Payment $payment
-     * @param array       $REG_IDs
-     * @param bool | null $delete_txn_reg_status_change
-     *
-     * @return array
-     */
-    protected function _build_payment_json_response(
-        EE_Payment $payment,
-        $REG_IDs = array(),
-        $delete_txn_reg_status_change = null
-    ) {
-        // was the payment deleted ?
-        if (is_bool($delete_txn_reg_status_change)) {
-            return array(
-                'PAY_ID'                       => $payment->ID(),
-                'amount'                       => $payment->amount(),
-                'total_paid'                   => $payment->transaction()->paid(),
-                'txn_status'                   => $payment->transaction()->status_ID(),
-                'pay_status'                   => $payment->STS_ID(),
-                'registrations'                => $this->_registration_payment_data_array($REG_IDs),
-                'delete_txn_reg_status_change' => $delete_txn_reg_status_change,
-            );
-        } else {
-            $this->_get_payment_status_array();
-
-            return array(
-                'amount'           => $payment->amount(),
-                'total_paid'       => $payment->transaction()->paid(),
-                'txn_status'       => $payment->transaction()->status_ID(),
-                'pay_status'       => $payment->STS_ID(),
-                'PAY_ID'           => $payment->ID(),
-                'STS_ID'           => $payment->STS_ID(),
-                'status'           => self::$_pay_status[$payment->STS_ID()],
-                'date'             => $payment->timestamp('Y-m-d', 'h:i a'),
-                'method'           => strtoupper($payment->source()),
-                'PM_ID'            => $payment->payment_method() ? $payment->payment_method()->ID() : 1,
-                'gateway'          => $payment->payment_method() ? $payment->payment_method()->admin_name() : esc_html__("Unknown",
-                    'event_espresso'),
-                'gateway_response' => $payment->gateway_response(),
-                'txn_id_chq_nmbr'  => $payment->txn_id_chq_nmbr(),
-                'po_number'        => $payment->po_number(),
-                'extra_accntng'    => $payment->extra_accntng(),
-                'registrations'    => $this->_registration_payment_data_array($REG_IDs),
-            );
-        }
-    }
-
-
-    /**
-     * delete_payment
-     *    delete a payment or refund made towards a transaction
-     *
-     * @access public
-     * @return void
-     */
-    public function delete_payment()
-    {
-        $json_response_data = array('return_data' => false);
-        $PAY_ID             = isset($this->_req_data['delete_txn_admin_payment'], $this->_req_data['delete_txn_admin_payment']['PAY_ID']) ? absint($this->_req_data['delete_txn_admin_payment']['PAY_ID']) : 0;
-        if ($PAY_ID) {
-            $delete_txn_reg_status_change = isset($this->_req_data['delete_txn_reg_status_change']) ? $this->_req_data['delete_txn_reg_status_change'] : false;
-            $payment                      = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
-            if ($payment instanceof EE_Payment) {
-                $REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                if ($transaction_payments->delete_payment_and_update_transaction($payment)) {
-                    $json_response_data['return_data'] = $this->_build_payment_json_response($payment, $REG_IDs,
-                        $delete_txn_reg_status_change);
-                    if ($delete_txn_reg_status_change) {
-                        $this->_req_data['txn_reg_status_change'] = $delete_txn_reg_status_change;
-                        //MAKE sure we also add the delete_txn_req_status_change to the
-                        //$_REQUEST global because that's how messages will be looking for it.
-                        $_REQUEST['txn_reg_status_change'] = $delete_txn_reg_status_change;
-                        $this->_maybe_send_notifications();
-                        $this->_process_registration_status_change($payment->transaction(), $REG_IDs);
-                    }
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__('A valid Payment ID was not received, therefore payment form data could not be loaded.',
-                    'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        $notices              = EE_Error::get_notices(false, false, false);
-        $this->_template_args = array(
-            'data'      => $json_response_data,
-            'success'   => $notices['success'],
-            'error'     => $notices['errors'],
-            'attention' => $notices['attention']
-        );
-        $this->_return_json();
-    }
-
-
-    /**
-     * _registration_payment_data_array
-     * adds info for 'owing' and 'paid' for each registration to the json response
-     *
-     * @access protected
-     *
-     * @param array $REG_IDs
-     *
-     * @return array
-     */
-    protected function _registration_payment_data_array($REG_IDs)
-    {
-        $registration_payment_data = array();
-        //if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows.
-        if ( ! empty($REG_IDs)) {
-            $registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs))));
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration) {
-                    $registration_payment_data[$registration->ID()] = array(
-                        'paid'  => $registration->pretty_paid(),
-                        'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()),
-                    );
-                }
-            }
-        }
-
-        return $registration_payment_data;
-    }
-
-
-    /**
-     * _maybe_send_notifications
-     *
-     * determines whether or not the admin has indicated that notifications should be sent.
-     * If so, will toggle a filter switch for delivering registration notices.
-     * If passed an EE_Payment object, then it will trigger payment notifications instead.
-     *
-     * @access protected
-     *
-     * @param \EE_Payment | null $payment
-     */
-    protected function _maybe_send_notifications($payment = null)
-    {
-        switch ($payment instanceof EE_Payment) {
-            // payment notifications
-            case true :
-                if (
-                    isset(
-                        $this->_req_data['txn_payments'],
-                        $this->_req_data['txn_payments']['send_notifications']
-                    ) &&
-                    filter_var($this->_req_data['txn_payments']['send_notifications'], FILTER_VALIDATE_BOOLEAN)
-                ) {
-                    $this->_process_payment_notification($payment);
-                }
-                break;
-            // registration notifications
-            case false :
-                if (
-                    isset(
-                        $this->_req_data['txn_reg_status_change'],
-                        $this->_req_data['txn_reg_status_change']['send_notifications']
-                    ) &&
-                    filter_var($this->_req_data['txn_reg_status_change']['send_notifications'], FILTER_VALIDATE_BOOLEAN)
-                ) {
-                    add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-                }
-                break;
-        }
-    }
-
-
-    /**
-     * _send_payment_reminder
-     *    generates HTML for the View Transaction Details Admin page
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _send_payment_reminder()
-    {
-        $TXN_ID      = ( ! empty($this->_req_data['TXN_ID'])) ? absint($this->_req_data['TXN_ID']) : false;
-        $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-        $query_args  = isset($this->_req_data['redirect_to']) ? array(
-            'action' => $this->_req_data['redirect_to'],
-            'TXN_ID' => $this->_req_data['TXN_ID']
-        ) : array();
-        do_action('AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
-            $transaction);
-        $this->_redirect_after_action(false, esc_html__('payment reminder', 'event_espresso'),
-            esc_html__('sent', 'event_espresso'), $query_args, true);
-    }
-
-
-    /**
-     *  get_transactions
-     *    get transactions for given parameters (used by list table)
-     *
-     * @param  int     $perpage how many transactions displayed per page
-     * @param  boolean $count   return the count or objects
-     * @param string   $view
-     *
-     * @return mixed int = count || array of transaction objects
-     */
-    public function get_transactions($perpage, $count = false, $view = '')
-    {
-
-        $TXN = EEM_Transaction::instance();
-
-        $start_date = isset($this->_req_data['txn-filter-start-date']) ? wp_strip_all_tags($this->_req_data['txn-filter-start-date']) : date('m/d/Y',
-            strtotime('-10 year'));
-        $end_date   = isset($this->_req_data['txn-filter-end-date']) ? wp_strip_all_tags($this->_req_data['txn-filter-end-date']) : date('m/d/Y');
-
-        //make sure our timestamps start and end right at the boundaries for each day
-        $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-        $end_date   = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
-
-
-        //convert to timestamps
-        $start_date = strtotime($start_date);
-        $end_date   = strtotime($end_date);
-
-        //makes sure start date is the lowest value and vice versa
-        $start_date = min($start_date, $end_date);
-        $end_date   = max($start_date, $end_date);
-
-        //convert to correct format for query
-        $start_date = EEM_Transaction::instance()->convert_datetime_for_query('TXN_timestamp',
-            date('Y-m-d H:i:s', $start_date), 'Y-m-d H:i:s');
-        $end_date   = EEM_Transaction::instance()->convert_datetime_for_query('TXN_timestamp',
-            date('Y-m-d H:i:s', $end_date), 'Y-m-d H:i:s');
-
-
-        //set orderby
-        $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
-
-        switch ($this->_req_data['orderby']) {
-            case 'TXN_ID':
-                $orderby = 'TXN_ID';
-                break;
-            case 'ATT_fname':
-                $orderby = 'Registration.Attendee.ATT_fname';
-                break;
-            case 'event_name':
-                $orderby = 'Registration.Event.EVT_name';
-                break;
-            default: //'TXN_timestamp'
-                $orderby = 'TXN_timestamp';
-        }
-
-        $sort         = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'DESC';
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1;
-        $per_page     = isset($perpage) && ! empty($perpage) ? $perpage : 10;
-        $per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $per_page;
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = array($offset, $per_page);
-
-        $_where = array(
-            'TXN_timestamp'          => array('BETWEEN', array($start_date, $end_date)),
-            'Registration.REG_count' => 1
-        );
-
-        if (isset($this->_req_data['EVT_ID'])) {
-            $_where['Registration.EVT_ID'] = $this->_req_data['EVT_ID'];
-        }
-
-        if (isset($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
-            $_where['OR']  = array(
-                'Registration.Event.EVT_name'         => array('LIKE', $search_string),
-                'Registration.Event.EVT_desc'         => array('LIKE', $search_string),
-                'Registration.Event.EVT_short_desc'   => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_full_name' => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_fname'     => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_lname'     => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_short_bio' => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_email'     => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_address'   => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_address2'  => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_city'      => array('LIKE', $search_string),
-                'Registration.REG_final_price'        => array('LIKE', $search_string),
-                'Registration.REG_code'               => array('LIKE', $search_string),
-                'Registration.REG_count'              => array('LIKE', $search_string),
-                'Registration.REG_group_size'         => array('LIKE', $search_string),
-                'Registration.Ticket.TKT_name'        => array('LIKE', $search_string),
-                'Registration.Ticket.TKT_description' => array('LIKE', $search_string),
-                'Payment.PAY_source'                  => array('LIKE', $search_string),
-                'Payment.Payment_Method.PMD_name'     => array('LIKE', $search_string),
-                'TXN_session_data'                    => array('LIKE', $search_string),
-                'Payment.PAY_txn_id_chq_nmbr'         => array('LIKE', $search_string)
-            );
-        }
-
-        //failed transactions
-        $failed    = ( ! empty($this->_req_data['status']) && $this->_req_data['status'] == 'failed' && ! $count) || ($count && $view == 'failed') ? true : false;
-        $abandoned = ( ! empty($this->_req_data['status']) && $this->_req_data['status'] == 'abandoned' && ! $count) || ($count && $view == 'abandoned') ? true : false;
-
-        if ($failed) {
-            $_where['STS_ID'] = EEM_Transaction::failed_status_code;
-        } else if ($abandoned) {
-            $_where['STS_ID'] = EEM_Transaction::abandoned_status_code;
-        } else {
-            $_where['STS_ID']  = array('!=', EEM_Transaction::failed_status_code);
-            $_where['STS_ID*'] = array('!=', EEM_Transaction::abandoned_status_code);
-        }
-
-        $query_params = array($_where, 'order_by' => array($orderby => $sort), 'limit' => $limit);
-
-        $transactions = $count ? $TXN->count(array($_where), 'TXN_ID', true) : $TXN->get_all($query_params);
-
-
-        return $transactions;
-
-    }
+		// process payment details
+		$payments = $this->_transaction->get_many_related('Payment');
+		if ( ! empty($payments)) {
+			$this->_template_args['payments']              = $payments;
+			$this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments);
+		} else {
+			$this->_template_args['payments']              = false;
+			$this->_template_args['existing_reg_payments'] = array();
+		}
+
+		$this->_template_args['edit_payment_url']   = add_query_arg(array('action' => 'edit_payment'), TXN_ADMIN_URL);
+		$this->_template_args['delete_payment_url'] = add_query_arg(array('action' => 'espresso_delete_payment'),
+			TXN_ADMIN_URL);
+
+		if (isset($txn_details['invoice_number'])) {
+			$this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code'];
+			$this->_template_args['txn_details']['invoice_number']['label'] = esc_html__('Invoice Number',
+				'event_espresso');
+		}
+
+		$this->_template_args['txn_details']['registration_session']['value'] = $this->_transaction->get_first_related('Registration')->get('REG_session');
+		$this->_template_args['txn_details']['registration_session']['label'] = esc_html__('Registration Session',
+			'event_espresso');
+
+		$this->_template_args['txn_details']['ip_address']['value'] = isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '';
+		$this->_template_args['txn_details']['ip_address']['label'] = esc_html__('Transaction placed from IP',
+			'event_espresso');
+
+		$this->_template_args['txn_details']['user_agent']['value'] = isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '';
+		$this->_template_args['txn_details']['user_agent']['label'] = esc_html__('Registrant User Agent',
+			'event_espresso');
+
+		$reg_steps = '<ul>';
+		foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) {
+			if ($reg_step_status === true) {
+				$reg_steps .= '<li style="color:#70cc50">' . sprintf(esc_html__('%1$s : Completed', 'event_espresso'),
+						ucwords(str_replace('_', ' ', $reg_step))) . '</li>';
+			} else if (is_numeric($reg_step_status) && $reg_step_status !== false) {
+				$reg_steps .= '<li style="color:#2EA2CC">' . sprintf(
+						esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
+						ucwords(str_replace('_', ' ', $reg_step)),
+						date(get_option('date_format') . ' ' . get_option('time_format'),
+							($reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS)))
+					) . '</li>';
+			} else {
+				$reg_steps .= '<li style="color:#E76700">' . sprintf(esc_html__('%1$s : Never Initiated',
+						'event_espresso'), ucwords(str_replace('_', ' ', $reg_step))) . '</li>';
+			}
+		}
+		$reg_steps .= '</ul>';
+		$this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps;
+		$this->_template_args['txn_details']['reg_steps']['label'] = esc_html__('Registration Step Progress',
+			'event_espresso');
+
+
+		$this->_get_registrations_to_apply_payment_to();
+		$this->_get_payment_methods($payments);
+		$this->_get_payment_status_array();
+		$this->_get_reg_status_selection(); //sets up the template args for the reg status array for the transaction.
+
+		$this->_template_args['transaction_form_url']    = add_query_arg(array(
+			'action'  => 'edit_transaction',
+			'process' => 'transaction'
+		), TXN_ADMIN_URL);
+		$this->_template_args['apply_payment_form_url']  = add_query_arg(array(
+			'page'   => 'espresso_transactions',
+			'action' => 'espresso_apply_payment'
+		), WP_AJAX_URL);
+		$this->_template_args['delete_payment_form_url'] = add_query_arg(array(
+			'page'   => 'espresso_transactions',
+			'action' => 'espresso_delete_payment'
+		), WP_AJAX_URL);
+
+		// 'espresso_delete_payment_nonce'
+
+		$template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+
+	}
+
+
+	/**
+	 * _get_registration_payment_IDs
+	 *
+	 *    generates an array of Payment IDs and their corresponding Registration IDs
+	 *
+	 * @access protected
+	 *
+	 * @param EE_Payment[] $payments
+	 *
+	 * @return array
+	 */
+	protected function _get_registration_payment_IDs($payments = array())
+	{
+		$existing_reg_payments = array();
+		// get all reg payments for these payments
+		$reg_payments = EEM_Registration_Payment::instance()->get_all(array(
+			array(
+				'PAY_ID' => array(
+					'IN',
+					array_keys($payments)
+				)
+			)
+		));
+		if ( ! empty($reg_payments)) {
+			foreach ($payments as $payment) {
+				if ( ! $payment instanceof EE_Payment) {
+					continue;
+				} else if ( ! isset($existing_reg_payments[$payment->ID()])) {
+					$existing_reg_payments[$payment->ID()] = array();
+				}
+				foreach ($reg_payments as $reg_payment) {
+					if ($reg_payment instanceof EE_Registration_Payment && $reg_payment->payment_ID() === $payment->ID()) {
+						$existing_reg_payments[$payment->ID()][] = $reg_payment->registration_ID();
+					}
+				}
+			}
+		}
+
+		return $existing_reg_payments;
+	}
+
+
+	/**
+	 * _get_registrations_to_apply_payment_to
+	 *    generates HTML for displaying a series of checkboxes in the admin payment modal window
+	 * which allows the admin to only apply the payment to the specific registrations
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _get_registrations_to_apply_payment_to()
+	{
+		// we want any registration with an active status (ie: not deleted or cancelled)
+		$query_params                      = array(
+			array(
+				'STS_ID' => array(
+					'IN',
+					array(
+						EEM_Registration::status_id_approved,
+						EEM_Registration::status_id_pending_payment,
+						EEM_Registration::status_id_not_approved,
+					)
+				)
+			)
+		);
+		$registrations_to_apply_payment_to = EEH_HTML::br() . EEH_HTML::div(
+				'', 'txn-admin-apply-payment-to-registrations-dv', '', 'clear: both; margin: 1.5em 0 0; display: none;'
+			);
+		$registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
+		$registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl');
+		$registrations_to_apply_payment_to .= EEH_HTML::thead(
+			EEH_HTML::tr(
+				EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
+				EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
+				EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
+			)
+		);
+		$registrations_to_apply_payment_to .= EEH_HTML::tbody();
+		// get registrations for TXN
+		$registrations = $this->_transaction->registrations($query_params);
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				$attendee_name = $registration->attendee() instanceof EE_Attendee
+					? $registration->attendee()->full_name()
+					: esc_html__('Unknown Attendee', 'event_espresso');
+				$owing         = $registration->final_price() - $registration->paid();
+				$taxable       = $registration->ticket()->taxable()
+					? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
+					: '';
+				$checked       = empty($existing_reg_payments) || in_array($registration->ID(), $existing_reg_payments)
+					? ' checked="checked"'
+					: '';
+				$disabled      = $registration->final_price() > 0 ? '' : ' disabled';
+				$registrations_to_apply_payment_to .= EEH_HTML::tr(
+					EEH_HTML::td($registration->ID()) .
+					EEH_HTML::td($attendee_name) .
+					EEH_HTML::td(
+						$registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
+					) .
+					EEH_HTML::td($registration->event_name()) .
+					EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
+					EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr') .
+					EEH_HTML::td(
+						'<input type="checkbox" value="' . $registration->ID()
+						. '" name="txn_admin_payment[registrations]"'
+						. $checked . $disabled . '>',
+						'', 'jst-cntr'
+					),
+					'apply-payment-registration-row-' . $registration->ID()
+				);
+			}
+		}
+		$registrations_to_apply_payment_to .= EEH_HTML::tbodyx();
+		$registrations_to_apply_payment_to .= EEH_HTML::tablex();
+		$registrations_to_apply_payment_to .= EEH_HTML::divx();
+		$registrations_to_apply_payment_to .= EEH_HTML::p(
+			esc_html__(
+				'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.',
+				'event_espresso'
+			),
+			'', 'clear description'
+		);
+		$registrations_to_apply_payment_to .= EEH_HTML::divx();
+		$this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to;
+	}
+
+
+	/**
+	 * _get_reg_status_selection
+	 *
+	 * @todo   this will need to be adjusted either once MER comes along OR we move default reg status to tickets
+	 *         instead of events.
+	 * @access protected
+	 * @return void
+	 */
+	protected function _get_reg_status_selection()
+	{
+		//first get all possible statuses
+		$statuses = EEM_Registration::reg_status_array(array(), true);
+		//let's add a "don't change" option.
+		$status_array['NAN']                                 = esc_html__('Leave the Same', 'event_espresso');
+		$status_array                                        = array_merge($status_array, $statuses);
+		$this->_template_args['status_change_select']        = EEH_Form_Fields::select_input('txn_reg_status_change[reg_status]',
+			$status_array, 'NAN', 'id="txn-admin-payment-reg-status-inp"', 'txn-reg-status-change-reg-status');
+		$this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input('delete_txn_reg_status_change[reg_status]',
+			$status_array, 'NAN', 'delete-txn-admin-payment-reg-status-inp', 'delete-txn-reg-status-change-reg-status');
+
+	}
+
+
+	/**
+	 *    _get_payment_methods
+	 * Gets all the payment methods available generally, or the ones that are already
+	 * selected on these payments (in case their payment methods are no longer active).
+	 * Has the side-effect of updating the template args' payment_methods item
+	 * @access private
+	 *
+	 * @param EE_Payment[] to show on this page
+	 *
+	 * @return void
+	 */
+	private function _get_payment_methods($payments = array())
+	{
+		$payment_methods_of_payments = array();
+		foreach ($payments as $payment) {
+			if ($payment instanceof EE_Payment) {
+				$payment_methods_of_payments[] = $payment->get('PMD_ID');
+			}
+		}
+		if ($payment_methods_of_payments) {
+			$query_args = array(
+				array(
+					'OR*payment_method_for_payment' => array(
+						'PMD_ID'    => array('IN', $payment_methods_of_payments),
+						'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%')
+					)
+				)
+			);
+		} else {
+			$query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%')));
+		}
+		$this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
+	}
+
+
+	/**
+	 * txn_attendees_meta_box
+	 *    generates HTML for the Attendees Transaction main meta box
+	 *
+	 * @access public
+	 *
+	 * @param WP_Post $post
+	 * @param array   $metabox
+	 *
+	 * @return void
+	 */
+	public function txn_attendees_meta_box($post, $metabox = array('args' => array()))
+	{
+
+		extract($metabox['args']);
+		$this->_template_args['post']            = $post;
+		$this->_template_args['event_attendees'] = array();
+		// process items in cart
+		$line_items = $this->_transaction->get_many_related('Line_Item', array(array('LIN_type' => 'line-item')));
+		if ( ! empty($line_items)) {
+			foreach ($line_items as $item) {
+				if ($item instanceof EE_Line_Item) {
+					switch ($item->OBJ_type()) {
+
+						case 'Event' :
+							break;
+
+						case 'Ticket' :
+							$ticket = $item->ticket();
+							//right now we're only handling tickets here.  Cause its expected that only tickets will have attendees right?
+							if ( ! $ticket instanceof EE_Ticket) {
+								continue;
+							}
+							try {
+								$event_name = $ticket->get_event_name();
+							} catch (Exception $e) {
+								EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+								$event_name = esc_html__('Unknown Event', 'event_espresso');
+							}
+							$event_name .= ' - ' . $item->get('LIN_name');
+							$ticket_price = EEH_Template::format_currency($item->get('LIN_unit_price'));
+							// now get all of the registrations for this transaction that use this ticket
+							$registrations = $ticket->get_many_related('Registration',
+								array(array('TXN_ID' => $this->_transaction->ID())));
+							foreach ($registrations as $registration) {
+								if ( ! $registration instanceof EE_Registration) {
+									continue;
+								}
+								$this->_template_args['event_attendees'][$registration->ID()]['STS_ID']            = $registration->status_ID();
+								$this->_template_args['event_attendees'][$registration->ID()]['att_num']           = $registration->count();
+								$this->_template_args['event_attendees'][$registration->ID()]['event_ticket_name'] = $event_name;
+								$this->_template_args['event_attendees'][$registration->ID()]['ticket_price']      = $ticket_price;
+								// attendee info
+								$attendee = $registration->get_first_related('Attendee');
+								if ($attendee instanceof EE_Attendee) {
+									$this->_template_args['event_attendees'][$registration->ID()]['att_id']   = $attendee->ID();
+									$this->_template_args['event_attendees'][$registration->ID()]['attendee'] = $attendee->full_name();
+									$this->_template_args['event_attendees'][$registration->ID()]['email']    = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name . esc_html__(' Event',
+											'event_espresso') . '">' . $attendee->email() . '</a>';
+									$this->_template_args['event_attendees'][$registration->ID()]['address']  = EEH_Address::format($attendee,
+										'inline', false, false);
+								} else {
+									$this->_template_args['event_attendees'][$registration->ID()]['att_id']   = '';
+									$this->_template_args['event_attendees'][$registration->ID()]['attendee'] = '';
+									$this->_template_args['event_attendees'][$registration->ID()]['email']    = '';
+									$this->_template_args['event_attendees'][$registration->ID()]['address']  = '';
+								}
+							}
+							break;
+
+					}
+				}
+			}
+
+			$this->_template_args['transaction_form_url'] = add_query_arg(array(
+				'action'  => 'edit_transaction',
+				'process' => 'attendees'
+			), TXN_ADMIN_URL);
+			echo EEH_Template::display_template(TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
+				$this->_template_args, true);
+
+		} else {
+			echo sprintf(
+				esc_html__('%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s',
+					'event_espresso'),
+				'<p class="important-notice">',
+				'</p>'
+			);
+		}
+	}
+
+
+	/**
+	 * txn_registrant_side_meta_box
+	 * generates HTML for the Edit Transaction side meta box
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 * @return void
+	 */
+	public function txn_registrant_side_meta_box()
+	{
+		$primary_att = $this->_transaction->primary_registration() instanceof EE_Registration ? $this->_transaction->primary_registration()->get_first_related('Attendee') : null;
+		if ( ! $primary_att instanceof EE_Attendee) {
+			$this->_template_args['no_attendee_message'] = esc_html__('There is no attached contact for this transaction.  The transaction either failed due to an error or was abandoned.',
+				'event_espresso');
+			$primary_att                                 = EEM_Attendee::instance()->create_default_object();
+		}
+		$this->_template_args['ATT_ID']            = $primary_att->ID();
+		$this->_template_args['prime_reg_fname']   = $primary_att->fname();
+		$this->_template_args['prime_reg_lname']   = $primary_att->lname();
+		$this->_template_args['prime_reg_email']   = $primary_att->email();
+		$this->_template_args['prime_reg_phone']   = $primary_att->phone();
+		$this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action' => 'edit_attendee',
+			'post'   => $primary_att->ID()
+		), REG_ADMIN_URL);
+		// get formatted address for registrant
+		$this->_template_args['formatted_address'] = EEH_Address::format($primary_att);
+		echo EEH_Template::display_template(TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
+			$this->_template_args, true);
+	}
+
+
+	/**
+	 * txn_billing_info_side_meta_box
+	 *    generates HTML for the Edit Transaction side meta box
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function txn_billing_info_side_meta_box()
+	{
+
+		$this->_template_args['billing_form']     = $this->_transaction->billing_info();
+		$this->_template_args['billing_form_url'] = add_query_arg(
+			array('action' => 'edit_transaction', 'process' => 'billing'),
+			TXN_ADMIN_URL
+		);
+
+		$template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);/**/
+	}
+
+
+	/**
+	 * apply_payments_or_refunds
+	 *    registers a payment or refund made towards a transaction
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function apply_payments_or_refunds()
+	{
+		$json_response_data = array('return_data' => false);
+		$valid_data         = $this->_validate_payment_request_data();
+		if ( ! empty($valid_data)) {
+			$PAY_ID = $valid_data['PAY_ID'];
+			//save  the new payment
+			$payment = $this->_create_payment_from_request_data($valid_data);
+			// get the TXN for this payment
+			$transaction = $payment->transaction();
+			// verify transaction
+			if ($transaction instanceof EE_Transaction) {
+				// calculate_total_payments_and_update_status
+				$this->_process_transaction_payments($transaction);
+				$REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment);
+				$this->_remove_existing_registration_payments($payment, $PAY_ID);
+				// apply payment to registrations (if applicable)
+				if ( ! empty($REG_IDs)) {
+					$this->_update_registration_payments($transaction, $payment, $REG_IDs);
+					$this->_maybe_send_notifications();
+					// now process status changes for the same registrations
+					$this->_process_registration_status_change($transaction, $REG_IDs);
+				}
+				$this->_maybe_send_notifications($payment);
+				//prepare to render page
+				$json_response_data['return_data'] = $this->_build_payment_json_response($payment, $REG_IDs);
+				do_action('AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording', $transaction,
+					$payment);
+			} else {
+				EE_Error::add_error(
+					esc_html__('A valid Transaction for this payment could not be retrieved.', 'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+			}
+		} else {
+			EE_Error::add_error(esc_html__('The payment form data could not be processed. Please try again.',
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+		}
+
+		$notices              = EE_Error::get_notices(false, false, false);
+		$this->_template_args = array(
+			'data'    => $json_response_data,
+			'error'   => $notices['errors'],
+			'success' => $notices['success']
+		);
+		$this->_return_json();
+	}
+
+
+	/**
+	 * _validate_payment_request_data
+	 *
+	 * @return array
+	 */
+	protected function _validate_payment_request_data()
+	{
+		if ( ! isset($this->_req_data['txn_admin_payment'])) {
+			return false;
+		}
+		$payment_form = $this->_generate_payment_form_section();
+		try {
+			if ($payment_form->was_submitted()) {
+				$payment_form->receive_form_submission();
+				if ( ! $payment_form->is_valid()) {
+					$submission_error_messages = array();
+					foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) {
+						if ($validation_error instanceof EE_Validation_Error) {
+							$submission_error_messages[] = sprintf(
+								_x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'),
+								$validation_error->get_form_section()->html_label_text(),
+								$validation_error->getMessage()
+							);
+						}
+					}
+					EE_Error::add_error(join('<br />', $submission_error_messages), __FILE__, __FUNCTION__, __LINE__);
+
+					return array();
+				}
+			}
+		} catch (EE_Error $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+
+			return array();
+		}
+
+		return $payment_form->valid_data();
+	}
+
+
+	/**
+	 * _generate_payment_form_section
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	protected function _generate_payment_form_section()
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'name'        => 'txn_admin_payment',
+				'subsections' => array(
+					'PAY_ID'          => new EE_Text_Input(
+						array(
+							'default'               => 0,
+							'required'              => false,
+							'html_label_text'       => esc_html__('Payment ID', 'event_espresso'),
+							'validation_strategies' => array(new EE_Int_Normalization())
+						)
+					),
+					'TXN_ID'          => new EE_Text_Input(
+						array(
+							'default'               => 0,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Transaction ID', 'event_espresso'),
+							'validation_strategies' => array(new EE_Int_Normalization())
+						)
+					),
+					'type'            => new EE_Text_Input(
+						array(
+							'default'               => 1,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment or Refund', 'event_espresso'),
+							'validation_strategies' => array(new EE_Int_Normalization())
+						)
+					),
+					'amount'          => new EE_Text_Input(
+						array(
+							'default'               => 0,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment amount', 'event_espresso'),
+							'validation_strategies' => array(new EE_Float_Normalization())
+						)
+					),
+					'status'          => new EE_Text_Input(
+						array(
+							'default'         => EEM_Payment::status_id_approved,
+							'required'        => true,
+							'html_label_text' => esc_html__('Payment status', 'event_espresso'),
+						)
+					),
+					'PMD_ID'          => new EE_Text_Input(
+						array(
+							'default'               => 2,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment Method', 'event_espresso'),
+							'validation_strategies' => array(new EE_Int_Normalization())
+						)
+					),
+					'date'            => new EE_Text_Input(
+						array(
+							'default'         => time(),
+							'required'        => true,
+							'html_label_text' => esc_html__('Payment date', 'event_espresso'),
+						)
+					),
+					'txn_id_chq_nmbr' => new EE_Text_Input(
+						array(
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Transaction or Cheque Number', 'event_espresso'),
+							'validation_strategies' => array(
+								new EE_Max_Length_Validation_Strategy(esc_html__('Input too long', 'event_espresso'),
+									100),
+							)
+						)
+					),
+					'po_number'       => new EE_Text_Input(
+						array(
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Purchase Order Number', 'event_espresso'),
+							'validation_strategies' => array(
+								new EE_Max_Length_Validation_Strategy(esc_html__('Input too long', 'event_espresso'),
+									100),
+							)
+						)
+					),
+					'accounting'      => new EE_Text_Input(
+						array(
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Extra Field for Accounting', 'event_espresso'),
+							'validation_strategies' => array(
+								new EE_Max_Length_Validation_Strategy(esc_html__('Input too long', 'event_espresso'),
+									100),
+							)
+						)
+					),
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _create_payment_from_request_data
+	 *
+	 * @param array $valid_data
+	 *
+	 * @return EE_Payment
+	 */
+	protected function _create_payment_from_request_data($valid_data)
+	{
+		$PAY_ID = $valid_data['PAY_ID'];
+		// get payment amount
+		$amount = $valid_data['amount'] ? abs($valid_data['amount']) : 0;
+		// payments have a type value of 1 and refunds have a type value of -1
+		// so multiplying amount by type will give a positive value for payments, and negative values for refunds
+		$amount = $valid_data['type'] < 0 ? $amount * -1 : $amount;
+		// for some reason the date string coming in has extra spaces between the date and time.  This fixes that.
+		$date    = $valid_data['date'] ? preg_replace('/\s+/', ' ', $valid_data['date']) : date('Y-m-d g:i a',
+			current_time('timestamp'));
+		$payment = EE_Payment::new_instance(
+			array(
+				'TXN_ID'              => $valid_data['TXN_ID'],
+				'STS_ID'              => $valid_data['status'],
+				'PAY_timestamp'       => $date,
+				'PAY_source'          => EEM_Payment_Method::scope_admin,
+				'PMD_ID'              => $valid_data['PMD_ID'],
+				'PAY_amount'          => $amount,
+				'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'],
+				'PAY_po_number'       => $valid_data['po_number'],
+				'PAY_extra_accntng'   => $valid_data['accounting'],
+				'PAY_details'         => $valid_data,
+				'PAY_ID'              => $PAY_ID
+			),
+			'',
+			array('Y-m-d', 'g:i a')
+		);
+
+		if ( ! $payment->save()) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'),
+					$payment->ID()
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+
+		return $payment;
+	}
+
+
+	/**
+	 * _process_transaction_payments
+	 *
+	 * @param \EE_Transaction $transaction
+	 *
+	 * @return array
+	 */
+	protected function _process_transaction_payments(EE_Transaction $transaction)
+	{
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+		//update the transaction with this payment
+		if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) {
+			EE_Error::add_success(esc_html__('The payment has been processed successfully.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__);
+		} else {
+			EE_Error::add_error(
+				esc_html__('The payment was processed successfully but the amount paid for the transaction was not updated.',
+					'event_espresso')
+				, __FILE__, __FUNCTION__, __LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * _get_REG_IDs_to_apply_payment_to
+	 *
+	 * returns a list of registration IDs that the payment will apply to
+	 *
+	 * @param \EE_Payment $payment
+	 *
+	 * @return array
+	 */
+	protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment)
+	{
+		$REG_IDs = array();
+		// grab array of IDs for specific registrations to apply changes to
+		if (isset($this->_req_data['txn_admin_payment']['registrations'])) {
+			$REG_IDs = (array)$this->_req_data['txn_admin_payment']['registrations'];
+		}
+		//nothing specified ? then get all reg IDs
+		if (empty($REG_IDs)) {
+			$registrations = $payment->transaction()->registrations();
+			$REG_IDs       = ! empty($registrations) ? array_keys($registrations) : $this->_get_existing_reg_payment_REG_IDs($payment);
+		}
+
+		// ensure that REG_IDs are integers and NOT strings
+		return array_map('intval', $REG_IDs);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function existing_reg_payment_REG_IDs()
+	{
+		return $this->_existing_reg_payment_REG_IDs;
+	}
+
+
+	/**
+	 * @param array $existing_reg_payment_REG_IDs
+	 */
+	public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null)
+	{
+		$this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs;
+	}
+
+
+	/**
+	 * _get_existing_reg_payment_REG_IDs
+	 *
+	 * returns a list of registration IDs that the payment is currently related to
+	 * as recorded in the database
+	 *
+	 * @param \EE_Payment $payment
+	 *
+	 * @return array
+	 */
+	protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment)
+	{
+		if ($this->existing_reg_payment_REG_IDs() === null) {
+			// let's get any existing reg payment records for this payment
+			$existing_reg_payment_REG_IDs = $payment->get_many_related('Registration');
+			// but we only want the REG IDs, so grab the array keys
+			$existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs) ? array_keys($existing_reg_payment_REG_IDs) : array();
+			$this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs);
+		}
+
+		return $this->existing_reg_payment_REG_IDs();
+	}
+
+
+	/**
+	 * _remove_existing_registration_payments
+	 *
+	 * this calculates the difference between existing relations
+	 * to the supplied payment and the new list registration IDs,
+	 * removes any related registrations that no longer apply,
+	 * and then updates the registration paid fields
+	 *
+	 * @param \EE_Payment $payment
+	 * @param int         $PAY_ID
+	 *
+	 * @return bool;
+	 */
+	protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0)
+	{
+		// newly created payments will have nothing recorded for $PAY_ID
+		if ($PAY_ID == 0) {
+			return false;
+		}
+		$existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
+		if (empty($existing_reg_payment_REG_IDs)) {
+			return false;
+		}
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+
+		return $transaction_payments->delete_registration_payments_and_update_registrations(
+			$payment,
+			array(
+				array(
+					'PAY_ID' => $payment->ID(),
+					'REG_ID' => array('IN', $existing_reg_payment_REG_IDs),
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _update_registration_payments
+	 *
+	 * this applies the payments to the selected registrations
+	 * but only if they have not already been paid for
+	 *
+	 * @param  EE_Transaction $transaction
+	 * @param \EE_Payment     $payment
+	 * @param array           $REG_IDs
+	 *
+	 * @return bool
+	 */
+	protected function _update_registration_payments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		$REG_IDs = array()
+	) {
+		// we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments()
+		// so let's do that using our set of REG_IDs from the form
+		$registration_query_where_params = array(
+			'REG_ID' => array('IN', $REG_IDs)
+		);
+		// but add in some conditions regarding payment,
+		// so that we don't apply payments to registrations that are free or have already been paid for
+		// but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative )
+		if ( ! $payment->is_a_refund()) {
+			$registration_query_where_params['REG_final_price']  = array('!=', 0);
+			$registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true);
+		}
+		//EEH_Debug_Tools::printr( $registration_query_where_params, '$registration_query_where_params', __FILE__, __LINE__ );
+		$registrations = $transaction->registrations(array($registration_query_where_params));
+		if ( ! empty($registrations)) {
+			/** @type EE_Payment_Processor $payment_processor */
+			$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+			$payment_processor->process_registration_payments($transaction, $payment, $registrations);
+		}
+	}
+
+
+	/**
+	 * _process_registration_status_change
+	 *
+	 * This processes requested registration status changes for all the registrations
+	 * on a given transaction and (optionally) sends out notifications for the changes.
+	 *
+	 * @param  EE_Transaction $transaction
+	 * @param array           $REG_IDs
+	 *
+	 * @return bool
+	 */
+	protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = array())
+	{
+		// first if there is no change in status then we get out.
+		if (
+			! isset($this->_req_data['txn_reg_status_change'], $this->_req_data['txn_reg_status_change']['reg_status'])
+			|| $this->_req_data['txn_reg_status_change']['reg_status'] == 'NAN'
+		) {
+			//no error message, no change requested, just nothing to do man.
+			return false;
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+
+		// made it here dude?  Oh WOW.  K, let's take care of changing the statuses
+		return $transaction_processor->manually_update_registration_statuses(
+			$transaction,
+			sanitize_text_field($this->_req_data['txn_reg_status_change']['reg_status']),
+			array(array('REG_ID' => array('IN', $REG_IDs)))
+		);
+	}
+
+
+	/**
+	 * _build_payment_json_response
+	 *
+	 * @access public
+	 *
+	 * @param \EE_Payment $payment
+	 * @param array       $REG_IDs
+	 * @param bool | null $delete_txn_reg_status_change
+	 *
+	 * @return array
+	 */
+	protected function _build_payment_json_response(
+		EE_Payment $payment,
+		$REG_IDs = array(),
+		$delete_txn_reg_status_change = null
+	) {
+		// was the payment deleted ?
+		if (is_bool($delete_txn_reg_status_change)) {
+			return array(
+				'PAY_ID'                       => $payment->ID(),
+				'amount'                       => $payment->amount(),
+				'total_paid'                   => $payment->transaction()->paid(),
+				'txn_status'                   => $payment->transaction()->status_ID(),
+				'pay_status'                   => $payment->STS_ID(),
+				'registrations'                => $this->_registration_payment_data_array($REG_IDs),
+				'delete_txn_reg_status_change' => $delete_txn_reg_status_change,
+			);
+		} else {
+			$this->_get_payment_status_array();
+
+			return array(
+				'amount'           => $payment->amount(),
+				'total_paid'       => $payment->transaction()->paid(),
+				'txn_status'       => $payment->transaction()->status_ID(),
+				'pay_status'       => $payment->STS_ID(),
+				'PAY_ID'           => $payment->ID(),
+				'STS_ID'           => $payment->STS_ID(),
+				'status'           => self::$_pay_status[$payment->STS_ID()],
+				'date'             => $payment->timestamp('Y-m-d', 'h:i a'),
+				'method'           => strtoupper($payment->source()),
+				'PM_ID'            => $payment->payment_method() ? $payment->payment_method()->ID() : 1,
+				'gateway'          => $payment->payment_method() ? $payment->payment_method()->admin_name() : esc_html__("Unknown",
+					'event_espresso'),
+				'gateway_response' => $payment->gateway_response(),
+				'txn_id_chq_nmbr'  => $payment->txn_id_chq_nmbr(),
+				'po_number'        => $payment->po_number(),
+				'extra_accntng'    => $payment->extra_accntng(),
+				'registrations'    => $this->_registration_payment_data_array($REG_IDs),
+			);
+		}
+	}
+
+
+	/**
+	 * delete_payment
+	 *    delete a payment or refund made towards a transaction
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function delete_payment()
+	{
+		$json_response_data = array('return_data' => false);
+		$PAY_ID             = isset($this->_req_data['delete_txn_admin_payment'], $this->_req_data['delete_txn_admin_payment']['PAY_ID']) ? absint($this->_req_data['delete_txn_admin_payment']['PAY_ID']) : 0;
+		if ($PAY_ID) {
+			$delete_txn_reg_status_change = isset($this->_req_data['delete_txn_reg_status_change']) ? $this->_req_data['delete_txn_reg_status_change'] : false;
+			$payment                      = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
+			if ($payment instanceof EE_Payment) {
+				$REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				if ($transaction_payments->delete_payment_and_update_transaction($payment)) {
+					$json_response_data['return_data'] = $this->_build_payment_json_response($payment, $REG_IDs,
+						$delete_txn_reg_status_change);
+					if ($delete_txn_reg_status_change) {
+						$this->_req_data['txn_reg_status_change'] = $delete_txn_reg_status_change;
+						//MAKE sure we also add the delete_txn_req_status_change to the
+						//$_REQUEST global because that's how messages will be looking for it.
+						$_REQUEST['txn_reg_status_change'] = $delete_txn_reg_status_change;
+						$this->_maybe_send_notifications();
+						$this->_process_registration_status_change($payment->transaction(), $REG_IDs);
+					}
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__('A valid Payment ID was not received, therefore payment form data could not be loaded.',
+					'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		$notices              = EE_Error::get_notices(false, false, false);
+		$this->_template_args = array(
+			'data'      => $json_response_data,
+			'success'   => $notices['success'],
+			'error'     => $notices['errors'],
+			'attention' => $notices['attention']
+		);
+		$this->_return_json();
+	}
+
+
+	/**
+	 * _registration_payment_data_array
+	 * adds info for 'owing' and 'paid' for each registration to the json response
+	 *
+	 * @access protected
+	 *
+	 * @param array $REG_IDs
+	 *
+	 * @return array
+	 */
+	protected function _registration_payment_data_array($REG_IDs)
+	{
+		$registration_payment_data = array();
+		//if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows.
+		if ( ! empty($REG_IDs)) {
+			$registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs))));
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration) {
+					$registration_payment_data[$registration->ID()] = array(
+						'paid'  => $registration->pretty_paid(),
+						'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()),
+					);
+				}
+			}
+		}
+
+		return $registration_payment_data;
+	}
+
+
+	/**
+	 * _maybe_send_notifications
+	 *
+	 * determines whether or not the admin has indicated that notifications should be sent.
+	 * If so, will toggle a filter switch for delivering registration notices.
+	 * If passed an EE_Payment object, then it will trigger payment notifications instead.
+	 *
+	 * @access protected
+	 *
+	 * @param \EE_Payment | null $payment
+	 */
+	protected function _maybe_send_notifications($payment = null)
+	{
+		switch ($payment instanceof EE_Payment) {
+			// payment notifications
+			case true :
+				if (
+					isset(
+						$this->_req_data['txn_payments'],
+						$this->_req_data['txn_payments']['send_notifications']
+					) &&
+					filter_var($this->_req_data['txn_payments']['send_notifications'], FILTER_VALIDATE_BOOLEAN)
+				) {
+					$this->_process_payment_notification($payment);
+				}
+				break;
+			// registration notifications
+			case false :
+				if (
+					isset(
+						$this->_req_data['txn_reg_status_change'],
+						$this->_req_data['txn_reg_status_change']['send_notifications']
+					) &&
+					filter_var($this->_req_data['txn_reg_status_change']['send_notifications'], FILTER_VALIDATE_BOOLEAN)
+				) {
+					add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+				}
+				break;
+		}
+	}
+
+
+	/**
+	 * _send_payment_reminder
+	 *    generates HTML for the View Transaction Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _send_payment_reminder()
+	{
+		$TXN_ID      = ( ! empty($this->_req_data['TXN_ID'])) ? absint($this->_req_data['TXN_ID']) : false;
+		$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+		$query_args  = isset($this->_req_data['redirect_to']) ? array(
+			'action' => $this->_req_data['redirect_to'],
+			'TXN_ID' => $this->_req_data['TXN_ID']
+		) : array();
+		do_action('AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
+			$transaction);
+		$this->_redirect_after_action(false, esc_html__('payment reminder', 'event_espresso'),
+			esc_html__('sent', 'event_espresso'), $query_args, true);
+	}
+
+
+	/**
+	 *  get_transactions
+	 *    get transactions for given parameters (used by list table)
+	 *
+	 * @param  int     $perpage how many transactions displayed per page
+	 * @param  boolean $count   return the count or objects
+	 * @param string   $view
+	 *
+	 * @return mixed int = count || array of transaction objects
+	 */
+	public function get_transactions($perpage, $count = false, $view = '')
+	{
+
+		$TXN = EEM_Transaction::instance();
+
+		$start_date = isset($this->_req_data['txn-filter-start-date']) ? wp_strip_all_tags($this->_req_data['txn-filter-start-date']) : date('m/d/Y',
+			strtotime('-10 year'));
+		$end_date   = isset($this->_req_data['txn-filter-end-date']) ? wp_strip_all_tags($this->_req_data['txn-filter-end-date']) : date('m/d/Y');
+
+		//make sure our timestamps start and end right at the boundaries for each day
+		$start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
+		$end_date   = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+
+
+		//convert to timestamps
+		$start_date = strtotime($start_date);
+		$end_date   = strtotime($end_date);
+
+		//makes sure start date is the lowest value and vice versa
+		$start_date = min($start_date, $end_date);
+		$end_date   = max($start_date, $end_date);
+
+		//convert to correct format for query
+		$start_date = EEM_Transaction::instance()->convert_datetime_for_query('TXN_timestamp',
+			date('Y-m-d H:i:s', $start_date), 'Y-m-d H:i:s');
+		$end_date   = EEM_Transaction::instance()->convert_datetime_for_query('TXN_timestamp',
+			date('Y-m-d H:i:s', $end_date), 'Y-m-d H:i:s');
+
+
+		//set orderby
+		$this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
+
+		switch ($this->_req_data['orderby']) {
+			case 'TXN_ID':
+				$orderby = 'TXN_ID';
+				break;
+			case 'ATT_fname':
+				$orderby = 'Registration.Attendee.ATT_fname';
+				break;
+			case 'event_name':
+				$orderby = 'Registration.Event.EVT_name';
+				break;
+			default: //'TXN_timestamp'
+				$orderby = 'TXN_timestamp';
+		}
+
+		$sort         = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'DESC';
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1;
+		$per_page     = isset($perpage) && ! empty($perpage) ? $perpage : 10;
+		$per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $per_page;
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = array($offset, $per_page);
+
+		$_where = array(
+			'TXN_timestamp'          => array('BETWEEN', array($start_date, $end_date)),
+			'Registration.REG_count' => 1
+		);
+
+		if (isset($this->_req_data['EVT_ID'])) {
+			$_where['Registration.EVT_ID'] = $this->_req_data['EVT_ID'];
+		}
+
+		if (isset($this->_req_data['s'])) {
+			$search_string = '%' . $this->_req_data['s'] . '%';
+			$_where['OR']  = array(
+				'Registration.Event.EVT_name'         => array('LIKE', $search_string),
+				'Registration.Event.EVT_desc'         => array('LIKE', $search_string),
+				'Registration.Event.EVT_short_desc'   => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_full_name' => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_fname'     => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_lname'     => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_short_bio' => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_email'     => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_address'   => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_address2'  => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_city'      => array('LIKE', $search_string),
+				'Registration.REG_final_price'        => array('LIKE', $search_string),
+				'Registration.REG_code'               => array('LIKE', $search_string),
+				'Registration.REG_count'              => array('LIKE', $search_string),
+				'Registration.REG_group_size'         => array('LIKE', $search_string),
+				'Registration.Ticket.TKT_name'        => array('LIKE', $search_string),
+				'Registration.Ticket.TKT_description' => array('LIKE', $search_string),
+				'Payment.PAY_source'                  => array('LIKE', $search_string),
+				'Payment.Payment_Method.PMD_name'     => array('LIKE', $search_string),
+				'TXN_session_data'                    => array('LIKE', $search_string),
+				'Payment.PAY_txn_id_chq_nmbr'         => array('LIKE', $search_string)
+			);
+		}
+
+		//failed transactions
+		$failed    = ( ! empty($this->_req_data['status']) && $this->_req_data['status'] == 'failed' && ! $count) || ($count && $view == 'failed') ? true : false;
+		$abandoned = ( ! empty($this->_req_data['status']) && $this->_req_data['status'] == 'abandoned' && ! $count) || ($count && $view == 'abandoned') ? true : false;
+
+		if ($failed) {
+			$_where['STS_ID'] = EEM_Transaction::failed_status_code;
+		} else if ($abandoned) {
+			$_where['STS_ID'] = EEM_Transaction::abandoned_status_code;
+		} else {
+			$_where['STS_ID']  = array('!=', EEM_Transaction::failed_status_code);
+			$_where['STS_ID*'] = array('!=', EEM_Transaction::abandoned_status_code);
+		}
+
+		$query_params = array($_where, 'order_by' => array($orderby => $sort), 'limit' => $limit);
+
+		$transactions = $count ? $TXN->count(array($_where), 'TXN_ID', true) : $TXN->get_all($query_params);
+
+
+		return $transactions;
+
+	}
 
 
 }

Spacing +61 added lines, -61 removed lines

@@ -338,11 +338,11 @@ 
     public function load_scripts_styles()
     {
         //enqueue style
-        wp_register_style('espresso_txn', TXN_ASSETS_URL . 'espresso_transactions_admin.css', array(),
+        wp_register_style('espresso_txn', TXN_ASSETS_URL.'espresso_transactions_admin.css', array(),
             EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('espresso_txn');
         //scripts
-        wp_register_script('espresso_txn', TXN_ASSETS_URL . 'espresso_transactions_admin.js', array(
+        wp_register_script('espresso_txn', TXN_ASSETS_URL.'espresso_transactions_admin.js', array(
             'ee_admin_js',
             'ee-datepicker',
             'jquery-ui-datepicker',
@@ -434,7 +434,7 @@ 
 
         if (empty($this->_transaction)) {
             $error_msg = esc_html__('An error occurred and the details for Transaction ID #',
-                    'event_espresso') . $TXN_ID . esc_html__(' could not be retrieved.', 'event_espresso');
+                    'event_espresso').$TXN_ID.esc_html__(' could not be retrieved.', 'event_espresso');
             EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
         }
     }
@@ -509,23 +509,23 @@ 
             'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
             array(
                 'overpaid'   => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::overpaid_status_code,
                     'desc'  => EEH_Template::pretty_status(EEM_Transaction::overpaid_status_code, false, 'sentence')
                 ),
                 'complete'   => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::complete_status_code,
                     'desc'  => EEH_Template::pretty_status(EEM_Transaction::complete_status_code, false, 'sentence')
                 ),
                 'incomplete' => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::incomplete_status_code,
                     'desc'  => EEH_Template::pretty_status(EEM_Transaction::incomplete_status_code, false, 'sentence')
                 ),
                 'abandoned'  => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::abandoned_status_code,
                     'desc'  => EEH_Template::pretty_status(EEM_Transaction::abandoned_status_code, false, 'sentence')
                 ),
                 'failed'     => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::failed_status_code,
                     'desc'  => EEH_Template::pretty_status(EEM_Transaction::failed_status_code, false, 'sentence')
                 )
             )
@@ -547,10 +547,10 @@ 
         $event                                     = isset($this->_req_data['EVT_ID']) ? EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']) : null;
         $this->_template_args['admin_page_header'] = $event instanceof EE_Event ? sprintf(esc_html__('%sViewing Transactions for the Event: %s%s',
             'event_espresso'), '<h3>',
-            '<a href="' . EE_Admin_Page::add_query_args_and_nonce(array('action' => 'edit', 'post' => $event->ID()),
-                EVENTS_ADMIN_URL) . '" title="' . esc_attr__('Click to Edit event',
-                'event_espresso') . '">' . $event->get('EVT_name') . '</a>', '</h3>') : '';
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_transaction_legend_items());
+            '<a href="'.EE_Admin_Page::add_query_args_and_nonce(array('action' => 'edit', 'post' => $event->ID()),
+                EVENTS_ADMIN_URL).'" title="'.esc_attr__('Click to Edit event',
+                'event_espresso').'">'.$event->get('EVT_name').'</a>', '</h3>') : '';
+        $this->_template_args['after_list_table'] = $this->_display_legend($this->_transaction_legend_items());
         $this->display_admin_list_table_page_with_no_sidebar();
     }
 
@@ -584,7 +584,7 @@ 
 
         $this->_template_args['txn_status']['value'] = self::$_txn_status[$this->_transaction->get('STS_ID')];
         $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
-        $this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->get('STS_ID');
+        $this->_template_args['txn_status']['class'] = 'status-'.$this->_transaction->get('STS_ID');
 
         $this->_template_args['grand_total'] = $this->_transaction->get('TXN_total');
         $this->_template_args['total_paid']  = $this->_transaction->get('TXN_paid');
@@ -621,9 +621,9 @@ 
         $amount_due                         = $this->_transaction->get('TXN_total') - $this->_transaction->get('TXN_paid');
         $this->_template_args['amount_due'] = EEH_Template::format_currency($amount_due, true);
         if (EE_Registry::instance()->CFG->currency->sign_b4) {
-            $this->_template_args['amount_due'] = EE_Registry::instance()->CFG->currency->sign . $this->_template_args['amount_due'];
+            $this->_template_args['amount_due'] = EE_Registry::instance()->CFG->currency->sign.$this->_template_args['amount_due'];
         } else {
-            $this->_template_args['amount_due'] = $this->_template_args['amount_due'] . EE_Registry::instance()->CFG->currency->sign;
+            $this->_template_args['amount_due'] = $this->_template_args['amount_due'].EE_Registry::instance()->CFG->currency->sign;
         }
         $this->_template_args['amount_due_class'] = '';
 
@@ -658,7 +658,7 @@ 
 
 
         // next link
-        $next_txn                                 = $this->_transaction->next(
+        $next_txn = $this->_transaction->next(
             null,
             array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
             'TXN_ID'
@@ -673,7 +673,7 @@ 
             )
             : '';
         // previous link
-        $previous_txn                                 = $this->_transaction->previous(
+        $previous_txn = $this->_transaction->previous(
             null,
             array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
             'TXN_ID'
@@ -727,7 +727,7 @@ 
         // grab messages at the last second
         $this->_template_args['notices'] = EE_Error::get_notices();
         // path to template
-        $template_path                             = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
+        $template_path                             = TXN_TEMPLATE_PATH.'txn_admin_details_header.template.php';
         $this->_template_args['admin_page_header'] = EEH_Template::display_template($template_path,
             $this->_template_args, true);
 
@@ -835,18 +835,18 @@ 
         $reg_steps = '<ul>';
         foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) {
             if ($reg_step_status === true) {
-                $reg_steps .= '<li style="color:#70cc50">' . sprintf(esc_html__('%1$s : Completed', 'event_espresso'),
-                        ucwords(str_replace('_', ' ', $reg_step))) . '</li>';
+                $reg_steps .= '<li style="color:#70cc50">'.sprintf(esc_html__('%1$s : Completed', 'event_espresso'),
+                        ucwords(str_replace('_', ' ', $reg_step))).'</li>';
             } else if (is_numeric($reg_step_status) && $reg_step_status !== false) {
-                $reg_steps .= '<li style="color:#2EA2CC">' . sprintf(
+                $reg_steps .= '<li style="color:#2EA2CC">'.sprintf(
                         esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
                         ucwords(str_replace('_', ' ', $reg_step)),
-                        date(get_option('date_format') . ' ' . get_option('time_format'),
+                        date(get_option('date_format').' '.get_option('time_format'),
                             ($reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS)))
-                    ) . '</li>';
+                    ).'</li>';
             } else {
-                $reg_steps .= '<li style="color:#E76700">' . sprintf(esc_html__('%1$s : Never Initiated',
-                        'event_espresso'), ucwords(str_replace('_', ' ', $reg_step))) . '</li>';
+                $reg_steps .= '<li style="color:#E76700">'.sprintf(esc_html__('%1$s : Never Initiated',
+                        'event_espresso'), ucwords(str_replace('_', ' ', $reg_step))).'</li>';
             }
         }
         $reg_steps .= '</ul>';
@@ -860,11 +860,11 @@ 
         $this->_get_payment_status_array();
         $this->_get_reg_status_selection(); //sets up the template args for the reg status array for the transaction.
 
-        $this->_template_args['transaction_form_url']    = add_query_arg(array(
+        $this->_template_args['transaction_form_url'] = add_query_arg(array(
             'action'  => 'edit_transaction',
             'process' => 'transaction'
         ), TXN_ADMIN_URL);
-        $this->_template_args['apply_payment_form_url']  = add_query_arg(array(
+        $this->_template_args['apply_payment_form_url'] = add_query_arg(array(
             'page'   => 'espresso_transactions',
             'action' => 'espresso_apply_payment'
         ), WP_AJAX_URL);
@@ -875,7 +875,7 @@ 
 
         // 'espresso_delete_payment_nonce'
 
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
+        $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_main_meta_box_txn_details.template.php';
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
 
     }
@@ -935,7 +935,7 @@ 
     protected function _get_registrations_to_apply_payment_to()
     {
         // we want any registration with an active status (ie: not deleted or cancelled)
-        $query_params                      = array(
+        $query_params = array(
             array(
                 'STS_ID' => array(
                     'IN',
@@ -947,19 +947,19 @@ 
                 )
             )
         );
-        $registrations_to_apply_payment_to = EEH_HTML::br() . EEH_HTML::div(
+        $registrations_to_apply_payment_to = EEH_HTML::br().EEH_HTML::div(
                 '', 'txn-admin-apply-payment-to-registrations-dv', '', 'clear: both; margin: 1.5em 0 0; display: none;'
             );
-        $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
+        $registrations_to_apply_payment_to .= EEH_HTML::br().EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
         $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl');
         $registrations_to_apply_payment_to .= EEH_HTML::thead(
             EEH_HTML::tr(
-                EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
+                EEH_HTML::th(esc_html__('ID', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Registrant', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Ticket', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Event', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr').
+                EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr').
                 EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
             )
         );
@@ -973,28 +973,28 @@ 
                     : esc_html__('Unknown Attendee', 'event_espresso');
                 $owing         = $registration->final_price() - $registration->paid();
                 $taxable       = $registration->ticket()->taxable()
-                    ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
+                    ? ' <span class="smaller-text lt-grey-text"> '.esc_html__('+ tax', 'event_espresso').'</span>'
                     : '';
                 $checked       = empty($existing_reg_payments) || in_array($registration->ID(), $existing_reg_payments)
                     ? ' checked="checked"'
                     : '';
                 $disabled      = $registration->final_price() > 0 ? '' : ' disabled';
                 $registrations_to_apply_payment_to .= EEH_HTML::tr(
-                    EEH_HTML::td($registration->ID()) .
-                    EEH_HTML::td($attendee_name) .
+                    EEH_HTML::td($registration->ID()).
+                    EEH_HTML::td($attendee_name).
                     EEH_HTML::td(
-                        $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
-                    ) .
-                    EEH_HTML::td($registration->event_name()) .
-                    EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
-                    EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr') .
+                        $registration->ticket()->name().' : '.$registration->ticket()->pretty_price().$taxable
+                    ).
+                    EEH_HTML::td($registration->event_name()).
+                    EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr').
+                    EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr').
                     EEH_HTML::td(
-                        '<input type="checkbox" value="' . $registration->ID()
+                        '<input type="checkbox" value="'.$registration->ID()
                         . '" name="txn_admin_payment[registrations]"'
-                        . $checked . $disabled . '>',
+                        . $checked.$disabled.'>',
                         '', 'jst-cntr'
                     ),
-                    'apply-payment-registration-row-' . $registration->ID()
+                    'apply-payment-registration-row-'.$registration->ID()
                 );
             }
         }
@@ -1060,12 +1060,12 @@ 
                 array(
                     'OR*payment_method_for_payment' => array(
                         'PMD_ID'    => array('IN', $payment_methods_of_payments),
-                        'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%')
+                        'PMD_scope' => array('LIKE', '%'.EEM_Payment_Method::scope_admin.'%')
                     )
                 )
             );
         } else {
-            $query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%')));
+            $query_args = array(array('PMD_scope' => array('LIKE', '%'.EEM_Payment_Method::scope_admin.'%')));
         }
         $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
     }
@@ -1110,7 +1110,7 @@ 
                                 EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
                                 $event_name = esc_html__('Unknown Event', 'event_espresso');
                             }
-                            $event_name .= ' - ' . $item->get('LIN_name');
+                            $event_name .= ' - '.$item->get('LIN_name');
                             $ticket_price = EEH_Template::format_currency($item->get('LIN_unit_price'));
                             // now get all of the registrations for this transaction that use this ticket
                             $registrations = $ticket->get_many_related('Registration',
@@ -1128,8 +1128,8 @@ 
                                 if ($attendee instanceof EE_Attendee) {
                                     $this->_template_args['event_attendees'][$registration->ID()]['att_id']   = $attendee->ID();
                                     $this->_template_args['event_attendees'][$registration->ID()]['attendee'] = $attendee->full_name();
-                                    $this->_template_args['event_attendees'][$registration->ID()]['email']    = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name . esc_html__(' Event',
-                                            'event_espresso') . '">' . $attendee->email() . '</a>';
+                                    $this->_template_args['event_attendees'][$registration->ID()]['email']    = '<a href="mailto:'.$attendee->email().'?subject='.$event_name.esc_html__(' Event',
+                                            'event_espresso').'">'.$attendee->email().'</a>';
                                     $this->_template_args['event_attendees'][$registration->ID()]['address']  = EEH_Address::format($attendee,
                                         'inline', false, false);
                                 } else {
@@ -1149,7 +1149,7 @@ 
                 'action'  => 'edit_transaction',
                 'process' => 'attendees'
             ), TXN_ADMIN_URL);
-            echo EEH_Template::display_template(TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
+            echo EEH_Template::display_template(TXN_TEMPLATE_PATH.'txn_admin_details_main_meta_box_attendees.template.php',
                 $this->_template_args, true);
 
         } else {
@@ -1190,7 +1190,7 @@ 
         ), REG_ADMIN_URL);
         // get formatted address for registrant
         $this->_template_args['formatted_address'] = EEH_Address::format($primary_att);
-        echo EEH_Template::display_template(TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
+        echo EEH_Template::display_template(TXN_TEMPLATE_PATH.'txn_admin_details_side_meta_box_registrant.template.php',
             $this->_template_args, true);
     }
 
@@ -1211,8 +1211,8 @@ 
             TXN_ADMIN_URL
         );
 
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);/**/
+        $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_side_meta_box_billing_info.template.php';
+        echo EEH_Template::display_template($template_path, $this->_template_args, true); /**/
     }
 
 
@@ -1505,7 +1505,7 @@ 
         $REG_IDs = array();
         // grab array of IDs for specific registrations to apply changes to
         if (isset($this->_req_data['txn_admin_payment']['registrations'])) {
-            $REG_IDs = (array)$this->_req_data['txn_admin_payment']['registrations'];
+            $REG_IDs = (array) $this->_req_data['txn_admin_payment']['registrations'];
         }
         //nothing specified ? then get all reg IDs
         if (empty($REG_IDs)) {
@@ -1891,8 +1891,8 @@ 
         $end_date   = isset($this->_req_data['txn-filter-end-date']) ? wp_strip_all_tags($this->_req_data['txn-filter-end-date']) : date('m/d/Y');
 
         //make sure our timestamps start and end right at the boundaries for each day
-        $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-        $end_date   = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+        $start_date = date('Y-m-d', strtotime($start_date)).' 00:00:00';
+        $end_date   = date('Y-m-d', strtotime($end_date)).' 23:59:59';
 
 
         //convert to timestamps
@@ -1945,7 +1945,7 @@ 
         }
 
         if (isset($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
+            $search_string = '%'.$this->_req_data['s'].'%';
             $_where['OR']  = array(
                 'Registration.Event.EVT_name'         => array('LIKE', $search_string),
                 'Registration.Event.EVT_desc'         => array('LIKE', $search_string),

caffeinated/admin/extend/transactions/Extend_Transactions_Admin_Page.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -198,7 +198,7 @@
      *
      * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
      *
-     * @return int
+     * @return string
      */
     private function _revenue_per_event_report($period = '-1 month')
     {

Indentation +220 added lines, -220 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -32,224 +32,224 @@ 
 {
 
 
-    /**
-     * This is used to hold the reports template data which is setup early in the request.
-     * @type array
-     */
-    protected $_reports_template_data = array();
-
-    /**
-     * @Constructor
-     * @access public
-     *
-     * @param bool $routing
-     *
-     * @return \Extend_Transactions_Admin_Page
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/');
-        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/');
-        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/');
-    }
-
-
-    /**
-     *    _extend_page_config
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions';
-
-        $new_page_routes = array(
-            'reports' => array(
-                'func'       => '_transaction_reports',
-                'capability' => 'ee_read_transactions'
-            )
-        );
-
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-
-        $new_page_config    = array(
-            'reports' => array(
-                'nav'           => array(
-                    'label' => __('Reports', 'event_espresso'),
-                    'order' => 20
-                ),
-                'help_tabs'     => array(
-                    'transactions_reports_help_tab' => array(
-                        'title'    => __('Transaction Reports', 'event_espresso'),
-                        'filename' => 'transactions_reports'
-                    )
-                ),
-                /*'help_tour' => array( 'Transaction_Reports_Help_Tour' ),*/
-                'require_nonce' => false
-            )
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-    }
-
-
-    /**
-     *    load_scripts_styles_reports
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_reports()
-    {
-        wp_register_script(
-            'ee-txn-reports-js',
-            TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js',
-            array('google-charts'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-txn-reports-js');
-        $this->_transaction_reports_js_setup();
-        EE_Registry::$i18n_js_strings['currency_format'] = EEH_Money::get_format_for_google_charts();
-    }
-
-
-    /**
-     * This is called when javascript is being enqueued to setup the various data needed for the reports js.
-     * Also $this->{$_reports_template_data} property is set for later usage by the _transaction_reports method.
-     */
-    protected function _transaction_reports_js_setup()
-    {
-        $this->_reports_template_data['admin_reports'][] = $this->_revenue_per_day_report();
-        $this->_reports_template_data['admin_reports'][] = $this->_revenue_per_event_report();
-    }
-
-
-    /**
-     * _transaction_reports
-     *    generates Business Reports regarding Transactions
-     *
-     * @return void
-     */
-    protected function _transaction_reports()
-    {
-        $template_path                              = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
-        $this->_admin_page_title                    = __('Transactions', 'event_espresso');
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
-            $this->_reports_template_data, true);
-
-        // the final template wrapper
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * _revenue_per_day_report
-     * generates Business Report showing Total Revenue per Day.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     *
-     * @return string
-     */
-    private function _revenue_per_day_report($period = '-1 month')
-    {
-
-        $report_ID = 'txn-admin-revenue-per-day-report-dv';
-
-        $TXN = EEM_Transaction::instance();
-
-        $results  = $TXN->get_revenue_per_day_report($period);
-        $results  = (array)$results;
-        $revenue  = array();
-        $subtitle = '';
-
-        if ($results) {
-            $revenue[] = array(
-                __('Date (only shows dates that have a revenue greater than 1)', 'event_espresso'),
-                __('Total Revenue', 'event_espresso')
-            );
-            foreach ($results as $result) {
-                $revenue[] = array($result->txnDate, (float)$result->revenue);
-            }
-
-            //setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
-        }
-
-        $report_title = esc_html__('Total Revenue per Day', 'event_espresso');
-
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'revenue'   => $revenue,
-            'noResults' => empty($revenue) || count($revenue) === 1,
-            'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>', '</p>')
-        );
-        wp_localize_script('ee-txn-reports-js', 'txnRevPerDay', $report_params);
-
-        return $report_ID;
-    }
-
-
-    /**
-     * _revenue_per_event_report
-     * generates Business Report showing total revenue per event.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     *
-     * @return int
-     */
-    private function _revenue_per_event_report($period = '-1 month')
-    {
-
-        $report_ID = 'txn-admin-revenue-per-event-report-dv';
-
-        $TXN      = EEM_Transaction::instance();
-        $results  = $TXN->get_revenue_per_event_report($period);
-        $results  = (array)$results;
-        $revenue  = array();
-        $subtitle = '';
-
-        if ($results) {
-            $revenue[] = array(
-                __('Event (only events that have a revenue greater than 1 are shown)', 'event_espresso'),
-                __('Total Revenue', 'event_espresso')
-            );
-            foreach ($results as $result) {
-                if ($result->revenue > 1) {
-                    $event_name = stripslashes(html_entity_decode($result->event_name, ENT_QUOTES, 'UTF-8'));
-                    $event_name = wp_trim_words($event_name, 5, '...');
-                    $revenue[]  = array($event_name, (float)$result->revenue);
-                }
-            }
-
-            //setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
-            $subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
-        }
-
-        $report_title = esc_html__('Total Revenue per Event', 'event_espresso');
-
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'revenue'   => $revenue,
-            'noResults' => empty($revenue),
-            'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>', '</p>')
-        );
-        wp_localize_script('ee-txn-reports-js', 'txnRevPerEvent', $report_params);
-
-        return $report_ID;
-    }
+	/**
+	 * This is used to hold the reports template data which is setup early in the request.
+	 * @type array
+	 */
+	protected $_reports_template_data = array();
+
+	/**
+	 * @Constructor
+	 * @access public
+	 *
+	 * @param bool $routing
+	 *
+	 * @return \Extend_Transactions_Admin_Page
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/');
+		define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/');
+		define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/');
+	}
+
+
+	/**
+	 *    _extend_page_config
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions';
+
+		$new_page_routes = array(
+			'reports' => array(
+				'func'       => '_transaction_reports',
+				'capability' => 'ee_read_transactions'
+			)
+		);
+
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+
+		$new_page_config    = array(
+			'reports' => array(
+				'nav'           => array(
+					'label' => __('Reports', 'event_espresso'),
+					'order' => 20
+				),
+				'help_tabs'     => array(
+					'transactions_reports_help_tab' => array(
+						'title'    => __('Transaction Reports', 'event_espresso'),
+						'filename' => 'transactions_reports'
+					)
+				),
+				/*'help_tour' => array( 'Transaction_Reports_Help_Tour' ),*/
+				'require_nonce' => false
+			)
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+	}
+
+
+	/**
+	 *    load_scripts_styles_reports
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_reports()
+	{
+		wp_register_script(
+			'ee-txn-reports-js',
+			TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js',
+			array('google-charts'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-txn-reports-js');
+		$this->_transaction_reports_js_setup();
+		EE_Registry::$i18n_js_strings['currency_format'] = EEH_Money::get_format_for_google_charts();
+	}
+
+
+	/**
+	 * This is called when javascript is being enqueued to setup the various data needed for the reports js.
+	 * Also $this->{$_reports_template_data} property is set for later usage by the _transaction_reports method.
+	 */
+	protected function _transaction_reports_js_setup()
+	{
+		$this->_reports_template_data['admin_reports'][] = $this->_revenue_per_day_report();
+		$this->_reports_template_data['admin_reports'][] = $this->_revenue_per_event_report();
+	}
+
+
+	/**
+	 * _transaction_reports
+	 *    generates Business Reports regarding Transactions
+	 *
+	 * @return void
+	 */
+	protected function _transaction_reports()
+	{
+		$template_path                              = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+		$this->_admin_page_title                    = __('Transactions', 'event_espresso');
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
+			$this->_reports_template_data, true);
+
+		// the final template wrapper
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * _revenue_per_day_report
+	 * generates Business Report showing Total Revenue per Day.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 *
+	 * @return string
+	 */
+	private function _revenue_per_day_report($period = '-1 month')
+	{
+
+		$report_ID = 'txn-admin-revenue-per-day-report-dv';
+
+		$TXN = EEM_Transaction::instance();
+
+		$results  = $TXN->get_revenue_per_day_report($period);
+		$results  = (array)$results;
+		$revenue  = array();
+		$subtitle = '';
+
+		if ($results) {
+			$revenue[] = array(
+				__('Date (only shows dates that have a revenue greater than 1)', 'event_espresso'),
+				__('Total Revenue', 'event_espresso')
+			);
+			foreach ($results as $result) {
+				$revenue[] = array($result->txnDate, (float)$result->revenue);
+			}
+
+			//setup the date range.
+			$beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
+		}
+
+		$report_title = esc_html__('Total Revenue per Day', 'event_espresso');
+
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'revenue'   => $revenue,
+			'noResults' => empty($revenue) || count($revenue) === 1,
+			'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
+				'<h2>' . $report_title . '</h2><p>', '</p>')
+		);
+		wp_localize_script('ee-txn-reports-js', 'txnRevPerDay', $report_params);
+
+		return $report_ID;
+	}
+
+
+	/**
+	 * _revenue_per_event_report
+	 * generates Business Report showing total revenue per event.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 *
+	 * @return int
+	 */
+	private function _revenue_per_event_report($period = '-1 month')
+	{
+
+		$report_ID = 'txn-admin-revenue-per-event-report-dv';
+
+		$TXN      = EEM_Transaction::instance();
+		$results  = $TXN->get_revenue_per_event_report($period);
+		$results  = (array)$results;
+		$revenue  = array();
+		$subtitle = '';
+
+		if ($results) {
+			$revenue[] = array(
+				__('Event (only events that have a revenue greater than 1 are shown)', 'event_espresso'),
+				__('Total Revenue', 'event_espresso')
+			);
+			foreach ($results as $result) {
+				if ($result->revenue > 1) {
+					$event_name = stripslashes(html_entity_decode($result->event_name, ENT_QUOTES, 'UTF-8'));
+					$event_name = wp_trim_words($event_name, 5, '...');
+					$revenue[]  = array($event_name, (float)$result->revenue);
+				}
+			}
+
+			//setup the date range.
+			$beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+			$subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
+		}
+
+		$report_title = esc_html__('Total Revenue per Event', 'event_espresso');
+
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'revenue'   => $revenue,
+			'noResults' => empty($revenue),
+			'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
+				'<h2>' . $report_title . '</h2><p>', '</p>')
+		);
+		wp_localize_script('ee-txn-reports-js', 'txnRevPerEvent', $report_params);
+
+		return $report_ID;
+	}
 
 }

Spacing +14 added lines, -14 removed lines

@@ -49,9 +49,9 @@ 
     public function __construct($routing = true)
     {
         parent::__construct($routing);
-        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/');
-        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/');
-        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/');
+        define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'transactions/templates/');
+        define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'transactions/assets/');
+        define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'transactions/assets/');
     }
 
 
@@ -63,7 +63,7 @@ 
      */
     protected function _extend_page_config()
     {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions';
+        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'transactions';
 
         $new_page_routes = array(
             'reports' => array(
@@ -104,7 +104,7 @@ 
     {
         wp_register_script(
             'ee-txn-reports-js',
-            TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js',
+            TXN_CAF_ASSETS_URL.'ee-transaction-admin-reports.js',
             array('google-charts'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -134,7 +134,7 @@ 
      */
     protected function _transaction_reports()
     {
-        $template_path                              = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+        $template_path                              = EE_ADMIN_TEMPLATE.'admin_reports.template.php';
         $this->_admin_page_title                    = __('Transactions', 'event_espresso');
         $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
             $this->_reports_template_data, true);
@@ -160,7 +160,7 @@ 
         $TXN = EEM_Transaction::instance();
 
         $results  = $TXN->get_revenue_per_day_report($period);
-        $results  = (array)$results;
+        $results  = (array) $results;
         $revenue  = array();
         $subtitle = '';
 
@@ -170,11 +170,11 @@ 
                 __('Total Revenue', 'event_espresso')
             );
             foreach ($results as $result) {
-                $revenue[] = array($result->txnDate, (float)$result->revenue);
+                $revenue[] = array($result->txnDate, (float) $result->revenue);
             }
 
             //setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+            $beginning_date = new DateTime('now'.$period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
                 $beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
@@ -189,7 +189,7 @@ 
             'revenue'   => $revenue,
             'noResults' => empty($revenue) || count($revenue) === 1,
             'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>', '</p>')
+                '<h2>'.$report_title.'</h2><p>', '</p>')
         );
         wp_localize_script('ee-txn-reports-js', 'txnRevPerDay', $report_params);
 
@@ -212,7 +212,7 @@ 
 
         $TXN      = EEM_Transaction::instance();
         $results  = $TXN->get_revenue_per_event_report($period);
-        $results  = (array)$results;
+        $results  = (array) $results;
         $revenue  = array();
         $subtitle = '';
 
@@ -225,12 +225,12 @@ 
                 if ($result->revenue > 1) {
                     $event_name = stripslashes(html_entity_decode($result->event_name, ENT_QUOTES, 'UTF-8'));
                     $event_name = wp_trim_words($event_name, 5, '...');
-                    $revenue[]  = array($event_name, (float)$result->revenue);
+                    $revenue[]  = array($event_name, (float) $result->revenue);
                 }
             }
 
             //setup the date range.
-            $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
+            $beginning_date = new DateTime('now'.$period, new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $ending_date    = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone()));
             $subtitle       = sprintf(_x('For the period: %s to %s', 'Used to give date range', 'event_espresso'),
                 $beginning_date->format('Y-m-d'), $ending_date->format('Y-m-d'));
@@ -245,7 +245,7 @@ 
             'revenue'   => $revenue,
             'noResults' => empty($revenue),
             'noTxnMsg'  => sprintf(__('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'),
-                '<h2>' . $report_title . '</h2><p>', '</p>')
+                '<h2>'.$report_title.'</h2><p>', '</p>')
         );
         wp_localize_script('ee-txn-reports-js', 'txnRevPerEvent', $report_params);
 

caffeinated/EE_Caf_Messages.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
      *
      * @param  array $dir_ref original array of paths
      *
-     * @return array           appended paths
+     * @return string[]           appended paths
      */
     public function messages_autoload_paths($dir_ref)
     {
@@ -701,7 +701,7 @@ 
      * @param EE_Question[]  $questions        An array of questions indexed by answer id.
      * @param EE_Answer[]    $answers          An array of answer objects
      * @param string         $template         Template content to be parsed.
-     * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
+     * @param string[]          $valid_shortcodes Valid shortcodes for the template being parsed.
      * @param array          $extra_data       Extra data that might be used when parsing the template.
      */
     protected function _parse_question_list_for_primary_or_recipient_registration(

Indentation +714 added lines, -714 removed lines

@@ -7,7 +7,7 @@ 
  * @since           4.3.2
  */
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -22,735 +22,735 @@ 
 {
     
     
-    /**
-     * constructor.
-     */
-    public function __construct()
-    {
-        $this->_caf_hooks();
-    }
-    
-    
-    /**
-     * Contains all the hooks filters for setting up caffeinated messages functionality.
-     *
-     * @since 4.3.2
-     *
-     * @return void
-     */
-    private function _caf_hooks()
-    {
-        add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
-        add_filter('FHEE__EE_Email_messenger__get_validator_config', array($this, 'email_messenger_validator_config'),
-            5, 2);
-        add_filter('FHEE__EE_Email_messenger__get_template_fields', array($this, 'email_messenger_template_fields'), 5,
-            2);
-        add_filter('FHEE__EE_Html_messenger__get_template_fields', array($this, 'html_messenger_template_fields'), 5,
-            2);
-        add_filter('FHEE__EE_Html_messenger__get_validator_config', array($this, 'html_messenger_validator_config'), 5,
-            2);
-        add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
-        add_filter('FHEE__EE_Pdf_messenger__get_validator_config', array($this, 'pdf_messenger_validator_config'), 5,
-            2);
-        add_filter('FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
-            array($this, 'new_default_templates'), 5, 7);
-        add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', array($this, 'message_types_valid_shortcodes'), 5,
-            2);
-        
-        //shortcode parsers
-        add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
-        add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
-        add_filter('FHEE__EE_Recipient_List_Shortcodes__shortcodes',
-            array($this, 'additional_recipient_details_shortcodes'), 5, 2);
-        add_filter('FHEE__EE_Recipient_List_Shortcodes__parser_after',
-            array($this, 'additional_recipient_details_parser'), 5, 5);
-        add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
-            array($this, 'additional_primary_registration_details_shortcodes'), 5, 2);
-        add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
-            array($this, 'additional_primary_registration_details_parser'), 5, 5);
-        
-        /**
-         * @since 4.2.0
-         */
-        add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
-        add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
-        
-        /**
-         * @since 4.3.0
-         */
-        //eat our own dog food!
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
-        do_action('EE_Brewing_Regular___messages_caf');
-    }
-    
-    
-    /**
-     * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
-     * messages system.
-     *
-     * @param  array $dir_ref original array of paths
-     *
-     * @return array           appended paths
-     */
-    public function messages_autoload_paths($dir_ref)
-    {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
-        
-        return $dir_ref;
-    }
-    
-    
-    public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]')
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]')
-        );
-        
-        return $validator_config;
-    }
-    
-    
-    public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]')
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]')
-        );
-        
-        return $validator_config;
-    }
-    
-    
-    public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]')
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]')
-        );
-        
-        return $validator_config;
-    }
-    
-    
-    public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]')
-        );
-        
-        return $template_fields;
-    }
-    
-    
-    public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]')
-        );
-        
-        return $template_fields;
-    }
-    
-    
-    public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]')
-        );
-        
-        return $template_fields;
-    }
-    
-    
-    public function new_default_templates(
-        $contents,
-        $actual_path,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $field,
-        $context,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        
-        //we're only modifying templates for the default template pack
-        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
-            return $contents;
-        }
-        
-        //the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix           = $messenger->name . '_' . $message_type->name . '_';
-        
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
-        
-        if ($messenger->name == 'email' && $message_type->name == 'registration') {
+	/**
+	 * constructor.
+	 */
+	public function __construct()
+	{
+		$this->_caf_hooks();
+	}
+    
+    
+	/**
+	 * Contains all the hooks filters for setting up caffeinated messages functionality.
+	 *
+	 * @since 4.3.2
+	 *
+	 * @return void
+	 */
+	private function _caf_hooks()
+	{
+		add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
+		add_filter('FHEE__EE_Email_messenger__get_validator_config', array($this, 'email_messenger_validator_config'),
+			5, 2);
+		add_filter('FHEE__EE_Email_messenger__get_template_fields', array($this, 'email_messenger_template_fields'), 5,
+			2);
+		add_filter('FHEE__EE_Html_messenger__get_template_fields', array($this, 'html_messenger_template_fields'), 5,
+			2);
+		add_filter('FHEE__EE_Html_messenger__get_validator_config', array($this, 'html_messenger_validator_config'), 5,
+			2);
+		add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
+		add_filter('FHEE__EE_Pdf_messenger__get_validator_config', array($this, 'pdf_messenger_validator_config'), 5,
+			2);
+		add_filter('FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
+			array($this, 'new_default_templates'), 5, 7);
+		add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', array($this, 'message_types_valid_shortcodes'), 5,
+			2);
+        
+		//shortcode parsers
+		add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
+		add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
+		add_filter('FHEE__EE_Recipient_List_Shortcodes__shortcodes',
+			array($this, 'additional_recipient_details_shortcodes'), 5, 2);
+		add_filter('FHEE__EE_Recipient_List_Shortcodes__parser_after',
+			array($this, 'additional_recipient_details_parser'), 5, 5);
+		add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
+			array($this, 'additional_primary_registration_details_shortcodes'), 5, 2);
+		add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
+			array($this, 'additional_primary_registration_details_parser'), 5, 5);
+        
+		/**
+		 * @since 4.2.0
+		 */
+		add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
+		add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
+        
+		/**
+		 * @since 4.3.0
+		 */
+		//eat our own dog food!
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
+		do_action('EE_Brewing_Regular___messages_caf');
+	}
+    
+    
+	/**
+	 * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
+	 * messages system.
+	 *
+	 * @param  array $dir_ref original array of paths
+	 *
+	 * @return array           appended paths
+	 */
+	public function messages_autoload_paths($dir_ref)
+	{
+		$dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+        
+		return $dir_ref;
+	}
+    
+    
+	public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]')
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]')
+		);
+        
+		return $validator_config;
+	}
+    
+    
+	public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]')
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]')
+		);
+        
+		return $validator_config;
+	}
+    
+    
+	public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]')
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]')
+		);
+        
+		return $validator_config;
+	}
+    
+    
+	public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]')
+		);
+        
+		return $template_fields;
+	}
+    
+    
+	public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]')
+		);
+        
+		return $template_fields;
+	}
+    
+    
+	public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]')
+		);
+        
+		return $template_fields;
+	}
+    
+    
+	public function new_default_templates(
+		$contents,
+		$actual_path,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$field,
+		$context,
+		EE_Messages_Template_Pack $template_pack
+	) {
+        
+		//we're only modifying templates for the default template pack
+		if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+			return $contents;
+		}
+        
+		//the template file name we're replacing contents for.
+		$template_file_prefix = $field . '_' . $context;
+		$msg_prefix           = $messenger->name . '_' . $message_type->name . '_';
+        
+		$base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+        
+		if ($messenger->name == 'email' && $message_type->name == 'registration') {
             
-            switch ($template_file_prefix) {
+			switch ($template_file_prefix) {
                 
-                case 'question_list_admin' :
-                case 'question_list_attendee' :
-                case 'question_list_primary_attendee' :
-                    $path     = $base_path . $msg_prefix . 'question_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
+				case 'question_list_admin' :
+				case 'question_list_attendee' :
+				case 'question_list_primary_attendee' :
+					$path     = $base_path . $msg_prefix . 'question_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
                 
-                case 'attendee_list_primary_attendee' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
+				case 'attendee_list_primary_attendee' :
+					$path     = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
                 
-                case 'attendee_list_admin' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
-                    $contents = EEH_Template::display_template($path,
-                        array(), true);
-                    break;
+				case 'attendee_list_admin' :
+					$path     = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+					$contents = EEH_Template::display_template($path,
+						array(), true);
+					break;
                 
-                case 'attendee_list_attendee' :
-                    $contents = '';
-                    break;
+				case 'attendee_list_attendee' :
+					$contents = '';
+					break;
                 
-                case 'event_list_attendee' :
-                    $path     = $base_path . $msg_prefix . 'event_list_attendee.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
-            switch ($template_file_prefix) {
+				case 'event_list_attendee' :
+					$path     = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
+			switch ($template_file_prefix) {
                 
-                case 'content_attendee' :
-                    $path     = $base_path . $msg_prefix . 'content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
+				case 'content_attendee' :
+					$path     = $base_path . $msg_prefix . 'content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
                 
-                case 'newsletter_content_attendee' :
-                    $path     = $base_path . $msg_prefix . 'newsletter_content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
+				case 'newsletter_content_attendee' :
+					$path     = $base_path . $msg_prefix . 'newsletter_content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
                 
-                case 'newsletter_subject_attendee' :
-                    $path     = $base_path . $msg_prefix . 'subject.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
-            switch ($template_file_prefix) {
-                case 'attendee_list_purchaser' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        }
-        
-        return $contents;
-        
-    }
-    
-    
-    public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
-    {
-        //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.
-        $include_with = array(
-            'registration',
-            'cancelled_registration',
-            'declined_registration',
-            'not_approved_registration',
-            'payment_declined',
-            'payment_failed',
-            'payment_cancelled',
-            'payment',
-            'payment_reminder',
-            'pending_approval',
-            'registration_summary',
-            'invoice',
-            'receipt'
-        );
-        if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
-            $contexts = array_keys($msg->get_contexts());
-            foreach ($contexts as $context) {
-                $valid_shortcodes[$context][] = 'question_list';
-                $valid_shortcodes[$context][] = 'question';
-            }
-        }
-        
-        return $valid_shortcodes;
-    }
-    
-    
-    public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $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.',
-            'event_espresso');
-        
-        return $shortcodes;
-    }
-    
-    
-    public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-        
-        if (strpos($shortcode,
-                '[ANSWER_*') === false || ! isset($extra_data['data']->questions) || ! isset($extra_data['data']->registrations)
-        ) {
-            return $parsed;
-        }
-        
-        //let's get the question from the code.
-        $shortcode = str_replace('[ANSWER_*', '', $shortcode);
-        $shortcode = trim(str_replace(']', '', $shortcode));
-        
-        $registration = $data instanceof EE_Registration ? $data : null;
-        $registration = ! $registration instanceof EE_Registration && is_array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
-        
-        $aee = $data instanceof EE_Messages_Addressee ? $data : null;
-        $aee = ! $aee instanceof EE_Messages_Addressee && is_array($extra_data) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
-        
-        if ( ! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-        
-        //now let's figure out which question has this text.
-        foreach ($aee->questions as $ansid => $question) {
-            if (
-                $question instanceof EE_Question
-                && trim($question->display_text()) == trim($shortcode)
-                && isset($aee->registrations[$registration->ID()]['ans_objs'][$ansid])
-            ) {
-                return $aee->registrations[$registration->ID()]['ans_objs'][$ansid]->get_pretty('ANS_value',
-                    'no_wpautop');
-            }
-        }
-        
-        //nothing!
-        return $parsed;
-    }
-    
-    
-    /**
-     * Callback for additional shortcodes filter for adding additional datetime shortcodes.
-     *
-     * @since  4.2
-     *
-     * @param  array                  $shortcodes         array of shortcodes and
-     *                                                    descriptions
-     * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
-     *
-     * @return array                                        array of shortcodes and
-     *                                                        descriptions
-     */
-    public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[DTT_NAME]']          = __('This will be parsed to the Title given for a Datetime',
-            'event_espresso');
-        $shortcodes['[DTT_DESCRIPTION]']   = __('This will be parsed to the description for a Datetime',
-            'event_espresso');
-        $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.',
-            'event_espresso');
-        
-        return $shortcodes;
-    }
-    
-    
-    /**
-     * Callback for additional shortcodes parser filter used for adding parser for new
-     * Datetime shortcodes
-     *
-     * @since  4.2
-     *
-     * @param  string                 $parsed     The finished parsed string for the given shortcode.
-     * @param  string                 $shortcode  The shortcode being parsed.
-     * @param  object                 $data       The incoming data object for the Shortcode Parser.
-     * @param  object                 $extra_data The incoming extra date object for the Shortcode
-     *                                            Parser.
-     * @param  EE_Datetime_Shortcodes $shortcode_parser
-     *
-     * @return string                   The new parsed string.
-     */
-    public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-        
-        if ( ! $data instanceof EE_Datetime) {
-            return ''; //get out because we can only parse with the datetime object.
-        }
-        
-        switch ($shortcode) {
-            case '[DTT_NAME]' :
-                return $data->name();
-                break;
-            case '[DTT_DESCRIPTION]' :
-                return $data->description();
-                break;
-            case '[DTT_NAME_OR_DATES]' :
-                return $data->get_dtt_display_name(true);
-                break;
-            default :
-                return $parsed;
-                break;
-        }
-    }
-    
-    
-    public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $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.',
-            'event_espresso');
-        
-        return $shortcodes;
-    }
-    
-    
-    /**
-     * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-        
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-        
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-        
-        if ( ! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-        
-        switch ($shortcode) {
-            case '[RECIPIENT_QUESTION_LIST]' :
-                $att                       = $recipient->att_obj;
-                $registrations_on_attendee = $att instanceof EE_Attendee ? $recipient->attendees[$att->ID()]['reg_objs'] : array();
-                $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
-                $answers                   = array();
+				case 'newsletter_subject_attendee' :
+					$path     = $base_path . $msg_prefix . 'subject.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
+			switch ($template_file_prefix) {
+				case 'attendee_list_purchaser' :
+					$path     = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		}
+        
+		return $contents;
+        
+	}
+    
+    
+	public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
+	{
+		//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.
+		$include_with = array(
+			'registration',
+			'cancelled_registration',
+			'declined_registration',
+			'not_approved_registration',
+			'payment_declined',
+			'payment_failed',
+			'payment_cancelled',
+			'payment',
+			'payment_reminder',
+			'pending_approval',
+			'registration_summary',
+			'invoice',
+			'receipt'
+		);
+		if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
+			$contexts = array_keys($msg->get_contexts());
+			foreach ($contexts as $context) {
+				$valid_shortcodes[$context][] = 'question_list';
+				$valid_shortcodes[$context][] = 'question';
+			}
+		}
+        
+		return $valid_shortcodes;
+	}
+    
+    
+	public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$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.',
+			'event_espresso');
+        
+		return $shortcodes;
+	}
+    
+    
+	public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+        
+		if (strpos($shortcode,
+				'[ANSWER_*') === false || ! isset($extra_data['data']->questions) || ! isset($extra_data['data']->registrations)
+		) {
+			return $parsed;
+		}
+        
+		//let's get the question from the code.
+		$shortcode = str_replace('[ANSWER_*', '', $shortcode);
+		$shortcode = trim(str_replace(']', '', $shortcode));
+        
+		$registration = $data instanceof EE_Registration ? $data : null;
+		$registration = ! $registration instanceof EE_Registration && is_array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
+        
+		$aee = $data instanceof EE_Messages_Addressee ? $data : null;
+		$aee = ! $aee instanceof EE_Messages_Addressee && is_array($extra_data) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
+        
+		if ( ! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+        
+		//now let's figure out which question has this text.
+		foreach ($aee->questions as $ansid => $question) {
+			if (
+				$question instanceof EE_Question
+				&& trim($question->display_text()) == trim($shortcode)
+				&& isset($aee->registrations[$registration->ID()]['ans_objs'][$ansid])
+			) {
+				return $aee->registrations[$registration->ID()]['ans_objs'][$ansid]->get_pretty('ANS_value',
+					'no_wpautop');
+			}
+		}
+        
+		//nothing!
+		return $parsed;
+	}
+    
+    
+	/**
+	 * Callback for additional shortcodes filter for adding additional datetime shortcodes.
+	 *
+	 * @since  4.2
+	 *
+	 * @param  array                  $shortcodes         array of shortcodes and
+	 *                                                    descriptions
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
+	 *
+	 * @return array                                        array of shortcodes and
+	 *                                                        descriptions
+	 */
+	public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[DTT_NAME]']          = __('This will be parsed to the Title given for a Datetime',
+			'event_espresso');
+		$shortcodes['[DTT_DESCRIPTION]']   = __('This will be parsed to the description for a Datetime',
+			'event_espresso');
+		$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.',
+			'event_espresso');
+        
+		return $shortcodes;
+	}
+    
+    
+	/**
+	 * Callback for additional shortcodes parser filter used for adding parser for new
+	 * Datetime shortcodes
+	 *
+	 * @since  4.2
+	 *
+	 * @param  string                 $parsed     The finished parsed string for the given shortcode.
+	 * @param  string                 $shortcode  The shortcode being parsed.
+	 * @param  object                 $data       The incoming data object for the Shortcode Parser.
+	 * @param  object                 $extra_data The incoming extra date object for the Shortcode
+	 *                                            Parser.
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser
+	 *
+	 * @return string                   The new parsed string.
+	 */
+	public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+        
+		if ( ! $data instanceof EE_Datetime) {
+			return ''; //get out because we can only parse with the datetime object.
+		}
+        
+		switch ($shortcode) {
+			case '[DTT_NAME]' :
+				return $data->name();
+				break;
+			case '[DTT_DESCRIPTION]' :
+				return $data->description();
+				break;
+			case '[DTT_NAME_OR_DATES]' :
+				return $data->get_dtt_display_name(true);
+				break;
+			default :
+				return $parsed;
+				break;
+		}
+	}
+    
+    
+	public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$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.',
+			'event_espresso');
+        
+		return $shortcodes;
+	}
+    
+    
+	/**
+	 * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+        
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+        
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+        
+		if ( ! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+        
+		switch ($shortcode) {
+			case '[RECIPIENT_QUESTION_LIST]' :
+				$att                       = $recipient->att_obj;
+				$registrations_on_attendee = $att instanceof EE_Attendee ? $recipient->attendees[$att->ID()]['reg_objs'] : array();
+				$registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
+				$answers                   = array();
                 
-                $template         = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
+				$template         = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
                 
-                //if the context is main_content then get all answers for all registrations on this attendee
-                if ($data['data'] instanceof EE_Messages_Addressee) {
+				//if the context is main_content then get all answers for all registrations on this attendee
+				if ($data['data'] instanceof EE_Messages_Addressee) {
                     
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration) {
-                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[$ans->ID()] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration) {
+							$anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[$ans->ID()] = $ans;
+								}
+							}
+						}
+					}
+				}
                 
-                //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.
-                if ($data['data'] instanceof EE_Event) {
-                    $event = $data['data'];
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
-                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[$ans->ID()] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
+				//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.
+				if ($data['data'] instanceof EE_Event) {
+					$event = $data['data'];
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
+							$anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[$ans->ID()] = $ans;
+								}
+							}
+						}
+					}
+				}
                 
-                $questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
+				$questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
                 
-                //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                //object on it.
-                if ( ! isset( $extra_data['data'] ) ) {
-                    $extra_data['data'] = $recipient;
-                }
+				//if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				//object on it.
+				if ( ! isset( $extra_data['data'] ) ) {
+					$extra_data['data'] = $recipient;
+				}
                 
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
             
-            default :
-                return $parsed;
-                break;
-        }
-    }
-    
-    
-    public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $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',
-            'event_espresso');
-        
-        return $shortcodes;
-    }
-    
-    
-    /**
-     * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_primary_registration_details_parser(
-        $parsed,
-        $shortcode,
-        $data,
-        $extra_data,
-        $shortcode_parser
-    ) {
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-        
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-        
-        if ( ! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-        
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_QUESTION_LIST]' :
-                if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                $registration     = $recipient->primary_reg_obj;
-                $answers = isset($recipient->registrations[$registration->ID()]['ans_objs'])
-                    ? $recipient->registrations[$registration->ID()]['ans_objs']
-                    : array();
-                if (empty($answers)) {
-                    return '';
-                }
-                $template         = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
-                $answers          = $recipient->registrations[$registration->ID()]['ans_objs'];
-                $questions = isset($recipient->questions) ? $recipient->questions : array();
-                //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                //object on it.
-                if ( ! isset( $extra_data['data'] ) ){
-                    $extra_data['data'] = $recipient;
-                }
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
+			default :
+				return $parsed;
+				break;
+		}
+	}
+    
+    
+	public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$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',
+			'event_espresso');
+        
+		return $shortcodes;
+	}
+    
+    
+	/**
+	 * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_primary_registration_details_parser(
+		$parsed,
+		$shortcode,
+		$data,
+		$extra_data,
+		$shortcode_parser
+	) {
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+        
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+        
+		if ( ! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+        
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_QUESTION_LIST]' :
+				if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				$registration     = $recipient->primary_reg_obj;
+				$answers = isset($recipient->registrations[$registration->ID()]['ans_objs'])
+					? $recipient->registrations[$registration->ID()]['ans_objs']
+					: array();
+				if (empty($answers)) {
+					return '';
+				}
+				$template         = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
+				$answers          = $recipient->registrations[$registration->ID()]['ans_objs'];
+				$questions = isset($recipient->questions) ? $recipient->questions : array();
+				//if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				//object on it.
+				if ( ! isset( $extra_data['data'] ) ){
+					$extra_data['data'] = $recipient;
+				}
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
             
-            default :
-                return $parsed;
-                break;
-        }
-    }
-    
-    
-    /**
-     * Takes care of registering the  message types that are only available in caffeinated EE.
-     *
-     * @since   4.3.2
-     *
-     * @return  void
-     */
-    public function register_caf_message_types()
-    {
-        //register newsletter message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Newsletter_message_type.class.php',
-            'autoloadpaths'               => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/'
-            ),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('newsletter', $setup_args);
-        
-        //register payment reminder message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('payment_reminder', $setup_args);
-        
-        //register payment declined message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('payment_declined', $setup_args);
-        
-        //register registration declined message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('declined_registration', $setup_args);
-        
-        //register registration cancelled message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('cancelled_registration', $setup_args);
-        
-        
-        //register payment failed message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('payment_failed', $setup_args);
-        
-        //register payment declined message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('payment_cancelled', $setup_args);
-    }
-    
-    
-    /**
-     * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
-     *
-     * @since   4.3.2
-     *
-     * @return void
-     */
-    public function register_caf_shortcodes()
-    {
-        $setup_args = array(
-            'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/'
-            ),
-            'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
-            'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
-            'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]')
-        );
-        EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
-    }
-    
-    
-    /**
-     * Parses a question list shortcode using given data and template
-     *
-     * @param \EE_Shortcodes $shortcode_parser
-     * @param EE_Question[]  $questions        An array of questions indexed by answer id.
-     * @param EE_Answer[]    $answers          An array of answer objects
-     * @param string         $template         Template content to be parsed.
-     * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
-     * @param array          $extra_data       Extra data that might be used when parsing the template.
-     */
-    protected function _parse_question_list_for_primary_or_recipient_registration(
-        $shortcode_parser,
-        $questions,
-        $answers,
-        $template,
-        $valid_shortcodes,
-        $extra_data
-    ) {
-        $question_list = '';
-        /** @var EEH_Parse_Shortcodes $shortcode_helper */
-        $shortcode_helper = $shortcode_parser->get_shortcode_helper();
-        foreach ($answers as $answer) {
-            if ($answer instanceof EE_Answer) {
-                //first see if the question is in our $questions array. If not then try to get from answer object.
-                $question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null;
-                $question = ! $question instanceof EE_Question ? $answer->question() : $question;
-                if (
-                    ! $question instanceof EE_Question
-                    || (
-                        $question instanceof EE_Question
-                        && $question->admin_only()
-                    )
-                ) {
-                    continue;
-                }
-                $question_list .= $shortcode_helper->parse_question_list_template(
-                    $template,
-                    $answer,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-            }
-        }
-        
-        return $question_list;
-    }
+			default :
+				return $parsed;
+				break;
+		}
+	}
+    
+    
+	/**
+	 * Takes care of registering the  message types that are only available in caffeinated EE.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return  void
+	 */
+	public function register_caf_message_types()
+	{
+		//register newsletter message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Newsletter_message_type.class.php',
+			'autoloadpaths'               => array(
+				EE_CAF_LIBRARIES . 'messages/message_type/newsletter/'
+			),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('newsletter', $setup_args);
+        
+		//register payment reminder message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Payment_Reminder_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('payment_reminder', $setup_args);
+        
+		//register payment declined message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Payment_Declined_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('payment_declined', $setup_args);
+        
+		//register registration declined message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Declined_Registration_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('declined_registration', $setup_args);
+        
+		//register registration cancelled message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Cancelled_Registration_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('cancelled_registration', $setup_args);
+        
+        
+		//register payment failed message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Payment_Failed_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('payment_failed', $setup_args);
+        
+		//register payment declined message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Payment_Cancelled_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('payment_cancelled', $setup_args);
+	}
+    
+    
+	/**
+	 * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return void
+	 */
+	public function register_caf_shortcodes()
+	{
+		$setup_args = array(
+			'autoloadpaths'                 => array(
+				EE_CAF_LIBRARIES . 'shortcodes/'
+			),
+			'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
+			'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
+			'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]')
+		);
+		EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
+	}
+    
+    
+	/**
+	 * Parses a question list shortcode using given data and template
+	 *
+	 * @param \EE_Shortcodes $shortcode_parser
+	 * @param EE_Question[]  $questions        An array of questions indexed by answer id.
+	 * @param EE_Answer[]    $answers          An array of answer objects
+	 * @param string         $template         Template content to be parsed.
+	 * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
+	 * @param array          $extra_data       Extra data that might be used when parsing the template.
+	 */
+	protected function _parse_question_list_for_primary_or_recipient_registration(
+		$shortcode_parser,
+		$questions,
+		$answers,
+		$template,
+		$valid_shortcodes,
+		$extra_data
+	) {
+		$question_list = '';
+		/** @var EEH_Parse_Shortcodes $shortcode_helper */
+		$shortcode_helper = $shortcode_parser->get_shortcode_helper();
+		foreach ($answers as $answer) {
+			if ($answer instanceof EE_Answer) {
+				//first see if the question is in our $questions array. If not then try to get from answer object.
+				$question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null;
+				$question = ! $question instanceof EE_Question ? $answer->question() : $question;
+				if (
+					! $question instanceof EE_Question
+					|| (
+						$question instanceof EE_Question
+						&& $question->admin_only()
+					)
+				) {
+					continue;
+				}
+				$question_list .= $shortcode_helper->parse_question_list_template(
+					$template,
+					$answer,
+					$valid_shortcodes,
+					$extra_data
+				);
+			}
+		}
+        
+		return $question_list;
+	}
 }

Spacing +23 added lines, -23 removed lines

@@ -95,7 +95,7 @@ 
      */
     public function messages_autoload_paths($dir_ref)
     {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+        $dir_ref[] = EE_CAF_LIBRARIES.'shortcodes/';
         
         return $dir_ref;
     }
@@ -216,10 +216,10 @@ 
         }
         
         //the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix           = $messenger->name . '_' . $message_type->name . '_';
+        $template_file_prefix = $field.'_'.$context;
+        $msg_prefix           = $messenger->name.'_'.$message_type->name.'_';
         
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+        $base_path = EE_CAF_LIBRARIES.'messages/defaults/default/';
         
         if ($messenger->name == 'email' && $message_type->name == 'registration') {
             
@@ -228,17 +228,17 @@ 
                 case 'question_list_admin' :
                 case 'question_list_attendee' :
                 case 'question_list_primary_attendee' :
-                    $path     = $base_path . $msg_prefix . 'question_list.template.php';
+                    $path     = $base_path.$msg_prefix.'question_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
                 
                 case 'attendee_list_primary_attendee' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path     = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
                 
                 case 'attendee_list_admin' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+                    $path     = $base_path.$msg_prefix.'attendee_list_admin.template.php';
                     $contents = EEH_Template::display_template($path,
                         array(), true);
                     break;
@@ -248,7 +248,7 @@ 
                     break;
                 
                 case 'event_list_attendee' :
-                    $path     = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+                    $path     = $base_path.$msg_prefix.'event_list_attendee.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
@@ -256,24 +256,24 @@ 
             switch ($template_file_prefix) {
                 
                 case 'content_attendee' :
-                    $path     = $base_path . $msg_prefix . 'content.template.php';
+                    $path     = $base_path.$msg_prefix.'content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
                 
                 case 'newsletter_content_attendee' :
-                    $path     = $base_path . $msg_prefix . 'newsletter_content.template.php';
+                    $path     = $base_path.$msg_prefix.'newsletter_content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
                 
                 case 'newsletter_subject_attendee' :
-                    $path     = $base_path . $msg_prefix . 'subject.template.php';
+                    $path     = $base_path.$msg_prefix.'subject.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
         } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
             switch ($template_file_prefix) {
                 case 'attendee_list_purchaser' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path     = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
@@ -505,7 +505,7 @@ 
                 
                 //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 //object on it.
-                if ( ! isset( $extra_data['data'] ) ) {
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
                 
@@ -569,7 +569,7 @@ 
                 if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
                     return '';
                 }
-                $registration     = $recipient->primary_reg_obj;
+                $registration = $recipient->primary_reg_obj;
                 $answers = isset($recipient->registrations[$registration->ID()]['ans_objs'])
                     ? $recipient->registrations[$registration->ID()]['ans_objs']
                     : array();
@@ -582,7 +582,7 @@ 
                 $questions = isset($recipient->questions) ? $recipient->questions : array();
                 //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 //object on it.
-                if ( ! isset( $extra_data['data'] ) ){
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
                 return $this->_parse_question_list_for_primary_or_recipient_registration(
@@ -615,7 +615,7 @@ 
         $setup_args = array(
             'mtfilename'                  => 'EE_Newsletter_message_type.class.php',
             'autoloadpaths'               => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/'
+                EE_CAF_LIBRARIES.'messages/message_type/newsletter/'
             ),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
@@ -626,7 +626,7 @@ 
         //register payment reminder message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/payment_reminder/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -636,7 +636,7 @@ 
         //register payment declined message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/payment_declined/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -646,7 +646,7 @@ 
         //register registration declined message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/declined_registration/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -656,7 +656,7 @@ 
         //register registration cancelled message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/cancelled_registration/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -667,7 +667,7 @@ 
         //register payment failed message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/payment_failed/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -677,7 +677,7 @@ 
         //register payment declined message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/payment_cancelled/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -697,7 +697,7 @@ 
     {
         $setup_args = array(
             'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/'
+                EE_CAF_LIBRARIES.'shortcodes/'
             ),
             'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
             'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),

core/libraries/messages/data_class/EE_Messages_Preview_incoming_data.class.php

Indentation +553 added lines, -553 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -24,585 +24,585 @@ 
 class EE_Messages_Preview_incoming_data extends EE_Messages_incoming_data
 {
     
-    //some specific properties we need for this class
-    private $_events = array();
-    private $_attendees = array();
-    private $_registrations = array();
+	//some specific properties we need for this class
+	private $_events = array();
+	private $_attendees = array();
+	private $_registrations = array();
     
     
-    /**
-     * For the constructor of this special preview class.  We're either looking for an event id or empty data.  If we
-     * have an event id (or ids) then we'll use that as the source for the "dummy" data.  If the data is empty then
-     * we'll get the first three published events from the users database and use that as a source.
-     *
-     * @param array $data
-     */
-    public function __construct($data = array())
-    {
-        $this->_data = isset($data['event_ids']) ? $data['event_ids'] : array();
-        $this->_setup_attendees_events();
-        parent::__construct($data);
-    }
+	/**
+	 * For the constructor of this special preview class.  We're either looking for an event id or empty data.  If we
+	 * have an event id (or ids) then we'll use that as the source for the "dummy" data.  If the data is empty then
+	 * we'll get the first three published events from the users database and use that as a source.
+	 *
+	 * @param array $data
+	 */
+	public function __construct($data = array())
+	{
+		$this->_data = isset($data['event_ids']) ? $data['event_ids'] : array();
+		$this->_setup_attendees_events();
+		parent::__construct($data);
+	}
     
     
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param array $data The incoming data to be prepped.
-     *
-     * @return array   The prepped data for db
-     */
-    static public function convert_data_for_persistent_storage($data)
-    {
-        return $data;
-    }
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param array $data The incoming data to be prepped.
+	 *
+	 * @return array   The prepped data for db
+	 */
+	static public function convert_data_for_persistent_storage($data)
+	{
+		return $data;
+	}
     
     
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param array $data
-     *
-     * @return array
-     */
-    static public function convert_data_from_persistent_storage($data)
-    {
-        return $data;
-    }
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param array $data
+	 *
+	 * @return array
+	 */
+	static public function convert_data_from_persistent_storage($data)
+	{
+		return $data;
+	}
     
     
-    /**
-     * This will just setup the _events property in the expected format.
-     *
-     * @throws \EE_Error
-     */
-    private function _setup_attendees_events()
-    {
-        
-        //setup some attendee objects
-        $attendees = $this->_get_some_attendees();
-        
-        //if empty $data we'll do a query to get some events from the server. otherwise we'll retrieve the event data for the given ids.
-        $events = $this->_get_some_events($this->_data);
-        
-        $answers_n_questions = $this->_get_some_q_and_as();
-        
-        if (count($events) < 1) {
-            throw new EE_Error(__('We can\'t generate a preview for you because there are no active events in your database',
-                'event_espresso'));
-        }
-        
-        
-        //now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
-        
-        
-        //we'll actually use the generated line_item identifiers for our loop
-        $dtts = $tkts = array();
-        foreach ($events as $id => $event) {
-            if ( ! $event instanceof EE_Event) {
-                continue;
-            }
-            $this->_events[$id]['ID']       = $id;
-            $this->_events[$id]['name']     = $event->get('EVT_name');
-            $datetime                       = $event->get_first_related('Datetime');
-            $tickets                        = $datetime instanceof EE_Datetime ? $datetime->get_many_related('Ticket',
-                array('default_where_conditions' => 'none')) : array();
-            $this->_events[$id]['event']    = $event;
-            $this->_events[$id]['reg_objs'] = array();
-            $this->_events[$id]['tkt_objs'] = $tickets;
-            $this->_events[$id]['dtt_objs'] = array();
+	/**
+	 * This will just setup the _events property in the expected format.
+	 *
+	 * @throws \EE_Error
+	 */
+	private function _setup_attendees_events()
+	{
+        
+		//setup some attendee objects
+		$attendees = $this->_get_some_attendees();
+        
+		//if empty $data we'll do a query to get some events from the server. otherwise we'll retrieve the event data for the given ids.
+		$events = $this->_get_some_events($this->_data);
+        
+		$answers_n_questions = $this->_get_some_q_and_as();
+        
+		if (count($events) < 1) {
+			throw new EE_Error(__('We can\'t generate a preview for you because there are no active events in your database',
+				'event_espresso'));
+		}
+        
+        
+		//now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
+        
+        
+		//we'll actually use the generated line_item identifiers for our loop
+		$dtts = $tkts = array();
+		foreach ($events as $id => $event) {
+			if ( ! $event instanceof EE_Event) {
+				continue;
+			}
+			$this->_events[$id]['ID']       = $id;
+			$this->_events[$id]['name']     = $event->get('EVT_name');
+			$datetime                       = $event->get_first_related('Datetime');
+			$tickets                        = $datetime instanceof EE_Datetime ? $datetime->get_many_related('Ticket',
+				array('default_where_conditions' => 'none')) : array();
+			$this->_events[$id]['event']    = $event;
+			$this->_events[$id]['reg_objs'] = array();
+			$this->_events[$id]['tkt_objs'] = $tickets;
+			$this->_events[$id]['dtt_objs'] = array();
             
-            $dttcache = array();
-            $tkts     = array();
-            foreach ($tickets as $ticket) {
-                if ( ! $ticket instanceof EE_Ticket) {
-                    continue;
-                }
-                $reldatetime                     = $ticket->datetimes();
-                $tkts[$ticket->ID()]             = array();
-                $tkts[$ticket->ID()]['ticket']   = $ticket;
-                $tkts[$ticket->ID()]['dtt_objs'] = $reldatetime;
-                $tkts[$ticket->ID()]['att_objs'] = $attendees;
-                $tkts[$ticket->ID()]['count']    = count($attendees);
-                $tkts[$ticket->ID()]['EE_Event'] = $event;
-                foreach ($reldatetime as $datetime) {
-                    if ($datetime instanceof EE_Datetime && ! isset($dtts[$datetime->ID()])) {
-                        $this->_events[$id]['dtt_objs'][$datetime->ID()] = $datetime;
-                        $dtts[$datetime->ID()]['datetime']               = $datetime;
-                        $dtts[$datetime->ID()]['tkt_objs'][]             = $ticket;
-                        $dtts[$datetime->ID()]['evt_objs'][]             = $event;
-                        $dttcache[$datetime->ID()]                       = $datetime;
-                    }
-                }
-            }
+			$dttcache = array();
+			$tkts     = array();
+			foreach ($tickets as $ticket) {
+				if ( ! $ticket instanceof EE_Ticket) {
+					continue;
+				}
+				$reldatetime                     = $ticket->datetimes();
+				$tkts[$ticket->ID()]             = array();
+				$tkts[$ticket->ID()]['ticket']   = $ticket;
+				$tkts[$ticket->ID()]['dtt_objs'] = $reldatetime;
+				$tkts[$ticket->ID()]['att_objs'] = $attendees;
+				$tkts[$ticket->ID()]['count']    = count($attendees);
+				$tkts[$ticket->ID()]['EE_Event'] = $event;
+				foreach ($reldatetime as $datetime) {
+					if ($datetime instanceof EE_Datetime && ! isset($dtts[$datetime->ID()])) {
+						$this->_events[$id]['dtt_objs'][$datetime->ID()] = $datetime;
+						$dtts[$datetime->ID()]['datetime']               = $datetime;
+						$dtts[$datetime->ID()]['tkt_objs'][]             = $ticket;
+						$dtts[$datetime->ID()]['evt_objs'][]             = $event;
+						$dttcache[$datetime->ID()]                       = $datetime;
+					}
+				}
+			}
             
-            $this->_events[$id]['total_attendees'] = count($attendees);
-            $this->_events[$id]['att_objs']        = $attendees;
+			$this->_events[$id]['total_attendees'] = count($attendees);
+			$this->_events[$id]['att_objs']        = $attendees;
             
-            //let's also setup the dummy attendees property!
-            foreach ($attendees as $att_key => $attendee) {
-                if ( ! $attendee instanceof EE_Attendee) {
-                    continue;
-                }
-                $this->_attendees[$att_key]['line_ref'][] = $id;  //so later it can be determined what events this attendee registered for!
-                $this->_attendees[$att_key]['evt_objs'][] = $event;
-                $this->_attendees[$att_key]['att_obj']    = $attendee;
-                //$this->_attendees[$att_key]['registration_id'] = 0;
-                $this->_attendees[$att_key]['attendee_email'] = $attendee->email();
-                $this->_attendees[$att_key]['tkt_objs']       = $tickets;
-                if ($att_key == 999999991) {
-                    $this->_attendees[$att_key]['ans_objs'][999]  = $answers_n_questions['answers'][999];
-                    $this->_attendees[$att_key]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
-                    $this->_attendees[$att_key]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
-                } elseif ($att_key == 999999992) {
-                    $this->_attendees[$att_key]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
-                    $this->_attendees[$att_key]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
-                    $this->_attendees[$att_key]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
-                } elseif ($att_key == 999999993) {
-                    $this->_attendees[$att_key]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
-                    $this->_attendees[$att_key]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
-                    $this->_attendees[$att_key]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
-                }
-            }
-        }
-        
-        $this->tickets            = $tkts;
-        $this->datetimes          = $dtts;
-        $this->answers            = $answers_n_questions['answers'];
-        $this->questions          = $answers_n_questions['questions'];
-        $this->total_ticket_count = count($tkts) * count($this->_attendees);
-        
-    }
+			//let's also setup the dummy attendees property!
+			foreach ($attendees as $att_key => $attendee) {
+				if ( ! $attendee instanceof EE_Attendee) {
+					continue;
+				}
+				$this->_attendees[$att_key]['line_ref'][] = $id;  //so later it can be determined what events this attendee registered for!
+				$this->_attendees[$att_key]['evt_objs'][] = $event;
+				$this->_attendees[$att_key]['att_obj']    = $attendee;
+				//$this->_attendees[$att_key]['registration_id'] = 0;
+				$this->_attendees[$att_key]['attendee_email'] = $attendee->email();
+				$this->_attendees[$att_key]['tkt_objs']       = $tickets;
+				if ($att_key == 999999991) {
+					$this->_attendees[$att_key]['ans_objs'][999]  = $answers_n_questions['answers'][999];
+					$this->_attendees[$att_key]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
+					$this->_attendees[$att_key]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
+				} elseif ($att_key == 999999992) {
+					$this->_attendees[$att_key]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
+					$this->_attendees[$att_key]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
+					$this->_attendees[$att_key]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
+				} elseif ($att_key == 999999993) {
+					$this->_attendees[$att_key]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
+					$this->_attendees[$att_key]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
+					$this->_attendees[$att_key]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
+				}
+			}
+		}
+        
+		$this->tickets            = $tkts;
+		$this->datetimes          = $dtts;
+		$this->answers            = $answers_n_questions['answers'];
+		$this->questions          = $answers_n_questions['questions'];
+		$this->total_ticket_count = count($tkts) * count($this->_attendees);
+        
+	}
     
     
-    /**
-     * This just returns an array of dummy attendee objects that we'll use to attach to events for our preview data
-     *
-     * @access private
-     * @return array an array of attendee objects
-     */
-    private function _get_some_attendees()
-    {
-        //let's just setup a dummy array of various attendee details
-        $dummy_attendees = array(
-            0 => array(
-                'Luke',
-                'Skywalker',
-                'farfaraway@galaxy.sp',
-                '804 Bantha Dr.',
-                'Complex 8',
-                'Mos Eisley',
-                32,
-                'US',
-                'f0r3e',
-                '222-333-4763',
-                false,
-                '999999991'
-            ),
-            1 => array(
-                'Princess',
-                'Leia',
-                'buns@fcn.al',
-                '1456 Valley Way Boulevard',
-                'Suite 9',
-                'Alderaan',
-                15,
-                'US',
-                'c1h2c',
-                '78-123-111-1111',
-                false,
-                '999999992'
-            ),
-            2 => array(
-                'Yoda',
-                'I Am',
-                'arrivenot@emailbad.fr',
-                '4th Tree',
-                '5th Knot',
-                'Marsh',
-                22,
-                'US',
-                'l18n',
-                '999-999-9999',
-                false,
-                '999999993'
-            ),
-        );
-        
-        //let's generate the attendee objects
-        $attendees = array();
-        $var_array = array(
-            'fname',
-            'lname',
-            'email',
-            'address',
-            'address2',
-            'city',
-            'staid',
-            'cntry',
-            'zip',
-            'phone',
-            'deleted',
-            'attid'
-        );
-        
-        //EE_Registry::instance()->load_class( 'Attendee', array(), FALSE, false, TRUE );
-        foreach ($dummy_attendees as $dummy) {
-            $att = array_combine($var_array, $dummy);
-            extract($att);
-            /** @var $fname string */
-            /** @var $lname string */
-            /** @var $address string */
-            /** @var $address2 string */
-            /** @var $city string */
-            /** @var $staid string */
-            /** @var $cntry string */
-            /** @var $zip string */
-            /** @var $email string */
-            /** @var $phone string */
-            /** @var $attid string */
-            $attendees[$attid] = EE_Attendee::new_instance(
-                array(
-                    'ATT_fname'    => $fname,
-                    'ATT_lname'    => $lname,
-                    'ATT_address'  => $address,
-                    'ATT_address2' => $address2,
-                    'ATT_city'     => $city,
-                    'STA_ID'       => $staid,
-                    'CNT_ISO'      => $cntry,
-                    'ATT_zip'      => $zip,
-                    'ATT_email'    => $email,
-                    'ATT_phone'    => $phone,
-                    'ATT_ID'       => $attid
-                )
-            );
-        }
-        
-        return $attendees;
-    }
+	/**
+	 * This just returns an array of dummy attendee objects that we'll use to attach to events for our preview data
+	 *
+	 * @access private
+	 * @return array an array of attendee objects
+	 */
+	private function _get_some_attendees()
+	{
+		//let's just setup a dummy array of various attendee details
+		$dummy_attendees = array(
+			0 => array(
+				'Luke',
+				'Skywalker',
+				'farfaraway@galaxy.sp',
+				'804 Bantha Dr.',
+				'Complex 8',
+				'Mos Eisley',
+				32,
+				'US',
+				'f0r3e',
+				'222-333-4763',
+				false,
+				'999999991'
+			),
+			1 => array(
+				'Princess',
+				'Leia',
+				'buns@fcn.al',
+				'1456 Valley Way Boulevard',
+				'Suite 9',
+				'Alderaan',
+				15,
+				'US',
+				'c1h2c',
+				'78-123-111-1111',
+				false,
+				'999999992'
+			),
+			2 => array(
+				'Yoda',
+				'I Am',
+				'arrivenot@emailbad.fr',
+				'4th Tree',
+				'5th Knot',
+				'Marsh',
+				22,
+				'US',
+				'l18n',
+				'999-999-9999',
+				false,
+				'999999993'
+			),
+		);
+        
+		//let's generate the attendee objects
+		$attendees = array();
+		$var_array = array(
+			'fname',
+			'lname',
+			'email',
+			'address',
+			'address2',
+			'city',
+			'staid',
+			'cntry',
+			'zip',
+			'phone',
+			'deleted',
+			'attid'
+		);
+        
+		//EE_Registry::instance()->load_class( 'Attendee', array(), FALSE, false, TRUE );
+		foreach ($dummy_attendees as $dummy) {
+			$att = array_combine($var_array, $dummy);
+			extract($att);
+			/** @var $fname string */
+			/** @var $lname string */
+			/** @var $address string */
+			/** @var $address2 string */
+			/** @var $city string */
+			/** @var $staid string */
+			/** @var $cntry string */
+			/** @var $zip string */
+			/** @var $email string */
+			/** @var $phone string */
+			/** @var $attid string */
+			$attendees[$attid] = EE_Attendee::new_instance(
+				array(
+					'ATT_fname'    => $fname,
+					'ATT_lname'    => $lname,
+					'ATT_address'  => $address,
+					'ATT_address2' => $address2,
+					'ATT_city'     => $city,
+					'STA_ID'       => $staid,
+					'CNT_ISO'      => $cntry,
+					'ATT_zip'      => $zip,
+					'ATT_email'    => $email,
+					'ATT_phone'    => $phone,
+					'ATT_ID'       => $attid
+				)
+			);
+		}
+        
+		return $attendees;
+	}
     
     
-    /**
-     * Return an array of dummy question objects indexed by answer id and dummy answer objects indexed by answer id.
-     * This will be used in our dummy data setup
-     * @return array
-     */
-    private function _get_some_q_and_as()
-    {
-        
-        
-        $quests_array = array(
-            0 => array(
-                555,
-                __('What is your favorite planet?', 'event_espresso'),
-                0
-            ),
-            1 => array(
-                556,
-                __('What is your favorite food?', 'event_espresso'),
-                0
-            ),
-            2 => array(
-                557,
-                __('How many lightyears have you travelled', 'event_espresso'),
-                0
-            )
-        );
-        
-        
-        $ans_array = array(
-            0 => array(
-                999,
-                555,
-                'Tattoine'
-            ),
-            1 => array(
-                1000,
-                555,
-                'Alderaan'
-            ),
-            2 => array(
-                1001,
-                555,
-                'Dantooine'
-            ),
-            3 => array(
-                1002,
-                556,
-                'Fish Fingers'
-            ),
-            4 => array(
-                1003,
-                556,
-                'Sushi'
-            ),
-            5 => array(
-                1004,
-                556,
-                'Water'
-            ),
-            6 => array(
-                1005,
-                557,
-                'A lot',
-            ),
-            7 => array(
-                1006,
-                557,
-                "That's none of your business."
-            ),
-            8 => array(
-                1007,
-                557,
-                "People less travel me then."
-            )
-        );
-        
-        $qst_columns = array('QST_ID', 'QST_display_text', 'QST_system');
-        $ans_columns = array('ANS_ID', 'QST_ID', 'ANS_value');
-        
-        //EE_Registry::instance()->load_class( 'Question', array(), FALSE, TRUE, TRUE );
-        //EE_Registry::instance()->load_class( 'Answer', array(), FALSE, TRUE, TRUE );
-        
-        $qsts = array();
-        //first the questions
-        foreach ($quests_array as $qst) {
-            $qstobj                  = array_combine($qst_columns, $qst);
-            $qsts[$qstobj['QST_ID']] = EE_Question::new_instance($qstobj);
-        }
-        
-        //now the answers (and we'll setup our arrays)
-        $q_n_as = array();
-        foreach ($ans_array as $ans) {
-            $ansobj                             = array_combine($ans_columns, $ans);
-            $ansobj                             = EE_Answer::new_instance($ansobj);
-            $q_n_as['answers'][$ansobj->ID()]   = $ansobj;
-            $q_n_as['questions'][$ansobj->ID()] = $qsts[$ansobj->get('QST_ID')];
-        }
-        
-        return $q_n_as;
-        
-    }
+	/**
+	 * Return an array of dummy question objects indexed by answer id and dummy answer objects indexed by answer id.
+	 * This will be used in our dummy data setup
+	 * @return array
+	 */
+	private function _get_some_q_and_as()
+	{
+        
+        
+		$quests_array = array(
+			0 => array(
+				555,
+				__('What is your favorite planet?', 'event_espresso'),
+				0
+			),
+			1 => array(
+				556,
+				__('What is your favorite food?', 'event_espresso'),
+				0
+			),
+			2 => array(
+				557,
+				__('How many lightyears have you travelled', 'event_espresso'),
+				0
+			)
+		);
+        
+        
+		$ans_array = array(
+			0 => array(
+				999,
+				555,
+				'Tattoine'
+			),
+			1 => array(
+				1000,
+				555,
+				'Alderaan'
+			),
+			2 => array(
+				1001,
+				555,
+				'Dantooine'
+			),
+			3 => array(
+				1002,
+				556,
+				'Fish Fingers'
+			),
+			4 => array(
+				1003,
+				556,
+				'Sushi'
+			),
+			5 => array(
+				1004,
+				556,
+				'Water'
+			),
+			6 => array(
+				1005,
+				557,
+				'A lot',
+			),
+			7 => array(
+				1006,
+				557,
+				"That's none of your business."
+			),
+			8 => array(
+				1007,
+				557,
+				"People less travel me then."
+			)
+		);
+        
+		$qst_columns = array('QST_ID', 'QST_display_text', 'QST_system');
+		$ans_columns = array('ANS_ID', 'QST_ID', 'ANS_value');
+        
+		//EE_Registry::instance()->load_class( 'Question', array(), FALSE, TRUE, TRUE );
+		//EE_Registry::instance()->load_class( 'Answer', array(), FALSE, TRUE, TRUE );
+        
+		$qsts = array();
+		//first the questions
+		foreach ($quests_array as $qst) {
+			$qstobj                  = array_combine($qst_columns, $qst);
+			$qsts[$qstobj['QST_ID']] = EE_Question::new_instance($qstobj);
+		}
+        
+		//now the answers (and we'll setup our arrays)
+		$q_n_as = array();
+		foreach ($ans_array as $ans) {
+			$ansobj                             = array_combine($ans_columns, $ans);
+			$ansobj                             = EE_Answer::new_instance($ansobj);
+			$q_n_as['answers'][$ansobj->ID()]   = $ansobj;
+			$q_n_as['questions'][$ansobj->ID()] = $qsts[$ansobj->get('QST_ID')];
+		}
+        
+		return $q_n_as;
+        
+	}
     
     
-    /**
-     * Return an array of event objects from the database
-     *
-     * If event ids are not included then we'll just retrieve the first published event from the database.
-     *
-     * @param  array $event_ids if set, this will be an array of event ids to obtain events for.
-     *
-     * @return array    An array of event objects from the db.
-     */
-    private function _get_some_events($event_ids = array())
-    {
-        
-        //HEY, if we have an evt_id then we want to make sure we use that for the preview (because a specific event template is being viewed);
-        $event_ids = isset($_REQUEST['evt_id']) && ! empty($_REQUEST['evt_id'])
-            ? array($_REQUEST['evt_id'])
-            : $event_ids;
-        
-        $limit = ! empty($event_ids)
-            ? null
-            : apply_filters('FHEE__EE_Messages_Preview_incoming_data___get_some_events__limit', '0,1');
-        
-        $where = ! empty($event_ids)
-            ? array(
-                'EVT_ID'                 => array('IN', $event_ids),
-                'Datetime.Ticket.TKT_ID' => array('>', 1)
-            )
-            : array('Datetime.Ticket.TKT_ID' => array('>', 1));
-        
-        $events = EE_Registry::instance()->load_model('Event')->get_all(array($where, 'limit' => $limit));
-        
-        return $events;
-    }
+	/**
+	 * Return an array of event objects from the database
+	 *
+	 * If event ids are not included then we'll just retrieve the first published event from the database.
+	 *
+	 * @param  array $event_ids if set, this will be an array of event ids to obtain events for.
+	 *
+	 * @return array    An array of event objects from the db.
+	 */
+	private function _get_some_events($event_ids = array())
+	{
+        
+		//HEY, if we have an evt_id then we want to make sure we use that for the preview (because a specific event template is being viewed);
+		$event_ids = isset($_REQUEST['evt_id']) && ! empty($_REQUEST['evt_id'])
+			? array($_REQUEST['evt_id'])
+			: $event_ids;
+        
+		$limit = ! empty($event_ids)
+			? null
+			: apply_filters('FHEE__EE_Messages_Preview_incoming_data___get_some_events__limit', '0,1');
+        
+		$where = ! empty($event_ids)
+			? array(
+				'EVT_ID'                 => array('IN', $event_ids),
+				'Datetime.Ticket.TKT_ID' => array('>', 1)
+			)
+			: array('Datetime.Ticket.TKT_ID' => array('>', 1));
+        
+		$events = EE_Registry::instance()->load_model('Event')->get_all(array($where, 'limit' => $limit));
+        
+		return $events;
+	}
     
     
-    protected function _setup_data()
-    {
-        
-        //need to figure out the running total for test purposes so... we're going to create a temp cart and add the tickets to it!
-        if (EE_Registry::instance()->SSN instanceof EE_Session) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-            $session = EE_Registry::instance()->SSN;
-        } else {
-            $session = EE_Registry::instance()->load_core('Session');
-        }
-        $cart = EE_Cart::instance(null, $session);
-        
-        
-        //add tickets to cart
-        foreach ($this->tickets as $ticket) {
-            $cart->add_ticket_to_cart($ticket['ticket']);
-        }
-        
-        
-        //setup txn property
-        $this->txn = EE_Transaction::new_instance(
-            array(
-                'TXN_timestamp'    => time(), //unix timestamp
-                'TXN_total'        => 0, //txn_total
-                'TXN_paid'         => 0, //txn_paid
-                'STS_ID'           => EEM_Transaction::incomplete_status_code, //sts_id
-                'TXN_session_data' => null, //dump of txn session object (we're just going to leave blank here)
-                'TXN_hash_salt'    => null, //hash salt blank as well
-                'TXN_ID'           => 999999
-            )
-        );
-        
-        
-        //setup reg_objects
-        //note we're setting up a reg object for each attendee in each event but ALSO adding to the reg_object array.
-        $this->reg_objs = array();
-        $regid          = 9999990;
-        foreach ($this->_attendees as $key => $attendee) {
-            //note we need to setup reg_objects for each event this attendee belongs to
-            $regatt = $attendee['att_obj'] instanceof EE_Attendee ? $attendee['att_obj']->ID() : null;
-            $regtxn = $this->txn->ID();
-            $regcnt = 1;
-            foreach ($attendee['line_ref'] as $evtid) {
-                foreach ($this->_events[$evtid]['tkt_objs'] as $ticket) {
-                    if ( ! $ticket instanceof EE_Ticket) {
-                        continue;
-                    }
-                    $reg_array                                        = array(
-                        'EVT_ID'           => $evtid,
-                        'ATT_ID'           => $regatt,
-                        'TXN_ID'           => $regtxn,
-                        'TKT_ID'           => $ticket->ID(),
-                        'STS_ID'           => EEM_Registration::status_id_pending_payment,
-                        'REG_date'         => time(),
-                        'REG_final_price'  => $ticket->get('TKT_price'),
-                        'REG_session'      => 'dummy_session_id',
-                        'REG_code'         => $regid . '-dummy-generated-code',
-                        'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
-                        'REG_count'        => $regcnt,
-                        'REG_group_size'   => $this->_events[$evtid]['total_attendees'],
-                        'REG_att_is_going' => true,
-                        'REG_ID'           => $regid
-                    );
-                    $REG_OBJ                                          = EE_Registration::new_instance($reg_array);
-                    $this->_attendees[$key]['reg_objs'][$regid]       = $REG_OBJ;
-                    $this->_events[$evtid]['reg_objs'][]              = $REG_OBJ;
-                    $this->reg_objs[]                                 = $REG_OBJ;
-                    $this->tickets[$ticket->ID()]['reg_objs'][$regid] = $REG_OBJ;
+	protected function _setup_data()
+	{
+        
+		//need to figure out the running total for test purposes so... we're going to create a temp cart and add the tickets to it!
+		if (EE_Registry::instance()->SSN instanceof EE_Session) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+			$session = EE_Registry::instance()->SSN;
+		} else {
+			$session = EE_Registry::instance()->load_core('Session');
+		}
+		$cart = EE_Cart::instance(null, $session);
+        
+        
+		//add tickets to cart
+		foreach ($this->tickets as $ticket) {
+			$cart->add_ticket_to_cart($ticket['ticket']);
+		}
+        
+        
+		//setup txn property
+		$this->txn = EE_Transaction::new_instance(
+			array(
+				'TXN_timestamp'    => time(), //unix timestamp
+				'TXN_total'        => 0, //txn_total
+				'TXN_paid'         => 0, //txn_paid
+				'STS_ID'           => EEM_Transaction::incomplete_status_code, //sts_id
+				'TXN_session_data' => null, //dump of txn session object (we're just going to leave blank here)
+				'TXN_hash_salt'    => null, //hash salt blank as well
+				'TXN_ID'           => 999999
+			)
+		);
+        
+        
+		//setup reg_objects
+		//note we're setting up a reg object for each attendee in each event but ALSO adding to the reg_object array.
+		$this->reg_objs = array();
+		$regid          = 9999990;
+		foreach ($this->_attendees as $key => $attendee) {
+			//note we need to setup reg_objects for each event this attendee belongs to
+			$regatt = $attendee['att_obj'] instanceof EE_Attendee ? $attendee['att_obj']->ID() : null;
+			$regtxn = $this->txn->ID();
+			$regcnt = 1;
+			foreach ($attendee['line_ref'] as $evtid) {
+				foreach ($this->_events[$evtid]['tkt_objs'] as $ticket) {
+					if ( ! $ticket instanceof EE_Ticket) {
+						continue;
+					}
+					$reg_array                                        = array(
+						'EVT_ID'           => $evtid,
+						'ATT_ID'           => $regatt,
+						'TXN_ID'           => $regtxn,
+						'TKT_ID'           => $ticket->ID(),
+						'STS_ID'           => EEM_Registration::status_id_pending_payment,
+						'REG_date'         => time(),
+						'REG_final_price'  => $ticket->get('TKT_price'),
+						'REG_session'      => 'dummy_session_id',
+						'REG_code'         => $regid . '-dummy-generated-code',
+						'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
+						'REG_count'        => $regcnt,
+						'REG_group_size'   => $this->_events[$evtid]['total_attendees'],
+						'REG_att_is_going' => true,
+						'REG_ID'           => $regid
+					);
+					$REG_OBJ                                          = EE_Registration::new_instance($reg_array);
+					$this->_attendees[$key]['reg_objs'][$regid]       = $REG_OBJ;
+					$this->_events[$evtid]['reg_objs'][]              = $REG_OBJ;
+					$this->reg_objs[]                                 = $REG_OBJ;
+					$this->tickets[$ticket->ID()]['reg_objs'][$regid] = $REG_OBJ;
                     
-                    $regcnt++;
-                    $regid++;
-                }
-            }
-        }
-        
-        
-        //setup line items!
-        $line_item_total = EEH_Line_Item::create_total_line_item($this->txn);
-        
-        //add tickets
-        foreach ($this->tickets as $tktid => $item) {
-            $qty    = $item['count'];
-            $ticket = $item['ticket'];
-            EEH_Line_Item::add_ticket_purchase($line_item_total, $ticket, $qty);
-        }
-        
-        $shipping_line_item = EE_Line_Item::new_instance(array(
-            'LIN_name'       => __('Shipping Surcharge', 'event_espresso'),
-            'LIN_desc'       => __('Sent via Millenium Falcon', 'event_espresso'),
-            'LIN_unit_price' => 20,
-            'LIN_quantity'   => 1,
-            'LIN_is_taxable' => true,
-            'LIN_total'      => 20,
-            'LIN_type'       => EEM_Line_Item::type_line_item
-        ));
-        EEH_Line_Item::add_item($line_item_total, $shipping_line_item);
-        $this->additional_line_items = array($shipping_line_item);
-        
-        //now let's add taxes
-        EEH_Line_Item::apply_taxes($line_item_total);
-        
-        //now we should be able to get the items we need from this object
-        $event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
-        $line_items       = array();
-        foreach ($event_line_items as $line_id => $line_item) {
-            if ( ! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
-                continue;
-            }
-            $ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
-            foreach ($ticket_line_items as $ticket_line_id => $ticket_line_item) {
-                if ( ! $ticket_line_item instanceof EE_Line_Item) {
-                    continue;
-                }
-                $this->tickets[$ticket_line_item->OBJ_ID()]['line_item']      = $ticket_line_item;
-                $this->tickets[$ticket_line_item->OBJ_ID()]['sub_line_items'] = $ticket_line_item->children();
-                $line_items[$ticket_line_item->ID()]['children']              = $ticket_line_item->children();
-                $line_items[$ticket_line_item->ID()]['EE_Ticket']             = $this->tickets[$ticket_line_item->OBJ_ID()]['ticket'];
-            }
-        }
-        
-        $this->line_items_with_children = $line_items;
-        $this->tax_line_items           = $line_item_total->tax_descendants();
-        
-        //add proper total to transaction object.
-        $grand_total                 = $line_item_total->recalculate_total_including_taxes();
-        $this->grand_total_line_item = $line_item_total;
-        $this->txn->set_total($grand_total);
-        
-        
-        //add additional details for each registration
-        foreach ($this->reg_objs as $reg) {
-            if ( ! $reg instanceof EE_Registration) {
-                continue;
-            }
-            $this->_registrations[$reg->ID()]['tkt_obj']  = $this->tickets[$reg->get('TKT_ID')]['ticket'];
-            $this->_registrations[$reg->ID()]['evt_obj']  = $this->_events[$reg->get('EVT_ID')]['event'];
-            $this->_registrations[$reg->ID()]['reg_obj']  = $reg;
-            $this->_registrations[$reg->ID()]['ans_objs'] = $this->_attendees[$reg->get('ATT_ID')]['ans_objs'];
-            $this->_registrations[$reg->ID()]['att_obj']  = $this->_attendees[$reg->get('ATT_ID')]['att_obj'];
-            $this->_registrations[$reg->ID()]['dtt_objs'] = $this->tickets[$reg->get('TKT_ID')]['dtt_objs'];
-        }
-        
-        
-        //events and attendees
-        $this->events        = $this->_events;
-        $this->attendees     = $this->_attendees;
-        $this->registrations = $this->_registrations;
-        
-        $attendees_to_shift = $this->_attendees;
-        
-        //setup primary attendee property
-        $this->primary_attendee_data = array(
-            'fname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->fname()
-                : '',
+					$regcnt++;
+					$regid++;
+				}
+			}
+		}
+        
+        
+		//setup line items!
+		$line_item_total = EEH_Line_Item::create_total_line_item($this->txn);
+        
+		//add tickets
+		foreach ($this->tickets as $tktid => $item) {
+			$qty    = $item['count'];
+			$ticket = $item['ticket'];
+			EEH_Line_Item::add_ticket_purchase($line_item_total, $ticket, $qty);
+		}
+        
+		$shipping_line_item = EE_Line_Item::new_instance(array(
+			'LIN_name'       => __('Shipping Surcharge', 'event_espresso'),
+			'LIN_desc'       => __('Sent via Millenium Falcon', 'event_espresso'),
+			'LIN_unit_price' => 20,
+			'LIN_quantity'   => 1,
+			'LIN_is_taxable' => true,
+			'LIN_total'      => 20,
+			'LIN_type'       => EEM_Line_Item::type_line_item
+		));
+		EEH_Line_Item::add_item($line_item_total, $shipping_line_item);
+		$this->additional_line_items = array($shipping_line_item);
+        
+		//now let's add taxes
+		EEH_Line_Item::apply_taxes($line_item_total);
+        
+		//now we should be able to get the items we need from this object
+		$event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
+		$line_items       = array();
+		foreach ($event_line_items as $line_id => $line_item) {
+			if ( ! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
+				continue;
+			}
+			$ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
+			foreach ($ticket_line_items as $ticket_line_id => $ticket_line_item) {
+				if ( ! $ticket_line_item instanceof EE_Line_Item) {
+					continue;
+				}
+				$this->tickets[$ticket_line_item->OBJ_ID()]['line_item']      = $ticket_line_item;
+				$this->tickets[$ticket_line_item->OBJ_ID()]['sub_line_items'] = $ticket_line_item->children();
+				$line_items[$ticket_line_item->ID()]['children']              = $ticket_line_item->children();
+				$line_items[$ticket_line_item->ID()]['EE_Ticket']             = $this->tickets[$ticket_line_item->OBJ_ID()]['ticket'];
+			}
+		}
+        
+		$this->line_items_with_children = $line_items;
+		$this->tax_line_items           = $line_item_total->tax_descendants();
+        
+		//add proper total to transaction object.
+		$grand_total                 = $line_item_total->recalculate_total_including_taxes();
+		$this->grand_total_line_item = $line_item_total;
+		$this->txn->set_total($grand_total);
+        
+        
+		//add additional details for each registration
+		foreach ($this->reg_objs as $reg) {
+			if ( ! $reg instanceof EE_Registration) {
+				continue;
+			}
+			$this->_registrations[$reg->ID()]['tkt_obj']  = $this->tickets[$reg->get('TKT_ID')]['ticket'];
+			$this->_registrations[$reg->ID()]['evt_obj']  = $this->_events[$reg->get('EVT_ID')]['event'];
+			$this->_registrations[$reg->ID()]['reg_obj']  = $reg;
+			$this->_registrations[$reg->ID()]['ans_objs'] = $this->_attendees[$reg->get('ATT_ID')]['ans_objs'];
+			$this->_registrations[$reg->ID()]['att_obj']  = $this->_attendees[$reg->get('ATT_ID')]['att_obj'];
+			$this->_registrations[$reg->ID()]['dtt_objs'] = $this->tickets[$reg->get('TKT_ID')]['dtt_objs'];
+		}
+        
+        
+		//events and attendees
+		$this->events        = $this->_events;
+		$this->attendees     = $this->_attendees;
+		$this->registrations = $this->_registrations;
+        
+		$attendees_to_shift = $this->_attendees;
+        
+		//setup primary attendee property
+		$this->primary_attendee_data = array(
+			'fname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->fname()
+				: '',
             
-            'lname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->lname()
-                : '',
+			'lname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->lname()
+				: '',
             
-            'email' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->email()
-                : '',
+			'email' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->email()
+				: '',
             
-            'att_obj' => $this->_attendees[999999991]['att_obj'],
+			'att_obj' => $this->_attendees[999999991]['att_obj'],
             
-            'reg_obj' => array_shift($attendees_to_shift[999999991]['reg_objs'])
-        );
+			'reg_obj' => array_shift($attendees_to_shift[999999991]['reg_objs'])
+		);
         
-        //reg_info property
-        //note this isn't referenced by any shortcode parsers so we'll ignore for now.
-        $this->reg_info = array();
+		//reg_info property
+		//note this isn't referenced by any shortcode parsers so we'll ignore for now.
+		$this->reg_info = array();
         
-        //let's set a reg_obj for messengers expecting one.
-        $this->reg_obj = array_pop($this->_attendees[999999991]['reg_objs']);
+		//let's set a reg_obj for messengers expecting one.
+		$this->reg_obj = array_pop($this->_attendees[999999991]['reg_objs']);
         
         
-        //the below are just dummy items.
-        $this->user_id     = 1;
-        $this->ip_address  = '192.0.2.1';
-        $this->user_agent  = '';
-        $this->init_access = time();
-        $this->last_access = time();
-    }
+		//the below are just dummy items.
+		$this->user_id     = 1;
+		$this->ip_address  = '192.0.2.1';
+		$this->user_agent  = '';
+		$this->init_access = time();
+		$this->last_access = time();
+	}
     
 } //end EE_Messages_Preview_incoming_data class

Spacing +4 added lines, -4 removed lines

@@ -145,7 +145,7 @@ 
                 if ( ! $attendee instanceof EE_Attendee) {
                     continue;
                 }
-                $this->_attendees[$att_key]['line_ref'][] = $id;  //so later it can be determined what events this attendee registered for!
+                $this->_attendees[$att_key]['line_ref'][] = $id; //so later it can be determined what events this attendee registered for!
                 $this->_attendees[$att_key]['evt_objs'][] = $event;
                 $this->_attendees[$att_key]['att_obj']    = $attendee;
                 //$this->_attendees[$att_key]['registration_id'] = 0;
@@ -467,7 +467,7 @@ 
                     if ( ! $ticket instanceof EE_Ticket) {
                         continue;
                     }
-                    $reg_array                                        = array(
+                    $reg_array = array(
                         'EVT_ID'           => $evtid,
                         'ATT_ID'           => $regatt,
                         'TXN_ID'           => $regtxn,
@@ -476,8 +476,8 @@ 
                         'REG_date'         => time(),
                         'REG_final_price'  => $ticket->get('TKT_price'),
                         'REG_session'      => 'dummy_session_id',
-                        'REG_code'         => $regid . '-dummy-generated-code',
-                        'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
+                        'REG_code'         => $regid.'-dummy-generated-code',
+                        'REG_url_link'     => $regcnt.'-daafpapasdlfakasdfpqasdfasdf',
                         'REG_count'        => $regcnt,
                         'REG_group_size'   => $this->_events[$evtid]['total_attendees'],
                         'REG_att_is_going' => true,

caffeinated/core/libraries/shortcodes/EE_Question_List_Shortcodes.lib.php

Indentation +62 added lines, -62 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -36,80 +36,80 @@ 
 {
     
     
-    public function __construct()
-    {
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
     
     
-    protected function _init_props()
-    {
-        $this->label       = __('Questions and Answers Shortcodes', 'event_espresso');
-        $this->description = __('All shortcodes related to custom questions and answers', 'event_espresso');
-        $this->_shortcodes = array(
-            '[QUESTION_LIST]' => __('This is used to indicate where you want the list of questions and answers to show for the registrant.  You place this within the "[attendee_list]" field.',
-                'event_espresso')
-        );
-    }
+	protected function _init_props()
+	{
+		$this->label       = __('Questions and Answers Shortcodes', 'event_espresso');
+		$this->description = __('All shortcodes related to custom questions and answers', 'event_espresso');
+		$this->_shortcodes = array(
+			'[QUESTION_LIST]' => __('This is used to indicate where you want the list of questions and answers to show for the registrant.  You place this within the "[attendee_list]" field.',
+				'event_espresso')
+		);
+	}
     
     
-    protected function _parser($shortcode)
-    {
+	protected function _parser($shortcode)
+	{
         
         
-        switch ($shortcode) {
-            case '[QUESTION_LIST]' :
-                return $this->_get_question_list();
-                break;
-        }
+		switch ($shortcode) {
+			case '[QUESTION_LIST]' :
+				return $this->_get_question_list();
+				break;
+		}
         
-        return '';
-    }
+		return '';
+	}
     
     
-    protected function _get_question_list()
-    {
-        $this->_validate_list_requirements();
+	protected function _get_question_list()
+	{
+		$this->_validate_list_requirements();
         
-        //for when [QUESTION_LIST] is used in the [attendee_list] field.
-        if ($this->_data['data'] instanceof EE_Registration) {
-            return $this->_get_question_answer_list_for_attendee();
-        } //for when [QUESTION_LIST] is used in the main content field.
-        else if ($this->_data['data'] instanceof EE_Messages_Addressee && $this->_data['data']->reg_obj instanceof EE_Registration) {
-            return $this->_get_question_answer_list_for_attendee($this->_data['data']->reg_obj);
-        } else {
-            return '';
-        }
-    }
+		//for when [QUESTION_LIST] is used in the [attendee_list] field.
+		if ($this->_data['data'] instanceof EE_Registration) {
+			return $this->_get_question_answer_list_for_attendee();
+		} //for when [QUESTION_LIST] is used in the main content field.
+		else if ($this->_data['data'] instanceof EE_Messages_Addressee && $this->_data['data']->reg_obj instanceof EE_Registration) {
+			return $this->_get_question_answer_list_for_attendee($this->_data['data']->reg_obj);
+		} else {
+			return '';
+		}
+	}
     
     
-    /**
-     * Note when we parse the "[question_list]" shortcode for attendees we're actually going to retrieve the list of
-     * answers for that attendee since that is what we really need (we can derive the questions from the answers);
-     * @return string parsed template.
-     */
-    private function _get_question_answer_list_for_attendee($reg_obj = null)
-    {
-        $valid_shortcodes = array('question');
-        $reg_obj          = $reg_obj instanceof EE_Registration ? $reg_obj : $this->_data['data'];
-        $template         = is_array($this->_data['template']) && isset($this->_data['template']['question_list']) ? $this->_data['template']['question_list'] : '';
-        $template         = empty($template) && isset($this->_extra_data['template']['question_list']) ? $this->_extra_data['template']['question_list'] : $template;
-        $ans_result       = '';
-        $answers          = ! empty($this->_extra_data['data']->registrations[$reg_obj->ID()]['ans_objs']) ? $this->_extra_data['data']->registrations[$reg_obj->ID()]['ans_objs'] : array();
-        $questions        = ! empty($this->_extra_data['data']->questions) ? $this->_extra_data['data']->questions : array();
-        foreach ($answers as $answer) {
-            //first see if the question is in our $questions array.  If not then try to get from answer object
-            $question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
-            $question = ! $question instanceof EE_Question ? $answer->question() : $question;
-            if ($question instanceof EE_Question and $question->admin_only()) {
-                continue;
-            }
-            $ans_result .= $this->_shortcode_helper->parse_question_list_template($template, $answer, $valid_shortcodes,
-                $this->_extra_data);
-        }
+	/**
+	 * Note when we parse the "[question_list]" shortcode for attendees we're actually going to retrieve the list of
+	 * answers for that attendee since that is what we really need (we can derive the questions from the answers);
+	 * @return string parsed template.
+	 */
+	private function _get_question_answer_list_for_attendee($reg_obj = null)
+	{
+		$valid_shortcodes = array('question');
+		$reg_obj          = $reg_obj instanceof EE_Registration ? $reg_obj : $this->_data['data'];
+		$template         = is_array($this->_data['template']) && isset($this->_data['template']['question_list']) ? $this->_data['template']['question_list'] : '';
+		$template         = empty($template) && isset($this->_extra_data['template']['question_list']) ? $this->_extra_data['template']['question_list'] : $template;
+		$ans_result       = '';
+		$answers          = ! empty($this->_extra_data['data']->registrations[$reg_obj->ID()]['ans_objs']) ? $this->_extra_data['data']->registrations[$reg_obj->ID()]['ans_objs'] : array();
+		$questions        = ! empty($this->_extra_data['data']->questions) ? $this->_extra_data['data']->questions : array();
+		foreach ($answers as $answer) {
+			//first see if the question is in our $questions array.  If not then try to get from answer object
+			$question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
+			$question = ! $question instanceof EE_Question ? $answer->question() : $question;
+			if ($question instanceof EE_Question and $question->admin_only()) {
+				continue;
+			}
+			$ans_result .= $this->_shortcode_helper->parse_question_list_template($template, $answer, $valid_shortcodes,
+				$this->_extra_data);
+		}
         
-        return $ans_result;
-    }
+		return $ans_result;
+	}
     
     
 } //end EE_Question_List_Shortcodes class

Spacing +1 added lines, -1 removed lines

@@ -99,7 +99,7 @@
         $questions        = ! empty($this->_extra_data['data']->questions) ? $this->_extra_data['data']->questions : array();
         foreach ($answers as $answer) {
             //first see if the question is in our $questions array.  If not then try to get from answer object
-            $question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
+            $question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null;
             $question = ! $question instanceof EE_Question ? $answer->question() : $question;
             if ($question instanceof EE_Question and $question->admin_only()) {
                 continue;

admin_pages/registrations/templates/reg_admin_details_side_meta_box_registrant.template.php

Indentation +8 added lines, -8 removed lines

@@ -26,13 +26,13 @@ 
 
 <p class="contact-details-buttons">
     <?php if (
-        $att_check instanceof EE_Attendee
-        && EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_contact',
-            'view_or_edit_contact_button',
-            $att_check->ID()
-        )
-    ) : ?>
+		$att_check instanceof EE_Attendee
+		&& EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_contact',
+			'view_or_edit_contact_button',
+			$att_check->ID()
+		)
+	) : ?>
     <a class="button button-small" href="<?php echo $att_edit_link; ?>"
        title="<?php echo esc_attr($att_edit_label); ?>">
         <span class="ee-icon ee-icon-user-edit"></span><?php echo $att_edit_label; ?>
@@ -40,7 +40,7 @@ 
     <?php if (! empty($create_link)) : ?>
         <a class="button button-small" href="<?php echo $create_link; ?>"
            title="<?php esc_attr_e('This registration shares the contact details for the primary registration in this group.  If you\'d like this registration to have its own details, you can do so by clicking this button',
-               'event_espresso'); ?>">
+			   'event_espresso'); ?>">
             <span class="ee-icon ee-icon-user-add-new"></span><?php echo $create_label; ?>
         </a>
     <?php endif; ?>

Spacing +2 added lines, -2 removed lines

@@ -2,7 +2,7 @@ 
     <p class="clearfix">
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left">
             <?php _e('Name', 'event_espresso'); ?>
-        </span><?php echo $fname . ' ' . $lname; ?>
+        </span><?php echo $fname.' '.$lname; ?>
     </p>
     <p class="clearfix">
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left"><?php _e('Email', 'event_espresso'); ?></span><a
@@ -37,7 +37,7 @@ 
        title="<?php echo esc_attr($att_edit_label); ?>">
         <span class="ee-icon ee-icon-user-edit"></span><?php echo $att_edit_label; ?>
     </a>
-    <?php if (! empty($create_link)) : ?>
+    <?php if ( ! empty($create_link)) : ?>
         <a class="button button-small" href="<?php echo $create_link; ?>"
            title="<?php esc_attr_e('This registration shares the contact details for the primary registration in this group.  If you\'d like this registration to have its own details, you can do so by clicking this button',
                'event_espresso'); ?>">